blob: 98b6120f7e61ae33dc6ecd7d1f49623a8dd8f503 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
using System;
using System.IO;
using MediaBrowser.Common.Kernel;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Common.Json;
namespace MediaBrowser.Common.Plugins
{
/// <summary>
/// Provides a BasePlugin with generics, allowing for strongly typed configuration access.
/// </summary>
public abstract class BaseGenericPlugin<TConfigurationType> : BasePlugin
where TConfigurationType : BasePluginConfiguration, new()
{
public new TConfigurationType Configuration
{
get
{
return base.Configuration as TConfigurationType;
}
set
{
base.Configuration = value;
}
}
protected override Type ConfigurationType
{
get { return typeof(TConfigurationType); }
}
}
/// <summary>
/// Provides a common base class for all plugins
/// </summary>
public abstract class BasePlugin : IDisposable
{
/// <summary>
/// Gets or sets the plugin's current context
/// </summary>
public KernelContext Context { get; set; }
/// <summary>
/// Gets the name of the plugin
/// </summary>
public abstract string Name { get; }
/// <summary>
/// Gets the type of configuration this plugin uses
/// </summary>
protected abstract Type ConfigurationType { get; }
/// <summary>
/// Gets or sets the path to the plugin's folder
/// </summary>
public string Path { get; set; }
/// <summary>
/// Gets or sets the plugin version
/// </summary>
public Version Version { get; set; }
/// <summary>
/// Gets or sets the current plugin configuration
/// </summary>
public BasePluginConfiguration Configuration { get; protected set; }
protected string ConfigurationPath
{
get
{
return System.IO.Path.Combine(Path, "config.js");
}
}
public bool Enabled
{
get
{
return Configuration.Enabled;
}
}
public DateTime ConfigurationDateLastModified
{
get
{
return Configuration.DateLastModified;
}
}
/// <summary>
/// Returns true or false indicating if the plugin should be downloaded and run within the UI.
/// </summary>
public virtual bool DownloadToUI
{
get
{
return false;
}
}
/// <summary>
/// Starts the plugin.
/// </summary>
public virtual void Init()
{
}
/// <summary>
/// Disposes the plugins. Undos all actions performed during Init.
/// </summary>
public virtual void Dispose()
{
}
public void ReloadConfiguration()
{
if (!File.Exists(ConfigurationPath))
{
Configuration = Activator.CreateInstance(ConfigurationType) as BasePluginConfiguration;
}
else
{
Configuration = JsonSerializer.DeserializeFromFile(ConfigurationType, ConfigurationPath) as BasePluginConfiguration;
Configuration.DateLastModified = File.GetLastWriteTime(ConfigurationPath);
}
}
}
}
|
