MediaWiki REL1_32
SpecialRandompage.php
Go to the documentation of this file.
1<?php
26
32class RandomPage extends SpecialPage {
33 private $namespaces; // namespaces to select pages from
34 protected $isRedir = false; // should the result be a redirect?
35 protected $extra = []; // Extra SQL statements
36
37 public function __construct( $name = 'Randompage' ) {
38 $this->namespaces = MWNamespace::getContentNamespaces();
39 parent::__construct( $name );
40 }
41
42 public function getNamespaces() {
43 return $this->namespaces;
44 }
45
46 public function setNamespace( $ns ) {
47 if ( !$ns || $ns < NS_MAIN ) {
48 $ns = NS_MAIN;
49 }
50 $this->namespaces = [ $ns ];
51 }
52
53 // select redirects instead of normal pages?
54 public function isRedirect() {
55 return $this->isRedir;
56 }
57
58 public function execute( $par ) {
59 if ( is_string( $par ) ) {
60 // Testing for stringiness since we want to catch
61 // the empty string to mean main namespace only.
62 $this->setNamespace(
63 MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex( $par ) );
64 }
65
66 $title = $this->getRandomTitle();
67
68 if ( is_null( $title ) ) {
69 $this->setHeaders();
70 // Message: randompage-nopages, randomredirect-nopages
71 $this->getOutput()->addWikiMsg( strtolower( $this->getName() ) . '-nopages',
72 $this->getNsList(), count( $this->namespaces ) );
73
74 return;
75 }
76
77 $redirectParam = $this->isRedirect() ? [ 'redirect' => 'no' ] : [];
78 $query = array_merge( $this->getRequest()->getValues(), $redirectParam );
79 unset( $query['title'] );
80 $this->getOutput()->redirect( $title->getFullURL( $query ) );
81 }
82
88 private function getNsList() {
89 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
90 $nsNames = [];
91 foreach ( $this->namespaces as $n ) {
92 if ( $n === NS_MAIN ) {
93 $nsNames[] = $this->msg( 'blanknamespace' )->plain();
94 } else {
95 $nsNames[] = $contLang->getNsText( $n );
96 }
97 }
98
99 return $contLang->commaList( $nsNames );
100 }
101
106 public function getRandomTitle() {
107 $randstr = wfRandom();
108 $title = null;
109
110 if ( !Hooks::run(
111 'SpecialRandomGetRandomTitle',
112 [ &$randstr, &$this->isRedir, &$this->namespaces, &$this->extra, &$title ]
113 ) ) {
114 return $title;
115 }
116
117 $row = $this->selectRandomPageFromDB( $randstr );
118
119 /* If we picked a value that was higher than any in
120 * the DB, wrap around and select the page with the
121 * lowest value instead! One might think this would
122 * skew the distribution, but in fact it won't cause
123 * any more bias than what the page_random scheme
124 * causes anyway. Trust me, I'm a mathematician. :)
125 */
126 if ( !$row ) {
127 $row = $this->selectRandomPageFromDB( "0" );
128 }
129
130 if ( $row ) {
131 return Title::makeTitleSafe( $row->page_namespace, $row->page_title );
132 }
133
134 return null;
135 }
136
137 protected function getQueryInfo( $randstr ) {
138 $redirect = $this->isRedirect() ? 1 : 0;
139 $tables = [ 'page' ];
140 $conds = array_merge( [
141 'page_namespace' => $this->namespaces,
142 'page_is_redirect' => $redirect,
143 'page_random >= ' . $randstr
144 ], $this->extra );
145 $joinConds = [];
146
147 // Allow extensions to modify the query
148 Hooks::run( 'RandomPageQuery', [ &$tables, &$conds, &$joinConds ] );
149
150 return [
151 'tables' => $tables,
152 'fields' => [ 'page_title', 'page_namespace' ],
153 'conds' => $conds,
154 'options' => [
155 'ORDER BY' => 'page_random',
156 'LIMIT' => 1,
157 ],
158 'join_conds' => $joinConds
159 ];
160 }
161
162 private function selectRandomPageFromDB( $randstr, $fname = __METHOD__ ) {
164
165 $query = $this->getQueryInfo( $randstr );
166 $res = $dbr->select(
167 $query['tables'],
168 $query['fields'],
169 $query['conds'],
170 $fname,
171 $query['options'],
172 $query['join_conds']
173 );
174
175 return $dbr->fetchObject( $res );
176 }
177
178 protected function getGroupName() {
179 return 'redirects';
180 }
181}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
to move a page</td >< td > &*You are moving the page across namespaces
wfRandom()
Get a random decimal value between 0 and 1, in a way not likely to give duplicate values for any real...
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition Setup.php:121
MediaWikiServices is the service locator for the application scope of MediaWiki.
Special page to direct the user to a random page.
getNsList()
Get a comma-delimited list of namespaces we don't have any pages in.
getRandomTitle()
Choose a random title.
getQueryInfo( $randstr)
__construct( $name='Randompage')
selectRandomPageFromDB( $randstr, $fname=__METHOD__)
execute( $par)
Default execute method Checks user permissions.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Parent class for all special pages.
getName()
Get the name of this Special Page.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
$res
Definition database.txt:21
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
const NS_MAIN
Definition Defines.php:64
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
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:1035
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
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:1656
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
const DB_REPLICA
Definition defines.php:25