Merge pull request #170 from opencloud-eu/pick-ext-system-improvements

Pick ext system improvements

Author: kulmann

packages/extension-sdk/index.mjs

@@ -10,7 +10,7 @@ import { readFileSync } from 'fs'
 import vue from '@vitejs/plugin-vue'
 import serve from 'rollup-plugin-serve'
 
-const distDir = 'dist'
+const distDir = process.env.OPENCLOUD_EXTENSION_DIST_DIR || 'dist'
 
 const certsDir = process.env.OPENCLOUD_CERTS_DIR
 const defaultHttps = () =>

packages/web-client/src/helpers/resource/functions.ts

@@ -92,7 +92,10 @@ const convertObjectToCamelCaseKeys = (data: Record<string, any>) => {
   return converted
 }
 
-export function buildResource(resource: WebDavResponseResource): Resource {
+export function buildResource(
+  resource: WebDavResponseResource,
+  extraPropNames: string[] = []
+): Resource {
   const name = resource.props[DavProperty.Name]?.toString() || basename(resource.filename)
   const id = resource.props[DavProperty.FileId]
 
@@ -128,6 +131,16 @@ export function buildResource(resource: WebDavResponseResource): Resource {
     }
   }
 
+  const extraProps: Record<string, unknown> = {}
+  for (const name of extraPropNames || []) {
+    // only use the tag name, the namespace is ignored by our WebDav library
+    // https://github.com/perry-mitchell/webdav-client/issues/210
+    const extraPropName = name.split(':').pop()
+    if (resource.props[extraPropName]) {
+      extraProps[name] = resource.props[extraPropName]
+    }
+  }
+
   const r = {
     id,
     fileId: id,
@@ -166,6 +179,7 @@ export function buildResource(resource: WebDavResponseResource): Resource {
     location: convertObjectToCamelCaseKeys(resource.props[DavProperty.Location]),
     image: convertObjectToCamelCaseKeys(resource.props[DavProperty.Image]),
     photo: convertObjectToCamelCaseKeys(resource.props[DavProperty.Photo]),
+    extraProps,
     canUpload: function () {
       return this.permissions.indexOf(DavPermission.FolderCreateable) >= 0
     },

packages/web-client/src/helpers/resource/types.ts

@@ -78,6 +78,7 @@ export interface Resource {
   privateLink?: string
   owner?: Identity
   extension?: string
+  extraProps?: Record<string, unknown>
 
   // necessary for incoming share resources and resources inside shares
   remoteItemId?: string

packages/web-client/src/webdav/client/builders.ts

@@ -1,25 +1,36 @@
 import { XMLBuilder } from 'fast-xml-parser'
 import { DavProperties, DavPropertyValue } from '../constants'
 
-const getNamespacedDavProps = (obj: Partial<Record<DavPropertyValue, unknown>>) => {
-  return Object.keys(obj).reduce<Record<string, unknown>>((acc, val) => {
-    const davNamespace = DavProperties.DavNamespace.includes(val as DavPropertyValue)
-    acc[davNamespace ? `d:${val}` : `oc:${val}`] = obj[val as DavPropertyValue] || ''
-    return acc
-  }, {})
+const getNamespacedDavProps = (
+  obj: Partial<Record<DavPropertyValue, unknown>>,
+  extraProps: string[]
+) => {
+  return Object.fromEntries(
+    Object.entries(obj).map(([name, value]) => {
+      if (extraProps.includes(name)) {
+        return [name, value || '']
+      }
+
+      const davNamespace = DavProperties.DavNamespace.includes(name as unknown as DavPropertyValue)
+      const propName = davNamespace ? `d:${name}` : `oc:${name}`
+      return [propName, value || '']
+    })
+  )
 }
 
 export const buildPropFindBody = (
   properties: DavPropertyValue[] = [],
   {
     pattern,
     filterRules,
-    limit = 0
+    limit = 0,
+    extraProps = []
   }: {
     pattern?: string
     filterRules?: Partial<Record<DavPropertyValue, unknown>>
     limit?: number
-  } = {}
+    extraProps: string[]
+  }
 ): string => {
   let bodyType = 'd:propfind'
   if (pattern) {
@@ -31,7 +42,7 @@ export const buildPropFindBody = (
   }
 
   const object = properties.reduce((obj, item) => Object.assign(obj, { [item]: null }), {})
-  const props = getNamespacedDavProps(object)
+  const props = getNamespacedDavProps(object, extraProps)
 
   const xmlObj = {
     [bodyType]: {
@@ -42,7 +53,7 @@ export const buildPropFindBody = (
         'oc:search': { 'oc:pattern': pattern, 'oc:limit': limit }
       }),
       ...(filterRules && {
-        'oc:filter-rules': getNamespacedDavProps(filterRules)
+        'oc:filter-rules': getNamespacedDavProps(filterRules, [])
       })
     }
   }
@@ -62,7 +73,7 @@ export const buildPropPatchBody = (
 ): string => {
   const xmlObj = {
     'd:propertyupdate': {
-      'd:set': { 'd:prop': getNamespacedDavProps(properties) },
+      'd:set': { 'd:prop': getNamespacedDavProps(properties, []) },
       '@@xmlns:d': 'DAV:',
       '@@xmlns:oc': 'http://owncloud.org/ns'
     }

packages/web-client/src/webdav/client/dav.ts

@@ -34,11 +34,13 @@ export class DAV {
   private client: WebDAVClient
   private davPath: string
   private headers: () => Headers
+  public extraProps: string[]
 
   constructor({ baseUrl, headers }: DAVOptions) {
     this.davPath = urlJoin(baseUrl, 'remote.php/dav')
     this.client = createClient(this.davPath, {})
     this.headers = headers
+    this.extraProps = []
   }
 
   public mkcol(path: string, opts: DAVRequestOptions = {}) {
@@ -57,7 +59,7 @@ export class DAV {
     const requestHeaders = { ...headers, Depth: depth.toString() }
     const { body, result } = await this.request(path, {
       method: DavMethod.propfind,
-      data: buildPropFindBody(properties),
+      data: buildPropFindBody(properties, { extraProps: this.extraProps }),
       headers: requestHeaders,
       ...opts
     })
@@ -87,7 +89,12 @@ export class DAV {
   ) {
     const { body, result } = await this.request(path, {
       method: DavMethod.report,
-      data: buildPropFindBody(properties, { pattern, filterRules, limit }),
+      data: buildPropFindBody(properties, {
+        pattern,
+        filterRules,
+        limit,
+        extraProps: this.extraProps
+      }),
       ...opts
     })
 

packages/web-client/src/webdav/index.ts

@@ -37,7 +37,11 @@ export const webdav = (baseURI: string, headers?: () => Headers): WebDAV => {
   }
 
   const options = { axiosClient, baseUrl: baseURI, headers }
+
   const dav = new DAV({ baseUrl: baseURI, headers })
+  const registerExtraProp = (name: string) => {
+    dav.extraProps.push(name)
+  }
 
   const pathForFileIdFactory = GetPathForFileIdFactory(dav, options)
   const { getPathForFileId } = pathForFileIdFactory
@@ -91,6 +95,8 @@ export const webdav = (baseURI: string, headers?: () => Headers): WebDAV => {
     clearTrashBin,
     search,
     listFavoriteFiles,
-    setFavorite
+    setFavorite,
+
+    registerExtraProp
   }
 }

packages/web-client/src/webdav/listFileVersions.ts

@@ -11,7 +11,7 @@ export const ListFileVersionsFactory = (dav: DAV, options: WebDavOptions) => {
         urlJoin('meta', id, 'v', { leadingSlash: true }),
         opts
       )
-      return versions.map(buildResource)
+      return versions.map((v) => buildResource(v, dav.extraProps))
     }
   }
 }

packages/web-client/src/webdav/listFiles.ts

@@ -91,10 +91,10 @@ export const ListFilesFactory = (
               driveAlias: space.driveAlias,
               webDavPath: space.webDavPath
             }),
-            children: children.map(buildResource)
+            children: children.map((c) => buildResource(c, dav.extraProps))
           } as ListFilesResult
         }
-        const resources = webDavResources.map(buildResource)
+        const resources = webDavResources.map((r) => buildResource(r, dav.extraProps))
         return { resource: resources[0], children: resources.slice(1) } as ListFilesResult
       }
 
@@ -118,11 +118,13 @@ export const ListFilesFactory = (
         })
         if (isTrash) {
           return {
-            resource: buildResource(webDavResources[0]),
+            resource: buildResource(webDavResources[0], dav.extraProps),
             children: webDavResources.slice(1).map(buildDeletedResource)
           } as ListFilesResult
         }
-        const resources = webDavResources.map(buildResource)
+
+        const resources = webDavResources.map((r) => buildResource(r, dav.extraProps))
+
         const resourceIsSpace = fileId === space.id
         if (fileId && !resourceIsSpace && fileId !== resources[0].fileId) {
           return listFilesCorrectedPath()

packages/web-client/src/webdav/search.ts

@@ -29,7 +29,7 @@ export const SearchFactory = (dav: DAV, options: WebDavOptions) => {
 
       return {
         resources: results.map((r) => ({
-          ...buildResource(r),
+          ...buildResource(r, dav.extraProps),
           highlights: r.props[DavProperty.Highlights] || ''
         })),
         totalResults: range ? parseInt(range?.split('/')[1]) : null

packages/web-client/src/webdav/types.ts

@@ -45,4 +45,10 @@ export interface WebDAV {
   search: ReturnType<typeof SearchFactory>['search']
   listFavoriteFiles: ReturnType<typeof ListFavoriteFilesFactory>['listFavoriteFiles']
   setFavorite: ReturnType<typeof SetFavoriteFactory>['setFavorite']
+
+  // register prop that will be added to resource.extraProps if available in a response
+  // because of a limitation in our WebDAV library, we cannot differentiate between
+  // the same tag in two different namespaces. Make sure to use unique tag names despite
+  // differing namespaces.
+  registerExtraProp(name: string)
 }