Add Echo as HTTP Server.

Author: myrkvi

.idea/Modmail.iml

@@ -8,6 +8,9 @@ COPY *.go ./
 # Copy help
 COPY ./help.md ./
 
+# Copy HTML
+COPY *.html ./
+
 RUN go mod download
 RUN  go build -o /bin/modmail
 

Dockerfile

@@ -213,7 +213,7 @@ func helpHandler(ev *handler.CommandEvent) error {
 	}
 
 	return ev.CreateMessage(discord.MessageCreate{
-		Content: helpText,
+		Content: "",
 		Embeds: []discord.Embed{
 			discord.NewEmbedBuilder().
 				SetTitle("Modmail Help").

create_commands.go

@@ -1,17 +1,16 @@
-# fly.toml app configuration file generated for nll-modmail on 2024-01-17T12:38:22+01:00
+# fly.toml app configuration file generated for nll-modmail-dev on 2024-01-21T02:40:24+01:00
 #
 # See https://fly.io/docs/reference/configuration/ for information about how to use this file.
 #
 
 app = "nll-modmail"
 primary_region = "ams"
 
+[build]
 
 [env]
-  PORT = "8080"
   MODMAIL_HTTP_SERVER_ENABLED = "true"
-
-
+  PORT = "8080"
 
 [http_service]
   internal_port = 8080
@@ -24,4 +23,4 @@ primary_region = "ams"
 [[vm]]
   cpu_kind = "shared"
   cpus = 1
-  memory_mb = 256
+  memory_mb = 1024

fly.toml

@@ -15,7 +15,11 @@ require (
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/gorilla/websocket v1.5.1 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/labstack/echo/v4 v4.11.4 // indirect
+	github.com/labstack/gommon v0.4.2 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/sagikazarmark/locafero v0.4.0 // indirect
@@ -25,6 +29,8 @@ require (
 	github.com/spf13/afero v1.11.0 // indirect
 	github.com/spf13/cast v1.6.0 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasttemplate v1.2.2 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/crypto v0.18.0 // indirect
 	golang.org/x/exp v0.0.0-20230905200255-921286631fa9 // indirect

go.mod

@@ -13,8 +13,17 @@ github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/
 github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
+github.com/labstack/echo/v4 v4.11.4 h1:vDZmA+qNeh1pd/cCkEicDMrjtrnMGQ1QFI9gWN1zGq8=
+github.com/labstack/echo/v4 v4.11.4/go.mod h1:noh7EvLwqDsmh/X/HWKPUl1AjzJrhyptRyEbQJfxen8=
+github.com/labstack/gommon v0.4.2 h1:F8qTUNXgG1+6WQmqoUWnz8WiEU60mXVVw0P4ht1WRA0=
+github.com/labstack/gommon v0.4.2/go.mod h1:QlUFxVM+SNXhDL/Z7YhocGIBYOiwB0mXm1+1bAPHPyU=
 github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY=
 github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/pelletier/go-toml/v2 v2.1.0 h1:FnwAJ4oYMvbT/34k9zzHuZNrhlz48GB3/s6at6/MHO4=
@@ -44,6 +53,10 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
 github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
+github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
+github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
+github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo=
+github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ=
 go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
 go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
@@ -52,6 +65,8 @@ golang.org/x/exp v0.0.0-20230905200255-921286631fa9 h1:GoHiUyI/Tp2nVkLI2mCxVkOjs
 golang.org/x/exp v0.0.0-20230905200255-921286631fa9/go.mod h1:S2oDrQGGwySpoQPVqRShND87VCbxmc6bL1Yd2oYrm6k=
 golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
 golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
 golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=

go.sum

@@ -1,7 +1,4 @@
-Modmail is a bot that helps users contact moderators privately.
-It does so by providing a thin layer on top of Discord's existing
-Threads feature, allowing users to send messages in a private channel,
-that is attached to a parent channel.
+Modmail is a bot that helps users contact moderators privately. It does so by providing a thin layer on top of Discord's existing Threads feature, allowing users to send messages in a private channel, that is attached to a parent channel.
 
 ## Commands
 - `/help` - Show this help message.
@@ -10,8 +7,7 @@ that is attached to a parent channel.
   - `label: text` - The label of the button.
   - `color: color` - (Optional) The color of the button. Defaults to blue.
   - `role: role` - (Optional) The role that can use the button. Defaults to nobody.
-    - **Note:** If no role is specified, moderators or other intended support will not be notified of new reports.
-      If a non-mentionable role is specified, the bot must have the permission for mentioning all roles.
+    - **Note:** If no role is specified, moderators or other intended support will not be notified of new reports. If a non-mentionable role is specified, the bot must have the permission for mentioning all roles.
 
 ## Permissions
 
@@ -22,4 +18,13 @@ that is attached to a parent channel.
   - **Embed Links:** This is required to include the content submitted by the user.
 - **__Optional Permissions__**
   - **Manage Threads:** To set Threads to non-invitable and extend the thread's archive timer.
-  - **Mention Everyone:** To mention the role specified in `/create-report-button`.
+  - **Mention Everyone:** To mention the role specified in `/create-report-button`.
+
+## Getting Started
+1. Set up a channel that will be used for modmail.
+2. Set it up so that users can only read messages, but cannot create threads.
+    - If desired, you can allow users to manually create private threads.
+3. Ensure the bot has the required permissions; it should by default, but you can restrict it to only the modmail channel if you want.
+4. Type up some guidelines or other information that may be pertinent to users for when they contact you.
+5. Run `/create-report-button` in the channel you want the button to be in.
+6. Done! Users can now click the button to contact you, and threads will be created in the modmail channel.

help.md

@@ -2,6 +2,8 @@ package main
 
 import (
 	"context"
+	_ "embed"
+	"encoding/hex"
 	"fmt"
 	"github.com/disgoorg/disgo"
 	"github.com/disgoorg/disgo/bot"
@@ -10,6 +12,7 @@ import (
 	"github.com/disgoorg/disgo/handler"
 	"github.com/disgoorg/disgo/httpserver"
 	"github.com/disgoorg/snowflake/v2"
+	"github.com/labstack/echo/v4"
 	"github.com/spf13/viper"
 	"log/slog"
 	"os"
@@ -46,16 +49,12 @@ func main() {
 	})
 	r.Command("/ping", pingHandler)
 	r.Command("/create-report-button", createReportButtonHandler)
+	r.Command("/help", helpHandler)
 	r.Component("/report-button/{role}", reportButtonHandler)
 	r.Modal("/report-modal/{role}", reportModalHandler)
 
 	client, err := disgo.New(
 		BOT_TOKEN,
-		bot.WithHTTPServerConfigOpts(
-			PUB_KEY,
-			httpserver.WithURL("/interactions"),
-			httpserver.WithAddress(fmt.Sprintf(":%d", viper.GetUint("http_server.port"))),
-		),
 		bot.WithDefaultGateway(),
 		bot.WithEventListeners(r),
 		bot.WithEventListenerFunc(func(ev *events.Ready) {
@@ -95,7 +94,8 @@ func main() {
 	}
 
 	if viper.GetBool("http_server.enabled") {
-		err = client.OpenHTTPServer()
+		address := fmt.Sprintf(":%d", viper.GetInt("http_server.port"))
+		openHTTPServer(client, PUB_KEY, "/interactions", address)
 		slog.Info("HTTP server is listening", "port", viper.GetInt("http_server.port"))
 	} else {
 		err = client.OpenGateway(context.Background())
@@ -108,3 +108,34 @@ func main() {
 	signal.Notify(s, os.Interrupt, syscall.SIGTERM)
 	<-s
 }
+
+//go:embed welcome.html
+var welcomePage string
+
+func openHTTPServer(client bot.Client, publicKey, webhookPath, address string) {
+	r := echo.New()
+	pubKeyBytes, err := hex.DecodeString(publicKey)
+	if err != nil {
+		panic(err)
+	}
+
+	handlerFunc := httpserver.HandleInteraction(
+		pubKeyBytes,
+		slog.Default(),
+		client.EventManager().HandleHTTPEvent,
+	)
+
+	r.POST(webhookPath, func(c echo.Context) error {
+		handlerFunc.ServeHTTP(c.Response().Writer, c.Request())
+		return nil
+	})
+
+	r.GET("/", func(c echo.Context) error {
+		return c.HTML(200, welcomePage)
+	})
+
+	slog.Info("HTTP server is listening", "address", address)
+
+	r.HideBanner = true
+	go r.Start(address)
+}

main.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"context"
+	"encoding/hex"
+	"github.com/disgoorg/disgo/httpserver"
+	"github.com/labstack/echo/v4"
+	"log/slog"
+)
+
+type Server struct {
+	*echo.Echo
+	EventHandlerFunc httpserver.EventHandlerFunc
+	publicKey        string
+}
+
+var _ httpserver.Server = (*Server)(nil)
+
+func NewServer(publicKey string, eventHandlerFunc httpserver.EventHandlerFunc) Server {
+	return Server{
+		Echo:             echo.New(),
+		EventHandlerFunc: eventHandlerFunc,
+		publicKey:        publicKey,
+	}
+}
+
+func (s *Server) Start() {
+	hexKey, err := hex.DecodeString(s.publicKey)
+	if err != nil {
+		slog.Error("failed to decode public key",
+			"error", err)
+		panic(err)
+	}
+	handlerFunc := httpserver.HandleInteraction(
+		hexKey,
+		slog.Default(),
+		s.EventHandlerFunc,
+	)
+	s.POST("/interactions", func(ctx echo.Context) error {
+		handlerFunc(ctx.Response().Writer, ctx.Request())
+		return nil
+	})
+
+	s.Logger.Fatal(s.Echo.Start(":8080"))
+}
+
+func (s *Server) Close(ctx context.Context) {
+	if err := s.Echo.Shutdown(ctx); err != nil {
+		slog.Error("failed to shutdown http server",
+			"error", err)
+	}
+}
+
+func startServer() {
+	r := echo.New()
+	r.GET("/", func(c echo.Context) error {
+		return c.String(200, "Hello, World!")
+	})
+
+	r.Logger.Fatal(r.Start(":8080"))
+}

server.go

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <script src="https://cdn.twind.style" crossorigin></script>
+        <!--<script>
+            twind.install({
+                /* options */
+            })
+        </script>-->
+    </head>
+    <body>
+        <div class="relative flex min-h-screen flex-col justify-center overflow-hidden bg-amber-400 py-6 sm:py-12">
+            <div class="relative bg-amber-100 px-6 pt-10 pb-8 shadow-xl ring-1 ring-gray-900/5 sm:mx-auto sm:max-w-lg sm:rounded-lg sm:px-10">
+                <div class="mx-auto max-w-md">
+                    <h1 class="text-4xl font-thin">Modmail</h1>
+                    <div class="divide-y divide-gray-300/50">
+                        <div class="space-y-6 py-8 text-base leading-7 text-gray-600">
+                            <p>
+                                <i>Modmail</i> is a simple bot for handling staff support requests for a Dsicord server. It uses Discord's existing threads and adds a more user-friendly interface for starting a new one, with the intent of getting in touch with moderators or other support staff.
+                            </p>
+                            <p>
+                                The bot works entirely by Discord's interactions system. This means that the bot does not read any messages from the server, and instead functions entirely passively.
+                            </p>
+                            <p>
+                                <a href="https://discord.com/api/oauth2/authorize?client_id=1195759348438282281&permissions=395137138688&scope=bot"
+                                   class="border-2 border-stone-600 rounded-md p-0.5 bg-amber-200 hover:bg-amber-300 select-none">
+                                    Add Modmail to your server!
+                                </a>
+                            </p>
+                            <hr class="border-stone-600">
+                            <p>
+                                This bot is maintained by
+                                <a href="https://myrkvi.no/" class="underline">Myrkvi</a>.
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </body>
+</html>