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.Color;
007import java.awt.Component;
008import java.awt.Container;
009import java.awt.Dimension;
010import java.awt.GridBagConstraints;
011import java.awt.GridBagLayout;
012import java.awt.Insets;
013import java.awt.event.MouseAdapter;
014import java.awt.event.MouseEvent;
015import java.util.List;
016import java.util.Objects;
017import java.util.Optional;
018import java.util.concurrent.CopyOnWriteArrayList;
019
020import javax.swing.BorderFactory;
021import javax.swing.JComponent;
022import javax.swing.JFrame;
023import javax.swing.JLabel;
024import javax.swing.JPanel;
025import javax.swing.JProgressBar;
026import javax.swing.JScrollPane;
027import javax.swing.JSeparator;
028import javax.swing.ScrollPaneConstants;
029import javax.swing.border.Border;
030import javax.swing.border.EmptyBorder;
031import javax.swing.border.EtchedBorder;
032import javax.swing.event.ChangeEvent;
033import javax.swing.event.ChangeListener;
034
035import org.openstreetmap.josm.data.Version;
036import org.openstreetmap.josm.gui.progress.ProgressMonitor;
037import org.openstreetmap.josm.gui.progress.ProgressTaskId;
038import org.openstreetmap.josm.gui.util.GuiHelper;
039import org.openstreetmap.josm.gui.util.WindowGeometry;
040import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
041import org.openstreetmap.josm.tools.GBC;
042import org.openstreetmap.josm.tools.ImageProvider;
043import org.openstreetmap.josm.tools.Logging;
044import org.openstreetmap.josm.tools.Stopwatch;
045import org.openstreetmap.josm.tools.Utils;
046
047/**
048 * Show a splash screen so the user knows what is happening during startup.
049 * @since 976
050 */
051public class SplashScreen extends JFrame implements ChangeListener {
052
053    private final transient SplashProgressMonitor progressMonitor;
054    private final SplashScreenProgressRenderer progressRenderer;
055
056    /**
057     * Constructs a new {@code SplashScreen}.
058     */
059    public SplashScreen() {
060        setUndecorated(true);
061
062        // Add a nice border to the main splash screen
063        Container contentPane = this.getContentPane();
064        Border margin = new EtchedBorder(1, Color.white, Color.gray);
065        if (contentPane instanceof JComponent) {
066            ((JComponent) contentPane).setBorder(margin);
067        }
068
069        // Add a margin from the border to the content
070        JPanel innerContentPane = new JPanel(new GridBagLayout());
071        innerContentPane.setBorder(new EmptyBorder(10, 10, 2, 10));
072        contentPane.add(innerContentPane);
073
074        // Add the logo
075        JLabel logo = new JLabel(ImageProvider.get("logo.svg", ImageProvider.ImageSizes.SPLASH_LOGO));
076        GridBagConstraints gbc = new GridBagConstraints();
077        gbc.gridheight = 2;
078        gbc.insets = new Insets(0, 0, 0, 70);
079        innerContentPane.add(logo, gbc);
080
081        // Add the name of this application
082        JLabel caption = new JLabel("JOSM – " + tr("Java OpenStreetMap Editor"));
083        caption.setFont(GuiHelper.getTitleFont());
084        gbc.gridheight = 1;
085        gbc.gridx = 1;
086        gbc.insets = new Insets(30, 0, 0, 0);
087        innerContentPane.add(caption, gbc);
088
089        // Add the version number
090        JLabel version = new JLabel(tr("Version {0}", Version.getInstance().getVersionString()));
091        gbc.gridy = 1;
092        gbc.insets = new Insets(0, 0, 0, 0);
093        innerContentPane.add(version, gbc);
094
095        // Add a separator to the status text
096        JSeparator separator = new JSeparator(JSeparator.HORIZONTAL);
097        gbc.gridx = 0;
098        gbc.gridy = 2;
099        gbc.gridwidth = 2;
100        gbc.fill = GridBagConstraints.HORIZONTAL;
101        gbc.insets = new Insets(15, 0, 5, 0);
102        innerContentPane.add(separator, gbc);
103
104        // Add a status message
105        progressRenderer = new SplashScreenProgressRenderer();
106        gbc.gridy = 3;
107        gbc.insets = new Insets(0, 0, 10, 0);
108        innerContentPane.add(progressRenderer, gbc);
109        progressMonitor = new SplashProgressMonitor(null, this);
110
111        pack();
112
113        WindowGeometry.centerOnScreen(this.getSize(), "gui.geometry").applySafe(this);
114
115        // Add ability to hide splash screen by clicking it
116        addMouseListener(new MouseAdapter() {
117            @Override
118            public void mousePressed(MouseEvent event) {
119                setVisible(false);
120            }
121        });
122    }
123
124    @Override
125    public void stateChanged(ChangeEvent ignore) {
126        GuiHelper.runInEDT(() -> progressRenderer.setTasks(progressMonitor.toString()));
127    }
128
129    /**
130     * A task (of a {@link ProgressMonitor}).
131     */
132    private abstract static class Task {
133
134        /**
135         * Returns a HTML representation for this task.
136         * @param sb a {@code StringBuilder} used to build the HTML code
137         * @return {@code sb}
138         */
139        public abstract StringBuilder toHtml(StringBuilder sb);
140
141        @Override
142        public final String toString() {
143            return toHtml(new StringBuilder(1024)).toString();
144        }
145    }
146
147    /**
148     * A single task (of a {@link ProgressMonitor}) which keeps track of its execution duration
149     * (requires a call to {@link #finish()}).
150     */
151    private static class MeasurableTask extends Task {
152        private final String name;
153        private final Stopwatch stopwatch;
154        private String duration = "";
155
156        MeasurableTask(String name) {
157            this.name = name;
158            this.stopwatch = Stopwatch.createStarted();
159        }
160
161        public void finish() {
162            if (isFinished()) {
163                throw new IllegalStateException("This task has already been finished: " + name);
164            }
165            if (stopwatch.elapsed() >= 0) {
166                duration = tr(" ({0})", stopwatch);
167            }
168        }
169
170        /**
171         * Determines if this task has been finished.
172         * @return {@code true} if this task has been finished
173         */
174        public boolean isFinished() {
175            return !duration.isEmpty();
176        }
177
178        @Override
179        public StringBuilder toHtml(StringBuilder sb) {
180            return sb.append(name).append("<i style='color: #666666;'>").append(duration).append("</i>");
181        }
182
183        @Override
184        public boolean equals(Object o) {
185            if (this == o) return true;
186            if (o == null || getClass() != o.getClass()) return false;
187            MeasurableTask that = (MeasurableTask) o;
188            return Objects.equals(name, that.name)
189                && isFinished() == that.isFinished();
190        }
191
192        @Override
193        public int hashCode() {
194            return Objects.hashCode(name);
195        }
196    }
197
198    /**
199     * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
200     */
201    public static class SplashProgressMonitor extends Task implements ProgressMonitor {
202
203        private final String name;
204        private final ChangeListener listener;
205        private final List<Task> tasks = new CopyOnWriteArrayList<>();
206        private SplashProgressMonitor latestSubtask;
207
208        /**
209         * Constructs a new {@code SplashProgressMonitor}.
210         * @param name name
211         * @param listener change listener
212         */
213        public SplashProgressMonitor(String name, ChangeListener listener) {
214            this.name = name;
215            this.listener = listener;
216        }
217
218        @Override
219        public StringBuilder toHtml(StringBuilder sb) {
220            sb.append(Utils.firstNonNull(name, ""));
221            if (!tasks.isEmpty()) {
222                sb.append("<ul>");
223                for (Task i : tasks) {
224                    sb.append("<li>");
225                    i.toHtml(sb);
226                    sb.append("</li>");
227                }
228                sb.append("</ul>");
229            }
230            return sb;
231        }
232
233        @Override
234        public void beginTask(String title) {
235            if (title != null && !title.isEmpty()) {
236                Logging.debug(title);
237                final MeasurableTask task = new MeasurableTask(title);
238                tasks.add(task);
239                listener.stateChanged(null);
240            }
241        }
242
243        @Override
244        public void beginTask(String title, int ticks) {
245            this.beginTask(title);
246        }
247
248        @Override
249        public void setCustomText(String text) {
250            this.beginTask(text);
251        }
252
253        @Override
254        public void setExtraText(String text) {
255            this.beginTask(text);
256        }
257
258        @Override
259        public void indeterminateSubTask(String title) {
260            this.subTask(title);
261        }
262
263        @Override
264        public void subTask(String title) {
265            Logging.debug(title);
266            latestSubtask = new SplashProgressMonitor(title, listener);
267            tasks.add(latestSubtask);
268            listener.stateChanged(null);
269        }
270
271        @Override
272        public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
273            if (latestSubtask != null) {
274                return latestSubtask;
275            } else {
276                // subTask has not been called before, such as for plugin update, #11874
277                return this;
278            }
279        }
280
281        /**
282         * @deprecated Use {@link #finishTask(String)} instead.
283         */
284        @Override
285        @Deprecated
286        public void finishTask() {
287            // Not used
288        }
289
290        /**
291         * Displays the given task as finished.
292         * @param title the task title
293         */
294        public void finishTask(String title) {
295            Optional<Task> taskOptional = tasks.stream()
296                    .filter(new MeasurableTask(title)::equals)
297                    .filter(MeasurableTask.class::isInstance)
298                    .findAny();
299            taskOptional.ifPresent(task -> {
300                ((MeasurableTask) task).finish();
301                if (Logging.isDebugEnabled()) {
302                    Logging.debug(tr("{0} completed in {1}", title, ((MeasurableTask) task).duration));
303                }
304                listener.stateChanged(null);
305            });
306        }
307
308        @Override
309        public void invalidate() {
310            // Not used
311        }
312
313        @Override
314        public void setTicksCount(int ticks) {
315            // Not used
316        }
317
318        @Override
319        public int getTicksCount() {
320            return 0;
321        }
322
323        @Override
324        public void setTicks(int ticks) {
325            // Not used
326        }
327
328        @Override
329        public int getTicks() {
330            return 0;
331        }
332
333        @Override
334        public void worked(int ticks) {
335            // Not used
336        }
337
338        @Override
339        public boolean isCanceled() {
340            return false;
341        }
342
343        @Override
344        public void cancel() {
345            // Not used
346        }
347
348        @Override
349        public void addCancelListener(CancelListener listener) {
350            // Not used
351        }
352
353        @Override
354        public void removeCancelListener(CancelListener listener) {
355            // Not used
356        }
357
358        @Override
359        public void appendLogMessage(String message) {
360            // Not used
361        }
362
363        @Override
364        public void setProgressTaskId(ProgressTaskId taskId) {
365            // Not used
366        }
367
368        @Override
369        public ProgressTaskId getProgressTaskId() {
370            return null;
371        }
372
373        @Override
374        public Component getWindowParent() {
375            return MainApplication.getMainFrame();
376        }
377    }
378
379    /**
380     * Returns the progress monitor.
381     * @return The progress monitor
382     */
383    public SplashProgressMonitor getProgressMonitor() {
384        return progressMonitor;
385    }
386
387    private static class SplashScreenProgressRenderer extends JPanel {
388        private final JosmEditorPane lblTaskTitle = new JosmEditorPane();
389        private final JProgressBar progressBar = new JProgressBar(JProgressBar.HORIZONTAL);
390        private static final String LABEL_HTML = "<html>"
391                + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>";
392
393        protected void build() {
394            setLayout(new GridBagLayout());
395
396            JosmEditorPane.makeJLabelLike(lblTaskTitle, false);
397            lblTaskTitle.setText(LABEL_HTML);
398            final JScrollPane scrollPane = new JScrollPane(lblTaskTitle,
399                    ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED, ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
400            scrollPane.setPreferredSize(new Dimension(0, 320));
401            scrollPane.setBorder(BorderFactory.createEmptyBorder());
402            add(scrollPane, GBC.eol().insets(5, 5, 0, 0).fill(GridBagConstraints.HORIZONTAL));
403
404            progressBar.setIndeterminate(true);
405            add(progressBar, GBC.eol().insets(5, 15, 0, 0).fill(GridBagConstraints.HORIZONTAL));
406        }
407
408        /**
409         * Constructs a new {@code SplashScreenProgressRenderer}.
410         */
411        SplashScreenProgressRenderer() {
412            build();
413        }
414
415        /**
416         * Sets the tasks to displayed. A HTML formatted list is expected.
417         * @param tasks HTML formatted list of tasks
418         */
419        public void setTasks(String tasks) {
420            lblTaskTitle.setText(LABEL_HTML + tasks);
421            lblTaskTitle.setCaretPosition(lblTaskTitle.getDocument().getLength());
422        }
423    }
424}