From 0291942613e7627a03d882b1bba6a88a30e1164b Mon Sep 17 00:00:00 2001 From: Yury Bondarenko Date: Thu, 28 Dec 2023 13:46:39 +0100 Subject: [PATCH] Proof-of-concept: independent menu section providers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Replace god-class resolvers with a service that populates the menus from lists of injectable providers - Static menu sections are resolved at the root route ~ `resolveStatic` - Route-dependent menu sections can be declared in the same structure, but are resolved on-demand ~ `resolveRoute` - More and more easily customizable - Parts can be moved between menus, removed, replaced or extended individually - The dependencies of each provider are independent of each other - Order of providers determines the order of each menu → single source of truth for the order --- .../admin-sidebar-section.component.ts | 11 +- ...dable-admin-sidebar-section.component.html | 2 +- ...andable-admin-sidebar-section.component.ts | 5 +- src/app/app-routing.module.ts | 40 +++--- src/app/app.menus.ts | 58 ++++++++ src/app/app.module.ts | 60 ++++++--- .../collection-page-routing.module.ts | 52 +++----- .../community-page-routing.module.ts | 47 +++---- src/app/home-page/home-page-routing.module.ts | 19 +-- src/app/item-page/item-page-routing.module.ts | 62 +++++---- src/app/item-page/item-page.resolver.ts | 4 +- .../expandable-navbar-section.component.ts | 12 +- .../navbar-section.component.ts | 14 +- ...dit-menu-expandable-section.component.scss | 14 +- ...-edit-menu-expandable-section.component.ts | 10 +- .../dso-edit-menu-section.component.ts | 10 +- .../menu/menu-item/models/altmetric.model.ts | 2 +- .../menu-item/models/external-link.model.ts | 2 +- .../menu/menu-item/models/link.model.ts | 2 +- .../menu/menu-item/models/menu-item.model.ts | 2 +- .../menu/menu-item/models/onclick.model.ts | 4 +- .../menu/menu-item/models/search.model.ts | 4 +- .../menu/menu-item/models/text.model.ts | 2 +- src/app/shared/menu/menu-provider.service.ts | 126 ++++++++++++++++++ src/app/shared/menu/menu-provider.ts | 47 +++++++ src/app/shared/menu/menu-section.model.ts | 93 +++++++++++-- ....ts => abstract-menu-section.component.ts} | 41 ++++-- .../menu-section.component.spec.ts | 37 +++-- src/app/shared/menu/menu-state.model.ts | 2 +- src/app/shared/menu/menu.component.ts | 10 +- src/app/shared/menu/menu.module.ts | 16 +-- src/app/shared/menu/menu.reducer.spec.ts | 2 +- src/app/shared/menu/menu.reducer.ts | 2 +- src/app/shared/menu/menu.resolver.ts | 35 +++++ src/app/shared/menu/menu.structure.ts | 46 +++++++ .../menu/providers/access-control.menu.ts | 94 +++++++++++++ .../menu/providers/admin-search.menu.ts | 50 +++++++ src/app/shared/menu/providers/browse.menu.ts | 67 ++++++++++ .../menu/providers/comcol-subscribe.menu.ts | 65 +++++++++ .../menu/providers/community-list.menu.ts | 35 +++++ .../shared/menu/providers/curation.menu.ts | 51 +++++++ .../shared/menu/providers/dso-edit.menu.ts | 53 ++++++++ src/app/shared/menu/providers/dso.menu.ts | 56 ++++++++ src/app/shared/menu/providers/edit.menu.ts | 92 +++++++++++++ .../providers/expandable-menu-provider.ts | 64 +++++++++ src/app/shared/menu/providers/export.menu.ts | 88 ++++++++++++ src/app/shared/menu/providers/health.menu.ts | 50 +++++++ src/app/shared/menu/providers/import.menu.ts | 80 +++++++++++ .../shared/menu/providers/item-claim.menu.ts | 93 +++++++++++++ .../shared/menu/providers/item-orcid.menu.ts | 57 ++++++++ .../menu/providers/item-versioning.menu.ts | 60 +++++++++ src/app/shared/menu/providers/item.menu.ts | 52 ++++++++ src/app/shared/menu/providers/new.menu.ts | 100 ++++++++++++++ .../menu/providers/notifications.menu.ts | 68 ++++++++++ .../shared/menu/providers/processes.menu.ts | 50 +++++++ .../shared/menu/providers/registries.menu.ts | 75 +++++++++++ .../menu/providers/route-context.menu.ts | 43 ++++++ .../shared/menu/providers/statistics.menu.ts | 70 ++++++++++ .../menu/providers/system-wide-alert.menu.ts | 50 +++++++ .../shared/menu/providers/workflow.menu.ts | 50 +++++++ 60 files changed, 2281 insertions(+), 227 deletions(-) create mode 100644 src/app/app.menus.ts create mode 100644 src/app/shared/menu/menu-provider.service.ts create mode 100644 src/app/shared/menu/menu-provider.ts rename src/app/shared/menu/menu-section/{menu-section.component.ts => abstract-menu-section.component.ts} (89%) create mode 100644 src/app/shared/menu/menu.resolver.ts create mode 100644 src/app/shared/menu/menu.structure.ts create mode 100644 src/app/shared/menu/providers/access-control.menu.ts create mode 100644 src/app/shared/menu/providers/admin-search.menu.ts create mode 100644 src/app/shared/menu/providers/browse.menu.ts create mode 100644 src/app/shared/menu/providers/comcol-subscribe.menu.ts create mode 100644 src/app/shared/menu/providers/community-list.menu.ts create mode 100644 src/app/shared/menu/providers/curation.menu.ts create mode 100644 src/app/shared/menu/providers/dso-edit.menu.ts create mode 100644 src/app/shared/menu/providers/dso.menu.ts create mode 100644 src/app/shared/menu/providers/edit.menu.ts create mode 100644 src/app/shared/menu/providers/expandable-menu-provider.ts create mode 100644 src/app/shared/menu/providers/export.menu.ts create mode 100644 src/app/shared/menu/providers/health.menu.ts create mode 100644 src/app/shared/menu/providers/import.menu.ts create mode 100644 src/app/shared/menu/providers/item-claim.menu.ts create mode 100644 src/app/shared/menu/providers/item-orcid.menu.ts create mode 100644 src/app/shared/menu/providers/item-versioning.menu.ts create mode 100644 src/app/shared/menu/providers/item.menu.ts create mode 100644 src/app/shared/menu/providers/new.menu.ts create mode 100644 src/app/shared/menu/providers/notifications.menu.ts create mode 100644 src/app/shared/menu/providers/processes.menu.ts create mode 100644 src/app/shared/menu/providers/registries.menu.ts create mode 100644 src/app/shared/menu/providers/route-context.menu.ts create mode 100644 src/app/shared/menu/providers/statistics.menu.ts create mode 100644 src/app/shared/menu/providers/system-wide-alert.menu.ts create mode 100644 src/app/shared/menu/providers/workflow.menu.ts diff --git a/src/app/admin/admin-sidebar/admin-sidebar-section/admin-sidebar-section.component.ts b/src/app/admin/admin-sidebar/admin-sidebar-section/admin-sidebar-section.component.ts index d6cd803622..3606cb299f 100644 --- a/src/app/admin/admin-sidebar/admin-sidebar-section/admin-sidebar-section.component.ts +++ b/src/app/admin/admin-sidebar/admin-sidebar-section/admin-sidebar-section.component.ts @@ -1,5 +1,5 @@ import { Component, Inject, Injector, OnInit } from '@angular/core'; -import { MenuSectionComponent } from '../../../shared/menu/menu-section/menu-section.component'; +import { AbstractMenuSectionComponent } from '../../../shared/menu/menu-section/abstract-menu-section.component'; import { MenuService } from '../../../shared/menu/menu.service'; import { rendersSectionForMenu } from '../../../shared/menu/menu-section.decorator'; import { LinkMenuItemModel } from '../../../shared/menu/menu-item/models/link.model'; @@ -19,7 +19,7 @@ import { Router } from '@angular/router'; }) @rendersSectionForMenu(MenuID.ADMIN, false) -export class AdminSidebarSectionComponent extends MenuSectionComponent implements OnInit { +export class AdminSidebarSectionComponent extends AbstractMenuSectionComponent implements OnInit { /** * This section resides in the Admin Sidebar @@ -33,16 +33,17 @@ export class AdminSidebarSectionComponent extends MenuSectionComponent implement isDisabled: boolean; constructor( - @Inject('sectionDataProvider') menuSection: MenuSection, + @Inject('sectionDataProvider') protected section: MenuSection, protected menuService: MenuService, protected injector: Injector, protected router: Router, ) { - super(menuSection, menuService, injector); - this.itemModel = menuSection.model as LinkMenuItemModel; + super(menuService, injector); + this.itemModel = section.model as LinkMenuItemModel; } ngOnInit(): void { + // todo: should support all menu entries? this.isDisabled = this.itemModel?.disabled || isEmpty(this.itemModel?.link); super.ngOnInit(); } diff --git a/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.html b/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.html index 1f4666bbd0..23f5a958d2 100644 --- a/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.html +++ b/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.html @@ -13,7 +13,7 @@ (keyup.enter)="toggleSection($event)" >
- +
diff --git a/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.ts b/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.ts index 4555c0fa93..2602fbd846 100644 --- a/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.ts +++ b/src/app/admin/admin-sidebar/expandable-admin-sidebar-section/expandable-admin-sidebar-section.component.ts @@ -1,5 +1,6 @@ import { Component, Inject, Injector, OnInit } from '@angular/core'; import { rotate } from '../../../shared/animations/rotate'; +import { MenuSection } from '../../../shared/menu/menu-section.model'; import { AdminSidebarSectionComponent } from '../admin-sidebar-section/admin-sidebar-section.component'; import { slide } from '../../../shared/animations/slide'; import { CSSVariableService } from '../../../shared/sass-helper/css-variable.service'; @@ -51,13 +52,13 @@ export class ExpandableAdminSidebarSectionComponent extends AdminSidebarSectionC expanded: Observable; constructor( - @Inject('sectionDataProvider') menuSection, + @Inject('sectionDataProvider') protected section: MenuSection, protected menuService: MenuService, private variableService: CSSVariableService, protected injector: Injector, protected router: Router, ) { - super(menuSection, menuService, injector, router); + super(section, menuService, injector, router); } /** diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts index deb68f1ea9..568cfb0244 100644 --- a/src/app/app-routing.module.ts +++ b/src/app/app-routing.module.ts @@ -1,11 +1,8 @@ import { NgModule } from '@angular/core'; -import { RouterModule, NoPreloading } from '@angular/router'; -import { AuthBlockingGuard } from './core/auth/auth-blocking.guard'; - -import { AuthenticatedGuard } from './core/auth/authenticated.guard'; import { - SiteAdministratorGuard -} from './core/data/feature-authorization/feature-authorization-guard/site-administrator.guard'; + NoPreloading, + RouterModule, +} from '@angular/router'; import { ACCESS_CONTROL_MODULE_PATH, ADMIN_MODULE_PATH, @@ -24,22 +21,24 @@ import { } from './app-routing-paths'; import { COLLECTION_MODULE_PATH } from './collection-page/collection-page-routing-paths'; import { COMMUNITY_MODULE_PATH } from './community-page/community-page-routing-paths'; -import { ITEM_MODULE_PATH } from './item-page/item-page-routing-paths'; -import { PROCESS_MODULE_PATH } from './process-page/process-page-routing.paths'; -import { ReloadGuard } from './core/reload/reload.guard'; -import { EndUserAgreementCurrentUserGuard } from './core/end-user-agreement/end-user-agreement-current-user.guard'; +import { AuthBlockingGuard } from './core/auth/auth-blocking.guard'; + +import { AuthenticatedGuard } from './core/auth/authenticated.guard'; +import { GroupAdministratorGuard } from './core/data/feature-authorization/feature-authorization-guard/group-administrator.guard'; +import { SiteAdministratorGuard } from './core/data/feature-authorization/feature-authorization-guard/site-administrator.guard'; import { SiteRegisterGuard } from './core/data/feature-authorization/feature-authorization-guard/site-register.guard'; -import { ThemedPageNotFoundComponent } from './pagenotfound/themed-pagenotfound.component'; -import { ThemedForbiddenComponent } from './forbidden/themed-forbidden.component'; -import { - GroupAdministratorGuard -} from './core/data/feature-authorization/feature-authorization-guard/group-administrator.guard'; -import { - ThemedPageInternalServerErrorComponent -} from './page-internal-server-error/themed-page-internal-server-error.component'; +import { EndUserAgreementCurrentUserGuard } from './core/end-user-agreement/end-user-agreement-current-user.guard'; +import { ReloadGuard } from './core/reload/reload.guard'; import { ServerCheckGuard } from './core/server-check/server-check.guard'; +import { ThemedForbiddenComponent } from './forbidden/themed-forbidden.component'; +import { ITEM_MODULE_PATH } from './item-page/item-page-routing-paths'; import { MenuResolver } from './menu.resolver'; import { ThemedPageErrorComponent } from './page-error/themed-page-error.component'; +import { ThemedPageInternalServerErrorComponent } from './page-internal-server-error/themed-page-internal-server-error.component'; +import { ThemedPageNotFoundComponent } from './pagenotfound/themed-pagenotfound.component'; +import { PROCESS_MODULE_PATH } from './process-page/process-page-routing.paths'; +import { MenuProviderService } from './shared/menu/menu-provider.service'; +import { resolveStaticMenus } from './shared/menu/menu.resolver'; @NgModule({ imports: [ @@ -50,7 +49,10 @@ import { ThemedPageErrorComponent } from './page-error/themed-page-error.compone path: '', canActivate: [AuthBlockingGuard], canActivateChild: [ServerCheckGuard], - resolve: [MenuResolver], + resolve: [ + resolveStaticMenus(), + // MenuResolver, + ], children: [ { path: '', redirectTo: '/home', pathMatch: 'full' }, { diff --git a/src/app/app.menus.ts b/src/app/app.menus.ts new file mode 100644 index 0000000000..9453a07b92 --- /dev/null +++ b/src/app/app.menus.ts @@ -0,0 +1,58 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { MenuID } from './shared/menu/menu-id.model'; +import { buildMenuStructure } from './shared/menu/menu.structure'; +import { AccessControlMenuProvider } from './shared/menu/providers/access-control.menu'; +import { AdminSearchMenuProvider } from './shared/menu/providers/admin-search.menu'; +import { BrowseMenuProvider } from './shared/menu/providers/browse.menu'; +import { SubscribeMenuProvider } from './shared/menu/providers/comcol-subscribe.menu'; +import { CommunityListMenuProvider } from './shared/menu/providers/community-list.menu'; +import { CurationMenuProvider } from './shared/menu/providers/curation.menu'; +import { DSpaceObjectEditMenuProvider } from './shared/menu/providers/dso-edit.menu'; +import { EditMenuProvider } from './shared/menu/providers/edit.menu'; +import { ExportMenuProvider } from './shared/menu/providers/export.menu'; +import { HealthMenuProvider } from './shared/menu/providers/health.menu'; +import { ImportMenuProvider } from './shared/menu/providers/import.menu'; +import { ClaimMenuProvider } from './shared/menu/providers/item-claim.menu'; +import { OrcidMenuProvider } from './shared/menu/providers/item-orcid.menu'; +import { VersioningMenuProvider } from './shared/menu/providers/item-versioning.menu'; +import { NewMenuProvider } from './shared/menu/providers/new.menu'; +import { ProcessesMenuProvider } from './shared/menu/providers/processes.menu'; +import { RegistriesMenuProvider } from './shared/menu/providers/registries.menu'; +import { StatisticsMenuProvider } from './shared/menu/providers/statistics.menu'; +import { SystemWideAlertMenuProvider } from './shared/menu/providers/system-wide-alert.menu'; +import { WorkflowMenuProvider } from './shared/menu/providers/workflow.menu'; + +export const MENUS = buildMenuStructure({ + [MenuID.PUBLIC]: [ + CommunityListMenuProvider, + BrowseMenuProvider, + StatisticsMenuProvider, + ], + [MenuID.ADMIN]: [ + NewMenuProvider, + EditMenuProvider, + ImportMenuProvider, + ExportMenuProvider, + AccessControlMenuProvider, + AdminSearchMenuProvider, + RegistriesMenuProvider, + CurationMenuProvider, + ProcessesMenuProvider, + WorkflowMenuProvider, + HealthMenuProvider, + SystemWideAlertMenuProvider, + ], + [MenuID.DSO_EDIT]: [ + DSpaceObjectEditMenuProvider, + VersioningMenuProvider, + OrcidMenuProvider, + ClaimMenuProvider, + SubscribeMenuProvider, + ], +}); diff --git a/src/app/app.module.ts b/src/app/app.module.ts index 89e361821b..20fbe72d4e 100644 --- a/src/app/app.module.ts +++ b/src/app/app.module.ts @@ -1,35 +1,60 @@ -import { APP_BASE_HREF, CommonModule, DOCUMENT } from '@angular/common'; -import { HTTP_INTERCEPTORS, HttpClientModule } from '@angular/common/http'; +import { + APP_BASE_HREF, + CommonModule, + DOCUMENT, +} from '@angular/common'; +import { + HTTP_INTERCEPTORS, + HttpClientModule, +} from '@angular/common/http'; import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { NgbModule } from '@ng-bootstrap/ng-bootstrap'; +import { DYNAMIC_MATCHER_PROVIDERS } from '@ng-dynamic-forms/core'; import { EffectsModule } from '@ngrx/effects'; -import { RouterStateSerializer, StoreRouterConnectingModule } from '@ngrx/router-store'; -import { MetaReducer, StoreModule, USER_PROVIDED_META_REDUCERS } from '@ngrx/store'; +import { + RouterStateSerializer, + StoreRouterConnectingModule, +} from '@ngrx/router-store'; +import { + MetaReducer, + StoreModule, + USER_PROVIDED_META_REDUCERS, +} from '@ngrx/store'; import { TranslateModule } from '@ngx-translate/core'; import { ScrollToModule } from '@nicky-lenaers/ngx-scroll-to'; -import { DYNAMIC_MATCHER_PROVIDERS } from '@ng-dynamic-forms/core'; +import { + APP_CONFIG, + AppConfig, +} from '../config/app-config.interface'; +import { StoreDevModules } from '../config/store/devtools'; +import { environment } from '../environments/environment'; +import { EagerThemesModule } from '../themes/eager-themes.module'; import { AppRoutingModule } from './app-routing.module'; import { AppComponent } from './app.component'; import { appEffects } from './app.effects'; -import { appMetaReducers, debugMetaReducers } from './app.metareducers'; -import { appReducers, AppState, storeModuleConfig } from './app.reducer'; +import { MENUS } from './app.menus'; +import { + appMetaReducers, + debugMetaReducers, +} from './app.metareducers'; +import { + appReducers, + AppState, + storeModuleConfig, +} from './app.reducer'; +import { AuthInterceptor } from './core/auth/auth.interceptor'; import { CoreModule } from './core/core.module'; +import { LocaleInterceptor } from './core/locale/locale.interceptor'; +import { LogInterceptor } from './core/log/log.interceptor'; import { ClientCookieService } from './core/services/client-cookie.service'; +import { XsrfInterceptor } from './core/xsrf/xsrf.interceptor'; import { NavbarModule } from './navbar/navbar.module'; +import { RootModule } from './root.module'; import { DSpaceRouterStateSerializer } from './shared/ngrx/dspace-router-state-serializer'; import { SharedModule } from './shared/shared.module'; -import { environment } from '../environments/environment'; -import { AuthInterceptor } from './core/auth/auth.interceptor'; -import { LocaleInterceptor } from './core/locale/locale.interceptor'; -import { XsrfInterceptor } from './core/xsrf/xsrf.interceptor'; -import { LogInterceptor } from './core/log/log.interceptor'; -import { EagerThemesModule } from '../themes/eager-themes.module'; -import { APP_CONFIG, AppConfig } from '../config/app-config.interface'; -import { StoreDevModules } from '../config/store/devtools'; -import { RootModule } from './root.module'; export function getConfig() { return environment; @@ -105,6 +130,9 @@ const PROVIDERS = [ }, // register the dynamic matcher used by form. MUST be provided by the app module ...DYNAMIC_MATCHER_PROVIDERS, + + // DI-composable menus + ...MENUS, ]; const DECLARATIONS = [ diff --git a/src/app/collection-page/collection-page-routing.module.ts b/src/app/collection-page/collection-page-routing.module.ts index 9dc25b778e..27693f348e 100644 --- a/src/app/collection-page/collection-page-routing.module.ts +++ b/src/app/collection-page/collection-page-routing.module.ts @@ -1,27 +1,28 @@ import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; +import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; +import { CollectionBreadcrumbResolver } from '../core/breadcrumbs/collection-breadcrumb.resolver'; +import { DSOBreadcrumbsService } from '../core/breadcrumbs/dso-breadcrumbs.service'; +import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver'; +import { LinkService } from '../core/cache/builders/link.service'; +import { resolveRouteMenus } from '../shared/menu/menu.resolver'; +import { SubscribeMenuProvider } from '../shared/menu/providers/comcol-subscribe.menu'; +import { DSpaceObjectEditMenuProvider } from '../shared/menu/providers/dso-edit.menu'; +import { StatisticsMenuProvider } from '../shared/menu/providers/statistics.menu'; +import { CollectionPageAdministratorGuard } from './collection-page-administrator.guard'; +import { + COLLECTION_CREATE_PATH, + COLLECTION_EDIT_PATH, + ITEMTEMPLATE_PATH, +} from './collection-page-routing-paths'; import { CollectionPageResolver } from './collection-page.resolver'; import { CreateCollectionPageComponent } from './create-collection-page/create-collection-page.component'; -import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; import { CreateCollectionPageGuard } from './create-collection-page/create-collection-page.guard'; import { DeleteCollectionPageComponent } from './delete-collection-page/delete-collection-page.component'; -import { ThemedEditItemTemplatePageComponent } from './edit-item-template-page/themed-edit-item-template-page.component'; import { ItemTemplatePageResolver } from './edit-item-template-page/item-template-page.resolver'; -import { CollectionBreadcrumbResolver } from '../core/breadcrumbs/collection-breadcrumb.resolver'; -import { DSOBreadcrumbsService } from '../core/breadcrumbs/dso-breadcrumbs.service'; -import { LinkService } from '../core/cache/builders/link.service'; -import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver'; -import { - ITEMTEMPLATE_PATH, - COLLECTION_EDIT_PATH, - COLLECTION_CREATE_PATH -} from './collection-page-routing-paths'; -import { CollectionPageAdministratorGuard } from './collection-page-administrator.guard'; -import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model'; +import { ThemedEditItemTemplatePageComponent } from './edit-item-template-page/themed-edit-item-template-page.component'; import { ThemedCollectionPageComponent } from './themed-collection-page.component'; -import { MenuItemType } from '../shared/menu/menu-item-type.model'; -import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; @NgModule({ imports: [ @@ -36,7 +37,11 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; resolve: { dso: CollectionPageResolver, breadcrumb: CollectionBreadcrumbResolver, - menu: DSOEditMenuResolver + menu: resolveRouteMenus( + StatisticsMenuProvider, + DSpaceObjectEditMenuProvider, + SubscribeMenuProvider, + ), }, runGuardsAndResolvers: 'always', children: [ @@ -68,21 +73,6 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; pathMatch: 'full', } ], - data: { - menu: { - public: [{ - id: 'statistics_collection_:id', - active: true, - visible: true, - index: 2, - model: { - type: MenuItemType.LINK, - text: 'menu.section.statistics', - link: 'statistics/collections/:id/', - } as LinkMenuItemModel, - }], - }, - }, }, ]) ], diff --git a/src/app/community-page/community-page-routing.module.ts b/src/app/community-page/community-page-routing.module.ts index c37f8832f8..493908ce0c 100644 --- a/src/app/community-page/community-page-routing.module.ts +++ b/src/app/community-page/community-page-routing.module.ts @@ -1,20 +1,25 @@ import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; - -import { CommunityPageResolver } from './community-page.resolver'; -import { CreateCommunityPageComponent } from './create-community-page/create-community-page.component'; import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; -import { CreateCommunityPageGuard } from './create-community-page/create-community-page.guard'; -import { DeleteCommunityPageComponent } from './delete-community-page/delete-community-page.component'; import { CommunityBreadcrumbResolver } from '../core/breadcrumbs/community-breadcrumb.resolver'; import { DSOBreadcrumbsService } from '../core/breadcrumbs/dso-breadcrumbs.service'; import { LinkService } from '../core/cache/builders/link.service'; -import { COMMUNITY_EDIT_PATH, COMMUNITY_CREATE_PATH } from './community-page-routing-paths'; -import { CommunityPageAdministratorGuard } from './community-page-administrator.guard'; -import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model'; -import { ThemedCommunityPageComponent } from './themed-community-page.component'; -import { MenuItemType } from '../shared/menu/menu-item-type.model'; import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; +import { resolveRouteMenus } from '../shared/menu/menu.resolver'; +import { SubscribeMenuProvider } from '../shared/menu/providers/comcol-subscribe.menu'; +import { DSpaceObjectEditMenuProvider } from '../shared/menu/providers/dso-edit.menu'; +import { StatisticsMenuProvider } from '../shared/menu/providers/statistics.menu'; +import { CommunityPageAdministratorGuard } from './community-page-administrator.guard'; +import { + COMMUNITY_CREATE_PATH, + COMMUNITY_EDIT_PATH, +} from './community-page-routing-paths'; + +import { CommunityPageResolver } from './community-page.resolver'; +import { CreateCommunityPageComponent } from './create-community-page/create-community-page.component'; +import { CreateCommunityPageGuard } from './create-community-page/create-community-page.guard'; +import { DeleteCommunityPageComponent } from './delete-community-page/delete-community-page.component'; +import { ThemedCommunityPageComponent } from './themed-community-page.component'; @NgModule({ imports: [ @@ -29,7 +34,12 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; resolve: { dso: CommunityPageResolver, breadcrumb: CommunityBreadcrumbResolver, - menu: DSOEditMenuResolver + // menu: DSOEditMenuResolver, + menu: resolveRouteMenus( + StatisticsMenuProvider, + DSpaceObjectEditMenuProvider, + SubscribeMenuProvider, + ), }, runGuardsAndResolvers: 'always', children: [ @@ -51,21 +61,6 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; pathMatch: 'full', } ], - data: { - menu: { - public: [{ - id: 'statistics_community_:id', - active: true, - visible: true, - index: 2, - model: { - type: MenuItemType.LINK, - text: 'menu.section.statistics', - link: 'statistics/communities/:id/', - } as LinkMenuItemModel, - }], - }, - }, }, ]) ], diff --git a/src/app/home-page/home-page-routing.module.ts b/src/app/home-page/home-page-routing.module.ts index 196a290552..92aa86b3da 100644 --- a/src/app/home-page/home-page-routing.module.ts +++ b/src/app/home-page/home-page-routing.module.ts @@ -1,5 +1,8 @@ import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; +import { MenuProviderService } from '../shared/menu/menu-provider.service'; +import { resolveRouteMenus } from '../shared/menu/menu.resolver'; +import { StatisticsMenuProvider } from '../shared/menu/providers/statistics.menu'; import { HomePageResolver } from './home-page.resolver'; import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model'; @@ -15,22 +18,10 @@ import { MenuItemType } from '../shared/menu/menu-item-type.model'; pathMatch: 'full', data: { title: 'home.title', - menu: { - public: [{ - id: 'statistics_site', - active: true, - visible: true, - index: 2, - model: { - type: MenuItemType.LINK, - text: 'menu.section.statistics', - link: 'statistics', - } as LinkMenuItemModel, - }], - }, }, resolve: { - site: HomePageResolver + site: HomePageResolver, + menu: resolveRouteMenus(StatisticsMenuProvider), // todo: sometimes this doesn't show up! } } ]) diff --git a/src/app/item-page/item-page-routing.module.ts b/src/app/item-page/item-page-routing.module.ts index 0c855ab34d..c5ac00835d 100644 --- a/src/app/item-page/item-page-routing.module.ts +++ b/src/app/item-page/item-page-routing.module.ts @@ -1,24 +1,31 @@ import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; -import { ItemPageResolver } from './item-page.resolver'; -import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; -import { ItemBreadcrumbResolver } from '../core/breadcrumbs/item-breadcrumb.resolver'; -import { VersionResolver } from './version-page/version.resolver'; -import { DSOBreadcrumbsService } from '../core/breadcrumbs/dso-breadcrumbs.service'; -import { LinkService } from '../core/cache/builders/link.service'; -import { UploadBitstreamComponent } from './bitstreams/upload/upload-bitstream.component'; -import { ITEM_EDIT_PATH, ORCID_PATH, UPLOAD_BITSTREAM_PATH } from './item-page-routing-paths'; -import { ItemPageAdministratorGuard } from './item-page-administrator.guard'; -import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model'; -import { ThemedItemPageComponent } from './simple/themed-item-page.component'; -import { ThemedFullItemPageComponent } from './full/themed-full-item-page.component'; -import { MenuItemType } from '../shared/menu/menu-item-type.model'; -import { VersionPageComponent } from './version-page/version-page/version-page.component'; -import { BitstreamRequestACopyPageComponent } from './bitstreams/request-a-copy/bitstream-request-a-copy-page.component'; import { REQUEST_COPY_MODULE_PATH } from '../app-routing-paths'; +import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; +import { DSOBreadcrumbsService } from '../core/breadcrumbs/dso-breadcrumbs.service'; +import { ItemBreadcrumbResolver } from '../core/breadcrumbs/item-breadcrumb.resolver'; +import { LinkService } from '../core/cache/builders/link.service'; +import { resolveRouteMenus } from '../shared/menu/menu.resolver'; +import { DSpaceObjectEditMenuProvider } from '../shared/menu/providers/dso-edit.menu'; +import { ClaimMenuProvider } from '../shared/menu/providers/item-claim.menu'; +import { OrcidMenuProvider } from '../shared/menu/providers/item-orcid.menu'; +import { VersioningMenuProvider } from '../shared/menu/providers/item-versioning.menu'; +import { StatisticsMenuProvider } from '../shared/menu/providers/statistics.menu'; +import { BitstreamRequestACopyPageComponent } from './bitstreams/request-a-copy/bitstream-request-a-copy-page.component'; +import { UploadBitstreamComponent } from './bitstreams/upload/upload-bitstream.component'; +import { ThemedFullItemPageComponent } from './full/themed-full-item-page.component'; +import { ItemPageAdministratorGuard } from './item-page-administrator.guard'; +import { + ITEM_EDIT_PATH, + ORCID_PATH, + UPLOAD_BITSTREAM_PATH, +} from './item-page-routing-paths'; +import { ItemPageResolver } from './item-page.resolver'; import { OrcidPageComponent } from './orcid-page/orcid-page.component'; import { OrcidPageGuard } from './orcid-page/orcid-page.guard'; -import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; +import { ThemedItemPageComponent } from './simple/themed-item-page.component'; +import { VersionPageComponent } from './version-page/version-page/version-page.component'; +import { VersionResolver } from './version-page/version.resolver'; @NgModule({ imports: [ @@ -28,7 +35,13 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; resolve: { dso: ItemPageResolver, breadcrumb: ItemBreadcrumbResolver, - menu: DSOEditMenuResolver + menu: resolveRouteMenus( + StatisticsMenuProvider, + OrcidMenuProvider, + DSpaceObjectEditMenuProvider, + ClaimMenuProvider, + VersioningMenuProvider, + ), }, runGuardsAndResolvers: 'always', children: [ @@ -61,21 +74,6 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver'; canActivate: [AuthenticatedGuard, OrcidPageGuard] } ], - data: { - menu: { - public: [{ - id: 'statistics_item_:id', - active: true, - visible: true, - index: 2, - model: { - type: MenuItemType.LINK, - text: 'menu.section.statistics', - link: 'statistics/items/:id/', - } as LinkMenuItemModel, - }], - }, - }, }, { path: 'version', diff --git a/src/app/item-page/item-page.resolver.ts b/src/app/item-page/item-page.resolver.ts index e9b287406e..0db76b33a9 100644 --- a/src/app/item-page/item-page.resolver.ts +++ b/src/app/item-page/item-page.resolver.ts @@ -14,7 +14,9 @@ import { ItemResolver } from './item.resolver'; * This class represents a resolver that requests a specific item before the route is activated and will redirect to the * entity page */ -@Injectable() +@Injectable({ + providedIn: 'root', +}) export class ItemPageResolver extends ItemResolver { constructor( protected itemService: ItemDataService, diff --git a/src/app/navbar/expandable-navbar-section/expandable-navbar-section.component.ts b/src/app/navbar/expandable-navbar-section/expandable-navbar-section.component.ts index 5bc69bcbb4..6f05eb0e54 100644 --- a/src/app/navbar/expandable-navbar-section/expandable-navbar-section.component.ts +++ b/src/app/navbar/expandable-navbar-section/expandable-navbar-section.component.ts @@ -1,4 +1,5 @@ import { Component, Inject, Injector, OnInit } from '@angular/core'; +import { MenuSection } from '../../shared/menu/menu-section.model'; import { NavbarSectionComponent } from '../navbar-section/navbar-section.component'; import { MenuService } from '../../shared/menu/menu.service'; import { slide } from '../../shared/animations/slide'; @@ -23,12 +24,13 @@ export class ExpandableNavbarSectionComponent extends NavbarSectionComponent imp */ menuID = MenuID.PUBLIC; - constructor(@Inject('sectionDataProvider') menuSection, - protected menuService: MenuService, - protected injector: Injector, - private windowService: HostWindowService + constructor( + @Inject('sectionDataProvider') protected section: MenuSection, + protected menuService: MenuService, + protected injector: Injector, + private windowService: HostWindowService, ) { - super(menuSection, menuService, injector); + super(section, menuService, injector); } ngOnInit() { diff --git a/src/app/navbar/navbar-section/navbar-section.component.ts b/src/app/navbar/navbar-section/navbar-section.component.ts index 9f75a96f6e..db0c01e870 100644 --- a/src/app/navbar/navbar-section/navbar-section.component.ts +++ b/src/app/navbar/navbar-section/navbar-section.component.ts @@ -1,5 +1,6 @@ import { Component, Inject, Injector, OnInit } from '@angular/core'; -import { MenuSectionComponent } from '../../shared/menu/menu-section/menu-section.component'; +import { MenuSection } from '../../shared/menu/menu-section.model'; +import { AbstractMenuSectionComponent } from '../../shared/menu/menu-section/abstract-menu-section.component'; import { MenuService } from '../../shared/menu/menu.service'; import { rendersSectionForMenu } from '../../shared/menu/menu-section.decorator'; import { MenuID } from '../../shared/menu/menu-id.model'; @@ -14,17 +15,18 @@ import { MenuID } from '../../shared/menu/menu-id.model'; styleUrls: ['./navbar-section.component.scss'] }) @rendersSectionForMenu(MenuID.PUBLIC, false) -export class NavbarSectionComponent extends MenuSectionComponent implements OnInit { +export class NavbarSectionComponent extends AbstractMenuSectionComponent implements OnInit { /** * This section resides in the Public Navbar */ menuID = MenuID.PUBLIC; - constructor(@Inject('sectionDataProvider') menuSection, - protected menuService: MenuService, - protected injector: Injector + constructor( + @Inject('sectionDataProvider') protected section: MenuSection, + protected menuService: MenuService, + protected injector: Injector, ) { - super(menuSection, menuService, injector); + super(menuService, injector); } ngOnInit() { diff --git a/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.scss b/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.scss index b37f1be746..0b222da867 100644 --- a/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.scss +++ b/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.scss @@ -3,9 +3,21 @@ } .dso-button-menu { + // todo: random thought to make dso page dropdown buttons clear .dropdown-toggle::after { - display: none; + content: ''; + width: 0; + height: 0; + border-style: solid; + border-width: 12px 12px 0 0; + border-color: transparent #627a91 transparent transparent; + border-bottom-right-radius: var(--bs-btn-border-radius-sm); + right: 0; + bottom: 0; + position: absolute; + overflow: hidden; } + overflow: hidden; } ul.dropdown-menu { diff --git a/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.ts b/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.ts index 8e4a7008af..183c072c7a 100644 --- a/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.ts +++ b/src/app/shared/dso-page/dso-edit-menu/dso-edit-expandable-menu-section/dso-edit-menu-expandable-section.component.ts @@ -1,6 +1,6 @@ import { Component, Inject, Injector } from '@angular/core'; import { rendersSectionForMenu } from 'src/app/shared/menu/menu-section.decorator'; -import { MenuSectionComponent } from 'src/app/shared/menu/menu-section/menu-section.component'; +import { AbstractMenuSectionComponent } from 'src/app/shared/menu/menu-section/abstract-menu-section.component'; import { MenuService } from '../../../menu/menu.service'; import { Router } from '@angular/router'; import { MenuID } from 'src/app/shared/menu/menu-id.model'; @@ -19,7 +19,7 @@ import { hasValue } from '../../../empty.util'; styleUrls: ['./dso-edit-menu-expandable-section.component.scss'], }) @rendersSectionForMenu(MenuID.DSO_EDIT, true) -export class DsoEditMenuExpandableSectionComponent extends MenuSectionComponent { +export class DsoEditMenuExpandableSectionComponent extends AbstractMenuSectionComponent { menuID: MenuID = MenuID.DSO_EDIT; itemModel; @@ -27,13 +27,13 @@ export class DsoEditMenuExpandableSectionComponent extends MenuSectionComponent renderIcons$: Observable; constructor( - @Inject('sectionDataProvider') menuSection: MenuSection, + @Inject('sectionDataProvider') protected section: MenuSection, protected menuService: MenuService, protected injector: Injector, protected router: Router, ) { - super(menuSection, menuService, injector); - this.itemModel = menuSection.model; + super(menuService, injector); + this.itemModel = section.model; } ngOnInit(): void { diff --git a/src/app/shared/dso-page/dso-edit-menu/dso-edit-menu-section/dso-edit-menu-section.component.ts b/src/app/shared/dso-page/dso-edit-menu/dso-edit-menu-section/dso-edit-menu-section.component.ts index af3381ef71..824894de01 100644 --- a/src/app/shared/dso-page/dso-edit-menu/dso-edit-menu-section/dso-edit-menu-section.component.ts +++ b/src/app/shared/dso-page/dso-edit-menu/dso-edit-menu-section/dso-edit-menu-section.component.ts @@ -1,6 +1,6 @@ import { Component, Inject, Injector, OnInit } from '@angular/core'; import { rendersSectionForMenu } from 'src/app/shared/menu/menu-section.decorator'; -import { MenuSectionComponent } from 'src/app/shared/menu/menu-section/menu-section.component'; +import { AbstractMenuSectionComponent } from 'src/app/shared/menu/menu-section/abstract-menu-section.component'; import { MenuService } from '../../../menu/menu.service'; import { isNotEmpty } from '../../../empty.util'; import { MenuID } from '../../../menu/menu-id.model'; @@ -16,7 +16,7 @@ import { MenuSection } from '../../../menu/menu-section.model'; styleUrls: ['./dso-edit-menu-section.component.scss'] }) @rendersSectionForMenu(MenuID.DSO_EDIT, false) -export class DsoEditMenuSectionComponent extends MenuSectionComponent implements OnInit { +export class DsoEditMenuSectionComponent extends AbstractMenuSectionComponent implements OnInit { menuID: MenuID = MenuID.DSO_EDIT; itemModel; @@ -24,12 +24,12 @@ export class DsoEditMenuSectionComponent extends MenuSectionComponent implements canActivate: boolean; constructor( - @Inject('sectionDataProvider') menuSection: MenuSection, + @Inject('sectionDataProvider') protected section: MenuSection, protected menuService: MenuService, protected injector: Injector, ) { - super(menuSection, menuService, injector); - this.itemModel = menuSection.model; + super(menuService, injector); + this.itemModel = section.model; } ngOnInit(): void { diff --git a/src/app/shared/menu/menu-item/models/altmetric.model.ts b/src/app/shared/menu/menu-item/models/altmetric.model.ts index e27004c268..91748ee3aa 100644 --- a/src/app/shared/menu/menu-item/models/altmetric.model.ts +++ b/src/app/shared/menu/menu-item/models/altmetric.model.ts @@ -6,6 +6,6 @@ import { MenuItemType } from '../../menu-item-type.model'; */ export class AltmetricMenuItemModel implements MenuItemModel { type = MenuItemType.ALTMETRIC; - disabled: boolean; + disabled?: boolean; url: string; } diff --git a/src/app/shared/menu/menu-item/models/external-link.model.ts b/src/app/shared/menu/menu-item/models/external-link.model.ts index d835691107..949f69f1b1 100644 --- a/src/app/shared/menu/menu-item/models/external-link.model.ts +++ b/src/app/shared/menu/menu-item/models/external-link.model.ts @@ -6,7 +6,7 @@ import { MenuItemType } from '../../menu-item-type.model'; */ export class ExternalLinkMenuItemModel implements MenuItemModel { type = MenuItemType.EXTERNAL; - disabled: boolean; + disabled?: boolean; text: string; href: string; } diff --git a/src/app/shared/menu/menu-item/models/link.model.ts b/src/app/shared/menu/menu-item/models/link.model.ts index f26340749c..ddbb6d3ab5 100644 --- a/src/app/shared/menu/menu-item/models/link.model.ts +++ b/src/app/shared/menu/menu-item/models/link.model.ts @@ -7,7 +7,7 @@ import { Params } from '@angular/router'; */ export class LinkMenuItemModel implements MenuItemModel { type = MenuItemType.LINK; - disabled: boolean; + disabled?: boolean; text: string; link: string; queryParams?: Params | null; diff --git a/src/app/shared/menu/menu-item/models/menu-item.model.ts b/src/app/shared/menu/menu-item/models/menu-item.model.ts index ddca3d222d..3bfc632df4 100644 --- a/src/app/shared/menu/menu-item/models/menu-item.model.ts +++ b/src/app/shared/menu/menu-item/models/menu-item.model.ts @@ -5,5 +5,5 @@ import { MenuItemType } from '../../menu-item-type.model'; */ export interface MenuItemModel { type: MenuItemType; - disabled: boolean; + disabled?: boolean; } diff --git a/src/app/shared/menu/menu-item/models/onclick.model.ts b/src/app/shared/menu/menu-item/models/onclick.model.ts index 32139001d0..58e6826096 100644 --- a/src/app/shared/menu/menu-item/models/onclick.model.ts +++ b/src/app/shared/menu/menu-item/models/onclick.model.ts @@ -6,7 +6,7 @@ import { MenuItemType } from '../../menu-item-type.model'; */ export class OnClickMenuItemModel implements MenuItemModel { type = MenuItemType.ONCLICK; - disabled: boolean; + disabled?: boolean; text: string; - function: () => {}; + function: () => void; } diff --git a/src/app/shared/menu/menu-item/models/search.model.ts b/src/app/shared/menu/menu-item/models/search.model.ts index 1c2b5a6456..ce08afd744 100644 --- a/src/app/shared/menu/menu-item/models/search.model.ts +++ b/src/app/shared/menu/menu-item/models/search.model.ts @@ -1,12 +1,12 @@ -import { MenuItemModel } from './menu-item.model'; import { MenuItemType } from '../../menu-item-type.model'; +import { MenuItemModel } from './menu-item.model'; /** * Model representing an Search Bar Menu Section */ export class SearchMenuItemModel implements MenuItemModel { type = MenuItemType.SEARCH; - disabled: boolean; + disabled?: boolean; placeholder: string; action: string; } diff --git a/src/app/shared/menu/menu-item/models/text.model.ts b/src/app/shared/menu/menu-item/models/text.model.ts index 4fe8a41cc9..00e0ad9577 100644 --- a/src/app/shared/menu/menu-item/models/text.model.ts +++ b/src/app/shared/menu/menu-item/models/text.model.ts @@ -6,6 +6,6 @@ import { MenuItemType } from '../../menu-item-type.model'; */ export class TextMenuItemModel implements MenuItemModel { type = MenuItemType.TEXT; - disabled: boolean; + disabled?: boolean; text: string; } diff --git a/src/app/shared/menu/menu-provider.service.ts b/src/app/shared/menu/menu-provider.service.ts new file mode 100644 index 0000000000..c3d36487d3 --- /dev/null +++ b/src/app/shared/menu/menu-provider.service.ts @@ -0,0 +1,126 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { + Inject, + Injectable, + Injector, + Optional, + Type, +} from '@angular/core'; +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { + combineLatest, + forkJoin, + map, + Observable, +} from 'rxjs'; +import { + find, + switchMap, + take, + tap, +} from 'rxjs/operators'; +import { v4 as uuidv4 } from 'uuid'; +import { hasValue } from '../empty.util'; +import { MenuID } from './menu-id.model'; +import { AbstractMenuProvider } from './menu-provider'; +import { MenuSection } from './menu-section.model'; +import { MenuState } from './menu-state.model'; +import { MenuService } from './menu.service'; +import { MENU_PROVIDER } from './menu.structure'; + +@Injectable({ + providedIn: 'root', +}) +export class MenuProviderService { + constructor( + @Inject(MENU_PROVIDER) @Optional() protected providers: ReadonlyArray, + protected menuService: MenuService, + protected injector: Injector, + ) { + } + + /** + * Wait for a specific menu to appear + * @param id the ID of the menu to wait for + * @return an Observable that emits true as soon as the menu is created + */ + protected waitForMenu$(id: MenuID): Observable { + return this.menuService.getMenu(id).pipe( + find((menu: MenuState) => hasValue(menu)), + map(() => true), + ); + } + + public resolveStaticMenu( + route: ActivatedRouteSnapshot, + state: RouterStateSnapshot, + ): Observable { + return combineLatest( + this.providers + .filter(p => p.allRoutes) + .map(provider => provider.getSections(route, state).pipe( + tap((sections) => { + sections.forEach((section: MenuSection) => { + this.menuService.addSection(provider.menuID, { + ...section, + id: section.id ?? uuidv4(), + index: section.index ?? provider.index, + shouldPersistOnRouteChange: true, + }); + }); + }), + switchMap(() => this.waitForMenu$(provider.menuID)), + )), + ).pipe( + map(done => done.every(Boolean)), + ); + } + + public resolveRouteMenu( + route: ActivatedRouteSnapshot, + state: RouterStateSnapshot, + ...providerTypes: Type[] + ): Observable { + // todo: no why please no + return forkJoin( + providerTypes.map(pt => this.injector.get(pt)) + .map((provider: AbstractMenuProvider) => provider.getSections(route, state).pipe( + map(sections => [ + provider.menuID, + sections.map((section: MenuSection) => { + return { + ...section, + id: section.id ?? uuidv4(), + index: section.index ?? provider.index, + shouldPersistOnRouteChange: false, + }; + }), + ]), + take(1), + )), + ).pipe( + map((entries) => { + return entries.reduce((all, entry) => { + const menuID = entry[0] as unknown as MenuID; + const sections = entry[1] as unknown as MenuSection[]; + + if (all[menuID] === undefined) { + all[menuID] = []; + } + all[menuID].push(...sections); + return all; + }, {}); + }), + ); + } +} diff --git a/src/app/shared/menu/menu-provider.ts b/src/app/shared/menu/menu-provider.ts new file mode 100644 index 0000000000..0d11e6a1c9 --- /dev/null +++ b/src/app/shared/menu/menu-provider.ts @@ -0,0 +1,47 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { Omit } from '@material-ui/core'; +import flatten from 'lodash/flatten'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { MenuID } from './menu-id.model'; +import { MenuSection } from './menu-section.model'; + +export type PartialMenuSection = Omit; + +export interface MenuProvider { + allRoutes?: boolean, + menuID?: MenuID; + index?: number; + + getSections(route?: ActivatedRouteSnapshot, state?: RouterStateSnapshot): Observable; +} + +export abstract class AbstractMenuProvider implements MenuProvider { + public allRoutes = true; + menuID?: MenuID; + index?: number; + + abstract getSections(route?: ActivatedRouteSnapshot, state?: RouterStateSnapshot): Observable; + + protected concat(...sections$: Observable[]): Observable { + return combineLatest(sections$).pipe( + map(sections => flatten(sections)), + ); + } +} + + diff --git a/src/app/shared/menu/menu-section.model.ts b/src/app/shared/menu/menu-section.model.ts index f14b029d77..e1bf1a7416 100644 --- a/src/app/shared/menu/menu-section.model.ts +++ b/src/app/shared/menu/menu-section.model.ts @@ -1,15 +1,82 @@ -import { MenuItemModel } from './menu-item/models/menu-item.model'; +import { MenuItemType } from './menu-item-type.model'; +import { AltmetricMenuItemModel } from './menu-item/models/altmetric.model'; +import { ExternalLinkMenuItemModel } from './menu-item/models/external-link.model'; +import { LinkMenuItemModel } from './menu-item/models/link.model'; +import { OnClickMenuItemModel } from './menu-item/models/onclick.model'; +import { SearchMenuItemModel } from './menu-item/models/search.model'; +import { TextMenuItemModel } from './menu-item/models/text.model'; -/** - * Represents the state of a single menu section in the store - */ -export class MenuSection { - id: string; - parentID?: string; - visible: boolean; - active: boolean; - model: MenuItemModel; - index?: number; - icon?: string; - shouldPersistOnRouteChange? = false; +export type MenuItemModels = + LinkMenuItemModel + | AltmetricMenuItemModel + | ExternalLinkMenuItemModel + | OnClickMenuItemModel + | SearchMenuItemModel + | TextMenuItemModel; + +function itemModelFactory(type: MenuItemType): MenuItemModels { + switch (type) { + case MenuItemType.TEXT: + return new TextMenuItemModel(); + case MenuItemType.LINK: + return new LinkMenuItemModel(); + case MenuItemType.ALTMETRIC: + return new AltmetricMenuItemModel(); + case MenuItemType.SEARCH: + return new SearchMenuItemModel(); + case MenuItemType.ONCLICK: + return new OnClickMenuItemModel(); + case MenuItemType.EXTERNAL: + return new ExternalLinkMenuItemModel(); + default: { + throw new Error(`No such menu item type: ${type}`); + } + } +} + +export interface MenuSection { + /** + * The identifier for this section + */ + id: string; + + /** + * Whether this section should be visible. + */ + visible: boolean; + + /** + * + */ + model: MenuItemModels; + + /** + * The identifier of this section's parent section (optional). + */ + parentID?: string; + + /** + * The index of this section in its menu. + */ + index?: number; + + /** + * Whether this section is currently active. + * Newly created sections are inactive until toggled. + */ + active?: boolean; + + /** + * Whether this section is independent of the route (default: true). + * This value should be set explicitly for route-dependent sections. + */ + shouldPersistOnRouteChange?: boolean; + + + /** + * An optional icon for this section. + * Must correspond to a FontAwesome icon class save for the `.fa-` prefix. + * Note that not all menus may render icons. + */ + icon?: string; } diff --git a/src/app/shared/menu/menu-section/menu-section.component.ts b/src/app/shared/menu/menu-section/abstract-menu-section.component.ts similarity index 89% rename from src/app/shared/menu/menu-section/menu-section.component.ts rename to src/app/shared/menu/menu-section/abstract-menu-section.component.ts index 9b5bd499e1..bf72e0c53f 100644 --- a/src/app/shared/menu/menu-section/menu-section.component.ts +++ b/src/app/shared/menu/menu-section/abstract-menu-section.component.ts @@ -1,14 +1,29 @@ -import { Component, Injector, OnDestroy, OnInit } from '@angular/core'; -import { MenuService } from '../menu.service'; -import { getComponentForMenuItemType } from '../menu-item.decorator'; -import { hasNoValue, hasValue } from '../../empty.util'; -import { BehaviorSubject, Observable, Subscription } from 'rxjs'; -import { MenuItemModel } from '../menu-item/models/menu-item.model'; -import { distinctUntilChanged, switchMap } from 'rxjs/operators'; +import { + Component, + Injector, + OnDestroy, + OnInit, +} from '@angular/core'; +import { + BehaviorSubject, + Observable, + Subscription, +} from 'rxjs'; +import { + distinctUntilChanged, + switchMap, +} from 'rxjs/operators'; import { GenericConstructor } from '../../../core/shared/generic-constructor'; -import { MenuSection } from '../menu-section.model'; +import { + hasNoValue, + hasValue, +} from '../../empty.util'; import { MenuID } from '../menu-id.model'; import { MenuItemType } from '../menu-item-type.model'; +import { getComponentForMenuItemType } from '../menu-item.decorator'; +import { MenuItemModel } from '../menu-item/models/menu-item.model'; +import { MenuSection } from '../menu-section.model'; +import { MenuService } from '../menu.service'; /** * A basic implementation of a menu section's component @@ -17,7 +32,8 @@ import { MenuItemType } from '../menu-item-type.model'; selector: 'ds-menu-section', template: '' }) -export class MenuSectionComponent implements OnInit, OnDestroy { +export abstract class AbstractMenuSectionComponent implements OnInit, OnDestroy { + protected abstract section: MenuSection; /** * Observable that emits whether or not this section is currently active @@ -39,7 +55,7 @@ export class MenuSectionComponent implements OnInit, OnDestroy { */ sectionMap$: BehaviorSubject + component: GenericConstructor }>> = new BehaviorSubject(new Map()); /** @@ -48,7 +64,10 @@ export class MenuSectionComponent implements OnInit, OnDestroy { */ subs: Subscription[] = []; - constructor(public section: MenuSection, protected menuService: MenuService, protected injector: Injector) { + protected constructor( + protected menuService: MenuService, + protected injector: Injector, + ) { } /** diff --git a/src/app/shared/menu/menu-section/menu-section.component.spec.ts b/src/app/shared/menu/menu-section/menu-section.component.spec.ts index f40f45f9b4..8949c6c1b0 100644 --- a/src/app/shared/menu/menu-section/menu-section.component.spec.ts +++ b/src/app/shared/menu/menu-section/menu-section.component.spec.ts @@ -1,17 +1,38 @@ import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing'; import { NoopAnimationsModule } from '@angular/platform-browser/animations'; +import { Router } from '@angular/router'; import { TranslateModule } from '@ngx-translate/core'; -import { ChangeDetectionStrategy, Injector, NO_ERRORS_SCHEMA } from '@angular/core'; -import { MenuSectionComponent } from './menu-section.component'; +import { + ChangeDetectionStrategy, + Component, + Inject, + Injector, + NO_ERRORS_SCHEMA, +} from '@angular/core'; +import { AbstractMenuSectionComponent } from './abstract-menu-section.component'; import { MenuService } from '../menu.service'; import { MenuServiceStub } from '../../testing/menu-service.stub'; import { of as observableOf } from 'rxjs'; import { LinkMenuItemComponent } from '../menu-item/link-menu-item.component'; import { MenuSection } from '../menu-section.model'; +@Component({ + selector: 'ds-some-menu-section', + template: '', +}) +class SomeMenuSectionComponent extends AbstractMenuSectionComponent { + constructor( + @Inject('sectionDataProvider') protected section: MenuSection, + protected menuService: MenuService, + protected injector: Injector, + ) { + super(menuService, injector); + } +} + describe('MenuSectionComponent', () => { - let comp: MenuSectionComponent; - let fixture: ComponentFixture; + let comp: AbstractMenuSectionComponent; + let fixture: ComponentFixture; let menuService: MenuService; let dummySection; @@ -23,20 +44,20 @@ describe('MenuSectionComponent', () => { } as any; TestBed.configureTestingModule({ imports: [TranslateModule.forRoot(), NoopAnimationsModule], - declarations: [MenuSectionComponent], + declarations: [AbstractMenuSectionComponent], providers: [ { provide: Injector, useValue: {} }, { provide: MenuService, useClass: MenuServiceStub }, - { provide: MenuSection, useValue: dummySection }, + { provide: 'sectionDataProvider', useValue: dummySection }, ], schemas: [NO_ERRORS_SCHEMA] - }).overrideComponent(MenuSectionComponent, { + }).overrideComponent(SomeMenuSectionComponent, { set: { changeDetection: ChangeDetectionStrategy.Default } }).compileComponents(); })); beforeEach(() => { - fixture = TestBed.createComponent(MenuSectionComponent); + fixture = TestBed.createComponent(SomeMenuSectionComponent); comp = fixture.componentInstance; menuService = (comp as any).menuService; spyOn(comp as any, 'getMenuItemComponent').and.returnValue(LinkMenuItemComponent); diff --git a/src/app/shared/menu/menu-state.model.ts b/src/app/shared/menu/menu-state.model.ts index 0bedac2129..805531aa07 100644 --- a/src/app/shared/menu/menu-state.model.ts +++ b/src/app/shared/menu/menu-state.model.ts @@ -1,4 +1,4 @@ -import { MenuSectionIndex } from './menu-section-Index.model'; +import { MenuSectionIndex } from './menu-section-index.model'; import { MenuSections } from './menu-sections.model'; import { MenuID } from './menu-id.model'; diff --git a/src/app/shared/menu/menu.component.ts b/src/app/shared/menu/menu.component.ts index 35e180b476..8d9e9da246 100644 --- a/src/app/shared/menu/menu.component.ts +++ b/src/app/shared/menu/menu.component.ts @@ -4,7 +4,7 @@ import { MenuService } from './menu.service'; import { distinctUntilChanged, map, mergeMap, switchMap } from 'rxjs/operators'; import { GenericConstructor } from '../../core/shared/generic-constructor'; import { hasValue, isNotEmptyOperator } from '../empty.util'; -import { MenuSectionComponent } from './menu-section/menu-section.component'; +import { AbstractMenuSectionComponent } from './menu-section/abstract-menu-section.component'; import { getComponentForMenu } from './menu-section.decorator'; import { compareArraysUsingIds } from '../../item-page/simple/item-types/shared/item-relationships-utils'; import { MenuSection } from './menu-section.model'; @@ -52,7 +52,7 @@ export class MenuComponent implements OnInit, OnDestroy { */ sectionMap$: BehaviorSubject + component: GenericConstructor }>> = new BehaviorSubject(new Map()); /** @@ -101,7 +101,7 @@ export class MenuComponent implements OnInit, OnDestroy { }), isNotEmptyOperator(), switchMap((section: MenuSection) => this.getSectionComponent(section).pipe( - map((component: GenericConstructor) => ({ section, component })) + map((component: GenericConstructor) => ({ section, component })) )), distinctUntilChanged((x, y) => x.section.id === y.section.id) ).subscribe(({ section, component }) => { @@ -213,9 +213,9 @@ export class MenuComponent implements OnInit, OnDestroy { /** * Retrieve the component for a given MenuSection object * @param {MenuSection} section The given MenuSection - * @returns {Observable>} Emits the constructor of the Component that should be used to render this object + * @returns {Observable>} Emits the constructor of the Component that should be used to render this object */ - private getSectionComponent(section: MenuSection): Observable> { + private getSectionComponent(section: MenuSection): Observable> { return this.menuService.hasSubSections(this.menuID, section.id).pipe( map((expandable: boolean) => { return getComponentForMenu(this.menuID, expandable, this.themeService.getThemeName()); diff --git a/src/app/shared/menu/menu.module.ts b/src/app/shared/menu/menu.module.ts index 28bdab9987..ef53768b68 100644 --- a/src/app/shared/menu/menu.module.ts +++ b/src/app/shared/menu/menu.module.ts @@ -1,16 +1,14 @@ -import { MenuSectionComponent } from './menu-section/menu-section.component'; -import { MenuComponent } from './menu.component'; -import { NgModule } from '@angular/core'; -import { TranslateModule } from '@ngx-translate/core'; -import { RouterModule } from '@angular/router'; -import { LinkMenuItemComponent } from './menu-item/link-menu-item.component'; -import { TextMenuItemComponent } from './menu-item/text-menu-item.component'; -import { OnClickMenuItemComponent } from './menu-item/onclick-menu-item.component'; import { CommonModule } from '@angular/common'; +import { NgModule } from '@angular/core'; +import { RouterModule } from '@angular/router'; +import { TranslateModule } from '@ngx-translate/core'; import { ExternalLinkMenuItemComponent } from './menu-item/external-link-menu-item.component'; +import { LinkMenuItemComponent } from './menu-item/link-menu-item.component'; +import { OnClickMenuItemComponent } from './menu-item/onclick-menu-item.component'; +import { TextMenuItemComponent } from './menu-item/text-menu-item.component'; +import { MenuComponent } from './menu.component'; const COMPONENTS = [ - MenuSectionComponent, MenuComponent, ]; diff --git a/src/app/shared/menu/menu.reducer.spec.ts b/src/app/shared/menu/menu.reducer.spec.ts index 2865e887fc..2f4bb6a1b6 100644 --- a/src/app/shared/menu/menu.reducer.spec.ts +++ b/src/app/shared/menu/menu.reducer.spec.ts @@ -18,7 +18,7 @@ import { } from './menu.actions'; import { menusReducer } from './menu.reducer'; import { initialMenusState} from './initial-menus-state'; -import { MenuSectionIndex } from './menu-section-Index.model'; +import { MenuSectionIndex } from './menu-section-index.model'; import { MenuID } from './menu-id.model'; let visibleSection1; diff --git a/src/app/shared/menu/menu.reducer.ts b/src/app/shared/menu/menu.reducer.ts index c7ea017cc2..451127be62 100644 --- a/src/app/shared/menu/menu.reducer.ts +++ b/src/app/shared/menu/menu.reducer.ts @@ -14,7 +14,7 @@ import { initialMenusState} from './initial-menus-state'; import { hasValue } from '../empty.util'; import { MenusState } from './menus-state.model'; import { MenuState } from './menu-state.model'; -import { MenuSectionIndex } from './menu-section-Index.model'; +import { MenuSectionIndex } from './menu-section-index.model'; import { MenuSections } from './menu-sections.model'; import { MenuSection } from './menu-section.model'; import { MenuID } from './menu-id.model'; diff --git a/src/app/shared/menu/menu.resolver.ts b/src/app/shared/menu/menu.resolver.ts new file mode 100644 index 0000000000..cc17d7c9aa --- /dev/null +++ b/src/app/shared/menu/menu.resolver.ts @@ -0,0 +1,35 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + inject, + Type, +} from '@angular/core'; +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { Observable } from 'rxjs'; +import { AbstractMenuProvider } from './menu-provider'; +import { MenuProviderService } from './menu-provider.service'; + +export function resolveStaticMenus(): (ActivatedRouteSnapshot, RouterStateSnapshot, ProviderMenuService) => Observable { + return ( + route: ActivatedRouteSnapshot, + state: RouterStateSnapshot, + menuProviderService: MenuProviderService = inject(MenuProviderService), + ) => menuProviderService.resolveStaticMenu(route, state); +} + +export function resolveRouteMenus(...providerTypes: Type[]): (ActivatedRouteSnapshot, RouterStateSnapshot, ProviderMenuService) => Observable { + // todo: runtime error if undeclared should be compile time ideally + return ( + route: ActivatedRouteSnapshot, + state: RouterStateSnapshot, + menuProviderService: MenuProviderService = inject(MenuProviderService), + ) => menuProviderService.resolveRouteMenu(route, state, ...providerTypes); +} diff --git a/src/app/shared/menu/menu.structure.ts b/src/app/shared/menu/menu.structure.ts new file mode 100644 index 0000000000..f10fa6c3f3 --- /dev/null +++ b/src/app/shared/menu/menu.structure.ts @@ -0,0 +1,46 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + InjectionToken, + Provider, + Type, +} from '@angular/core'; +import { MenuID } from './menu-id.model'; +import { AbstractMenuProvider } from './menu-provider'; +import { MenuProviderService } from './menu-provider.service'; + +export const MENU_PROVIDER = new InjectionToken('MENU_PROVIDER'); + +type MenuStructure = { + [key in MenuID]: Type[]; +}; + +export function buildMenuStructure(structure: MenuStructure): Provider[] { + const providers: Provider[] = [ + MenuProviderService, + ]; + + Object.entries(structure).forEach(([menuID, providerTypes]) => { + for (const [index, providerType] of providerTypes.entries()) { + // todo: should complain if not injectable! + providers.push(providerType); + providers.push({ + provide: MENU_PROVIDER, + multi: true, + useFactory(provider: AbstractMenuProvider): AbstractMenuProvider { + provider.menuID = menuID as MenuID; + provider.index = provider.index ?? index; + return provider; + }, + deps: [providerType], + }); + } + }); + + return providers; +} diff --git a/src/app/shared/menu/providers/access-control.menu.ts b/src/app/shared/menu/providers/access-control.menu.ts new file mode 100644 index 0000000000..311fc49777 --- /dev/null +++ b/src/app/shared/menu/providers/access-control.menu.ts @@ -0,0 +1,94 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest as observableCombineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ScriptDataService } from '../../../core/data/processes/script-data.service'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class AccessControlMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected scriptDataService: ScriptDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf({ + model: { + type: MenuItemType.TEXT, + text: 'menu.section.access_control', + }, + icon: 'key' + }); + } + + public getSubSections(): Observable { + return observableCombineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + this.authorizationService.isAuthorized(FeatureID.CanManageGroups), + ]).pipe( + map(([isSiteAdmin, canManageGroups]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.access_control_people', + link: '/access-control/epeople', + }, + }, + { + visible: canManageGroups, + model: { + type: MenuItemType.LINK, + text: 'menu.section.access_control_groups', + link: '/access-control/groups', + }, + }, + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.access_control_bulk', + link: '/access-control/bulk-access', + }, + }, + // TODO: enable this menu item once the feature has been implemented + // { + // id: 'access_control_authorizations', + // parentID: 'access_control', + // active: false, + // visible: authorized, + // model: { + // type: MenuItemType.LINK, + // text: 'menu.section.access_control_authorizations', + // link: '' + // } as LinkMenuItemModel, + // }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/admin-search.menu.ts b/src/app/shared/menu/providers/admin-search.menu.ts new file mode 100644 index 0000000000..9d5e2cdb98 --- /dev/null +++ b/src/app/shared/menu/providers/admin-search.menu.ts @@ -0,0 +1,50 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class AdminSearchMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.admin_search', + link: '/admin/search', + }, + icon: 'search', + }, + ]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/browse.menu.ts b/src/app/shared/menu/providers/browse.menu.ts new file mode 100644 index 0000000000..06a6cf3dbe --- /dev/null +++ b/src/app/shared/menu/providers/browse.menu.ts @@ -0,0 +1,67 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + Observable, + of as observableOf, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { BrowseService } from '../../../core/browse/browse.service'; +import { PaginatedList } from '../../../core/data/paginated-list.model'; +import { RemoteData } from '../../../core/data/remote-data'; +import { BrowseDefinition } from '../../../core/shared/browse-definition.model'; +import { getFirstSucceededRemoteData } from '../../../core/shared/operators'; +import { MenuItemType } from '../menu-item-type.model'; +import { TextMenuItemModel } from '../menu-item/models/text.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class BrowseMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected browseService: BrowseService, + ) { + super(); + } + + getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.browse_global', + } as TextMenuItemModel, + icon: 'globe', + }, + ); + } + + getSubSections(): Observable { + return this.browseService.getBrowseDefinitions().pipe( + getFirstSucceededRemoteData(), + map((rd: RemoteData>) => { + return [ + ...rd.payload.page.map((browseDef) => { + return { + visible: true, + model: { + type: MenuItemType.LINK, + text: `menu.section.browse_global_by_${browseDef.id}`, + link: `/browse/${browseDef.id}`, + }, + }; + }), + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/comcol-subscribe.menu.ts b/src/app/shared/menu/providers/comcol-subscribe.menu.ts new file mode 100644 index 0000000000..e766aa540c --- /dev/null +++ b/src/app/shared/menu/providers/comcol-subscribe.menu.ts @@ -0,0 +1,65 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { Collection } from '../../../core/shared/collection.model'; +import { COLLECTION } from '../../../core/shared/collection.resource-type'; +import { Community } from '../../../core/shared/community.model'; +import { COMMUNITY } from '../../../core/shared/community.resource-type'; +import { SubscriptionModalComponent } from '../../subscriptions/subscription-modal/subscription-modal.component'; +import { MenuItemType } from '../menu-item-type.model'; +import { OnClickMenuItemModel } from '../menu-item/models/onclick.model'; +import { PartialMenuSection } from '../menu-provider'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +@Injectable() +export class SubscribeMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected modalService: NgbModal, + protected dsoDataService: DSpaceObjectDataService, + ) { + super(dsoDataService); + } + + protected isApplicable(dso: Community | Collection): boolean { + // @ts-ignore + return dso.type === COMMUNITY.value || dso.type.value === COLLECTION; + } + + public getSectionsForContext(dso: Community | Collection): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.CanSubscribe, dso.self), + ]).pipe( + map(([canSubscribe]) => { + return [ + { + visible: canSubscribe, + model: { + type: MenuItemType.ONCLICK, + text: 'subscriptions.tooltip', + function: () => { + const modalRef = this.modalService.open(SubscriptionModalComponent); + modalRef.componentInstance.dso = dso; + } + } as OnClickMenuItemModel, + icon: 'bell', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/community-list.menu.ts b/src/app/shared/menu/providers/community-list.menu.ts new file mode 100644 index 0000000000..5637db8ff7 --- /dev/null +++ b/src/app/shared/menu/providers/community-list.menu.ts @@ -0,0 +1,35 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + Observable, + of, +} from 'rxjs'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class CommunityListMenuProvider extends AbstractMenuProvider { + public getSections(): Observable { + return of([ + { + visible: true, + model: { + type: MenuItemType.LINK, + text: `menu.section.browse_global_communities_and_collections`, + link: `/community-list`, + }, + icon: 'diagram-project' + }, + ] as PartialMenuSection[]); + } +} diff --git a/src/app/shared/menu/providers/curation.menu.ts b/src/app/shared/menu/providers/curation.menu.ts new file mode 100644 index 0000000000..16b4501048 --- /dev/null +++ b/src/app/shared/menu/providers/curation.menu.ts @@ -0,0 +1,51 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { LinkMenuItemModel } from '../menu-item/models/link.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class CurationMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.curation_task', + link: 'admin/curation-tasks', + } as LinkMenuItemModel, + icon: 'filter', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/dso-edit.menu.ts b/src/app/shared/menu/providers/dso-edit.menu.ts new file mode 100644 index 0000000000..35eccf7e24 --- /dev/null +++ b/src/app/shared/menu/providers/dso-edit.menu.ts @@ -0,0 +1,53 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { getDSORoute } from '../../../app-routing-paths'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { DSpaceObject } from '../../../core/shared/dspace-object.model'; +import { URLCombiner } from '../../../core/url-combiner/url-combiner'; +import { MenuItemType } from '../menu-item-type.model'; +import { LinkMenuItemModel } from '../menu-item/models/link.model'; +import { PartialMenuSection } from '../menu-provider'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +@Injectable() +export class DSpaceObjectEditMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected authorizationDataService: AuthorizationDataService, + protected dsoDataService: DSpaceObjectDataService, + ) { + super(dsoDataService); + } + + public getSectionsForContext(dso: DSpaceObject): Observable { + return combineLatest([ + this.authorizationDataService.isAuthorized(FeatureID.CanEditMetadata, dso.self), + ]).pipe( + map(([canEditItem]) => { + return [ + { + visible: canEditItem, + model: { + type: MenuItemType.LINK, + text: this.getDsoType(dso) + '.page.edit', + link: new URLCombiner(getDSORoute(dso), 'edit', 'metadata').toString() + } as LinkMenuItemModel, + icon: 'pencil-alt', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/dso.menu.ts b/src/app/shared/menu/providers/dso.menu.ts new file mode 100644 index 0000000000..0545b7cd6f --- /dev/null +++ b/src/app/shared/menu/providers/dso.menu.ts @@ -0,0 +1,56 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { Observable } from 'rxjs'; +import { map } from 'rxjs/operators'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { DSpaceObject } from '../../../core/shared/dspace-object.model'; +import { getFirstCompletedRemoteData } from '../../../core/shared/operators'; +import { AbstractRouteContextMenuProvider } from './route-context.menu'; + +export abstract class DSpaceObjectPageMenuProvider extends AbstractRouteContextMenuProvider { + allRoutes = false; + + protected constructor( + protected dsoDataService: DSpaceObjectDataService, + ) { + super(); + } + + + public getRouteContext(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable { + // todo: would be cool to automatically switch to cached version of specific DSO + // ...but we can't really know which is which because the other resolver may run _after_ + // we could refactor the resolver to a function though; then it's less problematic to just call it here + return this.dsoDataService.findById(route.params.id, true, false).pipe( + getFirstCompletedRemoteData(), + map((dsoRD) => { + if (dsoRD.hasSucceeded) { + return dsoRD.payload as T; + } else { + return undefined; + } + }) + ); + } + + /** + * Retrieve the dso or entity type for an object to be used in generic messages + */ + protected getDsoType(dso: T) { + const renderType = dso.getRenderTypes()[0]; + if (typeof renderType === 'string' || renderType instanceof String) { + return renderType.toLowerCase(); + } else { + return dso.type.toString().toLowerCase(); + } + } +} diff --git a/src/app/shared/menu/providers/edit.menu.ts b/src/app/shared/menu/providers/edit.menu.ts new file mode 100644 index 0000000000..cc003aa259 --- /dev/null +++ b/src/app/shared/menu/providers/edit.menu.ts @@ -0,0 +1,92 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ThemedEditCollectionSelectorComponent } from '../../dso-selector/modal-wrappers/edit-collection-selector/themed-edit-collection-selector.component'; +import { ThemedEditCommunitySelectorComponent } from '../../dso-selector/modal-wrappers/edit-community-selector/themed-edit-community-selector.component'; +import { ThemedEditItemSelectorComponent } from '../../dso-selector/modal-wrappers/edit-item-selector/themed-edit-item-selector.component'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class EditMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.edit', + }, + icon: 'pencil', + }, + ); + } + + public getSubSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.IsCollectionAdmin), + this.authorizationService.isAuthorized(FeatureID.IsCommunityAdmin), + this.authorizationService.isAuthorized(FeatureID.CanEditItem), + ]).pipe( + map(([isCollectionAdmin, isCommunityAdmin, canEditItem]) => { + return [ + { + visible: isCommunityAdmin, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.edit_community', + function: () => { + this.modalService.open(ThemedEditCommunitySelectorComponent); + }, + }, + }, + { + visible: isCollectionAdmin, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.edit_collection', + function: () => { + this.modalService.open(ThemedEditCollectionSelectorComponent); + }, + }, + }, + { + visible: canEditItem, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.edit_item', + function: () => { + this.modalService.open(ThemedEditItemSelectorComponent); + }, + }, + }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/expandable-menu-provider.ts b/src/app/shared/menu/providers/expandable-menu-provider.ts new file mode 100644 index 0000000000..e3a1f9c414 --- /dev/null +++ b/src/app/shared/menu/providers/expandable-menu-provider.ts @@ -0,0 +1,64 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Omit } from '@material-ui/core'; +import { + combineLatest, + Observable, + of as observableOf, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { v4 as uuidv4 } from 'uuid'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +export type MenuTopSection = Omit; +export type MenuSubSection = Omit; + +export abstract class AbstractExpandableMenuProvider extends AbstractMenuProvider { + protected showWithoutSubsections = false; + + abstract getTopSection(): Observable; + + abstract getSubSections(): Observable; + + protected includeSubSections(): boolean { + return true; + } + + getSections(): Observable { + const full = this.includeSubSections(); + const parentID = uuidv4(); + + return combineLatest([ + this.getTopSection(), + full ? this.getSubSections() : observableOf([]), + ]).pipe( + map(( + [partialTopSection, partialSubSections]: [MenuTopSection, MenuSubSection[]] + ) => { + const subSections = partialSubSections.map(partialSub => { + return { + ...partialSub, + parentID: parentID, + }; + }); + + return [ + ...subSections, + { + ...partialTopSection, + id: parentID, + visible: full ? subSections.some(sub => sub.visible) : this.showWithoutSubsections, + }, + ]; + }) + ); + } +} diff --git a/src/app/shared/menu/providers/export.menu.ts b/src/app/shared/menu/providers/export.menu.ts new file mode 100644 index 0000000000..50f6667b38 --- /dev/null +++ b/src/app/shared/menu/providers/export.menu.ts @@ -0,0 +1,88 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest as observableCombineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { + METADATA_EXPORT_SCRIPT_NAME, + ScriptDataService, +} from '../../../core/data/processes/script-data.service'; +import { ExportBatchSelectorComponent } from '../../dso-selector/modal-wrappers/export-batch-selector/export-batch-selector.component'; +import { ExportMetadataSelectorComponent } from '../../dso-selector/modal-wrappers/export-metadata-selector/export-metadata-selector.component'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class ExportMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected scriptDataService: ScriptDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.export', + }, + icon: 'file-export', + shouldPersistOnRouteChange: true, + }, + ); + } + + public getSubSections(): Observable { + return observableCombineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + this.scriptDataService.scriptWithNameExistsAndCanExecute(METADATA_EXPORT_SCRIPT_NAME), + ]).pipe( + map(([authorized, metadataExportScriptExists]) => { + return [ + { + visible: authorized && metadataExportScriptExists, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.export_metadata', + function: () => { + this.modalService.open(ExportMetadataSelectorComponent); + }, + }, + shouldPersistOnRouteChange: true, + }, + { + visible: authorized && metadataExportScriptExists, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.export_batch', + function: () => { + this.modalService.open(ExportBatchSelectorComponent); + }, + }, + shouldPersistOnRouteChange: true, + }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/health.menu.ts b/src/app/shared/menu/providers/health.menu.ts new file mode 100644 index 0000000000..b3db57b3ac --- /dev/null +++ b/src/app/shared/menu/providers/health.menu.ts @@ -0,0 +1,50 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class HealthMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.health', + link: '/health', + }, + icon: 'heartbeat', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/import.menu.ts b/src/app/shared/menu/providers/import.menu.ts new file mode 100644 index 0000000000..5b1cfc0d0e --- /dev/null +++ b/src/app/shared/menu/providers/import.menu.ts @@ -0,0 +1,80 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest as observableCombineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { + METADATA_IMPORT_SCRIPT_NAME, + ScriptDataService, +} from '../../../core/data/processes/script-data.service'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class ImportMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected scriptDataService: ScriptDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.import', + }, + icon: 'file-import', + shouldPersistOnRouteChange: true, + }, + ); + } + + public getSubSections(): Observable { + return observableCombineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + this.scriptDataService.scriptWithNameExistsAndCanExecute(METADATA_IMPORT_SCRIPT_NAME), + ]).pipe( + map(([authorized, metadataImportScriptExists]) => { + return [ + { + visible: authorized && metadataImportScriptExists, + model: { + type: MenuItemType.LINK, + text: 'menu.section.import_metadata', + link: '/admin/metadata-import', + }, + }, + { + visible: authorized && metadataImportScriptExists, + model: { + type: MenuItemType.LINK, + text: 'menu.section.import_batch', + link: '/admin/batch-import', + }, + }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/item-claim.menu.ts b/src/app/shared/menu/providers/item-claim.menu.ts new file mode 100644 index 0000000000..4b1bf0ccfd --- /dev/null +++ b/src/app/shared/menu/providers/item-claim.menu.ts @@ -0,0 +1,93 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateService } from '@ngx-translate/core'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ResearcherProfileDataService } from '../../../core/profile/researcher-profile-data.service'; +import { Item } from '../../../core/shared/item.model'; +import { isNotEmpty } from '../../empty.util'; +import { NotificationsService } from '../../notifications/notifications.service'; +import { MenuID } from '../menu-id.model'; +import { MenuItemType } from '../menu-item-type.model'; +import { OnClickMenuItemModel } from '../menu-item/models/onclick.model'; +import { PartialMenuSection } from '../menu-provider'; +import { MenuService } from '../menu.service'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +@Injectable() +// todo: the "Item-ness" of this class is basically unenforced though... +export class ClaimMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected menuService: MenuService, + protected dsoDataService: DSpaceObjectDataService, + protected translate: TranslateService, + protected notificationsService: NotificationsService, + protected researcherProfileService: ResearcherProfileDataService, + protected modalService: NgbModal, + ) { + super(dsoDataService); + } + + + protected isApplicable(item: Item): boolean { + return this.getDsoType(item) === 'person'; + } + + public getSectionsForContext(item: Item): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.CanClaimItem, item.self), + ]).pipe( + map(([canClaimItem]) => { + return [ + { + visible: canClaimItem, + model: { + type: MenuItemType.ONCLICK, + text: 'item.page.claim.button', + function: () => { + this.claimResearcher(item); + }, + } as OnClickMenuItemModel, + icon: 'hand-paper', + }, + ] as PartialMenuSection[]; + }), + ); + } + + /** + * Claim a researcher by creating a profile + * Shows notifications and/or hides the menu section on success/error + */ + protected claimResearcher(item: Item) { + this.researcherProfileService.createFromExternalSourceAndReturnRelatedItemId(item.self).subscribe((id: string) => { + if (isNotEmpty(id)) { + this.notificationsService.success( + this.translate.get('researcherprofile.success.claim.title'), + this.translate.get('researcherprofile.success.claim.body'), + ); + this.authorizationService.invalidateAuthorizationsRequestCache(); + this.menuService.hideMenuSection(MenuID.DSO_EDIT, 'claim-dso-' + item.uuid); + } else { + this.notificationsService.error( + this.translate.get('researcherprofile.error.claim.title'), + this.translate.get('researcherprofile.error.claim.body'), + ); + } + }); + } +} diff --git a/src/app/shared/menu/providers/item-orcid.menu.ts b/src/app/shared/menu/providers/item-orcid.menu.ts new file mode 100644 index 0000000000..b1a9c6d9e7 --- /dev/null +++ b/src/app/shared/menu/providers/item-orcid.menu.ts @@ -0,0 +1,57 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { getDSORoute } from '../../../app-routing-paths'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { Item } from '../../../core/shared/item.model'; +import { URLCombiner } from '../../../core/url-combiner/url-combiner'; +import { MenuItemType } from '../menu-item-type.model'; +import { LinkMenuItemModel } from '../menu-item/models/link.model'; +import { PartialMenuSection } from '../menu-provider'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +@Injectable() +export class OrcidMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected dsoDataService: DSpaceObjectDataService, + ) { + super(dsoDataService); + } + + protected isApplicable(item: Item): boolean { + return this.getDsoType(item) === 'person'; + } + + public getSectionsForContext(item: Item): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.CanSynchronizeWithORCID, item.self), + ]).pipe( + map(([canSynchronizeWithOrcid]) => { + return [ + { + visible: canSynchronizeWithOrcid, + model: { + type: MenuItemType.LINK, + text: 'item.page.orcid.tooltip', + link: new URLCombiner(getDSORoute(item), 'orcid').toString() + } as LinkMenuItemModel, + icon: 'orcid fab fa-lg', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/item-versioning.menu.ts b/src/app/shared/menu/providers/item-versioning.menu.ts new file mode 100644 index 0000000000..fe32d36aa5 --- /dev/null +++ b/src/app/shared/menu/providers/item-versioning.menu.ts @@ -0,0 +1,60 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Injectable } from '@angular/core'; +import { + combineLatest, + Observable, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { Item } from '../../../core/shared/item.model'; +import { DsoVersioningModalService } from '../../dso-page/dso-versioning-modal-service/dso-versioning-modal.service'; +import { MenuItemType } from '../menu-item-type.model'; +import { OnClickMenuItemModel } from '../menu-item/models/onclick.model'; +import { PartialMenuSection } from '../menu-provider'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +@Injectable() +export class VersioningMenuProvider extends DSpaceObjectPageMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected dsoVersioningModalService: DsoVersioningModalService, + protected dsoDataService: DSpaceObjectDataService, + ) { + super(dsoDataService); + } + + public getSectionsForContext(item: Item): Observable { + console.log(`VersioningMenuProvider.getSectionsForContext()`, item); // todo: remove this + + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.CanCreateVersion, item.self), + this.dsoVersioningModalService.isNewVersionButtonDisabled(item), + this.dsoVersioningModalService.getVersioningTooltipMessage(item, 'item.page.version.hasDraft', 'item.page.version.create'), + ]).pipe( + map(([canCreateVersion, disableVersioning, versionTooltip]) => { + return [ + { + visible: canCreateVersion, + model: { + type: MenuItemType.ONCLICK, + text: versionTooltip, + disabled: disableVersioning, + function: () => { + this.dsoVersioningModalService.openCreateVersionModal(item); + }, + } as OnClickMenuItemModel, + icon: 'code-branch', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/item.menu.ts b/src/app/shared/menu/providers/item.menu.ts new file mode 100644 index 0000000000..5f889077af --- /dev/null +++ b/src/app/shared/menu/providers/item.menu.ts @@ -0,0 +1,52 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { Optional } from '@angular/core'; +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { + Observable, + of, +} from 'rxjs'; +import { map } from 'rxjs/operators'; +import { DSpaceObjectDataService } from '../../../core/data/dspace-object-data.service'; +import { RemoteData } from '../../../core/data/remote-data'; +import { Item } from '../../../core/shared/item.model'; +import { getFirstCompletedRemoteData } from '../../../core/shared/operators'; +import { ItemPageResolver } from '../../../item-page/item-page.resolver'; +import { DSpaceObjectPageMenuProvider } from './dso.menu'; + +export abstract class ItemPageMenuProvider extends DSpaceObjectPageMenuProvider { + allRoutes = false; + + protected constructor( + protected dsoDataService: DSpaceObjectDataService, + @Optional() protected resolver?: ItemPageResolver, + ) { + super(dsoDataService); + } + + public getRouteContext(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable { + if (this.resolver === null) { + return of(undefined); + } + + // todo: it should be better to reuse the exact resolver that the page uses already, since the RD is guaranteed to be cached already + return (this.resolver.resolve(route, state) as Observable>).pipe( + getFirstCompletedRemoteData(), + map((dsoRD) => { + if (dsoRD.hasSucceeded) { + return dsoRD.payload; + } else { + return undefined; + } + }) + ); + } +} diff --git a/src/app/shared/menu/providers/new.menu.ts b/src/app/shared/menu/providers/new.menu.ts new file mode 100644 index 0000000000..93786b7d02 --- /dev/null +++ b/src/app/shared/menu/providers/new.menu.ts @@ -0,0 +1,100 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ThemedCreateCollectionParentSelectorComponent } from '../../dso-selector/modal-wrappers/create-collection-parent-selector/themed-create-collection-parent-selector.component'; +import { ThemedCreateCommunityParentSelectorComponent } from '../../dso-selector/modal-wrappers/create-community-parent-selector/themed-create-community-parent-selector.component'; +import { ThemedCreateItemParentSelectorComponent } from '../../dso-selector/modal-wrappers/create-item-parent-selector/themed-create-item-parent-selector.component'; +import { MenuItemType } from '../menu-item-type.model'; +import { TextMenuItemModel } from '../menu-item/models/text.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class NewMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.new' + } as TextMenuItemModel, + icon: 'plus', + }, + ); + } + + public getSubSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.IsCollectionAdmin), + this.authorizationService.isAuthorized(FeatureID.IsCommunityAdmin), + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + this.authorizationService.isAuthorized(FeatureID.CanSubmit), + ]).pipe(map(([isCollectionAdmin, isCommunityAdmin, isSiteAdmin, canSubmit]) => { + return [ + { + visible: isCollectionAdmin, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.new_community', + function: () => { + this.modalService.open(ThemedCreateCommunityParentSelectorComponent); + } + }, + }, + { + visible: isCommunityAdmin, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.new_collection', + function: () => { + this.modalService.open(ThemedCreateCollectionParentSelectorComponent); + } + }, + }, + { + visible: canSubmit, + model: { + type: MenuItemType.ONCLICK, + text: 'menu.section.new_item', + function: () => { + this.modalService.open(ThemedCreateItemParentSelectorComponent); + } + }, + }, + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.new_process', + link: '/processes/new' + }, + }, + ] as MenuSubSection[]; + })); + } +} diff --git a/src/app/shared/menu/providers/notifications.menu.ts b/src/app/shared/menu/providers/notifications.menu.ts new file mode 100644 index 0000000000..7c189b8018 --- /dev/null +++ b/src/app/shared/menu/providers/notifications.menu.ts @@ -0,0 +1,68 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ScriptDataService } from '../../../core/data/processes/script-data.service'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class NotificationsMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected scriptDataService: ScriptDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.notifications', + }, + icon: 'bell', + }, + ); + } + + public getSubSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + this.authorizationService.isAuthorized(FeatureID.CanSeeQA), + ]).pipe( + map(([authorized, canSeeQA]) => { + return [ + { + visible: authorized && canSeeQA, + model: { + type: MenuItemType.LINK, + text: 'menu.section.quality-assurance', + link: '/admin/notifications/quality-assurance', + }, + }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/processes.menu.ts b/src/app/shared/menu/providers/processes.menu.ts new file mode 100644 index 0000000000..244c1b4f8e --- /dev/null +++ b/src/app/shared/menu/providers/processes.menu.ts @@ -0,0 +1,50 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class ProcessesMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.processes', + link: '/processes', + }, + icon: 'terminal', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/registries.menu.ts b/src/app/shared/menu/providers/registries.menu.ts new file mode 100644 index 0000000000..d2e7e2835d --- /dev/null +++ b/src/app/shared/menu/providers/registries.menu.ts @@ -0,0 +1,75 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { + combineLatest, + map, + Observable, + of as observableOf, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { ScriptDataService } from '../../../core/data/processes/script-data.service'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractExpandableMenuProvider, + MenuSubSection, + MenuTopSection, +} from './expandable-menu-provider'; + +@Injectable() +export class RegistriesMenuProvider extends AbstractExpandableMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + protected scriptDataService: ScriptDataService, + protected modalService: NgbModal, + ) { + super(); + } + + public getTopSection(): Observable { + return observableOf( + { + model: { + type: MenuItemType.TEXT, + text: 'menu.section.registries', + }, + icon: 'list', + }, + ); + } + + public getSubSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([authorized]) => { + return [ + { + visible: authorized, + model: { + type: MenuItemType.LINK, + text: 'menu.section.registries_metadata', + link: 'admin/registries/metadata', + }, + }, + { + visible: authorized, + model: { + type: MenuItemType.LINK, + text: 'menu.section.registries_format', + link: 'admin/registries/bitstream-formats', + }, + }, + ] as MenuSubSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/route-context.menu.ts b/src/app/shared/menu/providers/route-context.menu.ts new file mode 100644 index 0000000000..0d5ce954f2 --- /dev/null +++ b/src/app/shared/menu/providers/route-context.menu.ts @@ -0,0 +1,43 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { + Observable, + of as observableOf, +} from 'rxjs'; +import { switchMap } from 'rxjs/operators'; +import { hasValue } from '../../empty.util'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +export abstract class AbstractRouteContextMenuProvider extends AbstractMenuProvider { + abstract getRouteContext(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable; + + abstract getSectionsForContext(routeContext: T): Observable; + + getSections(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable { + return this.getRouteContext(route, state).pipe( + switchMap((routeContext: T) => { + if (hasValue(routeContext) && this.isApplicable(routeContext)) { + return this.getSectionsForContext(routeContext); + } else { + return observableOf([]); + } + }), + ); + } + + protected isApplicable(routeContext: T): boolean { + return true; + } +} diff --git a/src/app/shared/menu/providers/statistics.menu.ts b/src/app/shared/menu/providers/statistics.menu.ts new file mode 100644 index 0000000000..4754b0b108 --- /dev/null +++ b/src/app/shared/menu/providers/statistics.menu.ts @@ -0,0 +1,70 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + ActivatedRouteSnapshot, + RouterStateSnapshot, +} from '@angular/router'; +import { + Observable, + of, +} from 'rxjs'; +import { hasNoValue } from '../../empty.util'; +import { MenuItemType } from '../menu-item-type.model'; +import { PartialMenuSection } from '../menu-provider'; +import { AbstractRouteContextMenuProvider } from './route-context.menu'; + +interface StatisticsLink { + id: string, + link: string, +} + +@Injectable() +export class StatisticsMenuProvider extends AbstractRouteContextMenuProvider { + allRoutes = false; + + public getRouteContext(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable { + // todo: this won't work for entities! + let page = state.url.split('/')[1]; + const uuid = route.params.id; + + // todo: wow + if (page === 'entities') { + page = 'items'; + } + + if ( + !['home', 'items', 'communities', 'collections'].includes(page) || + (hasNoValue(uuid) && page !== 'home') + ) { + return of(undefined); + } + + if (page === 'home') { + return of(`statistics`); + } else { + return of(`statistics/${page}/${uuid}`); + } + } + + public getSectionsForContext(link: string): Observable { + return of([ + { + visible: true, + model: { + type: MenuItemType.LINK, + text: 'menu.section.statistics', + link, + }, + icon: 'chart-line', + }, + ] as PartialMenuSection[]); + } + +} diff --git a/src/app/shared/menu/providers/system-wide-alert.menu.ts b/src/app/shared/menu/providers/system-wide-alert.menu.ts new file mode 100644 index 0000000000..1db18e1587 --- /dev/null +++ b/src/app/shared/menu/providers/system-wide-alert.menu.ts @@ -0,0 +1,50 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class SystemWideAlertMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.system-wide-alert', + link: '/admin/system-wide-alert', + }, + icon: 'exclamation-circle', + }, + ] as PartialMenuSection[]; + }), + ); + } +} diff --git a/src/app/shared/menu/providers/workflow.menu.ts b/src/app/shared/menu/providers/workflow.menu.ts new file mode 100644 index 0000000000..0ecd772ad1 --- /dev/null +++ b/src/app/shared/menu/providers/workflow.menu.ts @@ -0,0 +1,50 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ + +import { Injectable } from '@angular/core'; +import { + combineLatest, + map, + Observable, +} from 'rxjs'; +import { AuthorizationDataService } from '../../../core/data/feature-authorization/authorization-data.service'; +import { FeatureID } from '../../../core/data/feature-authorization/feature-id'; +import { MenuItemType } from '../menu-item-type.model'; +import { + AbstractMenuProvider, + PartialMenuSection, +} from '../menu-provider'; + +@Injectable() +export class WorkflowMenuProvider extends AbstractMenuProvider { + constructor( + protected authorizationService: AuthorizationDataService, + ) { + super(); + } + + public getSections(): Observable { + return combineLatest([ + this.authorizationService.isAuthorized(FeatureID.AdministratorOf), + ]).pipe( + map(([isSiteAdmin]) => { + return [ + { + visible: isSiteAdmin, + model: { + type: MenuItemType.LINK, + text: 'menu.section.workflow', + link: '/admin/workflow', + }, + icon: 'user-check', + }, + ] as PartialMenuSection[]; + }), + ); + } +}