Merge pull request #3087 from cozy/notes-archives

Add images to notes

Author: nono

docs/files.md

@@ -125,7 +125,8 @@ more informations about the `not_synchronized_on` field.
 ### GET /files/:file-id
 
 Get a directory or a file informations. In the case of a directory, it contains
-the list of files and sub-directories inside it.
+the list of files and sub-directories inside it. For a note, its images are
+included.
 
 Contents is paginated following [jsonapi conventions](jsonapi.md#pagination).
 The default limit is 30 entries.

docs/notes.md

@@ -1140,12 +1140,79 @@ Content-Type: application/vnd.api+json
 }
 ```
 
+### POST /notes/:id/images
+
+This route can be used to upload an image for a note. The note will be
+transformed in a tar archive in the VFS, with the image saved inside it.
+
+This route can only be used to upload images (the content-type is checked) and
+requires a POST permission on the note.
+
+The filename of the image is given in the query string, via the `Name`
+parameter. In case of conflict (another image has the same name), the stack
+will rename this image.
+
+If the image is larger than 768px, a thumbnail will be generated.
+
+#### Request
+
+```http
+POST /notes/f48d9370-e1ec-0137-8547-543d7eb8149c/images?Name=diagram.jpg HTTP/1.1
+Accept: application/vnd.api+json
+Content-Length: 123456
+Content-Type: image/jpeg
+Host: cozy.example.com
+<content>
+```
+
+#### Response
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/vnd.api+json
+```
+
+```json
+{
+  "data": {
+    "type": "io.cozy.notes.images",
+    "id": "f48d9370-e1ec-0137-8547-543d7eb8149c/e57d2ec0-d281-0139-2bed-543d7eb8149c",
+    "meta": {
+      "rev": "1-588ab661"
+    },
+    "attributes": {
+      "name": "diagram.jpg",
+      "mime": "image/jpeg",
+      "width": 1000,
+      "height": 1000,
+      "willBeResized": true,
+      "cozyMetadata": {
+        "doctypeVersion": "1",
+        "metadataVersion": 1,
+        "createdAt": "2021-07-12T10:58:00Z",
+        "createdByApp": "notes",
+        "createdOn": "https://cozy.example.com/",
+        "updatedAt": "2021-07-12T10:58:00Z",
+        "uploadedAt": "2021-07-12T10:58:00Z",
+        "uploadedOn": "https://cozy.example.com/",
+        "uploadedBy": {
+          "slug": "notes"
+        }
+      }
+    },
+    "links": {
+      "self": "/notes/f48d9370-e1ec-0137-8547-543d7eb8149c/images/e57d2ec0-d281-0139-2bed-543d7eb8149c/543d7eb8149c128b"
+    }
+  }
+}
+```
+
 ## Real-time via websockets
 
 You can subscribe to the [realtime](realtime.md) API for a document with the
 `io.cozy.notes.events` doctype, and the id of a note file. It requires a permission
 on this file, and it will send the events for this notes: changes of the title, the
-steps applied, and the telepointer updates.
+steps applied, the telepointer updates, and images processed.
 
 ### Example
 
@@ -1175,4 +1242,12 @@ server > {"event": "UPDATED",
           "payload": {"id": "f48d9370-e1ec-0137-8547-543d7eb8149c",
                       "type": "io.cozy.notes.events",
                       "doc": {"doctype": "io.cozy.notes.telepointers", "sessionID": "543781490137", "anchor": 7, "head": 12, "type": "textSelection"}}}
