From edd90bb293c05b7638a231ca5fb2cdf61fe75f60 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Thu, 21 Oct 2021 23:59:53 +0200 Subject: [PATCH] [quotedb] Add HTTP API Signed-off-by: Knut Ahlers --- internal/actors/quotedb/actor.go | 39 +++++- internal/actors/quotedb/http.go | 208 +++++++++++++++++++++++++++++++ 2 files changed, 245 insertions(+), 2 deletions(-) create mode 100644 internal/actors/quotedb/http.go diff --git a/internal/actors/quotedb/actor.go b/internal/actors/quotedb/actor.go index 1e27218..ecb7438 100644 --- a/internal/actors/quotedb/actor.go +++ b/internal/actors/quotedb/actor.go @@ -77,6 +77,8 @@ func Register(args plugins.RegistrationArguments) error { }, }) + registerAPI(args.RegisterAPIRoute) + args.RegisterTemplateFunction("lastQuoteIndex", func(m *irc.Message, r *plugins.Rule, fields plugins.FieldCollection) interface{} { return func() int { return storedObject.GetMaxQuoteIdx(plugins.DeriveChannel(m, nil)) @@ -232,6 +234,15 @@ func (s *storage) DelQuote(channel string, quote int) { s.ChannelQuotes[channel] = quotes } +func (s *storage) GetChannelQuotes(channel string) []string { + s.lock.RLock() + defer s.lock.RUnlock() + + var out []string + out = append(out, s.ChannelQuotes[channel]...) + return out +} + func (s *storage) GetMaxQuoteIdx(channel string) int { s.lock.RLock() defer s.lock.RUnlock() @@ -254,11 +265,35 @@ func (s *storage) GetQuote(channel string, quote int) (int, string) { return quote, s.ChannelQuotes[channel][quote-1] } -// Implement marshaller interfaces -func (s *storage) MarshalStoredObject() ([]byte, error) { +func (s *storage) SetQuotes(channel string, quotes []string) { s.lock.Lock() defer s.lock.Unlock() + s.ChannelQuotes[channel] = quotes +} + +func (s *storage) UpdateQuote(channel string, idx int, quote string) { + s.lock.Lock() + defer s.lock.Unlock() + + var quotes []string + for i := range s.ChannelQuotes[channel] { + if i == idx { + quotes = append(quotes, quote) + continue + } + + quotes = append(quotes, s.ChannelQuotes[channel][i]) + } + + s.ChannelQuotes[channel] = quotes +} + +// Implement marshaller interfaces +func (s *storage) MarshalStoredObject() ([]byte, error) { + s.lock.RLock() + defer s.lock.RUnlock() + return json.Marshal(s) } diff --git a/internal/actors/quotedb/http.go b/internal/actors/quotedb/http.go new file mode 100644 index 0000000..cea5aab --- /dev/null +++ b/internal/actors/quotedb/http.go @@ -0,0 +1,208 @@ +package quotedb + +import ( + "encoding/json" + "net/http" + "strconv" + "strings" + + "github.com/Luzifer/twitch-bot/plugins" + "github.com/gorilla/mux" + "github.com/pkg/errors" +) + +func registerAPI(register plugins.HTTPRouteRegistrationFunc) { + register(plugins.HTTPRouteRegistrationArgs{ + Description: "Add quotes for the given {channel}", + HandlerFunc: handleAddQuotes, + Method: http.MethodPost, + Module: "quotedb", + Name: "Add Quotes", + Path: "/{channel}", + ResponseType: plugins.HTTPRouteResponseTypeTextPlain, + RouteParams: []plugins.HTTPRouteParamDocumentation{ + { + Description: "Channel to delete the quote in", + Name: "channel", + }, + }, + }) + + register(plugins.HTTPRouteRegistrationArgs{ + Description: "Deletes quote with given {idx} from {channel}", + HandlerFunc: handleDeleteQuote, + Method: http.MethodDelete, + Module: "quotedb", + Name: "Delete Quote", + Path: "/{channel}/{idx:[0-9]+}", + ResponseType: plugins.HTTPRouteResponseTypeTextPlain, + RouteParams: []plugins.HTTPRouteParamDocumentation{ + { + Description: "Channel to delete the quote in", + Name: "channel", + }, + { + Description: "Index of the quote to delete", + Name: "idx", + }, + }, + }) + + register(plugins.HTTPRouteRegistrationArgs{ + Description: "Lists all quotes for the given {channel}", + HandlerFunc: handleListQuotes, + Method: http.MethodGet, + Module: "quotedb", + Name: "List Quotes", + Path: "/{channel}", + ResponseType: plugins.HTTPRouteResponseTypeJSON, + RouteParams: []plugins.HTTPRouteParamDocumentation{ + { + Description: "Channel to delete the quote in", + Name: "channel", + }, + }, + }) + + register(plugins.HTTPRouteRegistrationArgs{ + Description: "Set quotes for the given {channel} (will overwrite ALL quotes!)", + HandlerFunc: handleReplaceQuotes, + Method: http.MethodPut, + Module: "quotedb", + Name: "Set Quotes", + Path: "/{channel}", + ResponseType: plugins.HTTPRouteResponseTypeTextPlain, + RouteParams: []plugins.HTTPRouteParamDocumentation{ + { + Description: "Channel to delete the quote in", + Name: "channel", + }, + }, + }) + + register(plugins.HTTPRouteRegistrationArgs{ + Description: "Updates quote with given {idx} from {channel}", + HandlerFunc: handleDeleteQuote, + Method: http.MethodPut, + Module: "quotedb", + Name: "Update Quote", + Path: "/{channel}/{idx:[0-9]+}", + ResponseType: plugins.HTTPRouteResponseTypeTextPlain, + RouteParams: []plugins.HTTPRouteParamDocumentation{ + { + Description: "Channel to delete the quote in", + Name: "channel", + }, + { + Description: "Index of the quote to delete", + Name: "idx", + }, + }, + }) +} + +func handleAddQuotes(w http.ResponseWriter, r *http.Request) { + channel := "#" + strings.TrimLeft(mux.Vars(r)["channel"], "#") + + var quotes []string + if err := json.NewDecoder(r.Body).Decode("es); err != nil { + http.Error(w, errors.Wrap(err, "parsing input").Error(), http.StatusBadRequest) + return + } + + for _, q := range quotes { + storedObject.AddQuote(channel, q) + } + + if err := store.SetModuleStore(moduleUUID, storedObject); err != nil { + http.Error(w, errors.Wrap(err, "storing quote database").Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusCreated) +} + +func handleDeleteQuote(w http.ResponseWriter, r *http.Request) { + var ( + channel = "#" + strings.TrimLeft(mux.Vars(r)["channel"], "#") + idxStr = mux.Vars(r)["idx"] + ) + + idx, err := strconv.Atoi(idxStr) + if err != nil { + http.Error(w, errors.Wrap(err, "parsing index").Error(), http.StatusBadRequest) + return + } + + storedObject.DelQuote(channel, idx) + + if err := store.SetModuleStore(moduleUUID, storedObject); err != nil { + http.Error(w, errors.Wrap(err, "storing quote database").Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusNoContent) +} + +func handleListQuotes(w http.ResponseWriter, r *http.Request) { + channel := "#" + strings.TrimLeft(mux.Vars(r)["channel"], "#") + + quotes := storedObject.GetChannelQuotes(channel) + + if err := json.NewEncoder(w).Encode(quotes); err != nil { + http.Error(w, errors.Wrap(err, "enocding quote list").Error(), http.StatusInternalServerError) + return + } +} + +func handleReplaceQuotes(w http.ResponseWriter, r *http.Request) { + channel := "#" + strings.TrimLeft(mux.Vars(r)["channel"], "#") + + var quotes []string + if err := json.NewDecoder(r.Body).Decode("es); err != nil { + http.Error(w, errors.Wrap(err, "parsing input").Error(), http.StatusBadRequest) + return + } + + storedObject.SetQuotes(channel, quotes) + + if err := store.SetModuleStore(moduleUUID, storedObject); err != nil { + http.Error(w, errors.Wrap(err, "storing quote database").Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusNoContent) +} + +func handleUpdateQuote(w http.ResponseWriter, r *http.Request) { + var ( + channel = "#" + strings.TrimLeft(mux.Vars(r)["channel"], "#") + idxStr = mux.Vars(r)["idx"] + ) + + idx, err := strconv.Atoi(idxStr) + if err != nil { + http.Error(w, errors.Wrap(err, "parsing index").Error(), http.StatusBadRequest) + return + } + + var quotes []string + if err := json.NewDecoder(r.Body).Decode("es); err != nil { + http.Error(w, errors.Wrap(err, "parsing input").Error(), http.StatusBadRequest) + return + } + + if len(quotes) != 1 { + http.Error(w, "input must be list with one quote", http.StatusBadRequest) + return + } + + storedObject.UpdateQuote(channel, idx, quotes[0]) + + if err := store.SetModuleStore(moduleUUID, storedObject); err != nil { + http.Error(w, errors.Wrap(err, "storing quote database").Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusNoContent) +}