@@ -33,193 +33,193 @@ |
||
33 | 33 | use OCP\IMemcache; |
34 | 34 | |
35 | 35 | class Memcached extends Cache implements IMemcache { |
36 | - use CASTrait; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var \Memcached $cache |
|
40 | - */ |
|
41 | - private static $cache = null; |
|
42 | - |
|
43 | - use CADTrait; |
|
44 | - |
|
45 | - public function __construct($prefix = '') { |
|
46 | - parent::__construct($prefix); |
|
47 | - if (is_null(self::$cache)) { |
|
48 | - self::$cache = new \Memcached(); |
|
49 | - |
|
50 | - $defaultOptions = [ |
|
51 | - \Memcached::OPT_CONNECT_TIMEOUT => 50, |
|
52 | - \Memcached::OPT_RETRY_TIMEOUT => 50, |
|
53 | - \Memcached::OPT_SEND_TIMEOUT => 50, |
|
54 | - \Memcached::OPT_RECV_TIMEOUT => 50, |
|
55 | - \Memcached::OPT_POLL_TIMEOUT => 50, |
|
56 | - |
|
57 | - // Enable compression |
|
58 | - \Memcached::OPT_COMPRESSION => true, |
|
59 | - |
|
60 | - // Turn on consistent hashing |
|
61 | - \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, |
|
62 | - |
|
63 | - // Enable Binary Protocol |
|
64 | - //\Memcached::OPT_BINARY_PROTOCOL => true, |
|
65 | - ]; |
|
66 | - // by default enable igbinary serializer if available |
|
67 | - if (\Memcached::HAVE_IGBINARY) { |
|
68 | - $defaultOptions[\Memcached::OPT_SERIALIZER] = |
|
69 | - \Memcached::SERIALIZER_IGBINARY; |
|
70 | - } |
|
71 | - $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []); |
|
72 | - if (is_array($options)) { |
|
73 | - $options = $options + $defaultOptions; |
|
74 | - self::$cache->setOptions($options); |
|
75 | - } else { |
|
76 | - throw new HintException("Expected 'memcached_options' config to be an array, got $options"); |
|
77 | - } |
|
78 | - |
|
79 | - $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers'); |
|
80 | - if (!$servers) { |
|
81 | - $server = \OC::$server->getSystemConfig()->getValue('memcached_server'); |
|
82 | - if ($server) { |
|
83 | - $servers = [$server]; |
|
84 | - } else { |
|
85 | - $servers = [['localhost', 11211]]; |
|
86 | - } |
|
87 | - } |
|
88 | - self::$cache->addServers($servers); |
|
89 | - } |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * entries in XCache gets namespaced to prevent collisions between owncloud instances and users |
|
94 | - */ |
|
95 | - protected function getNameSpace() { |
|
96 | - return $this->prefix; |
|
97 | - } |
|
98 | - |
|
99 | - public function get($key) { |
|
100 | - $result = self::$cache->get($this->getNameSpace() . $key); |
|
101 | - if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) { |
|
102 | - return null; |
|
103 | - } else { |
|
104 | - return $result; |
|
105 | - } |
|
106 | - } |
|
107 | - |
|
108 | - public function set($key, $value, $ttl = 0) { |
|
109 | - if ($ttl > 0) { |
|
110 | - $result = self::$cache->set($this->getNameSpace() . $key, $value, $ttl); |
|
111 | - } else { |
|
112 | - $result = self::$cache->set($this->getNameSpace() . $key, $value); |
|
113 | - } |
|
114 | - if ($result !== true) { |
|
115 | - $this->verifyReturnCode(); |
|
116 | - } |
|
117 | - return $result; |
|
118 | - } |
|
119 | - |
|
120 | - public function hasKey($key) { |
|
121 | - self::$cache->get($this->getNameSpace() . $key); |
|
122 | - return self::$cache->getResultCode() === \Memcached::RES_SUCCESS; |
|
123 | - } |
|
124 | - |
|
125 | - public function remove($key) { |
|
126 | - $result= self::$cache->delete($this->getNameSpace() . $key); |
|
127 | - if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) { |
|
128 | - $this->verifyReturnCode(); |
|
129 | - } |
|
130 | - return $result; |
|
131 | - } |
|
132 | - |
|
133 | - public function clear($prefix = '') { |
|
134 | - $prefix = $this->getNameSpace() . $prefix; |
|
135 | - $allKeys = self::$cache->getAllKeys(); |
|
136 | - if ($allKeys === false) { |
|
137 | - // newer Memcached doesn't like getAllKeys(), flush everything |
|
138 | - self::$cache->flush(); |
|
139 | - return true; |
|
140 | - } |
|
141 | - $keys = array(); |
|
142 | - $prefixLength = strlen($prefix); |
|
143 | - foreach ($allKeys as $key) { |
|
144 | - if (substr($key, 0, $prefixLength) === $prefix) { |
|
145 | - $keys[] = $key; |
|
146 | - } |
|
147 | - } |
|
148 | - if (method_exists(self::$cache, 'deleteMulti')) { |
|
149 | - self::$cache->deleteMulti($keys); |
|
150 | - } else { |
|
151 | - foreach ($keys as $key) { |
|
152 | - self::$cache->delete($key); |
|
153 | - } |
|
154 | - } |
|
155 | - return true; |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * Set a value in the cache if it's not already stored |
|
160 | - * |
|
161 | - * @param string $key |
|
162 | - * @param mixed $value |
|
163 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
164 | - * @return bool |
|
165 | - * @throws \Exception |
|
166 | - */ |
|
167 | - public function add($key, $value, $ttl = 0) { |
|
168 | - $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl); |
|
169 | - if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) { |
|
170 | - $this->verifyReturnCode(); |
|
171 | - } |
|
172 | - return $result; |
|
173 | - } |
|
174 | - |
|
175 | - /** |
|
176 | - * Increase a stored number |
|
177 | - * |
|
178 | - * @param string $key |
|
179 | - * @param int $step |
|
180 | - * @return int | bool |
|
181 | - */ |
|
182 | - public function inc($key, $step = 1) { |
|
183 | - $this->add($key, 0); |
|
184 | - $result = self::$cache->increment($this->getPrefix() . $key, $step); |
|
185 | - |
|
186 | - if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) { |
|
187 | - return false; |
|
188 | - } |
|
189 | - |
|
190 | - return $result; |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * Decrease a stored number |
|
195 | - * |
|
196 | - * @param string $key |
|
197 | - * @param int $step |
|
198 | - * @return int | bool |
|
199 | - */ |
|
200 | - public function dec($key, $step = 1) { |
|
201 | - $result = self::$cache->decrement($this->getPrefix() . $key, $step); |
|
202 | - |
|
203 | - if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) { |
|
204 | - return false; |
|
205 | - } |
|
206 | - |
|
207 | - return $result; |
|
208 | - } |
|
209 | - |
|
210 | - static public function isAvailable() { |
|
211 | - return extension_loaded('memcached'); |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * @throws \Exception |
|
216 | - */ |
|
217 | - private function verifyReturnCode() { |
|
218 | - $code = self::$cache->getResultCode(); |
|
219 | - if ($code === \Memcached::RES_SUCCESS) { |
|
220 | - return; |
|
221 | - } |
|
222 | - $message = self::$cache->getResultMessage(); |
|
223 | - throw new \Exception("Error $code interacting with memcached : $message"); |
|
224 | - } |
|
36 | + use CASTrait; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var \Memcached $cache |
|
40 | + */ |
|
41 | + private static $cache = null; |
|
42 | + |
|
43 | + use CADTrait; |
|
44 | + |
|
45 | + public function __construct($prefix = '') { |
|
46 | + parent::__construct($prefix); |
|
47 | + if (is_null(self::$cache)) { |
|
48 | + self::$cache = new \Memcached(); |
|
49 | + |
|
50 | + $defaultOptions = [ |
|
51 | + \Memcached::OPT_CONNECT_TIMEOUT => 50, |
|
52 | + \Memcached::OPT_RETRY_TIMEOUT => 50, |
|
53 | + \Memcached::OPT_SEND_TIMEOUT => 50, |
|
54 | + \Memcached::OPT_RECV_TIMEOUT => 50, |
|
55 | + \Memcached::OPT_POLL_TIMEOUT => 50, |
|
56 | + |
|
57 | + // Enable compression |
|
58 | + \Memcached::OPT_COMPRESSION => true, |
|
59 | + |
|
60 | + // Turn on consistent hashing |
|
61 | + \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, |
|
62 | + |
|
63 | + // Enable Binary Protocol |
|
64 | + //\Memcached::OPT_BINARY_PROTOCOL => true, |
|
65 | + ]; |
|
66 | + // by default enable igbinary serializer if available |
|
67 | + if (\Memcached::HAVE_IGBINARY) { |
|
68 | + $defaultOptions[\Memcached::OPT_SERIALIZER] = |
|
69 | + \Memcached::SERIALIZER_IGBINARY; |
|
70 | + } |
|
71 | + $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []); |
|
72 | + if (is_array($options)) { |
|
73 | + $options = $options + $defaultOptions; |
|
74 | + self::$cache->setOptions($options); |
|
75 | + } else { |
|
76 | + throw new HintException("Expected 'memcached_options' config to be an array, got $options"); |
|
77 | + } |
|
78 | + |
|
79 | + $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers'); |
|
80 | + if (!$servers) { |
|
81 | + $server = \OC::$server->getSystemConfig()->getValue('memcached_server'); |
|
82 | + if ($server) { |
|
83 | + $servers = [$server]; |
|
84 | + } else { |
|
85 | + $servers = [['localhost', 11211]]; |
|
86 | + } |
|
87 | + } |
|
88 | + self::$cache->addServers($servers); |
|
89 | + } |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * entries in XCache gets namespaced to prevent collisions between owncloud instances and users |
|
94 | + */ |
|
95 | + protected function getNameSpace() { |
|
96 | + return $this->prefix; |
|
97 | + } |
|
98 | + |
|
99 | + public function get($key) { |
|
100 | + $result = self::$cache->get($this->getNameSpace() . $key); |
|
101 | + if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) { |
|
102 | + return null; |
|
103 | + } else { |
|
104 | + return $result; |
|
105 | + } |
|
106 | + } |
|
107 | + |
|
108 | + public function set($key, $value, $ttl = 0) { |
|
109 | + if ($ttl > 0) { |
|
110 | + $result = self::$cache->set($this->getNameSpace() . $key, $value, $ttl); |
|
111 | + } else { |
|
112 | + $result = self::$cache->set($this->getNameSpace() . $key, $value); |
|
113 | + } |
|
114 | + if ($result !== true) { |
|
115 | + $this->verifyReturnCode(); |
|
116 | + } |
|
117 | + return $result; |
|
118 | + } |
|
119 | + |
|
120 | + public function hasKey($key) { |
|
121 | + self::$cache->get($this->getNameSpace() . $key); |
|
122 | + return self::$cache->getResultCode() === \Memcached::RES_SUCCESS; |
|
123 | + } |
|
124 | + |
|
125 | + public function remove($key) { |
|
126 | + $result= self::$cache->delete($this->getNameSpace() . $key); |
|
127 | + if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) { |
|
128 | + $this->verifyReturnCode(); |
|
129 | + } |
|
130 | + return $result; |
|
131 | + } |
|
132 | + |
|
133 | + public function clear($prefix = '') { |
|
134 | + $prefix = $this->getNameSpace() . $prefix; |
|
135 | + $allKeys = self::$cache->getAllKeys(); |
|
136 | + if ($allKeys === false) { |
|
137 | + // newer Memcached doesn't like getAllKeys(), flush everything |
|
138 | + self::$cache->flush(); |
|
139 | + return true; |
|
140 | + } |
|
141 | + $keys = array(); |
|
142 | + $prefixLength = strlen($prefix); |
|
143 | + foreach ($allKeys as $key) { |
|
144 | + if (substr($key, 0, $prefixLength) === $prefix) { |
|
145 | + $keys[] = $key; |
|
146 | + } |
|
147 | + } |
|
148 | + if (method_exists(self::$cache, 'deleteMulti')) { |
|
149 | + self::$cache->deleteMulti($keys); |
|
150 | + } else { |
|
151 | + foreach ($keys as $key) { |
|
152 | + self::$cache->delete($key); |
|
153 | + } |
|
154 | + } |
|
155 | + return true; |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * Set a value in the cache if it's not already stored |
|
160 | + * |
|
161 | + * @param string $key |
|
162 | + * @param mixed $value |
|
163 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
164 | + * @return bool |
|
165 | + * @throws \Exception |
|
166 | + */ |
|
167 | + public function add($key, $value, $ttl = 0) { |
|
168 | + $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl); |
|
169 | + if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) { |
|
170 | + $this->verifyReturnCode(); |
|
171 | + } |
|
172 | + return $result; |
|
173 | + } |
|
174 | + |
|
175 | + /** |
|
176 | + * Increase a stored number |
|
177 | + * |
|
178 | + * @param string $key |
|
179 | + * @param int $step |
|
180 | + * @return int | bool |
|
181 | + */ |
|
182 | + public function inc($key, $step = 1) { |
|
183 | + $this->add($key, 0); |
|
184 | + $result = self::$cache->increment($this->getPrefix() . $key, $step); |
|
185 | + |
|
186 | + if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) { |
|
187 | + return false; |
|
188 | + } |
|
189 | + |
|
190 | + return $result; |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * Decrease a stored number |
|
195 | + * |
|
196 | + * @param string $key |
|
197 | + * @param int $step |
|
198 | + * @return int | bool |
|
199 | + */ |
|
200 | + public function dec($key, $step = 1) { |
|
201 | + $result = self::$cache->decrement($this->getPrefix() . $key, $step); |
|
202 | + |
|
203 | + if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) { |
|
204 | + return false; |
|
205 | + } |
|
206 | + |
|
207 | + return $result; |
|
208 | + } |
|
209 | + |
|
210 | + static public function isAvailable() { |
|
211 | + return extension_loaded('memcached'); |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * @throws \Exception |
|
216 | + */ |
|
217 | + private function verifyReturnCode() { |
|
218 | + $code = self::$cache->getResultCode(); |
|
219 | + if ($code === \Memcached::RES_SUCCESS) { |
|
220 | + return; |
|
221 | + } |
|
222 | + $message = self::$cache->getResultMessage(); |
|
223 | + throw new \Exception("Error $code interacting with memcached : $message"); |
|
224 | + } |
|
225 | 225 | } |
@@ -37,172 +37,172 @@ |
||
37 | 37 | */ |
38 | 38 | class CleanTags implements IRepairStep { |
39 | 39 | |
40 | - /** @var IDBConnection */ |
|
41 | - protected $connection; |
|
42 | - |
|
43 | - /** @var IUserManager */ |
|
44 | - protected $userManager; |
|
45 | - |
|
46 | - protected $deletedTags = 0; |
|
47 | - |
|
48 | - /** |
|
49 | - * @param IDBConnection $connection |
|
50 | - * @param IUserManager $userManager |
|
51 | - */ |
|
52 | - public function __construct(IDBConnection $connection, IUserManager $userManager) { |
|
53 | - $this->connection = $connection; |
|
54 | - $this->userManager = $userManager; |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * @return string |
|
59 | - */ |
|
60 | - public function getName() { |
|
61 | - return 'Clean tags and favorites'; |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * Updates the configuration after running an update |
|
66 | - */ |
|
67 | - public function run(IOutput $output) { |
|
68 | - $this->deleteOrphanTags($output); |
|
69 | - $this->deleteOrphanFileEntries($output); |
|
70 | - $this->deleteOrphanTagEntries($output); |
|
71 | - $this->deleteOrphanCategoryEntries($output); |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * Delete tags for deleted users |
|
76 | - */ |
|
77 | - protected function deleteOrphanTags(IOutput $output) { |
|
78 | - $offset = 0; |
|
79 | - while ($this->checkTags($offset)) { |
|
80 | - $offset += 50; |
|
81 | - } |
|
82 | - |
|
83 | - $output->info(sprintf('%d tags of deleted users have been removed.', $this->deletedTags)); |
|
84 | - } |
|
85 | - |
|
86 | - protected function checkTags($offset) { |
|
87 | - $query = $this->connection->getQueryBuilder(); |
|
88 | - $query->select('uid') |
|
89 | - ->from('vcategory') |
|
90 | - ->groupBy('uid') |
|
91 | - ->orderBy('uid') |
|
92 | - ->setMaxResults(50) |
|
93 | - ->setFirstResult($offset); |
|
94 | - $result = $query->execute(); |
|
95 | - |
|
96 | - $users = []; |
|
97 | - $hadResults = false; |
|
98 | - while ($row = $result->fetch()) { |
|
99 | - $hadResults = true; |
|
100 | - if (!$this->userManager->userExists($row['uid'])) { |
|
101 | - $users[] = $row['uid']; |
|
102 | - } |
|
103 | - } |
|
104 | - $result->closeCursor(); |
|
105 | - |
|
106 | - if (!$hadResults) { |
|
107 | - // No more tags, stop looping |
|
108 | - return false; |
|
109 | - } |
|
110 | - |
|
111 | - if (!empty($users)) { |
|
112 | - $query = $this->connection->getQueryBuilder(); |
|
113 | - $query->delete('vcategory') |
|
114 | - ->where($query->expr()->in('uid', $query->createNamedParameter($users, IQueryBuilder::PARAM_STR_ARRAY))); |
|
115 | - $this->deletedTags += $query->execute(); |
|
116 | - } |
|
117 | - return true; |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * Delete tag entries for deleted files |
|
122 | - */ |
|
123 | - protected function deleteOrphanFileEntries(IOutput $output) { |
|
124 | - $this->deleteOrphanEntries( |
|
125 | - $output, |
|
126 | - '%d tags for delete files have been removed.', |
|
127 | - 'vcategory_to_object', 'objid', |
|
128 | - 'filecache', 'fileid', 'path_hash' |
|
129 | - ); |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Delete tag entries for deleted tags |
|
134 | - */ |
|
135 | - protected function deleteOrphanTagEntries(IOutput $output) { |
|
136 | - $this->deleteOrphanEntries( |
|
137 | - $output, |
|
138 | - '%d tag entries for deleted tags have been removed.', |
|
139 | - 'vcategory_to_object', 'categoryid', |
|
140 | - 'vcategory', 'id', 'uid' |
|
141 | - ); |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Delete tags that have no entries |
|
146 | - */ |
|
147 | - protected function deleteOrphanCategoryEntries(IOutput $output) { |
|
148 | - $this->deleteOrphanEntries( |
|
149 | - $output, |
|
150 | - '%d tags with no entries have been removed.', |
|
151 | - 'vcategory', 'id', |
|
152 | - 'vcategory_to_object', 'categoryid', 'type' |
|
153 | - ); |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Deletes all entries from $deleteTable that do not have a matching entry in $sourceTable |
|
158 | - * |
|
159 | - * A query joins $deleteTable.$deleteId = $sourceTable.$sourceId and checks |
|
160 | - * whether $sourceNullColumn is null. If it is null, the entry in $deleteTable |
|
161 | - * is being deleted. |
|
162 | - * |
|
163 | - * @param string $repairInfo |
|
164 | - * @param string $deleteTable |
|
165 | - * @param string $deleteId |
|
166 | - * @param string $sourceTable |
|
167 | - * @param string $sourceId |
|
168 | - * @param string $sourceNullColumn If this column is null in the source table, |
|
169 | - * the entry is deleted in the $deleteTable |
|
170 | - * @suppress SqlInjectionChecker |
|
171 | - */ |
|
172 | - protected function deleteOrphanEntries(IOutput $output, $repairInfo, $deleteTable, $deleteId, $sourceTable, $sourceId, $sourceNullColumn) { |
|
173 | - $qb = $this->connection->getQueryBuilder(); |
|
174 | - |
|
175 | - $qb->select('d.' . $deleteId) |
|
176 | - ->from($deleteTable, 'd') |
|
177 | - ->leftJoin('d', $sourceTable, 's', $qb->expr()->eq('d.' . $deleteId, 's.' . $sourceId)) |
|
178 | - ->where( |
|
179 | - $qb->expr()->eq('d.type', $qb->expr()->literal('files')) |
|
180 | - ) |
|
181 | - ->andWhere( |
|
182 | - $qb->expr()->isNull('s.' . $sourceNullColumn) |
|
183 | - ); |
|
184 | - $result = $qb->execute(); |
|
185 | - |
|
186 | - $orphanItems = array(); |
|
187 | - while ($row = $result->fetch()) { |
|
188 | - $orphanItems[] = (int) $row[$deleteId]; |
|
189 | - } |
|
190 | - |
|
191 | - if (!empty($orphanItems)) { |
|
192 | - $orphanItemsBatch = array_chunk($orphanItems, 200); |
|
193 | - foreach ($orphanItemsBatch as $items) { |
|
194 | - $qb->delete($deleteTable) |
|
195 | - ->where( |
|
196 | - $qb->expr()->eq('type', $qb->expr()->literal('files')) |
|
197 | - ) |
|
198 | - ->andWhere($qb->expr()->in($deleteId, $qb->createParameter('ids'))); |
|
199 | - $qb->setParameter('ids', $items, IQueryBuilder::PARAM_INT_ARRAY); |
|
200 | - $qb->execute(); |
|
201 | - } |
|
202 | - } |
|
203 | - |
|
204 | - if ($repairInfo) { |
|
205 | - $output->info(sprintf($repairInfo, count($orphanItems))); |
|
206 | - } |
|
207 | - } |
|
40 | + /** @var IDBConnection */ |
|
41 | + protected $connection; |
|
42 | + |
|
43 | + /** @var IUserManager */ |
|
44 | + protected $userManager; |
|
45 | + |
|
46 | + protected $deletedTags = 0; |
|
47 | + |
|
48 | + /** |
|
49 | + * @param IDBConnection $connection |
|
50 | + * @param IUserManager $userManager |
|
51 | + */ |
|
52 | + public function __construct(IDBConnection $connection, IUserManager $userManager) { |
|
53 | + $this->connection = $connection; |
|
54 | + $this->userManager = $userManager; |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * @return string |
|
59 | + */ |
|
60 | + public function getName() { |
|
61 | + return 'Clean tags and favorites'; |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * Updates the configuration after running an update |
|
66 | + */ |
|
67 | + public function run(IOutput $output) { |
|
68 | + $this->deleteOrphanTags($output); |
|
69 | + $this->deleteOrphanFileEntries($output); |
|
70 | + $this->deleteOrphanTagEntries($output); |
|
71 | + $this->deleteOrphanCategoryEntries($output); |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * Delete tags for deleted users |
|
76 | + */ |
|
77 | + protected function deleteOrphanTags(IOutput $output) { |
|
78 | + $offset = 0; |
|
79 | + while ($this->checkTags($offset)) { |
|
80 | + $offset += 50; |
|
81 | + } |
|
82 | + |
|
83 | + $output->info(sprintf('%d tags of deleted users have been removed.', $this->deletedTags)); |
|
84 | + } |
|
85 | + |
|
86 | + protected function checkTags($offset) { |
|
87 | + $query = $this->connection->getQueryBuilder(); |
|
88 | + $query->select('uid') |
|
89 | + ->from('vcategory') |
|
90 | + ->groupBy('uid') |
|
91 | + ->orderBy('uid') |
|
92 | + ->setMaxResults(50) |
|
93 | + ->setFirstResult($offset); |
|
94 | + $result = $query->execute(); |
|
95 | + |
|
96 | + $users = []; |
|
97 | + $hadResults = false; |
|
98 | + while ($row = $result->fetch()) { |
|
99 | + $hadResults = true; |
|
100 | + if (!$this->userManager->userExists($row['uid'])) { |
|
101 | + $users[] = $row['uid']; |
|
102 | + } |
|
103 | + } |
|
104 | + $result->closeCursor(); |
|
105 | + |
|
106 | + if (!$hadResults) { |
|
107 | + // No more tags, stop looping |
|
108 | + return false; |
|
109 | + } |
|
110 | + |
|
111 | + if (!empty($users)) { |
|
112 | + $query = $this->connection->getQueryBuilder(); |
|
113 | + $query->delete('vcategory') |
|
114 | + ->where($query->expr()->in('uid', $query->createNamedParameter($users, IQueryBuilder::PARAM_STR_ARRAY))); |
|
115 | + $this->deletedTags += $query->execute(); |
|
116 | + } |
|
117 | + return true; |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * Delete tag entries for deleted files |
|
122 | + */ |
|
123 | + protected function deleteOrphanFileEntries(IOutput $output) { |
|
124 | + $this->deleteOrphanEntries( |
|
125 | + $output, |
|
126 | + '%d tags for delete files have been removed.', |
|
127 | + 'vcategory_to_object', 'objid', |
|
128 | + 'filecache', 'fileid', 'path_hash' |
|
129 | + ); |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Delete tag entries for deleted tags |
|
134 | + */ |
|
135 | + protected function deleteOrphanTagEntries(IOutput $output) { |
|
136 | + $this->deleteOrphanEntries( |
|
137 | + $output, |
|
138 | + '%d tag entries for deleted tags have been removed.', |
|
139 | + 'vcategory_to_object', 'categoryid', |
|
140 | + 'vcategory', 'id', 'uid' |
|
141 | + ); |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Delete tags that have no entries |
|
146 | + */ |
|
147 | + protected function deleteOrphanCategoryEntries(IOutput $output) { |
|
148 | + $this->deleteOrphanEntries( |
|
149 | + $output, |
|
150 | + '%d tags with no entries have been removed.', |
|
151 | + 'vcategory', 'id', |
|
152 | + 'vcategory_to_object', 'categoryid', 'type' |
|
153 | + ); |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Deletes all entries from $deleteTable that do not have a matching entry in $sourceTable |
|
158 | + * |
|
159 | + * A query joins $deleteTable.$deleteId = $sourceTable.$sourceId and checks |
|
160 | + * whether $sourceNullColumn is null. If it is null, the entry in $deleteTable |
|
161 | + * is being deleted. |
|
162 | + * |
|
163 | + * @param string $repairInfo |
|
164 | + * @param string $deleteTable |
|
165 | + * @param string $deleteId |
|
166 | + * @param string $sourceTable |
|
167 | + * @param string $sourceId |
|
168 | + * @param string $sourceNullColumn If this column is null in the source table, |
|
169 | + * the entry is deleted in the $deleteTable |
|
170 | + * @suppress SqlInjectionChecker |
|
171 | + */ |
|
172 | + protected function deleteOrphanEntries(IOutput $output, $repairInfo, $deleteTable, $deleteId, $sourceTable, $sourceId, $sourceNullColumn) { |
|
173 | + $qb = $this->connection->getQueryBuilder(); |
|
174 | + |
|
175 | + $qb->select('d.' . $deleteId) |
|
176 | + ->from($deleteTable, 'd') |
|
177 | + ->leftJoin('d', $sourceTable, 's', $qb->expr()->eq('d.' . $deleteId, 's.' . $sourceId)) |
|
178 | + ->where( |
|
179 | + $qb->expr()->eq('d.type', $qb->expr()->literal('files')) |
|
180 | + ) |
|
181 | + ->andWhere( |
|
182 | + $qb->expr()->isNull('s.' . $sourceNullColumn) |
|
183 | + ); |
|
184 | + $result = $qb->execute(); |
|
185 | + |
|
186 | + $orphanItems = array(); |
|
187 | + while ($row = $result->fetch()) { |
|
188 | + $orphanItems[] = (int) $row[$deleteId]; |
|
189 | + } |
|
190 | + |
|
191 | + if (!empty($orphanItems)) { |
|
192 | + $orphanItemsBatch = array_chunk($orphanItems, 200); |
|
193 | + foreach ($orphanItemsBatch as $items) { |
|
194 | + $qb->delete($deleteTable) |
|
195 | + ->where( |
|
196 | + $qb->expr()->eq('type', $qb->expr()->literal('files')) |
|
197 | + ) |
|
198 | + ->andWhere($qb->expr()->in($deleteId, $qb->createParameter('ids'))); |
|
199 | + $qb->setParameter('ids', $items, IQueryBuilder::PARAM_INT_ARRAY); |
|
200 | + $qb->execute(); |
|
201 | + } |
|
202 | + } |
|
203 | + |
|
204 | + if ($repairInfo) { |
|
205 | + $output->info(sprintf($repairInfo, count($orphanItems))); |
|
206 | + } |
|
207 | + } |
|
208 | 208 | } |
@@ -29,179 +29,179 @@ |
||
29 | 29 | |
30 | 30 | class MigrationSchemaChecker extends NodeVisitorAbstract { |
31 | 31 | |
32 | - /** @var string */ |
|
33 | - protected $schemaVariableName = null; |
|
34 | - /** @var array */ |
|
35 | - protected $tableVariableNames = []; |
|
36 | - /** @var array */ |
|
37 | - public $errors = []; |
|
32 | + /** @var string */ |
|
33 | + protected $schemaVariableName = null; |
|
34 | + /** @var array */ |
|
35 | + protected $tableVariableNames = []; |
|
36 | + /** @var array */ |
|
37 | + public $errors = []; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param Node $node |
|
41 | - * @return void |
|
42 | - * |
|
43 | - * @suppress PhanUndeclaredProperty |
|
44 | - */ |
|
45 | - public function enterNode(Node $node) { |
|
46 | - /** |
|
47 | - * Check tables |
|
48 | - */ |
|
49 | - if ($this->schemaVariableName !== null && |
|
50 | - $node instanceof Node\Expr\Assign && |
|
51 | - $node->var instanceof Node\Expr\Variable && |
|
52 | - $node->expr instanceof Node\Expr\MethodCall && |
|
53 | - $node->expr->var instanceof Node\Expr\Variable && |
|
54 | - $node->expr->var->name === $this->schemaVariableName) { |
|
39 | + /** |
|
40 | + * @param Node $node |
|
41 | + * @return void |
|
42 | + * |
|
43 | + * @suppress PhanUndeclaredProperty |
|
44 | + */ |
|
45 | + public function enterNode(Node $node) { |
|
46 | + /** |
|
47 | + * Check tables |
|
48 | + */ |
|
49 | + if ($this->schemaVariableName !== null && |
|
50 | + $node instanceof Node\Expr\Assign && |
|
51 | + $node->var instanceof Node\Expr\Variable && |
|
52 | + $node->expr instanceof Node\Expr\MethodCall && |
|
53 | + $node->expr->var instanceof Node\Expr\Variable && |
|
54 | + $node->expr->var->name === $this->schemaVariableName) { |
|
55 | 55 | |
56 | - if ($node->expr->name === 'createTable') { |
|
57 | - if (isset($node->expr->args[0]) && $node->expr->args[0]->value instanceof Node\Scalar\String_) { |
|
58 | - if (!$this->checkNameLength($node->expr->args[0]->value->value)) { |
|
59 | - $this->errors[] = [ |
|
60 | - 'line' => $node->getLine(), |
|
61 | - 'disallowedToken' => $node->expr->args[0]->value->value, |
|
62 | - 'reason' => 'Table name is too long (max. 27)', |
|
63 | - ]; |
|
64 | - } else { |
|
65 | - $this->tableVariableNames[$node->var->name] = $node->expr->args[0]->value->value; |
|
66 | - } |
|
67 | - } |
|
68 | - } else if ($node->expr->name === 'getTable') { |
|
69 | - if (isset($node->expr->args[0]) && $node->expr->args[0]->value instanceof Node\Scalar\String_) { |
|
70 | - $this->tableVariableNames[$node->var->name] = $node->expr->args[0]->value->value; |
|
71 | - } |
|
72 | - } |
|
73 | - } else if ($this->schemaVariableName !== null && |
|
74 | - $node instanceof Node\Expr\MethodCall && |
|
75 | - $node->var instanceof Node\Expr\Variable && |
|
76 | - $node->var->name === $this->schemaVariableName) { |
|
56 | + if ($node->expr->name === 'createTable') { |
|
57 | + if (isset($node->expr->args[0]) && $node->expr->args[0]->value instanceof Node\Scalar\String_) { |
|
58 | + if (!$this->checkNameLength($node->expr->args[0]->value->value)) { |
|
59 | + $this->errors[] = [ |
|
60 | + 'line' => $node->getLine(), |
|
61 | + 'disallowedToken' => $node->expr->args[0]->value->value, |
|
62 | + 'reason' => 'Table name is too long (max. 27)', |
|
63 | + ]; |
|
64 | + } else { |
|
65 | + $this->tableVariableNames[$node->var->name] = $node->expr->args[0]->value->value; |
|
66 | + } |
|
67 | + } |
|
68 | + } else if ($node->expr->name === 'getTable') { |
|
69 | + if (isset($node->expr->args[0]) && $node->expr->args[0]->value instanceof Node\Scalar\String_) { |
|
70 | + $this->tableVariableNames[$node->var->name] = $node->expr->args[0]->value->value; |
|
71 | + } |
|
72 | + } |
|
73 | + } else if ($this->schemaVariableName !== null && |
|
74 | + $node instanceof Node\Expr\MethodCall && |
|
75 | + $node->var instanceof Node\Expr\Variable && |
|
76 | + $node->var->name === $this->schemaVariableName) { |
|
77 | 77 | |
78 | - if ($node->name === 'renameTable') { |
|
79 | - $this->errors[] = [ |
|
80 | - 'line' => $node->getLine(), |
|
81 | - 'disallowedToken' => 'Deprecated method', |
|
82 | - 'reason' => sprintf( |
|
83 | - '`$%s->renameTable()` must not be used', |
|
84 | - $node->var->name |
|
85 | - ), |
|
86 | - ]; |
|
87 | - } |
|
78 | + if ($node->name === 'renameTable') { |
|
79 | + $this->errors[] = [ |
|
80 | + 'line' => $node->getLine(), |
|
81 | + 'disallowedToken' => 'Deprecated method', |
|
82 | + 'reason' => sprintf( |
|
83 | + '`$%s->renameTable()` must not be used', |
|
84 | + $node->var->name |
|
85 | + ), |
|
86 | + ]; |
|
87 | + } |
|
88 | 88 | |
89 | - /** |
|
90 | - * Check columns and Indexes |
|
91 | - */ |
|
92 | - } else if (!empty($this->tableVariableNames) && |
|
93 | - $node instanceof Node\Expr\MethodCall && |
|
94 | - $node->var instanceof Node\Expr\Variable && |
|
95 | - isset($this->tableVariableNames[$node->var->name])) { |
|
89 | + /** |
|
90 | + * Check columns and Indexes |
|
91 | + */ |
|
92 | + } else if (!empty($this->tableVariableNames) && |
|
93 | + $node instanceof Node\Expr\MethodCall && |
|
94 | + $node->var instanceof Node\Expr\Variable && |
|
95 | + isset($this->tableVariableNames[$node->var->name])) { |
|
96 | 96 | |
97 | - if ($node->name === 'addColumn' || $node->name === 'changeColumn') { |
|
98 | - if (isset($node->args[0]) && $node->args[0]->value instanceof Node\Scalar\String_) { |
|
99 | - if (!$this->checkNameLength($node->args[0]->value->value)) { |
|
100 | - $this->errors[] = [ |
|
101 | - 'line' => $node->getLine(), |
|
102 | - 'disallowedToken' => $node->args[0]->value->value, |
|
103 | - 'reason' => sprintf( |
|
104 | - 'Column name is too long on table `%s` (max. 27)', |
|
105 | - $this->tableVariableNames[$node->var->name] |
|
106 | - ), |
|
107 | - ]; |
|
108 | - } |
|
97 | + if ($node->name === 'addColumn' || $node->name === 'changeColumn') { |
|
98 | + if (isset($node->args[0]) && $node->args[0]->value instanceof Node\Scalar\String_) { |
|
99 | + if (!$this->checkNameLength($node->args[0]->value->value)) { |
|
100 | + $this->errors[] = [ |
|
101 | + 'line' => $node->getLine(), |
|
102 | + 'disallowedToken' => $node->args[0]->value->value, |
|
103 | + 'reason' => sprintf( |
|
104 | + 'Column name is too long on table `%s` (max. 27)', |
|
105 | + $this->tableVariableNames[$node->var->name] |
|
106 | + ), |
|
107 | + ]; |
|
108 | + } |
|
109 | 109 | |
110 | - // On autoincrement the max length of the table name is 21 instead of 27 |
|
111 | - if (isset($node->args[2]) && $node->args[2]->value instanceof Node\Expr\Array_) { |
|
112 | - /** @var Node\Expr\Array_ $options */ |
|
113 | - $options = $node->args[2]->value; |
|
114 | - if ($this->checkColumnForAutoincrement($options)) { |
|
115 | - if (!$this->checkNameLength($this->tableVariableNames[$node->var->name], true)) { |
|
116 | - $this->errors[] = [ |
|
117 | - 'line' => $node->getLine(), |
|
118 | - 'disallowedToken' => $this->tableVariableNames[$node->var->name], |
|
119 | - 'reason' => 'Table name is too long because of autoincrement (max. 21)', |
|
120 | - ]; |
|
121 | - } |
|
122 | - } |
|
123 | - } |
|
124 | - } |
|
125 | - } else if ($node->name === 'addIndex' || |
|
126 | - $node->name === 'addUniqueIndex' || |
|
127 | - $node->name === 'renameIndex' || |
|
128 | - $node->name === 'setPrimaryKey') { |
|
129 | - if (isset($node->args[1]) && $node->args[1]->value instanceof Node\Scalar\String_) { |
|
130 | - if (!$this->checkNameLength($node->args[1]->value->value)) { |
|
131 | - $this->errors[] = [ |
|
132 | - 'line' => $node->getLine(), |
|
133 | - 'disallowedToken' => $node->args[1]->value->value, |
|
134 | - 'reason' => sprintf( |
|
135 | - 'Index name is too long on table `%s` (max. 27)', |
|
136 | - $this->tableVariableNames[$node->var->name] |
|
137 | - ), |
|
138 | - ]; |
|
139 | - } |
|
140 | - } |
|
141 | - } else if ($node->name === 'addForeignKeyConstraint') { |
|
142 | - if (isset($node->args[4]) && $node->args[4]->value instanceof Node\Scalar\String_) { |
|
143 | - if (!$this->checkNameLength($node->args[4]->value->value)) { |
|
144 | - $this->errors[] = [ |
|
145 | - 'line' => $node->getLine(), |
|
146 | - 'disallowedToken' => $node->args[4]->value->value, |
|
147 | - 'reason' => sprintf( |
|
148 | - 'Constraint name is too long on table `%s` (max. 27)', |
|
149 | - $this->tableVariableNames[$node->var->name] |
|
150 | - ), |
|
151 | - ]; |
|
152 | - } |
|
153 | - } |
|
154 | - } else if ($node->name === 'renameColumn') { |
|
155 | - $this->errors[] = [ |
|
156 | - 'line' => $node->getLine(), |
|
157 | - 'disallowedToken' => 'Deprecated method', |
|
158 | - 'reason' => sprintf( |
|
159 | - '`$%s->renameColumn()` must not be used', |
|
160 | - $node->var->name |
|
161 | - ), |
|
162 | - ]; |
|
163 | - } |
|
110 | + // On autoincrement the max length of the table name is 21 instead of 27 |
|
111 | + if (isset($node->args[2]) && $node->args[2]->value instanceof Node\Expr\Array_) { |
|
112 | + /** @var Node\Expr\Array_ $options */ |
|
113 | + $options = $node->args[2]->value; |
|
114 | + if ($this->checkColumnForAutoincrement($options)) { |
|
115 | + if (!$this->checkNameLength($this->tableVariableNames[$node->var->name], true)) { |
|
116 | + $this->errors[] = [ |
|
117 | + 'line' => $node->getLine(), |
|
118 | + 'disallowedToken' => $this->tableVariableNames[$node->var->name], |
|
119 | + 'reason' => 'Table name is too long because of autoincrement (max. 21)', |
|
120 | + ]; |
|
121 | + } |
|
122 | + } |
|
123 | + } |
|
124 | + } |
|
125 | + } else if ($node->name === 'addIndex' || |
|
126 | + $node->name === 'addUniqueIndex' || |
|
127 | + $node->name === 'renameIndex' || |
|
128 | + $node->name === 'setPrimaryKey') { |
|
129 | + if (isset($node->args[1]) && $node->args[1]->value instanceof Node\Scalar\String_) { |
|
130 | + if (!$this->checkNameLength($node->args[1]->value->value)) { |
|
131 | + $this->errors[] = [ |
|
132 | + 'line' => $node->getLine(), |
|
133 | + 'disallowedToken' => $node->args[1]->value->value, |
|
134 | + 'reason' => sprintf( |
|
135 | + 'Index name is too long on table `%s` (max. 27)', |
|
136 | + $this->tableVariableNames[$node->var->name] |
|
137 | + ), |
|
138 | + ]; |
|
139 | + } |
|
140 | + } |
|
141 | + } else if ($node->name === 'addForeignKeyConstraint') { |
|
142 | + if (isset($node->args[4]) && $node->args[4]->value instanceof Node\Scalar\String_) { |
|
143 | + if (!$this->checkNameLength($node->args[4]->value->value)) { |
|
144 | + $this->errors[] = [ |
|
145 | + 'line' => $node->getLine(), |
|
146 | + 'disallowedToken' => $node->args[4]->value->value, |
|
147 | + 'reason' => sprintf( |
|
148 | + 'Constraint name is too long on table `%s` (max. 27)', |
|
149 | + $this->tableVariableNames[$node->var->name] |
|
150 | + ), |
|
151 | + ]; |
|
152 | + } |
|
153 | + } |
|
154 | + } else if ($node->name === 'renameColumn') { |
|
155 | + $this->errors[] = [ |
|
156 | + 'line' => $node->getLine(), |
|
157 | + 'disallowedToken' => 'Deprecated method', |
|
158 | + 'reason' => sprintf( |
|
159 | + '`$%s->renameColumn()` must not be used', |
|
160 | + $node->var->name |
|
161 | + ), |
|
162 | + ]; |
|
163 | + } |
|
164 | 164 | |
165 | - /** |
|
166 | - * Find the schema |
|
167 | - */ |
|
168 | - } else if ($node instanceof Node\Expr\Assign && |
|
169 | - $node->expr instanceof Node\Expr\FuncCall && |
|
170 | - $node->var instanceof Node\Expr\Variable && |
|
171 | - $node->expr->name instanceof Node\Expr\Variable && |
|
172 | - $node->expr->name->name === 'schemaClosure') { |
|
173 | - // E.g. $schema = $schemaClosure(); |
|
174 | - $this->schemaVariableName = $node->var->name; |
|
175 | - } |
|
176 | - } |
|
165 | + /** |
|
166 | + * Find the schema |
|
167 | + */ |
|
168 | + } else if ($node instanceof Node\Expr\Assign && |
|
169 | + $node->expr instanceof Node\Expr\FuncCall && |
|
170 | + $node->var instanceof Node\Expr\Variable && |
|
171 | + $node->expr->name instanceof Node\Expr\Variable && |
|
172 | + $node->expr->name->name === 'schemaClosure') { |
|
173 | + // E.g. $schema = $schemaClosure(); |
|
174 | + $this->schemaVariableName = $node->var->name; |
|
175 | + } |
|
176 | + } |
|
177 | 177 | |
178 | - protected function checkNameLength($tableName, $hasAutoincrement = false) { |
|
179 | - if ($hasAutoincrement) { |
|
180 | - return strlen($tableName) <= 21; |
|
181 | - } |
|
182 | - return strlen($tableName) <= 27; |
|
183 | - } |
|
178 | + protected function checkNameLength($tableName, $hasAutoincrement = false) { |
|
179 | + if ($hasAutoincrement) { |
|
180 | + return strlen($tableName) <= 21; |
|
181 | + } |
|
182 | + return strlen($tableName) <= 27; |
|
183 | + } |
|
184 | 184 | |
185 | - /** |
|
186 | - * @param Node\Expr\Array_ $optionsArray |
|
187 | - * @return bool Whether the column is an autoincrement column |
|
188 | - */ |
|
189 | - protected function checkColumnForAutoincrement(Node\Expr\Array_ $optionsArray) { |
|
190 | - foreach ($optionsArray->items as $option) { |
|
191 | - if ($option->key instanceof Node\Scalar\String_) { |
|
192 | - if ($option->key->value === 'autoincrement' && |
|
193 | - $option->value instanceof Node\Expr\ConstFetch) { |
|
194 | - /** @var Node\Expr\ConstFetch $const */ |
|
195 | - $const = $option->value; |
|
185 | + /** |
|
186 | + * @param Node\Expr\Array_ $optionsArray |
|
187 | + * @return bool Whether the column is an autoincrement column |
|
188 | + */ |
|
189 | + protected function checkColumnForAutoincrement(Node\Expr\Array_ $optionsArray) { |
|
190 | + foreach ($optionsArray->items as $option) { |
|
191 | + if ($option->key instanceof Node\Scalar\String_) { |
|
192 | + if ($option->key->value === 'autoincrement' && |
|
193 | + $option->value instanceof Node\Expr\ConstFetch) { |
|
194 | + /** @var Node\Expr\ConstFetch $const */ |
|
195 | + $const = $option->value; |
|
196 | 196 | |
197 | - if ($const->name instanceof Name && |
|
198 | - $const->name->parts === ['true']) { |
|
199 | - return true; |
|
200 | - } |
|
201 | - } |
|
202 | - } |
|
203 | - } |
|
197 | + if ($const->name instanceof Name && |
|
198 | + $const->name->parts === ['true']) { |
|
199 | + return true; |
|
200 | + } |
|
201 | + } |
|
202 | + } |
|
203 | + } |
|
204 | 204 | |
205 | - return false; |
|
206 | - } |
|
205 | + return false; |
|
206 | + } |
|
207 | 207 | } |
@@ -25,16 +25,16 @@ |
||
25 | 25 | |
26 | 26 | class Exception extends \Exception { |
27 | 27 | |
28 | - /** @var Result */ |
|
29 | - private $result; |
|
28 | + /** @var Result */ |
|
29 | + private $result; |
|
30 | 30 | |
31 | - public function __construct(Result $result) { |
|
32 | - parent::__construct(); |
|
33 | - $this->result = $result; |
|
34 | - } |
|
31 | + public function __construct(Result $result) { |
|
32 | + parent::__construct(); |
|
33 | + $this->result = $result; |
|
34 | + } |
|
35 | 35 | |
36 | - public function getResult() { |
|
37 | - return $this->result; |
|
38 | - } |
|
36 | + public function getResult() { |
|
37 | + return $this->result; |
|
38 | + } |
|
39 | 39 | |
40 | 40 | } |
@@ -32,85 +32,85 @@ |
||
32 | 32 | */ |
33 | 33 | class File extends \OCP\Search\Result { |
34 | 34 | |
35 | - /** |
|
36 | - * Type name; translated in templates |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - public $type = 'file'; |
|
35 | + /** |
|
36 | + * Type name; translated in templates |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + public $type = 'file'; |
|
40 | 40 | |
41 | - /** |
|
42 | - * Path to file |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public $path; |
|
41 | + /** |
|
42 | + * Path to file |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public $path; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Size, in bytes |
|
49 | - * @var int |
|
50 | - */ |
|
51 | - public $size; |
|
47 | + /** |
|
48 | + * Size, in bytes |
|
49 | + * @var int |
|
50 | + */ |
|
51 | + public $size; |
|
52 | 52 | |
53 | - /** |
|
54 | - * Date modified, in human readable form |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public $modified; |
|
53 | + /** |
|
54 | + * Date modified, in human readable form |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public $modified; |
|
58 | 58 | |
59 | - /** |
|
60 | - * File mime type |
|
61 | - * @var string |
|
62 | - */ |
|
63 | - public $mime_type; |
|
59 | + /** |
|
60 | + * File mime type |
|
61 | + * @var string |
|
62 | + */ |
|
63 | + public $mime_type; |
|
64 | 64 | |
65 | - /** |
|
66 | - * File permissions: |
|
67 | - * |
|
68 | - * @var string |
|
69 | - */ |
|
70 | - public $permissions; |
|
65 | + /** |
|
66 | + * File permissions: |
|
67 | + * |
|
68 | + * @var string |
|
69 | + */ |
|
70 | + public $permissions; |
|
71 | 71 | |
72 | - /** |
|
73 | - * Create a new file search result |
|
74 | - * @param FileInfo $data file data given by provider |
|
75 | - */ |
|
76 | - public function __construct(FileInfo $data) { |
|
72 | + /** |
|
73 | + * Create a new file search result |
|
74 | + * @param FileInfo $data file data given by provider |
|
75 | + */ |
|
76 | + public function __construct(FileInfo $data) { |
|
77 | 77 | |
78 | - $path = $this->getRelativePath($data->getPath()); |
|
78 | + $path = $this->getRelativePath($data->getPath()); |
|
79 | 79 | |
80 | - $info = pathinfo($path); |
|
81 | - $this->id = $data->getId(); |
|
82 | - $this->name = $info['basename']; |
|
83 | - $this->link = \OC::$server->getURLGenerator()->linkToRoute( |
|
84 | - 'files.view.index', |
|
85 | - [ |
|
86 | - 'dir' => $info['dirname'], |
|
87 | - 'scrollto' => $info['basename'], |
|
88 | - ] |
|
89 | - ); |
|
90 | - $this->permissions = $data->getPermissions(); |
|
91 | - $this->path = $path; |
|
92 | - $this->size = $data->getSize(); |
|
93 | - $this->modified = $data->getMtime(); |
|
94 | - $this->mime_type = $data->getMimetype(); |
|
95 | - } |
|
80 | + $info = pathinfo($path); |
|
81 | + $this->id = $data->getId(); |
|
82 | + $this->name = $info['basename']; |
|
83 | + $this->link = \OC::$server->getURLGenerator()->linkToRoute( |
|
84 | + 'files.view.index', |
|
85 | + [ |
|
86 | + 'dir' => $info['dirname'], |
|
87 | + 'scrollto' => $info['basename'], |
|
88 | + ] |
|
89 | + ); |
|
90 | + $this->permissions = $data->getPermissions(); |
|
91 | + $this->path = $path; |
|
92 | + $this->size = $data->getSize(); |
|
93 | + $this->modified = $data->getMtime(); |
|
94 | + $this->mime_type = $data->getMimetype(); |
|
95 | + } |
|
96 | 96 | |
97 | - /** |
|
98 | - * @var Folder $userFolderCache |
|
99 | - */ |
|
100 | - static protected $userFolderCache = null; |
|
97 | + /** |
|
98 | + * @var Folder $userFolderCache |
|
99 | + */ |
|
100 | + static protected $userFolderCache = null; |
|
101 | 101 | |
102 | - /** |
|
103 | - * converts a path relative to the users files folder |
|
104 | - * eg /user/files/foo.txt -> /foo.txt |
|
105 | - * @param string $path |
|
106 | - * @return string relative path |
|
107 | - */ |
|
108 | - protected function getRelativePath ($path) { |
|
109 | - if (!isset(self::$userFolderCache)) { |
|
110 | - $user = \OC::$server->getUserSession()->getUser()->getUID(); |
|
111 | - self::$userFolderCache = \OC::$server->getUserFolder($user); |
|
112 | - } |
|
113 | - return self::$userFolderCache->getRelativePath($path); |
|
114 | - } |
|
102 | + /** |
|
103 | + * converts a path relative to the users files folder |
|
104 | + * eg /user/files/foo.txt -> /foo.txt |
|
105 | + * @param string $path |
|
106 | + * @return string relative path |
|
107 | + */ |
|
108 | + protected function getRelativePath ($path) { |
|
109 | + if (!isset(self::$userFolderCache)) { |
|
110 | + $user = \OC::$server->getUserSession()->getUser()->getUID(); |
|
111 | + self::$userFolderCache = \OC::$server->getUserFolder($user); |
|
112 | + } |
|
113 | + return self::$userFolderCache->getRelativePath($path); |
|
114 | + } |
|
115 | 115 | |
116 | 116 | } |
@@ -32,26 +32,26 @@ |
||
32 | 32 | * @package OC\BackgroundJob |
33 | 33 | */ |
34 | 34 | abstract class TimedJob extends Job { |
35 | - protected $interval = 0; |
|
35 | + protected $interval = 0; |
|
36 | 36 | |
37 | - /** |
|
38 | - * set the interval for the job |
|
39 | - * |
|
40 | - * @param int $interval |
|
41 | - */ |
|
42 | - public function setInterval($interval) { |
|
43 | - $this->interval = $interval; |
|
44 | - } |
|
37 | + /** |
|
38 | + * set the interval for the job |
|
39 | + * |
|
40 | + * @param int $interval |
|
41 | + */ |
|
42 | + public function setInterval($interval) { |
|
43 | + $this->interval = $interval; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * run the job if |
|
48 | - * |
|
49 | - * @param JobList $jobList |
|
50 | - * @param ILogger|null $logger |
|
51 | - */ |
|
52 | - public function execute($jobList, ILogger $logger = null) { |
|
53 | - if ((time() - $this->lastRun) > $this->interval) { |
|
54 | - parent::execute($jobList, $logger); |
|
55 | - } |
|
56 | - } |
|
46 | + /** |
|
47 | + * run the job if |
|
48 | + * |
|
49 | + * @param JobList $jobList |
|
50 | + * @param ILogger|null $logger |
|
51 | + */ |
|
52 | + public function execute($jobList, ILogger $logger = null) { |
|
53 | + if ((time() - $this->lastRun) > $this->interval) { |
|
54 | + parent::execute($jobList, $logger); |
|
55 | + } |
|
56 | + } |
|
57 | 57 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @package OC\BackgroundJob |
33 | 33 | */ |
34 | 34 | abstract class QueuedJob extends Job { |
35 | - /** |
|
36 | - * run the job, then remove it from the joblist |
|
37 | - * |
|
38 | - * @param JobList $jobList |
|
39 | - * @param ILogger|null $logger |
|
40 | - */ |
|
41 | - public function execute($jobList, ILogger $logger = null) { |
|
42 | - $jobList->remove($this, $this->argument); |
|
43 | - parent::execute($jobList, $logger); |
|
44 | - } |
|
35 | + /** |
|
36 | + * run the job, then remove it from the joblist |
|
37 | + * |
|
38 | + * @param JobList $jobList |
|
39 | + * @param ILogger|null $logger |
|
40 | + */ |
|
41 | + public function execute($jobList, ILogger $logger = null) { |
|
42 | + $jobList->remove($this, $this->argument); |
|
43 | + parent::execute($jobList, $logger); |
|
44 | + } |
|
45 | 45 | } |
@@ -34,502 +34,502 @@ |
||
34 | 34 | */ |
35 | 35 | class Encoding extends Wrapper { |
36 | 36 | |
37 | - /** |
|
38 | - * @var ICache |
|
39 | - */ |
|
40 | - private $namesCache; |
|
41 | - |
|
42 | - /** |
|
43 | - * @param array $parameters |
|
44 | - */ |
|
45 | - public function __construct($parameters) { |
|
46 | - $this->storage = $parameters['storage']; |
|
47 | - $this->namesCache = new CappedMemoryCache(); |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * Returns whether the given string is only made of ASCII characters |
|
52 | - * |
|
53 | - * @param string $str string |
|
54 | - * |
|
55 | - * @return bool true if the string is all ASCII, false otherwise |
|
56 | - */ |
|
57 | - private function isAscii($str) { |
|
58 | - return (bool) !preg_match('/[\\x80-\\xff]+/', $str); |
|
59 | - } |
|
60 | - |
|
61 | - /** |
|
62 | - * Checks whether the given path exists in NFC or NFD form after checking |
|
63 | - * each form for each path section and returns the correct form. |
|
64 | - * If no existing path found, returns the path as it was given. |
|
65 | - * |
|
66 | - * @param string $fullPath path to check |
|
67 | - * |
|
68 | - * @return string original or converted path |
|
69 | - */ |
|
70 | - private function findPathToUse($fullPath) { |
|
71 | - $cachedPath = $this->namesCache[$fullPath]; |
|
72 | - if ($cachedPath !== null) { |
|
73 | - return $cachedPath; |
|
74 | - } |
|
75 | - |
|
76 | - $sections = explode('/', $fullPath); |
|
77 | - $path = ''; |
|
78 | - foreach ($sections as $section) { |
|
79 | - $convertedPath = $this->findPathToUseLastSection($path, $section); |
|
80 | - if ($convertedPath === null) { |
|
81 | - // no point in continuing if the section was not found, use original path |
|
82 | - return $fullPath; |
|
83 | - } |
|
84 | - $path = $convertedPath . '/'; |
|
85 | - } |
|
86 | - $path = rtrim($path, '/'); |
|
87 | - return $path; |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Checks whether the last path section of the given path exists in NFC or NFD form |
|
92 | - * and returns the correct form. If no existing path found, returns null. |
|
93 | - * |
|
94 | - * @param string $basePath base path to check |
|
95 | - * @param string $lastSection last section of the path to check for NFD/NFC variations |
|
96 | - * |
|
97 | - * @return string|null original or converted path, or null if none of the forms was found |
|
98 | - */ |
|
99 | - private function findPathToUseLastSection($basePath, $lastSection) { |
|
100 | - $fullPath = $basePath . $lastSection; |
|
101 | - if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) { |
|
102 | - $this->namesCache[$fullPath] = $fullPath; |
|
103 | - return $fullPath; |
|
104 | - } |
|
105 | - |
|
106 | - // swap encoding |
|
107 | - if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) { |
|
108 | - $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D); |
|
109 | - } else { |
|
110 | - $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C); |
|
111 | - } |
|
112 | - $otherFullPath = $basePath . $otherFormPath; |
|
113 | - if ($this->storage->file_exists($otherFullPath)) { |
|
114 | - $this->namesCache[$fullPath] = $otherFullPath; |
|
115 | - return $otherFullPath; |
|
116 | - } |
|
117 | - |
|
118 | - // return original path, file did not exist at all |
|
119 | - $this->namesCache[$fullPath] = $fullPath; |
|
120 | - return null; |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * see http://php.net/manual/en/function.mkdir.php |
|
125 | - * |
|
126 | - * @param string $path |
|
127 | - * @return bool |
|
128 | - */ |
|
129 | - public function mkdir($path) { |
|
130 | - // note: no conversion here, method should not be called with non-NFC names! |
|
131 | - $result = $this->storage->mkdir($path); |
|
132 | - if ($result) { |
|
133 | - $this->namesCache[$path] = $path; |
|
134 | - } |
|
135 | - return $result; |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * see http://php.net/manual/en/function.rmdir.php |
|
140 | - * |
|
141 | - * @param string $path |
|
142 | - * @return bool |
|
143 | - */ |
|
144 | - public function rmdir($path) { |
|
145 | - $result = $this->storage->rmdir($this->findPathToUse($path)); |
|
146 | - if ($result) { |
|
147 | - unset($this->namesCache[$path]); |
|
148 | - } |
|
149 | - return $result; |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * see http://php.net/manual/en/function.opendir.php |
|
154 | - * |
|
155 | - * @param string $path |
|
156 | - * @return resource |
|
157 | - */ |
|
158 | - public function opendir($path) { |
|
159 | - return $this->storage->opendir($this->findPathToUse($path)); |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * see http://php.net/manual/en/function.is_dir.php |
|
164 | - * |
|
165 | - * @param string $path |
|
166 | - * @return bool |
|
167 | - */ |
|
168 | - public function is_dir($path) { |
|
169 | - return $this->storage->is_dir($this->findPathToUse($path)); |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * see http://php.net/manual/en/function.is_file.php |
|
174 | - * |
|
175 | - * @param string $path |
|
176 | - * @return bool |
|
177 | - */ |
|
178 | - public function is_file($path) { |
|
179 | - return $this->storage->is_file($this->findPathToUse($path)); |
|
180 | - } |
|
181 | - |
|
182 | - /** |
|
183 | - * see http://php.net/manual/en/function.stat.php |
|
184 | - * only the following keys are required in the result: size and mtime |
|
185 | - * |
|
186 | - * @param string $path |
|
187 | - * @return array |
|
188 | - */ |
|
189 | - public function stat($path) { |
|
190 | - return $this->storage->stat($this->findPathToUse($path)); |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * see http://php.net/manual/en/function.filetype.php |
|
195 | - * |
|
196 | - * @param string $path |
|
197 | - * @return bool |
|
198 | - */ |
|
199 | - public function filetype($path) { |
|
200 | - return $this->storage->filetype($this->findPathToUse($path)); |
|
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * see http://php.net/manual/en/function.filesize.php |
|
205 | - * The result for filesize when called on a folder is required to be 0 |
|
206 | - * |
|
207 | - * @param string $path |
|
208 | - * @return int |
|
209 | - */ |
|
210 | - public function filesize($path) { |
|
211 | - return $this->storage->filesize($this->findPathToUse($path)); |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * check if a file can be created in $path |
|
216 | - * |
|
217 | - * @param string $path |
|
218 | - * @return bool |
|
219 | - */ |
|
220 | - public function isCreatable($path) { |
|
221 | - return $this->storage->isCreatable($this->findPathToUse($path)); |
|
222 | - } |
|
223 | - |
|
224 | - /** |
|
225 | - * check if a file can be read |
|
226 | - * |
|
227 | - * @param string $path |
|
228 | - * @return bool |
|
229 | - */ |
|
230 | - public function isReadable($path) { |
|
231 | - return $this->storage->isReadable($this->findPathToUse($path)); |
|
232 | - } |
|
233 | - |
|
234 | - /** |
|
235 | - * check if a file can be written to |
|
236 | - * |
|
237 | - * @param string $path |
|
238 | - * @return bool |
|
239 | - */ |
|
240 | - public function isUpdatable($path) { |
|
241 | - return $this->storage->isUpdatable($this->findPathToUse($path)); |
|
242 | - } |
|
243 | - |
|
244 | - /** |
|
245 | - * check if a file can be deleted |
|
246 | - * |
|
247 | - * @param string $path |
|
248 | - * @return bool |
|
249 | - */ |
|
250 | - public function isDeletable($path) { |
|
251 | - return $this->storage->isDeletable($this->findPathToUse($path)); |
|
252 | - } |
|
253 | - |
|
254 | - /** |
|
255 | - * check if a file can be shared |
|
256 | - * |
|
257 | - * @param string $path |
|
258 | - * @return bool |
|
259 | - */ |
|
260 | - public function isSharable($path) { |
|
261 | - return $this->storage->isSharable($this->findPathToUse($path)); |
|
262 | - } |
|
263 | - |
|
264 | - /** |
|
265 | - * get the full permissions of a path. |
|
266 | - * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php |
|
267 | - * |
|
268 | - * @param string $path |
|
269 | - * @return int |
|
270 | - */ |
|
271 | - public function getPermissions($path) { |
|
272 | - return $this->storage->getPermissions($this->findPathToUse($path)); |
|
273 | - } |
|
274 | - |
|
275 | - /** |
|
276 | - * see http://php.net/manual/en/function.file_exists.php |
|
277 | - * |
|
278 | - * @param string $path |
|
279 | - * @return bool |
|
280 | - */ |
|
281 | - public function file_exists($path) { |
|
282 | - return $this->storage->file_exists($this->findPathToUse($path)); |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * see http://php.net/manual/en/function.filemtime.php |
|
287 | - * |
|
288 | - * @param string $path |
|
289 | - * @return int |
|
290 | - */ |
|
291 | - public function filemtime($path) { |
|
292 | - return $this->storage->filemtime($this->findPathToUse($path)); |
|
293 | - } |
|
294 | - |
|
295 | - /** |
|
296 | - * see http://php.net/manual/en/function.file_get_contents.php |
|
297 | - * |
|
298 | - * @param string $path |
|
299 | - * @return string |
|
300 | - */ |
|
301 | - public function file_get_contents($path) { |
|
302 | - return $this->storage->file_get_contents($this->findPathToUse($path)); |
|
303 | - } |
|
304 | - |
|
305 | - /** |
|
306 | - * see http://php.net/manual/en/function.file_put_contents.php |
|
307 | - * |
|
308 | - * @param string $path |
|
309 | - * @param string $data |
|
310 | - * @return bool |
|
311 | - */ |
|
312 | - public function file_put_contents($path, $data) { |
|
313 | - return $this->storage->file_put_contents($this->findPathToUse($path), $data); |
|
314 | - } |
|
315 | - |
|
316 | - /** |
|
317 | - * see http://php.net/manual/en/function.unlink.php |
|
318 | - * |
|
319 | - * @param string $path |
|
320 | - * @return bool |
|
321 | - */ |
|
322 | - public function unlink($path) { |
|
323 | - $result = $this->storage->unlink($this->findPathToUse($path)); |
|
324 | - if ($result) { |
|
325 | - unset($this->namesCache[$path]); |
|
326 | - } |
|
327 | - return $result; |
|
328 | - } |
|
329 | - |
|
330 | - /** |
|
331 | - * see http://php.net/manual/en/function.rename.php |
|
332 | - * |
|
333 | - * @param string $path1 |
|
334 | - * @param string $path2 |
|
335 | - * @return bool |
|
336 | - */ |
|
337 | - public function rename($path1, $path2) { |
|
338 | - // second name always NFC |
|
339 | - return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2)); |
|
340 | - } |
|
341 | - |
|
342 | - /** |
|
343 | - * see http://php.net/manual/en/function.copy.php |
|
344 | - * |
|
345 | - * @param string $path1 |
|
346 | - * @param string $path2 |
|
347 | - * @return bool |
|
348 | - */ |
|
349 | - public function copy($path1, $path2) { |
|
350 | - return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2)); |
|
351 | - } |
|
352 | - |
|
353 | - /** |
|
354 | - * see http://php.net/manual/en/function.fopen.php |
|
355 | - * |
|
356 | - * @param string $path |
|
357 | - * @param string $mode |
|
358 | - * @return resource |
|
359 | - */ |
|
360 | - public function fopen($path, $mode) { |
|
361 | - $result = $this->storage->fopen($this->findPathToUse($path), $mode); |
|
362 | - if ($result && $mode !== 'r' && $mode !== 'rb') { |
|
363 | - unset($this->namesCache[$path]); |
|
364 | - } |
|
365 | - return $result; |
|
366 | - } |
|
367 | - |
|
368 | - /** |
|
369 | - * get the mimetype for a file or folder |
|
370 | - * The mimetype for a folder is required to be "httpd/unix-directory" |
|
371 | - * |
|
372 | - * @param string $path |
|
373 | - * @return string |
|
374 | - */ |
|
375 | - public function getMimeType($path) { |
|
376 | - return $this->storage->getMimeType($this->findPathToUse($path)); |
|
377 | - } |
|
378 | - |
|
379 | - /** |
|
380 | - * see http://php.net/manual/en/function.hash.php |
|
381 | - * |
|
382 | - * @param string $type |
|
383 | - * @param string $path |
|
384 | - * @param bool $raw |
|
385 | - * @return string |
|
386 | - */ |
|
387 | - public function hash($type, $path, $raw = false) { |
|
388 | - return $this->storage->hash($type, $this->findPathToUse($path), $raw); |
|
389 | - } |
|
390 | - |
|
391 | - /** |
|
392 | - * see http://php.net/manual/en/function.free_space.php |
|
393 | - * |
|
394 | - * @param string $path |
|
395 | - * @return int |
|
396 | - */ |
|
397 | - public function free_space($path) { |
|
398 | - return $this->storage->free_space($this->findPathToUse($path)); |
|
399 | - } |
|
400 | - |
|
401 | - /** |
|
402 | - * search for occurrences of $query in file names |
|
403 | - * |
|
404 | - * @param string $query |
|
405 | - * @return array |
|
406 | - */ |
|
407 | - public function search($query) { |
|
408 | - return $this->storage->search($query); |
|
409 | - } |
|
410 | - |
|
411 | - /** |
|
412 | - * see http://php.net/manual/en/function.touch.php |
|
413 | - * If the backend does not support the operation, false should be returned |
|
414 | - * |
|
415 | - * @param string $path |
|
416 | - * @param int $mtime |
|
417 | - * @return bool |
|
418 | - */ |
|
419 | - public function touch($path, $mtime = null) { |
|
420 | - return $this->storage->touch($this->findPathToUse($path), $mtime); |
|
421 | - } |
|
422 | - |
|
423 | - /** |
|
424 | - * get the path to a local version of the file. |
|
425 | - * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
426 | - * |
|
427 | - * @param string $path |
|
428 | - * @return string |
|
429 | - */ |
|
430 | - public function getLocalFile($path) { |
|
431 | - return $this->storage->getLocalFile($this->findPathToUse($path)); |
|
432 | - } |
|
433 | - |
|
434 | - /** |
|
435 | - * check if a file or folder has been updated since $time |
|
436 | - * |
|
437 | - * @param string $path |
|
438 | - * @param int $time |
|
439 | - * @return bool |
|
440 | - * |
|
441 | - * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed. |
|
442 | - * returning true for other changes in the folder is optional |
|
443 | - */ |
|
444 | - public function hasUpdated($path, $time) { |
|
445 | - return $this->storage->hasUpdated($this->findPathToUse($path), $time); |
|
446 | - } |
|
447 | - |
|
448 | - /** |
|
449 | - * get a cache instance for the storage |
|
450 | - * |
|
451 | - * @param string $path |
|
452 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
453 | - * @return \OC\Files\Cache\Cache |
|
454 | - */ |
|
455 | - public function getCache($path = '', $storage = null) { |
|
456 | - if (!$storage) { |
|
457 | - $storage = $this; |
|
458 | - } |
|
459 | - return $this->storage->getCache($this->findPathToUse($path), $storage); |
|
460 | - } |
|
461 | - |
|
462 | - /** |
|
463 | - * get a scanner instance for the storage |
|
464 | - * |
|
465 | - * @param string $path |
|
466 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
467 | - * @return \OC\Files\Cache\Scanner |
|
468 | - */ |
|
469 | - public function getScanner($path = '', $storage = null) { |
|
470 | - if (!$storage) { |
|
471 | - $storage = $this; |
|
472 | - } |
|
473 | - return $this->storage->getScanner($this->findPathToUse($path), $storage); |
|
474 | - } |
|
475 | - |
|
476 | - /** |
|
477 | - * get the ETag for a file or folder |
|
478 | - * |
|
479 | - * @param string $path |
|
480 | - * @return string |
|
481 | - */ |
|
482 | - public function getETag($path) { |
|
483 | - return $this->storage->getETag($this->findPathToUse($path)); |
|
484 | - } |
|
485 | - |
|
486 | - /** |
|
487 | - * @param IStorage $sourceStorage |
|
488 | - * @param string $sourceInternalPath |
|
489 | - * @param string $targetInternalPath |
|
490 | - * @return bool |
|
491 | - */ |
|
492 | - public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
493 | - if ($sourceStorage === $this) { |
|
494 | - return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
495 | - } |
|
496 | - |
|
497 | - $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
498 | - if ($result) { |
|
499 | - unset($this->namesCache[$targetInternalPath]); |
|
500 | - } |
|
501 | - return $result; |
|
502 | - } |
|
503 | - |
|
504 | - /** |
|
505 | - * @param IStorage $sourceStorage |
|
506 | - * @param string $sourceInternalPath |
|
507 | - * @param string $targetInternalPath |
|
508 | - * @return bool |
|
509 | - */ |
|
510 | - public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
511 | - if ($sourceStorage === $this) { |
|
512 | - $result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
513 | - if ($result) { |
|
514 | - unset($this->namesCache[$sourceInternalPath]); |
|
515 | - unset($this->namesCache[$targetInternalPath]); |
|
516 | - } |
|
517 | - return $result; |
|
518 | - } |
|
519 | - |
|
520 | - $result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
521 | - if ($result) { |
|
522 | - unset($this->namesCache[$sourceInternalPath]); |
|
523 | - unset($this->namesCache[$targetInternalPath]); |
|
524 | - } |
|
525 | - return $result; |
|
526 | - } |
|
527 | - |
|
528 | - /** |
|
529 | - * @param string $path |
|
530 | - * @return array |
|
531 | - */ |
|
532 | - public function getMetaData($path) { |
|
533 | - return $this->storage->getMetaData($this->findPathToUse($path)); |
|
534 | - } |
|
37 | + /** |
|
38 | + * @var ICache |
|
39 | + */ |
|
40 | + private $namesCache; |
|
41 | + |
|
42 | + /** |
|
43 | + * @param array $parameters |
|
44 | + */ |
|
45 | + public function __construct($parameters) { |
|
46 | + $this->storage = $parameters['storage']; |
|
47 | + $this->namesCache = new CappedMemoryCache(); |
|
48 | + } |
|
49 | + |
|
50 | + /** |
|
51 | + * Returns whether the given string is only made of ASCII characters |
|
52 | + * |
|
53 | + * @param string $str string |
|
54 | + * |
|
55 | + * @return bool true if the string is all ASCII, false otherwise |
|
56 | + */ |
|
57 | + private function isAscii($str) { |
|
58 | + return (bool) !preg_match('/[\\x80-\\xff]+/', $str); |
|
59 | + } |
|
60 | + |
|
61 | + /** |
|
62 | + * Checks whether the given path exists in NFC or NFD form after checking |
|
63 | + * each form for each path section and returns the correct form. |
|
64 | + * If no existing path found, returns the path as it was given. |
|
65 | + * |
|
66 | + * @param string $fullPath path to check |
|
67 | + * |
|
68 | + * @return string original or converted path |
|
69 | + */ |
|
70 | + private function findPathToUse($fullPath) { |
|
71 | + $cachedPath = $this->namesCache[$fullPath]; |
|
72 | + if ($cachedPath !== null) { |
|
73 | + return $cachedPath; |
|
74 | + } |
|
75 | + |
|
76 | + $sections = explode('/', $fullPath); |
|
77 | + $path = ''; |
|
78 | + foreach ($sections as $section) { |
|
79 | + $convertedPath = $this->findPathToUseLastSection($path, $section); |
|
80 | + if ($convertedPath === null) { |
|
81 | + // no point in continuing if the section was not found, use original path |
|
82 | + return $fullPath; |
|
83 | + } |
|
84 | + $path = $convertedPath . '/'; |
|
85 | + } |
|
86 | + $path = rtrim($path, '/'); |
|
87 | + return $path; |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Checks whether the last path section of the given path exists in NFC or NFD form |
|
92 | + * and returns the correct form. If no existing path found, returns null. |
|
93 | + * |
|
94 | + * @param string $basePath base path to check |
|
95 | + * @param string $lastSection last section of the path to check for NFD/NFC variations |
|
96 | + * |
|
97 | + * @return string|null original or converted path, or null if none of the forms was found |
|
98 | + */ |
|
99 | + private function findPathToUseLastSection($basePath, $lastSection) { |
|
100 | + $fullPath = $basePath . $lastSection; |
|
101 | + if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) { |
|
102 | + $this->namesCache[$fullPath] = $fullPath; |
|
103 | + return $fullPath; |
|
104 | + } |
|
105 | + |
|
106 | + // swap encoding |
|
107 | + if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) { |
|
108 | + $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D); |
|
109 | + } else { |
|
110 | + $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C); |
|
111 | + } |
|
112 | + $otherFullPath = $basePath . $otherFormPath; |
|
113 | + if ($this->storage->file_exists($otherFullPath)) { |
|
114 | + $this->namesCache[$fullPath] = $otherFullPath; |
|
115 | + return $otherFullPath; |
|
116 | + } |
|
117 | + |
|
118 | + // return original path, file did not exist at all |
|
119 | + $this->namesCache[$fullPath] = $fullPath; |
|
120 | + return null; |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * see http://php.net/manual/en/function.mkdir.php |
|
125 | + * |
|
126 | + * @param string $path |
|
127 | + * @return bool |
|
128 | + */ |
|
129 | + public function mkdir($path) { |
|
130 | + // note: no conversion here, method should not be called with non-NFC names! |
|
131 | + $result = $this->storage->mkdir($path); |
|
132 | + if ($result) { |
|
133 | + $this->namesCache[$path] = $path; |
|
134 | + } |
|
135 | + return $result; |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * see http://php.net/manual/en/function.rmdir.php |
|
140 | + * |
|
141 | + * @param string $path |
|
142 | + * @return bool |
|
143 | + */ |
|
144 | + public function rmdir($path) { |
|
145 | + $result = $this->storage->rmdir($this->findPathToUse($path)); |
|
146 | + if ($result) { |
|
147 | + unset($this->namesCache[$path]); |
|
148 | + } |
|
149 | + return $result; |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * see http://php.net/manual/en/function.opendir.php |
|
154 | + * |
|
155 | + * @param string $path |
|
156 | + * @return resource |
|
157 | + */ |
|
158 | + public function opendir($path) { |
|
159 | + return $this->storage->opendir($this->findPathToUse($path)); |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * see http://php.net/manual/en/function.is_dir.php |
|
164 | + * |
|
165 | + * @param string $path |
|
166 | + * @return bool |
|
167 | + */ |
|
168 | + public function is_dir($path) { |
|
169 | + return $this->storage->is_dir($this->findPathToUse($path)); |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * see http://php.net/manual/en/function.is_file.php |
|
174 | + * |
|
175 | + * @param string $path |
|
176 | + * @return bool |
|
177 | + */ |
|
178 | + public function is_file($path) { |
|
179 | + return $this->storage->is_file($this->findPathToUse($path)); |
|
180 | + } |
|
181 | + |
|
182 | + /** |
|
183 | + * see http://php.net/manual/en/function.stat.php |
|
184 | + * only the following keys are required in the result: size and mtime |
|
185 | + * |
|
186 | + * @param string $path |
|
187 | + * @return array |
|
188 | + */ |
|
189 | + public function stat($path) { |
|
190 | + return $this->storage->stat($this->findPathToUse($path)); |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * see http://php.net/manual/en/function.filetype.php |
|
195 | + * |
|
196 | + * @param string $path |
|
197 | + * @return bool |
|
198 | + */ |
|
199 | + public function filetype($path) { |
|
200 | + return $this->storage->filetype($this->findPathToUse($path)); |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * see http://php.net/manual/en/function.filesize.php |
|
205 | + * The result for filesize when called on a folder is required to be 0 |
|
206 | + * |
|
207 | + * @param string $path |
|
208 | + * @return int |
|
209 | + */ |
|
210 | + public function filesize($path) { |
|
211 | + return $this->storage->filesize($this->findPathToUse($path)); |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * check if a file can be created in $path |
|
216 | + * |
|
217 | + * @param string $path |
|
218 | + * @return bool |
|
219 | + */ |
|
220 | + public function isCreatable($path) { |
|
221 | + return $this->storage->isCreatable($this->findPathToUse($path)); |
|
222 | + } |
|
223 | + |
|
224 | + /** |
|
225 | + * check if a file can be read |
|
226 | + * |
|
227 | + * @param string $path |
|
228 | + * @return bool |
|
229 | + */ |
|
230 | + public function isReadable($path) { |
|
231 | + return $this->storage->isReadable($this->findPathToUse($path)); |
|
232 | + } |
|
233 | + |
|
234 | + /** |
|
235 | + * check if a file can be written to |
|
236 | + * |
|
237 | + * @param string $path |
|
238 | + * @return bool |
|
239 | + */ |
|
240 | + public function isUpdatable($path) { |
|
241 | + return $this->storage->isUpdatable($this->findPathToUse($path)); |
|
242 | + } |
|
243 | + |
|
244 | + /** |
|
245 | + * check if a file can be deleted |
|
246 | + * |
|
247 | + * @param string $path |
|
248 | + * @return bool |
|
249 | + */ |
|
250 | + public function isDeletable($path) { |
|
251 | + return $this->storage->isDeletable($this->findPathToUse($path)); |
|
252 | + } |
|
253 | + |
|
254 | + /** |
|
255 | + * check if a file can be shared |
|
256 | + * |
|
257 | + * @param string $path |
|
258 | + * @return bool |
|
259 | + */ |
|
260 | + public function isSharable($path) { |
|
261 | + return $this->storage->isSharable($this->findPathToUse($path)); |
|
262 | + } |
|
263 | + |
|
264 | + /** |
|
265 | + * get the full permissions of a path. |
|
266 | + * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php |
|
267 | + * |
|
268 | + * @param string $path |
|
269 | + * @return int |
|
270 | + */ |
|
271 | + public function getPermissions($path) { |
|
272 | + return $this->storage->getPermissions($this->findPathToUse($path)); |
|
273 | + } |
|
274 | + |
|
275 | + /** |
|
276 | + * see http://php.net/manual/en/function.file_exists.php |
|
277 | + * |
|
278 | + * @param string $path |
|
279 | + * @return bool |
|
280 | + */ |
|
281 | + public function file_exists($path) { |
|
282 | + return $this->storage->file_exists($this->findPathToUse($path)); |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * see http://php.net/manual/en/function.filemtime.php |
|
287 | + * |
|
288 | + * @param string $path |
|
289 | + * @return int |
|
290 | + */ |
|
291 | + public function filemtime($path) { |
|
292 | + return $this->storage->filemtime($this->findPathToUse($path)); |
|
293 | + } |
|
294 | + |
|
295 | + /** |
|
296 | + * see http://php.net/manual/en/function.file_get_contents.php |
|
297 | + * |
|
298 | + * @param string $path |
|
299 | + * @return string |
|
300 | + */ |
|
301 | + public function file_get_contents($path) { |
|
302 | + return $this->storage->file_get_contents($this->findPathToUse($path)); |
|
303 | + } |
|
304 | + |
|
305 | + /** |
|
306 | + * see http://php.net/manual/en/function.file_put_contents.php |
|
307 | + * |
|
308 | + * @param string $path |
|
309 | + * @param string $data |
|
310 | + * @return bool |
|
311 | + */ |
|
312 | + public function file_put_contents($path, $data) { |
|
313 | + return $this->storage->file_put_contents($this->findPathToUse($path), $data); |
|
314 | + } |
|
315 | + |
|
316 | + /** |
|
317 | + * see http://php.net/manual/en/function.unlink.php |
|
318 | + * |
|
319 | + * @param string $path |
|
320 | + * @return bool |
|
321 | + */ |
|
322 | + public function unlink($path) { |
|
323 | + $result = $this->storage->unlink($this->findPathToUse($path)); |
|
324 | + if ($result) { |
|
325 | + unset($this->namesCache[$path]); |
|
326 | + } |
|
327 | + return $result; |
|
328 | + } |
|
329 | + |
|
330 | + /** |
|
331 | + * see http://php.net/manual/en/function.rename.php |
|
332 | + * |
|
333 | + * @param string $path1 |
|
334 | + * @param string $path2 |
|
335 | + * @return bool |
|
336 | + */ |
|
337 | + public function rename($path1, $path2) { |
|
338 | + // second name always NFC |
|
339 | + return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2)); |
|
340 | + } |
|
341 | + |
|
342 | + /** |
|
343 | + * see http://php.net/manual/en/function.copy.php |
|
344 | + * |
|
345 | + * @param string $path1 |
|
346 | + * @param string $path2 |
|
347 | + * @return bool |
|
348 | + */ |
|
349 | + public function copy($path1, $path2) { |
|
350 | + return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2)); |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * see http://php.net/manual/en/function.fopen.php |
|
355 | + * |
|
356 | + * @param string $path |
|
357 | + * @param string $mode |
|
358 | + * @return resource |
|
359 | + */ |
|
360 | + public function fopen($path, $mode) { |
|
361 | + $result = $this->storage->fopen($this->findPathToUse($path), $mode); |
|
362 | + if ($result && $mode !== 'r' && $mode !== 'rb') { |
|
363 | + unset($this->namesCache[$path]); |
|
364 | + } |
|
365 | + return $result; |
|
366 | + } |
|
367 | + |
|
368 | + /** |
|
369 | + * get the mimetype for a file or folder |
|
370 | + * The mimetype for a folder is required to be "httpd/unix-directory" |
|
371 | + * |
|
372 | + * @param string $path |
|
373 | + * @return string |
|
374 | + */ |
|
375 | + public function getMimeType($path) { |
|
376 | + return $this->storage->getMimeType($this->findPathToUse($path)); |
|
377 | + } |
|
378 | + |
|
379 | + /** |
|
380 | + * see http://php.net/manual/en/function.hash.php |
|
381 | + * |
|
382 | + * @param string $type |
|
383 | + * @param string $path |
|
384 | + * @param bool $raw |
|
385 | + * @return string |
|
386 | + */ |
|
387 | + public function hash($type, $path, $raw = false) { |
|
388 | + return $this->storage->hash($type, $this->findPathToUse($path), $raw); |
|
389 | + } |
|
390 | + |
|
391 | + /** |
|
392 | + * see http://php.net/manual/en/function.free_space.php |
|
393 | + * |
|
394 | + * @param string $path |
|
395 | + * @return int |
|
396 | + */ |
|
397 | + public function free_space($path) { |
|
398 | + return $this->storage->free_space($this->findPathToUse($path)); |
|
399 | + } |
|
400 | + |
|
401 | + /** |
|
402 | + * search for occurrences of $query in file names |
|
403 | + * |
|
404 | + * @param string $query |
|
405 | + * @return array |
|
406 | + */ |
|
407 | + public function search($query) { |
|
408 | + return $this->storage->search($query); |
|
409 | + } |
|
410 | + |
|
411 | + /** |
|
412 | + * see http://php.net/manual/en/function.touch.php |
|
413 | + * If the backend does not support the operation, false should be returned |
|
414 | + * |
|
415 | + * @param string $path |
|
416 | + * @param int $mtime |
|
417 | + * @return bool |
|
418 | + */ |
|
419 | + public function touch($path, $mtime = null) { |
|
420 | + return $this->storage->touch($this->findPathToUse($path), $mtime); |
|
421 | + } |
|
422 | + |
|
423 | + /** |
|
424 | + * get the path to a local version of the file. |
|
425 | + * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
426 | + * |
|
427 | + * @param string $path |
|
428 | + * @return string |
|
429 | + */ |
|
430 | + public function getLocalFile($path) { |
|
431 | + return $this->storage->getLocalFile($this->findPathToUse($path)); |
|
432 | + } |
|
433 | + |
|
434 | + /** |
|
435 | + * check if a file or folder has been updated since $time |
|
436 | + * |
|
437 | + * @param string $path |
|
438 | + * @param int $time |
|
439 | + * @return bool |
|
440 | + * |
|
441 | + * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed. |
|
442 | + * returning true for other changes in the folder is optional |
|
443 | + */ |
|
444 | + public function hasUpdated($path, $time) { |
|
445 | + return $this->storage->hasUpdated($this->findPathToUse($path), $time); |
|
446 | + } |
|
447 | + |
|
448 | + /** |
|
449 | + * get a cache instance for the storage |
|
450 | + * |
|
451 | + * @param string $path |
|
452 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
453 | + * @return \OC\Files\Cache\Cache |
|
454 | + */ |
|
455 | + public function getCache($path = '', $storage = null) { |
|
456 | + if (!$storage) { |
|
457 | + $storage = $this; |
|
458 | + } |
|
459 | + return $this->storage->getCache($this->findPathToUse($path), $storage); |
|
460 | + } |
|
461 | + |
|
462 | + /** |
|
463 | + * get a scanner instance for the storage |
|
464 | + * |
|
465 | + * @param string $path |
|
466 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
467 | + * @return \OC\Files\Cache\Scanner |
|
468 | + */ |
|
469 | + public function getScanner($path = '', $storage = null) { |
|
470 | + if (!$storage) { |
|
471 | + $storage = $this; |
|
472 | + } |
|
473 | + return $this->storage->getScanner($this->findPathToUse($path), $storage); |
|
474 | + } |
|
475 | + |
|
476 | + /** |
|
477 | + * get the ETag for a file or folder |
|
478 | + * |
|
479 | + * @param string $path |
|
480 | + * @return string |
|
481 | + */ |
|
482 | + public function getETag($path) { |
|
483 | + return $this->storage->getETag($this->findPathToUse($path)); |
|
484 | + } |
|
485 | + |
|
486 | + /** |
|
487 | + * @param IStorage $sourceStorage |
|
488 | + * @param string $sourceInternalPath |
|
489 | + * @param string $targetInternalPath |
|
490 | + * @return bool |
|
491 | + */ |
|
492 | + public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
493 | + if ($sourceStorage === $this) { |
|
494 | + return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
495 | + } |
|
496 | + |
|
497 | + $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
498 | + if ($result) { |
|
499 | + unset($this->namesCache[$targetInternalPath]); |
|
500 | + } |
|
501 | + return $result; |
|
502 | + } |
|
503 | + |
|
504 | + /** |
|
505 | + * @param IStorage $sourceStorage |
|
506 | + * @param string $sourceInternalPath |
|
507 | + * @param string $targetInternalPath |
|
508 | + * @return bool |
|
509 | + */ |
|
510 | + public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
511 | + if ($sourceStorage === $this) { |
|
512 | + $result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
513 | + if ($result) { |
|
514 | + unset($this->namesCache[$sourceInternalPath]); |
|
515 | + unset($this->namesCache[$targetInternalPath]); |
|
516 | + } |
|
517 | + return $result; |
|
518 | + } |
|
519 | + |
|
520 | + $result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath)); |
|
521 | + if ($result) { |
|
522 | + unset($this->namesCache[$sourceInternalPath]); |
|
523 | + unset($this->namesCache[$targetInternalPath]); |
|
524 | + } |
|
525 | + return $result; |
|
526 | + } |
|
527 | + |
|
528 | + /** |
|
529 | + * @param string $path |
|
530 | + * @return array |
|
531 | + */ |
|
532 | + public function getMetaData($path) { |
|
533 | + return $this->storage->getMetaData($this->findPathToUse($path)); |
|
534 | + } |
|
535 | 535 | } |
@@ -30,114 +30,114 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IDateTimeFormatter { |
33 | - /** |
|
34 | - * Formats the date of the given timestamp |
|
35 | - * |
|
36 | - * @param int|\DateTime $timestamp |
|
37 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
38 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
39 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
40 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
41 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
42 | - * The exact format is dependent on the language |
|
43 | - * @param \DateTimeZone|null $timeZone The timezone to use |
|
44 | - * @param \OCP\IL10N|null $l The locale to use |
|
45 | - * @return string Formatted date string |
|
46 | - * @since 8.0.0 |
|
47 | - */ |
|
48 | - public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
33 | + /** |
|
34 | + * Formats the date of the given timestamp |
|
35 | + * |
|
36 | + * @param int|\DateTime $timestamp |
|
37 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
38 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
39 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
40 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
41 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
42 | + * The exact format is dependent on the language |
|
43 | + * @param \DateTimeZone|null $timeZone The timezone to use |
|
44 | + * @param \OCP\IL10N|null $l The locale to use |
|
45 | + * @return string Formatted date string |
|
46 | + * @since 8.0.0 |
|
47 | + */ |
|
48 | + public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Formats the date of the given timestamp |
|
52 | - * |
|
53 | - * @param int|\DateTime $timestamp |
|
54 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
55 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
56 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
57 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
58 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
59 | - * The exact format is dependent on the language |
|
60 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
61 | - * @param \DateTimeZone|null $timeZone The timezone to use |
|
62 | - * @param \OCP\IL10N|null $l The locale to use |
|
63 | - * @return string Formatted relative date string |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
50 | + /** |
|
51 | + * Formats the date of the given timestamp |
|
52 | + * |
|
53 | + * @param int|\DateTime $timestamp |
|
54 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
55 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
56 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
57 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
58 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
59 | + * The exact format is dependent on the language |
|
60 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
61 | + * @param \DateTimeZone|null $timeZone The timezone to use |
|
62 | + * @param \OCP\IL10N|null $l The locale to use |
|
63 | + * @return string Formatted relative date string |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Gives the relative date of the timestamp |
|
70 | - * Only works for past dates |
|
71 | - * |
|
72 | - * @param int|\DateTime $timestamp |
|
73 | - * @param int|\DateTime|null $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
74 | - * @param \OCP\IL10N|null $l The locale to use |
|
75 | - * @return string Dates returned are: |
|
76 | - * < 1 month => Today, Yesterday, n days ago |
|
77 | - * < 13 month => last month, n months ago |
|
78 | - * >= 13 month => last year, n years ago |
|
79 | - * @since 8.0.0 |
|
80 | - */ |
|
81 | - public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
68 | + /** |
|
69 | + * Gives the relative date of the timestamp |
|
70 | + * Only works for past dates |
|
71 | + * |
|
72 | + * @param int|\DateTime $timestamp |
|
73 | + * @param int|\DateTime|null $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
74 | + * @param \OCP\IL10N|null $l The locale to use |
|
75 | + * @return string Dates returned are: |
|
76 | + * < 1 month => Today, Yesterday, n days ago |
|
77 | + * < 13 month => last month, n months ago |
|
78 | + * >= 13 month => last year, n years ago |
|
79 | + * @since 8.0.0 |
|
80 | + */ |
|
81 | + public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
82 | 82 | |
83 | - /** |
|
84 | - * Formats the time of the given timestamp |
|
85 | - * |
|
86 | - * @param int|\DateTime $timestamp |
|
87 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
88 | - * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
89 | - * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
90 | - * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
91 | - * short: e.g. 'h:mm a' => '11:42 AM' |
|
92 | - * The exact format is dependent on the language |
|
93 | - * @param \DateTimeZone|null $timeZone The timezone to use |
|
94 | - * @param \OCP\IL10N|null $l The locale to use |
|
95 | - * @return string Formatted time string |
|
96 | - * @since 8.0.0 |
|
97 | - */ |
|
98 | - public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
83 | + /** |
|
84 | + * Formats the time of the given timestamp |
|
85 | + * |
|
86 | + * @param int|\DateTime $timestamp |
|
87 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
88 | + * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
89 | + * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
90 | + * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
91 | + * short: e.g. 'h:mm a' => '11:42 AM' |
|
92 | + * The exact format is dependent on the language |
|
93 | + * @param \DateTimeZone|null $timeZone The timezone to use |
|
94 | + * @param \OCP\IL10N|null $l The locale to use |
|
95 | + * @return string Formatted time string |
|
96 | + * @since 8.0.0 |
|
97 | + */ |
|
98 | + public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
99 | 99 | |
100 | - /** |
|
101 | - * Gives the relative past time of the timestamp |
|
102 | - * |
|
103 | - * @param int|\DateTime $timestamp |
|
104 | - * @param int|\DateTime|null $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
105 | - * @param \OCP\IL10N|null $l The locale to use |
|
106 | - * @return string Dates returned are: |
|
107 | - * < 60 sec => seconds ago |
|
108 | - * < 1 hour => n minutes ago |
|
109 | - * < 1 day => n hours ago |
|
110 | - * < 1 month => Yesterday, n days ago |
|
111 | - * < 13 month => last month, n months ago |
|
112 | - * >= 13 month => last year, n years ago |
|
113 | - * @since 8.0.0 |
|
114 | - */ |
|
115 | - public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
100 | + /** |
|
101 | + * Gives the relative past time of the timestamp |
|
102 | + * |
|
103 | + * @param int|\DateTime $timestamp |
|
104 | + * @param int|\DateTime|null $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
105 | + * @param \OCP\IL10N|null $l The locale to use |
|
106 | + * @return string Dates returned are: |
|
107 | + * < 60 sec => seconds ago |
|
108 | + * < 1 hour => n minutes ago |
|
109 | + * < 1 day => n hours ago |
|
110 | + * < 1 month => Yesterday, n days ago |
|
111 | + * < 13 month => last month, n months ago |
|
112 | + * >= 13 month => last year, n years ago |
|
113 | + * @since 8.0.0 |
|
114 | + */ |
|
115 | + public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
116 | 116 | |
117 | - /** |
|
118 | - * Formats the date and time of the given timestamp |
|
119 | - * |
|
120 | - * @param int|\DateTime $timestamp |
|
121 | - * @param string $formatDate See formatDate() for description |
|
122 | - * @param string $formatTime See formatTime() for description |
|
123 | - * @param \DateTimeZone|null $timeZone The timezone to use |
|
124 | - * @param \OCP\IL10N|null $l The locale to use |
|
125 | - * @return string Formatted date and time string |
|
126 | - * @since 8.0.0 |
|
127 | - */ |
|
128 | - public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
117 | + /** |
|
118 | + * Formats the date and time of the given timestamp |
|
119 | + * |
|
120 | + * @param int|\DateTime $timestamp |
|
121 | + * @param string $formatDate See formatDate() for description |
|
122 | + * @param string $formatTime See formatTime() for description |
|
123 | + * @param \DateTimeZone|null $timeZone The timezone to use |
|
124 | + * @param \OCP\IL10N|null $l The locale to use |
|
125 | + * @return string Formatted date and time string |
|
126 | + * @since 8.0.0 |
|
127 | + */ |
|
128 | + public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
129 | 129 | |
130 | - /** |
|
131 | - * Formats the date and time of the given timestamp |
|
132 | - * |
|
133 | - * @param int|\DateTime $timestamp |
|
134 | - * @param string $formatDate See formatDate() for description |
|
135 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
136 | - * @param string $formatTime See formatTime() for description |
|
137 | - * @param \DateTimeZone|null $timeZone The timezone to use |
|
138 | - * @param \OCP\IL10N|null $l The locale to use |
|
139 | - * @return string Formatted relative date and time string |
|
140 | - * @since 8.0.0 |
|
141 | - */ |
|
142 | - public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
130 | + /** |
|
131 | + * Formats the date and time of the given timestamp |
|
132 | + * |
|
133 | + * @param int|\DateTime $timestamp |
|
134 | + * @param string $formatDate See formatDate() for description |
|
135 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
136 | + * @param string $formatTime See formatTime() for description |
|
137 | + * @param \DateTimeZone|null $timeZone The timezone to use |
|
138 | + * @param \OCP\IL10N|null $l The locale to use |
|
139 | + * @return string Formatted relative date and time string |
|
140 | + * @since 8.0.0 |
|
141 | + */ |
|
142 | + public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
143 | 143 | } |