From 97a2016177edd18968efabce4602eb3b49bfb3ff Mon Sep 17 00:00:00 2001
From: James Hillyerd <james@hillyerd.com>
Date: Thu, 10 Oct 2013 14:04:22 -0700
Subject: [PATCH] Add customizable greeting to index page

Allow an organization to copy the greeting.html file out of the themes
directory, customize it, then point the greeting.file config option at
it so that it will survive Inbucket upgrades.
---
 config/config.go                          | 10 +++++++++-
 etc/devel.conf                            |  4 ++++
 etc/inbucket.conf                         |  4 ++++
 etc/unix-sample.conf                      |  4 ++++
 etc/win-sample.conf                       |  4 ++++
 themes/greeting.html                      |  9 +++++++++
 themes/integral/templates/root/index.html |  9 +--------
 web/root_controller.go                    |  8 ++++++++
 8 files changed, 43 insertions(+), 9 deletions(-)
 create mode 100644 themes/greeting.html

diff --git a/config/config.go b/config/config.go
index bfa1e5f..25b6030 100644
--- a/config/config.go
+++ b/config/config.go
@@ -25,7 +25,7 @@ type SmtpConfig struct {
 type Pop3Config struct {
 	Ip4address     net.IP
 	Ip4port        int
-	Domain string
+	Domain         string
 	MaxIdleSeconds int
 }
 
@@ -35,6 +35,7 @@ type WebConfig struct {
 	TemplateDir   string
 	TemplateCache bool
 	PublicDir     string
+	GreetingFile  string
 }
 
 type DataStoreConfig struct {
@@ -328,6 +329,13 @@ func parseWebConfig() error {
 	}
 	webConfig.PublicDir = str
 
+	option = "greeting.file"
+	str, err = Config.String(section, option)
+	if err != nil {
+		return fmt.Errorf("Failed to parse [%v]%v: '%v'", section, option, err)
+	}
+	webConfig.GreetingFile = str
+
 	return nil
 }
 
diff --git a/etc/devel.conf b/etc/devel.conf
index 2ce5c4b..56b5c04 100644
--- a/etc/devel.conf
+++ b/etc/devel.conf
@@ -81,6 +81,10 @@ template.cache=false
 # Path to the selected themes public (static) files
 public.dir=%(install.dir)s/themes/%(theme)s/public
 
+# Path to the greeting HTML displayed on front page, can
+# be moved out of installation dir for customization
+greeting.file=%(install.dir)s/themes/greeting.html
+
 #############################################################################
 [datastore]
 
diff --git a/etc/inbucket.conf b/etc/inbucket.conf
index a6c9c81..2236f1c 100644
--- a/etc/inbucket.conf
+++ b/etc/inbucket.conf
@@ -81,6 +81,10 @@ template.cache=true
 # Path to the selected themes public (static) files
 public.dir=%(install.dir)s/themes/%(theme)s/public
 
+# Path to the greeting HTML displayed on front page, can
+# be moved out of installation dir for customization
+greeting.file=%(install.dir)s/themes/greeting.html
+
 #############################################################################
 [datastore]
 
diff --git a/etc/unix-sample.conf b/etc/unix-sample.conf
index 17b7b9d..00061f8 100644
--- a/etc/unix-sample.conf
+++ b/etc/unix-sample.conf
@@ -81,6 +81,10 @@ template.cache=true
 # Path to the selected themes public (static) files
 public.dir=%(install.dir)s/themes/%(theme)s/public
 
+# Path to the greeting HTML displayed on front page, can
+# be moved out of installation dir for customization
+greeting.file=%(install.dir)s/themes/greeting.html
+
 #############################################################################
 [datastore]
 
diff --git a/etc/win-sample.conf b/etc/win-sample.conf
index b0fcdcf..507336c 100644
--- a/etc/win-sample.conf
+++ b/etc/win-sample.conf
@@ -81,6 +81,10 @@ template.cache=true
 # Path to the selected themes public (static) files
 public.dir=%(install.dir)s\themes\%(theme)s\public
 
+# Path to the greeting HTML displayed on front page, can
+# be moved out of installation dir for customization
+greeting.file=%(install.dir)s\themes\greeting.html
+
 #############################################################################
 [datastore]
 
diff --git a/themes/greeting.html b/themes/greeting.html
new file mode 100644
index 0000000..67f4794
--- /dev/null
+++ b/themes/greeting.html
@@ -0,0 +1,9 @@
+<p>Inbucket is an email testing service; it will accept email for any email
+address and make it available to view without a password.</p>
+
+<p>To view email for a particular address, enter the username portion
+of the address into the box on the upper right and click <em>go</em>.</p>
+
+<p>This message can be customized by editing greeting.html.  Change the
+configuration option <code>greeting.file</code> if you'd like to move it
+outside of the Inbucket installation directory.</p>
diff --git a/themes/integral/templates/root/index.html b/themes/integral/templates/root/index.html
index a8404c1..8a1899e 100644
--- a/themes/integral/templates/root/index.html
+++ b/themes/integral/templates/root/index.html
@@ -9,11 +9,4 @@
 </div>
 {{end}}
 
-{{define "content"}}
-<p>Inbucket is an email testing service; it will accept email for any email
-address and make it available to view without a password.</p>
-
-<p>To view email for a particular address, enter the username portion
-of the address into the box on the upper right and click <em>go</em>.</p>
-{{end}}
-
+{{define "content"}}{{.greeting}}{{end}}
diff --git a/web/root_controller.go b/web/root_controller.go
index f5df0de..aa410a1 100644
--- a/web/root_controller.go
+++ b/web/root_controller.go
@@ -3,12 +3,20 @@ package web
 import (
 	"fmt"
 	"github.com/jhillyerd/inbucket/config"
+	"html/template"
+	"io/ioutil"
 	"net/http"
 )
 
 func RootIndex(w http.ResponseWriter, req *http.Request, ctx *Context) (err error) {
+	greeting, err := ioutil.ReadFile(config.GetWebConfig().GreetingFile)
+	if err != nil {
+		return fmt.Errorf("Failed to load greeting: %v", err)
+	}
+		
 	return RenderTemplate("root/index.html", w, map[string]interface{}{
 		"ctx": ctx,
+		"greeting": template.HTML(string(greeting)),
 	})
 }