MediaWiki  master
FileDeleteForm.php
Go to the documentation of this file.
1 <?php
25 
32 
36  private $title = null;
37 
41  private $file = null;
42 
46  private $oldfile = null;
47  private $oldimage = '';
48 
52  public function __construct( $file ) {
53  $this->title = $file->getTitle();
54  $this->file = $file;
55  }
56 
61  public function execute() {
62  global $wgOut, $wgRequest, $wgUser, $wgUploadMaintenance;
63 
64  $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
65  if ( count( $permissionErrors ) ) {
66  throw new PermissionsError( 'delete', $permissionErrors );
67  }
68 
69  if ( wfReadOnly() ) {
70  throw new ReadOnlyError;
71  }
72 
73  if ( $wgUploadMaintenance ) {
74  throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
75  }
76 
77  $this->setHeaders();
78 
79  $this->oldimage = $wgRequest->getText( 'oldimage', false );
80  $token = $wgRequest->getText( 'wpEditToken' );
81  # Flag to hide all contents of the archived revisions
82  $suppress = $wgRequest->getCheck( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
83 
84  if ( $this->oldimage ) {
85  $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
86  $this->title,
87  $this->oldimage
88  );
89  }
90 
91  if ( !self::haveDeletableFile( $this->file, $this->oldfile, $this->oldimage ) ) {
92  $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
93  $wgOut->addReturnTo( $this->title );
94  return;
95  }
96 
97  // Perform the deletion if appropriate
98  if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
99  $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
100  $deleteReason = $wgRequest->getText( 'wpReason' );
101 
102  if ( $deleteReasonList == 'other' ) {
103  $reason = $deleteReason;
104  } elseif ( $deleteReason != '' ) {
105  // Entry from drop down menu + additional comment
106  $reason = $deleteReasonList . wfMessage( 'colon-separator' )
107  ->inContentLanguage()->text() . $deleteReason;
108  } else {
109  $reason = $deleteReasonList;
110  }
111 
112  $status = self::doDelete(
113  $this->title,
114  $this->file,
115  $this->oldimage,
116  $reason,
117  $suppress,
118  $wgUser
119  );
120 
121  if ( !$status->isGood() ) {
122  $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
123  $wgOut->wrapWikiTextAsInterface(
124  'error',
125  $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
126  );
127  }
128  if ( $status->isOK() ) {
129  $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
130  $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
131  // Return to the main page if we just deleted all versions of the
132  // file, otherwise go back to the description page
133  $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
134 
135  WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
136  }
137  return;
138  }
139 
140  $this->showForm();
141  $this->showLogEntries();
142  }
143 
157  public static function doDelete( &$title, &$file, &$oldimage, $reason,
158  $suppress, User $user = null, $tags = []
159  ) {
160  if ( $user === null ) {
161  global $wgUser;
162  $user = $wgUser;
163  }
164 
165  if ( $oldimage ) {
166  $page = null;
167  $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
168  if ( $status->ok ) {
169  // Need to do a log item
170  $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
171  if ( trim( $reason ) != '' ) {
172  $logComment .= wfMessage( 'colon-separator' )
173  ->inContentLanguage()->text() . $reason;
174  }
175 
176  $logtype = $suppress ? 'suppress' : 'delete';
177 
178  $logEntry = new ManualLogEntry( $logtype, 'delete' );
179  $logEntry->setPerformer( $user );
180  $logEntry->setTarget( $title );
181  $logEntry->setComment( $logComment );
182  $logEntry->setTags( $tags );
183  $logid = $logEntry->insert();
184  $logEntry->publish( $logid );
185 
186  $status->value = $logid;
187  }
188  } else {
189  $status = Status::newFatal( 'cannotdelete',
191  );
192  $page = WikiPage::factory( $title );
193  $dbw = wfGetDB( DB_MASTER );
194  $dbw->startAtomic( __METHOD__ );
195  // delete the associated article first
196  $error = '';
197  $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
198  $user, $tags );
199  // doDeleteArticleReal() returns a non-fatal error status if the page
200  // or revision is missing, so check for isOK() rather than isGood()
201  if ( $deleteStatus->isOK() ) {
202  $status = $file->delete( $reason, $suppress, $user );
203  if ( $status->isOK() ) {
204  if ( $deleteStatus->value === null ) {
205  // No log ID from doDeleteArticleReal(), probably
206  // because the page/revision didn't exist, so create
207  // one here.
208  $logtype = $suppress ? 'suppress' : 'delete';
209  $logEntry = new ManualLogEntry( $logtype, 'delete' );
210  $logEntry->setPerformer( $user );
211  $logEntry->setTarget( clone $title );
212  $logEntry->setComment( $reason );
213  $logEntry->setTags( $tags );
214  $logid = $logEntry->insert();
215  $dbw->onTransactionPreCommitOrIdle(
216  function () use ( $logEntry, $logid ) {
217  $logEntry->publish( $logid );
218  },
219  __METHOD__
220  );
221  $status->value = $logid;
222  } else {
223  $status->value = $deleteStatus->value; // log id
224  }
225  $dbw->endAtomic( __METHOD__ );
226  } else {
227  // Page deleted but file still there? rollback page delete
228  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
229  $lbFactory->rollbackMasterChanges( __METHOD__ );
230  }
231  } else {
232  // Done; nothing changed
233  $dbw->endAtomic( __METHOD__ );
234  }
235  }
236 
237  if ( $status->isOK() ) {
238  Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
239  }
240 
241  return $status;
242  }
243 
247  private function showForm() {
248  global $wgOut, $wgUser, $wgRequest;
249 
250  $conf = RequestContext::getMain()->getConfig();
251  $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
252 
253  $wgOut->addModules( 'mediawiki.action.delete.file' );
254 
255  $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
256 
257  $wgOut->enableOOUI();
258 
260  $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
261  [ 'other' => $wgOut->msg( 'filedelete-reason-otherlist' )->inContentLanguage()->text() ]
262  );
264 
265  $fields[] = new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet(
266  $this->prepareMessage( 'filedelete-intro' ) ) ]
267  );
268 
269  $fields[] = new OOUI\FieldLayout(
270  new OOUI\DropdownInputWidget( [
271  'name' => 'wpDeleteReasonList',
272  'inputId' => 'wpDeleteReasonList',
273  'tabIndex' => 1,
274  'infusable' => true,
275  'value' => '',
276  'options' => $options,
277  ] ),
278  [
279  'label' => $wgOut->msg( 'filedelete-comment' )->text(),
280  'align' => 'top',
281  ]
282  );
283 
284  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
285  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
286  // Unicode codepoints (or 255 UTF-8 bytes for old schema).
287  $fields[] = new OOUI\FieldLayout(
288  new OOUI\TextInputWidget( [
289  'name' => 'wpReason',
290  'inputId' => 'wpReason',
291  'tabIndex' => 2,
292  'maxLength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
293  'infusable' => true,
294  'value' => $wgRequest->getText( 'wpReason' ),
295  'autofocus' => true,
296  ] ),
297  [
298  'label' => $wgOut->msg( 'filedelete-otherreason' )->text(),
299  'align' => 'top',
300  ]
301  );
302 
303  if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
304  $fields[] = new OOUI\FieldLayout(
305  new OOUI\CheckboxInputWidget( [
306  'name' => 'wpSuppress',
307  'inputId' => 'wpSuppress',
308  'tabIndex' => 3,
309  'selected' => false,
310  ] ),
311  [
312  'label' => $wgOut->msg( 'revdelete-suppress' )->text(),
313  'align' => 'inline',
314  'infusable' => true,
315  ]
316  );
317  }
318 
319  if ( $wgUser->isLoggedIn() ) {
320  $fields[] = new OOUI\FieldLayout(
321  new OOUI\CheckboxInputWidget( [
322  'name' => 'wpWatch',
323  'inputId' => 'wpWatch',
324  'tabIndex' => 3,
325  'selected' => $checkWatch,
326  ] ),
327  [
328  'label' => $wgOut->msg( 'watchthis' )->text(),
329  'align' => 'inline',
330  'infusable' => true,
331  ]
332  );
333  }
334 
335  $fields[] = new OOUI\FieldLayout(
336  new OOUI\ButtonInputWidget( [
337  'name' => 'mw-filedelete-submit',
338  'inputId' => 'mw-filedelete-submit',
339  'tabIndex' => 4,
340  'value' => $wgOut->msg( 'filedelete-submit' )->text(),
341  'label' => $wgOut->msg( 'filedelete-submit' )->text(),
342  'flags' => [ 'primary', 'destructive' ],
343  'type' => 'submit',
344  ] ),
345  [
346  'align' => 'top',
347  ]
348  );
349 
350  $fieldset = new OOUI\FieldsetLayout( [
351  'label' => $wgOut->msg( 'filedelete-legend' )->text(),
352  'items' => $fields,
353  ] );
354 
355  $form = new OOUI\FormLayout( [
356  'method' => 'post',
357  'action' => $this->getAction(),
358  'id' => 'mw-img-deleteconfirm',
359  ] );
360  $form->appendContent(
361  $fieldset,
362  new OOUI\HtmlSnippet(
363  Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) )
364  )
365  );
366 
367  $wgOut->addHTML(
368  new OOUI\PanelLayout( [
369  'classes' => [ 'deletepage-wrapper' ],
370  'expanded' => false,
371  'padded' => true,
372  'framed' => true,
373  'content' => $form,
374  ] )
375  );
376 
377  if ( $wgUser->isAllowed( 'editinterface' ) ) {
378  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
379  $link = $linkRenderer->makeKnownLink(
380  $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle(),
381  wfMessage( 'filedelete-edit-reasonlist' )->text(),
382  [],
383  [ 'action' => 'edit' ]
384  );
385  $wgOut->addHTML( '<p class="mw-filedelete-editreasons">' . $link . '</p>' );
386  }
387  }
388 
392  private function showLogEntries() {
393  global $wgOut;
394  $deleteLogPage = new LogPage( 'delete' );
395  $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
396  LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
397  }
398 
407  private function prepareMessage( $message ) {
408  global $wgLang;
409  if ( $this->oldimage ) {
410  # Message keys used:
411  # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
412  return wfMessage(
413  "{$message}-old",
414  wfEscapeWikiText( $this->title->getText() ),
415  $wgLang->date( $this->getTimestamp(), true ),
416  $wgLang->time( $this->getTimestamp(), true ),
417  wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
418  } else {
419  return wfMessage(
420  $message,
421  wfEscapeWikiText( $this->title->getText() )
422  )->parseAsBlock();
423  }
424  }
425 
429  private function setHeaders() {
430  global $wgOut;
431  $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
432  $wgOut->setRobotPolicy( 'noindex,nofollow' );
433  $wgOut->addBacklinkSubtitle( $this->title );
434  }
435 
442  public static function isValidOldSpec( $oldimage ) {
443  return strlen( $oldimage ) >= 16
444  && strpos( $oldimage, '/' ) === false
445  && strpos( $oldimage, '\\' ) === false;
446  }
447 
458  public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
459  return $oldimage
460  ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
461  : $file && $file->exists() && $file->isLocal();
462  }
463 
469  private function getAction() {
470  $q = [];
471  $q['action'] = 'delete';
472 
473  if ( $this->oldimage ) {
474  $q['oldimage'] = $this->oldimage;
475  }
476 
477  return $this->title->getLocalURL( $q );
478  }
479 
485  private function getTimestamp() {
486  return $this->oldfile->getTimestamp();
487  }
488 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:127
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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 noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:1997
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
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:1277
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
const PROTO_CURRENT
Definition: Defines.php:222
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 MediaWikiServices
Definition: injection.txt:23
getTimestamp()
Extract the timestamp of the old version.
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1694
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
isLocal()
Returns true if the file comes from the local file repository.
Definition: File.php:1856
title
getTitle()
Return the associated title object.
Definition: File.php:326
const DB_MASTER
Definition: defines.php:26
Class to simplify the use of log pages.
Definition: LogPage.php:33
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3044
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
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 noclasses just before the function returns a value If you return true
Definition: hooks.txt:1997
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
wfReadOnly()
Check whether the wiki is in read-only mode.
$wgLang
Definition: Setup.php:902
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
An error page which can definitely be safely rendered using the OutputPage.
getAction()
Prepare the form action.
static isValidOldSpec( $oldimage)
Is the provided oldimage value valid?
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
Definition: WatchAction.php:89
const MIGRATION_OLD
Definition: Defines.php:315
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:61
static listDropDownOptions( $list, $params=[])
Build options for a drop-down box from a textual list.
Definition: Xml.php:541
setHeaders()
Set headers, titles and other bits.
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:1997
static doDelete(&$title, &$file, &$oldimage, $reason, $suppress, User $user=null, $tags=[])
Really delete the file.
delete( $reason, $suppress=false, $user=null)
Delete all versions of the file.
Definition: File.php:1950
static haveDeletableFile(&$file, &$oldfile, $oldimage)
Could we delete the file specified? If an oldimage value was provided, does it correspond to an exist...
showLogEntries()
Show deletion log fragments pertaining to the current file.
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
prepareMessage( $message)
Prepare a message referring to the file being deleted, showing an appropriate message depending upon ...
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:795
exists()
Returns true if file exists in the repository.
Definition: File.php:896
Show an error when a user tries to do something they do not have the necessary permissions for...
execute()
Fulfil the request; shows the form or deletes the file, pending authentication, confirmation, etc.
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:747
$wgOut
Definition: Setup.php:907
showForm()
Show the confirmation form.
$wgUploadMaintenance
To disable file delete/restore temporarily.
File deletion user interface.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static listDropDownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc...
Definition: Xml.php:583
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.