include "compile_time_constants.pxi"

import os

import sys

import cython

import platform

import traceback

import time

import types

import re

import copy

import inspect # used by JavascriptBindings.__SetObjectMethods()

import urllib

import json

import datetime

import random

if sys.version_info.major == 2:

# noinspection PyUnresolvedReferences

import urlparse

else:

# noinspection PyUnresolvedReferences

from urllib import parse as urlparse

if sys.version_info.major == 2:

# noinspection PyUnresolvedReferences

from urllib import pathname2url as urllib_pathname2url

else:

# noinspection PyUnresolvedReferences

from urllib.request import pathname2url as urllib_pathname2url

from cpython.version cimport PY_MAJOR_VERSION

import weakref

ctypedef object py_string

ctypedef object py_void

from cpython cimport PyLong_FromVoidPtr

from cpython cimport bool as py_bool

from libcpp cimport bool as cpp_bool

from libcpp.map cimport map as cpp_map

from multimap cimport multimap as cpp_multimap

from libcpp.pair cimport pair as cpp_pair

from libcpp.vector cimport vector as cpp_vector

from libcpp.string cimport string as cpp_string

from wstring cimport wstring as cpp_wstring

from libc.string cimport strlen

from libc.string cimport memcpy

from cython.operator cimport preincrement as preinc, dereference as deref

from libc.stdlib cimport calloc, malloc, free

from libc.stdlib cimport atoi

from libc.stdint cimport uint64_t

from libc.stdint cimport uintptr_t

ctypedef uintptr_t WindowHandle

cimport ctime

IF UNAME_SYSNAME == "Windows":

from windows cimport *

from dpi_aware_win cimport *

ELIF UNAME_SYSNAME == "Linux":

from linux cimport *

ELIF UNAME_SYSNAME == "Darwin":

from mac cimport *

from cpp_utils cimport *

from task cimport *

from cef_string cimport *

cdef extern from *:

# noinspection PyUnresolvedReferences

ctypedef CefString ConstCefString "const CefString"

from cef_types cimport (

CefSettings, CefBrowserSettings, CefRect, CefPoint,

CefKeyEvent, CefMouseEvent, CefScreenInfo,

PathKey, PK_DIR_EXE, PK_DIR_MODULE,

int32, uint32, int64, uint64,

)

from cef_task cimport *

from cef_platform cimport *

from cef_ptr cimport *

from cef_app cimport *

from cef_browser cimport *

cimport cef_browser_static

from cef_client cimport *

from client_handler cimport *

from cef_frame cimport *

from cef_time cimport *

from cef_values cimport *

from cefpython_app cimport *

from cef_process_message cimport *

from cef_web_plugin cimport *

from cef_request_handler cimport *

from cef_request cimport *

from cef_cookie cimport *

from cef_string_visitor cimport *

cimport cef_cookie_manager_namespace

from cookie_visitor cimport *

from string_visitor cimport *

from cef_callback cimport *

from cef_response cimport *

from cef_resource_handler cimport *

from resource_handler cimport *

from cef_urlrequest cimport *

from web_request_client cimport *

from cef_command_line cimport *

from cef_request_context cimport *

from cef_request_context_handler cimport *

from request_context_handler cimport *

from cef_jsdialog_handler cimport *

from cef_path_util cimport *

from cef_drag_data cimport *

from cef_image cimport *

from main_message_loop cimport *

from cef_scoped_ptr cimport scoped_ptr

g_debug = False

g_debugFile = "debug.log"

g_applicationSettings = {"string_encoding": "utf-8"}

g_commandLineSwitches = {}

cdef scoped_ptr[MainMessageLoopExternalPump] g_external_message_pump

cdef py_bool g_MessageLoop_called = False

cdef py_bool g_MessageLoopWork_called = False

cdef dict g_globalClientCallbacks = {}

cdef CefRefPtr[CefRequestContext] g_sharedRequestContext

include "utils.pyx"

include "string_utils.pyx"

IF UNAME_SYSNAME == "Windows":

include "string_utils_win.pyx"

include "time_utils.pyx"

include "browser.pyx"

include "frame.pyx"

include "settings.pyx"

IF UNAME_SYSNAME == "Windows":

include "window_utils_win.pyx"

include "dpi_aware_win.pyx"

ELIF UNAME_SYSNAME == "Linux":

