1 package jalview.ws2.gui;
4 import java.awt.event.MouseAdapter;
5 import java.awt.event.MouseEvent;
7 import java.util.ArrayList;
8 import java.util.Collection;
9 import java.util.Collections;
10 import java.util.Comparator;
11 import java.util.HashMap;
12 import java.util.HashSet;
13 import java.util.List;
15 import java.util.Objects;
16 import java.util.TreeMap;
17 import java.util.concurrent.CompletionStage;
19 import javax.swing.JMenu;
20 import javax.swing.JMenuItem;
21 import javax.swing.ToolTipManager;
23 import jalview.gui.AlignFrame;
24 import jalview.gui.Desktop;
25 import jalview.gui.JvSwingUtils;
26 import jalview.gui.WsJobParameters;
27 import jalview.util.MessageManager;
28 import jalview.viewmodel.AlignmentViewport;
29 import jalview.ws.params.ArgumentI;
30 import jalview.ws.params.ParamDatastoreI;
31 import jalview.ws.params.WsParamSetI;
32 import jalview.ws2.actions.alignment.AlignmentAction;
33 import jalview.ws2.actions.api.ActionI;
34 import jalview.ws2.actions.api.TaskI;
35 import jalview.ws2.api.Credentials;
36 import jalview.ws2.api.WebService;
37 import jalview.ws2.client.api.WebServiceProviderI;
39 public class WebServicesMenuManager
41 private final JMenu menu;
43 private final AlignFrame frame;
45 private JMenuItem inProgressItem = new JMenuItem("Service discovery in progress");
47 private JMenuItem noServicesItem = new JMenuItem("No services available");
49 inProgressItem.setEnabled(false);
50 inProgressItem.setVisible(false);
51 noServicesItem.setEnabled(false);
54 public WebServicesMenuManager(String name, AlignFrame frame)
57 menu = new JMenu(name);
58 menu.add(inProgressItem);
59 menu.add(noServicesItem);
62 public JMenu getMenu()
67 public void setNoServices(boolean noServices)
69 noServicesItem.setVisible(noServices);
72 public void setInProgress(boolean inProgress)
74 inProgressItem.setVisible(inProgress);
77 public void setServices(WebServiceProviderI services)
80 // services grouped by their category
81 Map<String, List<WebService<?>>> oneshotServices = new HashMap<>();
82 Map<String, List<WebService<?>>> interactiveServices = new HashMap<>();
83 for (WebService<?> service : services.getServices())
85 var map = service.isInteractive() ? interactiveServices : oneshotServices;
86 map.computeIfAbsent(service.getCategory(), k -> new ArrayList<>())
89 var allKeysSet = new HashSet<>(oneshotServices.keySet());
90 allKeysSet.addAll(interactiveServices.keySet());
91 var allKeys = new ArrayList<>(allKeysSet);
92 allKeys.sort(Comparator.naturalOrder());
93 for (String category : allKeys)
95 var categoryMenu = new JMenu(category);
96 var oneshot = oneshotServices.get(category);
98 addOneshotEntries(oneshot, categoryMenu);
99 var interactive = interactiveServices.get(category);
100 if (interactive != null)
103 categoryMenu.addSeparator();
104 // addInteractiveEntries(interactive, categoryMenu);
106 menu.add(categoryMenu);
108 menu.add(inProgressItem);
109 menu.add(noServicesItem);
112 private void addOneshotEntries(List<WebService<?>> services, JMenu menu)
114 services.sort(Comparator
115 .<WebService<?>, String> comparing(s -> s.getUrl().toString())
116 .thenComparing(WebService::getName));
118 for (WebService<?> service : services)
120 // if new host differs from the last one, add entry separating them
121 URL host = service.getUrl();
122 if (!host.equals(lastHost))
124 if (lastHost != null)
126 var item = new JMenuItem(host.toString());
127 item.setForeground(Color.BLUE);
128 item.addActionListener(e -> Desktop.showUrl(host.toString()));
133 // group actions by their subcategory, sorted
134 var actionsByCategory = new TreeMap<String, List<ActionI<?>>>();
135 for (ActionI<?> action : service.getActions())
139 Objects.requireNonNullElse(action.getSubcategory(), ""),
140 k -> new ArrayList<>())
143 actionsByCategory.forEach((k, v) -> {
144 // create submenu named {subcategory} with {service} or use root menu
145 var atMenu = k.isEmpty() ? menu : new JMenu(String.format("%s with %s", k, service.getName()));
147 menu.add(atMenu); // add only if submenu
148 // sort actions by name pulling nulls to the front
149 v.sort(Comparator.comparing(
150 ActionI::getName, Comparator.nullsFirst(Comparator.naturalOrder())));
151 for (ActionI<?> action : v)
153 addEntriesForAction(action, atMenu, atMenu == menu);
159 private void addEntriesForAction(ActionI<?> action, JMenu menu, boolean isTopLevel)
161 var service = action.getWebService();
165 itemName = service.getName();
166 if (action.getName() != null && !action.getName().isEmpty())
167 itemName += " " + action.getName();
171 if (action.getName() == null || action.getName().isEmpty())
174 itemName = action.getName();
176 var datastore = service.getParamDatastore();
178 String text = itemName;
179 if (datastore.hasParameters() || datastore.hasPresets())
180 text += "with defaults";
181 JMenuItem item = new JMenuItem(text);
182 item.addActionListener(e -> {
183 runAction(action, frame.getCurrentView(), Collections.emptyList(),
184 Credentials.empty());
188 if (datastore.hasParameters())
190 JMenuItem item = new JMenuItem("Edit settings and run...");
191 item.addActionListener(e -> {
192 openEditParamsDialog(datastore, null, null).thenAccept(args -> {
194 runAction(action, frame.getCurrentView(), args, Credentials.empty());
199 var presets = datastore.getPresets();
200 if (presets != null && presets.size() > 0)
202 final var presetsMenu = new JMenu(MessageManager.formatMessage(
203 "label.run_with_preset_params", service.getName()));
204 final int dismissDelay = ToolTipManager.sharedInstance()
206 final int QUICK_TOOLTIP = 1500;
207 for (var preset : presets)
209 var item = new JMenuItem(preset.getName());
210 item.addMouseListener(new MouseAdapter()
213 public void mouseEntered(MouseEvent evt)
215 ToolTipManager.sharedInstance().setDismissDelay(QUICK_TOOLTIP);
219 public void mouseExited(MouseEvent evt)
221 ToolTipManager.sharedInstance().setDismissDelay(dismissDelay);
224 String tooltipTitle = MessageManager.getString(
225 preset.isModifiable() ? "label.user_preset" : "label.service_preset");
226 String tooltip = String.format("<strong>%s</strong><br/>%s",
227 tooltipTitle, preset.getDescription());
228 tooltip = JvSwingUtils.wrapTooltip(true, tooltip);
229 item.setToolTipText(tooltip);
230 item.addActionListener(event -> {
231 runAction(action, frame.getCurrentView(), preset.getArguments(),
232 Credentials.empty());
234 presetsMenu.add(item);
236 menu.add(presetsMenu);
240 private TaskI<?> runAction(ActionI<?> action, AlignmentViewport viewport,
241 List<ArgumentI> args, Credentials credentials)
243 // casting and instance checks can be avoided with some effort,
244 // let them be for now.
245 if (action instanceof AlignmentAction)
247 // TODO: test if selection contains enough sequences
248 var _action = (AlignmentAction) action;
249 var handler = new AlignmentServiceGuiHandler(_action, frame);
250 return _action.perform(viewport, args, credentials, handler);
252 throw new IllegalArgumentException(
253 String.format("Illegal action type %s", action.getClass().getName()));
256 private static CompletionStage<List<ArgumentI>> openEditParamsDialog(
257 ParamDatastoreI paramStore, WsParamSetI preset, List<ArgumentI> arguments)
259 final WsJobParameters jobParams;
260 if (preset == null && arguments != null && arguments.size() > 0)
261 jobParams = new WsJobParameters(paramStore, preset, arguments);
263 jobParams = new WsJobParameters(paramStore, preset, null);
265 jobParams.setName(MessageManager.getString(
266 "label.adjusting_parameters_for_calculation"));
267 var stage = jobParams.showRunDialog();
268 return stage.thenApply(startJob -> {
270 return null; // null if cancelled
271 if (jobParams.getPreset() != null)
272 return jobParams.getPreset().getArguments();
273 if (jobParams.isServiceDefaults())
274 return Collections.emptyList();
276 return jobParams.getJobParams();