Plugin Manager and download tool "BlacksmithPluginManager" - v

じ☆ve冰风

BlacksmithPluginManager v0.2.1
[email=Connor%20%22Saelorable%22%20Macleod<Blacksmith@saelora.com>]Connor "Saelorable" Macleod <Blacksmith@saelora.com>[/email]​

Introduction
Blacksmith Plugin Manager is the first of a suite of plugin development tools i am working on. Originally for personal use, but now being shared.
The aim of the Plugin Manager is to provide an easy way to manage dependencies without having to worry about plugin load order. As well as allowing users to include plugins from the internet far easier.

Features

• Online plugin download: Plugins can be included using a URL to download at runtime. These plugins can also be cached so they are only downloaded once for offline projects. Any plugin can be included in this manner.
  
• Dependancy management: Compatible Plugins are not initialised until their dependancies are ready.
  
• Access compatible plugins from anywhere: compatible plugins are stored in an object for access from other plugins, allowing for a clean global scope.
  

How to Use

End users: Either copy the below script and save it as a text file "BlacksmithPluginManager.js" or else right click on the github link and select "save as" or "download" depending on your browser.
However you get the file, save it in your projects js/plugins folder.
Once you have the file, enable it in the plugin manager within RPG Maker.
You can then include any plugins you have a direct url to in the plugin parameters on the page within. and they will be included within your project, no further work needed.

Plugin developers: Instead of using a Self-Executing Anonymous Function to isolate your code, compatible plugins should use the following structure:
                Code:       

