public async Task SetParentZone(string zoneName, string parentZoneName)
        {
            Zone zone = await ZoneUtils.GetZoneAsync(zoneName);

            Zone parent = await ZoneUtils.GetZoneAsync(parentZoneName);

            if (await BotUtils.ReplyValidateZoneAsync(Context, zone) && await BotUtils.ReplyValidateZoneAsync(Context, parent))
            {
                if (zone.Id == parent.Id)
                {
                    await BotUtils.ReplyAsync_Error(Context, "A zone cannot be its own parent.");
                }
                else if (parent.ParentId == zone.Id)
                {
                    await BotUtils.ReplyAsync_Error(Context, "A zone cannot have its child as its parent.");
                }
                else if (zone.ParentId == parent.Id)
                {
                    await BotUtils.ReplyAsync_Warning(Context, string.Format("The parent zone of **{0}** is already **{1}**.",
                                                                             zone.FullName,
                                                                             parent.FullName));
                }
                else
                {
                    zone.ParentId = parent.Id;

                    await ZoneUtils.UpdateZoneAsync(zone);

                    await BotUtils.ReplyAsync_Success(Context, string.Format("Successfully set the parent zone of **{0}** to **{1}**.",
                                                                             zone.FullName,
                                                                             parent.FullName));
                }
            }
        }
        public async Task SetZonePic(string zone, string imageUrl)
        {
            // Make sure that the given zone exists.

            Zone z = await ZoneUtils.GetZoneAsync(zone);

            if (!await BotUtils.ReplyValidateZoneAsync(Context, z))
            {
                return;
            }

            // Make sure the image URL is valid.

            if (!await BotUtils.ReplyIsImageUrlValidAsync(Context, imageUrl))
            {
                return;
            }

            // Update the zone.

            using (SQLiteCommand cmd = new SQLiteCommand("UPDATE Zones SET pics=$pics WHERE id=$id;")) {
                cmd.Parameters.AddWithValue("$pics", imageUrl);
                cmd.Parameters.AddWithValue("$id", z.Id);

                await Database.ExecuteNonQuery(cmd);
            }

            await BotUtils.ReplyAsync_Success(Context, string.Format("Successfully updated the picture for **{0}**.", z.GetFullName()));
        }
        public async Task AddZone(string name, string type = "", string description = "")
        {
            if (string.IsNullOrEmpty(name))
            {
                await BotUtils.ReplyAsync_Error(Context, "Zone name cannot be empty.");
            }
            else
            {
                // Allow the user to specify zones with numbers (e.g., "1") or single letters (e.g., "A").
                // Otherwise, the name is taken as-is.
                name = ZoneUtils.FormatZoneName(name).ToLower();

                // If an invalid type was provided, assume the user meant it as a description instead.
                // i.e., "addzone <name> <description>"

                ZoneType zone_type = await ZoneUtils.GetZoneTypeAsync(type);

                if (zone_type is null || zone_type.Id == ZoneType.NullZoneTypeId)
                {
                    description = type;

                    // Attempt to determine the zone type automatically if one wasn't provided.
                    // Currently, this is only possible if users are using the default zone types (i.e. "aquatic" and "terrestrial").

                    zone_type = await ZoneUtils.GetDefaultZoneTypeAsync(name);
                }

                if (await ZoneUtils.GetZoneAsync(name) != null)
                {
                    // Don't attempt to create the zone if it already exists.

                    await BotUtils.ReplyAsync_Warning(Context, string.Format("A zone named \"{0}\" already exists.", ZoneUtils.FormatZoneName(name)));
                }
                else
                {
                    await ZoneUtils.AddZoneAsync(new Zone {
                        Name        = name,
                        Description = description,
                        ZoneTypeId  = zone_type.Id
                    });

                    await BotUtils.ReplyAsync_Success(Context, string.Format("Successfully created new {0} zone, **{1}**.",
                                                                             zone_type.Name.ToLower(),
                                                                             ZoneUtils.FormatZoneName(name)));
                }
            }
        }
        public async Task SetZoneType(string zoneName, string zoneType)
        {
            Zone zone = await ZoneUtils.GetZoneAsync(zoneName);

            ZoneType type = await ZoneUtils.GetZoneTypeAsync(zoneType);

            if (await BotUtils.ReplyValidateZoneAsync(Context, zone) && await BotUtils.ReplyValidateZoneTypeAsync(Context, type))
            {
                zone.ZoneTypeId = type.Id;

                await ZoneUtils.UpdateZoneAsync(zone);

                await BotUtils.ReplyAsync_Success(Context, string.Format("Successfully set the type of {0}**{1}** to **{2}**.",
                                                                         zone.FullName.StartsWith("Zone") ? string.Empty : "zone ",
                                                                         zone.FullName,
                                                                         type.Name));
            }
        }
        public async Task GetZoneType(string arg0)
        {
            // If the given argument is a zone type, display information for that type.
            // If the given argument is a zone name, display information for the type corresponding to that zone.

            ZoneType type = await ZoneUtils.GetZoneTypeAsync(arg0);

            if (!ZoneUtils.ZoneTypeIsValid(type))
            {
                // If no zone type exists with this name, attempt to get the type of the zone with this name.

                Zone zone = await ZoneUtils.GetZoneAsync(arg0);

                if (zone != null)
                {
                    type = await ZoneUtils.GetZoneTypeAsync(zone.ZoneTypeId);
                }
            }

            if (ZoneUtils.ZoneTypeIsValid(type))
            {
                // We got a valid zone type, so show information about the zone type.

                Zone[] zones = await ZoneUtils.GetZonesAsync(type);

                Bot.PaginatedMessageBuilder embed = new Bot.PaginatedMessageBuilder {
                    Title       = string.Format("{0} {1} Zones ({2})", type.Icon, type.Name, zones.Count()),
                    Description = type.Description + "\n\n",
                    Color       = Bot.DiscordUtils.ConvertColor(type.Color)
                };

                await BotUtils.ZonesToEmbedPagesAsync(embed, zones, showIcon : false);

                embed.AddPageNumbers();

                await Bot.DiscordUtils.SendMessageAsync(Context, embed.Build());
            }
            else
            {
                await BotUtils.ReplyAsync_Error(Context, "No such zone type exists.");
            }
        }
        public async Task SetZoneDescription(string zoneName, string description)
        {
            // Get the zone from the database.

            Zone zone = await ZoneUtils.GetZoneAsync(zoneName);

            if (!await BotUtils.ReplyValidateZoneAsync(Context, zone))
            {
                return;
            }

            // Update the description for the zone.

            using (SQLiteCommand cmd = new SQLiteCommand("UPDATE Zones SET description=$description WHERE id=$id;")) {
                cmd.Parameters.AddWithValue("$description", description);
                cmd.Parameters.AddWithValue("$id", zone.Id);

                await Database.ExecuteNonQuery(cmd);
            }

            await BotUtils.ReplyAsync_Success(Context, string.Format("Successfully updated the description for **{0}**.", zone.GetFullName()));
        }
        public async Task Zone(string arg0 = "")
        {
            ZoneType zone_type = await ZoneUtils.GetZoneTypeAsync(arg0);

            if (string.IsNullOrEmpty(arg0) || ZoneUtils.ZoneTypeIsValid(zone_type))
            {
                // Display all zones, or, if the user passed in a valid zone type, all zones of that type.

                Zone[] zones = await ZoneUtils.GetZonesAsync(zone_type);

                if (zones.Count() > 0)
                {
                    // We need to make sure that even if the "short" description is actually long, we can show n zones per page.

                    Bot.PaginatedMessageBuilder embed = new Bot.PaginatedMessageBuilder {
                        Title       = StringUtils.ToTitleCase(string.Format("{0} zones ({1})", string.IsNullOrEmpty(arg0) ? "All" : arg0, zones.Count())),
                        Description = string.Format("For detailed zone information, use `{0}zone <zone>` (e.g. `{0}zone {1}`).\n\n",
                                                    OurFoodChainBot.Instance.Config.Prefix,
                                                    zones[0].ShortName.Contains(" ") ? string.Format("\"{0}\"", zones[0].ShortName.ToLower()) : zones[0].ShortName.ToLower())
                    };

                    // Build paginated message.

                    await BotUtils.ZonesToEmbedPagesAsync(embed, zones);

                    embed.AddPageNumbers();

                    if (ZoneUtils.ZoneTypeIsValid(zone_type))
                    {
                        embed.SetColor(Bot.DiscordUtils.ConvertColor(zone_type.Color));
                    }

                    await Bot.DiscordUtils.SendMessageAsync(Context, embed.Build());
                }
                else
                {
                    await BotUtils.ReplyAsync_Info(Context, "No zones have been added yet.");
                }

                return;
            }
            else
            {
                Zone zone = await ZoneUtils.GetZoneAsync(arg0);

                if (await BotUtils.ReplyValidateZoneAsync(Context, zone))
                {
                    List <Embed> pages = new List <Embed>();

                    ZoneType type = await ZoneUtils.GetZoneTypeAsync(zone.ZoneTypeId) ?? new ZoneType();

                    string title       = string.Format("{0} {1}", type.Icon, zone.FullName);
                    string description = zone.GetDescriptionOrDefault();
                    Color  color       = Bot.DiscordUtils.ConvertColor(type.Color);

                    // Get all species living in this zone.

                    List <Species> species_list = new List <Species>(await BotUtils.GetSpeciesFromDbByZone(zone));

                    species_list.Sort((lhs, rhs) => lhs.ShortName.CompareTo(rhs.ShortName));

                    // Starting building a paginated message.
                    // The message will have a paginated species list, and a toggle button to display the species sorted by role.

                    List <EmbedBuilder>         embed_pages = EmbedUtils.SpeciesListToEmbedPages(species_list, fieldName: (string.Format("Extant species in this zone ({0}):", species_list.Count())));
                    Bot.PaginatedMessageBuilder paginated   = new Bot.PaginatedMessageBuilder(embed_pages);

                    if (embed_pages.Count() <= 0)
                    {
                        embed_pages.Add(new EmbedBuilder());
                    }

                    // Add title, decription, etc., to all pages.

                    paginated.SetTitle(title);
                    paginated.SetDescription(description);
                    paginated.SetThumbnailUrl(zone.Pics);
                    paginated.SetColor(color);

                    // This page will have species organized by role.
                    // Only bother with the role page if species actually exist in this zone.

                    if (species_list.Count() > 0)
                    {
                        EmbedBuilder role_page = new EmbedBuilder();

                        role_page.WithTitle(title);
                        role_page.WithDescription(description);
                        //role_page.WithThumbnailUrl(zone.pics);
                        role_page.WithColor(color);

                        Dictionary <string, List <Species> > roles_map = new Dictionary <string, List <Species> >();

                        foreach (Species sp in species_list)
                        {
                            Role[] roles_list = await SpeciesUtils.GetRolesAsync(sp);

                            if (roles_list.Count() <= 0)
                            {
                                if (!roles_map.ContainsKey("no role"))
                                {
                                    roles_map["no role"] = new List <Species>();
                                }

                                roles_map["no role"].Add(sp);

                                continue;
                            }

                            foreach (Role role in roles_list)
                            {
                                if (!roles_map.ContainsKey(role.name))
                                {
                                    roles_map[role.name] = new List <Species>();
                                }

                                roles_map[role.name].Add(sp);
                            }
                        }

                        // Sort the list of species belonging to each role.

                        foreach (List <Species> i in roles_map.Values)
                        {
                            i.Sort((lhs, rhs) => lhs.ShortName.CompareTo(rhs.ShortName));
                        }

                        // Create a sorted list of keys so that the roles are in order.

                        List <string> sorted_keys = new List <string>(roles_map.Keys);
                        sorted_keys.Sort();

                        foreach (string i in sorted_keys)
                        {
                            StringBuilder lines = new StringBuilder();

                            foreach (Species j in roles_map[i])
                            {
                                lines.AppendLine(j.ShortName);
                            }

                            role_page.AddField(string.Format("{0}s ({1})", StringUtils.ToTitleCase(i), roles_map[i].Count()), lines.ToString(), inline: true);
                        }

                        // Add the page to the builder.

                        paginated.AddReaction("🇷");
                        paginated.SetCallback(async(args) => {
                            if (args.Reaction != "🇷")
                            {
                                return;
                            }

                            args.PaginatedMessage.PaginationEnabled = !args.ReactionAdded;

                            if (args.ReactionAdded)
                            {
                                await args.DiscordMessage.ModifyAsync(msg => msg.Embed = role_page.Build());
                            }
                            else
                            {
                                await args.DiscordMessage.ModifyAsync(msg => msg.Embed = args.PaginatedMessage.Pages[args.PaginatedMessage.PageIndex]);
                            }
                        });
                    }

                    await Bot.DiscordUtils.SendMessageAsync(Context, paginated.Build());
                }
            }
        }