aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Cache/CappedMemoryCache.php
blob: 999ed8a7a74e2044f9722cb39cd2bc4b1bc37289 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OC\Cache;

use OCP\ICache;

/**
 * In-memory cache with a capacity limit to keep memory usage in check
 *
 * Uses a simple FIFO expiry mechanism
 * @template T
 * @deprecated 25.0.0 use OCP\Cache\CappedMemoryCache instead
 */
class CappedMemoryCache implements ICache, \ArrayAccess {
	private $capacity;
	/** @var T[] */
	private $cache = [];

	public function __construct($capacity = 512) {
		$this->capacity = $capacity;
	}

	public function hasKey($key): bool {
		return isset($this->cache[$key]);
	}

	/**
	 * @return ?T
	 */
	public function get($key) {
		return $this->cache[$key] ?? null;
	}

	/**
	 * @param string $key
	 * @param T $value
	 * @param int $ttl
	 * @return bool
	 */
	public function set($key, $value, $ttl = 0): bool {
		if (is_null($key)) {
			$this->cache[] = $value;
		} else {
			$this->cache[$key] = $value;
		}
		$this->garbageCollect();
		return true;
	}

	public function remove($key) {
		unset($this->cache[$key]);
		return true;
	}

	public function clear($prefix = '') {
		$this->cache = [];
		return true;
	}

	public function offsetExists($offset): bool {
		return $this->hasKey($offset);
	}

	/**
	 * @return T
	 */
	#[\ReturnTypeWillChange]
	public function &offsetGet($offset) {
		return $this->cache[$offset];
	}

	/**
	 * @param string $offset
	 * @param T $value
	 * @return void
	 */
	public function offsetSet($offset, $value): void {
		$this->set($offset, $value);
	}

	public function offsetUnset($offset): void {
		$this->remove($offset);
	}

	/**
	 * @return T[]
	 */
	public function getData() {
		return $this->cache;
	}


	private function garbageCollect() {
		while (count($this->cache) > $this->capacity) {
			reset($this->cache);
			$key = key($this->cache);
			$this->remove($key);
		}
	}

