Implemented [RequestHandler].OnResourceResponse(), example added to cefadvanced.py

cztomczak · cztomczak · commit 6d6546755f01 · 2012-09-24T12:21:13.000+01:00
diff --git a/_code cleanup.txt b/_code cleanup.txt
@@ -0,0 +1,8 @@
+- Get rid of mutable arguments:
+	PyBrowser.__init__
+	Initialize()
+
+- Global variables should not use "__" prefix, as it is not
+	allowed to use such variables from inside classes.
+	Use g_ prefix or capitalize, so that "__applicationSettings"
+	becomes "ApplicationSettings" or "g_applicationSettings".
diff --git a/_get rid of mutable arguments.txt b/_get rid of mutable arguments.txt
diff --git a/cefexample/_changelog.txt b/cefexample/_changelog.txt
@@ -3,6 +3,7 @@ Version 0.42 not yet released.
  * en-US locale was outdated, came from revision `607`, locales/ directory contains all locales now, the default one is "en-US", others are optional and do not need to be distributed.
  * !OnConsoleMessage example added to cefadvanced.py
  * You can now get javascript stack trace, see: [cefpython].!GetJavascriptStackTrace() and [cefpython].!GetJavascriptStackTraceFormatted().
+ * Implemented [RequestHandler].OnResourceResponse(), example added to cefadvanced.py
 
 Version 0.41 released on 2012-09-14.
  * New options in [ApplicationSettings]: auto_detect_proxy_settings_enabled, pack_loading_disabled.
diff --git a/cefexample/cefadvanced.py b/cefexample/cefadvanced.py
@@ -62,6 +62,7 @@ def CefAdvanced():
 	handlers["OnLoadError"] = clientHandler.OnLoadError
 	handlers["OnKeyEvent"] = (clientHandler.OnKeyEvent, None, clientHandler.OnKeyEvent)
 	handlers["OnConsoleMessage"] = clientHandler.OnConsoleMessage
+	handlers["OnResourceResponse"] = clientHandler.OnResourceResponse
 
 	cefBindings = cefpython.JavascriptBindings(bindToFrames=False, bindToPopups=False)
 	browser = cefpython.CreateBrowser(windowID, browserSettings, "cefadvanced.html", handlers, cefBindings)
@@ -140,8 +141,8 @@ def HandleJavascriptError(errorMessage, url, lineNumber):
 		url = re.sub(r"[/\\]+", re.escape(os.sep), url)
 		url = re.sub(r"%s" % re.escape(cefpython.GetRealPath()), "", url, flags=re.IGNORECASE)
 		url = re.sub(r"^%s" % re.escape(os.sep), "", url)
-	stackTrace = cefpython.GetJavascriptStackTraceFormatted()
-	raise Exception("%s\n in %s on line %s\n\n%s" % (errorMessage, url, lineNumber, stackTrace))
+	# stackTrace = cefpython.GetJavascriptStackTraceFormatted() # Getting stack trace from window.onerror context doesn't work.
+	raise Exception("%s\n in %s on line %s\n\n" % (errorMessage, url, lineNumber))
 
 class Python:
 
@@ -292,12 +293,17 @@ def OnConsoleMessage(self, browser, message, source, line):
 			appdir = appdir[0].upper() + appdir[1:]
 		source = source.replace("file:///", "")
 		source = source.replace(appdir, "")
-		#if (message.lower().find("error") != -1): # DOESN'T WORK, stack trace is empty in this context.
+		#if (message.lower().find("error") != -1): # Doesn't work, stack trace is empty in this context.
 			#stackTrace = cefpython.GetJavascriptStackTraceFormatted()
 			#raise Exception("%s\n in %s on line %s\n\n%s" % (message, source, line, stackTrace))
 		print("Console message: %s (%s:%s)\n" % (message, source, line));
 		return False
 
+	def OnResourceResponse(self, browser, url, response, filter):
+
+		# This function does not get called for local disk sources (file:///).
+		print("Resource: %s (status=%s)" % (url, response.GetStatus()))
+
 
 if __name__ == "__main__":
 	
