Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-24 17:34:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more information to check command

Browse source 
Additionally, fix up null checks in affected files
This commit is contained in:
Noi 2021-10-24 18:15:46 -07:00
parent 16ac294fe3
commit 800bba2193
4 changed files with 38 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
BackgroundServices/BirthdayRoleUpdate.cs
View file

@ -72,7 +72,7 @@ class BirthdayRoleUpdate : BackgroundService {
// Birthday announcement
var announce = gc.AnnounceMessages;
var announceping = gc.AnnouncePing;
SocketTextChannel channel = null;
SocketTextChannel? channel = null;
if (gc.AnnounceChannelId.HasValue) channel = guild.GetTextChannel(gc.AnnounceChannelId.Value);
if (announcementList.Any()) {
await AnnounceBirthdaysAsync(announce, announceping, channel, announcementList).ConfigureAwait(false);
@ -83,21 +83,14 @@ class BirthdayRoleUpdate : BackgroundService {
/// Gets all known users from the given guild and returns a list including only those who are
/// currently experiencing a birthday in the respective time zone.
/// </summary>
private static HashSet<ulong> GetGuildCurrentBirthdays(IEnumerable<GuildUserConfiguration> guildUsers, string defaultTzStr) {
public static HashSet<ulong> GetGuildCurrentBirthdays(IEnumerable<GuildUserConfiguration> guildUsers, string? defaultTzStr) {
var tzdb = DateTimeZoneProviders.Tzdb;
DateTimeZone defaultTz = (defaultTzStr != null ? DateTimeZoneProviders.Tzdb.GetZoneOrNull(defaultTzStr) : null) ?? tzdb.GetZoneOrNull("UTC")!;
var birthdayUsers = new HashSet<ulong>();
DateTimeZone defaultTz = null;
if (defaultTzStr != null) defaultTz = DateTimeZoneProviders.Tzdb.GetZoneOrNull(defaultTzStr);
defaultTz ??= DateTimeZoneProviders.Tzdb.GetZoneOrNull("UTC");
foreach (var item in guildUsers) {
// Determine final time zone to use for calculation
DateTimeZone tz = null;
if (item.TimeZone != null) {
// Try user-provided time zone
tz = DateTimeZoneProviders.Tzdb.GetZoneOrNull(item.TimeZone);
}
tz ??= defaultTz;
DateTimeZone tz = (item.TimeZone != null ? tzdb.GetZoneOrNull(item.TimeZone) : null) ?? defaultTz;
var targetMonth = item.BirthMonth;
var targetDay = item.BirthDay;
@ -112,7 +105,6 @@ class BirthdayRoleUpdate : BackgroundService {
birthdayUsers.Add(item.UserId);
}
}
return birthdayUsers;
}
@ -155,13 +147,12 @@ class BirthdayRoleUpdate : BackgroundService {
public const string DefaultAnnouncePl = "Please wish a happy birthday to our esteemed members: %n";
/// <summary>
/// Makes (or attempts to make) an announcement in the specified channel that includes all users
/// who have just had their birthday role added.
/// Attempts to send an announcement message.
/// </summary>
/// <returns>The message to place into operation status log.</returns>
private static async Task<string> AnnounceBirthdaysAsync(
(string, string) announce, bool announcePing, SocketTextChannel c, IEnumerable<SocketGuildUser> names) {
if (c == null) return "Announcement channel is not configured, or has gone missing.";
private static async Task AnnounceBirthdaysAsync(
(string?, string?) announce, bool announcePing, SocketTextChannel? c, IEnumerable<SocketGuildUser> names) {
if (c == null) return;
if (!c.Guild.CurrentUser.GetPermissions(c).SendMessages) return;
string announceMsg;
if (names.Count() == 1) announceMsg = announce.Item1 ?? announce.Item2 ?? DefaultAnnounce;
@ -182,12 +173,6 @@ class BirthdayRoleUpdate : BackgroundService {
}
namedisplay.Remove(0, 2); // Remove initial comma and space
try {
await c.SendMessageAsync(announceMsg.Replace("%n", namedisplay.ToString())).ConfigureAwait(false);
return null;
} catch (Discord.Net.HttpException ex) {
// Directly use the resulting exception message in the operation status log
return ex.Message;
}
}
}

2
BirthdayBot.csproj
View file

@ -3,7 +3,7 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework>
<Version>3.2.0</Version>
<Version>3.2.1</Version>
<PackageId>BirthdayBot</PackageId>
<Authors>NoiTheCat</Authors>
<Description>Discord bot for birthday recognition and reminders.</Description>

14
Data/GuildConfiguration.cs
View file

@ -34,7 +34,7 @@ class GuildConfiguration {
/// Gets or sets the guild's default time zone ztring.
/// Updating this value requires a call to <see cref="UpdateAsync"/>.
/// </summary>
public string TimeZone { get; set; }
public string? TimeZone { get; set; }
/// <summary>
/// Gets or sets the guild's moderated mode setting.
@ -52,7 +52,7 @@ class GuildConfiguration {
/// Gets or sets the guild-specific birthday announcement message.
/// Updating this value requires a call to <see cref="UpdateAsync"/>.
/// </summary>
public (string, string) AnnounceMessages { get; set; }
public (string?, string?) AnnounceMessages { get; set; }
/// <summary>
/// Gets or sets the announcement ping setting.
@ -68,8 +68,8 @@ class GuildConfiguration {
TimeZone = reader.IsDBNull(3) ? null : reader.GetString(3);
IsModerated = reader.GetBoolean(4);
if (!reader.IsDBNull(5)) ModeratorRole = (ulong)reader.GetInt64(5);
string announceMsg = reader.IsDBNull(6) ? null : reader.GetString(6);
string announceMsgPl = reader.IsDBNull(7) ? null : reader.GetString(7);
string? announceMsg = reader.IsDBNull(6) ? null : reader.GetString(6);
string? announceMsgPl = reader.IsDBNull(7) ? null : reader.GetString(7);
AnnounceMessages = (announceMsg, announceMsgPl);
AnnouncePing = reader.GetBoolean(8);
}
@ -169,7 +169,7 @@ class GuildConfiguration {
/// If true, this method shall not create a new entry and will return null if the guild does
/// not exist in the database.
/// </param>
public static async Task<GuildConfiguration> LoadAsync(ulong guildId, bool nullIfUnknown) {
public static async Task<GuildConfiguration?> LoadAsync(ulong guildId, bool nullIfUnknown) {
using (var db = await Database.OpenConnectionAsync().ConfigureAwait(false)) {
using (var c = db.CreateCommand()) {
// Take note of ordinals for the constructor
@ -242,8 +242,8 @@ class GuildConfiguration {
c.Parameters.Add("@AnnouncePing", NpgsqlDbType.Boolean).Value = AnnouncePing;
c.Prepare();
c.ExecuteNonQuery();
await c.PrepareAsync().ConfigureAwait(false);
await c.ExecuteNonQueryAsync().ConfigureAwait(false);
}
#endregion
}

27
UserInterface/ManagerCommands.cs
View file

@ -391,15 +391,23 @@ internal class ManagerCommands : CommandsCommon {
var result = new StringBuilder();
var guild = reqChannel.Guild;
var conf = await GuildConfiguration.LoadAsync(guild.Id, true).ConfigureAwait(false);
result.AppendLine($"Server ID: {guild.Id} | Bot shard ID: {instance.ShardId:00}");
result.AppendLine();
result.AppendLine(DoTestFor("Bot has obtained the user list", () => Common.HasMostMembersDownloaded(guild)));
result.AppendLine(DoTestFor("Server configuration exists", delegate {
if (conf == null) return false;
result.AppendLine($"Server ID: {guild.Id} | Bot shard ID: {instance.ShardId:00}");
bool hasMembers = Common.HasMostMembersDownloaded(guild);
result.Append(DoTestFor("Bot has obtained the user list", () => hasMembers));
result.AppendLine($" - Has {guild.DownloadedMemberCount} of {guild.MemberCount} members.");
int bdayCount = -1;
result.Append(DoTestFor("Check if users have a birthday today", delegate {
if (!hasMembers) return false;
var gc = GuildConfiguration.LoadAsync(guild.Id, true).ConfigureAwait(false).GetAwaiter().GetResult();
var users = GuildUserConfiguration.LoadAllAsync(guild.Id).ConfigureAwait(false).GetAwaiter().GetResult();
bdayCount = BackgroundServices.BirthdayRoleUpdate.GetGuildCurrentBirthdays(users, gc?.TimeZone).Count;
return true;
}));
if (hasMembers) result.AppendLine($" - {bdayCount} user(s) currently having a birthday.");
else result.AppendLine(" - Cannot check without user list.");
result.AppendLine();
result.AppendLine(DoTestFor("Birthday role set with `bb.config role`", delegate {
if (conf == null) return false;
SocketRole? role = guild.GetRole(conf.RoleId ?? 0);
@ -412,14 +420,15 @@ internal class ManagerCommands : CommandsCommon {
return guild.CurrentUser.GuildPermissions.ManageRoles && role.Position < guild.CurrentUser.Hierarchy;
}));
result.AppendLine();
SocketTextChannel? channel = null;
result.AppendLine(DoTestFor("(Optional) Announcement channel set with `bb.config channel`", delegate {
if (conf == null) return false;
SocketTextChannel? channel = guild.GetTextChannel(conf.AnnounceChannelId ?? 0);
channel = guild.GetTextChannel(conf.AnnounceChannelId ?? 0);
return channel != null;
}));
result.AppendLine(DoTestFor("(Optional) Bot can send messages into announcement channel", delegate {
if (conf == null) return false;
SocketTextChannel? channel = guild.GetTextChannel(conf.AnnounceChannelId ?? 0);
string disp = channel == null ? "announcement channel" : $"<#{channel.Id}>";
result.AppendLine(DoTestFor($"(Optional) Bot can send messages into { disp }", delegate {
if (channel == null) return false;
return guild.CurrentUser.GetPermissions(channel).SendMessages;
}));