Classes
struct	PluginContextAction
struct	PluginAvailableActions
struct	PluginCapabilityView
struct	PluginChangelogView
struct	PluginDialogItem
struct	PluginOperationState

Functions
PluginCapabilityType	primary_capability_type_of (PluginManager &manager, const std::string &plugin_key)
PluginDescriptor	as_cloud_only_descriptor (PluginDescriptor descriptor)
std::string	to_string (PluginUpdateStatus status)
nlohmann::json	build_context_actions_payload (const PluginAvailableActions &available_actions)
nlohmann::json	build_plugin_payload_item (const PluginDialogItem &dialog_item)
PluginSource	derive_plugin_source (const PluginDescriptor &descriptor)
PluginAvailableActions	evaluate_action_policy (const PluginDialogItem &item)
PluginDialogItem	build_plugin_dialog_item (const PluginDescriptor &descriptor)
const PluginContextAction *	find_context_action (const PluginAvailableActions &available_actions, const std::string &action_id)
void	store_plugin_operation_result (const std::shared_ptr< PluginOperationState > &state, bool succeeded, std::string error)
bool	take_plugin_operation_result (const std::shared_ptr< PluginOperationState > &state, std::string &error)
std::vector< PluginDescriptor >	current_cloud_metadata_snapshot ()

Variables
const wxString	kDeletePluginTitle = _L("Delete Plugin")
const wxString	kUnsubscribeTitle = _L("Unsubscribe")
const wxString	kOverwritePluginTitle = _L("Overwrite Plugin")
std::string	s_selected_plugin_install_action = "explore"
constexpr bool	kFetchCloudMeta = true
constexpr bool	kUseCurrentCloudMeta = false

Class Documentation

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction:

Class Members
bool	danger = false
bool	enabled = true
string	id
string	label

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions:

Class Members
bool	can_toggle = false
vector< PluginContextAction >	context_actions
bool	toggle_installs_cloud_plugin = false

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginCapabilityView

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginCapabilityView

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginCapabilityView:

Class Members
bool	can_run = false
bool	can_toggle = false
bool	enabled = false
bool	has_config_ui = false
PluginCapabilityId	id

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginChangelogView

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginChangelogView

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginChangelogView:

Class Members
string	changelog
long long	created_time = 0
string	version

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginDialogItem

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginDialogItem

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginDialogItem:

Class Members
string	author
PluginAvailableActions	available_actions
bool	can_run_script = false
vector< PluginCapabilityView >	capabilities
vector< PluginChangelogView >	changelog
string	description
string	display_name
string	error_text
bool	has_error = false
bool	has_local_package = false
bool	has_script_capability = false
string	installed_version
bool	is_cloud_plugin = false
bool	is_loaded = false
string	latest_version
bool	loading = false
bool	orphaned = false
string	plugin_id
string	plugin_key
string	sharing_token
string	sort_version
PluginSource	source = PluginSource::Local
PluginStatus	status = PluginStatus::Inactive
string	thumbnail_url
string	type_key
string	type_label
vector< string >	type_labels
bool	unauthorized = false
PluginUpdateStatus	update_status = PluginUpdateStatus::Normal
string	version

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginOperationState

struct Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginOperationState

Collaboration diagram for Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginOperationState:

Class Members
string	error
mutex	mutex
bool	succeeded = false

Function Documentation

◆ as_cloud_only_descriptor()

PluginDescriptor Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::as_cloud_only_descriptor ( PluginDescriptor descriptor )

{
    descriptor.plugin_root.clear();
    descriptor.entry_path.clear();
    descriptor.installed_version.clear();
    // No local package is left behind, so the package verdict and any load error it produced go with it.
    descriptor.metadata_valid = false;
    descriptor.clear_error();
    if (descriptor.cloud.has_value()) {
        descriptor.cloud->installed        = false;
        descriptor.cloud->update_available = false;
    }
    return descriptor;
}

