SpecialLockdb.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use ErrorPageError;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\MainConfigNames;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\Status\Status;
use MediaWiki\User\User;
use Wikimedia\AtEase\AtEase;
 
class SpecialLockdb extends FormSpecialPage {
 
    public function __construct() {
        parent::__construct( 'Lockdb', 'siteadmin' );
    }
 
    public function doesWrites() {
        return false;
    }
 
    public function requiresWrite() {
        return false;
    }
 
    public function checkExecutePermissions( User $user ) {
        parent::checkExecutePermissions( $user );
        # If the lock file isn't writable, we can do sweet bugger all
        if ( !is_writable( dirname( $this->getConfig()->get( MainConfigNames::ReadOnlyFile ) ) ) ) {
            throw new ErrorPageError( 'lockdb', 'lockfilenotwritable' );
        }
        if ( file_exists( $this->getConfig()->get( MainConfigNames::ReadOnlyFile ) ) ) {
            throw new ErrorPageError( 'lockdb', 'databaselocked' );
        }
    }
 
    protected function getFormFields() {
        return [
            'Reason' => [
                'type' => 'textarea',
                'rows' => 4,
                'label-message' => 'enterlockreason',
            ],
            'Confirm' => [
                'type' => 'toggle',
                'label-message' => 'lockconfirm',
            ],
        ];
    }
 
    protected function alterForm( HTMLForm $form ) {
        $form->setWrapperLegend( false )
            ->setHeaderHtml( $this->msg( 'lockdbtext' )->parseAsBlock() )
            ->setSubmitTextMsg( 'lockbtn' );
    }
 
    public function onSubmit( array $data ) {
        if ( !$data['Confirm'] ) {
            return Status::newFatal( 'locknoconfirm' );
        }
 
        AtEase::suppressWarnings();
        $fp = fopen( $this->getConfig()->get( MainConfigNames::ReadOnlyFile ), 'w' );
        AtEase::restoreWarnings();
 
        if ( $fp === false ) {
            # This used to show a file not found error, but the likeliest reason for fopen()
            # to fail at this point is insufficient permission to write to the file...good old
            # is_writable() is plain wrong in some cases, it seems...
            return Status::newFatal( 'lockfilenotwritable' );
        }
        fwrite( $fp, $data['Reason'] );
        $timestamp = wfTimestampNow();
        $contLang = $this->getContentLanguage();
        fwrite( $fp, "\n<p>" . $this->msg( 'lockedbyandtime',
            $this->getUser()->getName(),
            $contLang->date( $timestamp, false, false ),
            $contLang->time( $timestamp, false, false )
        )->inContentLanguage()->text() . "</p>\n" );
        fclose( $fp );
 
        return Status::newGood();
    }
 
    public function onSuccess() {
        $out = $this->getOutput();
        $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
        $out->addWikiMsg( 'lockdbsuccesstext' );
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    protected function getGroupName() {
        return 'wiki';
    }
}
 
class_alias( SpecialLockdb::class, 'SpecialLockdb' );