From f4c0a4025925bd258f01b69f4f39f89c8030b4da Mon Sep 17 00:00:00 2001 From: sam Date: Mon, 27 May 2024 15:53:54 +0200 Subject: [PATCH] init --- .gitignore | 2 + .idea/.idea.Foxnouns.NET/.idea/.gitignore | 13 + .idea/.idea.Foxnouns.NET/.idea/encodings.xml | 4 + .../.idea.Foxnouns.NET/.idea/indexLayout.xml | 8 + .idea/.idea.Foxnouns.NET/.idea/vcs.xml | 6 + Foxnouns.Backend/Config.cs | 24 + Foxnouns.Backend/Database/BaseModel.cs | 6 + Foxnouns.Backend/Database/DatabaseContext.cs | 73 ++ .../Database/ISnowflakeGenerator.cs | 8 + .../20240527132444_Init.Designer.cs | 412 +++++++++++ .../Migrations/20240527132444_Init.cs | 171 +++++ .../DatabaseContextModelSnapshot.cs | 409 +++++++++++ .../Database/Models/AuthMethod.cs | 23 + .../Database/Models/FediverseApplication.cs | 15 + Foxnouns.Backend/Database/Models/Field.cs | 18 + Foxnouns.Backend/Database/Models/Member.cs | 18 + Foxnouns.Backend/Database/Models/Token.cs | 15 + Foxnouns.Backend/Database/Models/User.cs | 27 + Foxnouns.Backend/Database/Snowflake.cs | 57 ++ .../Database/SnowflakeGenerator.cs | 45 ++ .../Extensions/WebApplicationExtensions.cs | 60 ++ Foxnouns.Backend/Foxnouns.Backend.csproj | 29 + Foxnouns.Backend/GlobalUsing.cs | 2 + Foxnouns.Backend/Program.cs | 40 ++ Foxnouns.Backend/config.ini | 20 + Foxnouns.NET.sln | 22 + LICENSE | 661 ++++++++++++++++++ 27 files changed, 2188 insertions(+) create mode 100644 .gitignore create mode 100644 .idea/.idea.Foxnouns.NET/.idea/.gitignore create mode 100644 .idea/.idea.Foxnouns.NET/.idea/encodings.xml create mode 100644 .idea/.idea.Foxnouns.NET/.idea/indexLayout.xml create mode 100644 .idea/.idea.Foxnouns.NET/.idea/vcs.xml create mode 100644 Foxnouns.Backend/Config.cs create mode 100644 Foxnouns.Backend/Database/BaseModel.cs create mode 100644 Foxnouns.Backend/Database/DatabaseContext.cs create mode 100644 Foxnouns.Backend/Database/ISnowflakeGenerator.cs create mode 100644 Foxnouns.Backend/Database/Migrations/20240527132444_Init.Designer.cs create mode 100644 Foxnouns.Backend/Database/Migrations/20240527132444_Init.cs create mode 100644 Foxnouns.Backend/Database/Migrations/DatabaseContextModelSnapshot.cs create mode 100644 Foxnouns.Backend/Database/Models/AuthMethod.cs create mode 100644 Foxnouns.Backend/Database/Models/FediverseApplication.cs create mode 100644 Foxnouns.Backend/Database/Models/Field.cs create mode 100644 Foxnouns.Backend/Database/Models/Member.cs create mode 100644 Foxnouns.Backend/Database/Models/Token.cs create mode 100644 Foxnouns.Backend/Database/Models/User.cs create mode 100644 Foxnouns.Backend/Database/Snowflake.cs create mode 100644 Foxnouns.Backend/Database/SnowflakeGenerator.cs create mode 100644 Foxnouns.Backend/Extensions/WebApplicationExtensions.cs create mode 100644 Foxnouns.Backend/Foxnouns.Backend.csproj create mode 100644 Foxnouns.Backend/GlobalUsing.cs create mode 100644 Foxnouns.Backend/Program.cs create mode 100644 Foxnouns.Backend/config.ini create mode 100644 Foxnouns.NET.sln create mode 100644 LICENSE diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cd42ee3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +bin/ +obj/ diff --git a/.idea/.idea.Foxnouns.NET/.idea/.gitignore b/.idea/.idea.Foxnouns.NET/.idea/.gitignore new file mode 100644 index 0000000..0542aff --- /dev/null +++ b/.idea/.idea.Foxnouns.NET/.idea/.gitignore @@ -0,0 +1,13 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Rider ignored files +/.idea.Foxnouns.NET.iml +/projectSettingsUpdater.xml +/modules.xml +/contentModel.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/.idea.Foxnouns.NET/.idea/encodings.xml b/.idea/.idea.Foxnouns.NET/.idea/encodings.xml new file mode 100644 index 0000000..df87cf9 --- /dev/null +++ b/.idea/.idea.Foxnouns.NET/.idea/encodings.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/.idea/.idea.Foxnouns.NET/.idea/indexLayout.xml b/.idea/.idea.Foxnouns.NET/.idea/indexLayout.xml new file mode 100644 index 0000000..7b08163 --- /dev/null +++ b/.idea/.idea.Foxnouns.NET/.idea/indexLayout.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/.idea.Foxnouns.NET/.idea/vcs.xml b/.idea/.idea.Foxnouns.NET/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/.idea.Foxnouns.NET/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Foxnouns.Backend/Config.cs b/Foxnouns.Backend/Config.cs new file mode 100644 index 0000000..39a417f --- /dev/null +++ b/Foxnouns.Backend/Config.cs @@ -0,0 +1,24 @@ +using Serilog.Events; + +namespace Foxnouns.Backend; + +public class Config +{ + public string Host { get; set; } = "localhost"; + public int Port { get; set; } = 3000; + public string BaseUrl { get; set; } = null!; + + public string Address => $"http://{Host}:{Port}"; + + public string? SeqLogUrl { get; set; } + public LogEventLevel LogEventLevel { get; set; } = LogEventLevel.Debug; + + public DatabaseConfig Database { get; set; } = new(); + + public class DatabaseConfig + { + public string Url { get; set; } = string.Empty; + public int? Timeout { get; set; } + public int? MaxPoolSize { get; set; } + } +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/BaseModel.cs b/Foxnouns.Backend/Database/BaseModel.cs new file mode 100644 index 0000000..d0dcbca --- /dev/null +++ b/Foxnouns.Backend/Database/BaseModel.cs @@ -0,0 +1,6 @@ +namespace Foxnouns.Backend.Database; + +public abstract class BaseModel +{ + public required Snowflake Id { get; init; } = SnowflakeGenerator.Instance.GenerateSnowflake(); +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/DatabaseContext.cs b/Foxnouns.Backend/Database/DatabaseContext.cs new file mode 100644 index 0000000..4caa31c --- /dev/null +++ b/Foxnouns.Backend/Database/DatabaseContext.cs @@ -0,0 +1,73 @@ +using Foxnouns.Backend.Database.Models; +using Foxnouns.Backend.Extensions; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Design; +using Npgsql; + +namespace Foxnouns.Backend.Database; + +public class DatabaseContext : DbContext +{ + private readonly NpgsqlDataSource _dataSource; + + public DbSet Users { get; set; } + public DbSet Members { get; set; } + public DbSet AuthMethods { get; set; } + public DbSet FediverseApplications { get; set; } + public DbSet Tokens { get; set; } + + public DatabaseContext(Config config) + { + var connString = new NpgsqlConnectionStringBuilder(config.Database.Url) + { + Timeout = config.Database.Timeout ?? 5, + MaxPoolSize = config.Database.MaxPoolSize ?? 50, + }.ConnectionString; + + var dataSourceBuilder = new NpgsqlDataSourceBuilder(connString); + dataSourceBuilder.UseNodaTime(); + _dataSource = dataSourceBuilder.Build(); + } + + protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) + => optionsBuilder + .UseNpgsql(_dataSource, o => o.UseNodaTime()) + .UseSnakeCaseNamingConvention(); + + protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder) + { + // Snowflakes are stored as longs + configurationBuilder.Properties().HaveConversion(); + } + + protected override void OnModelCreating(ModelBuilder modelBuilder) + { + modelBuilder.Entity().HasIndex(u => u.Username).IsUnique(); + modelBuilder.Entity().HasIndex(m => new { m.UserId, m.Name }).IsUnique(); + + modelBuilder.Entity() + .OwnsOne(u => u.Fields, f => f.ToJson()) + .OwnsOne(u => u.Names, n => n.ToJson()) + .OwnsOne(u => u.Pronouns, p => p.ToJson()); + + modelBuilder.Entity() + .OwnsOne(m => m.Fields, f => f.ToJson()) + .OwnsOne(m => m.Names, n => n.ToJson()) + .OwnsOne(m => m.Pronouns, p => p.ToJson()); + } +} + +public class DesignTimeDatabaseContextFactory : IDesignTimeDbContextFactory +{ + public DatabaseContext CreateDbContext(string[] args) + { + // Read the configuration file + var config = new ConfigurationBuilder() + .AddConfiguration() + .Build() + // Get the configuration as our config class + .Get() ?? new(); + + return new DatabaseContext(config); + } +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/ISnowflakeGenerator.cs b/Foxnouns.Backend/Database/ISnowflakeGenerator.cs new file mode 100644 index 0000000..dd76ab3 --- /dev/null +++ b/Foxnouns.Backend/Database/ISnowflakeGenerator.cs @@ -0,0 +1,8 @@ +using NodaTime; + +namespace Foxnouns.Backend.Database; + +public interface ISnowflakeGenerator +{ + Snowflake GenerateSnowflake(Instant? time = null); +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Migrations/20240527132444_Init.Designer.cs b/Foxnouns.Backend/Database/Migrations/20240527132444_Init.Designer.cs new file mode 100644 index 0000000..5274ef0 --- /dev/null +++ b/Foxnouns.Backend/Database/Migrations/20240527132444_Init.Designer.cs @@ -0,0 +1,412 @@ +// +using Foxnouns.Backend.Database; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Migrations; +using Microsoft.EntityFrameworkCore.Storage.ValueConversion; +using NodaTime; +using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata; + +#nullable disable + +namespace Foxnouns.Backend.Database.Migrations +{ + [DbContext(typeof(DatabaseContext))] + [Migration("20240527132444_Init")] + partial class Init + { + /// + protected override void BuildTargetModel(ModelBuilder modelBuilder) + { +#pragma warning disable 612, 618 + modelBuilder + .HasAnnotation("ProductVersion", "8.0.5") + .HasAnnotation("Relational:MaxIdentifierLength", 63); + + NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.AuthMethod", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("AuthType") + .HasColumnType("integer") + .HasColumnName("auth_type"); + + b.Property("FediverseApplicationId") + .HasColumnType("bigint") + .HasColumnName("fediverse_application_id"); + + b.Property("RemoteId") + .IsRequired() + .HasColumnType("text") + .HasColumnName("remote_id"); + + b.Property("RemoteUsername") + .HasColumnType("text") + .HasColumnName("remote_username"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_auth_methods"); + + b.HasIndex("FediverseApplicationId") + .HasDatabaseName("ix_auth_methods_fediverse_application_id"); + + b.HasIndex("UserId") + .HasDatabaseName("ix_auth_methods_user_id"); + + b.ToTable("auth_methods", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.FediverseApplication", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("ClientId") + .IsRequired() + .HasColumnType("text") + .HasColumnName("client_id"); + + b.Property("ClientSecret") + .IsRequired() + .HasColumnType("text") + .HasColumnName("client_secret"); + + b.Property("Domain") + .IsRequired() + .HasColumnType("text") + .HasColumnName("domain"); + + b.Property("InstanceType") + .HasColumnType("integer") + .HasColumnName("instance_type"); + + b.HasKey("Id") + .HasName("pk_fediverse_applications"); + + b.ToTable("fediverse_applications", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Member", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("Avatar") + .HasColumnType("text") + .HasColumnName("avatar"); + + b.Property("Bio") + .HasColumnType("text") + .HasColumnName("bio"); + + b.Property("DisplayName") + .HasColumnType("text") + .HasColumnName("display_name"); + + b.Property("Links") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("links"); + + b.Property("Name") + .IsRequired() + .HasColumnType("text") + .HasColumnName("name"); + + b.Property("Unlisted") + .HasColumnType("boolean") + .HasColumnName("unlisted"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_members"); + + b.HasIndex("UserId", "Name") + .IsUnique() + .HasDatabaseName("ix_members_user_id_name"); + + b.ToTable("members", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Token", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("ExpiresAt") + .HasColumnType("timestamp with time zone") + .HasColumnName("expires_at"); + + b.Property("ManuallyExpired") + .HasColumnType("boolean") + .HasColumnName("manually_expired"); + + b.Property("Scopes") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("scopes"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_tokens"); + + b.HasIndex("UserId") + .HasDatabaseName("ix_tokens_user_id"); + + b.ToTable("tokens", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("Avatar") + .HasColumnType("text") + .HasColumnName("avatar"); + + b.Property("Bio") + .HasColumnType("text") + .HasColumnName("bio"); + + b.Property("DisplayName") + .HasColumnType("text") + .HasColumnName("display_name"); + + b.Property("Links") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("links"); + + b.Property("MemberTitle") + .HasColumnType("text") + .HasColumnName("member_title"); + + b.Property("Role") + .HasColumnType("integer") + .HasColumnName("role"); + + b.Property("Username") + .IsRequired() + .HasColumnType("text") + .HasColumnName("username"); + + b.HasKey("Id") + .HasName("pk_users"); + + b.HasIndex("Username") + .IsUnique() + .HasDatabaseName("ix_users_username"); + + b.ToTable("users", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.AuthMethod", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.FediverseApplication", "FediverseApplication") + .WithMany() + .HasForeignKey("FediverseApplicationId") + .HasConstraintName("fk_auth_methods_fediverse_applications_fediverse_application_id"); + + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany("AuthMethods") + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_auth_methods_users_user_id"); + + b.Navigation("FediverseApplication"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Member", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany("Members") + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_members_users_user_id"); + + b.OwnsOne("System.Collections.Generic.List", "Fields", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("fields"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.OwnsOne("System.Collections.Generic.List", "Names", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("names"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.OwnsOne("System.Collections.Generic.List", "Pronouns", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("pronouns"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.Navigation("Fields") + .IsRequired(); + + b.Navigation("Names") + .IsRequired(); + + b.Navigation("Pronouns") + .IsRequired(); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Token", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany() + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_tokens_users_user_id"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Fields#List", "Fields", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("fields"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Names#List", "Names", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("names"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Pronouns#List", "Pronouns", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("pronouns"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.Navigation("Fields") + .IsRequired(); + + b.Navigation("Names") + .IsRequired(); + + b.Navigation("Pronouns") + .IsRequired(); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.Navigation("AuthMethods"); + + b.Navigation("Members"); + }); +#pragma warning restore 612, 618 + } + } +} diff --git a/Foxnouns.Backend/Database/Migrations/20240527132444_Init.cs b/Foxnouns.Backend/Database/Migrations/20240527132444_Init.cs new file mode 100644 index 0000000..dc82d36 --- /dev/null +++ b/Foxnouns.Backend/Database/Migrations/20240527132444_Init.cs @@ -0,0 +1,171 @@ +using Microsoft.EntityFrameworkCore.Migrations; +using NodaTime; + +#nullable disable + +namespace Foxnouns.Backend.Database.Migrations +{ + /// + public partial class Init : Migration + { + /// + protected override void Up(MigrationBuilder migrationBuilder) + { + migrationBuilder.CreateTable( + name: "fediverse_applications", + columns: table => new + { + id = table.Column(type: "bigint", nullable: false), + domain = table.Column(type: "text", nullable: false), + client_id = table.Column(type: "text", nullable: false), + client_secret = table.Column(type: "text", nullable: false), + instance_type = table.Column(type: "integer", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("pk_fediverse_applications", x => x.id); + }); + + migrationBuilder.CreateTable( + name: "users", + columns: table => new + { + id = table.Column(type: "bigint", nullable: false), + username = table.Column(type: "text", nullable: false), + display_name = table.Column(type: "text", nullable: true), + bio = table.Column(type: "text", nullable: true), + member_title = table.Column(type: "text", nullable: true), + avatar = table.Column(type: "text", nullable: true), + links = table.Column(type: "text[]", nullable: false), + role = table.Column(type: "integer", nullable: false), + fields = table.Column(type: "jsonb", nullable: false), + names = table.Column(type: "jsonb", nullable: false), + pronouns = table.Column(type: "jsonb", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("pk_users", x => x.id); + }); + + migrationBuilder.CreateTable( + name: "auth_methods", + columns: table => new + { + id = table.Column(type: "bigint", nullable: false), + auth_type = table.Column(type: "integer", nullable: false), + remote_id = table.Column(type: "text", nullable: false), + remote_username = table.Column(type: "text", nullable: true), + user_id = table.Column(type: "bigint", nullable: false), + fediverse_application_id = table.Column(type: "bigint", nullable: true) + }, + constraints: table => + { + table.PrimaryKey("pk_auth_methods", x => x.id); + table.ForeignKey( + name: "fk_auth_methods_fediverse_applications_fediverse_application_id", + column: x => x.fediverse_application_id, + principalTable: "fediverse_applications", + principalColumn: "id"); + table.ForeignKey( + name: "fk_auth_methods_users_user_id", + column: x => x.user_id, + principalTable: "users", + principalColumn: "id", + onDelete: ReferentialAction.Cascade); + }); + + migrationBuilder.CreateTable( + name: "members", + columns: table => new + { + id = table.Column(type: "bigint", nullable: false), + name = table.Column(type: "text", nullable: false), + display_name = table.Column(type: "text", nullable: true), + bio = table.Column(type: "text", nullable: true), + avatar = table.Column(type: "text", nullable: true), + links = table.Column(type: "text[]", nullable: false), + unlisted = table.Column(type: "boolean", nullable: false), + user_id = table.Column(type: "bigint", nullable: false), + fields = table.Column(type: "jsonb", nullable: false), + names = table.Column(type: "jsonb", nullable: false), + pronouns = table.Column(type: "jsonb", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("pk_members", x => x.id); + table.ForeignKey( + name: "fk_members_users_user_id", + column: x => x.user_id, + principalTable: "users", + principalColumn: "id", + onDelete: ReferentialAction.Cascade); + }); + + migrationBuilder.CreateTable( + name: "tokens", + columns: table => new + { + id = table.Column(type: "bigint", nullable: false), + expires_at = table.Column(type: "timestamp with time zone", nullable: false), + scopes = table.Column(type: "text[]", nullable: false), + manually_expired = table.Column(type: "boolean", nullable: false), + user_id = table.Column(type: "bigint", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("pk_tokens", x => x.id); + table.ForeignKey( + name: "fk_tokens_users_user_id", + column: x => x.user_id, + principalTable: "users", + principalColumn: "id", + onDelete: ReferentialAction.Cascade); + }); + + migrationBuilder.CreateIndex( + name: "ix_auth_methods_fediverse_application_id", + table: "auth_methods", + column: "fediverse_application_id"); + + migrationBuilder.CreateIndex( + name: "ix_auth_methods_user_id", + table: "auth_methods", + column: "user_id"); + + // EF Core doesn't support creating indexes on arbitrary expressions, so we have to create it manually. + // Due to historical reasons (I made a mistake while writing the initial migration for the Go version) + // only members have case-insensitive names. + migrationBuilder.Sql("CREATE UNIQUE INDEX ix_members_user_id_name ON members (user_id, lower(name))"); + + migrationBuilder.CreateIndex( + name: "ix_tokens_user_id", + table: "tokens", + column: "user_id"); + + migrationBuilder.CreateIndex( + name: "ix_users_username", + table: "users", + column: "username", + unique: true); + } + + /// + protected override void Down(MigrationBuilder migrationBuilder) + { + migrationBuilder.DropTable( + name: "auth_methods"); + + migrationBuilder.DropTable( + name: "members"); + + migrationBuilder.DropTable( + name: "tokens"); + + migrationBuilder.DropTable( + name: "fediverse_applications"); + + migrationBuilder.DropTable( + name: "users"); + } + } +} diff --git a/Foxnouns.Backend/Database/Migrations/DatabaseContextModelSnapshot.cs b/Foxnouns.Backend/Database/Migrations/DatabaseContextModelSnapshot.cs new file mode 100644 index 0000000..92f7fdb --- /dev/null +++ b/Foxnouns.Backend/Database/Migrations/DatabaseContextModelSnapshot.cs @@ -0,0 +1,409 @@ +// +using Foxnouns.Backend.Database; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Storage.ValueConversion; +using NodaTime; +using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata; + +#nullable disable + +namespace Foxnouns.Backend.Database.Migrations +{ + [DbContext(typeof(DatabaseContext))] + partial class DatabaseContextModelSnapshot : ModelSnapshot + { + protected override void BuildModel(ModelBuilder modelBuilder) + { +#pragma warning disable 612, 618 + modelBuilder + .HasAnnotation("ProductVersion", "8.0.5") + .HasAnnotation("Relational:MaxIdentifierLength", 63); + + NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.AuthMethod", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("AuthType") + .HasColumnType("integer") + .HasColumnName("auth_type"); + + b.Property("FediverseApplicationId") + .HasColumnType("bigint") + .HasColumnName("fediverse_application_id"); + + b.Property("RemoteId") + .IsRequired() + .HasColumnType("text") + .HasColumnName("remote_id"); + + b.Property("RemoteUsername") + .HasColumnType("text") + .HasColumnName("remote_username"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_auth_methods"); + + b.HasIndex("FediverseApplicationId") + .HasDatabaseName("ix_auth_methods_fediverse_application_id"); + + b.HasIndex("UserId") + .HasDatabaseName("ix_auth_methods_user_id"); + + b.ToTable("auth_methods", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.FediverseApplication", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("ClientId") + .IsRequired() + .HasColumnType("text") + .HasColumnName("client_id"); + + b.Property("ClientSecret") + .IsRequired() + .HasColumnType("text") + .HasColumnName("client_secret"); + + b.Property("Domain") + .IsRequired() + .HasColumnType("text") + .HasColumnName("domain"); + + b.Property("InstanceType") + .HasColumnType("integer") + .HasColumnName("instance_type"); + + b.HasKey("Id") + .HasName("pk_fediverse_applications"); + + b.ToTable("fediverse_applications", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Member", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("Avatar") + .HasColumnType("text") + .HasColumnName("avatar"); + + b.Property("Bio") + .HasColumnType("text") + .HasColumnName("bio"); + + b.Property("DisplayName") + .HasColumnType("text") + .HasColumnName("display_name"); + + b.Property("Links") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("links"); + + b.Property("Name") + .IsRequired() + .HasColumnType("text") + .HasColumnName("name"); + + b.Property("Unlisted") + .HasColumnType("boolean") + .HasColumnName("unlisted"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_members"); + + b.HasIndex("UserId", "Name") + .IsUnique() + .HasDatabaseName("ix_members_user_id_name"); + + b.ToTable("members", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Token", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("ExpiresAt") + .HasColumnType("timestamp with time zone") + .HasColumnName("expires_at"); + + b.Property("ManuallyExpired") + .HasColumnType("boolean") + .HasColumnName("manually_expired"); + + b.Property("Scopes") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("scopes"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("Id") + .HasName("pk_tokens"); + + b.HasIndex("UserId") + .HasDatabaseName("ix_tokens_user_id"); + + b.ToTable("tokens", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.Property("Id") + .HasColumnType("bigint") + .HasColumnName("id"); + + b.Property("Avatar") + .HasColumnType("text") + .HasColumnName("avatar"); + + b.Property("Bio") + .HasColumnType("text") + .HasColumnName("bio"); + + b.Property("DisplayName") + .HasColumnType("text") + .HasColumnName("display_name"); + + b.Property("Links") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("links"); + + b.Property("MemberTitle") + .HasColumnType("text") + .HasColumnName("member_title"); + + b.Property("Role") + .HasColumnType("integer") + .HasColumnName("role"); + + b.Property("Username") + .IsRequired() + .HasColumnType("text") + .HasColumnName("username"); + + b.HasKey("Id") + .HasName("pk_users"); + + b.HasIndex("Username") + .IsUnique() + .HasDatabaseName("ix_users_username"); + + b.ToTable("users", (string)null); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.AuthMethod", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.FediverseApplication", "FediverseApplication") + .WithMany() + .HasForeignKey("FediverseApplicationId") + .HasConstraintName("fk_auth_methods_fediverse_applications_fediverse_application_id"); + + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany("AuthMethods") + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_auth_methods_users_user_id"); + + b.Navigation("FediverseApplication"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Member", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany("Members") + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_members_users_user_id"); + + b.OwnsOne("System.Collections.Generic.List", "Fields", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("fields"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.OwnsOne("System.Collections.Generic.List", "Names", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("names"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.OwnsOne("System.Collections.Generic.List", "Pronouns", b1 => + { + b1.Property("MemberId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("MemberId"); + + b1.ToTable("members"); + + b1.ToJson("pronouns"); + + b1.WithOwner() + .HasForeignKey("MemberId") + .HasConstraintName("fk_members_members_id"); + }); + + b.Navigation("Fields") + .IsRequired(); + + b.Navigation("Names") + .IsRequired(); + + b.Navigation("Pronouns") + .IsRequired(); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.Token", b => + { + b.HasOne("Foxnouns.Backend.Database.Models.User", "User") + .WithMany() + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_tokens_users_user_id"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Fields#List", "Fields", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("fields"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Names#List", "Names", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("names"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.OwnsOne("Foxnouns.Backend.Database.Models.User.Pronouns#List", "Pronouns", b1 => + { + b1.Property("UserId") + .HasColumnType("bigint"); + + b1.Property("Capacity") + .HasColumnType("integer"); + + b1.HasKey("UserId") + .HasName("pk_users"); + + b1.ToTable("users"); + + b1.ToJson("pronouns"); + + b1.WithOwner() + .HasForeignKey("UserId") + .HasConstraintName("fk_users_users_user_id"); + }); + + b.Navigation("Fields") + .IsRequired(); + + b.Navigation("Names") + .IsRequired(); + + b.Navigation("Pronouns") + .IsRequired(); + }); + + modelBuilder.Entity("Foxnouns.Backend.Database.Models.User", b => + { + b.Navigation("AuthMethods"); + + b.Navigation("Members"); + }); +#pragma warning restore 612, 618 + } + } +} diff --git a/Foxnouns.Backend/Database/Models/AuthMethod.cs b/Foxnouns.Backend/Database/Models/AuthMethod.cs new file mode 100644 index 0000000..0e282ae --- /dev/null +++ b/Foxnouns.Backend/Database/Models/AuthMethod.cs @@ -0,0 +1,23 @@ +namespace Foxnouns.Backend.Database.Models; + +public class AuthMethod : BaseModel +{ + public required AuthType AuthType { get; init; } + public required string RemoteId { get; init; } + public string? RemoteUsername { get; set; } + + public Snowflake UserId { get; init; } + public User User { get; init; } = null!; + + public Snowflake? FediverseApplicationId { get; init; } + public FediverseApplication? FediverseApplication { get; init; } +} + +public enum AuthType +{ + Discord, + Google, + Tumblr, + Fediverse, + Email, +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Models/FediverseApplication.cs b/Foxnouns.Backend/Database/Models/FediverseApplication.cs new file mode 100644 index 0000000..8da8b29 --- /dev/null +++ b/Foxnouns.Backend/Database/Models/FediverseApplication.cs @@ -0,0 +1,15 @@ +namespace Foxnouns.Backend.Database.Models; + +public class FediverseApplication : BaseModel +{ + public required string Domain { get; init; } + public required string ClientId { get; set; } + public required string ClientSecret { get; set; } + public required FediverseInstanceType InstanceType { get; set; } +} + +public enum FediverseInstanceType +{ + MastodonApi, + MisskeyApi +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Models/Field.cs b/Foxnouns.Backend/Database/Models/Field.cs new file mode 100644 index 0000000..c123e5b --- /dev/null +++ b/Foxnouns.Backend/Database/Models/Field.cs @@ -0,0 +1,18 @@ +namespace Foxnouns.Backend.Database.Models; + +public class Field +{ + public required string Name { get; set; } + public FieldEntry[] Entries { get; set; } = []; +} + +public class FieldEntry +{ + public required string Value { get; set; } + public required string Status { get; set; } +} + +public class Pronoun : FieldEntry +{ + public string? DisplayText { get; set; } +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Models/Member.cs b/Foxnouns.Backend/Database/Models/Member.cs new file mode 100644 index 0000000..cd0d9cd --- /dev/null +++ b/Foxnouns.Backend/Database/Models/Member.cs @@ -0,0 +1,18 @@ +namespace Foxnouns.Backend.Database.Models; + +public class Member : BaseModel +{ + public required string Name { get; set; } + public string? DisplayName { get; set; } + public string? Bio { get; set; } + public string? Avatar { get; set; } + public string[] Links { get; set; } = []; + public bool Unlisted { get; set; } + + public List Names { get; set; } = []; + public List Pronouns { get; set; } = []; + public List Fields { get; set; } = []; + + public Snowflake UserId { get; init; } + public User User { get; init; } = null!; +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Models/Token.cs b/Foxnouns.Backend/Database/Models/Token.cs new file mode 100644 index 0000000..89a3c4c --- /dev/null +++ b/Foxnouns.Backend/Database/Models/Token.cs @@ -0,0 +1,15 @@ +using NodaTime; + +namespace Foxnouns.Backend.Database.Models; + +public class Token : BaseModel +{ + public required Instant ExpiresAt { get; init; } + public required string[] Scopes { get; init; } + public bool ManuallyExpired { get; set; } + + public bool IsExpired => ManuallyExpired || ExpiresAt < SystemClock.Instance.GetCurrentInstant(); + + public Snowflake UserId { get; init; } + public User User { get; init; } = null!; +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Models/User.cs b/Foxnouns.Backend/Database/Models/User.cs new file mode 100644 index 0000000..9821bde --- /dev/null +++ b/Foxnouns.Backend/Database/Models/User.cs @@ -0,0 +1,27 @@ +namespace Foxnouns.Backend.Database.Models; + +public class User : BaseModel +{ + public required string Username { get; set; } + public string? DisplayName { get; set; } + public string? Bio { get; set; } + public string? MemberTitle { get; set; } + public string? Avatar { get; set; } + public string[] Links { get; set; } = []; + + public List Names { get; set; } = []; + public List Pronouns { get; set; } = []; + public List Fields { get; set; } = []; + + public UserRole Role { get; set; } = UserRole.User; + + public List Members { get; } = []; + public List AuthMethods { get; } = []; +} + +public enum UserRole +{ + User, + Moderator, + Admin, +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/Snowflake.cs b/Foxnouns.Backend/Database/Snowflake.cs new file mode 100644 index 0000000..56a6097 --- /dev/null +++ b/Foxnouns.Backend/Database/Snowflake.cs @@ -0,0 +1,57 @@ +using Microsoft.EntityFrameworkCore.Storage.ValueConversion; +using NodaTime; + +namespace Foxnouns.Backend.Database; + +public readonly struct Snowflake(ulong value) +{ + public const long Epoch = 1_640_995_200_000; // 2022-01-01 at 00:00:00 UTC + public readonly ulong Value = value; + + /// + /// The time this snowflake was created. + /// + public Instant Time => Instant.FromUnixTimeMilliseconds(Timestamp); + + /// + /// The Unix timestamp embedded in this snowflake, in milliseconds. + /// + public long Timestamp => (long)((Value >> 22) + Epoch); + + /// + /// The process ID embedded in this snowflake. + /// + public byte ProcessId => (byte)((Value & 0x3E0000) >> 17); + + /// + /// The thread ID embedded in this snowflake. + /// + public byte ThreadId => (byte)((Value & 0x1F000) >> 12); + + /// + /// The increment embedded in this snowflake. + /// + public short Increment => (short)(Value & 0xFFF); + + public static bool operator <(Snowflake arg1, Snowflake arg2) => arg1.Value < arg2.Value; + public static bool operator >(Snowflake arg1, Snowflake arg2) => arg1.Value > arg2.Value; + public static bool operator ==(Snowflake arg1, Snowflake arg2) => arg1.Value == arg2.Value; + public static bool operator !=(Snowflake arg1, Snowflake arg2) => arg1.Value != arg2.Value; + + public static implicit operator ulong(Snowflake s) => s.Value; + public static implicit operator long(Snowflake s) => (long)s.Value; + public static implicit operator Snowflake(ulong n) => new(n); + public static implicit operator Snowflake(long n) => new((ulong)n); + + public override bool Equals(object? obj) => obj is Snowflake other && Value == other.Value; + public override int GetHashCode() => Value.GetHashCode(); + + /// + /// An Entity Framework ValueConverter for Snowflakes to longs. + /// + // ReSharper disable once ClassNeverInstantiated.Global + public class ValueConverter() : ValueConverter( + convertToProviderExpression: x => x, + convertFromProviderExpression: x => x + ); +} \ No newline at end of file diff --git a/Foxnouns.Backend/Database/SnowflakeGenerator.cs b/Foxnouns.Backend/Database/SnowflakeGenerator.cs new file mode 100644 index 0000000..e070e20 --- /dev/null +++ b/Foxnouns.Backend/Database/SnowflakeGenerator.cs @@ -0,0 +1,45 @@ +using NodaTime; + +namespace Foxnouns.Backend.Database; + +public class SnowflakeGenerator : ISnowflakeGenerator +{ + /// + /// Singleton instance of SnowflakeGenerator. Where possible, use an injected ISnowflakeGenerator instead + /// (see IServiceCollection.AddSnowflakeGenerator). + /// + public static SnowflakeGenerator Instance { get; } = new(); + + private readonly byte _processId; + private long _increment; + + public SnowflakeGenerator(int? processId = null) + { + processId ??= Environment.ProcessId; + _processId = (byte)(processId % 32); + _increment = Random.Shared.NextInt64() % 4096; + } + + /// + /// Generate a snowflake ID for the given timestamp. + /// + /// An optional timestamp. If null, use the current timestamp. + /// A new snowflake ID. + public Snowflake GenerateSnowflake(Instant? time = null) + { + time ??= SystemClock.Instance.GetCurrentInstant(); + var increment = Interlocked.Increment(ref _increment); + var threadId = Environment.CurrentManagedThreadId % 32; + var timestamp = time.Value.ToUnixTimeMilliseconds() - Snowflake.Epoch; + + return (timestamp << 22) | (uint)(_processId << 17) | (uint)(threadId << 12) | (increment % 4096); + } +} + +public static class SnowflakeGeneratorServiceExtensions +{ + public static IServiceCollection AddSnowflakeGenerator(this IServiceCollection services, int? processId = null) + { + return services.AddSingleton(new SnowflakeGenerator(processId)); + } +} \ No newline at end of file diff --git a/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs b/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs new file mode 100644 index 0000000..4fd06db --- /dev/null +++ b/Foxnouns.Backend/Extensions/WebApplicationExtensions.cs @@ -0,0 +1,60 @@ +using Serilog; +using Serilog.Events; +using Serilog.Sinks.SystemConsole.Themes; + +namespace Foxnouns.Backend.Extensions; + +public static class ServiceCollectionExtensions +{ + /// + /// Adds Serilog to this service collection. This method also initializes Serilog, so it should be called as early as possible, before any log calls. + /// + public static WebApplicationBuilder AddSerilog(this WebApplicationBuilder builder, LogEventLevel level) + { + var config = builder.Configuration.Get() ?? new(); + + var logCfg = new LoggerConfiguration() + .Enrich.FromLogContext() + .MinimumLevel.Is(level) + // ASP.NET's built in request logs are extremely verbose, so we use Serilog's instead. + // Serilog doesn't disable the built-in logs, so we do it here. + .MinimumLevel.Override("Microsoft", LogEventLevel.Information) + .MinimumLevel.Override("Microsoft.AspNetCore.Hosting", LogEventLevel.Warning) + .MinimumLevel.Override("Microsoft.AspNetCore.Mvc", LogEventLevel.Warning) + .MinimumLevel.Override("Microsoft.AspNetCore.Routing", LogEventLevel.Warning) + .WriteTo.Console(theme: AnsiConsoleTheme.Code); + + if (config.SeqLogUrl != null) + { + logCfg.WriteTo.Seq(config.SeqLogUrl, restrictedToMinimumLevel: LogEventLevel.Verbose); + } + + Log.Logger = logCfg.CreateLogger(); + + // AddSerilog doesn't seem to add an ILogger to the service collection, so add that manually. + builder.Services.AddSerilog().AddSingleton(Log.Logger); + + return builder; + } + + public static Config AddConfiguration(this WebApplicationBuilder builder) + { + + builder.Configuration.Sources.Clear(); + builder.Configuration.AddConfiguration(); + + var config = builder.Configuration.Get() ?? new(); + builder.Services.AddSingleton(config); + return config; + } + + public static IConfigurationBuilder AddConfiguration(this IConfigurationBuilder builder) + { + var file = Environment.GetEnvironmentVariable("FOXNOUNS_CONFIG_FILE") ?? "config.ini"; + + return builder + .SetBasePath(Directory.GetCurrentDirectory()) + .AddIniFile(file, optional: false, reloadOnChange: true) + .AddEnvironmentVariables(); + } +} diff --git a/Foxnouns.Backend/Foxnouns.Backend.csproj b/Foxnouns.Backend/Foxnouns.Backend.csproj new file mode 100644 index 0000000..765047f --- /dev/null +++ b/Foxnouns.Backend/Foxnouns.Backend.csproj @@ -0,0 +1,29 @@ + + + + net8.0 + enable + enable + + + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + + + + + + diff --git a/Foxnouns.Backend/GlobalUsing.cs b/Foxnouns.Backend/GlobalUsing.cs new file mode 100644 index 0000000..5275c8d --- /dev/null +++ b/Foxnouns.Backend/GlobalUsing.cs @@ -0,0 +1,2 @@ +global using ILogger = Serilog.ILogger; +global using Log = Serilog.Log; diff --git a/Foxnouns.Backend/Program.cs b/Foxnouns.Backend/Program.cs new file mode 100644 index 0000000..8a30f9d --- /dev/null +++ b/Foxnouns.Backend/Program.cs @@ -0,0 +1,40 @@ +using Foxnouns.Backend.Database; +using Serilog; +using Foxnouns.Backend.Extensions; +using Newtonsoft.Json.Serialization; + +var builder = WebApplication.CreateBuilder(args); + +var config = builder.AddConfiguration(); + +builder.AddSerilog(config.LogEventLevel); + +builder.Services + .AddControllers() + .AddNewtonsoftJson(options => + options.SerializerSettings.ContractResolver = new DefaultContractResolver + { + NamingStrategy = new SnakeCaseNamingStrategy() + }); + +builder.Services + .AddDbContext() + .AddSnowflakeGenerator() + .AddEndpointsApiExplorer() + .AddSwaggerGen(); + +var app = builder.Build(); + +app.UseSerilogRequestLogging(); +app.UseRouting(); +app.UseSwagger(); +app.UseSwaggerUI(); +app.UseCors(); +app.MapControllers(); + +app.Urls.Clear(); +app.Urls.Add(config.Address); + +app.Run(); + +Log.CloseAndFlush(); diff --git a/Foxnouns.Backend/config.ini b/Foxnouns.Backend/config.ini new file mode 100644 index 0000000..b0e71f3 --- /dev/null +++ b/Foxnouns.Backend/config.ini @@ -0,0 +1,20 @@ +; The host the server will listen on +Host = localhost +; The port the server will listen on +Port = 5000 +; The base *external* URL +BaseUrl = https://pronouns.localhost + +; The level to log things at. Valid settings: Verbose, Debug, Information, Warning, Error, Fatal +LogEventLevel = Verbose + +SeqLogUrl = http://localhost:5341 + +[Database] +; The database URL in ADO.NET format. +Url = "Host=localhost;Database=foxnouns_net;Username=pronouns;Password=pronouns" + +; The timeout for opening new connections. Defaults to 5. +Timeout = 5 +; The maximum number of open connections. Defaults to 50. +MaxPoolSize = 500 diff --git a/Foxnouns.NET.sln b/Foxnouns.NET.sln new file mode 100644 index 0000000..3b119c5 --- /dev/null +++ b/Foxnouns.NET.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Foxnouns.Backend", "Foxnouns.Backend\Foxnouns.Backend.csproj", "{439E3E38-5AEF-4F73-AD57-E32057B3FC7F}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {439E3E38-5AEF-4F73-AD57-E32057B3FC7F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {439E3E38-5AEF-4F73-AD57-E32057B3FC7F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {439E3E38-5AEF-4F73-AD57-E32057B3FC7F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {439E3E38-5AEF-4F73-AD57-E32057B3FC7F}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +.