mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-12-01 18:57:04 +00:00
9e4bdd00bf
Rather than try to build individually build login, logout, and create account menu items, we handle them the same as all other user links menu items in Hooks.php. While Hooks isnt ideal, there currently isnt a good path for moving that code to SkinComponents until core provides menu data. In the meantime, this patch reduces code complexity and prevents bugs like T324638. This approach also allows us to move user links logic from SkinVector22 to VectorComponentUserLinks.php, and ensures the user links dropdown contains multiple menus, which allows us to reuse styles from page tools dropdowns. Expected 11 visual changes: * minor visual change where the user links dropdown has an additional 4px vertical padding. This padding was originally added to the page tools dropdowns per Alex's request, but Alex also said that dropdowns should share the same spacing. This change makes the styles all consistent * Order of talk and contribution links have been swapped Bug: T289212 Bug: T319356 Bug: T328954 Change-Id: Iac0586893fec26a8a6c2c904ce08fbf1e19b339c
744 lines
25 KiB
PHP
744 lines
25 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Skins\Vector;
|
|
|
|
use Config;
|
|
use IContextSource;
|
|
use MediaWiki\Auth\Hook\LocalUserCreatedHook;
|
|
use MediaWiki\Hook\MakeGlobalVariablesScriptHook;
|
|
use MediaWiki\Hook\RequestContextCreateSkinHook;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Preferences\Hook\GetPreferencesHook;
|
|
use MediaWiki\ResourceLoader as RL;
|
|
use MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteModulePagesHook;
|
|
use MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteStylesModulePagesHook;
|
|
use MediaWiki\Skins\Hook\SkinPageReadyConfigHook;
|
|
use OutputPage;
|
|
use RuntimeException;
|
|
use Skin;
|
|
use SkinTemplate;
|
|
use User;
|
|
|
|
/**
|
|
* Presentation hook handlers for Vector skin.
|
|
*
|
|
* Hook handler method names should be in the form of:
|
|
* on<HookName>()
|
|
* @package Vector
|
|
* @internal
|
|
*/
|
|
class Hooks implements
|
|
GetPreferencesHook,
|
|
LocalUserCreatedHook,
|
|
MakeGlobalVariablesScriptHook,
|
|
ResourceLoaderSiteModulePagesHook,
|
|
ResourceLoaderSiteStylesModulePagesHook,
|
|
RequestContextCreateSkinHook,
|
|
SkinPageReadyConfigHook
|
|
{
|
|
/**
|
|
* Checks if the current skin is a variant of Vector
|
|
*
|
|
* @param string $skinName
|
|
* @return bool
|
|
*/
|
|
private static function isVectorSkin( string $skinName ): bool {
|
|
return (
|
|
$skinName === Constants::SKIN_NAME_LEGACY ||
|
|
$skinName === Constants::SKIN_NAME_MODERN
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Config $config
|
|
* @return array
|
|
*/
|
|
private static function getActiveABTest( $config ) {
|
|
$ab = $config->get(
|
|
Constants::CONFIG_WEB_AB_TEST_ENROLLMENT
|
|
);
|
|
if ( count( $ab ) === 0 ) {
|
|
// If array is empty then no experiment and need to validate.
|
|
return $ab;
|
|
}
|
|
if ( !array_key_exists( 'buckets', $ab ) ) {
|
|
throw new RuntimeException( 'Invalid VectorWebABTestEnrollment value: Must contain buckets key.' );
|
|
}
|
|
if ( !array_key_exists( 'unsampled', $ab['buckets'] ) ) {
|
|
throw new RuntimeException( 'Invalid VectorWebABTestEnrollment value: Must define an `unsampled` bucket.' );
|
|
} else {
|
|
// check bucket values.
|
|
foreach ( $ab['buckets'] as $bucketName => $bucketDefinition ) {
|
|
if ( !is_array( $bucketDefinition ) ) {
|
|
throw new RuntimeException( 'Invalid VectorWebABTestEnrollment value: Buckets should be arrays' );
|
|
}
|
|
$samplingRate = $bucketDefinition['samplingRate'];
|
|
if ( is_string( $samplingRate ) ) {
|
|
throw new RuntimeException(
|
|
'Invalid VectorWebABTestEnrollment value: Sampling rate should be number between 0 and 1.'
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $ab;
|
|
}
|
|
|
|
/**
|
|
* Passes config variables to Vector (modern) ResourceLoader module.
|
|
* @param RL\Context $context
|
|
* @param Config $config
|
|
* @return array
|
|
*/
|
|
public static function getVectorResourceLoaderConfig(
|
|
RL\Context $context,
|
|
Config $config
|
|
) {
|
|
return [
|
|
'wgVectorSearchApiUrl' => $config->get( 'VectorSearchApiUrl' ),
|
|
'wgVectorWebABTestEnrollment' => self::getActiveABTest( $config ),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Generates config variables for skins.vector.search Resource Loader module (defined in
|
|
* skin.json).
|
|
*
|
|
* @param RL\Context $context
|
|
* @param Config $config
|
|
* @return array<string,mixed>
|
|
*/
|
|
public static function getVectorSearchResourceLoaderConfig(
|
|
RL\Context $context,
|
|
Config $config
|
|
): array {
|
|
$result = $config->get( 'VectorWvuiSearchOptions' );
|
|
$result['highlightQuery'] =
|
|
VectorServices::getLanguageService()->canWordsBeSplitSafely( $context->getLanguage() );
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* SkinPageReadyConfig hook handler
|
|
*
|
|
* Replace searchModule provided by skin.
|
|
*
|
|
* @since 1.35
|
|
* @param RL\Context $context
|
|
* @param mixed[] &$config Associative array of configurable options
|
|
* @return void This hook must not abort, it must return no value
|
|
*/
|
|
public function onSkinPageReadyConfig(
|
|
RL\Context $context,
|
|
array &$config
|
|
): void {
|
|
// It's better to exit before any additional check
|
|
if ( !self::isVectorSkin( $context->getSkin() ) ) {
|
|
return;
|
|
}
|
|
|
|
// Tell the `mediawiki.page.ready` module not to wire up search.
|
|
// This allows us to use the new Vue implementation.
|
|
// Context has no knowledge of legacy / modern Vector
|
|
// and from its point of view they are the same thing.
|
|
// Please see the modules `skins.vector.js` and `skins.vector.legacy.js`
|
|
// for the wire up of search.
|
|
// The related method self::getVectorResourceLoaderConfig handles which
|
|
// search to load.
|
|
$config['search'] = false;
|
|
}
|
|
|
|
/**
|
|
* Moves watch item from actions to views menu.
|
|
*
|
|
* @internal used inside Hooks::onSkinTemplateNavigation
|
|
* @param array &$content_navigation
|
|
*/
|
|
private static function updateActionsMenu( &$content_navigation ) {
|
|
$key = null;
|
|
if ( isset( $content_navigation['actions']['watch'] ) ) {
|
|
$key = 'watch';
|
|
}
|
|
if ( isset( $content_navigation['actions']['unwatch'] ) ) {
|
|
$key = 'unwatch';
|
|
}
|
|
|
|
// Promote watch link from actions to views and add an icon
|
|
// The second check to isset is pointless but shuts up phan.
|
|
if ( $key !== null && isset( $content_navigation['actions'][ $key ] ) ) {
|
|
$content_navigation['views'][$key] = $content_navigation['actions'][$key];
|
|
unset( $content_navigation['actions'][$key] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds icons to items in the "views" menu.
|
|
*
|
|
* @internal used inside Hooks::onSkinTemplateNavigation
|
|
* @param array &$content_navigation
|
|
* @param bool $isLegacy is this the legacy Vector skin?
|
|
*/
|
|
private static function updateViewsMenuIcons( &$content_navigation, $isLegacy ) {
|
|
$featureManager = VectorServices::getFeatureManager();
|
|
|
|
foreach ( $content_navigation['views'] as $key => $item ) {
|
|
$icon = $item['icon'] ?? null;
|
|
if ( $icon ) {
|
|
if ( $isLegacy ) {
|
|
self::appendClassToItem(
|
|
$item['class'],
|
|
[ 'icon' ]
|
|
);
|
|
} else {
|
|
// Force the item as a button with hidden text.
|
|
$item['button'] = true;
|
|
$item['text-hidden'] = true;
|
|
$item = self::updateMenuItemData( $item, true );
|
|
}
|
|
} elseif ( !$isLegacy ) {
|
|
// The vector-tab-noicon class is only used in Vector-22.
|
|
self::appendClassToItem(
|
|
$item['class'],
|
|
[ 'vector-tab-noicon' ]
|
|
);
|
|
}
|
|
$content_navigation['views'][$key] = $item;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* All associated pages menu items do not have icons so are given the vector-tab-noicon class.
|
|
*
|
|
* @internal used inside Hooks::onSkinTemplateNavigation
|
|
* @param array &$content_navigation
|
|
*/
|
|
private static function updateAssociatedPagesMenuIcons( &$content_navigation ) {
|
|
foreach ( $content_navigation['associated-pages'] as $key => $item ) {
|
|
self::appendClassToItem(
|
|
$item['class'],
|
|
[ 'vector-tab-noicon' ]
|
|
);
|
|
$content_navigation['associated-pages'][$key] = $item;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds class to a property
|
|
*
|
|
* @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 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Updates personal navigation menu (user links) dropdown for modern Vector:
|
|
* - Adds icons
|
|
* - Makes user page and watchlist collapsible
|
|
*
|
|
* @internal used inside ::updateUserLinksItems
|
|
* @param SkinTemplate $sk
|
|
* @param array &$content_navigation
|
|
* @suppress PhanTypeInvalidDimOffset
|
|
*/
|
|
private static function updateUserLinksDropdownItems( $sk, &$content_navigation ) {
|
|
// For logged-in users in modern Vector, rearrange some links in the personal toolbar.
|
|
$user = $sk->getUser();
|
|
$isTemp = $user->isTemp();
|
|
$isRegistered = $user->isRegistered();
|
|
|
|
if ( $isTemp ) {
|
|
if ( isset( $content_navigation['user-page']['tmpuserpage'] ) ) {
|
|
$content_navigation['user-page']['tmpuserpage']['collapsible'] = true;
|
|
$content_navigation['user-page']['tmpuserpage'] =
|
|
self::updateMenuItemData( $content_navigation['user-page']['tmpuserpage'] );
|
|
}
|
|
if ( isset( $content_navigation['user-menu']['tmpuserpage'] ) ) {
|
|
$content_navigation['user-menu']['tmpuserpage']['collapsible'] = true;
|
|
$content_navigation['user-menu']['tmpuserpage'] =
|
|
self::updateMenuItemData( $content_navigation['user-menu']['tmpuserpage'] );
|
|
}
|
|
} elseif ( $isRegistered ) {
|
|
// Remove user page from personal menu dropdown for logged in use
|
|
$content_navigation['user-menu']['userpage']['collapsible'] = true;
|
|
// watchlist may be disabled if $wgGroupPermissions['*']['viewmywatchlist'] = false;
|
|
// See [[phab:T299671]]
|
|
if ( isset( $content_navigation['user-menu']['watchlist'] ) ) {
|
|
$content_navigation['user-menu']['watchlist']['collapsible'] = true;
|
|
}
|
|
|
|
// Anon editor links handled manually in new anon editor menu
|
|
$logoutMenu = [];
|
|
if ( isset( $content_navigation['user-menu']['logout'] ) ) {
|
|
$logoutMenu['logout'] = $content_navigation['user-menu']['logout'];
|
|
$logoutMenu['logout']['id'] = 'pt-logout';
|
|
unset( $content_navigation['user-menu']['logout'] );
|
|
}
|
|
$content_navigation['user-menu-logout'] = $logoutMenu;
|
|
|
|
self::updateMenuItems( $content_navigation, 'user-menu' );
|
|
self::updateMenuItems( $content_navigation, 'user-menu-logout' );
|
|
}
|
|
|
|
if ( !$isRegistered || $isTemp ) {
|
|
// Remove "Not logged in" from personal menu dropdown for anon users.
|
|
unset( $content_navigation['user-menu']['anonuserpage'] );
|
|
// Remove duplicate "Login" link added by SkinTemplate::buildPersonalUrls if group read permissions
|
|
// are set to false.
|
|
unset( $content_navigation['user-menu']['login-private'] );
|
|
|
|
// Make login and create account collapsible
|
|
$content_navigation['user-menu']['login']['collapsible'] = true;
|
|
$content_navigation['user-menu']['createaccount']['collapsible'] = true;
|
|
|
|
// Anon editor links handled manually in new anon editor menu
|
|
$anonEditorMenu = [];
|
|
if ( isset( $content_navigation['user-menu']['anoncontribs'] ) ) {
|
|
$anonEditorMenu['anoncontribs'] = $content_navigation['user-menu']['anoncontribs'];
|
|
$anonEditorMenu['anoncontribs']['id'] = 'pt-anoncontribs';
|
|
unset( $content_navigation['user-menu']['anoncontribs'] );
|
|
}
|
|
if ( isset( $content_navigation['user-menu']['anontalk'] ) ) {
|
|
$anonEditorMenu['anontalk'] = $content_navigation['user-menu']['anontalk'];
|
|
$anonEditorMenu['anontalk']['id'] = 'pt-anontalk';
|
|
unset( $content_navigation['user-menu']['anontalk'] );
|
|
}
|
|
$content_navigation['user-menu-anon-editor'] = $anonEditorMenu;
|
|
|
|
// Only show icons for anon menu items (login and create account).
|
|
self::updateMenuItems( $content_navigation, 'user-menu' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Populates 'vector-user-menu-overflow' bucket for modern Vector with modified personal navigation (user links)
|
|
* menu items, including 'notification', 'user-interface-preferences', 'user-page', 'vector-user-menu-overflow'
|
|
*
|
|
* @internal used inside ::updateUserLinksItems
|
|
* @param SkinTemplate $sk
|
|
* @param array &$content_navigation
|
|
*/
|
|
private static function updateUserLinksOverflowItems( $sk, &$content_navigation ) {
|
|
$overflow = 'vector-user-menu-overflow';
|
|
$content_navigation[$overflow] = [];
|
|
$featureManager = VectorServices::getFeatureManager();
|
|
|
|
// Logged in and logged out overflow items
|
|
if ( isset( $content_navigation['user-interface-preferences']['uls'] ) ) {
|
|
$content_navigation[$overflow]['uls'] = array_merge(
|
|
$content_navigation['user-interface-preferences']['uls'], [
|
|
'collapsible' => true,
|
|
] );
|
|
}
|
|
|
|
// Logged in overflow items
|
|
if ( isset( $content_navigation['user-page']['userpage'] ) ) {
|
|
$content_navigation[$overflow]['userpage'] = array_merge(
|
|
$content_navigation['user-page']['userpage'], [
|
|
// T312157: Style the userpage link as a blue link rather than a quiet button.
|
|
'button' => false,
|
|
'collapsible' => true,
|
|
// Remove icon
|
|
'icon' => '',
|
|
] );
|
|
}
|
|
if ( isset( $content_navigation['notifications'] ) ) {
|
|
foreach ( $content_navigation['notifications'] as $key => $data ) {
|
|
$content_navigation[$overflow][$key] = $data;
|
|
$icon = $data['icon'] ?? null;
|
|
if ( $icon ) {
|
|
$linkClass = $content_navigation[$overflow][$key]['link-class'] ?? [];
|
|
$item = $content_navigation[$overflow][$key];
|
|
$newLinkClass = [
|
|
// Allows Echo to react to clicks
|
|
'mw-echo-notification-badge-nojs'
|
|
];
|
|
if ( in_array( 'mw-echo-unseen-notifications', $linkClass ) ) {
|
|
$newLinkClass[] = 'mw-echo-unseen-notifications';
|
|
}
|
|
$item['button'] = true;
|
|
$item['text-hidden'] = true;
|
|
$item['link-class'] = $newLinkClass;
|
|
$content_navigation[$overflow][$key] = $item;
|
|
}
|
|
}
|
|
}
|
|
if ( isset( $content_navigation['user-menu']['watchlist'] ) ) {
|
|
$content_navigation[$overflow]['watchlist'] = array_merge(
|
|
$content_navigation['user-menu']['watchlist'], [
|
|
'id' => 'pt-watchlist-2',
|
|
'button' => true,
|
|
'collapsible' => true,
|
|
'text-hidden' => true,
|
|
] );
|
|
}
|
|
|
|
// Anon/temp overflow items
|
|
$user = $sk->getUser();
|
|
$isTemp = $user->isTemp();
|
|
$isRegistered = $user->isRegistered();
|
|
$isCreateAccountAllowed = ( !$isRegistered || $isTemp );
|
|
if ( isset( $content_navigation['user-menu']['createaccount'] ) && $isCreateAccountAllowed ) {
|
|
$content_navigation[$overflow]['createaccount'] = array_merge(
|
|
$content_navigation['user-menu']['createaccount'], [
|
|
'id' => 'pt-createaccount-2',
|
|
'collapsible' => true,
|
|
// Remove icon
|
|
'icon' => '',
|
|
] );
|
|
}
|
|
if ( isset( $content_navigation['user-menu']['login'] ) ) {
|
|
$content_navigation[$overflow]['login'] = array_merge(
|
|
$content_navigation['user-menu']['login'], [
|
|
'id' => 'pt-login-2',
|
|
'collapsible' => true,
|
|
// Remove icon
|
|
'icon' => '',
|
|
] );
|
|
}
|
|
|
|
self::updateMenuItems( $content_navigation, $overflow );
|
|
}
|
|
|
|
/**
|
|
* Updates personal navigation menu (user links) for modern Vector wherein user page, create account and login links
|
|
* are removed from the dropdown to be handled separately. In legacy Vector, the custom "user-page" bucket is
|
|
* removed to preserve existing behavior.
|
|
*
|
|
* @internal used inside Hooks::onSkinTemplateNavigation
|
|
* @param SkinTemplate $sk
|
|
* @param array &$content_navigation
|
|
*/
|
|
private static function updateUserLinksItems( $sk, &$content_navigation ) {
|
|
$skinName = $sk->getSkinName();
|
|
if ( self::isSkinVersionLegacy( $skinName ) ) {
|
|
// Remove user page from personal toolbar since it will be inside the personal menu for logged-in
|
|
// users in legacy Vector.
|
|
unset( $content_navigation['user-page'] );
|
|
} else {
|
|
self::updateUserLinksOverflowItems( $sk, $content_navigation );
|
|
self::updateUserLinksDropdownItems( $sk, $content_navigation );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Modifies list item to make it collapsible.
|
|
*
|
|
* @internal used in ::updateItemData and ::createMoreOverflowMenu
|
|
* @param array &$item
|
|
* @param string $prefix defaults to user-links-
|
|
*/
|
|
private static function makeMenuItemCollapsible( array &$item, string $prefix = 'user-links-' ) {
|
|
$COLLAPSE_MENU_ITEM_CLASS = $prefix . 'collapsible-item';
|
|
self::appendClassToItem( $item[ 'class' ], $COLLAPSE_MENU_ITEM_CLASS );
|
|
}
|
|
|
|
/**
|
|
* Make an icon
|
|
*
|
|
* @internal for use inside Vector skin.
|
|
* @param string $name
|
|
* @return string of HTML
|
|
*/
|
|
public static function makeIcon( $name ) {
|
|
// Html::makeLink will pass this through rawElement
|
|
return '<span class="mw-ui-icon mw-ui-icon-' . $name . ' mw-ui-icon-wikimedia-' . $name . '"></span>';
|
|
}
|
|
|
|
/**
|
|
* Update template data to include classes and html that handle buttons, icons, and collapsible items.
|
|
*
|
|
* @internal used in ::updateMenuItemData
|
|
* @param array $item data to update
|
|
* @param string $buttonClassProp property to append button classes
|
|
* @param string $iconHtmlProp property to set icon HTML
|
|
* @param bool $isSmallIcon when set a small icon will be applied rather than the standard icon size
|
|
* @return array $item Updated data
|
|
*/
|
|
private static function updateItemData( $item, $buttonClassProp, $iconHtmlProp, $isSmallIcon = false ) {
|
|
$hasButton = $item['button'] ?? false;
|
|
$hideText = $item['text-hidden'] ?? false;
|
|
$isCollapsible = $item['collapsible'] ?? false;
|
|
$icon = $item['icon'] ?? '';
|
|
unset( $item['button'] );
|
|
unset( $item['icon'] );
|
|
unset( $item['text-hidden'] );
|
|
unset( $item['collapsible'] );
|
|
|
|
if ( $isCollapsible ) {
|
|
self::makeMenuItemCollapsible( $item );
|
|
}
|
|
if ( $hasButton ) {
|
|
self::appendClassToItem( $item[ $buttonClassProp ], [ 'mw-ui-button', 'mw-ui-quiet' ] );
|
|
}
|
|
if ( $icon ) {
|
|
if ( $hideText ) {
|
|
$iconElementClasses = [ 'mw-ui-icon', 'mw-ui-icon-element',
|
|
// Some extensions declare icons without the wikimedia- prefix. e.g. Echo
|
|
'mw-ui-icon-' . $icon,
|
|
// FIXME: Some icon names are prefixed with `wikimedia-`.
|
|
// We should seek to remove all these instances.
|
|
'mw-ui-icon-wikimedia-' . $icon
|
|
];
|
|
if ( $isSmallIcon ) {
|
|
$iconElementClasses[] = 'mw-ui-icon-small';
|
|
}
|
|
self::appendClassToItem( $item[ $buttonClassProp ], $iconElementClasses );
|
|
} else {
|
|
$item[ $iconHtmlProp ] = self::makeIcon( $icon );
|
|
}
|
|
}
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* Updates template data for Vector menu items.
|
|
*
|
|
* @internal used inside Hooks::updateMenuItems ::updateViewsMenuIcons and ::updateUserLinksDropdownItems
|
|
* @param array $item menu item data to update
|
|
* @param bool $isSmallIcon when set a small icon will be applied rather than the standard icon size
|
|
* @return array $item Updated menu item data
|
|
*/
|
|
public static function updateMenuItemData( $item, $isSmallIcon = false ) {
|
|
$buttonClassProp = 'link-class';
|
|
$iconHtmlProp = 'link-html';
|
|
return self::updateItemData( $item, $buttonClassProp, $iconHtmlProp, $isSmallIcon );
|
|
}
|
|
|
|
/**
|
|
* Updates user interface preferences for modern Vector to upgrade icon/button menu items.
|
|
*
|
|
* @param array &$content_navigation
|
|
* @param string $menu identifier
|
|
*/
|
|
private static function updateMenuItems( &$content_navigation, $menu ) {
|
|
foreach ( $content_navigation[$menu] as $key => $item ) {
|
|
$content_navigation[$menu][$key] = self::updateMenuItemData( $item );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Vector 2022 only:
|
|
* Creates an additional menu that will be injected inside the more (cactions)
|
|
* dropdown menu. This menu is a clone of `views` and this menu will only be
|
|
* shown at low resolutions (when the `views` menu is hidden).
|
|
*
|
|
* An additional menu is used instead of adding to the existing cactions menu
|
|
* so that the emptyPortlet logic for that menu is preserved and the cactions menu
|
|
* is not shown at large resolutions when empty (e.g. all items including collapsed
|
|
* items are hidden).
|
|
*
|
|
* @param array &$content_navigation
|
|
*/
|
|
private static function createMoreOverflowMenu( &$content_navigation ) {
|
|
$clonedViews = [];
|
|
foreach ( array_keys( $content_navigation['views'] ?? [] ) as $key ) {
|
|
$newItem = $content_navigation['views'][$key];
|
|
self::makeMenuItemCollapsible(
|
|
$newItem,
|
|
'vector-more-'
|
|
);
|
|
$clonedViews['more-' . $key] = $newItem;
|
|
}
|
|
// Inject collapsible menu items ahead of existing actions.
|
|
$content_navigation['views-overflow'] = $clonedViews;
|
|
}
|
|
|
|
/**
|
|
* Upgrades Vector's watch action to a watchstar.
|
|
* This is invoked inside SkinVector, not via skin registration, as skin hooks
|
|
* are not guaranteed to run last.
|
|
* This can possibly be revised based on the outcome of T287622.
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation
|
|
* @param SkinTemplate $sk
|
|
* @param array &$content_navigation
|
|
*/
|
|
public static function onSkinTemplateNavigation( $sk, &$content_navigation ) {
|
|
$title = $sk->getRelevantTitle();
|
|
|
|
$skinName = $sk->getSkinName();
|
|
// These changes should only happen in Vector.
|
|
if ( !$skinName || !self::isVectorSkin( $skinName ) ) {
|
|
return;
|
|
}
|
|
|
|
if (
|
|
$sk->getConfig()->get( 'VectorUseIconWatch' ) &&
|
|
$title && $title->canExist()
|
|
) {
|
|
self::updateActionsMenu( $content_navigation );
|
|
}
|
|
|
|
self::updateUserLinksItems( $sk, $content_navigation );
|
|
if ( $skinName === Constants::SKIN_NAME_MODERN ) {
|
|
self::createMoreOverflowMenu( $content_navigation );
|
|
}
|
|
|
|
// The updating of the views menu happens /after/ the overflow menu has been created
|
|
// this avoids icons showing in the more overflow menu.
|
|
self::updateViewsMenuIcons( $content_navigation, self::isSkinVersionLegacy( $skinName ) );
|
|
self::updateAssociatedPagesMenuIcons( $content_navigation );
|
|
}
|
|
|
|
/**
|
|
* Adds MediaWiki:Vector.css as the skin style that controls classic Vector.
|
|
*
|
|
* @param string $skin
|
|
* @param array &$pages
|
|
*/
|
|
public function onResourceLoaderSiteStylesModulePages( $skin, &$pages ): void {
|
|
if ( $skin === Constants::SKIN_NAME_MODERN ) {
|
|
$pages['MediaWiki:Vector.css'] = [ 'type' => 'style' ];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds MediaWiki:Vector.css as the skin style that controls classic Vector.
|
|
*
|
|
* @param string $skin
|
|
* @param array &$pages
|
|
*/
|
|
public function onResourceLoaderSiteModulePages( $skin, &$pages ): void {
|
|
if ( $skin === Constants::SKIN_NAME_MODERN ) {
|
|
$pages['MediaWiki:Vector.js'] = [ 'type' => 'script' ];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds the persistent sidebar hidden API preference.
|
|
*
|
|
* @param User $user User whose preferences are being modified.
|
|
* @param array[] &$prefs Preferences description array, to be fed to a HTMLForm object.
|
|
*/
|
|
public function onGetPreferences( $user, &$prefs ): void {
|
|
$config = MediaWikiServices::getInstance()->getMainConfig();
|
|
$vectorPrefs = [
|
|
Constants::PREF_KEY_SIDEBAR_VISIBLE => [
|
|
'type' => 'api',
|
|
'default' => $config->get(
|
|
Constants::CONFIG_KEY_DEFAULT_SIDEBAR_VISIBLE_FOR_AUTHORISED_USER
|
|
),
|
|
],
|
|
Constants::PREF_KEY_PAGE_TOOLS_PINNED => [
|
|
'type' => 'api'
|
|
],
|
|
Constants::PREF_KEY_MAIN_MENU_PINNED => [
|
|
'type' => 'api'
|
|
],
|
|
Constants::PREF_KEY_LIMITED_WIDTH => [
|
|
'type' => 'toggle',
|
|
'label-message' => 'vector-prefs-limited-width',
|
|
'section' => 'rendering/skin/skin-prefs',
|
|
'help-message' => 'vector-prefs-limited-width-help',
|
|
'hide-if' => [ '!==', 'skin', Constants::SKIN_NAME_MODERN ],
|
|
]
|
|
];
|
|
$prefs += $vectorPrefs;
|
|
}
|
|
|
|
/**
|
|
* Called one time when initializing a users preferences for a newly created account.
|
|
*
|
|
* @param User $user Newly created user object.
|
|
* @param bool $isAutoCreated
|
|
*/
|
|
public function onLocalUserCreated( $user, $isAutoCreated ) {
|
|
$config = MediaWikiServices::getInstance()->getMainConfig();
|
|
$default = $config->get( Constants::CONFIG_KEY_DEFAULT_SKIN_VERSION_FOR_NEW_ACCOUNTS );
|
|
if ( $default ) {
|
|
$optionsManager = MediaWikiServices::getInstance()->getUserOptionsManager();
|
|
$optionsManager->setOption(
|
|
$user,
|
|
Constants::PREF_KEY_SKIN,
|
|
$default === Constants::SKIN_VERSION_LEGACY ?
|
|
Constants::SKIN_NAME_LEGACY : Constants::SKIN_NAME_MODERN
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Temporary RequestContextCreateSkin hook handler.
|
|
* Switches to new Vector on certain pages.
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/RequestContextCreateSkin
|
|
*
|
|
* @param IContextSource $context The RequestContext object the skin is being created for.
|
|
* @param Skin|null|string &$skin A variable reference you may set a Skin instance or string
|
|
* key on to override the skin that will be used for the context.
|
|
* @return bool|void
|
|
*/
|
|
public function onRequestContextCreateSkin( $context, &$skin ) {
|
|
if ( !$skin ) {
|
|
// user is anonymous
|
|
$user = $context->getUser();
|
|
$config = $context->getConfig();
|
|
$titles = $config->get( 'Vector2022PreviewPages' );
|
|
$title = $context->getTitle();
|
|
$titleText = $title ? $title->getPrefixedText() : null;
|
|
if ( $titleText && $user->isAnon() && in_array( $titleText, $titles ) ) {
|
|
$skin = 'vector-2022';
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* NOTE: Please use ResourceLoaderGetConfigVars hook instead if possible
|
|
* for adding config to the page.
|
|
* Adds config variables to JS that depend on current page/request.
|
|
*
|
|
* Adds a config flag that can disable saving the VectorSidebarVisible
|
|
* user preference when the sidebar menu icon is clicked.
|
|
*
|
|
* @param array &$vars Array of variables to be added into the output.
|
|
* @param OutputPage $out OutputPage instance calling the hook
|
|
*/
|
|
public function onMakeGlobalVariablesScript( &$vars, $out ): void {
|
|
$skin = $out->getSkin();
|
|
$skinName = $skin->getSkinName();
|
|
if ( !self::isVectorSkin( $skinName ) ) {
|
|
return;
|
|
}
|
|
$config = $out->getConfig();
|
|
$user = $out->getUser();
|
|
|
|
if ( $user->isRegistered() && self::isSkinVersionLegacy( $skinName ) ) {
|
|
$vars[ 'wgVectorDisableSidebarPersistence' ] =
|
|
$config->get(
|
|
Constants::CONFIG_KEY_DISABLE_SIDEBAR_PERSISTENCE
|
|
);
|
|
}
|
|
// Must be exposed to CentralNotice banners via mw.config
|
|
$vars[ 'wgVector2022PreviewPages' ] = $config->get( 'Vector2022PreviewPages' );
|
|
}
|
|
|
|
/**
|
|
* Gets whether the current skin version is the legacy version.
|
|
*
|
|
* @param string $skinName hint that can be used to detect modern vector.
|
|
* @return bool
|
|
*/
|
|
private static function isSkinVersionLegacy( $skinName ): bool {
|
|
return $skinName === Constants::SKIN_NAME_LEGACY;
|
|
}
|
|
}
|