classes/submission/layoutEditor/LayoutEditorAction.inc.php

<?php

// $Id: LayoutEditorAction.inc.php,v 1.38 2008/07/01 01:16:11 asmecher Exp $


import('submission.common.Action');

class LayoutEditorAction extends Action {

   //
   // Actions
   //

   function orderGalley($article, $galleyId, $direction) {
      $galleyDao = &DAORegistry::getDAO('ArticleGalleyDAO');
      $galley = &$galleyDao->getGalley($galleyId, $article->getArticleId());

      if (isset($galley)) {
         $galley->setSequence($galley->getSequence() + ($direction == 'u' ? -1.5 : 1.5));
         $galleyDao->updateGalley($galley);
         $galleyDao->resequenceGalleys($article->getArticleId());
      }
   }

   function deleteGalley($article, $galleyId) {
      import('file.ArticleFileManager');

      $galleyDao = &DAORegistry::getDAO('ArticleGalleyDAO');
      $galley = &$galleyDao->getGalley($galleyId, $article->getArticleId());

      if (isset($galley) && !HookRegistry::call('LayoutEditorAction::deleteGalley', array(&$article, &$galley))) {
         $articleFileManager = &new ArticleFileManager($article->getArticleId());

         if ($galley->getFileId()) {
            $articleFileManager->deleteFile($galley->getFileId());
            import('search.ArticleSearchIndex');
            ArticleSearchIndex::deleteTextIndex($article->getArticleId(), ARTICLE_SEARCH_GALLEY_FILE, $galley->getFileId());
         }
         if ($galley->isHTMLGalley()) {
            if ($galley->getStyleFileId()) {
               $articleFileManager->deleteFile($galley->getStyleFileId());
            }
            foreach ($galley->getImageFiles() as $image) {
               $articleFileManager->deleteFile($image->getFileId());
            }
         }
         $galleyDao->deleteGalley($galley);
      }
   }

   function deleteArticleImage($submission, $fileId, $revision) {
      import('file.ArticleFileManager');
      $articleGalleyDao =& DAORegistry::getDAO('ArticleGalleyDAO');
      if (HookRegistry::call('LayoutEditorAction::deleteArticleImage', array(&$submission, &$fileId, &$revision))) return;
      foreach ($submission->getGalleys() as $galley) {
         $images =& $articleGalleyDao->getGalleyImages($galley->getGalleyId());
         foreach ($images as $imageFile) {
            if ($imageFile->getArticleId() == $submission->getArticleId() && $fileId == $imageFile->getFileId() && $imageFile->getRevision() == $revision) {
               $articleFileManager = &new ArticleFileManager($submission->getArticleId());
               $articleFileManager->deleteFile($imageFile->getFileId(), $imageFile->getRevision());
            }
         }
         unset($images);
      }
   }

   function orderSuppFile($article, $suppFileId, $direction) {
      $suppFileDao = &DAORegistry::getDAO('SuppFileDAO');
      $suppFile = &$suppFileDao->getSuppFile($suppFileId, $article->getArticleId());

      if (isset($suppFile)) {
         $suppFile->setSequence($suppFile->getSequence() + ($direction == 'u' ? -1.5 : 1.5));
         $suppFileDao->updateSuppFile($suppFile);
         $suppFileDao->resequenceSuppFiles($article->getArticleId());
      }
   }

   function deleteSuppFile($article, $suppFileId) {
      import('file.ArticleFileManager');

      $suppFileDao = &DAORegistry::getDAO('SuppFileDAO');

      $suppFile = &$suppFileDao->getSuppFile($suppFileId, $article->getArticleId());
      if (isset($suppFile) && !HookRegistry::call('LayoutEditorAction::deleteSuppFile', array(&$article, &$suppFile))) {
         if ($suppFile->getFileId()) {
            $articleFileManager = &new ArticleFileManager($article->getArticleId());
            $articleFileManager->deleteFile($suppFile->getFileId());
            import('search.ArticleSearchIndex');
            ArticleSearchIndex::deleteTextIndex($article->getArticleId(), ARTICLE_SEARCH_SUPPLEMENTARY_FILE, $suppFile->getFileId());
         }
         $suppFileDao->deleteSuppFile($suppFile);
      }
   }

