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 doesWrites() {
  37                 return true;
  38         }
  39
  40         public function requiresWrite() {
  41                 return false;
  42         }
  43
  44         public function checkExecutePermissions( User $user ) {
  45                 parent::checkExecutePermissions( $user );
  46                 # If the lock file isn't writable, we can do sweet bugger all
  47                 if ( !is_writable( dirname( $this->getConfig()->get( 'ReadOnlyFile' ) ) ) ) {
  48                         throw new ErrorPageError( 'lockdb', 'lockfilenotwritable' );
  49                 }
  50         }
  51
  52         protected function getFormFields() {
  53                 return [
  54                         'Reason' => [
  55                                 'type' => 'textarea',
  56                                 'rows' => 4,
  57                                 'vertical-label' => true,
  58                                 'label-message' => 'enterlockreason',
  59                         ],
  60                         'Confirm' => [
  61                                 'type' => 'toggle',
  62                                 'label-message' => 'lockconfirm',
  63                         ],
  64                 ];
  65         }
  66
  67         protected function alterForm( HTMLForm $form ) {
  68                 $form->setWrapperLegend( false );
  69                 $form->setHeaderText( $this->msg( 'lockdbtext' )->parseAsBlock() );
  70                 $form->setSubmitTextMsg( 'lockbtn' );
  71         }
  72
  73         public function onSubmit( array $data ) {
  74                 global $wgContLang;
  75
  76                 if ( !$data['Confirm'] ) {
  77                         return Status::newFatal( 'locknoconfirm' );
  78                 }
  79
  80                 MediaWiki\suppressWarnings();
  81                 $fp = fopen( $this->getConfig()->get( 'ReadOnlyFile' ), 'w' );
  82                 MediaWiki\restoreWarnings();
  83
  84                 if ( false === $fp ) {
  85                         # This used to show a file not found error, but the likeliest reason for fopen()
  86                         # to fail at this point is insufficient permission to write to the file...good old
  87                         # is_writable() is plain wrong in some cases, it seems...
  88                         return Status::newFatal( 'lockfilenotwritable' );
  89                 }
  90                 fwrite( $fp, $data['Reason'] );
  91                 $timestamp = wfTimestampNow();
  92                 fwrite( $fp, "\n<p>" . $this->msg( 'lockedbyandtime',
  93                         $this->getUser()->getName(),
  94                         $wgContLang->date( $timestamp, false, false ),
  95                         $wgContLang->time( $timestamp, false, false )
  96                 )->inContentLanguage()->text() . "</p>\n" );
  97                 fclose( $fp );
  98
  99                 return Status::newGood();
 100         }
 101
 102         public function onSuccess() {
 103                 $out = $this->getOutput();
 104                 $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
 105                 $out->addWikiMsg( 'lockdbsuccesstext' );
 106         }
 107
 108         protected function getGroupName() {
 109                 return 'wiki';
 110         }
 111 }