include "window_utils_linux.pyx"

ELIF UNAME_SYSNAME == "Darwin":

include "window_utils_mac.pyx"

include "task.pyx"

include "javascript_bindings.pyx"

include "virtual_keys.pyx"

include "window_info.pyx"

include "process_message_utils.pyx"

include "javascript_callback.pyx"

include "python_callback.pyx"

include "web_plugin_info.pyx"

include "request.pyx"

include "cookie.pyx"

include "string_visitor.pyx"

include "network_error.pyx"

include "paint_buffer.pyx"

include "callback.pyx"

include "response.pyx"

include "web_request.pyx"

include "command_line.pyx"

include "app.pyx"

include "drag_data.pyx"

include "helpers.pyx"

IF UNAME_SYSNAME == "Linux":

include "image.pyx"

include "handlers/browser_process_handler.pyx"

include "handlers/display_handler.pyx"

include "handlers/focus_handler.pyx"

include "handlers/javascript_dialog_handler.pyx"

include "handlers/keyboard_handler.pyx"

include "handlers/lifespan_handler.pyx"

include "handlers/load_handler.pyx"

include "handlers/render_handler.pyx"

include "handlers/resource_handler.pyx"

include "handlers/request_handler.pyx"

include "handlers/v8context_handler.pyx"

include "handlers/v8function_handler.pyx"

cdef public void cefpython_GetDebugOptions(

cpp_bool* debug,

cpp_string* debugFile

) 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)

cdef public cpp_bool ApplicationSettings_GetBool(const char* key

) except * with gil:

# Called from client_handler/client_handler.cpp for example

cdef py_string pyKey = CharToPyString(key)

if pyKey in g_applicationSettings:

return bool(g_applicationSettings[pyKey])

return False

cdef public cpp_bool ApplicationSettings_GetBoolFromDict(const char* key1,

const char* key2) except * with gil:

cdef py_string pyKey1 = CharToPyString(key1)

cdef py_string pyKey2 = CharToPyString(key2)

cdef object dictValue # Yet to be checked whether it is `dict`

if pyKey1 in g_applicationSettings:

dictValue = g_applicationSettings[pyKey1]

if type(dictValue) != dict:

return False

if pyKey2 in dictValue:

return bool(dictValue[pyKey2])

return False

cdef public cpp_string ApplicationSettings_GetString(const char* key

) except * with gil:

cdef py_string pyKey = CharToPyString(key)

cdef cpp_string cppString

if pyKey in g_applicationSettings:

cppString = PyStringToChar(AnyToPyString(g_applicationSettings[pyKey]))

return cppString

cdef public int CommandLineSwitches_GetInt(const char* key) except * with gil:

cdef py_string pyKey = CharToPyString(key)

if pyKey in g_commandLineSwitches:

return int(g_commandLineSwitches[pyKey])

return 0

def Initialize(applicationSettings=None, commandLineSwitches=None, **kwargs):

# Alternative names for existing parameters

if "settings" in kwargs:

applicationSettings = kwargs["settings"]

if "switches" in kwargs:

commandLineSwitches = kwargs["switches"]

IF UNAME_SYSNAME == "Linux":

# Fix Issue #231 - Discovery of the "icudtl.dat" file fails on Linux.

cdef str py_module_dir = GetModuleDirectory()

cdef CefString cef_module_dir

PyToCefString(py_module_dir, cef_module_dir)

CefOverridePath(PK_DIR_EXE, cef_module_dir)\

or Debug("ERROR: CefOverridePath failed")

CefOverridePath(PK_DIR_MODULE, cef_module_dir)\

or Debug("ERROR: CefOverridePath failed")

# END IF UNAME_SYSNAME == "Linux":

if not applicationSettings:

applicationSettings = {}

# 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 applicationSettings:

g_debug = bool(applicationSettings["debug"])

if "log_file" in applicationSettings:

g_debugFile = applicationSettings["log_file"]

Debug("Initialize() called")

# Mac initialization. Need to call NSApplication.sharedApplication()

# and do NSApplication methods swizzling to implement

# CrAppControlProtocol. See Issue 156.

IF UNAME_SYSNAME == "Darwin":

MacInitialize()

# -------------------------------------------------------------------------

# CEF Python only options - default values

if "debug" not in applicationSettings:

