source: josm/trunk/src/org/openstreetmap/josm/plugins/PluginInformation.java@ 12225

Last change on this file since 12225 was 12218, checked in by Don-vip, 7 years ago

code cleanup - catch ReflectiveOperationException when possible
  • Property svn:eol-style set to native
File size: 21.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.plugins;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.io.File;
7import java.io.FileInputStream;
8import java.io.IOException;
9import java.io.InputStream;
10import java.lang.reflect.Constructor;
11import java.net.URL;
12import java.text.MessageFormat;
13import java.util.ArrayList;
14import java.util.Collection;
15import java.util.LinkedList;
16import java.util.List;
17import java.util.Locale;
18import java.util.Map;
19import java.util.Optional;
20import java.util.TreeMap;
21import java.util.jar.Attributes;
22import java.util.jar.JarInputStream;
23import java.util.jar.Manifest;
24
25import javax.swing.ImageIcon;
26
27import org.openstreetmap.josm.Main;
28import org.openstreetmap.josm.data.Version;
29import org.openstreetmap.josm.tools.ImageProvider;
30import org.openstreetmap.josm.tools.LanguageInfo;
31import org.openstreetmap.josm.tools.Utils;
32
33/**
34 * Encapsulate general information about a plugin. This information is available
35 * without the need of loading any class from the plugin jar file.
36 *
37 * @author imi
38 * @since 153
39 */
40public class PluginInformation {
41
42 /** The plugin jar file. */
43 public File file;
44 /** The plugin name. */
45 public String name;
46 /** The lowest JOSM version required by this plugin (from plugin list). **/
47 public int mainversion;
48 /** The lowest JOSM version required by this plugin (from locally available jar). **/
49 public int localmainversion;
50 /** The plugin class name. */
51 public String className;
52 /** Determines if the plugin is an old version loaded for incompatibility with latest JOSM (from plugin list) */
53 public boolean oldmode;
54 /** The list of required plugins, separated by ';' (from plugin list). */
55 public String requires;
56 /** The list of required plugins, separated by ';' (from locally available jar). */
57 public String localrequires;
58 /** The plugin link (for documentation). */
59 public String link;
60 /** The plugin description. */
61 public String description;
62 /** Determines if the plugin must be loaded early or not. */
63 public boolean early;
64 /** The plugin author. */
65 public String author;
66 /** The plugin stage, determining the loading sequence order of plugins. */
67 public int stage = 50;
68 /** The plugin version (from plugin list). **/
69 public String version;
70 /** The plugin version (from locally available jar). **/
71 public String localversion;
72 /** The plugin download link. */
73 public String downloadlink;
74 /** The plugin icon path inside jar. */
75 public String iconPath;
76 /** The plugin icon. */
77 private ImageProvider icon;
78 /** Plugin can be loaded at any time and not just at start. */
79 public boolean canloadatruntime;
80 /** The libraries referenced in Class-Path manifest attribute. */
81 public List<URL> libraries = new LinkedList<>();
82 /** All manifest attributes. */
83 public final Map<String, String> attr = new TreeMap<>();
84 /** Empty icon for these plugins which have none */
85 private static final ImageIcon emptyIcon = ImageProvider.getEmpty(ImageProvider.ImageSizes.LARGEICON);
86
87 /**
88 * Creates a plugin information object by reading the plugin information from
89 * the manifest in the plugin jar.
90 *
91 * The plugin name is derived from the file name.
92 *
93 * @param file the plugin jar file
94 * @throws PluginException if reading the manifest fails
95 */
96 public PluginInformation(File file) throws PluginException {
97 this(file, file.getName().substring(0, file.getName().length()-4));
98 }
99
100 /**
101 * Creates a plugin information object for the plugin with name {@code name}.
102 * Information about the plugin is extracted from the manifest file in the plugin jar
103 * {@code file}.
104 * @param file the plugin jar
105 * @param name the plugin name
106 * @throws PluginException if reading the manifest file fails
107 */
108 public PluginInformation(File file, String name) throws PluginException {
109 if (!PluginHandler.isValidJar(file)) {
110 throw new PluginException(tr("Invalid jar file ''{0}''", file));
111 }
112 this.name = name;
113 this.file = file;
114 try (
115 FileInputStream fis = new FileInputStream(file);
116 JarInputStream jar = new JarInputStream(fis)
117 ) {
118 Manifest manifest = jar.getManifest();
119 if (manifest == null)
120 throw new PluginException(tr("The plugin file ''{0}'' does not include a Manifest.", file.toString()));
121 scanManifest(manifest, false);
122 libraries.add(0, Utils.fileToURL(file));
123 } catch (IOException e) {
124 throw new PluginException(name, e);
125 }
126 }
127
128 /**
129 * Creates a plugin information object by reading plugin information in Manifest format
130 * from the input stream {@code manifestStream}.
131 *
132 * @param manifestStream the stream to read the manifest from
133 * @param name the plugin name
134 * @param url the download URL for the plugin
135 * @throws PluginException if the plugin information can't be read from the input stream
136 */
137 public PluginInformation(InputStream manifestStream, String name, String url) throws PluginException {
138 this.name = name;
139 try {
140 Manifest manifest = new Manifest();
141 manifest.read(manifestStream);
142 if (url != null) {
143 downloadlink = url;
144 }
145 scanManifest(manifest, url != null);
146 } catch (IOException e) {
147 throw new PluginException(name, e);
148 }
149 }
150
151 /**
152 * Updates the plugin information of this plugin information object with the
153 * plugin information in a plugin information object retrieved from a plugin
154 * update site.
155 *
156 * @param other the plugin information object retrieved from the update site
157 */
158 public void updateFromPluginSite(PluginInformation other) {
159 this.mainversion = other.mainversion;
160 this.className = other.className;
161 this.requires = other.requires;
162 this.link = other.link;
163 this.description = other.description;
164 this.early = other.early;
165 this.author = other.author;
166 this.stage = other.stage;
167 this.version = other.version;
168 this.downloadlink = other.downloadlink;
169 this.icon = other.icon;
170 this.iconPath = other.iconPath;
171 this.canloadatruntime = other.canloadatruntime;
172 this.libraries = other.libraries;
173 this.attr.clear();
174 this.attr.putAll(other.attr);
175 }
176
177 /**
178 * Updates the plugin information of this plugin information object with the
179 * plugin information in a plugin information object retrieved from a plugin jar.
180 *
181 * @param other the plugin information object retrieved from the jar file
182 * @since 5601
183 */
184 public void updateFromJar(PluginInformation other) {
185 updateLocalInfo(other);
186 if (other.icon != null) {
187 this.icon = other.icon;
188 }
189 this.early = other.early;
190 this.className = other.className;
191 this.canloadatruntime = other.canloadatruntime;
192 this.libraries = other.libraries;
193 this.stage = other.stage;
194 this.file = other.file;
195 }
196
197 private void scanManifest(Manifest manifest, boolean oldcheck) {
198 String lang = LanguageInfo.getLanguageCodeManifest();
199 Attributes attr = manifest.getMainAttributes();
200 className = attr.getValue("Plugin-Class");
201 String s = Optional.ofNullable(attr.getValue(lang+"Plugin-Link")).orElseGet(() -> attr.getValue("Plugin-Link"));
202 if (s != null && !Utils.isValidUrl(s)) {
203 Main.info(tr("Invalid URL ''{0}'' in plugin {1}", s, name));
204 s = null;
205 }
206 link = s;
207 requires = attr.getValue("Plugin-Requires");
208 s = attr.getValue(lang+"Plugin-Description");
209 if (s == null) {
210 s = attr.getValue("Plugin-Description");
211 if (s != null) {
212 try {
213 s = tr(s);
214 } catch (IllegalArgumentException e) {
215 Main.debug(e);
216 Main.info(tr("Invalid plugin description ''{0}'' in plugin {1}", s, name));
217 }
218 }
219 } else {
220 s = MessageFormat.format(s, (Object[]) null);
221 }
222 description = s;
223 early = Boolean.parseBoolean(attr.getValue("Plugin-Early"));
224 String stageStr = attr.getValue("Plugin-Stage");
225 stage = stageStr == null ? 50 : Integer.parseInt(stageStr);
226 version = attr.getValue("Plugin-Version");
227 s = attr.getValue("Plugin-Mainversion");
228 if (s != null) {
229 try {
230 mainversion = Integer.parseInt(s);
231 } catch (NumberFormatException e) {
232 Main.warn(tr("Invalid plugin main version ''{0}'' in plugin {1}", s, name));
233 }
234 } else {
235 Main.warn(tr("Missing plugin main version in plugin {0}", name));
236 }
237 author = attr.getValue("Author");
238 iconPath = attr.getValue("Plugin-Icon");
239 if (iconPath != null) {
240 if (file != null) {
241 // extract icon from the plugin jar file
242 icon = new ImageProvider(iconPath).setArchive(file).setMaxSize(ImageProvider.ImageSizes.LARGEICON).setOptional(true);
243 } else if (iconPath.startsWith("data:")) {
244 icon = new ImageProvider(iconPath).setMaxSize(ImageProvider.ImageSizes.LARGEICON).setOptional(true);
245 }
246 }
247 canloadatruntime = Boolean.parseBoolean(attr.getValue("Plugin-Canloadatruntime"));
248 if (oldcheck && mainversion > Version.getInstance().getVersion()) {
249 int myv = Version.getInstance().getVersion();
250 for (Map.Entry<Object, Object> entry : attr.entrySet()) {
251 try {
252 String key = ((Attributes.Name) entry.getKey()).toString();
253 if (key.endsWith("_Plugin-Url")) {
254 int mv = Integer.parseInt(key.substring(0, key.length()-11));
255 if (mv <= myv && (mv > mainversion || mainversion > myv)) {
256 String v = (String) entry.getValue();
257 int i = v.indexOf(';');
258 if (i > 0) {
259 downloadlink = v.substring(i+1);
260 mainversion = mv;
261 version = v.substring(0, i);
262 oldmode = true;
263 }
264 }
265 }
266 } catch (NumberFormatException e) {
267 Main.error(e);
268 }
269 }
270 }
271
272 String classPath = attr.getValue(Attributes.Name.CLASS_PATH);
273 if (classPath != null) {
274 for (String entry : classPath.split(" ")) {
275 File entryFile;
276 if (new File(entry).isAbsolute() || file == null) {
277 entryFile = new File(entry);
278 } else {
279 entryFile = new File(file.getParent(), entry);
280 }
281
282 libraries.add(Utils.fileToURL(entryFile));
283 }
284 }
285 for (Object o : attr.keySet()) {
286 this.attr.put(o.toString(), attr.getValue(o.toString()));
287 }
288 }
289
290 /**
291 * Replies the description as HTML document, including a link to a web page with
292 * more information, provided such a link is available.
293 *
294 * @return the description as HTML document
295 */
296 public String getDescriptionAsHtml() {
297 StringBuilder sb = new StringBuilder(128);
298 sb.append("<html><body>")
299 .append(description == null ? tr("no description available") : Utils.escapeReservedCharactersHTML(description));
300 if (link != null) {
301 sb.append(" <a href=\"").append(link).append("\">").append(tr("More info...")).append("</a>");
302 }
303 if (downloadlink != null
304 && !downloadlink.startsWith("http://svn.openstreetmap.org/applications/editors/josm/dist/")
305 && !downloadlink.startsWith("https://svn.openstreetmap.org/applications/editors/josm/dist/")
306 && !downloadlink.startsWith("http://trac.openstreetmap.org/browser/applications/editors/josm/dist/")
307 && !downloadlink.startsWith("https://github.com/JOSM/")) {
308 sb.append("<p>&nbsp;</p><p>").append(tr("<b>Plugin provided by an external source:</b> {0}", downloadlink)).append("</p>");
309 }
310 sb.append("</body></html>");
311 return sb.toString();
312 }
313
314 /**
315 * Loads and instantiates the plugin.
316 *
317 * @param klass the plugin class
318 * @return the instantiated and initialized plugin
319 * @throws PluginException if the plugin cannot be loaded or instanciated
320 */
321 public PluginProxy load(Class<?> klass) throws PluginException {
322 try {
323 Constructor<?> c = klass.getConstructor(PluginInformation.class);
324 Object plugin = c.newInstance(this);
325 return new PluginProxy(plugin, this);
326 } catch (ReflectiveOperationException e) {
327 throw new PluginException(name, e);
328 }
329 }
330
331 /**
332 * Loads the class of the plugin.
333 *
334 * @param classLoader the class loader to use
335 * @return the loaded class
336 * @throws PluginException if the class cannot be loaded
337 */
338 public Class<?> loadClass(ClassLoader classLoader) throws PluginException {
339 if (className == null)
340 return null;
341 try {
342 return Class.forName(className, true, classLoader);
343 } catch (NoClassDefFoundError | ClassNotFoundException | ClassCastException e) {
344 throw new PluginException(name, e);
345 }
346 }
347
348 /**
349 * Try to find a plugin after some criterias. Extract the plugin-information
350 * from the plugin and return it. The plugin is searched in the following way:
351 *<ol>
352 *<li>first look after an MANIFEST.MF in the package org.openstreetmap.josm.plugins.&lt;plugin name&gt;
353 * (After removing all fancy characters from the plugin name).
354 * If found, the plugin is loaded using the bootstrap classloader.</li>
355 *<li>If not found, look for a jar file in the user specific plugin directory
356 * (~/.josm/plugins/&lt;plugin name&gt;.jar)</li>
357 *<li>If not found and the environment variable JOSM_RESOURCES + "/plugins/" exist, look there.</li>
358 *<li>Try for the java property josm.resources + "/plugins/" (set via java -Djosm.plugins.path=...)</li>
359 *<li>If the environment variable ALLUSERSPROFILE and APPDATA exist, look in
360 * ALLUSERSPROFILE/&lt;the last stuff from APPDATA&gt;/JOSM/plugins.
361 * (*sic* There is no easy way under Windows to get the All User's application
362 * directory)</li>
363 *<li>Finally, look in some typical unix paths:<ul>
364 * <li>/usr/local/share/josm/plugins/</li>
365 * <li>/usr/local/lib/josm/plugins/</li>
366 * <li>/usr/share/josm/plugins/</li>
367 * <li>/usr/lib/josm/plugins/</li></ul></li>
368 *</ol>
369 * If a plugin class or jar file is found earlier in the list but seem not to
370 * be working, an PluginException is thrown rather than continuing the search.
371 * This is so JOSM can detect broken user-provided plugins and do not go silently
372 * ignore them.
373 *
374 * The plugin is not initialized. If the plugin is a .jar file, it is not loaded
375 * (only the manifest is extracted). In the classloader-case, the class is
376 * bootstraped (e.g. static {} - declarations will run. However, nothing else is done.
377 *
378 * @param pluginName The name of the plugin (in all lowercase). E.g. "lang-de"
379 * @return Information about the plugin or <code>null</code>, if the plugin
380 * was nowhere to be found.
381 * @throws PluginException In case of broken plugins.
382 */
383 public static PluginInformation findPlugin(String pluginName) throws PluginException {
384 String name = pluginName;
385 name = name.replaceAll("[-. ]", "");
386 try (InputStream manifestStream = PluginInformation.class.getResourceAsStream("/org/openstreetmap/josm/plugins/"+name+"/MANIFEST.MF")) {
387 if (manifestStream != null) {
388 return new PluginInformation(manifestStream, pluginName, null);
389 }
390 } catch (IOException e) {
391 Main.warn(e);
392 }
393
394 Collection<String> locations = getPluginLocations();
395
396 for (String s : locations) {
397 File pluginFile = new File(s, pluginName + ".jar");
398 if (pluginFile.exists()) {
399 return new PluginInformation(pluginFile);
400 }
401 }
402 return null;
403 }
404
405 /**
406 * Returns all possible plugin locations.
407 * @return all possible plugin locations.
408 */
409 public static Collection<String> getPluginLocations() {
410 Collection<String> locations = Main.pref.getAllPossiblePreferenceDirs();
411 Collection<String> all = new ArrayList<>(locations.size());
412 for (String s : locations) {
413 all.add(s+"plugins");
414 }
415 return all;
416 }
417
418 /**
419 * Replies true if the plugin with the given information is most likely outdated with
420 * respect to the referenceVersion.
421 *
422 * @param referenceVersion the reference version. Can be null if we don't know a
423 * reference version
424 *
425 * @return true, if the plugin needs to be updated; false, otherweise
426 */
427 public boolean isUpdateRequired(String referenceVersion) {
428 if (this.downloadlink == null) return false;
429 if (this.version == null && referenceVersion != null)
430 return true;
431 return this.version != null && !this.version.equals(referenceVersion);
432 }
433
434 /**
435 * Replies true if this this plugin should be updated/downloaded because either
436 * it is not available locally (its local version is null) or its local version is
437 * older than the available version on the server.
438 *
439 * @return true if the plugin should be updated
440 */
441 public boolean isUpdateRequired() {
442 if (this.downloadlink == null) return false;
443 if (this.localversion == null) return true;
444 return isUpdateRequired(this.localversion);
445 }
446
447 protected boolean matches(String filter, String value) {
448 if (filter == null) return true;
449 if (value == null) return false;
450 return value.toLowerCase(Locale.ENGLISH).contains(filter.toLowerCase(Locale.ENGLISH));
451 }
452
453 /**
454 * Replies true if either the name, the description, or the version match (case insensitive)
455 * one of the words in filter. Replies true if filter is null.
456 *
457 * @param filter the filter expression
458 * @return true if this plugin info matches with the filter
459 */
460 public boolean matches(String filter) {
461 if (filter == null) return true;
462 String[] words = filter.split("\\s+");
463 for (String word: words) {
464 if (matches(word, name)
465 || matches(word, description)
466 || matches(word, version)
467 || matches(word, localversion))
468 return true;
469 }
470 return false;
471 }
472
473 /**
474 * Replies the name of the plugin.
475 * @return The plugin name
476 */
477 public String getName() {
478 return name;
479 }
480
481 /**
482 * Sets the name
483 * @param name Plugin name
484 */
485 public void setName(String name) {
486 this.name = name;
487 }
488
489 /**
490 * Replies the plugin icon, scaled to LARGE_ICON size.
491 * @return the plugin icon, scaled to LARGE_ICON size.
492 */
493 public ImageIcon getScaledIcon() {
494 ImageIcon img = (icon != null) ? icon.get() : null;
495 if (img == null)
496 return emptyIcon;
497 return img;
498 }
499
500 @Override
501 public final String toString() {
502 return getName();
503 }
504
505 private static List<String> getRequiredPlugins(String pluginList) {
506 List<String> requiredPlugins = new ArrayList<>();
507 if (pluginList != null) {
508 for (String s : pluginList.split(";")) {
509 String plugin = s.trim();
510 if (!plugin.isEmpty()) {
511 requiredPlugins.add(plugin);
512 }
513 }
514 }
515 return requiredPlugins;
516 }
517
518 /**
519 * Replies the list of plugins required by the up-to-date version of this plugin.
520 * @return List of plugins required. Empty if no plugin is required.
521 * @since 5601
522 */
523 public List<String> getRequiredPlugins() {
524 return getRequiredPlugins(requires);
525 }
526
527 /**
528 * Replies the list of plugins required by the local instance of this plugin.
529 * @return List of plugins required. Empty if no plugin is required.
530 * @since 5601
531 */
532 public List<String> getLocalRequiredPlugins() {
533 return getRequiredPlugins(localrequires);
534 }
535
536 /**
537 * Updates the local fields ({@link #localversion}, {@link #localmainversion}, {@link #localrequires})
538 * to values contained in the up-to-date fields ({@link #version}, {@link #mainversion}, {@link #requires})
539 * of the given PluginInformation.
540 * @param info The plugin information to get the data from.
541 * @since 5601
542 */
543 public void updateLocalInfo(PluginInformation info) {
544 if (info != null) {
545 this.localversion = info.version;
546 this.localmainversion = info.mainversion;
547 this.localrequires = info.requires;
548 }
549 }
550}
Note: See TracBrowser for help on using the repository browser.