ArticleSearchIndex.inc.php

<?php
 
import('lib.pkp.classes.search.SubmissionSearchIndex');
 
class ArticleSearchIndex extends SubmissionSearchIndex {
 
   public function submissionMetadataChanged($submission) {
      // Check whether a search plug-in jumps in.
      $hookResult = HookRegistry::call(
         'ArticleSearchIndex::articleMetadataChanged',
         array($submission)
      );
 
      if (!empty($hookResult)) {
         return;
      }
 
      $publication = $submission->getCurrentPublication();
 
      // Build author keywords
      $authorText = [];
      foreach ($publication->getData('authors') as $author) {
         $authorText = array_merge(
            $authorText,
            array_values((array) $author->getData('givenName')),
            array_values((array) $author->getData('familyName')),
            array_values(array_map('strip_tags', (array) $author->getData('affiliation'))),
            array_values(array_map('strip_tags', (array) $author->getData('biography')))
         );
      }
 
      // Update search index
      import('classes.search.ArticleSearch');
      $submissionId = $submission->getId();
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_AUTHOR, $authorText);
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_TITLE, $publication->getFullTitles());
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_ABSTRACT, $publication->getData('abstract'));
 
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_SUBJECT, (array) $publication->getData('subjects'));
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_DISCIPLINE, (array) $publication->getData('disciplines'));
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_TYPE, (array) $publication->getData('type'));
      $this->_updateTextIndex($submissionId, SUBMISSION_SEARCH_COVERAGE, (array) $publication->getData('coverage'));
      // FIXME Index sponsors too?
   }
 
   public function deleteTextIndex($articleId, $type = null, $assocId = null) {
      $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
      return $searchDao->deleteSubmissionKeywords($articleId, $type, $assocId);
   }
 
   public function submissionFileChanged($articleId, $type, $fileId) {
      // Check whether a search plug-in jumps in.
      $hookResult = HookRegistry::call(
         'ArticleSearchIndex::submissionFileChanged',
         array($articleId, $type, $fileId)
      );
 
      // If no search plug-in is activated then fall back to the
      // default database search implementation.
      if ($hookResult === false || is_null($hookResult)) {
         $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
         $file = $submissionFileDao->getLatestRevision($fileId);
         if (isset($file)) {
            $parser = SearchFileParser::fromFile($file);
         }
 
         if (isset($parser) && $parser->open()) {
            $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
            $objectId = $searchDao->insertObject($articleId, $type, $fileId);
 
            $position = 0;
            while(($text = $parser->read()) !== false) {
               $this->_indexObjectKeywords($objectId, $text, $position);
            }
            $parser->close();
         }
      }
   }
 
   public function clearSubmissionFiles($submission) {
      $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
      $searchDao->deleteSubmissionKeywords($submission->getId(), SUBMISSION_SEARCH_GALLEY_FILE);
   }
 
   public function submissionFilesChanged($article) {
      // Check whether a search plug-in jumps in.
      $hookResult = HookRegistry::call(
         'ArticleSearchIndex::submissionFilesChanged',
         array($article)
      );
 
      // If no search plug-in is activated then fall back to the
      // default database search implementation.
      if ($hookResult === false || is_null($hookResult)) {
         $fileDao = DAORegistry::getDAO('SubmissionFileDAO');
         import('lib.pkp.classes.submission.SubmissionFile'); // Constants
         // Index galley files
         $files = $fileDao->getLatestRevisions(
            $article->getId(), SUBMISSION_FILE_PROOF
         );
         foreach ($files as $file) {
            if ($file->getFileId()) {
               $this->submissionFileChanged($article->getId(), SUBMISSION_SEARCH_GALLEY_FILE, $file->getFileId());
               // Index dependent files associated with any galley files.
               $dependentFiles = $fileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_SUBMISSION_FILE, $file->getFileId(), $article->getId(), SUBMISSION_FILE_DEPENDENT);
               foreach ($dependentFiles as $depFile) {
                  if ($depFile->getFileId()) {
                     $this->submissionFileChanged($article->getId(), SUBMISSION_SEARCH_SUPPLEMENTARY_FILE, $depFile->getFileId());
                  }
               }
            }
         }
      }
   }
 
   public function submissionFileDeleted($articleId, $type = null, $assocId = null) {
      // Check whether a search plug-in jumps in.
      $hookResult = HookRegistry::call(
         'ArticleSearchIndex::submissionFileDeleted',
         array($articleId, $type, $assocId)
      );
 
      // If no search plug-in is activated then fall back to the
      // default database search implementation.
      if ($hookResult === false || is_null($hookResult)) {
         $searchDao = DAORegistry::getDAO('ArticleSearchDAO'); /* @var $searchDao ArticleSearchDAO */
         return $searchDao->deleteSubmissionKeywords($articleId, $type, $assocId);
      }
   }
 
   public function articleDeleted($articleId) {
      // Trigger a hook to let the indexing back-end know that
      // an article was deleted.
      HookRegistry::call(
         'ArticleSearchIndex::articleDeleted',
         array($articleId)
      );
 
      // The default indexing back-end does nothing when an
      // article is deleted (FIXME?).
   }
 
   public function submissionChangesFinished() {
      // Trigger a hook to let the indexing back-end know that
      // the index may be updated.
      HookRegistry::call(
         'ArticleSearchIndex::articleChangesFinished'
      );
 
      // The default indexing back-end works completely synchronously
      // and will therefore not do anything here.
   }
 
   public function articleChangesFinished() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated call to articleChangesFinished. Use submissionChangesFinished instead.');
      $this->submissionChangesFinished();
   }
 
   public function rebuildIndex($log = false, $journal = null, $switches = array()) {
      // Check whether a search plug-in jumps in.
      $hookResult = HookRegistry::call(
         'ArticleSearchIndex::rebuildIndex',
         array($log, $journal, $switches)
      );
 
      // If no search plug-in is activated then fall back to the
      // default database search implementation.
      if ($hookResult === false || is_null($hookResult)) {
 
         AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
 
         // Check that no journal was given as we do
         // not support journal-specific re-indexing.
         if (is_a($journal, 'Journal')) die(__('search.cli.rebuildIndex.indexingByJournalNotSupported') . "\n");
 
         // Clear index
         if ($log) echo __('search.cli.rebuildIndex.clearingIndex') . ' ... ';
         $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
         $searchDao->clearIndex();
         if ($log) echo __('search.cli.rebuildIndex.done') . "\n";
 
         // Build index
         $journalDao = DAORegistry::getDAO('JournalDAO'); /* @var $journalDao JournalDAO */
 
         $journals = $journalDao->getAll();
         while ($journal = $journals->next()) {
            $numIndexed = 0;
 
            if ($log) echo __('search.cli.rebuildIndex.indexing', array('journalName' => $journal->getLocalizedName())) . ' ... ';
 
            $submissionsIterator = Services::get('submission')->getMany(['contextId' => $journal->getId()]);
            foreach ($submissionsIterator as $submission) {
               if ($submission->getSubmissionProgress() == 0) { // Not incomplete
                  $this->submissionMetadataChanged($submission);
                  $this->submissionFilesChanged($submission);
                  $numIndexed++;
               }
            }
            $this->submissionChangesFinished();
 
            if ($log) echo __('search.cli.rebuildIndex.result', array('numIndexed' => $numIndexed)) . "\n";
         }
      }
   }
 
 
   //
   // Private helper methods
   //
   protected function _indexObjectKeywords($objectId, $text, &$position) {
      $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
      $keywords = $this->filterKeywords($text);
      for ($i = 0, $count = count($keywords); $i < $count; $i++) {
         if ($searchDao->insertObjectKeyword($objectId, $keywords[$i], $position) !== null) {
            $position += 1;
         }
      }
   }
 
   protected function _updateTextIndex($articleId, $type, $text, $assocId = null) {
      $searchDao = DAORegistry::getDAO('ArticleSearchDAO');
      $objectId = $searchDao->insertObject($articleId, $type, $assocId);
      $position = 0;
      $this->_indexObjectKeywords($objectId, $text, $position);
   }
}