diff options
| -rw-r--r-- | .gitattributes | 63 | ||||
| -rw-r--r-- | .gitignore | 363 | ||||
| -rw-r--r-- | ApiModels.cs | 48 | ||||
| -rw-r--r-- | ApiModels.csproj | 15 | ||||
| -rw-r--r-- | Attributes.cs | 9 | ||||
| -rw-r--r-- | Exception.cs | 86 | ||||
| -rw-r--r-- | Feed.cs | 28 | ||||
| -rw-r--r-- | MediaUpload.cs | 15 |
8 files changed, 627 insertions, 0 deletions
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..9491a2f --- /dev/null +++ b/.gitignore @@ -0,0 +1,363 @@ +## 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
\ No newline at end of file diff --git a/ApiModels.cs b/ApiModels.cs new file mode 100644 index 0000000..2738c83 --- /dev/null +++ b/ApiModels.cs @@ -0,0 +1,48 @@ +using System.Text.Json.Serialization; + +namespace HyperBooru.ApiModels; + +public enum PathType { + Windows, + Unix +} + +public record Media { + public Guid MediaId { get; init; } + public string? ShortDescription { get; init; } + public string? LongDescription { get; init; } +} + +public record UploadedFile { + public Guid UploadedFileId { get; init; } + public Guid MediaId { get; init; } + public string Checksum { get; init; } + public bool ChecksumVerified { get; init; } + public string? Filename { get; init; } + public long Length { get; init; } + public string MimeType { get; init; } + public int? Width { get; init; } + public int? Height { get; init; } + public DateTime UploadTime { get; init; } + public DateTime? LastAccessTime { get; init; } + public DateTime? LastWriteTime { get; init; } + public DateTime? CreateTime { get; init; } + public string? Path { get; init; } + [JsonConverter(typeof(JsonStringEnumConverter))] + public PathType? PathType { get; init; } +} + +public record TagDefinition { + public Guid TagDefinitionId { get; init; } + public string? Namespace { get; init; } + public string Name { get; init; } + public string? Alias { get; init; } + public Guid[] ImplicitTags { get; init; } +} + +public record OcrData { + public Guid MediaId { get; init; } + public string Text { get; init; } + public string SearchableText { get; init; } + public DateTime Timestamp { get; init; } +} diff --git a/ApiModels.csproj b/ApiModels.csproj new file mode 100644 index 0000000..5871030 --- /dev/null +++ b/ApiModels.csproj @@ -0,0 +1,15 @@ +<Project Sdk="Microsoft.NET.Sdk"> + + <PropertyGroup> + <TargetFramework>net8.0</TargetFramework> + <ImplicitUsings>enable</ImplicitUsings> + <Nullable>enable</Nullable> + <AssemblyTitle>HyperBooru.ApiModels</AssemblyTitle> + <RootNamespace>HyperBooru.ApiModels</RootNamespace> + <AssemblyName>HyperBooru.ApiModels</AssemblyName> + <AssemblyVersion>0.13.0.0</AssemblyVersion> + <FileVersion>$(AssemblyVersion)</FileVersion> + <Version>0.13-alpha</Version> + </PropertyGroup> + +</Project> diff --git a/Attributes.cs b/Attributes.cs new file mode 100644 index 0000000..87ec2d6 --- /dev/null +++ b/Attributes.cs @@ -0,0 +1,9 @@ +namespace HyperBooru.ApiModels; + +[AttributeUsage(AttributeTargets.Class)] +public class ExceptionStatusCodeAttribute : Attribute { + public int StatusCode { get; set; } + + public ExceptionStatusCodeAttribute(int statusCode) => + StatusCode = statusCode; +} diff --git a/Exception.cs b/Exception.cs new file mode 100644 index 0000000..5299522 --- /dev/null +++ b/Exception.cs @@ -0,0 +1,86 @@ +using System.Text.Json.Serialization; + +namespace HyperBooru.ApiModels; + +[JsonPolymorphic(TypeDiscriminatorPropertyName = "$type")] +[JsonDerivedType(typeof(MediaCreateException), typeDiscriminator: "mediaCreateException")] +[JsonDerivedType(typeof(MediaException), typeDiscriminator: "mediaException")] +[JsonDerivedType(typeof(ObjectNotFoundException), typeDiscriminator: "objectNotFoundException")] +[JsonDerivedType(typeof(TagDuplicateException), typeDiscriminator: "tagDuplicateException")] +[JsonDerivedType(typeof(TagException), typeDiscriminator: "tagException")] +[JsonDerivedType(typeof(ThumbnailException), typeDiscriminator: "thumbnailException")] +public class HBException : Exception { + public HBException() + : base() {} + [JsonConstructor] + public HBException(string message) + : base(message) {} + public HBException(string message, Exception inner) + : base(message, inner) {} +} + +[ExceptionStatusCode(404)] +public class ObjectNotFoundException : HBException { + public Guid Guid { get; } + + [JsonConstructor] + public ObjectNotFoundException(Guid guid) + : base($"Object not found: {guid}") { + + Guid = guid; + } +} + +public class TagException : HBException { + public Guid? TagDefinitionId { get; } + + public TagException(string message) : base(message) {} + [JsonConstructor] + public TagException(string message, Guid? tagDefinitionId) + : base(message) => + TagDefinitionId = tagDefinitionId; +} + +[ExceptionStatusCode(400)] +public class TagDuplicateException : TagException { + public bool NameExists { get; } + public bool AliasExists { get; } + + [JsonConstructor] + public TagDuplicateException(bool nameExists, bool aliasExists) + : base(GenerateMessage(nameExists, aliasExists)) { + + NameExists = nameExists; + AliasExists = aliasExists; + } + + private static string GenerateMessage(bool nameExists, bool aliasExists) { + if(nameExists && aliasExists) + return $"Both tag name and alias already exist!"; + else if(nameExists) + return $"Tag name already exists!"; + else + return $"Tag alias already exists"; + } +} + +public class MediaException : HBException { + public Guid? MediaId { get; } + + public MediaException(string message) : base(message) {} + [JsonConstructor] + public MediaException(string message, Guid? mediaId) : base(message) => + MediaId = mediaId; +} + +public class MediaCreateException : MediaException { + [JsonConstructor] + public MediaCreateException(string message) + : base(message) {} +} + +public class ThumbnailException : MediaException { + [JsonConstructor] + public ThumbnailException(string message, Guid mediaId) + : base(message, mediaId) {} +} @@ -0,0 +1,28 @@ +using System.Text.Json.Serialization; + +namespace HyperBooru.ApiModels; + +public enum SortOrder { + ObjectId, + LastWriteTime, + Random, +} + +[JsonPolymorphic] +[JsonDerivedType(typeof(FeedSearchRequest), "FeedSearchRequest")] +[JsonDerivedType(typeof(FeedTagRequest), "FeedTagRequest")] +public record FeedRequest { + public bool SelectIngest { get; init; } + public bool IncludeNsfw { get; init; } + public Media? Key { get; init; } = null; + public int Count { get; init; } = 50; + public SortOrder SortOrder { get; init; } = SortOrder.ObjectId; +} + +public record FeedSearchRequest : FeedRequest { + public string Query { get; init; } +} + +public record FeedTagRequest : FeedRequest { + public Guid TagId { get; init; } +} diff --git a/MediaUpload.cs b/MediaUpload.cs new file mode 100644 index 0000000..f9976de --- /dev/null +++ b/MediaUpload.cs @@ -0,0 +1,15 @@ +using System.Text.Json.Serialization; + +namespace HyperBooru.ApiModels; + +public record MediaUploadRequest { + public string? Checksum { get; init; } = null; + public DateTime? LastAccessTime { get; init; } = null; + public DateTime? LastWriteTime { get; init; } = null; + public DateTime? CreateTime { get; init; } = null; + public string? Path { get; init; } = null; + [JsonConverter(typeof(JsonStringEnumConverter))] + public PathType? PathType { get; init; } = null; + public Guid[]? Tags { get; init; } = null; + public bool IsIngest { get; init; } = true; +} |