maintenance/rebuildrecentchanges.php

   1 <?php
   2 /**
   3  * Rebuild recent changes from scratch.  This takes several hours,
   4  * depending on the database size and server configuration.
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  * @todo Document
  24  */
  25
  26 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script that rebuilds recent changes from scratch.
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class RebuildRecentchanges extends Maintenance {
  34         public function __construct() {
  35                 parent::__construct();
  36                 $this->mDescription = "Rebuild recent changes";
  37         }
  38
  39         public function execute() {
  40                 $this->rebuildRecentChangesTablePass1();
  41                 $this->rebuildRecentChangesTablePass2();
  42                 $this->rebuildRecentChangesTablePass3();
  43                 $this->rebuildRecentChangesTablePass4();
  44                 $this->purgeFeeds();
  45                 $this->output( "Done.\n" );
  46         }
  47
  48         /**
  49          * Rebuild pass 1
  50          * DOCUMENT ME!
  51          */
  52         private function rebuildRecentChangesTablePass1() {
  53                 $dbw = wfGetDB( DB_MASTER );
  54
  55                 $dbw->delete( 'recentchanges', '*' );
  56
  57                 $this->output( "Loading from page and revision tables...\n" );
  58
  59                 global $wgRCMaxAge;
  60
  61                 $this->output( '$wgRCMaxAge=' . $wgRCMaxAge );
  62                 $days = $wgRCMaxAge / 24 / 3600;
  63                 if ( intval( $days ) == $days ) {
  64                         $this->output( " (" . $days . " days)\n" );
  65                 } else {
  66                         $this->output( " (approx. " . intval( $days ) . " days)\n" );
  67                 }
  68
  69                 $cutoff = time() - $wgRCMaxAge;
  70                 $dbw->insertSelect( 'recentchanges', array( 'page', 'revision' ),
  71                         array(
  72                                 'rc_timestamp'  => 'rev_timestamp',
  73                                 'rc_user'       => 'rev_user',
  74                                 'rc_user_text'  => 'rev_user_text',
  75                                 'rc_namespace'  => 'page_namespace',
  76                                 'rc_title'      => 'page_title',
  77                                 'rc_comment'    => 'rev_comment',
  78                                 'rc_minor'      => 'rev_minor_edit',
  79                                 'rc_bot'        => 0,
  80                                 'rc_new'        => 'page_is_new',
  81                                 'rc_cur_id'     => 'page_id',
  82                                 'rc_this_oldid' => 'rev_id',
  83                                 'rc_last_oldid' => 0, // is this ok?
  84                                 'rc_type'       => $dbw->conditional( 'page_is_new != 0', RC_NEW, RC_EDIT ),
  85                                 'rc_source'     => $dbw->conditional( 'page_is_new != 0', $dbw->addQuotes( RecentChange::SRC_NEW ), $dbw->addQuotes( RecentChange::SRC_EDIT ) ),
  86                                 'rc_deleted'    => 'rev_deleted'
  87                         ), array(
  88                                 'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $cutoff ) ),
  89                                 'rev_page=page_id'
  90                         ), __METHOD__,
  91                         array(), // INSERT options
  92                         array( 'ORDER BY' => 'rev_timestamp DESC', 'LIMIT' => 5000 ) // SELECT options
  93                 );
  94         }
  95
  96         /**
  97          * Rebuild pass 2
  98          * DOCUMENT ME!
  99          */
 100         private function rebuildRecentChangesTablePass2() {
 101                 $dbw = wfGetDB( DB_MASTER );
 102                 list( $recentchanges, $revision ) = $dbw->tableNamesN( 'recentchanges', 'revision' );
 103
 104                 $this->output( "Updating links and size differences...\n" );
 105
 106                 # Fill in the rc_last_oldid field, which points to the previous edit
 107                 $sql = "SELECT rc_cur_id,rc_this_oldid,rc_timestamp FROM $recentchanges " .
 108                         "ORDER BY rc_cur_id,rc_timestamp";
 109                 $res = $dbw->query( $sql, DB_MASTER );
 110
 111                 $lastCurId = 0;
 112                 $lastOldId = 0;
 113                 foreach ( $res as $obj ) {
 114                         $new = 0;
 115                         if ( $obj->rc_cur_id != $lastCurId ) {
 116                                 # Switch! Look up the previous last edit, if any
 117                                 $lastCurId = intval( $obj->rc_cur_id );
 118                                 $emit = $obj->rc_timestamp;
 119                                 $sql2 = "SELECT rev_id,rev_len FROM $revision " .
 120                                         "WHERE rev_page={$lastCurId} " .
 121                                         "AND rev_timestamp<'{$emit}' ORDER BY rev_timestamp DESC";
 122                                 $sql2 = $dbw->limitResult( $sql2, 1, false );
 123                                 $res2 = $dbw->query( $sql2 );
 124                                 $row = $dbw->fetchObject( $res2 );
 125                                 if ( $row ) {
 126                                         $lastOldId = intval( $row->rev_id );
 127                                         # Grab the last text size if available
 128                                         $lastSize = !is_null( $row->rev_len ) ? intval( $row->rev_len ) : null;
 129                                 } else {
 130                                         # No previous edit
 131                                         $lastOldId = 0;
 132                                         $lastSize = null;
 133                                         $new = 1; // probably true
 134                                 }
 135                         }
 136                         if ( $lastCurId == 0 ) {
 137                                 $this->output( "Uhhh, something wrong? No curid\n" );
 138                         } else {
 139                                 # Grab the entry's text size
 140                                 $size = $dbw->selectField( 'revision', 'rev_len', array( 'rev_id' => $obj->rc_this_oldid ) );
 141
 142                                 $dbw->update( 'recentchanges',
 143                                         array(
 144                                                 'rc_last_oldid' => $lastOldId,
 145                                                 'rc_new' => $new,
 146                                                 'rc_type' => $new,
 147                                                 'rc_source' => $new === 1 ? RecentChange::SRC_NEW : RecentChange::SRC_EDIT,
 148                                                 'rc_old_len' => $lastSize,
 149                                                 'rc_new_len' => $size,
 150                                         ), array(
 151                                                 'rc_cur_id' => $lastCurId,
 152                                                 'rc_this_oldid' => $obj->rc_this_oldid,
 153                                         ),
 154                                         __METHOD__
 155                                 );
 156
 157                                 $lastOldId = intval( $obj->rc_this_oldid );
 158                                 $lastSize = $size;
 159                         }
 160                 }
 161         }
 162
 163         /**
 164          * Rebuild pass 3
 165          * DOCUMENT ME!
 166          */
 167         private function rebuildRecentChangesTablePass3() {
 168                 $dbw = wfGetDB( DB_MASTER );
 169
 170                 $this->output( "Loading from user, page, and logging tables...\n" );
 171
 172                 global $wgRCMaxAge, $wgLogTypes, $wgLogRestrictions;
 173                 // Some logs don't go in RC. This should check for that
 174                 $basicRCLogs = array_diff( $wgLogTypes, array_keys( $wgLogRestrictions ) );
 175
 176                 // Escape...blah blah
 177                 $selectLogs = array();
 178                 foreach ( $basicRCLogs as $logtype ) {
 179                         $safetype = $dbw->strencode( $logtype );
 180                         $selectLogs[] = "'$safetype'";
 181                 }
 182
 183                 $cutoff = time() - $wgRCMaxAge;
 184                 list( $logging, $page ) = $dbw->tableNamesN( 'logging', 'page' );
 185                 $dbw->insertSelect( 'recentchanges', array( 'user', "$logging LEFT JOIN $page ON (log_namespace=page_namespace AND log_title=page_title)" ),
 186                         array(
 187                                 'rc_timestamp'  => 'log_timestamp',
 188                                 'rc_user'       => 'log_user',
 189                                 'rc_user_text'  => 'user_name',
 190                                 'rc_namespace'  => 'log_namespace',
 191                                 'rc_title'      => 'log_title',
 192                                 'rc_comment'    => 'log_comment',
 193                                 'rc_minor'      => 0,
 194                                 'rc_bot'        => 0,
 195                                 'rc_patrolled'  => 1,
 196                                 'rc_new'        => 0,
 197                                 'rc_this_oldid' => 0,
 198                                 'rc_last_oldid' => 0,
 199                                 'rc_type'       => RC_LOG,
 200                                 'rc_source'     => $dbw->addQuotes( RecentChange::SRC_LOG ),
 201                                 'rc_cur_id'     => $dbw->cascadingDeletes() ? 'page_id' : 'COALESCE(page_id, 0)',
 202                                 'rc_log_type'   => 'log_type',
 203                                 'rc_log_action' => 'log_action',
 204                                 'rc_logid'      => 'log_id',
 205                                 'rc_params'     => 'log_params',
 206                                 'rc_deleted'    => 'log_deleted'
 207                         ), array(
 208                                 'log_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $cutoff ) ),
 209                                 'log_user=user_id',
 210                                 'log_type IN(' . implode( ',', $selectLogs ) . ')'
 211                         ), __METHOD__,
 212                         array(), // INSERT options
 213                         array( 'ORDER BY' => 'log_timestamp DESC', 'LIMIT' => 5000 ) // SELECT options
 214                 );
 215         }
 216
 217         /**
 218          * Rebuild pass 4
 219          * DOCUMENT ME!
 220          */
 221         private function rebuildRecentChangesTablePass4() {
 222                 global $wgUseRCPatrol;
 223
 224                 $dbw = wfGetDB( DB_MASTER );
 225
 226                 list( $recentchanges, $usergroups, $user ) = $dbw->tableNamesN( 'recentchanges', 'user_groups', 'user' );
 227
 228                 $botgroups = User::getGroupsWithPermission( 'bot' );
 229                 $autopatrolgroups = $wgUseRCPatrol ? User::getGroupsWithPermission( 'autopatrol' ) : array();
 230                 # Flag our recent bot edits
 231                 if ( !empty( $botgroups ) ) {
 232                         $botwhere = $dbw->makeList( $botgroups );
 233                         $botusers = array();
 234
 235                         $this->output( "Flagging bot account edits...\n" );
 236
 237                         # Find all users that are bots
 238                         $sql = "SELECT DISTINCT user_name FROM $usergroups, $user " .
 239                                 "WHERE ug_group IN($botwhere) AND user_id = ug_user";
 240                         $res = $dbw->query( $sql, DB_MASTER );
 241
 242                         foreach ( $res as $obj ) {
 243                                 $botusers[] = $dbw->addQuotes( $obj->user_name );
 244                         }
 245                         # Fill in the rc_bot field
 246                         if ( !empty( $botusers ) ) {
 247                                 $botwhere = implode( ',', $botusers );
 248                                 $sql2 = "UPDATE $recentchanges SET rc_bot=1 " .
 249                                         "WHERE rc_user_text IN($botwhere)";
 250                                 $dbw->query( $sql2 );
 251                         }
 252                 }
 253                 global $wgMiserMode;
 254                 # Flag our recent autopatrolled edits
 255                 if ( !$wgMiserMode && !empty( $autopatrolgroups ) ) {
 256                         $patrolwhere = $dbw->makeList( $autopatrolgroups );
 257                         $patrolusers = array();
 258
 259                         $this->output( "Flagging auto-patrolled edits...\n" );
 260
 261                         # Find all users in RC with autopatrol rights
 262                         $sql = "SELECT DISTINCT user_name FROM $usergroups, $user " .
 263                                 "WHERE ug_group IN($patrolwhere) AND user_id = ug_user";
 264                         $res = $dbw->query( $sql, DB_MASTER );
 265
 266                         foreach ( $res as $obj ) {
 267                                 $patrolusers[] = $dbw->addQuotes( $obj->user_name );
 268                         }
 269
 270                         # Fill in the rc_patrolled field
 271                         if ( !empty( $patrolusers ) ) {
 272                                 $patrolwhere = implode( ',', $patrolusers );
 273                                 $sql2 = "UPDATE $recentchanges SET rc_patrolled=1 " .
 274                                         "WHERE rc_user_text IN($patrolwhere)";
 275                                 $dbw->query( $sql2 );
 276                         }
 277                 }
 278         }
 279
 280         /**
 281          * Purge cached feeds in $messageMemc
 282          */
 283         private function purgeFeeds() {
 284                 global $wgFeedClasses, $messageMemc;
 285
 286                 $this->output( "Deleting feed timestamps.\n" );
 287
 288                 foreach ( $wgFeedClasses as $feed => $className ) {
 289                         $messageMemc->delete( wfMemcKey( 'rcfeed', $feed, 'timestamp' ) ); # Good enough for now.
 290                 }
 291         }
 292
 293 }
 294
 295 $maintClass = "RebuildRecentchanges";
 296 require_once RUN_MAINTENANCE_IF_MAIN;