Caching (#260)

Author: felixfbecker

src/Cache/Cache.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Cache;
+
+use Sabre\Event\Promise;
+
+/**
+ * A key/value store for caching purposes
+ */
+interface Cache
+{
+    /**
+     * Gets a value from the cache
+     *
+     * @param string $key
+     * @return Promise <mixed>
+     */
+    public function get(string $key): Promise;
+
+    /**
+     * Sets a value in the cache
+     *
+     * @param string $key
+     * @param mixed  $value
+     * @return Promise
+     */
+    public function set(string $key, $value): Promise;
+}

src/Cache/ClientCache.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Cache;
+
+use LanguageServer\LanguageClient;
+use Sabre\Event\Promise;
+
+/**
+ * Caches content through a xcache/* requests
+ */
+class ClientCache implements Cache
+{
+    /**
+     * @param LanguageClient $client
+     */
+    public function __construct(LanguageClient $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Gets a value from the cache
+     *
+     * @param string $key
+     * @return Promise <mixed>
+     */
+    public function get(string $key): Promise
+    {
+        return $this->client->xcache->get($key)->then('unserialize')->otherwise(function () {
+            // Ignore
+        });
+    }
+
+    /**
+     * Sets a value in the cache
+     *
+     * @param string $key
+     * @param mixed  $value
+     * @return Promise
+     */
+    public function set(string $key, $value): Promise
+    {
+        return $this->client->xcache->set($key, serialize($value))->otherwise(function () {
+            // Ignore
+        });
+    }
+}

src/Cache/FileSystemCache.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Cache;
+
+use LanguageServer\LanguageClient;
+use Sabre\Event\Promise;
+
+/**
+ * Caches content on the file system
+ */
+class FileSystemCache implements Cache
+{
+    /**
+     * @var string
+     */
+    public $cacheDir;
+
+    public function __construct()
+    {
+        if (PHP_OS === 'WINNT') {
+            $this->cacheDir = getenv('LOCALAPPDATA') . '\\PHP Language Server\\';
+        } else if (getenv('XDG_CACHE_HOME')) {
+            $this->cacheDir = getenv('XDG_CACHE_HOME') . '/phpls/';
+        } else {
+            $this->cacheDir = getenv('HOME') . '/.phpls/';
+        }
+    }
+
+    /**
+     * Gets a value from the cache
+     *
+     * @param string $key
+     * @return Promise <mixed>
+     */
+    public function get(string $key): Promise
+    {
+        try {
+            $file = $this->cacheDir . urlencode($key);
+            if (!file_exists($file)) {
+                return Promise\resolve(null);
+            }
+            return Promise\resolve(unserialize(file_get_contents($file)));
+        } catch (\Exception $e) {
+            return Promise\resolve(null);
+        }
+    }
+
+    /**
+     * Sets a value in the cache
+     *
+     * @param string $key
+     * @param mixed  $value
+     * @return Promise
+     */
+    public function set(string $key, $value): Promise
+    {
+        try {
+            $file = $this->cacheDir . urlencode($key);
+            if (!file_exists($this->cacheDir)) {
+                mkdir($this->cacheDir);
+            }
+            file_put_contents($file, serialize($value));
+        } finally {
+            return Promise\resolve(null);
+        }
+    }
+}

src/Client/XCache.php

@@ -0,0 +1,43 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Client;
+
+use LanguageServer\ClientHandler;
+use LanguageServer\Protocol\Message;
+use Sabre\Event\Promise;
+
+/**
+ * Provides method handlers for all xcache/* methods
+ */
+class XCache
+{
+    /**
+     * @var ClientHandler
+     */
+    private $handler;
+
+    public function __construct(ClientHandler $handler)
+    {
+        $this->handler = $handler;
+    }
+
+    /**
+     * @param string $key
+     * @return Promise <mixed>
+     */
+    public function get(string $key): Promise
+    {
+        return $this->handler->request('xcache/get', ['key' => $key]);
+    }
+
+    /**
+     * @param string $key
+     * @param mixed  $value
+     * @return Promise <mixed>
+     */
+    public function set(string $key, $value): Promise
+    {
+        return $this->handler->notify('xcache/set', ['key' => $key, 'value' => $value]);
+    }
+}

src/Index/DependenciesIndex.php

@@ -34,6 +34,17 @@ public function getDependencyIndex(string $packageName): Index
         return $this->indexes[$packageName];
     }
 
+    /**
+     * @param string $packageName
+     * @param Index  $index
+     * @return void
+     */
+    public function setDependencyIndex(string $packageName, Index $index)
+    {
+        $this->indexes[$packageName] = $index;
+        $this->registerIndex($index);
+    }
+
     /**
      * @param string $packageName
      * @return void

src/Index/Index.php

@@ -10,7 +10,7 @@
  * Represents the index of a project or dependency
  * Serializable for caching
  */
-class Index implements ReadableIndex
+class Index implements ReadableIndex, \Serializable
 {
     use EmitterTrait;
 
@@ -185,4 +185,30 @@ public function removeReferenceUri(string $fqn, string $uri)
         }
         array_splice($this->references[$fqn], $index, 1);
     }
+
+    /**
+     * @param string $serialized
+     * @return void
+     */
+    public function unserialize($serialized)
+    {
+        $data = unserialize($serialized);
+        foreach ($data as $prop => $val) {
+            $this->$prop = $val;
+        }
+    }
+
+    /**
+     * @param string $serialized
+     * @return string
+     */
+    public function serialize()
+    {
+        return serialize([
+            'definitions' => $this->definitions,
+            'references' => $this->references,
+            'complete' => $this->complete,
+            'staticComplete' => $this->staticComplete
+        ]);
+    }
 }