'NotificationDAO' => 'notification.NotificationDAO',

			'NotificationSettingsDAO' => 'notification.NotificationSettingsDAO',

<?php

/**

 * @file classes/notification/NotificationDAO.inc.php

 *

 * Copyright (c) 2003-2008 John Willinsky

 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.

 *

 * @class NotificationDAO

 * @ingroup notification

 * @see Notification

 *

 * @brief Operations for retrieving and modifying Notification objects.

 */

// $Id: NotificationDAO.inc.php,v 1.19 2008/11/05 00:46:39 mcrider Exp $

import('notification.Notification');

class NotificationDAO extends DAO {

	/**

	 * Constructor.

	 */

	function NotificationDAO() {

		parent::DAO();

	}

	/**

	 * Retrieve Notification by notification id

	 * @param $notificationId int

	 * @return Notification object

	 */

	function &getNotificationById($notificationId) {

		$result =& $this->retrieve(

			'SELECT * FROM notifications WHERE notification_id = ?', (int) $notificationId

		);

		$notification =& $this->_returnNotificationFromRow($result->GetRowAssoc(false));

		$result->Close();

		unset($result);

		return $notification;

	}	

	/**

	 * Retrieve Notifications by user id

	 * @param $userId int

	 * @return Notification objects array

	 */

	function &getNotificationsByUserId($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$notifications = array();

		$result =& $this->retrieve(

			'SELECT * FROM notifications WHERE user_id = ? AND product = ? AND context = ? ORDER BY date_created DESC',	

			array((int) $userId, $productName, (int) $contextId)

		);

		$returner = new DAOResultFactory($result, $this, '_returnNotificationFromRow');

		return $returner;

	}

	/**

	 * Retrieve Notifications by notification id

	 * @param $notificationId int

	 * @return boolean

	 */

	function setDateRead($notificationId) {

		$returner = $this->update(

			sprintf('UPDATE notifications

				SET date_read = %s

				WHERE notification_id = ?',

				$this->datetimeToDB(date('Y-m-d H:i:s'))),

			(int) $notificationId

		);

		return $returner;

	}

	/**

	 * Creates and returns an notification object from a row

	 * @param $row array

	 * @return Notification object

	 */

	function &_returnNotificationFromRow($row) {

		$notification = new Notification();

		$notification->setNotificationId($row['notification_id']);

		$notification->setUserId($row['user_id']);

		$notification->setDateCreated($row['date_created']);

		$notification->setDateRead($row['date_read']);

		$notification->setContents($row['contents']);

		$notification->setParam($row['param']);

		$notification->setLocation($row['location']);

		$notification->setIsLocalized($row['is_localized']);

		$notification->setContext($row['context']);

		$notification->setAssocType($row['assoc_type']);

		HookRegistry::call('NotificationDAO::_returnNotificationFromRow', array(&$notification, &$row));

		return $notification;

	}

	/**

	 * Inserts a new notification into notifications table

	 * @param Notification object

	 * @return int Notification Id 

	 */

	function insertNotification(&$notification) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		if ($this->notificationAlreadyExists($notification)) {

			return 0;

		}

		$notificationSettingsDao =& DAORegistry::getDAO('NotificationSettingsDAO');

		$notificationSettings = $notificationSettingsDao->getNotificationSettings($notification->getUserId());

		$notificationEmailSettings = $notificationSettingsDao->getNotificationEmailSettings($notification->getUserId());

		if(in_array($notification->getAssocType(), $notificationEmailSettings)) {

			$this->sendNotificationEmail($notification);

		}

