wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Client\Hooks;

use MediaWiki\Language\LanguageCode;
use MediaWiki\Site\Site;
use MediaWiki\Site\SiteLookup;
use MediaWiki\Title\Title;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\DataModel\SiteLink;

/**
 * Outputs a sidebar section for other project links.
 *
 * @license GPL-2.0-or-later
 * @author Thomas Pellissier Tanon
 * @author Marius Hoch < hoo@online.de >
 */
class OtherProjectsSidebarGenerator {

    /**
     * @var string
     */
    private $localSiteId;

    /**
     * @var SiteLinksForDisplayLookup
     */
    private $siteLinksForDisplayLookup;

    /**
     * @var SiteLookup
     */
    private $siteLookup;

    /**
     * @var SidebarLinkBadgeDisplay
     */
    private $sidebarLinkBadgeDisplay;

    /**
     * @var string[]
     */
    private $siteIdsToOutput;

    /**
     * @param string $localSiteId
     * @param SiteLinksForDisplayLookup $siteLinksForDisplayLookup
     * @param SiteLookup $siteLookup
     * @param SidebarLinkBadgeDisplay $sidebarLinkBadgeDisplay
     * @param string[] $siteIdsToOutput
     */
    public function __construct(
        $localSiteId,
        SiteLinksForDisplayLookup $siteLinksForDisplayLookup,
        SiteLookup $siteLookup,
        SidebarLinkBadgeDisplay $sidebarLinkBadgeDisplay,
        array $siteIdsToOutput
    ) {
        $this->localSiteId = $localSiteId;
        $this->siteLinksForDisplayLookup = $siteLinksForDisplayLookup;
        $this->siteLookup = $siteLookup;
        $this->sidebarLinkBadgeDisplay = $sidebarLinkBadgeDisplay;
        $this->siteIdsToOutput = $siteIdsToOutput;
    }

    /**
     * @param ItemId $itemId
     *
     * @return array[] Array of arrays of attributes describing sidebar links, sorted by the site's
     * group and global ids.
     */
    public function buildProjectLinkSidebarFromItemId( ItemId $itemId ) {
        $sidebar = $this->buildPreliminarySidebarFromSiteLinks(
            $this->siteLinksForDisplayLookup->getSiteLinksForItemId( $itemId )
        );
        return $this->sortAndFlattenSidebar( $sidebar );
    }

    /**
     * @param Title $title
     *
     * @return array[] Array of arrays of attributes describing sidebar links, sorted by the site's
     * group and global ids.
     */
    public function buildProjectLinkSidebar( Title $title ) {
        $sidebar = $this->buildPreliminarySidebarFromSiteLinks(
            $this->siteLinksForDisplayLookup->getSiteLinksForPageTitle( $title )
        );
        return $this->sortAndFlattenSidebar( $sidebar );
    }

    /**
     * @param SiteLink[] $siteLinks
     *
     * @return array[] Arrays of link attributes indexed by site group and by global site id.
     */
    private function buildPreliminarySidebarFromSiteLinks( array $siteLinks ) {
        $linksByGroup = [];

        foreach ( $siteLinks as $siteLink ) {
            if ( !in_array( $siteLink->getSiteId(), $this->siteIdsToOutput ) ) {
                continue;
            }

            $site = $this->siteLookup->getSite( $siteLink->getSiteId() );

            if ( $site !== null ) {
                $group = $site->getGroup();
                $globalId = $site->getGlobalId();
                // Index by site group and global id
                $linksByGroup[$group][$globalId] = $this->buildSidebarLink( $siteLink, $site );
            }
        }

        return $linksByGroup;
    }

    /**
     * The arrays of link attributes are indexed by site group and by global site id.
     * Sort them by both and then return the flattened array.
     *
     * @param array[] $linksByGroup
     *
     * @return array[] Array of arrays of attributes describing sidebar links, sorted by the site's
     * group and global ids.
     */
    private function sortAndFlattenSidebar( array $linksByGroup ) {
        $result = [];

        ksort( $linksByGroup ); // Sort by group id

        foreach ( $linksByGroup as $linksPerGroup ) {
            ksort( $linksPerGroup ); // Sort individual arrays by global site id
            $result = array_merge( $result, array_values( $linksPerGroup ) );
        }

        return $result;
    }

    /**
     * @param SiteLink $siteLink
     * @param Site $site
     *
     * @return string[] Array of attributes describing a sidebar link.
     */
    private function buildSidebarLink( SiteLink $siteLink, Site $site ) {
        // Messages in the WikimediaMessages extension (as of 2015-03-31):
        // wikibase-otherprojects-commons
        // wikibase-otherprojects-testwikidata
        // wikibase-otherprojects-wikidata
        // wikibase-otherprojects-wikinews
        // wikibase-otherprojects-wikipedia
        // wikibase-otherprojects-wikiquote
        // wikibase-otherprojects-wikisource
        // wikibase-otherprojects-wikivoyage
        $attributes = [
            'msg' => 'wikibase-otherprojects-' . $site->getGroup(),
            'class' => 'wb-otherproject-link wb-otherproject-' . $site->getGroup(),
            'href' => $site->getPageUrl( $siteLink->getPageName() ),
        ];

        $siteLanguageCode = $site->getLanguageCode();
        if ( $siteLanguageCode !== null ) {
            $attributes['hreflang'] = LanguageCode::bcp47( $siteLanguageCode );
        }

        $this->sidebarLinkBadgeDisplay->applyBadgeToLink(
            $attributes,
            $this->sidebarLinkBadgeDisplay->getBadgeInfo( $siteLink->getBadges() )
        );

        return $attributes;
    }

}