[icedtea-web] RFC: allow alternate means of finding browsers
Dr Andrew John Hughes
ahughes at redhat.com
Wed Dec 22 12:42:58 PST 2010
On 15:32 Wed 22 Dec , Omair Majid wrote:
> Hi,
>
> The attached patch allows netx to use a browser based on the BROWSER env
> variable or using xdg-open, as opposed to relying on user-supplied
> browser command.
>
> A new configuration option deployment.browser.source is used to
> determine where to find the browser. If it is set to "PATH" (the
> default), the configuration option deployment.browser.path is used. If
> deployment.browser.source is set to "ENV" then the $BROWSER environment
> variable is used. If deployment.browser.source is set to "XDG" then the
> program xdg-open is used to launch the browser.
>
I would make XDG the default so it works like other applications on the system
(which I presume use either this or $BROWSER) if deployment.browser.path is not set.
Then NetX automatically picks up the system browser rather than prompting.
Shouldn't we do some basic sanity checks on the contents of getEnv? (And path too
if we don't already)
> To remain compatible with other implementations, this option is only
> used when deployment.browser.path is null.
>
> ChangeLog:
> 2010-12-22 Omair Majid <omajid at redhat.com>
>
> * netx/net/sourceforge/jnlp/config/Defaults.java
> (getDefaults): Add new option.
> * netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java:
> Add new constants BROWSER_FROM_PATH, BROWSER_FROM_ENV,
> BROWSER_FROM_FREEDESKTOP. Add new key KEY_BROWSER_SOURCE.
> * netx/net/sourceforge/jnlp/controlpanel/BrowserPanel.java: New
> file. Implements a panel to display the browser selection.
> * netx/net/sourceforge/jnlp/controlpanel/ComboItem.java: Make text
> private.
> * netx/net/sourceforge/jnlp/controlpanel/ControlPanel.java
> (createMainSettingsPanel): Add new browser tab.
> (createBrowserPanel): New method. Creates a JPanel to configure the
> browser.
> * netx/net/sourceforge/jnlp/resources/Messages.properties: Add
> CPTabBrowser, BPBrowser, BPBrowserEnv, BPBrowserFreeDesktop,
> and BPBrowserPath.
> * netx/net/sourceforge/jnlp/services/XBasicService.java
> (initialize): If command is null use configuration to find out
> whether the hardcoded path, or $BROWSER or xdg-open should be used.
>
> Any thoughts or comments?
>
> Cheers,
> Omair
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/config/Defaults.java
> --- a/netx/net/sourceforge/jnlp/config/Defaults.java Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/config/Defaults.java Wed Dec 22 15:32:05 2010 -0500
> @@ -369,6 +369,16 @@
> },
> /* browser selection */
> {
> + DeploymentConfiguration.KEY_BROWSER_SOURCE,
> + BasicValueValidators.getStringValidator(new String[] {
> + DeploymentConfiguration.BROWSER_FROM_PATH,
> + DeploymentConfiguration.BROWSER_FROM_ENV,
> + DeploymentConfiguration.BROWSER_FROM_FREEDESKTOP,
> +
> + }),
> + DeploymentConfiguration.BROWSER_FROM_PATH,
> + },
> + {
> DeploymentConfiguration.KEY_BROWSER_PATH,
> BasicValueValidators.getFilePathValidator(),
> null
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java
> --- a/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java Wed Dec 22 15:32:05 2010 -0500
> @@ -58,6 +58,10 @@
> public static final int JNLP_ASSOCIATION_ASK_USER = 2;
> public static final int JNLP_ASSOCIATION_REPLACE_ASK = 3;
>
> + public static final String BROWSER_FROM_PATH = "PATH";
> + public static final String BROWSER_FROM_ENV = "ENV";
> + public static final String BROWSER_FROM_FREEDESKTOP = "XDG";
> +
> /*
> * FIXME these should be moved into JavaConsole, but there is a strange
> * dependency in the build system. First all of netx is built. Then the
> @@ -152,6 +156,17 @@
> public static final String KEY_JRE_INTSTALL_URL = "deployment.javaws.installURL";
> public static final String KEY_AUTO_DOWNLOAD_JRE = "deployment.javaws.autodownload";
>
> + /**
> + * This is a new option that is not supported by other implementations.
> + * To maintain compatibility with other implementations, this should only
> + * be used when the browser path is null. Possible Values:
> + * <dl>
> + * <dt>0</dt><dd>use KEY_BROWSER_PATH</dd>
> + * <dt>1</dt><dd>use environment variable BROWSER</dd>
> + * <dt>2</dt><dd>use xdg-open</dd>
> + * </d>
> + */
> + public static final String KEY_BROWSER_SOURCE = "deployment.browser.source";
> public static final String KEY_BROWSER_PATH = "deployment.browser.path";
> public static final String KEY_UPDATE_TIMEOUT = "deployment.javaws.update.timeout";
>
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/controlpanel/BrowserPanel.java
> --- /dev/null Thu Jan 01 00:00:00 1970 +0000
> +++ b/netx/net/sourceforge/jnlp/controlpanel/BrowserPanel.java Wed Dec 22 15:32:05 2010 -0500
> @@ -0,0 +1,152 @@
> +/* BrowserPanel.java -- A panel to allow the user to select browser
> +Copyright (C) 2010 Red Hat
> +
> +This program is free software; you can redistribute it and/or modify
> +it under the terms of the GNU General Public License as published by
> +the Free Software Foundation; either version 2 of the License, or
> +(at your option) any later version.
> +
> +This program is distributed in the hope that it will be useful, but
> +WITHOUT ANY WARRANTY; without even the implied warranty of
> +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +General Public License for more details.
> +
> +You should have received a copy of the GNU General Public License
> +along with this program; if not, write to the Free Software
> +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
> +*/
> +
> +package net.sourceforge.jnlp.controlpanel;
> +
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> +import java.awt.BorderLayout;
> +import java.awt.Component;
> +import java.awt.Dimension;
> +import java.awt.GridBagConstraints;
> +import java.awt.GridBagLayout;
> +import java.awt.event.ActionEvent;
> +import java.awt.event.ActionListener;
> +
> +import javax.swing.BorderFactory;
> +import javax.swing.Box;
> +import javax.swing.ButtonGroup;
> +import javax.swing.Icon;
> +import javax.swing.JPanel;
> +import javax.swing.JRadioButton;
> +import javax.swing.JTextField;
> +import javax.swing.UIManager;
> +
> +import net.sourceforge.jnlp.config.DeploymentConfiguration;
> +
> +/**
> + * A JPanel that allows configuring the browser settings:
> + * {@link DeploymentConfiguration#KEY_BROWSER_PATH} and
> + * {@link DeploymentConfiguration#KEY_BROWSER_SOURCE}
> + */
> +public class BrowserPanel extends NamedBorderPanel {
> +
> + private DeploymentConfiguration config;
> +
> + private JTextField browserLocation;
> + private ButtonGroup browserSourceButtonGroup;
> + private JRadioButton[] radioButtons;
> + private ActionListener browserRadioListener;
> +
> + BrowserPanel(DeploymentConfiguration config) {
> + super(R("BPBrowser"), new GridBagLayout());
> + this.config = config;
> +
> + initializeComponents();
> + addComponents();
> + }
> +
> + /**
> + * Initialize all the components
> + */
> + private void initializeComponents() {
> + final int BROWSER_LOCATION_WIDTH = 30;
> +
> + browserLocation = new JTextField(BROWSER_LOCATION_WIDTH);
> + browserLocation.setText(config.getProperty(DeploymentConfiguration.KEY_BROWSER_PATH));
> + browserLocation.getDocument().addDocumentListener(
> + new DocumentAdapter(config, DeploymentConfiguration.KEY_BROWSER_PATH));
> +
> + browserSourceButtonGroup = new ButtonGroup();
> +
> + ComboItem[] radioData = new ComboItem[] {
> + new ComboItem(R("BPBrowserPath"), DeploymentConfiguration.BROWSER_FROM_PATH),
> + new ComboItem(R("BPBrowserEnv"), DeploymentConfiguration.BROWSER_FROM_ENV),
> + new ComboItem(R("BPBrowserFreeDesktop"), DeploymentConfiguration.BROWSER_FROM_FREEDESKTOP),
> + };
> +
> + browserRadioListener = new ActionListener() {
> + @Override
> + public void actionPerformed(ActionEvent e) {
> + JRadioButton b = (JRadioButton) e.getSource();
> + String command = b.getActionCommand();
> + config.setProperty(DeploymentConfiguration.KEY_BROWSER_SOURCE, b.getActionCommand());
> + if (command.equals(DeploymentConfiguration.BROWSER_FROM_PATH)) {
> + browserLocation.setEnabled(true);
> + } else {
> + config.setProperty(DeploymentConfiguration.KEY_BROWSER_PATH, null);
> + browserLocation.setEnabled(false);
> + }
> + }
> + };
> +
> + radioButtons = new JRadioButton[radioData.length];
> + JRadioButton rb = null;
> + for (int i = 0; i < radioData.length; i++) {
> + rb = new JRadioButton();
> + rb.setText(radioData[i].toString());
> + rb.setActionCommand(radioData[i].getValue());
> + rb.addActionListener(browserRadioListener);
> + browserSourceButtonGroup.add(rb);
> + if (config.getProperty(DeploymentConfiguration.KEY_BROWSER_SOURCE).equals(radioData[i].getValue())) {
> + rb.doClick();
> + }
> +
> + radioButtons[i] = rb;
> + }
> +
> + }
> +
> + /**
> + * Layout the components on the panel
> + */
> + private void addComponents() {
> + GridBagConstraints c = new GridBagConstraints();
> +
> + c.anchor = GridBagConstraints.FIRST_LINE_START;
> + c.fill = GridBagConstraints.BOTH;
> + c.gridx = -1;
> + c.gridy = 0;
> + c.weighty = 0;
> + c.weightx = 1;
> +
> + for (int i = 0; i < radioButtons.length; i++) {
> + JRadioButton rb = radioButtons[i];
> + c.gridy++;
> + add(rb, c);
> + if (rb.getActionCommand().equals(DeploymentConfiguration.BROWSER_FROM_PATH)) {
> + c.gridy++;
> + c.fill = GridBagConstraints.VERTICAL;
> + JPanel browserLocationContainer = new JPanel();
> + Icon icon = UIManager.getIcon("RadioButton.icon");
> + int width = icon.getIconWidth() + rb.getIconTextGap();
> + browserLocationContainer.setBorder(BorderFactory.createEmptyBorder(0, width, 0, 0));
> + browserLocationContainer.add(browserLocation, BorderLayout.LINE_START);
> + add(browserLocationContainer, c);
> + c.fill = GridBagConstraints.BOTH;
> + }
> +
> + }
> +
> + // pack the bottom so that it doesn't change size if resized.
> + Component filler = Box.createRigidArea(new Dimension(1, 1));
> + c.gridy++;
> + c.weighty = 1;
> + add(filler, c);
> + }
> +}
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/controlpanel/ComboItem.java
> --- a/netx/net/sourceforge/jnlp/controlpanel/ComboItem.java Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/controlpanel/ComboItem.java Wed Dec 22 15:32:05 2010 -0500
> @@ -26,7 +26,7 @@
> *
> */
> public class ComboItem {
> - String text = null;
> + private String text = null;
> private String value; // Value to be compared with.
>
> /**
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/controlpanel/ControlPanel.java
> --- a/netx/net/sourceforge/jnlp/controlpanel/ControlPanel.java Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/controlpanel/ControlPanel.java Wed Dec 22 15:32:05 2010 -0500
> @@ -225,7 +225,9 @@
>
> loadConfiguration();
>
> - SettingsPanel[] panels = new SettingsPanel[] { new SettingsPanel(Translator.R("CPTabAbout"), createAboutPanel()),
> + SettingsPanel[] panels = new SettingsPanel[] {
> + new SettingsPanel(Translator.R("CPTabAbout"), createAboutPanel()),
> + new SettingsPanel(Translator.R("CPTabBrowser"), createBrowserPanel()),
> new SettingsPanel(Translator.R("CPTabCache"), createCacheSettingsPanel()),
> new SettingsPanel(Translator.R("CPTabCertificate"), createCertificatesSettingsPanel()),
> // new SettingsPanel(Translator.R("CPTabClassLoader"), createClassLoaderSettingsPanel()),
> @@ -275,6 +277,10 @@
> return new AboutPanel();
> }
>
> + private JPanel createBrowserPanel() {
> + return new BrowserPanel(config);
> + }
> +
> private JPanel createCacheSettingsPanel() {
> return new TemporaryInternetFilesPanel(this.config);
> }
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/resources/Messages.properties
> --- a/netx/net/sourceforge/jnlp/resources/Messages.properties Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/resources/Messages.properties Wed Dec 22 15:32:05 2010 -0500
> @@ -284,7 +284,8 @@
> CPHeadSecurity=Security Settings
>
> # Control Panel - Tabs
> -CPTabAbout=About IcedTea-Web
> +CPTabAbout=About IcedTea-Web
> +CPTabBrowser=Browser
> CPTabCache=Cache
> CPTabCertificate=Certificates
> CPTabClassLoader=Class Loaders
> @@ -311,6 +312,12 @@
> APSExceptionsLabel=Exceptions
> APSExceptionsDescription=Do not use proxy server for addresses beginning with
> APSExceptionInstruction=Separate each entry with a semicolon.
> +
> +# Control Panel - BrowserPanel
> +BPBrowser=Select Browser
> +BPBrowserEnv=Use $BROWSER environment variable
> +BPBrowserFreeDesktop=Use the desktop standard browser (uses xdg-open)
> +BPBrowserPath=Custom. Enter browser command:
>
> # Control Panel - DebugginPanel
> DPEnableTracing=Enable tracing
> diff -r 7ddab63cf8fe netx/net/sourceforge/jnlp/services/XBasicService.java
> --- a/netx/net/sourceforge/jnlp/services/XBasicService.java Tue Dec 21 16:48:12 2010 -0500
> +++ b/netx/net/sourceforge/jnlp/services/XBasicService.java Wed Dec 22 15:32:05 2010 -0500
> @@ -199,15 +199,22 @@
> command = config.getProperty(DeploymentConfiguration.KEY_BROWSER_PATH);
>
> if (command == null) { // prompt & store
> - command = promptForCommand(null);
> + String browserSelection = config.getProperty(DeploymentConfiguration.KEY_BROWSER_SOURCE);
> + if (browserSelection.equals(DeploymentConfiguration.BROWSER_FROM_PATH)) {
> + command = promptForCommand(null);
>
> - if (command != null) {
> - config.setProperty(DeploymentConfiguration.KEY_BROWSER_PATH, command);
> - try {
> - config.save();
> - } catch (IOException e) {
> - e.printStackTrace();
> + if (command != null) {
> + config.setProperty(DeploymentConfiguration.KEY_BROWSER_PATH, command);
> + try {
> + config.save();
> + } catch (IOException e) {
> + e.printStackTrace();
> + }
> }
> + } else if (browserSelection.equals(DeploymentConfiguration.BROWSER_FROM_ENV)) {
> + command = System.getenv("BROWSER");
> + } else if (browserSelection.equals(DeploymentConfiguration.BROWSER_FROM_FREEDESKTOP)) {
> + command = "xdg-open";
> }
> }
> }
--
Andrew :)
Free Java Software Engineer
Red Hat, Inc. (http://www.redhat.com)
Support Free Java!
Contribute to GNU Classpath and IcedTea
http://www.gnu.org/software/classpath
http://icedtea.classpath.org
PGP Key: 94EFD9D8 (http://subkeys.pgp.net)
Fingerprint = F8EF F1EA 401E 2E60 15FA 7927 142C 2591 94EF D9D8
More information about the distro-pkg-dev
mailing list