<?php
/**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * Page protection
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
* http://www.mediawiki.org/
*
* This program is free software; you can redistribute it and/or modify
* 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
*/
/**
- * @todo document, briefly.
+ * Handles the page protection UI and backend
*/
class ProtectionForm {
/** A map of action to restriction level, from request or default */
/** Map of action to "other" expiry time. Used in preference to mExpirySelection. */
var $mExpiry = array();
- /**
- * Map of action to value selected in expiry drop-down list.
- * Will be set to 'othertime' whenever mExpiry is set.
+ /**
+ * Map of action to value selected in expiry drop-down list.
+ * Will be set to 'othertime' whenever mExpiry is set.
*/
var $mExpirySelection = array();
var $mExistingExpiry = array();
function __construct( Article $article ) {
- global $wgRequest, $wgUser;
- global $wgRestrictionTypes, $wgRestrictionLevels;
+ 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->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' );
foreach( $this->mApplicableTypes as $action ) {
// 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] ) {
// Expiry selected from list
$this->mExpiry[$action] = '';
$this->mExpirySelection[$action] = $requestExpirySelection;
- } elseif ( $existingExpiry == 'infinite' ) {
+ } elseif ( $existingExpiry == 'infinity' ) {
// Existing expiry is infinite, use "infinite" in drop-down
$this->mExpiry[$action] = '';
$this->mExpirySelection[$action] = 'infinite';
}
}
- /**
+ /**
* 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
+ *
+ * @return 14-char timestamp or "infinity", or false if the input was invalid
*/
function getExpiry( $action ) {
if ( $this->mExpirySelection[$action] == 'existing' ) {
return $time;
}
+ /**
+ * Main entry point for action=protect and action=unprotect
+ */
function execute() {
global $wgRequest, $wgOut;
if( $wgRequest->wasPosted() ) {
}
}
+ /**
+ * 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;
list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
- if ( "" != $err ) {
+ if ( $err != "" ) {
$wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
$wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
}
$titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
}
- $wgOut->wrapWikiMsg( "$1\n$titles", array( 'protect-cascadeon', count($cascadeSources) ) );
+ $wgOut->wrapWikiMsg( "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>", array( 'protect-cascadeon', count($cascadeSources) ) );
}
$sk = $wgUser->getSkin();
- $titleLink = $sk->makeLinkObj( $this->mTitle );
+ $titleLink = $sk->link( $this->mTitle );
$wgOut->setPageTitle( wfMsg( 'protect-title', $this->mTitle->getPrefixedText() ) );
$wgOut->setSubtitle( wfMsg( 'protect-backlink', $titleLink ) );
$this->showLogExtract( $wgOut );
}
+ /**
+ * Save submitted protection form
+ *
+ * @return Boolean: success
+ */
function save() {
- global $wgRequest, $wgUser, $wgOut;
+ global $wgRequest, $wgUser;
+
# Permission check!
if ( $this->disabled ) {
$this->show();
$this->show( wfMsg( 'sessionfailure' ) );
return false;
}
-
+
# Create reason string. Use list and/or custom string.
$reasonstr = $this->mReasonSelection;
if ( $reasonstr != 'other' && $this->mReason != '' ) {
// Entry from drop down menu + additional comment
- $reasonstr .= ': ' . $this->mReason;
+ $reasonstr .= wfMsgForContent( 'colon-separator' ) . $this->mReason;
} elseif ( $reasonstr == 'other' ) {
$reasonstr = $this->mReason;
}
$expiry = array();
foreach( $this->mApplicableTypes as $action ) {
$expiry[$action] = $this->getExpiry( $action );
+ if( empty($this->mRestrictions[$action]) )
+ continue; // unprotected
if ( !$expiry[$action] ) {
$this->show( wfMsg( 'protect_expiry_invalid' ) );
return false;
# to a semi-protected page.
global $wgGroupPermissions;
- $edit_restriction = $this->mRestrictions['edit'];
+ $edit_restriction = isset( $this->mRestrictions['edit'] ) ? $this->mRestrictions['edit'] : '';
$this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
if ($this->mCascade && ($edit_restriction != 'protect') &&
!(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
throw new FatalError( "Unknown error at restriction save time." );
}
- if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
+ $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() ) {
$this->mArticle->doWatch();
} elseif( $this->mTitle->userIsWatching() ) {
$this->mArticle->doUnwatch();
/**
* 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();
- $out .= Xml::openElement( 'form', array( 'method' => 'post',
- 'action' => $this->mTitle->getLocalUrl( 'action=protect' ),
+ $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' ) .
if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) {
$msg = $action;
}
- $label = Xml::element( 'label', array( 'for' => "mwProtect-level-$action" ), $msg );
- $out .= "<tr><td><table>" .
- "<tr><th>$label</th><th></th></tr>" .
- "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td><td>";
+ $out .= "<tr><td>".
+ Xml::openElement( 'fieldset' ) .
+ Xml::element( 'legend', null, $msg ) .
+ Xml::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
+ "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
$reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
wfMsgForContent( 'protect-dropdown' ),
- wfMsgForContent( 'protect-otherreason-op' ),
+ wfMsgForContent( 'protect-otherreason-op' ),
$this->mReasonSelection,
'mwProtect-reason', 4 );
- $scExpiryOptions = wfMsgForContent( 'ipboptions' ); // FIXME: use its own message
+ $scExpiryOptions = wfMsgForContent( 'protect-expiry-options' );
$showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled);
$expiryFormOptions = '';
if ( $this->mExistingExpiry[$action] && $this->mExistingExpiry[$action] != 'infinity' ) {
- $expiryFormOptions .=
- Xml::option(
- wfMsg( 'protect-existing-expiry', $wgLang->timeanddate( $this->mExistingExpiry[$action] ) ),
+ $timestamp = $wgLang->timeanddate( $this->mExistingExpiry[$action] );
+ $d = $wgLang->date( $this->mExistingExpiry[$action] );
+ $t = $wgLang->time( $this->mExistingExpiry[$action] );
+ $expiryFormOptions .=
+ Xml::option(
+ wfMsg( 'protect-existing-expiry', $timestamp, $d, $t ),
'existing',
$this->mExpirySelection[$action] == 'existing'
) . "\n";
}
-
+
$expiryFormOptions .= Xml::option( wfMsg( 'protect-othertime-op' ), "othertime" ) . "\n";
foreach( explode(',', $scExpiryOptions) as $option ) {
if ( strpos($option, ":") === false ) {
</tr></table>";
}
# Add custom expiry field
- $attribs = array( 'id' => "mwProtect-$action-expires", 'onkeyup' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
+ $attribs = array( 'id' => "mwProtect-$action-expires",
+ 'onkeyup' => 'ProtectionForm.updateExpiry(this)',
+ 'onchange' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
$out .= "<table><tr>
<td class='mw-label'>" .
$mProtectother .
'</td>
<td class="mw-input">' .
- Xml::input( "mwProtect-expiry-$action", 60, $this->mExpiry[$action], $attribs ) .
+ Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
'</td>
</tr></table>';
- $out .= "</td></tr></table></td></tr>";
+ $out .= "</td></tr>" .
+ Xml::closeElement( 'table' ) .
+ Xml::closeElement( 'fieldset' ) .
+ "</td></tr>";
}
+ # Give extensions a chance to add items to the form
+ wfRunHooks( 'ProtectionForm::buildForm', array($this->mArticle,&$out) );
$out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
$out .= '<tr>
<td></td>
<td class="mw-input">' .
- Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
+ Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
$this->mCascade, $this->disabledAttrib ) .
"</td>
</tr>\n";
$out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
}
-
+
# Add manual and custom reason field/selects as well as submit
if( !$this->disabled ) {
$out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
{$mProtectreason}
</td>
<td class='mw-input'>" .
- Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text',
+ Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text',
'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) .
"</td>
- </tr>
+ </tr>";
+ # Disallow watching is user is not logged in
+ if( $wgUser->isLoggedIn() ) {
+ $out .= "
<tr>
<td></td>
<td class='mw-input'>" .
'mwProtectWatch', 'mwProtectWatch',
$this->mTitle->userIsWatching() || $wgUser->getOption( 'watchdefault' ) ) .
"</td>
- </tr>
+ </tr>";
+ }
+ $out .= "
<tr>
<td></td>
<td class='mw-submit'>" .
}
$out .= Xml::closeElement( 'fieldset' );
+ if ( $wgUser->isAllowed( 'editinterface' ) ) {
+ $title = Title::makeTitle( NS_MEDIAWIKI, 'Protect-dropdown' );
+ $link = $wgUser->getSkin()->link(
+ $title,
+ wfMsgHtml( 'protect-edit-reasonlist' ),
+ array(),
+ array( 'action' => 'edit' )
+ );
+ $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
+ }
+
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;
/**
* 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 $msg;
}
}
-
- 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=';
}
$script .= "[" . implode(',',$CascadeableLevels) . "];\n";
$options = (object)array(
- 'tableId' => 'mw-protect-table2',
- '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) );
}
}