Fix onlyoffice behavior

docs/docker.md

@@ -68,7 +68,8 @@ $ docker run -it --rm --name=oodev --net=host cozy/onlyoffice-dev
 and run the stack with:
 
 ```bash
-$ cozy-stack serve --disable-csp --onlyoffice-url=http://localhost:8000/ --onlyoffice-inbox-secret=inbox_secret --onlyoffice-outbox-secret=outbox_secret
+$ cozy-stack serve --disable-csp --onlyoffice-url=http://localhost:8000 --onlyoffice-inbox-secret=inbox_secret --onlyoffice-outbox-secret=outbox_secret
+$ cozy-stack features defaults '{"drive.office": {"enabled": true, "write": true}}'
 ```
 
 If you need to rebuild it, you can do that with:

docs/office.md

@@ -121,6 +121,66 @@ Content-Type: application/vnd.api+json
 }
 ```
 
+### POST /office/keys/:key
+
+If a document is being edited while a new version is uploaded (via the desktop
+for example), the OO webapp should call this endpoint if the user chooses to
+continue editing the version on which they were working. A conflict file is
+created, so that no work is lost.
+
+#### Request
+
+```http
+POST /office/keys/7c7ccc2e7137ba774b7e44de HTTP/1.1
+Host: bob.cozy.example
+```
+
+#### Response
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/vnd.api+json
+```
+
+```json
+{
+  "data": {
+    "type": "io.cozy.files",
+    "id": "32e07d806f9b0139c541543d7eb8149c",
+    "meta": {
+      "rev": "3-18c04daba326"
+    },
+    "attributes": {
+      "type": "file",
+      "name": "slideshow (2).pptx",
+      "trashed": false,
+      "md5sum": "ODZmYjI2OWQxOTBkMmM4NQo=",
+      "created_at": "2023-09-30T21:42:05Z",
+      "updated_at": "2023-09-30T22:38:04Z",
+      "tags": [],
+      "metadata": {},
+      "size": 12345,
+      "executable": false,
+      "class": "slide",
+      "mime": "application/vnd.ms-powerpoint",
+      "cozyMetadata": {
+        "doctypeVersion": "1",
+        "metadataVersion": 1,
+        "createdAt": "2023-09-30T21:42:05Z",
+        "createdByApp": "drive",
+        "createdOn": "https://bob.cozy.example/",
+        "updatedAt": "2023-09-30T22:38:04Z",
+        "uploadedAt": "2023-09-30T22:38:04Z",
+        "uploadedOn": "https://bob.cozy.example/",
+        "uploadedBy": {
+          "slug": "onlyoffice-server"
+        }
+      }
+    }
+  }
+}
+```
+
 ### POST /office/callback
 
 This is the callback handler for OnlyOffice. It is called when the document

model/office/callback.go

@@ -6,6 +6,9 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"os"
+	"path"
+	"strings"
 	"time"
 
 	"github.com/cozy/cozy-stack/model/instance"
@@ -28,6 +31,10 @@ const (
 	StatusForceSaveRequested = 6
 )
 
+// OOSlug is the slug for uploadedBy field of the CozyMetadata when a file has
+// been modified in the online OnlyOffice.
+const OOSlug = "onlyoffice-server"
+
 // CallbackParameters is a struct for the parameters sent by the document
 // server to the stack.
 // Cf https://api.onlyoffice.com/editors/callback
