Use CEF logging functions (cztomczak#352) and others (cztomczak#351, cztomczak#277)...

Fix logging command line string for sub-processes (cztomczak#351).

Remove CefExecuteProcess call in cef.Initialize. This call should
happen only in subprocess main.cpp.

Author: cztomczak

api/ApplicationSettings.md

@@ -287,9 +287,9 @@ a value of "verbose", "info", "warning", "error", "error-report" or
 
 Accepted values - constants available in the cefpython module:
 * LOGSEVERITY_VERBOSE
-* LOGSEVERITY_INFO (default)
+* LOGSEVERITY_INFO
 * LOGSEVERITY_WARNING
-* LOGSEVERITY_ERROR
+* LOGSEVERITY_ERROR (default)
 * LOGSEVERITY_ERROR_REPORT
 * LOGSEVERITY_DISABLE
 

docs/Knowledge-Base.md

@@ -167,8 +167,12 @@ You can pass "--debug" command line flag to any of CEF Python
 examples and unit tests. It will also work with your app, as
 this feature is enabled in CEF Python's core. When this flag is
 passed the following settings will be set:
-```
-settings = {"debug": True, "log_severity": cef.LOGSEVERITY_WARNING}
+```python
+settings = {
+    "debug": True,
+    "log_severity": cef.LOGSEVERITY_INFO,
+    "log_file": "debug.log",
+}
 cef.Initialize(settings=settings)
 ```
 

docs/Tutorial.md

@@ -244,7 +244,7 @@ To enable debugging set these settings:
 ```python
 settings = {
     "debug": True,
-    "log_severity": cef.LOGSEVERITY_WARNING,
+    "log_severity": cef.LOGSEVERITY_INFO,
     "log_file": "debug.log",
 }
 cef.Initialize(settings=settings)

examples/wxpython.py

@@ -1,9 +1,8 @@
 # Example of embedding CEF Python browser using wxPython library.
 # This example has a top menu and a browser widget without navigation bar.
 
-# To install wxPython on Linux type "sudo apt-get install python-wxtools".
-
 # Tested configurations:
+# - wxPython 4.0 on Windows/Linux
 # - wxPython 3.0 on Windows/Mac
 # - wxPython 2.8 on Linux
 # - CEF Python v55.4+
@@ -35,8 +34,7 @@ def main():
     sys.excepthook = cef.ExceptHook  # To shutdown all CEF processes on error
     settings = {}
     if WINDOWS:
-        # High DPI support
-        settings["auto_zooming"] = "system_dpi"
+        settings["auto_zooming"] = "system_dpi"  # High DPI support
         # noinspection PyUnresolvedReferences, PyArgumentList
         cef.DpiAware.SetProcessDpiAware()  # Alternative is to embed manifest
     cef.Initialize(settings=settings)

src/cefpython.pyx

@@ -438,12 +438,12 @@ from cef_image cimport *
 from main_message_loop cimport *
 # noinspection PyUnresolvedReferences
 from cef_views cimport *
+from cef_log cimport *
 
 # -----------------------------------------------------------------------------
 # GLOBAL VARIABLES
 
 g_debug = False
-g_debugFile = "debug.log"
 
 # When put None here and assigned a local dictionary in Initialize(), later
 # while running app this global variable was garbage collected, see topic:
@@ -462,6 +462,7 @@ cdef scoped_ptr[MainMessageLoopExternalPump] g_external_message_pump
 
 cdef py_bool g_MessageLoop_called = False
 cdef py_bool g_MessageLoopWork_called = False
+cdef py_bool g_cef_initialized = False
 
 cdef dict g_globalClientCallbacks = {}
 
@@ -530,14 +531,11 @@ include "handlers/v8function_handler.pyx"
 # Utility functions to provide settings to the C++ browser process code.
 
 cdef public void cefpython_GetDebugOptions(
-        cpp_bool* debug,
-        cpp_string* debugFile
+        cpp_bool* debug
         ) except * with gil:
     # Called from subprocess/cefpython_app.cpp -> CefPythonApp constructor.
-    cdef cpp_string cppString = PyStringToChar(g_debugFile)
     try:
         debug[0] = <cpp_bool>bool(g_debug)
-        debugFile.assign(cppString)
     except:
         (exc_type, exc_value, exc_trace) = sys.exc_info()
         sys.excepthook(exc_type, exc_value, exc_trace)
@@ -618,16 +616,17 @@ def Initialize(applicationSettings=None, commandLineSwitches=None, **kwargs):
     # Debug settings need to be set before Debug() is called
     # and before the CefPythonApp class is instantiated.
     global g_debug
-    global g_debugFile
     if "--debug" in sys.argv:
         application_settings["debug"] = True
-        application_settings["log_file"] = "debug.log"
-        application_settings["log_severity"] = LOGSEVERITY_WARNING
+        application_settings["log_file"] = os.path.join(os.getcwd(),
+                                                        "debug.log")
+        application_settings["log_severity"] = LOGSEVERITY_INFO
         sys.argv.remove("--debug")
     if "debug" in application_settings:
         g_debug = bool(application_settings["debug"])
-    if "log_file" in application_settings:
-        g_debugFile = application_settings["log_file"]
+    if "log_severity" in application_settings:
+        if application_settings["log_severity"] <= LOGSEVERITY_INFO:
+            g_debug = True
 
     Debug("Initialize() called")
 
@@ -719,11 +718,9 @@ def Initialize(applicationSettings=None, commandLineSwitches=None, **kwargs):
         # TODO: use the CefMainArgs(int argc, char** argv) constructor.
         cdef CefMainArgs cefMainArgs
     cdef int exitCode = 1
-    with nogil:
-        exitCode = CefExecuteProcess(cefMainArgs, cefApp, NULL)
-    Debug("CefExecuteProcess(): exitCode = %s" % exitCode)
-    if exitCode >= 0:
-        sys.exit(exitCode)
+
+    # NOTE: CefExecuteProcess shall not be called here. It should
+    #       be called only in the subprocess main.cpp.
 
     # Make a copy as applicationSettings is a reference only
     # that might get destroyed later.
@@ -755,6 +752,9 @@ def Initialize(applicationSettings=None, commandLineSwitches=None, **kwargs):
     with nogil:
         ret = CefInitialize(cefMainArgs, cefApplicationSettings, cefApp, NULL)
 
+    global g_cef_initialized
+    g_cef_initialized = True
+
     if not ret:
         Debug("CefInitialize() failed")
 

src/client_handler/Makefile

@@ -23,6 +23,7 @@ SRC = client_handler.cpp cookie_visitor.cpp resource_handler.cpp \
 	download_handler.cpp focus_handler.cpp js_dialog_handler.cpp \
 	keyboard_handler.cpp lifespan_handler.cpp load_handler.cpp \
 	render_handler.cpp request_handler.cpp dialog_handler.cpp \
+	cef_log.cpp \
 	$(SRC_MORE)
 
 OBJ = $(filter %.o, $(SRC:.cpp=.o) $(SRC:.mm=.o))

src/client_handler/cef_log.cpp

@@ -0,0 +1,17 @@
+// Copyright (c) 2017 CEF Python, see the Authors file.
+// All rights reserved. Licensed under BSD 3-clause license.
+// Project website: https://github.com/cztomczak/cefpython
+
+#include "include/base/cef_logging.h"
+
+void cef_log_info(char* msg) {
+    LOG(INFO) << msg;
+}
+
+void cef_log_warning(char* msg) {
+    LOG(WARNING) << msg;
+}
+
+void cef_log_error(char* msg) {
+    LOG(ERROR) << msg;
+}

src/client_handler/cef_log.h

@@ -0,0 +1,9 @@
+// Copyright (c) 2017 CEF Python, see the Authors file.
+// All rights reserved. Licensed under BSD 3-clause license.
+// Project website: https://github.com/cztomczak/cefpython
+
+#pragma once
+
+void cef_log_info(char* msg);
+void cef_log_warning(char* msg);
+void cef_log_error(char* msg);

src/client_handler/client_handler.cpp

@@ -8,7 +8,7 @@
 
 #include "client_handler.h"
 #include "common/cefpython_public_api.h"
-#include "common/DebugLog.h"
+#include "include/base/cef_logging.h"
 
 #if defined(OS_WIN)
 #include <Shellapi.h>
@@ -34,9 +34,9 @@ bool ClientHandler::OnProcessMessageReceived(
         return false;
     }
     std::string messageName = message->GetName().ToString();
-    std::string logMessage = "Browser: OnProcessMessageReceived(): ";
+    std::string logMessage = "[Browser process] OnProcessMessageReceived(): ";
     logMessage.append(messageName.c_str());
-    DebugLog(logMessage.c_str());
+    LOG(INFO) << logMessage.c_str();
     if (messageName == "OnContextCreated") {
         CefRefPtr<CefListValue> arguments = message->GetArgumentList();
         if (arguments->GetSize() == 1 && arguments->GetType(0) == VTYPE_INT) {
@@ -45,8 +45,8 @@ bool ClientHandler::OnProcessMessageReceived(
             V8ContextHandler_OnContextCreated(browser, frame);
             return true;
         } else {
-            DebugLog("Browser: OnProcessMessageReceived(): invalid arguments" \
-                     ", messageName = OnContextCreated");
+            LOG(ERROR) << "[Browser process] OnProcessMessageReceived():"
+                          " invalid arguments, messageName=OnContextCreated";
             return false;
         }
     } else if (messageName == "OnContextReleased") {
@@ -59,8 +59,8 @@ bool ClientHandler::OnProcessMessageReceived(
             V8ContextHandler_OnContextReleased(browserId, frameId);
             return true;
         } else {
-            DebugLog("Browser: OnProcessMessageReceived(): invalid arguments" \
-                     ", messageName = OnContextReleased");
+            LOG(ERROR) << "[Browser process] OnProcessMessageReceived():"
+                          " invalid arguments, messageName=OnContextReleased";
             return false;
         }
     } else if (messageName == "V8FunctionHandler::Execute") {
@@ -80,8 +80,9 @@ bool ClientHandler::OnProcessMessageReceived(
                                       functionArguments);
             return true;
         } else {
-            DebugLog("Browser: OnProcessMessageReceived(): invalid arguments" \
-                     ", messageName = V8FunctionHandler::Execute");
+            LOG(ERROR) << "[Browser process] OnProcessMessageReceived():"
+                          " invalid arguments,"
+                          " messageName=V8FunctionHandler::Execute";
             return false;
         }
     } else if (messageName == "ExecutePythonCallback") {
@@ -94,8 +95,9 @@ bool ClientHandler::OnProcessMessageReceived(
             ExecutePythonCallback(browser, callbackId, functionArguments);
             return true;
         } else {
-            DebugLog("Browser: OnProcessMessageReceived(): invalid arguments" \
-                     ", messageName = ExecutePythonCallback");
+            LOG(ERROR) << "[Browser process] OnProcessMessageReceived():"
+                          " invalid arguments,"
+                          " messageName=ExecutePythonCallback";
             return false;
         }
     } else if (messageName == "RemovePythonCallbacksForFrame") {
@@ -105,8 +107,9 @@ bool ClientHandler::OnProcessMessageReceived(
             RemovePythonCallbacksForFrame(frameId);
             return true;
         } else {
-            DebugLog("Browser: OnProcessMessageReceived(): invalid arguments" \
-                     ", messageName = ExecutePythonCallback");
+            LOG(ERROR) << "[Browser process] OnProcessMessageReceived():"
+                          " invalid arguments,"
+                          " messageName=ExecutePythonCallback";
             return false;
         }
     }

src/client_handler/context_menu_handler.cpp

@@ -3,7 +3,7 @@
 // Project website: https://github.com/cztomczak/cefpython
 
 #include "context_menu_handler.h"
-#include "common/DebugLog.h"
+#include "include/base/cef_logging.h"
 
 #define _MENU_ID_DEVTOOLS                         MENU_ID_USER_FIRST + 1
 #define _MENU_ID_RELOAD_PAGE                      MENU_ID_USER_FIRST + 2
@@ -127,12 +127,13 @@ void OpenInExternalBrowser(const std::string& url)
     // Linux equivalent of ShellExecute
 
     if (url.empty()) {
-        DebugLog("Browser: OpenInExternalBrowser() FAILED: url is empty");
+        LOG(ERROR) << "[Browser process] OpenInExternalBrowser():"
+                      " url is empty";
         return;
     }
-    std::string msg = "Browser: OpenInExternalBrowser(): url=";
+    std::string msg = "[Browser process] OpenInExternalBrowser(): url=";
     msg.append(url.c_str());
-    DebugLog(msg.c_str());
+    LOG(INFO) << msg.c_str();
 
     // xdg-open is a desktop-independent tool for running
     // default applications. Installed by default on Ubuntu.