MediaWiki  1.28.0
populateContentModel.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
31  public function __construct() {
32  parent::__construct();
33  $this->addDescription( 'Populate the various content_* fields' );
34  $this->addOption( 'ns', 'Namespace to run in, or "all" for all namespaces', true, true );
35  $this->addOption( 'table', 'Table to run in', true, true );
36  $this->setBatchSize( 100 );
37  }
38 
39  public function execute() {
40  $dbw = $this->getDB( DB_MASTER );
41  $ns = $this->getOption( 'ns' );
42  if ( !ctype_digit( $ns ) && $ns !== 'all' ) {
43  $this->error( 'Invalid namespace', 1 );
44  }
45  $ns = $ns === 'all' ? 'all' : (int)$ns;
46  $table = $this->getOption( 'table' );
47  switch ( $table ) {
48  case 'revision':
49  case 'archive':
50  $this->populateRevisionOrArchive( $dbw, $table, $ns );
51  break;
52  case 'page':
53  $this->populatePage( $dbw, $ns );
54  break;
55  default:
56  $this->error( "Invalid table name: $table", 1 );
57  }
58  }
59 
60  private function updatePageRows( Database $dbw, $pageIds, $model ) {
61  $count = count( $pageIds );
62  $this->output( "Setting $count rows to $model..." );
63  $dbw->update(
64  'page',
65  [ 'page_content_model' => $model ],
66  [ 'page_id' => $pageIds ],
67  __METHOD__
68  );
70  $this->output( "done.\n" );
71  }
72 
73  protected function populatePage( Database $dbw, $ns ) {
74  $toSave = [];
75  $lastId = 0;
76  $nsCondition = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
77  do {
78  $rows = $dbw->select(
79  'page',
80  [ 'page_namespace', 'page_title', 'page_id' ],
81  [
82  'page_content_model' => null,
83  'page_id > ' . $dbw->addQuotes( $lastId ),
84  ] + $nsCondition,
85  __METHOD__,
86  [ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'page_id ASC' ]
87  );
88  $this->output( "Fetched {$rows->numRows()} rows.\n" );
89  foreach ( $rows as $row ) {
90  $title = Title::newFromRow( $row );
92  $toSave[$model][] = $row->page_id;
93  if ( count( $toSave[$model] ) >= $this->mBatchSize ) {
94  $this->updatePageRows( $dbw, $toSave[$model], $model );
95  unset( $toSave[$model] );
96  }
97  $lastId = $row->page_id;
98  }
99  } while ( $rows->numRows() >= $this->mBatchSize );
100  foreach ( $toSave as $model => $pages ) {
101  $this->updatePageRows( $dbw, $pages, $model );
102  }
103  }
104 
105  private function updateRevisionOrArchiveRows( Database $dbw, $ids, $model, $table ) {
106  $prefix = $table === 'archive' ? 'ar' : 'rev';
107  $model_column = "{$prefix}_content_model";
108  $format_column = "{$prefix}_content_format";
109  $key = "{$prefix}_id";
110 
111  $count = count( $ids );
112  $format = ContentHandler::getForModelID( $model )->getDefaultFormat();
113  $this->output( "Setting $count rows to $model / $format..." );
114  $dbw->update(
115  $table,
116  [ $model_column => $model, $format_column => $format ],
117  [ $key => $ids ],
118  __METHOD__
119  );
120  $this->output( "done.\n" );
121  }
122 
123  protected function populateRevisionOrArchive( Database $dbw, $table, $ns ) {
124  $prefix = $table === 'archive' ? 'ar' : 'rev';
125  $model_column = "{$prefix}_content_model";
126  $format_column = "{$prefix}_content_format";
127  $key = "{$prefix}_id";
128  if ( $table === 'archive' ) {
129  $selectTables = 'archive';
130  $fields = [ 'ar_namespace', 'ar_title' ];
131  $join_conds = [];
132  $where = $ns === 'all' ? [] : [ 'ar_namespace' => $ns ];
133  } else { // revision
134  $selectTables = [ 'revision', 'page' ];
135  $fields = [ 'page_title', 'page_namespace' ];
136  $join_conds = [ 'page' => [ 'INNER JOIN', 'rev_page=page_id' ] ];
137  $where = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
138  }
139 
140  $toSave = [];
141  $lastId = 0;
142  do {
143  $rows = $dbw->select(
144  $selectTables,
145  array_merge( $fields, [ $model_column, $format_column, $key ] ),
146  // @todo support populating format if model is already set
147  [
148  $model_column => null,
149  "$key > " . $dbw->addQuotes( $lastId ),
150  ] + $where,
151  __METHOD__,
152  [ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => "$key ASC" ],
153  $join_conds
154  );
155  $this->output( "Fetched {$rows->numRows()} rows.\n" );
156  foreach ( $rows as $row ) {
157  if ( $table === 'archive' ) {
158  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
159  } else {
160  $title = Title::newFromRow( $row );
161  }
162  $lastId = $row->{$key};
163  try {
165  } catch ( MWException $e ) {
166  $this->error( "Invalid content model for $title" );
167  continue;
168  }
169  $defaultModel = $handler->getModelID();
170  $defaultFormat = $handler->getDefaultFormat();
171  $dbModel = $row->{$model_column};
172  $dbFormat = $row->{$format_column};
173  $id = $row->{$key};
174  if ( $dbModel === null && $dbFormat === null ) {
175  // Set the defaults
176  $toSave[$defaultModel][] = $row->{$key};
177  } else { // $dbModel === null, $dbFormat set.
178  if ( $dbFormat === $defaultFormat ) {
179  $toSave[$defaultModel][] = $row->{$key};
180  } else { // non-default format, just update now
181  $this->output( "Updating model to match format for $table $id of $title... " );
182  $dbw->update(
183  $table,
184  [ $model_column => $defaultModel ],
185  [ $key => $id ],
186  __METHOD__
187  );
188  wfWaitForSlaves();
189  $this->output( "done.\n" );
190  continue;
191  }
192  }
193 
194  if ( count( $toSave[$defaultModel] ) >= $this->mBatchSize ) {
195  $this->updateRevisionOrArchiveRows( $dbw, $toSave[$defaultModel], $defaultModel, $table );
196  unset( $toSave[$defaultModel] );
197  }
198  }
199  } while ( $rows->numRows() >= $this->mBatchSize );
200  foreach ( $toSave as $model => $ids ) {
201  $this->updateRevisionOrArchiveRows( $dbw, $ids, $model, $table );
202  }
203  }
204 }
205 
206 $maintClass = 'PopulateContentModel';
207 require_once RUN_MAINTENANCE_IF_MAIN;
static newFromRow($row)
Make a Title object from a DB row.
Definition: Title.php:450
wfWaitForSlaves($ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
select($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
Definition: Database.php:1250
static getForModelID($modelId)
Returns the ContentHandler singleton for the given model ID.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title...
getDB($db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
update($table, $values, $conds, $fname=__METHOD__, $options=[])
UPDATE wrapper.
Definition: Database.php:1533
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
const DB_MASTER
Definition: defines.php:23
updateRevisionOrArchiveRows(Database $dbw, $ids, $model, $table)
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
addDescription($text)
Set the description text.
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getOption($name, $default=null)
Get an option, or return the default.
output($out, $channel=null)
Throw some output to the user.
Usage: populateContentModel.php –ns=1 –table=page.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
addQuotes($s)
Adds quotes and backslashes.
Definition: Database.php:1958
int $mBatchSize
Batch size.
Definition: Maintenance.php:98
error($err, $die=0)
Throw an error to the user.
$count
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all.It could be easily changed to send incrementally if that becomes useful
populatePage(Database $dbw, $ns)
updatePageRows(Database $dbw, $pageIds, $model)
setBatchSize($s=0)
Set the batch size.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:802
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
populateRevisionOrArchive(Database $dbw, $table, $ns)