feat: Notification about file creation inside sharing (#4621)

shepilov · web-flow · commit e0d1102992ab · 2025-12-05T14:41:28.000+01:00
Adds email notifications when files or folders are uploaded to a shared
folder
diff --git a/assets/locales/de.po b/assets/locales/de.po
@@ -959,4 +959,16 @@ msgid "Push Sharing Shortcut Message"
 msgstr "%s has shared %s with you."
 
 msgid "Permissions io.cozy.drive.settings"
-msgstr "Drive-Einstellungen"
+msgstr "Drive-Einstellungen"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/en.po b/assets/locales/en.po
@@ -1288,4 +1288,16 @@ msgid "Push Sharing Shortcut Message"
 msgstr "%s has shared %s with you."
 
 msgid "Permissions io.cozy.drive.settings"
-msgstr "Drive settings"
+msgstr "Drive settings"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/es.po b/assets/locales/es.po
@@ -971,3 +971,15 @@ msgstr "%s has shared %s with you."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Configuración de Drive"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/fr.po b/assets/locales/fr.po
@@ -1403,3 +1403,15 @@ msgstr "%s vous a partagé %s."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Paramètres de Drive"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "Fichier modifié dans le dossier partagé : %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Quelqu'un a partagé un fichier avec vous :"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "Voir sur Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Quelqu'un a partagé un dossier avec vous :"
diff --git a/assets/locales/ja.po b/assets/locales/ja.po
@@ -800,3 +800,15 @@ msgstr "%s has shared %s with you."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Drive の設定"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/nl_NL.po b/assets/locales/nl_NL.po
@@ -1158,3 +1158,15 @@ msgstr "%s has shared %s with you."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Drive-instellingen"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/ru.po b/assets/locales/ru.po
@@ -1379,3 +1379,15 @@ msgstr "%s поделился с вами %s."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Настройки Drive"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/locales/vi.po b/assets/locales/vi.po
@@ -1351,3 +1351,15 @@ msgstr "%s đã chia sẻ %s với bạn."
 
 msgid "Permissions io.cozy.drive.settings"
 msgstr "Cài đặt Drive"
+
+msgid "Mail Sharing File Changed Subject"
+msgstr "File changed in shared folder: %s"
+
+msgid "Mail Sharing File Changed Intro"
+msgstr "Someone shared a file with you:"
+
+msgid "Mail Sharing File Changed Link Text"
+msgstr "See on Twake Drive"
+
+msgid "Mail Sharing Folder Changed Intro"
+msgstr "Someone shared a folder with you:"
diff --git a/assets/mails/sharing_file_changed.mjml b/assets/mails/sharing_file_changed.mjml
@@ -0,0 +1,15 @@
+{{define "content"}}
+<mj-text mj-class="title content-medium">
+	<img src="https://files.cozycloud.cc/email-assets/stack/twake-share.png" width="16" height="16" style="vertical-align:sub;"/>&nbsp;
+	{{t "Mail Sharing File Changed Subject" .SharingDescription}}
+</mj-text>
+<mj-text mj-class="content-medium">
+	{{if .IsFolder}}{{t "Mail Sharing Folder Changed Intro"}}{{else}}{{t "Mail Sharing File Changed Intro"}}{{end}}
+</mj-text>
+<mj-text mj-class="content-medium" padding-left="20px">
+	<strong>{{.FileName}}</strong>
+</mj-text>
+<mj-button href="{{.FileURL}}" align="left" mj-class="primary-button content-xlarge">
+	{{t "Mail Sharing File Changed Link Text"}}
+</mj-button>
+{{end}}
diff --git a/assets/mails/sharing_file_changed.text b/assets/mails/sharing_file_changed.text
@@ -0,0 +1,7 @@
+{{if .IsFolder}}{{t "Mail Sharing Folder Changed Intro"}}{{else}}{{t "Mail Sharing File Changed Intro"}}{{end}}
+
+  {{.FileName}}
+
+{{t "Mail Sharing File Changed Link Text"}}
+
+  [{{.FileURL}}]
diff --git a/model/notification/center/notification_center.go b/model/notification/center/notification_center.go
@@ -28,6 +28,9 @@ const (
 	// NotificationOAuthClients category for sending alert when exceeding the
 	// connected OAuth clients limit.
 	NotificationOAuthClients = "oauth-clients"
+	// NotificationSharingFileChanged category for sending alert when a file or
+	// folder is created in a sharing.
+	NotificationSharingFileChanged = "sharing-file-changed"
 )
 
 var (
@@ -45,6 +48,12 @@ var (
 			Stateful:     false,
 			MailTemplate: "notifications_oauthclients",
 		},
+		NotificationSharingFileChanged: {
+			Description:  "Notify about new files or folders created in a sharing",
+			Collapsible:  false,
+			Stateful:     false,
+			MailTemplate: "sharing_file_changed",
+		},
 	}
 )
 
