controllers/grid/files/signoff/form/FileAuditorForm.inc.php

<?php

import('lib.pkp.classes.form.Form');

class FileAuditorForm extends Form {
   var $_monograph;

   var $_fileStage;

   var $_stageId;

   var $_symbolic;

   var $_eventType;

   var $_assocId;

   var $_publicationFormatId;

   var $_signoffId;

   var $_fileId;

   function FileAuditorForm($monograph, $fileStage, $stageId, $symbolic, $eventType, $assocId = null, $publicationFormatId = null) {
      parent::Form('controllers/grid/files/signoff/form/addAuditor.tpl');
      $this->_monograph =& $monograph;
      $this->_fileStage = $fileStage;
      $this->_stageId = $stageId;
      $this->_symbolic = $symbolic;
      $this->_eventType = $eventType;
      $this->_assocId = $assocId;
      $this->_publicationFormatId = $publicationFormatId;

      $this->addCheck(new FormValidator($this, 'userId', 'required', 'editor.monograph.fileAuditor.form.userRequired'));
      $this->addCheck(new FormValidatorListBuilder($this, 'files', 'editor.monograph.fileAuditor.form.fileRequired'));
      $this->addCheck(new FormValidator($this, 'personalMessage', 'required', 'editor.monograph.fileAuditor.form.messageRequired'));
      $this->addCheck(new FormValidatorPost($this));
   }

   function getMonograph() {
      return $this->_monograph;
   }

   function getFileStage() {
      return $this->_fileStage;
   }
   function getStageId() {
      return $this->_stageId;
   }

   function getSymbolic() {
      return $this->_symbolic;
   }

   function getEventType() {
      return $this->_eventType;
   }

   function getAssocId() {
      return $this->_assocId;
   }

   function getPublicationFormatId() {
      return $this->_publicationFormatId;
   }

   function getSignoffId() {
      return $this->_signoffId;
   }

   function getFileId() {
      return $this->_fileId;
   }


   //
   // Overridden template methods
   //
   function initData($args, &$request) {
      $monograph = $this->getMonograph();
      $this->setData('monographId', $monograph->getId());
      $this->setData('fileStage', $this->getFileStage());
      $this->setData('assocId', $this->getAssocId());
      if ($this->getPublicationFormatId()) {
         $this->setData('publicationFormatId', $this->getPublicationFormatId());
      }
      import('classes.mail.MonographMailTemplate');
      $email = new MonographMailTemplate($monograph, 'AUDITOR_REQUEST');
      $user =& $request->getUser();
      // Intentionally omit {$auditorName} for now -- see bug #7090
      $email->assignParams(array(
         'editorialContactSignature' => $user->getContactSignature(),
         'monographTitle' => $monograph->getSeriesTitle(),
         'weekLaterDate' => strftime(
            Config::getVar('general', 'date_format_short'),
            time() + 604800 // 60 * 60 * 24 * 7 seconds
         ),
      ));

      $press =& $request->getPress();
      $this->setData('personalMessage', $email->getBody() . "\n" . $press->getSetting('emailSignature'));
   }

   function readInputData() {
      $this->readUserVars(array('userId-GroupId', 'files', 'responseDueDate', 'personalMessage', 'skipEmail'));

      list($userId, $userGroupId) = explode('-', $this->getData('userId-GroupId'));
      $this->setData('userId', $userId);
      $this->setData('userGroupId', $userGroupId);
   }

   function execute(&$request) {
      // Decode the "files" list
      import('lib.pkp.classes.controllers.listbuilder.ListbuilderHandler');
      ListbuilderHandler::unpack($request, $this->getData('files'));

      // Send the message to the user
      $monograph =& $this->getMonograph();
      import('classes.mail.MonographMailTemplate');
      $email = new MonographMailTemplate($monograph, 'AUDITOR_REQUEST', null, null, null, false);
      $email->setBody($this->getData('personalMessage'));

      $userDao =& DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      // FIXME: How to validate user IDs?
      $user =& $userDao->getById($this->getData('userId'));
      import('controllers.grid.submissions.SubmissionsListGridCellProvider');
      list($page, $operation) = SubmissionsListGridCellProvider::getPageAndOperationByUserRoles($request, $monograph, $user->getId());

      $dispatcher =& $request->getDispatcher();
      $auditUrl = $dispatcher->url($request, ROUTE_PAGE, null, $page, $operation, array('monographId' => $monograph->getId()));

      // Other parameters assigned above; see bug #7090.
      $email->assignParams(array(
         'auditorName' => $user->getFullName(),
         'auditorUserName' => $user->getUsername(),
         'auditUrl' => $auditUrl,
      ));

      $email->addRecipient($user->getEmail(), $user->getFullName());
      $email->setEventType($this->getEventType());
      if (!$this->getData('skipEmail')) {
         $email->send($request);
      }
   }

   function insertEntry(&$request, $newRowId) {
      // Fetch and validate the file ID
      $fileId = (int) $newRowId['name'];
      $monograph =& $this->getMonograph();
      $submissionFileDao =& DAORegistry::getDAO('SubmissionFileDAO');
      $monographFile =& $submissionFileDao->getLatestRevision($fileId, null, $monograph->getId());
      assert($monographFile);

      // FIXME: How to validate user IDs?
      $userId = (int) $this->getData('userId');

      // Fetch and validate user group ID
      $userGroupId = (int) $this->getData('userGroupId');
      $press =& $request->getPress();
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $userGroup =& $userGroupDao->getById($userGroupId, $press->getId());

      // Build the signoff.
      $monographFileSignoffDao =& DAORegistry::getDAO('MonographFileSignoffDAO');
      $signoff =& $monographFileSignoffDao->build(
         $this->getSymbolic(),
         $monographFile->getFileId(),
         $userId, $userGroup->getId()
      ); /* @var $signoff Signoff */

      // Set the date notified
      $signoff->setDateNotified(Core::getCurrentDate());

      // Set the date response due (stored as date underway in signoffs table)
      $dueDateParts = explode('-', $this->getData('responseDueDate'));
      $signoff->setDateUnderway(date('Y-m-d H:i:s', mktime(0, 0, 0, $dueDateParts[0], $dueDateParts[1], $dueDateParts[2])));
      $monographFileSignoffDao->updateObject($signoff);

      $this->_signoffId = $signoff->getId();
      $this->_fileId = $signoff->getAssocId();

      // Update NOTIFICATION_TYPE_AUDITOR_REQUEST.
      $notificationMgr = new NotificationManager();
      $notificationMgr->updateAuditorRequestNotification($signoff, $request);

      // log the add auditor event.
      import('classes.log.MonographFileLog');
      import('classes.log.MonographFileEventLogEntry'); // constants
      $userDao =& DAORegistry::getDAO('UserDAO');
      $user =& $userDao->getById($userId);
      if (isset($user)) {
         MonographFileLog::logEvent($request, $monographFile, MONOGRAPH_LOG_FILE_AUDITOR_ASSIGN, 'submission.event.fileAuditorAdded', array('file' => $monographFile->getOriginalFileName(), 'name' => $user->getFullName(), 'username' => $user->getUsername()));
      }
      // Update NOTIFICATION_TYPE_SIGNOFF_...
      $notificationMgr->updateSignoffNotification($signoff, $request);
   }

   function deleteEntry(&$request, $rowId) {
      return true;
   }
}

?>