PKPPublicationDAO.inc.php

<?php
 
import('lib.pkp.classes.db.SchemaDAO');
import('lib.pkp.classes.plugins.PKPPubIdPluginDAO');
import('classes.publication.Publication');
import('lib.pkp.classes.services.PKPSchemaService'); // SCHEMA_ constants
 
class PKPPublicationDAO extends SchemaDAO implements PKPPubIdPluginDAO {
   public $schemaName = SCHEMA_PUBLICATION;
 
   public $tableName = 'publications';
 
   public $settingsTableName = 'publication_settings';
 
   public $primaryKeyColumn = 'publication_id';
 
   public $controlledVocabProps = ['disciplines', 'keywords', 'languages', 'subjects', 'supportingAgencies'];
 
   public function newDataObject() {
      return new Publication();
   }
 
   public function _fromRow($primaryRow) {
      $publication = parent::_fromRow($primaryRow);
 
      // Get authors
      $publication->setData('authors', iterator_to_array(
         Services::get('author')->getMany(['publicationIds' => $publication->getId()])
      ));
 
      // Get controlled vocab metadata
      $submissionKeywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $submissionKeywordDao SubmissionKeywordDAO */
      $publication->setData('keywords', $submissionKeywordDao->getKeywords($publication->getId()));
      $submissionSubjectDao = DAORegistry::getDAO('SubmissionSubjectDAO'); /* @var $submissionSubjectDao SubmissionSubjectDAO */
      $publication->setData('subjects', $submissionSubjectDao->getSubjects($publication->getId()));
      $submissionDisciplineDao = DAORegistry::getDAO('SubmissionDisciplineDAO'); /* @var $submissionDisciplineDao SubmissionDisciplineDAO */
      $publication->setData('disciplines', $submissionDisciplineDao->getDisciplines($publication->getId()));
      $submissionLanguageDao = DAORegistry::getDAO('SubmissionLanguageDAO'); /* @var $submissionLanguageDao SubmissionLanguageDAO */
      $publication->setData('languages', $submissionLanguageDao->getLanguages($publication->getId()));
      $submissionAgencyDao = DAORegistry::getDAO('SubmissionAgencyDAO'); /* @var $submissionAgencyDao SubmissionAgencyDAO */
      $publication->setData('supportingAgencies', $submissionAgencyDao->getAgencies($publication->getId()));
 
      // Get categories
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $publication->setData('categoryIds', array_map(
         function($category) {
            return (int) $category->getId();
         },
         $categoryDao->getByPublicationId($publication->getId())->toArray()
      ));
 
      return $publication;
   }
 
   public function insertObject($publication) {
 
      // Remove the controlled vocabulary from the publication to save it separately
      $controlledVocabKeyedArray = array_flip($this->controlledVocabProps);
      $controlledVocabProps = array_intersect_key($publication->_data, $controlledVocabKeyedArray);
      $publication->_data = array_diff_key($publication->_data, $controlledVocabKeyedArray);
 
      parent::insertObject($publication);
 
      // Add controlled vocabularly for which we have props
      if (!empty($controlledVocabProps)) {
         foreach ($controlledVocabProps as $prop => $value) {
            switch ($prop) {
               case 'keywords':
                  $submissionKeywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $submissionKeywordDao SubmissionKeywordDAO */
                  $submissionKeywordDao->insertKeywords($value, $publication->getId());
                  break;
               case 'subjects':
                  $submissionSubjectDao = DAORegistry::getDAO('SubmissionSubjectDAO'); /* @var $submissionSubjectDao SubmissionSubjectDAO */
                  $submissionSubjectDao->insertSubjects($value, $publication->getId());
                  break;
               case 'disciplines':
                  $submissionDisciplineDao = DAORegistry::getDAO('SubmissionDisciplineDAO'); /* @var $submissionDisciplineDao SubmissionDisciplineDAO */
                  $submissionDisciplineDao->insertDisciplines($value, $publication->getId());
                  break;
               case 'languages':
                  $submissionLanguageDao = DAORegistry::getDAO('SubmissionLanguageDAO'); /* @var $submissionLanguageDao SubmissionLanguageDAO */
                  $submissionLanguageDao->insertLanguages($value, $publication->getId());
                  break;
               case 'supportingAgencies':
                  $submissionAgencyDao = DAORegistry::getDAO('SubmissionAgencyDAO'); /* @var $submissionAgencyDao SubmissionAgencyDAO */
                  $submissionAgencyDao->insertAgencies($value, $publication->getId());
                  break;
            }
         }
      }
 
      // Set categories
      if (!empty($publication->getData('categoryIds'))) {
         $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
         foreach ($publication->getData('categoryIds') as $categoryId) {
            $categoryDao->insertPublicationAssignment($categoryId, $publication->getId());
         }
      }
 
      return $publication->getId();
   }
 
