mediawiki-skins-MinervaNeue/includes/ServiceWiring.php

147 lines
5.4 KiB
PHP
Raw Normal View History

<?php
/**
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\MediaWikiServices;
use MediaWiki\Minerva\LanguagesHelper;
use MediaWiki\Minerva\Menu\Definitions;
use MediaWiki\Minerva\Menu\Main\AdvancedMainMenuBuilder;
use MediaWiki\Minerva\Menu\Main\DefaultMainMenuBuilder;
use MediaWiki\Minerva\Menu\Main\MainMenuDirector;
PageActions menu should use Builder pattern The PageActions menu shouldn't be built inside SkinMinerva class. All menus should be build in similar way so it's easier to understand how different parts of the system work. This will allow us to easily track different menu elements/move elements between different menus. Additionally we should allow extensions/3rd party to modify both the toolbar and overflow menus. Changes: - Removed PageActions logic from SkinMinerva class - introduced new PageActions/Director to build page actions menu - introduced Builders for toolbar, and different types of overflow menu - because Overflow menu elements require the BaseTemplate::data['nav_urls] array, instead building all links, pass the array when building PageActions menu. Code for getting menu entries had to be rewritten (use $navUrls array instead of $this->tpl['nav_urls']; - ServiceWirings file contains logic on what to pass to PageActions/Director class (which builders) - PageActionsMenuEntry setTitle() and setNodeID() returns $this so we can use method chaining. Only a syntax sugar. - if AMC is not available/Overflow menu is disabled via config, system will pass EmptyOverflowBuilder. System will not add "show more" icon to toolbar menu when $overflowBuilder returns empty set of options. - both ToolbarBulder and OverflowMenuBuilders (except EmptyOverflowBuilder) will run 'MobileMenu' hook. Extensions should listen to hook, and inject it's own menu entries at their leisure. Required follow-ups: - SkinMinerva provides isAllowedAction() method which is used both in the skin code and in Toolbar builder. We should extract that method into separate service - SkinMinerva provides getHistoryUrl() method which is used both in the skin code and in Toolbar builder. We should provide MinervaUrls service that knows how to build custom mobile URLs. Bug: T221792 Change-Id: Ie08c4b61cea60c3a42fbf796a39360feea22bc33
2019-05-23 22:34:10 +00:00
use MediaWiki\Minerva\Menu\PageActions as PageActionsMenu;
use MediaWiki\Minerva\Menu\User\AdvancedUserMenuBuilder;
use MediaWiki\Minerva\Menu\User\DefaultUserMenuBuilder;
use MediaWiki\Minerva\Menu\User\UserMenuDirector;
use MediaWiki\Minerva\Permissions\IMinervaPagePermissions;
use MediaWiki\Minerva\Permissions\MinervaPagePermissions;
use MediaWiki\Minerva\SkinOptions;
use MediaWiki\Minerva\Skins\SkinUserPageHelper;
return [
'Minerva.Menu.Definitions' => function ( MediaWikiServices $services ): Definitions {
return new Definitions( RequestContext::getMain(), $services->getSpecialPageFactory() );
},
'Minerva.Menu.UserMenuDirector' => function ( MediaWikiServices $services ): UserMenuDirector {
$options = $services->getService( 'Minerva.SkinOptions' );
$definitions = $services->getService( 'Minerva.Menu.Definitions' );
$context = RequestContext::getMain();
Feature flag overhaul Two new feature flags: 1) MinervaPersonalMenu 2) MinervaAdvancedMainMenu Changes: * AMC defaults to false on desktop - desktop doesn't have AMC mode it just enables several skin options. * WHen inserting a link at the bottom of the page check whether the talk at top of the page (tabs) is enabled.. not AMC * Update ServiceWiring to construct menu based on MinervaAdvancedMainMenu and MinervaPersonalMenu - note when former is enabled but not latter there is no way to logout. Noted in README. * Use one entry point for skins.minerva.amc.styles/index.less * Document files inside skins.minerva.amc.styles to make it clear which features they are associated with * Drop history page styles when AMC is disabled - it's not possible to ever get to these as the history page redirects in non-AMC mode * Rename the class .minerva--amc-enabled to minerva--history-page-action-enabled to reflect its real purpose and move styles from skins.minerva.base.styles to skins.minerva.amc.styles No need to worry about cached HTML as AMC runs without cache... * Remove isAnyAMCOptionEnabled - it's an antipattern and should be discouraged as it discourages the art of feature flagging. Nothing is using it after these changes. * The AMC_MODE flag is disabled. There is no need for this - AMC is not a feature and therefore not a skin option. It is a mechanism for turning on other skin options. Tests are updated. Testing: It should now be possible to enable any feature in `beta` and see it in the beta of the site. Bug: T229295 Change-Id: I48959905f5c09721b14a27aa1a5ad82849ac6263
2019-08-22 20:31:31 +00:00
$builder = $options->get( SkinOptions::PERSONAL_MENU ) ?
new AdvancedUserMenuBuilder(
$context,
$context->getUser(),
$definitions
) :
new DefaultUserMenuBuilder();
return new UserMenuDirector(
$builder,
$context->getSkin()
);
},
'Minerva.Menu.MainDirector' => function ( MediaWikiServices $services ): MainMenuDirector {
$context = RequestContext::getMain();
/** @var SkinOptions $options */
$options = $services->getService( 'Minerva.SkinOptions' );
$definitions = $services->getService( 'Minerva.Menu.Definitions' );
$showMobileOptions = $options->get( SkinOptions::MOBILE_OPTIONS );
$user = $context->getUser();
// Add a donate link (see https://phabricator.wikimedia.org/T219793)
$showDonateLink = $options->get( SkinOptions::SHOW_DONATE );
Feature flag overhaul Two new feature flags: 1) MinervaPersonalMenu 2) MinervaAdvancedMainMenu Changes: * AMC defaults to false on desktop - desktop doesn't have AMC mode it just enables several skin options. * WHen inserting a link at the bottom of the page check whether the talk at top of the page (tabs) is enabled.. not AMC * Update ServiceWiring to construct menu based on MinervaAdvancedMainMenu and MinervaPersonalMenu - note when former is enabled but not latter there is no way to logout. Noted in README. * Use one entry point for skins.minerva.amc.styles/index.less * Document files inside skins.minerva.amc.styles to make it clear which features they are associated with * Drop history page styles when AMC is disabled - it's not possible to ever get to these as the history page redirects in non-AMC mode * Rename the class .minerva--amc-enabled to minerva--history-page-action-enabled to reflect its real purpose and move styles from skins.minerva.base.styles to skins.minerva.amc.styles No need to worry about cached HTML as AMC runs without cache... * Remove isAnyAMCOptionEnabled - it's an antipattern and should be discouraged as it discourages the art of feature flagging. Nothing is using it after these changes. * The AMC_MODE flag is disabled. There is no need for this - AMC is not a feature and therefore not a skin option. It is a mechanism for turning on other skin options. Tests are updated. Testing: It should now be possible to enable any feature in `beta` and see it in the beta of the site. Bug: T229295 Change-Id: I48959905f5c09721b14a27aa1a5ad82849ac6263
2019-08-22 20:31:31 +00:00
$builder = $options->get( SkinOptions::MAIN_MENU_EXPANDED ) ?
new AdvancedMainMenuBuilder( $showMobileOptions, $showDonateLink, $user, $definitions ) :
new DefaultMainMenuBuilder( $showMobileOptions, $showDonateLink, $user, $definitions );
return new MainMenuDirector( $builder, $context, $services->getSpecialPageFactory() );
},
'Minerva.Menu.PageActionsDirector' =>
function ( MediaWikiServices $services ): PageActionsMenu\PageActionsDirector {
/**
* @var SkinOptions $skinOptions
* @var SkinMinerva $skin
* @var SkinUserPageHelper $userPageHelper
*/
$skinOptions = $services->getService( 'Minerva.SkinOptions' );
$context = RequestContext::getMain();
$title = $context->getTitle();
$user = $context->getUser();
$userPageHelper = $services->getService( 'Minerva.SkinUserPageHelper' );
$languagesHelper = $services->getService( 'Minerva.LanguagesHelper' );
$namespaceInfo = $services->getNamespaceInfo();
$relevantUserPageHelper = $title->inNamespace( NS_USER_TALK ) ?
new SkinUserPageHelper(
$namespaceInfo->getSubjectPage( $context->getSkin()->getRelevantTitle() )
) :
$userPageHelper;
$toolbarBuilder = new PageActionsMenu\ToolbarBuilder(
$title,
$user,
$context,
$services->getService( 'Minerva.Permissions' ),
$skinOptions,
$relevantUserPageHelper,
$languagesHelper
);
if ( $skinOptions->get( SkinOptions::TOOLBAR_SUBMENU ) ) {
$overflowBuilder = $relevantUserPageHelper->isUserPage() ?
new PageActionsMenu\UserNamespaceOverflowBuilder(
$title,
$context,
$services->getService( 'Minerva.Permissions' ),
$languagesHelper
) :
new PageActionsMenu\DefaultOverflowBuilder(
$context
);
} else {
$overflowBuilder = new PageActionsMenu\EmptyOverflowBuilder();
}
PageActions menu should use Builder pattern The PageActions menu shouldn't be built inside SkinMinerva class. All menus should be build in similar way so it's easier to understand how different parts of the system work. This will allow us to easily track different menu elements/move elements between different menus. Additionally we should allow extensions/3rd party to modify both the toolbar and overflow menus. Changes: - Removed PageActions logic from SkinMinerva class - introduced new PageActions/Director to build page actions menu - introduced Builders for toolbar, and different types of overflow menu - because Overflow menu elements require the BaseTemplate::data['nav_urls] array, instead building all links, pass the array when building PageActions menu. Code for getting menu entries had to be rewritten (use $navUrls array instead of $this->tpl['nav_urls']; - ServiceWirings file contains logic on what to pass to PageActions/Director class (which builders) - PageActionsMenuEntry setTitle() and setNodeID() returns $this so we can use method chaining. Only a syntax sugar. - if AMC is not available/Overflow menu is disabled via config, system will pass EmptyOverflowBuilder. System will not add "show more" icon to toolbar menu when $overflowBuilder returns empty set of options. - both ToolbarBulder and OverflowMenuBuilders (except EmptyOverflowBuilder) will run 'MobileMenu' hook. Extensions should listen to hook, and inject it's own menu entries at their leisure. Required follow-ups: - SkinMinerva provides isAllowedAction() method which is used both in the skin code and in Toolbar builder. We should extract that method into separate service - SkinMinerva provides getHistoryUrl() method which is used both in the skin code and in Toolbar builder. We should provide MinervaUrls service that knows how to build custom mobile URLs. Bug: T221792 Change-Id: Ie08c4b61cea60c3a42fbf796a39360feea22bc33
2019-05-23 22:34:10 +00:00
return new PageActionsMenu\PageActionsDirector(
$toolbarBuilder,
$overflowBuilder,
$context
);
},
'Minerva.SkinUserPageHelper' => function (): SkinUserPageHelper {
return new SkinUserPageHelper(
RequestContext::getMain()->getSkin()->getRelevantTitle()
);
},
'Minerva.LanguagesHelper' => function (): LanguagesHelper {
return new LanguagesHelper( RequestContext::getMain()->getOutput() );
},
'Minerva.SkinOptions' => function (): SkinOptions {
return new SkinOptions();
},
'Minerva.Permissions' => function ( MediaWikiServices $services ): IMinervaPagePermissions {
$permissions = new MinervaPagePermissions(
$services->getService( 'Minerva.SkinOptions' ),
$services->getService( 'Minerva.LanguagesHelper' ),
$services->getPermissionManager()
);
// TODO: This should not be allowed, this is basically global $wgTitle and $wgUser.
$permissions->setContext( RequestContext::getMain() );
return $permissions;
}
];