mediawiki-skins-Citizen/includes/Partials/Header.php

<?php
/**
 * Citizen - A responsive skin developed for the Star Citizen Wiki
 *
 * This file is part of Citizen.
 *
 * Citizen is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Citizen is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Citizen.  If not, see <https://www.gnu.org/licenses/>.
 *
 * @file
 * @ingroup Skins
 */

declare( strict_types=1 );

namespace MediaWiki\Skins\Citizen\Partials;

use MediaWiki\MediaWikiServices;
use MWException;
use Skin;
use SpecialPage;
use User;

/**
 * Header partial of Skin Citizen
 * Generates the following partials:
 * - Personal Menu
 * - Extra Tools
 * - Search
 */
final class Header extends Partial {
	/**
	 * Build Personal Tools menu
	 *
	 * @return array
	 */
	public function buildPersonalMenu(): array {
		$skin = $this->skin;

		$personalTools = $skin->getPersonalToolsForMakeListItem(
			$skin->buildPersonalUrlsPublic()
		);

		$header = $this->getPersonalHeaderData( $personalTools );
		// We need userpage for personal header
		if ( isset( $personalTools['userpage'] ) ) {
			unset( $personalTools['userpage'] );
		}

		// Move the Echo badges out of default list
		// TODO: Remove notifications since MW 1.36 from buildPersonalUrls
		if ( isset( $personalTools['notifications-alert'] ) ) {
			unset( $personalTools['notifications-alert'] );
		}
		if ( isset( $personalTools['notifications-notice'] ) ) {
			unset( $personalTools['notifications-notice'] );
		}

		return [
			'data-personal-menu-header' => $header,
			'data-personal-menu-list' => $skin->getPortletData( 'personal', $personalTools ),
		];
	}

	/**
	 * Echo notification badges button
	 *
	 * @return array
	 */
	public function getNotifications(): array {
		$skin = $this->skin;

		$personalTools = $skin->getPersonalToolsForMakeListItem(
			$skin->buildPersonalUrlsPublic()
		);

		// Create the Echo badges
		$notifications = [];
		if ( isset( $personalTools['notifications-alert'] ) ) {
			$notifications['notifications-alert'] = $personalTools['notifications-alert'];
		}
		if ( isset( $personalTools['notifications-notice'] ) ) {
			$notifications['notifications-notice'] = $personalTools['notifications-notice'];
		}

		$html = $skin->getPortletData( 'notifications', $notifications );

		return $html;
	}

	/**
	 * Render the search box
	 *
	 * @return array
	 * @throws MWException
	 */
	public function buildSearchProps(): array {
		$skin = $this->skin;

		$toggleMsg = $skin->msg( 'citizen-search-toggle' )->text();

		return [
			// TODO: This should be called in skin.json
			'msg-citizen-search-toggle' => $toggleMsg,
			'msg-citizen-search-toggle-shortcut' => $toggleMsg . ' [/]',
			'form-action' => $this->getConfigValue( 'Script' ),
			'html-input' => $skin->makeSearchInput( [ 'id' => 'searchInput' ] ),
			'page-title' => SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey(),
			'html-random-href' => Skin::makeSpecialUrl( 'Randompage' ),
		];
	}

	/**
	 * Decorate the personal menu
	 *
	 * @param array $personalTools The original personal tools urls
	 *
	 * @return array
	 */
	private function getPersonalHeaderData( $personalTools ): array {
		$skin = $this->skin;
		$user = $this->user;
		$header = [];

		if ( $user->isRegistered() ) {
			$header += [
				'userpage' => $personalTools['userpage'] ?? null,
				'usergroups' => $this->getUserGroupsData( $personalTools, $user ),
				'usercontris' => $this->getUserContributionsData( $user ),
			];
		}

		return $skin->getPortletData( 'personal-header', array_filter( $header ) );
	}

	/**
	 * Build and return user groups data
	 *
	 * @param array $personalTools The original personal tools urls
	 * @param User $user
	 *
	 * @return array|null
	 */
	private function getUserGroupsData( $personalTools, $user ): ?array {
		// This does not return implicit groups
		$groups = MediaWikiServices::getInstance()->getUserGroupManager()->getUserGroups( $user );

		if ( empty( $groups ) ) {
			return null;
		}

		$skin = $this->skin;
		$title = $this->title;

		// Add user group
		$groupLinks = [];
		$msgName = 'group-%s';

		foreach ( $groups as $group ) {
			$groupPage = $title->newFromText(
				$skin->msg( sprintf( $msgName, $group ) )->text(),
				NS_PROJECT
			);

			$groupLinks[$group] = [
				'msg' => sprintf( $msgName, $group ),
				// Nullpointer should not happen
				'href' => $groupPage->getLinkURL(),
				'tooltiponly' => true,
				'id' => sprintf( $msgName, $group ),
				// 'exists' => $groupPage->exists() - This will add an additional DB call
			];
		}

		return [
			'id' => 'pt-usergroups',
			'links' => $groupLinks
		];
	}

	/**
	 * Build and return user contributions data
	 *
	 * @param User $user
	 *
	 * @return array|null
	 */
	private function getUserContributionsData( $user ): ?array {
		// Return user edits
		$edits = MediaWikiServices::getInstance()->getUserEditTracker()->getUserEditCount( $user );

		if ( empty( $edits ) ) {
			return null;
		}

		$skin = $this->skin;

		return [
			'text' => $skin->msg( 'usereditcount' )
				->numParams( sprintf( '%s', number_format( $edits, 0 ) ) ),
			'id' => 'pt-usercontris'
		];
	}
}