001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.preferences.advanced;
003
004import static org.openstreetmap.josm.tools.I18n.marktr;
005import static org.openstreetmap.josm.tools.I18n.tr;
006
007import java.awt.Dimension;
008import java.awt.event.ActionEvent;
009import java.awt.event.ActionListener;
010import java.io.File;
011import java.io.IOException;
012import java.nio.file.InvalidPathException;
013import java.util.ArrayList;
014import java.util.Collections;
015import java.util.Comparator;
016import java.util.LinkedHashMap;
017import java.util.List;
018import java.util.Locale;
019import java.util.Map;
020import java.util.Map.Entry;
021import java.util.Objects;
022
023import javax.swing.AbstractAction;
024import javax.swing.Box;
025import javax.swing.JButton;
026import javax.swing.JFileChooser;
027import javax.swing.JLabel;
028import javax.swing.JMenu;
029import javax.swing.JOptionPane;
030import javax.swing.JPanel;
031import javax.swing.JPopupMenu;
032import javax.swing.JScrollPane;
033import javax.swing.event.DocumentEvent;
034import javax.swing.event.DocumentListener;
035import javax.swing.event.MenuEvent;
036import javax.swing.event.MenuListener;
037import javax.swing.filechooser.FileFilter;
038
039import org.openstreetmap.josm.actions.DiskAccessAction;
040import org.openstreetmap.josm.data.Preferences;
041import org.openstreetmap.josm.data.PreferencesUtils;
042import org.openstreetmap.josm.gui.MainApplication;
043import org.openstreetmap.josm.gui.dialogs.LogShowDialog;
044import org.openstreetmap.josm.gui.help.HelpUtil;
045import org.openstreetmap.josm.gui.io.CustomConfigurator;
046import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
047import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
048import org.openstreetmap.josm.gui.preferences.PreferenceSettingFactory;
049import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane;
050import org.openstreetmap.josm.gui.util.GuiHelper;
051import org.openstreetmap.josm.gui.widgets.AbstractFileChooser;
052import org.openstreetmap.josm.gui.widgets.JosmTextField;
053import org.openstreetmap.josm.spi.preferences.Config;
054import org.openstreetmap.josm.spi.preferences.Setting;
055import org.openstreetmap.josm.spi.preferences.StringSetting;
056import org.openstreetmap.josm.tools.GBC;
057import org.openstreetmap.josm.tools.Logging;
058import org.openstreetmap.josm.tools.Utils;
059
060/**
061 * Advanced preferences, allowing to set preference entries directly.
062 */
063public final class AdvancedPreference extends DefaultTabPreferenceSetting {
064
065    /**
066     * Factory used to create a new {@code AdvancedPreference}.
067     */
068    public static class Factory implements PreferenceSettingFactory {
069        @Override
070        public PreferenceSetting createPreferenceSetting() {
071            return new AdvancedPreference();
072        }
073    }
074
075    private List<PrefEntry> allData;
076    private final List<PrefEntry> displayData = new ArrayList<>();
077    private JosmTextField txtFilter;
078    private PreferencesTable table;
079
080    private final Map<String, String> profileTypes = new LinkedHashMap<>();
081
082    private final Comparator<PrefEntry> customComparator = (o1, o2) -> {
083        if (o1.isChanged() && !o2.isChanged())
084            return -1;
085        if (o2.isChanged() && !o1.isChanged())
086            return 1;
087        if (!(o1.isDefault()) && o2.isDefault())
088            return -1;
089        if (!(o2.isDefault()) && o1.isDefault())
090            return 1;
091        return o1.compareTo(o2);
092    };
093
094    private AdvancedPreference() {
095        super(/* ICON(preferences/) */ "advanced", tr("Advanced Preferences"), tr("Setting Preference entries directly. Use with caution!"));
096    }
097
098    @Override
099    public boolean isExpert() {
100        return true;
101    }
102
103    @Override
104    public void addGui(final PreferenceTabbedPane gui) {
105        JPanel p = gui.createPreferenceTab(this);
106
107        txtFilter = new JosmTextField();
108        JLabel lbFilter = new JLabel(tr("Search:"));
109        lbFilter.setLabelFor(txtFilter);
110        p.add(lbFilter);
111        p.add(txtFilter, GBC.eol().fill(GBC.HORIZONTAL));
112        txtFilter.getDocument().addDocumentListener(new DocumentListener() {
113            @Override
114            public void changedUpdate(DocumentEvent e) {
115                action();
116            }
117
118            @Override
119            public void insertUpdate(DocumentEvent e) {
120                action();
121            }
122
123            @Override
124            public void removeUpdate(DocumentEvent e) {
125                action();
126            }
127
128            private void action() {
129                applyFilter();
130            }
131        });
132        readPreferences(Preferences.main());
133
134        applyFilter();
135        table = new PreferencesTable(displayData);
136        JScrollPane scroll = new JScrollPane(table);
137        p.add(scroll, GBC.eol().fill(GBC.BOTH));
138        scroll.setPreferredSize(new Dimension(400, 200));
139
140        JButton add = new JButton(tr("Add"));
141        p.add(Box.createHorizontalGlue(), GBC.std().fill(GBC.HORIZONTAL));
142        p.add(add, GBC.std().insets(0, 5, 0, 0));
143        add.addActionListener(e -> {
144            PrefEntry pe = table.addPreference(gui);
145            if (pe != null) {
146                allData.add(pe);
147                Collections.sort(allData);
148                applyFilter();
149            }
150        });
151
152        JButton edit = new JButton(tr("Edit"));
153        p.add(edit, GBC.std().insets(5, 5, 5, 0));
154        edit.addActionListener(e -> {
155            if (table.editPreference(gui))
156                applyFilter();
157        });
158
159        JButton reset = new JButton(tr("Reset"));
160        p.add(reset, GBC.std().insets(0, 5, 0, 0));
161        reset.addActionListener(e -> table.resetPreferences(gui));
162
163        JButton read = new JButton(tr("Read from file"));
164        p.add(read, GBC.std().insets(5, 5, 0, 0));
165        read.addActionListener(e -> readPreferencesFromXML());
166
167        JButton export = new JButton(tr("Export selected items"));
168        p.add(export, GBC.std().insets(5, 5, 0, 0));
169        export.addActionListener(e -> exportSelectedToXML());
170
171        final JButton more = new JButton(tr("More..."));
172        p.add(more, GBC.std().insets(5, 5, 0, 0));
173        more.addActionListener(new ActionListener() {
174            private JPopupMenu menu = buildPopupMenu();
175            @Override
176            public void actionPerformed(ActionEvent ev) {
177                if (more.isShowing()) {
178                    menu.show(more, 0, 0);
179                }
180            }
181        });
182    }
183
184    private void readPreferences(Preferences tmpPrefs) {
185        Map<String, Setting<?>> loaded;
186        Map<String, Setting<?>> orig = Preferences.main().getAllSettings();
187        Map<String, Setting<?>> defaults = tmpPrefs.getAllDefaults();
188        orig.remove("osm-server.password");
189        defaults.remove("osm-server.password");
190        if (tmpPrefs != Preferences.main()) {
191            loaded = tmpPrefs.getAllSettings();
192            // plugins preference keys may be changed directly later, after plugins are downloaded
193            // so we do not want to show it in the table as "changed" now
194            Setting<?> pluginSetting = orig.get("plugins");
195            if (pluginSetting != null) {
196                loaded.put("plugins", pluginSetting);
197            }
198        } else {
199            loaded = orig;
200        }
201        allData = prepareData(loaded, orig, defaults);
202    }
203
204    private static File[] askUserForCustomSettingsFiles(boolean saveFileFlag, String title) {
205        FileFilter filter = new FileFilter() {
206            @Override
207            public boolean accept(File f) {
208                return f.isDirectory() || Utils.hasExtension(f, "xml");
209            }
210
211            @Override
212            public String getDescription() {
213                return tr("JOSM custom settings files (*.xml)");
214            }
215        };
216        AbstractFileChooser fc = DiskAccessAction.createAndOpenFileChooser(!saveFileFlag, !saveFileFlag, title, filter,
217                JFileChooser.FILES_ONLY, "customsettings.lastDirectory");
218        if (fc != null) {
219            File[] sel = fc.isMultiSelectionEnabled() ? fc.getSelectedFiles() : (new File[]{fc.getSelectedFile()});
220            if (sel.length == 1 && !sel[0].getName().contains("."))
221                sel[0] = new File(sel[0].getAbsolutePath()+".xml");
222            return sel;
223        }
224        return new File[0];
225    }
226
227    private void exportSelectedToXML() {
228        List<String> keys = new ArrayList<>();
229        boolean hasLists = false;
230
231        for (PrefEntry p: table.getSelectedItems()) {
232            // preferences with default values are not saved
233            if (!(p.getValue() instanceof StringSetting)) {
234                hasLists = true; // => append and replace differs
235            }
236            if (!p.isDefault()) {
237                keys.add(p.getKey());
238            }
239        }
240
241        if (keys.isEmpty()) {
242            JOptionPane.showMessageDialog(MainApplication.getMainFrame(),
243                    tr("Please select some preference keys not marked as default"), tr("Warning"), JOptionPane.WARNING_MESSAGE);
244            return;
245        }
246
247        File[] files = askUserForCustomSettingsFiles(true, tr("Export preferences keys to JOSM customization file"));
248        if (files.length == 0) {
249            return;
250        }
251
252        int answer = 0;
253        if (hasLists) {
254            answer = JOptionPane.showOptionDialog(
255                    MainApplication.getMainFrame(), tr("What to do with preference lists when this file is to be imported?"), tr("Question"),
256                    JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.QUESTION_MESSAGE, null,
257                    new String[]{tr("Append preferences from file to existing values"), tr("Replace existing values")}, 0);
258        }
259        CustomConfigurator.exportPreferencesKeysToFile(files[0].getAbsolutePath(), answer == 0, keys);
260    }
261
262    private void readPreferencesFromXML() {
263        File[] files = askUserForCustomSettingsFiles(false, tr("Open JOSM customization file"));
264        if (files.length == 0)
265            return;
266
267        Preferences tmpPrefs = new Preferences(Preferences.main());
268
269        StringBuilder log = new StringBuilder();
270        log.append("<html>");
271        for (File f : files) {
272            CustomConfigurator.readXML(f, tmpPrefs);
273            log.append(PreferencesUtils.getLog());
274        }
275        log.append("</html>");
276        String msg = log.toString().replace("\n", "<br/>");
277
278        new LogShowDialog(tr("Import log"), tr("<html>Here is file import summary. <br/>"
279                + "You can reject preferences changes by pressing \"Cancel\" in preferences dialog <br/>"
280                + "To activate some changes JOSM restart may be needed.</html>"), msg).showDialog();
281
282        readPreferences(tmpPrefs);
283        // sorting after modification - first modified, then non-default, then default entries
284        allData.sort(customComparator);
285        applyFilter();
286    }
287
288    private List<PrefEntry> prepareData(Map<String, Setting<?>> loaded, Map<String, Setting<?>> orig, Map<String, Setting<?>> defaults) {
289        List<PrefEntry> data = new ArrayList<>();
290        for (Entry<String, Setting<?>> e : loaded.entrySet()) {
291            Setting<?> value = e.getValue();
292            Setting<?> old = orig.get(e.getKey());
293            Setting<?> def = defaults.get(e.getKey());
294            if (def == null) {
295                def = value.getNullInstance();
296            }
297            PrefEntry en = new PrefEntry(e.getKey(), value, def, false);
298            // after changes we have nondefault value. Value is changed if is not equal to old value
299            if (!Objects.equals(old, value)) {
300                en.markAsChanged();
301            }
302            data.add(en);
303        }
304        for (Entry<String, Setting<?>> e : defaults.entrySet()) {
305            if (!loaded.containsKey(e.getKey())) {
306                PrefEntry en = new PrefEntry(e.getKey(), e.getValue(), e.getValue(), true);
307                // after changes we have default value. So, value is changed if old value is not default
308                Setting<?> old = orig.get(e.getKey());
309                if (old != null) {
310                    en.markAsChanged();
311                }
312                data.add(en);
313            }
314        }
315        Collections.sort(data);
316        displayData.clear();
317        displayData.addAll(data);
318        return data;
319    }
320
321    private JPopupMenu buildPopupMenu() {
322        JPopupMenu menu = new JPopupMenu();
323        profileTypes.put(marktr("shortcut"), "shortcut\\..*");
324        profileTypes.put(marktr("color"), "color\\..*");
325        profileTypes.put(marktr("toolbar"), "toolbar.*");
326        profileTypes.put(marktr("imagery"), "imagery.*");
327
328        for (Entry<String, String> e: profileTypes.entrySet()) {
329            menu.add(new ExportProfileAction(Preferences.main(), e.getKey(), e.getValue()));
330        }
331
332        menu.addSeparator();
333        menu.add(getProfileMenu());
334        menu.addSeparator();
335        menu.add(new AbstractAction(tr("Reset preferences")) {
336            @Override
337            public void actionPerformed(ActionEvent ae) {
338                if (!GuiHelper.warnUser(tr("Reset preferences"),
339                        "<html>"+
340                        tr("You are about to clear all preferences to their default values<br />"+
341                        "All your settings will be deleted: plugins, imagery, filters, toolbar buttons, keyboard, etc. <br />"+
342                        "Are you sure you want to continue?")
343                        +"</html>", null, "")) {
344                    Preferences.main().resetToDefault();
345                    try {
346                        Preferences.main().save();
347                    } catch (IOException | InvalidPathException e) {
348                        Logging.log(Logging.LEVEL_WARN, "Exception while saving preferences:", e);
349                    }
350                    readPreferences(Preferences.main());
351                    applyFilter();
352                }
353            }
354        });
355        return menu;
356    }
357
358    private JMenu getProfileMenu() {
359        final JMenu p = new JMenu(tr("Load profile"));
360        p.addMenuListener(new MenuListener() {
361            @Override
362            public void menuSelected(MenuEvent me) {
363                p.removeAll();
364                File[] files = new File(".").listFiles();
365                if (files != null) {
366                    for (File f: files) {
367                       String s = f.getName();
368                       int idx = s.indexOf('_');
369                       if (idx >= 0) {
370                            String t = s.substring(0, idx);
371                            if (profileTypes.containsKey(t)) {
372                                p.add(new ImportProfileAction(s, f, t));
373                            }
374                       }
375                    }
376                }
377                files = Config.getDirs().getPreferencesDirectory(false).listFiles();
378                if (files != null) {
379                    for (File f: files) {
380                       String s = f.getName();
381                       int idx = s.indexOf('_');
382                       if (idx >= 0) {
383                            String t = s.substring(0, idx);
384                            if (profileTypes.containsKey(t)) {
385                                p.add(new ImportProfileAction(s, f, t));
386                            }
387                       }
388                    }
389                }
390            }
391
392            @Override
393            public void menuDeselected(MenuEvent me) {
394                // Not implemented
395            }
396
397            @Override
398            public void menuCanceled(MenuEvent me) {
399                // Not implemented
400            }
401        });
402        return p;
403    }
404
405    private class ImportProfileAction extends AbstractAction {
406        private final File file;
407        private final String type;
408
409        ImportProfileAction(String name, File file, String type) {
410            super(name);
411            this.file = file;
412            this.type = type;
413        }
414
415        @Override
416        public void actionPerformed(ActionEvent ae) {
417            Preferences tmpPrefs = new Preferences(Preferences.main());
418            CustomConfigurator.readXML(file, tmpPrefs);
419            readPreferences(tmpPrefs);
420            String prefRegex = profileTypes.get(type);
421            // clean all the preferences from the chosen group
422            for (PrefEntry p : allData) {
423               if (p.getKey().matches(prefRegex) && !p.isDefault()) {
424                    p.reset();
425               }
426            }
427            // allow user to review the changes in table
428            allData.sort(customComparator);
429            applyFilter();
430        }
431    }
432
433    private void applyFilter() {
434        displayData.clear();
435        for (PrefEntry e : allData) {
436            String prefKey = e.getKey();
437            Setting<?> valueSetting = e.getValue();
438            String prefValue = valueSetting.getValue() == null ? "" : valueSetting.getValue().toString();
439
440            String[] input = txtFilter.getText().split("\\s+");
441            boolean canHas = true;
442
443            // Make 'wmsplugin cache' search for e.g. 'cache.wmsplugin'
444            final String prefKeyLower = prefKey.toLowerCase(Locale.ENGLISH);
445            final String prefValueLower = prefValue.toLowerCase(Locale.ENGLISH);
446            for (String bit : input) {
447                bit = bit.toLowerCase(Locale.ENGLISH);
448                if (!prefKeyLower.contains(bit) && !prefValueLower.contains(bit)) {
449                    canHas = false;
450                    break;
451                }
452            }
453            if (canHas) {
454                displayData.add(e);
455            }
456        }
457        if (table != null)
458            table.fireDataChanged();
459    }
460
461    @Override
462    public boolean ok() {
463        for (PrefEntry e : allData) {
464            if (e.isChanged()) {
465                Preferences.main().putSetting(e.getKey(), e.getValue().getValue() == null ? null : e.getValue());
466            }
467        }
468        return false;
469    }
470
471    @Override
472    public String getHelpContext() {
473        return HelpUtil.ht("/Preferences/Advanced");
474    }
475}