includes/site/FileBasedSiteLookup.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  *
  20  * @license GPL-2.0-or-later
  21  */
  22
  23 /**
  24  * Provides a file-based cache of a SiteStore, using a json file.
  25  *
  26  * @since 1.25
  27  * @deprecated since 1.33 Use CachingSiteStore instead.
  28  */
  29 class FileBasedSiteLookup implements SiteLookup {
  30
  31         /**
  32          * @var SiteList
  33          */
  34         private $sites = null;
  35
  36         /**
  37          * @var string
  38          */
  39         private $cacheFile;
  40
  41         /**
  42          * @param string $cacheFile
  43          */
  44         public function __construct( $cacheFile ) {
  45                 wfDeprecated( __CLASS__, '1.33' );
  46                 $this->cacheFile = $cacheFile;
  47         }
  48
  49         /**
  50          * @since 1.25
  51          *
  52          * @return SiteList
  53          */
  54         public function getSites() {
  55                 if ( $this->sites === null ) {
  56                         $this->sites = $this->loadSitesFromCache();
  57                 }
  58
  59                 return $this->sites;
  60         }
  61
  62         /**
  63          * @param string $globalId
  64          *
  65          * @since 1.25
  66          *
  67          * @return Site|null
  68          */
  69         public function getSite( $globalId ) {
  70                 $sites = $this->getSites();
  71
  72                 return $sites->hasSite( $globalId ) ? $sites->getSite( $globalId ) : null;
  73         }
  74
  75         /**
  76          * @return SiteList
  77          */
  78         private function loadSitesFromCache() {
  79                 $data = $this->loadJsonFile();
  80
  81                 $sites = new SiteList();
  82
  83                 // @todo lazy initialize the site objects in the site list (e.g. only when needed to access)
  84                 foreach ( $data['sites'] as $siteArray ) {
  85                         $sites[] = $this->newSiteFromArray( $siteArray );
  86                 }
  87
  88                 return $sites;
  89         }
  90
  91         /**
  92          * @throws MWException
  93          * @return array see docs/sitescache.txt for format of the array.
  94          */
  95         private function loadJsonFile() {
  96                 if ( !is_readable( $this->cacheFile ) ) {
  97                         throw new MWException( 'SiteList cache file not found.' );
  98                 }
  99
 100                 $contents = file_get_contents( $this->cacheFile );
 101                 $data = json_decode( $contents, true );
 102
 103                 if ( !is_array( $data ) || !is_array( $data['sites'] )
 104                         || !array_key_exists( 'sites', $data )
 105                 ) {
 106                         throw new MWException( 'SiteStore json cache data is invalid.' );
 107                 }
 108
 109                 return $data;
 110         }
 111
 112         /**
 113          * @param array $data
 114          *
 115          * @return Site
 116          */
 117         private function newSiteFromArray( array $data ) {
 118                 $siteType = array_key_exists( 'type', $data ) ? $data['type'] : Site::TYPE_UNKNOWN;
 119                 $site = Site::newForType( $siteType );
 120
 121                 $site->setGlobalId( $data['globalid'] );
 122                 $site->setForward( $data['forward'] );
 123                 $site->setGroup( $data['group'] );
 124                 $site->setLanguageCode( $data['language'] );
 125                 $site->setSource( $data['source'] );
 126                 $site->setExtraData( $data['data'] );
 127                 $site->setExtraConfig( $data['config'] );
 128
 129                 foreach ( $data['identifiers'] as $identifier ) {
 130                         $site->addLocalId( $identifier['type'], $identifier['key'] );
 131                 }
 132
 133                 return $site;
 134         }
 135
 136 }