add logging to webserver

This reverts commit 9232168b1e.

Dockerfile

@@ -5,4 +5,6 @@ COPY . .
 RUN go get -d -v .
 RUN go install -v .
 
+EXPOSE 8080
+
 CMD [ "gidbig" ]

README.md

@@ -1,6 +1,7 @@
-# Gidbig
+# Gidbig
 
-Gidbig is a Discord Bot in Go based on (now deprecated) [Airhorn Bot by Hammer and Chisel](https://github.com/discord/airhornbot/tree/golang).  
+Gidbig is a Discord Bot in Go based on
+[Airhorn Bot by Hammer and Chisel](https://github.com/hammerandchisel/airhornbot/).  
 Visit [https://airhorn.solutions/](https://airhorn.solutions/).
 
 ## Features
@@ -15,7 +16,10 @@ Typing only the `!command` without an argument results in a random sound of this
 
 ## Installation
 Coming soon.
-
 ## To do
 - more web interface enhancements
-- add support for more than just `.dca` files, mp3 would be nice!
+
+## Known issues
+- `https://discordapp.com/api/oauth2` needs to be added to `brokenAuthHeaderProviders` in `golang.org/x/oauth2/internal/token.go` in order for oauth2 to work again.
+
+Please use the issue tracker. Thank you!

config.sample.yaml

@@ -3,6 +3,6 @@ shard: ""
 shardcount: ""
 owner: ""
 port: 8080
-redirecturl: "https://yourbot"
-ci: 1337
+redirecturl: "https://bot.example.org:1337"
+ci: 0
 cs: ""

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/dustin/go-humanize v1.0.0
 	github.com/gorilla/mux v1.8.0
 	github.com/gorilla/sessions v1.2.1
+	github.com/simplesurance/go-ip-anonymizer v0.0.0-20200429124537-35a880f8e87d
 	github.com/sirupsen/logrus v1.8.1
 	golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602
 	gopkg.in/yaml.v2 v2.2.2

go.sum

@@ -123,6 +123,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
+github.com/simplesurance/go-ip-anonymizer v0.0.0-20200429124537-35a880f8e87d h1:4FkGkGts6gLznca6fgclIvbupwbq543mb/fFkog4VIg=
+github.com/simplesurance/go-ip-anonymizer v0.0.0-20200429124537-35a880f8e87d/go.mod h1:fTTj1EOmRdtuwYw3jF/1X2dTa0N1BdbZhrpA21N/S4I=
 github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
 github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

main.go

@@ -418,6 +418,7 @@ func displayBotStats(cid string) {
 	discord.ChannelMessageSend(cid, buf.String())
 }
 
+// what did I start here?
 func utilGetMentioned(s *discordgo.Session, m *discordgo.MessageCreate) *discordgo.User {
 	for _, mention := range m.Mentions {
 		if mention.ID != s.State.Ready.User.ID {
@@ -436,7 +437,7 @@ func handleBotControlMessages(s *discordgo.Session, m *discordgo.MessageCreate,
 	}
 }
 
-func setIdleStatus(s *discordgo.Session) {
+func setIdleStatus() {
 	games := []string{
 		"Terranigma",
 		"Secret of Mana",
@@ -476,8 +477,8 @@ func setIdleStatus(s *discordgo.Session) {
 		"R-Type",
 	}
 	for {
-		s.UpdateStreamingStatus(1, "", "")
-		s.UpdateGameStatus(0, games[randomRange(0, len(games))])
+		discord.UpdateStreamingStatus(1, "", "")
+		discord.UpdateGameStatus(0, games[randomRange(0, len(games))])
 		time.Sleep(time.Duration(randomRange(5, 15)) * time.Minute)
 	}
 }
@@ -639,6 +640,9 @@ func loadConfigFile() *config {
 
 func main() {
 	config := loadConfigFile()
+	var (
+		err error
+	)
 
 	// create SoundCollections by scanning the audio folder
 	createCollections()
@@ -663,7 +667,7 @@ func main() {
 
 	// Create a discord session
 	log.Info("Starting discord session...")
-	discord, err := discordgo.New("Bot " + config.Token)
+	discord, err = discordgo.New("Bot " + config.Token)
 	if err != nil {
 		log.WithFields(log.Fields{
 			"error": err,
@@ -690,7 +694,7 @@ func main() {
 		return
 	}
 
-	go setIdleStatus(discord)
+	go setIdleStatus()
 	// We're running!
 	log.Info("Gidbig is ready. Quit with CTRL-C.")
 

webserver.go

@@ -4,15 +4,20 @@ import (
 	"bufio"
 	"crypto/rand"
 	"encoding/base64"
+	"errors"
 	"fmt"
 	"html/template"
+	"net"
 	"net/http"
 	_ "net/http/pprof"
 	"os"
+	"strconv"
 
 	"github.com/bwmarrin/discordgo"
 	"github.com/gorilla/mux"
 	"github.com/gorilla/sessions"
+	"github.com/simplesurance/go-ip-anonymizer/ipanonymizer"
+	log "github.com/sirupsen/logrus"
 	"golang.org/x/oauth2"
 )
 
@@ -37,8 +42,14 @@ var (
 		TokenURL: "https://discordapp.com/api/oauth2/token",
 	}
 	tmpls = map[string]*template.Template{}
+
 	// TODO change secret
 	store *sessions.CookieStore
+
+	ipAnonymizer = ipanonymizer.NewWithMask(
+		net.CIDRMask(16, 32),
+		net.CIDRMask(64, 128),
+	)
 )
 
 // SoundItem is used to represent a sound of our COLLECTIONS for html generation
@@ -67,8 +78,8 @@ func startWebServer(port string, ci string, cs string, redirectURL string) {
 	r := mux.NewRouter()
 	r.HandleFunc("/", handleMain)
 	r.HandleFunc("/logout", handleLogout)
-	r.HandleFunc("/discordLogin", handlediscordLogin)
-	r.HandleFunc("/discordCallback", handlediscordCallback)
+	r.HandleFunc("/discordLogin", handleDiscordLogin)
+	r.HandleFunc("/discordCallback", handleDiscordCallback)
 	r.HandleFunc("/playsound", handlePlaySound)
 	http.Handle("/", r)
 	http.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.Dir("static"))))
@@ -76,6 +87,7 @@ func startWebServer(port string, ci string, cs string, redirectURL string) {
 }
 
 func handlePlaySound(w http.ResponseWriter, r *http.Request) {
+	log.Infoln("WebUI /playsound Request from " + r.RemoteAddr)
 	r.ParseForm()
 	sound, soundCollection := findSoundAndCollection(r.FormValue("command"), r.FormValue("soundname"))
 	session, _ := store.Get(r, "gidbig-session")
@@ -106,13 +118,13 @@ func handlePlaySound(w http.ResponseWriter, r *http.Request) {
 }
 
 func handleMain(w http.ResponseWriter, r *http.Request) {
+	logWebRequests(r)
 	session, _ := store.Get(r, "gidbig-session")
 	if session.Values["discordUsername"] != nil {
 		var prefixes []string
 		var si []SoundItem
 		for _, sc := range COLLECTIONS {
-			var newSoundItemRandom SoundItem
-			newSoundItemRandom = SoundItem{
+			newSoundItemRandom := SoundItem{
 				Itemprefix:    sc.Prefix,
 				Itemcommand:   "!" + sc.Prefix,
 				Itemsoundname: "",
@@ -122,8 +134,7 @@ func handleMain(w http.ResponseWriter, r *http.Request) {
 			prefixes = append(prefixes, sc.Prefix)
 			si = append(si, newSoundItemRandom)
 			for _, snd := range sc.Sounds {
-				var newSoundItem SoundItem
-				newSoundItem = SoundItem{
+				newSoundItem := SoundItem{
 					Itemprefix:    sc.Prefix,
 					Itemcommand:   "!" + sc.Prefix,
 					Itemsoundname: snd.Name,
@@ -208,6 +219,7 @@ func handleMain(w http.ResponseWriter, r *http.Request) {
 	tmpls["home.html"].ExecuteTemplate(w, "footer", map[string]interface{}{})
 }
 func handleLogout(w http.ResponseWriter, r *http.Request) {
+	log.Infoln("WebUI /logout Request from " + r.RemoteAddr)
 	cookie := &http.Cookie{
 		Name:   "gidbig-session",
 		Value:  "",
@@ -217,7 +229,8 @@ func handleLogout(w http.ResponseWriter, r *http.Request) {
 	http.SetCookie(w, cookie)
 	http.Redirect(w, r, "/", http.StatusFound)
 }
-func handlediscordLogin(w http.ResponseWriter, r *http.Request) {
+func handleDiscordLogin(w http.ResponseWriter, r *http.Request) {
+	logWebRequests(r)
 	b := make([]byte, 16)
 	rand.Read(b)
 	oauthStateString = base64.URLEncoding.EncodeToString(b)
@@ -230,7 +243,8 @@ func handlediscordLogin(w http.ResponseWriter, r *http.Request) {
 	http.Redirect(w, r, url, http.StatusTemporaryRedirect)
 }
 
-func handlediscordCallback(w http.ResponseWriter, r *http.Request) {
+func handleDiscordCallback(w http.ResponseWriter, r *http.Request) {
+	logWebRequests(r)
 	session, err := store.Get(r, "gidbig-session")
 	if err != nil {
 		fmt.Fprintln(w, "aborted")
@@ -275,3 +289,44 @@ func handlediscordCallback(w http.ResponseWriter, r *http.Request) {
 
 	http.Redirect(w, r, "/", http.StatusTemporaryRedirect)
 }
+
+func parseIPPort(s string) (ip net.IP, port, space string, err error) {
+	ip = net.ParseIP(s)
+	if ip == nil {
+		var host string
+		host, port, err = net.SplitHostPort(s)
+		if err != nil {
+			return
+		}
+		if port != "" {
+			// This check only makes sense if service names are not allowed
+			if _, err = strconv.ParseUint(port, 10, 16); err != nil {
+				return
+			}
+		}
+		ip = net.ParseIP(host)
+	}
+	if ip == nil {
+		err = errors.New("invalid address format")
+	} else {
+		space = "IPv6"
+		if ip4 := ip.To4(); ip4 != nil {
+			space = "IPv4"
+			ip = ip4
+		}
+	}
+	return
+}
+
+func logWebRequests(r *http.Request) {
+	ip, port, _, err := parseIPPort(r.RemoteAddr)
+	if err != nil {
+		log.Warnln("Error parsing IP address for WebUI Request to " + r.RequestURI)
+	}
+	anonIP, err := ipAnonymizer.IPString(ip.String())
+	if err != nil {
+		log.Warnln("Could not anonymize IP address for WebUI Request to " + r.RequestURI)
+	} else {
+		log.Infoln("WebUI Request to " + r.RequestURI + " from " + anonIP + port)
+	}
+}