MediaWiki  1.30.0
populateLogSearch.php
Go to the documentation of this file.
1 <?php
25 require_once __DIR__ . '/Maintenance.php';
26 
34  private static $tableMap = [
35  'rev' => 'revision',
36  'fa' => 'filearchive',
37  'oi' => 'oldimage',
38  'ar' => 'archive'
39  ];
40 
41  public function __construct() {
42  parent::__construct();
43  $this->addDescription( 'Migrate log params to new table and index for searching' );
44  $this->setBatchSize( 100 );
45  }
46 
47  protected function getUpdateKey() {
48  return 'populate log_search';
49  }
50 
51  protected function updateSkippedMessage() {
52  return 'log_search table already populated.';
53  }
54 
55  protected function doDBUpdates() {
56  $db = $this->getDB( DB_MASTER );
57  if ( !$db->tableExists( 'log_search' ) ) {
58  $this->error( "log_search does not exist" );
59 
60  return false;
61  }
62  $start = $db->selectField( 'logging', 'MIN(log_id)', false, __FUNCTION__ );
63  if ( !$start ) {
64  $this->output( "Nothing to do.\n" );
65 
66  return true;
67  }
68  $end = $db->selectField( 'logging', 'MAX(log_id)', false, __FUNCTION__ );
69 
70  # Do remaining chunk
71  $end += $this->mBatchSize - 1;
72  $blockStart = $start;
73  $blockEnd = $start + $this->mBatchSize - 1;
74 
75  $delTypes = [ 'delete', 'suppress' ]; // revisiondelete types
76  while ( $blockEnd <= $end ) {
77  $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
78  $cond = "log_id BETWEEN $blockStart AND $blockEnd";
79  $res = $db->select( 'logging', '*', $cond, __FUNCTION__ );
80  foreach ( $res as $row ) {
81  // RevisionDelete logs - revisions
82  if ( LogEventsList::typeAction( $row, $delTypes, 'revision' ) ) {
83  $params = LogPage::extractParams( $row->log_params );
84  // Param format: <urlparam> <item CSV> [<ofield> <nfield>]
85  if ( count( $params ) < 2 ) {
86  continue; // bad row?
87  }
89  // B/C, the params may start with a title key (<title> <urlparam> <CSV>)
90  if ( $field == null ) {
91  array_shift( $params ); // remove title param
93  if ( $field == null ) {
94  $this->output( "Invalid param type for {$row->log_id}\n" );
95  continue; // skip this row
96  } else {
97  // Clean up the row...
98  $db->update( 'logging',
99  [ 'log_params' => implode( ',', $params ) ],
100  [ 'log_id' => $row->log_id ] );
101  }
102  }
103  $items = explode( ',', $params[1] );
104  $log = new LogPage( $row->log_type );
105  // Add item relations...
106  $log->addRelations( $field, $items, $row->log_id );
107  // Determine what table to query...
108  $prefix = substr( $field, 0, strpos( $field, '_' ) ); // db prefix
109  if ( !isset( self::$tableMap[$prefix] ) ) {
110  continue; // bad row?
111  }
112  $table = self::$tableMap[$prefix];
113  $userField = $prefix . '_user';
114  $userTextField = $prefix . '_user_text';
115  // Add item author relations...
116  $userIds = $userIPs = [];
117  $sres = $db->select( $table,
118  [ $userField, $userTextField ],
119  [ $field => $items ]
120  );
121  foreach ( $sres as $srow ) {
122  if ( $srow->$userField > 0 ) {
123  $userIds[] = intval( $srow->$userField );
124  } elseif ( $srow->$userTextField != '' ) {
125  $userIPs[] = $srow->$userTextField;
126  }
127  }
128  // Add item author relations...
129  $log->addRelations( 'target_author_id', $userIds, $row->log_id );
130  $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
131  } elseif ( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
132  // RevisionDelete logs - log events
133  $params = LogPage::extractParams( $row->log_params );
134  // Param format: <item CSV> [<ofield> <nfield>]
135  if ( count( $params ) < 1 ) {
136  continue; // bad row
137  }
138  $items = explode( ',', $params[0] );
139  $log = new LogPage( $row->log_type );
140  // Add item relations...
141  $log->addRelations( 'log_id', $items, $row->log_id );
142  // Add item author relations...
143  $userIds = $userIPs = [];
144  $sres = $db->select( 'logging',
145  [ 'log_user', 'log_user_text' ],
146  [ 'log_id' => $items ]
147  );
148  foreach ( $sres as $srow ) {
149  if ( $srow->log_user > 0 ) {
150  $userIds[] = intval( $srow->log_user );
151  } elseif ( IP::isIPAddress( $srow->log_user_text ) ) {
152  $userIPs[] = $srow->log_user_text;
153  }
154  }
155  $log->addRelations( 'target_author_id', $userIds, $row->log_id );
156  $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
157  }
158  }
159  $blockStart += $this->mBatchSize;
160  $blockEnd += $this->mBatchSize;
161  wfWaitForSlaves();
162  }
163  $this->output( "Done populating log_search table.\n" );
164 
165  return true;
166  }
167 }
168 
169 $maintClass = "PopulateLogSearch";
170 require_once RUN_MAINTENANCE_IF_MAIN;
Maintenance\$mBatchSize
int $mBatchSize
Batch size.
Definition: Maintenance.php:103
LogPage\extractParams
static extractParams( $blob)
Extract a parameter array from a blob.
Definition: LogPage.php:419
captcha-old.count
count
Definition: captcha-old.py:249
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:287
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:3010
php
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
PopulateLogSearch\__construct
__construct()
Default constructor.
Definition: populateLogSearch.php:41
LoggedUpdateMaintenance
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
Definition: Maintenance.php:1562
$maintClass
$maintClass
Definition: populateLogSearch.php:169
LogEventsList\typeAction
static typeAction( $row, $type, $action, $right='')
Definition: LogEventsList.php:505
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
DB_MASTER
const DB_MASTER
Definition: defines.php:26
PopulateLogSearch\updateSkippedMessage
updateSkippedMessage()
Message to show that the update was done already and was just skipped.
Definition: populateLogSearch.php:51
PopulateLogSearch
Maintenance script that makes the required database updates for populating the log_search table retro...
Definition: populateLogSearch.php:33
RevisionDeleter\getRelationType
static getRelationType( $typeName)
Get DB field name for URL param...
Definition: RevisionDeleter.php:154
PopulateLogSearch\doDBUpdates
doDBUpdates()
Do the actual work.
Definition: populateLogSearch.php:55
as
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
PopulateLogSearch\getUpdateKey
getUpdateKey()
Get the update key name to go in the update log table.
Definition: populateLogSearch.php:47
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1251
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:392
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:373
IP\isIPAddress
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
PopulateLogSearch\$tableMap
static $tableMap
Definition: populateLogSearch.php:34
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:314