diff --git a/model/sharing/notification.go b/model/sharing/notification.go
@@ -0,0 +1,136 @@
+package sharing
+
+import (
+	"net/url"
+
+	"github.com/cozy/cozy-stack/model/instance"
+	"github.com/cozy/cozy-stack/model/notification"
+	"github.com/cozy/cozy-stack/model/notification/center"
+	"github.com/cozy/cozy-stack/pkg/config/config"
+	"github.com/cozy/cozy-stack/pkg/consts"
+)
+
+func sendFileChangeNotification(inst *instance.Instance, description, fileName, fileOrDirID, parentID string, isFolder bool) error {
+	// Format for file: https://alice.example.com/#/folder/{parent_folder_id}/file/{file_id}
+	itemURL := inst.SubDomain(consts.DriveSlug)
+	if isFolder {
+		itemURL.Fragment = "/folder/" + url.PathEscape(fileOrDirID)
+	} else {
+		itemURL.Fragment = "/folder/" + url.PathEscape(parentID) + "/file/" + url.PathEscape(fileOrDirID)
+	}
+
+	n := &notification.Notification{
+		Title: inst.Translate("Mail Sharing File Changed Subject", description),
+		Slug:  consts.DriveSlug,
+		Data: map[string]interface{}{
+			"SharingDescription": description,
+			"FileName":           fileName,
+			"FileURL":            itemURL.String(),
+			"IsFolder":           isFolder,
+		},
+		PreferredChannels: []string{"mail"},
+	}
+	return center.PushStack(inst.DomainName(), center.NotificationSharingFileChanged, n)
+}
+
+// MaybeNotifyFileCreated checks if a file change notification should be sent.
+// Only sends notifications when a file or folder is CREATED, not updated or removed.
+func MaybeNotifyFileCreated(inst *instance.Instance, msg TrackMessage, evt TrackEvent) {
+	// Check if notifications are enabled for this context
+	cfg := config.GetSharingNotificationsConfig(inst.ContextName)
+	if !cfg.Enabled {
+		return
+	}
+
+	// Only notify for file changes
+	if msg.DocType != consts.Files {
+		return
+	}
+
+	// Only notify on CREATED events, not updates or deletions
+	if evt.Verb != "CREATED" {
+		return
+	}
+
+	// Get the sharing
+	s, err := FindSharing(inst, msg.SharingID)
+	if err != nil {
+		inst.Logger().WithNamespace("sharing").
+			Warnf("Cannot find sharing for notification: %s", err)
+		return
+	}
+	// Only send notification if this is the owner's instance
+	if !s.Owner {
+		return
+	}
+	// Only send for file-based sharings
+	if s.FirstFilesRule() == nil {
+		return
+	}
+
+	// Check if this is a folder or a file
+	docType, _ := evt.Doc.Get("type").(string)
+	isFolder := docType == consts.DirType
+
+	// Get file/folder name from the event
+	fileName, _ := evt.Doc.Get("name").(string)
+	if fileName == "" {
+		fileName = "unknown"
+	}
+
+	// Get file/folder ID from the event
+	fileID := evt.Doc.ID()
+	if fileID == "" {
+		inst.Logger().WithNamespace("sharing").
+			Warnf("Failed to get fileID from event: %s", err)
+		return
+	}
+
+	// Get parent folder ID from the event
+	dirID, _ := evt.Doc.Get("dir_id").(string)
+	if dirID == "" {
+		inst.Logger().WithNamespace("sharing").
+			Warnf("Failed to get dir_id from event doc: %s", err)
+		return
+	}
+
+	// Send the notification (async, don't block on errors)
+	go func() {
+		if err := sendFileChangeNotification(inst, s.Description, fileName, fileID, dirID, isFolder); err != nil {
+			inst.Logger().WithNamespace("sharing").
+				Warnf("Failed to send file change notification: %s", err)
+		}
+	}()
+}
+
+// MaybeNotifyShareByLinkUpload checks if a notification should be sent when
+// a file or folder is uploaded via a share-by-link (public link).
+func MaybeNotifyShareByLinkUpload(inst *instance.Instance, fileName, fileID, parentID string, isFolder bool) {
+	// Check if notifications are enabled for this context
+	cfg := config.GetSharingNotificationsConfig(inst.ContextName)
+	if !cfg.Enabled {
+		return
+	}
+
+	if fileName == "" {
+		fileName = "unknown"
+	}
+
+	if fileID == "" || parentID == "" {
+		return
+	}
+
+	// For share-by-link, we use the parent folder name as description
+	description := ""
+	if parentDir, err := inst.VFS().DirByID(parentID); err == nil {
+		description = parentDir.DocName
+	}
+
+	// Send the notification (async, don't block on errors)
+	go func() {
+		if err := sendFileChangeNotification(inst, description, fileName, fileID, parentID, isFolder); err != nil {
+			inst.Logger().WithNamespace("sharing").
+				Warnf("Failed to send share-by-link file change notification: %s", err)
+		}
+	}()
+}
diff --git a/model/sharing/shared.go b/model/sharing/shared.go
@@ -426,6 +426,11 @@ func UpdateShared(inst *instance.Instance, msg TrackMessage, evt TrackEvent) err
 		}
 	}
 