1. new PluginManager.Plugin({
2.         id: "examplePluginID", //required - this should match the filename
3.         name: "Example Plugin", //optional - if not provided will be generated based on id
4.         dependencies: ["exampleDependancyID", {url: http://www.example.com/examplePlugin/xyyyzzq.js, id: exampleOnlineDependancy}], //optional - you can leave out or leave an empty array for no dependancies. This should match the id (as above) of the required plugin, or else be the URL of a plugin available online, with the id matching the ID as above.
5.         initializer: function (callback) { //required - all your code should go in here
6.    
7.             /* your code here */
9.             calback()
10.         }
11. });

复制代码

Script

Github Link: https://github.com/Connor-Macleod/blacksmith-plugin-suite/blob/master/BlacksmithPluginManager.js

                Code:       

1. //=============================================================================
2. // BlacksmithPluginManager.js - v0.2.1
3. //=============================================================================
5. /*:
6. * @plugindesc Allows management of plugin dependencies
7. * @author Connor "Saelorable" Macleod <Blacksmith[at]saelora.com>
8. *
9. * @help This plugin does not provide plugin commands.
10. * COPYRIGHT: Copyright (c) 2019 Connor "Saelorable" Macleod
11. *
12. * Permission is hereby granted, free of charge, to any person obtaining a copy
13. * of this software and associated documentation files (the "Software"), to deal
14. * in the Software without restriction, including without limitation the rights
15. * to use, copy, modify, merge, publish and/or distribute copies of the Software,
16. * and to permit persons to whom the Software is furnished to do so, subject to
17. * the following conditions:
18. *
19. * That no additional charge is ascribed to the inclusion of the software.
20. * That attribution is included with any use of the software such that it is
21. *     visible to end users, either within any bundled software or on any related
22. *     download pages.
23. * That no bundled items intentionally promote hate speech or discrimination of
24. *     protected minorities.
25. *
26. * Additionally, permission to sublicense, and/or sell copies of the Software may
27. * be obtained by contacting the copyright holder. This permission may come with
28. * additional and/or more specific costs and/or conditions.
29. *
30. * The above copyright notice and this permission notice shall be included in all
31. * copies or substantial portions of the Software.
32. *
33. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39. * SOFTWARE.
40. *
41. * @param cacheOnlinePlugins
42. * @desc Should online plugins be cached when ran locally?
43. * @type boolean
44. * @default true
45. *
46. * @param onlinePlugins
47. * @type struct<OnlinePlugin>[]
48. * @desc Recommended when available!
49. *
50. * @param extraPluginParameters
51. * @desc parameters for plugins can also be set in js/params/pluginName.json
52. * @type struct<ExtraParam>[]
53. *
54. * @param allowRemoteConfigJson
55. * @desc ADVANCED USERS: set to true to load config from js/params/BlacksmithPluginManager.json !POTENTIAL LAG!
56. * @type boolean
57. * @default false
58. *
59. */
61. /*~struct~ExtraParam:
62. * @param PluginName
63. * @text Plugin Name
64. * @desc The name of the plugin you want to set a parameter for
65. * @type string
66. *
67. * @param ParamName
68. * @text Parameter
69. * @desc The parameter you want to set
70. * @type string
71. * @parent PluginName
72. *
73. * @param value
74. * @text Parameter Value
75. * @desc the value of the parameter you are setting
76. * @type note
77. *
78. */
80. /*~struct~OnlinePlugin:
81. * @param name
82. * @text Plugin Name
83. * @desc The name of the plugin you want to load. For Blacksmith plugins this should match the id of the plugin. Optional.
84. * @type string
85. *
86. * @param url
87. * @text Plugin Url
88. * @desc Must include the protocol. (i.e. the "http:" part)
89. * @type string
90. *
91. */
93. (function(){
94.     let pluginList = [];
95.     let Globals = {};
96.     let state = {};
97.     let initialised = [];
98.     let onlinePlugins = [];
99.     let parameters = PluginManager.parameters('BlacksmithPluginManager');
102.     let allowRemoteConfigJson = parameters
103.         && parameters.allowRemoteConfigJson;
105.     let parameters2;
106.     let paramsPath = "js/params/BlacksmithPluginManager.json";
107.     if (Utils.isNwjs()){
108.         let fs = require("fs");
109.         if (fs.existsSync(paramsPath)){
110.             paramsFile = fs.readFileSync(paramsPath);
111.             parameters2 = JSON.parse(paramsFile)
112.         }
113.     } else if(allowRemoteConfigJson) {
114.         let request = new XMLHttpRequest();
115.         request.open('GET', paramsPath, false);  // `false` makes the request synchronous
116.         request.send(null);
117.         if (request.status === 200) {
118.             parameters2 = JSON.parse(request.responseText);
119.         }
120.     }
121.     if (!parameters){
122.         parameters = {};
123.     }
124.     if (parameters2){
125.         for (let param in parameters2){
126.             if (parameters2.hasOwnProperty(param)) {
127.                 parameters[param] = parameters2[param];
128.             }
129.         }
130.     }
132.     const cacheOnlineDependencies = parameters.cacheOnlinePlugins;
134.     parameters.pluginParameters = {};
135.     let extraPluginParameters = parameters.extraPluginParameters && JSON.parse(parameters.extraPluginParameters);
136.     extraPluginParameters && extraPluginParameters.forEach(function(paramater){
137.         let paramName = paramater.paramName;
138.         let paramValue = JSON.parse(paramater.value);
139.         let pluginName = paramater.PluginName;
140.         if (!parameters.pluginParameters[pluginName]){
141.             parameters.pluginParameters[pluginName] = {};
142.         }
143.         parameters.pluginParameters[pluginName][paramName] = paramValue;
144.     });
146.     const initNext = function(){
148.         for (let index in pluginList){
149.             if (pluginList.hasOwnProperty(index)) {
150.                 let plugin = pluginList[index];
152.                 if (!plugin._initialised) {
153.                     if (!plugin.dependencies) {
154.                         //we initlaise this function if it has no dependencies
155.                         plugin._initFunction();
156.                         initialised.push(plugin);
157.                         return true;
158.                     } else {
159.                         let allInitialised = true;
160.                         for (let dependencyIndex in plugin.dependencies){
161.                             if (plugin.dependencies.hasOwnProperty(dependencyIndex)) {
162.                                 let dependency = plugin.dependencies[dependencyIndex];
163.                                 if (dependency.name){
164.                                     dependency = dependency.name
165.                                 }
166.                                 dependency = pluginList[dependency];
168.                                 if (!dependency._initialised) {
169.                                     allInitialised = false
170.                                 }
171.                             }
172.                         }
173.                         if (allInitialised) {
174.                             // we initialise this function if all of it's dependencies have been met
175.                             return plugin._initFunction();
176.                         }
177.                     }
178.                 }
179.             }
180.         }
181.         let loadFailed = pluginList.find(function(plugin){
182.             return !plugin._initialised;
183.         });
184.         if (loadFailed){
185.             return //an error;
186.         }
187.         allInitialised();
188.     };
190.     const initlaisePlugins = function(){
191.         initNext();
192.     };
193.     let dirtyHookSceneManagerRun = SceneManager.run;
194.     SceneManager.run = function(...args){
195.         //all plugins have loaded, but we still need to initialise ours!
196.         dirtyHookSceneManagerRun = dirtyHookSceneManagerRun.bind(SceneManager, ...args);
197.         initlaisePlugins();
199.     };
201.     const allInitialised = function(){
202.         dirtyHookSceneManagerRun();
203.     };
205.     const getPluginNameFromUrl = function(url){
206.         return /[^/]*$/.exec(url)[0].replace(/.js|.LPMP/, "");
207.     };
209.     const streamDependency = function(url){
210.         let script = document.createElement('script');
211.         script.type = 'text/javascript';
212.         script.src = url;
213.         script.async = false;
214.         script._url = url;
215.         document.body.appendChild(script);
216.     };
218.     const cacheFtpPlugin = function(url, name){
219.         const net = require('net');
220.         let controlSocket;
221.         let connectionOptions = {
222.             port: url.port || 21,
223.             host: url.hostname
224.         };
225.         let filename;
226.         let getFile = function(){
227.             let path = url.pathname;
228.             const match = /^(.*)[\\/]([^\\/]+)$/.exec(path);
229.             filename = match[2];
230.             let dir = match[1];
231.             controlSocket.write("CWD "+dir+ "\r\n",function(){
232.                 controlSocket.write("PASV"+ "\r\n", function(){
234.                 });
235.             })
236.         };
237.         controlSocket = net.createConnection(connectionOptions, function(){
238.             if(url.username && url.password){
239.                 controlSocket.write("USER "+url.username+ "\r\n", function(){
240.                     controlSocket.write("PASS "+url.password+ "\r\n", getFile)
241.                 })
242.             } else if (url.password){
243.                 controlSocket.write("USER anonymous"+ "\r\n", function(){
244.                     controlSocket.write("PASS "+url.password+ "\r\n", getFile)
245.                 })
246.             } else {
247.                 controlSocket.write("USER anonymous"+ "\r\n", function(){
248.                     controlSocket.write("PASS guest"+ "\r\n", getFile)
249.                 })
250.             }
251.         });
252.         controlSocket.on("data", function(dataBuffer){
253.             const data = dataBuffer.toString('utf8');
254.             let dataParse = /\((\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3})\)/.exec(data);
255.             if (dataParse){
256.                 let ip = dataParse[1]+"."+dataParse[2]+"."+dataParse[3]+"."+dataParse[4];
257.                 let port = parseInt(dataParse[5]) * 256+parseInt(dataParse[6]);
258.                 let dataSocket = net.createConnection({port: port, host: ip}, function(){
259.                     const fs = require('fs');
260.                     const file = fs.createWriteStream("js/plugins/cachedWebPlugins/"+name+".js");
261.                     dataSocket.pipe(file);
262.                     controlSocket.write("RETR "+filename+ "\r\n");
263.                 });
264.             } else if(data.match(/(\r\n|^)226/)){
265.                 controlSocket.end("QUIT"+ "\r\n")
266.                 dataSocket.end();
267.             }
268.         });
269.     };
271.     const cachePlugin = function(plugin){
272.         const { URL } = require('url');
273.         plugin.url = new URL(plugin.url);
274.         if (plugin.url.protocol ==='ftp:'){
275.             cacheFtpPlugin(plugin.url, plugin.name);
276.         } else {
277.             const fs = require('fs');
278.             const http = require('http');
279.             const file = fs.createWriteStream("js/plugins/cachedWebPlugins/"+plugin.name+".js");
280.             http.get(plugin.url, function(response) {
281.                 response.pipe(file);
282.             });
283.         }
285.         //since we need access to the script synchronously and the above functions must run
286.         // asynchronously, we also have to stream an online copy.
287.         streamDependency(plugin.url);
288.     };
290.     const loadFromCache = function(pluginName){
291.         const path = "js/plugins/cachedWebPlugins/"+ pluginName + ".js";
292.         const fs = require('fs');
293.         if (!fs.existsSync(path)) {
294.             return false;
295.         }
296.         let script = document.createElement('script');
297.         script.type = 'text/javascript';
298.         script.src = path;
299.         script.async = false;
300.         script._url = path;
301.         document.body.appendChild(script);
302.     };
304.     const loadOnlineDependency = function(dependency){
305.         if (cacheOnlineDependencies && Utils.isNwjs()){
306.             if (loadFromCache(dependency.name)){
307.                 return;
308.             } else {
309.                 cachePlugin(dependency);
310.             }
311.         } else {
312.             streamDependency(dependency.url)
313.         }
315.     };
317.     const loadOnlinePlugins = function(){
318.         onlinePlugins = JSON.parse(parameters.onlinePlugins);
319.         onlinePlugins.forEach(function(plugin){
320.             plugin = JSON.parse(plugin);
321.             if (!plugin.name){
322.                 plugin.name = getPluginNameFromUrl(plugin.url);
323.             }
324.             loadOnlineDependency(plugin);
325.         });
326.     };
327.     loadOnlinePlugins();
329.     let fastParameters = {};
331.     const preloadParamaters = function(pluginName){
332.         let pluginParameters = PluginManager._parameters[pluginName.toLowerCase()];
333.         let pluginParameters2;
334.         let paramsPath = "js/params/"+pluginName+".json";
335.         let paramsLoadedCallback = function(){
336.             if (!pluginParameters) {
337.                 pluginParameters = {};
338.             }
339.             if (pluginParameters2){
340.                 for (let param in pluginParameters2){
341.                     if (pluginParameters2.hasOwnProperty(param)) {
342.                         pluginParameters[param] = pluginParameters2[param];
343.                     }
344.                 }
345.             }
346.             if (parameters.pluginParameters[pluginName]){
347.                 for (let param in parameters.pluginParameters[pluginName]){
348.                     if (parameters.pluginParameters[pluginName].hasOwnProperty(param)) {
349.                         pluginParameters[param] = parameters.pluginParameters[pluginName][param];
350.                     }
351.                 }
352.             }
353.             fastParameters[pluginName] = pluginParameters;
354.         };
356.         if (Utils.isNwjs()){
357.             let fs = require("fs");
358.             if (fs.existsSync(paramsPath)){
359.                 fs.readFile(paramsPath, function(err, data){
360.                     pluginParameters2 = JSON.parse(data);
361.                     paramsLoadedCallback();
362.                 });
363.             }
364.         } else {
365.             let request = new XMLHttpRequest();
366.             request.open('GET', paramsPath);
367.             request.send(null);
369.             request.addEventListener("load", function(){
370.                 if (request.status === 200) {
371.                     pluginParameters2 = JSON.parse(this.responseText);
372.                     paramsLoadedCallback();
373.                 }
374.             });
375.         }
377.     };
379.     PluginManager.parameters = function(pluginName){
380.         if (fastParameters[pluginName]){
381.             return fastParameters[pluginName];
382.         }
383.         let pluginParameters = PluginManager._parameters[pluginName.toLowerCase()];
384.         let pluginParameters2;
385.         let paramsPath = "js/params/"+pluginName+".json";
386.         if (Utils.isNwjs()){
387.             let fs = require("fs");
388.             if (fs.existsSync(paramsPath)){
389.                 paramsFile = fs.readFileSync(paramsPath);
390.                 pluginParameters2 = JSON.parse(paramsFile)
391.             }
392.         } else {
393.             let request = new XMLHttpRequest();
394.             request.open('GET', paramsPath, false);  // `false` makes the request synchronous
395.             request.send(null);
396.             if (request.status === 200) {
397.                 pluginParameters2 = JSON.parse(request.responseText);
398.             }
399.         }
400.         if (!pluginParameters) {
401.             pluginParameters = {};
402.         }
403.         if (pluginParameters2){
404.             for (let param in pluginParameters2){
405.                 if (pluginParameters2.hasOwnProperty(param)) {
406.                     pluginParameters[param] = pluginParameters2[param];
407.                 }
408.             }
409.         }
410.         fastParameters[pluginName] = pluginParameters;
411.         return pluginParameters;
412.     };
414.     class Plugin {
415.         constructor(pluginConfig){
416.             // id and dependencies are required, so we don't check for them
417.             // TODO: error handling for incorrectly created Plugins to make it more clear when an author has messed up
418.             if (!pluginConfig.globals){
419.                 pluginConfig.globals = [];
420.             }
421.             if (!pluginConfig.humanReadableName){
422.                 pluginConfig.humanReadableName = pluginConfig.id.replace(/([A-Z])/g, " $1").replace(/^ /, "");
423.             }
424.             if (!pluginConfig.dependencies){
425.                 pluginConfig.dependencies = [];
426.             }
427.             this._id = pluginConfig.id;
428.             this._humanReadableName = pluginConfig.humanReadableName;
429.             this._globals = pluginConfig.globals;
430.             this._dependencies = pluginConfig.dependencies;
431.             this.init = pluginConfig.initializer;
432.             Globals[this._id] = this._globals;
433.             if (this.dependencies){
434.                 this.dependencies.forEach(function(dependency){
435.                     if (typeof dependency == "string"){
436.                         if (dependency.match(/^https?:\/\//)){
437.                             dependency = {
438.                                 url: dependency
439.                             };
440.                         } else {
441.                             dependency = {
442.                                 name: dependency
443.                             };
444.                         }
445.                     }
446.                     if (dependency.url){
447.                         if (!dependency.name){
448.                             dependency.name = getPluginNameFromUrl(dependency.url)
449.                         }
450.                         if (!onlinePlugins.contains(dependency.name)){
451.                             loadOnlineDependency(dependency);
452.                             onlinePlugins.push(dependency.name);
453.                         }
454.                     } else {
455.                         if (!PluginManager._scripts.contains(dependency.name)) { // we load dependencies even if they're turned off
456.                             PluginManager.loadScript(dependency.name + '.js');
457.                             PluginManager._scripts.push(dependency.name);
458.                         }
459.                     }
460.                 });
461.             }
462.             preloadParamaters(this._id);
463.             pluginList[this._id] = this;
464.         }
466.         set init(initFunction){
467.             if (!this._initFunction){
468.                 let thisplugin = this;
469.                 this._initFunction = function(){
470.                     initFunction(function(error, message){
471.                         if (error){
472.                             //terminate loading with helpful message
473.                         } else {
474.                             thisplugin._initialised=true;
475.                             initNext();
476.                         }
477.                     });
478.                 }
479.             } else {
480.                 //throw error about init function already registered
481.             }
482.         }
484.         get dependencies(){
485.             if (
486.                 !this._dependencies ||
487.                 this._dependencies instanceof Plugin ||
488.                 this._dependencies.length===0
489.             ){
490.                 return false;
491.             }
492.             if (this._dependencies instanceof Plugin){
493.                 return [this._dependencies];
494.             }
495.             if (this._dependencies.length > 0){
496.                 return this._dependencies
497.             }
499.         }
501.         global (name, value){
502.             if (value!==undefined){
503.                 Globals[this._id][name] = value;
504.             }
505.             return Globals[this._id][name];
506.         }
507.     }
510.     PluginManager.Plugin = Plugin;
511.     PluginManager.plugins = pluginList
513. })();

复制代码

FAQ
Q: I'm working on a plugin that depends on another plugin and it's not a compatible plugin, how do i include it?
A: Just include the dependancy in the same way you would a compatible plugin. All non-compatible plugins are loaded before blacksmith plugins, so you can guarantee the dependancy will be loaded first.

Q: I'm insane and want to include a plugin available over ftp.
A: Why? what even... ?!? Luckily i'm insane too and included a rudimentary FTP client in the code, so there is partial support for including ftp sources. You will need to enable caching online plugins, and run the game once in test mode for it to work though.

Q: What's this i hear about JSON files?
A: You can include configuration for any plugins in a json file named after the plugin. I.E. "js/plugins/examplePlugin.json"

Licencing
Copyright (c) 2019 Connor "Saelorable" Macleod

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish and/or distribute copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

• That no additional charge is ascribed to the inclusion of the software.
  
• That attribution is included with any use of the software such that it is visible to end users, either within any bundled software or on any related download pages.
  
• That no bundled items intentionally promote hate speech or discrimination of protected minorities.
  

Additionally, permission to sublicense, and/or sell copies of the Software may be obtained by contacting the copyright holder. This permission may come with additional and/or more specific costs and/or conditions.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author's Notes
All feedback is greatly appreciated!


本贴来自国际rpgmaker官方论坛作者:Saelorable处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/plugin-manager-and-download-tool-blacksmithpluginmanager-v0-2-1.105933/