Fixed keyboard errors in the Kivy example when local keyboard

cztomczak · cztomczak · commit 4687bacf243b · 2013-09-19T13:20:32.000+02:00
mode is used and when visiting webpages that contain frames
(youtube for example).
diff --git a/cefpython/cef3/linux/binaries_64bit/kivy_.py b/cefpython/cef3/linux/binaries_64bit/kivy_.py
@@ -64,7 +64,7 @@ class CefBrowser(Widget):
     # Keyboard mode: "global" or "local".
     # 1. Global mode forwards keys to CEF all the time.
     # 2. Local mode forwards keys to CEF only when an editable
-    #    control is focused (input type=text or textarea).
+    #    control is focused (input type=text|password or textarea).
     keyboard_mode = "global"
     
     '''Represent a browser widget for kivy, which can be used like a normal widget.
@@ -208,9 +208,25 @@ def set_js_bindings(self):
     
 
     def change_url(self, *kwargs):
-        self.browser.Navigate("http://www.google.com/")
-        self._client_handler._reset_js_bindings = True
+        # Doing a javascript redirect instead of Navigate()
+        # solves the js bindings error. The url here need to
+        # be preceded with "http://". Calling StopLoad()
+        # might be a good idea before making the js navigation.
+        
+        self.browser.StopLoad()
+        self.browser.GetMainFrame().ExecuteJavascript(
+               "window.location='http://www.youtube.com/'")
+
+        # Do not use Navigate() or GetMainFrame()->LoadURL(),
+        # as it causes the js bindings to be removed. There is
+        # a bug in CEF, that happens after a call to Navigate().
+        # The OnBrowserDestroyed() callback is fired and causes 
+        # the js bindings to be removed. See this topic for more 
+        # details:
+        # http://www.magpcss.org/ceforum/viewtopic.php?f=6&t=11009
 
+        # OFF:
+        # | self.browser.Navigate("http://www.youtube.com/")
 
     _keyboard = None
 
@@ -226,13 +242,15 @@ def request_keyboard(self):
         self.is_ctrl2 = False
         self.is_alt1 = False
         self.is_alt2 = False
-        # Browser lost its focus after the LoadURL() and the 
-        # OnBrowserDestroyed() callback bug. This will only work
-        # when keyboard mode is local.
+        # Not sure if it is still required to send the focus
+        # (some earlier bug), but it shouldn't hurt to call it.
         self.browser.SendFocusEvent(True)
 
 
     def release_keyboard(self):
+        # When using local keyboard mode, do all the request
+        # and releases of the keyboard through js bindings,
+        # otherwise some focus problems arise.
         self.is_shift1 = False
         self.is_shift2 = False
         self.is_ctrl1 = False
@@ -594,15 +612,6 @@ def OnLoadingStateChange(self, browser, isLoading, canGoBack,
             canGoForward):
         print("OnLoadingStateChange(): isLoading = %s" % isLoading)
         browserWidget = browser.GetUserData("browserWidget")
-        if self._reset_js_bindings and not isLoading:
-            if browserWidget:
-                browserWidget.set_js_bindings()
-                self._reset_js_bindings = False
-        if isLoading and browserWidget \
-                and browserWidget.keyboard_mode == "local":
-            # Release keyboard when navigating to a new page.
-            browserWidget.release_keyboard()
-            pass
 
     
     def OnPaint(self, browser, paintElementType, dirtyRects, buffer, width, 
diff --git a/cefpython/cef3/subprocess/cefpython_app.cpp b/cefpython/cef3/subprocess/cefpython_app.cpp
@@ -14,6 +14,7 @@
 #include "include/cef_runnable.h"
 #include "DebugLog.h"
 #include <vector>
+#include <algorithm>
 #include "v8utils.h"
 #include "javascript_callback.h"
 #include "v8function_handler.h"
@@ -350,36 +351,54 @@ void CefPythonApp::DoJavascriptBindingsForBrowser(
         return;
     }
     std::vector<int64> frameIds;
+    std::vector<CefString> frameNames;
     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());
+        // GetFrameIdentifiers() is buggy, returns always a vector
+        // filled with zeroes (as of revision 1448). Use GetFrameNames()
+        // instead.
+        browser->GetFrameNames(frameNames);
+        for (std::vector<CefString>::iterator it = frameNames.begin(); \
+                it != frameNames.end(); ++it) {
+            CefRefPtr<CefFrame> frame = browser->GetFrame(*it);
+            if (frame.get()) {
+                frameIds.push_back(frame->GetIdentifier());
+                // | printf("GetFrameNames(): frameId = %lu\n", 
+                // |         frame->GetIdentifier());
+            }
         }
-    } else {
+    }
+    // BUG in CEF: 
+    //   GetFrameNames() does not return the main frame (as of revision 1448).
+    //   Make it work for the future when this bug gets fixed.
+    std::vector<int64>::iterator find_it = std::find(
+            frameIds.begin(), frameIds.end(), 
+            browser->GetMainFrame()->GetIdentifier());
+    if (find_it == frameIds.end()) {
+        // Main frame not found in frameIds vector, add it now.
+        // | printf("Adding main frame to frameIds: %lu\n",
+        // |         browser->GetMainFrame()->GetIdentifier());
         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.
+    for (std::vector<int64>::iterator it = frameIds.begin(); \
+            it != frameIds.end(); ++it) {
+        if (*it <= 0) {
+            // GetFrameIdentifiers() bug that returned a vector
+            // filled with zeros. This problem was fixed by using'
+            // GetFrameNames() so this block of code should not
+            // be executed anymore.
             DebugLog("Renderer: DoJavascriptBindingsForBrowser() WARNING: " \
                 "frameId <= 0");
-            printf("cefpython: Renderer: frameId = %li\n", frameIds[i]);
+            printf("cefpython: Renderer: frameId = %li\n", *it);
             continue;
         }
-        CefRefPtr<CefFrame> frame = browser->GetFrame(frameIds[i]);
+        CefRefPtr<CefFrame> frame = browser->GetFrame(*it);
         if (!frame.get()) {
             DebugLog("Renderer: DoJavascriptBindingsForBrowser() WARNING: " \
                     "GetFrame() failed");
