MediaWiki REL1_33
SpecialLockdb.php
Go to the documentation of this file.
1<?php
25
32 protected $reason = '';
33
34 public function __construct() {
35 parent::__construct( 'Lockdb', 'siteadmin' );
36 }
37
38 public function doesWrites() {
39 return false;
40 }
41
42 public function requiresWrite() {
43 return false;
44 }
45
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' );
51 }
52 if ( file_exists( $this->getConfig()->get( 'ReadOnlyFile' ) ) ) {
53 throw new ErrorPageError( 'lockdb', 'databaselocked' );
54 }
55 }
56
57 protected function getFormFields() {
58 return [
59 'Reason' => [
60 'type' => 'textarea',
61 'rows' => 4,
62 'vertical-label' => true,
63 'label-message' => 'enterlockreason',
64 ],
65 'Confirm' => [
66 'type' => 'toggle',
67 'label-message' => 'lockconfirm',
68 ],
69 ];
70 }
71
72 protected function alterForm( HTMLForm $form ) {
73 $form->setWrapperLegend( false )
74 ->setHeaderText( $this->msg( 'lockdbtext' )->parseAsBlock() )
75 ->setSubmitTextMsg( 'lockbtn' );
76 }
77
78 public function onSubmit( array $data ) {
79 if ( !$data['Confirm'] ) {
80 return Status::newFatal( 'locknoconfirm' );
81 }
82
83 Wikimedia\suppressWarnings();
84 $fp = fopen( $this->getConfig()->get( 'ReadOnlyFile' ), 'w' );
85 Wikimedia\restoreWarnings();
86
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' );
92 }
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" );
101 fclose( $fp );
102
103 return Status::newGood();
104 }
105
106 public function onSuccess() {
107 $out = $this->getOutput();
108 $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
109 $out->addWikiMsg( 'lockdbsuccesstext' );
110 }
111
112 protected function getDisplayFormat() {
113 return 'ooui';
114 }
115
116 protected function getGroupName() {
117 return 'wiki';
118 }
119}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
An error page which can definitely be safely rendered using the OutputPage.
Special page which uses an HTMLForm to handle processing.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:133
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.
MediaWikiServices is the service locator for the application scope of MediaWiki.
A form to make the database readonly (eg for maintenance purposes).
onSubmit(array $data)
Process the form on POST submission.
getFormFields()
Get an HTMLForm descriptor array.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
checkExecutePermissions(User $user)
Called from execute() to check if the given user can perform this action.
requiresWrite()
Whether this action requires the wiki not to be locked.
doesWrites()
Indicates whether this special page may perform database writes.
getDisplayFormat()
Get display format for the form.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
getName()
Get the name of this Special Page.
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
msg( $key)
Wrapper around wfMessage that sets the current context.
getConfig()
Shortcut to get main config object.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:855
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))