cloudron-box/dashboard/src/Index.vue

<script setup>

import { onMounted, ref, useTemplateRef, provide } from 'vue';
import { Notification, fetcher } from '@cloudron/pankow';
import { setLanguage } from './i18n.js';
import { API_ORIGIN, TOKEN_TYPES } from './constants.js';
import { redirectIfNeeded } from './utils.js';
import ProfileModel from './models/ProfileModel.js';
import ProvisionModel from './models/ProvisionModel.js';
import DashboardModel from './models/DashboardModel.js';
import BrandingModel from './models/BrandingModel.js';
import Headerbar from './components/Headerbar.vue';
import SubscriptionRequiredDialog from './components/SubscriptionRequiredDialog.vue';
import RequestErrorDialog from './components/RequestErrorDialog.vue';
import OfflineOverlay from './components/OfflineOverlay.vue';
import SideBar from './components/SideBar.vue';
import AppsView from './views/AppsView.vue';
import AppConfigureView from './views/AppConfigureView.vue';
import AppearanceView from './views/AppearanceView.vue';
import AppstoreView from './views/AppstoreView.vue';
import BackupSitesView from './views/BackupSitesView.vue';
import AppArchiveView from './views/AppArchiveView.vue';
import CloudronAccountView from './views/CloudronAccountView.vue';
import DomainsView from './views/DomainsView.vue';
import EmailDomainView from './views/EmailDomainView.vue';
import EmailDomainsView from './views/EmailDomainsView.vue';
import EmailMailboxesView from './views/EmailMailboxesView.vue';
import EmailMailinglistsView from './views/EmailMailinglistsView.vue';
import EmailSettingsView from './views/EmailSettingsView.vue';
import EmailEventlogView from './views/EmailEventlogView.vue';
import EventlogView from './views/EventlogView.vue';
import NetworkView from './views/NetworkView.vue';
import ProfileView from './views/ProfileView.vue';
import ServicesView from './views/ServicesView.vue';
import SystemSettingsView from './views/SystemSettingsView.vue';
import SystemUpdateView from './views/SystemUpdateView.vue';
import DockerView from './views/DockerView.vue';
import ServerView from './views/ServerView.vue';
import UserDirectorySettingsView from './views/UserDirectorySettingsView.vue';
import LdapView from './views/LdapView.vue';
import OpenIdView from './views/OpenIdView.vue';
import UsersView from './views/UsersView.vue';
import GroupsView from './views/GroupsView.vue';
import VolumesView from './views/VolumesView.vue';

const VIEWS = Object.freeze({
  APP: '#/app', // this is a prefix
  APPEARANCE: '#/appearance',
  APPS: '#/apps',
  APPSTORE: '#/appstore', // this is a prefix
  BACKUP_SITES: '#/backup-sites',
  APP_ARCHIVE: '#/app-archive',
  CLOUDRON_ACCOUNT: '#/cloudron-account',
  DOMAINS: '#/domains',
  EMAIL_DOMAIN: '#/email-domain',
  EMAIL_DOMAINS: '#/email-domains',
  MAILBOXES: '#/mailboxes',
  MAILINGLISTS: '#/mailinglists',
  EMAIL_SETTINGS: '#/email-settings',
  EMAIL_EVENTLOG: '#/email-eventlog',
  SERVER: '#/server',
  NETWORK: '#/network',
  PROFILE: '#/profile',
  SERVICES: '#/services',
  SYSTEM_SETTINGS: '#/system-settings',
  DOCKER: '#/docker',
  SYSTEM_EVENTLOG: '#/system-eventlog',
  SYSTEM_UPDATE: '#/system-update',
  USER_DIRECTORY_SETTINGS: '#/user-directory-settings',
  LDAP: '#/ldap',
  OPENID: '#/openid',
  USERS: '#/users',
  GROUPS: '#/groups',
  VOLUMES: '#/volumes',
});

const offlineOverlay = useTemplateRef('offlineOverlay');

fetcher.globalOptions.errorHook = (error) => {
  // network error, request killed by browser
  if (error instanceof TypeError) {
    return offlineOverlay.value.open();
  }

  // re-login will make the code get a new token
  if (error.status === 401) return profileModel.logout();

  if (error.status === 500 || error.status === 501) {
    // actual internal server error, most likely a bug or timeout log to console only to not alert the user
    console.error(error);
    console.log('------\nCloudron Internal Error\n\nIf you see this, please send a mail with above log to support@cloudron.io\n------\n');
  }

  if (error.status >= 502) {
    // This means the box service is not reachable. We just show offline banner for now
    ready.value = false;
    return offlineOverlay.value.open();
  }
};

const dashboardModel = DashboardModel.create();
const profileModel = ProfileModel.create();
const provisionModel = ProvisionModel.create();

