<?php

/**
 * @file PaperMailTemplate.inc.php
 *
 * Copyright (c) 2000-2008 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @package mail
 * @class PaperMailTemplate
 *
 * Subclass of MailTemplate for sending emails related to papers.
 * This allows for paper-specific functionality like logging, etc.
 *
 * $Id: PaperMailTemplate.inc.php,v 1.11 2008/04/04 17:06:45 asmecher Exp $
 */

import('mail.MailTemplate');
import('paper.log.PaperEmailLogEntry'); // Bring in log constants

class PaperMailTemplate extends MailTemplate {

	/** @var object the associated paper */
	var $paper;

	/** @var object the associated conference */
	var $conference;

	/** @var object the associated scheduled conference */
	var $schedConf;

	/** @var int Event type of this email */
	var $eventType;

	/** @var int Associated type of this email */
	var $assocType;

	/** @var int Associated ID of this email */
	var $assocId;

	/**
	 * Constructor.
	 * @param $paper object
	 * @param $emailType int optional
	 * @param $locale string optional
	 * @param $enableAttachments boolean optional
	 * @param $conference object optional
	 * @param $schedConf object optional
	 * @see MailTemplate::MailTemplate()
	 */
	function PaperMailTemplate($paper, $emailKey = null, $locale = null, $enableAttachments = null, $conference = null, $schedConf = null) {
		parent::MailTemplate($emailKey, $locale, $enableAttachments, $conference, $schedConf);
		$this->paper = $paper;
	}

	function assignParams($paramArray = array()) {
		$paper = &$this->paper;
		$conference = isset($this->conference)?$this->conference:Request::getConference();
		$schedConf = isset($this->schedConf)?$this->schedConf:Request::getSchedConf();

		$paramArray['paperTitle'] = strip_tags($paper->getPaperTitle());
		$paramArray['conferenceName'] = strip_tags($conference->getConferenceTitle());
		$paramArray['schedConfName'] = strip_tags($schedConf->getSchedConfTitle());
		$paramArray['trackName'] = strip_tags($paper->getTrackTitle());
		$paramArray['paperAbstract'] = strip_tags($paper->getPaperAbstract());
		$paramArray['presenterString'] = strip_tags($paper->getPresenterString());

		parent::assignParams($paramArray);
	}

	/**
	 * @see parent::send()
	 */
	function send() {
		if (parent::send()) {
			if (!isset($this->skip) || !$this->skip) $this->log();
			return true;

		} else {
			return false;
		}
	}

	/**
	 * @see parent::sendWithParams()
	 */
	function sendWithParams($paramArray) {
		$savedSubject = $this->getSubject();
		$savedBody = $this->getBody();

		$this->assignParams($paramArray);

		$ret = $this->send();

		$this->setSubject($savedSubject);
		$this->setBody($savedBody);

		return $ret;
	}

	/**
	 * Add a generic association between this email and some event type / type / ID tuple.
	 * @param $eventType int
	 * @param $assocType int
	 * @param $assocId int
	 */
	function setAssoc($eventType, $assocType, $assocId) {
		$this->eventType = $eventType;
		$this->assocType = $assocType;
		$this->assocId = $assocId;
	}

	/**
	 * Set the conference this message is associated with.
	 * @param $conference object
	 */
	function setConference($conference) {
		$this->conference = $conference;
	}

	/**
	 * Set the scheduled conference this message is associated with.
	 * @param $schedConf object
	 */
	function setSchedConf($schedConf) {
		$this->schedConf = $schedConf;
	}

	/**
	 * Save the email in the paper email log.
	 */
	function log() {
		import('paper.log.PaperEmailLogEntry');
		import('paper.log.PaperLog');
		$entry = &new PaperEmailLogEntry();

		// Log data
		$entry->setEventType($this->eventType);
		$entry->setAssocType($this->assocType);
		$entry->setAssocId($this->assocId);

		// Email data
		$entry->setSubject($this->getSubject());
		$entry->setBody($this->getBody());
		$entry->setFrom($this->getFromString());
		$entry->setRecipients($this->getRecipientString());
		$entry->setCcs($this->getCcString());
		$entry->setBccs($this->getBccString());

		// Add log entry
		$paper = &$this->paper;
		PaperLog::logEmailEntry($paper->getPaperId(), $entry);
	}

	function ccAssignedDirectors($paperId) {
		$returner = array();
		$editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');
		$editAssignments =& $editAssignmentDao->getDirectorAssignmentsByPaperId($paperId);
		while ($editAssignment =& $editAssignments->next()) {
			$this->addCc($editAssignment->getDirectorEmail(), $editAssignment->getDirectorFullName());
			$returner[] =& $editAssignment;
			unset($editAssignment);
		}
		return $returner;
	}

	function toAssignedDirectors($paperId) {
		$returner = array();
		$editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');
		$editAssignments =& $editAssignmentDao->getDirectorAssignmentsByPaperId($paperId);
		while ($editAssignment =& $editAssignments->next()) {
			$this->addRecipient($editAssignment->getDirectorEmail(), $editAssignment->getDirectorFullName());
			$returner[] =& $editAssignment;
			unset($editAssignment);
		}
		return $returner;
	}

	function toAssignedTrackDirectors($paperId) {
		$returner = array();
		$editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');
		$editAssignments =& $editAssignmentDao->getTrackDirectorAssignmentsByPaperId($paperId);
		while ($editAssignment =& $editAssignments->next()) {
			$this->addRecipient($editAssignment->getDirectorEmail(), $editAssignment->getDirectorFullName());
			$returner[] =& $editAssignment;
			unset($editAssignment);
		}
		return $returner;
	}

	function ccAssignedTrackDirectors($paperId) {
		$returner = array();
		$editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');
		$editAssignments =& $editAssignmentDao->getTrackDirectorAssignmentsByPaperId($paperId);
		while ($editAssignment =& $editAssignments->next()) {
			$this->addCc($editAssignment->getDirectorEmail(), $editAssignment->getDirectorFullName());
			$returner[] =& $editAssignment;
			unset($editAssignment);
		}
		return $returner;
	}
}

?>