MediaWiki  REL1_31
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 = [];
121  $fields['userid'] = $prefix . '_user';
122  $fields['username'] = $prefix . '_user_text';
123  }
125  if ( $prefix === 'rev' ) {
126  $tables[] = 'revision_actor_temp';
127  $joins['revision_actor_temp'] = [
128  $wgActorTableSchemaMigrationStage === MIGRATION_NEW ? 'JOIN' : 'LEFT JOIN',
129  'rev_id = revactor_rev',
130  ];
131  $fields['actorid'] = 'revactor_actor';
132  } else {
133  $fields['actorid'] = $prefix . '_actor';
134  }
135  }
136  $sres = $db->select( $tables, $fields, [ $field => $items ], __METHOD__, [], $joins );
137  } elseif ( LogEventsList::typeAction( $row, $delTypes, 'event' ) ) {
138  // RevisionDelete logs - log events
139  $params = LogPage::extractParams( $row->log_params );
140  // Param format: <item CSV> [<ofield> <nfield>]
141  if ( count( $params ) < 1 ) {
142  continue; // bad row
143  }
144  $items = explode( ',', $params[0] );
145  $log = new LogPage( $row->log_type );
146  // Add item relations...
147  $log->addRelations( 'log_id', $items, $row->log_id );
148  // Query item author relations...
149  $fields = [];
151  $fields['userid'] = 'log_user';
152  $fields['username'] = 'log_user_text';
153  }
155  $fields['actorid'] = 'log_actor';
156  }
157 
158  $sres = $db->select( 'logging', $fields, [ 'log_id' => $items ], __METHOD__ );
159  } else {
160  continue;
161  }
162 
163  // Add item author relations...
164  $userIds = $userIPs = $userActors = [];
165  foreach ( $sres as $srow ) {
167  if ( $srow->userid > 0 ) {
168  $userIds[] = intval( $srow->userid );
169  } elseif ( $srow->username != '' ) {
170  $userIPs[] = $srow->username;
171  }
172  }
174  if ( $srow->actorid ) {
175  $userActors[] = intval( $srow->actorid );
176  } elseif ( $srow->userid > 0 ) {
177  $userActors[] = User::newFromId( $srow->userid )->getActorId( $db );
178  } else {
179  $userActors[] = User::newFromName( $srow->username, false )->getActorId( $db );
180  }
181  }
182  }
183  // Add item author relations...
185  $log->addRelations( 'target_author_id', $userIds, $row->log_id );
186  $log->addRelations( 'target_author_ip', $userIPs, $row->log_id );
187  }
189  $log->addRelations( 'target_author_actor', $userActors, $row->log_id );
190  }
191  }
192  $blockStart += $batchSize;
193  $blockEnd += $batchSize;
194  wfWaitForSlaves();
195  }
196  $this->output( "Done populating log_search table.\n" );
197 
198  return true;
199  }
200 }
201 
203 require_once RUN_MAINTENANCE_IF_MAIN;
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
LogPage\extractParams
static extractParams( $blob)
Extract a parameter array from a blob.
Definition: LogPage.php:418
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
MIGRATION_NEW
const MIGRATION_NEW
Definition: Defines.php:305
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$params
$params
Definition: styleTest.css.php:40
MIGRATION_WRITE_BOTH
const MIGRATION_WRITE_BOTH
Definition: Defines.php:303
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
$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:2966
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:37
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:1640
$maintClass
$maintClass
Definition: populateLogSearch.php:202
LogEventsList\typeAction
static typeAction( $row, $type, $action, $right='')
Definition: LogEventsList.php:506
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
MIGRATION_OLD
const MIGRATION_OLD
Definition: Defines.php:302
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
$tables
this hook is for auditing only RecentChangesLinked and Watchlist 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:1015
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
Maintenance\getBatchSize
getBatchSize()
Returns batch size.
Definition: Maintenance.php:321
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:22
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:1309
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
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
PopulateLogSearch\$tableMap
static $tableMap
Definition: populateLogSearch.php:34
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:329
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8878