ActivityStarter.java

Go to the documentation of this file.

// -*- mode: java; c-basic-offset: 2; -*-
// Copyright 2009-2011 Google, All Rights reserved
// Copyright 2011-2020 MIT, All rights reserved
// Released under the Apache License, Version 2.0
// http://www.apache.org/licenses/LICENSE-2.0
 
package com.google.appinventor.components.runtime;
 
import android.app.Activity;
 
import android.content.ActivityNotFoundException;
import android.content.ComponentName;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
 
import android.net.Uri;
 
import android.text.TextUtils;
 
import android.util.Log;
 
import com.google.appinventor.components.annotations.DesignerComponent;
import com.google.appinventor.components.annotations.DesignerProperty;
import com.google.appinventor.components.annotations.PropertyCategory;
import com.google.appinventor.components.annotations.SimpleEvent;
import com.google.appinventor.components.annotations.SimpleFunction;
import com.google.appinventor.components.annotations.SimpleObject;
import com.google.appinventor.components.annotations.SimpleProperty;
 
import com.google.appinventor.components.common.ComponentCategory;
import com.google.appinventor.components.common.PropertyTypeConstants;
import com.google.appinventor.components.common.YaVersion;
 
import com.google.appinventor.components.runtime.errors.YailRuntimeError;
 
import com.google.appinventor.components.runtime.util.AnimationUtil;
import com.google.appinventor.components.runtime.util.ErrorMessages;
import com.google.appinventor.components.runtime.util.NougatUtil;
import com.google.appinventor.components.runtime.util.YailList;
 
import java.io.File;
 
@DesignerComponent(version = YaVersion.ACTIVITYSTARTER_COMPONENT_VERSION,
    designerHelpDescription = "A component that can launch an activity " +
    "using the <code>StartActivity</code> method." +
    "<p>Activities that can be launched include: <ul> \n" +
    "<li> starting other App Inventor for Android apps </li> \n" +
    "<li> starting the camera application </li> \n" +
    "<li> performing web search </li> \n" +
    "<li> opening a browser to a specified web page</li> \n" +
    "<li> opening the map application to a specified location</li></ul> \n" +
    "You can also launch activities that return text data.  See the " +
    "documentation on using the Activity Starter for examples.</p>",
 
 
    // TODO(user): Add more information about bringing up maps when
    // the issues with html quoting (bug 2386151) are fixed.
    description = "A component that can launch an activity using " +
    "the <code>StartActivity</code> method. \n" +
    "<p>Activities that can be launched include:<ul> " +
    "<li> Starting another App Inventor for Android app. \n To do so, first " +
    "     find out the <em>class</em> of the other application by " +
    "     downloading the source code and using a file explorer or unzip " +
    "     utility to find a file named " +
    "     \"youngandroidproject/project.properties\".  \n The first line of " +
    "     the file will start with \"main=\" and be followed by the class " +
    "     name; for example, " +
    "     <code>main=com.gmail.Bitdiddle.Ben.HelloPurr.Screen1</code>.  " +
    "     (The first components indicate that it was created by " +
    "     Ben.Bitdiddle@gmail.com.)  \n To make your " +
    "     <code>ActivityStarter</code> launch this application, set the " +
    "     following properties: <ul>\n " +
    "     <li> <code>ActivityPackage</code> to the class name, dropping the " +
    "          last component (for example, " +
    "          <code>com.gmail.Bitdiddle.Ben.HelloPurr</code>)</li>\n " +
    "     <li> <code>ActivityClass</code> to the entire class name (for " +
    "          example, " +
    "          <code>com.gmail.Bitdiddle.Ben.HelloPurr.Screen1</code>)</li> " +
    "     </ul></li> \n" +
    "<li> Starting the camera application by setting the following " +
    "     properties:<ul> \n" +
    "     <li> <code>Action: android.intent.action.MAIN</code> </li> \n" +
    "     <li> <code>ActivityPackage: com.android.camera</code> </li> \n" +
    "     <li> <code>ActivityClass: com.android.camera.Camera</code></li>\n " +
    "     </ul></li>\n" +
    "<li> Performing web search.  Assuming the term you want to search " +
    "     for is \"vampire\" (feel free to substitute your own choice), \n" +
    "     set the properties to:\n<ul><code>" +
    "     <li>Action: android.intent.action.WEB_SEARCH</li> " +
    "     <li>ExtraKey: query</li> " +
    "     <li>ExtraValue: vampire</li> " +
    "     <li>ActivityPackage: com.google.android.providers.enhancedgooglesearch</li>" +
    "     <li>ActivityClass: com.google.android.providers.enhancedgooglesearch.Launcher</li> " +
    "     </code></ul></li> \n" +
    "<li> Opening a browser to a specified web page.  Assuming the page you " +
    "     want to go to is \"www.facebook.com\" (feel free to substitute " +
    "     your own choice), set the properties to:\n<ul><code> " +
    "     <li>Action: android.intent.action.VIEW</li> " +
    "     <li>DataUri: http://www.facebook.com</li> </code> </ul> </li> " +
    "</ul></p>",
    category = ComponentCategory.CONNECTIVITY,
    nonVisible = true,
    iconName = "images/activityStarter.png")
