includes/ProtectionForm.php

   1 <?php
   2 /**
   3  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
   4  * http://www.mediawiki.org/
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  */
  21
  22 /**
  23  * @todo document, briefly.
  24  */
  25 class ProtectionForm {
  26         /** A map of action to restriction level, from request or default */
  27         var $mRestrictions = array();
  28
  29         /** The custom/additional protection reason */
  30         var $mReason = '';
  31
  32         /** The reason selected from the list, blank for other/additional */
  33         var $mReasonSelection = '';
  34
  35         /** True if the restrictions are cascading, from request or existing protection */
  36         var $mCascade = false;
  37
  38         /** Map of action to "other" expiry time. Used in preference to mExpirySelection. */
  39         var $mExpiry = array();
  40
  41         /**
  42          * Map of action to value selected in expiry drop-down list.
  43          * Will be set to 'othertime' whenever mExpiry is set.
  44          */
  45         var $mExpirySelection = array();
  46
  47         /** Permissions errors for the protect action */
  48         var $mPermErrors = array();
  49
  50         /** Types (i.e. actions) for which levels can be selected */
  51         var $mApplicableTypes = array();
  52
  53         /** Map of action to the expiry time of the existing protection */
  54         var $mExistingExpiry = array();
  55
  56         function __construct( Article $article ) {
  57                 global $wgRequest, $wgUser;
  58                 global $wgRestrictionTypes, $wgRestrictionLevels;
  59                 $this->mArticle = $article;
  60                 $this->mTitle = $article->mTitle;
  61                 $this->mApplicableTypes = $this->mTitle->exists() ? $wgRestrictionTypes : array('create');
  62
  63                 $this->mCascade = $this->mTitle->areRestrictionsCascading();
  64
  65                 // The form will be available in read-only to show levels.
  66                 $this->mPermErrors = $this->mTitle->getUserPermissionsErrors('protect',$wgUser);
  67                 $this->disabled = wfReadOnly() || $this->mPermErrors != array();
  68                 $this->disabledAttrib = $this->disabled
  69                         ? array( 'disabled' => 'disabled' )
  70                         : array();
  71
  72                 $this->mReason = $wgRequest->getText( 'mwProtect-reason' );
  73                 $this->mReasonSelection = $wgRequest->getText( 'wpProtectReasonSelection' );
  74                 $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade );
  75
  76                 foreach( $this->mApplicableTypes as $action ) {
  77                         // Fixme: this form currently requires individual selections,
  78                         // but the db allows multiples separated by commas.
  79                         $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
  80
  81                         if ( !$this->mRestrictions[$action] ) {
  82                                 // No existing expiry
  83                                 $existingExpiry = '';
  84                         } else {
  85                                 $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
  86                         }
  87                         $this->mExistingExpiry[$action] = $existingExpiry;
  88
  89                         $requestExpiry = $wgRequest->getText( "mwProtect-expiry-$action" );
  90                         $requestExpirySelection = $wgRequest->getVal( "wpProtectExpirySelection-$action" );
  91
  92                         if ( $requestExpiry ) {
  93                                 // Custom expiry takes precedence
  94                                 $this->mExpiry[$action] = $requestExpiry;
  95                                 $this->mExpirySelection[$action] = 'othertime';
  96                         } elseif ( $requestExpirySelection ) {
  97                                 // Expiry selected from list
  98                                 $this->mExpiry[$action] = '';
  99                                 $this->mExpirySelection[$action] = $requestExpirySelection;
 100                         } elseif ( $existingExpiry == 'infinity' ) {
 101                                 // Existing expiry is infinite, use "infinite" in drop-down
 102                                 $this->mExpiry[$action] = '';
 103                                 $this->mExpirySelection[$action] = 'infinite';
 104                         } elseif ( $existingExpiry ) {
 105                                 // Use existing expiry in its own list item
 106                                 $this->mExpiry[$action] = '';
 107                                 $this->mExpirySelection[$action] = $existingExpiry;
 108                         } else {
 109                                 // Final default: infinite
 110                                 $this->mExpiry[$action] = '';
 111                                 $this->mExpirySelection[$action] = 'infinite';
 112                         }
 113
 114                         $val = $wgRequest->getVal( "mwProtect-level-$action" );
 115                         if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
 116                                 // Prevent users from setting levels that they cannot later unset
 117                                 if( $val == 'sysop' ) {
 118                                         // Special case, rewrite sysop to either protect and editprotected
 119                                         if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') )
 120                                                 continue;
 121                                 } else {
 122                                         if( !$wgUser->isAllowed($val) )
 123                                                 continue;
 124                                 }
 125                                 $this->mRestrictions[$action] = $val;
 126                         }
 127                 }
 128         }
 129
 130         /**
 131          * Get the expiry time for a given action, by combining the relevant inputs.
 132          * Returns a 14-char timestamp or "infinity", or false if the input was invalid
 133          */
 134         function getExpiry( $action ) {
 135                 if ( $this->mExpirySelection[$action] == 'existing' ) {
 136                         return $this->mExistingExpiry[$action];
 137                 } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
 138                         $value = $this->mExpiry[$action];
 139                 } else {
 140                         $value = $this->mExpirySelection[$action];
 141                 }
 142                 if ( $value == 'infinite' || $value == 'indefinite' || $value == 'infinity' ) {
 143                         $time = Block::infinity();
 144                 } else {
 145                         $unix = strtotime( $value );
 146
 147                         if ( !$unix || $unix === -1 ) {
 148                                 return false;
 149                         }
 150
 151                         // Fixme: non-qualified absolute times are not in users specified timezone
 152                         // and there isn't notice about it in the ui
 153                         $time = wfTimestamp( TS_MW, $unix );
 154                 }
 155                 return $time;
 156         }
 157
 158         function execute() {
 159                 global $wgRequest, $wgOut;
 160                 if( $wgRequest->wasPosted() ) {
 161                         if( $this->save() ) {
 162                                 $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
 163                                 $wgOut->redirect( $this->mTitle->getFullUrl( $q ) );
 164                         }
 165                 } else {
 166                         $this->show();
 167                 }
 168         }
 169
 170         function show( $err = null ) {
 171                 global $wgOut, $wgUser;
 172
 173                 $wgOut->setRobotPolicy( 'noindex,nofollow' );
 174
 175                 if( is_null( $this->mTitle ) ||
 176                         $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
 177                         $wgOut->showFatalError( wfMsg( 'badarticleerror' ) );
 178                         return;
 179                 }
 180
 181                 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
 182
 183                 if ( "" != $err ) {
 184                         $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
 185                         $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
 186                 }
 187
 188                 if ( $cascadeSources && count($cascadeSources) > 0 ) {
 189                         $titles = '';
 190
 191                         foreach ( $cascadeSources as $title ) {
 192                                 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
 193                         }
 194
 195                         $wgOut->wrapWikiMsg( "$1\n$titles", array( 'protect-cascadeon', count($cascadeSources) ) );
 196                 }
 197
 198                 $sk = $wgUser->getSkin();
 199                 $titleLink = $sk->makeLinkObj( $this->mTitle );
 200                 $wgOut->setPageTitle( wfMsg( 'protect-title', $this->mTitle->getPrefixedText() ) );
 201                 $wgOut->setSubtitle( wfMsg( 'protect-backlink', $titleLink ) );
 202
 203                 # Show an appropriate message if the user isn't allowed or able to change
 204                 # the protection settings at this time
 205                 if( $this->disabled ) {
 206                         if( wfReadOnly() ) {
 207                                 $wgOut->readOnlyPage();
 208                         } elseif( $this->mPermErrors ) {
 209                                 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors ) );
 210                         }
 211                 } else {
 212                         $wgOut->addWikiMsg( 'protect-text', $this->mTitle->getPrefixedText() );
 213                 }
 214
 215                 $wgOut->addHTML( $this->buildForm() );
 216
 217                 $this->showLogExtract( $wgOut );
 218         }
 219
 220         function save() {
 221                 global $wgRequest, $wgUser, $wgOut;
 222                 # Permission check!
 223                 if ( $this->disabled ) {
 224                         $this->show();
 225                         return false;
 226                 }
 227
 228                 $token = $wgRequest->getVal( 'wpEditToken' );
 229                 if ( !$wgUser->matchEditToken( $token ) ) {
 230                         $this->show( wfMsg( 'sessionfailure' ) );
 231                         return false;
 232                 }
 233
 234                 # Create reason string. Use list and/or custom string.
 235                 $reasonstr = $this->mReasonSelection;
 236                 if ( $reasonstr != 'other' && $this->mReason != '' ) {
 237                         // Entry from drop down menu + additional comment
 238                         $reasonstr .= ': ' . $this->mReason;
 239                 } elseif ( $reasonstr == 'other' ) {
 240                         $reasonstr = $this->mReason;
 241                 }
 242                 $expiry = array();
 243                 foreach( $this->mApplicableTypes as $action ) {
 244                         $expiry[$action] = $this->getExpiry( $action );
 245                         if ( !$expiry[$action] ) {
 246                                 $this->show( wfMsg( 'protect_expiry_invalid' ) );
 247                                 return false;
 248                         }
 249                         if ( $expiry[$action] < wfTimestampNow() ) {
 250                                 $this->show( wfMsg( 'protect_expiry_old' ) );
 251                                 return false;
 252                         }
 253                 }
 254
 255                 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
 256                 #  to a semi-protected page.
 257                 global $wgGroupPermissions;
 258
 259                 $edit_restriction = $this->mRestrictions['edit'];
 260                 $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
 261                 if ($this->mCascade && ($edit_restriction != 'protect') &&
 262                         !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
 263                         $this->mCascade = false;
 264
 265                 if ($this->mTitle->exists()) {
 266                         $ok = $this->mArticle->updateRestrictions( $this->mRestrictions, $reasonstr, $this->mCascade, $expiry );
 267                 } else {
 268                         $ok = $this->mTitle->updateTitleProtection( $this->mRestrictions['create'], $reasonstr, $expiry['create'] );
 269                 }
 270
 271                 if( !$ok ) {
 272                         throw new FatalError( "Unknown error at restriction save time." );
 273                 }
 274
 275                 if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
 276                         $this->mArticle->doWatch();
 277                 } elseif( $this->mTitle->userIsWatching() ) {
 278                         $this->mArticle->doUnwatch();
 279                 }
 280                 return $ok;
 281         }
 282
 283         /**
 284          * Build the input form
 285          *
 286          * @return $out string HTML form
 287          */
 288         function buildForm() {
 289                 global $wgUser, $wgLang;
 290
 291                 $mProtectreasonother = Xml::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' );
 292                 $mProtectreason = Xml::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' );
 293
 294                 $out = '';
 295                 if( !$this->disabled ) {
 296                         $out .= $this->buildScript();
 297                         $out .= Xml::openElement( 'form', array( 'method' => 'post',
 298                                 'action' => $this->mTitle->getLocalUrl( 'action=protect' ),
 299                                 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
 300                         $out .= Xml::hidden( 'wpEditToken',$wgUser->editToken() );
 301                 }
 302
 303                 $out .= Xml::openElement( 'fieldset' ) .
 304                         Xml::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
 305                         Xml::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
 306                         Xml::openElement( 'tbody' );
 307
 308                 foreach( $this->mRestrictions as $action => $selected ) {
 309                         /* Not all languages have V_x <-> N_x relation */
 310                         $msg = wfMsg( 'restriction-' . $action );
 311                         if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) {
 312                                 $msg = $action;
 313                         }
 314                         $label = Xml::element( 'label', array( 'for' => "mwProtect-level-$action" ), $msg );
 315                         $out .= "<tr><td><table>" .
 316                                 "<tr><th>$label</th><th></th></tr>" .
 317                                 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td><td>";
 318
 319                         $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
 320                                 wfMsgForContent( 'protect-dropdown' ),
 321                                 wfMsgForContent( 'protect-otherreason-op' ),
 322                                 $this->mReasonSelection,
 323                                 'mwProtect-reason', 4 );
 324                         $scExpiryOptions = wfMsgForContent( 'ipboptions' ); // FIXME: use its own message
 325
 326                         $showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled);
 327
 328                         $mProtectexpiry = Xml::label( wfMsg( 'protectexpiry' ), "mwProtectExpirySelection-$action" );
 329                         $mProtectother = Xml::label( wfMsg( 'protect-othertime' ), "mwProtect-$action-expires" );
 330
 331                         $expiryFormOptions = '';
 332                         if ( $this->mExistingExpiry[$action] && $this->mExistingExpiry[$action] != 'infinity' ) {
 333                                 $expiryFormOptions .=
 334                                         Xml::option(
 335                                                 wfMsg( 'protect-existing-expiry', $wgLang->timeanddate( $this->mExistingExpiry[$action] ) ),
 336                                                 'existing',
 337                                                 $this->mExpirySelection[$action] == 'existing'
 338                                         ) . "\n";
 339                         }
 340
 341                         $expiryFormOptions .= Xml::option( wfMsg( 'protect-othertime-op' ), "othertime" ) . "\n";
 342                         foreach( explode(',', $scExpiryOptions) as $option ) {
 343                                 if ( strpos($option, ":") === false ) {
 344                                         $show = $value = $option;
 345                                 } else {
 346                                         list($show, $value) = explode(":", $option);
 347                                 }
 348                                 $show = htmlspecialchars($show);
 349                                 $value = htmlspecialchars($value);
 350                                 $expiryFormOptions .= Xml::option( $show, $value, $this->mExpirySelection[$action] === $value ) . "\n";
 351                         }
 352                         # Add expiry dropdown
 353                         if( $showProtectOptions && !$this->disabled ) {
 354                                 $out .= "
 355                                         <table><tr>
 356                                                 <td class='mw-label'>
 357                                                         {$mProtectexpiry}
 358                                                 </td>
 359                                                 <td class='mw-input'>" .
 360                                                         Xml::tags( 'select',
 361                                                                 array(
 362                                                                         'id' => "mwProtectExpirySelection-$action",
 363                                                                         'name' => "wpProtectExpirySelection-$action",
 364                                                                         'onchange' => "ProtectionForm.updateExpiryList(this)",
 365                                                                         'tabindex' => '2' ) + $this->disabledAttrib,
 366                                                                 $expiryFormOptions ) .
 367                                                 "</td>
 368                                         </tr></table>";
 369                         }
 370                         # Add custom expiry field
 371                         $attribs = array( 'id' => "mwProtect-$action-expires", 'onkeyup' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
 372                         $out .= "<table><tr>
 373                                         <td class='mw-label'>" .
 374                                                 $mProtectother .
 375                                         '</td>
 376                                         <td class="mw-input">' .
 377                                                 Xml::input( "mwProtect-expiry-$action", 60, $this->mExpiry[$action], $attribs ) .
 378                                         '</td>
 379                                 </tr></table>';
 380                         $out .= "</td></tr></table></td></tr>";
 381                 }
 382
 383                 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
 384
 385                 // JavaScript will add another row with a value-chaining checkbox
 386                 if( $this->mTitle->exists() ) {
 387                         $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
 388                                 Xml::openElement( 'tbody' );
 389                         $out .= '<tr>
 390                                         <td></td>
 391                                         <td class="mw-input">' .
 392                                                 Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
 393                                                         $this->mCascade, $this->disabledAttrib ) .
 394                                         "</td>
 395                                 </tr>\n";
 396                         $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
 397                 }
 398
 399                 # Add manual and custom reason field/selects as well as submit
 400                 if( !$this->disabled ) {
 401                         $out .=  Xml::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
 402                                 Xml::openElement( 'tbody' );
 403                         $out .= "
 404                                 <tr>
 405                                         <td class='mw-label'>
 406                                                 {$mProtectreasonother}
 407                                         </td>
 408                                         <td class='mw-input'>
 409                                                 {$reasonDropDown}
 410                                         </td>
 411                                 </tr>
 412                                 <tr>
 413                                         <td class='mw-label'>
 414                                                 {$mProtectreason}
 415                                         </td>
 416                                         <td class='mw-input'>" .
 417                                                 Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text',
 418                                                         'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) .
 419                                         "</td>
 420                                 </tr>
 421                                 <tr>
 422                                         <td></td>
 423                                         <td class='mw-input'>" .
 424                                                 Xml::checkLabel( wfMsg( 'watchthis' ),
 425                                                         'mwProtectWatch', 'mwProtectWatch',
 426                                                         $this->mTitle->userIsWatching() || $wgUser->getOption( 'watchdefault' ) ) .
 427                                         "</td>
 428                                 </tr>
 429                                 <tr>
 430                                         <td></td>
 431                                         <td class='mw-submit'>" .
 432                                                 Xml::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
 433                                         "</td>
 434                                 </tr>\n";
 435                         $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
 436                 }
 437                 $out .= Xml::closeElement( 'fieldset' );
 438
 439                 if ( !$this->disabled ) {
 440                         $out .= Xml::closeElement( 'form' ) .
 441                                 $this->buildCleanupScript();
 442                 }
 443
 444                 return $out;
 445         }
 446
 447         function buildSelector( $action, $selected ) {
 448                 global $wgRestrictionLevels, $wgUser;
 449
 450                 $levels = array();
 451                 foreach( $wgRestrictionLevels as $key ) {
 452                         //don't let them choose levels above their own (aka so they can still unprotect and edit the page). but only when the form isn't disabled
 453                         if( $key == 'sysop' ) {
 454                                 //special case, rewrite sysop to protect and editprotected
 455                                 if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') && !$this->disabled )
 456                                         continue;
 457                         } else {
 458                                 if( !$wgUser->isAllowed($key) && !$this->disabled )
 459                                         continue;
 460                         }
 461                         $levels[] = $key;
 462                 }
 463
 464                 $id = 'mwProtect-level-' . $action;
 465                 $attribs = array(
 466                         'id' => $id,
 467                         'name' => $id,
 468                         'size' => count( $levels ),
 469                         'onchange' => 'ProtectionForm.updateLevels(this)',
 470                         ) + $this->disabledAttrib;
 471
 472                 $out = Xml::openElement( 'select', $attribs );
 473                 foreach( $levels as $key ) {
 474                         $out .= Xml::option( $this->getOptionLabel( $key ), $key, $key == $selected );
 475                 }
 476                 $out .= Xml::closeElement( 'select' );
 477                 return $out;
 478         }
 479
 480         /**
 481          * Prepare the label for a protection selector option
 482          *
 483          * @param string $permission Permission required
 484          * @return string
 485          */
 486         private function getOptionLabel( $permission ) {
 487                 if( $permission == '' ) {
 488                         return wfMsg( 'protect-default' );
 489                 } else {
 490                         $key = "protect-level-{$permission}";
 491                         $msg = wfMsg( $key );
 492                         if( wfEmptyMsg( $key, $msg ) )
 493                                 $msg = wfMsg( 'protect-fallback', $permission );
 494                         return $msg;
 495                 }
 496         }
 497
 498         function buildScript() {
 499                 global $wgStylePath, $wgStyleVersion;
 500                 return Xml::tags( 'script', array(
 501                         'type' => 'text/javascript',
 502                         'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion.1" ), '' );
 503         }
 504
 505         function buildCleanupScript() {
 506                 global $wgRestrictionLevels, $wgGroupPermissions;
 507                 $script = 'var wgCascadeableLevels=';
 508                 $CascadeableLevels = array();
 509                 foreach( $wgRestrictionLevels as $key ) {
 510                         if ( (isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect']) || $key == 'protect' ) {
 511                                 $CascadeableLevels[] = "'" . Xml::escapeJsString( $key ) . "'";
 512                         }
 513                 }
 514                 $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
 515                 $options = (object)array(
 516                         'tableId' => 'mw-protect-table2',
 517                         'labelText' => wfMsg( 'protect-unchain' ),
 518                         'numTypes' => count($this->mApplicableTypes),
 519                         'existingMatch' => 1 == count( array_unique( $this->mExistingExpiry ) ),
 520                 );
 521                 $encOptions = Xml::encodeJsVar( $options );
 522
 523                 $script .= "ProtectionForm.init($encOptions)";
 524                 return Xml::tags( 'script', array( 'type' => 'text/javascript' ), $script );
 525         }
 526
 527         /**
 528          * @param OutputPage $out
 529          * @access private
 530          */
 531         function showLogExtract( &$out ) {
 532                 # Show relevant lines from the protection log:
 533                 $out->addHTML( Xml::element( 'h2', null, LogPage::logName( 'protect' ) ) );
 534                 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle->getPrefixedText() );
 535         }
 536 }