rdbms: Avoid selectDB() call in LoadMonitor new connections
[mediawiki.git] / includes / Category.php
blobc22ea64abf8c398a204c1035327e7e0cef3e3cfb
1 <?php
2 /**
3 * Representation for a category.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @author Simetrical
24 /**
25 * Category objects are immutable, strictly speaking. If you call methods that change the database,
26 * like to refresh link counts, the objects will be appropriately reinitialized.
27 * Member variables are lazy-initialized.
29 * @todo Move some stuff from CategoryPage.php to here, and use that.
31 class Category {
32 /** Name of the category, normalized to DB-key form */
33 private $mName = null;
34 private $mID = null;
35 /**
36 * Category page title
37 * @var Title
39 private $mTitle = null;
40 /** Counts of membership (cat_pages, cat_subcats, cat_files) */
41 private $mPages = null, $mSubcats = null, $mFiles = null;
43 const LOAD_ONLY = 0;
44 const LAZY_INIT_ROW = 1;
46 private function __construct() {
49 /**
50 * Set up all member variables using a database query.
51 * @param integer $mode
52 * @throws MWException
53 * @return bool True on success, false on failure.
55 protected function initialize( $mode = self::LOAD_ONLY ) {
56 if ( $this->mName === null && $this->mID === null ) {
57 throw new MWException( __METHOD__ . ' has both names and IDs null' );
58 } elseif ( $this->mID === null ) {
59 $where = [ 'cat_title' => $this->mName ];
60 } elseif ( $this->mName === null ) {
61 $where = [ 'cat_id' => $this->mID ];
62 } else {
63 # Already initialized
64 return true;
67 $dbr = wfGetDB( DB_REPLICA );
68 $row = $dbr->selectRow(
69 'category',
70 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
71 $where,
72 __METHOD__
75 if ( !$row ) {
76 # Okay, there were no contents. Nothing to initialize.
77 if ( $this->mTitle ) {
78 # If there is a title object but no record in the category table,
79 # treat this as an empty category.
80 $this->mID = false;
81 $this->mName = $this->mTitle->getDBkey();
82 $this->mPages = 0;
83 $this->mSubcats = 0;
84 $this->mFiles = 0;
86 # If the title exists, call refreshCounts to add a row for it.
87 if ( $mode === self::LAZY_INIT_ROW && $this->mTitle->exists() ) {
88 DeferredUpdates::addCallableUpdate( [ $this, 'refreshCounts' ] );
91 return true;
92 } else {
93 return false; # Fail
97 $this->mID = $row->cat_id;
98 $this->mName = $row->cat_title;
99 $this->mPages = $row->cat_pages;
100 $this->mSubcats = $row->cat_subcats;
101 $this->mFiles = $row->cat_files;
103 # (T15683) If the count is negative, then 1) it's obviously wrong
104 # and should not be kept, and 2) we *probably* don't have to scan many
105 # rows to obtain the correct figure, so let's risk a one-time recount.
106 if ( $this->mPages < 0 || $this->mSubcats < 0 || $this->mFiles < 0 ) {
107 $this->mPages = max( $this->mPages, 0 );
108 $this->mSubcats = max( $this->mSubcats, 0 );
109 $this->mFiles = max( $this->mFiles, 0 );
111 if ( $mode === self::LAZY_INIT_ROW ) {
112 DeferredUpdates::addCallableUpdate( [ $this, 'refreshCounts' ] );
116 return true;
120 * Factory function.
122 * @param array $name A category name (no "Category:" prefix). It need
123 * not be normalized, with spaces replaced by underscores.
124 * @return mixed Category, or false on a totally invalid name
126 public static function newFromName( $name ) {
127 $cat = new self();
128 $title = Title::makeTitleSafe( NS_CATEGORY, $name );
130 if ( !is_object( $title ) ) {
131 return false;
134 $cat->mTitle = $title;
135 $cat->mName = $title->getDBkey();
137 return $cat;
141 * Factory function.
143 * @param Title $title Title for the category page
144 * @return Category|bool On a totally invalid name
146 public static function newFromTitle( $title ) {
147 $cat = new self();
149 $cat->mTitle = $title;
150 $cat->mName = $title->getDBkey();
152 return $cat;
156 * Factory function.
158 * @param int $id A category id
159 * @return Category
161 public static function newFromID( $id ) {
162 $cat = new self();
163 $cat->mID = intval( $id );
164 return $cat;
168 * Factory function, for constructing a Category object from a result set
170 * @param object $row Result set row, must contain the cat_xxx fields. If the
171 * fields are null, the resulting Category object will represent an empty
172 * category if a title object was given. If the fields are null and no
173 * title was given, this method fails and returns false.
174 * @param Title $title Optional title object for the category represented by
175 * the given row. May be provided if it is already known, to avoid having
176 * to re-create a title object later.
177 * @return Category|false
179 public static function newFromRow( $row, $title = null ) {
180 $cat = new self();
181 $cat->mTitle = $title;
183 # NOTE: the row often results from a LEFT JOIN on categorylinks. This may result in
184 # all the cat_xxx fields being null, if the category page exists, but nothing
185 # was ever added to the category. This case should be treated link an empty
186 # category, if possible.
188 if ( $row->cat_title === null ) {
189 if ( $title === null ) {
190 # the name is probably somewhere in the row, for example as page_title,
191 # but we can't know that here...
192 return false;
193 } else {
194 # if we have a title object, fetch the category name from there
195 $cat->mName = $title->getDBkey();
198 $cat->mID = false;
199 $cat->mSubcats = 0;
200 $cat->mPages = 0;
201 $cat->mFiles = 0;
202 } else {
203 $cat->mName = $row->cat_title;
204 $cat->mID = $row->cat_id;
205 $cat->mSubcats = $row->cat_subcats;
206 $cat->mPages = $row->cat_pages;
207 $cat->mFiles = $row->cat_files;
210 return $cat;
214 * @return mixed DB key name, or false on failure
216 public function getName() {
217 return $this->getX( 'mName' );
221 * @return mixed Category ID, or false on failure
223 public function getID() {
224 return $this->getX( 'mID' );
228 * @return mixed Total number of member pages, or false on failure
230 public function getPageCount() {
231 return $this->getX( 'mPages' );
235 * @return mixed Number of subcategories, or false on failure
237 public function getSubcatCount() {
238 return $this->getX( 'mSubcats' );
242 * @return mixed Number of member files, or false on failure
244 public function getFileCount() {
245 return $this->getX( 'mFiles' );
249 * @return Title|bool Title for this category, or false on failure.
251 public function getTitle() {
252 if ( $this->mTitle ) {
253 return $this->mTitle;
256 if ( !$this->initialize( self::LAZY_INIT_ROW ) ) {
257 return false;
260 $this->mTitle = Title::makeTitleSafe( NS_CATEGORY, $this->mName );
261 return $this->mTitle;
265 * Fetch a TitleArray of up to $limit category members, beginning after the
266 * category sort key $offset.
267 * @param int|bool $limit
268 * @param string $offset
269 * @return TitleArray TitleArray object for category members.
271 public function getMembers( $limit = false, $offset = '' ) {
272 $dbr = wfGetDB( DB_REPLICA );
274 $conds = [ 'cl_to' => $this->getName(), 'cl_from = page_id' ];
275 $options = [ 'ORDER BY' => 'cl_sortkey' ];
277 if ( $limit ) {
278 $options['LIMIT'] = $limit;
281 if ( $offset !== '' ) {
282 $conds[] = 'cl_sortkey > ' . $dbr->addQuotes( $offset );
285 $result = TitleArray::newFromResult(
286 $dbr->select(
287 [ 'page', 'categorylinks' ],
288 [ 'page_id', 'page_namespace', 'page_title', 'page_len',
289 'page_is_redirect', 'page_latest' ],
290 $conds,
291 __METHOD__,
292 $options
296 return $result;
300 * Generic accessor
301 * @param string $key
302 * @return bool
304 private function getX( $key ) {
305 if ( !$this->initialize( self::LAZY_INIT_ROW ) ) {
306 return false;
308 return $this->{$key};
312 * Refresh the counts for this category.
314 * @return bool True on success, false on failure
316 public function refreshCounts() {
317 if ( wfReadOnly() ) {
318 return false;
321 # If we have just a category name, find out whether there is an
322 # existing row. Or if we have just an ID, get the name, because
323 # that's what categorylinks uses.
324 if ( !$this->initialize( self::LOAD_ONLY ) ) {
325 return false;
328 $dbw = wfGetDB( DB_MASTER );
329 # Avoid excess contention on the same category (T162121)
330 $name = __METHOD__ . ':' . md5( $this->mName );
331 $scopedLock = $dbw->getScopedLockAndFlush( $name, __METHOD__, 1 );
332 if ( !$scopedLock ) {
333 return false;
336 $dbw->startAtomic( __METHOD__ );
338 $cond1 = $dbw->conditional( [ 'page_namespace' => NS_CATEGORY ], 1, 'NULL' );
339 $cond2 = $dbw->conditional( [ 'page_namespace' => NS_FILE ], 1, 'NULL' );
340 $result = $dbw->selectRow(
341 [ 'categorylinks', 'page' ],
342 [ 'pages' => 'COUNT(*)',
343 'subcats' => "COUNT($cond1)",
344 'files' => "COUNT($cond2)"
346 [ 'cl_to' => $this->mName, 'page_id = cl_from' ],
347 __METHOD__,
348 [ 'LOCK IN SHARE MODE' ]
351 $shouldExist = $result->pages > 0 || $this->getTitle()->exists();
353 if ( $this->mID ) {
354 if ( $shouldExist ) {
355 # The category row already exists, so do a plain UPDATE instead
356 # of INSERT...ON DUPLICATE KEY UPDATE to avoid creating a gap
357 # in the cat_id sequence. The row may or may not be "affected".
358 $dbw->update(
359 'category',
361 'cat_pages' => $result->pages,
362 'cat_subcats' => $result->subcats,
363 'cat_files' => $result->files
365 [ 'cat_title' => $this->mName ],
366 __METHOD__
368 } else {
369 # The category is empty and has no description page, delete it
370 $dbw->delete(
371 'category',
372 [ 'cat_title' => $this->mName ],
373 __METHOD__
375 $this->mID = false;
377 } elseif ( $shouldExist ) {
378 # The category row doesn't exist but should, so create it. Use
379 # upsert in case of races.
380 $dbw->upsert(
381 'category',
383 'cat_title' => $this->mName,
384 'cat_pages' => $result->pages,
385 'cat_subcats' => $result->subcats,
386 'cat_files' => $result->files
388 [ 'cat_title' ],
390 'cat_pages' => $result->pages,
391 'cat_subcats' => $result->subcats,
392 'cat_files' => $result->files
394 __METHOD__
396 // @todo: Should we update $this->mID here? Or not since Category
397 // objects tend to be short lived enough to not matter?
400 $dbw->endAtomic( __METHOD__ );
402 # Now we should update our local counts.
403 $this->mPages = $result->pages;
404 $this->mSubcats = $result->subcats;
405 $this->mFiles = $result->files;
407 return true;