applicationSettings["debug"] = False

if "log_severity" not in applicationSettings:

# By default show only errors. Don't show on Linux X server non-fatal

# errors like "WARNING:x11_util.cc(1409)] X error received".

applicationSettings["log_severity"] = LOGSEVERITY_ERROR

if "string_encoding" not in applicationSettings:

applicationSettings["string_encoding"] = "utf-8"

if "unique_request_context_per_browser" not in applicationSettings:

applicationSettings["unique_request_context_per_browser"] = False

if "downloads_enabled" not in applicationSettings:

applicationSettings["downloads_enabled"] = True

if "remote_debugging_port" not in applicationSettings:

applicationSettings["remote_debugging_port"] = 0

if "auto_zooming" not in applicationSettings:

IF UNAME_SYSNAME == "Windows":

if DpiAware.IsProcessDpiAware():

applicationSettings["auto_zooming"] = "system_dpi"

# Paths

cdef str module_dir = GetModuleDirectory()

if "locales_dir_path" not in applicationSettings:

if platform.system() != "Darwin":

applicationSettings["locales_dir_path"] = os.path.join(

module_dir, "locales")

if "resources_dir_path" not in applicationSettings:

applicationSettings["resources_dir_path"] = module_dir

if platform.system() == "Darwin":

pass # TODO: Check if this needs to be set in v56+

if "browser_subprocess_path" not in applicationSettings:

applicationSettings["browser_subprocess_path"] = os.path.join(

module_dir, "subprocess")

# Mouse context menu

if "context_menu" not in applicationSettings:

applicationSettings["context_menu"] = {}

menuItems = ["enabled", "navigation", "print", "view_source",

"external_browser", "devtools"]

for item in menuItems:

if item not in applicationSettings["context_menu"]:

applicationSettings["context_menu"][item] = True

# Remote debugging port. If value is 0 we will generate a random

# port. To disable remote debugging set value to -1.

if applicationSettings["remote_debugging_port"] == 0:

# Generate a random port.

applicationSettings["remote_debugging_port"] =\

random.randint(49152, 65535)

elif applicationSettings["remote_debugging_port"] == -1:

# Disable remote debugging

applicationSettings["remote_debugging_port"] = 0

# -------------------------------------------------------------------------

# CEF options - default values.

if not "multi_threaded_message_loop" in applicationSettings:

applicationSettings["multi_threaded_message_loop"] = False

if not "single_process" in applicationSettings:

applicationSettings["single_process"] = False

cdef CefRefPtr[CefApp] cefApp = <CefRefPtr[CefApp]?>new CefPythonApp()

IF UNAME_SYSNAME == "Windows":

cdef HINSTANCE hInstance = GetModuleHandle(NULL)

cdef CefMainArgs cefMainArgs = CefMainArgs(hInstance)

ELIF UNAME_SYSNAME == "Linux":

# TODO: use the CefMainArgs(int argc, char** argv) constructor.

cdef CefMainArgs cefMainArgs

ELIF UNAME_SYSNAME == "Darwin":

# 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)

# Make a copy as applicationSettings is a reference only

# that might get destroyed later.

global g_applicationSettings

for key in applicationSettings:

g_applicationSettings[key] = copy.deepcopy(applicationSettings[key])

cdef CefSettings cefApplicationSettings

# No sandboxing for the subprocesses

cefApplicationSettings.no_sandbox = 1

SetApplicationSettings(applicationSettings, &cefApplicationSettings)

if commandLineSwitches:

# Make a copy as commandLineSwitches is a reference only

# that might get destroyed later.

global g_commandLineSwitches

for key in commandLineSwitches:

g_commandLineSwitches[key] = copy.deepcopy(

commandLineSwitches[key])

# External message pump

if GetAppSetting("external_message_pump")\

and not g_external_message_pump.get():

g_external_message_pump.Assign(MainMessageLoopExternalPump.Create())

Debug("CefInitialize()")

cdef cpp_bool ret

with nogil:

ret = CefInitialize(cefMainArgs, cefApplicationSettings, cefApp, NULL)

if not ret:

Debug("CefInitialize() failed")

IF UNAME_SYSNAME == "Linux":

# Install by default.

WindowUtils.InstallX11ErrorHandlers()

return ret

def CreateBrowser(**kwargs):

"""Create browser asynchronously. TODO. """

