MediaWiki  master
SpecialPage.php
Go to the documentation of this file.
1 <?php
27 
36 class SpecialPage implements MessageLocalizer {
37  // The canonical name of this special page
38  // Also used for the default <h1> heading, @see getDescription()
39  protected $mName;
40 
41  // The local name of this special page
42  private $mLocalName;
43 
44  // Minimum user level required to access this page, or "" for anyone.
45  // Also used to categorise the pages in Special:Specialpages
46  protected $mRestriction;
47 
48  // Listed in Special:Specialpages?
49  private $mListed;
50 
51  // Whether or not this special page is being included from an article
52  protected $mIncluding;
53 
54  // Whether the special page can be included in an article
55  protected $mIncludable;
56 
61  protected $mContext;
62 
66  private $linkRenderer;
67 
82  public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
84  self::getTitleValueFor( $name, $subpage, $fragment )
85  );
86  }
87 
97  public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
98  $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
99  getLocalNameFor( $name, $subpage );
100 
101  return new TitleValue( NS_SPECIAL, $name, $fragment );
102  }
103 
111  public static function getSafeTitleFor( $name, $subpage = false ) {
112  $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
113  getLocalNameFor( $name, $subpage );
114  if ( $name ) {
116  } else {
117  return null;
118  }
119  }
120 
138  public function __construct(
139  $name = '', $restriction = '', $listed = true,
140  $function = false, $file = '', $includable = false
141  ) {
142  $this->mName = $name;
143  $this->mRestriction = $restriction;
144  $this->mListed = $listed;
145  $this->mIncludable = $includable;
146  }
147 
152  function getName() {
153  return $this->mName;
154  }
155 
160  function getRestriction() {
161  return $this->mRestriction;
162  }
163 
164  // @todo FIXME: Decide which syntax to use for this, and stick to it
165 
171  function isListed() {
172  return $this->mListed;
173  }
174 
181  function setListed( $listed ) {
182  return wfSetVar( $this->mListed, $listed );
183  }
184 
191  function listed( $x = null ) {
192  return wfSetVar( $this->mListed, $x );
193  }
194 
199  public function isIncludable() {
200  return $this->mIncludable;
201  }
202 
213  public function maxIncludeCacheTime() {
214  return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
215  }
216 
220  protected function getCacheTTL() {
221  return 60 * 60;
222  }
223 
229  function including( $x = null ) {
230  return wfSetVar( $this->mIncluding, $x );
231  }
232 
237  function getLocalName() {
238  if ( !isset( $this->mLocalName ) ) {
239  $this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
240  getLocalNameFor( $this->mName );
241  }
242 
243  return $this->mLocalName;
244  }
245 
254  public function isExpensive() {
255  return false;
256  }
257 
267  public function isCached() {
268  return false;
269  }
270 
278  public function isRestricted() {
279  // DWIM: If anons can do something, then it is not restricted
280  return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
281  }
282 
291  public function userCanExecute( User $user ) {
292  return $user->isAllowed( $this->mRestriction );
293  }
294 
300  throw new PermissionsError( $this->mRestriction );
301  }
302 
310  public function checkPermissions() {
311  if ( !$this->userCanExecute( $this->getUser() ) ) {
312  $this->displayRestrictionError();
313  }
314  }
315 
323  public function checkReadOnly() {
324  if ( wfReadOnly() ) {
325  throw new ReadOnlyError;
326  }
327  }
328 
340  public function requireLogin(
341  $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
342  ) {
343  if ( $this->getUser()->isAnon() ) {
344  throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
345  }
346  }
347 
355  protected function getLoginSecurityLevel() {
356  return false;
357  }
358 
373  protected function setReauthPostData( array $data ) {
374  }
375 
401  protected function checkLoginSecurityLevel( $level = null ) {
402  $level = $level ?: $this->getName();
403  $key = 'SpecialPage:reauth:' . $this->getName();
404  $request = $this->getRequest();
405 
406  $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
407  if ( $securityStatus === AuthManager::SEC_OK ) {
408  $uniqueId = $request->getVal( 'postUniqueId' );
409  if ( $uniqueId ) {
410  $key .= ':' . $uniqueId;
411  $session = $request->getSession();
412  $data = $session->getSecret( $key );
413  if ( $data ) {
414  $session->remove( $key );
415  $this->setReauthPostData( $data );
416  }
417  }
418  return true;
419  } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
420  $title = self::getTitleFor( 'Userlogin' );
421  $queryParams = $request->getQueryValues();
422 
423  if ( $request->wasPosted() ) {
424  $data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
425  if ( $data ) {
426  // unique ID in case the same special page is open in multiple browser tabs
427  $uniqueId = MWCryptRand::generateHex( 6 );
428  $key .= ':' . $uniqueId;
429  $queryParams['postUniqueId'] = $uniqueId;
430  $session = $request->getSession();
431  $session->persist(); // Just in case
432  $session->setSecret( $key, $data );
433  }
434  }
435 
436  $query = [
437  'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
438  'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
439  'force' => $level,
440  ];
441  $url = $title->getFullURL( $query, false, PROTO_HTTPS );
442 
443  $this->getOutput()->redirect( $url );
444  return false;
445  }
446 
447  $titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
448  $errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
449  throw new ErrorPageError( $titleMessage, $errorMessage );
450  }
451 
468  public function prefixSearchSubpages( $search, $limit, $offset ) {
469  $subpages = $this->getSubpagesForPrefixSearch();
470  if ( !$subpages ) {
471  return [];
472  }
473 
474  return self::prefixSearchArray( $search, $limit, $subpages, $offset );
475  }
476 
485  protected function getSubpagesForPrefixSearch() {
486  return [];
487  }
488 
496  protected function prefixSearchString( $search, $limit, $offset ) {
497  $title = Title::newFromText( $search );
498  if ( !$title || !$title->canExist() ) {
499  // No prefix suggestion in special and media namespace
500  return [];
501  }
502 
503  $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
504  $searchEngine->setLimitOffset( $limit, $offset );
505  $searchEngine->setNamespaces( [] );
506  $result = $searchEngine->defaultPrefixSearch( $search );
507  return array_map( function ( Title $t ) {
508  return $t->getPrefixedText();
509  }, $result );
510  }
511 
523  protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
524  $escaped = preg_quote( $search, '/' );
525  return array_slice( preg_grep( "/^$escaped/i",
526  array_slice( $subpages, $offset ) ), 0, $limit );
527  }
528 
532  function setHeaders() {
533  $out = $this->getOutput();
534  $out->setArticleRelated( false );
535  $out->setRobotPolicy( $this->getRobotPolicy() );
536  $out->setPageTitle( $this->getDescription() );
537  if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
538  $out->addModuleStyles( [
539  'mediawiki.ui.input',
540  'mediawiki.ui.radio',
541  'mediawiki.ui.checkbox',
542  ] );
543  }
544  }
545 
553  final public function run( $subPage ) {
563  if ( !Hooks::run( 'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
564  return;
565  }
566 
567  if ( $this->beforeExecute( $subPage ) === false ) {
568  return;
569  }
570  $this->execute( $subPage );
571  $this->afterExecute( $subPage );
572 
581  Hooks::run( 'SpecialPageAfterExecute', [ $this, $subPage ] );
582  }
583 
593  protected function beforeExecute( $subPage ) {
594  // No-op
595  }
596 
604  protected function afterExecute( $subPage ) {
605  // No-op
606  }
607 
616  public function execute( $subPage ) {
617  $this->setHeaders();
618  $this->checkPermissions();
619  $securityLevel = $this->getLoginSecurityLevel();
620  if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
621  return;
622  }
623  $this->outputHeader();
624  }
625 
634  function outputHeader( $summaryMessageKey = '' ) {
635  if ( $summaryMessageKey == '' ) {
636  $msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
637  '-summary';
638  } else {
639  $msg = $summaryMessageKey;
640  }
641  if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
642  $this->getOutput()->wrapWikiMsg(
643  "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
644  }
645  }
646 
656  function getDescription() {
657  return $this->msg( strtolower( $this->mName ) )->text();
658  }
659 
667  function getTitle( $subpage = false ) {
668  wfDeprecated( __METHOD__, '1.23' );
669  return $this->getPageTitle( $subpage );
670  }
671 
679  function getPageTitle( $subpage = false ) {
680  return self::getTitleFor( $this->mName, $subpage );
681  }
682 
689  public function setContext( $context ) {
690  $this->mContext = $context;
691  }
692 
699  public function getContext() {
700  if ( $this->mContext instanceof IContextSource ) {
701  return $this->mContext;
702  } else {
703  wfDebug( __METHOD__ . " called and \$mContext is null. " .
704  "Return RequestContext::getMain(); for sanity\n" );
705 
706  return RequestContext::getMain();
707  }
708  }
709 
716  public function getRequest() {
717  return $this->getContext()->getRequest();
718  }
719 
726  public function getOutput() {
727  return $this->getContext()->getOutput();
728  }
729 
736  public function getUser() {
737  return $this->getContext()->getUser();
738  }
739 
746  public function getSkin() {
747  return $this->getContext()->getSkin();
748  }
749 
756  public function getLanguage() {
757  return $this->getContext()->getLanguage();
758  }
759 
765  public function getConfig() {
766  return $this->getContext()->getConfig();
767  }
768 
775  public function getFullTitle() {
776  return $this->getContext()->getTitle();
777  }
778 
786  protected function getRobotPolicy() {
787  return 'noindex,nofollow';
788  }
789 
797  public function msg( $key /* $args */ ) {
798  $message = $this->getContext()->msg( ...func_get_args() );
799  // RequestContext passes context to wfMessage, and the language is set from
800  // the context, but setting the language for Message class removes the
801  // interface message status, which breaks for example usernameless gender
802  // invocations. Restore the flag when not including special page in content.
803  if ( $this->including() ) {
804  $message->setInterfaceMessageFlag( false );
805  }
806 
807  return $message;
808  }
809 
815  protected function addFeedLinks( $params ) {
816  $feedTemplate = wfScript( 'api' );
817 
818  foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
819  $theseParams = $params + [ 'feedformat' => $format ];
820  $url = wfAppendQuery( $feedTemplate, $theseParams );
821  $this->getOutput()->addFeedLink( $format, $url );
822  }
823  }
824 
833  public function addHelpLink( $to, $overrideBaseUrl = false ) {
834  if ( $this->including() ) {
835  return;
836  }
837 
838  $msg = $this->msg(
839  MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
840  '-helppage' );
841 
842  if ( !$msg->isDisabled() ) {
843  $helpUrl = Skin::makeUrl( $msg->plain() );
844  $this->getOutput()->addHelpLink( $helpUrl, true );
845  } else {
846  $this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
847  }
848  }
849 
858  public function getFinalGroupName() {
859  $name = $this->getName();
860 
861  // Allow overriding the group from the wiki side
862  $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
863  if ( !$msg->isBlank() ) {
864  $group = $msg->text();
865  } else {
866  // Than use the group from this object
867  $group = $this->getGroupName();
868  }
869 
870  return $group;
871  }
872 
879  public function doesWrites() {
880  return false;
881  }
882 
891  protected function getGroupName() {
892  return 'other';
893  }
894 
899  protected function useTransactionalTimeLimit() {
900  if ( $this->getRequest()->wasPosted() ) {
902  }
903  }
904 
909  public function getLinkRenderer() {
910  if ( $this->linkRenderer ) {
911  return $this->linkRenderer;
912  } else {
913  return MediaWikiServices::getInstance()->getLinkRenderer();
914  }
915  }
916 
922  $this->linkRenderer = $linkRenderer;
923  }
924 
935  protected function buildPrevNextNavigation( $offset, $limit,
936  array $query = [], $atend = false, $subpage = false
937  ) {
938  $lang = $this->getLanguage();
939 
940  # Make 'previous' link
941  $prev = $this->msg( 'prevn' )->numParams( $limit )->text();
942  if ( $offset > 0 ) {
943  $plink = $this->numLink( max( $offset - $limit, 0 ), $limit, $query,
944  $prev, 'prevn-title', 'mw-prevlink', $subpage );
945  } else {
946  $plink = htmlspecialchars( $prev );
947  }
948 
949  # Make 'next' link
950  $next = $this->msg( 'nextn' )->numParams( $limit )->text();
951  if ( $atend ) {
952  $nlink = htmlspecialchars( $next );
953  } else {
954  $nlink = $this->numLink( $offset + $limit, $limit,
955  $query, $next, 'nextn-title', 'mw-nextlink', $subpage );
956  }
957 
958  # Make links to set number of items per page
959  $numLinks = [];
960  foreach ( [ 20, 50, 100, 250, 500 ] as $num ) {
961  $numLinks[] = $this->numLink( $offset, $num, $query,
962  $lang->formatNum( $num ), 'shown-title', 'mw-numlink', $subpage );
963  }
964 
965  return $this->msg( 'viewprevnext' )->rawParams( $plink, $nlink, $lang->pipeList( $numLinks ) )->
966  escaped();
967  }
968 
981  private function numLink( $offset, $limit, array $query, $link,
982  $tooltipMsg, $class, $subpage = false
983  ) {
984  $query = [ 'limit' => $limit, 'offset' => $offset ] + $query;
985  $tooltip = $this->msg( $tooltipMsg )->numParams( $limit )->text();
986  $href = $this->getPageTitle( $subpage )->getLocalURL( $query );
987  return Html::element( 'a', [ 'href' => $href,
988  'title' => $tooltip, 'class' => $class ], $link );
989  }
990 }
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
Definition: SpecialPage.php:97
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))
run( $subPage)
Entry point.
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
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:1585
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
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 ...
if(!isset( $args[0])) $lang
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:53
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:1696
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. '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:1980
isListed()
Whether this special page is listed in Special:SpecialPages.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3050
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:50
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:780
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:220
IContextSource $mContext
Current request context.
Definition: SpecialPage.php:61
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:3730
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:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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:82
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:4936
isCached()
Is this page cached? Expensive pages are cached or disabled in miser mode.
static makeUrl( $name, $urlaction='')
Definition: Skin.php:1191
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:617
execute( $subPage)
Default execute method Checks user permissions.
getTitle( $subpage=false)
Get a self-referential title object.
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.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
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:2633
checkLoginSecurityLevel( $level=null)
Verifies that the user meets the security level, possibly reauthenticating them in the process...
numLink( $offset, $limit, array $query, $link, $tooltipMsg, $class, $subpage=false)
Helper function for buildPrevNextNavigation() that generates links.
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:2633
static newFromTitleValue(TitleValue $titleValue, $forceClone='')
Returns a Title given a TitleValue.
Definition: Title.php:256
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:1473
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:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319