maintenance/getReplicaServer.php

   1 <?php
   2 /**
   3  * Reports the hostname of a replica DB server.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 use MediaWiki\Maintenance\Maintenance;
  25
  26 // @codeCoverageIgnoreStart
  27 require_once __DIR__ . '/Maintenance.php';
  28 // @codeCoverageIgnoreEnd
  29
  30 /**
  31  * Maintenance script that reports the hostname of a replica DB server.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class GetReplicaServer extends Maintenance {
  36         public function __construct() {
  37                 parent::__construct();
  38                 $this->addOption( "group", "Query group to check specifically" );
  39                 $this->addOption( 'cluster', 'Use an external cluster by name', false, true );
  40                 $this->addDescription( 'Report the hostname of a replica DB server' );
  41         }
  42
  43         public function execute() {
  44                 $lbf = $this->getServiceContainer()->getDBLoadBalancerFactory();
  45                 if ( $this->hasOption( 'cluster' ) ) {
  46                         try {
  47                                 $lb = $lbf->getExternalLB( $this->getOption( 'cluster' ) );
  48                         } catch ( InvalidArgumentException $e ) {
  49                                 $this->fatalError( 'Error: ' . $e->getMessage() );
  50                         }
  51                 } else {
  52                         $lb = $lbf->getMainLB();
  53                 }
  54
  55                 $group = $this->getOption( 'group', false );
  56                 $index = $lb->getReaderIndex( $group );
  57                 if ( $index === false && $group ) {
  58                         // retry without the group; it may not exist
  59                         $index = $lb->getReaderIndex( false );
  60                 }
  61                 if ( $index === false ) {
  62                         $this->fatalError( 'Error: unable to get reader index' );
  63                 }
  64
  65                 $this->output( $lb->getServerName( $index ) . "\n" );
  66         }
  67 }
  68
  69 // @codeCoverageIgnoreStart
  70 $maintClass = GetReplicaServer::class;
  71 require_once RUN_MAINTENANCE_IF_MAIN;
  72 // @codeCoverageIgnoreEnd