CreateBrowserSync(**kwargs)

def CreateBrowserSync(windowInfo=None,

browserSettings=None,

navigateUrl="",

**kwargs):

# Alternative names for existing parameters

if "window_info" in kwargs:

windowInfo = kwargs["window_info"]

if "settings" in kwargs:

browserSettings = kwargs["settings"]

if "url" in kwargs:

navigateUrl = kwargs["url"]

Debug("CreateBrowserSync() called")

assert IsThread(TID_UI), (

"cefpython.CreateBrowserSync() may only be called on the UI thread")

if not windowInfo:

windowInfo = WindowInfo()

windowInfo.SetAsChild(0)

elif not isinstance(windowInfo, WindowInfo):

raise Exception("CreateBrowserSync() failed: windowInfo: invalid object")

if not browserSettings:

browserSettings = {}

cdef CefBrowserSettings cefBrowserSettings

SetBrowserSettings(browserSettings, &cefBrowserSettings)

cdef CefWindowInfo cefWindowInfo

SetCefWindowInfo(cefWindowInfo, windowInfo)

navigateUrl = GetNavigateUrl(navigateUrl)

Debug("navigateUrl: %s" % navigateUrl)

cdef CefString cefNavigateUrl

PyToCefString(navigateUrl, cefNavigateUrl)

Debug("CefBrowser::CreateBrowserSync()")

cdef CefRefPtr[ClientHandler] clientHandler =\

<CefRefPtr[ClientHandler]?>new ClientHandler()

cdef CefRefPtr[CefBrowser] cefBrowser

# Request context - part 1/2.

createSharedRequestContext = bool(not g_sharedRequestContext.get())

cdef CefRefPtr[CefRequestContext] cefRequestContext

cdef CefRefPtr[RequestContextHandler] requestContextHandler =\

<CefRefPtr[RequestContextHandler]?>new RequestContextHandler(

cefBrowser)

if g_applicationSettings["unique_request_context_per_browser"]:

cefRequestContext = CefRequestContext.CreateContext(

CefRequestContext.GetGlobalContext(),

<CefRefPtr[CefRequestContextHandler]?>requestContextHandler)

else:

if createSharedRequestContext:

cefRequestContext = CefRequestContext.CreateContext(

CefRequestContext.GetGlobalContext(),

<CefRefPtr[CefRequestContextHandler]?>\

requestContextHandler)

g_sharedRequestContext.Assign(cefRequestContext.get())

else:

cefRequestContext.Assign(g_sharedRequestContext.get())

# CEF browser creation.

with nogil:

cefBrowser = cef_browser_static.CreateBrowserSync(

cefWindowInfo, <CefRefPtr[CefClient]?>clientHandler,

cefNavigateUrl, cefBrowserSettings,

cefRequestContext)

if <void*>cefBrowser == NULL or not cefBrowser.get():

Debug("CefBrowser::CreateBrowserSync() failed")

return None

else:

Debug("CefBrowser::CreateBrowserSync() succeeded")

# Request context - part 2/2.

if g_applicationSettings["unique_request_context_per_browser"]:

requestContextHandler.get().SetBrowser(cefBrowser)

else:

if createSharedRequestContext:

requestContextHandler.get().SetBrowser(cefBrowser)

cdef PyBrowser pyBrowser = GetPyBrowser(cefBrowser)

pyBrowser.SetUserData("__outerWindowHandle", int(windowInfo.parentWindowHandle))

return pyBrowser

def MessageLoop():

Debug("MessageLoop()")

if not g_MessageLoop_called:

global g_MessageLoop_called

g_MessageLoop_called = True

with nogil:

CefRunMessageLoop()

def MessageLoopWork():

# Perform a single iteration of CEF message loop processing.

# This function is used to integrate the CEF message loop

# into an existing application message loop.

# Anything that can block for a significant amount of time

# and is thread-safe should release the GIL:

# https://groups.google.com/d/msg/cython-users/jcvjpSOZPp0/KHpUEX8IhnAJ

# GIL must be released here otherwise we will get dead lock

# when calling from c++ to python.

if not g_MessageLoopWork_called:

global g_MessageLoopWork_called

g_MessageLoopWork_called = True

with nogil:

CefDoMessageLoopWork()

def SingleMessageLoop():

# @deprecated, use MessageLoopWork() instead

