X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FProtectionForm.php;h=cac302558aaf8a240bbc96a210e8ec6a948e198d;hb=bd756e66843bd1f346ebfed21d11996fde92ba62;hp=3d88420730b7923f826bed1a486012753345d4fb;hpb=c255da09f072168ad82f913a56743af4c22bb579;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ProtectionForm.php b/includes/ProtectionForm.php index 3d88420730..cac302558a 100644 --- a/includes/ProtectionForm.php +++ b/includes/ProtectionForm.php @@ -1,6 +1,8 @@ + * Page protection + * + * Copyright © 2005 Brion Vibber * http://www.mediawiki.org/ * * This program is free software; you can redistribute it and/or modify @@ -17,6 +19,8 @@ * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ /** @@ -53,29 +57,42 @@ class ProtectionForm { /** Map of action to the expiry time of the existing protection */ var $mExistingExpiry = array(); - function __construct( Article $article ) { - global $wgRequest, $wgUser; - global $wgRestrictionTypes, $wgRestrictionLevels; + function __construct( Page $article ) { + global $wgUser; + // Set instance variables. $this->mArticle = $article; - $this->mTitle = $article->mTitle; - $this->mApplicableTypes = $this->mTitle->exists() ? $wgRestrictionTypes : array('create'); - - $this->mCascade = $this->mTitle->areRestrictionsCascading(); - - // The form will be available in read-only to show levels. + $this->mTitle = $article->getTitle(); + $this->mApplicableTypes = $this->mTitle->getRestrictionTypes(); + + // Check if the form should be disabled. + // If it is, the form will be available in read-only to show levels. $this->mPermErrors = $this->mTitle->getUserPermissionsErrors('protect',$wgUser); $this->disabled = wfReadOnly() || $this->mPermErrors != array(); $this->disabledAttrib = $this->disabled ? array( 'disabled' => 'disabled' ) : array(); + + $this->loadData(); + } + + /** + * Loads the current state of protection into the object. + */ + function loadData() { + global $wgRequest, $wgUser; + global $wgRestrictionLevels; + + $this->mCascade = $this->mTitle->areRestrictionsCascading(); $this->mReason = $wgRequest->getText( 'mwProtect-reason' ); $this->mReasonSelection = $wgRequest->getText( 'wpProtectReasonSelection' ); $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade ); foreach( $this->mApplicableTypes as $action ) { - // Fixme: this form currently requires individual selections, + // @todo FIXME: This form currently requires individual selections, // but the db allows multiples separated by commas. + + // Pull the actual restriction from the DB $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) ); if ( !$this->mRestrictions[$action] ) { @@ -116,7 +133,7 @@ class ProtectionForm { // Prevent users from setting levels that they cannot later unset if( $val == 'sysop' ) { // Special case, rewrite sysop to either protect and editprotected - if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') ) + if( !$wgUser->isAllowedAny( 'protect', 'editprotected' ) ) continue; } else { if( !$wgUser->isAllowed($val) ) @@ -129,7 +146,10 @@ class ProtectionForm { /** * Get the expiry time for a given action, by combining the relevant inputs. - * Returns a 14-char timestamp or "infinity", or false if the input was invalid + * + * @param $action string + * + * @return string 14-char timestamp or "infinity", or false if the input was invalid */ function getExpiry( $action ) { if ( $this->mExpirySelection[$action] == 'existing' ) { @@ -140,7 +160,7 @@ class ProtectionForm { $value = $this->mExpirySelection[$action]; } if ( $value == 'infinite' || $value == 'indefinite' || $value == 'infinity' ) { - $time = Block::infinity(); + $time = wfGetDB( DB_SLAVE )->getInfinity(); } else { $unix = strtotime( $value ); @@ -148,13 +168,16 @@ class ProtectionForm { return false; } - // Fixme: non-qualified absolute times are not in users specified timezone + // @todo FIXME: Non-qualified absolute times are not in users specified timezone // and there isn't notice about it in the ui $time = wfTimestamp( TS_MW, $unix ); } return $time; } + /** + * Main entry point for action=protect and action=unprotect + */ function execute() { global $wgRequest, $wgOut; if( $wgRequest->wasPosted() ) { @@ -167,6 +190,11 @@ class ProtectionForm { } } + /** + * Show the input form with optional error message + * + * @param $err String: error message or null if there's no error + */ function show( $err = null ) { global $wgOut, $wgUser; @@ -180,7 +208,7 @@ class ProtectionForm { list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources(); - if ( "" != $err ) { + if ( $err != "" ) { $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) ); $wgOut->addHTML( "

