mirror of
https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git
synced 2024-11-17 03:19:31 +00:00
323acda0b1
Talk page keys in the associated page array can vary based on namespace. This commit will match keys end with 'talk' and match them to the speechBubble icon.
406 lines
13 KiB
PHP
406 lines
13 KiB
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\Hooks;
|
|
|
|
use MediaWiki\Hook\BeforePageDisplayHook;
|
|
use MediaWiki\Hook\SidebarBeforeOutputHook;
|
|
use MediaWiki\Hook\SkinBuildSidebarHook;
|
|
use MediaWiki\Hook\SkinEditSectionLinksHook;
|
|
use MediaWiki\Hook\SkinTemplateNavigation__UniversalHook;
|
|
use MediaWiki\Skins\Hook\SkinPageReadyConfigHook;
|
|
|
|
/**
|
|
* Hooks to run relating the skin
|
|
*/
|
|
class SkinHooks implements
|
|
BeforePageDisplayHook,
|
|
SidebarBeforeOutputHook,
|
|
SkinBuildSidebarHook,
|
|
SkinEditSectionLinksHook,
|
|
SkinPageReadyConfigHook,
|
|
SkinTemplateNavigation__UniversalHook
|
|
{
|
|
/**
|
|
* Adds the inline theme switcher script to the page
|
|
*
|
|
* @param OutputPage $out
|
|
* @param Skin $skin
|
|
*/
|
|
public function onBeforePageDisplay( $out, $skin ): void {
|
|
// It's better to exit before any additional check
|
|
if ( $skin->getSkinName() !== 'citizen' ) {
|
|
return;
|
|
}
|
|
|
|
$nonce = $out->getCSP()->getNonce();
|
|
|
|
// Script content at 'skins.citizen.scripts.theme/inline.js
|
|
// phpcs:disable Generic.Files.LineLength.TooLong
|
|
$script = sprintf(
|
|
'<script%s>%s</script>',
|
|
$nonce !== false ? sprintf( ' nonce="%s"', $nonce ) : '',
|
|
'window.applyPref=()=>{const a="skin-citizen-",b="skin-citizen-theme",c=a=>window.localStorage.getItem(a),d=c("skin-citizen-theme"),e=()=>{const d={fontsize:"font-size",pagewidth:"--width-layout",lineheight:"--line-height"},e=()=>["auto","dark","light"].map(b=>a+b),f=a=>{let b=document.getElementById("citizen-style");null===b&&(b=document.createElement("style"),b.setAttribute("id","citizen-style"),document.head.appendChild(b)),b.textContent=`:root{${a}}`};try{const g=c(b);let h="";if(null!==g){const b=document.documentElement;b.classList.remove(...e(a)),b.classList.add(a+g)}for(const[b,e]of Object.entries(d)){const d=c(a+b);null!==d&&(h+=`${e}:${d};`)}h&&f(h)}catch(a){}};if("auto"===d){const a=window.matchMedia("(prefers-color-scheme: dark)"),c=a.matches?"dark":"light",d=(a,b)=>window.localStorage.setItem(a,b);d(b,c),e(),a.addEventListener("change",()=>{e()}),d(b,"auto")}else e()},(()=>{window.applyPref()})();'
|
|
);
|
|
// phpcs:enable Generic.Files.LineLength.TooLong
|
|
|
|
$out->addHeadItem( 'skin.citizen.inline', $script );
|
|
}
|
|
|
|
/**
|
|
* Modify toolbox links
|
|
* For some reason onSkinBuildSidebar was not able to get toolbox
|
|
* So we need to use this hook instead
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SidebarBeforeOutput
|
|
* @param Skin $skin
|
|
* @param array &$sidebar
|
|
*/
|
|
public function onSidebarBeforeOutput( $skin, &$sidebar ): void {
|
|
// Be extra safe because it might be active on other skins with caching
|
|
if ( $skin->getSkinName() === 'citizen' && $sidebar ) {
|
|
if ( isset( $sidebar['TOOLBOX'] ) ) {
|
|
self::updateToolboxMenu( $sidebar );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Modify sidebar links
|
|
* This is cached compared to onSidebarBeforeOutput
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SkinBuildSidebar
|
|
* @param Skin $skin
|
|
* @param array &$bar
|
|
*/
|
|
public function onSkinBuildSidebar( $skin, &$bar ): void {
|
|
// Be extra safe because it might be active on other skins with caching
|
|
if ( $skin->getSkinName() === 'citizen' && $bar ) {
|
|
foreach ( $bar as $key => $item ) {
|
|
self::addIconsToMenuItems( $bar, $key );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Modify editsection links
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SkinEditSectionLinks
|
|
* @param Skin $skin
|
|
* @param Title $title
|
|
* @param string $section
|
|
* @param string $sectionTitle
|
|
* @param array &$result
|
|
* @param Language $lang
|
|
*/
|
|
public function onSkinEditSectionLinks( $skin, $title, $section, $sectionTitle, &$result, $lang ) {
|
|
// Be extra safe because it might be active on other skins with caching
|
|
if ( $skin->getSkinName() === 'citizen' && $result ) {
|
|
// Add icon to edit section link
|
|
// If VE button is present, use wikiText icon
|
|
if ( isset( $result['veeditsection'] ) ) {
|
|
self::appendClassToItem(
|
|
$result['veeditsection']['attribs']['class'],
|
|
[
|
|
'citizen-editsection-icon',
|
|
'mw-ui-icon-wikimedia-edit'
|
|
]
|
|
);
|
|
self::appendClassToItem(
|
|
$result['editsection']['attribs']['class'],
|
|
[
|
|
'citizen-editsection-icon',
|
|
'mw-ui-icon-wikimedia-wikiText'
|
|
]
|
|
);
|
|
} elseif ( isset( $result['editsection'] ) ) {
|
|
self::appendClassToItem(
|
|
$result['editsection']['attribs']['class'],
|
|
[
|
|
'citizen-editsection-icon',
|
|
'mw-ui-icon-wikimedia-edit'
|
|
]
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* SkinPageReadyConfig hook handler
|
|
*
|
|
* Replace searchModule provided by skin.
|
|
*
|
|
* @since 1.35
|
|
* @param ResourceLoaderContext $context
|
|
* @param mixed[] &$config Associative array of configurable options
|
|
* @return void This hook must not abort, it must return no value
|
|
*/
|
|
public function onSkinPageReadyConfig( $context, array &$config ): void {
|
|
// It's better to exit before any additional check
|
|
if ( $context->getSkin() !== 'citizen' ) {
|
|
return;
|
|
}
|
|
|
|
// Tell the `mediawiki.page.ready` module not to wire up search.
|
|
$config['search'] = false;
|
|
}
|
|
|
|
/**
|
|
* Modify navigation links
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal
|
|
* @param SkinTemplate $sktemplate
|
|
* @param array &$links
|
|
*/
|
|
public function onSkinTemplateNavigation__Universal( $sktemplate, &$links ): void {
|
|
// Be extra safe because it might be active on other skins with caching
|
|
if ( $sktemplate->getSkinName() === 'citizen' ) {
|
|
if ( isset( $links['actions'] ) ) {
|
|
self::updateActionsMenu( $links );
|
|
}
|
|
|
|
if ( isset( $links['associated-pages'] ) ) {
|
|
self::updateAssociatedPagesMenu( $links );
|
|
}
|
|
|
|
if ( isset( $links['user-menu'] ) ) {
|
|
self::updateUserMenu( $sktemplate, $links );
|
|
}
|
|
|
|
if ( isset( $links['views'] ) ) {
|
|
self::updateViewsMenu( $links );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update actions menu items
|
|
*
|
|
* @param array &$links
|
|
*/
|
|
private static function updateActionsMenu( &$links ) {
|
|
// Most icons are not mapped yet in the actions menu
|
|
$iconMap = [
|
|
'delete' => 'trash',
|
|
'move' => 'move',
|
|
'protect' => 'lock',
|
|
'unprotect' => 'unLock',
|
|
// Extension:Purge
|
|
// Extension:SemanticMediaWiki
|
|
'purge' => 'reload'
|
|
];
|
|
|
|
self::mapIconsToMenuItems( $links, 'actions', $iconMap );
|
|
self::addIconsToMenuItems( $links, 'actions' );
|
|
}
|
|
|
|
/**
|
|
* Update associated pages menu items
|
|
*
|
|
* @param array &$links
|
|
*/
|
|
private static function updateAssociatedPagesMenu( &$links ) {
|
|
// Most icons are not mapped yet in the associated pages menu
|
|
$iconMap = [
|
|
'main' => 'article',
|
|
'user' => 'userAvatar'
|
|
];
|
|
|
|
// Special handling for talk pages
|
|
// Since talk keys have namespace as prefix
|
|
foreach ( $links['associated-pages'] as $key => $item ) {
|
|
// I wish I can use str_ends_with but need to wait for PHP 7.X to be dropped
|
|
if ( substr( $key, -4 ) === 'talk' ) {
|
|
$links['associated-pages'][$key]['icon'] = 'speechBubbles';
|
|
}
|
|
}
|
|
|
|
self::mapIconsToMenuItems( $links, 'associated-pages', $iconMap );
|
|
self::addIconsToMenuItems( $links, 'associated-pages' );
|
|
}
|
|
|
|
/**
|
|
* Update toolbox menu items
|
|
* This is not guaranteed to run after extensions hook
|
|
*
|
|
* WORKAROUND: Load the skin after all extensions
|
|
* FIXME: Revisit when T287622 is resolved
|
|
*
|
|
* @param array &$links
|
|
*/
|
|
private static function updateToolboxMenu( &$links ) {
|
|
// Most icons are not mapped yet in the toolbox menu
|
|
$iconMap = [
|
|
'whatlinkshere' => 'articleRedirect',
|
|
'recentchangeslinked' => 'recentChanges',
|
|
'print' => 'printer',
|
|
'permalink' => 'link',
|
|
'info' => 'infoFilled',
|
|
'contributions' => 'userContributions',
|
|
'log' => 'history',
|
|
'blockip' => 'block',
|
|
'userrights' => 'userGroup',
|
|
// Extension:CiteThisPage
|
|
'citethispage' => 'reference',
|
|
// Extension:Cargo
|
|
'cargo-pagevalues' => 'database',
|
|
// Extension:SemanticMediaWiki
|
|
'smwbrowselink' => 'database'
|
|
];
|
|
|
|
self::mapIconsToMenuItems( $links, 'TOOLBOX', $iconMap );
|
|
self::addIconsToMenuItems( $links, 'TOOLBOX' );
|
|
}
|
|
|
|
/**
|
|
* Update user menu
|
|
*
|
|
* @param SkinTemplate $sktemplate
|
|
* @param array &$links
|
|
*/
|
|
private static function updateUserMenu( $sktemplate, &$links ) {
|
|
$user = $sktemplate->getUser();
|
|
$isRegistered = $user->isRegistered();
|
|
$isTemp = $user->isTemp();
|
|
|
|
if ( $isTemp ) {
|
|
// Remove temporary user page text from user menu and recreate it in user info
|
|
unset( $links['user-menu']['tmpuserpage'] );
|
|
// Remove links as they are added to the bottom of user menu later
|
|
// unset( $links['user-menu']['logout'] );
|
|
} elseif ( $isRegistered ) {
|
|
// Remove user page link from user menu and recreate it in user info
|
|
unset( $links['user-menu']['userpage'] );
|
|
} else {
|
|
// Remove anon user page text from user menu and recreate it in user info
|
|
unset( $links['user-menu']['anonuserpage'] );
|
|
// Remove links as they are added to the bottom of user menu later
|
|
// unset( $links['user-menu']['createaccount'] );
|
|
// unset( $links['user-menu']['login'] );
|
|
// unset( $links['user-menu']['login-private'] );
|
|
}
|
|
|
|
self::addIconsToMenuItems( $links, 'user-menu' );
|
|
}
|
|
|
|
/**
|
|
* Update views menu items
|
|
*
|
|
* @param array &$links
|
|
*/
|
|
private static function updateViewsMenu( &$links ) {
|
|
// Most icons are not mapped yet in the views menu
|
|
$iconMap = [
|
|
'view' => 'article',
|
|
// View source button only appears when the user do not have permission
|
|
'viewsource' => 'editLock',
|
|
'history' => 'history',
|
|
'edit' => 'edit',
|
|
'view-foreign' => 'linkExternal',
|
|
// Extension:VisualEditor
|
|
// For some reason the icon span element keeps getting removed
|
|
// So we are adding this the legacy way
|
|
// Bug: T323188
|
|
// 've-edit' => 'edit',
|
|
// Extension:DiscussionTools
|
|
'addsection' => 'speechBubbleAdd'
|
|
];
|
|
|
|
// If both visual edit and source edit buttons are present
|
|
if ( isset( $links['views']['ve-edit'] ) && isset( $links['views']['edit'] ) ) {
|
|
// Add a class so that we can make a merged button through CSS
|
|
self::appendClassToItem( $links['views']['ve-edit']['class'], [ 'citizen-ve-edit-merged' ] );
|
|
self::appendClassToItem( $links['views']['edit']['class'], [ 'citizen-ve-edit-merged' ] );
|
|
// Use wikiText icon instead of edit icon for source edit
|
|
$iconMap['edit'] = 'wikiText';
|
|
}
|
|
|
|
self::mapIconsToMenuItems( $links, 'views', $iconMap );
|
|
self::addIconsToMenuItems( $links, 'views' );
|
|
}
|
|
|
|
/**
|
|
* Set the icon parameter of the menu item based on the mapping
|
|
*
|
|
* @param array &$links
|
|
* @param string $menu identifier
|
|
* @param array $map icon mapping
|
|
*/
|
|
private static function mapIconsToMenuItems( &$links, $menu, $map ) {
|
|
foreach ( $map as $key => $icon ) {
|
|
if ( isset( $links[$menu][$key] ) ) {
|
|
$links[$menu][$key]['icon'] ??= $icon;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the HTML needed for icons to menu items
|
|
*
|
|
* @param array &$links
|
|
* @param string $menu identifier
|
|
*/
|
|
private static function addIconsToMenuItems( &$links, $menu ) {
|
|
// Loop through each menu to check/append its link classes.
|
|
foreach ( $links[$menu] as $key => $item ) {
|
|
$icon = $item['icon'] ?? '';
|
|
|
|
if ( $icon ) {
|
|
// Html::makeLink will pass this through rawElement
|
|
// Avoid using mw-ui-icon in case its styles get loaded
|
|
$links[$menu][$key]['link-html'] = '<span class="citizen-ui-icon mw-ui-icon-wikimedia-' . $icon . '"></span>';
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds class to a property
|
|
* Based on Vector
|
|
*
|
|
* @param array &$item to update
|
|
* @param array|string $classes to add to the item
|
|
*/
|
|
private static function appendClassToItem( &$item, $classes ) {
|
|
$existingClasses = $item;
|
|
|
|
if ( is_array( $existingClasses ) ) {
|
|
// Treat as array
|
|
$newArrayClasses = is_array( $classes ) ? $classes : [ trim( $classes ) ];
|
|
$item = array_merge( $existingClasses, $newArrayClasses );
|
|
} elseif ( is_string( $existingClasses ) ) {
|
|
// Treat as string
|
|
$newStrClasses = is_string( $classes ) ? trim( $classes ) : implode( ' ', $classes );
|
|
$item .= ' ' . $newStrClasses;
|
|
} else {
|
|
// Treat as whatever $classes is
|
|
$item = $classes;
|
|
}
|
|
|
|
if ( is_string( $item ) ) {
|
|
$item = trim( $item );
|
|
}
|
|
}
|
|
}
|