plugins/importexport/crossref/CrossRefExportPlugin.inc.php

<?php

// $Id: CrossRefExportPlugin.inc.php,v 1.15 2008/07/01 01:16:14 asmecher Exp $


import('classes.plugins.ImportExportPlugin');

class CrossRefExportPlugin extends ImportExportPlugin {
   function register($category, $path) {
      $success = parent::register($category, $path);
      $this->addLocaleData();
      return $success;
   }

   function getName() {
      return 'CrossRefExportPlugin';
   }

   function getDisplayName() {
      return Locale::translate('plugins.importexport.crossref.displayName');
   }

   function getDescription() {
      return Locale::translate('plugins.importexport.crossref.description');
   }

   function display(&$args) {
      $templateMgr = &TemplateManager::getManager();
      parent::display($args);

      $issueDao = &DAORegistry::getDAO('IssueDAO');

      $journal = &Request::getJournal();

      switch (array_shift($args)) {                   
         case 'exportIssues':
            $issueIds = Request::getUserVar('issueId');
            if (!isset($issueIds)) $issueIds = array();
            $issues = array();
            foreach ($issueIds as $issueId) {
               $issue = &$issueDao->getIssueById($issueId);
               if (!$issue) Request::redirect();
               $issues[] = &$issue;
            }
            $this->exportIssues($journal, $issues);
            break;
         case 'exportIssue':
            $issueId = array_shift($args);
            $issue = &$issueDao->getIssueById($issueId);
            if (!$issue) Request::redirect();
            $issues = array($issue);
            $this->exportIssues($journal, $issues);
            break;
         case 'exportArticle':
            $articleIds = array(array_shift($args));
            $result = ArticleSearch::formatResults($articleIds);
            $this->exportArticles($journal, $result);
            break;
         case 'exportArticles':
            $articleIds = Request::getUserVar('articleId');
            if (!isset($articleIds)) $articleIds = array();
            $results = &ArticleSearch::formatResults($articleIds);
            $this->exportArticles($journal, $results);
            break;
         case 'issues':
            // Display a list of issues for export
            $this->setBreadcrumbs(array(), true);
            $issueDao = &DAORegistry::getDAO('IssueDAO');
            $issues =& $issueDao->getPublishedIssues($journal->getJournalId(), Handler::getRangeInfo('issues'));

            $templateMgr->assign_by_ref('issues', $issues);
            $templateMgr->display($this->getTemplatePath() . 'issues.tpl');
            break;
         case 'articles':
            // Display a list of articles for export
            $this->setBreadcrumbs(array(), true);
            $publishedArticleDao = &DAORegistry::getDAO('PublishedArticleDAO');
            $rangeInfo = Handler::getRangeInfo('articles');
            $articleIds = $publishedArticleDao->getPublishedArticleIdsByJournal($journal->getJournalId(), false);
            $totalArticles = count($articleIds);
            if ($rangeInfo->isValid()) $articleIds = array_slice($articleIds, $rangeInfo->getCount() * ($rangeInfo->getPage()-1), $rangeInfo->getCount());
            $iterator = &new VirtualArrayIterator(ArticleSearch::formatResults($articleIds), $totalArticles, $rangeInfo->getPage(), $rangeInfo->getCount());
            $templateMgr->assign_by_ref('articles', $iterator);
            $templateMgr->display($this->getTemplatePath() . 'articles.tpl');
            break;
         default:
            $this->setBreadcrumbs();
            $templateMgr->assign_by_ref('journal', $journal);
            $templateMgr->display($this->getTemplatePath() . 'index.tpl');
      }
   }

   function exportArticles(&$journal, &$results, $outputFile = null) {
      $this->import('CrossRefExportDom');

      $doc = &CrossRefExportDom::generateCrossRefDom();
      $doiBatchNode = &CrossRefExportDom::generateDoiBatchDom($doc);

      // Create Head Node and all parts inside it
      $head = &CrossRefExportDom::generateHeadDom($doc, $journal);

      // attach it to the root node
      XMLCustomWriter::appendChild($doiBatchNode, $head);

      // the body node contains everything
      $bodyNode = &XMLCustomWriter::createElement($doc, 'body');
      XMLCustomWriter::appendChild($doiBatchNode, $bodyNode);

      // now cycle through everything we want to submit in this batch
      foreach ($results as $result) {
         $journal = &$result['journal'];
         $issue = &$result['issue'];
         $section = &$result['section'];
         $article = &$result['publishedArticle'];

         // Create the metadata node
         // this does not need to be repeated for every article
         // but its allowed to be and its simpler to do so
         $journalNode = &XMLCustomWriter::createElement($doc, 'journal');
         $journalMetadataNode = &CrossRefExportDom::generateJournalMetadataDom($doc, $journal);
         XMLCustomWriter::appendChild($journalNode, $journalMetadataNode);

         // Create the journal_issue node
         $journalIssueNode = &CrossRefExportDom::generateJournalIssueDom($doc, $journal, $issue, $section, $article);
         XMLCustomWriter::appendChild($journalNode, $journalIssueNode);

         // Create the article
         $journalArticleNode = &CrossRefExportDom::generateJournalArticleDom($doc, $journal, $issue, $section, $article);
         XMLCustomWriter::appendChild($journalNode, $journalArticleNode);

         // Create the DOI data
         $DOIdataNode = &CrossRefExportDom::generateDOIdataDom($doc, $article->getDOI(), Request::url(null, 'article', 'view', $article->getArticleId()));
         XMLCustomWriter::appendChild($journalArticleNode, $DOIdataNode);                    
         XMLCustomWriter::appendChild($bodyNode, $journalNode);
      }


      // dump out the results
      if (!empty($outputFile)) {
         if (($h = fopen($outputFile, 'w'))===false) return false;
         fwrite($h, XMLCustomWriter::getXML($doc));
         fclose($h);
      } else {
         header("Content-Type: application/xml");
         header("Cache-Control: private");
         header("Content-Disposition: attachment; filename=\"crossref.xml\"");
         XMLCustomWriter::printXML($doc);
      }
      return true;
   }

