001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.plugins; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.io.File; 007import java.io.FileInputStream; 008import java.io.IOException; 009import java.io.InputStream; 010import java.lang.reflect.Constructor; 011import java.lang.reflect.InvocationTargetException; 012import java.net.URL; 013import java.text.MessageFormat; 014import java.util.ArrayList; 015import java.util.Collection; 016import java.util.LinkedList; 017import java.util.List; 018import java.util.Locale; 019import java.util.Map; 020import java.util.TreeMap; 021import java.util.jar.Attributes; 022import java.util.jar.JarInputStream; 023import java.util.jar.Manifest; 024 025import javax.swing.ImageIcon; 026 027import org.openstreetmap.josm.Main; 028import org.openstreetmap.josm.data.Version; 029import org.openstreetmap.josm.tools.ImageProvider; 030import org.openstreetmap.josm.tools.LanguageInfo; 031import org.openstreetmap.josm.tools.Utils; 032 033/** 034 * Encapsulate general information about a plugin. This information is available 035 * without the need of loading any class from the plugin jar file. 036 * 037 * @author imi 038 * @since 153 039 */ 040public class PluginInformation { 041 042 /** The plugin jar file. */ 043 public File file; 044 /** The plugin name. */ 045 public String name; 046 /** The lowest JOSM version required by this plugin (from plugin list). **/ 047 public int mainversion; 048 /** The lowest JOSM version required by this plugin (from locally available jar). **/ 049 public int localmainversion; 050 /** The plugin class name. */ 051 public String className; 052 /** Determines if the plugin is an old version loaded for incompatibility with latest JOSM (from plugin list) */ 053 public boolean oldmode; 054 /** The list of required plugins, separated by ';' (from plugin list). */ 055 public String requires; 056 /** The list of required plugins, separated by ';' (from locally available jar). */ 057 public String localrequires; 058 /** The plugin link (for documentation). */ 059 public String link; 060 /** The plugin description. */ 061 public String description; 062 /** Determines if the plugin must be loaded early or not. */ 063 public boolean early; 064 /** The plugin author. */ 065 public String author; 066 /** The plugin stage, determining the loading sequence order of plugins. */ 067 public int stage = 50; 068 /** The plugin version (from plugin list). **/ 069 public String version; 070 /** The plugin version (from locally available jar). **/ 071 public String localversion; 072 /** The plugin download link. */ 073 public String downloadlink; 074 /** The plugin icon path inside jar. */ 075 public String iconPath; 076 /** The plugin icon. */ 077 private ImageProvider icon; 078 /** Plugin can be loaded at any time and not just at start. */ 079 public boolean canloadatruntime; 080 /** The libraries referenced in Class-Path manifest attribute. */ 081 public List<URL> libraries = new LinkedList<>(); 082 /** All manifest attributes. */ 083 public final Map<String, String> attr = new TreeMap<>(); 084 /** Empty icon for these plugins which have none */ 085 private static final ImageIcon emptyIcon = ImageProvider.getEmpty(ImageProvider.ImageSizes.LARGEICON); 086 087 /** 088 * Creates a plugin information object by reading the plugin information from 089 * the manifest in the plugin jar. 090 * 091 * The plugin name is derived from the file name. 092 * 093 * @param file the plugin jar file 094 * @throws PluginException if reading the manifest fails 095 */ 096 public PluginInformation(File file) throws PluginException { 097 this(file, file.getName().substring(0, file.getName().length()-4)); 098 } 099 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 = attr.getValue(lang+"Plugin-Link"); 202 if (s == null) { 203 s = attr.getValue("Plugin-Link"); 204 } 205 if (s != null && !Utils.isValidUrl(s)) { 206 Main.info(tr("Invalid URL ''{0}'' in plugin {1}", s, name)); 207 s = null; 208 } 209 link = s; 210 requires = attr.getValue("Plugin-Requires"); 211 s = attr.getValue(lang+"Plugin-Description"); 212 if (s == null) { 213 s = attr.getValue("Plugin-Description"); 214 if (s != null) { 215 try { 216 s = tr(s); 217 } catch (IllegalArgumentException e) { 218 Main.info(tr("Invalid plugin description ''{0}'' in plugin {1}", s, name)); 219 } 220 } 221 } else { 222 s = MessageFormat.format(s, (Object[]) null); 223 } 224 description = s; 225 early = Boolean.parseBoolean(attr.getValue("Plugin-Early")); 226 String stageStr = attr.getValue("Plugin-Stage"); 227 stage = stageStr == null ? 50 : Integer.parseInt(stageStr); 228 version = attr.getValue("Plugin-Version"); 229 s = attr.getValue("Plugin-Mainversion"); 230 if (s != null) { 231 try { 232 mainversion = Integer.parseInt(s); 233 } catch (NumberFormatException e) { 234 Main.warn(tr("Invalid plugin main version ''{0}'' in plugin {1}", s, name)); 235 } 236 } else { 237 Main.warn(tr("Missing plugin main version in plugin {0}", name)); 238 } 239 author = attr.getValue("Author"); 240 iconPath = attr.getValue("Plugin-Icon"); 241 if (iconPath != null) { 242 if (file != null) { 243 // extract icon from the plugin jar file 244 icon = new ImageProvider(iconPath).setArchive(file).setMaxSize(ImageProvider.ImageSizes.LARGEICON).setOptional(true); 245 } else if (iconPath.startsWith("data:")) { 246 icon = new ImageProvider(iconPath).setMaxSize(ImageProvider.ImageSizes.LARGEICON).setOptional(true); 247 } 248 } 249 canloadatruntime = Boolean.parseBoolean(attr.getValue("Plugin-Canloadatruntime")); 250 if (oldcheck && mainversion > Version.getInstance().getVersion()) { 251 int myv = Version.getInstance().getVersion(); 252 for (Map.Entry<Object, Object> entry : attr.entrySet()) { 253 try { 254 String key = ((Attributes.Name) entry.getKey()).toString(); 255 if (key.endsWith("_Plugin-Url")) { 256 int mv = Integer.parseInt(key.substring(0, key.length()-11)); 257 if (mv <= myv && (mv > mainversion || mainversion > myv)) { 258 String v = (String) entry.getValue(); 259 int i = v.indexOf(';'); 260 if (i > 0) { 261 downloadlink = v.substring(i+1); 262 mainversion = mv; 263 version = v.substring(0, i); 264 oldmode = true; 265 } 266 } 267 } 268 } catch (NumberFormatException e) { 269 Main.error(e); 270 } 271 } 272 } 273 274 String classPath = attr.getValue(Attributes.Name.CLASS_PATH); 275 if (classPath != null) { 276 for (String entry : classPath.split(" ")) { 277 File entryFile; 278 if (new File(entry).isAbsolute() || file == null) { 279 entryFile = new File(entry); 280 } else { 281 entryFile = new File(file.getParent(), entry); 282 } 283 284 libraries.add(Utils.fileToURL(entryFile)); 285 } 286 } 287 for (Object o : attr.keySet()) { 288 this.attr.put(o.toString(), attr.getValue(o.toString())); 289 } 290 } 291 292 /** 293 * Replies the description as HTML document, including a link to a web page with 294 * more information, provided such a link is available. 295 * 296 * @return the description as HTML document 297 */ 298 public String getDescriptionAsHtml() { 299 StringBuilder sb = new StringBuilder(128); 300 sb.append("<html><body>") 301 .append(description == null ? tr("no description available") : description); 302 if (link != null) { 303 sb.append(" <a href=\"").append(link).append("\">").append(tr("More info...")).append("</a>"); 304 } 305 if (downloadlink != null 306 && !downloadlink.startsWith("http://svn.openstreetmap.org/applications/editors/josm/dist/") 307 && !downloadlink.startsWith("https://svn.openstreetmap.org/applications/editors/josm/dist/") 308 && !downloadlink.startsWith("http://trac.openstreetmap.org/browser/applications/editors/josm/dist/") 309 && !downloadlink.startsWith("https://github.com/JOSM/")) { 310 sb.append("<p> </p><p>").append(tr("<b>Plugin provided by an external source:</b> {0}", downloadlink)).append("</p>"); 311 } 312 sb.append("</body></html>"); 313 return sb.toString(); 314 } 315 316 /** 317 * Loads and instantiates the plugin. 318 * 319 * @param klass the plugin class 320 * @return the instantiated and initialized plugin 321 * @throws PluginException if the plugin cannot be loaded or instanciated 322 */ 323 public PluginProxy load(Class<?> klass) throws PluginException { 324 try { 325 Constructor<?> c = klass.getConstructor(PluginInformation.class); 326 Object plugin = c.newInstance(this); 327 return new PluginProxy(plugin, this); 328 } catch (NoSuchMethodException | IllegalAccessException | InstantiationException | InvocationTargetException e) { 329 throw new PluginException(name, e); 330 } 331 } 332 333 /** 334 * Loads the class of the plugin. 335 * 336 * @param classLoader the class loader to use 337 * @return the loaded class 338 * @throws PluginException if the class cannot be loaded 339 */ 340 public Class<?> loadClass(ClassLoader classLoader) throws PluginException { 341 if (className == null) 342 return null; 343 try { 344 return Class.forName(className, true, classLoader); 345 } catch (NoClassDefFoundError | ClassNotFoundException | ClassCastException e) { 346 throw new PluginException(name, e); 347 } 348 } 349 350 /** 351 * Try to find a plugin after some criterias. Extract the plugin-information 352 * from the plugin and return it. The plugin is searched in the following way: 353 *<ol> 354 *<li>first look after an MANIFEST.MF in the package org.openstreetmap.josm.plugins.<plugin name> 355 * (After removing all fancy characters from the plugin name). 356 * If found, the plugin is loaded using the bootstrap classloader.</li> 357 *<li>If not found, look for a jar file in the user specific plugin directory 358 * (~/.josm/plugins/<plugin name>.jar)</li> 359 *<li>If not found and the environment variable JOSM_RESOURCES + "/plugins/" exist, look there.</li> 360 *<li>Try for the java property josm.resources + "/plugins/" (set via java -Djosm.plugins.path=...)</li> 361 *<li>If the environment variable ALLUSERSPROFILE and APPDATA exist, look in 362 * ALLUSERSPROFILE/<the last stuff from APPDATA>/JOSM/plugins. 363 * (*sic* There is no easy way under Windows to get the All User's application 364 * directory)</li> 365 *<li>Finally, look in some typical unix paths:<ul> 366 * <li>/usr/local/share/josm/plugins/</li> 367 * <li>/usr/local/lib/josm/plugins/</li> 368 * <li>/usr/share/josm/plugins/</li> 369 * <li>/usr/lib/josm/plugins/</li></ul></li> 370 *</ol> 371 * If a plugin class or jar file is found earlier in the list but seem not to 372 * be working, an PluginException is thrown rather than continuing the search. 373 * This is so JOSM can detect broken user-provided plugins and do not go silently 374 * ignore them. 375 * 376 * The plugin is not initialized. If the plugin is a .jar file, it is not loaded 377 * (only the manifest is extracted). In the classloader-case, the class is 378 * bootstraped (e.g. static {} - declarations will run. However, nothing else is done. 379 * 380 * @param pluginName The name of the plugin (in all lowercase). E.g. "lang-de" 381 * @return Information about the plugin or <code>null</code>, if the plugin 382 * was nowhere to be found. 383 * @throws PluginException In case of broken plugins. 384 */ 385 public static PluginInformation findPlugin(String pluginName) throws PluginException { 386 String name = pluginName; 387 name = name.replaceAll("[-. ]", ""); 388 try (InputStream manifestStream = PluginInformation.class.getResourceAsStream("/org/openstreetmap/josm/plugins/"+name+"/MANIFEST.MF")) { 389 if (manifestStream != null) { 390 return new PluginInformation(manifestStream, pluginName, null); 391 } 392 } catch (IOException e) { 393 Main.warn(e); 394 } 395 396 Collection<String> locations = getPluginLocations(); 397 398 for (String s : locations) { 399 File pluginFile = new File(s, pluginName + ".jar"); 400 if (pluginFile.exists()) { 401 return new PluginInformation(pluginFile); 402 } 403 } 404 return null; 405 } 406 407 /** 408 * Returns all possible plugin locations. 409 * @return all possible plugin locations. 410 */ 411 public static Collection<String> getPluginLocations() { 412 Collection<String> locations = Main.pref.getAllPossiblePreferenceDirs(); 413 Collection<String> all = new ArrayList<>(locations.size()); 414 for (String s : locations) { 415 all.add(s+"plugins"); 416 } 417 return all; 418 } 419 420 /** 421 * Replies true if the plugin with the given information is most likely outdated with 422 * respect to the referenceVersion. 423 * 424 * @param referenceVersion the reference version. Can be null if we don't know a 425 * reference version 426 * 427 * @return true, if the plugin needs to be updated; false, otherweise 428 */ 429 public boolean isUpdateRequired(String referenceVersion) { 430 if (this.downloadlink == null) return false; 431 if (this.version == null && referenceVersion != null) 432 return true; 433 if (this.version != null && !this.version.equals(referenceVersion)) 434 return true; 435 return false; 436 } 437 438 /** 439 * Replies true if this this plugin should be updated/downloaded because either 440 * it is not available locally (its local version is null) or its local version is 441 * older than the available version on the server. 442 * 443 * @return true if the plugin should be updated 444 */ 445 public boolean isUpdateRequired() { 446 if (this.downloadlink == null) return false; 447 if (this.localversion == null) return true; 448 return isUpdateRequired(this.localversion); 449 } 450 451 protected boolean matches(String filter, String value) { 452 if (filter == null) return true; 453 if (value == null) return false; 454 return value.toLowerCase(Locale.ENGLISH).contains(filter.toLowerCase(Locale.ENGLISH)); 455 } 456 457 /** 458 * Replies true if either the name, the description, or the version match (case insensitive) 459 * one of the words in filter. Replies true if filter is null. 460 * 461 * @param filter the filter expression 462 * @return true if this plugin info matches with the filter 463 */ 464 public boolean matches(String filter) { 465 if (filter == null) return true; 466 String[] words = filter.split("\\s+"); 467 for (String word: words) { 468 if (matches(word, name) 469 || matches(word, description) 470 || matches(word, version) 471 || matches(word, localversion)) 472 return true; 473 } 474 return false; 475 } 476 477 /** 478 * Replies the name of the plugin. 479 * @return The plugin name 480 */ 481 public String getName() { 482 return name; 483 } 484 485 /** 486 * Sets the name 487 * @param name Plugin name 488 */ 489 public void setName(String name) { 490 this.name = name; 491 } 492 493 /** 494 * Replies the plugin icon, scaled to LARGE_ICON size. 495 * @return the plugin icon, scaled to LARGE_ICON size. 496 */ 497 public ImageIcon getScaledIcon() { 498 ImageIcon img = (icon != null) ? icon.get() : null; 499 if (img == null) 500 return emptyIcon; 501 return img; 502 } 503 504 @Override 505 public final String toString() { 506 return getName(); 507 } 508 509 private static List<String> getRequiredPlugins(String pluginList) { 510 List<String> requiredPlugins = new ArrayList<>(); 511 if (pluginList != null) { 512 for (String s : pluginList.split(";")) { 513 String plugin = s.trim(); 514 if (!plugin.isEmpty()) { 515 requiredPlugins.add(plugin); 516 } 517 } 518 } 519 return requiredPlugins; 520 } 521 522 /** 523 * Replies the list of plugins required by the up-to-date version of this plugin. 524 * @return List of plugins required. Empty if no plugin is required. 525 * @since 5601 526 */ 527 public List<String> getRequiredPlugins() { 528 return getRequiredPlugins(requires); 529 } 530 531 /** 532 * Replies the list of plugins required by the local instance of this plugin. 533 * @return List of plugins required. Empty if no plugin is required. 534 * @since 5601 535 */ 536 public List<String> getLocalRequiredPlugins() { 537 return getRequiredPlugins(localrequires); 538 } 539 540 /** 541 * Updates the local fields ({@link #localversion}, {@link #localmainversion}, {@link #localrequires}) 542 * to values contained in the up-to-date fields ({@link #version}, {@link #mainversion}, {@link #requires}) 543 * of the given PluginInformation. 544 * @param info The plugin information to get the data from. 545 * @since 5601 546 */ 547 public void updateLocalInfo(PluginInformation info) { 548 if (info != null) { 549 this.localversion = info.version; 550 this.localmainversion = info.mainversion; 551 this.localrequires = info.requires; 552 } 553 } 554}