+	// Send notification to owner if a recipient created a file
+	if evt.Verb == "CREATED" {
+		MaybeNotifyFileCreated(inst, msg, evt)
+	}
+
 	// For a directory, we have to update the Removed flag for the files inside
 	// it, as we won't have any events for them.
 	if needToUpdateFiles {
diff --git a/pkg/config/config/config.go b/pkg/config/config/config.go
@@ -366,6 +366,36 @@ func GetSharingConfig(contextName string) SharingConfig {
 	return defaultConfig
 }
 
+// SharingNotificationsConfig contains settings for sharing file change notifications.
+type SharingNotificationsConfig struct {
+	Enabled bool `mapstructure:"enabled"`
+}
+
+func GetSharingNotificationsConfig(contextName string) SharingNotificationsConfig {
+	defaultConfig := SharingNotificationsConfig{
+		Enabled: false,
+	}
+
+	if config == nil || config.Contexts == nil {
+		return defaultConfig
+	}
+
+	if contextName == "" {
+		contextName = DefaultInstanceContext
+	}
+
+	if ctxData, ok := config.Contexts[contextName].(map[string]interface{}); ok {
+		if notifData, ok := ctxData["sharing_notifications"].(map[string]interface{}); ok {
+			var cfg SharingNotificationsConfig
+			if err := mapstructure.Decode(notifData, &cfg); err == nil {
+				return cfg
+			}
+		}
+	}
+
+	return defaultConfig
+}
+
 // SMS contains the configuration to send notifications by SMS.
 type SMS struct {
 	Provider string
diff --git a/web/files/files.go b/web/files/files.go
diff --git a/web/sharings/sharings_test.go b/web/sharings/sharings_test.go
diff --git a/web/statik/statik.go b/web/statik/statik.go
diff --git a/worker/mails/mail_templates.go b/worker/mails/mail_templates.go