	public static function isAvailable(): bool {
		return true;
	}
}
/span> "somevalue")); $query->execute(array("Someuser", "getkeysapp", "key-tastic", "somevalue")); $query->execute(array("Someuser", "getvalueapp", "key", "a value for a key")); $query->execute(array("Deleteuser", "deleteapp", "deletekey", "somevalue")); $query->execute(array("Deleteuser", "deleteapp", "somekey", "somevalue")); $query->execute(array("Deleteuser", "someapp", "somekey", "somevalue")); } public static function tearDownAfterClass() { $query = \OC_DB::prepare('DELETE FROM `*PREFIX*preferences` WHERE `userid` = ?'); $query->execute(array('Someuser')); $query->execute(array('Anotheruser')); $query->execute(array('Anuser')); } public function testGetUsers() { $query = \OC_DB::prepare('SELECT DISTINCT `userid` FROM `*PREFIX*preferences`'); $result = $query->execute(); $expected = array(); while ($row = $result->fetchRow()) { $expected[] = $row['userid']; } $this->assertEquals($expected, \OC_Preferences::getUsers()); } public function testGetApps() { $query = \OC_DB::prepare('SELECT DISTINCT `appid` FROM `*PREFIX*preferences` WHERE `userid` = ?'); $result = $query->execute(array('Someuser')); $expected = array(); while ($row = $result->fetchRow()) { $expected[] = $row['appid']; } $this->assertEquals($expected, \OC_Preferences::getApps('Someuser')); } public function testGetKeys() { $query = \OC_DB::prepare('SELECT DISTINCT `configkey` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?'); $result = $query->execute(array('Someuser', 'getkeysapp')); $expected = array(); while ($row = $result->fetchRow()) { $expected[] = $row['configkey']; } $this->assertEquals($expected, \OC_Preferences::getKeys('Someuser', 'getkeysapp')); } public function testGetValue() { $this->assertNull(\OC_Preferences::getValue('nonexistant', 'nonexistant', 'nonexistant')); $this->assertEquals('default', \OC_Preferences::getValue('nonexistant', 'nonexistant', 'nonexistant', 'default')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'); $result = $query->execute(array('Someuser', 'getvalueapp', 'key')); $row = $result->fetchRow(); $expected = $row['configvalue']; $this->assertEquals($expected, \OC_Preferences::getValue('Someuser', 'getvalueapp', 'key')); } public function testSetValue() { $this->assertTrue(\OC_Preferences::setValue('Someuser', 'setvalueapp', 'newkey', 'newvalue')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'); $result = $query->execute(array('Someuser', 'setvalueapp', 'newkey')); $row = $result->fetchRow(); $value = $row['configvalue']; $this->assertEquals('newvalue', $value); $this->assertTrue(\OC_Preferences::setValue('Someuser', 'setvalueapp', 'newkey', 'othervalue')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'); $result = $query->execute(array('Someuser', 'setvalueapp', 'newkey')); $row = $result->fetchRow(); $value = $row['configvalue']; $this->assertEquals('othervalue', $value); } public function testDeleteKey() { $this->assertTrue(\OC_Preferences::deleteKey('Deleteuser', 'deleteapp', 'deletekey')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'); $result = $query->execute(array('Deleteuser', 'deleteapp', 'deletekey')); $this->assertEquals(0, $result->numRows()); } public function testDeleteApp() { $this->assertTrue(\OC_Preferences::deleteApp('Deleteuser', 'deleteapp')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?'); $result = $query->execute(array('Deleteuser', 'deleteapp')); $this->assertEquals(0, $result->numRows()); } public function testDeleteUser() { $this->assertTrue(\OC_Preferences::deleteUser('Deleteuser')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?'); $result = $query->execute(array('Deleteuser')); $this->assertEquals(0, $result->numRows()); } public function testDeleteAppFromAllUsers() { $this->assertTrue(\OC_Preferences::deleteAppFromAllUsers('someapp')); $query = \OC_DB::prepare('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `appid` = ?'); $result = $query->execute(array('someapp')); $this->assertEquals(0, $result->numRows()); } } class Test_Preferences_Object extends PHPUnit_Framework_TestCase { public function testGetUsers() { $statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false); $statementMock->expects($this->exactly(2)) ->method('fetchColumn') ->will($this->onConsecutiveCalls('foo', false)); $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('executeQuery') ->with($this->equalTo('SELECT DISTINCT `userid` FROM `*PREFIX*preferences`')) ->will($this->returnValue($statementMock)); $preferences = new OC\Preferences($connectionMock); $apps = $preferences->getUsers(); $this->assertEquals(array('foo'), $apps); } public function testGetApps() { $statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false); $statementMock->expects($this->exactly(2)) ->method('fetchColumn') ->will($this->onConsecutiveCalls('foo', false)); $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('executeQuery') ->with($this->equalTo('SELECT DISTINCT `appid` FROM `*PREFIX*preferences` WHERE `userid` = ?'), $this->equalTo(array('bar'))) ->will($this->returnValue($statementMock)); $preferences = new OC\Preferences($connectionMock); $apps = $preferences->getApps('bar'); $this->assertEquals(array('foo'), $apps); } public function testGetKeys() { $statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false); $statementMock->expects($this->exactly(2)) ->method('fetchColumn') ->will($this->onConsecutiveCalls('foo', false)); $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('executeQuery') ->with($this->equalTo('SELECT `configkey` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?'), $this->equalTo(array('bar', 'moo'))) ->will($this->returnValue($statementMock)); $preferences = new OC\Preferences($connectionMock); $keys = $preferences->getKeys('bar', 'moo'); $this->assertEquals(array('foo'), $keys); } public function testGetValue() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->exactly(2)) ->method('fetchAssoc') ->with($this->equalTo('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'), $this->equalTo(array('grg', 'bar', 'red'))) ->will($this->onConsecutiveCalls(array('configvalue'=>'foo'), null)); $preferences = new OC\Preferences($connectionMock); $value = $preferences->getValue('grg', 'bar', 'red'); $this->assertEquals('foo', $value); $value = $preferences->getValue('grg', 'bar', 'red', 'def'); $this->assertEquals('def', $value); } public function testSetValue() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->exactly(2)) ->method('fetchColumn') ->with($this->equalTo('SELECT COUNT(*) FROM `*PREFIX*preferences`' .' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'), $this->equalTo(array('grg', 'bar', 'foo'))) ->will($this->onConsecutiveCalls(0, 1)); $connectionMock->expects($this->once()) ->method('insert') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'userid' => 'grg', 'appid' => 'bar', 'configkey' => 'foo', 'configvalue' => 'v1', ) )); $connectionMock->expects($this->once()) ->method('update') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'configvalue' => 'v2', )), $this->equalTo( array( 'userid' => 'grg', 'appid' => 'bar', 'configkey' => 'foo', ) )); $preferences = new OC\Preferences($connectionMock); $preferences->setValue('grg', 'bar', 'foo', 'v1'); $preferences->setValue('grg', 'bar', 'foo', 'v2'); } public function testDeleteKey() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('delete') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'userid' => 'grg', 'appid' => 'bar', 'configkey' => 'foo', ) )); $preferences = new OC\Preferences($connectionMock); $preferences->deleteKey('grg', 'bar', 'foo'); } public function testDeleteApp() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('delete') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'userid' => 'grg', 'appid' => 'bar', ) )); $preferences = new OC\Preferences($connectionMock); $preferences->deleteApp('grg', 'bar'); } public function testDeleteUser() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('delete') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'userid' => 'grg', ) )); $preferences = new OC\Preferences($connectionMock); $preferences->deleteUser('grg'); } public function testDeleteAppFromAllUsers() { $connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false); $connectionMock->expects($this->once()) ->method('delete') ->with($this->equalTo('*PREFIX*preferences'), $this->equalTo( array( 'appid' => 'bar', ) )); $preferences = new OC\Preferences($connectionMock); $preferences->deleteAppFromAllUsers('bar'); } }