nextcloud/apps/files_external/src/actions/inlineStorageCheckAction.ts

/**
 * @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @author John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @license AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
// eslint-disable-next-line n/no-extraneous-import
import type { AxiosError } from 'axios'
import type { Node } from '@nextcloud/files'

import { showWarning } from '@nextcloud/dialogs'
import { translate as t } from '@nextcloud/l10n'
import AlertSvg from '@mdi/svg/svg/alert-circle.svg?raw'
import Vue from 'vue'

import '../css/fileEntryStatus.scss'
import { getStatus, type StorageConfig } from '../services/externalStorage'
import { isMissingAuthConfig, STORAGE_STATUS } from '../utils/credentialsUtils'
import { isNodeExternalStorage } from '../utils/externalStorageUtils'
import { registerFileAction, FileAction } from '../../../files/src/services/FileAction'

export const action = new FileAction({
	id: 'check-external-storage',
	displayName: () => '',
	iconSvgInline: () => '',

	enabled: (nodes: Node[]) => {
		return nodes.every(node => isNodeExternalStorage(node) === true)
	},
	exec: async () => null,

	/**
	 * Use this function to check the storage availability
	 * We then update the node attributes directly.
	 */
	async renderInline(node: Node) {
		let config = null as any as StorageConfig
		try {
			const response = await getStatus(node.attributes.id, node.attributes.scope === 'system')
			config = response.data
			Vue.set(node.attributes, 'config', config)

			if (config.status !== STORAGE_STATUS.SUCCESS) {
				throw new Error(config?.statusMessage || t('files_external', 'There was an error with this external storage.'))
			}

			return null
		} catch (error) {
			// If axios failed or if something else prevented
			// us from getting the config
			if ((error as AxiosError).response && !config) {
				showWarning(t('files_external', 'We were unable to check the external storage {basename}', {
					basename: node.basename,
				}))
				return null
			}

			// Checking if we really have an error
			const isWarning = isMissingAuthConfig(config)
			const overlay = document.createElement('span')
			overlay.classList.add(`files-list__row-status--${isWarning ? 'warning' : 'error'}`)

			const span = document.createElement('span')
			span.className = 'files-list__row-status'

			// Only show an icon for errors, warning like missing credentials
			// have a dedicated inline action button
			if (!isWarning) {
				span.innerHTML = AlertSvg
				span.title = (error as Error).message
			}

			span.prepend(overlay)
			return span
		}
	},

	order: 10,
})

registerFileAction(action)