XMLPSWrapper.inc.php

<?php
 
class XMLPSWrapper {
   
   const JOB_CONVERSION_STAGE_ZIP = 10;
   const JOB_STATUS_PENDING = 0;
   const JOB_STATUS_PROCESSING = 1;
   const JOB_STATUS_COMPLETED = 2;
   const JOB_STATUS_FAILED = 3;
   
   const DEFAULT_DEMO_HOST = 'https://pkp-xml-demo.lib.sfu.ca';
   
   protected $_username = null;
   
   protected $_token = null;
   
   protected $_host = null;
   
   public function __construct($host, $username = null, $token = null) {
      
      if (is_null($host) || empty($host)) {
         $this->_host = self::DEFAULT_DEMO_HOST;
      }
      
      $this->_host = rtrim($host, '/');
      $this->_username = $username;
      $this->_token = $token;
   }
   
   protected function _buildRequestUrl($endpoint, $params = array()) {
      
      $endpoint = trim($endpoint, '/');
      $params = http_build_query($params);
      $url = "{$this->_host}/{$endpoint}";
      
      return empty($params) ? $url : "{$url}?{$params}";
   }
   
   protected function _withLoginCredentials($params) {
      $credentials = array(
         'email' => $this->_username,
         'access_token' => $this->_token,
      );
      
      return array_merge($params, $credentials);
   }
   
   protected function _makeApiRequest($endpoint, $params, $authRequired = false, $isPost = false) {
 
      if ($authRequired) {
         
         if (empty($this->_username) || empty($this->_token)) {
            throw new Exception('Login credentials (username & token) are required for server authentication.');
         }
         
         $params = $this->_withLoginCredentials($params);
      }
      
      $apiUrl = null;
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      
      if ($isPost) {
         curl_setopt($ch, CURLOPT_POST, 1);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
         
         $apiUrl = $this->_buildRequestUrl($endpoint);
      }
      else {
         $apiUrl = $this->_buildRequestUrl($endpoint, $params);
      }
      
      
      curl_setopt($ch, CURLOPT_URL, $apiUrl);
      $response = curl_exec($ch);
      $response = json_decode($response, true);
      
      if (!$response) {
         $error = curl_error($ch);
         
         if (empty($error)) {
            $error = 'HTTP status: ' . curl_getinfo($ch, CURLINFO_HTTP_CODE);
         }
         
         throw new Exception($error);
      }
      
      curl_close($ch);
      
      return $response;
   }
   
   public function submitJob($fileName, $fileContent, $citationStyleHash, $metadata = null) {
      
      $params = array(
         'fileName' => $fileName,
         'fileContent' => $fileContent,
         'citationStyleHash' => $citationStyleHash,
      );
 
      if (!is_null($metadata)) {
         $params['fileMetadata'] = json_encode($metadata);
      }
 
      $response = $this->_makeApiRequest('api/job/submit', $params, true, true);
      
      if ($response['status'] != "success") {
         throw new Exception('Job submission failed.');
      }
      
      return $response['id'];
   }
   
   public function getJobStatus($jobId) {
      
      $params = array(
         'id' => $jobId
      );
      
      $response = $this->_makeApiRequest('api/job/status', $params, true);
      
      if ($response['status'] != "success") {
         throw new Exception('Unable to fetch job status.');
      }
      
      return $response['jobStatus'];
   }
   
   protected function _getFileUrl($jobId) {
      
      $params = array(
         'id' => $jobId,
         'conversionStage' => self::JOB_CONVERSION_STAGE_ZIP,
      );
      
      $params = $this->_withLoginCredentials($params);
      
      return $this->_buildRequestUrl('api/job/retrieve', $params);
   }
   
   public function downloadFile($jobId, $filename = 'documents.zip', $destinationDir = null)
   {
      if (is_null($destinationDir)) {
         $destinationDir = sys_get_temp_dir();
      }
      
      $fileUrl = $this->_getFileUrl($jobId);
      $filePath = rtrim($destinationDir, '/') . '/' . $filename;
      
      if (file_exists($filePath)) {
         @unlink($filePath);
      }
      
      if (!@copy($fileUrl, $filePath)) {
         throw new Exception("Unable to copy from {$fileUrl} to {$filePath}");
      }
      
      return $filePath;
   }
   
   public function getCitationList() {
      
      $response = $this->_makeApiRequest('/api/job/citationStyleList', array());
      
      if ($response['status'] != "success") {
         throw new Exception('Job submission failed.');
      }
      
      return $response['citationStyles'];
   }
   
   public function statusCodeToLabel($code) {
      switch ($code) {
         case self::JOB_STATUS_PENDING:
            return 'Pending';
         case self::JOB_STATUS_PROCESSING:
            return 'Processing';
         case self::JOB_STATUS_COMPLETED:
            return 'Completed';
         case self::JOB_STATUS_FAILED:
            return 'Failed';
      }
   }
   
}