Repository navigation
Expand file tree
/
Copy pathcefpython_app.cpp
More file actions
525 lines (494 loc) · 21.5 KB
/
Copy pathcefpython_app.cpp
File metadata and controls
525 lines (494 loc) · 21.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
// Copyright (c) 2012-2013 The CEF Python authors. All rights reserved.
// License: New BSD License.
// Website: http://code.google.com/p/cefpython/
// BROWSER_PROCESS macro is defined when compiling the libcefpythonapp library.
// RENDERER_PROCESS macro is define when compiling the subprocess executable.
#ifdef BROWSER_PROCESS
#include "cefpython_public_api.h"
#endif
#include "cefpython_app.h"
#include "util.h"
#include "include/cef_runnable.h"
#include "DebugLog.h"
#include <vector>
#include "v8utils.h"
#include "javascript_callback.h"
#include "v8function_handler.h"
bool g_debug = false;
std::string g_logFile = "debug.log";
// -----------------------------------------------------------------------------
// CefApp
// -----------------------------------------------------------------------------
void CefPythonApp::OnBeforeCommandLineProcessing(
const CefString& process_type,
CefRefPtr<CefCommandLine> command_line) {
}
void CefPythonApp::OnRegisterCustomSchemes(
CefRefPtr<CefSchemeRegistrar> registrar) {
}
CefRefPtr<CefResourceBundleHandler> CefPythonApp::GetResourceBundleHandler() {
return NULL;
}
CefRefPtr<CefBrowserProcessHandler> CefPythonApp::GetBrowserProcessHandler() {
return this;
}
CefRefPtr<CefRenderProcessHandler> CefPythonApp::GetRenderProcessHandler() {
return this;
}
// -----------------------------------------------------------------------------
// CefBrowserProcessHandler
// -----------------------------------------------------------------------------
void CefPythonApp::OnContextInitialized() {
REQUIRE_UI_THREAD();
}
void CefPythonApp::OnBeforeChildProcessLaunch(
CefRefPtr<CefCommandLine> command_line) {}
///
// Called on the browser process IO thread after the main thread has been
// created for a new render process. Provides an opportunity to specify extra
// information that will be passed to
// CefRenderProcessHandler::OnRenderThreadCreated() in the render process. Do
// not keep a reference to |extra_info| outside of this method.
///
void CefPythonApp::OnRenderProcessThreadCreated(
CefRefPtr<CefListValue> extra_info) {
// If you have an existing CefListValue that you would like
// to provide, do this:
// | extra_info = mylist.get()
// The equivalent in Cython is:
// | extra_info.Assign(mylist.get())
REQUIRE_IO_THREAD();
#ifdef BROWSER_PROCESS
// This is included only in the Browser process, when building
// the libcefpythonapp library.
BrowserProcessHandler_OnRenderProcessThreadCreated(extra_info);
#endif
}
// -----------------------------------------------------------------------------
// CefRenderProcessHandler
// -----------------------------------------------------------------------------
///
// Called after the render process main thread has been created. |extra_info|
// is a read-only value originating from
// CefBrowserProcessHandler::OnRenderProcessThreadCreated(). Do not keep a
// reference to |extra_info| outside of this method.
///
void CefPythonApp::OnRenderThreadCreated(CefRefPtr<CefListValue> extra_info) {
if (extra_info->GetType(0) == VTYPE_BOOL) {
// printf("!! CefPythonApp::OnRenderThreadCreated(): g_debug OK\n");
g_debug = extra_info->GetBool(0);
}
if (extra_info->GetType(1) == VTYPE_STRING) {
// printf("!! CefPythonApp::OnRenderThreadCreated(): g_logFile OK\n");
g_logFile = extra_info->GetString(1).ToString();
}
}
void CefPythonApp::OnWebKitInitialized() {
}
void CefPythonApp::OnBrowserCreated(CefRefPtr<CefBrowser> browser) {
}
void CefPythonApp::OnBrowserDestroyed(CefRefPtr<CefBrowser> browser) {
DebugLog("Renderer: OnBrowserDestroyed()");
RemoveJavascriptBindings(browser);
}
bool CefPythonApp::OnBeforeNavigation(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefRequest> request,
cef_navigation_type_t navigation_type,
bool is_redirect) {
return false;
}
void CefPythonApp::OnContextCreated(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefV8Context> context) {
DebugLog("Renderer: OnContextCreated()");
CefRefPtr<CefProcessMessage> message = CefProcessMessage::Create(
"OnContextCreated");
CefRefPtr<CefListValue> arguments = message->GetArgumentList();
/*
Sending int64 type using process messaging would require
converting it to a string or a binary, or you could send
two ints, see this topic:
http://www.magpcss.org/ceforum/viewtopic.php?f=6&t=10869
*/
/*
// Example of converting int64 to string. Still need an
// example of converting it back from string.
std::string logMessage = "OnContextCreated(): frameId=";
stringstream stream;
int64 value = frame->GetIdentifier();
stream << value;
logMessage.append(stream.str());
DebugLog(logMessage.c_str());
*/
// TODO: losing int64 precision, the solution is to convert
// it to string and then in the Browser process back
// from string to int64. But it is rather unlikely
// that number of frames will exceed int range, so
// casting it to int for now.
arguments->SetInt(0, (int)(frame->GetIdentifier()));
browser->SendProcessMessage(PID_BROWSER, message);
CefRefPtr<CefDictionaryValue> jsBindings = GetJavascriptBindings(browser);
if (jsBindings.get()) {
// Javascript bindings are most probably not yet set for
// the main frame, they will be set a moment later due to
// process messaging delay. The code seems to be executed
// only for iframes.
if (frame->IsMain()) {
DoJavascriptBindingsForFrame(browser, frame, context);
} else {
if (jsBindings->HasKey("bindToFrames")
&& jsBindings->GetType("bindToFrames") == VTYPE_BOOL
&& jsBindings->GetBool("bindToFrames")) {
DoJavascriptBindingsForFrame(browser, frame, context);
}
}
}
}
void CefPythonApp::OnContextReleased(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefV8Context> context) {
DebugLog("Renderer: OnContextReleased()");
CefRefPtr<CefProcessMessage> message;
CefRefPtr<CefListValue> arguments;
// ------------------------------------------------------------------------
// 1. Send "OnContextReleased" message.
// ------------------------------------------------------------------------
message = CefProcessMessage::Create("OnContextReleased");
arguments = message->GetArgumentList();
arguments->SetInt(0, browser->GetIdentifier());
// TODO: losing int64 precision, the solution is to convert
// it to string and then in the Browser process back
// from string to int64. But it is rather unlikely
// that number of frames will exceed int range, so
// casting it to int for now.
arguments->SetInt(1, (int)(frame->GetIdentifier()));
// Should we send the message using current "browser"
// when this is not the main frame? It could fail, so
// it is more reliable to always use the main browser.
browser->SendProcessMessage(PID_BROWSER, message);
// ------------------------------------------------------------------------
// 2. Remove python callbacks for a frame.
// ------------------------------------------------------------------------
// If this is the main frame then the message won't arrive
// to the browser process, as browser is being destroyed,
// but it doesn't matter because in LifespanHandler_BeforeClose()
// we're calling RemovePythonCallbacksForBrowser().
message = CefProcessMessage::Create("RemovePythonCallbacksForFrame");
arguments = message->GetArgumentList();
// TODO: int64 precision lost
arguments->SetInt(0, (int)(frame->GetIdentifier()));
browser->SendProcessMessage(PID_BROWSER, message);
// ------------------------------------------------------------------------
// 3. Clear javascript callbacks.
// ------------------------------------------------------------------------
RemoveJavascriptCallbacksForFrame(frame);
}
void CefPythonApp::OnUncaughtException(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefV8Context> context,
CefRefPtr<CefV8Exception> exception,
CefRefPtr<CefV8StackTrace> stackTrace) {
}
void CefPythonApp::OnFocusedNodeChanged(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefDOMNode> node) {
}
///
// Called when a new message is received from a different process. Return true
// if the message was handled or false otherwise. Do not keep a reference to
// or attempt to access the message outside of this callback.
///
bool CefPythonApp::OnProcessMessageReceived(CefRefPtr<CefBrowser> browser,
CefProcessId source_process,
CefRefPtr<CefProcessMessage> message) {
std::string messageName = message->GetName().ToString();
std::string logMessage = "Renderer: OnProcessMessageReceived(): ";
logMessage.append(messageName.c_str());
DebugLog(logMessage.c_str());
CefRefPtr<CefListValue> args = message->GetArgumentList();
if (messageName == "DoJavascriptBindings") {
if (args->GetSize() == 1
&& args->GetType(0) == VTYPE_DICTIONARY
&& args->GetDictionary(0)->IsValid()) {
// Is it necessary to make a copy? It won't harm.
SetJavascriptBindings(browser,
args->GetDictionary(0)->Copy(false));
DoJavascriptBindingsForBrowser(browser);
} else {
DebugLog("Renderer: OnProcessMessageReceived(): invalid arguments,"\
" messageName=DoJavascriptBindings");
return false;
}
} else if (messageName == "ExecuteJavascriptCallback") {
if (args->GetType(0) == VTYPE_INT) {
int jsCallbackId = args->GetInt(0);
CefRefPtr<CefListValue> jsArgs;
if (args->IsReadOnly()) {
jsArgs = args->Copy();
} else {
jsArgs = args;
}
// Remove jsCallbackId.
jsArgs->Remove(0);
ExecuteJavascriptCallback(jsCallbackId, jsArgs);
} else {
DebugLog("Renderer: OnProcessMessageReceived: invalid arguments," \
"expected first argument to be a javascript callback " \
"(int)");
return false;
}
}
return true;
}
void CefPythonApp::SetJavascriptBindings(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefDictionaryValue> data) {
javascriptBindings_[browser->GetIdentifier()] = data;
}
CefRefPtr<CefDictionaryValue> CefPythonApp::GetJavascriptBindings(
CefRefPtr<CefBrowser> browser) {
int browserId = browser->GetIdentifier();
if (javascriptBindings_.find(browserId) != javascriptBindings_.end()) {
return javascriptBindings_[browserId];
}
return NULL;
}
void CefPythonApp::RemoveJavascriptBindings(CefRefPtr<CefBrowser> browser) {
int browserId = browser->GetIdentifier();
if (javascriptBindings_.find(browserId) != javascriptBindings_.end()) {
javascriptBindings_.erase(browserId);
}
}
bool CefPythonApp::BindedFunctionExists(CefRefPtr<CefBrowser> browser,
const CefString& functionName) {
CefRefPtr<CefDictionaryValue> jsBindings = GetJavascriptBindings(browser);
if (!jsBindings.get()) {
return false;
}
std::string strFunctionName = functionName.ToString();
size_t dotPosition = strFunctionName.find(".");
if (std::string::npos != dotPosition) {
// This is a method call, functionName == "object.method".
CefString objectName(strFunctionName.substr(0, dotPosition));
CefString methodName(strFunctionName.substr(dotPosition + 1,
std::string::npos));
if (!(jsBindings->HasKey("objects")
&& jsBindings->GetType("objects") == VTYPE_DICTIONARY)) {
DebugLog("Renderer: BindedFunctionExists() FAILED: "\
"objects dictionary not found");
return false;
}
CefRefPtr<CefDictionaryValue> objects = \
jsBindings->GetDictionary("objects");
if (objects->HasKey(objectName)) {
if (!(objects->GetType(objectName) == VTYPE_DICTIONARY)) {
DebugLog("Renderer: BindedFunctionExists() FAILED: "\
"objects dictionary has invalid type");
return false;
}
CefRefPtr<CefDictionaryValue> methods = \
objects->GetDictionary(objectName);
return methods->HasKey(methodName);
} else {
return false;
}
} else {
// This is a function call.
if (!(jsBindings->HasKey("functions")
&& jsBindings->GetType("functions") == VTYPE_DICTIONARY)) {
DebugLog("Renderer: BindedFunctionExists() FAILED: "\
"functions dictionary not found");
return false;
}
CefRefPtr<CefDictionaryValue> functions = \
jsBindings->GetDictionary("functions");
return functions->HasKey(functionName);
}
}
void CefPythonApp::DoJavascriptBindingsForBrowser(
CefRefPtr<CefBrowser> browser) {
// get frame
// get context
// if bindToFrames is true loop through all frames,
// otherwise just the main frame.
// post task on a valid v8 thread
CefRefPtr<CefDictionaryValue> jsBindings = GetJavascriptBindings(browser);
if (!jsBindings.get()) {
// Bindings must be set before this function is called.
DebugLog("Renderer: DoJavascriptBindingsForBrowser() FAILED: " \
"bindings not set");
return;
}
std::vector<int64> frameIds;
if (jsBindings->HasKey("bindToFrames")
&& jsBindings->GetType("bindToFrames") == VTYPE_BOOL
&& jsBindings->GetBool("bindToFrames")) {
browser->GetFrameIdentifiers(frameIds);
// CEF BUG: frameIds contain just one frame with frameId=0
if (frameIds.size() == 1 && frameIds[0] == 0) {
frameIds.push_back(browser->GetMainFrame()->GetIdentifier());
}
} else {
frameIds.push_back(browser->GetMainFrame()->GetIdentifier());
}
/*
Another way:
| for (std::vector<int64>::iterator it = v.begin(); it != v.end(); ++it) {
| CefRefPtr<CefFrame> frame = browser->GetFrame(*it);
*/
if (!frameIds.size()) {
DebugLog("Renderer: DoJavascriptBindingsForBrowser() FAILED: " \
"frameIds.size() == 0");
return;
}
for (std::vector<int>::size_type i = 0; i != frameIds.size(); i++) {
if (frameIds[i] <= 0) {
// Frame not yet created, race condition / bug in CEF.
DebugLog("Renderer: DoJavascriptBindingsForBrowser() WARNING: " \
"frameId <= 0");
printf("cefpython: Renderer: frameId = %li\n", frameIds[i]);
continue;
}
CefRefPtr<CefFrame> frame = browser->GetFrame(frameIds[i]);
if (!frame.get()) {
DebugLog("Renderer: DoJavascriptBindingsForBrowser() WARNING: " \
"GetFrame() failed");
continue;
}
CefRefPtr<CefV8Context> context = frame->GetV8Context();
CefRefPtr<CefTaskRunner> taskRunner = context->GetTaskRunner();
taskRunner->PostTask(NewCefRunnableMethod(
this, &CefPythonApp::DoJavascriptBindingsForFrame,
browser, frame, context));
}
}
void CefPythonApp::DoJavascriptBindingsForFrame(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame,
CefRefPtr<CefV8Context> context) {
CefRefPtr<CefDictionaryValue> jsBindings = GetJavascriptBindings(browser);
if (!jsBindings.get()) {
// Bindings may not yet be set, it's okay.
DebugLog("Renderer: DoJavascriptBindingsForFrame(): bindings not set");
return;
}
DebugLog("Renderer: DoJavascriptBindingsForFrame(): bindings are set");
if (!(jsBindings->HasKey("functions")
&& jsBindings->GetType("functions") == VTYPE_DICTIONARY
&& jsBindings->HasKey("properties")
&& jsBindings->GetType("properties") == VTYPE_DICTIONARY
&& jsBindings->HasKey("objects")
&& jsBindings->GetType("objects") == VTYPE_DICTIONARY
&& jsBindings->HasKey("bindToFrames")
&& jsBindings->GetType("bindToFrames") == VTYPE_BOOL)) {
DebugLog("Renderer: DoJavascriptBindingsForFrame() FAILED: " \
"invalid data [1]");
return;
}
// A context must be explicitly entered before creating a
// V8 Object, Array, Function or Date asynchronously.
bool enteredContext = false;
if (!context->IsSame(CefV8Context::GetCurrentContext())) {
enteredContext = true;
context->Enter();
}
CefRefPtr<CefDictionaryValue> functions = \
jsBindings->GetDictionary("functions");
CefRefPtr<CefDictionaryValue> properties = \
jsBindings->GetDictionary("properties");
CefRefPtr<CefDictionaryValue> objects = \
jsBindings->GetDictionary("objects");
// Here in this function we bind only for the current frame.
// | bool bindToFrames = jsBindings->GetBool("bindToFrames");
if (!(functions->IsValid() && properties->IsValid()
&& objects->IsValid())) {
DebugLog("Renderer: DoJavascriptBindingsForFrame() FAILED: " \
"invalid data [2]");
if (enteredContext)
context->Exit();
return;
}
CefRefPtr<CefV8Value> v8Window = context->GetGlobal();
CefRefPtr<CefV8Value> v8Function;
CefRefPtr<CefV8Handler> v8FunctionHandler(new V8FunctionHandler(this, 0));
// FUNCTIONS.
std::vector<CefString> functionsVector;
if (!functions->GetKeys(functionsVector)) {
DebugLog("Renderer: DoJavascriptBindingsForFrame(): " \
"functions->GetKeys() FAILED");
if (enteredContext)
context->Exit();
return;
}
for (std::vector<CefString>::iterator it = functionsVector.begin(); \
it != functionsVector.end(); ++it) {
CefString functionName = *it;
v8Function = CefV8Value::CreateFunction(functionName,
v8FunctionHandler);
v8Window->SetValue(functionName, v8Function,
V8_PROPERTY_ATTRIBUTE_NONE);
}
// PROPERTIES.
CefRefPtr<CefV8Value> v8Properties = CefDictionaryValueToV8Value(
properties);
std::vector<CefString> v8Keys;
if (!v8Properties->GetKeys(v8Keys)) {
DebugLog("DoJavascriptBindingsForFrame() FAILED: " \
"v8Properties->GetKeys() failed");
if (enteredContext)
context->Exit();
return;
}
for (std::vector<CefString>::iterator it = v8Keys.begin(); \
it != v8Keys.end(); ++it) {
CefString v8Key = *it;
CefRefPtr<CefV8Value> v8Value = v8Properties->GetValue(v8Key);
v8Window->SetValue(v8Key, v8Value, V8_PROPERTY_ATTRIBUTE_NONE);
}
// OBJECTS AND ITS METHODS.
std::vector<CefString> objectsVector;
if (!objects->GetKeys(objectsVector)) {
DebugLog("Renderer: DoJavascriptBindingsForFrame() FAILED: " \
"objects->GetKeys() failed");
if (enteredContext)
context->Exit();
return;
}
for (std::vector<CefString>::iterator it = objectsVector.begin(); \
it != objectsVector.end(); ++it) {
CefString objectName = *it;
CefRefPtr<CefV8Value> v8Object = CefV8Value::CreateObject(NULL);
v8Window->SetValue(objectName, v8Object, V8_PROPERTY_ATTRIBUTE_NONE);
// METHODS.
if (!(objects->GetType(objectName) == VTYPE_DICTIONARY)) {
DebugLog("Renderer: DoJavascriptBindingsForFrame() FAILED: " \
"objects->GetType() != VTYPE_DICTIONARY");
if (enteredContext)
context->Exit();
return;
}
CefRefPtr<CefDictionaryValue> methods = \
objects->GetDictionary(objectName);
std::vector<CefString> methodsVector;
if (!(methods->IsValid() && methods->GetKeys(methodsVector))) {
DebugLog("Renderer: DoJavascriptBindingsForFrame() FAILED: " \
"methods->GetKeys() failed");
if (enteredContext)
context->Exit();
return;
}
for (std::vector<CefString>::iterator it = methodsVector.begin(); \
it != methodsVector.end(); ++it) {
CefString methodName = *it;
// fullMethodName = "object.method"
std::string fullMethodName = objectName.ToString().append(".") \
.append(methodName.ToString());
v8Function = CefV8Value::CreateFunction(fullMethodName,
v8FunctionHandler);
v8Object->SetValue(methodName, v8Function,
V8_PROPERTY_ATTRIBUTE_NONE);
}
}
// END.
if (enteredContext)
context->Exit();
}