Update documentation about custom schemes and virtual file systems.

[wxWidgets.git] / src / gtk / webview_webkit.cpp

diff --git a/src/gtk/webview_webkit.cpp b/src/gtk/webview_webkit.cpp
index 3f4c7c69bdf0b2b806365f9cbd23d6c5673d51d4..d4de44070cf7fb70661bdaa431f51f4e91833c3c 100644 (file)
--- a/src/gtk/webview_webkit.cpp
+++ b/src/gtk/webview_webkit.cpp
@@ -16,6 +16,8 @@
 #include "wx/gtk/webview_webkit.h"
 #include "wx/gtk/control.h"
 #include "wx/gtk/private.h"
 #include "wx/gtk/webview_webkit.h"
 #include "wx/gtk/control.h"
 #include "wx/gtk/private.h"

+#include "wx/filesys.h"
+#include "wx/base64.h"

 #include "webkit/webkit.h"
 
 // ----------------------------------------------------------------------------
 #include "webkit/webkit.h"
 
 // ----------------------------------------------------------------------------


@@ -26,8 +28,9 @@ extern "C"
 {
 
 static void
 {
 
 static void

-wxgtk_webkitctrl_load_status_callback(GtkWidget* widget, GParamSpec* arg1,
-                                      wxWebViewWebKit *webKitCtrl)
+wxgtk_webview_webkit_load_status(GtkWidget* widget, 
+                                 GParamSpec*,
+                                 wxWebViewWebKit *webKitCtrl)

 {
     if (!webKitCtrl->m_ready) return;
 
 {
     if (!webKitCtrl->m_ready) return;
 


@@ -60,12 +63,24 @@ wxgtk_webkitctrl_load_status_callback(GtkWidget* widget, GParamSpec* arg1,
     }
 }
 
     }
 }
 

-static WebKitNavigationResponse
-wxgtk_webkitctrl_navigation_requ_callback(WebKitWebView        *web_view,
-                                          WebKitWebFrame       *frame,
-                                          WebKitNetworkRequest *request,
-                                          wxWebViewWebKit      *webKitCtrl)
+static gboolean
+wxgtk_webview_webkit_navigation(WebKitWebView *,
+                                WebKitWebFrame *frame,
+                                WebKitNetworkRequest *request,
+                                WebKitWebNavigationAction *,
+                                WebKitWebPolicyDecision *policy_decision,
+                                wxWebViewWebKit *webKitCtrl)

 {
 {

+    if(webKitCtrl->m_guard)
+    {
+        webKitCtrl->m_guard = false;
+        //We set this to make sure that we don't try to load the page again from 
+        //the resource request callback
+        webKitCtrl->m_vfsurl = webkit_network_request_get_uri(request);
+        webkit_web_policy_decision_use(policy_decision);
+        return FALSE;
+    }
+

     webKitCtrl->m_busy = true;
 
     const gchar* uri = webkit_network_request_get_uri(request);
     webKitCtrl->m_busy = true;
 
     const gchar* uri = webkit_network_request_get_uri(request);


@@ -83,20 +98,47 @@ wxgtk_webkitctrl_navigation_requ_callback(WebKitWebView        *web_view,
     if (thisEvent.IsVetoed())
     {
         webKitCtrl->m_busy = false;
     if (thisEvent.IsVetoed())
     {
         webKitCtrl->m_busy = false;

-        return WEBKIT_NAVIGATION_RESPONSE_IGNORE;
+        webkit_web_policy_decision_ignore(policy_decision);
+        return TRUE;

     }
     else
     {
     }
     else
     {

-        return  WEBKIT_NAVIGATION_RESPONSE_ACCEPT;
+        wxString wxuri = uri;
+        wxSharedPtr<wxWebHandler> handler;
+        wxVector<wxSharedPtr<wxWebHandler> > hanlders = webKitCtrl->GetHandlers();
+        //We are not vetoed so see if we match one of the additional handlers
+        for(wxVector<wxSharedPtr<wxWebHandler> >::iterator it = hanlders.begin();
+            it != hanlders.end(); ++it)
+        {
+            if(wxuri.substr(0, (*it)->GetName().length()) == (*it)->GetName())
+            {
+                handler = (*it);
+            }
+        }
+        //If we found a handler we can then use it to load the file directly 
+        //ourselves
+        if(handler)
+        {
+            webKitCtrl->m_guard = true;
+            wxFSFile* file = handler->GetFile(wxuri);
+            if(file)
+            {
+                webKitCtrl->SetPage(*file->GetStream(), wxuri);
+            }
+            //We need to throw some sort of error here if file is NULL
+            webkit_web_policy_decision_ignore(policy_decision);
+            return TRUE;
+        }
+        return FALSE;

     }
 }
 
 static gboolean
     }
 }
 
 static gboolean

-wxgtk_webkitctrl_error (WebKitWebView  *web_view,
-                        WebKitWebFrame *web_frame,
-                        gchar          *uri,
-                        gpointer        web_error,
-                        wxWebViewWebKit* webKitWindow)
+wxgtk_webview_webkit_error(WebKitWebView*,
+                           WebKitWebFrame*,
+                           gchar *uri,
+                           gpointer web_error,
+                           wxWebViewWebKit* webKitWindow)

 {
     webKitWindow->m_busy = false;
     wxWebNavigationError type = wxWEB_NAV_ERR_OTHER;
 {
     webKitWindow->m_busy = false;
     wxWebNavigationError type = wxWEB_NAV_ERR_OTHER;


@@ -235,12 +277,12 @@ wxgtk_webkitctrl_error (WebKitWebView  *web_view,
 }
 
 static gboolean
 }
 
 static gboolean

-wxgtk_webkitctrl_new_window(WebKitWebView *webView,
-                            WebKitWebFrame *frame,
-                            WebKitNetworkRequest *request,
-                            WebKitWebNavigationAction *navigation_action,
-                            WebKitWebPolicyDecision *policy_decision,
-                    wxWebViewWebKit *webKitCtrl)
+wxgtk_webview_webkit_new_window(WebKitWebView*,
+                                WebKitWebFrame *frame,
+                                WebKitNetworkRequest *request,
+                                WebKitWebNavigationAction*,
+                                WebKitWebPolicyDecision *policy_decision,
+                                wxWebViewWebKit *webKitCtrl)

 {
     const gchar* uri = webkit_network_request_get_uri(request);
 
 {
     const gchar* uri = webkit_network_request_get_uri(request);
 


@@ -254,15 +296,76 @@ wxgtk_webkitctrl_new_window(WebKitWebView *webView,
     if (webKitCtrl && webKitCtrl->GetEventHandler())
         webKitCtrl->GetEventHandler()->ProcessEvent(thisEvent);
 
     if (webKitCtrl && webKitCtrl->GetEventHandler())
         webKitCtrl->GetEventHandler()->ProcessEvent(thisEvent);
 

-    if (thisEvent.IsVetoed())
+    //We always want the user to handle this themselves
+    webkit_web_policy_decision_ignore(policy_decision);
+    return TRUE;
+}
+
+static void
+wxgtk_webview_webkit_title_changed(WebKitWebView*,
+                                   WebKitWebFrame*,
+                                   gchar *title,
+                                   wxWebViewWebKit *webKitCtrl)
+{
+    wxWebNavigationEvent thisEvent(wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED,
+                                   webKitCtrl->GetId(),
+                                   webKitCtrl->GetCurrentURL(),
+                                   "",
+                                   true);
+    thisEvent.SetString(wxString(title, wxConvUTF8));
+
+    if (webKitCtrl && webKitCtrl->GetEventHandler())
+        webKitCtrl->GetEventHandler()->ProcessEvent(thisEvent);
+
+}
+
+static void
+wxgtk_webview_webkit_resource_req(WebKitWebView *,
+                                  WebKitWebFrame *,
+                                  WebKitWebResource *,
+                                  WebKitNetworkRequest *request,
+                                  WebKitNetworkResponse *,
+                                  wxWebViewWebKit *webKitCtrl)
+{
+    wxString uri = webkit_network_request_get_uri(request);
+    
+    wxSharedPtr<wxWebHandler> handler;
+    wxVector<wxSharedPtr<wxWebHandler> > hanlders = webKitCtrl->GetHandlers();
+    
+    //We are not vetoed so see if we match one of the additional handlers
+    for(wxVector<wxSharedPtr<wxWebHandler> >::iterator it = hanlders.begin();
+        it != hanlders.end(); ++it)

     {
     {

-        webkit_web_policy_decision_ignore(policy_decision);
+        if(uri.substr(0, (*it)->GetName().length()) == (*it)->GetName())
+        {
+            handler = (*it);
+        }

     }
     }

-    else
+    //If we found a handler we can then use it to load the file directly 
+    //ourselves
+    if(handler)

     {
     {

-        webkit_web_policy_decision_use(policy_decision);
+        //If it is requsting the page itself then return as we have already
+        //loaded it from the archive
+        if(webKitCtrl->m_vfsurl == uri)
+            return;
+
+        wxFSFile* file = handler->GetFile(uri);
+        if(file)
+        {
+            //We load the data into a data url to save it being written out again
+            size_t size = file->GetStream()->GetLength();
+            char *buffer = new char[size];
+            file->GetStream()->Read(buffer, size);
+            wxString data = wxBase64Encode(buffer, size);
+            delete[] buffer;
+            wxString mime = file->GetMimeType();
+            wxString path = "data:" + mime + ";base64," + data;
+            //Then we can redirect the call
+            webkit_network_request_set_uri(request, path);
+        }
+        

     }
     }

-    return TRUE;

 }
 
 } // extern "C"
 }
 
 } // extern "C"


@@ -271,7 +374,7 @@ wxgtk_webkitctrl_new_window(WebKitWebView *webView,
 // wxWebViewWebKit
 //-----------------------------------------------------------------------------
 
 // wxWebViewWebKit
 //-----------------------------------------------------------------------------
 

-//IMPLEMENT_DYNAMIC_CLASS(wxWebViewWebKit, wxControl)
+wxIMPLEMENT_DYNAMIC_CLASS(wxWebViewWebKit, wxWebView);

 
 bool wxWebViewWebKit::Create(wxWindow *parent,
                       wxWindowID id,
 
 bool wxWebViewWebKit::Create(wxWindow *parent,
                       wxWindowID id,


@@ -283,6 +386,7 @@ bool wxWebViewWebKit::Create(wxWindow *parent,
 {
     m_ready = false;
     m_busy = false;
 {
     m_ready = false;
     m_busy = false;

+    m_guard = false;

 
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))


@@ -304,17 +408,23 @@ bool wxWebViewWebKit::Create(wxWindow *parent,
     gtk_widget_show(web_view);
 
     g_signal_connect_after(web_view, "notify::load-status",
     gtk_widget_show(web_view);
 
     g_signal_connect_after(web_view, "notify::load-status",

-                           G_CALLBACK(wxgtk_webkitctrl_load_status_callback),
+                           G_CALLBACK(wxgtk_webview_webkit_load_status),

                            this);
                            this);

-    g_signal_connect_after(web_view, "navigation-requested",
-                           G_CALLBACK(wxgtk_webkitctrl_navigation_requ_callback),
+    g_signal_connect_after(web_view, "navigation-policy-decision-requested",
+                           G_CALLBACK(wxgtk_webview_webkit_navigation),

                            this);
     g_signal_connect_after(web_view, "load-error", 
                            this);
     g_signal_connect_after(web_view, "load-error", 

-                           G_CALLBACK(wxgtk_webkitctrl_error),
+                           G_CALLBACK(wxgtk_webview_webkit_error),

                            this);
 
     g_signal_connect_after(web_view, "new-window-policy-decision-requested",
                            this);
 
     g_signal_connect_after(web_view, "new-window-policy-decision-requested",

-                           G_CALLBACK(wxgtk_webkitctrl_new_window), this);
+                           G_CALLBACK(wxgtk_webview_webkit_new_window), this);
+
+    g_signal_connect_after(web_view, "title-changed",
+                           G_CALLBACK(wxgtk_webview_webkit_title_changed), this);
+
+    g_signal_connect_after(web_view, "resource-request-starting",
+                           G_CALLBACK(wxgtk_webview_webkit_resource_req), this);

 
     m_parent->DoAddChild( this );
 
 
     m_parent->DoAddChild( this );
 


@@ -323,6 +433,11 @@ bool wxWebViewWebKit::Create(wxWindow *parent,
     /* Open a webpage */
     webkit_web_view_load_uri (WEBKIT_WEB_VIEW (web_view), url);
 
     /* Open a webpage */
     webkit_web_view_load_uri (WEBKIT_WEB_VIEW (web_view), url);
 

+    //Get the initial history limit so we can enable and disable it later
+    WebKitWebBackForwardList* history;
+    history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+    m_historyLimit = webkit_web_back_forward_list_get_limit(history);
+

     m_ready = true;
 
     return true;
     m_ready = true;
 
     return true;


@@ -413,6 +528,129 @@ bool wxWebViewWebKit::CanGoForward()
     return webkit_web_view_can_go_forward (WEBKIT_WEB_VIEW(web_view));
 }
 
     return webkit_web_view_can_go_forward (WEBKIT_WEB_VIEW(web_view));
 }
 

+void wxWebViewWebKit::ClearHistory()
+{
+    WebKitWebBackForwardList* history;
+    history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+    webkit_web_back_forward_list_clear(history);
+}
+
+void wxWebViewWebKit::EnableHistory(bool enable)
+{
+    WebKitWebBackForwardList* history;
+    history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+    if(enable)
+    {
+        webkit_web_back_forward_list_set_limit(history, m_historyLimit);
+    }
+    else
+    {
+        webkit_web_back_forward_list_set_limit(history, 0);
+    }
+}
+
+wxVector<wxSharedPtr<wxWebHistoryItem> > wxWebViewWebKit::GetBackwardHistory()
+{
+    wxVector<wxSharedPtr<wxWebHistoryItem> > backhist; 
+    WebKitWebBackForwardList* history;
+    history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+    GList* list = webkit_web_back_forward_list_get_back_list_with_limit(history, 
+                                                                        m_historyLimit);
+    //We need to iterate in reverse to get the order we desire
+    for(int i = g_list_length(list) - 1; i >= 0 ; i--)
+    {
+        WebKitWebHistoryItem* gtkitem = (WebKitWebHistoryItem*)g_list_nth_data(list, i);
+        wxWebHistoryItem* wxitem = new wxWebHistoryItem(
+                                   webkit_web_history_item_get_uri(gtkitem),
+                                   webkit_web_history_item_get_title(gtkitem));
+        wxitem->m_histItem = gtkitem;
+        wxSharedPtr<wxWebHistoryItem> item(wxitem);
+        backhist.push_back(item);
+    }
+    return backhist;
+}
+
+wxVector<wxSharedPtr<wxWebHistoryItem> > wxWebViewWebKit::GetForwardHistory()
+{
+    wxVector<wxSharedPtr<wxWebHistoryItem> > forwardhist; 
+    WebKitWebBackForwardList* history;
+    history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+    GList* list = webkit_web_back_forward_list_get_forward_list_with_limit(history, 
+                                                                           m_historyLimit);
+    for(guint i = 0; i < g_list_length(list); i++)
+    {
+        WebKitWebHistoryItem* gtkitem = (WebKitWebHistoryItem*)g_list_nth_data(list, i);
+        wxWebHistoryItem* wxitem = new wxWebHistoryItem(
+                                   webkit_web_history_item_get_uri(gtkitem),
+                                   webkit_web_history_item_get_title(gtkitem));
+        wxitem->m_histItem = gtkitem;
+        wxSharedPtr<wxWebHistoryItem> item(wxitem);
+        forwardhist.push_back(item);
+    }
+    return forwardhist;
+}
+
+void wxWebViewWebKit::LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item)
+{
+    WebKitWebHistoryItem* gtkitem = item->m_histItem;
+    if(gtkitem)
+    {
+        WebKitWebBackForwardList* history;
+        history = webkit_web_view_get_back_forward_list(WEBKIT_WEB_VIEW(web_view));
+        webkit_web_back_forward_list_go_to_item(WEBKIT_WEB_BACK_FORWARD_LIST(history), 
+                                                WEBKIT_WEB_HISTORY_ITEM(gtkitem));
+    }
+}
+
+bool wxWebViewWebKit::CanCut()
+{
+    return webkit_web_view_can_cut_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+bool wxWebViewWebKit::CanCopy()
+{
+    return webkit_web_view_can_copy_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+bool wxWebViewWebKit::CanPaste()
+{
+    return webkit_web_view_can_paste_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::Cut()
+{
+    webkit_web_view_cut_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::Copy()
+{
+    webkit_web_view_copy_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::Paste()
+{
+    webkit_web_view_paste_clipboard(WEBKIT_WEB_VIEW(web_view));
+}
+
+bool wxWebViewWebKit::CanUndo()
+{
+    return webkit_web_view_can_undo(WEBKIT_WEB_VIEW(web_view));
+}
+
+bool wxWebViewWebKit::CanRedo()
+{
+    return webkit_web_view_can_redo(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::Undo()
+{
+    webkit_web_view_undo(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::Redo()
+{
+    webkit_web_view_redo(WEBKIT_WEB_VIEW(web_view));
+}

 
 wxString wxWebViewWebKit::GetCurrentURL()
 {
 
 wxString wxWebViewWebKit::GetCurrentURL()
 {


@@ -577,6 +815,107 @@ bool wxWebViewWebKit::IsBusy()
      */
 }
 
      */
 }
 

+void wxWebViewWebKit::SetEditable(bool enable)
+{
+    webkit_web_view_set_editable(WEBKIT_WEB_VIEW(web_view), enable);
+}
+
+bool wxWebViewWebKit::IsEditable()
+{
+    return webkit_web_view_get_editable(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::DeleteSelection()
+{
+    webkit_web_view_delete_selection(WEBKIT_WEB_VIEW(web_view));
+}
+
+bool wxWebViewWebKit::HasSelection()
+{
+    return webkit_web_view_has_selection(WEBKIT_WEB_VIEW(web_view));
+}
+
+void wxWebViewWebKit::SelectAll()
+{
+    webkit_web_view_select_all(WEBKIT_WEB_VIEW(web_view));
+}
+
+wxString wxWebViewWebKit::GetSelectedText()
+{
+    WebKitDOMDocument* doc; 
+    WebKitDOMDOMWindow* win;
+    WebKitDOMDOMSelection* sel;
+    WebKitDOMRange* range;
+
+    doc = webkit_web_view_get_dom_document(WEBKIT_WEB_VIEW(web_view));
+    win = webkit_dom_document_get_default_view(WEBKIT_DOM_DOCUMENT(doc));
+    sel = webkit_dom_dom_window_get_selection(WEBKIT_DOM_DOM_WINDOW(win));
+    range = webkit_dom_dom_selection_get_range_at(WEBKIT_DOM_DOM_SELECTION(sel), 
+                                                  0, NULL);
+    return wxString(webkit_dom_range_get_text(WEBKIT_DOM_RANGE(range)), 
+                    wxConvUTF8);
+}
+
+wxString wxWebViewWebKit::GetSelectedSource()
+{
+    WebKitDOMDocument* doc; 
+    WebKitDOMDOMWindow* win;
+    WebKitDOMDOMSelection* sel;
+    WebKitDOMRange* range;
+    WebKitDOMElement* div;
+    WebKitDOMDocumentFragment* clone;
+    WebKitDOMHTMLElement* html;
+
+    doc = webkit_web_view_get_dom_document(WEBKIT_WEB_VIEW(web_view));
+    win = webkit_dom_document_get_default_view(WEBKIT_DOM_DOCUMENT(doc));
+    sel = webkit_dom_dom_window_get_selection(WEBKIT_DOM_DOM_WINDOW(win));
+    range = webkit_dom_dom_selection_get_range_at(WEBKIT_DOM_DOM_SELECTION(sel), 
+                                                  0, NULL);
+    div = webkit_dom_document_create_element(WEBKIT_DOM_DOCUMENT(doc), "div", NULL);
+
+    clone = webkit_dom_range_clone_contents(WEBKIT_DOM_RANGE(range), NULL);
+    webkit_dom_node_append_child(&div->parent_instance, &clone->parent_instance, NULL);
+    html = (WebKitDOMHTMLElement*)div;
+
+    return wxString(webkit_dom_html_element_get_inner_html(WEBKIT_DOM_HTML_ELEMENT(html)), 
+                    wxConvUTF8);
+}
+
+void wxWebViewWebKit::ClearSelection()
+{
+    WebKitDOMDocument* doc; 
+    WebKitDOMDOMWindow* win;
+    WebKitDOMDOMSelection* sel;
+
+    doc = webkit_web_view_get_dom_document(WEBKIT_WEB_VIEW(web_view));
+    win = webkit_dom_document_get_default_view(WEBKIT_DOM_DOCUMENT(doc));
+    sel = webkit_dom_dom_window_get_selection(WEBKIT_DOM_DOM_WINDOW(win));
+    webkit_dom_dom_selection_remove_all_ranges(WEBKIT_DOM_DOM_SELECTION(sel));
+
+}
+
+wxString wxWebViewWebKit::GetPageText()
+{
+    WebKitDOMDocument* doc; 
+    WebKitDOMHTMLElement* body;
+
+    doc = webkit_web_view_get_dom_document(WEBKIT_WEB_VIEW(web_view));
+    body = webkit_dom_document_get_body(WEBKIT_DOM_DOCUMENT(doc));
+    return wxString(webkit_dom_html_element_get_inner_text(WEBKIT_DOM_HTML_ELEMENT(body)), 
+                    wxConvUTF8);
+}
+
+void wxWebViewWebKit::RunScript(const wxString& javascript)
+{
+    webkit_web_view_execute_script(WEBKIT_WEB_VIEW(web_view), 
+                                   javascript.mb_str(wxConvUTF8));
+}
+
+void wxWebViewWebKit::RegisterHandler(wxSharedPtr<wxWebHandler> handler)
+{
+    m_handlerList.push_back(handler);
+}
+

 // static
 wxVisualAttributes
 wxWebViewWebKit::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 // static
 wxVisualAttributes
 wxWebViewWebKit::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))