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' );
42 protected function setup( $par ) {
44 $opts = new FormOptions();
45 $this->opts
= $opts; // bind
46 $opts->add( 'hideliu', false );
47 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
48 $opts->add( 'hidebots', false );
49 $opts->add( 'hideredirs', true );
50 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
51 $opts->add( 'offset', '' );
52 $opts->add( 'namespace', '0' );
53 $opts->add( 'username', '' );
54 $opts->add( 'feed', '' );
55 $opts->add( 'tagfilter', '' );
56 $opts->add( 'invert', false );
57 $opts->add( 'size-mode', 'max' );
58 $opts->add( 'size', 0 );
60 $this->customFilters
= [];
61 Hooks
::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters
] );
62 foreach ( $this->customFilters
as $key => $params ) {
63 $opts->add( $key, $params['default'] );
67 $opts->fetchValuesFromRequest( $this->getRequest() );
69 $this->parseParams( $par );
73 $opts->validateIntBounds( 'limit', 0, 5000 );
76 protected function parseParams( $par ) {
77 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
78 foreach ( $bits as $bit ) {
79 if ( 'shownav' == $bit ) {
80 $this->showNavigation
= true;
82 if ( 'hideliu' === $bit ) {
83 $this->opts
->setValue( 'hideliu', true );
85 if ( 'hidepatrolled' == $bit ) {
86 $this->opts
->setValue( 'hidepatrolled', true );
88 if ( 'hidebots' == $bit ) {
89 $this->opts
->setValue( 'hidebots', true );
91 if ( 'showredirs' == $bit ) {
92 $this->opts
->setValue( 'hideredirs', false );
94 if ( is_numeric( $bit ) ) {
95 $this->opts
->setValue( 'limit', intval( $bit ) );
99 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
100 $this->opts
->setValue( 'limit', intval( $m[1] ) );
102 // PG offsets not just digits!
103 if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
104 $this->opts
->setValue( 'offset', intval( $m[1] ) );
106 if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
107 $this->opts
->setValue( 'username', $m[1] );
109 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
110 $ns = $this->getLanguage()->getNsIndex( $m[1] );
111 if ( $ns !== false ) {
112 $this->opts
->setValue( 'namespace', $ns );
119 * Show a form for filtering namespace and username
123 public function execute( $par ) {
124 $out = $this->getOutput();
127 $this->outputHeader();
129 $this->showNavigation
= !$this->including(); // Maybe changed in setup
130 $this->setup( $par );
132 $this->addHelpLink( 'Help:New pages' );
134 if ( !$this->including() ) {
138 $feedType = $this->opts
->getValue( 'feed' );
140 $this->feed( $feedType );
145 $allValues = $this->opts
->getAllValues();
146 unset( $allValues['feed'] );
147 $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
150 $pager = new NewPagesPager( $this, $this->opts
);
151 $pager->mLimit
= $this->opts
->getValue( 'limit' );
152 $pager->mOffset
= $this->opts
->getValue( 'offset' );
154 if ( $pager->getNumRows() ) {
156 if ( $this->showNavigation
) {
157 $navigation = $pager->getNavigationBar();
159 $out->addHTML( $navigation . $pager->getBody() . $navigation );
161 $out->addWikiMsg( 'specialpage-empty' );
165 protected function filterLinks() {
167 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
169 // Option value -> message mapping
171 'hideliu' => 'rcshowhideliu',
172 'hidepatrolled' => 'rcshowhidepatr',
173 'hidebots' => 'rcshowhidebots',
174 'hideredirs' => 'whatlinkshere-hideredirs'
176 foreach ( $this->customFilters
as $key => $params ) {
177 $filters[$key] = $params['msg'];
180 // Disable some if needed
181 if ( !User
::groupHasPermission( '*', 'createpage' ) ) {
182 unset( $filters['hideliu'] );
184 if ( !$this->getUser()->useNPPatrol() ) {
185 unset( $filters['hidepatrolled'] );
189 $changed = $this->opts
->getChangedValues();
190 unset( $changed['offset'] ); // Reset offset if query type changes
192 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
193 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
195 $changed = array_map( function ( $value ) {
196 return $value ?
'1' : '0';
199 $self = $this->getPageTitle();
200 $linkRenderer = $this->getLinkRenderer();
201 foreach ( $filters as $key => $msg ) {
202 $onoff = 1 - $this->opts
->getValue( $key );
203 $link = $linkRenderer->makeLink(
205 new HtmlArmor( $showhide[$onoff] ),
207 [ $key => $onoff ] +
$changed
209 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
212 return $this->getLanguage()->pipeList( $links );
215 protected function form() {
216 $out = $this->getOutput();
219 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
220 $namespace = $this->opts
->consumeValue( 'namespace' );
221 $username = $this->opts
->consumeValue( 'username' );
222 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
223 $nsinvert = $this->opts
->consumeValue( 'invert' );
225 $size = $this->opts
->consumeValue( 'size' );
226 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
228 // Check username input validity
229 $ut = Title
::makeTitleSafe( NS_USER
, $username );
230 $userText = $ut ?
$ut->getText() : '';
232 // Store query values in hidden fields so that form submission doesn't lose them
234 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
235 $hidden[] = Html
::hidden( $key, $value );
237 $hidden = implode( "\n", $hidden );
241 'type' => 'namespaceselect',
242 'name' => 'namespace',
243 'label-message' => 'namespace',
244 'default' => $namespace,
249 'label-message' => 'invert',
250 'default' => $nsinvert,
251 'tooltip' => 'invert',
254 'type' => 'tagfilter',
255 'name' => 'tagfilter',
256 'label-raw' => $this->msg( 'tag-filter' )->parse(),
257 'default' => $tagFilterVal,
261 'name' => 'username',
262 'label-message' => 'newpages-username',
263 'default' => $userText,
264 'id' => 'mw-np-username',
268 'type' => 'sizefilter',
270 'default' => -$max * $size,
274 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
277 ->setFormIdentifier( 'newpagesform' )
278 // The form should be visible on each request (inclusive requests with submitted forms), so
279 // return always false here.
285 ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
286 ->setWrapperLegend( $this->msg( 'newpages' )->text() )
287 ->addFooterText( Html
::rawElement(
293 $out->addModuleStyles( 'mediawiki.special' );
297 * @param stdClass $result Result row from recent changes
298 * @param Title $title
299 * @return bool|Revision
301 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
302 return new Revision( [
303 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
304 'deleted' => $result->rc_deleted
,
305 'user_text' => $result->rc_user_text
,
306 'user' => $result->rc_user
,
307 'actor' => $result->rc_actor
,
312 * Format a row, providing the timestamp, links to the page/history,
313 * size, user links, and a comment
315 * @param object $result Result row
318 public function formatRow( $result ) {
319 $title = Title
::newFromRow( $result );
321 // Revision deletion works on revisions,
322 // so cast our recent change row to a revision row.
323 $rev = $this->revisionFromRcResult( $result, $title );
326 $attribs = [ 'data-mw-revid' => $result->rev_id
];
328 $lang = $this->getLanguage();
329 $dm = $lang->getDirMark();
331 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
332 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
334 $linkRenderer = $this->getLinkRenderer();
335 $time = $linkRenderer->makeKnownLink(
337 new HtmlArmor( $spanTime ),
339 [ 'oldid' => $result->rc_this_oldid
]
342 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
344 $plink = $linkRenderer->makeKnownLink(
347 [ 'class' => 'mw-newpages-pagename' ],
350 $histLink = $linkRenderer->makeKnownLink(
352 $this->msg( 'hist' )->text(),
354 [ 'action' => 'history' ]
356 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
357 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
359 $length = Html
::rawElement(
361 [ 'class' => 'mw-newpages-length' ],
362 $this->msg( 'brackets' )->rawParams(
363 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
367 $ulink = Linker
::revUserTools( $rev );
368 $comment = Linker
::revComment( $rev );
370 if ( $this->patrollable( $result ) ) {
371 $classes[] = 'not-patrolled';
374 # Add a class for zero byte pages
375 if ( $result->length
== 0 ) {
376 $classes[] = 'mw-newpages-zero-byte-page';
380 if ( isset( $result->ts_tags
) ) {
381 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
386 $classes = array_merge( $classes, $newClasses );
391 # Display the old title if the namespace/title has been changed
393 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
395 if ( !$title->equals( $oldTitle ) ) {
396 $oldTitleText = $oldTitle->getPrefixedText();
397 $oldTitleText = Html
::rawElement(
399 [ 'class' => 'mw-newpages-oldtitle' ],
400 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
404 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
405 . "{$tagDisplay} {$oldTitleText}";
407 // Let extensions add data
408 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
409 $attribs = array_filter( $attribs,
410 [ Sanitizer
::class, 'isReservedDataAttribute' ],
414 if ( count( $classes ) ) {
415 $attribs['class'] = implode( ' ', $classes );
418 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
422 * Should a specific result row provide "patrollable" links?
424 * @param object $result Result row
427 protected function patrollable( $result ) {
428 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
432 * Output a subscription feed listing recent edits to this page.
434 * @param string $type
436 protected function feed( $type ) {
437 if ( !$this->getConfig()->get( 'Feed' ) ) {
438 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
443 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
444 if ( !isset( $feedClasses[$type] ) ) {
445 $this->getOutput()->addWikiMsg( 'feed-invalid' );
450 $feed = new $feedClasses[$type](
452 $this->msg( 'tagline' )->text(),
453 $this->getPageTitle()->getFullURL()
456 $pager = new NewPagesPager( $this, $this->opts
);
457 $limit = $this->opts
->getValue( 'limit' );
458 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
461 if ( $pager->getNumRows() > 0 ) {
462 foreach ( $pager->mResult
as $row ) {
463 $feed->outItem( $this->feedItem( $row ) );
469 protected function feedTitle() {
470 $desc = $this->getDescription();
471 $code = $this->getConfig()->get( 'LanguageCode' );
472 $sitename = $this->getConfig()->get( 'Sitename' );
474 return "$sitename - $desc [$code]";
477 protected function feedItem( $row ) {
478 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
480 $date = $row->rc_timestamp
;
481 $comments = $title->getTalkPage()->getFullURL();
484 $title->getPrefixedText(),
485 $this->feedItemDesc( $row ),
486 $title->getFullURL(),
488 $this->feedItemAuthor( $row ),
496 protected function feedItemAuthor( $row ) {
497 return $row->rc_user_text ??
'';
500 protected function feedItemDesc( $row ) {
501 $revision = Revision
::newFromId( $row->rev_id
);
506 $content = $revision->getContent();
507 if ( $content === null ) {
511 // XXX: include content model/type in feed item?
512 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
513 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
514 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
515 "</p>\n<hr />\n<div>" .
516 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
519 protected function getGroupName() {
523 protected function getCacheTTL() {