MediaWiki REL1_32
ApiDelete.php
Go to the documentation of this file.
1<?php
29class ApiDelete extends ApiBase {
37 public function execute() {
39
41
42 $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
43 $titleObj = $pageObj->getTitle();
44 if ( !$pageObj->exists() &&
45 !( $titleObj->getNamespace() == NS_FILE && self::canDeleteFile( $pageObj->getFile() ) )
46 ) {
47 $this->dieWithError( 'apierror-missingtitle' );
48 }
49
50 $reason = $params['reason'];
51 $user = $this->getUser();
52
53 // Check that the user is allowed to carry out the deletion
54 $this->checkTitleUserPermissions( $titleObj, 'delete' );
55
56 // If change tagging was requested, check that the user is allowed to tag,
57 // and the tags are valid
58 if ( $params['tags'] ) {
59 $tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
60 if ( !$tagStatus->isOK() ) {
61 $this->dieStatus( $tagStatus );
62 }
63 }
64
65 if ( $titleObj->getNamespace() == NS_FILE ) {
67 $pageObj,
68 $user,
69 $params['oldimage'],
70 $reason,
71 false,
72 $params['tags']
73 );
74 } else {
75 $status = self::delete( $pageObj, $user, $reason, $params['tags'] );
76 }
77
78 if ( !$status->isOk() ) {
79 $this->dieStatus( $status );
80 }
81 $this->addMessagesFromStatus( $status, [ 'warning' ], [ 'delete-scheduled' ] );
82
83 // Deprecated parameters
84 if ( $params['watch'] ) {
85 $watch = 'watch';
86 } elseif ( $params['unwatch'] ) {
87 $watch = 'unwatch';
88 } else {
89 $watch = $params['watchlist'];
90 }
91 $this->setWatch( $watch, $titleObj, 'watchdeletion' );
92
93 $r = [
94 'title' => $titleObj->getPrefixedText(),
95 'reason' => $reason,
96 ];
97 if ( $status->hasMessage( 'delete-scheduled' ) ) {
98 $r['scheduled'] = true;
99 }
100 if ( $status->value !== null ) {
101 // Scheduled deletions don't currently have a log entry available at this point
102 $r['logid'] = $status->value;
103 }
104 $this->getResult()->addValue( null, $this->getModuleName(), $r );
105 }
106
116 protected static function delete( Page $page, User $user, &$reason = null, $tags = [] ) {
117 $title = $page->getTitle();
118
119 // Auto-generate a summary, if necessary
120 if ( is_null( $reason ) ) {
121 // Need to pass a throwaway variable because generateReason expects
122 // a reference
123 $hasHistory = false;
124 $reason = $page->getAutoDeleteReason( $hasHistory );
125 if ( $reason === false ) {
126 // Should be reachable only if the page has no revisions
127 return Status::newFatal( 'cannotdelete', $title->getPrefixedText() ); // @codeCoverageIgnore
128 }
129 }
130
131 $error = '';
132
133 // Luckily, Article.php provides a reusable delete function that does the hard work for us
134 return $page->doDeleteArticleReal( $reason, false, 0, true, $error, $user, $tags );
135 }
136
141 protected static function canDeleteFile( File $file ) {
142 return $file->exists() && $file->isLocal() && !$file->getRedirected();
143 }
144
154 protected static function deleteFile( Page $page, User $user, $oldimage,
155 &$reason = null, $suppress = false, $tags = []
156 ) {
157 $title = $page->getTitle();
158
159 $file = $page->getFile();
160 if ( !self::canDeleteFile( $file ) ) {
161 return self::delete( $page, $user, $reason, $tags );
162 }
163
164 if ( $oldimage ) {
165 if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
166 return Status::newFatal( 'invalidoldimage' );
167 }
168 $oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
169 if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
170 return Status::newFatal( 'nodeleteablefile' );
171 }
172 }
173
174 if ( is_null( $reason ) ) { // Log and RC don't like null reasons
175 $reason = '';
176 }
177
178 return FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress, $user, $tags );
179 }
180
181 public function mustBePosted() {
182 return true;
183 }
184
185 public function isWriteMode() {
186 return true;
187 }
188
189 public function getAllowedParams() {
190 return [
191 'title' => null,
192 'pageid' => [
193 ApiBase::PARAM_TYPE => 'integer'
194 ],
195 'reason' => null,
196 'tags' => [
197 ApiBase::PARAM_TYPE => 'tags',
199 ],
200 'watch' => [
201 ApiBase::PARAM_DFLT => false,
203 ],
204 'watchlist' => [
205 ApiBase::PARAM_DFLT => 'preferences',
207 'watch',
208 'unwatch',
209 'preferences',
210 'nochange'
211 ],
212 ],
213 'unwatch' => [
214 ApiBase::PARAM_DFLT => false,
216 ],
217 'oldimage' => null,
218 ];
219 }
220
221 public function needsToken() {
222 return 'csrf';
223 }
224
225 protected function getExamplesMessages() {
226 return [
227 'action=delete&title=Main%20Page&token=123ABC'
228 => 'apihelp-delete-example-simple',
229 'action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
230 => 'apihelp-delete-example-reason',
231 ];
232 }
233
234 public function getHelpUrls() {
235 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Delete';
236 }
237}
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:105
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
addMessagesFromStatus(StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
Add warnings and/or errors from a Status.
Definition ApiBase.php:1966
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
setWatch( $watch, $titleObj, $userOption=null)
Set a watch (or unwatch) based the based on a watchlist parameter.
Definition ApiBase.php:1749
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
getResult()
Get the result object.
Definition ApiBase.php:659
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:539
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition ApiBase.php:1042
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:2052
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition ApiBase.php:1879
checkTitleUserPermissions(Title $title, $actions, $user=null)
Helper function for permission-denied errors.
Definition ApiBase.php:2113
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
API module that facilitates deleting pages.
Definition ApiDelete.php:29
execute()
Extracts the title and reason from the request parameters and invokes the local delete() function wit...
Definition ApiDelete.php:37
needsToken()
Returns the token type this module requires in order to execute.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getHelpUrls()
Return links to more detailed help pages about the module.
static canDeleteFile(File $file)
isWriteMode()
Indicates whether this module requires write mode.
static deleteFile(Page $page, User $user, $oldimage, &$reason=null, $suppress=false, $tags=[])
static delete(Page $page, User $user, &$reason=null, $tags=[])
We have our own delete() function, since Article.php's implementation is split in two phases.
mustBePosted()
Indicates whether this module must be called with a POST request.
static doDelete(&$title, &$file, &$oldimage, $reason, $suppress, User $user=null, $tags=[])
Really delete the file.
static isValidOldSpec( $oldimage)
Is the provided oldimage value valid?
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:51
isLocal()
Returns true if the file comes from the local file repository.
Definition File.php:1856
exists()
Returns true if file exists in the repository.
Definition File.php:896
getRedirected()
Definition File.php:2233
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
const NS_FILE
Definition Defines.php:70
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:1305
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
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:247
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:37
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition Page.php:24
$params