MediaWiki  master
SpecialPage.php
Go to the documentation of this file.
1 <?php
28 
37 class SpecialPage implements MessageLocalizer {
38  // The canonical name of this special page
39  // Also used for the default <h1> heading, @see getDescription()
40  protected $mName;
41 
42  // The local name of this special page
43  private $mLocalName;
44 
45  // Minimum user level required to access this page, or "" for anyone.
46  // Also used to categorise the pages in Special:Specialpages
47  protected $mRestriction;
48 
49  // Listed in Special:Specialpages?
50  private $mListed;
51 
52  // Whether or not this special page is being included from an article
53  protected $mIncluding;
54 
55  // Whether the special page can be included in an article
56  protected $mIncludable;
57 
62  protected $mContext;
63 
67  private $linkRenderer;
68 
83  public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
85  self::getTitleValueFor( $name, $subpage, $fragment )
86  );
87  }
88 
98  public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
99  $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
100  getLocalNameFor( $name, $subpage );
101 
102  return new TitleValue( NS_SPECIAL, $name, $fragment );
103  }
104 
112  public static function getSafeTitleFor( $name, $subpage = false ) {
113  $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
114  getLocalNameFor( $name, $subpage );
115  if ( $name ) {
117  } else {
118  return null;
119  }
120  }
121 
139  public function __construct(
140  $name = '', $restriction = '', $listed = true,
141  $function = false, $file = '', $includable = false
142  ) {
143  $this->mName = $name;
144  $this->mRestriction = $restriction;
145  $this->mListed = $listed;
146  $this->mIncludable = $includable;
147  }
148 
153  function getName() {
154  return $this->mName;
155  }
156 
161  function getRestriction() {
162  return $this->mRestriction;
163  }
164 
165  // @todo FIXME: Decide which syntax to use for this, and stick to it
166 
172  function isListed() {
173  return $this->mListed;
174  }
175 
182  function setListed( $listed ) {
183  return wfSetVar( $this->mListed, $listed );
184  }
185 
192  function listed( $x = null ) {
193  return wfSetVar( $this->mListed, $x );
194  }
195 
200  public function isIncludable() {
201  return $this->mIncludable;
202  }
203 
214  public function maxIncludeCacheTime() {
215  return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
216  }
217 
221  protected function getCacheTTL() {
222  return 60 * 60;
223  }
224 
230  function including( $x = null ) {
231  return wfSetVar( $this->mIncluding, $x );
232  }
233 
238  function getLocalName() {
239  if ( !isset( $this->mLocalName ) ) {
240  $this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
241  getLocalNameFor( $this->mName );
242  }
243 
244  return $this->mLocalName;
245  }
246 
255  public function isExpensive() {
256  return false;
257  }
258 
268  public function isCached() {
269  return false;
270  }
271 
279  public function isRestricted() {
280  // DWIM: If anons can do something, then it is not restricted
281  return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
282  }
283 
292  public function userCanExecute( User $user ) {
293  return $user->isAllowed( $this->mRestriction );
294  }
295 
301  throw new PermissionsError( $this->mRestriction );
302  }
303 
311  public function checkPermissions() {
312  if ( !$this->userCanExecute( $this->getUser() ) ) {
313  $this->displayRestrictionError();
314  }
315  }
316 
324  public function checkReadOnly() {
325  if ( wfReadOnly() ) {
326  throw new ReadOnlyError;
327  }
328  }
329 
341  public function requireLogin(
342  $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
343  ) {
344  if ( $this->getUser()->isAnon() ) {
345  throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
346  }
347  }
348 
356  protected function getLoginSecurityLevel() {
357  return false;
358  }
359 
374  protected function setReauthPostData( array $data ) {
375  }
376 
402  protected function checkLoginSecurityLevel( $level = null ) {
403  $level = $level ?: $this->getName();
404  $key = 'SpecialPage:reauth:' . $this->getName();
405  $request = $this->getRequest();
406 
407  $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
408  if ( $securityStatus === AuthManager::SEC_OK ) {
409  $uniqueId = $request->getVal( 'postUniqueId' );
410  if ( $uniqueId ) {
411  $key .= ':' . $uniqueId;
412  $session = $request->getSession();
413  $data = $session->getSecret( $key );
414  if ( $data ) {
415  $session->remove( $key );
416  $this->setReauthPostData( $data );
417  }
418  }
419  return true;
420  } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
421  $title = self::getTitleFor( 'Userlogin' );
422  $queryParams = $request->getQueryValues();
423 
424  if ( $request->wasPosted() ) {
425  $data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
426  if ( $data ) {
427  // unique ID in case the same special page is open in multiple browser tabs
428  $uniqueId = MWCryptRand::generateHex( 6 );
429  $key .= ':' . $uniqueId;
430  $queryParams['postUniqueId'] = $uniqueId;
431  $session = $request->getSession();
432  $session->persist(); // Just in case
433  $session->setSecret( $key, $data );
434  }
435  }
436 
437  $query = [
438  'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
439  'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
440  'force' => $level,
441  ];
442  $url = $title->getFullURL( $query, false, PROTO_HTTPS );
443 
444  $this->getOutput()->redirect( $url );
445  return false;
446  }
447 
448  $titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
449  $errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
450  throw new ErrorPageError( $titleMessage, $errorMessage );
451  }
452 
469  public function prefixSearchSubpages( $search, $limit, $offset ) {
470  $subpages = $this->getSubpagesForPrefixSearch();
471  if ( !$subpages ) {
472  return [];
473  }
474 
475  return self::prefixSearchArray( $search, $limit, $subpages, $offset );
476  }
477 
486  protected function getSubpagesForPrefixSearch() {
487  return [];
488  }
489 
497  protected function prefixSearchString( $search, $limit, $offset ) {
498  $title = Title::newFromText( $search );
499  if ( !$title || !$title->canExist() ) {
500  // No prefix suggestion in special and media namespace
501  return [];
502  }
503 
504  $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
505  $searchEngine->setLimitOffset( $limit, $offset );
506  $searchEngine->setNamespaces( [] );
507  $result = $searchEngine->defaultPrefixSearch( $search );
508  return array_map( function ( Title $t ) {
509  return $t->getPrefixedText();
510  }, $result );
511  }
512 
524  protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
525  $escaped = preg_quote( $search, '/' );
526  return array_slice( preg_grep( "/^$escaped/i",
527  array_slice( $subpages, $offset ) ), 0, $limit );
528  }
529 
533  function setHeaders() {
534  $out = $this->getOutput();
535  $out->setArticleRelated( false );
536  $out->setRobotPolicy( $this->getRobotPolicy() );
537  $out->setPageTitle( $this->getDescription() );
538  if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
539  $out->addModuleStyles( [
540  'mediawiki.ui.input',
541  'mediawiki.ui.radio',
542  'mediawiki.ui.checkbox',
543  ] );
544  }
545  }
546 
554  final public function run( $subPage ) {
564  if ( !Hooks::run( 'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
565  return;
566  }
567 
568  if ( $this->beforeExecute( $subPage ) === false ) {
569  return;
570  }
571  $this->execute( $subPage );
572  $this->afterExecute( $subPage );
573 
582  Hooks::run( 'SpecialPageAfterExecute', [ $this, $subPage ] );
583  }
584 
594  protected function beforeExecute( $subPage ) {
595  // No-op
596  }
597 
605  protected function afterExecute( $subPage ) {
606  // No-op
607  }
608 
617  public function execute( $subPage ) {
618  $this->setHeaders();
619  $this->checkPermissions();
620  $securityLevel = $this->getLoginSecurityLevel();
621  if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
622  return;
623  }
624  $this->outputHeader();
625  }
626 
635  function outputHeader( $summaryMessageKey = '' ) {
636  if ( $summaryMessageKey == '' ) {
637  $msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
638  '-summary';
639  } else {
640  $msg = $summaryMessageKey;
641  }
642  if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
643  $this->getOutput()->wrapWikiMsg(
644  "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
645  }
646  }
647 
657  function getDescription() {
658  return $this->msg( strtolower( $this->mName ) )->text();
659  }
660 
668  function getPageTitle( $subpage = false ) {
669  return self::getTitleFor( $this->mName, $subpage );
670  }
671 
678  public function setContext( $context ) {
679  $this->mContext = $context;
680  }
681 
688  public function getContext() {
689  if ( $this->mContext instanceof IContextSource ) {
690  return $this->mContext;
691  } else {
692  wfDebug( __METHOD__ . " called and \$mContext is null. " .
693  "Return RequestContext::getMain(); for sanity\n" );
694 
695  return RequestContext::getMain();
696  }
697  }
698 
705  public function getRequest() {
706  return $this->getContext()->getRequest();
707  }
708 
715  public function getOutput() {
716  return $this->getContext()->getOutput();
717  }
718 
725  public function getUser() {
726  return $this->getContext()->getUser();
727  }
728 
735  public function getSkin() {
736  return $this->getContext()->getSkin();
737  }
738 
745  public function getLanguage() {
746  return $this->getContext()->getLanguage();
747  }
748 
754  public function getConfig() {
755  return $this->getContext()->getConfig();
756  }
757 
764  public function getFullTitle() {
765  return $this->getContext()->getTitle();
766  }
767 
775  protected function getRobotPolicy() {
776  return 'noindex,nofollow';
777  }
778 
786  public function msg( $key /* $args */ ) {
787  $message = $this->getContext()->msg( ...func_get_args() );
788  // RequestContext passes context to wfMessage, and the language is set from
789  // the context, but setting the language for Message class removes the
790  // interface message status, which breaks for example usernameless gender
791  // invocations. Restore the flag when not including special page in content.
792  if ( $this->including() ) {
793  $message->setInterfaceMessageFlag( false );
794  }
795 
796  return $message;
797  }
798 
804  protected function addFeedLinks( $params ) {
805  $feedTemplate = wfScript( 'api' );
806 
807  foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
808  $theseParams = $params + [ 'feedformat' => $format ];
809  $url = wfAppendQuery( $feedTemplate, $theseParams );
810  $this->getOutput()->addFeedLink( $format, $url );
811  }
812  }
813 
822  public function addHelpLink( $to, $overrideBaseUrl = false ) {
823  if ( $this->including() ) {
824  return;
825  }
826 
827  $msg = $this->msg(
828  MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
829  '-helppage' );
830 
831  if ( !$msg->isDisabled() ) {
832  $helpUrl = Skin::makeUrl( $msg->plain() );
833  $this->getOutput()->addHelpLink( $helpUrl, true );
834  } else {
835  $this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
836  }
837  }
838 
847  public function getFinalGroupName() {
848  $name = $this->getName();
849 
850  // Allow overriding the group from the wiki side
851  $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
852  if ( !$msg->isBlank() ) {
853  $group = $msg->text();
854  } else {
855  // Than use the group from this object
856  $group = $this->getGroupName();
857  }
858 
859  return $group;
860  }
861 
868  public function doesWrites() {
869  return false;
870  }
871 
880  protected function getGroupName() {
881  return 'other';
882  }
883 
888  protected function useTransactionalTimeLimit() {
889  if ( $this->getRequest()->wasPosted() ) {
891  }
892  }
893 
898  public function getLinkRenderer() {
899  if ( $this->linkRenderer ) {
900  return $this->linkRenderer;
901  } else {
902  return MediaWikiServices::getInstance()->getLinkRenderer();
903  }
904  }
905 
911  $this->linkRenderer = $linkRenderer;
912  }
913 
924  protected function buildPrevNextNavigation( $offset, $limit,
925  array $query = [], $atend = false, $subpage = false
926  ) {
927  $title = $this->getPageTitle( $subpage );
928  $prevNext = new PrevNextNavigationRenderer( $this );
929 
930  return $prevNext->buildPrevNextNavigation( $title, $offset, $limit, $query, $atend );
931  }
932 }
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
Definition: SpecialPage.php:98
run( $subPage)
Entry point.
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
Helper class for generating prev/next links for paging.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1566
getRestriction()
Get the permission that a user must have to execute this page.
doesWrites()
Indicates whether this special page may perform database writes.
getContext()
Gets the context this SpecialPage is executed in.
static prefixSearchArray( $search, $limit, array $subpages, $offset)
Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as op...
including( $x=null)
Whether the special page is being evaluated via transclusion.
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
isIncludable()
Whether it&#39;s allowed to transclude the special page via {{Special:Foo/params}}.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
setReauthPostData(array $data)
Record preserved POST data after a reauthentication.
maxIncludeCacheTime()
How long to cache page when it is being included.
isExpensive()
Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in ...
listed( $x=null)
Get or set whether this special page is listed in Special:SpecialPages.
getFinalGroupName()
Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.
const NS_SPECIAL
Definition: Defines.php:49
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
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
Definition: injection.txt:23
beforeExecute( $subPage)
Gets called before.
getOutput()
Get the OutputPage being used for this instance.
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1722
getRobotPolicy()
Return the robot policy.
Redirect a user to the login page.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1969
isListed()
Whether this special page is listed in Special:SpecialPages.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
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:767
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
afterExecute( $subPage)
Gets called after.
buildPrevNextNavigation( $offset, $limit, array $query=[], $atend=false, $subpage=false)
Generate (prev x| next x) (20|50|100...) type links for paging.
const PROTO_HTTPS
Definition: Defines.php:200
IContextSource $mContext
Current request context.
Definition: SpecialPage.php:62
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
wfReadOnly()
Check whether the wiki is in read-only mode.
setContext( $context)
Sets the context this SpecialPage is executed in.
Class that generates HTML links for pages.
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 use $formDescriptor instead 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 "&lt
static getMain()
Get the RequestContext object associated with the main request.
displayRestrictionError()
Output an error message telling the user what access level they have to have.
An error page which can definitely be safely rendered using the OutputPage.
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept for prefix searches.
isRestricted()
Can be overridden by subclasses with more complicated permissions schemes.
setListed( $listed)
Set whether this page is listed in Special:Specialpages, at run-time.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$params
getSkin()
Shortcut to get the skin being used for this instance.
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition: User.php:3642
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format...
Definition: MWCryptRand.php:36
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 null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
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
Definition: distributors.txt:9
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4831
isCached()
Is this page cached? Expensive pages are cached or disabled in miser mode.
static makeUrl( $name, $urlaction='')
Definition: Skin.php:1193
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:618
execute( $subPage)
Default execute method Checks user permissions.
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:35
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
addFeedLinks( $params)
Adds RSS/atom links.
__construct( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
Default constructor for special pages Derivative classes should call this from their constructor Note...
getName()
Get the name of this Special Page.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
setLinkRenderer(LinkRenderer $linkRenderer)
Show an error when a user tries to do something they do not have the necessary permissions for...
getLanguage()
Shortcut to get user&#39;s language.
wfTransactionalTimeLimit()
Set PHP&#39;s time limit to the larger of php.ini or $wgTransactionalTimeLimit.
msg( $key)
Wrapper around wfMessage that sets the current context.
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2620
checkLoginSecurityLevel( $level=null)
Verifies that the user meets the security level, possibly reauthenticating them in the process...
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages &#39;specialpages-gro...
getFullTitle()
Return the full title, including $par.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static getSafeTitleFor( $name, $subpage=false)
Get a localised Title object for a page name with a possibly unvalidated subpage. ...
getRequest()
Get the WebRequest being used for this instance.
getLocalName()
Get the localised name of the special page.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2620
static newFromTitleValue(TitleValue $titleValue, $forceClone='')
Returns a Title given a TitleValue.
Definition: Title.php:257
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:320