includes/page/CategoryPage.php

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