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                 $opts = new FormOptions();
  44                 $this->opts = $opts; // bind
  45                 $opts->add( 'hideliu', false );
  46                 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
  47                 $opts->add( 'hidebots', false );
  48                 $opts->add( 'hideredirs', true );
  49                 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
  50                 $opts->add( 'offset', '' );
  51                 $opts->add( 'namespace', '0' );
  52                 $opts->add( 'username', '' );
  53                 $opts->add( 'feed', '' );
  54                 $opts->add( 'tagfilter', '' );
  55                 $opts->add( 'invert', false );
  56                 $opts->add( 'size-mode', 'max' );
  57                 $opts->add( 'size', 0 );
  58
  59                 $this->customFilters = [];
  60                 Hooks::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters ] );
  61                 foreach ( $this->customFilters as $key => $params ) {
  62                         $opts->add( $key, $params['default'] );
  63                 }
  64
  65                 $opts->fetchValuesFromRequest( $this->getRequest() );
  66                 if ( $par ) {
  67                         $this->parseParams( $par );
  68                 }
  69
  70                 $opts->validateIntBounds( 'limit', 0, 5000 );
  71         }
  72
  73         protected function parseParams( $par ) {
  74                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
  75                 foreach ( $bits as $bit ) {
  76                         if ( $bit === 'shownav' ) {
  77                                 $this->showNavigation = true;
  78                         }
  79                         if ( $bit === 'hideliu' ) {
  80                                 $this->opts->setValue( 'hideliu', true );
  81                         }
  82                         if ( $bit === 'hidepatrolled' ) {
  83                                 $this->opts->setValue( 'hidepatrolled', true );
  84                         }
  85                         if ( $bit === 'hidebots' ) {
  86                                 $this->opts->setValue( 'hidebots', true );
  87                         }
  88                         if ( $bit === 'showredirs' ) {
  89                                 $this->opts->setValue( 'hideredirs', false );
  90                         }
  91                         if ( is_numeric( $bit ) ) {
  92                                 $this->opts->setValue( 'limit', intval( $bit ) );
  93                         }
  94
  95                         $m = [];
  96                         if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
  97                                 $this->opts->setValue( 'limit', intval( $m[1] ) );
  98                         }
  99                         // PG offsets not just digits!
 100                         if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
 101                                 $this->opts->setValue( 'offset', intval( $m[1] ) );
 102                         }
 103                         if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
 104                                 $this->opts->setValue( 'username', $m[1] );
 105                         }
 106                         if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
 107                                 $ns = $this->getLanguage()->getNsIndex( $m[1] );
 108                                 if ( $ns !== false ) {
 109                                         $this->opts->setValue( 'namespace', $ns );
 110                                 }
 111                         }
 112                 }
 113         }
 114
 115         /**
 116          * Show a form for filtering namespace and username
 117          *
 118          * @param string $par
 119          */
 120         public function execute( $par ) {
 121                 $out = $this->getOutput();
 122
 123                 $this->setHeaders();
 124                 $this->outputHeader();
 125
 126                 $this->showNavigation = !$this->including(); // Maybe changed in setup
 127                 $this->setup( $par );
 128
 129                 $this->addHelpLink( 'Help:New pages' );
 130
 131                 if ( !$this->including() ) {
 132                         // Settings
 133                         $this->form();
 134
 135                         $feedType = $this->opts->getValue( 'feed' );
 136                         if ( $feedType ) {
 137                                 $this->feed( $feedType );
 138
 139                                 return;
 140                         }
 141
 142                         $allValues = $this->opts->getAllValues();
 143                         unset( $allValues['feed'] );
 144                         $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
 145                 }
 146
 147                 $pager = new NewPagesPager( $this, $this->opts );
 148                 $pager->mLimit = $this->opts->getValue( 'limit' );
 149                 $pager->mOffset = $this->opts->getValue( 'offset' );
 150
 151                 if ( $pager->getNumRows() ) {
 152                         $navigation = '';
 153                         if ( $this->showNavigation ) {
 154                                 $navigation = $pager->getNavigationBar();
 155                         }
 156                         $out->addHTML( $navigation . $pager->getBody() . $navigation );
 157                 } else {
 158                         $out->addWikiMsg( 'specialpage-empty' );
 159                 }
 160         }
 161
 162         protected function filterLinks() {
 163                 // show/hide links
 164                 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
 165
 166                 // Option value -> message mapping
 167                 $filters = [
 168                         'hideliu' => 'rcshowhideliu',
 169                         'hidepatrolled' => 'rcshowhidepatr',
 170                         'hidebots' => 'rcshowhidebots',
 171                         'hideredirs' => 'whatlinkshere-hideredirs'
 172                 ];
 173                 foreach ( $this->customFilters as $key => $params ) {
 174                         $filters[$key] = $params['msg'];
 175                 }
 176
 177                 // Disable some if needed
 178                 if ( !User::groupHasPermission( '*', 'createpage' ) ) {
 179                         unset( $filters['hideliu'] );
 180                 }
 181                 if ( !$this->getUser()->useNPPatrol() ) {
 182                         unset( $filters['hidepatrolled'] );
 183                 }
 184
 185                 $links = [];
 186                 $changed = $this->opts->getChangedValues();
 187                 unset( $changed['offset'] ); // Reset offset if query type changes
 188
 189                 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
 190                 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
 191                 // to 0 or 1.
 192                 // Also do this only for boolean options, not eg. namespace or tagfilter
 193                 foreach ( $changed as $key => $value ) {
 194                         if ( array_key_exists( $key, $filters ) ) {
 195                                 $changed[$key] = $changed[$key] ? '1' : '0';
 196                         }
 197                 }
 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                 $formDescriptor = [
 233                         'namespace' => [
 234                                 'type' => 'namespaceselect',
 235                                 'name' => 'namespace',
 236                                 'label-message' => 'namespace',
 237                                 'default' => $namespace,
 238                         ],
 239                         'nsinvert' => [
 240                                 'type' => 'check',
 241                                 'name' => 'invert',
 242                                 'label-message' => 'invert',
 243                                 'default' => $nsinvert,
 244                                 'tooltip' => 'invert',
 245                         ],
 246                         'tagFilter' => [
 247                                 'type' => 'tagfilter',
 248                                 'name' => 'tagfilter',
 249                                 'label-raw' => $this->msg( 'tag-filter' )->parse(),
 250                                 'default' => $tagFilterVal,
 251                         ],
 252                         'username' => [
 253                                 'type' => 'user',
 254                                 'name' => 'username',
 255                                 'label-message' => 'newpages-username',
 256                                 'default' => $userText,
 257                                 'id' => 'mw-np-username',
 258                                 'size' => 30,
 259                         ],
 260                         'size' => [
 261                                 'type' => 'sizefilter',
 262                                 'name' => 'size',
 263                                 'default' => -$max * $size,
 264                         ],
 265                 ];
 266
 267                 $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
 268
 269                 // Store query values in hidden fields so that form submission doesn't lose them
 270                 foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
 271                         $htmlForm->addHiddenField( $key, $value );
 272                 }
 273
 274                 $htmlForm
 275                         ->setMethod( 'get' )
 276                         ->setFormIdentifier( 'newpagesform' )
 277                         // The form should be visible on each request (inclusive requests with submitted forms), so
 278                         // return always false here.
 279                         ->setSubmitCallback(
 280                                 function () {
 281                                         return false;
 282                                 }
 283                         )
 284                         ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
 285                         ->setWrapperLegend( $this->msg( 'newpages' )->text() )
 286                         ->addFooterText( Html::rawElement(
 287                                 'div',
 288                                 null,
 289                                 $this->filterLinks()
 290                         ) )
 291                         ->show();
 292                 $out->addModuleStyles( 'mediawiki.special' );
 293         }
 294
 295         /**
 296          * @param stdClass $result Result row from recent changes
 297          * @param Title $title
 298          * @return bool|Revision
 299          */
 300         protected function revisionFromRcResult( stdClass $result, Title $title ) {
 301                 return new Revision( [
 302                         'comment' => CommentStore::getStore()->getComment( 'rc_comment', $result )->text,
 303                         'deleted' => $result->rc_deleted,
 304                         'user_text' => $result->rc_user_text,
 305                         'user' => $result->rc_user,
 306                         'actor' => $result->rc_actor,
 307                 ], 0, $title );
 308         }
 309
 310         /**
 311          * Format a row, providing the timestamp, links to the page/history,
 312          * size, user links, and a comment
 313          *
 314          * @param object $result Result row
 315          * @return string
 316          */
 317         public function formatRow( $result ) {
 318                 $title = Title::newFromRow( $result );
 319
 320                 // Revision deletion works on revisions,
 321                 // so cast our recent change row to a revision row.
 322                 $rev = $this->revisionFromRcResult( $result, $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
 394                 if ( !$title->equals( $oldTitle ) ) {
 395                         $oldTitleText = $oldTitle->getPrefixedText();
 396                         $oldTitleText = Html::rawElement(
 397                                 'span',
 398                                 [ 'class' => 'mw-newpages-oldtitle' ],
 399                                 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
 400                         );
 401                 }
 402
 403                 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
 404                         . "{$tagDisplay} {$oldTitleText}";
 405
 406                 // Let extensions add data
 407                 Hooks::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
 408                 $attribs = array_filter( $attribs,
 409                         [ Sanitizer::class, 'isReservedDataAttribute' ],
 410                         ARRAY_FILTER_USE_KEY
 411                 );
 412
 413                 if ( count( $classes ) ) {
 414                         $attribs['class'] = implode( ' ', $classes );
 415                 }
 416
 417                 return Html::rawElement( 'li', $attribs, $ret ) . "\n";
 418         }
 419
 420         /**
 421          * Should a specific result row provide "patrollable" links?
 422          *
 423          * @param object $result Result row
 424          * @return bool
 425          */
 426         protected function patrollable( $result ) {
 427                 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
 428         }
 429
 430         /**
 431          * Output a subscription feed listing recent edits to this page.
 432          *
 433          * @param string $type
 434          */
 435         protected function feed( $type ) {
 436                 if ( !$this->getConfig()->get( 'Feed' ) ) {
 437                         $this->getOutput()->addWikiMsg( 'feed-unavailable' );
 438
 439                         return;
 440                 }
 441
 442                 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
 443                 if ( !isset( $feedClasses[$type] ) ) {
 444                         $this->getOutput()->addWikiMsg( 'feed-invalid' );
 445
 446                         return;
 447                 }
 448
 449                 $feed = new $feedClasses[$type](
 450                         $this->feedTitle(),
 451                         $this->msg( 'tagline' )->text(),
 452                         $this->getPageTitle()->getFullURL()
 453                 );
 454
 455                 $pager = new NewPagesPager( $this, $this->opts );
 456                 $limit = $this->opts->getValue( 'limit' );
 457                 $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
 458
 459                 $feed->outHeader();
 460                 if ( $pager->getNumRows() > 0 ) {
 461                         foreach ( $pager->mResult as $row ) {
 462                                 $feed->outItem( $this->feedItem( $row ) );
 463                         }
 464                 }
 465                 $feed->outFooter();
 466         }
 467
 468         protected function feedTitle() {
 469                 $desc = $this->getDescription();
 470                 $code = $this->getConfig()->get( 'LanguageCode' );
 471                 $sitename = $this->getConfig()->get( 'Sitename' );
 472
 473                 return "$sitename - $desc [$code]";
 474         }
 475
 476         protected function feedItem( $row ) {
 477                 $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
 478                 if ( $title ) {
 479                         $date = $row->rc_timestamp;
 480                         $comments = $title->getTalkPage()->getFullURL();
 481
 482                         return new FeedItem(
 483                                 $title->getPrefixedText(),
 484                                 $this->feedItemDesc( $row ),
 485                                 $title->getFullURL(),
 486                                 $date,
 487                                 $this->feedItemAuthor( $row ),
 488                                 $comments
 489                         );
 490                 } else {
 491                         return null;
 492                 }
 493         }
 494
 495         protected function feedItemAuthor( $row ) {
 496                 return $row->rc_user_text ?? '';
 497         }
 498
 499         protected function feedItemDesc( $row ) {
 500                 $revision = Revision::newFromId( $row->rev_id );
 501                 if ( !$revision ) {
 502                         return '';
 503                 }
 504
 505                 $content = $revision->getContent();
 506                 if ( $content === null ) {
 507                         return '';
 508                 }
 509
 510                 // XXX: include content model/type in feed item?
 511                 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
 512                         $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
 513                         htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
 514                         "</p>\n<hr />\n<div>" .
 515                         nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
 516         }
 517
 518         protected function getGroupName() {
 519                 return 'changes';
 520         }
 521
 522         protected function getCacheTTL() {
 523                 return 60 * 5;
 524         }
 525 }