001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.dialogs.changeset.query; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.BorderLayout; 007import java.awt.GridBagConstraints; 008import java.awt.GridBagLayout; 009import java.awt.Insets; 010import java.awt.event.ItemEvent; 011import java.awt.event.ItemListener; 012import java.util.HashMap; 013import java.util.Map; 014 015import javax.swing.BorderFactory; 016import javax.swing.ButtonGroup; 017import javax.swing.JCheckBox; 018import javax.swing.JPanel; 019import javax.swing.JRadioButton; 020 021import org.openstreetmap.josm.Main; 022import org.openstreetmap.josm.data.Bounds; 023import org.openstreetmap.josm.gui.JosmUserIdentityManager; 024import org.openstreetmap.josm.gui.widgets.HtmlPanel; 025import org.openstreetmap.josm.gui.widgets.JMultilineLabel; 026import org.openstreetmap.josm.io.ChangesetQuery; 027 028/** 029 * This panel presents a list of basic queries for changests. 030 * 031 */ 032public class BasicChangesetQueryPanel extends JPanel { 033 034 /** 035 * Enumeration of basic, predefined queries 036 */ 037 private static enum BasicQuery { 038 MOST_RECENT_CHANGESETS, 039 MY_OPEN_CHANGESETS, 040 CHANGESETS_IN_MAP_VIEW; 041 } 042 043 private Map<BasicQuery, JRadioButton> rbQueries; 044 private Map<BasicQuery, JMultilineLabel> lblQueries; 045 private JCheckBox cbMyChangesetsOnly; 046 047 protected JPanel buildQueriesPanel() { 048 JPanel pnl = new JPanel(new GridBagLayout()); 049 050 ButtonGroup bgQueries = new ButtonGroup(); 051 rbQueries = new HashMap<>(); 052 lblQueries = new HashMap<>(); 053 SelectQueryHandler selectedQueryHandler = new SelectQueryHandler(); 054 for (BasicQuery q: BasicQuery.values()) { 055 JRadioButton rb = new JRadioButton(); 056 rb.addItemListener(selectedQueryHandler); 057 rbQueries.put(q, rb); 058 bgQueries.add(rb); 059 lblQueries.put(q, new JMultilineLabel("")); 060 } 061 062 GridBagConstraints gc = new GridBagConstraints(); 063 // -- most recent changes 064 gc.fill = GridBagConstraints.NONE; 065 gc.anchor = GridBagConstraints.NORTHWEST; 066 gc.insets = new Insets(0,0,5,3); 067 pnl.add(rbQueries.get(BasicQuery.MOST_RECENT_CHANGESETS), gc); 068 069 gc.gridx = 1; 070 gc.fill = GridBagConstraints.HORIZONTAL; 071 gc.weightx = 1.0; 072 pnl.add(lblQueries.get(BasicQuery.MOST_RECENT_CHANGESETS), gc); 073 074 // -- most recent changes 075 gc.gridx = 0; 076 gc.gridy = 1; 077 gc.fill = GridBagConstraints.NONE; 078 gc.weightx = 0.0; 079 pnl.add(rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS), gc); 080 081 gc.gridx = 1; 082 gc.fill = GridBagConstraints.HORIZONTAL; 083 gc.weightx = 1.0; 084 pnl.add(lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS), gc); 085 086 // -- changesets in map view 087 gc.gridx = 0; 088 gc.gridy = 2; 089 gc.fill = GridBagConstraints.NONE; 090 gc.weightx = 0.0; 091 pnl.add(rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW), gc); 092 093 gc.gridx = 1; 094 gc.fill = GridBagConstraints.HORIZONTAL; 095 gc.weightx = 1.0; 096 pnl.add(lblQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW), gc); 097 098 // -- checkbox my changesets only 099 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 pnl.add(cbMyChangesetsOnly = new JCheckBox(tr("Download my changesets only")), gc); 106 cbMyChangesetsOnly.setToolTipText(tr("<html>Select to restrict the query to your changesets only.<br>Unselect to include all changesets in the query.</html>")); 107 108 // grab remaining space 109 gc.gridx = 0; 110 gc.gridy = 4; 111 gc.gridwidth = 2; 112 gc.insets = new Insets(5,0,3,3); 113 gc.fill = GridBagConstraints.BOTH; 114 gc.weightx = 1.0; 115 gc.weighty = 1.0; 116 pnl.add(new JPanel(), gc); 117 118 return pnl; 119 } 120 121 protected JPanel buildInfoPanel() { 122 HtmlPanel pnlInfos = new HtmlPanel(); 123 pnlInfos.setText(tr("<html>Please select one the following <strong>standard queries</strong>." 124 + "Select <strong>Download my changesets only</strong>" 125 + " if you only want to download changesets created by yourself.<br>" 126 + "Note that JOSM will download max. 100 changesets.</html>") 127 ); 128 return pnlInfos; 129 } 130 131 protected final void build() { 132 setLayout(new BorderLayout(0,5)); 133 setBorder(BorderFactory.createEmptyBorder(5,5,5,5)); 134 add(buildInfoPanel(), BorderLayout.NORTH); 135 add(buildQueriesPanel(), BorderLayout.CENTER); 136 } 137 138 /** 139 * Constructs a new {@code BasicChangesetQueryPanel}. 140 */ 141 public BasicChangesetQueryPanel() { 142 build(); 143 } 144 145 public void init() { 146 JMultilineLabel lbl = lblQueries.get(BasicQuery.MOST_RECENT_CHANGESETS); 147 lbl.setText(tr("<html>Download the latest changesets</html>")); 148 149 // query for open changesets only possible if we have a current user which is at least 150 // partially identified 151 lbl = lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS); 152 if (JosmUserIdentityManager.getInstance().isAnonymous()) { 153 rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(false); 154 lbl.setText(tr("<html>Download my open changesets<br><em>Disabled. Please enter your OSM user name in the preferences first.</em></html>")); 155 } else { 156 rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(true); 157 lbl.setText(tr("<html>Download my open changesets</html>")); 158 } 159 160 // query for changesets in the current map view only if there *is* a current 161 // map view 162 lbl = lblQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW); 163 if (!Main.isDisplayingMapView()) { 164 rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(false); 165 lbl.setText(tr("<html>Download changesets in the current map view.<br><em>Disabled. There is currently no map view active.</em></html>")); 166 } else { 167 rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(true); 168 lbl.setText(tr("<html>Download changesets in the current map view</html>")); 169 } 170 171 restoreFromPreferences(); 172 } 173 174 public void rememberInPreferences() { 175 BasicQuery q = getSelectedQuery(); 176 if (q == null) { 177 Main.pref.put("changeset-query.basic.query", null); 178 } else { 179 Main.pref.put("changeset-query.basic.query", q.toString()); 180 } 181 Main.pref.put("changeset-query.basic.my-changesets-only", cbMyChangesetsOnly.isSelected()); 182 } 183 184 public void restoreFromPreferences() { 185 BasicQuery q; 186 String value = Main.pref.get("changeset-query.basic.query", null); 187 if (value == null) { 188 q = BasicQuery.MOST_RECENT_CHANGESETS; 189 } else { 190 try { 191 q = BasicQuery.valueOf(BasicQuery.class, value); 192 } catch(IllegalArgumentException e) { 193 Main.warn(tr("Unexpected value for preference ''{0}'', got ''{1}''. Resetting to default query.","changeset-query.basic.query", value)); 194 q = BasicQuery.MOST_RECENT_CHANGESETS; 195 } 196 } 197 rbQueries.get(q).setSelected(true); 198 boolean mineOnly = Main.pref.getBoolean("changeset-query.basic.my-changesets-only", false); 199 mineOnly = mineOnly || q.equals(BasicQuery.MY_OPEN_CHANGESETS); 200 cbMyChangesetsOnly.setSelected(mineOnly); 201 } 202 203 protected BasicQuery getSelectedQuery() { 204 for (BasicQuery q : BasicQuery.values()) { 205 if (rbQueries.get(q).isSelected()) 206 return q; 207 } 208 return null; 209 } 210 211 public ChangesetQuery buildChangesetQuery() { 212 BasicQuery q = getSelectedQuery(); 213 ChangesetQuery query = new ChangesetQuery(); 214 JosmUserIdentityManager im = JosmUserIdentityManager.getInstance(); 215 if (q == null) 216 return query; 217 switch(q) { 218 case MOST_RECENT_CHANGESETS: 219 break; 220 case MY_OPEN_CHANGESETS: 221 query = query.beingOpen(true); 222 break; 223 case CHANGESETS_IN_MAP_VIEW: 224 Bounds b = Main.map.mapView.getLatLonBounds(Main.map.mapView.getBounds()); 225 query = query.inBbox(b); 226 break; 227 } 228 229 if (cbMyChangesetsOnly.isSelected()) { 230 if (im.isPartiallyIdentified()) { 231 query = query.forUser(im.getUserName()); 232 } else if (im.isFullyIdentified()) { 233 query = query.forUser(im.getUserId()).beingOpen(true); 234 } else 235 // anonymous -- can happen with a fresh config. 236 throw new IllegalStateException(tr("Cannot create changeset query for open changesets of anonymous user")); 237 } 238 239 return query; 240 } 241 242 /** 243 * Responds to changes in the selected query 244 * 245 */ 246 class SelectQueryHandler implements ItemListener { 247 @Override 248 public void itemStateChanged(ItemEvent e) { 249 BasicQuery q = getSelectedQuery(); 250 if (q == null) return; 251 if (q.equals(BasicQuery.MY_OPEN_CHANGESETS)) { 252 cbMyChangesetsOnly.setSelected(true); 253 cbMyChangesetsOnly.setEnabled(false); 254 } else { 255 if (! cbMyChangesetsOnly.isEnabled()) { 256 cbMyChangesetsOnly.setEnabled(true); 257 } 258 } 259 } 260 } 261}