MediaWiki  master
SpecialChangeContentModel.php
Go to the documentation of this file.
1 <?php
2 
4 
5  public function __construct() {
6  parent::__construct( 'ChangeContentModel', 'editcontentmodel' );
7  }
8 
9  public function doesWrites() {
10  return true;
11  }
12 
16  private $title;
17 
23  private $oldRevision;
24 
25  protected function setParameter( $par ) {
26  $par = $this->getRequest()->getVal( 'pagetitle', $par );
28  if ( $title ) {
29  $this->title = $title;
30  $this->par = $title->getPrefixedText();
31  } else {
32  $this->par = '';
33  }
34  }
35 
36  protected function postText() {
37  $text = '';
38  if ( $this->title ) {
39  $contentModelLogPage = new LogPage( 'contentmodel' );
40  $text = Xml::element( 'h2', null, $contentModelLogPage->getName()->text() );
41  $out = '';
42  LogEventsList::showLogExtract( $out, 'contentmodel', $this->title );
43  $text .= $out;
44  }
45  return $text;
46  }
47 
48  protected function getDisplayFormat() {
49  return 'ooui';
50  }
51 
52  protected function alterForm( HTMLForm $form ) {
53  if ( !$this->title ) {
54  $form->setMethod( 'GET' );
55  }
56 
57  $this->addHelpLink( 'Help:ChangeContentModel' );
58 
59  // T120576
60  $form->setSubmitTextMsg( 'changecontentmodel-submit' );
61  }
62 
63  public function validateTitle( $title ) {
64  if ( !$title ) {
65  // No form input yet
66  return true;
67  }
68 
69  // Already validated by HTMLForm, but if not, throw
70  // and exception instead of a fatal
71  $titleObj = Title::newFromTextThrow( $title );
72 
73  $this->oldRevision = Revision::newFromTitle( $titleObj ) ?: false;
74 
75  if ( $this->oldRevision ) {
76  $oldContent = $this->oldRevision->getContent();
77  if ( !$oldContent->getContentHandler()->supportsDirectEditing() ) {
78  return $this->msg( 'changecontentmodel-nodirectediting' )
79  ->params( ContentHandler::getLocalizedName( $oldContent->getModel() ) )
80  ->escaped();
81  }
82  }
83 
84  return true;
85  }
86 
87  protected function getFormFields() {
88  $fields = [
89  'pagetitle' => [
90  'type' => 'title',
91  'creatable' => true,
92  'name' => 'pagetitle',
93  'default' => $this->par,
94  'label-message' => 'changecontentmodel-title-label',
95  'validation-callback' => [ $this, 'validateTitle' ],
96  ],
97  ];
98  if ( $this->title ) {
99  $options = $this->getOptionsForTitle( $this->title );
100  if ( empty( $options ) ) {
101  throw new ErrorPageError(
102  'changecontentmodel-emptymodels-title',
103  'changecontentmodel-emptymodels-text',
104  $this->title->getPrefixedText()
105  );
106  }
107  $fields['pagetitle']['readonly'] = true;
108  $fields += [
109  'model' => [
110  'type' => 'select',
111  'name' => 'model',
112  'options' => $options,
113  'label-message' => 'changecontentmodel-model-label'
114  ],
115  'reason' => [
116  'type' => 'text',
117  'name' => 'reason',
118  'validation-callback' => function ( $reason ) {
119  $match = EditPage::matchSummarySpamRegex( $reason );
120  if ( $match ) {
121  return $this->msg( 'spamprotectionmatch', $match )->parse();
122  }
123 
124  return true;
125  },
126  'label-message' => 'changecontentmodel-reason-label',
127  ],
128  ];
129  }
130 
131  return $fields;
132  }
133 
134  private function getOptionsForTitle( Title $title = null ) {
136  $options = [];
137  foreach ( $models as $model ) {
139  if ( !$handler->supportsDirectEditing() ) {
140  continue;
141  }
142  if ( $title ) {
143  if ( $title->getContentModel() === $model ) {
144  continue;
145  }
146  if ( !$handler->canBeUsedOn( $title ) ) {
147  continue;
148  }
149  }
150  $options[ContentHandler::getLocalizedName( $model )] = $model;
151  }
152 
153  return $options;
154  }
155 
156  public function onSubmit( array $data ) {
157  if ( $data['pagetitle'] === '' ) {
158  // Initial form view of special page, pass
159  return false;
160  }
161 
162  // At this point, it has to be a POST request. This is enforced by HTMLForm,
163  // but lets be safe verify that.
164  if ( !$this->getRequest()->wasPosted() ) {
165  throw new RuntimeException( "Form submission was not POSTed" );
166  }
167 
168  $this->title = Title::newFromText( $data['pagetitle'] );
169  $titleWithNewContentModel = clone $this->title;
170  $titleWithNewContentModel->setContentModel( $data['model'] );
171  $user = $this->getUser();
172  // Check permissions and make sure the user has permission to:
173  $errors = wfMergeErrorArrays(
174  // edit the contentmodel of the page
175  $this->title->getUserPermissionsErrors( 'editcontentmodel', $user ),
176  // edit the page under the old content model
177  $this->title->getUserPermissionsErrors( 'edit', $user ),
178  // edit the contentmodel under the new content model
179  $titleWithNewContentModel->getUserPermissionsErrors( 'editcontentmodel', $user ),
180  // edit the page under the new content model
181  $titleWithNewContentModel->getUserPermissionsErrors( 'edit', $user )
182  );
183  if ( $errors ) {
184  $out = $this->getOutput();
185  $wikitext = $out->formatPermissionsErrorMessage( $errors );
186  // Hack to get our wikitext parsed
187  return Status::newFatal( new RawMessage( '$1', [ $wikitext ] ) );
188  }
189 
190  $page = WikiPage::factory( $this->title );
191  if ( $this->oldRevision === null ) {
192  $this->oldRevision = $page->getRevision() ?: false;
193  }
194  $oldModel = $this->title->getContentModel();
195  if ( $this->oldRevision ) {
196  $oldContent = $this->oldRevision->getContent();
197  try {
198  $newContent = ContentHandler::makeContent(
199  $oldContent->serialize(), $this->title, $data['model']
200  );
201  } catch ( MWException $e ) {
202  return Status::newFatal(
203  $this->msg( 'changecontentmodel-cannot-convert' )
204  ->params(
205  $this->title->getPrefixedText(),
206  ContentHandler::getLocalizedName( $data['model'] )
207  )
208  );
209  }
210  } else {
211  // Page doesn't exist, create an empty content object
212  $newContent = ContentHandler::getForModelID( $data['model'] )->makeEmptyContent();
213  }
214 
215  // All other checks have passed, let's check rate limits
216  if ( $user->pingLimiter( 'editcontentmodel' ) ) {
217  throw new ThrottledError();
218  }
219 
220  $flags = $this->oldRevision ? EDIT_UPDATE : EDIT_NEW;
221  $flags |= EDIT_INTERNAL;
222  if ( $user->isAllowed( 'bot' ) ) {
223  $flags |= EDIT_FORCE_BOT;
224  }
225 
226  $log = new ManualLogEntry( 'contentmodel', $this->oldRevision ? 'change' : 'new' );
227  $log->setPerformer( $user );
228  $log->setTarget( $this->title );
229  $log->setComment( $data['reason'] );
230  $log->setParameters( [
231  '4::oldmodel' => $oldModel,
232  '5::newmodel' => $data['model']
233  ] );
234 
235  $formatter = LogFormatter::newFromEntry( $log );
236  $formatter->setContext( RequestContext::newExtraneousContext( $this->title ) );
237  $reason = $formatter->getPlainActionText();
238  if ( $data['reason'] !== '' ) {
239  $reason .= $this->msg( 'colon-separator' )->inContentLanguage()->text() . $data['reason'];
240  }
241 
242  // Run edit filters
243  $derivativeContext = new DerivativeContext( $this->getContext() );
244  $derivativeContext->setTitle( $this->title );
245  $derivativeContext->setWikiPage( $page );
246  $status = new Status();
247  if ( !Hooks::run( 'EditFilterMergedContent',
248  [ $derivativeContext, $newContent, $status, $reason,
249  $user, false ] )
250  ) {
251  if ( $status->isGood() ) {
252  // TODO: extensions should really specify an error message
253  $status->fatal( 'hookaborted' );
254  }
255  return $status;
256  }
257 
258  $status = $page->doEditContent(
259  $newContent,
260  $reason,
261  $flags,
262  $this->oldRevision ? $this->oldRevision->getId() : false,
263  $user
264  );
265  if ( !$status->isOK() ) {
266  return $status;
267  }
268 
269  $logid = $log->insert();
270  $log->publish( $logid );
271 
272  return $status;
273  }
274 
275  public function onSuccess() {
276  $out = $this->getOutput();
277  $out->setPageTitle( $this->msg( 'changecontentmodel-success-title' ) );
278  $out->addWikiMsg( 'changecontentmodel-success-text', $this->title );
279  }
280 
289  public function prefixSearchSubpages( $search, $limit, $offset ) {
290  return $this->prefixSearchString( $search, $limit, $offset );
291  }
292 
293  protected function getGroupName() {
294  return 'pagetools';
295  }
296 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
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 $out
Definition: hooks.txt:790
the array() calling protocol came about after MediaWiki 1.4rc1.
getContext()
Gets the context this SpecialPage is executed in.
static element($element, $attribs=null, $contents= '', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
setMethod($method= 'post')
Set the method used to submit the form.
Definition: HTMLForm.php:1591
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:2195
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:68
static getContentModels()
static newFromEntry(LogEntry $entry)
Constructs a new formatter suitable for given entry.
An IContextSource implementation which will inherit context from another source but allow individual ...
const EDIT_INTERNAL
Definition: Defines.php:160
getOutput()
Get the OutputPage being used for this instance.
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1625
const EDIT_UPDATE
Definition: Defines.php:154
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
Definition: Revision.php:133
Special page which uses an HTMLForm to handle processing.
title
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static showLogExtract(&$out, $types=[], $page= '', $user= '', $param=[])
Show log extract.
static matchSummarySpamRegex($text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match...
Definition: EditPage.php:2364
Class to simplify the use of log pages.
Definition: LogPage.php:33
static getLocalizedName($name, Language $lang=null)
Returns the localized name for a given content model.
getContentModel($flags=0)
Get the page's content model id, see the CONTENT_MODEL_XXX constants.
Definition: Title.php:980
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
const EDIT_FORCE_BOT
Definition: Defines.php:157
An error page which can definitely be safely rendered using the OutputPage.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2019
setSubmitTextMsg($msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1363
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
msg($key)
Wrapper around wfMessage that sets the current context.
static makeContent($text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
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
static newFromTextThrow($text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:306
prefixSearchSubpages($search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
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
const EDIT_NEW
Definition: Defines.php:153
Variant of the Message class.
Definition: RawMessage.php:34
getUser()
Shortcut to get the User executing this instance.
string $par
The sub-page of the special page.
Revision bool null $oldRevision
A Revision object, false if no revision exists, null if not loaded yet.
Status::newGood()`to allow deletion, and then`return false`from the hook function.Ensure you consume the 'ChangeTagAfterDelete'hook to carry out custom deletion actions.$tag:name of the tag $user:user initiating the action &$status:Status object.See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use.&$tags:list of all active tags.Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function.Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change.&$allowedTags:List of all the tags the user is allowed to add.Any tags the user wants to add($addTags) that are not in this array will cause it to fail.You may add or remove tags to this array as required.$addTags:List of tags user intends to add.$user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed.$performer:The User who will perform the change $user:The User whose groups will be changed &$add:The groups that will be added &$remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation.$collationName:Name of the collation in question &$collationObject:Null.Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user's email has been confirmed successfully.$user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object.Called by Content::getParserOutput after parsing has finished.Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML).$content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput.May be used to override the normal model-specific rendering of page content.$content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering.To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state.$generateHtml:boolean, indicating whether full HTML should be generated.If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object.&$output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title.May be used to assign a different model for that title.$title:the Title in question &$model:the model name.Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers.Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core.$modeName:the requested content model name &$handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page.This is especially useful to prevent some content models to be used in some special location.$contentModel:ID of the content model in question $title:the Title in question.&$ok:Output parameter, whether it is OK to use $contentModel on $title.Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run &$pager:Pager object for contributions &$queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions &$data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title &$tools:Array of tool links $specialPage:SpecialPage instance for context and services.Can be either SpecialContributions or DeletedContributionsPage.Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested.Handler functions that modify $result should generally return false to disable further attempts at conversion.$content:The Content object to be converted.$toModel:The ID of the content model to convert to.$lossy:boolean indicating whether lossy conversion is allowed.&$result:Output parameter, in case the handler function wants to provide a converted Content object.Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources.This affects all directives except for the script directive.If you want to add a script source, see ContentSecurityPolicyScriptSource hook.&$defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives.Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs.&$directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources.Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add.&$scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g.for a special namespace, etc.$article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery &$data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished.Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about.This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process.For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion.&where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table.$db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function.$differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable's value is null.This hook can be used to inject content into said class member variable.$differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the"mark as patrolled"link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink".$differenceEngine:DifferenceEngine object &$markAsPatrolledLink:The"mark as patrolled"link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter.For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions.&$rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.$differenceEngine:DifferenceEngine object &$newHeader:The string containing the various#mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1287
getRequest()
Get the WebRequest being used for this instance.
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:790
prefixSearchString($search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
Show an error when the user hits a rate limit.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:244
setContentModel($model)
Set a proposed content model for the page for permissions checking.
Definition: Title.php:1018