   function exportIssues(&$journal, &$issues, $outputFile = null) {
      $this->import('CrossRefExportDom');

      $doc = &CrossRefExportDom::generateCrossRefDom();
      $doiBatchNode = &CrossRefExportDom::generateDoiBatchDom($doc);

      $journal = &Request::getJournal();

      // Create Head Node and all parts inside it
      $head = &CrossRefExportDom::generateHeadDom($doc, $journal);

      // attach it to the root node
      XMLCustomWriter::appendChild($doiBatchNode, $head);

      $bodyNode = &XMLCustomWriter::createElement($doc, 'body');
      XMLCustomWriter::appendChild($doiBatchNode, $bodyNode);

      $sectionDao = &DAORegistry::getDAO('SectionDAO');
      $publishedArticleDao = &DAORegistry::getDAO('PublishedArticleDAO');

      foreach ($issues as $issue) {
         foreach ($sectionDao->getSectionsForIssue($issue->getIssueId()) as $section) {
            foreach ($publishedArticleDao->getPublishedArticlesBySectionId($section->getSectionId(), $issue->getIssueId()) as $article) {
               // Create the metadata node
               // this does not need to be repeated for every article
               // but its allowed to be and its simpler to do so              
               $journalNode = &XMLCustomWriter::createElement($doc, 'journal');
               $journalMetadataNode = &CrossRefExportDom::generateJournalMetadataDom($doc, $journal);
               XMLCustomWriter::appendChild($journalNode, $journalMetadataNode);

               $journalIssueNode = &CrossRefExportDom::generateJournalIssueDom($doc, $journal, $issue, $section, $article);
               XMLCustomWriter::appendChild($journalNode, $journalIssueNode);

               // Article node
               $journalArticleNode = &CrossRefExportDom::generateJournalArticleDom($doc, $journal, $issue, $section, $article);
               XMLCustomWriter::appendChild($journalNode, $journalArticleNode);

               // DOI data node
               $DOIdataNode = &CrossRefExportDom::generateDOIdataDom($doc, $article->getDOI(), Request::url(null, 'article', 'view', $article->getArticleId()));
               XMLCustomWriter::appendChild($journalArticleNode, $DOIdataNode);                    
               XMLCustomWriter::appendChild($bodyNode, $journalNode);

            }
         }
      }

      // dump out results
      if (!empty($outputFile)) {
         if (($h = fopen($outputFile, 'w'))===false) return false;
         fwrite($h, XMLCustomWriter::getXML($doc));
         fclose($h);
      } else {
         header("Content-Type: application/xml");
         header("Cache-Control: private");
         header("Content-Disposition: attachment; filename=\"crossref.xml\"");
         XMLCustomWriter::printXML($doc);
      }

      return true;
   }

   function executeCLI($scriptName, &$args) {
//    $command = array_shift($args);
      $xmlFile = array_shift($args);
      $journalPath = array_shift($args);

      $journalDao = &DAORegistry::getDAO('JournalDAO');
      $issueDao = &DAORegistry::getDAO('IssueDAO');
      $sectionDao = &DAORegistry::getDAO('SectionDAO');
      $userDao = &DAORegistry::getDAO('UserDAO');
      $publishedArticleDao = &DAORegistry::getDAO('PublishedArticleDAO');

      $journal = &$journalDao->getJournalByPath($journalPath);

      if (!$journal) {
         if ($journalPath != '') {
            echo Locale::translate('plugins.importexport.crossref.cliError') . "\n";
            echo Locale::translate('plugins.importexport.crossref.error.unknownJournal', array('journalPath' => $journalPath)) . "\n\n";
         }
         $this->usage($scriptName);
         return;
      }

      if ($xmlFile != '') switch (array_shift($args)) {
         case 'articles':
            $results = &ArticleSearch::formatResults($args);
            if (!$this->exportArticles($journal, $results, $xmlFile)) {
               echo Locale::translate('plugins.importexport.crossref.cliError') . "\n";
               echo Locale::translate('plugins.importexport.crossref.export.error.couldNotWrite', array('fileName' => $xmlFile)) . "\n\n";
            }
            return;
         case 'issue':
            $issueId = array_shift($args);
            $issue = &$issueDao->getIssueByBestIssueId($issueId, $journal->getJournalId());
            if ($issue == null) {
               echo Locale::translate('plugins.importexport.crossref.cliError') . "\n";
               echo Locale::translate('plugins.importexport.crossref.export.error.issueNotFound', array('issueId' => $issueId)) . "\n\n";
               return;
            }
            $issues = array($issue);
            if (!$this->exportIssues($journal, $issues, $xmlFile)) {
               echo Locale::translate('plugins.importexport.crossref.cliError') . "\n";
               echo Locale::translate('plugins.importexport.crossref.export.error.couldNotWrite', array('fileName' => $xmlFile)) . "\n\n";
            }
            return;
      }
      $this->usage($scriptName);

   }

   function usage($scriptName) {
      echo Locale::translate('plugins.importexport.crossref.cliUsage', array(
         'scriptName' => $scriptName,
         'pluginName' => $this->getName()
      )) . "\n";
   }
}

?>

---