CSVImportExportPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.ImportExportPlugin');
 
class CSVImportExportPlugin extends ImportExportPlugin {
   function __construct() {
      parent::__construct();
   }
 
   function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      $this->addLocaleData();
      return $success;
   }
 
   function getName() {
      return 'CSVImportExportPlugin';
   }
 
   function getDisplayName() {
      return __('plugins.importexport.csv.displayName');
   }
 
   function getDescription() {
      return __('plugins.importexport.csv.description');
   }
 
   function getActions($request, $actionArgs) {
      return array(); // Not available via the web interface
   }
 
   function display($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      parent::display($args, $request);
      switch (array_shift($args)) {
         case 'index':
         case '':
            $templateMgr->display($this->getTemplateResource('index.tpl'));
            break;
      }
   }
 
   function executeCLI($scriptName, &$args) {
 
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
 
      $filename = array_shift($args);
      $username = array_shift($args);
 
      if (!$filename || !$username) {
         $this->usage($scriptName);
         exit();
      }
 
      if (!file_exists($filename)) {
         echo __('plugins.importexport.csv.fileDoesNotExist', array('filename' => $filename)) . "\n";
         exit();
      }
 
      $data = file($filename);
 
      if (is_array($data) && count($data) > 0) {
 
         $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
         $user = $userDao->getByUsername($username);
         if (!$user) {
            echo __('plugins.importexport.csv.unknownUser', array('username' => $username)) . "\n";
            exit();
         }
 
         $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
         $authorDao = DAORegistry::getDAO('AuthorDAO'); /* @var $authorDao AuthorDAO */
         $pressDao = Application::getContextDAO();
         $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
         $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
         $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
         $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
         import('lib.pkp.classes.submission.SubmissionFile'); // constants.
         $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
         $publicationDateDao = DAORegistry::getDAO('PublicationDateDAO'); /* @var $publicationDateDao PublicationDateDAO */
 
         foreach ($data as $csvLine) {
            // Format is:
            // Press Path, Author string, title, series path, year, is_edited_volume, locale, URL to PDF, doi (optional)
            list($pressPath, $authorString, $title, $seriesPath, $year, $isEditedVolume, $locale, $pdfUrl, $doi) = preg_split('/\t/', $csvLine);
 
            $press = $pressDao->getByPath($pressPath);
 
            if ($press) {
 
               $supportedLocales = $press->getSupportedSubmissionLocales();
               if (!is_array($supportedLocales) || count($supportedLocales) < 1) $supportedLocales = array($press->getPrimaryLocale());
               $authorGroup = $userGroupDao->getDefaultByRoleId($press->getId(), ROLE_ID_AUTHOR);
 
               // we need a Genre for the files.  Assume a key of MANUSCRIPT as a default.
               $genre = $genreDao->getByKey('MANUSCRIPT', $press->getId());
 
               if (!$genre) {
                  echo __('plugins.importexport.csv.noGenre') . "\n";
                  exit();
               }
               if (!$authorGroup) {
                  echo __('plugins.importexport.csv.noAuthorGroup', array('press' => $pressPath)) . "\n";
                  continue;
               }
               if (in_array($locale, $supportedLocales)) {
                  $submission = $submissionDao->newDataObject();
                  $submission->setContextId($press->getId());
                  $submission->setUserId($user->getId());
                  $submission->stampLastActivity();
                  $submission->setStatus(STATUS_PUBLISHED);
                  $submission->setWorkType($isEditedVolume == 1?WORK_TYPE_EDITED_VOLUME:WORK_TYPE_AUTHORED_WORK);
                  $submission->setCopyrightNotice($press->getLocalizedSetting('copyrightNotice'), $locale);
                  $submission->setLocale($locale);
 
                  $series = $seriesDao->getByPath($seriesPath, $press->getId());
                  if ($series) {
                     $submission->setSeriesId($series->getId());
                  } else {
                     echo __('plugins.importexport.csv.noSeries', array('seriesPath' => $seriesPath)) . "\n";
                  }
 
                  $submissionId = $submissionDao->insertObject($submission);
 
                  $contactEmail = $press->getContactEmail();
                  $authorString = trim($authorString, '"'); // remove double quotes if present.
                  $authors = preg_split('/,\s*/', $authorString);
                  $firstAuthor = true;
                  foreach ($authors as $authorString) {
                     // Examine the author string. Best case is: Given1 Family1 <email@address.com>, Given2 Family2 <email@address.com>, etc
                     // But default to press email address based on press path if not present.
                     $givenName = $familyName = $emailAddress = null;
                     $authorString = trim($authorString); // whitespace.
                     if (preg_match('/^(\w+)(\s+\w+)?\s*(<([^>]+)>)?$/', $authorString, $matches)) {
                        $givenName = $matches[1]; // Mandatory
                        if (count($matches) > 2) {
                           $familyName = $matches[2];
                        }
                        if (count($matches) == 5) {
                           $emailAddress = $matches[4];
                        } else {
                           $emailAddress = $contactEmail;
                        }
                     }
                     $author = $authorDao->newDataObject();
                     $author->setSubmissionId($submissionId);
                     $author->setUserGroupId($authorGroup->getId());
                     $author->setGivenName($givenName, $locale);
                     $author->setFamilyName($familyName, $locale);
                     $author->setEmail($emailAddress);
                     if ($firstAuthor) {
                        $author->setPrimaryContact(1);
                        $firstAuthor = false;
                     }
                     $authorDao->insertObject($author);
                  } // Authors done.
 
                  $submission->setTitle($title, $locale);
                  $submissionDao->updateObject($submission);
 
                  // Submission is done.  Create a publication format for it.
                  $publicationFormat = $publicationFormatDao->newDataObject();
                  $publicationFormat->setPhysicalFormat(false);
                  $publicationFormat->setIsApproved(true);
                  $publicationFormat->setIsAvailable(true);
                  $publicationFormat->setSubmissionId($submissionId);
                  $publicationFormat->setProductAvailabilityCode('20'); // ONIX code for Available.
                  $publicationFormat->setEntryKey('DA'); // ONIX code for Digital
                  $publicationFormat->setData('name', 'PDF', $submission->getLocale());
                  $publicationFormat->setSequence(REALLY_BIG_NUMBER);
                  $publicationFormatId = $publicationFormatDao->insertObject($publicationFormat);
 
                  if ($doi) {
                     $publicationFormat->setStoredPubId('doi', $doi);
                  }
 
                  $publicationFormatDao->updateObject($publicationFormat);
 
                  // Create a publication format date for this publication format.
                  $publicationDate = $publicationDateDao->newDataObject();
                  $publicationDate->setDateFormat('05'); // List55, YYYY
                  $publicationDate->setRole('01'); // List163, Publication Date
                  $publicationDate->setDate($year);
                  $publicationDate->setPublicationFormatId($publicationFormatId);
                  $publicationDateDao->insertObject($publicationDate);
 
                  // Submission File.
                  import('lib.pkp.classes.file.TemporaryFileManager');
                  import('lib.pkp.classes.file.FileManager');
 
                  $temporaryFileManager = new TemporaryFileManager();
                  $temporaryFilename = tempnam($temporaryFileManager->getBasePath(), 'remote');
                  $temporaryFileManager->copyFile($pdfUrl, $temporaryFilename);
                  $submissionFile = $submissionFileDao->newDataObjectByGenreId($genre->getId());
                  $submissionFile->setSubmissionId($submissionId);
                  $submissionFile->setSubmissionLocale($submission->getLocale());
                  $submissionFile->setGenreId($genre->getId());
                  $submissionFile->setFileStage(SUBMISSION_FILE_PROOF);
                  $submissionFile->setDateUploaded(Core::getCurrentDate());
                  $submissionFile->setDateModified(Core::getCurrentDate());
                  $submissionFile->setAssocType(ASSOC_TYPE_REPRESENTATION);
                  $submissionFile->setAssocId($publicationFormatId);
                  $submissionFile->setFileType('application/pdf');
 
                  // Assume open access, no price.
                  $submissionFile->setDirectSalesPrice(0);
                  $submissionFile->setSalesType('openAccess');
 
                  $submissionFileDao->insertObject($submissionFile, $temporaryFilename);
                  $fileManager = new FileManager();
                  $fileManager->deleteByPath($temporaryFilename);
 
                  echo __('plugins.importexport.csv.import.submission', array('title' => $title)) . "\n";
               } else {
                  echo __('plugins.importexport.csv.unknownLocale', array('locale' => $locale)) . "\n";
               }
            } else {
               echo __('plugins.importexport.csv.unknownPress', array('pressPath' => $pressPath)) . "\n";
            }
         }
      }
   }
 
   function usage($scriptName) {
      echo __('plugins.importexport.csv.cliUsage', array(
         'scriptName' => $scriptName,
         'pluginName' => $this->getName()
      )) . "\n";
   }
}