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  $db = $this->getDB( DB_MASTER );
44  $batchSize = $this->getBatchSize();
45  if ( !$db->tableExists( 'page_restrictions' ) ) {
46  $this->fatalError( "page_restrictions table does not exist" );
47  }
48 
49  $start = $db->selectField( 'page', 'MIN(page_id)', '', __METHOD__ );
50  if ( !$start ) {
51  $this->fatalError( "Nothing to do." );
52  }
53  $end = $db->selectField( 'page', 'MAX(page_id)', '', __METHOD__ );
54 
55  # Do remaining chunk
56  $end += $batchSize - 1;
57  $blockStart = $start;
58  $blockEnd = $start + $batchSize - 1;
59  $encodedExpiry = 'infinity';
60  while ( $blockEnd <= $end ) {
61  $this->output( "...doing page_id from $blockStart to $blockEnd out of $end\n" );
62  $cond = "page_id BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd .
63  " AND page_restrictions !=''";
64  $res = $db->select(
65  'page',
66  [ 'page_id', 'page_namespace', 'page_restrictions' ],
67  $cond,
68  __METHOD__
69  );
70  $batch = [];
71  foreach ( $res as $row ) {
72  $oldRestrictions = [];
73  foreach ( explode( ':', trim( $row->page_restrictions ) ) as $restrict ) {
74  $temp = explode( '=', trim( $restrict ), 2 );
75  // Make sure we are not settings restrictions to ""
76  if ( count( $temp ) == 1 && $temp[0] ) {
77  // old old format should be treated as edit/move restriction
78  $oldRestrictions["edit"] = trim( $temp[0] );
79  $oldRestrictions["move"] = trim( $temp[0] );
80  } elseif ( $temp[1] ) {
81  $oldRestrictions[$temp[0]] = trim( $temp[1] );
82  }
83  }
84  # Clear invalid columns
85  if ( $row->page_namespace == NS_MEDIAWIKI ) {
86  $db->update( 'page', [ 'page_restrictions' => '' ],
87  [ 'page_id' => $row->page_id ], __FUNCTION__ );
88  $this->output( "...removed dead page_restrictions column for page {$row->page_id}\n" );
89  }
90  # Update restrictions table
91  foreach ( $oldRestrictions as $action => $restrictions ) {
92  $batch[] = [
93  'pr_page' => $row->page_id,
94  'pr_type' => $action,
95  'pr_level' => $restrictions,
96  'pr_cascade' => 0,
97  'pr_expiry' => $encodedExpiry
98  ];
99  }
100  }
101  # We use insert() and not replace() as Article.php replaces
102  # page_restrictions with '' when protected in the restrictions table
103  if ( count( $batch ) ) {
104  $ok = $db->deadlockLoop( [ $db, 'insert' ], 'page_restrictions',
105  $batch, __FUNCTION__, [ 'IGNORE' ] );
106  if ( !$ok ) {
107  throw new MWException( "Deadlock loop failed wtf :(" );
108  }
109  }
110  $blockStart += $batchSize - 1;
111  $blockEnd += $batchSize - 1;
112  wfWaitForSlaves();
113  }
114  $this->output( "...removing dead rows from page_restrictions\n" );
115  // Kill any broken rows from previous imports
116  $db->delete( 'page_restrictions', [ 'pr_level' => '' ] );
117  // Kill other invalid rows
118  $db->deleteJoin(
119  'page_restrictions',
120  'page',
121  'pr_page',
122  'page_id',
123  [ 'page_namespace' => NS_MEDIAWIKI ]
124  );
125  $this->output( "...Done!\n" );
126  }
127 }
128 
129 $maintClass = UpdateRestrictions::class;
130 require_once RUN_MAINTENANCE_IF_MAIN;
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
Maintenance script that updates page_restrictions table from old page_restriction column...
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:82
setBatchSize( $s=0)
Set the batch size.
const DB_MASTER
Definition: defines.php:26
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
addDescription( $text)
Set the description text.
output( $out, $channel=null)
Throw some output to the user.
const NS_MEDIAWIKI
Definition: Defines.php:68
getBatchSize()
Returns batch size.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.