3 * Populate the page_content_model and {rev,ar}_content_{model,format} fields.
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.
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.
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
21 * @ingroup Maintenance
24 require_once __DIR__
. '/Maintenance.php';
26 use Wikimedia\Rdbms\IDatabase
;
27 use MediaWiki\MediaWikiServices
;
31 * populateContentModel.php --ns=1 --table=page
33 class PopulateContentModel
extends Maintenance
{
35 /** @var WANObjectCache */
38 public function __construct() {
39 parent
::__construct();
40 $this->addDescription( 'Populate the various content_* fields' );
41 $this->addOption( 'ns', 'Namespace to run in, or "all" for all namespaces', true, true );
42 $this->addOption( 'table', 'Table to run in', true, true );
43 $this->setBatchSize( 100 );
46 public function execute() {
47 $dbw = $this->getDB( DB_MASTER
);
49 $this->wikiId
= $dbw->getDomainID();
50 $this->wanCache
= MediaWikiServices
::getInstance()->getMainWANObjectCache();
52 $ns = $this->getOption( 'ns' );
53 if ( !ctype_digit( $ns ) && $ns !== 'all' ) {
54 $this->error( 'Invalid namespace', 1 );
56 $ns = $ns === 'all' ?
'all' : (int)$ns;
57 $table = $this->getOption( 'table' );
61 $this->populateRevisionOrArchive( $dbw, $table, $ns );
64 $this->populatePage( $dbw, $ns );
67 $this->error( "Invalid table name: $table", 1 );
71 protected function clearCache( $page_id, $rev_id ) {
72 $contentModelKey = $this->wanCache
->makeKey( 'page-content-model', $rev_id );
74 $this->wanCache
->makeGlobalKey( 'revision', $this->wikiId
, $page_id, $rev_id );
76 // WikiPage content model cache
77 $this->wanCache
->delete( $contentModelKey );
79 // Revision object cache, which contains a content model
80 $this->wanCache
->delete( $revisionKey );
83 private function updatePageRows( IDatabase
$dbw, $pageIds, $model ) {
84 $count = count( $pageIds );
85 $this->output( "Setting $count rows to $model..." );
88 [ 'page_content_model' => $model ],
89 [ 'page_id' => $pageIds ],
93 $this->output( "done.\n" );
96 protected function populatePage( IDatabase
$dbw, $ns ) {
99 $nsCondition = $ns === 'all' ?
[] : [ 'page_namespace' => $ns ];
100 $batchSize = $this->getBatchSize();
102 $rows = $dbw->select(
104 [ 'page_namespace', 'page_title', 'page_id' ],
106 'page_content_model' => null,
107 'page_id > ' . $dbw->addQuotes( $lastId ),
110 [ 'LIMIT' => $batchSize, 'ORDER BY' => 'page_id ASC' ]
112 $this->output( "Fetched {$rows->numRows()} rows.\n" );
113 foreach ( $rows as $row ) {
114 $title = Title
::newFromRow( $row );
115 $model = ContentHandler
::getDefaultModelFor( $title );
116 $toSave[$model][] = $row->page_id
;
117 if ( count( $toSave[$model] ) >= $batchSize ) {
118 $this->updatePageRows( $dbw, $toSave[$model], $model );
119 unset( $toSave[$model] );
121 $lastId = $row->page_id
;
123 } while ( $rows->numRows() >= $batchSize );
124 foreach ( $toSave as $model => $pages ) {
125 $this->updatePageRows( $dbw, $pages, $model );
129 private function updateRevisionOrArchiveRows( IDatabase
$dbw, $ids, $model, $table ) {
130 $prefix = $table === 'archive' ?
'ar' : 'rev';
131 $model_column = "{$prefix}_content_model";
132 $format_column = "{$prefix}_content_format";
133 $key = "{$prefix}_id";
135 $count = count( $ids );
136 $format = ContentHandler
::getForModelID( $model )->getDefaultFormat();
137 $this->output( "Setting $count rows to $model / $format..." );
140 [ $model_column => $model, $format_column => $format ],
145 $this->output( "done.\n" );
148 protected function populateRevisionOrArchive( IDatabase
$dbw, $table, $ns ) {
149 $prefix = $table === 'archive' ?
'ar' : 'rev';
150 $model_column = "{$prefix}_content_model";
151 $format_column = "{$prefix}_content_format";
152 $key = "{$prefix}_id";
153 if ( $table === 'archive' ) {
154 $selectTables = 'archive';
155 $fields = [ 'ar_namespace', 'ar_title' ];
157 $where = $ns === 'all' ?
[] : [ 'ar_namespace' => $ns ];
158 $page_id_column = 'ar_page_id';
159 $rev_id_column = 'ar_rev_id';
161 $selectTables = [ 'revision', 'page' ];
162 $fields = [ 'page_title', 'page_namespace' ];
163 $join_conds = [ 'page' => [ 'INNER JOIN', 'rev_page=page_id' ] ];
164 $where = $ns === 'all' ?
[] : [ 'page_namespace' => $ns ];
165 $page_id_column = 'rev_page';
166 $rev_id_column = 'rev_id';
172 $batchSize = $this->getBatchSize();
174 $rows = $dbw->select(
178 [ $model_column, $format_column, $key, $page_id_column, $rev_id_column ]
180 // @todo support populating format if model is already set
182 $model_column => null,
183 "$key > " . $dbw->addQuotes( $lastId ),
186 [ 'LIMIT' => $batchSize, 'ORDER BY' => "$key ASC" ],
189 $this->output( "Fetched {$rows->numRows()} rows.\n" );
190 foreach ( $rows as $row ) {
191 if ( $table === 'archive' ) {
192 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
194 $title = Title
::newFromRow( $row );
196 $lastId = $row->{$key};
198 $handler = ContentHandler
::getForTitle( $title );
199 } catch ( MWException
$e ) {
200 $this->error( "Invalid content model for $title" );
203 $defaultModel = $handler->getModelID();
204 $defaultFormat = $handler->getDefaultFormat();
205 $dbModel = $row->{$model_column};
206 $dbFormat = $row->{$format_column};
208 if ( $dbModel === null && $dbFormat === null ) {
210 $toSave[$defaultModel][] = $row->{$key};
212 'page_id' => $row->{$page_id_column},
213 'rev_id' => $row->{$rev_id_column},
215 } else { // $dbModel === null, $dbFormat set.
216 if ( $dbFormat === $defaultFormat ) {
217 $toSave[$defaultModel][] = $row->{$key};
219 'page_id' => $row->{$page_id_column},
220 'rev_id' => $row->{$rev_id_column},
222 } else { // non-default format, just update now
223 $this->output( "Updating model to match format for $table $id of $title... " );
226 [ $model_column => $defaultModel ],
231 $this->clearCache( $row->{$page_id_column}, $row->{$rev_id_column} );
232 $this->output( "done.\n" );
237 if ( count( $toSave[$defaultModel] ) >= $batchSize ) {
238 $this->updateRevisionOrArchiveRows( $dbw, $toSave[$defaultModel], $defaultModel, $table );
239 unset( $toSave[$defaultModel] );
242 } while ( $rows->numRows() >= $batchSize );
243 foreach ( $toSave as $model => $ids ) {
244 $this->updateRevisionOrArchiveRows( $dbw, $ids, $model, $table );
247 foreach ( $idsToClear as $idPair ) {
248 $this->clearCache( $idPair['page_id'], $idPair['rev_id'] );
253 $maintClass = 'PopulateContentModel';
254 require_once RUN_MAINTENANCE_IF_MAIN
;