diff --git a/cefexample/cefpython.py b/cefexample/cefpython.py
@@ -705,3 +705,33 @@ def VisitDOM(visitor):
 		return None
 	"""
 
+class Response:
+
+	def GetStatus(self):
+		return 0
+
+	def SetStatus(self, status):
+		return None
+
+	def GetStatusText(self):
+		return ""
+
+	def SetStatusText(self, statusText):
+		return None
+
+	def GetMimeType(self):
+		return ""
+
+	def SetMimeType(self, mimeType):
+		return None
+
+	def GetHeader(self, name):
+		return ""
+
+	"""
+	def GetHeaderMap(self):
+		return [("","")]
+
+	def SetHeaderMap(self, headerMap):
+		return None
+	"""
diff --git a/cefpython.pyx b/cefpython.pyx
@@ -47,6 +47,7 @@ include "v8utils.pyx"
 include "javascriptcallback.pyx"
 include "pythoncallback.pyx"
 include "requesthandler.pyx"
+include "response.pyx"
 include "displayhandler.pyx"
 
 # Client handler.
diff --git a/pyinclude/cef_response.pxd b/pyinclude/cef_response.pxd
@@ -3,8 +3,23 @@
 # Website: http://code.google.com/p/cefpython/
 
 from cef_base cimport CefBase
+from cef_string cimport CefString
+from libcpp.map cimport map
 
 cdef extern from "include/cef_response.h":
+
+	# TODO: create .pxd for std::multimap
+	# ctypedef multimap[CefString, CefString] HeaderMap
 	
 	cdef cppclass CefResponse(CefBase):
-		pass
+		
+		int GetStatus()
+		void SetStatus(int status)
+		CefString GetStatusText()
+		void SetStatusText(CefString& statusText)
+		CefString GetMimeType()
+		void SetMimeType(CefString& mimeType)
+		CefString GetHeader(CefString& name)
+		# virtual void GetHeaderMap(HeaderMap& headerMap) =0;
+		# virtual void SetHeaderMap(const HeaderMap& headerMap) =0;
+
diff --git a/requesthandler.pyx b/requesthandler.pyx
@@ -58,7 +58,7 @@ cdef public cbool RequestHandler_OnBeforeResourceLoad(
 		pyRequest = GetPyRequestByCefRequest(cefRequest)
 		pyRedirectURL = [""]
 		pyResourceStream = GetPyStreamReaderByCefStreamReader(cefResourceStream)
-		pyResponse = GetPyResponseByCefResponse(cefResponse)
+		pyResponse = None
 
 		handler = pyBrowser.GetClientHandler("OnBeforeResourceLoad")
 		if handler:
@@ -102,13 +102,10 @@ cdef public void RequestHandler_OnResourceResponse(
 		CefRefPtr[CefResponse] cefResponse,
 		CefRefPtr[CefContentFilter]& cefFilter) except * with gil:
 
-	# TODO: not yet implemented.
-	return
-
 	try:
 		pyBrowser = GetPyBrowserByCefBrowser(cefBrowser)
 		pyURL = CefStringToPyString(cefURL)
-		pyResponse = GetPyResponseByCefResponse(cefResponse)
+		pyResponse = CreatePyResponse(cefResponse)
 		pyFilter = None # TODO.
 
 		handler = pyBrowser.GetClientHandler("OnResourceResponse")
diff --git a/response.pyx b/response.pyx
@@ -0,0 +1,78 @@
+# Copyright (c) 2012 CefPython Authors. All rights reserved.
+# License: New BSD License.
+# Website: http://code.google.com/p/cefpython/
+
+include "imports.pyx"
+
+cdef object CreatePyResponse(CefRefPtr[CefResponse] cefResponse):
+
+	pyResponse = PyResponse()
+	pyResponse.cefResponse = cefResponse
+	return pyResponse
+
+cdef class PyResponse:
+
+	cdef CefRefPtr[CefResponse] cefResponse
+
+	def CheckCefResponse(self):
+
+		if <void*>self.cefResponse != NULL and <CefResponse*>(self.cefResponse.get()):
+			return True
+		else:
+			raise Exception("CefResponse was destroyed, you cannot use this object anymore")
+
+	def GetStatus(self):
+
+		self.CheckCefResponse()
+		return (<CefResponse*>(self.cefResponse.get())).GetStatus()
+
+	def SetStatus(self, status):
+
+		self.CheckCefResponse()
+		assert type(status) == int, "Response.SetStatus() failed: status param is not an int"		
+		(<CefResponse*>(self.cefResponse.get())).SetStatus(int(status))
+
+	def GetStatusText(self):
+
+		self.CheckCefResponse()
+		return CefStringToPyString((<CefResponse*>(self.cefResponse.get())).GetStatusText())
+
+	def SetStatusText(self, statusText):
+
+		self.CheckCefResponse()
+		assert type(statusText) in (str, unicode, bytes), "Response.SetStatusText() failed: statusText param is not a string"
+		cdef CefString cefStatusText
+		PyStringToCefString(statusText, cefStatusText)
+		(<CefResponse*>(self.cefResponse.get())).SetStatusText(cefStatusText)
+
+	def GetMimeType(self):
+
+		self.CheckCefResponse()
+		return CefStringToPyString((<CefResponse*>(self.cefResponse.get())).GetMimeType())
+
+	def SetMimeType(self, mimeType):
+
+		self.CheckCefResponse()
+		assert type(mimeType) in (str, unicode, bytes), "Response.SetMimeType() failed: mimeType param is not a string"
+		cdef CefString cefMimeType
+		PyStringToCefString(mimeType, cefMimeType)
+		(<CefResponse*>(self.cefResponse.get())).SetMimeType(cefMimeType)
+
+	def GetHeader(self, name):
+
+		# TODO: what is returned when you try to get a non-existent header?
+		self.CheckCefResponse()
+		assert type(name) in (str, unicode, bytes), "Response.GetHeader() failed: name param is not a string"
+		cdef CefString cefName
+		PyStringToCefString(name, cefName)
+		return CefStringToPyString((<CefResponse*>(self.cefResponse.get())).GetHeader(cefName))
+
+	"""
+	def GetHeaderMap(self):
+
+		pass # TODO.
+
+	def SetHeaderMap(self, headerMap):
+
+		pass # TODO.
+	"""
diff --git a/utils.pyx b/utils.pyx
@@ -116,11 +116,6 @@ cdef object GetPyStreamReaderByCefStreamReader(CefRefPtr[CefStreamReader] cefStr
 	# TODO: not yet implemented.
 	return None
 
-cdef object GetPyResponseByCefResponse(CefRefPtr[CefResponse] cefResponse):
-
-	# TODO: not yet implemented.
-	return None
-
 cdef object GetPyContentFilterByCefContentFilter(CefRefPtr[CefContentFilter] cefContentFilter):
 
 	# TODO: not yet implemented.
@@ -255,18 +250,32 @@ cdef object CefStringToPyString(CefString& cefString):
 
 cdef void PyStringToCefString(pyString, CefString& cefString) except *:
 	
-	if bytes == str:
+	if bytes == str: 
+		# Python 2.7
+		if pyString == unicode:
+			pyString = pyString.encode(__applicationSettings["unicode_to_bytes_encoding"])
 		cefString.FromASCII(<char*>pyString) # Python 2.7
-	else:
-		# In python 3 bytes and str are different types.
-		bytesString = pyString.encode("utf-8") # Python 3 requires bytes before converting to char*
+	else: 
+		# Python 3
+		# Python 3 requires bytes before converting to char*
+		if pyString == bytes:
+			bytesString = pyString
+		else:
+			bytesString = pyString.encode("utf-8")	
 		cefString.FromASCII(<char*>bytesString)
 
 cdef void PyStringToCefStringPtr(pyString, CefString* cefString) except *:
 	
 	if bytes == str:
-		cefString.FromASCII(<char*>pyString) # Python 2.7
+		# Python 2.7
+		if pyString == unicode:
+			pyString = pyString.encode(__applicationSettings["unicode_to_bytes_encoding"])
+		cefString.FromASCII(<char*>pyString)
 	else:
-		# In python 3 bytes and str are different types.
-		bytesString = pyString.encode("utf-8") # Python 3 requires bytes before converting to char*
+		# Python 3
+		# Python 3 requires bytes before converting to char*
+		if pyString == bytes:
+			bytesString = pyString
+		else:
+			bytesString = pyString.encode("utf-8")	
 		cefString.FromASCII(<char*>bytesString)
