MediaWiki  master
SpecialShortpages.php
Go to the documentation of this file.
1 <?php
26 
33 class ShortPagesPage extends QueryPage {
34 
35  function __construct( $name = 'Shortpages' ) {
36  parent::__construct( $name );
37  }
38 
39  function isSyndicated() {
40  return false;
41  }
42 
43  public function getQueryInfo() {
44  $config = $this->getConfig();
45  $blacklist = $config->get( 'ShortPagesNamespaceBlacklist' );
46  $tables = [ 'page' ];
47  $conds = [
48  'page_namespace' => array_diff( MWNamespace::getContentNamespaces(), $blacklist ),
49  'page_is_redirect' => 0
50  ];
51  $joinConds = [];
52  $options = [ 'USE INDEX' => [ 'page' => 'page_redirect_namespace_len' ] ];
53 
54  // Allow extensions to modify the query
55  Hooks::run( 'ShortPagesQuery', [ &$tables, &$conds, &$joinConds, &$options ] );
56 
57  return [
58  'tables' => $tables,
59  'fields' => [
60  'namespace' => 'page_namespace',
61  'title' => 'page_title',
62  'value' => 'page_len'
63  ],
64  'conds' => $conds,
65  'join_conds' => $joinConds,
66  'options' => $options
67  ];
68  }
69 
70  public function reallyDoQuery( $limit, $offset = false ) {
71  $fname = static::class . '::reallyDoQuery';
72  $dbr = $this->getRecacheDB();
73  $query = $this->getQueryInfo();
74  $order = $this->getOrderFields();
75 
76  if ( $this->sortDescending() ) {
77  foreach ( $order as &$field ) {
78  $field .= ' DESC';
79  }
80  }
81 
82  $tables = isset( $query['tables'] ) ? (array)$query['tables'] : [];
83  $fields = isset( $query['fields'] ) ? (array)$query['fields'] : [];
84  $conds = isset( $query['conds'] ) ? (array)$query['conds'] : [];
85  $options = isset( $query['options'] ) ? (array)$query['options'] : [];
86  $join_conds = isset( $query['join_conds'] ) ? (array)$query['join_conds'] : [];
87 
88  if ( $limit !== false ) {
89  $options['LIMIT'] = intval( $limit );
90  }
91 
92  if ( $offset !== false ) {
93  $options['OFFSET'] = intval( $offset );
94  }
95 
96  $namespaces = $conds['page_namespace'];
97  if ( count( $namespaces ) === 1 ) {
98  $options['ORDER BY'] = $order;
99  $res = $dbr->select( $tables, $fields, $conds, $fname,
100  $options, $join_conds
101  );
102  } else {
103  unset( $conds['page_namespace'] );
104  $options['INNER ORDER BY'] = $order;
105  $options['ORDER BY'] = [ 'value' . ( $this->sortDescending() ? ' DESC' : '' ) ];
106  $sql = $dbr->unionConditionPermutations(
107  $tables,
108  $fields,
109  [ 'page_namespace' => $namespaces ],
110  $conds,
111  $fname,
112  $options,
113  $join_conds
114  );
115  $res = $dbr->query( $sql, $fname );
116  }
117 
118  return $res;
119  }
120 
121  function getOrderFields() {
122  return [ 'page_len' ];
123  }
124 
129  function preprocessResults( $db, $res ) {
131  }
132 
133  function sortDescending() {
134  return false;
135  }
136 
142  function formatResult( $skin, $result ) {
143  $dm = $this->getLanguage()->getDirMark();
144 
145  $title = Title::makeTitleSafe( $result->namespace, $result->title );
146  if ( !$title ) {
147  return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
148  Linker::getInvalidTitleDescription( $this->getContext(), $result->namespace, $result->title ) );
149  }
150 
151  $linkRenderer = $this->getLinkRenderer();
152  $hlink = $linkRenderer->makeKnownLink(
153  $title,
154  $this->msg( 'hist' )->text(),
155  [],
156  [ 'action' => 'history' ]
157  );
158  $hlinkInParentheses = $this->msg( 'parentheses' )->rawParams( $hlink )->escaped();
159 
160  if ( $this->isCached() ) {
161  $plink = $linkRenderer->makeLink( $title );
162  $exists = $title->exists();
163  } else {
164  $plink = $linkRenderer->makeKnownLink( $title );
165  $exists = true;
166  }
167 
168  $size = $this->msg( 'nbytes' )->numParams( $result->value )->escaped();
169 
170  return $exists
171  ? "${hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]"
172  : "<del>${hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]</del>";
173  }
174 
175  protected function getGroupName() {
176  return 'maintenance';
177  }
178 }
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))
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:1599
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
getContext()
Gets the context this SpecialPage is executed in.
SpecialShortpages extends QueryPage.
reallyDoQuery( $limit, $offset=false)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
isCached()
Whether or not the output of the page in question is retrieved from the database cache.
Definition: QueryPage.php:227
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
this hook is for auditing only 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 & $tables
Definition: hooks.txt:990
__construct( $name='Shortpages')
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:1994
This is a class for doing query pages; since they&#39;re almost all the same, we factor out some of the f...
Definition: QueryPage.php:35
getRecacheDB()
Get a DB connection to be used for slow recache queries.
Definition: QueryPage.php:383
$res
Definition: database.txt:21
formatResult( $skin, $result)
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 & $options
Definition: hooks.txt:1996
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:40
static getContentNamespaces()
Get a list of all namespace indices which are considered to contain content.
preprocessResults( $db, $res)
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:936
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 $skin
Definition: hooks.txt:1996
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:936
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
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:121
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:573
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
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
getConfig()
Shortcut to get main config object.
int $limit
Definition: QueryPage.php:43
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:276
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
Definition: Linker.php:186
executeLBFromResultWrapper(IResultWrapper $res, $ns=null)
Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and ...
Definition: QueryPage.php:860
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