Newer
Older
import {createInstance} from './i18n.js';
import {ScopedElementsMixin} from '@open-wc/scoped-elements';
import {LanguageSelect} from '@dbp-toolkit/language-select';
import {Icon} from '@dbp-toolkit/common';
import {AuthKeycloak} from '@dbp-toolkit/auth';
import {AuthMenuButton} from './auth-menu-button.js';
import {Notification} from '@dbp-toolkit/notification';
import {ThemeSwitcher} from '@dbp-toolkit/theme-switcher';
import * as commonStyles from '@dbp-toolkit/common/styles';
import {classMap} from 'lit/directives/class-map.js';
import {Router} from './router.js';
import {BuildInfo} from './build-info.js';
import {send as notify} from '@dbp-toolkit/common/notification';
import {appWelcomeMeta} from './dbp-app-shell-welcome.js';
import {MatomoElement} from '@dbp-toolkit/matomo/src/matomo';
import DBPLitElement from '@dbp-toolkit/common/dbp-lit-element';
/**
* In case the application gets updated future dynamic imports might fail.
* This sends a notification suggesting the user to reload the page.
*
* usage: importNotify(import('<path>'));
* @param {Promise} promise
*/
const importNotify = async (i18n, promise) => {
try {
return await promise;
} catch (error) {
console.log(error);
notify({
body: i18n.t('page-updated-needs-reload'),
type: 'info',
icon: 'warning',
});
throw error;
}
};
export class AppShell extends ScopedElementsMixin(DBPLitElement) {
constructor() {
super();
this.activeView = '';
this.subtitle = '';
this.description = '';
this.routes = [];

Reiter, Christoph
committed
this.visibleRoutes = [];
this.metadata = {};
this.topic = {};
this.basePath = '/';
this.keycloakConfig = null;
this.noWelcomePage = false;
this.menuHeight = -1;
this.gitInfo = '';
this.env = '';
this.buildUrl = '';
this.buildTime = '';
this._loginStatus = 'unknown';
this._roles = [];
this._i18n = createInstance();
this.lang = this._i18n.language;
this.matomoUrl = '';
this.matomoSiteId = -1;
this._attrObserver = new MutationObserver(this.onAttributeObserved);
this._onShowActivityEvent = this._onShowActivityEvent.bind(this);
this.boundCloseMenuHandler = this.hideMenu.bind(this);
this.initateOpenMenu = false;
}
static get scopedElements() {
return {
'dbp-language-select': LanguageSelect,
'dbp-build-info': BuildInfo,
'dbp-auth-keycloak': AuthKeycloak,
'dbp-auth-menu-button': AuthMenuButton,
'dbp-theme-switcher': ThemeSwitcher,
'dbp-notification': Notification,
'dbp-icon': Icon,
'dbp-matomo': MatomoElement,
onAttributeObserved(mutationsList, observer) {
if (mutation.type === 'attributes') {
const key = mutation.attributeName;
const value = mutation.target.getAttribute(key);
sessionStorage.setItem('dbp-attr-' + key, value);
}
}
}
/**
* Fetches the metadata of the components we want to use in the menu, dynamically imports the js modules for them,
* then triggers a rebuilding of the menu and resolves the current route
*
* @param {string} topicURL The topic metadata URL or relative path to load things from
*/
async fetchMetadata(topicURL) {
let metadata = {};
let routes = [];
const result = await (
await fetch(topicURL, {
headers: {'Content-Type': 'application/json'},
})
).json();
this.topic = result;
const fetchOne = async (url) => {
const result = await fetch(url, {
headers: {'Content-Type': 'application/json'},
const jsondata = await result.json();
if (jsondata['element'] === undefined)
throw new Error('no element defined in metadata');
return jsondata;
};
let promises = [];
for (const activity of result.activities) {
const actURL = new URL(activity.path, new URL(topicURL, window.location).href).href;
promises.push([
activity.visible === undefined || activity.visible,
actURL,
fetchOne(actURL),
]);
}
for (const [visible, actURL, p] of promises) {
try {
const activity = await p;
activity.visible = visible;
// Resolve module_src relative to the location of the json file
activity.module_src = new URL(activity.module_src, actURL).href;
activity.required_roles = activity.required_roles || [];
metadata[activity.routing_name] = activity;
routes.push(activity.routing_name);
} catch (error) {
console.log(error);
}
}
if (!this.noWelcomePage) {
// Inject the welcome activity
metadata = Object.assign(metadata, {
customElements.get('dbp-app-shell-welcome').app = this;
// this also triggers a rebuilding of the menu
this.metadata = metadata;
this.routes = routes;
// Switch to the first route if none is selected
if (!this.activeView) this.switchComponent(routes[0]);
else this.switchComponent(this.activeView);
}
initRouter() {
const routes = [
{
path: '',
action: (context) => {
return {
lang: this.lang,
component: '',
},
{
path: '/:lang',
children: [
{
path: '',
action: (context, params) => {
return {
lang: params.lang,
component: '',
},
{
name: 'mainRoute',
path: ['/:component', '/:component/(.*)'],
action: (context, params) => {
let componentTag = params.component.toLowerCase();
let extra = params[0] ? params[0].split('/') : [];
return {
lang: params.lang,
component: componentTag,
};
},
},
],
},
];
this.router = new Router(
routes,
{
routeName: 'mainRoute',
getState: () => {
let state = {
component: this.activeView,
lang: this.lang,
};
return state;
},
setState: (state) => {
this.updateLangIfChanged(state.lang);
this.switchComponent(state.component);
this._extra = state.extra;
},
getDefaultState: () => {
return {
lang: 'de',
component: this.routes[0],
{
baseUrl: new URL(this.basePath, window.location).pathname.replace(/\/$/, ''),
}
);
this.router.setStateFromCurrentLocation();
}
static get properties() {
lang: {type: String, reflect: true},
src: {type: String},
basePath: {type: String, attribute: 'base-path'},
activeView: {type: String, attribute: false},
entryPointUrl: {type: String, attribute: 'entry-point-url'},
keycloakConfig: {type: Object, attribute: 'keycloak-config'},
metadata: {type: Object, attribute: false},
visibleRoutes: {type: Array, attribute: false},
topic: {type: Object, attribute: false},
subtitle: {type: String, attribute: false},
description: {type: String, attribute: false},
_loginStatus: {type: Boolean, attribute: false},
_roles: {type: Array, attribute: false},
matomoUrl: {type: String, attribute: 'matomo-url'},
matomoSiteId: {type: Number, attribute: 'matomo-site-id'},
noWelcomePage: {type: Boolean, attribute: 'no-welcome-page'},
gitInfo: {type: String, attribute: 'git-info'},
buildUrl: {type: String, attribute: 'build-url'},
buildTime: {type: String, attribute: 'build-time'},
env: {type: String},
auth: {type: Object},
}
connectedCallback() {
super.connectedCallback();
this.initRouter();
if (this.src) {
this.fetchMetadata(this.src);
}
}
/**
* Switches language if another language is requested
*
* @param {string} lang
*/
updateLangIfChanged(lang) {

Reiter, Christoph
committed
// in case the language is unknown, fall back to the default
if (!this._i18n.languages.includes(lang)) {

Reiter, Christoph
committed
lang = this.lang;
}
if (this.lang !== lang) {
this.lang = lang;
this.router.update();
Bekerle, Patrizio
committed
// tell a dbp-provider to update the "lang" property
Bekerle, Patrizio
committed
this.sendSetPropertyEvent('lang', lang, true);
}
}
update(changedProperties) {
changedProperties.forEach((oldValue, propName) => {
switch (propName) {
case 'lang':
this._i18n.changeLanguage(this.lang);
document.documentElement.setAttribute('lang', this.lang);
this.subtitle = this.activeMetaDataText('short_name');
this.description = this.activeMetaDataText('description');
this.dispatchEvent(
new CustomEvent('dbp-lang', {
bubbles: true,
composed: true,

Reiter, Christoph
committed
case 'metadata':
break;
case 'auth':
{
if (this.auth.person) {
this._roles = this.auth.person['roles'];
} else {
this._roles = [];
}
this._updateVisibleRoutes();
const loginStatus = this.auth['login-status'];
if (loginStatus !== this._loginStatus) {
console.log('Login status: ' + loginStatus);
}
// Clear the session storage when the user logs out
if (this._loginStatus === 'logging-out') {
sessionStorage.clear();
}
}
});
super.update(changedProperties);
}
onMenuItemClick(e) {
e.preventDefault();
// if not the current page was clicked we need to check if the page can be left
if (!e.currentTarget.className.includes('selected')) {
// simulate a "beforeunload" event
bubbles: true,
cancelable: true,
});
const eventResult = window.dispatchEvent(event);
// if someone canceled the "beforeunload" event we don't want to leave the page
if (!eventResult) {
return;
}
}
const link = e.composedPath()[0];
const location = link.getAttribute('href');
this.router.updateFromPathname(location);
this.hideMenu();
}
onLanguageChanged(e) {
const newLang = e.detail.lang;
this.lang = newLang;
if (changed) {
this.router.update();
this.subtitle = this.activeMetaDataText('short_name');
this.description = this.activeMetaDataText('description');
}
}
switchComponent(componentTag) {
const changed = componentTag !== this.activeView;
this.activeView = componentTag;
const metadata = this.metadata[componentTag];
if (metadata === undefined) {
return;
}
let updateFunc = () => {
const header = this.shadowRoot.querySelector('header');
const title = this.shadowRoot.querySelector('#headline');
if (header === null || title === null) {
return;
}
let style = getComputedStyle(title);
let marginTop = isNaN(parseInt(style.marginTop, 10))
? 0
: parseInt(style.marginTop, 10);
let marginBottom = isNaN(parseInt(style.marginBottom, 10))
? 0
: parseInt(style.marginBottom, 10);
let topValue =
header.getBoundingClientRect().height +
title.getBoundingClientRect().height +
marginTop +
marginBottom;
if (offset < topValue) {
window.scrollTo(0, offset);
} else {
window.scrollTo(0, topValue);
}
this.updatePageTitle();
this.subtitle = this.activeMetaDataText('short_name');
this.description = this.activeMetaDataText('description');
};
// If it is empty assume the element is already registered through other means
if (!metadata.module_src) {
updateFunc();
return;
}
importNotify(this._i18n, import(metadata.module_src))
.then(() => {
updateFunc();
})
.catch((e) => {
console.error(`Error loading ${metadata.element}`);
throw e;
});
}
metaDataText(routingName, key) {
const metadata = this.metadata[routingName];
return metadata !== undefined && metadata[key] !== undefined
? metadata[key][this.lang]
: '';
}
topicMetaDataText(key) {
return this.topic[key] !== undefined ? this.topic[key][this.lang] : '';
}
activeMetaDataText(key) {
return this.metaDataText(this.activeView, key);
}
updatePageTitle() {
document.title = `${this.topicMetaDataText('name')} - ${this.activeMetaDataText(
'short_name'
)}`;
}
toggleMenu() {
const menu = this.shadowRoot.querySelector('ul.menu');
const subtitle = this.shadowRoot.querySelector('h2.subtitle');
if (menu === null || subtitle === null) {
return;
}
menu.classList.toggle('hidden');
if (this.menuHeight === -1) {
this.menuHeight = menu.clientHeight;

Tögl, Christina
committed
}
let topValue = subtitle.getBoundingClientRect().bottom;
let isMenuOverflow = this.menuHeight + topValue >= window.innerHeight ? true : false;
if (isMenuOverflow && !menu.classList.contains('hidden')) {
menu.setAttribute(
'style',
'position: fixed;top: ' +
topValue +
'px;bottom: 0;border-bottom: 0;overflow-y: auto;'
);

Tögl, Christina
committed
menu.scrollTop = 0;
document.body.setAttribute('style', 'overflow:hidden;');
} else if (isMenuOverflow && menu.classList.contains('hidden')) {

Tögl, Christina
committed
document.body.removeAttribute('style', 'overflow:hidden;');
menu.removeAttribute('style');

Tögl, Christina
committed
}
const chevron = this.shadowRoot.querySelector('#menu-chevron-icon');
if (chevron !== null) {
chevron.name = menu.classList.contains('hidden') ? 'chevron-down' : 'chevron-up';
}
if (!menu.classList.contains('hidden')) {
document.addEventListener('click', this.boundCloseMenuHandler);
this.initateOpenMenu = true;
document.removeEventListener('click', this.boundCloseMenuHandler);
menu.removeAttribute('style');
}
hideMenu() {
if (this.initateOpenMenu) {
this.initateOpenMenu = false;
return;
}
const menu = this.shadowRoot.querySelector('ul.menu');
if (menu && !menu.classList.contains('hidden')) this.toggleMenu();
static get styles() {
// language=css
return css`
${commonStyles.getThemeCSS()}
${commonStyles.getGeneralCSS()}
h1.title {
margin-bottom: 0;
font-weight: 300;
}
#main {
display: grid;
grid-template-columns: minmax(180px, 17%) minmax(0, auto);
grid-template-rows: min-content min-content 1fr min-content;
grid-template-areas: 'header header' 'headline headline' 'sidebar main' 'footer footer';
max-width: 1400px;
margin: auto;
min-height: 100vh;
}
#main-logo {
padding: 0 50px 0 0;
}
header {
grid-area: header;
display: grid;
grid-template-columns: 50% 1px auto;
grid-template-rows: 60px 60px;
grid-template-areas: 'hd1-left hd1-middle hd1-right' 'hd2-left . hd2-right';
width: 100%;
max-width: 1060px;
margin: 0 auto;
}
aside {
grid-area: sidebar;
margin: 15px 15px;
}
#headline {
grid-area: headline;
margin: 20px 0 30px 0;
text-align: center;
}
main {
grid-area: main;
margin: 15px 15px;
}
footer {
grid-area: footer;
margin: 15px;
text-align: right;
}
header .hd1-left {
display: flex;
justify-content: flex-end;
-webkit-justify-content: flex-end;
grid-area: hd1-left;
text-align: right;
padding-right: 20px;
header .hd1-middle {
grid-area: hd1-middle;
var(--dbp-content) 0%,
var(--dbp-content) 85%,
}
header .hd1-right {
grid-area: hd1-right;
display: flex;
-webkit-justify-content: flex-start;
padding: 0 20px;
min-width: 0;
align-items: center;
}
header .hd1-right .auth-button {
min-width: 0;
}
header .hd2-left {
grid-area: hd2-left;
display: flex;
flex-direction: column;
white-space: nowrap;
}
header .hd2-left .header {
margin-left: 50px;
}
color: var(--dbp-hover-color, var(--dbp-content));
background-color: var(--dbp-hover-background-color);
header .hd2-right {
grid-area: hd2-right;
display: flex;
flex-direction: column;
justify-content: center;
text-align: right;
}
header a {
display: inline;
}
list-style: none;
}
ul.menu li.close {
display: none;
}
footer {
justify-content: flex-end;
flex-wrap: wrap;
}
margin: 0.5em 0 0 1em;
}
footer a {
padding: 0;
}
color: var(--dbp-hover-color, var(--dbp-content));
background-color: var(--dbp-hover-background-color);
border-color: var(--dbp-hover-color, var(--dbp-content));
}
/* We don't allow inline-svg */
/*
footer .int-link-external::after {
content: "\\00a0\\00a0\\00a0\\00a0";
background-image: url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3Ardf%3D%22http%3A%2F%2Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20height%3D%225.6842mm%22%20width%3D%225.6873mm%22%20version%3D%221.1%22%20xmlns%3Acc%3D%22http%3A%2F%2Fcreativecommons.org%2Fns%23%22%20xmlns%3Adc%3D%22http%3A%2F%2Fpurl.org%2Fdc%2Felements%2F1.1%2F%22%20viewBox%3D%220%200%2020.151879%2020.141083%22%3E%3Cg%20transform%3D%22translate(-258.5%20-425.15)%22%3E%3Cpath%20style%3D%22stroke-linejoin%3Around%3Bstroke%3A%23000%3Bstroke-linecap%3Around%3Bstroke-width%3A1.2%3Bfill%3Anone%22%20d%3D%22m266.7%20429.59h-7.5029v15.002h15.002v-7.4634%22%2F%3E%3Cpath%20style%3D%22stroke-linejoin%3Around%3Bstroke%3A%23000%3Bstroke-linecap%3Around%3Bstroke-width%3A1.2%3Bfill%3Anone%22%20d%3D%22m262.94%20440.86%2015.002-15.002%22%2F%3E%3Cpath%20style%3D%22stroke-linejoin%3Around%3Bstroke%3A%23000%3Bstroke-linecap%3Around%3Bstroke-width%3A1.2%3Bfill%3Anone%22%20d%3D%22m270.44%20425.86h7.499v7.499%22%2F%3E%3C%2Fg%3E%3C%2Fsvg%3E');
background-size:contain;
background-repeat: no-repeat;
background-position:center center;
margin: 0 0.5% 0 1.5%;
font-size:94%;
}
*/
.menu a {
padding: 0.3em;
font-weight: 300;
padding-right: 13px;
word-break: break-word;
color: var(--dbp-hover-color, var(--dbp-content));
background-color: var(--dbp-hover-background-color);
border-left: 3px solid var(--dbp-accent);
font-weight: bolder;
padding-left: 0.5em;
}
aside .subtitle {
display: none;
font-size: 1.25rem;
font-weight: 300;
line-height: 1.25;
cursor: pointer;
text-align: center;
}
ul.menu.hidden {
display: block;
}
a {
transition: background-color 0.15s ease 0s, color 0.15s ease 0s;
}
.description {
text-align: left;
margin-bottom: 1rem;
display: none;
}
#main {
grid-template-columns: minmax(0, auto);
grid-template-rows: min-content min-content min-content 1fr min-content;
grid-template-areas: 'header' 'headline' 'sidebar' 'main' 'footer';
}
header {
grid-template-rows: 40px;
grid-template-areas: 'hd1-left hd1-middle hd1-right';
display: none;
}
aside {
position: sticky;
top: 0;
width: 100%;
background-color: var(--dbp-background);
}
aside h2.subtitle {
display: block;

Reiter, Christoph
committed
padding: 0.5em 0.5em;
}
aside .menu {
border-top-width: 0;
background-color: var(--dbp-background);
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
}
.menu li {
padding: 7px;
}
.menu a {
padding: 8px;
}
ul.menu li.close {
display: block;
padding: 0 15px 15px 15px;
text-align: right;
cursor: pointer;
}
ul.menu.hidden {
display: none;
}
}
`;
}
_createActivityElement(activity) {
// We have to create elements dynamically based on a tag name which isn't possible with lit-html.
// This means we pass the finished element to lit-html and have to handle element caching and
// event binding ourselves.
if (this._lastElm !== undefined) {
if (this._lastElm.tagName.toLowerCase() == activity.element.toLowerCase()) {
return this._lastElm;
} else {
this._onActivityRemoved(this._lastElm);
this._lastElm = undefined;
}
}
this.track('renderActivity', activity.element);
// After it is loaded and registered globally, we get it and register it locally
customElements.whenDefined(activity.element).then(() => {
this.defineScopedElement(activity.element, customElements.get(activity.element));
});
let elm = this.createScopedElement(activity.element);
this._onActivityAdded(elm);
this._lastElm = elm;
return elm;
}
_onShowActivityEvent(e) {
this.switchComponent(e.detail.name);
}
_onActivityAdded(element) {
let value = sessionStorage.getItem('dbp-attr-' + key);
if (value !== null) {
element.setAttribute(key, value);
this._attrObserver.observe(element, {
attributes: true,
attributeFilter: this.topic.attributes,
});
element.addEventListener('dbp-show-activity', this._onShowActivityEvent);
_onActivityRemoved(element) {
this._attrObserver.disconnect();
element.removeEventListener('dbp-show-activity', this._onShowActivityEvent);
this.sendSetPropertyEvent('analytics-event', {category: action, action: message}, true);
_renderActivity() {
const act = this.metadata[this.activeView];
Bekerle, Patrizio
committed
// add subscriptions for the provider component
if (act.subscribe !== undefined) {
Bekerle, Patrizio
committed
// only add the entry-point-url attribute if it isn't subscribed
if (act.subscribe === undefined || !act.subscribe.includes('entry-point-url:')) {
elm.setAttribute('entry-point-url', this.entryPointUrl);
Bekerle, Patrizio
committed
}
// only add the lang attribute if it isn't subscribed
if (act.subscribe === undefined || !act.subscribe.includes('lang:')) {
elm.setAttribute('lang', this.lang);
Bekerle, Patrizio
committed
}
return elm;
}

Reiter, Christoph
committed
_updateVisibleRoutes() {
let visibleRoutes = [];
for (let routingName of this.routes) {
const data = this.metadata[routingName];
const requiredRoles = data['required_roles'];
let visible = data['visible'];
// Hide them until the user is logged in and we know the roles of the user
for (let role of requiredRoles) {
if (!this._roles.includes(role)) {
visible = false;
break;
}
}
if (visible) {
visibleRoutes.push(routingName);
}
}
this.visibleRoutes = visibleRoutes;
const event = new CustomEvent('visibility-changed', {

Reiter, Christoph
committed
bubbles: false,
cancelable: true,
});
this.dispatchEvent(event);
}
let i18n = this._i18n;
return classMap({selected: this.activeView === name});
// We hide the app until we are either fully logged in or logged out
// At the same time when we hide the main app we show the main slot (e.g. a loading spinner)
const appHidden = this._loginStatus === 'unknown' || this._loginStatus === 'logging-in';
const mainClassMap = classMap({hidden: appHidden});
const slotClassMap = classMap({hidden: !appHidden});
if (!appHidden) {
this.updateComplete.then(() => {
Bekerle, Patrizio
committed
// XXX: Safari 11 doesn't like CSS being applied to slots or via HTML,
// so we have to remove the slot instead of hiding it
// select slots with no name attribute
const slot = this.shadowRoot.querySelector('slot:not([name])');
if (slot) slot.remove();
const prodClassMap = classMap({
hidden: this.env === 'production' || this.env === 'demo' || this.env === '',
});
this.updatePageTitle();
// build the menu
let menuTemplates = [];

Reiter, Christoph
committed
for (let routingName of this.visibleRoutes) {
menuTemplates.push(
html`
<li>
<a
@click="${(e) => this.onMenuItemClick(e)}"
href="${this.router.getPathname({component: routingName})}"
data-nav
class="${getSelectClasses(routingName)}"
title="${this.metaDataText(routingName, 'description')}">
${this.metaDataText(routingName, 'short_name')}
</a>
</li>
`
);
return html`
<slot class="${slotClassMap}"></slot>
<dbp-auth-keycloak
subscribe="requested-login-status"
lang="${this.lang}"
entry-point-url="${this.entryPointUrl}"
url="${kc.url}"
realm="${kc.realm}"
client-id="${kc.clientId}"
silent-check-sso-redirect-uri="${kc.silentCheckSsoRedirectUri || ''}"
scope="${kc.scope || ''}"
idp-hint="${kc.idpHint || ''}"
?force-login="${kc.forceLogin}"
?try-login="${!kc.forceLogin}"></dbp-auth-keycloak>
<dbp-matomo
subscribe="auth,analytics-event"
endpoint="${this.matomoUrl}"
site-id="${this.matomoSiteId}"
git-info="${this.gitInfo}"></dbp-matomo>
<div id="main">
<dbp-notification id="dbp-notification" lang="${this.lang}"></dbp-notification>
<header>
<slot name="header">
<div class="hd1-left">