		if(!in_array($notification->getAssocType(), $notificationSettings)) {

			$this->update(

				sprintf('INSERT INTO notifications

					(user_id, date_created, contents, param, location, is_localized, context, product, assoc_type)

					VALUES

					(?, %s, ?, ?, ?, ?, ?, ?, ?)',

					$this->datetimeToDB(date('Y-m-d H:i:s'))),

				array(

					(int) $notification->getUserId(),

					$notification->getContents(),

					$notification->getParam(),

					$notification->getLocation(),

					(int) $notification->getIsLocalized(),

					(int) $notification->getContext(),

					$productName,

					(int) $notification->getAssocType(),

				)

			);

			$notification->setNotificationId($this->getInsertNotificationId());

			return $notification->getNotificationId();

		} else return 0;

	}

	/**

	 * Delete Notification by notification id

	 * @param $notificationId int

	 * @return boolean

	 */

	function deleteNotificationById($notificationId, $userId = null) {

		$params = array($notificationId);

		if (isset($userId)) $params[] = $userId;

		return $this->update('DELETE FROM notifications WHERE notification_id = ?' . (isset($userId) ? ' AND user_id = ?' : ''), 

			$params

		);

	}	

	/**

	 * Check if the same notification was added in the last hour

	 * Will prevent multiple notifications to show up in a user's feed e.g.

	 * if a user edits a submission multiple times in a short time span

	 * @param notification object

	 * @return boolean

	 */

	function notificationAlreadyExists(&$notification) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT date_created FROM notifications WHERE user_id = ? AND contents = ? AND product = ? AND assoc_type = ? AND context = ?',

			array(

					(int) $notification->getUserId(),

					$notification->getContents(),

					$productName,

					(int) $notification->getAssocType(),

					(int) $contextId

				)

		);

		$date = isset($result->fields[0]) ? $result->fields[0] : 0;

		if ($date == 0) {

			return false;

		} else {

			$timeDiff = strtotime($date) - time();

			if ($timeDiff < 3600) { // 1 hour (in seconds)

				return true;

			} else return false;

		}

	}

	/**

	 * Get the ID of the last inserted notification

	 * @return int

	 */

	function getInsertNotificationId() {

		return $this->getInsertId('notifications', 'notification_id');

	}

	/**

	 * Get the number of unread messages for a user

	 * @param $userId int

	 * @return int

	 */

	function getUnreadNotificationCount($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT count(*) FROM notifications WHERE user_id = ? AND date_read IS NULL AND product = ? AND context = ?',

			array((int) $userId, $productName, (int) $contextId)

		);

		$returner = $result->fields[0];

		$result->Close();

		unset($result);

		return $returner;

	}

	/**

	 * Get the number of read messages for a user

	 * @param $userId int

	 * @return int

	 */

	function getReadNotificationCount($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT count(*) FROM notifications WHERE user_id = ? AND date_read IS NOT NULL AND product = ? AND context = ?',

			array((int) $userId, $productName, (int) $contextId)

		);

		$returner = $result->fields[0];

		$result->Close();

		unset($result);

		return $returner;

	}

	/**

	 * Send an email to a user regarding the notification

	 * @param $notification object Notification

	 */

	function sendNotificationEmail($notification) {

		$userId = $notification->getUserId();

		$userDao =& DAORegistry::getDAO('UserDAO');

		$user = $userDao->getUser($userId);

		if ($notification->getIsLocalized()) {

			$params = array('param' => $notification->getParam());

			$notificationContents = Locale::translate($notification->getContents(), $params);

		} else {

			$notificationContents = $notification->getContents();

		}

		import('mail.MailTemplate');

		$site =& Request::getSite();

		$mail = new MailTemplate('NOTIFICATION');

		$mail->setFrom($site->getSiteContactEmail(), $site->getSiteContactName());

		$mail->assignParams(array(

			'notificationContents' => $notificationContents,

			'url' => $notification->getLocation(),

			'siteTitle' => $site->getSiteTitle()

		));

		$mail->addRecipient($user->getEmail(), $user->getFullName());

		$mail->send();

	}	

	/**

	 * Send an update to all users on the mailing list

	 * @param $notification object Notification

	 */

	function sendToMailingList($notification) {

		$notificationSettingsDao =& DAORegistry::getDAO('NotificationSettingsDAO');

		$mailList = $notificationSettingsDao->getMailList();

		foreach ($mailList as $email) {

			if ($notification->getIsLocalized()) {

				$params = array('param' => $notification->getParam());

				$notificationContents = Locale::translate($notification->getContents(), $params);

			} else {

				$notificationContents = $notification->getContents();

			}

			import('mail.MailTemplate');

			$journal =& Request::getJournal();

			$site =& Request::getSite();

			$mail = new MailTemplate('NOTIFICATION_MAILLIST');

			$mail->setFrom($site->getSiteContactEmail(), $site->getSiteContactName());

			$mail->assignParams(array(

				'notificationContents' => $notificationContents,

				'url' => $notification->getLocation(),

				'siteTitle' => $journal->getJournalTitle(),

				'unsubscribeLink' => Request::url(null, 'notification', 'unsubscribeMailList')

			));

			$mail->addRecipient($email);

			$mail->send();

		}

	}	

}

