Your IP : 216.73.216.11
<?php
/**
* @version 1.5 stable $Id: flexinotify.php 1806 2013-11-10 01:38:20Z ggppdk $
* @package Joomla
* @subpackage FLEXIcontent
* @copyright (C) 2009 Emmanuel Danan - www.vistamedia.fr
* @license GNU/GPL v2
*
* FLEXIcontent is a derivative work of the excellent QuickFAQ component
* @copyright (C) 2008 Christoph Lukes
* see www.schlu.net for more information
*
* FLEXIcontent is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );
jimport('cms.plugin.plugin');
/**
* Flexicontent Notification Plugin
*
* @package Joomla
* @subpackage FLEXIcontent
* @since 1.5.5
*/
class plgFlexicontentFlexinotify extends JPlugin
{
/**
* Constructor
*
* For php4 compatability we must not use the __constructor as a constructor for plugins
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
* This causes problems with cross-referencing necessary for the observer design pattern.
*
* @param object $subject The object to observe
* @param object $params The object that holds the plugin parameters
* @since 1.5
*/
function __construct( &$subject, $params )
{
parent::__construct( $subject, $params );
JPlugin::loadLanguage( 'plg_flexicontent_flexinotify' );
}
/**
* This method is executed just before an item is stored
*
* Method is called by the model
*
* @param object The item object.
* @param boolean Indicates if item is new
*/
/*function onBeforeSaveItem( &$item, $isnew ) {
$post = JFactory::getApplication()->input->get('post');
//echo "<pre>"; $post; echo "</pre>"; exit;
//...
if ($somethingbad) {
$app = &JFactory::getApplication();
$app->enqueueMessage( 'Saving cancel due to error ...', 'notice' );
return false;
}
return true;
}*/
/**
* This method is executed just after an item stored (including custom fields)
*
* Method is called by the model
*
* @param object The item object.
* @param object The complete $_POST data
*/
function onAfterSaveItem( &$item, &$post )
{
/**
* Checks to decide whether to send emails
*/
// Get Plugin parameters and send notifications
$plugin = JPluginHelper::getPlugin('flexicontent', 'flexinotify');
$params = new JRegistry($plugin->params);
$app = JFactory::getApplication();
$session = JFactory::getSession();
$debug_notifications = (int) $params->get('debug_notifications', 0);
// Check if debug_notifications is for super admin only
if ($debug_notifications === 2)
{
if (!FlexicontentHelperPerm::getPerm()->SuperAdmin) $debug_notifications = 0;
// Set this for later usage ... not to recalculate
$params->set('debug_notifications', $debug_notifications);
}
/**
* Fast skip of uneeded code, if nothing to do
*/
if (!$debug_notifications && empty($post['notify']) && empty($post['notify_owner']))
{
return;
}
/**
* Check if new document version was approved
*/
if ($post['vstate'] != 2)
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Not sending notifications, because new document version did not become active (needs approval by a publisher/administrator)", 'message');
return;
}
/**
* Send notification email to item owner
*/
if (empty($post['notify_owner']))
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Current editor did not request to notify owner", 'message');
}
elseif (!$item->created_by)
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Item owner was not notified for changes (item has no owner)", 'message');
}
else
{
// Check if notification email to owner was already sent during current session
$owners_notified = $session->get('owners_notified', array(),'flexicontent');
if (empty($owners_notified[$item->id]))
{
$owner = JFactory::getUser($item->created_by);
$this->sendOwnerNotification($item, $owner, $params);
// Set flag to avoid resending notification
$owners_notified[$item->id] = 1;
$session->set('owners_notified', $owners_notified, 'flexicontent');
}
else
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Notifications email to owner was already sent during current session", 'message');
}
}
/**
* Send notification emails to item's subscribers
*/
$subscribers = $this->_getSubscribers($item->id);
// Check if current item has subscribers
if (count($subscribers) === 0)
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Current content item has no subscribers", 'message');
return;
}
// Check if notification emails to subscribers were already sent during current session
$subscribers_notified = $session->get('subscribers_notified', array(),'flexicontent');
if (!empty($subscribers_notified[$item->id]))
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Notifications emails to subscribers were already sent during current session", 'message');
return;
}
// Check if notification flag was set
if (empty($post['notify']))
{
if ($debug_notifications) $app->enqueueMessage("** Notification Plugin: Current editor did not request to notify subscribers", 'message');
return;
}
// Send notifications (optionally these will be personalized)
$this->sendNotifications($item, $subscribers, $params);
// Set flag to avoid resending notifications
$subscribers_notified[$item->id] = 1;
$session->set('subscribers_notified', $subscribers_notified, 'flexicontent');
}
/**
* This method is executed after item saving is complete (all data, e.g. including versioning metadata)
*
* Method is called by the model
*
* @param object The item object.
* @param object The complete $_POST data
*/
/*function onCompleteSaveItem( &$item, &$fields ) {
}*/
function _getSubscribers($itemid)
{
$db = JFactory::getDbo();
$query = 'SELECT u.* '
.' FROM #__flexicontent_favourites AS f'
.' LEFT JOIN #__users AS u'
.' ON u.id = f.userid'
.' WHERE f.itemid = ' . (int)$itemid . ' AND f.type = 0'
.' AND u.block=0 '
;
$db->setQuery($query);
$users = $db->loadObjectList();
return $users;
}
function sendOwnerNotification($item, $owner, $params)
{
$debug_notifications= $params->get('debug_notifications', 0);
if (!$owner)
{
if ($debug_notifications)
{
JFactory::getApplication()->enqueueMessage("** Notification Plugin: Item owner %d could not be loaded. Notification to owner for item changes could not be sent", 'message');
}
return;
}
global $globalcats;
$categories = $globalcats;
$app = JFactory::getApplication();
$config = JFactory::getConfig();
// Get the route helper
require_once (JPATH_SITE.DS.'components'.DS.'com_flexicontent'.DS.'helpers'.DS.'route.php');
// Import joomla mail helper class that contains the sendMail helper function
jimport('joomla.mail.helper');
$mailer = JFactory::getMailer();
$mailer->Encoding = 'base64';
/**
* Parameters for 'message' language string
*
* 1: $subname Name of the subscriber
* 2: $itemid ID of the item
* 3: $title Title of the item
* 4: $maincat Main category of the item
* 5: $link Link of the item
* 6: $sitename Website
*/
/**
* Create variables need for subject
*/
$subname = '__OWNER_NAME__';
$itemid = $item->id;
$title = $item->title;
$maincat = $categories[$item->catid]->title;
// Label for current item state
$state_labels = array(
1 => 'FLEXI_PUBLISHED',
0 => 'FLEXI_UNPUBLISHED',
-5 => 'FLEXI_IN_PROGRESS',
-3 => 'FLEXI_PENDING',
-4 => 'FLEXI_TO_WRITE',
2 => 'FLEXI_ARCHIVED',
-2 => 'FLEXI_TRASHED',
);
$itemStateName = isset($state_labels[$item->state])
? JText::_($state_labels[$item->state])
: JText::_('FLEXI_UNKNOWN');
// Create the non-SEF URL
$site_languages = FLEXIUtilities::getLanguages();
$sef_lang = $item->language !== '*' && isset($site_languages->{$item->language})
? $site_languages->{$item->language}->sef
: '';
$item_url =
FlexicontentHelperRoute::getItemRoute($item->id.':'.$item->alias, $categories[$item->catid]->slug)
. ($sef_lang ? '&lang=' . $sef_lang : '');
// Create the SEF URL
$item_url = $app->isClient('administrator')
? flexicontent_html::getSefUrl($item_url) // ..., $_xhtml= true, $_ssl=-1);
: JRoute::_($item_url); // ..., $_xhtml= true, $_ssl=-1);
// Make URL absolute since this URL will be emailed
$item_url = JUri::getInstance()->toString(array('scheme', 'host', 'port')) . $item_url;
/**
* Create parameters passed to mail helper function
*/
$site_info = $app->getCfg('sitename') . ' - ' . JUri::root();
$sendermail = $params->get('sendermail', $app->getCfg('mailfrom'));
$sendermail = JMailHelper::cleanAddress($sendermail);
// Use 'sitename' as sender name
$sendername = $params->get('sendername', $app->getCfg('sitename'));
// Use custom message subject if this is set
$subject = $params->get('mailsubject_owner', '')
? JMailHelper::cleanSubject($params->get('mailsubject_owner'))
: JText::_('FLEXI_SUBJECT_DEFAULT');
$body = $params->get('mailbody_owner', '')
? JMailHelper::cleanSubject($params->get('mailsubject_owner'))
: JText::_('FLEXI_SUBJECT_DEFAULT');
$message = JText::sprintf('FLEXI_NOTIFICATION_MESSAGE_OWNER',
$subname,
$itemid,
$title,
$maincat,
$itemStateName,
'<a href="'.$item_url.'">'.$item_url.'</a>',
$site_info
);
$message = nl2br($message);
/**
* Send email notification to owner about item being updated
*/
$to_arr = array();
$to = JMailHelper::cleanAddress($owner->email);
$to_arr[] = $to;
$_message = $message;
$_message = str_replace('__OWNER_NAME__', $owner->name, $_message);
$from = $sendermail;
$fromname = $sendername;
$recipient = array($to);
$html_mode=true; $cc=null; $bcc=null;
$attachment=null; $replyto=null; $replytoname=null;
try {
$send_result = $mailer->sendMail( $from, $fromname, $recipient, $subject, $_message, $html_mode, $cc, $bcc, $attachment, $replyto, $replytoname );
} catch(\Exception $e) {
$send_result = false;
}
/**
* Finally give some feedback to current editor
*/
$msg = JText::_($send_result ? 'FLEXI_NOTIFY_OWNER_SUCCESS' : 'FLEXI_NOTIFY_OWNER_FAILURE');
// Include the email of owner if debug is enabled
$msg_receiver = !$debug_notifications ? '' : ' <br/> Owner email: ' . $to;
$app->enqueueMessage($msg . $msg_receiver, $send_result ? 'message' : 'warning');
return $send_result;
}
function sendNotifications($item, $subscribers, $params)
{
global $globalcats;
$categories = $globalcats;
$app = JFactory::getApplication();
$config = JFactory::getConfig();
// Get the route helper
require_once (JPATH_SITE.DS.'components'.DS.'com_flexicontent'.DS.'helpers'.DS.'route.php');
// Import joomla mail helper class that contains the sendMail helper function
jimport('joomla.mail.helper');
$mailer = JFactory::getMailer();
$mailer->Encoding = 'base64';
$debug_notifications = (int) $params->get('debug_notifications', 0);
/**
* Parameters for 'message' language string
*
* 1: $subname Name of the subscriber
* 2: $itemid ID of the item
* 3: $title Title of the item
* 4: $maincat Main category of the item
* 5: $link Link of the item
* 6: $sitename Website
*/
$include_fullname = (int) $params->get('include_fullname', 1);
$send_personalized = (int) $params->get('send_personalized', 1);
/**
* Disable personalized messages if subscriber limit for personal messages is exceeded
*/
if ($send_personalized)
{
$personalized_limit = (int) $params->get('personalized_limit', 50);
$personalized_limit = min($personalized_limit, 100);
$send_personalized = count($subscribers) <= $personalized_limit;
}
/**
* Create variables need for subject
*/
$subname = ($send_personalized && $include_fullname) ? '__SUBSCRIBER_NAME__' : JText::_('FLEXI_SUBSCRIBER');
$itemid = $item->id;
$title = $item->title;
$maincat = $categories[$item->catid]->title;
// Create the non-SEF URL
$site_languages = FLEXIUtilities::getLanguages();
$sef_lang = $item->language !== '*' && isset($site_languages->{$item->language})
? $site_languages->{$item->language}->sef
: '';
$item_url =
FlexicontentHelperRoute::getItemRoute($item->id.':'.$item->alias, $categories[$item->catid]->slug)
. ($sef_lang ? '&lang=' . $sef_lang : '');
// Create the SEF URL
$item_url = $app->isClient('administrator')
? flexicontent_html::getSefUrl($item_url) // ..., $_xhtml= true, $_ssl=-1);
: JRoute::_($item_url); // ..., $_xhtml= true, $_ssl=-1);
// Make URL absolute since this URL will be emailed
$item_url = JUri::getInstance()->toString(array('scheme', 'host', 'port')) . $item_url;
/**
* Create parameters passed to mail helper function
*/
$site_info = $app->getCfg('sitename') . ' - ' . JUri::root();
$sendermail = $params->get('sendermail', $app->getCfg('mailfrom'));
$sendermail = JMailHelper::cleanAddress($sendermail);
// Use 'sitename' as sender name
$sendername = $params->get('sendername', $app->getCfg('sitename'));
// Use custom message subject if this is set
$subject = $params->get('mailsubject', '')
? JMailHelper::cleanSubject($params->get('mailsubject'))
: JText::_('FLEXI_SUBJECT_DEFAULT');
$message = JText::sprintf('FLEXI_NOTIFICATION_MESSAGE',
$subname,
$itemid,
$title,
$maincat,
'<a href="'.$item_url.'">'.$item_url.'</a>',
$site_info
);
$message = nl2br($message);
// *************************************************
// Send email notifications about item being updated
// *************************************************
// Personalized email per subscribers
if ($send_personalized)
{
$count_sent = 0;
$to_arr = array();
foreach ($subscribers as $subscriber)
{
$to = JMailHelper::cleanAddress($subscriber->email);
$to_arr[] = $to;
$_message = $message;
if ($include_fullname) $_message = str_replace('__SUBSCRIBER_NAME__', $subscriber->name, $_message);
$from = $sendermail;
$fromname = $sendername;
$recipient = array($to);
$html_mode=true; $cc=null; $bcc=null;
$attachment=null; $replyto=null; $replytoname=null;
try {
$send_result = $mailer->sendMail( $from, $fromname, $recipient, $subject, $_message, $html_mode, $cc, $bcc, $attachment, $replyto, $replytoname );
} catch(\Exception $e) {
$send_result = false;
}
if ($send_result) $count_sent++;
}
$send_result = (boolean) $count_sent;
if ($debug_notifications)
{
$app->enqueueMessage("** Notification Plugin: Sent personalized message per subscriber", 'message');
}
}
// Single same message for ALL subscribers
else
{
$to_arr = array();
$count = 0;
foreach ($subscribers as $subscriber)
{
$to = JMailHelper::cleanAddress($subscriber->email);
$to_arr[] = $to;
$to_100_arr[ intval($count/100) ][] = $to;
$count++;
}
$count_sent = 0;
foreach ($to_100_arr as $to_100)
{
$from = $sendermail;
$fromname = $sendername;
$recipient = array($from);
$html_mode=true; $cc=null; $bcc = $to_100;
$attachment=null; $replyto=null; $replytoname=null;
try {
$send_result = $mailer->sendMail( $from, $fromname, $recipient, $subject, $message, $html_mode, $cc, $bcc, $attachment, $replyto, $replytoname );
} catch(\Exception $e) {
$send_result = false;
}
if ($send_result) $count_sent += count($to_100);
}
$send_result = (boolean) $count_sent;
if ($debug_notifications)
{
$app->enqueueMessage("** Notification Plugin: Sent same message to all subscribers", 'message');
}
}
/**
* Finally give some feedback to current editor
*/
$msg = $send_result ?
JText::sprintf('FLEXI_NOTIFY_SUCCESS', $count_sent, count($subscribers)) :
JText::sprintf('FLEXI_NOTIFY_FAILURE', count($subscribers));
// Include emails of receivers if debug is enabled
$msg_receivers = !$debug_notifications ? '' : ' <br/> Subscribers List: ' . implode(', ', $to_arr);
$app->enqueueMessage($msg . $msg_receivers, $send_result ? 'message' : 'warning');
return $send_result;
}
}