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 /**
  27  * Usage:
  28  *  populatePPSortKey.php
  29  */
  30 class PopulatePPSortKey extends LoggedUpdateMaintenance {
  31         public function __construct() {
  32                 parent::__construct();
  33                 $this->addDescription( 'Populate the pp_sortkey field' );
  34                 $this->setBatchSize( 100 );
  35         }
  36
  37         protected function doDBUpdates() {
  38                 $dbw = $this->getDB( DB_MASTER );
  39
  40                 $lastProp = null;
  41                 $lastPageValue = 0;
  42                 $editedRowCount = 0;
  43
  44                 $this->output( "Populating page_props.pp_sortkey...\n" );
  45                 while ( true ) {
  46                         $conditions = [ 'pp_sortkey IS NULL' ];
  47                         if ( $lastPageValue !== 0 ) {
  48                                 $conditions[] = 'pp_page > ' . $dbw->addQuotes( $lastPageValue ) . ' OR ' .
  49                                         '( pp_page = ' . $dbw->addQuotes( $lastPageValue ) .
  50                                         ' AND pp_propname > ' . $dbw->addQuotes( $lastProp ) . ' )';
  51                         }
  52
  53                         $res = $dbw->select(
  54                                 'page_props',
  55                                 [ 'pp_propname', 'pp_page', 'pp_sortkey', 'pp_value' ],
  56                                 $conditions,
  57                                 __METHOD__,
  58                                 [
  59                                         'ORDER BY' => 'pp_page, pp_propname',
  60                                         'LIMIT' => $this->getBatchSize()
  61                                 ]
  62                         );
  63
  64                         if ( $res->numRows() === 0 ) {
  65                                 break;
  66                         }
  67
  68                         $this->beginTransaction( $dbw, __METHOD__ );
  69
  70                         foreach ( $res as $row ) {
  71                                 if ( !is_numeric( $row->pp_value ) ) {
  72                                         continue;
  73                                 }
  74                                 $dbw->update(
  75                                         'page_props',
  76                                         [ 'pp_sortkey' => $row->pp_value ],
  77                                         [
  78                                                 'pp_page' => $row->pp_page,
  79                                                 'pp_propname' => $row->pp_propname
  80                                         ],
  81                                         __METHOD__
  82                                 );
  83                                 $editedRowCount++;
  84                         }
  85
  86                         $this->output( "Updated " . $editedRowCount . " rows\n" );
  87                         $this->commitTransaction( $dbw, __METHOD__ );
  88
  89                         // We need to get the last element's page ID
  90                         $lastPageValue = $row->pp_page;
  91                         // And the propname...
  92                         $lastProp = $row->pp_propname;
  93                 }
  94
  95                 $this->output( "Populating page_props.pp_sortkey complete.\n" );
  96         }
  97
  98         protected function getUpdateKey() {
  99                 return 'populate pp_sortkey';
 100         }
 101 }
 102
 103 $maintClass = 'PopulatePPSortKey';
 104 require_once RUN_MAINTENANCE_IF_MAIN;