1 /* ownCloud Android client application
2 * Copyright (C) 2012 Bartek Przybylski
3 * Copyright (C) 2012-2013 ownCloud Inc.
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2,
7 * as published by the Free Software Foundation.
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.
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/>.
19 package com
.owncloud
.android
.authentication
;
21 import com
.owncloud
.android
.AccountUtils
;
22 import com
.owncloud
.android
.Log_OC
;
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
;
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
.graphics
.Rect
;
46 import android
.graphics
.drawable
.Drawable
;
47 import android
.net
.Uri
;
48 import android
.os
.Bundle
;
49 import android
.os
.Handler
;
50 import android
.preference
.PreferenceManager
;
51 import android
.text
.Editable
;
52 import android
.text
.InputType
;
53 import android
.text
.TextWatcher
;
54 import android
.view
.KeyEvent
;
55 import android
.view
.MotionEvent
;
56 import android
.view
.View
;
57 import android
.view
.View
.OnFocusChangeListener
;
58 import android
.view
.View
.OnTouchListener
;
59 import android
.view
.Window
;
60 import android
.view
.inputmethod
.EditorInfo
;
61 import android
.widget
.CheckBox
;
62 import android
.widget
.EditText
;
63 import android
.widget
.Button
;
64 import android
.widget
.ImageView
;
65 import android
.widget
.TextView
;
66 import android
.widget
.Toast
;
67 import android
.widget
.TextView
.OnEditorActionListener
;
69 import com
.owncloud
.android
.R
;
71 import eu
.alefzero
.webdav
.WebdavClient
;
74 * This Activity is used to add an ownCloud account to the App
76 * @author Bartek Przybylski
77 * @author David A. Velasco
79 public class AuthenticatorActivity
extends AccountAuthenticatorActivity
80 implements OnRemoteOperationListener
, OnSslValidatorListener
, OnFocusChangeListener
, OnEditorActionListener
{
82 private static final String TAG
= AuthenticatorActivity
.class.getSimpleName();
84 public static final String EXTRA_ACCOUNT
= "ACCOUNT";
85 public static final String EXTRA_USER_NAME
= "USER_NAME";
86 public static final String EXTRA_HOST_NAME
= "HOST_NAME";
87 public static final String EXTRA_ACTION
= "ACTION";
89 private static final String KEY_HOST_URL_TEXT
= "HOST_URL_TEXT";
90 private static final String KEY_OC_VERSION
= "OC_VERSION";
91 private static final String KEY_ACCOUNT
= "ACCOUNT";
92 private static final String KEY_SERVER_VALID
= "SERVER_VALID";
93 private static final String KEY_SERVER_CHECKED
= "SERVER_CHECKED";
94 private static final String KEY_SERVER_CHECK_IN_PROGRESS
= "SERVER_CHECK_IN_PROGRESS";
95 private static final String KEY_SERVER_STATUS_TEXT
= "SERVER_STATUS_TEXT";
96 private static final String KEY_SERVER_STATUS_ICON
= "SERVER_STATUS_ICON";
97 private static final String KEY_IS_SSL_CONN
= "IS_SSL_CONN";
98 private static final String KEY_AUTH_STATUS_TEXT
= "AUTH_STATUS_TEXT";
99 private static final String KEY_AUTH_STATUS_ICON
= "AUTH_STATUS_ICON";
101 private static final String OAUTH_MODE_ON
= "on";
102 private static final String OAUTH_MODE_OFF
= "off";
103 private static final String OAUTH_MODE_OPTIONAL
= "optional";
105 private static final int DIALOG_LOGIN_PROGRESS
= 0;
106 private static final int DIALOG_SSL_VALIDATOR
= 1;
107 private static final int DIALOG_CERT_NOT_SAVED
= 2;
108 private static final int DIALOG_OAUTH2_LOGIN_PROGRESS
= 3;
110 public static final byte ACTION_CREATE
= 0;
111 public static final byte ACTION_UPDATE_TOKEN
= 1;
114 private String mHostBaseUrl
;
115 private OwnCloudVersion mDiscoveredVersion
;
117 private int mServerStatusText
, mServerStatusIcon
;
118 private boolean mServerIsChecked
, mServerIsValid
, mIsSslConn
;
119 private int mAuthStatusText
, mAuthStatusIcon
;
121 private final Handler mHandler
= new Handler();
122 private Thread mOperationThread
;
123 private OwnCloudServerCheckOperation mOcServerChkOperation
;
124 private ExistenceCheckOperation mAuthCheckOperation
;
125 private RemoteOperationResult mLastSslUntrustedServerResult
;
127 private Uri mNewCapturedUriFromOAuth2Redirection
;
129 private AccountManager mAccountMgr
;
130 private boolean mJustCreated
;
131 private byte mAction
;
132 private Account mAccount
;
134 private ImageView mViewPasswordButton
;
135 private EditText mHostUrlInput
;
136 private EditText mUsernameInput
;
137 private EditText mPasswordInput
;
138 private CheckBox mOAuth2Check
;
139 private String mOAuthAccessToken
;
140 private View mOkButton
;
141 private TextView mAuthStatusLayout
;
143 private TextView mOAuthAuthEndpointText
;
144 private TextView mOAuthTokenEndpointText
;
150 * IMPORTANT ENTRY POINT 1: activity is shown to the user
153 protected void onCreate(Bundle savedInstanceState
) {
154 super.onCreate(savedInstanceState
);
155 getWindow().requestFeature(Window
.FEATURE_NO_TITLE
);
157 /// set view and get references to view elements
158 setContentView(R
.layout
.account_setup
);
159 mViewPasswordButton
= (ImageView
) findViewById(R
.id
.viewPasswordButton
);
160 mHostUrlInput
= (EditText
) findViewById(R
.id
.hostUrlInput
);
161 mUsernameInput
= (EditText
) findViewById(R
.id
.account_username
);
162 mPasswordInput
= (EditText
) findViewById(R
.id
.account_password
);
163 mOAuthAuthEndpointText
= (TextView
)findViewById(R
.id
.oAuthEntryPoint_1
);
164 mOAuthTokenEndpointText
= (TextView
)findViewById(R
.id
.oAuthEntryPoint_2
);
165 mOAuth2Check
= (CheckBox
) findViewById(R
.id
.oauth_onOff_check
);
166 mOkButton
= findViewById(R
.id
.buttonOK
);
167 mAuthStatusLayout
= (TextView
) findViewById(R
.id
.auth_status_text
);
169 /// complete label for 'register account' button
170 Button b
= (Button
) findViewById(R
.id
.account_register
);
172 b
.setText(String
.format(getString(R
.string
.auth_register
), getString(R
.string
.app_name
)));
176 mAccountMgr
= AccountManager
.get(this);
177 mNewCapturedUriFromOAuth2Redirection
= null
;
178 mAction
= getIntent().getByteExtra(EXTRA_ACTION
, ACTION_CREATE
);
182 if (savedInstanceState
== null
) {
183 /// connection state and info
184 mServerStatusText
= mServerStatusIcon
= 0;
185 mServerIsValid
= false
;
186 mServerIsChecked
= false
;
188 mAuthStatusText
= mAuthStatusIcon
= 0;
190 /// retrieve extras from intent
191 String tokenType
= getIntent().getExtras().getString(AccountAuthenticator
.KEY_AUTH_TOKEN_TYPE
);
192 boolean oAuthRequired
= AccountAuthenticator
.AUTH_TOKEN_TYPE_ACCESS_TOKEN
.equals(tokenType
) || OAUTH_MODE_ON
.equals(getString(R
.string
.oauth2_mode
));
194 mAccount
= getIntent().getExtras().getParcelable(EXTRA_ACCOUNT
);
195 if (mAccount
!= null
) {
196 String ocVersion
= mAccountMgr
.getUserData(mAccount
, AccountAuthenticator
.KEY_OC_VERSION
);
197 if (ocVersion
!= null
) {
198 mDiscoveredVersion
= new OwnCloudVersion(ocVersion
);
200 mHostBaseUrl
= normalizeUrl(mAccountMgr
.getUserData(mAccount
, AccountAuthenticator
.KEY_OC_BASE_URL
));
201 mHostUrlInput
.setText(mHostBaseUrl
);
202 String userName
= mAccount
.name
.substring(0, mAccount
.name
.lastIndexOf('@'));
203 mUsernameInput
.setText(userName
);
204 oAuthRequired
= (mAccountMgr
.getUserData(mAccount
, AccountAuthenticator
.KEY_SUPPORTS_OAUTH2
) != null
);
206 mOAuth2Check
.setChecked(oAuthRequired
);
207 changeViewByOAuth2Check(oAuthRequired
);
211 /// connection state and info
212 mServerIsValid
= savedInstanceState
.getBoolean(KEY_SERVER_VALID
);
213 mServerIsChecked
= savedInstanceState
.getBoolean(KEY_SERVER_CHECKED
);
214 mServerStatusText
= savedInstanceState
.getInt(KEY_SERVER_STATUS_TEXT
);
215 mServerStatusIcon
= savedInstanceState
.getInt(KEY_SERVER_STATUS_ICON
);
216 mIsSslConn
= savedInstanceState
.getBoolean(KEY_IS_SSL_CONN
);
217 mAuthStatusText
= savedInstanceState
.getInt(KEY_AUTH_STATUS_TEXT
);
218 mAuthStatusIcon
= savedInstanceState
.getInt(KEY_AUTH_STATUS_ICON
);
221 String ocVersion
= savedInstanceState
.getString(KEY_OC_VERSION
);
222 if (ocVersion
!= null
) {
223 mDiscoveredVersion
= new OwnCloudVersion(ocVersion
);
225 mHostBaseUrl
= savedInstanceState
.getString(KEY_HOST_URL_TEXT
);
227 // account data, if updating
228 mAccount
= savedInstanceState
.getParcelable(KEY_ACCOUNT
);
230 // check if server check was interrupted by a configuration change
231 if (savedInstanceState
.getBoolean(KEY_SERVER_CHECK_IN_PROGRESS
, false
)) {
239 if (mServerIsChecked
&& !mServerIsValid
) showRefreshButton();
240 mOkButton
.setEnabled(mServerIsValid
); // state not automatically recovered in configuration changes
242 if (!OAUTH_MODE_OPTIONAL
.equals(getString(R
.string
.oauth2_mode
))) {
243 mOAuth2Check
.setVisibility(View
.GONE
);
246 if (mAction
== ACTION_UPDATE_TOKEN
) {
247 /// lock things that should not change
248 mHostUrlInput
.setEnabled(false
);
249 mUsernameInput
.setEnabled(false
);
250 mOAuth2Check
.setVisibility(View
.GONE
);
251 if (!mServerIsValid
&& mOcServerChkOperation
== null
) {
256 mPasswordInput
.setText(""); // clean password to avoid social hacking (disadvantage: password in removed if the device is turned aside)
259 /// bind view elements to listeners
260 mHostUrlInput
.setOnFocusChangeListener(this);
261 mHostUrlInput
.setOnTouchListener(new RightDrawableOnTouchListener() {
263 public boolean onDrawableTouch(final MotionEvent event
) {
264 AuthenticatorActivity
.this.onRefreshClick(mHostUrlInput
);
268 mHostUrlInput
.addTextChangedListener(new TextWatcher() {
271 public void afterTextChanged(Editable s
) {
272 if (!mHostBaseUrl
.equals(normalizeUrl(mHostUrlInput
.getText().toString()))) {
273 mOkButton
.setEnabled(false
);
278 public void beforeTextChanged(CharSequence s
, int start
, int count
, int after
) {}
281 public void onTextChanged(CharSequence s
, int start
, int before
, int count
) {}
284 mPasswordInput
.setOnFocusChangeListener(this);
285 mPasswordInput
.setImeOptions(EditorInfo
.IME_ACTION_DONE
);
286 mPasswordInput
.setOnEditorActionListener(this);
290 * Saves relevant state before {@link #onPause()}
292 * Do NOT save {@link #mNewCapturedUriFromOAuth2Redirection}; it keeps a temporal flag, intended to defer the
293 * processing of the redirection caught in {@link #onNewIntent(Intent)} until {@link #onResume()}
295 * See {@link #loadSavedInstanceState(Bundle)}
298 protected void onSaveInstanceState(Bundle outState
) {
299 super.onSaveInstanceState(outState
);
301 /// connection state and info
302 outState
.putInt(KEY_SERVER_STATUS_TEXT
, mServerStatusText
);
303 outState
.putInt(KEY_SERVER_STATUS_ICON
, mServerStatusIcon
);
304 outState
.putBoolean(KEY_SERVER_VALID
, mServerIsValid
);
305 outState
.putBoolean(KEY_SERVER_CHECKED
, mServerIsChecked
);
306 outState
.putBoolean(KEY_SERVER_CHECK_IN_PROGRESS
, (!mServerIsValid
&& mOcServerChkOperation
!= null
));
307 outState
.putBoolean(KEY_IS_SSL_CONN
, mIsSslConn
);
308 outState
.putInt(KEY_AUTH_STATUS_ICON
, mAuthStatusIcon
);
309 outState
.putInt(KEY_AUTH_STATUS_TEXT
, mAuthStatusText
);
312 if (mDiscoveredVersion
!= null
) {
313 outState
.putString(KEY_OC_VERSION
, mDiscoveredVersion
.toString());
315 outState
.putString(KEY_HOST_URL_TEXT
, mHostBaseUrl
);
317 /// account data, if updating
318 if (mAccount
!= null
) {
319 outState
.putParcelable(KEY_ACCOUNT
, mAccount
);
326 * The redirection triggered by the OAuth authentication server as response to the GET AUTHORIZATION request
329 * To make this possible, this activity needs to be qualified with android:launchMode = "singleTask" in the
330 * AndroidManifest.xml file.
333 protected void onNewIntent (Intent intent
) {
334 Log_OC
.d(TAG
, "onNewIntent()");
335 Uri data
= intent
.getData();
336 if (data
!= null
&& data
.toString().startsWith(getString(R
.string
.oauth2_redirect_uri
))) {
337 mNewCapturedUriFromOAuth2Redirection
= data
;
343 * The redirection triggered by the OAuth authentication server as response to the GET AUTHORIZATION, and
344 * deferred in {@link #onNewIntent(Intent)}, is processed here.
347 protected void onResume() {
349 // the state of mOAuth2Check is automatically recovered between configuration changes, but not before onCreate() finishes; so keep the next lines here
350 changeViewByOAuth2Check(mOAuth2Check
.isChecked());
351 if (mAction
== ACTION_UPDATE_TOKEN
&& mJustCreated
) {
352 if (mOAuth2Check
.isChecked())
353 Toast
.makeText(this, R
.string
.auth_expired_oauth_token_toast
, Toast
.LENGTH_LONG
).show();
355 Toast
.makeText(this, R
.string
.auth_expired_basic_auth_toast
, Toast
.LENGTH_LONG
).show();
358 if (mNewCapturedUriFromOAuth2Redirection
!= null
) {
359 getOAuth2AccessTokenFromCapturedRedirection();
362 mJustCreated
= false
;
367 * Parses the redirection with the response to the GET AUTHORIZATION request to the
368 * oAuth server and requests for the access token (GET ACCESS TOKEN)
370 private void getOAuth2AccessTokenFromCapturedRedirection() {
371 /// Parse data from OAuth redirection
372 String queryParameters
= mNewCapturedUriFromOAuth2Redirection
.getQuery();
373 mNewCapturedUriFromOAuth2Redirection
= null
;
375 /// Showing the dialog with instructions for the user.
376 showDialog(DIALOG_OAUTH2_LOGIN_PROGRESS
);
378 /// GET ACCESS TOKEN to the oAuth server
379 RemoteOperation operation
= new OAuth2GetAccessToken( getString(R
.string
.oauth2_client_id
),
380 getString(R
.string
.oauth2_redirect_uri
),
381 getString(R
.string
.oauth2_grant_type
),
383 //WebdavClient client = OwnCloudClientUtils.createOwnCloudClient(Uri.parse(getString(R.string.oauth2_url_endpoint_access)), getApplicationContext());
384 WebdavClient client
= OwnCloudClientUtils
.createOwnCloudClient(Uri
.parse(mOAuthTokenEndpointText
.getText().toString().trim()), getApplicationContext());
385 operation
.execute(client
, this, mHandler
);
391 * Handles the change of focus on the text inputs for the server URL and the password
393 public void onFocusChange(View view
, boolean hasFocus
) {
394 if (view
.getId() == R
.id
.hostUrlInput
&& !hasFocus
) {
395 onUrlInputFocusLost((TextView
) view
);
397 } else if (view
.getId() == R
.id
.account_password
) {
398 onPasswordFocusChanged((TextView
) view
, hasFocus
);
404 * Handles changes in focus on the text input for the server URL.
406 * IMPORTANT ENTRY POINT 2: When (!hasFocus), user wrote the server URL and changed to
407 * other field. The operation to check the existence of the server in the entered URL is
410 * When hasFocus: user 'comes back' to write again the server URL.
412 * @param hostInput TextView with the URL input field receiving the change of focus.
414 private void onUrlInputFocusLost(TextView hostInput
) {
415 if (!mHostBaseUrl
.equals(normalizeUrl(mHostUrlInput
.getText().toString()))) {
418 mOkButton
.setEnabled(mServerIsValid
);
423 private void checkOcServer() {
424 String uri
= mHostUrlInput
.getText().toString().trim();
425 mServerIsValid
= false
;
426 mServerIsChecked
= false
;
427 mOkButton
.setEnabled(false
);
428 mDiscoveredVersion
= null
;
430 if (uri
.length() != 0) {
431 mServerStatusText
= R
.string
.auth_testing_connection
;
432 mServerStatusIcon
= R
.drawable
.progress_small
;
434 mOcServerChkOperation
= new OwnCloudServerCheckOperation(uri
, this);
435 WebdavClient client
= OwnCloudClientUtils
.createOwnCloudClient(Uri
.parse(uri
), this);
436 mOperationThread
= mOcServerChkOperation
.execute(client
, this, mHandler
);
438 mServerStatusText
= 0;
439 mServerStatusIcon
= 0;
446 * Handles changes in focus on the text input for the password (basic authorization).
448 * When (hasFocus), the button to toggle password visibility is shown.
450 * When (!hasFocus), the button is made invisible and the password is hidden.
452 * @param passwordInput TextView with the password input field receiving the change of focus.
453 * @param hasFocus 'True' if focus is received, 'false' if is lost
455 private void onPasswordFocusChanged(TextView passwordInput
, boolean hasFocus
) {
457 mViewPasswordButton
.setVisibility(View
.VISIBLE
);
459 int input_type
= InputType
.TYPE_CLASS_TEXT
| InputType
.TYPE_TEXT_VARIATION_PASSWORD
;
460 passwordInput
.setInputType(input_type
);
461 mViewPasswordButton
.setVisibility(View
.INVISIBLE
);
468 * Cancels the authenticator activity
470 * IMPORTANT ENTRY POINT 3: Never underestimate the importance of cancellation
472 * This method is bound in the layout/acceoun_setup.xml resource file.
474 * @param view Cancel button
476 public void onCancelClick(View view
) {
477 setResult(RESULT_CANCELED
); // TODO review how is this related to AccountAuthenticator (debugging)
484 * Checks the credentials of the user in the root of the ownCloud server
485 * before creating a new local account.
487 * For basic authorization, a check of existence of the root folder is
490 * For OAuth, starts the flow to get an access token; the credentials test
491 * is postponed until it is available.
493 * IMPORTANT ENTRY POINT 4
495 * @param view OK button
497 public void onOkClick(View view
) {
498 // this check should be unnecessary
499 if (mDiscoveredVersion
== null
|| !mDiscoveredVersion
.isVersionValid() || mHostBaseUrl
== null
|| mHostBaseUrl
.length() == 0) {
500 mServerStatusIcon
= R
.drawable
.common_error
;
501 mServerStatusText
= R
.string
.auth_wtf_reenter_URL
;
503 mOkButton
.setEnabled(false
);
504 Log_OC
.wtf(TAG
, "The user was allowed to click 'connect' to an unchecked server!!");
508 if (mOAuth2Check
.isChecked()) {
509 startOauthorization();
512 checkBasicAuthorization();
518 * Tests the credentials entered by the user performing a check of existence on
519 * the root folder of the ownCloud server.
521 private void checkBasicAuthorization() {
522 /// get the path to the root folder through WebDAV from the version server
523 String webdav_path
= AccountUtils
.getWebdavPath(mDiscoveredVersion
, false
);
525 /// get basic credentials entered by user
526 String username
= mUsernameInput
.getText().toString();
527 String password
= mPasswordInput
.getText().toString();
529 /// be gentle with the user
530 showDialog(DIALOG_LOGIN_PROGRESS
);
532 /// test credentials accessing the root folder
533 mAuthCheckOperation
= new ExistenceCheckOperation("", this, false
);
534 WebdavClient client
= OwnCloudClientUtils
.createOwnCloudClient(Uri
.parse(mHostBaseUrl
+ webdav_path
), this);
535 client
.setBasicCredentials(username
, password
);
536 mOperationThread
= mAuthCheckOperation
.execute(client
, this, mHandler
);
541 * Starts the OAuth 'grant type' flow to get an access token, with
542 * a GET AUTHORIZATION request to the BUILT-IN authorization server.
544 private void startOauthorization() {
545 // be gentle with the user
546 mAuthStatusIcon
= R
.drawable
.progress_small
;
547 mAuthStatusText
= R
.string
.oauth_login_connection
;
550 // GET AUTHORIZATION request
551 //Uri uri = Uri.parse(getString(R.string.oauth2_url_endpoint_auth));
552 Uri uri
= Uri
.parse(mOAuthAuthEndpointText
.getText().toString().trim());
553 Uri
.Builder uriBuilder
= uri
.buildUpon();
554 uriBuilder
.appendQueryParameter(OAuth2Constants
.KEY_RESPONSE_TYPE
, getString(R
.string
.oauth2_response_type
));
555 uriBuilder
.appendQueryParameter(OAuth2Constants
.KEY_REDIRECT_URI
, getString(R
.string
.oauth2_redirect_uri
));
556 uriBuilder
.appendQueryParameter(OAuth2Constants
.KEY_CLIENT_ID
, getString(R
.string
.oauth2_client_id
));
557 uriBuilder
.appendQueryParameter(OAuth2Constants
.KEY_SCOPE
, getString(R
.string
.oauth2_scope
));
558 //uriBuilder.appendQueryParameter(OAuth2Constants.KEY_STATE, whateverwewant);
559 uri
= uriBuilder
.build();
560 Log_OC
.d(TAG
, "Starting browser to view " + uri
.toString());
561 Intent i
= new Intent(Intent
.ACTION_VIEW
, uri
);
567 * Callback method invoked when a RemoteOperation executed by this Activity finishes.
569 * Dispatches the operation flow to the right method.
572 public void onRemoteOperationFinish(RemoteOperation operation
, RemoteOperationResult result
) {
574 if (operation
instanceof OwnCloudServerCheckOperation
) {
575 onOcServerCheckFinish((OwnCloudServerCheckOperation
) operation
, result
);
577 } else if (operation
instanceof OAuth2GetAccessToken
) {
578 onGetOAuthAccessTokenFinish((OAuth2GetAccessToken
)operation
, result
);
580 } else if (operation
instanceof ExistenceCheckOperation
) {
581 onAuthorizationCheckFinish((ExistenceCheckOperation
)operation
, result
);
588 * Processes the result of the server check performed when the user finishes the enter of the
591 * @param operation Server check performed.
592 * @param result Result of the check.
594 private void onOcServerCheckFinish(OwnCloudServerCheckOperation operation
, RemoteOperationResult result
) {
595 if (operation
.equals(mOcServerChkOperation
)) {
596 /// save result state
597 mServerIsChecked
= true
;
598 mServerIsValid
= result
.isSuccess();
599 mIsSslConn
= (result
.getCode() == ResultCode
.OK_SSL
);
600 mOcServerChkOperation
= null
;
602 /// update status icon and text
603 if (mServerIsValid
) {
608 updateServerStatusIconAndText(result
);
611 /// very special case (TODO: move to a common place for all the remote operations)
612 if (result
.getCode() == ResultCode
.SSL_RECOVERABLE_PEER_UNVERIFIED
) {
613 mLastSslUntrustedServerResult
= result
;
614 showDialog(DIALOG_SSL_VALIDATOR
);
617 /// retrieve discovered version and normalize server URL
618 mDiscoveredVersion
= operation
.getDiscoveredVersion();
619 mHostBaseUrl
= normalizeUrl(mHostUrlInput
.getText().toString());
621 /// allow or not the user try to access the server
622 mOkButton
.setEnabled(mServerIsValid
);
624 } // else nothing ; only the last check operation is considered;
625 // multiple can be triggered if the user amends a URL before a previous check can be triggered
629 private String
normalizeUrl(String url
) {
630 if (url
!= null
&& url
.length() > 0) {
632 if (!url
.toLowerCase().startsWith("http://") &&
633 !url
.toLowerCase().startsWith("https://")) {
635 url
= "https://" + url
;
637 url
= "http://" + url
;
641 if (url
.endsWith("/")) {
642 url
= url
.substring(0, url
.length() - 1);
645 return (url
!= null ? url
: "");
649 * Chooses the right icon and text to show to the user for the received operation result.
651 * @param result Result of a remote operation performed in this activity
653 private void updateServerStatusIconAndText(RemoteOperationResult result
) {
654 mServerStatusIcon
= R
.drawable
.common_error
; // the most common case in the switch below
656 switch (result
.getCode()) {
658 mServerStatusIcon
= android
.R
.drawable
.ic_secure
;
659 mServerStatusText
= R
.string
.auth_secure_connection
;
664 if (mHostUrlInput
.getText().toString().trim().toLowerCase().startsWith("http://") ) {
665 mServerStatusText
= R
.string
.auth_connection_established
;
666 mServerStatusIcon
= R
.drawable
.ic_ok
;
668 mServerStatusText
= R
.string
.auth_nossl_plain_ok_title
;
669 mServerStatusIcon
= android
.R
.drawable
.ic_partial_secure
;
673 case NO_NETWORK_CONNECTION
:
674 mServerStatusIcon
= R
.drawable
.no_network
;
675 mServerStatusText
= R
.string
.auth_no_net_conn_title
;
678 case SSL_RECOVERABLE_PEER_UNVERIFIED
:
679 mServerStatusText
= R
.string
.auth_ssl_unverified_server_title
;
682 mServerStatusText
= R
.string
.auth_bad_oc_version_title
;
684 case WRONG_CONNECTION
:
685 mServerStatusText
= R
.string
.auth_wrong_connection_title
;
688 mServerStatusText
= R
.string
.auth_timeout_title
;
690 case INCORRECT_ADDRESS
:
691 mServerStatusText
= R
.string
.auth_incorrect_address_title
;
694 mServerStatusText
= R
.string
.auth_ssl_general_error_title
;
697 mServerStatusText
= R
.string
.auth_unauthorized
;
699 case HOST_NOT_AVAILABLE
:
700 mServerStatusText
= R
.string
.auth_unknown_host_title
;
702 case INSTANCE_NOT_CONFIGURED
:
703 mServerStatusText
= R
.string
.auth_not_configured_title
;
706 mServerStatusText
= R
.string
.auth_incorrect_path_title
;
709 mServerStatusText
= R
.string
.auth_oauth_error
;
711 case OAUTH2_ERROR_ACCESS_DENIED
:
712 mServerStatusText
= R
.string
.auth_oauth_error_access_denied
;
714 case UNHANDLED_HTTP_CODE
:
716 mServerStatusText
= R
.string
.auth_unknown_error_title
;
719 mServerStatusText
= 0;
720 mServerStatusIcon
= 0;
726 * Chooses the right icon and text to show to the user for the received operation result.
728 * @param result Result of a remote operation performed in this activity
730 private void updateAuthStatusIconAndText(RemoteOperationResult result
) {
731 mAuthStatusIcon
= R
.drawable
.common_error
; // the most common case in the switch below
733 switch (result
.getCode()) {
735 mAuthStatusIcon
= android
.R
.drawable
.ic_secure
;
736 mAuthStatusText
= R
.string
.auth_secure_connection
;
741 if (mHostUrlInput
.getText().toString().trim().toLowerCase().startsWith("http://") ) {
742 mAuthStatusText
= R
.string
.auth_connection_established
;
743 mAuthStatusIcon
= R
.drawable
.ic_ok
;
745 mAuthStatusText
= R
.string
.auth_nossl_plain_ok_title
;
746 mAuthStatusIcon
= android
.R
.drawable
.ic_partial_secure
;
750 case NO_NETWORK_CONNECTION
:
751 mAuthStatusIcon
= R
.drawable
.no_network
;
752 mAuthStatusText
= R
.string
.auth_no_net_conn_title
;
755 case SSL_RECOVERABLE_PEER_UNVERIFIED
:
756 mAuthStatusText
= R
.string
.auth_ssl_unverified_server_title
;
759 mAuthStatusText
= R
.string
.auth_bad_oc_version_title
;
761 case WRONG_CONNECTION
:
762 mAuthStatusText
= R
.string
.auth_wrong_connection_title
;
765 mAuthStatusText
= R
.string
.auth_timeout_title
;
767 case INCORRECT_ADDRESS
:
768 mAuthStatusText
= R
.string
.auth_incorrect_address_title
;
771 mAuthStatusText
= R
.string
.auth_ssl_general_error_title
;
774 mAuthStatusText
= R
.string
.auth_unauthorized
;
776 case HOST_NOT_AVAILABLE
:
777 mAuthStatusText
= R
.string
.auth_unknown_host_title
;
779 case INSTANCE_NOT_CONFIGURED
:
780 mAuthStatusText
= R
.string
.auth_not_configured_title
;
783 mAuthStatusText
= R
.string
.auth_incorrect_path_title
;
786 mAuthStatusText
= R
.string
.auth_oauth_error
;
788 case OAUTH2_ERROR_ACCESS_DENIED
:
789 mAuthStatusText
= R
.string
.auth_oauth_error_access_denied
;
791 case UNHANDLED_HTTP_CODE
:
793 mAuthStatusText
= R
.string
.auth_unknown_error_title
;
803 * Processes the result of the request for and access token send
804 * to an OAuth authorization server.
806 * @param operation Operation performed requesting the access token.
807 * @param result Result of the operation.
809 private void onGetOAuthAccessTokenFinish(OAuth2GetAccessToken operation
, RemoteOperationResult result
) {
811 dismissDialog(DIALOG_OAUTH2_LOGIN_PROGRESS
);
812 } catch (IllegalArgumentException e
) {
813 // NOTHING TO DO ; can't find out what situation that leads to the exception in this code, but user logs signal that it happens
816 String webdav_path
= AccountUtils
.getWebdavPath(mDiscoveredVersion
, true
);
817 if (result
.isSuccess() && webdav_path
!= null
) {
818 /// be gentle with the user
819 showDialog(DIALOG_LOGIN_PROGRESS
);
821 /// time to test the retrieved access token on the ownCloud server
822 mOAuthAccessToken
= ((OAuth2GetAccessToken
)operation
).getResultTokenMap().get(OAuth2Constants
.KEY_ACCESS_TOKEN
);
823 Log_OC
.d(TAG
, "Got ACCESS TOKEN: " + mOAuthAccessToken
);
824 mAuthCheckOperation
= new ExistenceCheckOperation("", this, false
);
825 WebdavClient client
= OwnCloudClientUtils
.createOwnCloudClient(Uri
.parse(mHostBaseUrl
+ webdav_path
), this);
826 client
.setBearerCredentials(mOAuthAccessToken
);
827 mAuthCheckOperation
.execute(client
, this, mHandler
);
830 updateAuthStatusIconAndText(result
);
832 Log_OC
.d(TAG
, "Access failed: " + result
.getLogMessage());
838 * Processes the result of the access check performed to try the user credentials.
840 * Creates a new account through the AccountManager.
842 * @param operation Access check performed.
843 * @param result Result of the operation.
845 private void onAuthorizationCheckFinish(ExistenceCheckOperation operation
, RemoteOperationResult result
) {
847 dismissDialog(DIALOG_LOGIN_PROGRESS
);
848 } catch (IllegalArgumentException e
) {
849 // NOTHING TO DO ; can't find out what situation that leads to the exception in this code, but user logs signal that it happens
852 if (result
.isSuccess()) {
853 Log_OC
.d(TAG
, "Successful access - time to save the account");
855 if (mAction
== ACTION_CREATE
) {
865 updateAuthStatusIconAndText(result
);
867 Log_OC
.d(TAG
, "Access failed: " + result
.getLogMessage());
873 * Sets the proper response to get that the Account Authenticator that started this activity saves
874 * a new authorization token for mAccount.
876 private void updateToken() {
877 Bundle response
= new Bundle();
878 response
.putString(AccountManager
.KEY_ACCOUNT_NAME
, mAccount
.name
);
879 response
.putString(AccountManager
.KEY_ACCOUNT_TYPE
, mAccount
.type
);
880 boolean isOAuth
= mOAuth2Check
.isChecked();
882 response
.putString(AccountManager
.KEY_AUTHTOKEN
, mOAuthAccessToken
);
883 // the next line is necessary; by now, notifications are calling directly to the AuthenticatorActivity to update, without AccountManager intervention
884 mAccountMgr
.setAuthToken(mAccount
, AccountAuthenticator
.AUTH_TOKEN_TYPE_ACCESS_TOKEN
, mOAuthAccessToken
);
886 response
.putString(AccountManager
.KEY_AUTHTOKEN
, mPasswordInput
.getText().toString());
887 mAccountMgr
.setPassword(mAccount
, mPasswordInput
.getText().toString());
889 setAccountAuthenticatorResult(response
);
894 * Creates a new account through the Account Authenticator that started this activity.
896 * This makes the account permanent.
898 * TODO Decide how to name the OAuth accounts
900 private void createAccount() {
901 /// create and save new ownCloud account
902 boolean isOAuth
= mOAuth2Check
.isChecked();
904 Uri uri
= Uri
.parse(mHostBaseUrl
);
905 String username
= mUsernameInput
.getText().toString().trim();
907 username
= "OAuth_user" + (new java
.util
.Random(System
.currentTimeMillis())).nextLong();
909 String accountName
= username
+ "@" + uri
.getHost();
910 if (uri
.getPort() >= 0) {
911 accountName
+= ":" + uri
.getPort();
913 mAccount
= new Account(accountName
, AccountAuthenticator
.ACCOUNT_TYPE
);
915 mAccountMgr
.addAccountExplicitly(mAccount
, "", null
); // with our implementation, the password is never input in the app
917 mAccountMgr
.addAccountExplicitly(mAccount
, mPasswordInput
.getText().toString(), null
);
920 /// add the new account as default in preferences, if there is none already
921 Account defaultAccount
= AccountUtils
.getCurrentOwnCloudAccount(this);
922 if (defaultAccount
== null
) {
923 SharedPreferences
.Editor editor
= PreferenceManager
924 .getDefaultSharedPreferences(this).edit();
925 editor
.putString("select_oc_account", accountName
);
929 /// prepare result to return to the Authenticator
930 // TODO check again what the Authenticator makes with it; probably has the same effect as addAccountExplicitly, but it's not well done
931 final Intent intent
= new Intent();
932 intent
.putExtra(AccountManager
.KEY_ACCOUNT_TYPE
, AccountAuthenticator
.ACCOUNT_TYPE
);
933 intent
.putExtra(AccountManager
.KEY_ACCOUNT_NAME
, mAccount
.name
);
935 intent
.putExtra(AccountManager
.KEY_AUTHTOKEN
, AccountAuthenticator
.ACCOUNT_TYPE
); // TODO check this; not sure it's right; maybe
936 intent
.putExtra(AccountManager
.KEY_USERDATA
, username
);
938 mAccountMgr
.setAuthToken(mAccount
, AccountAuthenticator
.AUTH_TOKEN_TYPE_ACCESS_TOKEN
, mOAuthAccessToken
);
940 /// add user data to the new account; TODO probably can be done in the last parameter addAccountExplicitly, or in KEY_USERDATA
941 mAccountMgr
.setUserData(mAccount
, AccountAuthenticator
.KEY_OC_VERSION
, mDiscoveredVersion
.toString());
942 mAccountMgr
.setUserData(mAccount
, AccountAuthenticator
.KEY_OC_BASE_URL
, mHostBaseUrl
);
944 mAccountMgr
.setUserData(mAccount
, AccountAuthenticator
.KEY_SUPPORTS_OAUTH2
, "TRUE"); // TODO this flag should be unnecessary
946 setAccountAuthenticatorResult(intent
.getExtras());
947 setResult(RESULT_OK
, intent
);
949 /// immediately request for the synchronization of the new account
950 Bundle bundle
= new Bundle();
951 bundle
.putBoolean(ContentResolver
.SYNC_EXTRAS_MANUAL
, true
);
952 ContentResolver
.requestSync(mAccount
, AccountAuthenticator
.AUTHORITY
, bundle
);
959 * Necessary to update the contents of the SSL Dialog
961 * TODO move to some common place for all possible untrusted SSL failures
964 protected void onPrepareDialog(int id
, Dialog dialog
, Bundle args
) {
966 case DIALOG_LOGIN_PROGRESS
:
967 case DIALOG_CERT_NOT_SAVED
:
968 case DIALOG_OAUTH2_LOGIN_PROGRESS
:
970 case DIALOG_SSL_VALIDATOR
: {
971 ((SslValidatorDialog
)dialog
).updateResult(mLastSslUntrustedServerResult
);
975 Log_OC
.e(TAG
, "Incorrect dialog called with id = " + id
);
984 protected Dialog
onCreateDialog(int id
) {
985 Dialog dialog
= null
;
987 case DIALOG_LOGIN_PROGRESS
: {
988 /// simple progress dialog
989 ProgressDialog working_dialog
= new ProgressDialog(this);
990 working_dialog
.setMessage(getResources().getString(R
.string
.auth_trying_to_login
));
991 working_dialog
.setIndeterminate(true
);
992 working_dialog
.setCancelable(true
);
994 .setOnCancelListener(new DialogInterface
.OnCancelListener() {
996 public void onCancel(DialogInterface dialog
) {
997 /// TODO study if this is enough
998 Log_OC
.i(TAG
, "Login canceled");
999 if (mOperationThread
!= null
) {
1000 mOperationThread
.interrupt();
1005 dialog
= working_dialog
;
1008 case DIALOG_OAUTH2_LOGIN_PROGRESS
: {
1009 ProgressDialog working_dialog
= new ProgressDialog(this);
1010 working_dialog
.setMessage(String
.format("Getting authorization"));
1011 working_dialog
.setIndeterminate(true
);
1012 working_dialog
.setCancelable(true
);
1014 .setOnCancelListener(new DialogInterface
.OnCancelListener() {
1016 public void onCancel(DialogInterface dialog
) {
1017 Log_OC
.i(TAG
, "Login canceled");
1021 dialog
= working_dialog
;
1024 case DIALOG_SSL_VALIDATOR
: {
1025 /// TODO start to use new dialog interface, at least for this (it is a FragmentDialog already)
1026 dialog
= SslValidatorDialog
.newInstance(this, mLastSslUntrustedServerResult
, this);
1029 case DIALOG_CERT_NOT_SAVED
: {
1030 AlertDialog
.Builder builder
= new AlertDialog
.Builder(this);
1031 builder
.setMessage(getResources().getString(R
.string
.ssl_validator_not_saved
));
1032 builder
.setCancelable(false
);
1033 builder
.setPositiveButton(R
.string
.common_ok
, new DialogInterface
.OnClickListener() {
1035 public void onClick(DialogInterface dialog
, int which
) {
1039 dialog
= builder
.create();
1043 Log_OC
.e(TAG
, "Incorrect dialog called with id = " + id
);
1050 * Starts and activity to open the 'new account' page in the ownCloud web site
1052 * @param view 'Account register' button
1054 public void onRegisterClick(View view
) {
1055 Intent register
= new Intent(Intent
.ACTION_VIEW
, Uri
.parse(getString(R
.string
.url_account_register
)));
1056 setResult(RESULT_CANCELED
);
1057 startActivity(register
);
1062 * Updates the content and visibility state of the icon and text associated
1063 * to the last check on the ownCloud server.
1065 private void showServerStatus() {
1066 TextView tv
= (TextView
) findViewById(R
.id
.server_status_text
);
1068 if (mServerStatusIcon
== 0 && mServerStatusText
== 0) {
1069 tv
.setVisibility(View
.INVISIBLE
);
1072 tv
.setText(mServerStatusText
);
1073 tv
.setCompoundDrawablesWithIntrinsicBounds(mServerStatusIcon
, 0, 0, 0);
1074 tv
.setVisibility(View
.VISIBLE
);
1081 * Updates the content and visibility state of the icon and text associated
1082 * to the interactions with the OAuth authorization server.
1084 private void showAuthStatus() {
1085 if (mAuthStatusIcon
== 0 && mAuthStatusText
== 0) {
1086 mAuthStatusLayout
.setVisibility(View
.INVISIBLE
);
1089 mAuthStatusLayout
.setText(mAuthStatusText
);
1090 mAuthStatusLayout
.setCompoundDrawablesWithIntrinsicBounds(mAuthStatusIcon
, 0, 0, 0);
1091 mAuthStatusLayout
.setVisibility(View
.VISIBLE
);
1096 private void showRefreshButton() {
1097 mHostUrlInput
.setCompoundDrawablesWithIntrinsicBounds(0, 0, R
.drawable
.ic_action_refresh_black
, 0);
1100 private void hideRefreshButton() {
1101 mHostUrlInput
.setCompoundDrawablesWithIntrinsicBounds(0, 0, 0, 0);
1105 * Called when the refresh button in the input field for ownCloud host is clicked.
1107 * Performs a new check on the URL in the input field.
1109 * @param view Refresh 'button'
1111 public void onRefreshClick(View view
) {
1117 * Called when the eye icon in the password field is clicked.
1119 * Toggles the visibility of the password in the field.
1121 * @param view 'View password' 'button'
1123 public void onViewPasswordClick(View view
) {
1124 int selectionStart
= mPasswordInput
.getSelectionStart();
1125 int selectionEnd
= mPasswordInput
.getSelectionEnd();
1126 int input_type
= mPasswordInput
.getInputType();
1127 if ((input_type
& InputType
.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD
) == InputType
.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD
) {
1128 input_type
= InputType
.TYPE_CLASS_TEXT
1129 | InputType
.TYPE_TEXT_VARIATION_PASSWORD
;
1131 input_type
= InputType
.TYPE_CLASS_TEXT
1132 | InputType
.TYPE_TEXT_VARIATION_VISIBLE_PASSWORD
;
1134 mPasswordInput
.setInputType(input_type
);
1135 mPasswordInput
.setSelection(selectionStart
, selectionEnd
);
1140 * Called when the checkbox for OAuth authorization is clicked.
1142 * Hides or shows the input fields for user & password.
1144 * @param view 'View password' 'button'
1146 public void onCheckClick(View view
) {
1147 CheckBox oAuth2Check
= (CheckBox
)view
;
1148 changeViewByOAuth2Check(oAuth2Check
.isChecked());
1153 * Changes the visibility of input elements depending upon the kind of authorization
1154 * chosen by the user: basic or OAuth
1156 * @param checked 'True' when OAuth is selected.
1158 public void changeViewByOAuth2Check(Boolean checked
) {
1161 mOAuthAuthEndpointText
.setVisibility(View
.VISIBLE
);
1162 mOAuthTokenEndpointText
.setVisibility(View
.VISIBLE
);
1163 mUsernameInput
.setVisibility(View
.GONE
);
1164 mPasswordInput
.setVisibility(View
.GONE
);
1165 mViewPasswordButton
.setVisibility(View
.GONE
);
1167 mOAuthAuthEndpointText
.setVisibility(View
.GONE
);
1168 mOAuthTokenEndpointText
.setVisibility(View
.GONE
);
1169 mUsernameInput
.setVisibility(View
.VISIBLE
);
1170 mPasswordInput
.setVisibility(View
.VISIBLE
);
1171 mViewPasswordButton
.setVisibility(View
.INVISIBLE
);
1177 * Called from SslValidatorDialog when a new server certificate was correctly saved.
1179 public void onSavedCertificate() {
1180 mOperationThread
= mOcServerChkOperation
.retry(this, mHandler
);
1184 * Called from SslValidatorDialog when a new server certificate could not be saved
1185 * when the user requested it.
1188 public void onFailedSavingCertificate() {
1189 showDialog(DIALOG_CERT_NOT_SAVED
);
1194 * Called when the 'action' button in an IME is pressed ('enter' in software keyboard).
1196 * Used to trigger the authorization check when the user presses 'enter' after writing the password.
1199 public boolean onEditorAction(TextView inputField
, int actionId
, KeyEvent event
) {
1200 if (inputField
!= null
&& inputField
.equals(mPasswordInput
) &&
1201 actionId
== EditorInfo
.IME_ACTION_DONE
) {
1202 if (mOkButton
.isEnabled()) {
1203 mOkButton
.performClick();
1206 return false
; // always return false to grant that the software keyboard is hidden anyway
1210 private abstract static class RightDrawableOnTouchListener
implements OnTouchListener
{
1212 private int fuzz
= 10;
1218 public boolean onTouch(View view
, MotionEvent event
) {
1219 if (event
.getAction() == MotionEvent
.ACTION_DOWN
) {
1220 Drawable rightDrawable
= null
;
1221 if (view
instanceof TextView
) {
1222 Drawable
[] drawables
= ((TextView
)view
).getCompoundDrawables();
1223 if (drawables
.length
> 2) {
1224 rightDrawable
= drawables
[2];
1227 if (rightDrawable
!= null
) {
1228 final int x
= (int) event
.getX();
1229 final int y
= (int) event
.getY();
1230 final Rect bounds
= rightDrawable
.getBounds();
1231 if (x
>= (view
.getRight() - bounds
.width() - fuzz
) && x
<= (view
.getRight() - view
.getPaddingRight() + fuzz
)
1232 && y
>= (view
.getPaddingTop() - fuzz
) && y
<= (view
.getHeight() - view
.getPaddingBottom()) + fuzz
) {
1234 return onDrawableTouch(event
);
1241 public abstract boolean onDrawableTouch(final MotionEvent event
);