3 * Makes the required database updates for populating the
4 * log_search table retroactively
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
25 require_once __DIR__
. '/Maintenance.php';
28 * Maintenance script that makes the required database updates for populating the
29 * log_search table retroactively
31 * @ingroup Maintenance
33 class PopulateLogSearch
extends LoggedUpdateMaintenance
{
34 private static $tableMap = [
36 'fa' => 'filearchive',
41 public function __construct() {
42 parent
::__construct();
43 $this->addDescription( 'Migrate log params to new table and index for searching' );
44 $this->setBatchSize( 100 );
47 protected function getUpdateKey() {
48 return 'populate log_search';
51 protected function updateSkippedMessage() {
52 return 'log_search table already populated.';
55 protected function doDBUpdates() {
56 global $wgActorTableSchemaMigrationStage;
58 $batchSize = $this->getBatchSize();
59 $db = $this->getDB( DB_MASTER
);
60 if ( !$db->tableExists( 'log_search' ) ) {
61 $this->error( "log_search does not exist" );
65 $start = $db->selectField( 'logging', 'MIN(log_id)', '', __FUNCTION__
);
67 $this->output( "Nothing to do.\n" );
71 $end = $db->selectField( 'logging', 'MAX(log_id)', '', __FUNCTION__
);
74 $end +
= $batchSize - 1;
76 $blockEnd = $start +
$batchSize - 1;
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;
83 'logging', [ 'log_id', 'log_type', 'log_action', 'log_params' ], $cond, __FUNCTION__
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 ) {
93 $field = RevisionDeleter
::getRelationType( $params[0] );
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
97 $field = RevisionDeleter
::getRelationType( $params[0] );
98 if ( $field == null ) {
99 $this->output( "Invalid param type for {$row->log_id}\n" );
100 continue; // skip this row
102 // Clean up the row...
103 $db->update( 'logging',
104 [ 'log_params' => implode( ',', $params ) ],
105 [ 'log_id' => $row->log_id
] );
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?
117 $tables = [ self
::$tableMap[$prefix] ];
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';
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',
133 $fields['actorid'] = 'revactor_actor';
135 $fields['actorid'] = $prefix . '_actor';
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 ) {
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...
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';
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';
162 $sres = $db->select( 'logging', $fields, [ 'log_id' => $items ], __METHOD__
);
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
;
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 );
183 $userActors[] = User
::newFromName( $srow->username
, false )->getActorId( $db );
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
);
192 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
193 $log->addRelations( 'target_author_actor', $userActors, $row->log_id
);
196 $blockStart +
= $batchSize;
197 $blockEnd +
= $batchSize;
200 $this->output( "Done populating log_search table.\n" );
206 $maintClass = PopulateLogSearch
::class;
207 require_once RUN_MAINTENANCE_IF_MAIN
;