diff options
Diffstat (limited to 'apps/updatenotification/src')
| -rw-r--r-- | apps/updatenotification/src/components/AppChangelogDialog.vue | 100 | ||||
| -rw-r--r-- | apps/updatenotification/src/components/Markdown.vue | 60 | ||||
| -rw-r--r-- | apps/updatenotification/src/components/UpdateNotification.vue | 527 | ||||
| -rw-r--r-- | apps/updatenotification/src/composables/useMarkdown.ts | 66 | ||||
| -rw-r--r-- | apps/updatenotification/src/init.ts | 82 | ||||
| -rw-r--r-- | apps/updatenotification/src/update-notification-legacy.ts | 24 | ||||
| -rw-r--r-- | apps/updatenotification/src/updatenotification.js | 25 | ||||
| -rw-r--r-- | apps/updatenotification/src/view-changelog-page.ts | 12 | ||||
| -rw-r--r-- | apps/updatenotification/src/views/App.vue | 43 |
9 files changed, 939 insertions, 0 deletions
diff --git a/apps/updatenotification/src/components/AppChangelogDialog.vue b/apps/updatenotification/src/components/AppChangelogDialog.vue new file mode 100644 index 00000000000..0fb7432843c --- /dev/null +++ b/apps/updatenotification/src/components/AppChangelogDialog.vue @@ -0,0 +1,100 @@ +<!-- + - SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + - SPDX-License-Identifier: AGPL-3.0-or-later +--> +<template> + <NcDialog content-classes="app-changelog-dialog" + :buttons="dialogButtons" + :name="t('updatenotification', 'What\'s new in {app} {version}', { app: appName, version: appVersion })" + :open="open && markdown !== undefined" + size="normal" + @update:open="$emit('update:open', $event)"> + <Markdown class="app-changelog-dialog__text" :markdown="markdown" :min-heading-level="3" /> + </NcDialog> +</template> + +<script setup lang="ts"> +import { translate as t } from '@nextcloud/l10n' +import { generateOcsUrl } from '@nextcloud/router' +import { ref, watchEffect } from 'vue' + +import axios from '@nextcloud/axios' +import NcDialog from '@nextcloud/vue/components/NcDialog' +import Markdown from './Markdown.vue' + +const props = withDefaults( + defineProps<{ + appId: string + version?: string + open?: boolean + }>(), + + // Default values + { + open: true, + version: undefined, + }, +) + +const emit = defineEmits<{ + /** + * Event that is called when the "Get started"-button is pressed + */ + (e: 'dismiss'): void + + (e: 'update:open', v: boolean): void +}>() + +const dialogButtons = [ + { + label: t('updatenotification', 'Give feedback'), + callback: () => { + window.open(`https://apps.nextcloud.com/apps/${props.appId}#comments`, '_blank', 'noreferrer noopener') + }, + }, + { + label: t('updatenotification', 'Get started'), + type: 'primary', + callback: () => { + emit('dismiss') + emit('update:open', false) + }, + }, +] + +const appName = ref(props.appId) +const appVersion = ref(props.version ?? '') +const markdown = ref<string>('') +watchEffect(() => { + const url = props.version + ? generateOcsUrl('/apps/updatenotification/api/v1/changelog/{app}?version={version}', { version: props.version, app: props.appId }) + : generateOcsUrl('/apps/updatenotification/api/v1/changelog/{app}', { version: props.version, app: props.appId }) + + axios.get(url) + .then(({ data }) => { + appName.value = data.ocs.data.appName + appVersion.value = data.ocs.data.version + markdown.value = data.ocs.data.content + }) + .catch((error) => { + if (error?.response?.status === 404) { + appName.value = props.appId + markdown.value = t('updatenotification', 'No changelog available') + } else { + console.error('Failed to load changelog entry', error) + emit('update:open', false) + } + }) + +}) +</script> + +<style scoped lang="scss"> +:deep(.app-changelog-dialog) { + min-height: 50vh !important; +} + +.app-changelog-dialog__text { + padding-inline: 14px; +} +</style> diff --git a/apps/updatenotification/src/components/Markdown.vue b/apps/updatenotification/src/components/Markdown.vue new file mode 100644 index 00000000000..125b0ff96a9 --- /dev/null +++ b/apps/updatenotification/src/components/Markdown.vue @@ -0,0 +1,60 @@ +<!-- + - SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + - SPDX-License-Identifier: AGPL-3.0-or-later +--> +<template> + <!-- eslint-disable-next-line vue/no-v-html --> + <div class="markdown" v-html="html" /> +</template> + +<script setup lang="ts"> +import { toRef } from 'vue' +import { useMarkdown } from '../composables/useMarkdown' + +const props = withDefaults( + defineProps<{ + markdown: string + minHeadingLevel?: 1|2|3|4|5|6 + }>(), + { + minHeadingLevel: 2, + }, +) + +const { html } = useMarkdown(toRef(props, 'markdown'), toRef(props, 'minHeadingLevel')) +</script> + +<style scoped lang="scss"> +.markdown { + :deep { + ul { + list-style: disc; + padding-inline-start: 20px; + } + + h3, h4, h5, h6 { + font-weight: 600; + line-height: 1.5; + margin-top: 24px; + margin-bottom: 12px; + color: var(--color-main-text); + } + + h3 { + font-size: 20px; + } + + h4 { + font-size: 18px; + } + + h5 { + font-size: 17px; + } + + h6 { + font-size: var(--default-font-size); + } + } +} +</style> diff --git a/apps/updatenotification/src/components/UpdateNotification.vue b/apps/updatenotification/src/components/UpdateNotification.vue new file mode 100644 index 00000000000..94c58dbdfd9 --- /dev/null +++ b/apps/updatenotification/src/components/UpdateNotification.vue @@ -0,0 +1,527 @@ +<!-- + - SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors + - SPDX-License-Identifier: AGPL-3.0-or-later +--> +<template> + <NcSettingsSection id="updatenotification" :name="t('updatenotification', 'Update')"> + <div class="update"> + <template v-if="isNewVersionAvailable"> + <NcNoteCard v-if="versionIsEol" type="warning"> + {{ t('updatenotification', 'The version you are running is not maintained anymore. Please make sure to update to a supported version as soon as possible.') }} + </NcNoteCard> + + <p> + <!-- eslint-disable-next-line vue/no-v-html --> + <span v-html="newVersionAvailableString" /><br> + <span v-if="!isListFetched" class="icon icon-loading-small" /> + <!-- eslint-disable-next-line vue/no-v-html --> + <span v-html="statusText" /> + </p> + + <template v-if="missingAppUpdates.length"> + <h3 class="clickable" @click="toggleHideMissingUpdates"> + {{ t('updatenotification', 'Apps missing compatible version') }} + <span v-if="!hideMissingUpdates" class="icon icon-triangle-n" /> + <span v-if="hideMissingUpdates" class="icon icon-triangle-s" /> + </h3> + <ul v-if="!hideMissingUpdates" class="applist"> + <li v-for="(app, index) in missingAppUpdates" :key="index"> + <a :href="'https://apps.nextcloud.com/apps/' + app.appId" :title="t('settings', 'View in store')">{{ app.appName }} ↗</a> + </li> + </ul> + </template> + + <template v-if="availableAppUpdates.length"> + <h3 class="clickable" @click="toggleHideAvailableUpdates"> + {{ t('updatenotification', 'Apps with compatible version') }} + <span v-if="!hideAvailableUpdates" class="icon icon-triangle-n" /> + <span v-if="hideAvailableUpdates" class="icon icon-triangle-s" /> + </h3> + <ul v-if="!hideAvailableUpdates" class="applist"> + <li v-for="(app, index) in availableAppUpdates" :key="index"> + <a :href="'https://apps.nextcloud.com/apps/' + app.appId" :title="t('settings', 'View in store')">{{ app.appName }} ↗</a> + </li> + </ul> + </template> + + <template v-if="!isWebUpdaterRecommended && updaterEnabled && webUpdaterEnabled"> + <h3 class="warning"> + {{ t('updatenotification', 'Please note that the web updater is not recommended with more than 100 accounts! Please use the command line updater instead!') }} + </h3> + </template> + + <div> + <a v-if="updaterEnabled && webUpdaterEnabled" + href="#" + class="button primary" + @click="clickUpdaterButton">{{ t('updatenotification', 'Open updater') }}</a> + <a v-if="downloadLink" + :href="downloadLink" + class="button" + :class="{ hidden: !updaterEnabled }">{{ t('updatenotification', 'Download now') }}</a> + <span v-if="updaterEnabled && !webUpdaterEnabled"> + {{ t('updatenotification', 'Web updater is disabled. Please use the command line updater or the appropriate update mechanism for your installation method (e.g. Docker pull) to update.') }} + </span> + <NcActions v-if="whatsNewData || changelogURL" + :force-menu="true" + :menu-name="t('updatenotification', 'What\'s new?')" + type="tertiary"> + <template #icon> + <IconNewBox :size="20" /> + </template> + <template #default> + <NcActionCaption v-for="changes,index in whatsNewData" :key="index" :name="changes" /> + <NcActionLink v-if="changelogURL" + :href="changelogURL" + close-after-click + target="_blank"> + {{ t('updatenotification', 'View changelog') }} + <template #icon> + <IconLink :size="20" /> + </template> + </NcActionLink> + </template> + </NcActions> + </div> + </template> + <template v-else-if="!isUpdateChecked"> + {{ t('updatenotification', 'The update check is not yet finished. Please refresh the page.') }} + </template> + <template v-else> + {{ t('updatenotification', 'Your version is up to date.') }} + <a :title="lastCheckedOnString" + :aria-label="lastCheckedOnString" + href="https://nextcloud.com/changelog/" + class="icon-info details" + target="_blank" /> + </template> + + <template v-if="!isDefaultUpdateServerURL"> + <p class="topMargin"> + <em>{{ t('updatenotification', 'A non-default update server is in use to be checked for updates:') }} <code>{{ updateServerURL }}</code></em> + </p> + </template> + </div> + + <h3>{{ t('updatenotification', 'Update channel') }}</h3> + <p class="inlineblock"> + {{ t('updatenotification', 'Changing the update channel also affects the apps management page. E.g. after switching to the beta channel, beta app updates will be offered to you in the apps management page.') }} + </p> + <div class="update-channel-selector"> + <span>{{ t('updatenotification', 'Current update channel:') }}</span> + <NcActions :force-menu="true" + :menu-name="localizedChannelName" + type="tertiary"> + <template #icon> + <IconChevronDown :size="20" /> + </template> + <template #default> + <NcActionButton v-for="channel in channelList" + :key="channel.value" + :disabled="channel.disabled" + :name="channel.text" + :value="channel.value" + :model-value="currentChannel" + type="radio" + close-after-click + @update:modelValue="changeReleaseChannel"> + <template #icon> + <component :is="channel.icon" :size="20" /> + </template> + {{ channel.longtext }} + </NcActionButton> + </template> + </NcActions> + </div> + <p> + <em>{{ t('updatenotification', 'You can always update to a newer version. But you can never downgrade to a more stable version.') }}</em><br> + <!-- eslint-disable-next-line vue/no-v-html --> + <em v-html="noteDelayedStableString" /> + </p> + + <NcSelect id="notify-members-settings-select-wrapper" + v-model="notifyGroups" + :input-label="t('updatenotification', 'Notify members of the following groups about available updates:')" + :options="groups" + :multiple="true" + label="displayname" + :loading="loadingGroups" + :close-on-select="false" + @search="searchGroup"> + <template #no-options> + {{ t('updatenotification', 'No groups') }} + </template> + </NcSelect> + <p> + <em v-if="currentChannel === 'daily' || currentChannel === 'git'">{{ t('updatenotification', 'Only notifications for app updates are available.') }}</em> + <em v-if="currentChannel === 'daily'">{{ t('updatenotification', 'The selected update channel makes dedicated notifications for the server obsolete.') }}</em> + <em v-else-if="currentChannel === 'git'">{{ t('updatenotification', 'The selected update channel does not support updates of the server.') }}</em> + </p> + </NcSettingsSection> +</template> + +<script> +import { showSuccess } from '@nextcloud/dialogs' +import { loadState } from '@nextcloud/initial-state' +import { getLoggerBuilder } from '@nextcloud/logger' +import { generateUrl, getRootUrl, generateOcsUrl } from '@nextcloud/router' + +import axios from '@nextcloud/axios' +import NcActions from '@nextcloud/vue/components/NcActions' +import NcActionButton from '@nextcloud/vue/components/NcActionButton' +import NcActionCaption from '@nextcloud/vue/components/NcActionCaption' +import NcActionLink from '@nextcloud/vue/components/NcActionLink' +import NcNoteCard from '@nextcloud/vue/components/NcNoteCard' +import NcSelect from '@nextcloud/vue/components/NcSelect' +import NcSettingsSection from '@nextcloud/vue/components/NcSettingsSection' +import IconChevronDown from 'vue-material-design-icons/ChevronDown.vue' +import IconCloudCheckVariant from 'vue-material-design-icons/CloudCheckVariant.vue' +import IconLink from 'vue-material-design-icons/Link.vue' +import IconNewBox from 'vue-material-design-icons/NewBox.vue' +import IconPencil from 'vue-material-design-icons/PencilOutline.vue' +import IconSourceBranch from 'vue-material-design-icons/SourceBranch.vue' +import IconStar from 'vue-material-design-icons/Star.vue' +import IconWeatherNight from 'vue-material-design-icons/WeatherNight.vue' +import IconWrench from 'vue-material-design-icons/Wrench.vue' +import debounce from 'debounce' + +const logger = getLoggerBuilder() + .setApp('updatenotification') + .detectUser() + .build() + +export default { + name: 'UpdateNotification', + components: { + IconChevronDown, + IconLink, + IconNewBox, + NcActions, + NcActionButton, + NcActionCaption, + NcActionLink, + NcNoteCard, + NcSelect, + NcSettingsSection, + }, + + data() { + return { + loadingGroups: false, + newVersionString: '', + lastCheckedDate: '', + isUpdateChecked: false, + webUpdaterEnabled: true, + isWebUpdaterRecommended: true, + updaterEnabled: true, + versionIsEol: false, + downloadLink: '', + isNewVersionAvailable: false, + hasValidSubscription: false, + updateServerURL: '', + changelogURL: '', + whatsNewData: [], + currentChannel: '', + channels: [], + notifyGroups: '', + groups: [], + isDefaultUpdateServerURL: true, + enableChangeWatcher: false, + + availableAppUpdates: [], + missingAppUpdates: [], + appStoreFailed: false, + appStoreDisabled: false, + isListFetched: false, + hideMissingUpdates: false, + hideAvailableUpdates: true, + openedWhatsNew: false, + openedUpdateChannelMenu: false, + } + }, + + computed: { + newVersionAvailableString() { + return t('updatenotification', 'A new version is available: <strong>{newVersionString}</strong>', { + newVersionString: this.newVersionString, + }) + }, + + noteDelayedStableString() { + return t('updatenotification', 'Note that after a new release the update only shows up after the first minor release or later. We roll out new versions spread out over time and sometimes skip a version when issues are found. Learn more about updates and release channels at {link}') + .replace('{link}', '<a href="https://nextcloud.com/release-channels/">https://nextcloud.com/release-channels/</a>') + }, + + lastCheckedOnString() { + return t('updatenotification', 'Checked on {lastCheckedDate} - Open changelog', { + lastCheckedDate: this.lastCheckedDate, + }) + }, + + statusText() { + if (!this.isListFetched) { + return t('updatenotification', 'Checking apps for compatible versions') + } + + if (this.appStoreDisabled) { + return t('updatenotification', 'Please make sure your config.php does not set <samp>appstoreenabled</samp> to false.') + } + + if (this.appStoreFailed) { + return t('updatenotification', 'Could not connect to the App Store or no updates have been returned at all. Search manually for updates or make sure your server has access to the internet and can connect to the App Store.') + } + + return this.missingAppUpdates.length === 0 + ? t('updatenotification', '<strong>All</strong> apps have a compatible version for this Nextcloud version available.', this) + : n('updatenotification', '<strong>%n</strong> app has no compatible version for this Nextcloud version available.', '<strong>%n</strong> apps have no compatible version for this Nextcloud version available.', this.missingAppUpdates.length) + }, + + channelList() { + const channelList = [] + + channelList.push({ + text: t('updatenotification', 'Enterprise'), + longtext: t('updatenotification', 'For enterprise use. Provides always the latest patch level, but will not update to the next major release immediately. That update happens once Nextcloud GmbH has done additional hardening and testing for large-scale and mission-critical deployments. This channel is only available to customers and provides the Nextcloud Enterprise package.'), + icon: IconStar, + active: this.currentChannel === 'enterprise', + disabled: !this.hasValidSubscription, + value: 'enterprise', + }) + + channelList.push({ + text: t('updatenotification', 'Stable'), + longtext: t('updatenotification', 'The most recent stable version. It is suited for regular use and will always update to the latest major version.'), + icon: IconCloudCheckVariant, + value: 'stable', + }) + + channelList.push({ + text: t('updatenotification', 'Beta'), + longtext: t('updatenotification', 'A pre-release version only for testing new features, not for production environments.'), + icon: IconWrench, + value: 'beta', + }) + + if (this.isNonDefaultChannel(this.currentChannel)) { + const nonDefaultIcons = { + daily: IconWeatherNight, + git: IconSourceBranch, + } + channelList.push({ + text: this.currentChannel, + icon: nonDefaultIcons[this.currentChannel] || IconPencil, + value: this.currentChannel, + }) + } + + return channelList + }, + + localizedChannelName() { + switch (this.currentChannel) { + case 'enterprise': + return t('updatenotification', 'Enterprise') + case 'stable': + return t('updatenotification', 'Stable') + case 'beta': + return t('updatenotification', 'Beta') + default: + return this.currentChannel + } + }, + }, + + watch: { + notifyGroups() { + if (!this.enableChangeWatcher) { + // The first time is when loading the app + this.enableChangeWatcher = true + return + } + + const groups = this.notifyGroups.map(group => { + return group.id + }) + + OCP.AppConfig.setValue('updatenotification', 'notify_groups', JSON.stringify(groups)) + }, + isNewVersionAvailable() { + if (!this.isNewVersionAvailable) { + return + } + + axios.get(generateOcsUrl('apps/updatenotification/api/v1/applist/{newVersion}', { + newVersion: this.newVersion, + })).then(({ data }) => { + this.availableAppUpdates = data.ocs.data.available + this.missingAppUpdates = data.ocs.data.missing + this.isListFetched = true + this.appStoreFailed = false + }).catch(({ response }) => { + this.availableAppUpdates = [] + this.missingAppUpdates = [] + this.appStoreDisabled = response.data.ocs.data.appstore_disabled + this.isListFetched = true + this.appStoreFailed = true + }) + }, + }, + beforeMount() { + // Parse server data + const data = loadState('updatenotification', 'data') + + this.newVersion = data.newVersion + this.newVersionString = data.newVersionString + this.lastCheckedDate = data.lastChecked + this.isUpdateChecked = data.isUpdateChecked + this.webUpdaterEnabled = data.webUpdaterEnabled + this.isWebUpdaterRecommended = data.isWebUpdaterRecommended + this.updaterEnabled = data.updaterEnabled + this.downloadLink = data.downloadLink + this.isNewVersionAvailable = data.isNewVersionAvailable + this.updateServerURL = data.updateServerURL + this.currentChannel = data.currentChannel + this.channels = data.channels + this.notifyGroups = data.notifyGroups + this.isDefaultUpdateServerURL = data.isDefaultUpdateServerURL + this.versionIsEol = data.versionIsEol + this.hasValidSubscription = data.hasValidSubscription + if (data.changes && data.changes.changelogURL) { + this.changelogURL = data.changes.changelogURL + } + if (data.changes && data.changes.whatsNew) { + if (data.changes.whatsNew.admin) { + this.whatsNewData = this.whatsNewData.concat(data.changes.whatsNew.admin) + } + this.whatsNewData = this.whatsNewData.concat(data.changes.whatsNew.regular) + } + }, + + mounted() { + this.searchGroup() + }, + + methods: { + searchGroup: debounce(async function(query) { + this.loadingGroups = true + try { + const response = await axios.get(generateOcsUrl('cloud/groups/details'), { + search: query, + limit: 20, + offset: 0, + }) + this.groups = response.data.ocs.data.groups.sort(function(a, b) { + return a.displayname.localeCompare(b.displayname) + }) + } catch (err) { + logger.error('Could not fetch groups', err) + } finally { + this.loadingGroups = false + } + }, 500), + /** + * Creates a new authentication token and loads the updater URL + */ + clickUpdaterButton() { + axios.get(generateUrl('/apps/updatenotification/credentials')) + .then(({ data }) => { + // create a form to send a proper post request to the updater + const form = document.createElement('form') + form.setAttribute('method', 'post') + form.setAttribute('action', getRootUrl() + '/updater/') + + const hiddenField = document.createElement('input') + hiddenField.setAttribute('type', 'hidden') + hiddenField.setAttribute('name', 'updater-secret-input') + hiddenField.setAttribute('value', data) + + form.appendChild(hiddenField) + + document.body.appendChild(form) + form.submit() + }) + }, + + isNonDefaultChannel(channel) { + return !['enterprise', 'stable', 'beta'].includes(channel) + }, + + changeReleaseChannel(channel) { + if (this.isNonDefaultChannel(channel)) { + return + } + + this.currentChannel = channel + + axios.post(generateUrl('/apps/updatenotification/channel'), { + channel: this.currentChannel, + }).then(({ data }) => { + showSuccess(data.data.message) + }) + + this.openedUpdateChannelMenu = false + }, + toggleHideMissingUpdates() { + this.hideMissingUpdates = !this.hideMissingUpdates + }, + toggleHideAvailableUpdates() { + this.hideAvailableUpdates = !this.hideAvailableUpdates + }, + }, +} +</script> + +<style lang="scss" scoped> + #updatenotification { + & > * { + max-width: 900px; + } + + .topMargin { + margin-top: 15px; + } + + div.update, + p:not(.inlineblock) { + margin-bottom: 25px; + } + h2.inlineblock { + margin-top: 25px; + } + h3 { + &.clickable { + cursor: pointer; + .icon { + cursor: pointer; + } + } + } + .update-channel-selector { + display: flex; + align-items: center; + gap: 12px; + } + .icon { + display: inline-block; + margin-bottom: -3px; + } + .icon-triangle-s, .icon-triangle-n { + opacity: 0.5; + } + .applist { + margin-bottom: 25px; + } + } +</style> +<style lang="scss"> +#updatenotification { + /* override NcSelect styling so that label can have correct width */ + #notify-members-settings-select-wrapper { + width: fit-content; + + .vs__dropdown-toggle { + min-width: 100%; + } + } +} +</style> diff --git a/apps/updatenotification/src/composables/useMarkdown.ts b/apps/updatenotification/src/composables/useMarkdown.ts new file mode 100644 index 00000000000..71b496a10b3 --- /dev/null +++ b/apps/updatenotification/src/composables/useMarkdown.ts @@ -0,0 +1,66 @@ +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +import type { Ref } from 'vue' + +import { marked } from 'marked' +import { computed } from 'vue' +import dompurify from 'dompurify' + +export const useMarkdown = (text: Ref<string|undefined|null>, minHeadingLevel: Ref<number|undefined>) => { + const minHeading = computed(() => Math.min(Math.max(minHeadingLevel.value ?? 1, 1), 6)) + const renderer = new marked.Renderer() + + renderer.link = function(href, title, text) { + let out = `<a href="${href}" rel="noreferrer noopener" target="_blank"` + if (title) { + out += ' title="' + title + '"' + } + out += '>' + text + '</a>' + return out + } + + renderer.image = function(href, title, text) { + if (text) { + return text + } + return title ?? '' + } + + renderer.heading = (text: string, level: number) => { + const headingLevel = Math.max(minHeading.value, level) + return `<h${headingLevel}>${text}</h${headingLevel}>` + } + + const html = computed(() => dompurify.sanitize( + marked((text.value ?? '').trim(), { + renderer, + gfm: false, + breaks: false, + pedantic: false, + }), + { + SAFE_FOR_JQUERY: true, + ALLOWED_TAGS: [ + 'h1', + 'h2', + 'h3', + 'h4', + 'h5', + 'h6', + 'strong', + 'p', + 'a', + 'ul', + 'ol', + 'li', + 'em', + 'del', + 'blockquote', + ], + }, + )) + + return { html } +} diff --git a/apps/updatenotification/src/init.ts b/apps/updatenotification/src/init.ts new file mode 100644 index 00000000000..d82272bf4b2 --- /dev/null +++ b/apps/updatenotification/src/init.ts @@ -0,0 +1,82 @@ +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +import type { INavigationEntry } from '../../../core/src/types/navigation' + +import { subscribe } from '@nextcloud/event-bus' +import { loadState } from '@nextcloud/initial-state' +import { generateOcsUrl } from '@nextcloud/router' +import Vue, { defineAsyncComponent } from 'vue' +import axios from '@nextcloud/axios' + +const navigationEntries = loadState<INavigationEntry[]>('core', 'apps', []) + +const DialogVue = defineAsyncComponent(() => import('./components/AppChangelogDialog.vue')) + +/** + * Show the app changelog dialog + * + * @param appId The app to show the changelog for + * @param version Optional version to show + */ +function showDialog(appId: string, version?: string) { + const element = document.createElement('div') + document.body.appendChild(element) + + return new Promise((resolve) => { + let dismissed = false + + const dialog = new Vue({ + el: element, + render: (h) => h(DialogVue, { + props: { + appId, + version, + }, + on: { + dismiss: () => { dismissed = true }, + 'update:open': (open: boolean) => { + if (!open) { + dialog.$destroy?.() + resolve(dismissed) + + const app = navigationEntries.find(({ app }) => app === appId) + if (dismissed && app !== undefined) { + window.location.href = app.href + } + } + }, + }, + }), + }) + }) +} + +interface INotificationActionEvent { + cancelAction: boolean + notification: Readonly<{ + notificationId: number + objectId: string + objectType: string + }> + action: Readonly<{ + url: string + type: 'WEB'|'GET'|'POST'|'DELETE' + }>, +} + +subscribe('notifications:action:execute', (event: INotificationActionEvent) => { + if (event.notification.objectType === 'app_updated') { + event.cancelAction = true + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const [_, app, version, __] = event.action.url.match(/(?<=\/)([^?]+)?version=((\d+.?)+)/) ?? [] + showDialog((app as string|undefined) || (event.notification.objectId as string), version) + .then((dismissed) => { + if (dismissed) { + axios.delete(generateOcsUrl('apps/notifications/api/v2/notifications/{id}', { id: event.notification.notificationId })) + } + }) + } +}) diff --git a/apps/updatenotification/src/update-notification-legacy.ts b/apps/updatenotification/src/update-notification-legacy.ts new file mode 100644 index 00000000000..5809c1761dc --- /dev/null +++ b/apps/updatenotification/src/update-notification-legacy.ts @@ -0,0 +1,24 @@ +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + +import { showInfo } from '@nextcloud/dialogs' +import { loadState } from '@nextcloud/initial-state' +import { t } from '@nextcloud/l10n' + +interface IUpdateNotificationState { + updateLink: string + updateVersion: string +} + +/** + * This only gets loaded if an update is available and the notifications app is not enabled for the user. + */ +window.addEventListener('DOMContentLoaded', function() { + const { updateLink, updateVersion } = loadState<IUpdateNotificationState>('updatenotification', 'updateState') + const text = t('core', '{version} is available. Get more information on how to update.', { version: updateVersion }) + + // On click open the update link in a new tab + showInfo(text, { onClick: () => window.open(updateLink, '_blank') }) +}) diff --git a/apps/updatenotification/src/updatenotification.js b/apps/updatenotification/src/updatenotification.js new file mode 100644 index 00000000000..44b783e1454 --- /dev/null +++ b/apps/updatenotification/src/updatenotification.js @@ -0,0 +1,25 @@ +/** + * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +import { translate, translatePlural } from '@nextcloud/l10n' + +import Vue from 'vue' +import Root from './components/UpdateNotification.vue' + +Vue.mixin({ + methods: { + t(app, text, vars, count, options) { + return translate(app, text, vars, count, options) + }, + n(app, textSingular, textPlural, count, vars, options) { + return translatePlural(app, textSingular, textPlural, count, vars, options) + }, + }, +}) + +// eslint-disable-next-line no-new +new Vue({ + el: '#updatenotification', + render: h => h(Root), +}) diff --git a/apps/updatenotification/src/view-changelog-page.ts b/apps/updatenotification/src/view-changelog-page.ts new file mode 100644 index 00000000000..d7f8e84680d --- /dev/null +++ b/apps/updatenotification/src/view-changelog-page.ts @@ -0,0 +1,12 @@ +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +import Vue from 'vue' +import App from './views/App.vue' + +export default new Vue({ + name: 'ViewChangelogPage', + render: (h) => h(App), + el: '#content', +}) diff --git a/apps/updatenotification/src/views/App.vue b/apps/updatenotification/src/views/App.vue new file mode 100644 index 00000000000..8bf1d86dfe2 --- /dev/null +++ b/apps/updatenotification/src/views/App.vue @@ -0,0 +1,43 @@ +<!-- + - SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + - SPDX-License-Identifier: AGPL-3.0-or-later +--> +<template> + <NcContent app-name="updatenotification"> + <NcAppContent :page-heading="t('updatenotification', 'Changelog for app {app}', { app: appName })"> + <div class="changelog__wrapper"> + <h2 class="changelog__heading"> + {{ t('updatenotification', 'What\'s new in {app} version {version}', { app: appName, version: appVersion }) }} + </h2> + <Markdown :markdown="markdown" :min-heading-level="3" /> + </div> + </NcAppContent> + </NcContent> +</template> + +<script setup lang="ts"> +import { translate as t } from '@nextcloud/l10n' +import { loadState } from '@nextcloud/initial-state' + +import NcAppContent from '@nextcloud/vue/components/NcAppContent' +import NcContent from '@nextcloud/vue/components/NcContent' +import Markdown from '../components/Markdown.vue' + +const { + appName, + appVersion, + text: markdown, +} = loadState<{ appName: string, appVersion: string, text: string }>('updatenotification', 'changelog') +</script> + +<style scoped> +.changelog__wrapper { + max-width: max(50vw,700px); + margin-inline: auto; +} + +.changelog__heading { + font-size: 30px; + margin-block: var(--app-navigation-padding, 8px) 1em; +} +</style> |