Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: handle quick link copy action in resources list on safari #10401

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions packages/web-pkg/src/components/CreateLinkModal.vue
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ export default defineComponent({
space: { type: Object as PropType<SpaceResource>, default: undefined },
isQuickLink: { type: Boolean, default: false },
callbackFn: {
type: Function as PropType<(result: PromiseSettledResult<Share>[]) => Promise<void> | void>,
type: Function as PropType<(promise: Promise<string | null>) => Promise<void> | void>,
default: undefined
}
},
Expand Down Expand Up @@ -278,7 +278,7 @@ export default defineComponent({
)
}

const onConfirm = async () => {
const handleLinksCreation = async (): Promise<string | null> => {
if (!unref(selectedRoleIsInternal)) {
if (unref(passwordEnforced) && !unref(password).value) {
password.error = $gettext('Password must not be empty')
Expand All @@ -292,11 +292,13 @@ export default defineComponent({

const result = await createLinks()

const succeeded = result.filter(({ status }) => status === 'fulfilled')
const succeeded = result.filter(
({ status }) => status === 'fulfilled'
) as PromiseFulfilledResult<Share>[]
if (succeeded.length && unref(isEmbedEnabled)) {
postMessage<string[]>(
'owncloud-embed:share',
(succeeded as PromiseFulfilledResult<Share>[]).map(({ value }) => value.url)
succeeded.map(({ value }) => value.url)
)
}

Expand All @@ -319,9 +321,17 @@ export default defineComponent({
return Promise.reject()
}

Promise.resolve(succeeded[0]?.value.url ?? null)
}

const onConfirm = async () => {
if (props.callbackFn) {
props.callbackFn(result)
props.callbackFn(handleLinksCreation)

return
}

await handleLinksCreation()
}

expose({ onConfirm })
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export const useFileActionsCopyQuickLink = () => {
unref(createLinkActions).find(({ name }) => name === 'create-quick-links')
)

const copyQuickLinkToClipboard = async (url: string) => {
const copyQuickLinkToClipboard = async (url: string | (() => Promise<string>)) => {
try {
await copyToClipboard(url)
showMessage({ title: $gettext('The link has been copied to your clipboard.') })
Expand All @@ -63,17 +63,18 @@ export const useFileActionsCopyQuickLink = () => {
include_tags: false
})

return linkSharesForResource
.map((share: any) => buildShare(share.shareInfo, null, null))
.find((share: Share) => share.quicklink === true)
return (
linkSharesForResource
.map((share: any) => buildShare(share.shareInfo, null, null))
.find((share: Share) => share.quicklink === true)?.url || null
)
}

const handler = async ({ space, resources }: FileActionOptions) => {
const handler = ({ space, resources }: FileActionOptions) => {
const [resource] = resources

const existingQuickLink = await getExistingQuickLink(resource)
if (existingQuickLink) {
return copyQuickLinkToClipboard(existingQuickLink.url)
if (ShareTypes.containsAnyValue(ShareTypes.unauthenticated, resource.shareTypes ?? [])) {
return copyQuickLinkToClipboard(getExistingQuickLink.bind(this, resource))
}

return unref(createQuicklinkAction).handler({ space, resources })
Expand Down
79 changes: 59 additions & 20 deletions packages/web-pkg/src/composables/clipboard/useClipboard.ts
Original file line number Diff line number Diff line change
@@ -1,27 +1,66 @@
import { useClipboard as _useClipboard } from '@vueuse/core'

export const useClipboard = () => {
// doCopy creates the requested link and copies the url to the clipboard,
// the copy action uses the clipboard // clipboardItem api to work around the webkit limitations.
//
// https://developer.apple.com/forums/thread/691873
//
// if those apis not available (or like in firefox behind dom.events.asyncClipboard.clipboardItem)
// it has a fallback to the vue-use implementation.
//
// https://webkit.org/blog/10855/
const copyToClipboard = (quickLinkUrl: string) => {
if (typeof ClipboardItem && navigator?.clipboard?.write) {
return navigator.clipboard.write([
new ClipboardItem({
'text/plain': new Blob([quickLinkUrl], { type: 'text/plain' })
})
])
} else {
const { copy } = _useClipboard({ legacy: true })
return copy(quickLinkUrl)
}
/**
* Copies given text into clipboard
*
* @remarks the copy action uses the clipboard // clipboardItem api to work around the webkit limitations.(https://developer.apple.com/forums/thread/691873) if those apis not available (or like in firefox behind dom.events.asyncClipboard.clipboardItem). it has a fallback to the vue-use implementation. (https://webkit.org/blog/10855/)
*
* @param quickLinkUrl If the text is supposed to be resolved via a promise, pass the promise directly and resolve it to string
* @returns resolves whether the text has been copied into clipboard (e.g. whether the quickLinkUrl function resolved into a string or not)
*/
const copyToClipboard = (
quickLinkUrl: string | (() => Promise<string | null | undefined>)
): Promise<boolean> => {
return new Promise<boolean>(async (resolve) => {
try {
if (typeof ClipboardItem && navigator?.clipboard?.write) {
const blob =
typeof quickLinkUrl === 'function'
? quickLinkUrl().then((text) => {
if (!text) {
throw new EmptyTextError('No text received')
}

return new Blob([text], { type: 'text/plain' })
})
: new Blob([quickLinkUrl], { type: 'text/plain' })

await navigator.clipboard.write([
new ClipboardItem({
'text/plain': blob
})
])

resolve(true)
return
}

const { copy } = _useClipboard({ legacy: true })
const text = typeof quickLinkUrl === 'function' ? await quickLinkUrl() : quickLinkUrl

await copy(text)
resolve(true)
} catch (error) {
if (error instanceof EmptyTextError) {
resolve(false)

return
}

// A real error happened
throw error
}
})
}

return { copyToClipboard }
}

class EmptyTextError extends Error {
constructor(msg) {
super(msg)

this.name = 'ClipboardEmptyTextError'
}
}