The document compare view in Collabora Online Writer allows comparing documents side by side, see the first post for more info about the feature in general.

This second post is meant to give you an update on what happened in this area in the last month.

Motivation¶

Collabora Online core supports showing or hiding tracked changes in document content, we have a UI button for that, see the notebookbar's Review tab, the Tracking section's Show button.

Entering doc compare mode or leaving it works by clicking on the View Changes button, in the same section.

But this means that you can show/hide changes (modifies the document layout, affects everyone) and also view them (only affects your view), and they do quite different things. :-)

Results so far¶

The new UI has a button with a drop-down: the button is toggle that reflects if you compare change side-by-side or not. And if you click the drop-down next to the button, it's clear that show/hide is for inline rendering in the document layout while the other option is to render changes side-by-side:

While this used to look like this:

There were also a number of other smaller improvements: now side-by-side rendering works nicely if you use IME to type characters, a missing invalidation is sorted out and side-by-side rendering is better with comments.

How is this implemented?¶

If you would like to know a bit more about how this works, continue reading... :-)

As usual, the high-level problem was addressed by a series of small changes. Core side:

• tdf#171191 sw redline render mode: fix crash on IME input

COOL side:

• browser, document compare: annotate overriding functions with 'override'
• cool#14940 document compare: merge Show and View Changes buttons into a single menu button
• cool#14990 document compare: fix lost mode=2 full invalidations
• cool#15195 document compare: fix bad vertical position of comments on scrolling
• cool#15195 document compare: fix bad horizontal position of comments

Want to start using this?¶

You can get a development edition of Collabora Online 25.04 and try it out yourself right now: try the development edition.

If you have two documents or two versions of a document to compare, then traditional tracked changes is too late, the untracked changes are already in the document.

This work for Collabora Online adds interactive a non-interactive document compare to create tracked changes after the fact, finally introduces a document compare view, to better understand these changes.

Motivation¶

Collabora Online's core already contained a document compare feature, but this was never integrated with the SDK (REST API) or with the browser UI.

Additionally, while some users took a training in understanding track changes (or: redlines), the usage of underlines for inserts and strike-throughs for deletions may not be obvious. An alternative of this is a side-by-side view, which is now available in Collabora Online for text documents.

Results so far¶

Non-interactive document compare¶

See the SDK, now you can convert e.g. an editable (new) docx file to PDF in a way that your request references your old docx file as a parameter, and the resulting PDF shows the differences:

curl -k -F "data=@new.docx" -F "compare=@old.docx" -F "format=pdf" -o out.pdf https://localhost:9980/cool/convert-to

Interactive document compare¶

Technically this is a bit similar to image insertion: once you open your new document, you can compare its content with an old local or remote document:

Just use the Compare button on the Review tab on the notebookbar.

Document compare view¶

We worked with Gokay to build this. The LOK API now provides "tile modes" for text documents, similar to how presentations already have tile modes for slide content, master pages and notes. The default tile mode is unchanged for text documents, but the Review tab of the notebookbar has a View Changes button and then the new left hand side, right hand side tile modes allow you to show the changes side by side:

Removed content is colored with a red-like color, added content is colored with a green-like color. The matching content on the other side is gray. This is not only for text, e.g. images have a frame with a similar color.

Now that the LOK API could provide tiles either left or right hand side mode, Gokay built a whole new tile layout on the browser side, so these are shown nicely side by side.

To better understand what you see on your screen, now there are also labels at the top of the first pages:

This describes the purposes of the two sides, and in case you're right after a document compare action, also shows you the file names, modification dates and author names.

For integrators, it's possible to start in this mode by default, if you append &comparechanges=1 to COOL's iframe URL.

Finally if you hover over a tracked change with your mouse, now you get a highlight for that piece of text on both sides, to match the same parts of the old and new version better. A deletion looks like this:

This also works for inserts:

How is this implemented?¶

If you would like to know a bit more about how this works, continue reading... :-)

As usual, the high-level problem was addressed by a series of small changes. Core side:

