Add basic file cache

src/FileCacheFactory.php

@@ -0,0 +1,151 @@
+<?php
+
+/**
+ * Implements a basic file cache for DrupalClient.
+ */
+
+namespace EclipseGc\DrupalOrg\Api;
+
+//use EclipseGc\DrupalOrg\Api\FactoryInterface;
+//use EclipseGc\DrupalOrg\Api\Factory;
+use GuzzleHttp\Stream\Stream;
+use GuzzleHttp\Message\Response;
+
+/**
+ * Class FileCacheFactory
+ *
+ * Uses a simple directory cache to store requests. This directory defaults to
+ * $HOME/.drupal-api-cache, but is configurable in the constructor.
+ *
+ * @package EclipseGc\DrupalOrg\Api
+ */
+class FileCacheFactory implements FactoryInterface {
+  /**
+   * @var Factory
+   */
+  protected $baseFactory;
+  /**
+   * @var
+   */
+  protected $cacheDirectory;
+
+  /**
+   * Constructor
+   * @param $factory FactoryInterface
+   * @param $cacheDirectory string
+   *  The directory in which to store cache files. Defaults to
+   *  $HOME/.drupal-api-cache.
+   * @throws \Exception
+   */
+  public function __construct(FactoryInterface $factory, $cacheDirectory = '.drupal-api-cache') {
+    $this->baseFactory = $factory;
+
+    if (!strstr($cacheDirectory, '/') !== FALSE) {
+      if (realpath($cacheDirectory) == '') {
+        // It's not local, so default to the home directory.
+        $cacheDirectory = $_SERVER['HOME'] . '/' . $cacheDirectory;
+      }
+      else {
+        $cacheDirectory = realpath($cacheDirectory);
+      }
+    }
+
+    if (!file_exists($cacheDirectory)) {
+      // Try to create it.
+      if (!mkdir($cacheDirectory)) {
+        throw new \Exception('Unable to create cache directory: ' . $cacheDirectory);
+      }
+    }
+
+    if (!is_writable($cacheDirectory)) {
+      throw new \Exception('Cache directory is not writable: ' . $cacheDirectory);
+    }
+
+    $this->cacheDirectory = $cacheDirectory;
+  }
+
+  /**
+   * Caching request mechanism. Returns cached requests if we have them.
+   * @inheritdoc
+   */
+  public function request($entity_type, $id) {
+    $cacheFilePath = $this->cacheDirectory . '/' . $entity_type . '/' . $id;
+
+    if (file_exists($cacheFilePath)) {
+      $data = unserialize(file_get_contents($cacheFilePath));
+      if (isset($data->list)) {
+        $data = reset($data->list);
+      }
+      $data = new Response(200, ['Content-Type' => 'application/json'], Stream::factory(json_encode($data)));
+    }
+    else {
+      // No data.
+      $data = $this->baseFactory->request($entity_type, $id);
+
+      if (!file_exists($this->cacheDirectory . '/' . $entity_type)) {
+        mkdir($this->cacheDirectory . '/' . $entity_type);
+      }
+      else {
+        file_put_contents($cacheFilePath, serialize($data->json()));
+      }
+    }
+
+    return $data;
+  }
+
+  /**
+   * Caching request mechanism. Returns cached requests if we have them.
+   * @inheritdoc
+   */
+  public function pagedRequest($entity_type, array $params, $page = 0) {
+    $paramKeys = array_keys($params);
+    $entityKey = $entity_type . '-' . implode('-', $paramKeys);
+    $paramIds = implode('-', array_values($params)) . '-' . $page;
+    $cacheFilePath = $this->cacheDirectory . '/' . $entityKey . '/' . $paramIds;
+
+    if (file_exists($cacheFilePath)) {
+      $data = unserialize(file_get_contents($cacheFilePath));
+      $data = new Response(200, ['Content-Type' => 'application/json'], Stream::factory(json_encode($data)));
+    }
+    else {
+      $data = $this->baseFactory->pagedRequest($entity_type, $params, $page);
+
+      if (!file_exists($this->cacheDirectory . '/' . $entityKey)) {
+        mkdir($this->cacheDirectory . '/' . $entityKey);
+      }
+      else {
+        file_put_contents($cacheFilePath, serialize($data->json()));
+      }
+    }
+
+    return $data;
+  }
+
+  /**
+   * @inheritdoc
+   */
+  public function getObjectTypeClass($type, array $data) {
+    return $this->baseFactory->getObjectTypeClass($type, $data);
+  }
+
+  /**
+   * @inheritdoc
+   */
+  public function createObjectType($type, array $data = array()) {
+    return $this->baseFactory->createObjectType($type, $data);
+  }
+
+  /**
+   * Creates a list based on a response.
+   *
+   * @param $entityType
+   * @param $params
+   * @param array $data
+   * @param int $page
+   * @return object
+   */
+  public function createList($entityType, $params, array $data = array(), $page = 0) {
+    $data['factory'] = $this;
+    return $this->baseFactory->createList($entityType, $params, $data, $page);
+  }
+}