From 890c2862327e959411671001c8cc59b319ea57c0 Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Fri, 29 Mar 2019 10:36:20 +0000 Subject: api before/after response hooks --- system/api/handlers.go | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++ system/item/item.go | 27 ++++++++++++++----- 2 files changed, 93 insertions(+), 7 deletions(-) diff --git a/system/api/handlers.go b/system/api/handlers.go index 20356e9..29707fe 100644 --- a/system/api/handlers.go +++ b/system/api/handlers.go @@ -100,7 +100,31 @@ func contentsHandler(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := it() + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } } func contentHandler(res http.ResponseWriter, req *http.Request) { @@ -156,7 +180,31 @@ func contentHandler(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := p + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } } func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { @@ -206,7 +254,32 @@ func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := p + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } + } func uploadsHandler(res http.ResponseWriter, req *http.Request) { diff --git a/system/item/item.go b/system/item/item.go index 1108ae0..51ac2a9 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -24,13 +24,13 @@ func init() { // We store the compiled regex as the key // and assign the replacement as the map's value. rxList = map[*regexp.Regexp][]byte{ - regexp.MustCompile("`[-]+`"): []byte("-"), - regexp.MustCompile("[[:space:]]"): []byte("-"), - regexp.MustCompile("[[:blank:]]"): []byte(""), - regexp.MustCompile("`[^a-z0-9]`i"): []byte("-"), - regexp.MustCompile("[!/:-@[-`{-~]"): []byte(""), - regexp.MustCompile("/[^\x20-\x7F]/"): []byte(""), - regexp.MustCompile("`&(amp;)?#?[a-z0-9]+;`i"): []byte("-"), + regexp.MustCompile("`[-]+`"): []byte("-"), + regexp.MustCompile("[[:space:]]"): []byte("-"), + regexp.MustCompile("[[:blank:]]"): []byte(""), + regexp.MustCompile("`[^a-z0-9]`i"): []byte("-"), + regexp.MustCompile("[!/:-@[-`{-~]"): []byte(""), + regexp.MustCompile("/[^\x20-\x7F]/"): []byte(""), + regexp.MustCompile("`&(amp;)?#?[a-z0-9]+;`i"): []byte("-"), regexp.MustCompile("`&([a-z])(acute|uml|circ|grave|ring|cedil|slash|tilde|caron|lig|quot|rsquo);`i"): []byte("\\1"), } } @@ -65,6 +65,9 @@ type Sortable interface { // to the different lifecycles/events a struct may encounter. Item implements // Hookable with no-ops so our user can override only whichever ones necessary. type Hookable interface { + BeforeAPIResponse(http.ResponseWriter, *http.Request) error + AfterAPIResponse(http.ResponseWriter, *http.Request) error + BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error @@ -177,6 +180,16 @@ func (i Item) String() string { return fmt.Sprintf("Item ID: %s", i.UniqueID()) } +// BeforeAPIResponse is a no-op to ensure structs which embed Item implement Hookable +func (i Item) BeforeAPIResponse(res http.ResponseWriter, req *http.Request) error { + return nil +} + +// AfterAPIResponse is a no-op to ensure structs which embed Item implement Hookable +func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request) error { + return nil +} + // BeforeAPICreate is a no-op to ensure structs which embed Item implement Hookable func (i Item) BeforeAPICreate(res http.ResponseWriter, req *http.Request) error { return nil -- cgit v1.2.3