Slic3r::GUI::PrinterWebView Class Reference

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

Inheritance diagram for Slic3r::GUI::PrinterWebView:

Collaboration diagram for Slic3r::GUI::PrinterWebView:

Public Member Functions
	PrinterWebView (wxWindow *parent)
virtual	~PrinterWebView ()
void	load_url (wxString &url, wxString apikey="")
void	UpdateState ()
void	OnClose (wxCloseEvent &evt)
void	OnError (wxWebViewEvent &evt)
void	OnLoaded (wxWebViewEvent &evt)
void	OnNewWindow (wxWebViewEvent &evt)
void	OnScriptMessage (wxWebViewEvent &evt)
void	reload ()
void	update_mode ()
bool	Show (bool show=true) override

Static Public Member Functions
static PrinterWebView *	if_built ()
static PrinterWebView *	ensure ()
static void	when_built (std::function< void(PrinterWebView &)> fn)

Private Member Functions
void	SendAPIKey ()
void	create_browser ()
void	reset_browser ()

Private Attributes
wxWebView *	m_browser
long	m_zoomFactor
wxString	m_apikey
bool	m_apikey_sent
wxString	m_url
wxString	m_url_deferred
PrintHostType	m_host_type {htOctoPrint}
bool	m_url_loaded {false}
std::unique_ptr< PrinterWebViewHandler >	m_handler
bool	m_reset_on_show {false}

Static Private Attributes
static Lazy< PrinterWebView > *	s_lazy

Friends
class	PrinterWebViewHandler

Detailed Description

Constructor & Destructor Documentation

PrinterWebView()

Slic3r::GUI::PrinterWebView::PrinterWebView

(

wxWindow *

parent

)

        : wxPanel(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize)
    , m_browser(nullptr)
    , m_zoomFactor(100)
    , m_apikey()
    , m_apikey_sent(false)
    , m_url_deferred()
    , m_handler(std::make_unique<PrinterWebViewHandler>(*this))
 {
 
    wxBoxSizer* topsizer = new wxBoxSizer(wxVERTICAL);
 
      // Create the webview
    create_browser();
    m_reset_on_show = WebView::NeedsRecreateOnShow();
 
    SetSizer(topsizer);
 
    topsizer->Add(m_browser, wxSizerFlags().Expand().Proportion(1));
 
    // Log backend information
    /* m_browser->GetUserAgent() may lead crash
    if (wxGetApp().get_mode() == comDevelop) {
        wxLogMessage(wxWebView::GetBackendVersionInfo().ToString());
        wxLogMessage("Backend: %s Version: %s", m_browser->GetClassInfo()->GetClassName(),
            wxWebView::GetBackendVersionInfo().ToString());
        wxLogMessage("User Agent: %s", m_browser->GetUserAgent());
    }
    */
 
    //Connect the idle events
    Bind(wxEVT_CLOSE_WINDOW, &PrinterWebView::OnClose, this);
 
 }

References create_browser(), m_apikey, m_apikey_sent, m_browser, m_handler, m_reset_on_show, m_url_deferred, m_zoomFactor, Slic3r::make_unique(), WebView::NeedsRecreateOnShow(), OnClose(), and PrinterWebViewHandler.

Here is the call graph for this function:

~PrinterWebView()

Slic3r::GUI::PrinterWebView::~PrinterWebView ( )

virtual

{
    BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << " Start";
    SetEvtHandlerEnabled(false);
    m_handler.reset();
 
    // Destroy the webview
    if(m_browser){
        m_browser->Destroy();
        m_browser = nullptr;
    }
 
 
    BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << " End";
}

References m_browser, and m_handler.

Member Function Documentation

create_browser()

void Slic3r::GUI::PrinterWebView::create_browser ( )

private