@@ -94,7 +101,7 @@ func checkToken(cfg *config.Office, params CallbackParameters) error {
 func finalSaveFile(inst *instance.Instance, key, downloadURL string) error {
 	detector, err := GetStore().GetDoc(inst, key)
 	if err != nil || detector == nil || detector.ID == "" || detector.Rev == "" {
-		return errors.New("invalid key")
+		return ErrInvalidKey
 	}
 
 	_, err = saveFile(inst, *detector, downloadURL)
@@ -107,7 +114,7 @@ func finalSaveFile(inst *instance.Instance, key, downloadURL string) error {
 func forceSaveFile(inst *instance.Instance, key, downloadURL string) error {
 	detector, err := GetStore().GetDoc(inst, key)
 	if err != nil || detector == nil || detector.ID == "" || detector.Rev == "" {
-		return errors.New("invalid key")
+		return ErrInvalidKey
 	}
 
 	updated, err := saveFile(inst, *detector, downloadURL)
@@ -148,6 +155,7 @@ func saveFile(inst *instance.Instance, detector conflictDetector, downloadURL st
 	newfile.UpdatedAt = time.Now()
 	newfile.CozyMetadata.UpdatedAt = newfile.UpdatedAt
 	newfile.CozyMetadata.UploadedAt = &newfile.UpdatedAt
+	newfile.CozyMetadata.UploadedBy = &vfs.UploadedByEntry{Slug: OOSlug}
 
 	// If the file was renamed while OO editor was opened, the revision has
 	// been changed, but we still should avoid creating a conflict if the
@@ -157,15 +165,24 @@ func saveFile(inst *instance.Instance, detector conflictDetector, downloadURL st
 		file = nil
 		newfile.SetID("")
 		newfile.SetRev("")
-		newfile.DocName = fmt.Sprintf("%s - conflict - %d", newfile.DocName, time.Now().Unix())
+	}
+
+	basename := newfile.DocName
+	var f vfs.File
+	for i := 2; i < 100; i++ {
+		f, err = fs.CreateFile(newfile, file)
+		if err == nil {
+			break
+		} else if !errors.Is(err, os.ErrExist) {
+			return nil, err
+		}
+		ext := path.Ext(basename)
+		filename := strings.TrimSuffix(path.Base(basename), ext)
+		newfile.DocName = fmt.Sprintf("%s (%d)%s", filename, i, ext)
 		newfile.ResetFullpath()
 		_, _ = newfile.Path(inst.VFS()) // Prefill the fullpath
 	}
 
-	f, err := fs.CreateFile(newfile, file)
-	if err != nil {
-		return nil, err
-	}
 	_, err = io.Copy(f, res.Body)
 	if cerr := f.Close(); cerr != nil && err == nil {
 		err = cerr

model/office/errors.go

@@ -11,4 +11,6 @@ var (
 	// ErrInternalServerError is used when something goes wrong (like no
 	// connection to redis)
 	ErrInternalServerError = errors.New("Internal server error")
+	// ErrInvalidKey is used when the key is not found in the store
+	ErrInvalidKey = errors.New("invalid key")
 )

model/office/file_by_key.go

@@ -0,0 +1,49 @@
+package office
+
+import (
+	"bytes"
+
+	"github.com/cozy/cozy-stack/model/instance"
+	"github.com/cozy/cozy-stack/model/vfs"
+)
+
+// EnsureFileForKey returns the file that will be written when OnlyOffice will
+// save a document with the given key. The general case is that is the file
+// that has been opened. But, it can also be a new file if a conflict has
+// happened because a new version has been uploaded for this file (by the
+// desktop client for example).
+func EnsureFileForKey(inst *instance.Instance, key string) (*vfs.FileDoc, error) {
+	detector, err := GetStore().GetDoc(inst, key)
+	if err != nil {
+		return nil, err
+	}
+	if detector == nil || detector.ID == "" || detector.Rev == "" {
+		return nil, ErrInvalidKey
+	}
+
+	fs := inst.VFS()
+	file, err := fs.FileByID(detector.ID)
+	if err != nil {
+		return nil, err
+	}
+
+	if file.Rev() == detector.Rev || bytes.Equal(file.MD5Sum, detector.MD5Sum) {
+		return file, nil
+	}
+
+	// Manage the conflict
+	conflictName := vfs.ConflictName(fs, file.DirID, file.DocName, true)
+	newfile := vfs.CreateFileDocCopy(file, file.DirID, conflictName)
+	newfile.CozyMetadata = vfs.NewCozyMetadata(inst.PageURL("/", nil))
+	newfile.CozyMetadata.UpdatedAt = newfile.UpdatedAt
+	newfile.CozyMetadata.UploadedAt = &newfile.UpdatedAt
+	newfile.CozyMetadata.UploadedBy = &vfs.UploadedByEntry{Slug: OOSlug}
+	if err := fs.CopyFile(file, newfile); err != nil {
+		return nil, err
+	}
+
+	updated := conflictDetector{ID: newfile.ID(), Rev: newfile.Rev(), MD5Sum: newfile.MD5Sum}
+	_ = GetStore().UpdateSecret(inst, key, file.ID(), newfile.ID())
+	_ = GetStore().UpdateDoc(inst, key, updated)
+	return newfile, nil
+}

model/office/open.go

@@ -1,6 +1,7 @@
 package office
 
 import (
+	"bytes"
 	"net/url"
 
 	"github.com/cozy/cozy-stack/client/request"
@@ -169,8 +170,27 @@ func (o *Opener) openLocalDocument(memberIndex int, readOnly bool) (*apiOfficeUR
 			Infof("Cannot build download URL: %s", err)
 		return nil, ErrInternalServerError
 	}
-	detector := conflictDetector{ID: o.File.ID(), Rev: o.File.Rev(), MD5Sum: o.File.MD5Sum}
-	key, err := GetStore().AddDoc(o.Inst, detector)
+	key, err := GetStore().GetSecretByID(o.Inst, o.File.ID())
+	if err != nil {
+		o.Inst.Logger().WithNamespace("office").
+			Infof("Cannot get secret from store: %s", err)
+		return nil, ErrInternalServerError
+	}
+	if key != "" {
+		doc, err := GetStore().GetDoc(o.Inst, key)
+		if err != nil {
+			o.Inst.Logger().WithNamespace("office").
+				Infof("Cannot get doc from store: %s", err)
+			return nil, ErrInternalServerError
+		}
+		if shouldOpenANewVersion(o.File, doc) {
+			key = ""
+		}
+	}
+	if key == "" {
+		detector := conflictDetector{ID: o.File.ID(), Rev: o.File.Rev(), MD5Sum: o.File.MD5Sum}
+		key, err = GetStore().AddDoc(o.Inst, detector)
+	}
 	if err != nil {
 		o.Inst.Logger().WithNamespace("office").
 			Infof("Cannot add doc to store: %s", err)
@@ -296,3 +316,17 @@ func getConfig(contextName string) *config.Office {
 	}
 	return nil
 }
+
+func shouldOpenANewVersion(file *vfs.FileDoc, detector *conflictDetector) bool {
+	if detector == nil {
+		return true
+	}
+	cm := file.CozyMetadata
+	if cm != nil && cm.UploadedBy != nil && cm.UploadedBy.Slug == OOSlug {
+		return false
+	}
+	if bytes.Equal(file.MD5Sum, detector.MD5Sum) {
+		return false
+	}
+	return true
+}