MediaWiki REL1_28
Go to the documentation of this file.
30 protected $reason = '';
32 public function __construct() {
33 parent::__construct( 'Lockdb', 'siteadmin' );
34 }
36 public function doesWrites() {
37 return false;
38 }
40 public function requiresWrite() {
41 return false;
42 }
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 if ( file_exists( $this->getConfig()->get( 'ReadOnlyFile' ) ) ) {
51 throw new ErrorPageError( 'lockdb', 'databaselocked' );
52 }
53 }
55 protected function getFormFields() {
56 return [
57 'Reason' => [
58 'type' => 'textarea',
59 'rows' => 4,
60 'vertical-label' => true,
61 'label-message' => 'enterlockreason',
62 ],
63 'Confirm' => [
64 'type' => 'toggle',
65 'label-message' => 'lockconfirm',
66 ],
67 ];
68 }
70 protected function alterForm( HTMLForm $form ) {
71 $form->setWrapperLegend( false )
72 ->setHeaderText( $this->msg( 'lockdbtext' )->parseAsBlock() )
73 ->setSubmitTextMsg( 'lockbtn' );
74 }
76 public function onSubmit( array $data ) {
79 if ( !$data['Confirm'] ) {
80 return Status::newFatal( 'locknoconfirm' );
81 }
83 MediaWiki\suppressWarnings();
84 $fp = fopen( $this->getConfig()->get( 'ReadOnlyFile' ), 'w' );
85 MediaWiki\restoreWarnings();
87 if ( false === $fp ) {
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'] );
95 fwrite( $fp, "\n<p>" . $this->msg( 'lockedbyandtime',
96 $this->getUser()->getName(),
97 $wgContLang->date( $timestamp, false, false ),
98 $wgContLang->time( $timestamp, false, false )
99 )->inContentLanguage()->text() . "</p>\n" );
100 fclose( $fp );
102 return Status::newGood();
103 }
105 public function onSuccess() {
106 $out = $this->getOutput();
107 $out->addSubtitle( $this->msg( 'lockdbsuccesssub' ) );
108 $out->addWikiMsg( 'lockdbsuccesstext' );
109 }
111 protected function getDisplayFormat() {
112 return 'ooui';
113 }
115 protected function getGroupName() {
116 return 'wiki';
117 }
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:128
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.
A form to make the database readonly (eg for maintenance purposes).
onSubmit(array $data)
Process the form on POST submission.
Get an HTMLForm descriptor array.
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.
Whether this action requires the wiki not to be locked.
Indicates whether this special page may perform database writes.
Get display format for the form.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Get the name of this Special Page.
Get the OutputPage being used for this instance.
Shortcut to get the User executing this instance.
Shortcut to get main config object.
Wrapper around wfMessage that sets the current context.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
the array() calling protocol came about after MediaWiki 1.4rc1.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:886
if( $limit) $timestamp
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