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 $sk = $wgUser->getSkin();
123 $titleLink = $sk->makeLinkObj( $this->mTitle
);
124 $wgOut->setPageTitle( wfMsg( 'protect-title', $this->mTitle
->getPrefixedText() ) );
125 $wgOut->setSubtitle( wfMsg( 'protect-backlink', $titleLink ) );
127 # Show an appropriate message if the user isn't allowed or able to change
128 # the protection settings at this time
129 if( $this->disabled
) {
131 $wgOut->readOnlyPage();
132 } elseif( $this->mPermErrors
) {
133 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors
) );
136 $wgOut->addWikiMsg( 'protect-text', $this->mTitle
->getPrefixedText() );
139 $wgOut->addHTML( $this->buildForm() );
141 $this->showLogExtract( $wgOut );
145 global $wgRequest, $wgUser, $wgOut;
147 if( $this->disabled
) {
152 $token = $wgRequest->getVal( 'wpEditToken' );
153 if( !$wgUser->matchEditToken( $token ) ) {
154 $this->show( wfMsg( 'sessionfailure' ) );
158 if ( strlen( $this->mExpiry
) == 0 ) {
159 $this->mExpiry
= 'infinite';
162 if ( $this->mExpiry
== 'infinite' ||
$this->mExpiry
== 'indefinite' ) {
163 $expiry = Block
::infinity();
165 # Convert GNU-style date, on error returns -1 for PHP <5.1 and false for PHP >=5.1
166 $expiry = strtotime( $this->mExpiry
);
168 if ( $expiry < 0 ||
$expiry === false ) {
169 $this->show( wfMsg( 'protect_expiry_invalid' ) );
173 $expiry = wfTimestamp( TS_MW
, $expiry );
175 if ( $expiry < wfTimestampNow() ) {
176 $this->show( wfMsg( 'protect_expiry_old' ) );
182 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
183 # to a semi-protected page.
184 global $wgGroupPermissions;
186 $edit_restriction = $this->mRestrictions
['edit'];
188 if ($this->mCascade
&& ($edit_restriction != 'protect') &&
189 !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
190 $this->mCascade
= false;
192 if ($this->mTitle
->exists()) {
193 $ok = $this->mArticle
->updateRestrictions( $this->mRestrictions
, $this->mReason
, $this->mCascade
, $expiry );
195 $ok = $this->mTitle
->updateTitleProtection( $this->mRestrictions
['create'], $this->mReason
, $expiry );
199 throw new FatalError( "Unknown error at restriction save time." );
202 if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
203 $this->mArticle
->doWatch();
204 } elseif( $this->mTitle
->userIsWatching() ) {
205 $this->mArticle
->doUnwatch();
212 * Build the input form
214 * @return $out string HTML form
216 function buildForm() {
217 global $wgUser, $wgContLang;
220 if( !$this->disabled
) {
221 $out .= $this->buildScript();
222 // The submission needs to reenable the move permission selector
223 // if it's in locked mode, or some browsers won't submit the data.
224 $out .= Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $this->mTitle
->getLocalUrl( 'action=protect' ), 'id' => 'mw-Protect-Form', 'onsubmit' => 'protectEnable(true)' ) ) .
225 Xml
::hidden( 'wpEditToken',$wgUser->editToken() );
228 $out .= Xml
::openElement( 'fieldset' ) .
229 Xml
::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
230 Xml
::openElement( 'table', array( 'id' => 'mwProtectSet' ) );
231 Xml
::openElement( 'tbody' ) .
234 foreach( $this->mRestrictions
as $action => $required ) {
235 /* Not all languages have V_x <-> N_x relation */
236 $out .= Xml
::element( 'th', null, wfMsg( 'restriction-' . $action ) );
240 foreach( $this->mRestrictions
as $action => $selected ) {
242 $this->buildSelector( $action, $selected ) .
247 // JavaScript will add another row with a value-chaining checkbox
249 $out .= Xml
::closeElement( 'tbody' ) .
250 Xml
::closeElement( 'table' ) .
251 Xml
::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
252 Xml
::openElement( 'tbody' );
254 global $wgEnableCascadingProtection;
255 if( $wgEnableCascadingProtection && $this->mTitle
->exists() ) {
259 Xml
::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade', $this->mCascade
, $this->disabledAttrib
) .
264 $attribs = array( 'id' => 'expires' ) +
$this->disabledAttrib
;
265 $align = $wgContLang->isRtl() ?
'left' : 'right';
267 <td align='$align'>" .
268 Xml
::label( wfMsgExt( 'protectexpiry', array( 'parseinline' ) ), 'expires' ) .
271 Xml
::input( 'mwProtect-expiry', 60, $this->mExpiry
, $attribs ) .
275 if( !$this->disabled
) {
276 $id = 'mwProtect-reason';
278 <td align='$align'>" .
279 Xml
::label( wfMsg( 'protectcomment' ), $id ) .
282 Xml
::input( $id, 60, $this->mReason
, array( 'type' => 'text', 'id' => $id, 'maxlength' => 255 ) ) .
288 Xml
::checkLabel( wfMsg( 'watchthis' ),
289 'mwProtectWatch', 'mwProtectWatch',
290 $this->mTitle
->userIsWatching() ||
$wgUser->getOption( 'watchdefault' ) ) .
296 Xml
::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
301 $out .= Xml
::closeElement( 'tbody' ) .
302 Xml
::closeElement( 'table' ) .
303 Xml
::closeElement( 'fieldset' );
305 if ( !$this->disabled
) {
306 $out .= Xml
::closeElement( 'form' ) .
307 $this->buildCleanupScript();
313 function buildSelector( $action, $selected ) {
314 global $wgRestrictionLevels;
315 $id = 'mwProtect-level-' . $action;
319 'size' => count( $wgRestrictionLevels ),
320 'onchange' => 'protectLevelsUpdate(this)',
321 ) +
$this->disabledAttrib
;
323 $out = Xml
::openElement( 'select', $attribs );
324 foreach( $wgRestrictionLevels as $key ) {
325 $out .= Xml
::option( $this->getOptionLabel( $key ), $key, $key == $selected );
327 $out .= Xml
::closeElement( 'select' );
332 * Prepare the label for a protection selector option
334 * @param string $permission Permission required
337 private function getOptionLabel( $permission ) {
338 if( $permission == '' ) {
339 return wfMsg( 'protect-default' );
341 $key = "protect-level-{$permission}";
342 $msg = wfMsg( $key );
343 if( wfEmptyMsg( $key, $msg ) )
344 $msg = wfMsg( 'protect-fallback', $permission );
349 function buildScript() {
350 global $wgStylePath, $wgStyleVersion;
351 return '<script type="text/javascript" src="' .
352 htmlspecialchars( $wgStylePath . "/common/protect.js?$wgStyleVersion" ) .
356 function buildCleanupScript() {
357 global $wgRestrictionLevels, $wgGroupPermissions;
358 $script = 'var wgCascadeableLevels=';
359 $CascadeableLevels = array();
360 foreach( $wgRestrictionLevels as $key ) {
361 if ( (isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect']) ||
$key == 'protect' ) {
362 $CascadeableLevels[] = "'" . Xml
::escapeJsString( $key ) . "'";
365 $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
366 $script .= 'protectInitialize("mwProtectSet","' . Xml
::escapeJsString( wfMsg( 'protect-unchain' ) ) . '","' . count($this->mApplicableTypes
) . '")';
367 return '<script type="text/javascript">' . $script . '</script>';
371 * @param OutputPage $out
374 function showLogExtract( &$out ) {
375 # Show relevant lines from the protection log:
376 $out->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'protect' ) ) );
377 $logViewer = new LogViewer(
380 array( 'page' => $this->mTitle
->getPrefixedText(),
381 'type' => 'protect' ) ) ) );
382 $logViewer->showList( $out );