first commit

classes/cache/CacheMemcached.php

@@ -0,0 +1,280 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+/**
+ * This class require PECL Memcached extension.
+ */
+class CacheMemcachedCore extends Cache
+{
+    /**
+     * @var Memcached
+     */
+    protected $memcached;
+
+    /**
+     * @var bool Connection status
+     */
+    protected $is_connected = false;
+
+    public function __construct()
+    {
+        $this->connect();
+        if ($this->isConnected()) {
+            $this->memcached->setOption(Memcached::OPT_PREFIX_KEY, _DB_PREFIX_);
+            if ($this->memcached->getOption(Memcached::HAVE_IGBINARY)) {
+                $this->memcached->setOption(Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_IGBINARY);
+            }
+        }
+    }
+
+    public function isConnected()
+    {
+        return $this->is_connected;
+    }
+
+    public function __destruct()
+    {
+        $this->close();
+    }
+
+    /**
+     * Connect to memcached server.
+     */
+    public function connect()
+    {
+        if (class_exists('Memcached') && extension_loaded('memcached')) {
+            $this->memcached = new Memcached();
+        } else {
+            return;
+        }
+
+        $servers = self::getMemcachedServers();
+
+        if (!$servers) {
+            return;
+        }
+        foreach ($servers as $server) {
+            $this->memcached->addServer($server['ip'], $server['port'], (int) $server['weight']);
+        }
+
+        $versions = $this->memcached->getVersion();
+        $this->is_connected = is_array($versions)
+            ? in_array('255.255.255', $versions, true) === false
+            : false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _set($key, $value, $ttl = 0)
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        $result = $this->memcached->set($key, $value, $ttl);
+
+        if ($result === false) {
+            if ($this->memcached->getResultCode() === Memcached::RES_E2BIG) {
+                $this->setAdjustTableCacheSize(true);
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _get($key)
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->get($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _exists($key)
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->get($key) !== false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _delete($key)
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->delete($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _deleteMulti(array $keyArray)
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->deleteMulti($keyArray);
+    }
+
+    /**
+     * @see Cache::_writeKeys()
+     */
+    protected function _writeKeys()
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function flush()
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->flush();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function set($key, $value, $ttl = 0)
+    {
+        return $this->_set($key, $value, $ttl);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get($key)
+    {
+        return $this->_get($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function exists($key)
+    {
+        return $this->_exists($key);
+    }
+
+    /**
+     * Delete one or several data from cache (* joker can be used, but avoid it !)
+     * 	E.g.: delete('*'); delete('my_prefix_*'); delete('my_key_name');.
+     *
+     * @param string $key
+     *
+     * @return bool
+     */
+    public function delete($key)
+    {
+        if ($key == '*') {
+            $this->flush();
+        } elseif (strpos($key, '*') === false) {
+            $this->_delete($key);
+        } else {
+            $pattern = str_replace('\\*', '.*', preg_quote($key));
+            $keys = $this->memcached->getAllKeys();
+            foreach ($keys as $key => $data) {
+                if (preg_match('#^' . $pattern . '$#', $key)) {
+                    $this->_delete($key);
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Close connection to memcache server.
+     *
+     * @return bool
+     */
+    protected function close()
+    {
+        if (!$this->isConnected()) {
+            return false;
+        }
+
+        return $this->memcached->quit();
+    }
+
+    /**
+     * Add a memcached server.
+     *
+     * @param string $ip
+     * @param int $port
+     * @param int $weight
+     *
+     * @return bool
+     */
+    public static function addServer($ip, $port, $weight)
+    {
+        return Db::getInstance()->execute('INSERT INTO ' . _DB_PREFIX_ . 'memcached_servers (ip, port, weight) VALUES(\'' . pSQL($ip) . '\', ' . (int) $port . ', ' . (int) $weight . ')', false);
+    }
+
+    /**
+     * Get list of memcached servers.
+     *
+     * @return array
+     */
+    public static function getMemcachedServers()
+    {
+        return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('SELECT * FROM ' . _DB_PREFIX_ . 'memcached_servers', true, false);
+    }
+
+    /**
+     * Delete a memcached server.
+     *
+     * @param int $id_server
+     *
+     * @return bool
+     */
+    public static function deleteServer($id_server)
+    {
+        return Db::getInstance()->execute('DELETE FROM ' . _DB_PREFIX_ . 'memcached_servers WHERE id_memcached_server=' . (int) $id_server);
+    }
+}