akamai.class.inc in Akamai 7.3

akamai.class.inc Akamai is a registered trademark of Akamai Technologies, Inc. This class is an abstraction around the Akamai Cache Control API.

File

akamai.class.inc

<?php

/**
 * @file akamai.class.inc
 *    Akamai is a registered trademark of Akamai Technologies, Inc.
 *    This class is an abstraction around the Akamai Cache Control API.
 */
interface AkamaiCacheControl {

  /**
   * Clears the provided URLs from the Akamai Content Cache.
   *
   * @param $paths
   *    A path (or array of paths) to clear from Akamai
   * @return
   *    An array with 2 keys:
   *       success: TRUE or FALSE indicating cache clearing success
   *       message: Blank if successful, the error message if not successful.
   */
  function clear_url($paths);

}

/**
 * Default implementation of the AkamaiCacheControl interface
 */
class AkamaiCacheControlClient implements AkamaiCacheControl {
  private $defaults;

  //akamai_get_defaults();
  public $parameters;

  /**
   * Constructs an instance of the Akamai Cache Control facade.
   *
   * Valid parameters are specified in the options array as key/value pairs with the
   * parameter name being the key and the parameter setting being the value
   *
   * @param options  An array of parameter options for the Akamae Cache Control
   *                  Web Service. These will override the defaults.
   */
  function __construct($options = array()) {
    $this->defaults = array(
      'basepath' => variable_get("akamai_basepath", ""),
      'name' => variable_get("akamai_username", ""),
      'pwd' => variable_get("akamai_password", ""),
      'action' => variable_get("akamai_action", ""),
      'type' => "arl",
      'domain' => variable_get("akamai_domain", ""),
      'restapi' => variable_get("akamai_restapi", ""),
      'timeout' => variable_get("akamai_timeout", "5"),
    );
    $this->parameters = array_merge($this->defaults, $options);
  }

  /**
   * Clears the provided URLs from the Akamai Content Cache.
   *
   * @param $paths
   *    A path (or array of paths) to clear from Akamai.
   * @throws AkamaiException
   *
   * @return array
   *   An array with 2 keys:
   *   - success: TRUE or FALSE indicating cache clearing success.
   *   - message: Blank if successful, the error message if not successful.
   */
  function clear_url($paths) {

    // Grab params.
    extract($this->parameters);

    // Prepend base path to paths to make URIs.
    $uris = array();
    foreach ($paths as $path) {
      $path = rtrim(preg_match("/^\\//", $path) ? $path : "/{$path}");
      array_push($uris, $basepath . $path);
    }
    $data = array(
      "type" => "arl",
      "action" => "{$action}",
      "domain" => "{$domain}",
      "objects" => $uris,
    );
    $data_string = json_encode($data);
    $data_string = str_replace("\\/", '/', $data_string);

    // URL needs to be in the format of scheme://user:pass@url.
    $url_parsed = parse_url($restapi);
    $url = $url_parsed['scheme'] . '://' . $name . ':' . $pwd . '@' . $url_parsed['host'] . $url_parsed['path'];
    $response = drupal_http_request($url, array(
      'method' => 'POST',
      'data' => $data_string,
      'timeout' => $this->defaults['timeout'],
      'headers' => array(
        'Content-Type' => 'application/json',
        'Content-Length' => strlen($data_string),
      ),
    ));

    // We expect Akamai to respond with code 201 if the purge request was
    // successfully created.
    if ($response->code != 201) {
      $message = format_string('Akamai RestAPI failed !action for !uris with code !code and response: !response', array(
        '!uris' => implode(' ', $uris),
        '!action' => $action,
        '!code' => $response->code,
        '!response' => var_export($response, TRUE),
      ));
      throw new AkamaiException($message);
    }
    if (empty($response->data)) {
      $message = format_string('Received no response data. Akamai RestAPI !action for !uris: Response: !response', array(
        '!uris' => implode(' ', $uris),
        '!action' => $action,
        '!response' => var_export($response, TRUE),
      ));
      throw new AkamaiException($message);
    }
    $response_data = json_decode($response->data);
    if ($response_data === null && json_last_error() !== JSON_ERROR_NONE) {
      $message = format_string('Failed to decode JSON data. Akamai RestAPI !action for !uris: Response: !response', array(
        '!uris' => implode(' ', $uris),
        '!action' => $action,
        '!response' => var_export($response, TRUE),
      ));
      throw new AkamaiException($message);
    }
    watchdog('Akamai', "Akamai RestAPI %action for %uris on %domain: Response: %response", array(
      '%uris' => implode(' ', $uris),
      '%action' => $action,
      '%domain' => $domain,
      '%response' => print_r($response_data, TRUE),
    ), WATCHDOG_NOTICE);
    return $response;
  }

}

/**
 * Implementation of the AkamaiCacheControl interface that records what was sent to it.
 * Hint: This is only useful for testing.
 */
class RecordingCacheControlClient implements AkamaiCacheControl {
  public $paths;
  public $options;

  /**
   * Constructs an instance of the Akamai Cache Control facade.
   */
  function __construct($options = array()) {
    $this->options = $options;
  }

  /**
   * Records the paths passed in.
   */
  function clear_url($paths) {
    if (!is_array($paths)) {
      $paths = array(
        $paths,
      );
    }
    $this->paths = $paths;
    return (object) array(
      'success' => TRUE,
      'code' => '',
      'message' => '',
    );
  }

}

/**
 * Implementation of the AkamaiCacheControl interface that throws AkamaiException.
 * Hint: This is only useful for testing.
 */
class ErrorCacheControlClient implements AkamaiCacheControl {

  /**
   * Constructs an instance of the Akamai Cache Control facade.
   */
  function __construct($options = array()) {
  }

  /**
   * Records the paths passed in.
   */
  function clear_url($paths) {
    throw new AkamaiException(t('Akamai Failure Condition Test'));
  }

}

/**
 * Class AkamaiException.
 */
class AkamaiException extends Exception {

}

Classes

Name	Description
AkamaiCacheControlClient	Default implementation of the AkamaiCacheControl interface
AkamaiException	Class AkamaiException.
ErrorCacheControlClient	Implementation of the AkamaiCacheControl interface that throws AkamaiException. Hint: This is only useful for testing.
RecordingCacheControlClient	Implementation of the AkamaiCacheControl interface that records what was sent to it. Hint: This is only useful for testing.

Interfaces

Name	Description
AkamaiCacheControl	@file akamai.class.inc Akamai is a registered trademark of Akamai Technologies, Inc. This class is an abstraction around the Akamai Cache Control API.