{
    m_browser = WebView::CreateWebView(this, "");
    add_page_strings(m_browser);
 
#ifdef __linux__
    inject_vue_resize_workaround(m_browser);
 
    auto cookiesPath = boost::filesystem::path(data_dir() + "/cache/cookies.db");
    auto wv = static_cast<WebKitWebView*>(m_browser->GetNativeBackend());
    auto wv_ctx = webkit_web_view_get_context(wv);
    auto cookieManager = webkit_web_context_get_cookie_manager(wv_ctx);
    webkit_cookie_manager_set_persistent_storage(cookieManager, cookiesPath.c_str(), WEBKIT_COOKIE_PERSISTENT_STORAGE_SQLITE);
#endif
 
    m_browser->Bind(wxEVT_WEBVIEW_ERROR, &PrinterWebView::OnError, this);
    m_browser->Bind(wxEVT_WEBVIEW_LOADED, &PrinterWebView::OnLoaded, this);
    m_browser->Bind(wxEVT_WEBVIEW_NEWWINDOW, &PrinterWebView::OnNewWindow, this);
    m_browser->Bind(wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED, &PrinterWebView::OnScriptMessage, this);
    update_mode();
}

References Slic3r::GUI::add_page_strings(), WebView::CreateWebView(), Slic3r::data_dir(), m_browser, OnError(), OnLoaded(), OnNewWindow(), OnScriptMessage(), and update_mode().

Referenced by PrinterWebView(), and reset_browser().

Here is the call graph for this function:

Here is the caller graph for this function:

ensure()

PrinterWebView * Slic3r::GUI::LazyInstance< PrinterWebView >::ensure ( )

inlinestaticinherited

{ return s_lazy ? s_lazy->ensure() : nullptr; }

if_built()

PrinterWebView * Slic3r::GUI::LazyInstance< PrinterWebView >::if_built ( )

inlinestaticinherited

{ return s_lazy ? s_lazy->get() : nullptr; }

Referenced by Slic3r::GUI::MainFrame::init_tabpanel(), Slic3r::GUI::Plater::priv::on_tab_selection_changing(), Slic3r::GUI::GUI_App::update_internal_development(), and Slic3r::GUI::GUI_App::update_mode().

Here is the caller graph for this function:

load_url()

void Slic3r::GUI::PrinterWebView::load_url	(	wxString &	url,
		wxString	apikey = "" )

{
//    this->Show();
//    this->Raise();
    const PrintHostType host_type = active_host_type();
    // Selecting the tab requests the same page again; navigating would reload it and drop its state.
    if (m_url_loaded && url == m_url && apikey == m_apikey && host_type == m_host_type)
        return;
 
    m_url = url;
    m_apikey = apikey;
    m_host_type = host_type;
    m_apikey_sent = false;
    m_url_loaded = false;
    m_handler = create_printer_webview_handler(*this);
 
    if (this->IsShown()) {
        //ORCA: m_url_deferred will be cleared on load success
        //m_url_deferred.clear();
        m_browser->LoadURL(url);
    } else {
        m_url_deferred = url;
    }
    //m_browser->SetFocus();
    UpdateState();
}

References Slic3r::GUI::active_host_type(), Slic3r::GUI::create_printer_webview_handler(), m_apikey, m_apikey_sent, m_browser, m_handler, m_host_type, m_url, m_url_deferred, m_url_loaded, and UpdateState().

Here is the call graph for this function:

OnClose()

void Slic3r::GUI::PrinterWebView::OnClose

(

wxCloseEvent &

evt

)

{
    this->Hide();
}

Referenced by PrinterWebView().

Here is the caller graph for this function:

OnError()

void Slic3r::GUI::PrinterWebView::OnError

(

wxWebViewEvent &

evt

)

