classes/submission/author/AuthorSubmissionDAO.inc.php

<?php

// $Id: AuthorSubmissionDAO.inc.php,v 1.43 2008/07/01 01:16:10 asmecher Exp $


import('submission.author.AuthorSubmission');

class AuthorSubmissionDAO extends DAO {
   var $articleDao;
   var $authorDao;
   var $userDao;
   var $reviewAssignmentDao;
   var $articleFileDao;
   var $suppFileDao;
   var $copyeditorSubmissionDao;
   var $articleCommentDao;
   var $layoutAssignmentDao;
   var $proofAssignmentDao;
   var $galleyDao;

   function AuthorSubmissionDAO() {
      parent::DAO();
      $this->articleDao = &DAORegistry::getDAO('ArticleDAO');
      $this->authorDao = &DAORegistry::getDAO('AuthorDAO');
      $this->userDao = &DAORegistry::getDAO('UserDAO');
      $this->reviewAssignmentDao = &DAORegistry::getDAO('ReviewAssignmentDAO');
      $this->editAssignmentDao = &DAORegistry::getDAO('EditAssignmentDAO');
      $this->articleFileDao = &DAORegistry::getDAO('ArticleFileDAO');
      $this->suppFileDao = &DAORegistry::getDAO('SuppFileDAO');
      $this->copyeditorSubmissionDao = &DAORegistry::getDAO('CopyeditorSubmissionDAO');
      $this->articleCommentDao = &DAORegistry::getDAO('ArticleCommentDAO');
      $this->layoutAssignmentDao = &DAORegistry::getDAO('LayoutAssignmentDAO');
      $this->proofAssignmentDao = &DAORegistry::getDAO('ProofAssignmentDAO');
      $this->galleyDao = &DAORegistry::getDAO('ArticleGalleyDAO');
   }