• cool#13574 sw lok: introduce a redline render mode view option
• cool#13574 sw lok: improve non-standard redline render mode colors
• cool#13574 sw lok: increase saturation of non-standard redline render mode
• cool#13574 sw redline render mode: add uno command to switch from standard
• cool#13574 sw redline render mode: send LOK status
• cool#13574 sw redline render mode: invalidate both omit modes together
• cool#13574 sw redline render mode: avoid coloring, set lightness
• cool#13574 sw redline render mode: extract SwTextPaintOmitter from text painter
• cool#13988 sw redline render mode: handle anchored images
• cool#13574 sw redline render mode: somewhat color ins/del as green/red
• cool#13988 sw redline render mode: handle inline images
• cool#13988 sw redline render mode: add colored border for anchored images
• cool#13988 sw redline render mode: add colored border for inline images
• cool#13988 sw redline render mode: handle moves
• cool#13988 sw redline render mode: table row redlines
• cool#13988 sw redline render mode: handle number portions
• cool#13988 sw redline render mode: handle tab portions
• cool#13988 sw redline render mode: expose old/new author/date when comparing
• cool#13988 sw redline tooltip LOK API: expose anchor range

COOL side:

• cool#4535 convert-to compare option: introduce 'additional files'
• cool#4535 convert-to compare option: insert old reference doc before save
• cool#4535 convert-to compare option: add testcase
• cool#13574 redline render mode: send statusupdate with mode=2 when entering doc compare mode
• cool#13574 redline render mode: fix missing invalidate after the 2nd enter
• cool#13574 redline render mode: extract sendTileCombineMessage() from sendTileCombineRequest()
• cool#13574 redline render mode: request mode=1 tiles on requesting mode=2 tiles
• cool#13988 browser: fire comparedocuments event on selecting a file for doc compare purposes
• cool#13988 browser, on comparedocuments: send insertfile websocket message
• cool#13988 kit, insert file: handle the comparedocuments type
• cool#13988 doc compare: add testcase
• cool#13988 doc compare, browser: add a new Action_CompareDocuments PostMessage
• cool#13988 doc compare, kit: handle comparedocumentsurl file insertion
• cool#14093 browser: show the user name of other text cursors on mouse hover
• cool#14093 add testcase
• cypress, cursor header section: improve testability
• cool#14299 redline render mode: change notebookbar button type to bigcustomtoolitem
• cool#13988 redline render mode: add a HTTP parameter to activate this mode on load
• cool#13988 redline render mode: fix TilesMiddleware.getMissingTiles()
• cool#13988 redline render mode: improve TilesMiddleware.updateTileDistance()
• cool#13988 redline render mode: fix the HTTP GET parameter
• cool#13988 redline render mode: add missing tiles testcase
• cool#13988 redline render mode: add a new CompareChangesLabelSection
• cool#13988 redline render mode: scroll CompareChangesLabelSection
• cool#13988 redline render mode: labels can be now multiline
• cool#13988 redline render mode: display author / modification date for both sides
• cool#13988 redline render mode: deduplicate the label setup code for the two sides
• cool#13988 redline render mode: center the title vertically when we have no subtitle
• cool#13988 redline render mode: avoid doc name when just viewing tracked changes
• cool#13988 redline render mode: switch to gray/blue backgrounds for the labels
• cool#13988 redline render mode: show the old file name in the old label after local compare
• cool#13988 redline render mode: try to avoid DOM node touch while drawing
• cool#13988 redline render mode: show the old file name also with a remote compare
• cool#13988 redline render mode: fix insert/delete tooltip
• cool#13988 redline render mode: extract common code from ContentControlSection to CanvasSectionObject
• cool#13988 redline render mode: add a new TooltipAnchorSection
• cool#13988 redline render mode: add dynamic color for the tooltip anchor section
• cool#13988 redline render mode: don't highlight redline ranges by default
• cool#13770 windows: use LOK's new registerFileSaveDialogCallback()
• cool#13988 redline render mode: highlight both sides
• cool#13988 redline render mode: adjust highlight color to text color
• cool#13988 redline render mode: work with last used tile mode when showing tooltip
• cool#13988 redline render mode: add tooltip anchor section cypress test
• Related: cool#14716 document compare: fix position of the context toolbar
• Related: cool#14716 document compare: add context toolbar position test
• cool#14716 document compare: fix bad tile position after zoom change

Want to start using this?¶

You can get a development edition of Collabora Online 25.04 and try it out yourself right now: try the development edition.