{
    auto e = "unknown error";
    switch (evt.GetInt()) {
      case wxWEBVIEW_NAV_ERR_CONNECTION:
        e = "wxWEBVIEW_NAV_ERR_CONNECTION";
        break;
      case wxWEBVIEW_NAV_ERR_CERTIFICATE:
        e = "wxWEBVIEW_NAV_ERR_CERTIFICATE";
        break;
      case wxWEBVIEW_NAV_ERR_AUTH:
        e = "wxWEBVIEW_NAV_ERR_AUTH";
        break;
      case wxWEBVIEW_NAV_ERR_SECURITY:
        e = "wxWEBVIEW_NAV_ERR_SECURITY";
        break;
      case wxWEBVIEW_NAV_ERR_NOT_FOUND:
        e = "wxWEBVIEW_NAV_ERR_NOT_FOUND";
        break;
      case wxWEBVIEW_NAV_ERR_REQUEST:
        e = "wxWEBVIEW_NAV_ERR_REQUEST";

References m_browser.

Referenced by create_browser().

Here is the caller graph for this function:

OnLoaded()

void Slic3r::GUI::PrinterWebView::OnLoaded

(

wxWebViewEvent &

evt

)

                                           :
        e = "wxWEBVIEW_NAV_ERR_USER_CANCELLED";
        break;
      case wxWEBVIEW_NAV_ERR_OTHER:
        e = "wxWEBVIEW_NAV_ERR_OTHER";
        break;
      }
    BOOST_LOG_TRIVIAL(info) << __FUNCTION__<< boost::format(": error loading page %1% %2% %3% %4%") %evt.GetURL() %evt.GetTarget() %e %evt.GetString();
}
 
