src/com/owncloud/android/authenticator/AccountAuthenticator.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012  Bartek Przybylski
   3  *
   4  *   This program is free software: you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation, either version 3 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18
  19 package com.owncloud.android.authenticator;
  20
  21 import com.owncloud.android.ui.activity.AuthenticatorActivity;
  22
  23 import android.accounts.*;
  24 import android.content.Context;
  25 import android.content.Intent;
  26 import android.os.Bundle;
  27 import android.util.Log;
  28
  29 public class AccountAuthenticator extends AbstractAccountAuthenticator {
  30     /**
  31      * Is used by android system to assign accounts to authenticators. Should be
  32      * used by application and all extensions.
  33      */
  34     public static final String ACCOUNT_TYPE = "owncloud";
  35     public static final String AUTHORITY = "org.owncloud";
  36     public static final String AUTH_TOKEN_TYPE = "org.owncloud";
  37     public static final String AUTH_TOKEN_TYPE_PASSWORD = "owncloud.password";
  38     public static final String AUTH_TOKEN_TYPE_ACCESS_TOKEN = "owncloud.oauth2.access_token";
  39     public static final String AUTH_TOKEN_TYPE_REFRESH_TOKEN = "owncloud.oauth2.refresh_token";
  40
  41     public static final String KEY_AUTH_TOKEN_TYPE = "authTokenType";
  42     public static final String KEY_REQUIRED_FEATURES = "requiredFeatures";
  43     public static final String KEY_LOGIN_OPTIONS = "loginOptions";
  44     public static final String KEY_ACCOUNT = "account";
  45     /**
  46      * Value under this key should handle path to webdav php script. Will be
  47      * removed and usage should be replaced by combining
  48      * {@link com.owncloud.android.authenticator.AuthenticatorActivity.KEY_OC_BASE_URL} and
  49      * {@link com.owncloud.android.utils.OwnCloudVersion}
  50      *
  51      * @deprecated
  52      */
  53     public static final String KEY_OC_URL = "oc_url";
  54     /**
  55      * Version should be 3 numbers separated by dot so it can be parsed by
  56      * {@link com.owncloud.android.utils.OwnCloudVersion}
  57      */
  58     public static final String KEY_OC_VERSION = "oc_version";
  59     /**
  60      * Base url should point to owncloud installation without trailing / ie:
  61      * http://server/path or https://owncloud.server
  62      */
  63     public static final String KEY_OC_BASE_URL = "oc_base_url";
  64     /**
  65      * Flag signaling if the ownCloud server can be accessed with OAuth2 access tokens.
  66      */
  67     public static final String KEY_SUPPORTS_OAUTH2 = "oc_supports_oauth2";
  68
  69     private static final String TAG = AccountAuthenticator.class.getSimpleName();
  70
  71     private Context mContext;
  72
  73     public AccountAuthenticator(Context context) {
  74         super(context);
  75         mContext = context;
  76     }
  77
  78     /**
  79      * {@inheritDoc}
  80      */
  81     @Override
  82     public Bundle addAccount(AccountAuthenticatorResponse response,
  83             String accountType, String authTokenType,
  84             String[] requiredFeatures, Bundle options)
  85             throws NetworkErrorException {
  86         Log.i(TAG, "Adding account with type " + accountType
  87                 + " and auth token " + authTokenType);
  88         try {
  89             validateAccountType(accountType);
  90         } catch (AuthenticatorException e) {
  91             Log.e(TAG, "Failed to validate account type " + accountType + ": "
  92                     + e.getMessage());
  93             e.printStackTrace();
  94             return e.getFailureBundle();
  95         }
  96         final Intent intent = new Intent(mContext, AuthenticatorActivity.class);
  97         intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE, response);
  98         intent.putExtra(KEY_AUTH_TOKEN_TYPE, authTokenType);
  99         intent.putExtra(KEY_REQUIRED_FEATURES, requiredFeatures);
 100         intent.putExtra(KEY_LOGIN_OPTIONS, options);
 101
 102         setIntentFlags(intent);
 103
 104         final Bundle bundle = new Bundle();
 105         bundle.putParcelable(AccountManager.KEY_INTENT, intent);
 106         return bundle;
 107     }
 108
 109     /**
 110      * {@inheritDoc}
 111      */
 112     @Override
 113     public Bundle confirmCredentials(AccountAuthenticatorResponse response,
 114             Account account, Bundle options) throws NetworkErrorException {
 115         try {
 116             validateAccountType(account.type);
 117         } catch (AuthenticatorException e) {
 118             Log.e(TAG, "Failed to validate account type " + account.type + ": "
 119                     + e.getMessage());
 120             e.printStackTrace();
 121             return e.getFailureBundle();
 122         }
 123         Intent intent = new Intent(mContext, AuthenticatorActivity.class);
 124         intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE,
 125                 response);
 126         intent.putExtra(KEY_ACCOUNT, account);
 127         intent.putExtra(KEY_LOGIN_OPTIONS, options);
 128
 129         setIntentFlags(intent);
 130
 131         Bundle resultBundle = new Bundle();
 132         resultBundle.putParcelable(AccountManager.KEY_INTENT, intent);
 133         return resultBundle;
 134     }
 135
 136     @Override
 137     public Bundle editProperties(AccountAuthenticatorResponse response,
 138             String accountType) {
 139         return null;
 140     }
 141
 142     /**
 143      * {@inheritDoc}
 144      */
 145     @Override
 146     public Bundle getAuthToken(AccountAuthenticatorResponse response,
 147             Account account, String authTokenType, Bundle options)
 148             throws NetworkErrorException {
 149         /// validate parameters
 150         try {
 151             validateAccountType(account.type);
 152             validateAuthTokenType(authTokenType);
 153         } catch (AuthenticatorException e) {
 154             Log.e(TAG, "Failed to validate account type " + account.type + ": "
 155                     + e.getMessage());
 156             e.printStackTrace();
 157             return e.getFailureBundle();
 158         }
 159
 160         /// check if required token is stored
 161         final AccountManager am = AccountManager.get(mContext);
 162         String accessToken;
 163         if (authTokenType.equals(AUTH_TOKEN_TYPE_PASSWORD)) {
 164             accessToken = am.getPassword(account);
 165         } else {
 166             accessToken = am.peekAuthToken(account, authTokenType);
 167         }
 168         if (accessToken != null) {
 169             final Bundle result = new Bundle();
 170             result.putString(AccountManager.KEY_ACCOUNT_NAME, account.name);
 171             result.putString(AccountManager.KEY_ACCOUNT_TYPE, ACCOUNT_TYPE);
 172             result.putString(AccountManager.KEY_AUTHTOKEN, accessToken);
 173             return result;
 174         }
 175
 176         /// if not stored, return Intent to access the AuthenticatorActivity
 177         final Intent intent = new Intent(mContext, AuthenticatorActivity.class);
 178         intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE, response);
 179         intent.putExtra(KEY_AUTH_TOKEN_TYPE, authTokenType);
 180         intent.putExtra(KEY_LOGIN_OPTIONS, options);
 181         intent.putExtra(AuthenticatorActivity.EXTRA_ACCOUNT, account);
 182
 183         final Bundle bundle = new Bundle();
 184         bundle.putParcelable(AccountManager.KEY_INTENT, intent);
 185         return bundle;
 186     }
 187
 188     @Override
 189     public String getAuthTokenLabel(String authTokenType) {
 190         return null;
 191     }
 192
 193     @Override
 194     public Bundle hasFeatures(AccountAuthenticatorResponse response,
 195             Account account, String[] features) throws NetworkErrorException {
 196         final Bundle result = new Bundle();
 197         result.putBoolean(AccountManager.KEY_BOOLEAN_RESULT, false);
 198         return result;
 199     }
 200
 201     @Override
 202     public Bundle updateCredentials(AccountAuthenticatorResponse response,
 203             Account account, String authTokenType, Bundle options)
 204             throws NetworkErrorException {
 205         final Intent intent = new Intent(mContext, AuthenticatorActivity.class);
 206         intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE,
 207                 response);
 208         intent.putExtra(KEY_ACCOUNT, account);
 209         intent.putExtra(KEY_AUTH_TOKEN_TYPE, authTokenType);
 210         intent.putExtra(KEY_LOGIN_OPTIONS, options);
 211         setIntentFlags(intent);
 212
 213         final Bundle bundle = new Bundle();
 214         bundle.putParcelable(AccountManager.KEY_INTENT, intent);
 215         return bundle;
 216     }
 217
 218     @Override
 219     public Bundle getAccountRemovalAllowed(
 220             AccountAuthenticatorResponse response, Account account)
 221             throws NetworkErrorException {
 222         return super.getAccountRemovalAllowed(response, account);
 223     }
 224
 225     private void setIntentFlags(Intent intent) {
 226         intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 227         intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
 228         intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY); // incompatible with the authorization code grant in OAuth
 229         intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 230         intent.addFlags(Intent.FLAG_FROM_BACKGROUND);
 231     }
 232
 233     private void validateAccountType(String type)
 234             throws UnsupportedAccountTypeException {
 235         if (!type.equals(ACCOUNT_TYPE)) {
 236             throw new UnsupportedAccountTypeException();
 237         }
 238     }
 239
 240     private void validateAuthTokenType(String authTokenType)
 241             throws UnsupportedAuthTokenTypeException {
 242         if (!authTokenType.equals(AUTH_TOKEN_TYPE) &&
 243             !authTokenType.equals(AUTH_TOKEN_TYPE_PASSWORD) &&
 244             !authTokenType.equals(AUTH_TOKEN_TYPE_ACCESS_TOKEN) &&
 245             !authTokenType.equals(AUTH_TOKEN_TYPE_REFRESH_TOKEN) ) {
 246             throw new UnsupportedAuthTokenTypeException();
 247         }
 248     }
 249
 250     public static class AuthenticatorException extends Exception {
 251         private static final long serialVersionUID = 1L;
 252         private Bundle mFailureBundle;
 253
 254         public AuthenticatorException(int code, String errorMsg) {
 255             mFailureBundle = new Bundle();
 256             mFailureBundle.putInt(AccountManager.KEY_ERROR_CODE, code);
 257             mFailureBundle
 258                     .putString(AccountManager.KEY_ERROR_MESSAGE, errorMsg);
 259         }
 260
 261         public Bundle getFailureBundle() {
 262             return mFailureBundle;
 263         }
 264     }
 265
 266     public static class UnsupportedAccountTypeException extends
 267             AuthenticatorException {
 268         private static final long serialVersionUID = 1L;
 269
 270         public UnsupportedAccountTypeException() {
 271             super(AccountManager.ERROR_CODE_UNSUPPORTED_OPERATION,
 272                     "Unsupported account type");
 273         }
 274     }
 275
 276     public static class UnsupportedAuthTokenTypeException extends
 277             AuthenticatorException {
 278         private static final long serialVersionUID = 1L;
 279
 280         public UnsupportedAuthTokenTypeException() {
 281             super(AccountManager.ERROR_CODE_UNSUPPORTED_OPERATION,
 282                     "Unsupported auth token type");
 283         }
 284     }
 285
 286     public static class UnsupportedFeaturesException extends
 287             AuthenticatorException {
 288         public static final long serialVersionUID = 1L;
 289
 290         public UnsupportedFeaturesException() {
 291             super(AccountManager.ERROR_CODE_UNSUPPORTED_OPERATION,
 292                     "Unsupported features");
 293         }
 294     }
 295
 296     public static class AccessDeniedException extends AuthenticatorException {
 297         public AccessDeniedException(int code, String errorMsg) {
 298             super(AccountManager.ERROR_CODE_INVALID_RESPONSE, "Access Denied");
 299         }
 300
 301         private static final long serialVersionUID = 1L;
 302
 303     }
 304 }