ENH: Open Prinables.com Links and Zip Archives (#3823)

* Enable ability to open `prusaslicer://` links * Add needed function to miniz * Import Zip Functionality Allows zip file to be drag and dropped or imported via the menu option Based on prusa3d/PrusaSlicer@ce38e57 and current master branch files * Update dialog style to match Orca * Ensure link is from printables * add toggle option in preferences doesn't actually control anything yet * Add Downloader classes As-is from PS master * Create Orca Styled Variant of Icons * Add Icons to ImGui * Use PS's Downloader impl for `prusaslicer://` links * Implement URL Registering on Windows * Implement prusaslicer:// link on macOS * Remove unnecessary class name qualifier in Plater.hpp * Add downloader desktop integration registration and undo * Revert Info.plist --------- Co-authored-by: SoftFever <softfeverever@gmail.com>
2025-07-20 05:07:51 -06:00 · 2024-05-21 22:52:34 -04:00 · 2024-05-21 22:52:34 -04:00 · a764d836e1
commit a764d836e1
parent 0dbf610226
39 changed files with 3109 additions and 41 deletions
--- a/src/slic3r/GUI/Downloader.cpp
+++ b/src/slic3r/GUI/Downloader.cpp
@ -0,0 +1,270 @@
+///|/ Copyright (c) Prusa Research 2023 David Kocík @kocikdav, Oleksandra Iushchenko @YuSanka
+///|/
+///|/ PrusaSlicer is released under the terms of the AGPLv3 or higher
+///|/
+#include "Downloader.hpp"
+#include "GUI_App.hpp"
+#include "NotificationManager.hpp"
+#include "format.hpp"
+#include "MainFrame.hpp"
+
+#include <boost/algorithm/string.hpp>
+#include <boost/log/trivial.hpp>
+#include <boost/regex.hpp>
+
+namespace Slic3r {
+namespace GUI {
+
+namespace {
+void open_folder(const std::string& path)
+{
+	// Code taken from NotificationManager.cpp
+
+	// Execute command to open a file explorer, platform dependent.
+	// FIXME: The const_casts aren't needed in wxWidgets 3.1, remove them when we upgrade.
+
+#ifdef _WIN32
+	const wxString widepath = from_u8(path);
+	const wchar_t* argv[] = { L"explorer", widepath.GetData(), nullptr };
+	::wxExecute(const_cast<wchar_t**>(argv), wxEXEC_ASYNC, nullptr);
+#elif __APPLE__
+	const char* argv[] = { "open", path.data(), nullptr };
+	::wxExecute(const_cast<char**>(argv), wxEXEC_ASYNC, nullptr);
+#else
+	const char* argv[] = { "xdg-open", path.data(), nullptr };
+
+	// Check if we're running in an AppImage container, if so, we need to remove AppImage's env vars,
+	// because they may mess up the environment expected by the file manager.
+	// Mostly this is about LD_LIBRARY_PATH, but we remove a few more too for good measure.
+	if (wxGetEnv("APPIMAGE", nullptr)) {
+		// We're running from AppImage
+		wxEnvVariableHashMap env_vars;
+		wxGetEnvMap(&env_vars);
+
+		env_vars.erase("APPIMAGE");
+		env_vars.erase("APPDIR");
+		env_vars.erase("LD_LIBRARY_PATH");
+		env_vars.erase("LD_PRELOAD");
+		env_vars.erase("UNION_PRELOAD");
+
+		wxExecuteEnv exec_env;
+		exec_env.env = std::move(env_vars);
+
+		wxString owd;
+		if (wxGetEnv("OWD", &owd)) {
+			// This is the original work directory from which the AppImage image was run,
+			// set it as CWD for the child process:
+			exec_env.cwd = std::move(owd);
+		}
+
+		::wxExecute(const_cast<char**>(argv), wxEXEC_ASYNC, nullptr, &exec_env);
+	}
+	else {
+		// Looks like we're NOT running from AppImage, we'll make no changes to the environment.
+		::wxExecute(const_cast<char**>(argv), wxEXEC_ASYNC, nullptr, nullptr);
+	}
+#endif
+}
+
+std::string filename_from_url(const std::string& url)
+{
+	// TODO: can it be done with curl?
+	size_t slash = url.find_last_of("/");
+	if (slash == std::string::npos && slash != url.size() - 1)
+		return {};
+	return url.substr(slash + 1, url.size() - slash + 1);
+}
+}
+
+Download::Download(int ID, std::string url, wxEvtHandler* evt_handler, const boost::filesystem::path& dest_folder)
+    : m_id(ID)
+	, m_filename(filename_from_url(url))
+	, m_dest_folder(dest_folder)
+{
+	assert(boost::filesystem::is_directory(dest_folder));
+	m_final_path = dest_folder / m_filename;
+    m_file_get = std::make_shared<FileGet>(ID, std::move(url), m_filename, evt_handler, dest_folder);
+}
+
+void Download::start()
+{
+	m_state = DownloadState::DownloadOngoing;
+	m_file_get->get();
+}
+void Download::cancel()
+{
+	m_state = DownloadState::DownloadStopped;
+	m_file_get->cancel();
+}
+void Download::pause()
+{
+	//assert(m_state == DownloadState::DownloadOngoing);
+	// if instead of assert - it can happen that user clicks on pause several times before the pause happens
+	if (m_state != DownloadState::DownloadOngoing)
+		return;
+	m_state = DownloadState::DownloadPaused;
+	m_file_get->pause();
+}
+void Download::resume()
+{
+	//assert(m_state == DownloadState::DownloadPaused);
+	if (m_state != DownloadState::DownloadPaused)
+		return;
+	m_state = DownloadState::DownloadOngoing;
+	m_file_get->resume();
+}
+
+
+Downloader::Downloader()
+	: wxEvtHandler()
+{
+	//Bind(EVT_DWNLDR_FILE_COMPLETE, [](const wxCommandEvent& evt) {});
+	//Bind(EVT_DWNLDR_FILE_PROGRESS, [](const wxCommandEvent& evt) {});
+	//Bind(EVT_DWNLDR_FILE_ERROR, [](const wxCommandEvent& evt) {});
+	//Bind(EVT_DWNLDR_FILE_NAME_CHANGE, [](const wxCommandEvent& evt) {});
+
+	Bind(EVT_DWNLDR_FILE_COMPLETE, &Downloader::on_complete, this);
+	Bind(EVT_DWNLDR_FILE_PROGRESS, &Downloader::on_progress, this);
+	Bind(EVT_DWNLDR_FILE_ERROR, &Downloader::on_error, this);
+	Bind(EVT_DWNLDR_FILE_NAME_CHANGE, &Downloader::on_name_change, this);
+	Bind(EVT_DWNLDR_FILE_PAUSED, &Downloader::on_paused, this);
+	Bind(EVT_DWNLDR_FILE_CANCELED, &Downloader::on_canceled, this);
+}
+
+void Downloader::start_download(const std::string& full_url)
+{
+	assert(m_initialized);
+
+    // Orca: check if url is registered
+    if (!wxGetApp().app_config->has("ps_url_registered") || !wxGetApp().app_config->get_bool("ps_url_registered")) {
+        BOOST_LOG_TRIVIAL(error) << "PrusaSlicer links are not enabled. Download aborted: " << full_url;
+        show_error(nullptr, "PrusaSlicer links are not enabled in preferences. Download aborted.");
+        return;
+    }
+
+    // Orca: Move to the 3D view
+    MainFrame* mainframe = wxGetApp().mainframe;
+    Plater* plater = wxGetApp().plater();
+
+    mainframe->Freeze();
+    mainframe->select_tab((size_t)MainFrame::TabPosition::tp3DEditor);
+    plater->select_view_3D("3D");
+    plater->select_view("plate");
+    plater->get_current_canvas3D()->zoom_to_bed();
+    mainframe->Thaw();
+
+    // Orca: Replace PS workaround for "mysterious slash" with a more dynamic approach
+    // Windows seems to have fixed the issue and this provides backwards compatability for those it still affects
+    boost::regex re(R"(^prusaslicer:\/\/open[\/]?\?file=)", boost::regbase::icase);
+    boost::smatch results;
+
+	if (!boost::regex_search(full_url, results, re)) {
+		BOOST_LOG_TRIVIAL(error) << "Could not start download due to wrong URL: " << full_url;
+        // Orca: show error
+        NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+        ntf_mngr->push_notification(NotificationType::CustomNotification, NotificationManager::NotificationLevel::ErrorNotificationLevel,
+                                    "Could not start download due to malformed URL");
+		return;
+	}
+    size_t id = get_next_id();
+    std::string escaped_url = FileGet::escape_url(full_url.substr(results.length()));
+	if (!boost::starts_with(escaped_url, "https://") || !FileGet::is_subdomain(escaped_url, "printables.com")) {
+		std::string msg = format(_L("Download won't start. Download URL doesn't point to https://printables.com : %1%"), escaped_url);
+		BOOST_LOG_TRIVIAL(error) << msg;
+		NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+		ntf_mngr->push_notification(NotificationType::CustomNotification, NotificationManager::NotificationLevel::ErrorNotificationLevel,
+                                    "Download failed. Download URL doesn't point to https://printables.com.");
+		return;
+	}
+	
+	std::string text(escaped_url);
+    m_downloads.emplace_back(std::make_unique<Download>(id, std::move(escaped_url), this, m_dest_folder));
+	NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+	ntf_mngr->push_download_URL_progress_notification(id, m_downloads.back()->get_filename(), std::bind(&Downloader::user_action_callback, this, std::placeholders::_1, std::placeholders::_2));
+	m_downloads.back()->start();
+	BOOST_LOG_TRIVIAL(debug) << "started download";
+}
+
+void Downloader::on_progress(wxCommandEvent& event)
+{
+	size_t id = event.GetInt();
+	float percent = (float)std::stoi(boost::nowide::narrow(event.GetString())) / 100.f;
+	//BOOST_LOG_TRIVIAL(error) << "progress " << id << ": " << percent;
+	NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+	BOOST_LOG_TRIVIAL(trace) << "Download "<< id << ": " << percent;
+	ntf_mngr->set_download_URL_progress(id, percent);
+}
+void Downloader::on_error(wxCommandEvent& event)
+{
+	size_t id = event.GetInt();
+    set_download_state(event.GetInt(), DownloadState::DownloadError);
+    BOOST_LOG_TRIVIAL(error) << "Download error: " << event.GetString();
+	NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+	ntf_mngr->set_download_URL_error(id, boost::nowide::narrow(event.GetString()));
+	show_error(nullptr, format_wxstr(L"%1%\n%2%", _L("The download has failed") + ":", event.GetString()));
+}
+void Downloader::on_complete(wxCommandEvent& event)
+{
+	// TODO: is this always true? :
+	// here we open the file itself, notification should get 1.f progress from on progress.
+    set_download_state(event.GetInt(), DownloadState::DownloadDone);
+	wxArrayString paths;
+	paths.Add(event.GetString());
+	wxGetApp().plater()->load_files(paths);
+}
+bool Downloader::user_action_callback(DownloaderUserAction action, int id)
+{
+	for (size_t i = 0; i < m_downloads.size(); ++i) {
+		if (m_downloads[i]->get_id() == id) {
+			switch (action) {
+			case DownloadUserCanceled:
+				m_downloads[i]->cancel();
+				return true;
+			case DownloadUserPaused:
+				m_downloads[i]->pause();
+				return true;
+			case DownloadUserContinued:
+				m_downloads[i]->resume();
+				return true;
+			case DownloadUserOpenedFolder:
+				open_folder(m_downloads[i]->get_dest_folder());
+				return true;
+			default:
+				return false;
+			}
+		}
+	}
+	return false;
+}
+
+void Downloader::on_name_change(wxCommandEvent& event)
+{
+   
+}
+
+void Downloader::on_paused(wxCommandEvent& event)
+{
+	size_t id = event.GetInt();
+	NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+	ntf_mngr->set_download_URL_paused(id);
+}
+
+void Downloader::on_canceled(wxCommandEvent& event)
+{
+	size_t id = event.GetInt();
+	NotificationManager* ntf_mngr = wxGetApp().notification_manager();
+	ntf_mngr->set_download_URL_canceled(id);
+}
+
+void Downloader::set_download_state(int id, DownloadState state)
+{
+    for (size_t i = 0; i < m_downloads.size(); ++i) {
+        if (m_downloads[i]->get_id() == id) {
+            m_downloads[i]->set_state(state);
+            return;
+        }
+    }
+}
+
+}
+}