3 * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
4 * http://www.mediawiki.org/
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.
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.
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
23 * @todo document, briefly.
24 * @addtogroup SpecialPage
26 class ProtectionForm
{
27 var $mRestrictions = array();
29 var $mCascade = false;
31 var $mPermErrors = array();
32 var $mApplicableTypes = array();
34 function __construct( &$article ) {
35 global $wgRequest, $wgUser;
36 global $wgRestrictionTypes, $wgRestrictionLevels;
37 $this->mArticle
=& $article;
38 $this->mTitle
=& $article->mTitle
;
39 $this->mApplicableTypes
= $this->mTitle
->exists() ?
$wgRestrictionTypes : array('create');
42 $this->mTitle
->loadRestrictions();
44 foreach( $this->mApplicableTypes
as $action ) {
45 // Fixme: this form currently requires individual selections,
46 // but the db allows multiples separated by commas.
47 $this->mRestrictions
[$action] = implode( '', $this->mTitle
->getRestrictions( $action ) );
50 $this->mCascade
= $this->mTitle
->areRestrictionsCascading();
52 if ( $this->mTitle
->mRestrictionsExpiry
== 'infinity' ) {
53 $this->mExpiry
= 'infinite';
54 } else if ( strlen($this->mTitle
->mRestrictionsExpiry
) == 0 ) {
57 $this->mExpiry
= wfTimestamp( TS_RFC2822
, $this->mTitle
->mRestrictionsExpiry
);
61 // The form will be available in read-only to show levels.
62 $this->disabled
= wfReadOnly() ||
($this->mPermErrors
= $this->mTitle
->getUserPermissionsErrors('protect',$wgUser)) != array();
63 $this->disabledAttrib
= $this->disabled
64 ?
array( 'disabled' => 'disabled' )
67 if( $wgRequest->wasPosted() ) {
68 $this->mReason
= $wgRequest->getText( 'mwProtect-reason' );
69 $this->mCascade
= $wgRequest->getBool( 'mwProtect-cascade' );
70 $this->mExpiry
= $wgRequest->getText( 'mwProtect-expiry' );
72 foreach( $this->mApplicableTypes
as $action ) {
73 $val = $wgRequest->getVal( "mwProtect-level-$action" );
74 if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
75 $this->mRestrictions
[$action] = $val;
82 global $wgRequest, $wgOut;
83 if( $wgRequest->wasPosted() ) {
85 $article = new Article( $this->mTitle
);
86 $q = $article->isRedirect() ?
'redirect=no' : '';
87 $wgOut->redirect( $this->mTitle
->getFullUrl( $q ) );
94 function show( $err = null ) {
95 global $wgOut, $wgUser;
97 $wgOut->setRobotpolicy( 'noindex,nofollow' );
99 if( is_null( $this->mTitle
) ||
100 $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
101 $wgOut->showFatalError( wfMsg( 'badarticleerror' ) );
105 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
108 $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
109 $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
112 if ( $cascadeSources && count($cascadeSources) > 0 ) {
115 foreach ( $cascadeSources as $title ) {
116 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
119 $wgOut->wrapWikiMsg( "$1\n$titles", array( 'protect-cascadeon', count($cascadeSources) ) );
122 $wgOut->setPageTitle( wfMsg( 'confirmprotect' ) );
123 $wgOut->setSubtitle( wfMsg( 'protectsub', $this->mTitle
->getPrefixedText() ) );
125 # Show an appropriate message if the user isn't allowed or able to change
126 # the protection settings at this time
127 if( $this->disabled
) {
129 $wgOut->readOnlyPage();
130 } elseif( $this->mPermErrors
) {
131 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors
) );
134 $wgOut->addWikiMsg( 'protect-text', $this->mTitle
->getPrefixedText() );
137 $wgOut->addHTML( $this->buildForm() );
139 $this->showLogExtract( $wgOut );
143 global $wgRequest, $wgUser, $wgOut;
145 if( $this->disabled
) {
150 $token = $wgRequest->getVal( 'wpEditToken' );
151 if( !$wgUser->matchEditToken( $token ) ) {
152 $this->show( wfMsg( 'sessionfailure' ) );
156 if ( strlen( $this->mExpiry
) == 0 ) {
157 $this->mExpiry
= 'infinite';
160 if ( $this->mExpiry
== 'infinite' ||
$this->mExpiry
== 'indefinite' ) {
161 $expiry = Block
::infinity();
163 # Convert GNU-style date, on error returns -1 for PHP <5.1 and false for PHP >=5.1
164 $expiry = strtotime( $this->mExpiry
);
166 if ( $expiry < 0 ||
$expiry === false ) {
167 $this->show( wfMsg( 'protect_expiry_invalid' ) );
171 $expiry = wfTimestamp( TS_MW
, $expiry );
173 if ( $expiry < wfTimestampNow() ) {
174 $this->show( wfMsg( 'protect_expiry_old' ) );
180 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
181 # to a semi-protected page.
182 global $wgGroupPermissions;
184 $edit_restriction = $this->mRestrictions
['edit'];
186 if ($this->mCascade
&& ($edit_restriction != 'protect') &&
187 !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
188 $this->mCascade
= false;
190 if ($this->mTitle
->exists()) {
191 $ok = $this->mArticle
->updateRestrictions( $this->mRestrictions
, $this->mReason
, $this->mCascade
, $expiry );
193 $ok = $this->mTitle
->updateTitleProtection( $this->mRestrictions
['create'], $this->mReason
, $expiry );
197 throw new FatalError( "Unknown error at restriction save time." );
200 if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
201 $this->mArticle
->doWatch();
202 } elseif( $this->mTitle
->userIsWatching() ) {
203 $this->mArticle
->doUnwatch();
209 function buildForm() {
213 if( !$this->disabled
) {
214 $out .= $this->buildScript();
215 // The submission needs to reenable the move permission selector
216 // if it's in locked mode, or some browsers won't submit the data.
217 $out .= wfOpenElement( 'form', array(
218 'id' => 'mw-Protect-Form',
219 'action' => $this->mTitle
->getLocalUrl( 'action=protect' ),
221 'onsubmit' => 'protectEnable(true)' ) );
223 $out .= wfElement( 'input', array(
225 'name' => 'wpEditToken',
226 'value' => $wgUser->editToken() ) );
229 $out .= "<table id='mwProtectSet'>";
233 foreach( $this->mRestrictions
as $action => $required ) {
234 /* Not all languages have V_x <-> N_x relation */
235 $out .= "<th>" . wfMsgHtml( 'restriction-' . $action ) . "</th>\n";
239 foreach( $this->mRestrictions
as $action => $selected ) {
241 $out .= $this->buildSelector( $action, $selected );
246 // JavaScript will add another row with a value-chaining checkbox
248 $out .= "</tbody>\n";
249 $out .= "</table>\n";
254 global $wgEnableCascadingProtection;
255 if( $wgEnableCascadingProtection && $this->mTitle
->exists() )
256 $out .= '<tr><td></td><td>' . $this->buildCascadeInput() . "</td></tr>\n";
258 $out .= $this->buildExpiryInput();
260 if( !$this->disabled
) {
261 $out .= "<tr><td>" . $this->buildReasonInput() . "</td></tr>\n";
262 $out .= "<tr><td></td><td>" . $this->buildWatchInput() . "</td></tr>\n";
263 $out .= "<tr><td></td><td>" . $this->buildSubmit() . "</td></tr>\n";
266 $out .= "</tbody>\n";
267 $out .= "</table>\n";
269 if ( !$this->disabled
) {
271 $out .= $this->buildCleanupScript();
277 function buildSelector( $action, $selected ) {
278 global $wgRestrictionLevels;
279 $id = 'mwProtect-level-' . $action;
283 'size' => count( $wgRestrictionLevels ),
284 'onchange' => 'protectLevelsUpdate(this)',
285 ) +
$this->disabledAttrib
;
287 $out = wfOpenElement( 'select', $attribs );
288 foreach( $wgRestrictionLevels as $key ) {
289 $out .= Xml
::option( $this->getOptionLabel( $key ), $key, $key == $selected );
291 $out .= "</select>\n";
296 * Prepare the label for a protection selector option
298 * @param string $permission Permission required
301 private function getOptionLabel( $permission ) {
302 if( $permission == '' ) {
303 return wfMsg( 'protect-default' );
305 $key = "protect-level-{$permission}";
306 $msg = wfMsg( $key );
307 if( wfEmptyMsg( $key, $msg ) )
308 $msg = wfMsg( 'protect-fallback', $permission );
313 function buildReasonInput() {
314 $id = 'mwProtect-reason';
315 return wfElement( 'label', array(
318 wfMsg( 'protectcomment' ) ) .
320 wfElement( 'input', array(
325 'value' => $this->mReason
) );
328 function buildCascadeInput() {
329 $id = 'mwProtect-cascade';
330 $ci = wfCheckLabel( wfMsg( 'protect-cascade' ), $id, $id, $this->mCascade
, $this->disabledAttrib
);
334 function buildExpiryInput() {
335 $attribs = array( 'id' => 'expires' ) +
$this->disabledAttrib
;
337 . '<td><label for="expires">' . wfMsgExt( 'protectexpiry', array( 'parseinline' ) ) . '</label></td>'
338 . '<td>' . Xml
::input( 'mwProtect-expiry', 60, $this->mExpiry
, $attribs ) . '</td>'
342 function buildWatchInput() {
344 return Xml
::checkLabel(
345 wfMsg( 'watchthis' ),
348 $this->mTitle
->userIsWatching() ||
$wgUser->getOption( 'watchdefault' )
352 function buildSubmit() {
353 return wfElement( 'input', array(
354 'id' => 'mw-Protect-submit',
356 'value' => wfMsg( 'confirm' ) ) );
359 function buildScript() {
360 global $wgStylePath, $wgStyleVersion;
361 return '<script type="text/javascript" src="' .
362 htmlspecialchars( $wgStylePath . "/common/protect.js?$wgStyleVersion" ) .
366 function buildCleanupScript() {
367 global $wgRestrictionLevels, $wgGroupPermissions;
368 $script = 'var wgCascadeableLevels=';
369 $CascadeableLevels = array();
370 foreach( $wgRestrictionLevels as $key ) {
371 if ( (isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect']) ||
$key == 'protect' ) {
372 $CascadeableLevels[]="'" . wfEscapeJsString($key) . "'";
375 $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
376 $script .= 'protectInitialize("mwProtectSet","' . wfEscapeJsString( wfMsg( 'protect-unchain' ) ) . '","' . count($this->mApplicableTypes
) . '")';
377 return '<script type="text/javascript">' . $script . '</script>';
381 * @param OutputPage $out
384 function showLogExtract( &$out ) {
385 # Show relevant lines from the protection log:
386 $out->addHTML( "<h2>" . htmlspecialchars( LogPage
::logName( 'protect' ) ) . "</h2>\n" );
387 $logViewer = new LogViewer(
390 array( 'page' => $this->mTitle
->getPrefixedText(),
391 'type' => 'protect' ) ) ) );
392 $logViewer->showList( $out );