e2c9eab1ce075cddcb1655a4d43f566d2fb689f4
[lhc/web/wiklou.git] / includes / specials / SpecialNewpages.php
1 <?php
2 /**
3 * Implements Special:Newpages
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup SpecialPage
22 */
23
24 /**
25 * A special page that list newly created pages
26 *
27 * @ingroup SpecialPage
28 */
29 class SpecialNewpages extends IncludableSpecialPage {
30 /**
31 * @var FormOptions
32 */
33 protected $opts;
34 protected $customFilters;
35
36 protected $showNavigation = false;
37
38 public function __construct() {
39 parent::__construct( 'Newpages' );
40 }
41
42 protected function setup( $par ) {
43 // Options
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 );
59
60 $this->customFilters = [];
61 Hooks::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters ] );
62 foreach ( $this->customFilters as $key => $params ) {
63 $opts->add( $key, $params['default'] );
64 }
65
66 // Set values
67 $opts->fetchValuesFromRequest( $this->getRequest() );
68 if ( $par ) {
69 $this->parseParams( $par );
70 }
71
72 // Validate
73 $opts->validateIntBounds( 'limit', 0, 5000 );
74 }
75
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;
81 }
82 if ( 'hideliu' === $bit ) {
83 $this->opts->setValue( 'hideliu', true );
84 }
85 if ( 'hidepatrolled' == $bit ) {
86 $this->opts->setValue( 'hidepatrolled', true );
87 }
88 if ( 'hidebots' == $bit ) {
89 $this->opts->setValue( 'hidebots', true );
90 }
91 if ( 'showredirs' == $bit ) {
92 $this->opts->setValue( 'hideredirs', false );
93 }
94 if ( is_numeric( $bit ) ) {
95 $this->opts->setValue( 'limit', intval( $bit ) );
96 }
97
98 $m = [];
99 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
100 $this->opts->setValue( 'limit', intval( $m[1] ) );
101 }
102 // PG offsets not just digits!
103 if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
104 $this->opts->setValue( 'offset', intval( $m[1] ) );
105 }
106 if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
107 $this->opts->setValue( 'username', $m[1] );
108 }
109 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
110 $ns = $this->getLanguage()->getNsIndex( $m[1] );
111 if ( $ns !== false ) {
112 $this->opts->setValue( 'namespace', $ns );
113 }
114 }
115 }
116 }
117
118 /**
119 * Show a form for filtering namespace and username
120 *
121 * @param string $par
122 */
123 public function execute( $par ) {
124 $out = $this->getOutput();
125
126 $this->setHeaders();
127 $this->outputHeader();
128
129 $this->showNavigation = !$this->including(); // Maybe changed in setup
130 $this->setup( $par );
131
132 $this->addHelpLink( 'Help:New pages' );
133
134 if ( !$this->including() ) {
135 // Settings
136 $this->form();
137
138 $feedType = $this->opts->getValue( 'feed' );
139 if ( $feedType ) {
140 $this->feed( $feedType );
141
142 return;
143 }
144
145 $allValues = $this->opts->getAllValues();
146 unset( $allValues['feed'] );
147 $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
148 }
149
150 $pager = new NewPagesPager( $this, $this->opts );
151 $pager->mLimit = $this->opts->getValue( 'limit' );
152 $pager->mOffset = $this->opts->getValue( 'offset' );
153
154 if ( $pager->getNumRows() ) {
155 $navigation = '';
156 if ( $this->showNavigation ) {
157 $navigation = $pager->getNavigationBar();
158 }
159 $out->addHTML( $navigation . $pager->getBody() . $navigation );
160 } else {
161 $out->addWikiMsg( 'specialpage-empty' );
162 }
163 }
164
165 protected function filterLinks() {
166 // show/hide links
167 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
168
169 // Option value -> message mapping
170 $filters = [
171 'hideliu' => 'rcshowhideliu',
172 'hidepatrolled' => 'rcshowhidepatr',
173 'hidebots' => 'rcshowhidebots',
174 'hideredirs' => 'whatlinkshere-hideredirs'
175 ];
176 foreach ( $this->customFilters as $key => $params ) {
177 $filters[$key] = $params['msg'];
178 }
179
180 // Disable some if needed
181 if ( !User::groupHasPermission( '*', 'createpage' ) ) {
182 unset( $filters['hideliu'] );
183 }
184 if ( !$this->getUser()->useNPPatrol() ) {
185 unset( $filters['hidepatrolled'] );
186 }
187
188 $links = [];
189 $changed = $this->opts->getChangedValues();
190 unset( $changed['offset'] ); // Reset offset if query type changes
191
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(
197 $self,
198 new HtmlArmor( $showhide[$onoff] ),
199 [],
200 [ $key => $onoff ] + $changed
201 );
202 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
203 }
204
205 return $this->getLanguage()->pipeList( $links );
206 }
207
208 protected function form() {
209 $out = $this->getOutput();
210 $out->addModules( 'mediawiki.userSuggest' );
211
212 // Consume values
213 $this->opts->consumeValue( 'offset' ); // don't carry offset, DWIW
214 $namespace = $this->opts->consumeValue( 'namespace' );
215 $username = $this->opts->consumeValue( 'username' );
216 $tagFilterVal = $this->opts->consumeValue( 'tagfilter' );
217 $nsinvert = $this->opts->consumeValue( 'invert' );
218
219 $size = $this->opts->consumeValue( 'size' );
220 $max = $this->opts->consumeValue( 'size-mode' ) === 'max';
221
222 // Check username input validity
223 $ut = Title::makeTitleSafe( NS_USER, $username );
224 $userText = $ut ? $ut->getText() : '';
225
226 // Store query values in hidden fields so that form submission doesn't lose them
227 $hidden = [];
228 foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
229 $hidden[] = Html::hidden( $key, $value );
230 }
231 $hidden = implode( "\n", $hidden );
232
233 $form = [
234 'namespace' => [
235 'type' => 'namespaceselect',
236 'name' => 'namespace',
237 'label-message' => 'namespace',
238 'default' => $namespace,
239 ],
240 'nsinvert' => [
241 'type' => 'check',
242 'name' => 'invert',
243 'label-message' => 'invert',
244 'default' => $nsinvert,
245 'tooltip' => 'invert',
246 ],
247 'tagFilter' => [
248 'type' => 'tagfilter',
249 'name' => 'tagfilter',
250 'label-raw' => $this->msg( 'tag-filter' )->parse(),
251 'default' => $tagFilterVal,
252 ],
253 'username' => [
254 'type' => 'text',
255 'name' => 'username',
256 'label-message' => 'newpages-username',
257 'default' => $userText,
258 'id' => 'mw-np-username',
259 'size' => 30,
260 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
261 ],
262 'size' => [
263 'type' => 'sizefilter',
264 'name' => 'size',
265 'default' => -$max * $size,
266 ],
267 ];
268
269 $htmlForm = new HTMLForm( $form, $this->getContext() );
270
271 $htmlForm->setSubmitText( $this->msg( 'newpages-submit' )->text() );
272 $htmlForm->setSubmitProgressive();
273 // The form should be visible on each request (inclusive requests with submitted forms), so
274 // return always false here.
275 $htmlForm->setSubmitCallback(
276 function () {
277 return false;
278 }
279 );
280 $htmlForm->setMethod( 'get' );
281
282 $out->addHTML( Xml::fieldset( $this->msg( 'newpages' )->text() ) );
283
284 $htmlForm->show();
285
286 $out->addHTML(
287 Html::rawElement(
288 'div',
289 null,
290 $this->filterLinks()
291 ) .
292 Xml::closeElement( 'fieldset' )
293 );
294 }
295
296 /**
297 * @param stdClass $row Result row from recent changes
298 * @return Revision|bool
299 */
300 protected function revisionFromRcResult( stdClass $result ) {
301 return new Revision( [
302 'comment' => $result->rc_comment,
303 'deleted' => $result->rc_deleted,
304 'user_text' => $result->rc_user_text,
305 'user' => $result->rc_user,
306 ] );
307 }
308
309 /**
310 * Format a row, providing the timestamp, links to the page/history,
311 * size, user links, and a comment
312 *
313 * @param object $result Result row
314 * @return string
315 */
316 public function formatRow( $result ) {
317 $title = Title::newFromRow( $result );
318
319 // Revision deletion works on revisions,
320 // so cast our recent change row to a revision row.
321 $rev = $this->revisionFromRcResult( $result );
322 $rev->setTitle( $title );
323
324 $classes = [];
325 $attribs = [ 'data-mw-revid' => $result->rev_id ];
326
327 $lang = $this->getLanguage();
328 $dm = $lang->getDirMark();
329
330 $spanTime = Html::element( 'span', [ 'class' => 'mw-newpages-time' ],
331 $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
332 );
333 $linkRenderer = $this->getLinkRenderer();
334 $time = $linkRenderer->makeKnownLink(
335 $title,
336 new HtmlArmor( $spanTime ),
337 [],
338 [ 'oldid' => $result->rc_this_oldid ]
339 );
340
341 $query = $title->isRedirect() ? [ 'redirect' => 'no' ] : [];
342
343 $plink = $linkRenderer->makeKnownLink(
344 $title,
345 null,
346 [ 'class' => 'mw-newpages-pagename' ],
347 $query
348 );
349 $histLink = $linkRenderer->makeKnownLink(
350 $title,
351 $this->msg( 'hist' )->text(),
352 [],
353 [ 'action' => 'history' ]
354 );
355 $hist = Html::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
356 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
357
358 $length = Html::rawElement(
359 'span',
360 [ 'class' => 'mw-newpages-length' ],
361 $this->msg( 'brackets' )->rawParams(
362 $this->msg( 'nbytes' )->numParams( $result->length )->escaped()
363 )->escaped()
364 );
365
366 $ulink = Linker::revUserTools( $rev );
367 $comment = Linker::revComment( $rev );
368
369 if ( $this->patrollable( $result ) ) {
370 $classes[] = 'not-patrolled';
371 }
372
373 # Add a class for zero byte pages
374 if ( $result->length == 0 ) {
375 $classes[] = 'mw-newpages-zero-byte-page';
376 }
377
378 # Tags, if any.
379 if ( isset( $result->ts_tags ) ) {
380 list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
381 $result->ts_tags,
382 'newpages',
383 $this->getContext()
384 );
385 $classes = array_merge( $classes, $newClasses );
386 } else {
387 $tagDisplay = '';
388 }
389
390 # Display the old title if the namespace/title has been changed
391 $oldTitleText = '';
392 $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
393 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
394 . "{$tagDisplay} {$oldTitleText}";
395
396 // Let extensions add data
397 Hooks::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
398 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer::class, 'isReservedDataAttribute' ] );
399
400 if ( count( $classes ) ) {
401 $attribs['class'] = implode( ' ', $classes );
402 }
403
404 if ( !$title->equals( $oldTitle ) ) {
405 $oldTitleText = $oldTitle->getPrefixedText();
406 $oldTitleText = Html::rawElement(
407 'span',
408 [ 'class' => 'mw-newpages-oldtitle' ],
409 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
410 );
411 }
412
413 return Html::rawElement( 'li', $attribs, $ret ) . "\n";
414 }
415
416 /**
417 * Should a specific result row provide "patrollable" links?
418 *
419 * @param object $result Result row
420 * @return bool
421 */
422 protected function patrollable( $result ) {
423 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
424 }
425
426 /**
427 * Output a subscription feed listing recent edits to this page.
428 *
429 * @param string $type
430 */
431 protected function feed( $type ) {
432 if ( !$this->getConfig()->get( 'Feed' ) ) {
433 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
434
435 return;
436 }
437
438 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
439 if ( !isset( $feedClasses[$type] ) ) {
440 $this->getOutput()->addWikiMsg( 'feed-invalid' );
441
442 return;
443 }
444
445 $feed = new $feedClasses[$type](
446 $this->feedTitle(),
447 $this->msg( 'tagline' )->text(),
448 $this->getPageTitle()->getFullURL()
449 );
450
451 $pager = new NewPagesPager( $this, $this->opts );
452 $limit = $this->opts->getValue( 'limit' );
453 $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
454
455 $feed->outHeader();
456 if ( $pager->getNumRows() > 0 ) {
457 foreach ( $pager->mResult as $row ) {
458 $feed->outItem( $this->feedItem( $row ) );
459 }
460 }
461 $feed->outFooter();
462 }
463
464 protected function feedTitle() {
465 $desc = $this->getDescription();
466 $code = $this->getConfig()->get( 'LanguageCode' );
467 $sitename = $this->getConfig()->get( 'Sitename' );
468
469 return "$sitename - $desc [$code]";
470 }
471
472 protected function feedItem( $row ) {
473 $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
474 if ( $title ) {
475 $date = $row->rc_timestamp;
476 $comments = $title->getTalkPage()->getFullURL();
477
478 return new FeedItem(
479 $title->getPrefixedText(),
480 $this->feedItemDesc( $row ),
481 $title->getFullURL(),
482 $date,
483 $this->feedItemAuthor( $row ),
484 $comments
485 );
486 } else {
487 return null;
488 }
489 }
490
491 protected function feedItemAuthor( $row ) {
492 return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
493 }
494
495 protected function feedItemDesc( $row ) {
496 $revision = $this->revisionFromRcResult( $row );
497 if ( $revision ) {
498 // XXX: include content model/type in feed item?
499 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
500 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
501 htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
502 "</p>\n<hr />\n<div>" .
503 nl2br( htmlspecialchars( $revision->getContent()->serialize() ) ) . "</div>";
504 }
505
506 return '';
507 }
508
509 protected function getGroupName() {
510 return 'changes';
511 }
512
513 protected function getCacheTTL() {
514 return 60 * 5;
515 }
516 }