Refactor the web routes and methods to a new package, pass in dependencies

main.go

@@ -1,46 +1,22 @@
 package main
 
 import (
-	"embed"
-	"encoding/json"
 	"flag"
 	"fmt"
-	"html/template"
-	"io"
 	"log"
 	"net/http"
-	"strings"
 	"time"
 
-	"strconv"
-
-	"github.com/gorilla/mux"
 	"github.com/tardisx/gropple/config"
 	"github.com/tardisx/gropple/download"
 	"github.com/tardisx/gropple/version"
+	"github.com/tardisx/gropple/web"
 )
 
-var dm *download.Manager
-var configService *config.ConfigService
-
-var versionInfo = version.Manager{
-	VersionInfo: version.Info{CurrentVersion: "v0.6.0-alpha.4"},
-}
-
-//go:embed web
-var webFS embed.FS
-
-type successResponse struct {
-	Success bool   `json:"success"`
-	Message string `json:"message"`
-}
-
-type errorResponse struct {
-	Success bool   `json:"success"`
-	Error   string `json:"error"`
-}
-
 func main() {
+	versionInfo := &version.Manager{
+		VersionInfo: version.Info{CurrentVersion: "v0.7.0"},
+	}
 	log.Printf("Starting gropple %s - https://github.com/tardisx/gropple", versionInfo.GetInfo().CurrentVersion)
 
 	var configPath string
@@ -48,7 +24,7 @@ func main() {
 
 	flag.Parse()
 
-	configService = &config.ConfigService{}
+	configService := &config.ConfigService{}
 	if configPath != "" {
 		configService.ConfigPath = configPath
 	} else {
@@ -73,23 +49,9 @@ func main() {
 	}
 
 	// create the download manager
-	dm = &download.Manager{MaxPerDomain: configService.Config.Server.MaximumActiveDownloads}
+	downloadManager := &download.Manager{MaxPerDomain: configService.Config.Server.MaximumActiveDownloads}
 
-	r := mux.NewRouter()
+	r := web.CreateRoutes(configService, downloadManager, versionInfo)
-	r.HandleFunc("/", homeHandler)
-	r.HandleFunc("/static/{filename}", staticHandler)
-	r.HandleFunc("/config", configHandler)
-	r.HandleFunc("/fetch", fetchHandler)
-	r.HandleFunc("/fetch/{id}", fetchHandler)
-
-	// info for the list
-	r.HandleFunc("/rest/fetch", fetchInfoRESTHandler)
-	// info for one, including update
-	r.HandleFunc("/rest/fetch/{id}", fetchInfoOneRESTHandler)
-	r.HandleFunc("/rest/version", versionRESTHandler)
-	r.HandleFunc("/rest/config", configRESTHandler)
-
-	http.Handle("/", r)
 
 	srv := &http.Server{
 		Handler: r,
@@ -112,323 +74,12 @@ func main() {
 
 	// start downloading queued downloads when slots available, and clean up
 	// old entries
-	go dm.ManageQueue()
+	go downloadManager.ManageQueue()
 
 	// add testdata if compiled with the '-tags testdata' flag
-	dm.AddStressTestData(configService)
+	downloadManager.AddStressTestData(configService)
 
 	log.Printf("Visit %s for details on installing the bookmarklet and to check status", configService.Config.Server.Address)
 	log.Fatal(srv.ListenAndServe())
 
 }
-
-// versionRESTHandler returns the version information, if we have up-to-date info from github
-func versionRESTHandler(w http.ResponseWriter, r *http.Request) {
-	if versionInfo.GetInfo().GithubVersionFetched {
-		b, _ := json.Marshal(versionInfo.GetInfo())
-		_, err := w.Write(b)
-		if err != nil {
-			log.Printf("could not write to client: %s", err)
-		}
-	} else {
-		w.WriteHeader(400)
-	}
-}
-
-// homeHandler returns the main index page
-func homeHandler(w http.ResponseWriter, r *http.Request) {
-	w.WriteHeader(http.StatusOK)
-
-	bookmarkletURL := fmt.Sprintf("javascript:(function(f,s,n,o){window.open(f+encodeURIComponent(s),n,o)}('%s/fetch?url=',window.location,'yourform','width=%d,height=%d'));", configService.Config.Server.Address, configService.Config.UI.PopupWidth, configService.Config.UI.PopupHeight)
-
-	t, err := template.ParseFS(webFS, "web/layout.tmpl", "web/menu.tmpl", "web/index.html")
-	if err != nil {
-		panic(err)
-	}
-
-	type Info struct {
-		Manager        *download.Manager
-		BookmarkletURL template.URL
-		Config         *config.Config
-		Version        version.Info
-	}
-
-	info := Info{
-		Manager:        dm,
-		BookmarkletURL: template.URL(bookmarkletURL),
-		Config:         configService.Config,
-		Version:        versionInfo.GetInfo(),
-	}
-
-	dm.Lock.Lock()
-	defer dm.Lock.Unlock()
-	err = t.ExecuteTemplate(w, "layout", info)
-	if err != nil {
-		panic(err)
-	}
-}
-
-// staticHandler handles requests for static files
-func staticHandler(w http.ResponseWriter, r *http.Request) {
-	vars := mux.Vars(r)
-
-	filename := vars["filename"]
-	if strings.Index(filename, ".js") == len(filename)-3 {
-		f, err := webFS.Open("web/" + filename)
-		if err != nil {
-			log.Printf("error accessing %s - %v", filename, err)
-			w.WriteHeader(http.StatusNotFound)
-			return
-		}
-		w.WriteHeader(http.StatusOK)
-		_, err = io.Copy(w, f)
-		if err != nil {
-			log.Printf("could not write to client: %s", err)
-		}
-		return
-	}
-	w.WriteHeader(http.StatusNotFound)
-}
-
-// configHandler returns the configuration page
-func configHandler(w http.ResponseWriter, r *http.Request) {
-	w.WriteHeader(http.StatusOK)
-
-	t, err := template.ParseFS(webFS, "web/layout.tmpl", "web/menu.tmpl", "web/config.html")
-	if err != nil {
-		panic(err)
-	}
-
-	err = t.ExecuteTemplate(w, "layout", nil)
-	if err != nil {
-		panic(err)
-	}
-}
-
-// configRESTHandler handles both reading and writing of the configuration
-func configRESTHandler(w http.ResponseWriter, r *http.Request) {
-
-	if r.Method == "POST" {
-		log.Printf("Updating config")
-		b, err := io.ReadAll(r.Body)
-		if err != nil {
-			panic(err)
-		}
-		err = configService.Config.UpdateFromJSON(b)
-
-		if err != nil {
-			errorRes := errorResponse{Success: false, Error: err.Error()}
-			errorResB, _ := json.Marshal(errorRes)
-			w.WriteHeader(400)
-			_, err = w.Write(errorResB)
-			if err != nil {
-				log.Printf("could not write to client: %s", err)
-			}
-			return
-		}
-		configService.WriteConfig()
-	}
-	b, _ := json.Marshal(configService.Config)
-	_, err := w.Write(b)
-	if err != nil {
-		log.Printf("could not write config to client: %s", err)
-	}
-}
-
-func fetchInfoOneRESTHandler(w http.ResponseWriter, r *http.Request) {
-	vars := mux.Vars(r)
-	idString := vars["id"]
-	if idString != "" {
-		id, err := strconv.Atoi(idString)
-		if err != nil {
-			http.NotFound(w, r)
-			return
-		}
-
-		thisDownload, err := dm.GetDlById(id)
-		if err != nil {
-			http.NotFound(w, r)
-			return
-		}
-		if thisDownload == nil {
-			panic("should not happen")
-		}
-
-		if r.Method == "POST" {
-
-			type updateRequest struct {
-				Action      string `json:"action"`
-				Profile     string `json:"profile"`
-				Destination string `json:"destination"`
-			}
-
-			thisReq := updateRequest{}
-
-			b, err := io.ReadAll(r.Body)
-			if err != nil {
-				panic(err)
-			}
-
-			err = json.Unmarshal(b, &thisReq)
-			if err != nil {
-				errorRes := errorResponse{Success: false, Error: err.Error()}
-				errorResB, _ := json.Marshal(errorRes)
-				w.WriteHeader(400)
-				_, err = w.Write(errorResB)
-				if err != nil {
-					log.Printf("could not write to client: %s", err)
-				}
-				return
-			}
-
-			if thisReq.Action == "start" {
-				// find the profile they asked for
-				profile := configService.Config.ProfileCalled(thisReq.Profile)
-				if profile == nil {
-					panic("bad profile name?")
-				}
-				// set the profile
-				thisDownload.Lock.Lock()
-				thisDownload.DownloadProfile = *profile
-				thisDownload.Lock.Unlock()
-
-				dm.Queue(thisDownload)
-
-				succRes := successResponse{Success: true, Message: "download started"}
-				succResB, _ := json.Marshal(succRes)
-				_, err = w.Write(succResB)
-				if err != nil {
-					log.Printf("could not write to client: %s", err)
-				}
-				return
-			}
-
-			if thisReq.Action == "change_destination" {
-
-				// nil means (probably) that they chose "don't move" - which is fine,
-				// and maps to nil on the Download (the default state).
-				destination := configService.Config.DestinationCalled(thisReq.Destination)
-				dm.ChangeDestination(thisDownload, destination)
-
-				//				log.Printf("%#v", thisDownload)
-
-				succRes := successResponse{Success: true, Message: "destination changed"}
-				succResB, _ := json.Marshal(succRes)
-				_, err = w.Write(succResB)
-				if err != nil {
-					log.Printf("could not write to client: %s", err)
-				}
-				return
-			}
-
-			if thisReq.Action == "stop" {
-
-				thisDownload.Stop()
-				succRes := successResponse{Success: true, Message: "download stopped"}
-				succResB, _ := json.Marshal(succRes)
-				_, err = w.Write(succResB)
-				if err != nil {
-					log.Printf("could not write to client: %s", err)
-				}
-				return
-			}
-		}
-
-		// just a get, return the object
-		thisDownload.Lock.Lock()
-		defer thisDownload.Lock.Unlock()
-
-		b, _ := json.Marshal(thisDownload)
-
-		_, err = w.Write(b)
-		if err != nil {
-			log.Printf("could not write to client: %s", err)
-		}
-		return
-	} else {
-		http.NotFound(w, r)
-	}
-}
-
-func fetchInfoRESTHandler(w http.ResponseWriter, r *http.Request) {
-
-	b, err := dm.DownloadsAsJSON()
-	if err != nil {
-		panic(err)
-	}
-	_, err = w.Write(b)
-	if err != nil {
-		log.Printf("could not write to client: %s", err)
-	}
-}
-
-func fetchHandler(w http.ResponseWriter, r *http.Request) {
-
-	// if they refreshed the popup, just load the existing object, don't
-	// create a new one
-	vars := mux.Vars(r)
-	idString := vars["id"]
-
-	idInt, err := strconv.ParseInt(idString, 10, 32)
-
-	// existing, load it up
-	if err == nil && idInt > 0 {
-
-		dl, err := dm.GetDlById(int(idInt))
-		if err != nil {
-			log.Printf("not found")
-			w.WriteHeader(404)
-			return
-		}
-
-		t, err := template.ParseFS(webFS, "web/layout.tmpl", "web/popup.html")
-		if err != nil {
-			panic(err)
-		}
-
-		templateData := map[string]interface{}{"dl": dl, "config": configService.Config, "canStop": download.CanStopDownload}
-
-		err = t.ExecuteTemplate(w, "layout", templateData)
-		if err != nil {
-			panic(err)
-		}
-		return
-	}
-
-	query := r.URL.Query()
-	url, present := query["url"]
-
-	if !present {
-		w.WriteHeader(400)
-		fmt.Fprint(w, "No url supplied")
-		return
-	} else {
-
-		log.Printf("popup for %s", url)
-		// check the URL for a sudden but inevitable betrayal
-		if strings.Contains(url[0], configService.Config.Server.Address) {
-			w.WriteHeader(400)
-			fmt.Fprint(w, "you mustn't gropple your gropple :-)")
-			return
-		}
-
-		// create the new download
-		newDL := download.NewDownload(url[0], configService.Config)
-		dm.AddDownload(newDL)
-
-		t, err := template.ParseFS(webFS, "web/layout.tmpl", "web/popup.html")
-		if err != nil {
-			panic(err)
-		}
-
-		newDL.Lock.Lock()
-		defer newDL.Lock.Unlock()
-
-		templateData := map[string]interface{}{"Version": versionInfo.GetInfo(), "dl": newDL, "config": configService.Config, "canStop": download.CanStopDownload}
-
-		err = t.ExecuteTemplate(w, "layout", templateData)
-		if err != nil {
-			panic(err)
-		}
-	}
-}

web/web.go

@@ -0,0 +1,375 @@
+package web
+
+import (
+	"embed"
+	"encoding/json"
+	"fmt"
+	"html/template"
+	"io"
+	"log"
+	"net/http"
+	"strconv"
+	"strings"
+
+	"github.com/gorilla/mux"
+	"github.com/tardisx/gropple/config"
+	"github.com/tardisx/gropple/download"
+	"github.com/tardisx/gropple/version"
+)
+
+type successResponse struct {
+	Success bool   `json:"success"`
+	Message string `json:"message"`
+}
+
+type errorResponse struct {
+	Success bool   `json:"success"`
+	Error   string `json:"error"`
+}
+
+//go:embed data/**
+var webFS embed.FS
+
+func CreateRoutes(cs *config.ConfigService, dm *download.Manager, vm *version.Manager) *mux.Router {
+	r := mux.NewRouter()
+	r.HandleFunc("/", homeHandler(cs, vm, dm))
+	r.HandleFunc("/static/{filename}", staticHandler())
+	r.HandleFunc("/config", configHandler)
+	r.HandleFunc("/fetch", fetchHandler(cs, vm, dm))
+	r.HandleFunc("/fetch/{id}", fetchHandler(cs, vm, dm))
+
+	// info for the list
+	r.HandleFunc("/rest/fetch", fetchInfoRESTHandler(dm))
+	// info for one, including update
+	r.HandleFunc("/rest/fetch/{id}", fetchInfoOneRESTHandler(cs, dm))
+	r.HandleFunc("/rest/version", versionRESTHandler(vm))
+	r.HandleFunc("/rest/config", configRESTHandler(cs))
+
+	http.Handle("/", r)
+	return r
+}
+
+// versionRESTHandler returns the version information, if we have up-to-date info from github
+func versionRESTHandler(vm *version.Manager) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		if vm.GetInfo().GithubVersionFetched {
+			b, _ := json.Marshal(vm.GetInfo())
+			_, err := w.Write(b)
+			if err != nil {
+				log.Printf("could not write to client: %s", err)
+			}
+		} else {
+			w.WriteHeader(400)
+		}
+	}
+}
+
+// homeHandler returns the main index page
+func homeHandler(cs *config.ConfigService, vm *version.Manager, dm *download.Manager) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+
+		bookmarkletURL := fmt.Sprintf("javascript:(function(f,s,n,o){window.open(f+encodeURIComponent(s),n,o)}('%s/fetch?url=',window.location,'yourform','width=%d,height=%d'));", cs.Config.Server.Address, cs.Config.UI.PopupWidth, cs.Config.UI.PopupHeight)
+
+		t, err := template.ParseFS(webFS, "data/templates/layout.tmpl", "data/templates/menu.tmpl", "data/templates/index.tmpl")
+		if err != nil {
+			panic(err)
+		}
+
+		type Info struct {
+			Manager        *download.Manager
+			BookmarkletURL template.URL
+			Config         *config.Config
+			Version        version.Info
+		}
+
+		info := Info{
+			Manager:        dm,
+			BookmarkletURL: template.URL(bookmarkletURL),
+			Config:         cs.Config,
+			Version:        vm.GetInfo(),
+		}
+
+		dm.Lock.Lock()
+		defer dm.Lock.Unlock()
+		err = t.ExecuteTemplate(w, "layout", info)
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+// staticHandler handles requests for static files
+func staticHandler() func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := mux.Vars(r)
+
+		filename := vars["filename"]
+		if strings.Index(filename, ".js") == len(filename)-3 {
+			f, err := webFS.Open("data/js/" + filename)
+			if err != nil {
+				log.Printf("error accessing %s - %v", filename, err)
+				w.WriteHeader(http.StatusNotFound)
+				return
+			}
+			w.WriteHeader(http.StatusOK)
+			_, err = io.Copy(w, f)
+			if err != nil {
+				log.Printf("could not write to client: %s", err)
+			}
+			return
+		}
+		w.WriteHeader(http.StatusNotFound)
+	}
+}
+
+// configHandler returns the configuration page
+func configHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+
+	t, err := template.ParseFS(webFS, "data/templates/layout.tmpl", "data/templates/menu.tmpl", "data/templates/config.tmpl")
+	if err != nil {
+		panic(err)
+	}
+
+	err = t.ExecuteTemplate(w, "layout", nil)
+	if err != nil {
+		panic(err)
+	}
+}
+
+// configRESTHandler handles both reading and writing of the configuration
+func configRESTHandler(cs *config.ConfigService) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+
+		if r.Method == "POST" {
+			log.Printf("Updating config")
+			b, err := io.ReadAll(r.Body)
+			if err != nil {
+				panic(err)
+			}
+			err = cs.Config.UpdateFromJSON(b)
+
+			if err != nil {
+				errorRes := errorResponse{Success: false, Error: err.Error()}
+				errorResB, _ := json.Marshal(errorRes)
+				w.WriteHeader(400)
+				_, err = w.Write(errorResB)
+				if err != nil {
+					log.Printf("could not write to client: %s", err)
+				}
+				return
+			}
+			cs.WriteConfig()
+		}
+		b, _ := json.Marshal(cs.Config)
+		_, err := w.Write(b)
+		if err != nil {
+			log.Printf("could not write config to client: %s", err)
+		}
+	}
+}
+
+func fetchInfoOneRESTHandler(cs *config.ConfigService, dm *download.Manager) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := mux.Vars(r)
+		idString := vars["id"]
+		if idString != "" {
+			id, err := strconv.Atoi(idString)
+			if err != nil {
+				http.NotFound(w, r)
+				return
+			}
+
+			thisDownload, err := dm.GetDlById(id)
+			if err != nil {
+				http.NotFound(w, r)
+				return
+			}
+			if thisDownload == nil {
+				panic("should not happen")
+			}
+
+			if r.Method == "POST" {
+
+				type updateRequest struct {
+					Action      string `json:"action"`
+					Profile     string `json:"profile"`
+					Destination string `json:"destination"`
+				}
+
+				thisReq := updateRequest{}
+
+				b, err := io.ReadAll(r.Body)
+				if err != nil {
+					panic(err)
+				}
+
+				err = json.Unmarshal(b, &thisReq)
+				if err != nil {
+					errorRes := errorResponse{Success: false, Error: err.Error()}
+					errorResB, _ := json.Marshal(errorRes)
+					w.WriteHeader(400)
+					_, err = w.Write(errorResB)
+					if err != nil {
+						log.Printf("could not write to client: %s", err)
+					}
+					return
+				}
+
+				if thisReq.Action == "start" {
+					// find the profile they asked for
+					profile := cs.Config.ProfileCalled(thisReq.Profile)
+					if profile == nil {
+						panic("bad profile name?")
+					}
+					// set the profile
+					thisDownload.Lock.Lock()
+					thisDownload.DownloadProfile = *profile
+					thisDownload.Lock.Unlock()
+
+					dm.Queue(thisDownload)
+
+					succRes := successResponse{Success: true, Message: "download started"}
+					succResB, _ := json.Marshal(succRes)
+					_, err = w.Write(succResB)
+					if err != nil {
+						log.Printf("could not write to client: %s", err)
+					}
+					return
+				}
+
+				if thisReq.Action == "change_destination" {
+
+					// nil means (probably) that they chose "don't move" - which is fine,
+					// and maps to nil on the Download (the default state).
+					destination := cs.Config.DestinationCalled(thisReq.Destination)
+					dm.ChangeDestination(thisDownload, destination)
+
+					//				log.Printf("%#v", thisDownload)
+
+					succRes := successResponse{Success: true, Message: "destination changed"}
+					succResB, _ := json.Marshal(succRes)
+					_, err = w.Write(succResB)
+					if err != nil {
+						log.Printf("could not write to client: %s", err)
+					}
+					return
+				}
+
+				if thisReq.Action == "stop" {
+
+					thisDownload.Stop()
+					succRes := successResponse{Success: true, Message: "download stopped"}
+					succResB, _ := json.Marshal(succRes)
+					_, err = w.Write(succResB)
+					if err != nil {
+						log.Printf("could not write to client: %s", err)
+					}
+					return
+				}
+			}
+
+			// just a get, return the object
+			thisDownload.Lock.Lock()
+			defer thisDownload.Lock.Unlock()
+
+			b, _ := json.Marshal(thisDownload)
+
+			_, err = w.Write(b)
+			if err != nil {
+				log.Printf("could not write to client: %s", err)
+			}
+			return
+		} else {
+			http.NotFound(w, r)
+		}
+	}
+}
+
+func fetchInfoRESTHandler(dm *download.Manager) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+
+		b, err := dm.DownloadsAsJSON()
+		if err != nil {
+			panic(err)
+		}
+		_, err = w.Write(b)
+		if err != nil {
+			log.Printf("could not write to client: %s", err)
+		}
+	}
+}
+
+func fetchHandler(cs *config.ConfigService, vm *version.Manager, dm *download.Manager) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+
+		// if they refreshed the popup, just load the existing object, don't
+		// create a new one
+		vars := mux.Vars(r)
+		idString := vars["id"]
+
+		idInt, err := strconv.ParseInt(idString, 10, 32)
+
+		// existing, load it up
+		if err == nil && idInt > 0 {
+
+			dl, err := dm.GetDlById(int(idInt))
+			if err != nil {
+				log.Printf("not found")
+				w.WriteHeader(404)
+				return
+			}
+
+			t, err := template.ParseFS(webFS, "data/templates/layout.tmpl", "data/templates/popup.tmpl")
+			if err != nil {
+				panic(err)
+			}
+
+			templateData := map[string]interface{}{"dl": dl, "config": cs.Config, "canStop": download.CanStopDownload}
+
+			err = t.ExecuteTemplate(w, "layout", templateData)
+			if err != nil {
+				panic(err)
+			}
+			return
+		}
+
+		query := r.URL.Query()
+		url, present := query["url"]
+
+		if !present {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "No url supplied")
+			return
+		} else {
+
+			log.Printf("popup for %s", url)
+			// check the URL for a sudden but inevitable betrayal
+			if strings.Contains(url[0], cs.Config.Server.Address) {
+				w.WriteHeader(400)
+				fmt.Fprint(w, "you mustn't gropple your gropple :-)")
+				return
+			}
+
+			// create the new download
+			newDL := download.NewDownload(url[0], cs.Config)
+			dm.AddDownload(newDL)
+
+			t, err := template.ParseFS(webFS, "web/layout.tmpl", "web/popup.html")
+			if err != nil {
+				panic(err)
+			}
+
+			newDL.Lock.Lock()
+			defer newDL.Lock.Unlock()
+
+			templateData := map[string]interface{}{"Version": vm.GetInfo(), "dl": newDL, "config": cs.Config, "canStop": download.CanStopDownload}
+
+			err = t.ExecuteTemplate(w, "layout", templateData)
+			if err != nil {
+				panic(err)
+			}
+		}
+	}
+}