diff --git a/config/config.go b/config/config.go index 1eba4b1..1a98a5c 100644 --- a/config/config.go +++ b/config/config.go @@ -51,12 +51,14 @@ type Config struct { func ReadConfigFile(filename string, conf *Config) error { configData, err := ioutil.ReadFile(filename) if err != nil { - log.Printf("Error reading config file: %s", err.Error()) + err = fmt.Errorf("Error reading config file: %w", err) + log.Println(err.Error()) return err } err = json.Unmarshal(configData, conf) if err != nil { - log.Printf("Error parsing config file as json: %s", err.Error()) + err = fmt.Errorf("Error parsing config file as json: %w", err) + log.Println(err.Error()) return err } return validateConfig(conf) diff --git a/controllers/addOfficeHourHandler.go b/controllers/addOfficeHourHandler.go index 1bdaf5d..a99a40a 100644 --- a/controllers/addOfficeHourHandler.go +++ b/controllers/addOfficeHourHandler.go @@ -2,10 +2,12 @@ package controllers import ( "fmt" + "log" "net/http" "net/mail" "officeHours/config" "officeHours/models" + "officeHours/templating" "strconv" "strings" ) @@ -148,12 +150,19 @@ func (b *BaseHandler) AddOfficeHourHandler(w http.ResponseWriter, req *http.Requ id, err := b.officeHourRepo.Add(officeHour) if err != nil { w.WriteHeader(http.StatusInternalServerError) - b.serveTemplate(w, "addFailure", err) + templating.ServeTemplate(w, "addFailure", err) return } - officeHour, _ = b.officeHourRepo.FindById(id) - b.requestRepo.Add(officeHour, models.RequestActivate) - b.serveTemplate(w, "addSuccess", nil) + officeHour, err = b.officeHourRepo.FindById(id) + if err != nil { + log.Printf("Error finding new office hour by id %d: %s", id, err.Error()) + } + _, err = b.requestRepo.Add(officeHour, models.RequestActivate) + if err != nil { + log.Printf("Error adding request: %s", err.Error()) + } + templating.ServeTemplate(w, "addSuccess", nil) + } } @@ -164,5 +173,5 @@ func (b *BaseHandler) writeAddOfficeHourMask(w http.ResponseWriter, req *http.Re if len(data.Errors) != 0 { w.WriteHeader(http.StatusBadRequest) } - b.serveTemplate(w, "addMask", data) + templating.ServeTemplate(w, "addMask", data) } diff --git a/controllers/confirmRequestHandler.go b/controllers/confirmRequestHandler.go index 7f2060f..98a485d 100644 --- a/controllers/confirmRequestHandler.go +++ b/controllers/confirmRequestHandler.go @@ -2,6 +2,7 @@ package controllers import ( "net/http" + "officeHours/templating" ) func (b *BaseHandler) ConfirmRequestHandler(w http.ResponseWriter, req *http.Request) { @@ -9,15 +10,17 @@ func (b *BaseHandler) ConfirmRequestHandler(w http.ResponseWriter, req *http.Req request, err := b.requestRepo.FindBySecret(secret) if err != nil { - b.serveTemplate(w, "requestNotFound", nil) + // TODO: header 404 + templating.ServeTemplate(w, "requestNotFound", nil) return } err = b.requestRepo.Execute(request) if err != nil { - b.serveTemplate(w, "executeFailure", err.Error()) + // TODO: write header 500 + templating.ServeTemplate(w, "executeFailure", err.Error()) return } - b.serveTemplate(w, "executeSuccess", nil) + templating.ServeTemplate(w, "executeSuccess", nil) } diff --git a/controllers/deleteOfficeHourHandler.go b/controllers/deleteOfficeHourHandler.go index 233dc34..f694872 100644 --- a/controllers/deleteOfficeHourHandler.go +++ b/controllers/deleteOfficeHourHandler.go @@ -4,10 +4,13 @@ package controllers import ( "net/http" "officeHours/models" + "officeHours/templating" "strconv" ) func (b *BaseHandler) DeleteOfficeHourHandler(w http.ResponseWriter, req *http.Request) { + // TODO: error handling here is by no means sufficient, furthermore + // 400 BadRequest is for technically wrong stuff (most promimently GET instead of POST) if req.FormValue("id") != "" { id, err := strconv.Atoi(req.FormValue("id")) if err != nil { @@ -18,7 +21,7 @@ func (b *BaseHandler) DeleteOfficeHourHandler(w http.ResponseWriter, req *http.R w.WriteHeader(http.StatusBadRequest) } _, err = b.requestRepo.Add(officeHour, models.RequestDelete) - b.serveTemplate(w, "deleteSuccess", nil) + templating.ServeTemplate(w, "deleteSuccess", nil) } else { officeHours, _ := b.officeHourRepo.GetAll(true) timetable, slots := b.GetTimetable(officeHours) diff --git a/controllers/getHandlers.go b/controllers/getHandlers.go index 50d055e..5bdc516 100644 --- a/controllers/getHandlers.go +++ b/controllers/getHandlers.go @@ -2,8 +2,10 @@ package controllers import ( "html/template" + "log" "net/http" "officeHours/models" + "officeHours/templating" "strconv" ) @@ -18,7 +20,10 @@ func (b *BaseHandler) GetByRoomHandler(w http.ResponseWriter, req *http.Request) b.RootHandler(w, req) return } - officeHours, _ := b.officeHourRepo.FindByRoom(room, true) + officeHours, err := b.officeHourRepo.FindByRoom(room, true) + if err != nil { + log.Printf("Error getting office hours for room %s: %s", room.Name, err.Error()) + } timetable, slots := b.GetTimetable(officeHours) b.writeTimetablePage(w, req, b.printTimetable(timetable, slots, false)) } @@ -34,7 +39,10 @@ func (b *BaseHandler) GetByCourseHandler(w http.ResponseWriter, req *http.Reques b.RootHandler(w, req) return } - officeHours, _ := b.officeHourRepo.FindByCourse(course, true) + officeHours, err := b.officeHourRepo.FindByCourse(course, true) + if err != nil { + log.Printf("Error getting office hours for course %s: %s", course.Name, err.Error()) + } timetable, slots := b.GetTimetable(officeHours) b.writeTimetablePage(w, req, b.printTimetable(timetable, slots, false)) } @@ -51,5 +59,5 @@ func (b *BaseHandler) writeTimetablePage(w http.ResponseWriter, req *http.Reques SelectedRoom int SelectedCourse int }{courses, rooms, timetable, selectedRoom, selectedCourse} - b.serveTemplate(w, "index", data) + templating.ServeTemplate(w, "index", data) } diff --git a/controllers/templates.go b/controllers/templates.go deleted file mode 100644 index 7dd1a78..0000000 --- a/controllers/templates.go +++ /dev/null @@ -1,60 +0,0 @@ -package controllers - -import ( - "fmt" - "html/template" - "log" - "net/http" - "officeHours/models" - "os" -) - -var funcs = template.FuncMap{ - "DayName": models.DayName, - "divide": func(i int, j int) int { return i / j }, -} -var baseTemplate = template.Must(template.ParseFiles("templates/base.html")).New("base.html").Funcs(funcs) - -// Execute a rendered full HTML page. -// -// If you just want to fill a template snippet, use the RawTemplates object. -// -// Parameters: -// - name is the name of the template file inside templates/, without .html suffix. -// - data is passed through to the template -func (b *BaseHandler) serveTemplate(w http.ResponseWriter, name string, data any) { - full_name := "templates/" + name + ".html" - // check that template exists - info, err := os.Stat(full_name) - if (err != nil && os.IsNotExist(err)) || info.IsDir() { - errMsg := fmt.Sprintf("Template %s nicht gefunden", full_name) - log.Println(errMsg) - w.WriteHeader(http.StatusNotFound) - w.Write([]byte(errMsg)) - return - } - - tmpl, err := baseTemplate.ParseFiles(full_name) - if err != nil { - errMsg := fmt.Sprintf("Template %s konnte nicht geparst werden : %s", full_name, err.Error()) - log.Println(errMsg) - w.WriteHeader(http.StatusInternalServerError) - w.Write([]byte(errMsg)) - return - } - // TODO: cache templates in parsed state, but not executed - err = template.Must(tmpl.Clone()).Execute(w, data) - if err != nil { - errMsg := fmt.Sprintf("Template %s konnte nicht ausgeführt werden : %s", full_name, err.Error()) - log.Println(errMsg) - w.WriteHeader(http.StatusInternalServerError) - w.Write([]byte(errMsg)) - return - } -} - -// standalone templates that should not be wrapped into the base.html -var RawTemplates = template.Must(template.New("").Funcs(funcs).ParseFiles( - "templates/confirmationMail", - "templates/td.html", - "templates/officeHourTable.html")) diff --git a/controllers/timetable.go b/controllers/timetable.go index 7162026..b1d5eb1 100644 --- a/controllers/timetable.go +++ b/controllers/timetable.go @@ -5,7 +5,9 @@ import ( "bytes" "fmt" "html/template" + "log" "officeHours/models" + "officeHours/templating" ) func (b *BaseHandler) GetTimetable(officeHours []models.OfficeHour) (timetable map[models.Date]map[int]models.OfficeHour, slots []int) { @@ -84,7 +86,12 @@ func (b *BaseHandler) printTimetable(timetable map[models.Date]map[int]models.Of MinuteGranularity int DeleteIcons bool }{OfficeHour: current, MinuteGranularity: b.config.Date.MinuteGranularity, DeleteIcons: deleteIcons} - RawTemplates.ExecuteTemplate(&celldata, "td.html", data) + err := templating.WriteTemplate(&celldata, "td", data) + if err != nil { + err = fmt.Errorf("writing table cell failed:\n%w", err) + log.Println(err.Error()) + // TODO: better error wrapping up to top-level request handler + } tableBody += celldata.String() } } else { @@ -116,6 +123,11 @@ func (b *BaseHandler) printTimetable(timetable map[models.Date]map[int]models.Of slots[4], template.HTML(tableBody), } - RawTemplates.ExecuteTemplate(&table, "officeHourTable.html", tableData) + err := templating.WriteTemplate(&table, "officeHourTable", tableData) + if err != nil { + err = fmt.Errorf("writing table failed:\n%w", err) + log.Println(err.Error()) + // TODO: better error wrapping up to top-level request handler + } return template.HTML(table.String()) } diff --git a/main.go b/main.go index 67e773e..00423f5 100644 --- a/main.go +++ b/main.go @@ -11,6 +11,7 @@ import ( "officeHours/controllers" "officeHours/repositories" "officeHours/sqldb" + "officeHours/templating" "os" ) @@ -19,6 +20,7 @@ func main() { if e == nil { log.SetOutput(logwriter) } + configFile := flag.String( "config", "config/config.json", @@ -37,8 +39,17 @@ func main() { // serve static files staticHandler := http.FileServer(http.Dir("./static")) - - db := sqldb.Connect(conf) + // parse templates + if err = templating.InitTemplates(); err != nil { + log.Print(err.Error()) + log.Fatal(">>>\nFatal error occurred, aborting program\n<<<\n") + } + // database connection + db, err := sqldb.Connect(conf) + if err != nil { + log.Print(err.Error()) + log.Fatal(">>>\nFatal error occurred, aborting program\n<<<\n") + } // Create repos roomRepo := repositories.NewRoomRepo(db) courseRepo := repositories.NewCourseRepo(db) diff --git a/repositories/course.go b/repositories/course.go index 68dd801..e721130 100644 --- a/repositories/course.go +++ b/repositories/course.go @@ -3,6 +3,9 @@ package repositories import ( "database/sql" + "errors" + "fmt" + "log" "officeHours/models" ) @@ -17,26 +20,17 @@ func NewCourseRepo(db *sql.DB) *CourseRepo { } func (r *CourseRepo) FindByName(name string) (models.Course, error) { - row := r.db.QueryRow("SELECT * FROM course WHERE name=?", name) - var course models.Course - if err := row.Scan(&course.Id, &course.Name); err != nil { - return models.Course{}, err - } - return course, nil + return r.getFromRow(r.db.QueryRow("SELECT * FROM course WHERE name=?", name)) } func (r *CourseRepo) FindById(id int) (models.Course, error) { - row := r.db.QueryRow("SELECT * FROM course WHERE id=?", id) - var course models.Course - if err := row.Scan(&course.Id, &course.Name); err != nil { - return models.Course{}, err - } - return course, nil + return r.getFromRow(r.db.QueryRow("SELECT * FROM course WHERE id=?", id)) } func (r *CourseRepo) GetAll() ([]models.Course, error) { rows, err := r.db.Query("SELECT * FROM course") if err != nil { + log.Printf("Error getting all courses: %s", err.Error()) return nil, err } defer rows.Close() @@ -49,9 +43,22 @@ func (r *CourseRepo) getFromRows(rows *sql.Rows) ([]models.Course, error) { for rows.Next() { var course models.Course if err := rows.Scan(&course.Id, &course.Name); err != nil { + log.Printf("Error scanning course row: %s", err.Error()) return courses, err } courses = append(courses, course) } return courses, nil } + +func (r *CourseRepo) getFromRow(row *sql.Row) (models.Course, error) { + var course models.Course + if err := row.Scan(&course.Id, &course.Name); err != nil { + err = fmt.Errorf("Error getting course row: %w", err) + if !errors.Is(err, sql.ErrNoRows) { + log.Printf(err.Error()) + } + return models.Course{}, err + } + return course, nil +} diff --git a/repositories/officeHour.go b/repositories/officeHour.go index dae2213..e92093f 100644 --- a/repositories/officeHour.go +++ b/repositories/officeHour.go @@ -3,7 +3,9 @@ package repositories import ( "database/sql" + "errors" "fmt" + "log" "officeHours/config" "officeHours/models" ) @@ -35,7 +37,11 @@ func (r *OfficeHourRepo) GetAll(activeOnly bool) ([]models.OfficeHour, error) { rows, err = r.db.Query("SELECT * FROM officeHour") } if err != nil { - return nil, fmt.Errorf("Error getting all officeHours from database: %s", err.Error()) + err = fmt.Errorf("Error getting all officeHours from database: %w", err) + if !errors.Is(err, sql.ErrNoRows) { + log.Println(err.Error()) + } + return nil, err } defer rows.Close() return r.getFromRows(rows) @@ -49,10 +55,14 @@ func (r *OfficeHourRepo) FindByCourse(course models.Course, activeOnly bool) ([] } else { rows, err = r.db.Query("SELECT * FROM officeHour WHERE course=?", course.Id) } - if err != nil { - return nil, fmt.Errorf("Error getting officeHours by course from database: %s", err.Error()) - } defer rows.Close() + if err != nil { + err = fmt.Errorf("Error getting officeHours by course from database: %w", err) + if !errors.Is(err, sql.ErrNoRows) { + log.Println(err.Error()) + } + return nil, err + } return r.getFromRows(rows) } @@ -65,7 +75,11 @@ func (r *OfficeHourRepo) FindByRoom(room models.Room, activeOnly bool) ([]models rows, err = r.db.Query("SELECT * FROM officeHour WHERE room=?", room.Id) } if err != nil { - return nil, fmt.Errorf("Error getting officeHours by room from database: %s", err.Error()) + err = fmt.Errorf("Error getting officeHours by room from database: %w", err) + if !errors.Is(err, sql.ErrNoRows) { + log.Println(err.Error()) + } + return nil, err } defer rows.Close() return r.getFromRows(rows) @@ -75,11 +89,16 @@ func (r *OfficeHourRepo) FindById(id int) (models.OfficeHour, error) { return r.getFromRow(r.db.QueryRow("SELECT * FROM officeHour WHERE id=?", id)) } -func (r *OfficeHourRepo) Add(officeHour models.OfficeHour) (id int, err error) { +func (r *OfficeHourRepo) Add(officeHour models.OfficeHour) (int, error) { // Find correct tutor or add if not existent - r.tutorRepo.Add(officeHour.Tutor) + _, err := r.tutorRepo.Add(officeHour.Tutor) + if err != nil { + return 0, err + } officeHour.Tutor, err = r.tutorRepo.FindByNameAndEmail(officeHour.Tutor.Name, officeHour.Tutor.Email) if err != nil { + err = fmt.Errorf("Newly added tutor not found: %w", err) + log.Println(err.Error()) return 0, err } @@ -111,14 +130,19 @@ func (r *OfficeHourRepo) Add(officeHour models.OfficeHour) (id int, err error) { officeHour.Info, officeHour.Active, officeHour.Duration) - id64, _ := sqlResult.LastInsertId() - return int(id64), err + id, lastInsertIdErr := sqlResult.LastInsertId() + if lastInsertIdErr != nil { + log.Printf("Error getting Id for new tutor: %s", lastInsertIdErr.Error()) + } + return int(id), err } func (r *OfficeHourRepo) Delete(officeHour models.OfficeHour) error { _, err := r.db.Exec("DELETE FROM officeHour WHERE id=?", officeHour.Id) if err != nil { - return fmt.Errorf("Error deleting officeHour from database: %s", err.Error()) + err = fmt.Errorf("Error deleting officeHour from database: %w", err) + log.Println(err.Error()) + return err } return nil } @@ -128,12 +152,29 @@ func (r *OfficeHourRepo) getFromRow(row *sql.Row) (models.OfficeHour, error) { var week, day, hour, minute, tutorId, courseId, roomId int err := row.Scan(&officeHour.Id, &tutorId, &day, &hour, &minute, &roomId, &courseId, &week, &officeHour.Info, &officeHour.Active, &officeHour.Duration) if err != nil { - return models.OfficeHour{}, fmt.Errorf("Error getting single officeHours row from database: %s", err.Error()) + err = fmt.Errorf("Error getting single officeHour row from database: %w", err) + log.Println(err.Error()) + return models.OfficeHour{}, err } officeHour.Date = models.Date{Week: week, Day: day, Hour: hour, Minute: minute} - officeHour.Room, _ = r.roomRepo.FindById(roomId) - officeHour.Tutor, _ = r.tutorRepo.FindById(tutorId) - officeHour.Course, _ = r.courseRepo.FindById(courseId) + officeHour.Room, err = r.roomRepo.FindById(roomId) + if err != nil { + err = fmt.Errorf("Error finding room by id %d for office hour: %w", roomId, err) + log.Println(err.Error()) + return officeHour, err + } + officeHour.Tutor, err = r.tutorRepo.FindById(tutorId) + if err != nil { + err = fmt.Errorf("Error finding tutor by id %d for office hour: %w", tutorId, err) + log.Println(err.Error()) + return officeHour, err + } + officeHour.Course, err = r.courseRepo.FindById(courseId) + if err != nil { + err = fmt.Errorf("Error finding course by id %d for office hour: %w", courseId, err) + log.Println(err.Error()) + return officeHour, err + } return officeHour, nil } @@ -142,13 +183,29 @@ func (r *OfficeHourRepo) getFromRows(rows *sql.Rows) ([]models.OfficeHour, error for rows.Next() { var officeHour models.OfficeHour var week, day, hour, minute, tutorId, roomId, courseId int + var err error if err := rows.Scan(&officeHour.Id, &tutorId, &day, &hour, &minute, &roomId, &courseId, &week, &officeHour.Info, &officeHour.Active, &officeHour.Duration); err != nil { - return officeHours, fmt.Errorf("Error getting multiple officeHour rows from database: %s", err.Error()) + return officeHours, fmt.Errorf("Error getting multiple officeHour rows from database: %w", err) } officeHour.Date = models.Date{Week: week, Day: day, Hour: hour, Minute: minute} - officeHour.Room, _ = r.roomRepo.FindById(roomId) - officeHour.Tutor, _ = r.tutorRepo.FindById(tutorId) - officeHour.Course, _ = r.courseRepo.FindById(courseId) + officeHour.Room, err = r.roomRepo.FindById(roomId) + if err != nil { + err = fmt.Errorf("Error finding room by id %d for office hour: %w", roomId, err) + log.Println(err.Error()) + return officeHours, err + } + officeHour.Tutor, err = r.tutorRepo.FindById(tutorId) + if err != nil { + err = fmt.Errorf("Error finding tutor by id %d for office hour: %w", tutorId, err) + log.Println(err.Error()) + return officeHours, err + } + officeHour.Course, err = r.courseRepo.FindById(courseId) + if err != nil { + err = fmt.Errorf("Error finding course by id %d for office hour: %w", courseId, err) + log.Println(err.Error()) + return officeHours, err + } officeHours = append(officeHours, officeHour) } return officeHours, nil @@ -163,7 +220,9 @@ func (r *OfficeHourRepo) NumberByTimeSpanAndRoom(date models.Date, duration int, rows, err = r.db.Query("SELECT * FROM officeHour WHERE room=?", room.Id) } if err != nil { - return 0, fmt.Errorf("Error getting officeHours by timespan and room from database: %s", err.Error()) + err = fmt.Errorf("Error getting officeHours by timespan and room from database: %w", err) + log.Println(err.Error()) + return 0, err } defer rows.Close() officeHours, err := r.getFromRows(rows) diff --git a/repositories/request.go b/repositories/request.go index 2ebdb73..e6273e9 100644 --- a/repositories/request.go +++ b/repositories/request.go @@ -5,13 +5,14 @@ import ( "bytes" "crypto/rand" "database/sql" + "errors" "fmt" "log" "math/big" "net/smtp" "officeHours/config" - "officeHours/controllers" "officeHours/models" + "officeHours/templating" ) type RequestRepo struct { @@ -53,6 +54,8 @@ func (r *RequestRepo) FindByOfficeHour(officeHour models.OfficeHour) ([]models.R var request models.Request var officeHourId int if err := rows.Scan(&request.Id, &officeHourId, &request.Action, &request.Secret); err != nil { + err = fmt.Errorf("Error scanning request row: %w", err) + log.Println(err.Error()) return requests, err } request.OfficeHour, err = r.officeHourRepo.FindById(officeHourId) @@ -66,7 +69,7 @@ func (r *RequestRepo) FindByOfficeHour(officeHour models.OfficeHour) ([]models.R func (r *RequestRepo) Add(officeHour models.OfficeHour, action int) (int, error) { existents, err := r.FindByOfficeHour(officeHour) - if err != nil && err != sql.ErrNoRows { + if err != nil && !errors.Is(err, sql.ErrNoRows) { return 0, err } /* Resend confirmation mail if identical request exists, @@ -100,10 +103,10 @@ func (r *RequestRepo) Execute(request models.Request) error { _, err = r.db.Exec("UPDATE officeHour SET active=true WHERE id=?", request.OfficeHour.Id) r.db.Exec("DELETE FROM request WHERE officeHour=?", request.OfficeHour.Id) case models.RequestDelete: - r.officeHourRepo.Delete(request.OfficeHour) + err = r.officeHourRepo.Delete(request.OfficeHour) r.db.Exec("DELETE FROM request WHERE officeHour=?", request.OfficeHour.Id) default: - r.db.Exec("DELETE FROM request WHERE id=?", request.Id) + _, err = r.db.Exec("DELETE FROM request WHERE id=?", request.Id) } return err } @@ -112,10 +115,10 @@ func (r *RequestRepo) newSecret() (string, error) { var err error var secret string // find unused secret - for err != sql.ErrNoRows { + for !errors.Is(err, sql.ErrNoRows) { secret = randomString(r.config.Request.SecretLength) _, err = r.FindBySecret(secret) - if err != nil && err != sql.ErrNoRows { + if err != nil && !errors.Is(err, sql.ErrNoRows) { return "", err } } @@ -128,11 +131,13 @@ func (r *RequestRepo) sendConfirmationMail(request models.Request) error { Config config.Config Request models.Request }{r.config, request} - err := controllers.RawTemplates.ExecuteTemplate(&message, "confirmationMail", data) + err := templating.WriteTemplate(&message, "confirmationMail", data) if err != nil { - log.Printf("Error parsing confirmation Mail: %s", err.Error()) + err = fmt.Errorf("Error parsing confirmation Mail: %w", err) + log.Println(err.Error()) return err } + switch r.config.Mailer.Type { case "Stdout": fmt.Println(message.String()) @@ -142,7 +147,12 @@ func (r *RequestRepo) sendConfirmationMail(request models.Request) error { if r.config.Mailer.SmtpUseAuth { auth = smtp.PlainAuth(r.config.Mailer.SmtpIdentity, r.config.Mailer.FromAddress, r.config.Mailer.SmtpPassword, r.config.Mailer.SmtpHost) } - return smtp.SendMail(fmt.Sprintf("%s:%d", r.config.Mailer.SmtpHost, r.config.Mailer.SmtpPort), auth, string(r.config.Mailer.FromName), to, message.Bytes()) + err = smtp.SendMail(fmt.Sprintf("%s:%d", r.config.Mailer.SmtpHost, r.config.Mailer.SmtpPort), auth, string(r.config.Mailer.FromName), to, message.Bytes()) + if err != nil { + err = fmt.Errorf("Error sending mail by smtp: %w", err) + log.Println(err.Error()) + } + return err } return nil } @@ -154,7 +164,10 @@ func randomString(n int) string { s := make([]rune, n) for i := range s { - position, _ := rand.Int(rand.Reader, big.NewInt(int64(len(letters)))) + position, err := rand.Int(rand.Reader, big.NewInt(int64(len(letters)))) + if err != nil { + log.Printf("Error getting random position in randomString(n int): %s", err.Error()) + } s[i] = letters[position.Int64()] } return string(s) diff --git a/repositories/room.go b/repositories/room.go index 2ad0c69..771eb8c 100644 --- a/repositories/room.go +++ b/repositories/room.go @@ -3,6 +3,9 @@ package repositories import ( "database/sql" + "errors" + "fmt" + "log" "officeHours/models" ) @@ -29,6 +32,10 @@ func (r *RoomRepo) FindById(id int) (models.Room, error) { row := r.db.QueryRow("SELECT * FROM room WHERE id=?", id) var room models.Room if err := row.Scan(&room.Id, &room.Name, &room.MaxOccupy); err != nil { + err = fmt.Errorf("Error scanning row to get room: %w", err) + if !errors.Is(err, sql.ErrNoRows) { + log.Println(err.Error()) + } return models.Room{}, err } return room, nil @@ -37,6 +44,8 @@ func (r *RoomRepo) FindById(id int) (models.Room, error) { func (r *RoomRepo) GetAll() ([]models.Room, error) { rows, err := r.db.Query("SELECT * FROM room") if err != nil { + err = fmt.Errorf("Error getting all rooms: %w", err) + log.Println(err.Error()) return nil, err } defer rows.Close() @@ -45,15 +54,10 @@ func (r *RoomRepo) GetAll() ([]models.Room, error) { for rows.Next() { var room models.Room if err := rows.Scan(&room.Id, &room.Name, &room.MaxOccupy); err != nil { + err = fmt.Errorf("Error scanning row to get room: %w", err) return rooms, err } rooms = append(rooms, room) } return rooms, nil } -func (r *RoomRepo) Save(room models.Room) error { - return nil -} -func (r *RoomRepo) Add(room models.Room) error { - return nil -} diff --git a/repositories/tutor.go b/repositories/tutor.go index c5693c1..3c84819 100644 --- a/repositories/tutor.go +++ b/repositories/tutor.go @@ -3,6 +3,9 @@ package repositories import ( "database/sql" + "errors" + "fmt" + "log" "officeHours/models" ) @@ -27,6 +30,8 @@ func (r *TutorRepo) FindByEmail(email string) ([]models.Tutor, error) { for rows.Next() { var tutor models.Tutor if err := rows.Scan(&tutor.Id, &tutor.Name, &tutor.Email); err != nil { + err = fmt.Errorf("Error scanning tutor row: %w", err) + log.Println(err.Error()) return tutors, err } tutors = append(tutors, tutor) @@ -63,23 +68,24 @@ func (r *TutorRepo) GetAll() ([]models.Tutor, error) { for rows.Next() { var tutor models.Tutor if err := rows.Scan(&tutor.Id, &tutor.Name, &tutor.Email); err != nil { + err = fmt.Errorf("Error scanning tutor row: %w", err) + log.Println(err.Error()) return tutors, err } tutors = append(tutors, tutor) } return tutors, nil } -func (r *TutorRepo) Save(tutor models.Tutor) error { - return nil -} func (r *TutorRepo) Add(tutor models.Tutor) (int, error) { //Don't add identical tutors existentTutor, err := r.FindByNameAndEmail(tutor.Name, tutor.Email) - if err == sql.ErrNoRows { + if errors.Is(err, sql.ErrNoRows) { sqlResult, err := r.db.Exec("INSERT INTO `tutor` (name, email) VALUES (?,?)", tutor.Name, tutor.Email) - id, _ := sqlResult.LastInsertId() + id, lastInsertIdErr := sqlResult.LastInsertId() + if lastInsertIdErr != nil { + log.Printf("Error getting Id for new tutor: %s", lastInsertIdErr.Error()) + } return int(id), err } return existentTutor.Id, err - } diff --git a/sqldb/sqldb.go b/sqldb/sqldb.go index 783ba88..f4c5e26 100644 --- a/sqldb/sqldb.go +++ b/sqldb/sqldb.go @@ -3,14 +3,13 @@ package sqldb import ( "database/sql" "fmt" - "log" "officeHours/config" _ "github.com/go-sql-driver/mysql" _ "github.com/mattn/go-sqlite3" ) -func Connect(config config.Config) *sql.DB { +func Connect(config config.Config) (*sql.DB, error) { switch config.SQL.Type { case "SQLite": return connectSQLite(config.SQL.SQLiteFile) @@ -21,30 +20,28 @@ func Connect(config config.Config) *sql.DB { config.SQL.MysqlPort, config.SQL.MysqlDatabase) default: - log.Fatal("Type of database not recognised.") + return nil, fmt.Errorf("Type of database not recognised: %s", config.SQL.Type) } - return nil } -func connectSQLite(file string) *sql.DB { +func connectSQLite(file string) (*sql.DB, error) { db, err := sql.Open("sqlite3", file) if err != nil { - log.Fatal(err) + return db, fmt.Errorf("Error opening SQLite database: %w", err) } - - return db + return db, nil } -func connectMysql(user string, password string, address string, port int, database string) *sql.DB { +func connectMysql(user string, password string, address string, port int, database string) (*sql.DB, error) { db, err := sql.Open("mysql", fmt.Sprintf("%s:%s@tcp(%s:%d)/%s", user, password, address, port, database)) if err != nil { - log.Fatalf("Error connecting to database: %s", err) + return db, fmt.Errorf("Error connecting to Mysql database: %w", err) } err = db.Ping() // handle error if err != nil { - log.Fatalf("Error pinging database: %s", err) + return db, fmt.Errorf("Error pinging Mysql database: %w", err) } - return db + return db, nil } diff --git a/templating/templates.go b/templating/templates.go new file mode 100644 index 0000000..982b2c2 --- /dev/null +++ b/templating/templates.go @@ -0,0 +1,138 @@ +package templating + +import ( + "fmt" + "html/template" + "io" + "log" + "net/http" + "officeHours/models" + "os" + "time" +) + +// parsed templates available for execution +var templates map[string]*template.Template = map[string]*template.Template{} + +// Initialise and parse templates. +// +// Should only be called once. +// +// Since this is something which may error and feels like +// it should not be done automatically on import, +// put it into a function. +func InitTemplates() error { + const templateDir = "templating/templates/" + var funcs = template.FuncMap{ + "DayName": models.DayName, + "divide": func(i int, j int) int { return i / j }, + } + var emptyTemplate = template.New("").Funcs(funcs) + var baseTemplate, err = template.ParseFiles(templateDir + "base.html") + if err != nil { + return fmt.Errorf("parsing base template failed:\n%w", err) + } + baseTemplate.Funcs(funcs) + + type toCache struct { + filename string + standalone bool + } + var toParse = map[string]toCache{ + // full html templates + "addFailure": {"addFailure.html", false}, + "addMask": {"addMask.html", false}, + "addSuccess": {"addSuccess.html", false}, + "deleteSuccess": {"deleteSuccess.html", false}, + "executeFailure": {"executeFailure.html", false}, + "executeSuccess": {"executeSuccess.html", false}, + "index": {"index.html", false}, + "requestNotFound": {"requestNotFound.html", false}, + // standalone templates + "confirmationMail": {"confirmationMail", true}, + "officeHourTable": {"officeHourTable.html", true}, + "td": {"td.html", true}, + } + + // parse templates and add to global mapping + for key, tmpl := range toParse { + if _, exists := templates[key]; exists { + return fmt.Errorf("template '%s' already parsed", key) + } + fullName := templateDir + tmpl.filename + // check that template file + info, err := os.Stat(fullName) + if err != nil { + return fmt.Errorf("adding template %s failed:\n%w", tmpl.filename, err) + } + if info.IsDir() { + return fmt.Errorf("adding template %s failed: is a directory", tmpl.filename) + } + // parse + var parsed *template.Template + if tmpl.standalone { + parsed, err = emptyTemplate.Clone() + parsed = parsed.New(tmpl.filename) + } else { + parsed, err = baseTemplate.Clone() + } + if err != nil { + return fmt.Errorf("cloning base template failed:\n%w", err) + } + parsed, err = parsed.ParseFiles(fullName) + if err != nil { + return fmt.Errorf("parsing template %s failed:\n%w", tmpl.filename, err) + } + templates[key] = parsed + } + return nil +} + +// Execute a template and write it to the given writer. +// +// Parameters: +// - name: name of the template to execute +// - data: passed through to the template +func WriteTemplate(w io.Writer, name string, data any) error { + tmpl, exists := templates[name] + if !exists { + return fmt.Errorf("template %s not available", name) + } + tmpl, err := tmpl.Clone() + if err != nil { + return fmt.Errorf("cloning template failed:\n%w", err) + } + err = tmpl.Execute(w, data) + if err != nil { + return fmt.Errorf("template execution failed:\n%w", err) + } + return nil +} + +// Execute a template and write it to a http writer. +// +// Similar to WriteTemplate, but in error case this adds a corresponding +// status code and writes an error message to the writer. +// +// Typically, this is the final action in handling an http request. +// +// Parameters: +// - name: name of the template to execute +// - data: passed through to the template +func ServeTemplate(w http.ResponseWriter, name string, data any) { + // TODO: make this return an error, handle on top of every request handler + err := WriteTemplate(w, name, data) + if err != nil { + err = fmt.Errorf("writing template failed:\n%w", err) + log.Println(err.Error()) + w.WriteHeader(http.StatusInternalServerError) + io.WriteString(w, `Internal Server Error. + +Du kannst uns helfen, indem du folgende Fehlermeldung per Mail +an sprechstunden@mathebau.de sendest: + +Fehler um\n +`+time.Now().String()+"\n"+err.Error()) + return + } +} diff --git a/templates/addFailure.html b/templating/templates/addFailure.html similarity index 100% rename from templates/addFailure.html rename to templating/templates/addFailure.html diff --git a/templates/addMask.html b/templating/templates/addMask.html similarity index 100% rename from templates/addMask.html rename to templating/templates/addMask.html diff --git a/templates/addSuccess.html b/templating/templates/addSuccess.html similarity index 100% rename from templates/addSuccess.html rename to templating/templates/addSuccess.html diff --git a/templates/base.html b/templating/templates/base.html similarity index 100% rename from templates/base.html rename to templating/templates/base.html diff --git a/templates/confirmationMail b/templating/templates/confirmationMail similarity index 100% rename from templates/confirmationMail rename to templating/templates/confirmationMail diff --git a/templates/deleteSuccess.html b/templating/templates/deleteSuccess.html similarity index 100% rename from templates/deleteSuccess.html rename to templating/templates/deleteSuccess.html diff --git a/templates/executeFailure.html b/templating/templates/executeFailure.html similarity index 100% rename from templates/executeFailure.html rename to templating/templates/executeFailure.html diff --git a/templates/executeSuccess.html b/templating/templates/executeSuccess.html similarity index 100% rename from templates/executeSuccess.html rename to templating/templates/executeSuccess.html diff --git a/templates/index.html b/templating/templates/index.html similarity index 100% rename from templates/index.html rename to templating/templates/index.html diff --git a/templates/officeHourTable.html b/templating/templates/officeHourTable.html similarity index 100% rename from templates/officeHourTable.html rename to templating/templates/officeHourTable.html diff --git a/templates/requestNotFound.html b/templating/templates/requestNotFound.html similarity index 100% rename from templates/requestNotFound.html rename to templating/templates/requestNotFound.html diff --git a/templates/td.html b/templating/templates/td.html similarity index 100% rename from templates/td.html rename to templating/templates/td.html