includes/specials/SpecialLockdb.php

   1 <?php
   2 /**
   3  * Implements Special:Lockdb
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * A form to make the database readonly (eg for maintenance purposes).
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialLockdb extends FormSpecialPage {
  30         protected $reason = '';
  31
  32         public function __construct() {
  33                 parent::__construct( 'Lockdb', 'siteadmin' );
  34         }
  35
  36         public function requiresWrite() {
  37                 return false;
  38         }
  39
  40         public function checkExecutePermissions( User $user ) {
  41                 global $wgReadOnlyFile;
  42
  43                 parent::checkExecutePermissions( $user );
  44                 # If the lock file isn't writable, we can do sweet bugger all
  45                 if ( !is_writable( dirname( $wgReadOnlyFile ) ) ) {
  46                         throw new ErrorPageError( 'lockdb', 'lockfilenotwritable' );
  47                 }
  48         }
  49
  50         protected function getFormFields() {
  51                 return array(
  52                         'Reason' => array(
  53                                 'type' => 'textarea',
  54                                 'rows' => 4,
  55                                 'vertical-label' => true,
  56                                 'label-message' => 'enterlockreason',
  57                         ),
  58                         'Confirm' => array(
  59                                 'type' => 'toggle',
  60                                 'label-message' => 'lockconfirm',
  61                         ),
  62                 );
  63         }
  64
  65         protected function alterForm( HTMLForm $form ) {
  66                 $form->setWrapperLegend( false );
  67                 $form->setHeaderText( $this->msg( 'lockdbtext' )->parseAsBlock() );
  68                 $form->setSubmitTextMsg( 'lockbtn' );
  69         }
  70
  71         public function onSubmit( array $data ) {
  72                 global $wgContLang, $wgReadOnlyFile;
  73
  74                 if ( !$data['Confirm'] ) {
  75                         return Status::newFatal( 'locknoconfirm' );
  76                 }
  77
  78                 wfSuppressWarnings();
  79                 $fp = fopen( $wgReadOnlyFile, 'w' );
  80                 wfRestoreWarnings();
  81
  82                 if ( false === $fp ) {
  83                         # This used to show a file not found error, but the likeliest reason for fopen()
  84                         # to fail at this point is insufficient permission to write to the file...good old
  85                         # is_writable() is plain wrong in some cases, it seems...
  86                         return Status::newFatal( 'lockfilenotwritable' );
  87                 }
  88                 fwrite( $fp, $data['Reason'] );
  89                 $timestamp = wfTimestampNow();
  90                 fwrite( $fp, "\n<p>" . $this->msg( 'lockedbyandtime',
  91                         $this->getUser()->getName(),
  92                         $wgContLang->date( $timestamp, false, false ),
  93                         $wgContLang->time( $timestamp, false, false )
  94                 )->inContentLanguage()->text() . "</p>\n" );
  95                 fclose( $fp );
  96
  97                 return Status::newGood();
  98         }
  99
 100         public function onSuccess() {
 101                 $out = $this->getOutput();
 102                 $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
 103                 $out->addWikiMsg( 'lockdbsuccesstext' );
 104         }
 105
 106         protected function getGroupName() {
 107                 return 'wiki';
 108         }
 109 }