| /******************************************************************************* |
| * Copyright (c) 2004, 2010 Tasktop Technologies and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Tasktop Technologies - initial API and implementation |
| * IBM Corporation - helper methods from |
| * org.eclipse.wst.common.frameworks.internal.ui.WTPActivityHelper |
| *******************************************************************************/ |
| |
| package org.eclipse.equinox.internal.p2.ui.discovery.util; |
| |
| import static java.util.Arrays.stream; |
| |
| import java.net.MalformedURLException; |
| import java.net.URL; |
| import java.util.Calendar; |
| import java.util.Optional; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.equinox.internal.p2.core.helpers.LogHelper; |
| import org.eclipse.equinox.internal.p2.ui.discovery.DiscoveryUi; |
| import org.eclipse.jface.dialogs.MessageDialog; |
| import org.eclipse.osgi.util.NLS; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.widgets.Shell; |
| import org.eclipse.ui.*; |
| import org.eclipse.ui.activities.IIdentifier; |
| import org.eclipse.ui.activities.IWorkbenchActivitySupport; |
| import org.eclipse.ui.browser.IWebBrowser; |
| import org.eclipse.ui.browser.IWorkbenchBrowserSupport; |
| import org.eclipse.ui.internal.browser.WebBrowserPreference; |
| import org.eclipse.ui.internal.browser.WorkbenchBrowserSupport; |
| |
| /** |
| * @author Mik Kersten |
| * @author Steffen Pingel |
| */ |
| @SuppressWarnings("restriction") |
| public class WorkbenchUtil { |
| |
| /** |
| * Return the modal shell that is currently open. If there isn't one then return null. |
| * <p> |
| * <b>Note: Applied from patch on bug 99472.</b> |
| * |
| * @return Shell. |
| */ |
| private static Optional<Shell> getModalShell() { |
| IWorkbench workbench = PlatformUI.getWorkbench(); |
| Shell[] shells = workbench.getDisplay().getShells(); |
| int modal = SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL | SWT.PRIMARY_MODAL; |
| return stream(shells).filter(shell -> shell.isVisible() && (shell.getStyle() & modal) != 0).findFirst(); |
| } |
| |
| /** |
| * Utility method to get the best parenting possible for a dialog. If there is a modal shell create it so as to |
| * avoid two modal dialogs. If not then return the shell of the active workbench window. If neither can be found |
| * return null. |
| * <p> |
| * <b>Note: Applied from patch on bug 99472.</b> |
| * |
| * @return Shell or <code>null</code> |
| */ |
| public static Shell getShell() { |
| if (!PlatformUI.isWorkbenchRunning() || PlatformUI.getWorkbench().isClosing()) { |
| return null; |
| } |
| return getModalShell().orElse(getNonModalShell().orElse(null)); |
| } |
| |
| /** |
| * Get the active non modal shell. If there isn't one return null. |
| * <p> |
| * <b>Note: Applied from patch on bug 99472.</b> |
| * |
| * @return Shell |
| */ |
| private static Optional<Shell> getNonModalShell() { |
| IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); |
| if (window == null) { |
| IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows(); |
| if (windows.length > 0) { |
| return Optional.of(windows[0].getShell()); |
| } |
| } else { |
| return Optional.of(window.getShell()); |
| } |
| |
| return Optional.empty(); |
| } |
| |
| /** |
| * @return whether the UI is set up to filter contributions (has defined activity categories). |
| */ |
| public static final boolean isFiltering() { |
| return !PlatformUI.getWorkbench().getActivitySupport().getActivityManager().getDefinedActivityIds().isEmpty(); |
| } |
| |
| public static boolean allowUseOf(Object object) { |
| if (!isFiltering()) { |
| return true; |
| } |
| if (object instanceof IPluginContribution) { |
| IPluginContribution contribution = (IPluginContribution) object; |
| if (contribution.getPluginId() != null) { |
| IWorkbenchActivitySupport workbenchActivitySupport = PlatformUI.getWorkbench().getActivitySupport(); |
| IIdentifier identifier = workbenchActivitySupport.getActivityManager().getIdentifier(createUnifiedId(contribution)); |
| return identifier.isEnabled(); |
| } |
| } |
| if (object instanceof String) { |
| IWorkbenchActivitySupport workbenchActivitySupport = PlatformUI.getWorkbench().getActivitySupport(); |
| IIdentifier identifier = workbenchActivitySupport.getActivityManager().getIdentifier((String) object); |
| return identifier.isEnabled(); |
| } |
| return true; |
| } |
| |
| private static final String createUnifiedId(IPluginContribution contribution) { |
| if (contribution.getPluginId() != null) { |
| return contribution.getPluginId() + '/' + contribution.getLocalId(); |
| } |
| return contribution.getLocalId(); |
| } |
| |
| /** |
| * Opens <code>location</code> in a web-browser according to the Eclipse workbench preferences. |
| * |
| * @param location |
| * the url to open |
| * @see #openUrl(String, int) |
| */ |
| public static void openUrl(String location) { |
| openUrl(location, SWT.NONE); |
| } |
| |
| /** |
| * Opens <code>location</code> in a web-browser according to the Eclipse workbench preferences. |
| * |
| * @param location |
| * the url to open |
| * @param customFlags |
| * additional flags that are passed to {@link IWorkbenchBrowserSupport}, pass |
| * {@link IWorkbenchBrowserSupport#AS_EXTERNAL} to force opening external browser |
| */ |
| public static void openUrl(String location, int customFlags) { |
| try { |
| URL url = null; |
| if (location != null) { |
| url = new URL(location); |
| } |
| if (WebBrowserPreference.getBrowserChoice() == WebBrowserPreference.EXTERNAL || (customFlags & IWorkbenchBrowserSupport.AS_EXTERNAL) != 0) { |
| try { |
| IWorkbenchBrowserSupport support = PlatformUI.getWorkbench().getBrowserSupport(); |
| support.getExternalBrowser().openURL(url); |
| } catch (PartInitException e) { |
| Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN, Messages.WorkbenchUtil_Browser_Initialization_Failed); |
| MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage()); |
| } |
| } else { |
| IWebBrowser browser = null; |
| int flags = customFlags; |
| if (WorkbenchBrowserSupport.getInstance().isInternalWebBrowserAvailable()) { |
| flags |= IWorkbenchBrowserSupport.AS_EDITOR | IWorkbenchBrowserSupport.LOCATION_BAR | IWorkbenchBrowserSupport.NAVIGATION_BAR; |
| } else { |
| flags |= IWorkbenchBrowserSupport.AS_EXTERNAL | IWorkbenchBrowserSupport.LOCATION_BAR | IWorkbenchBrowserSupport.NAVIGATION_BAR; |
| } |
| |
| String generatedId = "org.eclipse.mylyn.web.browser-" + Calendar.getInstance().getTimeInMillis(); //$NON-NLS-1$ |
| browser = WorkbenchBrowserSupport.getInstance().createBrowser(flags, generatedId, null, null); |
| browser.openURL(url); |
| } |
| } catch (PartInitException e) { |
| Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN, Messages.WorkbenchUtil_Browser_Initialization_Failed, e); |
| LogHelper.log(status); |
| MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage()); |
| } catch (MalformedURLException e) { |
| if (location != null && location.trim().equals("")) { //$NON-NLS-1$ |
| Status status = new Status(IStatus.WARNING, DiscoveryUi.ID_PLUGIN, Messages.WorkbenchUtil_No_URL_Error, e); |
| MessageDialog.openWarning(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage()); |
| } else { |
| Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN, NLS.bind(Messages.WorkbenchUtil_Invalid_URL_Error, location), e); |
| MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage()); |
| } |
| } |
| } |
| |
| } |