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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
<?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
*/
namespace MediaWiki\Site;
use Wikimedia\ObjectCache\BagOStuff;
/**
* Hold a configured list of sites (SiteList), with a caching layer.
*
* @internal For use by core ServiceWiring only. The public interface is SiteStore
* @ingroup Site
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
* @author Katie Filbert < aude.wiki@gmail.com >
*/
class CachingSiteStore implements SiteStore {
/** @var SiteStore */
private $siteStore;
/** @var BagOStuff */
private $cache;
/** @var string|null */
private $cacheKey = null;
/** @var SiteList|null */
private $sites = null;
/**
* @param SiteStore $siteStore
* @param BagOStuff $cache
*/
public function __construct(
SiteStore $siteStore,
BagOStuff $cache
) {
$this->siteStore = $siteStore;
$this->cache = $cache;
}
/**
* Constructs a cache key to use for caching the list of sites.
*
* This includes the concrete class name of the site list as well as a version identifier
* for the list's serialization, to avoid problems when unserializing site lists serialized
* by an older version, e.g. when reading from a cache.
*
* The cache key also includes information about where the sites were loaded from, e.g.
* the name of a database table.
*
* @see SiteList::getSerialVersionId
*
* @return string The cache key.
*/
private function getCacheKey() {
if ( $this->cacheKey === null ) {
$version = SiteList::getSerialVersionId();
$this->cacheKey = $this->cache->makeKey( 'site-SiteList', $version );
}
return $this->cacheKey;
}
/**
* @see SiteStore::getSites
*
* @since 1.25
* @return SiteList
*/
public function getSites() {
if ( $this->sites === null ) {
$this->sites = $this->cache->getWithSetCallback(
$this->getCacheKey(),
BagOStuff::TTL_HOUR,
function () {
return $this->siteStore->getSites();
}
);
}
return $this->sites;
}
/**
* @see SiteStore::getSite
*
* @since 1.25
* @param string $globalId
* @return Site|null
*/
public function getSite( $globalId ) {
$sites = $this->getSites();
return $sites->hasSite( $globalId ) ? $sites->getSite( $globalId ) : null;
}
/**
* @see SiteStore::saveSite
*
* @since 1.25
* @param Site $site
* @return bool Success indicator
*/
public function saveSite( Site $site ) {
return $this->saveSites( [ $site ] );
}
/**
* @see SiteStore::saveSites
*
* @since 1.25
* @param Site[] $sites
* @return bool Success indicator
*/
public function saveSites( array $sites ) {
if ( !$sites ) {
return true;
}
$success = $this->siteStore->saveSites( $sites );
// purge cache
$this->reset();
return $success;
}
/**
* Purge the internal and external cache of the site list, forcing the list.
* of sites to be reloaded.
*
* @since 1.25
*/
public function reset() {
$this->cache->delete( $this->getCacheKey() );
$this->sites = null;
}
/**
* Clears the list of sites stored.
*
* NOTE: The fact that this also clears the in-process cache is an internal
* detail for PHPUnit testing only. The injected cache is generally APCU,
* which is per-server, so the cache reset would not apply to any other web servers.
*
* @see SiteStore::clear()
* @return bool Success
*/
public function clear() {
$this->reset();
return $this->siteStore->clear();
}
}
/** @deprecated class alias since 1.42 */
class_alias( CachingSiteStore::class, 'CachingSiteStore' );
|
