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