includes/specials/SpecialBrokenRedirects.php

   1 <?php
   2 /**
   3  * Implements Special:Brokenredirects
   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 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Rdbms\IResultWrapper;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * A special page listing redirects to non existent page. Those should be
  30  * fixed to point to an existing page.
  31  *
  32  * @ingroup SpecialPage
  33  */
  34 class SpecialBrokenRedirects extends QueryPage {
  35         function __construct( $name = 'BrokenRedirects' ) {
  36                 parent::__construct( $name );
  37         }
  38
  39         public function isExpensive() {
  40                 return true;
  41         }
  42
  43         function isSyndicated() {
  44                 return false;
  45         }
  46
  47         function sortDescending() {
  48                 return false;
  49         }
  50
  51         function getPageHeader() {
  52                 return $this->msg( 'brokenredirectstext' )->parseAsBlock();
  53         }
  54
  55         public function getQueryInfo() {
  56                 $dbr = wfGetDB( DB_REPLICA );
  57
  58                 return [
  59                         'tables' => [
  60                                 'redirect',
  61                                 'p1' => 'page',
  62                                 'p2' => 'page',
  63                         ],
  64                         'fields' => [
  65                                 'namespace' => 'p1.page_namespace',
  66                                 'title' => 'p1.page_title',
  67                                 'value' => 'p1.page_title',
  68                                 'rd_namespace',
  69                                 'rd_title',
  70                                 'rd_fragment',
  71                         ],
  72                         'conds' => [
  73                                 // Exclude pages that don't exist locally as wiki pages,
  74                                 // but aren't "broken" either.
  75                                 // Special pages and interwiki links
  76                                 'rd_namespace >= 0',
  77                                 'rd_interwiki IS NULL OR rd_interwiki = ' . $dbr->addQuotes( '' ),
  78                                 'p2.page_namespace IS NULL',
  79                         ],
  80                         'join_conds' => [
  81                                 'p1' => [ 'JOIN', [
  82                                         'rd_from=p1.page_id',
  83                                 ] ],
  84                                 'p2' => [ 'LEFT JOIN', [
  85                                         'rd_namespace=p2.page_namespace',
  86                                         'rd_title=p2.page_title'
  87                                 ] ],
  88                         ],
  89                 ];
  90         }
  91
  92         /**
  93          * @return array
  94          */
  95         function getOrderFields() {
  96                 return [ 'rd_namespace', 'rd_title', 'rd_from' ];
  97         }
  98
  99         /**
 100          * @param Skin $skin
 101          * @param object $result Result row
 102          * @return string
 103          */
 104         function formatResult( $skin, $result ) {
 105                 $fromObj = Title::makeTitle( $result->namespace, $result->title );
 106                 if ( isset( $result->rd_title ) ) {
 107                         $toObj = Title::makeTitle( $result->rd_namespace, $result->rd_title, $result->rd_fragment );
 108                 } else {
 109                         $blinks = $fromObj->getBrokenLinksFrom(); # TODO: check for redirect, not for links
 110                         if ( $blinks ) {
 111                                 $toObj = $blinks[0];
 112                         } else {
 113                                 $toObj = false;
 114                         }
 115                 }
 116
 117                 $linkRenderer = $this->getLinkRenderer();
 118                 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
 119
 120                 // $toObj may very easily be false if the $result list is cached
 121                 if ( !is_object( $toObj ) ) {
 122                         return '<del>' . $linkRenderer->makeLink( $fromObj ) . '</del>';
 123                 }
 124
 125                 $from = $linkRenderer->makeKnownLink(
 126                         $fromObj,
 127                         null,
 128                         [],
 129                         [ 'redirect' => 'no' ]
 130                 );
 131                 $links = [];
 132                 // if the page is editable, add an edit link
 133                 if (
 134                         // check user permissions
 135                         $permissionManager->userHasRight( $this->getUser(), 'edit' ) &&
 136                         // check, if the content model is editable through action=edit
 137                         ContentHandler::getForTitle( $fromObj )->supportsDirectEditing()
 138                 ) {
 139                         $links[] = $linkRenderer->makeKnownLink(
 140                                 $fromObj,
 141                                 $this->msg( 'brokenredirects-edit' )->text(),
 142                                 [],
 143                                 [ 'action' => 'edit' ]
 144                         );
 145                 }
 146                 $to = $linkRenderer->makeBrokenLink( $toObj, $toObj->getFullText() );
 147                 $arr = $this->getLanguage()->getArrow();
 148
 149                 $out = $from . $this->msg( 'word-separator' )->escaped();
 150
 151                 if ( $permissionManager->userHasRight( $this->getUser(), 'delete' ) ) {
 152                         $links[] = $linkRenderer->makeKnownLink(
 153                                 $fromObj,
 154                                 $this->msg( 'brokenredirects-delete' )->text(),
 155                                 [],
 156                                 [ 'action' => 'delete' ]
 157                         );
 158                 }
 159
 160                 if ( $links ) {
 161                         $out .= $this->msg( 'parentheses' )->rawParams( $this->getLanguage()
 162                                 ->pipeList( $links ) )->escaped();
 163                 }
 164                 $out .= " {$arr} {$to}";
 165
 166                 return $out;
 167         }
 168
 169         public function execute( $par ) {
 170                 $this->addHelpLink( 'Help:Redirects' );
 171                 parent::execute( $par );
 172         }
 173
 174         /**
 175          * Cache page content model for performance
 176          *
 177          * @param IDatabase $db
 178          * @param IResultWrapper $res
 179          */
 180         function preprocessResults( $db, $res ) {
 181                 $this->executeLBFromResultWrapper( $res );
 182         }
 183
 184         protected function getGroupName() {
 185                 return 'maintenance';
 186         }
 187 }