?>

<?php

/**

 * @file classes/notification/NotificationSettingsDAODAO.inc.php

 *

 * Copyright (c) 2003-2008 John Willinsky

 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.

 *

 * @class NotificationSettingsDAO

 * @ingroup notification

 * @see Notification

 *

 * @brief Operations for retrieving and modifying user's notification settings.

 */

// $Id: NotificationSettingsDAO.inc.php,v 1.19 2008/11/05 00:46:39 mcrider Exp $

class NotificationSettingsDAO extends DAO {

	/**

	 * Constructor.

	 */

	function NotificationSettingsDAO() {

		parent::DAO();

	}

	/**

	 * Retrieve Notifications settings by user id

	 * Returns an array of notification types that the user

	 * does NOT want to be notified of

	 * @param $userId int

	 * @return array

	 */

	function &getNotificationSettings($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$notificationSettings = array();

		$result =& $this->retrieve(

			'SELECT setting_value FROM notification_settings WHERE user_id = ? AND product = ? AND setting_name = ? AND context = ?',

				array((int) $userId, $productName, 'notify', (int) $contextId)

		);

		while (!$result->EOF) {

			$row = $result->GetRowAssoc(false);

			$notificationSettings[] = (int) $row['setting_value'];

			$result->moveNext();

		}

		$result->Close();

		unset($result);

		return $notificationSettings;

	}

	/**

	 * Retrieve Notifications email settings by user id

	 * Returns an array of notification types that the user

	 * DOES want to be emailed about

	 * @param $userId int

	 * @return array

	 */

	function &getNotificationEmailSettings($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$emailSettings = array();

		$result =& $this->retrieve(

			'SELECT setting_value FROM notification_settings WHERE user_id = ? AND product = ? AND setting_name = ? AND context = ?',

				array((int) $userId, $productName, 'email', (int) $contextId)

		);

		while (!$result->EOF) {

			$row = $result->GetRowAssoc(false);

			$emailSettings[] = (int) $row['setting_value'];

			$result->moveNext();

		}

		$result->Close();

		unset($result);

		return $emailSettings;

	}

	/**

	 * Update a user's notification settings

	 * @param $notificationSettings array

	 * @param $userId int

	 */

	function updateNotificationSettings($notificationSettings, $userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();		

		// Delete old settings first, then insert new settings

		$this->update('DELETE FROM notification_settings WHERE user_id = ? AND product = ? AND setting_name = ? AND context = ?',

			array((int) $userId, $productName, 'notify', (int) $contextId));

		for ($i=0; $i<count($notificationSettings); $i++) {

			$this->update(

				'INSERT INTO notification_settings

					(setting_name, setting_value, user_id, product, context)

					VALUES

					(?, ?, ?, ?, ?)',

				array(

					"notify",

					$notificationSettings[$i],

					(int) $userId,

					$productName,

					(int) $contextId

				)

			);

		}

	}

	/**

	 * Update a user's notification email settings

	 * @param $notificationEmailSettings array

	 * @param $userId int

	 */

	function updateNotificationEmailSettings($emailSettings, $userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		// Delete old settings first, then insert new settings

		$this->update('DELETE FROM notification_settings WHERE user_id = ? AND product = ? AND setting_name = ? AND context = ?',

			array($userId, $productName, 'email', $contextId));

		for ($i=0; $i<count($emailSettings); $i++) {

			$this->update(

				'INSERT INTO notification_settings

					(setting_name, setting_value, user_id, product, context)

					VALUES

					(?, ?, ?, ?, ?)',

				array(

					"email",

					$emailSettings[$i],

					(int) $userId,

					$productName,

					(int) $contextId

				)

			);

		}

	}

