Merge "Pass database connection to SpecialWatchlist::countItems"
[lhc/web/wiklou.git] / maintenance / populateCategory.php
index 3b3101a..ae54d69 100644 (file)
@@ -1,15 +1,34 @@
 <?php
 /**
- * @file 
+ * 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
  */
 
-$optionsWithArgs = array( 'begin', 'max-slave-lag', 'throttle' );
-
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
-
+require_once( __DIR__ . '/Maintenance.php' );
 
+/**
+ * Mainteance script to populate the category table.
+ *
+ * @ingroup Maintenance
+ */
 class PopulateCategory extends Maintenance {
 
        const REPORTING_INTERVAL = 1000;
@@ -37,7 +56,7 @@ TEXT;
                $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', '' );
                $maxSlaveLag = $this->getOption( 'max-slave-lag', 10 );
@@ -48,7 +67,7 @@ TEXT;
 
        private function doPopulateCategory( $begin, $maxlag, $throttle, $force ) {
                $dbw = wfGetDB( DB_MASTER );
-       
+
                if ( !$force ) {
                        $row = $dbw->selectRow(
                                'updatelog',
@@ -63,8 +82,7 @@ TEXT;
                                return true;
                        }
                }
-       
-               $maxlag = intval( $maxlag );
+
                $throttle = intval( $throttle );
                if ( $begin !== '' ) {
                        $where = 'cl_to > ' . $dbw->addQuotes( $begin );
@@ -72,7 +90,7 @@ TEXT;
                        $where = null;
                }
                $i = 0;
-       
+
                while ( true ) {
                        # Find which category to update
                        $row = $dbw->selectRow(
@@ -90,7 +108,7 @@ TEXT;
                        }
                        $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 ) ) {
@@ -98,15 +116,15 @@ TEXT;
                        } else {
                                $cat->refreshCounts();
                        }
-       
+
                        ++$i;
                        if ( !( $i % self::REPORTING_INTERVAL ) ) {
                                $this->output( "$name\n" );
-                               wfWaitForSlaves( $maxlag );
+                               wfWaitForSlaves();
                        }
                        usleep( $throttle * 1000 );
                }
-       
+
                if ( $dbw->insert(
                                'updatelog',
                                array( 'ul_key' => 'populate category' ),
@@ -124,4 +142,4 @@ TEXT;
 }
 
 $maintClass = "PopulateCategory";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );