src/com/owncloud/android/authentication/AuthenticatorActivity.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012  Bartek Przybylski
   3  *   Copyright (C) 2012-2013 ownCloud Inc.
   4  *
   5  *   This program is free software: you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation, either version 2 of the License, or
   8  *   (at your option) any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details.
  14  *
  15  *   You should have received a copy of the GNU General Public License
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 package com.owncloud.android.authentication;
  21
  22 import com.owncloud.android.AccountUtils;
  23 import com.owncloud.android.ui.dialog.SslValidatorDialog;
  24 import com.owncloud.android.ui.dialog.SslValidatorDialog.OnSslValidatorListener;
  25 import com.owncloud.android.utils.OwnCloudVersion;
  26 import com.owncloud.android.network.OwnCloudClientUtils;
  27 import com.owncloud.android.operations.OwnCloudServerCheckOperation;
  28 import com.owncloud.android.operations.ExistenceCheckOperation;
  29 import com.owncloud.android.operations.OAuth2GetAccessToken;
  30 import com.owncloud.android.operations.OnRemoteOperationListener;
  31 import com.owncloud.android.operations.RemoteOperation;
  32 import com.owncloud.android.operations.RemoteOperationResult;
  33 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
  34
  35 import android.accounts.Account;
  36 import android.accounts.AccountAuthenticatorActivity;
  37 import android.accounts.AccountManager;
  38 import android.app.AlertDialog;
  39 import android.app.Dialog;
  40 import android.app.ProgressDialog;
  41 import android.content.ContentResolver;
  42 import android.content.DialogInterface;
  43 import android.content.Intent;
  44 import android.content.SharedPreferences;
  45 import android.net.Uri;
  46 import android.os.Bundle;
  47 import android.os.Handler;
  48 import android.preference.PreferenceManager;
  49 import android.text.InputType;
  50 import android.util.Log;
  51 import android.view.View;
  52 import android.view.View.OnFocusChangeListener;
  53 import android.view.Window;
  54 import android.widget.CheckBox;
  55 import android.widget.EditText;
  56 import android.widget.Button;
  57 import android.widget.ImageView;
  58 import android.widget.TextView;
  59 import android.widget.Toast;
  60
  61 import com.owncloud.android.R;
  62
  63 import eu.alefzero.webdav.WebdavClient;
  64
  65 /**
  66  * This Activity is used to add an ownCloud account to the App
  67  *
  68  * @author Bartek Przybylski
  69  * @author David A. Velasco
  70  */
  71 public class AuthenticatorActivity extends AccountAuthenticatorActivity
  72         implements  OnRemoteOperationListener, OnSslValidatorListener, OnFocusChangeListener {
  73
  74     private static final String TAG = AuthenticatorActivity.class.getSimpleName();
  75
  76     public static final String EXTRA_ACCOUNT = "ACCOUNT";
  77     public static final String EXTRA_USER_NAME = "USER_NAME";
  78     public static final String EXTRA_HOST_NAME = "HOST_NAME";
  79     public static final String EXTRA_ACTION = "ACTION";
  80
  81     private static final String KEY_HOST_URL_TEXT = "HOST_URL_TEXT";
  82     private static final String KEY_OC_VERSION = "OC_VERSION";
  83     private static final String KEY_ACCOUNT = "ACCOUNT";
  84     private static final String KEY_STATUS_TEXT = "STATUS_TEXT";
  85     private static final String KEY_STATUS_ICON = "STATUS_ICON";
  86     private static final String KEY_STATUS_CORRECT = "STATUS_CORRECT";
  87     private static final String KEY_IS_SSL_CONN = "IS_SSL_CONN";
  88     private static final String KEY_OAUTH2_STATUS_TEXT = "OAUTH2_STATUS_TEXT";
  89     private static final String KEY_OAUTH2_STATUS_ICON = "OAUTH2_STATUS_ICON";
  90
  91     private static final int DIALOG_LOGIN_PROGRESS = 0;
  92     private static final int DIALOG_SSL_VALIDATOR = 1;
  93     private static final int DIALOG_CERT_NOT_SAVED = 2;
  94     private static final int DIALOG_OAUTH2_LOGIN_PROGRESS = 3;
  95
  96     public static final byte ACTION_CREATE = 0;
  97     public static final byte ACTION_UPDATE_TOKEN = 1;
  98
  99
 100     private String mHostBaseUrl;
 101     private OwnCloudVersion mDiscoveredVersion;
 102
 103     private int mStatusText, mStatusIcon;
 104     private boolean mStatusCorrect, mIsSslConn;
 105     private int mOAuth2StatusText, mOAuth2StatusIcon;
 106
 107     private final Handler mHandler = new Handler();
 108     private Thread mOperationThread;
 109     private OwnCloudServerCheckOperation mOcServerChkOperation;
 110     private ExistenceCheckOperation mAuthCheckOperation;
 111     private RemoteOperationResult mLastSslUntrustedServerResult;
 112
 113     private Uri mNewCapturedUriFromOAuth2Redirection;
 114
 115     private AccountManager mAccountMgr;
 116     private boolean mJustCreated;
 117     private byte mAction;
 118     private Account mAccount;
 119
 120     private ImageView mRefreshButton;
 121     private ImageView mViewPasswordButton;
 122     private EditText mHostUrlInput;
 123     private EditText mUsernameInput;
 124     private EditText mPasswordInput;
 125     private CheckBox mOAuth2Check;
 126     private String mOAuthAccessToken;
 127     private View mOkButton;
 128     private TextView mAuthStatusLayout;
 129
 130     private TextView mOAuthAuthEndpointText;
 131     private TextView mOAuthTokenEndpointText;
 132
 133
 134     /**
 135      * {@inheritDoc}
 136      *
 137      * IMPORTANT ENTRY POINT 1: activity is shown to the user
 138      */
 139     @Override
 140     protected void onCreate(Bundle savedInstanceState) {
 141         super.onCreate(savedInstanceState);
 142         getWindow().requestFeature(Window.FEATURE_NO_TITLE);
 143
 144         /// set view and get references to view elements
 145         setContentView(R.layout.account_setup);
 146         mRefreshButton = (ImageView) findViewById(R.id.refreshButton);
 147         mViewPasswordButton = (ImageView) findViewById(R.id.viewPasswordButton);
 148         mHostUrlInput = (EditText) findViewById(R.id.hostUrlInput);
 149         mUsernameInput = (EditText) findViewById(R.id.account_username);
 150         mPasswordInput = (EditText) findViewById(R.id.account_password);
 151         mOAuthAuthEndpointText = (TextView)findViewById(R.id.oAuthEntryPoint_1);
 152         mOAuthTokenEndpointText = (TextView)findViewById(R.id.oAuthEntryPoint_2);
 153         mOAuth2Check = (CheckBox) findViewById(R.id.oauth_onOff_check);
 154         mOkButton = findViewById(R.id.buttonOK);
 155         mAuthStatusLayout = (TextView) findViewById(R.id.auth_status_text);
 156
 157
 158         /// complete label for 'register account' button
 159         Button b = (Button) findViewById(R.id.account_register);
 160         if (b != null) {
 161             b.setText(String.format(getString(R.string.auth_register), getString(R.string.app_name)));
 162         }
 163
 164         /// bind view elements to listeners
 165         mHostUrlInput.setOnFocusChangeListener(this);
 166         mPasswordInput.setOnFocusChangeListener(this);
 167
 168         /// initialization
 169         mAccountMgr = AccountManager.get(this);
 170         mNewCapturedUriFromOAuth2Redirection = null;
 171         mAction = getIntent().getByteExtra(EXTRA_ACTION, ACTION_CREATE);
 172         mAccount = null;
 173
 174         if (savedInstanceState == null) {
 175             /// connection state and info
 176             mStatusText = mStatusIcon = 0;
 177             mStatusCorrect = false;
 178             mIsSslConn = false;
 179
 180             /// retrieve extras from intent
 181             String tokenType = getIntent().getExtras().getString(AccountAuthenticator.KEY_AUTH_TOKEN_TYPE);
 182             boolean oAuthRequired = AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN.equals(tokenType);
 183
 184             mAccount = getIntent().getExtras().getParcelable(EXTRA_ACCOUNT);
 185             if (mAccount != null) {
 186                 String ocVersion = mAccountMgr.getUserData(mAccount, AccountAuthenticator.KEY_OC_VERSION);
 187                 if (ocVersion != null) {
 188                     mDiscoveredVersion = new OwnCloudVersion(ocVersion);
 189                 }
 190                 mHostBaseUrl = mAccountMgr.getUserData(mAccount, AccountAuthenticator.KEY_OC_BASE_URL);
 191                 mHostUrlInput.setText(mHostBaseUrl);
 192                 String userName = mAccount.name.substring(0, mAccount.name.lastIndexOf('@'));
 193                 mUsernameInput.setText(userName);
 194                 oAuthRequired = (mAccountMgr.getUserData(mAccount, AccountAuthenticator.KEY_SUPPORTS_OAUTH2) != null);
 195             }
 196             mOAuth2Check.setChecked(oAuthRequired);
 197             changeViewByOAuth2Check(oAuthRequired);
 198
 199
 200         } else {
 201             loadSavedInstanceState(savedInstanceState);
 202         }
 203
 204         if (mAction == ACTION_UPDATE_TOKEN) {
 205             /// lock things that should not change
 206             mHostUrlInput.setEnabled(false);
 207             mUsernameInput.setEnabled(false);
 208             mOAuth2Check.setVisibility(View.GONE);
 209             checkOcServer();
 210         }
 211
 212         mPasswordInput.setText("");     // clean password to avoid social hacking (disadvantage: password in removed if the device is turned aside)
 213         mJustCreated = true;
 214     }
 215
 216
 217     /**
 218      * Saves relevant state before {@link #onPause()}
 219      *
 220      * Do NOT save {@link #mNewCapturedUriFromOAuth2Redirection}; it keeps a temporal flag, intended to defer the
 221      * processing of the redirection caught in {@link #onNewIntent(Intent)} until {@link #onResume()}
 222      *
 223      * See {@link #loadSavedInstanceState(Bundle)}
 224      */
 225     @Override
 226     protected void onSaveInstanceState(Bundle outState) {
 227         super.onSaveInstanceState(outState);
 228
 229         /// connection state and info
 230         outState.putInt(KEY_STATUS_TEXT, mStatusText);
 231         outState.putInt(KEY_STATUS_ICON, mStatusIcon);
 232         outState.putBoolean(KEY_STATUS_CORRECT, mStatusCorrect);
 233         outState.putBoolean(KEY_IS_SSL_CONN, mIsSslConn);
 234
 235         /// server data
 236         if (mDiscoveredVersion != null)
 237             outState.putString(KEY_OC_VERSION, mDiscoveredVersion.toString());
 238         outState.putString(KEY_HOST_URL_TEXT, mHostBaseUrl);
 239
 240         /// account data, if updating
 241         if (mAccount != null)
 242             outState.putParcelable(KEY_ACCOUNT, mAccount);
 243
 244         // Saving the state of oAuth2 components.
 245         outState.putInt(KEY_OAUTH2_STATUS_ICON, mOAuth2StatusIcon);
 246         outState.putInt(KEY_OAUTH2_STATUS_TEXT, mOAuth2StatusText);
 247
 248     }
 249
 250
 251     /**
 252      * Loads saved state
 253      *
 254      * See {@link #onSaveInstanceState(Bundle)}.
 255      *
 256      * @param savedInstanceState    Saved state, as received in {@link #onCreate(Bundle)}.
 257      */
 258     private void loadSavedInstanceState(Bundle savedInstanceState) {
 259         /// connection state and info
 260         mStatusCorrect = savedInstanceState.getBoolean(KEY_STATUS_CORRECT);
 261         mIsSslConn = savedInstanceState.getBoolean(KEY_IS_SSL_CONN);
 262         mStatusText = savedInstanceState.getInt(KEY_STATUS_TEXT);
 263         mStatusIcon = savedInstanceState.getInt(KEY_STATUS_ICON);
 264         updateConnStatus();
 265
 266         /// UI settings depending upon connection
 267         mOkButton.setEnabled(mStatusCorrect);   // TODO really necessary?
 268         if (!mStatusCorrect)
 269             mRefreshButton.setVisibility(View.VISIBLE); // seems that setting visibility is necessary
 270         else
 271             mRefreshButton.setVisibility(View.INVISIBLE);
 272
 273         /// server data
 274         String ocVersion = savedInstanceState.getString(KEY_OC_VERSION);
 275         if (ocVersion != null)
 276             mDiscoveredVersion = new OwnCloudVersion(ocVersion);
 277         mHostBaseUrl = savedInstanceState.getString(KEY_HOST_URL_TEXT);
 278
 279         // account data, if updating
 280         mAccount = savedInstanceState.getParcelable(KEY_ACCOUNT);
 281
 282         // state of oAuth2 components
 283         mOAuth2StatusIcon = savedInstanceState.getInt(KEY_OAUTH2_STATUS_ICON);
 284         mOAuth2StatusText = savedInstanceState.getInt(KEY_OAUTH2_STATUS_TEXT);
 285         // END of getting the state of oAuth2 components.
 286     }
 287
 288
 289     /**
 290      * The redirection triggered by the OAuth authentication server as response to the GET AUTHORIZATION request
 291      * is caught here.
 292      *
 293      * To make this possible, this activity needs to be qualified with android:launchMode = "singleTask" in the
 294      * AndroidManifest.xml file.
 295      */
 296     @Override
 297     protected void onNewIntent (Intent intent) {
 298         Log.d(TAG, "onNewIntent()");
 299         Uri data = intent.getData();
 300         if (data != null && data.toString().startsWith(getString(R.string.oauth2_redirect_uri))) {
 301             mNewCapturedUriFromOAuth2Redirection = data;
 302         }
 303     }
 304
 305
 306     /**
 307      * The redirection triggered by the OAuth authentication server as response to the GET AUTHORIZATION, and
 308      * deferred in {@link #onNewIntent(Intent)}, is processed here.
 309      */
 310     @Override
 311     protected void onResume() {
 312         super.onResume();
 313         // the state of mOAuth2Check is automatically recovered between configuration changes, but not before onCreate() finishes; so keep the next lines here
 314         changeViewByOAuth2Check(mOAuth2Check.isChecked());
 315         if (mAction == ACTION_UPDATE_TOKEN && mJustCreated) {
 316             if (mOAuth2Check.isChecked())
 317                 Toast.makeText(this, R.string.auth_expired_oauth_token_toast, Toast.LENGTH_LONG).show();
 318             else
 319                 Toast.makeText(this, R.string.auth_expired_basic_auth_toast, Toast.LENGTH_LONG).show();
 320         }
 321
 322         if (mNewCapturedUriFromOAuth2Redirection != null) {
 323             getOAuth2AccessTokenFromCapturedRedirection();
 324         }
 325
 326         mJustCreated = false;
 327     }
 328
 329
 330     /**
 331      * Parses the redirection with the response to the GET AUTHORIZATION request to the
 332      * oAuth server and requests for the access token (GET ACCESS TOKEN)
 333      */
 334     private void getOAuth2AccessTokenFromCapturedRedirection() {
 335         /// Parse data from OAuth redirection
 336         String queryParameters = mNewCapturedUriFromOAuth2Redirection.getQuery();
 337         mNewCapturedUriFromOAuth2Redirection = null;
 338
 339         /// Showing the dialog with instructions for the user.
 340         showDialog(DIALOG_OAUTH2_LOGIN_PROGRESS);
 341
 342         /// GET ACCESS TOKEN to the oAuth server
 343         RemoteOperation operation = new OAuth2GetAccessToken(   getString(R.string.oauth2_client_id),
 344                                                                 getString(R.string.oauth2_redirect_uri), // TODO check - necessary here?
 345                                                                 getString(R.string.oauth2_grant_type),
 346                                                                 queryParameters);
 347         WebdavClient client = OwnCloudClientUtils.createOwnCloudClient(Uri.parse(getString(R.string.oauth2_url_endpoint_access)), getApplicationContext());
 348         operation.execute(client, this, mHandler);
 349     }
 350
 351
 352
 353     /**
 354      * Handles the change of focus on the text inputs for the server URL and the password
 355      */
 356     public void onFocusChange(View view, boolean hasFocus) {
 357         if (view.getId() == R.id.hostUrlInput) {
 358             onUrlInputFocusChanged((TextView) view, hasFocus);
 359
 360         } else if (view.getId() == R.id.account_password) {
 361             onPasswordFocusChanged((TextView) view, hasFocus);
 362         }
 363     }
 364
 365
 366     /**
 367      * Handles changes in focus on the text input for the server URL.
 368      *
 369      * IMPORTANT ENTRY POINT 2: When (!hasFocus), user wrote the server URL and changed to
 370      * other field. The operation to check the existence of the server in the entered URL is
 371      * started.
 372      *
 373      * When hasFocus:    user 'comes back' to write again the server URL.
 374      *
 375      * @param hostInput     TextView with the URL input field receiving the change of focus.
 376      * @param hasFocus      'True' if focus is received, 'false' if is lost
 377      */
 378     private void onUrlInputFocusChanged(TextView hostInput, boolean hasFocus) {
 379         if (!hasFocus) {
 380             checkOcServer();
 381
 382         } else {
 383             // avoids that the 'connect' button can be clicked if the test was previously passed
 384             mOkButton.setEnabled(false);
 385         }
 386     }
 387
 388
 389     private void checkOcServer() {
 390         String uri = mHostUrlInput.getText().toString().trim();
 391         if (uri.length() != 0) {
 392             mStatusText = R.string.auth_testing_connection;
 393             mStatusIcon = R.drawable.progress_small;
 394             updateConnStatus();
 395             /** TODO cancel previous connection check if the user tries to ammend a wrong URL
 396             if(mConnChkOperation != null) {
 397                 mConnChkOperation.cancel();
 398             } */
 399             mOcServerChkOperation = new  OwnCloudServerCheckOperation(uri, this);
 400             WebdavClient client = OwnCloudClientUtils.createOwnCloudClient(Uri.parse(uri), this);
 401             mHostBaseUrl = "";
 402             mDiscoveredVersion = null;
 403             mOperationThread = mOcServerChkOperation.execute(client, this, mHandler);
 404         } else {
 405             mRefreshButton.setVisibility(View.INVISIBLE);
 406             mStatusText = 0;
 407             mStatusIcon = 0;
 408             updateConnStatus();
 409         }
 410     }
 411
 412
 413     /**
 414      * Handles changes in focus on the text input for the password (basic authorization).
 415      *
 416      * When (hasFocus), the button to toggle password visibility is shown.
 417      *
 418      * When (!hasFocus), the button is made invisible and the password is hidden.
 419      *
 420      * @param passwordInput    TextView with the password input field receiving the change of focus.
 421      * @param hasFocus          'True' if focus is received, 'false' if is lost
 422      */
 423     private void onPasswordFocusChanged(TextView passwordInput, boolean hasFocus) {
 424         if (hasFocus) {
 425             mViewPasswordButton.setVisibility(View.VISIBLE);
 426         } else {
 427             int input_type = InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_PASSWORD;
 428             passwordInput.setInputType(input_type);
 429             mViewPasswordButton.setVisibility(View.INVISIBLE);
 430         }
 431     }
 432
 433
 434
 435     /**
 436      * Cancels the authenticator activity
 437      *
 438      * IMPORTANT ENTRY POINT 3: Never underestimate the importance of cancellation
 439      *
 440      * This method is bound in the layout/acceoun_setup.xml resource file.
 441      *
 442      * @param view      Cancel button
 443      */
 444     public void onCancelClick(View view) {
 445         setResult(RESULT_CANCELED);     // TODO review how is this related to AccountAuthenticator (debugging)
 446         finish();
 447     }
 448
 449
 450
 451     /**
 452      * Checks the credentials of the user in the root of the ownCloud server
 453      * before creating a new local account.
 454      *
 455      * For basic authorization, a check of existence of the root folder is
 456      * performed.
 457      *
 458      * For OAuth, starts the flow to get an access token; the credentials test
 459      * is postponed until it is available.
 460      *
 461      * IMPORTANT ENTRY POINT 4
 462      *
 463      * @param view      OK button
 464      */
 465     public void onOkClick(View view) {
 466         // this check should be unnecessary
 467         if (mDiscoveredVersion == null || !mDiscoveredVersion.isVersionValid()  || mHostBaseUrl == null || mHostBaseUrl.length() == 0) {
 468             mStatusIcon = R.drawable.common_error;
 469             mStatusText = R.string.auth_wtf_reenter_URL;
 470             updateConnStatus();
 471             mOkButton.setEnabled(false);
 472             Log.wtf(TAG,  "The user was allowed to click 'connect' to an unchecked server!!");
 473             return;
 474         }
 475
 476         if (mOAuth2Check.isChecked()) {
 477             startOauthorization();
 478
 479         } else {
 480             checkBasicAuthorization();
 481         }
 482     }
 483
 484
 485     /**
 486      * Tests the credentials entered by the user performing a check of existence on
 487      * the root folder of the ownCloud server.
 488      */
 489     private void checkBasicAuthorization() {
 490         /// get the path to the root folder through WebDAV from the version server
 491         String webdav_path = AccountUtils.getWebdavPath(mDiscoveredVersion, false);
 492
 493         /// get basic credentials entered by user
 494         String username = mUsernameInput.getText().toString();
 495         String password = mPasswordInput.getText().toString();
 496
 497         /// be gentle with the user
 498         showDialog(DIALOG_LOGIN_PROGRESS);
 499
 500         /// test credentials accessing the root folder
 501         mAuthCheckOperation = new  ExistenceCheckOperation("", this, false);
 502         WebdavClient client = OwnCloudClientUtils.createOwnCloudClient(Uri.parse(mHostBaseUrl + webdav_path), this);
 503         client.setBasicCredentials(username, password);
 504         mOperationThread = mAuthCheckOperation.execute(client, this, mHandler);
 505     }
 506
 507
 508     /**
 509      * Starts the OAuth 'grant type' flow to get an access token, with
 510      * a GET AUTHORIZATION request to the BUILT-IN authorization server.
 511      */
 512     private void startOauthorization() {
 513         // be gentle with the user
 514         mStatusIcon = R.drawable.progress_small;
 515         mStatusText = R.string.oauth_login_connection;
 516         updateAuthStatus();
 517
 518         // GET AUTHORIZATION request
 519         Uri uri = Uri.parse(getString(R.string.oauth2_url_endpoint_auth));
 520         Uri.Builder uriBuilder = uri.buildUpon();
 521         uriBuilder.appendQueryParameter(OAuth2Constants.KEY_RESPONSE_TYPE, getString(R.string.oauth2_response_type));
 522         uriBuilder.appendQueryParameter(OAuth2Constants.KEY_REDIRECT_URI, getString(R.string.oauth2_redirect_uri));
 523         uriBuilder.appendQueryParameter(OAuth2Constants.KEY_CLIENT_ID, getString(R.string.oauth2_client_id));
 524         uriBuilder.appendQueryParameter(OAuth2Constants.KEY_SCOPE, getString(R.string.oauth2_scope));
 525         //uriBuilder.appendQueryParameter(OAuth2Constants.KEY_STATE, whateverwewant);
 526         uri = uriBuilder.build();
 527         Log.d(TAG, "Starting browser to view " + uri.toString());
 528         Intent i = new Intent(Intent.ACTION_VIEW, uri);
 529         startActivity(i);
 530     }
 531
 532
 533     /**
 534      * Callback method invoked when a RemoteOperation executed by this Activity finishes.
 535      *
 536      * Dispatches the operation flow to the right method.
 537      */
 538     @Override
 539     public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) {
 540
 541         if (operation instanceof OwnCloudServerCheckOperation) {
 542             onOcServerCheckFinish((OwnCloudServerCheckOperation) operation, result);
 543
 544         } else if (operation instanceof OAuth2GetAccessToken) {
 545             onGetOAuthAccessTokenFinish((OAuth2GetAccessToken)operation, result);
 546
 547         } else if (operation instanceof ExistenceCheckOperation)  {
 548             onAuthorizationCheckFinish((ExistenceCheckOperation)operation, result);
 549
 550         }
 551     }
 552
 553
 554     /**
 555      * Processes the result of the server check performed when the user finishes the enter of the
 556      * server URL.
 557      *
 558      * @param operation     Server check performed.
 559      * @param result        Result of the check.
 560      */
 561     private void onOcServerCheckFinish(OwnCloudServerCheckOperation operation, RemoteOperationResult result) {
 562         /// update status icon and text
 563         updateStatusIconAndText(result);
 564         updateConnStatus();
 565
 566         /// save result state
 567         mStatusCorrect = result.isSuccess();
 568         mIsSslConn = (result.getCode() == ResultCode.OK_SSL);
 569
 570         /// very special case (TODO: move to a common place for all the remote operations)
 571         if (result.getCode() == ResultCode.SSL_RECOVERABLE_PEER_UNVERIFIED) {
 572             mLastSslUntrustedServerResult = result;
 573             showDialog(DIALOG_SSL_VALIDATOR);
 574         }
 575
 576         /// update the visibility of the 'retry connection' button
 577         if (!mStatusCorrect)
 578             mRefreshButton.setVisibility(View.VISIBLE);
 579         else
 580             mRefreshButton.setVisibility(View.INVISIBLE);
 581
 582         /// retrieve discovered version and normalize server URL
 583         mDiscoveredVersion = operation.getDiscoveredVersion();
 584         mHostBaseUrl = mHostUrlInput.getText().toString().trim();
 585         if (!mHostBaseUrl.toLowerCase().startsWith("http://") &&
 586             !mHostBaseUrl.toLowerCase().startsWith("https://")) {
 587
 588             if (mIsSslConn) {
 589                 mHostBaseUrl = "https://" + mHostBaseUrl;
 590             } else {
 591                 mHostBaseUrl = "http://" + mHostBaseUrl;
 592             }
 593
 594         }
 595         if (mHostBaseUrl.endsWith("/"))
 596             mHostBaseUrl = mHostBaseUrl.substring(0, mHostBaseUrl.length() - 1);
 597
 598         /// allow or not the user try to access the server
 599         mOkButton.setEnabled(mStatusCorrect);
 600     }
 601
 602
 603     /**
 604      * Chooses the right icon and text to show to the user for the received operation result.
 605      *
 606      * @param result    Result of a remote operation performed in this activity
 607      */
 608     private void updateStatusIconAndText(RemoteOperationResult result) {
 609         mStatusText = mStatusIcon = 0;
 610
 611         switch (result.getCode()) {
 612         case OK_SSL:
 613             mStatusIcon = android.R.drawable.ic_secure;
 614             mStatusText = R.string.auth_secure_connection;
 615             break;
 616
 617         case OK_NO_SSL:
 618         case OK:
 619             if (mHostUrlInput.getText().toString().trim().toLowerCase().startsWith("http://") ) {
 620                 mStatusText = R.string.auth_connection_established;
 621                 mStatusIcon = R.drawable.ic_ok;
 622             } else {
 623                 mStatusText = R.string.auth_nossl_plain_ok_title;
 624                 mStatusIcon = android.R.drawable.ic_partial_secure;
 625             }
 626             break;
 627
 628         case SSL_RECOVERABLE_PEER_UNVERIFIED:
 629             mStatusIcon = R.drawable.common_error;
 630             mStatusText = R.string.auth_ssl_unverified_server_title;
 631             break;
 632
 633         case BAD_OC_VERSION:
 634             mStatusIcon = R.drawable.common_error;
 635             mStatusText = R.string.auth_bad_oc_version_title;
 636             break;
 637         case WRONG_CONNECTION:
 638             mStatusIcon = R.drawable.common_error;
 639             mStatusText = R.string.auth_wrong_connection_title;
 640             break;
 641         case TIMEOUT:
 642             mStatusIcon = R.drawable.common_error;
 643             mStatusText = R.string.auth_timeout_title;
 644             break;
 645         case INCORRECT_ADDRESS:
 646             mStatusIcon = R.drawable.common_error;
 647             mStatusText = R.string.auth_incorrect_address_title;
 648             break;
 649
 650         case SSL_ERROR:
 651             mStatusIcon = R.drawable.common_error;
 652             mStatusText = R.string.auth_ssl_general_error_title;
 653             break;
 654
 655         case UNAUTHORIZED:
 656             mStatusIcon = R.drawable.common_error;
 657             mStatusText = R.string.auth_unauthorized;
 658             break;
 659         case HOST_NOT_AVAILABLE:
 660             mStatusIcon = R.drawable.common_error;
 661             mStatusText = R.string.auth_unknown_host_title;
 662             break;
 663         case NO_NETWORK_CONNECTION:
 664             mStatusIcon = R.drawable.no_network;
 665             mStatusText = R.string.auth_no_net_conn_title;
 666             break;
 667         case INSTANCE_NOT_CONFIGURED:
 668             mStatusIcon = R.drawable.common_error;
 669             mStatusText = R.string.auth_not_configured_title;
 670             break;
 671         case FILE_NOT_FOUND:
 672             mStatusIcon = R.drawable.common_error;
 673             mStatusText = R.string.auth_incorrect_path_title;
 674             break;
 675         case OAUTH2_ERROR:
 676             mStatusIcon = R.drawable.common_error;
 677             mStatusText = R.string.auth_oauth_error;
 678             break;
 679         case OAUTH2_ERROR_ACCESS_DENIED:
 680             mStatusIcon = R.drawable.common_error;
 681             mStatusText = R.string.auth_oauth_error_access_denied;
 682             break;
 683         case UNHANDLED_HTTP_CODE:
 684         case UNKNOWN_ERROR:
 685             mStatusIcon = R.drawable.common_error;
 686             mStatusText = R.string.auth_unknown_error_title;
 687             break;
 688
 689         default:
 690             break;
 691         }
 692     }
 693
 694
 695     /**
 696      * Processes the result of the request for and access token send
 697      * to an OAuth authorization server.
 698      *
 699      * @param operation     Operation performed requesting the access token.
 700      * @param result        Result of the operation.
 701      */
 702     private void onGetOAuthAccessTokenFinish(OAuth2GetAccessToken operation, RemoteOperationResult result) {
 703         try {
 704             dismissDialog(DIALOG_OAUTH2_LOGIN_PROGRESS);
 705         } catch (IllegalArgumentException e) {
 706             // NOTHING TO DO ; can't find out what situation that leads to the exception in this code, but user logs signal that it happens
 707         }
 708
 709         String webdav_path = AccountUtils.getWebdavPath(mDiscoveredVersion, true);
 710         if (result.isSuccess() && webdav_path != null) {
 711             /// be gentle with the user
 712             showDialog(DIALOG_LOGIN_PROGRESS);
 713
 714             /// time to test the retrieved access token on the ownCloud server
 715             mOAuthAccessToken = ((OAuth2GetAccessToken)operation).getResultTokenMap().get(OAuth2Constants.KEY_ACCESS_TOKEN);
 716             Log.d(TAG, "Got ACCESS TOKEN: " + mOAuthAccessToken);
 717             mAuthCheckOperation = new ExistenceCheckOperation("", this, false);
 718             WebdavClient client = OwnCloudClientUtils.createOwnCloudClient(Uri.parse(mHostBaseUrl + webdav_path), this);
 719             client.setBearerCredentials(mOAuthAccessToken);
 720             mAuthCheckOperation.execute(client, this, mHandler);
 721
 722         } else {
 723             updateStatusIconAndText(result);
 724             updateAuthStatus();
 725             Log.d(TAG, "Access failed: " + result.getLogMessage());
 726         }
 727     }
 728
 729
 730     /**
 731      * Processes the result of the access check performed to try the user credentials.
 732      *
 733      * Creates a new account through the AccountManager.
 734      *
 735      * @param operation     Access check performed.
 736      * @param result        Result of the operation.
 737      */
 738     private void onAuthorizationCheckFinish(ExistenceCheckOperation operation, RemoteOperationResult result) {
 739         try {
 740             dismissDialog(DIALOG_LOGIN_PROGRESS);
 741         } catch (IllegalArgumentException e) {
 742             // NOTHING TO DO ; can't find out what situation that leads to the exception in this code, but user logs signal that it happens
 743         }
 744
 745         if (result.isSuccess()) {
 746             Log.d(TAG, "Successful access - time to save the account");
 747
 748             if (mAction == ACTION_CREATE) {
 749                 createAccount();
 750
 751             } else {
 752                 updateToken();
 753             }
 754
 755             finish();
 756
 757         } else {
 758             updateStatusIconAndText(result);
 759             updateAuthStatus();
 760             Log.d(TAG, "Access failed: " + result.getLogMessage());
 761         }
 762     }
 763
 764
 765     /**
 766      * Sets the proper response to get that the Account Authenticator that started this activity saves
 767      * a new authorization token for mAccount.
 768      */
 769     private void updateToken() {
 770         Bundle response = new Bundle();
 771         response.putString(AccountManager.KEY_ACCOUNT_NAME, mAccount.name);
 772         response.putString(AccountManager.KEY_ACCOUNT_TYPE, mAccount.type);
 773         boolean isOAuth = mOAuth2Check.isChecked();
 774         if (isOAuth) {
 775             response.putString(AccountManager.KEY_AUTHTOKEN, mOAuthAccessToken);
 776             // the next line is necessary; by now, notifications are calling directly to the AuthenticatorActivity to update, without AccountManager intervention
 777             mAccountMgr.setAuthToken(mAccount, AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN, mOAuthAccessToken);
 778         } else {
 779             response.putString(AccountManager.KEY_AUTHTOKEN, mPasswordInput.getText().toString());
 780             mAccountMgr.setPassword(mAccount, mPasswordInput.getText().toString());
 781         }
 782         setAccountAuthenticatorResult(response);
 783     }
 784
 785
 786     /**
 787      * Creates a new account through the Account Authenticator that started this activity.
 788      *
 789      * This makes the account permanent.
 790      *
 791      * TODO Decide how to name the OAuth accounts
 792      */
 793     private void createAccount() {
 794         /// create and save new ownCloud account
 795         boolean isOAuth = mOAuth2Check.isChecked();
 796
 797         Uri uri = Uri.parse(mHostBaseUrl);
 798         String username = mUsernameInput.getText().toString().trim();
 799         if (isOAuth) {
 800             username = "OAuth_user" + (new java.util.Random(System.currentTimeMillis())).nextLong();
 801         }
 802         String accountName = username + "@" + uri.getHost();
 803         if (uri.getPort() >= 0) {
 804             accountName += ":" + uri.getPort();
 805         }
 806         mAccount = new Account(accountName, AccountAuthenticator.ACCOUNT_TYPE);
 807         if (isOAuth) {
 808             mAccountMgr.addAccountExplicitly(mAccount, "", null);  // with our implementation, the password is never input in the app
 809         } else {
 810             mAccountMgr.addAccountExplicitly(mAccount, mPasswordInput.getText().toString(), null);
 811         }
 812
 813         /// add the new account as default in preferences, if there is none already
 814         Account defaultAccount = AccountUtils.getCurrentOwnCloudAccount(this);
 815         if (defaultAccount == null) {
 816             SharedPreferences.Editor editor = PreferenceManager
 817                     .getDefaultSharedPreferences(this).edit();
 818             editor.putString("select_oc_account", accountName);
 819             editor.commit();
 820         }
 821
 822         /// prepare result to return to the Authenticator
 823         //  TODO check again what the Authenticator makes with it; probably has the same effect as addAccountExplicitly, but it's not well done
 824         final Intent intent = new Intent();
 825         intent.putExtra(AccountManager.KEY_ACCOUNT_TYPE,    AccountAuthenticator.ACCOUNT_TYPE);
 826         intent.putExtra(AccountManager.KEY_ACCOUNT_NAME,    mAccount.name);
 827         if (!isOAuth)
 828             intent.putExtra(AccountManager.KEY_AUTHTOKEN,   AccountAuthenticator.ACCOUNT_TYPE); // TODO check this; not sure it's right; maybe
 829         intent.putExtra(AccountManager.KEY_USERDATA,        username);
 830         if (isOAuth) {
 831             mAccountMgr.setAuthToken(mAccount, AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN, mOAuthAccessToken);
 832         }
 833         /// add user data to the new account; TODO probably can be done in the last parameter addAccountExplicitly, or in KEY_USERDATA
 834         mAccountMgr.setUserData(mAccount, AccountAuthenticator.KEY_OC_VERSION,    mDiscoveredVersion.toString());
 835         mAccountMgr.setUserData(mAccount, AccountAuthenticator.KEY_OC_BASE_URL,   mHostBaseUrl);
 836         if (isOAuth)
 837             mAccountMgr.setUserData(mAccount, AccountAuthenticator.KEY_SUPPORTS_OAUTH2, "TRUE");  // TODO this flag should be unnecessary
 838
 839         setAccountAuthenticatorResult(intent.getExtras());
 840         setResult(RESULT_OK, intent);
 841
 842         /// immediately request for the synchronization of the new account
 843         Bundle bundle = new Bundle();
 844         bundle.putBoolean(ContentResolver.SYNC_EXTRAS_MANUAL, true);
 845         ContentResolver.requestSync(mAccount, AccountAuthenticator.AUTHORITY, bundle);
 846     }
 847
 848
 849     /**
 850      * {@inheritDoc}
 851      *
 852      * Necessary to update the contents of the SSL Dialog
 853      *
 854      * TODO move to some common place for all possible untrusted SSL failures
 855      */
 856     @Override
 857     protected void onPrepareDialog(int id, Dialog dialog, Bundle args) {
 858         switch (id) {
 859         case DIALOG_LOGIN_PROGRESS:
 860         case DIALOG_CERT_NOT_SAVED:
 861         case DIALOG_OAUTH2_LOGIN_PROGRESS:
 862             break;
 863         case DIALOG_SSL_VALIDATOR: {
 864             ((SslValidatorDialog)dialog).updateResult(mLastSslUntrustedServerResult);
 865             break;
 866         }
 867         default:
 868             Log.e(TAG, "Incorrect dialog called with id = " + id);
 869         }
 870     }
 871
 872
 873     /**
 874      * {@inheritDoc}
 875      */
 876     @Override
 877     protected Dialog onCreateDialog(int id) {
 878         Dialog dialog = null;
 879         switch (id) {
 880         case DIALOG_LOGIN_PROGRESS: {
 881             /// simple progress dialog
 882             ProgressDialog working_dialog = new ProgressDialog(this);
 883             working_dialog.setMessage(getResources().getString(R.string.auth_trying_to_login));
 884             working_dialog.setIndeterminate(true);
 885             working_dialog.setCancelable(true);
 886             working_dialog
 887                     .setOnCancelListener(new DialogInterface.OnCancelListener() {
 888                         @Override
 889                         public void onCancel(DialogInterface dialog) {
 890                             /// TODO study if this is enough
 891                             Log.i(TAG, "Login canceled");
 892                             if (mOperationThread != null) {
 893                                 mOperationThread.interrupt();
 894                                 finish();
 895                             }
 896                         }
 897                     });
 898             dialog = working_dialog;
 899             break;
 900         }
 901         case DIALOG_OAUTH2_LOGIN_PROGRESS: {
 902             ProgressDialog working_dialog = new ProgressDialog(this);
 903             working_dialog.setMessage(String.format("Getting authorization"));
 904             working_dialog.setIndeterminate(true);
 905             working_dialog.setCancelable(true);
 906             working_dialog
 907             .setOnCancelListener(new DialogInterface.OnCancelListener() {
 908                 @Override
 909                 public void onCancel(DialogInterface dialog) {
 910                     Log.i(TAG, "Login canceled");
 911                     finish();
 912                 }
 913             });
 914             dialog = working_dialog;
 915             break;
 916         }
 917         case DIALOG_SSL_VALIDATOR: {
 918             /// TODO start to use new dialog interface, at least for this (it is a FragmentDialog already)
 919             dialog = SslValidatorDialog.newInstance(this, mLastSslUntrustedServerResult, this);
 920             break;
 921         }
 922         case DIALOG_CERT_NOT_SAVED: {
 923             AlertDialog.Builder builder = new AlertDialog.Builder(this);
 924             builder.setMessage(getResources().getString(R.string.ssl_validator_not_saved));
 925             builder.setCancelable(false);
 926             builder.setPositiveButton(R.string.common_ok, new DialogInterface.OnClickListener() {
 927                     @Override
 928                     public void onClick(DialogInterface dialog, int which) {
 929                         dialog.dismiss();
 930                     };
 931                 });
 932             dialog = builder.create();
 933             break;
 934         }
 935         default:
 936             Log.e(TAG, "Incorrect dialog called with id = " + id);
 937         }
 938         return dialog;
 939     }
 940
 941
 942     /**
 943      * Starts and activity to open the 'new account' page in the ownCloud web site
 944      *
 945      * @param view      'Account register' button
 946      */
 947     public void onRegisterClick(View view) {
 948         Intent register = new Intent(Intent.ACTION_VIEW, Uri.parse(getString(R.string.url_account_register)));
 949         setResult(RESULT_CANCELED);
 950         startActivity(register);
 951     }
 952
 953
 954     /**
 955      * Updates the content and visibility state of the icon and text associated
 956      * to the last check on the ownCloud server.
 957      */
 958     private void updateConnStatus() {
 959         ImageView iv = (ImageView) findViewById(R.id.action_indicator);
 960         TextView tv = (TextView) findViewById(R.id.status_text);
 961
 962         if (mStatusIcon == 0 && mStatusText == 0) {
 963             iv.setVisibility(View.INVISIBLE);
 964             tv.setVisibility(View.INVISIBLE);
 965         } else {
 966             iv.setImageResource(mStatusIcon);
 967             tv.setText(mStatusText);
 968             iv.setVisibility(View.VISIBLE);
 969             tv.setVisibility(View.VISIBLE);
 970         }
 971     }
 972
 973
 974     /**
 975      * Updates the content and visibility state of the icon and text associated
 976      * to the interactions with the OAuth authorization server.
 977      */
 978     private void updateAuthStatus() {
 979         if (mStatusIcon == 0 && mStatusText == 0) {
 980             mAuthStatusLayout.setVisibility(View.INVISIBLE);
 981         } else {
 982             mAuthStatusLayout.setText(mStatusText);
 983             mAuthStatusLayout.setCompoundDrawablesWithIntrinsicBounds(mStatusIcon, 0, 0, 0);
 984             mAuthStatusLayout.setVisibility(View.VISIBLE);
 985         }
 986     }
 987
 988
 989     /**
 990      * Called when the refresh button in the input field for ownCloud host is clicked.
 991      *
 992      * Performs a new check on the URL in the input field.
 993      *
 994      * @param view      Refresh 'button'
 995      */
 996     public void onRefreshClick(View view) {
 997         onFocusChange(mRefreshButton, false);
 998     }
 999
