summaryrefslogtreecommitdiff
path: root/plugins/LdapCommon/MemcacheSchemaCache.php
diff options
context:
space:
mode:
authorCraig Andrews <candrews@integralblue.com>2010-03-21 23:05:23 -0400
committerCraig Andrews <candrews@integralblue.com>2010-03-22 14:17:58 -0400
commit295e05ea39982ff2b41cec21d5622375005682c2 (patch)
tree4b3ba21af1ba462ea84d037c7d6d12d4417bec57 /plugins/LdapCommon/MemcacheSchemaCache.php
parentc810f2485132fe124e671dee4f86eb721eee15e4 (diff)
Refactor common parts of LdapAuthorization and LdapAuthentication plugins into a separate class
LdapAuthorization should get a performance improvement as LDAP schema caching is now used
Diffstat (limited to 'plugins/LdapCommon/MemcacheSchemaCache.php')
-rw-r--r--plugins/LdapCommon/MemcacheSchemaCache.php75
1 files changed, 75 insertions, 0 deletions
diff --git a/plugins/LdapCommon/MemcacheSchemaCache.php b/plugins/LdapCommon/MemcacheSchemaCache.php
new file mode 100644
index 000000000..6b91d17d6
--- /dev/null
+++ b/plugins/LdapCommon/MemcacheSchemaCache.php
@@ -0,0 +1,75 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Cache the LDAP schema in memcache to improve performance
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Plugin
+ * @package StatusNet
+ * @author Craig Andrews <candrews@integralblue.com>
+ * @copyright 2009 Craig Andrews http://candrews.integralblue.com
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
+ */
+class MemcacheSchemaCache implements Net_LDAP2_SchemaCache
+{
+ protected $c;
+ protected $cacheKey;
+
+ /**
+ * Initialize the simple cache
+ *
+ * Config is as following:
+ * memcache memcache instance
+ * cachekey the key in the cache to look at
+ *
+ * @param array $cfg Config array
+ */
+ public function MemcacheSchemaCache($cfg)
+ {
+ $this->c = $cfg['c'];
+ $this->cacheKey = $cfg['cacheKey'];
+ }
+
+ /**
+ * Return the schema object from the cache
+ *
+ * @return Net_LDAP2_Schema|Net_LDAP2_Error|false
+ */
+ public function loadSchema()
+ {
+ return $this->c->get($this->cacheKey);
+ }
+
+ /**
+ * Store a schema object in the cache
+ *
+ * This method will be called, if Net_LDAP2 has fetched a fresh
+ * schema object from LDAP and wants to init or refresh the cache.
+ *
+ * To invalidate the cache and cause Net_LDAP2 to refresh the cache,
+ * you can call this method with null or false as value.
+ * The next call to $ldap->schema() will then refresh the caches object.
+ *
+ * @param mixed $schema The object that should be cached
+ * @return true|Net_LDAP2_Error|false
+ */
+ public function storeSchema($schema) {
+ return $this->c->set($this->cacheKey, $schema);
+ }
+}