LibreOffice Technology had the concept of digital signing, but this was not available in Collabora Online, so it was not possible to combine this with collaborative editing. Also, once Collabora Online started to expose digital signing with software certificates for ODF files, that also allowed taking a further step and start supporting electronic signing for PDF files. Partnering with eID Easy, you can create strongest of the electronic signatures – the mighty QES. This means signing with Collabora Online allows you to:

• create proper electronic signatures
• not share your document with a 3rd-party, only the hash of your PDF will be sent to the external service
• integrate with e.g. Nextcloud, use the feature without installing anything other than the Nextcloud AIO image
• potentially combine signing with other security features like Secure View and
• work with visual signing in a WYSIWYG way, which allows placing a visible signature widget at the specified page, then dragging it to the preferred position.

The sample integration presented here is for Nextcloud, but the feature can be made available in other integrations as well.

See Collabora's blog post if you prefer less technical information about this feature.

Motivation¶

Digital and electronic signing of documents is meant to be based on cryptographic security, and traditionally this has been exposed to users in a very complex way. You need to know that first you have to sign your macros and only then your document, you need to somehow get PEM files to have a signing certificate, you need to somehow get your certificate trusted by some certificate authority that is commonly trusted by other people who will verify your signature, and so on.

This lead to the need to first support digital signatures in COOL using a single signatures dialog for ODF files and then later to provide electronic visual signing for PDF files, while continuing to respect your privacy by not sharing your document with a 3rd-party service.

Results so far¶

A read-write signatures dialog¶

First the signature viewer dialog was turned into a read-write digital signatures dialog in COOL that is still async (compatible with collaborative editing), first for ODF files & using PEM files.

Related to this, we automatically sign macros (if the document has macros) when signing the document, so you can’t forget about this or get the order wrong (sign macros first, then the document).

At this stage implementing signature removal was possible, which again needs an async conversion so the user can confirm they really want to remove a signature. This also means the signature status of the document can change, the COOL UI now supports this.

You can now associate a signing certificate / key / CA chain with a COOL editor, so you can sign the document, but not an other editor working on the same document.

Finally adding a digital signature is now possible, where the certificate chooser just shows your signing certificates and hides it from other editors.

Here is a screenshot of the early digital signatures dialog at this stage:

Automatically signed documents¶

The second half of digital signing support in COOL started with WOPI extensions, so an integrator of COOL can specify the signature settings on their user settings page and pass that to COOL when a document is edited. We then send this to the document editor process only when needed, i.e. not on file open, but when the actual signing process would start.

UI is also added on the notebookbar in the form of a new button that allows adding signatures to a previously unsigned document – before you could only trigger the signatures dialog if the status bar said something about existing signatures, and only then you could add a signature. This button is hidden if you don’t have signature settings configured. It looks like this:

When was still missing here is automated Cypress tests to make sure signing e.g. an ODT file keeps working and the SDK documentation now also describes what does it take to support digital signatures in your COOL integration. For example you can create a Nextcloud integration like this:

Finally, COOL’s convert-to endpoint is hooked up with signature support, so you can export to a signed PDF. Example curl invocation:

curl -k -F "data=@in.odt" -F "format=pdf" -F 'options={"SignPDF":{"type":"boolean","value":"true"},"SignCertificateCaPem":{"type":"string","value":"..."},"SignCertificateCertPem":{"type":"string","value":"..."},"SignCertificateKeyPem":{"type":"string","value":"..."}}' https://localhost:9980/cool/convert-to > out.pdf

Plumbing for electronic signing¶

Once digital signing of ODF files is handled, let’s switch to PDF signing, which is much more interesting: you typically want to sign something final, and we see PDF as a final output of your documents. So first support for digital signing of PDFs was added.

The next part is to integrate with eID Easy, which can do privacy-friendly electronic signing for us. This is a 5 step process:

1. Extract the hash of the to-be-signed document. This is similar to signing, you start the process but once you have the hash that you would sign locally, you just take that hash and abort the actual signing.
2. Send this hash to the electronic signing service.
3. Open a popup and let the user authenticate with their credentials (passport, personal ID, etc) using one of the providers (different providers support different countries) and sign the hash.
4. Download the signed hash from the service.
5. Serialize this signed hash into the local document. This requires producing the local PDF signature once more, but this time using the previous timestamp (instead of the system clock, so the hash is table) and using the downloaded PKCS#7 signature instead of locally signing something.

At the end we got something that looks like a signature produced externally, but there was no UI for this. An initial popup for step 3 looked like this in the test environment (that doesn’t work with real passport numbers or anything sensitive):

UI for electronic signing¶

The next step was to create a user interface for electronic signing. The Insert menu had a new menu item to insert electronic signatures and to specify your country, finally choose one of the providers available in your country.

Also support for two types of providers is added: the first is the “in context” one, the other is a “redirect based” one. We now support both: all the redirect (should be familiar to you if you ever did e.g. online payments) happens in the popup, so the original COOL editor is never closed.

eID also has the concept of multiple tokens for signing: initiating the signing costs money, so is done using a “secret”, which is never sent to the COOL JS code. Then the “client ID” identifies the client, but can’t be used to start signing. Finally any single signing transaction has a specific “document ID”. We took care to follow the guidelines here, so the sensitive “secret” for signing is always kept on the server.

Similar to the initial document signing, electronic signing settings are also possible to specify from an integration, we documented this in the SDK and also created a sample Nextcloud integration for this.

The Nextcloud integration looks like this:

Note that later the API URL was changed to be a hidden setting, as real signing never needs a custom value there, this is just for testing.

Visual signing¶

The last part of this electronic signing effort was to expose visual singing in COOL, something that was added to LibreOffice Draw back in 2020, see this earlier blog post.

First this was exposed in COOL with digital signing, in a way that the current page gets a signature widget inserted at the page center and then the user can move that signature widget to the desired location.

Combining this with electronic signing is a bit more tricky, since we don’t want to select a certificate when the signature widget is inserted, we’ll deal with that in the external service, as usual.

Also, there was no real reason to not use visual signing unconditionally, so now the way to initiate a signing process is to open your PDF in COOL, use the Insert → Signature line menu item to insert a signature widget, move it to the wanted position, click “finish” on the snackbar and that completes the process with the usual electronic signing popup.

The final problem was that our multi-page PDF viewer was not really prepared to deal with changed PDF content (assuming your PDF rendering will not change is reasonable), so some last minute work had to be done to make sure the signature widget’s graphical selection indicator, its dragging and its rendering works fine even on non-first pages of a PDF document.

At the end, a test signature using the d-trust signature provider’s test environment looks like this:

Or if you prefer watching a demo, a typical electronic signing process session looks like this:

There were a few more talks with similar content:

• FOSDEM: Automatic Documents, packed with content and signed
• Nextcloud Hub 10 announcement

At the end you get an electronic signature that is trusted by the EU trust list and thus e.g. Acrobat Reader:

How is this implemented?¶

If you would like to know a bit more about how this works, continue reading... :-) As usual, the high-level problem was addressed by a series of small changes.

LibreOffice core commits:

• cool#9992 lok doc sign: add SfxObjectShell::AfterSignContent()
• cool#9992 lok doc sign: make SfxMedium::SignContents_Impl() async
• cool#9992 lok doc sign: async DocumentDigitalSignatures::signDocumentContent()
• cool#9992 lok doc sign: async DocumentDigitalSignatures::ImplViewSignatures()
• cool#9992 lok doc sign: async read-write DigitalSignaturesDialog
• cool#9992 lok doc sign: allow sign of macros & the document itself in one step
• cool#9992 lok doc sign: implement signature removal
• cool#9992 lok doc sign: fix signature status after load
• cool#9992 lok doc sign: add password-less mode to create-certs.sh
• cool#9992 lok doc sign: extract duplicated code to SfxLokHelper
• cool#9992 lok doc sign: handle .uno:SignatureCert/Key/Ca view options
• cool#9992 lok doc sign: store signing cert in the view
• cool#9992 lok doc sign: fix import of the private key
• cool#9992 lok doc sign: conditionally show the add button in the sign dialog
• cool#9992 lok doc sign: only take sign cert from the view in the cert chooser
• cool#9992 lok doc sign: convert the certificate chooser dialog to async
• cool#9992 lok doc sign: update sign status after modify the list of trusted CAs
• cool#9992 lok doc sign: avoid storing the sign cert in the model after sign
• cool#9992 lok doc sign: allow late-init of the sign cert
• cool#9992 lok doc sign: never remember previous .uno:Signature params
• cool#9992 lok doc sign: allow injecting sign cert/key during pdf export
• cool#9992 lok doc sign, create-certs.sh password-less mode: still create a .p12
• cool#9992 lok doc sign, hash extract: initial getCommandValues('Signature')
• cool#9992 lok doc sign, hash extract: time for getCommandValues('Signature')
• cool#9992 lok doc sign, hash extract: digest for getCommandValues('Signature')
• cool#9992 lok doc sign, hash extract: add signatureTime parameter
• cool#9992 lok doc sign: add initial serialization of external signatures
• cool#9992 doc electronic sign: make return type for .uno:Signature consistent
• cool#10630 lok doc sign: fix Impress sign line when creating directly
• cool#10630 lok doc sign: fix Impress sign line when picking a certificate
• cool#10630 doc sign: fix Impress sign line, to be able to finish signing again
• cool#10630 lok doc sign: allow setting the pos of the Impress sign line
• cool#10630 lok doc sign: allow setting the size of the Impress sign line
• cool#10630 doc electronic sign: fix insertion of the signature line
• cool#10630 doc electronic sign: fix no graphic selection for the signature line
• cool#10630 doc electronic sign: move signature line tracking to the view
• cool#10630 doc electronic sign: unselect & reject reselect
• cool#10630 lok doc sign: reduce the default size of the signature line

