source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/UserRestrictionPanel.java@ 11330

Last change on this file since 11330 was 11330, checked in by Don-vip, 7 years ago

sonar - fix recent issues
  • Property svn:eol-style set to native
File size: 11.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs.changeset.query;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Color;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.Insets;
10import java.awt.event.ItemEvent;
11import java.awt.event.ItemListener;
12
13import javax.swing.BorderFactory;
14import javax.swing.ButtonGroup;
15import javax.swing.JLabel;
16import javax.swing.JOptionPane;
17import javax.swing.JPanel;
18import javax.swing.JRadioButton;
19
20import org.openstreetmap.josm.Main;
21import org.openstreetmap.josm.gui.HelpAwareOptionPane;
22import org.openstreetmap.josm.gui.JosmUserIdentityManager;
23import org.openstreetmap.josm.gui.help.HelpUtil;
24import org.openstreetmap.josm.gui.preferences.server.UserNameValidator;
25import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
26import org.openstreetmap.josm.gui.widgets.JosmTextField;
27import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
28import org.openstreetmap.josm.io.ChangesetQuery;
29import org.openstreetmap.josm.tools.CheckParameterUtil;
30
31/**
32 * This is the panel for selecting whether the query should be restricted to a specific user.
33 * @since 11326 (extracted from AdvancedChangesetQueryPanel)
34 */
35public class UserRestrictionPanel extends JPanel implements RestrictionPanel {
36 private static final String PREF_ROOT = "changeset-query.advanced.user-restrictions";
37 private static final String PREF_QUERY_TYPE = PREF_ROOT + ".query-type";
38
39 private final ButtonGroup bgUserRestrictions = new ButtonGroup();
40 private final JRadioButton rbRestrictToMyself = new JRadioButton();
41 private final JRadioButton rbRestrictToUid = new JRadioButton();
42 private final JRadioButton rbRestrictToUserName = new JRadioButton();
43 private final JosmTextField tfUid = new JosmTextField(10);
44 private transient UidInputFieldValidator valUid;
45 private final JosmTextField tfUserName = new JosmTextField(10);
46 private transient UserNameValidator valUserName;
47 private final JMultilineLabel lblRestrictedToMyself = new JMultilineLabel(tr("Only changesets owned by myself"));
48
49 /**
50 * Constructs a new {@code UserRestrictionPanel}.
51 */
52 public UserRestrictionPanel() {
53 build();
54 }
55
56 protected JPanel buildUidInputPanel() {
57 JPanel pnl = new JPanel(new GridBagLayout());
58 GridBagConstraints gc = new GridBagConstraints();
59 gc.fill = GridBagConstraints.HORIZONTAL;
60 gc.weightx = 0.0;
61 gc.insets = new Insets(0, 0, 0, 3);
62 pnl.add(new JLabel(tr("User ID:")), gc);
63
64 gc.gridx = 1;
65 pnl.add(tfUid, gc);
66 SelectAllOnFocusGainedDecorator.decorate(tfUid);
67 valUid = UidInputFieldValidator.decorate(tfUid);
68
69 // grab remaining space
70 gc.gridx = 2;
71 gc.weightx = 1.0;
72 pnl.add(new JPanel(), gc);
73 return pnl;
74 }
75
76 protected JPanel buildUserNameInputPanel() {
77 JPanel pnl = new JPanel(new GridBagLayout());
78 GridBagConstraints gc = new GridBagConstraints();
79 gc.fill = GridBagConstraints.HORIZONTAL;
80 gc.weightx = 0.0;
81 gc.insets = new Insets(0, 0, 0, 3);
82 pnl.add(new JLabel(tr("User name:")), gc);
83
84 gc.gridx = 1;
85 pnl.add(tfUserName, gc);
86 SelectAllOnFocusGainedDecorator.decorate(tfUserName);
87 valUserName = new UserNameValidator(tfUserName);
88
89 // grab remaining space
90 gc.gridx = 2;
91 gc.weightx = 1.0;
92 pnl.add(new JPanel(), gc);
93 return pnl;
94 }
95
96 protected void build() {
97 setLayout(new GridBagLayout());
98 setBorder(BorderFactory.createCompoundBorder(
99 BorderFactory.createEmptyBorder(3, 3, 3, 3),
100 BorderFactory.createCompoundBorder(
101 BorderFactory.createLineBorder(Color.GRAY),
102 BorderFactory.createEmptyBorder(5, 5, 5, 5)
103 )
104 ));
105
106 ItemListener userRestrictionChangeHandler = new UserRestrictionChangedHandler();
107 GridBagConstraints gc = new GridBagConstraints();
108 gc.anchor = GridBagConstraints.NORTHWEST;
109 gc.gridx = 0;
110 gc.fill = GridBagConstraints.HORIZONTAL;
111 gc.weightx = 0.0;
112 add(rbRestrictToMyself, gc);
113 rbRestrictToMyself.addItemListener(userRestrictionChangeHandler);
114
115 gc.gridx = 1;
116 gc.fill = GridBagConstraints.HORIZONTAL;
117 gc.weightx = 1.0;
118 add(lblRestrictedToMyself, gc);
119
120 gc.gridx = 0;
121 gc.gridy = 1;
122 gc.fill = GridBagConstraints.HORIZONTAL;
123 gc.weightx = 0.0;
124 add(rbRestrictToUid, gc);
125 rbRestrictToUid.addItemListener(userRestrictionChangeHandler);
126
127 gc.gridx = 1;
128 gc.fill = GridBagConstraints.HORIZONTAL;
129 gc.weightx = 1.0;
130 add(new JMultilineLabel(tr("Only changesets owned by the user with the following user ID")), gc);
131
132 gc.gridx = 1;
133 gc.gridy = 2;
134 gc.fill = GridBagConstraints.HORIZONTAL;
135 gc.weightx = 1.0;
136 add(buildUidInputPanel(), gc);
137
138 gc.gridx = 0;
139 gc.gridy = 3;
140 gc.fill = GridBagConstraints.HORIZONTAL;
141 gc.weightx = 0.0;
142 add(rbRestrictToUserName, gc);
143 rbRestrictToUserName.addItemListener(userRestrictionChangeHandler);
144
145 gc.gridx = 1;
146 gc.fill = GridBagConstraints.HORIZONTAL;
147 gc.weightx = 1.0;
148 add(new JMultilineLabel(tr("Only changesets owned by the user with the following user name")), gc);
149
150 gc.gridx = 1;
151 gc.gridy = 4;
152 gc.fill = GridBagConstraints.HORIZONTAL;
153 gc.weightx = 1.0;
154 add(buildUserNameInputPanel(), gc);
155
156 bgUserRestrictions.add(rbRestrictToMyself);
157 bgUserRestrictions.add(rbRestrictToUid);
158 bgUserRestrictions.add(rbRestrictToUserName);
159 }
160
161 /**
162 * Initializes HMI for user input.
163 */
164 public void startUserInput() {
165 if (JosmUserIdentityManager.getInstance().isAnonymous()) {
166 lblRestrictedToMyself.setText(tr("Only changesets owned by myself (disabled. JOSM is currently run by an anonymous user)"));
167 rbRestrictToMyself.setEnabled(false);
168 if (rbRestrictToMyself.isSelected()) {
169 rbRestrictToUid.setSelected(true);
170 }
171 } else {
172 lblRestrictedToMyself.setText(tr("Only changesets owned by myself"));
173 rbRestrictToMyself.setEnabled(true);
174 rbRestrictToMyself.setSelected(true);
175 }
176 restoreFromSettings();
177 }
178
179 /**
180 * Sets the query restrictions on <code>query</code> for changeset owner based restrictions.
181 *
182 * @param query the query. Must not be null.
183 * @throws IllegalArgumentException if query is null
184 * @throws IllegalStateException if one of the available values for query parameters in this panel isn't valid
185 */
186 @Override
187 public void fillInQuery(ChangesetQuery query) {
188 CheckParameterUtil.ensureParameterNotNull(query, "query");
189 if (rbRestrictToMyself.isSelected()) {
190 JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
191 if (im.isPartiallyIdentified()) {
192 query.forUser(im.getUserName());
193 } else if (im.isFullyIdentified()) {
194 query.forUser(im.getUserId());
195 } else
196 throw new IllegalStateException(
197 tr("Cannot restrict changeset query to the current user because the current user is anonymous"));
198 } else if (rbRestrictToUid.isSelected()) {
199 int uid = valUid.getUid();
200 if (uid > 0) {
201 query.forUser(uid);
202 } else
203 throw new IllegalStateException(tr("Current value ''{0}'' for user ID is not valid", tfUid.getText()));
204 } else if (rbRestrictToUserName.isSelected()) {
205 if (!valUserName.isValid())
206 throw new IllegalStateException(
207 tr("Cannot restrict the changeset query to the user name ''{0}''", tfUserName.getText()));
208 query.forUser(tfUserName.getText());
209 }
210 }
211
212 /**
213 * Determines if the changeset query time information is valid.
214 * @return {@code true} if the changeset query time information is valid.
215 */
216 @Override
217 public boolean isValidChangesetQuery() {
218 if (rbRestrictToUid.isSelected())
219 return valUid.isValid();
220 else if (rbRestrictToUserName.isSelected())
221 return valUserName.isValid();
222 return true;
223 }
224
225 protected void alertInvalidUid() {
226 HelpAwareOptionPane.showOptionDialog(
227 this,
228 tr("Please enter a valid user ID"),
229 tr("Invalid user ID"),
230 JOptionPane.ERROR_MESSAGE,
231 HelpUtil.ht("/Dialog/ChangesetQueryDialog#InvalidUserId")
232 );
233 }
234
235 protected void alertInvalidUserName() {
236 HelpAwareOptionPane.showOptionDialog(
237 this,
238 tr("Please enter a non-empty user name"),
239 tr("Invalid user name"),
240 JOptionPane.ERROR_MESSAGE,
241 HelpUtil.ht("/Dialog/ChangesetQueryDialog#InvalidUserName")
242 );
243 }
244
245 @Override
246 public void displayMessageIfInvalid() {
247 if (rbRestrictToUid.isSelected()) {
248 if (!valUid.isValid()) {
249 alertInvalidUid();
250 }
251 } else if (rbRestrictToUserName.isSelected()) {
252 if (!valUserName.isValid()) {
253 alertInvalidUserName();
254 }
255 }
256 }
257
258 /**
259 * Remember settings in preferences.
260 */
261 public void rememberSettings() {
262 if (rbRestrictToMyself.isSelected()) {
263 Main.pref.put(PREF_QUERY_TYPE, "mine");
264 } else if (rbRestrictToUid.isSelected()) {
265 Main.pref.put(PREF_QUERY_TYPE, "uid");
266 } else if (rbRestrictToUserName.isSelected()) {
267 Main.pref.put(PREF_QUERY_TYPE, "username");
268 }
269 Main.pref.put(PREF_ROOT + ".uid", tfUid.getText());
270 Main.pref.put(PREF_ROOT + ".username", tfUserName.getText());
271 }
272
273 /**
274 * Restore settings from preferences.
275 */
276 public void restoreFromSettings() {
277 String v = Main.pref.get(PREF_QUERY_TYPE, "mine");
278 if ("mine".equals(v)) {
279 JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
280 if (im.isAnonymous()) {
281 rbRestrictToUid.setSelected(true);
282 } else {
283 rbRestrictToMyself.setSelected(true);
284 }
285 } else if ("uid".equals(v)) {
286 rbRestrictToUid.setSelected(true);
287 } else if ("username".equals(v)) {
288 rbRestrictToUserName.setSelected(true);
289 }
290 tfUid.setText(Main.pref.get(PREF_ROOT + ".uid", ""));
291 if (!valUid.isValid()) {
292 tfUid.setText("");
293 }
294 tfUserName.setText(Main.pref.get(PREF_ROOT + ".username", ""));
295 }
296
297 class UserRestrictionChangedHandler implements ItemListener {
298 @Override
299 public void itemStateChanged(ItemEvent e) {
300 tfUid.setEnabled(rbRestrictToUid.isSelected());
301 tfUserName.setEnabled(rbRestrictToUserName.isSelected());
302 if (rbRestrictToUid.isSelected()) {
303 tfUid.requestFocusInWindow();
304 } else if (rbRestrictToUserName.isSelected()) {
305 tfUserName.requestFocusInWindow();
306 }
307 }
308 }
309}
Note: See TracBrowser for help on using the repository browser.