Add logic to use the special Android files for Messaging (#234)

Author: a-maurice

aar_builder/build_aar.py

@@ -31,6 +31,12 @@
 flags.DEFINE_string("proguard_file", None,
                     "Location of the proguard file to include in the aar")
 flags.mark_flag_as_required("proguard_file")
+flags.DEFINE_string("android_manifest", None,
+                    "Location of the AndroidManifest.xml file to include " +
+                    "in the aar. A default is used if not provided.")
+flags.DEFINE_string("classes_jar", None,
+                    "Location of the classes.jar file to include " + 
+                    "in the aar. A default is used if not provided.")
 
 
 def main(unused_argv):
@@ -45,6 +51,14 @@ def main(unused_argv):
 
   file_dir = os.path.dirname(os.path.realpath(__file__))
 
+  # Use the default or custom AndroidManifest.xml and classes.jar
+  android_manifest_file = os.path.join(file_dir, "AndroidManifest.xml")
+  if FLAGS.android_manifest:
+    android_manifest_file = os.path.normcase(FLAGS.android_manifest)
+  classes_jar_file = os.path.join(file_dir, "classes.jar")
+  if FLAGS.classes_jar:
+    classes_jar_file = os.path.normcase(FLAGS.classes_jar)
+
   # Delete the aar file, if it already exists
   if os.path.exists(output_file):
     os.remove(output_file)
@@ -65,9 +79,8 @@ def main(unused_argv):
 
   with zipfile.ZipFile(output_file, "w") as myzip:
     # Write the generic base files that are required in an aar file.
-    myzip.write(
-        os.path.join(file_dir, "AndroidManifest.xml"), "AndroidManifest.xml")
-    myzip.write(os.path.join(file_dir, "classes.jar"), "classes.jar")
+    myzip.write(android_manifest_file, "AndroidManifest.xml")
+    myzip.write(classes_jar_file, "classes.jar")
     myzip.write(os.path.join(file_dir, "R.txt"), "R.txt")
     myzip.writestr("res/", "")
     # Write the provided library to the proper architecture, and proguard file.

cmake/build_aar.cmake

@@ -29,8 +29,16 @@ set(MAVEN_TEMPLATE ${CMAKE_CURRENT_LIST_DIR}/maven.template)
 #  PROGUARD_TARGET: The target that outputs the proguard file.
 #  ARTIFACT_ID: The artifact id to use with the generated files.
 #  VERSION: The version number to tag the generated files with.
+#
+# Optional Args:
+#  ANDROID_MANIFEST: The custom AndroidManifest file to include.
+#  CLASSES_JAR: The custom classes.jar file to include.
 function(build_aar LIBRARY_NAME LIBRARY_TARGET PROGUARD_TARGET
                    ARTIFACT_ID VERSION)
+  # Parse the additional arguments
+  set(single ANDROID_MANIFEST CLASSES_JAR)
+  cmake_parse_arguments(BUILD_AAR_ARGS "" "${single}" "" ${ARGN})
+
   set(AAR_NAME "${ARTIFACT_ID}-${VERSION}")
   set(OUTPUT_AAR "${CMAKE_CURRENT_BINARY_DIR}/${AAR_NAME}.srcaar")
 
@@ -41,6 +49,8 @@ function(build_aar LIBRARY_NAME LIBRARY_TARGET PROGUARD_TARGET
       "--library_file=$<TARGET_FILE:${LIBRARY_TARGET}>"
       "--architecture=${ANDROID_ABI}"
       "--proguard_file=${${PROGUARD_TARGET}}"
+      "--android_manifest=${BUILD_AAR_ARGS_ANDROID_MANIFEST}"
+      "--classes_jar=${BUILD_AAR_ARGS_CLASSES_JAR}"
     DEPENDS
       "${LIBRARY_TARGET}"
       "${PROGUARD_TARGET}"

cmake/build_firebase_aar.cmake

@@ -24,8 +24,16 @@ include(build_aar)
 #  ARTIFACT_NAME: The name to use in the artifact id.
 #  LIBRARY_TARGET: The target that outputs the shared libary to include.
 #  PROGUARD_TARGET: The target that outputs the proguard file.
+#
+# Optional Args:
+#  ANDROID_MANIFEST: The custom AndroidManifest file to include.
+#  CLASSES_JAR: The custom classes.jar file to include.
 function(build_firebase_aar LIBRARY_NAME ARTIFACT_NAME LIBRARY_TARGET
                             PROGUARD_TARGET)
+  # Parse the additional arguments
+  set(single ANDROID_MANIFEST CLASSES_JAR)
+  cmake_parse_arguments(FIREBASE_AAR_ARGS "" "${single}" "" ${ARGN})
+
   # Set the variables expected by the templates
   set(ARTIFACT_ID "firebase-${ARTIFACT_NAME}-unity")
   set(VERSION "${FIREBASE_UNITY_SDK_VERSION}")
@@ -35,5 +43,9 @@ function(build_firebase_aar LIBRARY_NAME ARTIFACT_NAME LIBRARY_TARGET
     ${PROGUARD_TARGET}
     ${ARTIFACT_ID}
     ${VERSION}
+    ANDROID_MANIFEST
+      ${FIREBASE_AAR_ARGS_ANDROID_MANIFEST}
+    CLASSES_JAR
+      ${FIREBASE_AAR_ARGS_CLASSES_JAR}
   )
 endfunction()

cmake/build_shared.cmake

@@ -23,8 +23,16 @@ include(build_firebase_aar)
 #  LIBRARY_NAME: The name of the library, used to determine the targets.
 #  ARTIFACT_NAME: The name used to generate the artifact id used by the srcaar.
 #  OUTPUT_NAME: The output name to use for the shared library
+#
+# Optional Args:
+#  ANDROID_MANIFEST: The custom AndroidManifest file to include.
+#  CLASSES_JAR: The custom classes.jar file to include.
 function(build_firebase_shared LIBRARY_NAME ARTIFACT_NAME OUTPUT_NAME)
 
+  set(single ANDROID_MANIFEST CLASSES_JAR)
+  # Parse the arguments
+  cmake_parse_arguments(FIREBASE_SHARED_ARGS "" "${single}" "" ${ARGN})
+
   set(shared_target "firebase_${LIBRARY_NAME}_shared")
 
   add_library(${shared_target} SHARED
@@ -93,6 +101,10 @@ function(build_firebase_shared LIBRARY_NAME ARTIFACT_NAME OUTPUT_NAME)
       ${ARTIFACT_NAME}
       ${shared_target}
       "FIREBASE_CPP_${UPPER_BASENAME}_PROGUARD"
+      ANDROID_MANIFEST
+        ${FIREBASE_SHARED_ARGS_ANDROID_MANIFEST}
+      CLASSES_JAR
+        ${FIREBASE_SHARED_ARGS_CLASSES_JAR}
     )
   endif()
 

messaging/CMakeLists.txt

@@ -58,6 +58,10 @@ build_firebase_shared(
   messaging
   messaging
   FirebaseCppMessaging
+  ANDROID_MANIFEST
+    "${CMAKE_CURRENT_LIST_DIR}/AndroidManifest.xml"
+  CLASSES_JAR
+    "${CMAKE_CURRENT_LIST_DIR}/activity/classes.jar"
 )
 endif()
 

messaging/activity/README.md

@@ -0,0 +1,7 @@
+The classes.jar file is a combination of the following:
+ - The MessagingUnityPlayerActivity.java file
+ - The firebase_messaging_cpp.aar file from the Firebase C++ SDK
+ - The java source files from Flatbuffers
+And it is compiled by linking against the UnityPlayerActivity and the classes.jar provided by Unity.
+
+This gets included in the firebase-messaging-unity-{version}.srcaar that is built. For now, we have this file checked in and used directly, but the plan is to switch to generating the classes.jar file as part of the open source build process.