org.github.oauth2.OAuth2BrowserDialog.java Source code

Introduction

Here is the source code for org.github.oauth2.OAuth2BrowserDialog.java

Source

/******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *****************************************************************************/
package org.github.oauth2;

import java.net.URI;
import java.net.URISyntaxException;
import java.util.List;

import org.apache.http.NameValuePair;
import org.apache.http.client.utils.URLEncodedUtils;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.browser.Browser;
import org.eclipse.swt.browser.LocationAdapter;
import org.eclipse.swt.browser.LocationEvent;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.PlatformUI;

/**
 * Dialog to display authorization page for an OAuth2 request
 */
public class OAuth2BrowserDialog extends Dialog {

    /**
     * Get code for client
     * 
     * @param client
     * @return code
     */
    public static String getCode(final OAuth2Client client) {
        return getCode(client, null);
    }

    /**
     * Get code for client and scope
     * 
     * @param client
     * @param scope
     * @return code
     */
    public static String getCode(final OAuth2Client client, final String scope) {
        return getCode(client, scope, PlatformUI.getWorkbench().getDisplay().getActiveShell());
    }

    /**
     * Get code for client, scope, and shell
     * 
     * @param client
     * @param scope
     * @param shell
     * @return code
     */
    public static String getCode(final OAuth2Client client, final String scope, final Shell shell) {
        String url = OAuth2Utils.getAuthorizeUrl(client, scope);
        OAuth2BrowserDialog dialog = new OAuth2BrowserDialog(shell, url, client.getRedirectUri());
        if (dialog.open() == Window.OK)
            return dialog.getCode();
        return null;
    }

    private final String url;

    private final String redirectUri;

    private final String paramName;

    private String code;

    /**
     * @param shell
     * @param url
     * @param redirectUri
     */
    public OAuth2BrowserDialog(Shell shell, String url, String redirectUri) {
        this(shell, url, IOAuth2Constants.PARAM_CODE, redirectUri);
    }

    @Override
    protected IDialogSettings getDialogBoundsSettings() {
        String sectionName = getClass().getName() + ".dialogBounds"; //$NON-NLS-1$
        IDialogSettings settings = OAuth2Plugin.getDefault().getDialogSettings();
        IDialogSettings section = settings.getSection(sectionName);
        if (section == null)
            section = settings.addNewSection(sectionName);
        return section;
    }

    @Override
    protected boolean isResizable() {
        return true;
    }

    /**
     * @param shell
     * @param url
     * @param parameterName
     * @param redirectUri
     */
    public OAuth2BrowserDialog(Shell shell, String url, String parameterName, String redirectUri) {
        super(shell);
        this.url = url;
        paramName = parameterName;
        this.redirectUri = redirectUri;
    }

    protected Control createDialogArea(Composite parent) {
        Composite control = (Composite) super.createDialogArea(parent);

        Composite displayArea = new Composite(control, SWT.NONE);
        GridLayoutFactory.fillDefaults().applyTo(displayArea);
        GridDataFactory.fillDefaults().hint(600, 400).grab(true, true).applyTo(displayArea);

        Browser browser = new Browser(displayArea, SWT.NONE);
        GridDataFactory.fillDefaults().grab(true, true).applyTo(browser);
        browser.setUrl(url);
        browser.addLocationListener(new LocationAdapter() {

            public void changing(LocationEvent event) {
                if (!event.location.startsWith(redirectUri))
                    return;
                URI uri;
                try {
                    uri = new URI(event.location);
                } catch (URISyntaxException ignored) {
                    return;
                }
                List<NameValuePair> params = URLEncodedUtils.parse(uri, null);
                for (NameValuePair param : params)
                    if (paramName.equals(param.getName())) {
                        code = param.getValue();
                        break;
                    }
                event.doit = false;
                close();
            }
        });
        getShell().setText(Messages.OAuth2BrowserDialog_Title);
        return control;
    }

    /**
     * Get code
     * 
     * @return code
     */
    public String getCode() {
        return code;
    }

    protected void createButtonsForButtonBar(Composite parent) {
        createButton(parent, IDialogConstants.CANCEL_ID, IDialogConstants.CANCEL_LABEL, false);
    }
}