ModLogEntry: Add composite foreign key reference

Data/BotDatabaseContext.cs

@@ -54,6 +54,11 @@ public class BotDatabaseContext : DbContext {
         });
         modelBuilder.Entity<CachedGuildMessage>(e => e.Property(p => p.CreatedAt).HasDefaultValueSql("now()"));
         modelBuilder.HasPostgresEnum<ModLogType>();
-        modelBuilder.Entity<ModLogEntry>(e => e.Property(p => p.Timestamp).HasDefaultValueSql("now()"));
+        modelBuilder.Entity<ModLogEntry>(e => {
+            e.Property(p => p.Timestamp).HasDefaultValueSql("now()");
+            e.HasOne(entry => entry.User)
+                .WithMany(gu => gu.Logs)
+                .HasForeignKey(entry => new {entry.GuildId, entry.UserId});
+        });
     }
 }

Data/CachedGuildMessage.cs

@@ -53,12 +53,11 @@ public class CachedGuildMessage {
     /// </summary>
     public string? Content { get; set; } = null!;
 
-    /// <summary>
+    /// <inheritdoc cref="CachedGuildUser.User" />
-    /// If included in the query, references the associated <seealso cref="CachedUser"/> for this entry.
-    /// </summary>
     [ForeignKey(nameof(AuthorId))]
     [InverseProperty(nameof(CachedUser.GuildMessages))]
     public CachedUser Author { get; set; } = null!;
+    // TODO set up composite foreign key. will require rewriting some parts in modules...
 
     // Used by MessageCachingSubservice
     internal static CachedGuildMessage? Clone(CachedGuildMessage? original) {

Data/CachedGuildUser.cs

@@ -33,4 +33,9 @@ public class CachedGuildUser {
     [ForeignKey(nameof(UserId))]
     [InverseProperty(nameof(CachedUser.Guilds))]
     public CachedUser User { get; set; } = null!;
+
+    /// <summary>
+    /// If included in the query, references all <seealso cref="ModLogEntry"/> items associated with this entry.
+    /// </summary>
+    public ICollection<ModLogEntry> Logs { get; set; } = null!;
 }

Data/CachedUser.cs

@@ -8,7 +8,7 @@ namespace RegexBot.Data;
 [Table("cache_users")]
 public class CachedUser {
     /// <summary>
-    /// Gets the user's snowflake ID.
+    /// Gets the associated user's snowflake ID.
     /// </summary>
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.None)]

Data/Migrations/20220824023321_AddModLogs.Designer.cs

@@ -0,0 +1,232 @@
+// <auto-generated />
+using System;
+using System.Collections.Generic;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
+using RegexBot.Data;
+
+#nullable disable
+
+namespace RegexBot.Data.Migrations
+{
+    [DbContext(typeof(BotDatabaseContext))]
+    [Migration("20220824023321_AddModLogs")]
+    partial class AddModLogs
+    {
+        protected override void BuildTargetModel(ModelBuilder modelBuilder)
+        {
+#pragma warning disable 612, 618
+            modelBuilder
+                .HasAnnotation("ProductVersion", "6.0.7")
+                .HasAnnotation("Relational:MaxIdentifierLength", 63);
+
+            NpgsqlModelBuilderExtensions.HasPostgresEnum(modelBuilder, "mod_log_type", new[] { "other", "note", "warn", "timeout", "kick", "ban" });
+            NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
+                {
+                    b.Property<long>("MessageId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("message_id");
+
+                    b.Property<List<string>>("AttachmentNames")
+                        .IsRequired()
+                        .HasColumnType("text[]")
+                        .HasColumnName("attachment_names");
+
+                    b.Property<long>("AuthorId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("author_id");
+
+                    b.Property<long>("ChannelId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("channel_id");
+
+                    b.Property<string>("Content")
+                        .HasColumnType("text")
+                        .HasColumnName("content");
+
+                    b.Property<DateTimeOffset>("CreatedAt")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("created_at")
+                        .HasDefaultValueSql("now()");
+
+                    b.Property<DateTimeOffset?>("EditedAt")
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("edited_at");
+
+                    b.Property<long>("GuildId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("guild_id");
+
+                    b.HasKey("MessageId")
+                        .HasName("pk_cache_guildmessages");
+
+                    b.HasIndex("AuthorId")
+                        .HasDatabaseName("ix_cache_guildmessages_author_id");
+
+                    b.ToTable("cache_guildmessages", (string)null);
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
+                {
+                    b.Property<long>("UserId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("user_id");
+
+                    b.Property<long>("GuildId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("guild_id");
+
+                    b.Property<DateTimeOffset>("FirstSeenTime")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("first_seen_time")
+                        .HasDefaultValueSql("now()");
+
+                    b.Property<DateTimeOffset>("GULastUpdateTime")
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("gu_last_update_time");
+
+                    b.Property<string>("Nickname")
+                        .HasColumnType("text")
+                        .HasColumnName("nickname");
+
+                    b.HasKey("UserId", "GuildId")
+                        .HasName("pk_cache_usersinguild");
+
+                    b.ToTable("cache_usersinguild", (string)null);
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedUser", b =>
+                {
+                    b.Property<long>("UserId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("user_id");
+
+                    b.Property<string>("AvatarUrl")
+                        .HasColumnType("text")
+                        .HasColumnName("avatar_url");
+
+                    b.Property<string>("Discriminator")
+                        .IsRequired()
+                        .HasMaxLength(4)
+                        .HasColumnType("character(4)")
+                        .HasColumnName("discriminator")
+                        .IsFixedLength();
+
+                    b.Property<DateTimeOffset>("ULastUpdateTime")
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("u_last_update_time");
+
+                    b.Property<string>("Username")
+                        .IsRequired()
+                        .HasColumnType("text")
+                        .HasColumnName("username");
+
+                    b.HasKey("UserId")
+                        .HasName("pk_cache_users");
+
+                    b.ToTable("cache_users", (string)null);
+                });
+
+            modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
+                {
+                    b.Property<int>("LogId")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("integer")
+                        .HasColumnName("log_id");
+
+                    NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("LogId"));
+
+                    b.Property<long>("GuildId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("guild_id");
+
+                    b.Property<string>("IssuedBy")
+                        .IsRequired()
+                        .HasColumnType("text")
+                        .HasColumnName("issued_by");
+
+                    b.Property<int>("LogType")
+                        .HasColumnType("integer")
+                        .HasColumnName("log_type");
+
+                    b.Property<string>("Message")
+                        .HasColumnType("text")
+                        .HasColumnName("message");
+
+                    b.Property<DateTimeOffset>("Timestamp")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("timestamp")
+                        .HasDefaultValueSql("now()");
+
+                    b.Property<long>("UserId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("user_id");
+
+                    b.HasKey("LogId")
+                        .HasName("pk_modlogs");
+
+                    b.HasIndex("GuildId", "UserId")
+                        .HasDatabaseName("ix_modlogs_guild_id_user_id");
+
+                    b.ToTable("modlogs", (string)null);
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
+                {
+                    b.HasOne("RegexBot.Data.CachedUser", "Author")
+                        .WithMany("GuildMessages")
+                        .HasForeignKey("AuthorId")
+                        .OnDelete(DeleteBehavior.Cascade)
+                        .IsRequired()
+                        .HasConstraintName("fk_cache_guildmessages_cache_users_author_id");
+
+                    b.Navigation("Author");
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
+                {
+                    b.HasOne("RegexBot.Data.CachedUser", "User")
+                        .WithMany("Guilds")
+                        .HasForeignKey("UserId")
+                        .OnDelete(DeleteBehavior.Cascade)
+                        .IsRequired()
+                        .HasConstraintName("fk_cache_usersinguild_cache_users_user_id");
+
+                    b.Navigation("User");
+                });
+
+            modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
+                {
+                    b.HasOne("RegexBot.Data.CachedGuildUser", "User")
+                        .WithMany("Logs")
+                        .HasForeignKey("GuildId", "UserId")
+                        .OnDelete(DeleteBehavior.Cascade)
+                        .IsRequired()
+                        .HasConstraintName("fk_modlogs_cache_usersinguild_user_temp_id");
+
+                    b.Navigation("User");
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
+                {
+                    b.Navigation("Logs");
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedUser", b =>
+                {
+                    b.Navigation("GuildMessages");
+
+                    b.Navigation("Guilds");
+                });
+#pragma warning restore 612, 618
+        }
+    }
+}

Data/Migrations/20220824023321_AddModLogs.cs

@@ -0,0 +1,55 @@
+using System;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
+
+#nullable disable
+
+namespace RegexBot.Data.Migrations
+{
+    public partial class AddModLogs : Migration
+    {
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterDatabase()
+                .Annotation("Npgsql:Enum:mod_log_type", "other,note,warn,timeout,kick,ban");
+
+            migrationBuilder.CreateTable(
+                name: "modlogs",
+                columns: table => new
+                {
+                    log_id = table.Column<int>(type: "integer", nullable: false)
+                        .Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn),
+                    timestamp = table.Column<DateTimeOffset>(type: "timestamp with time zone", nullable: false, defaultValueSql: "now()"),
+                    guild_id = table.Column<long>(type: "bigint", nullable: false),
+                    user_id = table.Column<long>(type: "bigint", nullable: false),
+                    log_type = table.Column<int>(type: "integer", nullable: false),
+                    issued_by = table.Column<string>(type: "text", nullable: false),
+                    message = table.Column<string>(type: "text", nullable: true)
+                },
+                constraints: table =>
+                {
+                    table.PrimaryKey("pk_modlogs", x => x.log_id);
+                    table.ForeignKey(
+                        name: "fk_modlogs_cache_usersinguild_user_temp_id",
+                        columns: x => new { x.guild_id, x.user_id },
+                        principalTable: "cache_usersinguild",
+                        principalColumns: new[] { "user_id", "guild_id" },
+                        onDelete: ReferentialAction.Cascade);
+                });
+
+            migrationBuilder.CreateIndex(
+                name: "ix_modlogs_guild_id_user_id",
+                table: "modlogs",
+                columns: new[] { "guild_id", "user_id" });
+        }
+
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropTable(
+                name: "modlogs");
+
+            migrationBuilder.AlterDatabase()
+                .OldAnnotation("Npgsql:Enum:mod_log_type", "other,note,warn,timeout,kick,ban");
+        }
+    }
+}

Data/Migrations/BotDatabaseContextModelSnapshot.cs

@@ -21,6 +21,7 @@ namespace RegexBot.Data.Migrations
                 .HasAnnotation("ProductVersion", "6.0.7")
                 .HasAnnotation("Relational:MaxIdentifierLength", 63);
 
+            NpgsqlModelBuilderExtensions.HasPostgresEnum(modelBuilder, "mod_log_type", new[] { "other", "note", "warn", "timeout", "kick", "ban" });
             NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
 
             modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
@@ -131,6 +132,51 @@ namespace RegexBot.Data.Migrations
                     b.ToTable("cache_users", (string)null);
                 });
 
+            modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
+                {
+                    b.Property<int>("LogId")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("integer")
+                        .HasColumnName("log_id");
+
+                    NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("LogId"));
+
+                    b.Property<long>("GuildId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("guild_id");
+
+                    b.Property<string>("IssuedBy")
+                        .IsRequired()
+                        .HasColumnType("text")
+                        .HasColumnName("issued_by");
+
+                    b.Property<int>("LogType")
+                        .HasColumnType("integer")
+                        .HasColumnName("log_type");
+
+                    b.Property<string>("Message")
+                        .HasColumnType("text")
+                        .HasColumnName("message");
+
+                    b.Property<DateTimeOffset>("Timestamp")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("timestamp with time zone")
+                        .HasColumnName("timestamp")
+                        .HasDefaultValueSql("now()");
+
+                    b.Property<long>("UserId")
+                        .HasColumnType("bigint")
+                        .HasColumnName("user_id");
+
+                    b.HasKey("LogId")
+                        .HasName("pk_modlogs");
+
+                    b.HasIndex("GuildId", "UserId")
+                        .HasDatabaseName("ix_modlogs_guild_id_user_id");
+
+                    b.ToTable("modlogs", (string)null);
+                });
+
             modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
                 {
                     b.HasOne("RegexBot.Data.CachedUser", "Author")
@@ -155,6 +201,23 @@ namespace RegexBot.Data.Migrations
                     b.Navigation("User");
                 });
 
+            modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
+                {
+                    b.HasOne("RegexBot.Data.CachedGuildUser", "User")
+                        .WithMany("Logs")
+                        .HasForeignKey("GuildId", "UserId")
+                        .OnDelete(DeleteBehavior.Cascade)
+                        .IsRequired()
+                        .HasConstraintName("fk_modlogs_cache_usersinguild_user_temp_id");
+
+                    b.Navigation("User");
+                });
+
+            modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
+                {
+                    b.Navigation("Logs");
+                });
+
             modelBuilder.Entity("RegexBot.Data.CachedUser", b =>
                 {
                     b.Navigation("GuildMessages");

Data/ModLogEntry.cs

@@ -7,7 +7,7 @@ namespace RegexBot.Data;
 /// Represents a moderation log entry.
 /// </summary>
 [Table("modlogs")]
-public class ModLogEntry {
+public class ModLogEntry : ISharedEvent {
     /// <summary>
     /// Gets the ID number for this entry.
     /// </summary>
@@ -22,7 +22,9 @@ public class ModLogEntry {
     /// <inheritdoc cref="CachedGuildUser.GuildId"/>
     public long GuildId { get; set; }
 
-    /// <inheritdoc cref="CachedGuildUser.UserId"/>
+    /// <summary>
+    /// Gets the ID of the users for which this log entry pertains.
+    /// </summary>
     public long UserId { get; set; }
 
     /// <summary>
@@ -40,4 +42,9 @@ public class ModLogEntry {
     /// Gets any additional message associated with this log entry.
     /// </summary>
     public string? Message { get; set; }
+
+    /// <summary>
+    /// If included in the query, gets the associated <seealso cref="CachedGuildUser"/> for this entry.
+    /// </summary>
+    public CachedGuildUser User { get; set; } = null!;
 }