Added @UsesXmls annotation which allows to create xml files in APK resources #3292

patryk84a · 2024-12-14T02:35:47Z

General items:

I have updated the relevant documentation files under docs/
My code follows the:
- Google Java style guide (for .java files)
- Google JavaScript style guide (for .js files)
ant tests passes on my machine

If your code changes how something works on the device (i.e., it affects the companion):

I branched from ucr
My pull request has ucr as the base

Further, if you've changed the blocks language or another user-facing designer/blocks API (added a SimpleProperty, etc.):

I have updated the corresponding version number in appinventor/components/src/.../common/YaVersion.java
I have updated the corresponding upgrader in appinventor/appengine/src/.../client/youngandroid/YoungAndroidFormUpgrader.java (components only)
I have updated the corresponding entries in appinventor/blocklyeditor/src/versioning.js

For all other changes:

I branched from master
My pull request has master as the base

What does this PR accomplish?

I think this will solve some problems caused by lack of resources in APK.

We can only create xml files and only in these folders with different configurations:

layout, values, drawable, mipmap, xml, color, menu, animator, anim

Example usage:

@UsesXmls(xmls = {
    @XmlElement(dir = "xml",
                name = "automotive_app_desc.xml",
                content = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<automotiveApp>\n<uses name=\"media\"/>\n</automotiveApp>")
})

Reference:
https://developer.android.com/guide/topics/resources/providing-resources.html

Resolves #3246 .

…sources.

AppInventorWorkerBee · 2024-12-14T02:35:50Z

Can one of the admins verify this patch?

ewpatton · 2024-12-14T16:02:03Z

@AppInventorWorkerBee ok to test

ewpatton · 2024-12-14T17:07:32Z

appinventor/components/src/com/google/appinventor/components/annotations/UsesXmls.java

+// Copyright 2009-2011 Google, All Rights reserved
+// Copyright 2011-2024 MIT, All rights reserved


ewpatton · 2024-12-14T18:28:24Z

appinventor/components/src/com/google/appinventor/components/scripts/ComponentProcessor.java

