Merge pull request #6 from havce/open

Prepare for open sourcing

Dockerfile

@@ -11,10 +11,10 @@ COPY . .
 
 ENV CGO_ENABLED=0
 
-RUN go build -o havcebotd ./cmd/havcebotd
+RUN go build -o ctfbotd ./cmd/ctfbotd
 
 FROM gcr.io/distroless/static-debian12
 
-COPY --from=builder /app/havcebotd /havcebotd
+COPY --from=builder /app/ctfbotd /ctfbotd
 
-ENTRYPOINT ["/havcebotd", "-config-path", "/havcebotd.toml"]
+ENTRYPOINT ["/ctfbotd", "-config-path", "/ctfbotd.toml"]

README.md

@@ -0,0 +1,20 @@
+# ctfbot
+
+A Discord bot for managing CTFs in your team.
+
+Picture this: your Discord server has grown too much and there are too many people wandering around. You are tired of
+gathering participation and manually setting your channel permissions. Then this what you are looking for!
+
+## Features
+
+The bot supports various commands:
+
+- `/new`: Create a new CTF (admin only)
+- `/open`: Open the CTF for registration (admin only)
+- `/close`: Close the CTF registration (admin only)
+- `/delete`: Delete the CTF (admin only)
+- `/info`: List CTFs available on CTFTime for the next weeks
+- `/vote`: Start a vote for which CTF to play (admin only)
+- `/chal`: Create a new challenge inside the CTF
+- `/flag`: Mark the challenge as solved
+- `/blood`: Mark the challenge as first blooded

cmd/havcebotd/main.go → cmd/ctfbotd/main.go

@@ -13,10 +13,10 @@ import (
 	"strings"
 
 	"github.com/BurntSushi/toml"
-	"github.com/havce/havcebot"
-	"github.com/havce/havcebot/ctftime"
-	"github.com/havce/havcebot/discord"
-	"github.com/havce/havcebot/sqlite"
+	"github.com/havce/ctfbot"
+	"github.com/havce/ctfbot/ctftime"
+	"github.com/havce/ctfbot/discord"
+	"github.com/havce/ctfbot/sqlite"
 )
 
 // Build version, injected during build.
