Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7427192
SpecialRandomPage.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
SpecialRandomPage.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace
MediaWiki\Specials
;
use
MediaWiki\SpecialPage\SpecialPage
;
use
MediaWiki\Title\NamespaceInfo
;
use
MediaWiki\Title\Title
;
use
Wikimedia\Rdbms\IConnectionProvider
;
/**
* Redirect to a random page
*
* @ingroup SpecialPage
* @author Rob Church <robchur@gmail.com>, Ilmari Karonen
*/
class
SpecialRandomPage
extends
SpecialPage
{
/** @var int[] namespaces to select pages from */
private
$namespaces
;
/** @var bool should the result be a redirect? */
protected
$isRedir
=
false
;
/** @var array Extra SQL statements */
protected
$extra
=
[];
private
IConnectionProvider
$dbProvider
;
public
function
__construct
(
IConnectionProvider
$dbProvider
,
NamespaceInfo
$nsInfo
)
{
parent
::
__construct
(
'Randompage'
);
$this
->
dbProvider
=
$dbProvider
;
$this
->
namespaces
=
$nsInfo
->
getContentNamespaces
();
}
/**
* @return int[]
*/
public
function
getNamespaces
()
{
return
$this
->
namespaces
;
}
/**
* @param int|false $ns
*/
public
function
setNamespace
(
$ns
)
{
if
(
!
$this
->
isValidNS
(
$ns
)
)
{
$ns
=
NS_MAIN
;
}
$this
->
namespaces
=
[
$ns
];
}
/**
* @param int|false $ns
*/
private
function
isValidNS
(
$ns
):
bool
{
return
$ns
!==
false
&&
$ns
>=
0
;
}
/**
* select redirects instead of normal pages?
* @return bool
*/
public
function
isRedirect
()
{
return
$this
->
isRedir
;
}
/** @inheritDoc */
public
function
execute
(
$par
)
{
$this
->
parsePar
(
$par
);
$title
=
$this
->
getRandomTitle
();
if
(
$title
===
null
)
{
$this
->
setHeaders
();
// Message: randompage-nopages, randomredirect-nopages
$this
->
getOutput
()->
addWikiMsg
(
strtolower
(
$this
->
getName
()
)
.
'-nopages'
,
$this
->
getNsList
(),
count
(
$this
->
namespaces
)
);
return
;
}
$redirectParam
=
$this
->
isRedirect
()
?
[
'redirect'
=>
'no'
]
:
[];
$query
=
array_merge
(
$this
->
getRequest
()->
getQueryValues
(),
$redirectParam
);
unset
(
$query
[
'title'
]
);
$this
->
getOutput
()->
redirect
(
$title
->
getFullURL
(
$query
)
);
}
/**
* Parse the subpage parameter that specifies namespaces
*
* @param string $par Subpage to special page
*/
private
function
parsePar
(
$par
)
{
// Testing for stringiness since we want to catch
// the empty string to mean main namespace only.
if
(
is_string
(
$par
)
)
{
$ns
=
$this
->
getContentLanguage
()->
getNsIndex
(
$par
);
if
(
$ns
===
false
&&
str_contains
(
$par
,
','
)
)
{
$nsList
=
[];
// Comma separated list
$parSplit
=
explode
(
','
,
$par
);
foreach
(
$parSplit
as
$potentialNs
)
{
$ns
=
$this
->
getContentLanguage
()->
getNsIndex
(
$potentialNs
);
if
(
$this
->
isValidNS
(
$ns
)
)
{
$nsList
[]
=
$ns
;
}
// Remove duplicate values, and re-index array
$nsList
=
array_unique
(
$nsList
);
$nsList
=
array_values
(
$nsList
);
if
(
$nsList
!==
[]
)
{
$this
->
namespaces
=
$nsList
;
}
}
}
else
{
// Note, that the case of $par being something
// like "main" which is not a namespace, falls
// through to here, and sets NS_MAIN, allowing
// Special:Random/main or Special:Random/article
// to work as expected.
$this
->
setNamespace
(
$this
->
getContentLanguage
()->
getNsIndex
(
$par
)
);
}
}
}
/**
* Get a comma-delimited list of namespaces we don't have
* any pages in
* @return string
*/
private
function
getNsList
()
{
$contLang
=
$this
->
getContentLanguage
();
$nsNames
=
[];
foreach
(
$this
->
namespaces
as
$n
)
{
if
(
$n
===
NS_MAIN
)
{
$nsNames
[]
=
$this
->
msg
(
'blanknamespace'
)->
plain
();
}
else
{
$nsNames
[]
=
$contLang
->
getNsText
(
$n
);
}
}
return
$contLang
->
commaList
(
$nsNames
);
}
/**
* Choose a random title.
* @return Title|null Title object (or null if nothing to choose from)
*/
public
function
getRandomTitle
()
{
$randstr
=
wfRandom
();
$title
=
null
;
if
(
!
$this
->
getHookRunner
()->
onSpecialRandomGetRandomTitle
(
$randstr
,
$this
->
isRedir
,
$this
->
namespaces
,
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$this
->
extra
,
$title
)
)
{
return
$title
;
}
$row
=
$this
->
selectRandomPageFromDB
(
$randstr
,
__METHOD__
);
/* If we picked a value that was higher than any in
* the DB, wrap around and select the page with the
* lowest value instead! One might think this would
* skew the distribution, but in fact it won't cause
* any more bias than what the page_random scheme
* causes anyway. Trust me, I'm a mathematician. :)
*/
if
(
!
$row
)
{
$row
=
$this
->
selectRandomPageFromDB
(
0
,
__METHOD__
);
}
if
(
$row
)
{
return
Title
::
makeTitleSafe
(
$row
->
page_namespace
,
$row
->
page_title
);
}
return
null
;
}
/**
* @param string $randstr
* @return array
*/
protected
function
getQueryInfo
(
$randstr
)
{
$dbr
=
$this
->
dbProvider
->
getReplicaDatabase
();
$redirect
=
$this
->
isRedirect
()
?
1
:
0
;
$tables
=
[
'page'
];
$conds
=
[
'page_namespace'
=>
$this
->
namespaces
,
'page_is_redirect'
=>
$redirect
,
$dbr
->
expr
(
'page_random'
,
'>='
,
$randstr
),
...
$this
->
extra
,
];
$joinConds
=
[];
// Allow extensions to modify the query
$this
->
getHookRunner
()->
onRandomPageQuery
(
$tables
,
$conds
,
$joinConds
);
return
[
'tables'
=>
$tables
,
'fields'
=>
[
'page_title'
,
'page_namespace'
],
'conds'
=>
$conds
,
'options'
=>
[
'ORDER BY'
=>
'page_random'
,
'LIMIT'
=>
1
,
],
'join_conds'
=>
$joinConds
];
}
/**
* @param int|string $randstr
* @param string $fname
* @return \stdClass|false
*/
private
function
selectRandomPageFromDB
(
$randstr
,
string
$fname
)
{
$dbr
=
$this
->
dbProvider
->
getReplicaDatabase
();
$query
=
$this
->
getQueryInfo
(
$randstr
);
return
$dbr
->
newSelectQueryBuilder
()
->
queryInfo
(
$query
)
->
caller
(
$fname
)
->
fetchRow
();
}
/** @inheritDoc */
protected
function
getGroupName
()
{
return
'redirects'
;
}
}
/**
* Retain the old class name for backwards compatibility.
* @deprecated since 1.41
*/
class_alias
(
SpecialRandomPage
::
class
,
'SpecialRandomPage'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 08:50 (17 h, 18 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
68/e5/5b788dc017dfb246980c6407b4fc
Default Alt Text
SpecialRandomPage.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment