MediaWiki REL1_30
populateCategory.php
Go to the documentation of this file.
1<?php
25require_once __DIR__ . '/Maintenance.php';
26
33
34 const REPORTING_INTERVAL = 1000;
35
36 public function __construct() {
37 parent::__construct();
38 $this->addDescription(
39 <<<TEXT
40This script will populate the category table, added in MediaWiki 1.13. It will
41print out progress indicators every 1000 categories it adds to the table. The
42script is perfectly safe to run on large, live wikis, and running it multiple
43times is harmless. You may want to use the throttling options if it's causing
44too much load; they will not affect correctness.
45
46If the script is stopped and later resumed, you can use the --begin option with
47the last printed progress indicator to pick up where you left off. This is
48safe, because any newly-added categories before this cutoff will have been
49added after the software update and so will be populated anyway.
50
51When the script has finished, it will make a note of this in the database, and
52will not run again without the --force option.
53TEXT
54 );
55
56 $this->addOption(
57 'begin',
58 'Only do categories whose names are alphabetically after the provided name',
59 false,
60 true
61 );
62 $this->addOption(
63 'throttle',
64 'Wait this many milliseconds after each category. Default: 0',
65 false,
66 true
67 );
68 $this->addOption( 'force', 'Run regardless of whether the database says it\'s been run already' );
69 }
70
71 public function execute() {
72 $begin = $this->getOption( 'begin', '' );
73 $throttle = $this->getOption( 'throttle', 0 );
74 $force = $this->hasOption( 'force' );
75
76 $dbw = $this->getDB( DB_MASTER );
77
78 if ( !$force ) {
79 $row = $dbw->selectRow(
80 'updatelog',
81 '1',
82 [ 'ul_key' => 'populate category' ],
83 __METHOD__
84 );
85 if ( $row ) {
86 $this->output( "Category table already populated. Use php " .
87 "maintenance/populateCategory.php\n--force from the command line " .
88 "to override.\n" );
89
90 return true;
91 }
92 }
93
94 $throttle = intval( $throttle );
95 if ( $begin !== '' ) {
96 $where = 'cl_to > ' . $dbw->addQuotes( $begin );
97 } else {
98 $where = null;
99 }
100 $i = 0;
101
102 while ( true ) {
103 # Find which category to update
104 $row = $dbw->selectRow(
105 'categorylinks',
106 'cl_to',
107 $where,
108 __METHOD__,
109 [
110 'ORDER BY' => 'cl_to'
111 ]
112 );
113 if ( !$row ) {
114 # Done, hopefully.
115 break;
116 }
117 $name = $row->cl_to;
118 $where = 'cl_to > ' . $dbw->addQuotes( $name );
119
120 # Use the row to update the category count
121 $cat = Category::newFromName( $name );
122 if ( !is_object( $cat ) ) {
123 $this->output( "The category named $name is not valid?!\n" );
124 } else {
125 $cat->refreshCounts();
126 }
127
128 ++$i;
129 if ( !( $i % self::REPORTING_INTERVAL ) ) {
130 $this->output( "$name\n" );
132 }
133 usleep( $throttle * 1000 );
134 }
135
136 if ( $dbw->insert(
137 'updatelog',
138 [ 'ul_key' => 'populate category' ],
139 __METHOD__,
140 'IGNORE'
141 ) ) {
142 $this->output( "Category population complete.\n" );
143
144 return true;
145 } else {
146 $this->output( "Could not insert category population row.\n" );
147
148 return false;
149 }
150 }
151}
152
153$maintClass = "PopulateCategory";
154require_once RUN_MAINTENANCE_IF_MAIN;
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
getOption( $name, $default=null)
Get an option, or return the default.
Maintenance script to populate the category table.
execute()
Do the actual work.
__construct()
Default constructor.
print
Definition cleanup.php:99
$dbw begin(__METHOD__)
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition deferred.txt:16
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
require_once RUN_MAINTENANCE_IF_MAIN
A helper class for throttling authentication attempts.
const DB_MASTER
Definition defines.php:26