CategoryTreeHooks.php

Go to the documentation of this file.

<?php
class CategoryTreeHooks {
 
    public static function shouldForceHeaders() {
        global $wgCategoryTreeForceHeaders;
        return $wgCategoryTreeForceHeaders;
    }
 
    public static function initialize() {
        global $wgRequest;
        global $wgCategoryTreeDefaultOptions, $wgCategoryTreeDefaultMode;
        global $wgCategoryTreeCategoryPageOptions, $wgCategoryTreeCategoryPageMode;
        global $wgCategoryTreeOmitNamespace;
 
        if ( !isset( $wgCategoryTreeDefaultOptions['mode'] )
            || is_null( $wgCategoryTreeDefaultOptions['mode'] )
        ) {
            $wgCategoryTreeDefaultOptions['mode'] = $wgCategoryTreeDefaultMode;
        }
 
        if ( !isset( $wgCategoryTreeDefaultOptions['hideprefix'] )
            || is_null( $wgCategoryTreeDefaultOptions['hideprefix'] )
        ) {
            $wgCategoryTreeDefaultOptions['hideprefix'] = $wgCategoryTreeOmitNamespace;
        }
 
        if ( !isset( $wgCategoryTreeCategoryPageOptions['mode'] )
            || is_null( $wgCategoryTreeCategoryPageOptions['mode'] )
        ) {
            $mode = $wgRequest->getVal( 'mode' );
            $wgCategoryTreeCategoryPageOptions['mode'] = ( $mode )
                ? CategoryTree::decodeMode( $mode ) : $wgCategoryTreeCategoryPageMode;
        }
    }
 
    public static function setHooks( Parser $parser ) {
        global $wgCategoryTreeAllowTag;
        if ( !$wgCategoryTreeAllowTag ) {
            return;
        }
        $parser->setHook( 'categorytree', 'CategoryTreeHooks::parserHook' );
        $parser->setFunctionHook( 'categorytree', 'CategoryTreeHooks::parserFunction' );
    }
 
    public static function parserFunction( Parser $parser, ...$params ) {
        // first user-supplied parameter must be category name
        if ( !$params ) {
            // no category specified, return nothing
            return '';
        }
        $cat = array_shift( $params );
 
        // build associative arguments from flat parameter list
        $argv = [];
        foreach ( $params as $p ) {
            if ( preg_match( '/^\s*(\S.*?)\s*=\s*(.*?)\s*$/', $p, $m ) ) {
                $k = $m[1];
                // strip any quotes enclusing the value
                $v = preg_replace( '/^"\s*(.*?)\s*"$/', '$1', $m[2] );
            } else {
                $k = trim( $p );
                $v = true;
            }
 
            $argv[$k] = $v;
        }
 
        // now handle just like a <categorytree> tag
        $html = self::parserHook( $cat, $argv, $parser );
        return [ $html, 'noparse' => true, 'isHTML' => true ];
    }
 
    public static function onSkinBuildSidebar( Skin $skin, array &$sidebar ) {
        global $wgCategoryTreeSidebarRoot, $wgCategoryTreeSidebarOptions;
 
        if ( !$wgCategoryTreeSidebarRoot ) {
            return;
        }
 
        $html = self::parserHook( $wgCategoryTreeSidebarRoot, $wgCategoryTreeSidebarOptions );
        if ( $html ) {
            $sidebar['categorytree-portlet'] = $html;
            CategoryTree::setHeaders( $skin->getOutput() );
        }
    }
 
    public static function parserHook(
        $cat,
        array $argv,
        Parser $parser = null,
        $allowMissing = false
    ) {
        if ( $parser ) {
            # flag for use by CategoryTreeHooks::parserOutput
            $parser->mOutput->mCategoryTreeTag = true;
        }
 
        $ct = new CategoryTree( $argv );
 
        $attr = Sanitizer::validateTagAttributes( $argv, 'div' );
 
        $hideroot = isset( $argv['hideroot'] )
            ? CategoryTree::decodeBoolean( $argv['hideroot'] ) : null;
        $onlyroot = isset( $argv['onlyroot'] )
            ? CategoryTree::decodeBoolean( $argv['onlyroot'] ) : null;
        $depthArg = isset( $argv['depth'] ) ? (int)$argv['depth'] : null;
 
        $depth = CategoryTree::capDepth( $ct->getOption( 'mode' ), $depthArg );
        if ( $onlyroot ) {
            $depth = 0;
        }
 
        return $ct->getTag( $parser, $cat, $hideroot, $attr, $depth, $allowMissing );
    }
 
    public static function parserOutput( OutputPage $outputPage, ParserOutput $parserOutput ) {
        if ( self::shouldForceHeaders() ) {
            // Skip, we've already set the headers unconditionally
            return;
        }
        if ( !empty( $parserOutput->mCategoryTreeTag ) ) {
            CategoryTree::setHeaders( $outputPage );
        }
    }
 
    public static function addHeaders( OutputPage $out ) {
        if ( !self::shouldForceHeaders() ) {
            return;
        }
        CategoryTree::setHeaders( $out );
    }
 
    public static function articleFromTitle( Title $title, Article &$article = null ) {
        if ( $title->getNamespace() == NS_CATEGORY ) {
            $article = new CategoryTreeCategoryPage( $title );
        }
    }
 
    public static function outputPageMakeCategoryLinks(
        OutputPage &$out,
        array $categories,
        array &$links
    ) {
        global $wgCategoryTreePageCategoryOptions, $wgCategoryTreeHijackPageCategories;
 
        if ( !$wgCategoryTreeHijackPageCategories ) {
            // Not enabled, don't do anything
            return true;
        }
 
        foreach ( $categories as $category => $type ) {
            $links[$type][] = self::parserHook( $category, $wgCategoryTreePageCategoryOptions, null, true );
            CategoryTree::setHeaders( $out );
        }
 
        return false;
    }
 
    public static function getDataForJs() {
        global $wgCategoryTreeCategoryPageOptions;
 
        // Look, this is pretty bad but CategoryTree is just whacky, it needs to be rewritten
        $ct = new CategoryTree( $wgCategoryTreeCategoryPageOptions );
 
        return [
            'defaultCtOptions' => $ct->getOptionsAsJsStructure(),
        ];
    }
 
    public static function onSpecialTrackingCategoriesPreprocess(
        SpecialPage $specialPage, array $trackingCategories
    ) {
        $categoryDbKeys = [];
        foreach ( $trackingCategories as $catMsg => $data ) {
            foreach ( $data['cats'] as $catTitle ) {
                $categoryDbKeys[] = $catTitle->getDbKey();
            }
        }
        $categories = [];
        if ( $categoryDbKeys ) {
            $dbr = wfGetDB( DB_REPLICA );
            $res = $dbr->select(
                'category',
                [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
                [ 'cat_title' => array_unique( $categoryDbKeys ) ],
                __METHOD__
            );
            foreach ( $res as $row ) {
                $categories[$row->cat_title] = Category::newFromRow( $row );
            }
        }
        $specialPage->categoryTreeCategories = $categories;
    }
 
    public static function onSpecialTrackingCategoriesGenerateCatLink(
        SpecialPage $specialPage, Title $catTitle, &$html
    ) {
        if ( !isset( $specialPage->categoryTreeCategories ) ) {
            return;
        }
 
        $cat = null;
        if ( isset( $specialPage->categoryTreeCategories[$catTitle->getDbKey()] ) ) {
            $cat = $specialPage->categoryTreeCategories[$catTitle->getDbKey()];
        }
 
        $html .= CategoryTree::createCountString( $specialPage->getContext(), $cat, 0 );
    }
}