]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - maintenance/orphans.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / maintenance / orphans.php
index 480b72207f33895109ee5ab28dfad49669c2774f..644fb958df655154b83c937c61a3c1d52a6948bc 100644 (file)
 <?php
-# Copyright (C) 2005 Brion Vibber <brion@pobox.com>
-# http://www.mediawiki.org/
-#
-# 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
-
 /**
- * Look for 'orphan' revisions hooked to pages which don't exist
- * And 'childless' pages with no revisions.
+ * Look for 'orphan' revisions hooked to pages which don't exist and
+ * 'childless' pages with no revisions.
  * Then, kill the poor widows and orphans.
  * Man this is depressing.
  *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
+ * https://www.mediawiki.org/
+ *
+ * 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
  * @author <brion@pobox.com>
  * @ingroup Maintenance
  */
 
-$options = array( 'fix' );
-
-/** */
-require_once( 'commandLine.inc' );
-$wgTitle = Title::newFromText( 'Orphan revision cleanup script' );
-
-checkOrphans( isset( $options['fix'] ) );
-checkSeparation( isset( $options['fix'] ) );
-#checkWidows( isset( $options['fix'] ) );
+require_once __DIR__ . '/Maintenance.php';
 
-# ------
+use Wikimedia\Rdbms\IMaintainableDatabase;
 
-function checkOrphans( $fix ) {
-       $dbw = wfGetDB( DB_MASTER );
-       $page = $dbw->tableName( 'page' );
-       $revision = $dbw->tableName( 'revision' );
+/**
+ * Maintenance script that looks for 'orphan' revisions hooked to pages which
+ * don't exist and 'childless' pages with no revisions.
+ *
+ * @ingroup Maintenance
+ */
+class Orphans extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->addDescription( "Look for 'orphan' revisions hooked to pages which don't exist\n" .
+                       "and 'childless' pages with no revisions\n" .
+                       "Then, kill the poor widows and orphans\n" .
+                       "Man this is depressing"
+               );
+               $this->addOption( 'fix', 'Actually fix broken entries' );
+       }
 
