@@ -34,158 +34,158 @@ |
||
34 | 34 | use \OCP\ILogger; |
35 | 35 | |
36 | 36 | class Factory implements ICacheFactory { |
37 | - const NULL_CACHE = '\\OC\\Memcache\\NullCache'; |
|
38 | - |
|
39 | - /** |
|
40 | - * @var string $globalPrefix |
|
41 | - */ |
|
42 | - private $globalPrefix; |
|
43 | - |
|
44 | - /** |
|
45 | - * @var ILogger $logger |
|
46 | - */ |
|
47 | - private $logger; |
|
48 | - |
|
49 | - /** |
|
50 | - * @var string $localCacheClass |
|
51 | - */ |
|
52 | - private $localCacheClass; |
|
53 | - |
|
54 | - /** |
|
55 | - * @var string $distributedCacheClass |
|
56 | - */ |
|
57 | - private $distributedCacheClass; |
|
58 | - |
|
59 | - /** |
|
60 | - * @var string $lockingCacheClass |
|
61 | - */ |
|
62 | - private $lockingCacheClass; |
|
63 | - |
|
64 | - /** |
|
65 | - * @param string $globalPrefix |
|
66 | - * @param ILogger $logger |
|
67 | - * @param string|null $localCacheClass |
|
68 | - * @param string|null $distributedCacheClass |
|
69 | - * @param string|null $lockingCacheClass |
|
70 | - */ |
|
71 | - public function __construct($globalPrefix, ILogger $logger, |
|
72 | - $localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) |
|
73 | - { |
|
74 | - $this->logger = $logger; |
|
75 | - $this->globalPrefix = $globalPrefix; |
|
76 | - |
|
77 | - if (!$localCacheClass) { |
|
78 | - $localCacheClass = self::NULL_CACHE; |
|
79 | - } |
|
80 | - if (!$distributedCacheClass) { |
|
81 | - $distributedCacheClass = $localCacheClass; |
|
82 | - } |
|
83 | - |
|
84 | - $missingCacheMessage = 'Memcache {class} not available for {use} cache'; |
|
85 | - $missingCacheHint = 'Is the matching PHP module installed and enabled?'; |
|
86 | - if (!class_exists($localCacheClass) || !$localCacheClass::isAvailable()) { |
|
87 | - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
88 | - // CLI should not hard-fail on broken memcache |
|
89 | - $this->logger->info($missingCacheMessage, [ |
|
90 | - 'class' => $localCacheClass, |
|
91 | - 'use' => 'local', |
|
92 | - 'app' => 'cli' |
|
93 | - ]); |
|
94 | - $localCacheClass = self::NULL_CACHE; |
|
95 | - } else { |
|
96 | - throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
97 | - '{class}' => $localCacheClass, '{use}' => 'local' |
|
98 | - ]), $missingCacheHint); |
|
99 | - } |
|
100 | - } |
|
101 | - if (!class_exists($distributedCacheClass) || !$distributedCacheClass::isAvailable()) { |
|
102 | - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
103 | - // CLI should not hard-fail on broken memcache |
|
104 | - $this->logger->info($missingCacheMessage, [ |
|
105 | - 'class' => $distributedCacheClass, |
|
106 | - 'use' => 'distributed', |
|
107 | - 'app' => 'cli' |
|
108 | - ]); |
|
109 | - $distributedCacheClass = self::NULL_CACHE; |
|
110 | - } else { |
|
111 | - throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
112 | - '{class}' => $distributedCacheClass, '{use}' => 'distributed' |
|
113 | - ]), $missingCacheHint); |
|
114 | - } |
|
115 | - } |
|
116 | - if (!($lockingCacheClass && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) { |
|
117 | - // don't fallback since the fallback might not be suitable for storing lock |
|
118 | - $lockingCacheClass = self::NULL_CACHE; |
|
119 | - } |
|
120 | - |
|
121 | - $this->localCacheClass = $localCacheClass; |
|
122 | - $this->distributedCacheClass = $distributedCacheClass; |
|
123 | - $this->lockingCacheClass = $lockingCacheClass; |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * create a cache instance for storing locks |
|
128 | - * |
|
129 | - * @param string $prefix |
|
130 | - * @return \OCP\IMemcache |
|
131 | - */ |
|
132 | - public function createLocking($prefix = '') { |
|
133 | - return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * create a distributed cache instance |
|
138 | - * |
|
139 | - * @param string $prefix |
|
140 | - * @return \OC\Memcache\Cache |
|
141 | - */ |
|
142 | - public function createDistributed($prefix = '') { |
|
143 | - return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); |
|
144 | - } |
|
145 | - |
|
146 | - /** |
|
147 | - * create a local cache instance |
|
148 | - * |
|
149 | - * @param string $prefix |
|
150 | - * @return \OC\Memcache\Cache |
|
151 | - */ |
|
152 | - public function createLocal($prefix = '') { |
|
153 | - return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * @see \OC\Memcache\Factory::createDistributed() |
|
158 | - * @param string $prefix |
|
159 | - * @return \OC\Memcache\Cache |
|
160 | - */ |
|
161 | - public function create($prefix = '') { |
|
162 | - return $this->createDistributed($prefix); |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * check memcache availability |
|
167 | - * |
|
168 | - * @return bool |
|
169 | - */ |
|
170 | - public function isAvailable() { |
|
171 | - return ($this->distributedCacheClass !== self::NULL_CACHE); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * @see \OC\Memcache\Factory::createLocal() |
|
176 | - * @param string $prefix |
|
177 | - * @return Cache |
|
178 | - */ |
|
179 | - public function createLowLatency($prefix = '') { |
|
180 | - return $this->createLocal($prefix); |
|
181 | - } |
|
182 | - |
|
183 | - /** |
|
184 | - * check local memcache availability |
|
185 | - * |
|
186 | - * @return bool |
|
187 | - */ |
|
188 | - public function isAvailableLowLatency() { |
|
189 | - return ($this->localCacheClass !== self::NULL_CACHE); |
|
190 | - } |
|
37 | + const NULL_CACHE = '\\OC\\Memcache\\NullCache'; |
|
38 | + |
|
39 | + /** |
|
40 | + * @var string $globalPrefix |
|
41 | + */ |
|
42 | + private $globalPrefix; |
|
43 | + |
|
44 | + /** |
|
45 | + * @var ILogger $logger |
|
46 | + */ |
|
47 | + private $logger; |
|
48 | + |
|
49 | + /** |
|
50 | + * @var string $localCacheClass |
|
51 | + */ |
|
52 | + private $localCacheClass; |
|
53 | + |
|
54 | + /** |
|
55 | + * @var string $distributedCacheClass |
|
56 | + */ |
|
57 | + private $distributedCacheClass; |
|
58 | + |
|
59 | + /** |
|
60 | + * @var string $lockingCacheClass |
|
61 | + */ |
|
62 | + private $lockingCacheClass; |
|
63 | + |
|
64 | + /** |
|
65 | + * @param string $globalPrefix |
|
66 | + * @param ILogger $logger |
|
67 | + * @param string|null $localCacheClass |
|
68 | + * @param string|null $distributedCacheClass |
|
69 | + * @param string|null $lockingCacheClass |
|
70 | + */ |
|
71 | + public function __construct($globalPrefix, ILogger $logger, |
|
72 | + $localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) |
|
73 | + { |
|
74 | + $this->logger = $logger; |
|
75 | + $this->globalPrefix = $globalPrefix; |
|
76 | + |
|
77 | + if (!$localCacheClass) { |
|
78 | + $localCacheClass = self::NULL_CACHE; |
|
79 | + } |
|
80 | + if (!$distributedCacheClass) { |
|
81 | + $distributedCacheClass = $localCacheClass; |
|
82 | + } |
|
83 | + |
|
84 | + $missingCacheMessage = 'Memcache {class} not available for {use} cache'; |
|
85 | + $missingCacheHint = 'Is the matching PHP module installed and enabled?'; |
|
86 | + if (!class_exists($localCacheClass) || !$localCacheClass::isAvailable()) { |
|
87 | + if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
88 | + // CLI should not hard-fail on broken memcache |
|
89 | + $this->logger->info($missingCacheMessage, [ |
|
90 | + 'class' => $localCacheClass, |
|
91 | + 'use' => 'local', |
|
92 | + 'app' => 'cli' |
|
93 | + ]); |
|
94 | + $localCacheClass = self::NULL_CACHE; |
|
95 | + } else { |
|
96 | + throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
97 | + '{class}' => $localCacheClass, '{use}' => 'local' |
|
98 | + ]), $missingCacheHint); |
|
99 | + } |
|
100 | + } |
|
101 | + if (!class_exists($distributedCacheClass) || !$distributedCacheClass::isAvailable()) { |
|
102 | + if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
103 | + // CLI should not hard-fail on broken memcache |
|
104 | + $this->logger->info($missingCacheMessage, [ |
|
105 | + 'class' => $distributedCacheClass, |
|
106 | + 'use' => 'distributed', |
|
107 | + 'app' => 'cli' |
|
108 | + ]); |
|
109 | + $distributedCacheClass = self::NULL_CACHE; |
|
110 | + } else { |
|
111 | + throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
112 | + '{class}' => $distributedCacheClass, '{use}' => 'distributed' |
|
113 | + ]), $missingCacheHint); |
|
114 | + } |
|
115 | + } |
|
116 | + if (!($lockingCacheClass && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) { |
|
117 | + // don't fallback since the fallback might not be suitable for storing lock |
|
118 | + $lockingCacheClass = self::NULL_CACHE; |
|
119 | + } |
|
120 | + |
|
121 | + $this->localCacheClass = $localCacheClass; |
|
122 | + $this->distributedCacheClass = $distributedCacheClass; |
|
123 | + $this->lockingCacheClass = $lockingCacheClass; |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * create a cache instance for storing locks |
|
128 | + * |
|
129 | + * @param string $prefix |
|
130 | + * @return \OCP\IMemcache |
|
131 | + */ |
|
132 | + public function createLocking($prefix = '') { |
|
133 | + return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * create a distributed cache instance |
|
138 | + * |
|
139 | + * @param string $prefix |
|
140 | + * @return \OC\Memcache\Cache |
|
141 | + */ |
|
142 | + public function createDistributed($prefix = '') { |
|
143 | + return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); |
|
144 | + } |
|
145 | + |
|
146 | + /** |
|
147 | + * create a local cache instance |
|
148 | + * |
|
149 | + * @param string $prefix |
|
150 | + * @return \OC\Memcache\Cache |
|
151 | + */ |
|
152 | + public function createLocal($prefix = '') { |
|
153 | + return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * @see \OC\Memcache\Factory::createDistributed() |
|
158 | + * @param string $prefix |
|
159 | + * @return \OC\Memcache\Cache |
|
160 | + */ |
|
161 | + public function create($prefix = '') { |
|
162 | + return $this->createDistributed($prefix); |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * check memcache availability |
|
167 | + * |
|
168 | + * @return bool |
|
169 | + */ |
|
170 | + public function isAvailable() { |
|
171 | + return ($this->distributedCacheClass !== self::NULL_CACHE); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * @see \OC\Memcache\Factory::createLocal() |
|
176 | + * @param string $prefix |
|
177 | + * @return Cache |
|
178 | + */ |
|
179 | + public function createLowLatency($prefix = '') { |
|
180 | + return $this->createLocal($prefix); |
|
181 | + } |
|
182 | + |
|
183 | + /** |
|
184 | + * check local memcache availability |
|
185 | + * |
|
186 | + * @return bool |
|
187 | + */ |
|
188 | + public function isAvailableLowLatency() { |
|
189 | + return ($this->localCacheClass !== self::NULL_CACHE); |
|
190 | + } |
|
191 | 191 | } |
@@ -23,35 +23,35 @@ |
||
23 | 23 | namespace OC\Memcache; |
24 | 24 | |
25 | 25 | trait CASTrait { |
26 | - abstract public function get($key); |
|
26 | + abstract public function get($key); |
|
27 | 27 | |
28 | - abstract public function set($key, $value, $ttl = 0); |
|
28 | + abstract public function set($key, $value, $ttl = 0); |
|
29 | 29 | |
30 | - abstract public function remove($key); |
|
30 | + abstract public function remove($key); |
|
31 | 31 | |
32 | - abstract public function add($key, $value, $ttl = 0); |
|
32 | + abstract public function add($key, $value, $ttl = 0); |
|
33 | 33 | |
34 | - /** |
|
35 | - * Compare and set |
|
36 | - * |
|
37 | - * @param string $key |
|
38 | - * @param mixed $old |
|
39 | - * @param mixed $new |
|
40 | - * @return bool |
|
41 | - */ |
|
42 | - public function cas($key, $old, $new) { |
|
43 | - //no native cas, emulate with locking |
|
44 | - if ($this->add($key . '_lock', true)) { |
|
45 | - if ($this->get($key) === $old) { |
|
46 | - $this->set($key, $new); |
|
47 | - $this->remove($key . '_lock'); |
|
48 | - return true; |
|
49 | - } else { |
|
50 | - $this->remove($key . '_lock'); |
|
51 | - return false; |
|
52 | - } |
|
53 | - } else { |
|
54 | - return false; |
|
55 | - } |
|
56 | - } |
|
34 | + /** |
|
35 | + * Compare and set |
|
36 | + * |
|
37 | + * @param string $key |
|
38 | + * @param mixed $old |
|
39 | + * @param mixed $new |
|
40 | + * @return bool |
|
41 | + */ |
|
42 | + public function cas($key, $old, $new) { |
|
43 | + //no native cas, emulate with locking |
|
44 | + if ($this->add($key . '_lock', true)) { |
|
45 | + if ($this->get($key) === $old) { |
|
46 | + $this->set($key, $new); |
|
47 | + $this->remove($key . '_lock'); |
|
48 | + return true; |
|
49 | + } else { |
|
50 | + $this->remove($key . '_lock'); |
|
51 | + return false; |
|
52 | + } |
|
53 | + } else { |
|
54 | + return false; |
|
55 | + } |
|
56 | + } |
|
57 | 57 | } |
@@ -26,72 +26,72 @@ |
||
26 | 26 | namespace OC\Memcache; |
27 | 27 | |
28 | 28 | abstract class Cache implements \ArrayAccess, \OCP\ICache { |
29 | - /** |
|
30 | - * @var string $prefix |
|
31 | - */ |
|
32 | - protected $prefix; |
|
29 | + /** |
|
30 | + * @var string $prefix |
|
31 | + */ |
|
32 | + protected $prefix; |
|
33 | 33 | |
34 | - /** |
|
35 | - * @param string $prefix |
|
36 | - */ |
|
37 | - public function __construct($prefix = '') { |
|
38 | - $this->prefix = $prefix; |
|
39 | - } |
|
34 | + /** |
|
35 | + * @param string $prefix |
|
36 | + */ |
|
37 | + public function __construct($prefix = '') { |
|
38 | + $this->prefix = $prefix; |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * @return string Prefix used for caching purposes |
|
43 | - */ |
|
44 | - public function getPrefix() { |
|
45 | - return $this->prefix; |
|
46 | - } |
|
41 | + /** |
|
42 | + * @return string Prefix used for caching purposes |
|
43 | + */ |
|
44 | + public function getPrefix() { |
|
45 | + return $this->prefix; |
|
46 | + } |
|
47 | 47 | |
48 | - /** |
|
49 | - * @param string $key |
|
50 | - * @return mixed |
|
51 | - */ |
|
52 | - abstract public function get($key); |
|
48 | + /** |
|
49 | + * @param string $key |
|
50 | + * @return mixed |
|
51 | + */ |
|
52 | + abstract public function get($key); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param string $key |
|
56 | - * @param mixed $value |
|
57 | - * @param int $ttl |
|
58 | - * @return mixed |
|
59 | - */ |
|
60 | - abstract public function set($key, $value, $ttl = 0); |
|
54 | + /** |
|
55 | + * @param string $key |
|
56 | + * @param mixed $value |
|
57 | + * @param int $ttl |
|
58 | + * @return mixed |
|
59 | + */ |
|
60 | + abstract public function set($key, $value, $ttl = 0); |
|
61 | 61 | |
62 | - /** |
|
63 | - * @param string $key |
|
64 | - * @return mixed |
|
65 | - */ |
|
66 | - abstract public function hasKey($key); |
|
62 | + /** |
|
63 | + * @param string $key |
|
64 | + * @return mixed |
|
65 | + */ |
|
66 | + abstract public function hasKey($key); |
|
67 | 67 | |
68 | - /** |
|
69 | - * @param string $key |
|
70 | - * @return mixed |
|
71 | - */ |
|
72 | - abstract public function remove($key); |
|
68 | + /** |
|
69 | + * @param string $key |
|
70 | + * @return mixed |
|
71 | + */ |
|
72 | + abstract public function remove($key); |
|
73 | 73 | |
74 | - /** |
|
75 | - * @param string $prefix |
|
76 | - * @return mixed |
|
77 | - */ |
|
78 | - abstract public function clear($prefix = ''); |
|
74 | + /** |
|
75 | + * @param string $prefix |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | + abstract public function clear($prefix = ''); |
|
79 | 79 | |
80 | - //implement the ArrayAccess interface |
|
80 | + //implement the ArrayAccess interface |
|
81 | 81 | |
82 | - public function offsetExists($offset) { |
|
83 | - return $this->hasKey($offset); |
|
84 | - } |
|
82 | + public function offsetExists($offset) { |
|
83 | + return $this->hasKey($offset); |
|
84 | + } |
|
85 | 85 | |
86 | - public function offsetSet($offset, $value) { |
|
87 | - $this->set($offset, $value); |
|
88 | - } |
|
86 | + public function offsetSet($offset, $value) { |
|
87 | + $this->set($offset, $value); |
|
88 | + } |
|
89 | 89 | |
90 | - public function offsetGet($offset) { |
|
91 | - return $this->get($offset); |
|
92 | - } |
|
90 | + public function offsetGet($offset) { |
|
91 | + return $this->get($offset); |
|
92 | + } |
|
93 | 93 | |
94 | - public function offsetUnset($offset) { |
|
95 | - $this->remove($offset); |
|
96 | - } |
|
94 | + public function offsetUnset($offset) { |
|
95 | + $this->remove($offset); |
|
96 | + } |
|
97 | 97 | } |
@@ -30,140 +30,140 @@ |
||
30 | 30 | use OCP\IMemcache; |
31 | 31 | |
32 | 32 | class APCu extends Cache implements IMemcache { |
33 | - use CASTrait { |
|
34 | - cas as casEmulated; |
|
35 | - } |
|
33 | + use CASTrait { |
|
34 | + cas as casEmulated; |
|
35 | + } |
|
36 | 36 | |
37 | - use CADTrait; |
|
37 | + use CADTrait; |
|
38 | 38 | |
39 | - public function get($key) { |
|
40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | - if (!$success) { |
|
42 | - return null; |
|
43 | - } |
|
44 | - return $result; |
|
45 | - } |
|
39 | + public function get($key) { |
|
40 | + $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | + if (!$success) { |
|
42 | + return null; |
|
43 | + } |
|
44 | + return $result; |
|
45 | + } |
|
46 | 46 | |
47 | - public function set($key, $value, $ttl = 0) { |
|
48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | - } |
|
47 | + public function set($key, $value, $ttl = 0) { |
|
48 | + return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | + } |
|
50 | 50 | |
51 | - public function hasKey($key) { |
|
52 | - return apcu_exists($this->getPrefix() . $key); |
|
53 | - } |
|
51 | + public function hasKey($key) { |
|
52 | + return apcu_exists($this->getPrefix() . $key); |
|
53 | + } |
|
54 | 54 | |
55 | - public function remove($key) { |
|
56 | - return apcu_delete($this->getPrefix() . $key); |
|
57 | - } |
|
55 | + public function remove($key) { |
|
56 | + return apcu_delete($this->getPrefix() . $key); |
|
57 | + } |
|
58 | 58 | |
59 | - public function clear($prefix = '') { |
|
60 | - $ns = $this->getPrefix() . $prefix; |
|
61 | - $ns = preg_quote($ns, '/'); |
|
62 | - if(class_exists('\APCIterator')) { |
|
63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | - } else { |
|
65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | - } |
|
67 | - return apcu_delete($iter); |
|
68 | - } |
|
59 | + public function clear($prefix = '') { |
|
60 | + $ns = $this->getPrefix() . $prefix; |
|
61 | + $ns = preg_quote($ns, '/'); |
|
62 | + if(class_exists('\APCIterator')) { |
|
63 | + $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | + } else { |
|
65 | + $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | + } |
|
67 | + return apcu_delete($iter); |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * Set a value in the cache if it's not already stored |
|
72 | - * |
|
73 | - * @param string $key |
|
74 | - * @param mixed $value |
|
75 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | - * @return bool |
|
77 | - */ |
|
78 | - public function add($key, $value, $ttl = 0) { |
|
79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | - } |
|
70 | + /** |
|
71 | + * Set a value in the cache if it's not already stored |
|
72 | + * |
|
73 | + * @param string $key |
|
74 | + * @param mixed $value |
|
75 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | + * @return bool |
|
77 | + */ |
|
78 | + public function add($key, $value, $ttl = 0) { |
|
79 | + return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * Increase a stored number |
|
84 | - * |
|
85 | - * @param string $key |
|
86 | - * @param int $step |
|
87 | - * @return int | bool |
|
88 | - */ |
|
89 | - public function inc($key, $step = 1) { |
|
90 | - $this->add($key, 0); |
|
91 | - /** |
|
92 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | - * |
|
94 | - * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | - * "0" and result in "1" as value - therefore we check for existence |
|
96 | - * first |
|
97 | - * |
|
98 | - * on PHP 5.6 this is not the case |
|
99 | - * |
|
100 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | - * for details |
|
102 | - */ |
|
103 | - return apcu_exists($this->getPrefix() . $key) |
|
104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | - : false; |
|
106 | - } |
|
82 | + /** |
|
83 | + * Increase a stored number |
|
84 | + * |
|
85 | + * @param string $key |
|
86 | + * @param int $step |
|
87 | + * @return int | bool |
|
88 | + */ |
|
89 | + public function inc($key, $step = 1) { |
|
90 | + $this->add($key, 0); |
|
91 | + /** |
|
92 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | + * |
|
94 | + * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | + * "0" and result in "1" as value - therefore we check for existence |
|
96 | + * first |
|
97 | + * |
|
98 | + * on PHP 5.6 this is not the case |
|
99 | + * |
|
100 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | + * for details |
|
102 | + */ |
|
103 | + return apcu_exists($this->getPrefix() . $key) |
|
104 | + ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | + : false; |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Decrease a stored number |
|
110 | - * |
|
111 | - * @param string $key |
|
112 | - * @param int $step |
|
113 | - * @return int | bool |
|
114 | - */ |
|
115 | - public function dec($key, $step = 1) { |
|
116 | - /** |
|
117 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | - * |
|
119 | - * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | - * "0" and result in "-1" as value - therefore we check for existence |
|
121 | - * first |
|
122 | - * |
|
123 | - * on PHP 5.6 this is not the case |
|
124 | - * |
|
125 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | - * for details |
|
127 | - */ |
|
128 | - return apcu_exists($this->getPrefix() . $key) |
|
129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | - : false; |
|
131 | - } |
|
108 | + /** |
|
109 | + * Decrease a stored number |
|
110 | + * |
|
111 | + * @param string $key |
|
112 | + * @param int $step |
|
113 | + * @return int | bool |
|
114 | + */ |
|
115 | + public function dec($key, $step = 1) { |
|
116 | + /** |
|
117 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | + * |
|
119 | + * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | + * "0" and result in "-1" as value - therefore we check for existence |
|
121 | + * first |
|
122 | + * |
|
123 | + * on PHP 5.6 this is not the case |
|
124 | + * |
|
125 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | + * for details |
|
127 | + */ |
|
128 | + return apcu_exists($this->getPrefix() . $key) |
|
129 | + ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | + : false; |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * Compare and set |
|
135 | - * |
|
136 | - * @param string $key |
|
137 | - * @param mixed $old |
|
138 | - * @param mixed $new |
|
139 | - * @return bool |
|
140 | - */ |
|
141 | - public function cas($key, $old, $new) { |
|
142 | - // apc only does cas for ints |
|
143 | - if (is_int($old) and is_int($new)) { |
|
144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | - } else { |
|
146 | - return $this->casEmulated($key, $old, $new); |
|
147 | - } |
|
148 | - } |
|
133 | + /** |
|
134 | + * Compare and set |
|
135 | + * |
|
136 | + * @param string $key |
|
137 | + * @param mixed $old |
|
138 | + * @param mixed $new |
|
139 | + * @return bool |
|
140 | + */ |
|
141 | + public function cas($key, $old, $new) { |
|
142 | + // apc only does cas for ints |
|
143 | + if (is_int($old) and is_int($new)) { |
|
144 | + return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | + } else { |
|
146 | + return $this->casEmulated($key, $old, $new); |
|
147 | + } |
|
148 | + } |
|
149 | 149 | |
150 | - /** |
|
151 | - * @return bool |
|
152 | - */ |
|
153 | - static public function isAvailable() { |
|
154 | - if (!extension_loaded('apcu')) { |
|
155 | - return false; |
|
156 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | - return false; |
|
158 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | - return false; |
|
160 | - } elseif ( |
|
161 | - version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | - version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | - ) { |
|
164 | - return false; |
|
165 | - } else { |
|
166 | - return true; |
|
167 | - } |
|
168 | - } |
|
150 | + /** |
|
151 | + * @return bool |
|
152 | + */ |
|
153 | + static public function isAvailable() { |
|
154 | + if (!extension_loaded('apcu')) { |
|
155 | + return false; |
|
156 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | + return false; |
|
158 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | + return false; |
|
160 | + } elseif ( |
|
161 | + version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | + version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | + ) { |
|
164 | + return false; |
|
165 | + } else { |
|
166 | + return true; |
|
167 | + } |
|
168 | + } |
|
169 | 169 | } |
@@ -23,32 +23,32 @@ |
||
23 | 23 | namespace OC\Memcache; |
24 | 24 | |
25 | 25 | trait CADTrait { |
26 | - abstract public function get($key); |
|
26 | + abstract public function get($key); |
|
27 | 27 | |
28 | - abstract public function remove($key); |
|
28 | + abstract public function remove($key); |
|
29 | 29 | |
30 | - abstract public function add($key, $value, $ttl = 0); |
|
30 | + abstract public function add($key, $value, $ttl = 0); |
|
31 | 31 | |
32 | - /** |
|
33 | - * Compare and delete |
|
34 | - * |
|
35 | - * @param string $key |
|
36 | - * @param mixed $old |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function cad($key, $old) { |
|
40 | - //no native cas, emulate with locking |
|
41 | - if ($this->add($key . '_lock', true)) { |
|
42 | - if ($this->get($key) === $old) { |
|
43 | - $this->remove($key); |
|
44 | - $this->remove($key . '_lock'); |
|
45 | - return true; |
|
46 | - } else { |
|
47 | - $this->remove($key . '_lock'); |
|
48 | - return false; |
|
49 | - } |
|
50 | - } else { |
|
51 | - return false; |
|
52 | - } |
|
53 | - } |
|
32 | + /** |
|
33 | + * Compare and delete |
|
34 | + * |
|
35 | + * @param string $key |
|
36 | + * @param mixed $old |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function cad($key, $old) { |
|
40 | + //no native cas, emulate with locking |
|
41 | + if ($this->add($key . '_lock', true)) { |
|
42 | + if ($this->get($key) === $old) { |
|
43 | + $this->remove($key); |
|
44 | + $this->remove($key . '_lock'); |
|
45 | + return true; |
|
46 | + } else { |
|
47 | + $this->remove($key . '_lock'); |
|
48 | + return false; |
|
49 | + } |
|
50 | + } else { |
|
51 | + return false; |
|
52 | + } |
|
53 | + } |
|
54 | 54 | } |
@@ -27,133 +27,133 @@ |
||
27 | 27 | use OCP\IMemcache; |
28 | 28 | |
29 | 29 | class ArrayCache extends Cache implements IMemcache { |
30 | - /** @var array Array with the cached data */ |
|
31 | - protected $cachedData = array(); |
|
30 | + /** @var array Array with the cached data */ |
|
31 | + protected $cachedData = array(); |
|
32 | 32 | |
33 | - use CADTrait; |
|
33 | + use CADTrait; |
|
34 | 34 | |
35 | - /** |
|
36 | - * {@inheritDoc} |
|
37 | - */ |
|
38 | - public function get($key) { |
|
39 | - if ($this->hasKey($key)) { |
|
40 | - return $this->cachedData[$key]; |
|
41 | - } |
|
42 | - return null; |
|
43 | - } |
|
35 | + /** |
|
36 | + * {@inheritDoc} |
|
37 | + */ |
|
38 | + public function get($key) { |
|
39 | + if ($this->hasKey($key)) { |
|
40 | + return $this->cachedData[$key]; |
|
41 | + } |
|
42 | + return null; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * {@inheritDoc} |
|
47 | - */ |
|
48 | - public function set($key, $value, $ttl = 0) { |
|
49 | - $this->cachedData[$key] = $value; |
|
50 | - return true; |
|
51 | - } |
|
45 | + /** |
|
46 | + * {@inheritDoc} |
|
47 | + */ |
|
48 | + public function set($key, $value, $ttl = 0) { |
|
49 | + $this->cachedData[$key] = $value; |
|
50 | + return true; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * {@inheritDoc} |
|
55 | - */ |
|
56 | - public function hasKey($key) { |
|
57 | - return isset($this->cachedData[$key]); |
|
58 | - } |
|
53 | + /** |
|
54 | + * {@inheritDoc} |
|
55 | + */ |
|
56 | + public function hasKey($key) { |
|
57 | + return isset($this->cachedData[$key]); |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * {@inheritDoc} |
|
62 | - */ |
|
63 | - public function remove($key) { |
|
64 | - unset($this->cachedData[$key]); |
|
65 | - return true; |
|
66 | - } |
|
60 | + /** |
|
61 | + * {@inheritDoc} |
|
62 | + */ |
|
63 | + public function remove($key) { |
|
64 | + unset($this->cachedData[$key]); |
|
65 | + return true; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * {@inheritDoc} |
|
70 | - */ |
|
71 | - public function clear($prefix = '') { |
|
72 | - if ($prefix === '') { |
|
73 | - $this->cachedData = []; |
|
74 | - return true; |
|
75 | - } |
|
68 | + /** |
|
69 | + * {@inheritDoc} |
|
70 | + */ |
|
71 | + public function clear($prefix = '') { |
|
72 | + if ($prefix === '') { |
|
73 | + $this->cachedData = []; |
|
74 | + return true; |
|
75 | + } |
|
76 | 76 | |
77 | - foreach ($this->cachedData as $key => $value) { |
|
78 | - if (strpos($key, $prefix) === 0) { |
|
79 | - $this->remove($key); |
|
80 | - } |
|
81 | - } |
|
82 | - return true; |
|
83 | - } |
|
77 | + foreach ($this->cachedData as $key => $value) { |
|
78 | + if (strpos($key, $prefix) === 0) { |
|
79 | + $this->remove($key); |
|
80 | + } |
|
81 | + } |
|
82 | + return true; |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Set a value in the cache if it's not already stored |
|
87 | - * |
|
88 | - * @param string $key |
|
89 | - * @param mixed $value |
|
90 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | - * @return bool |
|
92 | - */ |
|
93 | - public function add($key, $value, $ttl = 0) { |
|
94 | - // since this cache is not shared race conditions aren't an issue |
|
95 | - if ($this->hasKey($key)) { |
|
96 | - return false; |
|
97 | - } else { |
|
98 | - return $this->set($key, $value, $ttl); |
|
99 | - } |
|
100 | - } |
|
85 | + /** |
|
86 | + * Set a value in the cache if it's not already stored |
|
87 | + * |
|
88 | + * @param string $key |
|
89 | + * @param mixed $value |
|
90 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | + * @return bool |
|
92 | + */ |
|
93 | + public function add($key, $value, $ttl = 0) { |
|
94 | + // since this cache is not shared race conditions aren't an issue |
|
95 | + if ($this->hasKey($key)) { |
|
96 | + return false; |
|
97 | + } else { |
|
98 | + return $this->set($key, $value, $ttl); |
|
99 | + } |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Increase a stored number |
|
104 | - * |
|
105 | - * @param string $key |
|
106 | - * @param int $step |
|
107 | - * @return int | bool |
|
108 | - */ |
|
109 | - public function inc($key, $step = 1) { |
|
110 | - $oldValue = $this->get($key); |
|
111 | - if (is_int($oldValue)) { |
|
112 | - $this->set($key, $oldValue + $step); |
|
113 | - return $oldValue + $step; |
|
114 | - } else { |
|
115 | - $success = $this->add($key, $step); |
|
116 | - return ($success) ? $step : false; |
|
117 | - } |
|
118 | - } |
|
102 | + /** |
|
103 | + * Increase a stored number |
|
104 | + * |
|
105 | + * @param string $key |
|
106 | + * @param int $step |
|
107 | + * @return int | bool |
|
108 | + */ |
|
109 | + public function inc($key, $step = 1) { |
|
110 | + $oldValue = $this->get($key); |
|
111 | + if (is_int($oldValue)) { |
|
112 | + $this->set($key, $oldValue + $step); |
|
113 | + return $oldValue + $step; |
|
114 | + } else { |
|
115 | + $success = $this->add($key, $step); |
|
116 | + return ($success) ? $step : false; |
|
117 | + } |
|
118 | + } |
|
119 | 119 | |
120 | - /** |
|
121 | - * Decrease a stored number |
|
122 | - * |
|
123 | - * @param string $key |
|
124 | - * @param int $step |
|
125 | - * @return int | bool |
|
126 | - */ |
|
127 | - public function dec($key, $step = 1) { |
|
128 | - $oldValue = $this->get($key); |
|
129 | - if (is_int($oldValue)) { |
|
130 | - $this->set($key, $oldValue - $step); |
|
131 | - return $oldValue - $step; |
|
132 | - } else { |
|
133 | - return false; |
|
134 | - } |
|
135 | - } |
|
120 | + /** |
|
121 | + * Decrease a stored number |
|
122 | + * |
|
123 | + * @param string $key |
|
124 | + * @param int $step |
|
125 | + * @return int | bool |
|
126 | + */ |
|
127 | + public function dec($key, $step = 1) { |
|
128 | + $oldValue = $this->get($key); |
|
129 | + if (is_int($oldValue)) { |
|
130 | + $this->set($key, $oldValue - $step); |
|
131 | + return $oldValue - $step; |
|
132 | + } else { |
|
133 | + return false; |
|
134 | + } |
|
135 | + } |
|
136 | 136 | |
137 | - /** |
|
138 | - * Compare and set |
|
139 | - * |
|
140 | - * @param string $key |
|
141 | - * @param mixed $old |
|
142 | - * @param mixed $new |
|
143 | - * @return bool |
|
144 | - */ |
|
145 | - public function cas($key, $old, $new) { |
|
146 | - if ($this->get($key) === $old) { |
|
147 | - return $this->set($key, $new); |
|
148 | - } else { |
|
149 | - return false; |
|
150 | - } |
|
151 | - } |
|
137 | + /** |
|
138 | + * Compare and set |
|
139 | + * |
|
140 | + * @param string $key |
|
141 | + * @param mixed $old |
|
142 | + * @param mixed $new |
|
143 | + * @return bool |
|
144 | + */ |
|
145 | + public function cas($key, $old, $new) { |
|
146 | + if ($this->get($key) === $old) { |
|
147 | + return $this->set($key, $new); |
|
148 | + } else { |
|
149 | + return false; |
|
150 | + } |
|
151 | + } |
|
152 | 152 | |
153 | - /** |
|
154 | - * {@inheritDoc} |
|
155 | - */ |
|
156 | - static public function isAvailable() { |
|
157 | - return true; |
|
158 | - } |
|
153 | + /** |
|
154 | + * {@inheritDoc} |
|
155 | + */ |
|
156 | + static public function isAvailable() { |
|
157 | + return true; |
|
158 | + } |
|
159 | 159 | } |
@@ -27,47 +27,47 @@ |
||
27 | 27 | namespace OC\Memcache; |
28 | 28 | |
29 | 29 | class NullCache extends Cache implements \OCP\IMemcache { |
30 | - public function get($key) { |
|
31 | - return null; |
|
32 | - } |
|
30 | + public function get($key) { |
|
31 | + return null; |
|
32 | + } |
|
33 | 33 | |
34 | - public function set($key, $value, $ttl = 0) { |
|
35 | - return true; |
|
36 | - } |
|
34 | + public function set($key, $value, $ttl = 0) { |
|
35 | + return true; |
|
36 | + } |
|
37 | 37 | |
38 | - public function hasKey($key) { |
|
39 | - return false; |
|
40 | - } |
|
38 | + public function hasKey($key) { |
|
39 | + return false; |
|
40 | + } |
|
41 | 41 | |
42 | - public function remove($key) { |
|
43 | - return true; |
|
44 | - } |
|
42 | + public function remove($key) { |
|
43 | + return true; |
|
44 | + } |
|
45 | 45 | |
46 | - public function add($key, $value, $ttl = 0) { |
|
47 | - return true; |
|
48 | - } |
|
46 | + public function add($key, $value, $ttl = 0) { |
|
47 | + return true; |
|
48 | + } |
|
49 | 49 | |
50 | - public function inc($key, $step = 1) { |
|
51 | - return true; |
|
52 | - } |
|
50 | + public function inc($key, $step = 1) { |
|
51 | + return true; |
|
52 | + } |
|
53 | 53 | |
54 | - public function dec($key, $step = 1) { |
|
55 | - return true; |
|
56 | - } |
|
54 | + public function dec($key, $step = 1) { |
|
55 | + return true; |
|
56 | + } |
|
57 | 57 | |
58 | - public function cas($key, $old, $new) { |
|
59 | - return true; |
|
60 | - } |
|
58 | + public function cas($key, $old, $new) { |
|
59 | + return true; |
|
60 | + } |
|
61 | 61 | |
62 | - public function cad($key, $old) { |
|
63 | - return true; |
|
64 | - } |
|
62 | + public function cad($key, $old) { |
|
63 | + return true; |
|
64 | + } |
|
65 | 65 | |
66 | - public function clear($prefix = '') { |
|
67 | - return true; |
|
68 | - } |
|
66 | + public function clear($prefix = '') { |
|
67 | + return true; |
|
68 | + } |
|
69 | 69 | |
70 | - static public function isAvailable() { |
|
71 | - return true; |
|
72 | - } |
|
70 | + static public function isAvailable() { |
|
71 | + return true; |
|
72 | + } |
|
73 | 73 | } |
@@ -32,129 +32,129 @@ |
||
32 | 32 | |
33 | 33 | class Result { |
34 | 34 | |
35 | - /** @var array */ |
|
36 | - protected $data; |
|
37 | - |
|
38 | - /** @var null|string */ |
|
39 | - protected $message; |
|
40 | - |
|
41 | - /** @var int */ |
|
42 | - protected $statusCode; |
|
43 | - |
|
44 | - /** @var integer */ |
|
45 | - protected $items; |
|
46 | - |
|
47 | - /** @var integer */ |
|
48 | - protected $perPage; |
|
49 | - |
|
50 | - /** @var array */ |
|
51 | - private $headers = []; |
|
52 | - |
|
53 | - /** |
|
54 | - * create the OCS_Result object |
|
55 | - * @param mixed $data the data to return |
|
56 | - * @param int $code |
|
57 | - * @param null|string $message |
|
58 | - * @param array $headers |
|
59 | - */ |
|
60 | - public function __construct($data = null, $code = 100, $message = null, $headers = []) { |
|
61 | - if ($data === null) { |
|
62 | - $this->data = array(); |
|
63 | - } elseif (!is_array($data)) { |
|
64 | - $this->data = array($this->data); |
|
65 | - } else { |
|
66 | - $this->data = $data; |
|
67 | - } |
|
68 | - $this->statusCode = $code; |
|
69 | - $this->message = $message; |
|
70 | - $this->headers = $headers; |
|
71 | - } |
|
72 | - |
|
73 | - /** |
|
74 | - * optionally set the total number of items available |
|
75 | - * @param int $items |
|
76 | - */ |
|
77 | - public function setTotalItems($items) { |
|
78 | - $this->items = $items; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * optionally set the the number of items per page |
|
83 | - * @param int $items |
|
84 | - */ |
|
85 | - public function setItemsPerPage($items) { |
|
86 | - $this->perPage = $items; |
|
87 | - } |
|
88 | - |
|
89 | - /** |
|
90 | - * get the status code |
|
91 | - * @return int |
|
92 | - */ |
|
93 | - public function getStatusCode() { |
|
94 | - return $this->statusCode; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * get the meta data for the result |
|
99 | - * @return array |
|
100 | - */ |
|
101 | - public function getMeta() { |
|
102 | - $meta = array(); |
|
103 | - $meta['status'] = $this->succeeded() ? 'ok' : 'failure'; |
|
104 | - $meta['statuscode'] = $this->statusCode; |
|
105 | - $meta['message'] = $this->message; |
|
106 | - if(isset($this->items)) { |
|
107 | - $meta['totalitems'] = $this->items; |
|
108 | - } |
|
109 | - if(isset($this->perPage)) { |
|
110 | - $meta['itemsperpage'] = $this->perPage; |
|
111 | - } |
|
112 | - return $meta; |
|
113 | - |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * get the result data |
|
118 | - * @return array |
|
119 | - */ |
|
120 | - public function getData() { |
|
121 | - return $this->data; |
|
122 | - } |
|
123 | - |
|
124 | - /** |
|
125 | - * return bool Whether the method succeeded |
|
126 | - * @return bool |
|
127 | - */ |
|
128 | - public function succeeded() { |
|
129 | - return ($this->statusCode == 100); |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Adds a new header to the response |
|
134 | - * @param string $name The name of the HTTP header |
|
135 | - * @param string $value The value, null will delete it |
|
136 | - * @return $this |
|
137 | - */ |
|
138 | - public function addHeader($name, $value) { |
|
139 | - $name = trim($name); // always remove leading and trailing whitespace |
|
140 | - // to be able to reliably check for security |
|
141 | - // headers |
|
142 | - |
|
143 | - if(is_null($value)) { |
|
144 | - unset($this->headers[$name]); |
|
145 | - } else { |
|
146 | - $this->headers[$name] = $value; |
|
147 | - } |
|
148 | - |
|
149 | - return $this; |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * Returns the set headers |
|
154 | - * @return array the headers |
|
155 | - */ |
|
156 | - public function getHeaders() { |
|
157 | - return $this->headers; |
|
158 | - } |
|
35 | + /** @var array */ |
|
36 | + protected $data; |
|
37 | + |
|
38 | + /** @var null|string */ |
|
39 | + protected $message; |
|
40 | + |
|
41 | + /** @var int */ |
|
42 | + protected $statusCode; |
|
43 | + |
|
44 | + /** @var integer */ |
|
45 | + protected $items; |
|
46 | + |
|
47 | + /** @var integer */ |
|
48 | + protected $perPage; |
|
49 | + |
|
50 | + /** @var array */ |
|
51 | + private $headers = []; |
|
52 | + |
|
53 | + /** |
|
54 | + * create the OCS_Result object |
|
55 | + * @param mixed $data the data to return |
|
56 | + * @param int $code |
|
57 | + * @param null|string $message |
|
58 | + * @param array $headers |
|
59 | + */ |
|
60 | + public function __construct($data = null, $code = 100, $message = null, $headers = []) { |
|
61 | + if ($data === null) { |
|
62 | + $this->data = array(); |
|
63 | + } elseif (!is_array($data)) { |
|
64 | + $this->data = array($this->data); |
|
65 | + } else { |
|
66 | + $this->data = $data; |
|
67 | + } |
|
68 | + $this->statusCode = $code; |
|
69 | + $this->message = $message; |
|
70 | + $this->headers = $headers; |
|
71 | + } |
|
72 | + |
|
73 | + /** |
|
74 | + * optionally set the total number of items available |
|
75 | + * @param int $items |
|
76 | + */ |
|
77 | + public function setTotalItems($items) { |
|
78 | + $this->items = $items; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * optionally set the the number of items per page |
|
83 | + * @param int $items |
|
84 | + */ |
|
85 | + public function setItemsPerPage($items) { |
|
86 | + $this->perPage = $items; |
|
87 | + } |
|
88 | + |
|
89 | + /** |
|
90 | + * get the status code |
|
91 | + * @return int |
|
92 | + */ |
|
93 | + public function getStatusCode() { |
|
94 | + return $this->statusCode; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * get the meta data for the result |
|
99 | + * @return array |
|
100 | + */ |
|
101 | + public function getMeta() { |
|
102 | + $meta = array(); |
|
103 | + $meta['status'] = $this->succeeded() ? 'ok' : 'failure'; |
|
104 | + $meta['statuscode'] = $this->statusCode; |
|
105 | + $meta['message'] = $this->message; |
|
106 | + if(isset($this->items)) { |
|
107 | + $meta['totalitems'] = $this->items; |
|
108 | + } |
|
109 | + if(isset($this->perPage)) { |
|
110 | + $meta['itemsperpage'] = $this->perPage; |
|
111 | + } |
|
112 | + return $meta; |
|
113 | + |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * get the result data |
|
118 | + * @return array |
|
119 | + */ |
|
120 | + public function getData() { |
|
121 | + return $this->data; |
|
122 | + } |
|
123 | + |
|
124 | + /** |
|
125 | + * return bool Whether the method succeeded |
|
126 | + * @return bool |
|
127 | + */ |
|
128 | + public function succeeded() { |
|
129 | + return ($this->statusCode == 100); |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Adds a new header to the response |
|
134 | + * @param string $name The name of the HTTP header |
|
135 | + * @param string $value The value, null will delete it |
|
136 | + * @return $this |
|
137 | + */ |
|
138 | + public function addHeader($name, $value) { |
|
139 | + $name = trim($name); // always remove leading and trailing whitespace |
|
140 | + // to be able to reliably check for security |
|
141 | + // headers |
|
142 | + |
|
143 | + if(is_null($value)) { |
|
144 | + unset($this->headers[$name]); |
|
145 | + } else { |
|
146 | + $this->headers[$name] = $value; |
|
147 | + } |
|
148 | + |
|
149 | + return $this; |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * Returns the set headers |
|
154 | + * @return array the headers |
|
155 | + */ |
|
156 | + public function getHeaders() { |
|
157 | + return $this->headers; |
|
158 | + } |
|
159 | 159 | |
160 | 160 | } |
@@ -33,27 +33,27 @@ |
||
33 | 33 | */ |
34 | 34 | class CoreCapabilities implements ICapability { |
35 | 35 | |
36 | - /** @var IConfig */ |
|
37 | - private $config; |
|
36 | + /** @var IConfig */ |
|
37 | + private $config; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param IConfig $config |
|
41 | - */ |
|
42 | - public function __construct(IConfig $config) { |
|
43 | - $this->config = $config; |
|
44 | - } |
|
39 | + /** |
|
40 | + * @param IConfig $config |
|
41 | + */ |
|
42 | + public function __construct(IConfig $config) { |
|
43 | + $this->config = $config; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Return this classes capabilities |
|
48 | - * |
|
49 | - * @return array |
|
50 | - */ |
|
51 | - public function getCapabilities() { |
|
52 | - return [ |
|
53 | - 'core' => [ |
|
54 | - 'pollinterval' => $this->config->getSystemValue('pollinterval', 60), |
|
55 | - 'webdav-root' => $this->config->getSystemValue('webdav-root', 'remote.php/webdav'), |
|
56 | - ] |
|
57 | - ]; |
|
58 | - } |
|
46 | + /** |
|
47 | + * Return this classes capabilities |
|
48 | + * |
|
49 | + * @return array |
|
50 | + */ |
|
51 | + public function getCapabilities() { |
|
52 | + return [ |
|
53 | + 'core' => [ |
|
54 | + 'pollinterval' => $this->config->getSystemValue('pollinterval', 60), |
|
55 | + 'webdav-root' => $this->config->getSystemValue('webdav-root', 'remote.php/webdav'), |
|
56 | + ] |
|
57 | + ]; |
|
58 | + } |
|
59 | 59 | } |