PSWebServiceLibrary.class.php

<?php
/*
* 2007-2022 PrestaShop SA and Contributors
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://www.prestashop.com for more information.
*
*  @author PrestaShop SA <contact@prestashop.com>
*  @copyright  2007-2022 PrestaShop SA
*  @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
*  International Registered Trademark & Property of PrestaShop SA
* PrestaShop Webservice Library
* @package PrestaShopWebservice
*/
 
class PrestaShopWebservice
{
 
  protected $url;
 
  protected $key;
 
  protected $debug;
 
  protected $version;
 
  const PS_COMPATIBLE_VERSIONS_MIN = '1.4.0.0';
  const PS_COMPATIBLE_VERSIONS_MAX = '8.1.1';
 
  public function __construct($url, $key, $debug = true)
  {
    if (!extension_loaded('curl')) {
      throw new PrestaShopWebserviceException(
        'Please activate the PHP extension \'curl\' to allow use of PrestaShop webservice library'
      );
    }
    $this->url = $url;
    $this->key = $key;
    $this->debug = $debug;
    $this->version = 'unknown';
  }
 
  protected function checkStatusCode($request)
  {
    switch ($request['status_code']) {
      case 200:
      case 201:
        break;
      case 204:
        $error_message = 'No content';
        break;
      case 400:
        $error_message = 'Bad Request';
        break;
      case 401:
        $error_message = 'Unauthorized';
        break;
      case 404:
        $error_message = 'Not Found';
        break;
      case 405:
        $error_message = 'Method Not Allowed';
        break;
      case 500:
        $error_message = 'Internal Server Error';
        break;
      default:
        throw new PrestaShopWebserviceException(
          'This call to PrestaShop Web Services returned an unexpected HTTP status of:' . $request['status_code']
        );
    }
 
    if (!empty($error_message)) {
      $response = $this->parseXML($request['response']);
      $errors = $response->children()->children();
      if ($errors && count($errors) > 0) {
        foreach ($errors as $error) {
          $error_message.= ' - (Code ' . $error->code . '): ' . $error->message;
        }
      }
      $error_label = 'This call to PrestaShop Web Services failed and returned an HTTP status of %d. That means: %s.';
      throw new PrestaShopWebserviceException(sprintf($error_label, $request['status_code'], $error_message));
    }
  }
 
  protected function getCurlDefaultParams()
  {
    $defaultParams = array(
      CURLOPT_HEADER => true,
      CURLOPT_RETURNTRANSFER => true,
      CURLINFO_HEADER_OUT => true,
      CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
      CURLOPT_USERPWD => $this->key . ':',
      CURLOPT_HTTPHEADER => array('Expect:'),
      //CURLOPT_SSL_VERIFYPEER => false, // reminder, in dev environment sometimes self-signed certificates are used
      //CURLOPT_CAINFO => "PATH2CAINFO", // ssl certificate chain checking
      //CURLOPT_CAPATH => "PATH2CAPATH",
    );
    return $defaultParams;
  }
 
