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