InformationCenterHandler.inc.php

<?php
 
import('classes.handler.Handler');
import('lib.pkp.classes.core.JSONMessage');
import('classes.log.SubmissionEventLogEntry');
 
abstract class InformationCenterHandler extends Handler {
   var $_submission;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_SUB_EDITOR, ROLE_ID_MANAGER),
         array(
            'viewInformationCenter',
            'viewHistory',
            'viewNotes', 'listNotes', 'saveNote', 'deleteNote',
         )
      );
   }
 
 
   //
   // Implement template methods from PKPHandler.
   //
   function authorize($request, &$args, $roleAssignments) {
      // Require a submission
      import('lib.pkp.classes.security.authorization.SubmissionAccessPolicy');
      $this->addPolicy(new SubmissionAccessPolicy($request, $args, $roleAssignments, 'submissionId'));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request) {
      parent::initialize($request);
 
      // Fetch the submission and file to display information about
      $this->_submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
   }
 
 
   //
   // Public operations
   //
   function viewInformationCenter($args, $request) {
      $this->setupTemplate($request);
      $templateMgr = TemplateManager::getManager($request);
      return $templateMgr->fetchJson('controllers/informationCenter/informationCenter.tpl');
   }
 
   abstract function viewNotes($args, $request);
 
   abstract function saveNote($args, $request);
 
   function deleteNote($args, $request) {
      $this->setupTemplate($request);
 
      $noteId = (int) $request->getUserVar('noteId');
      $noteDao = DAORegistry::getDAO('NoteDAO'); /* @var $noteDao NoteDAO */
      $note = $noteDao->getById($noteId);
 
      if (!$request->checkCSRF() || !$note || $note->getAssocType() != $this->_getAssocType() || $note->getAssocId() != $this->_getAssocId()) fatalError('Invalid note!');
      $noteDao->deleteById($noteId);
 
      $user = $request->getUser();
      NotificationManager::createTrivialNotification($user->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => __('notification.removedNote')));
 
      $json = new JSONMessage(true);
      $jsonViewNotesResponse = $this->viewNotes($args, $request);
      $json->setEvent('dataChanged');
      $json->setEvent('noteDeleted', $jsonViewNotesResponse->_content);
 
      return $json;
   }
 
   function _listNotes($args, $request) {
      $this->setupTemplate($request);
 
      $templateMgr = TemplateManager::getManager($request);
      $noteDao = DAORegistry::getDAO('NoteDAO'); /* @var $noteDao NoteDAO */
      $templateMgr->assign('notes', $noteDao->getByAssoc($this->_getAssocType(), $this->_getAssocId()));
 
      $user = $request->getUser();
      $templateMgr->assign('currentUserId', $user->getId());
      $templateMgr->assign('notesDeletable', true);
 
      $templateMgr->assign('notesListId', 'notesList');
 
      return $templateMgr->fetch('controllers/informationCenter/notesList.tpl');
   }
 
   function _getLinkParams() {
      return array(
         'submissionId' => $this->_submission->getId(),
      );
   }
 
   function _logEvent($request, $object, $eventType, $logClass) {
      // Get the log event message
      switch($eventType) {
         case SUBMISSION_LOG_NOTE_POSTED:
            $logMessage = 'informationCenter.history.notePosted';
            break;
         case SUBMISSION_LOG_MESSAGE_SENT:
            $logMessage = 'informationCenter.history.messageSent';
            break;
         default:
            assert(false);
      }
      import('lib.pkp.classes.log.SubmissionFileLog');
      $logClass::logEvent($request, $object, $eventType, $logMessage);
   }
 
   function setupTemplate($request) {
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_SUBMISSION, LOCALE_COMPONENT_PKP_SUBMISSION);
 
      $linkParams = $this->_getLinkParams();
      $templateMgr = TemplateManager::getManager($request);
 
      // Preselect tab from keywords 'notes', 'notify', 'history'
      switch ($request->getUserVar('tab')) {
         case 'history':
            $templateMgr->assign('selectedTabIndex', 2);
            break;
         case 'notify':
            $userId = (int) $request->getUserVar('userId');
            if ($userId) {
               $linkParams['userId'] = $userId; // user validated in Listbuilder.
            }
            $templateMgr->assign('selectedTabIndex', 1);
            break;
         // notes is default
         default:
            $templateMgr->assign('selectedTabIndex', 0);
            break;
      }
 
      $templateMgr->assign('linkParams', $linkParams);
      parent::setupTemplate($request);
   }
 
   abstract function _getAssocId();
 
   abstract function _getAssocType();
}