diff options
Diffstat (limited to 'www/wiki/maintenance/populateCategory.php')
| -rw-r--r-- | www/wiki/maintenance/populateCategory.php | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/www/wiki/maintenance/populateCategory.php b/www/wiki/maintenance/populateCategory.php new file mode 100644 index 00000000..f2a00078 --- /dev/null +++ b/www/wiki/maintenance/populateCategory.php @@ -0,0 +1,154 @@ +<?php +/** + * Populate the category table. + * + * 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 + * @ingroup Maintenance + * @author Simetrical + */ + +require_once __DIR__ . '/Maintenance.php'; + +/** + * Maintenance script to populate the category table. + * + * @ingroup Maintenance + */ +class PopulateCategory extends Maintenance { + + const REPORTING_INTERVAL = 1000; + + public function __construct() { + parent::__construct(); + $this->addDescription( + <<<TEXT +This script will populate the category table, added in MediaWiki 1.13. It will +print out progress indicators every 1000 categories it adds to the table. The +script is perfectly safe to run on large, live wikis, and running it multiple +times is harmless. You may want to use the throttling options if it's causing +too much load; they will not affect correctness. + +If the script is stopped and later resumed, you can use the --begin option with +the last printed progress indicator to pick up where you left off. This is +safe, because any newly-added categories before this cutoff will have been +added after the software update and so will be populated anyway. + +When the script has finished, it will make a note of this in the database, and +will not run again without the --force option. +TEXT + ); + + $this->addOption( + 'begin', + 'Only do categories whose names are alphabetically after the provided name', + false, + true + ); + $this->addOption( + 'throttle', + 'Wait this many milliseconds after each category. Default: 0', + false, + true + ); + $this->addOption( 'force', 'Run regardless of whether the database says it\'s been run already' ); + } + + public function execute() { + $begin = $this->getOption( 'begin', '' ); + $throttle = $this->getOption( 'throttle', 0 ); + $force = $this->hasOption( 'force' ); + + $dbw = $this->getDB( DB_MASTER ); + + if ( !$force ) { + $row = $dbw->selectRow( + 'updatelog', + '1', + [ 'ul_key' => 'populate category' ], + __METHOD__ + ); + if ( $row ) { + $this->output( "Category table already populated. Use php " . + "maintenance/populateCategory.php\n--force from the command line " . + "to override.\n" ); + + return true; + } + } + + $throttle = intval( $throttle ); + if ( $begin !== '' ) { + $where = 'cl_to > ' . $dbw->addQuotes( $begin ); + } else { + $where = null; + } + $i = 0; + + while ( true ) { + # Find which category to update + $row = $dbw->selectRow( + 'categorylinks', + 'cl_to', + $where, + __METHOD__, + [ + 'ORDER BY' => 'cl_to' + ] + ); + if ( !$row ) { + # Done, hopefully. + break; + } + $name = $row->cl_to; + $where = 'cl_to > ' . $dbw->addQuotes( $name ); + + # Use the row to update the category count + $cat = Category::newFromName( $name ); + if ( !is_object( $cat ) ) { + $this->output( "The category named $name is not valid?!\n" ); + } else { + $cat->refreshCounts(); + } + + ++$i; + if ( !( $i % self::REPORTING_INTERVAL ) ) { + $this->output( "$name\n" ); + wfWaitForSlaves(); + } + usleep( $throttle * 1000 ); + } + + if ( $dbw->insert( + 'updatelog', + [ 'ul_key' => 'populate category' ], + __METHOD__, + 'IGNORE' + ) ) { + $this->output( "Category population complete.\n" ); + + return true; + } else { + $this->output( "Could not insert category population row.\n" ); + + return false; + } + } +} + +$maintClass = PopulateCategory::class; +require_once RUN_MAINTENANCE_IF_MAIN; |