maintenance/populatePPSortKey.php

   1 <?php
   2 /**
   3  * Populate the pp_sortkey fields in the page_props table
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 require_once __DIR__ . '/Maintenance.php';
  25
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * Usage:
  30  *  populatePPSortKey.php
  31  */
  32 class PopulatePPSortKey extends LoggedUpdateMaintenance {
  33         public function __construct() {
  34                 parent::__construct();
  35                 $this->addDescription( 'Populate the pp_sortkey field' );
  36                 $this->setBatchSize( 100 );
  37         }
  38
  39         protected function doDBUpdates() {
  40                 $dbw = $this->getDB( DB_MASTER );
  41
  42                 $lastProp = null;
  43                 $lastPageValue = 0;
  44                 $editedRowCount = 0;
  45
  46                 $this->output( "Populating page_props.pp_sortkey...\n" );
  47                 while ( true ) {
  48                         $conditions = [ 'pp_sortkey IS NULL' ];
  49                         if ( $lastPageValue !== 0 ) {
  50                                 $conditions[] = 'pp_page > ' . $dbw->addQuotes( $lastPageValue ) . ' OR ' .
  51                                         '( pp_page = ' . $dbw->addQuotes( $lastPageValue ) .
  52                                         ' AND pp_propname > ' . $dbw->addQuotes( $lastProp ) . ' )';
  53                         }
  54
  55                         $res = $dbw->select(
  56                                 'page_props',
  57                                 [ 'pp_propname', 'pp_page', 'pp_sortkey', 'pp_value' ],
  58                                 $conditions,
  59                                 __METHOD__,
  60                                 [
  61                                         'ORDER BY' => 'pp_page, pp_propname',
  62                                         'LIMIT' => $this->mBatchSize
  63                                 ]
  64                         );
  65
  66                         if ( $res->numRows() === 0 ) {
  67                                 break;
  68                         }
  69
  70                         $this->beginTransaction( $dbw, __METHOD__ );
  71
  72                         foreach ( $res as $row ) {
  73                                 if ( !is_numeric( $row->pp_value ) ) {
  74                                         continue;
  75                                 }
  76                                 $dbw->update(
  77                                         'page_props',
  78                                         [ 'pp_sortkey' => $row->pp_value ],
  79                                         [
  80                                                 'pp_page' => $row->pp_page,
  81                                                 'pp_propname' => $row->pp_propname
  82                                         ],
  83                                         __METHOD__
  84                                 );
  85                                 $editedRowCount++;
  86                         }
  87
  88                         $this->output( "Updated " . $editedRowCount . " rows\n" );
  89                         $this->commitTransaction( $dbw, __METHOD__ );
  90
  91                         // We need to get the last element's page ID
  92                         $lastPageValue = $row->pp_page;
  93                         // And the propname...
  94                         $lastProp = $row->pp_propname;
  95                 }
  96
  97                 $this->output( "Populating page_props.pp_sortkey complete.\n" );
  98         }
  99
 100         protected function getUpdateKey() {
 101                 return 'populate pp_sortkey';
 102         }
 103 }
 104
 105 $maintClass = 'PopulatePPSortKey';
 106 require_once RUN_MAINTENANCE_IF_MAIN;