WebView Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/WebView.hpp>

Static Public Member Functions
static wxWebView *	CreateWebView (wxWindow *parent, wxString const &url)
static void	LoadUrl (wxWebView *webView, wxString const &url)
static wxString	RedactUrl (const wxString &url)
static bool	RunScript (wxWebView *webView, wxString const &msg)
static void	MarkScriptMessageHandlerAdded (wxWebView *webView)
static bool	NeedsRecreateOnShow ()
static bool	NeedsCompositingWorkaround ()
static bool	SupportsForceSharedMemory ()
static void	RecreateAll ()

Detailed Description

Member Function Documentation

CreateWebView()

wxWebView * WebView::CreateWebView ( wxWindow * parent, wxString const & url )

static

{
#if wxUSE_WEBVIEW_EDGE
    // Check if a fixed version of edge is present in
    // $executable_path/edge_fixed and use it
    wxFileName edgeFixedDir(wxStandardPaths::Get().GetExecutablePath());
    edgeFixedDir.SetFullName("");
    edgeFixedDir.AppendDir("edge_fixed");
    if (edgeFixedDir.DirExists()) {
        wxWebViewEdge::MSWSetBrowserExecutableDir(edgeFixedDir.GetFullPath());
        wxLogMessage("Using fixed edge version");
    }
#endif
    auto url2  = url;
#ifdef __WIN32__
    url2.Replace("\\", "/");
#endif
    if (!url2.empty()) { url2 = wxURI(url2).BuildURI(); }
    BOOST_LOG_TRIVIAL(trace) << __FUNCTION__ << ": " << url2.ToUTF8();
 
#ifdef __WIN32__
    wxWebView* webView = new WebViewEdge;
#elif defined(__WXOSX__)
    wxWebView* webView = new WebViewWebKit;
#else
    auto webView = wxWebView::New();
#endif
    if (webView) {
        webView->SetBackgroundColour(StateColor::darkModeColorFor(*wxWHITE));
 
        wxString language_code = Slic3r::GUI::wxGetApp().current_language_code().BeforeFirst('_');
        language_code          = language_code.ToStdString();
#ifdef __WIN32__
        webView->SetUserAgent(wxString::Format("Mozilla/5.0 (Windows NT 10.0; Win64; x64) "
                                               "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.52 BBL-Slicer/v%s (%s) BBL-Language/%s",
                                               Slic3r::GUI::wxGetApp().get_bbl_client_version(), Slic3r::GUI::wxGetApp().dark_mode() ? "dark" : "light", language_code.mb_str()));
        webView->Create(parent, wxID_ANY, url2, wxDefaultPosition, wxDefaultSize, wxBORDER_NONE);
        // We register the wxfs:// protocol for testing purposes
        webView->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewArchiveHandler("bbl")));
        // And the memory: file system
        webView->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewFSHandler("memory")));
#else
        // With WKWebView handlers need to be registered before creation.
        // On Linux (WebKit2GTK), URI schemes are registered globally and can only
        // be registered once, so guard against multiple registrations.
        static bool s_schemes_registered = false;
        if (!s_schemes_registered) {
            webView->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewArchiveHandler("wxfs")));
            webView->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewFSHandler("memory")));
            s_schemes_registered = true;
        }
        webView->Create(parent, wxID_ANY, url2, wxDefaultPosition, wxDefaultSize, wxBORDER_NONE);
#ifdef __linux__
        webView->SetUserAgent(linux_user_agent());
#else
        webView->SetUserAgent(wxString::Format("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) BBL-Slicer/v%s (%s) BBL-Language/%s",
                                               Slic3r::GUI::wxGetApp().get_bbl_client_version(), Slic3r::GUI::wxGetApp().dark_mode() ? "dark" : "light", language_code.mb_str()));
#endif
#endif
#ifdef __WXMAC__
        WKWebView * wkWebView = (WKWebView *) webView->GetNativeBackend();
        Slic3r::GUI::WKWebView_setTransparentBackground(wkWebView);
#endif
        auto addScriptMessageHandler = [] (wxWebView *webView) {
            // Skip if SendAPIKey() already registered "wx"; a duplicate add throws an
            // uncatchable NSException on WKWebView, killing the app at startup.
            WebViewRef *ref = webview_ref(webView);
            if (ref && ref->m_script_handler_added)
                return;
            BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << ": begin to add script message handler for wx.";
            Slic3r::GUI::wxGetApp().set_adding_script_handler(true);
            if (!webView->AddScriptMessageHandler("wx"))
                wxLogError("Could not add script message handler");
            else if (ref)
                ref->m_script_handler_added = true;
            Slic3r::GUI::wxGetApp().set_adding_script_handler(false);
            BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << ": finished add script message handler for wx.";
        };
