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.EnumMap; 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 enum BasicQuery { 038 MOST_RECENT_CHANGESETS, 039 MY_OPEN_CHANGESETS, 040 CHANGESETS_IN_MAP_VIEW; 041 } 042 043 private transient Map<BasicQuery, JRadioButton> rbQueries; 044 private transient 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 EnumMap<>(BasicQuery.class); 052 lblQueries = new EnumMap<>(BasicQuery.class); 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( 107 tr("<html>Select to restrict the query to your changesets only.<br>Unselect to include all changesets in the query.</html>")); 108 109 // grab remaining space 110 gc.gridx = 0; 111 gc.gridy = 4; 112 gc.gridwidth = 2; 113 gc.insets = new Insets(5, 0, 3, 3); 114 gc.fill = GridBagConstraints.BOTH; 115 gc.weightx = 1.0; 116 gc.weighty = 1.0; 117 pnl.add(new JPanel(), gc); 118 119 return pnl; 120 } 121 122 protected JPanel buildInfoPanel() { 123 HtmlPanel pnlInfos = new HtmlPanel(); 124 pnlInfos.setText(tr("<html>Please select one the following <strong>standard queries</strong>." 125 + "Select <strong>Download my changesets only</strong>" 126 + " if you only want to download changesets created by yourself.<br>" 127 + "Note that JOSM will download max. 100 changesets.</html>") 128 ); 129 return pnlInfos; 130 } 131 132 protected final void build() { 133 setLayout(new BorderLayout(0, 5)); 134 setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5)); 135 add(buildInfoPanel(), BorderLayout.NORTH); 136 add(buildQueriesPanel(), BorderLayout.CENTER); 137 } 138 139 /** 140 * Constructs a new {@code BasicChangesetQueryPanel}. 141 */ 142 public BasicChangesetQueryPanel() { 143 build(); 144 } 145 146 public void init() { 147 JMultilineLabel lbl = lblQueries.get(BasicQuery.MOST_RECENT_CHANGESETS); 148 lbl.setText(tr("<html>Download the latest changesets</html>")); 149 150 // query for open changesets only possible if we have a current user which is at least 151 // partially identified 152 lbl = lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS); 153 if (JosmUserIdentityManager.getInstance().isAnonymous()) { 154 rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(false); 155 lbl.setText(tr("<html>Download my open changesets<br><em>Disabled. " + 156 "Please enter your OSM user name in the preferences first.</em></html>")); 157 } else { 158 rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(true); 159 lbl.setText(tr("<html>Download my open changesets</html>")); 160 } 161 162 // query for changesets in the current map view only if there *is* a current 163 // map view 164 lbl = lblQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW); 165 if (!Main.isDisplayingMapView()) { 166 rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(false); 167 lbl.setText(tr("<html>Download changesets in the current map view.<br><em>Disabled. " + 168 "There is currently no map view active.</em></html>")); 169 } else { 170 rbQueries.get(BasicQuery.CHANGESETS_IN_MAP_VIEW).setEnabled(true); 171 lbl.setText(tr("<html>Download changesets in the current map view</html>")); 172 } 173 174 restoreFromPreferences(); 175 } 176 177 public void rememberInPreferences() { 178 BasicQuery q = getSelectedQuery(); 179 if (q == null) { 180 Main.pref.put("changeset-query.basic.query", null); 181 } else { 182 Main.pref.put("changeset-query.basic.query", q.toString()); 183 } 184 Main.pref.put("changeset-query.basic.my-changesets-only", cbMyChangesetsOnly.isSelected()); 185 } 186 187 public void restoreFromPreferences() { 188 BasicQuery q; 189 String value = Main.pref.get("changeset-query.basic.query", null); 190 if (value == null) { 191 q = BasicQuery.MOST_RECENT_CHANGESETS; 192 } else { 193 try { 194 q = BasicQuery.valueOf(BasicQuery.class, value); 195 } catch (IllegalArgumentException e) { 196 Main.warn(tr("Unexpected value for preference ''{0}'', got ''{1}''. Resetting to default query.", 197 "changeset-query.basic.query", value)); 198 q = BasicQuery.MOST_RECENT_CHANGESETS; 199 } 200 } 201 rbQueries.get(q).setSelected(true); 202 boolean mineOnly = Main.pref.getBoolean("changeset-query.basic.my-changesets-only", false); 203 mineOnly = mineOnly || q.equals(BasicQuery.MY_OPEN_CHANGESETS); 204 cbMyChangesetsOnly.setSelected(mineOnly); 205 } 206 207 protected BasicQuery getSelectedQuery() { 208 for (BasicQuery q : BasicQuery.values()) { 209 if (rbQueries.get(q).isSelected()) 210 return q; 211 } 212 return null; 213 } 214 215 public ChangesetQuery buildChangesetQuery() { 216 BasicQuery q = getSelectedQuery(); 217 ChangesetQuery query = new ChangesetQuery(); 218 JosmUserIdentityManager im = JosmUserIdentityManager.getInstance(); 219 if (q == null) 220 return query; 221 switch(q) { 222 case MOST_RECENT_CHANGESETS: 223 break; 224 case MY_OPEN_CHANGESETS: 225 query = query.beingOpen(true); 226 break; 227 case CHANGESETS_IN_MAP_VIEW: 228 Bounds b = Main.map.mapView.getLatLonBounds(Main.map.mapView.getBounds()); 229 query = query.inBbox(b); 230 break; 231 } 232 233 if (cbMyChangesetsOnly.isSelected()) { 234 if (im.isPartiallyIdentified()) { 235 query = query.forUser(im.getUserName()); 236 } else if (im.isFullyIdentified()) { 237 query = query.forUser(im.getUserId()).beingOpen(true); 238 } else 239 // anonymous -- can happen with a fresh config. 240 throw new IllegalStateException(tr("Cannot create changeset query for open changesets of anonymous user")); 241 } 242 243 return query; 244 } 245 246 /** 247 * Responds to changes in the selected query 248 * 249 */ 250 class SelectQueryHandler implements ItemListener { 251 @Override 252 public void itemStateChanged(ItemEvent e) { 253 BasicQuery q = getSelectedQuery(); 254 if (q == null) return; 255 if (q.equals(BasicQuery.MY_OPEN_CHANGESETS)) { 256 cbMyChangesetsOnly.setSelected(true); 257 cbMyChangesetsOnly.setEnabled(false); 258 } else { 259 if (!cbMyChangesetsOnly.isEnabled()) { 260 cbMyChangesetsOnly.setEnabled(true); 261 } 262 } 263 } 264 } 265}