This repository was archived by the owner on Aug 2, 2025. It is now read-only.
forked from cztomczak/cefpython
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathframe.pyx
More file actions
261 lines (219 loc) · 9.85 KB
/
frame.pyx
File metadata and controls
261 lines (219 loc) · 9.85 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
# Copyright (c) 2012 CEF Python, see the Authors file.
# All rights reserved. Licensed under BSD 3-clause license.
# Project website: https://github.com/cztomczak/cefpython
include "cefpython.pyx"
include "browser.pyx"
cdef dict g_pyFrames = {}
# If a frame was unreferenced (browser closed or OnContextReleased)
# it shouldn't be kept global anymore.
cdef list g_unreferenced_frames = [] # [str unique identifier, ..]
cdef object GetUniqueFrameId(int browserId, object frameId):
return str(browserId) +"#"+ str(frameId)
cdef PyFrame GetPyFrameById(int browserId, object frameId):
cdef object uniqueFrameId = GetUniqueFrameId(browserId, frameId)
if uniqueFrameId in g_pyFrames:
return g_pyFrames[uniqueFrameId]
return None
cdef PyFrame GetPyFrame(CefRefPtr[CefFrame] cefFrame):
global g_pyFrames
#lc void*
if not cefFrame.get():
raise Exception("GetPyFrame(): CefFrame reference is NULL")
cdef PyFrame pyFrame
cdef object frameId = cefFrame.get().GetIdentifier() # int64
cdef int browserId = cefFrame.get().GetBrowser().get().GetIdentifier()
assert (frameId and browserId), "frameId or browserId empty"
cdef object uniqueFrameId = GetUniqueFrameId(browserId, frameId)
if frameId < 0:
# Underlying frame does not yet exist. In such case PyFrame
# is not stored in g_pyFrames since frameId is invalid.
# However even though frame is not supposed to exist, you
# can still call CefFrame.ExecuteFunction and it works fine
# in tutorial.py example.
Debug("GetPyFrame(): underlying frame does not yet exist:"
" browserId = {0}, frameId = {1}".format(browserId, frameId))
else:
if uniqueFrameId in g_pyFrames:
return g_pyFrames[uniqueFrameId]
# This code probably ain't needed.
# ----
cdef list toRemove = []
for uFid, pyFrame in g_pyFrames.items():
if not pyFrame.cefFrame.get():
toRemove.append(uFid)
for uFid in toRemove:
Debug("GetPyFrame(): removing an empty CefFrame reference, "
"uniqueFrameId = %s" % uniqueFrameId)
del g_pyFrames[uFid]
# ----
pyFrame = PyFrame(browserId, frameId)
pyFrame.cefFrame = cefFrame
if uniqueFrameId in g_unreferenced_frames \
or frameId < 0 \
or browserId in g_unreferenced_browsers \
or browserId in g_closed_browsers:
# Browser was already globally unreferenced in OnBeforeClose,
# thus all frames are globally unreferenced too, or frame
# was unreferenced in OnContextReleased. Create a new
# incomplete instance of PyFrame object. Read comments in
# browser.pyx > GetPyBrowser and in Browser.md for what
# "incomplete" means.
pass
else:
# Keep a global reference to this frame only if the browser
# wasn't destroyed in OnBeforeClose. Otherwise we would leave
# dead frames references living forever.
# SIDE EFFECT: two calls to GetPyFrame for the same frame object
# may return two different PyFrame objects. Compare
# frame objects always using GetIdentifier().
Debug("GetPyFrame(): create new PyFrame, frameId=%s" % frameId)
g_pyFrames[uniqueFrameId] = pyFrame
return pyFrame
cdef void RemovePyFrame(int browserId, object frameId) except *:
# Called from V8ContextHandler_OnContextReleased().
global g_pyFrames
cdef PyFrame pyFrame
cdef object uniqueFrameId = GetUniqueFrameId(browserId, frameId)
if uniqueFrameId in g_pyFrames:
Debug("del g_pyFrames[%s]" % uniqueFrameId)
pyFrame = g_pyFrames[uniqueFrameId]
pyFrame.cefFrame.Assign(nullptr)
del pyFrame
del g_pyFrames[uniqueFrameId]
g_unreferenced_frames.append(uniqueFrameId)
RemovePythonCallbacksForFrame(frameId)
else:
Debug("RemovePyFrame() FAILED: uniqueFrameId = %s" % uniqueFrameId)
cdef void RemovePyFramesForBrowser(int browserId) except *:
# Called from LifespanHandler_BeforeClose().
cdef list toRemove = []
cdef object uniqueFrameId
cdef PyFrame pyFrame
global g_pyFrames
for uniqueFrameId, pyFrame in g_pyFrames.iteritems():
if pyFrame.GetBrowserIdentifier() == browserId:
toRemove.append(uniqueFrameId)
for uniqueFrameId in toRemove:
Debug("del g_pyFrames[%s]" % uniqueFrameId)
pyFrame = g_pyFrames[uniqueFrameId]
pyFrame.cefFrame.Assign(nullptr)
del pyFrame
del g_pyFrames[uniqueFrameId]
g_unreferenced_frames.append(uniqueFrameId)
# RemovePythonCallbacksForBrowser already called
# in LifespanHandler_OnBeforeClose.
cdef class PyFrame:
cdef CefRefPtr[CefFrame] cefFrame
cdef int browserId
cdef object frameId
cdef CefRefPtr[CefFrame] GetCefFrame(self) except *:
# Do not call IsValid() here, if the frame does not exist
# then no big deal, no reason to crash the application.
# The CEF calls will fail, but they also won't cause crash.
#lc void*
if self.cefFrame.get():
return self.cefFrame
raise Exception("PyFrame.GetCefFrame() failed: CefFrame was destroyed")
def __init__(self, int browserId, int64 frameId):
self.browserId = browserId
self.frameId = frameId
cpdef py_bool IsValid(self):
#lc void*
if self.cefFrame.get() \
and self.cefFrame.get().IsValid():
return True
return False
def CallFunction(self, *args):
# DEPRECATED - keep for backwards compatibility.
self.ExecuteFunction(*args)
cpdef py_void Copy(self):
self.GetCefFrame().get().Copy()
cpdef py_void Cut(self):
self.GetCefFrame().get().Cut()
cpdef py_void Delete(self):
self.GetCefFrame().get().Delete()
def ExecuteFunction(self, funcName, *args):
# No need to enter V8 context as we're calling javascript
# asynchronously using ExecuteJavascript() function.
code = funcName+"("
for i in range(0, len(args)):
if i != 0:
code += ", "
code += json.dumps(args[i])
code += ")"
self.ExecuteJavascript(code)
cpdef py_void ExecuteJavascript(self, py_string jsCode,
py_string scriptUrl="", int startLine=1):
self.GetCefFrame().get().ExecuteJavaScript(PyToCefStringValue(jsCode),
PyToCefStringValue(scriptUrl), startLine)
cpdef object GetIdentifier(self):
# It is better to save browser and frame identifiers during
# browser instantiation. When freeing PyBrowser and PyFrame
# we need these identifiers. CefFrame and CefBrowser may already
# be freed and calling methods on these objects may fail, this
# may or may not include GetIdentifier() method, but let's be sure.
return self.frameId
cpdef PyFrame GetParent(self):
return GetPyFrame(self.GetCefFrame().get().GetParent())
cpdef PyBrowser GetBrowser(self):
return GetPyBrowser(self.GetCefFrame().get().GetBrowser())
cpdef int GetBrowserIdentifier(self) except *:
return self.browserId
cpdef str GetName(self):
return CefToPyString(self.GetCefFrame().get().GetName())
cpdef py_void GetSource(self, object visitor):
self.GetCefFrame().get().GetSource(CreateStringVisitor(visitor))
cpdef py_void GetText(self, object visitor):
self.GetCefFrame().get().GetText(CreateStringVisitor(visitor))
cpdef str GetUrl(self):
return CefToPyString(self.GetCefFrame().get().GetURL())
cpdef py_bool IsFocused(self):
return self.GetCefFrame().get().IsFocused()
cpdef py_bool IsMain(self):
return self.GetCefFrame().get().IsMain()
# cpdef py_void LoadString(self, py_string value, py_string url):
# cdef CefString cefValue
# cdef CefString cefUrl
# PyToCefString(value, cefValue)
# PyToCefString(url, cefUrl)
# self.GetCefFrame().get().LoadString(cefValue, cefUrl)
cpdef py_void LoadUrl(self, py_string url):
cdef CefString cefUrl
PyToCefString(url, cefUrl)
self.GetCefFrame().get().LoadURL(cefUrl)
cpdef py_void Paste(self):
self.GetCefFrame().get().Paste()
cpdef py_void Redo(self):
self.GetCefFrame().get().Redo()
cpdef py_void SelectAll(self):
self.GetCefFrame().get().SelectAll()
cpdef py_void Undo(self):
self.GetCefFrame().get().Undo()
cpdef py_void ViewSource(self):
self.GetCefFrame().get().ViewSource()
cdef void SendProcessMessage(self, cef_process_id_t targetProcess,
object frameId, py_string messageName, list pyArguments
) except *:
cdef CefRefPtr[CefProcessMessage] message = \
CefProcessMessage_Create(PyToCefStringValue(messageName))
# This does not work, no idea why, the CEF implementation
# seems not to allow it, both Assign() and swap() do not work:
# | message.get().GetArgumentList().Assign(arguments.get())
# | message.get().GetArgumentList().swap(arguments)
cdef CefRefPtr[CefListValue] messageArguments = \
message.get().GetArgumentList()
PyListToExistingCefListValue(self.GetBrowserIdentifier(),
frameId,
pyArguments, messageArguments)
Debug("SendProcessMessage(): message=%s, arguments size=%d" % (
messageName,
message.get().GetArgumentList().get().GetSize()))
#lc test
# cdef cpp_bool success = \
# self.GetCefFrame().get().SendProcessMessage(
# targetProcess,
# message)
# if not success:
# raise Exception("Frame.SendProcessMessage() failed: "\
# "messageName=%s" % messageName)
self.GetCefFrame().get().SendProcessMessage(targetProcess, message)