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

Last change on this file since 6084 was 6084, checked in by bastiK, 5 years ago

see #8902 - add missing @Override annotations (patch by shinigami)

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