src/com/owncloud/android/ui/activity/PassCodeActivity.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author Bartek Przybylski
   5  *   @author masensio
   6  *   @author David A. Velasco
   7  *   Copyright (C) 2011 Bartek Przybylski
   8  *   Copyright (C) 2015 ownCloud Inc.
   9  *
  10  *   This program is free software: you can redistribute it and/or modify
  11  *   it under the terms of the GNU General Public License version 2,
  12  *   as published by the Free Software Foundation.
  13  *
  14  *   This program is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  */
  23 package com.owncloud.android.ui.activity;
  24
  25 import java.util.Arrays;
  26
  27 import android.content.SharedPreferences;
  28 import android.os.Bundle;
  29 import android.preference.PreferenceManager;
  30 import android.text.Editable;
  31 import android.text.TextWatcher;
  32 import android.view.KeyEvent;
  33 import android.view.View;
  34 import android.view.View.OnClickListener;
  35 import android.widget.Button;
  36 import android.widget.EditText;
  37 import android.widget.TextView;
  38 import android.widget.Toast;
  39
  40 import com.actionbarsherlock.app.ActionBar;
  41 import com.actionbarsherlock.app.SherlockFragmentActivity;
  42 import com.owncloud.android.R;
  43 import com.owncloud.android.lib.common.utils.Log_OC;
  44 import com.owncloud.android.utils.DisplayUtils;
  45
  46 public class PassCodeActivity extends SherlockFragmentActivity {
  47
  48
  49     private static final String TAG = PassCodeActivity.class.getSimpleName();
  50
  51     public final static String ACTION_ENABLE = PassCodeActivity.class.getCanonicalName() + ".ENABLE";
  52     public final static String ACTION_DISABLE = PassCodeActivity.class.getCanonicalName() + ".DISABLE";
  53     public final static String ACTION_REQUEST = PassCodeActivity.class.getCanonicalName()  + ".REQUEST";
  54
  55     private Button mBCancel;
  56     private TextView mPassCodeHdr;
  57     private TextView mPassCodeHdrExplanation;
  58     private EditText[] mPassCodeEditTexts = new EditText[4];
  59
  60     private String [] mPassCodeDigits = {"","","",""};
  61     private boolean mConfirmingPassCode = false;
  62
  63     private boolean mBChange = true; // to control that only one blocks jump
  64
  65
  66     /**
  67      * Initializes the activity.
  68      *
  69      * An intent with a valid ACTION is expected; if none is found, an {@link IllegalArgumentException} will be thrown.
  70      *
  71      * @param savedInstanceState    Previously saved state - irrelevant in this case
  72      */
  73     protected void onCreate(Bundle savedInstanceState) {
  74         super.onCreate(savedInstanceState);
  75         setContentView(R.layout.passcodelock);
  76
  77         mBCancel = (Button) findViewById(R.id.cancel);
  78         mPassCodeHdr = (TextView) findViewById(R.id.header);
  79         mPassCodeHdrExplanation = (TextView) findViewById(R.id.explanation);
  80         mPassCodeEditTexts[0] = (EditText) findViewById(R.id.txt0);
  81         mPassCodeEditTexts[0].requestFocus();
  82         getWindow().setSoftInputMode(android.view.WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE);
  83         mPassCodeEditTexts[1] = (EditText) findViewById(R.id.txt1);
  84         mPassCodeEditTexts[2] = (EditText) findViewById(R.id.txt2);
  85         mPassCodeEditTexts[3] = (EditText) findViewById(R.id.txt3);
  86
  87         if (ACTION_REQUEST.equals(getIntent().getAction())) {
  88             /// this is a pass code request; the user has to input the right value
  89             mPassCodeHdr.setText(R.string.pass_code_enter_pass_code);
  90             mPassCodeHdrExplanation.setVisibility(View.INVISIBLE);
  91             setCancelButtonEnabled(false);      // no option to cancel
  92
  93         } else if (ACTION_ENABLE.equals(getIntent().getAction())) {
  94             /// pass code preference has just been activated in Preferences; will receive and confirm pass code value
  95             mPassCodeHdr.setText(R.string.pass_code_configure_your_pass_code);
  96             //mPassCodeHdr.setText(R.string.pass_code_enter_pass_code); // TODO choose a header, check iOS
  97             mPassCodeHdrExplanation.setVisibility(View.VISIBLE);
  98             setCancelButtonEnabled(true);
  99
 100         } else if (ACTION_DISABLE.equals(getIntent().getAction())) {
 101             /// pass code preference has just been disabled in Preferences;
 102             // will confirm user knows pass code, then remove it
 103             mPassCodeHdr.setText(R.string.pass_code_remove_your_pass_code);
 104             mPassCodeHdrExplanation.setVisibility(View.INVISIBLE);
 105             setCancelButtonEnabled(true);
 106
 107         } else {
 108             throw new IllegalArgumentException("A valid ACTION is needed in the Intent passed to " + TAG);
 109         }
 110
 111         setTextListeners();
 112
 113         ActionBar actionBar = getSupportActionBar();
 114         actionBar.setIcon(DisplayUtils.getSeasonalIconId());
 115     }
 116
 117
 118     /**
 119      * Enables or disables the cancel button to allow the user interrupt the ACTION requested to the activity.
 120      *
 121      * @param enabled       'True' makes the cancel button available, 'false' hides it.
 122      */
 123     protected void setCancelButtonEnabled(boolean enabled){
 124         if(enabled){
 125             mBCancel.setVisibility(View.VISIBLE);
 126             mBCancel.setOnClickListener(new OnClickListener() {
 127                 @Override
 128                 public void onClick(View v) {
 129                     revertActionAndExit();
 130                 }
 131             });
 132         } else {
 133             mBCancel.setVisibility(View.GONE);
 134             mBCancel.setVisibility(View.INVISIBLE);
 135             mBCancel.setOnClickListener(null);
 136         }
 137     }
 138
 139
 140     /**
 141      * Binds the appropiate listeners to the input boxes receiving each digit of the pass code.
 142      */
 143     protected void setTextListeners() {
 144
 145          ///  First input field
 146         mPassCodeEditTexts[0].addTextChangedListener(new PassCodeDigitTextWatcher(0, false));
 147
 148
 149         /*------------------------------------------------
 150          *  SECOND BOX
 151          -------------------------------------------------*/
 152         mPassCodeEditTexts[1].addTextChangedListener(new PassCodeDigitTextWatcher(1, false));
 153
 154         mPassCodeEditTexts[1].setOnKeyListener(new View.OnKeyListener() {
 155
 156             @Override
 157             public boolean onKey(View v, int keyCode, KeyEvent event) {
 158                 if (keyCode == KeyEvent.KEYCODE_DEL && mBChange) {  // TODO WIP: event should be used to control what's exactly happening with DEL, not any custom field...
 159                     mPassCodeEditTexts[0].setText("");
 160                     mPassCodeEditTexts[0].requestFocus();
 161                     if (!mConfirmingPassCode)
 162                         mPassCodeDigits[0] = "";
 163                     mBChange = false;
 164
 165                 } else if (!mBChange) {
 166                     mBChange = true;
 167                 }
 168                 return false;
 169             }
 170         });
 171
 172         mPassCodeEditTexts[1].setOnFocusChangeListener(new View.OnFocusChangeListener() {
 173
 174             @Override
 175             public void onFocusChange(View v, boolean hasFocus) {
 176                 /// TODO WIP: should take advantage of hasFocus to reduce processing
 177                 if (mPassCodeEditTexts[0].getText().toString().equals("")) {    // TODO WIP validation could be done in a global way, with a single OnFocusChangeListener for all the input fields
 178                     mPassCodeEditTexts[0].requestFocus();
 179                 }
 180             }
 181         });
 182
 183
 184         /*------------------------------------------------
 185          *  THIRD BOX
 186          -------------------------------------------------*/
 187         mPassCodeEditTexts[2].addTextChangedListener(new PassCodeDigitTextWatcher(2, false));
 188
 189         mPassCodeEditTexts[2].setOnKeyListener(new View.OnKeyListener() {
 190
 191             @Override
 192             public boolean onKey(View v, int keyCode, KeyEvent event) {
 193                 if (keyCode == KeyEvent.KEYCODE_DEL && mBChange) {
 194                     mPassCodeEditTexts[1].requestFocus();
 195                     if (!mConfirmingPassCode)
 196                         mPassCodeDigits[1] = "";
 197                     mPassCodeEditTexts[1].setText("");
 198                     mBChange = false;
 199
 200                 } else if (!mBChange) {
 201                     mBChange = true;
 202
 203                 }
 204                 return false;
 205             }
 206         });
 207
 208         mPassCodeEditTexts[2].setOnFocusChangeListener(new View.OnFocusChangeListener() {
 209
 210             @Override
 211             public void onFocusChange(View v, boolean hasFocus) {
 212                 if (mPassCodeEditTexts[0].getText().toString().equals("")) {
 213                     mPassCodeEditTexts[0].requestFocus();
 214                 } else if (mPassCodeEditTexts[1].getText().toString().equals("")) {
 215                     mPassCodeEditTexts[1].requestFocus();
 216                 }
 217             }
 218         });
 219
 220
 221         /*------------------------------------------------
 222          *  FOURTH BOX
 223          -------------------------------------------------*/
 224         mPassCodeEditTexts[3].addTextChangedListener(new PassCodeDigitTextWatcher(3, true));
 225
 226         mPassCodeEditTexts[3].setOnKeyListener(new View.OnKeyListener() {
 227
 228             @Override
 229             public boolean onKey(View v, int keyCode, KeyEvent event) {
 230                 if (keyCode == KeyEvent.KEYCODE_DEL && mBChange) {
 231                     mPassCodeEditTexts[2].requestFocus();
 232                     if (!mConfirmingPassCode)
 233                         mPassCodeDigits[2] = "";
 234                     mPassCodeEditTexts[2].setText("");
 235                     mBChange = false;
 236
 237                 } else if (!mBChange) {
 238                     mBChange = true;
 239                 }
 240                 return false;
 241             }
 242         });
 243
 244         mPassCodeEditTexts[3].setOnFocusChangeListener(new View.OnFocusChangeListener() {
 245
 246             @Override
 247             public void onFocusChange(View v, boolean hasFocus) {
 248
 249                 if (mPassCodeEditTexts[0].getText().toString().equals("")) {
 250                     mPassCodeEditTexts[0].requestFocus();
 251                 } else if (mPassCodeEditTexts[1].getText().toString().equals("")) {
 252                     mPassCodeEditTexts[1].requestFocus();
 253                 } else if (mPassCodeEditTexts[2].getText().toString().equals("")) {
 254                     mPassCodeEditTexts[2].requestFocus();
 255                 }
 256
 257             }
 258         });
 259
 260     } // end setTextListener
 261
 262
 263     /**
 264      * Processes the pass code entered by the user just after the last digit was in.
 265      *
 266      * Takes into account the action requested to the activity, the currently saved pass code and the previously
 267      * typed pass code, if any.
 268      */
 269     private void processFullPassCode() {
 270         if (ACTION_REQUEST.equals(getIntent().getAction())) {
 271             if (checkPassCode()) {
 272                 /// pass code accepted in request, user is allowed to access the app
 273                 finish();
 274
 275             }  else {
 276                 showErrorAndRestart(R.string.common_error, R.string.pass_code_enter_pass_code, View.INVISIBLE);
 277                     /// TODO better error message
 278             }
 279
 280         } else if (ACTION_DISABLE.equals(getIntent().getAction())) {
 281             if (checkPassCode()) {
 282                 /// pass code accepted when disabling, pass code is removed
 283                 SharedPreferences.Editor appPrefs = PreferenceManager
 284                         .getDefaultSharedPreferences(getApplicationContext()).edit();
 285                 appPrefs.putBoolean("set_pincode", false);  // TODO remove; this should be unnecessary, was done before entering in the activity
 286                 appPrefs.commit();
 287
 288                 Toast.makeText(PassCodeActivity.this, R.string.pass_code_removed, Toast.LENGTH_LONG).show();
 289                 finish();
 290
 291             } else {
 292                 showErrorAndRestart(R.string.common_error, R.string.pass_code_enter_pass_code, View.INVISIBLE);
 293                     /// TODO better error message
 294             }
 295
 296         } else if (ACTION_ENABLE.equals(getIntent().getAction())) {
 297             /// enabling pass code
 298             if (!mConfirmingPassCode) {
 299                 requestPassCodeConfirmation();
 300
 301             } else if (confirmPassCode()) {
 302                 /// confirmed: user typed the same pass code twice
 303                 savePassCodeAndExit();
 304
 305             } else {
 306                 showErrorAndRestart(
 307                         R.string.pass_code_mismatch, R.string.pass_code_configure_your_pass_code, View.VISIBLE
 308                 );
 309             }
 310         }
 311     }
 312
 313
 314     private void showErrorAndRestart(int errorMessage, int headerMessage, int explanationVisibility) {
 315         Arrays.fill(mPassCodeDigits, null);
 316         CharSequence errorSeq = getString(errorMessage);
 317         Toast.makeText(this, errorSeq, Toast.LENGTH_LONG).show();
 318         mPassCodeHdr.setText(headerMessage);                // TODO check if really needed
 319         mPassCodeHdrExplanation.setVisibility(explanationVisibility);  // TODO check if really needed
 320         clearBoxes();
 321     }
 322
 323
 324     /**
 325      * Ask to the user for retyping the pass code just entered before saving it as the current pass code.
 326      */
 327     protected void requestPassCodeConfirmation(){
 328         clearBoxes();
 329         mPassCodeHdr.setText(R.string.pass_code_reenter_your_pass_code);
 330         mPassCodeHdrExplanation.setVisibility(View.INVISIBLE);
 331         mConfirmingPassCode = true;
 332     }
 333
 334     /**
 335      * Compares pass code entered by the user with the value currently saved in the app.
 336      *
 337      * @return     'True' if entered pass code equals to the saved one.
 338      */
 339     protected boolean checkPassCode(){
 340         SharedPreferences appPrefs = PreferenceManager
 341             .getDefaultSharedPreferences(getApplicationContext());
 342
 343         String savedPassCodeDigits[] = new String[4];
 344         savedPassCodeDigits[0] = appPrefs.getString("PrefPinCode1", null);
 345         savedPassCodeDigits[1] = appPrefs.getString("PrefPinCode2", null);
 346         savedPassCodeDigits[2] = appPrefs.getString("PrefPinCode3", null);
 347         savedPassCodeDigits[3] = appPrefs.getString("PrefPinCode4", null);
 348
 349         boolean result = true;
 350         for (int i = 0; i < mPassCodeDigits.length && result; i++) {
 351             result = result && (mPassCodeDigits[i] != null) && mPassCodeDigits[i].equals(savedPassCodeDigits[i]);
 352         }
 353         return result;
 354     }
 355
 356     /**
 357      * Compares pass code retyped by the user in the input fields with the value entered just before.
 358      *
 359      * @return     'True' if retyped pass code equals to the entered before.
 360      */
 361     protected boolean confirmPassCode(){
 362         mConfirmingPassCode = false;
 363
 364         boolean result = true;
 365         for (int i = 0; i < mPassCodeEditTexts.length && result; i++) {
 366             result = result && ((mPassCodeEditTexts[i].getText().toString()).equals(mPassCodeDigits[i]));
 367         }
 368         return result;
 369     }
 370
 371     /**
 372      * Sets the input fields to empty strings and puts the focus on the first one.
 373      */
 374     protected void clearBoxes(){
 375         for (int i=0; i < mPassCodeEditTexts.length; i++) {
 376             mPassCodeEditTexts[i].setText("");
 377         }
 378         mPassCodeEditTexts[0].requestFocus();
 379     }
 380
 381     /**
 382      * Overrides click on the BACK arrow to correctly cancel ACTION_ENABLE or ACTION_DISABLE, while preventing
 383      * than ACTION_REQUEST may be worked around.
 384      *
 385      * @param keyCode       Key code of the key that triggered the down event.
 386      * @param event         Event triggered.
 387      * @return              'True' when the key event was processed by this method.
 388      */
 389     @Override
 390     public boolean onKeyDown(int keyCode, KeyEvent event){
 391         if (keyCode == KeyEvent.KEYCODE_BACK && event.getRepeatCount()== 0){
 392             if (ACTION_ENABLE.equals(getIntent().getAction()) || ACTION_DISABLE.equals(getIntent().getAction())) {
 393                 revertActionAndExit();
 394             }
 395             return true;
 396         }
 397         return super.onKeyDown(keyCode, event);
 398     }
 399
 400     /**
 401      * Saves the pass code input by the user as the current pass code.
 402      */
 403     protected void savePassCodeAndExit() {
 404         SharedPreferences.Editor appPrefs = PreferenceManager
 405                 .getDefaultSharedPreferences(getApplicationContext()).edit();
 406
 407         appPrefs.putString("PrefPinCode1", mPassCodeDigits[0]);
 408         appPrefs.putString("PrefPinCode2", mPassCodeDigits[1]);
 409         appPrefs.putString("PrefPinCode3", mPassCodeDigits[2]);
 410         appPrefs.putString("PrefPinCode4", mPassCodeDigits[3]);
 411         appPrefs.putBoolean("set_pincode", true);    /// TODO remove; unnecessary, Preferences did it before entering here
 412         appPrefs.commit();
 413
 414         Toast.makeText(this, R.string.pass_code_stored, Toast.LENGTH_LONG).show();
 415         finish();
 416     }
 417
 418     /**
 419      * Cancellation of ACTION_ENABLE or ACTION_DISABLE; reverts the enable or disable action done by
 420      * {@link Preferences}, then finishes.
 421      */
 422     protected void revertActionAndExit() {
 423         SharedPreferences.Editor appPrefsE = PreferenceManager
 424                 .getDefaultSharedPreferences(getApplicationContext()).edit();
 425
 426         SharedPreferences appPrefs = PreferenceManager
 427                 .getDefaultSharedPreferences(getApplicationContext());
 428
 429         boolean state = appPrefs.getBoolean("set_pincode", false);
 430         appPrefsE.putBoolean("set_pincode", !state);
 431         // TODO WIP: this is reverting the value of the preference because it was changed BEFORE entering
 432         // TODO         in this activity; was the PreferenceCheckBox in the caller who did it
 433         appPrefsE.commit();
 434         finish();
 435     }
 436
 437
 438     private class PassCodeDigitTextWatcher implements TextWatcher {
 439
 440         private int mIndex = -1;
 441         private boolean mLastOne = false;
 442
 443         /**
 444          * Constructor
 445          *
 446          * @param index         Position in the pass code of the input field that will be bound to this watcher.
 447          * @param lastOne       'True' means that watcher corresponds to the last position of the pass code.
 448          */
 449         public PassCodeDigitTextWatcher(int index, boolean lastOne) {
 450             mIndex = index;
 451             mLastOne  = lastOne;
 452             if (mIndex < 0) {
 453                 throw new IllegalArgumentException(
 454                         "Invalid index in " + PassCodeDigitTextWatcher.class.getSimpleName() + " constructor"
 455                 );
 456             }
 457         }
 458
 459         private int next() {
 460             return mLastOne ? 0 : mIndex + 1;
 461         }
 462
 463         /**
 464          * Performs several actions when the user types a digit in an input field:
 465          *  - saves the input digit to the state of the activity; this will allow retyping the pass code to confirm it.
 466          *  - moves the focus automatically to the next field
 467          *  - for the last field, triggers the processing of the full pass code
 468          *
 469          * @param s
 470          */
 471         @Override
 472         public void afterTextChanged(Editable s) {
 473             if (s.length() > 0) {
 474                 if (!mConfirmingPassCode) {
 475                     mPassCodeDigits[mIndex] = mPassCodeEditTexts[mIndex].getText().toString();
 476                 }
 477                 mPassCodeEditTexts[next()].requestFocus();
 478
 479                 if (mLastOne) {
 480                     processFullPassCode();
 481                 }
 482
 483             } else {
 484                 Log_OC.d(TAG, "Text box " + mIndex + " was cleaned");
 485             }
 486         }
 487
 488         @Override
 489         public void beforeTextChanged(CharSequence s, int start, int count, int after) {
 490             // nothing to do
 491         }
 492
 493         @Override
 494         public void onTextChanged(CharSequence s, int start, int before, int count) {
 495             // nothing to do
 496         }
 497
 498     }
 499
 500
 501 }