feat: implement user mentions in Collabora docs

Users can be mentioned with `@` in Collabora documents, triggering a
notification to the mentioned user.

Also refactors all Collabora postMessage stuff to a dedicated
composable.

Author: JammingBen

packages/web-app-external/src/App.vue

@@ -42,6 +42,7 @@ import {
   unref,
   nextTick,
   ref,
+  toRef,
   watch,
   onMounted,
   useTemplateRef,
@@ -73,15 +74,10 @@ import {
   useSpacesStore,
   useClientService,
   useSharesStore,
-  useModals,
-  useRouter,
-  useThemeStore,
-  useFolderLink,
-  FilePickerModal
+  useThemeStore
 } from '@opencloud-eu/web-pkg'
-import FileNameModal from './components/FileNameModal.vue'
-import { DavProperty } from '@opencloud-eu/web-client/webdav'
 import { storeToRefs } from 'pinia'
+import { useCollaboraPostMessages } from './composables'
 
 const { space, resource, isReadOnly } = defineProps<{
   space: SpaceResource
@@ -97,16 +93,13 @@ const { showErrorMessage } = useMessages()
 const capabilityStore = useCapabilityStore()
 const configStore = useConfigStore()
 const route = useRoute()
-const router = useRouter()
 const appProviderService = useAppProviderService()
 const { makeRequest } = useRequest()
 const spacesStore = useSpacesStore()
 const sharesStore = useSharesStore()
-const { graphAuthenticated: graphClient, webdav } = useClientService()
-const { dispatchModal } = useModals()
+const { graphAuthenticated: graphClient } = useClientService()
 const themeStore = useThemeStore()
 const { currentTheme } = storeToRefs(themeStore)
-const { getParentFolderLink } = useFolderLink()
 
 const viewModeQuery = useRouteQuery('view_mode')
 const viewModeQueryValue = computed(() => {
@@ -260,166 +253,13 @@ const catchClickMicrosoftEdit = (event: MessageEvent) => {
   } catch {}
 }
 
-const handlePostMessagesCollabora = async (event: MessageEvent) => {
-  try {
-    const message = JSON.parse(event.data || '{}')
-
-    if (message.MessageId === 'App_LoadingStatus') {
-      postMessageToCollabora('Hide_Button', { id: 'toggledarktheme' })
-
-      if (message.Values?.Status === 'Frame_Ready') {
-        postMessageToCollabora('Host_PostmessageReady')
-      }
-      return
-    }
-
-    if (message.MessageId === 'UI_SaveAs') {
-      if (Object.hasOwn(message.Values, 'format')) {
-        dispatchModal({
-          title: $gettext('Export »%{name}« as %{format}', {
-            name: resource.name,
-            format: message.Values.format
-          }),
-          customComponent: FileNameModal,
-          customComponentAttrs: () => ({
-            space,
-            resource,
-            fileExtension: message.Values.format,
-            callbackFn: (newFileName: string) => {
-              postMessageToCollabora('Action_SaveAs', {
-                Filename: newFileName,
-                Notify: true
-              })
-            }
-          })
-        })
-        return
-      }
-
-      dispatchModal({
-        title: $gettext('Save »%{name}« with new name', { name: resource.name }),
-        customComponent: FileNameModal,
-        customComponentAttrs: () => ({
-          space,
-          resource,
-          callbackFn: (newFileName: string) => {
-            postMessageToCollabora('Action_SaveAs', {
-              Filename: newFileName,
-              Notify: true
-            })
-          }
-        })
-      })
-      return
-    }
-
-    if (message.MessageId === 'Action_Save_Resp') {
-      if (!message.Values?.fileName) {
-        return
-      }
-
-      // FIXME: when we move to id based propfinds we magically need a fileId for the new file. Collabora doesn't provide that.
-      const newFile = await webdav.getFileInfo(space, {
-        path:
-          resource.path.substring(0, resource.path.length - resource.name.length) +
-          message.Values.fileName,
-        fileId: undefined
-      })
-      await router.push({
-        name: unref(route).name,
-        params: {
-          ...unref(route).params,
-          driveAliasAndItem: queryItemAsString(unref(route).params.driveAliasAndItem).replace(
-            resource.name,
-            newFile.name
-          )
-        },
-        query: {
-          ...unref(route).query,
-          fileId: newFile.fileId
-        }
-      })
-      return
-    }
-
-    if (message.MessageId === 'UI_InsertGraphic') {
-      dispatchModal({
-        elementClass: 'file-picker-modal',
-        title: $gettext('Insert graphic'),
-        customComponent: FilePickerModal,
-        hideActions: true,
-        customComponentAttrs: () => ({
-          parentFolderLink: getParentFolderLink(resource),
-          allowedFileTypes: ['image/png', 'image/gif', 'image/jpeg', 'image/svg'],
-          callbackFn: async ({ resource }: { resource: Resource }) => {
-            const { downloadURL: url } = await webdav.getFileInfo(space, resource, {
-              davProperties: [DavProperty.DownloadURL]
-            })
-
-            postMessageToCollabora('Action_InsertGraphic', { url })
-          }
-        }),
-        focusTrapInitial: false
-      })
-      return
-    }
-
-    if (message.MessageId === 'UI_InsertFile') {
-      const callback = message.Values?.callback
-      const mimeTypeFilter = message.Values?.mimeTypeFilter
-
-      dispatchModal({
-        elementClass: 'file-picker-modal',
-        title:
-          callback === 'Action_CompareDocuments'
-            ? $gettext('Select document to compare')
-            : $gettext('Insert file'),
-        customComponent: FilePickerModal,
-        hideActions: true,
-        customComponentAttrs: () => ({
-          parentFolderLink: getParentFolderLink(resource),
-          allowedFileTypes: mimeTypeFilter || [],
-          callbackFn: async ({ resource }: { resource: Resource }) => {
-            const { downloadURL: url } = await webdav.getFileInfo(space, resource, {
-              davProperties: [DavProperty.DownloadURL]
-            })
-
-            const values: Record<string, unknown> = { url }
-            if (callback === 'Action_CompareDocuments') {
-              values.filename = resource.name
-            }
-
-            postMessageToCollabora(callback, values)
-          }
-        }),
-        focusTrapInitial: false
-      })
-      return
-    }
+const appIframeRef = useTemplateRef<HTMLIFrameElement>('appIframe')
 
-    if (message.MessageId === 'UI_PickLink') {
-      dispatchModal({
-        elementClass: 'file-picker-modal',
-        title: $gettext('Pick a file to link'),
-        customComponent: FilePickerModal,
-        hideActions: true,
-        customComponentAttrs: () => ({
-          parentFolderLink: getParentFolderLink(resource),
-          allowedFileTypes: [],
-          callbackFn: ({ resource }: { resource: Resource }) => {
-            postMessageToCollabora('Action_InsertLink', {
-              url: resource.privateLink,
-              text: resource.name
-            })
-          }
-        }),
-        focusTrapInitial: false
-      })
-    }
-  } catch (e) {
-    console.debug('Error parsing Collabora PostMessage', e)
-  }
-}
+const { handlePostMessagesCollabora, resetMentionState } = useCollaboraPostMessages({
+  space: toRef(() => space),
+  resource: toRef(() => resource),
+  appIframeRef
+})
 
 onMounted(() => {
   if (determineOpenAsPreview(unref(appName))) {
@@ -439,30 +279,14 @@ onBeforeUnmount(() => {
   }
 })
 
-const appIframeRef = useTemplateRef<HTMLIFrameElement>('appIframe')
-const postMessageToCollabora = (messageId: string, values?: { [key: string]: unknown }): void => {
-  if (!unref(appIframeRef)) {
-    console.error('Collabora iframe not found')
-    return
-  }
-
-  return unref(appIframeRef).contentWindow.postMessage(
-    JSON.stringify({
-      MessageId: messageId,
-      SendTime: Date.now(),
-      ...(values && { Values: values })
-    }),
-    '*'
-  )
-}
-
 watch(
   () => resource,
   async (newResource, oldResource) => {
     if (isSameResource(newResource, oldResource)) {
       return
     }
 
+    resetMentionState()
     let viewMode = 'read'
 
     if (isShareSpaceResource(space)) {

packages/web-app-external/src/composables/index.ts

@@ -1 +1,2 @@
 export * from './createFileHandler'
+export * from './useCollaboraPostMessages'