+server > {"event": "UPDATED",
+          "payload": {"id": "f48d9370-e1ec-0137-8547-543d7eb8149c",
+                      "type": "io.cozy.notes.events",
+                      "doc": {"doctype": "io.cozy.notes.images",
+                              "image_id": "e57d2ec0-d281-0139-2bed-543d7eb8149c",
+                              "mime": "image/jpeg",
+                              "width": 768,
+                              "height": 768}}}
 ```

model/instance/instance.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
+	"path"
 	"strings"
 	"time"
 
@@ -21,6 +22,7 @@ import (
 	"github.com/cozy/cozy-stack/pkg/jsonapi"
 	"github.com/cozy/cozy-stack/pkg/lock"
 	"github.com/cozy/cozy-stack/pkg/logger"
+	"github.com/spf13/afero"
 
 	"github.com/sirupsen/logrus"
 	jwt "gopkg.in/dgrijalva/jwt-go.v3"
@@ -225,6 +227,34 @@ func (i *Instance) MakeVFS() error {
 	return err
 }
 
+// ThumbsFS returns the hidden filesystem for storing the thumbnails of the
+// photos/image
+func (i *Instance) ThumbsFS() vfs.Thumbser {
+	fsURL := config.FsURL()
+	switch fsURL.Scheme {
+	case config.SchemeFile:
+		baseFS := afero.NewBasePathFs(afero.NewOsFs(),
+			path.Join(fsURL.Path, i.DirName(), vfs.ThumbsDirName))
+		return vfsafero.NewThumbsFs(baseFS)
+	case config.SchemeMem:
+		baseFS := vfsafero.GetMemFS(i.DomainName() + "-thumbs")
+		return vfsafero.NewThumbsFs(baseFS)
+	case config.SchemeSwift, config.SchemeSwiftSecure:
+		switch i.SwiftLayout {
+		case 0:
+			return vfsswift.NewThumbsFs(config.GetSwiftConnection(), i.Domain)
+		case 1:
+			return vfsswift.NewThumbsFsV2(config.GetSwiftConnection(), i)
+		case 2:
+			return vfsswift.NewThumbsFsV3(config.GetSwiftConnection(), i)
+		default:
+			panic(ErrInvalidSwiftLayout)
+		}
+	default:
+		panic(fmt.Sprintf("instance: unknown storage provider %s", fsURL.Scheme))
+	}
+}
+
 // NotesLock returns a mutex for the notes on this instance.
 func (i *Instance) NotesLock() lock.ErrorRWLocker {
 	return lock.ReadWrite(i, "notes")

model/instance/lifecycle/thumbs.go

@@ -0,0 +1,42 @@
+package note
+
+import (
+	"github.com/cozy/cozy-stack/model/instance"
+	"github.com/cozy/cozy-stack/model/vfs"
+	"github.com/cozy/cozy-stack/pkg/consts"
+	"github.com/cozy/cozy-stack/pkg/couchdb"
+	"github.com/cozy/cozy-stack/pkg/prefixer"
+)
+
+func init() {
+	vfs.DeleteNote = deleteNote
+}
+
+func deleteNote(db prefixer.Prefixer, noteID string) {
+	go func() {
+		images, err := getImages(db, noteID)
+		if err == nil {
+			formats := []string{
+				consts.NoteImageOriginalFormat,
+				consts.NoteImageThumbFormat,
+			}
+			for _, img := range images {
+				inst := &instance.Instance{
+					Domain: db.DomainName(),
+					Prefix: db.DBPrefix(),
+				}
+				_ = inst.ThumbsFS().RemoveNoteThumb(img.ID(), formats)
+				_ = couchdb.DeleteDoc(db, img)
+			}
+		}
+
+		steps, err := getSteps(db, noteID, 0)
+		if err == nil && len(steps) > 0 {
+			docs := make([]couchdb.Doc, 0, len(steps))
+			for i := range steps {
+				docs = append(docs, &steps[i])
+			}
+			_ = couchdb.BulkDeleteDocs(db, consts.NotesSteps, docs)
+		}
+	}()
+}

model/note/delete.go

@@ -1,6 +1,8 @@
 package note
 
 import (
+	"strings"
+
 	"github.com/cozy/cozy-stack/model/instance"
 	"github.com/cozy/cozy-stack/pkg/consts"
 	"github.com/cozy/cozy-stack/pkg/couchdb"
@@ -96,4 +98,12 @@ func publishSteps(inst *instance.Instance, fileID string, steps []Step) {
 	}
 }
 
+// PublishThumbnail sends information about a resized image.
+func PublishThumbnail(inst *instance.Instance, event Event) {
+	parts := strings.SplitN(event.ID(), "/", 2)
+	event.SetID(parts[0])        // The note ID is the first part of the image ID
+	event["image_id"] = parts[1] // The image ID is the second part
+	event.publish(inst)
+}
+
 var _ jsonapi.Object = &Event{}