filebackend: use self:: instead of FileBackend:: for some constant uses
[lhc/web/wiklou.git] / includes / ProtectionForm.php
1 <?php
2 /**
3 * Page protection
4 *
5 * Copyright © 2005 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
22 *
23 * @file
24 */
25 use MediaWiki\MediaWikiServices;
26
27 /**
28 * Handles the page protection UI and backend
29 */
30 class ProtectionForm {
31 /** @var array A map of action to restriction level, from request or default */
32 protected $mRestrictions = [];
33
34 /** @var string The custom/additional protection reason */
35 protected $mReason = '';
36
37 /** @var string The reason selected from the list, blank for other/additional */
38 protected $mReasonSelection = '';
39
40 /** @var bool True if the restrictions are cascading, from request or existing protection */
41 protected $mCascade = false;
42
43 /** @var array Map of action to "other" expiry time. Used in preference to mExpirySelection. */
44 protected $mExpiry = [];
45
46 /**
47 * @var array Map of action to value selected in expiry drop-down list.
48 * Will be set to 'othertime' whenever mExpiry is set.
49 */
50 protected $mExpirySelection = [];
51
52 /** @var array Permissions errors for the protect action */
53 protected $mPermErrors = [];
54
55 /** @var array Types (i.e. actions) for which levels can be selected */
56 protected $mApplicableTypes = [];
57
58 /** @var array Map of action to the expiry time of the existing protection */
59 protected $mExistingExpiry = [];
60
61 /** @var IContextSource */
62 private $mContext;
63
64 function __construct( Article $article ) {
65 // Set instance variables.
66 $this->mArticle = $article;
67 $this->mTitle = $article->getTitle();
68 $this->mApplicableTypes = $this->mTitle->getRestrictionTypes();
69 $this->mContext = $article->getContext();
70
71 // Check if the form should be disabled.
72 // If it is, the form will be available in read-only to show levels.
73 $this->mPermErrors = $this->mTitle->getUserPermissionsErrors(
74 'protect',
75 $this->mContext->getUser(),
76 $this->mContext->getRequest()->wasPosted() ? 'secure' : 'full' // T92357
77 );
78 if ( wfReadOnly() ) {
79 $this->mPermErrors[] = [ 'readonlytext', wfReadOnlyReason() ];
80 }
81 $this->disabled = $this->mPermErrors != [];
82 $this->disabledAttrib = $this->disabled
83 ? [ 'disabled' => 'disabled' ]
84 : [];
85
86 $this->loadData();
87 }
88
89 /**
90 * Loads the current state of protection into the object.
91 */
92 function loadData() {
93 $levels = MediaWikiServices::getInstance()->getPermissionManager()->getNamespaceRestrictionLevels(
94 $this->mTitle->getNamespace(), $this->mContext->getUser()
95 );
96 $this->mCascade = $this->mTitle->areRestrictionsCascading();
97
98 $request = $this->mContext->getRequest();
99 $this->mReason = $request->getText( 'mwProtect-reason' );
100 $this->mReasonSelection = $request->getText( 'wpProtectReasonSelection' );
101 $this->mCascade = $request->getBool( 'mwProtect-cascade', $this->mCascade );
102
103 foreach ( $this->mApplicableTypes as $action ) {
104 // @todo FIXME: This form currently requires individual selections,
105 // but the db allows multiples separated by commas.
106
107 // Pull the actual restriction from the DB
108 $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
109
110 if ( !$this->mRestrictions[$action] ) {
111 // No existing expiry
112 $existingExpiry = '';
113 } else {
114 $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
115 }
116 $this->mExistingExpiry[$action] = $existingExpiry;
117
118 $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
119 $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
120
121 if ( $requestExpiry ) {
122 // Custom expiry takes precedence
123 $this->mExpiry[$action] = $requestExpiry;
124 $this->mExpirySelection[$action] = 'othertime';
125 } elseif ( $requestExpirySelection ) {
126 // Expiry selected from list
127 $this->mExpiry[$action] = '';
128 $this->mExpirySelection[$action] = $requestExpirySelection;
129 } elseif ( $existingExpiry ) {
130 // Use existing expiry in its own list item
131 $this->mExpiry[$action] = '';
132 $this->mExpirySelection[$action] = $existingExpiry;
133 } else {
134 // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
135 // Final default: infinite
136 $this->mExpiry[$action] = '';
137 $this->mExpirySelection[$action] = 'infinite';
138 }
139
140 $val = $request->getVal( "mwProtect-level-$action" );
141 if ( isset( $val ) && in_array( $val, $levels ) ) {
142 $this->mRestrictions[$action] = $val;
143 }
144 }
145 }
146
147 /**
148 * Get the expiry time for a given action, by combining the relevant inputs.
149 *
150 * @param string $action
151 *
152 * @return string|false 14-char timestamp or "infinity", or false if the input was invalid
153 */
154 function getExpiry( $action ) {
155 if ( $this->mExpirySelection[$action] == 'existing' ) {
156 return $this->mExistingExpiry[$action];
157 } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
158 $value = $this->mExpiry[$action];
159 } else {
160 $value = $this->mExpirySelection[$action];
161 }
162 if ( wfIsInfinity( $value ) ) {
163 $time = 'infinity';
164 } else {
165 $unix = strtotime( $value );
166
167 if ( !$unix || $unix === -1 ) {
168 return false;
169 }
170
171 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
172 // and there isn't notice about it in the ui
173 $time = wfTimestamp( TS_MW, $unix );
174 }
175 return $time;
176 }
177
178 /**
179 * Main entry point for action=protect and action=unprotect
180 */
181 function execute() {
182 if (
183 MediaWikiServices::getInstance()->getPermissionManager()->getNamespaceRestrictionLevels(
184 $this->mTitle->getNamespace()
185 ) === [ '' ]
186 ) {
187 throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
188 }
189
190 if ( $this->mContext->getRequest()->wasPosted() ) {
191 if ( $this->save() ) {
192 $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
193 $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) );
194 }
195 } else {
196 $this->show();
197 }
198 }
199
200 /**
201 * Show the input form with optional error message
202 *
203 * @param string|string[]|null $err Error message or null if there's no error
204 */
205 function show( $err = null ) {
206 $out = $this->mContext->getOutput();
207 $out->setRobotPolicy( 'noindex,nofollow' );
208 $out->addBacklinkSubtitle( $this->mTitle );
209
210 if ( is_array( $err ) ) {
211 $out->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n", $err );
212 } elseif ( is_string( $err ) ) {
213 $out->addHTML( "<div class='error'>{$err}</div>\n" );
214 }
215
216 if ( $this->mTitle->getRestrictionTypes() === [] ) {
217 // No restriction types available for the current title
218 // this might happen if an extension alters the available types
219 $out->setPageTitle( $this->mContext->msg(
220 'protect-norestrictiontypes-title',
221 $this->mTitle->getPrefixedText()
222 ) );
223 $out->addWikiTextAsInterface(
224 $this->mContext->msg( 'protect-norestrictiontypes-text' )->plain()
225 );
226
227 // Show the log in case protection was possible once
228 $this->showLogExtract( $out );
229 // return as there isn't anything else we can do
230 return;
231 }
232
233 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
234 if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
235 $titles = '';
236
237 foreach ( $cascadeSources as $title ) {
238 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
239 }
240
241 /** @todo FIXME: i18n issue, should use formatted number. */
242 $out->wrapWikiMsg(
243 "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
244 [ 'protect-cascadeon', count( $cascadeSources ) ]
245 );
246 }
247
248 # Show an appropriate message if the user isn't allowed or able to change
249 # the protection settings at this time
250 if ( $this->disabled ) {
251 $out->setPageTitle(
252 $this->mContext->msg( 'protect-title-notallowed',
253 $this->mTitle->getPrefixedText() )
254 );
255 $out->addWikiTextAsInterface( $out->formatPermissionsErrorMessage(
256 $this->mPermErrors, 'protect'
257 ) );
258 } else {
259 $out->setPageTitle( $this->mContext->msg( 'protect-title', $this->mTitle->getPrefixedText() ) );
260 $out->addWikiMsg( 'protect-text',
261 wfEscapeWikiText( $this->mTitle->getPrefixedText() ) );
262 }
263
264 $out->addHTML( $this->buildForm() );
265 $this->showLogExtract( $out );
266 }
267
268 /**
269 * Save submitted protection form
270 *
271 * @return bool Success
272 */
273 function save() {
274 # Permission check!
275 if ( $this->disabled ) {
276 $this->show();
277 return false;
278 }
279
280 $request = $this->mContext->getRequest();
281 $user = $this->mContext->getUser();
282 $out = $this->mContext->getOutput();
283 $token = $request->getVal( 'wpEditToken' );
284 if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle->getPrefixedDBkey() ] ) ) {
285 $this->show( [ 'sessionfailure' ] );
286 return false;
287 }
288
289 # Create reason string. Use list and/or custom string.
290 $reasonstr = $this->mReasonSelection;
291 if ( $reasonstr != 'other' && $this->mReason != '' ) {
292 // Entry from drop down menu + additional comment
293 $reasonstr .= $this->mContext->msg( 'colon-separator' )->text() . $this->mReason;
294 } elseif ( $reasonstr == 'other' ) {
295 $reasonstr = $this->mReason;
296 }
297 $expiry = [];
298 foreach ( $this->mApplicableTypes as $action ) {
299 $expiry[$action] = $this->getExpiry( $action );
300 if ( empty( $this->mRestrictions[$action] ) ) {
301 continue; // unprotected
302 }
303 if ( !$expiry[$action] ) {
304 $this->show( [ 'protect_expiry_invalid' ] );
305 return false;
306 }
307 if ( $expiry[$action] < wfTimestampNow() ) {
308 $this->show( [ 'protect_expiry_old' ] );
309 return false;
310 }
311 }
312
313 $this->mCascade = $request->getBool( 'mwProtect-cascade' );
314
315 $status = $this->mArticle->doUpdateRestrictions(
316 $this->mRestrictions,
317 $expiry,
318 $this->mCascade,
319 $reasonstr,
320 $user
321 );
322
323 if ( !$status->isOK() ) {
324 $this->show( $out->parseInlineAsInterface( $status->getWikiText() ) );
325 return false;
326 }
327
328 /**
329 * Give extensions a change to handle added form items
330 *
331 * @since 1.19 you can (and you should) return false to abort saving;
332 * you can also return an array of message name and its parameters
333 */
334 $errorMsg = '';
335 if ( !Hooks::run( 'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
336 if ( $errorMsg == '' ) {
337 $errorMsg = [ 'hookaborted' ];
338 }
339 }
340 if ( $errorMsg != '' ) {
341 $this->show( $errorMsg );
342 return false;
343 }
344
345 WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
346
347 return true;
348 }
349
350 /**
351 * Build the input form
352 *
353 * @return string HTML form
354 */
355 function buildForm() {
356 $context = $this->mContext;
357 $user = $context->getUser();
358 $output = $context->getOutput();
359 $lang = $context->getLanguage();
360 $out = '';
361 if ( !$this->disabled ) {
362 $output->addModules( 'mediawiki.legacy.protect' );
363 $out .= Xml::openElement( 'form', [ 'method' => 'post',
364 'action' => $this->mTitle->getLocalURL( 'action=protect' ),
365 'id' => 'mw-Protect-Form' ] );
366 }
367
368 $out .= Xml::openElement( 'fieldset' ) .
369 Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
370 Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
371 Xml::openElement( 'tbody' );
372
373 $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
374 $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
375
376 // Not all languages have V_x <-> N_x relation
377 foreach ( $this->mRestrictions as $action => $selected ) {
378 // Messages:
379 // restriction-edit, restriction-move, restriction-create, restriction-upload
380 $msg = $context->msg( 'restriction-' . $action );
381 $out .= "<tr><td>" .
382 Xml::openElement( 'fieldset' ) .
383 Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
384 Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
385 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
386
387 $mProtectexpiry = Xml::label(
388 $context->msg( 'protectexpiry' )->text(),
389 "mwProtectExpirySelection-$action"
390 );
391 $mProtectother = Xml::label(
392 $context->msg( 'protect-othertime' )->text(),
393 "mwProtect-$action-expires"
394 );
395
396 $expiryFormOptions = new XmlSelect(
397 "wpProtectExpirySelection-$action",
398 "mwProtectExpirySelection-$action",
399 $this->mExpirySelection[$action]
400 );
401 $expiryFormOptions->setAttribute( 'tabindex', '2' );
402 if ( $this->disabled ) {
403 $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
404 }
405
406 if ( $this->mExistingExpiry[$action] ) {
407 if ( $this->mExistingExpiry[$action] == 'infinity' ) {
408 $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
409 } else {
410 $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry[$action], $user );
411 $d = $lang->userDate( $this->mExistingExpiry[$action], $user );
412 $t = $lang->userTime( $this->mExistingExpiry[$action], $user );
413 $existingExpiryMessage = $context->msg(
414 'protect-existing-expiry',
415 $timestamp,
416 $d,
417 $t
418 );
419 }
420 $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
421 }
422
423 $expiryFormOptions->addOption(
424 $context->msg( 'protect-othertime-op' )->text(),
425 'othertime'
426 );
427 foreach ( explode( ',', $scExpiryOptions ) as $option ) {
428 if ( strpos( $option, ":" ) === false ) {
429 $show = $value = $option;
430 } else {
431 list( $show, $value ) = explode( ":", $option );
432 }
433 $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
434 }
435 # Add expiry dropdown
436 if ( $showProtectOptions && !$this->disabled ) {
437 $out .= "
438 <table><tr>
439 <td class='mw-label'>
440 {$mProtectexpiry}
441 </td>
442 <td class='mw-input'>" .
443 $expiryFormOptions->getHTML() .
444 "</td>
445 </tr></table>";
446 }
447 # Add custom expiry field
448 $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib;
449 $out .= "<table><tr>
450 <td class='mw-label'>" .
451 $mProtectother .
452 '</td>
453 <td class="mw-input">' .
454 Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
455 '</td>
456 </tr></table>';
457 $out .= "</td></tr>" .
458 Xml::closeElement( 'table' ) .
459 Xml::closeElement( 'fieldset' ) .
460 "</td></tr>";
461 }
462 # Give extensions a chance to add items to the form
463 Hooks::run( 'ProtectionForm::buildForm', [ $this->mArticle, &$out ] );
464
465 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
466
467 // JavaScript will add another row with a value-chaining checkbox
468 if ( $this->mTitle->exists() ) {
469 $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
470 Xml::openElement( 'tbody' );
471 $out .= '<tr>
472 <td></td>
473 <td class="mw-input">' .
474 Xml::checkLabel(
475 $context->msg( 'protect-cascade' )->text(),
476 'mwProtect-cascade',
477 'mwProtect-cascade',
478 $this->mCascade, $this->disabledAttrib
479 ) .
480 "</td>
481 </tr>\n";
482 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
483 }
484
485 # Add manual and custom reason field/selects as well as submit
486 if ( !$this->disabled ) {
487 $mProtectreasonother = Xml::label(
488 $context->msg( 'protectcomment' )->text(),
489 'wpProtectReasonSelection'
490 );
491
492 $mProtectreason = Xml::label(
493 $context->msg( 'protect-otherreason' )->text(),
494 'mwProtect-reason'
495 );
496
497 $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
498 wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
499 wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
500 $this->mReasonSelection,
501 'mwProtect-reason', 4 );
502
503 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
504 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
505 // Unicode codepoints.
506 // Subtract arbitrary 75 to leave some space for the autogenerated null edit's summary
507 // and other texts chosen by dropdown menus on this page.
508 $maxlength = CommentStore::COMMENT_CHARACTER_LIMIT - 75;
509
510 $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
511 Xml::openElement( 'tbody' );
512 $out .= "
513 <tr>
514 <td class='mw-label'>
515 {$mProtectreasonother}
516 </td>
517 <td class='mw-input'>
518 {$reasonDropDown}
519 </td>
520 </tr>
521 <tr>
522 <td class='mw-label'>
523 {$mProtectreason}
524 </td>
525 <td class='mw-input'>" .
526 Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text',
527 'id' => 'mwProtect-reason', 'maxlength' => $maxlength ] ) .
528 "</td>
529 </tr>";
530 # Disallow watching is user is not logged in
531 if ( $user->isLoggedIn() ) {
532 $out .= "
533 <tr>
534 <td></td>
535 <td class='mw-input'>" .
536 Xml::checkLabel( $context->msg( 'watchthis' )->text(),
537 'mwProtectWatch', 'mwProtectWatch',
538 $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
539 "</td>
540 </tr>";
541 }
542 $out .= "
543 <tr>
544 <td></td>
545 <td class='mw-submit'>" .
546 Xml::submitButton(
547 $context->msg( 'confirm' )->text(),
548 [ 'id' => 'mw-Protect-submit' ]
549 ) .
550 "</td>
551 </tr>\n";
552 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
553 }
554 $out .= Xml::closeElement( 'fieldset' );
555
556 if ( MediaWikiServices::getInstance()->getPermissionManager()
557 ->userHasRight( $user, 'editinterface' ) ) {
558 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
559 $link = $linkRenderer->makeKnownLink(
560 $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
561 $context->msg( 'protect-edit-reasonlist' )->text(),
562 [],
563 [ 'action' => 'edit' ]
564 );
565 $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
566 }
567
568 if ( !$this->disabled ) {
569 $out .= Html::hidden(
570 'wpEditToken',
571 $user->getEditToken( [ 'protect', $this->mTitle->getPrefixedDBkey() ] )
572 );
573 $out .= Xml::closeElement( 'form' );
574 }
575
576 return $out;
577 }
578
579 /**
580 * Build protection level selector
581 *
582 * @param string $action Action to protect
583 * @param string $selected Current protection level
584 * @return string HTML fragment
585 */
586 function buildSelector( $action, $selected ) {
587 // If the form is disabled, display all relevant levels. Otherwise,
588 // just show the ones this user can use.
589 $levels = MediaWikiServices::getInstance()
590 ->getPermissionManager()
591 ->getNamespaceRestrictionLevels(
592 $this->mTitle->getNamespace(),
593 $this->disabled ? null : $this->mContext->getUser()
594 );
595
596 $id = 'mwProtect-level-' . $action;
597
598 $select = new XmlSelect( $id, $id, $selected );
599 $select->setAttribute( 'size', count( $levels ) );
600 if ( $this->disabled ) {
601 $select->setAttribute( 'disabled', 'disabled' );
602 }
603
604 foreach ( $levels as $key ) {
605 $select->addOption( $this->getOptionLabel( $key ), $key );
606 }
607
608 return $select->getHTML();
609 }
610
611 /**
612 * Prepare the label for a protection selector option
613 *
614 * @param string $permission Permission required
615 * @return string
616 */
617 private function getOptionLabel( $permission ) {
618 if ( $permission == '' ) {
619 return $this->mContext->msg( 'protect-default' )->text();
620 } else {
621 // Messages: protect-level-autoconfirmed, protect-level-sysop
622 $msg = $this->mContext->msg( "protect-level-{$permission}" );
623 if ( $msg->exists() ) {
624 return $msg->text();
625 }
626 return $this->mContext->msg( 'protect-fallback', $permission )->text();
627 }
628 }
629
630 /**
631 * Show protection long extracts for this page
632 *
633 * @param OutputPage $out
634 */
635 private function showLogExtract( OutputPage $out ) {
636 # Show relevant lines from the protection log:
637 $protectLogPage = new LogPage( 'protect' );
638 $out->addHTML( Xml::element( 'h2', null, $protectLogPage->getName()->text() ) );
639 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle );
640 # Let extensions add other relevant log extracts
641 Hooks::run( 'ProtectionForm::showLogExtract', [ $this->mArticle, $out ] );
642 }
643 }