includes/specials/SpecialUnwatchedPages.php

   1 <?php
   2 /**
   3  * Implements Special:Unwatchedpages
   4  *
   5  * Copyright © 2005 Ævar Arnfjörð Bjarmason
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @ingroup SpecialPage
  24  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  25  */
  26
  27 use MediaWiki\MediaWikiServices;
  28 use Wikimedia\Rdbms\IResultWrapper;
  29 use Wikimedia\Rdbms\IDatabase;
  30
  31 /**
  32  * A special page that displays a list of pages that are not on anyones watchlist.
  33  *
  34  * @ingroup SpecialPage
  35  */
  36 class SpecialUnwatchedPages extends QueryPage {
  37
  38         function __construct( $name = 'Unwatchedpages' ) {
  39                 parent::__construct( $name, 'unwatchedpages' );
  40         }
  41
  42         public function isExpensive() {
  43                 return true;
  44         }
  45
  46         function isSyndicated() {
  47                 return false;
  48         }
  49
  50         /**
  51          * Pre-cache page existence to speed up link generation
  52          *
  53          * @param IDatabase $db
  54          * @param IResultWrapper $res
  55          */
  56         public function preprocessResults( $db, $res ) {
  57                 if ( !$res->numRows() ) {
  58                         return;
  59                 }
  60
  61                 $batch = new LinkBatch();
  62                 foreach ( $res as $row ) {
  63                         $batch->add( $row->namespace, $row->title );
  64                 }
  65                 $batch->execute();
  66
  67                 $res->seek( 0 );
  68         }
  69
  70         public function getQueryInfo() {
  71                 $dbr = wfGetDB( DB_REPLICA );
  72                 return [
  73                         'tables' => [ 'page', 'watchlist' ],
  74                         'fields' => [
  75                                 'namespace' => 'page_namespace',
  76                                 'title' => 'page_title',
  77                                 'value' => 'page_namespace'
  78                         ],
  79                         'conds' => [
  80                                 'wl_title IS NULL',
  81                                 'page_is_redirect' => 0,
  82                                 'page_namespace != ' . $dbr->addQuotes( NS_MEDIAWIKI ),
  83                         ],
  84                         'join_conds' => [ 'watchlist' => [
  85                                 'LEFT JOIN', [ 'wl_title = page_title',
  86                                         'wl_namespace = page_namespace' ] ] ]
  87                 ];
  88         }
  89
  90         function sortDescending() {
  91                 return false;
  92         }
  93
  94         function getOrderFields() {
  95                 return [ 'page_namespace', 'page_title' ];
  96         }
  97
  98         /**
  99          * Add the JS
 100          * @param string|null $par
 101          */
 102         public function execute( $par ) {
 103                 parent::execute( $par );
 104                 $this->getOutput()->addModules( 'mediawiki.special.unwatchedPages' );
 105                 $this->addHelpLink( 'Help:Watchlist' );
 106         }
 107
 108         /**
 109          * @param Skin $skin
 110          * @param object $result Result row
 111          * @return string
 112          */
 113         function formatResult( $skin, $result ) {
 114                 $nt = Title::makeTitleSafe( $result->namespace, $result->title );
 115                 if ( !$nt ) {
 116                         return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
 117                                 Linker::getInvalidTitleDescription( $this->getContext(), $result->namespace, $result->title ) );
 118                 }
 119
 120                 $text = MediaWikiServices::getInstance()->getContentLanguage()->
 121                         convert( htmlspecialchars( $nt->getPrefixedText() ) );
 122
 123                 $linkRenderer = $this->getLinkRenderer();
 124
 125                 $plink = $linkRenderer->makeKnownLink( $nt, new HtmlArmor( $text ) );
 126                 $wlink = $linkRenderer->makeKnownLink(
 127                         $nt,
 128                         $this->msg( 'watch' )->text(),
 129                         [ 'class' => 'mw-watch-link' ],
 130                         [ 'action' => 'watch' ]
 131                 );
 132
 133                 return $this->getLanguage()->specialList( $plink, $wlink );
 134         }
 135
 136         protected function getGroupName() {
 137                 return 'maintenance';
 138         }
 139 }