gvsig-scripting / org.gvsig.scripting / trunk / org.gvsig.scripting / org.gvsig.scripting.lib / org.gvsig.scripting.lib.impl / src / main / java / org / gvsig / scripting / impl / DefaultScriptingManager.java @ 585
History | View | Annotate | Download (17 KB)
1 |
package org.gvsig.scripting.impl; |
---|---|
2 |
|
3 |
import java.io.File; |
4 |
import java.util.ArrayList; |
5 |
import java.util.Collections; |
6 |
import java.util.HashMap; |
7 |
import java.util.Iterator; |
8 |
import java.util.List; |
9 |
import java.util.Map; |
10 |
|
11 |
import javax.script.ScriptContext; |
12 |
import javax.script.ScriptEngine; |
13 |
import javax.script.ScriptEngineFactory; |
14 |
import javax.script.ScriptEngineManager; |
15 |
import javax.script.SimpleBindings; |
16 |
import javax.swing.ImageIcon; |
17 |
|
18 |
import org.apache.commons.io.FileUtils; |
19 |
import org.apache.commons.io.FilenameUtils; |
20 |
import org.gvsig.scripting.ScriptingBaseScript; |
21 |
import org.gvsig.scripting.ScriptingDialog; |
22 |
import org.gvsig.scripting.ScriptingFolder; |
23 |
import org.gvsig.scripting.ScriptingHelpManager; |
24 |
import org.gvsig.scripting.ScriptingManager; |
25 |
import org.gvsig.scripting.ScriptingScript; |
26 |
import org.gvsig.scripting.ScriptingUnit; |
27 |
import org.gvsig.tools.service.spi.ProviderFactory; |
28 |
import org.slf4j.Logger; |
29 |
import org.slf4j.LoggerFactory; |
30 |
|
31 |
public class DefaultScriptingManager implements ScriptingManager { |
32 |
|
33 |
public static class RegisterSystemFolder { |
34 |
|
35 |
public String name; |
36 |
public File folder; |
37 |
|
38 |
public RegisterSystemFolder(String name, File folder) { |
39 |
this.name = name;
|
40 |
this.folder = folder;
|
41 |
} |
42 |
} |
43 |
|
44 |
private static final Logger LOG = LoggerFactory |
45 |
.getLogger(DefaultScriptingManager.class); |
46 |
|
47 |
protected Map<String, ImageIcon> icons; |
48 |
protected List<RegisterSystemFolder> systemFolders = new ArrayList<>(); |
49 |
protected ScriptEngineManager engineManager = null; |
50 |
private final SimpleBindings bindings = new SimpleBindings(); |
51 |
private ScriptingHelpManager helpManager = null; |
52 |
private List<String> unitTypes = null; |
53 |
private ClassLoader classLoader = null; |
54 |
private List<File> libFolders = new ArrayList<>(); |
55 |
private File home = null; |
56 |
private List<ScriptingFolder> alternativeUserFolders = new ArrayList<>(); |
57 |
private Map<String, String> extensionOfLanguage = null; |
58 |
private Map<String, String> languageOfExtension = null; |
59 |
private File packagesFolder; |
60 |
|
61 |
public DefaultScriptingManager() {
|
62 |
this.classLoader = getClass().getClassLoader();
|
63 |
this.setHomeFolder(null); |
64 |
this.bindings.put("ScriptingManager", this); |
65 |
} |
66 |
|
67 |
public DefaultScriptingManager(ClassLoader classLoader) { |
68 |
this();
|
69 |
this.classLoader = classLoader;
|
70 |
} |
71 |
|
72 |
private void createFolder(File f) { |
73 |
if (!f.exists()) {
|
74 |
try {
|
75 |
FileUtils.forceMkdir(f); |
76 |
LOG.info("Created scripting folder '" + f.getAbsolutePath() + "'"); |
77 |
} catch (Throwable e) { |
78 |
LOG.warn("Can't Create scripting folder '" + f.getAbsolutePath() + "'"); |
79 |
} |
80 |
} |
81 |
} |
82 |
|
83 |
private void createDefaultFolders(File home) { |
84 |
createFolder(new File(home, "scripts")); |
85 |
createFolder(new File(home, "help")); |
86 |
createFolder(new File(home, "lib")); |
87 |
} |
88 |
|
89 |
@Override
|
90 |
public File getHomeFolder() { |
91 |
if (!this.home.exists()) { |
92 |
createFolder(home); |
93 |
createDefaultFolders(home); |
94 |
} |
95 |
return this.home; |
96 |
} |
97 |
|
98 |
@Override
|
99 |
public void setHomeFolder(File home) { |
100 |
if (home == null) { |
101 |
this.home = new File(System.getProperty("user.home"), ".gvsig-scripting"); |
102 |
} else {
|
103 |
this.home = home;
|
104 |
} |
105 |
createDefaultFolders(this.home);
|
106 |
LOG.info("Set scripting home to '" + this.home.getAbsolutePath() + "'"); |
107 |
this.addLibFolder(new File(this.home, "lib")); |
108 |
} |
109 |
|
110 |
protected ScriptEngineManager getEngineManager() {
|
111 |
if (this.engineManager == null) { |
112 |
this.engineManager
|
113 |
= classLoader == null ? new ScriptEngineManager() |
114 |
: new ScriptEngineManager(classLoader);
|
115 |
showEnginesInfo(engineManager); |
116 |
} |
117 |
return this.engineManager; |
118 |
} |
119 |
|
120 |
private void showEnginesInfo(ScriptEngineManager mgr) { |
121 |
if (LOG.isInfoEnabled()) {
|
122 |
List<ScriptEngineFactory> factories = mgr.getEngineFactories();
|
123 |
StringBuilder buffer = new StringBuilder(); |
124 |
List<Object> values = new ArrayList<>(); |
125 |
buffer.append("Scripting engines available:");
|
126 |
for (ScriptEngineFactory factory : factories) {
|
127 |
|
128 |
// Main engine info
|
129 |
buffer |
130 |
.append("\n- {}: version = {}, language = {}, langVersion = {}");
|
131 |
values.add(factory.getEngineName()); |
132 |
values.add(factory.getEngineVersion()); |
133 |
values.add(factory.getLanguageName()); |
134 |
values.add(factory.getLanguageVersion()); |
135 |
|
136 |
// Aliases
|
137 |
buffer.append("\n\t- Aliases: ");
|
138 |
List<String> engNames = factory.getNames(); |
139 |
int size = engNames.size();
|
140 |
for (String name : engNames) { |
141 |
size--; |
142 |
buffer.append("{}");
|
143 |
if (size > 0) { |
144 |
buffer.append(", ");
|
145 |
} |
146 |
values.add(name); |
147 |
} |
148 |
buffer.append("\n\t- File extensions: ");
|
149 |
List<String> extNames = factory.getExtensions(); |
150 |
size = extNames.size(); |
151 |
for (String name : extNames) { |
152 |
size--; |
153 |
buffer.append("{}");
|
154 |
if (size > 0) { |
155 |
buffer.append(", ");
|
156 |
} |
157 |
values.add(name); |
158 |
} |
159 |
buffer.append("\n\t- Mime types: ");
|
160 |
List<String> mimeNames = factory.getMimeTypes(); |
161 |
size = mimeNames.size(); |
162 |
for (String name : mimeNames) { |
163 |
size--; |
164 |
buffer.append("{}");
|
165 |
if (size > 0) { |
166 |
buffer.append(", ");
|
167 |
} |
168 |
values.add(name); |
169 |
} |
170 |
|
171 |
} |
172 |
LOG.info(buffer.toString(), values.toArray()); |
173 |
} |
174 |
} |
175 |
|
176 |
public void loadEngines() { |
177 |
this.getEngineManager();
|
178 |
} |
179 |
|
180 |
protected ScriptEngine getEngine(String langName) { |
181 |
ScriptEngineManager manager = this.getEngineManager();
|
182 |
ScriptEngine engine = manager.getEngineByName(langName); |
183 |
engine.getBindings(ScriptContext.ENGINE_SCOPE).putAll(bindings); |
184 |
return engine;
|
185 |
} |
186 |
|
187 |
public ImageIcon getIcon(String name) { |
188 |
return this.icons.get(name); |
189 |
} |
190 |
|
191 |
@Override
|
192 |
public String getEngineNameByLanguage(String langName) { |
193 |
List<ScriptEngineFactory> factories
|
194 |
= getEngineManager().getEngineFactories(); |
195 |
|
196 |
for (ScriptEngineFactory factory : factories) {
|
197 |
if (factory.getLanguageName().equalsIgnoreCase(langName)) {
|
198 |
return factory.getEngineName();
|
199 |
} |
200 |
} |
201 |
return null; |
202 |
} |
203 |
|
204 |
public ScriptEngine getEngineByLanguage(String langName) { |
205 |
List<ScriptEngineFactory> factories
|
206 |
= getEngineManager().getEngineFactories(); |
207 |
|
208 |
for (ScriptEngineFactory factory : factories) {
|
209 |
if (factory.getLanguageName().equalsIgnoreCase(langName)) {
|
210 |
return factory.getScriptEngine();
|
211 |
} |
212 |
} |
213 |
return null; |
214 |
} |
215 |
|
216 |
@Override
|
217 |
public boolean validateUnitId(ScriptingFolder folder, String id) { |
218 |
List<ScriptingUnit> units = folder.getUnits();
|
219 |
String fileName;
|
220 |
String s[]; |
221 |
String extension;
|
222 |
for (ScriptingUnit unit : units) {
|
223 |
fileName = unit.getId(); |
224 |
fileName = FilenameUtils.getBaseName(fileName); |
225 |
if (fileName.equals(id)) {
|
226 |
return false; |
227 |
} |
228 |
} |
229 |
return true; |
230 |
} |
231 |
|
232 |
public ScriptingScript createScript(ScriptingFolder folder, String id) { |
233 |
return this.createScript(folder, id, null); |
234 |
} |
235 |
|
236 |
private ScriptingScript createScript(ScriptingFolder folder, String id, String language) { |
237 |
DefaultScriptingScript script = new DefaultScriptingScript(folder, this, id); |
238 |
if (!script.getFile().exists()) {
|
239 |
script.create(folder, id, language); |
240 |
} else {
|
241 |
script.load(folder, id); |
242 |
} |
243 |
return script;
|
244 |
} |
245 |
|
246 |
public ScriptingDialog createDialog(ScriptingFolder folder, String id) { |
247 |
return this.createDialog(folder, id, null); |
248 |
} |
249 |
|
250 |
private ScriptingDialog createDialog(ScriptingFolder folder, String id, String language) { |
251 |
DefaultScriptingDialog dialog = new DefaultScriptingDialog(folder, this, id); |
252 |
if (!dialog.getFile().exists()) {
|
253 |
dialog.create(folder, id, language); |
254 |
} else {
|
255 |
dialog.load(folder, id); |
256 |
} |
257 |
return dialog;
|
258 |
} |
259 |
|
260 |
public ScriptingFolder createFolder(ScriptingFolder folder, String id) { |
261 |
DefaultScriptingFolder unit = new DefaultScriptingFolder(folder, this, new File(folder.getFile(), id)); |
262 |
unit.load(folder, id); |
263 |
if (!unit.getFile().exists()) {
|
264 |
unit.create(folder, id); |
265 |
} |
266 |
return unit;
|
267 |
} |
268 |
|
269 |
@Override
|
270 |
public ScriptingBaseScript getScript(File file) { |
271 |
ScriptingBaseScript script = (ScriptingBaseScript) this.getUnit(file);
|
272 |
if (script == null) { |
273 |
throw new ScriptNotFoundException(file); |
274 |
} |
275 |
return script;
|
276 |
} |
277 |
|
278 |
@Override
|
279 |
public ScriptingFolder getFolder(File file) { |
280 |
ScriptingFolder folder = (ScriptingFolder) this.getUnit(file);
|
281 |
if (folder == null) { |
282 |
throw new RuntimeException(file.getAbsolutePath()); |
283 |
} |
284 |
return folder;
|
285 |
} |
286 |
|
287 |
public ScriptingUnit getUnit(File file) { |
288 |
ScriptingFolder folder; |
289 |
ScriptingUnit unit; |
290 |
|
291 |
if (file.isAbsolute()) {
|
292 |
folder = new DefaultScriptingFolder(null, this, file.getParentFile()); |
293 |
unit = folder.getUnit(file); |
294 |
return unit;
|
295 |
} else {
|
296 |
folder = this.getUserFolder();
|
297 |
unit = folder.getUnit(file); |
298 |
if (unit != null) { |
299 |
return unit;
|
300 |
} |
301 |
|
302 |
folder = this.getSystemFolder();
|
303 |
unit = folder.getUnit(file); |
304 |
if (unit != null) { |
305 |
return unit;
|
306 |
} |
307 |
} |
308 |
return null; |
309 |
} |
310 |
|
311 |
@Override
|
312 |
public ScriptingFolder getSystemFolder() {
|
313 |
return new SystemFolder(this); |
314 |
} |
315 |
|
316 |
@Override
|
317 |
public ScriptingFolder getUserFolder() {
|
318 |
return new UserFolder(this, this.getRootUserFolder()); |
319 |
} |
320 |
|
321 |
@Override
|
322 |
public ScriptingBaseScript getScript(String name) { |
323 |
return (ScriptingBaseScript) findScript(null, name); |
324 |
} |
325 |
|
326 |
private ScriptingUnit findScript(ScriptingFolder folder, String name) { |
327 |
if (name == null) { |
328 |
return null; |
329 |
} |
330 |
if (name.trim().length() == 0) { |
331 |
return null; |
332 |
} |
333 |
ScriptingUnit unit; |
334 |
if (folder == null) { |
335 |
unit = findScript(this.getUserFolder(), name);
|
336 |
if (unit != null) { |
337 |
return unit;
|
338 |
} |
339 |
unit = findScript(this.getSystemFolder(), name);
|
340 |
return unit;
|
341 |
} |
342 |
List<ScriptingUnit> units = folder.getUnits();
|
343 |
Iterator<ScriptingUnit> it = units.iterator();
|
344 |
while (it.hasNext()) {
|
345 |
unit = it.next(); |
346 |
if (unit instanceof ScriptingFolder) { |
347 |
unit = findScript((ScriptingFolder) unit, name); |
348 |
if (unit != null) { |
349 |
return unit;
|
350 |
} |
351 |
} else if (unit instanceof ScriptingBaseScript) { |
352 |
if (name.equalsIgnoreCase(unit.getId())) {
|
353 |
return unit;
|
354 |
} |
355 |
} |
356 |
} |
357 |
return null; |
358 |
} |
359 |
|
360 |
@Override
|
361 |
public File getRootUserFolder() { |
362 |
return new File(this.getHomeFolder(), "scripts"); |
363 |
} |
364 |
|
365 |
@Override
|
366 |
public void registerSystemFolder(String name, File folder) { |
367 |
this.systemFolders.add(new RegisterSystemFolder(name, folder)); |
368 |
LOG.info("Register system folder name '" + name + "' folder " + folder.getAbsolutePath() + "'"); |
369 |
|
370 |
} |
371 |
|
372 |
public List<RegisterSystemFolder> getSystemFolders() { |
373 |
return this.systemFolders; |
374 |
} |
375 |
|
376 |
@Override
|
377 |
public List<ScriptingFolder> getAlternativeUserFolders() { |
378 |
return this.alternativeUserFolders; |
379 |
} |
380 |
|
381 |
@Override
|
382 |
public void addAlternativeUserFolder(File f, String name, String description) { |
383 |
UserFolder x = new UserFolder(this, f); |
384 |
x.setName(name); |
385 |
x.setDescription(description); |
386 |
x.setId("UserFolder_" + this.alternativeUserFolders.size() + 1); |
387 |
this.alternativeUserFolders.add(x);
|
388 |
} |
389 |
|
390 |
private void initLanguages() { |
391 |
if (this.extensionOfLanguage == null) { |
392 |
Map<String, String> extensionOfLanguage = new HashMap<>(); |
393 |
List<ScriptEngineFactory> factories = getEngineManager().getEngineFactories();
|
394 |
for (ScriptEngineFactory factory : factories) {
|
395 |
List<String> extensions = factory.getExtensions(); |
396 |
if (extensions != null && !extensions.isEmpty()) { |
397 |
extensionOfLanguage.put( |
398 |
factory.getLanguageName().toLowerCase(), |
399 |
extensions.get(0).toLowerCase()
|
400 |
); |
401 |
} |
402 |
} |
403 |
this.extensionOfLanguage = extensionOfLanguage;
|
404 |
} |
405 |
if (this.languageOfExtension == null) { |
406 |
Map<String, String> languageOfExtension = new HashMap<>(); |
407 |
List<ScriptEngineFactory> factories = getEngineManager().getEngineFactories();
|
408 |
for (ScriptEngineFactory factory : factories) {
|
409 |
List<String> extensions = factory.getExtensions(); |
410 |
if (extensions != null) { |
411 |
for (String extension1 : extensions) { |
412 |
languageOfExtension.put( |
413 |
extension1.toLowerCase(), |
414 |
factory.getLanguageName().toLowerCase() |
415 |
); |
416 |
} |
417 |
} |
418 |
} |
419 |
this.languageOfExtension = languageOfExtension;
|
420 |
} |
421 |
} |
422 |
|
423 |
@Override
|
424 |
public String getExtensionOfLanguage(String langName) { |
425 |
if (langName == null) { |
426 |
return null; |
427 |
} |
428 |
langName = langName.toLowerCase(); |
429 |
initLanguages(); |
430 |
return this.extensionOfLanguage.get(langName); |
431 |
} |
432 |
|
433 |
@Override
|
434 |
public List<String> getSupportedLanguages() { |
435 |
List<String> languages = new ArrayList<>(); |
436 |
|
437 |
initLanguages(); |
438 |
languages.addAll(this.extensionOfLanguage.keySet());
|
439 |
Collections.sort(languages);
|
440 |
return languages;
|
441 |
} |
442 |
|
443 |
public String getLanguageOfExtension(String extension) { |
444 |
if (extension == null) { |
445 |
return null; |
446 |
} |
447 |
extension = extension.toLowerCase(); |
448 |
if (extension.startsWith(".")) { |
449 |
extension = extension.substring(1);
|
450 |
} |
451 |
initLanguages(); |
452 |
return this.languageOfExtension.get(extension); |
453 |
} |
454 |
|
455 |
public Object get(String key) { |
456 |
return this.bindings.get(key); |
457 |
} |
458 |
|
459 |
public void put(String key, Object value) { |
460 |
this.bindings.put(key, value);
|
461 |
|
462 |
} |
463 |
|
464 |
@Override
|
465 |
public ScriptingHelpManager getHelpManager() {
|
466 |
if (this.helpManager == null) { |
467 |
this.helpManager = new DefaultScriptingHelpManager(this); |
468 |
} |
469 |
return this.helpManager; |
470 |
} |
471 |
|
472 |
@Override
|
473 |
public ScriptingUnit createUnit(String unitType, ScriptingFolder folder, String id) { |
474 |
return createUnit(unitType, folder, id, null); |
475 |
} |
476 |
|
477 |
@Override
|
478 |
public ScriptingUnit createUnit(String unitType, ScriptingFolder folder, String id, String language) { |
479 |
if (unitType.equals(UNIT_SCRIPT)) {
|
480 |
return this.createScript(folder, id, language); |
481 |
} |
482 |
if (unitType.equals(UNIT_DIALOG)) {
|
483 |
return this.createDialog(folder, id, language); |
484 |
} |
485 |
if (unitType.equals(UNIT_FOLDER)) {
|
486 |
return this.createFolder(folder, id); |
487 |
} |
488 |
return null; |
489 |
} |
490 |
|
491 |
@Override
|
492 |
public List<String> getUnitTypes() { |
493 |
if (this.unitTypes == null) { |
494 |
this.unitTypes = new ArrayList<>(); |
495 |
this.unitTypes.add(UNIT_SCRIPT);
|
496 |
this.unitTypes.add(UNIT_DIALOG);
|
497 |
this.unitTypes.add(UNIT_FOLDER);
|
498 |
} |
499 |
return this.unitTypes; |
500 |
} |
501 |
|
502 |
@Override
|
503 |
public void addLibFolder(File lib) { |
504 |
if (lib.exists()) {
|
505 |
LOG.info("Add scripting lib folder '" + lib.getAbsolutePath() + "'"); |
506 |
this.libFolders.add(lib);
|
507 |
} else {
|
508 |
LOG.info("Skip add scripting lib folder '" + lib.getAbsolutePath() + "', folder don't exist"); |
509 |
} |
510 |
} |
511 |
|
512 |
public List<File> getLibFolders() { |
513 |
return this.libFolders; |
514 |
} |
515 |
|
516 |
public ProviderFactory getInstallerFactory() {
|
517 |
return new ScriptingInstallerProviderFactory(); |
518 |
} |
519 |
|
520 |
public ProviderFactory getHelpInstallerFactory() {
|
521 |
return new ScriptingHelpInstallerProviderFactory(); |
522 |
} |
523 |
|
524 |
@Override
|
525 |
public File getPackagesFolder() { |
526 |
return this.packagesFolder; |
527 |
} |
528 |
|
529 |
@Override
|
530 |
public void setPackagesFolder(File folder) { |
531 |
this.packagesFolder = folder;
|
532 |
} |
533 |
|
534 |
} |