wikimedia /
mediawiki
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like DatabaseMysqlBase 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 DatabaseMysqlBase, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | abstract class DatabaseMysqlBase extends DatabaseBase { |
||
| 33 | /** @var MysqlMasterPos */ |
||
| 34 | protected $lastKnownReplicaPos; |
||
| 35 | /** @var string Method to detect replica DB lag */ |
||
| 36 | protected $lagDetectionMethod; |
||
| 37 | /** @var array Method to detect replica DB lag */ |
||
| 38 | protected $lagDetectionOptions = []; |
||
| 39 | /** @var bool bool Whether to use GTID methods */ |
||
| 40 | protected $useGTIDs = false; |
||
| 41 | /** @var string|null */ |
||
| 42 | protected $sslKeyPath; |
||
| 43 | /** @var string|null */ |
||
| 44 | protected $sslCertPath; |
||
| 45 | /** @var string|null */ |
||
| 46 | protected $sslCAPath; |
||
| 47 | /** @var string[]|null */ |
||
| 48 | protected $sslCiphers; |
||
| 49 | /** @var string sql_mode value to send on connection */ |
||
| 50 | protected $sqlMode; |
||
| 51 | /** @var bool Use experimental UTF-8 transmission encoding */ |
||
| 52 | protected $utf8Mode; |
||
| 53 | |||
| 54 | /** @var string|null */ |
||
| 55 | private $serverVersion = null; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Additional $params include: |
||
| 59 | * - lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat). |
||
| 60 | * pt-heartbeat assumes the table is at heartbeat.heartbeat |
||
| 61 | * and uses UTC timestamps in the heartbeat.ts column. |
||
| 62 | * (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html) |
||
| 63 | * - lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change |
||
| 64 | * the default behavior. Normally, the heartbeat row with the server |
||
| 65 | * ID of this server's master will be used. Set the "conds" field to |
||
| 66 | * override the query conditions, e.g. ['shard' => 's1']. |
||
| 67 | * - useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible. |
||
| 68 | * - sslKeyPath : path to key file [default: null] |
||
| 69 | * - sslCertPath : path to certificate file [default: null] |
||
| 70 | * - sslCAPath : parth to certificate authority PEM files [default: null] |
||
| 71 | * - sslCiphers : array list of allowable ciphers [default: null] |
||
| 72 | * @param array $params |
||
| 73 | */ |
||
| 74 | function __construct( array $params ) { |
||
| 93 | |||
| 94 | /** |
||
| 95 | * @return string |
||
| 96 | */ |
||
| 97 | function getType() { |
||
| 100 | |||
| 101 | /** |
||
| 102 | * @param string $server |
||
| 103 | * @param string $user |
||
| 104 | * @param string $password |
||
| 105 | * @param string $dbName |
||
| 106 | * @throws Exception|DBConnectionError |
||
| 107 | * @return bool |
||
| 108 | */ |
||
| 109 | function open( $server, $user, $password, $dbName ) { |
||
| 204 | |||
| 205 | /** |
||
| 206 | * Set the character set information right after connection |
||
| 207 | * @return bool |
||
| 208 | */ |
||
| 209 | protected function connectInitCharset() { |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Open a connection to a MySQL server |
||
| 221 | * |
||
| 222 | * @param string $realServer |
||
| 223 | * @return mixed Raw connection |
||
| 224 | * @throws DBConnectionError |
||
| 225 | */ |
||
| 226 | abstract protected function mysqlConnect( $realServer ); |
||
| 227 | |||
| 228 | /** |
||
| 229 | * Set the character set of the MySQL link |
||
| 230 | * |
||
| 231 | * @param string $charset |
||
| 232 | * @return bool |
||
| 233 | */ |
||
| 234 | abstract protected function mysqlSetCharset( $charset ); |
||
| 235 | |||
| 236 | /** |
||
| 237 | * @param ResultWrapper|resource $res |
||
| 238 | * @throws DBUnexpectedError |
||
| 239 | */ |
||
| 240 | View Code Duplication | function freeResult( $res ) { |
|
| 251 | |||
| 252 | /** |
||
| 253 | * Free result memory |
||
| 254 | * |
||
| 255 | * @param resource $res Raw result |
||
| 256 | * @return bool |
||
| 257 | */ |
||
| 258 | abstract protected function mysqlFreeResult( $res ); |
||
| 259 | |||
| 260 | /** |
||
| 261 | * @param ResultWrapper|resource $res |
||
| 262 | * @return stdClass|bool |
||
| 263 | * @throws DBUnexpectedError |
||
| 264 | */ |
||
| 265 | View Code Duplication | function fetchObject( $res ) { |
|
| 287 | |||
| 288 | /** |
||
| 289 | * Fetch a result row as an object |
||
| 290 | * |
||
| 291 | * @param resource $res Raw result |
||
| 292 | * @return stdClass |
||
| 293 | */ |
||
| 294 | abstract protected function mysqlFetchObject( $res ); |
||
| 295 | |||
| 296 | /** |
||
| 297 | * @param ResultWrapper|resource $res |
||
| 298 | * @return array|bool |
||
| 299 | * @throws DBUnexpectedError |
||
| 300 | */ |
||
| 301 | View Code Duplication | function fetchRow( $res ) { |
|
| 323 | |||
| 324 | /** |
||
| 325 | * Fetch a result row as an associative and numeric array |
||
| 326 | * |
||
| 327 | * @param resource $res Raw result |
||
| 328 | * @return array |
||
| 329 | */ |
||
| 330 | abstract protected function mysqlFetchArray( $res ); |
||
| 331 | |||
| 332 | /** |
||
| 333 | * @throws DBUnexpectedError |
||
| 334 | * @param ResultWrapper|resource $res |
||
| 335 | * @return int |
||
| 336 | */ |
||
| 337 | function numRows( $res ) { |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Get number of rows in result |
||
| 355 | * |
||
| 356 | * @param resource $res Raw result |
||
| 357 | * @return int |
||
| 358 | */ |
||
| 359 | abstract protected function mysqlNumRows( $res ); |
||
| 360 | |||
| 361 | /** |
||
| 362 | * @param ResultWrapper|resource $res |
||
| 363 | * @return int |
||
| 364 | */ |
||
| 365 | function numFields( $res ) { |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Get number of fields in result |
||
| 375 | * |
||
| 376 | * @param resource $res Raw result |
||
| 377 | * @return int |
||
| 378 | */ |
||
| 379 | abstract protected function mysqlNumFields( $res ); |
||
| 380 | |||
| 381 | /** |
||
| 382 | * @param ResultWrapper|resource $res |
||
| 383 | * @param int $n |
||
| 384 | * @return string |
||
| 385 | */ |
||
| 386 | function fieldName( $res, $n ) { |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Get the name of the specified field in a result |
||
| 396 | * |
||
| 397 | * @param ResultWrapper|resource $res |
||
| 398 | * @param int $n |
||
| 399 | * @return string |
||
| 400 | */ |
||
| 401 | abstract protected function mysqlFieldName( $res, $n ); |
||
| 402 | |||
| 403 | /** |
||
| 404 | * mysql_field_type() wrapper |
||
| 405 | * @param ResultWrapper|resource $res |
||
| 406 | * @param int $n |
||
| 407 | * @return string |
||
| 408 | */ |
||
| 409 | public function fieldType( $res, $n ) { |
||
| 416 | |||
| 417 | /** |
||
| 418 | * Get the type of the specified field in a result |
||
| 419 | * |
||
| 420 | * @param ResultWrapper|resource $res |
||
| 421 | * @param int $n |
||
| 422 | * @return string |
||
| 423 | */ |
||
| 424 | abstract protected function mysqlFieldType( $res, $n ); |
||
| 425 | |||
| 426 | /** |
||
| 427 | * @param ResultWrapper|resource $res |
||
| 428 | * @param int $row |
||
| 429 | * @return bool |
||
| 430 | */ |
||
| 431 | function dataSeek( $res, $row ) { |
||
| 438 | |||
| 439 | /** |
||
| 440 | * Move internal result pointer |
||
| 441 | * |
||
| 442 | * @param ResultWrapper|resource $res |
||
| 443 | * @param int $row |
||
| 444 | * @return bool |
||
| 445 | */ |
||
| 446 | abstract protected function mysqlDataSeek( $res, $row ); |
||
| 447 | |||
| 448 | /** |
||
| 449 | * @return string |
||
| 450 | */ |
||
| 451 | function lastError() { |
||
| 469 | |||
| 470 | /** |
||
| 471 | * Returns the text of the error message from previous MySQL operation |
||
| 472 | * |
||
| 473 | * @param resource $conn Raw connection |
||
| 474 | * @return string |
||
| 475 | */ |
||
| 476 | abstract protected function mysqlError( $conn = null ); |
||
| 477 | |||
| 478 | /** |
||
| 479 | * @param string $table |
||
| 480 | * @param array $uniqueIndexes |
||
| 481 | * @param array $rows |
||
| 482 | * @param string $fname |
||
| 483 | * @return ResultWrapper |
||
| 484 | */ |
||
| 485 | function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) { |
||
| 488 | |||
| 489 | /** |
||
| 490 | * Estimate rows in dataset |
||
| 491 | * Returns estimated count, based on EXPLAIN output |
||
| 492 | * Takes same arguments as Database::select() |
||
| 493 | * |
||
| 494 | * @param string|array $table |
||
| 495 | * @param string|array $vars |
||
| 496 | * @param string|array $conds |
||
| 497 | * @param string $fname |
||
| 498 | * @param string|array $options |
||
| 499 | * @return bool|int |
||
| 500 | */ |
||
| 501 | public function estimateRowCount( $table, $vars = '*', $conds = '', |
||
| 520 | |||
| 521 | function tableExists( $table, $fname = __METHOD__ ) { |
||
| 526 | |||
| 527 | /** |
||
| 528 | * @param string $table |
||
| 529 | * @param string $field |
||
| 530 | * @return bool|MySQLField |
||
| 531 | */ |
||
| 532 | function fieldInfo( $table, $field ) { |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Get column information from a result |
||
| 551 | * |
||
| 552 | * @param resource $res Raw result |
||
| 553 | * @param int $n |
||
| 554 | * @return stdClass |
||
| 555 | */ |
||
| 556 | abstract protected function mysqlFetchField( $res, $n ); |
||
| 557 | |||
| 558 | /** |
||
| 559 | * Get information about an index into an object |
||
| 560 | * Returns false if the index does not exist |
||
| 561 | * |
||
| 562 | * @param string $table |
||
| 563 | * @param string $index |
||
| 564 | * @param string $fname |
||
| 565 | * @return bool|array|null False or null on failure |
||
| 566 | */ |
||
| 567 | function indexInfo( $table, $index, $fname = __METHOD__ ) { |
||
| 591 | |||
| 592 | /** |
||
| 593 | * @param string $s |
||
| 594 | * @return string |
||
| 595 | */ |
||
| 596 | function strencode( $s ) { |
||
| 599 | |||
| 600 | /** |
||
| 601 | * @param string $s |
||
| 602 | * @return mixed |
||
| 603 | */ |
||
| 604 | abstract protected function mysqlRealEscapeString( $s ); |
||
| 605 | |||
| 606 | /** |
||
| 607 | * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes". |
||
| 608 | * |
||
| 609 | * @param string $s |
||
| 610 | * @return string |
||
| 611 | */ |
||
| 612 | public function addIdentifierQuotes( $s ) { |
||
| 617 | |||
| 618 | /** |
||
| 619 | * @param string $name |
||
| 620 | * @return bool |
||
| 621 | */ |
||
| 622 | public function isQuotedIdentifier( $name ) { |
||
| 625 | |||
| 626 | function getLag() { |
||
| 633 | |||
| 634 | /** |
||
| 635 | * @return string |
||
| 636 | */ |
||
| 637 | protected function getLagDetectionMethod() { |
||
| 640 | |||
| 641 | /** |
||
| 642 | * @return bool|int |
||
| 643 | */ |
||
| 644 | protected function getLagFromSlaveStatus() { |
||
| 653 | |||
| 654 | /** |
||
| 655 | * @return bool|float |
||
| 656 | */ |
||
| 657 | protected function getLagFromPtHeartbeat() { |
||
| 699 | |||
| 700 | protected function getMasterServerInfo() { |
||
| 737 | |||
| 738 | /** |
||
| 739 | * @param array $conds WHERE clause conditions to find a row |
||
| 740 | * @return array (heartbeat `ts` column value or null, UNIX timestamp) for the newest beat |
||
| 741 | * @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html |
||
| 742 | */ |
||
| 743 | protected function getHeartbeatData( array $conds ) { |
||
| 755 | |||
| 756 | public function getApproximateLagStatus() { |
||
| 773 | |||
| 774 | function masterPosWait( DBMasterPos $pos, $timeout ) { |
||
| 821 | |||
| 822 | /** |
||
| 823 | * Get the position of the master from SHOW SLAVE STATUS |
||
| 824 | * |
||
| 825 | * @return MySQLMasterPos|bool |
||
| 826 | */ |
||
| 827 | function getSlavePos() { |
||
| 849 | |||
| 850 | /** |
||
| 851 | * Get the position of the master from SHOW MASTER STATUS |
||
| 852 | * |
||
| 853 | * @return MySQLMasterPos|bool |
||
| 854 | */ |
||
| 855 | function getMasterPos() { |
||
| 874 | |||
| 875 | public function serverIsReadOnly() { |
||
| 881 | |||
| 882 | /** |
||
| 883 | * @param string $index |
||
| 884 | * @return string |
||
| 885 | */ |
||
| 886 | function useIndexClause( $index ) { |
||
| 889 | |||
| 890 | /** |
||
| 891 | * @param string $index |
||
| 892 | * @return string |
||
| 893 | */ |
||
| 894 | function ignoreIndexClause( $index ) { |
||
| 897 | |||
| 898 | /** |
||
| 899 | * @return string |
||
| 900 | */ |
||
| 901 | function lowPriorityOption() { |
||
| 904 | |||
| 905 | /** |
||
| 906 | * @return string |
||
| 907 | */ |
||
| 908 | public function getSoftwareLink() { |
||
| 922 | |||
| 923 | /** |
||
| 924 | * @return string |
||
| 925 | */ |
||
| 926 | public function getServerVersion() { |
||
| 935 | |||
| 936 | /** |
||
| 937 | * @param array $options |
||
| 938 | */ |
||
| 939 | public function setSessionOptions( array $options ) { |
||
| 946 | |||
| 947 | /** |
||
| 948 | * @param string $sql |
||
| 949 | * @param string $newLine |
||
| 950 | * @return bool |
||
| 951 | */ |
||
| 952 | public function streamStatementEnd( &$sql, &$newLine ) { |
||
| 961 | |||
| 962 | /** |
||
| 963 | * Check to see if a named lock is available. This is non-blocking. |
||
| 964 | * |
||
| 965 | * @param string $lockName Name of lock to poll |
||
| 966 | * @param string $method Name of method calling us |
||
| 967 | * @return bool |
||
| 968 | * @since 1.20 |
||
| 969 | */ |
||
| 970 | View Code Duplication | public function lockIsFree( $lockName, $method ) { |
|
| 977 | |||
| 978 | /** |
||
| 979 | * @param string $lockName |
||
| 980 | * @param string $method |
||
| 981 | * @param int $timeout |
||
| 982 | * @return bool |
||
| 983 | */ |
||
| 984 | View Code Duplication | public function lock( $lockName, $method, $timeout = 5 ) { |
|
| 998 | |||
| 999 | /** |
||
| 1000 | * FROM MYSQL DOCS: |
||
| 1001 | * http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock |
||
| 1002 | * @param string $lockName |
||
| 1003 | * @param string $method |
||
| 1004 | * @return bool |
||
| 1005 | */ |
||
| 1006 | View Code Duplication | public function unlock( $lockName, $method ) { |
|
| 1020 | |||
| 1021 | private function makeLockName( $lockName ) { |
||
| 1026 | |||
| 1027 | public function namedLocksEnqueue() { |
||
| 1030 | |||
| 1031 | /** |
||
| 1032 | * @param array $read |
||
| 1033 | * @param array $write |
||
| 1034 | * @param string $method |
||
| 1035 | * @param bool $lowPriority |
||
| 1036 | * @return bool |
||
| 1037 | */ |
||
| 1038 | public function lockTables( $read, $write, $method, $lowPriority = true ) { |
||
| 1055 | |||
| 1056 | /** |
||
| 1057 | * @param string $method |
||
| 1058 | * @return bool |
||
| 1059 | */ |
||
| 1060 | public function unlockTables( $method ) { |
||
| 1065 | |||
| 1066 | /** |
||
| 1067 | * @param bool $value |
||
| 1068 | */ |
||
| 1069 | public function setBigSelects( $value = true ) { |
||
| 1084 | |||
| 1085 | /** |
||
| 1086 | * DELETE where the condition is a join. MySql uses multi-table deletes. |
||
| 1087 | * @param string $delTable |
||
| 1088 | * @param string $joinTable |
||
| 1089 | * @param string $delVar |
||
| 1090 | * @param string $joinVar |
||
| 1091 | * @param array|string $conds |
||
| 1092 | * @param bool|string $fname |
||
| 1093 | * @throws DBUnexpectedError |
||
| 1094 | * @return bool|ResultWrapper |
||
| 1095 | */ |
||
| 1096 | View Code Duplication | function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__ ) { |
|
| 1111 | |||
| 1112 | /** |
||
| 1113 | * @param string $table |
||
| 1114 | * @param array $rows |
||
| 1115 | * @param array $uniqueIndexes |
||
| 1116 | * @param array $set |
||
| 1117 | * @param string $fname |
||
| 1118 | * @return bool |
||
| 1119 | */ |
||
| 1120 | public function upsert( $table, array $rows, array $uniqueIndexes, |
||
| 1144 | |||
| 1145 | /** |
||
| 1146 | * Determines how long the server has been up |
||
| 1147 | * |
||
| 1148 | * @return int |
||
| 1149 | */ |
||
| 1150 | function getServerUptime() { |
||
| 1155 | |||
| 1156 | /** |
||
| 1157 | * Determines if the last failure was due to a deadlock |
||
| 1158 | * |
||
| 1159 | * @return bool |
||
| 1160 | */ |
||
| 1161 | function wasDeadlock() { |
||
| 1164 | |||
| 1165 | /** |
||
| 1166 | * Determines if the last failure was due to a lock timeout |
||
| 1167 | * |
||
| 1168 | * @return bool |
||
| 1169 | */ |
||
| 1170 | function wasLockTimeout() { |
||
| 1173 | |||
| 1174 | function wasErrorReissuable() { |
||
| 1177 | |||
| 1178 | /** |
||
| 1179 | * Determines if the last failure was due to the database being read-only. |
||
| 1180 | * |
||
| 1181 | * @return bool |
||
| 1182 | */ |
||
| 1183 | function wasReadOnlyError() { |
||
| 1187 | |||
| 1188 | function wasConnectionError( $errno ) { |
||
| 1191 | |||
| 1192 | /** |
||
| 1193 | * Get the underlying binding handle, mConn |
||
| 1194 | * |
||
| 1195 | * Makes sure that mConn is set (disconnects and ping() failure can unset it). |
||
| 1196 | * This catches broken callers than catch and ignore disconnection exceptions. |
||
| 1197 | * Unlike checking isOpen(), this is safe to call inside of open(). |
||
| 1198 | * |
||
| 1199 | * @return resource|object |
||
| 1200 | * @throws DBUnexpectedError |
||
| 1201 | * @since 1.26 |
||
| 1202 | */ |
||
| 1203 | protected function getBindingHandle() { |
||
| 1213 | |||
| 1214 | /** |
||
| 1215 | * @param string $oldName |
||
| 1216 | * @param string $newName |
||
| 1217 | * @param bool $temporary |
||
| 1218 | * @param string $fname |
||
| 1219 | * @return bool |
||
| 1220 | */ |
||
| 1221 | function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ ) { |
||
| 1229 | |||
| 1230 | /** |
||
| 1231 | * List all tables on the database |
||
| 1232 | * |
||
| 1233 | * @param string $prefix Only show tables with this prefix, e.g. mw_ |
||
| 1234 | * @param string $fname Calling function name |
||
| 1235 | * @return array |
||
| 1236 | */ |
||
| 1237 | function listTables( $prefix = null, $fname = __METHOD__ ) { |
||
| 1253 | |||
| 1254 | /** |
||
| 1255 | * @param string $tableName |
||
| 1256 | * @param string $fName |
||
| 1257 | * @return bool|ResultWrapper |
||
| 1258 | */ |
||
| 1259 | View Code Duplication | public function dropTable( $tableName, $fName = __METHOD__ ) { |
|
| 1266 | |||
| 1267 | /** |
||
| 1268 | * @return array |
||
| 1269 | */ |
||
| 1270 | protected function getDefaultSchemaVars() { |
||
| 1281 | |||
| 1282 | /** |
||
| 1283 | * Get status information from SHOW STATUS in an associative array |
||
| 1284 | * |
||
| 1285 | * @param string $which |
||
| 1286 | * @return array |
||
| 1287 | */ |
||
| 1288 | function getMysqlStatus( $which = "%" ) { |
||
| 1298 | |||
| 1299 | /** |
||
| 1300 | * Lists VIEWs in the database |
||
| 1301 | * |
||
| 1302 | * @param string $prefix Only show VIEWs with this prefix, eg. |
||
| 1303 | * unit_test_, or $wgDBprefix. Default: null, would return all views. |
||
| 1304 | * @param string $fname Name of calling function |
||
| 1305 | * @return array |
||
| 1306 | * @since 1.22 |
||
| 1307 | */ |
||
| 1308 | public function listViews( $prefix = null, $fname = __METHOD__ ) { |
||
| 1337 | |||
| 1338 | /** |
||
| 1339 | * Differentiates between a TABLE and a VIEW. |
||
| 1340 | * |
||
| 1341 | * @param string $name Name of the TABLE/VIEW to test |
||
| 1342 | * @param string $prefix |
||
| 1343 | * @return bool |
||
| 1344 | * @since 1.22 |
||
| 1345 | */ |
||
| 1346 | public function isView( $name, $prefix = null ) { |
||
| 1349 | } |
||
| 1350 | |||
| 1351 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: