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

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

Author: susnux

src/components/Albums/CollaboratorsSelectionForm.vue

@@ -349,7 +349,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

@@ -84,7 +84,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/mixins/FetchFacesMixin.js

@@ -20,17 +20,16 @@
  *
  */
 
-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'
 
 export default {
 	name: 'FetchFacesMixin',
@@ -76,8 +75,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(),
 					details: true,
 					signal: this.abortController.signal,
 				})
@@ -111,13 +110,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(),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				fetchedFiles = fetchedFiles
@@ -163,13 +162,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(),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				fetchedFiles = fetchedFiles
@@ -204,13 +203,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(),
 						details: true,
 						signal: this.abortController.signal,
-					}
+					},
 				)
 
 				const count = Number(unassignedFacesRoot.props.nbItems)

src/mixins/FetchFilesMixin.js

@@ -20,8 +20,11 @@
  *
  */
 
-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'
@@ -91,7 +94,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)
@@ -105,7 +108,7 @@ export default {
 					const source = joinPaths(davRootPath, store.state.userConfig.photosSourceFolder ?? '/Photos') + '/'
 					logger.debug('Photo source does not exist, creating it.')
 					try {
-						await davGetClient().createDirectory(source)
+						await davClient.createDirectory(source)
 					} catch (error) {
 						logger.error('Fail to create source directory', { error })
 					}
@@ -116,8 +119,8 @@ export default {
 				}
 
 				// cancelled request, moving on...
-				logger.error('Error fetching files', { error })
-				console.error(error)
+				showError(t('photos', 'Error fetching files'))
+				logger.error(error)
 			} finally {
 				this.loadingFiles = false
 				this.fetchSemaphore.release(fetchSemaphoreSymbol)

src/services/Albums.js

@@ -23,10 +23,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
@@ -68,7 +68,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),
@@ -96,7 +96,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),
@@ -164,10 +164,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.js

@@ -1,7 +1,7 @@
 /**
- * @copyright Copyright (c) 2019 John Molakvoæ <[email protected]>
+ * @copyright Copyright (c) 2024 Ferdinand Thiessen <[email protected]>
  *
- * @author John Molakvoæ <[email protected]>
+ * @author Ferdinand Thiessen <[email protected]>
  *
  * @license AGPL-3.0-or-later
  *
@@ -20,25 +20,7 @@
  *
  */
 
-import client, { prefixPath } from './DavClient.js'
-import request from './DavRequest.js'
-import { genFileInfo } from '../utils/fileUtils.js'
+import type { WebDAVClient } from 'webdav'
+import { davGetClient } from '@nextcloud/files'
 
-/**
- * Get a file info
- *
- * @param {string} path the path relative to the user root
- * @return {FileInfo} the file info
- */
-export default async function(path) {
-	// getDirectoryContents doesn't accept / for root
-	const fixedPath = path === '/' ? '' : path
-
-	// fetch listing
-	const response = await client.stat(prefixPath + fixedPath, {
-		data: request,
-		details: true,
-	})
-
-	return genFileInfo(response.data)
-}
+export const davClient: WebDAVClient = davGetClient()

src/services/FileInfo.js renamed to src/services/DavClient.ts

@@ -2,6 +2,7 @@
  * @copyright Copyright (c) 2019 John Molakvoæ <[email protected]>
  *
  * @author John Molakvoæ <[email protected]>
+ * @author Ferdinand Thiessen <[email protected]>
  *
  * @license AGPL-3.0-or-later
  *
@@ -19,34 +20,48 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-const props = `
-	<d:getcontentlength />
-	<d:getcontenttype />
-	<d:getetag />
-	<d:getlastmodified />
-	<d:resourcetype />
-	<nc:face-detections />
-	<nc:face-preview-image />
-	<nc:metadata-photos-size />
-	<nc:metadata-photos-original_date_time />
-	<nc:metadata-files-live-photo />
-	<nc:metadata-blurhash/>
-	<nc:has-preview />
-	<nc:realpath />
-	<nc:hidden />
-	<oc:favorite />
-	<oc:fileid />
-	<oc:permissions />
-	<nc:nbItems />
-`
 
-export { props }
-export default `<?xml version="1.0"?>
+import { getDavProperties, registerDavProperty } from '@nextcloud/files'
+
+const photoDavProps = [
+	'face-detections',
+	'face-preview-image',
+	'metadata-photos-size',
+	'metadata-photos-original_date_time',
+	'metadata-files-live-photo',
+	'metadata-blurhash',
+	'realpath',
+	'nbItems',
+]
+
+/**
+ * Used to cache the props
+ */
+let props: string|null = null
+
+/**
+ * Get the default props
+ */
+const getDefaultDavProps = () => {
+	if (props === null) {
+		photoDavProps.forEach(prop => registerDavProperty(prop))
+		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>
-					${props}
+					${getDefaultDavProps()}
+					${extraProps.join('\n')}
 				</d:prop>
 			</d:propfind>`
+}