1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui.dialogs.changeset.query;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.awt.BorderLayout;
|
---|
7 | import java.awt.GridBagConstraints;
|
---|
8 | import java.awt.GridBagLayout;
|
---|
9 | import java.awt.Insets;
|
---|
10 | import java.awt.event.ItemEvent;
|
---|
11 | import java.awt.event.ItemListener;
|
---|
12 | import java.util.EnumMap;
|
---|
13 | import java.util.Map;
|
---|
14 |
|
---|
15 | import javax.swing.BorderFactory;
|
---|
16 | import javax.swing.ButtonGroup;
|
---|
17 | import javax.swing.JCheckBox;
|
---|
18 | import javax.swing.JPanel;
|
---|
19 | import javax.swing.JRadioButton;
|
---|
20 |
|
---|
21 | import org.openstreetmap.josm.Main;
|
---|
22 | import org.openstreetmap.josm.data.Bounds;
|
---|
23 | import org.openstreetmap.josm.gui.JosmUserIdentityManager;
|
---|
24 | import org.openstreetmap.josm.gui.widgets.HtmlPanel;
|
---|
25 | import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
|
---|
26 | import org.openstreetmap.josm.io.ChangesetQuery;
|
---|
27 |
|
---|
28 | /**
|
---|
29 | * This panel presents a list of basic queries for changests.
|
---|
30 | *
|
---|
31 | */
|
---|
32 | public class BasicChangesetQueryPanel extends JPanel {
|
---|
33 |
|
---|
34 | /**
|
---|
35 | * Enumeration of basic, predefined queries
|
---|
36 | */
|
---|
37 | private enum BasicQuery {
|
---|
38 | MOST_RECENT_CHANGESETS,
|
---|
39 | MY_OPEN_CHANGESETS,
|
---|
40 | CHANGESETS_IN_MAP_VIEW;
|
---|
41 | }
|
---|
42 |
|
---|
43 | private transient Map<BasicQuery, JRadioButton> rbQueries;
|
---|
44 | private transient Map<BasicQuery, JMultilineLabel> lblQueries;
|
---|
45 | private JCheckBox cbMyChangesetsOnly;
|
---|
46 |
|
---|
47 | protected JPanel buildQueriesPanel() {
|
---|
48 | JPanel pnl = new JPanel(new GridBagLayout());
|
---|
49 |
|
---|
50 | ButtonGroup bgQueries = new ButtonGroup();
|
---|
51 | rbQueries = new EnumMap<>(BasicQuery.class);
|
---|
52 | lblQueries = new EnumMap<>(BasicQuery.class);
|
---|
53 | SelectQueryHandler selectedQueryHandler = new SelectQueryHandler();
|
---|
54 | for (BasicQuery q: BasicQuery.values()) {
|
---|
55 | JRadioButton rb = new JRadioButton();
|
---|
56 | rb.addItemListener(selectedQueryHandler);
|
---|
57 | rbQueries.put(q, rb);
|
---|
58 | bgQueries.add(rb);
|
---|
59 | lblQueries.put(q, new JMultilineLabel(""));
|
---|
60 | }
|
---|
61 |
|
---|
62 | GridBagConstraints gc = new GridBagConstraints();
|
---|
63 | // -- most recent changes
|
---|
64 | gc.fill = GridBagConstraints.NONE;
|
---|
65 | gc.anchor = GridBagConstraints.NORTHWEST;
|
---|
66 | gc.insets = new Insets(0, 0, 5, 3);
|
---|
67 | pnl.add(rbQueries.get(BasicQuery.MOST_RECENT_CHANGESETS), gc);
|
---|
68 |
|
---|
69 | gc.gridx = 1;
|
---|
70 | gc.fill = GridBagConstraints.HORIZONTAL;
|
---|
71 | gc.weightx = 1.0;
|
---|
72 | pnl.add(lblQueries.get(BasicQuery.MOST_RECENT_CHANGESETS), gc);
|
---|
73 |
|
---|
74 | // -- most recent changes
|
---|
75 | gc.gridx = 0;
|
---|
76 | gc.gridy = 1;
|
---|
77 | gc.fill = GridBagConstraints.NONE;
|
---|
78 | gc.weightx = 0.0;
|
---|
79 | pnl.add(rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS), gc);
|
---|
80 |
|
---|
81 | gc.gridx = 1;
|
---|
82 | gc.fill = GridBagConstraints.HORIZONTAL;
|
---|
83 | gc.weightx = 1.0;
|
---|
84 | pnl.add(lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS), gc);
|
---|
85 |
|
---|
86 | // -- changesets in map view
|
---|
87 | gc.gridx = 0;
|
---|
88 | gc.gridy = 2;
|
---|
89 | gc.fill = GridBagConstraints.NONE;
|
---|
90 | gc.weightx = 0.0;
|
---|
91 | pnl.add(rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW), gc);
|
---|
92 |
|
---|
93 | gc.gridx = 1;
|
---|
94 | gc.fill = GridBagConstraints.HORIZONTAL;
|
---|
95 | gc.weightx = 1.0;
|
---|
96 | pnl.add(lblQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW), gc);
|
---|
97 |
|
---|
98 | // -- checkbox my changesets only
|
---|
99 | gc.gridx = 0;
|
---|
100 | gc.gridy = 3;
|
---|
101 | gc.gridwidth = 2;
|
---|
102 | gc.insets = new Insets(5, 0, 3, 3);
|
---|
103 | gc.fill = GridBagConstraints.HORIZONTAL;
|
---|
104 | gc.weightx = 1.0;
|
---|
105 | cbMyChangesetsOnly = new JCheckBox(tr("Download my changesets only"));
|
---|
106 | pnl.add(cbMyChangesetsOnly, gc);
|
---|
107 | cbMyChangesetsOnly.setToolTipText(
|
---|
108 | tr("<html>Select to restrict the query to your changesets only.<br>Unselect to include all changesets in the query.</html>"));
|
---|
109 |
|
---|
110 | // grab remaining space
|
---|
111 | gc.gridx = 0;
|
---|
112 | gc.gridy = 4;
|
---|
113 | gc.gridwidth = 2;
|
---|
114 | gc.insets = new Insets(5, 0, 3, 3);
|
---|
115 | gc.fill = GridBagConstraints.BOTH;
|
---|
116 | gc.weightx = 1.0;
|
---|
117 | gc.weighty = 1.0;
|
---|
118 | pnl.add(new JPanel(), gc);
|
---|
119 |
|
---|
120 | return pnl;
|
---|
121 | }
|
---|
122 |
|
---|
123 | protected JPanel buildInfoPanel() {
|
---|
124 | HtmlPanel pnlInfos = new HtmlPanel();
|
---|
125 | pnlInfos.setText(tr("<html>Please select one the following <strong>standard queries</strong>."
|
---|
126 | + "Select <strong>Download my changesets only</strong>"
|
---|
127 | + " if you only want to download changesets created by yourself.<br>"
|
---|
128 | + "Note that JOSM will download max. 100 changesets.</html>")
|
---|
129 | );
|
---|
130 | return pnlInfos;
|
---|
131 | }
|
---|
132 |
|
---|
133 | protected final void build() {
|
---|
134 | setLayout(new BorderLayout(0, 5));
|
---|
135 | setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
|
---|
136 | add(buildInfoPanel(), BorderLayout.NORTH);
|
---|
137 | add(buildQueriesPanel(), BorderLayout.CENTER);
|
---|
138 | }
|
---|
139 |
|
---|
140 | /**
|
---|
141 | * Constructs a new {@code BasicChangesetQueryPanel}.
|
---|
142 | */
|
---|
143 | public BasicChangesetQueryPanel() {
|
---|
144 | build();
|
---|
145 | }
|
---|
146 |
|
---|
147 | public void init() {
|
---|
148 | JMultilineLabel lbl = lblQueries.get(BasicQuery.MOST_RECENT_CHANGESETS);
|
---|
149 | lbl.setText(tr("<html>Download the latest changesets</html>"));
|
---|
150 |
|
---|
151 | // query for open changesets only possible if we have a current user which is at least
|
---|
152 | // partially identified
|
---|
153 | lbl = lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS);
|
---|
154 | if (JosmUserIdentityManager.getInstance().isAnonymous()) {
|
---|
155 | rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(false);
|
---|
156 | lbl.setText(tr("<html>Download my open changesets<br><em>Disabled. " +
|
---|
157 | "Please enter your OSM user name in the preferences first.</em></html>"));
|
---|
158 | } else {
|
---|
159 | rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(true);
|
---|
160 | lbl.setText(tr("<html>Download my open changesets</html>"));
|
---|
161 | }
|
---|
162 |
|
---|
163 | // query for changesets in the current map view only if there *is* a current
|
---|
164 | // map view
|
---|
165 | lbl = lblQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW);
|
---|
166 | if (!Main.isDisplayingMapView()) {
|
---|
167 | rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(false);
|
---|
168 | lbl.setText(tr("<html>Download changesets in the current map view.<br><em>Disabled. " +
|
---|
169 | "There is currently no map view active.</em></html>"));
|
---|
170 | } else {
|
---|
171 | rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(true);
|
---|
172 | lbl.setText(tr("<html>Download changesets in the current map view</html>"));
|
---|
173 | }
|
---|
174 |
|
---|
175 | restoreFromPreferences();
|
---|
176 | }
|
---|
177 |
|
---|
178 | public void rememberInPreferences() {
|
---|
179 | BasicQuery q = getSelectedQuery();
|
---|
180 | if (q == null) {
|
---|
181 | Main.pref.put("changeset-query.basic.query", null);
|
---|
182 | } else {
|
---|
183 | Main.pref.put("changeset-query.basic.query", q.toString());
|
---|
184 | }
|
---|
185 | Main.pref.put("changeset-query.basic.my-changesets-only", cbMyChangesetsOnly.isSelected());
|
---|
186 | }
|
---|
187 |
|
---|
188 | public void restoreFromPreferences() {
|
---|
189 | BasicQuery q;
|
---|
190 | String value = Main.pref.get("changeset-query.basic.query", null);
|
---|
191 | if (value == null) {
|
---|
192 | q = BasicQuery.MOST_RECENT_CHANGESETS;
|
---|
193 | } else {
|
---|
194 | try {
|
---|
195 | q = BasicQuery.valueOf(BasicQuery.class, value);
|
---|
196 | } catch (IllegalArgumentException e) {
|
---|
197 | Main.warn(tr("Unexpected value for preference ''{0}'', got ''{1}''. Resetting to default query.",
|
---|
198 | "changeset-query.basic.query", value));
|
---|
199 | q = BasicQuery.MOST_RECENT_CHANGESETS;
|
---|
200 | }
|
---|
201 | }
|
---|
202 | rbQueries.get(q).setSelected(true);
|
---|
203 | boolean mineOnly = Main.pref.getBoolean("changeset-query.basic.my-changesets-only", false);
|
---|
204 | mineOnly = mineOnly || q.equals(BasicQuery.MY_OPEN_CHANGESETS);
|
---|
205 | cbMyChangesetsOnly.setSelected(mineOnly);
|
---|
206 | }
|
---|
207 |
|
---|
208 | protected BasicQuery getSelectedQuery() {
|
---|
209 | for (BasicQuery q : BasicQuery.values()) {
|
---|
210 | if (rbQueries.get(q).isSelected())
|
---|
211 | return q;
|
---|
212 | }
|
---|
213 | return null;
|
---|
214 | }
|
---|
215 |
|
---|
216 | public ChangesetQuery buildChangesetQuery() {
|
---|
217 | BasicQuery q = getSelectedQuery();
|
---|
218 | ChangesetQuery query = new ChangesetQuery();
|
---|
219 | JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
|
---|
220 | if (q == null)
|
---|
221 | return query;
|
---|
222 | switch(q) {
|
---|
223 | case MOST_RECENT_CHANGESETS:
|
---|
224 | break;
|
---|
225 | case MY_OPEN_CHANGESETS:
|
---|
226 | query = query.beingOpen(true);
|
---|
227 | break;
|
---|
228 | case CHANGESETS_IN_MAP_VIEW:
|
---|
229 | Bounds b = Main.map.mapView.getLatLonBounds(Main.map.mapView.getBounds());
|
---|
230 | query = query.inBbox(b);
|
---|
231 | break;
|
---|
232 | }
|
---|
233 |
|
---|
234 | if (cbMyChangesetsOnly.isSelected()) {
|
---|
235 | if (im.isPartiallyIdentified()) {
|
---|
236 | query = query.forUser(im.getUserName());
|
---|
237 | } else if (im.isFullyIdentified()) {
|
---|
238 | query = query.forUser(im.getUserId()).beingOpen(true);
|
---|
239 | } else
|
---|
240 | // anonymous -- can happen with a fresh config.
|
---|
241 | throw new IllegalStateException(tr("Cannot create changeset query for open changesets of anonymous user"));
|
---|
242 | }
|
---|
243 |
|
---|
244 | return query;
|
---|
245 | }
|
---|
246 |
|
---|
247 | /**
|
---|
248 | * Responds to changes in the selected query
|
---|
249 | *
|
---|
250 | */
|
---|
251 | class SelectQueryHandler implements ItemListener {
|
---|
252 | @Override
|
---|
253 | public void itemStateChanged(ItemEvent e) {
|
---|
254 | BasicQuery q = getSelectedQuery();
|
---|
255 | if (q == null) return;
|
---|
256 | if (q.equals(BasicQuery.MY_OPEN_CHANGESETS)) {
|
---|
257 | cbMyChangesetsOnly.setSelected(true);
|
---|
258 | cbMyChangesetsOnly.setEnabled(false);
|
---|
259 | } else {
|
---|
260 | if (!cbMyChangesetsOnly.isEnabled()) {
|
---|
261 | cbMyChangesetsOnly.setEnabled(true);
|
---|
262 | }
|
---|
263 | }
|
---|
264 | }
|
---|
265 | }
|
---|
266 | }
|
---|