MediaWiki REL1_30
Nuke_body.php
Go to the documentation of this file.
1<?php
2
3class SpecialNuke extends SpecialPage {
4
5 public function __construct() {
6 parent::__construct( 'Nuke', 'nuke' );
7 }
8
9 public function doesWrites() {
10 return true;
11 }
12
13 public function execute( $par ) {
14 $this->setHeaders();
15 $this->checkPermissions();
16 $this->checkReadOnly();
17 $this->outputHeader();
18
19 $currentUser = $this->getUser();
20 if ( $currentUser->isBlocked() ) {
21 $block = $currentUser->getBlock();
22 throw new UserBlockedError( $block );
23 }
24
25 $req = $this->getRequest();
26 $target = trim( $req->getText( 'target', $par ) );
27
28 // Normalise name
29 if ( $target !== '' ) {
30 $user = User::newFromName( $target );
31 if ( $user ) {
32 $target = $user->getName();
33 }
34 }
35
36 $msg = $target === '' ?
37 $this->msg( 'nuke-multiplepeople' )->inContentLanguage()->text() :
38 $this->msg( 'nuke-defaultreason', $target )->
39 inContentLanguage()->text();
40 $reason = $req->getText( 'wpReason', $msg );
41
42 $limit = $req->getInt( 'limit', 500 );
43 $namespace = $req->getVal( 'namespace' );
44 $namespace = ctype_digit( $namespace ) ? (int)$namespace : null;
45
46 if ( $req->wasPosted()
47 && $currentUser->matchEditToken( $req->getVal( 'wpEditToken' ) )
48 ) {
49 if ( $req->getVal( 'action' ) === 'delete' ) {
50 $pages = $req->getArray( 'pages' );
51
52 if ( $pages ) {
53 $this->doDelete( $pages, $reason );
54
55 return;
56 }
57 } elseif ( $req->getVal( 'action' ) === 'submit' ) {
58 $this->listForm( $target, $reason, $limit, $namespace );
59 } else {
60 $this->promptForm();
61 }
62 } elseif ( $target === '' ) {
63 $this->promptForm();
64 } else {
65 $this->listForm( $target, $reason, $limit, $namespace );
66 }
67 }
68
74 protected function promptForm( $userName = '' ) {
75 $out = $this->getOutput();
76
77 $out->addWikiMsg( 'nuke-tools' );
78
79 $formDescriptor = [
80 'nuke-target' => [
81 'id' => 'nuke-target',
82 'default' => $userName,
83 'label' => $this->msg( 'nuke-userorip' )->text(),
84 'type' => 'user',
85 'name' => 'target'
86 ],
87 'nuke-pattern' => [
88 'id' => 'nuke-pattern',
89 'label' => $this->msg( 'nuke-pattern' )->text(),
90 'maxLength' => 40,
91 'type' => 'text',
92 'name' => 'pattern'
93 ],
94 'namespace' => [
95 'id' => 'nuke-namespace',
96 'type' => 'namespaceselect',
97 'label' => $this->msg( 'nuke-namespace' )->text(),
98 'all' => 'all',
99 'name' => 'namespace'
100 ],
101 'limit' => [
102 'id' => 'nuke-limit',
103 'maxLength' => 7,
104 'default' => 500,
105 'label' => $this->msg( 'nuke-maxpages' )->text(),
106 'type' => 'int',
107 'name' => 'limit'
108 ]
109 ];
110
111 HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
112 ->setName( 'massdelete' )
113 ->setFormIdentifier( 'massdelete' )
114 ->setWrapperLegendMsg( 'nuke' )
115 ->setSubmitTextMsg( 'nuke-submit-user' )
116 ->setSubmitName( 'nuke-submit-user' )
117 ->setAction( $this->getPageTitle()->getLocalURL( 'action=submit' ) )
118 ->setMethod( 'post' )
119 ->addHiddenField( 'wpEditToken', $this->getUser()->getEditToken() )
120 ->prepareForm()
121 ->displayForm( false );
122 }
123
132 protected function listForm( $username, $reason, $limit, $namespace = null ) {
133 $out = $this->getOutput();
134
135 $pages = $this->getNewPages( $username, $limit, $namespace );
136
137 if ( count( $pages ) === 0 ) {
138 if ( $username === '' ) {
139 $out->addWikiMsg( 'nuke-nopages-global' );
140 } else {
141 $out->addWikiMsg( 'nuke-nopages', $username );
142 }
143
144 $this->promptForm( $username );
145
146 return;
147 }
148
149 if ( $username === '' ) {
150 $out->addWikiMsg( 'nuke-list-multiple' );
151 } else {
152 $out->addWikiMsg( 'nuke-list', $username );
153 }
154
155 $nuke = $this->getPageTitle();
156
157 $out->addHTML(
158 Xml::openElement( 'form', [
159 'action' => $nuke->getLocalURL( 'action=delete' ),
160 'method' => 'post',
161 'name' => 'nukelist' ]
162 ) .
163 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
164 Xml::tags( 'p',
165 null,
166 Xml::inputLabel(
167 $this->msg( 'deletecomment' )->text(), 'wpReason', 'wpReason', 70, $reason
168 )
169 )
170 );
171
172 // Select: All, None, Invert
173 // ListToggle was introduced in 1.27, old code kept for B/C
174 if ( class_exists( 'ListToggle' ) ) {
175 $listToggle = new ListToggle( $this->getOutput() );
176 $selectLinks = $listToggle->getHTML();
177 } else {
178 $out->addModules( 'ext.nuke' );
179
180 $links = [];
181 $links[] = '<a href="#" id="toggleall">' .
182 $this->msg( 'powersearch-toggleall' )->escaped() . '</a>';
183 $links[] = '<a href="#" id="togglenone">' .
184 $this->msg( 'powersearch-togglenone' )->escaped() . '</a>';
185 $links[] = '<a href="#" id="toggleinvert">' .
186 $this->msg( 'nuke-toggleinvert' )->escaped() . '</a>';
187
188 $selectLinks = Xml::tags( 'p',
189 null,
190 $this->msg( 'nuke-select' )
191 ->rawParams( $this->getLanguage()->commaList( $links ) )->escaped()
192 );
193 }
194
195 $out->addHTML(
196 $selectLinks .
197 '<ul>'
198 );
199
200 $wordSeparator = $this->msg( 'word-separator' )->escaped();
201 $commaSeparator = $this->msg( 'comma-separator' )->escaped();
202
204 foreach ( $pages as $info ) {
208 list( $title, $userName ) = $info;
209
210 $image = $title->inNamespace( NS_FILE ) ? wfLocalFile( $title ) : false;
211 $thumb = $image && $image->exists() ?
212 $image->transform( [ 'width' => 120, 'height' => 120 ], 0 ) :
213 false;
214
215 $userNameText = $userName ?
216 $this->msg( 'nuke-editby', $userName )->parse() . $commaSeparator :
217 '';
218 $changesLink = $linkRenderer->makeKnownLink(
219 $title,
220 $this->msg( 'nuke-viewchanges' )->text(),
221 [],
222 [ 'action' => 'history' ]
223 );
224 $out->addHTML( '<li>' .
225 Xml::check(
226 'pages[]',
227 true,
228 [ 'value' => $title->getPrefixedDBkey() ]
229 ) . '&#160;' .
230 ( $thumb ? $thumb->toHtml( [ 'desc-link' => true ] ) : '' ) .
231 $linkRenderer->makeKnownLink( $title ) . $wordSeparator .
232 $this->msg( 'parentheses' )->rawParams( $userNameText . $changesLink )->escaped() .
233 "</li>\n" );
234 }
235
236 $out->addHTML(
237 "</ul>\n" .
238 Xml::submitButton( $this->msg( 'nuke-submit-delete' )->text() ) .
239 '</form>'
240 );
241 }
242
252 protected function getNewPages( $username, $limit, $namespace = null ) {
253 $dbr = wfGetDB( DB_SLAVE );
254
255 $what = [
256 'rc_namespace',
257 'rc_title',
258 'rc_timestamp',
259 ];
260
261 $where = [ "(rc_new = 1) OR (rc_log_type = 'upload' AND rc_log_action = 'upload')" ];
262
263 if ( $username === '' ) {
264 $what[] = 'rc_user_text';
265 } else {
266 $where['rc_user_text'] = $username;
267 }
268
269 if ( $namespace !== null ) {
270 $where['rc_namespace'] = $namespace;
271 }
272
273 $pattern = $this->getRequest()->getText( 'pattern' );
274 if ( !is_null( $pattern ) && trim( $pattern ) !== '' ) {
275 // $pattern is a SQL pattern supporting wildcards, so buildLike
276 // will not work.
277 $where[] = 'rc_title LIKE ' . $dbr->addQuotes( $pattern );
278 }
279 $group = implode( ', ', $what );
280
281 $result = $dbr->select( 'recentchanges',
282 $what,
283 $where,
284 __METHOD__,
285 [
286 'ORDER BY' => 'rc_timestamp DESC',
287 'GROUP BY' => $group,
288 'LIMIT' => $limit
289 ]
290 );
291
292 $pages = [];
293
294 foreach ( $result as $row ) {
295 $pages[] = [
296 Title::makeTitle( $row->rc_namespace, $row->rc_title ),
297 $username === '' ? $row->rc_user_text : false
298 ];
299 }
300
301 // Allows other extensions to provide pages to be nuked that don't use
302 // the recentchanges table the way mediawiki-core does
303 Hooks::run( 'NukeGetNewPages', [ $username, $pattern, $namespace, $limit, &$pages ] );
304
305 // Re-enforcing the limit *after* the hook because other extensions
306 // may add and/or remove pages. We need to make sure we don't end up
307 // with more pages than $limit.
308 if ( count( $pages ) > $limit ) {
309 $pages = array_slice( $pages, 0, $limit );
310 }
311
312 return $pages;
313 }
314
322 protected function doDelete( array $pages, $reason ) {
323 $res = [];
324
325 foreach ( $pages as $page ) {
326 $title = Title::newFromText( $page );
327
328 $deletionResult = false;
329 if ( !Hooks::run( 'NukeDeletePage', [ $title, $reason, &$deletionResult ] ) ) {
330 if ( $deletionResult ) {
331 $res[] = $this->msg( 'nuke-deleted', $title->getPrefixedText() )->parse();
332 } else {
333 $res[] = $this->msg( 'nuke-not-deleted', $title->getPrefixedText() )->parse();
334 }
335 continue;
336 }
337
338 $file = $title->getNamespace() === NS_FILE ? wfLocalFile( $title ) : false;
339 $permission_errors = $title->getUserPermissionsErrors( 'delete', $this->getUser() );
340
341 if ( $permission_errors !== [] ) {
342 throw new PermissionsError( 'delete', $permission_errors );
343 }
344
345 if ( $file ) {
346 $oldimage = null; // Must be passed by reference
347 $ok = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, false )->isOK();
348 } else {
349 $article = new Article( $title, 0 );
350 $ok = $article->doDeleteArticle( $reason );
351 }
352
353 if ( $ok ) {
354 $res[] = $this->msg( 'nuke-deleted', $title->getPrefixedText() )->parse();
355 } else {
356 $res[] = $this->msg( 'nuke-not-deleted', $title->getPrefixedText() )->parse();
357 }
358 }
359
360 $this->getOutput()->addHTML( "<ul>\n<li>" . implode( "</li>\n<li>", $res ) . "</li>\n</ul>\n" );
361 $this->getOutput()->addWikiMsg( 'nuke-delete-more' );
362 }
363
372 public function prefixSearchSubpages( $search, $limit, $offset ) {
373 if ( !class_exists( 'UserNamePrefixSearch' ) ) { // check for version 1.27
374 return [];
375 }
376 $user = User::newFromName( $search );
377 if ( !$user ) {
378 // No prefix suggestion for invalid user
379 return [];
380 }
381 // Autocomplete subpage as user list - public to allow caching
382 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
383 }
384
385 protected function getGroupName() {
386 return 'pagetools';
387 }
388}
const DB_SLAVE
Definition Defines.php:37
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfLocalFile( $title)
Get an object referring to a locally registered file.
Class for viewing MediaWiki article and history.
Definition Article.php:35
static doDelete(&$title, &$file, &$oldimage, $reason, $suppress, User $user=null, $tags=[])
Really delete the file.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition HTMLForm.php:277
Class for generating clickable toggle links for a list of checkboxes.
Show an error when a user tries to do something they do not have the necessary permissions for.
execute( $par)
Default execute method Checks user permissions.
Definition Nuke_body.php:13
doDelete(array $pages, $reason)
Does the actual deletion of the pages.
promptForm( $userName='')
Prompt for a username or IP address.
Definition Nuke_body.php:74
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
getNewPages( $username, $limit, $namespace=null)
Gets a list of new pages by the specified user or everyone when none is specified.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
listForm( $username, $reason, $limit, $namespace=null)
Display list of pages to delete.
doesWrites()
Indicates whether this special page may perform database writes.
Definition Nuke_body.php:9
Parent class for all special pages.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
getPageTitle( $subpage=false)
Get a self-referential title object.
getLanguage()
Shortcut to get user's language.
MediaWiki Linker LinkRenderer null $linkRenderer
Show an error when the user tries to do something whilst blocked.
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
if(! $regexes) $dbr
Definition cleanup.php:94
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
this hook is for auditing only $req
Definition hooks.txt:988
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 $image
Definition hooks.txt:893
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
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:862
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:783
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
const NS_FILE
Definition Defines.php:71