001// License: GPL. See LICENSE file for details. 002 003package org.openstreetmap.josm.gui; 004 005import static org.openstreetmap.josm.tools.I18n.tr; 006 007import java.awt.BorderLayout; 008import java.awt.EventQueue; 009import java.awt.GraphicsEnvironment; 010import java.awt.event.InputEvent; 011import java.awt.event.KeyEvent; 012import java.io.IOException; 013import java.net.URL; 014import java.nio.charset.StandardCharsets; 015import java.util.regex.Matcher; 016import java.util.regex.Pattern; 017 018import javax.swing.JComponent; 019import javax.swing.JPanel; 020import javax.swing.JScrollPane; 021import javax.swing.KeyStroke; 022import javax.swing.border.EmptyBorder; 023import javax.swing.event.HyperlinkEvent; 024import javax.swing.event.HyperlinkListener; 025 026import org.openstreetmap.josm.Main; 027import org.openstreetmap.josm.data.Version; 028import org.openstreetmap.josm.gui.preferences.server.ProxyPreference; 029import org.openstreetmap.josm.gui.preferences.server.ProxyPreferenceListener; 030import org.openstreetmap.josm.gui.widgets.JosmEditorPane; 031import org.openstreetmap.josm.io.CacheCustomContent; 032import org.openstreetmap.josm.tools.LanguageInfo; 033import org.openstreetmap.josm.tools.OpenBrowser; 034import org.openstreetmap.josm.tools.WikiReader; 035 036public final class GettingStarted extends JPanel implements ProxyPreferenceListener { 037 038 private final LinkGeneral lg; 039 private String content = ""; 040 private boolean contentInitialized = false; 041 042 private static final String STYLE = "<style type=\"text/css\">\n" 043 + "body {font-family: sans-serif; font-weight: bold; }\n" 044 + "h1 {text-align: center; }\n" 045 + ".icon {font-size: 0; }\n" 046 + "</style>\n"; 047 048 public static class LinkGeneral extends JosmEditorPane implements HyperlinkListener { 049 050 /** 051 * Constructs a new {@code LinkGeneral} with the given HTML text 052 * @param text The text to display 053 */ 054 public LinkGeneral(String text) { 055 setContentType("text/html"); 056 setText(text); 057 setEditable(false); 058 setOpaque(false); 059 addHyperlinkListener(this); 060 adaptForNimbus(this); 061 } 062 063 @Override 064 public void hyperlinkUpdate(HyperlinkEvent e) { 065 if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) { 066 OpenBrowser.displayUrl(e.getDescription()); 067 } 068 } 069 } 070 071 /** 072 * Grabs current MOTD from cache or webpage and parses it. 073 */ 074 private static class MotdContent extends CacheCustomContent<IOException> { 075 public MotdContent() { 076 super("motd.html", CacheCustomContent.INTERVAL_DAILY); 077 } 078 079 private final int myVersion = Version.getInstance().getVersion(); 080 private final String myJava = System.getProperty("java.version"); 081 private final String myLang = LanguageInfo.getWikiLanguagePrefix(); 082 083 /** 084 * This function gets executed whenever the cached files need updating 085 * @see org.openstreetmap.josm.io.CacheCustomContent#updateData() 086 */ 087 @Override 088 protected byte[] updateData() throws IOException { 089 String motd = new WikiReader().readLang("StartupPage"); 090 // Save this to prefs in case JOSM is updated so MOTD can be refreshed 091 Main.pref.putInteger("cache.motd.html.version", myVersion); 092 Main.pref.put("cache.motd.html.java", myJava); 093 Main.pref.put("cache.motd.html.lang", myLang); 094 return motd.getBytes(StandardCharsets.UTF_8); 095 } 096 097 /** 098 * Additionally check if JOSM has been updated and refresh MOTD 099 */ 100 @Override 101 protected boolean isCacheValid() { 102 // We assume a default of myVersion because it only kicks in in two cases: 103 // 1. Not yet written - but so isn't the interval variable, so it gets updated anyway 104 // 2. Cannot be written (e.g. while developing). Obviously we don't want to update 105 // everytime because of something we can't read. 106 return (Main.pref.getInteger("cache.motd.html.version", -999) == myVersion) 107 && Main.pref.get("cache.motd.html.java").equals(myJava) 108 && Main.pref.get("cache.motd.html.lang").equals(myLang); 109 } 110 } 111 112 /** 113 * Initializes getting the MOTD as well as enabling the FileDrop Listener. Displays a message 114 * while the MOTD is downloading. 115 */ 116 public GettingStarted() { 117 super(new BorderLayout()); 118 lg = new LinkGeneral("<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor") 119 + "</h1><h2 align=\"center\">" + tr("Downloading \"Message of the day\"") + "</h2></html>"); 120 // clear the build-in command ctrl+shift+O, because it is used as shortcut in JOSM 121 lg.getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_O, InputEvent.SHIFT_MASK | InputEvent.CTRL_MASK), "none"); 122 123 JScrollPane scroller = new JScrollPane(lg); 124 scroller.setViewportBorder(new EmptyBorder(10, 100, 10, 100)); 125 add(scroller, BorderLayout.CENTER); 126 127 getMOTD(); 128 129 if (!GraphicsEnvironment.isHeadless()) { 130 new FileDrop(scroller); 131 } 132 } 133 134 private void getMOTD() { 135 // Asynchronously get MOTD to speed-up JOSM startup 136 Thread t = new Thread(new Runnable() { 137 @Override 138 public void run() { 139 if (!contentInitialized && Main.pref.getBoolean("help.displaymotd", true)) { 140 try { 141 content = new MotdContent().updateIfRequiredString(); 142 contentInitialized = true; 143 ProxyPreference.removeProxyPreferenceListener(GettingStarted.this); 144 } catch (IOException ex) { 145 Main.warn(tr("Failed to read MOTD. Exception was: {0}", ex.toString())); 146 content = "<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor") 147 + "</h1>\n<h2 align=\"center\">(" + tr("Message of the day not available") + ")</h2></html>"; 148 // In case of MOTD not loaded because of proxy error, listen to preference changes to retry after update 149 ProxyPreference.addProxyPreferenceListener(GettingStarted.this); 150 } 151 } 152 153 EventQueue.invokeLater(new Runnable() { 154 @Override 155 public void run() { 156 lg.setText(fixImageLinks(content)); 157 } 158 }); 159 } 160 }, "MOTD-Loader"); 161 t.setDaemon(true); 162 t.start(); 163 } 164 165 private String fixImageLinks(String s) { 166 Matcher m = Pattern.compile("src=\""+Main.getJOSMWebsite()+"/browser/trunk(/images/.*?\\.png)\\?format=raw\"").matcher(s); 167 StringBuffer sb = new StringBuffer(); 168 while (m.find()) { 169 String im = m.group(1); 170 URL u = getClass().getResource(im); 171 if (u != null) { 172 m.appendReplacement(sb, Matcher.quoteReplacement("src=\"" + u.toString() + "\"")); 173 } 174 } 175 m.appendTail(sb); 176 return sb.toString(); 177 } 178 179 @Override 180 public void proxyPreferenceChanged() { 181 getMOTD(); 182 } 183}