v1.0.0

README.md

@@ -1,26 +1,153 @@
 ## 🥪 Sandwich Delivery 🥪
 Sandwich Delivery is a Discord bot in which people can order any sandwich they desire (even non-existent ones), have it made in our Discord by our top-of-the-line sandwich artists, and then have it delivered to your Discord server.
 
-To see the bot in action, or you want to use our bot to order sandwiches, [Join our discord](https://discord.gg/uHVzYBt8jD)!
+[Join our Discord](https://discord.gg/uHVzYBt8jD) for quick responses, support, and to see the bot in action!
+
 
-If you find any bugs or have a suggestion, please [create an issue](../../issues/new)!
 
 ## Self Hosting
+### Bare Metal
 #### Requirements
 
-* Golang 1.20 or above
 * MariaDB 10 or later
 * A Discord server
 * [Discord bot token](https://discord.com/developers/applications)
 
+#### Setting Up 
+
+To get started, you first get an executable, you can either compile yourself (see [compilation](#compilation)) or download the latest release: [stable](../../releases/latest) or [nightly/beta](https://nightly.link/refractored/sandwich-delivery/workflows/go/master/sandwich-delivery-linux-amd64.zip).
+
+Once you have the executable, you need to create a config file in the working directory, you can use the [example config](config.json.example) as a template.
+You can find a configuration reference [here](#configuration).
+
+Once you have the config file, you can run the executable and you're off!
+
+### Docker
+#### Requirements
+
+* Docker
+* Docker Compose (optional)
+* MariaDB 10 or later (must be accessible from the container)
+* A Discord server
+* [Discord bot token](https://discord.com/developers/applications)
+
 #### Setting Up
 
-To run the bot yourself, clone the project using<br />
-``https://github.com/refractored/sandwich-delivery.git``,<br />
-then run it in the main directory using<br />
-``go run ./src/main``
+For Docker, you can use our example [docker-compose.yml](docker-compose.yml.example) file as a reference.
+You can use our image, or build one yourself, see [compilation](#compilation) (long story short, you can just change the line containing `image` to `build: .`).
+
+Once you have a container, you need to create a config file in the volume attached to `/app/work`, you can use the [example config](config.json.example) as a template.
+You can find a configuration reference [here](#configuration).
+
+Once you have the config file, you can run the container with `docker-compose up -d` (or `docker-compose up` if you want to see the logs).
+
+
+
+## Configuration
+
+### Config File
+
+The config file is a JSON file that contains all the configuration for the bot.
+The config file is located in the working directory and is called `config.json`.
+
+### Config Reference
+
+| Key                     | Type                          | Description                                                                                                        | Optional?                                                 |
+|-------------------------|-------------------------------|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
+| `token`                 | `string`                      | The Discord bot token                                                                                              | No                                                        |
+| `owners`                | `array` of `string`           | The Discord IDs of the bot owners                                                                                  | One is required                                           |
+| `guildID`               | `string`                      | The Discord ID of the guild that certain commands will be registered in (e.g. `/blacklist`)                        | No                                                        |
+| `kitchenChannelID`      | `string`                      | The Discord ID of the channel where orders will be sent.                                                           | No                                                        |
+| `startupChannelID`      | `string`                      | The Discord ID of the channel where startup and shutdown messages will be sent.                                    | Yes                                                       |
+| `database`              | `object`                      | The database configuration                                                                                         | No                                                        |
+| `database.host`         | `string`                      | The database host                                                                                                  | No, unless `database.URL` is set, then it must be empty.  |
+| `database.port`         | `int`                         | The database port                                                                                                  | No, unless `database.URL` is set, then it must be empty.  |
+| `database.user`         | `string`                      | The database user                                                                                                  | No, unless `database.URL` is set, then it must be empty.  |
+| `database.password`     | `string`                      | The database password                                                                                              | No, unless `database.URL` is set, then it must be empty.  |
+| `database.database`     | `string`                      | The database name                                                                                                  | No, unless `database.URL` is set, then it must be empty.  |
+| `database.extraOptions` | `map` of `string` -> `string` | Extra options to pass to the database connection                                                                   | Yes, unless `database.URL` is set, then it must be empty. |
+| `database.URL`          | `string`                      | The database URL/DSN. A reference can be found [here](https://github.com/go-sql-driver/mysql#dsn-data-source-name) | Yes, unless other database entries are not set.           |
+| `tokensPerOrder`        | `int`                         | The amount of tokens an order costs. Must be > 0 and defaults to 1.                                                | Yes                                                       |
+| `dailyTokens`           | `int`                         | The amount of tokens a user gets per day. Must be > 0 and defaults to 1.                                           | Yes                                                       |
+
+### !! Warning !!
+If you are using the `database.URL` option and do not add `parseTime=true` as an option, you will run into issues.
+This will also occur if you add an entry to `database.extraOptions` with the key `parseTime` and the value `false`.
+
+
+
+## Compilation
+### Getting the Source
+
+To get the source code, you can either download the source code from the [latest release](../../releases/latest) or clone the repository with git:
+
+```bash
+git clone https://github.com/refractored/sandwich-delivery
+```
+
+Then you can `cd` into the directory.
+
+### Bare Metal Executable
+#### Requirements
+
+* Go 1.21.4 or later
+
+#### Building
+
+After you have the source, building is as easy as one command:
+
+```bash
+go build -v -o sandwich-delivery src/main
+```
+
+A new executable should be created in the working directory called `sandwich-delivery`.
+
+### Docker Image
+#### Requirements
+
+* Docker
+* Docker Compose (optional)
+
+#### Building
+
+After you have the source, building is as easy as one command:
+
+```bash
+docker build -t sandwich-delivery .
+```
+
+**OR**
+
+You can use the [docker-compose.yml](docker-compose.yml.example) file as a reference, but replace `image: ` with `build: .`
+
+Then you can run the container with `docker-compose up -d` (or `docker-compose up` if you want to see the logs).
+
+
+
+## Bugs
+
+If you find any bugs or have a suggestion, please [create an issue](../../issues/new)!
+
+For quick responses and community support, you can also [join our Discord](https://discord.gg/uHVzYBt8jD).
+
+
+
+## Contributing
+
+If you want to contribute, you can create a pull request, currently, however, there are no guidelines for contributing apart from the [code of conduct](CODE_OF_CONDUCT.md).
+
+
+
+## License
 
+This project is licensed under the [GPLv3 License](LICENSE).
 
 
 
+## Credits
 
+* [Refractored](https://refractored.net) - Project Owner & Lead Developer
+* [Bacon](https://baconing.tech) - Developer
+* [All our contributors](../../graphs/contributors)
+* [All our dependencies](../../network/dependencies)
+* And you for using it ❤️

config.json.example

@@ -1,6 +1,15 @@
 {
-  "token": "BOT_TOKEN",
-  "mysqldsn": "user:password@tcp(localhost:3306)/your_database_name?parseTime=true",
-  "owners": ["1234", "1234"],
-  "guildid": "1234"
+    "token": "secret",
+    "owners": ["you", "and", "your", "friends"],
+    "guildID": "some numbers",
+
+    "kitchenChannelID": "some numbers",
+
+    "database": {
+        "host": "127.0.0.1",
+        "port": 3306,
+        "user": "sandwich",
+        "password": "secret",
+        "database": "sandwich"
+    }
 }

src/commands/blacklist.go

@@ -19,10 +19,30 @@ func (c BlacklistCommand) getCommandData() *discordgo.ApplicationCommand {
 		Description: "Blacklist a user from using the bot.",
 		Options: []*discordgo.ApplicationCommandOption{
 			{
-				Type:        discordgo.ApplicationCommandOptionUser,
-				Name:        "user",
-				Description: "The user to blacklist.",
-				Required:    true,
+				Name:        "add",
+				Description: "Add an user to the blacklisted users.",
+				Type:        discordgo.ApplicationCommandOptionSubCommand,
+				Options: []*discordgo.ApplicationCommandOption{
+					{
+						Type:        discordgo.ApplicationCommandOptionUser,
+						Name:        "user",
+						Description: "The user to blacklist.",
+						Required:    true,
+					},
+				},
+			},
+			{
+				Name:        "remove",
+				Description: "remove an user from the blacklisted users.",
+				Type:        discordgo.ApplicationCommandOptionSubCommand,
+				Options: []*discordgo.ApplicationCommandOption{
+					{
+						Type:        discordgo.ApplicationCommandOptionUser,
+						Name:        "user",
+						Description: "The user to remove.",
+						Required:    true,
+					},
+				},
 			},
 		},
 	}
@@ -37,12 +57,25 @@ func (c BlacklistCommand) permissionLevel() models.UserPermissionLevel {
 }
 
 func (c BlacklistCommand) execute(session *discordgo.Session, event *discordgo.InteractionCreate) {
-	userOption := event.ApplicationCommandData().Options[0].UserValue(session)
+	switch event.ApplicationCommandData().Options[0].Name {
+	case "add":
+		BlacklistAdd(session, event)
+		break
+	case "remove":
+		BlacklistRemove(session, event)
+		break
+	}
+}
 
-	var user models.User
+func BlacklistAdd(session *discordgo.Session, event *discordgo.InteractionCreate) {
+	userOption := event.ApplicationCommandData().Options[0].Options[0].UserValue(session)
 
-	database.GetDB().First(&user, "user_id = ?", userOption.ID)
+	var user models.User
 
+	resp := database.GetDB().Find(&user, "user_id = ?", userOption.ID)
+	if resp.RowsAffected == 0 {
+		user.UserID = userOption.ID
+	}
 	user.IsBlacklisted = true
 	database.GetDB().Save(&user)
 
@@ -53,3 +86,22 @@ func (c BlacklistCommand) execute(session *discordgo.Session, event *discordgo.I
 		},
 	})
 }
+
+func BlacklistRemove(session *discordgo.Session, event *discordgo.InteractionCreate) {
+	userOption := event.ApplicationCommandData().Options[0].Options[0].UserValue(session)
+
+	var user models.User
+
+	resp := database.GetDB().Find(&user, "user_id = ?", userOption.ID)
+	if resp.RowsAffected == 0 {
+		user.UserID = userOption.ID
+	}
+	user.IsBlacklisted = true
+	database.GetDB().Save(&user)
+	session.InteractionRespond(event.Interaction, &discordgo.InteractionResponse{
+		Type: discordgo.InteractionResponseChannelMessageWithSource,
+		Data: &discordgo.InteractionResponseData{
+			Content: "User blacklisted successfully.",
+		},
+	})
+}

src/commands/bot.go

@@ -0,0 +1,109 @@
+package commands
+
+import (
+	"github.com/bwmarrin/discordgo"
+	"math/rand"
+	"os"
+	"sandwich-delivery/src/config"
+	"sandwich-delivery/src/models"
+)
+
+type BotCommand struct{}
+
+func (c BotCommand) getName() string {
+	return "bot"
+}
+
+func (c BotCommand) getCommandData() *discordgo.ApplicationCommand {
+	DMPermission := new(bool)
+	*DMPermission = false
+	return &discordgo.ApplicationCommand{Name: c.getName(),
+		Description: "Manage the bot.",
+		Options: []*discordgo.ApplicationCommandOption{
+			{
+				Name:        "shutdown",
+				Description: "Shutdown the bot.",
+				Type:        discordgo.ApplicationCommandOptionSubCommand,
+			},
+			{
+				Name:        "purgecmds",
+				Description: "Purges all commands and restarts.",
+				Type:        discordgo.ApplicationCommandOptionSubCommand,
+			},
+		},
+		DMPermission: DMPermission,
+	}
+}
+
+func (c BotCommand) registerGuild() string {
+	return config.GetConfig().GuildID
+}
+
+func (c BotCommand) permissionLevel() models.UserPermissionLevel {
+	return models.PermissionLevelAdmin
+}
+
+func (c BotCommand) execute(session *discordgo.Session, event *discordgo.InteractionCreate) {
+	switch event.ApplicationCommandData().Options[0].Name {
+	case "shutdown":
+		BotShutdown(session, event)
+		break
+	case "purgecmds":
+		BotPurgeCMDS(session, event)
+		break
+	}
+}
+func BotShutdown(session *discordgo.Session, event *discordgo.InteractionCreate) {
+	var shutdownMessages = []string{
+		"Was it something I did? :( *(Shutting Down)*",
+		"Whatever you say... *(Shutting Down)*",
+		"Whatever. *(Shutting Down)*",
+		"Rude. *(Shutting Down)*",
+		"Fine... I guess... :( *(Shutting Down)*",
+	}
+
+	selection := rand.Intn(len(shutdownMessages))
+
+	session.InteractionRespond(event.Interaction, &discordgo.InteractionResponse{
+		Type: discordgo.InteractionResponseChannelMessageWithSource,
+		Data: &discordgo.InteractionResponseData{
+			Content: shutdownMessages[selection],
+		},
+	})
+
+	session.Close()
+	os.Exit(0)
+}
+
+func BotPurgeCMDS(session *discordgo.Session, event *discordgo.InteractionCreate) {
+	session.InteractionRespond(event.Interaction, &discordgo.InteractionResponse{
+		Type: discordgo.InteractionResponseChannelMessageWithSource,
+		Data: &discordgo.InteractionResponseData{
+			Content: "Give me a minute...",
+		},
+	})
+
+	applicationCommands, err := session.ApplicationCommands(session.State.User.ID, "")
+	if err != nil {
+		return
+	}
+	for _, applicationCommand := range applicationCommands {
+		session.InteractionRespond(event.Interaction, &discordgo.InteractionResponse{
+			Type: discordgo.InteractionResponseDeferredChannelMessageWithSource,
+		})
+		session.ApplicationCommandDelete(session.State.User.ID, "", applicationCommand.ID)
+	}
+
+	if InteractionIsDM(event) {
+		applicationCommands, err := session.ApplicationCommands(session.State.User.ID, event.GuildID)
+		if err != nil {
+			return
+		}
+		for _, applicationCommand := range applicationCommands {
+			session.ApplicationCommandDelete(session.State.User.ID, event.GuildID, applicationCommand.ID)
+		}
+	}
+
+	session.Close()
+	os.Exit(0)
+}

src/commands/command.go

@@ -50,7 +50,7 @@ func InteractionIsDM(event *discordgo.InteractionCreate) bool {
 func DoesUserExist(userID string) bool {
 	var user models.User
 
-	resp := database.GetDB().First(&user, "user_id = ?", userID)
+	resp := database.GetDB().Find(&user, "user_id = ?", userID)
 
 	return resp.RowsAffected != 0
 }
@@ -62,7 +62,7 @@ func IsUserBlacklisted(userID string) bool {
 
 	var user models.User
 
-	resp := database.GetDB().First(&user, "user_id = ?", userID)
+	resp := database.GetDB().Find(&user, "user_id = ?", userID)
 
 	if resp.RowsAffected == 0 {
 		return false