Support opening hex files shared to CreateAI on android

Author: glastonbridge

android/app/src/main/AndroidManifest.xml

@@ -33,15 +33,20 @@
                 <data android:mimeType="application/octet-stream" />
                 <data android:scheme="file" />
                 <data android:scheme="content" />
-
             </intent-filter>
+        </activity>
 
-
+        <activity
+            android:name=".shareplugin.ShareReceiverActivity"
+            android:label="@string/app_name"
+            android:exported="true"
+            android:parentActivityName=".MainActivity"
+            android:excludeFromRecents="true"
+            android:theme="@style/AppTheme.NoActionBar">
             <intent-filter>
                 <action android:name="android.intent.action.SEND" />
                 <category android:name="android.intent.category.DEFAULT" />
-
-                <data android:mimeType="*/*" />
+                <data android:mimeType="application/octet-stream" />
             </intent-filter>
         </activity>
 

android/app/src/main/java/org/microbit/createai/MainActivity.java

@@ -1,15 +1,53 @@
 package org.microbit.createai;
 
+import android.content.Intent;
+import android.net.Uri;
+import android.os.Bundle;
+
 import androidx.activity.EdgeToEdge;
 
 import com.getcapacitor.BridgeActivity;
+import com.getcapacitor.JSObject;
+
+import org.microbit.createai.shareplugin.ShareReceiver;
 
 public class MainActivity extends BridgeActivity {
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        registerPlugin(ShareReceiver.class);
+        super.onCreate(savedInstanceState);
+        handleIncomingIntent(getIntent());
+    }
 
     @Override
     public void onStart() {
         super.onStart();
         EdgeToEdge.enable(this);
     }
 
+    @Override
+    protected void onNewIntent(Intent intent) {
+        super.onNewIntent(intent);
+        handleIncomingIntent(intent);
+    }
+
+    private void handleIncomingIntent(Intent intent) {
+        if (intent == null) return;
+
+        String action = intent.getAction();
+
+        if ("org.microbit.createai.SHARE_PRIVATE".equals(action)) {
+
+            Uri shared = intent.getParcelableExtra("sharedUri");
+
+            if (shared != null) {
+
+                JSObject payload = new JSObject();
+                payload.put("uri", shared.toString());
+
+                getBridge().triggerWindowJSEvent("indirectShareReceived", payload.toString());
+
+            }
+        }
+    }
 }

android/app/src/main/java/org/microbit/createai/shareplugin/ShareReceiver.java

@@ -0,0 +1,88 @@
+package org.microbit.createai.shareplugin;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.Intent;
+import android.database.Cursor;
+import android.net.Uri;
+import android.provider.OpenableColumns;
+
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+
+import org.microbit.createai.MainActivity;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+
+@CapacitorPlugin(name = "ShareReceiver")
+public class ShareReceiver extends Plugin {
+
+    @PluginMethod
+    public void isShare(PluginCall call) {
+        Intent intent = bridge.getActivity().getIntent();
+        String action = intent.getAction();
+        String type = intent.getType();
+        var result = new JSObject();
+        result.put("isShare", Intent.ACTION_SEND.equals(action) && type != null);
+        call.resolve(result);
+    }
+
+    @PluginMethod
+    public void finish(PluginCall call) {
+
+        bridge.getActivity().finish();
+    }
+
+    @PluginMethod
+    public void openMainActivity (PluginCall call) {
+        Activity receiver = getActivity();
+        Intent incoming = receiver.getIntent();
+        Uri shared = incoming.getParcelableExtra(Intent.EXTRA_STREAM);
+
+        Uri localCopy = makeFileLocal(shared);
+
+        int flags = incoming.getFlags() & Intent.FLAG_GRANT_READ_URI_PERMISSION;
+
+        Intent forward = new Intent(this.getActivity(), MainActivity.class);
+        forward.setAction("org.microbit.createai.SHARE_PRIVATE");
+        forward.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP);
+        forward.addFlags(flags);
+        forward.putExtra("sharedUri", localCopy);
+        receiver.startActivity(forward);
+        call.resolve(new JSObject());
+    }
+
+    Uri makeFileLocal(Uri uri) {
+        // get the name
+        Cursor contentCursor =
+                getContext().getContentResolver().query(uri, null, null, null, null);
+        contentCursor.moveToFirst();
+        int nameCol = contentCursor.getColumnIndex(OpenableColumns.DISPLAY_NAME);
+        String fileName = contentCursor.getString(nameCol);
+        contentCursor.close();
+
+        File file = new File(getContext().getFilesDir(), fileName);
+
+        try (FileOutputStream outputStream = getContext().openFileOutput(fileName, Context.MODE_PRIVATE);
+             InputStream inputStream = getContext().getContentResolver().openInputStream(uri)) {
+
+            byte[] buffer = new byte[8192];
+            int n;
+            while ((n = inputStream.read(buffer)) != -1) {
+                outputStream.write(buffer, 0, n);
+            }
+
+            return Uri.fromFile(file);
+        } catch (IOException ioException) {
+            ioException.printStackTrace();
+        }
+        return null;
+    }
+}

