includes/CategoryPage.php

   1 <?php
   2 /**
   3  * Special handling for category description pages
   4  * Modelled after ImagePage.php
   5  *
   6  * @package MediaWiki
   7  */
   8
   9 if( !defined( 'MEDIAWIKI' ) )
  10         die( 1 );
  11
  12 /**
  13  * @package MediaWiki
  14  */
  15 class CategoryPage extends Article {
  16         function view() {
  17                 if(!wfRunHooks('CategoryPageView', array(&$this))) return;
  18
  19                 if ( NS_CATEGORY == $this->mTitle->getNamespace() ) {
  20                         $this->openShowCategory();
  21                 }
  22
  23                 Article::view();
  24
  25                 # If the article we've just shown is in the "Image" namespace,
  26                 # follow it with the history list and link list for the image
  27                 # it describes.
  28
  29                 if ( NS_CATEGORY == $this->mTitle->getNamespace() ) {
  30                         $this->closeShowCategory();
  31                 }
  32         }
  33
  34         function openShowCategory() {
  35                 # For overloading
  36         }
  37
  38         function closeShowCategory() {
  39                 global $wgOut, $wgRequest;
  40                 $from = $wgRequest->getVal( 'from' );
  41                 $until = $wgRequest->getVal( 'until' );
  42
  43                 $viewer = new CategoryViewer( $this->mTitle, $from, $until );
  44                 $wgOut->addHTML( $viewer->getHTML() );
  45         }
  46 }
  47
  48 class CategoryViewer {
  49         var $title, $limit, $from, $until,
  50                 $articles, $articles_start_char,
  51                 $children, $children_start_char,
  52                 $showGallery, $gallery,
  53                 $skin;
  54
  55         function __construct( $title, $from, $until ) {
  56                 global $wgCategoryPagingLimit;
  57                 $this->title = $title;
  58                 $this->from = $from;
  59                 $this->until = $until;
  60                 $this->limit = $wgCategoryPagingLimit;
  61         }
  62
  63         /**
  64          * Format the category data list.
  65          *
  66          * @param string $from -- return only sort keys from this item on
  67          * @param string $until -- don't return keys after this point.
  68          * @return string HTML output
  69          * @private
  70          */
  71         function getHTML() {
  72                 global $wgOut, $wgCategoryMagicGallery, $wgCategoryPagingLimit;
  73                 wfProfileIn( __METHOD__ );
  74
  75                 $this->showGallery = $wgCategoryMagicGallery && !$wgOut->mNoGallery;
  76
  77                 $this->clearCategoryState();
  78                 $this->doCategoryQuery();
  79                 $this->finaliseCategoryState();
  80
  81                 $r = $this->getCategoryTop() .
  82                         $this->getSubcategorySection() .
  83                         $this->getPagesSection() .
  84                         $this->getImageSection() .
  85                         $this->getCategoryBottom();
  86
  87                 wfProfileOut( __METHOD__ );
  88                 return $r;
  89         }
  90
  91         function clearCategoryState() {
  92                 $this->articles = array();
  93                 $this->articles_start_char = array();
  94                 $this->children = array();
  95                 $this->children_start_char = array();
  96                 if( $this->showGallery ) {
  97                         $this->gallery = new ImageGallery();
  98                         $this->gallery->setParsing();
  99                 }
 100         }
 101
 102         function getSkin() {
 103                 if ( !$this->skin ) {
 104                         global $wgUser;
 105                         $this->skin = $wgUser->getSkin();
 106                 }
 107                 return $this->skin;
 108         }
 109
 110         /**
 111          * Add a subcategory to the internal lists
 112          */
 113         function addSubcategory( $title, $sortkey, $pageLength ) {
 114                 global $wgContLang;
 115                 // Subcategory; strip the 'Category' namespace from the link text.
 116                 $this->children[] = $this->getSkin()->makeKnownLinkObj(
 117                         $title, $wgContLang->convertHtml( $title->getText() ) );
 118
 119                 // If there's a link from Category:A to Category:B, the sortkey of the resulting
 120                 // entry in the categorylinks table is Category:A, not A, which it SHOULD be.
 121                 // Workaround: If sortkey == "Category:".$title, than use $title for sorting,
 122                 // else use sortkey...
 123                 $sortkey = '';
 124                 if( $title->getPrefixedText() == $sortkey ) {
 125                         $sortkey = $wgContLang->firstChar( $title->getDBkey() );
 126                 } else {
 127                         $sortkey = $wgContLang->firstChar( $sortkey );
 128                 }
 129                 $this->children_start_char[] = $wgContLang->convert( $sortkey );
 130         }
 131
 132         /**
 133          * Add a page in the image namespace
 134          */
 135         function addImage( $title, $sortkey, $pageLength ) {
 136                 if ( $this->showGallery ) {
 137                         $image = new Image( $title );
 138                         if( $this->flip ) {
 139                                 $this->gallery->insert( $image );
 140                         } else {
 141                                 $this->gallery->add( $image );
 142                         }
 143                 } else {
 144                         $this->addPage( $title, $sortkey, $pageLength );
 145                 }
 146         }
 147
 148         /**
 149          * Add a miscellaneous page
 150          */
 151         function addPage( $title, $sortkey, $pageLength ) {
 152                 global $wgContLang;
 153                 $this->articles[] = $this->getSkin()->makeSizeLinkObj(
 154                         $pageLength, $title, $wgContLang->convert( $title->getPrefixedText() )
 155                 );
 156                 $this->articles_start_char[] = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );
 157         }
 158
 159         function finaliseCategoryState() {
 160                 if( $this->flip ) {
 161                         $this->children            = array_reverse( $this->children );
 162                         $this->children_start_char = array_reverse( $this->children_start_char );
 163                         $this->articles            = array_reverse( $this->articles );
 164                         $this->articles_start_char = array_reverse( $this->articles_start_char );
 165                 }
 166         }
 167
 168         function doCategoryQuery() {
 169                 $dbr =& wfGetDB( DB_SLAVE );
 170                 if( $this->from != '' ) {
 171                         $pageCondition = 'cl_sortkey >= ' . $dbr->addQuotes( $this->from );
 172                         $this->flip = false;
 173                 } elseif( $this->until != '' ) {
 174                         $pageCondition = 'cl_sortkey < ' . $dbr->addQuotes( $this->until );
 175                         $this->flip = true;
 176                 } else {
 177                         $pageCondition = '1 = 1';
 178                         $this->flip = false;
 179                 }
 180                 $res = $dbr->select(
 181                         array( 'page', 'categorylinks' ),
 182                         array( 'page_title', 'page_namespace', 'page_len', 'cl_sortkey' ),
 183                         array( $pageCondition,
 184                                'cl_from          =  page_id',
 185                                'cl_to'           => $this->title->getDBKey()),
 186                                #'page_is_redirect' => 0),
 187                         #+ $pageCondition,
 188                         __METHOD__,
 189                         array( 'ORDER BY' => $this->flip ? 'cl_sortkey DESC' : 'cl_sortkey',
 190                                'LIMIT'    => $this->limit + 1 ) );
 191
 192                 $count = 0;
 193                 $this->nextPage = null;
 194                 while( $x = $dbr->fetchObject ( $res ) ) {
 195                         if( ++$count > $this->limit ) {
 196                                 // We've reached the one extra which shows that there are
 197                                 // additional pages to be had. Stop here...
 198                                 $this->nextPage = $x->cl_sortkey;
 199                                 break;
 200                         }
 201
 202                         $title = Title::makeTitle( $x->page_namespace, $x->page_title );
 203
 204                         if( $title->getNamespace() == NS_CATEGORY ) {
 205                                 $this->addSubcategory( $title, $x->cl_sortkey, $x->page_len );
 206                         } elseif( $title->getNamespace() == NS_IMAGE ) {
 207                                 $this->addImage( $title, $x->cl_sortkey, $x->page_len );
 208                         } else {
 209                                 $this->addPage( $title, $x->cl_sortkey, $x->page_len );
 210                         }
 211                 }
 212                 $dbr->freeResult( $res );
 213         }
 214
 215         function getCategoryTop() {
 216                 $r = "<br style=\"clear:both;\"/>\n";
 217                 if( $this->until != '' ) {
 218                         $r .= $this->pagingLinks( $this->title, $this->nextPage, $this->until, $this->limit );
 219                 } elseif( $this->nextPage != '' || $this->from != '' ) {
 220                         $r .= $this->pagingLinks( $this->title, $this->from, $this->nextPage, $this->limit );
 221                 }
 222                 return $r;
 223         }
 224
 225         function getSubcategorySection() {
 226                 # Don't show subcategories section if there are none.
 227                 $r = '';
 228                 if( count( $this->children ) > 0 ) {
 229                         # Showing subcategories
 230                         $r .= '<h2>' . wfMsg( 'subcategories' ) . "</h2>\n";
 231                         $r .= wfMsgExt( 'subcategorycount', array( 'parse' ), count( $this->children) );
 232                         $r .= $this->formatList( $this->children, $this->children_start_char );
 233                 }
 234                 return $r;
 235         }
 236
 237         function getPagesSection() {
 238                 $ti = htmlspecialchars( $this->title->getText() );
 239                 $r = '<h2>' . wfMsg( 'category_header', $ti ) . "</h2>\n";
 240                 $r .= wfMsgExt( 'categoryarticlecount', array( 'parse' ), count( $this->articles) );
 241                 $r .= $this->formatList( $this->articles, $this->articles_start_char );
 242                 return $r;
 243         }
 244
 245         function getImageSection() {
 246                 if( $this->showGallery && ! $this->gallery->isEmpty() ) {
 247                         return $this->gallery->toHTML();
 248                 } else {
 249                         return '';
 250                 }
 251         }
 252
 253         function getCategoryBottom() {
 254                 if( $this->until != '' ) {
 255                         return $this->pagingLinks( $this->title, $this->nextPage, $this->until, $this->limit );
 256                 } elseif( $this->nextPage != '' || $this->from != '' ) {
 257                         return $this->pagingLinks( $this->title, $this->from, $this->nextPage, $this->limit );
 258                 } else {
 259                         return '';
 260                 }
 261         }
 262
 263         /**
 264          * Format a list of articles chunked by letter, either as a
 265          * bullet list or a columnar format, depending on the length.
 266          *
 267          * @param array $articles
 268          * @param array $articles_start_char
 269          * @param int   $cutoff
 270          * @return string
 271          * @private
 272          */
 273         function formatList( $articles, $articles_start_char, $cutoff = 6 ) {
 274                 if ( count ( $articles ) > $cutoff ) {
 275                         return $this->columnList( $articles, $articles_start_char );
 276                 } elseif ( count($articles) > 0) {
 277                         // for short lists of articles in categories.
 278                         return $this->shortList( $articles, $articles_start_char );
 279                 }
 280                 return '';
 281         }
 282
 283         /**
 284          * Format a list of articles chunked by letter in a three-column
 285          * list, ordered vertically.
 286          *
 287          * @param array $articles
 288          * @param array $articles_start_char
 289          * @return string
 290          * @private
 291          */
 292         function columnList( $articles, $articles_start_char ) {
 293                 // divide list into three equal chunks
 294                 $chunk = (int) (count ( $articles ) / 3);
 295
 296                 // get and display header
 297                 $r = '<table width="100%"><tr valign="top">';
 298
 299                 $prev_start_char = 'none';
 300
 301                 // loop through the chunks
 302                 for($startChunk = 0, $endChunk = $chunk, $chunkIndex = 0;
 303                         $chunkIndex < 3;
 304                         $chunkIndex++, $startChunk = $endChunk, $endChunk += $chunk + 1)
 305                 {
 306                         $r .= "<td>\n";
 307                         $atColumnTop = true;
 308
 309                         // output all articles in category
 310                         for ($index = $startChunk ;
 311                                 $index < $endChunk && $index < count($articles);
 312                                 $index++ )
 313                         {
 314                                 // check for change of starting letter or begining of chunk
 315                                 if ( ($index == $startChunk) ||
 316                                          ($articles_start_char[$index] != $articles_start_char[$index - 1]) )
 317
 318                                 {
 319                                         if( $atColumnTop ) {
 320                                                 $atColumnTop = false;
 321                                         } else {
 322                                                 $r .= "</ul>\n";
 323                                         }
 324                                         $cont_msg = "";
 325                                         if ( $articles_start_char[$index] == $prev_start_char )
 326                                                 $cont_msg = wfMsgHtml('listingcontinuesabbrev');
 327                                         $r .= "<h3>" . htmlspecialchars( $articles_start_char[$index] ) . "$cont_msg</h3>\n<ul>";
 328                                         $prev_start_char = $articles_start_char[$index];
 329                                 }
 330
 331                                 $r .= "<li>{$articles[$index]}</li>";
 332                         }
 333                         if( !$atColumnTop ) {
 334                                 $r .= "</ul>\n";
 335                         }
 336                         $r .= "</td>\n";
 337
 338
 339                 }
 340                 $r .= '</tr></table>';
 341                 return $r;
 342         }
 343
 344         /**
 345          * Format a list of articles chunked by letter in a bullet list.
 346          * @param array $articles
 347          * @param array $articles_start_char
 348          * @return string
 349          * @private
 350          */
 351         function shortList( $articles, $articles_start_char ) {
 352                 $r = '<h3>' . htmlspecialchars( $articles_start_char[0] ) . "</h3>\n";
 353                 $r .= '<ul><li>'.$articles[0].'</li>';
 354                 for ($index = 1; $index < count($articles); $index++ )
 355                 {
 356                         if ($articles_start_char[$index] != $articles_start_char[$index - 1])
 357                         {
 358                                 $r .= "</ul><h3>" . htmlspecialchars( $articles_start_char[$index] ) . "</h3>\n<ul>";
 359                         }
 360
 361                         $r .= "<li>{$articles[$index]}</li>";
 362                 }
 363                 $r .= '</ul>';
 364                 return $r;
 365         }
 366
 367         /**
 368          * @param Title  $title
 369          * @param string $first
 370          * @param string $last
 371          * @param int    $limit
 372          * @param array  $query - additional query options to pass
 373          * @return string
 374          * @private
 375          */
 376         function pagingLinks( $title, $first, $last, $limit, $query = array() ) {
 377                 global $wgUser, $wgLang;
 378                 $sk =& $this->getSkin();
 379                 $limitText = $wgLang->formatNum( $limit );
 380
 381                 $prevLink = htmlspecialchars( wfMsg( 'prevn', $limitText ) );
 382                 if( $first != '' ) {
 383                         $prevLink = $sk->makeLinkObj( $title, $prevLink,
 384                                 wfArrayToCGI( $query + array( 'until' => $first ) ) );
 385                 }
 386                 $nextLink = htmlspecialchars( wfMsg( 'nextn', $limitText ) );
 387                 if( $last != '' ) {
 388                         $nextLink = $sk->makeLinkObj( $title, $nextLink,
 389                                 wfArrayToCGI( $query + array( 'from' => $last ) ) );
 390                 }
 391
 392                 return "($prevLink) ($nextLink)";
 393         }
 394 }
 395
 396
 397 ?>