References as_cloud_only_descriptor(), Slic3r::PluginDescriptor::clear_error(), Slic3r::PluginDescriptor::cloud, Slic3r::PluginDescriptor::entry_path, Slic3r::PluginDescriptor::installed_version, Slic3r::PluginDescriptor::metadata_valid, and Slic3r::PluginDescriptor::plugin_root.

Referenced by as_cloud_only_descriptor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_context_actions_payload()

nlohmann::json Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_context_actions_payload ( const PluginAvailableActions & available_actions )

{
    nlohmann::json payload = nlohmann::json::array();
 
    for (const PluginContextAction& action : available_actions.context_actions) {
        nlohmann::json item;
        item["id"]      = action.id;
        item["label"]   = action.label;
        item["enabled"] = action.enabled;
        item["danger"]  = action.danger;
        payload.push_back(std::move(item));
    }
 
    return payload;
}

References build_context_actions_payload(), Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions::context_actions, Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction::danger, Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction::enabled, Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction::id, and Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction::label.

Referenced by build_context_actions_payload(), and build_plugin_payload_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_plugin_dialog_item()

PluginDialogItem Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item ( const PluginDescriptor & descriptor )

{
    PluginDialogItem item;
    PluginManager& manager = PluginManager::instance();
 
    item.plugin_key   = descriptor.plugin_key;
    item.display_name = descriptor.name;
    item.description  = !descriptor.is_metadata_valid() && descriptor.has_error() ?
                            descriptor.normalized_error() :
                            (descriptor.description.empty() ? _u8L("No description.") : descriptor.description);
    item.author       = descriptor.author;
    item.version      = descriptor.version;
    // The cloud merge overwrites `version` with the latest cloud version, so prefer the preserved local
    // one, falling back to `version` for local-only / pre-merge descriptors.
    item.installed_version = descriptor.has_local_package() ?
                                 (descriptor.installed_version.empty() ? descriptor.version : descriptor.installed_version) :
                                 std::string{};
    item.latest_version    = descriptor.latest_available_version();
    item.sort_version      = item.installed_version.empty() ? item.latest_version : item.installed_version;
    // A package that is not loaded has no capabilities, so its row contributes none and does not
    // expand.
    const std::vector<std::shared_ptr<PluginCapabilityInterface>> capabilities =
        manager.get_plugin_capabilities(descriptor.plugin_key, PluginCapabilityType::Unknown, /*only_enabled=*/false);
 
    const PluginCapabilityType primary_type = capabilities.empty() ? PluginCapabilityType::Unknown : capabilities.front()->type();
    item.type_label                         = plugin_capability_type_to_string(primary_type);
    item.type_key                           = plugin_capability_type_to_string(primary_type);
    // "types" is the display-only compatibility list. Cloud plugins show the raw labels the
    // service returned (which may not map to real capability types); local plugins derive them
    // from the capabilities actually loaded.
    if (descriptor.is_cloud_plugin() && !descriptor.display_types.empty()) {
        for (const std::string& label : descriptor.display_types)
            if (std::find(item.type_labels.begin(), item.type_labels.end(), label) == item.type_labels.end())
                item.type_labels.push_back(label);
    } else {
        for (const auto& capability : capabilities) {
            const std::string label = PluginConfig::capability_type_label(capability->type());
            if (std::find(item.type_labels.begin(), item.type_labels.end(), label) == item.type_labels.end())
                item.type_labels.push_back(label);
        }
    }
    for (const PluginChangelog& entry : descriptor.changelog)
        item.changelog.push_back({entry.version, entry.changelog, entry.created_time});
    item.source                = derive_plugin_source(descriptor);
    item.update_status         = descriptor.get_update_status();
    item.error_text            = descriptor.normalized_error();
    item.has_error             = descriptor.has_error();
    item.is_cloud_plugin       = descriptor.is_cloud_plugin();
    item.orphaned              = descriptor.cloud.has_value() && descriptor.cloud->orphaned;
    item.has_local_package     = descriptor.has_local_package();
    item.unauthorized          = descriptor.is_unauthorized();
    item.is_loaded             = manager.is_plugin_loaded(descriptor.plugin_key);
    item.loading               = manager.is_plugin_load_in_progress(descriptor.plugin_key);
    item.has_script_capability = false;
    for (const auto& capability : capabilities) {
        item.capabilities.push_back({capability->identity(), capability->is_enabled(), true, false, capability->config_ui_available()});
        if (capability->type() == PluginCapabilityType::Script)
            item.has_script_capability = true;
    }
    item.sharing_token = descriptor.sharing_token;
    item.thumbnail_url = descriptor.thumbnail_url;
 
    item.status = resolve_plugin_status(item.loading, item.has_error, item.is_loaded);
 
    item.available_actions        = evaluate_action_policy(item);
    const bool has_enabled_script = std::any_of(item.capabilities.begin(), item.capabilities.end(),
                                                [](const PluginCapabilityView& capability) {
                                                    return capability.id.type == PluginCapabilityType::Script && capability.enabled;
                                                });
    item.can_run_script = descriptor.is_metadata_valid() && !descriptor.has_error() && item.has_script_capability && item.is_loaded &&
                          !item.loading && has_enabled_script;
    for (PluginCapabilityView& capability : item.capabilities) {
        capability.can_run = item.can_run_script && capability.id.type == PluginCapabilityType::Script && capability.enabled;
    }
    return item;
}

