Move smtpd/utils.go into dedicated stringutil pkg

rest/apiv1_controller.go

@@ -14,13 +14,13 @@ import (
 	"github.com/jhillyerd/inbucket/httpd"
 	"github.com/jhillyerd/inbucket/log"
 	"github.com/jhillyerd/inbucket/rest/model"
-	"github.com/jhillyerd/inbucket/smtpd"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 // MailboxListV1 renders a list of messages in a mailbox
 func MailboxListV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -55,7 +55,7 @@ func MailboxListV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context)
 func MailboxShowV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -117,7 +117,7 @@ func MailboxShowV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context)
 // MailboxPurgeV1 deletes all messages from a mailbox
 func MailboxPurgeV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -140,7 +140,7 @@ func MailboxPurgeV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context
 func MailboxSourceV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -174,7 +174,7 @@ func MailboxSourceV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Contex
 func MailboxDeleteV1(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}

rest/socketv1_controller.go

@@ -9,7 +9,7 @@ import (
 	"github.com/jhillyerd/inbucket/log"
 	"github.com/jhillyerd/inbucket/msghub"
 	"github.com/jhillyerd/inbucket/rest/model"
-	"github.com/jhillyerd/inbucket/smtpd"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 const (
@@ -169,7 +169,7 @@ func MonitorAllMessagesV1(
 
 func MonitorMailboxMessagesV1(
 	w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}

smtpd/filestore.go

@@ -14,6 +14,7 @@ import (
 	"github.com/jhillyerd/inbucket/config"
 	"github.com/jhillyerd/inbucket/datastore"
 	"github.com/jhillyerd/inbucket/log"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 // Name of index file in each mailbox
@@ -82,11 +83,11 @@ func DefaultFileDataStore() datastore.DataStore {
 // MailboxFor retrieves the Mailbox object for a specified email address, if the mailbox
 // does not exist, it will attempt to create it.
 func (ds *FileDataStore) MailboxFor(emailAddress string) (datastore.Mailbox, error) {
-	name, err := ParseMailboxName(emailAddress)
+	name, err := stringutil.ParseMailboxName(emailAddress)
 	if err != nil {
 		return nil, err
 	}
-	dir := HashMailboxName(name)
+	dir := stringutil.HashMailboxName(name)
 	s1 := dir[0:3]
 	s2 := dir[0:6]
 	path := filepath.Join(ds.mailPath, s1, s2, dir)

smtpd/handler.go

@@ -15,6 +15,7 @@ import (
 	"github.com/jhillyerd/inbucket/datastore"
 	"github.com/jhillyerd/inbucket/log"
 	"github.com/jhillyerd/inbucket/msghub"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 // State tracks the current mode of our SMTP state machine
@@ -266,7 +267,7 @@ func (ss *Session) readyHandler(cmd string, arg string) {
 			return
 		}
 		from := m[1]
-		if _, _, err := ParseEmailAddress(from); err != nil {
+		if _, _, err := stringutil.ParseEmailAddress(from); err != nil {
 			ss.send("501 Bad sender address syntax")
 			ss.logWarn("Bad address as MAIL arg: %q, %s", from, err)
 			return
@@ -315,7 +316,7 @@ func (ss *Session) mailHandler(cmd string, arg string) {
 		}
 		// This trim is probably too forgiving
 		recip := strings.Trim(arg[3:], "<> ")
-		if _, _, err := ParseEmailAddress(recip); err != nil {
+		if _, _, err := stringutil.ParseEmailAddress(recip); err != nil {
 			ss.send("501 Bad recipient address syntax")
 			ss.logWarn("Bad address as RCPT arg: %q, %s", recip, err)
 			return
@@ -355,7 +356,7 @@ func (ss *Session) dataHandler() {
 	if ss.server.storeMessages {
 		for e := ss.recipients.Front(); e != nil; e = e.Next() {
 			recip := e.Value.(string)
-			local, domain, err := ParseEmailAddress(recip)
+			local, domain, err := stringutil.ParseEmailAddress(recip)
 			if err != nil {
 				ss.logError("Failed to parse address for %q", recip)
 				ss.send(fmt.Sprintf("451 Failed to open mailbox for %v", recip))

stringutil/utils.go

@@ -1,4 +1,4 @@
-package smtpd
+package stringutil
 
 import (
 	"bytes"
@@ -41,7 +41,7 @@ func ParseMailboxName(localPart string) (result string, err error) {
 	return result, nil
 }
 
-// HashMailboxName accepts a mailbox name and hashes it.  Inbucket uses this as
+// HashMailboxName accepts a mailbox name and hashes it.  filestore uses this as
 // the directory to house the mailbox
 func HashMailboxName(mailbox string) string {
 	h := sha1.New()

stringutil/utils_test.go

@@ -1,4 +1,4 @@
-package smtpd
+package stringutil
 
 import (
 	"strings"

webui/mailbox_controller.go

@@ -10,7 +10,7 @@ import (
 	"github.com/jhillyerd/inbucket/datastore"
 	"github.com/jhillyerd/inbucket/httpd"
 	"github.com/jhillyerd/inbucket/log"
-	"github.com/jhillyerd/inbucket/smtpd"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 // MailboxIndex renders the index page for a particular mailbox
@@ -24,7 +24,7 @@ func MailboxIndex(w http.ResponseWriter, req *http.Request, ctx *httpd.Context)
 		http.Redirect(w, req, httpd.Reverse("RootIndex"), http.StatusSeeOther)
 		return nil
 	}
-	name, err = smtpd.ParseMailboxName(name)
+	name, err = stringutil.ParseMailboxName(name)
 	if err != nil {
 		ctx.Session.AddFlash(err.Error(), "errors")
 		_ = ctx.Session.Save(req, w)
@@ -51,7 +51,7 @@ func MailboxIndex(w http.ResponseWriter, req *http.Request, ctx *httpd.Context)
 func MailboxLink(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		ctx.Session.AddFlash(err.Error(), "errors")
 		_ = ctx.Session.Save(req, w)
@@ -67,7 +67,7 @@ func MailboxLink(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (
 // MailboxList renders a list of messages in a mailbox. Renders a partial
 func MailboxList(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -94,7 +94,7 @@ func MailboxList(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (
 func MailboxShow(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -134,7 +134,7 @@ func MailboxShow(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (
 func MailboxHTML(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -171,7 +171,7 @@ func MailboxHTML(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (
 func MailboxSource(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		return err
 	}
@@ -206,7 +206,7 @@ func MailboxSource(w http.ResponseWriter, req *http.Request, ctx *httpd.Context)
 func MailboxDownloadAttach(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
 	id := ctx.Vars["id"]
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		ctx.Session.AddFlash(err.Error(), "errors")
 		_ = ctx.Session.Save(req, w)
@@ -258,7 +258,7 @@ func MailboxDownloadAttach(w http.ResponseWriter, req *http.Request, ctx *httpd.
 // MailboxViewAttach sends the attachment to the client for online viewing
 func MailboxViewAttach(w http.ResponseWriter, req *http.Request, ctx *httpd.Context) (err error) {
 	// Don't have to validate these aren't empty, Gorilla returns 404
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		ctx.Session.AddFlash(err.Error(), "errors")
 		_ = ctx.Session.Save(req, w)

webui/root_controller.go

@@ -8,7 +8,7 @@ import (
 
 	"github.com/jhillyerd/inbucket/config"
 	"github.com/jhillyerd/inbucket/httpd"
-	"github.com/jhillyerd/inbucket/smtpd"
+	"github.com/jhillyerd/inbucket/stringutil"
 )
 
 // RootIndex serves the Inbucket landing page
@@ -58,7 +58,7 @@ func RootMonitorMailbox(w http.ResponseWriter, req *http.Request, ctx *httpd.Con
 		http.Redirect(w, req, httpd.Reverse("RootIndex"), http.StatusSeeOther)
 		return nil
 	}
-	name, err := smtpd.ParseMailboxName(ctx.Vars["name"])
+	name, err := stringutil.ParseMailboxName(ctx.Vars["name"])
 	if err != nil {
 		ctx.Session.AddFlash(err.Error(), "errors")
 		_ = ctx.Session.Save(req, w)