Collabora Online commits:

• cool#9992 doc sign: fix update of the signature widget in the status bar
• cool#9992 doc sign: fix missing enable on the cert chooser description entry
• cool#9992 doc sign: better fix for the cert chooser dialog's disabled description widget
• cool#9992 doc sign: add sign button to the home tab of the notebookbar
• cool#9992 doc sign: local file wopi provider: allow setting the sign cert/key/ca
• cool#9992 doc sign: set the view's sign cert from the WOPI UserPrivateInfo
• cool#9992 doc sign: add a setting to be able to disable this
• cool#10220 doc sign: don't assume that user private data is a dict json
• cool#9992 doc sign: hide sign button when user pref doesn't provide cert or key
• cool#9992 doc sign: add signature creation cypress test
• cool#9992 doc sign: move sign key/cert init from doc init to sign dispatch
• cool#9992 doc sign: fix handling of saveas options containing spaces
• cool#9992 doc sign: add menu item for the compact UI
• cool#9992 doc sign: add UI to sign PDF files
• cool#9992 doc electronic sign: allow passing sign params from JS
• cool#9992 doc electronic sign: allow more user private info settings with make run
• cool#9992 doc electronic sign: add menu item to trigger hash extract
• cool#9992 doc electronic sign: send the hash to be signed
• cool#9992 doc electronic sign: actually sign the hash in a popup
• cool#9992 doc electronic sign: fetch the created signature
• cool#9992 doc electronic sign: serialize the fetched signature
• cool#9992 doc electronic sign: add cypress test
• cool#9992 doc electronic sign: add a provider selector dialog
• cool#9992 doc electronic sign: select the provider interactively
• cool#10630 doc electronic sign: improve error handling on bad client ID
• cool#10630 doc electronic sign: more human-readable names for providers
• cool#10630 doc electronic sign: add /cool/signature endpoint
• cool#10630 doc electronic sign: implement support for redirect-based providers
• cool#10630 doc electronic sign: expose the name of the document
• cool#10630 doc electronic sign: send the hash on the server
• cool#10630 doc electronic sign: get the signature on the server
• cool#10630 doc electronic sign: stop sending the secret to the client
• cool#10630 doc electronic sign: remove CSP rules
• cool#10630 doc electronic sign: configure the language of the popup
• cool#10630 doc electronic sign: add a country selector to the dialog
• cool#10630 doc electronic sign: add ISO country names
• cool#10630 doc electronic sign: send selected country to the server
• cool#10630 doc electronic sign: moved esign settings out of UserPrivateInfo
• cool#10630 doc electronic sign: support per-server private info during 'make run'
• cool#10630 doc electronic sign: default to a redirect-based provider
• cool#10630 doc electronic sign: set defaults without an index
• cool#10630 doc electronic sign: return dialog result without an index
• cool#10630 doc electronic sign: limit the offered providers based on the selected country
• cool#10630 doc electronic sign: sort the country & provider lists
• cool#10630 doc sign: expose visual signing
• cool#10630 doc sign: add visual signing testcase
• cool#10630 doc sign: allow setting the position / size of a visual signature
• cool#10630 doc electronic sign: handle visual signatures
• cool#10630 doc electronic sign: add a snackbar
• cool#10630 doc electronic sign: show the sign view dialog after esign
• cool#10630 doc electronic sign: remember the provider in localstorage
• cool#10630 doc electronic sign: show busy overlay while the popup is open
• cool#10630 doc electronic sign: close the popup on tab close
• cool#10630 doc electronic sign: avoid unwanted postmessage during sign
• cool#10630 doc electronic sign: fix no graphic selection on 2nd page
• cool#11002 kit: fix memory corruption in Document::handleSaveMessage()
• cool#10630 doc electronic sign: fix no SVG in graphic selection on 2nd page
• cool#10630 doc electronic sign: fix outgoing mouse messages on 2nd page
• cool#10630 doc electronic sign: fix outgoing transform pos on 2nd page
• cool#10630 doc electronic sign: fix outdated tile for shape move on 2nd page

