MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
31 require_once __DIR__ . '/Maintenance.php';
41 class Orphans extends Maintenance {
42  public function __construct() {
43  parent::__construct();
44  $this->addDescription( "Look for 'orphan' revisions hooked to pages which don't exist\n" .
45  "and 'childless' pages with no revisions\n" .
46  "Then, kill the poor widows and orphans\n" .
47  "Man this is depressing"
48  );
49  $this->addOption( 'fix', 'Actually fix broken entries' );
50  }
52  public function execute() {
53  $this->checkOrphans( $this->hasOption( 'fix' ) );
54  $this->checkSeparation( $this->hasOption( 'fix' ) );
55  # Does not work yet, do not use
56  # $this->checkWidows( $this->hasOption( 'fix' ) );
57  }
64  private function lockTables( $db, $extraTable = [] ) {
65  $tbls = [ 'page', 'revision', 'redirect' ];
66  if ( $extraTable ) {
67  $tbls = array_merge( $tbls, $extraTable );
68  }
69  $db->lockTables( [], $tbls, __METHOD__, false );
70  }
76  private function checkOrphans( $fix ) {
77  $dbw = $this->getDB( DB_MASTER );
78  $commentStore = CommentStore::getStore();
80  if ( $fix ) {
81  $this->lockTables( $dbw );
82  }
84  $commentQuery = $commentStore->getJoin( 'rev_comment' );
85  $actorQuery = ActorMigration::newMigration()->getJoin( 'rev_user' );
87  $this->output( "Checking for orphan revision table entries... "
88  . "(this may take a while on a large wiki)\n" );
89  $result = $dbw->select(
90  [ 'revision', 'page' ] + $commentQuery['tables'] + $actorQuery['tables'],
91  [ 'rev_id', 'rev_page', 'rev_timestamp' ] + $commentQuery['fields'] + $actorQuery['fields'],
92  [ 'page_id' => null ],
93  __METHOD__,
94  [],
95  [ 'page' => [ 'LEFT JOIN', [ 'rev_page=page_id' ] ] ] + $commentQuery['joins']
96  + $actorQuery['joins']
97  );
98  $orphans = $result->numRows();
99  if ( $orphans > 0 ) {
102  $this->output( "$orphans orphan revisions...\n" );
103  $this->output( sprintf(
104  "%10s %10s %14s %20s %s\n",
105  'rev_id', 'rev_page', 'rev_timestamp', 'rev_user_text', 'rev_comment'
106  ) );
108  foreach ( $result as $row ) {
109  $comment = $commentStore->getComment( 'rev_comment', $row )->text;
110  if ( $comment !== '' ) {
111  $comment = '(' . $wgContLang->truncate( $comment, 40 ) . ')';
112  }
113  $this->output( sprintf( "%10d %10d %14s %20s %s\n",
114  $row->rev_id,
115  $row->rev_page,
116  $row->rev_timestamp,
117  $wgContLang->truncate( $row->rev_user_text, 17 ),
118  $comment ) );
119  if ( $fix ) {
120  $dbw->delete( 'revision', [ 'rev_id' => $row->rev_id ] );
121  }
122  }
123  if ( !$fix ) {
124  $this->output( "Run again with --fix to remove these entries automatically.\n" );
125  }
126  } else {
127  $this->output( "No orphans! Yay!\n" );
128  }
130  if ( $fix ) {
131  $dbw->unlockTables( __METHOD__ );
132  }
133  }
141  private function checkWidows( $fix ) {
142  $dbw = $this->getDB( DB_MASTER );
143  $page = $dbw->tableName( 'page' );
144  $revision = $dbw->tableName( 'revision' );
146  if ( $fix ) {
147  $this->lockTables( $dbw );
148  }
150  $this->output( "\nChecking for childless page table entries... "
151  . "(this may take a while on a large wiki)\n" );
152  $result = $dbw->query( "
153  SELECT *
154  FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
155  WHERE rev_id IS NULL
156  " );
157  $widows = $result->numRows();
158  if ( $widows > 0 ) {
159  $this->output( "$widows childless pages...\n" );
160  $this->output( sprintf( "%10s %11s %2s %s\n", 'page_id', 'page_latest', 'ns', 'page_title' ) );
161  foreach ( $result as $row ) {
162  printf( "%10d %11d %2d %s\n",
163  $row->page_id,
164  $row->page_latest,
165  $row->page_namespace,
166  $row->page_title );
167  if ( $fix ) {
168  $dbw->delete( 'page', [ 'page_id' => $row->page_id ] );
169  }
170  }
171  if ( !$fix ) {
172  $this->output( "Run again with --fix to remove these entries automatically.\n" );
173  }
174  } else {
175  $this->output( "No childless pages! Yay!\n" );
176  }
178  if ( $fix ) {
179  $dbw->unlockTables( __METHOD__ );
180  }
181  }
187  private function checkSeparation( $fix ) {
188  $dbw = $this->getDB( DB_MASTER );
189  $page = $dbw->tableName( 'page' );
190  $revision = $dbw->tableName( 'revision' );
192  if ( $fix ) {
193  $this->lockTables( $dbw, [ 'user', 'text' ] );
194  }
196  $this->output( "\nChecking for pages whose page_latest links are incorrect... "
197  . "(this may take a while on a large wiki)\n" );
198  $result = $dbw->query( "
199  SELECT *
200  FROM $page LEFT OUTER JOIN $revision ON page_latest=rev_id
201  " );
202  $found = 0;
203  foreach ( $result as $row ) {
204  $result2 = $dbw->query( "
205  SELECT MAX(rev_timestamp) as max_timestamp
206  FROM $revision
207  WHERE rev_page=" . (int)( $row->page_id )
208  );
209  $row2 = $dbw->fetchObject( $result2 );
210  if ( $row2 ) {
211  if ( $row->rev_timestamp != $row2->max_timestamp ) {
212  if ( $found == 0 ) {
213  $this->output( sprintf( "%10s %10s %14s %14s\n",
214  'page_id', 'rev_id', 'timestamp', 'max timestamp' ) );
215  }
216  ++$found;
217  $this->output( sprintf( "%10d %10d %14s %14s\n",
218  $row->page_id,
219  $row->page_latest,
220  $row->rev_timestamp,
221  $row2->max_timestamp ) );
222  if ( $fix ) {
223  # ...
224  $maxId = $dbw->selectField(
225  'revision',
226  'rev_id',
227  [
228  'rev_page' => $row->page_id,
229  'rev_timestamp' => $row2->max_timestamp ] );
230  $this->output( "... updating to revision $maxId\n" );
231  $maxRev = Revision::newFromId( $maxId );
232  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
234  $article->updateRevisionOn( $dbw, $maxRev );
235  }
236  }
237  } else {
238  $this->output( "wtf\n" );
239  }
240  }
242  if ( $found ) {
243  $this->output( "Found $found pages with incorrect latest revision.\n" );
244  } else {
245  $this->output( "No pages with incorrect latest revision. Yay!\n" );
246  }
247  if ( !$fix && $found > 0 ) {
248  $this->output( "Run again with --fix to remove these entries automatically.\n" );
249  }
251  if ( $fix ) {
252  $dbw->unlockTables( __METHOD__ );
253  }
254  }
255 }
258 require_once RUN_MAINTENANCE_IF_MAIN;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
Definition: maintenance.txt:50
checkWidows( $fix)
Definition: orphans.php:141
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
Default constructor.
Definition: orphans.php:42
checkSeparation( $fix)
Check for pages where page_latest is wrong.
Definition: orphans.php:187
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
Definition: defines.php:29
checkOrphans( $fix)
Check for orphan revisions.
Definition: orphans.php:76
lockTables( $db, $extraTable=[])
Lock the appropriate tables for the script.
Definition: orphans.php:64
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance script that looks for 'orphan' revisions hooked to pages which don't exist and 'childless...
Definition: orphans.php:41
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Do the actual work.
Definition: orphans.php:52
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
static getStore()
Definition: CommentStore.php:130
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:38
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
Definition: orphans.php:257