@@ -39,8 +39,8 @@ type Config struct {
 }
 
 const (
-	DefaultDSN        = "~/havcebot.sqlite3"
-	DefaultConfigPath = "~/havcebot.toml"
+	DefaultDSN        = "~/ctfbot.sqlite3"
+	DefaultConfigPath = "~/ctfbot.toml"
 )
 
 const (
@@ -59,8 +59,8 @@ func DefaultConfig() Config {
 
 func main() {
 	// Propagate build information to root package to share globally.
-	havcebot.Version = strings.TrimPrefix(version, "")
-	havcebot.Commit = commit
+	ctfbot.Version = strings.TrimPrefix(version, "")
+	ctfbot.Commit = commit
 
 	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, os.Kill)
 	defer cancel()
@@ -116,8 +116,8 @@ func (m *Main) Close(ctx context.Context) error {
 }
 
 func (m *Main) ParseFlagAndConfig(ctx context.Context, args []string) error {
-	f := flag.NewFlagSet("havcebotd", flag.ContinueOnError)
-	f.StringVar(&m.ConfigPath, "config-path", "~/.havcebot.toml", "config file path")
+	f := flag.NewFlagSet("ctfbotd", flag.ContinueOnError)
+	f.StringVar(&m.ConfigPath, "config-path", "~/.ctfbot.toml", "config file path")
 	if err := f.Parse(args); err != nil {
 		return err
 	}
@@ -204,7 +204,7 @@ func (m *Main) Run(ctx context.Context) (err error) {
 		return err
 	}
 
-	slog.Log(ctx, slog.LevelInfo, "havcebotd started")
+	slog.Log(ctx, slog.LevelInfo, "ctfbotd started")
 
 	return nil
 }

ctf.go

@@ -1,4 +1,4 @@
-package havcebot
+package ctfbot
 
 import (
 	"context"

havcebot.go → ctfbot.go

@@ -1,4 +1,4 @@
-package havcebot
+package ctfbot
 
 var (
 	Version = "n/a"

havcebot.toml.sample → ctfbot.sample

@@ -1,5 +1,5 @@
 [db]
-dsn = "/database/havcebot.sqlite"
+dsn = "/database/ctfbot.sqlite"
 
 [discord]
 # Required

ctftime/client.go

@@ -7,7 +7,7 @@ import (
 	"net/url"
 	"strconv"
 
-	"github.com/havce/havcebot"
+	"github.com/havce/ctfbot"
 )
 
 type Client struct {
@@ -42,9 +42,9 @@ func (c *Client) FindEventByID(ctx context.Context, id int) (*Event, error) {
 	}
 
 	if resp.StatusCode > 400 && resp.StatusCode < 499 {
-		return nil, havcebot.Errorf(havcebot.ENOTFOUND, "Event not found.")
+		return nil, ctfbot.Errorf(ctfbot.ENOTFOUND, "Event not found.")
 	} else if resp.StatusCode < 200 || resp.StatusCode > 299 {
-		return nil, havcebot.Errorf(havcebot.EINVALID, "Internal server error.")
+		return nil, ctfbot.Errorf(ctfbot.EINVALID, "Internal server error.")
 	}
 
 	event := &Event{}

discord/ctf.go

@@ -13,7 +13,7 @@ import (
 	"github.com/disgoorg/disgo/discord"
 	"github.com/disgoorg/disgo/handler"
 	"github.com/disgoorg/snowflake/v2"
-	"github.com/havce/havcebot"
+	"github.com/havce/ctfbot"
 )
 
 const (
@@ -34,7 +34,7 @@ func (s *Server) handleCommandNewCTF(event *handler.CommandEvent) error {
 	// Check if CTF is already present with the same name.
 	_, err := s.CTFService.FindCTFByName(context.TODO(), ctfName)
 	if err == nil {
-		return Error(event, havcebot.Errorf(havcebot.ECONFLICT, "A CTF with the same name has already been created."))
+		return Error(event, ctfbot.Errorf(ctfbot.ECONFLICT, "A CTF with the same name has already been created."))
 	}
 
 	_, err = event.CreateFollowupMessage(discord.NewMessageCreateBuilder().
@@ -188,7 +188,7 @@ func (s *Server) handleCreateCTF(event *handler.ComponentEvent) error {
 	// Check again if CTF is already present with the same name.
 	_, err = s.CTFService.FindCTFByName(context.TODO(), ctf)
 	if err == nil {
-		return Error(event, havcebot.Errorf(havcebot.ECONFLICT, "A CTF with the same name has already been created."))
+		return Error(event, ctfbot.Errorf(ctfbot.ECONFLICT, "A CTF with the same name has already been created."))
 	}
 
 	// Create role with CTF name.
@@ -293,7 +293,7 @@ func (s *Server) handleCreateCTF(event *handler.ComponentEvent) error {
 		return Error(event, err)
 	}
 
-	err = s.CTFService.CreateCTF(context.TODO(), &havcebot.CTF{
+	err = s.CTFService.CreateCTF(context.TODO(), &ctfbot.CTF{
 		Name:  ctf,
 		Start: time.Now(),
 		// Parse the role.ID as uint64 and then convert
@@ -338,18 +338,18 @@ func (s *Server) handleJoinCTF(event *handler.ComponentEvent) error {
 	}
 
 	if !retrievedCTF.CanJoin {
-		return Error(event, havcebot.Errorf(havcebot.EUNAUTHORIZED, "Registrations are closed for `%s`. Ask an admin if you want to join.", ctf))
+		return Error(event, ctfbot.Errorf(ctfbot.EUNAUTHORIZED, "Registrations are closed for `%s`. Ask an admin if you want to join.", ctf))
 	}
 
 	role, found := s.client.Caches().Role(*event.GuildID(), roleID)
 	if !found {
 		return Error(event,
-			havcebot.Errorf(havcebot.ENOTFOUND, "Couldn't find player role for `%s`. Maybe it was deleted?", ctf))
+			ctfbot.Errorf(ctfbot.ENOTFOUND, "Couldn't find player role for `%s`. Maybe it was deleted?", ctf))
 	}
 
 	if slices.Contains(event.Member().RoleIDs, role.ID) {
 		return Error(event,
-			havcebot.Errorf(havcebot.ECONFLICT, "You already joined `%s`", ctf))
+			ctfbot.Errorf(ctfbot.ECONFLICT, "You already joined `%s`", ctf))
 	}
 
 	// Add the roleID to the roleIDs of the user.
@@ -376,7 +376,7 @@ func (s *Server) handleUpdateCanJoin(canJoin bool) func(event *handler.CommandEv
 
 		// If you're not inside a CTF it will output a CTF not found error.
 		_, err = s.CTFService.UpdateCTF(context.TODO(), parentChannel.Name(),
-			havcebot.CTFUpdate{
+			ctfbot.CTFUpdate{
 				CanJoin: &canJoin,
 			})
 		if err != nil {
@@ -403,8 +403,8 @@ func (s *Server) handleFlag(blood bool) func(event *handler.CommandEvent) error
 		}
 
 		if !s.flagAllowed(event.Channel().Name()) {
-			return Error(event, havcebot.Errorf(
-				havcebot.EINVALID, "You cannot flag here."))
+			return Error(event, ctfbot.Errorf(
+				ctfbot.EINVALID, "You cannot flag here."))
 		}
 
 		// Check if someone has already flagged this.
@@ -415,7 +415,7 @@ func (s *Server) handleFlag(blood bool) func(event *handler.CommandEvent) error
 			blocklist := []string{flagEmoji, bloodEmoji}
 			// Check against blocklist.
 			if slices.Contains(blocklist, string(c)) {
-				return Error(event, havcebot.Errorf(havcebot.EINVALID, "Somebody has already %s this.", prefix))
+				return Error(event, ctfbot.Errorf(ctfbot.EINVALID, "Somebody has already %s this.", prefix))
 			}
 		}
 
@@ -478,8 +478,8 @@ func (s *Server) handleNewChal(event *handler.CommandEvent) error {
 
 	// If so, return an error.
 	if found {
-		return Error(event, havcebot.Errorf(
-			havcebot.ECONFLICT, "Somebody has already created `%s`.", chalName))
+		return Error(event, ctfbot.Errorf(
+			ctfbot.ECONFLICT, "Somebody has already created `%s`.", chalName))
 	}
 
 	// We already validated the existence of parentChannel in the middleware.
@@ -502,7 +502,7 @@ func (s *Server) handleNewChal(event *handler.CommandEvent) error {
 
 	role, found := s.client.Caches().Role(*event.GuildID(), roleID)
 	if !found {
-		return Error(event, havcebot.Errorf(havcebot.EINTERNAL, "Couldn't find player role for `%s`. Maybe it was deleted?", ctf.Name))
+		return Error(event, ctfbot.Errorf(ctfbot.EINTERNAL, "Couldn't find player role for `%s`. Maybe it was deleted?", ctf.Name))
 	}
 
 	// Create the channel with our custom permissions.

discord/discord.go

@@ -4,7 +4,7 @@ import (
 	"github.com/disgoorg/disgo/bot"
 	"github.com/disgoorg/disgo/discord"
 	"github.com/disgoorg/disgo/rest"
-	"github.com/havce/havcebot"
+	"github.com/havce/ctfbot"
 )
 
 type CreateFollowupMessager interface {
@@ -14,9 +14,9 @@ type CreateFollowupMessager interface {
 
 func Error(event CreateFollowupMessager, err error) error {
 	// Extract error code and message.
-	code, message := havcebot.ErrorCode(err), havcebot.ErrorMessage(err)
+	code, message := ctfbot.ErrorCode(err), ctfbot.ErrorMessage(err)
 
-	if code == havcebot.EINTERNAL {
+	if code == ctfbot.EINTERNAL {
 		event.Client().Logger().Error("Internal server error", code, err)
 	}
 

discord/info.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/disgoorg/disgo/discord"
 	"github.com/disgoorg/disgo/handler"
-	"github.com/havce/havcebot"
-	"github.com/havce/havcebot/ctftime"
+	"github.com/havce/ctfbot"
+	"github.com/havce/ctfbot/ctftime"
 )
 
 const (
@@ -46,7 +46,7 @@ func (s *Server) handleInfoCTF(vote bool) func(event *handler.CommandEvent) erro
 
 			title := event.Title
 			if vote {
-				title = havcebot.Itoe(i+1) + " " + title
+				title = ctfbot.Itoe(i+1) + " " + title
 			}
 
 			embed := discord.Embed{
@@ -110,7 +110,7 @@ func (s *Server) handleInfoCTF(vote bool) func(event *handler.CommandEvent) erro
 			}
 
 			for i := range embeds {
-				err = s.client.Rest().AddReaction(event.Channel().ID(), msg.ID, havcebot.Itoe(i+1))
+				err = s.client.Rest().AddReaction(event.Channel().ID(), msg.ID, ctfbot.Itoe(i+1))
 				if err != nil {
 					return Error(event, err)
 				}

discord/middlewares.go

@@ -7,7 +7,7 @@ import (
 	"github.com/disgoorg/disgo/events"
 	"github.com/disgoorg/disgo/handler"
 	"github.com/disgoorg/disgo/handler/middleware"
-	"github.com/havce/havcebot"
+	"github.com/havce/ctfbot"
 )
 
 // AdminOnly restricts access to the routes to Administrators only.
@@ -24,7 +24,7 @@ var AdminOnly handler.Middleware = func(next handler.Handler) handler.Handler {
 				SetEphemeral(true).
 				SetEmbeds(messageEmbedError("You're not authorized to run this command.")).Build())
 
-		return havcebot.Errorf(havcebot.EUNAUTHORIZED, "You're not authorized to run this command.")
+		return ctfbot.Errorf(ctfbot.EUNAUTHORIZED, "You're not authorized to run this command.")
 	}
 }
 
@@ -35,7 +35,7 @@ func (s *Server) MustBeInsideCTFAndAdmin(next handler.Handler) handler.Handler {
 				discord.NewMessageCreateBuilder().
 					SetEphemeral(true).
 					SetEmbeds(messageEmbedError("You're not authorized to run this command.")).Build())
-			return havcebot.Errorf(havcebot.EUNAUTHORIZED, "You're not authorized to run this command.")
+			return ctfbot.Errorf(ctfbot.EUNAUTHORIZED, "You're not authorized to run this command.")
 		}
 		return s.MustBeInsideCTF(next)(e)
 	}

discord/server.go

@@ -12,8 +12,8 @@ import (
 	"github.com/disgoorg/disgo/handler"
 	"github.com/disgoorg/disgo/handler/middleware"
 	"github.com/disgoorg/snowflake/v2"
-	"github.com/havce/havcebot"
-	"github.com/havce/havcebot/ctftime"
+	"github.com/havce/ctfbot"
+	"github.com/havce/ctfbot/ctftime"
 )
 
 type Server struct {
@@ -23,7 +23,7 @@ type Server struct {
 	router handler.Router
 	client bot.Client
 
-	CTFService    havcebot.CTFService
+	CTFService    ctfbot.CTFService
 	CTFTimeClient *ctftime.Client
 
 	// Channel default names.

discord/utils.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/disgoorg/disgo/discord"
 	"github.com/disgoorg/snowflake/v2"
-	"github.com/havce/havcebot"
+	"github.com/havce/ctfbot"
 )
 
 func formatTime(t *time.Time) string {
@@ -17,11 +17,11 @@ func formatTime(t *time.Time) string {
 func (s *Server) parentChannel(channelID snowflake.ID) (discord.GuildChannel, error) {
 	currentChannel, present := s.client.Caches().Channel(channelID)
 	if !present {
-		return nil, havcebot.Errorf(havcebot.ENOTFOUND, "Channel not found.")
+		return nil, ctfbot.Errorf(ctfbot.ENOTFOUND, "Channel not found.")
 	}
 	parentChannel, present := s.client.Caches().Channel(*currentChannel.ParentID())
 	if !present {
-		return nil, havcebot.Errorf(havcebot.ENOTFOUND, "Parent channel of %s not found.", currentChannel.Name())
+		return nil, ctfbot.Errorf(ctfbot.ENOTFOUND, "Parent channel of %s not found.", currentChannel.Name())
 	}
 
 	return parentChannel, nil

docker-compose.yml

@@ -1,9 +1,9 @@
 version: '3'
 services:
-  havcebot:
+  ctfbot:
     build: .
     volumes:
-      - "./havcebotd.toml:/havcebotd.toml:ro"
+      - "./ctfbotd.toml:/ctfbotd.toml:ro"
       - "database:/database"
     restart: unless-stopped
 

error.go

@@ -1,4 +1,4 @@
-package havcebot
+package ctfbot
 
 import (
 	"errors"
@@ -36,7 +36,7 @@ type Error struct {
 
 // Error implements the error interface. Not used by the application otherwise.
 func (e *Error) Error() string {
-	return fmt.Sprintf("havcebot error: code=%s message=%s", e.Code, e.Message)
+	return fmt.Sprintf("ctfbot error: code=%s message=%s", e.Code, e.Message)
 }
 
 // ErrorCode unwraps an application error and returns its code.

go.mod

@@ -1,4 +1,4 @@
-module github.com/havce/havcebot
+module github.com/havce/ctfbot
 
 go 1.21.6