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' => 'user',
 255                                 'name' => 'username',
 256                                 'label-message' => 'newpages-username',
 257                                 'default' => $userText,
 258                                 'id' => 'mw-np-username',
 259                                 'size' => 30,
 260                         ],
 261                         'size' => [
 262                                 'type' => 'sizefilter',
 263                                 'name' => 'size',
 264                                 'default' => -$max * $size,
 265                         ],
 266                 ];
 267
 268                 $htmlForm = new HTMLForm( $form, $this->getContext() );
 269
 270                 $htmlForm->setSubmitText( $this->msg( 'newpages-submit' )->text() );
 271                 // The form should be visible on each request (inclusive requests with submitted forms), so
 272                 // return always false here.
 273                 $htmlForm->setSubmitCallback(
 274                         function () {
 275                                 return false;
 276                         }
 277                 );
 278                 $htmlForm->setMethod( 'get' );
 279                 $htmlForm->setWrapperLegend( true );
 280                 $htmlForm->setWrapperLegendMsg( 'newpages' );
 281                 $htmlForm->addFooterText( Html::rawElement(
 282                         'div',
 283                         null,
 284                         $this->filterLinks()
 285                 ) );
 286                 $htmlForm->show();
 287         }
 288
 289         /**
 290          * @param stdClass $result Result row from recent changes
 291          * @param Title $title
 292          * @return bool|Revision
 293          */
 294         protected function revisionFromRcResult( stdClass $result, Title $title ) {
 295                 return new Revision( [
 296                         'comment' => CommentStore::getStore()->getComment( 'rc_comment', $result )->text,
 297                         'deleted' => $result->rc_deleted,
 298                         'user_text' => $result->rc_user_text,
 299                         'user' => $result->rc_user,
 300                         'actor' => $result->rc_actor,
 301                 ], 0, $title );
 302         }
 303
 304         /**
 305          * Format a row, providing the timestamp, links to the page/history,
 306          * size, user links, and a comment
 307          *
 308          * @param object $result Result row
 309          * @return string
 310          */
 311         public function formatRow( $result ) {
 312                 $title = Title::newFromRow( $result );
 313
 314                 // Revision deletion works on revisions,
 315                 // so cast our recent change row to a revision row.
 316                 $rev = $this->revisionFromRcResult( $result, $title );
 317
 318                 $classes = [];
 319                 $attribs = [ 'data-mw-revid' => $result->rev_id ];
 320
 321                 $lang = $this->getLanguage();
 322                 $dm = $lang->getDirMark();
 323
 324                 $spanTime = Html::element( 'span', [ 'class' => 'mw-newpages-time' ],
 325                         $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
 326                 );
 327                 $linkRenderer = $this->getLinkRenderer();
 328                 $time = $linkRenderer->makeKnownLink(
 329                         $title,
 330                         new HtmlArmor( $spanTime ),
 331                         [],
 332                         [ 'oldid' => $result->rc_this_oldid ]
 333                 );
 334
 335                 $query = $title->isRedirect() ? [ 'redirect' => 'no' ] : [];
 336
 337                 $plink = $linkRenderer->makeKnownLink(
 338                         $title,
 339                         null,
 340                         [ 'class' => 'mw-newpages-pagename' ],
 341                         $query
 342                 );
 343                 $histLink = $linkRenderer->makeKnownLink(
 344                         $title,
 345                         $this->msg( 'hist' )->text(),
 346                         [],
 347                         [ 'action' => 'history' ]
 348                 );
 349                 $hist = Html::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
 350                         $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
 351
 352                 $length = Html::rawElement(
 353                         'span',
 354                         [ 'class' => 'mw-newpages-length' ],
 355                         $this->msg( 'brackets' )->rawParams(
 356                                 $this->msg( 'nbytes' )->numParams( $result->length )->escaped()
 357                         )->escaped()
 358                 );
 359
 360                 $ulink = Linker::revUserTools( $rev );
 361                 $comment = Linker::revComment( $rev );
 362
 363                 if ( $this->patrollable( $result ) ) {
 364                         $classes[] = 'not-patrolled';
 365                 }
 366
 367                 # Add a class for zero byte pages
 368                 if ( $result->length == 0 ) {
 369                         $classes[] = 'mw-newpages-zero-byte-page';
 370                 }
 371
 372                 # Tags, if any.
 373                 if ( isset( $result->ts_tags ) ) {
 374                         list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
 375                                 $result->ts_tags,
 376                                 'newpages',
 377                                 $this->getContext()
 378                         );
 379                         $classes = array_merge( $classes, $newClasses );
 380                 } else {
 381                         $tagDisplay = '';
 382                 }
 383
 384                 # Display the old title if the namespace/title has been changed
 385                 $oldTitleText = '';
 386                 $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
 387
 388                 if ( !$title->equals( $oldTitle ) ) {
 389                         $oldTitleText = $oldTitle->getPrefixedText();
 390                         $oldTitleText = Html::rawElement(
 391                                 'span',
 392                                 [ 'class' => 'mw-newpages-oldtitle' ],
 393                                 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
 394                         );
 395                 }
 396
 397                 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
 398                         . "{$tagDisplay} {$oldTitleText}";
 399
 400                 // Let extensions add data
 401                 Hooks::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
 402                 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer::class, 'isReservedDataAttribute' ] );
 403
 404                 if ( count( $classes ) ) {
 405                         $attribs['class'] = implode( ' ', $classes );
 406                 }
 407
 408                 return Html::rawElement( 'li', $attribs, $ret ) . "\n";
 409         }
 410
 411         /**
 412          * Should a specific result row provide "patrollable" links?
 413          *
 414          * @param object $result Result row
 415          * @return bool
 416          */
 417         protected function patrollable( $result ) {
 418                 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
 419         }
 420
 421         /**
 422          * Output a subscription feed listing recent edits to this page.
 423          *
 424          * @param string $type
 425          */
 426         protected function feed( $type ) {
 427                 if ( !$this->getConfig()->get( 'Feed' ) ) {
 428                         $this->getOutput()->addWikiMsg( 'feed-unavailable' );
 429
 430                         return;
 431                 }
 432
 433                 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
 434                 if ( !isset( $feedClasses[$type] ) ) {
 435                         $this->getOutput()->addWikiMsg( 'feed-invalid' );
 436
 437                         return;
 438                 }
 439
 440                 $feed = new $feedClasses[$type](
 441                         $this->feedTitle(),
 442                         $this->msg( 'tagline' )->text(),
 443                         $this->getPageTitle()->getFullURL()
 444                 );
 445
 446                 $pager = new NewPagesPager( $this, $this->opts );
 447                 $limit = $this->opts->getValue( 'limit' );
 448                 $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
 449
 450                 $feed->outHeader();
 451                 if ( $pager->getNumRows() > 0 ) {
 452                         foreach ( $pager->mResult as $row ) {
 453                                 $feed->outItem( $this->feedItem( $row ) );
 454                         }
 455                 }
 456                 $feed->outFooter();
 457         }
 458
 459         protected function feedTitle() {
 460                 $desc = $this->getDescription();
 461                 $code = $this->getConfig()->get( 'LanguageCode' );
 462                 $sitename = $this->getConfig()->get( 'Sitename' );
 463
 464                 return "$sitename - $desc [$code]";
 465         }
 466
 467         protected function feedItem( $row ) {
 468                 $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
 469                 if ( $title ) {
 470                         $date = $row->rc_timestamp;
 471                         $comments = $title->getTalkPage()->getFullURL();
 472
 473                         return new FeedItem(
 474                                 $title->getPrefixedText(),
 475                                 $this->feedItemDesc( $row ),
 476                                 $title->getFullURL(),
 477                                 $date,
 478                                 $this->feedItemAuthor( $row ),
 479                                 $comments
 480                         );
 481                 } else {
 482                         return null;
 483                 }
 484         }
 485
 486         protected function feedItemAuthor( $row ) {
 487                 return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
 488         }
 489
 490         protected function feedItemDesc( $row ) {
 491                 $revision = Revision::newFromId( $row->rev_id );
 492                 if ( !$revision ) {
 493                         return '';
 494                 }
 495
 496                 $content = $revision->getContent();
 497                 if ( $content === null ) {
 498                         return '';
 499                 }
 500
 501                 // XXX: include content model/type in feed item?
 502                 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
 503                         $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
 504                         htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
 505                         "</p>\n<hr />\n<div>" .
 506                         nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
 507         }
 508
 509         protected function getGroupName() {
 510                 return 'changes';
 511         }
 512
 513         protected function getCacheTTL() {
 514                 return 60 * 5;
 515         }
 516 }