Updated Analytics Windows to allow multiple DLL hashes, and add usage of Options struct.

analytics/CMakeLists.txt

@@ -104,6 +104,9 @@ set_property(TARGET firebase_analytics PROPERTY FOLDER "Firebase Cpp")
 # Set up the dependency on Firebase App.
 target_link_libraries(firebase_analytics
     PUBLIC firebase_app)
+if(WIN32)
+  target_link_libraries(firebase_analytics PRIVATE Crypt32.lib)
+endif()
 # Public headers all refer to each other relative to the src/include directory,
 # while private headers are relative to the entire C++ SDK directory.
 target_include_directories(firebase_analytics

analytics/generate_windows_stubs.py

@@ -55,13 +55,34 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
     initialized pointers, and a dynamic loading function for Windows.
 
     Args:
-        header_file_path (str): The path to the DLL file.
+        dll_file_path (str): The path to the DLL file.
         header_file_path (str): The path to the input C header file.
         output_h_path (str): The path for the generated C header output file.
         output_c_path (str): The path for the generated C source output file.
     """
     print(f"Reading DLL file: {dll_file_path}")
-    dll_hash = hash_file(dll_file_path)
+    dll_hash = hash_file(dll_file_path) # This is binary
+
+    # --- Manage known hashes ---
+    hash_file_path = os.path.join(os.path.dirname(dll_file_path), "known_dll_hashes.txt")
+    known_hex_hashes = []
+    try:
+        with open(hash_file_path, 'r') as f:
+            for line in f:
+                known_hex_hashes.append(line.strip())
+    except FileNotFoundError:
+        print(f"Info: '{hash_file_path}' not found, will be created.")
+        pass # File doesn't exist, list remains empty
+
+    current_dll_hex_hash = dll_hash.hex()
+    if current_dll_hex_hash not in known_hex_hashes:
+        known_hex_hashes.append(current_dll_hex_hash)
+
+    with open(hash_file_path, 'w') as f:
+        for hex_hash in known_hex_hashes:
+            f.write(hex_hash + '\n')
+    print(f"Updated known hashes in: {hash_file_path}")
+    # --- End of manage known hashes ---
 
     print(f"Reading header file: {header_file_path}")
     try:
@@ -77,7 +98,7 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
     includes = re.findall(r"#include\s+<.*?>", header_content)
 
     # Find all typedefs, including their documentation comments
-    typedefs = re.findall(r"/\*\*(?:[\s\S]*?)\*/\s*typedef[\s\S]*?;\s*", header_content)
+    typedefs = re.findall(r"(?:/\*\*(?:[\s\S]*?)\*/\s*)?typedef[\s\S]*?;\s*", header_content)
 
     # --- Extract function prototypes ---
     function_pattern = re.compile(
@@ -104,7 +125,7 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         if "void" in return_type:
             return_statement = "    // No return value."
         elif "*" in return_type:
-            return_statement = f'    return ({return_type})(&g_stub_memory);'
+            return_statement = f'    return ({return_type})(&g_stub_memory[0]);'
         else: # bool, int64_t, etc.
             return_statement = "    return 1;"
 
@@ -136,6 +157,7 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         f.write(f"// Generated from {os.path.basename(header_file_path)} by {os.path.basename(sys.argv[0])}\n\n")
         f.write(f"#ifndef {header_guard}\n")
         f.write(f"#define {header_guard}\n\n")
+        f.write(f"#define ANALYTICS_API  // filter out from header copy\n\n")
         f.write("#include <stdbool.h>  // needed for bool type in pure C\n\n")
 
         f.write("// --- Copied from original header ---\n")
@@ -157,8 +179,10 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         f.write("\n// --- Dynamic Loader Declaration for Windows ---\n")
         f.write("#if defined(_WIN32)\n\n")
         f.write('#include <windows.h>\n')
-        f.write(f'\n// Google Analytics Windows DLL SHA256 hash, to be verified before loading.')
-        f.write(f'\nextern const unsigned char FirebaseAnalytics_WindowsDllHash[{len(dll_hash)}];\n\n');
+        f.write('\n// Array of known Google Analytics Windows DLL SHA256 hashes (hex strings).\n')
+        f.write('extern const char* FirebaseAnalytics_KnownWindowsDllHashes[];\n')
+        f.write('// Count of known Google Analytics Windows DLL SHA256 hashes.\n')
+        f.write('extern const int FirebaseAnalytics_KnownWindowsDllHashCount;\n\n')
         f.write('// Load Analytics functions from the given DLL handle into function pointers.\n')
         f.write(f'// Returns the number of functions successfully loaded.\n')
         f.write("int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle);\n\n")
@@ -178,15 +202,23 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         f.write(f"// Generated from {os.path.basename(header_file_path)} by {os.path.basename(sys.argv[0])}\n\n")
         f.write(f'#include "{INCLUDE_PREFIX}{os.path.basename(output_h_path)}"\n\n')
         f.write('#include <stddef.h>\n\n')
-        f.write("static void* g_stub_memory = NULL;\n\n")
+        f.write("// A nice big chunk of stub memory that can be returned by stubbed Create methods.\n")
+        f.write("static char g_stub_memory[256] = {0};\n\n")
         f.write("// clang-format off\n")
         f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
         f.write(f'\nconst int FirebaseAnalytics_DynamicFunctionCount = {len(function_details_for_loader)};\n\n');
         f.write("#if defined(_WIN32)\n")
-        f.write('// Google Analytics Windows DLL SHA256 hash, to be verified before loading.\n')
-        f.write('const unsigned char FirebaseAnalytics_WindowsDllHash[] = {\n    ')
-        f.write(', '.join(["0x%02x" % s for s in dll_hash]))
-        f.write('\n};\n')
+        f.write('// Array of known Google Analytics Windows DLL SHA256 hashes (hex strings).\n')
+        f.write('const char* FirebaseAnalytics_KnownWindowsDllHashes[] = {\n')
+        if known_hex_hashes:
+            for i, hex_hash in enumerate(known_hex_hashes):
+                f.write(f'    "{hex_hash}"')
+                if i < len(known_hex_hashes) - 1:
+                    f.write(',')
+                f.write('\n')
+        f.write('};\n\n')
+        f.write('// Count of known Google Analytics Windows DLL SHA256 hashes.\n')
+        f.write(f'const int FirebaseAnalytics_KnownWindowsDllHashCount = {len(known_hex_hashes)};\n')
         f.write("#endif  // defined(_WIN32)\n")
         f.write("\n// --- Stub Function Definitions ---\n")
         f.write("\n\n".join(stub_functions))
@@ -231,25 +263,21 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
     parser.add_argument(
         "--windows_dll",
         default = os.path.join(os.path.dirname(sys.argv[0]), "windows/analytics_win.dll"),
-        #required=True,
         help="Path to the DLL file to calculate a hash."
     )
     parser.add_argument(
         "--windows_header",
         default = os.path.join(os.path.dirname(sys.argv[0]), "windows/include/public/c/analytics.h"),
-        #required=True,
         help="Path to the input C header file."
     )
     parser.add_argument(
         "--output_header",
         default = os.path.join(os.path.dirname(sys.argv[0]), INCLUDE_PATH, "analytics_desktop_dynamic.h"),
-        #required=True,
         help="Path for the generated output header file."
     )
     parser.add_argument(
         "--output_source",
         default = os.path.join(os.path.dirname(sys.argv[0]), INCLUDE_PATH, "analytics_desktop_dynamic.c"),
-        #required=True,
         help="Path for the generated output source file."
     )
     args = parser.parse_args()