libraries/classes/Replication.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Replication helpers
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PhpMyAdmin;
   9
  10 use PhpMyAdmin\Core;
  11 use PhpMyAdmin\DatabaseInterface;
  12
  13 /**
  14  * PhpMyAdmin\Replication class
  15  *
  16  * @package PhpMyAdmin
  17  */
  18 class Replication
  19 {
  20     /**
  21      * Fill global replication_info variable.
  22      *
  23      * @param string $type               Type: master, slave
  24      * @param string $replicationInfoKey Key in replication_info variable
  25      * @param array  $mysqlInfo          MySQL data about replication
  26      * @param string $mysqlKey           MySQL key
  27      *
  28      * @return array
  29      */
  30     public static function fillInfo(
  31         $type, $replicationInfoKey, array $mysqlInfo, $mysqlKey
  32     ) {
  33         $GLOBALS['replication_info'][$type][$replicationInfoKey]
  34             = empty($mysqlInfo[$mysqlKey])
  35                 ? array()
  36                 : explode(
  37                     ",",
  38                     $mysqlInfo[$mysqlKey]
  39                 );
  40
  41         return $GLOBALS['replication_info'][$type][$replicationInfoKey];
  42     }
  43
  44     /**
  45      * Extracts database or table name from string
  46      *
  47      * @param string $string contains "dbname.tablename"
  48      * @param string $what   what to extract (db|table)
  49      *
  50      * @return string the extracted part
  51      */
  52     public static function extractDbOrTable($string, $what = 'db')
  53     {
  54         $list = explode(".", $string);
  55         if ('db' == $what) {
  56             return $list[0];
  57         } else {
  58             return $list[1];
  59         }
  60     }
  61
  62     /**
  63      * Configures replication slave
  64      *
  65      * @param string $action  possible values: START or STOP
  66      * @param string $control default: null,
  67      *                        possible values: SQL_THREAD or IO_THREAD or null.
  68      *                        If it is set to null, it controls both
  69      *                        SQL_THREAD and IO_THREAD
  70      * @param mixed  $link    mysql link
  71      *
  72      * @return mixed output of DatabaseInterface::tryQuery
  73      */
  74     public static function slaveControl($action, $control = null, $link = null)
  75     {
  76         $action = mb_strtoupper($action);
  77         $control = mb_strtoupper($control);
  78
  79         if ($action != "START" && $action != "STOP") {
  80             return -1;
  81         }
  82         if ($control != "SQL_THREAD" && $control != "IO_THREAD" && $control != null) {
  83             return -1;
  84         }
  85
  86         return $GLOBALS['dbi']->tryQuery($action . " SLAVE " . $control . ";", $link);
  87     }
  88
  89     /**
  90      * Changes master for replication slave
  91      *
  92      * @param string $user     replication user on master
  93      * @param string $password password for the user
  94      * @param string $host     master's hostname or IP
  95      * @param int    $port     port, where mysql is running
  96      * @param array  $pos      position of mysql replication,
  97      *                         array should contain fields File and Position
  98      * @param bool   $stop     shall we stop slave?
  99      * @param bool   $start    shall we start slave?
 100      * @param mixed  $link     mysql link
 101      *
 102      * @return string output of CHANGE MASTER mysql command
 103      */
 104     public static function slaveChangeMaster($user, $password, $host, $port,
 105         array $pos, $stop = true, $start = true, $link = null
 106     ) {
 107         if ($stop) {
 108             self::slaveControl("STOP", null, $link);
 109         }
 110
 111         $out = $GLOBALS['dbi']->tryQuery(
 112             'CHANGE MASTER TO ' .
 113             'MASTER_HOST=\'' . $host . '\',' .
 114             'MASTER_PORT=' . ($port * 1) . ',' .
 115             'MASTER_USER=\'' . $user . '\',' .
 116             'MASTER_PASSWORD=\'' . $password . '\',' .
 117             'MASTER_LOG_FILE=\'' . $pos["File"] . '\',' .
 118             'MASTER_LOG_POS=' . $pos["Position"] . ';', $link
 119         );
 120
 121         if ($start) {
 122             self::slaveControl("START", null, $link);
 123         }
 124
 125         return $out;
 126     }
 127
 128     /**
 129      * This function provides connection to remote mysql server
 130      *
 131      * @param string $user     mysql username
 132      * @param string $password password for the user
 133      * @param string $host     mysql server's hostname or IP
 134      * @param int    $port     mysql remote port
 135      * @param string $socket   path to unix socket
 136      *
 137      * @return mixed $link mysql link on success
 138      */
 139     public static function connectToMaster(
 140         $user, $password, $host = null, $port = null, $socket = null
 141     ) {
 142         $server = array();
 143         $server['user'] = $user;
 144         $server['password'] = $password;
 145         $server["host"] = Core::sanitizeMySQLHost($host);
 146         $server["port"] = $port;
 147         $server["socket"] = $socket;
 148
 149         // 5th parameter set to true means that it's an auxiliary connection
 150         // and we must not go back to login page if it fails
 151         return $GLOBALS['dbi']->connect(DatabaseInterface::CONNECT_AUXILIARY, $server);
 152     }
 153
 154     /**
 155      * Fetches position and file of current binary log on master
 156      *
 157      * @param mixed $link mysql link
 158      *
 159      * @return array an array containing File and Position in MySQL replication
 160      * on master server, useful for self::slaveChangeMaster
 161      */
 162     public static function slaveBinLogMaster($link = null)
 163     {
 164         $data = $GLOBALS['dbi']->fetchResult('SHOW MASTER STATUS', null, null, $link);
 165         $output = array();
 166
 167         if (! empty($data)) {
 168             $output["File"] = $data[0]["File"];
 169             $output["Position"] = $data[0]["Position"];
 170         }
 171         return $output;
 172     }
 173 }