// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.actions;
import static java.awt.GridBagConstraints.HORIZONTAL;
import static javax.swing.SwingConstants.CENTER;
import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
import static org.openstreetmap.josm.tools.I18n.tr;
import static org.openstreetmap.josm.tools.Utils.getSystemProperty;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.GridBagLayout;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Map.Entry;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import org.openstreetmap.josm.data.Preferences;
import org.openstreetmap.josm.data.Version;
import org.openstreetmap.josm.gui.ExtendedDialog;
import org.openstreetmap.josm.gui.MainApplication;
import org.openstreetmap.josm.gui.util.GuiHelper;
import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
import org.openstreetmap.josm.gui.widgets.JosmTextArea;
import org.openstreetmap.josm.gui.widgets.UrlLabel;
import org.openstreetmap.josm.plugins.PluginHandler;
import org.openstreetmap.josm.spi.preferences.Config;
import org.openstreetmap.josm.tools.GBC;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.ImageProvider.ImageSizes;
import org.openstreetmap.josm.tools.Logging;
import org.openstreetmap.josm.tools.OpenBrowser;
import org.openstreetmap.josm.tools.Shortcut;
import org.openstreetmap.josm.tools.Utils;
/**
* Nice about screen.
*
* The REVISION resource is read and if present, it shows the revision information of the jar-file.
*
* @author imi
*/
public final class AboutAction extends JosmAction {
/**
* Constructs a new {@code AboutAction}.
*/
public AboutAction() {
super(tr("About"), "logo", tr("Display the about screen."),
Shortcut.registerShortcut("system:about", tr("Help: {0}", tr("About")),
KeyEvent.VK_F1, Shortcut.SHIFT), true, false);
}
JPanel buildAboutPanel() {
final JTabbedPane about = new JTabbedPane();
Version version = Version.getInstance();
JosmTextArea readme = new JosmTextArea();
readme.setFont(GuiHelper.getMonospacedFont(readme));
readme.setEditable(false);
setTextFromResourceFile(readme, "/README");
readme.setCaretPosition(0);
JosmTextArea revision = new JosmTextArea();
revision.setFont(GuiHelper.getMonospacedFont(revision));
revision.setEditable(false);
revision.setText(version.getReleaseAttributes());
revision.setCaretPosition(0);
JosmTextArea contribution = new JosmTextArea();
contribution.setEditable(false);
setTextFromResourceFile(contribution, "/CONTRIBUTION");
contribution.setCaretPosition(0);
JosmTextArea license = new JosmTextArea();
license.setEditable(false);
setTextFromResourceFile(license, "/LICENSE");
license.setCaretPosition(0);
JPanel info = new JPanel(new GridBagLayout());
final JMultilineLabel label = new JMultilineLabel("" +
"" + "JOSM – " + tr("Java OpenStreetMap Editor") + "
" +
"" +
"" + tr("Version {0}", version.getVersionString()) + "
" +
"" +
"" + tr("Last change at {0}", version.getTime()) + "
" +
"" +
"" + tr("Java Version {0}", getSystemProperty("java.version")) + "
" +
"" +
"");
info.add(label, GBC.eol().fill(HORIZONTAL).insets(10, 0, 0, 10));
info.add(new JLabel(tr("Homepage")), GBC.std().insets(10, 0, 10, 0));
info.add(new UrlLabel(Config.getUrls().getJOSMWebsite(), 2), GBC.eol());
info.add(new JLabel(tr("Translations")), GBC.std().insets(10, 0, 10, 0));
info.add(new UrlLabel("https://josm.openstreetmap.de/wiki/Translations", 2), GBC.eol());
info.add(new JLabel(tr("Follow us on")), GBC.std().insets(10, 10, 10, 0));
JPanel logos = new JPanel(new FlowLayout());
//logos.add(createImageLink("OpenStreetMap", /* ICON(dialogs/about/) */ "openstreetmap",
// "https://www.openstreetmap.org/user/josmeditor/diary"));
//logos.add(createImageLink("Mastodon", /* ICON(dialogs/about/) */ "mastodon", "https://en.osm.town/@josmeditor"));
//logos.add(createImageLink("X", /* ICON(dialogs/about/) */ "twitter-square", "https://x.com/josmeditor"));
//logos.add(createImageLink("Facebook", /* ICON(dialogs/about/) */ "facebook-square", "https://www.facebook.com/josmeditor"));
logos.add(createImageLink("GitHub", /* ICON(dialogs/about/) */ "github-square", "https://github.com/JOSM"));
info.add(logos, GBC.eol().insets(0, 10, 0, 0));
info.add(GBC.glue(0, 5), GBC.eol());
JPanel inst = new JPanel(new GridBagLayout());
inst.add(new JLabel(tr("Preferences are stored in {0}", getPathToPreferences())), GBC.eol().insets(0, 0, 0, 10));
inst.add(new JLabel(tr("Symbolic names for directories and the actual paths:")),
GBC.eol().insets(0, 0, 0, 10));
for (Entry entry : ShowStatusReportAction.getAnonimicDirectorySymbolMap().entrySet()) {
addInstallationLine(inst, entry.getValue(), entry.getKey());
}
about.addTab(tr("Info"), info);
about.addTab(tr("Readme"), createScrollPane(readme));
about.addTab(tr("Revision"), createScrollPane(revision));
about.addTab(tr("Contribution"), createScrollPane(contribution));
about.addTab(tr("License"), createScrollPane(license));
about.addTab(tr("Plugins"), new JScrollPane(PluginHandler.getInfoPanel()));
about.addTab(tr("Installation Details"), inst);
// Get the list of Launchpad contributors using customary msgid “translator-credits”
String translators = tr("translator-credits");
if (!Utils.isEmpty(translators) && !"translator-credits".equals(translators)) {
about.addTab(tr("Translators"), createScrollPane(new JosmTextArea(translators)));
}
// Intermediate panel to allow proper optionPane resizing
JPanel panel = new JPanel(new GridBagLayout());
panel.setPreferredSize(new Dimension(890, 300));
panel.add(new JLabel("", ImageProvider.get("logo.svg", ImageSizes.ABOUT_LOGO), CENTER), GBC.std().insets(0, 5, 0, 0));
panel.add(about, GBC.std().fill());
return panel;
}
private static String getPathToPreferences() {
File preferenceFile = Preferences.main().getPreferenceFile();
try {
return ShowStatusReportAction.paramCleanup(preferenceFile.getAbsolutePath());
} catch (SecurityException e) {
Logging.warn(e);
return ShowStatusReportAction.paramCleanup(preferenceFile.getPath());
}
}
@Override
public void actionPerformed(ActionEvent e) {
JPanel panel = buildAboutPanel();
GuiHelper.prepareResizeableOptionPane(panel, panel.getPreferredSize());
ExtendedDialog dlg = new ExtendedDialog(MainApplication.getMainFrame(), tr("About JOSM..."), tr("OK"), tr("Report bug"));
int ret = dlg.setButtonIcons("ok", "bug")
.configureContextsensitiveHelp(ht("Action/About"), true)
.setContent(panel, false)
.showDialog().getValue();
if (2 == ret) {
MainApplication.getMenu().reportbug.actionPerformed(null);
}
GuiHelper.destroyComponents(panel, false);
dlg.dispose();
}
private static class OpenDirAction extends AbstractAction {
final String dir;
OpenDirAction(String dir) {
putValue(Action.NAME, "...");
this.dir = dir;
try {
setEnabled(dir != null && new File(dir).isDirectory());
} catch (SecurityException e) {
setEnabled(false);
Logging.warn(e);
}
}
@Override
public void actionPerformed(ActionEvent e) {
OpenBrowser.displayUrl(new File(dir).toURI());
}
}
/**
* Add line to installation details showing symbolic name used in status report and actual directory.
* @param inst the panel
* @param dir the actual path represented by a symbol
* @param source source for symbol
*/
private static void addInstallationLine(JPanel inst, String dir, String source) {
if (source == null)
return;
JLabel symbol = new JLabel(source);
symbol.setFont(GuiHelper.getMonospacedFont(symbol));
JosmTextArea dirLabel = new JosmTextArea();
if (!Utils.isEmpty(dir)) {
dirLabel.setText(dir);
dirLabel.setEditable(false);
} else {
dirLabel.setText("<" + tr("unset") + ">");
dirLabel.setFont(dirLabel.getFont().deriveFont(Font.ITALIC));
dirLabel.setEditable(false);
}
inst.add(symbol, GBC.std().insets(5, 0, 0, 0));
inst.add(GBC.glue(10, 0), GBC.std());
dirLabel.setFont(GuiHelper.getMonospacedFont(dirLabel));
dirLabel.setOpaque(false);
inst.add(dirLabel, GBC.std().fill(HORIZONTAL));
JButton btn = new JButton(new OpenDirAction(dir));
btn.setToolTipText(tr("Open directory"));
inst.add(btn, GBC.eol().insets(0, 0, 5, 0));
}
private static JLabel createImageLink(String tooltip, String icon, final String link) {
return new UrlLabel(link, tooltip, ImageProvider.get("dialogs/about", icon, ImageSizes.LARGEICON));
}
/**
* Reads the contents of the resource file that is described by the {@code filePath}-attribute and puts that text
* into the {@link JTextArea} given by the {@code ta}-attribute.
* @param ta the {@link JTextArea} to put the files contents into
* @param filePath the path where the resource file to read resides
*/
private void setTextFromResourceFile(JTextArea ta, String filePath) {
InputStream is = Utils.getResourceAsStream(getClass(), filePath);
if (is == null) {
displayErrorMessage(ta, tr("Failed to locate resource ''{0}''.", filePath));
} else {
try (BufferedReader br = new BufferedReader(new InputStreamReader(is, StandardCharsets.UTF_8))) {
String line;
while ((line = br.readLine()) != null) {
ta.append(line+'\n');
}
} catch (IOException e) {
Logging.warn(e);
displayErrorMessage(ta, tr("Failed to load resource ''{0}'', error is {1}.", filePath, e.toString()));
}
}
}
private static void displayErrorMessage(JTextArea ta, String msg) {
Logging.warn(msg);
ta.setForeground(new Color(200, 0, 0));
ta.setText(msg);
}
private static JScrollPane createScrollPane(JosmTextArea area) {
area.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
area.setOpaque(false);
JScrollPane sp = new JScrollPane(area);
sp.setBorder(null);
sp.setOpaque(false);
return sp;
}
}