source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/UserListDialog.java@ 11297

Last change on this file since 11297 was 10938, checked in by Don-vip, 8 years ago

sonar - squid:S1450 - Private fields only used as local variables in methods should become local variables
  • Property svn:eol-style set to native
File size: 12.5 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trn;
6
7import java.awt.event.ActionEvent;
8import java.awt.event.KeyEvent;
9import java.awt.event.MouseAdapter;
10import java.awt.event.MouseEvent;
11import java.text.NumberFormat;
12import java.util.ArrayList;
13import java.util.Arrays;
14import java.util.Collection;
15import java.util.Collections;
16import java.util.HashMap;
17import java.util.HashSet;
18import java.util.Iterator;
19import java.util.LinkedList;
20import java.util.List;
21import java.util.Map;
22import java.util.Set;
23
24import javax.swing.AbstractAction;
25import javax.swing.JTable;
26import javax.swing.ListSelectionModel;
27import javax.swing.event.ListSelectionEvent;
28import javax.swing.event.ListSelectionListener;
29import javax.swing.table.DefaultTableModel;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.actions.AbstractInfoAction;
33import org.openstreetmap.josm.data.SelectionChangedListener;
34import org.openstreetmap.josm.data.osm.DataSet;
35import org.openstreetmap.josm.data.osm.OsmPrimitive;
36import org.openstreetmap.josm.data.osm.User;
37import org.openstreetmap.josm.gui.SideButton;
38import org.openstreetmap.josm.gui.layer.Layer;
39import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeEvent;
40import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
41import org.openstreetmap.josm.gui.layer.OsmDataLayer;
42import org.openstreetmap.josm.gui.util.GuiHelper;
43import org.openstreetmap.josm.tools.ImageProvider;
44import org.openstreetmap.josm.tools.OpenBrowser;
45import org.openstreetmap.josm.tools.Shortcut;
46import org.openstreetmap.josm.tools.Utils;
47
48/**
49 * Displays a dialog with all users who have last edited something in the
50 * selection area, along with the number of objects.
51 *
52 */
53public class UserListDialog extends ToggleDialog implements SelectionChangedListener, ActiveLayerChangeListener {
54
55 /**
56 * The display list.
57 */
58 private JTable userTable;
59 private UserTableModel model;
60 private SelectUsersPrimitivesAction selectionUsersPrimitivesAction;
61
62 /**
63 * Constructs a new {@code UserListDialog}.
64 */
65 public UserListDialog() {
66 super(tr("Authors"), "userlist", tr("Open a list of people working on the selected objects."),
67 Shortcut.registerShortcut("subwindow:authors", tr("Toggle: {0}", tr("Authors")), KeyEvent.VK_A, Shortcut.ALT_SHIFT), 150);
68 build();
69 }
70
71 @Override
72 public void showNotify() {
73 DataSet.addSelectionListener(this);
74 Main.getLayerManager().addActiveLayerChangeListener(this);
75 }
76
77 @Override
78 public void hideNotify() {
79 Main.getLayerManager().removeActiveLayerChangeListener(this);
80 DataSet.removeSelectionListener(this);
81 }
82
83 protected void build() {
84 model = new UserTableModel();
85 userTable = new JTable(model);
86 userTable.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
87 userTable.addMouseListener(new DoubleClickAdapter());
88
89 // -- select users primitives action
90 //
91 selectionUsersPrimitivesAction = new SelectUsersPrimitivesAction();
92 userTable.getSelectionModel().addListSelectionListener(selectionUsersPrimitivesAction);
93
94 // -- info action
95 //
96 ShowUserInfoAction showUserInfoAction = new ShowUserInfoAction();
97 userTable.getSelectionModel().addListSelectionListener(showUserInfoAction);
98
99 createLayout(userTable, true, Arrays.asList(new SideButton[] {
100 new SideButton(selectionUsersPrimitivesAction),
101 new SideButton(showUserInfoAction)
102 }));
103 }
104
105 /**
106 * Called when the selection in the dataset changed.
107 * @param newSelection The new selection array.
108 */
109 @Override
110 public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
111 refresh(newSelection);
112 }
113
114 @Override
115 public void activeOrEditLayerChanged(ActiveLayerChangeEvent e) {
116 Layer activeLayer = e.getSource().getActiveLayer();
117 if (activeLayer instanceof OsmDataLayer) {
118 refresh(((OsmDataLayer) activeLayer).data.getAllSelected());
119 } else {
120 refresh(null);
121 }
122 }
123
124 /**
125 * Refreshes user list from given collection of OSM primitives.
126 * @param fromPrimitives OSM primitives to fetch users from
127 */
128 public void refresh(Collection<? extends OsmPrimitive> fromPrimitives) {
129 model.populate(fromPrimitives);
130 GuiHelper.runInEDT(() -> {
131 if (model.getRowCount() != 0) {
132 setTitle(trn("{0} Author", "{0} Authors", model.getRowCount(), model.getRowCount()));
133 } else {
134 setTitle(tr("Authors"));
135 }
136 });
137 }
138
139 @Override
140 public void showDialog() {
141 super.showDialog();
142 Layer layer = Main.getLayerManager().getActiveLayer();
143 if (layer instanceof OsmDataLayer) {
144 refresh(((OsmDataLayer) layer).data.getAllSelected());
145 }
146 }
147
148 class SelectUsersPrimitivesAction extends AbstractAction implements ListSelectionListener {
149
150 /**
151 * Constructs a new {@code SelectUsersPrimitivesAction}.
152 */
153 SelectUsersPrimitivesAction() {
154 putValue(NAME, tr("Select"));
155 putValue(SHORT_DESCRIPTION, tr("Select objects submitted by this user"));
156 new ImageProvider("dialogs", "select").getResource().attachImageIcon(this, true);
157 updateEnabledState();
158 }
159
160 public void select() {
161 int[] indexes = userTable.getSelectedRows();
162 if (indexes == null || indexes.length == 0)
163 return;
164 model.selectPrimitivesOwnedBy(userTable.getSelectedRows());
165 }
166
167 @Override
168 public void actionPerformed(ActionEvent e) {
169 select();
170 }
171
172 protected void updateEnabledState() {
173 setEnabled(userTable != null && userTable.getSelectedRowCount() > 0);
174 }
175
176 @Override
177 public void valueChanged(ListSelectionEvent e) {
178 updateEnabledState();
179 }
180 }
181
182 /**
183 * Action for launching the info page of a user.
184 */
185 class ShowUserInfoAction extends AbstractInfoAction implements ListSelectionListener {
186
187 ShowUserInfoAction() {
188 super(false);
189 putValue(NAME, tr("Show info"));
190 putValue(SHORT_DESCRIPTION, tr("Launches a browser with information about the user"));
191 new ImageProvider("help/internet").getResource().attachImageIcon(this, true);
192 updateEnabledState();
193 }
194
195 @Override
196 public void actionPerformed(ActionEvent e) {
197 int[] rows = userTable.getSelectedRows();
198 if (rows == null || rows.length == 0)
199 return;
200 List<User> users = model.getSelectedUsers(rows);
201 if (users.isEmpty())
202 return;
203 if (users.size() > 10) {
204 Main.warn(tr("Only launching info browsers for the first {0} of {1} selected users", 10, users.size()));
205 }
206 int num = Math.min(10, users.size());
207 Iterator<User> it = users.iterator();
208 while (it.hasNext() && num > 0) {
209 String url = createInfoUrl(it.next());
210 if (url == null) {
211 break;
212 }
213 OpenBrowser.displayUrl(url);
214 num--;
215 }
216 }
217
218 @Override
219 protected String createInfoUrl(Object infoObject) {
220 if (infoObject instanceof User) {
221 User user = (User) infoObject;
222 return Main.getBaseUserUrl() + '/' + Utils.encodeUrl(user.getName()).replaceAll("\\+", "%20");
223 } else {
224 return null;
225 }
226 }
227
228 @Override
229 protected void updateEnabledState() {
230 setEnabled(userTable != null && userTable.getSelectedRowCount() > 0);
231 }
232
233 @Override
234 public void valueChanged(ListSelectionEvent e) {
235 updateEnabledState();
236 }
237 }
238
239 class DoubleClickAdapter extends MouseAdapter {
240 @Override
241 public void mouseClicked(MouseEvent e) {
242 if (e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2) {
243 selectionUsersPrimitivesAction.select();
244 }
245 }
246 }
247
248 /**
249 * Action for selecting the primitives contributed by the currently selected users.
250 *
251 */
252 private static class UserInfo implements Comparable<UserInfo> {
253 public final User user;
254 public final int count;
255 public final double percent;
256
257 UserInfo(User user, int count, double percent) {
258 this.user = user;
259 this.count = count;
260 this.percent = percent;
261 }
262
263 @Override
264 public int compareTo(UserInfo o) {
265 if (count < o.count)
266 return 1;
267 if (count > o.count)
268 return -1;
269 if (user == null || user.getName() == null)
270 return 1;
271 if (o.user == null || o.user.getName() == null)
272 return -1;
273 return user.getName().compareTo(o.user.getName());
274 }
275
276 public String getName() {
277 if (user == null)
278 return tr("<new object>");
279 return user.getName();
280 }
281 }
282
283 /**
284 * The table model for the users
285 *
286 */
287 static class UserTableModel extends DefaultTableModel {
288 private final transient List<UserInfo> data;
289
290 UserTableModel() {
291 setColumnIdentifiers(new String[]{tr("Author"), tr("# Objects"), "%"});
292 data = new ArrayList<>();
293 }
294
295 protected Map<User, Integer> computeStatistics(Collection<? extends OsmPrimitive> primitives) {
296 Map<User, Integer> ret = new HashMap<>();
297 if (primitives == null || primitives.isEmpty())
298 return ret;
299 for (OsmPrimitive primitive: primitives) {
300 if (ret.containsKey(primitive.getUser())) {
301 ret.put(primitive.getUser(), ret.get(primitive.getUser()) + 1);
302 } else {
303 ret.put(primitive.getUser(), 1);
304 }
305 }
306 return ret;
307 }
308
309 public void populate(Collection<? extends OsmPrimitive> primitives) {
310 Map<User, Integer> statistics = computeStatistics(primitives);
311 data.clear();
312 if (primitives != null) {
313 for (Map.Entry<User, Integer> entry: statistics.entrySet()) {
314 data.add(new UserInfo(entry.getKey(), entry.getValue(), (double) entry.getValue() / (double) primitives.size()));
315 }
316 }
317 Collections.sort(data);
318 GuiHelper.runInEDTAndWait(this::fireTableDataChanged);
319 }
320
321 @Override
322 public int getRowCount() {
323 if (data == null)
324 return 0;
325 return data.size();
326 }
327
328 @Override
329 public Object getValueAt(int row, int column) {
330 UserInfo info = data.get(row);
331 switch(column) {
332 case 0: /* author */ return info.getName() == null ? "" : info.getName();
333 case 1: /* count */ return info.count;
334 case 2: /* percent */ return NumberFormat.getPercentInstance().format(info.percent);
335 default: return null;
336 }
337 }
338
339 @Override
340 public boolean isCellEditable(int row, int column) {
341 return false;
342 }
343
344 public void selectPrimitivesOwnedBy(int ... rows) {
345 Set<User> users = new HashSet<>();
346 for (int index: rows) {
347 users.add(data.get(index).user);
348 }
349 Collection<OsmPrimitive> selected = Main.getLayerManager().getEditDataSet().getAllSelected();
350 Collection<OsmPrimitive> byUser = new LinkedList<>();
351 for (OsmPrimitive p : selected) {
352 if (users.contains(p.getUser())) {
353 byUser.add(p);
354 }
355 }
356 Main.getLayerManager().getEditDataSet().setSelected(byUser);
357 }
358
359 public List<User> getSelectedUsers(int ... rows) {
360 List<User> ret = new LinkedList<>();
361 if (rows == null || rows.length == 0)
362 return ret;
363 for (int row: rows) {
364 if (data.get(row).user == null) {
365 continue;
366 }
367 ret.add(data.get(row).user);
368 }
369 return ret;
370 }
371 }
372}
Note: See TracBrowser for help on using the repository browser.