const subscriptionRequiredDialog = useTemplateRef('subscriptionRequiredDialog');
const ready = ref(false);
const view = ref('');
const profile = ref({});
const dashboardDomain = ref('');
const subscription = ref({
  plan: {},
});
const config = ref({});
const avatarUrl = ref('');
const features = ref({});

function onHashChange() {
  const v = window.location.hash.split('?')[0];

  if (v === VIEWS.APPS) {
    view.value = VIEWS.APPS;
  } else if (v.indexOf(VIEWS.APPSTORE) === 0 && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.APPSTORE;
  } else if (v.indexOf(VIEWS.APP+'/') === 0) { // this checks permissions within the view as we may have an app operator
    view.value = VIEWS.APP;
  } else if (v === VIEWS.APPEARANCE && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.APPEARANCE;
  } else if (v === VIEWS.BACKUP_SITES && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.BACKUP_SITES;
  } else if (v === VIEWS.APP_ARCHIVE && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.APP_ARCHIVE;
  } else if (v === VIEWS.CLOUDRON_ACCOUNT && profile.value.isAtLeastOwner) {
    view.value = VIEWS.CLOUDRON_ACCOUNT;
  } else if (v === VIEWS.DOMAINS && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.DOMAINS;
  } else if (v.indexOf(VIEWS.EMAIL_DOMAIN+'/') === 0 && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.EMAIL_DOMAIN;
  } else if (v === VIEWS.EMAIL_DOMAINS && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.EMAIL_DOMAINS;
  } else if (v === VIEWS.MAILBOXES && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.MAILBOXES;
  } else if (v === VIEWS.MAILINGLISTS && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.MAILINGLISTS;
  } else if (v === VIEWS.EMAIL_SETTINGS && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.EMAIL_SETTINGS;
  } else if (v === VIEWS.EMAIL_EVENTLOG && profile.value.isAtLeastMailManager) {
    view.value = VIEWS.EMAIL_EVENTLOG;
  } else if (v === VIEWS.SERVER && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.SERVER;
  } else if (v === VIEWS.NETWORK && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.NETWORK;
  } else if (v === VIEWS.PROFILE) {
    view.value = VIEWS.PROFILE;
  } else if (v === VIEWS.SERVICES && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.SERVICES;
  } else if (v === VIEWS.SYSTEM_SETTINGS && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.SYSTEM_SETTINGS;
  } else if (v === VIEWS.DOCKER && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.DOCKER;
  } else if (v === VIEWS.SYSTEM_EVENTLOG && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.SYSTEM_EVENTLOG;
  } else if (v === VIEWS.SYSTEM_UPDATE && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.SYSTEM_UPDATE;
  } else if (v === VIEWS.USER_DIRECTORY_SETTINGS && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.USER_DIRECTORY_SETTINGS;
  } else if (v === VIEWS.LDAP && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.LDAP;
  } else if (v === VIEWS.OPENID && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.OPENID;
  } else if (v === VIEWS.USERS && profile.value.isAtLeastUserManager) {
    view.value = VIEWS.USERS;
  } else if (v === VIEWS.GROUPS && profile.value.isAtLeastUserManager) {
    view.value = VIEWS.GROUPS;
  } else if (v === VIEWS.VOLUMES && profile.value.isAtLeastAdmin) {
    view.value = VIEWS.VOLUMES;
  } else {
    window.location.href = VIEWS.APPS;
  }
}

BrandingModel.onChange(BrandingModel.KEYS.NAME, (value) => {
  window.document.title = value;
  config.value.cloudronName = value;
});

BrandingModel.onChange(BrandingModel.KEYS.AVATAR, (value) => {
  avatarUrl.value = value;
  if (document.querySelector('link[rel="icon"]')) document.querySelector('link[rel="icon"]').href = value;
});

ProfileModel.onChange(ProfileModel.KEYS.AVATAR, (value) => {
  profile.value.avatarUrl = value;
});

async function refreshProfile() {
  const [error, result] = await profileModel.get();
  if (error) return window.cloudron.onError(error);
  profile.value = result;
}

async function refreshConfigAndFeatures() {
  const [error, result] = await dashboardModel.config();
  if (error) return window.cloudron.onError(error);

  const currentVersion = localStorage.getItem('version');
  if (currentVersion === null) {
    localStorage.setItem('version', result.version);
  } else if (result.version !== currentVersion) {
    console.log('Dashboard version changed, reloading');
    localStorage.setItem('version', result.version);
    window.location.reload(true);
  }

  config.value = result;
  features.value = result.features;
  dashboardDomain.value = result.adminDomain;
}

async function onOnline() {
  ready.value = true;
  await refreshConfigAndFeatures(); // reload dashboard if needed after an update
}

provide('subscriptionRequiredDialog', subscriptionRequiredDialog);
provide('features', features);
provide('profile', profile);
provide('refreshProfile', refreshProfile);
provide('refreshFeatures', refreshConfigAndFeatures);
provide('dashboardDomain', dashboardDomain);

