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[1].setSelected(false);
 179                     mPassCodeEditTexts[0].requestFocus();
 180                     mPassCodeEditTexts[0].setSelected(true);   // TODO WIP really needed? is it for the colour highlight
 181                     mPassCodeEditTexts[0].setSelection(0);     // TODO WIP what is THIS for?
 182                 }
 183
 184             }
 185         });
 186
 187
 188         /*------------------------------------------------
 189          *  THIRD BOX
 190          -------------------------------------------------*/
 191         mPassCodeEditTexts[2].addTextChangedListener(new PassCodeDigitTextWatcher(2, false));
 192
 193         mPassCodeEditTexts[2].setOnKeyListener(new View.OnKeyListener() {
 194
 195             @Override
 196             public boolean onKey(View v, int keyCode, KeyEvent event) {
 197                 if (keyCode == KeyEvent.KEYCODE_DEL && mBChange) {
 198                     mPassCodeEditTexts[1].requestFocus();
 199                     if (!mConfirmingPassCode)
 200                         mPassCodeDigits[1] = "";
 201                     mPassCodeEditTexts[1].setText("");
 202                     mBChange = false;
 203
 204                 } else if (!mBChange) {
 205                     mBChange = true;
 206
 207                 }
 208                 return false;
 209             }
 210         });
 211
 212         mPassCodeEditTexts[2].setOnFocusChangeListener(new View.OnFocusChangeListener() {
 213
 214             @Override
 215             public void onFocusChange(View v, boolean hasFocus) {
 216                 if (mPassCodeEditTexts[0].getText().toString().equals("")) {
 217                     mPassCodeEditTexts[2].setSelected(false);
 218                     mPassCodeEditTexts[0].requestFocus();
 219                     mPassCodeEditTexts[0].setSelected(true);
 220                     mPassCodeEditTexts[0].setSelection(0);
 221                 } else if (mPassCodeEditTexts[1].getText().toString().equals("")) {
 222                     mPassCodeEditTexts[2].setSelected(false);
 223                     mPassCodeEditTexts[1].requestFocus();
 224                     mPassCodeEditTexts[1].setSelected(true);
 225                     mPassCodeEditTexts[1].setSelection(0);
 226                 }
 227
 228             }
 229         });
 230
 231
 232         /*------------------------------------------------
 233          *  FOURTH BOX
 234          -------------------------------------------------*/
 235         mPassCodeEditTexts[3].addTextChangedListener(new PassCodeDigitTextWatcher(3, true));
 236
 237         mPassCodeEditTexts[3].setOnKeyListener(new View.OnKeyListener() {
 238
 239             @Override
 240             public boolean onKey(View v, int keyCode, KeyEvent event) {
 241                 if (keyCode == KeyEvent.KEYCODE_DEL && mBChange) {
 242                     mPassCodeEditTexts[2].requestFocus();
 243                     if (!mConfirmingPassCode)
 244                         mPassCodeDigits[2] = "";
 245                     mPassCodeEditTexts[2].setText("");
 246                     mBChange = false;
 247
 248                 } else if (!mBChange) {
 249                     mBChange = true;
 250                 }
 251                 return false;
 252             }
 253         });
 254
 255         mPassCodeEditTexts[3].setOnFocusChangeListener(new View.OnFocusChangeListener() {
 256
 257             @Override
 258             public void onFocusChange(View v, boolean hasFocus) {
 259
 260                 if (mPassCodeEditTexts[0].getText().toString().equals("")) {
 261                     mPassCodeEditTexts[3].setSelected(false);
 262                     mPassCodeEditTexts[0].requestFocus();
 263                     mPassCodeEditTexts[0].setSelected(true);
 264                     mPassCodeEditTexts[0].setSelection(0);
 265                 } else if (mPassCodeEditTexts[1].getText().toString().equals("")) {
 266                     mPassCodeEditTexts[3].setSelected(false);
 267                     mPassCodeEditTexts[1].requestFocus();
 268                     mPassCodeEditTexts[1].setSelected(true);
 269                     mPassCodeEditTexts[1].setSelection(0);
 270                 } else if (mPassCodeEditTexts[2].getText().toString().equals("")) {
 271                     mPassCodeEditTexts[3].setSelected(false);
 272                     mPassCodeEditTexts[2].requestFocus();
 273                     mPassCodeEditTexts[2].setSelected(true);
 274                     mPassCodeEditTexts[2].setSelection(0);
 275                 }
 276
 277             }
 278         });
 279
 280     } // end setTextListener
 281
 282
 283     /**
 284      * Processes the pass code entered by the user just after the last digit was in.
 285      *
 286      * Takes into account the action requested to the activity, the currently saved pass code and the previously
 287      * typed pass code, if any.
 288      */
 289     private void processFullPassCode() {
 290         if (ACTION_REQUEST.equals(getIntent().getAction())) {
 291             if (checkPassCode()) {
 292                 /// pass code accepted in request, user is allowed to access the app
 293                 finish();
 294
 295             }  else {
 296                 showErrorAndRestart(R.string.common_error, R.string.pass_code_enter_pass_code, View.INVISIBLE);
 297                     /// TODO better error message
 298             }
 299
 300         } else if (ACTION_DISABLE.equals(getIntent().getAction())) {
 301             if (checkPassCode()) {
 302                 /// pass code accepted when disabling, pass code is removed
 303                 SharedPreferences.Editor appPrefs = PreferenceManager
 304                         .getDefaultSharedPreferences(getApplicationContext()).edit();
 305                 appPrefs.putBoolean("set_pincode", false);  // TODO remove; this should be unnecessary, was done before entering in the activity
 306                 appPrefs.commit();
 307
 308                 Toast.makeText(PassCodeActivity.this, R.string.pass_code_removed, Toast.LENGTH_LONG).show();
 309                 finish();
 310
 311             } else {
 312                 showErrorAndRestart(R.string.common_error, R.string.pass_code_enter_pass_code, View.INVISIBLE);
 313                     /// TODO better error message
 314             }
 315
 316         } else if (ACTION_ENABLE.equals(getIntent().getAction())) {
 317             /// enabling pass code
 318             if (!mConfirmingPassCode) {
 319                 requestPassCodeConfirmation();
 320
 321             } else if (confirmPassCode()) {
 322                 /// confirmed: user typed the same pass code twice
 323                 savePassCodeAndExit();
 324
 325             } else {
 326                 showErrorAndRestart(
 327                         R.string.pass_code_mismatch, R.string.pass_code_configure_your_pass_code, View.VISIBLE
 328                 );
 329             }
 330         }
 331     }
 332
 333
 334     private void showErrorAndRestart(int errorMessage, int headerMessage, int explanationVisibility) {
 335         Arrays.fill(mPassCodeDigits, null);
 336         CharSequence errorSeq = getString(errorMessage);
 337         Toast.makeText(this, errorSeq, Toast.LENGTH_LONG).show();
 338         mPassCodeHdr.setText(headerMessage);                // TODO check if really needed
 339         mPassCodeHdrExplanation.setVisibility(explanationVisibility);  // TODO check if really needed
 340         clearBoxes();
 341     }
 342
 343
 344     /**
 345      * Ask to the user for retyping the pass code just entered before saving it as the current pass code.
 346      */
 347     protected void requestPassCodeConfirmation(){
 348         clearBoxes();
 349         mPassCodeHdr.setText(R.string.pass_code_reenter_your_pass_code);
 350         mPassCodeHdrExplanation.setVisibility(View.INVISIBLE);
 351         mConfirmingPassCode = true;
 352     }
 353
 354     /**
 355      * Compares pass code entered by the user with the value currently saved in the app.
 356      *
 357      * @return     'True' if entered pass code equals to the saved one.
 358      */
 359     protected boolean checkPassCode(){
 360         SharedPreferences appPrefs = PreferenceManager
 361             .getDefaultSharedPreferences(getApplicationContext());
 362
 363         String savedPassCodeDigits[] = new String[4];
 364         savedPassCodeDigits[0] = appPrefs.getString("PrefPinCode1", null);
 365         savedPassCodeDigits[1] = appPrefs.getString("PrefPinCode2", null);
 366         savedPassCodeDigits[2] = appPrefs.getString("PrefPinCode3", null);
 367         savedPassCodeDigits[3] = appPrefs.getString("PrefPinCode4", null);
 368
 369         boolean result = true;
 370         for (int i = 0; i < mPassCodeDigits.length && result; i++) {
 371             result = result && (mPassCodeDigits[i] != null) && mPassCodeDigits[i].equals(savedPassCodeDigits[i]);
 372         }
 373         return result;
 374     }
 375
 376     /**
 377      * Compares pass code retyped by the user in the input fields with the value entered just before.
 378      *
 379      * @return     'True' if retyped pass code equals to the entered before.
 380      */
 381     protected boolean confirmPassCode(){
 382         mConfirmingPassCode = false;
 383
 384         boolean result = true;
 385         for (int i = 0; i < mPassCodeEditTexts.length && result; i++) {
 386             result = result && ((mPassCodeEditTexts[i].getText().toString()).equals(mPassCodeDigits[i]));
 387         }
 388         return result;
 389     }
 390
 391     /**
 392      * Sets the input fields to empty strings and puts the focus on the first one.
 393      */
 394     protected void clearBoxes(){
 395         for (int i=0; i < mPassCodeEditTexts.length; i++) {
 396             mPassCodeEditTexts[i].setText("");
 397         }
 398         mPassCodeEditTexts[0].requestFocus();
 399     }
 400
 401     /**
 402      * Overrides click on the BACK arrow to correctly cancel ACTION_ENABLE or ACTION_DISABLE, while preventing
 403      * than ACTION_REQUEST may be worked around.
 404      *
 405      * @param keyCode       Key code of the key that triggered the down event.
 406      * @param event         Event triggered.
 407      * @return              'True' when the key event was processed by this method.
 408      */
 409     @Override
 410     public boolean onKeyDown(int keyCode, KeyEvent event){
 411         if (keyCode == KeyEvent.KEYCODE_BACK && event.getRepeatCount()== 0){
 412             if (ACTION_ENABLE.equals(getIntent().getAction()) || ACTION_DISABLE.equals(getIntent().getAction())) {
 413                 revertActionAndExit();
 414             }
 415             return true;
 416         }
 417         return super.onKeyDown(keyCode, event);
 418     }
 419
 420     /**
 421      * Saves the pass code input by the user as the current pass code.
 422      */
 423     protected void savePassCodeAndExit() {
 424         SharedPreferences.Editor appPrefs = PreferenceManager
 425                 .getDefaultSharedPreferences(getApplicationContext()).edit();
 426
 427         appPrefs.putString("PrefPinCode1", mPassCodeDigits[0]);
 428         appPrefs.putString("PrefPinCode2", mPassCodeDigits[1]);
 429         appPrefs.putString("PrefPinCode3", mPassCodeDigits[2]);
 430         appPrefs.putString("PrefPinCode4", mPassCodeDigits[3]);
 431         appPrefs.putBoolean("set_pincode", true);    /// TODO remove; unnecessary, Preferences did it before entering here
 432         appPrefs.commit();
 433
 434         Toast.makeText(this, R.string.pass_code_stored, Toast.LENGTH_LONG).show();
 435         finish();
 436     }
 437
 438     /**
 439      * Cancellation of ACTION_ENABLE or ACTION_DISABLE; reverts the enable or disable action done by
 440      * {@link Preferences}, then finishes.
 441      */
 442     protected void revertActionAndExit() {
 443         SharedPreferences.Editor appPrefsE = PreferenceManager
 444                 .getDefaultSharedPreferences(getApplicationContext()).edit();
 445
 446         SharedPreferences appPrefs = PreferenceManager
 447                 .getDefaultSharedPreferences(getApplicationContext());
 448
 449         boolean state = appPrefs.getBoolean("set_pincode", false);
 450         appPrefsE.putBoolean("set_pincode", !state);
 451         // TODO WIP: this is reverting the value of the preference because it was changed BEFORE entering
 452         // TODO         in this activity; was the PreferenceCheckBox in the caller who did it
 453         appPrefsE.commit();
 454         finish();
 455     }
 456
 457
 458     private class PassCodeDigitTextWatcher implements TextWatcher {
 459
 460         private int mIndex = -1;
 461         private boolean mLastOne = false;
 462
 463         /**
 464          * Constructor
 465          *
 466          * @param index         Position in the pass code of the input field that will be bound to this watcher.
 467          * @param lastOne       'True' means that watcher corresponds to the last position of the pass code.
 468          */
 469         public PassCodeDigitTextWatcher(int index, boolean lastOne) {
 470             mIndex = index;
 471             mLastOne  = lastOne;
 472             if (mIndex < 0) {
 473                 throw new IllegalArgumentException(
 474                         "Invalid index in " + PassCodeDigitTextWatcher.class.getSimpleName() + " constructor"
 475                 );
 476             }
 477         }
 478
 479         private int next() {
 480             return mLastOne ? 0 : mIndex + 1;
 481         }
 482
 483         /**
 484          * Performs several actions when the user types a digit in an input field:
 485          *  - saves the input digit to the state of the activity; this will allow retyping the pass code to confirm it.
 486          *  - moves the focus automatically to the next field
 487          *  - for the last field, triggers the processing of the full pass code
 488          *
 489          * @param s
 490          */
 491         @Override
 492         public void afterTextChanged(Editable s) {
 493             if (s.length() > 0) {
 494                 if (!mConfirmingPassCode) {
 495                     mPassCodeDigits[mIndex] = mPassCodeEditTexts[mIndex].getText().toString();
 496                 }
 497                 mPassCodeEditTexts[next()].requestFocus();
 498
 499                 if (mLastOne) {
 500                     processFullPassCode();
 501                 }
 502
 503             } else {
 504                 Log_OC.d(TAG, "Text box " + mIndex + " was cleaned");
 505             }
 506         }
 507
 508         @Override
 509         public void beforeTextChanged(CharSequence s, int start, int count, int after) {
 510             // nothing to do
 511         }
 512
 513         @Override
 514         public void onTextChanged(CharSequence s, int start, int before, int count) {
 515             // nothing to do
 516         }
 517
 518     }
 519
 520
 521 }