Referenced by build_plugin_dialog_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_plugin_payload_item()

nlohmann::json Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_payload_item ( const PluginDialogItem & dialog_item )

{
    nlohmann::json payload_item;
    payload_item["plugin_key"]  = dialog_item.plugin_key;
    payload_item["plugin_id"]   = dialog_item.plugin_id;
    payload_item["name"]        = dialog_item.display_name;
    payload_item["description"] = dialog_item.description;
    payload_item["author"]      = dialog_item.author;
    payload_item["version"]     = dialog_item.version;
    payload_item["type"]        = dialog_item.type_label;
    payload_item["type_key"]    = dialog_item.type_key;
    payload_item["types"]       = dialog_item.type_labels;
 
    nlohmann::json caps = nlohmann::json::array();
    for (const PluginCapabilityView& capability : dialog_item.capabilities) {
        nlohmann::json c;
        c["name"]          = capability.id.name;
        c["type"]          = PluginConfig::capability_type_label(capability.id.type);
        c["type_key"]      = plugin_capability_type_to_string(capability.id.type);
        c["enabled"]       = capability.enabled;
        c["can_toggle"]    = capability.can_toggle;
        c["can_run"]       = capability.can_run;
        c["has_config_ui"] = capability.has_config_ui;
        caps.push_back(std::move(c));
    }
    payload_item["capabilities"] = std::move(caps);
 
    // The Config tab's sidebar, built by the shared builder so it stays identical to PluginsConfigDialog's.
    // Not the `capabilities` array above: that is the list tab's, with enable/run state and descriptor-only
    // rows the config view has no use for.
    std::vector<PluginCapabilityId> config_ids;
    for (const PluginCapabilityView& capability : dialog_item.capabilities)
        if (!capability.id.name.empty())
            config_ids.push_back(capability.id);
    payload_item["config_capabilities"] = PluginConfig::capabilities_payload(config_ids);
 
    nlohmann::json changelog = nlohmann::json::array();
    for (const PluginChangelogView& entry : dialog_item.changelog) {
        nlohmann::json c;
        c["version"]      = entry.version;
        c["changelog"]    = entry.changelog;
        c["created_time"] = entry.created_time;
        changelog.push_back(std::move(c));
    }
    payload_item["changelog"] = std::move(changelog);
 
    payload_item["label"]                 = dialog_item.display_name;
    payload_item["source"]                = to_string(dialog_item.source);
    payload_item["status"]                = to_string(dialog_item.status);
    payload_item["is_loaded"]             = dialog_item.is_loaded;
    payload_item["error"]                 = dialog_item.error_text;
    payload_item["update_status"]         = to_string(dialog_item.update_status);
    payload_item["unauthorized"]          = dialog_item.unauthorized;
    payload_item["context_actions"]       = build_context_actions_payload(dialog_item.available_actions);
    payload_item["update_available"]      = dialog_item.update_status == PluginUpdateStatus::UpdateAvailable;
    payload_item["can_toggle"]            = dialog_item.available_actions.can_toggle;
    payload_item["has_script_capability"] = dialog_item.has_script_capability;
    payload_item["can_run_script"]        = dialog_item.can_run_script;
    payload_item["sharing_token"]         = dialog_item.sharing_token;
    payload_item["thumbnail_url"]         = dialog_item.thumbnail_url;
    payload_item["installed"]             = dialog_item.has_local_package;
    payload_item["orphaned"]              = dialog_item.orphaned;
    payload_item["installed_version"]     = dialog_item.installed_version;
    payload_item["latest_version"]        = dialog_item.latest_version;
    return payload_item;
}

