<?php

/**
 * @file controllers/grid/eventLog/SubmissionEventLogGridHandler.inc.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class SubmissionEventLogGridHandler
 * @ingroup controllers_grid_eventLog
 *
 * @brief Grid handler presenting the submission event log grid.
 */

// import grid base classes
import('lib.pkp.classes.controllers.grid.GridHandler');

// Link action & modal classes
import('lib.pkp.classes.linkAction.request.AjaxModal');

// Other classes used by this grid
import('lib.pkp.controllers.grid.eventLog.EventLogGridRow');
import('lib.pkp.classes.controllers.grid.DateGridCellProvider');
import('lib.pkp.controllers.grid.eventLog.EventLogGridCellProvider');

class SubmissionEventLogGridHandler extends GridHandler {
	/** @var Submission */
	var $_submission;

	/** @var int The current workflow stage */
	var $_stageId;

	/** @var boolean Is the current user assigned as an author to this submission */
	var $_isCurrentUserAssignedAuthor;

	/**
	 * Constructor
	 */
	function __construct() {
		parent::__construct();
		$this->addRoleAssignment(
			array(ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR),
			array('fetchGrid', 'fetchRow', 'viewEmail')
		);
	}


	//
	// Getters/Setters
	//
	/**
	 * Get the submission associated with this grid.
	 * @return Submission
	 */
	function getSubmission() {
		return $this->_submission;
	}

	/**
	 * Set the Submission
	 * @param $submission Submission
	 */
	function setSubmission($submission) {
		$this->_submission = $submission;
	}


	//
	// Overridden methods from PKPHandler
	//
	/**
	 * @see PKPHandler::authorize()
	 * @param $request PKPRequest
	 * @param $args array
	 * @param $roleAssignments array
	 */
	function authorize($request, &$args, $roleAssignments) {
		import('lib.pkp.classes.security.authorization.SubmissionAccessPolicy');
		$this->addPolicy(new SubmissionAccessPolicy($request, $args, $roleAssignments));

		import('lib.pkp.classes.security.authorization.internal.UserAccessibleWorkflowStageRequiredPolicy');
		$this->addPolicy(new UserAccessibleWorkflowStageRequiredPolicy($request, WORKFLOW_TYPE_EDITORIAL));

		$success = parent::authorize($request, $args, $roleAssignments);

		// Prevent authors from accessing review details, even if they are also
		// assigned as an editor, sub-editor or assistant.
		$userAssignedRoles = $this->getAuthorizedContextObject(ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES);
		$this->_isCurrentUserAssignedAuthor = false;
		foreach ($userAssignedRoles as $stageId => $roles) {
			if (in_array(ROLE_ID_AUTHOR, $roles)) {
				$this->_isCurrentUserAssignedAuthor = true;
				break;
			}
		}

		return $success;
	}

	/**
	 * @copydoc GridHandler::initialize()
	 */
	function initialize($request, $args = null) {
		parent::initialize($request, $args);

		// Retrieve the authorized monograph.
		$submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
		$this->setSubmission($submission);

		$this->_stageId = (int) $args['stageId'];

		// Load submission-specific translations
		AppLocale::requireComponents(
			LOCALE_COMPONENT_APP_SUBMISSION,
			LOCALE_COMPONENT_PKP_SUBMISSION,
			LOCALE_COMPONENT_APP_EDITOR,
			LOCALE_COMPONENT_PKP_EDITOR
		);

		// Columns
		$cellProvider = new EventLogGridCellProvider($this->_isCurrentUserAssignedAuthor);
		$this->addColumn(
			new GridColumn(
				'date',
				'common.date',
				null,
				null,
				new DateGridCellProvider(
					$cellProvider,
					\Application::get()->getRequest()->getContext()->getLocalizedDateFormatShort()
				)
			)
		);
		$this->addColumn(
			new GridColumn(
				'user',
				'common.user',
				null,
				null,
				$cellProvider
			)
		);
		$this->addColumn(
			new GridColumn(
				'event',
				'common.event',
				null,
				null,
				$cellProvider,
				array('width' => 60)
			)
		);
	}


	//
	// Overridden methods from GridHandler
	//
	/**
	 * @see GridHandler::getRowInstance()
	 * @return EventLogGridRow
	 */
	protected function getRowInstance() {
		return new EventLogGridRow($this->getSubmission(), $this->_isCurrentUserAssignedAuthor);
	}

	/**
	 * Get the arguments that will identify the data in the grid
	 * In this case, the monograph.
	 * @return array
	 */
	function getRequestArgs() {
		$submission = $this->getSubmission();

		return array(
			'submissionId' => $submission->getId(),
			'stageId' => $this->_stageId,
		);
	}

	/**
	 * @copydoc GridHandler::loadData
	 */
	protected function loadData($request, $filter = null) {
		$submissionEventLogDao = DAORegistry::getDAO('SubmissionEventLogDAO'); /* @var $submissionEventLogDao SubmissionEventLogDAO */
		$submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /* @var $submissionEmailLogDao SubmissionEmailLogDAO */

		$submission = $this->getSubmission();

		$eventLogEntries = $submissionEventLogDao->getBySubmissionId($submission->getId());
		$emailLogEntries = $submissionEmailLogDao->getBySubmissionId($submission->getId());

		$entries = array_merge($eventLogEntries->toArray(), $emailLogEntries->toArray());

		// Sort the merged data by date, most recent first
		usort($entries, function($a, $b) {
			$aDate = is_a($a, 'EventLogEntry') ? $a->getDateLogged() : $a->getDateSent();
			$bDate = is_a($b, 'EventLogEntry') ? $b->getDateLogged() : $b->getDateSent();

			if ($aDate == $bDate) return 0;

			return $aDate < $bDate ? 1 : -1;
		});

		return $entries;
	}

	/**
	 * Get the contents of the email
	 * @param $args array
	 * @param $request PKPRequest
	 * @return JSONMessage JSON object
	 */
	function viewEmail($args, $request) {
		$submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /* @var $submissionEmailLogDao SubmissionEmailLogDAO */
		$emailLogEntry = $submissionEmailLogDao->getById((int) $args['emailLogEntryId']);
		return new JSONMessage(true, $this->_formatEmail($emailLogEntry));
	}

	/**
	 * Format the contents of the email
	 * @param $emailLogEntry EmailLogEntry
	 * @return string Formatted email
	 */
	function _formatEmail($emailLogEntry) {
		assert(is_a($emailLogEntry, 'EmailLogEntry'));

		$text = array();
		$text[] = __('email.from') . ': ' . htmlspecialchars($emailLogEntry->getFrom());
		$text[] =  __('email.to') . ': ' . htmlspecialchars($emailLogEntry->getRecipients());
		$text[] =  __('email.subject') . ': ' . htmlspecialchars($emailLogEntry->getSubject());
		$text[] = $emailLogEntry->getBody();

		return nl2br(PKPString::stripUnsafeHtml(implode(PHP_EOL . PHP_EOL, $text)));
	}
}