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

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

fix server preferences dialog broken in r6523 + reload MOTD after proxy update if it fails because of a proxy error

  • 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.event.InputEvent;
10import java.awt.event.KeyEvent;
11import java.io.IOException;
12import java.io.UnsupportedEncodingException;
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.WikiReader;
34
35public final class GettingStarted extends JPanel implements ProxyPreferenceListener {
36
37    private final LinkGeneral lg;
38    private String content = "";
39    private boolean contentInitialized = false;
40
41    private static final String STYLE = "<style type=\"text/css\">\n"
42            + "body {font-family: sans-serif; font-weight: bold; }\n"
43            + "h1 {text-align: center; }\n"
44            + ".icon {font-size: 0; }\n"
45            + "</style>\n";
46
47    public static class LinkGeneral extends JosmEditorPane implements HyperlinkListener {
48
49        /**
50         * Constructs a new {@code LinkGeneral} with the given HTML text
51         * @param text The text to display
52         */
53        public LinkGeneral(String text) {
54            setContentType("text/html");
55            setText(text);
56            setEditable(false);
57            setOpaque(false);
58            addHyperlinkListener(this);
59        }
60
61        @Override
62        public void hyperlinkUpdate(HyperlinkEvent e) {
63            if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
64                OpenBrowser.displayUrl(e.getDescription());
65            }
66        }
67    }
68
69    /**
70     * Grabs current MOTD from cache or webpage and parses it.
71     */
72    private static class MotdContent extends CacheCustomContent<IOException> {
73        public MotdContent() {
74            super("motd.html", CacheCustomContent.INTERVAL_DAILY);
75        }
76
77        final private int myVersion = Version.getInstance().getVersion();
78        final private String myJava = System.getProperty("java.version");
79        final private String myLang = LanguageInfo.getWikiLanguagePrefix();
80
81        /**
82         * This function gets executed whenever the cached files need updating
83         * @see org.openstreetmap.josm.io.CacheCustomContent#updateData()
84         */
85        @Override
86        protected byte[] updateData() throws IOException {
87            String motd = new WikiReader().readLang("StartupPage");
88            // Save this to prefs in case JOSM is updated so MOTD can be refreshed
89            Main.pref.putInteger("cache.motd.html.version", myVersion);
90            Main.pref.put("cache.motd.html.java", myJava);
91            Main.pref.put("cache.motd.html.lang", myLang);
92            try {
93                return motd.getBytes("utf-8");
94            } catch(UnsupportedEncodingException e){
95                e.printStackTrace();
96                return new byte[0];
97            }
98        }
99
100        /**
101         * Additionally check if JOSM has been updated and refresh MOTD
102         */
103        @Override
104        protected boolean isCacheValid() {
105            // We assume a default of myVersion because it only kicks in in two cases:
106            // 1. Not yet written - but so isn't the interval variable, so it gets updated anyway
107            // 2. Cannot be written (e.g. while developing). Obviously we don't want to update
108            // everytime because of something we can't read.
109            return (Main.pref.getInteger("cache.motd.html.version", -999) == myVersion)
110            && Main.pref.get("cache.motd.html.java").equals(myJava)
111            && Main.pref.get("cache.motd.html.lang").equals(myLang);
112        }
113    }
114
115    /**
116     * Initializes getting the MOTD as well as enabling the FileDrop Listener. Displays a message
117     * while the MOTD is downloading.
118     */
119    public GettingStarted() {
120        super(new BorderLayout());
121        lg = new LinkGeneral("<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor")
122                + "</h1><h2 align=\"center\">" + tr("Downloading \"Message of the day\"") + "</h2></html>");
123        // clear the build-in command ctrl+shift+O, because it is used as shortcut in JOSM
124        lg.getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_O, InputEvent.SHIFT_MASK | InputEvent.CTRL_MASK), "none");
125
126        JScrollPane scroller = new JScrollPane(lg);
127        scroller.setViewportBorder(new EmptyBorder(10, 100, 10, 100));
128        add(scroller, BorderLayout.CENTER);
129
130        getMOTD();
131
132        new FileDrop(scroller);
133    }
134
135    private void getMOTD() {
136        // Asynchronously get MOTD to speed-up JOSM startup
137        Thread t = new Thread(new Runnable() {
138            @Override
139            public void run() {
140                if (!contentInitialized && Main.pref.getBoolean("help.displaymotd", true)) {
141                    try {
142                        content = new MotdContent().updateIfRequiredString();
143                        contentInitialized = true;
144                        ProxyPreference.removeProxyPreferenceListener(GettingStarted.this);
145                    } catch (IOException ex) {
146                        Main.warn(tr("Failed to read MOTD. Exception was: {0}", ex.toString()));
147                        content = "<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor")
148                                + "</h1>\n<h2 align=\"center\">(" + tr("Message of the day not available") + ")</h2></html>";
149                        // In case of MOTD not loaded because of proxy error, listen to preference changes to retry after update
150                        ProxyPreference.addProxyPreferenceListener(GettingStarted.this);
151                    }
152                }
153
154                EventQueue.invokeLater(new Runnable() {
155                    @Override
156                    public void run() {
157                        lg.setText(fixImageLinks(content));
158                    }
159                });
160            }
161        }, "MOTD-Loader");
162        t.setDaemon(true);
163        t.start();
164    }
165
166    private String fixImageLinks(String s) {
167        Matcher m = Pattern.compile("src=\""+Main.JOSM_WEBSITE+"/browser/trunk(/images/.*?\\.png)\\?format=raw\"").matcher(s);
168        StringBuffer sb = new StringBuffer();
169        while (m.find()) {
170            String im = m.group(1);
171            URL u = getClass().getResource(im);
172            if (u != null) {
173                m.appendReplacement(sb, Matcher.quoteReplacement("src=\"" + u.toString() + "\""));
174            }
175        }
176        m.appendTail(sb);
177        return sb.toString();
178    }
179
180    @Override
181    public void proxyPreferenceChanged() {
182        getMOTD();
183    }
184}
Note: See TracBrowser for help on using the repository browser.