Backing out this change for the Droid on suspicion that it's interfering with at...
[zxing.git] / android / src / com / google / zxing / client / android / CaptureActivity.java
index 336ed40..e6f6de8 100755 (executable)
 
 package com.google.zxing.client.android;
 
+import com.google.zxing.BarcodeFormat;
 import com.google.zxing.Result;
 import com.google.zxing.ResultPoint;
+import com.google.zxing.client.android.camera.CameraManager;
+import com.google.zxing.client.android.history.HistoryManager;
 import com.google.zxing.client.android.result.ResultButtonListener;
 import com.google.zxing.client.android.result.ResultHandler;
 import com.google.zxing.client.android.result.ResultHandlerFactory;
+import com.google.zxing.client.android.share.ShareActivity;
 
 import android.app.Activity;
 import android.app.AlertDialog;
@@ -40,6 +44,7 @@ import android.media.MediaPlayer;
 import android.media.MediaPlayer.OnCompletionListener;
 import android.net.Uri;
 import android.os.Bundle;
+import android.os.Handler;
 import android.os.Message;
 import android.os.Vibrator;
 import android.preference.PreferenceManager;
@@ -57,11 +62,16 @@ import android.view.View;
 import android.view.ViewGroup;
 import android.view.Window;
 import android.view.WindowManager;
-import android.widget.Button;
 import android.widget.ImageView;
 import android.widget.TextView;
 
 import java.io.IOException;
+import java.text.DateFormat;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Date;
+import java.util.Vector;
+import java.util.regex.Pattern;
 
 /**
  * The barcode reader activity itself. This is loosely based on the CameraPreview
@@ -70,22 +80,51 @@ import java.io.IOException;
  * @author dswitkin@google.com (Daniel Switkin)
  */
 public final class CaptureActivity extends Activity implements SurfaceHolder.Callback {
-  private static final String TAG = "CaptureActivity";
+
+  private static final String TAG = CaptureActivity.class.getSimpleName();
+
+  private static final Pattern COMMA_PATTERN = Pattern.compile(",");
 
   private static final int SHARE_ID = Menu.FIRST;
-  private static final int SETTINGS_ID = Menu.FIRST + 1;
-  private static final int HELP_ID = Menu.FIRST + 2;
-  private static final int ABOUT_ID = Menu.FIRST + 3;
+  private static final int HISTORY_ID = Menu.FIRST + 1;
+  private static final int SETTINGS_ID = Menu.FIRST + 2;
+  private static final int HELP_ID = Menu.FIRST + 3;
+  private static final int ABOUT_ID = Menu.FIRST + 4;
 
-  private static final int MAX_RESULT_IMAGE_SIZE = 150;
   private static final long INTENT_RESULT_DURATION = 1500L;
-  private static final float BEEP_VOLUME = 0.15f;
+  private static final float BEEP_VOLUME = 0.10f;
   private static final long VIBRATE_DURATION = 200L;
 
   private static final String PACKAGE_NAME = "com.google.zxing.client.android";
   private static final String PRODUCT_SEARCH_URL_PREFIX = "http://www.google";
   private static final String PRODUCT_SEARCH_URL_SUFFIX = "/m/products/scan";
   private static final String ZXING_URL = "http://zxing.appspot.com/scan";
+  private static final String RETURN_CODE_PLACEHOLDER = "{CODE}";
+  private static final String RETURN_URL_PARAM = "ret";
+
+  static final Vector<BarcodeFormat> PRODUCT_FORMATS;
+  static final Vector<BarcodeFormat> ONE_D_FORMATS;
+  static final Vector<BarcodeFormat> QR_CODE_FORMATS;
+  static final Vector<BarcodeFormat> ALL_FORMATS;
+
+  static {
+    PRODUCT_FORMATS = new Vector<BarcodeFormat>(5);
+    PRODUCT_FORMATS.add(BarcodeFormat.UPC_A);
+    PRODUCT_FORMATS.add(BarcodeFormat.UPC_E);
+    PRODUCT_FORMATS.add(BarcodeFormat.EAN_13);
+    PRODUCT_FORMATS.add(BarcodeFormat.EAN_8);
+    PRODUCT_FORMATS.add(BarcodeFormat.RSS14);
+    ONE_D_FORMATS = new Vector<BarcodeFormat>(PRODUCT_FORMATS.size() + 3);
+    ONE_D_FORMATS.addAll(PRODUCT_FORMATS);
+    ONE_D_FORMATS.add(BarcodeFormat.CODE_39);
+    ONE_D_FORMATS.add(BarcodeFormat.CODE_128);
+    ONE_D_FORMATS.add(BarcodeFormat.ITF);
+    QR_CODE_FORMATS = new Vector<BarcodeFormat>(1);
+    QR_CODE_FORMATS.add(BarcodeFormat.QR_CODE);
+    ALL_FORMATS = new Vector<BarcodeFormat>(ONE_D_FORMATS.size() + QR_CODE_FORMATS.size());
+    ALL_FORMATS.addAll(ONE_D_FORMATS);
+    ALL_FORMATS.addAll(QR_CODE_FORMATS);
+  }
 
   private enum Source {
     NATIVE_APP_INTENT,
@@ -94,7 +133,7 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
     NONE
   }
 
-  public CaptureActivityHandler handler;
+  private CaptureActivityHandler handler;
 
   private ViewfinderView viewfinderView;
   private View statusView;
@@ -107,22 +146,33 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
   private boolean copyToClipboard;
   private Source source;
   private String sourceUrl;
-  private String decodeMode;
+  private String returnUrlTemplate;
+  private Vector<BarcodeFormat> decodeFormats;
+  private String characterSet;
   private String versionName;
-  
+  private HistoryManager historyManager;
+
   private final OnCompletionListener beepListener = new BeepListener();
 
   private final DialogInterface.OnClickListener aboutListener =
       new DialogInterface.OnClickListener() {
     public void onClick(DialogInterface dialogInterface, int i) {
       Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(getString(R.string.zxing_url)));
+      intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
       startActivity(intent);
     }
   };
 
