Apply $wgMaxArticleSize more exactly
[mediawiki.git] / includes / site / DBSiteStore.php
blob974789f94f12d63758b8183af6ce2ce2273edb52
1 <?php
3 /**
4 * Represents the site configuration of a wiki.
5 * Holds a list of sites (ie SiteList), stored in the database.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
22 * @since 1.25
24 * @file
25 * @ingroup Site
27 * @license GNU GPL v2+
28 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
29 * @author Daniel Kinzler
31 class DBSiteStore implements SiteStore {
33 /**
34 * @var SiteList|null
36 protected $sites = null;
38 /**
39 * @var LoadBalancer
41 private $dbLoadBalancer;
43 /**
44 * @since 1.27
46 * @todo: inject some kind of connection manager that is aware of the target wiki,
47 * instead of injecting a LoadBalancer.
49 * @param LoadBalancer $dbLoadBalancer
51 public function __construct( LoadBalancer $dbLoadBalancer ) {
52 $this->dbLoadBalancer = $dbLoadBalancer;
55 /**
56 * @see SiteStore::getSites
58 * @since 1.25
60 * @return SiteList
62 public function getSites() {
63 $this->loadSites();
65 return $this->sites;
68 /**
69 * Fetches the site from the database and loads them into the sites field.
71 * @since 1.25
73 protected function loadSites() {
74 $this->sites = new SiteList();
76 $dbr = $this->dbLoadBalancer->getConnection( DB_SLAVE );
78 $res = $dbr->select(
79 'sites',
81 'site_id',
82 'site_global_key',
83 'site_type',
84 'site_group',
85 'site_source',
86 'site_language',
87 'site_protocol',
88 'site_domain',
89 'site_data',
90 'site_forward',
91 'site_config',
93 '',
94 __METHOD__,
95 [ 'ORDER BY' => 'site_global_key' ]
98 foreach ( $res as $row ) {
99 $site = Site::newForType( $row->site_type );
100 $site->setGlobalId( $row->site_global_key );
101 $site->setInternalId( (int)$row->site_id );
102 $site->setForward( (bool)$row->site_forward );
103 $site->setGroup( $row->site_group );
104 $site->setLanguageCode( $row->site_language === ''
105 ? null
106 : $row->site_language
108 $site->setSource( $row->site_source );
109 $site->setExtraData( unserialize( $row->site_data ) );
110 $site->setExtraConfig( unserialize( $row->site_config ) );
111 $this->sites[] = $site;
114 // Batch load the local site identifiers.
115 $ids = $dbr->select(
116 'site_identifiers',
118 'si_site',
119 'si_type',
120 'si_key',
123 __METHOD__
126 foreach ( $ids as $id ) {
127 if ( $this->sites->hasInternalId( $id->si_site ) ) {
128 $site = $this->sites->getSiteByInternalId( $id->si_site );
129 $site->addLocalId( $id->si_type, $id->si_key );
130 $this->sites->setSite( $site );
134 $this->dbLoadBalancer->reuseConnection( $dbr );
138 * @see SiteStore::getSite
140 * @since 1.25
142 * @param string $globalId
144 * @return Site|null
146 public function getSite( $globalId ) {
147 if ( $this->sites === null ) {
148 $this->sites = $this->getSites();
151 return $this->sites->hasSite( $globalId ) ? $this->sites->getSite( $globalId ) : null;
155 * @see SiteStore::saveSite
157 * @since 1.25
159 * @param Site $site
161 * @return bool Success indicator
163 public function saveSite( Site $site ) {
164 return $this->saveSites( [ $site ] );
168 * @see SiteStore::saveSites
170 * @since 1.25
172 * @param Site[] $sites
174 * @return bool Success indicator
176 public function saveSites( array $sites ) {
177 if ( empty( $sites ) ) {
178 return true;
181 $dbw = $this->dbLoadBalancer->getConnection( DB_MASTER );
183 $dbw->startAtomic( __METHOD__ );
185 $success = true;
187 $internalIds = [];
188 $localIds = [];
190 foreach ( $sites as $site ) {
191 if ( $site->getInternalId() !== null ) {
192 $internalIds[] = $site->getInternalId();
195 $fields = [
196 // Site data
197 'site_global_key' => $site->getGlobalId(), // TODO: check not null
198 'site_type' => $site->getType(),
199 'site_group' => $site->getGroup(),
200 'site_source' => $site->getSource(),
201 'site_language' => $site->getLanguageCode() === null ? '' : $site->getLanguageCode(),
202 'site_protocol' => $site->getProtocol(),
203 'site_domain' => strrev( $site->getDomain() ) . '.',
204 'site_data' => serialize( $site->getExtraData() ),
206 // Site config
207 'site_forward' => $site->shouldForward() ? 1 : 0,
208 'site_config' => serialize( $site->getExtraConfig() ),
211 $rowId = $site->getInternalId();
212 if ( $rowId !== null ) {
213 $success = $dbw->update(
214 'sites', $fields, [ 'site_id' => $rowId ], __METHOD__
215 ) && $success;
216 } else {
217 $rowId = $dbw->nextSequenceValue( 'sites_site_id_seq' );
218 $fields['site_id'] = $rowId;
219 $success = $dbw->insert( 'sites', $fields, __METHOD__ ) && $success;
220 $rowId = $dbw->insertId();
223 foreach ( $site->getLocalIds() as $idType => $ids ) {
224 foreach ( $ids as $id ) {
225 $localIds[] = [ $rowId, $idType, $id ];
230 if ( $internalIds !== [] ) {
231 $dbw->delete(
232 'site_identifiers',
233 [ 'si_site' => $internalIds ],
234 __METHOD__
238 foreach ( $localIds as $localId ) {
239 $dbw->insert(
240 'site_identifiers',
242 'si_site' => $localId[0],
243 'si_type' => $localId[1],
244 'si_key' => $localId[2],
246 __METHOD__
250 $dbw->endAtomic( __METHOD__ );
252 $this->dbLoadBalancer->reuseConnection( $dbw );
254 $this->reset();
256 return $success;
260 * Resets the SiteList
262 * @since 1.25
264 public function reset() {
265 $this->sites = null;
269 * Clears the list of sites stored in the database.
271 * @see SiteStore::clear()
273 * @return bool Success
275 public function clear() {
276 $dbw = $this->dbLoadBalancer->getConnection( DB_MASTER );
278 $dbw->startAtomic( __METHOD__ );
279 $ok = $dbw->delete( 'sites', '*', __METHOD__ );
280 $ok = $dbw->delete( 'site_identifiers', '*', __METHOD__ ) && $ok;
281 $dbw->endAtomic( __METHOD__ );
283 $this->dbLoadBalancer->reuseConnection( $dbw );
285 $this->reset();
287 return $ok;