]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blob - includes/ProtectionForm.php
MediaWiki 1.15.4-scripts
[autoinstalls/mediawiki.git] / includes / ProtectionForm.php
1 <?php
2 /**
3  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
4  * http://www.mediawiki.org/
5  *
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.
10  *
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.
15  *
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
20  */
21
22 /**
23  * Handles the page protection UI and backend
24  */
25 class ProtectionForm {
26         /** A map of action to restriction level, from request or default */
27         var $mRestrictions = array();
28
29         /** The custom/additional protection reason */
30         var $mReason = '';
31
32         /** The reason selected from the list, blank for other/additional */
33         var $mReasonSelection = '';
34
35         /** True if the restrictions are cascading, from request or existing protection */
36         var $mCascade = false;
37
38         /** Map of action to "other" expiry time. Used in preference to mExpirySelection. */
39         var $mExpiry = array();
40
41         /** 
42          * Map of action to value selected in expiry drop-down list. 
43          * Will be set to 'othertime' whenever mExpiry is set. 
44          */
45         var $mExpirySelection = array();
46
47         /** Permissions errors for the protect action */
48         var $mPermErrors = array();
49
50         /** Types (i.e. actions) for which levels can be selected */
51         var $mApplicableTypes = array();
52
53         /** Map of action to the expiry time of the existing protection */
54         var $mExistingExpiry = array();
55
56         function __construct( Article $article ) {
57                 global $wgRequest, $wgUser;
58                 global $wgRestrictionTypes, $wgRestrictionLevels;
59                 $this->mArticle = $article;
60                 $this->mTitle = $article->mTitle;
61                 $this->mApplicableTypes = $this->mTitle->exists() ? $wgRestrictionTypes : array('create');
62
63                 $this->mCascade = $this->mTitle->areRestrictionsCascading();
64
65                 // The form will be available in read-only to show levels.
66                 $this->mPermErrors = $this->mTitle->getUserPermissionsErrors('protect',$wgUser);
67                 $this->disabled = wfReadOnly() || $this->mPermErrors != array();
68                 $this->disabledAttrib = $this->disabled
69                         ? array( 'disabled' => 'disabled' )
70                         : array();
71
72                 $this->mReason = $wgRequest->getText( 'mwProtect-reason' );
73                 $this->mReasonSelection = $wgRequest->getText( 'wpProtectReasonSelection' );
74                 $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade', $this->mCascade );
75
76                 foreach( $this->mApplicableTypes as $action ) {
77                         // Fixme: this form currently requires individual selections,
78                         // but the db allows multiples separated by commas.
79                         $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
80
81                         if ( !$this->mRestrictions[$action] ) {
82                                 // No existing expiry
83                                 $existingExpiry = '';
84                         } else {
85                                 $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
86                         }
87                         $this->mExistingExpiry[$action] = $existingExpiry;
88
89                         $requestExpiry = $wgRequest->getText( "mwProtect-expiry-$action" );
90                         $requestExpirySelection = $wgRequest->getVal( "wpProtectExpirySelection-$action" );
91
92                         if ( $requestExpiry ) {
93                                 // Custom expiry takes precedence
94                                 $this->mExpiry[$action] = $requestExpiry;
95                                 $this->mExpirySelection[$action] = 'othertime';
96                         } elseif ( $requestExpirySelection ) {
97                                 // Expiry selected from list
98                                 $this->mExpiry[$action] = '';
99                                 $this->mExpirySelection[$action] = $requestExpirySelection;
100                         } elseif ( $existingExpiry == 'infinity' ) {
101                                 // Existing expiry is infinite, use "infinite" in drop-down
102                                 $this->mExpiry[$action] = '';
103                                 $this->mExpirySelection[$action] = 'infinite';
104                         } elseif ( $existingExpiry ) {
105                                 // Use existing expiry in its own list item
106                                 $this->mExpiry[$action] = '';
107                                 $this->mExpirySelection[$action] = $existingExpiry;
108                         } else {
109                                 // Final default: infinite
110                                 $this->mExpiry[$action] = '';
111                                 $this->mExpirySelection[$action] = 'infinite';
112                         }
113
114                         $val = $wgRequest->getVal( "mwProtect-level-$action" );
115                         if( isset( $val ) && in_array( $val, $wgRestrictionLevels ) ) {
116                                 // Prevent users from setting levels that they cannot later unset
117                                 if( $val == 'sysop' ) {
118                                         // Special case, rewrite sysop to either protect and editprotected
119                                         if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') )
120                                                 continue;
121                                 } else {
122                                         if( !$wgUser->isAllowed($val) )
123                                                 continue;
124                                 }
125                                 $this->mRestrictions[$action] = $val;
126                         }
127                 }
128         }
129
130         /** 
131          * Get the expiry time for a given action, by combining the relevant inputs.
132          * Returns a 14-char timestamp or "infinity", or false if the input was invalid
133          */
134         function getExpiry( $action ) {
135                 if ( $this->mExpirySelection[$action] == 'existing' ) {
136                         return $this->mExistingExpiry[$action];
137                 } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
138                         $value = $this->mExpiry[$action];
139                 } else {
140                         $value = $this->mExpirySelection[$action];
141                 }
142                 if ( $value == 'infinite' || $value == 'indefinite' || $value == 'infinity' ) {
143                         $time = Block::infinity();
144                 } else {
145                         $unix = strtotime( $value );
146
147                         if ( !$unix || $unix === -1 ) {
148                                 return false;
149                         }
150
151                         // Fixme: non-qualified absolute times are not in users specified timezone
152                         // and there isn't notice about it in the ui
153                         $time = wfTimestamp( TS_MW, $unix );
154                 }
155                 return $time;
156         }
157
158         function execute() {
159                 global $wgRequest, $wgOut;
160                 if( $wgRequest->wasPosted() ) {
161                         if( $this->save() ) {
162                                 $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
163                                 $wgOut->redirect( $this->mTitle->getFullUrl( $q ) );
164                         }
165                 } else {
166                         $this->show();
167                 }
168         }
169
170         function show( $err = null ) {
171                 global $wgOut, $wgUser;
172
173                 $wgOut->setRobotPolicy( 'noindex,nofollow' );
174
175                 if( is_null( $this->mTitle ) ||
176                         $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
177                         $wgOut->showFatalError( wfMsg( 'badarticleerror' ) );
178                         return;
179                 }
180
181                 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
182
183                 if ( "" != $err ) {
184                         $wgOut->setSubtitle( wfMsgHtml( 'formerror' ) );
185                         $wgOut->addHTML( "<p class='error'>{$err}</p>\n" );
186                 }
187
188                 if ( $cascadeSources && count($cascadeSources) > 0 ) {
189                         $titles = '';
190
191                         foreach ( $cascadeSources as $title ) {
192                                 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
193                         }
194
195                         $wgOut->wrapWikiMsg( "$1\n$titles", array( 'protect-cascadeon', count($cascadeSources) ) );
196                 }
197
198                 $sk = $wgUser->getSkin();
199                 $titleLink = $sk->makeLinkObj( $this->mTitle );
200                 $wgOut->setPageTitle( wfMsg( 'protect-title', $this->mTitle->getPrefixedText() ) );
201                 $wgOut->setSubtitle( wfMsg( 'protect-backlink', $titleLink ) );
202
203                 # Show an appropriate message if the user isn't allowed or able to change
204                 # the protection settings at this time
205                 if( $this->disabled ) {
206                         if( wfReadOnly() ) {
207                                 $wgOut->readOnlyPage();
208                         } elseif( $this->mPermErrors ) {
209                                 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $this->mPermErrors ) );
210                         }
211                 } else {
212                         $wgOut->addWikiMsg( 'protect-text', $this->mTitle->getPrefixedText() );
213                 }
214
215                 $wgOut->addHTML( $this->buildForm() );
216
217                 $this->showLogExtract( $wgOut );
218         }
219
220         function save() {
221                 global $wgRequest, $wgUser, $wgOut;
222                 # Permission check!
223                 if ( $this->disabled ) {
224                         $this->show();
225                         return false;
226                 }
227
228                 $token = $wgRequest->getVal( 'wpEditToken' );
229                 if ( !$wgUser->matchEditToken( $token ) ) {
230                         $this->show( wfMsg( 'sessionfailure' ) );
231                         return false;
232                 }
233                 
234                 # Create reason string. Use list and/or custom string.
235                 $reasonstr = $this->mReasonSelection;
236                 if ( $reasonstr != 'other' && $this->mReason != '' ) {
237                         // Entry from drop down menu + additional comment
238                         $reasonstr .= wfMsgForContent( 'colon-separator' ) . $this->mReason;
239                 } elseif ( $reasonstr == 'other' ) {
240                         $reasonstr = $this->mReason;
241                 }
242                 $expiry = array();
243                 foreach( $this->mApplicableTypes as $action ) {
244                         $expiry[$action] = $this->getExpiry( $action );
245                         if( empty($this->mRestrictions[$action]) )
246                                 continue; // unprotected
247                         if ( !$expiry[$action] ) {
248                                 $this->show( wfMsg( 'protect_expiry_invalid' ) );
249                                 return false;
250                         }
251                         if ( $expiry[$action] < wfTimestampNow() ) {
252                                 $this->show( wfMsg( 'protect_expiry_old' ) );
253                                 return false;
254                         }
255                 }
256
257                 # They shouldn't be able to do this anyway, but just to make sure, ensure that cascading restrictions aren't being applied
258                 #  to a semi-protected page.
259                 global $wgGroupPermissions;
260
261                 $edit_restriction = $this->mRestrictions['edit'];
262                 $this->mCascade = $wgRequest->getBool( 'mwProtect-cascade' );
263                 if ($this->mCascade && ($edit_restriction != 'protect') &&
264                         !(isset($wgGroupPermissions[$edit_restriction]['protect']) && $wgGroupPermissions[$edit_restriction]['protect'] ) )
265                         $this->mCascade = false;
266
267                 if ($this->mTitle->exists()) {
268                         $ok = $this->mArticle->updateRestrictions( $this->mRestrictions, $reasonstr, $this->mCascade, $expiry );
269                 } else {
270                         $ok = $this->mTitle->updateTitleProtection( $this->mRestrictions['create'], $reasonstr, $expiry['create'] );
271                 }
272
273                 if( !$ok ) {
274                         throw new FatalError( "Unknown error at restriction save time." );
275                 }
276
277                 if( $wgRequest->getCheck( 'mwProtectWatch' ) ) {
278                         $this->mArticle->doWatch();
279                 } elseif( $this->mTitle->userIsWatching() ) {
280                         $this->mArticle->doUnwatch();
281                 }
282                 return $ok;
283         }
284
285         /**
286          * Build the input form
287          *
288          * @return $out string HTML form
289          */
290         function buildForm() {
291                 global $wgUser, $wgLang;
292
293                 $mProtectreasonother = Xml::label( wfMsg( 'protectcomment' ), 'wpProtectReasonSelection' );
294                 $mProtectreason = Xml::label( wfMsg( 'protect-otherreason' ), 'mwProtect-reason' );
295
296                 $out = '';
297                 if( !$this->disabled ) {
298                         $out .= $this->buildScript();
299                         $out .= Xml::openElement( 'form', array( 'method' => 'post', 
300                                 'action' => $this->mTitle->getLocalUrl( 'action=protect' ), 
301                                 'id' => 'mw-Protect-Form', 'onsubmit' => 'ProtectionForm.enableUnchainedInputs(true)' ) );
302                         $out .= Xml::hidden( 'wpEditToken',$wgUser->editToken() );
303                 }
304
305                 $out .= Xml::openElement( 'fieldset' ) .
306                         Xml::element( 'legend', null, wfMsg( 'protect-legend' ) ) .
307                         Xml::openElement( 'table', array( 'id' => 'mwProtectSet' ) ) .
308                         Xml::openElement( 'tbody' );
309
310                 foreach( $this->mRestrictions as $action => $selected ) {
311                         /* Not all languages have V_x <-> N_x relation */
312                         $msg = wfMsg( 'restriction-' . $action );
313                         if( wfEmptyMsg( 'restriction-' . $action, $msg ) ) {
314                                 $msg = $action;
315                         }
316                         $out .= "<tr><td>".
317                         Xml::openElement( 'fieldset' ) .
318                         Xml::element( 'legend', null, $msg ) .
319                         Xml::openElement( 'table', array( 'id' => "mw-protect-table-$action" ) ) .
320                                 "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
321
322                         $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
323                                 wfMsgForContent( 'protect-dropdown' ),
324                                 wfMsgForContent( 'protect-otherreason-op' ), 
325                                 $this->mReasonSelection,
326                                 'mwProtect-reason', 4 );
327                         $scExpiryOptions = wfMsgForContent( 'protect-expiry-options' );
328
329                         $showProtectOptions = ($scExpiryOptions !== '-' && !$this->disabled);
330
331                         $mProtectexpiry = Xml::label( wfMsg( 'protectexpiry' ), "mwProtectExpirySelection-$action" );
332                         $mProtectother = Xml::label( wfMsg( 'protect-othertime' ), "mwProtect-$action-expires" );
333
334                         $expiryFormOptions = '';
335                         if ( $this->mExistingExpiry[$action] && $this->mExistingExpiry[$action] != 'infinity' ) {
336                                 $timestamp = $wgLang->timeanddate( $this->mExistingExpiry[$action] );
337                                 $d = $wgLang->date( $this->mExistingExpiry[$action] );
338                                 $t = $wgLang->time( $this->mExistingExpiry[$action] );
339                                 $expiryFormOptions .= 
340                                         Xml::option( 
341                                                 wfMsg( 'protect-existing-expiry', $timestamp, $d, $t ),
342                                                 'existing',
343                                                 $this->mExpirySelection[$action] == 'existing'
344                                         ) . "\n";
345                         }
346                         
347                         $expiryFormOptions .= Xml::option( wfMsg( 'protect-othertime-op' ), "othertime" ) . "\n";
348                         foreach( explode(',', $scExpiryOptions) as $option ) {
349                                 if ( strpos($option, ":") === false ) {
350                                         $show = $value = $option;
351                                 } else {
352                                         list($show, $value) = explode(":", $option);
353                                 }
354                                 $show = htmlspecialchars($show);
355                                 $value = htmlspecialchars($value);
356                                 $expiryFormOptions .= Xml::option( $show, $value, $this->mExpirySelection[$action] === $value ) . "\n";
357                         }
358                         # Add expiry dropdown
359                         if( $showProtectOptions && !$this->disabled ) {
360                                 $out .= "
361                                         <table><tr>
362                                                 <td class='mw-label'>
363                                                         {$mProtectexpiry}
364                                                 </td>
365                                                 <td class='mw-input'>" .
366                                                         Xml::tags( 'select',
367                                                                 array(
368                                                                         'id' => "mwProtectExpirySelection-$action",
369                                                                         'name' => "wpProtectExpirySelection-$action",
370                                                                         'onchange' => "ProtectionForm.updateExpiryList(this)",
371                                                                         'tabindex' => '2' ) + $this->disabledAttrib,
372                                                                 $expiryFormOptions ) .
373                                                 "</td>
374                                         </tr></table>";
375                         }
376                         # Add custom expiry field
377                         $attribs = array( 'id' => "mwProtect-$action-expires",
378                                 'onkeyup' => 'ProtectionForm.updateExpiry(this)' ) + $this->disabledAttrib;
379                         $out .= "<table><tr>
380                                         <td class='mw-label'>" .
381                                                 $mProtectother .
382                                         '</td>
383                                         <td class="mw-input">' .
384                                                 Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
385                                         '</td>
386                                 </tr></table>';
387                         $out .= "</td></tr>" .
388                         Xml::closeElement( 'table' ) .
389                         Xml::closeElement( 'fieldset' ) .
390                         "</td></tr>";
391                 }
392
393                 $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
394
395                 // JavaScript will add another row with a value-chaining checkbox
396                 if( $this->mTitle->exists() ) {
397                         $out .= Xml::openElement( 'table', array( 'id' => 'mw-protect-table2' ) ) .
398                                 Xml::openElement( 'tbody' );
399                         $out .= '<tr>
400                                         <td></td>
401                                         <td class="mw-input">' .
402                                                 Xml::checkLabel( wfMsg( 'protect-cascade' ), 'mwProtect-cascade', 'mwProtect-cascade', 
403                                                         $this->mCascade, $this->disabledAttrib ) .
404                                         "</td>
405                                 </tr>\n";
406                         $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
407                 }
408                 
409                 # Add manual and custom reason field/selects as well as submit
410                 if( !$this->disabled ) {
411                         $out .=  Xml::openElement( 'table', array( 'id' => 'mw-protect-table3' ) ) .
412                                 Xml::openElement( 'tbody' );
413                         $out .= "
414                                 <tr>
415                                         <td class='mw-label'>
416                                                 {$mProtectreasonother}
417                                         </td>
418                                         <td class='mw-input'>
419                                                 {$reasonDropDown}
420                                         </td>
421                                 </tr>
422                                 <tr>
423                                         <td class='mw-label'>
424                                                 {$mProtectreason}
425                                         </td>
426                                         <td class='mw-input'>" .
427                                                 Xml::input( 'mwProtect-reason', 60, $this->mReason, array( 'type' => 'text', 
428                                                         'id' => 'mwProtect-reason', 'maxlength' => 255 ) ) .
429                                         "</td>
430                                 </tr>
431                                 <tr>
432                                         <td></td>
433                                         <td class='mw-input'>" .
434                                                 Xml::checkLabel( wfMsg( 'watchthis' ),
435                                                         'mwProtectWatch', 'mwProtectWatch',
436                                                         $this->mTitle->userIsWatching() || $wgUser->getOption( 'watchdefault' ) ) .
437                                         "</td>
438                                 </tr>
439                                 <tr>
440                                         <td></td>
441                                         <td class='mw-submit'>" .
442                                                 Xml::submitButton( wfMsg( 'confirm' ), array( 'id' => 'mw-Protect-submit' ) ) .
443                                         "</td>
444                                 </tr>\n";
445                         $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
446                 }
447                 $out .= Xml::closeElement( 'fieldset' );
448
449                 if ( $wgUser->isAllowed( 'editinterface' ) ) {
450                         $linkTitle = Title::makeTitleSafe( NS_MEDIAWIKI, 'protect-dropdown' );
451                         $link = $wgUser->getSkin()->Link ( $linkTitle, wfMsgHtml( 'protect-edit-reasonlist' ) );
452                         $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
453                 }
454
455                 if ( !$this->disabled ) {
456                         $out .= Xml::closeElement( 'form' ) .
457                                 $this->buildCleanupScript();
458                 }
459
460                 return $out;
461         }
462
463         function buildSelector( $action, $selected ) {
464                 global $wgRestrictionLevels, $wgUser;
465
466                 $levels = array();
467                 foreach( $wgRestrictionLevels as $key ) {
468                         //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
469                         if( $key == 'sysop' ) {
470                                 //special case, rewrite sysop to protect and editprotected
471                                 if( !$wgUser->isAllowed('protect') && !$wgUser->isAllowed('editprotected') && !$this->disabled )
472                                         continue;
473                         } else {
474                                 if( !$wgUser->isAllowed($key) && !$this->disabled )
475                                         continue;
476                         }
477                         $levels[] = $key;
478                 }
479
480                 $id = 'mwProtect-level-' . $action;
481                 $attribs = array(
482                         'id' => $id,
483                         'name' => $id,
484                         'size' => count( $levels ),
485                         'onchange' => 'ProtectionForm.updateLevels(this)',
486                         ) + $this->disabledAttrib;
487
488                 $out = Xml::openElement( 'select', $attribs );
489                 foreach( $levels as $key ) {
490                         $out .= Xml::option( $this->getOptionLabel( $key ), $key, $key == $selected );
491                 }
492                 $out .= Xml::closeElement( 'select' );
493                 return $out;
494         }
495
496         /**
497          * Prepare the label for a protection selector option
498          *
499          * @param string $permission Permission required
500          * @return string
501          */
502         private function getOptionLabel( $permission ) {
503                 if( $permission == '' ) {
504                         return wfMsg( 'protect-default' );
505                 } else {
506                         $key = "protect-level-{$permission}";
507                         $msg = wfMsg( $key );
508                         if( wfEmptyMsg( $key, $msg ) )
509                                 $msg = wfMsg( 'protect-fallback', $permission );
510                         return $msg;
511                 }
512         }
513
514         function buildScript() {
515                 global $wgStylePath, $wgStyleVersion;
516                 return Xml::tags( 'script', array(
517                         'type' => 'text/javascript',
518                         'src' => $wgStylePath . "/common/protect.js?$wgStyleVersion.1" ), '' );
519         }
520
521         function buildCleanupScript() {
522                 global $wgRestrictionLevels, $wgGroupPermissions;
523                 $script = 'var wgCascadeableLevels=';
524                 $CascadeableLevels = array();
525                 foreach( $wgRestrictionLevels as $key ) {
526                         if ( (isset($wgGroupPermissions[$key]['protect']) && $wgGroupPermissions[$key]['protect']) || $key == 'protect' ) {
527                                 $CascadeableLevels[] = "'" . Xml::escapeJsString( $key ) . "'";
528                         }
529                 }
530                 $script .= "[" . implode(',',$CascadeableLevels) . "];\n";
531                 $options = (object)array(
532                         'tableId' => 'mw-protect-table-move',
533                         'labelText' => wfMsg( 'protect-unchain' ),
534                         'numTypes' => count($this->mApplicableTypes),
535                         'existingMatch' => 1 == count( array_unique( $this->mExistingExpiry ) ),
536                 );
537                 $encOptions = Xml::encodeJsVar( $options );
538
539                 $script .= "ProtectionForm.init($encOptions)";
540                 return Xml::tags( 'script', array( 'type' => 'text/javascript' ), $script );
541         }
542
543         /**
544          * @param OutputPage $out
545          * @access private
546          */
547         function showLogExtract( &$out ) {
548                 # Show relevant lines from the protection log:
549                 $out->addHTML( Xml::element( 'h2', null, LogPage::logName( 'protect' ) ) );
550                 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle->getPrefixedText() );
551         }
552 }