android/app/src/main/java/org/microbit/createai/shareplugin/ShareReceiverActivity.java

@@ -0,0 +1,26 @@
+package org.microbit.createai.shareplugin;
+
+import android.os.Bundle;
+
+import com.getcapacitor.BridgeActivity;
+
+public class ShareReceiverActivity extends BridgeActivity {
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        registerPlugin(ShareReceiver.class);
+        super.onCreate(savedInstanceState);
+    }
+
+    @Override
+    public void onPause() {
+        super.onPause();
+        finish();
+    }
+
+    @Override
+    public void onStop() {
+        super.onStop();
+        finish();
+    }
+}

src/components/LoadProjectInput.tsx

@@ -42,7 +42,6 @@ const LoadProjectInput = forwardRef<LoadProjectInputRef, LoadProjectInputProps>(
                 inputRef.current!.value = "";
                 if (filesArray.length === 1) {
                   const { path, name } = filesArray[0];
-                  console.log("Attempting to load", path, name);
                   if (path && name) {
                     loadNativeUrl(path, name);
                   }

src/hooks/project-hooks.tsx

@@ -43,10 +43,17 @@ import {
   readFileAsText,
 } from "../utils/fs-util";
 import { useDownloadActions } from "./download-hooks";
-import { Capacitor } from "@capacitor/core";
+import { Capacitor, registerPlugin } from "@capacitor/core";
 import { App as CapacitorApp } from "@capacitor/app";
 import { Encoding, Filesystem } from "@capacitor/filesystem";
 
+interface ShareReceiverI {
+  isShare(): Promise<{ isShare: boolean }>;
+  openMainActivity(): Promise<void>;
+  finish(): Promise<void>;
+}
+const ShareReceiver = registerPlugin<ShareReceiverI>("ShareReceiver");
+
 class CodeEditorError extends Error {}
 
 /**
@@ -173,21 +180,57 @@ export const ProjectProvider = ({
             path: evt.url,
             encoding: Encoding.UTF8,
           });
-          let filename = evt.url.substring(evt.url.lastIndexOf("/") + 1);
-          // Forgivingly shim broken filenames to hex files,
-          // we can't rely on android to maintain file data.
-          // Even Android's Files app often passes us a broken
-          // filename. MakeCode is resilient to bad files.
-          if (filename.length === 0) {
-            filename = "Unnamed.hex";
-          }
-          if (!filename.includes(".")) {
-            filename += ".hex";
-          }
+          const filename = filenameProbablyHex(
+            evt.url.substring(evt.url.lastIndexOf("/") + 1)
+          );
+
           await importHex(contents.data as string, filename);
         }
       );
 
+      // This part receives projects sent using the Share interface.
+      // The send intent is received using a separate activity, and
+      // sent back to CreateAI's main activity so that it persists
+      // in the app's main process.
+      // See https://github.com/carsten-klaffke/send-intent/issues/69#issuecomment-1544619608
+      const initSendIntent = async () => {
+        const isShare = await ShareReceiver.isShare();
+        if (!isShare.isShare) {
+          return;
+        }
+
+        logging.log("Passing share action to main activity.");
+        await ShareReceiver.openMainActivity(); // reuses the shared object passed in
+        void ShareReceiver.finish();
+      };
+
+      void initSendIntent();
+
+      // This is the portion that gets called in the receiving MainActivity
+      window.addEventListener("indirectShareReceived", async (evt) => {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
+        const path = (evt as any).uri as string;
+
+        const fileExtension = getLowercaseFileExtension(path);
+        logging.event({
+          type: "app-file-share-open",
+          detail: {
+            extension: fileExtension || "none",
+          },
+        });
+
+        const contents = await Filesystem.readFile({
+          path,
+          encoding: Encoding.UTF8,
+        });
+
+        const filename = filenameProbablyHex(
+          path.substring(path.lastIndexOf("/") + 1)
+        );
+
+        await importHex(contents.data as string, filename);
+      });
+
       return () => {
         const removeListenerHandler = async () => {
           void (await appUrlListener).remove();
@@ -580,3 +623,17 @@ export const ProjectProvider = ({
     <ProjectContext.Provider value={value}>{children}</ProjectContext.Provider>
   );
 };
+
+// Forgivingly shim broken filenames into hex files,
+// we can't rely on android to maintain file data.
+// Even Android's Files app often passes us a broken
+// filename. MakeCode is resilient to bad files.
+const filenameProbablyHex = (filename: string) => {
+  if (filename.length === 0) {
+    return "Unnamed.hex";
+  }
+  if (!filename.includes(".")) {
+    return filename + ".hex";
+  }
+  return filename;
+};