MediaWiki  1.28.3
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 getDisplayFormat() {
37  return 'ooui';
38  }
39 
40  protected function alterForm( HTMLForm $form ) {
41  if ( !$this->title ) {
42  $form->setMethod( 'GET' );
43  }
44 
45  $this->addHelpLink( 'Help:ChangeContentModel' );
46 
47  // T120576
48  $form->setSubmitTextMsg( 'changecontentmodel-submit' );
49  }
50 
51  public function validateTitle( $title ) {
52  if ( !$title ) {
53  // No form input yet
54  return true;
55  }
56 
57  // Already validated by HTMLForm, but if not, throw
58  // and exception instead of a fatal
59  $titleObj = Title::newFromTextThrow( $title );
60 
61  $this->oldRevision = Revision::newFromTitle( $titleObj ) ?: false;
62 
63  if ( $this->oldRevision ) {
64  $oldContent = $this->oldRevision->getContent();
65  if ( !$oldContent->getContentHandler()->supportsDirectEditing() ) {
66  return $this->msg( 'changecontentmodel-nodirectediting' )
67  ->params( ContentHandler::getLocalizedName( $oldContent->getModel() ) )
68  ->escaped();
69  }
70  }
71 
72  return true;
73  }
74 
75  protected function getFormFields() {
76  $fields = [
77  'pagetitle' => [
78  'type' => 'title',
79  'creatable' => true,
80  'name' => 'pagetitle',
81  'default' => $this->par,
82  'label-message' => 'changecontentmodel-title-label',
83  'validation-callback' => [ $this, 'validateTitle' ],
84  ],
85  ];
86  if ( $this->title ) {
87  $options = $this->getOptionsForTitle( $this->title );
88  if ( empty( $options ) ) {
89  throw new ErrorPageError(
90  'changecontentmodel-emptymodels-title',
91  'changecontentmodel-emptymodels-text',
92  $this->title->getPrefixedText()
93  );
94  }
95  $fields['pagetitle']['readonly'] = true;
96  $fields += [
97  'model' => [
98  'type' => 'select',
99  'name' => 'model',
100  'options' => $options,
101  'label-message' => 'changecontentmodel-model-label'
102  ],
103  'reason' => [
104  'type' => 'text',
105  'name' => 'reason',
106  'validation-callback' => function( $reason ) {
107  $match = EditPage::matchSummarySpamRegex( $reason );
108  if ( $match ) {
109  return $this->msg( 'spamprotectionmatch', $match )->parse();
110  }
111 
112  return true;
113  },
114  'label-message' => 'changecontentmodel-reason-label',
115  ],
116  ];
117  }
118 
119  return $fields;
120  }
121 
122  private function getOptionsForTitle( Title $title = null ) {
124  $options = [];
125  foreach ( $models as $model ) {
127  if ( !$handler->supportsDirectEditing() ) {
128  continue;
129  }
130  if ( $title ) {
131  if ( $title->getContentModel() === $model ) {
132  continue;
133  }
134  if ( !$handler->canBeUsedOn( $title ) ) {
135  continue;
136  }
137  }
138  $options[ContentHandler::getLocalizedName( $model )] = $model;
139  }
140 
141  return $options;
142  }
143 
144  public function onSubmit( array $data ) {
146 
147  if ( $data['pagetitle'] === '' ) {
148  // Initial form view of special page, pass
149  return false;
150  }
151 
152  // At this point, it has to be a POST request. This is enforced by HTMLForm,
153  // but lets be safe verify that.
154  if ( !$this->getRequest()->wasPosted() ) {
155  throw new RuntimeException( "Form submission was not POSTed" );
156  }
157 
158  $this->title = Title::newFromText( $data['pagetitle'] );
159  $titleWithNewContentModel = clone $this->title;
160  $titleWithNewContentModel->setContentModel( $data['model'] );
161  $user = $this->getUser();
162  // Check permissions and make sure the user has permission to:
163  $errors = wfMergeErrorArrays(
164  // edit the contentmodel of the page
165  $this->title->getUserPermissionsErrors( 'editcontentmodel', $user ),
166  // edit the page under the old content model
167  $this->title->getUserPermissionsErrors( 'edit', $user ),
168  // edit the contentmodel under the new content model
169  $titleWithNewContentModel->getUserPermissionsErrors( 'editcontentmodel', $user ),
170  // edit the page under the new content model
171  $titleWithNewContentModel->getUserPermissionsErrors( 'edit', $user )
172  );
173  if ( $errors ) {
174  $out = $this->getOutput();
175  $wikitext = $out->formatPermissionsErrorMessage( $errors );
176  // Hack to get our wikitext parsed
177  return Status::newFatal( new RawMessage( '$1', [ $wikitext ] ) );
178  }
179 
180  $page = WikiPage::factory( $this->title );
181  if ( $this->oldRevision === null ) {
182  $this->oldRevision = $page->getRevision() ?: false;
183  }
184  $oldModel = $this->title->getContentModel();
185  if ( $this->oldRevision ) {
186  $oldContent = $this->oldRevision->getContent();
187  try {
188  $newContent = ContentHandler::makeContent(
189  $oldContent->getNativeData(), $this->title, $data['model']
190  );
191  } catch ( MWException $e ) {
192  return Status::newFatal(
193  $this->msg( 'changecontentmodel-cannot-convert' )
194  ->params(
195  $this->title->getPrefixedText(),
196  ContentHandler::getLocalizedName( $data['model'] )
197  )
198  );
199  }
200  } else {
201  // Page doesn't exist, create an empty content object
202  $newContent = ContentHandler::getForModelID( $data['model'] )->makeEmptyContent();
203  }
204 
205  // All other checks have passed, let's check rate limits
206  if ( $user->pingLimiter( 'editcontentmodel' ) ) {
207  throw new ThrottledError();
208  }
209 
210  $flags = $this->oldRevision ? EDIT_UPDATE : EDIT_NEW;
212  if ( $user->isAllowed( 'bot' ) ) {
214  }
215 
216  $log = new ManualLogEntry( 'contentmodel', $this->oldRevision ? 'change' : 'new' );
217  $log->setPerformer( $user );
218  $log->setTarget( $this->title );
219  $log->setComment( $data['reason'] );
220  $log->setParameters( [
221  '4::oldmodel' => $oldModel,
222  '5::newmodel' => $data['model']
223  ] );
224 
225  $formatter = LogFormatter::newFromEntry( $log );
226  $formatter->setContext( RequestContext::newExtraneousContext( $this->title ) );
227  $reason = $formatter->getPlainActionText();
228  if ( $data['reason'] !== '' ) {
229  $reason .= $this->msg( 'colon-separator' )->inContentLanguage()->text() . $data['reason'];
230  }
231  # Truncate for whole multibyte characters.
232  $reason = $wgContLang->truncate( $reason, 255 );
233 
234  // Run edit filters
235  $derivativeContext = new DerivativeContext( $this->getContext() );
236  $derivativeContext->setTitle( $this->title );
237  $derivativeContext->setWikiPage( $page );
238  $status = new Status();
239  if ( !Hooks::run( 'EditFilterMergedContent',
240  [ $derivativeContext, $newContent, $status, $reason,
241  $user, false ] )
242  ) {
243  if ( $status->isGood() ) {
244  // TODO: extensions should really specify an error message
245  $status->fatal( 'hookaborted' );
246  }
247  return $status;
248  }
249 
250  $status = $page->doEditContent(
251  $newContent,
252  $reason,
253  $flags,
254  $this->oldRevision ? $this->oldRevision->getId() : false,
255  $user
256  );
257  if ( !$status->isOK() ) {
258  return $status;
259  }
260 
261  $logid = $log->insert();
262  $log->publish( $logid );
263 
264  return $status;
265  }
266 
267  public function onSuccess() {
268  $out = $this->getOutput();
269  $out->setPageTitle( $this->msg( 'changecontentmodel-success-title' ) );
270  $out->addWikiMsg( 'changecontentmodel-success-text', $this->title );
271  }
272 
281  public function prefixSearchSubpages( $search, $limit, $offset ) {
282  return $this->prefixSearchString( $search, $limit, $offset );
283  }
284 
285  protected function getGroupName() {
286  return 'pagetools';
287  }
288 }
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:806
the array() calling protocol came about after MediaWiki 1.4rc1.
getContext()
Gets the context this SpecialPage is executed in.
setMethod($method= 'post')
Set the method used to submit the form.
Definition: HTMLForm.php:1576
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:2106
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
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:153
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2707
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1455
const EDIT_UPDATE
Definition: Defines.php:147
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
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:128
Special page which uses an HTMLForm to handle processing.
title
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static matchSummarySpamRegex($text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match...
Definition: EditPage.php:2307
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:931
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
const EDIT_FORCE_BOT
Definition: Defines.php:150
An error page which can definitely be safely rendered using the OutputPage.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1050
setSubmitTextMsg($msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1348
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
Object handling generic submission, CSRF protection, layout and other logic for UI forms...
Definition: HTMLForm.php:128
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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
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:246
static newFromTextThrow($text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:292
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
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:394
const EDIT_NEW
Definition: Defines.php:146
Variant of the Message class.
Definition: Message.php:1260
getUser()
Shortcut to get the User executing this instance.
string $par
The sub-page of the special page.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive $limit
Definition: hooks.txt:1050
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1050
Revision bool null $oldRevision
A Revision object, false if no revision exists, null if not loaded yet.
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:806
prefixSearchString($search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
Show an error when the user hits a rate limit.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2495
setContentModel($model)
Set a proposed content model for the page for permissions checking.
Definition: Title.php:969