  public function executeRequest($url, $curl_params = array())
  {
    $defaultParams = $this->getCurlDefaultParams();
 
    dol_syslog("curl_init url=".$url);
    $session = curl_init($url);
 
    $curl_options = array();
    foreach ($defaultParams as $defkey => $defval) {
      if (isset($curl_params[$defkey])) {
        $curl_options[$defkey] = $curl_params[$defkey];
      } else {
        $curl_options[$defkey] = $defaultParams[$defkey];
      }
    }
    foreach ($curl_params as $defkey => $defval) {
      if (!isset($curl_options[$defkey])) {
        $curl_options[$defkey] = $curl_params[$defkey];
      }
    }
 
    dol_syslog("curl curl_options = ".var_export($curl_options, true));
    curl_setopt_array($session, $curl_options);
    $response = curl_exec($session);
 
    $index = strpos($response, "\r\n\r\n");
    if ($index === false && $curl_params[CURLOPT_CUSTOMREQUEST] != 'HEAD') {
      throw new PrestaShopWebserviceException('Bad HTTP response ' . $response . curl_error($session));
    }
 
    $header = substr($response, 0, $index);
    $body = substr($response, $index + 4);
 
    $headerArrayTmp = explode("\n", $header);
 
    $headerArray = array();
    foreach ($headerArrayTmp as &$headerItem) {
      $tmp = explode(':', $headerItem);
      $tmp = array_map('trim', $tmp);
      if (count($tmp) == 2) {
        $headerArray[$tmp[0]] = $tmp[1];
      }
    }
 
    if (array_key_exists('PSWS-Version', $headerArray)) {
      $this->version = $headerArray['PSWS-Version'];
      if (
        version_compare(PrestaShopWebservice::PS_COMPATIBLE_VERSIONS_MIN, $headerArray['PSWS-Version']) == 1 ||
        version_compare(PrestaShopWebservice::PS_COMPATIBLE_VERSIONS_MAX, $headerArray['PSWS-Version']) == -1
      ) {
        throw new PrestaShopWebserviceException(
          'This library is not compatible with this version of PrestaShop. Please upgrade/downgrade this library'
        );
      }
    }
 
    if ($this->debug) {
      $this->printDebug('HTTP REQUEST HEADER', curl_getinfo($session, CURLINFO_HEADER_OUT));
      $this->printDebug('HTTP RESPONSE HEADER', $header);
    }
    $status_code = curl_getinfo($session, CURLINFO_HTTP_CODE);
    if ($status_code === 0) {
      throw new PrestaShopWebserviceException('CURL Error: ' . curl_error($session));
    }
    curl_close($session);
    if ($this->debug) {
      if ($curl_params[CURLOPT_CUSTOMREQUEST] == 'PUT' || $curl_params[CURLOPT_CUSTOMREQUEST] == 'POST') {
        $this->printDebug('XML SENT', urldecode($curl_params[CURLOPT_POSTFIELDS]));
      }
      if ($curl_params[CURLOPT_CUSTOMREQUEST] != 'DELETE' && $curl_params[CURLOPT_CUSTOMREQUEST] != 'HEAD') {
        $this->printDebug('RETURN HTTP BODY', $body);
      }
    }
    return array('status_code' => $status_code, 'response' => $body, 'header' => $header);
  }
 
  public function printDebug($title, $content)
  {
    if (php_sapi_name() == 'cli') {
      echo $title . PHP_EOL . $content;
    } else {
      echo '<div style="display:table;background:#CCC;font-size:8pt;padding:7px"><h6 style="font-size:9pt;margin:0">'
        . $title
        . '</h6><pre>'
        . htmlentities($content)
        . '</pre></div>';
    }
  }
 
  public function getVersion()
  {
    return $this->version;
  }
 
  protected function parseXML($response)
  {
    if ($response != '') {
      libxml_clear_errors();
      libxml_use_internal_errors(true);
      if (LIBXML_VERSION < 20900) {
        // Avoid load of external entities (security problem).
        // Required only if LIBXML_VERSION < 20900
        // @phan-suppress-next-line PhanDeprecatedFunctionInternal
        libxml_disable_entity_loader(true);
      }
 
      $xml = simplexml_load_string(trim($response), 'SimpleXMLElement', LIBXML_NOCDATA|LIBXML_NONET);
      if (libxml_get_errors()) {
        $msg = var_export(libxml_get_errors(), true);
        libxml_clear_errors();
        throw new PrestaShopWebserviceException('HTTP XML response is not parsable: ' . $msg);
      }
      return $xml;
    } else {
      throw new PrestaShopWebserviceException('HTTP response is empty');
    }
  }
 