1000
1001     /**
1002      * Called when the eye icon in the password field is clicked.
1003      *
1004      * Toggles the visibility of the password in the field.
1005      *
1006      * @param view      'View password' 'button'
1007      */
1008     public void onViewPasswordClick(View view) {
1009         int selectionStart = mPasswordInput.getSelectionStart();
1010         int selectionEnd = mPasswordInput.getSelectionEnd();
1011         int input_type = mPasswordInput.getInputType();
1012         if ((input_type & InputType.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD) == InputType.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD) {
1013             input_type = InputType.TYPE_CLASS_TEXT
1014                     | InputType.TYPE_TEXT_VARIATION_PASSWORD;
1015         } else {
1016             input_type = InputType.TYPE_CLASS_TEXT
1017                     | InputType.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD;
1018         }
1019         mPasswordInput.setInputType(input_type);
1020         mPasswordInput.setSelection(selectionStart, selectionEnd);
1021     }
1022
1023
1024     /**
1025      * Called when the checkbox for OAuth authorization is clicked.
1026      *
1027      * Hides or shows the input fields for user & password.
1028      *
1029      * @param view      'View password' 'button'
1030      */
1031     public void onCheckClick(View view) {
1032         CheckBox oAuth2Check = (CheckBox)view;
1033         changeViewByOAuth2Check(oAuth2Check.isChecked());
1034
1035     }
1036
1037     /**
1038      * Changes the visibility of input elements depending upon the kind of authorization
1039      * chosen by the user: basic or OAuth
1040      *
1041      * @param checked       'True' when OAuth is selected.
1042      */
1043     public void changeViewByOAuth2Check(Boolean checked) {
1044
1045         if (checked) {
1046             mOAuthAuthEndpointText.setVisibility(View.VISIBLE);
1047             mOAuthTokenEndpointText.setVisibility(View.VISIBLE);
1048             mUsernameInput.setVisibility(View.GONE);
1049             mPasswordInput.setVisibility(View.GONE);
1050             mViewPasswordButton.setVisibility(View.GONE);
1051         } else {
1052             mOAuthAuthEndpointText.setVisibility(View.GONE);
1053             mOAuthTokenEndpointText.setVisibility(View.GONE);
1054             mUsernameInput.setVisibility(View.VISIBLE);
1055             mPasswordInput.setVisibility(View.VISIBLE);
1056             mViewPasswordButton.setVisibility(View.INVISIBLE);
1057         }
1058
1059     }
1060
1061     /**
1062      * Called from SslValidatorDialog when a new server certificate was correctly saved.
1063      */
1064     public void onSavedCertificate() {
1065         mOperationThread = mOcServerChkOperation.retry(this, mHandler);
1066     }
1067
1068     /**
1069      * Called from SslValidatorDialog when a new server certificate could not be saved
1070      * when the user requested it.
1071      */
1072     @Override
1073     public void onFailedSavingCertificate() {
1074         showDialog(DIALOG_CERT_NOT_SAVED);
1075     }
1076
1077 }