Don't check namespace in SpecialWantedtemplates
[lhc/web/wiklou.git] / maintenance / populateCategory.php
1 <?php
2 /**
3 * Populate the category table.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup Maintenance
22 * @author Simetrical
23 */
24
25 require_once __DIR__ . '/Maintenance.php';
26
27 /**
28 * Mainteance script to populate the category table.
29 *
30 * @ingroup Maintenance
31 */
32 class PopulateCategory extends Maintenance {
33
34 const REPORTING_INTERVAL = 1000;
35
36 public function __construct() {
37 parent::__construct();
38 $this->mDescription = <<<TEXT
39 This script will populate the category table, added in MediaWiki 1.13. It will
40 print out progress indicators every 1000 categories it adds to the table. The
41 script is perfectly safe to run on large, live wikis, and running it multiple
42 times is harmless. You may want to use the throttling options if it's causing
43 too much load; they will not affect correctness.
44
45 If the script is stopped and later resumed, you can use the --begin option with
46 the last printed progress indicator to pick up where you left off. This is
47 safe, because any newly-added categories before this cutoff will have been
48 added after the software update and so will be populated anyway.
49
50 When the script has finished, it will make a note of this in the database, and
51 will not run again without the --force option.
52 TEXT;
53 # '
54 $this->addOption(
55 'begin',
56 'Only do categories whose names are alphabetically after the provided name',
57 false,
58 true
59 );
60 $this->addOption(
61 'throttle',
62 'Wait this many milliseconds after each category. Default: 0',
63 false,
64 true
65 );
66 $this->addOption( 'force', 'Run regardless of whether the database says it\'s been run already' );
67 }
68
69 public function execute() {
70 $begin = $this->getOption( 'begin', '' );
71 $throttle = $this->getOption( 'throttle', 0 );
72 $force = $this->getOption( 'force', false );
73
74 $dbw = wfGetDB( DB_MASTER );
75
76 if ( !$force ) {
77 $row = $dbw->selectRow(
78 'updatelog',
79 '1',
80 array( 'ul_key' => 'populate category' ),
81 __METHOD__
82 );
83 if ( $row ) {
84 $this->output( "Category table already populated. Use php " .
85 "maintenance/populateCategory.php\n--force from the command line " .
86 "to override.\n" );
87
88 return true;
89 }
90 }
91
92 $throttle = intval( $throttle );
93 if ( $begin !== '' ) {
94 $where = 'cl_to > ' . $dbw->addQuotes( $begin );
95 } else {
96 $where = null;
97 }
98 $i = 0;
99
100 while ( true ) {
101 # Find which category to update
102 $row = $dbw->selectRow(
103 'categorylinks',
104 'cl_to',
105 $where,
106 __METHOD__,
107 array(
108 'ORDER BY' => 'cl_to'
109 )
110 );
111 if ( !$row ) {
112 # Done, hopefully.
113 break;
114 }
115 $name = $row->cl_to;
116 $where = 'cl_to > ' . $dbw->addQuotes( $name );
117
118 # Use the row to update the category count
119 $cat = Category::newFromName( $name );
120 if ( !is_object( $cat ) ) {
121 $this->output( "The category named $name is not valid?!\n" );
122 } else {
123 $cat->refreshCounts();
124 }
125
126 ++$i;
127 if ( !( $i % self::REPORTING_INTERVAL ) ) {
128 $this->output( "$name\n" );
129 wfWaitForSlaves();
130 }
131 usleep( $throttle * 1000 );
132 }
133
134 if ( $dbw->insert(
135 'updatelog',
136 array( 'ul_key' => 'populate category' ),
137 __METHOD__,
138 'IGNORE'
139 ) ) {
140 $this->output( "Category population complete.\n" );
141
142 return true;
143 } else {
144 $this->output( "Could not insert category population row.\n" );
145
146 return false;
147 }
148 }
149 }
150
151 $maintClass = "PopulateCategory";
152 require_once RUN_MAINTENANCE_IF_MAIN;