@SimpleObject
public class ActivityStarter extends AndroidNonvisibleComponent
    implements ActivityResultListener, Component, Deleteable {
 
  private String action;
  private String dataUri;
  private String dataType;
  private String activityPackage;
  private String activityClass;
  private String extraKey;
  private String extraValue;
  private String resultName;
  private Intent resultIntent;
  private String result;
  private int requestCode;
  private YailList extras;
  private final ComponentContainer container;
 
  private static final String LOG_TAG = "ActivityStarter";
 
  public ActivityStarter(ComponentContainer container) {
    super(container.$form());
    // Save the container for later
    this.container = container;
    result = "";
    Action(Intent.ACTION_MAIN);
    ActivityPackage("");
    ActivityClass("");
    DataUri("");
    DataType("");
    ExtraKey("");
    ExtraValue("");
    Extras(new YailList());
    ResultName("");
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String Action() {
    return action;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void Action(String action) {
    this.action = action.trim();
  }
 
  // TODO(lizlooney) - currently we support just one extra name/value pair that will be passed to
  // the activity. The user specifies the ExtraKey and ExtraValue properties.
  // We should allow more extra name/value pairs, but we'd need a different interface with regard
  // to properties and functions.
  // In the documentation for Intent, they use the term "name", not "key", and we might want to use
  // the term "name", also.
  // There are backwards compatibility issues with removing the ExtraKey and ExtraValue properties.
  // Also, while extra names are always Strings, the values can be other types. We'd need to know
  // the correct type of the value in order to call the appropriate Intent.putExtra method.
  // Adding multiple functions like PutStringExtra, PutStringArrayExtra, PutCharExtra,
  // PutCharArrayExtra, PutBooleanExtra, PutBooleanArrayExtra, PutByteExtra, PutByteArrayExtra,
  // PutShortExtra, PutShortArrayExtra, PutIntExtra, PutIntArrayExtra, PutLongExtra,
  // PutLongArrayExtra, PutFloatExtra, PutFloatArrayExtra, PutDoubleExtra, PutDoubleArrayExtra,
  // etc, seems like a bad idea.
 
  @SimpleProperty(
      description = "Returns the extra key that will be passed to the activity.\n" +
          "DEPRECATED: New code should use Extras property instead.",
      category = PropertyCategory.BEHAVIOR)
  public String ExtraKey() {
    return extraKey;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void ExtraKey(String extraKey) {
    this.extraKey = extraKey.trim();
  }
 
 
  @SimpleProperty(
      description = "Returns the extra value that will be passed to the activity.\n" +
          "DEPRECATED: New code should use Extras property instead.",
      category = PropertyCategory.BEHAVIOR)
  public String ExtraValue() {
    return extraValue;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void ExtraValue(String extraValue) {
    this.extraValue = extraValue.trim();
  }
 
  // TODO(lizlooney) - currently we support retrieving just one string extra result from the
  // activity. The user specifies the ResultName property and, then after the activity finishes,
  // the string extra result corresponding to ResultName is passed as the result parameter to the
  // AfterActivity event and is also available from the Result property getter.
  // We should allow access to more extra results, but we'd need a different interface with regard
  // to properties, functions, and events parameters.
  // There are backwards compatibility issues with removing the AfterActivity event's result
  // parameter and the Result property.
  // Also, while extra names are always Strings, the values can be other types. We'd need to know
  // the correct type of the value in order to call the appropriate Intent.get...Extra method.
  // Adding multiple functions like GetStringExtra, GetStringArrayExtra, GetCharExtra,
  // GetCharArrayExtra, GetBooleanExtra, GetBooleanArrayExtra, GetByteExtra, GetByteArrayExtra,
  // GetShortExtra, GetShortArrayExtra, GetIntExtra, GetIntArrayExtra, GetLongExtra,
  // GetLongArrayExtra, GetFloatExtra, GetFloatArrayExtra, GetDoubleExtra, GetDoubleArrayExtra,
  // etc, seems like a bad idea.
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String ResultName() {
    return resultName;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void ResultName(String resultName) {
    this.resultName = resultName.trim();
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String Result() {
    return result;
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String DataUri() {
    return dataUri;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void DataUri(String dataUri) {
    this.dataUri = dataUri.trim();
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String DataType() {
    return dataType;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void DataType(String dataType) {
    this.dataType = dataType.trim();
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String ActivityPackage() {
    return activityPackage;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void ActivityPackage(String activityPackage) {
    this.activityPackage = activityPackage.trim();
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String ActivityClass() {
    return activityClass;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_STRING,
      defaultValue = "")
  @SimpleProperty
  public void ActivityClass(String activityClass) {
    this.activityClass = activityClass.trim();
  }
 
  @SimpleEvent(description = "Event raised after this ActivityStarter returns.")
  public void AfterActivity(String result) {
    EventDispatcher.dispatchEvent(this, "AfterActivity", result);
  }
 
  @SimpleEvent(description =
      "Event raised if this ActivityStarter returns because the activity was canceled.")
  public void ActivityCanceled() {
    EventDispatcher.dispatchEvent(this, "ActivityCanceled");
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String ResultType() {
    if (resultIntent != null) {
      String resultType = resultIntent.getType();
      if (resultType != null) {
        return resultType;
      }
    }
    return "";
  }
 
  @SimpleProperty(
      category = PropertyCategory.BEHAVIOR)
  public String ResultUri() {
    if (resultIntent != null) {
      String resultUri = resultIntent.getDataString();
      if (resultUri != null) {
        return resultUri;
      }
    }
    return "";
  }
 
  @SimpleProperty
  public void Extras(YailList pairs) {
    for (Object pair : pairs.toArray()) {
      boolean isYailList = pair instanceof YailList;
      boolean isPair = isYailList ? ((YailList) pair).size() == 2 : false;
      if (!isYailList || !isPair) {
        throw new YailRuntimeError("Argument to Extras should be a list of pairs",
            "ActivityStarter Error");
      }
    }
    extras = pairs;
  }
 
  @SimpleProperty
  public YailList Extras() {
    return extras;
  }
 
 
  @SimpleFunction(description = "Returns the name of the activity that corresponds to this " +
      "ActivityStarter, or an empty string if no corresponding activity can be found.")
  public String ResolveActivity() {
    Intent intent = buildActivityIntent();
    PackageManager pm = container.$context().getPackageManager();
    ResolveInfo resolveInfo = pm.resolveActivity(intent, 0);
    if (resolveInfo != null && resolveInfo.activityInfo != null) {
      return resolveInfo.activityInfo.name;
    }
    return "";
  }
 
  @SimpleFunction(description = "Start the activity corresponding to this ActivityStarter.")
  public void StartActivity() {
    resultIntent = null;
    result = "";
 
    Intent intent = buildActivityIntent();
 
    if (requestCode == 0) {
      // First time, we need to register this as an ActivityResultListener with the Form.
      // The Form's onActivityResult method will be called when the activity returns. If we
      // register with the Form and then use the requestCode when we start an activity, the Form
      // will call our resultReturned method.
      requestCode = form.registerForActivityResult(this);
    }
 
    if (intent == null) {
      form.dispatchErrorOccurredEvent(this, "StartActivity",
        ErrorMessages.ERROR_ACTIVITY_STARTER_NO_ACTION_INFO);
    } else {
      try {
        container.$context().startActivityForResult(intent, requestCode);
        String openAnim = container.$form().getOpenAnimType();
        AnimationUtil.ApplyOpenScreenAnimation(container.$context(), openAnim);
      } catch (ActivityNotFoundException e) {
        form.dispatchErrorOccurredEvent(this, "StartActivity",
          ErrorMessages.ERROR_ACTIVITY_STARTER_NO_CORRESPONDING_ACTIVITY);
      }
    }
  }
 
  private Intent buildActivityIntent() {
    Uri uri = (dataUri.length() != 0) ? Uri.parse(dataUri) : null;
    Intent intent = new Intent(action);
 
    if (uri != null && dataUri.toLowerCase().startsWith("file://") ) {
      Log.d(LOG_TAG, "Using file://");
      File file = new File(uri.getPath());
      if (file.isFile()) {
        Log.d(LOG_TAG, "It's a file");
        uri = NougatUtil.getPackageUri(form, file);
        intent = new Intent(action);
        intent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
        Log.d(LOG_TAG, "added permissions"); // adb log shows this gets printed
      }
    }
 
    if (TextUtils.isEmpty(Action())) {
      return null;
    }
 
    if (dataType.length() != 0) {
      if (uri != null) {
        intent.setDataAndType(uri, dataType);
      } else {
        intent.setType(dataType);
      }
    } else {
      intent.setData(uri);
    }
 
    if (activityPackage.length() != 0 || activityClass.length() != 0) {
      ComponentName component = new ComponentName(activityPackage, activityClass);
      intent.setComponent(component);
    } else if (Action().equals("android.intent.action.MAIN")) {
      return null;
    }
 
    if (extraKey.length() != 0 && extraValue.length() != 0) {
      Log.i(LOG_TAG, "Adding extra, key = " + extraKey + " value = " + extraValue);
      intent.putExtra(extraKey, extraValue);
    }
 
    // If the extra value is a string, put it to the intent. If the extra value is a list
    // of strings, convert it to a java list and put that to the intent.
    for (Object extra : extras.toArray()) {
      YailList castExtra = (YailList) extra;
      String key = castExtra.getString(0);
      Object value = castExtra.getObject(1);
      Log.i(LOG_TAG, "Adding extra, key = " + key + " value = " + value);
      if ((key.length() != 0)) {
        if (value instanceof YailList) {
          Log.i(LOG_TAG, "Adding extra list, key = " + key + " value = " + value);
          intent.putExtra(key, ((YailList) value).toStringArray());
        }
        else {
          String stringValue = castExtra.getString(1);
          Log.i(LOG_TAG, "Adding extra string, key = " + key + " value = " + stringValue);
          intent.putExtra(key, stringValue);
        }
      };
    };
    return intent;
  }
 
  @Override
  public void resultReturned(int requestCode, int resultCode, Intent data) {
    if (requestCode == this.requestCode) {
      Log.i(LOG_TAG, "resultReturned - resultCode = " + resultCode);
      if (resultCode == Activity.RESULT_OK) {
        resultIntent = data;
        if (resultName.length() != 0 && resultIntent != null &&
            resultIntent.hasExtra(resultName)) {
          result = resultIntent.getStringExtra(resultName);
        } else {
          result = "";
        }
        // call user's AfterActivity event handler
        AfterActivity(result);
      } else if (resultCode == Activity.RESULT_CANCELED) {
        ActivityCanceled();
      }
    }
  }
 
  @SimpleEvent(description = "The ActivityError event is no longer used. " +
      "Please use the Screen.ErrorOccurred event instead.",
      userVisible = false)
  public void ActivityError(String message) {
  }
 
  // Deleteable implementation
 
  @Override
  public void onDelete() {
    form.unregisterForActivityResult(this);
  }
}