Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?php
> /** > * Memory caching. // security - hide paths > * if (!defined('ADODB_DIR')) die(); > * This file is part of ADOdb, a Database Abstraction Layer library for PHP. > * global $ADODB_INCLUDED_MEMCACHE; > * @package ADOdb $ADODB_INCLUDED_MEMCACHE = 1; > * @link https://adodb.org Project's web site and documentation > * @link https://github.com/ADOdb/ADOdb Source code and issue tracker global $ADODB_INCLUDED_CSV; > * if (empty($ADODB_INCLUDED_CSV)) include_once(ADODB_DIR.'/adodb-csvlib.inc.php'); > * The ADOdb Library is dual-licensed, released under both the BSD 3-Clause > * and the GNU Lesser General Public Licence (LGPL) v2.1 or, at your option, /* > * any later version. This means you can use it in proprietary products. > * See the LICENSE.md file distributed with this source code for details. @version v5.20.16 12-Jan-2020 > * @license BSD-3-Clause @copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved. > * @license LGPL-2.1-or-later @copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community > * Released under both BSD license and Lesser GPL library license. > * @copyright 2000-2013 John Lim Whenever there is any discrepancy between the two licenses, > * @copyright 2014 Damien Regad, Mark Newnham and the ADOdb community the BSD license will take precedence. See License.txt. > */
< /* < < @version v5.20.16 12-Jan-2020 < @copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved. < @copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community < Released under both BSD license and Lesser GPL library license. < Whenever there is any discrepancy between the two licenses, < the BSD license will take precedence. See License.txt. < Set tabs to 4 for best viewing. < < Latest version is available at http://adodb.org/ < < Usage: < < $db = NewADOConnection($driver); < $db->memCache = true; /// should we use memCache instead of caching in files < $db->memCacheHost = array($ip1, $ip2, $ip3); < $db->memCachePort = 11211; /// this is default memCache port < $db->memCacheCompress = false; /// Use 'true' to store the item compressed (uses zlib) < < $db->Connect(...); < $db->CacheExecute($sql); < < Note the memcache class is shared by all connections, is created during the first call to Connect/PConnect. < < Class instance is stored in $ADODB_CACHE < */ <
var $compress = false; // memcache compression with zlib
> // $library will be populated with the proper library on connect > // and is used later when there are differences in specific calls var $_connected = false; > // between memcache and memcached var $_memcache = false; > var $library = false; >
function __construct(&$obj) { $this->hosts = $obj->memCacheHost; $this->port = $obj->memCachePort; $this->compress = $obj->memCacheCompress; } // implement as lazy connection. The connection only occurs on CacheExecute call function connect(&$err) {
< if (!function_exists('memcache_pconnect')) { < $err = 'Memcache module PECL extension not found!';
> // do we have memcache or memcached? > if (class_exists('Memcache')) { > $this->library='Memcache'; > $memcache = new MemCache; > } elseif (class_exists('Memcached')) { > $this->library='Memcached'; > $memcache = new MemCached; > } else { > $err = 'Neither the Memcache nor Memcached PECL extensions were found!';
return false; }
< $memcache = new MemCache; <
if (!is_array($this->hosts)) $this->hosts = array($this->hosts); $failcnt = 0; foreach($this->hosts as $host) {
< if (!@$memcache->addServer($host,$this->port,true)) {
> if (!@$memcache->addServer($host,$this->port)) {
$failcnt += 1; } } if ($failcnt == sizeof($this->hosts)) { $err = 'Can\'t connect to any memcache server'; return false; } $this->_connected = true; $this->_memcache = $memcache; return true; } // returns true or false. true if successful save function writecache($filename, $contents, $debug, $secs2cache) { if (!$this->_connected) { $err = ''; if (!$this->connect($err) && $debug) ADOConnection::outp($err); } if (!$this->_memcache) return false;
> $failed=false; if (!$this->_memcache->set($filename, $contents, $this->compress ? MEMCACHE_COMPRESSED : 0, $secs2cache)) { > switch ($this->library) { if ($debug) ADOConnection::outp(" Failed to save data at the memcached server!<br>\n"); > case 'Memcache':
< if ($debug) ADOConnection::outp(" Failed to save data at the memcached server!<br>\n");
> $failed=true; > } > break; > case 'Memcached': > if (!$this->_memcache->set($filename, $contents, $secs2cache)) { > $failed=true; > } > break; > default: > $failed=true; > break; > } > > if($failed) { > if ($debug) ADOConnection::outp(" Failed to save data at the memcache server!<br>\n");
} return true; } // returns a recordset function readcache($filename, &$err, $secs2cache, $rsClass) { $false = false; if (!$this->_connected) $this->connect($err); if (!$this->_memcache) return $false; $rs = $this->_memcache->get($filename); if (!$rs) {
< $err = 'Item with such key doesn\'t exists on the memcached server.';
> $err = 'Item with such key doesn\'t exist on the memcache server.';
return $false; } // hack, should actually use _csv2rs $rs = explode("\n", $rs); unset($rs[0]); $rs = join("\n", $rs); $rs = unserialize($rs); if (! is_object($rs)) { $err = 'Unable to unserialize $rs'; return $false; } if ($rs->timeCreated == 0) return $rs; // apparently have been reports that timeCreated was set to 0 somewhere $tdiff = intval($rs->timeCreated+$secs2cache - time()); if ($tdiff <= 2) { switch($tdiff) { case 2: if ((rand() & 15) == 0) { $err = "Timeout 2"; return $false; } break; case 1: if ((rand() & 3) == 0) { $err = "Timeout 1"; return $false; } break; default: $err = "Timeout 0"; return $false; } } return $rs; } function flushall($debug=false) { if (!$this->_connected) { $err = ''; if (!$this->connect($err) && $debug) ADOConnection::outp($err); } if (!$this->_memcache) return false; $del = $this->_memcache->flush(); if ($debug) if (!$del) ADOConnection::outp("flushall: failed!<br>\n"); else ADOConnection::outp("flushall: succeeded!<br>\n"); return $del; } function flushcache($filename, $debug=false) { if (!$this->_connected) { $err = ''; if (!$this->connect($err) && $debug) ADOConnection::outp($err); } if (!$this->_memcache) return false; $del = $this->_memcache->delete($filename); if ($debug)
< if (!$del) ADOConnection::outp("flushcache: $key entry doesn't exist on memcached server!<br>\n"); < else ADOConnection::outp("flushcache: $key entry flushed from memcached server!<br>\n");
> if (!$del) ADOConnection::outp("flushcache: $key entry doesn't exist on memcache server!<br>\n"); > else ADOConnection::outp("flushcache: $key entry flushed from memcache server!<br>\n");
return $del; } // not used for memcache function createdir($dir, $hash) { return true; } }