restclient.wsconnector.inc in RESTClient 7.2

File

restclient.wsconnector.inc

<?php

/**
 * @file
 * Default implementation of wsdata classes
 */
if (class_exists('WsConnector')) {
  class restclient_wsconnector extends WsConnector {
    public function supportsCaching() {
      return TRUE;
    }
    public function __construct($endpoint) {
      $this->languagePlugins = array(
        'header',
        // @todo add support for the rest of the language plugins

        /*  'argument',
            'uri',
            'path', */
        'replace',
        'default',
      );
      parent::__construct($endpoint);
    }
    public function getMethods() {
      return array(
        'single' => array(
          'create' => t('RESTful create method (POST)'),
          'read' => t('RESTful read method (GET)'),
          'update' => t('RESTful update method (PUT)'),
          'delete' => t('RESTful delete method (DELETE)'),
          'index' => t('RESTful index method (GET)'),
        ),
        'multiple' => array(
          'action' => t('RESTful action (POST)'),
        ),
      );
    }

    /**
     * Preprocess some options prior to making the web service request
     */
    protected function restclientPrepareWsCall(&$type, &$endpoint, &$method, &$arguments, &$options) {

      // Allow the create/update methods to be altered
      if ($type == 'create' and isset($options['create_method'])) {
        $type = $options['create_method'];
      }
      if (is_callable(array(
        $this,
        'setError',
      )) and !isset($options['error_handling'])) {
        $options['error_handling'] = __CLASS__;
      }

      // If the arguments aren't a simple string, we need to get RESTClient to
      // process it into a string
      if (!empty($arguments) and !is_string($arguments)) {
        $options['data'] = $arguments;
        $arguments = NULL;
      }
      if ($type == 'update' and isset($options['update_method'])) {
        $type = $options['update_method'];
      }
      if (empty($method) and isset($options['accept-type'])) {
        $method = "." . $options['accept-type'];
      }
      if (!empty($options['language']) and isset($options['language plugin'])) {

        // There should only ever be a single plugin. The foreach is just to make
        // dealing with array keys simpler.
        foreach ($options['language plugin'] as $name => $settings) {
          switch ($name) {
            case 'header':
              $options['headers'][$settings['header']] = $settings[$options['language']];
              break;
            case 'replace':
              $replace = $settings['default'];
              if (!empty($settings[$options['language']])) {
                $replace = $settings[$options['language']];
              }
              $method = str_replace('{language}', $replace, $method);
              $endpoint = str_replace('{language}', $replace, $endpoint);
              break;

            // @todo the rest of the plugins
            default:
          }
          break;
        }
      }

      // Set cache override options to force cache times
      if (isset($this->cacheDefaultTime) and isset($this->cacheDefaultOverride)) {
        $options['cache_default_time'] = $this->cacheDefaultTime;
        $options['cache_default_override'] = $this->cacheDefaultOverride;
      }
      if (isset($this->staleCache) and $this->staleCache) {
        $options['stale_cache'] = TRUE;
      }
    }

    /**
     * Perform a create method request (e.g. POST)
     */
    protected function restclientCreate(&$type, &$endpoint, &$method, &$arguments, &$options) {
      $variables = array(
        'endpoint' => $endpoint,
        'body' => $arguments,
      ) + $options;
      if (empty($arguments)) {
        unset($variables['body']);
      }
      $response = restclient_post($method, $variables);
      if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
        if (isset($options['error_handling'])) {
          if ($options['error_handling'] == __CLASS__) {
            $this
              ->setError($response->code, $response->error);
            return FALSE;
          }
          else {

            // don't cache error responses
            $this->expires = 0;
            return $response;
          }
        }
        else {
          return FALSE;
        }
      }
      else {
        return $response->data;
      }
    }

    /**
     * Perform a read method request (e.g. GET)
     */
    protected function restclientRead(&$type, &$endpoint, &$method, &$arguments, &$options) {
      $response = restclient_get($method, array(
        'endpoint' => $endpoint,
      ) + $options);

      // @todo add support for more 200 class response codes
      if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
        if (isset($options['error_handling'])) {
          if ($options['error_handling'] == __CLASS__) {
            $this
              ->setError($response->code, $response->error);
            return FALSE;
          }
          else {

            // don't cache error responses
            $this->expires = 0;
            return $response;
          }
        }
        else {
          return FALSE;
        }
      }
      else {
        if (isset($response->expires)) {
          $this->expires = $response->expires;
        }
        return $response->data;
      }
    }

    /**
     * Perform an update method request (e.g. PUT)
     */
    protected function restclientUpdate(&$type, &$endpoint, &$method, &$arguments, &$options) {
      $variables = array(
        'endpoint' => $endpoint,
        'body' => $arguments,
      ) + $options;
      if (empty($arguments)) {
        unset($variables['body']);
      }
      $response = restclient_put($method, $variables);
      if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
        if (isset($options['error_handling'])) {
          if ($options['error_handling'] == __CLASS__) {
            $this
              ->setError($response->code, $response->error);
            return FALSE;
          }
          else {

            // don't cache error responses
            $this->expires = 0;
            return $response;
          }
        }
        else {
          return FALSE;
        }
      }
      else {
        return $response->data;
      }
    }

    /**
     * Perform a delete method request (e.g. DELETE)
     */
    protected function restclientDelete(&$type, &$endpoint, &$method, &$arguments, &$options) {
      $response = restclient_delete($method, array(
        'endpoint' => $endpoint,
      ) + $options);
      if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
        if (isset($options['error_handling'])) {
          if ($options['error_handling'] == __CLASS__) {
            $this
              ->setError($response->code, $response->error);
            return FALSE;
          }
          else {

            // don't cache error responses
            $this->expires = 0;
            return $response;
          }
        }
        else {
          return FALSE;
        }
      }
      else {
        return $response->data;
      }
    }

    /**
     * Perform a index method request (e.g. GET)
     */
    protected function restclientIndex(&$type, &$endpoint, &$method, &$arguments, &$options) {
      $response = restclient_get($method, array(
        'endpoint' => $endpoint,
      ) + $options);

      // @todo add support for more 200 class response codes
      if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
        if (isset($options['error_handling'])) {
          if ($options['error_handling'] == __CLASS__) {
            $this
              ->setError($response->code, $response->error);
            return FALSE;
          }
          else {

            // don't cache error responses
            $this->expires = 0;
            return $response;
          }
        }
        else {
          return FALSE;
        }
      }
      else {
        if (isset($response->expires)) {
          $this->expires = $response->expires;
        }
        return $response->data;
      }
    }

    /**
     * Implements WsConnector->wscall().
     */
    public function wscall($type, $method, $arguments, $options) {
      $endpoint = $this->endpoint;
      $this
        ->restclientPrepareWsCall($type, $endpoint, $method, $arguments, $options);
      switch ($type) {
        case 'create':
          return $this
            ->restclientCreate($type, $endpoint, $method, $arguments, $options);
        case 'read':
          return $this
            ->restclientRead($type, $endpoint, $method, $arguments, $options);
        case 'update':
          return $this
            ->restclientUpdate($type, $endpoint, $method, $arguments, $options);
        case 'delete':
          return $this
            ->restclientDelete($type, $endpoint, $method, $arguments, $options);
        case 'index':
          return $this
            ->restclientIndex($type, $endpoint, $method, $arguments, $options);
        default:

          // Make an actionable request (i.e. generic POST)
          if (drupal_substr($type, 0, 7) == 'action_') {
            $variables = array(
              'endpoint' => $endpoint,
              'body' => $arguments,
            ) + $options;
            if (empty($arguments)) {
              unset($variables['body']);
            }
            $response = restclient_post($method, $variables);
            if (restclient_response_code($response) != RESTCLIENT_RESPONSE_SUCCESS) {
              if (isset($options['error_handling']) and $options['error_handling']) {

                // don't cache error responses
                $this->expires = 0;
                return $response;
              }
              else {
                return FALSE;
              }
            }
            else {
              return $response->data;
            }
          }
      }
    }

    /**
     * Custom impelementation of update
     *
     * With REST, the ID is part of the URL, so we don't need to included it
     * in the body.
     */
    public function update($id, $method, $object, $options = array()) {
      $this->expires = 0;
      return $this
        ->wscall('update', $method, $object, $options);
    }
    public function isDegraded() {
      $error = $this
        ->getError();
      if (!isset($error) or !isset($error['code'])) {
        return FALSE;
      }
      if ($error['code'] == -1) {
        return TRUE;
      }
      return FALSE;
    }

  }
}