-       if( $fix ) {
-               $dbw->query( "LOCK TABLES $page WRITE, $revision WRITE" );
+       public function execute() {
+               $this->checkOrphans( $this->hasOption( 'fix' ) );
+               $this->checkSeparation( $this->hasOption( 'fix' ) );
+               # Does not work yet, do not use
+               # $this->checkWidows( $this->hasOption( 'fix' ) );
        }
 
-       echo "Checking for orphan revision table entries... (this may take a while on a large wiki)\n";
-       $result = $dbw->query( "
-               SELECT *
-               FROM $revision LEFT OUTER JOIN $page ON rev_page=page_id
-               WHERE page_id IS NULL
-       ");
-       $orphans = $dbw->numRows( $result );
-       if( $orphans > 0 ) {
-               global $wgContLang;
-               echo "$orphans orphan revisions...\n";
-               printf( "%10s %10s %14s %20s %s\n", 'rev_id', 'rev_page', 'rev_timestamp', 'rev_user_text', 'rev_comment' );
-               while( $row = $dbw->fetchObject( $result ) ) {
-                       $comment = ( $row->rev_comment == '' )
-                               ? ''
-                               : '(' . $wgContLang->truncate( $row->rev_comment, 40 ) . ')';
-                       printf( "%10d %10d %14s %20s %s\n",
-                               $row->rev_id,
-                               $row->rev_page,
-                               $row->rev_timestamp,
-                               $wgContLang->truncate( $row->rev_user_text, 17 ),
-                               $comment );
-                       if( $fix ) {
-                               $dbw->delete( 'revision', array( 'rev_id' => $row->rev_id ) );
-                       }
-               }
-               if( !$fix ) {
-                       echo "Run again with --fix to remove these entries automatically.\n";
+       /**
+        * Lock the appropriate tables for the script
+        * @param IMaintainableDatabase $db
+        * @param string[] $extraTable The name of any extra tables to lock (eg: text)
+        */
+       private function lockTables( $db, $extraTable = [] ) {
+               $tbls = [ 'page', 'revision', 'redirect' ];
+               if ( $extraTable ) {
+                       $tbls = array_merge( $tbls, $extraTable );
                }
-       } else {
-               echo "No orphans! Yay!\n";
+               $db->lockTables( [], $tbls, __METHOD__, false );
        }
 
-       if( $fix ) {
-               $dbw->query( "UNLOCK TABLES" );
-       }
-}
+       /**
+        * Check for orphan revisions
+        * @param bool $fix Whether to fix broken revisions when found
+        */
+       private function checkOrphans( $fix ) {
+               $dbw = $this->getDB( DB_MASTER );
+               $commentStore = new CommentStore( 'rev_comment' );
 
-/**
- * @todo DON'T USE THIS YET! It will remove entries which have children,
- *       but which aren't properly attached (eg if page_latest is bogus
- *       but valid revisions do exist)
- */
-function checkWidows( $fix ) {
-       $dbw = wfGetDB( DB_MASTER );
-       $page = $dbw->tableName( 'page' );
-       $revision = $dbw->tableName( 'revision' );
+               if ( $fix ) {
+                       $this->lockTables( $dbw );
+               }
 
-       if( $fix ) {
-               $dbw->query( "LOCK TABLES $page WRITE, $revision WRITE" );
-       }
+               $commentQuery = $commentStore->getJoin();
+
+               $this->output( "Checking for orphan revision table entries... "
+                       . "(this may take a while on a large wiki)\n" );
+               $result = $dbw->select(
+                       [ 'revision', 'page' ] + $commentQuery['tables'],
+                       [ 'rev_id', 'rev_page', 'rev_timestamp', 'rev_user_text' ] + $commentQuery['fields'],
+                       [ 'page_id' => null ],
+                       __METHOD__,
+                       [],
+                       [ 'page' => [ 'LEFT JOIN', [ 'rev_page=page_id' ] ] ] + $commentQuery['joins']
+               );
+               $orphans = $result->numRows();
+               if ( $orphans > 0 ) {
+                       global $wgContLang;
 
-       echo "\nChecking for childless page table entries... (this may take a while on a large wiki)\n";
-       $result = $dbw->query( "
-               SELECT *
-               FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
-               WHERE rev_id IS NULL
-       ");
-       $widows = $dbw->numRows( $result );
-       if( $widows > 0 ) {
-               global $wgContLang;
-               echo "$widows childless pages...\n";
-               printf( "%10s %11s %2s %s\n", 'page_id', 'page_latest', 'ns', 'page_title' );
-               while( $row = $dbw->fetchObject( $result ) ) {
-                       printf( "%10d %11d %2d %s\n",
-                               $row->page_id,
-                               $row->page_latest,
-                               $row->page_namespace,
-                               $row->page_title );
-                       if( $fix ) {
-                               $dbw->delete( 'page', array( 'page_id' => $row->page_id ) );
+                       $this->output( "$orphans orphan revisions...\n" );
+                       $this->output( sprintf(
+                               "%10s %10s %14s %20s %s\n",
+                               'rev_id', 'rev_page', 'rev_timestamp', 'rev_user_text', 'rev_comment'
+                       ) );
+
+                       foreach ( $result as $row ) {
+                               $comment = $commentStore->getComment( $row )->text;
+                               if ( $comment !== '' ) {
+                                       $comment = '(' . $wgContLang->truncate( $comment, 40 ) . ')';
+                               }
+                               $this->output( sprintf( "%10d %10d %14s %20s %s\n",
+                                       $row->rev_id,
+                                       $row->rev_page,
+                                       $row->rev_timestamp,
+                                       $wgContLang->truncate( $row->rev_user_text, 17 ),
+                                       $comment ) );
+                               if ( $fix ) {
+                                       $dbw->delete( 'revision', [ 'rev_id' => $row->rev_id ] );
+                               }
                        }
+                       if ( !$fix ) {
+                               $this->output( "Run again with --fix to remove these entries automatically.\n" );
+                       }
+               } else {
+                       $this->output( "No orphans! Yay!\n" );
                }
-               if( !$fix ) {
-                       echo "Run again with --fix to remove these entries automatically.\n";
-               }
-       } else {
-               echo "No childless pages! Yay!\n";
-       }
 
-       if( $fix ) {
-               $dbw->query( "UNLOCK TABLES" );
+               if ( $fix ) {
+                       $dbw->unlockTables( __METHOD__ );
+               }
        }
-}
 
+       /**
+        * @param bool $fix
+        * @todo DON'T USE THIS YET! It will remove entries which have children,
+        *       but which aren't properly attached (eg if page_latest is bogus
+        *       but valid revisions do exist)
+        */
+       private function checkWidows( $fix ) {
+               $dbw = $this->getDB( DB_MASTER );
+               $page = $dbw->tableName( 'page' );
+               $revision = $dbw->tableName( 'revision' );
 
-function checkSeparation( $fix ) {
-       $dbw = wfGetDB( DB_MASTER );
-       $page     = $dbw->tableName( 'page' );
-       $revision = $dbw->tableName( 'revision' );
-       $text     = $dbw->tableName( 'text' );
-
-       if( $fix ) {
-               $dbw->query( "LOCK TABLES $page WRITE, $revision WRITE, $text WRITE" );
-       }
+               if ( $fix ) {
+                       $this->lockTables( $dbw );
+               }
 
-       echo "\nChecking for pages whose page_latest links are incorrect... (this may take a while on a large wiki)\n";
-       $result = $dbw->query( "
-               SELECT *
-               FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
-       ");
-       $found = 0;
-       while( $row = $dbw->fetchObject( $result ) ) {
-               $result2 = $dbw->query( "
-                       SELECT MAX(rev_timestamp) as max_timestamp
-                       FROM $revision
-                       WHERE rev_page=$row->page_id
+               $this->output( "\nChecking for childless page table entries... "
+                       . "(this may take a while on a large wiki)\n" );
+               $result = $dbw->query( "
+                       SELECT *
+                       FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
+                       WHERE rev_id IS NULL
                " );
-               $row2 = $dbw->fetchObject( $result2 );
-               $dbw->freeResult( $result2 );
-               if( $row2 ) {
-                       if( $row->rev_timestamp != $row2->max_timestamp ) {
-                               if( $found == 0 ) {
-                                       printf( "%10s %10s %14s %14s\n",
-                                               'page_id', 'rev_id', 'timestamp', 'max timestamp' );
-                               }
-                               ++$found;
-                               printf( "%10d %10d %14s %14s\n",
+               $widows = $result->numRows();
+               if ( $widows > 0 ) {
+                       $this->output( "$widows childless pages...\n" );
+                       $this->output( sprintf( "%10s %11s %2s %s\n", 'page_id', 'page_latest', 'ns', 'page_title' ) );
+                       foreach ( $result as $row ) {
+                               printf( "%10d %11d %2d %s\n",
                                        $row->page_id,
                                        $row->page_latest,
-                                       $row->rev_timestamp,
-                                       $row2->max_timestamp );
-                               if( $fix ) {
-                                       # ...
-                                       $maxId = $dbw->selectField(
-                                               'revision',
-                                               'rev_id',
-                                               array(
-                                                       'rev_page'      => $row->page_id,
-                                                       'rev_timestamp' => $row2->max_timestamp ) );
-                                       echo "... updating to revision $maxId\n";
-                                       $maxRev = Revision::newFromId( $maxId );
-                                       $title = Title::makeTitle( $row->page_namespace, $row->page_title );
-                                       $article = new Article( $title );
-                                       $article->updateRevisionOn( $dbw, $maxRev );
+                                       $row->page_namespace,
+                                       $row->page_title );
+                               if ( $fix ) {
+                                       $dbw->delete( 'page', [ 'page_id' => $row->page_id ] );
                                }
                        }
+                       if ( !$fix ) {
+                               $this->output( "Run again with --fix to remove these entries automatically.\n" );
+                       }
                } else {
-                       echo "wtf\n";
+                       $this->output( "No childless pages! Yay!\n" );
                }
-       }
 
-       if( $found ) {
-               echo "Found $found pages with incorrect latest revision.\n";
-       } else {
-               echo "No pages with incorrect latest revision. Yay!\n";
-       }
-       if( !$fix && $found > 0 ) {
-               echo "Run again with --fix to remove these entries automatically.\n";
+               if ( $fix ) {
+                       $dbw->unlockTables( __METHOD__ );
+               }
        }
 
-       if( $fix ) {
-               $dbw->query( "UNLOCK TABLES" );
+       /**
+        * Check for pages where page_latest is wrong
+        * @param bool $fix Whether to fix broken entries
+        */
+       private function checkSeparation( $fix ) {
+               $dbw = $this->getDB( DB_MASTER );
+               $page = $dbw->tableName( 'page' );
+               $revision = $dbw->tableName( 'revision' );
+
+               if ( $fix ) {
+                       $this->lockTables( $dbw, [ 'user', 'text' ] );
+               }
+
+               $this->output( "\nChecking for pages whose page_latest links are incorrect... "
+                       . "(this may take a while on a large wiki)\n" );
+               $result = $dbw->query( "
+                       SELECT *
+                       FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
+               " );
+               $found = 0;
+               foreach ( $result as $row ) {
+                       $result2 = $dbw->query( "
+                               SELECT MAX(rev_timestamp) as max_timestamp
+                               FROM $revision
+                               WHERE rev_page=$row->page_id
+                       " );
+                       $row2 = $dbw->fetchObject( $result2 );
+                       if ( $row2 ) {
+                               if ( $row->rev_timestamp != $row2->max_timestamp ) {
+                                       if ( $found == 0 ) {
+                                               $this->output( sprintf( "%10s %10s %14s %14s\n",
+                                                       'page_id', 'rev_id', 'timestamp', 'max timestamp' ) );
+                                       }
+                                       ++$found;
+                                       $this->output( sprintf( "%10d %10d %14s %14s\n",
+                                               $row->page_id,
+                                               $row->page_latest,
+                                               $row->rev_timestamp,
+                                               $row2->max_timestamp ) );
+                                       if ( $fix ) {
+                                               # ...
+                                               $maxId = $dbw->selectField(
+                                                       'revision',
+                                                       'rev_id',
+                                                       [
+                                                               'rev_page' => $row->page_id,
+                                                               'rev_timestamp' => $row2->max_timestamp ] );
+                                               $this->output( "... updating to revision $maxId\n" );
+                                               $maxRev = Revision::newFromId( $maxId );
+                                               $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+                                               $article = WikiPage::factory( $title );
+                                               $article->updateRevisionOn( $dbw, $maxRev );
+                                       }
+                               }
+                       } else {
+                               $this->output( "wtf\n" );
+                       }
+               }
+
+               if ( $found ) {
+                       $this->output( "Found $found pages with incorrect latest revision.\n" );
+               } else {
+                       $this->output( "No pages with incorrect latest revision. Yay!\n" );
+               }
+               if ( !$fix && $found > 0 ) {
+                       $this->output( "Run again with --fix to remove these entries automatically.\n" );
+               }
+
+               if ( $fix ) {
+                       $dbw->unlockTables( __METHOD__ );
+               }
        }
 }
 
+$maintClass = "Orphans";
+require_once RUN_MAINTENANCE_IF_MAIN;