3 * Implements Special:Lockdb
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.
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.
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
21 * @ingroup SpecialPage
24 use MediaWiki\MediaWikiServices
;
27 * A form to make the database readonly (eg for maintenance purposes).
29 * @ingroup SpecialPage
31 class SpecialLockdb
extends FormSpecialPage
{
32 protected $reason = '';
34 public function __construct() {
35 parent
::__construct( 'Lockdb', 'siteadmin' );
38 public function doesWrites() {
42 public function requiresWrite() {
46 public function checkExecutePermissions( User
$user ) {
47 parent
::checkExecutePermissions( $user );
48 # If the lock file isn't writable, we can do sweet bugger all
49 if ( !is_writable( dirname( $this->getConfig()->get( 'ReadOnlyFile' ) ) ) ) {
50 throw new ErrorPageError( 'lockdb', 'lockfilenotwritable' );
52 if ( file_exists( $this->getConfig()->get( 'ReadOnlyFile' ) ) ) {
53 throw new ErrorPageError( 'lockdb', 'databaselocked' );
57 protected function getFormFields() {
62 'vertical-label' => true,
63 'label-message' => 'enterlockreason',
67 'label-message' => 'lockconfirm',
72 protected function alterForm( HTMLForm
$form ) {
73 $form->setWrapperLegend( false )
74 ->setHeaderText( $this->msg( 'lockdbtext' )->parseAsBlock() )
75 ->setSubmitTextMsg( 'lockbtn' );
78 public function onSubmit( array $data ) {
79 if ( !$data['Confirm'] ) {
80 return Status
::newFatal( 'locknoconfirm' );
83 Wikimedia\
suppressWarnings();
84 $fp = fopen( $this->getConfig()->get( 'ReadOnlyFile' ), 'w' );
85 Wikimedia\restoreWarnings
();
87 if ( $fp === false ) {
88 # This used to show a file not found error, but the likeliest reason for fopen()
89 # to fail at this point is insufficient permission to write to the file...good old
90 # is_writable() is plain wrong in some cases, it seems...
91 return Status
::newFatal( 'lockfilenotwritable' );
93 fwrite( $fp, $data['Reason'] );
94 $timestamp = wfTimestampNow();
95 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
96 fwrite( $fp, "\n<p>" . $this->msg( 'lockedbyandtime',
97 $this->getUser()->getName(),
98 $contLang->date( $timestamp, false, false ),
99 $contLang->time( $timestamp, false, false )
100 )->inContentLanguage()->text() . "</p>\n" );
103 return Status
::newGood();
106 public function onSuccess() {
107 $out = $this->getOutput();
108 $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
109 $out->addWikiMsg( 'lockdbsuccesstext' );
112 protected function getDisplayFormat() {
116 protected function getGroupName() {