   public function updateObject($publication)   {
 
      // Remove the controlled vocabulary from the publication to save it separately
      $controlledVocabKeyedArray = array_flip($this->controlledVocabProps);
      $controlledVocabProps = array_intersect_key($publication->_data, $controlledVocabKeyedArray);
      $publication->_data = array_diff_key($publication->_data, $controlledVocabKeyedArray);
 
      parent::updateObject($publication);
 
      // Update controlled vocabularly for which we have props
      if (!empty($controlledVocabProps)) {
         foreach ($controlledVocabProps as $prop => $value) {
            switch ($prop) {
               case 'keywords':
                  $submissionKeywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $submissionKeywordDao SubmissionKeywordDAO */
                  $submissionKeywordDao->insertKeywords($value, $publication->getId());
                  break;
               case 'subjects':
                  $submissionSubjectDao = DAORegistry::getDAO('SubmissionSubjectDAO'); /* @var $submissionSubjectDao SubmissionSubjectDAO */
                  $submissionSubjectDao->insertSubjects($value, $publication->getId());
                  break;
               case 'disciplines':
                  $submissionDisciplineDao = DAORegistry::getDAO('SubmissionDisciplineDAO'); /* @var $submissionDisciplineDao SubmissionDisciplineDAO */
                  $submissionDisciplineDao->insertDisciplines($value, $publication->getId());
                  break;
               case 'languages':
                  $submissionLanguageDao = DAORegistry::getDAO('SubmissionLanguageDAO'); /* @var $submissionLanguageDao SubmissionLanguageDAO */
                  $submissionLanguageDao->insertLanguages($value, $publication->getId());
                  break;
               case 'supportingAgencies':
                  $submissionAgencyDao = DAORegistry::getDAO('SubmissionAgencyDAO'); /* @var $submissionAgencyDao SubmissionAgencyDAO */
                  $submissionAgencyDao->insertAgencies($value, $publication->getId());
                  break;
            }
         }
      }
 
      // Set categories
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoryDao->deletePublicationAssignments($publication->getId());
      if (!empty($publication->getData('categoryIds'))) {
         foreach ($publication->getData('categoryIds') as $categoryId) {
            $categoryDao->insertPublicationAssignment($categoryId, $publication->getId());
         }
      }
   }
 