#ifndef __WIN32__
        webView->CallAfter([webView, addScriptMessageHandler] {
#endif
            if (Slic3r::GUI::wxGetApp().is_adding_script_handler()) {
                g_delay_webviews.push_back(webView);
            } else {
                addScriptMessageHandler(webView);
                while (!g_delay_webviews.empty()) {
                    auto views = std::move(g_delay_webviews);
                    for (const wxWeakRef<wxWebView>& wv : views)
                        if (wv)
                            addScriptMessageHandler(wv.get());
                }
            }
#ifndef __WIN32__
        });
#endif
        webView->EnableContextMenu(true);
    } else {
        BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << ": failed. Use fake web view.";
        webView = new FakeWebView;
    }
    webView->SetRefData(new WebViewRef(webView));
    g_webviews.push_back(webView);
    return webView;
}

References StateColor::darkModeColorFor(), g_delay_webviews, g_webviews, WebViewRef::m_script_handler_added, webview_ref(), and Slic3r::GUI::WKWebView_setTransparentBackground().

Referenced by Slic3r::GUI::GuideFrame::GuideFrame(), Slic3r::GUI::ModelMallDialog::ModelMallDialog(), Slic3r::GUI::PrinterCloudAuthDialog::PrinterCloudAuthDialog(), Slic3r::GUI::WebPanel::WebPanel(), Slic3r::GUI::ZUserLogin::ZUserLogin(), Slic3r::GUI::PrinterWebView::create_browser(), Slic3r::GUI::ProjectPanel::create_browser(), Slic3r::GUI::WebViewPanel::create_browser(), Slic3r::GUI::WebViewPanel::create_cloud_browser(), Slic3r::GUI::StatusBasePanel::create_monitoring_page(), Slic3r::GUI::WebViewHostDialog::create_webview(), Slic3r::GUI::MarkdownTip::CreateTipView(), Slic3r::GUI::PrivacyUpdateDialog::CreateTipView(), and Slic3r::GUI::UpdateVersionDialog::CreateTipView().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadUrl()

void WebView::LoadUrl ( wxWebView * webView, wxString const & url )

static

{
    auto url2  = url;
#ifdef __WIN32__
    url2.Replace("\\", "/");
#endif
    if (!url2.empty()) { url2 = wxURI(url2).BuildURI(); }
    BOOST_LOG_TRIVIAL(trace) << __FUNCTION__ << RedactUrl(url2).ToUTF8();
    webView->LoadURL(url2);
}

References RedactUrl().

Referenced by Slic3r::GUI::ProjectPanel::create_browser(), Slic3r::GUI::WebViewPanel::create_browser(), Slic3r::GUI::ModelMallDialog::go_to_url(), Slic3r::GUI::GuideFrame::load_url(), and Slic3r::GUI::WebViewHostDialog::load_url().

Here is the call graph for this function:

Here is the caller graph for this function:

MarkScriptMessageHandlerAdded()

void WebView::MarkScriptMessageHandlerAdded ( wxWebView * webView )

static

{
    if (WebViewRef *ref = webview_ref(webView))
        ref->m_script_handler_added = true;
}

References webview_ref().

Referenced by Slic3r::GUI::PrinterWebView::SendAPIKey().

Here is the call graph for this function:

Here is the caller graph for this function:

NeedsCompositingWorkaround()

bool WebView::NeedsCompositingWorkaround ( )

static

{
#ifdef __linux__
    const guint major = webkit_get_major_version();
    const guint minor = webkit_get_minor_version();
    return major < 2 || (major == 2 && minor < 42);
#else
    return false;
#endif
}

Referenced by Slic3r::CLI::run().

Here is the caller graph for this function:

NeedsRecreateOnShow()

bool WebView::NeedsRecreateOnShow ( )

static

{
    const bool recreating = Slic3r::GUI::wxGetApp().is_recreating_gui();
    BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << ": is_recreating_gui = " << recreating;
#ifdef __WIN32__
    return recreating;
#else
    return false;
#endif
}

Referenced by Slic3r::GUI::PrinterWebView::PrinterWebView(), Slic3r::GUI::ProjectPanel::ProjectPanel(), and Slic3r::GUI::WebViewPanel::WebViewPanel().

Here is the caller graph for this function:

RecreateAll()

void WebView::RecreateAll ( )

static

