runff 1.0 commit

lib/SimpleSAML/Store.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace SimpleSAML;
+
+use SimpleSAML\Error\CriticalConfigurationError;
+
+/**
+ * Base class for data stores.
+ *
+ * @package SimpleSAMLphp
+ */
+abstract class Store
+{
+    /**
+     * Our singleton instance.
+     *
+     * This is false if the data store isn't enabled, and null if we haven't attempted to initialize it.
+     *
+     * @var \SimpleSAML\Store|false|null
+     */
+    private static $instance;
+
+
+    /**
+     * Retrieve our singleton instance.
+     *
+     * @return false|\SimpleSAML\Store The data store, or false if it isn't enabled.
+     *
+     * @throws \SimpleSAML\Error\CriticalConfigurationError
+     */
+    public static function getInstance()
+    {
+        if (self::$instance !== null) {
+            return self::$instance;
+        }
+
+        $config = \SimpleSAML_Configuration::getInstance();
+        $storeType = $config->getString('store.type', null);
+        if ($storeType === null) {
+            $storeType = $config->getString('session.handler', 'phpsession');
+        }
+
+        switch ($storeType) {
+            case 'phpsession':
+                // we cannot support advanced features with the PHP session store
+                self::$instance = false;
+                break;
+            case 'memcache':
+                self::$instance = new Store\Memcache();
+                break;
+            case 'sql':
+                self::$instance = new Store\SQL();
+                break;
+            case 'redis':
+                self::$instance = new Store\Redis();
+                break;
+            default:
+                // datastore from module
+                try {
+                    $className = Module::resolveClass($storeType, 'Store', '\SimpleSAML\Store');
+                } catch (\Exception $e) {
+                    $c = $config->toArray();
+                    $c['store.type'] = 'phpsession';
+                    throw new CriticalConfigurationError(
+                        "Invalid 'store.type' configuration option. Cannot find store '$storeType'.",
+                        null,
+                        $c
+                    );
+                }
+                self::$instance = new $className();
+        }
+
+        return self::$instance;
+    }
+
+
+    /**
+     * Retrieve a value from the data store.
+     *
+     * @param string $type The data type.
+     * @param string $key The key.
+     *
+     * @return mixed|null The value.
+     */
+    abstract public function get($type, $key);
+
+
+    /**
+     * Save a value to the data store.
+     *
+     * @param string   $type The data type.
+     * @param string   $key The key.
+     * @param mixed    $value The value.
+     * @param int|null $expire The expiration time (unix timestamp), or null if it never expires.
+     */
+    abstract public function set($type, $key, $value, $expire = null);
+
+
+    /**
+     * Delete a value from the data store.
+     *
+     * @param string $type The data type.
+     * @param string $key The key.
+     */
+    abstract public function delete($type, $key);
+}