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( 'size-mode', 'max' );
60 $opts->add( 'size', 0 );
62 $this->customFilters
= [];
63 Hooks
::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters
] );
64 foreach ( $this->customFilters
as $key => $params ) {
65 $opts->add( $key, $params['default'] );
68 $opts->fetchValuesFromRequest( $this->getRequest() );
70 $this->parseParams( $par );
73 $opts->validateIntBounds( 'limit', 0, 5000 );
79 protected function parseParams( $par ) {
80 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
81 foreach ( $bits as $bit ) {
82 if ( $bit === 'shownav' ) {
83 $this->showNavigation
= true;
85 if ( $bit === 'hideliu' ) {
86 $this->opts
->setValue( 'hideliu', true );
88 if ( $bit === 'hidepatrolled' ) {
89 $this->opts
->setValue( 'hidepatrolled', true );
91 if ( $bit === 'hidebots' ) {
92 $this->opts
->setValue( 'hidebots', true );
94 if ( $bit === 'showredirs' ) {
95 $this->opts
->setValue( 'hideredirs', false );
97 if ( is_numeric( $bit ) ) {
98 $this->opts
->setValue( 'limit', intval( $bit ) );
102 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
103 $this->opts
->setValue( 'limit', intval( $m[1] ) );
105 // PG offsets not just digits!
106 if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
107 $this->opts
->setValue( 'offset', intval( $m[1] ) );
109 if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
110 $this->opts
->setValue( 'username', $m[1] );
112 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
113 $ns = $this->getLanguage()->getNsIndex( $m[1] );
114 if ( $ns !== false ) {
115 $this->opts
->setValue( 'namespace', $ns );
122 * Show a form for filtering namespace and username
124 * @param string|null $par
126 public function execute( $par ) {
127 $out = $this->getOutput();
130 $this->outputHeader();
132 $this->showNavigation
= !$this->including(); // Maybe changed in setup
133 $this->setup( $par );
135 $this->addHelpLink( 'Help:New pages' );
137 if ( !$this->including() ) {
141 $feedType = $this->opts
->getValue( 'feed' );
143 $this->feed( $feedType );
148 $allValues = $this->opts
->getAllValues();
149 unset( $allValues['feed'] );
150 $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
153 $pager = new NewPagesPager( $this, $this->opts
);
154 $pager->mLimit
= $this->opts
->getValue( 'limit' );
155 $pager->mOffset
= $this->opts
->getValue( 'offset' );
157 if ( $pager->getNumRows() ) {
159 if ( $this->showNavigation
) {
160 $navigation = $pager->getNavigationBar();
162 $out->addHTML( $navigation . $pager->getBody() . $navigation );
163 // Add styles for change tags
164 $out->addModuleStyles( 'mediawiki.interface.helpers.styles' );
166 $out->addWikiMsg( 'specialpage-empty' );
170 protected function filterLinks() {
172 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
174 // Option value -> message mapping
176 'hideliu' => 'rcshowhideliu',
177 'hidepatrolled' => 'rcshowhidepatr',
178 'hidebots' => 'rcshowhidebots',
179 'hideredirs' => 'whatlinkshere-hideredirs'
181 foreach ( $this->customFilters
as $key => $params ) {
182 $filters[$key] = $params['msg'];
185 // Disable some if needed
186 if ( !User
::groupHasPermission( '*', 'createpage' ) ) {
187 unset( $filters['hideliu'] );
189 if ( !$this->getUser()->useNPPatrol() ) {
190 unset( $filters['hidepatrolled'] );
194 $changed = $this->opts
->getChangedValues();
195 unset( $changed['offset'] ); // Reset offset if query type changes
197 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
198 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
200 // Also do this only for boolean options, not eg. namespace or tagfilter
201 foreach ( $changed as $key => $value ) {
202 if ( array_key_exists( $key, $filters ) ) {
203 $changed[$key] = $changed[$key] ?
'1' : '0';
207 $self = $this->getPageTitle();
208 $linkRenderer = $this->getLinkRenderer();
209 foreach ( $filters as $key => $msg ) {
210 $onoff = 1 - $this->opts
->getValue( $key );
211 $link = $linkRenderer->makeLink(
213 new HtmlArmor( $showhide[$onoff] ),
215 [ $key => $onoff ] +
$changed
217 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
220 return $this->getLanguage()->pipeList( $links );
223 protected function form() {
224 $out = $this->getOutput();
227 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
228 $namespace = $this->opts
->consumeValue( 'namespace' );
229 $username = $this->opts
->consumeValue( 'username' );
230 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
231 $nsinvert = $this->opts
->consumeValue( 'invert' );
233 $size = $this->opts
->consumeValue( 'size' );
234 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
236 // Check username input validity
237 $ut = Title
::makeTitleSafe( NS_USER
, $username );
238 $userText = $ut ?
$ut->getText() : '';
242 'type' => 'namespaceselect',
243 'name' => 'namespace',
244 'label-message' => 'namespace',
245 'default' => $namespace,
250 'label-message' => 'invert',
251 'default' => $nsinvert,
252 'tooltip' => 'invert',
255 'type' => 'tagfilter',
256 'name' => 'tagfilter',
257 'label-raw' => $this->msg( 'tag-filter' )->parse(),
258 'default' => $tagFilterVal,
262 'name' => 'username',
263 'label-message' => 'newpages-username',
264 'default' => $userText,
265 'id' => 'mw-np-username',
269 'type' => 'sizefilter',
271 'default' => -$max * $size,
275 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
277 // Store query values in hidden fields so that form submission doesn't lose them
278 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
279 $htmlForm->addHiddenField( $key, $value );
284 ->setFormIdentifier( 'newpagesform' )
285 // The form should be visible on each request (inclusive requests with submitted forms), so
286 // return always false here.
292 ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
293 ->setWrapperLegend( $this->msg( 'newpages' )->text() )
294 ->addFooterText( Html
::rawElement(
300 $out->addModuleStyles( 'mediawiki.special' );
304 * @param stdClass $result Result row from recent changes
305 * @param Title $title
306 * @return bool|Revision
308 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
309 return new Revision( [
310 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
311 'deleted' => $result->rc_deleted
,
312 'user_text' => $result->rc_user_text
,
313 'user' => $result->rc_user
,
314 'actor' => $result->rc_actor
,
319 * Format a row, providing the timestamp, links to the page/history,
320 * size, user links, and a comment
322 * @param object $result Result row
325 public function formatRow( $result ) {
326 $title = Title
::newFromRow( $result );
328 // Revision deletion works on revisions,
329 // so cast our recent change row to a revision row.
330 $rev = $this->revisionFromRcResult( $result, $title );
333 $attribs = [ 'data-mw-revid' => $result->rev_id
];
335 $lang = $this->getLanguage();
336 $dm = $lang->getDirMark();
338 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
339 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
341 $linkRenderer = $this->getLinkRenderer();
342 $time = $linkRenderer->makeKnownLink(
344 new HtmlArmor( $spanTime ),
346 [ 'oldid' => $result->rc_this_oldid
]
349 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
351 $plink = $linkRenderer->makeKnownLink(
354 [ 'class' => 'mw-newpages-pagename' ],
357 $histLink = $linkRenderer->makeKnownLink(
359 $this->msg( 'hist' )->text(),
361 [ 'action' => 'history' ]
363 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
364 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
366 $length = Html
::rawElement(
368 [ 'class' => 'mw-newpages-length' ],
369 $this->msg( 'brackets' )->rawParams(
370 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
374 $ulink = Linker
::revUserTools( $rev );
375 $comment = Linker
::revComment( $rev );
377 if ( $this->patrollable( $result ) ) {
378 $classes[] = 'not-patrolled';
381 # Add a class for zero byte pages
382 if ( $result->length
== 0 ) {
383 $classes[] = 'mw-newpages-zero-byte-page';
387 if ( isset( $result->ts_tags
) ) {
388 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
393 $classes = array_merge( $classes, $newClasses );
398 # Display the old title if the namespace/title has been changed
400 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
402 if ( !$title->equals( $oldTitle ) ) {
403 $oldTitleText = $oldTitle->getPrefixedText();
404 $oldTitleText = Html
::rawElement(
406 [ 'class' => 'mw-newpages-oldtitle' ],
407 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
411 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
412 . "{$tagDisplay} {$oldTitleText}";
414 // Let extensions add data
415 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
416 $attribs = array_filter( $attribs,
417 [ Sanitizer
::class, 'isReservedDataAttribute' ],
421 if ( count( $classes ) ) {
422 $attribs['class'] = implode( ' ', $classes );
425 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
429 * Should a specific result row provide "patrollable" links?
431 * @param object $result Result row
434 protected function patrollable( $result ) {
435 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
439 * Output a subscription feed listing recent edits to this page.
441 * @param string $type
443 protected function feed( $type ) {
444 if ( !$this->getConfig()->get( 'Feed' ) ) {
445 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
450 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
451 if ( !isset( $feedClasses[$type] ) ) {
452 $this->getOutput()->addWikiMsg( 'feed-invalid' );
457 $feed = new $feedClasses[$type](
459 $this->msg( 'tagline' )->text(),
460 $this->getPageTitle()->getFullURL()
463 $pager = new NewPagesPager( $this, $this->opts
);
464 $limit = $this->opts
->getValue( 'limit' );
465 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
468 if ( $pager->getNumRows() > 0 ) {
469 foreach ( $pager->mResult
as $row ) {
470 $feed->outItem( $this->feedItem( $row ) );
476 protected function feedTitle() {
477 $desc = $this->getDescription();
478 $code = $this->getConfig()->get( 'LanguageCode' );
479 $sitename = $this->getConfig()->get( 'Sitename' );
481 return "$sitename - $desc [$code]";
484 protected function feedItem( $row ) {
485 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
487 $date = $row->rc_timestamp
;
488 $comments = $title->getTalkPage()->getFullURL();
491 $title->getPrefixedText(),
492 $this->feedItemDesc( $row ),
493 $title->getFullURL(),
495 $this->feedItemAuthor( $row ),
503 protected function feedItemAuthor( $row ) {
504 return $row->rc_user_text ??
'';
507 protected function feedItemDesc( $row ) {
508 $revision = Revision
::newFromId( $row->rev_id
);
513 $content = $revision->getContent();
514 if ( $content === null ) {
518 // XXX: include content model/type in feed item?
519 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
520 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
521 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
522 "</p>\n<hr />\n<div>" .
523 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
526 protected function getGroupName() {
530 protected function getCacheTTL() {