   function &getAuthorSubmission($articleId) {
      $primaryLocale = Locale::getPrimaryLocale();
      $locale = Locale::getLocale();
      $result = &$this->retrieve(
         'SELECT  a.*,
            COALESCE(stl.setting_value, stpl.setting_value) AS section_title,
            COALESCE(sal.setting_value, sapl.setting_value) AS section_abbrev,
            c.copyed_id, c.copyeditor_id, c.date_notified AS copyeditor_date_notified, c.date_underway AS copyeditor_date_underway, c.date_completed AS copyeditor_date_completed, c.date_acknowledged AS copyeditor_date_acknowledged, c.date_author_notified AS ce_date_author_notified, c.date_author_underway AS ce_date_author_underway, c.date_author_completed AS ce_date_author_completed,
            c.date_author_acknowledged AS ce_date_author_acknowledged, c.date_final_notified AS ce_date_final_notified, c.date_final_underway AS ce_date_final_underway, c.date_final_completed AS ce_date_final_completed, c.date_final_acknowledged AS ce_date_final_acknowledged, c.initial_revision AS copyeditor_initial_revision, c.editor_author_revision AS ce_editor_author_revision,
            c.final_revision AS copyeditor_final_revision
         FROM articles a
            LEFT JOIN sections s ON (s.section_id = a.section_id)
            LEFT JOIN copyed_assignments c on (a.article_id = c.article_id)
            LEFT JOIN section_settings stpl ON (s.section_id = stpl.section_id AND stpl.setting_name = ? AND stpl.locale = ?)
            LEFT JOIN section_settings stl ON (s.section_id = stl.section_id AND stl.setting_name = ? AND stl.locale = ?)
            LEFT JOIN section_settings sapl ON (s.section_id = sapl.section_id AND sapl.setting_name = ? AND sapl.locale = ?)
            LEFT JOIN section_settings sal ON (s.section_id = sal.section_id AND sal.setting_name = ? AND sal.locale = ?)
         WHERE a.article_id = ?',
         array(
            'title',
            $primaryLocale,
            'title',
            $locale,
            'abbrev',
            $primaryLocale,
            'abbrev',
            $locale,
            $articleId,
         )
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = &$this->_returnAuthorSubmissionFromRow($result->GetRowAssoc(false));
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function &_returnAuthorSubmissionFromRow(&$row) {
      $authorSubmission = &new AuthorSubmission();

      // Article attributes
      $this->articleDao->_articleFromRow($authorSubmission, $row);

      // Editor Assignment
      $editAssignments =& $this->editAssignmentDao->getEditAssignmentsByArticleId($row['article_id']);
      $authorSubmission->setEditAssignments($editAssignments->toArray());

      // Editor Decisions
      for ($i = 1; $i <= $row['current_round']; $i++) {
         $authorSubmission->setDecisions($this->getEditorDecisions($row['article_id'], $i), $i);
      }

      // Review Assignments
      for ($i = 1; $i <= $row['current_round']; $i++) {
         $authorSubmission->setReviewAssignments($this->reviewAssignmentDao->getReviewAssignmentsByArticleId($row['article_id'], $i), $i);
      }

      // Comments
      $authorSubmission->setMostRecentEditorDecisionComment($this->articleCommentDao->getMostRecentArticleComment($row['article_id'], COMMENT_TYPE_EDITOR_DECISION, $row['article_id']));
      $authorSubmission->setMostRecentCopyeditComment($this->articleCommentDao->getMostRecentArticleComment($row['article_id'], COMMENT_TYPE_COPYEDIT, $row['article_id']));
      $authorSubmission->setMostRecentProofreadComment($this->articleCommentDao->getMostRecentArticleComment($row['article_id'], COMMENT_TYPE_PROOFREAD, $row['article_id']));
      $authorSubmission->setMostRecentLayoutComment($this->articleCommentDao->getMostRecentArticleComment($row['article_id'], COMMENT_TYPE_LAYOUT, $row['article_id']));

      // Files
      $authorSubmission->setSubmissionFile($this->articleFileDao->getArticleFile($row['submission_file_id']));
      $authorSubmission->setRevisedFile($this->articleFileDao->getArticleFile($row['revised_file_id']));
      $authorSubmission->setSuppFiles($this->suppFileDao->getSuppFilesByArticle($row['article_id']));
      for ($i = 1; $i <= $row['current_round']; $i++) {
         $authorSubmission->setAuthorFileRevisions($this->articleFileDao->getArticleFileRevisions($row['revised_file_id'], $i), $i);
      }
      for ($i = 1; $i <= $row['current_round']; $i++) {
         $authorSubmission->setEditorFileRevisions($this->articleFileDao->getArticleFileRevisions($row['editor_file_id'], $i), $i);
      }
      $authorSubmission->setGalleys($this->galleyDao->getGalleysByArticle($row['article_id']));

      // Initial Copyedit File
      if ($row['copyeditor_initial_revision'] != null) {
         $authorSubmission->setInitialCopyeditFile($this->articleFileDao->getArticleFile($row['copyedit_file_id'], $row['copyeditor_initial_revision']));
      }

      // Editor / Author Copyedit File
      if ($row['ce_editor_author_revision'] != null) {
         $authorSubmission->setEditorAuthorCopyeditFile($this->articleFileDao->getArticleFile($row['copyedit_file_id'], $row['ce_editor_author_revision']));
      }

      // Final Copyedit File
      if ($row['copyeditor_final_revision'] != null) {
         $authorSubmission->setFinalCopyeditFile($this->articleFileDao->getArticleFile($row['copyedit_file_id'], $row['copyeditor_final_revision']));
      }

      // Copyeditor Assignment
      $authorSubmission->setCopyedId($row['copyed_id']);
      $authorSubmission->setCopyeditorId($row['copyeditor_id']);
      $authorSubmission->setCopyeditor($this->userDao->getUser($row['copyeditor_id']), true);
      $authorSubmission->setCopyeditorDateNotified($this->datetimeFromDB($row['copyeditor_date_notified']));
      $authorSubmission->setCopyeditorDateUnderway($this->datetimeFromDB($row['copyeditor_date_underway']));
      $authorSubmission->setCopyeditorDateCompleted($this->datetimeFromDB($row['copyeditor_date_completed']));
      $authorSubmission->setCopyeditorDateAcknowledged($this->datetimeFromDB($row['copyeditor_date_acknowledged']));
      $authorSubmission->setCopyeditorDateAuthorNotified($this->datetimeFromDB($row['ce_date_author_notified']));
      $authorSubmission->setCopyeditorDateAuthorUnderway($this->datetimeFromDB($row['ce_date_author_underway']));
      $authorSubmission->setCopyeditorDateAuthorCompleted($this->datetimeFromDB($row['ce_date_author_completed']));
      $authorSubmission->setCopyeditorDateAuthorAcknowledged($this->datetimeFromDB($row['ce_date_author_acknowledged']));
      $authorSubmission->setCopyeditorDateFinalNotified($this->datetimeFromDB($row['ce_date_final_notified']));
      $authorSubmission->setCopyeditorDateFinalUnderway($this->datetimeFromDB($row['ce_date_final_underway']));
      $authorSubmission->setCopyeditorDateFinalCompleted($this->datetimeFromDB($row['ce_date_final_completed']));
      $authorSubmission->setCopyeditorDateFinalAcknowledged($this->datetimeFromDB($row['ce_date_final_acknowledged']));
      $authorSubmission->setCopyeditorInitialRevision($row['copyeditor_initial_revision']);
      $authorSubmission->setCopyeditorEditorAuthorRevision($row['ce_editor_author_revision']);
      $authorSubmission->setCopyeditorFinalRevision($row['copyeditor_final_revision']);

      // Layout Assignment
      $authorSubmission->setLayoutAssignment($this->layoutAssignmentDao->getLayoutAssignmentByArticleId($row['article_id']));

      // Proof Assignment
      $authorSubmission->setProofAssignment($this->proofAssignmentDao->getProofAssignmentByArticleId($row['article_id']));

      HookRegistry::call('AuthorSubmissionDAO::_returnAuthorSubmissionFromRow', array(&$authorSubmission, &$row));

      return $authorSubmission;
   }

   function updateAuthorSubmission(&$authorSubmission) {
      // Update article
      if ($authorSubmission->getArticleId()) {
         $article = &$this->articleDao->getArticle($authorSubmission->getArticleId());

         // Only update fields that an author can actually edit.
         $article->setRevisedFileId($authorSubmission->getRevisedFileId());
         $article->setDateStatusModified($authorSubmission->getDateStatusModified());
         $article->setLastModified($authorSubmission->getLastModified());
         // FIXME: These two are necessary for designating the
         // original as the review version, but they are probably
         // best not exposed like this.
         $article->setReviewFileId($authorSubmission->getReviewFileId());
         $article->setEditorFileId($authorSubmission->getEditorFileId());

         $this->articleDao->updateArticle($article);
      }


      // Update copyeditor assignment
      if ($authorSubmission->getCopyedId()) {
         $copyeditorSubmission = &$this->copyeditorSubmissionDao->getCopyeditorSubmission($authorSubmission->getArticleId());

         // Only update fields that an author can actually edit.
         $copyeditorSubmission->setDateAuthorUnderway($authorSubmission->getCopyeditorDateAuthorUnderway());
         $copyeditorSubmission->setDateAuthorCompleted($authorSubmission->getCopyeditorDateAuthorCompleted());
         $copyeditorSubmission->setDateFinalNotified($authorSubmission->getCopyeditorDateFinalNotified());
         $copyeditorSubmission->setEditorAuthorRevision($authorSubmission->getCopyeditorEditorAuthorRevision());
         $copyeditorSubmission->setDateStatusModified($authorSubmission->getDateStatusModified());
         $copyeditorSubmission->setLastModified($authorSubmission->getLastModified());

         $this->copyeditorSubmissionDao->updateCopyeditorSubmission($copyeditorSubmission);
      }
   }

   function &getAuthorSubmissions($authorId, $journalId, $active = true, $rangeInfo = null) {
      $primaryLocale = Locale::getPrimaryLocale();
      $locale = Locale::getLocale();
      $result = &$this->retrieveRange(
         'SELECT  a.*,
            COALESCE(stl.setting_value, stpl.setting_value) AS section_title,
            COALESCE(sal.setting_value, sapl.setting_value) AS section_abbrev,
            c.copyed_id, c.copyeditor_id, c.date_notified AS copyeditor_date_notified, c.date_underway AS copyeditor_date_underway, c.date_completed AS copyeditor_date_completed, c.date_acknowledged AS copyeditor_date_acknowledged, c.date_author_notified AS ce_date_author_notified, c.date_author_underway AS ce_date_author_underway, c.date_author_completed AS ce_date_author_completed,
            c.date_author_acknowledged AS ce_date_author_acknowledged, c.date_final_notified AS ce_date_final_notified, c.date_final_underway AS ce_date_final_underway, c.date_final_completed AS ce_date_final_completed, c.date_final_acknowledged AS ce_date_final_acknowledged, c.initial_revision AS copyeditor_initial_revision, c.editor_author_revision AS ce_editor_author_revision,
            c.final_revision AS copyeditor_final_revision
         FROM articles a
            LEFT JOIN sections s ON (s.section_id = a.section_id)
            LEFT JOIN copyed_assignments c on (a.article_id = c.article_id)
            LEFT JOIN section_settings stpl ON (s.section_id = stpl.section_id AND stpl.setting_name = ? AND stpl.locale = ?)
            LEFT JOIN section_settings stl ON (s.section_id = stl.section_id AND stl.setting_name = ? AND stl.locale = ?)
            LEFT JOIN section_settings sapl ON (s.section_id = sapl.section_id AND sapl.setting_name = ? AND sapl.locale = ?)
            LEFT JOIN section_settings sal ON (s.section_id = sal.section_id AND sal.setting_name = ? AND sal.locale = ?)
         WHERE a.user_id = ? AND a.journal_id = ? AND ' .
         ($active?'a.status = 1':'(a.status <> 1 AND a.submission_progress = 0)'),
         array(
            'title',
            $primaryLocale,
            'title',
            $locale,
            'abbrev',
            $primaryLocale,
            'abbrev',
            $locale,
            $authorId,
            $journalId
         ),
         $rangeInfo
      );

      $returner = &new DAOResultFactory($result, $this, '_returnAuthorSubmissionFromRow');
      return $returner;
   }

   //
   // Miscellaneous
   //

   function getEditorDecisions($articleId, $round = null) {
      $decisions = array();

      if ($round == null) {
         $result = &$this->retrieve(
            'SELECT edit_decision_id, editor_id, decision, date_decided FROM edit_decisions WHERE article_id = ? ORDER BY date_decided ASC', $articleId
         );
      } else {
         $result = &$this->retrieve(
            'SELECT edit_decision_id, editor_id, decision, date_decided FROM edit_decisions WHERE article_id = ? AND round = ? ORDER BY date_decided ASC',
            array($articleId, $round)
         );
      }

      while (!$result->EOF) {
         $decisions[] = array(
            'editDecisionId' => $result->fields['edit_decision_id'],
            'editorId' => $result->fields['editor_id'],
            'decision' => $result->fields['decision'],
            'dateDecided' => $this->datetimeFromDB($result->fields['date_decided'])
         );
         $result->moveNext();
      }

      $result->Close();
      unset($result);

      return $decisions;
   }

   function getSubmissionsCount($authorId, $journalId) {
      $submissionsCount = array();
      $submissionsCount[0] = 0;
      $submissionsCount[1] = 0;

      $sql = 'SELECT count(*), status FROM articles a LEFT JOIN sections s ON (s.section_id = a.section_id) LEFT JOIN copyed_assignments c on (a.article_id = c.article_id) WHERE a.journal_id = ? AND a.user_id = ? GROUP BY a.status';

      $result = &$this->retrieve($sql, array($journalId, $authorId));

      while (!$result->EOF) {
         if ($result->fields['status'] != 1) {
            $submissionsCount[1] += $result->fields[0];
         } else {
            $submissionsCount[0] += $result->fields[0];
         }
         $result->moveNext();
      }

      $result->Close();
      unset($result);

      return $submissionsCount;
   }
}

?>

---