enh: Migrate to use webdav v5 and @nextcloud/files for DAV handling

Signed-off-by: Ferdinand Thiessen <[email protected]>

src/components/Albums/CollaboratorsSelectionForm.vue

@@ -330,7 +330,7 @@ export default {
 			await this.updateAlbumCollaborators()
 			await this.fetchCollection(
 				this.albumFileName,
-				['<nc:location />', '<nc:dateRange />', '<nc:collaborators />']
+				['<nc:location />', '<nc:dateRange />', '<nc:collaborators />'],
 			)
 		},
 

src/components/FilesListViewer.vue

@@ -67,7 +67,7 @@ import { NcEmptyContent, NcLoadingIcon } from '@nextcloud/vue'
 import { subscribe, unsubscribe } from '@nextcloud/event-bus'
 
 import TiledLayout from '../components/TiledLayout/TiledLayout.vue'
-import { fetchFile } from '../services/fileFetcher.js'
+import { fetchFile } from '../services/fileFetcher.ts'
 import VirtualScrolling from '../components/VirtualScrolling.vue'
 import EmptyBox from '../assets/Illustrations/empty.svg'
 

src/main.js

@@ -5,6 +5,7 @@
 
 import { generateFilePath } from '@nextcloud/router'
 import { getRequestToken } from '@nextcloud/auth'
+import { registerDavProperty } from '@nextcloud/files/dav'
 import { sync } from 'vuex-router-sync'
 import { translate, translatePlural } from '@nextcloud/l10n'
 import Vue from 'vue'
@@ -29,6 +30,11 @@ sync(store, router)
 Vue.prototype.t = translate
 Vue.prototype.n = translatePlural
 
+registerDavProperty('nc:metadata-photos-size')
+registerDavProperty('nc:metadata-files-live-photo')
+registerDavProperty('nc:metadata-blurhash')
+registerDavProperty('nc:metadata-photos-original_date_time')
+
 // TODO: remove when we have a proper fileinfo standalone library
 // original scripts are loaded from
 // https://github.com/nextcloud/server/blob/5bf3d1bb384da56adbf205752be8f840aac3b0c5/lib/private/legacy/template.php#L120-L122

src/mixins/FetchCollectionsMixin.js

@@ -7,6 +7,7 @@ import { mapActions } from 'vuex'
 
 import AbortControllerMixin from './AbortControllerMixin.js'
 import { fetchCollections } from '../services/collectionFetcher.js'
+import logger from '../services/logger.js'
 
 export default {
 	name: 'FetchCollectionsMixin',
@@ -53,6 +54,7 @@ export default {
 				} else {
 					this.errorFetchingCollections = error
 				}
+				logger.error('Error fetching collections:', { error })
 			} finally {
 				this.loadingCollections = false
 			}

src/mixins/FetchFacesMixin.js

@@ -3,17 +3,22 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { mapActions, mapGetters } from 'vuex'
-
 import { showError } from '@nextcloud/dialogs'
 import { getCurrentUser } from '@nextcloud/auth'
+import { mapActions, mapGetters } from 'vuex'
+import he from 'he'
 
-import client from '../services/DavClient.js'
-import logger from '../services/logger.js'
-import DavRequest from '../services/DavRequest.js'
 import { genFileInfo } from '../utils/fileUtils.js'
+import logger from '../services/logger.js'
 import AbortControllerMixin from './AbortControllerMixin.js'
