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                 // 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
 194                 // to 0 or 1.
 195                 $changed = array_map( function ( $value ) {
 196                         return $value ? '1' : '0';
 197                 }, $changed );
 198
 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(
 204                                 $self,
 205                                 new HtmlArmor( $showhide[$onoff] ),
 206                                 [],
 207                                 [ $key => $onoff ] + $changed
 208                         );
 209                         $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
 210                 }
 211
 212                 return $this->getLanguage()->pipeList( $links );
 213         }
 214
 215         protected function form() {
 216                 $out = $this->getOutput();
 217
 218                 // Consume values
 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' );
 224
 225                 $size = $this->opts->consumeValue( 'size' );
 226                 $max = $this->opts->consumeValue( 'size-mode' ) === 'max';
 227
 228                 // Check username input validity
 229                 $ut = Title::makeTitleSafe( NS_USER, $username );
 230                 $userText = $ut ? $ut->getText() : '';
 231
 232                 // Store query values in hidden fields so that form submission doesn't lose them
 233                 $hidden = [];
 234                 foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
 235                         $hidden[] = Html::hidden( $key, $value );
 236                 }
 237                 $hidden = implode( "\n", $hidden );
 238
 239                 $formDescriptor = [
 240                         'namespace' => [
 241                                 'type' => 'namespaceselect',
 242                                 'name' => 'namespace',
 243                                 'label-message' => 'namespace',
 244                                 'default' => $namespace,
 245                         ],
 246                         'nsinvert' => [
 247                                 'type' => 'check',
 248                                 'name' => 'invert',
 249                                 'label-message' => 'invert',
 250                                 'default' => $nsinvert,
 251                                 'tooltip' => 'invert',
 252                         ],
 253                         'tagFilter' => [
 254                                 'type' => 'tagfilter',
 255                                 'name' => 'tagfilter',
 256                                 'label-raw' => $this->msg( 'tag-filter' )->parse(),
 257                                 'default' => $tagFilterVal,
 258                         ],
 259                         'username' => [
 260                                 'type' => 'user',
 261                                 'name' => 'username',
 262                                 'label-message' => 'newpages-username',
 263                                 'default' => $userText,
 264                                 'id' => 'mw-np-username',
 265                                 'size' => 30,
 266                         ],
 267                         'size' => [
 268                                 'type' => 'sizefilter',
 269                                 'name' => 'size',
 270                                 'default' => -$max * $size,
 271                         ],
 272                 ];
 273
 274                 $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
 275                 $htmlForm
 276                         ->setMethod( 'get' )
 277                         ->setFormIdentifier( 'newpagesform' )
 278                         // The form should be visible on each request (inclusive requests with submitted forms), so
 279                         // return always false here.
 280                         ->setSubmitCallback(
 281                                 function () {
 282                                         return false;
 283                                 }
 284                         )
 285                         ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
 286                         ->setWrapperLegend( $this->msg( 'newpages' )->text() )
 287                         ->addFooterText( Html::rawElement(
 288                                 'div',
 289                                 null,
 290                                 $this->filterLinks()
 291                         ) )
 292                         ->show();
 293                 $out->addModuleStyles( 'mediawiki.special' );
 294         }
 295
 296         /**
 297          * @param stdClass $result Result row from recent changes
 298          * @param Title $title
 299          * @return bool|Revision
 300          */
 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,
 308                 ], 0, $title );
 309         }
 310
 311         /**
 312          * Format a row, providing the timestamp, links to the page/history,
 313          * size, user links, and a comment
 314          *
 315          * @param object $result Result row
 316          * @return string
 317          */
 318         public function formatRow( $result ) {
 319                 $title = Title::newFromRow( $result );
 320
 321                 // Revision deletion works on revisions,
 322                 // so cast our recent change row to a revision row.
 323                 $rev = $this->revisionFromRcResult( $result, $title );
 324
 325                 $classes = [];
 326                 $attribs = [ 'data-mw-revid' => $result->rev_id ];
 327
 328                 $lang = $this->getLanguage();
 329                 $dm = $lang->getDirMark();
 330
 331                 $spanTime = Html::element( 'span', [ 'class' => 'mw-newpages-time' ],
 332                         $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
 333                 );
 334                 $linkRenderer = $this->getLinkRenderer();
 335                 $time = $linkRenderer->makeKnownLink(
 336                         $title,
 337                         new HtmlArmor( $spanTime ),
 338                         [],
 339                         [ 'oldid' => $result->rc_this_oldid ]
 340                 );
 341
 342                 $query = $title->isRedirect() ? [ 'redirect' => 'no' ] : [];
 343
 344                 $plink = $linkRenderer->makeKnownLink(
 345                         $title,
 346                         null,
 347                         [ 'class' => 'mw-newpages-pagename' ],
 348                         $query
 349                 );
 350                 $histLink = $linkRenderer->makeKnownLink(
 351                         $title,
 352                         $this->msg( 'hist' )->text(),
 353                         [],
 354                         [ 'action' => 'history' ]
 355                 );
 356                 $hist = Html::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
 357                         $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
 358
 359                 $length = Html::rawElement(
 360                         'span',
 361                         [ 'class' => 'mw-newpages-length' ],
 362                         $this->msg( 'brackets' )->rawParams(
 363                                 $this->msg( 'nbytes' )->numParams( $result->length )->escaped()
 364                         )->escaped()
 365                 );
 366
 367                 $ulink = Linker::revUserTools( $rev );
 368                 $comment = Linker::revComment( $rev );
 369
 370                 if ( $this->patrollable( $result ) ) {
 371                         $classes[] = 'not-patrolled';
 372                 }
 373
 374                 # Add a class for zero byte pages
 375                 if ( $result->length == 0 ) {
 376                         $classes[] = 'mw-newpages-zero-byte-page';
 377                 }
 378
 379                 # Tags, if any.
 380                 if ( isset( $result->ts_tags ) ) {
 381                         list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
 382                                 $result->ts_tags,
 383                                 'newpages',
 384                                 $this->getContext()
 385                         );
 386                         $classes = array_merge( $classes, $newClasses );
 387                 } else {
 388                         $tagDisplay = '';
 389                 }
 390
 391                 # Display the old title if the namespace/title has been changed
 392                 $oldTitleText = '';
 393                 $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
 394
 395                 if ( !$title->equals( $oldTitle ) ) {
 396                         $oldTitleText = $oldTitle->getPrefixedText();
 397                         $oldTitleText = Html::rawElement(
 398                                 'span',
 399                                 [ 'class' => 'mw-newpages-oldtitle' ],
 400                                 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
 401                         );
 402                 }
 403
 404                 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
 405                         . "{$tagDisplay} {$oldTitleText}";
 406
 407                 // Let extensions add data
 408                 Hooks::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
 409                 $attribs = array_filter( $attribs,
 410                         [ Sanitizer::class, 'isReservedDataAttribute' ],
 411                         ARRAY_FILTER_USE_KEY
 412                 );
 413
 414                 if ( count( $classes ) ) {
 415                         $attribs['class'] = implode( ' ', $classes );
 416                 }
 417
 418                 return Html::rawElement( 'li', $attribs, $ret ) . "\n";
 419         }
 420
 421         /**
 422          * Should a specific result row provide "patrollable" links?
 423          *
 424          * @param object $result Result row
 425          * @return bool
 426          */
 427         protected function patrollable( $result ) {
 428                 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
 429         }
 430
 431         /**
 432          * Output a subscription feed listing recent edits to this page.
 433          *
 434          * @param string $type
 435          */
 436         protected function feed( $type ) {
 437                 if ( !$this->getConfig()->get( 'Feed' ) ) {
 438                         $this->getOutput()->addWikiMsg( 'feed-unavailable' );
 439
 440                         return;
 441                 }
 442
 443                 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
 444                 if ( !isset( $feedClasses[$type] ) ) {
 445                         $this->getOutput()->addWikiMsg( 'feed-invalid' );
 446
 447                         return;
 448                 }
 449
 450                 $feed = new $feedClasses[$type](
 451                         $this->feedTitle(),
 452                         $this->msg( 'tagline' )->text(),
 453                         $this->getPageTitle()->getFullURL()
 454                 );
 455
 456                 $pager = new NewPagesPager( $this, $this->opts );
 457                 $limit = $this->opts->getValue( 'limit' );
 458                 $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
 459
 460                 $feed->outHeader();
 461                 if ( $pager->getNumRows() > 0 ) {
 462                         foreach ( $pager->mResult as $row ) {
 463                                 $feed->outItem( $this->feedItem( $row ) );
 464                         }
 465                 }
 466                 $feed->outFooter();
 467         }
 468
 469         protected function feedTitle() {
 470                 $desc = $this->getDescription();
 471                 $code = $this->getConfig()->get( 'LanguageCode' );
 472                 $sitename = $this->getConfig()->get( 'Sitename' );
 473
 474                 return "$sitename - $desc [$code]";
 475         }
 476
 477         protected function feedItem( $row ) {
 478                 $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
 479                 if ( $title ) {
 480                         $date = $row->rc_timestamp;
 481                         $comments = $title->getTalkPage()->getFullURL();
 482
 483                         return new FeedItem(
 484                                 $title->getPrefixedText(),
 485                                 $this->feedItemDesc( $row ),
 486                                 $title->getFullURL(),
 487                                 $date,
 488                                 $this->feedItemAuthor( $row ),
 489                                 $comments
 490                         );
 491                 } else {
 492                         return null;
 493                 }
 494         }
 495
 496         protected function feedItemAuthor( $row ) {
 497                 return $row->rc_user_text ?? '';
 498         }
 499
 500         protected function feedItemDesc( $row ) {
 501                 $revision = Revision::newFromId( $row->rev_id );
 502                 if ( !$revision ) {
 503                         return '';
 504                 }
 505
 506                 $content = $revision->getContent();
 507                 if ( $content === null ) {
 508                         return '';
 509                 }
 510
 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>";
 517         }
 518
 519         protected function getGroupName() {
 520                 return 'changes';
 521         }
 522
 523         protected function getCacheTTL() {
 524                 return 60 * 5;
 525         }
 526 }