Merge ba7b04a into d299673

Author: jonsimantov

analytics/CMakeLists.txt

@@ -74,9 +74,15 @@ set(android_SRCS
 set(ios_SRCS
     src/analytics_ios.mm)
 
-# Source files used by the stub implementation.
-set(stub_SRCS
-    src/analytics_stub.cc)
+# Source files used by the desktop / stub implementation.
+set(desktop_SRCS
+    src/analytics_desktop.cc
+    src/analytics_desktop_dynamic.c)
+
+if(WIN32)
+  # Add Windows-specific sources for desktop builds.
+  list(APPEND desktop_SRCS src/analytics_windows.cc)
+endif()
 
 if(ANDROID)
   set(analytics_platform_SRCS
@@ -86,7 +92,7 @@ elseif(IOS)
       "${ios_SRCS}")
 else()
   set(analytics_platform_SRCS
-      "${stub_SRCS}")
+      "${desktop_SRCS}")
 endif()
 
 add_library(firebase_analytics STATIC
@@ -98,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

@@ -16,12 +16,13 @@
 """Generate stubs and function pointers for Windows SDK"""
 
 import argparse
+import hashlib
 import os
 import re
 import sys
 
 HEADER_GUARD_PREFIX = "FIREBASE_ANALYTICS_SRC_WINDOWS_"
-INCLUDE_PATH = "src/windows/"
+INCLUDE_PATH = "src/"
 INCLUDE_PREFIX = "analytics/" + INCLUDE_PATH
 COPYRIGHT_NOTICE = """// Copyright 2025 Google LLC
 //
@@ -39,17 +40,50 @@
 
 """
 
-def generate_function_pointers(header_file_path, output_h_path, output_c_path):
+
+def hash_file(filename):
+    sha256_hash = hashlib.sha256()
+    with open(filename, "rb") as file:
+        while chunk := file.read(4096):
+            sha256_hash.update(chunk)
+    return sha256_hash.digest()
+
+def generate_function_pointers(dll_file_path, header_file_path, output_h_path, output_c_path):
     """
     Parses a C header file to generate a self-contained header with typedefs,
     extern function pointer declarations, and a source file with stub functions,
     initialized pointers, and a dynamic loading function for Windows.
 
     Args:
+        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) # 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:
         with open(header_file_path, 'r', encoding='utf-8') as f:
@@ -64,7 +98,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
     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(
@@ -83,18 +117,18 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         return_type = match.group(1).strip()
         function_name = match.group(2).strip()
         params_str = match.group(3).strip()
-        
+
         cleaned_params_for_decl = re.sub(r'\s+', ' ', params_str) if params_str else ""
         stub_name = f"Stub_{function_name}"
 
         # Generate return statement for the stub
         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;"
-            
+
         stub_function = (
             f"// Stub for {function_name}\n"
             f"static {return_type} {stub_name}({params_str}) {{\n"
@@ -111,7 +145,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
 
         pointer_init = f"{return_type} (*ptr_{function_name})({cleaned_params_for_decl}) = &{stub_name};"
         pointer_initializations.append(pointer_init)
-        
+
         function_details_for_loader.append((function_name, return_type, cleaned_params_for_decl))
 
     print(f"Found {len(pointer_initializations)} functions. Generating output files...")
@@ -123,13 +157,14 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         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")
         f.write("\n".join(includes) + "\n\n")
         f.write("".join(typedefs))
         f.write("// --- End of copied section ---\n\n")
-        
+
         f.write("#ifdef __cplusplus\n")
         f.write('extern "C" {\n')
         f.write("#endif\n\n")
@@ -139,15 +174,21 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         f.write("\n\n")
         f.write("\n".join(macro_definitions))
         f.write("\n// clang-format on\n")
-        f.write("\n\n// --- Dynamic Loader Declaration for Windows ---\n")
-        f.write("#if defined(_WIN32)\n")
-        f.write('#include <windows.h> // For HMODULE\n')
-        f.write('// Load Google Analytics functions from the given DLL handle into function pointers.\n')
-        f.write(f'// Returns the number of functions successfully loaded (out of {len(function_details_for_loader)}).\n')
-        f.write("int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle);\n\n")
+        f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
+        f.write('\nextern const int FirebaseAnalytics_DynamicFunctionCount;\n');
+        f.write("\n// --- Dynamic Loader Declaration for Windows ---\n")
+        f.write("#if defined(_WIN32)\n\n")
+        f.write('#include <windows.h>\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")
         f.write('// Reset all function pointers back to stubs.\n')
-        f.write("void FirebaseAnalytics_UnloadAnalyticsFunctions(void);\n\n")
-        f.write("#endif // defined(_WIN32)\n")
+        f.write("void FirebaseAnalytics_UnloadDynamicFunctions(void);\n\n")
+        f.write("#endif  // defined(_WIN32)\n")
         f.write("\n#ifdef __cplusplus\n")
         f.write("}\n")
         f.write("#endif\n\n")
@@ -159,18 +200,34 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
     with open(output_c_path, 'w', encoding='utf-8') as f:
         f.write(f"{COPYRIGHT_NOTICE}")
         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')
+        f.write(f'#include "{INCLUDE_PREFIX}{os.path.basename(output_h_path)}"\n\n')
         f.write('#include <stddef.h>\n\n')
-        f.write("// clang-format off\n\n")
-        f.write("static void* g_stub_memory = NULL;\n\n")
-        f.write("// --- Stub Function Definitions ---\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('// 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))
         f.write("\n\n\n// --- Function Pointer Initializations ---\n")
         f.write("\n".join(pointer_initializations))
         f.write("\n\n// --- Dynamic Loader Function for Windows ---\n")
         loader_lines = [
             '#if defined(_WIN32)',
-            'int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle) {',
+            'int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle) {',
             '    int count = 0;\n',
             '    if (!dll_handle) {',
             '        return count;',
@@ -188,7 +245,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
             loader_lines.extend(proc_check)
         loader_lines.append('\n    return count;')
         loader_lines.append('}\n')
-        loader_lines.append('void FirebaseAnalytics_UnloadAnalyticsFunctions(void) {')
+        loader_lines.append('void FirebaseAnalytics_UnloadDynamicFunctions(void) {')
         for name, ret_type, params in function_details_for_loader:
             loader_lines.append(f'    ptr_{name} = &Stub_{name};');
         loader_lines.append('}\n')
@@ -203,29 +260,31 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
     parser = argparse.ArgumentParser(
         description="Generate C stubs and function pointers from a header file."
     )
+    parser.add_argument(
+        "--windows_dll",
+        default = os.path.join(os.path.dirname(sys.argv[0]), "windows/analytics_win.dll"),
+        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_dynamic.h"),
-        #required=True,
+        default = os.path.join(os.path.dirname(sys.argv[0]), INCLUDE_PATH, "analytics_desktop_dynamic.h"),
         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_dynamic.c"),
-        #required=True,
+        default = os.path.join(os.path.dirname(sys.argv[0]), INCLUDE_PATH, "analytics_desktop_dynamic.c"),
         help="Path for the generated output source file."
     )
-    
     args = parser.parse_args()
-    
+
     generate_function_pointers(
-        args.windows_header, 
-        args.output_header, 
+        args.windows_dll,
+        args.windows_header,
+        args.output_header,
         args.output_source
     )

analytics/integration_test/CMakeLists.txt

@@ -211,6 +211,16 @@ else()
     )
   elseif(MSVC)
     set(ADDITIONAL_LIBS advapi32 ws2_32 crypt32)
+    set(ANALYTICS_WINDOWS_DLL "${FIREBASE_CPP_SDK_DIR}/analytics/windows/analytics_win.dll")
+
+    # For Windows, check if the Analytics DLL exists, and copy it in if so.
+    if (EXISTS "${ANALYTICS_WINDOWS_DLL}")
+      add_custom_command(
+        TARGET ${integration_test_target_name} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy
+	  "${ANALYTICS_WINDOWS_DLL}"
+          $<TARGET_FILE_DIR:${integration_test_target_name}>)
+    endif()
   else()
     set(ADDITIONAL_LIBS pthread)
   endif()