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.
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.
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
20 * @license GNU GPL v2+
24 * Provides a file-based cache of a SiteStore. The sites are stored in
25 * a json file. (see docs/sitescache.txt regarding format)
27 * The cache can be built with the rebuildSitesCache.php maintenance script,
28 * and a MediaWiki instance can be setup to use this by setting the
29 * 'wgSitesCacheFile' configuration to the cache file location.
33 class FileBasedSiteLookup
implements SiteLookup
{
38 private $sites = null;
48 private $languageCodeMapping = [];
51 * @param string $cacheFile
53 public function __construct( $cacheFile ) {
54 $this->cacheFile
= $cacheFile;
62 public function getSites() {
63 if ( $this->sites
=== null ) {
64 $this->sites
= $this->loadSitesFromCache();
71 * @param string $globalId
77 public function getSite( $globalId ) {
78 $sites = $this->getSites();
80 return $sites->hasSite( $globalId ) ?
$sites->getSite( $globalId ) : null;
86 private function loadSitesFromCache() {
87 $data = $this->loadJsonFile();
89 $sites = new SiteList();
91 // @todo lazy initialize the site objects in the site list (e.g. only when needed to access)
92 foreach ( $data['sites'] as $siteArray ) {
93 $sites[] = $this->newSiteFromArray( $siteArray );
100 * @throws MWException
101 * @return array see docs/sitescache.txt for format of the array.
103 private function loadJsonFile() {
104 if ( !is_readable( $this->cacheFile
) ) {
105 throw new MWException( 'SiteList cache file not found.' );
108 $contents = file_get_contents( $this->cacheFile
);
109 $data = json_decode( $contents, true );
111 if ( !is_array( $data ) ||
!is_array( $data['sites'] )
112 ||
!array_key_exists( 'sites', $data )
114 throw new MWException( 'SiteStore json cache data is invalid.' );
125 private function newSiteFromArray( array $data ) {
126 $languageCode = $data['language'];
127 if ( isset( $this->languageCodeMapping
[ $languageCode ] ) ) {
128 $languageCode = $this->languageCodeMapping
[ $languageCode ];
131 $siteType = array_key_exists( 'type', $data ) ?
$data['type'] : Site
::TYPE_UNKNOWN
;
132 $site = Site
::newForType( $siteType );
134 $site->setGlobalId( $data['globalid'] );
135 $site->setForward( $data['forward'] );
136 $site->setGroup( $data['group'] );
137 $site->setLanguageCode( $languageCode );
138 $site->setSource( $data['source'] );
139 $site->setExtraData( $data['data'] );
140 $site->setExtraConfig( $data['config'] );
142 foreach ( $data['identifiers'] as $identifier ) {
143 $site->addLocalId( $identifier['type'], $identifier['key'] );
150 * Provide an array that maps language codes
152 * @param string[] $newMapping
154 public function setLanguageCodeMapping( array $newMapping ) {
155 $this->languageCodeMapping
= $newMapping;