{
    auto dark = Slic3r::GUI::wxGetApp().dark_mode();
    wxString language_code = Slic3r::GUI::wxGetApp().current_language_code().BeforeFirst('_');
    language_code          = language_code.ToStdString();
    for (auto webView : g_webviews) {
#ifdef __linux__
        webView->SetUserAgent(linux_user_agent());
#else
        webView->SetUserAgent(wxString::Format("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) BBL-Slicer/v%s (%s) BBL-Language/%s",
                                               Slic3r::GUI::wxGetApp().get_bbl_client_version(), dark ? "dark" : "light", language_code.mb_str()));
#endif
        // A host-themed WebViewHostDialog re-themes in place (no reload). If it handles
        // the event, skip the reload; legacy pages fall through and reload as before
        // (their own dark.css swap re-themes them on reload).
        wxCommandEvent evt(EVT_WEBVIEW_RECREATED);
        evt.SetEventObject(webView);
        if (!webView->GetEventHandler()->ProcessEvent(evt))
            webView->Reload();
    }
}

References g_webviews.

Referenced by Slic3r::GUI::MainFrame::on_sys_color_changed().

Here is the caller graph for this function:

RedactUrl()

wxString WebView::RedactUrl ( const wxString & url )

static

{
    const size_t cut = url.find_first_of(wxString("?#"));
    return cut == wxString::npos ? url : url.Left(cut);
}

Referenced by Slic3r::GUI::WebViewPanel::load_cloud_url(), LoadUrl(), Slic3r::GUI::WebViewPanel::OnNavigationComplete(), Slic3r::GUI::WebViewPanel::OnNavigationRequest(), Slic3r::GUI::WebViewPanel::OnNewWindow(), and Slic3r::GUI::open_cloud_url_externally().

Here is the caller graph for this function:

RunScript()

bool WebView::RunScript ( wxWebView * webView, wxString const & msg )

static

{
    if (Slic3r::GUI::wxGetApp().app_config->get("internal_developer_mode") == "true"
            && javascript.find("studio_userlogin") == wxString::npos)
        wxLogMessage("Running JavaScript:\n%s\n", javascript);
 
    try {
#ifdef __WIN32__
        ICoreWebView2 *   webView2 = (ICoreWebView2 *) webView->GetNativeBackend();
        if (webView2 == nullptr)
            return false;
        return webView2->ExecuteScript(javascript, NULL) == 0;
#elif defined __WXMAC__
        WKWebView * wkWebView = (WKWebView *) webView->GetNativeBackend();
        Slic3r::GUI::WKWebView_evaluateJavaScript(wkWebView, javascript, nullptr);
        return true;
#else
        WebKitWebView *wkWebView = (WebKitWebView *) webView->GetNativeBackend();
        webkit_web_view_run_javascript(
            wkWebView, javascript.utf8_str(), NULL,
            [](GObject *wkWebView, GAsyncResult *res, void *) {
                GError * error = NULL;
                auto result = webkit_web_view_run_javascript_finish((WebKitWebView*)wkWebView, res, &error);
                if (!result)
                    g_error_free (error);
                else
                    webkit_javascript_result_unref (result);
        }, NULL);
        return true;
#endif
    } catch (std::exception &) {
        return false;
    }
}

References Slic3r::GUI::WKWebView_evaluateJavaScript().

Referenced by Slic3r::GUI::WebPanel::apply_theme(), Slic3r::GUI::WebPanel::post_to_page(), Slic3r::GUI::WebViewHostDialog::run_script(), Slic3r::GUI::GuideFrame::RunScript(), Slic3r::GUI::MarkdownTip::RunScript(), Slic3r::GUI::PrivacyUpdateDialog::RunScript(), Slic3r::GUI::ProjectPanel::RunScript(), Slic3r::GUI::UpdateVersionDialog::RunScript(), Slic3r::GUI::WebViewPanel::RunScript(), Slic3r::GUI::ZUserLogin::RunScript(), and Slic3r::GUI::anonymous_namespace{PrinterWebViewHandler.cpp}::ElegooPrinterWebViewHandler::send_ipc_message().

Here is the call graph for this function:

Here is the caller graph for this function:

SupportsForceSharedMemory()

bool WebView::SupportsForceSharedMemory ( )

static

{
#ifdef __linux__
    const guint major = webkit_get_major_version();
    const guint minor = webkit_get_minor_version();
    return major > 2 || (major == 2 && minor >= 44);
#else
    return false;
#endif
}

Referenced by Slic3r::CLI::run().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/WebView.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/WebView.cpp