001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.BorderLayout;
007import java.awt.EventQueue;
008import java.awt.Graphics;
009import java.io.IOException;
010import java.nio.charset.StandardCharsets;
011import java.util.regex.Matcher;
012import java.util.regex.Pattern;
013
014import javax.swing.JComponent;
015import javax.swing.JPanel;
016import javax.swing.JScrollPane;
017import javax.swing.Timer;
018import javax.swing.border.EmptyBorder;
019import javax.swing.event.HyperlinkEvent;
020import javax.swing.event.HyperlinkListener;
021
022import org.openstreetmap.josm.actions.DownloadAction;
023import org.openstreetmap.josm.actions.DownloadPrimitiveAction;
024import org.openstreetmap.josm.actions.HistoryInfoAction;
025import org.openstreetmap.josm.data.Version;
026import org.openstreetmap.josm.gui.animation.AnimationExtensionManager;
027import org.openstreetmap.josm.gui.datatransfer.OpenTransferHandler;
028import org.openstreetmap.josm.gui.dialogs.MenuItemSearchDialog;
029import org.openstreetmap.josm.gui.preferences.server.ProxyPreference;
030import org.openstreetmap.josm.gui.preferences.server.ProxyPreferenceListener;
031import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
032import org.openstreetmap.josm.io.CacheCustomContent;
033import org.openstreetmap.josm.io.NetworkManager;
034import org.openstreetmap.josm.io.OnlineResource;
035import org.openstreetmap.josm.spi.preferences.Config;
036import org.openstreetmap.josm.tools.ImageProvider;
037import org.openstreetmap.josm.tools.ImageProvider.ImageSizes;
038import org.openstreetmap.josm.tools.LanguageInfo;
039import org.openstreetmap.josm.tools.Logging;
040import org.openstreetmap.josm.tools.OpenBrowser;
041import org.openstreetmap.josm.tools.Utils;
042import org.openstreetmap.josm.tools.WikiReader;
043
044/**
045 * Panel that fills the main part of the program window when JOSM has just started.
046 *
047 * It downloads and displays the so called <em>message of the day</em>, which
048 * contains news about recent major changes, warning in case of outdated versions, etc.
049 */
050public final class GettingStarted extends JPanel implements ProxyPreferenceListener {
051
052    private final LinkGeneral lg;
053    private String content = "";
054    private boolean contentInitialized;
055    private final Timer timer = new Timer(50, e -> repaint());
056
057    private static final String STYLE = "<style type=\"text/css\">\n"
058            + "body {font-family: sans-serif; font-weight: bold; }\n"
059            + "h1 {text-align: center; }\n"
060            + "a {color: " + JosmEditorPane.getLinkColor() + "; }\n"
061            + ".icon {font-size: 0; }\n"
062            + "</style>\n";
063
064    public static class LinkGeneral extends JosmEditorPane implements HyperlinkListener {
065
066        /**
067         * Constructs a new {@code LinkGeneral} with the given HTML text
068         * @param text The text to display
069         */
070        public LinkGeneral(String text) {
071            setContentType("text/html");
072            setText(text);
073            setEditable(false);
074            setOpaque(false);
075            addHyperlinkListener(this);
076            adaptForNimbus(this);
077        }
078
079        @Override
080        public void hyperlinkUpdate(HyperlinkEvent e) {
081            if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
082                OpenBrowser.displayUrl(e.getDescription());
083            }
084        }
085    }
086
087    /**
088     * Grabs current MOTD from cache or webpage and parses it.
089     */
090    static class MotdContent extends CacheCustomContent<IOException> {
091        MotdContent() {
092            super("motd.html", CacheCustomContent.INTERVAL_DAILY);
093        }
094
095        private final int myVersion = Version.getInstance().getVersion();
096        private final String myJava = Utils.getSystemProperty("java.version");
097        private final String myLang = LanguageInfo.getWikiLanguagePrefix();
098
099        /**
100         * This function gets executed whenever the cached files need updating
101         * @see org.openstreetmap.josm.io.CacheCustomContent#updateData()
102         */
103        @Override
104        protected byte[] updateData() throws IOException {
105            String motd = new WikiReader().readLang("StartupPage");
106            // Save this to prefs in case JOSM is updated so MOTD can be refreshed
107            Config.getPref().putInt("cache.motd.html.version", myVersion);
108            Config.getPref().put("cache.motd.html.java", myJava);
109            Config.getPref().put("cache.motd.html.lang", myLang);
110            return motd.getBytes(StandardCharsets.UTF_8);
111        }
112
113        @Override
114        protected boolean isOffline() {
115            return NetworkManager.isOffline(OnlineResource.JOSM_WEBSITE);
116        }
117
118        /**
119         * Additionally check if JOSM has been updated and refresh MOTD
120         */
121        @Override
122        protected boolean isCacheValid() {
123            // We assume a default of myVersion because it only kicks in in two cases:
124            // 1. Not yet written - but so isn't the interval variable, so it gets updated anyway
125            // 2. Cannot be written (e.g. while developing). Obviously we don't want to update
126            // every time because of something we can't read.
127            return (Config.getPref().getInt("cache.motd.html.version", -999) == myVersion)
128            && Config.getPref().get("cache.motd.html.java").equals(myJava)
129            && Config.getPref().get("cache.motd.html.lang").equals(myLang);
130        }
131    }
132
133    /**
134     * Initializes getting the MOTD as well as enabling the FileDrop Listener. Displays a message
135     * while the MOTD is downloading.
136     */
137    public GettingStarted() {
138        super(new BorderLayout());
139        lg = new LinkGeneral("<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor")
140                + "</h1><h2 align=\"center\">" + tr("Downloading \"Message of the day\"") + "</h2></html>");
141        // clear the build-in command ctrl+shift+O, ctrl+space, ctrl+H because it is used as shortcut in JOSM
142        lg.getInputMap(JComponent.WHEN_FOCUSED).put(DownloadAction.SHORTCUT.getKeyStroke(), "none");
143        lg.getInputMap(JComponent.WHEN_FOCUSED).put(DownloadPrimitiveAction.SHORTCUT.getKeyStroke(), "none");
144        lg.getInputMap(JComponent.WHEN_FOCUSED).put(MenuItemSearchDialog.Action.SHORTCUT.getKeyStroke(), "none");
145        lg.getInputMap(JComponent.WHEN_FOCUSED).put(HistoryInfoAction.SHORTCUT.getKeyStroke(), "none");
146        lg.setTransferHandler(null);
147
148        JScrollPane scroller = new JScrollPane(lg);
149        scroller.setViewportBorder(new EmptyBorder(10, 100, 10, 100));
150        add(scroller, BorderLayout.CENTER);
151
152        getMOTD();
153
154        setTransferHandler(new OpenTransferHandler());
155    }
156
157    @Override
158    public void addNotify() {
159        if (AnimationExtensionManager.isExtensionEnabled()) {
160            timer.start();
161        }
162        super.addNotify();
163    }
164
165    @Override
166    public void removeNotify() {
167        if (timer.isRunning()) {
168            timer.stop();
169        }
170        super.removeNotify();
171    }
172
173    @Override
174    public void paint(Graphics g) {
175        super.paint(g);
176        if (isShowing()) {
177            AnimationExtensionManager.getExtension().adjustForSize(getWidth(), getHeight());
178            AnimationExtensionManager.getExtension().animate();
179            AnimationExtensionManager.getExtension().paint(g);
180        }
181    }
182
183    private void getMOTD() {
184        // Asynchronously get MOTD to speed-up JOSM startup
185        Thread t = new Thread((Runnable) () -> {
186            if (!contentInitialized && Config.getPref().getBoolean("help.displaymotd", true)) {
187                try {
188                    content = new MotdContent().updateIfRequiredString();
189                    contentInitialized = true;
190                    ProxyPreference.removeProxyPreferenceListener(this);
191                } catch (IOException ex) {
192                    Logging.log(Logging.LEVEL_WARN, tr("Failed to read MOTD. Exception was: {0}", ex.toString()), ex);
193                    content = "<html>" + STYLE + "<h1>" + "JOSM - " + tr("Java OpenStreetMap Editor")
194                            + "</h1>\n<h2 align=\"center\">(" + tr("Message of the day not available") + ")</h2></html>";
195                    // In case of MOTD not loaded because of proxy error, listen to preference changes to retry after update
196                    ProxyPreference.addProxyPreferenceListener(this);
197                }
198            }
199
200            if (content != null) {
201                EventQueue.invokeLater(() -> lg.setText(fixImageLinks(content)));
202            }
203        }, "MOTD-Loader");
204        t.setDaemon(true);
205        t.start();
206    }
207
208    static String fixImageLinks(String s) {
209        Matcher m = Pattern.compile("src=\"/browser/trunk/resources/images/(.*?)\\.(png|svg)\\?format=raw\"").matcher(s);
210        StringBuffer sb = new StringBuffer();
211        while (m.find()) {
212            String im = m.group(1);
213            String u = new ImageProvider(im).setMaxSize(ImageSizes.HTMLINLINE).getDataURL();
214            if (u != null) {
215                m.appendReplacement(sb, Matcher.quoteReplacement("src=\"" + u + '\"'));
216            }
217        }
218        m.appendTail(sb);
219        return sb.toString();
220    }
221
222    @Override
223    public void proxyPreferenceChanged() {
224        getMOTD();
225    }
226}