Go to the documentation of this file.
67 $this->mTitle =
$article->getTitle();
68 $this->mApplicableTypes = $this->mTitle->getRestrictionTypes();
69 $this->mContext =
$article->getContext();
73 $this->mPermErrors = $this->mTitle->getUserPermissionsErrors(
75 $this->mContext->getUser(),
76 $this->mContext->getRequest()->wasPosted() ?
'secure' :
'full'
81 $this->disabled = $this->mPermErrors != [];
82 $this->disabledAttrib = $this->disabled
83 ? [
'disabled' =>
'disabled' ]
94 $this->mTitle->getNamespace(), $this->mContext->getUser()
96 $this->mCascade = $this->mTitle->areRestrictionsCascading();
99 $this->mReason =
$request->getText(
'mwProtect-reason' );
100 $this->mReasonSelection =
$request->getText(
'wpProtectReasonSelection' );
101 $this->mCascade =
$request->getBool(
'mwProtect-cascade', $this->mCascade );
103 foreach ( $this->mApplicableTypes
as $action ) {
108 $this->mRestrictions[$action] = implode(
'', $this->mTitle->getRestrictions( $action ) );
110 if ( !$this->mRestrictions[$action] ) {
112 $existingExpiry =
'';
114 $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
116 $this->mExistingExpiry[$action] = $existingExpiry;
118 $requestExpiry =
$request->getText(
"mwProtect-expiry-$action" );
119 $requestExpirySelection =
$request->getVal(
"wpProtectExpirySelection-$action" );
121 if ( $requestExpiry ) {
123 $this->mExpiry[$action] = $requestExpiry;
124 $this->mExpirySelection[$action] =
'othertime';
125 } elseif ( $requestExpirySelection ) {
127 $this->mExpiry[$action] =
'';
128 $this->mExpirySelection[$action] = $requestExpirySelection;
129 } elseif ( $existingExpiry ) {
131 $this->mExpiry[$action] =
'';
132 $this->mExpirySelection[$action] = $existingExpiry;
136 $this->mExpiry[$action] =
'';
137 $this->mExpirySelection[$action] =
'infinite';
140 $val =
$request->getVal(
"mwProtect-level-$action" );
141 if ( isset( $val ) && in_array( $val, $levels ) ) {
142 $this->mRestrictions[$action] = $val;
155 if ( $this->mExpirySelection[$action] ==
'existing' ) {
156 return $this->mExistingExpiry[$action];
157 } elseif ( $this->mExpirySelection[$action] ==
'othertime' ) {
158 $value = $this->mExpiry[$action];
160 $value = $this->mExpirySelection[$action];
165 $unix = strtotime(
$value );
167 if ( !$unix || $unix === -1 ) {
183 throw new ErrorPageError(
'protect-badnamespace-title',
'protect-badnamespace-text' );
186 if ( $this->mContext->getRequest()->wasPosted() ) {
187 if ( $this->
save() ) {
188 $q = $this->mArticle->isRedirect() ?
'redirect=no' :
'';
189 $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) );
202 $out = $this->mContext->getOutput();
203 $out->setRobotPolicy(
'noindex,nofollow' );
204 $out->addBacklinkSubtitle( $this->mTitle );
206 if ( is_array( $err ) ) {
207 $out->wrapWikiMsg(
"<p class='error'>\n$1\n</p>\n", $err );
208 } elseif ( is_string( $err ) ) {
209 $out->addHTML(
"<p class='error'>{$err}</p>\n" );
212 if ( $this->mTitle->getRestrictionTypes() === [] ) {
215 $out->setPageTitle( $this->mContext->msg(
216 'protect-norestrictiontypes-title',
217 $this->mTitle->getPrefixedText()
219 $out->addWikiText( $this->mContext->msg(
'protect-norestrictiontypes-text' )->plain() );
227 list( $cascadeSources, ) = $this->mTitle->getCascadeProtectionSources();
228 if ( $cascadeSources &&
count( $cascadeSources ) > 0 ) {
231 foreach ( $cascadeSources
as $title ) {
237 "<div id=\"mw-protect-cascadeon\">\n$1\n" .
$titles .
"</div>",
238 [
'protect-cascadeon',
count( $cascadeSources ) ]
242 # Show an appropriate message if the user isn't allowed or able to change
243 # the protection settings at this time
244 if ( $this->disabled ) {
246 $this->mContext->msg(
'protect-title-notallowed',
247 $this->mTitle->getPrefixedText() )
249 $out->addWikiText(
$out->formatPermissionsErrorMessage( $this->mPermErrors,
'protect' ) );
251 $out->setPageTitle( $this->mContext->msg(
'protect-title', $this->mTitle->getPrefixedText() ) );
252 $out->addWikiMsg(
'protect-text',
267 if ( $this->disabled ) {
273 $user = $this->mContext->getUser();
274 $out = $this->mContext->getOutput();
275 $token =
$request->getVal(
'wpEditToken' );
276 if ( !
$user->matchEditToken( $token, [
'protect', $this->mTitle->getPrefixedDBkey() ] ) ) {
277 $this->
show( [
'sessionfailure' ] );
281 # Create reason string. Use list and/or custom string.
283 if ( $reasonstr !=
'other' && $this->mReason !=
'' ) {
285 $reasonstr .= $this->mContext->msg(
'colon-separator' )->text() .
$this->mReason;
286 } elseif ( $reasonstr ==
'other' ) {
290 foreach ( $this->mApplicableTypes
as $action ) {
291 $expiry[$action] = $this->
getExpiry( $action );
292 if ( empty( $this->mRestrictions[$action] ) ) {
295 if ( !$expiry[$action] ) {
296 $this->
show( [
'protect_expiry_invalid' ] );
300 $this->
show( [
'protect_expiry_old' ] );
305 $this->mCascade =
$request->getBool(
'mwProtect-cascade' );
307 $status = $this->mArticle->doUpdateRestrictions(
308 $this->mRestrictions,
327 if ( !
Hooks::run(
'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
328 if ( $errorMsg ==
'' ) {
329 $errorMsg = [
'hookaborted' ];
332 if ( $errorMsg !=
'' ) {
333 $this->
show( $errorMsg );
352 $cascadingRestrictionLevels =
$context->
getConfig()->get(
'CascadingRestrictionLevels' );
354 if ( !$this->disabled ) {
355 $output->addModules(
'mediawiki.legacy.protect' );
356 $output->addJsConfigVars(
'wgCascadeableLevels', $cascadingRestrictionLevels );
358 'action' => $this->mTitle->getLocalURL(
'action=protect' ),
359 'id' =>
'mw-Protect-Form' ] );
367 $scExpiryOptions =
wfMessage(
'protect-expiry-options' )->inContentLanguage()->text();
368 $showProtectOptions = $scExpiryOptions !==
'-' && !$this->disabled;
371 foreach ( $this->mRestrictions
as $action => $selected ) {
377 Xml::element(
'legend',
null, $msg->exists() ? $msg->text() : $action ) .
379 "<tr><td>" . $this->
buildSelector( $action, $selected ) .
"</td></tr><tr><td>";
383 "mwProtectExpirySelection-$action"
387 "mwProtect-$action-expires"
391 "wpProtectExpirySelection-$action",
392 "mwProtectExpirySelection-$action",
393 $this->mExpirySelection[$action]
395 $expiryFormOptions->setAttribute(
'tabindex',
'2' );
396 if ( $this->disabled ) {
397 $expiryFormOptions->setAttribute(
'disabled',
'disabled' );
400 if ( $this->mExistingExpiry[$action] ) {
401 if ( $this->mExistingExpiry[$action] ==
'infinity' ) {
402 $existingExpiryMessage =
$context->
msg(
'protect-existing-expiry-infinity' );
404 $timestamp =
$lang->userTimeAndDate( $this->mExistingExpiry[$action],
$user );
405 $d =
$lang->userDate( $this->mExistingExpiry[$action],
$user );
406 $t =
$lang->userTime( $this->mExistingExpiry[$action],
$user );
408 'protect-existing-expiry',
414 $expiryFormOptions->addOption( $existingExpiryMessage->text(),
'existing' );
417 $expiryFormOptions->addOption(
421 foreach ( explode(
',', $scExpiryOptions )
as $option ) {
422 if ( strpos( $option,
":" ) ===
false ) {
425 list( $show,
$value ) = explode(
":", $option );
427 $expiryFormOptions->addOption( $show, htmlspecialchars(
$value ) );
429 # Add expiry dropdown
430 if ( $showProtectOptions && !$this->disabled ) {
433 <td class='mw-label'>
436 <td class='mw-input'>" .
437 $expiryFormOptions->getHTML() .
441 # Add custom expiry field
442 $attribs = [
'id' =>
"mwProtect-$action-expires" ] + $this->disabledAttrib;
444 <td class='mw-label'>" .
447 <td class="mw-input">' .
451 $out .=
"</td></tr>" .
456 # Give extensions a chance to add items to the form
457 Hooks::run(
'ProtectionForm::buildForm', [ $this->mArticle, &
$out ] );
462 if ( $this->mTitle->exists() ) {
467 <td class="mw-input">' .
479 # Add manual and custom reason field/selects as well as submit
480 if ( !$this->disabled ) {
483 'wpProtectReasonSelection'
492 wfMessage(
'protect-dropdown' )->inContentLanguage()->
text(),
493 wfMessage(
'protect-otherreason-op' )->inContentLanguage()->
text(),
494 $this->mReasonSelection,
495 'mwProtect-reason', 4 );
501 <td class='mw-label'>
502 {$mProtectreasonother}
504 <td class='mw-input'>
509 <td class='mw-label'>
512 <td class='mw-input'>" .
513 Xml::input(
'mwProtect-reason', 60, $this->mReason, [
'type' =>
'text',
514 'id' =>
'mwProtect-reason',
'maxlength' => 180 ] ) .
520 # Disallow watching is user is not logged in
521 if (
$user->isLoggedIn() ) {
525 <td class='mw-input'>" .
527 'mwProtectWatch',
'mwProtectWatch',
528 $user->isWatched( $this->mTitle ) ||
$user->getOption(
'watchdefault' ) ) .
535 <td class='mw-submit'>" .
538 [
'id' =>
'mw-Protect-submit' ]
546 if (
$user->isAllowed(
'editinterface' ) ) {
547 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
549 $context->
msg(
'protect-dropdown' )->inContentLanguage()->getTitle(),
550 $context->
msg(
'protect-edit-reasonlist' )->text(),
552 [
'action' =>
'edit' ]
554 $out .=
'<p class="mw-protect-editreasons">' .
$link .
'</p>';
557 if ( !$this->disabled ) {
560 $user->getEditToken( [
'protect', $this->mTitle->getPrefixedDBkey() ] )
579 $this->disabled ? null : $this->mContext->getUser()
582 $id =
'mwProtect-level-' . $action;
584 $select =
new XmlSelect( $id, $id, $selected );
585 $select->setAttribute(
'size',
count( $levels ) );
586 if ( $this->disabled ) {
587 $select->setAttribute(
'disabled',
'disabled' );
590 foreach ( $levels
as $key ) {
594 return $select->getHTML();
604 if ( $permission ==
'' ) {
605 return $this->mContext->msg(
'protect-default' )->text();
608 $msg = $this->mContext->msg(
"protect-level-{$permission}" );
609 if ( $msg->exists() ) {
612 return $this->mContext->msg(
'protect-fallback', $permission )->text();
623 # Show relevant lines from the protection log:
624 $protectLogPage =
new LogPage(
'protect' );
625 $out->addHTML(
Xml::element(
'h2',
null, $protectLogPage->getName()->text() ) );
627 # Let extensions add other relevant log extracts
628 Hooks::run(
'ProtectionForm::showLogExtract', [ $this->mArticle,
$out ] );
getConfig()
Get the Config object.
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
error also a ContextSource you ll probably need to make sure the header is varied on $request
processing should stop and the error should be shown to the user * false
msg()
Get a Message object with context set Parameters are the same as wfMessage()
if(!isset( $args[0])) $lang
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
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 account $user
wfReadOnly()
Check whether the wiki is in read-only mode.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
getRequest()
Get the WebRequest object.
getUser()
Get the User object.
static openElement( $element, $attribs=null)
This opens an XML element.
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
Class for generating HTML <select> or <datalist> elements.
getLanguage()
Get the Language object.
namespace and then decline to actually register it file or subcat img or subcat $title
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
getOutput()
Get the OutputPage object.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Class to simplify the use of log pages.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
see documentation in includes Linker php for Linker::makeImageLink & $time
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
static getRestrictionLevels( $index, User $user=null)
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a use...
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
wfIsInfinity( $str)
Determine input string is represents as infinity.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Interface for objects which can provide a MediaWiki context on request.
static closeElement( $element)
Shortcut to close an XML element.
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
usually copyright or history_copyright This message must be in HTML not wikitext & $link
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Class for viewing MediaWiki article and history.
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 MediaWikiServices
An error page which can definitely be safely rendered using the OutputPage.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
the array() calling protocol came about after MediaWiki 1.4rc1.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
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