3 * Implements Special:Newpages
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * A special page that list newly created pages
27 * @ingroup SpecialPage
29 class SpecialNewpages
extends IncludableSpecialPage
{
34 protected $customFilters;
36 protected $showNavigation = false;
38 public function __construct() {
39 parent
::__construct( 'Newpages' );
43 * @param string|null $par
45 protected function setup( $par ) {
46 $opts = new FormOptions();
47 $this->opts
= $opts; // bind
48 $opts->add( 'hideliu', false );
49 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
50 $opts->add( 'hidebots', false );
51 $opts->add( 'hideredirs', true );
52 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
53 $opts->add( 'offset', '' );
54 $opts->add( 'namespace', '0' );
55 $opts->add( 'username', '' );
56 $opts->add( 'feed', '' );
57 $opts->add( 'tagfilter', '' );
58 $opts->add( 'invert', false );
59 $opts->add( 'associated', false );
60 $opts->add( 'size-mode', 'max' );
61 $opts->add( 'size', 0 );
63 $this->customFilters
= [];
64 Hooks
::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters
] );
65 foreach ( $this->customFilters
as $key => $params ) {
66 $opts->add( $key, $params['default'] );
69 $opts->fetchValuesFromRequest( $this->getRequest() );
71 $this->parseParams( $par );
74 $opts->validateIntBounds( 'limit', 0, 5000 );
80 protected function parseParams( $par ) {
81 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
82 foreach ( $bits as $bit ) {
83 if ( $bit === 'shownav' ) {
84 $this->showNavigation
= true;
86 if ( $bit === 'hideliu' ) {
87 $this->opts
->setValue( 'hideliu', true );
89 if ( $bit === 'hidepatrolled' ) {
90 $this->opts
->setValue( 'hidepatrolled', true );
92 if ( $bit === 'hidebots' ) {
93 $this->opts
->setValue( 'hidebots', true );
95 if ( $bit === 'showredirs' ) {
96 $this->opts
->setValue( 'hideredirs', false );
98 if ( is_numeric( $bit ) ) {
99 $this->opts
->setValue( 'limit', intval( $bit ) );
103 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
104 $this->opts
->setValue( 'limit', intval( $m[1] ) );
106 // PG offsets not just digits!
107 if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
108 $this->opts
->setValue( 'offset', intval( $m[1] ) );
110 if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
111 $this->opts
->setValue( 'username', $m[1] );
113 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
114 $ns = $this->getLanguage()->getNsIndex( $m[1] );
115 if ( $ns !== false ) {
116 $this->opts
->setValue( 'namespace', $ns );
123 * Show a form for filtering namespace and username
125 * @param string|null $par
127 public function execute( $par ) {
128 $out = $this->getOutput();
131 $this->outputHeader();
133 $this->showNavigation
= !$this->including(); // Maybe changed in setup
134 $this->setup( $par );
136 $this->addHelpLink( 'Help:New pages' );
138 if ( !$this->including() ) {
142 $feedType = $this->opts
->getValue( 'feed' );
144 $this->feed( $feedType );
149 $allValues = $this->opts
->getAllValues();
150 unset( $allValues['feed'] );
151 $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
154 $pager = new NewPagesPager( $this, $this->opts
);
155 $pager->mLimit
= $this->opts
->getValue( 'limit' );
156 $pager->mOffset
= $this->opts
->getValue( 'offset' );
158 if ( $pager->getNumRows() ) {
160 if ( $this->showNavigation
) {
161 $navigation = $pager->getNavigationBar();
163 $out->addHTML( $navigation . $pager->getBody() . $navigation );
164 // Add styles for change tags
165 $out->addModuleStyles( 'mediawiki.interface.helpers.styles' );
167 $out->addWikiMsg( 'specialpage-empty' );
171 protected function filterLinks() {
173 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
175 // Option value -> message mapping
177 'hideliu' => 'rcshowhideliu',
178 'hidepatrolled' => 'rcshowhidepatr',
179 'hidebots' => 'rcshowhidebots',
180 'hideredirs' => 'whatlinkshere-hideredirs'
182 foreach ( $this->customFilters
as $key => $params ) {
183 $filters[$key] = $params['msg'];
186 // Disable some if needed
187 if ( !User
::groupHasPermission( '*', 'createpage' ) ) {
188 unset( $filters['hideliu'] );
190 if ( !$this->getUser()->useNPPatrol() ) {
191 unset( $filters['hidepatrolled'] );
195 $changed = $this->opts
->getChangedValues();
196 unset( $changed['offset'] ); // Reset offset if query type changes
198 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
199 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
201 // Also do this only for boolean options, not eg. namespace or tagfilter
202 foreach ( $changed as $key => $value ) {
203 if ( array_key_exists( $key, $filters ) ) {
204 $changed[$key] = $changed[$key] ?
'1' : '0';
208 $self = $this->getPageTitle();
209 $linkRenderer = $this->getLinkRenderer();
210 foreach ( $filters as $key => $msg ) {
211 $onoff = 1 - $this->opts
->getValue( $key );
212 $link = $linkRenderer->makeLink(
214 new HtmlArmor( $showhide[$onoff] ),
216 [ $key => $onoff ] +
$changed
218 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
221 return $this->getLanguage()->pipeList( $links );
224 protected function form() {
225 $out = $this->getOutput();
228 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
229 $namespace = $this->opts
->consumeValue( 'namespace' );
230 $username = $this->opts
->consumeValue( 'username' );
231 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
232 $nsinvert = $this->opts
->consumeValue( 'invert' );
233 $nsassociated = $this->opts
->consumeValue( 'associated' );
235 $size = $this->opts
->consumeValue( 'size' );
236 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
238 // Check username input validity
239 $ut = Title
::makeTitleSafe( NS_USER
, $username );
240 $userText = $ut ?
$ut->getText() : '';
244 'type' => 'namespaceselect',
245 'name' => 'namespace',
246 'label-message' => 'namespace',
247 'default' => $namespace,
252 'label-message' => 'invert',
253 'default' => $nsinvert,
254 'tooltip' => 'invert',
258 'name' => 'associated',
259 'label-message' => 'namespace_association',
260 'default' => $nsassociated,
261 'tooltip' => 'namespace_association',
264 'type' => 'tagfilter',
265 'name' => 'tagfilter',
266 'label-raw' => $this->msg( 'tag-filter' )->parse(),
267 'default' => $tagFilterVal,
271 'name' => 'username',
272 'label-message' => 'newpages-username',
273 'default' => $userText,
274 'id' => 'mw-np-username',
278 'type' => 'sizefilter',
280 'default' => -$max * $size,
284 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
286 // Store query values in hidden fields so that form submission doesn't lose them
287 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
288 $htmlForm->addHiddenField( $key, $value );
293 ->setFormIdentifier( 'newpagesform' )
294 // The form should be visible on each request (inclusive requests with submitted forms), so
295 // return always false here.
301 ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
302 ->setWrapperLegend( $this->msg( 'newpages' )->text() )
303 ->addFooterText( Html
::rawElement(
309 $out->addModuleStyles( 'mediawiki.special' );
313 * @param stdClass $result Result row from recent changes
314 * @param Title $title
315 * @return bool|Revision
317 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
318 return new Revision( [
319 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
320 'deleted' => $result->rc_deleted
,
321 'user_text' => $result->rc_user_text
,
322 'user' => $result->rc_user
,
323 'actor' => $result->rc_actor
,
328 * Format a row, providing the timestamp, links to the page/history,
329 * size, user links, and a comment
331 * @param object $result Result row
334 public function formatRow( $result ) {
335 $title = Title
::newFromRow( $result );
337 // Revision deletion works on revisions,
338 // so cast our recent change row to a revision row.
339 $rev = $this->revisionFromRcResult( $result, $title );
342 $attribs = [ 'data-mw-revid' => $result->rev_id
];
344 $lang = $this->getLanguage();
345 $dm = $lang->getDirMark();
347 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
348 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
350 $linkRenderer = $this->getLinkRenderer();
351 $time = $linkRenderer->makeKnownLink(
353 new HtmlArmor( $spanTime ),
355 [ 'oldid' => $result->rc_this_oldid
]
358 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
360 $plink = $linkRenderer->makeKnownLink(
363 [ 'class' => 'mw-newpages-pagename' ],
366 $histLink = $linkRenderer->makeKnownLink(
368 $this->msg( 'hist' )->text(),
370 [ 'action' => 'history' ]
372 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
373 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
375 $length = Html
::rawElement(
377 [ 'class' => 'mw-newpages-length' ],
378 $this->msg( 'brackets' )->rawParams(
379 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
383 $ulink = Linker
::revUserTools( $rev );
384 $comment = Linker
::revComment( $rev );
386 if ( $this->patrollable( $result ) ) {
387 $classes[] = 'not-patrolled';
390 # Add a class for zero byte pages
391 if ( $result->length
== 0 ) {
392 $classes[] = 'mw-newpages-zero-byte-page';
396 if ( isset( $result->ts_tags
) ) {
397 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
402 $classes = array_merge( $classes, $newClasses );
407 # Display the old title if the namespace/title has been changed
409 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
411 if ( !$title->equals( $oldTitle ) ) {
412 $oldTitleText = $oldTitle->getPrefixedText();
413 $oldTitleText = Html
::rawElement(
415 [ 'class' => 'mw-newpages-oldtitle' ],
416 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
420 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
421 . "{$tagDisplay} {$oldTitleText}";
423 // Let extensions add data
424 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
425 $attribs = array_filter( $attribs,
426 [ Sanitizer
::class, 'isReservedDataAttribute' ],
430 if ( count( $classes ) ) {
431 $attribs['class'] = implode( ' ', $classes );
434 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
438 * Should a specific result row provide "patrollable" links?
440 * @param object $result Result row
443 protected function patrollable( $result ) {
444 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
448 * Output a subscription feed listing recent edits to this page.
450 * @param string $type
452 protected function feed( $type ) {
453 if ( !$this->getConfig()->get( 'Feed' ) ) {
454 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
459 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
460 if ( !isset( $feedClasses[$type] ) ) {
461 $this->getOutput()->addWikiMsg( 'feed-invalid' );
466 $feed = new $feedClasses[$type](
468 $this->msg( 'tagline' )->text(),
469 $this->getPageTitle()->getFullURL()
472 $pager = new NewPagesPager( $this, $this->opts
);
473 $limit = $this->opts
->getValue( 'limit' );
474 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
477 if ( $pager->getNumRows() > 0 ) {
478 foreach ( $pager->mResult
as $row ) {
479 $feed->outItem( $this->feedItem( $row ) );
485 protected function feedTitle() {
486 $desc = $this->getDescription();
487 $code = $this->getConfig()->get( 'LanguageCode' );
488 $sitename = $this->getConfig()->get( 'Sitename' );
490 return "$sitename - $desc [$code]";
493 protected function feedItem( $row ) {
494 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
496 $date = $row->rc_timestamp
;
497 $comments = $title->getTalkPage()->getFullURL();
500 $title->getPrefixedText(),
501 $this->feedItemDesc( $row ),
502 $title->getFullURL(),
504 $this->feedItemAuthor( $row ),
512 protected function feedItemAuthor( $row ) {
513 return $row->rc_user_text ??
'';
516 protected function feedItemDesc( $row ) {
517 $revision = Revision
::newFromId( $row->rev_id
);
522 $content = $revision->getContent();
523 if ( $content === null ) {
527 // XXX: include content model/type in feed item?
528 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
529 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
530 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
531 "</p>\n<hr />\n<div>" .
532 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
535 protected function getGroupName() {
539 protected function getCacheTTL() {