includes/filerepo/ForeignDBViaLBRepo.php

   1 <?php
   2 /**
   3  * A foreign repository with a MediaWiki database accessible via the configured LBFactory.
   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 FileRepo
  22  */
  23
  24 /**
  25  * A foreign repository with a MediaWiki database accessible via the configured LBFactory
  26  *
  27  * @ingroup FileRepo
  28  */
  29 class ForeignDBViaLBRepo extends LocalRepo {
  30         protected $wiki;
  31         protected $dbName;
  32         protected $tablePrefix;
  33         protected $fileFactory = array( 'ForeignDBFile', 'newFromTitle' );
  34         protected $fileFromRowFactory = array( 'ForeignDBFile', 'newFromRow' );
  35
  36         /**
  37          * @param $info array|null
  38          */
  39         function __construct( $info ) {
  40                 parent::__construct( $info );
  41                 $this->wiki = $info['wiki'];
  42                 list( $this->dbName, $this->tablePrefix ) = wfSplitWikiID( $this->wiki );
  43                 $this->hasSharedCache = $info['hasSharedCache'];
  44         }
  45
  46         /**
  47          * @return DatabaseBase
  48          */
  49         function getMasterDB() {
  50                 return wfGetDB( DB_MASTER, array(), $this->wiki );
  51         }
  52
  53         /**
  54          * @return DatabaseBase
  55          */
  56         function getSlaveDB() {
  57                 return wfGetDB( DB_SLAVE, array(), $this->wiki );
  58         }
  59
  60         function hasSharedCache() {
  61                 return $this->hasSharedCache;
  62         }
  63
  64         /**
  65          * Get a key on the primary cache for this repository.
  66          * Returns false if the repository's cache is not accessible at this site.
  67          * The parameters are the parts of the key, as for wfMemcKey().
  68          * @return bool|string
  69          */
  70         function getSharedCacheKey( /*...*/ ) {
  71                 if ( $this->hasSharedCache() ) {
  72                         $args = func_get_args();
  73                         array_unshift( $args, $this->wiki );
  74
  75                         return implode( ':', $args );
  76                 } else {
  77                         return false;
  78                 }
  79         }
  80
  81         protected function assertWritableRepo() {
  82                 throw new MWException( get_class( $this ) . ': write operations are not supported.' );
  83         }
  84 }