Skip to content

Settings

Bases: GroupCog

Represents the settings commands for the discord bot.

Source code in src\cogs\settings.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
class Settings(commands.GroupCog, name="setting"):
    """
    Represents the settings commands for the discord bot.
    """

    def __init__(self, bot: commands.Bot) -> None:
        """
        Creates an instance of the Settings class.

        Args:
            bot (discord.ext.commands.Bot): The bot that the cog is being
                                            added to.
        """
        self.bot = bot
        self.history_size: int = 4
        self.history: list[dict] = []

    def reset_history(self) -> None:
        """
        Checks if the history should be reset.
        """
        if len(self.history) > self.history_size:
            self.history = []

    @app_commands.command(
        name="list_all",
        description="Displays all the current settings for the bot."
    )
    @app_commands.checks.has_permissions(administrator=True)
    async def list_all(self, interaction: discord.Interaction) -> None:
        """
        Lists all the settings for the discord bot.

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
        """
        try:
            config = Config()
            config_items = config.config_data.items()
            bot_name = self.bot.user
            tab = " -----> "
            protected = [
                "token",
                "bot_token",
                "bot_key",
                "api",
                "api_token",
                "api_key",
                "key",
                "password",
                "passkey",
                "pass"
            ]
            embed = discord.Embed(
                title=f"{bot_name} Settings:",
                color=discord.Color.red()
            )

            for keys, values in config_items:
                keys = str(keys)
                values = str(values)
                if keys.strip() in protected:
                    embed.add_field(name=keys + tab + "*\*\*\*\*", value="",
                                    inline=False)
                else:
                    embed.add_field(name=keys + tab + values, value="",
                                    inline=False)

            await interaction.response.send_message(embed=embed)
        except Exception as e:
            nasa_bot_logger.exception(e)


    @app_commands.command(
        name="set",
        description="Set the state of a setting."
    )
    @app_commands.checks.has_permissions(administrator=True)
    async def set(self,
                  interaction: discord.Interaction,
                  setting: str,
                  new_value: str) -> None:
        """
        Sets a setting in the discord bot configuration file.

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
            setting (str): The setting that is being changed.
            new_value (str): The new value for the setting.
        """
        try:
            config = Config()
            setting = str(setting).strip()
            new_value = str(new_value).strip()
            previous_value = config.get_unique_item(setting)
            self.reset_history()
            self.history.append({setting: [previous_value, new_value]})
            config.update_unique_item(setting, new_value)
            embed = discord.Embed(
                title="Settings changed:",
                color=discord.Color.red(),
                timestamp=datetime.datetime.now()
            )
            embed.add_field(name="Old Settings",
                            value=f"{setting}: {previous_value}",
                            inline=False)
            embed.add_field(name="New Setting",
                            value=f"{setting}: {new_value}",
                            inline=False)

            await interaction.response.send_message(embed=embed)
        except AttributeError:
            await interaction.response.send_message("The setting selected "
                                                    "does not exist.")
            nasa_bot_logger.info("A non existent setting was attempted to be "
                                 "changed.")
        except Exception as e:
            nasa_bot_logger.exception(e)

    @app_commands.command(
        name="unset",
        description="Sets a setting to the state of \"unset\"."
    )
    @app_commands.checks.has_permissions(administrator=True)
    async def unset(self,
                    interaction: discord.Interaction,
                    setting: str) -> None:
        """
        Sets a value in the discord bot configuration to a value of "unset".

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
            setting (str): The setting to "unset".
        """
        try:
            config = Config()
            setting = str(setting).strip()
            previous_value = config.get_unique_item(setting)
            self.reset_history()
            self.history.append({setting: [previous_value, "unset"]})
            config.update_unique_item(setting, "unset")
            embed = discord.Embed(
                title="Settings changed:",
                color=discord.Color.red(),
                timestamp=datetime.datetime.now()
            )
            embed.add_field(name="Old Settings",
                            value=f"{setting}: {previous_value}",
                            inline=False)
            embed.add_field(name="New Setting",
                            value=f"{setting}: unset",
                            inline=False)

            await interaction.response.send_message(embed=embed)
        except AttributeError:
            await interaction.response.send_message("The setting selected "
                                                    "does not exist.")
            nasa_bot_logger.info("A non existent setting was attempted to be "
                                 "unset.")
        except Exception as e:
            nasa_bot_logger.exception(e)

    @app_commands.command(
        name="view_history",
        description="Displays the history for the past 5 changes that have "
                    "been made to the settings."
    )
    @app_commands.checks.has_permissions(administrator=True)
    async def view_history(self, interaction: discord.Interaction) -> None:
        """
        List the history of changes to the bot settings.

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
        """
        setting_index = 0
        max_history_length = 6
        embed = discord.Embed(
            title="Recent Changes:",
            color=discord.Color.red(),
            description="Changes can be reverted with: /settings restore #",
            timestamp=datetime.datetime.now()
        )
        for setting in self.history:
            if setting_index < max_history_length:
                for key, value in setting.items():
                    embed.add_field(name=f"{setting_index}. {key}",
                                    value=f"Old Value: {value[0]} ----> New "
                                          f"Value: {value[1]}",
                                    inline=False)
                    setting_index += 1
        try:
            await interaction.response.send_message(embed=embed)
        except Exception as e:
            nasa_bot_logger.exception(e)

    @app_commands.command(
        name="restore",
        description="Allows for a previous setting to be restored. Can only "
                    "be done on the past 5 commands executed"
    )
    @app_commands.checks.has_permissions(administrator=True)
    async def restore(self,
                      interaction: discord.Interaction,
                      change: int) -> None:
        """
        Restores a past setting change to the previous state.

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
            change (int): The number of the change that is to be reverted.
        """
        try:
            config = Config()
            change = self.history[change]
            for key, value in change.items():
                config.update_unique_item(key, value[0])

            self.history.remove(change)
            await interaction.response.send_message(f"Change #{change} "
                                                    f"has be reset.")
        except IndexError:
            await interaction.response.send_message("The change selected does "
                                                    "not exist.")
        except Exception as e:
            nasa_bot_logger.exception(e)