+  ViewfinderView getViewfinderView() {
+    return viewfinderView;
+  }
+
+  public Handler getHandler() {
+    return handler;
+  }
+
   @Override
   public void onCreate(Bundle icicle) {
-    Log.i(TAG, "Creating CaptureActivity");
     super.onCreate(icicle);
 
     Window window = getWindow();
@@ -136,6 +186,8 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
     handler = null;
     lastResult = null;
     hasSurface = false;
+    historyManager = new HistoryManager(this);
+    historyManager.trimHistory();
 
     showHelpOnFirstLaunch();
   }
@@ -163,31 +215,35 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
       if (action.equals(Intents.Scan.ACTION)) {
         // Scan the formats the intent requested, and return the result to the calling activity.
         source = Source.NATIVE_APP_INTENT;
-        decodeMode = intent.getStringExtra(Intents.Scan.MODE);
+        decodeFormats = parseDecodeFormats(intent);
         resetStatusView();
       } else if (dataString != null && dataString.contains(PRODUCT_SEARCH_URL_PREFIX) &&
           dataString.contains(PRODUCT_SEARCH_URL_SUFFIX)) {
         // Scan only products and send the result to mobile Product Search.
         source = Source.PRODUCT_SEARCH_LINK;
         sourceUrl = dataString;
-        decodeMode = Intents.Scan.PRODUCT_MODE;
+        decodeFormats = PRODUCT_FORMATS;
         resetStatusView();
-      } else if (dataString != null && dataString.equals(ZXING_URL)) {
-        // Scan all formats and handle the results ourselves.
-        // TODO: In the future we could allow the hyperlink to include a URL to send the results to.
+      } else if (dataString != null && dataString.startsWith(ZXING_URL)) {
+        // Scan formats requested in query string (all formats if none specified).
+        // If a return URL is specified, send the results there. Otherwise, handle the results ourselves.
         source = Source.ZXING_LINK;
         sourceUrl = dataString;
-        decodeMode = null;
+        Uri inputUri = Uri.parse(sourceUrl);
+        returnUrlTemplate = inputUri.getQueryParameter(RETURN_URL_PARAM);
+        decodeFormats = parseDecodeFormats(inputUri);
         resetStatusView();
       } else {
         // Scan all formats and handle the results ourselves (launched from Home).
         source = Source.NONE;
-        decodeMode = null;
+        decodeFormats = null;
         resetStatusView();
       }
