MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
19 require_once __DIR__ . '/Maintenance.php';
28  public function __construct() {
29  parent::__construct();
30  $this->addDescription( 'Remove autopatrol logs in the logging table' );
31  $this->addOption( 'dry-run', 'Print debug info instead of actually deleting' );
32  $this->addOption(
33  'check-old',
34  'Check old patrol logs (for deleting old format autopatrols).'
35  );
36  $this->addOption(
37  'before',
38  'Timestamp to delete only before that time, all MediaWiki timestamp formats are accepted',
39  false,
40  true
41  );
42  $this->addOption(
43  'from-id',
44  'First row (log id) to start updating from',
45  false,
46  true
47  );
48  $this->addOption(
49  'sleep',
50  'Sleep time (in seconds) between every batch',
51  false,
52  true
53  );
54  $this->setBatchSize( 1000 );
55  }
57  public function execute() {
58  $this->setBatchSize( $this->getOption( 'batch-size', $this->getBatchSize() ) );
60  $sleep = (int)$this->getOption( 'sleep', 10 );
61  $fromId = $this->getOption( 'from-id', null );
62  $this->countDown( 5 );
63  while ( true ) {
64  if ( $this->hasOption( 'check-old' ) ) {
65  $rowsData = $this->getRowsOld( $fromId );
66  // We reached end of the table
67  if ( !$rowsData ) {
68  break;
69  }
70  $rows = $rowsData['rows'];
71  $fromId = $rowsData['lastId'];
73  // There is nothing to delete in this batch
74  if ( !$rows ) {
75  continue;
76  }
77  } else {
78  $rows = $this->getRows( $fromId );
79  if ( !$rows ) {
80  break;
81  }
82  $fromId = end( $rows );
83  }
85  if ( $this->hasOption( 'dry-run' ) ) {
86  $this->output( 'These rows will get deleted: ' . implode( ', ', $rows ) . "\n" );
87  } else {
88  $this->deleteRows( $rows );
89  $this->output( 'Processed up to row id ' . end( $rows ) . "\n" );
90  }
92  if ( $sleep > 0 ) {
93  sleep( $sleep );
94  }
95  }
96  }
98  private function getRows( $fromId ) {
99  $dbr = MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection(
101  );
102  $before = $this->getOption( 'before', false );
104  $conds = [
105  'log_type' => 'patrol',
106  'log_action' => 'autopatrol',
107  ];
109  if ( $fromId ) {
110  $conds[] = 'log_id > ' . $dbr->addQuotes( $fromId );
111  }
113  if ( $before ) {
114  $conds[] = 'log_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $before ) );
115  }
117  return $dbr->selectFieldValues(
118  'logging',
119  'log_id',
120  $conds,
121  __METHOD__,
122  [ 'LIMIT' => $this->getBatchSize() ]
123  );
124  }
126  private function getRowsOld( $fromId ) {
127  $dbr = MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection(
129  );
130  $batchSize = $this->getBatchSize();
131  $before = $this->getOption( 'before', false );
133  $conds = [
134  'log_type' => 'patrol',
135  'log_action' => 'patrol',
136  ];
138  if ( $fromId ) {
139  $conds[] = 'log_id > ' . $dbr->addQuotes( $fromId );
140  }
142  if ( $before ) {
143  $conds[] = 'log_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $before ) );
144  }
146  $result = $dbr->select(
147  'logging',
148  [ 'log_id', 'log_params' ],
149  $conds,
150  __METHOD__,
151  [ 'LIMIT' => $batchSize ]
152  );
154  $last = null;
155  $autopatrols = [];
156  foreach ( $result as $row ) {
157  $last = $row->log_id;
158  $logEntry = DatabaseLogEntry::newFromRow( $row );
159  $params = $logEntry->getParameters();
160  if ( !is_array( $params ) ) {
161  continue;
162  }
164  // This logic belongs to PatrolLogFormatter::getMessageKey
165  // and LogFormatter::extractParameters the 'auto' value is logically presented as key [5].
166  // For legacy case the logical key is index + 3, meaning [2].
167  // For the modern case, the logical key is index - 1 meaning [6].
168  if ( array_key_exists( '6::auto', $params ) ) {
169  // Between 2011-2016 autopatrol logs
170  $auto = $params['6::auto'] === true;
171  } elseif ( $logEntry->isLegacy() === true && array_key_exists( 2, $params ) ) {
172  // Pre-2011 autopatrol logs
173  $auto = $params[2] === '1';
174  } else {
175  continue;
176  }
178  if ( $auto === true ) {
179  $autopatrols[] = $row->log_id;
180  }
181  }
183  if ( $last === null ) {
184  return null;
185  }
187  return [ 'rows' => $autopatrols, 'lastId' => $last ];
188  }
190  private function deleteRows( array $rows ) {
191  $dbw = MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection(
193  );
195  $dbw->delete(
196  'logging',
197  [ 'log_id' => $rows ],
198  __METHOD__
199  );
201  MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->waitForReplication();
202  }
204 }
207 require_once RUN_MAINTENANCE_IF_MAIN;
getRows( $fromId)
Definition: deleteAutoPatrolLogs.php:98
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
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. '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. '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 '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 since 1.28! 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:1983
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition: deleteAutoPatrolLogs.php:26
Definition: maintenance.txt:50
Definition: styleTest.css.php:44
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
Definition: profileinfo.php:416
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:35
Definition: testCompression.php:50
Do the actual work.
Definition: deleteAutoPatrolLogs.php:57
static newFromRow( $row)
Constructs new LogEntry from database result row.
Definition: LogEntry.php:212
Default constructor.
Definition: deleteAutoPatrolLogs.php:28
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:248
Definition: defines.php:25
Definition: defines.php:26
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("", 2))
countDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
Definition: Maintenance.php:1545
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped true if there is text before this autocomment $auto
Definition: hooks.txt:1476
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:124
getRowsOld( $fromId)
Definition: deleteAutoPatrolLogs.php:126
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:283
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2636
Returns batch size.
Definition: Maintenance.php:367
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:9
Definition: deleteAutoPatrolLogs.php:206
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:434
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:52
hasOption( $name)
Checks to see if a particular option exists.
Definition: Maintenance.php:269
deleteRows(array $rows)
Definition: deleteAutoPatrolLogs.php:190
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:375