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