  public function add($options)
  {
    $xml = '';
 
    if (isset($options['resource'], $options['postXml']) || isset($options['url'], $options['postXml'])) {
      $url = (isset($options['resource']) ? $this->url . '/api/' . $options['resource'] : $options['url']);
      $xml = $options['postXml'];
      if (isset($options['id_shop'])) {
        $url .= '&id_shop=' . $options['id_shop'];
      }
      if (isset($options['id_group_shop'])) {
        $url .= '&id_group_shop=' . $options['id_group_shop'];
      }
    } else {
      throw new PrestaShopWebserviceException('Bad parameters given');
    }
    $request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => $xml));
 
    $this->checkStatusCode($request);
    return $this->parseXML($request['response']);
  }
 
  public function get($options)
  {
    if (isset($options['url'])) {
      $url = $options['url'];
    } elseif (isset($options['resource'])) {
      $url = $this->url . '/api/' . $options['resource'];
      $url_params = array();
      if (isset($options['id'])) {
        $url .= '/' . $options['id'];
      }
 
      $params = array('filter', 'display', 'sort', 'limit', 'id_shop', 'id_group_shop', 'schema', 'language', 'date', 'price');
      foreach ($params as $p) {
        foreach ($options as $k => $o) {
          if (strpos($k, $p) !== false) {
            $url_params[$k] = $options[$k];
          }
        }
      }
      if (count($url_params) > 0) {
        $url .= '?' . http_build_query($url_params);
      }
    } else {
      throw new PrestaShopWebserviceException('Bad parameters given');
    }
 
    $request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'GET'));
 
    $this->checkStatusCode($request);// check the response validity
 
    return $this->parseXML($request['response']);
  }
 
  public function head($options)
  {
    if (isset($options['url'])) {
      $url = $options['url'];
    } elseif (isset($options['resource'])) {
      $url = $this->url . '/api/' . $options['resource'];
      $url_params = array();
      if (isset($options['id'])) {
        $url .= '/' . $options['id'];
      }
 
      $params = array('filter', 'display', 'sort', 'limit');
      foreach ($params as $p) {
        foreach ($options as $k => $o) {
          if (strpos($k, $p) !== false) {
            $url_params[$k] = $options[$k];
          }
        }
      }
      if (count($url_params) > 0) {
        $url .= '?' . http_build_query($url_params);
      }
    } else {
      throw new PrestaShopWebserviceException('Bad parameters given');
    }
    $request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'HEAD', CURLOPT_NOBODY => true));
    $this->checkStatusCode($request);// check the response validity
    return $request['header'];
  }
 
  public function edit($options)
  {
    $xml = '';
    if (isset($options['url'])) {
      $url = $options['url'];
    } elseif ((isset($options['resource'], $options['id']) || isset($options['url'])) && $options['putXml']) {
      $url = (isset($options['url']) ? $options['url'] :
        $this->url . '/api/' . $options['resource'] . '/' . $options['id']);
      $xml = $options['putXml'];
      if (isset($options['id_shop'])) {
        $url .= '&id_shop=' . $options['id_shop'];
      }
      if (isset($options['id_group_shop'])) {
        $url .= '&id_group_shop=' . $options['id_group_shop'];
      }
    } else {
      throw new PrestaShopWebserviceException('Bad parameters given');
    }
 
    $request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_POSTFIELDS => $xml));
    $this->checkStatusCode($request);// check the response validity
    return $this->parseXML($request['response']);
  }
 
  public function delete($options)
  {
    if (isset($options['url'])) {
      $url = $options['url'];
    } elseif (isset($options['resource']) && isset($options['id'])) {
      $url = (is_array($options['id']))
        ? $this->url . '/api/' . $options['resource'] . '/?id=[' . implode(',', $options['id']) . ']'
        : $this->url . '/api/' . $options['resource'] . '/' . $options['id'];
    } else {
      throw new PrestaShopWebserviceException('Bad parameters given');
    }
 
    if (isset($options['id_shop'])) {
      $url .= '&id_shop=' . $options['id_shop'];
    }
    if (isset($options['id_group_shop'])) {
      $url .= '&id_group_shop=' . $options['id_group_shop'];
    }
 
    $request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'DELETE'));
    $this->checkStatusCode($request);// check the response validity
    return true;
  }
}
 
class PrestaShopWebserviceException extends Exception
{
}