Nextcloud richdocuments commits:

• feat: add personal setting to specify the CA chain for document signing
• feat: expose the documentSigningCa personal setting in the WOPI CheckFileInfo
• feat: document signing, add setting for the signing certificate & key, too (fixes #4123)
• feat: electronic signing, add settings for eIDEasy (fixes #4311)

Want to start using this?¶

You can get a development edition of Collabora Online 24.04 and try it out yourself right now: try the development edition.

Collabora Online now takes the visible area (viewport) of large Writer documents into account in more cases, leading to better performance & interactivity.

Motivation¶

Collabora Online has two kinds of "visible areas" for a document: on one hand, the entire document is visible, so in case any part of the document changes, the browser client gets notified; on the other hand, there is a viewport in the web browser, and keeping that up to date is a priority, compared to the rest of the document.

There were some cases in the past where we handled the entire document with the same priority, leading to slower than ideal update times on the UI.

Wouldn't it be nice to always update the visible part first, and only then deal with the rest, on idle?

Results so far¶

When looking at this topic, we noticed a cluster of problems:

First, consider the case of a long (~300 pages) document, where you insert a page break at the start and wait for the update of the visible area. The entire document layout (now 301 pages) were calculated, and now we do this for the visible area synchronously (and the rest on idle). This operation is now about 19 times faster.

Second, loading a long document calculated the entire layout before showing the first page. This is now improved, the document loading time itself at a LOK API level for such a long document is now about 5 times faster.

Third, COOL didn't consider the priority of core tasks when interrupting to do its own work (COOL's document editing process and LibreOffice core shares the same main loop). Now we do this, categorizing the core tasks into "high priority" and "low priority" buckets and we only interrupt when core doesn't have high priority tasks any more (this is only in 25.04).

Fourth, there was no easy access to a large Writer document during development. Now make run COOL_WRITER_LARGE=y allows opening a long document in your local browser for development / testing purposes.

How is this implemented?¶

If you would like to know a bit more about how this works, continue reading... :-)

As usual, the high-level problem was addressed by a series of small changes:

• cool#11064 kit: send the client's visible area during file load
• cool#11064 kit: check for callbacks & wsd socket in the anyInput callback
• cool#11064 any input: conditionally consider priority of core tasks
• cool#11064 any input: add page insert testcase
• cool#11064 test: support creating a large Writer document with many pages

The tracking issue was cool#11064.

Want to start using this?¶

You can get a development edition of Collabora Online 24.04 and try it out yourself right now: try the development edition.

Collabora Online now uses the Clipboard API if it's available in the used browser, getting rid of many annoying dialogs.

Motivation¶

The paste side was covered by an earlier post, but in short, if you're on Chrome (or Safari), you won't see the "can't paste" dialog:

Also you won't see a "Can't paste special" dialog:

Wouldn't it be nice to improve the copy side in a similar way?

Results so far¶

The primary reason why we needed similar, annoying dialogs for copy in the past is that the clipboard API was synchronous but the network API is async. This means that writing to the clipboard ("copy") is only possible with data that we have in the browser when the copy is executed. This is a problem, since in general we don't have data for your selection in the browser.