Referenced by build_plugin_payload_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ current_cloud_metadata_snapshot()

std::vector< PluginDescriptor > Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::current_cloud_metadata_snapshot ( )

{
    std::vector<PluginDescriptor> cloud_entries;
    for (const PluginDescriptor& entry : PluginManager::instance().get_plugin_descriptors(/*include_invalid=*/true))
        if (entry.is_cloud_plugin())
            cloud_entries.push_back(entry);
    return cloud_entries;
}

References current_cloud_metadata_snapshot(), and Slic3r::PluginManager::instance().

Referenced by current_cloud_metadata_snapshot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ derive_plugin_source()

PluginSource Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::derive_plugin_source ( const PluginDescriptor & descriptor )

{
    const bool has_cloud_meta = descriptor.cloud.has_value();
    const bool is_cloud       = descriptor.is_cloud_plugin();
    const bool is_mine        = is_cloud && has_cloud_meta && descriptor.cloud->is_mine;
 
    if (is_cloud && has_cloud_meta && descriptor.cloud->orphaned)
        return PluginSource::Orphaned;
    if (is_mine)
        return PluginSource::Mine;
    if (is_cloud)
        return PluginSource::Subscribed;
    return PluginSource::Local;
}

References Slic3r::PluginDescriptor::cloud, derive_plugin_source(), Slic3r::PluginDescriptor::is_cloud_plugin(), Slic3r::GUI::Local, Slic3r::GUI::Mine, Slic3r::GUI::Orphaned, and Slic3r::GUI::Subscribed.

Referenced by build_plugin_dialog_item(), and derive_plugin_source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluate_action_policy()

PluginAvailableActions Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::evaluate_action_policy ( const PluginDialogItem & item )

{
    PluginAvailableActions available_actions;
    const bool is_loading             = item.status == PluginStatus::Loading;
    const bool is_cloud               = item.is_cloud_plugin;
    const bool is_orphaned            = item.orphaned;
    const bool is_mine                = item.source == PluginSource::Mine;
    const bool has_local              = item.has_local_package;
    const bool authorized_for_install = !item.unauthorized;
 
    available_actions.toggle_installs_cloud_plugin = is_cloud && !is_orphaned && !has_local && authorized_for_install;
    available_actions.can_toggle                   = !is_loading && (has_local || available_actions.toggle_installs_cloud_plugin);
 
    auto add_action = [&available_actions](const char* id, const char* label, bool enabled = true, bool danger = false) {
        available_actions.context_actions.push_back(PluginContextAction{id, _u8L(label), enabled, danger});
    };
 
    // Owned cloud plugins fall through to the local delete: it removes the installed package only.
    // Deleting a plugin from the cloud is a plugin hub operation and is never offered here.
    if (is_cloud && !is_orphaned && !is_mine) {
        add_action("unsubscribe_plugin", L("Unsubscribe"), true, true);
    } else if (has_local) {
        add_action("delete_plugin", L("Delete"), true, true);
    }
 
    add_action("open_folder", L("Show in folder"), has_local);
 
    if (!is_orphaned) {
        if (is_cloud) {
            add_action("reinstall_plugin", L("Reinstall"));
        } else {
            add_action("reload_plugin", L("Reload"));
            add_action("clear_cache_reload_plugin", L("Delete cache and reload"));
        }
    }
 
    return available_actions;
}

