MediaWiki  master
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() {
57 
58  $batchSize = $this->getBatchSize();
59  $db = $this->getDB( DB_MASTER );
60  if ( !$db->tableExists( 'log_search' ) ) {
61  $this->error( "log_search does not exist" );
62 
63  return false;
64  }
65  $start = $db->selectField( 'logging', 'MIN(log_id)', '', __FUNCTION__ );
66  if ( !$start ) {
67  $this->output( "Nothing to do.\n" );
68 
69  return true;
70  }
71  $end = $db->selectField( 'logging', 'MAX(log_id)', '', __FUNCTION__ );
72 
73  # Do remaining chunk
74  $end += $batchSize - 1;
75  $blockStart = $start;
76  $blockEnd = $start + $batchSize - 1;
77 
78  $delTypes = [ 'delete', 'suppress' ]; // revisiondelete types
79  while ( $blockEnd <= $end ) {
80  $this->output( "...doing log_id from $blockStart to $blockEnd\n" );
81  $cond = "log_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd;
82  $res = $db->select(
83  'logging', [ 'log_id', 'log_type', 'log_action', 'log_params' ], $cond, __FUNCTION__
84  );
85  foreach ( $res as $row ) {
86  if ( LogEventsList::typeAction( $row, $delTypes, 'revision' ) ) {
87  // RevisionDelete logs - revisions
88  $params = LogPage::extractParams( $row->log_params );
89  // Param format: <urlparam> <item CSV> [<ofield> <nfield>]
90  if ( count( $params ) < 2 ) {
91  continue; // bad row?
92  }
94  // B/C, the params may start with a title key (<title> <urlparam> <CSV>)
95  if ( $field == null ) {
96  array_shift( $params ); // remove title param
98  if ( $field == null ) {
99  $this->output( "Invalid param type for {$row->log_id}\n" );
100  continue; // skip this row
101  } else {
102  // Clean up the row...
103  $db->update( 'logging',
104  [ 'log_params' => implode( ',', $params ) ],
105  [ 'log_id' => $row->log_id ] );
106  }
107  }
108  $items = explode( ',', $params[1] );
109  $log = new LogPage( $row->log_type );
110  // Add item relations...
111  $log->addRelations( $field, $items, $row->log_id );
112  // Query item author relations...
113  $prefix = substr( $field, 0, strpos( $field, '_' ) ); // db prefix
114  if ( !isset( self::$tableMap[$prefix] ) ) {
115  continue; // bad row?
116  }
117  $tables = [ self::$tableMap[$prefix] ];
118  $fields = [];
119  $joins = [];
120  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
121  // Read the old fields if we're still writing them regardless of read mode, to handle upgrades
122  $fields['userid'] = $prefix . '_user';
123  $fields['username'] = $prefix . '_user_text';
124  }
125  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
126  // Read the new fields if we're writing them regardless of read mode, to handle upgrades
127  if ( $prefix === 'rev' ) {
128  $tables[] = 'revision_actor_temp';
129  $joins['revision_actor_temp'] = [
130  ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) ? 'LEFT JOIN' : 'JOIN',
131  'rev_id = revactor_rev',
132  ];
133  $fields['actorid'] = 'revactor_actor';
134  } else {
135  $fields['actorid'] = $prefix . '_actor';
136  }
137  }
138  $sres = $db->select( $tables, $fields, [ $field => $items ], __METHOD__, [], $joins );
139  } elseif ( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
140  // RevisionDelete logs - log events
141  $params = LogPage::extractParams( $row->log_params );
142  // Param format: <item CSV> [<ofield> <nfield>]
143  if ( count( $params ) < 1 ) {
144  continue; // bad row
145  }
146  $items = explode( ',', $params[0] );
147  $log = new LogPage( $row->log_type );
148  // Add item relations...
149  $log->addRelations( 'log_id', $items, $row->log_id );
150  // Query item author relations...
151  $fields = [];
152  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
153  // Read the old fields if we're still writing them regardless of read mode, to handle upgrades
154  $fields['userid'] = 'log_user';
155  $fields['username'] = 'log_user_text';
156  }
157  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
158  // Read the new fields if we're writing them regardless of read mode, to handle upgrades
159  $fields['actorid'] = 'log_actor';
160  }
161 
162  $sres = $db->select( 'logging', $fields, [ 'log_id' => $items ], __METHOD__ );
163  } else {
164  continue;
165  }
166 
167  // Add item author relations...
168  $userIds = $userIPs = $userActors = [];
169  foreach ( $sres as $srow ) {
170  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
171  if ( $srow->userid > 0 ) {
172  $userIds[] = intval( $srow->userid );
173  } elseif ( $srow->username != '' ) {
174  $userIPs[] = $srow->username;
175  }
176  }
177  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
178  if ( $srow->actorid ) {
179  $userActors[] = intval( $srow->actorid );
180  } elseif ( $srow->userid > 0 ) {
181  $userActors[] = User::newFromId( $srow->userid )->getActorId( $db );
182  } else {
183  $userActors[] = User::newFromName( $srow->username, false )->getActorId( $db );
184  }
185  }
186  }
187  // Add item author relations...
188  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
189  $log->addRelations( 'target_author_id', $userIds, $row->log_id );
190  $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
191  }
192  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
193  $log->addRelations( 'target_author_actor', $userActors, $row->log_id );
194  }
195  }
196  $blockStart += $batchSize;
197  $blockEnd += $batchSize;
198  wfWaitForSlaves();
199  }
200  $this->output( "Done populating log_search table.\n" );
201 
202  return true;
203  }
204 }
205 
207 require_once RUN_MAINTENANCE_IF_MAIN;
const SCHEMA_COMPAT_WRITE_OLD
Definition: Defines.php:280
static getRelationType( $typeName)
Get DB field name for URL param...
Maintenance script that makes the required database updates for populating the log_search table retro...
error( $err, $die=0)
Throw an error to the user.
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
static typeAction( $row, $type, $action, $right='')
setBatchSize( $s=0)
Set the batch size.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
const DB_MASTER
Definition: defines.php:26
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:979
Class to simplify the use of log pages.
Definition: LogPage.php:33
const SCHEMA_COMPAT_WRITE_NEW
Definition: Defines.php:282
$res
Definition: database.txt:21
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
addDescription( $text)
Set the description text.
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
output( $out, $channel=null)
Throw some output to the user.
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
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
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:618
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
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
getBatchSize()
Returns batch size.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:594
static extractParams( $blob)
Extract a parameter array from a blob.
Definition: LogPage.php:427