Android Open Source - utexas-utilities Auth Cookie

• Back to Development/webservice  ↑

From Project

Back to project page utexas-utilities.

License

The source code is released under:

Apache License

Java Source Code

package com.nasageek.utexasutilities;
/*  www .j  av a2 s  .c  om*/
import android.content.Context;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;

import com.squareup.okhttp.FormEncodingBuilder;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.RequestBody;
import com.squareup.okhttp.Response;

import java.io.IOException;
import java.net.CookieHandler;
import java.net.CookieManager;
import java.net.CookieStore;
import java.net.HttpCookie;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * Created by Chris on 7/4/2014.
 */
public class AuthCookie {

    protected String prefKey;
    protected String authCookie;
    protected String authCookieKey;
    protected String userNameKey;
    protected String passwordKey;
    protected boolean cookieHasBeenSet;
    protected OkHttpClient client;
    protected SharedPreferences settings;
    protected SecurePreferences secureSettings;
    protected URL url;


    public AuthCookie(String prefKey, String authCookieKey, String loginUrl, String userNameKey,
                      String passwordKey, Context con) {
        this.prefKey = prefKey;
        this.authCookieKey = authCookieKey;
        this.userNameKey = userNameKey;
        this.passwordKey = passwordKey;
        try {
            this.url = new URL(loginUrl);
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
        this.client = new OkHttpClient();
        this.client.setConnectTimeout(10, TimeUnit.SECONDS);
        this.secureSettings = new SecurePreferences(con, "com.nasageek.utexasutilities.password",
                false);
        this.settings = PreferenceManager.getDefaultSharedPreferences(con);
    }

    public boolean hasCookieBeenSet() {
        return cookieHasBeenSet;
    }

    public String getPrefKey() {
        return prefKey;
    }

    public String getAuthCookieKey() {
        return authCookieKey;
    }

    public String getAuthCookieVal() {
        if (cookieHasBeenSet) {
            return authCookie;
        } else if (settings.contains(prefKey)) {
            cookieHasBeenSet = true;
            authCookie = settings.getString(prefKey, "");
            return authCookie;
        } else {
           return null;
        }
    }

    private void resetCookie() {
        settings.edit().remove(prefKey).apply();
        authCookie = "";
        try {
            /*
            This step is *required* for PNA, and nicety for other services. PNA won't let you
            log in if you're still holding on to a valid authcookie, so we clear them out.
             */
            URI loginURI = URI.create(url.getHost());
            CookieStore cookies = ((CookieManager) CookieHandler.getDefault()).getCookieStore();
            for (HttpCookie cookie : cookies.get(loginURI)) {
                cookies.remove(loginURI, cookie);
            }
        } catch (IllegalArgumentException e) {
            e.printStackTrace();
        }
        cookieHasBeenSet = false;
    }

    public void setAuthCookieVal(String authCookie) {
        this.authCookie = authCookie;
        settings.edit().putString(prefKey, authCookie).apply();

        /*
        this is technically unnecessary if OkHttp handled the authentication, because it will
        have already set the cookies in the CookieHandler. It doesn't seem to cause any issues
        just to re-add the cookies, though
         */
        HttpCookie httpCookie = new HttpCookie(authCookieKey, authCookie);
        httpCookie.setDomain(url.getHost());
        // this is required for PNA login and does not appear to affect other services
        httpCookie.setVersion(0);
        try {
            CookieStore cookies = ((CookieManager) CookieHandler.getDefault()).getCookieStore();
            cookies.add(URI.create(url.getHost()), httpCookie);
        } catch (IllegalArgumentException e) {
            e.printStackTrace();
        }
        cookieHasBeenSet = true;
    }

    /**
     * Builds a login request and executes it to produce a valid AuthCookie.
     * @return true if the cookie was set successfully, false if the cookie was not set
     * @throws IOException
     * @throws com.nasageek.utexasutilities.TempLoginException if persistent login is
     * not activated
     */
    public boolean login() throws IOException {
        if (!settings.getBoolean("loginpref", false)) {
            throw new TempLoginException("login() cannot be called when persistent login" +
                    " is turned off.");
        }
        Request request = buildLoginRequest();
        return performLogin(request);
    }

    /**
     * Executes a login request with the AuthCookie's OkHttpClient. This should only be called
     * when persistent login is activated.
     * @param request Request to execute
     * @return true if the cookie was set successfully, false if the cookie was not set
     * @throws IOException
     */
    protected boolean performLogin(Request request) throws IOException {
        Response response = client.newCall(request).execute();
        if (!response.isSuccessful()) {
            throw new IOException("Bad response code: " + response + " during login.");
        }
        CookieManager cm = (CookieManager) CookieHandler.getDefault();
        List<HttpCookie> cookies = cm.getCookieStore().getCookies();
        for (HttpCookie cookie : cookies) {
            // special case for UTD login since I'm too lazy to subclass it
            String cookieVal = cookie.getValue();
            if (cookie.getName().equals(authCookieKey) && !cookieVal.equals("NONE")) {
                setAuthCookieVal(cookieVal);
                return true;
            }
        }
        return false;
    }

    protected Request buildLoginRequest() {
        String user = settings.getString("eid", "error");
        String pw = secureSettings.getString("password");

        RequestBody requestBody = new FormEncodingBuilder()
                .add(userNameKey, user)
                .add(passwordKey, pw)
                .build();
        Request request = new Request.Builder()
                .url(url)
                .post(requestBody)
                .build();
        return request;
    }

    public void logout() {
        resetCookie();
    }
}

Java Source Code List

• Back to Development/webservice  ↑