MessageLoopWork()

def QuitMessageLoop():

Debug("QuitMessageLoop()")

with nogil:

CefQuitMessageLoop()

def Shutdown():

if g_sharedRequestContext.get():

# A similar release is done in RemovePyBrowser and CloseBrowser.

# This one is probably redundant. Additional testing should be done.

Debug("Shutdown: releasing shared request context")

g_sharedRequestContext.Assign(NULL)

# Run some message loop work, force closing browsers and then run

# some message loop work again for the browsers to close cleanly.

#

# CASE 1:

# There might be a case when python error occured after creating

# browser, but before any message loop was run. In such case

# the renderer process won't be terminated unless we run some

# message loop work here first, close browser and free

# reference, and then run some message loop work again.

#

# CASE 2:

# Application closes browser and then calls CEF shutdown. We need

# to run some message loop work so that browser can close cleanly.

# Looks like running message loop work is also required when

# application runs MessageLoop() (Issue #282 and the hello_world.py

# example).

#

# CASE 3:

# Run some message loop work to fix possible errors on shutdown.

# See this post:

# >> https://magpcss.org/ceforum/viewtopic.php?p=30858#p30858

# May be fixed by host owned message loop, see Issue 1805:

# >> https://bitbucket.org/chromiumembedded/cef/issues/1805/

# This 0.2 sec message loop work should close browsers and clean

# CEF references. Even when CloseBrowser(True) wasn't called

# in client app, then this code below should close it cleanly.

# Looks like CEF detects that parent window was destroyed

# and closes browser automatically if you give it some time.

# If the time was not enough, then there is an emergency plan,

# the code block further down that checks len(g_pyBrowsers).

for _ in range(20):

for __ in range(10):

with nogil:

CefDoMessageLoopWork()

time.sleep(0.01)

# Emergency plan in case the code above didn't close browsers,

# and neither browsers were closed in client app. This code

# will force closing browsers by calling CloseBrowser(True)

# and then free global g_pyBrowsers list that keeps CEF

# references alive.

if len(g_pyBrowsers):

browsers_list = []

for browserId in g_pyBrowsers:

# Cannot close browser here otherwise error:

# > dictionary changed size during iteration

browsers_list.append(browserId)

browser_close_forced = False

for browserId in browsers_list:

browser = GetPyBrowserById(browserId)

if browser and browserId not in g_closed_browsers:

Debug("WARNING: Browser was not closed with CloseBrowser call."

" Will close it safely now, but this will delay CEF"

" shutdown by 0.2 sec.")

browser.CloseBrowser(True)

browser_close_forced = True

browser = None # free reference

RemovePyBrowser(browserId)

if browser_close_forced:

for _ in range(20):

for __ in range(10):

with nogil:

CefDoMessageLoopWork()

time.sleep(0.01)

# Message loop work was run, so handlers callbacks might got called

# and browsers might still be in g_pyBrowsers.

for browserId in browsers_list:

if browserId in g_pyBrowsers:

RemovePyBrowser(browserId)

# If the the two code blocks above, that tried to close browsers

# and free CEF references, failed, then display an error about it!

if len(g_pyBrowsers):

NonCriticalError("Shutdown called, but there are still browser"

" references alive")

Debug("Shutdown()")

with nogil:

CefShutdown()

# Release external message pump, as in cefclient after Shutdown

if g_external_message_pump.get():

# Reset will set it to NULL

g_external_message_pump.reset()

def SetOsModalLoop(py_bool modalLoop):

cdef cpp_bool cefModalLoop = bool(modalLoop)

with nogil:

CefSetOSModalLoop(cefModalLoop)

cpdef py_void SetGlobalClientCallback(py_string name, object callback):

global g_globalClientCallbacks

if name in ["OnCertificateError", "OnBeforePluginLoad", "OnAfterCreated"]:

g_globalClientCallbacks[name] = callback

else:

raise Exception("SetGlobalClientCallback() failed: "\

"invalid callback name = %s" % name)

cpdef object GetGlobalClientCallback(py_string name):

global g_globalClientCallbacks

if name in g_globalClientCallbacks:

return g_globalClientCallbacks[name]

else:

return None

cpdef object GetAppSetting(py_string key):

global g_applicationSettings

if key in g_applicationSettings:

return g_applicationSettings[key]

return None