maintenance/cleanupCaps.php

   1 <?php
   2 /**
   3  * Clean up broken page links when somebody turns on $wgCapitalLinks.
   4  *
   5  * Usage: php cleanupCaps.php [--dry-run]
   6  * Options:
   7  *   --dry-run  don't actually try moving them
   8  *
   9  * Copyright © 2005 Brion Vibber <brion@pobox.com>
  10  * https://www.mediawiki.org/
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License along
  23  * with this program; if not, write to the Free Software Foundation, Inc.,
  24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  25  * http://www.gnu.org/copyleft/gpl.html
  26  *
  27  * @file
  28  * @author Brion Vibber <brion at pobox.com>
  29  * @ingroup Maintenance
  30  */
  31
  32 use MediaWiki\MediaWikiServices;
  33
  34 require_once __DIR__ . '/cleanupTable.inc';
  35
  36 /**
  37  * Maintenance script to clean up broken page links when somebody turns
  38  * on or off $wgCapitalLinks.
  39  *
  40  * @ingroup Maintenance
  41  */
  42 class CleanupCaps extends TableCleanup {
  43
  44         private $user;
  45         private $namespace;
  46
  47         public function __construct() {
  48                 parent::__construct();
  49                 $this->addDescription( 'Script to cleanup capitalization' );
  50                 $this->addOption( 'namespace', 'Namespace number to run caps cleanup on', false, true );
  51         }
  52
  53         public function execute() {
  54                 $this->user = User::newSystemUser( 'Conversion script', [ 'steal' => true ] );
  55
  56                 $this->namespace = intval( $this->getOption( 'namespace', 0 ) );
  57
  58                 if (
  59                         MediaWikiServices::getInstance()->getNamespaceInfo()->
  60                                 isCapitalized( $this->namespace )
  61                 ) {
  62                         $this->output( "Will be moving pages to first letter capitalized titles" );
  63                         $callback = 'processRowToUppercase';
  64                 } else {
  65                         $this->output( "Will be moving pages to first letter lowercase titles" );
  66                         $callback = 'processRowToLowercase';
  67                 }
  68
  69                 $this->dryrun = $this->hasOption( 'dry-run' );
  70
  71                 $this->runTable( [
  72                         'table' => 'page',
  73                         'conds' => [ 'page_namespace' => $this->namespace ],
  74                         'index' => 'page_id',
  75                         'callback' => $callback ] );
  76         }
  77
  78         protected function processRowToUppercase( $row ) {
  79                 $current = Title::makeTitle( $row->page_namespace, $row->page_title );
  80                 $display = $current->getPrefixedText();
  81                 $lower = $row->page_title;
  82                 $upper = MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $row->page_title );
  83                 if ( $upper == $lower ) {
  84                         $this->output( "\"$display\" already uppercase.\n" );
  85
  86                         return $this->progress( 0 );
  87                 }
  88
  89                 $target = Title::makeTitle( $row->page_namespace, $upper );
  90                 if ( $target->exists() ) {
  91                         // Prefix "CapsCleanup" to bypass the conflict
  92                         $target = Title::newFromText( 'CapsCleanup/' . $display );
  93                 }
  94                 $ok = $this->movePage(
  95                         $current,
  96                         $target,
  97                         'Converting page title to first-letter uppercase',
  98                         false
  99                 );
 100                 if ( $ok ) {
 101                         $this->progress( 1 );
 102                         if ( $row->page_namespace == $this->namespace ) {
 103                                 $talk = $target->getTalkPage();
 104                                 $row->page_namespace = $talk->getNamespace();
 105                                 if ( $talk->exists() ) {
 106                                         return $this->processRowToUppercase( $row );
 107                                 }
 108                         }
 109                 }
 110
 111                 return $this->progress( 0 );
 112         }
 113
 114         protected function processRowToLowercase( $row ) {
 115                 $current = Title::makeTitle( $row->page_namespace, $row->page_title );
 116                 $display = $current->getPrefixedText();
 117                 $upper = $row->page_title;
 118                 $lower = MediaWikiServices::getInstance()->getContentLanguage()->lcfirst( $row->page_title );
 119                 if ( $upper == $lower ) {
 120                         $this->output( "\"$display\" already lowercase.\n" );
 121
 122                         return $this->progress( 0 );
 123                 }
 124
 125                 $target = Title::makeTitle( $row->page_namespace, $lower );
 126                 if ( $target->exists() ) {
 127                         $targetDisplay = $target->getPrefixedText();
 128                         $this->output( "\"$display\" skipped; \"$targetDisplay\" already exists\n" );
 129
 130                         return $this->progress( 0 );
 131                 }
 132
 133                 $ok = $this->movePage( $current, $target, 'Converting page titles to lowercase', true );
 134                 if ( $ok === true ) {
 135                         $this->progress( 1 );
 136                         if ( $row->page_namespace == $this->namespace ) {
 137                                 $talk = $target->getTalkPage();
 138                                 $row->page_namespace = $talk->getNamespace();
 139                                 if ( $talk->exists() ) {
 140                                         return $this->processRowToLowercase( $row );
 141                                 }
 142                         }
 143                 }
 144
 145                 return $this->progress( 0 );
 146         }
 147
 148         /**
 149          * @param Title $current
 150          * @param Title $target
 151          * @param string $reason
 152          * @param bool $createRedirect
 153          * @return bool Success
 154          */
 155         private function movePage( Title $current, Title $target, $reason, $createRedirect ) {
 156                 $display = $current->getPrefixedText();
 157                 $targetDisplay = $target->getPrefixedText();
 158
 159                 if ( $this->dryrun ) {
 160                         $this->output( "\"$display\" -> \"$targetDisplay\": DRY RUN, NOT MOVED\n" );
 161                         $ok = 'OK';
 162                 } else {
 163                         $mp = MediaWikiServices::getInstance()->getMovePageFactory()
 164                                 ->newMovePage( $current, $target );
 165                         $status = $mp->move( $this->user, $reason, $createRedirect );
 166                         $ok = $status->isOK() ? 'OK' : $status->getMessage( false, false, 'en' )->text();
 167                         $this->output( "\"$display\" -> \"$targetDisplay\": $ok\n" );
 168                 }
 169
 170                 return $ok === 'OK';
 171         }
 172 }
 173
 174 $maintClass = CleanupCaps::class;
 175 require_once RUN_MAINTENANCE_IF_MAIN;