	/**

	 * Gets a user id by an RSS token value

	 * @param $token int

	 * @return int

	 */

	function getUserIdByRSSToken($token) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT user_id FROM notification_settings WHERE setting_value = ? AND setting_name = ? AND product = ? AND context = ?',

				array($token, 'token', $productName, (int) $contextId)

		);

		$row = $result->GetRowAssoc(false);

		$userId = $row['user_id'];

		$result->Close();

		unset($result);

		return $userId;

	}

	/**

	 * Gets an RSS token for a user id

	 * @param $userId int

	 * @return int

	 */

	function getRSSTokenByUserId($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT setting_value FROM notification_settings WHERE user_id = ? AND setting_name = ? AND product = ? AND context = ?',

				array((int) $userId, 'token', $productName, (int) $contextId)

		);

		$row = $result->GetRowAssoc(false);

		$userId = $row['setting_value'];

		$result->Close();

		unset($result);

		return $userId;

	}

	/**

	 * Generates and inserts a new token for a user's RSS feed

	 * @param $userId int

	 * @return int

	 */

	function insertNewRSSToken($userId) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$token = uniqid(rand());

		$this->update(

			'INSERT INTO notification_settings

				(setting_name, setting_value, user_id, product, context)

				VALUES

				(?, ?, ?, ?, ?)',

			array(

				'token',

				$token,

				(int) $userId,

				$productName,

				(int) $contextId

			)

		);

		return $token;

	}

	/**

	 * Generates an access key for the guest user and adds them to the settings table

	 * @param $userId int

	 * @return int

	 */

	function subscribeGuest($email) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		// Check that the email doesn't already exist

		$result =& $this->retrieve(

			'SELECT * FROM notification_settings WHERE setting_name = ? AND setting_value = ? AND product = ? AND context = ?',

			array(

				'mailList',

				$email,

				$productName,

				(int) $contextId

			)

		);

		if ($result->RecordCount() != 0) {

			return false;

		} else {		

			$this->update(

				'INSERT INTO notification_settings

					(setting_name, setting_value, user_id, product, context)

					VALUES

					(?, ?, ?, ?, ?)',

				array(

					'mailListUncomfirmed',

					$email,

					0,

					$productName,

					(int) $contextId

				)

			);

		}	

		// Get assoc_id into notification_settings table, also used as user_id for access key

		$assocId = $this->getInsertNotificationSettingId();

		import('security.AccessKeyManager');

		$accessKeyManager = new AccessKeyManager();

		$password = $accessKeyManager->createKey('MailListContext', $assocId, $assocId, 10000);

		return $password;

	}

	/**

	 * Removes an email address and associated access key from email notifications

	 * @param $email string

	 * @param $password string

	 * @return boolean

	 */

	function unsubscribeGuest($email, $password) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT setting_id FROM notification_settings WHERE setting_name = ? AND product = ? AND context = ?',

			array(

				'mailList',

				$productName,

				(int) $contextId

			)

		);

		$row = $result->GetRowAssoc(false);

		$userId = (int) $row['setting_id'];

		$result->Close();

		unset($result);

		import('security.AccessKeyManager');

		$accessKeyManager = new AccessKeyManager();

		$accessKeyHash = AccessKeyManager::generateKeyHash($password);

		$accessKey = $accessKeyManager->validateKey('MailListContext', $userId, $accessKeyHash);

		if ($accessKey) {

			$this->update(

				'DELETE FROM notification_settings WHERE setting_name = ? AND setting_value = ? AND product = ? AND context = ?',

				array(

					'mailList',

					$email,

					$productName,

					(int) $contextId

				)

			);

			$accessKeyDao =& DAORegistry::getDAO('AccessKeyDAO');

			$accessKeyDao->deleteAccessKey($accessKey);

			return true;

		} else return false;	

	}

	/**

	 * Gets the setting id for a maillist member (to access the accompanying access key)

	 * @return array

	 */

	function getMailListSettingId($email, $settingName = 'mailListUncomfirmed') {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();	

		$result =& $this->retrieve(

			'SELECT setting_id FROM notification_settings WHERE setting_name = ? AND setting_value = ? AND product = ? AND context = ?',

			array(

				$settingName,

				$email,

				$productName,

				(int) $contextId

			)

		);

		$row = $result->GetRowAssoc(false);

		$settingId = (int) $row['setting_id'];

		return $settingId;

	}

	/**

	 * Update the notification settings table to confirm the mailing list subscription

	 * @return boolean

	 */

	function confirmMailListSubscription($settingId) {

		return $this->update(

			'UPDATE notification_settings SET setting_name = ? WHERE setting_id = ?',

			array('mailList', (int) $settingId)

		);

	}

	/**

	 * Gets a list of email addresses of users subscribed to the mailing list

	 * @return array

	 */

	function getMailList() {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$mailList = array();

		$result =& $this->retrieve(

			'SELECT setting_value FROM notification_settings WHERE setting_name = ? AND product = ? AND context = ?',

			array(

				'mailList',

				$productName,

				(int) $contextId

			)

		);

		while (!$result->EOF) {

			$row = $result->GetRowAssoc(false);

			$mailList[] = $row['setting_value'];

			$result->moveNext();

		}

		$result->Close();

		unset($result);

		return $mailList;

	}

	/**

	 * Generates and inserts a new password for a mailing list user

	 * @param $email string

	 * @return string

	 */

	function resetPassword($email) {

		$application =& PKPApplication::getApplication();

		$productName = $application->getName();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$result =& $this->retrieve(

			'SELECT setting_id FROM notification_settings WHERE setting_name = ? AND setting_value = ? AND product = ? AND context = ?',

			array(

				'mailList',

				$email,

				$productName,

				(int) $contextId

			)

		);

		$row = $result->GetRowAssoc(false);

		$settingId = $row['setting_id'];

		$result->Close();

		unset($result);

		$accessKeyDao =& DAORegistry::getDAO('AccessKeyDAO');

		$accessKey = $accessKeyDao->getAccessKeyByUserId('MailListContext', $settingId);

		if ($accessKey) {

			$key = Validation::generatePassword();

			$accessKey->setKeyHash(md5($key));

			$accessKeyDao =& DAORegistry::getDAO('AccessKeyDAO');

			$accessKeyDao->updateAccessKey($accessKey);

			return $key;

		} else return false;

	}

	/**

	 * Get the ID of the last inserted notification

	 * @return int

	 */

	function getInsertNotificationSettingId() {

		return $this->getInsertId('notification_settings', 'setting_id');

	}

}

?>

<?php

/**

 * @file classes/notification/Notification.inc.php

 *

 * Copyright (c) 2003-2008 John Willinsky

 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.

 *

 * @class Notification

 * @ingroup notification

 * @see NotificationDAO

 * @brief Class for Notification.

 */

// $Id: Notification.inc.php,v 1.10 2008/07/01 01:16:09 asmecher Exp $

import('notification.NotificationDAO');

class PKPNotification extends DataObject {

	/**

	 * Constructor.

	 */

	function PKPNotification() {

		parent::DataObject();

	}

	/**

	 * Create a new notification with the specified arguments and insert into DB

	 * This is a static method

	 * @param $userId int

	 * @param $contents string

	 * @param $param string

	 * @param $location string

	 * @param $isLocalized bool

	 * @param $assocType int

	 * @param $assocId int

	 * @return Notification object

	 */

	function createNotification($userId, $contents, $param, $location, $isLocalized, $assocType) {

		$notification = new Notification();

		$context =& Request::getContext();

		$contextId = $context->getId();

		$notification->setUserId($userId);

		$notification->setContents($contents);

		$notification->setParam($param);

		$notification->setLocation($location);

		$notification->setIsLoca