+      characterSet = intent.getStringExtra(Intents.Scan.CHARACTER_SET);
     } else {
       source = Source.NONE;
-      decodeMode = null;
+      decodeFormats = null;
+      characterSet = null;
       if (lastResult == null) {
         resetStatusView();
       }
@@ -195,11 +251,62 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
 
     SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
     playBeep = prefs.getBoolean(PreferencesActivity.KEY_PLAY_BEEP, true);
+    if (playBeep) {
+      // See if sound settings overrides this
+      AudioManager audioService = (AudioManager) getSystemService(AUDIO_SERVICE);
+      if (audioService.getRingerMode() != AudioManager.RINGER_MODE_NORMAL) {
+        playBeep = false;
+      }
+    }
     vibrate = prefs.getBoolean(PreferencesActivity.KEY_VIBRATE, false);
     copyToClipboard = prefs.getBoolean(PreferencesActivity.KEY_COPY_TO_CLIPBOARD, true);
     initBeepSound();
   }
 
+  private static Vector<BarcodeFormat> parseDecodeFormats(Intent intent) {
+    List<String> scanFormats = null;
+    String scanFormatsString = intent.getStringExtra(Intents.Scan.SCAN_FORMATS);
+    if (scanFormatsString != null) {
+      scanFormats = Arrays.asList(COMMA_PATTERN.split(scanFormatsString));
+    }
+    return parseDecodeFormats(scanFormats, intent.getStringExtra(Intents.Scan.MODE));
+  }
+
+  private static Vector<BarcodeFormat> parseDecodeFormats(Uri inputUri) {
+    List<String> formats = inputUri.getQueryParameters(Intents.Scan.SCAN_FORMATS);
+    if (formats != null && formats.size() == 1 && formats.get(0) != null){
+      formats = Arrays.asList(COMMA_PATTERN.split(formats.get(0)));
+    }
+    return parseDecodeFormats(formats, inputUri.getQueryParameter(Intents.Scan.MODE));
+  }
+
+  private static Vector<BarcodeFormat> parseDecodeFormats(List<String> scanFormats,
+                                                          String decodeMode) {
+    if (scanFormats != null) {
+      Vector<BarcodeFormat> formats = new Vector<BarcodeFormat>();
+      try {
+        for (String format : scanFormats) {
+          formats.add(BarcodeFormat.valueOf(format));
+        }
+        return formats;
+      } catch (IllegalArgumentException iae) {
+        // ignore it then
+      }
+    }
+    if (decodeMode != null) {
+      if (Intents.Scan.PRODUCT_MODE.equals(decodeMode)) {
+        return PRODUCT_FORMATS;
+      }
+      if (Intents.Scan.QR_CODE_MODE.equals(decodeMode)) {
+        return QR_CODE_FORMATS;
+      }
+      if (Intents.Scan.ONE_D_MODE.equals(decodeMode)) {
+        return ONE_D_FORMATS;
+      }
+    }
+    return null;
+  }
+
   @Override
   protected void onPause() {
     super.onPause();
@@ -219,7 +326,9 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
         return true;
       } else if ((source == Source.NONE || source == Source.ZXING_LINK) && lastResult != null) {
         resetStatusView();
-        handler.sendEmptyMessage(R.id.restart_preview);
+        if (handler != null) {
+          handler.sendEmptyMessage(R.id.restart_preview);
+        }
         return true;
       }
     } else if (keyCode == KeyEvent.KEYCODE_FOCUS || keyCode == KeyEvent.KEYCODE_CAMERA) {
@@ -232,7 +341,10 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
   @Override
   public boolean onCreateOptionsMenu(Menu menu) {
     super.onCreateOptionsMenu(menu);
-    menu.add(0, SHARE_ID, 0, R.string.menu_share).setIcon(R.drawable.share_menu_item);
+    menu.add(0, SHARE_ID, 0, R.string.menu_share)
+        .setIcon(android.R.drawable.ic_menu_share);
+    menu.add(0, HISTORY_ID, 0, R.string.menu_history)
+        .setIcon(android.R.drawable.ic_menu_recent_history);
     menu.add(0, SETTINGS_ID, 0, R.string.menu_settings)
         .setIcon(android.R.drawable.ic_menu_preferences);
     menu.add(0, HELP_ID, 0, R.string.menu_help)
@@ -255,18 +367,26 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
     switch (item.getItemId()) {
       case SHARE_ID: {
         Intent intent = new Intent(Intent.ACTION_VIEW);
+        intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
         intent.setClassName(this, ShareActivity.class.getName());
         startActivity(intent);
         break;
       }
+      case HISTORY_ID: {
+        AlertDialog historyAlert = historyManager.buildAlert();
+        historyAlert.show();
+        break;
+      }
       case SETTINGS_ID: {
         Intent intent = new Intent(Intent.ACTION_VIEW);
+        intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
         intent.setClassName(this, PreferencesActivity.class.getName());
         startActivity(intent);
         break;
       }
       case HELP_ID: {
         Intent intent = new Intent(Intent.ACTION_VIEW);
+        intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
         intent.setClassName(this, HelpActivity.class.getName());
         startActivity(intent);
         break;
@@ -313,18 +433,29 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
    */
   public void handleDecode(Result rawResult, Bitmap barcode) {
     lastResult = rawResult;
-    playBeepSoundAndVibrate();
-    drawResultPoints(barcode, rawResult);
-
-    switch (source) {
-      case NATIVE_APP_INTENT:
-      case PRODUCT_SEARCH_LINK:
-        handleDecodeExternally(rawResult, barcode);
-        break;
-      case ZXING_LINK:
-      case NONE:
-        handleDecodeInternally(rawResult, barcode);
-        break;
+    historyManager.addHistoryItem(rawResult);
+    if (barcode == null) {
+      // This is from history -- no saved barcode
+      handleDecodeInternally(rawResult, null);
+    } else {
+      playBeepSoundAndVibrate();
+      drawResultPoints(barcode, rawResult);
+      switch (source) {
+        case NATIVE_APP_INTENT:
+        case PRODUCT_SEARCH_LINK:
+          handleDecodeExternally(rawResult, barcode);
+          break;
+        case ZXING_LINK:
+          if(returnUrlTemplate == null){
+            handleDecodeInternally(rawResult, barcode);
+          } else {
+            handleDecodeExternally(rawResult, barcode);
+          }
+          break;
+        case NONE:
+          handleDecodeInternally(rawResult, barcode);
+          break;
+      }
     }
   }
 
@@ -366,19 +497,30 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
     resultView.setVisibility(View.VISIBLE);
 
     ImageView barcodeImageView = (ImageView) findViewById(R.id.barcode_image_view);
-    barcodeImageView.setMaxWidth(MAX_RESULT_IMAGE_SIZE);
-    barcodeImageView.setMaxHeight(MAX_RESULT_IMAGE_SIZE);
-    barcodeImageView.setImageBitmap(barcode);
+    if (barcode == null) {
+      barcodeImageView.setImageResource(R.drawable.zxing_icon);
+    } else {
+      barcodeImageView.setImageBitmap(barcode);
+    }
+    barcodeImageView.setVisibility(View.VISIBLE);
 
     TextView formatTextView = (TextView) findViewById(R.id.format_text_view);
+    formatTextView.setVisibility(View.VISIBLE);
     formatTextView.setText(getString(R.string.msg_default_format) + ": " +
         rawResult.getBarcodeFormat().toString());
 
     ResultHandler resultHandler = ResultHandlerFactory.makeResultHandler(this, rawResult);
     TextView typeTextView = (TextView) findViewById(R.id.type_text_view);
+    typeTextView.setVisibility(View.VISIBLE);
     typeTextView.setText(getString(R.string.msg_default_type) + ": " +
         resultHandler.getType().toString());
 
+    DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);
+    String formattedTime = formatter.format(new Date(rawResult.getTimestamp()));
+    TextView timeTextView = (TextView) findViewById(R.id.time_text_view);
+    timeTextView.setVisibility(View.VISIBLE);
+    timeTextView.setText(getString(R.string.msg_default_time) + ": " + formattedTime);
+
     TextView contentsTextView = (TextView) findViewById(R.id.contents_text_view);
     CharSequence title = getString(resultHandler.getDisplayTitle());
     SpannableStringBuilder styled = new SpannableStringBuilder(title + "\n\n");
@@ -391,7 +533,7 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
     ViewGroup buttonView = (ViewGroup) findViewById(R.id.result_button_view);
     buttonView.requestFocus();
     for (int x = 0; x < ResultHandler.MAX_BUTTON_COUNT; x++) {
-      Button button = (Button) buttonView.getChildAt(x);
+      TextView button = (TextView) buttonView.getChildAt(x);
       if (x < buttonCount) {
         button.setVisibility(View.VISIBLE);
         button.setText(resultHandler.getButtonText(x));
@@ -431,6 +573,7 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
       // Hand back whatever action they requested - this can be changed to Intents.Scan.ACTION when
       // the deprecated intent is retired.
       Intent intent = new Intent(getIntent().getAction());
+      intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
       intent.putExtra(Intents.Scan.RESULT, rawResult.toString());
       intent.putExtra(Intents.Scan.RESULT_FORMAT, rawResult.getBarcodeFormat().toString());
       Message message = Message.obtain(handler, R.id.return_scan_result);
@@ -444,6 +587,12 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
       message.obj = sourceUrl.substring(0, end) + "?q=" +
           resultHandler.getDisplayContents().toString() + "&source=zxing";
       handler.sendMessageDelayed(message, INTENT_RESULT_DURATION);
+    } else if (source == Source.ZXING_LINK) {
+      // Replace each occurrence of RETURN_CODE_PLACEHOLDER in the returnUrlTemplate
+      // with the scanned code. This allows both queries and REST-style URLs to work.
+      Message message = Message.obtain(handler, R.id.launch_product_query);
+      message.obj = returnUrlTemplate.replace(RETURN_CODE_PLACEHOLDER, resultHandler.getDisplayContents().toString());
+      handler.sendMessageDelayed(message, INTENT_RESULT_DURATION);
     }
   }
 
@@ -452,7 +601,7 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
    * run. The easiest way to do this is to check android:versionCode from the manifest, and compare
    * it to a value stored as a preference.
    */
-  private void showHelpOnFirstLaunch() {
+  private boolean showHelpOnFirstLaunch() {
     try {
       PackageInfo info = getPackageManager().getPackageInfo(PACKAGE_NAME, 0);
       int currentVersion = info.versionCode;
@@ -463,13 +612,18 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
       int lastVersion = prefs.getInt(PreferencesActivity.KEY_HELP_VERSION_SHOWN, 0);
       if (currentVersion > lastVersion) {
         prefs.edit().putInt(PreferencesActivity.KEY_HELP_VERSION_SHOWN, currentVersion).commit();
-        Intent intent = new Intent(Intent.ACTION_VIEW);
-        intent.setClassName(this, HelpActivity.class.getName());
+        Intent intent = new Intent(this, HelpActivity.class);
+        intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
+        // Show the default page on a clean install, and the what's new page on an upgrade.
+        String page = (lastVersion == 0) ? HelpActivity.DEFAULT_PAGE : HelpActivity.WHATS_NEW_PAGE;
+        intent.putExtra(HelpActivity.REQUESTED_PAGE_KEY, page);
         startActivity(intent);
+        return true;
       }
     } catch (PackageManager.NameNotFoundException e) {
       Log.w(TAG, e);
     }
+    return false;
   }
 
   /**
@@ -478,8 +632,11 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
    */
   private void initBeepSound() {
     if (playBeep && mediaPlayer == null) {
+      // The volume on STREAM_SYSTEM is not adjustable, and users found it too loud,
+      // so we now play on the music stream.
+      setVolumeControlStream(AudioManager.STREAM_MUSIC);
       mediaPlayer = new MediaPlayer();
-      mediaPlayer.setAudioStreamType(AudioManager.STREAM_SYSTEM);
+      mediaPlayer.setAudioStreamType(AudioManager.STREAM_MUSIC);
       mediaPlayer.setOnCompletionListener(beepListener);
 
       AssetFileDescriptor file = getResources().openRawResourceFd(R.raw.beep);
@@ -510,14 +667,33 @@ public final class CaptureActivity extends Activity implements SurfaceHolder.Cal
       CameraManager.get().openDriver(surfaceHolder);
     } catch (IOException ioe) {
       Log.w(TAG, ioe);
+      displayFrameworkBugMessageAndExit();
+      return;
+    } catch (RuntimeException e) {
+      // Barcode Scanner has seen crashes in the wild of this variety:
+      // java.?lang.?RuntimeException: Fail to connect to camera service
+      Log.w(TAG, "Unexpected error initializating camera", e);
+      displayFrameworkBugMessageAndExit();
       return;
     }
     if (handler == null) {
       boolean beginScanning = lastResult == null;
-      handler = new CaptureActivityHandler(this, decodeMode, beginScanning);
+      handler = new CaptureActivityHandler(this, decodeFormats, characterSet, beginScanning);
     }
   }
 
+  private void displayFrameworkBugMessageAndExit() {
+    AlertDialog.Builder builder = new AlertDialog.Builder(this);
+    builder.setTitle(getString(R.string.app_name));
+    builder.setMessage(getString(R.string.msg_camera_framework_bug));
+    builder.setPositiveButton(R.string.button_ok, new DialogInterface.OnClickListener() {
+      public void onClick(DialogInterface dialogInterface, int i) {
+        finish();
+      }
+    });
+    builder.show();
+  }
+
   private void resetStatusView() {
     resultView.setVisibility(View.GONE);
     statusView.setVisibility(View.VISIBLE);