MediaWiki  master
updateRestrictions.php
Go to the documentation of this file.
1 <?php
27 require_once __DIR__ . '/Maintenance.php';
28 
36  public function __construct() {
37  parent::__construct();
38  $this->addDescription( 'Updates page_restrictions table from old page_restriction column' );
39  $this->setBatchSize( 1000 );
40  }
41 
42  public function execute() {
43  $dbw = $this->getDB( DB_PRIMARY );
44  $batchSize = $this->getBatchSize();
45 
46  if ( !$dbw->tableExists( 'page_restrictions', __METHOD__ ) ) {
47  $this->fatalError( "page_restrictions table does not exist" );
48  }
49 
50  if ( !$dbw->fieldExists( 'page', 'page_restrictions' ) ) {
51  $this->output( "Migration is not needed.\n" );
52  return true;
53  }
54 
55  $encodedExpiry = $dbw->getInfinity();
56 
57  $maxPageId = $dbw->newSelectQueryBuilder()
58  ->select( 'MAX(page_id)' )
59  ->from( 'page' )
60  ->caller( __METHOD__ )->fetchField();
61  $escapedEmptyBlobValue = $dbw->addQuotes( '' );
62 
63  $batchMinPageId = 0;
64 
65  do {
66  $batchMaxPageId = $batchMinPageId + $batchSize;
67 
68  $this->output( "...processing page IDs from $batchMinPageId to $batchMaxPageId.\n" );
69 
70  $res = $dbw->newSelectQueryBuilder()
71  ->select( [ 'page_id', 'page_restrictions' ] )
72  ->from( 'page' )
73  ->where( [
74  "page_restrictions != $escapedEmptyBlobValue",
75  'page_id > ' . $dbw->addQuotes( $batchMinPageId ),
76  'page_id <= ' . $dbw->addQuotes( $batchMaxPageId ),
77  ] )
78  ->caller( __METHOD__ )->fetchResultSet();
79 
80  // No pages have legacy protection settings in the current batch
81  if ( !$res->numRows() ) {
82  $batchMinPageId = $batchMaxPageId;
83  continue;
84  }
85 
86  $batch = [];
87  $pageIds = [];
88 
89  foreach ( $res as $row ) {
90  $pageIds[] = $row->page_id;
91 
92  $restrictionsByAction = $this->mapLegacyRestrictionBlob( $row->page_restrictions );
93 
94  # Update restrictions table
95  foreach ( $restrictionsByAction as $action => $restrictions ) {
96  $batch[] = [
97  'pr_page' => $row->page_id,
98  'pr_type' => $action,
99  'pr_level' => $restrictions,
100  'pr_cascade' => 0,
101  'pr_expiry' => $encodedExpiry
102  ];
103  }
104  }
105 
106  $this->beginTransaction( $dbw, __METHOD__ );
107 
108  // Insert new format protection settings for the pages in the current batch.
109  // Use INSERT IGNORE to ignore conflicts with new format settings that might exist for the page
110  $dbw->insert(
111  'page_restrictions',
112  $batch,
113  __METHOD__,
114  [ 'IGNORE' ]
115  );
116 
117  // Clear out the legacy page.page_restrictions blob for this batch
118  $dbw->update( 'page', [ 'page_restrictions' => '' ], [ 'page_id' => $pageIds ], __METHOD__ );
119 
120  $this->commitTransaction( $dbw, __METHOD__ );
121 
122  $batchMinPageId = $batchMaxPageId;
123  } while ( $batchMaxPageId < $maxPageId );
124 
125  $this->output( "...Done!\n" );
126  return true;
127  }
128 
137  private function mapLegacyRestrictionBlob( $legacyBlob ) {
138  $oldRestrictions = [];
139 
140  foreach ( explode( ':', trim( $legacyBlob ) ) as $restrict ) {
141  $temp = explode( '=', trim( $restrict ) );
142 
143  // Treat old old format without action name as edit/move restriction
144  if ( count( $temp ) == 1 ) {
145  $level = trim( $temp[0] );
146 
147  $oldRestrictions['edit'] = $level;
148  $oldRestrictions['move'] = $level;
149  } else {
150  $restriction = trim( $temp[1] );
151  // Some old entries are empty
152  if ( $restriction != '' ) {
153  $oldRestrictions[$temp[0]] = $restriction;
154  }
155  }
156  }
157 
158  return $oldRestrictions;
159  }
160 }
161 
162 $maintClass = UpdateRestrictions::class;
163 require_once RUN_MAINTENANCE_IF_MAIN;
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:66
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
beginTransaction(IDatabase $dbw, $fname)
Begin a transaction on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transaction on a DB handle and wait for replica DBs to catch up.
output( $out, $channel=null)
Throw some output to the user.
getBatchSize()
Returns batch size.
addDescription( $text)
Set the description text.
setBatchSize( $s=0)
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Maintenance script that updates page_restrictions table from old page_restriction column.
__construct()
Default constructor.
execute()
Do the actual work.
const DB_PRIMARY
Definition: defines.php:28