mirror of
https://github.com/jellyfin/jellyfin-plugin-opds.git
synced 2024-11-23 06:10:06 +00:00
init
This commit is contained in:
Cody Robibero
commit
9bdc7effcf
330
.gitignore
vendored
Normal file
330
.gitignore
vendored
Normal file
@ -0,0 +1,330 @@
|
||||
## 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
|
||||
*.suo
|
||||
*.user
|
||||
*.userosscache
|
||||
*.sln.docstates
|
||||
|
||||
# User-specific files (MonoDevelop/Xamarin Studio)
|
||||
*.userprefs
|
||||
|
||||
# Build results
|
||||
[Dd]ebug/
|
||||
[Dd]ebugPublic/
|
||||
[Rr]elease/
|
||||
[Rr]eleases/
|
||||
x64/
|
||||
x86/
|
||||
bld/
|
||||
[Bb]in/
|
||||
[Oo]bj/
|
||||
[Ll]og/
|
||||
|
||||
# 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
|
||||
|
||||
# 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/
|
||||
**/Properties/launchSettings.json
|
||||
|
||||
# StyleCop
|
||||
StyleCopReport.xml
|
||||
|
||||
# Files built by Visual Studio
|
||||
*_i.c
|
||||
*_p.c
|
||||
*_i.h
|
||||
*.ilk
|
||||
*.meta
|
||||
*.obj
|
||||
*.iobj
|
||||
*.pch
|
||||
*.pdb
|
||||
*.ipdb
|
||||
*.pgc
|
||||
*.pgd
|
||||
*.rsp
|
||||
*.sbr
|
||||
*.tlb
|
||||
*.tli
|
||||
*.tlh
|
||||
*.tmp
|
||||
*.tmp_proj
|
||||
*.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
|
||||
|
||||
# JustCode is a .NET coding add-in
|
||||
.JustCode
|
||||
|
||||
# TeamCity is a build add-in
|
||||
_TeamCity*
|
||||
|
||||
# DotCover is a Code Coverage Tool
|
||||
*.dotCover
|
||||
|
||||
# AxoCover is a Code Coverage Tool
|
||||
.axoCover/*
|
||||
!.axoCover/settings.json
|
||||
|
||||
# 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
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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/
|
||||
|
||||
# JetBrains Rider
|
||||
.idea/
|
||||
*.sln.iml
|
||||
|
||||
# CodeRush
|
||||
.cr/
|
||||
|
||||
# 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/
|
||||
16
Jellyfin.Plugin.Opds.sln
Normal file
16
Jellyfin.Plugin.Opds.sln
Normal file
@ -0,0 +1,16 @@
|
||||
|
||||
Microsoft Visual Studio Solution File, Format Version 12.00
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.Opds", "Jellyfin.Plugin.Opds\Jellyfin.Plugin.Opds.csproj", "{65BAE705-B80E-4177-AF3B-743DFFC18F87}"
|
||||
EndProject
|
||||
Global
|
||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||
Debug|Any CPU = Debug|Any CPU
|
||||
Release|Any CPU = Release|Any CPU
|
||||
EndGlobalSection
|
||||
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
||||
{65BAE705-B80E-4177-AF3B-743DFFC18F87}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{65BAE705-B80E-4177-AF3B-743DFFC18F87}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{65BAE705-B80E-4177-AF3B-743DFFC18F87}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
{65BAE705-B80E-4177-AF3B-743DFFC18F87}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||
EndGlobalSection
|
||||
EndGlobal
|
||||
31
Jellyfin.Plugin.Opds/Configuration/PluginConfiguration.cs
Normal file
31
Jellyfin.Plugin.Opds/Configuration/PluginConfiguration.cs
Normal file
@ -0,0 +1,31 @@
|
||||
using System;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Configuration
|
||||
{
|
||||
/// <summary>
|
||||
/// Opds plugin configuration.
|
||||
/// </summary>
|
||||
public class PluginConfiguration : BasePluginConfiguration
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PluginConfiguration"/> class.
|
||||
/// </summary>
|
||||
public PluginConfiguration()
|
||||
{
|
||||
AllowAnonymousAccess = false;
|
||||
// TODO don't hardcode, allow user to edit library id.
|
||||
BookLibraries = new[] { new Guid("4e985111ed7f570b595204d82adb02f3") };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the api should allow anonymous access.
|
||||
/// </summary>
|
||||
public bool AllowAnonymousAccess { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the list of book libraries.
|
||||
/// </summary>
|
||||
public Guid[] BookLibraries { get; set; }
|
||||
}
|
||||
}
|
||||
0
Jellyfin.Plugin.Opds/Configuration/Web/config.html
Normal file
0
Jellyfin.Plugin.Opds/Configuration/Web/config.html
Normal file
0
Jellyfin.Plugin.Opds/Configuration/Web/config.js
Normal file
0
Jellyfin.Plugin.Opds/Configuration/Web/config.js
Normal file
34
Jellyfin.Plugin.Opds/Jellyfin.Plugin.Opds.csproj
Normal file
34
Jellyfin.Plugin.Opds/Jellyfin.Plugin.Opds.csproj
Normal file
@ -0,0 +1,34 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net5.0</TargetFramework>
|
||||
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
||||
<FileVersion>1.0.0.0</FileVersion>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<Nullable>enable</Nullable>
|
||||
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
|
||||
<CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet>
|
||||
<NoWarn>CA1819</NoWarn>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Jellyfin.Controller" Version="10.*-*" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="5.*" PrivateAssets="All" />
|
||||
<PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
|
||||
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
|
||||
<PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All" />
|
||||
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Remove="Configuration\Web\config.html" />
|
||||
<EmbeddedResource Include="Configuration\Web\config.html" />
|
||||
<None Remove="Configuration\Web\config.js" />
|
||||
<EmbeddedResource Include="Configuration\Web\config.js" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
50
Jellyfin.Plugin.Opds/Models/AuthorDto.cs
Normal file
50
Jellyfin.Plugin.Opds/Models/AuthorDto.cs
Normal file
@ -0,0 +1,50 @@
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Author dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "author")]
|
||||
public class AuthorDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="AuthorDto"/> class.
|
||||
/// </summary>
|
||||
public AuthorDto()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="AuthorDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="name">The author name.</param>
|
||||
public AuthorDto(string name)
|
||||
{
|
||||
Name = name;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="AuthorDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="name">The author name.</param>
|
||||
/// <param name="uri">The author uri.</param>
|
||||
public AuthorDto(string name, string uri)
|
||||
{
|
||||
Name = name;
|
||||
Uri = uri;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the name.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "name")]
|
||||
public string? Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the uri.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "uri")]
|
||||
public string? Uri { get; set; }
|
||||
}
|
||||
}
|
||||
41
Jellyfin.Plugin.Opds/Models/ContentDto.cs
Normal file
41
Jellyfin.Plugin.Opds/Models/ContentDto.cs
Normal file
@ -0,0 +1,41 @@
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Content dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "content")]
|
||||
public class ContentDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ContentDto"/> class.
|
||||
/// </summary>
|
||||
protected ContentDto()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ContentDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="type">The content type.</param>
|
||||
/// <param name="text">The content text.</param>
|
||||
public ContentDto(string type, string text)
|
||||
{
|
||||
Type = type;
|
||||
Text = text;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the content type.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "type")]
|
||||
public string? Type { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the content text.
|
||||
/// </summary>
|
||||
[XmlText]
|
||||
public string? Text { get; set; }
|
||||
}
|
||||
}
|
||||
109
Jellyfin.Plugin.Opds/Models/EntryDto.cs
Normal file
109
Jellyfin.Plugin.Opds/Models/EntryDto.cs
Normal file
@ -0,0 +1,109 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Entry dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "entry")]
|
||||
public class EntryDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="EntryDto"/> class.
|
||||
/// </summary>
|
||||
protected EntryDto()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="EntryDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="title">The entry title.</param>
|
||||
/// <param name="id">The entry id.</param>
|
||||
/// <param name="updated">The entry update timestamp.</param>
|
||||
public EntryDto(
|
||||
string title,
|
||||
string id,
|
||||
DateTime updated)
|
||||
{
|
||||
Title = title;
|
||||
Id = id;
|
||||
Updated = updated;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="EntryDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="title">The entry title.</param>
|
||||
/// <param name="id">The entry id.</param>
|
||||
/// <param name="content">The entry content dto.</param>
|
||||
/// <param name="updated">The entry update timestamp.</param>
|
||||
public EntryDto(
|
||||
string title,
|
||||
string id,
|
||||
ContentDto content,
|
||||
DateTime updated)
|
||||
{
|
||||
Title = title;
|
||||
Id = id;
|
||||
Content = content;
|
||||
Updated = updated;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the entry title.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "title")]
|
||||
public string? Title { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the entry id.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "id")]
|
||||
public string? Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the updated timestamp.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "updated")]
|
||||
public DateTime Updated { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the entry content.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "content")]
|
||||
public ContentDto? Content { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the author.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName="author")]
|
||||
public AuthorDto? Author { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the publisher.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName="publisher")]
|
||||
public PublisherDto? Publisher { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the language.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName="language")]
|
||||
public string? Language { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the summary.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName="summary")]
|
||||
public string? Summary { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the list of links.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName="link")]
|
||||
public List<LinkDto>? Links { get; set; }
|
||||
}
|
||||
}
|
||||
61
Jellyfin.Plugin.Opds/Models/FeedDto.cs
Normal file
61
Jellyfin.Plugin.Opds/Models/FeedDto.cs
Normal file
@ -0,0 +1,61 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Feed dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "feed")]
|
||||
public class FeedDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the feed id.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "id")]
|
||||
public string? Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the updated timestamp.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "updated")]
|
||||
public DateTime Updated { get; set; } = DateTime.UtcNow;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the list of links.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "link")]
|
||||
public LinkDto[] Links { get; set; } = Array.Empty<LinkDto>();
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the title.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "title")]
|
||||
public string? Title { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the author.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "author")]
|
||||
public AuthorDto? Author { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the list of entries.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "entry")]
|
||||
public List<EntryDto>? Entries { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the xmlns attribute.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "xmlns")]
|
||||
public string Xmlns { get; set; } = "http://www.w3.org/2005/Atom";
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the xml text.
|
||||
/// </summary>
|
||||
[XmlText]
|
||||
public string? Text { get; set; }
|
||||
}
|
||||
}
|
||||
158
Jellyfin.Plugin.Opds/Models/LinkDto.cs
Normal file
158
Jellyfin.Plugin.Opds/Models/LinkDto.cs
Normal file
@ -0,0 +1,158 @@
|
||||
using System;
|
||||
using System.ComponentModel;
|
||||
using System.Globalization;
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// The link dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "link")]
|
||||
public class LinkDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LinkDto"/> class.
|
||||
/// </summary>
|
||||
protected LinkDto()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LinkDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="href">The link href.</param>
|
||||
/// <param name="type">The link type.</param>
|
||||
public LinkDto(string href, string type)
|
||||
{
|
||||
Href = href;
|
||||
Type = type;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LinkDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="rel">The link rel.</param>
|
||||
/// <param name="href">The link href.</param>
|
||||
/// <param name="type">The link type.</param>
|
||||
public LinkDto(string rel, string href, string type)
|
||||
{
|
||||
Rel = rel;
|
||||
Href = href;
|
||||
Type = type;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LinkDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="rel">The link rel.</param>
|
||||
/// <param name="href">The link href.</param>
|
||||
/// <param name="type">The link type.</param>
|
||||
/// <param name="title">The link title.</param>
|
||||
public LinkDto(string rel, string href, string type, string title)
|
||||
{
|
||||
Rel = rel;
|
||||
Href = href;
|
||||
Type = type;
|
||||
Title = title;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the link rel.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "rel")]
|
||||
public string? Rel { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the link destination.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "href")]
|
||||
public string? Href { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the link type.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "type")]
|
||||
public string? Type { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the link title.
|
||||
/// </summary>
|
||||
[XmlAttribute(AttributeName = "title")]
|
||||
public string? Title { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the file size.
|
||||
/// </summary>
|
||||
[XmlIgnore]
|
||||
public long? Length { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the string representation of the file size.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Xml is unable to serialize "Complex Types", so this is used for serialization.
|
||||
/// </remarks>
|
||||
[XmlAttribute(AttributeName = "length")]
|
||||
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||
public string? LengthStr
|
||||
{
|
||||
get => Length?.ToString(CultureInfo.InvariantCulture);
|
||||
set
|
||||
{
|
||||
switch (value)
|
||||
{
|
||||
case null:
|
||||
Length = null;
|
||||
break;
|
||||
case var l:
|
||||
{
|
||||
if (long.TryParse(l, out var val))
|
||||
{
|
||||
Length = val;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the book updated time.
|
||||
/// </summary>
|
||||
[XmlIgnore]
|
||||
public DateTime? UpdateTime { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the string representation of the file size.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Xml is unable to serialize "Complex Types", so this is used for serialization.
|
||||
/// </remarks>
|
||||
[XmlAttribute(AttributeName = "mtime")]
|
||||
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||
public string? UpdateTimeSTr
|
||||
{
|
||||
get => UpdateTime?.ToString(CultureInfo.InvariantCulture);
|
||||
set
|
||||
{
|
||||
switch (value)
|
||||
{
|
||||
case null:
|
||||
UpdateTime = null;
|
||||
break;
|
||||
case var l:
|
||||
{
|
||||
if (DateTime.TryParse(l, out var val))
|
||||
{
|
||||
UpdateTime = val;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
50
Jellyfin.Plugin.Opds/Models/PublisherDto.cs
Normal file
50
Jellyfin.Plugin.Opds/Models/PublisherDto.cs
Normal file
@ -0,0 +1,50 @@
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Publisher dto.
|
||||
/// </summary>
|
||||
[XmlRoot(ElementName = "publisher")]
|
||||
public class PublisherDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PublisherDto"/> class.
|
||||
/// </summary>
|
||||
public PublisherDto()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PublisherDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="name">The publisher name.</param>
|
||||
public PublisherDto(string name)
|
||||
{
|
||||
Name = name;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PublisherDto"/> class.
|
||||
/// </summary>
|
||||
/// <param name="name">The publisher name.</param>
|
||||
/// <param name="uri">The publisher uri.</param>
|
||||
public PublisherDto(string name, string uri)
|
||||
{
|
||||
Name = name;
|
||||
Uri = uri;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the name.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "name")]
|
||||
public string? Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the uri.
|
||||
/// </summary>
|
||||
[XmlElement(ElementName = "uri")]
|
||||
public string? Uri { get; set; }
|
||||
}
|
||||
}
|
||||
179
Jellyfin.Plugin.Opds/OpdsApi.cs
Normal file
179
Jellyfin.Plugin.Opds/OpdsApi.cs
Normal file
@ -0,0 +1,179 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Net.Http.Headers;
|
||||
using System.Text;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.Opds.Models;
|
||||
using Jellyfin.Plugin.Opds.Services;
|
||||
using MediaBrowser.Common.Extensions;
|
||||
using MediaBrowser.Controller.Authentication;
|
||||
using MediaBrowser.Controller.Library;
|
||||
using MediaBrowser.Model.Serialization;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.Net.Http.Headers;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds
|
||||
{
|
||||
/// <summary>
|
||||
/// Opds endpoints.
|
||||
/// </summary>
|
||||
[Route("opds")]
|
||||
public class OpdsApi : ControllerBase
|
||||
{
|
||||
private readonly IUserManager _userManager;
|
||||
private readonly IOpdsFeedProvider _opdsFeedProvider;
|
||||
private readonly IXmlSerializer _xmlSerializer;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="OpdsApi"/> class.
|
||||
/// </summary>
|
||||
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
|
||||
/// <param name="opdsFeedProvider">The opds feed provider.</param>
|
||||
/// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
|
||||
public OpdsApi(
|
||||
IUserManager userManager,
|
||||
OpdsFeedProvider opdsFeedProvider,
|
||||
IXmlSerializer xmlSerializer)
|
||||
{
|
||||
_userManager = userManager;
|
||||
_opdsFeedProvider = opdsFeedProvider;
|
||||
_xmlSerializer = xmlSerializer;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the root feed.
|
||||
/// </summary>
|
||||
/// <returns>The root feed xml.</returns>
|
||||
[HttpGet]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
public async Task<ActionResult> GetRootFeed()
|
||||
{
|
||||
await AuthorizeAsync().ConfigureAwait(false);
|
||||
var feeds = _opdsFeedProvider.GetFeeds();
|
||||
return BuildOutput(feeds);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of letters to filter by.
|
||||
/// </summary>
|
||||
/// <returns>The alphabetical feed xml.</returns>
|
||||
[HttpGet("books")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
public async Task<ActionResult> GetAlphabeticalRootFeed()
|
||||
{
|
||||
var userId = await AuthorizeAsync().ConfigureAwait(false);
|
||||
var feeds = _opdsFeedProvider.GetAlphabeticalFeed(userId);
|
||||
return BuildOutput(feeds);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of letters to filter by.
|
||||
/// </summary>
|
||||
/// <param name="startFilter">The start filter.</param>
|
||||
/// <returns>The alphabetical feed xml.</returns>
|
||||
[HttpGet("books/letter/{startFilter}")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
public async Task<ActionResult> GetAlphabeticalFeed(string startFilter)
|
||||
{
|
||||
await AuthorizeAsync().ConfigureAwait(false);
|
||||
var feeds = _opdsFeedProvider.GetAllBooks(startFilter);
|
||||
return BuildOutput(feeds);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the book image.
|
||||
/// </summary>
|
||||
/// <param name="bookId">The book id.</param>
|
||||
/// <returns>The book image.</returns>
|
||||
[HttpGet("cover/{bookId}")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public async Task<ActionResult> GetBookImage(Guid bookId)
|
||||
{
|
||||
await AuthorizeAsync().ConfigureAwait(false);
|
||||
var imagePath = _opdsFeedProvider.GetBookImage(bookId);
|
||||
if (string.IsNullOrEmpty(imagePath))
|
||||
{
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
return PhysicalFile(imagePath, "image/jpeg");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the book file.
|
||||
/// </summary>
|
||||
/// <param name="bookId">The book id.</param>
|
||||
/// <returns>The book image.</returns>
|
||||
[HttpGet("download/{bookId}")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public async Task<ActionResult> DownloadBook(Guid bookId)
|
||||
{
|
||||
await AuthorizeAsync().ConfigureAwait(false);
|
||||
var bookPath = _opdsFeedProvider.GetBook(bookId);
|
||||
if (string.IsNullOrEmpty(bookPath))
|
||||
{
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
return PhysicalFile(bookPath, "application/epub+zip");
|
||||
}
|
||||
|
||||
private async Task<Guid> AuthorizeAsync()
|
||||
{
|
||||
if (OpdsPlugin.Instance!.Configuration.AllowAnonymousAccess)
|
||||
{
|
||||
// Endpoints don't require auth, allow all requests.
|
||||
return Guid.Empty;
|
||||
}
|
||||
|
||||
Request.Headers.TryGetValue(HeaderNames.Authorization, out var authorizationHeader);
|
||||
if (authorizationHeader.Count == 0)
|
||||
{
|
||||
throw new AuthenticationException("Basic Authentication is required");
|
||||
}
|
||||
|
||||
var authenticationHeaderValue = AuthenticationHeaderValue.Parse(authorizationHeader);
|
||||
if (string.IsNullOrEmpty(authenticationHeaderValue.Parameter)
|
||||
|| !string.Equals("Basic", authenticationHeaderValue.Scheme, StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
throw new AuthenticationException("Basic Authentication is required");
|
||||
}
|
||||
|
||||
var credentialString = Encoding.UTF8.GetString(Convert.FromBase64String(authenticationHeaderValue.Parameter));
|
||||
var credentialSplitIndex = credentialString.IndexOf(':');
|
||||
if (credentialSplitIndex < 0)
|
||||
{
|
||||
throw new AuthenticationException("Basic Authentication is required");
|
||||
}
|
||||
|
||||
var username = credentialString[..credentialSplitIndex];
|
||||
var password = credentialString[(credentialSplitIndex + 1)..];
|
||||
|
||||
var user = await _userManager.AuthenticateUser(
|
||||
username,
|
||||
password,
|
||||
string.Empty,
|
||||
HttpContext.GetNormalizedRemoteIp(),
|
||||
true)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (user is null)
|
||||
{
|
||||
throw new AuthenticationException("Basic Authentication is required");
|
||||
}
|
||||
|
||||
return user.Id;
|
||||
}
|
||||
|
||||
private FileStreamResult BuildOutput(FeedDto feedDto)
|
||||
{
|
||||
var memoryStream = new MemoryStream();
|
||||
_xmlSerializer.SerializeToStream(feedDto, memoryStream);
|
||||
memoryStream.Seek(0, SeekOrigin.Begin);
|
||||
return File(memoryStream, "application/atom+xml; charset=utf-8");
|
||||
}
|
||||
}
|
||||
}
|
||||
60
Jellyfin.Plugin.Opds/OpdsPlugin.cs
Normal file
60
Jellyfin.Plugin.Opds/OpdsPlugin.cs
Normal file
@ -0,0 +1,60 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.Opds.Configuration;
|
||||
using MediaBrowser.Common.Configuration;
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
using MediaBrowser.Model.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds
|
||||
{
|
||||
/// <summary>
|
||||
/// Plugin entrypoint.
|
||||
/// </summary>
|
||||
public class OpdsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||
{
|
||||
private readonly Guid _id = new ("F30880AE-3365-449E-B9E6-BF133C8401B0");
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="OpdsPlugin"/> class.
|
||||
/// </summary>
|
||||
/// <param name="applicationPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
|
||||
/// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
|
||||
public OpdsPlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
|
||||
: base(applicationPaths, xmlSerializer)
|
||||
{
|
||||
Instance = this;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets current plugin instance.
|
||||
/// </summary>
|
||||
public static OpdsPlugin? Instance { get; private set; }
|
||||
|
||||
/// <inheritdoc />
|
||||
public override Guid Id => _id;
|
||||
|
||||
/// <inheritdoc />
|
||||
public override string Name => "OPDS Feed";
|
||||
|
||||
/// <inheritdoc />
|
||||
public override string Description => "Provides an OPDS book feed";
|
||||
|
||||
/// <inheritdoc />
|
||||
public IEnumerable<PluginPageInfo> GetPages()
|
||||
{
|
||||
var prefix = GetType().Namespace;
|
||||
yield return new PluginPageInfo
|
||||
{
|
||||
Name = Name,
|
||||
EmbeddedResourcePath = prefix + ".Configuration.Web.config.html"
|
||||
};
|
||||
|
||||
yield return new PluginPageInfo
|
||||
{
|
||||
Name = $"{Name}.js",
|
||||
EmbeddedResourcePath = prefix + ".Configuration.Web.config.js"
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
18
Jellyfin.Plugin.Opds/PluginServiceRegistrator.cs
Normal file
18
Jellyfin.Plugin.Opds/PluginServiceRegistrator.cs
Normal file
@ -0,0 +1,18 @@
|
||||
using Jellyfin.Plugin.Opds.Services;
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds
|
||||
{
|
||||
/// <summary>
|
||||
/// Register OPDS services.
|
||||
/// </summary>
|
||||
public class PluginServiceRegistrator : IPluginServiceRegistrator
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public void RegisterServices(IServiceCollection serviceCollection)
|
||||
{
|
||||
serviceCollection.AddScoped<OpdsFeedProvider>();
|
||||
}
|
||||
}
|
||||
}
|
||||
45
Jellyfin.Plugin.Opds/Services/IOpdsFeedProvider.cs
Normal file
45
Jellyfin.Plugin.Opds/Services/IOpdsFeedProvider.cs
Normal file
@ -0,0 +1,45 @@
|
||||
using System;
|
||||
using Jellyfin.Plugin.Opds.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Services
|
||||
{
|
||||
/// <summary>
|
||||
/// Opds feed provider.
|
||||
/// </summary>
|
||||
public interface IOpdsFeedProvider
|
||||
{
|
||||
/// <summary>
|
||||
/// Get the root feeds list.
|
||||
/// </summary>
|
||||
/// <returns>The root feed.</returns>
|
||||
FeedDto GetFeeds();
|
||||
|
||||
/// <summary>
|
||||
/// Get the alphabetical books feed.
|
||||
/// </summary>
|
||||
/// <param name="userId">The user id to filter libraries by.</param>
|
||||
/// <returns>The alphabetical books feed.</returns>
|
||||
FeedDto GetAlphabeticalFeed(Guid userId);
|
||||
|
||||
/// <summary>
|
||||
/// Get the list of books matching the filter.
|
||||
/// </summary>
|
||||
/// <param name="filterStart">The filter start.</param>
|
||||
/// <returns>The list of books.</returns>
|
||||
FeedDto GetAllBooks(string filterStart);
|
||||
|
||||
/// <summary>
|
||||
/// Get the book image path.
|
||||
/// </summary>
|
||||
/// <param name="bookId">The book id.</param>
|
||||
/// <returns>The book image path.</returns>
|
||||
string? GetBookImage(Guid bookId);
|
||||
|
||||
/// <summary>
|
||||
/// Get the book path.
|
||||
/// </summary>
|
||||
/// <param name="bookId">The book id.</param>
|
||||
/// <returns>The book path.</returns>
|
||||
string? GetBook(Guid bookId);
|
||||
}
|
||||
}
|
||||
235
Jellyfin.Plugin.Opds/Services/OpdsFeedProvider.cs
Normal file
235
Jellyfin.Plugin.Opds/Services/OpdsFeedProvider.cs
Normal file
@ -0,0 +1,235 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.Opds.Models;
|
||||
using MediaBrowser.Controller.Configuration;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
using MediaBrowser.Controller.Library;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Jellyfin.Plugin.Opds.Services
|
||||
{
|
||||
/// <summary>
|
||||
/// OPDS feed provider.
|
||||
/// </summary>
|
||||
public class OpdsFeedProvider : IOpdsFeedProvider
|
||||
{
|
||||
private static readonly string[] IncludeItemTypes = { nameof(Book) };
|
||||
private static readonly AuthorDto PluginAuthor = new ("Jellyfin", "https://github.com/jellyfin/jellyfin-plugin-opds");
|
||||
|
||||
private readonly ILogger<OpdsFeedProvider> _logger;
|
||||
private readonly ILibraryManager _libraryManager;
|
||||
private readonly IServerConfigurationManager _serverConfigurationManager;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="OpdsFeedProvider"/> class.
|
||||
/// </summary>
|
||||
/// <param name="logger">Instance of the <see cref="ILogger{OpdsFeedProvider}"/> interface.</param>
|
||||
/// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
|
||||
/// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
|
||||
public OpdsFeedProvider(
|
||||
ILogger<OpdsFeedProvider> logger,
|
||||
ILibraryManager libraryManager,
|
||||
IServerConfigurationManager serverConfigurationManager)
|
||||
{
|
||||
_logger = logger;
|
||||
_libraryManager = libraryManager;
|
||||
_serverConfigurationManager = serverConfigurationManager;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public FeedDto GetFeeds()
|
||||
{
|
||||
var baseUrl = GetBaseUrl();
|
||||
return new FeedDto
|
||||
{
|
||||
Id = Guid.NewGuid().ToString(),
|
||||
Links = new[]
|
||||
{
|
||||
new LinkDto("self", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;kind=navigation"),
|
||||
new LinkDto("start", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;kind=navigation", "Start"),
|
||||
new LinkDto("search", baseUrl + "/opds/osd", "application/opensearchdescription+xml"),
|
||||
new LinkDto("search", baseUrl + "/opds/search/{searchTerms}", "application/atom+xml", "Search")
|
||||
},
|
||||
Title = _serverConfigurationManager.Configuration.ServerName,
|
||||
Author = PluginAuthor,
|
||||
Entries = new List<EntryDto>
|
||||
{
|
||||
new ("Alphabetical Books",
|
||||
"/opds/books",
|
||||
new ContentDto("text", "Books sorted alphabetically"),
|
||||
DateTime.UtcNow)
|
||||
{
|
||||
Links = new List<LinkDto>
|
||||
{
|
||||
new (baseUrl + "/opds/books", "application/atom+xml;profile=opds-catalog")
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public FeedDto GetAlphabeticalFeed(Guid userId)
|
||||
{
|
||||
var baseUrl = GetBaseUrl();
|
||||
var utcNow = DateTime.UtcNow;
|
||||
var entries = new List<EntryDto>
|
||||
{
|
||||
new (
|
||||
"All",
|
||||
"/opds/books/letter/00",
|
||||
utcNow)
|
||||
{
|
||||
Links = new List<LinkDto>
|
||||
{
|
||||
new ("subsection",
|
||||
baseUrl + "/opds/books/letter/00",
|
||||
"application/atom+xml;profile=opds-catalog")
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// TODO add entries based on library contents first char.
|
||||
for (var i = 'A'; i <= 'Z'; i++)
|
||||
{
|
||||
var letter = char.ToString(i);
|
||||
entries.Add(new EntryDto(
|
||||
letter,
|
||||
"/opds/books/letter/" + letter,
|
||||
utcNow)
|
||||
{
|
||||
Links = new List<LinkDto>
|
||||
{
|
||||
new ("subsection",
|
||||
baseUrl + "/opds/books/letter/" + letter,
|
||||
"application/atom+xml;profile=opds-catalog")
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return new FeedDto
|
||||
{
|
||||
Id = Guid.NewGuid().ToString(),
|
||||
Author = PluginAuthor,
|
||||
Title = _serverConfigurationManager.Configuration.ServerName,
|
||||
Links = new[]
|
||||
{
|
||||
new LinkDto("self", baseUrl + "/opds/books?", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("start", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("up", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("search", baseUrl + "/opds/osd", "application/opensearchdescription+xml"),
|
||||
new LinkDto("search", baseUrl + "/opds/search/{searchTerms}", "application/atom+xml", "Search")
|
||||
},
|
||||
Entries = entries
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets all books.
|
||||
/// </summary>
|
||||
/// <param name="filterStart">The start filter character.</param>
|
||||
/// <returns>The list of books.</returns>
|
||||
public FeedDto GetAllBooks(string filterStart)
|
||||
{
|
||||
var baseUrl = GetBaseUrl();
|
||||
var books = new List<Book>();
|
||||
if (filterStart.Length != 1)
|
||||
{
|
||||
filterStart = string.Empty;
|
||||
}
|
||||
|
||||
foreach (var libraryId in OpdsPlugin.Instance!.Configuration.BookLibraries)
|
||||
{
|
||||
var items = _libraryManager.GetItemList(new InternalItemsQuery
|
||||
{
|
||||
ParentId = libraryId,
|
||||
IncludeItemTypes = IncludeItemTypes,
|
||||
Recursive = true,
|
||||
NameStartsWith = string.IsNullOrEmpty(filterStart) ? null : filterStart
|
||||
});
|
||||
|
||||
if (items is null || items.Count == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (var item in items)
|
||||
{
|
||||
if (item is Book book)
|
||||
{
|
||||
books.Add(book);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var entries = new List<EntryDto>(books.Count);
|
||||
foreach (var book in books)
|
||||
{
|
||||
entries.Add(new EntryDto(
|
||||
book.Name,
|
||||
book.Id.ToString(),
|
||||
book.DateModified)
|
||||
{
|
||||
Author = new AuthorDto
|
||||
{
|
||||
Name = book.Parent.Name
|
||||
},
|
||||
// TODO verify.
|
||||
Summary = book.Overview,
|
||||
Links = new List<LinkDto>
|
||||
{
|
||||
// TODO change type based on actual media type.
|
||||
new ("http://opds-spec.org/image", baseUrl + "/opds/cover/" + book.Id, "image/jpeg"),
|
||||
new ("http://opds-spec.org/image/thumbnail", baseUrl + "/opds/cover/" + book.Id, "image/jpeg"),
|
||||
new ("http://opds-spec.org/acquisition", baseUrl + "/opds/download/" + book.Id, "application/epub+zip")
|
||||
{
|
||||
UpdateTime = book.DateModified,
|
||||
Length = book.Size
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return new FeedDto
|
||||
{
|
||||
Id = Guid.NewGuid().ToString(),
|
||||
Author = PluginAuthor,
|
||||
Title = _serverConfigurationManager.Configuration.ServerName,
|
||||
Links = new[]
|
||||
{
|
||||
new LinkDto("self", baseUrl + "/opds/books/letter/" + filterStart + "?", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("start", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("up", baseUrl + "/opds", "application/atom+xml;profile=opds-catalog;type=feed;kind=navigation"),
|
||||
new LinkDto("search", baseUrl + "/opds/osd", "application/opensearchdescription+xml"),
|
||||
new LinkDto("search", baseUrl + "/opds/search/{searchTerms}", "application/atom+xml", "Search")
|
||||
},
|
||||
Entries = entries
|
||||
};
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public string? GetBookImage(Guid bookId)
|
||||
{
|
||||
var item = _libraryManager.GetItemById(bookId);
|
||||
return item?.PrimaryImagePath;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public string? GetBook(Guid bookId)
|
||||
{
|
||||
var item = _libraryManager.GetItemById(bookId);
|
||||
return item?.Path;
|
||||
}
|
||||
|
||||
private string GetBaseUrl()
|
||||
{
|
||||
var baseUrl = _serverConfigurationManager.Configuration.BaseUrl;
|
||||
if (string.Equals(baseUrl, "/", StringComparison.Ordinal))
|
||||
{
|
||||
baseUrl = string.Empty;
|
||||
}
|
||||
|
||||
return baseUrl;
|
||||
}
|
||||
}
|
||||
}
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 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 General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is 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. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
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.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
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 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. Use with the GNU Affero General Public License.
|
||||
|
||||
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 Affero 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 special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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 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 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 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 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU 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 the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
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 GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
19
README.md
Normal file
19
README.md
Normal file
@ -0,0 +1,19 @@
|
||||
<h1 align="center">Jellyfin OPDS Plugin</h1>
|
||||
<h3 align="center">Part of the <a href="https://jellyfin.media">Jellyfin Project</a></h3>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-opds.svg?sanitize=true"/>
|
||||
<br/>
|
||||
<br/>
|
||||
<a href="https://github.com/jellyfin/jellyfin-plugin-opds/actions?query=workflow%3A%22Test+Build+Plugin%22">
|
||||
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-opds/Test%20Build%20Plugin.svg">
|
||||
</a>
|
||||
<a href="https://github.com/jellyfin/jellyfin-plugin-opds">
|
||||
<img alt="GPLv3 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-opds.svg"/>
|
||||
</a>
|
||||
<a href="https://github.com/jellyfin/jellyfin-plugin-opds/releases">
|
||||
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-opds.svg"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
Feed is located at `${baseUrl}/opds`
|
||||
15
build.yaml
Normal file
15
build.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
name: "OPDS"
|
||||
guid: "F30880AE-3365-449E-B9E6-BF133C8401B0"
|
||||
imageUrl: "https://repo.jellyfin.org/releases/plugin/images/jellyfin-plugin-opds.png"
|
||||
version: "1"
|
||||
targetAbi: "10.7.7.0"
|
||||
framework: "net5.0"
|
||||
owner: "jellyfin"
|
||||
overview: "Provides an OPDS book feed"
|
||||
description: >
|
||||
Provides an OPDS feed for book browsing.
|
||||
|
||||
category: ""
|
||||
artifacts:
|
||||
- "Jellyfin.Plugin.Opds.dll"
|
||||
changelog: |2-
|
||||
98
jellyfin.ruleset
Normal file
98
jellyfin.ruleset
Normal file
@ -0,0 +1,98 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<RuleSet Name="Rules for Jellyfin.Server" Description="Code analysis rules for Jellyfin.Server.csproj" ToolsVersion="14.0">
|
||||
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
|
||||
<!-- disable warning SA1009: Closing parenthesis should be followed by a space. -->
|
||||
<Rule Id="SA1009" Action="None" />
|
||||
<!-- disable warning SA1011: Closing square bracket should be followed by a space. -->
|
||||
<Rule Id="SA1011" Action="None" />
|
||||
<!-- disable warning SA1101: Prefix local calls with 'this.' -->
|
||||
<Rule Id="SA1101" Action="None" />
|
||||
<!-- disable warning SA1108: Block statements should not contain embedded comments -->
|
||||
<Rule Id="SA1108" Action="None" />
|
||||
<!-- disable warning SA1118: Parameter must not span multiple lines. -->
|
||||
<Rule Id="SA1118" Action="None" />
|
||||
<!-- disable warning SA1128:: Put constructor initializers on their own line -->
|
||||
<Rule Id="SA1128" Action="None" />
|
||||
<!-- disable warning SA1130: Use lambda syntax -->
|
||||
<Rule Id="SA1130" Action="None" />
|
||||
<!-- disable warning SA1200: 'using' directive must appear within a namespace declaration -->
|
||||
<Rule Id="SA1200" Action="None" />
|
||||
<!-- disable warning SA1202: 'public' members must come before 'private' members -->
|
||||
<Rule Id="SA1202" Action="None" />
|
||||
<!-- disable warning SA1204: Static members must appear before non-static members -->
|
||||
<Rule Id="SA1204" Action="None" />
|
||||
<!-- disable warning SA1309: Fields must not begin with an underscore -->
|
||||
<Rule Id="SA1309" Action="None" />
|
||||
<!-- disable warning SA1413: Use trailing comma in multi-line initializers -->
|
||||
<Rule Id="SA1413" Action="None" />
|
||||
<!-- disable warning SA1512: Single-line comments must not be followed by blank line -->
|
||||
<Rule Id="SA1512" Action="None" />
|
||||
<!-- disable warning SA1515: Single-line comment should be preceded by blank line -->
|
||||
<Rule Id="SA1515" Action="None" />
|
||||
<!-- disable warning SA1600: Elements should be documented -->
|
||||
<Rule Id="SA1600" Action="None" />
|
||||
<!-- disable warning SA1602: Enumeration items should be documented -->
|
||||
<Rule Id="SA1602" Action="None" />
|
||||
<!-- disable warning SA1633: The file header is missing or not located at the top of the file -->
|
||||
<Rule Id="SA1633" Action="None" />
|
||||
</Rules>
|
||||
|
||||
<Rules AnalyzerId="Microsoft.CodeAnalysis.NetAnalyzers" RuleNamespace="Microsoft.Design">
|
||||
<!-- error on CA1305: Specify IFormatProvider -->
|
||||
<Rule Id="CA1305" Action="Error" />
|
||||
<!-- error on CA1725: Parameter names should match base declaration -->
|
||||
<Rule Id="CA1725" Action="Error" />
|
||||
<!-- error on CA2016: Forward the CancellationToken parameter to methods that take one
|
||||
or pass in 'CancellationToken.None' explicitly to indicate intentionally not propagating the token -->
|
||||
<Rule Id="CA2016" Action="Error" />
|
||||
|
||||
<!-- disable warning CA1014: Mark assemblies with CLSCompliantAttribute -->
|
||||
<Rule Id="CA1014" Action="Info" />
|
||||
<!-- disable warning CA1024: Use properties where appropriate -->
|
||||
<Rule Id="CA1024" Action="Info" />
|
||||
<!-- disable warning CA1031: Do not catch general exception types -->
|
||||
<Rule Id="CA1031" Action="Info" />
|
||||
<!-- disable warning CA1032: Implement standard exception constructors -->
|
||||
<Rule Id="CA1032" Action="Info" />
|
||||
<!-- disable warning CA1040: Avoid empty interfaces -->
|
||||
<Rule Id="CA1040" Action="Info" />
|
||||
<!-- disable warning CA1062: Validate arguments of public methods -->
|
||||
<Rule Id="CA1062" Action="Info" />
|
||||
<!-- TODO: enable when false positives are fixed -->
|
||||
<!-- disable warning CA1508: Avoid dead conditional code -->
|
||||
<Rule Id="CA1508" Action="Info" />
|
||||
<!-- disable warning CA1716: Identifiers should not match keywords -->
|
||||
<Rule Id="CA1716" Action="Info" />
|
||||
<!-- disable warning CA1720: Identifiers should not contain type names -->
|
||||
<Rule Id="CA1720" Action="Info" />
|
||||
<!-- disable warning CA1724: Type names should not match namespaces -->
|
||||
<Rule Id="CA1724" Action="Info" />
|
||||
<!-- disable warning CA1805: Do not initialize unnecessarily -->
|
||||
<Rule Id="CA1805" Action="Info" />
|
||||
<!-- disable warning CA1812: internal class that is apparently never instantiated.
|
||||
If so, remove the code from the assembly.
|
||||
If this class is intended to contain only static members, make it static -->
|
||||
<Rule Id="CA1812" Action="Info" />
|
||||
<!-- disable warning CA1822: Member does not access instance data and can be marked as static -->
|
||||
<Rule Id="CA1822" Action="Info" />
|
||||
<!-- disable warning CA2000: Dispose objects before losing scope -->
|
||||
<Rule Id="CA2000" Action="Info" />
|
||||
<!-- disable warning CA5394: Do not use insecure randomness -->
|
||||
<Rule Id="CA5394" Action="Info" />
|
||||
|
||||
<!-- disable warning CA1054: Change the type of parameter url from string to System.Uri -->
|
||||
<Rule Id="CA1054" Action="None" />
|
||||
<!-- disable warning CA1055: URI return values should not be strings -->
|
||||
<Rule Id="CA1055" Action="None" />
|
||||
<!-- disable warning CA1056: URI properties should not be strings -->
|
||||
<Rule Id="CA1056" Action="None" />
|
||||
<!-- disable warning CA1303: Do not pass literals as localized parameters -->
|
||||
<Rule Id="CA1303" Action="None" />
|
||||
<!-- disable warning CA1308: Normalize strings to uppercase -->
|
||||
<Rule Id="CA1308" Action="None" />
|
||||
<!-- disable warning CA2101: Specify marshaling for P/Invoke string arguments -->
|
||||
<Rule Id="CA2101" Action="None" />
|
||||
<!-- disable warning CA2234: Pass System.Uri objects instead of strings -->
|
||||
<Rule Id="CA2234" Action="None" />
|
||||
</Rules>
|
||||
</RuleSet>
|
||||
Loading…
Reference in New Issue
Block a user