With the Clipboard API, the copy side can be improved as well. Instead of always fetching the HTML for a simple selection (even if you don't copy) and having a three step copy for complex selections, async clipboard write is now possible. This gets us rid of the "You need to download" dialog:

Also it eliminates the "Download completed dialog:

Instead, we still need to nominally write to the clipboard in the special keyboard or click context initiating the copy (Chrome doesn't require this, Safari does), but the written object can be a callback that will do the network operation for us.

Unfortunately it's hard to screenshot the new code, since part of the result is that all these dialogs are now eliminated, copy & paste just works. :-)

Note that this can be used also in Firefox, but first you need to set dom.events.asyncClipboard.clipboardItem to true in about:config.

The last part was to adapt tests to this new world, because previously it was handy to just create a selection and assert what would be copied to the clipboard as HTML, but now we don't download the HTML anymore every time you create a selection.

How is this implemented?¶

If you would like to know a bit more about how this works, continue reading... :-)

As usual, the high-level problem was addressed by a series of small changes:

• Related: cool#8648 clipboard: extract parseClipboard() from Control.DownloadProgress.js
• Related: cool#8648 clipboard: use JSON when requesting HTML only
• cool#8648 clipboard: try to use navigator.clipboard.write()
• cool#8648 clipboard: fix desktop/writer/copy_paste_spec.js
• cool#8648 clipboard: fix desktop/calc/clipboard_spec.js
• cool#8648 clipboard: fix desktop/writer/undo_redo_spec.js
• cool#8648 clipboard: fix desktop/writer/track_changes_spec.js
• cool#8648 clipboard: fix most of desktop/writer/top_toolbar_spec.js
• cool#8648 clipboard: fix insert hyperlink dialog
• cool#8648 clipboard: fix desktop/writer/table_operation_spec.js
• cool#8648 clipboard: fix desktop/writer/searchbar_spec.js
• cool#8648 clipboard: fix desktop/writer/notebookbar_spec.js
• cool#8648 clipboard: fix desktop/writer/editable_area_spec.js
• cool#8648 clipboard: fix desktop/impress/undo_redo_spec.js
• cool#8648 clipboard: fix desktop/impress/delete_objects_spec.js
• cool#8648 clipboard: fix desktop/calc/undo_redo_spec.js
• cool#8648 clipboard: fix desktop/calc/top_toolbar_spec.js
• cool#8648 clipboard: fix desktop/calc/searchbar_spec.js
• cool#8648 clipboard: fix desktop/calc/searchbar_spec.js
• cool#8648 clipboard: fix desktop/calc/focus_spec.js
• cool#8648 clipboard: fix desktop/calc/delete_objects_spec.js
• cool#8648 clipboard: fix desktop/calc/autofilter_spec.js
• cool#8648 clipboard: fix desktop/calc/cell_appearance_spec.js
• cool#8648 clipboard: fix mobile/calc/apply_font_spec.js
• cool#8648 clipboard: fix mobile/calc/autofilter_spec.js
• cool#8648 clipboard: fix mobile/calc/bottom_toolbar_spec.js
• cool#8648 clipboard: fix mobile/calc/cell_appearance_spec.js
• cool#8648 clipboard: fix mobile/calc/delete_objects_spec.js
• cool#8648 clipboard: fix mobile/calc/insertion_wizard_spec.js
• cool#8648 clipboard: fix mobile/calc/searchbar_spec.js
• cool#8648 clipboard: fix mobile/calc/spellchecking_spec.js
• cool#8648 clipboard: fix mobile/impress/delete_objects_spec.js
• cool#8648 clipboard: fix mobile/impress/impress_focus_spec.js
• cool#8648 clipboard: fix mobile/impress/insertion_wizard_spec.js
• cool#8648 clipboard: fix mobile/impress/spellchecking_spec.js
• cool#8648 clipboard: fix mobile/writer/apply_font_spec.js
• cool#8648 clipboard: fix mobile/writer/delete_objects_spec.js
• cool#8648 clipboard: fix mobile/writer/insert_formatting_mark_spec.js
• cool#8648 clipboard: fix mobile/impress/insertion_wizard_spec.js
• cool#8648 clipboard: fix mobile/writer/track_changes_spec.js
• cool#8648 clipboard: fix mobile/writer/table_properties_spec.js
• cool#8648 clipboard: stop fetching the clipboard on text selection create in tests
• cool#8648 clipboard: fix idle tests

The tracking issue was cool#8648.

Want to start using this?¶

You can get a development edition of Collabora Online 24.04 and try it out yourself right now: try the development edition.