Enhance Android Logging with setLogCallback API (#35254)

* Enhance Android Logging with setLogCallback API

This change adds the setLogCallback API to the AndroidChipLogging class
of the Matter SDK, enhancing its logging capabilities. With this API,
developers can customize logging behavior and integrate it with
Android's logging system, allowing for more flexible and comprehensive
logging.
An example of usage in Kotlin is as follows:
ChipDeviceController.loadJni()
AndroidChipLogging.setLogCallback { module, priority, message ->
    when (priority) {
        Log.ERROR -> Log.e(module, message)
        Log.INFO -> Log.i(module, message)
        Log.DEBUG -> Log.d(module, message)
    }
}

Signed-off-by: Youngho Yoon <[email protected]>

* Add s prefix for global variables

Signed-off-by: Youngho Yoon <[email protected]>

* Do not call onLogMessage callback when msg is null

Handle the case where jMsg is null due to UTF decode errors in buffer.
Don't call the callback when the string is null.

Signed-off-by: Youngho Yoon <[email protected]>

* Return logRedirectCallback when env is nullptr

Signed-off-by: Youngho Yoon <[email protected]>

* Use JniLocalReferenceScope instead of DeleteLocalRef

Signed-off-by: Youngho Yoon <[email protected]>

* Change type of global ref to JniGlobalReference

Signed-off-by: Youngho Yoon <[email protected]>

* Use CharToStringUTF instead of NewStringUTF

Signed-off-by: Youngho Yoon <[email protected]>

* Use VerifyOrReturn for CharToStringUTF

Signed-off-by: Youngho Yoon <[email protected]>

---------

Signed-off-by: Youngho Yoon <[email protected]>

src/platform/android/AndroidChipPlatform-JNI.cpp

@@ -60,6 +60,8 @@ static bool JavaBytesToUUID(JNIEnv * env, jbyteArray value, chip::Ble::ChipBleUU
 namespace {
 JavaVM * sJVM = nullptr;
 JniGlobalReference sAndroidChipPlatformExceptionCls;
+jmethodID sOnLogMessageMethod = nullptr;
+JniGlobalReference sJavaLogCallbackObject;
 } // namespace
 
 CHIP_ERROR AndroidChipPlatformJNI_OnLoad(JavaVM * jvm, void * reserved)
@@ -274,6 +276,76 @@ JNI_LOGGING_METHOD(void, setLogFilter)(JNIEnv * env, jclass clazz, jint level)
     SetLogFilter(category);
 }
 
+static void ENFORCE_FORMAT(3, 0) logRedirectCallback(const char * module, uint8_t category, const char * msg, va_list args)
+{
+    using namespace chip::Logging;
+
+    JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
+    VerifyOrReturn(env != nullptr);
+    VerifyOrReturn(sJavaLogCallbackObject.HasValidObjectRef());
+    VerifyOrReturn(sOnLogMessageMethod != nullptr);
+
+    JniLocalReferenceScope scope(env);
+    int priority = ANDROID_LOG_DEBUG;
+    switch (category)
+    {
+    case kLogCategory_Error:
+        priority = ANDROID_LOG_ERROR;
+        break;
+    case kLogCategory_Progress:
+        priority = ANDROID_LOG_INFO;
+        break;
+    case kLogCategory_Detail:
+        priority = ANDROID_LOG_DEBUG;
+        break;
+    default:
+        break;
+    }
+
+    jint jPriority = static_cast<jint>(priority);
+    jobject jModule;
+    VerifyOrReturn(JniReferences::GetInstance().CharToStringUTF(CharSpan::fromCharString(module), jModule) == CHIP_NO_ERROR);
+    VerifyOrReturn(jModule != nullptr);
+
+    char buffer[CHIP_CONFIG_LOG_MESSAGE_MAX_SIZE];
+    vsnprintf(buffer, sizeof(buffer), msg, args);
+    jobject jMsg;
+    VerifyOrReturn(JniReferences::GetInstance().CharToStringUTF(CharSpan::fromCharString(buffer), jMsg) == CHIP_NO_ERROR);
+    VerifyOrReturn(jMsg != nullptr);
+
+    env->CallVoidMethod(sJavaLogCallbackObject.ObjectRef(), sOnLogMessageMethod, static_cast<jstring>(jModule), jPriority,
+                        static_cast<jstring>(jMsg));
+}
+
+JNI_LOGGING_METHOD(void, setLogCallback)(JNIEnv * env, jclass clazz, jobject callback)
+{
+    using namespace chip::Logging;
+
+    if (sOnLogMessageMethod == nullptr)
+    {
+        jclass callbackClass = env->GetObjectClass(callback);
+        sOnLogMessageMethod  = env->GetMethodID(callbackClass, "onLogMessage", "(Ljava/lang/String;ILjava/lang/String;)V");
+    }
+    VerifyOrReturn(sOnLogMessageMethod != nullptr,
+                   ChipLogError(DeviceLayer, "Failed to access AndroidChipLogging.LogCallback 'onLogMessage' method"));
+
+    if (sJavaLogCallbackObject.HasValidObjectRef())
+    {
+        sJavaLogCallbackObject.Reset();
+    }
+
+    if (env->IsSameObject(callback, NULL))
+    {
+        SetLogRedirectCallback(nullptr);
+    }
+    else
+    {
+        VerifyOrReturn(sJavaLogCallbackObject.Init(callback) == CHIP_NO_ERROR,
+                       ChipLogError(DeviceLayer, "Failed to init sJavaLogCallbackObject"));
+        SetLogRedirectCallback(logRedirectCallback);
+    }
+}
+
 JNI_MDNSCALLBACK_METHOD(void, handleServiceResolve)
 (JNIEnv * env, jclass self, jstring instanceName, jstring serviceType, jstring hostName, jstring address, jint port,
  jobject attributes, jlong callbackHandle, jlong contextHandle)

src/platform/android/java/chip/platform/AndroidChipLogging.java

@@ -20,4 +20,11 @@
 public class AndroidChipLogging {
   // logging level is in android.util.Log class
   public static native void setLogFilter(int level);
+
+  // This must be called after System.loadLibrary
+  public static native void setLogCallback(LogCallback callback);
+
+  public interface LogCallback {
+    void onLogMessage(String module, int priority, String message);
+  }
 }