__init__(bot)

Creates an instance of the Settings class.

Parameters:

Name Type Description Default
bot Bot

The bot that the cog is being added to.

 required
Source code in src\cogs\settings.py 
16
17
18
19
20
21
22
23
24
25
26
def __init__(self, bot: commands.Bot) -> None:
    """
    Creates an instance of the Settings class.

    Args:
        bot (discord.ext.commands.Bot): The bot that the cog is being
                                        added to.
    """
    self.bot = bot
    self.history_size: int = 4
    self.history: list[dict] = []

list_all(interaction) async

Lists all the settings for the discord bot.

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
Source code in src\cogs\settings.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@app_commands.command(
    name="list_all",
    description="Displays all the current settings for the bot."
)
@app_commands.checks.has_permissions(administrator=True)
async def list_all(self, interaction: discord.Interaction) -> None:
    """
    Lists all the settings for the discord bot.

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
    """
    try:
        config = Config()
        config_items = config.config_data.items()
        bot_name = self.bot.user
        tab = " -----> "
        protected = [
            "token",
            "bot_token",
            "bot_key",
            "api",
            "api_token",
            "api_key",
            "key",
            "password",
            "passkey",
            "pass"
        ]
        embed = discord.Embed(
            title=f"{bot_name} Settings:",
            color=discord.Color.red()
        )

        for keys, values in config_items:
            keys = str(keys)
            values = str(values)
            if keys.strip() in protected:
                embed.add_field(name=keys + tab + "*\*\*\*\*", value="",
                                inline=False)
            else:
                embed.add_field(name=keys + tab + values, value="",
                                inline=False)

        await interaction.response.send_message(embed=embed)
    except Exception as e:
        nasa_bot_logger.exception(e)

reset_history()

Checks if the history should be reset.

Source code in src\cogs\settings.py 
28
29
30
31
32
33
def reset_history(self) -> None:
    """
    Checks if the history should be reset.
    """
    if len(self.history) > self.history_size:
        self.history = []

restore(interaction, change) async

Restores a past setting change to the previous state.

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
change int

The number of the change that is to be reverted.

 required
Source code in src\cogs\settings.py 
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
@app_commands.command(
    name="restore",
    description="Allows for a previous setting to be restored. Can only "
                "be done on the past 5 commands executed"
)
@app_commands.checks.has_permissions(administrator=True)
async def restore(self,
                  interaction: discord.Interaction,
                  change: int) -> None:
    """
    Restores a past setting change to the previous state.

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
        change (int): The number of the change that is to be reverted.
    """
    try:
        config = Config()
        change = self.history[change]
        for key, value in change.items():
            config.update_unique_item(key, value[0])

        self.history.remove(change)
        await interaction.response.send_message(f"Change #{change} "
                                                f"has be reset.")
    except IndexError:
        await interaction.response.send_message("The change selected does "
                                                "not exist.")
    except Exception as e:
        nasa_bot_logger.exception(e)

