From f9a5140071703faf0c7515a05f52e69fdc1f11ba Mon Sep 17 00:00:00 2001 From: xengineering Date: Wed, 8 Feb 2023 20:53:20 +0100 Subject: Move all sources to package main This project is not so big that it needs multiple packages. --- Makefile | 4 +- database.go | 175 +++++++++++++++++++++++++++ errors.go | 84 +++++++++++++ handler.go | 307 +++++++++++++++++++++++++++++++++++++++++++++++ main.go | 9 +- router.go | 27 +++++ runtime_config.go | 65 ++++++++++ storage.go | 31 +++++ templates.go | 32 +++++ utils/database.go | 175 --------------------------- utils/errors.go | 84 ------------- utils/runtime_config.go | 65 ---------- utils/storage.go | 31 ----- utils/templates.go | 32 ----- web/handler.go | 309 ------------------------------------------------ web/router.go | 29 ----- 16 files changed, 726 insertions(+), 733 deletions(-) create mode 100644 database.go create mode 100644 errors.go create mode 100644 handler.go create mode 100644 router.go create mode 100644 runtime_config.go create mode 100644 storage.go create mode 100644 templates.go delete mode 100644 utils/database.go delete mode 100644 utils/errors.go delete mode 100644 utils/runtime_config.go delete mode 100644 utils/storage.go delete mode 100644 utils/templates.go delete mode 100644 web/handler.go delete mode 100644 web/router.go diff --git a/Makefile b/Makefile index 45f5d0b..1d1e261 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ PREFIX="/usr" all: mkdir -p build - go build -o build/ceres main.go + go build -o build/ceres *.go clean: rm -rf build @@ -26,4 +26,4 @@ install: all install -Dm 644 sql/0002_migration.sql $(DESTDIR)$(PREFIX)/share/ceres/migrations/0002_migration.sql debug: - go run main.go -c config/debug.json + go run *.go -c config/debug.json diff --git a/database.go b/database.go new file mode 100644 index 0000000..20ec5a6 --- /dev/null +++ b/database.go @@ -0,0 +1,175 @@ + +package main + +import ( + "log" + "fmt" + "path/filepath" + "io" + "os" + "os/signal" + "os/user" + "os/exec" + "strconv" + "syscall" + "database/sql" + + _ "github.com/go-sql-driver/mysql" +) + +const databaseSchemaVersion int = 2 // this defines the needed version for the + // executable + +type Database struct { + config DatabaseConfig + target string + Backend *sql.DB +} + +func InitDatabase(config DatabaseConfig) Database { + + db := NewDatabase(config) + db.Connect() + db.Ping() + db.Migrate(config.Migrations) + + // allow graceful shutdown + var listener = make(chan os.Signal) + signal.Notify(listener, syscall.SIGTERM) + signal.Notify(listener, syscall.SIGINT) + go func() { + signal := <-listener + log.Printf("\nGot signal '%+v'. Shutting down ...\n", signal) + db.Cleanup() + os.Exit(0) // TODO this does not belong to a database - write utils file 'shutdown.go' + }() + + return db +} + +func NewDatabase(config DatabaseConfig) Database { + + db := Database{} + + db.config = config + var username string + user_ptr,err := user.Current() + if err != nil { + log.Fatal(err) + } + username = user_ptr.Username + db.target = fmt.Sprintf("%s@unix(%s)/%s", username, config.Socket, config.Database) + + return db +} + +func (db *Database) Connect() { + var err error + db.Backend,err = sql.Open("mysql", db.target) + if err != nil { + log.Fatal(err) + } + log.Printf("Connected to database '%s'\n", db.target) +} + +func (db *Database) Ping() { + err := db.Backend.Ping() + if err != nil { + log.Fatal(err) + } else { + log.Println("Database is responding") + } +} + +func (db *Database) Migrate(dir string) { + + const t = databaseSchemaVersion // targeted database schema version + + for { + v := db.SchemaVersion() // read schema version from DB table + + // handle current database schema which is newer than targeted one + if v > t { + log.Fatalf( + "Current database schema version is %d but newest is %d!", v, t) + } + + // break if targeted version is already reached + if v == t { + break + } + + // execute migration + log.Printf("Starting database schema migration to version %d.\n", v+1) + path := filepath.Join(dir, fmt.Sprintf("%04d_migration.sql", v+1)) + RunSql(path) + log.Printf("Finished database schema migration to version %d.\n", v+1) + } +} + +func RunSql(path string) { + + script, err := os.Open(path) + if err != nil { + log.Fatalf("Could not open SQL script '%s'!\n", path) + } + + cmd := exec.Command("mariadb") + stdin, err := cmd.StdinPipe() + if err != nil { + log.Fatalf("Could not open stdin of mariadb process!\n%v", err) + } + + err = cmd.Start() + if err != nil { + log.Fatalf("Could not start mariadb process!\n%v", err) + } + io.Copy(stdin, script) + stdin.Close() + + err = cmd.Wait() + if err != nil { + log.Fatalf("Failed to wait for SQL script to finish!\n%v", err) + } +} + +func (db *Database) SchemaVersion() int { + + // ask database for schema version + cmd := "SELECT value FROM meta WHERE (identifier='version');" + rows, err := db.Backend.Query(cmd) + + // handle missing meta table + if err != nil { + log.Fatal(err) + } + + // handle successful schema version query + defer rows.Close() + rows.Next() + var version string + err = rows.Scan(&version) + + // handle missing version field in meta table + if err != nil { + log.Fatal(err) + } + + // convert to integer and handle error + v, err := strconv.Atoi(version) + if err != nil { + log.Fatalf("Could not convert database schema version '%s' to int.\n", + version) + } + + return v +} + +func (db *Database) Cleanup() { + err := db.Backend.Close() + if err != nil { + log.Println("Could not close database connection") + } else { + log.Println("Closed database connection") + } +} diff --git a/errors.go b/errors.go new file mode 100644 index 0000000..193cc11 --- /dev/null +++ b/errors.go @@ -0,0 +1,84 @@ + +package main + +import ( + "fmt" + "log" + "net/http" +) + +func Err(w http.ResponseWriter, code int, a ...interface{}) { + + var msg string // format string for error message + var hc int // HTTP error code + + var prefix string = fmt.Sprintf("Error %d - ", code) + + // ATTENTION: the used error codes in this switch statements should be + // stable. Do not change them, just append to the list! + switch code { + + case 1: + msg = "Failed to load recipes from database." + hc = http.StatusInternalServerError + + case 2: + msg = "Could not parse recipe from database request." + hc = http.StatusInternalServerError + + case 3: + msg = "Exactly 1 'id' URL parameter expected but %d provided." + hc = http.StatusBadRequest + + case 4: + msg = "'id' URL parameter '%s' doas not match the regex '%s'." + hc = http.StatusBadRequest + + case 5: + msg = "Received error from database: '%s'." + hc = http.StatusInternalServerError + + case 6: + msg = "Expected exactly 1 recipe from database but got %d." + hc = http.StatusInternalServerError + + // deprecated + case 7: + msg = "Exactly 1 'type' URL parameter expected but %d provided." + hc = http.StatusBadRequest + + case 8: + msg = "Form data does not contain recipe URL (key is '%s')." + hc = http.StatusBadRequest + + case 9: + msg = "Could not add recipe: '%s'." + hc = http.StatusInternalServerError + + case 10: + msg = "Expected exactly 1 recipe URL in '%s' but got %d (regex is '%s')." + hc = http.StatusBadRequest + + case 11: + msg = "Could not get recipe ID from database: '%s'." + hc = http.StatusInternalServerError + + // deprecated + case 12: + msg = "Given recipe type '%s' is unknown." + hc = http.StatusBadRequest + + default: + msg = "An unknown error occured." + hc = http.StatusInternalServerError + + } + + // format full error message + final := fmt.Sprintf(prefix + msg, a...) + + // send message to log and user + log.Println(final) + http.Error(w, final, hc) + +} diff --git a/handler.go b/handler.go new file mode 100644 index 0000000..f7e14d3 --- /dev/null +++ b/handler.go @@ -0,0 +1,307 @@ + +package main + +import ( + "bytes" + "fmt" + "regexp" + "log" + "io/ioutil" + "net/http" + "path/filepath" + + "github.com/yuin/goldmark" +) + +const ( + VALID_ID_REGEX = `^[0-9]+$` +) + +func static(filename string, staticRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + path := filepath.Join(staticRoot, filename) + log.Printf("Trying to serve: %s\n", path) + http.ServeFile(w, r, path) + } +} + +func index(db *Database, templateRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + + // get data from database + cmd := "SELECT id,title FROM recipes ORDER BY title;" + log.Printf("Query: %s", cmd) + rows, err := db.Backend.Query(cmd) + if err != nil { + Err(w, 1) + return + } + defer rows.Close() + + // prepare data store + type Element struct { + Id string + Title string + } + elements := make([]Element, 0) + + // scan database rows to data store + for rows.Next() { + var element Element + err := rows.Scan(&element.Id, &element.Title) + if err != nil { + Err(w, 2) + return + } else { + elements = append(elements, element) + } + } + + // render and return template + path := filepath.Join(templateRoot, "index.html") + ServeTemplate(w, "index", path, elements) + } +} + +func recipe(db *Database, templateRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + + // get id from URL parameters + ids := r.URL.Query()["id"] + if len(ids) != 1 { + Err(w, 3, len(ids)) + return + } + idStr := ids[0] + + // validate id + idRegex := regexp.MustCompile(VALID_ID_REGEX) + if !(idRegex.MatchString(idStr)) { + Err(w, 4, idStr, VALID_ID_REGEX) + return + } + + if r.Method == "GET" { + + // get data from database + cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr) + log.Printf("Query: %s", cmd) + rows, err := db.Backend.Query(cmd) + if err != nil { + Err(w, 5, err) + return + } + defer rows.Close() + + // prepare data store + type Element struct { + Id string + Title string + UpstreamUrl string + DescriptionMarkdown string + RenderedDescriptionMarkdown string + } + elements := make([]Element, 0) + + // scan database rows to data store + for rows.Next() { + var element Element + element.Id = idStr + err := rows.Scan(&element.Title, &element.UpstreamUrl, &element.DescriptionMarkdown) + if err != nil { + Err(w, 2) + return + } else { + elements = append(elements, element) + } + } + + // check result + if len(elements) != 1 { + Err(w, 6, len(elements)) + return + } + + // render markdown + var buf bytes.Buffer + goldmark.Convert([]byte(elements[0].DescriptionMarkdown), &buf) + elements[0].RenderedDescriptionMarkdown = buf.String() + + // render and return template + path := filepath.Join(templateRoot, "recipe.html") + ServeTemplate(w, "recipe", path, elements[0]) + } + + if r.Method == "POST" { + + // read request body + buffer,_ := ioutil.ReadAll(r.Body) // FIXME error handling + body := string(buffer) + updateRecipe(db, body, idStr) + + } + } +} + +func recipe_edit(db *Database, templateRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + + // get id from URL parameters + ids := r.URL.Query()["id"] + if len(ids) != 1 { + Err(w, 3, len(ids)) + return + } + idStr := ids[0] + + // validate id + idRegex := regexp.MustCompile(VALID_ID_REGEX) + if !(idRegex.MatchString(idStr)) { + Err(w, 4, idStr, VALID_ID_REGEX) + return + } + + if r.Method == "GET" { + + // get data from database + cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr) + log.Printf("Query: %s", cmd) + rows, err := db.Backend.Query(cmd) + if err != nil { + Err(w, 5, err) + return + } + defer rows.Close() + + // prepare data store + type Element struct { + Id string + Title string + UpstreamUrl string + DescriptionMarkdown string + RenderedDescriptionMarkdown string + } + elements := make([]Element, 0) + + // scan database rows to data store + for rows.Next() { + var element Element + element.Id = idStr + err := rows.Scan(&element.Title, &element.UpstreamUrl, &element.DescriptionMarkdown) + if err != nil { + Err(w, 2) + return + } else { + elements = append(elements, element) + } + } + + // check result + if len(elements) != 1 { + Err(w, 6, len(elements)) + return + } + + // render markdown + // var buf bytes.Buffer + // goldmark.Convert([]byte(elements[0].DescriptionMarkdown), &buf) + // elements[0].RenderedDescriptionMarkdown = buf.String() + + // render and return template + path := filepath.Join(templateRoot, "recipe_edit.html") + ServeTemplate(w, "recipe", path, elements[0]) + } + + if r.Method == "POST" { + + // read request body + buffer,_ := ioutil.ReadAll(r.Body) // FIXME error handling + body := string(buffer) + updateRecipe(db, body, idStr) + + } + } +} + +func updateRecipe(db *Database, body string, idStr string) { + + // execute SQL UPDATE + _,_ = db.Backend.Exec(` + UPDATE + recipes + SET + description_markdown=? + WHERE + (id=?); + `, + body, idStr, + ) // FIXME error handling + + return +} + +func image(storageRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + + // get ID + ids := r.URL.Query()["id"] + if len(ids) != 1 { + Err(w, 3, len(ids)) + return + } + idStr := ids[0] + + // validate ID + idRegex := regexp.MustCompile(VALID_ID_REGEX) + if !idRegex.MatchString(idStr) { + Err(w, 4, idStr, VALID_ID_REGEX) + return + } + + // serve image + path := fmt.Sprintf("recipes/image/%s.jpg", idStr) + ServeStorage(w, r, storageRoot, path) + } +} + +func add_recipes(db *Database, storageRoot string, staticRoot string) func(http.ResponseWriter, *http.Request) { + + return func(w http.ResponseWriter, r *http.Request) { + + if r.Method == "GET" { + filename := "add.html" + path := filepath.Join(staticRoot, filename) + log.Printf("Trying to serve: %s", path) + http.ServeFile(w, r, path) + return + } + + if r.Method == "POST" { + url := r.FormValue("url") + title := r.FormValue("title") + + cmd := fmt.Sprintf("INSERT INTO recipes (title,upstream_url) VALUES ('%s', '%s')", title, url) + log.Println(cmd) + res,err := db.Backend.Exec(cmd) + if err != nil { + Err(w, 9, err) + return + } + id,err := res.LastInsertId() + if err != nil { + Err(w, 11, err) + return + } else { + log.Println("Added custom recipe.") + redirect := fmt.Sprintf("/recipe?id=%d", id) + http.Redirect(w, r, redirect, 303) + return + } + } + } +} diff --git a/main.go b/main.go index 4efab32..9df2917 100644 --- a/main.go +++ b/main.go @@ -3,22 +3,19 @@ package main import ( "log" - - "xengineering.eu/ceres/utils" - "xengineering.eu/ceres/web" ) func main() { // read all sources of runtime configuration (e.g. CLI flags and config file) - config := utils.GetRuntimeConfig() + config := GetRuntimeConfig() // print start message log.Printf("Starting ceres with config file '%s'\n", config.Path) // initialize database - db := utils.InitDatabase(config.Database) + db := InitDatabase(config.Database) // start web server - web.RunServer(config.Http, &db) + RunServer(config.Http, &db) } diff --git a/router.go b/router.go new file mode 100644 index 0000000..6985780 --- /dev/null +++ b/router.go @@ -0,0 +1,27 @@ + +package main + +import ( + "log" + "net/http" +) + +func RunServer(config HttpConfig, db *Database) { + + http.HandleFunc("/", index(db, config.Templates)) + + http.HandleFunc("/recipe", recipe(db, config.Templates)) + + http.HandleFunc("/recipe/edit", recipe_edit(db, config.Templates)) + + http.HandleFunc("/recipe/image", image(config.Storage)) + + http.HandleFunc("/add_recipes", add_recipes(db, config.Storage, config.Static)) + + http.HandleFunc("/static/style.css", static("style.css", config.Static)) + http.HandleFunc("/favicon.ico", static("favicon.ico", config.Static)) + + address := config.Host + ":" + config.Port + log.Println("Binding to 'http://" + address) + log.Fatal(http.ListenAndServe(address, nil)) +} diff --git a/runtime_config.go b/runtime_config.go new file mode 100644 index 0000000..9302e11 --- /dev/null +++ b/runtime_config.go @@ -0,0 +1,65 @@ + +package main + +import ( + "fmt" + "log" + "flag" + "os" + "io/ioutil" + "encoding/json" +) + +type RuntimeConfig struct { + Path string + Http HttpConfig `json:"http"` + Database DatabaseConfig `json:"database"` +} + +type HttpConfig struct { + Host string `json:"bind_host"` + Port string `json:"bind_port"` + Static string `json:"static"` + Templates string `json:"templates"` + Storage string `json:"storage"` +} + +type DatabaseConfig struct { + Socket string `json:"socket"` + User string `json:"user"` + Database string `json:"database"` + Migrations string `json:"migrations"` +} + +func GetRuntimeConfig() RuntimeConfig { + + // init empty return value + config := RuntimeConfig{} + + // read command line flags + flag.StringVar(&config.Path, "c", "/etc/ceres/config.json", "Path to ceres configuration file") + flag.Parse() + + // open config file + configFile, err := os.Open(config.Path) + defer configFile.Close() + if err != nil { + log.Fatalf("Could not open configuration file %s", config.Path) + } + + // read byte content + configData, err := ioutil.ReadAll(configFile) + if err != nil { + log.Fatalf("Could not read configuration file %s", config.Path) + } + + fmt.Print("Used config: " + string(configData) + "\n") + + // parse content to config structs + err = json.Unmarshal(configData, &config) + if err != nil { + log.Fatalf("Could not parse configuration file %s", config.Path) + } + + return config +} diff --git a/storage.go b/storage.go new file mode 100644 index 0000000..02bc94d --- /dev/null +++ b/storage.go @@ -0,0 +1,31 @@ + +package main + +import ( + "log" + "net/http" + "io/ioutil" + "path/filepath" +) + +func ServeStorage(w http.ResponseWriter, r *http.Request, storage string, path string) { + + // generate absolute, cleaned path of ressource + path = filepath.Join(storage, path) + path,err := filepath.Abs(path) + if err != nil { + log.Print(err) + http.Error(w, http.StatusText(400), 400) + return + } + + // TODO check if path is still in storage folder + + // serve the file if nothing has been wrong + http.ServeFile(w, r, path) +} + +func SaveStorageFile(data *[]byte, storage string, path string) error { + fullpath := filepath.Join(storage, path) + return ioutil.WriteFile(fullpath, *data, 0644) +} diff --git a/templates.go b/templates.go new file mode 100644 index 0000000..84e449a --- /dev/null +++ b/templates.go @@ -0,0 +1,32 @@ + +package main + +import ( + "log" + "net/http" + "io/ioutil" + "text/template" // FIXME switch to html/template for security reasons + // and make a workaround for rendered Markdown insertion +) + +func ServeTemplate(w http.ResponseWriter, name string, path string, data interface{}) { + + templateFile,err := ioutil.ReadFile(path) + if err != nil { + log.Print(err) + http.Error(w, http.StatusText(404), 404) + return + } + tmpl,err := template.New(name).Parse(string(templateFile)) + if err != nil { + log.Print(err) + http.Error(w, http.StatusText(404), 404) + return + } + err = tmpl.Execute(w, data) + if err != nil { + log.Print(err) + http.Error(w, http.StatusText(404), 404) + return + } +} diff --git a/utils/database.go b/utils/database.go deleted file mode 100644 index f48af35..0000000 --- a/utils/database.go +++ /dev/null @@ -1,175 +0,0 @@ - -package utils - -import ( - "log" - "fmt" - "path/filepath" - "io" - "os" - "os/signal" - "os/user" - "os/exec" - "strconv" - "syscall" - "database/sql" - - _ "github.com/go-sql-driver/mysql" -) - -const databaseSchemaVersion int = 2 // this defines the needed version for the - // executable - -type Database struct { - config DatabaseConfig - target string - Backend *sql.DB -} - -func InitDatabase(config DatabaseConfig) Database { - - db := NewDatabase(config) - db.Connect() - db.Ping() - db.Migrate(config.Migrations) - - // allow graceful shutdown - var listener = make(chan os.Signal) - signal.Notify(listener, syscall.SIGTERM) - signal.Notify(listener, syscall.SIGINT) - go func() { - signal := <-listener - log.Printf("\nGot signal '%+v'. Shutting down ...\n", signal) - db.Cleanup() - os.Exit(0) // TODO this does not belong to a database - write utils file 'shutdown.go' - }() - - return db -} - -func NewDatabase(config DatabaseConfig) Database { - - db := Database{} - - db.config = config - var username string - user_ptr,err := user.Current() - if err != nil { - log.Fatal(err) - } - username = user_ptr.Username - db.target = fmt.Sprintf("%s@unix(%s)/%s", username, config.Socket, config.Database) - - return db -} - -func (db *Database) Connect() { - var err error - db.Backend,err = sql.Open("mysql", db.target) - if err != nil { - log.Fatal(err) - } - log.Printf("Connected to database '%s'\n", db.target) -} - -func (db *Database) Ping() { - err := db.Backend.Ping() - if err != nil { - log.Fatal(err) - } else { - log.Println("Database is responding") - } -} - -func (db *Database) Migrate(dir string) { - - const t = databaseSchemaVersion // targeted database schema version - - for { - v := db.SchemaVersion() // read schema version from DB table - - // handle current database schema which is newer than targeted one - if v > t { - log.Fatalf( - "Current database schema version is %d but newest is %d!", v, t) - } - - // break if targeted version is already reached - if v == t { - break - } - - // execute migration - log.Printf("Starting database schema migration to version %d.\n", v+1) - path := filepath.Join(dir, fmt.Sprintf("%04d_migration.sql", v+1)) - RunSql(path) - log.Printf("Finished database schema migration to version %d.\n", v+1) - } -} - -func RunSql(path string) { - - script, err := os.Open(path) - if err != nil { - log.Fatalf("Could not open SQL script '%s'!\n", path) - } - - cmd := exec.Command("mariadb") - stdin, err := cmd.StdinPipe() - if err != nil { - log.Fatalf("Could not open stdin of mariadb process!\n%v", err) - } - - err = cmd.Start() - if err != nil { - log.Fatalf("Could not start mariadb process!\n%v", err) - } - io.Copy(stdin, script) - stdin.Close() - - err = cmd.Wait() - if err != nil { - log.Fatalf("Failed to wait for SQL script to finish!\n%v", err) - } -} - -func (db *Database) SchemaVersion() int { - - // ask database for schema version - cmd := "SELECT value FROM meta WHERE (identifier='version');" - rows, err := db.Backend.Query(cmd) - - // handle missing meta table - if err != nil { - log.Fatal(err) - } - - // handle successful schema version query - defer rows.Close() - rows.Next() - var version string - err = rows.Scan(&version) - - // handle missing version field in meta table - if err != nil { - log.Fatal(err) - } - - // convert to integer and handle error - v, err := strconv.Atoi(version) - if err != nil { - log.Fatalf("Could not convert database schema version '%s' to int.\n", - version) - } - - return v -} - -func (db *Database) Cleanup() { - err := db.Backend.Close() - if err != nil { - log.Println("Could not close database connection") - } else { - log.Println("Closed database connection") - } -} diff --git a/utils/errors.go b/utils/errors.go deleted file mode 100644 index 757d2a1..0000000 --- a/utils/errors.go +++ /dev/null @@ -1,84 +0,0 @@ - -package utils - -import ( - "fmt" - "log" - "net/http" -) - -func Err(w http.ResponseWriter, code int, a ...interface{}) { - - var msg string // format string for error message - var hc int // HTTP error code - - var prefix string = fmt.Sprintf("Error %d - ", code) - - // ATTENTION: the used error codes in this switch statements should be - // stable. Do not change them, just append to the list! - switch code { - - case 1: - msg = "Failed to load recipes from database." - hc = http.StatusInternalServerError - - case 2: - msg = "Could not parse recipe from database request." - hc = http.StatusInternalServerError - - case 3: - msg = "Exactly 1 'id' URL parameter expected but %d provided." - hc = http.StatusBadRequest - - case 4: - msg = "'id' URL parameter '%s' doas not match the regex '%s'." - hc = http.StatusBadRequest - - case 5: - msg = "Received error from database: '%s'." - hc = http.StatusInternalServerError - - case 6: - msg = "Expected exactly 1 recipe from database but got %d." - hc = http.StatusInternalServerError - - // deprecated - case 7: - msg = "Exactly 1 'type' URL parameter expected but %d provided." - hc = http.StatusBadRequest - - case 8: - msg = "Form data does not contain recipe URL (key is '%s')." - hc = http.StatusBadRequest - - case 9: - msg = "Could not add recipe: '%s'." - hc = http.StatusInternalServerError - - case 10: - msg = "Expected exactly 1 recipe URL in '%s' but got %d (regex is '%s')." - hc = http.StatusBadRequest - - case 11: - msg = "Could not get recipe ID from database: '%s'." - hc = http.StatusInternalServerError - - // deprecated - case 12: - msg = "Given recipe type '%s' is unknown." - hc = http.StatusBadRequest - - default: - msg = "An unknown error occured." - hc = http.StatusInternalServerError - - } - - // format full error message - final := fmt.Sprintf(prefix + msg, a...) - - // send message to log and user - log.Println(final) - http.Error(w, final, hc) - -} diff --git a/utils/runtime_config.go b/utils/runtime_config.go deleted file mode 100644 index fb5bd72..0000000 --- a/utils/runtime_config.go +++ /dev/null @@ -1,65 +0,0 @@ - -package utils - -import ( - "fmt" - "log" - "flag" - "os" - "io/ioutil" - "encoding/json" -) - -type RuntimeConfig struct { - Path string - Http HttpConfig `json:"http"` - Database DatabaseConfig `json:"database"` -} - -type HttpConfig struct { - Host string `json:"bind_host"` - Port string `json:"bind_port"` - Static string `json:"static"` - Templates string `json:"templates"` - Storage string `json:"storage"` -} - -type DatabaseConfig struct { - Socket string `json:"socket"` - User string `json:"user"` - Database string `json:"database"` - Migrations string `json:"migrations"` -} - -func GetRuntimeConfig() RuntimeConfig { - - // init empty return value - config := RuntimeConfig{} - - // read command line flags - flag.StringVar(&config.Path, "c", "/etc/ceres/config.json", "Path to ceres configuration file") - flag.Parse() - - // open config file - configFile, err := os.Open(config.Path) - defer configFile.Close() - if err != nil { - log.Fatalf("Could not open configuration file %s", config.Path) - } - - // read byte content - configData, err := ioutil.ReadAll(configFile) - if err != nil { - log.Fatalf("Could not read configuration file %s", config.Path) - } - - fmt.Print("Used config: " + string(configData) + "\n") - - // parse content to config structs - err = json.Unmarshal(configData, &config) - if err != nil { - log.Fatalf("Could not parse configuration file %s", config.Path) - } - - return config -} diff --git a/utils/storage.go b/utils/storage.go deleted file mode 100644 index ee5b7bf..0000000 --- a/utils/storage.go +++ /dev/null @@ -1,31 +0,0 @@ - -package utils - -import ( - "log" - "net/http" - "io/ioutil" - "path/filepath" -) - -func ServeStorage(w http.ResponseWriter, r *http.Request, storage string, path string) { - - // generate absolute, cleaned path of ressource - path = filepath.Join(storage, path) - path,err := filepath.Abs(path) - if err != nil { - log.Print(err) - http.Error(w, http.StatusText(400), 400) - return - } - - // TODO check if path is still in storage folder - - // serve the file if nothing has been wrong - http.ServeFile(w, r, path) -} - -func SaveStorageFile(data *[]byte, storage string, path string) error { - fullpath := filepath.Join(storage, path) - return ioutil.WriteFile(fullpath, *data, 0644) -} diff --git a/utils/templates.go b/utils/templates.go deleted file mode 100644 index 00a8eb2..0000000 --- a/utils/templates.go +++ /dev/null @@ -1,32 +0,0 @@ - -package utils - -import ( - "log" - "net/http" - "io/ioutil" - "text/template" // FIXME switch to html/template for security reasons - // and make a workaround for rendered Markdown insertion -) - -func ServeTemplate(w http.ResponseWriter, name string, path string, data interface{}) { - - templateFile,err := ioutil.ReadFile(path) - if err != nil { - log.Print(err) - http.Error(w, http.StatusText(404), 404) - return - } - tmpl,err := template.New(name).Parse(string(templateFile)) - if err != nil { - log.Print(err) - http.Error(w, http.StatusText(404), 404) - return - } - err = tmpl.Execute(w, data) - if err != nil { - log.Print(err) - http.Error(w, http.StatusText(404), 404) - return - } -} diff --git a/web/handler.go b/web/handler.go deleted file mode 100644 index 07d04fa..0000000 --- a/web/handler.go +++ /dev/null @@ -1,309 +0,0 @@ - -package web - -import ( - "bytes" - "fmt" - "regexp" - "log" - "io/ioutil" - "net/http" - "path/filepath" - - "xengineering.eu/ceres/utils" - - "github.com/yuin/goldmark" -) - -const ( - VALID_ID_REGEX = `^[0-9]+$` -) - -func static(filename string, staticRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - path := filepath.Join(staticRoot, filename) - log.Printf("Trying to serve: %s\n", path) - http.ServeFile(w, r, path) - } -} - -func index(db *utils.Database, templateRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - - // get data from database - cmd := "SELECT id,title FROM recipes ORDER BY title;" - log.Printf("Query: %s", cmd) - rows, err := db.Backend.Query(cmd) - if err != nil { - utils.Err(w, 1) - return - } - defer rows.Close() - - // prepare data store - type Element struct { - Id string - Title string - } - elements := make([]Element, 0) - - // scan database rows to data store - for rows.Next() { - var element Element - err := rows.Scan(&element.Id, &element.Title) - if err != nil { - utils.Err(w, 2) - return - } else { - elements = append(elements, element) - } - } - - // render and return template - path := filepath.Join(templateRoot, "index.html") - utils.ServeTemplate(w, "index", path, elements) - } -} - -func recipe(db *utils.Database, templateRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - - // get id from URL parameters - ids := r.URL.Query()["id"] - if len(ids) != 1 { - utils.Err(w, 3, len(ids)) - return - } - idStr := ids[0] - - // validate id - idRegex := regexp.MustCompile(VALID_ID_REGEX) - if !(idRegex.MatchString(idStr)) { - utils.Err(w, 4, idStr, VALID_ID_REGEX) - return - } - - if r.Method == "GET" { - - // get data from database - cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr) - log.Printf("Query: %s", cmd) - rows, err := db.Backend.Query(cmd) - if err != nil { - utils.Err(w, 5, err) - return - } - defer rows.Close() - - // prepare data store - type Element struct { - Id string - Title string - UpstreamUrl string - DescriptionMarkdown string - RenderedDescriptionMarkdown string - } - elements := make([]Element, 0) - - // scan database rows to data store - for rows.Next() { - var element Element - element.Id = idStr - err := rows.Scan(&element.Title, &element.UpstreamUrl, &element.DescriptionMarkdown) - if err != nil { - utils.Err(w, 2) - return - } else { - elements = append(elements, element) - } - } - - // check result - if len(elements) != 1 { - utils.Err(w, 6, len(elements)) - return - } - - // render markdown - var buf bytes.Buffer - goldmark.Convert([]byte(elements[0].DescriptionMarkdown), &buf) - elements[0].RenderedDescriptionMarkdown = buf.String() - - // render and return template - path := filepath.Join(templateRoot, "recipe.html") - utils.ServeTemplate(w, "recipe", path, elements[0]) - } - - if r.Method == "POST" { - - // read request body - buffer,_ := ioutil.ReadAll(r.Body) // FIXME error handling - body := string(buffer) - updateRecipe(db, body, idStr) - - } - } -} - -func recipe_edit(db *utils.Database, templateRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - - // get id from URL parameters - ids := r.URL.Query()["id"] - if len(ids) != 1 { - utils.Err(w, 3, len(ids)) - return - } - idStr := ids[0] - - // validate id - idRegex := regexp.MustCompile(VALID_ID_REGEX) - if !(idRegex.MatchString(idStr)) { - utils.Err(w, 4, idStr, VALID_ID_REGEX) - return - } - - if r.Method == "GET" { - - // get data from database - cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr) - log.Printf("Query: %s", cmd) - rows, err := db.Backend.Query(cmd) - if err != nil { - utils.Err(w, 5, err) - return - } - defer rows.Close() - - // prepare data store - type Element struct { - Id string - Title string - UpstreamUrl string - DescriptionMarkdown string - RenderedDescriptionMarkdown string - } - elements := make([]Element, 0) - - // scan database rows to data store - for rows.Next() { - var element Element - element.Id = idStr - err := rows.Scan(&element.Title, &element.UpstreamUrl, &element.DescriptionMarkdown) - if err != nil { - utils.Err(w, 2) - return - } else { - elements = append(elements, element) - } - } - - // check result - if len(elements) != 1 { - utils.Err(w, 6, len(elements)) - return - } - - // render markdown - // var buf bytes.Buffer - // goldmark.Convert([]byte(elements[0].DescriptionMarkdown), &buf) - // elements[0].RenderedDescriptionMarkdown = buf.String() - - // render and return template - path := filepath.Join(templateRoot, "recipe_edit.html") - utils.ServeTemplate(w, "recipe", path, elements[0]) - } - - if r.Method == "POST" { - - // read request body - buffer,_ := ioutil.ReadAll(r.Body) // FIXME error handling - body := string(buffer) - updateRecipe(db, body, idStr) - - } - } -} - -func updateRecipe(db *utils.Database, body string, idStr string) { - - // execute SQL UPDATE - _,_ = db.Backend.Exec(` - UPDATE - recipes - SET - description_markdown=? - WHERE - (id=?); - `, - body, idStr, - ) // FIXME error handling - - return -} - -func image(storageRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - - // get ID - ids := r.URL.Query()["id"] - if len(ids) != 1 { - utils.Err(w, 3, len(ids)) - return - } - idStr := ids[0] - - // validate ID - idRegex := regexp.MustCompile(VALID_ID_REGEX) - if !idRegex.MatchString(idStr) { - utils.Err(w, 4, idStr, VALID_ID_REGEX) - return - } - - // serve image - path := fmt.Sprintf("recipes/image/%s.jpg", idStr) - utils.ServeStorage(w, r, storageRoot, path) - } -} - -func add_recipes(db *utils.Database, storageRoot string, staticRoot string) func(http.ResponseWriter, *http.Request) { - - return func(w http.ResponseWriter, r *http.Request) { - - if r.Method == "GET" { - filename := "add.html" - path := filepath.Join(staticRoot, filename) - log.Printf("Trying to serve: %s", path) - http.ServeFile(w, r, path) - return - } - - if r.Method == "POST" { - url := r.FormValue("url") - title := r.FormValue("title") - - cmd := fmt.Sprintf("INSERT INTO recipes (title,upstream_url) VALUES ('%s', '%s')", title, url) - log.Println(cmd) - res,err := db.Backend.Exec(cmd) - if err != nil { - utils.Err(w, 9, err) - return - } - id,err := res.LastInsertId() - if err != nil { - utils.Err(w, 11, err) - return - } else { - log.Println("Added custom recipe.") - redirect := fmt.Sprintf("/recipe?id=%d", id) - http.Redirect(w, r, redirect, 303) - return - } - } - } -} diff --git a/web/router.go b/web/router.go deleted file mode 100644 index ec67399..0000000 --- a/web/router.go +++ /dev/null @@ -1,29 +0,0 @@ - -package web - -import ( - "log" - "net/http" - - "xengineering.eu/ceres/utils" -) - -func RunServer(config utils.HttpConfig, db *utils.Database) { - - http.HandleFunc("/", index(db, config.Templates)) - - http.HandleFunc("/recipe", recipe(db, config.Templates)) - - http.HandleFunc("/recipe/edit", recipe_edit(db, config.Templates)) - - http.HandleFunc("/recipe/image", image(config.Storage)) - - http.HandleFunc("/add_recipes", add_recipes(db, config.Storage, config.Static)) - - http.HandleFunc("/static/style.css", static("style.css", config.Static)) - http.HandleFunc("/favicon.ico", static("favicon.ico", config.Static)) - - address := config.Host + ":" + config.Port - log.Println("Binding to 'http://" + address) - log.Fatal(http.ListenAndServe(address, nil)) -} -- cgit v1.2.3-70-g09d2