onMounted(async () => {
  const [error, result] = await provisionModel.status();
  if (error) return window.cloudron.onError(error);

  if (redirectIfNeeded(result, 'dashboard')) return; // redirected to some other view...

  if (!localStorage.token) {
    localStorage.setItem('redirectToHash', window.location.hash);

    // start oidc flow
    window.location.href =  `${API_ORIGIN}/openid/auth?client_id=` + (API_ORIGIN ? TOKEN_TYPES.ID_DEVELOPMENT : TOKEN_TYPES.ID_WEBADMIN) + '&scope=openid email profile&response_type=code token&redirect_uri=' + window.location.origin + '/authcallback.html';

    return;
  }

  await refreshProfile();

  // ensure language from profile if set
  if (profile.value.language) await setLanguage(profile.value.language, true);

  await refreshConfigAndFeatures();

  avatarUrl.value = `https://${config.value.adminFqdn}/api/v1/cloudron/avatar`;

  if (config.value.mandatory2FA && !profile.value.twoFactorAuthenticationEnabled) window.location.href = VIEWS.PROFILE;

  window.addEventListener('hashchange', onHashChange);
  onHashChange();

  console.log(`Cloudron dashboard v${config.value.version}`);

  ready.value = true;
});

</script>

<template>
  <div style="overflow: hidden; height: 100%;">
    <Notification />
    <OfflineOverlay ref="offlineOverlay" @online="onOnline()" :href="'https://docs.cloudron.io/troubleshooting/'" :label="$t('main.offline')" />
    <SubscriptionRequiredDialog ref="subscriptionRequiredDialog"/>
    <RequestErrorDialog/>

    <div v-if="ready" style="display: flex; flex-direction: row; overflow: hidden; height: 100%;">
      <SideBar v-if="profile.isAtLeastUserManager" :profile="profile" :active-view="view" :VIEWS="VIEWS" :cloudron-name="config.cloudronName" :cloudron-avatar-url="avatarUrl"/>

      <div style="flex-grow: 1; display: flex; flex-direction: column; overflow: hidden; height: 100%;">
        <Headerbar :config="config" :subscription="subscription"/>

        <div style="display: flex; justify-content: center; overflow: auto; flex-grow: 1; padding: 0; margin: 0 10px; position: relative;">
          <KeepAlive>
            <AppsView v-if="view === VIEWS.APPS" />
            <AppstoreView v-else-if="view === VIEWS.APPSTORE" />
          </KeepAlive>
          <AppConfigureView v-if="view === VIEWS.APP" />
          <AppearanceView v-else-if="view === VIEWS.APPEARANCE" />
          <BackupSitesView v-else-if="view === VIEWS.BACKUP_SITES" />
          <AppArchiveView v-else-if="view === VIEWS.APP_ARCHIVE" />
          <CloudronAccountView v-else-if="view === VIEWS.CLOUDRON_ACCOUNT" />
          <DomainsView v-else-if="view === VIEWS.DOMAINS" />
          <EmailDomainsView v-else-if="view === VIEWS.EMAIL_DOMAINS" />
          <EmailDomainView v-else-if="view === VIEWS.EMAIL_DOMAIN" />
          <EmailMailboxesView v-else-if="view === VIEWS.MAILBOXES" />
          <EmailMailinglistsView v-else-if="view === VIEWS.MAILINGLISTS" />
          <EmailSettingsView v-else-if="view === VIEWS.EMAIL_SETTINGS" />
          <EmailEventlogView v-else-if="view === VIEWS.EMAIL_EVENTLOG" />
          <EventlogView v-else-if="view === VIEWS.SYSTEM_EVENTLOG" />
          <ServerView v-else-if="view === VIEWS.SERVER" />
          <NetworkView v-else-if="view === VIEWS.NETWORK" />
          <ProfileView v-else-if="view === VIEWS.PROFILE" />
          <ServicesView v-else-if="view === VIEWS.SERVICES" />
          <SystemSettingsView v-else-if="view === VIEWS.SYSTEM_SETTINGS" />
          <DockerView v-else-if="view === VIEWS.DOCKER" />
          <SystemUpdateView v-else-if="view === VIEWS.SYSTEM_UPDATE" />
          <UserDirectorySettingsView v-else-if="view === VIEWS.USER_DIRECTORY_SETTINGS" />
          <LdapView v-else-if="view === VIEWS.LDAP" />
          <OpenIdView v-else-if="view === VIEWS.OPENID" />
          <UsersView v-else-if="view === VIEWS.USERS" />
          <GroupsView v-else-if="view === VIEWS.GROUPS" />
          <VolumesView v-else-if="view === VIEWS.VOLUMES" />
        </div>
      </div>
    </div>
  </div>
</template>