@@ -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,145 +161,145 @@ 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 | - |
|
| 297 | - $userBackend = new User_Proxy( |
|
| 298 | - $configPrefixes, $ldapWrapper, $ocConfig |
|
| 299 | - ); |
|
| 300 | - $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
| 301 | - if($uid !== false) { |
|
| 302 | - $param['uid'] = $uid; |
|
| 303 | - } |
|
| 304 | - } |
|
| 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 | + |
|
| 297 | + $userBackend = new User_Proxy( |
|
| 298 | + $configPrefixes, $ldapWrapper, $ocConfig |
|
| 299 | + ); |
|
| 300 | + $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
| 301 | + if($uid !== false) { |
|
| 302 | + $param['uid'] = $uid; |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | 305 | } |
@@ -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 | |
@@ -294,11 +294,11 @@ discard block |
||
| 294 | 294 | $ldapWrapper = new LDAP(); |
| 295 | 295 | $ocConfig = \OC::$server->getConfig(); |
| 296 | 296 | |
| 297 | - $userBackend = new User_Proxy( |
|
| 297 | + $userBackend = new User_Proxy( |
|
| 298 | 298 | $configPrefixes, $ldapWrapper, $ocConfig |
| 299 | 299 | ); |
| 300 | - $uid = $userBackend->loginName2UserName($param['uid'] ); |
|
| 301 | - if($uid !== false) { |
|
| 300 | + $uid = $userBackend->loginName2UserName($param['uid']); |
|
| 301 | + if ($uid !== false) { |
|
| 302 | 302 | $param['uid'] = $uid; |
| 303 | 303 | } |
| 304 | 304 | } |
@@ -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,98 +41,98 @@ |
||
| 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 | - return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', [ |
|
| 128 | - 'redirect_url' => urlencode($this->request->server['REQUEST_URI']), |
|
| 129 | - ])); |
|
| 130 | - } |
|
| 131 | - if ($exception instanceof UserAlreadyLoggedInException) { |
|
| 132 | - return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index')); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - throw $exception; |
|
| 136 | - } |
|
| 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 | + return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', [ |
|
| 128 | + 'redirect_url' => urlencode($this->request->server['REQUEST_URI']), |
|
| 129 | + ])); |
|
| 130 | + } |
|
| 131 | + if ($exception instanceof UserAlreadyLoggedInException) { |
|
| 132 | + return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index')); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + throw $exception; |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | } |
@@ -102,7 +102,7 @@ |
||
| 102 | 102 | * @param bool $isLoggedIn |
| 103 | 103 | * @param bool $isAdminUser |
| 104 | 104 | * @param ContentSecurityPolicyManager $contentSecurityPolicyManager |
| 105 | - * @param CSRFTokenManager $csrfTokenManager |
|
| 105 | + * @param CsrfTokenManager $csrfTokenManager |
|
| 106 | 106 | * @param ContentSecurityPolicyNonceManager $cspNonceManager |
| 107 | 107 | * @param Throttler $throttler |
| 108 | 108 | */ |
@@ -64,219 +64,219 @@ |
||
| 64 | 64 | * check fails |
| 65 | 65 | */ |
| 66 | 66 | class SecurityMiddleware extends Middleware { |
| 67 | - /** @var INavigationManager */ |
|
| 68 | - private $navigationManager; |
|
| 69 | - /** @var IRequest */ |
|
| 70 | - private $request; |
|
| 71 | - /** @var ControllerMethodReflector */ |
|
| 72 | - private $reflector; |
|
| 73 | - /** @var string */ |
|
| 74 | - private $appName; |
|
| 75 | - /** @var IURLGenerator */ |
|
| 76 | - private $urlGenerator; |
|
| 77 | - /** @var ILogger */ |
|
| 78 | - private $logger; |
|
| 79 | - /** @var ISession */ |
|
| 80 | - private $session; |
|
| 81 | - /** @var bool */ |
|
| 82 | - private $isLoggedIn; |
|
| 83 | - /** @var bool */ |
|
| 84 | - private $isAdminUser; |
|
| 85 | - /** @var ContentSecurityPolicyManager */ |
|
| 86 | - private $contentSecurityPolicyManager; |
|
| 87 | - /** @var CsrfTokenManager */ |
|
| 88 | - private $csrfTokenManager; |
|
| 89 | - /** @var ContentSecurityPolicyNonceManager */ |
|
| 90 | - private $cspNonceManager; |
|
| 91 | - /** @var Throttler */ |
|
| 92 | - private $throttler; |
|
| 67 | + /** @var INavigationManager */ |
|
| 68 | + private $navigationManager; |
|
| 69 | + /** @var IRequest */ |
|
| 70 | + private $request; |
|
| 71 | + /** @var ControllerMethodReflector */ |
|
| 72 | + private $reflector; |
|
| 73 | + /** @var string */ |
|
| 74 | + private $appName; |
|
| 75 | + /** @var IURLGenerator */ |
|
| 76 | + private $urlGenerator; |
|
| 77 | + /** @var ILogger */ |
|
| 78 | + private $logger; |
|
| 79 | + /** @var ISession */ |
|
| 80 | + private $session; |
|
| 81 | + /** @var bool */ |
|
| 82 | + private $isLoggedIn; |
|
| 83 | + /** @var bool */ |
|
| 84 | + private $isAdminUser; |
|
| 85 | + /** @var ContentSecurityPolicyManager */ |
|
| 86 | + private $contentSecurityPolicyManager; |
|
| 87 | + /** @var CsrfTokenManager */ |
|
| 88 | + private $csrfTokenManager; |
|
| 89 | + /** @var ContentSecurityPolicyNonceManager */ |
|
| 90 | + private $cspNonceManager; |
|
| 91 | + /** @var Throttler */ |
|
| 92 | + private $throttler; |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * @param IRequest $request |
|
| 96 | - * @param ControllerMethodReflector $reflector |
|
| 97 | - * @param INavigationManager $navigationManager |
|
| 98 | - * @param IURLGenerator $urlGenerator |
|
| 99 | - * @param ILogger $logger |
|
| 100 | - * @param ISession $session |
|
| 101 | - * @param string $appName |
|
| 102 | - * @param bool $isLoggedIn |
|
| 103 | - * @param bool $isAdminUser |
|
| 104 | - * @param ContentSecurityPolicyManager $contentSecurityPolicyManager |
|
| 105 | - * @param CSRFTokenManager $csrfTokenManager |
|
| 106 | - * @param ContentSecurityPolicyNonceManager $cspNonceManager |
|
| 107 | - * @param Throttler $throttler |
|
| 108 | - */ |
|
| 109 | - public function __construct(IRequest $request, |
|
| 110 | - ControllerMethodReflector $reflector, |
|
| 111 | - INavigationManager $navigationManager, |
|
| 112 | - IURLGenerator $urlGenerator, |
|
| 113 | - ILogger $logger, |
|
| 114 | - ISession $session, |
|
| 115 | - $appName, |
|
| 116 | - $isLoggedIn, |
|
| 117 | - $isAdminUser, |
|
| 118 | - ContentSecurityPolicyManager $contentSecurityPolicyManager, |
|
| 119 | - CsrfTokenManager $csrfTokenManager, |
|
| 120 | - ContentSecurityPolicyNonceManager $cspNonceManager, |
|
| 121 | - Throttler $throttler) { |
|
| 122 | - $this->navigationManager = $navigationManager; |
|
| 123 | - $this->request = $request; |
|
| 124 | - $this->reflector = $reflector; |
|
| 125 | - $this->appName = $appName; |
|
| 126 | - $this->urlGenerator = $urlGenerator; |
|
| 127 | - $this->logger = $logger; |
|
| 128 | - $this->session = $session; |
|
| 129 | - $this->isLoggedIn = $isLoggedIn; |
|
| 130 | - $this->isAdminUser = $isAdminUser; |
|
| 131 | - $this->contentSecurityPolicyManager = $contentSecurityPolicyManager; |
|
| 132 | - $this->csrfTokenManager = $csrfTokenManager; |
|
| 133 | - $this->cspNonceManager = $cspNonceManager; |
|
| 134 | - $this->throttler = $throttler; |
|
| 135 | - } |
|
| 94 | + /** |
|
| 95 | + * @param IRequest $request |
|
| 96 | + * @param ControllerMethodReflector $reflector |
|
| 97 | + * @param INavigationManager $navigationManager |
|
| 98 | + * @param IURLGenerator $urlGenerator |
|
| 99 | + * @param ILogger $logger |
|
| 100 | + * @param ISession $session |
|
| 101 | + * @param string $appName |
|
| 102 | + * @param bool $isLoggedIn |
|
| 103 | + * @param bool $isAdminUser |
|
| 104 | + * @param ContentSecurityPolicyManager $contentSecurityPolicyManager |
|
| 105 | + * @param CSRFTokenManager $csrfTokenManager |
|
| 106 | + * @param ContentSecurityPolicyNonceManager $cspNonceManager |
|
| 107 | + * @param Throttler $throttler |
|
| 108 | + */ |
|
| 109 | + public function __construct(IRequest $request, |
|
| 110 | + ControllerMethodReflector $reflector, |
|
| 111 | + INavigationManager $navigationManager, |
|
| 112 | + IURLGenerator $urlGenerator, |
|
| 113 | + ILogger $logger, |
|
| 114 | + ISession $session, |
|
| 115 | + $appName, |
|
| 116 | + $isLoggedIn, |
|
| 117 | + $isAdminUser, |
|
| 118 | + ContentSecurityPolicyManager $contentSecurityPolicyManager, |
|
| 119 | + CsrfTokenManager $csrfTokenManager, |
|
| 120 | + ContentSecurityPolicyNonceManager $cspNonceManager, |
|
| 121 | + Throttler $throttler) { |
|
| 122 | + $this->navigationManager = $navigationManager; |
|
| 123 | + $this->request = $request; |
|
| 124 | + $this->reflector = $reflector; |
|
| 125 | + $this->appName = $appName; |
|
| 126 | + $this->urlGenerator = $urlGenerator; |
|
| 127 | + $this->logger = $logger; |
|
| 128 | + $this->session = $session; |
|
| 129 | + $this->isLoggedIn = $isLoggedIn; |
|
| 130 | + $this->isAdminUser = $isAdminUser; |
|
| 131 | + $this->contentSecurityPolicyManager = $contentSecurityPolicyManager; |
|
| 132 | + $this->csrfTokenManager = $csrfTokenManager; |
|
| 133 | + $this->cspNonceManager = $cspNonceManager; |
|
| 134 | + $this->throttler = $throttler; |
|
| 135 | + } |
|
| 136 | 136 | |
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * This runs all the security checks before a method call. The |
|
| 140 | - * security checks are determined by inspecting the controller method |
|
| 141 | - * annotations |
|
| 142 | - * @param Controller $controller the controller |
|
| 143 | - * @param string $methodName the name of the method |
|
| 144 | - * @throws SecurityException when a security check fails |
|
| 145 | - */ |
|
| 146 | - public function beforeController($controller, $methodName) { |
|
| 138 | + /** |
|
| 139 | + * This runs all the security checks before a method call. The |
|
| 140 | + * security checks are determined by inspecting the controller method |
|
| 141 | + * annotations |
|
| 142 | + * @param Controller $controller the controller |
|
| 143 | + * @param string $methodName the name of the method |
|
| 144 | + * @throws SecurityException when a security check fails |
|
| 145 | + */ |
|
| 146 | + public function beforeController($controller, $methodName) { |
|
| 147 | 147 | |
| 148 | - // this will set the current navigation entry of the app, use this only |
|
| 149 | - // for normal HTML requests and not for AJAX requests |
|
| 150 | - $this->navigationManager->setActiveEntry($this->appName); |
|
| 148 | + // this will set the current navigation entry of the app, use this only |
|
| 149 | + // for normal HTML requests and not for AJAX requests |
|
| 150 | + $this->navigationManager->setActiveEntry($this->appName); |
|
| 151 | 151 | |
| 152 | - // security checks |
|
| 153 | - $isPublicPage = $this->reflector->hasAnnotation('PublicPage'); |
|
| 154 | - if(!$isPublicPage) { |
|
| 155 | - if(!$this->isLoggedIn) { |
|
| 156 | - throw new NotLoggedInException(); |
|
| 157 | - } |
|
| 152 | + // security checks |
|
| 153 | + $isPublicPage = $this->reflector->hasAnnotation('PublicPage'); |
|
| 154 | + if(!$isPublicPage) { |
|
| 155 | + if(!$this->isLoggedIn) { |
|
| 156 | + throw new NotLoggedInException(); |
|
| 157 | + } |
|
| 158 | 158 | |
| 159 | - if(!$this->reflector->hasAnnotation('NoAdminRequired')) { |
|
| 160 | - if(!$this->isAdminUser) { |
|
| 161 | - throw new NotAdminException(); |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - } |
|
| 159 | + if(!$this->reflector->hasAnnotation('NoAdminRequired')) { |
|
| 160 | + if(!$this->isAdminUser) { |
|
| 161 | + throw new NotAdminException(); |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + } |
|
| 165 | 165 | |
| 166 | - if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) { |
|
| 167 | - $lastConfirm = (int) $this->session->get('last-password-confirm'); |
|
| 168 | - if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay |
|
| 169 | - throw new NotConfirmedException(); |
|
| 170 | - } |
|
| 171 | - } |
|
| 166 | + if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) { |
|
| 167 | + $lastConfirm = (int) $this->session->get('last-password-confirm'); |
|
| 168 | + if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay |
|
| 169 | + throw new NotConfirmedException(); |
|
| 170 | + } |
|
| 171 | + } |
|
| 172 | 172 | |
| 173 | - // Check for strict cookie requirement |
|
| 174 | - if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 175 | - if(!$this->request->passesStrictCookieCheck()) { |
|
| 176 | - throw new StrictCookieMissingException(); |
|
| 177 | - } |
|
| 178 | - } |
|
| 179 | - // CSRF check - also registers the CSRF token since the session may be closed later |
|
| 180 | - Util::callRegister(); |
|
| 181 | - if(!$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 182 | - /* |
|
| 173 | + // Check for strict cookie requirement |
|
| 174 | + if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 175 | + if(!$this->request->passesStrictCookieCheck()) { |
|
| 176 | + throw new StrictCookieMissingException(); |
|
| 177 | + } |
|
| 178 | + } |
|
| 179 | + // CSRF check - also registers the CSRF token since the session may be closed later |
|
| 180 | + Util::callRegister(); |
|
| 181 | + if(!$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 182 | + /* |
|
| 183 | 183 | * Only allow the CSRF check to fail on OCS Requests. This kind of |
| 184 | 184 | * hacks around that we have no full token auth in place yet and we |
| 185 | 185 | * do want to offer CSRF checks for web requests. |
| 186 | 186 | */ |
| 187 | - if(!$this->request->passesCSRFCheck() && !( |
|
| 188 | - $controller instanceof OCSController && |
|
| 189 | - $this->request->getHeader('OCS-APIREQUEST') === 'true')) { |
|
| 190 | - throw new CrossSiteRequestForgeryException(); |
|
| 191 | - } |
|
| 192 | - } |
|
| 187 | + if(!$this->request->passesCSRFCheck() && !( |
|
| 188 | + $controller instanceof OCSController && |
|
| 189 | + $this->request->getHeader('OCS-APIREQUEST') === 'true')) { |
|
| 190 | + throw new CrossSiteRequestForgeryException(); |
|
| 191 | + } |
|
| 192 | + } |
|
| 193 | 193 | |
| 194 | - if($this->reflector->hasAnnotation('BruteForceProtection')) { |
|
| 195 | - $action = $this->reflector->getAnnotationParameter('BruteForceProtection'); |
|
| 196 | - $this->throttler->sleepDelay($this->request->getRemoteAddress(), $action); |
|
| 197 | - $this->throttler->registerAttempt($action, $this->request->getRemoteAddress()); |
|
| 198 | - } |
|
| 194 | + if($this->reflector->hasAnnotation('BruteForceProtection')) { |
|
| 195 | + $action = $this->reflector->getAnnotationParameter('BruteForceProtection'); |
|
| 196 | + $this->throttler->sleepDelay($this->request->getRemoteAddress(), $action); |
|
| 197 | + $this->throttler->registerAttempt($action, $this->request->getRemoteAddress()); |
|
| 198 | + } |
|
| 199 | 199 | |
| 200 | - /** |
|
| 201 | - * FIXME: Use DI once available |
|
| 202 | - * Checks if app is enabled (also includes a check whether user is allowed to access the resource) |
|
| 203 | - * The getAppPath() check is here since components such as settings also use the AppFramework and |
|
| 204 | - * therefore won't pass this check. |
|
| 205 | - */ |
|
| 206 | - if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) { |
|
| 207 | - throw new AppNotEnabledException(); |
|
| 208 | - } |
|
| 200 | + /** |
|
| 201 | + * FIXME: Use DI once available |
|
| 202 | + * Checks if app is enabled (also includes a check whether user is allowed to access the resource) |
|
| 203 | + * The getAppPath() check is here since components such as settings also use the AppFramework and |
|
| 204 | + * therefore won't pass this check. |
|
| 205 | + */ |
|
| 206 | + if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) { |
|
| 207 | + throw new AppNotEnabledException(); |
|
| 208 | + } |
|
| 209 | 209 | |
| 210 | - } |
|
| 210 | + } |
|
| 211 | 211 | |
| 212 | - /** |
|
| 213 | - * Performs the default CSP modifications that may be injected by other |
|
| 214 | - * applications |
|
| 215 | - * |
|
| 216 | - * @param Controller $controller |
|
| 217 | - * @param string $methodName |
|
| 218 | - * @param Response $response |
|
| 219 | - * @return Response |
|
| 220 | - */ |
|
| 221 | - public function afterController($controller, $methodName, Response $response) { |
|
| 222 | - $policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy(); |
|
| 212 | + /** |
|
| 213 | + * Performs the default CSP modifications that may be injected by other |
|
| 214 | + * applications |
|
| 215 | + * |
|
| 216 | + * @param Controller $controller |
|
| 217 | + * @param string $methodName |
|
| 218 | + * @param Response $response |
|
| 219 | + * @return Response |
|
| 220 | + */ |
|
| 221 | + public function afterController($controller, $methodName, Response $response) { |
|
| 222 | + $policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy(); |
|
| 223 | 223 | |
| 224 | - if (get_class($policy) === EmptyContentSecurityPolicy::class) { |
|
| 225 | - return $response; |
|
| 226 | - } |
|
| 224 | + if (get_class($policy) === EmptyContentSecurityPolicy::class) { |
|
| 225 | + return $response; |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - $defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy(); |
|
| 229 | - $defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy); |
|
| 228 | + $defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy(); |
|
| 229 | + $defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy); |
|
| 230 | 230 | |
| 231 | - if($this->cspNonceManager->browserSupportsCspV3()) { |
|
| 232 | - $defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue()); |
|
| 233 | - } |
|
| 231 | + if($this->cspNonceManager->browserSupportsCspV3()) { |
|
| 232 | + $defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue()); |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | - $response->setContentSecurityPolicy($defaultPolicy); |
|
| 235 | + $response->setContentSecurityPolicy($defaultPolicy); |
|
| 236 | 236 | |
| 237 | - return $response; |
|
| 238 | - } |
|
| 237 | + return $response; |
|
| 238 | + } |
|
| 239 | 239 | |
| 240 | - /** |
|
| 241 | - * If an SecurityException is being caught, ajax requests return a JSON error |
|
| 242 | - * response and non ajax requests redirect to the index |
|
| 243 | - * @param Controller $controller the controller that is being called |
|
| 244 | - * @param string $methodName the name of the method that will be called on |
|
| 245 | - * the controller |
|
| 246 | - * @param \Exception $exception the thrown exception |
|
| 247 | - * @throws \Exception the passed in exception if it can't handle it |
|
| 248 | - * @return Response a Response object or null in case that the exception could not be handled |
|
| 249 | - */ |
|
| 250 | - public function afterException($controller, $methodName, \Exception $exception) { |
|
| 251 | - if($exception instanceof SecurityException) { |
|
| 252 | - if($exception instanceof StrictCookieMissingException) { |
|
| 253 | - return new RedirectResponse(\OC::$WEBROOT); |
|
| 254 | - } |
|
| 255 | - if (stripos($this->request->getHeader('Accept'),'html') === false) { |
|
| 256 | - $response = new JSONResponse( |
|
| 257 | - array('message' => $exception->getMessage()), |
|
| 258 | - $exception->getCode() |
|
| 259 | - ); |
|
| 260 | - } else { |
|
| 261 | - if($exception instanceof NotLoggedInException) { |
|
| 262 | - $url = $this->urlGenerator->linkToRoute( |
|
| 263 | - 'core.login.showLoginForm', |
|
| 264 | - [ |
|
| 265 | - 'redirect_url' => $this->request->server['REQUEST_URI'], |
|
| 266 | - ] |
|
| 267 | - ); |
|
| 268 | - $response = new RedirectResponse($url); |
|
| 269 | - } else { |
|
| 270 | - $response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest'); |
|
| 271 | - $response->setStatus($exception->getCode()); |
|
| 272 | - } |
|
| 273 | - } |
|
| 240 | + /** |
|
| 241 | + * If an SecurityException is being caught, ajax requests return a JSON error |
|
| 242 | + * response and non ajax requests redirect to the index |
|
| 243 | + * @param Controller $controller the controller that is being called |
|
| 244 | + * @param string $methodName the name of the method that will be called on |
|
| 245 | + * the controller |
|
| 246 | + * @param \Exception $exception the thrown exception |
|
| 247 | + * @throws \Exception the passed in exception if it can't handle it |
|
| 248 | + * @return Response a Response object or null in case that the exception could not be handled |
|
| 249 | + */ |
|
| 250 | + public function afterException($controller, $methodName, \Exception $exception) { |
|
| 251 | + if($exception instanceof SecurityException) { |
|
| 252 | + if($exception instanceof StrictCookieMissingException) { |
|
| 253 | + return new RedirectResponse(\OC::$WEBROOT); |
|
| 254 | + } |
|
| 255 | + if (stripos($this->request->getHeader('Accept'),'html') === false) { |
|
| 256 | + $response = new JSONResponse( |
|
| 257 | + array('message' => $exception->getMessage()), |
|
| 258 | + $exception->getCode() |
|
| 259 | + ); |
|
| 260 | + } else { |
|
| 261 | + if($exception instanceof NotLoggedInException) { |
|
| 262 | + $url = $this->urlGenerator->linkToRoute( |
|
| 263 | + 'core.login.showLoginForm', |
|
| 264 | + [ |
|
| 265 | + 'redirect_url' => $this->request->server['REQUEST_URI'], |
|
| 266 | + ] |
|
| 267 | + ); |
|
| 268 | + $response = new RedirectResponse($url); |
|
| 269 | + } else { |
|
| 270 | + $response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest'); |
|
| 271 | + $response->setStatus($exception->getCode()); |
|
| 272 | + } |
|
| 273 | + } |
|
| 274 | 274 | |
| 275 | - $this->logger->debug($exception->getMessage()); |
|
| 276 | - return $response; |
|
| 277 | - } |
|
| 275 | + $this->logger->debug($exception->getMessage()); |
|
| 276 | + return $response; |
|
| 277 | + } |
|
| 278 | 278 | |
| 279 | - throw $exception; |
|
| 280 | - } |
|
| 279 | + throw $exception; |
|
| 280 | + } |
|
| 281 | 281 | |
| 282 | 282 | } |
@@ -151,13 +151,13 @@ discard block |
||
| 151 | 151 | |
| 152 | 152 | // security checks |
| 153 | 153 | $isPublicPage = $this->reflector->hasAnnotation('PublicPage'); |
| 154 | - if(!$isPublicPage) { |
|
| 155 | - if(!$this->isLoggedIn) { |
|
| 154 | + if (!$isPublicPage) { |
|
| 155 | + if (!$this->isLoggedIn) { |
|
| 156 | 156 | throw new NotLoggedInException(); |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | - if(!$this->reflector->hasAnnotation('NoAdminRequired')) { |
|
| 160 | - if(!$this->isAdminUser) { |
|
| 159 | + if (!$this->reflector->hasAnnotation('NoAdminRequired')) { |
|
| 160 | + if (!$this->isAdminUser) { |
|
| 161 | 161 | throw new NotAdminException(); |
| 162 | 162 | } |
| 163 | 163 | } |
@@ -171,27 +171,27 @@ discard block |
||
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | // Check for strict cookie requirement |
| 174 | - if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 175 | - if(!$this->request->passesStrictCookieCheck()) { |
|
| 174 | + if ($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 175 | + if (!$this->request->passesStrictCookieCheck()) { |
|
| 176 | 176 | throw new StrictCookieMissingException(); |
| 177 | 177 | } |
| 178 | 178 | } |
| 179 | 179 | // CSRF check - also registers the CSRF token since the session may be closed later |
| 180 | 180 | Util::callRegister(); |
| 181 | - if(!$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 181 | + if (!$this->reflector->hasAnnotation('NoCSRFRequired')) { |
|
| 182 | 182 | /* |
| 183 | 183 | * Only allow the CSRF check to fail on OCS Requests. This kind of |
| 184 | 184 | * hacks around that we have no full token auth in place yet and we |
| 185 | 185 | * do want to offer CSRF checks for web requests. |
| 186 | 186 | */ |
| 187 | - if(!$this->request->passesCSRFCheck() && !( |
|
| 187 | + if (!$this->request->passesCSRFCheck() && !( |
|
| 188 | 188 | $controller instanceof OCSController && |
| 189 | 189 | $this->request->getHeader('OCS-APIREQUEST') === 'true')) { |
| 190 | 190 | throw new CrossSiteRequestForgeryException(); |
| 191 | 191 | } |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - if($this->reflector->hasAnnotation('BruteForceProtection')) { |
|
| 194 | + if ($this->reflector->hasAnnotation('BruteForceProtection')) { |
|
| 195 | 195 | $action = $this->reflector->getAnnotationParameter('BruteForceProtection'); |
| 196 | 196 | $this->throttler->sleepDelay($this->request->getRemoteAddress(), $action); |
| 197 | 197 | $this->throttler->registerAttempt($action, $this->request->getRemoteAddress()); |
@@ -203,7 +203,7 @@ discard block |
||
| 203 | 203 | * The getAppPath() check is here since components such as settings also use the AppFramework and |
| 204 | 204 | * therefore won't pass this check. |
| 205 | 205 | */ |
| 206 | - if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) { |
|
| 206 | + if (\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) { |
|
| 207 | 207 | throw new AppNotEnabledException(); |
| 208 | 208 | } |
| 209 | 209 | |
@@ -228,7 +228,7 @@ discard block |
||
| 228 | 228 | $defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy(); |
| 229 | 229 | $defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy); |
| 230 | 230 | |
| 231 | - if($this->cspNonceManager->browserSupportsCspV3()) { |
|
| 231 | + if ($this->cspNonceManager->browserSupportsCspV3()) { |
|
| 232 | 232 | $defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue()); |
| 233 | 233 | } |
| 234 | 234 | |
@@ -248,17 +248,17 @@ discard block |
||
| 248 | 248 | * @return Response a Response object or null in case that the exception could not be handled |
| 249 | 249 | */ |
| 250 | 250 | public function afterException($controller, $methodName, \Exception $exception) { |
| 251 | - if($exception instanceof SecurityException) { |
|
| 252 | - if($exception instanceof StrictCookieMissingException) { |
|
| 251 | + if ($exception instanceof SecurityException) { |
|
| 252 | + if ($exception instanceof StrictCookieMissingException) { |
|
| 253 | 253 | return new RedirectResponse(\OC::$WEBROOT); |
| 254 | 254 | } |
| 255 | - if (stripos($this->request->getHeader('Accept'),'html') === false) { |
|
| 255 | + if (stripos($this->request->getHeader('Accept'), 'html') === false) { |
|
| 256 | 256 | $response = new JSONResponse( |
| 257 | 257 | array('message' => $exception->getMessage()), |
| 258 | 258 | $exception->getCode() |
| 259 | 259 | ); |
| 260 | 260 | } else { |
| 261 | - if($exception instanceof NotLoggedInException) { |
|
| 261 | + if ($exception instanceof NotLoggedInException) { |
|
| 262 | 262 | $url = $this->urlGenerator->linkToRoute( |
| 263 | 263 | 'core.login.showLoginForm', |
| 264 | 264 | [ |
@@ -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); |
@@ -33,279 +33,279 @@ |
||
| 33 | 33 | * Jail to a subdirectory of the wrapped cache |
| 34 | 34 | */ |
| 35 | 35 | class CacheJail extends CacheWrapper { |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 39 | - protected $root; |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | + protected $root; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @param \OCP\Files\Cache\ICache $cache |
|
| 43 | - * @param string $root |
|
| 44 | - */ |
|
| 45 | - public function __construct($cache, $root) { |
|
| 46 | - parent::__construct($cache); |
|
| 47 | - $this->root = $root; |
|
| 48 | - } |
|
| 41 | + /** |
|
| 42 | + * @param \OCP\Files\Cache\ICache $cache |
|
| 43 | + * @param string $root |
|
| 44 | + */ |
|
| 45 | + public function __construct($cache, $root) { |
|
| 46 | + parent::__construct($cache); |
|
| 47 | + $this->root = $root; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - protected function getSourcePath($path) { |
|
| 51 | - if ($path === '') { |
|
| 52 | - return $this->root; |
|
| 53 | - } else { |
|
| 54 | - return $this->root . '/' . ltrim($path, '/'); |
|
| 55 | - } |
|
| 56 | - } |
|
| 50 | + protected function getSourcePath($path) { |
|
| 51 | + if ($path === '') { |
|
| 52 | + return $this->root; |
|
| 53 | + } else { |
|
| 54 | + return $this->root . '/' . ltrim($path, '/'); |
|
| 55 | + } |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @param string $path |
|
| 60 | - * @return null|string the jailed path or null if the path is outside the jail |
|
| 61 | - */ |
|
| 62 | - protected function getJailedPath($path) { |
|
| 63 | - if ($this->root === '') { |
|
| 64 | - return $path; |
|
| 65 | - } |
|
| 66 | - $rootLength = strlen($this->root) + 1; |
|
| 67 | - if ($path === $this->root) { |
|
| 68 | - return ''; |
|
| 69 | - } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 70 | - return substr($path, $rootLength); |
|
| 71 | - } else { |
|
| 72 | - return null; |
|
| 73 | - } |
|
| 74 | - } |
|
| 58 | + /** |
|
| 59 | + * @param string $path |
|
| 60 | + * @return null|string the jailed path or null if the path is outside the jail |
|
| 61 | + */ |
|
| 62 | + protected function getJailedPath($path) { |
|
| 63 | + if ($this->root === '') { |
|
| 64 | + return $path; |
|
| 65 | + } |
|
| 66 | + $rootLength = strlen($this->root) + 1; |
|
| 67 | + if ($path === $this->root) { |
|
| 68 | + return ''; |
|
| 69 | + } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 70 | + return substr($path, $rootLength); |
|
| 71 | + } else { |
|
| 72 | + return null; |
|
| 73 | + } |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * @param ICacheEntry|array $entry |
|
| 78 | - * @return array |
|
| 79 | - */ |
|
| 80 | - protected function formatCacheEntry($entry) { |
|
| 81 | - if (isset($entry['path'])) { |
|
| 82 | - $entry['path'] = $this->getJailedPath($entry['path']); |
|
| 83 | - } |
|
| 84 | - return $entry; |
|
| 85 | - } |
|
| 76 | + /** |
|
| 77 | + * @param ICacheEntry|array $entry |
|
| 78 | + * @return array |
|
| 79 | + */ |
|
| 80 | + protected function formatCacheEntry($entry) { |
|
| 81 | + if (isset($entry['path'])) { |
|
| 82 | + $entry['path'] = $this->getJailedPath($entry['path']); |
|
| 83 | + } |
|
| 84 | + return $entry; |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - protected function filterCacheEntry($entry) { |
|
| 88 | - $rootLength = strlen($this->root) + 1; |
|
| 89 | - return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 90 | - } |
|
| 87 | + protected function filterCacheEntry($entry) { |
|
| 88 | + $rootLength = strlen($this->root) + 1; |
|
| 89 | + return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * get the stored metadata of a file or folder |
|
| 94 | - * |
|
| 95 | - * @param string /int $file |
|
| 96 | - * @return array|false |
|
| 97 | - */ |
|
| 98 | - public function get($file) { |
|
| 99 | - if (is_string($file) or $file == '') { |
|
| 100 | - $file = $this->getSourcePath($file); |
|
| 101 | - } |
|
| 102 | - return parent::get($file); |
|
| 103 | - } |
|
| 92 | + /** |
|
| 93 | + * get the stored metadata of a file or folder |
|
| 94 | + * |
|
| 95 | + * @param string /int $file |
|
| 96 | + * @return array|false |
|
| 97 | + */ |
|
| 98 | + public function get($file) { |
|
| 99 | + if (is_string($file) or $file == '') { |
|
| 100 | + $file = $this->getSourcePath($file); |
|
| 101 | + } |
|
| 102 | + return parent::get($file); |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * insert meta data for a new file or folder |
|
| 107 | - * |
|
| 108 | - * @param string $file |
|
| 109 | - * @param array $data |
|
| 110 | - * |
|
| 111 | - * @return int file id |
|
| 112 | - * @throws \RuntimeException |
|
| 113 | - */ |
|
| 114 | - public function insert($file, array $data) { |
|
| 115 | - return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
| 116 | - } |
|
| 105 | + /** |
|
| 106 | + * insert meta data for a new file or folder |
|
| 107 | + * |
|
| 108 | + * @param string $file |
|
| 109 | + * @param array $data |
|
| 110 | + * |
|
| 111 | + * @return int file id |
|
| 112 | + * @throws \RuntimeException |
|
| 113 | + */ |
|
| 114 | + public function insert($file, array $data) { |
|
| 115 | + return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
| 116 | + } |
|
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * update the metadata in the cache |
|
| 120 | - * |
|
| 121 | - * @param int $id |
|
| 122 | - * @param array $data |
|
| 123 | - */ |
|
| 124 | - public function update($id, array $data) { |
|
| 125 | - $this->getCache()->update($id, $data); |
|
| 126 | - } |
|
| 118 | + /** |
|
| 119 | + * update the metadata in the cache |
|
| 120 | + * |
|
| 121 | + * @param int $id |
|
| 122 | + * @param array $data |
|
| 123 | + */ |
|
| 124 | + public function update($id, array $data) { |
|
| 125 | + $this->getCache()->update($id, $data); |
|
| 126 | + } |
|
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * get the file id for a file |
|
| 130 | - * |
|
| 131 | - * @param string $file |
|
| 132 | - * @return int |
|
| 133 | - */ |
|
| 134 | - public function getId($file) { |
|
| 135 | - return $this->getCache()->getId($this->getSourcePath($file)); |
|
| 136 | - } |
|
| 128 | + /** |
|
| 129 | + * get the file id for a file |
|
| 130 | + * |
|
| 131 | + * @param string $file |
|
| 132 | + * @return int |
|
| 133 | + */ |
|
| 134 | + public function getId($file) { |
|
| 135 | + return $this->getCache()->getId($this->getSourcePath($file)); |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * get the id of the parent folder of a file |
|
| 140 | - * |
|
| 141 | - * @param string $file |
|
| 142 | - * @return int |
|
| 143 | - */ |
|
| 144 | - public function getParentId($file) { |
|
| 145 | - return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
| 146 | - } |
|
| 138 | + /** |
|
| 139 | + * get the id of the parent folder of a file |
|
| 140 | + * |
|
| 141 | + * @param string $file |
|
| 142 | + * @return int |
|
| 143 | + */ |
|
| 144 | + public function getParentId($file) { |
|
| 145 | + return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * check if a file is available in the cache |
|
| 150 | - * |
|
| 151 | - * @param string $file |
|
| 152 | - * @return bool |
|
| 153 | - */ |
|
| 154 | - public function inCache($file) { |
|
| 155 | - return $this->getCache()->inCache($this->getSourcePath($file)); |
|
| 156 | - } |
|
| 148 | + /** |
|
| 149 | + * check if a file is available in the cache |
|
| 150 | + * |
|
| 151 | + * @param string $file |
|
| 152 | + * @return bool |
|
| 153 | + */ |
|
| 154 | + public function inCache($file) { |
|
| 155 | + return $this->getCache()->inCache($this->getSourcePath($file)); |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * remove a file or folder from the cache |
|
| 160 | - * |
|
| 161 | - * @param string $file |
|
| 162 | - */ |
|
| 163 | - public function remove($file) { |
|
| 164 | - $this->getCache()->remove($this->getSourcePath($file)); |
|
| 165 | - } |
|
| 158 | + /** |
|
| 159 | + * remove a file or folder from the cache |
|
| 160 | + * |
|
| 161 | + * @param string $file |
|
| 162 | + */ |
|
| 163 | + public function remove($file) { |
|
| 164 | + $this->getCache()->remove($this->getSourcePath($file)); |
|
| 165 | + } |
|
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Move a file or folder in the cache |
|
| 169 | - * |
|
| 170 | - * @param string $source |
|
| 171 | - * @param string $target |
|
| 172 | - */ |
|
| 173 | - public function move($source, $target) { |
|
| 174 | - $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
| 175 | - } |
|
| 167 | + /** |
|
| 168 | + * Move a file or folder in the cache |
|
| 169 | + * |
|
| 170 | + * @param string $source |
|
| 171 | + * @param string $target |
|
| 172 | + */ |
|
| 173 | + public function move($source, $target) { |
|
| 174 | + $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
| 175 | + } |
|
| 176 | 176 | |
| 177 | - /** |
|
| 178 | - * remove all entries for files that are stored on the storage from the cache |
|
| 179 | - */ |
|
| 180 | - public function clear() { |
|
| 181 | - $this->getCache()->remove($this->root); |
|
| 182 | - } |
|
| 177 | + /** |
|
| 178 | + * remove all entries for files that are stored on the storage from the cache |
|
| 179 | + */ |
|
| 180 | + public function clear() { |
|
| 181 | + $this->getCache()->remove($this->root); |
|
| 182 | + } |
|
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * @param string $file |
|
| 186 | - * |
|
| 187 | - * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 188 | - */ |
|
| 189 | - public function getStatus($file) { |
|
| 190 | - return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
| 191 | - } |
|
| 184 | + /** |
|
| 185 | + * @param string $file |
|
| 186 | + * |
|
| 187 | + * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 188 | + */ |
|
| 189 | + public function getStatus($file) { |
|
| 190 | + return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
| 191 | + } |
|
| 192 | 192 | |
| 193 | - private function formatSearchResults($results) { |
|
| 194 | - $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
| 195 | - $results = array_values($results); |
|
| 196 | - return array_map(array($this, 'formatCacheEntry'), $results); |
|
| 197 | - } |
|
| 193 | + private function formatSearchResults($results) { |
|
| 194 | + $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
| 195 | + $results = array_values($results); |
|
| 196 | + return array_map(array($this, 'formatCacheEntry'), $results); |
|
| 197 | + } |
|
| 198 | 198 | |
| 199 | - /** |
|
| 200 | - * search for files matching $pattern |
|
| 201 | - * |
|
| 202 | - * @param string $pattern |
|
| 203 | - * @return array an array of file data |
|
| 204 | - */ |
|
| 205 | - public function search($pattern) { |
|
| 206 | - $results = $this->getCache()->search($pattern); |
|
| 207 | - return $this->formatSearchResults($results); |
|
| 208 | - } |
|
| 199 | + /** |
|
| 200 | + * search for files matching $pattern |
|
| 201 | + * |
|
| 202 | + * @param string $pattern |
|
| 203 | + * @return array an array of file data |
|
| 204 | + */ |
|
| 205 | + public function search($pattern) { |
|
| 206 | + $results = $this->getCache()->search($pattern); |
|
| 207 | + return $this->formatSearchResults($results); |
|
| 208 | + } |
|
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * search for files by mimetype |
|
| 212 | - * |
|
| 213 | - * @param string $mimetype |
|
| 214 | - * @return array |
|
| 215 | - */ |
|
| 216 | - public function searchByMime($mimetype) { |
|
| 217 | - $results = $this->getCache()->searchByMime($mimetype); |
|
| 218 | - return $this->formatSearchResults($results); |
|
| 219 | - } |
|
| 210 | + /** |
|
| 211 | + * search for files by mimetype |
|
| 212 | + * |
|
| 213 | + * @param string $mimetype |
|
| 214 | + * @return array |
|
| 215 | + */ |
|
| 216 | + public function searchByMime($mimetype) { |
|
| 217 | + $results = $this->getCache()->searchByMime($mimetype); |
|
| 218 | + return $this->formatSearchResults($results); |
|
| 219 | + } |
|
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * search for files by mimetype |
|
| 223 | - * |
|
| 224 | - * @param string|int $tag name or tag id |
|
| 225 | - * @param string $userId owner of the tags |
|
| 226 | - * @return array |
|
| 227 | - */ |
|
| 228 | - public function searchByTag($tag, $userId) { |
|
| 229 | - $results = $this->getCache()->searchByTag($tag, $userId); |
|
| 230 | - return $this->formatSearchResults($results); |
|
| 231 | - } |
|
| 221 | + /** |
|
| 222 | + * search for files by mimetype |
|
| 223 | + * |
|
| 224 | + * @param string|int $tag name or tag id |
|
| 225 | + * @param string $userId owner of the tags |
|
| 226 | + * @return array |
|
| 227 | + */ |
|
| 228 | + public function searchByTag($tag, $userId) { |
|
| 229 | + $results = $this->getCache()->searchByTag($tag, $userId); |
|
| 230 | + return $this->formatSearchResults($results); |
|
| 231 | + } |
|
| 232 | 232 | |
| 233 | - /** |
|
| 234 | - * update the folder size and the size of all parent folders |
|
| 235 | - * |
|
| 236 | - * @param string|boolean $path |
|
| 237 | - * @param array $data (optional) meta data of the folder |
|
| 238 | - */ |
|
| 239 | - public function correctFolderSize($path, $data = null) { |
|
| 240 | - if ($this->getCache() instanceof Cache) { |
|
| 241 | - $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
| 242 | - } |
|
| 243 | - } |
|
| 233 | + /** |
|
| 234 | + * update the folder size and the size of all parent folders |
|
| 235 | + * |
|
| 236 | + * @param string|boolean $path |
|
| 237 | + * @param array $data (optional) meta data of the folder |
|
| 238 | + */ |
|
| 239 | + public function correctFolderSize($path, $data = null) { |
|
| 240 | + if ($this->getCache() instanceof Cache) { |
|
| 241 | + $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
| 242 | + } |
|
| 243 | + } |
|
| 244 | 244 | |
| 245 | - /** |
|
| 246 | - * get the size of a folder and set it in the cache |
|
| 247 | - * |
|
| 248 | - * @param string $path |
|
| 249 | - * @param array $entry (optional) meta data of the folder |
|
| 250 | - * @return int |
|
| 251 | - */ |
|
| 252 | - public function calculateFolderSize($path, $entry = null) { |
|
| 253 | - if ($this->getCache() instanceof Cache) { |
|
| 254 | - return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
| 255 | - } else { |
|
| 256 | - return 0; |
|
| 257 | - } |
|
| 245 | + /** |
|
| 246 | + * get the size of a folder and set it in the cache |
|
| 247 | + * |
|
| 248 | + * @param string $path |
|
| 249 | + * @param array $entry (optional) meta data of the folder |
|
| 250 | + * @return int |
|
| 251 | + */ |
|
| 252 | + public function calculateFolderSize($path, $entry = null) { |
|
| 253 | + if ($this->getCache() instanceof Cache) { |
|
| 254 | + return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
| 255 | + } else { |
|
| 256 | + return 0; |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | - } |
|
| 259 | + } |
|
| 260 | 260 | |
| 261 | - /** |
|
| 262 | - * get all file ids on the files on the storage |
|
| 263 | - * |
|
| 264 | - * @return int[] |
|
| 265 | - */ |
|
| 266 | - public function getAll() { |
|
| 267 | - // not supported |
|
| 268 | - return array(); |
|
| 269 | - } |
|
| 261 | + /** |
|
| 262 | + * get all file ids on the files on the storage |
|
| 263 | + * |
|
| 264 | + * @return int[] |
|
| 265 | + */ |
|
| 266 | + public function getAll() { |
|
| 267 | + // not supported |
|
| 268 | + return array(); |
|
| 269 | + } |
|
| 270 | 270 | |
| 271 | - /** |
|
| 272 | - * find a folder in the cache which has not been fully scanned |
|
| 273 | - * |
|
| 274 | - * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 275 | - * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 276 | - * likely the folder where we stopped scanning previously |
|
| 277 | - * |
|
| 278 | - * @return string|bool the path of the folder or false when no folder matched |
|
| 279 | - */ |
|
| 280 | - public function getIncomplete() { |
|
| 281 | - // not supported |
|
| 282 | - return false; |
|
| 283 | - } |
|
| 271 | + /** |
|
| 272 | + * find a folder in the cache which has not been fully scanned |
|
| 273 | + * |
|
| 274 | + * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 275 | + * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 276 | + * likely the folder where we stopped scanning previously |
|
| 277 | + * |
|
| 278 | + * @return string|bool the path of the folder or false when no folder matched |
|
| 279 | + */ |
|
| 280 | + public function getIncomplete() { |
|
| 281 | + // not supported |
|
| 282 | + return false; |
|
| 283 | + } |
|
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * get the path of a file on this storage by it's id |
|
| 287 | - * |
|
| 288 | - * @param int $id |
|
| 289 | - * @return string|null |
|
| 290 | - */ |
|
| 291 | - public function getPathById($id) { |
|
| 292 | - $path = $this->getCache()->getPathById($id); |
|
| 293 | - return $this->getJailedPath($path); |
|
| 294 | - } |
|
| 285 | + /** |
|
| 286 | + * get the path of a file on this storage by it's id |
|
| 287 | + * |
|
| 288 | + * @param int $id |
|
| 289 | + * @return string|null |
|
| 290 | + */ |
|
| 291 | + public function getPathById($id) { |
|
| 292 | + $path = $this->getCache()->getPathById($id); |
|
| 293 | + return $this->getJailedPath($path); |
|
| 294 | + } |
|
| 295 | 295 | |
| 296 | - /** |
|
| 297 | - * Move a file or folder in the cache |
|
| 298 | - * |
|
| 299 | - * Note that this should make sure the entries are removed from the source cache |
|
| 300 | - * |
|
| 301 | - * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 302 | - * @param string $sourcePath |
|
| 303 | - * @param string $targetPath |
|
| 304 | - */ |
|
| 305 | - public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 306 | - if ($sourceCache === $this) { |
|
| 307 | - return $this->move($sourcePath, $targetPath); |
|
| 308 | - } |
|
| 309 | - return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
| 310 | - } |
|
| 296 | + /** |
|
| 297 | + * Move a file or folder in the cache |
|
| 298 | + * |
|
| 299 | + * Note that this should make sure the entries are removed from the source cache |
|
| 300 | + * |
|
| 301 | + * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 302 | + * @param string $sourcePath |
|
| 303 | + * @param string $targetPath |
|
| 304 | + */ |
|
| 305 | + public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 306 | + if ($sourceCache === $this) { |
|
| 307 | + return $this->move($sourcePath, $targetPath); |
|
| 308 | + } |
|
| 309 | + return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
| 310 | + } |
|
| 311 | 311 | } |
@@ -51,7 +51,7 @@ discard block |
||
| 51 | 51 | if ($path === '') { |
| 52 | 52 | return $this->root; |
| 53 | 53 | } else { |
| 54 | - return $this->root . '/' . ltrim($path, '/'); |
|
| 54 | + return $this->root.'/'.ltrim($path, '/'); |
|
| 55 | 55 | } |
| 56 | 56 | } |
| 57 | 57 | |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | $rootLength = strlen($this->root) + 1; |
| 67 | 67 | if ($path === $this->root) { |
| 68 | 68 | return ''; |
| 69 | - } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 69 | + } else if (substr($path, 0, $rootLength) === $this->root.'/') { |
|
| 70 | 70 | return substr($path, $rootLength); |
| 71 | 71 | } else { |
| 72 | 72 | return null; |
@@ -86,7 +86,7 @@ discard block |
||
| 86 | 86 | |
| 87 | 87 | protected function filterCacheEntry($entry) { |
| 88 | 88 | $rootLength = strlen($this->root) + 1; |
| 89 | - return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 89 | + return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root.'/'); |
|
| 90 | 90 | } |
| 91 | 91 | |
| 92 | 92 | /** |
@@ -32,7 +32,6 @@ |
||
| 32 | 32 | |
| 33 | 33 | use OCP\Files\Cache\ICacheEntry; |
| 34 | 34 | use OCP\Files\Mount\IMountPoint; |
| 35 | -use OCP\Files\Storage\IStorage; |
|
| 36 | 35 | use OCP\Files\IHomeStorage; |
| 37 | 36 | use OCP\IUser; |
| 38 | 37 | |
@@ -37,354 +37,354 @@ |
||
| 37 | 37 | use OCP\IUser; |
| 38 | 38 | |
| 39 | 39 | class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess { |
| 40 | - /** |
|
| 41 | - * @var array $data |
|
| 42 | - */ |
|
| 43 | - private $data; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var string $path |
|
| 47 | - */ |
|
| 48 | - private $path; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @var \OC\Files\Storage\Storage $storage |
|
| 52 | - */ |
|
| 53 | - private $storage; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @var string $internalPath |
|
| 57 | - */ |
|
| 58 | - private $internalPath; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @var \OCP\Files\Mount\IMountPoint |
|
| 62 | - */ |
|
| 63 | - private $mount; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @var IUser |
|
| 67 | - */ |
|
| 68 | - private $owner; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * @var string[] |
|
| 72 | - */ |
|
| 73 | - private $childEtags = []; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @var IMountPoint[] |
|
| 77 | - */ |
|
| 78 | - private $subMounts = []; |
|
| 79 | - |
|
| 80 | - private $subMountsUsed = false; |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @param string|boolean $path |
|
| 84 | - * @param Storage\Storage $storage |
|
| 85 | - * @param string $internalPath |
|
| 86 | - * @param array|ICacheEntry $data |
|
| 87 | - * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 88 | - * @param \OCP\IUser|null $owner |
|
| 89 | - */ |
|
| 90 | - public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 91 | - $this->path = $path; |
|
| 92 | - $this->storage = $storage; |
|
| 93 | - $this->internalPath = $internalPath; |
|
| 94 | - $this->data = $data; |
|
| 95 | - $this->mount = $mount; |
|
| 96 | - $this->owner = $owner; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - public function offsetSet($offset, $value) { |
|
| 100 | - $this->data[$offset] = $value; |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - public function offsetExists($offset) { |
|
| 104 | - return isset($this->data[$offset]); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - public function offsetUnset($offset) { |
|
| 108 | - unset($this->data[$offset]); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - public function offsetGet($offset) { |
|
| 112 | - if ($offset === 'type') { |
|
| 113 | - return $this->getType(); |
|
| 114 | - } else if ($offset === 'etag') { |
|
| 115 | - return $this->getEtag(); |
|
| 116 | - } else if ($offset === 'size') { |
|
| 117 | - return $this->getSize(); |
|
| 118 | - } else if ($offset === 'mtime') { |
|
| 119 | - return $this->getMTime(); |
|
| 120 | - } elseif ($offset === 'permissions') { |
|
| 121 | - return $this->getPermissions(); |
|
| 122 | - } elseif (isset($this->data[$offset])) { |
|
| 123 | - return $this->data[$offset]; |
|
| 124 | - } else { |
|
| 125 | - return null; |
|
| 126 | - } |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * @return string |
|
| 131 | - */ |
|
| 132 | - public function getPath() { |
|
| 133 | - return $this->path; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @return \OCP\Files\Storage |
|
| 138 | - */ |
|
| 139 | - public function getStorage() { |
|
| 140 | - return $this->storage; |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @return string |
|
| 145 | - */ |
|
| 146 | - public function getInternalPath() { |
|
| 147 | - return $this->internalPath; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * @return int |
|
| 152 | - */ |
|
| 153 | - public function getId() { |
|
| 154 | - return $this->data['fileid']; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @return string |
|
| 159 | - */ |
|
| 160 | - public function getMimetype() { |
|
| 161 | - return $this->data['mimetype']; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * @return string |
|
| 166 | - */ |
|
| 167 | - public function getMimePart() { |
|
| 168 | - return $this->data['mimepart']; |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * @return string |
|
| 173 | - */ |
|
| 174 | - public function getName() { |
|
| 175 | - return basename($this->getPath()); |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - public function getEtag() { |
|
| 182 | - $this->updateEntryfromSubMounts(); |
|
| 183 | - if (count($this->childEtags) > 0) { |
|
| 184 | - $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 185 | - return md5($combinedEtag); |
|
| 186 | - } else { |
|
| 187 | - return $this->data['etag']; |
|
| 188 | - } |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * @return int |
|
| 193 | - */ |
|
| 194 | - public function getSize() { |
|
| 195 | - $this->updateEntryfromSubMounts(); |
|
| 196 | - return isset($this->data['size']) ? $this->data['size'] : 0; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * @return int |
|
| 201 | - */ |
|
| 202 | - public function getMTime() { |
|
| 203 | - $this->updateEntryfromSubMounts(); |
|
| 204 | - return $this->data['mtime']; |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @return bool |
|
| 209 | - */ |
|
| 210 | - public function isEncrypted() { |
|
| 211 | - return $this->data['encrypted']; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Return the currently version used for the HMAC in the encryption app |
|
| 216 | - * |
|
| 217 | - * @return int |
|
| 218 | - */ |
|
| 219 | - public function getEncryptedVersion() { |
|
| 220 | - return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - /** |
|
| 224 | - * @return int |
|
| 225 | - */ |
|
| 226 | - public function getPermissions() { |
|
| 227 | - $perms = $this->data['permissions']; |
|
| 228 | - if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) { |
|
| 229 | - $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE; |
|
| 230 | - } |
|
| 231 | - return $perms; |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - /** |
|
| 235 | - * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
| 236 | - */ |
|
| 237 | - public function getType() { |
|
| 238 | - if (!isset($this->data['type'])) { |
|
| 239 | - $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE; |
|
| 240 | - } |
|
| 241 | - return $this->data['type']; |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - public function getData() { |
|
| 245 | - return $this->data; |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * @param int $permissions |
|
| 250 | - * @return bool |
|
| 251 | - */ |
|
| 252 | - protected function checkPermissions($permissions) { |
|
| 253 | - return ($this->getPermissions() & $permissions) === $permissions; |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * @return bool |
|
| 258 | - */ |
|
| 259 | - public function isReadable() { |
|
| 260 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_READ); |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * @return bool |
|
| 265 | - */ |
|
| 266 | - public function isUpdateable() { |
|
| 267 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE); |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Check whether new files or folders can be created inside this folder |
|
| 272 | - * |
|
| 273 | - * @return bool |
|
| 274 | - */ |
|
| 275 | - public function isCreatable() { |
|
| 276 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE); |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * @return bool |
|
| 281 | - */ |
|
| 282 | - public function isDeletable() { |
|
| 283 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE); |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * @return bool |
|
| 288 | - */ |
|
| 289 | - public function isShareable() { |
|
| 290 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE); |
|
| 291 | - } |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Check if a file or folder is shared |
|
| 295 | - * |
|
| 296 | - * @return bool |
|
| 297 | - */ |
|
| 298 | - public function isShared() { |
|
| 299 | - $sid = $this->getStorage()->getId(); |
|
| 300 | - if (!is_null($sid)) { |
|
| 301 | - $sid = explode(':', $sid); |
|
| 302 | - return ($sid[0] === 'shared'); |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - return false; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - public function isMounted() { |
|
| 309 | - $storage = $this->getStorage(); |
|
| 310 | - if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
| 311 | - return false; |
|
| 312 | - } |
|
| 313 | - $sid = $storage->getId(); |
|
| 314 | - if (!is_null($sid)) { |
|
| 315 | - $sid = explode(':', $sid); |
|
| 316 | - return ($sid[0] !== 'home' and $sid[0] !== 'shared'); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - return false; |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Get the mountpoint the file belongs to |
|
| 324 | - * |
|
| 325 | - * @return \OCP\Files\Mount\IMountPoint |
|
| 326 | - */ |
|
| 327 | - public function getMountPoint() { |
|
| 328 | - return $this->mount; |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - /** |
|
| 332 | - * Get the owner of the file |
|
| 333 | - * |
|
| 334 | - * @return \OCP\IUser |
|
| 335 | - */ |
|
| 336 | - public function getOwner() { |
|
| 337 | - return $this->owner; |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /** |
|
| 341 | - * @param IMountPoint[] $mounts |
|
| 342 | - */ |
|
| 343 | - public function setSubMounts(array $mounts) { |
|
| 344 | - $this->subMounts = $mounts; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - private function updateEntryfromSubMounts() { |
|
| 348 | - if ($this->subMountsUsed) { |
|
| 349 | - return; |
|
| 350 | - } |
|
| 351 | - $this->subMountsUsed = true; |
|
| 352 | - foreach ($this->subMounts as $mount) { |
|
| 353 | - $subStorage = $mount->getStorage(); |
|
| 354 | - if ($subStorage) { |
|
| 355 | - $subCache = $subStorage->getCache(''); |
|
| 356 | - $rootEntry = $subCache->get(''); |
|
| 357 | - $this->addSubEntry($rootEntry, $mount->getMountPoint()); |
|
| 358 | - } |
|
| 359 | - } |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - /** |
|
| 363 | - * Add a cache entry which is the child of this folder |
|
| 364 | - * |
|
| 365 | - * Sets the size, etag and size to for cross-storage childs |
|
| 366 | - * |
|
| 367 | - * @param array|ICacheEntry $data cache entry for the child |
|
| 368 | - * @param string $entryPath full path of the child entry |
|
| 369 | - */ |
|
| 370 | - public function addSubEntry($data, $entryPath) { |
|
| 371 | - $this->data['size'] += isset($data['size']) ? $data['size'] : 0; |
|
| 372 | - if (isset($data['mtime'])) { |
|
| 373 | - $this->data['mtime'] = max($this->data['mtime'], $data['mtime']); |
|
| 374 | - } |
|
| 375 | - if (isset($data['etag'])) { |
|
| 376 | - // prefix the etag with the relative path of the subentry to propagate etag on mount moves |
|
| 377 | - $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
|
| 378 | - // attach the permissions to propagate etag on permision changes of submounts |
|
| 379 | - $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
|
| 380 | - $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 381 | - } |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * @inheritdoc |
|
| 386 | - */ |
|
| 387 | - public function getChecksum() { |
|
| 388 | - return $this->data['checksum']; |
|
| 389 | - } |
|
| 40 | + /** |
|
| 41 | + * @var array $data |
|
| 42 | + */ |
|
| 43 | + private $data; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var string $path |
|
| 47 | + */ |
|
| 48 | + private $path; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @var \OC\Files\Storage\Storage $storage |
|
| 52 | + */ |
|
| 53 | + private $storage; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @var string $internalPath |
|
| 57 | + */ |
|
| 58 | + private $internalPath; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @var \OCP\Files\Mount\IMountPoint |
|
| 62 | + */ |
|
| 63 | + private $mount; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @var IUser |
|
| 67 | + */ |
|
| 68 | + private $owner; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * @var string[] |
|
| 72 | + */ |
|
| 73 | + private $childEtags = []; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @var IMountPoint[] |
|
| 77 | + */ |
|
| 78 | + private $subMounts = []; |
|
| 79 | + |
|
| 80 | + private $subMountsUsed = false; |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @param string|boolean $path |
|
| 84 | + * @param Storage\Storage $storage |
|
| 85 | + * @param string $internalPath |
|
| 86 | + * @param array|ICacheEntry $data |
|
| 87 | + * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 88 | + * @param \OCP\IUser|null $owner |
|
| 89 | + */ |
|
| 90 | + public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 91 | + $this->path = $path; |
|
| 92 | + $this->storage = $storage; |
|
| 93 | + $this->internalPath = $internalPath; |
|
| 94 | + $this->data = $data; |
|
| 95 | + $this->mount = $mount; |
|
| 96 | + $this->owner = $owner; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + public function offsetSet($offset, $value) { |
|
| 100 | + $this->data[$offset] = $value; |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + public function offsetExists($offset) { |
|
| 104 | + return isset($this->data[$offset]); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + public function offsetUnset($offset) { |
|
| 108 | + unset($this->data[$offset]); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + public function offsetGet($offset) { |
|
| 112 | + if ($offset === 'type') { |
|
| 113 | + return $this->getType(); |
|
| 114 | + } else if ($offset === 'etag') { |
|
| 115 | + return $this->getEtag(); |
|
| 116 | + } else if ($offset === 'size') { |
|
| 117 | + return $this->getSize(); |
|
| 118 | + } else if ($offset === 'mtime') { |
|
| 119 | + return $this->getMTime(); |
|
| 120 | + } elseif ($offset === 'permissions') { |
|
| 121 | + return $this->getPermissions(); |
|
| 122 | + } elseif (isset($this->data[$offset])) { |
|
| 123 | + return $this->data[$offset]; |
|
| 124 | + } else { |
|
| 125 | + return null; |
|
| 126 | + } |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * @return string |
|
| 131 | + */ |
|
| 132 | + public function getPath() { |
|
| 133 | + return $this->path; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @return \OCP\Files\Storage |
|
| 138 | + */ |
|
| 139 | + public function getStorage() { |
|
| 140 | + return $this->storage; |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @return string |
|
| 145 | + */ |
|
| 146 | + public function getInternalPath() { |
|
| 147 | + return $this->internalPath; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * @return int |
|
| 152 | + */ |
|
| 153 | + public function getId() { |
|
| 154 | + return $this->data['fileid']; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 160 | + public function getMimetype() { |
|
| 161 | + return $this->data['mimetype']; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * @return string |
|
| 166 | + */ |
|
| 167 | + public function getMimePart() { |
|
| 168 | + return $this->data['mimepart']; |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * @return string |
|
| 173 | + */ |
|
| 174 | + public function getName() { |
|
| 175 | + return basename($this->getPath()); |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + public function getEtag() { |
|
| 182 | + $this->updateEntryfromSubMounts(); |
|
| 183 | + if (count($this->childEtags) > 0) { |
|
| 184 | + $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 185 | + return md5($combinedEtag); |
|
| 186 | + } else { |
|
| 187 | + return $this->data['etag']; |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * @return int |
|
| 193 | + */ |
|
| 194 | + public function getSize() { |
|
| 195 | + $this->updateEntryfromSubMounts(); |
|
| 196 | + return isset($this->data['size']) ? $this->data['size'] : 0; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * @return int |
|
| 201 | + */ |
|
| 202 | + public function getMTime() { |
|
| 203 | + $this->updateEntryfromSubMounts(); |
|
| 204 | + return $this->data['mtime']; |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @return bool |
|
| 209 | + */ |
|
| 210 | + public function isEncrypted() { |
|
| 211 | + return $this->data['encrypted']; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Return the currently version used for the HMAC in the encryption app |
|
| 216 | + * |
|
| 217 | + * @return int |
|
| 218 | + */ |
|
| 219 | + public function getEncryptedVersion() { |
|
| 220 | + return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * @return int |
|
| 225 | + */ |
|
| 226 | + public function getPermissions() { |
|
| 227 | + $perms = $this->data['permissions']; |
|
| 228 | + if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) { |
|
| 229 | + $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE; |
|
| 230 | + } |
|
| 231 | + return $perms; |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + /** |
|
| 235 | + * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
| 236 | + */ |
|
| 237 | + public function getType() { |
|
| 238 | + if (!isset($this->data['type'])) { |
|
| 239 | + $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE; |
|
| 240 | + } |
|
| 241 | + return $this->data['type']; |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + public function getData() { |
|
| 245 | + return $this->data; |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * @param int $permissions |
|
| 250 | + * @return bool |
|
| 251 | + */ |
|
| 252 | + protected function checkPermissions($permissions) { |
|
| 253 | + return ($this->getPermissions() & $permissions) === $permissions; |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * @return bool |
|
| 258 | + */ |
|
| 259 | + public function isReadable() { |
|
| 260 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_READ); |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * @return bool |
|
| 265 | + */ |
|
| 266 | + public function isUpdateable() { |
|
| 267 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE); |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Check whether new files or folders can be created inside this folder |
|
| 272 | + * |
|
| 273 | + * @return bool |
|
| 274 | + */ |
|
| 275 | + public function isCreatable() { |
|
| 276 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE); |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * @return bool |
|
| 281 | + */ |
|
| 282 | + public function isDeletable() { |
|
| 283 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE); |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * @return bool |
|
| 288 | + */ |
|
| 289 | + public function isShareable() { |
|
| 290 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE); |
|
| 291 | + } |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Check if a file or folder is shared |
|
| 295 | + * |
|
| 296 | + * @return bool |
|
| 297 | + */ |
|
| 298 | + public function isShared() { |
|
| 299 | + $sid = $this->getStorage()->getId(); |
|
| 300 | + if (!is_null($sid)) { |
|
| 301 | + $sid = explode(':', $sid); |
|
| 302 | + return ($sid[0] === 'shared'); |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + return false; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + public function isMounted() { |
|
| 309 | + $storage = $this->getStorage(); |
|
| 310 | + if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
| 311 | + return false; |
|
| 312 | + } |
|
| 313 | + $sid = $storage->getId(); |
|
| 314 | + if (!is_null($sid)) { |
|
| 315 | + $sid = explode(':', $sid); |
|
| 316 | + return ($sid[0] !== 'home' and $sid[0] !== 'shared'); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + return false; |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Get the mountpoint the file belongs to |
|
| 324 | + * |
|
| 325 | + * @return \OCP\Files\Mount\IMountPoint |
|
| 326 | + */ |
|
| 327 | + public function getMountPoint() { |
|
| 328 | + return $this->mount; |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + /** |
|
| 332 | + * Get the owner of the file |
|
| 333 | + * |
|
| 334 | + * @return \OCP\IUser |
|
| 335 | + */ |
|
| 336 | + public function getOwner() { |
|
| 337 | + return $this->owner; |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /** |
|
| 341 | + * @param IMountPoint[] $mounts |
|
| 342 | + */ |
|
| 343 | + public function setSubMounts(array $mounts) { |
|
| 344 | + $this->subMounts = $mounts; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + private function updateEntryfromSubMounts() { |
|
| 348 | + if ($this->subMountsUsed) { |
|
| 349 | + return; |
|
| 350 | + } |
|
| 351 | + $this->subMountsUsed = true; |
|
| 352 | + foreach ($this->subMounts as $mount) { |
|
| 353 | + $subStorage = $mount->getStorage(); |
|
| 354 | + if ($subStorage) { |
|
| 355 | + $subCache = $subStorage->getCache(''); |
|
| 356 | + $rootEntry = $subCache->get(''); |
|
| 357 | + $this->addSubEntry($rootEntry, $mount->getMountPoint()); |
|
| 358 | + } |
|
| 359 | + } |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + /** |
|
| 363 | + * Add a cache entry which is the child of this folder |
|
| 364 | + * |
|
| 365 | + * Sets the size, etag and size to for cross-storage childs |
|
| 366 | + * |
|
| 367 | + * @param array|ICacheEntry $data cache entry for the child |
|
| 368 | + * @param string $entryPath full path of the child entry |
|
| 369 | + */ |
|
| 370 | + public function addSubEntry($data, $entryPath) { |
|
| 371 | + $this->data['size'] += isset($data['size']) ? $data['size'] : 0; |
|
| 372 | + if (isset($data['mtime'])) { |
|
| 373 | + $this->data['mtime'] = max($this->data['mtime'], $data['mtime']); |
|
| 374 | + } |
|
| 375 | + if (isset($data['etag'])) { |
|
| 376 | + // prefix the etag with the relative path of the subentry to propagate etag on mount moves |
|
| 377 | + $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
|
| 378 | + // attach the permissions to propagate etag on permision changes of submounts |
|
| 379 | + $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
|
| 380 | + $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 381 | + } |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * @inheritdoc |
|
| 386 | + */ |
|
| 387 | + public function getChecksum() { |
|
| 388 | + return $this->data['checksum']; |
|
| 389 | + } |
|
| 390 | 390 | } |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | * @param \OCP\Files\Mount\IMountPoint $mount |
| 88 | 88 | * @param \OCP\IUser|null $owner |
| 89 | 89 | */ |
| 90 | - public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 90 | + public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) { |
|
| 91 | 91 | $this->path = $path; |
| 92 | 92 | $this->storage = $storage; |
| 93 | 93 | $this->internalPath = $internalPath; |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | public function getEtag() { |
| 182 | 182 | $this->updateEntryfromSubMounts(); |
| 183 | 183 | if (count($this->childEtags) > 0) { |
| 184 | - $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 184 | + $combinedEtag = $this->data['etag'].'::'.implode('::', $this->childEtags); |
|
| 185 | 185 | return md5($combinedEtag); |
| 186 | 186 | } else { |
| 187 | 187 | return $this->data['etag']; |
@@ -377,7 +377,7 @@ discard block |
||
| 377 | 377 | $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
| 378 | 378 | // attach the permissions to propagate etag on permision changes of submounts |
| 379 | 379 | $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
| 380 | - $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 380 | + $this->childEtags[] = $relativeEntryPath.'/'.$data['etag'].$permissions; |
|
| 381 | 381 | } |
| 382 | 382 | } |
| 383 | 383 | |
@@ -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(); |
@@ -55,308 +55,308 @@ |
||
| 55 | 55 | * @package OC\Group |
| 56 | 56 | */ |
| 57 | 57 | class Manager extends PublicEmitter implements IGroupManager { |
| 58 | - /** |
|
| 59 | - * @var GroupInterface[] $backends |
|
| 60 | - */ |
|
| 61 | - private $backends = array(); |
|
| 58 | + /** |
|
| 59 | + * @var GroupInterface[] $backends |
|
| 60 | + */ |
|
| 61 | + private $backends = array(); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @var \OC\User\Manager $userManager |
|
| 65 | - */ |
|
| 66 | - private $userManager; |
|
| 63 | + /** |
|
| 64 | + * @var \OC\User\Manager $userManager |
|
| 65 | + */ |
|
| 66 | + private $userManager; |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @var \OC\Group\Group[] |
|
| 70 | - */ |
|
| 71 | - private $cachedGroups = array(); |
|
| 68 | + /** |
|
| 69 | + * @var \OC\Group\Group[] |
|
| 70 | + */ |
|
| 71 | + private $cachedGroups = array(); |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @var \OC\Group\Group[] |
|
| 75 | - */ |
|
| 76 | - private $cachedUserGroups = array(); |
|
| 73 | + /** |
|
| 74 | + * @var \OC\Group\Group[] |
|
| 75 | + */ |
|
| 76 | + private $cachedUserGroups = array(); |
|
| 77 | 77 | |
| 78 | - /** @var \OC\SubAdmin */ |
|
| 79 | - private $subAdmin = null; |
|
| 78 | + /** @var \OC\SubAdmin */ |
|
| 79 | + private $subAdmin = null; |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @param \OC\User\Manager $userManager |
|
| 83 | - */ |
|
| 84 | - public function __construct(\OC\User\Manager $userManager) { |
|
| 85 | - $this->userManager = $userManager; |
|
| 86 | - $cachedGroups = & $this->cachedGroups; |
|
| 87 | - $cachedUserGroups = & $this->cachedUserGroups; |
|
| 88 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | - /** |
|
| 90 | - * @var \OC\Group\Group $group |
|
| 91 | - */ |
|
| 92 | - unset($cachedGroups[$group->getGID()]); |
|
| 93 | - $cachedUserGroups = array(); |
|
| 94 | - }); |
|
| 95 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 96 | - /** |
|
| 97 | - * @var \OC\Group\Group $group |
|
| 98 | - */ |
|
| 99 | - $cachedUserGroups = array(); |
|
| 100 | - }); |
|
| 101 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 102 | - /** |
|
| 103 | - * @var \OC\Group\Group $group |
|
| 104 | - */ |
|
| 105 | - $cachedUserGroups = array(); |
|
| 106 | - }); |
|
| 107 | - } |
|
| 81 | + /** |
|
| 82 | + * @param \OC\User\Manager $userManager |
|
| 83 | + */ |
|
| 84 | + public function __construct(\OC\User\Manager $userManager) { |
|
| 85 | + $this->userManager = $userManager; |
|
| 86 | + $cachedGroups = & $this->cachedGroups; |
|
| 87 | + $cachedUserGroups = & $this->cachedUserGroups; |
|
| 88 | + $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | + /** |
|
| 90 | + * @var \OC\Group\Group $group |
|
| 91 | + */ |
|
| 92 | + unset($cachedGroups[$group->getGID()]); |
|
| 93 | + $cachedUserGroups = array(); |
|
| 94 | + }); |
|
| 95 | + $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 96 | + /** |
|
| 97 | + * @var \OC\Group\Group $group |
|
| 98 | + */ |
|
| 99 | + $cachedUserGroups = array(); |
|
| 100 | + }); |
|
| 101 | + $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 102 | + /** |
|
| 103 | + * @var \OC\Group\Group $group |
|
| 104 | + */ |
|
| 105 | + $cachedUserGroups = array(); |
|
| 106 | + }); |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Checks whether a given backend is used |
|
| 111 | - * |
|
| 112 | - * @param string $backendClass Full classname including complete namespace |
|
| 113 | - * @return bool |
|
| 114 | - */ |
|
| 115 | - public function isBackendUsed($backendClass) { |
|
| 116 | - $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
| 109 | + /** |
|
| 110 | + * Checks whether a given backend is used |
|
| 111 | + * |
|
| 112 | + * @param string $backendClass Full classname including complete namespace |
|
| 113 | + * @return bool |
|
| 114 | + */ |
|
| 115 | + public function isBackendUsed($backendClass) { |
|
| 116 | + $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
| 117 | 117 | |
| 118 | - foreach ($this->backends as $backend) { |
|
| 119 | - if (strtolower(get_class($backend)) === $backendClass) { |
|
| 120 | - return true; |
|
| 121 | - } |
|
| 122 | - } |
|
| 118 | + foreach ($this->backends as $backend) { |
|
| 119 | + if (strtolower(get_class($backend)) === $backendClass) { |
|
| 120 | + return true; |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - return false; |
|
| 125 | - } |
|
| 124 | + return false; |
|
| 125 | + } |
|
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * @param \OCP\GroupInterface $backend |
|
| 129 | - */ |
|
| 130 | - public function addBackend($backend) { |
|
| 131 | - $this->backends[] = $backend; |
|
| 132 | - $this->clearCaches(); |
|
| 133 | - } |
|
| 127 | + /** |
|
| 128 | + * @param \OCP\GroupInterface $backend |
|
| 129 | + */ |
|
| 130 | + public function addBackend($backend) { |
|
| 131 | + $this->backends[] = $backend; |
|
| 132 | + $this->clearCaches(); |
|
| 133 | + } |
|
| 134 | 134 | |
| 135 | - public function clearBackends() { |
|
| 136 | - $this->backends = array(); |
|
| 137 | - $this->clearCaches(); |
|
| 138 | - } |
|
| 135 | + public function clearBackends() { |
|
| 136 | + $this->backends = array(); |
|
| 137 | + $this->clearCaches(); |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - protected function clearCaches() { |
|
| 141 | - $this->cachedGroups = array(); |
|
| 142 | - $this->cachedUserGroups = array(); |
|
| 143 | - } |
|
| 140 | + protected function clearCaches() { |
|
| 141 | + $this->cachedGroups = array(); |
|
| 142 | + $this->cachedUserGroups = array(); |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * @param string $gid |
|
| 147 | - * @return \OC\Group\Group |
|
| 148 | - */ |
|
| 149 | - public function get($gid) { |
|
| 150 | - if (isset($this->cachedGroups[$gid])) { |
|
| 151 | - return $this->cachedGroups[$gid]; |
|
| 152 | - } |
|
| 153 | - return $this->getGroupObject($gid); |
|
| 154 | - } |
|
| 145 | + /** |
|
| 146 | + * @param string $gid |
|
| 147 | + * @return \OC\Group\Group |
|
| 148 | + */ |
|
| 149 | + public function get($gid) { |
|
| 150 | + if (isset($this->cachedGroups[$gid])) { |
|
| 151 | + return $this->cachedGroups[$gid]; |
|
| 152 | + } |
|
| 153 | + return $this->getGroupObject($gid); |
|
| 154 | + } |
|
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * @param string $gid |
|
| 158 | - * @param string $displayName |
|
| 159 | - * @return \OCP\IGroup |
|
| 160 | - */ |
|
| 161 | - protected function getGroupObject($gid, $displayName = null) { |
|
| 162 | - $backends = array(); |
|
| 163 | - foreach ($this->backends as $backend) { |
|
| 164 | - if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
| 165 | - $groupData = $backend->getGroupDetails($gid); |
|
| 166 | - if (is_array($groupData)) { |
|
| 167 | - // take the display name from the first backend that has a non-null one |
|
| 168 | - if (is_null($displayName) && isset($groupData['displayName'])) { |
|
| 169 | - $displayName = $groupData['displayName']; |
|
| 170 | - } |
|
| 171 | - $backends[] = $backend; |
|
| 172 | - } |
|
| 173 | - } else if ($backend->groupExists($gid)) { |
|
| 174 | - $backends[] = $backend; |
|
| 175 | - } |
|
| 176 | - } |
|
| 177 | - if (count($backends) === 0) { |
|
| 178 | - return null; |
|
| 179 | - } |
|
| 180 | - $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
| 181 | - return $this->cachedGroups[$gid]; |
|
| 182 | - } |
|
| 156 | + /** |
|
| 157 | + * @param string $gid |
|
| 158 | + * @param string $displayName |
|
| 159 | + * @return \OCP\IGroup |
|
| 160 | + */ |
|
| 161 | + protected function getGroupObject($gid, $displayName = null) { |
|
| 162 | + $backends = array(); |
|
| 163 | + foreach ($this->backends as $backend) { |
|
| 164 | + if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
| 165 | + $groupData = $backend->getGroupDetails($gid); |
|
| 166 | + if (is_array($groupData)) { |
|
| 167 | + // take the display name from the first backend that has a non-null one |
|
| 168 | + if (is_null($displayName) && isset($groupData['displayName'])) { |
|
| 169 | + $displayName = $groupData['displayName']; |
|
| 170 | + } |
|
| 171 | + $backends[] = $backend; |
|
| 172 | + } |
|
| 173 | + } else if ($backend->groupExists($gid)) { |
|
| 174 | + $backends[] = $backend; |
|
| 175 | + } |
|
| 176 | + } |
|
| 177 | + if (count($backends) === 0) { |
|
| 178 | + return null; |
|
| 179 | + } |
|
| 180 | + $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
| 181 | + return $this->cachedGroups[$gid]; |
|
| 182 | + } |
|
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * @param string $gid |
|
| 186 | - * @return bool |
|
| 187 | - */ |
|
| 188 | - public function groupExists($gid) { |
|
| 189 | - return !is_null($this->get($gid)); |
|
| 190 | - } |
|
| 184 | + /** |
|
| 185 | + * @param string $gid |
|
| 186 | + * @return bool |
|
| 187 | + */ |
|
| 188 | + public function groupExists($gid) { |
|
| 189 | + return !is_null($this->get($gid)); |
|
| 190 | + } |
|
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * @param string $gid |
|
| 194 | - * @return \OC\Group\Group |
|
| 195 | - */ |
|
| 196 | - public function createGroup($gid) { |
|
| 197 | - if ($gid === '' || is_null($gid)) { |
|
| 198 | - return false; |
|
| 199 | - } else if ($group = $this->get($gid)) { |
|
| 200 | - return $group; |
|
| 201 | - } else { |
|
| 202 | - $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
| 203 | - foreach ($this->backends as $backend) { |
|
| 204 | - if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
| 205 | - $backend->createGroup($gid); |
|
| 206 | - $group = $this->getGroupObject($gid); |
|
| 207 | - $this->emit('\OC\Group', 'postCreate', array($group)); |
|
| 208 | - return $group; |
|
| 209 | - } |
|
| 210 | - } |
|
| 211 | - return null; |
|
| 212 | - } |
|
| 213 | - } |
|
| 192 | + /** |
|
| 193 | + * @param string $gid |
|
| 194 | + * @return \OC\Group\Group |
|
| 195 | + */ |
|
| 196 | + public function createGroup($gid) { |
|
| 197 | + if ($gid === '' || is_null($gid)) { |
|
| 198 | + return false; |
|
| 199 | + } else if ($group = $this->get($gid)) { |
|
| 200 | + return $group; |
|
| 201 | + } else { |
|
| 202 | + $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
| 203 | + foreach ($this->backends as $backend) { |
|
| 204 | + if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
| 205 | + $backend->createGroup($gid); |
|
| 206 | + $group = $this->getGroupObject($gid); |
|
| 207 | + $this->emit('\OC\Group', 'postCreate', array($group)); |
|
| 208 | + return $group; |
|
| 209 | + } |
|
| 210 | + } |
|
| 211 | + return null; |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * @param string $search |
|
| 217 | - * @param int $limit |
|
| 218 | - * @param int $offset |
|
| 219 | - * @return \OC\Group\Group[] |
|
| 220 | - */ |
|
| 221 | - public function search($search, $limit = null, $offset = null) { |
|
| 222 | - $groups = array(); |
|
| 223 | - foreach ($this->backends as $backend) { |
|
| 224 | - $groupIds = $backend->getGroups($search, $limit, $offset); |
|
| 225 | - foreach ($groupIds as $groupId) { |
|
| 226 | - $groups[$groupId] = $this->get($groupId); |
|
| 227 | - } |
|
| 228 | - if (!is_null($limit) and $limit <= 0) { |
|
| 229 | - return array_values($groups); |
|
| 230 | - } |
|
| 231 | - } |
|
| 232 | - return array_values($groups); |
|
| 233 | - } |
|
| 215 | + /** |
|
| 216 | + * @param string $search |
|
| 217 | + * @param int $limit |
|
| 218 | + * @param int $offset |
|
| 219 | + * @return \OC\Group\Group[] |
|
| 220 | + */ |
|
| 221 | + public function search($search, $limit = null, $offset = null) { |
|
| 222 | + $groups = array(); |
|
| 223 | + foreach ($this->backends as $backend) { |
|
| 224 | + $groupIds = $backend->getGroups($search, $limit, $offset); |
|
| 225 | + foreach ($groupIds as $groupId) { |
|
| 226 | + $groups[$groupId] = $this->get($groupId); |
|
| 227 | + } |
|
| 228 | + if (!is_null($limit) and $limit <= 0) { |
|
| 229 | + return array_values($groups); |
|
| 230 | + } |
|
| 231 | + } |
|
| 232 | + return array_values($groups); |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * @param \OC\User\User|null $user |
|
| 237 | - * @return \OC\Group\Group[] |
|
| 238 | - */ |
|
| 239 | - public function getUserGroups($user) { |
|
| 240 | - if (is_null($user)) { |
|
| 241 | - return []; |
|
| 242 | - } |
|
| 243 | - return $this->getUserIdGroups($user->getUID()); |
|
| 244 | - } |
|
| 235 | + /** |
|
| 236 | + * @param \OC\User\User|null $user |
|
| 237 | + * @return \OC\Group\Group[] |
|
| 238 | + */ |
|
| 239 | + public function getUserGroups($user) { |
|
| 240 | + if (is_null($user)) { |
|
| 241 | + return []; |
|
| 242 | + } |
|
| 243 | + return $this->getUserIdGroups($user->getUID()); |
|
| 244 | + } |
|
| 245 | 245 | |
| 246 | - /** |
|
| 247 | - * @param string $uid the user id |
|
| 248 | - * @return \OC\Group\Group[] |
|
| 249 | - */ |
|
| 250 | - public function getUserIdGroups($uid) { |
|
| 251 | - if (isset($this->cachedUserGroups[$uid])) { |
|
| 252 | - return $this->cachedUserGroups[$uid]; |
|
| 253 | - } |
|
| 254 | - $groups = array(); |
|
| 255 | - foreach ($this->backends as $backend) { |
|
| 256 | - $groupIds = $backend->getUserGroups($uid); |
|
| 257 | - if (is_array($groupIds)) { |
|
| 258 | - foreach ($groupIds as $groupId) { |
|
| 259 | - $groups[$groupId] = $this->get($groupId); |
|
| 260 | - } |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - $this->cachedUserGroups[$uid] = $groups; |
|
| 264 | - return $this->cachedUserGroups[$uid]; |
|
| 265 | - } |
|
| 246 | + /** |
|
| 247 | + * @param string $uid the user id |
|
| 248 | + * @return \OC\Group\Group[] |
|
| 249 | + */ |
|
| 250 | + public function getUserIdGroups($uid) { |
|
| 251 | + if (isset($this->cachedUserGroups[$uid])) { |
|
| 252 | + return $this->cachedUserGroups[$uid]; |
|
| 253 | + } |
|
| 254 | + $groups = array(); |
|
| 255 | + foreach ($this->backends as $backend) { |
|
| 256 | + $groupIds = $backend->getUserGroups($uid); |
|
| 257 | + if (is_array($groupIds)) { |
|
| 258 | + foreach ($groupIds as $groupId) { |
|
| 259 | + $groups[$groupId] = $this->get($groupId); |
|
| 260 | + } |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + $this->cachedUserGroups[$uid] = $groups; |
|
| 264 | + return $this->cachedUserGroups[$uid]; |
|
| 265 | + } |
|
| 266 | 266 | |
| 267 | - /** |
|
| 268 | - * Checks if a userId is in the admin group |
|
| 269 | - * @param string $userId |
|
| 270 | - * @return bool if admin |
|
| 271 | - */ |
|
| 272 | - public function isAdmin($userId) { |
|
| 273 | - return $this->isInGroup($userId, 'admin'); |
|
| 274 | - } |
|
| 267 | + /** |
|
| 268 | + * Checks if a userId is in the admin group |
|
| 269 | + * @param string $userId |
|
| 270 | + * @return bool if admin |
|
| 271 | + */ |
|
| 272 | + public function isAdmin($userId) { |
|
| 273 | + return $this->isInGroup($userId, 'admin'); |
|
| 274 | + } |
|
| 275 | 275 | |
| 276 | - /** |
|
| 277 | - * Checks if a userId is in a group |
|
| 278 | - * @param string $userId |
|
| 279 | - * @param string $group |
|
| 280 | - * @return bool if in group |
|
| 281 | - */ |
|
| 282 | - public function isInGroup($userId, $group) { |
|
| 283 | - return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
| 284 | - } |
|
| 276 | + /** |
|
| 277 | + * Checks if a userId is in a group |
|
| 278 | + * @param string $userId |
|
| 279 | + * @param string $group |
|
| 280 | + * @return bool if in group |
|
| 281 | + */ |
|
| 282 | + public function isInGroup($userId, $group) { |
|
| 283 | + return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * get a list of group ids for a user |
|
| 288 | - * @param \OC\User\User $user |
|
| 289 | - * @return array with group ids |
|
| 290 | - */ |
|
| 291 | - public function getUserGroupIds($user) { |
|
| 292 | - return array_map(function($value) { |
|
| 293 | - return (string) $value; |
|
| 294 | - }, array_keys($this->getUserGroups($user))); |
|
| 295 | - } |
|
| 286 | + /** |
|
| 287 | + * get a list of group ids for a user |
|
| 288 | + * @param \OC\User\User $user |
|
| 289 | + * @return array with group ids |
|
| 290 | + */ |
|
| 291 | + public function getUserGroupIds($user) { |
|
| 292 | + return array_map(function($value) { |
|
| 293 | + return (string) $value; |
|
| 294 | + }, array_keys($this->getUserGroups($user))); |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * get a list of all display names in a group |
|
| 299 | - * @param string $gid |
|
| 300 | - * @param string $search |
|
| 301 | - * @param int $limit |
|
| 302 | - * @param int $offset |
|
| 303 | - * @return array an array of display names (value) and user ids (key) |
|
| 304 | - */ |
|
| 305 | - public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 306 | - $group = $this->get($gid); |
|
| 307 | - if(is_null($group)) { |
|
| 308 | - return array(); |
|
| 309 | - } |
|
| 297 | + /** |
|
| 298 | + * get a list of all display names in a group |
|
| 299 | + * @param string $gid |
|
| 300 | + * @param string $search |
|
| 301 | + * @param int $limit |
|
| 302 | + * @param int $offset |
|
| 303 | + * @return array an array of display names (value) and user ids (key) |
|
| 304 | + */ |
|
| 305 | + public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 306 | + $group = $this->get($gid); |
|
| 307 | + if(is_null($group)) { |
|
| 308 | + return array(); |
|
| 309 | + } |
|
| 310 | 310 | |
| 311 | - $search = trim($search); |
|
| 312 | - $groupUsers = array(); |
|
| 311 | + $search = trim($search); |
|
| 312 | + $groupUsers = array(); |
|
| 313 | 313 | |
| 314 | - if(!empty($search)) { |
|
| 315 | - // only user backends have the capability to do a complex search for users |
|
| 316 | - $searchOffset = 0; |
|
| 317 | - $searchLimit = $limit * 100; |
|
| 318 | - if($limit === -1) { |
|
| 319 | - $searchLimit = 500; |
|
| 320 | - } |
|
| 314 | + if(!empty($search)) { |
|
| 315 | + // only user backends have the capability to do a complex search for users |
|
| 316 | + $searchOffset = 0; |
|
| 317 | + $searchLimit = $limit * 100; |
|
| 318 | + if($limit === -1) { |
|
| 319 | + $searchLimit = 500; |
|
| 320 | + } |
|
| 321 | 321 | |
| 322 | - do { |
|
| 323 | - $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
| 324 | - foreach($filteredUsers as $filteredUser) { |
|
| 325 | - if($group->inGroup($filteredUser)) { |
|
| 326 | - $groupUsers[]= $filteredUser; |
|
| 327 | - } |
|
| 328 | - } |
|
| 329 | - $searchOffset += $searchLimit; |
|
| 330 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 322 | + do { |
|
| 323 | + $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
| 324 | + foreach($filteredUsers as $filteredUser) { |
|
| 325 | + if($group->inGroup($filteredUser)) { |
|
| 326 | + $groupUsers[]= $filteredUser; |
|
| 327 | + } |
|
| 328 | + } |
|
| 329 | + $searchOffset += $searchLimit; |
|
| 330 | + } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 331 | 331 | |
| 332 | - if($limit === -1) { |
|
| 333 | - $groupUsers = array_slice($groupUsers, $offset); |
|
| 334 | - } else { |
|
| 335 | - $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
| 336 | - } |
|
| 337 | - } else { |
|
| 338 | - $groupUsers = $group->searchUsers('', $limit, $offset); |
|
| 339 | - } |
|
| 332 | + if($limit === -1) { |
|
| 333 | + $groupUsers = array_slice($groupUsers, $offset); |
|
| 334 | + } else { |
|
| 335 | + $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
| 336 | + } |
|
| 337 | + } else { |
|
| 338 | + $groupUsers = $group->searchUsers('', $limit, $offset); |
|
| 339 | + } |
|
| 340 | 340 | |
| 341 | - $matchingUsers = array(); |
|
| 342 | - foreach($groupUsers as $groupUser) { |
|
| 343 | - $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
| 344 | - } |
|
| 345 | - return $matchingUsers; |
|
| 346 | - } |
|
| 341 | + $matchingUsers = array(); |
|
| 342 | + foreach($groupUsers as $groupUser) { |
|
| 343 | + $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
| 344 | + } |
|
| 345 | + return $matchingUsers; |
|
| 346 | + } |
|
| 347 | 347 | |
| 348 | - /** |
|
| 349 | - * @return \OC\SubAdmin |
|
| 350 | - */ |
|
| 351 | - public function getSubAdmin() { |
|
| 352 | - if (!$this->subAdmin) { |
|
| 353 | - $this->subAdmin = new \OC\SubAdmin( |
|
| 354 | - $this->userManager, |
|
| 355 | - $this, |
|
| 356 | - \OC::$server->getDatabaseConnection() |
|
| 357 | - ); |
|
| 358 | - } |
|
| 348 | + /** |
|
| 349 | + * @return \OC\SubAdmin |
|
| 350 | + */ |
|
| 351 | + public function getSubAdmin() { |
|
| 352 | + if (!$this->subAdmin) { |
|
| 353 | + $this->subAdmin = new \OC\SubAdmin( |
|
| 354 | + $this->userManager, |
|
| 355 | + $this, |
|
| 356 | + \OC::$server->getDatabaseConnection() |
|
| 357 | + ); |
|
| 358 | + } |
|
| 359 | 359 | |
| 360 | - return $this->subAdmin; |
|
| 361 | - } |
|
| 360 | + return $this->subAdmin; |
|
| 361 | + } |
|
| 362 | 362 | } |
@@ -85,20 +85,20 @@ discard block |
||
| 85 | 85 | $this->userManager = $userManager; |
| 86 | 86 | $cachedGroups = & $this->cachedGroups; |
| 87 | 87 | $cachedUserGroups = & $this->cachedUserGroups; |
| 88 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 88 | + $this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | 89 | /** |
| 90 | 90 | * @var \OC\Group\Group $group |
| 91 | 91 | */ |
| 92 | 92 | unset($cachedGroups[$group->getGID()]); |
| 93 | 93 | $cachedUserGroups = array(); |
| 94 | 94 | }); |
| 95 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 95 | + $this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) { |
|
| 96 | 96 | /** |
| 97 | 97 | * @var \OC\Group\Group $group |
| 98 | 98 | */ |
| 99 | 99 | $cachedUserGroups = array(); |
| 100 | 100 | }); |
| 101 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 101 | + $this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) { |
|
| 102 | 102 | /** |
| 103 | 103 | * @var \OC\Group\Group $group |
| 104 | 104 | */ |
@@ -304,32 +304,32 @@ discard block |
||
| 304 | 304 | */ |
| 305 | 305 | public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
| 306 | 306 | $group = $this->get($gid); |
| 307 | - if(is_null($group)) { |
|
| 307 | + if (is_null($group)) { |
|
| 308 | 308 | return array(); |
| 309 | 309 | } |
| 310 | 310 | |
| 311 | 311 | $search = trim($search); |
| 312 | 312 | $groupUsers = array(); |
| 313 | 313 | |
| 314 | - if(!empty($search)) { |
|
| 314 | + if (!empty($search)) { |
|
| 315 | 315 | // only user backends have the capability to do a complex search for users |
| 316 | 316 | $searchOffset = 0; |
| 317 | 317 | $searchLimit = $limit * 100; |
| 318 | - if($limit === -1) { |
|
| 318 | + if ($limit === -1) { |
|
| 319 | 319 | $searchLimit = 500; |
| 320 | 320 | } |
| 321 | 321 | |
| 322 | 322 | do { |
| 323 | 323 | $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
| 324 | - foreach($filteredUsers as $filteredUser) { |
|
| 325 | - if($group->inGroup($filteredUser)) { |
|
| 326 | - $groupUsers[]= $filteredUser; |
|
| 324 | + foreach ($filteredUsers as $filteredUser) { |
|
| 325 | + if ($group->inGroup($filteredUser)) { |
|
| 326 | + $groupUsers[] = $filteredUser; |
|
| 327 | 327 | } |
| 328 | 328 | } |
| 329 | 329 | $searchOffset += $searchLimit; |
| 330 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 330 | + } while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit); |
|
| 331 | 331 | |
| 332 | - if($limit === -1) { |
|
| 332 | + if ($limit === -1) { |
|
| 333 | 333 | $groupUsers = array_slice($groupUsers, $offset); |
| 334 | 334 | } else { |
| 335 | 335 | $groupUsers = array_slice($groupUsers, $offset, $limit); |
@@ -339,7 +339,7 @@ discard block |
||
| 339 | 339 | } |
| 340 | 340 | |
| 341 | 341 | $matchingUsers = array(); |
| 342 | - foreach($groupUsers as $groupUser) { |
|
| 342 | + foreach ($groupUsers as $groupUser) { |
|
| 343 | 343 | $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
| 344 | 344 | } |
| 345 | 345 | return $matchingUsers; |
@@ -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 | } |