-import he from 'he'
+import { davClient } from '../services/DavClient.ts'
+import { getPropFind } from '../services/DavRequest.ts'
+
+const recognizeDAVProps = [
+	'nc:face-detections',
+	'nc:face-preview-image',
+	'nc:realpath',
+]
 
 export default {
 	name: 'FetchFacesMixin',
@@ -59,8 +64,8 @@ export default {
 				this.loadingFaces = true
 				this.errorFetchingFaces = null
 
-				const { data: faces } = await client.getDirectoryContents(`/recognize/${getCurrentUser()?.uid}/faces/`, {
-					data: DavRequest,
+				const { data: faces } = await davClient.getDirectoryContents(`/recognize/${getCurrentUser()?.uid}/faces/`, {
+					data: getPropFind(recognizeDAVProps),
 					details: true,
 					signal: this.abortController.signal,
 				})
@@ -94,13 +99,13 @@ export default {
 				this.errorFetchingFiles = null
 				this.loadingFiles = true
 
-				let { data: fetchedFiles } = await client.getDirectoryContents(
+				let { data: fetchedFiles } = await davClient.getDirectoryContents(
 					`/recognize/${getCurrentUser()?.uid}/faces/${faceName}`,
 					{
-						data: DavRequest,
+						data: getPropFind(recognizeDAVProps),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				fetchedFiles = fetchedFiles
@@ -146,13 +151,13 @@ export default {
 				this.errorFetchingFiles = null
 				this.loadingFiles = true
 
-				let { data: fetchedFiles } = await client.getDirectoryContents(
+				let { data: fetchedFiles } = await davClient.getDirectoryContents(
 					`/recognize/${getCurrentUser()?.uid}/unassigned-faces`,
 					{
-						data: DavRequest,
+						data: getPropFind(recognizeDAVProps),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				fetchedFiles = fetchedFiles
@@ -187,13 +192,13 @@ export default {
 
 		async fetchUnassignedFacesCount() {
 			try {
-				const { data: unassignedFacesRoot } = await client.stat(
+				const { data: unassignedFacesRoot } = await davClient.stat(
 					`/recognize/${getCurrentUser()?.uid}/unassigned-faces`,
 					{
-						data: DavRequest,
+						data: getPropFind(recognizeDAVProps),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				const count = Number(unassignedFacesRoot.props.nbItems)

src/mixins/FetchFilesMixin.js

@@ -3,8 +3,11 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { davGetClient, davRootPath } from '@nextcloud/files'
+import { showError } from '@nextcloud/dialogs'
+import { davRootPath } from '@nextcloud/files'
 import { joinPaths } from '@nextcloud/paths'
+
+import { davClient } from '../services/DavClient.ts'
 import logger from '../services/logger.js'
 import getPhotos from '../services/PhotoSearch.js'
 import SemaphoreWithPriority from '../utils/semaphoreWithPriority.js'
@@ -74,7 +77,7 @@ export default {
 				this.fetchedFileIds.push(
 					...fileIds
 						.map((fileId) => fileId.toString())
-						.filter((fileId) => !blacklist.includes(fileId))
+						.filter((fileId) => !blacklist.includes(fileId)),
 				)
 
 				this.$store.dispatch('appendFiles', fetchedFiles)
@@ -91,7 +94,7 @@ export default {
 						}
 						logger.debug(`The ${source} folder does not exist, creating it.`)
 						try {
-							await davGetClient().createDirectory(joinPaths(davRootPath, source))
+							await davClient.createDirectory(joinPaths(davRootPath, source))
 							this.resetFetchFilesState()
 							return []
 						} catch (error) {
@@ -106,7 +109,8 @@ export default {
 				}
 
 				// cancelled request, moving on...
-				logger.error('Error fetching files', { error })
+				showError(t('photos', 'Error fetching files'))
+				logger.error(error)
 			} finally {
 				this.loadingFiles = false
 				this.fetchSemaphore.release(fetchSemaphoreSymbol)

src/services/Albums.js

@@ -6,10 +6,10 @@
 import moment from '@nextcloud/moment'
 import { translate as t } from '@nextcloud/l10n'
 
-import defaultClient from '../services/DavClient.js'
 import logger from '../services/logger.js'
-import DavRequest from '../services/DavRequest.js'
 import { genFileInfo } from '../utils/fileUtils.js'
+import { davClient } from './DavClient.ts'
+import { getPropFind } from './DavRequest.ts'
 
 /**
  * @typedef {object} Album
@@ -51,7 +51,7 @@ function getDavRequest(extraProps = '') {
  * @param {import('webdav').WebDAVClient} client - The DAV client to use.
  * @return {Promise<Album|null>}
  */
-export async function fetchAlbum(path, options, extraProps = '', client = defaultClient) {
+export async function fetchAlbum(path, options, extraProps = '', client = davClient) {
 	try {
 		const response = await client.stat(path, {
 			data: getDavRequest(extraProps),
@@ -79,7 +79,7 @@ export async function fetchAlbum(path, options, extraProps = '', client = defaul
  * @param {import('webdav').WebDAVClient} client - The DAV client to use.
  * @return {Promise<Album[]>}
  */
-export async function fetchAlbums(path, options, extraProps = '', client = defaultClient) {
+export async function fetchAlbums(path, options, extraProps = '', client = davClient) {
 	try {
 		const response = await client.getDirectoryContents(path, {
 			data: getDavRequest(extraProps),
@@ -147,10 +147,10 @@ function formatAlbum(album) {
  * @param {import('webdav').WebDAVClient} client - The DAV client to use.
  * @return {Promise<Array>}
  */
-export async function fetchAlbumContent(path, options, client = defaultClient) {
+export async function fetchAlbumContent(path, options, client = davClient) {
 	try {
 		const response = await client.getDirectoryContents(path, {
-			data: DavRequest,
+			data: getPropFind(),
 			details: true,
 			...options,
 		})

src/services/DavClient.ts

@@ -0,0 +1,9 @@
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import type { WebDAVClient } from 'webdav'
+import { getClient } from '@nextcloud/files/dav'
+
+export const davClient: WebDAVClient = getClient()

src/services/DavRequest.ts

@@ -0,0 +1,38 @@
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { getDavProperties } from '@nextcloud/files/dav'
+
+/**
+ * Used to cache the props
+ */
+let props: string|null = null
+
+/**
+ * Get the default WebDAV properties
+ * This is cached for performance reasons
+ */
+export const getDefaultDavProps = () => {
+	if (props === null) {
+		props = getDavProperties()
+	}
+	return props
+}
+
+/**
+ * @param extraProps - Extra properties to add to the DAV request.
+ */
+export function getPropFind(extraProps: string[] = []): string {
+	return `<?xml version="1.0"?>
+			<d:propfind xmlns:d="DAV:"
+				xmlns:oc="http://owncloud.org/ns"
+				xmlns:nc="http://nextcloud.org/ns"
+				xmlns:ocs="http://open-collaboration-services.org/ns">
+				<d:prop>
+					${getDefaultDavProps()}
+					${extraProps.join('\n')}
+				</d:prop>
+			</d:propfind>`
+}