includes/page/CategoryPage.php

   1 <?php
   2 /**
   3  * Special handling for category description pages.
   4  * Modelled after ImagePage.php.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Special handling for category description pages, showing pages,
  26  * subcategories and file that belong to the category
  27  */
  28 class CategoryPage extends Article {
  29         # Subclasses can change this to override the viewer class.
  30         protected $mCategoryViewerClass = 'CategoryViewer';
  31
  32         /**
  33          * @var WikiCategoryPage
  34          */
  35         protected $mPage;
  36
  37         /**
  38          * @param Title $title
  39          * @return WikiCategoryPage
  40          */
  41         protected function newPage( Title $title ) {
  42                 // Overload mPage with a category-specific page
  43                 return new WikiCategoryPage( $title );
  44         }
  45
  46         function view() {
  47                 $request = $this->getContext()->getRequest();
  48                 $diff = $request->getVal( 'diff' );
  49                 $diffOnly = $request->getBool( 'diffonly',
  50                         $this->getContext()->getUser()->getOption( 'diffonly' ) );
  51
  52                 if ( $diff !== null && $diffOnly ) {
  53                         parent::view();
  54                         return;
  55                 }
  56
  57                 // Avoid PHP 7.1 warning of passing $this by reference
  58                 $categoryPage = $this;
  59
  60                 if ( !Hooks::run( 'CategoryPageView', [ &$categoryPage ] ) ) {
  61                         return;
  62                 }
  63
  64                 $title = $this->getTitle();
  65                 if ( $title->inNamespace( NS_CATEGORY ) ) {
  66                         $this->openShowCategory();
  67                 }
  68
  69                 parent::view();
  70
  71                 if ( $title->inNamespace( NS_CATEGORY ) ) {
  72                         $this->closeShowCategory();
  73                 }
  74
  75                 # Use adaptive TTLs for CDN so delayed/failed purges are noticed less often
  76                 $outputPage = $this->getContext()->getOutput();
  77                 $outputPage->adaptCdnTTL( $this->mPage->getTouched(), IExpiringStore::TTL_MINUTE );
  78         }
  79
  80         function openShowCategory() {
  81                 # For overloading
  82         }
  83
  84         function closeShowCategory() {
  85                 // Use these as defaults for back compat --catrope
  86                 $request = $this->getContext()->getRequest();
  87                 $oldFrom = $request->getVal( 'from' );
  88                 $oldUntil = $request->getVal( 'until' );
  89
  90                 $reqArray = $request->getValues();
  91
  92                 $from = $until = [];
  93                 foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
  94                         $from[$type] = $request->getVal( "{$type}from", $oldFrom );
  95                         $until[$type] = $request->getVal( "{$type}until", $oldUntil );
  96
  97                         // Do not want old-style from/until propagating in nav links.
  98                         if ( !isset( $reqArray["{$type}from"] ) && isset( $reqArray["from"] ) ) {
  99                                 $reqArray["{$type}from"] = $reqArray["from"];
 100                         }
 101                         if ( !isset( $reqArray["{$type}to"] ) && isset( $reqArray["to"] ) ) {
 102                                 $reqArray["{$type}to"] = $reqArray["to"];
 103                         }
 104                 }
 105
 106                 unset( $reqArray["from"] );
 107                 unset( $reqArray["to"] );
 108
 109                 $viewer = new $this->mCategoryViewerClass(
 110                         $this->getContext()->getTitle(),
 111                         $this->getContext(),
 112                         $from,
 113                         $until,
 114                         $reqArray
 115                 );
 116                 $out = $this->getContext()->getOutput();
 117                 $out->addHTML( $viewer->getHTML() );
 118                 $this->addHelpLink( 'Help:Categories' );
 119         }
 120
 121         function getCategoryViewerClass() {
 122                 return $this->mCategoryViewerClass;
 123         }
 124
 125         function setCategoryViewerClass( $class ) {
 126                 $this->mCategoryViewerClass = $class;
 127         }
 128 }