SpecialUnlockdb.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Exception\ErrorPageError;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\MainConfigNames;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\Status\Status;
use MediaWiki\User\User;
 
class SpecialUnlockdb extends FormSpecialPage {
 
    public function __construct() {
        parent::__construct( 'Unlockdb', '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 ( !file_exists( $this->getConfig()->get( MainConfigNames::ReadOnlyFile ) ) ) {
            throw new ErrorPageError( 'lockdb', 'databasenotlocked' );
        }
    }
 
    protected function getFormFields() {
        return [
            'Confirm' => [
                'type' => 'toggle',
                'label-message' => 'unlockconfirm',
            ],
        ];
    }
 
    protected function alterForm( HTMLForm $form ) {
        $form->setWrapperLegend( false )
            ->setHeaderHtml( $this->msg( 'unlockdbtext' )->parseAsBlock() )
            ->setSubmitTextMsg( 'unlockbtn' );
    }
 
    public function onSubmit( array $data ) {
        if ( !$data['Confirm'] ) {
            return Status::newFatal( 'locknoconfirm' );
        }
 
        $readOnlyFile = $this->getConfig()->get( MainConfigNames::ReadOnlyFile );
        // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
        $res = @unlink( $readOnlyFile );
 
        if ( $res ) {
            return Status::newGood();
        } else {
            return Status::newFatal( 'filedeleteerror', $readOnlyFile );
        }
    }
 
    public function onSuccess() {
        $out = $this->getOutput();
        $out->addSubtitle( $this->msg( 'unlockdbsuccesssub' ) );
        $out->addWikiMsg( 'unlockdbsuccesstext' );
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    protected function getGroupName() {
        return 'wiki';
    }
}
 
class_alias( SpecialUnlockdb::class, 'SpecialUnlockdb' );