   function completeLayoutEditing($submission, $send = false) {
      $submissionDao = &DAORegistry::getDAO('LayoutEditorSubmissionDAO');
      $userDao = &DAORegistry::getDAO('UserDAO');
      $journal = &Request::getJournal();

      $layoutAssignment = &$submission->getLayoutAssignment();
      if ($layoutAssignment->getDateCompleted() != null) {
         return true;
      }

      import('mail.ArticleMailTemplate');
      $email = &new ArticleMailTemplate($submission, 'LAYOUT_COMPLETE');

      $editAssignments = &$submission->getEditAssignments();
      if (empty($editAssignments)) return;

      if (!$email->isEnabled() || ($send && !$email->hasErrors())) {
         HookRegistry::call('LayoutEditorAction::completeLayoutEditing', array(&$submission, &$layoutAssignment, &$editAssignments, &$email));
         if ($email->isEnabled()) {
            $email->setAssoc(ARTICLE_EMAIL_LAYOUT_NOTIFY_COMPLETE, ARTICLE_EMAIL_TYPE_LAYOUT, $layoutAssignment->getLayoutId());
            $email->send();
         }

         $layoutAssignment->setDateCompleted(Core::getCurrentDate());
         $submissionDao->updateSubmission($submission);

         // Add log entry
         $user = &Request::getUser();
         import('article.log.ArticleLog');
         import('article.log.ArticleEventLogEntry');
         ArticleLog::logEvent($submission->getArticleId(), ARTICLE_LOG_LAYOUT_COMPLETE, ARTICLE_LOG_TYPE_LAYOUT, $user->getUserId(), 'log.layout.layoutEditComplete', Array('editorName' => $user->getFullName(), 'articleId' => $submission->getArticleId()));

         return true;
      } else {
         $user = &Request::getUser();
         if (!Request::getUserVar('continued')) {
            $assignedSectionEditors = $email->toAssignedEditingSectionEditors($submission->getArticleId());
            $assignedEditors = $email->ccAssignedEditors($submission->getArticleId());
            if (empty($assignedSectionEditors) && empty($assignedEditors)) {
               $email->addRecipient($journal->getSetting('contactEmail'), $journal->getSetting('contactName'));
               $editorialContactName = $journal->getSetting('contactName');
            } else {
               $editorialContact = array_shift($assignedSectionEditors);
               if (!$editorialContact) $editorialContact = array_shift($assignedEditors);
               $editorialContactName = $editorialContact->getEditorFullName();
            }
            $paramArray = array(
               'editorialContactName' => $editorialContactName,
               'layoutEditorName' => $user->getFullName()
            );
            $email->assignParams($paramArray);
         }
         $email->displayEditForm(Request::url(null, 'layoutEditor', 'completeAssignment', 'send'), array('articleId' => $submission->getArticleId()));

         return false;
      }
   }

   function uploadLayoutVersion($submission) {
      import('file.ArticleFileManager');
      $articleFileManager = &new ArticleFileManager($submission->getArticleId());
      $layoutEditorSubmissionDao = &DAORegistry::getDAO('LayoutEditorSubmissionDAO');

      $layoutDao = &DAORegistry::getDAO('LayoutAssignmentDAO');
      $layoutAssignment = &$layoutDao->getLayoutAssignmentByArticleId($submission->getArticleId());

      $fileName = 'layoutFile';
      if ($articleFileManager->uploadedFileExists($fileName) && !HookRegistry::call('LayoutEditorAction::uploadLayoutVersion', array(&$submission, &$layoutAssignment))) {
         $layoutFileId = $articleFileManager->uploadLayoutFile($fileName, $layoutAssignment->getLayoutFileId());
         $layoutAssignment->setLayoutFileId($layoutFileId);
         $layoutDao->updateLayoutAssignment($layoutAssignment);
      }
   }

   //
   // Comments
   //

   function viewLayoutComments($article) {
      if (!HookRegistry::call('LayoutEditorAction::viewLayoutComments', array(&$article))) {
         import("submission.form.comment.LayoutCommentForm");

         $commentForm = &new LayoutCommentForm($article, ROLE_ID_LAYOUT_EDITOR);
         $commentForm->initData();
         $commentForm->display();
      }
   }

   function postLayoutComment($article, $emailComment) {
      if (!HookRegistry::call('LayoutEditorAction::postLayoutComment', array(&$article, &$emailComment))) {
         import("submission.form.comment.LayoutCommentForm");

         $commentForm = &new LayoutCommentForm($article, ROLE_ID_LAYOUT_EDITOR);
         $commentForm->readInputData();

         if ($commentForm->validate()) {
            $commentForm->execute();

            if ($emailComment) {
               $commentForm->email();
            }

         } else {
            $commentForm->display();
            return false;
         }
         return true;
      }
   }

   function viewProofreadComments($article) {
      if (!HookRegistry::call('LayoutEditorAction::viewProofreadComments', array(&$article))) {
         import("submission.form.comment.ProofreadCommentForm");

         $commentForm = &new ProofreadCommentForm($article, ROLE_ID_LAYOUT_EDITOR);
         $commentForm->initData();
         $commentForm->display();
      }
   }

   function postProofreadComment($article, $emailComment) {
      if (!HookRegistry::call('LayoutEditorAction::postProofreadComment', array(&$article, &$emailComment))) {
         import('submission.form.comment.ProofreadCommentForm');

         $commentForm = &new ProofreadCommentForm($article, ROLE_ID_LAYOUT_EDITOR);
         $commentForm->readInputData();

         if ($commentForm->validate()) {
            $commentForm->execute();

            if ($emailComment) {
               $commentForm->email();
            }

         } else {
            $commentForm->display();
            return false;
         }
         return true;
      }
   }

   //
   // Misc
   //

   function downloadFile($article, $fileId, $revision = null) {
      $canDownload = false;

      $layoutDao = &DAORegistry::getDAO('LayoutAssignmentDAO');
      $galleyDao = &DAORegistry::getDAO('ArticleGalleyDAO');
      $suppDao = &DAORegistry::getDAO('SuppFileDAO');

      $layoutAssignment = &$layoutDao->getLayoutAssignmentByArticleId($article->getArticleId());

      if ($layoutAssignment->getLayoutFileId() == $fileId) {
         $canDownload = true;

      } else if($galleyDao->galleyExistsByFileId($article->getArticleId(), $fileId)) {
         $canDownload = true;

      } else if($suppDao->suppFileExistsByFileId($article->getArticleId(), $fileId)) {
         $canDownload = true;
      }

      $result = false;
      if (!HookRegistry::call('LayoutEditorAction::downloadFile', array(&$article, &$fileId, &$revision, &$canDownload, &$result))) {
         if ($canDownload) {
            return parent::downloadFile($article->getArticleId(), $fileId, $revision);
         } else {
            return false;
         }
      }
      return $result;
   }
}

?>

---