set(interaction, setting, new_value) async

Sets a setting in the discord bot configuration file.

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
setting str

The setting that is being changed.

 required
new_value str

The new value for the setting.

 required
Source code in src\cogs\settings.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@app_commands.command(
    name="set",
    description="Set the state of a setting."
)
@app_commands.checks.has_permissions(administrator=True)
async def set(self,
              interaction: discord.Interaction,
              setting: str,
              new_value: str) -> None:
    """
    Sets a setting in the discord bot configuration file.

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
        setting (str): The setting that is being changed.
        new_value (str): The new value for the setting.
    """
    try:
        config = Config()
        setting = str(setting).strip()
        new_value = str(new_value).strip()
        previous_value = config.get_unique_item(setting)
        self.reset_history()
        self.history.append({setting: [previous_value, new_value]})
        config.update_unique_item(setting, new_value)
        embed = discord.Embed(
            title="Settings changed:",
            color=discord.Color.red(),
            timestamp=datetime.datetime.now()
        )
        embed.add_field(name="Old Settings",
                        value=f"{setting}: {previous_value}",
                        inline=False)
        embed.add_field(name="New Setting",
                        value=f"{setting}: {new_value}",
                        inline=False)

        await interaction.response.send_message(embed=embed)
    except AttributeError:
        await interaction.response.send_message("The setting selected "
                                                "does not exist.")
        nasa_bot_logger.info("A non existent setting was attempted to be "
                             "changed.")
    except Exception as e:
        nasa_bot_logger.exception(e)

unset(interaction, setting) async

Sets a value in the discord bot configuration to a value of "unset".

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
setting str

The setting to "unset".

 required
Source code in src\cogs\settings.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
@app_commands.command(
    name="unset",
    description="Sets a setting to the state of \"unset\"."
)
@app_commands.checks.has_permissions(administrator=True)
async def unset(self,
                interaction: discord.Interaction,
                setting: str) -> None:
    """
    Sets a value in the discord bot configuration to a value of "unset".

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
        setting (str): The setting to "unset".
    """
    try:
        config = Config()
        setting = str(setting).strip()
        previous_value = config.get_unique_item(setting)
        self.reset_history()
        self.history.append({setting: [previous_value, "unset"]})
        config.update_unique_item(setting, "unset")
        embed = discord.Embed(
            title="Settings changed:",
            color=discord.Color.red(),
            timestamp=datetime.datetime.now()
        )
        embed.add_field(name="Old Settings",
                        value=f"{setting}: {previous_value}",
                        inline=False)
        embed.add_field(name="New Setting",
                        value=f"{setting}: unset",
                        inline=False)

        await interaction.response.send_message(embed=embed)
    except AttributeError:
        await interaction.response.send_message("The setting selected "
                                                "does not exist.")
        nasa_bot_logger.info("A non existent setting was attempted to be "
                             "unset.")
    except Exception as e:
        nasa_bot_logger.exception(e)

view_history(interaction) async

List the history of changes to the bot settings.

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
Source code in src\cogs\settings.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
@app_commands.command(
    name="view_history",
    description="Displays the history for the past 5 changes that have "
                "been made to the settings."
)
@app_commands.checks.has_permissions(administrator=True)
async def view_history(self, interaction: discord.Interaction) -> None:
    """
    List the history of changes to the bot settings.

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
    """
    setting_index = 0
    max_history_length = 6
    embed = discord.Embed(
        title="Recent Changes:",
        color=discord.Color.red(),
        description="Changes can be reverted with: /settings restore #",
        timestamp=datetime.datetime.now()
    )
    for setting in self.history:
        if setting_index < max_history_length:
            for key, value in setting.items():
                embed.add_field(name=f"{setting_index}. {key}",
                                value=f"Old Value: {value[0]} ----> New "
                                      f"Value: {value[1]}",
                                inline=False)
                setting_index += 1
    try:
        await interaction.response.send_message(embed=embed)
    except Exception as e:
        nasa_bot_logger.exception(e)