+  // Transform a @XmlElement into an String for use later
+  // in creating xml files.
+  private static String xmlElementToString(XmlElement element)
+      throws IllegalAccessException, InvocationTargetException {


It's not clear that these exceptions should ever be thrown in this context.

ewpatton · 2024-12-14T18:28:41Z

appinventor/components/src/com/google/appinventor/components/scripts/ComponentProcessor.java

+      } catch (IllegalAccessException e) {
+        messager.printMessage(Diagnostic.Kind.ERROR, "IllegalAccessException when gathering " +
+            "xml attributes and subelements for component " + componentInfo.name);
+        throw new RuntimeException(e);
+      } catch (InvocationTargetException e) {


See my note below about whether these exceptions can ever be thrown.

ewpatton · 2024-12-14T18:32:12Z

...entor/buildserver/src/com/google/appinventor/buildserver/tasks/common/LoadComponentInfo.java

@@ -243,7 +244,7 @@ private boolean generateServices() {
  private boolean generateContentProviders() {
    try {
      loadJsonInfo(context.getComponentInfo().getContentProvidersNeeded(),
-          ComponentDescriptorConstants.SERVICES_TARGET);
+          ComponentDescriptorConstants.CONTENT_PROVIDERS_TARGET);


I believe this was addressed in #3279

Ok so I'll remove this change.

ewpatton · 2024-12-15T04:19:23Z

appinventor/buildserver/src/com/google/appinventor/buildserver/tasks/android/XmlConfig.java

+    for (Map.Entry<String, Set<String>> component : xmlsNeeded.entrySet()) {
+      for (String xml : component.getValue()) {
+        String[] parts = xml.split(":", 2);
+        context.getReporter().log("Creating " + parts[0]);


We probably don't need to log every single file getting created.

ewpatton · 2024-12-15T04:35:02Z

appinventor/buildserver/src/com/google/appinventor/buildserver/tasks/android/XmlConfig.java

+                createDir(context.getPaths().getResDir(), new File(parts[0]).getParent()),
+                new File(parts[0]).getName());


We should probably do some validation of parts[0] here. My concern is that a maliciously crafted components.json might have something like "../../../../../aapt" or similar in an attempt to overwrite executable files outside of the build directory.

I think we can't overwrite other files than XML because the file extension is hardcoded. UsesXmls only specifies the file name. But I assumed that the file will be saved only in a single folder nesting. I haven't tested it with a larger nesting. Maybe we need to validate by checking the first folder names and limit to a few hardcoded names like xml, drawable etc.

My point is that if you edit the JSON file you can make the filename be something else since the .xml is added at the point of the component processing when the extension is built, not at app build time, which is when this code is run. It would be less of a problem if you added the ".xml" here rather than in the component processor (which would be behavior that matches your statement).

Ok, I've researched and tested a few things. We can create any folder but it won't be included in the android resources. We have to use android defined folders. A folder can't contain a subfolder. Names can contain lowercase and uppercase letters, numbers, underscore, dash and plus (including configuration), can't start with numbers. I will use this to return an error for the file or folder name if it is outside of this range.

path.matches("^(?:(layout|values|drawable|mipmap|xml|color|menu|animator|anim)[a-zA-Z0-9-+_]*/)?[a-z][a-zA-Z0-9-+_.]*$")

As for the .xml extension, I think to check it, if the file contains the .xml extension, we can leave it, if it does not contain the extension, I will add it. If it contains another extension, return an error or change it to xml?

Reference:
https://developer.android.com/guide/topics/resources/providing-resources.html

Added @UsesXmls annotation which allows to create xml files in APK re…

ee49ac5

…sources.

ewpatton requested a review from a team December 14, 2024 16:00

ewpatton self-assigned this Dec 14, 2024

ewpatton added pull request: needs review feature request affects: master android labels Dec 14, 2024

ewpatton requested changes Dec 15, 2024

View reviewed changes

ewpatton added pull request: needs reply to review and removed pull request: needs review labels Dec 15, 2024

patryk84a added 3 commits December 18, 2024 20:42

Improved path validation, and a few others

33e8f9b

Corrected a small logical error

86ce8a7

Small corrected

e7a9a8b

patryk84a requested a review from ewpatton December 18, 2024 21:42

Reverting the content provider fix.

5bfd4b6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added @UsesXmls annotation which allows to create xml files in APK resources #3292

Added @UsesXmls annotation which allows to create xml files in APK resources #3292

patryk84a commented Dec 14, 2024 •

edited

Loading

AppInventorWorkerBee commented Dec 14, 2024

ewpatton commented Dec 14, 2024

ewpatton Dec 14, 2024

ewpatton Dec 14, 2024

ewpatton Dec 14, 2024

ewpatton Dec 14, 2024

patryk84a Dec 16, 2024

ewpatton Dec 15, 2024

ewpatton Dec 15, 2024

patryk84a Dec 16, 2024

ewpatton Dec 16, 2024

patryk84a Dec 17, 2024 •

edited

Loading

		// Copyright 2009-2011 Google, All Rights reserved
		// Copyright 2011-2024 MIT, All rights reserved

		createDir(context.getPaths().getResDir(), new File(parts[0]).getParent()),
		new File(parts[0]).getName());

Added @UsesXmls annotation which allows to create xml files in APK resources #3292

Are you sure you want to change the base?

Added @UsesXmls annotation which allows to create xml files in APK resources #3292

Conversation

patryk84a commented Dec 14, 2024 • edited Loading

AppInventorWorkerBee commented Dec 14, 2024

ewpatton commented Dec 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patryk84a Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

patryk84a commented Dec 14, 2024 •

edited

Loading

patryk84a Dec 17, 2024 •

edited

Loading