lagdo /
jaxon-dbadmin
| Total Complexity | 79 |
| Total Lines | 451 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Admin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Admin, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class Admin |
||
| 22 | { |
||
| 23 | /** |
||
| 24 | * @var Util |
||
| 25 | */ |
||
| 26 | public $util; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @var DriverInterface |
||
| 30 | */ |
||
| 31 | public $driver; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var Translator |
||
| 35 | */ |
||
| 36 | protected $trans; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The constructor |
||
| 40 | * |
||
| 41 | * @param Util $util |
||
| 42 | * @param DriverInterface $driver |
||
| 43 | * @param Translator $trans |
||
| 44 | */ |
||
| 45 | public function __construct(Util $util, DriverInterface $driver, Translator $trans) |
||
| 50 | } |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Create SQL condition from parsed query string |
||
| 54 | * |
||
| 55 | * @param array $where Parsed query string |
||
| 56 | * @param array $fields |
||
| 57 | * |
||
| 58 | * @return string |
||
| 59 | */ |
||
| 60 | public function where(array $where, array $fields = []) |
||
| 84 | } |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Apply SQL function |
||
| 88 | * |
||
| 89 | * @param string $function |
||
| 90 | * @param string $column escaped column identifier |
||
| 91 | * |
||
| 92 | * @return string |
||
| 93 | */ |
||
| 94 | public function applySqlFunction(string $function, string $column) |
||
| 95 | { |
||
| 96 | return ($function ? ($function == 'unixepoch' ? "DATETIME($column, '$function')" : |
||
| 97 | ($function == 'count distinct' ? 'COUNT(DISTINCT ' : strtoupper("$function(")) . "$column)") : $column); |
||
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Remove current user definer from SQL command |
||
| 102 | * |
||
| 103 | * @param string $query |
||
| 104 | * |
||
| 105 | * @return string |
||
| 106 | */ |
||
| 107 | public function removeDefiner(string $query) |
||
| 108 | { |
||
| 109 | return preg_replace('~^([A-Z =]+) DEFINER=`' . |
||
| 110 | preg_replace('~@(.*)~', '`@`(%|\1)', $this->driver->user()) . |
||
| 111 | '`~', '\1', $query); //! proper escaping of user |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Get the users and hosts |
||
| 116 | * |
||
| 117 | * @param string $database The database name |
||
| 118 | * |
||
| 119 | * @return array |
||
| 120 | */ |
||
| 121 | public function getUsers($database) |
||
| 122 | { |
||
| 123 | // From privileges.inc.php |
||
| 124 | $statement = $this->driver->query("SELECT User, Host FROM mysql." . |
||
| 125 | ($database == "" ? "user" : "db WHERE " . $this->driver->quote($database) . " LIKE Db") . |
||
| 126 | " ORDER BY Host, User"); |
||
| 127 | // $grant = $statement; |
||
| 128 | if (!$statement) { |
||
| 129 | // list logged user, information_schema.USER_PRIVILEGES lists just the current user too |
||
| 130 | $statement = $this->driver->query("SELECT SUBSTRING_INDEX(CURRENT_USER, '@', 1) " . |
||
| 131 | "AS User, SUBSTRING_INDEX(CURRENT_USER, '@', -1) AS Host"); |
||
| 132 | } |
||
| 133 | $users = []; |
||
| 134 | while ($row = $statement->fetchAssoc()) { |
||
| 135 | $users[] = $row; |
||
| 136 | } |
||
| 137 | return $users; |
||
| 138 | } |
||
| 139 | |||
| 140 | /** |
||
| 141 | * Get the grants of a user on a given host |
||
| 142 | * |
||
| 143 | * @param string $user The user name |
||
| 144 | * @param string $host The host name |
||
| 145 | * @param string $password The user password |
||
| 146 | * |
||
| 147 | * @return array |
||
| 148 | */ |
||
| 149 | public function getUserGrants(string $user, string $host, string &$password) |
||
| 150 | { |
||
| 151 | // From user.inc.php |
||
| 152 | $grants = []; |
||
| 153 | |||
| 154 | //! use information_schema for MySQL 5 - column names in column privileges are not escaped |
||
| 155 | if (($statement = $this->driver->query("SHOW GRANTS FOR " . |
||
| 156 | $this->driver->quote($user) . "@" . $this->driver->quote($host)))) { |
||
| 157 | while ($row = $statement->fetchRow()) { |
||
| 158 | if (\preg_match('~GRANT (.*) ON (.*) TO ~', $row[0], $match) && |
||
| 159 | \preg_match_all('~ *([^(,]*[^ ,(])( *\([^)]+\))?~', $match[1], $matches, PREG_SET_ORDER)) { //! escape the part between ON and TO |
||
| 160 | foreach ($matches as $val) { |
||
| 161 | $match2 = $match[2] ?? ''; |
||
| 162 | $val2 = $val[2] ?? ''; |
||
| 163 | if ($val[1] != "USAGE") { |
||
| 164 | $grants["$match2$val2"][$val[1]] = true; |
||
| 165 | } |
||
| 166 | if (\preg_match('~ WITH GRANT OPTION~', $row[0])) { //! don't check inside strings and identifiers |
||
| 167 | $grants["$match2$val2"]["GRANT OPTION"] = true; |
||
| 168 | } |
||
| 169 | } |
||
| 170 | } |
||
| 171 | if (\preg_match("~ IDENTIFIED BY PASSWORD '([^']+)~", $row[0], $match)) { |
||
| 172 | $password = $match[1]; |
||
| 173 | } |
||
| 174 | } |
||
| 175 | } |
||
| 176 | |||
| 177 | return $grants; |
||
| 178 | } |
||
| 179 | |||
| 180 | /** |
||
| 181 | * @param array $features |
||
| 182 | * @param array $contexts |
||
| 183 | * |
||
| 184 | * @return void |
||
| 185 | */ |
||
| 186 | private function makeFeatures(array &$features, array $contexts) |
||
| 187 | { |
||
| 188 | foreach ($contexts as $context) { |
||
| 189 | // Don't take 'Grant option' privileges. |
||
| 190 | if ($row['Privilege'] === 'Grant option') { |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 191 | continue; |
||
| 192 | } |
||
| 193 | // Privileges of 'Server Admin' and 'File access on server' are merged |
||
| 194 | if ($context === 'File access on server') { |
||
| 195 | $context = 'Server Admin'; |
||
| 196 | } |
||
| 197 | $privilege = $row['Privilege']; |
||
| 198 | // Comment for this is 'No privileges - allow connect only' |
||
| 199 | if ($context === 'Server Admin' && $privilege === 'Usage') { |
||
| 200 | continue; |
||
| 201 | } |
||
| 202 | // MySQL bug #30305 |
||
| 203 | if ($context === 'Procedures' && $privilege === 'Create routine') { |
||
| 204 | $context = 'Databases'; |
||
| 205 | } |
||
| 206 | if (!isset($features[$context])) { |
||
| 207 | $features[$context] = []; |
||
| 208 | } |
||
| 209 | $features[$context][$privilege] = $row['Comment']; |
||
| 210 | if ($context === 'Tables' && |
||
| 211 | in_array($privilege, ['Select', 'Insert', 'Update', 'References'])) { |
||
| 212 | $features['Columns'][$privilege] = $row['Comment']; |
||
| 213 | } |
||
| 214 | } |
||
| 215 | } |
||
| 216 | |||
| 217 | /** |
||
| 218 | * Get the user privileges |
||
| 219 | * |
||
| 220 | * @param array $grants The user grants |
||
| 221 | * |
||
| 222 | * @return array |
||
| 223 | */ |
||
| 224 | public function getUserPrivileges(array $grants) |
||
| 280 | } |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Query printed after execution in the message |
||
| 284 | * |
||
| 285 | * @param string $query Executed query |
||
| 286 | * @param string $time Elapsed time |
||
| 287 | * |
||
| 288 | * @return string |
||
| 289 | */ |
||
| 290 | private function messageQuery(string $query, string $time) |
||
| 291 | { |
||
| 292 | if (strlen($query) > 1e6) { |
||
| 293 | // [\x80-\xFF] - valid UTF-8, \n - can end by one-line comment |
||
| 294 | $query = preg_replace('~[\x80-\xFF]+$~', '', substr($query, 0, 1e6)) . "\n…"; |
||
| 295 | } |
||
| 296 | return $query; |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * Execute query |
||
| 301 | * |
||
| 302 | * @param string $query |
||
| 303 | * @param bool $execute |
||
| 304 | * @param bool $failed |
||
| 305 | * @param string $time |
||
| 306 | * |
||
| 307 | * @return bool |
||
| 308 | */ |
||
| 309 | private function executeQuery(string $query, bool $execute = true, bool $failed = false, string $time = '') |
||
| 310 | { |
||
| 311 | if ($execute) { |
||
| 312 | $start = microtime(true); |
||
| 313 | $failed = !$this->driver->query($query); |
||
| 314 | $time = $this->trans->formatTime($start); |
||
| 315 | } |
||
| 316 | if ($failed) { |
||
| 317 | $sql = ''; |
||
| 318 | if ($query) { |
||
| 319 | $sql = $this->messageQuery($query, $time); |
||
| 320 | } |
||
| 321 | throw new Exception($this->driver->error() . $sql); |
||
| 322 | } |
||
| 323 | return true; |
||
| 324 | } |
||
| 325 | |||
| 326 | /** |
||
| 327 | * Execute remembered queries |
||
| 328 | * |
||
| 329 | * @param bool $failed |
||
| 330 | * |
||
| 331 | * @return bool |
||
| 332 | */ |
||
| 333 | private function executeSavedQuery(bool $failed) |
||
| 334 | { |
||
| 335 | list($queries, $time) = $this->driver->queries(); |
||
| 336 | return $this->executeQuery($queries, false, $failed, $time); |
||
| 337 | } |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Find out foreign keys for each column |
||
| 341 | * |
||
| 342 | * @param string $table |
||
| 343 | * |
||
| 344 | * @return array |
||
| 345 | */ |
||
| 346 | public function columnForeignKeys(string $table) |
||
| 347 | { |
||
| 348 | $keys = []; |
||
| 349 | foreach ($this->driver->foreignKeys($table) as $foreignKey) { |
||
| 350 | foreach ($foreignKey->source as $val) { |
||
| 351 | $keys[$val][] = $foreignKey; |
||
| 352 | } |
||
| 353 | } |
||
| 354 | return $keys; |
||
| 355 | } |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Drop old object and create a new one |
||
| 359 | * |
||
| 360 | * @param string $drop Drop old object query |
||
| 361 | * @param string $create Create new object query |
||
| 362 | * @param string $dropCreated Drop new object query |
||
| 363 | * @param string $test Create test object query |
||
| 364 | * @param string $dropTest Drop test object query |
||
| 365 | * @param string $oldName |
||
| 366 | * @param string $newName |
||
| 367 | * |
||
| 368 | * @return string |
||
| 369 | */ |
||
| 370 | protected function dropAndCreate(string $drop, string $create, string $dropCreated, |
||
| 371 | string $test, string $dropTest, string $oldName, string $newName) |
||
| 372 | { |
||
| 373 | if ($oldName == '' && $newName == '') { |
||
| 374 | $this->executeQuery($drop); |
||
| 375 | return 'dropped'; |
||
| 376 | } |
||
| 377 | if ($oldName == '') { |
||
| 378 | $this->executeQuery($create); |
||
| 379 | return 'created'; |
||
| 380 | } |
||
| 381 | if ($oldName != $newName) { |
||
| 382 | $created = $this->driver->execute($create); |
||
| 383 | $dropped = $this->driver->execute($drop); |
||
| 384 | // $this->executeSavedQuery(!($created && $this->driver->execute($drop))); |
||
| 385 | if (!$dropped && $created) { |
||
| 386 | $this->driver->execute($dropCreated); |
||
| 387 | } |
||
| 388 | return 'altered'; |
||
| 389 | } |
||
| 390 | $this->executeSavedQuery(!($this->driver->execute($test) && |
||
| 391 | $this->driver->execute($dropTest) && |
||
| 392 | $this->driver->execute($drop) && $this->driver->execute($create))); |
||
| 393 | return 'altered'; |
||
| 394 | } |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Drop old object and redirect |
||
| 398 | * |
||
| 399 | * @param string $drop Drop old object query |
||
| 400 | * |
||
| 401 | * @return void |
||
| 402 | */ |
||
| 403 | public function drop(string $drop) |
||
| 404 | { |
||
| 405 | $this->executeQuery($drop); |
||
| 406 | } |
||
| 407 | |||
| 408 | /** |
||
| 409 | * Create a view |
||
| 410 | * |
||
| 411 | * @param array $values The view values |
||
| 412 | * |
||
| 413 | * @return bool |
||
| 414 | */ |
||
| 415 | public function createView(array $values) |
||
| 416 | { |
||
| 417 | // From view.inc.php |
||
| 418 | $name = trim($values['name']); |
||
| 419 | $type = $values['materialized'] ? ' MATERIALIZED VIEW ' : ' VIEW '; |
||
| 420 | |||
| 421 | $sql = ($this->driver->jush() === 'mssql' ? 'ALTER' : 'CREATE OR REPLACE') . |
||
| 422 | $type . $this->driver->table($name) . " AS\n" . $values['select']; |
||
| 423 | return $this->executeQuery($sql); |
||
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Update a view |
||
| 428 | * |
||
| 429 | * @param string $view The view name |
||
| 430 | * @param array $values The view values |
||
| 431 | * |
||
| 432 | * @return string |
||
| 433 | */ |
||
| 434 | public function updateView(string $view, array $values) |
||
| 452 | } |
||
| 453 | |||
| 454 | /** |
||
| 455 | * Drop a view |
||
| 456 | * |
||
| 457 | * @param string $view The view name |
||
| 458 | * |
||
| 459 | * @return bool |
||
| 460 | */ |
||
| 461 | public function dropView(string $view) |
||
| 472 | } |
||
| 473 | } |
||
| 474 |
Loading history...