includes/specials/SpecialWantedfiles.php

   1 <?php
   2 /**
   3  * Implements Special:Wantedfiles
   4  *
   5  * Copyright © 2008 Soxred93
   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 Soxred93 <soxred93@gmail.com>
  25  */
  26
  27 /**
  28  * Querypage that lists the most wanted files
  29  *
  30  * @ingroup SpecialPage
  31  */
  32 class WantedFilesPage extends WantedQueryPage {
  33
  34         function __construct( $name = 'Wantedfiles' ) {
  35                 parent::__construct( $name );
  36         }
  37
  38         function getPageHeader() {
  39                 # Specifically setting to use "Wanted Files" (NS_MAIN) as title, so as to get what
  40                 # category would be used on main namespace pages, for those tricky wikipedia
  41                 # admins who like to do {{#ifeq:{{NAMESPACE}}|foo|bar|....}}.
  42                 $catMessage = $this->msg( 'broken-file-category' )
  43                         ->title( Title::newFromText( "Wanted Files", NS_MAIN ) )
  44                         ->inContentLanguage();
  45
  46                 if ( !$catMessage->isDisabled() ) {
  47                         $category = Title::makeTitleSafe( NS_CATEGORY, $catMessage->text() );
  48                 } else {
  49                         $category = false;
  50                 }
  51
  52                 $noForeign = '';
  53                 if ( !$this->likelyToHaveFalsePositives() ) {
  54                         // Additional messages for grep:
  55                         // wantedfiletext-cat-noforeign, wantedfiletext-nocat-noforeign
  56                         $noForeign = '-noforeign';
  57                 }
  58
  59                 if ( $category ) {
  60                         return $this
  61                                 ->msg( 'wantedfiletext-cat' . $noForeign )
  62                                 ->params( $category->getFullText() )
  63                                 ->parseAsBlock();
  64                 } else {
  65                         return $this
  66                                 ->msg( 'wantedfiletext-nocat' . $noForeign )
  67                                 ->parseAsBlock();
  68                 }
  69         }
  70
  71         /**
  72          * Whether foreign repos are likely to cause false positives
  73          *
  74          * In its own function to allow subclasses to override.
  75          * @see SpecialWantedFilesGUOverride in GlobalUsage extension.
  76          * @since 1.24
  77          * @return bool
  78          */
  79         protected function likelyToHaveFalsePositives() {
  80                 return RepoGroup::singleton()->hasForeignRepos();
  81         }
  82
  83         /**
  84          * KLUGE: The results may contain false positives for files
  85          * that exist e.g. in a shared repo.  Setting this at least
  86          * keeps them from showing up as redlinks in the output, even
  87          * if it doesn't fix the real problem (T8220).
  88          *
  89          * @note could also have existing links here from broken file
  90          * redirects.
  91          * @return bool
  92          */
  93         function forceExistenceCheck() {
  94                 return true;
  95         }
  96
  97         /**
  98          * Does the file exist?
  99          *
 100          * Use wfFindFile so we still think file namespace pages without
 101          * files are missing, but valid file redirects and foreign files are ok.
 102          *
 103          * @param Title $title
 104          * @return bool
 105          */
 106         protected function existenceCheck( Title $title ) {
 107                 return (bool)wfFindFile( $title );
 108         }
 109
 110         function getQueryInfo() {
 111                 return [
 112                         'tables' => [
 113                                 'imagelinks',
 114                                 'page',
 115                                 'redirect',
 116                                 'img1' => 'image',
 117                                 'img2' => 'image',
 118                         ],
 119                         'fields' => [
 120                                 'namespace' => NS_FILE,
 121                                 'title' => 'il_to',
 122                                 'value' => 'COUNT(*)'
 123                         ],
 124                         'conds' => [
 125                                 'img1.img_name' => null,
 126                                 // We also need to exclude file redirects
 127                                 'img2.img_name' => null,
 128                         ],
 129                         'options' => [ 'GROUP BY' => 'il_to' ],
 130                         'join_conds' => [
 131                                 'img1' => [ 'LEFT JOIN',
 132                                         'il_to = img1.img_name'
 133                                 ],
 134                                 'page' => [ 'LEFT JOIN', [
 135                                         'il_to = page_title',
 136                                         'page_namespace' => NS_FILE,
 137                                 ] ],
 138                                 'redirect' => [ 'LEFT JOIN', [
 139                                         'page_id = rd_from',
 140                                         'rd_namespace' => NS_FILE,
 141                                         'rd_interwiki' => ''
 142                                 ] ],
 143                                 'img2' => [ 'LEFT JOIN',
 144                                         'rd_title = img2.img_name'
 145                                 ]
 146                         ]
 147                 ];
 148         }
 149
 150         protected function getGroupName() {
 151                 return 'maintenance';
 152         }
 153 }