diff options
| author | Jake Mannens <jake@asger.xyz> | 2025-08-17 22:10:27 +1000 |
|---|---|---|
| committer | Jake Mannens <jake@asger.xyz> | 2025-08-18 10:59:28 +1000 |
| commit | 6c53f3dc43f072dce4ffe4a1bd306074dd20ff39 (patch) | |
| tree | 494335104504dca462a3837c3993e2add8e72bad | |
Initial commit
| -rw-r--r-- | .config/dotnet-tools.json | 12 | ||||
| -rw-r--r-- | .editorconfig | 4 | ||||
| -rw-r--r-- | .gitattributes | 63 | ||||
| -rw-r--r-- | .gitignore | 365 | ||||
| -rw-r--r-- | ApiRecords.cs | 53 | ||||
| -rw-r--r-- | ConfigService.cs | 80 | ||||
| -rw-r--r-- | DbMedia.cs | 42 | ||||
| -rw-r--r-- | DbObject.cs | 15 | ||||
| -rw-r--r-- | DbTag.cs | 23 | ||||
| -rw-r--r-- | DebugController.cs | 22 | ||||
| -rw-r--r-- | Enum.cs | 13 | ||||
| -rw-r--r-- | HyperBooru.cs | 36 | ||||
| -rw-r--r-- | HyperBooruContext.cs | 24 | ||||
| -rw-r--r-- | LICENSE.txt | 661 | ||||
| -rw-r--r-- | MediaController.cs | 194 | ||||
| -rw-r--r-- | Pages/Index.cshtml | 15 | ||||
| -rw-r--r-- | Pages/Index.cshtml.cs | 15 | ||||
| -rw-r--r-- | Pages/Index.cshtml.css | 7 | ||||
| -rw-r--r-- | Pages/Shared/_Layout.cshtml | 25 | ||||
| -rw-r--r-- | Pages/Shared/_Layout.cshtml.css | 18 | ||||
| -rw-r--r-- | Pages/ViewMedia.cshtml | 88 | ||||
| -rw-r--r-- | Pages/ViewMedia.cshtml.cs | 23 | ||||
| -rw-r--r-- | Pages/ViewMedia.cshtml.css | 52 | ||||
| -rw-r--r-- | Pages/_ViewStart.cshtml | 3 | ||||
| -rw-r--r-- | Properties/launchSettings.json | 31 | ||||
| -rw-r--r-- | Server.csproj | 19 | ||||
| -rw-r--r-- | TagController.cs | 89 | ||||
| -rw-r--r-- | appsettings.Development.json | 8 | ||||
| -rw-r--r-- | appsettings.json | 9 | ||||
| -rw-r--r-- | wwwroot/styles/global.css | 63 |
30 files changed, 2072 insertions, 0 deletions
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 0000000..34c3e19 --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "dotnet-ef": { + "version": "7.0.5", + "commands": [ + "dotnet-ef" + ] + } + } +}
\ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..6d8f727 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,4 @@ +[*.cs] + +# CS8618: Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable. +dotnet_diagnostic.CS8618.severity = silent diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e6e4b24 --- /dev/null +++ b/.gitignore @@ -0,0 +1,365 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Oo]ut/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +Data/
\ No newline at end of file diff --git a/ApiRecords.cs b/ApiRecords.cs new file mode 100644 index 0000000..69160c5 --- /dev/null +++ b/ApiRecords.cs @@ -0,0 +1,53 @@ +namespace HyperBooru.ApiRecords; + +public class TagInfo { + public string Id { get; init; } + public string? Namespace { get; init; } + public string Name { get; init; } + public bool IsImplicit { get; init; } +} + +public class MediaInfo { + public string Id { get; init; } + public string Checksum { get; init; } + public string MimeType { get; init; } + public string? ShortDescription { get; init; } + public string? LongDescription { get; init; } + + public UploadedFileInfo[] UploadedFileHistory { get; init; } + + public MediaInfo(DbMedia media) { + Id = media.Guid.ToString(); + Checksum = media.Checksum; + MimeType = media.MimeType; + ShortDescription = media.ShortDescription; + LongDescription = media.LongDescription; + + UploadedFileHistory = media.UploadedFiles + .Select(uf => new UploadedFileInfo(uf)) + .ToArray(); + } +} + +public record MediaUpdateInfo { + public string? ShortDescription { get; init; } + public string? LongDescription { get; init; } +} + +public class UploadedFileInfo { + public string Checksum { get; init; } + public string? Filename { get; init; } + public DateTime UploadTime { get; init; } + public DateTime? LastAccessTime { get; init; } + public DateTime? LastWriteTime { get; init; } + public DateTime? CreateTime { get; init; } + + public UploadedFileInfo(DbUploadedFile uploadedFile) { + Checksum = uploadedFile.OriginalChecksum; + Filename = uploadedFile.Filename; + UploadTime = uploadedFile.UploadTime; + LastAccessTime = uploadedFile.LastAccessTime; + LastWriteTime = uploadedFile.LastWriteTime; + CreateTime = uploadedFile.CreateTime; + } +}
\ No newline at end of file diff --git a/ConfigService.cs b/ConfigService.cs new file mode 100644 index 0000000..0ee4113 --- /dev/null +++ b/ConfigService.cs @@ -0,0 +1,80 @@ +namespace HyperBooru; + +public interface IConfigService { + public string DataPath { get; } + public string DbPath { get; } + public string MediaBasePath { get; } + public string GetPath(DbMedia media); + public string GetPath(DbMedia media, int width, int height); +} + +public class ConfigService : IConfigService { + private IConfiguration config; + + private const string AppName = "HyperBooru"; + + public string DataPath { + get { + #if DEBUG + return "Data"; + #else + string? path = config["DataPath"]; + if(path is not null) + return path; + + switch(Environment.OSVersion.Platform) { + case PlatformID.Win32NT: + return Path.Join( + Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), + AppName); + case PlatformID.Unix: + return $"/var/lib/{AppName.ToLower()}"; + default: + throw new NotImplementedException( + $"Unknown Operating System: {Environment.OSVersion.Platform}"); + } + #endif + } + } + + public string DbPath => + Path.Join(DataPath, $"{AppName}.db"); + + public string MediaBasePath => + Path.Join(DataPath, "media"); + + public string ThumbnailBasePath => + Path.Join(DataPath, "thumb"); + + public ConfigService(IConfiguration config) { + this.config = config; + InitDirectoryStructure(); + } + + public string GetPath(DbMedia media) { + var fileInfo = new FileInfo(Path.Join( + MediaBasePath, + media.Guid.ToString().Substring(0, 2), + media.Guid.ToString().Substring(2, 2), + media.Guid.ToString())); + + Directory.CreateDirectory(fileInfo.Directory.FullName); + return fileInfo.FullName; + } + + public string GetPath(DbMedia media, int width, int height) { + var fileInfo = new FileInfo(Path.Join( + ThumbnailBasePath, + media.Guid.ToString().Substring(0, 2), + media.Guid.ToString().Substring(2, 2), + $"{media.Guid.ToString()}-{width}-{height}")); + + Directory.CreateDirectory(fileInfo.Directory.FullName); + return fileInfo.FullName; + } + + private void InitDirectoryStructure() { + Directory.CreateDirectory(DataPath); + Directory.CreateDirectory(MediaBasePath); + } +}
\ No newline at end of file diff --git a/DbMedia.cs b/DbMedia.cs new file mode 100644 index 0000000..311e412 --- /dev/null +++ b/DbMedia.cs @@ -0,0 +1,42 @@ +using Microsoft.AspNetCore.Mvc.ModelBinding.Binders; +using Microsoft.EntityFrameworkCore; +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; +using System.Net.NetworkInformation; + +namespace HyperBooru; + +public class DbMedia : DbObject { + public string Checksum { get; set; } + public string MimeType { get; set; } + public string? ShortDescription { get; set; } + public string? LongDescription { get; set; } + public virtual List<DbUploadedFile> UploadedFiles { get; set; } = new(); + + public DbMedia() => + base.ObjectType = ObjectType.Media; + + public string? DisplayName { + get { + if(ShortDescription is not null) + return ShortDescription; + + return UploadedFiles + .OrderBy(f => f.UploadTime) + .First()?.Filename; + } + } +} + +public record DbUploadedFile { + [Key] + [DatabaseGenerated(DatabaseGeneratedOption.Identity)] + public int UploadedFileId { get; set; } + public string OriginalChecksum { get; set; } + public string? Filename { get; set; } + public DateTime UploadTime { get; set; } = DateTime.Now; + public DateTime? LastAccessTime { get; set; } + public DateTime? LastWriteTime { get; set; } + public DateTime? CreateTime { get; set; } + public virtual DbMedia Media { get; set; } +}
\ No newline at end of file diff --git a/DbObject.cs b/DbObject.cs new file mode 100644 index 0000000..f07b866 --- /dev/null +++ b/DbObject.cs @@ -0,0 +1,15 @@ +using Microsoft.EntityFrameworkCore; +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; + +namespace HyperBooru; + +[Index(nameof(Guid))] +public class DbObject { + [Key] + [DatabaseGenerated(DatabaseGeneratedOption.Identity)] + public int ObjectId { get; set; } + public Guid Guid { get; set; } = Guid.NewGuid(); + public ObjectType ObjectType { get; set; } + public virtual List<DbTag> Tags { get; set; } +}
\ No newline at end of file diff --git a/DbTag.cs b/DbTag.cs new file mode 100644 index 0000000..4647f8e --- /dev/null +++ b/DbTag.cs @@ -0,0 +1,23 @@ +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; + +namespace HyperBooru; + +public class DbTagDefinition : DbObject { + public TagSource Source { get; set; } = TagSource.Internal; + public string? Namespace { get; set; } + public string Name { get; set; } + public virtual List<DbTagDefinition> ImplicitTags { get; set; } = new(); + + public DbTagDefinition() => + base.ObjectType = ObjectType.TagDefinition; +} + +public class DbTag : DbObject { + public virtual DbTagDefinition TagDefinition { get; set; } + public DateTime CreateTime { get; set; } = DateTime.Now; + public virtual DbObject Target { get; set; } + + public DbTag() => + base.ObjectType = ObjectType.Tag; +}
\ No newline at end of file diff --git a/DebugController.cs b/DebugController.cs new file mode 100644 index 0000000..7a87729 --- /dev/null +++ b/DebugController.cs @@ -0,0 +1,22 @@ +using Microsoft.AspNetCore.Mvc; + +namespace HyperBooru; + +#if DEBUG +[ApiController] +[Route("/debug")] +public class DebugController : Controller { + private HyperBooruDbContext db; + + public DebugController(HyperBooruDbContext db) => + this.db = db; + + [HttpGet("media")] + public IActionResult Media() => + Ok(db.Media.ToList()); + + [HttpGet("tags")] + public IActionResult TagDefinitions() => + Ok(db.Tags.ToList()); +} +#endif
\ No newline at end of file @@ -0,0 +1,13 @@ +namespace HyperBooru; + +public enum ObjectType { + TagDefinition, + Tag, + Media, + Collection +} + +public enum TagSource { + Internal, + UserTag +}
\ No newline at end of file diff --git a/HyperBooru.cs b/HyperBooru.cs new file mode 100644 index 0000000..9ccd323 --- /dev/null +++ b/HyperBooru.cs @@ -0,0 +1,36 @@ +using System.Text.Json.Serialization; + +namespace HyperBooru; + +public class HyperBooru { + public static void Main(string[] args) { + var builder = WebApplication.CreateBuilder(); + builder.Services.AddEndpointsApiExplorer(); + builder.Services.AddSwaggerGen(); + builder.Services.AddControllers().AddJsonOptions(o => { + var converter = new JsonStringEnumConverter(); + o.JsonSerializerOptions.Converters.Add(converter); + }); + builder.Services.AddRazorPages(); + builder.Services.AddSingleton<IConfigService, ConfigService>(); + builder.Services.AddScoped<HyperBooruDbContext>(p => + new HyperBooruDbContext(p.GetRequiredService<IConfigService>())); + + var app = builder.Build(); + + using var scope = app.Services.CreateScope(); + using var db = scope.ServiceProvider.GetRequiredService<HyperBooruDbContext>(); + db.Database.EnsureCreated(); + + #if DEBUG + app.UseSwagger(); + app.UseSwaggerUI(); + #endif + + app.MapRazorPages(); + app.UseStaticFiles(); + app.UseHttpsRedirection(); + app.MapControllers(); + app.Run(); + } +}
\ No newline at end of file diff --git a/HyperBooruContext.cs b/HyperBooruContext.cs new file mode 100644 index 0000000..8223ee3 --- /dev/null +++ b/HyperBooruContext.cs @@ -0,0 +1,24 @@ +using Microsoft.EntityFrameworkCore; +using System.Text.Json; + +namespace HyperBooru; + +public class HyperBooruDbContext : DbContext { + public DbSet<DbObject> Objects { get; set; } + public DbSet<DbTagDefinition> TagDefinitions { get; set; } + public DbSet<DbTag> Tags { get; set; } + public DbSet<DbMedia> Media { get; set; } + public DbSet<DbUploadedFile> UploadedFiles { get; set; } + + private IConfigService config; + + public HyperBooruDbContext(IConfigService config) => + this.config = config; + + protected override void OnConfiguring(DbContextOptionsBuilder options) { + options.UseLazyLoadingProxies(); + + var path = Path.Join(config.DataPath, "HyperBooru.db"); + options.UseSqlite($"Data Source = {config.DbPath}"); + } +}
\ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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 +<https://www.gnu.org/licenses/>. diff --git a/MediaController.cs b/MediaController.cs new file mode 100644 index 0000000..29a8f88 --- /dev/null +++ b/MediaController.cs @@ -0,0 +1,194 @@ +using HyperBooru.ApiRecords; +using ImageMagick; +using Microsoft.AspNetCore.Mvc; +using MimeDetective; +using System.Security.Cryptography; + +namespace HyperBooru; + +[ApiController] +[Route("/media")] +public class MediaController : Controller { + private IConfigService config; + private HyperBooruDbContext db; + + private ContentInspector inspector; + + public MediaController(IConfigService config, HyperBooruDbContext db) { + this.config = config; + this.db = db; + + ContentInspectorBuilder inspectorBuilder = new() { + Definitions = + MimeDetective.Definitions.Default.FileTypes.Images.All() + .Union(MimeDetective.Definitions.Default.FileTypes.Video.All()) + .ToList() + }; + + inspector = inspectorBuilder.Build(); + } + + [HttpGet("list")] + public IActionResult EnumerateMedia() => + Ok(db.Media.Select(m => m.ObjectId).ToArray()); + + [HttpGet("{mediaId}")] + public IActionResult Fetch([FromRoute] Guid mediaId) { + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + var fs = System.IO.File.OpenRead(config.GetPath(media)); + + return new FileStreamResult(fs, media.MimeType); + } + + [HttpGet("thumb/{mediaId}")] + public IActionResult Thumbnail( + [FromRoute] Guid mediaId, + [FromQuery] int? w, + [FromQuery] int? h) { + + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + if(media.MimeType.Split("/")[0] != "image") + return BadRequest("Media object not an image"); + + using var image = new MagickImage(config.GetPath(media)); + + if(w is null && h is null) + return BadRequest("Both width and height cannot be null!"); + + if(w > image.Width || h > image.Height) + return BadRequest("Requested thumbnail size is larger than original media"); + + int width = (int) (w is not null ? w : image.Width * h / image.Height); + int height = (int) (h is not null ? h : image.Height * w / image.Width); + + var thumbPath = config.GetPath(media, width, height); + + if(!System.IO.File.Exists(thumbPath)) { + image.Resize(new MagickGeometry(width, height)); + image.Write(thumbPath); + } + + var fs = System.IO.File.OpenRead(thumbPath); + + return new FileStreamResult(fs, "image/jpeg"); + } + + [HttpDelete("{mediaId}")] + public IActionResult Delete([FromRoute] Guid mediaId) { + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + System.IO.File.Delete(config.GetPath(media)); + + db.Media.Remove(media); + db.SaveChanges(); + return Ok(); + } + + [HttpGet("{mediaId}/info")] + public IActionResult GetInfo([FromRoute] Guid mediaId) { + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + return Ok(new MediaInfo(media)); + } + + [HttpPatch("{mediaId}/info")] + public IActionResult UpdateInfo( + [FromRoute] Guid mediaId, + [FromBody] MediaUpdateInfo updateInfo) { + + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + if(updateInfo.ShortDescription is not null) + media.ShortDescription = updateInfo.ShortDescription; + if(updateInfo.LongDescription is not null) + media.LongDescription = updateInfo.LongDescription; + + db.Update(media); + + db.SaveChanges(); + + return Ok(); + } + + [HttpPost] + public IActionResult Upload( + [FromForm] string? checksum, + [FromForm] DateTime? lastAccessTime, + [FromForm] DateTime? lastWriteTime, + [FromForm] DateTime? createTime) { + + using var transaction = db.Database.BeginTransaction(); + + var formFile = Request.Form.Files[0]; + if(formFile.Length < 1) + return BadRequest("Empty file"); + + var formStream = formFile.OpenReadStream(); + + // Calculate the checksum using the in-memory file contents + var hash = BitConverter + .ToString(MD5.Create().ComputeHash(formStream)) + .Replace("-", "") + .ToLower(); + + if(checksum is not null && hash != checksum.ToLower()) + return BadRequest("Checksum does not match"); + + var fileRecord = new DbUploadedFile() { + Filename = formFile.FileName, + OriginalChecksum = hash, + UploadTime = DateTime.Now, + LastAccessTime = lastAccessTime, + LastWriteTime = lastWriteTime, + CreateTime = createTime + }; + + formStream.Seek(0, SeekOrigin.Begin); + var defs = inspector.Inspect(formStream); + + var mime = defs.ByMimeType().FirstOrDefault()?.MimeType; + if(mime is null) + return BadRequest("Unsupported file type"); + + var media = db.Media + .FirstOrDefault(m => m.Checksum == hash); + + if(media is null) { + media = new() { + Checksum = hash, + MimeType = mime, + UploadedFiles = new() { + fileRecord + } + }; + + using var newFile = System.IO.File.Create(config.GetPath(media)); + + formStream.Seek(0, SeekOrigin.Begin); + formStream.CopyTo(newFile); + newFile.Flush(); + + db.Media.Add(media); + } else { + media.UploadedFiles.Add(fileRecord); + db.Update(media); + } + + db.SaveChanges(); + transaction.Commit(); + + return Ok(media.Guid); + } +}
\ No newline at end of file diff --git a/Pages/Index.cshtml b/Pages/Index.cshtml new file mode 100644 index 0000000..80e05d9 --- /dev/null +++ b/Pages/Index.cshtml @@ -0,0 +1,15 @@ +@page +@model HyperBooru.Pages.IndexModel + +<link rel="stylesheet" type="text/css" href="@(nameof(HyperBooru)).styles.css"/> + +<form id="upload" action="/media" method="post" enctype="multipart/form-data"> + <input type="file" id="myFile" name="filename"/> + <input type="submit" /> +</form> + +@foreach(var media in Model.Media) { + <a href="/ViewMedia?m=@(media.Guid)"> + <img src="/media/thumb/@(media.Guid)?h=200" /> + </a> +}
\ No newline at end of file diff --git a/Pages/Index.cshtml.cs b/Pages/Index.cshtml.cs new file mode 100644 index 0000000..e03a330 --- /dev/null +++ b/Pages/Index.cshtml.cs @@ -0,0 +1,15 @@ +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.RazorPages; + +namespace HyperBooru.Pages; + +public class IndexModel : PageModel { + public IEnumerable<DbMedia> Media => db.Media; + + private HyperBooruDbContext db; + + public IndexModel(HyperBooruDbContext db) => + this.db = db; + + public void OnGet() {} +}
\ No newline at end of file diff --git a/Pages/Index.cshtml.css b/Pages/Index.cshtml.css new file mode 100644 index 0000000..f573988 --- /dev/null +++ b/Pages/Index.cshtml.css @@ -0,0 +1,7 @@ +img { + max-height: 200px; +} + +form#upload { + padding-bottom: 30px; +}
\ No newline at end of file diff --git a/Pages/Shared/_Layout.cshtml b/Pages/Shared/_Layout.cshtml new file mode 100644 index 0000000..be445cc --- /dev/null +++ b/Pages/Shared/_Layout.cshtml @@ -0,0 +1,25 @@ +@{ + ViewBag.Title ??= "HyperBooru"; + ViewBag.ContentScroll ??= true; + ViewBag.ContentMargin ??= "30px"; +} + +<!DOCTYPE html> + +<html> +<head> + <meta name="viewport" content="width=device-width"/> + <link rel="stylesheet" type="text/css" href="/styles/global.css"/> + <link rel="stylesheet" type="text/css" href="@(nameof(HyperBooru)).styles.css"/> + <title>@ViewBag.Title</title> +</head> + <body> + <div id="navbar"> + <a href="/">Home</a> + <a href="/tags">Tags</a> + </div> + <div id="content" style="overflow:@(ViewBag.ContentScroll ? "auto" : "hidden");margin:@(ViewBag.ContentMargin ?? "0");"> + @RenderBody() + </div> + </body> +</html>
\ No newline at end of file diff --git a/Pages/Shared/_Layout.cshtml.css b/Pages/Shared/_Layout.cshtml.css new file mode 100644 index 0000000..5b2ba65 --- /dev/null +++ b/Pages/Shared/_Layout.cshtml.css @@ -0,0 +1,18 @@ +div#navbar { + background: var(--col-navbar-bg); + box-shadow: rgba(0, 0, 0, 0.5) 0px 10px 10px; +} + +div#navbar > a { + display: inline-block; + padding: 20px 20px 20px 20px; +} + +div#navbar > a:hover { + background: rgba(255, 255, 255, 0.4); +} + +div#navbar > a:active { + background: #fff; + color: var(--col-navbar-bg); +}
\ No newline at end of file diff --git a/Pages/ViewMedia.cshtml b/Pages/ViewMedia.cshtml new file mode 100644 index 0000000..967759b --- /dev/null +++ b/Pages/ViewMedia.cshtml @@ -0,0 +1,88 @@ +@page +@model HyperBooru.Pages.ViewMediaModel +@{ + ViewBag.ContentScroll = false; +} + +<link rel="stylesheet" type="text/css" href="@(nameof(HyperBooru)).styles.css"/> + +<script> + async function deleteMedia() { + var mediaId = new URL(window.location.href).searchParams.get('m'); + var resp = await fetch('/media/' + mediaId, { method: 'delete' }); + if(resp.ok) { + window.location.href = '/'; + } else { + alert('Failed to delete media object!'); + } + } + + function selectPane(tab) { + var tabs = Array.from(document.querySelectorAll('div#metadata-header > a')); + + var panes = Array.from(document.querySelectorAll('div#metadata > div')) + .filter(x => x.id != 'metadata-header'); + var pane = panes.filter(x => x.id == tab.dataset.pane)[0]; + + for(var t of tabs) { + if(t == tab) + t.classList.add('selected'); + else + t.classList.remove('selected'); + } + + for(var p of panes) { + if(p == pane) + p.classList.add('selected'); + else + p.classList.remove('selected'); + } + } +</script> + +<div id="content"> + <img src="/media/@(Model.Media.Guid)"/> + <div id="metadata"> + <div id="metadata-header"> + <a href="javascript:;" onclick="selectPane(this);" data-pane="metadata-fileinfo">File Info</a> + <a href="javascript:;" onclick="selectPane(this);" data-pane="metadata-tags" class="selected">Tags</a> + </div> +@* <form method="post"> + <label for="shortDescription">Short Description</label> + <input type="text" name="shortDescription" placeholder="@Model.Media.ShortDescription"/> + <label for="longDescription">Long Description</label> + <input type="text" name="longDescription" placeholder="@Model.Media.LongDescription"/> + <input type="submit" value="Update"/> + </form>*@ + <div id="metadata-fileinfo"> + <p>Upload history</p> + <hr /> + <table class="data-table"> + <tr> + <th>Created On</th> + <th>Last Write</th> + <th>Uploaded On</th> + <th>Filename</th> + <th>Original Checksum</th> + </tr> + @foreach(var file in Model.Media.UploadedFiles) { + <tr> + <td>@(file.CreateTime?.ToString() ?? "N/A")</td> + <td>@(file.LastWriteTime?.ToString() ?? "N/A")</td> + <td>@file.UploadTime</td> + <td>@file.Filename</td> + <td>@file.OriginalChecksum</td> + </tr> + } + </table> + </div> + <div id="metadata-tags" class="selected"> + <table class="data-table"> + <tr> + <th>Tag Name</th> + </tr> + </table> + <button>Add Tag</button> + </div> + </div> +</div>
\ No newline at end of file diff --git a/Pages/ViewMedia.cshtml.cs b/Pages/ViewMedia.cshtml.cs new file mode 100644 index 0000000..fe8d150 --- /dev/null +++ b/Pages/ViewMedia.cshtml.cs @@ -0,0 +1,23 @@ +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.RazorPages; + +namespace HyperBooru.Pages; + +public class ViewMediaModel : PageModel { + public DbMedia Media { get; private set; } + + private HyperBooruDbContext db; + + public ViewMediaModel(HyperBooruDbContext db) => + this.db = db; + + public IActionResult OnGet([FromQuery(Name = "m")] Guid mediaId) { + var media = db.Media.First(m => m.Guid == mediaId); + if(media is null) + return NotFound(); + + Media = media; + + return Page(); + } +}
\ No newline at end of file diff --git a/Pages/ViewMedia.cshtml.css b/Pages/ViewMedia.cshtml.css new file mode 100644 index 0000000..ff8a1cd --- /dev/null +++ b/Pages/ViewMedia.cshtml.css @@ -0,0 +1,52 @@ +div#content { + display: flex; + align-items: start; + height: 100%; +} + +div#content > img { + max-width: 60%; + height: 100%; + object-fit: contain; +} + +div#metadata { + margin-left: 15px; + width: 100%; +} + +div#metadata > div { + display: none; +} + +div#metadata > div.selected { + display: inherit !important; +} + +div#metadata-header { + display: inherit !important; + border-bottom: 1px solid white; +} + +div#metadata-header > a { + display: inline-block; + padding: 10px 10px 9px 10px; +} + +div#metadata-header > a.selected { + border-bottom: 4px solid white; + padding-bottom: 5px; +} + +div#metadata-header > a:hover { + background: rgba(255, 255, 255, 0.4); +} + +div#metadata-fileinfo > table th { + font-size: 8pt; +} + +div#metadata-fileinfo > table td { + font-family: 'Lucida Console'; + font-size: 8pt; +}
\ No newline at end of file diff --git a/Pages/_ViewStart.cshtml b/Pages/_ViewStart.cshtml new file mode 100644 index 0000000..1af6e49 --- /dev/null +++ b/Pages/_ViewStart.cshtml @@ -0,0 +1,3 @@ +@{ + Layout = "_Layout"; +}
\ No newline at end of file diff --git a/Properties/launchSettings.json b/Properties/launchSettings.json new file mode 100644 index 0000000..696a6ea --- /dev/null +++ b/Properties/launchSettings.json @@ -0,0 +1,31 @@ +{ + "profiles": { + "HyperBooru": { + "commandName": "Project", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "applicationUrl": "https://localhost:7284", + "dotnetRunMessages": true, + "nativeDebugging": false + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "launchUrl": "swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + }, + "$schema": "https://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:62281", + "sslPort": 44394 + } + } +}
\ No newline at end of file diff --git a/Server.csproj b/Server.csproj new file mode 100644 index 0000000..7917674 --- /dev/null +++ b/Server.csproj @@ -0,0 +1,19 @@ +<Project Sdk="Microsoft.NET.Sdk.Web"> + + <PropertyGroup> + <TargetFramework>net7.0</TargetFramework> + <Nullable>enable</Nullable> + <ImplicitUsings>enable</ImplicitUsings> + <AssemblyName>HyperBooru</AssemblyName> + <RootNamespace>HyperBooru</RootNamespace> + </PropertyGroup> + + <ItemGroup> + <PackageReference Include="Magick.NET-Q16-AnyCPU" Version="13.5.0" /> + <PackageReference Include="Microsoft.EntityFrameworkCore" Version="7.0.7" /> + <PackageReference Include="Microsoft.EntityFrameworkCore.Proxies" Version="7.0.7" /> + <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="7.0.7" /> + <PackageReference Include="Mime-Detective" Version="23.6.1" /> + <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" /> + </ItemGroup> +</Project> diff --git a/TagController.cs b/TagController.cs new file mode 100644 index 0000000..b97b066 --- /dev/null +++ b/TagController.cs @@ -0,0 +1,89 @@ +using Microsoft.AspNetCore.Mvc; + +namespace HyperBooru; + +[ApiController] +[Route("tag")] +public class TagController : Controller { + private HyperBooruDbContext db; + + public TagController(HyperBooruDbContext db) => + this.db = db; + + [HttpPost("{objectId}/{tagId}")] + public IActionResult AddTag([FromRoute] Guid objectId, [FromRoute] Guid tagId) { + var obj = db.Objects.First(o => o.Guid == objectId); + var def = db.TagDefinitions.First(d => d.Guid == tagId); + + if(obj is null || def is null) + return NotFound(); + + bool alreadyTagged = obj.Tags + .Select(t => t.TagDefinition.Guid) + .Contains(def.Guid); + + if(alreadyTagged) + return BadRequest(); + + obj.Tags.Add(new() { + TagDefinition = def, + Target = obj + }); + + db.SaveChanges(); + + return Ok(); + } + + [HttpDelete("{objectId}/{tagId}")] + public IActionResult RemoveTag([FromRoute] Guid objectId, [FromRoute] Guid tagId) { + var obj = db.Objects.First(o => o.Guid == objectId); + + if(obj is null) + return NotFound(); + + var tag = obj.Tags + .First(t => t.Guid == tagId || t.TagDefinition.Guid == tagId); + + if(tag is null) + return NotFound(); + + obj.Tags.Remove(tag); + db.SaveChanges(); + + return Ok(); + } + + [HttpPost("def")] + public void CreateTagDefinition( + [FromForm] string name, + [FromForm] string? @namespace) { + + DbTagDefinition tagdef = new() { + Source = TagSource.UserTag, + Namespace = @namespace, + Name = name + }; + if(!db.TagDefinitions.Contains(tagdef)) + db.TagDefinitions.Add(tagdef); + db.SaveChanges(); + } + + [HttpDelete("def/{tagId}")] + public IActionResult DeleteTagDefinition([FromRoute] Guid tagId) { + var tagdef = db.TagDefinitions.First(td => td.Guid == tagId); + if(tagdef is null) + return NotFound(); + + using var transaction = db.Database.BeginTransaction(); + + db.Tags.RemoveRange( + db.Tags.Where(t => t.TagDefinition == tagdef)); + db.TagDefinitions.Remove(tagdef); + db.SaveChanges(); + + transaction.Commit(); + + return Ok(); + } +}
\ No newline at end of file diff --git a/appsettings.Development.json b/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/appsettings.json b/appsettings.json new file mode 100644 index 0000000..10f68b8 --- /dev/null +++ b/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/wwwroot/styles/global.css b/wwwroot/styles/global.css new file mode 100644 index 0000000..4a76f87 --- /dev/null +++ b/wwwroot/styles/global.css @@ -0,0 +1,63 @@ +:root { + --col-bg: #222; + --col-navbar-bg: magenta; +} + +body { + margin: 0; + background: var(--col-bg); + color: white; + font-family: 'Trebuchet MS', 'Lucida Sans Unicode'; +} + +a { + color: white; + text-decoration: none; +} + +input { + color: white; + box-sizing: border-box; + border: 1px solid #aaa; + background: rgba(0, 0, 0, 0.3); + border-radius: 5px; +} + +button { + background: #f0f; + border-radius: 10px; + border: none; + box-sizing: border-box; + height: 30px; + padding: 0 7px 0 7px; +} + +button:hover { + background: #f8f; +} + +button:active { + background: #fff; +} + +table.data-table { + border-collapse: collapse; + width: 100%; +} + +table.data-table > tbody > tr > th { + border-bottom: 1px solid white; + padding: 4px; +} + +table.data-table > tbody > tr > td { + padding: 4px; +} + +table.data-table > tbody > tr:nth-child(2n):not(:last-child) { + background: rgba(255, 255, 255, 0.2); +} + +table.data-table > tbody > tr > td:not(:last-child) { + border-right: 1px solid white; +}
\ No newline at end of file |