Merge "Unit test for User::getEditCount"
[lhc/web/wiklou.git] / maintenance / namespaceDupes.php
index 13dfd9f..4197a35 100644 (file)
@@ -2,7 +2,7 @@
 /**
  * Check for articles to fix after adding/deleting namespaces
  *
- * Copyright (C) 2005-2007 Brion Vibber <brion@pobox.com>
+ * Copyright © 2005-2007 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once( __DIR__ . '/Maintenance.php' );
 
+/**
+ * Maintenance script that checks for articles to fix after
+ * adding/deleting namespaces.
+ *
+ * @ingroup Maintenance
+ */
 class NamespaceConflictChecker extends Maintenance {
+
+       /**
+        * @var DatabaseBase
+        */
+       protected $db;
+
        public function __construct() {
                parent::__construct();
                $this->mDescription = "";
                $this->addOption( 'fix', 'Attempt to automatically fix errors' );
-               $this->addOption( 'suffix', "Dupes will be renamed with correct namespace with\n" .
-                                                                       "\t\t<text> Appended after the article name", false, true );
-               $this->addOption( 'prefix', "Do an explicit check for the given title prefix\n" .
-                                                                       "\t\tappended after the article name", false, true );
+               $this->addOption( 'suffix', "Dupes will be renamed with correct namespace with " .
+                                                                       "<text> appended after the article name", false, true );
+               $this->addOption( 'prefix', "Do an explicit check for the given title prefix " .
+                                                                       "appended after the article name", false, true );
        }
 
        public function execute() {
@@ -52,7 +65,7 @@ class NamespaceConflictChecker extends Maintenance {
                } else {
                        $retval = $this->checkAll( $fix, $suffix );
                }
-       
+
                if ( $retval ) {
                        $this->output( "\nLooks good!\n" );
                } else {
@@ -64,13 +77,14 @@ class NamespaceConflictChecker extends Maintenance {
         * @todo Document
         * @param $fix Boolean: whether or not to fix broken entries
         * @param $suffix String: suffix to append to renamed articles
+        *
+        * @return bool
         */
        private function checkAll( $fix, $suffix = '' ) {
-               global $wgContLang, $wgNamespaceAliases, $wgCanonicalNamespaceNames;
-               global $wgCapitalLinks;
-               
+               global $wgContLang, $wgNamespaceAliases, $wgCapitalLinks;
+
                $spaces = array();
-               
+
                // List interwikis first, so they'll be overridden
                // by any conflicting local namespaces.
                foreach ( $this->getInterwikiList() as $prefix ) {
@@ -79,7 +93,7 @@ class NamespaceConflictChecker extends Maintenance {
                }
 
                // Now pull in all canonical and alias namespaces...
-               foreach ( $wgCanonicalNamespaceNames as $ns => $name ) {
+               foreach ( MWNamespace::getCanonicalNamespaces() as $ns => $name ) {
                        // This includes $wgExtraNamespaces
                        if ( $name !== '' ) {
                                $spaces[$name] = $ns;
@@ -96,7 +110,7 @@ class NamespaceConflictChecker extends Maintenance {
                foreach ( $wgContLang->getNamespaceAliases() as $name => $ns ) {
                        $spaces[$name] = $ns;
                }
-               
+
                // We'll need to check for lowercase keys as well,
                // since we're doing case-sensitive searches in the db.
                foreach ( $spaces as $name => $ns ) {
@@ -119,10 +133,10 @@ class NamespaceConflictChecker extends Maintenance {
                                }
                        }
                }
-               
+
                ksort( $spaces );
                asort( $spaces );
-               
+
                $ok = true;
                foreach ( $spaces as $name => $ns ) {
                        $ok = $this->checkNamespace( $ns, $name, $fix, $suffix ) && $ok;
@@ -151,6 +165,7 @@ class NamespaceConflictChecker extends Maintenance {
         * @param $name String
         * @param $fix Boolean: whether to fix broken entries
         * @param $suffix String: suffix to append to renamed articles
+        * @return bool
         */
        private function checkNamespace( $ns, $name, $fix, $suffix = '' ) {
                $conflicts = $this->getConflicts( $ns, $name );
@@ -169,9 +184,14 @@ class NamespaceConflictChecker extends Maintenance {
                }
                return $ok;
        }
-       
+
        /**
         * @todo: do this for reals
+        * @param $key
+        * @param $prefix
+        * @param $fix
+        * @param $suffix string
+        * @return bool
         */
        private function checkPrefix( $key, $prefix, $fix, $suffix = '' ) {
                $this->output( "Checking prefix \"$prefix\" vs namespace $key\n" );
@@ -184,6 +204,8 @@ class NamespaceConflictChecker extends Maintenance {
         *
         * @param $ns Integer: namespace id (id for new namespace?)
         * @param $name String: prefix that is being made a namespace
+        *
+        * @return array
         */
        private function getConflicts( $ns, $name ) {
                $page  = 'page';
@@ -197,15 +219,15 @@ class NamespaceConflictChecker extends Maintenance {
                        // An interwiki; try an alternate encoding with '-' for ':'
                        $titleSql = $this->db->buildConcat( array( "'$prefix-'", $titleSql ) );
                }
-                                     
+
                $sql = "SELECT {$page}_id    AS id,
-                              {$page}_title AS oldtitle,
-                              $encNamespace + {$page}_namespace AS namespace,
-                              $titleSql     AS title,
-                              {$page}_namespace AS oldnamespace
-                         FROM {$table}
-                        WHERE ( {$page}_namespace=0 OR {$page}_namespace=1 )
-                          AND {$page}_title " . $this->db->buildLike( $name . ':', $this->db->anyString() );
+                                          {$page}_title AS oldtitle,
+                                          $encNamespace + {$page}_namespace AS namespace,
+                                  $titleSql     AS title,
+                                  {$page}_namespace AS oldnamespace
+                                 FROM {$table}
+                                WHERE ( {$page}_namespace=0 OR {$page}_namespace=1 )
+                                  AND {$page}_title " . $this->db->buildLike( $name . ':', $this->db->anyString() );
 
                $result = $this->db->query( $sql, __METHOD__ );
 
@@ -218,6 +240,8 @@ class NamespaceConflictChecker extends Maintenance {
 
        /**
         * Report any conflicts we find
+        *
+        * @return bool
         */
        private function reportConflict( $row, $suffix ) {
                $newTitle = Title::makeTitleSafe( $row->namespace, $row->title );
@@ -240,7 +264,7 @@ class NamespaceConflictChecker extends Maintenance {
                        $newTitle->getDBkey(),
                        $newTitle->getPrefixedText() ) );
 
-               $id = $newTitle->getArticleId();
+               $id = $newTitle->getArticleID();
                if ( $id ) {
                        $this->output( "...  *** cannot resolve automatically; page exists with ID $id ***\n" );
                        return false;
@@ -255,6 +279,7 @@ class NamespaceConflictChecker extends Maintenance {
         * @param $row Object: row from the page table to fix
         * @param $resolvable Boolean
         * @param $suffix String: suffix to append to the fixed page
+        * @return bool
         */
        private function resolveConflict( $row, $resolvable, $suffix ) {
                if ( !$resolvable ) {
@@ -263,11 +288,12 @@ class NamespaceConflictChecker extends Maintenance {
                                $row->title .= $suffix;
                                $this->output( "...  *** new title {$row->title}\n" );
                                $title = Title::makeTitleSafe( $row->namespace, $row->title );
-                               if ( ! $title ) {
+                               if ( !$title ) {
                                        $this->output( "... !!! invalid title\n" );
                                        return false;
                                }
-                               if ( $id = $title->getArticleId() ) {
+                               $id = $title->getArticleID();
+                               if ( $id ) {
                                        $this->output( "...  *** page exists with ID $id ***\n" );
                                } else {
                                        break;
@@ -285,6 +311,7 @@ class NamespaceConflictChecker extends Maintenance {
         * @param $row Object: row from the old broken entry
         * @param $table String: table to update
         * @param $prefix String: prefix for column name, like page or ar
+        * @return bool
         */
        private function resolveConflictOn( $row, $table, $prefix ) {
                $this->output( "... resolving on $table... " );
@@ -306,4 +333,4 @@ class NamespaceConflictChecker extends Maintenance {
 }
 
 $maintClass = "NamespaceConflictChecker";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );