source: josm/trunk/src/org/openstreetmap/josm/gui/GettingStarted.java @ 7075

Last change on this file since 7075 was 7075, checked in by Don-vip, 5 years ago

Robustness to allow to run more unit tests in headless mode

  • Property svn:eol-style set to native
File size: 7.2 KB
Line 
1// License: GPL. See LICENSE file for details.
2
3package org.openstreetmap.josm.gui;
4
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.BorderLayout;
8import java.awt.EventQueue;
9import java.awt.GraphicsEnvironment;
10import java.awt.event.InputEvent;
11import java.awt.event.KeyEvent;
12import java.io.IOException;
13import java.net.URL;
14import java.util.regex.Matcher;
15import java.util.regex.Pattern;
16
17import javax.swing.JComponent;
18import javax.swing.JPanel;
19import javax.swing.JScrollPane;
20import javax.swing.KeyStroke;
21import javax.swing.border.EmptyBorder;
22import javax.swing.event.HyperlinkEvent;
23import javax.swing.event.HyperlinkListener;
24
25import org.openstreetmap.josm.Main;
26import org.openstreetmap.josm.data.Version;
27import org.openstreetmap.josm.gui.preferences.server.ProxyPreference;
28import org.openstreetmap.josm.gui.preferences.server.ProxyPreferenceListener;
29import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
30import org.openstreetmap.josm.io.CacheCustomContent;
31import org.openstreetmap.josm.tools.LanguageInfo;
32import org.openstreetmap.josm.tools.OpenBrowser;
33import org.openstreetmap.josm.tools.Utils;
34import org.openstreetmap.josm.tools.WikiReader;
35
36public final class GettingStarted extends JPanel implements ProxyPreferenceListener {
37
38    private final LinkGeneral lg;
39    private String content = "";
40    private boolean contentInitialized = false;
41
42    private static final String STYLE = "<style type=\"text/css\">\n"
43            + "body {font-family: sans-serif; font-weight: bold; }\n"
44            + "h1 {text-align: center; }\n"
45            + ".icon {font-size: 0; }\n"
46            + "</style>\n";
47
48    public static class LinkGeneral extends JosmEditorPane implements HyperlinkListener {
49
50        /**
51         * Constructs a new {@code LinkGeneral} with the given HTML text
52         * @param text The text to display
53         */
54        public LinkGeneral(String text) {
55            setContentType("text/html");
56            setText(text);
57            setEditable(false);
58            setOpaque(false);
59            addHyperlinkListener(this);
60            adaptForNimbus(this);
61        }
62
63        @Override
64        public void hyperlinkUpdate(HyperlinkEvent e) {
65            if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
66                OpenBrowser.displayUrl(e.getDescription());
67            }
68        }
69    }
70
71    /**
72     * Grabs current MOTD from cache or webpage and parses it.
73     */
74    private static class MotdContent extends CacheCustomContent<IOException> {
75        public MotdContent() {
76            super("motd.html", CacheCustomContent.INTERVAL_DAILY);
77        }
78
79        private final int myVersion = Version.getInstance().getVersion();
80        private final String myJava = System.getProperty("java.version");
81        private final String myLang = LanguageInfo.getWikiLanguagePrefix();
82
83        /**
84         * This function gets executed whenever the cached files need updating
85         * @see org.openstreetmap.josm.io.CacheCustomContent#updateData()
86         */
87        @Override
88        protected byte[] updateData() throws IOException {
89            String motd = new WikiReader().readLang("StartupPage");
90            // Save this to prefs in case JOSM is updated so MOTD can be refreshed
91            Main.pref.putInteger("cache.motd.html.version", myVersion);
92            Main.pref.put("cache.motd.html.java", myJava);
93            Main.pref.put("cache.motd.html.lang", myLang);
94            return motd.getBytes(Utils.UTF_8);
95        }
96
97        /**
98         * Additionally check if JOSM has been updated and refresh MOTD
99         */
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}
Note: See TracBrowser for help on using the repository browser.