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 );
164 $out->addWikiMsg( 'specialpage-empty' );
168 protected function filterLinks() {
170 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
172 // Option value -> message mapping
174 'hideliu' => 'rcshowhideliu',
175 'hidepatrolled' => 'rcshowhidepatr',
176 'hidebots' => 'rcshowhidebots',
177 'hideredirs' => 'whatlinkshere-hideredirs'
179 foreach ( $this->customFilters
as $key => $params ) {
180 $filters[$key] = $params['msg'];
183 // Disable some if needed
184 if ( !User
::groupHasPermission( '*', 'createpage' ) ) {
185 unset( $filters['hideliu'] );
187 if ( !$this->getUser()->useNPPatrol() ) {
188 unset( $filters['hidepatrolled'] );
192 $changed = $this->opts
->getChangedValues();
193 unset( $changed['offset'] ); // Reset offset if query type changes
195 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
196 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
198 // Also do this only for boolean options, not eg. namespace or tagfilter
199 foreach ( $changed as $key => $value ) {
200 if ( array_key_exists( $key, $filters ) ) {
201 $changed[$key] = $changed[$key] ?
'1' : '0';
205 $self = $this->getPageTitle();
206 $linkRenderer = $this->getLinkRenderer();
207 foreach ( $filters as $key => $msg ) {
208 $onoff = 1 - $this->opts
->getValue( $key );
209 $link = $linkRenderer->makeLink(
211 new HtmlArmor( $showhide[$onoff] ),
213 [ $key => $onoff ] +
$changed
215 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
218 return $this->getLanguage()->pipeList( $links );
221 protected function form() {
222 $out = $this->getOutput();
225 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
226 $namespace = $this->opts
->consumeValue( 'namespace' );
227 $username = $this->opts
->consumeValue( 'username' );
228 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
229 $nsinvert = $this->opts
->consumeValue( 'invert' );
231 $size = $this->opts
->consumeValue( 'size' );
232 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
234 // Check username input validity
235 $ut = Title
::makeTitleSafe( NS_USER
, $username );
236 $userText = $ut ?
$ut->getText() : '';
240 'type' => 'namespaceselect',
241 'name' => 'namespace',
242 'label-message' => 'namespace',
243 'default' => $namespace,
248 'label-message' => 'invert',
249 'default' => $nsinvert,
250 'tooltip' => 'invert',
253 'type' => 'tagfilter',
254 'name' => 'tagfilter',
255 'label-raw' => $this->msg( 'tag-filter' )->parse(),
256 'default' => $tagFilterVal,
260 'name' => 'username',
261 'label-message' => 'newpages-username',
262 'default' => $userText,
263 'id' => 'mw-np-username',
267 'type' => 'sizefilter',
269 'default' => -$max * $size,
273 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
275 // Store query values in hidden fields so that form submission doesn't lose them
276 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
277 $htmlForm->addHiddenField( $key, $value );
282 ->setFormIdentifier( 'newpagesform' )
283 // The form should be visible on each request (inclusive requests with submitted forms), so
284 // return always false here.
290 ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
291 ->setWrapperLegend( $this->msg( 'newpages' )->text() )
292 ->addFooterText( Html
::rawElement(
298 $out->addModuleStyles( 'mediawiki.special' );
302 * @param stdClass $result Result row from recent changes
303 * @param Title $title
304 * @return bool|Revision
306 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
307 return new Revision( [
308 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
309 'deleted' => $result->rc_deleted
,
310 'user_text' => $result->rc_user_text
,
311 'user' => $result->rc_user
,
312 'actor' => $result->rc_actor
,
317 * Format a row, providing the timestamp, links to the page/history,
318 * size, user links, and a comment
320 * @param object $result Result row
323 public function formatRow( $result ) {
324 $title = Title
::newFromRow( $result );
326 // Revision deletion works on revisions,
327 // so cast our recent change row to a revision row.
328 $rev = $this->revisionFromRcResult( $result, $title );
331 $attribs = [ 'data-mw-revid' => $result->rev_id
];
333 $lang = $this->getLanguage();
334 $dm = $lang->getDirMark();
336 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
337 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
339 $linkRenderer = $this->getLinkRenderer();
340 $time = $linkRenderer->makeKnownLink(
342 new HtmlArmor( $spanTime ),
344 [ 'oldid' => $result->rc_this_oldid
]
347 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
349 $plink = $linkRenderer->makeKnownLink(
352 [ 'class' => 'mw-newpages-pagename' ],
355 $histLink = $linkRenderer->makeKnownLink(
357 $this->msg( 'hist' )->text(),
359 [ 'action' => 'history' ]
361 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
362 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
364 $length = Html
::rawElement(
366 [ 'class' => 'mw-newpages-length' ],
367 $this->msg( 'brackets' )->rawParams(
368 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
372 $ulink = Linker
::revUserTools( $rev );
373 $comment = Linker
::revComment( $rev );
375 if ( $this->patrollable( $result ) ) {
376 $classes[] = 'not-patrolled';
379 # Add a class for zero byte pages
380 if ( $result->length
== 0 ) {
381 $classes[] = 'mw-newpages-zero-byte-page';
385 if ( isset( $result->ts_tags
) ) {
386 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
391 $classes = array_merge( $classes, $newClasses );
396 # Display the old title if the namespace/title has been changed
398 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
400 if ( !$title->equals( $oldTitle ) ) {
401 $oldTitleText = $oldTitle->getPrefixedText();
402 $oldTitleText = Html
::rawElement(
404 [ 'class' => 'mw-newpages-oldtitle' ],
405 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
409 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
410 . "{$tagDisplay} {$oldTitleText}";
412 // Let extensions add data
413 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
414 $attribs = array_filter( $attribs,
415 [ Sanitizer
::class, 'isReservedDataAttribute' ],
419 if ( count( $classes ) ) {
420 $attribs['class'] = implode( ' ', $classes );
423 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
427 * Should a specific result row provide "patrollable" links?
429 * @param object $result Result row
432 protected function patrollable( $result ) {
433 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
437 * Output a subscription feed listing recent edits to this page.
439 * @param string $type
441 protected function feed( $type ) {
442 if ( !$this->getConfig()->get( 'Feed' ) ) {
443 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
448 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
449 if ( !isset( $feedClasses[$type] ) ) {
450 $this->getOutput()->addWikiMsg( 'feed-invalid' );
455 $feed = new $feedClasses[$type](
457 $this->msg( 'tagline' )->text(),
458 $this->getPageTitle()->getFullURL()
461 $pager = new NewPagesPager( $this, $this->opts
);
462 $limit = $this->opts
->getValue( 'limit' );
463 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
466 if ( $pager->getNumRows() > 0 ) {
467 foreach ( $pager->mResult
as $row ) {
468 $feed->outItem( $this->feedItem( $row ) );
474 protected function feedTitle() {
475 $desc = $this->getDescription();
476 $code = $this->getConfig()->get( 'LanguageCode' );
477 $sitename = $this->getConfig()->get( 'Sitename' );
479 return "$sitename - $desc [$code]";
482 protected function feedItem( $row ) {
483 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
485 $date = $row->rc_timestamp
;
486 $comments = $title->getTalkPage()->getFullURL();
489 $title->getPrefixedText(),
490 $this->feedItemDesc( $row ),
491 $title->getFullURL(),
493 $this->feedItemAuthor( $row ),
501 protected function feedItemAuthor( $row ) {
502 return $row->rc_user_text ??
'';
505 protected function feedItemDesc( $row ) {
506 $revision = Revision
::newFromId( $row->rev_id
);
511 $content = $revision->getContent();
512 if ( $content === null ) {
516 // XXX: include content model/type in feed item?
517 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
518 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
519 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
520 "</p>\n<hr />\n<div>" .
521 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
524 protected function getGroupName() {
528 protected function getCacheTTL() {