   public function deleteById($publicationId) {
      parent::deleteById($publicationId);
 
      // Delete authors
      $authorsIterator = Services::get('author')->getMany(['publicationIds' => $publicationId]);
      foreach ($authorsIterator as $author) {
         Services::get('author')->delete($author);
      }
 
      // Delete the controlled vocabulary
      // Insert an empty array will clear existing entries
      $submissionKeywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $submissionKeywordDao SubmissionKeywordDAO */
      $submissionKeywordDao->insertKeywords([], $publicationId);
      $submissionSubjectDao = DAORegistry::getDAO('SubmissionSubjectDAO'); /* @var $submissionSubjectDao SubmissionSubjectDAO */
      $submissionSubjectDao->insertSubjects([], $publicationId);
      $submissionDisciplineDao = DAORegistry::getDAO('SubmissionDisciplineDAO'); /* @var $submissionDisciplineDao SubmissionDisciplineDAO */
      $submissionDisciplineDao->insertDisciplines([], $publicationId);
      $submissionLanguageDao = DAORegistry::getDAO('SubmissionLanguageDAO'); /* @var $submissionLanguageDao SubmissionLanguageDAO */
      $submissionLanguageDao->insertLanguages([], $publicationId);
      $submissionAgencyDao = DAORegistry::getDAO('SubmissionAgencyDAO'); /* @var $submissionAgencyDao SubmissionAgencyDAO */
      $submissionAgencyDao->insertAgencies([], $publicationId);
 
      // Delete categories
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoryDao->deletePublicationAssignments($publicationId);
 
      // Delete citations
      $citationDao = DAORegistry::getDAO('CitationDAO'); /* @var $citationDao CitationDAO */
      $citationDao->deleteByPublicationId($publicationId);
   }
 
   public function pubIdExists($pubIdType, $pubId, $excludePubObjectId, $contextId) {
      $result = $this->retrieve(
         'SELECT COUNT(*)
         FROM publication_settings ps
         LEFT JOIN publications p ON p.publication_id = ps.publication_id
         LEFT JOIN submissions s ON p.submission_id = s.submission_id
         WHERE ps.setting_name = ? and ps.setting_value = ? and s.submission_id <> ? AND s.context_id = ?',
         array(
            'pub-id::'.$pubIdType,
            $pubId,
            // The excludePubObjectId refers to the submission id
            // because multiple versions of the same submission
            // are allowed to share a DOI.
            (int) $excludePubObjectId,
            (int) $contextId
         )
      );
      $returner = $result->fields[0] ? true : false;
      $result->Close();
      return $returner;
   }
 
   function changePubId($pubObjectId, $pubIdType, $pubId) {
      $idFields = array(
         'publication_id', 'locale', 'setting_name'
      );
      $updateArray = array(
         'publication_id' => (int) $pubObjectId,
         'locale' => '',
         'setting_name' => 'pub-id::'.$pubIdType,
         'setting_value' => (string)$pubId
      );
      $this->replace('publication_settings', $updateArray, $idFields);
      $this->flushCache();
   }
 
   public function deletePubId($pubObjectId, $pubIdType) {
      $this->update(
         'DELETE FROM publication_settings ps
            WHERE ps.publication_id = ?
            AND ps.setting_name= ?',
         [
            $pubObjectId,
            'pubid::' . $pubIdType,
         ]
      );
      $this->flushCache();
   }
 
   public function deleteAllPubIds($contextId, $pubIdType) {
      switch ($this->getDriver()) {
         case 'mysql':
         case 'mysqli':
            $this->update(
               'DELETE ps FROM publication_settings ps
                  LEFT JOIN publications p ON p.publication_id = ps.publication_id
                  LEFT JOIN submissions s ON s.submission_id = p.submission_id
                  WHERE ps.setting_name = ?
                  AND s.context_id = ?',
               [
                  'pub-id::' . $pubIdType,
                  $contextId,
               ]
            );
            break;
         case 'postgres':
         case 'postgres64':
         case 'postgres7':
         case 'postgres8':
         case 'postgres9':
            $this->update(
               'DELETE FROM publication_settings
               USING publication_settings ps
                  LEFT JOIN publications p ON p.publication_id = ps.publication_id
                  LEFT JOIN submissions s ON s.submission_id = p.submission_id
               WHERE ps.setting_name = ?
                  AND s.context_id = ?
                  AND ps.publication_id = publication_settings.publication_id
                  AND ps.locale = publication_settings.locale
                  AND ps.setting_name = publication_settings.setting_name',
               [
                  'pub-id::' . $pubIdType,
                  $contextId,
               ]
            );
            break;
         default: fatalError("Unknown database type!");
      }
      $this->flushCache();
   }
}