Feature: Add ability to rename and delete tags globally

internal/storage/messages.go

@@ -131,8 +131,10 @@ func Store(body *[]byte) (string, error) {
 	// extract tags from search matches, and sort and extract unique tags
 	tags = sortedUniqueTags(append(tags, tagFilterMatches(id)...))
 
+	setTags := []string{}
 	if len(tags) > 0 {
-		if err := SetMessageTags(id, tags); err != nil {
+		setTags, err = SetMessageTags(id, tags)
+		if err != nil {
 			return "", err
 		}
 	}
@@ -148,7 +150,7 @@ func Store(body *[]byte) (string, error) {
 	c.Attachments = attachments
 	c.Subject = subject
 	c.Size = size
-	c.Tags = tags
+	c.Tags = setTags
 	c.Snippet = snippet
 
 	websockets.Broadcast("new", c)

internal/storage/schemas.go

@@ -199,7 +199,7 @@ func migrateTagsToManyMany() {
 	if len(toConvert) > 0 {
 		logger.Log().Infof("[migration] converting %d message tags", len(toConvert))
 		for id, tags := range toConvert {
-			if err := SetMessageTags(id, tags); err != nil {
+			if _, err := SetMessageTags(id, tags); err != nil {
 				logger.Log().Errorf("[migration] %s", err.Error())
 			} else {
 				if _, err := sqlf.Update(tenant("mailbox")).

internal/storage/tags.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"database/sql"
+	"fmt"
 	"regexp"
 	"sort"
 	"strings"
@@ -21,7 +22,7 @@ var (
 )
 
 // SetMessageTags will set the tags for a given database ID, removing any not in the array
-func SetMessageTags(id string, tags []string) error {
+func SetMessageTags(id string, tags []string) ([]string, error) {
 	applyTags := []string{}
 	for _, t := range tags {
 		t = tools.CleanTag(t)
@@ -30,6 +31,7 @@ func SetMessageTags(id string, tags []string) error {
 		}
 	}
 
+	tagNames := []string{}
 	currentTags := getMessageTags(id)
 	origTagCount := len(currentTags)
 
@@ -38,9 +40,12 @@ func SetMessageTags(id string, tags []string) error {
 			continue
 		}
 
-		if err := AddMessageTag(id, t); err != nil {
-			return err
+		name, err := AddMessageTag(id, t)
+		if err != nil {
+			return []string{}, err
 		}
+
+		tagNames = append(tagNames, name)
 	}
 
 	if origTagCount > 0 {
@@ -49,42 +54,44 @@ func SetMessageTags(id string, tags []string) error {
 		for _, t := range currentTags {
 			if !tools.InArray(t, applyTags) {
 				if err := DeleteMessageTag(id, t); err != nil {
-					return err
+					return []string{}, err
 				}
 			}
 		}
 	}
 
-	return nil
+	return tagNames, nil
 }
 
 // AddMessageTag adds a tag to a message
-func AddMessageTag(id, name string) error {
+func AddMessageTag(id, name string) (string, error) {
 	// prevent two identical tags being added at the same time
 	addTagMutex.Lock()
 
 	var tagID int
+	var foundName sql.NullString
 
 	q := sqlf.From(tenant("tags")).
 		Select("ID").To(&tagID).
+		Select("Name").To(&foundName).
 		Where("Name = ?", name)
 
 	// if tag exists - add tag to message
 	if err := q.QueryRowAndClose(context.TODO(), db); err == nil {
 		addTagMutex.Unlock()
 		// check message does not already have this tag
-		var count int
+		var exists int
 
 		if err := sqlf.From(tenant("message_tags")).
-			Select("COUNT(ID)").To(&count).
+			Select("COUNT(ID)").To(&exists).
 			Where("ID = ?", id).
 			Where("TagID = ?", tagID).
 			QueryRowAndClose(context.Background(), db); err != nil {
-			return err
+			return "", err
 		}
-		if count > 0 {
+		if exists > 0 {
 			// already exists
-			return nil
+			return foundName.String, nil
 		}
 
 		logger.Log().Debugf("[tags] adding tag \"%s\" to %s", name, id)
@@ -93,7 +100,7 @@ func AddMessageTag(id, name string) error {
 			Set("ID", id).
 			Set("TagID", tagID).
 			ExecAndClose(context.TODO(), db)
-		return err
+		return foundName.String, err
 	}
 
 	// new tag, add to the database
@@ -101,7 +108,7 @@ func AddMessageTag(id, name string) error {
 		Set("Name", name).
 		ExecAndClose(context.TODO(), db); err != nil {
 		addTagMutex.Unlock()
-		return err
+		return name, err
 	}
 
 	addTagMutex.Unlock()
@@ -174,6 +181,79 @@ func GetAllTagsCount() map[string]int64 {
 	return tags
 }
 
+// RenameTag renames a tag
+func RenameTag(from, to string) error {
+	to = tools.CleanTag(to)
+	if to == "" || !config.ValidTagRegexp.MatchString(to) {
+		return fmt.Errorf("invalid tag name: %s", to)
+	}
+
+	if from == to {
+		return nil // ignore
+	}
+
+	var id, existsID int
+
+	q := sqlf.From(tenant("tags")).
+		Select(`ID`).To(&id).
+		Where(`Name = ?`, from).
+		Limit(1)
+	err := q.QueryRowAndClose(context.Background(), db)
+	if err != nil {
+		return fmt.Errorf("tag not found: %s", from)
+	}
+
+	// check if another tag by this name already exists
+	q = sqlf.From(tenant("tags")).
+		Select("ID").To(&existsID).
+		Where(`Name = ?`, to).
+		Where(`ID != ?`, id).
+		Limit(1)
+	err = q.QueryRowAndClose(context.Background(), db)
+	if err == nil || existsID != 0 {
+		return fmt.Errorf("tag already exists: %s", to)
+	}
+
+	q = sqlf.Update(tenant("tags")).
+		Set("Name", to).
+		Where("ID = ?", id)
+	_, err = q.ExecAndClose(context.Background(), db)
+
+	return err
+}
+
+// DeleteTag deleted a tag and removed all references to the tag
+func DeleteTag(tag string) error {
+	var id int
+
+	q := sqlf.From(tenant("tags")).
+		Select(`ID`).To(&id).
+		Where(`Name = ?`, tag).
+		Limit(1)
+	err := q.QueryRowAndClose(context.Background(), db)
+	if err != nil {
+		return fmt.Errorf("tag not found: %s", tag)
+	}
+
+	// delete all references
+	q = sqlf.DeleteFrom(tenant("message_tags")).
+		Where(`TagID = ?`, id)
+	_, err = q.ExecAndClose(context.Background(), db)
+	if err != nil {
+		return fmt.Errorf("error deleting tag references: %s", err.Error())
+	}
+
+	// delete tag
+	q = sqlf.DeleteFrom(tenant("tags")).
+		Where(`ID = ?`, id)
+	_, err = q.ExecAndClose(context.Background(), db)
+	if err != nil {
+		return fmt.Errorf("error deleting tag: %s", err.Error())
+	}
+
+	return nil
+}
+
 // PruneUnusedTags will delete all unused tags from the database
 func pruneUnusedTags() error {
 	q := sqlf.From(tenant("tags")).

internal/storage/tags_test.go

@@ -24,7 +24,7 @@ func TestTags(t *testing.T) {
 	}
 
 	for i := 0; i < 10; i++ {
-		if err := SetMessageTags(ids[i], []string{fmt.Sprintf("Tag-%d", i)}); err != nil {
+		if _, err := SetMessageTags(ids[i], []string{fmt.Sprintf("Tag-%d", i)}); err != nil {
 			t.Log("error ", err)
 			t.Fail()
 		}
@@ -58,7 +58,7 @@ func TestTags(t *testing.T) {
 		// pad number with 0 to ensure they are returned alphabetically
 		newTags = append(newTags, fmt.Sprintf("AnotherTag %02d", i))
 	}
-	if err := SetMessageTags(id, newTags); err != nil {
+	if _, err := SetMessageTags(id, newTags); err != nil {
 		t.Log("error ", err)
 		t.Fail()
 	}
@@ -82,7 +82,7 @@ func TestTags(t *testing.T) {
 	assertEqual(t, "", strings.Join(returnedTags, "|"), "Message tags should be empty")
 
 	// apply the same tag twice
-	if err := SetMessageTags(id, []string{"Duplicate Tag", "Duplicate Tag"}); err != nil {
+	if _, err := SetMessageTags(id, []string{"Duplicate Tag", "Duplicate Tag"}); err != nil {
 		t.Log("error ", err)
 		t.Fail()
 	}
@@ -94,7 +94,7 @@ func TestTags(t *testing.T) {
 	}
 
 	// apply tag with invalid characters
-	if err := SetMessageTags(id, []string{"Dirty! \"Tag\""}); err != nil {
+	if _, err := SetMessageTags(id, []string{"Dirty! \"Tag\""}); err != nil {
 		t.Log("error ", err)
 		t.Fail()
 	}

server/apiv1/api.go

@@ -583,7 +583,7 @@ func SetMessageTags(w http.ResponseWriter, r *http.Request) {
 
 	if len(ids) > 0 {
 		for _, id := range ids {
-			if err := storage.SetMessageTags(id, data.Tags); err != nil {
+			if _, err := storage.SetMessageTags(id, data.Tags); err != nil {
 				httpError(w, err.Error())
 				return
 			}

server/apiv1/swagger.go

@@ -95,6 +95,22 @@ type setTagsRequestBody struct {
 	IDs []string
 }
 
+// swagger:parameters RenameTag
+type renameTagParams struct {
+	// in: body
+	Body *renameTagRequestBody
+}
+
+// Rename tag request
+// swagger:model renameTagRequestBody
+type renameTagRequestBody struct {
+	// New name
+	//
+	// required: true
+	// example: New name
+	Name string
+}
+
 // swagger:parameters ReleaseMessage
 type releaseMessageParams struct {
 	// Message database ID

server/apiv1/tags.go

@@ -0,0 +1,100 @@
+package apiv1
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/axllent/mailpit/internal/storage"
+	"github.com/axllent/mailpit/server/websockets"
+	"github.com/gorilla/mux"
+)
+
+// RenameTag (method: PUT) used to rename a tag
+func RenameTag(w http.ResponseWriter, r *http.Request) {
+	// swagger:route PUT /api/v1/tags/{tag} tags RenameTag
+	//
+	// # Rename a tag
+	//
+	// Renames a tag.
+	//
+	//	Produces:
+	//	- text/plain
+	//
+	//	Schemes: http, https
+	//
+	//	Parameters:
+	//	  + name: tag
+	//	    in: path
+	//	    description: The url-encoded tag name to rename
+	//	    required: true
+	//	    type: string
+	//
+	//	Responses:
+	//		200: OKResponse
+	//		default: ErrorResponse
+
+	vars := mux.Vars(r)
+
+	tag := vars["tag"]
+
+	decoder := json.NewDecoder(r.Body)
+
+	var data struct {
+		Name string
+	}
+
+	err := decoder.Decode(&data)
+	if err != nil {
+		httpError(w, err.Error())
+		return
+	}
+
+	if err := storage.RenameTag(tag, data.Name); err != nil {
+		httpError(w, err.Error())
+		return
+	}
+
+	websockets.Broadcast("prune", nil)
+
+	w.Header().Add("Content-Type", "text/plain")
+	_, _ = w.Write([]byte("ok"))
+}
+
+// DeleteTag (method: DELETE) used to delete a tag
+func DeleteTag(w http.ResponseWriter, r *http.Request) {
+	// swagger:route DELETE /api/v1/tags/{tag} tags DeleteTag
+	//
+	// # Delete a tag
+	//
+	// Deletes a tag. This will not delete any messages with this tag.
+	//
+	//	Produces:
+	//	- text/plain
+	//
+	//	Schemes: http, https
+	//
+	//	Parameters:
+	//	  + name: tag
+	//	    in: path
+	//	    description: The url-encoded tag name to delete
+	//	    required: true
+	//	    type: string
+	//
+	//	Responses:
+	//		200: OKResponse
+	//		default: ErrorResponse
+
+	vars := mux.Vars(r)
+
+	tag := vars["tag"]
+
+	if err := storage.DeleteTag(tag); err != nil {
+		httpError(w, err.Error())
+		return
+	}
+
+	websockets.Broadcast("prune", nil)
+
+	w.Header().Add("Content-Type", "text/plain")
+	_, _ = w.Write([]byte("ok"))
+}

server/pop3/pop3_test.go

@@ -349,7 +349,7 @@ func insertEmailData(t *testing.T) {
 			t.Fail()
 		}
 
-		if err := storage.SetMessageTags(id, []string{fmt.Sprintf("Test tag %03d", i)}); err != nil {
+		if _, err := storage.SetMessageTags(id, []string{fmt.Sprintf("Test tag %03d", i)}); err != nil {
 			t.Log("error ", err)
 			t.Fail()
 		}

server/server.go

@@ -132,6 +132,8 @@ func apiRoutes() *mux.Router {
 	r.HandleFunc(config.Webroot+"api/v1/send", middleWareFunc(apiv1.SendMessageHandler)).Methods("POST")
 	r.HandleFunc(config.Webroot+"api/v1/tags", middleWareFunc(apiv1.GetAllTags)).Methods("GET")
 	r.HandleFunc(config.Webroot+"api/v1/tags", middleWareFunc(apiv1.SetMessageTags)).Methods("PUT")
+	r.HandleFunc(config.Webroot+"api/v1/tags/{tag}", middleWareFunc(apiv1.RenameTag)).Methods("PUT")
+	r.HandleFunc(config.Webroot+"api/v1/tags/{tag}", middleWareFunc(apiv1.DeleteTag)).Methods("DELETE")
 	r.HandleFunc(config.Webroot+"api/v1/message/{id}/part/{partID}", middleWareFunc(apiv1.DownloadAttachment)).Methods("GET")
 	r.HandleFunc(config.Webroot+"api/v1/message/{id}/part/{partID}/thumb", middleWareFunc(apiv1.Thumbnail)).Methods("GET")
 	r.HandleFunc(config.Webroot+"api/v1/message/{id}/headers", middleWareFunc(apiv1.GetHeaders)).Methods("GET")

server/server_test.go

@@ -383,7 +383,7 @@ func insertEmailData(t *testing.T) {
 			t.Fail()
 		}
 
-		if err := storage.SetMessageTags(id, []string{fmt.Sprintf("Test tag %03d", i)}); err != nil {
+		if _, err := storage.SetMessageTags(id, []string{fmt.Sprintf("Test tag %03d", i)}); err != nil {
 			t.Log("error ", err)
 			t.Fail()
 		}

server/ui-src/App.vue

@@ -2,6 +2,7 @@
 import CommonMixins from './mixins/CommonMixins'
 import Favicon from './components/Favicon.vue'
 import Notifications from './components/Notifications.vue'
+import EditTags from './components/EditTags.vue'
 import { RouterView } from 'vue-router'
 import { mailbox } from "./stores/mailbox"
 
@@ -11,6 +12,7 @@ export default {
 	components: {
 		Favicon,
 		Notifications,
+		EditTags
 	},
 
 	beforeMount() {
@@ -41,4 +43,5 @@ export default {
 	<RouterView />
 	<Favicon />
 	<Notifications />
+	<EditTags />
 </template>

server/ui-src/components/EditTags.vue

@@ -0,0 +1,119 @@
+<script>
+import CommonMixins from '../mixins/CommonMixins'
+import { mailbox } from '../stores/mailbox'
+
+export default {
+	mixins: [CommonMixins],
+
+	data() {
+		return {
+			mailbox,
+			editableTags: [],
+			validTagRe: new RegExp(/^([a-zA-Z0-9\-\ \_\.]){1,}$/),
+			tagToDelete: false,
+		}
+	},
+
+	watch: {
+		'mailbox.tags': {
+			handler(tags) {
+				this.editableTags = []
+				tags.forEach((t) => {
+					this.editableTags.push({ before: t, after: t })
+				})
+			},
+			deep: true
+		}
+	},
+
+	methods: {
+		validTag(t) {
+			if (!t.after.match(/^([a-zA-Z0-9\-\ \_\.]){1,}$/)) {
+				return false
+			}
+
+			const lower = t.after.toLowerCase()
+			for (let x = 0; x < this.editableTags.length; x++) {
+				if (this.editableTags[x].before != t.before && lower == this.editableTags[x].before.toLowerCase()) {
+					return false
+				}
+			}
+
+			return true
+		},
+
+		renameTag(t) {
+			if (!this.validTag(t) || t.before == t.after) {
+				return
+			}
+
+			this.put(this.resolve(`/api/v1/tags/` + encodeURI(t.before)), { Name: t.after }, () => {
+				// the API triggers a reload via websockets
+			})
+		},
+
+		deleteTag() {
+			this.delete(this.resolve(`/api/v1/tags/` + encodeURI(this.tagToDelete.before)), null, () => {
+				// the API triggers a reload via websockets
+				this.tagToDelete = false
+			})
+		},
+
+		resetTagEdit(t) {
+			for (let x = 0; x < this.editableTags.length; x++) {
+				if (this.editableTags[x].before != t.before && this.editableTags[x].before != this.editableTags[x].after) {
+					this.editableTags[x].after = this.editableTags[x].before
+				}
+			}
+		}
+	}
+}
+</script>
+
+<template>
+	<div class="modal fade" id="EditTagsModal" tabindex="-1" aria-labelledby="EditTagsModalLabel" aria-hidden="true"
+		data-bs-keyboard="false">
+		<div class="modal-dialog modal-lg">
+			<div class="modal-content">
+				<div class="modal-header">
+					<h5 class="modal-title" id="EditTagsModalLabel">Edit tags</h5>
+					<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+				</div>
+				<div class="modal-body">
+					<p>
+						Renaming a tag will update the tag for all messages. Deleting a tag will only delete the tag
+						itself, and not any messages which had the tag.
+					</p>
+					<div class="mb-3" v-for="t in editableTags">
+						<div class="input-group has-validation">
+							<input type="text" class="form-control" :class="!validTag(t) ? 'is-invalid' : ''"
+								v-model.trim="t.after" aria-describedby="inputGroupPrepend" required
+								@keydown.enter="renameTag(t)" @keydown.esc="t.after = t.before"
+								@focus="resetTagEdit(t)">
+							<button v-if="t.before != t.after" class="btn btn-success"
+								@click="renameTag(t)">Save</button>
+							<template v-else>
+								<button class="btn btn-outline-danger"
+									:class="tagToDelete.before == t.before ? 'text-white btn-danger' : ''"
+									@click="!tagToDelete ? tagToDelete = t : deleteTag()" @blur="tagToDelete = false">
+									<template v-if="tagToDelete == t">
+										Confirm?
+									</template>
+									<template v-else>
+										Delete
+									</template>
+								</button>
+							</template>
+							<div class="invalid-feedback">
+								Invalid tag name
+							</div>
+						</div>
+					</div>
+				</div>
+				<div class="modal-footer">
+					<button type="button" class="btn btn-outline-secondary" data-bs-dismiss="modal">Close</button>
+				</div>
+			</div>
+		</div>
+	</div>
+</template>

server/ui-src/components/NavTags.vue

@@ -86,6 +86,11 @@ export default {
 				Tags
 			</button>
 			<ul class="dropdown-menu dropdown-menu-end">
+				<li>
+					<button class="dropdown-item" data-bs-toggle="modal" data-bs-target="#EditTagsModal">
+						Edit tags
+					</button>
+				</li>
 				<li>
 					<button class="dropdown-item" @click="mailbox.showTagColors = !mailbox.showTagColors">
 						<template v-if="mailbox.showTagColors">Hide</template>

server/ui/api/v1/swagger.json

@@ -703,6 +703,79 @@
         }
       }
     },
+    "/api/v1/tags/{tag}": {
+      "put": {
+        "description": "Renames a tag.",
+        "produces": [
+          "text/plain"
+        ],
+        "schemes": [
+          "http",
+          "https"
+        ],
+        "tags": [
+          "tags"
+        ],
+        "summary": "Rename a tag",
+        "operationId": "RenameTag",
+        "parameters": [
+          {
+            "name": "Body",
+            "in": "body",
+            "schema": {
+              "$ref": "#/definitions/renameTagRequestBody"
+            }
+          },
+          {
+            "type": "string",
+            "description": "The url-encoded tag name to rename",
+            "name": "tag",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/responses/OKResponse"
+          },
+          "default": {
+            "$ref": "#/responses/ErrorResponse"
+          }
+        }
+      },
+      "delete": {
+        "description": "Deletes a tag. This will not delete any messages with this tag.",
+        "produces": [
+          "text/plain"
+        ],
+        "schemes": [
+          "http",
+          "https"
+        ],
+        "tags": [
+          "tags"
+        ],
+        "summary": "Delete a tag",
+        "operationId": "DeleteTag",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "The url-encoded tag name to delete",
+            "name": "tag",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/responses/OKResponse"
+          },
+          "default": {
+            "$ref": "#/responses/ErrorResponse"
+          }
+        }
+      }
+    },
     "/api/v1/webui": {
       "get": {
         "description": "Returns configuration settings for the web UI.\nIntended for web UI only!",
@@ -1690,6 +1763,21 @@
       },
       "x-go-package": "github.com/axllent/mailpit/server/apiv1"
     },
+    "renameTagRequestBody": {
+      "description": "Rename tag request",
+      "type": "object",
+      "required": [
+        "Name"
+      ],
+      "properties": {
+        "Name": {
+          "description": "New name",
+          "type": "string",
+          "example": "New name"
+        }
+      },
+      "x-go-package": "github.com/axllent/mailpit/server/apiv1"
+    },
     "setReadStatusRequestBody": {
       "description": "Set read status request",
       "type": "object",