void PrinterWebView::OnLoaded(wxWebViewEvent& evt)
{
    // The web view's initial empty document (about:blank on WebKit) is not the requested page.
    if (evt.GetURL().IsEmpty() || evt.GetURL() == "about:blank")
        return;

Referenced by create_browser().

Here is the caller graph for this function:

OnNewWindow()

void Slic3r::GUI::PrinterWebView::OnNewWindow

(

wxWebViewEvent &

evt

)

                              {
        m_handler->on_loaded(evt);
        return;

References m_handler, m_url_deferred, and m_url_loaded.

Referenced by create_browser().

Here is the caller graph for this function:

OnScriptMessage()

void Slic3r::GUI::PrinterWebView::OnScriptMessage

(

wxWebViewEvent &

evt

)

{
  const wxString url = evt.GetURL();

Referenced by create_browser().

Here is the caller graph for this function:

reload()

void Slic3r::GUI::PrinterWebView::reload

(

)

{
    m_browser->Reload();
}

References m_browser.

reset_browser()

void Slic3r::GUI::PrinterWebView::reset_browser ( )

private

{
    m_browser->Destroy(); // also removes it from the sizer
    create_browser();
    GetSizer()->Add(m_browser, wxSizerFlags().Expand().Proportion(1));
    Layout();
 
    // OnLoaded may have cleared m_url_deferred already, so requeue the last url for Show().
    m_apikey_sent  = false;
    m_url_loaded   = false;
    m_url_deferred = m_url;
}

References create_browser(), m_apikey_sent, m_browser, m_url, m_url_deferred, and m_url_loaded.

Referenced by Show().

Here is the call graph for this function:

Here is the caller graph for this function:

SendAPIKey()

void Slic3r::GUI::PrinterWebView::SendAPIKey ( )

private

{
    if (m_apikey_sent || m_apikey.IsEmpty())
        return;
    m_apikey_sent   = true;
    wxString script = wxString::Format(R"(
    // Check if window.fetch exists before overriding
    if (window.fetch) {
        const originalFetch = window.fetch;
        window.fetch = function(input, init = {}) {
            init.headers = init.headers || {};
            init.headers['X-API-Key'] = '%s';
            return originalFetch(input, init);
        };
    }
)",
                                       m_apikey);
    m_browser->RemoveAllUserScripts();
    
    // RemoveAllUserScripts causes WebView to forget about our script message handler, 
    // so re-add it here.
    m_browser->RemoveScriptMessageHandler("wx");
    // Mark before adding: on WKWebView the add yields in RunScript() after registering "wx",
    // and CreateWebView()'s deferred add, if it runs in that yield, would register it again.
    WebView::MarkScriptMessageHandlerAdded(m_browser);
    if (!m_browser->AddScriptMessageHandler("wx"))
        wxLogError("Could not add script message handler");

References m_apikey, m_apikey_sent, m_browser, and WebView::MarkScriptMessageHandlerAdded().

Here is the call graph for this function:

Show()

bool Slic3r::GUI::PrinterWebView::Show ( bool show = true )

override

{
    if (show && std::exchange(m_reset_on_show, false))
        reset_browser();
    if (show && !m_url_deferred.empty()) {
        m_browser->LoadURL(m_url_deferred);
        //ORCA: m_url_deferred will be cleared on load success
        //m_url_deferred.clear();
    }
    return wxPanel::Show(show);
}

References m_browser, m_reset_on_show, m_url_deferred, and reset_browser().

Here is the call graph for this function:

update_mode()

void Slic3r::GUI::PrinterWebView::update_mode

(

)

{
    m_browser->EnableAccessToDevTools(wxGetApp().app_config->get_bool("developer_mode"));
}

References m_browser.

Referenced by create_browser().

Here is the caller graph for this function:

UpdateState()

void Slic3r::GUI::PrinterWebView::UpdateState

(

)

Method that retrieves the current state from the web control and updates the GUI the reflect this current state.

                                 {
  // SetTitle(m_browser->GetCurrentTitle());
 
}

Referenced by load_url().

Here is the caller graph for this function:

when_built()

void Slic3r::GUI::LazyInstance< PrinterWebView >::when_built ( std::function< void(PrinterWebView &)> fn )

inlinestaticinherited

    {
        if (s_lazy)
            s_lazy->when_built(std::move(fn));
    }

Friends And Related Symbol Documentation

PrinterWebViewHandler

friend class PrinterWebViewHandler

friend

References PrinterWebViewHandler.

Referenced by PrinterWebView(), and PrinterWebViewHandler.

Member Data Documentation

m_apikey

wxString Slic3r::GUI::PrinterWebView::m_apikey

private

Referenced by PrinterWebView(), load_url(), and SendAPIKey().

m_apikey_sent

bool Slic3r::GUI::PrinterWebView::m_apikey_sent

private

Referenced by PrinterWebView(), load_url(), reset_browser(), and SendAPIKey().

m_browser

wxWebView* Slic3r::GUI::PrinterWebView::m_browser

private

Referenced by PrinterWebView(), ~PrinterWebView(), create_browser(), load_url(), OnError(), reload(), reset_browser(), SendAPIKey(), Show(), and update_mode().

m_handler

std::unique_ptr<PrinterWebViewHandler> Slic3r::GUI::PrinterWebView::m_handler

private

Referenced by PrinterWebView(), ~PrinterWebView(), load_url(), and OnNewWindow().

m_host_type

PrintHostType Slic3r::GUI::PrinterWebView::m_host_type {htOctoPrint}

private

{htOctoPrint};

Referenced by load_url().

m_reset_on_show

bool Slic3r::GUI::PrinterWebView::m_reset_on_show {false}

private

{false};

Referenced by PrinterWebView(), and Show().

m_url

wxString Slic3r::GUI::PrinterWebView::m_url

private

Referenced by load_url(), and reset_browser().

m_url_deferred

wxString Slic3r::GUI::PrinterWebView::m_url_deferred

private

Referenced by PrinterWebView(), load_url(), OnNewWindow(), reset_browser(), and Show().

m_url_loaded

bool Slic3r::GUI::PrinterWebView::m_url_loaded {false}

private

{false};

Referenced by load_url(), OnNewWindow(), and reset_browser().

m_zoomFactor

long Slic3r::GUI::PrinterWebView::m_zoomFactor

private

Referenced by PrinterWebView().

s_lazy

Lazy<PrinterWebView>* Slic3r::GUI::LazyInstance< PrinterWebView >::s_lazy

inlinestaticprivateinherited

{ nullptr };

---

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

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