{$err}

\n" ); } @@ -206,10 +234,11 @@ class ProtectionForm { if( wfReadOnly() ) { $wgOut->readOnlyPage(); } elseif( $this->mPermErrors ) { - $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors ) ); + $wgOut->showPermissionsErrorPage( $this->mPermErrors ); } } else { - $wgOut->addWikiMsg( 'protect-text', $this->mTitle->getPrefixedText() ); + $wgOut->addWikiMsg( 'protect-text', + wfEscapeWikiText( $this->mTitle->getPrefixedText() ) ); } $wgOut->addHTML( $this->buildForm() ); @@ -217,8 +246,14 @@ class ProtectionForm { $this->showLogExtract( $wgOut ); } + /** + * Save submitted protection form + * + * @return Boolean: success + */ function save() { global $wgRequest, $wgUser; + # Permission check! if ( $this->disabled ) { $this->show(); @@ -274,10 +309,20 @@ class ProtectionForm { throw new FatalError( "Unknown error at restriction save time." ); } - if( $wgRequest->getCheck( 'mwProtectWatch' ) ) { - $this->mArticle->doWatch(); - } elseif( $this->mTitle->userIsWatching() ) { - $this->mArticle->doUnwatch(); + $errorMsg = ''; + # Give extensions a change to handle added form items + if( !wfRunHooks( 'ProtectionForm::save', array($this->mArticle,&$errorMsg) ) ) { + throw new FatalError( "Unknown hook error at restriction save time." ); + } + if( $errorMsg != '' ) { + $this->show( $errorMsg ); + return false; + } + + if ( $wgRequest->getCheck( 'mwProtectWatch' ) && $wgUser->isLoggedIn() ) { + WatchAction::doWatch( $this->mTitle, $wgUser ); + } elseif ( $this->mTitle->userIsWatching() ) { + WatchAction::doUnwatch( $this->mTitle, $wgUser ); } return $ok; } @@ -285,21 +330,21 @@ class ProtectionForm { /** * Build the input form * - * @return $out string HTML form + * @return String: HTML form */ function buildForm() { - global $wgUser, $wgLang; + global $wgUser, $wgLang, $wgOut; $mProtectreasonother = Xml::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' ); $mProtectreason = Xml::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' ); $out = ''; if( !$this->disabled ) { - $out .= $this->buildScript(); + $wgOut->addModules( 'mediawiki.legacy.protect' ); $out .= Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->mTitle->getLocalUrl( 'action=protect' ), 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) ); - $out .= Xml::hidden( 'wpEditToken',$wgUser->editToken() ); + $out .= Html::hidden( 'wpEditToken',$wgUser->editToken() ); } $out .= Xml::openElement( 'fieldset' ) . @@ -309,13 +354,10 @@ class ProtectionForm { foreach( $this->mRestrictions as $action => $selected ) { /* Not all languages have V_x <-> N_x relation */ - $msg = wfMsg( 'restriction-' . $action ); - if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) { - $msg = $action; - } + $msg = wfMessage( 'restriction-' . $action ); $out .= "". Xml::openElement( 'fieldset' ) . - Xml::element( 'legend', null, $msg ) . + Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) . Xml::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) . "" . $this->buildSelector( $action, $selected ) . ""; @@ -333,9 +375,9 @@ class ProtectionForm { $expiryFormOptions = ''; if ( $this->mExistingExpiry[$action] && $this->mExistingExpiry[$action] != 'infinity' ) { - $timestamp = $wgLang->timeanddate( $this->mExistingExpiry[$action] ); - $d = $wgLang->date( $this->mExistingExpiry[$action] ); - $t = $wgLang->time( $this->mExistingExpiry[$action] ); + $timestamp = $wgLang->timeanddate( $this->mExistingExpiry[$action], true ); + $d = $wgLang->date( $this->mExistingExpiry[$action], true ); + $t = $wgLang->time( $this->mExistingExpiry[$action], true ); $expiryFormOptions .= Xml::option( wfMsg( 'protect-existing-expiry', $timestamp, $d, $t ), @@ -390,6 +432,8 @@ class ProtectionForm { Xml::closeElement( 'fieldset' ) . ""; } + # Give extensions a chance to add items to the form + wfRunHooks( 'ProtectionForm::buildForm', array($this->mArticle,&$out) ); $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' ); @@ -426,9 +470,15 @@ class ProtectionForm { " . Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text', - 'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) . + 'id' => 'mwProtect-reason', 'maxlength' => 180 ) ) . + // Limited maxlength as the database trims at 255 bytes and other texts + // chosen by dropdown menus on this page are also included in this database field. + // The byte limit of 180 bytes is enforced in javascript " - + "; + # Disallow watching is user is not logged in + if( $wgUser->isLoggedIn() ) { + $out .= " " . @@ -436,7 +486,9 @@ class ProtectionForm { 'mwProtectWatch', 'mwProtectWatch', $this->mTitle->userIsWatching() || $wgUser->getOption( 'watchdefault' ) ) . " - + "; + } + $out .= " " . @@ -459,13 +511,20 @@ class ProtectionForm { } if ( !$this->disabled ) { - $out .= Xml::closeElement( 'form' ) . - $this->buildCleanupScript(); + $out .= Xml::closeElement( 'form' ); + $wgOut->addScript( $this->buildCleanupScript() ); } return $out; } + /** + * Build protection level selector + * + * @param $action String: action to protect + * @param $selected String: current protection level + * @return String: HTML fragment + */ function buildSelector( $action, $selected ) { global $wgRestrictionLevels, $wgUser; @@ -474,7 +533,7 @@ class ProtectionForm { //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 if( $key == 'sysop' ) { //special case, rewrite sysop to protect and editprotected - if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') && !$this->disabled ) + if( !$wgUser->isAllowedAny( 'protect', 'editprotected' ) && !$this->disabled ) continue; } else { if( !$wgUser->isAllowed($key) && !$this->disabled ) @@ -502,28 +561,21 @@ class ProtectionForm { /** * Prepare the label for a protection selector option * - * @param string $permission Permission required - * @return string + * @param $permission String: permission required + * @return String */ private function getOptionLabel( $permission ) { if( $permission == '' ) { return wfMsg( 'protect-default' ); } else { - $key = "protect-level-{$permission}"; - $msg = wfMsg( $key ); - if( wfEmptyMsg( $key, $msg ) ) - $msg = wfMsg( 'protect-fallback', $permission ); - return $msg; + $msg = wfMessage( "protect-level-{$permission}" ); + if( $msg->exists() ) { + return $msg->text(); + } + return wfMsg( 'protect-fallback', $permission ); } } - - function buildScript() { - global $wgStylePath, $wgStyleVersion; - return Xml::tags( 'script', array( - 'type' => 'text/javascript', - 'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion.1" ), '' ); - } - + function buildCleanupScript() { global $wgRestrictionLevels, $wgGroupPermissions; $script = 'var wgCascadeableLevels='; @@ -535,24 +587,28 @@ class ProtectionForm { } $script .= "[" . implode(',',$CascadeableLevels) . "];\n"; $options = (object)array( - 'tableId' => 'mw-protect-table-move', - 'labelText' => wfMsg( 'protect-unchain' ), + 'tableId' => 'mwProtectSet', + 'labelText' => wfMsg( 'protect-unchain-permissions' ), 'numTypes' => count($this->mApplicableTypes), 'existingMatch' => 1 == count( array_unique( $this->mExistingExpiry ) ), ); $encOptions = Xml::encodeJsVar( $options ); $script .= "ProtectionForm.init($encOptions)"; - return Xml::tags( 'script', array( 'type' => 'text/javascript' ), $script ); + return Html::inlineScript( "if ( window.mediaWiki ) { $script }" ); } /** - * @param OutputPage $out + * Show protection long extracts for this page + * + * @param $out OutputPage * @access private */ function showLogExtract( &$out ) { # Show relevant lines from the protection log: $out->addHTML( Xml::element( 'h2', null, LogPage::logName( 'protect' ) ) ); LogEventsList::showLogExtract( $out, 'protect', $this->mTitle->getPrefixedText() ); + # Let extensions add other relevant log extracts + wfRunHooks( 'ProtectionForm::showLogExtract', array($this->mArticle,$out) ); } }