commit 0bace555ab73ed986c17403c6a15b303aab64e35 Author: Thomas Gander Date: Sun Nov 23 14:03:46 2025 -0700 Initial Commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b84e563 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,194 @@ +# With more recent updates Visual Studio 2017 supports EditorConfig files out of the box +# Visual Studio Code needs an extension: https://github.com/editorconfig/editorconfig-vscode +# For emacs, vim, np++ and other editors, see here: https://github.com/editorconfig +############################### +# Core EditorConfig Options # +############################### +root = true +# All files +[*] +indent_style = space +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +end_of_line = lf +max_line_length = off + +# YAML indentation +[*.{yml,yaml}] +indent_size = 2 + +# XML indentation +[*.{csproj,xml}] +indent_size = 2 + +############################### +# .NET Coding Conventions # +############################### +[*.{cs,vb}] +# Organize usings +dotnet_sort_system_directives_first = true +# this. preferences +dotnet_style_qualification_for_field = false:silent +dotnet_style_qualification_for_property = false:silent +dotnet_style_qualification_for_method = false:silent +dotnet_style_qualification_for_event = false:silent +# Language keywords vs BCL types preferences +dotnet_style_predefined_type_for_locals_parameters_members = true:silent +dotnet_style_predefined_type_for_member_access = true:silent +# Parentheses preferences +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent +# Modifier preferences +dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent +dotnet_style_readonly_field = true:suggestion +# Expression-level preferences +dotnet_style_object_initializer = true:suggestion +dotnet_style_collection_initializer = true:suggestion +dotnet_style_explicit_tuple_names = true:suggestion +dotnet_style_null_propagation = true:suggestion +dotnet_style_coalesce_expression = true:suggestion +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent +dotnet_style_prefer_inferred_tuple_names = true:suggestion +dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion +dotnet_style_prefer_auto_properties = true:silent +dotnet_style_prefer_conditional_expression_over_assignment = true:silent +dotnet_style_prefer_conditional_expression_over_return = true:silent + +############################### +# Naming Conventions # +############################### +# Style Definitions (From Roslyn) + +# Non-private static fields are PascalCase +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style + +dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field +dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected +dotnet_naming_symbols.non_private_static_fields.required_modifiers = static + +dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case + +# Constants are PascalCase +dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants +dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style + +dotnet_naming_symbols.constants.applicable_kinds = field, local +dotnet_naming_symbols.constants.required_modifiers = const + +dotnet_naming_style.constant_style.capitalization = pascal_case + +# Static fields are camelCase and start with s_ +dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields +dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style + +dotnet_naming_symbols.static_fields.applicable_kinds = field +dotnet_naming_symbols.static_fields.required_modifiers = static + +dotnet_naming_style.static_field_style.capitalization = camel_case +dotnet_naming_style.static_field_style.required_prefix = _ + +# Instance fields are camelCase and start with _ +dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields +dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style + +dotnet_naming_symbols.instance_fields.applicable_kinds = field + +dotnet_naming_style.instance_field_style.capitalization = camel_case +dotnet_naming_style.instance_field_style.required_prefix = _ + +# Locals and parameters are camelCase +dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion +dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters +dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style + +dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local + +dotnet_naming_style.camel_case_style.capitalization = camel_case + +# Local functions are PascalCase +dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions +dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style + +dotnet_naming_symbols.local_functions.applicable_kinds = local_function + +dotnet_naming_style.local_function_style.capitalization = pascal_case + +# By default, name items with PascalCase +dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members +dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style + +dotnet_naming_symbols.all_members.applicable_kinds = * + +dotnet_naming_style.pascal_case_style.capitalization = pascal_case + +############################### +# C# Coding Conventions # +############################### +[*.cs] +# var preferences +csharp_style_var_for_built_in_types = true:silent +csharp_style_var_when_type_is_apparent = true:silent +csharp_style_var_elsewhere = true:silent +# Expression-bodied members +csharp_style_expression_bodied_methods = false:silent +csharp_style_expression_bodied_constructors = false:silent +csharp_style_expression_bodied_operators = false:silent +csharp_style_expression_bodied_properties = true:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_accessors = true:silent +# Pattern matching preferences +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion +# Null-checking preferences +csharp_style_throw_expression = true:suggestion +csharp_style_conditional_delegate_call = true:suggestion +# Modifier preferences +csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion +# Expression-level preferences +csharp_prefer_braces = true:silent +csharp_style_deconstructed_variable_declaration = true:suggestion +csharp_prefer_simple_default_expression = true:suggestion +csharp_style_pattern_local_over_anonymous_function = true:suggestion +csharp_style_inlined_variable_declaration = true:suggestion + +############################### +# C# Formatting Rules # +############################### +# New line preferences +csharp_new_line_before_open_brace = all +csharp_new_line_before_else = true +csharp_new_line_before_catch = true +csharp_new_line_before_finally = true +csharp_new_line_before_members_in_object_initializers = true +csharp_new_line_before_members_in_anonymous_types = true +csharp_new_line_between_query_expression_clauses = true +# Indentation preferences +csharp_indent_case_contents = true +csharp_indent_switch_labels = true +csharp_indent_labels = flush_left +# Space preferences +csharp_space_after_cast = false +csharp_space_after_keywords_in_control_flow_statements = true +csharp_space_between_method_call_parameter_list_parentheses = false +csharp_space_between_method_declaration_parameter_list_parentheses = false +csharp_space_between_parentheses = false +csharp_space_before_colon_in_inheritance_clause = true +csharp_space_after_colon_in_inheritance_clause = true +csharp_space_around_binary_operators = before_and_after +csharp_space_between_method_declaration_empty_parameter_list_parentheses = false +csharp_space_between_method_call_name_and_opening_parenthesis = false +csharp_space_between_method_call_empty_parameter_list_parentheses = false +# Wrapping preferences +csharp_preserve_single_line_statements = true +csharp_preserve_single_line_blocks = true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0b72c24 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +bin/ +obj/ +.vs/ +.idea/ +artifacts diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..698bc34 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. + // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp + // List of extensions which should be recommended for users of this workspace. + "recommendations": [ + "ms-dotnettools.csharp", + "editorconfig.editorconfig" + ], + // List of extensions recommended by VS Code that should not be recommended for users of this workspace. + "unwantedRecommendations": [] +} \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..9f17676 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,19 @@ +{ + // Paths and plugin names are configured in settings.json + "version": "0.2.0", + "configurations": [ + { + "type": "coreclr", + "name": "Launch", + "request": "launch", + "preLaunchTask": "build-and-copy", + "program": "${config:jellyfinDir}/bin/Debug/net9.0/jellyfin.dll", + "args": [ + //"--nowebclient" + "--webdir", + "${config:jellyfinWebDir}/dist/" + ], + "cwd": "${config:jellyfinDir}", + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b075e97 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,19 @@ +{ + // jellyfinDir : The directory of the cloned jellyfin server project + // This needs to be built once before it can be used + "jellyfinDir": "${workspaceFolder}/../jellyfin/Jellyfin.Server", + // jellyfinWebDir : The directory of the cloned jellyfin-web project + // This needs to be built once before it can be used + "jellyfinWebDir": "${workspaceFolder}/../jellyfin-web", + // jellyfinDataDir : the root data directory for a running jellyfin instance + // This is where jellyfin stores its configs, plugins, metadata etc + // This is platform specific by default, but on Windows defaults to + // ${env:LOCALAPPDATA}/jellyfin + // and on Linux, it defaults to + // ${env:XDG_DATA_HOME}/jellyfin + // However ${env:XDG_DATA_HOME} does not work in Visual Studio Code's development container! + "jellyfinWindowsDataDir": "${env:LOCALAPPDATA}/jellyfin", + "jellyfinLinuxDataDir": "$HOME/.local/share/jellyfin", + // The name of the plugin + "pluginName": "Jellyfin.Plugin.MediaCleaner", +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..62e3e70 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,76 @@ +{ + // Paths and plugin name are configured in settings.json + "version": "2.0.0", + "tasks": [ + { + // A chain task - build the plugin, then copy it to your + // jellyfin server's plugin directory + "label": "build-and-copy", + "dependsOrder": "sequence", + "dependsOn": [ + "build", + "make-plugin-dir", + "copy-dll" + ] + }, + { + // Build the plugin + "label": "build", + "command": "dotnet", + "type": "shell", + "args": [ + "publish", + "--configuration=Debug", + "${workspaceFolder}\\${config:pluginName}.sln", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "group": "build", + "presentation": { + "reveal": "silent" + }, + "problemMatcher": "$msCompile" + }, + { + // Ensure the plugin directory exists before trying to use it + "label": "make-plugin-dir", + "type": "shell", + "command": "mkdir", + "windows": { + "args": [ + "-Force", + "-Path", + "${config:jellyfinWindowsDataDir}/plugins/${config:pluginName}/" + ] + }, + "linux": { + "args": [ + "-p", + "${config:jellyfinLinuxDataDir}/plugins/${config:pluginName}/" + ] + } + }, + { + // Copy the plugin dll to the jellyfin plugin install path + // This command copies every .dll from the build directory to the plugin dir + // Usually, you probablly only need ${config:pluginName}.dll + // But some plugins may bundle extra requirements + "label": "copy-dll", + "type": "shell", + "command": "cp", + "windows": { + "args": [ + "./${config:pluginName}/bin/Debug/net9.0/publish/*", + "${config:jellyfinWindowsDataDir}/plugins/${config:pluginName}/" + ] + }, + "linux": { + "args": [ + "-r", + "./${config:pluginName}/bin/Debug/net9.0/publish/*", + "${config:jellyfinLinuxDataDir}/plugins/${config:pluginName}/" + ] + } + }, + ] +} diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 0000000..c702921 --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,7 @@ + + + 0.0.0.0 + 0.0.0.0 + 0.0.0.0 + + diff --git a/Jellyfin.Plugin.MediaCleaner.sln b/Jellyfin.Plugin.MediaCleaner.sln new file mode 100644 index 0000000..e2a653f --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner.sln @@ -0,0 +1,24 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.2.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.MediaCleaner", "Jellyfin.Plugin.MediaCleaner\Jellyfin.Plugin.MediaCleaner.csproj", "{C829A763-0F22-6F09-C0C4-819BD41CAEBA}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {C829A763-0F22-6F09-C0C4-819BD41CAEBA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C829A763-0F22-6F09-C0C4-819BD41CAEBA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C829A763-0F22-6F09-C0C4-819BD41CAEBA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C829A763-0F22-6F09-C0C4-819BD41CAEBA}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {45A396D1-3C65-49C3-8C25-474E5B27BED3} + EndGlobalSection +EndGlobal diff --git a/Jellyfin.Plugin.MediaCleaner/Configuration/PluginConfiguration.cs b/Jellyfin.Plugin.MediaCleaner/Configuration/PluginConfiguration.cs new file mode 100644 index 0000000..23b65aa --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Configuration/PluginConfiguration.cs @@ -0,0 +1,16 @@ +using MediaBrowser.Model.Plugins; + +namespace Jellyfin.Plugin.MediaCleaner.Configuration; + +/// +/// Plugin configuration. +/// +public class PluginConfiguration : BasePluginConfiguration +{ + /// + /// Initializes a new instance of the class. + /// + public PluginConfiguration() + { + } +} diff --git a/Jellyfin.Plugin.MediaCleaner/Configuration/configPage.html b/Jellyfin.Plugin.MediaCleaner/Configuration/configPage.html new file mode 100644 index 0000000..5604110 --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Configuration/configPage.html @@ -0,0 +1,79 @@ + + + + + Template + + +
+
+
+
+ +
+ +
+
+
+
+ +
+ + diff --git a/Jellyfin.Plugin.MediaCleaner/Jellyfin.Plugin.MediaCleaner.csproj b/Jellyfin.Plugin.MediaCleaner/Jellyfin.Plugin.MediaCleaner.csproj new file mode 100644 index 0000000..6fb1a62 --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Jellyfin.Plugin.MediaCleaner.csproj @@ -0,0 +1,33 @@ + + + + net9.0 + Jellyfin.Plugin.MediaCleaner + true + true + enable + AllEnabledByDefault + ../jellyfin.ruleset + + + + + runtime + + + runtime + + + + + + + + + + + + + + + diff --git a/Jellyfin.Plugin.MediaCleaner/Plugin.cs b/Jellyfin.Plugin.MediaCleaner/Plugin.cs new file mode 100644 index 0000000..530c2e6 --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Plugin.cs @@ -0,0 +1,51 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using Jellyfin.Plugin.MediaCleaner.Configuration; +using MediaBrowser.Common.Configuration; +using MediaBrowser.Common.Plugins; +using MediaBrowser.Model.Plugins; +using MediaBrowser.Model.Serialization; + +namespace Jellyfin.Plugin.MediaCleaner; + +/// +/// The main plugin. +/// +public class Plugin : BasePlugin, IHasWebPages +{ + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + /// Instance of the interface. + public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) + : base(applicationPaths, xmlSerializer) + { + Instance = this; + } + + /// + public override string Name => "Media Cleaner"; + + /// + public override Guid Id => Guid.Parse("fef007a8-3e8f-4aa8-a22e-486a387f4192"); + + /// + /// Gets the current plugin instance. + /// + public static Plugin? Instance { get; private set; } + + /// + public IEnumerable GetPages() + { + return + [ + new PluginPageInfo + { + Name = Name, + EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.configPage.html", GetType().Namespace) + } + ]; + } +} diff --git a/build.yaml b/build.yaml new file mode 100644 index 0000000..eb2f671 --- /dev/null +++ b/build.yaml @@ -0,0 +1,16 @@ +--- +name: "MediaCleaner" +guid: "eb5d7894-8eef-4b36-aa6f-5d124e828ce1" +version: "1.0.0.0" +targetAbi: "10.9.0.0" +framework: "net8.0" +overview: "Short description about your plugin" +description: > + This is a longer description that can span more than one + line and include details about your plugin. +category: "General" +owner: "jellyfin" +artifacts: +- "Jellyfin.Plugin.Template.dll" +changelog: > + changelog diff --git a/jellyfin.ruleset b/jellyfin.ruleset new file mode 100644 index 0000000..8af791c --- /dev/null +++ b/jellyfin.ruleset @@ -0,0 +1,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +