-
Notifications
You must be signed in to change notification settings - Fork 0
/
BaseOswPlugin.cs
225 lines (176 loc) · 8.12 KB
/
BaseOswPlugin.cs
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
using System;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using System.Linq;
using System.Text;
using System.Reflection;
using Newtonsoft.Json;
using Nop.Core;
using Nop.Core.Infrastructure;
using Nop.Services.Localization;
using Nop.Services.Plugins;
namespace Nop.Plugin.Opensoftware.DiscountRules.HasOneProduct
{
public abstract class BaseOswPlugin : BasePlugin
{
#region Fields
private readonly ILanguageService _languageService;
private readonly ILocalizationService _localizationService;
#endregion
#region Additional fields
public static FileInfo _originalAssemblyFile { get; private set; }
public static PluginDescriptor OswPluginDescriptor { get; private set; }
#endregion
#region Constructor
public BaseOswPlugin()
{
this._localizationService = EngineContext.Current.Resolve<ILocalizationService>();
this._languageService = EngineContext.Current.Resolve<ILanguageService>();
//get current plugin location in file system
string pluginLibraryLocationPath = Assembly.GetExecutingAssembly().Location;
//get plugin library name
string pluginLibraryName = Path.GetFileName(pluginLibraryLocationPath);
}
static BaseOswPlugin()
{
//get current plugin location in file system
string pluginLibraryLocationPath = Assembly.GetExecutingAssembly().Location;
//get plugin library name
string pluginLibraryName = Path.GetFileName(pluginLibraryLocationPath);
//get plugin library folder
string pluginLibraryFolder = Path.GetDirectoryName(pluginLibraryLocationPath);
var parentFolder = Directory.GetParent(pluginLibraryFolder);
//search for this file in nop plugins folder
var foundedFiles = Directory.GetFiles(parentFolder.FullName, pluginLibraryName, SearchOption.AllDirectories);
//create default plugin descriptor
OswPluginDescriptor = new PluginDescriptor(Assembly.GetExecutingAssembly());
//get plugin descriptor from plugin description file
if (foundedFiles.Any())
{
string nopPluginLibraryPath = string.Empty;
foreach (var file in foundedFiles)
if (!file.Contains("\\Plugins\\bin\\"))
{
nopPluginLibraryPath = file;
break;
}
if (!string.IsNullOrEmpty(nopPluginLibraryPath))
{
_originalAssemblyFile = new FileInfo(nopPluginLibraryPath);
var pluginDescriptorFile = $"{_originalAssemblyFile.DirectoryName}\\{ NopPluginDefaults.DescriptionFileName }";
if (!File.Exists(pluginDescriptorFile))
throw new Exception($"Plugin descriptor for {pluginLibraryName} aren't found");
var descriptorText = File.ReadAllText(pluginDescriptorFile);
OswPluginDescriptor = PluginDescriptor.GetPluginDescriptorFromText(descriptorText);
OswPluginDescriptor.Installed = IsPluginInstalled();
}
}
}
#endregion
#region Utilites
/// <summary>
/// Generate localization file path by language culture
/// </summary>
/// <param name="culture">Language culture. For example 'en-US'</param>
/// <returns>Localization Xml file path</returns>
protected string GenerateLocalizationXmlFilePathByCulture(string culture = "en-US")
{
string fileName = string.Format("localization.{0}.xml", culture);
string contentDirectoryPath = $"{_originalAssemblyFile.DirectoryName}\\Content\\";
return $"{contentDirectoryPath}{fileName}";
}
/// <summary>
/// Install available plugin localizations
/// </summary>
protected virtual void InstallLocalization()
{
var allLanguages = _languageService.GetAllLanguages();
var language = allLanguages.FirstOrDefault();
//if shop have no available languages method generate exception
if (language == null)
throw new Exception("Your store have no available language.");
foreach (var l in allLanguages)
{
//check file existing
bool isLocalizationFileExist = File.Exists(GenerateLocalizationXmlFilePathByCulture(l.LanguageCulture));
//get localization file path. If no one localization have no appropriate xml file method will install only default english localization
string localizationPath = isLocalizationFileExist ? GenerateLocalizationXmlFilePathByCulture(l.LanguageCulture) : GenerateLocalizationXmlFilePathByCulture();
//if file exists it's imports in database
var localizationFile = File.ReadAllBytes(localizationPath);
using (var stream = new MemoryStream(localizationFile))
{
using (var sr = new StreamReader(stream, Encoding.UTF8))
{
_localizationService.ImportResourcesFromXml(l, sr);
}
}
}
}
/// <summary>
/// Uninstall plugin localization
/// </summary>
protected virtual void UninstallLocalization()
{
var localizationPath = GenerateLocalizationXmlFilePathByCulture();
//if standart english localization file isn't exist method generate exception
if (!File.Exists(localizationPath))
throw new Exception("File isn't exist.");
var localizationFile = File.ReadAllBytes(localizationPath);
using (var stream = new MemoryStream(localizationFile))
{
using (var sr = new StreamReader(stream, Encoding.UTF8))
{
string result = sr.ReadToEnd();
XmlDocument xLang = new XmlDocument();
xLang.LoadXml(result);
//get localization keys
XmlNodeList xNodeList = xLang.SelectNodes("Language/LocaleResource");
foreach (XmlNode elem in xNodeList)
if (elem.Name == "LocaleResource")
{
var localResource = elem.Attributes["Name"].Value;
_localizationService.DeletePluginLocaleResource(localResource);
}
}
}
}
/// <summary>
/// Check current plugin installation status in 'InstalledPlugins.txt' document
/// </summary>
/// <param name="systemName">Plugin system name</param>
/// <returns>True - when plugin marked like installed</returns>
protected static bool IsPluginInstalled()
{
return IsPluginInstalled(OswPluginDescriptor.SystemName);
}
#endregion
#region Methods
public override void Install()
{
this.InstallLocalization();
base.Install();
}
public override void Uninstall()
{
this.UninstallLocalization();
base.Uninstall();
}
/// <summary>
/// Check InstalledPlugins.txt file list on plugin system name
/// </summary>
/// <param name="systemName">Plugin system name</param>
/// <returns>True when plugin added to list</returns>
public static bool IsPluginInstalled(string systemName)
{
string installedPluginsFile = CommonHelper.DefaultFileProvider.MapPath(NopPluginDefaults.PluginsInfoFilePath);
if (File.Exists(installedPluginsFile))
{
var redisPluginsInfo = JsonConvert.DeserializeObject<PluginsInfo>(File.ReadAllText(installedPluginsFile));
return redisPluginsInfo.InstalledPluginNames.Contains(systemName);
}
return false;
}
#endregion
}
}