Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
27.50% covered (danger)
27.50%
22 / 80
41.67% covered (danger)
41.67%
5 / 12
CRAP
0.00% covered (danger)
0.00%
0 / 1
SpecialRandomPage
27.85% covered (danger)
27.85%
22 / 79
41.67% covered (danger)
41.67%
5 / 12
322.48
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 getNamespaces
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setNamespace
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
 isValidNS
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 isRedirect
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 execute
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
12
 parsePar
100.00% covered (success)
100.00%
14 / 14
100.00% covered (success)
100.00%
1 / 1
7
 getNsList
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
12
 getRandomTitle
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
20
 getQueryInfo
0.00% covered (danger)
0.00%
0 / 19
0.00% covered (danger)
0.00%
0 / 1
6
 selectRandomPageFromDB
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 getGroupName
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21namespace MediaWiki\Specials;
22
23use MediaWiki\SpecialPage\SpecialPage;
24use MediaWiki\Title\NamespaceInfo;
25use MediaWiki\Title\Title;
26use Wikimedia\Rdbms\IConnectionProvider;
27
28/**
29 * Redirect to a random page
30 *
31 * @ingroup SpecialPage
32 * @author Rob Church <robchur@gmail.com>, Ilmari Karonen
33 */
34class SpecialRandomPage extends SpecialPage {
35    private $namespaces; // namespaces to select pages from
36    protected $isRedir = false; // should the result be a redirect?
37    protected $extra = []; // Extra SQL statements
38
39    private IConnectionProvider $dbProvider;
40
41    /**
42     * @param IConnectionProvider $dbProvider
43     * @param NamespaceInfo $nsInfo
44     */
45    public function __construct(
46        IConnectionProvider $dbProvider,
47        NamespaceInfo $nsInfo
48    ) {
49        parent::__construct( 'Randompage' );
50        $this->dbProvider = $dbProvider;
51        $this->namespaces = $nsInfo->getContentNamespaces();
52    }
53
54    public function getNamespaces() {
55        return $this->namespaces;
56    }
57
58    public function setNamespace( $ns ) {
59        if ( !$this->isValidNS( $ns ) ) {
60            $ns = NS_MAIN;
61        }
62        $this->namespaces = [ $ns ];
63    }
64
65    private function isValidNS( $ns ) {
66        return $ns !== false && $ns >= 0;
67    }
68
69    // select redirects instead of normal pages?
70    public function isRedirect() {
71        return $this->isRedir;
72    }
73
74    public function execute( $par ) {
75        $this->parsePar( $par );
76
77        $title = $this->getRandomTitle();
78
79        if ( $title === null ) {
80            $this->setHeaders();
81            // Message: randompage-nopages, randomredirect-nopages
82            $this->getOutput()->addWikiMsg( strtolower( $this->getName() ) . '-nopages',
83                $this->getNsList(), count( $this->namespaces ) );
84
85            return;
86        }
87
88        $redirectParam = $this->isRedirect() ? [ 'redirect' => 'no' ] : [];
89        $query = array_merge( $this->getRequest()->getValues(), $redirectParam );
90        unset( $query['title'] );
91        $this->getOutput()->redirect( $title->getFullURL( $query ) );
92    }
93
94    /**
95     * Parse the subpage parameter that specifies namespaces
96     *
97     * @param string $par Subpage to special page
98     */
99    private function parsePar( $par ) {
100        // Testing for stringiness since we want to catch
101        // the empty string to mean main namespace only.
102        if ( is_string( $par ) ) {
103            $ns = $this->getContentLanguage()->getNsIndex( $par );
104            if ( $ns === false && strpos( $par, ',' ) !== false ) {
105                $nsList = [];
106                // Comma separated list
107                $parSplit = explode( ',', $par );
108                foreach ( $parSplit as $potentialNs ) {
109                    $ns = $this->getContentLanguage()->getNsIndex( $potentialNs );
110                    if ( $this->isValidNS( $ns ) ) {
111                        $nsList[] = $ns;
112                    }
113                    // Remove duplicate values, and re-index array
114                    $nsList = array_unique( $nsList );
115                    $nsList = array_values( $nsList );
116                    if ( $nsList !== [] ) {
117                        $this->namespaces = $nsList;
118                    }
119                }
120            } else {
121                // Note, that the case of $par being something
122                // like "main" which is not a namespace, falls
123                // through to here, and sets NS_MAIN, allowing
124                // Special:Random/main or Special:Random/article
125                // to work as expected.
126                $this->setNamespace( $this->getContentLanguage()->getNsIndex( $par ) );
127            }
128        }
129    }
130
131    /**
132     * Get a comma-delimited list of namespaces we don't have
133     * any pages in
134     * @return string
135     */
136    private function getNsList() {
137        $contLang = $this->getContentLanguage();
138        $nsNames = [];
139        foreach ( $this->namespaces as $n ) {
140            if ( $n === NS_MAIN ) {
141                $nsNames[] = $this->msg( 'blanknamespace' )->plain();
142            } else {
143                $nsNames[] = $contLang->getNsText( $n );
144            }
145        }
146
147        return $contLang->commaList( $nsNames );
148    }
149
150    /**
151     * Choose a random title.
152     * @return Title|null Title object (or null if nothing to choose from)
153     */
154    public function getRandomTitle() {
155        $randstr = wfRandom();
156        $title = null;
157
158        if ( !$this->getHookRunner()->onSpecialRandomGetRandomTitle(
159            $randstr, $this->isRedir, $this->namespaces,
160            // @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
161            $this->extra, $title )
162        ) {
163            return $title;
164        }
165
166        $row = $this->selectRandomPageFromDB( $randstr, __METHOD__ );
167
168        /* If we picked a value that was higher than any in
169         * the DB, wrap around and select the page with the
170         * lowest value instead!  One might think this would
171         * skew the distribution, but in fact it won't cause
172         * any more bias than what the page_random scheme
173         * causes anyway.  Trust me, I'm a mathematician. :)
174         */
175        if ( !$row ) {
176            $row = $this->selectRandomPageFromDB( "0", __METHOD__ );
177        }
178
179        if ( $row ) {
180            return Title::makeTitleSafe( $row->page_namespace, $row->page_title );
181        }
182
183        return null;
184    }
185
186    protected function getQueryInfo( $randstr ) {
187        $redirect = $this->isRedirect() ? 1 : 0;
188        $tables = [ 'page' ];
189        $conds = array_merge( [
190            'page_namespace' => $this->namespaces,
191            'page_is_redirect' => $redirect,
192            'page_random >= ' . $randstr
193        ], $this->extra );
194        $joinConds = [];
195
196        // Allow extensions to modify the query
197        $this->getHookRunner()->onRandomPageQuery( $tables, $conds, $joinConds );
198
199        return [
200            'tables' => $tables,
201            'fields' => [ 'page_title', 'page_namespace' ],
202            'conds' => $conds,
203            'options' => [
204                'ORDER BY' => 'page_random',
205                'LIMIT' => 1,
206            ],
207            'join_conds' => $joinConds
208        ];
209    }
210
211    private function selectRandomPageFromDB( $randstr, $fname = __METHOD__ ) {
212        $dbr = $this->dbProvider->getReplicaDatabase();
213
214        $query = $this->getQueryInfo( $randstr );
215        return $dbr->newSelectQueryBuilder()
216            ->queryInfo( $query )
217            ->caller( $fname )
218            ->fetchRow();
219    }
220
221    protected function getGroupName() {
222        return 'redirects';
223    }
224}
225
226/**
227 * Retain the old class name for backwards compatibility.
228 * @deprecated since 1.41
229 */
230class_alias( SpecialRandomPage::class, 'SpecialRandomPage' );