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 $self = $this->getPageTitle();
193 $linkRenderer = $this->getLinkRenderer();
194 foreach ( $filters as $key => $msg ) {
195 $onoff = 1 - $this->opts
->getValue( $key );
196 $link = $linkRenderer->makeLink(
198 new HtmlArmor( $showhide[$onoff] ),
200 [ $key => $onoff ] +
$changed
202 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
205 return $this->getLanguage()->pipeList( $links );
208 protected function form() {
209 $out = $this->getOutput();
212 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
213 $namespace = $this->opts
->consumeValue( 'namespace' );
214 $username = $this->opts
->consumeValue( 'username' );
215 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
216 $nsinvert = $this->opts
->consumeValue( 'invert' );
218 $size = $this->opts
->consumeValue( 'size' );
219 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
221 // Check username input validity
222 $ut = Title
::makeTitleSafe( NS_USER
, $username );
223 $userText = $ut ?
$ut->getText() : '';
225 // Store query values in hidden fields so that form submission doesn't lose them
227 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
228 $hidden[] = Html
::hidden( $key, $value );
230 $hidden = implode( "\n", $hidden );
234 'type' => 'namespaceselect',
235 'name' => 'namespace',
236 'label-message' => 'namespace',
237 'default' => $namespace,
242 'label-message' => 'invert',
243 'default' => $nsinvert,
244 'tooltip' => 'invert',
247 'type' => 'tagfilter',
248 'name' => 'tagfilter',
249 'label-raw' => $this->msg( 'tag-filter' )->parse(),
250 'default' => $tagFilterVal,
254 'name' => 'username',
255 'label-message' => 'newpages-username',
256 'default' => $userText,
257 'id' => 'mw-np-username',
261 'type' => 'sizefilter',
263 'default' => -$max * $size,
267 $htmlForm = new HTMLForm( $form, $this->getContext() );
269 $htmlForm->setSubmitText( $this->msg( 'newpages-submit' )->text() );
270 // The form should be visible on each request (inclusive requests with submitted forms), so
271 // return always false here.
272 $htmlForm->setSubmitCallback(
277 $htmlForm->setMethod( 'get' );
278 $htmlForm->setWrapperLegend( true );
279 $htmlForm->setWrapperLegendMsg( 'newpages' );
280 $htmlForm->addFooterText( Html
::rawElement(
289 * @param stdClass $result Result row from recent changes
290 * @param Title $title
291 * @return bool|Revision
293 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
294 return new Revision( [
295 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
296 'deleted' => $result->rc_deleted
,
297 'user_text' => $result->rc_user_text
,
298 'user' => $result->rc_user
,
299 'actor' => $result->rc_actor
,
304 * Format a row, providing the timestamp, links to the page/history,
305 * size, user links, and a comment
307 * @param object $result Result row
310 public function formatRow( $result ) {
311 $title = Title
::newFromRow( $result );
313 // Revision deletion works on revisions,
314 // so cast our recent change row to a revision row.
315 $rev = $this->revisionFromRcResult( $result, $title );
318 $attribs = [ 'data-mw-revid' => $result->rev_id
];
320 $lang = $this->getLanguage();
321 $dm = $lang->getDirMark();
323 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
324 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
326 $linkRenderer = $this->getLinkRenderer();
327 $time = $linkRenderer->makeKnownLink(
329 new HtmlArmor( $spanTime ),
331 [ 'oldid' => $result->rc_this_oldid
]
334 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
336 $plink = $linkRenderer->makeKnownLink(
339 [ 'class' => 'mw-newpages-pagename' ],
342 $histLink = $linkRenderer->makeKnownLink(
344 $this->msg( 'hist' )->text(),
346 [ 'action' => 'history' ]
348 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
349 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
351 $length = Html
::rawElement(
353 [ 'class' => 'mw-newpages-length' ],
354 $this->msg( 'brackets' )->rawParams(
355 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
359 $ulink = Linker
::revUserTools( $rev );
360 $comment = Linker
::revComment( $rev );
362 if ( $this->patrollable( $result ) ) {
363 $classes[] = 'not-patrolled';
366 # Add a class for zero byte pages
367 if ( $result->length
== 0 ) {
368 $classes[] = 'mw-newpages-zero-byte-page';
372 if ( isset( $result->ts_tags
) ) {
373 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
378 $classes = array_merge( $classes, $newClasses );
383 # Display the old title if the namespace/title has been changed
385 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
387 if ( !$title->equals( $oldTitle ) ) {
388 $oldTitleText = $oldTitle->getPrefixedText();
389 $oldTitleText = Html
::rawElement(
391 [ 'class' => 'mw-newpages-oldtitle' ],
392 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
396 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
397 . "{$tagDisplay} {$oldTitleText}";
399 // Let extensions add data
400 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
401 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer
::class, 'isReservedDataAttribute' ] );
403 if ( count( $classes ) ) {
404 $attribs['class'] = implode( ' ', $classes );
407 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
411 * Should a specific result row provide "patrollable" links?
413 * @param object $result Result row
416 protected function patrollable( $result ) {
417 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
421 * Output a subscription feed listing recent edits to this page.
423 * @param string $type
425 protected function feed( $type ) {
426 if ( !$this->getConfig()->get( 'Feed' ) ) {
427 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
432 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
433 if ( !isset( $feedClasses[$type] ) ) {
434 $this->getOutput()->addWikiMsg( 'feed-invalid' );
439 $feed = new $feedClasses[$type](
441 $this->msg( 'tagline' )->text(),
442 $this->getPageTitle()->getFullURL()
445 $pager = new NewPagesPager( $this, $this->opts
);
446 $limit = $this->opts
->getValue( 'limit' );
447 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
450 if ( $pager->getNumRows() > 0 ) {
451 foreach ( $pager->mResult
as $row ) {
452 $feed->outItem( $this->feedItem( $row ) );
458 protected function feedTitle() {
459 $desc = $this->getDescription();
460 $code = $this->getConfig()->get( 'LanguageCode' );
461 $sitename = $this->getConfig()->get( 'Sitename' );
463 return "$sitename - $desc [$code]";
466 protected function feedItem( $row ) {
467 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
469 $date = $row->rc_timestamp
;
470 $comments = $title->getTalkPage()->getFullURL();
473 $title->getPrefixedText(),
474 $this->feedItemDesc( $row ),
475 $title->getFullURL(),
477 $this->feedItemAuthor( $row ),
485 protected function feedItemAuthor( $row ) {
486 return isset( $row->rc_user_text
) ?
$row->rc_user_text
: '';
489 protected function feedItemDesc( $row ) {
490 $revision = Revision
::newFromId( $row->rev_id
);
495 $content = $revision->getContent();
496 if ( $content === null ) {
500 // XXX: include content model/type in feed item?
501 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
502 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
503 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
504 "</p>\n<hr />\n<div>" .
505 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
508 protected function getGroupName() {
512 protected function getCacheTTL() {