summaryrefslogtreecommitdiff
path: root/includes/ProtectionForm.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/ProtectionForm.php')
-rw-r--r--includes/ProtectionForm.php409
1 files changed, 280 insertions, 129 deletions
diff --git a/includes/ProtectionForm.php b/includes/ProtectionForm.php
index e7787822..372edfcd 100644
--- a/includes/ProtectionForm.php
+++ b/includes/ProtectionForm.php
@@ -20,79 +20,146 @@
*/
/**
- * @todo document, briefly.
+ * Handles the page protection UI and backend
*/
class ProtectionForm {
+ /** A map of action to restriction level, from request or default */
var $mRestrictions = array();
+
+ /** The custom/additional protection reason */
var $mReason = '';
+
+ /** The reason selected from the list, blank for other/additional */
+ var $mReasonSelection = '';
+
+ /** True if the restrictions are cascading, from request or existing protection */
var $mCascade = false;
- var $mExpiry = null;
+
+ /** 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.
+ */
+ var $mExpirySelection = array();
+
+ /** Permissions errors for the protect action */
var $mPermErrors = array();
+
+ /** Types (i.e. actions) for which levels can be selected */
var $mApplicableTypes = array();
- function __construct( &$article ) {
+ /** Map of action to the expiry time of the existing protection */
+ var $mExistingExpiry = array();
+
+ function __construct( Article $article ) {
global $wgRequest, $wgUser;
global $wgRestrictionTypes, $wgRestrictionLevels;
- $this->mArticle =& $article;
- $this->mTitle =& $article->mTitle;
+ $this->mArticle = $article;
+ $this->mTitle = $article->mTitle;
$this->mApplicableTypes = $this->mTitle->exists() ? $wgRestrictionTypes : array('create');
- if( $this->mTitle ) {
- $this->mTitle->loadRestrictions();
+ $this->mCascade = $this->mTitle->areRestrictionsCascading();
- foreach( $this->mApplicableTypes as $action ) {
- // Fixme: this form currently requires individual selections,
- // but the db allows multiples separated by commas.
- $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
- }
+ // 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->mReason = $wgRequest->getText( 'mwProtect-reason' );
+ $this->mReasonSelection = $wgRequest->getText( 'wpProtectReasonSelection' );
+ $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade );
- $this->mCascade = $this->mTitle->areRestrictionsCascading();
+ foreach( $this->mApplicableTypes as $action ) {
+ // Fixme: this form currently requires individual selections,
+ // but the db allows multiples separated by commas.
+ $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
- if ( $this->mTitle->mRestrictionsExpiry == 'infinity' ) {
- $this->mExpiry = 'infinite';
- } else if ( strlen($this->mTitle->mRestrictionsExpiry) == 0 ) {
- $this->mExpiry = '';
+ if ( !$this->mRestrictions[$action] ) {
+ // No existing expiry
+ $existingExpiry = '';
} else {
- // FIXME: this format is not user friendly
- $this->mExpiry = wfTimestamp( TS_ISO_8601, $this->mTitle->mRestrictionsExpiry );
+ $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
+ }
+ $this->mExistingExpiry[$action] = $existingExpiry;
+
+ $requestExpiry = $wgRequest->getText( "mwProtect-expiry-$action" );
+ $requestExpirySelection = $wgRequest->getVal( "wpProtectExpirySelection-$action" );
+
+ if ( $requestExpiry ) {
+ // Custom expiry takes precedence
+ $this->mExpiry[$action] = $requestExpiry;
+ $this->mExpirySelection[$action] = 'othertime';
+ } elseif ( $requestExpirySelection ) {
+ // Expiry selected from list
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = $requestExpirySelection;
+ } elseif ( $existingExpiry == 'infinity' ) {
+ // Existing expiry is infinite, use "infinite" in drop-down
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = 'infinite';
+ } elseif ( $existingExpiry ) {
+ // Use existing expiry in its own list item
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = $existingExpiry;
+ } else {
+ // Final default: infinite
+ $this->mExpiry[$action] = '';
+ $this->mExpirySelection[$action] = 'infinite';
+ }
+
+ $val = $wgRequest->getVal( "mwProtect-level-$action" );
+ if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
+ // 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') )
+ continue;
+ } else {
+ if( !$wgUser->isAllowed($val) )
+ continue;
+ }
+ $this->mRestrictions[$action] = $val;
}
}
+ }
- // The form will be available in read-only to show levels.
- $this->disabled = wfReadOnly() || ($this->mPermErrors = $this->mTitle->getUserPermissionsErrors('protect',$wgUser)) != array();
- $this->disabledAttrib = $this->disabled
- ? array( 'disabled' => 'disabled' )
- : array();
+ /**
+ * 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
+ */
+ function getExpiry( $action ) {
+ if ( $this->mExpirySelection[$action] == 'existing' ) {
+ return $this->mExistingExpiry[$action];
+ } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
+ $value = $this->mExpiry[$action];
+ } else {
+ $value = $this->mExpirySelection[$action];
+ }
+ if ( $value == 'infinite' || $value == 'indefinite' || $value == 'infinity' ) {
+ $time = Block::infinity();
+ } else {
+ $unix = strtotime( $value );
- if( $wgRequest->wasPosted() ) {
- $this->mReason = $wgRequest->getText( 'mwProtect-reason' );
- $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
- $this->mExpiry = $wgRequest->getText( 'mwProtect-expiry' );
-
- foreach( $this->mApplicableTypes as $action ) {
- $val = $wgRequest->getVal( "mwProtect-level-$action" );
- if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
- //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') )
- continue;
- } else {
- if( !$wgUser->isAllowed($val) )
- continue;
- }
- $this->mRestrictions[$action] = $val;
- }
+ if ( !$unix || $unix === -1 ) {
+ return false;
}
+
+ // 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;
}
function execute() {
global $wgRequest, $wgOut;
if( $wgRequest->wasPosted() ) {
if( $this->save() ) {
- $article = new Article( $this->mTitle );
- $q = $article->isRedirect() ? 'redirect=no' : '';
+ $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
$wgOut->redirect( $this->mTitle->getFullUrl( $q ) );
}
} else {
@@ -103,7 +170,7 @@ class ProtectionForm {
function show( $err = null ) {
global $wgOut, $wgUser;
- $wgOut->setRobotpolicy( 'noindex,nofollow' );
+ $wgOut->setRobotPolicy( 'noindex,nofollow' );
if( is_null( $this->mTitle ) ||
$this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
@@ -152,42 +219,39 @@ class ProtectionForm {
function save() {
global $wgRequest, $wgUser, $wgOut;
-
- if( $this->disabled ) {
+ # Permission check!
+ if ( $this->disabled ) {
$this->show();
return false;
}
$token = $wgRequest->getVal( 'wpEditToken' );
- if( !$wgUser->matchEditToken( $token ) ) {
+ if ( !$wgUser->matchEditToken( $token ) ) {
$this->show( wfMsg( 'sessionfailure' ) );
return false;
}
-
- if ( strlen( $this->mExpiry ) == 0 ) {
- $this->mExpiry = 'infinite';
+
+ # 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;
+ } elseif ( $reasonstr == 'other' ) {
+ $reasonstr = $this->mReason;
}
-
- if ( $this->mExpiry == 'infinite' || $this->mExpiry == 'indefinite' ) {
- $expiry = Block::infinity();
- } else {
- # Convert GNU-style date, on error returns -1 for PHP <5.1 and false for PHP >=5.1
- $expiry = strtotime( $this->mExpiry );
-
- if ( $expiry < 0 || $expiry === false ) {
+ $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;
}
-
- // Fixme: non-qualified absolute times are not in users specified timezone
- // and there isn't notice about it in the ui
- $expiry = wfTimestamp( TS_MW, $expiry );
-
- if ( $expiry < wfTimestampNow() ) {
+ if ( $expiry[$action] < wfTimestampNow() ) {
$this->show( wfMsg( 'protect_expiry_old' ) );
return false;
}
-
}
# They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
@@ -195,15 +259,15 @@ class ProtectionForm {
global $wgGroupPermissions;
$edit_restriction = $this->mRestrictions['edit'];
-
+ $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
if ($this->mCascade && ($edit_restriction != 'protect') &&
!(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
$this->mCascade = false;
if ($this->mTitle->exists()) {
- $ok = $this->mArticle->updateRestrictions( $this->mRestrictions, $this->mReason, $this->mCascade, $expiry );
+ $ok = $this->mArticle->updateRestrictions( $this->mRestrictions, $reasonstr, $this->mCascade, $expiry );
} else {
- $ok = $this->mTitle->updateTitleProtection( $this->mRestrictions['create'], $this->mReason, $expiry );
+ $ok = $this->mTitle->updateTitleProtection( $this->mRestrictions['create'], $reasonstr, $expiry['create'] );
}
if( !$ok ) {
@@ -215,7 +279,6 @@ class ProtectionForm {
} elseif( $this->mTitle->userIsWatching() ) {
$this->mArticle->doUnwatch();
}
-
return $ok;
}
@@ -225,73 +288,143 @@ class ProtectionForm {
* @return $out string HTML form
*/
function buildForm() {
- global $wgUser;
+ global $wgUser, $wgLang;
+
+ $mProtectreasonother = Xml::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' );
+ $mProtectreason = Xml::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' );
$out = '';
if( !$this->disabled ) {
$out .= $this->buildScript();
- // The submission needs to reenable the move permission selector
- // if it's in locked mode, or some browsers won't submit the data.
- $out .= Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->mTitle->getLocalUrl( 'action=protect' ), 'id' => 'mw-Protect-Form', 'onsubmit' => 'protectEnable(true)' ) ) .
- Xml::hidden( 'wpEditToken',$wgUser->editToken() );
+ $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 .= Xml::openElement( 'fieldset' ) .
Xml::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
Xml::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
- Xml::openElement( 'tbody' ) .
- "<tr>\n";
+ Xml::openElement( 'tbody' );
- foreach( $this->mRestrictions as $action => $required ) {
- /* Not all languages have V_x <-> N_x relation */
- $label = Xml::element( 'label',
- array( 'for' => "mwProtect-level-$action" ),
- wfMsg( 'restriction-' . $action ) );
- $out .= "<th>$label</th>";
- }
- $out .= "</tr>
- <tr>\n";
foreach( $this->mRestrictions as $action => $selected ) {
- $out .= "<td>" .
- $this->buildSelector( $action, $selected ) .
- "</td>";
+ /* Not all languages have V_x <-> N_x relation */
+ $msg = wfMsg( 'restriction-' . $action );
+ if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) {
+ $msg = $action;
+ }
+ $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' ),
+ $this->mReasonSelection,
+ 'mwProtect-reason', 4 );
+ $scExpiryOptions = wfMsgForContent( 'protect-expiry-options' );
+
+ $showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled);
+
+ $mProtectexpiry = Xml::label( wfMsg( 'protectexpiry' ), "mwProtectExpirySelection-$action" );
+ $mProtectother = Xml::label( wfMsg( 'protect-othertime' ), "mwProtect-$action-expires" );
+
+ $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] );
+ $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 ) {
+ $show = $value = $option;
+ } else {
+ list($show, $value) = explode(":", $option);
+ }
+ $show = htmlspecialchars($show);
+ $value = htmlspecialchars($value);
+ $expiryFormOptions .= Xml::option( $show, $value, $this->mExpirySelection[$action] === $value ) . "\n";
+ }
+ # Add expiry dropdown
+ if( $showProtectOptions && !$this->disabled ) {
+ $out .= "
+ <table><tr>
+ <td class='mw-label'>
+ {$mProtectexpiry}
+ </td>
+ <td class='mw-input'>" .
+ Xml::tags( 'select',
+ array(
+ 'id' => "mwProtectExpirySelection-$action",
+ 'name' => "wpProtectExpirySelection-$action",
+ 'onchange' => "ProtectionForm.updateExpiryList(this)",
+ 'tabindex' => '2' ) + $this->disabledAttrib,
+ $expiryFormOptions ) .
+ "</td>
+ </tr></table>";
+ }
+ # Add custom expiry field
+ $attribs = array( 'id' => "mwProtect-$action-expires", 'onkeyup' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
+ $out .= "<table><tr>
+ <td class='mw-label'>" .
+ $mProtectother .
+ '</td>
+ <td class="mw-input">' .
+ Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
+ '</td>
+ </tr></table>';
+ $out .= "</td></tr>" .
+ Xml::closeElement( 'table' ) .
+ Xml::closeElement( 'fieldset' ) .
+ "</td></tr>";
}
- $out .= "</tr>\n";
-
- // JavaScript will add another row with a value-chaining checkbox
- $out .= Xml::closeElement( 'tbody' ) .
- Xml::closeElement( 'table' ) .
- Xml::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
- Xml::openElement( 'tbody' );
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
+ // JavaScript will add another row with a value-chaining checkbox
if( $this->mTitle->exists() ) {
+ $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
+ Xml::openElement( 'tbody' );
$out .= '<tr>
<td></td>
<td class="mw-input">' .
- Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade', $this->mCascade, $this->disabledAttrib ) .
+ Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade',
+ $this->mCascade, $this->disabledAttrib ) .
"</td>
</tr>\n";
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
}
-
- $attribs = array( 'id' => 'expires' ) + $this->disabledAttrib;
- $out .= "<tr>
- <td class='mw-label'>" .
- Xml::label( wfMsgExt( 'protectexpiry', array( 'parseinline' ) ), 'expires' ) .
- '</td>
- <td class="mw-input">' .
- Xml::input( 'mwProtect-expiry', 60, $this->mExpiry, $attribs ) .
- '</td>
- </tr>';
-
+
+ # Add manual and custom reason field/selects as well as submit
if( !$this->disabled ) {
- $id = 'mwProtect-reason';
- $out .= "<tr>
- <td class='mw-label'>" .
- Xml::label( wfMsg( 'protectcomment' ), $id ) .
- '</td>
- <td class="mw-input">' .
- Xml::input( $id, 60, $this->mReason, array( 'type' => 'text', 'id' => $id, 'maxlength' => 255 ) ) .
+ $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
+ Xml::openElement( 'tbody' );
+ $out .= "
+ <tr>
+ <td class='mw-label'>
+ {$mProtectreasonother}
+ </td>
+ <td class='mw-input'>
+ {$reasonDropDown}
+ </td>
+ </tr>
+ <tr>
+ <td class='mw-label'>
+ {$mProtectreason}
+ </td>
+ <td class='mw-input'>" .
+ Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text',
+ 'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) .
"</td>
</tr>
<tr>
@@ -308,11 +441,15 @@ class ProtectionForm {
Xml::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
"</td>
</tr>\n";
+ $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
}
+ $out .= Xml::closeElement( 'fieldset' );
- $out .= Xml::closeElement( 'tbody' ) .
- Xml::closeElement( 'table' ) .
- Xml::closeElement( 'fieldset' );
+ if ( $wgUser->isAllowed( 'editinterface' ) ) {
+ $linkTitle = Title::makeTitleSafe( NS_MEDIAWIKI, 'protect-dropdown' );
+ $link = $wgUser->getSkin()->Link ( $linkTitle, wfMsgHtml( 'protect-edit-reasonlist' ) );
+ $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
+ }
if ( !$this->disabled ) {
$out .= Xml::closeElement( 'form' ) .
@@ -324,15 +461,8 @@ class ProtectionForm {
function buildSelector( $action, $selected ) {
global $wgRestrictionLevels, $wgUser;
- $id = 'mwProtect-level-' . $action;
- $attribs = array(
- 'id' => $id,
- 'name' => $id,
- 'size' => count( $wgRestrictionLevels ),
- 'onchange' => 'protectLevelsUpdate(this)',
- ) + $this->disabledAttrib;
- $out = Xml::openElement( 'select', $attribs );
+ $levels = array();
foreach( $wgRestrictionLevels as $key ) {
//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' ) {
@@ -343,6 +473,19 @@ class ProtectionForm {
if( !$wgUser->isAllowed($key) && !$this->disabled )
continue;
}
+ $levels[] = $key;
+ }
+
+ $id = 'mwProtect-level-' . $action;
+ $attribs = array(
+ 'id' => $id,
+ 'name' => $id,
+ 'size' => count( $levels ),
+ 'onchange' => 'ProtectionForm.updateLevels(this)',
+ ) + $this->disabledAttrib;
+
+ $out = Xml::openElement( 'select', $attribs );
+ foreach( $levels as $key ) {
$out .= Xml::option( $this->getOptionLabel( $key ), $key, $key == $selected );
}
$out .= Xml::closeElement( 'select' );
@@ -371,7 +514,7 @@ class ProtectionForm {
global $wgStylePath, $wgStyleVersion;
return Xml::tags( 'script', array(
'type' => 'text/javascript',
- 'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion" ), '' );
+ 'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion.1" ), '' );
}
function buildCleanupScript() {
@@ -384,7 +527,15 @@ class ProtectionForm {
}
}
$script .= "[" . implode(',',$CascadeableLevels) . "];\n";
- $script .= 'protectInitialize("mwProtectSet","' . Xml::escapeJsString( wfMsg( 'protect-unchain' ) ) . '","' . count($this->mApplicableTypes) . '")';
+ $options = (object)array(
+ 'tableId' => 'mw-protect-table-move',
+ 'labelText' => wfMsg( 'protect-unchain' ),
+ '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 );
}