@@ -32,62 +32,62 @@ |
||
32 | 32 | |
33 | 33 | class SQLiteMigrator extends Migrator { |
34 | 34 | |
35 | - /** |
|
36 | - * @param \Doctrine\DBAL\Schema\Schema $targetSchema |
|
37 | - * @throws \OC\DB\MigrationException |
|
38 | - * |
|
39 | - * For sqlite we simple make a copy of the entire database, and test the migration on that |
|
40 | - */ |
|
41 | - public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) { |
|
42 | - $dbFile = $this->connection->getDatabase(); |
|
43 | - $tmpFile = $this->buildTempDatabase(); |
|
44 | - copy($dbFile, $tmpFile); |
|
35 | + /** |
|
36 | + * @param \Doctrine\DBAL\Schema\Schema $targetSchema |
|
37 | + * @throws \OC\DB\MigrationException |
|
38 | + * |
|
39 | + * For sqlite we simple make a copy of the entire database, and test the migration on that |
|
40 | + */ |
|
41 | + public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) { |
|
42 | + $dbFile = $this->connection->getDatabase(); |
|
43 | + $tmpFile = $this->buildTempDatabase(); |
|
44 | + copy($dbFile, $tmpFile); |
|
45 | 45 | |
46 | - $connectionParams = array( |
|
47 | - 'path' => $tmpFile, |
|
48 | - 'driver' => 'pdo_sqlite', |
|
49 | - ); |
|
50 | - $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams); |
|
51 | - try { |
|
52 | - $this->applySchema($targetSchema, $conn); |
|
53 | - $conn->close(); |
|
54 | - unlink($tmpFile); |
|
55 | - } catch (DBALException $e) { |
|
56 | - $conn->close(); |
|
57 | - unlink($tmpFile); |
|
58 | - throw new MigrationException('', $e->getMessage()); |
|
59 | - } |
|
60 | - } |
|
46 | + $connectionParams = array( |
|
47 | + 'path' => $tmpFile, |
|
48 | + 'driver' => 'pdo_sqlite', |
|
49 | + ); |
|
50 | + $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams); |
|
51 | + try { |
|
52 | + $this->applySchema($targetSchema, $conn); |
|
53 | + $conn->close(); |
|
54 | + unlink($tmpFile); |
|
55 | + } catch (DBALException $e) { |
|
56 | + $conn->close(); |
|
57 | + unlink($tmpFile); |
|
58 | + throw new MigrationException('', $e->getMessage()); |
|
59 | + } |
|
60 | + } |
|
61 | 61 | |
62 | - /** |
|
63 | - * @return string |
|
64 | - */ |
|
65 | - private function buildTempDatabase() { |
|
66 | - $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
67 | - $tmpFile = uniqid("oc_"); |
|
68 | - return "$dataDir/$tmpFile.db"; |
|
69 | - } |
|
62 | + /** |
|
63 | + * @return string |
|
64 | + */ |
|
65 | + private function buildTempDatabase() { |
|
66 | + $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
67 | + $tmpFile = uniqid("oc_"); |
|
68 | + return "$dataDir/$tmpFile.db"; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * @param Schema $targetSchema |
|
73 | - * @param \Doctrine\DBAL\Connection $connection |
|
74 | - * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
75 | - */ |
|
76 | - protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
77 | - $platform = $connection->getDatabasePlatform(); |
|
78 | - $platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer'); |
|
79 | - $platform->registerDoctrineTypeMapping('smallint unsigned', 'integer'); |
|
80 | - $platform->registerDoctrineTypeMapping('varchar ', 'string'); |
|
71 | + /** |
|
72 | + * @param Schema $targetSchema |
|
73 | + * @param \Doctrine\DBAL\Connection $connection |
|
74 | + * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
75 | + */ |
|
76 | + protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
77 | + $platform = $connection->getDatabasePlatform(); |
|
78 | + $platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer'); |
|
79 | + $platform->registerDoctrineTypeMapping('smallint unsigned', 'integer'); |
|
80 | + $platform->registerDoctrineTypeMapping('varchar ', 'string'); |
|
81 | 81 | |
82 | - // with sqlite autoincrement columns is of type integer |
|
83 | - foreach ($targetSchema->getTables() as $table) { |
|
84 | - foreach ($table->getColumns() as $column) { |
|
85 | - if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) { |
|
86 | - $column->setType(Type::getType('integer')); |
|
87 | - } |
|
88 | - } |
|
89 | - } |
|
82 | + // with sqlite autoincrement columns is of type integer |
|
83 | + foreach ($targetSchema->getTables() as $table) { |
|
84 | + foreach ($table->getColumns() as $column) { |
|
85 | + if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) { |
|
86 | + $column->setType(Type::getType('integer')); |
|
87 | + } |
|
88 | + } |
|
89 | + } |
|
90 | 90 | |
91 | - return parent::getDiff($targetSchema, $connection); |
|
92 | - } |
|
91 | + return parent::getDiff($targetSchema, $connection); |
|
92 | + } |
|
93 | 93 | } |
@@ -63,7 +63,7 @@ |
||
63 | 63 | * @return string |
64 | 64 | */ |
65 | 65 | private function buildTempDatabase() { |
66 | - $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
66 | + $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT.'/data'); |
|
67 | 67 | $tmpFile = uniqid("oc_"); |
68 | 68 | return "$dataDir/$tmpFile.db"; |
69 | 69 | } |
@@ -22,31 +22,31 @@ |
||
22 | 22 | namespace OC\App\AppStore\Version; |
23 | 23 | |
24 | 24 | class Version { |
25 | - /** @var string */ |
|
26 | - private $minVersion; |
|
27 | - /** @var string */ |
|
28 | - private $maxVersion; |
|
25 | + /** @var string */ |
|
26 | + private $minVersion; |
|
27 | + /** @var string */ |
|
28 | + private $maxVersion; |
|
29 | 29 | |
30 | - /** |
|
31 | - * @param string $minVersion |
|
32 | - * @param string $maxVersion |
|
33 | - */ |
|
34 | - public function __construct($minVersion, $maxVersion) { |
|
35 | - $this->minVersion = $minVersion; |
|
36 | - $this->maxVersion = $maxVersion; |
|
37 | - } |
|
30 | + /** |
|
31 | + * @param string $minVersion |
|
32 | + * @param string $maxVersion |
|
33 | + */ |
|
34 | + public function __construct($minVersion, $maxVersion) { |
|
35 | + $this->minVersion = $minVersion; |
|
36 | + $this->maxVersion = $maxVersion; |
|
37 | + } |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - */ |
|
42 | - public function getMinimumVersion() { |
|
43 | - return $this->minVersion; |
|
44 | - } |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + */ |
|
42 | + public function getMinimumVersion() { |
|
43 | + return $this->minVersion; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return string |
|
48 | - */ |
|
49 | - public function getMaximumVersion() { |
|
50 | - return $this->maxVersion; |
|
51 | - } |
|
46 | + /** |
|
47 | + * @return string |
|
48 | + */ |
|
49 | + public function getMaximumVersion() { |
|
50 | + return $this->maxVersion; |
|
51 | + } |
|
52 | 52 | } |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | |
103 | 103 | public function enterNode(Node $node) { |
104 | 104 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
105 | - $this->errors[]= [ |
|
105 | + $this->errors[] = [ |
|
106 | 106 | 'disallowedToken' => '==', |
107 | 107 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
108 | 108 | 'line' => $node->getLine(), |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | ]; |
111 | 111 | } |
112 | 112 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
113 | - $this->errors[]= [ |
|
113 | + $this->errors[] = [ |
|
114 | 114 | 'disallowedToken' => '!=', |
115 | 115 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
116 | 116 | 'line' => $node->getLine(), |
@@ -214,28 +214,28 @@ discard block |
||
214 | 214 | $alias = strtolower($alias); |
215 | 215 | |
216 | 216 | foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
217 | + if (strpos($blackListedClassName, $name.'\\') === 0) { |
|
218 | 218 | $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
219 | 219 | $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
220 | 220 | } |
221 | 221 | } |
222 | 222 | |
223 | 223 | foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
224 | + if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) { |
|
225 | 225 | $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
226 | 226 | $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
227 | 227 | } |
228 | 228 | } |
229 | 229 | |
230 | 230 | foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
231 | + if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) { |
|
232 | 232 | $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
233 | 233 | $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
234 | 234 | } |
235 | 235 | } |
236 | 236 | |
237 | 237 | foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
238 | + if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) { |
|
239 | 239 | $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
240 | 240 | $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
241 | 241 | } |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | $lowerName = strtolower($name); |
247 | 247 | |
248 | 248 | if (isset($this->blackListedClassNames[$lowerName])) { |
249 | - $this->errors[]= [ |
|
249 | + $this->errors[] = [ |
|
250 | 250 | 'disallowedToken' => $name, |
251 | 251 | 'errorCode' => $errorCode, |
252 | 252 | 'line' => $node->getLine(), |
@@ -256,11 +256,11 @@ discard block |
||
256 | 256 | } |
257 | 257 | |
258 | 258 | private function checkBlackListConstant($class, $constantName, Node $node) { |
259 | - $name = $class . '::' . $constantName; |
|
259 | + $name = $class.'::'.$constantName; |
|
260 | 260 | $lowerName = strtolower($name); |
261 | 261 | |
262 | 262 | if (isset($this->blackListedConstants[$lowerName])) { |
263 | - $this->errors[]= [ |
|
263 | + $this->errors[] = [ |
|
264 | 264 | 'disallowedToken' => $name, |
265 | 265 | 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
266 | 266 | 'line' => $node->getLine(), |
@@ -270,11 +270,11 @@ discard block |
||
270 | 270 | } |
271 | 271 | |
272 | 272 | private function checkBlackListFunction($class, $functionName, Node $node) { |
273 | - $name = $class . '::' . $functionName; |
|
273 | + $name = $class.'::'.$functionName; |
|
274 | 274 | $lowerName = strtolower($name); |
275 | 275 | |
276 | 276 | if (isset($this->blackListedFunctions[$lowerName])) { |
277 | - $this->errors[]= [ |
|
277 | + $this->errors[] = [ |
|
278 | 278 | 'disallowedToken' => $name, |
279 | 279 | 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
280 | 280 | 'line' => $node->getLine(), |
@@ -284,11 +284,11 @@ discard block |
||
284 | 284 | } |
285 | 285 | |
286 | 286 | private function checkBlackListMethod($class, $functionName, Node $node) { |
287 | - $name = $class . '::' . $functionName; |
|
287 | + $name = $class.'::'.$functionName; |
|
288 | 288 | $lowerName = strtolower($name); |
289 | 289 | |
290 | 290 | if (isset($this->blackListedMethods[$lowerName])) { |
291 | - $this->errors[]= [ |
|
291 | + $this->errors[] = [ |
|
292 | 292 | 'disallowedToken' => $name, |
293 | 293 | 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
294 | 294 | 'line' => $node->getLine(), |
@@ -29,280 +29,280 @@ |
||
29 | 29 | use PhpParser\NodeVisitorAbstract; |
30 | 30 | |
31 | 31 | class NodeVisitor extends NodeVisitorAbstract { |
32 | - /** @var ICheck */ |
|
33 | - protected $list; |
|
34 | - |
|
35 | - /** @var string */ |
|
36 | - protected $blackListDescription; |
|
37 | - /** @var string[] */ |
|
38 | - protected $blackListedClassNames; |
|
39 | - /** @var string[] */ |
|
40 | - protected $blackListedConstants; |
|
41 | - /** @var string[] */ |
|
42 | - protected $blackListedFunctions; |
|
43 | - /** @var string[] */ |
|
44 | - protected $blackListedMethods; |
|
45 | - /** @var bool */ |
|
46 | - protected $checkEqualOperatorUsage; |
|
47 | - /** @var string[] */ |
|
48 | - protected $errorMessages; |
|
49 | - |
|
50 | - /** |
|
51 | - * @param ICheck $list |
|
52 | - */ |
|
53 | - public function __construct(ICheck $list) { |
|
54 | - $this->list = $list; |
|
55 | - |
|
56 | - $this->blackListedClassNames = []; |
|
57 | - foreach ($list->getClasses() as $class => $blackListInfo) { |
|
58 | - if (is_numeric($class) && is_string($blackListInfo)) { |
|
59 | - $class = $blackListInfo; |
|
60 | - $blackListInfo = null; |
|
61 | - } |
|
62 | - |
|
63 | - $class = strtolower($class); |
|
64 | - $this->blackListedClassNames[$class] = $class; |
|
65 | - } |
|
66 | - |
|
67 | - $this->blackListedConstants = []; |
|
68 | - foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
69 | - $constantName = strtolower($constantName); |
|
70 | - $this->blackListedConstants[$constantName] = $constantName; |
|
71 | - } |
|
72 | - |
|
73 | - $this->blackListedFunctions = []; |
|
74 | - foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
75 | - $functionName = strtolower($functionName); |
|
76 | - $this->blackListedFunctions[$functionName] = $functionName; |
|
77 | - } |
|
78 | - |
|
79 | - $this->blackListedMethods = []; |
|
80 | - foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
81 | - $functionName = strtolower($functionName); |
|
82 | - $this->blackListedMethods[$functionName] = $functionName; |
|
83 | - } |
|
84 | - |
|
85 | - $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
86 | - |
|
87 | - $this->errorMessages = [ |
|
88 | - CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
89 | - CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
90 | - CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
91 | - CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
92 | - CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
93 | - CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
94 | - CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
95 | - |
|
96 | - CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
97 | - ]; |
|
98 | - } |
|
99 | - |
|
100 | - /** @var array */ |
|
101 | - public $errors = []; |
|
102 | - |
|
103 | - public function enterNode(Node $node) { |
|
104 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
105 | - $this->errors[]= [ |
|
106 | - 'disallowedToken' => '==', |
|
107 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
108 | - 'line' => $node->getLine(), |
|
109 | - 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
110 | - ]; |
|
111 | - } |
|
112 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
113 | - $this->errors[]= [ |
|
114 | - 'disallowedToken' => '!=', |
|
115 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
116 | - 'line' => $node->getLine(), |
|
117 | - 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
118 | - ]; |
|
119 | - } |
|
120 | - if ($node instanceof Node\Stmt\Class_) { |
|
121 | - if (!is_null($node->extends)) { |
|
122 | - $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
123 | - } |
|
124 | - foreach ($node->implements as $implements) { |
|
125 | - $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
126 | - } |
|
127 | - } |
|
128 | - if ($node instanceof Node\Expr\StaticCall) { |
|
129 | - if (!is_null($node->class)) { |
|
130 | - if ($node->class instanceof Name) { |
|
131 | - $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
132 | - |
|
133 | - $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
134 | - $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
135 | - } |
|
136 | - |
|
137 | - if ($node->class instanceof Node\Expr\Variable) { |
|
138 | - /** |
|
139 | - * TODO: find a way to detect something like this: |
|
140 | - * $c = "OC_API"; |
|
141 | - * $n = $c::call(); |
|
142 | - */ |
|
143 | - // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
144 | - } |
|
145 | - } |
|
146 | - } |
|
147 | - if ($node instanceof Node\Expr\MethodCall) { |
|
148 | - if (!is_null($node->var)) { |
|
149 | - if ($node->var instanceof Node\Expr\Variable) { |
|
150 | - /** |
|
151 | - * TODO: find a way to detect something like this: |
|
152 | - * $c = new OC_API(); |
|
153 | - * $n = $c::call(); |
|
154 | - * $n = $c->call(); |
|
155 | - */ |
|
156 | - // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
157 | - } |
|
158 | - } |
|
159 | - } |
|
160 | - if ($node instanceof Node\Expr\ClassConstFetch) { |
|
161 | - if (!is_null($node->class)) { |
|
162 | - if ($node->class instanceof Name) { |
|
163 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
164 | - } |
|
165 | - if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) { |
|
166 | - /** |
|
167 | - * TODO: find a way to detect something like this: |
|
168 | - * $c = "OC_API"; |
|
169 | - * $n = $i::ADMIN_AUTH; |
|
170 | - */ |
|
171 | - } else { |
|
172 | - $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
173 | - } |
|
174 | - } |
|
175 | - } |
|
176 | - if ($node instanceof Node\Expr\New_) { |
|
177 | - if (!is_null($node->class)) { |
|
178 | - if ($node->class instanceof Name) { |
|
179 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
180 | - } |
|
181 | - if ($node->class instanceof Node\Expr\Variable) { |
|
182 | - /** |
|
183 | - * TODO: find a way to detect something like this: |
|
184 | - * $c = "OC_API"; |
|
185 | - * $n = new $i; |
|
186 | - */ |
|
187 | - } |
|
188 | - } |
|
189 | - } |
|
190 | - if ($node instanceof Node\Stmt\UseUse) { |
|
191 | - $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
192 | - if ($node->alias) { |
|
193 | - $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
194 | - } else { |
|
195 | - $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
196 | - } |
|
197 | - } |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * Check whether an alias was introduced for a namespace of a blacklisted class |
|
202 | - * |
|
203 | - * Example: |
|
204 | - * - Blacklist entry: OCP\AppFramework\IApi |
|
205 | - * - Name: OCP\AppFramework |
|
206 | - * - Alias: OAF |
|
207 | - * => new blacklist entry: OAF\IApi |
|
208 | - * |
|
209 | - * @param string $name |
|
210 | - * @param string $alias |
|
211 | - */ |
|
212 | - private function addUseNameToBlackList($name, $alias) { |
|
213 | - $name = strtolower($name); |
|
214 | - $alias = strtolower($alias); |
|
215 | - |
|
216 | - foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
218 | - $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
219 | - $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
225 | - $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
226 | - $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
227 | - } |
|
228 | - } |
|
229 | - |
|
230 | - foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
232 | - $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
233 | - $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
234 | - } |
|
235 | - } |
|
236 | - |
|
237 | - foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
239 | - $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
240 | - $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
241 | - } |
|
242 | - } |
|
243 | - } |
|
244 | - |
|
245 | - private function checkBlackList($name, $errorCode, Node $node) { |
|
246 | - $lowerName = strtolower($name); |
|
247 | - |
|
248 | - if (isset($this->blackListedClassNames[$lowerName])) { |
|
249 | - $this->errors[]= [ |
|
250 | - 'disallowedToken' => $name, |
|
251 | - 'errorCode' => $errorCode, |
|
252 | - 'line' => $node->getLine(), |
|
253 | - 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
254 | - ]; |
|
255 | - } |
|
256 | - } |
|
257 | - |
|
258 | - private function checkBlackListConstant($class, $constantName, Node $node) { |
|
259 | - $name = $class . '::' . $constantName; |
|
260 | - $lowerName = strtolower($name); |
|
261 | - |
|
262 | - if (isset($this->blackListedConstants[$lowerName])) { |
|
263 | - $this->errors[]= [ |
|
264 | - 'disallowedToken' => $name, |
|
265 | - 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
266 | - 'line' => $node->getLine(), |
|
267 | - 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
268 | - ]; |
|
269 | - } |
|
270 | - } |
|
271 | - |
|
272 | - private function checkBlackListFunction($class, $functionName, Node $node) { |
|
273 | - $name = $class . '::' . $functionName; |
|
274 | - $lowerName = strtolower($name); |
|
275 | - |
|
276 | - if (isset($this->blackListedFunctions[$lowerName])) { |
|
277 | - $this->errors[]= [ |
|
278 | - 'disallowedToken' => $name, |
|
279 | - 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
280 | - 'line' => $node->getLine(), |
|
281 | - 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
282 | - ]; |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - private function checkBlackListMethod($class, $functionName, Node $node) { |
|
287 | - $name = $class . '::' . $functionName; |
|
288 | - $lowerName = strtolower($name); |
|
289 | - |
|
290 | - if (isset($this->blackListedMethods[$lowerName])) { |
|
291 | - $this->errors[]= [ |
|
292 | - 'disallowedToken' => $name, |
|
293 | - 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
294 | - 'line' => $node->getLine(), |
|
295 | - 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
296 | - ]; |
|
297 | - } |
|
298 | - } |
|
299 | - |
|
300 | - private function buildReason($name, $errorCode) { |
|
301 | - if (isset($this->errorMessages[$errorCode])) { |
|
302 | - $desc = $this->list->getDescription($errorCode, $name); |
|
303 | - return sprintf($this->errorMessages[$errorCode], $desc); |
|
304 | - } |
|
305 | - |
|
306 | - return "$name usage not allowed - error: $errorCode"; |
|
307 | - } |
|
32 | + /** @var ICheck */ |
|
33 | + protected $list; |
|
34 | + |
|
35 | + /** @var string */ |
|
36 | + protected $blackListDescription; |
|
37 | + /** @var string[] */ |
|
38 | + protected $blackListedClassNames; |
|
39 | + /** @var string[] */ |
|
40 | + protected $blackListedConstants; |
|
41 | + /** @var string[] */ |
|
42 | + protected $blackListedFunctions; |
|
43 | + /** @var string[] */ |
|
44 | + protected $blackListedMethods; |
|
45 | + /** @var bool */ |
|
46 | + protected $checkEqualOperatorUsage; |
|
47 | + /** @var string[] */ |
|
48 | + protected $errorMessages; |
|
49 | + |
|
50 | + /** |
|
51 | + * @param ICheck $list |
|
52 | + */ |
|
53 | + public function __construct(ICheck $list) { |
|
54 | + $this->list = $list; |
|
55 | + |
|
56 | + $this->blackListedClassNames = []; |
|
57 | + foreach ($list->getClasses() as $class => $blackListInfo) { |
|
58 | + if (is_numeric($class) && is_string($blackListInfo)) { |
|
59 | + $class = $blackListInfo; |
|
60 | + $blackListInfo = null; |
|
61 | + } |
|
62 | + |
|
63 | + $class = strtolower($class); |
|
64 | + $this->blackListedClassNames[$class] = $class; |
|
65 | + } |
|
66 | + |
|
67 | + $this->blackListedConstants = []; |
|
68 | + foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
69 | + $constantName = strtolower($constantName); |
|
70 | + $this->blackListedConstants[$constantName] = $constantName; |
|
71 | + } |
|
72 | + |
|
73 | + $this->blackListedFunctions = []; |
|
74 | + foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
75 | + $functionName = strtolower($functionName); |
|
76 | + $this->blackListedFunctions[$functionName] = $functionName; |
|
77 | + } |
|
78 | + |
|
79 | + $this->blackListedMethods = []; |
|
80 | + foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
81 | + $functionName = strtolower($functionName); |
|
82 | + $this->blackListedMethods[$functionName] = $functionName; |
|
83 | + } |
|
84 | + |
|
85 | + $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
86 | + |
|
87 | + $this->errorMessages = [ |
|
88 | + CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
89 | + CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
90 | + CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
91 | + CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
92 | + CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
93 | + CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
94 | + CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
95 | + |
|
96 | + CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
97 | + ]; |
|
98 | + } |
|
99 | + |
|
100 | + /** @var array */ |
|
101 | + public $errors = []; |
|
102 | + |
|
103 | + public function enterNode(Node $node) { |
|
104 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
105 | + $this->errors[]= [ |
|
106 | + 'disallowedToken' => '==', |
|
107 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
108 | + 'line' => $node->getLine(), |
|
109 | + 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
110 | + ]; |
|
111 | + } |
|
112 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
113 | + $this->errors[]= [ |
|
114 | + 'disallowedToken' => '!=', |
|
115 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
116 | + 'line' => $node->getLine(), |
|
117 | + 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
118 | + ]; |
|
119 | + } |
|
120 | + if ($node instanceof Node\Stmt\Class_) { |
|
121 | + if (!is_null($node->extends)) { |
|
122 | + $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
123 | + } |
|
124 | + foreach ($node->implements as $implements) { |
|
125 | + $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
126 | + } |
|
127 | + } |
|
128 | + if ($node instanceof Node\Expr\StaticCall) { |
|
129 | + if (!is_null($node->class)) { |
|
130 | + if ($node->class instanceof Name) { |
|
131 | + $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
132 | + |
|
133 | + $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
134 | + $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
135 | + } |
|
136 | + |
|
137 | + if ($node->class instanceof Node\Expr\Variable) { |
|
138 | + /** |
|
139 | + * TODO: find a way to detect something like this: |
|
140 | + * $c = "OC_API"; |
|
141 | + * $n = $c::call(); |
|
142 | + */ |
|
143 | + // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
144 | + } |
|
145 | + } |
|
146 | + } |
|
147 | + if ($node instanceof Node\Expr\MethodCall) { |
|
148 | + if (!is_null($node->var)) { |
|
149 | + if ($node->var instanceof Node\Expr\Variable) { |
|
150 | + /** |
|
151 | + * TODO: find a way to detect something like this: |
|
152 | + * $c = new OC_API(); |
|
153 | + * $n = $c::call(); |
|
154 | + * $n = $c->call(); |
|
155 | + */ |
|
156 | + // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
157 | + } |
|
158 | + } |
|
159 | + } |
|
160 | + if ($node instanceof Node\Expr\ClassConstFetch) { |
|
161 | + if (!is_null($node->class)) { |
|
162 | + if ($node->class instanceof Name) { |
|
163 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
164 | + } |
|
165 | + if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) { |
|
166 | + /** |
|
167 | + * TODO: find a way to detect something like this: |
|
168 | + * $c = "OC_API"; |
|
169 | + * $n = $i::ADMIN_AUTH; |
|
170 | + */ |
|
171 | + } else { |
|
172 | + $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
173 | + } |
|
174 | + } |
|
175 | + } |
|
176 | + if ($node instanceof Node\Expr\New_) { |
|
177 | + if (!is_null($node->class)) { |
|
178 | + if ($node->class instanceof Name) { |
|
179 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
180 | + } |
|
181 | + if ($node->class instanceof Node\Expr\Variable) { |
|
182 | + /** |
|
183 | + * TODO: find a way to detect something like this: |
|
184 | + * $c = "OC_API"; |
|
185 | + * $n = new $i; |
|
186 | + */ |
|
187 | + } |
|
188 | + } |
|
189 | + } |
|
190 | + if ($node instanceof Node\Stmt\UseUse) { |
|
191 | + $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
192 | + if ($node->alias) { |
|
193 | + $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
194 | + } else { |
|
195 | + $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
196 | + } |
|
197 | + } |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * Check whether an alias was introduced for a namespace of a blacklisted class |
|
202 | + * |
|
203 | + * Example: |
|
204 | + * - Blacklist entry: OCP\AppFramework\IApi |
|
205 | + * - Name: OCP\AppFramework |
|
206 | + * - Alias: OAF |
|
207 | + * => new blacklist entry: OAF\IApi |
|
208 | + * |
|
209 | + * @param string $name |
|
210 | + * @param string $alias |
|
211 | + */ |
|
212 | + private function addUseNameToBlackList($name, $alias) { |
|
213 | + $name = strtolower($name); |
|
214 | + $alias = strtolower($alias); |
|
215 | + |
|
216 | + foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
217 | + if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
218 | + $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
219 | + $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
224 | + if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
225 | + $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
226 | + $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
227 | + } |
|
228 | + } |
|
229 | + |
|
230 | + foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
231 | + if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
232 | + $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
233 | + $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
234 | + } |
|
235 | + } |
|
236 | + |
|
237 | + foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
238 | + if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
239 | + $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
240 | + $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
241 | + } |
|
242 | + } |
|
243 | + } |
|
244 | + |
|
245 | + private function checkBlackList($name, $errorCode, Node $node) { |
|
246 | + $lowerName = strtolower($name); |
|
247 | + |
|
248 | + if (isset($this->blackListedClassNames[$lowerName])) { |
|
249 | + $this->errors[]= [ |
|
250 | + 'disallowedToken' => $name, |
|
251 | + 'errorCode' => $errorCode, |
|
252 | + 'line' => $node->getLine(), |
|
253 | + 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
254 | + ]; |
|
255 | + } |
|
256 | + } |
|
257 | + |
|
258 | + private function checkBlackListConstant($class, $constantName, Node $node) { |
|
259 | + $name = $class . '::' . $constantName; |
|
260 | + $lowerName = strtolower($name); |
|
261 | + |
|
262 | + if (isset($this->blackListedConstants[$lowerName])) { |
|
263 | + $this->errors[]= [ |
|
264 | + 'disallowedToken' => $name, |
|
265 | + 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
266 | + 'line' => $node->getLine(), |
|
267 | + 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
268 | + ]; |
|
269 | + } |
|
270 | + } |
|
271 | + |
|
272 | + private function checkBlackListFunction($class, $functionName, Node $node) { |
|
273 | + $name = $class . '::' . $functionName; |
|
274 | + $lowerName = strtolower($name); |
|
275 | + |
|
276 | + if (isset($this->blackListedFunctions[$lowerName])) { |
|
277 | + $this->errors[]= [ |
|
278 | + 'disallowedToken' => $name, |
|
279 | + 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
280 | + 'line' => $node->getLine(), |
|
281 | + 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
282 | + ]; |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + private function checkBlackListMethod($class, $functionName, Node $node) { |
|
287 | + $name = $class . '::' . $functionName; |
|
288 | + $lowerName = strtolower($name); |
|
289 | + |
|
290 | + if (isset($this->blackListedMethods[$lowerName])) { |
|
291 | + $this->errors[]= [ |
|
292 | + 'disallowedToken' => $name, |
|
293 | + 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
294 | + 'line' => $node->getLine(), |
|
295 | + 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
296 | + ]; |
|
297 | + } |
|
298 | + } |
|
299 | + |
|
300 | + private function buildReason($name, $errorCode) { |
|
301 | + if (isset($this->errorMessages[$errorCode])) { |
|
302 | + $desc = $this->list->getDescription($errorCode, $name); |
|
303 | + return sprintf($this->errorMessages[$errorCode], $desc); |
|
304 | + } |
|
305 | + |
|
306 | + return "$name usage not allowed - error: $errorCode"; |
|
307 | + } |
|
308 | 308 | } |
@@ -23,118 +23,118 @@ |
||
23 | 23 | namespace OC\App\CodeChecker; |
24 | 24 | |
25 | 25 | abstract class AbstractCheck implements ICheck { |
26 | - /** @var ICheck */ |
|
27 | - protected $check; |
|
28 | - |
|
29 | - /** |
|
30 | - * @param ICheck $check |
|
31 | - */ |
|
32 | - public function __construct(ICheck $check) { |
|
33 | - $this->check = $check; |
|
34 | - } |
|
35 | - |
|
36 | - /** |
|
37 | - * @param int $errorCode |
|
38 | - * @param string $errorObject |
|
39 | - * @return string |
|
40 | - */ |
|
41 | - public function getDescription($errorCode, $errorObject) { |
|
42 | - switch ($errorCode) { |
|
43 | - case CodeChecker::STATIC_CALL_NOT_ALLOWED: |
|
44 | - $functions = $this->getLocalFunctions(); |
|
45 | - $functions = array_change_key_case($functions, CASE_LOWER); |
|
46 | - if (isset($functions[$errorObject])) { |
|
47 | - return $this->getLocalDescription(); |
|
48 | - } |
|
49 | - // no break; |
|
50 | - case CodeChecker::CLASS_EXTENDS_NOT_ALLOWED: |
|
51 | - case CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED: |
|
52 | - case CodeChecker::CLASS_NEW_NOT_ALLOWED: |
|
53 | - case CodeChecker::CLASS_USE_NOT_ALLOWED: |
|
54 | - $classes = $this->getLocalClasses(); |
|
55 | - $classes = array_change_key_case($classes, CASE_LOWER); |
|
56 | - if (isset($classes[$errorObject])) { |
|
57 | - return $this->getLocalDescription(); |
|
58 | - } |
|
59 | - break; |
|
60 | - |
|
61 | - case CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED: |
|
62 | - $constants = $this->getLocalConstants(); |
|
63 | - $constants = array_change_key_case($constants, CASE_LOWER); |
|
64 | - if (isset($constants[$errorObject])) { |
|
65 | - return $this->getLocalDescription(); |
|
66 | - } |
|
67 | - break; |
|
68 | - |
|
69 | - case CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED: |
|
70 | - $methods = $this->getLocalMethods(); |
|
71 | - $methods = array_change_key_case($methods, CASE_LOWER); |
|
72 | - if (isset($methods[$errorObject])) { |
|
73 | - return $this->getLocalDescription(); |
|
74 | - } |
|
75 | - break; |
|
76 | - } |
|
77 | - |
|
78 | - return $this->check->getDescription($errorCode, $errorObject); |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * @return string |
|
83 | - */ |
|
84 | - abstract protected function getLocalDescription(); |
|
85 | - |
|
86 | - /** |
|
87 | - * @return array |
|
88 | - */ |
|
89 | - abstract protected function getLocalClasses(); |
|
90 | - |
|
91 | - /** |
|
92 | - * @return array |
|
93 | - */ |
|
94 | - abstract protected function getLocalConstants(); |
|
95 | - |
|
96 | - /** |
|
97 | - * @return array |
|
98 | - */ |
|
99 | - abstract protected function getLocalFunctions(); |
|
100 | - |
|
101 | - /** |
|
102 | - * @return array |
|
103 | - */ |
|
104 | - abstract protected function getLocalMethods(); |
|
105 | - |
|
106 | - /** |
|
107 | - * @return array E.g.: `'ClassName' => 'oc version',` |
|
108 | - */ |
|
109 | - public function getClasses() { |
|
110 | - return array_merge($this->getLocalClasses(), $this->check->getClasses()); |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
115 | - */ |
|
116 | - public function getConstants() { |
|
117 | - return array_merge($this->getLocalConstants(), $this->check->getConstants()); |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * @return array E.g.: `'functionName' => 'oc version',` |
|
122 | - */ |
|
123 | - public function getFunctions() { |
|
124 | - return array_merge($this->getLocalFunctions(), $this->check->getFunctions()); |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
129 | - */ |
|
130 | - public function getMethods() { |
|
131 | - return array_merge($this->getLocalMethods(), $this->check->getMethods()); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * @return bool |
|
136 | - */ |
|
137 | - public function checkStrongComparisons() { |
|
138 | - return $this->check->checkStrongComparisons(); |
|
139 | - } |
|
26 | + /** @var ICheck */ |
|
27 | + protected $check; |
|
28 | + |
|
29 | + /** |
|
30 | + * @param ICheck $check |
|
31 | + */ |
|
32 | + public function __construct(ICheck $check) { |
|
33 | + $this->check = $check; |
|
34 | + } |
|
35 | + |
|
36 | + /** |
|
37 | + * @param int $errorCode |
|
38 | + * @param string $errorObject |
|
39 | + * @return string |
|
40 | + */ |
|
41 | + public function getDescription($errorCode, $errorObject) { |
|
42 | + switch ($errorCode) { |
|
43 | + case CodeChecker::STATIC_CALL_NOT_ALLOWED: |
|
44 | + $functions = $this->getLocalFunctions(); |
|
45 | + $functions = array_change_key_case($functions, CASE_LOWER); |
|
46 | + if (isset($functions[$errorObject])) { |
|
47 | + return $this->getLocalDescription(); |
|
48 | + } |
|
49 | + // no break; |
|
50 | + case CodeChecker::CLASS_EXTENDS_NOT_ALLOWED: |
|
51 | + case CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED: |
|
52 | + case CodeChecker::CLASS_NEW_NOT_ALLOWED: |
|
53 | + case CodeChecker::CLASS_USE_NOT_ALLOWED: |
|
54 | + $classes = $this->getLocalClasses(); |
|
55 | + $classes = array_change_key_case($classes, CASE_LOWER); |
|
56 | + if (isset($classes[$errorObject])) { |
|
57 | + return $this->getLocalDescription(); |
|
58 | + } |
|
59 | + break; |
|
60 | + |
|
61 | + case CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED: |
|
62 | + $constants = $this->getLocalConstants(); |
|
63 | + $constants = array_change_key_case($constants, CASE_LOWER); |
|
64 | + if (isset($constants[$errorObject])) { |
|
65 | + return $this->getLocalDescription(); |
|
66 | + } |
|
67 | + break; |
|
68 | + |
|
69 | + case CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED: |
|
70 | + $methods = $this->getLocalMethods(); |
|
71 | + $methods = array_change_key_case($methods, CASE_LOWER); |
|
72 | + if (isset($methods[$errorObject])) { |
|
73 | + return $this->getLocalDescription(); |
|
74 | + } |
|
75 | + break; |
|
76 | + } |
|
77 | + |
|
78 | + return $this->check->getDescription($errorCode, $errorObject); |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * @return string |
|
83 | + */ |
|
84 | + abstract protected function getLocalDescription(); |
|
85 | + |
|
86 | + /** |
|
87 | + * @return array |
|
88 | + */ |
|
89 | + abstract protected function getLocalClasses(); |
|
90 | + |
|
91 | + /** |
|
92 | + * @return array |
|
93 | + */ |
|
94 | + abstract protected function getLocalConstants(); |
|
95 | + |
|
96 | + /** |
|
97 | + * @return array |
|
98 | + */ |
|
99 | + abstract protected function getLocalFunctions(); |
|
100 | + |
|
101 | + /** |
|
102 | + * @return array |
|
103 | + */ |
|
104 | + abstract protected function getLocalMethods(); |
|
105 | + |
|
106 | + /** |
|
107 | + * @return array E.g.: `'ClassName' => 'oc version',` |
|
108 | + */ |
|
109 | + public function getClasses() { |
|
110 | + return array_merge($this->getLocalClasses(), $this->check->getClasses()); |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
115 | + */ |
|
116 | + public function getConstants() { |
|
117 | + return array_merge($this->getLocalConstants(), $this->check->getConstants()); |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * @return array E.g.: `'functionName' => 'oc version',` |
|
122 | + */ |
|
123 | + public function getFunctions() { |
|
124 | + return array_merge($this->getLocalFunctions(), $this->check->getFunctions()); |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
129 | + */ |
|
130 | + public function getMethods() { |
|
131 | + return array_merge($this->getLocalMethods(), $this->check->getMethods()); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * @return bool |
|
136 | + */ |
|
137 | + public function checkStrongComparisons() { |
|
138 | + return $this->check->checkStrongComparisons(); |
|
139 | + } |
|
140 | 140 | } |
@@ -22,47 +22,47 @@ |
||
22 | 22 | namespace OC\App\CodeChecker; |
23 | 23 | |
24 | 24 | class EmptyCheck implements ICheck { |
25 | - /** |
|
26 | - * @param int $errorCode |
|
27 | - * @param string $errorObject |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function getDescription($errorCode, $errorObject) { |
|
31 | - return ''; |
|
32 | - } |
|
25 | + /** |
|
26 | + * @param int $errorCode |
|
27 | + * @param string $errorObject |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function getDescription($errorCode, $errorObject) { |
|
31 | + return ''; |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * @return array E.g.: `'ClassName' => 'oc version',` |
|
36 | - */ |
|
37 | - public function getClasses() { |
|
38 | - return []; |
|
39 | - } |
|
34 | + /** |
|
35 | + * @return array E.g.: `'ClassName' => 'oc version',` |
|
36 | + */ |
|
37 | + public function getClasses() { |
|
38 | + return []; |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
43 | - */ |
|
44 | - public function getConstants() { |
|
45 | - return []; |
|
46 | - } |
|
41 | + /** |
|
42 | + * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
43 | + */ |
|
44 | + public function getConstants() { |
|
45 | + return []; |
|
46 | + } |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return array E.g.: `'functionName' => 'oc version',` |
|
50 | - */ |
|
51 | - public function getFunctions() { |
|
52 | - return []; |
|
53 | - } |
|
48 | + /** |
|
49 | + * @return array E.g.: `'functionName' => 'oc version',` |
|
50 | + */ |
|
51 | + public function getFunctions() { |
|
52 | + return []; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
57 | - */ |
|
58 | - public function getMethods() { |
|
59 | - return []; |
|
60 | - } |
|
55 | + /** |
|
56 | + * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
57 | + */ |
|
58 | + public function getMethods() { |
|
59 | + return []; |
|
60 | + } |
|
61 | 61 | |
62 | - /** |
|
63 | - * @return bool |
|
64 | - */ |
|
65 | - public function checkStrongComparisons() { |
|
66 | - return false; |
|
67 | - } |
|
62 | + /** |
|
63 | + * @return bool |
|
64 | + */ |
|
65 | + public function checkStrongComparisons() { |
|
66 | + return false; |
|
67 | + } |
|
68 | 68 | } |
@@ -23,57 +23,57 @@ |
||
23 | 23 | namespace OC\App\CodeChecker; |
24 | 24 | |
25 | 25 | class StrongComparisonCheck implements ICheck { |
26 | - /** @var ICheck */ |
|
27 | - protected $check; |
|
26 | + /** @var ICheck */ |
|
27 | + protected $check; |
|
28 | 28 | |
29 | - /** |
|
30 | - * @param ICheck $check |
|
31 | - */ |
|
32 | - public function __construct(ICheck $check) { |
|
33 | - $this->check = $check; |
|
34 | - } |
|
29 | + /** |
|
30 | + * @param ICheck $check |
|
31 | + */ |
|
32 | + public function __construct(ICheck $check) { |
|
33 | + $this->check = $check; |
|
34 | + } |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param int $errorCode |
|
38 | - * @param string $errorObject |
|
39 | - * @return string |
|
40 | - */ |
|
41 | - public function getDescription($errorCode, $errorObject) { |
|
42 | - return $this->check->getDescription($errorCode, $errorObject); |
|
43 | - } |
|
36 | + /** |
|
37 | + * @param int $errorCode |
|
38 | + * @param string $errorObject |
|
39 | + * @return string |
|
40 | + */ |
|
41 | + public function getDescription($errorCode, $errorObject) { |
|
42 | + return $this->check->getDescription($errorCode, $errorObject); |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return array |
|
47 | - */ |
|
48 | - public function getClasses() { |
|
49 | - return $this->check->getClasses(); |
|
50 | - } |
|
45 | + /** |
|
46 | + * @return array |
|
47 | + */ |
|
48 | + public function getClasses() { |
|
49 | + return $this->check->getClasses(); |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return array |
|
54 | - */ |
|
55 | - public function getConstants() { |
|
56 | - return $this->check->getConstants(); |
|
57 | - } |
|
52 | + /** |
|
53 | + * @return array |
|
54 | + */ |
|
55 | + public function getConstants() { |
|
56 | + return $this->check->getConstants(); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * @return array |
|
61 | - */ |
|
62 | - public function getFunctions() { |
|
63 | - return $this->check->getFunctions(); |
|
64 | - } |
|
59 | + /** |
|
60 | + * @return array |
|
61 | + */ |
|
62 | + public function getFunctions() { |
|
63 | + return $this->check->getFunctions(); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * @return array |
|
68 | - */ |
|
69 | - public function getMethods() { |
|
70 | - return $this->check->getMethods(); |
|
71 | - } |
|
66 | + /** |
|
67 | + * @return array |
|
68 | + */ |
|
69 | + public function getMethods() { |
|
70 | + return $this->check->getMethods(); |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * @return bool |
|
75 | - */ |
|
76 | - public function checkStrongComparisons() { |
|
77 | - return true; |
|
78 | - } |
|
73 | + /** |
|
74 | + * @return bool |
|
75 | + */ |
|
76 | + public function checkStrongComparisons() { |
|
77 | + return true; |
|
78 | + } |
|
79 | 79 | } |
@@ -22,35 +22,35 @@ |
||
22 | 22 | namespace OC\App\CodeChecker; |
23 | 23 | |
24 | 24 | interface ICheck { |
25 | - /** |
|
26 | - * @param int $errorCode |
|
27 | - * @param string $errorObject |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function getDescription($errorCode, $errorObject); |
|
25 | + /** |
|
26 | + * @param int $errorCode |
|
27 | + * @param string $errorObject |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function getDescription($errorCode, $errorObject); |
|
31 | 31 | |
32 | - /** |
|
33 | - * @return array E.g.: `'ClassName' => 'oc version',` |
|
34 | - */ |
|
35 | - public function getClasses(); |
|
32 | + /** |
|
33 | + * @return array E.g.: `'ClassName' => 'oc version',` |
|
34 | + */ |
|
35 | + public function getClasses(); |
|
36 | 36 | |
37 | - /** |
|
38 | - * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
39 | - */ |
|
40 | - public function getConstants(); |
|
37 | + /** |
|
38 | + * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',` |
|
39 | + */ |
|
40 | + public function getConstants(); |
|
41 | 41 | |
42 | - /** |
|
43 | - * @return array E.g.: `'functionName' => 'oc version',` |
|
44 | - */ |
|
45 | - public function getFunctions(); |
|
42 | + /** |
|
43 | + * @return array E.g.: `'functionName' => 'oc version',` |
|
44 | + */ |
|
45 | + public function getFunctions(); |
|
46 | 46 | |
47 | - /** |
|
48 | - * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
49 | - */ |
|
50 | - public function getMethods(); |
|
47 | + /** |
|
48 | + * @return array E.g.: `'ClassName::methodName' => 'oc version',` |
|
49 | + */ |
|
50 | + public function getMethods(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return bool |
|
54 | - */ |
|
55 | - public function checkStrongComparisons(); |
|
52 | + /** |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | + public function checkStrongComparisons(); |
|
56 | 56 | } |
@@ -30,200 +30,200 @@ |
||
30 | 30 | * @package OC\App |
31 | 31 | */ |
32 | 32 | class PlatformRepository { |
33 | - public function __construct() { |
|
34 | - $this->packages = $this->initialize(); |
|
35 | - } |
|
36 | - |
|
37 | - protected function initialize() { |
|
38 | - $loadedExtensions = get_loaded_extensions(); |
|
39 | - $packages = array(); |
|
40 | - |
|
41 | - // Extensions scanning |
|
42 | - foreach ($loadedExtensions as $name) { |
|
43 | - if (in_array($name, array('standard', 'Core'))) { |
|
44 | - continue; |
|
45 | - } |
|
46 | - |
|
47 | - $ext = new \ReflectionExtension($name); |
|
48 | - try { |
|
49 | - $prettyVersion = $ext->getVersion(); |
|
50 | - $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
51 | - } catch (\UnexpectedValueException $e) { |
|
52 | - $prettyVersion = '0'; |
|
53 | - $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
54 | - } |
|
55 | - |
|
56 | - $packages[$this->buildPackageName($name)] = $prettyVersion; |
|
57 | - } |
|
58 | - |
|
59 | - foreach ($loadedExtensions as $name) { |
|
60 | - $prettyVersion = null; |
|
61 | - switch ($name) { |
|
62 | - case 'curl': |
|
63 | - $curlVersion = curl_version(); |
|
64 | - $prettyVersion = $curlVersion['version']; |
|
65 | - break; |
|
66 | - |
|
67 | - case 'iconv': |
|
68 | - $prettyVersion = ICONV_VERSION; |
|
69 | - break; |
|
70 | - |
|
71 | - case 'intl': |
|
72 | - $name = 'ICU'; |
|
73 | - if (defined('INTL_ICU_VERSION')) { |
|
74 | - $prettyVersion = INTL_ICU_VERSION; |
|
75 | - } else { |
|
76 | - $reflector = new \ReflectionExtension('intl'); |
|
77 | - |
|
78 | - ob_start(); |
|
79 | - $reflector->info(); |
|
80 | - $output = ob_get_clean(); |
|
81 | - |
|
82 | - preg_match('/^ICU version => (.*)$/m', $output, $matches); |
|
83 | - $prettyVersion = $matches[1]; |
|
84 | - } |
|
85 | - |
|
86 | - break; |
|
87 | - |
|
88 | - case 'libxml': |
|
89 | - $prettyVersion = LIBXML_DOTTED_VERSION; |
|
90 | - break; |
|
91 | - |
|
92 | - case 'openssl': |
|
93 | - $prettyVersion = preg_replace_callback('{^(?:OpenSSL\s*)?([0-9.]+)([a-z]?).*}', function ($match) { |
|
94 | - return $match[1] . (empty($match[2]) ? '' : '.' . (ord($match[2]) - 96)); |
|
95 | - }, OPENSSL_VERSION_TEXT); |
|
96 | - break; |
|
97 | - |
|
98 | - case 'pcre': |
|
99 | - $prettyVersion = preg_replace('{^(\S+).*}', '$1', PCRE_VERSION); |
|
100 | - break; |
|
101 | - |
|
102 | - case 'uuid': |
|
103 | - $prettyVersion = phpversion('uuid'); |
|
104 | - break; |
|
105 | - |
|
106 | - case 'xsl': |
|
107 | - $prettyVersion = LIBXSLT_DOTTED_VERSION; |
|
108 | - break; |
|
109 | - |
|
110 | - default: |
|
111 | - // None handled extensions have no special cases, skip |
|
112 | - continue 2; |
|
113 | - } |
|
114 | - |
|
115 | - try { |
|
116 | - $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
117 | - } catch (\UnexpectedValueException $e) { |
|
118 | - continue; |
|
119 | - } |
|
120 | - |
|
121 | - $packages[$this->buildPackageName($name)] = $prettyVersion; |
|
122 | - } |
|
123 | - |
|
124 | - return $packages; |
|
125 | - } |
|
126 | - |
|
127 | - private function buildPackageName($name) { |
|
128 | - return str_replace(' ', '-', $name); |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * @param $name |
|
133 | - * @return string |
|
134 | - */ |
|
135 | - public function findLibrary($name) { |
|
136 | - $extName = $this->buildPackageName($name); |
|
137 | - if (isset($this->packages[$extName])) { |
|
138 | - return $this->packages[$extName]; |
|
139 | - } |
|
140 | - return null; |
|
141 | - } |
|
142 | - |
|
143 | - private static $modifierRegex = '[._-]?(?:(stable|beta|b|RC|alpha|a|patch|pl|p)(?:[.-]?(\d+))?)?([.-]?dev)?'; |
|
144 | - |
|
145 | - /** |
|
146 | - * Normalizes a version string to be able to perform comparisons on it |
|
147 | - * |
|
148 | - * https://github.com/composer/composer/blob/master/src/Composer/Package/Version/VersionParser.php#L94 |
|
149 | - * |
|
150 | - * @param string $version |
|
151 | - * @param string $fullVersion optional complete version string to give more context |
|
152 | - * @throws \UnexpectedValueException |
|
153 | - * @return string |
|
154 | - */ |
|
155 | - public function normalizeVersion($version, $fullVersion = null) { |
|
156 | - $version = trim($version); |
|
157 | - if (null === $fullVersion) { |
|
158 | - $fullVersion = $version; |
|
159 | - } |
|
160 | - // ignore aliases and just assume the alias is required instead of the source |
|
161 | - if (preg_match('{^([^,\s]+) +as +([^,\s]+)$}', $version, $match)) { |
|
162 | - $version = $match[1]; |
|
163 | - } |
|
164 | - // match master-like branches |
|
165 | - if (preg_match('{^(?:dev-)?(?:master|trunk|default)$}i', $version)) { |
|
166 | - return '9999999-dev'; |
|
167 | - } |
|
168 | - if ('dev-' === strtolower(substr($version, 0, 4))) { |
|
169 | - return 'dev-' . substr($version, 4); |
|
170 | - } |
|
171 | - // match classical versioning |
|
172 | - if (preg_match('{^v?(\d{1,3})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
173 | - $version = $matches[1] |
|
174 | - . (!empty($matches[2]) ? $matches[2] : '.0') |
|
175 | - . (!empty($matches[3]) ? $matches[3] : '.0') |
|
176 | - . (!empty($matches[4]) ? $matches[4] : '.0'); |
|
177 | - $index = 5; |
|
178 | - } elseif (preg_match('{^v?(\d{4}(?:[.:-]?\d{2}){1,6}(?:[.:-]?\d{1,3})?)' . self::$modifierRegex . '$}i', $version, $matches)) { // match date-based versioning |
|
179 | - $version = preg_replace('{\D}', '-', $matches[1]); |
|
180 | - $index = 2; |
|
181 | - } elseif (preg_match('{^v?(\d{4,})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
182 | - $version = $matches[1] |
|
183 | - . (!empty($matches[2]) ? $matches[2] : '.0') |
|
184 | - . (!empty($matches[3]) ? $matches[3] : '.0') |
|
185 | - . (!empty($matches[4]) ? $matches[4] : '.0'); |
|
186 | - $index = 5; |
|
187 | - } |
|
188 | - // add version modifiers if a version was matched |
|
189 | - if (isset($index)) { |
|
190 | - if (!empty($matches[$index])) { |
|
191 | - if ('stable' === $matches[$index]) { |
|
192 | - return $version; |
|
193 | - } |
|
194 | - $version .= '-' . $this->expandStability($matches[$index]) . (!empty($matches[$index + 1]) ? $matches[$index + 1] : ''); |
|
195 | - } |
|
196 | - if (!empty($matches[$index + 2])) { |
|
197 | - $version .= '-dev'; |
|
198 | - } |
|
199 | - return $version; |
|
200 | - } |
|
201 | - $extraMessage = ''; |
|
202 | - if (preg_match('{ +as +' . preg_quote($version) . '$}', $fullVersion)) { |
|
203 | - $extraMessage = ' in "' . $fullVersion . '", the alias must be an exact version'; |
|
204 | - } elseif (preg_match('{^' . preg_quote($version) . ' +as +}', $fullVersion)) { |
|
205 | - $extraMessage = ' in "' . $fullVersion . '", the alias source must be an exact version, if it is a branch name you should prefix it with dev-'; |
|
206 | - } |
|
207 | - throw new \UnexpectedValueException('Invalid version string "' . $version . '"' . $extraMessage); |
|
208 | - } |
|
209 | - |
|
210 | - /** |
|
211 | - * @param string $stability |
|
212 | - */ |
|
213 | - private function expandStability($stability) { |
|
214 | - $stability = strtolower($stability); |
|
215 | - switch ($stability) { |
|
216 | - case 'a': |
|
217 | - return 'alpha'; |
|
218 | - case 'b': |
|
219 | - return 'beta'; |
|
220 | - case 'p': |
|
221 | - case 'pl': |
|
222 | - return 'patch'; |
|
223 | - case 'rc': |
|
224 | - return 'RC'; |
|
225 | - default: |
|
226 | - return $stability; |
|
227 | - } |
|
228 | - } |
|
33 | + public function __construct() { |
|
34 | + $this->packages = $this->initialize(); |
|
35 | + } |
|
36 | + |
|
37 | + protected function initialize() { |
|
38 | + $loadedExtensions = get_loaded_extensions(); |
|
39 | + $packages = array(); |
|
40 | + |
|
41 | + // Extensions scanning |
|
42 | + foreach ($loadedExtensions as $name) { |
|
43 | + if (in_array($name, array('standard', 'Core'))) { |
|
44 | + continue; |
|
45 | + } |
|
46 | + |
|
47 | + $ext = new \ReflectionExtension($name); |
|
48 | + try { |
|
49 | + $prettyVersion = $ext->getVersion(); |
|
50 | + $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
51 | + } catch (\UnexpectedValueException $e) { |
|
52 | + $prettyVersion = '0'; |
|
53 | + $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
54 | + } |
|
55 | + |
|
56 | + $packages[$this->buildPackageName($name)] = $prettyVersion; |
|
57 | + } |
|
58 | + |
|
59 | + foreach ($loadedExtensions as $name) { |
|
60 | + $prettyVersion = null; |
|
61 | + switch ($name) { |
|
62 | + case 'curl': |
|
63 | + $curlVersion = curl_version(); |
|
64 | + $prettyVersion = $curlVersion['version']; |
|
65 | + break; |
|
66 | + |
|
67 | + case 'iconv': |
|
68 | + $prettyVersion = ICONV_VERSION; |
|
69 | + break; |
|
70 | + |
|
71 | + case 'intl': |
|
72 | + $name = 'ICU'; |
|
73 | + if (defined('INTL_ICU_VERSION')) { |
|
74 | + $prettyVersion = INTL_ICU_VERSION; |
|
75 | + } else { |
|
76 | + $reflector = new \ReflectionExtension('intl'); |
|
77 | + |
|
78 | + ob_start(); |
|
79 | + $reflector->info(); |
|
80 | + $output = ob_get_clean(); |
|
81 | + |
|
82 | + preg_match('/^ICU version => (.*)$/m', $output, $matches); |
|
83 | + $prettyVersion = $matches[1]; |
|
84 | + } |
|
85 | + |
|
86 | + break; |
|
87 | + |
|
88 | + case 'libxml': |
|
89 | + $prettyVersion = LIBXML_DOTTED_VERSION; |
|
90 | + break; |
|
91 | + |
|
92 | + case 'openssl': |
|
93 | + $prettyVersion = preg_replace_callback('{^(?:OpenSSL\s*)?([0-9.]+)([a-z]?).*}', function ($match) { |
|
94 | + return $match[1] . (empty($match[2]) ? '' : '.' . (ord($match[2]) - 96)); |
|
95 | + }, OPENSSL_VERSION_TEXT); |
|
96 | + break; |
|
97 | + |
|
98 | + case 'pcre': |
|
99 | + $prettyVersion = preg_replace('{^(\S+).*}', '$1', PCRE_VERSION); |
|
100 | + break; |
|
101 | + |
|
102 | + case 'uuid': |
|
103 | + $prettyVersion = phpversion('uuid'); |
|
104 | + break; |
|
105 | + |
|
106 | + case 'xsl': |
|
107 | + $prettyVersion = LIBXSLT_DOTTED_VERSION; |
|
108 | + break; |
|
109 | + |
|
110 | + default: |
|
111 | + // None handled extensions have no special cases, skip |
|
112 | + continue 2; |
|
113 | + } |
|
114 | + |
|
115 | + try { |
|
116 | + $prettyVersion = $this->normalizeVersion($prettyVersion); |
|
117 | + } catch (\UnexpectedValueException $e) { |
|
118 | + continue; |
|
119 | + } |
|
120 | + |
|
121 | + $packages[$this->buildPackageName($name)] = $prettyVersion; |
|
122 | + } |
|
123 | + |
|
124 | + return $packages; |
|
125 | + } |
|
126 | + |
|
127 | + private function buildPackageName($name) { |
|
128 | + return str_replace(' ', '-', $name); |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * @param $name |
|
133 | + * @return string |
|
134 | + */ |
|
135 | + public function findLibrary($name) { |
|
136 | + $extName = $this->buildPackageName($name); |
|
137 | + if (isset($this->packages[$extName])) { |
|
138 | + return $this->packages[$extName]; |
|
139 | + } |
|
140 | + return null; |
|
141 | + } |
|
142 | + |
|
143 | + private static $modifierRegex = '[._-]?(?:(stable|beta|b|RC|alpha|a|patch|pl|p)(?:[.-]?(\d+))?)?([.-]?dev)?'; |
|
144 | + |
|
145 | + /** |
|
146 | + * Normalizes a version string to be able to perform comparisons on it |
|
147 | + * |
|
148 | + * https://github.com/composer/composer/blob/master/src/Composer/Package/Version/VersionParser.php#L94 |
|
149 | + * |
|
150 | + * @param string $version |
|
151 | + * @param string $fullVersion optional complete version string to give more context |
|
152 | + * @throws \UnexpectedValueException |
|
153 | + * @return string |
|
154 | + */ |
|
155 | + public function normalizeVersion($version, $fullVersion = null) { |
|
156 | + $version = trim($version); |
|
157 | + if (null === $fullVersion) { |
|
158 | + $fullVersion = $version; |
|
159 | + } |
|
160 | + // ignore aliases and just assume the alias is required instead of the source |
|
161 | + if (preg_match('{^([^,\s]+) +as +([^,\s]+)$}', $version, $match)) { |
|
162 | + $version = $match[1]; |
|
163 | + } |
|
164 | + // match master-like branches |
|
165 | + if (preg_match('{^(?:dev-)?(?:master|trunk|default)$}i', $version)) { |
|
166 | + return '9999999-dev'; |
|
167 | + } |
|
168 | + if ('dev-' === strtolower(substr($version, 0, 4))) { |
|
169 | + return 'dev-' . substr($version, 4); |
|
170 | + } |
|
171 | + // match classical versioning |
|
172 | + if (preg_match('{^v?(\d{1,3})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
173 | + $version = $matches[1] |
|
174 | + . (!empty($matches[2]) ? $matches[2] : '.0') |
|
175 | + . (!empty($matches[3]) ? $matches[3] : '.0') |
|
176 | + . (!empty($matches[4]) ? $matches[4] : '.0'); |
|
177 | + $index = 5; |
|
178 | + } elseif (preg_match('{^v?(\d{4}(?:[.:-]?\d{2}){1,6}(?:[.:-]?\d{1,3})?)' . self::$modifierRegex . '$}i', $version, $matches)) { // match date-based versioning |
|
179 | + $version = preg_replace('{\D}', '-', $matches[1]); |
|
180 | + $index = 2; |
|
181 | + } elseif (preg_match('{^v?(\d{4,})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
182 | + $version = $matches[1] |
|
183 | + . (!empty($matches[2]) ? $matches[2] : '.0') |
|
184 | + . (!empty($matches[3]) ? $matches[3] : '.0') |
|
185 | + . (!empty($matches[4]) ? $matches[4] : '.0'); |
|
186 | + $index = 5; |
|
187 | + } |
|
188 | + // add version modifiers if a version was matched |
|
189 | + if (isset($index)) { |
|
190 | + if (!empty($matches[$index])) { |
|
191 | + if ('stable' === $matches[$index]) { |
|
192 | + return $version; |
|
193 | + } |
|
194 | + $version .= '-' . $this->expandStability($matches[$index]) . (!empty($matches[$index + 1]) ? $matches[$index + 1] : ''); |
|
195 | + } |
|
196 | + if (!empty($matches[$index + 2])) { |
|
197 | + $version .= '-dev'; |
|
198 | + } |
|
199 | + return $version; |
|
200 | + } |
|
201 | + $extraMessage = ''; |
|
202 | + if (preg_match('{ +as +' . preg_quote($version) . '$}', $fullVersion)) { |
|
203 | + $extraMessage = ' in "' . $fullVersion . '", the alias must be an exact version'; |
|
204 | + } elseif (preg_match('{^' . preg_quote($version) . ' +as +}', $fullVersion)) { |
|
205 | + $extraMessage = ' in "' . $fullVersion . '", the alias source must be an exact version, if it is a branch name you should prefix it with dev-'; |
|
206 | + } |
|
207 | + throw new \UnexpectedValueException('Invalid version string "' . $version . '"' . $extraMessage); |
|
208 | + } |
|
209 | + |
|
210 | + /** |
|
211 | + * @param string $stability |
|
212 | + */ |
|
213 | + private function expandStability($stability) { |
|
214 | + $stability = strtolower($stability); |
|
215 | + switch ($stability) { |
|
216 | + case 'a': |
|
217 | + return 'alpha'; |
|
218 | + case 'b': |
|
219 | + return 'beta'; |
|
220 | + case 'p': |
|
221 | + case 'pl': |
|
222 | + return 'patch'; |
|
223 | + case 'rc': |
|
224 | + return 'RC'; |
|
225 | + default: |
|
226 | + return $stability; |
|
227 | + } |
|
228 | + } |
|
229 | 229 | } |
@@ -90,8 +90,8 @@ discard block |
||
90 | 90 | break; |
91 | 91 | |
92 | 92 | case 'openssl': |
93 | - $prettyVersion = preg_replace_callback('{^(?:OpenSSL\s*)?([0-9.]+)([a-z]?).*}', function ($match) { |
|
94 | - return $match[1] . (empty($match[2]) ? '' : '.' . (ord($match[2]) - 96)); |
|
93 | + $prettyVersion = preg_replace_callback('{^(?:OpenSSL\s*)?([0-9.]+)([a-z]?).*}', function($match) { |
|
94 | + return $match[1].(empty($match[2]) ? '' : '.'.(ord($match[2]) - 96)); |
|
95 | 95 | }, OPENSSL_VERSION_TEXT); |
96 | 96 | break; |
97 | 97 | |
@@ -166,19 +166,19 @@ discard block |
||
166 | 166 | return '9999999-dev'; |
167 | 167 | } |
168 | 168 | if ('dev-' === strtolower(substr($version, 0, 4))) { |
169 | - return 'dev-' . substr($version, 4); |
|
169 | + return 'dev-'.substr($version, 4); |
|
170 | 170 | } |
171 | 171 | // match classical versioning |
172 | - if (preg_match('{^v?(\d{1,3})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
172 | + if (preg_match('{^v?(\d{1,3})(\.\d+)?(\.\d+)?(\.\d+)?'.self::$modifierRegex.'$}i', $version, $matches)) { |
|
173 | 173 | $version = $matches[1] |
174 | 174 | . (!empty($matches[2]) ? $matches[2] : '.0') |
175 | 175 | . (!empty($matches[3]) ? $matches[3] : '.0') |
176 | 176 | . (!empty($matches[4]) ? $matches[4] : '.0'); |
177 | 177 | $index = 5; |
178 | - } elseif (preg_match('{^v?(\d{4}(?:[.:-]?\d{2}){1,6}(?:[.:-]?\d{1,3})?)' . self::$modifierRegex . '$}i', $version, $matches)) { // match date-based versioning |
|
178 | + } elseif (preg_match('{^v?(\d{4}(?:[.:-]?\d{2}){1,6}(?:[.:-]?\d{1,3})?)'.self::$modifierRegex.'$}i', $version, $matches)) { // match date-based versioning |
|
179 | 179 | $version = preg_replace('{\D}', '-', $matches[1]); |
180 | 180 | $index = 2; |
181 | - } elseif (preg_match('{^v?(\d{4,})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) { |
|
181 | + } elseif (preg_match('{^v?(\d{4,})(\.\d+)?(\.\d+)?(\.\d+)?'.self::$modifierRegex.'$}i', $version, $matches)) { |
|
182 | 182 | $version = $matches[1] |
183 | 183 | . (!empty($matches[2]) ? $matches[2] : '.0') |
184 | 184 | . (!empty($matches[3]) ? $matches[3] : '.0') |
@@ -191,7 +191,7 @@ discard block |
||
191 | 191 | if ('stable' === $matches[$index]) { |
192 | 192 | return $version; |
193 | 193 | } |
194 | - $version .= '-' . $this->expandStability($matches[$index]) . (!empty($matches[$index + 1]) ? $matches[$index + 1] : ''); |
|
194 | + $version .= '-'.$this->expandStability($matches[$index]).(!empty($matches[$index + 1]) ? $matches[$index + 1] : ''); |
|
195 | 195 | } |
196 | 196 | if (!empty($matches[$index + 2])) { |
197 | 197 | $version .= '-dev'; |
@@ -199,12 +199,12 @@ discard block |
||
199 | 199 | return $version; |
200 | 200 | } |
201 | 201 | $extraMessage = ''; |
202 | - if (preg_match('{ +as +' . preg_quote($version) . '$}', $fullVersion)) { |
|
203 | - $extraMessage = ' in "' . $fullVersion . '", the alias must be an exact version'; |
|
204 | - } elseif (preg_match('{^' . preg_quote($version) . ' +as +}', $fullVersion)) { |
|
205 | - $extraMessage = ' in "' . $fullVersion . '", the alias source must be an exact version, if it is a branch name you should prefix it with dev-'; |
|
202 | + if (preg_match('{ +as +'.preg_quote($version).'$}', $fullVersion)) { |
|
203 | + $extraMessage = ' in "'.$fullVersion.'", the alias must be an exact version'; |
|
204 | + } elseif (preg_match('{^'.preg_quote($version).' +as +}', $fullVersion)) { |
|
205 | + $extraMessage = ' in "'.$fullVersion.'", the alias source must be an exact version, if it is a branch name you should prefix it with dev-'; |
|
206 | 206 | } |
207 | - throw new \UnexpectedValueException('Invalid version string "' . $version . '"' . $extraMessage); |
|
207 | + throw new \UnexpectedValueException('Invalid version string "'.$version.'"'.$extraMessage); |
|
208 | 208 | } |
209 | 209 | |
210 | 210 | /** |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | * @return string Formatted date and time string |
238 | 238 | */ |
239 | 239 | public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
240 | - return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
240 | + return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l); |
|
241 | 241 | } |
242 | 242 | |
243 | 243 | /** |
@@ -256,7 +256,7 @@ discard block |
||
256 | 256 | $formatDate .= '^'; |
257 | 257 | } |
258 | 258 | |
259 | - return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
259 | + return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l); |
|
260 | 260 | } |
261 | 261 | |
262 | 262 | /** |
@@ -25,294 +25,294 @@ |
||
25 | 25 | namespace OC; |
26 | 26 | |
27 | 27 | class DateTimeFormatter implements \OCP\IDateTimeFormatter { |
28 | - /** @var \DateTimeZone */ |
|
29 | - protected $defaultTimeZone; |
|
28 | + /** @var \DateTimeZone */ |
|
29 | + protected $defaultTimeZone; |
|
30 | 30 | |
31 | - /** @var \OCP\IL10N */ |
|
32 | - protected $defaultL10N; |
|
31 | + /** @var \OCP\IL10N */ |
|
32 | + protected $defaultL10N; |
|
33 | 33 | |
34 | - /** |
|
35 | - * Constructor |
|
36 | - * |
|
37 | - * @param \DateTimeZone $defaultTimeZone Set the timezone for the format |
|
38 | - * @param \OCP\IL10N $defaultL10N Set the language for the format |
|
39 | - */ |
|
40 | - public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) { |
|
41 | - $this->defaultTimeZone = $defaultTimeZone; |
|
42 | - $this->defaultL10N = $defaultL10N; |
|
43 | - } |
|
34 | + /** |
|
35 | + * Constructor |
|
36 | + * |
|
37 | + * @param \DateTimeZone $defaultTimeZone Set the timezone for the format |
|
38 | + * @param \OCP\IL10N $defaultL10N Set the language for the format |
|
39 | + */ |
|
40 | + public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) { |
|
41 | + $this->defaultTimeZone = $defaultTimeZone; |
|
42 | + $this->defaultL10N = $defaultL10N; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * Get TimeZone to use |
|
47 | - * |
|
48 | - * @param \DateTimeZone $timeZone The timezone to use |
|
49 | - * @return \DateTimeZone The timezone to use, falling back to the current user's timezone |
|
50 | - */ |
|
51 | - protected function getTimeZone($timeZone = null) { |
|
52 | - if ($timeZone === null) { |
|
53 | - $timeZone = $this->defaultTimeZone; |
|
54 | - } |
|
45 | + /** |
|
46 | + * Get TimeZone to use |
|
47 | + * |
|
48 | + * @param \DateTimeZone $timeZone The timezone to use |
|
49 | + * @return \DateTimeZone The timezone to use, falling back to the current user's timezone |
|
50 | + */ |
|
51 | + protected function getTimeZone($timeZone = null) { |
|
52 | + if ($timeZone === null) { |
|
53 | + $timeZone = $this->defaultTimeZone; |
|
54 | + } |
|
55 | 55 | |
56 | - return $timeZone; |
|
57 | - } |
|
56 | + return $timeZone; |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * Get \OCP\IL10N to use |
|
61 | - * |
|
62 | - * @param \OCP\IL10N $l The locale to use |
|
63 | - * @return \OCP\IL10N The locale to use, falling back to the current user's locale |
|
64 | - */ |
|
65 | - protected function getLocale($l = null) { |
|
66 | - if ($l === null) { |
|
67 | - $l = $this->defaultL10N; |
|
68 | - } |
|
59 | + /** |
|
60 | + * Get \OCP\IL10N to use |
|
61 | + * |
|
62 | + * @param \OCP\IL10N $l The locale to use |
|
63 | + * @return \OCP\IL10N The locale to use, falling back to the current user's locale |
|
64 | + */ |
|
65 | + protected function getLocale($l = null) { |
|
66 | + if ($l === null) { |
|
67 | + $l = $this->defaultL10N; |
|
68 | + } |
|
69 | 69 | |
70 | - return $l; |
|
71 | - } |
|
70 | + return $l; |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * Generates a DateTime object with the given timestamp and TimeZone |
|
75 | - * |
|
76 | - * @param mixed $timestamp |
|
77 | - * @param \DateTimeZone $timeZone The timezone to use |
|
78 | - * @return \DateTime |
|
79 | - */ |
|
80 | - protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) { |
|
81 | - if ($timestamp === null) { |
|
82 | - return new \DateTime('now', $timeZone); |
|
83 | - } else if (!$timestamp instanceof \DateTime) { |
|
84 | - $dateTime = new \DateTime('now', $timeZone); |
|
85 | - $dateTime->setTimestamp($timestamp); |
|
86 | - return $dateTime; |
|
87 | - } |
|
88 | - if ($timeZone) { |
|
89 | - $timestamp->setTimezone($timeZone); |
|
90 | - } |
|
91 | - return $timestamp; |
|
92 | - } |
|
73 | + /** |
|
74 | + * Generates a DateTime object with the given timestamp and TimeZone |
|
75 | + * |
|
76 | + * @param mixed $timestamp |
|
77 | + * @param \DateTimeZone $timeZone The timezone to use |
|
78 | + * @return \DateTime |
|
79 | + */ |
|
80 | + protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) { |
|
81 | + if ($timestamp === null) { |
|
82 | + return new \DateTime('now', $timeZone); |
|
83 | + } else if (!$timestamp instanceof \DateTime) { |
|
84 | + $dateTime = new \DateTime('now', $timeZone); |
|
85 | + $dateTime->setTimestamp($timestamp); |
|
86 | + return $dateTime; |
|
87 | + } |
|
88 | + if ($timeZone) { |
|
89 | + $timestamp->setTimezone($timeZone); |
|
90 | + } |
|
91 | + return $timestamp; |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Formats the date of the given timestamp |
|
96 | - * |
|
97 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
98 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
99 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
100 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
101 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
102 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
103 | - * The exact format is dependent on the language |
|
104 | - * @param \DateTimeZone $timeZone The timezone to use |
|
105 | - * @param \OCP\IL10N $l The locale to use |
|
106 | - * @return string Formatted date string |
|
107 | - */ |
|
108 | - public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
109 | - return $this->format($timestamp, 'date', $format, $timeZone, $l); |
|
110 | - } |
|
94 | + /** |
|
95 | + * Formats the date of the given timestamp |
|
96 | + * |
|
97 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
98 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
99 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
100 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
101 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
102 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
103 | + * The exact format is dependent on the language |
|
104 | + * @param \DateTimeZone $timeZone The timezone to use |
|
105 | + * @param \OCP\IL10N $l The locale to use |
|
106 | + * @return string Formatted date string |
|
107 | + */ |
|
108 | + public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
109 | + return $this->format($timestamp, 'date', $format, $timeZone, $l); |
|
110 | + } |
|
111 | 111 | |
112 | - /** |
|
113 | - * Formats the date of the given timestamp |
|
114 | - * |
|
115 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
116 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
117 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
118 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
119 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
120 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
121 | - * The exact format is dependent on the language |
|
122 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
123 | - * @param \DateTimeZone $timeZone The timezone to use |
|
124 | - * @param \OCP\IL10N $l The locale to use |
|
125 | - * @return string Formatted relative date string |
|
126 | - */ |
|
127 | - public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
128 | - if (substr($format, -1) !== '*' && substr($format, -1) !== '*') { |
|
129 | - $format .= '^'; |
|
130 | - } |
|
112 | + /** |
|
113 | + * Formats the date of the given timestamp |
|
114 | + * |
|
115 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
116 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
117 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
118 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
119 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
120 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
121 | + * The exact format is dependent on the language |
|
122 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
123 | + * @param \DateTimeZone $timeZone The timezone to use |
|
124 | + * @param \OCP\IL10N $l The locale to use |
|
125 | + * @return string Formatted relative date string |
|
126 | + */ |
|
127 | + public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
128 | + if (substr($format, -1) !== '*' && substr($format, -1) !== '*') { |
|
129 | + $format .= '^'; |
|
130 | + } |
|
131 | 131 | |
132 | - return $this->format($timestamp, 'date', $format, $timeZone, $l); |
|
133 | - } |
|
132 | + return $this->format($timestamp, 'date', $format, $timeZone, $l); |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * Gives the relative date of the timestamp |
|
137 | - * Only works for past dates |
|
138 | - * |
|
139 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
140 | - * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
141 | - * @return string Dates returned are: |
|
142 | - * < 1 month => Today, Yesterday, n days ago |
|
143 | - * < 13 month => last month, n months ago |
|
144 | - * >= 13 month => last year, n years ago |
|
145 | - * @param \OCP\IL10N $l The locale to use |
|
146 | - * @return string Formatted date span |
|
147 | - */ |
|
148 | - public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) { |
|
149 | - $l = $this->getLocale($l); |
|
150 | - $timestamp = $this->getDateTime($timestamp); |
|
151 | - $timestamp->setTime(0, 0, 0); |
|
135 | + /** |
|
136 | + * Gives the relative date of the timestamp |
|
137 | + * Only works for past dates |
|
138 | + * |
|
139 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
140 | + * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
141 | + * @return string Dates returned are: |
|
142 | + * < 1 month => Today, Yesterday, n days ago |
|
143 | + * < 13 month => last month, n months ago |
|
144 | + * >= 13 month => last year, n years ago |
|
145 | + * @param \OCP\IL10N $l The locale to use |
|
146 | + * @return string Formatted date span |
|
147 | + */ |
|
148 | + public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) { |
|
149 | + $l = $this->getLocale($l); |
|
150 | + $timestamp = $this->getDateTime($timestamp); |
|
151 | + $timestamp->setTime(0, 0, 0); |
|
152 | 152 | |
153 | - if ($baseTimestamp === null) { |
|
154 | - $baseTimestamp = time(); |
|
155 | - } |
|
156 | - $baseTimestamp = $this->getDateTime($baseTimestamp); |
|
157 | - $baseTimestamp->setTime(0, 0, 0); |
|
158 | - $dateInterval = $timestamp->diff($baseTimestamp); |
|
153 | + if ($baseTimestamp === null) { |
|
154 | + $baseTimestamp = time(); |
|
155 | + } |
|
156 | + $baseTimestamp = $this->getDateTime($baseTimestamp); |
|
157 | + $baseTimestamp->setTime(0, 0, 0); |
|
158 | + $dateInterval = $timestamp->diff($baseTimestamp); |
|
159 | 159 | |
160 | - if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) { |
|
161 | - return $l->t('today'); |
|
162 | - } else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) { |
|
163 | - if ($timestamp > $baseTimestamp) { |
|
164 | - return $l->t('tomorrow'); |
|
165 | - } else { |
|
166 | - return $l->t('yesterday'); |
|
167 | - } |
|
168 | - } else if ($dateInterval->y == 0 && $dateInterval->m == 0) { |
|
169 | - if ($timestamp > $baseTimestamp) { |
|
170 | - return $l->n('in %n day', 'in %n days', $dateInterval->d); |
|
171 | - } else { |
|
172 | - return $l->n('%n day ago', '%n days ago', $dateInterval->d); |
|
173 | - } |
|
174 | - } else if ($dateInterval->y == 0 && $dateInterval->m == 1) { |
|
175 | - if ($timestamp > $baseTimestamp) { |
|
176 | - return $l->t('next month'); |
|
177 | - } else { |
|
178 | - return $l->t('last month'); |
|
179 | - } |
|
180 | - } else if ($dateInterval->y == 0) { |
|
181 | - if ($timestamp > $baseTimestamp) { |
|
182 | - return $l->n('in %n month', 'in %n months', $dateInterval->m); |
|
183 | - } else { |
|
184 | - return $l->n('%n month ago', '%n months ago', $dateInterval->m); |
|
185 | - } |
|
186 | - } else if ($dateInterval->y == 1) { |
|
187 | - if ($timestamp > $baseTimestamp) { |
|
188 | - return $l->t('next year'); |
|
189 | - } else { |
|
190 | - return $l->t('last year'); |
|
191 | - } |
|
192 | - } |
|
193 | - if ($timestamp > $baseTimestamp) { |
|
194 | - return $l->n('in %n year', 'in %n years', $dateInterval->y); |
|
195 | - } else { |
|
196 | - return $l->n('%n year ago', '%n years ago', $dateInterval->y); |
|
197 | - } |
|
198 | - } |
|
160 | + if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) { |
|
161 | + return $l->t('today'); |
|
162 | + } else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) { |
|
163 | + if ($timestamp > $baseTimestamp) { |
|
164 | + return $l->t('tomorrow'); |
|
165 | + } else { |
|
166 | + return $l->t('yesterday'); |
|
167 | + } |
|
168 | + } else if ($dateInterval->y == 0 && $dateInterval->m == 0) { |
|
169 | + if ($timestamp > $baseTimestamp) { |
|
170 | + return $l->n('in %n day', 'in %n days', $dateInterval->d); |
|
171 | + } else { |
|
172 | + return $l->n('%n day ago', '%n days ago', $dateInterval->d); |
|
173 | + } |
|
174 | + } else if ($dateInterval->y == 0 && $dateInterval->m == 1) { |
|
175 | + if ($timestamp > $baseTimestamp) { |
|
176 | + return $l->t('next month'); |
|
177 | + } else { |
|
178 | + return $l->t('last month'); |
|
179 | + } |
|
180 | + } else if ($dateInterval->y == 0) { |
|
181 | + if ($timestamp > $baseTimestamp) { |
|
182 | + return $l->n('in %n month', 'in %n months', $dateInterval->m); |
|
183 | + } else { |
|
184 | + return $l->n('%n month ago', '%n months ago', $dateInterval->m); |
|
185 | + } |
|
186 | + } else if ($dateInterval->y == 1) { |
|
187 | + if ($timestamp > $baseTimestamp) { |
|
188 | + return $l->t('next year'); |
|
189 | + } else { |
|
190 | + return $l->t('last year'); |
|
191 | + } |
|
192 | + } |
|
193 | + if ($timestamp > $baseTimestamp) { |
|
194 | + return $l->n('in %n year', 'in %n years', $dateInterval->y); |
|
195 | + } else { |
|
196 | + return $l->n('%n year ago', '%n years ago', $dateInterval->y); |
|
197 | + } |
|
198 | + } |
|
199 | 199 | |
200 | - /** |
|
201 | - * Formats the time of the given timestamp |
|
202 | - * |
|
203 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
204 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
205 | - * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
206 | - * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
207 | - * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
208 | - * short: e.g. 'h:mm a' => '11:42 AM' |
|
209 | - * The exact format is dependent on the language |
|
210 | - * @param \DateTimeZone $timeZone The timezone to use |
|
211 | - * @param \OCP\IL10N $l The locale to use |
|
212 | - * @return string Formatted time string |
|
213 | - */ |
|
214 | - public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
215 | - return $this->format($timestamp, 'time', $format, $timeZone, $l); |
|
216 | - } |
|
200 | + /** |
|
201 | + * Formats the time of the given timestamp |
|
202 | + * |
|
203 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
204 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
205 | + * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
206 | + * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
207 | + * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
208 | + * short: e.g. 'h:mm a' => '11:42 AM' |
|
209 | + * The exact format is dependent on the language |
|
210 | + * @param \DateTimeZone $timeZone The timezone to use |
|
211 | + * @param \OCP\IL10N $l The locale to use |
|
212 | + * @return string Formatted time string |
|
213 | + */ |
|
214 | + public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
215 | + return $this->format($timestamp, 'time', $format, $timeZone, $l); |
|
216 | + } |
|
217 | 217 | |
218 | - /** |
|
219 | - * Gives the relative past time of the timestamp |
|
220 | - * |
|
221 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
222 | - * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
223 | - * @return string Dates returned are: |
|
224 | - * < 60 sec => seconds ago |
|
225 | - * < 1 hour => n minutes ago |
|
226 | - * < 1 day => n hours ago |
|
227 | - * < 1 month => Yesterday, n days ago |
|
228 | - * < 13 month => last month, n months ago |
|
229 | - * >= 13 month => last year, n years ago |
|
230 | - * @param \OCP\IL10N $l The locale to use |
|
231 | - * @return string Formatted time span |
|
232 | - */ |
|
233 | - public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) { |
|
234 | - $l = $this->getLocale($l); |
|
235 | - $timestamp = $this->getDateTime($timestamp); |
|
236 | - if ($baseTimestamp === null) { |
|
237 | - $baseTimestamp = time(); |
|
238 | - } |
|
239 | - $baseTimestamp = $this->getDateTime($baseTimestamp); |
|
218 | + /** |
|
219 | + * Gives the relative past time of the timestamp |
|
220 | + * |
|
221 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
222 | + * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
223 | + * @return string Dates returned are: |
|
224 | + * < 60 sec => seconds ago |
|
225 | + * < 1 hour => n minutes ago |
|
226 | + * < 1 day => n hours ago |
|
227 | + * < 1 month => Yesterday, n days ago |
|
228 | + * < 13 month => last month, n months ago |
|
229 | + * >= 13 month => last year, n years ago |
|
230 | + * @param \OCP\IL10N $l The locale to use |
|
231 | + * @return string Formatted time span |
|
232 | + */ |
|
233 | + public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) { |
|
234 | + $l = $this->getLocale($l); |
|
235 | + $timestamp = $this->getDateTime($timestamp); |
|
236 | + if ($baseTimestamp === null) { |
|
237 | + $baseTimestamp = time(); |
|
238 | + } |
|
239 | + $baseTimestamp = $this->getDateTime($baseTimestamp); |
|
240 | 240 | |
241 | - $diff = $timestamp->diff($baseTimestamp); |
|
242 | - if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) { |
|
243 | - return $this->formatDateSpan($timestamp, $baseTimestamp, $l); |
|
244 | - } |
|
241 | + $diff = $timestamp->diff($baseTimestamp); |
|
242 | + if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) { |
|
243 | + return $this->formatDateSpan($timestamp, $baseTimestamp, $l); |
|
244 | + } |
|
245 | 245 | |
246 | - if ($diff->h > 0) { |
|
247 | - if ($timestamp > $baseTimestamp) { |
|
248 | - return $l->n('in %n hour', 'in %n hours', $diff->h); |
|
249 | - } else { |
|
250 | - return $l->n('%n hour ago', '%n hours ago', $diff->h); |
|
251 | - } |
|
252 | - } else if ($diff->i > 0) { |
|
253 | - if ($timestamp > $baseTimestamp) { |
|
254 | - return $l->n('in %n minute', 'in %n minutes', $diff->i); |
|
255 | - } else { |
|
256 | - return $l->n('%n minute ago', '%n minutes ago', $diff->i); |
|
257 | - } |
|
258 | - } |
|
259 | - if ($timestamp > $baseTimestamp) { |
|
260 | - return $l->t('in a few seconds'); |
|
261 | - } else { |
|
262 | - return $l->t('seconds ago'); |
|
263 | - } |
|
264 | - } |
|
246 | + if ($diff->h > 0) { |
|
247 | + if ($timestamp > $baseTimestamp) { |
|
248 | + return $l->n('in %n hour', 'in %n hours', $diff->h); |
|
249 | + } else { |
|
250 | + return $l->n('%n hour ago', '%n hours ago', $diff->h); |
|
251 | + } |
|
252 | + } else if ($diff->i > 0) { |
|
253 | + if ($timestamp > $baseTimestamp) { |
|
254 | + return $l->n('in %n minute', 'in %n minutes', $diff->i); |
|
255 | + } else { |
|
256 | + return $l->n('%n minute ago', '%n minutes ago', $diff->i); |
|
257 | + } |
|
258 | + } |
|
259 | + if ($timestamp > $baseTimestamp) { |
|
260 | + return $l->t('in a few seconds'); |
|
261 | + } else { |
|
262 | + return $l->t('seconds ago'); |
|
263 | + } |
|
264 | + } |
|
265 | 265 | |
266 | - /** |
|
267 | - * Formats the date and time of the given timestamp |
|
268 | - * |
|
269 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
270 | - * @param string $formatDate See formatDate() for description |
|
271 | - * @param string $formatTime See formatTime() for description |
|
272 | - * @param \DateTimeZone $timeZone The timezone to use |
|
273 | - * @param \OCP\IL10N $l The locale to use |
|
274 | - * @return string Formatted date and time string |
|
275 | - */ |
|
276 | - public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
277 | - return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
278 | - } |
|
266 | + /** |
|
267 | + * Formats the date and time of the given timestamp |
|
268 | + * |
|
269 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
270 | + * @param string $formatDate See formatDate() for description |
|
271 | + * @param string $formatTime See formatTime() for description |
|
272 | + * @param \DateTimeZone $timeZone The timezone to use |
|
273 | + * @param \OCP\IL10N $l The locale to use |
|
274 | + * @return string Formatted date and time string |
|
275 | + */ |
|
276 | + public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
277 | + return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
278 | + } |
|
279 | 279 | |
280 | - /** |
|
281 | - * Formats the date and time of the given timestamp |
|
282 | - * |
|
283 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
284 | - * @param string $formatDate See formatDate() for description |
|
285 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
286 | - * @param string $formatTime See formatTime() for description |
|
287 | - * @param \DateTimeZone $timeZone The timezone to use |
|
288 | - * @param \OCP\IL10N $l The locale to use |
|
289 | - * @return string Formatted relative date and time string |
|
290 | - */ |
|
291 | - public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
292 | - if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') { |
|
293 | - $formatDate .= '^'; |
|
294 | - } |
|
280 | + /** |
|
281 | + * Formats the date and time of the given timestamp |
|
282 | + * |
|
283 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
284 | + * @param string $formatDate See formatDate() for description |
|
285 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
286 | + * @param string $formatTime See formatTime() for description |
|
287 | + * @param \DateTimeZone $timeZone The timezone to use |
|
288 | + * @param \OCP\IL10N $l The locale to use |
|
289 | + * @return string Formatted relative date and time string |
|
290 | + */ |
|
291 | + public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
292 | + if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') { |
|
293 | + $formatDate .= '^'; |
|
294 | + } |
|
295 | 295 | |
296 | - return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
297 | - } |
|
296 | + return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l); |
|
297 | + } |
|
298 | 298 | |
299 | - /** |
|
300 | - * Formats the date and time of the given timestamp |
|
301 | - * |
|
302 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
303 | - * @param string $type One of 'date', 'datetime' or 'time' |
|
304 | - * @param string $format Format string |
|
305 | - * @param \DateTimeZone $timeZone The timezone to use |
|
306 | - * @param \OCP\IL10N $l The locale to use |
|
307 | - * @return string Formatted date and time string |
|
308 | - */ |
|
309 | - protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
310 | - $l = $this->getLocale($l); |
|
311 | - $timeZone = $this->getTimeZone($timeZone); |
|
312 | - $timestamp = $this->getDateTime($timestamp, $timeZone); |
|
299 | + /** |
|
300 | + * Formats the date and time of the given timestamp |
|
301 | + * |
|
302 | + * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
303 | + * @param string $type One of 'date', 'datetime' or 'time' |
|
304 | + * @param string $format Format string |
|
305 | + * @param \DateTimeZone $timeZone The timezone to use |
|
306 | + * @param \OCP\IL10N $l The locale to use |
|
307 | + * @return string Formatted date and time string |
|
308 | + */ |
|
309 | + protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) { |
|
310 | + $l = $this->getLocale($l); |
|
311 | + $timeZone = $this->getTimeZone($timeZone); |
|
312 | + $timestamp = $this->getDateTime($timestamp, $timeZone); |
|
313 | 313 | |
314 | - return $l->l($type, $timestamp, array( |
|
315 | - 'width' => $format, |
|
316 | - )); |
|
317 | - } |
|
314 | + return $l->l($type, $timestamp, array( |
|
315 | + 'width' => $format, |
|
316 | + )); |
|
317 | + } |
|
318 | 318 | } |