NativeXmlSubmissionFilter.inc.php

<?php
 
import('lib.pkp.plugins.importexport.native.filter.NativeImportFilter');
 
class NativeXmlSubmissionFilter extends NativeImportFilter {
   function __construct($filterGroup) {
      $this->setDisplayName('Native XML submission import');
      parent::__construct($filterGroup);
   }
 
 
   //
   // Implement template methods from PersistableFilter
   //
   function getClassName() {
      return 'lib.pkp.plugins.importexport.native.filter.NativeXmlSubmissionFilter';
   }
 
 
   //
   // Implement template methods from NativeImportFilter
   //
   function getPluralElementName() {
      $deployment = $this->getDeployment();
      return $deployment->getSubmissionsNodeName();
   }
 
   function getSingularElementName() {
      $deployment = $this->getDeployment();
      return $deployment->getSubmissionNodeName();
   }
 
   function handleElement($node) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
 
      // Create and insert the submission (ID needed for other entities)
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $submission = $submissionDao->newDataObject();
 
      $submission->setData('contextId', $context->getId());
      $submission->stampLastActivity();
      $submission->setData('status', $node->getAttribute('status'));
      $submission->setData('submissionProgress', 0);
 
      import('lib.pkp.classes.workflow.WorkflowStageDAO');
      $submission->setData('stageId', WorkflowStageDAO::getIdFromPath($node->getAttribute('stage')));
      $submission->setData('currentPublicationId', $node->getAttribute('current_publication_id'));
 
      // Handle any additional attributes etc.
      $submission = $this->populateObject($submission, $node);
 
      $submission = Services::get('submission')->add($submission, Application::get()->getRequest());
      $deployment->setSubmission($submission);
 
      for ($n = $node->firstChild; $n !== null; $n=$n->nextSibling) {
         if (is_a($n, 'DOMElement')) {
            $this->handleChildElement($n, $submission);
         }
      }
      
      $submission = Services::get('submission')->edit($submission, array(), Application::get()->getRequest());
 
      return $submission;
   }
 
   function populateObject($submission, $node) {
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      if ($dateSubmitted = $node->getAttribute('date_submitted')) {
         $submission->setData('dateSubmitted', Core::getCurrentDate(strtotime($dateSubmitted)));
      } else {
         $submission->setData('dateSubmitted', Core::getCurrentDate());
      }
 
      return $submission;
   }
 
   function handleChildElement($n, $submission) {
      switch ($n->tagName) {
         case 'id':
            $this->parseIdentifier($n, $submission);
            break;
         case 'submission_file':
            $this->parseSubmissionFile($n, $submission);
            break;
         case 'publication':
            $publication = $this->parsePublication($n, $submission);
 
            $publications = $submission->getData('publications');
            $publications[] = $publication[0];
            $submission->setData('publications', $publications);
 
            break;
         default:
            $deployment = $this->getDeployment();
            $deployment->addWarning(ASSOC_TYPE_SUBMISSION, $submission->getId(), __('plugins.importexport.common.error.unknownElement', array('param' => $n->tagName)));
      }
   }
 
   //
   // Element parsing
   //
   function parseIdentifier($element, $submission) {
      $deployment = $this->getDeployment();
      $advice = $element->getAttribute('advice');
      switch ($element->getAttribute('type')) {
         case 'internal':
            // "update" advice not supported yet.
            assert(!$advice || $advice == 'ignore');
            break;
      }
   }
 
   function parseSubmissionFile($n, $submission) {
      $importFilter = $this->getImportFilter($n->tagName);
      assert(isset($importFilter)); // There should be a filter
 
      $importFilter->setDeployment($this->getDeployment());
      $submissionFileDoc = new DOMDocument();
      $submissionFileDoc->appendChild($submissionFileDoc->importNode($n, true));
      return $importFilter->execute($submissionFileDoc);
   }
 
   function parsePublication($n, $submission) {
      $importFilter = $this->getImportFilter($n->tagName);
      assert(isset($importFilter)); // There should be a filter
 
      $importFilter->setDeployment($this->getDeployment());
      $submissionFileDoc = new DOMDocument();
      $submissionFileDoc->appendChild($submissionFileDoc->importNode($n, true));
      return $importFilter->execute($submissionFileDoc);
   }
 
   //
   // Helper functions
   //
 
   function getImportFilter($elementName) {
      assert(false); // Subclasses should override
   }
}