@@ -124,6 +124,9 @@ |
||
124 | 124 | return $nextPrefix; |
125 | 125 | } |
126 | 126 | |
127 | + /** |
|
128 | + * @param string $value |
|
129 | + */ |
|
127 | 130 | private function getServersConfig($value) { |
128 | 131 | $regex = '/' . $value . '$/S'; |
129 | 132 |
@@ -34,126 +34,126 @@ discard block |
||
34 | 34 | |
35 | 35 | class Helper { |
36 | 36 | |
37 | - /** @var IConfig */ |
|
38 | - private $config; |
|
39 | - |
|
40 | - /** |
|
41 | - * Helper constructor. |
|
42 | - * |
|
43 | - * @param IConfig $config |
|
44 | - */ |
|
45 | - public function __construct(IConfig $config) { |
|
46 | - $this->config = $config; |
|
47 | - } |
|
48 | - |
|
49 | - /** |
|
50 | - * returns prefixes for each saved LDAP/AD server configuration. |
|
51 | - * @param bool $activeConfigurations optional, whether only active configuration shall be |
|
52 | - * retrieved, defaults to false |
|
53 | - * @return array with a list of the available prefixes |
|
54 | - * |
|
55 | - * Configuration prefixes are used to set up configurations for n LDAP or |
|
56 | - * AD servers. Since configuration is stored in the database, table |
|
57 | - * appconfig under appid user_ldap, the common identifiers in column |
|
58 | - * 'configkey' have a prefix. The prefix for the very first server |
|
59 | - * configuration is empty. |
|
60 | - * Configkey Examples: |
|
61 | - * Server 1: ldap_login_filter |
|
62 | - * Server 2: s1_ldap_login_filter |
|
63 | - * Server 3: s2_ldap_login_filter |
|
64 | - * |
|
65 | - * The prefix needs to be passed to the constructor of Connection class, |
|
66 | - * except the default (first) server shall be connected to. |
|
67 | - * |
|
68 | - */ |
|
69 | - public function getServerConfigurationPrefixes($activeConfigurations = false) { |
|
70 | - $referenceConfigkey = 'ldap_configuration_active'; |
|
71 | - |
|
72 | - $keys = $this->getServersConfig($referenceConfigkey); |
|
73 | - |
|
74 | - $prefixes = []; |
|
75 | - foreach ($keys as $key) { |
|
76 | - if ($activeConfigurations && $this->config->getAppValue('user_ldap', $key, '0') !== '1') { |
|
77 | - continue; |
|
78 | - } |
|
79 | - |
|
80 | - $len = strlen($key) - strlen($referenceConfigkey); |
|
81 | - $prefixes[] = substr($key, 0, $len); |
|
82 | - } |
|
83 | - |
|
84 | - return $prefixes; |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * |
|
89 | - * determines the host for every configured connection |
|
90 | - * @return array an array with configprefix as keys |
|
91 | - * |
|
92 | - */ |
|
93 | - public function getServerConfigurationHosts() { |
|
94 | - $referenceConfigkey = 'ldap_host'; |
|
95 | - |
|
96 | - $keys = $this->getServersConfig($referenceConfigkey); |
|
97 | - |
|
98 | - $result = array(); |
|
99 | - foreach($keys as $key) { |
|
100 | - $len = strlen($key) - strlen($referenceConfigkey); |
|
101 | - $prefix = substr($key, 0, $len); |
|
102 | - $result[$prefix] = $this->config->getAppValue('user_ldap', $key); |
|
103 | - } |
|
104 | - |
|
105 | - return $result; |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * return the next available configuration prefix |
|
110 | - * |
|
111 | - * @return string |
|
112 | - */ |
|
113 | - public function getNextServerConfigurationPrefix() { |
|
114 | - $serverConnections = $this->getServerConfigurationPrefixes(); |
|
115 | - |
|
116 | - if(count($serverConnections) === 0) { |
|
117 | - return 's01'; |
|
118 | - } |
|
119 | - |
|
120 | - sort($serverConnections); |
|
121 | - $lastKey = array_pop($serverConnections); |
|
122 | - $lastNumber = intval(str_replace('s', '', $lastKey)); |
|
123 | - $nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT); |
|
124 | - return $nextPrefix; |
|
125 | - } |
|
126 | - |
|
127 | - private function getServersConfig($value) { |
|
128 | - $regex = '/' . $value . '$/S'; |
|
129 | - |
|
130 | - $keys = $this->config->getAppKeys('user_ldap'); |
|
131 | - $result = []; |
|
132 | - foreach ($keys as $key) { |
|
133 | - if (preg_match($regex, $key) === 1) { |
|
134 | - $result[] = $key; |
|
135 | - } |
|
136 | - } |
|
137 | - |
|
138 | - return $result; |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * deletes a given saved LDAP/AD server configuration. |
|
143 | - * @param string $prefix the configuration prefix of the config to delete |
|
144 | - * @return bool true on success, false otherwise |
|
145 | - */ |
|
146 | - public function deleteServerConfiguration($prefix) { |
|
147 | - if(!in_array($prefix, self::getServerConfigurationPrefixes())) { |
|
148 | - return false; |
|
149 | - } |
|
150 | - |
|
151 | - $saveOtherConfigurations = ''; |
|
152 | - if(empty($prefix)) { |
|
153 | - $saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\''; |
|
154 | - } |
|
155 | - |
|
156 | - $query = \OCP\DB::prepare(' |
|
37 | + /** @var IConfig */ |
|
38 | + private $config; |
|
39 | + |
|
40 | + /** |
|
41 | + * Helper constructor. |
|
42 | + * |
|
43 | + * @param IConfig $config |
|
44 | + */ |
|
45 | + public function __construct(IConfig $config) { |
|
46 | + $this->config = $config; |
|
47 | + } |
|
48 | + |
|
49 | + /** |
|
50 | + * returns prefixes for each saved LDAP/AD server configuration. |
|
51 | + * @param bool $activeConfigurations optional, whether only active configuration shall be |
|
52 | + * retrieved, defaults to false |
|
53 | + * @return array with a list of the available prefixes |
|
54 | + * |
|
55 | + * Configuration prefixes are used to set up configurations for n LDAP or |
|
56 | + * AD servers. Since configuration is stored in the database, table |
|
57 | + * appconfig under appid user_ldap, the common identifiers in column |
|
58 | + * 'configkey' have a prefix. The prefix for the very first server |
|
59 | + * configuration is empty. |
|
60 | + * Configkey Examples: |
|
61 | + * Server 1: ldap_login_filter |
|
62 | + * Server 2: s1_ldap_login_filter |
|
63 | + * Server 3: s2_ldap_login_filter |
|
64 | + * |
|
65 | + * The prefix needs to be passed to the constructor of Connection class, |
|
66 | + * except the default (first) server shall be connected to. |
|
67 | + * |
|
68 | + */ |
|
69 | + public function getServerConfigurationPrefixes($activeConfigurations = false) { |
|
70 | + $referenceConfigkey = 'ldap_configuration_active'; |
|
71 | + |
|
72 | + $keys = $this->getServersConfig($referenceConfigkey); |
|
73 | + |
|
74 | + $prefixes = []; |
|
75 | + foreach ($keys as $key) { |
|
76 | + if ($activeConfigurations && $this->config->getAppValue('user_ldap', $key, '0') !== '1') { |
|
77 | + continue; |
|
78 | + } |
|
79 | + |
|
80 | + $len = strlen($key) - strlen($referenceConfigkey); |
|
81 | + $prefixes[] = substr($key, 0, $len); |
|
82 | + } |
|
83 | + |
|
84 | + return $prefixes; |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * |
|
89 | + * determines the host for every configured connection |
|
90 | + * @return array an array with configprefix as keys |
|
91 | + * |
|
92 | + */ |
|
93 | + public function getServerConfigurationHosts() { |
|
94 | + $referenceConfigkey = 'ldap_host'; |
|
95 | + |
|
96 | + $keys = $this->getServersConfig($referenceConfigkey); |
|
97 | + |
|
98 | + $result = array(); |
|
99 | + foreach($keys as $key) { |
|
100 | + $len = strlen($key) - strlen($referenceConfigkey); |
|
101 | + $prefix = substr($key, 0, $len); |
|
102 | + $result[$prefix] = $this->config->getAppValue('user_ldap', $key); |
|
103 | + } |
|
104 | + |
|
105 | + return $result; |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * return the next available configuration prefix |
|
110 | + * |
|
111 | + * @return string |
|
112 | + */ |
|
113 | + public function getNextServerConfigurationPrefix() { |
|
114 | + $serverConnections = $this->getServerConfigurationPrefixes(); |
|
115 | + |
|
116 | + if(count($serverConnections) === 0) { |
|
117 | + return 's01'; |
|
118 | + } |
|
119 | + |
|
120 | + sort($serverConnections); |
|
121 | + $lastKey = array_pop($serverConnections); |
|
122 | + $lastNumber = intval(str_replace('s', '', $lastKey)); |
|
123 | + $nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT); |
|
124 | + return $nextPrefix; |
|
125 | + } |
|
126 | + |
|
127 | + private function getServersConfig($value) { |
|
128 | + $regex = '/' . $value . '$/S'; |
|
129 | + |
|
130 | + $keys = $this->config->getAppKeys('user_ldap'); |
|
131 | + $result = []; |
|
132 | + foreach ($keys as $key) { |
|
133 | + if (preg_match($regex, $key) === 1) { |
|
134 | + $result[] = $key; |
|
135 | + } |
|
136 | + } |
|
137 | + |
|
138 | + return $result; |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * deletes a given saved LDAP/AD server configuration. |
|
143 | + * @param string $prefix the configuration prefix of the config to delete |
|
144 | + * @return bool true on success, false otherwise |
|
145 | + */ |
|
146 | + public function deleteServerConfiguration($prefix) { |
|
147 | + if(!in_array($prefix, self::getServerConfigurationPrefixes())) { |
|
148 | + return false; |
|
149 | + } |
|
150 | + |
|
151 | + $saveOtherConfigurations = ''; |
|
152 | + if(empty($prefix)) { |
|
153 | + $saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\''; |
|
154 | + } |
|
155 | + |
|
156 | + $query = \OCP\DB::prepare(' |
|
157 | 157 | DELETE |
158 | 158 | FROM `*PREFIX*appconfig` |
159 | 159 | WHERE `configkey` LIKE ? |
@@ -161,147 +161,147 @@ discard block |
||
161 | 161 | AND `appid` = \'user_ldap\' |
162 | 162 | AND `configkey` NOT IN (\'enabled\', \'installed_version\', \'types\', \'bgjUpdateGroupsLastRun\') |
163 | 163 | '); |
164 | - $delRows = $query->execute(array($prefix.'%')); |
|
165 | - |
|
166 | - if(\OCP\DB::isError($delRows)) { |
|
167 | - return false; |
|
168 | - } |
|
169 | - |
|
170 | - if($delRows === 0) { |
|
171 | - return false; |
|
172 | - } |
|
173 | - |
|
174 | - return true; |
|
175 | - } |
|
176 | - |
|
177 | - /** |
|
178 | - * checks whether there is one or more disabled LDAP configurations |
|
179 | - * @throws \Exception |
|
180 | - * @return bool |
|
181 | - */ |
|
182 | - public function haveDisabledConfigurations() { |
|
183 | - $all = $this->getServerConfigurationPrefixes(false); |
|
184 | - $active = $this->getServerConfigurationPrefixes(true); |
|
185 | - |
|
186 | - if(!is_array($all) || !is_array($active)) { |
|
187 | - throw new \Exception('Unexpected Return Value'); |
|
188 | - } |
|
189 | - |
|
190 | - return count($all) !== count($active) || count($all) === 0; |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * extracts the domain from a given URL |
|
195 | - * @param string $url the URL |
|
196 | - * @return string|false domain as string on success, false otherwise |
|
197 | - */ |
|
198 | - public function getDomainFromURL($url) { |
|
199 | - $uinfo = parse_url($url); |
|
200 | - if(!is_array($uinfo)) { |
|
201 | - return false; |
|
202 | - } |
|
203 | - |
|
204 | - $domain = false; |
|
205 | - if(isset($uinfo['host'])) { |
|
206 | - $domain = $uinfo['host']; |
|
207 | - } else if(isset($uinfo['path'])) { |
|
208 | - $domain = $uinfo['path']; |
|
209 | - } |
|
210 | - |
|
211 | - return $domain; |
|
212 | - } |
|
164 | + $delRows = $query->execute(array($prefix.'%')); |
|
165 | + |
|
166 | + if(\OCP\DB::isError($delRows)) { |
|
167 | + return false; |
|
168 | + } |
|
169 | + |
|
170 | + if($delRows === 0) { |
|
171 | + return false; |
|
172 | + } |
|
173 | + |
|
174 | + return true; |
|
175 | + } |
|
176 | + |
|
177 | + /** |
|
178 | + * checks whether there is one or more disabled LDAP configurations |
|
179 | + * @throws \Exception |
|
180 | + * @return bool |
|
181 | + */ |
|
182 | + public function haveDisabledConfigurations() { |
|
183 | + $all = $this->getServerConfigurationPrefixes(false); |
|
184 | + $active = $this->getServerConfigurationPrefixes(true); |
|
185 | + |
|
186 | + if(!is_array($all) || !is_array($active)) { |
|
187 | + throw new \Exception('Unexpected Return Value'); |
|
188 | + } |
|
189 | + |
|
190 | + return count($all) !== count($active) || count($all) === 0; |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * extracts the domain from a given URL |
|
195 | + * @param string $url the URL |
|
196 | + * @return string|false domain as string on success, false otherwise |
|
197 | + */ |
|
198 | + public function getDomainFromURL($url) { |
|
199 | + $uinfo = parse_url($url); |
|
200 | + if(!is_array($uinfo)) { |
|
201 | + return false; |
|
202 | + } |
|
203 | + |
|
204 | + $domain = false; |
|
205 | + if(isset($uinfo['host'])) { |
|
206 | + $domain = $uinfo['host']; |
|
207 | + } else if(isset($uinfo['path'])) { |
|
208 | + $domain = $uinfo['path']; |
|
209 | + } |
|
210 | + |
|
211 | + return $domain; |
|
212 | + } |
|
213 | 213 | |
214 | - /** |
|
215 | - * |
|
216 | - * Set the LDAPProvider in the config |
|
217 | - * |
|
218 | - */ |
|
219 | - public function setLDAPProvider() { |
|
220 | - $current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null); |
|
221 | - if(is_null($current)) { |
|
222 | - \OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory'); |
|
223 | - } |
|
224 | - } |
|
214 | + /** |
|
215 | + * |
|
216 | + * Set the LDAPProvider in the config |
|
217 | + * |
|
218 | + */ |
|
219 | + public function setLDAPProvider() { |
|
220 | + $current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null); |
|
221 | + if(is_null($current)) { |
|
222 | + \OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory'); |
|
223 | + } |
|
224 | + } |
|
225 | 225 | |
226 | - /** |
|
227 | - * sanitizes a DN received from the LDAP server |
|
228 | - * @param array $dn the DN in question |
|
229 | - * @return array the sanitized DN |
|
230 | - */ |
|
231 | - public function sanitizeDN($dn) { |
|
232 | - //treating multiple base DNs |
|
233 | - if(is_array($dn)) { |
|
234 | - $result = array(); |
|
235 | - foreach($dn as $singleDN) { |
|
236 | - $result[] = $this->sanitizeDN($singleDN); |
|
237 | - } |
|
238 | - return $result; |
|
239 | - } |
|
240 | - |
|
241 | - //OID sometimes gives back DNs with whitespace after the comma |
|
242 | - // a la "uid=foo, cn=bar, dn=..." We need to tackle this! |
|
243 | - $dn = preg_replace('/([^\\\]),(\s+)/u', '\1,', $dn); |
|
244 | - |
|
245 | - //make comparisons and everything work |
|
246 | - $dn = mb_strtolower($dn, 'UTF-8'); |
|
247 | - |
|
248 | - //escape DN values according to RFC 2253 – this is already done by ldap_explode_dn |
|
249 | - //to use the DN in search filters, \ needs to be escaped to \5c additionally |
|
250 | - //to use them in bases, we convert them back to simple backslashes in readAttribute() |
|
251 | - $replacements = array( |
|
252 | - '\,' => '\5c2C', |
|
253 | - '\=' => '\5c3D', |
|
254 | - '\+' => '\5c2B', |
|
255 | - '\<' => '\5c3C', |
|
256 | - '\>' => '\5c3E', |
|
257 | - '\;' => '\5c3B', |
|
258 | - '\"' => '\5c22', |
|
259 | - '\#' => '\5c23', |
|
260 | - '(' => '\28', |
|
261 | - ')' => '\29', |
|
262 | - '*' => '\2A', |
|
263 | - ); |
|
264 | - $dn = str_replace(array_keys($replacements), array_values($replacements), $dn); |
|
265 | - |
|
266 | - return $dn; |
|
267 | - } |
|
226 | + /** |
|
227 | + * sanitizes a DN received from the LDAP server |
|
228 | + * @param array $dn the DN in question |
|
229 | + * @return array the sanitized DN |
|
230 | + */ |
|
231 | + public function sanitizeDN($dn) { |
|
232 | + //treating multiple base DNs |
|
233 | + if(is_array($dn)) { |
|
234 | + $result = array(); |
|
235 | + foreach($dn as $singleDN) { |
|
236 | + $result[] = $this->sanitizeDN($singleDN); |
|
237 | + } |
|
238 | + return $result; |
|
239 | + } |
|
240 | + |
|
241 | + //OID sometimes gives back DNs with whitespace after the comma |
|
242 | + // a la "uid=foo, cn=bar, dn=..." We need to tackle this! |
|
243 | + $dn = preg_replace('/([^\\\]),(\s+)/u', '\1,', $dn); |
|
244 | + |
|
245 | + //make comparisons and everything work |
|
246 | + $dn = mb_strtolower($dn, 'UTF-8'); |
|
247 | + |
|
248 | + //escape DN values according to RFC 2253 – this is already done by ldap_explode_dn |
|
249 | + //to use the DN in search filters, \ needs to be escaped to \5c additionally |
|
250 | + //to use them in bases, we convert them back to simple backslashes in readAttribute() |
|
251 | + $replacements = array( |
|
252 | + '\,' => '\5c2C', |
|
253 | + '\=' => '\5c3D', |
|
254 | + '\+' => '\5c2B', |
|
255 | + '\<' => '\5c3C', |
|
256 | + '\>' => '\5c3E', |
|
257 | + '\;' => '\5c3B', |
|
258 | + '\"' => '\5c22', |
|
259 | + '\#' => '\5c23', |
|
260 | + '(' => '\28', |
|
261 | + ')' => '\29', |
|
262 | + '*' => '\2A', |
|
263 | + ); |
|
264 | + $dn = str_replace(array_keys($replacements), array_values($replacements), $dn); |
|
265 | + |
|
266 | + return $dn; |
|
267 | + } |
|
268 | 268 | |
269 | - /** |
|
270 | - * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters |
|
271 | - * @param string $dn the DN |
|
272 | - * @return string |
|
273 | - */ |
|
274 | - public function DNasBaseParameter($dn) { |
|
275 | - return str_ireplace('\\5c', '\\', $dn); |
|
276 | - } |
|
277 | - |
|
278 | - /** |
|
279 | - * listens to a hook thrown by server2server sharing and replaces the given |
|
280 | - * login name by a username, if it matches an LDAP user. |
|
281 | - * |
|
282 | - * @param array $param |
|
283 | - * @throws \Exception |
|
284 | - */ |
|
285 | - public static function loginName2UserName($param) { |
|
286 | - if(!isset($param['uid'])) { |
|
287 | - throw new \Exception('key uid is expected to be set in $param'); |
|
288 | - } |
|
289 | - |
|
290 | - //ain't it ironic? |
|
291 | - $helper = new Helper(\OC::$server->getConfig()); |
|
292 | - |
|
293 | - $configPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
294 | - $ldapWrapper = new LDAP(); |
|
295 | - $ocConfig = \OC::$server->getConfig(); |
|
296 | - $notificationManager = \OC::$server->getNotificationManager(); |
|
297 | - $userSession = \OC::$server->getUserSession(); |
|
298 | - |
|
299 | - $userBackend = new User_Proxy( |
|
300 | - $configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession |
|
301 | - ); |
|
302 | - $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
303 | - if($uid !== false) { |
|
304 | - $param['uid'] = $uid; |
|
305 | - } |
|
306 | - } |
|
269 | + /** |
|
270 | + * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters |
|
271 | + * @param string $dn the DN |
|
272 | + * @return string |
|
273 | + */ |
|
274 | + public function DNasBaseParameter($dn) { |
|
275 | + return str_ireplace('\\5c', '\\', $dn); |
|
276 | + } |
|
277 | + |
|
278 | + /** |
|
279 | + * listens to a hook thrown by server2server sharing and replaces the given |
|
280 | + * login name by a username, if it matches an LDAP user. |
|
281 | + * |
|
282 | + * @param array $param |
|
283 | + * @throws \Exception |
|
284 | + */ |
|
285 | + public static function loginName2UserName($param) { |
|
286 | + if(!isset($param['uid'])) { |
|
287 | + throw new \Exception('key uid is expected to be set in $param'); |
|
288 | + } |
|
289 | + |
|
290 | + //ain't it ironic? |
|
291 | + $helper = new Helper(\OC::$server->getConfig()); |
|
292 | + |
|
293 | + $configPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
294 | + $ldapWrapper = new LDAP(); |
|
295 | + $ocConfig = \OC::$server->getConfig(); |
|
296 | + $notificationManager = \OC::$server->getNotificationManager(); |
|
297 | + $userSession = \OC::$server->getUserSession(); |
|
298 | + |
|
299 | + $userBackend = new User_Proxy( |
|
300 | + $configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession |
|
301 | + ); |
|
302 | + $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
303 | + if($uid !== false) { |
|
304 | + $param['uid'] = $uid; |
|
305 | + } |
|
306 | + } |
|
307 | 307 | } |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | $keys = $this->getServersConfig($referenceConfigkey); |
97 | 97 | |
98 | 98 | $result = array(); |
99 | - foreach($keys as $key) { |
|
99 | + foreach ($keys as $key) { |
|
100 | 100 | $len = strlen($key) - strlen($referenceConfigkey); |
101 | 101 | $prefix = substr($key, 0, $len); |
102 | 102 | $result[$prefix] = $this->config->getAppValue('user_ldap', $key); |
@@ -113,19 +113,19 @@ discard block |
||
113 | 113 | public function getNextServerConfigurationPrefix() { |
114 | 114 | $serverConnections = $this->getServerConfigurationPrefixes(); |
115 | 115 | |
116 | - if(count($serverConnections) === 0) { |
|
116 | + if (count($serverConnections) === 0) { |
|
117 | 117 | return 's01'; |
118 | 118 | } |
119 | 119 | |
120 | 120 | sort($serverConnections); |
121 | 121 | $lastKey = array_pop($serverConnections); |
122 | 122 | $lastNumber = intval(str_replace('s', '', $lastKey)); |
123 | - $nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT); |
|
123 | + $nextPrefix = 's'.str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT); |
|
124 | 124 | return $nextPrefix; |
125 | 125 | } |
126 | 126 | |
127 | 127 | private function getServersConfig($value) { |
128 | - $regex = '/' . $value . '$/S'; |
|
128 | + $regex = '/'.$value.'$/S'; |
|
129 | 129 | |
130 | 130 | $keys = $this->config->getAppKeys('user_ldap'); |
131 | 131 | $result = []; |
@@ -144,12 +144,12 @@ discard block |
||
144 | 144 | * @return bool true on success, false otherwise |
145 | 145 | */ |
146 | 146 | public function deleteServerConfiguration($prefix) { |
147 | - if(!in_array($prefix, self::getServerConfigurationPrefixes())) { |
|
147 | + if (!in_array($prefix, self::getServerConfigurationPrefixes())) { |
|
148 | 148 | return false; |
149 | 149 | } |
150 | 150 | |
151 | 151 | $saveOtherConfigurations = ''; |
152 | - if(empty($prefix)) { |
|
152 | + if (empty($prefix)) { |
|
153 | 153 | $saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\''; |
154 | 154 | } |
155 | 155 | |
@@ -163,11 +163,11 @@ discard block |
||
163 | 163 | '); |
164 | 164 | $delRows = $query->execute(array($prefix.'%')); |
165 | 165 | |
166 | - if(\OCP\DB::isError($delRows)) { |
|
166 | + if (\OCP\DB::isError($delRows)) { |
|
167 | 167 | return false; |
168 | 168 | } |
169 | 169 | |
170 | - if($delRows === 0) { |
|
170 | + if ($delRows === 0) { |
|
171 | 171 | return false; |
172 | 172 | } |
173 | 173 | |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | $all = $this->getServerConfigurationPrefixes(false); |
184 | 184 | $active = $this->getServerConfigurationPrefixes(true); |
185 | 185 | |
186 | - if(!is_array($all) || !is_array($active)) { |
|
186 | + if (!is_array($all) || !is_array($active)) { |
|
187 | 187 | throw new \Exception('Unexpected Return Value'); |
188 | 188 | } |
189 | 189 | |
@@ -197,14 +197,14 @@ discard block |
||
197 | 197 | */ |
198 | 198 | public function getDomainFromURL($url) { |
199 | 199 | $uinfo = parse_url($url); |
200 | - if(!is_array($uinfo)) { |
|
200 | + if (!is_array($uinfo)) { |
|
201 | 201 | return false; |
202 | 202 | } |
203 | 203 | |
204 | 204 | $domain = false; |
205 | - if(isset($uinfo['host'])) { |
|
205 | + if (isset($uinfo['host'])) { |
|
206 | 206 | $domain = $uinfo['host']; |
207 | - } else if(isset($uinfo['path'])) { |
|
207 | + } else if (isset($uinfo['path'])) { |
|
208 | 208 | $domain = $uinfo['path']; |
209 | 209 | } |
210 | 210 | |
@@ -218,7 +218,7 @@ discard block |
||
218 | 218 | */ |
219 | 219 | public function setLDAPProvider() { |
220 | 220 | $current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null); |
221 | - if(is_null($current)) { |
|
221 | + if (is_null($current)) { |
|
222 | 222 | \OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory'); |
223 | 223 | } |
224 | 224 | } |
@@ -230,9 +230,9 @@ discard block |
||
230 | 230 | */ |
231 | 231 | public function sanitizeDN($dn) { |
232 | 232 | //treating multiple base DNs |
233 | - if(is_array($dn)) { |
|
233 | + if (is_array($dn)) { |
|
234 | 234 | $result = array(); |
235 | - foreach($dn as $singleDN) { |
|
235 | + foreach ($dn as $singleDN) { |
|
236 | 236 | $result[] = $this->sanitizeDN($singleDN); |
237 | 237 | } |
238 | 238 | return $result; |
@@ -283,7 +283,7 @@ discard block |
||
283 | 283 | * @throws \Exception |
284 | 284 | */ |
285 | 285 | public static function loginName2UserName($param) { |
286 | - if(!isset($param['uid'])) { |
|
286 | + if (!isset($param['uid'])) { |
|
287 | 287 | throw new \Exception('key uid is expected to be set in $param'); |
288 | 288 | } |
289 | 289 | |
@@ -296,11 +296,11 @@ discard block |
||
296 | 296 | $notificationManager = \OC::$server->getNotificationManager(); |
297 | 297 | $userSession = \OC::$server->getUserSession(); |
298 | 298 | |
299 | - $userBackend = new User_Proxy( |
|
299 | + $userBackend = new User_Proxy( |
|
300 | 300 | $configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession |
301 | 301 | ); |
302 | - $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
303 | - if($uid !== false) { |
|
302 | + $uid = $userBackend->loginName2UserName($param['uid']); |
|
303 | + if ($uid !== false) { |
|
304 | 304 | $param['uid'] = $uid; |
305 | 305 | } |
306 | 306 | } |
@@ -104,6 +104,10 @@ |
||
104 | 104 | // TODO: dont check/enforce 2FA if a auth token is used |
105 | 105 | } |
106 | 106 | |
107 | + /** |
|
108 | + * @param Controller $controller |
|
109 | + * @param string $methodName |
|
110 | + */ |
|
107 | 111 | private function checkTwoFactor($controller, $methodName, IUser $user) { |
108 | 112 | // If two-factor auth is in progress disallow access to any controllers |
109 | 113 | // defined within "LoginController". |
@@ -41,100 +41,100 @@ |
||
41 | 41 | |
42 | 42 | class TwoFactorMiddleware extends Middleware { |
43 | 43 | |
44 | - /** @var Manager */ |
|
45 | - private $twoFactorManager; |
|
46 | - |
|
47 | - /** @var Session */ |
|
48 | - private $userSession; |
|
49 | - |
|
50 | - /** @var ISession */ |
|
51 | - private $session; |
|
52 | - |
|
53 | - /** @var IURLGenerator */ |
|
54 | - private $urlGenerator; |
|
55 | - |
|
56 | - /** @var IControllerMethodReflector */ |
|
57 | - private $reflector; |
|
58 | - |
|
59 | - /** @var IRequest */ |
|
60 | - private $request; |
|
61 | - |
|
62 | - /** |
|
63 | - * @param Manager $twoFactorManager |
|
64 | - * @param Session $userSession |
|
65 | - * @param ISession $session |
|
66 | - * @param IURLGenerator $urlGenerator |
|
67 | - */ |
|
68 | - public function __construct(Manager $twoFactorManager, Session $userSession, ISession $session, |
|
69 | - IURLGenerator $urlGenerator, IControllerMethodReflector $reflector, IRequest $request) { |
|
70 | - $this->twoFactorManager = $twoFactorManager; |
|
71 | - $this->userSession = $userSession; |
|
72 | - $this->session = $session; |
|
73 | - $this->urlGenerator = $urlGenerator; |
|
74 | - $this->reflector = $reflector; |
|
75 | - $this->request = $request; |
|
76 | - } |
|
77 | - |
|
78 | - /** |
|
79 | - * @param Controller $controller |
|
80 | - * @param string $methodName |
|
81 | - */ |
|
82 | - public function beforeController($controller, $methodName) { |
|
83 | - if ($this->reflector->hasAnnotation('PublicPage')) { |
|
84 | - // Don't block public pages |
|
85 | - return; |
|
86 | - } |
|
87 | - |
|
88 | - if ($controller instanceof LoginController && $methodName === 'logout') { |
|
89 | - // Don't block the logout page, to allow canceling the 2FA |
|
90 | - return; |
|
91 | - } |
|
92 | - |
|
93 | - if ($this->userSession->isLoggedIn()) { |
|
94 | - $user = $this->userSession->getUser(); |
|
95 | - |
|
96 | - if ($this->twoFactorManager->isTwoFactorAuthenticated($user)) { |
|
97 | - $this->checkTwoFactor($controller, $methodName, $user); |
|
98 | - } else if ($controller instanceof TwoFactorChallengeController) { |
|
99 | - // Allow access to the two-factor controllers only if two-factor authentication |
|
100 | - // is in progress. |
|
101 | - throw new UserAlreadyLoggedInException(); |
|
102 | - } |
|
103 | - } |
|
104 | - // TODO: dont check/enforce 2FA if a auth token is used |
|
105 | - } |
|
106 | - |
|
107 | - private function checkTwoFactor($controller, $methodName, IUser $user) { |
|
108 | - // If two-factor auth is in progress disallow access to any controllers |
|
109 | - // defined within "LoginController". |
|
110 | - $needsSecondFactor = $this->twoFactorManager->needsSecondFactor($user); |
|
111 | - $twoFactor = $controller instanceof TwoFactorChallengeController; |
|
112 | - |
|
113 | - // Disallow access to any controller if 2FA needs to be checked |
|
114 | - if ($needsSecondFactor && !$twoFactor) { |
|
115 | - throw new TwoFactorAuthRequiredException(); |
|
116 | - } |
|
117 | - |
|
118 | - // Allow access to the two-factor controllers only if two-factor authentication |
|
119 | - // is in progress. |
|
120 | - if (!$needsSecondFactor && $twoFactor) { |
|
121 | - throw new UserAlreadyLoggedInException(); |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - public function afterException($controller, $methodName, Exception $exception) { |
|
126 | - if ($exception instanceof TwoFactorAuthRequiredException) { |
|
127 | - $params = []; |
|
128 | - if (isset($this->request->server['REQUEST_URI'])) { |
|
129 | - $params['redirect_url'] = $this->request->server['REQUEST_URI']; |
|
130 | - } |
|
131 | - return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', $params)); |
|
132 | - } |
|
133 | - if ($exception instanceof UserAlreadyLoggedInException) { |
|
134 | - return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index')); |
|
135 | - } |
|
136 | - |
|
137 | - throw $exception; |
|
138 | - } |
|
44 | + /** @var Manager */ |
|
45 | + private $twoFactorManager; |
|
46 | + |
|
47 | + /** @var Session */ |
|
48 | + private $userSession; |
|
49 | + |
|
50 | + /** @var ISession */ |
|
51 | + private $session; |
|
52 | + |
|
53 | + /** @var IURLGenerator */ |
|
54 | + private $urlGenerator; |
|
55 | + |
|
56 | + /** @var IControllerMethodReflector */ |
|
57 | + private $reflector; |
|
58 | + |
|
59 | + /** @var IRequest */ |
|
60 | + private $request; |
|
61 | + |
|
62 | + /** |
|
63 | + * @param Manager $twoFactorManager |
|
64 | + * @param Session $userSession |
|
65 | + * @param ISession $session |
|
66 | + * @param IURLGenerator $urlGenerator |
|
67 | + */ |
|
68 | + public function __construct(Manager $twoFactorManager, Session $userSession, ISession $session, |
|
69 | + IURLGenerator $urlGenerator, IControllerMethodReflector $reflector, IRequest $request) { |
|
70 | + $this->twoFactorManager = $twoFactorManager; |
|
71 | + $this->userSession = $userSession; |
|
72 | + $this->session = $session; |
|
73 | + $this->urlGenerator = $urlGenerator; |
|
74 | + $this->reflector = $reflector; |
|
75 | + $this->request = $request; |
|
76 | + } |
|
77 | + |
|
78 | + /** |
|
79 | + * @param Controller $controller |
|
80 | + * @param string $methodName |
|
81 | + */ |
|
82 | + public function beforeController($controller, $methodName) { |
|
83 | + if ($this->reflector->hasAnnotation('PublicPage')) { |
|
84 | + // Don't block public pages |
|
85 | + return; |
|
86 | + } |
|
87 | + |
|
88 | + if ($controller instanceof LoginController && $methodName === 'logout') { |
|
89 | + // Don't block the logout page, to allow canceling the 2FA |
|
90 | + return; |
|
91 | + } |
|
92 | + |
|
93 | + if ($this->userSession->isLoggedIn()) { |
|
94 | + $user = $this->userSession->getUser(); |
|
95 | + |
|
96 | + if ($this->twoFactorManager->isTwoFactorAuthenticated($user)) { |
|
97 | + $this->checkTwoFactor($controller, $methodName, $user); |
|
98 | + } else if ($controller instanceof TwoFactorChallengeController) { |
|
99 | + // Allow access to the two-factor controllers only if two-factor authentication |
|
100 | + // is in progress. |
|
101 | + throw new UserAlreadyLoggedInException(); |
|
102 | + } |
|
103 | + } |
|
104 | + // TODO: dont check/enforce 2FA if a auth token is used |
|
105 | + } |
|
106 | + |
|
107 | + private function checkTwoFactor($controller, $methodName, IUser $user) { |
|
108 | + // If two-factor auth is in progress disallow access to any controllers |
|
109 | + // defined within "LoginController". |
|
110 | + $needsSecondFactor = $this->twoFactorManager->needsSecondFactor($user); |
|
111 | + $twoFactor = $controller instanceof TwoFactorChallengeController; |
|
112 | + |
|
113 | + // Disallow access to any controller if 2FA needs to be checked |
|
114 | + if ($needsSecondFactor && !$twoFactor) { |
|
115 | + throw new TwoFactorAuthRequiredException(); |
|
116 | + } |
|
117 | + |
|
118 | + // Allow access to the two-factor controllers only if two-factor authentication |
|
119 | + // is in progress. |
|
120 | + if (!$needsSecondFactor && $twoFactor) { |
|
121 | + throw new UserAlreadyLoggedInException(); |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + public function afterException($controller, $methodName, Exception $exception) { |
|
126 | + if ($exception instanceof TwoFactorAuthRequiredException) { |
|
127 | + $params = []; |
|
128 | + if (isset($this->request->server['REQUEST_URI'])) { |
|
129 | + $params['redirect_url'] = $this->request->server['REQUEST_URI']; |
|
130 | + } |
|
131 | + return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', $params)); |
|
132 | + } |
|
133 | + if ($exception instanceof UserAlreadyLoggedInException) { |
|
134 | + return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index')); |
|
135 | + } |
|
136 | + |
|
137 | + throw $exception; |
|
138 | + } |
|
139 | 139 | |
140 | 140 | } |
@@ -370,6 +370,7 @@ |
||
370 | 370 | |
371 | 371 | /** |
372 | 372 | * write back temporary files |
373 | + * @param string $path |
|
373 | 374 | */ |
374 | 375 | function writeBack($tmpFile, $path) { |
375 | 376 | $this->addFile($path, $tmpFile); |
@@ -34,199 +34,199 @@ |
||
34 | 34 | use Icewind\Streams\CallbackWrapper; |
35 | 35 | |
36 | 36 | class ZIP extends Archive{ |
37 | - /** |
|
38 | - * @var \ZipArchive zip |
|
39 | - */ |
|
40 | - private $zip=null; |
|
41 | - private $path; |
|
37 | + /** |
|
38 | + * @var \ZipArchive zip |
|
39 | + */ |
|
40 | + private $zip=null; |
|
41 | + private $path; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param string $source |
|
45 | - */ |
|
46 | - function __construct($source) { |
|
47 | - $this->path=$source; |
|
48 | - $this->zip=new \ZipArchive(); |
|
49 | - if($this->zip->open($source, \ZipArchive::CREATE)) { |
|
50 | - }else{ |
|
51 | - \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN); |
|
52 | - } |
|
53 | - } |
|
54 | - /** |
|
55 | - * add an empty folder to the archive |
|
56 | - * @param string $path |
|
57 | - * @return bool |
|
58 | - */ |
|
59 | - function addFolder($path) { |
|
60 | - return $this->zip->addEmptyDir($path); |
|
61 | - } |
|
62 | - /** |
|
63 | - * add a file to the archive |
|
64 | - * @param string $path |
|
65 | - * @param string $source either a local file or string data |
|
66 | - * @return bool |
|
67 | - */ |
|
68 | - function addFile($path, $source='') { |
|
69 | - if($source and $source[0]=='/' and file_exists($source)) { |
|
70 | - $result=$this->zip->addFile($source, $path); |
|
71 | - }else{ |
|
72 | - $result=$this->zip->addFromString($path, $source); |
|
73 | - } |
|
74 | - if($result) { |
|
75 | - $this->zip->close();//close and reopen to save the zip |
|
76 | - $this->zip->open($this->path); |
|
77 | - } |
|
78 | - return $result; |
|
79 | - } |
|
80 | - /** |
|
81 | - * rename a file or folder in the archive |
|
82 | - * @param string $source |
|
83 | - * @param string $dest |
|
84 | - * @return boolean|null |
|
85 | - */ |
|
86 | - function rename($source, $dest) { |
|
87 | - $source=$this->stripPath($source); |
|
88 | - $dest=$this->stripPath($dest); |
|
89 | - $this->zip->renameName($source, $dest); |
|
90 | - } |
|
91 | - /** |
|
92 | - * get the uncompressed size of a file in the archive |
|
93 | - * @param string $path |
|
94 | - * @return int |
|
95 | - */ |
|
96 | - function filesize($path) { |
|
97 | - $stat=$this->zip->statName($path); |
|
98 | - return $stat['size']; |
|
99 | - } |
|
100 | - /** |
|
101 | - * get the last modified time of a file in the archive |
|
102 | - * @param string $path |
|
103 | - * @return int |
|
104 | - */ |
|
105 | - function mtime($path) { |
|
106 | - return filemtime($this->path); |
|
107 | - } |
|
108 | - /** |
|
109 | - * get the files in a folder |
|
110 | - * @param string $path |
|
111 | - * @return array |
|
112 | - */ |
|
113 | - function getFolder($path) { |
|
114 | - $files=$this->getFiles(); |
|
115 | - $folderContent=array(); |
|
116 | - $pathLength=strlen($path); |
|
117 | - foreach($files as $file) { |
|
118 | - if(substr($file, 0, $pathLength)==$path and $file!=$path) { |
|
119 | - if(strrpos(substr($file, 0, -1), '/')<=$pathLength) { |
|
120 | - $folderContent[]=substr($file, $pathLength); |
|
121 | - } |
|
122 | - } |
|
123 | - } |
|
124 | - return $folderContent; |
|
125 | - } |
|
126 | - /** |
|
127 | - * get all files in the archive |
|
128 | - * @return array |
|
129 | - */ |
|
130 | - function getFiles() { |
|
131 | - $fileCount=$this->zip->numFiles; |
|
132 | - $files=array(); |
|
133 | - for($i=0;$i<$fileCount;$i++) { |
|
134 | - $files[]=$this->zip->getNameIndex($i); |
|
135 | - } |
|
136 | - return $files; |
|
137 | - } |
|
138 | - /** |
|
139 | - * get the content of a file |
|
140 | - * @param string $path |
|
141 | - * @return string |
|
142 | - */ |
|
143 | - function getFile($path) { |
|
144 | - return $this->zip->getFromName($path); |
|
145 | - } |
|
146 | - /** |
|
147 | - * extract a single file from the archive |
|
148 | - * @param string $path |
|
149 | - * @param string $dest |
|
150 | - * @return boolean|null |
|
151 | - */ |
|
152 | - function extractFile($path, $dest) { |
|
153 | - $fp = $this->zip->getStream($path); |
|
154 | - file_put_contents($dest, $fp); |
|
155 | - } |
|
156 | - /** |
|
157 | - * extract the archive |
|
158 | - * @param string $dest |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - function extract($dest) { |
|
162 | - return $this->zip->extractTo($dest); |
|
163 | - } |
|
164 | - /** |
|
165 | - * check if a file or folder exists in the archive |
|
166 | - * @param string $path |
|
167 | - * @return bool |
|
168 | - */ |
|
169 | - function fileExists($path) { |
|
170 | - return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false); |
|
171 | - } |
|
172 | - /** |
|
173 | - * remove a file or folder from the archive |
|
174 | - * @param string $path |
|
175 | - * @return bool |
|
176 | - */ |
|
177 | - function remove($path) { |
|
178 | - if($this->fileExists($path.'/')) { |
|
179 | - return $this->zip->deleteName($path.'/'); |
|
180 | - }else{ |
|
181 | - return $this->zip->deleteName($path); |
|
182 | - } |
|
183 | - } |
|
184 | - /** |
|
185 | - * get a file handler |
|
186 | - * @param string $path |
|
187 | - * @param string $mode |
|
188 | - * @return resource |
|
189 | - */ |
|
190 | - function getStream($path, $mode) { |
|
191 | - if($mode=='r' or $mode=='rb') { |
|
192 | - return $this->zip->getStream($path); |
|
193 | - } else { |
|
194 | - //since we can't directly get a writable stream, |
|
195 | - //make a temp copy of the file and put it back |
|
196 | - //in the archive when the stream is closed |
|
197 | - if(strrpos($path, '.')!==false) { |
|
198 | - $ext=substr($path, strrpos($path, '.')); |
|
199 | - }else{ |
|
200 | - $ext=''; |
|
201 | - } |
|
202 | - $tmpFile=\OCP\Files::tmpFile($ext); |
|
203 | - if($this->fileExists($path)) { |
|
204 | - $this->extractFile($path, $tmpFile); |
|
205 | - } |
|
206 | - $handle = fopen($tmpFile, $mode); |
|
207 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
208 | - $this->writeBack($tmpFile, $path); |
|
209 | - }); |
|
210 | - } |
|
211 | - } |
|
43 | + /** |
|
44 | + * @param string $source |
|
45 | + */ |
|
46 | + function __construct($source) { |
|
47 | + $this->path=$source; |
|
48 | + $this->zip=new \ZipArchive(); |
|
49 | + if($this->zip->open($source, \ZipArchive::CREATE)) { |
|
50 | + }else{ |
|
51 | + \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN); |
|
52 | + } |
|
53 | + } |
|
54 | + /** |
|
55 | + * add an empty folder to the archive |
|
56 | + * @param string $path |
|
57 | + * @return bool |
|
58 | + */ |
|
59 | + function addFolder($path) { |
|
60 | + return $this->zip->addEmptyDir($path); |
|
61 | + } |
|
62 | + /** |
|
63 | + * add a file to the archive |
|
64 | + * @param string $path |
|
65 | + * @param string $source either a local file or string data |
|
66 | + * @return bool |
|
67 | + */ |
|
68 | + function addFile($path, $source='') { |
|
69 | + if($source and $source[0]=='/' and file_exists($source)) { |
|
70 | + $result=$this->zip->addFile($source, $path); |
|
71 | + }else{ |
|
72 | + $result=$this->zip->addFromString($path, $source); |
|
73 | + } |
|
74 | + if($result) { |
|
75 | + $this->zip->close();//close and reopen to save the zip |
|
76 | + $this->zip->open($this->path); |
|
77 | + } |
|
78 | + return $result; |
|
79 | + } |
|
80 | + /** |
|
81 | + * rename a file or folder in the archive |
|
82 | + * @param string $source |
|
83 | + * @param string $dest |
|
84 | + * @return boolean|null |
|
85 | + */ |
|
86 | + function rename($source, $dest) { |
|
87 | + $source=$this->stripPath($source); |
|
88 | + $dest=$this->stripPath($dest); |
|
89 | + $this->zip->renameName($source, $dest); |
|
90 | + } |
|
91 | + /** |
|
92 | + * get the uncompressed size of a file in the archive |
|
93 | + * @param string $path |
|
94 | + * @return int |
|
95 | + */ |
|
96 | + function filesize($path) { |
|
97 | + $stat=$this->zip->statName($path); |
|
98 | + return $stat['size']; |
|
99 | + } |
|
100 | + /** |
|
101 | + * get the last modified time of a file in the archive |
|
102 | + * @param string $path |
|
103 | + * @return int |
|
104 | + */ |
|
105 | + function mtime($path) { |
|
106 | + return filemtime($this->path); |
|
107 | + } |
|
108 | + /** |
|
109 | + * get the files in a folder |
|
110 | + * @param string $path |
|
111 | + * @return array |
|
112 | + */ |
|
113 | + function getFolder($path) { |
|
114 | + $files=$this->getFiles(); |
|
115 | + $folderContent=array(); |
|
116 | + $pathLength=strlen($path); |
|
117 | + foreach($files as $file) { |
|
118 | + if(substr($file, 0, $pathLength)==$path and $file!=$path) { |
|
119 | + if(strrpos(substr($file, 0, -1), '/')<=$pathLength) { |
|
120 | + $folderContent[]=substr($file, $pathLength); |
|
121 | + } |
|
122 | + } |
|
123 | + } |
|
124 | + return $folderContent; |
|
125 | + } |
|
126 | + /** |
|
127 | + * get all files in the archive |
|
128 | + * @return array |
|
129 | + */ |
|
130 | + function getFiles() { |
|
131 | + $fileCount=$this->zip->numFiles; |
|
132 | + $files=array(); |
|
133 | + for($i=0;$i<$fileCount;$i++) { |
|
134 | + $files[]=$this->zip->getNameIndex($i); |
|
135 | + } |
|
136 | + return $files; |
|
137 | + } |
|
138 | + /** |
|
139 | + * get the content of a file |
|
140 | + * @param string $path |
|
141 | + * @return string |
|
142 | + */ |
|
143 | + function getFile($path) { |
|
144 | + return $this->zip->getFromName($path); |
|
145 | + } |
|
146 | + /** |
|
147 | + * extract a single file from the archive |
|
148 | + * @param string $path |
|
149 | + * @param string $dest |
|
150 | + * @return boolean|null |
|
151 | + */ |
|
152 | + function extractFile($path, $dest) { |
|
153 | + $fp = $this->zip->getStream($path); |
|
154 | + file_put_contents($dest, $fp); |
|
155 | + } |
|
156 | + /** |
|
157 | + * extract the archive |
|
158 | + * @param string $dest |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + function extract($dest) { |
|
162 | + return $this->zip->extractTo($dest); |
|
163 | + } |
|
164 | + /** |
|
165 | + * check if a file or folder exists in the archive |
|
166 | + * @param string $path |
|
167 | + * @return bool |
|
168 | + */ |
|
169 | + function fileExists($path) { |
|
170 | + return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false); |
|
171 | + } |
|
172 | + /** |
|
173 | + * remove a file or folder from the archive |
|
174 | + * @param string $path |
|
175 | + * @return bool |
|
176 | + */ |
|
177 | + function remove($path) { |
|
178 | + if($this->fileExists($path.'/')) { |
|
179 | + return $this->zip->deleteName($path.'/'); |
|
180 | + }else{ |
|
181 | + return $this->zip->deleteName($path); |
|
182 | + } |
|
183 | + } |
|
184 | + /** |
|
185 | + * get a file handler |
|
186 | + * @param string $path |
|
187 | + * @param string $mode |
|
188 | + * @return resource |
|
189 | + */ |
|
190 | + function getStream($path, $mode) { |
|
191 | + if($mode=='r' or $mode=='rb') { |
|
192 | + return $this->zip->getStream($path); |
|
193 | + } else { |
|
194 | + //since we can't directly get a writable stream, |
|
195 | + //make a temp copy of the file and put it back |
|
196 | + //in the archive when the stream is closed |
|
197 | + if(strrpos($path, '.')!==false) { |
|
198 | + $ext=substr($path, strrpos($path, '.')); |
|
199 | + }else{ |
|
200 | + $ext=''; |
|
201 | + } |
|
202 | + $tmpFile=\OCP\Files::tmpFile($ext); |
|
203 | + if($this->fileExists($path)) { |
|
204 | + $this->extractFile($path, $tmpFile); |
|
205 | + } |
|
206 | + $handle = fopen($tmpFile, $mode); |
|
207 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
208 | + $this->writeBack($tmpFile, $path); |
|
209 | + }); |
|
210 | + } |
|
211 | + } |
|
212 | 212 | |
213 | - /** |
|
214 | - * write back temporary files |
|
215 | - */ |
|
216 | - function writeBack($tmpFile, $path) { |
|
217 | - $this->addFile($path, $tmpFile); |
|
218 | - unlink($tmpFile); |
|
219 | - } |
|
213 | + /** |
|
214 | + * write back temporary files |
|
215 | + */ |
|
216 | + function writeBack($tmpFile, $path) { |
|
217 | + $this->addFile($path, $tmpFile); |
|
218 | + unlink($tmpFile); |
|
219 | + } |
|
220 | 220 | |
221 | - /** |
|
222 | - * @param string $path |
|
223 | - * @return string |
|
224 | - */ |
|
225 | - private function stripPath($path) { |
|
226 | - if(!$path || $path[0]=='/') { |
|
227 | - return substr($path, 1); |
|
228 | - }else{ |
|
229 | - return $path; |
|
230 | - } |
|
231 | - } |
|
221 | + /** |
|
222 | + * @param string $path |
|
223 | + * @return string |
|
224 | + */ |
|
225 | + private function stripPath($path) { |
|
226 | + if(!$path || $path[0]=='/') { |
|
227 | + return substr($path, 1); |
|
228 | + }else{ |
|
229 | + return $path; |
|
230 | + } |
|
231 | + } |
|
232 | 232 | } |
@@ -33,21 +33,21 @@ discard block |
||
33 | 33 | |
34 | 34 | use Icewind\Streams\CallbackWrapper; |
35 | 35 | |
36 | -class ZIP extends Archive{ |
|
36 | +class ZIP extends Archive { |
|
37 | 37 | /** |
38 | 38 | * @var \ZipArchive zip |
39 | 39 | */ |
40 | - private $zip=null; |
|
40 | + private $zip = null; |
|
41 | 41 | private $path; |
42 | 42 | |
43 | 43 | /** |
44 | 44 | * @param string $source |
45 | 45 | */ |
46 | 46 | function __construct($source) { |
47 | - $this->path=$source; |
|
48 | - $this->zip=new \ZipArchive(); |
|
49 | - if($this->zip->open($source, \ZipArchive::CREATE)) { |
|
50 | - }else{ |
|
47 | + $this->path = $source; |
|
48 | + $this->zip = new \ZipArchive(); |
|
49 | + if ($this->zip->open($source, \ZipArchive::CREATE)) { |
|
50 | + } else { |
|
51 | 51 | \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN); |
52 | 52 | } |
53 | 53 | } |
@@ -65,14 +65,14 @@ discard block |
||
65 | 65 | * @param string $source either a local file or string data |
66 | 66 | * @return bool |
67 | 67 | */ |
68 | - function addFile($path, $source='') { |
|
69 | - if($source and $source[0]=='/' and file_exists($source)) { |
|
70 | - $result=$this->zip->addFile($source, $path); |
|
71 | - }else{ |
|
72 | - $result=$this->zip->addFromString($path, $source); |
|
68 | + function addFile($path, $source = '') { |
|
69 | + if ($source and $source[0] == '/' and file_exists($source)) { |
|
70 | + $result = $this->zip->addFile($source, $path); |
|
71 | + } else { |
|
72 | + $result = $this->zip->addFromString($path, $source); |
|
73 | 73 | } |
74 | - if($result) { |
|
75 | - $this->zip->close();//close and reopen to save the zip |
|
74 | + if ($result) { |
|
75 | + $this->zip->close(); //close and reopen to save the zip |
|
76 | 76 | $this->zip->open($this->path); |
77 | 77 | } |
78 | 78 | return $result; |
@@ -84,8 +84,8 @@ discard block |
||
84 | 84 | * @return boolean|null |
85 | 85 | */ |
86 | 86 | function rename($source, $dest) { |
87 | - $source=$this->stripPath($source); |
|
88 | - $dest=$this->stripPath($dest); |
|
87 | + $source = $this->stripPath($source); |
|
88 | + $dest = $this->stripPath($dest); |
|
89 | 89 | $this->zip->renameName($source, $dest); |
90 | 90 | } |
91 | 91 | /** |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | * @return int |
95 | 95 | */ |
96 | 96 | function filesize($path) { |
97 | - $stat=$this->zip->statName($path); |
|
97 | + $stat = $this->zip->statName($path); |
|
98 | 98 | return $stat['size']; |
99 | 99 | } |
100 | 100 | /** |
@@ -111,13 +111,13 @@ discard block |
||
111 | 111 | * @return array |
112 | 112 | */ |
113 | 113 | function getFolder($path) { |
114 | - $files=$this->getFiles(); |
|
115 | - $folderContent=array(); |
|
116 | - $pathLength=strlen($path); |
|
117 | - foreach($files as $file) { |
|
118 | - if(substr($file, 0, $pathLength)==$path and $file!=$path) { |
|
119 | - if(strrpos(substr($file, 0, -1), '/')<=$pathLength) { |
|
120 | - $folderContent[]=substr($file, $pathLength); |
|
114 | + $files = $this->getFiles(); |
|
115 | + $folderContent = array(); |
|
116 | + $pathLength = strlen($path); |
|
117 | + foreach ($files as $file) { |
|
118 | + if (substr($file, 0, $pathLength) == $path and $file != $path) { |
|
119 | + if (strrpos(substr($file, 0, -1), '/') <= $pathLength) { |
|
120 | + $folderContent[] = substr($file, $pathLength); |
|
121 | 121 | } |
122 | 122 | } |
123 | 123 | } |
@@ -128,10 +128,10 @@ discard block |
||
128 | 128 | * @return array |
129 | 129 | */ |
130 | 130 | function getFiles() { |
131 | - $fileCount=$this->zip->numFiles; |
|
132 | - $files=array(); |
|
133 | - for($i=0;$i<$fileCount;$i++) { |
|
134 | - $files[]=$this->zip->getNameIndex($i); |
|
131 | + $fileCount = $this->zip->numFiles; |
|
132 | + $files = array(); |
|
133 | + for ($i = 0; $i < $fileCount; $i++) { |
|
134 | + $files[] = $this->zip->getNameIndex($i); |
|
135 | 135 | } |
136 | 136 | return $files; |
137 | 137 | } |
@@ -167,7 +167,7 @@ discard block |
||
167 | 167 | * @return bool |
168 | 168 | */ |
169 | 169 | function fileExists($path) { |
170 | - return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false); |
|
170 | + return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false); |
|
171 | 171 | } |
172 | 172 | /** |
173 | 173 | * remove a file or folder from the archive |
@@ -175,9 +175,9 @@ discard block |
||
175 | 175 | * @return bool |
176 | 176 | */ |
177 | 177 | function remove($path) { |
178 | - if($this->fileExists($path.'/')) { |
|
178 | + if ($this->fileExists($path.'/')) { |
|
179 | 179 | return $this->zip->deleteName($path.'/'); |
180 | - }else{ |
|
180 | + } else { |
|
181 | 181 | return $this->zip->deleteName($path); |
182 | 182 | } |
183 | 183 | } |
@@ -188,23 +188,23 @@ discard block |
||
188 | 188 | * @return resource |
189 | 189 | */ |
190 | 190 | function getStream($path, $mode) { |
191 | - if($mode=='r' or $mode=='rb') { |
|
191 | + if ($mode == 'r' or $mode == 'rb') { |
|
192 | 192 | return $this->zip->getStream($path); |
193 | 193 | } else { |
194 | 194 | //since we can't directly get a writable stream, |
195 | 195 | //make a temp copy of the file and put it back |
196 | 196 | //in the archive when the stream is closed |
197 | - if(strrpos($path, '.')!==false) { |
|
198 | - $ext=substr($path, strrpos($path, '.')); |
|
199 | - }else{ |
|
200 | - $ext=''; |
|
197 | + if (strrpos($path, '.') !== false) { |
|
198 | + $ext = substr($path, strrpos($path, '.')); |
|
199 | + } else { |
|
200 | + $ext = ''; |
|
201 | 201 | } |
202 | - $tmpFile=\OCP\Files::tmpFile($ext); |
|
203 | - if($this->fileExists($path)) { |
|
202 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
203 | + if ($this->fileExists($path)) { |
|
204 | 204 | $this->extractFile($path, $tmpFile); |
205 | 205 | } |
206 | 206 | $handle = fopen($tmpFile, $mode); |
207 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
207 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
208 | 208 | $this->writeBack($tmpFile, $path); |
209 | 209 | }); |
210 | 210 | } |
@@ -223,9 +223,9 @@ discard block |
||
223 | 223 | * @return string |
224 | 224 | */ |
225 | 225 | private function stripPath($path) { |
226 | - if(!$path || $path[0]=='/') { |
|
226 | + if (!$path || $path[0] == '/') { |
|
227 | 227 | return substr($path, 1); |
228 | - }else{ |
|
228 | + } else { |
|
229 | 229 | return $path; |
230 | 230 | } |
231 | 231 | } |
@@ -47,7 +47,7 @@ discard block |
||
47 | 47 | $this->path=$source; |
48 | 48 | $this->zip=new \ZipArchive(); |
49 | 49 | if($this->zip->open($source, \ZipArchive::CREATE)) { |
50 | - }else{ |
|
50 | + } else{ |
|
51 | 51 | \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN); |
52 | 52 | } |
53 | 53 | } |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | function addFile($path, $source='') { |
69 | 69 | if($source and $source[0]=='/' and file_exists($source)) { |
70 | 70 | $result=$this->zip->addFile($source, $path); |
71 | - }else{ |
|
71 | + } else{ |
|
72 | 72 | $result=$this->zip->addFromString($path, $source); |
73 | 73 | } |
74 | 74 | if($result) { |
@@ -177,7 +177,7 @@ discard block |
||
177 | 177 | function remove($path) { |
178 | 178 | if($this->fileExists($path.'/')) { |
179 | 179 | return $this->zip->deleteName($path.'/'); |
180 | - }else{ |
|
180 | + } else{ |
|
181 | 181 | return $this->zip->deleteName($path); |
182 | 182 | } |
183 | 183 | } |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | //in the archive when the stream is closed |
197 | 197 | if(strrpos($path, '.')!==false) { |
198 | 198 | $ext=substr($path, strrpos($path, '.')); |
199 | - }else{ |
|
199 | + } else{ |
|
200 | 200 | $ext=''; |
201 | 201 | } |
202 | 202 | $tmpFile=\OCP\Files::tmpFile($ext); |
@@ -225,7 +225,7 @@ discard block |
||
225 | 225 | private function stripPath($path) { |
226 | 226 | if(!$path || $path[0]=='/') { |
227 | 227 | return substr($path, 1); |
228 | - }else{ |
|
228 | + } else{ |
|
229 | 229 | return $path; |
230 | 230 | } |
231 | 231 | } |
@@ -194,6 +194,9 @@ |
||
194 | 194 | return $this->getCache()->getStatus($this->getSourcePath($file)); |
195 | 195 | } |
196 | 196 | |
197 | + /** |
|
198 | + * @param ICacheEntry[] $results |
|
199 | + */ |
|
197 | 200 | private function formatSearchResults($results) { |
198 | 201 | $results = array_filter($results, array($this, 'filterCacheEntry')); |
199 | 202 | $results = array_values($results); |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | if ($path === '') { |
59 | 59 | return $this->getRoot(); |
60 | 60 | } else { |
61 | - return $this->getRoot() . '/' . ltrim($path, '/'); |
|
61 | + return $this->getRoot().'/'.ltrim($path, '/'); |
|
62 | 62 | } |
63 | 63 | } |
64 | 64 | |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | $rootLength = strlen($this->getRoot()) + 1; |
74 | 74 | if ($path === $this->getRoot()) { |
75 | 75 | return ''; |
76 | - } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') { |
|
76 | + } else if (substr($path, 0, $rootLength) === $this->getRoot().'/') { |
|
77 | 77 | return substr($path, $rootLength); |
78 | 78 | } else { |
79 | 79 | return null; |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | |
94 | 94 | protected function filterCacheEntry($entry) { |
95 | 95 | $rootLength = strlen($this->getRoot()) + 1; |
96 | - return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/'); |
|
96 | + return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot().'/'); |
|
97 | 97 | } |
98 | 98 | |
99 | 99 | /** |
@@ -36,302 +36,302 @@ |
||
36 | 36 | * Jail to a subdirectory of the wrapped cache |
37 | 37 | */ |
38 | 38 | class CacheJail extends CacheWrapper { |
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - protected $root; |
|
43 | - |
|
44 | - /** |
|
45 | - * @param \OCP\Files\Cache\ICache $cache |
|
46 | - * @param string $root |
|
47 | - */ |
|
48 | - public function __construct($cache, $root) { |
|
49 | - parent::__construct($cache); |
|
50 | - $this->root = $root; |
|
51 | - } |
|
52 | - |
|
53 | - protected function getRoot() { |
|
54 | - return $this->root; |
|
55 | - } |
|
56 | - |
|
57 | - protected function getSourcePath($path) { |
|
58 | - if ($path === '') { |
|
59 | - return $this->getRoot(); |
|
60 | - } else { |
|
61 | - return $this->getRoot() . '/' . ltrim($path, '/'); |
|
62 | - } |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * @param string $path |
|
67 | - * @return null|string the jailed path or null if the path is outside the jail |
|
68 | - */ |
|
69 | - protected function getJailedPath($path) { |
|
70 | - if ($this->getRoot() === '') { |
|
71 | - return $path; |
|
72 | - } |
|
73 | - $rootLength = strlen($this->getRoot()) + 1; |
|
74 | - if ($path === $this->getRoot()) { |
|
75 | - return ''; |
|
76 | - } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') { |
|
77 | - return substr($path, $rootLength); |
|
78 | - } else { |
|
79 | - return null; |
|
80 | - } |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * @param ICacheEntry|array $entry |
|
85 | - * @return array |
|
86 | - */ |
|
87 | - protected function formatCacheEntry($entry) { |
|
88 | - if (isset($entry['path'])) { |
|
89 | - $entry['path'] = $this->getJailedPath($entry['path']); |
|
90 | - } |
|
91 | - return $entry; |
|
92 | - } |
|
93 | - |
|
94 | - protected function filterCacheEntry($entry) { |
|
95 | - $rootLength = strlen($this->getRoot()) + 1; |
|
96 | - return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/'); |
|
97 | - } |
|
98 | - |
|
99 | - /** |
|
100 | - * get the stored metadata of a file or folder |
|
101 | - * |
|
102 | - * @param string /int $file |
|
103 | - * @return ICacheEntry|false |
|
104 | - */ |
|
105 | - public function get($file) { |
|
106 | - if (is_string($file) or $file == '') { |
|
107 | - $file = $this->getSourcePath($file); |
|
108 | - } |
|
109 | - return parent::get($file); |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * insert meta data for a new file or folder |
|
114 | - * |
|
115 | - * @param string $file |
|
116 | - * @param array $data |
|
117 | - * |
|
118 | - * @return int file id |
|
119 | - * @throws \RuntimeException |
|
120 | - */ |
|
121 | - public function insert($file, array $data) { |
|
122 | - return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * update the metadata in the cache |
|
127 | - * |
|
128 | - * @param int $id |
|
129 | - * @param array $data |
|
130 | - */ |
|
131 | - public function update($id, array $data) { |
|
132 | - $this->getCache()->update($id, $data); |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * get the file id for a file |
|
137 | - * |
|
138 | - * @param string $file |
|
139 | - * @return int |
|
140 | - */ |
|
141 | - public function getId($file) { |
|
142 | - return $this->getCache()->getId($this->getSourcePath($file)); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * get the id of the parent folder of a file |
|
147 | - * |
|
148 | - * @param string $file |
|
149 | - * @return int |
|
150 | - */ |
|
151 | - public function getParentId($file) { |
|
152 | - return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * check if a file is available in the cache |
|
157 | - * |
|
158 | - * @param string $file |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - public function inCache($file) { |
|
162 | - return $this->getCache()->inCache($this->getSourcePath($file)); |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * remove a file or folder from the cache |
|
167 | - * |
|
168 | - * @param string $file |
|
169 | - */ |
|
170 | - public function remove($file) { |
|
171 | - $this->getCache()->remove($this->getSourcePath($file)); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Move a file or folder in the cache |
|
176 | - * |
|
177 | - * @param string $source |
|
178 | - * @param string $target |
|
179 | - */ |
|
180 | - public function move($source, $target) { |
|
181 | - $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
182 | - } |
|
183 | - |
|
184 | - /** |
|
185 | - * Get the storage id and path needed for a move |
|
186 | - * |
|
187 | - * @param string $path |
|
188 | - * @return array [$storageId, $internalPath] |
|
189 | - */ |
|
190 | - protected function getMoveInfo($path) { |
|
191 | - return [$this->getNumericStorageId(), $this->getSourcePath($path)]; |
|
192 | - } |
|
193 | - |
|
194 | - /** |
|
195 | - * remove all entries for files that are stored on the storage from the cache |
|
196 | - */ |
|
197 | - public function clear() { |
|
198 | - $this->getCache()->remove($this->getRoot()); |
|
199 | - } |
|
200 | - |
|
201 | - /** |
|
202 | - * @param string $file |
|
203 | - * |
|
204 | - * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
205 | - */ |
|
206 | - public function getStatus($file) { |
|
207 | - return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
208 | - } |
|
209 | - |
|
210 | - private function formatSearchResults($results) { |
|
211 | - $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
212 | - $results = array_values($results); |
|
213 | - return array_map(array($this, 'formatCacheEntry'), $results); |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * search for files matching $pattern |
|
218 | - * |
|
219 | - * @param string $pattern |
|
220 | - * @return array an array of file data |
|
221 | - */ |
|
222 | - public function search($pattern) { |
|
223 | - $results = $this->getCache()->search($pattern); |
|
224 | - return $this->formatSearchResults($results); |
|
225 | - } |
|
226 | - |
|
227 | - /** |
|
228 | - * search for files by mimetype |
|
229 | - * |
|
230 | - * @param string $mimetype |
|
231 | - * @return array |
|
232 | - */ |
|
233 | - public function searchByMime($mimetype) { |
|
234 | - $results = $this->getCache()->searchByMime($mimetype); |
|
235 | - return $this->formatSearchResults($results); |
|
236 | - } |
|
237 | - |
|
238 | - public function searchQuery(ISearchQuery $query) { |
|
239 | - $results = $this->getCache()->searchQuery($query); |
|
240 | - return $this->formatSearchResults($results); |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * search for files by mimetype |
|
245 | - * |
|
246 | - * @param string|int $tag name or tag id |
|
247 | - * @param string $userId owner of the tags |
|
248 | - * @return array |
|
249 | - */ |
|
250 | - public function searchByTag($tag, $userId) { |
|
251 | - $results = $this->getCache()->searchByTag($tag, $userId); |
|
252 | - return $this->formatSearchResults($results); |
|
253 | - } |
|
254 | - |
|
255 | - /** |
|
256 | - * update the folder size and the size of all parent folders |
|
257 | - * |
|
258 | - * @param string|boolean $path |
|
259 | - * @param array $data (optional) meta data of the folder |
|
260 | - */ |
|
261 | - public function correctFolderSize($path, $data = null) { |
|
262 | - if ($this->getCache() instanceof Cache) { |
|
263 | - $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
264 | - } |
|
265 | - } |
|
266 | - |
|
267 | - /** |
|
268 | - * get the size of a folder and set it in the cache |
|
269 | - * |
|
270 | - * @param string $path |
|
271 | - * @param array $entry (optional) meta data of the folder |
|
272 | - * @return int |
|
273 | - */ |
|
274 | - public function calculateFolderSize($path, $entry = null) { |
|
275 | - if ($this->getCache() instanceof Cache) { |
|
276 | - return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
277 | - } else { |
|
278 | - return 0; |
|
279 | - } |
|
280 | - |
|
281 | - } |
|
282 | - |
|
283 | - /** |
|
284 | - * get all file ids on the files on the storage |
|
285 | - * |
|
286 | - * @return int[] |
|
287 | - */ |
|
288 | - public function getAll() { |
|
289 | - // not supported |
|
290 | - return array(); |
|
291 | - } |
|
292 | - |
|
293 | - /** |
|
294 | - * find a folder in the cache which has not been fully scanned |
|
295 | - * |
|
296 | - * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
297 | - * use the one with the highest id gives the best result with the background scanner, since that is most |
|
298 | - * likely the folder where we stopped scanning previously |
|
299 | - * |
|
300 | - * @return string|bool the path of the folder or false when no folder matched |
|
301 | - */ |
|
302 | - public function getIncomplete() { |
|
303 | - // not supported |
|
304 | - return false; |
|
305 | - } |
|
306 | - |
|
307 | - /** |
|
308 | - * get the path of a file on this storage by it's id |
|
309 | - * |
|
310 | - * @param int $id |
|
311 | - * @return string|null |
|
312 | - */ |
|
313 | - public function getPathById($id) { |
|
314 | - $path = $this->getCache()->getPathById($id); |
|
315 | - if ($path === null) { |
|
316 | - return null; |
|
317 | - } |
|
318 | - |
|
319 | - return $this->getJailedPath($path); |
|
320 | - } |
|
321 | - |
|
322 | - /** |
|
323 | - * Move a file or folder in the cache |
|
324 | - * |
|
325 | - * Note that this should make sure the entries are removed from the source cache |
|
326 | - * |
|
327 | - * @param \OCP\Files\Cache\ICache $sourceCache |
|
328 | - * @param string $sourcePath |
|
329 | - * @param string $targetPath |
|
330 | - */ |
|
331 | - public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
332 | - if ($sourceCache === $this) { |
|
333 | - return $this->move($sourcePath, $targetPath); |
|
334 | - } |
|
335 | - return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
336 | - } |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + protected $root; |
|
43 | + |
|
44 | + /** |
|
45 | + * @param \OCP\Files\Cache\ICache $cache |
|
46 | + * @param string $root |
|
47 | + */ |
|
48 | + public function __construct($cache, $root) { |
|
49 | + parent::__construct($cache); |
|
50 | + $this->root = $root; |
|
51 | + } |
|
52 | + |
|
53 | + protected function getRoot() { |
|
54 | + return $this->root; |
|
55 | + } |
|
56 | + |
|
57 | + protected function getSourcePath($path) { |
|
58 | + if ($path === '') { |
|
59 | + return $this->getRoot(); |
|
60 | + } else { |
|
61 | + return $this->getRoot() . '/' . ltrim($path, '/'); |
|
62 | + } |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * @param string $path |
|
67 | + * @return null|string the jailed path or null if the path is outside the jail |
|
68 | + */ |
|
69 | + protected function getJailedPath($path) { |
|
70 | + if ($this->getRoot() === '') { |
|
71 | + return $path; |
|
72 | + } |
|
73 | + $rootLength = strlen($this->getRoot()) + 1; |
|
74 | + if ($path === $this->getRoot()) { |
|
75 | + return ''; |
|
76 | + } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') { |
|
77 | + return substr($path, $rootLength); |
|
78 | + } else { |
|
79 | + return null; |
|
80 | + } |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * @param ICacheEntry|array $entry |
|
85 | + * @return array |
|
86 | + */ |
|
87 | + protected function formatCacheEntry($entry) { |
|
88 | + if (isset($entry['path'])) { |
|
89 | + $entry['path'] = $this->getJailedPath($entry['path']); |
|
90 | + } |
|
91 | + return $entry; |
|
92 | + } |
|
93 | + |
|
94 | + protected function filterCacheEntry($entry) { |
|
95 | + $rootLength = strlen($this->getRoot()) + 1; |
|
96 | + return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/'); |
|
97 | + } |
|
98 | + |
|
99 | + /** |
|
100 | + * get the stored metadata of a file or folder |
|
101 | + * |
|
102 | + * @param string /int $file |
|
103 | + * @return ICacheEntry|false |
|
104 | + */ |
|
105 | + public function get($file) { |
|
106 | + if (is_string($file) or $file == '') { |
|
107 | + $file = $this->getSourcePath($file); |
|
108 | + } |
|
109 | + return parent::get($file); |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * insert meta data for a new file or folder |
|
114 | + * |
|
115 | + * @param string $file |
|
116 | + * @param array $data |
|
117 | + * |
|
118 | + * @return int file id |
|
119 | + * @throws \RuntimeException |
|
120 | + */ |
|
121 | + public function insert($file, array $data) { |
|
122 | + return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * update the metadata in the cache |
|
127 | + * |
|
128 | + * @param int $id |
|
129 | + * @param array $data |
|
130 | + */ |
|
131 | + public function update($id, array $data) { |
|
132 | + $this->getCache()->update($id, $data); |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * get the file id for a file |
|
137 | + * |
|
138 | + * @param string $file |
|
139 | + * @return int |
|
140 | + */ |
|
141 | + public function getId($file) { |
|
142 | + return $this->getCache()->getId($this->getSourcePath($file)); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * get the id of the parent folder of a file |
|
147 | + * |
|
148 | + * @param string $file |
|
149 | + * @return int |
|
150 | + */ |
|
151 | + public function getParentId($file) { |
|
152 | + return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * check if a file is available in the cache |
|
157 | + * |
|
158 | + * @param string $file |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + public function inCache($file) { |
|
162 | + return $this->getCache()->inCache($this->getSourcePath($file)); |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * remove a file or folder from the cache |
|
167 | + * |
|
168 | + * @param string $file |
|
169 | + */ |
|
170 | + public function remove($file) { |
|
171 | + $this->getCache()->remove($this->getSourcePath($file)); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Move a file or folder in the cache |
|
176 | + * |
|
177 | + * @param string $source |
|
178 | + * @param string $target |
|
179 | + */ |
|
180 | + public function move($source, $target) { |
|
181 | + $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
182 | + } |
|
183 | + |
|
184 | + /** |
|
185 | + * Get the storage id and path needed for a move |
|
186 | + * |
|
187 | + * @param string $path |
|
188 | + * @return array [$storageId, $internalPath] |
|
189 | + */ |
|
190 | + protected function getMoveInfo($path) { |
|
191 | + return [$this->getNumericStorageId(), $this->getSourcePath($path)]; |
|
192 | + } |
|
193 | + |
|
194 | + /** |
|
195 | + * remove all entries for files that are stored on the storage from the cache |
|
196 | + */ |
|
197 | + public function clear() { |
|
198 | + $this->getCache()->remove($this->getRoot()); |
|
199 | + } |
|
200 | + |
|
201 | + /** |
|
202 | + * @param string $file |
|
203 | + * |
|
204 | + * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
205 | + */ |
|
206 | + public function getStatus($file) { |
|
207 | + return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
208 | + } |
|
209 | + |
|
210 | + private function formatSearchResults($results) { |
|
211 | + $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
212 | + $results = array_values($results); |
|
213 | + return array_map(array($this, 'formatCacheEntry'), $results); |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * search for files matching $pattern |
|
218 | + * |
|
219 | + * @param string $pattern |
|
220 | + * @return array an array of file data |
|
221 | + */ |
|
222 | + public function search($pattern) { |
|
223 | + $results = $this->getCache()->search($pattern); |
|
224 | + return $this->formatSearchResults($results); |
|
225 | + } |
|
226 | + |
|
227 | + /** |
|
228 | + * search for files by mimetype |
|
229 | + * |
|
230 | + * @param string $mimetype |
|
231 | + * @return array |
|
232 | + */ |
|
233 | + public function searchByMime($mimetype) { |
|
234 | + $results = $this->getCache()->searchByMime($mimetype); |
|
235 | + return $this->formatSearchResults($results); |
|
236 | + } |
|
237 | + |
|
238 | + public function searchQuery(ISearchQuery $query) { |
|
239 | + $results = $this->getCache()->searchQuery($query); |
|
240 | + return $this->formatSearchResults($results); |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * search for files by mimetype |
|
245 | + * |
|
246 | + * @param string|int $tag name or tag id |
|
247 | + * @param string $userId owner of the tags |
|
248 | + * @return array |
|
249 | + */ |
|
250 | + public function searchByTag($tag, $userId) { |
|
251 | + $results = $this->getCache()->searchByTag($tag, $userId); |
|
252 | + return $this->formatSearchResults($results); |
|
253 | + } |
|
254 | + |
|
255 | + /** |
|
256 | + * update the folder size and the size of all parent folders |
|
257 | + * |
|
258 | + * @param string|boolean $path |
|
259 | + * @param array $data (optional) meta data of the folder |
|
260 | + */ |
|
261 | + public function correctFolderSize($path, $data = null) { |
|
262 | + if ($this->getCache() instanceof Cache) { |
|
263 | + $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
264 | + } |
|
265 | + } |
|
266 | + |
|
267 | + /** |
|
268 | + * get the size of a folder and set it in the cache |
|
269 | + * |
|
270 | + * @param string $path |
|
271 | + * @param array $entry (optional) meta data of the folder |
|
272 | + * @return int |
|
273 | + */ |
|
274 | + public function calculateFolderSize($path, $entry = null) { |
|
275 | + if ($this->getCache() instanceof Cache) { |
|
276 | + return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
277 | + } else { |
|
278 | + return 0; |
|
279 | + } |
|
280 | + |
|
281 | + } |
|
282 | + |
|
283 | + /** |
|
284 | + * get all file ids on the files on the storage |
|
285 | + * |
|
286 | + * @return int[] |
|
287 | + */ |
|
288 | + public function getAll() { |
|
289 | + // not supported |
|
290 | + return array(); |
|
291 | + } |
|
292 | + |
|
293 | + /** |
|
294 | + * find a folder in the cache which has not been fully scanned |
|
295 | + * |
|
296 | + * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
297 | + * use the one with the highest id gives the best result with the background scanner, since that is most |
|
298 | + * likely the folder where we stopped scanning previously |
|
299 | + * |
|
300 | + * @return string|bool the path of the folder or false when no folder matched |
|
301 | + */ |
|
302 | + public function getIncomplete() { |
|
303 | + // not supported |
|
304 | + return false; |
|
305 | + } |
|
306 | + |
|
307 | + /** |
|
308 | + * get the path of a file on this storage by it's id |
|
309 | + * |
|
310 | + * @param int $id |
|
311 | + * @return string|null |
|
312 | + */ |
|
313 | + public function getPathById($id) { |
|
314 | + $path = $this->getCache()->getPathById($id); |
|
315 | + if ($path === null) { |
|
316 | + return null; |
|
317 | + } |
|
318 | + |
|
319 | + return $this->getJailedPath($path); |
|
320 | + } |
|
321 | + |
|
322 | + /** |
|
323 | + * Move a file or folder in the cache |
|
324 | + * |
|
325 | + * Note that this should make sure the entries are removed from the source cache |
|
326 | + * |
|
327 | + * @param \OCP\Files\Cache\ICache $sourceCache |
|
328 | + * @param string $sourcePath |
|
329 | + * @param string $targetPath |
|
330 | + */ |
|
331 | + public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
332 | + if ($sourceCache === $this) { |
|
333 | + return $this->move($sourcePath, $targetPath); |
|
334 | + } |
|
335 | + return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
336 | + } |
|
337 | 337 | } |
@@ -156,7 +156,7 @@ |
||
156 | 156 | /** |
157 | 157 | * @param string $gid |
158 | 158 | * @param string $displayName |
159 | - * @return \OCP\IGroup |
|
159 | + * @return null|Group |
|
160 | 160 | */ |
161 | 161 | protected function getGroupObject($gid, $displayName = null) { |
162 | 162 | $backends = array(); |
@@ -93,20 +93,20 @@ discard block |
||
93 | 93 | $this->logger = $logger; |
94 | 94 | $cachedGroups = & $this->cachedGroups; |
95 | 95 | $cachedUserGroups = & $this->cachedUserGroups; |
96 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
96 | + $this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | 97 | /** |
98 | 98 | * @var \OC\Group\Group $group |
99 | 99 | */ |
100 | 100 | unset($cachedGroups[$group->getGID()]); |
101 | 101 | $cachedUserGroups = array(); |
102 | 102 | }); |
103 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
103 | + $this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) { |
|
104 | 104 | /** |
105 | 105 | * @var \OC\Group\Group $group |
106 | 106 | */ |
107 | 107 | $cachedUserGroups = array(); |
108 | 108 | }); |
109 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
109 | + $this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) { |
|
110 | 110 | /** |
111 | 111 | * @var \OC\Group\Group $group |
112 | 112 | */ |
@@ -235,7 +235,7 @@ discard block |
||
235 | 235 | if ($aGroup instanceof IGroup) { |
236 | 236 | $groups[$groupId] = $aGroup; |
237 | 237 | } else { |
238 | - $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
238 | + $this->logger->debug('Group "'.$groupId.'" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | 239 | } |
240 | 240 | } |
241 | 241 | if (!is_null($limit) and $limit <= 0) { |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | if ($aGroup instanceof IGroup) { |
274 | 274 | $groups[$groupId] = $aGroup; |
275 | 275 | } else { |
276 | - $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
276 | + $this->logger->debug('User "'.$uid.'" belongs to deleted group: "'.$groupId.'"', ['app' => 'core']); |
|
277 | 277 | } |
278 | 278 | } |
279 | 279 | } |
@@ -322,32 +322,32 @@ discard block |
||
322 | 322 | */ |
323 | 323 | public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
324 | 324 | $group = $this->get($gid); |
325 | - if(is_null($group)) { |
|
325 | + if (is_null($group)) { |
|
326 | 326 | return array(); |
327 | 327 | } |
328 | 328 | |
329 | 329 | $search = trim($search); |
330 | 330 | $groupUsers = array(); |
331 | 331 | |
332 | - if(!empty($search)) { |
|
332 | + if (!empty($search)) { |
|
333 | 333 | // only user backends have the capability to do a complex search for users |
334 | 334 | $searchOffset = 0; |
335 | 335 | $searchLimit = $limit * 100; |
336 | - if($limit === -1) { |
|
336 | + if ($limit === -1) { |
|
337 | 337 | $searchLimit = 500; |
338 | 338 | } |
339 | 339 | |
340 | 340 | do { |
341 | 341 | $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
342 | - foreach($filteredUsers as $filteredUser) { |
|
343 | - if($group->inGroup($filteredUser)) { |
|
344 | - $groupUsers[]= $filteredUser; |
|
342 | + foreach ($filteredUsers as $filteredUser) { |
|
343 | + if ($group->inGroup($filteredUser)) { |
|
344 | + $groupUsers[] = $filteredUser; |
|
345 | 345 | } |
346 | 346 | } |
347 | 347 | $searchOffset += $searchLimit; |
348 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
348 | + } while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit); |
|
349 | 349 | |
350 | - if($limit === -1) { |
|
350 | + if ($limit === -1) { |
|
351 | 351 | $groupUsers = array_slice($groupUsers, $offset); |
352 | 352 | } else { |
353 | 353 | $groupUsers = array_slice($groupUsers, $offset, $limit); |
@@ -357,7 +357,7 @@ discard block |
||
357 | 357 | } |
358 | 358 | |
359 | 359 | $matchingUsers = array(); |
360 | - foreach($groupUsers as $groupUser) { |
|
360 | + foreach ($groupUsers as $groupUser) { |
|
361 | 361 | $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
362 | 362 | } |
363 | 363 | return $matchingUsers; |
@@ -58,323 +58,323 @@ |
||
58 | 58 | * @package OC\Group |
59 | 59 | */ |
60 | 60 | class Manager extends PublicEmitter implements IGroupManager { |
61 | - /** |
|
62 | - * @var GroupInterface[] $backends |
|
63 | - */ |
|
64 | - private $backends = array(); |
|
65 | - |
|
66 | - /** |
|
67 | - * @var \OC\User\Manager $userManager |
|
68 | - */ |
|
69 | - private $userManager; |
|
70 | - |
|
71 | - /** |
|
72 | - * @var \OC\Group\Group[] |
|
73 | - */ |
|
74 | - private $cachedGroups = array(); |
|
75 | - |
|
76 | - /** |
|
77 | - * @var \OC\Group\Group[][] |
|
78 | - */ |
|
79 | - private $cachedUserGroups = array(); |
|
80 | - |
|
81 | - /** @var \OC\SubAdmin */ |
|
82 | - private $subAdmin = null; |
|
83 | - |
|
84 | - /** @var ILogger */ |
|
85 | - private $logger; |
|
86 | - |
|
87 | - /** |
|
88 | - * @param \OC\User\Manager $userManager |
|
89 | - * @param ILogger $logger |
|
90 | - */ |
|
91 | - public function __construct(\OC\User\Manager $userManager, ILogger $logger) { |
|
92 | - $this->userManager = $userManager; |
|
93 | - $this->logger = $logger; |
|
94 | - $cachedGroups = & $this->cachedGroups; |
|
95 | - $cachedUserGroups = & $this->cachedUserGroups; |
|
96 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | - /** |
|
98 | - * @var \OC\Group\Group $group |
|
99 | - */ |
|
100 | - unset($cachedGroups[$group->getGID()]); |
|
101 | - $cachedUserGroups = array(); |
|
102 | - }); |
|
103 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
104 | - /** |
|
105 | - * @var \OC\Group\Group $group |
|
106 | - */ |
|
107 | - $cachedUserGroups = array(); |
|
108 | - }); |
|
109 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
110 | - /** |
|
111 | - * @var \OC\Group\Group $group |
|
112 | - */ |
|
113 | - $cachedUserGroups = array(); |
|
114 | - }); |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * Checks whether a given backend is used |
|
119 | - * |
|
120 | - * @param string $backendClass Full classname including complete namespace |
|
121 | - * @return bool |
|
122 | - */ |
|
123 | - public function isBackendUsed($backendClass) { |
|
124 | - $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
125 | - |
|
126 | - foreach ($this->backends as $backend) { |
|
127 | - if (strtolower(get_class($backend)) === $backendClass) { |
|
128 | - return true; |
|
129 | - } |
|
130 | - } |
|
131 | - |
|
132 | - return false; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * @param \OCP\GroupInterface $backend |
|
137 | - */ |
|
138 | - public function addBackend($backend) { |
|
139 | - $this->backends[] = $backend; |
|
140 | - $this->clearCaches(); |
|
141 | - } |
|
142 | - |
|
143 | - public function clearBackends() { |
|
144 | - $this->backends = array(); |
|
145 | - $this->clearCaches(); |
|
146 | - } |
|
61 | + /** |
|
62 | + * @var GroupInterface[] $backends |
|
63 | + */ |
|
64 | + private $backends = array(); |
|
65 | + |
|
66 | + /** |
|
67 | + * @var \OC\User\Manager $userManager |
|
68 | + */ |
|
69 | + private $userManager; |
|
70 | + |
|
71 | + /** |
|
72 | + * @var \OC\Group\Group[] |
|
73 | + */ |
|
74 | + private $cachedGroups = array(); |
|
75 | + |
|
76 | + /** |
|
77 | + * @var \OC\Group\Group[][] |
|
78 | + */ |
|
79 | + private $cachedUserGroups = array(); |
|
80 | + |
|
81 | + /** @var \OC\SubAdmin */ |
|
82 | + private $subAdmin = null; |
|
83 | + |
|
84 | + /** @var ILogger */ |
|
85 | + private $logger; |
|
86 | + |
|
87 | + /** |
|
88 | + * @param \OC\User\Manager $userManager |
|
89 | + * @param ILogger $logger |
|
90 | + */ |
|
91 | + public function __construct(\OC\User\Manager $userManager, ILogger $logger) { |
|
92 | + $this->userManager = $userManager; |
|
93 | + $this->logger = $logger; |
|
94 | + $cachedGroups = & $this->cachedGroups; |
|
95 | + $cachedUserGroups = & $this->cachedUserGroups; |
|
96 | + $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
97 | + /** |
|
98 | + * @var \OC\Group\Group $group |
|
99 | + */ |
|
100 | + unset($cachedGroups[$group->getGID()]); |
|
101 | + $cachedUserGroups = array(); |
|
102 | + }); |
|
103 | + $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
104 | + /** |
|
105 | + * @var \OC\Group\Group $group |
|
106 | + */ |
|
107 | + $cachedUserGroups = array(); |
|
108 | + }); |
|
109 | + $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
110 | + /** |
|
111 | + * @var \OC\Group\Group $group |
|
112 | + */ |
|
113 | + $cachedUserGroups = array(); |
|
114 | + }); |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * Checks whether a given backend is used |
|
119 | + * |
|
120 | + * @param string $backendClass Full classname including complete namespace |
|
121 | + * @return bool |
|
122 | + */ |
|
123 | + public function isBackendUsed($backendClass) { |
|
124 | + $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
125 | + |
|
126 | + foreach ($this->backends as $backend) { |
|
127 | + if (strtolower(get_class($backend)) === $backendClass) { |
|
128 | + return true; |
|
129 | + } |
|
130 | + } |
|
131 | + |
|
132 | + return false; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * @param \OCP\GroupInterface $backend |
|
137 | + */ |
|
138 | + public function addBackend($backend) { |
|
139 | + $this->backends[] = $backend; |
|
140 | + $this->clearCaches(); |
|
141 | + } |
|
142 | + |
|
143 | + public function clearBackends() { |
|
144 | + $this->backends = array(); |
|
145 | + $this->clearCaches(); |
|
146 | + } |
|
147 | 147 | |
148 | - protected function clearCaches() { |
|
149 | - $this->cachedGroups = array(); |
|
150 | - $this->cachedUserGroups = array(); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * @param string $gid |
|
155 | - * @return \OC\Group\Group |
|
156 | - */ |
|
157 | - public function get($gid) { |
|
158 | - if (isset($this->cachedGroups[$gid])) { |
|
159 | - return $this->cachedGroups[$gid]; |
|
160 | - } |
|
161 | - return $this->getGroupObject($gid); |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * @param string $gid |
|
166 | - * @param string $displayName |
|
167 | - * @return \OCP\IGroup |
|
168 | - */ |
|
169 | - protected function getGroupObject($gid, $displayName = null) { |
|
170 | - $backends = array(); |
|
171 | - foreach ($this->backends as $backend) { |
|
172 | - if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
173 | - $groupData = $backend->getGroupDetails($gid); |
|
174 | - if (is_array($groupData)) { |
|
175 | - // take the display name from the first backend that has a non-null one |
|
176 | - if (is_null($displayName) && isset($groupData['displayName'])) { |
|
177 | - $displayName = $groupData['displayName']; |
|
178 | - } |
|
179 | - $backends[] = $backend; |
|
180 | - } |
|
181 | - } else if ($backend->groupExists($gid)) { |
|
182 | - $backends[] = $backend; |
|
183 | - } |
|
184 | - } |
|
185 | - if (count($backends) === 0) { |
|
186 | - return null; |
|
187 | - } |
|
188 | - $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
189 | - return $this->cachedGroups[$gid]; |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * @param string $gid |
|
194 | - * @return bool |
|
195 | - */ |
|
196 | - public function groupExists($gid) { |
|
197 | - return $this->get($gid) instanceof IGroup; |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * @param string $gid |
|
202 | - * @return \OC\Group\Group |
|
203 | - */ |
|
204 | - public function createGroup($gid) { |
|
205 | - if ($gid === '' || $gid === null) { |
|
206 | - return false; |
|
207 | - } else if ($group = $this->get($gid)) { |
|
208 | - return $group; |
|
209 | - } else { |
|
210 | - $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
211 | - foreach ($this->backends as $backend) { |
|
212 | - if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
213 | - $backend->createGroup($gid); |
|
214 | - $group = $this->getGroupObject($gid); |
|
215 | - $this->emit('\OC\Group', 'postCreate', array($group)); |
|
216 | - return $group; |
|
217 | - } |
|
218 | - } |
|
219 | - return null; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - /** |
|
224 | - * @param string $search |
|
225 | - * @param int $limit |
|
226 | - * @param int $offset |
|
227 | - * @return \OC\Group\Group[] |
|
228 | - */ |
|
229 | - public function search($search, $limit = null, $offset = null) { |
|
230 | - $groups = array(); |
|
231 | - foreach ($this->backends as $backend) { |
|
232 | - $groupIds = $backend->getGroups($search, $limit, $offset); |
|
233 | - foreach ($groupIds as $groupId) { |
|
234 | - $aGroup = $this->get($groupId); |
|
235 | - if ($aGroup instanceof IGroup) { |
|
236 | - $groups[$groupId] = $aGroup; |
|
237 | - } else { |
|
238 | - $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | - } |
|
240 | - } |
|
241 | - if (!is_null($limit) and $limit <= 0) { |
|
242 | - return array_values($groups); |
|
243 | - } |
|
244 | - } |
|
245 | - return array_values($groups); |
|
246 | - } |
|
247 | - |
|
248 | - /** |
|
249 | - * @param \OC\User\User|null $user |
|
250 | - * @return \OC\Group\Group[] |
|
251 | - */ |
|
252 | - public function getUserGroups($user) { |
|
253 | - if (!$user instanceof IUser) { |
|
254 | - return []; |
|
255 | - } |
|
256 | - return $this->getUserIdGroups($user->getUID()); |
|
257 | - } |
|
258 | - |
|
259 | - /** |
|
260 | - * @param string $uid the user id |
|
261 | - * @return \OC\Group\Group[] |
|
262 | - */ |
|
263 | - public function getUserIdGroups($uid) { |
|
264 | - if (isset($this->cachedUserGroups[$uid])) { |
|
265 | - return $this->cachedUserGroups[$uid]; |
|
266 | - } |
|
267 | - $groups = array(); |
|
268 | - foreach ($this->backends as $backend) { |
|
269 | - $groupIds = $backend->getUserGroups($uid); |
|
270 | - if (is_array($groupIds)) { |
|
271 | - foreach ($groupIds as $groupId) { |
|
272 | - $aGroup = $this->get($groupId); |
|
273 | - if ($aGroup instanceof IGroup) { |
|
274 | - $groups[$groupId] = $aGroup; |
|
275 | - } else { |
|
276 | - $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
277 | - } |
|
278 | - } |
|
279 | - } |
|
280 | - } |
|
281 | - $this->cachedUserGroups[$uid] = $groups; |
|
282 | - return $this->cachedUserGroups[$uid]; |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Checks if a userId is in the admin group |
|
287 | - * @param string $userId |
|
288 | - * @return bool if admin |
|
289 | - */ |
|
290 | - public function isAdmin($userId) { |
|
291 | - return $this->isInGroup($userId, 'admin'); |
|
292 | - } |
|
293 | - |
|
294 | - /** |
|
295 | - * Checks if a userId is in a group |
|
296 | - * @param string $userId |
|
297 | - * @param string $group |
|
298 | - * @return bool if in group |
|
299 | - */ |
|
300 | - public function isInGroup($userId, $group) { |
|
301 | - return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
302 | - } |
|
303 | - |
|
304 | - /** |
|
305 | - * get a list of group ids for a user |
|
306 | - * @param \OC\User\User $user |
|
307 | - * @return array with group ids |
|
308 | - */ |
|
309 | - public function getUserGroupIds($user) { |
|
310 | - return array_map(function($value) { |
|
311 | - return (string) $value; |
|
312 | - }, array_keys($this->getUserGroups($user))); |
|
313 | - } |
|
314 | - |
|
315 | - /** |
|
316 | - * get a list of all display names in a group |
|
317 | - * @param string $gid |
|
318 | - * @param string $search |
|
319 | - * @param int $limit |
|
320 | - * @param int $offset |
|
321 | - * @return array an array of display names (value) and user ids (key) |
|
322 | - */ |
|
323 | - public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
324 | - $group = $this->get($gid); |
|
325 | - if(is_null($group)) { |
|
326 | - return array(); |
|
327 | - } |
|
328 | - |
|
329 | - $search = trim($search); |
|
330 | - $groupUsers = array(); |
|
331 | - |
|
332 | - if(!empty($search)) { |
|
333 | - // only user backends have the capability to do a complex search for users |
|
334 | - $searchOffset = 0; |
|
335 | - $searchLimit = $limit * 100; |
|
336 | - if($limit === -1) { |
|
337 | - $searchLimit = 500; |
|
338 | - } |
|
339 | - |
|
340 | - do { |
|
341 | - $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
342 | - foreach($filteredUsers as $filteredUser) { |
|
343 | - if($group->inGroup($filteredUser)) { |
|
344 | - $groupUsers[]= $filteredUser; |
|
345 | - } |
|
346 | - } |
|
347 | - $searchOffset += $searchLimit; |
|
348 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
349 | - |
|
350 | - if($limit === -1) { |
|
351 | - $groupUsers = array_slice($groupUsers, $offset); |
|
352 | - } else { |
|
353 | - $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
354 | - } |
|
355 | - } else { |
|
356 | - $groupUsers = $group->searchUsers('', $limit, $offset); |
|
357 | - } |
|
358 | - |
|
359 | - $matchingUsers = array(); |
|
360 | - foreach($groupUsers as $groupUser) { |
|
361 | - $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
362 | - } |
|
363 | - return $matchingUsers; |
|
364 | - } |
|
365 | - |
|
366 | - /** |
|
367 | - * @return \OC\SubAdmin |
|
368 | - */ |
|
369 | - public function getSubAdmin() { |
|
370 | - if (!$this->subAdmin) { |
|
371 | - $this->subAdmin = new \OC\SubAdmin( |
|
372 | - $this->userManager, |
|
373 | - $this, |
|
374 | - \OC::$server->getDatabaseConnection() |
|
375 | - ); |
|
376 | - } |
|
377 | - |
|
378 | - return $this->subAdmin; |
|
379 | - } |
|
148 | + protected function clearCaches() { |
|
149 | + $this->cachedGroups = array(); |
|
150 | + $this->cachedUserGroups = array(); |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * @param string $gid |
|
155 | + * @return \OC\Group\Group |
|
156 | + */ |
|
157 | + public function get($gid) { |
|
158 | + if (isset($this->cachedGroups[$gid])) { |
|
159 | + return $this->cachedGroups[$gid]; |
|
160 | + } |
|
161 | + return $this->getGroupObject($gid); |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * @param string $gid |
|
166 | + * @param string $displayName |
|
167 | + * @return \OCP\IGroup |
|
168 | + */ |
|
169 | + protected function getGroupObject($gid, $displayName = null) { |
|
170 | + $backends = array(); |
|
171 | + foreach ($this->backends as $backend) { |
|
172 | + if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
173 | + $groupData = $backend->getGroupDetails($gid); |
|
174 | + if (is_array($groupData)) { |
|
175 | + // take the display name from the first backend that has a non-null one |
|
176 | + if (is_null($displayName) && isset($groupData['displayName'])) { |
|
177 | + $displayName = $groupData['displayName']; |
|
178 | + } |
|
179 | + $backends[] = $backend; |
|
180 | + } |
|
181 | + } else if ($backend->groupExists($gid)) { |
|
182 | + $backends[] = $backend; |
|
183 | + } |
|
184 | + } |
|
185 | + if (count($backends) === 0) { |
|
186 | + return null; |
|
187 | + } |
|
188 | + $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
189 | + return $this->cachedGroups[$gid]; |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * @param string $gid |
|
194 | + * @return bool |
|
195 | + */ |
|
196 | + public function groupExists($gid) { |
|
197 | + return $this->get($gid) instanceof IGroup; |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * @param string $gid |
|
202 | + * @return \OC\Group\Group |
|
203 | + */ |
|
204 | + public function createGroup($gid) { |
|
205 | + if ($gid === '' || $gid === null) { |
|
206 | + return false; |
|
207 | + } else if ($group = $this->get($gid)) { |
|
208 | + return $group; |
|
209 | + } else { |
|
210 | + $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
211 | + foreach ($this->backends as $backend) { |
|
212 | + if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
213 | + $backend->createGroup($gid); |
|
214 | + $group = $this->getGroupObject($gid); |
|
215 | + $this->emit('\OC\Group', 'postCreate', array($group)); |
|
216 | + return $group; |
|
217 | + } |
|
218 | + } |
|
219 | + return null; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + /** |
|
224 | + * @param string $search |
|
225 | + * @param int $limit |
|
226 | + * @param int $offset |
|
227 | + * @return \OC\Group\Group[] |
|
228 | + */ |
|
229 | + public function search($search, $limit = null, $offset = null) { |
|
230 | + $groups = array(); |
|
231 | + foreach ($this->backends as $backend) { |
|
232 | + $groupIds = $backend->getGroups($search, $limit, $offset); |
|
233 | + foreach ($groupIds as $groupId) { |
|
234 | + $aGroup = $this->get($groupId); |
|
235 | + if ($aGroup instanceof IGroup) { |
|
236 | + $groups[$groupId] = $aGroup; |
|
237 | + } else { |
|
238 | + $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); |
|
239 | + } |
|
240 | + } |
|
241 | + if (!is_null($limit) and $limit <= 0) { |
|
242 | + return array_values($groups); |
|
243 | + } |
|
244 | + } |
|
245 | + return array_values($groups); |
|
246 | + } |
|
247 | + |
|
248 | + /** |
|
249 | + * @param \OC\User\User|null $user |
|
250 | + * @return \OC\Group\Group[] |
|
251 | + */ |
|
252 | + public function getUserGroups($user) { |
|
253 | + if (!$user instanceof IUser) { |
|
254 | + return []; |
|
255 | + } |
|
256 | + return $this->getUserIdGroups($user->getUID()); |
|
257 | + } |
|
258 | + |
|
259 | + /** |
|
260 | + * @param string $uid the user id |
|
261 | + * @return \OC\Group\Group[] |
|
262 | + */ |
|
263 | + public function getUserIdGroups($uid) { |
|
264 | + if (isset($this->cachedUserGroups[$uid])) { |
|
265 | + return $this->cachedUserGroups[$uid]; |
|
266 | + } |
|
267 | + $groups = array(); |
|
268 | + foreach ($this->backends as $backend) { |
|
269 | + $groupIds = $backend->getUserGroups($uid); |
|
270 | + if (is_array($groupIds)) { |
|
271 | + foreach ($groupIds as $groupId) { |
|
272 | + $aGroup = $this->get($groupId); |
|
273 | + if ($aGroup instanceof IGroup) { |
|
274 | + $groups[$groupId] = $aGroup; |
|
275 | + } else { |
|
276 | + $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
|
277 | + } |
|
278 | + } |
|
279 | + } |
|
280 | + } |
|
281 | + $this->cachedUserGroups[$uid] = $groups; |
|
282 | + return $this->cachedUserGroups[$uid]; |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Checks if a userId is in the admin group |
|
287 | + * @param string $userId |
|
288 | + * @return bool if admin |
|
289 | + */ |
|
290 | + public function isAdmin($userId) { |
|
291 | + return $this->isInGroup($userId, 'admin'); |
|
292 | + } |
|
293 | + |
|
294 | + /** |
|
295 | + * Checks if a userId is in a group |
|
296 | + * @param string $userId |
|
297 | + * @param string $group |
|
298 | + * @return bool if in group |
|
299 | + */ |
|
300 | + public function isInGroup($userId, $group) { |
|
301 | + return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
302 | + } |
|
303 | + |
|
304 | + /** |
|
305 | + * get a list of group ids for a user |
|
306 | + * @param \OC\User\User $user |
|
307 | + * @return array with group ids |
|
308 | + */ |
|
309 | + public function getUserGroupIds($user) { |
|
310 | + return array_map(function($value) { |
|
311 | + return (string) $value; |
|
312 | + }, array_keys($this->getUserGroups($user))); |
|
313 | + } |
|
314 | + |
|
315 | + /** |
|
316 | + * get a list of all display names in a group |
|
317 | + * @param string $gid |
|
318 | + * @param string $search |
|
319 | + * @param int $limit |
|
320 | + * @param int $offset |
|
321 | + * @return array an array of display names (value) and user ids (key) |
|
322 | + */ |
|
323 | + public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
324 | + $group = $this->get($gid); |
|
325 | + if(is_null($group)) { |
|
326 | + return array(); |
|
327 | + } |
|
328 | + |
|
329 | + $search = trim($search); |
|
330 | + $groupUsers = array(); |
|
331 | + |
|
332 | + if(!empty($search)) { |
|
333 | + // only user backends have the capability to do a complex search for users |
|
334 | + $searchOffset = 0; |
|
335 | + $searchLimit = $limit * 100; |
|
336 | + if($limit === -1) { |
|
337 | + $searchLimit = 500; |
|
338 | + } |
|
339 | + |
|
340 | + do { |
|
341 | + $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
342 | + foreach($filteredUsers as $filteredUser) { |
|
343 | + if($group->inGroup($filteredUser)) { |
|
344 | + $groupUsers[]= $filteredUser; |
|
345 | + } |
|
346 | + } |
|
347 | + $searchOffset += $searchLimit; |
|
348 | + } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
349 | + |
|
350 | + if($limit === -1) { |
|
351 | + $groupUsers = array_slice($groupUsers, $offset); |
|
352 | + } else { |
|
353 | + $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
354 | + } |
|
355 | + } else { |
|
356 | + $groupUsers = $group->searchUsers('', $limit, $offset); |
|
357 | + } |
|
358 | + |
|
359 | + $matchingUsers = array(); |
|
360 | + foreach($groupUsers as $groupUser) { |
|
361 | + $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
362 | + } |
|
363 | + return $matchingUsers; |
|
364 | + } |
|
365 | + |
|
366 | + /** |
|
367 | + * @return \OC\SubAdmin |
|
368 | + */ |
|
369 | + public function getSubAdmin() { |
|
370 | + if (!$this->subAdmin) { |
|
371 | + $this->subAdmin = new \OC\SubAdmin( |
|
372 | + $this->userManager, |
|
373 | + $this, |
|
374 | + \OC::$server->getDatabaseConnection() |
|
375 | + ); |
|
376 | + } |
|
377 | + |
|
378 | + return $this->subAdmin; |
|
379 | + } |
|
380 | 380 | } |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | * make preview_icon available as a simple function |
184 | 184 | * Returns the path to the preview of the image. |
185 | 185 | * @param string $path path of file |
186 | - * @return link to the preview |
|
186 | + * @return string to the preview |
|
187 | 187 | */ |
188 | 188 | function preview_icon( $path ) { |
189 | 189 | return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
@@ -191,6 +191,7 @@ discard block |
||
191 | 191 | |
192 | 192 | /** |
193 | 193 | * @param string $path |
194 | + * @param string $token |
|
194 | 195 | */ |
195 | 196 | function publicPreview_icon ( $path, $token ) { |
196 | 197 | return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
@@ -34,7 +34,7 @@ discard block |
||
34 | 34 | * @param string $string the string which will be escaped and printed |
35 | 35 | */ |
36 | 36 | function p($string) { |
37 | - print(\OCP\Util::sanitizeHTML($string)); |
|
37 | + print(\OCP\Util::sanitizeHTML($string)); |
|
38 | 38 | } |
39 | 39 | |
40 | 40 | /** |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | * @param string|array $string the string which will be printed as it is |
44 | 44 | */ |
45 | 45 | function print_unescaped($string) { |
46 | - print($string); |
|
46 | + print($string); |
|
47 | 47 | } |
48 | 48 | |
49 | 49 | /** |
@@ -53,13 +53,13 @@ discard block |
||
53 | 53 | * if an array is given it will add all scripts |
54 | 54 | */ |
55 | 55 | function script($app, $file = null) { |
56 | - if(is_array($file)) { |
|
57 | - foreach($file as $f) { |
|
58 | - OC_Util::addScript($app, $f); |
|
59 | - } |
|
60 | - } else { |
|
61 | - OC_Util::addScript($app, $file); |
|
62 | - } |
|
56 | + if(is_array($file)) { |
|
57 | + foreach($file as $f) { |
|
58 | + OC_Util::addScript($app, $f); |
|
59 | + } |
|
60 | + } else { |
|
61 | + OC_Util::addScript($app, $file); |
|
62 | + } |
|
63 | 63 | } |
64 | 64 | |
65 | 65 | /** |
@@ -69,13 +69,13 @@ discard block |
||
69 | 69 | * if an array is given it will add all scripts |
70 | 70 | */ |
71 | 71 | function vendor_script($app, $file = null) { |
72 | - if(is_array($file)) { |
|
73 | - foreach($file as $f) { |
|
74 | - OC_Util::addVendorScript($app, $f); |
|
75 | - } |
|
76 | - } else { |
|
77 | - OC_Util::addVendorScript($app, $file); |
|
78 | - } |
|
72 | + if(is_array($file)) { |
|
73 | + foreach($file as $f) { |
|
74 | + OC_Util::addVendorScript($app, $f); |
|
75 | + } |
|
76 | + } else { |
|
77 | + OC_Util::addVendorScript($app, $file); |
|
78 | + } |
|
79 | 79 | } |
80 | 80 | |
81 | 81 | /** |
@@ -85,13 +85,13 @@ discard block |
||
85 | 85 | * if an array is given it will add all styles |
86 | 86 | */ |
87 | 87 | function style($app, $file = null) { |
88 | - if(is_array($file)) { |
|
89 | - foreach($file as $f) { |
|
90 | - OC_Util::addStyle($app, $f); |
|
91 | - } |
|
92 | - } else { |
|
93 | - OC_Util::addStyle($app, $file); |
|
94 | - } |
|
88 | + if(is_array($file)) { |
|
89 | + foreach($file as $f) { |
|
90 | + OC_Util::addStyle($app, $f); |
|
91 | + } |
|
92 | + } else { |
|
93 | + OC_Util::addStyle($app, $file); |
|
94 | + } |
|
95 | 95 | } |
96 | 96 | |
97 | 97 | /** |
@@ -101,13 +101,13 @@ discard block |
||
101 | 101 | * if an array is given it will add all styles |
102 | 102 | */ |
103 | 103 | function vendor_style($app, $file = null) { |
104 | - if(is_array($file)) { |
|
105 | - foreach($file as $f) { |
|
106 | - OC_Util::addVendorStyle($app, $f); |
|
107 | - } |
|
108 | - } else { |
|
109 | - OC_Util::addVendorStyle($app, $file); |
|
110 | - } |
|
104 | + if(is_array($file)) { |
|
105 | + foreach($file as $f) { |
|
106 | + OC_Util::addVendorStyle($app, $f); |
|
107 | + } |
|
108 | + } else { |
|
109 | + OC_Util::addVendorStyle($app, $file); |
|
110 | + } |
|
111 | 111 | } |
112 | 112 | |
113 | 113 | /** |
@@ -116,7 +116,7 @@ discard block |
||
116 | 116 | * if an array is given it will add all styles |
117 | 117 | */ |
118 | 118 | function translation($app) { |
119 | - OC_Util::addTranslations($app); |
|
119 | + OC_Util::addTranslations($app); |
|
120 | 120 | } |
121 | 121 | |
122 | 122 | /** |
@@ -126,15 +126,15 @@ discard block |
||
126 | 126 | * if an array is given it will add all components |
127 | 127 | */ |
128 | 128 | function component($app, $file) { |
129 | - if(is_array($file)) { |
|
130 | - foreach($file as $f) { |
|
131 | - $url = link_to($app, 'component/' . $f . '.html'); |
|
132 | - OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
133 | - } |
|
134 | - } else { |
|
135 | - $url = link_to($app, 'component/' . $file . '.html'); |
|
136 | - OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
137 | - } |
|
129 | + if(is_array($file)) { |
|
130 | + foreach($file as $f) { |
|
131 | + $url = link_to($app, 'component/' . $f . '.html'); |
|
132 | + OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
133 | + } |
|
134 | + } else { |
|
135 | + $url = link_to($app, 'component/' . $file . '.html'); |
|
136 | + OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
137 | + } |
|
138 | 138 | } |
139 | 139 | |
140 | 140 | /** |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | * For further information have a look at \OCP\IURLGenerator::linkTo |
148 | 148 | */ |
149 | 149 | function link_to( $app, $file, $args = array() ) { |
150 | - return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
|
150 | + return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | /** |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | * @return string url to the online documentation |
156 | 156 | */ |
157 | 157 | function link_to_docs($key) { |
158 | - return \OC::$server->getURLGenerator()->linkToDocs($key); |
|
158 | + return \OC::$server->getURLGenerator()->linkToDocs($key); |
|
159 | 159 | } |
160 | 160 | |
161 | 161 | /** |
@@ -167,7 +167,7 @@ discard block |
||
167 | 167 | * For further information have a look at \OCP\IURLGenerator::imagePath |
168 | 168 | */ |
169 | 169 | function image_path( $app, $image ) { |
170 | - return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
170 | + return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
171 | 171 | } |
172 | 172 | |
173 | 173 | /** |
@@ -176,7 +176,7 @@ discard block |
||
176 | 176 | * @return string link to the image |
177 | 177 | */ |
178 | 178 | function mimetype_icon( $mimetype ) { |
179 | - return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
179 | + return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
180 | 180 | } |
181 | 181 | |
182 | 182 | /** |
@@ -186,14 +186,14 @@ discard block |
||
186 | 186 | * @return link to the preview |
187 | 187 | */ |
188 | 188 | function preview_icon( $path ) { |
189 | - return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
|
189 | + return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
|
190 | 190 | } |
191 | 191 | |
192 | 192 | /** |
193 | 193 | * @param string $path |
194 | 194 | */ |
195 | 195 | function publicPreview_icon ( $path, $token ) { |
196 | - return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
|
196 | + return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
|
197 | 197 | } |
198 | 198 | |
199 | 199 | /** |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | * For further information have a look at OC_Helper::humanFileSize |
205 | 205 | */ |
206 | 206 | function human_file_size( $bytes ) { |
207 | - return OC_Helper::humanFileSize( $bytes ); |
|
207 | + return OC_Helper::humanFileSize( $bytes ); |
|
208 | 208 | } |
209 | 209 | |
210 | 210 | /** |
@@ -213,9 +213,9 @@ discard block |
||
213 | 213 | * @return $timestamp without time value |
214 | 214 | */ |
215 | 215 | function strip_time($timestamp){ |
216 | - $date = new \DateTime("@{$timestamp}"); |
|
217 | - $date->setTime(0, 0, 0); |
|
218 | - return intval($date->format('U')); |
|
216 | + $date = new \DateTime("@{$timestamp}"); |
|
217 | + $date->setTime(0, 0, 0); |
|
218 | + return intval($date->format('U')); |
|
219 | 219 | } |
220 | 220 | |
221 | 221 | /** |
@@ -227,39 +227,39 @@ discard block |
||
227 | 227 | * @return string timestamp |
228 | 228 | */ |
229 | 229 | function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) { |
230 | - /** @var \OC\DateTimeFormatter $formatter */ |
|
231 | - $formatter = \OC::$server->query('DateTimeFormatter'); |
|
230 | + /** @var \OC\DateTimeFormatter $formatter */ |
|
231 | + $formatter = \OC::$server->query('DateTimeFormatter'); |
|
232 | 232 | |
233 | - if ($dateOnly){ |
|
234 | - return $formatter->formatDateSpan($timestamp, $fromTime); |
|
235 | - } |
|
236 | - return $formatter->formatTimeSpan($timestamp, $fromTime); |
|
233 | + if ($dateOnly){ |
|
234 | + return $formatter->formatDateSpan($timestamp, $fromTime); |
|
235 | + } |
|
236 | + return $formatter->formatTimeSpan($timestamp, $fromTime); |
|
237 | 237 | } |
238 | 238 | |
239 | 239 | function html_select_options($options, $selected, $params=array()) { |
240 | - if (!is_array($selected)) { |
|
241 | - $selected=array($selected); |
|
242 | - } |
|
243 | - if (isset($params['combine']) && $params['combine']) { |
|
244 | - $options = array_combine($options, $options); |
|
245 | - } |
|
246 | - $value_name = $label_name = false; |
|
247 | - if (isset($params['value'])) { |
|
248 | - $value_name = $params['value']; |
|
249 | - } |
|
250 | - if (isset($params['label'])) { |
|
251 | - $label_name = $params['label']; |
|
252 | - } |
|
253 | - $html = ''; |
|
254 | - foreach($options as $value => $label) { |
|
255 | - if ($value_name && is_array($label)) { |
|
256 | - $value = $label[$value_name]; |
|
257 | - } |
|
258 | - if ($label_name && is_array($label)) { |
|
259 | - $label = $label[$label_name]; |
|
260 | - } |
|
261 | - $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
|
262 | - $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
263 | - } |
|
264 | - return $html; |
|
240 | + if (!is_array($selected)) { |
|
241 | + $selected=array($selected); |
|
242 | + } |
|
243 | + if (isset($params['combine']) && $params['combine']) { |
|
244 | + $options = array_combine($options, $options); |
|
245 | + } |
|
246 | + $value_name = $label_name = false; |
|
247 | + if (isset($params['value'])) { |
|
248 | + $value_name = $params['value']; |
|
249 | + } |
|
250 | + if (isset($params['label'])) { |
|
251 | + $label_name = $params['label']; |
|
252 | + } |
|
253 | + $html = ''; |
|
254 | + foreach($options as $value => $label) { |
|
255 | + if ($value_name && is_array($label)) { |
|
256 | + $value = $label[$value_name]; |
|
257 | + } |
|
258 | + if ($label_name && is_array($label)) { |
|
259 | + $label = $label[$label_name]; |
|
260 | + } |
|
261 | + $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
|
262 | + $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
263 | + } |
|
264 | + return $html; |
|
265 | 265 | } |
@@ -53,8 +53,8 @@ discard block |
||
53 | 53 | * if an array is given it will add all scripts |
54 | 54 | */ |
55 | 55 | function script($app, $file = null) { |
56 | - if(is_array($file)) { |
|
57 | - foreach($file as $f) { |
|
56 | + if (is_array($file)) { |
|
57 | + foreach ($file as $f) { |
|
58 | 58 | OC_Util::addScript($app, $f); |
59 | 59 | } |
60 | 60 | } else { |
@@ -69,8 +69,8 @@ discard block |
||
69 | 69 | * if an array is given it will add all scripts |
70 | 70 | */ |
71 | 71 | function vendor_script($app, $file = null) { |
72 | - if(is_array($file)) { |
|
73 | - foreach($file as $f) { |
|
72 | + if (is_array($file)) { |
|
73 | + foreach ($file as $f) { |
|
74 | 74 | OC_Util::addVendorScript($app, $f); |
75 | 75 | } |
76 | 76 | } else { |
@@ -85,8 +85,8 @@ discard block |
||
85 | 85 | * if an array is given it will add all styles |
86 | 86 | */ |
87 | 87 | function style($app, $file = null) { |
88 | - if(is_array($file)) { |
|
89 | - foreach($file as $f) { |
|
88 | + if (is_array($file)) { |
|
89 | + foreach ($file as $f) { |
|
90 | 90 | OC_Util::addStyle($app, $f); |
91 | 91 | } |
92 | 92 | } else { |
@@ -101,8 +101,8 @@ discard block |
||
101 | 101 | * if an array is given it will add all styles |
102 | 102 | */ |
103 | 103 | function vendor_style($app, $file = null) { |
104 | - if(is_array($file)) { |
|
105 | - foreach($file as $f) { |
|
104 | + if (is_array($file)) { |
|
105 | + foreach ($file as $f) { |
|
106 | 106 | OC_Util::addVendorStyle($app, $f); |
107 | 107 | } |
108 | 108 | } else { |
@@ -126,13 +126,13 @@ discard block |
||
126 | 126 | * if an array is given it will add all components |
127 | 127 | */ |
128 | 128 | function component($app, $file) { |
129 | - if(is_array($file)) { |
|
130 | - foreach($file as $f) { |
|
131 | - $url = link_to($app, 'component/' . $f . '.html'); |
|
129 | + if (is_array($file)) { |
|
130 | + foreach ($file as $f) { |
|
131 | + $url = link_to($app, 'component/'.$f.'.html'); |
|
132 | 132 | OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
133 | 133 | } |
134 | 134 | } else { |
135 | - $url = link_to($app, 'component/' . $file . '.html'); |
|
135 | + $url = link_to($app, 'component/'.$file.'.html'); |
|
136 | 136 | OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
137 | 137 | } |
138 | 138 | } |
@@ -146,7 +146,7 @@ discard block |
||
146 | 146 | * |
147 | 147 | * For further information have a look at \OCP\IURLGenerator::linkTo |
148 | 148 | */ |
149 | -function link_to( $app, $file, $args = array() ) { |
|
149 | +function link_to($app, $file, $args = array()) { |
|
150 | 150 | return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
151 | 151 | } |
152 | 152 | |
@@ -166,8 +166,8 @@ discard block |
||
166 | 166 | * |
167 | 167 | * For further information have a look at \OCP\IURLGenerator::imagePath |
168 | 168 | */ |
169 | -function image_path( $app, $image ) { |
|
170 | - return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
169 | +function image_path($app, $image) { |
|
170 | + return \OC::$server->getURLGenerator()->imagePath($app, $image); |
|
171 | 171 | } |
172 | 172 | |
173 | 173 | /** |
@@ -175,8 +175,8 @@ discard block |
||
175 | 175 | * @param string $mimetype mimetype |
176 | 176 | * @return string link to the image |
177 | 177 | */ |
178 | -function mimetype_icon( $mimetype ) { |
|
179 | - return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
178 | +function mimetype_icon($mimetype) { |
|
179 | + return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype); |
|
180 | 180 | } |
181 | 181 | |
182 | 182 | /** |
@@ -185,14 +185,14 @@ discard block |
||
185 | 185 | * @param string $path path of file |
186 | 186 | * @return link to the preview |
187 | 187 | */ |
188 | -function preview_icon( $path ) { |
|
188 | +function preview_icon($path) { |
|
189 | 189 | return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
190 | 190 | } |
191 | 191 | |
192 | 192 | /** |
193 | 193 | * @param string $path |
194 | 194 | */ |
195 | -function publicPreview_icon ( $path, $token ) { |
|
195 | +function publicPreview_icon($path, $token) { |
|
196 | 196 | return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
197 | 197 | } |
198 | 198 | |
@@ -203,8 +203,8 @@ discard block |
||
203 | 203 | * |
204 | 204 | * For further information have a look at OC_Helper::humanFileSize |
205 | 205 | */ |
206 | -function human_file_size( $bytes ) { |
|
207 | - return OC_Helper::humanFileSize( $bytes ); |
|
206 | +function human_file_size($bytes) { |
|
207 | + return OC_Helper::humanFileSize($bytes); |
|
208 | 208 | } |
209 | 209 | |
210 | 210 | /** |
@@ -212,7 +212,7 @@ discard block |
||
212 | 212 | * @param int $timestamp UNIX timestamp to strip |
213 | 213 | * @return $timestamp without time value |
214 | 214 | */ |
215 | -function strip_time($timestamp){ |
|
215 | +function strip_time($timestamp) { |
|
216 | 216 | $date = new \DateTime("@{$timestamp}"); |
217 | 217 | $date->setTime(0, 0, 0); |
218 | 218 | return intval($date->format('U')); |
@@ -230,15 +230,15 @@ discard block |
||
230 | 230 | /** @var \OC\DateTimeFormatter $formatter */ |
231 | 231 | $formatter = \OC::$server->query('DateTimeFormatter'); |
232 | 232 | |
233 | - if ($dateOnly){ |
|
233 | + if ($dateOnly) { |
|
234 | 234 | return $formatter->formatDateSpan($timestamp, $fromTime); |
235 | 235 | } |
236 | 236 | return $formatter->formatTimeSpan($timestamp, $fromTime); |
237 | 237 | } |
238 | 238 | |
239 | -function html_select_options($options, $selected, $params=array()) { |
|
239 | +function html_select_options($options, $selected, $params = array()) { |
|
240 | 240 | if (!is_array($selected)) { |
241 | - $selected=array($selected); |
|
241 | + $selected = array($selected); |
|
242 | 242 | } |
243 | 243 | if (isset($params['combine']) && $params['combine']) { |
244 | 244 | $options = array_combine($options, $options); |
@@ -251,7 +251,7 @@ discard block |
||
251 | 251 | $label_name = $params['label']; |
252 | 252 | } |
253 | 253 | $html = ''; |
254 | - foreach($options as $value => $label) { |
|
254 | + foreach ($options as $value => $label) { |
|
255 | 255 | if ($value_name && is_array($label)) { |
256 | 256 | $value = $label[$value_name]; |
257 | 257 | } |
@@ -259,7 +259,7 @@ discard block |
||
259 | 259 | $label = $label[$label_name]; |
260 | 260 | } |
261 | 261 | $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
262 | - $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
262 | + $html .= '<option value="'.\OCP\Util::sanitizeHTML($value).'"'.$select.'>'.\OCP\Util::sanitizeHTML($label).'</option>'."\n"; |
|
263 | 263 | } |
264 | 264 | return $html; |
265 | 265 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | * Set a value in the cache if it's not already stored |
66 | 66 | * |
67 | 67 | * @param string $key |
68 | - * @param mixed $value |
|
68 | + * @param integer $value |
|
69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
70 | 70 | * @return bool |
71 | 71 | */ |
@@ -30,140 +30,140 @@ |
||
30 | 30 | use OCP\IMemcache; |
31 | 31 | |
32 | 32 | class APCu extends Cache implements IMemcache { |
33 | - use CASTrait { |
|
34 | - cas as casEmulated; |
|
35 | - } |
|
33 | + use CASTrait { |
|
34 | + cas as casEmulated; |
|
35 | + } |
|
36 | 36 | |
37 | - use CADTrait; |
|
37 | + use CADTrait; |
|
38 | 38 | |
39 | - public function get($key) { |
|
40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | - if (!$success) { |
|
42 | - return null; |
|
43 | - } |
|
44 | - return $result; |
|
45 | - } |
|
39 | + public function get($key) { |
|
40 | + $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
41 | + if (!$success) { |
|
42 | + return null; |
|
43 | + } |
|
44 | + return $result; |
|
45 | + } |
|
46 | 46 | |
47 | - public function set($key, $value, $ttl = 0) { |
|
48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | - } |
|
47 | + public function set($key, $value, $ttl = 0) { |
|
48 | + return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
49 | + } |
|
50 | 50 | |
51 | - public function hasKey($key) { |
|
52 | - return apcu_exists($this->getPrefix() . $key); |
|
53 | - } |
|
51 | + public function hasKey($key) { |
|
52 | + return apcu_exists($this->getPrefix() . $key); |
|
53 | + } |
|
54 | 54 | |
55 | - public function remove($key) { |
|
56 | - return apcu_delete($this->getPrefix() . $key); |
|
57 | - } |
|
55 | + public function remove($key) { |
|
56 | + return apcu_delete($this->getPrefix() . $key); |
|
57 | + } |
|
58 | 58 | |
59 | - public function clear($prefix = '') { |
|
60 | - $ns = $this->getPrefix() . $prefix; |
|
61 | - $ns = preg_quote($ns, '/'); |
|
62 | - if(class_exists('\APCIterator')) { |
|
63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | - } else { |
|
65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | - } |
|
67 | - return apcu_delete($iter); |
|
68 | - } |
|
59 | + public function clear($prefix = '') { |
|
60 | + $ns = $this->getPrefix() . $prefix; |
|
61 | + $ns = preg_quote($ns, '/'); |
|
62 | + if(class_exists('\APCIterator')) { |
|
63 | + $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
64 | + } else { |
|
65 | + $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
66 | + } |
|
67 | + return apcu_delete($iter); |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * Set a value in the cache if it's not already stored |
|
72 | - * |
|
73 | - * @param string $key |
|
74 | - * @param mixed $value |
|
75 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | - * @return bool |
|
77 | - */ |
|
78 | - public function add($key, $value, $ttl = 0) { |
|
79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | - } |
|
70 | + /** |
|
71 | + * Set a value in the cache if it's not already stored |
|
72 | + * |
|
73 | + * @param string $key |
|
74 | + * @param mixed $value |
|
75 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
76 | + * @return bool |
|
77 | + */ |
|
78 | + public function add($key, $value, $ttl = 0) { |
|
79 | + return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * Increase a stored number |
|
84 | - * |
|
85 | - * @param string $key |
|
86 | - * @param int $step |
|
87 | - * @return int | bool |
|
88 | - */ |
|
89 | - public function inc($key, $step = 1) { |
|
90 | - $this->add($key, 0); |
|
91 | - /** |
|
92 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | - * |
|
94 | - * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | - * "0" and result in "1" as value - therefore we check for existence |
|
96 | - * first |
|
97 | - * |
|
98 | - * on PHP 5.6 this is not the case |
|
99 | - * |
|
100 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | - * for details |
|
102 | - */ |
|
103 | - return apcu_exists($this->getPrefix() . $key) |
|
104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | - : false; |
|
106 | - } |
|
82 | + /** |
|
83 | + * Increase a stored number |
|
84 | + * |
|
85 | + * @param string $key |
|
86 | + * @param int $step |
|
87 | + * @return int | bool |
|
88 | + */ |
|
89 | + public function inc($key, $step = 1) { |
|
90 | + $this->add($key, 0); |
|
91 | + /** |
|
92 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
93 | + * |
|
94 | + * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
95 | + * "0" and result in "1" as value - therefore we check for existence |
|
96 | + * first |
|
97 | + * |
|
98 | + * on PHP 5.6 this is not the case |
|
99 | + * |
|
100 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
101 | + * for details |
|
102 | + */ |
|
103 | + return apcu_exists($this->getPrefix() . $key) |
|
104 | + ? apcu_inc($this->getPrefix() . $key, $step) |
|
105 | + : false; |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Decrease a stored number |
|
110 | - * |
|
111 | - * @param string $key |
|
112 | - * @param int $step |
|
113 | - * @return int | bool |
|
114 | - */ |
|
115 | - public function dec($key, $step = 1) { |
|
116 | - /** |
|
117 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | - * |
|
119 | - * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | - * "0" and result in "-1" as value - therefore we check for existence |
|
121 | - * first |
|
122 | - * |
|
123 | - * on PHP 5.6 this is not the case |
|
124 | - * |
|
125 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | - * for details |
|
127 | - */ |
|
128 | - return apcu_exists($this->getPrefix() . $key) |
|
129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | - : false; |
|
131 | - } |
|
108 | + /** |
|
109 | + * Decrease a stored number |
|
110 | + * |
|
111 | + * @param string $key |
|
112 | + * @param int $step |
|
113 | + * @return int | bool |
|
114 | + */ |
|
115 | + public function dec($key, $step = 1) { |
|
116 | + /** |
|
117 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
118 | + * |
|
119 | + * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
120 | + * "0" and result in "-1" as value - therefore we check for existence |
|
121 | + * first |
|
122 | + * |
|
123 | + * on PHP 5.6 this is not the case |
|
124 | + * |
|
125 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
126 | + * for details |
|
127 | + */ |
|
128 | + return apcu_exists($this->getPrefix() . $key) |
|
129 | + ? apcu_dec($this->getPrefix() . $key, $step) |
|
130 | + : false; |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * Compare and set |
|
135 | - * |
|
136 | - * @param string $key |
|
137 | - * @param mixed $old |
|
138 | - * @param mixed $new |
|
139 | - * @return bool |
|
140 | - */ |
|
141 | - public function cas($key, $old, $new) { |
|
142 | - // apc only does cas for ints |
|
143 | - if (is_int($old) and is_int($new)) { |
|
144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | - } else { |
|
146 | - return $this->casEmulated($key, $old, $new); |
|
147 | - } |
|
148 | - } |
|
133 | + /** |
|
134 | + * Compare and set |
|
135 | + * |
|
136 | + * @param string $key |
|
137 | + * @param mixed $old |
|
138 | + * @param mixed $new |
|
139 | + * @return bool |
|
140 | + */ |
|
141 | + public function cas($key, $old, $new) { |
|
142 | + // apc only does cas for ints |
|
143 | + if (is_int($old) and is_int($new)) { |
|
144 | + return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
145 | + } else { |
|
146 | + return $this->casEmulated($key, $old, $new); |
|
147 | + } |
|
148 | + } |
|
149 | 149 | |
150 | - /** |
|
151 | - * @return bool |
|
152 | - */ |
|
153 | - static public function isAvailable() { |
|
154 | - if (!extension_loaded('apcu')) { |
|
155 | - return false; |
|
156 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | - return false; |
|
158 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | - return false; |
|
160 | - } elseif ( |
|
161 | - version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | - version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | - ) { |
|
164 | - return false; |
|
165 | - } else { |
|
166 | - return true; |
|
167 | - } |
|
168 | - } |
|
150 | + /** |
|
151 | + * @return bool |
|
152 | + */ |
|
153 | + static public function isAvailable() { |
|
154 | + if (!extension_loaded('apcu')) { |
|
155 | + return false; |
|
156 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
157 | + return false; |
|
158 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
159 | + return false; |
|
160 | + } elseif ( |
|
161 | + version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
162 | + version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
163 | + ) { |
|
164 | + return false; |
|
165 | + } else { |
|
166 | + return true; |
|
167 | + } |
|
168 | + } |
|
169 | 169 | } |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | use CADTrait; |
38 | 38 | |
39 | 39 | public function get($key) { |
40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
40 | + $result = apcu_fetch($this->getPrefix().$key, $success); |
|
41 | 41 | if (!$success) { |
42 | 42 | return null; |
43 | 43 | } |
@@ -45,24 +45,24 @@ discard block |
||
45 | 45 | } |
46 | 46 | |
47 | 47 | public function set($key, $value, $ttl = 0) { |
48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
48 | + return apcu_store($this->getPrefix().$key, $value, $ttl); |
|
49 | 49 | } |
50 | 50 | |
51 | 51 | public function hasKey($key) { |
52 | - return apcu_exists($this->getPrefix() . $key); |
|
52 | + return apcu_exists($this->getPrefix().$key); |
|
53 | 53 | } |
54 | 54 | |
55 | 55 | public function remove($key) { |
56 | - return apcu_delete($this->getPrefix() . $key); |
|
56 | + return apcu_delete($this->getPrefix().$key); |
|
57 | 57 | } |
58 | 58 | |
59 | 59 | public function clear($prefix = '') { |
60 | - $ns = $this->getPrefix() . $prefix; |
|
60 | + $ns = $this->getPrefix().$prefix; |
|
61 | 61 | $ns = preg_quote($ns, '/'); |
62 | - if(class_exists('\APCIterator')) { |
|
63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
62 | + if (class_exists('\APCIterator')) { |
|
63 | + $iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY); |
|
64 | 64 | } else { |
65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
65 | + $iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY); |
|
66 | 66 | } |
67 | 67 | return apcu_delete($iter); |
68 | 68 | } |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | * @return bool |
77 | 77 | */ |
78 | 78 | public function add($key, $value, $ttl = 0) { |
79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
79 | + return apcu_add($this->getPrefix().$key, $value, $ttl); |
|
80 | 80 | } |
81 | 81 | |
82 | 82 | /** |
@@ -100,8 +100,8 @@ discard block |
||
100 | 100 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
101 | 101 | * for details |
102 | 102 | */ |
103 | - return apcu_exists($this->getPrefix() . $key) |
|
104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
103 | + return apcu_exists($this->getPrefix().$key) |
|
104 | + ? apcu_inc($this->getPrefix().$key, $step) |
|
105 | 105 | : false; |
106 | 106 | } |
107 | 107 | |
@@ -125,8 +125,8 @@ discard block |
||
125 | 125 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
126 | 126 | * for details |
127 | 127 | */ |
128 | - return apcu_exists($this->getPrefix() . $key) |
|
129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
128 | + return apcu_exists($this->getPrefix().$key) |
|
129 | + ? apcu_dec($this->getPrefix().$key, $step) |
|
130 | 130 | : false; |
131 | 131 | } |
132 | 132 | |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | public function cas($key, $old, $new) { |
142 | 142 | // apc only does cas for ints |
143 | 143 | if (is_int($old) and is_int($new)) { |
144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
144 | + return apcu_cas($this->getPrefix().$key, $old, $new); |
|
145 | 145 | } else { |
146 | 146 | return $this->casEmulated($key, $old, $new); |
147 | 147 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | * Set a value in the cache if it's not already stored |
66 | 66 | * |
67 | 67 | * @param string $key |
68 | - * @param mixed $value |
|
68 | + * @param integer $value |
|
69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
70 | 70 | * @return bool |
71 | 71 | */ |
@@ -27,133 +27,133 @@ |
||
27 | 27 | use OCP\IMemcache; |
28 | 28 | |
29 | 29 | class ArrayCache extends Cache implements IMemcache { |
30 | - /** @var array Array with the cached data */ |
|
31 | - protected $cachedData = array(); |
|
30 | + /** @var array Array with the cached data */ |
|
31 | + protected $cachedData = array(); |
|
32 | 32 | |
33 | - use CADTrait; |
|
33 | + use CADTrait; |
|
34 | 34 | |
35 | - /** |
|
36 | - * {@inheritDoc} |
|
37 | - */ |
|
38 | - public function get($key) { |
|
39 | - if ($this->hasKey($key)) { |
|
40 | - return $this->cachedData[$key]; |
|
41 | - } |
|
42 | - return null; |
|
43 | - } |
|
35 | + /** |
|
36 | + * {@inheritDoc} |
|
37 | + */ |
|
38 | + public function get($key) { |
|
39 | + if ($this->hasKey($key)) { |
|
40 | + return $this->cachedData[$key]; |
|
41 | + } |
|
42 | + return null; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * {@inheritDoc} |
|
47 | - */ |
|
48 | - public function set($key, $value, $ttl = 0) { |
|
49 | - $this->cachedData[$key] = $value; |
|
50 | - return true; |
|
51 | - } |
|
45 | + /** |
|
46 | + * {@inheritDoc} |
|
47 | + */ |
|
48 | + public function set($key, $value, $ttl = 0) { |
|
49 | + $this->cachedData[$key] = $value; |
|
50 | + return true; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * {@inheritDoc} |
|
55 | - */ |
|
56 | - public function hasKey($key) { |
|
57 | - return isset($this->cachedData[$key]); |
|
58 | - } |
|
53 | + /** |
|
54 | + * {@inheritDoc} |
|
55 | + */ |
|
56 | + public function hasKey($key) { |
|
57 | + return isset($this->cachedData[$key]); |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * {@inheritDoc} |
|
62 | - */ |
|
63 | - public function remove($key) { |
|
64 | - unset($this->cachedData[$key]); |
|
65 | - return true; |
|
66 | - } |
|
60 | + /** |
|
61 | + * {@inheritDoc} |
|
62 | + */ |
|
63 | + public function remove($key) { |
|
64 | + unset($this->cachedData[$key]); |
|
65 | + return true; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * {@inheritDoc} |
|
70 | - */ |
|
71 | - public function clear($prefix = '') { |
|
72 | - if ($prefix === '') { |
|
73 | - $this->cachedData = []; |
|
74 | - return true; |
|
75 | - } |
|
68 | + /** |
|
69 | + * {@inheritDoc} |
|
70 | + */ |
|
71 | + public function clear($prefix = '') { |
|
72 | + if ($prefix === '') { |
|
73 | + $this->cachedData = []; |
|
74 | + return true; |
|
75 | + } |
|
76 | 76 | |
77 | - foreach ($this->cachedData as $key => $value) { |
|
78 | - if (strpos($key, $prefix) === 0) { |
|
79 | - $this->remove($key); |
|
80 | - } |
|
81 | - } |
|
82 | - return true; |
|
83 | - } |
|
77 | + foreach ($this->cachedData as $key => $value) { |
|
78 | + if (strpos($key, $prefix) === 0) { |
|
79 | + $this->remove($key); |
|
80 | + } |
|
81 | + } |
|
82 | + return true; |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Set a value in the cache if it's not already stored |
|
87 | - * |
|
88 | - * @param string $key |
|
89 | - * @param mixed $value |
|
90 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | - * @return bool |
|
92 | - */ |
|
93 | - public function add($key, $value, $ttl = 0) { |
|
94 | - // since this cache is not shared race conditions aren't an issue |
|
95 | - if ($this->hasKey($key)) { |
|
96 | - return false; |
|
97 | - } else { |
|
98 | - return $this->set($key, $value, $ttl); |
|
99 | - } |
|
100 | - } |
|
85 | + /** |
|
86 | + * Set a value in the cache if it's not already stored |
|
87 | + * |
|
88 | + * @param string $key |
|
89 | + * @param mixed $value |
|
90 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
91 | + * @return bool |
|
92 | + */ |
|
93 | + public function add($key, $value, $ttl = 0) { |
|
94 | + // since this cache is not shared race conditions aren't an issue |
|
95 | + if ($this->hasKey($key)) { |
|
96 | + return false; |
|
97 | + } else { |
|
98 | + return $this->set($key, $value, $ttl); |
|
99 | + } |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Increase a stored number |
|
104 | - * |
|
105 | - * @param string $key |
|
106 | - * @param int $step |
|
107 | - * @return int | bool |
|
108 | - */ |
|
109 | - public function inc($key, $step = 1) { |
|
110 | - $oldValue = $this->get($key); |
|
111 | - if (is_int($oldValue)) { |
|
112 | - $this->set($key, $oldValue + $step); |
|
113 | - return $oldValue + $step; |
|
114 | - } else { |
|
115 | - $success = $this->add($key, $step); |
|
116 | - return ($success) ? $step : false; |
|
117 | - } |
|
118 | - } |
|
102 | + /** |
|
103 | + * Increase a stored number |
|
104 | + * |
|
105 | + * @param string $key |
|
106 | + * @param int $step |
|
107 | + * @return int | bool |
|
108 | + */ |
|
109 | + public function inc($key, $step = 1) { |
|
110 | + $oldValue = $this->get($key); |
|
111 | + if (is_int($oldValue)) { |
|
112 | + $this->set($key, $oldValue + $step); |
|
113 | + return $oldValue + $step; |
|
114 | + } else { |
|
115 | + $success = $this->add($key, $step); |
|
116 | + return ($success) ? $step : false; |
|
117 | + } |
|
118 | + } |
|
119 | 119 | |
120 | - /** |
|
121 | - * Decrease a stored number |
|
122 | - * |
|
123 | - * @param string $key |
|
124 | - * @param int $step |
|
125 | - * @return int | bool |
|
126 | - */ |
|
127 | - public function dec($key, $step = 1) { |
|
128 | - $oldValue = $this->get($key); |
|
129 | - if (is_int($oldValue)) { |
|
130 | - $this->set($key, $oldValue - $step); |
|
131 | - return $oldValue - $step; |
|
132 | - } else { |
|
133 | - return false; |
|
134 | - } |
|
135 | - } |
|
120 | + /** |
|
121 | + * Decrease a stored number |
|
122 | + * |
|
123 | + * @param string $key |
|
124 | + * @param int $step |
|
125 | + * @return int | bool |
|
126 | + */ |
|
127 | + public function dec($key, $step = 1) { |
|
128 | + $oldValue = $this->get($key); |
|
129 | + if (is_int($oldValue)) { |
|
130 | + $this->set($key, $oldValue - $step); |
|
131 | + return $oldValue - $step; |
|
132 | + } else { |
|
133 | + return false; |
|
134 | + } |
|
135 | + } |
|
136 | 136 | |
137 | - /** |
|
138 | - * Compare and set |
|
139 | - * |
|
140 | - * @param string $key |
|
141 | - * @param mixed $old |
|
142 | - * @param mixed $new |
|
143 | - * @return bool |
|
144 | - */ |
|
145 | - public function cas($key, $old, $new) { |
|
146 | - if ($this->get($key) === $old) { |
|
147 | - return $this->set($key, $new); |
|
148 | - } else { |
|
149 | - return false; |
|
150 | - } |
|
151 | - } |
|
137 | + /** |
|
138 | + * Compare and set |
|
139 | + * |
|
140 | + * @param string $key |
|
141 | + * @param mixed $old |
|
142 | + * @param mixed $new |
|
143 | + * @return bool |
|
144 | + */ |
|
145 | + public function cas($key, $old, $new) { |
|
146 | + if ($this->get($key) === $old) { |
|
147 | + return $this->set($key, $new); |
|
148 | + } else { |
|
149 | + return false; |
|
150 | + } |
|
151 | + } |
|
152 | 152 | |
153 | - /** |
|
154 | - * {@inheritDoc} |
|
155 | - */ |
|
156 | - static public function isAvailable() { |
|
157 | - return true; |
|
158 | - } |
|
153 | + /** |
|
154 | + * {@inheritDoc} |
|
155 | + */ |
|
156 | + static public function isAvailable() { |
|
157 | + return true; |
|
158 | + } |
|
159 | 159 | } |
@@ -498,6 +498,9 @@ |
||
498 | 498 | }); |
499 | 499 | } |
500 | 500 | |
501 | + /** |
|
502 | + * @param string $path |
|
503 | + */ |
|
501 | 504 | public function notify($path) { |
502 | 505 | $path = '/' . ltrim($path, '/'); |
503 | 506 | $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | |
85 | 85 | $this->root = isset($params['root']) ? $params['root'] : '/'; |
86 | 86 | if (!$this->root || $this->root[0] != '/') { |
87 | - $this->root = '/' . $this->root; |
|
87 | + $this->root = '/'.$this->root; |
|
88 | 88 | } |
89 | 89 | if (substr($this->root, -1, 1) != '/') { |
90 | 90 | $this->root .= '/'; |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | // FIXME: double slash to keep compatible with the old storage ids, |
103 | 103 | // failure to do so will lead to creation of a new storage id and |
104 | 104 | // loss of shares from the storage |
105 | - return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
105 | + return 'smb::'.$this->server->getUser().'@'.$this->server->getHost().'//'.$this->share->getName().'/'.$this->root; |
|
106 | 106 | } |
107 | 107 | |
108 | 108 | /** |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | * @return string |
111 | 111 | */ |
112 | 112 | protected function buildPath($path) { |
113 | - return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
113 | + return Filesystem::normalizePath($this->root.'/'.$path, true, false, true); |
|
114 | 114 | } |
115 | 115 | |
116 | 116 | protected function relativePath($fullPath) { |
@@ -150,9 +150,9 @@ discard block |
||
150 | 150 | $path = $this->buildPath($path); |
151 | 151 | $files = $this->share->dir($path); |
152 | 152 | foreach ($files as $file) { |
153 | - $this->statCache[$path . '/' . $file->getName()] = $file; |
|
153 | + $this->statCache[$path.'/'.$file->getName()] = $file; |
|
154 | 154 | } |
155 | - return array_filter($files, function (IFileInfo $file) { |
|
155 | + return array_filter($files, function(IFileInfo $file) { |
|
156 | 156 | return !$file->isHidden(); |
157 | 157 | }); |
158 | 158 | } catch (ConnectException $e) { |
@@ -297,7 +297,7 @@ discard block |
||
297 | 297 | case 'w': |
298 | 298 | case 'wb': |
299 | 299 | $source = $this->share->write($fullPath); |
300 | - return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
300 | + return CallBackWrapper::wrap($source, null, null, function() use ($fullPath) { |
|
301 | 301 | unset($this->statCache[$fullPath]); |
302 | 302 | }); |
303 | 303 | case 'a': |
@@ -329,7 +329,7 @@ discard block |
||
329 | 329 | } |
330 | 330 | $source = fopen($tmpFile, $mode); |
331 | 331 | $share = $this->share; |
332 | - return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
332 | + return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath, $share) { |
|
333 | 333 | unset($this->statCache[$fullPath]); |
334 | 334 | $share->put($tmpFile, $fullPath); |
335 | 335 | unlink($tmpFile); |
@@ -351,7 +351,7 @@ discard block |
||
351 | 351 | $content = $this->share->dir($this->buildPath($path)); |
352 | 352 | foreach ($content as $file) { |
353 | 353 | if ($file->isDirectory()) { |
354 | - $this->rmdir($path . '/' . $file->getName()); |
|
354 | + $this->rmdir($path.'/'.$file->getName()); |
|
355 | 355 | } else { |
356 | 356 | $this->share->del($file->getPath()); |
357 | 357 | } |
@@ -388,7 +388,7 @@ discard block |
||
388 | 388 | } catch (ForbiddenException $e) { |
389 | 389 | return false; |
390 | 390 | } |
391 | - $names = array_map(function ($info) { |
|
391 | + $names = array_map(function($info) { |
|
392 | 392 | /** @var \Icewind\SMB\IFileInfo $info */ |
393 | 393 | return $info->getName(); |
394 | 394 | }, $files); |
@@ -470,7 +470,7 @@ discard block |
||
470 | 470 | */ |
471 | 471 | public static function checkDependencies() { |
472 | 472 | return ( |
473 | - (bool)\OC_Helper::findBinaryPath('smbclient') |
|
473 | + (bool) \OC_Helper::findBinaryPath('smbclient') |
|
474 | 474 | || Server::NativeAvailable() |
475 | 475 | ) ? true : ['smbclient']; |
476 | 476 | } |
@@ -489,7 +489,7 @@ discard block |
||
489 | 489 | } |
490 | 490 | |
491 | 491 | public function listen($path, callable $callback) { |
492 | - $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
492 | + $this->notify($path)->listen(function(IChange $change) use ($callback) { |
|
493 | 493 | if ($change instanceof IRenameChange) { |
494 | 494 | return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
495 | 495 | } else { |
@@ -499,7 +499,7 @@ discard block |
||
499 | 499 | } |
500 | 500 | |
501 | 501 | public function notify($path) { |
502 | - $path = '/' . ltrim($path, '/'); |
|
502 | + $path = '/'.ltrim($path, '/'); |
|
503 | 503 | $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
504 | 504 | return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
505 | 505 | } |
@@ -51,475 +51,475 @@ |
||
51 | 51 | use OCP\Files\StorageNotAvailableException; |
52 | 52 | |
53 | 53 | class SMB extends Common implements INotifyStorage { |
54 | - /** |
|
55 | - * @var \Icewind\SMB\Server |
|
56 | - */ |
|
57 | - protected $server; |
|
58 | - |
|
59 | - /** |
|
60 | - * @var \Icewind\SMB\Share |
|
61 | - */ |
|
62 | - protected $share; |
|
63 | - |
|
64 | - /** |
|
65 | - * @var string |
|
66 | - */ |
|
67 | - protected $root; |
|
68 | - |
|
69 | - /** |
|
70 | - * @var \Icewind\SMB\FileInfo[] |
|
71 | - */ |
|
72 | - protected $statCache; |
|
73 | - |
|
74 | - public function __construct($params) { |
|
75 | - if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) { |
|
76 | - if (Server::NativeAvailable()) { |
|
77 | - $this->server = new NativeServer($params['host'], $params['user'], $params['password']); |
|
78 | - } else { |
|
79 | - $this->server = new Server($params['host'], $params['user'], $params['password']); |
|
80 | - } |
|
81 | - $this->share = $this->server->getShare(trim($params['share'], '/')); |
|
82 | - |
|
83 | - $this->root = isset($params['root']) ? $params['root'] : '/'; |
|
84 | - if (!$this->root || $this->root[0] != '/') { |
|
85 | - $this->root = '/' . $this->root; |
|
86 | - } |
|
87 | - if (substr($this->root, -1, 1) != '/') { |
|
88 | - $this->root .= '/'; |
|
89 | - } |
|
90 | - } else { |
|
91 | - throw new \Exception('Invalid configuration'); |
|
92 | - } |
|
93 | - $this->statCache = new CappedMemoryCache(); |
|
94 | - parent::__construct($params); |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * @return string |
|
99 | - */ |
|
100 | - public function getId() { |
|
101 | - // FIXME: double slash to keep compatible with the old storage ids, |
|
102 | - // failure to do so will lead to creation of a new storage id and |
|
103 | - // loss of shares from the storage |
|
104 | - return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * @param string $path |
|
109 | - * @return string |
|
110 | - */ |
|
111 | - protected function buildPath($path) { |
|
112 | - return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
113 | - } |
|
114 | - |
|
115 | - protected function relativePath($fullPath) { |
|
116 | - if ($fullPath === $this->root) { |
|
117 | - return ''; |
|
118 | - } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
119 | - return substr($fullPath, strlen($this->root)); |
|
120 | - } else { |
|
121 | - return null; |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * @param string $path |
|
127 | - * @return \Icewind\SMB\IFileInfo |
|
128 | - * @throws StorageNotAvailableException |
|
129 | - */ |
|
130 | - protected function getFileInfo($path) { |
|
131 | - try { |
|
132 | - $path = $this->buildPath($path); |
|
133 | - if (!isset($this->statCache[$path])) { |
|
134 | - $this->statCache[$path] = $this->share->stat($path); |
|
135 | - } |
|
136 | - return $this->statCache[$path]; |
|
137 | - } catch (ConnectException $e) { |
|
138 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
139 | - } |
|
140 | - } |
|
141 | - |
|
142 | - /** |
|
143 | - * @param string $path |
|
144 | - * @return \Icewind\SMB\IFileInfo[] |
|
145 | - * @throws StorageNotAvailableException |
|
146 | - */ |
|
147 | - protected function getFolderContents($path) { |
|
148 | - try { |
|
149 | - $path = $this->buildPath($path); |
|
150 | - $files = $this->share->dir($path); |
|
151 | - foreach ($files as $file) { |
|
152 | - $this->statCache[$path . '/' . $file->getName()] = $file; |
|
153 | - } |
|
154 | - return array_filter($files, function (IFileInfo $file) { |
|
155 | - return !$file->isHidden(); |
|
156 | - }); |
|
157 | - } catch (ConnectException $e) { |
|
158 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
159 | - } |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * @param \Icewind\SMB\IFileInfo $info |
|
164 | - * @return array |
|
165 | - */ |
|
166 | - protected function formatInfo($info) { |
|
167 | - $result = [ |
|
168 | - 'size' => $info->getSize(), |
|
169 | - 'mtime' => $info->getMTime(), |
|
170 | - ]; |
|
171 | - if ($info->isDirectory()) { |
|
172 | - $result['type'] = 'dir'; |
|
173 | - } else { |
|
174 | - $result['type'] = 'file'; |
|
175 | - } |
|
176 | - return $result; |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * Rename the files. If the source or the target is the root, the rename won't happen. |
|
181 | - * |
|
182 | - * @param string $source the old name of the path |
|
183 | - * @param string $target the new name of the path |
|
184 | - * @return bool true if the rename is successful, false otherwise |
|
185 | - */ |
|
186 | - public function rename($source, $target) { |
|
187 | - if ($this->isRootDir($source) || $this->isRootDir($target)) { |
|
188 | - return false; |
|
189 | - } |
|
190 | - |
|
191 | - $absoluteSource = $this->buildPath($source); |
|
192 | - $absoluteTarget = $this->buildPath($target); |
|
193 | - try { |
|
194 | - $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
195 | - } catch (AlreadyExistsException $e) { |
|
196 | - $this->remove($target); |
|
197 | - $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
198 | - } catch (\Exception $e) { |
|
199 | - return false; |
|
200 | - } |
|
201 | - unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]); |
|
202 | - return $result; |
|
203 | - } |
|
204 | - |
|
205 | - /** |
|
206 | - * @param string $path |
|
207 | - * @return array |
|
208 | - */ |
|
209 | - public function stat($path) { |
|
210 | - $result = $this->formatInfo($this->getFileInfo($path)); |
|
211 | - if ($this->remoteIsShare() && $this->isRootDir($path)) { |
|
212 | - $result['mtime'] = $this->shareMTime(); |
|
213 | - } |
|
214 | - return $result; |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * get the best guess for the modification time of the share |
|
219 | - * |
|
220 | - * @return int |
|
221 | - */ |
|
222 | - private function shareMTime() { |
|
223 | - $highestMTime = 0; |
|
224 | - $files = $this->share->dir($this->root); |
|
225 | - foreach ($files as $fileInfo) { |
|
226 | - if ($fileInfo->getMTime() > $highestMTime) { |
|
227 | - $highestMTime = $fileInfo->getMTime(); |
|
228 | - } |
|
229 | - } |
|
230 | - return $highestMTime; |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Check if the path is our root dir (not the smb one) |
|
235 | - * |
|
236 | - * @param string $path the path |
|
237 | - * @return bool |
|
238 | - */ |
|
239 | - private function isRootDir($path) { |
|
240 | - return $path === '' || $path === '/' || $path === '.'; |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Check if our root points to a smb share |
|
245 | - * |
|
246 | - * @return bool true if our root points to a share false otherwise |
|
247 | - */ |
|
248 | - private function remoteIsShare() { |
|
249 | - return $this->share->getName() && (!$this->root || $this->root === '/'); |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * @param string $path |
|
254 | - * @return bool |
|
255 | - */ |
|
256 | - public function unlink($path) { |
|
257 | - if ($this->isRootDir($path)) { |
|
258 | - return false; |
|
259 | - } |
|
260 | - |
|
261 | - try { |
|
262 | - if ($this->is_dir($path)) { |
|
263 | - return $this->rmdir($path); |
|
264 | - } else { |
|
265 | - $path = $this->buildPath($path); |
|
266 | - unset($this->statCache[$path]); |
|
267 | - $this->share->del($path); |
|
268 | - return true; |
|
269 | - } |
|
270 | - } catch (NotFoundException $e) { |
|
271 | - return false; |
|
272 | - } catch (ForbiddenException $e) { |
|
273 | - return false; |
|
274 | - } catch (ConnectException $e) { |
|
275 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
276 | - } |
|
277 | - } |
|
278 | - |
|
279 | - /** |
|
280 | - * check if a file or folder has been updated since $time |
|
281 | - * |
|
282 | - * @param string $path |
|
283 | - * @param int $time |
|
284 | - * @return bool |
|
285 | - */ |
|
286 | - public function hasUpdated($path, $time) { |
|
287 | - if (!$path and $this->root === '/') { |
|
288 | - // mtime doesn't work for shares, but giving the nature of the backend, |
|
289 | - // doing a full update is still just fast enough |
|
290 | - return true; |
|
291 | - } else { |
|
292 | - $actualTime = $this->filemtime($path); |
|
293 | - return $actualTime > $time; |
|
294 | - } |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * @param string $path |
|
299 | - * @param string $mode |
|
300 | - * @return resource|false |
|
301 | - */ |
|
302 | - public function fopen($path, $mode) { |
|
303 | - $fullPath = $this->buildPath($path); |
|
304 | - try { |
|
305 | - switch ($mode) { |
|
306 | - case 'r': |
|
307 | - case 'rb': |
|
308 | - if (!$this->file_exists($path)) { |
|
309 | - return false; |
|
310 | - } |
|
311 | - return $this->share->read($fullPath); |
|
312 | - case 'w': |
|
313 | - case 'wb': |
|
314 | - $source = $this->share->write($fullPath); |
|
315 | - return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
316 | - unset($this->statCache[$fullPath]); |
|
317 | - }); |
|
318 | - case 'a': |
|
319 | - case 'ab': |
|
320 | - case 'r+': |
|
321 | - case 'w+': |
|
322 | - case 'wb+': |
|
323 | - case 'a+': |
|
324 | - case 'x': |
|
325 | - case 'x+': |
|
326 | - case 'c': |
|
327 | - case 'c+': |
|
328 | - //emulate these |
|
329 | - if (strrpos($path, '.') !== false) { |
|
330 | - $ext = substr($path, strrpos($path, '.')); |
|
331 | - } else { |
|
332 | - $ext = ''; |
|
333 | - } |
|
334 | - if ($this->file_exists($path)) { |
|
335 | - if (!$this->isUpdatable($path)) { |
|
336 | - return false; |
|
337 | - } |
|
338 | - $tmpFile = $this->getCachedFile($path); |
|
339 | - } else { |
|
340 | - if (!$this->isCreatable(dirname($path))) { |
|
341 | - return false; |
|
342 | - } |
|
343 | - $tmpFile = \OCP\Files::tmpFile($ext); |
|
344 | - } |
|
345 | - $source = fopen($tmpFile, $mode); |
|
346 | - $share = $this->share; |
|
347 | - return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
348 | - unset($this->statCache[$fullPath]); |
|
349 | - $share->put($tmpFile, $fullPath); |
|
350 | - unlink($tmpFile); |
|
351 | - }); |
|
352 | - } |
|
353 | - return false; |
|
354 | - } catch (NotFoundException $e) { |
|
355 | - return false; |
|
356 | - } catch (ForbiddenException $e) { |
|
357 | - return false; |
|
358 | - } catch (ConnectException $e) { |
|
359 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
360 | - } |
|
361 | - } |
|
362 | - |
|
363 | - public function rmdir($path) { |
|
364 | - if ($this->isRootDir($path)) { |
|
365 | - return false; |
|
366 | - } |
|
367 | - |
|
368 | - try { |
|
369 | - $this->statCache = array(); |
|
370 | - $content = $this->share->dir($this->buildPath($path)); |
|
371 | - foreach ($content as $file) { |
|
372 | - if ($file->isDirectory()) { |
|
373 | - $this->rmdir($path . '/' . $file->getName()); |
|
374 | - } else { |
|
375 | - $this->share->del($file->getPath()); |
|
376 | - } |
|
377 | - } |
|
378 | - $this->share->rmdir($this->buildPath($path)); |
|
379 | - return true; |
|
380 | - } catch (NotFoundException $e) { |
|
381 | - return false; |
|
382 | - } catch (ForbiddenException $e) { |
|
383 | - return false; |
|
384 | - } catch (ConnectException $e) { |
|
385 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
386 | - } |
|
387 | - } |
|
388 | - |
|
389 | - public function touch($path, $time = null) { |
|
390 | - try { |
|
391 | - if (!$this->file_exists($path)) { |
|
392 | - $fh = $this->share->write($this->buildPath($path)); |
|
393 | - fclose($fh); |
|
394 | - return true; |
|
395 | - } |
|
396 | - return false; |
|
397 | - } catch (ConnectException $e) { |
|
398 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
399 | - } |
|
400 | - } |
|
401 | - |
|
402 | - public function opendir($path) { |
|
403 | - try { |
|
404 | - $files = $this->getFolderContents($path); |
|
405 | - } catch (NotFoundException $e) { |
|
406 | - return false; |
|
407 | - } catch (ForbiddenException $e) { |
|
408 | - return false; |
|
409 | - } |
|
410 | - $names = array_map(function ($info) { |
|
411 | - /** @var \Icewind\SMB\IFileInfo $info */ |
|
412 | - return $info->getName(); |
|
413 | - }, $files); |
|
414 | - return IteratorDirectory::wrap($names); |
|
415 | - } |
|
416 | - |
|
417 | - public function filetype($path) { |
|
418 | - try { |
|
419 | - return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file'; |
|
420 | - } catch (NotFoundException $e) { |
|
421 | - return false; |
|
422 | - } catch (ForbiddenException $e) { |
|
423 | - return false; |
|
424 | - } |
|
425 | - } |
|
426 | - |
|
427 | - public function mkdir($path) { |
|
428 | - $path = $this->buildPath($path); |
|
429 | - try { |
|
430 | - $this->share->mkdir($path); |
|
431 | - return true; |
|
432 | - } catch (ConnectException $e) { |
|
433 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
434 | - } catch (Exception $e) { |
|
435 | - return false; |
|
436 | - } |
|
437 | - } |
|
438 | - |
|
439 | - public function file_exists($path) { |
|
440 | - try { |
|
441 | - $this->getFileInfo($path); |
|
442 | - return true; |
|
443 | - } catch (NotFoundException $e) { |
|
444 | - return false; |
|
445 | - } catch (ForbiddenException $e) { |
|
446 | - return false; |
|
447 | - } catch (ConnectException $e) { |
|
448 | - throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
449 | - } |
|
450 | - } |
|
451 | - |
|
452 | - public function isReadable($path) { |
|
453 | - try { |
|
454 | - $info = $this->getFileInfo($path); |
|
455 | - return !$info->isHidden(); |
|
456 | - } catch (NotFoundException $e) { |
|
457 | - return false; |
|
458 | - } catch (ForbiddenException $e) { |
|
459 | - return false; |
|
460 | - } |
|
461 | - } |
|
462 | - |
|
463 | - public function isUpdatable($path) { |
|
464 | - try { |
|
465 | - $info = $this->getFileInfo($path); |
|
466 | - // following windows behaviour for read-only folders: they can be written into |
|
467 | - // (https://support.microsoft.com/en-us/kb/326549 - "cause" section) |
|
468 | - return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path)); |
|
469 | - } catch (NotFoundException $e) { |
|
470 | - return false; |
|
471 | - } catch (ForbiddenException $e) { |
|
472 | - return false; |
|
473 | - } |
|
474 | - } |
|
475 | - |
|
476 | - public function isDeletable($path) { |
|
477 | - try { |
|
478 | - $info = $this->getFileInfo($path); |
|
479 | - return !$info->isHidden() && !$info->isReadOnly(); |
|
480 | - } catch (NotFoundException $e) { |
|
481 | - return false; |
|
482 | - } catch (ForbiddenException $e) { |
|
483 | - return false; |
|
484 | - } |
|
485 | - } |
|
486 | - |
|
487 | - /** |
|
488 | - * check if smbclient is installed |
|
489 | - */ |
|
490 | - public static function checkDependencies() { |
|
491 | - return ( |
|
492 | - (bool)\OC_Helper::findBinaryPath('smbclient') |
|
493 | - || Server::NativeAvailable() |
|
494 | - ) ? true : ['smbclient']; |
|
495 | - } |
|
496 | - |
|
497 | - /** |
|
498 | - * Test a storage for availability |
|
499 | - * |
|
500 | - * @return bool |
|
501 | - */ |
|
502 | - public function test() { |
|
503 | - try { |
|
504 | - return parent::test(); |
|
505 | - } catch (Exception $e) { |
|
506 | - return false; |
|
507 | - } |
|
508 | - } |
|
509 | - |
|
510 | - public function listen($path, callable $callback) { |
|
511 | - $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
512 | - if ($change instanceof IRenameChange) { |
|
513 | - return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
|
514 | - } else { |
|
515 | - return $callback($change->getType(), $change->getPath()); |
|
516 | - } |
|
517 | - }); |
|
518 | - } |
|
519 | - |
|
520 | - public function notify($path) { |
|
521 | - $path = '/' . ltrim($path, '/'); |
|
522 | - $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
|
523 | - return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
|
524 | - } |
|
54 | + /** |
|
55 | + * @var \Icewind\SMB\Server |
|
56 | + */ |
|
57 | + protected $server; |
|
58 | + |
|
59 | + /** |
|
60 | + * @var \Icewind\SMB\Share |
|
61 | + */ |
|
62 | + protected $share; |
|
63 | + |
|
64 | + /** |
|
65 | + * @var string |
|
66 | + */ |
|
67 | + protected $root; |
|
68 | + |
|
69 | + /** |
|
70 | + * @var \Icewind\SMB\FileInfo[] |
|
71 | + */ |
|
72 | + protected $statCache; |
|
73 | + |
|
74 | + public function __construct($params) { |
|
75 | + if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) { |
|
76 | + if (Server::NativeAvailable()) { |
|
77 | + $this->server = new NativeServer($params['host'], $params['user'], $params['password']); |
|
78 | + } else { |
|
79 | + $this->server = new Server($params['host'], $params['user'], $params['password']); |
|
80 | + } |
|
81 | + $this->share = $this->server->getShare(trim($params['share'], '/')); |
|
82 | + |
|
83 | + $this->root = isset($params['root']) ? $params['root'] : '/'; |
|
84 | + if (!$this->root || $this->root[0] != '/') { |
|
85 | + $this->root = '/' . $this->root; |
|
86 | + } |
|
87 | + if (substr($this->root, -1, 1) != '/') { |
|
88 | + $this->root .= '/'; |
|
89 | + } |
|
90 | + } else { |
|
91 | + throw new \Exception('Invalid configuration'); |
|
92 | + } |
|
93 | + $this->statCache = new CappedMemoryCache(); |
|
94 | + parent::__construct($params); |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * @return string |
|
99 | + */ |
|
100 | + public function getId() { |
|
101 | + // FIXME: double slash to keep compatible with the old storage ids, |
|
102 | + // failure to do so will lead to creation of a new storage id and |
|
103 | + // loss of shares from the storage |
|
104 | + return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * @param string $path |
|
109 | + * @return string |
|
110 | + */ |
|
111 | + protected function buildPath($path) { |
|
112 | + return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
|
113 | + } |
|
114 | + |
|
115 | + protected function relativePath($fullPath) { |
|
116 | + if ($fullPath === $this->root) { |
|
117 | + return ''; |
|
118 | + } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
|
119 | + return substr($fullPath, strlen($this->root)); |
|
120 | + } else { |
|
121 | + return null; |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * @param string $path |
|
127 | + * @return \Icewind\SMB\IFileInfo |
|
128 | + * @throws StorageNotAvailableException |
|
129 | + */ |
|
130 | + protected function getFileInfo($path) { |
|
131 | + try { |
|
132 | + $path = $this->buildPath($path); |
|
133 | + if (!isset($this->statCache[$path])) { |
|
134 | + $this->statCache[$path] = $this->share->stat($path); |
|
135 | + } |
|
136 | + return $this->statCache[$path]; |
|
137 | + } catch (ConnectException $e) { |
|
138 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
139 | + } |
|
140 | + } |
|
141 | + |
|
142 | + /** |
|
143 | + * @param string $path |
|
144 | + * @return \Icewind\SMB\IFileInfo[] |
|
145 | + * @throws StorageNotAvailableException |
|
146 | + */ |
|
147 | + protected function getFolderContents($path) { |
|
148 | + try { |
|
149 | + $path = $this->buildPath($path); |
|
150 | + $files = $this->share->dir($path); |
|
151 | + foreach ($files as $file) { |
|
152 | + $this->statCache[$path . '/' . $file->getName()] = $file; |
|
153 | + } |
|
154 | + return array_filter($files, function (IFileInfo $file) { |
|
155 | + return !$file->isHidden(); |
|
156 | + }); |
|
157 | + } catch (ConnectException $e) { |
|
158 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
159 | + } |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * @param \Icewind\SMB\IFileInfo $info |
|
164 | + * @return array |
|
165 | + */ |
|
166 | + protected function formatInfo($info) { |
|
167 | + $result = [ |
|
168 | + 'size' => $info->getSize(), |
|
169 | + 'mtime' => $info->getMTime(), |
|
170 | + ]; |
|
171 | + if ($info->isDirectory()) { |
|
172 | + $result['type'] = 'dir'; |
|
173 | + } else { |
|
174 | + $result['type'] = 'file'; |
|
175 | + } |
|
176 | + return $result; |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * Rename the files. If the source or the target is the root, the rename won't happen. |
|
181 | + * |
|
182 | + * @param string $source the old name of the path |
|
183 | + * @param string $target the new name of the path |
|
184 | + * @return bool true if the rename is successful, false otherwise |
|
185 | + */ |
|
186 | + public function rename($source, $target) { |
|
187 | + if ($this->isRootDir($source) || $this->isRootDir($target)) { |
|
188 | + return false; |
|
189 | + } |
|
190 | + |
|
191 | + $absoluteSource = $this->buildPath($source); |
|
192 | + $absoluteTarget = $this->buildPath($target); |
|
193 | + try { |
|
194 | + $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
195 | + } catch (AlreadyExistsException $e) { |
|
196 | + $this->remove($target); |
|
197 | + $result = $this->share->rename($absoluteSource, $absoluteTarget); |
|
198 | + } catch (\Exception $e) { |
|
199 | + return false; |
|
200 | + } |
|
201 | + unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]); |
|
202 | + return $result; |
|
203 | + } |
|
204 | + |
|
205 | + /** |
|
206 | + * @param string $path |
|
207 | + * @return array |
|
208 | + */ |
|
209 | + public function stat($path) { |
|
210 | + $result = $this->formatInfo($this->getFileInfo($path)); |
|
211 | + if ($this->remoteIsShare() && $this->isRootDir($path)) { |
|
212 | + $result['mtime'] = $this->shareMTime(); |
|
213 | + } |
|
214 | + return $result; |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * get the best guess for the modification time of the share |
|
219 | + * |
|
220 | + * @return int |
|
221 | + */ |
|
222 | + private function shareMTime() { |
|
223 | + $highestMTime = 0; |
|
224 | + $files = $this->share->dir($this->root); |
|
225 | + foreach ($files as $fileInfo) { |
|
226 | + if ($fileInfo->getMTime() > $highestMTime) { |
|
227 | + $highestMTime = $fileInfo->getMTime(); |
|
228 | + } |
|
229 | + } |
|
230 | + return $highestMTime; |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Check if the path is our root dir (not the smb one) |
|
235 | + * |
|
236 | + * @param string $path the path |
|
237 | + * @return bool |
|
238 | + */ |
|
239 | + private function isRootDir($path) { |
|
240 | + return $path === '' || $path === '/' || $path === '.'; |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Check if our root points to a smb share |
|
245 | + * |
|
246 | + * @return bool true if our root points to a share false otherwise |
|
247 | + */ |
|
248 | + private function remoteIsShare() { |
|
249 | + return $this->share->getName() && (!$this->root || $this->root === '/'); |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * @param string $path |
|
254 | + * @return bool |
|
255 | + */ |
|
256 | + public function unlink($path) { |
|
257 | + if ($this->isRootDir($path)) { |
|
258 | + return false; |
|
259 | + } |
|
260 | + |
|
261 | + try { |
|
262 | + if ($this->is_dir($path)) { |
|
263 | + return $this->rmdir($path); |
|
264 | + } else { |
|
265 | + $path = $this->buildPath($path); |
|
266 | + unset($this->statCache[$path]); |
|
267 | + $this->share->del($path); |
|
268 | + return true; |
|
269 | + } |
|
270 | + } catch (NotFoundException $e) { |
|
271 | + return false; |
|
272 | + } catch (ForbiddenException $e) { |
|
273 | + return false; |
|
274 | + } catch (ConnectException $e) { |
|
275 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
276 | + } |
|
277 | + } |
|
278 | + |
|
279 | + /** |
|
280 | + * check if a file or folder has been updated since $time |
|
281 | + * |
|
282 | + * @param string $path |
|
283 | + * @param int $time |
|
284 | + * @return bool |
|
285 | + */ |
|
286 | + public function hasUpdated($path, $time) { |
|
287 | + if (!$path and $this->root === '/') { |
|
288 | + // mtime doesn't work for shares, but giving the nature of the backend, |
|
289 | + // doing a full update is still just fast enough |
|
290 | + return true; |
|
291 | + } else { |
|
292 | + $actualTime = $this->filemtime($path); |
|
293 | + return $actualTime > $time; |
|
294 | + } |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * @param string $path |
|
299 | + * @param string $mode |
|
300 | + * @return resource|false |
|
301 | + */ |
|
302 | + public function fopen($path, $mode) { |
|
303 | + $fullPath = $this->buildPath($path); |
|
304 | + try { |
|
305 | + switch ($mode) { |
|
306 | + case 'r': |
|
307 | + case 'rb': |
|
308 | + if (!$this->file_exists($path)) { |
|
309 | + return false; |
|
310 | + } |
|
311 | + return $this->share->read($fullPath); |
|
312 | + case 'w': |
|
313 | + case 'wb': |
|
314 | + $source = $this->share->write($fullPath); |
|
315 | + return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
|
316 | + unset($this->statCache[$fullPath]); |
|
317 | + }); |
|
318 | + case 'a': |
|
319 | + case 'ab': |
|
320 | + case 'r+': |
|
321 | + case 'w+': |
|
322 | + case 'wb+': |
|
323 | + case 'a+': |
|
324 | + case 'x': |
|
325 | + case 'x+': |
|
326 | + case 'c': |
|
327 | + case 'c+': |
|
328 | + //emulate these |
|
329 | + if (strrpos($path, '.') !== false) { |
|
330 | + $ext = substr($path, strrpos($path, '.')); |
|
331 | + } else { |
|
332 | + $ext = ''; |
|
333 | + } |
|
334 | + if ($this->file_exists($path)) { |
|
335 | + if (!$this->isUpdatable($path)) { |
|
336 | + return false; |
|
337 | + } |
|
338 | + $tmpFile = $this->getCachedFile($path); |
|
339 | + } else { |
|
340 | + if (!$this->isCreatable(dirname($path))) { |
|
341 | + return false; |
|
342 | + } |
|
343 | + $tmpFile = \OCP\Files::tmpFile($ext); |
|
344 | + } |
|
345 | + $source = fopen($tmpFile, $mode); |
|
346 | + $share = $this->share; |
|
347 | + return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
|
348 | + unset($this->statCache[$fullPath]); |
|
349 | + $share->put($tmpFile, $fullPath); |
|
350 | + unlink($tmpFile); |
|
351 | + }); |
|
352 | + } |
|
353 | + return false; |
|
354 | + } catch (NotFoundException $e) { |
|
355 | + return false; |
|
356 | + } catch (ForbiddenException $e) { |
|
357 | + return false; |
|
358 | + } catch (ConnectException $e) { |
|
359 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
360 | + } |
|
361 | + } |
|
362 | + |
|
363 | + public function rmdir($path) { |
|
364 | + if ($this->isRootDir($path)) { |
|
365 | + return false; |
|
366 | + } |
|
367 | + |
|
368 | + try { |
|
369 | + $this->statCache = array(); |
|
370 | + $content = $this->share->dir($this->buildPath($path)); |
|
371 | + foreach ($content as $file) { |
|
372 | + if ($file->isDirectory()) { |
|
373 | + $this->rmdir($path . '/' . $file->getName()); |
|
374 | + } else { |
|
375 | + $this->share->del($file->getPath()); |
|
376 | + } |
|
377 | + } |
|
378 | + $this->share->rmdir($this->buildPath($path)); |
|
379 | + return true; |
|
380 | + } catch (NotFoundException $e) { |
|
381 | + return false; |
|
382 | + } catch (ForbiddenException $e) { |
|
383 | + return false; |
|
384 | + } catch (ConnectException $e) { |
|
385 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
386 | + } |
|
387 | + } |
|
388 | + |
|
389 | + public function touch($path, $time = null) { |
|
390 | + try { |
|
391 | + if (!$this->file_exists($path)) { |
|
392 | + $fh = $this->share->write($this->buildPath($path)); |
|
393 | + fclose($fh); |
|
394 | + return true; |
|
395 | + } |
|
396 | + return false; |
|
397 | + } catch (ConnectException $e) { |
|
398 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
399 | + } |
|
400 | + } |
|
401 | + |
|
402 | + public function opendir($path) { |
|
403 | + try { |
|
404 | + $files = $this->getFolderContents($path); |
|
405 | + } catch (NotFoundException $e) { |
|
406 | + return false; |
|
407 | + } catch (ForbiddenException $e) { |
|
408 | + return false; |
|
409 | + } |
|
410 | + $names = array_map(function ($info) { |
|
411 | + /** @var \Icewind\SMB\IFileInfo $info */ |
|
412 | + return $info->getName(); |
|
413 | + }, $files); |
|
414 | + return IteratorDirectory::wrap($names); |
|
415 | + } |
|
416 | + |
|
417 | + public function filetype($path) { |
|
418 | + try { |
|
419 | + return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file'; |
|
420 | + } catch (NotFoundException $e) { |
|
421 | + return false; |
|
422 | + } catch (ForbiddenException $e) { |
|
423 | + return false; |
|
424 | + } |
|
425 | + } |
|
426 | + |
|
427 | + public function mkdir($path) { |
|
428 | + $path = $this->buildPath($path); |
|
429 | + try { |
|
430 | + $this->share->mkdir($path); |
|
431 | + return true; |
|
432 | + } catch (ConnectException $e) { |
|
433 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
434 | + } catch (Exception $e) { |
|
435 | + return false; |
|
436 | + } |
|
437 | + } |
|
438 | + |
|
439 | + public function file_exists($path) { |
|
440 | + try { |
|
441 | + $this->getFileInfo($path); |
|
442 | + return true; |
|
443 | + } catch (NotFoundException $e) { |
|
444 | + return false; |
|
445 | + } catch (ForbiddenException $e) { |
|
446 | + return false; |
|
447 | + } catch (ConnectException $e) { |
|
448 | + throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
|
449 | + } |
|
450 | + } |
|
451 | + |
|
452 | + public function isReadable($path) { |
|
453 | + try { |
|
454 | + $info = $this->getFileInfo($path); |
|
455 | + return !$info->isHidden(); |
|
456 | + } catch (NotFoundException $e) { |
|
457 | + return false; |
|
458 | + } catch (ForbiddenException $e) { |
|
459 | + return false; |
|
460 | + } |
|
461 | + } |
|
462 | + |
|
463 | + public function isUpdatable($path) { |
|
464 | + try { |
|
465 | + $info = $this->getFileInfo($path); |
|
466 | + // following windows behaviour for read-only folders: they can be written into |
|
467 | + // (https://support.microsoft.com/en-us/kb/326549 - "cause" section) |
|
468 | + return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path)); |
|
469 | + } catch (NotFoundException $e) { |
|
470 | + return false; |
|
471 | + } catch (ForbiddenException $e) { |
|
472 | + return false; |
|
473 | + } |
|
474 | + } |
|
475 | + |
|
476 | + public function isDeletable($path) { |
|
477 | + try { |
|
478 | + $info = $this->getFileInfo($path); |
|
479 | + return !$info->isHidden() && !$info->isReadOnly(); |
|
480 | + } catch (NotFoundException $e) { |
|
481 | + return false; |
|
482 | + } catch (ForbiddenException $e) { |
|
483 | + return false; |
|
484 | + } |
|
485 | + } |
|
486 | + |
|
487 | + /** |
|
488 | + * check if smbclient is installed |
|
489 | + */ |
|
490 | + public static function checkDependencies() { |
|
491 | + return ( |
|
492 | + (bool)\OC_Helper::findBinaryPath('smbclient') |
|
493 | + || Server::NativeAvailable() |
|
494 | + ) ? true : ['smbclient']; |
|
495 | + } |
|
496 | + |
|
497 | + /** |
|
498 | + * Test a storage for availability |
|
499 | + * |
|
500 | + * @return bool |
|
501 | + */ |
|
502 | + public function test() { |
|
503 | + try { |
|
504 | + return parent::test(); |
|
505 | + } catch (Exception $e) { |
|
506 | + return false; |
|
507 | + } |
|
508 | + } |
|
509 | + |
|
510 | + public function listen($path, callable $callback) { |
|
511 | + $this->notify($path)->listen(function (IChange $change) use ($callback) { |
|
512 | + if ($change instanceof IRenameChange) { |
|
513 | + return $callback($change->getType(), $change->getPath(), $change->getTargetPath()); |
|
514 | + } else { |
|
515 | + return $callback($change->getType(), $change->getPath()); |
|
516 | + } |
|
517 | + }); |
|
518 | + } |
|
519 | + |
|
520 | + public function notify($path) { |
|
521 | + $path = '/' . ltrim($path, '/'); |
|
522 | + $shareNotifyHandler = $this->share->notify($this->buildPath($path)); |
|
523 | + return new SMBNotifyHandler($shareNotifyHandler, $this->root); |
|
524 | + } |
|
525 | 525 | } |