Mirrors/roundcubemail
2
0
Fork 0
mirror of https://github.com/roundcube/roundcubemail.git synced 2026-02-20 01:21:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add APCu cache driver (#9828)

Browse Source
This commit is contained in:
Dennis
2025-04-06 15:43:53 +02:00
committed by GitHub
parent 62288d89dc
commit edbfd1109b
5 changed files with 141 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
config/defaults.inc.php
View File

@@ -240,7 +240,7 @@ $config['imap_disabled_caps'] = [];
// This is used to relate IMAP session with Roundcube user sessions
$config['imap_log_session'] = false;
// Type of IMAP indexes cache. Supported values: 'db', 'apc', 'redis' and 'memcache' or 'memcached'.
// Type of IMAP indexes cache. Supported values: 'db', 'apc', 'apcu', 'redis' and 'memcache' or 'memcached'.
$config['imap_cache'] = null;
// Enables messages cache. Only 'db' cache is supported.
@@ -460,7 +460,7 @@ $config['oauth_password_claim'] = null;
// LDAP
// ----------------------------------
// Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache' or 'memcached'.
// Type of LDAP cache. Supported values: 'db', 'apc', 'apcu' and 'memcache' or 'memcached'.
$config['ldap_cache'] = 'db';
// Lifetime of LDAP cache. Possible units: s, m, h, d, w

2
plugins/database_attachments/config.inc.php.dist
View File

@@ -4,7 +4,7 @@ $config = [];
// By default this plugin stores attachments in filesystem
// and copies them into sql database.
// You can change it to use 'memcache', 'memcached', 'redis' or 'apc'.
// You can change it to use 'memcache', 'memcached', 'redis', 'apc' or 'apcu'.
// -----------------------------------------------------------
// WARNING: Remember to set max_allowed_packet in database or
// config to match with expected max attachment size.

136
program/lib/Roundcube/cache/apcu.php vendored Normal file
View File

@@ -0,0 +1,136 @@
<?php
/*
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
| |
| Copyright (C) The Roundcube Dev Team |
| Copyright (C) Kolab Systems AG |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
| See the README file for a full license statement. |
| |
| PURPOSE: |
| Caching engine - APCu |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
*/
/**
* Interface implementation class for accessing APCu cache
*/
class rcube_cache_apcu extends rcube_cache
{
/**
* Indicates if APCu module is enabled and in a required version
*
* @var bool
*/
protected $enabled;
public function __construct($userid, $prefix = '', $ttl = 0, $packed = true, $indexed = false)
{
parent::__construct($userid, $prefix, $ttl, $packed, $indexed);
$rcube = rcube::get_instance();
$this->type = 'apcu';
$this->enabled = function_exists('apcu_exists'); // APCu required (pecl install apcu)
$this->debug = $rcube->config->get('apcu_debug');
}
/**
* Remove cache records older than ttl
*/
#[Override]
public function expunge()
{
// No need for GC, entries are expunged automatically
}
/**
* Remove expired records of all caches
*/
#[Override]
public static function gc()
{
// No need for GC, entries are expunged automatically
}
/**
* Reads cache entry.
*
* @param string $key Cache internal key name
*
* @return mixed Cached value
*/
#[Override]
protected function get_item($key)
{
if (!$this->enabled) {
return false;
}
$data = apcu_fetch($key);
if ($this->debug) {
$this->debug('get', $key, $data);
}
return $data;
}
/**
* Adds entry into memcache/apc/apcu/redis DB.
*
* @param string $key Cache internal key name
* @param mixed $data Serialized cache data
*
* @return bool True on success, False on failure
*/
#[Override]
protected function add_item($key, $data)
{
if (!$this->enabled) {
return false;
}
if (apcu_exists($key)) {
apcu_delete($key);
}
$result = apcu_store($key, $data, $this->ttl);
if ($this->debug) {
$this->debug('set', $key, $data, $result);
}
return $result;
}
/**
* Deletes entry from memcache/apc/apcu/redis DB.
*
* @param string $key Cache internal key name
*
* @return bool True on success, False on failure
*/
#[Override]
protected function delete_item($key)
{
if (!$this->enabled) {
return false;
}
$result = apcu_delete($key);
if ($this->debug) {
$this->debug('delete', $key, null, $result);
}
return $result;
}
}

2
program/lib/Roundcube/rcube.php
View File

@@ -215,7 +215,7 @@ class rcube
* Initialize and get user cache object
*
* @param string $name Cache identifier
* @param string $type Cache type ('db', 'apc', 'memcache', 'redis')
* @param string $type Cache type ('db', 'apc', 'apcu', 'memcache', 'redis')
* @param string|int $ttl Expiration time for cache items
* @param bool $packed Enables/disables data serialization
* @param bool $indexed Use indexed cache

2
program/lib/Roundcube/rcube_cache.php
View File

@@ -46,7 +46,7 @@ class rcube_cache
/**
* Object factory
*
* @param string $type Engine type ('db', 'memcache', 'apc', 'redis')
* @param string $type Engine type ('db', 'memcache', 'apc', 'apcu', 'redis')
* @param int $userid User identifier
* @param string $prefix Key name prefix
* @param int|string $ttl Expiration time of memcache/apc items