001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.preferences.imagery;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.event.ActionListener;
007import java.io.IOException;
008import java.net.MalformedURLException;
009import java.nio.file.InvalidPathException;
010import java.util.Collection;
011import java.util.List;
012import java.util.stream.Collectors;
013
014import javax.swing.DefaultComboBoxModel;
015import javax.swing.JButton;
016import javax.swing.JCheckBox;
017import javax.swing.JComboBox;
018import javax.swing.JLabel;
019import javax.swing.JOptionPane;
020import javax.swing.JScrollPane;
021
022import org.openstreetmap.josm.data.imagery.DefaultLayer;
023import org.openstreetmap.josm.data.imagery.ImageryInfo;
024import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType;
025import org.openstreetmap.josm.data.imagery.LayerDetails;
026import org.openstreetmap.josm.gui.bbox.SlippyMapBBoxChooser;
027import org.openstreetmap.josm.gui.util.GuiHelper;
028import org.openstreetmap.josm.gui.widgets.JosmTextArea;
029import org.openstreetmap.josm.io.imagery.WMSImagery;
030import org.openstreetmap.josm.tools.GBC;
031import org.openstreetmap.josm.tools.Logging;
032
033/**
034 * An imagery panel used to add WMS imagery sources.
035 * @since 2599
036 */
037public class AddWMSLayerPanel extends AddImageryPanel {
038
039    private transient WMSImagery wms;
040    private final JCheckBox endpoint = new JCheckBox(tr("Store WMS endpoint only, select layers at usage"));
041    private final JCheckBox setDefaultLayers = new JCheckBox(tr("Use selected layers as default"));
042    private final transient WMSLayerTree tree = new WMSLayerTree();
043    private final JComboBox<String> formats = new JComboBox<>();
044    private final JosmTextArea wmsUrl = new JosmTextArea(3, 40).transferFocusOnTab();
045    private final JButton showBounds = new JButton(tr("Show bounds"));
046
047    /**
048     * Constructs a new {@code AddWMSLayerPanel}.
049     */
050    public AddWMSLayerPanel() {
051
052        add(new JLabel(tr("{0} Make sure OSM has the permission to use this service", "1.")), GBC.eol());
053        add(new JLabel(tr("{0} Enter GetCapabilities URL", "2.")), GBC.eol());
054        add(rawUrl, GBC.eol().fill(GBC.HORIZONTAL));
055        rawUrl.setLineWrap(true);
056        JButton getLayers = new JButton(tr("{0} Get layers", "3."));
057        add(getLayers, GBC.eop().fill(GBC.HORIZONTAL));
058
059        add(new JLabel(tr("{0} Select layers", "4.")), GBC.eol());
060
061        add(endpoint, GBC.eol());
062        setDefaultLayers.setEnabled(false);
063        add(setDefaultLayers, GBC.eol());
064        add(new JScrollPane(tree.getLayerTree()), GBC.eol().fill());
065
066        showBounds.setEnabled(false);
067        add(showBounds, GBC.eop().fill(GBC.HORIZONTAL));
068
069        add(new JLabel(tr("{0} Select image format", "5.")), GBC.eol());
070        add(formats, GBC.eol().fill(GBC.HORIZONTAL));
071
072        addCommonSettings();
073
074        JLabel wmsInstruction = new JLabel(tr("{0} Edit generated {1} URL (optional)", "6.", "WMS"));
075        add(wmsInstruction, GBC.eol());
076        wmsInstruction.setLabelFor(wmsUrl);
077        add(wmsUrl, GBC.eop().fill(GBC.HORIZONTAL));
078        wmsUrl.setLineWrap(true);
079
080        add(new JLabel(tr("{0} Enter name for this layer", "7.")), GBC.eol());
081        add(name, GBC.eop().fill(GBC.HORIZONTAL));
082
083        getLayers.addActionListener(e -> {
084            try {
085                wms = new WMSImagery(rawUrl.getText(), getCommonHeaders());
086                tree.updateTree(wms);
087                Collection<String> wmsFormats = wms.getFormats();
088                formats.setModel(new DefaultComboBoxModel<>(wmsFormats.toArray(new String[0])));
089                formats.setSelectedItem(wms.getPreferredFormat());
090            } catch (MalformedURLException | InvalidPathException ex1) {
091                Logging.log(Logging.LEVEL_ERROR, ex1);
092                JOptionPane.showMessageDialog(getParent(), tr("Invalid service URL."),
093                        tr("WMS Error"), JOptionPane.ERROR_MESSAGE);
094            } catch (IOException ex2) {
095                Logging.log(Logging.LEVEL_ERROR, ex2);
096                JOptionPane.showMessageDialog(getParent(), tr("Could not retrieve WMS layer list."),
097                        tr("WMS Error"), JOptionPane.ERROR_MESSAGE);
098            } catch (WMSImagery.WMSGetCapabilitiesException ex3) {
099                String incomingData = ex3.getIncomingData() != null ? ex3.getIncomingData().trim() : "";
100                String title = tr("WMS Error");
101                StringBuilder message = new StringBuilder(tr("Could not parse WMS layer list."));
102                Logging.log(Logging.LEVEL_ERROR, "Could not parse WMS layer list. Incoming data:\n"+incomingData, ex3);
103                if ((incomingData.startsWith("<html>") || incomingData.startsWith("<HTML>"))
104                  && (incomingData.endsWith("</html>") || incomingData.endsWith("</HTML>"))) {
105                    GuiHelper.notifyUserHtmlError(this, title, message.toString(), incomingData);
106                } else {
107                    if (ex3.getMessage() != null) {
108                        message.append('\n').append(ex3.getMessage());
109                    }
110                    JOptionPane.showMessageDialog(getParent(), message.toString(), title, JOptionPane.ERROR_MESSAGE);
111                }
112            }
113        });
114
115        ActionListener availabilityManagerAction = a -> {
116            setDefaultLayers.setEnabled(endpoint.isSelected());
117            boolean enabled = !endpoint.isSelected() || setDefaultLayers.isSelected();
118            tree.getLayerTree().setEnabled(enabled);
119            showBounds.setEnabled(enabled);
120            wmsInstruction.setEnabled(enabled);
121            formats.setEnabled(enabled);
122            wmsUrl.setEnabled(enabled);
123            if (endpoint.isSelected() && !setDefaultLayers.isSelected() && wms != null) {
124                name.setText(wms.buildRootUrlWithoutCapabilities());
125            }
126            onLayerSelectionChanged();
127        };
128
129        endpoint.addActionListener(availabilityManagerAction);
130        setDefaultLayers.addActionListener(availabilityManagerAction);
131
132        tree.getLayerTree().addPropertyChangeListener("selectedLayers", evt -> onLayerSelectionChanged());
133
134        formats.addActionListener(e -> onLayerSelectionChanged());
135
136        showBounds.addActionListener(e -> {
137            if (tree.getSelectedLayers().get(0).getBounds() != null) {
138                SlippyMapBBoxChooser mapPanel = new SlippyMapBBoxChooser();
139                mapPanel.setBoundingBox(tree.getSelectedLayers().get(0).getBounds());
140                JOptionPane.showMessageDialog(null, mapPanel, tr("Show Bounds"), JOptionPane.PLAIN_MESSAGE);
141            } else {
142                JOptionPane.showMessageDialog(null, tr("No bounding box was found for this layer."),
143                        tr("WMS Error"), JOptionPane.ERROR_MESSAGE);
144            }
145        });
146
147        registerValidableComponent(endpoint);
148        registerValidableComponent(rawUrl);
149        registerValidableComponent(wmsUrl);
150        registerValidableComponent(setDefaultLayers);
151    }
152
153    protected final void onLayerSelectionChanged() {
154        if (wms != null && wms.buildRootUrl() != null) {
155            wmsUrl.setText(wms.buildGetMapUrl(
156                    tree.getSelectedLayers().stream().map(LayerDetails::getName).collect(Collectors.toList()),
157                    (List<String>) null,
158                    (String) formats.getSelectedItem(),
159                    true // TODO: ask user about transparency
160                )
161            );
162            name.setText(wms.buildRootUrlWithoutCapabilities() + ": " +
163                    tree.getSelectedLayers().stream().map(LayerDetails::toString).collect(Collectors.joining(", ")));
164        }
165        showBounds.setEnabled(tree.getSelectedLayers().size() == 1);
166    }
167
168    @Override
169    public ImageryInfo getImageryInfo() {
170        ImageryInfo info = null;
171        if (endpoint.isSelected()) {
172            info = new ImageryInfo(getImageryName(), getImageryRawUrl());
173            info.setImageryType(ImageryInfo.ImageryType.WMS_ENDPOINT);
174            if (setDefaultLayers.isSelected()) {
175                info.setDefaultLayers(tree.getSelectedLayers().stream()
176                        .map(x -> new DefaultLayer(
177                                ImageryInfo.ImageryType.WMS_ENDPOINT,
178                                x.getName(),
179                                "", // TODO: allow selection of styles
180                                ""))
181                        .collect(Collectors.toList()));
182                info.setServerProjections(wms.getServerProjections(tree.getSelectedLayers()));
183            }
184        } else {
185            if (wms != null && wms.buildRootUrl() != null) {
186                // TODO: ask user about transparency
187                info = wms.toImageryInfo(
188                        getImageryName(), tree.getSelectedLayers(), (List<String>) null, (String) formats.getSelectedItem(), true);
189            } else {
190                info = new ImageryInfo(getImageryName(), getWmsUrl());
191            }
192            info.setImageryType(ImageryType.WMS);
193        }
194        info.setGeoreferenceValid(getCommonIsValidGeoreference());
195        info.setCustomHttpHeaders(getCommonHeaders());
196        return info;
197    }
198
199    protected final String getWmsUrl() {
200        return sanitize(wmsUrl.getText(), ImageryInfo.ImageryType.WMS);
201    }
202
203    @Override
204    protected boolean isImageryValid() {
205        if (getImageryName().isEmpty()) {
206            return false;
207        }
208        if (setDefaultLayers.isSelected() && (tree == null || tree.getSelectedLayers().isEmpty())) {
209            return false;
210        }
211        if (endpoint.isSelected()) {
212            return !getImageryRawUrl().isEmpty();
213        } else {
214            return !getWmsUrl().isEmpty();
215        }
216    }
217}