Referenced by build_plugin_dialog_item(), and evaluate_action_policy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find_context_action()

const PluginContextAction * Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::find_context_action	(	const PluginAvailableActions &	available_actions,
		const std::string &	action_id )

{
    const auto it = std::find_if(available_actions.context_actions.begin(), available_actions.context_actions.end(),
                                 [&action_id](const PluginContextAction& action) { return action.id == action_id; });
    return it != available_actions.context_actions.end() ? &(*it) : nullptr;
}

References Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions::context_actions, and find_context_action().

Referenced by find_context_action().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ primary_capability_type_of()

PluginCapabilityType Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::primary_capability_type_of	(	PluginManager &	manager,
		const std::string &	plugin_key )

{
    const auto capabilities = manager.get_plugin_capabilities(plugin_key, PluginCapabilityType::Unknown, /*only_enabled=*/false);
    return capabilities.empty() ? PluginCapabilityType::Unknown : capabilities.front()->type();
}

References Slic3r::PluginManager::get_plugin_capabilities(), primary_capability_type_of(), and Slic3r::Unknown.

Referenced by primary_capability_type_of().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store_plugin_operation_result()

void Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::store_plugin_operation_result	(	const std::shared_ptr< PluginOperationState > &	state,
		bool	succeeded,
		std::string	error )

{
    std::lock_guard<std::mutex> lock(state->mutex);
    state->succeeded = succeeded;
    state->error     = std::move(error);
}

References store_plugin_operation_result().

Referenced by store_plugin_operation_result().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ take_plugin_operation_result()

bool Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::take_plugin_operation_result	(	const std::shared_ptr< PluginOperationState > &	state,
		std::string &	error )

{
    std::lock_guard<std::mutex> lock(state->mutex);
    error = std::move(state->error);
    return state->succeeded;
}

References take_plugin_operation_result().

Referenced by take_plugin_operation_result().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ to_string()

std::string Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::to_string ( PluginUpdateStatus status )

{
    switch (status) {
    case PluginUpdateStatus::Normal: return "normal";
    case PluginUpdateStatus::UpdateAvailable: return "update_available";
    case PluginUpdateStatus::Unauthorized: return "unauthorized";
    }
 
    return "normal";
}

References Slic3r::Normal, Slic3r::Unauthorized, and Slic3r::UpdateAvailable.

Variable Documentation

◆ kDeletePluginTitle

const wxString Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::kDeletePluginTitle = _L("Delete Plugin")

◆ kFetchCloudMeta

bool Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::kFetchCloudMeta = true

constexpr

◆ kOverwritePluginTitle

const wxString Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::kOverwritePluginTitle = _L("Overwrite Plugin")

◆ kUnsubscribeTitle

const wxString Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::kUnsubscribeTitle = _L("Unsubscribe")

◆ kUseCurrentCloudMeta

bool Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::kUseCurrentCloudMeta = false

constexpr

◆ s_selected_plugin_install_action

std::string Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::s_selected_plugin_install_action = "explore"

	OrcaSlicer latest OrcaSlicer

Classes

Functions

Variables

Class Documentation

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginContextAction

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginAvailableActions

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginCapabilityView

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginChangelogView

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginDialogItem

◆ Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::PluginOperationState

Function Documentation

◆ as_cloud_only_descriptor()

◆ build_context_actions_payload()

◆ build_plugin_dialog_item()

◆ build_plugin_payload_item()

◆ current_cloud_metadata_snapshot()

◆ derive_plugin_source()

◆ evaluate_action_policy()

◆ find_context_action()

◆ primary_capability_type_of()

◆ store_plugin_operation_result()

◆ take_plugin_operation_result()

◆ to_string()

Variable Documentation

◆ kDeletePluginTitle

◆ kFetchCloudMeta

◆ kOverwritePluginTitle

◆ kUnsubscribeTitle

◆ kUseCurrentCloudMeta

◆ s_selected_plugin_install_action