extension.cpp

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Authors:
 *   Ted Gould <ted@gould.cx>
 *
 * Copyright (C) 2002-2005 Authors
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */
 
#include "extension.h"
 
#include <utility>
#include <glib/gprintf.h>
#include <glibmm/fileutils.h>
#include <glibmm/i18n.h>
#include <glibmm/miscutils.h>
#include <gtkmm/box.h>
#include <gtkmm/frame.h>
#include <gtkmm/grid.h>
#include <gtkmm/label.h>
 
#include "db.h"
#include "dependency.h"
#include "document.h"
#include "processing-action.h"
#include "implementation/implementation.h"
#include "implementation/script.h"
#include "implementation/xslt.h"
#include "inkscape.h"
#include "io/resource.h"
#include "io/sys.h"
#include "prefdialog/parameter.h"
#include "prefdialog/prefdialog.h"
#include "prefdialog/widget.h"
#include "timer.h"
#include "ui/dialog-run.h"
#include "ui/pack.h"
#include "ui/util.h"
#include "xml/node.h"
#include "xml/repr.h"
 
namespace Inkscape::Extension {
 
FILE *Extension::error_file = nullptr;
 
Extension::Extension(Inkscape::XML::Node *in_repr, ImplementationHolder implementation, std::string *base_directory)
    : imp{std::move(implementation)}
{
    if (!imp) {
        throw no_implementation_for_extension();
    }
    g_return_if_fail(in_repr); // should be ensured in system.cpp
    repr = in_repr;
    Inkscape::GC::anchor(repr);
 
    if (base_directory) {
        _base_directory = *base_directory;
    }
 
    // get name of the translation catalog ("gettext textdomain") that the extension wants to use for translations
    // and lookup the locale directory for it
    char const *translationdomain = repr->attribute("translationdomain");
    if (translationdomain) {
        _translationdomain = translationdomain;
    } else {
        _translationdomain = "inkscape"; // default to the Inkscape catalog
    }
    if (!strcmp(_translationdomain, "none")) {
        // special keyword "none" means the extension author does not want translation of extension strings
        _translation_enabled = false;
        _translationdomain = nullptr;
    } else if (!strcmp(_translationdomain, "inkscape")) {
        // this is our default domain; we know the location already (also respects INKSCAPE_LOCALEDIR)
        _gettext_catalog_dir = bindtextdomain("inkscape", nullptr);
    } else {
        lookup_translation_catalog();
    }
 
    // Read XML tree and parse extension
    Inkscape::XML::Node *child_repr = repr->firstChild();
    while (child_repr) {
        char const *chname = child_repr->name();
        if (!strncmp(chname, INKSCAPE_EXTENSION_NS_NC, strlen(INKSCAPE_EXTENSION_NS_NC))) {
            chname += strlen(INKSCAPE_EXTENSION_NS);
        }
        if (chname[0] == '_') { // allow leading underscore in tag names for backwards-compatibility
            chname++;
        }
 
        if (!strcmp(chname, "id")) {
            char const *id = child_repr->firstChild() ? child_repr->firstChild()->content() : nullptr;
            if (id) {
                _id = id;
            } else {
                throw extension_no_id();
            }
        } else if (!strcmp(chname, "name")) {
            char const *name = child_repr->firstChild() ? child_repr->firstChild()->content() : nullptr;
            if (name) {
                _name = name;
            } else {
                throw extension_no_name();
            }
        } else if (InxWidget::is_valid_widget_name(chname)) {
            InxWidget *widget = InxWidget::make(child_repr, this);
            if (widget) {
                _widgets.emplace_back(widget);
            }
        } else if (!strcmp(chname, "action")) {
            _actions.emplace_back(child_repr);
        } else if (!strcmp(chname, "dependency")) {
            _deps.push_back(std::make_unique<Dependency>(child_repr, this));
        } else if (!strcmp(chname, "script")) { // TODO: should these be parsed in their respective Implementation?
            for (auto child = child_repr->firstChild(); child != nullptr; child = child->next()) {
                if (child->type() == Inkscape::XML::NodeType::ELEMENT_NODE) { // skip non-element nodes (see LP #1372200)
                    char const *interpreted = child->attribute("interpreter");
                    Dependency::type_t type = interpreted ? Dependency::TYPE_FILE : Dependency::TYPE_EXECUTABLE;
                    _deps.push_back(std::make_unique<Dependency>(child, this, type));
                    break;
                }
            }
        } else if (!strcmp(chname, "xslt")) { // TODO: should these be parsed in their respective Implementation?
            for (auto child = child_repr->firstChild(); child != nullptr; child = child->next()) {
                if (child->type() == Inkscape::XML::NodeType::ELEMENT_NODE) { // skip non-element nodes (see LP #1372200)
                    _deps.push_back(std::make_unique<Dependency>(child, this, Dependency::TYPE_FILE));
                    break;
                }
            }
        } else {
            // We could do some sanity checking here.
            // However, we don't really know which additional elements Extension subclasses might need...
        }
 
        child_repr = child_repr->next();
    }
 
    // all extensions need an ID and a name
    if (_id.empty()) {
        throw extension_no_id();
    }
    if (_name.empty()) {
        throw extension_no_name();
    }
 
    // filter out extensions that are not compatible with the current platform
#ifndef _WIN32
    if (_id.find("win32") != _id.npos) {
        throw extension_not_compatible();
    }
#endif
}
 
Extension::~Extension()
{
    Inkscape::GC::release(repr);
}
 
void
Extension::set_state (state_t in_state)
{
    if (_state == STATE_DEACTIVATED) return;
    if (in_state != _state) {
        switch (in_state) {
            case STATE_LOADED:
                if (imp->load(this))
                    _state = STATE_LOADED;
 
                timer = std::make_unique<ExpirationTimer>(this);
                break;
 
            case STATE_UNLOADED:
                imp->unload(this);
                _state = STATE_UNLOADED;
                timer.reset();
                break;
 
            case STATE_DEACTIVATED:
                _state = STATE_DEACTIVATED;
                timer.reset();
                break;
 
            default:
                break;
        }
    }
}
 
Extension::state_t
Extension::get_state ()
{
    return _state;
}
 
bool
Extension::loaded ()
{
    return get_state() == STATE_LOADED;
}
 
bool
Extension::check ()
{
    char const *inx_failure = _("  This is caused by an improper .inx file for this extension."
                                "  An improper .inx file could have been caused by a faulty installation of Inkscape.");
 
    if (repr == nullptr) {
        printFailure(Glib::ustring(_("the XML description of it got lost.")) += inx_failure);
        return false;
    }
    if (!imp) {
        printFailure(Glib::ustring(_("no implementation was defined for the extension.")) += inx_failure);
        return false;
    }
 
    bool retval = true;
    for (auto const &dep : _deps) {
        if (dep->check() == false) {
            printFailure(Glib::ustring(_("a dependency was not met.")));
            error_file_write(dep->info_string());
            retval = false;
        }
    }
 
    if (retval) {
        return imp->check(this);
    }
 
    error_file_write("");
    return retval;
}
 
void
Extension::printFailure(Glib::ustring const &reason)
{
    _error_reason = Glib::ustring::compose(_("Extension \"%1\" failed to load because %2"), _name, reason);
    error_file_write(_error_reason);
}
 
Inkscape::XML::Node *
Extension::get_repr ()
{
    return repr;
}
 
char const *
Extension::get_id () const
{
    return _id.c_str();
}
 
char const *
Extension::get_name () const
{
    return get_translation(_name.c_str(), nullptr);
}
 
void
Extension::deactivate ()
{
    set_state(STATE_DEACTIVATED);
 
    /* Removing the old implementation, and making this use the default. */
    /* This should save some memory */
    imp = ImplementationHolder();
}
 
bool
Extension::deactivated ()
{
    return get_state() == STATE_DEACTIVATED;
}
 
std::string Extension::get_dependency_location(char const *name)
{
    for (auto const &dep : _deps) {
        if (!strcmp(name, dep->get_name())) {
            return dep->get_path();
        }
    }
 
    return "";
}
 
static bool _find_filename_recursive(std::string directory, std::string const &filename) {
    Glib::Dir dir(directory);
 
    std::string name = dir.read_name();
    while (!name.empty()) {
        std::string fullpath = Glib::build_filename(directory, name);
        // g_message("%s", fullpath.c_str());
 
        if (Glib::file_test(fullpath, Glib::FileTest::IS_DIR)) {
            if (_find_filename_recursive(fullpath, filename)) {
                return true;
            }
        } else if (name == filename) {
            return true;
        }
        name = dir.read_name();
    }
 
    return false;
}
 
void Extension::lookup_translation_catalog() {
    g_assert(!_base_directory.empty());
 
    // get locale folder locations
    std::string locale_dir_current_extension;
    std::string locale_dir_extensions;
    std::string locale_dir_system;
 
    locale_dir_current_extension = Glib::build_filename(_base_directory, "locale");
 
    size_t index = _base_directory.find_last_of("extensions");
    if (index != std::string::npos) {
        locale_dir_extensions = Glib::build_filename(_base_directory.substr(0, index+1), "locale");
    }
 
    locale_dir_system = bindtextdomain("inkscape", nullptr);
 
    // collect unique locations into vector
    std::vector<std::string> locale_dirs;
    if (locale_dir_current_extension != locale_dir_extensions) {
        locale_dirs.push_back(std::move(locale_dir_current_extension));
    }
    locale_dirs.push_back(std::move(locale_dir_extensions));
    locale_dirs.push_back(std::move(locale_dir_system));
 
    // iterate over locations and look for the one that has the correct catalog
    std::string search_name;
    search_name += _translationdomain;
    search_name += ".mo";
    for (auto &&locale_dir : locale_dirs) {
        if (!Glib::file_test(locale_dir, Glib::FileTest::IS_DIR)) {
            continue;
        }
 
        if (_find_filename_recursive(locale_dir, search_name)) {
            _gettext_catalog_dir = std::move(locale_dir);
            break;
        }
    }
 
#ifdef _WIN32
    // obtain short path, bindtextdomain doesn't understand UTF-8
    if (!_gettext_catalog_dir.empty()) {
        auto shortpath = g_win32_locale_filename_from_utf8(_gettext_catalog_dir.c_str());
        _gettext_catalog_dir = shortpath;
        g_free(shortpath);
    }
#endif
 
    // register catalog with gettext if found, disable translation for this extension otherwise
    if (!_gettext_catalog_dir.empty()) {
        char const *current_dir = bindtextdomain(_translationdomain, nullptr);
        if (_gettext_catalog_dir != current_dir) {
            g_info("Binding textdomain '%s' to '%s'.", _translationdomain, _gettext_catalog_dir.c_str());
            bindtextdomain(_translationdomain, _gettext_catalog_dir.c_str());
            bind_textdomain_codeset(_translationdomain, "UTF-8");
        }
    } else {
        g_warning("Failed to locate message catalog for textdomain '%s'.", _translationdomain);
        _translation_enabled = false;
        _translationdomain = nullptr;
    }
}
 
char const *Extension::get_translation(char const *msgid, char const *msgctxt) const {
    if (!_translation_enabled) {
        return msgid;
    }
 
    if (!strcmp(msgid, "")) {
        g_warning("Attempting to translate an empty string in extension '%s', which is not supported.", _id.c_str());
        return msgid;
    }
 
    if (msgctxt) {
        return g_dpgettext2(_translationdomain, msgctxt, msgid);
    } else {
        return g_dgettext(_translationdomain, msgid);
    }
}
 
void Extension::set_environment(const SPDocument *doc) {
    Glib::unsetenv("INKEX_GETTEXT_DOMAIN");
    Glib::unsetenv("INKEX_GETTEXT_DIRECTORY");
 
    // This is needed so extensions can interact with the user's profile, keep settings etc.
    Glib::setenv("INKSCAPE_PROFILE_DIR", Inkscape::IO::Resource::profile_path());
 
    // This is needed if an extension calls inkscape itself
    Glib::setenv("SELF_CALL", "true");
 
    // This is needed so files can be saved relative to their document location (see image-extract)
    if (doc) {
        auto path = doc->getDocumentFilename();
        if (!path) {
            path = ""; // Set to blank string so extensions know the difference between old inkscape and not-saved document.
        }
        Glib::setenv("DOCUMENT_PATH", std::string(path));
    }
 
    if (_translationdomain) {
        Glib::setenv("INKEX_GETTEXT_DOMAIN", std::string(_translationdomain));
    }
    if (!_gettext_catalog_dir.empty()) {
        Glib::setenv("INKEX_GETTEXT_DIRECTORY", _gettext_catalog_dir);
    }
}
 
ModuleImpType Extension::get_implementation_type()
{
    if (dynamic_cast<Implementation::Script *>(imp.get())) {
        return MODULE_EXTENSION;
    } else if (dynamic_cast<Implementation::XSLT *>(imp.get())) {
        return MODULE_XSLT;
    }
    // MODULE_UNKNOWN_IMP is not required because it never results in an
    // object being created. Thus this function wouldn't be available.
    return MODULE_PLUGIN;
}
 
void
Extension::paramListString(std::list<std::string> &retlist) const
{
    // first collect all widgets in the current extension
    std::vector<InxWidget *> widget_list;
    for (auto const &widget : _widgets) {
        widget->get_widgets(widget_list);
    }
 
    // then build a list of parameter strings from parameter names and values, as '--name=value'
    for (auto widget : widget_list) {
        InxParameter *parameter = dynamic_cast<InxParameter *>(widget); // filter InxParameters from InxWidgets
        if (parameter) {
            char const *name = parameter->name();
            std::string value = parameter->value_to_string();
 
            if (name && !value.empty()) { // TODO: Shouldn't empty string values be allowed?
                std::string parameter_string;
                parameter_string += "--";
                parameter_string += name;
                parameter_string += "=";
                parameter_string += value;
                retlist.push_back(std::move(parameter_string));
            }
        }
    }
}
 
InxParameter *Extension::get_param(char const *name)
{
    if (!name || _widgets.empty()) {
        throw Extension::param_not_exist();
    }
 
    // first collect all widgets in the current extension
    std::vector<InxWidget *> widget_list;
    for (auto const &widget : _widgets) {
        widget->get_widgets(widget_list);
    }
 
    // then search for a parameter with a matching name
    for (auto widget : widget_list) {
        InxParameter *parameter = dynamic_cast<InxParameter *>(widget); // filter InxParameters from InxWidgets
        if (parameter && !strcmp(parameter->name(), name)) {
            return parameter;
        }
    }
 
    // if execution reaches here, no parameter matching 'name' was found
    throw Extension::param_not_exist();
}
 
InxParameter const *Extension::get_param(char const *name) const
{
    return const_cast<Extension *>(this)->get_param(name);
}
 
bool
Extension::get_param_bool(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_bool();
}
 
bool Extension::get_param_bool(char const *name, bool alt) const
{
    try {
        return get_param_bool(name);
    } catch (Extension::param_not_exist) {
        return alt;
    }
}
 
int
Extension::get_param_int(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_int();
}
 
int Extension::get_param_int(char const *name, int alt) const
{
    try {
        return get_param_int(name);
    } catch (Extension::param_not_exist) {
        return alt;
    }
}
 
double
Extension::get_param_float(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_float();
}
 
double Extension::get_param_float(char const *name, double alt) const
{
    try {
        return get_param_float(name);
    } catch (Extension::param_not_exist) {
        return alt;
    }
}
 
char const *
Extension::get_param_string(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_string();
}
 
char const *Extension::get_param_string(char const *name, char const *alt) const
{
    try {
        return get_param_string(name);
    } catch (Extension::param_not_exist) {
        return alt;
    }
}
 
char const *
Extension::get_param_optiongroup(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_optiongroup();
}
 
char const *Extension::get_param_optiongroup(char const *name, char const *alt) const
{
    try {
        return get_param_optiongroup(name);
    } catch (Extension::param_not_exist) {
        return alt;
    }
}
 
bool
Extension::get_param_optiongroup_contains(char const *name, char const *value) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_optiongroup_contains(value);
}
 
Colors::Color
Extension::get_param_color(char const *name) const
{
    const InxParameter *param;
    param = get_param(name);
    return param->get_color();
}
 
bool
Extension::set_param_bool(char const *name, const bool value)
{
    InxParameter *param;
    param = get_param(name);
    return param->set_bool(value);
}
 
int
Extension::set_param_int(char const *name, const int value)
{
    InxParameter *param;
    param = get_param(name);
    return param->set_int(value);
}
 
double
Extension::set_param_float(char const *name, const double value)
{
    InxParameter *param;
    param = get_param(name);
    return param->set_float(value);
}
 
char const *
Extension::set_param_string(char const *name, char const *value)
{
    InxParameter *param;
    param = get_param(name);
    return param->set_string(value);
}
 
char const *
Extension::set_param_optiongroup(char const *name, char const *value)
{
    InxParameter *param;
    param = get_param(name);
    return param->set_optiongroup(value);
}
 
void
Extension::set_param_color(char const *name, Inkscape::Colors::Color const &color)
{
    InxParameter *param;
    param = get_param(name);
    param->set_color(color);
}
 
void Extension::set_param_any(char const *name, std::string const &value)
{
    get_param(name)->set(value);
}
 
void Extension::set_param_hidden(char const *name, bool hidden)
{
    get_param(name)->set_hidden(hidden);
}
 
void
Extension::error_file_open ()
{
    auto ext_error_file = Inkscape::IO::Resource::log_path(EXTENSION_ERROR_LOG_FILENAME);
    error_file = Inkscape::IO::fopen_utf8name(ext_error_file.c_str(), "w+");
    if (!error_file) {
        g_warning(_("Could not create extension error log file '%s'"), ext_error_file.c_str());
    }
};
 
void
Extension::error_file_close ()
{
    if (error_file) {
        fclose(error_file);
    }
};
 
void
Extension::error_file_write(Glib::ustring const &text)
{
    if (error_file) {
        g_fprintf(error_file, "%s\n", text.c_str());
    }
};
 
class AutoGUI : public Gtk::Box {
public:
    AutoGUI () : Gtk::Box(Gtk::Orientation::VERTICAL) {};
 
    void addWidget(Gtk::Widget *widg, char const *tooltip, int indent) {
        if (widg) {
            widg->set_margin_start(indent * InxParameter::GUI_INDENTATION);
            UI::pack_start(*this, *widg, widg->get_vexpand(), true);
 
            if (tooltip) {
                widg->set_tooltip_text(tooltip);
            } else {
                widg->set_tooltip_text("");
                widg->set_has_tooltip(false);
            }
        }
    };
};
 
Gtk::Widget *
Extension::autogui (SPDocument *doc, Inkscape::XML::Node *node, sigc::signal<void ()> *changeSignal)
{
    if (!_gui || widget_visible_count() == 0) {
        return nullptr;
    }
 
    auto const agui = Gtk::make_managed<AutoGUI>();
    agui->set_margin(InxParameter::GUI_BOX_MARGIN);
    agui->set_spacing(InxParameter::GUI_BOX_SPACING);
 
    // go through the list of widgets and add the all non-hidden ones
    for (auto const &widget : _widgets) {
        if (widget->get_hidden()) {
            continue;
        }
 
        Gtk::Widget *widg = widget->get_widget(changeSignal);
        char const *tip = widget->get_tooltip();
        int indent = widget->get_indent();
        agui->addWidget(widg, tip, indent);
    }
 
    return agui;
};
 
/* Extension editor dialog stuff */
 
Gtk::Box *
Extension::get_info_widget()
{
    auto const retval = Gtk::make_managed<Gtk::Box>(Gtk::Orientation::VERTICAL, 4);
    retval->set_margin(4);
 
    auto const info = Gtk::make_managed<Gtk::Frame>("General Extension Information");
    UI::pack_start(*retval, *info, true, true, 4);
 
    auto const table = Gtk::make_managed<Gtk::Grid>();
    table->set_margin(4);
    table->set_column_spacing(4);
    info->set_child(*table);
 
    int row = 0;
    add_val(_("Name:"), get_translation(_name.c_str()), table, &row);
    add_val(_("ID:"), _id.c_str(), table, &row);
    add_val(_("State:"), _state == STATE_LOADED ? _("Loaded") : _state == STATE_UNLOADED ? _("Unloaded") : _("Deactivated"), table, &row);
 
    return retval;
}
 
void Extension::add_val(Glib::ustring const &labelstr, Glib::ustring const &valuestr,
                        Gtk::Grid * table, int * row)
{
    auto const label = Gtk::make_managed<Gtk::Label>(labelstr, Gtk::Align::START);
    auto const value = Gtk::make_managed<Gtk::Label>(valuestr, Gtk::Align::START);
 
    (*row)++;
    table->attach(*label, 0, (*row) - 1, 1, 1);
    table->attach(*value, 1, (*row) - 1, 1, 1);
}
 
Gtk::Box *
Extension::get_params_widget()
{
    auto const retval = Gtk::make_managed<Gtk::Box>(Gtk::Orientation::VERTICAL);
    Gtk::Widget * content = Gtk::make_managed<Gtk::Label>("Params");
    UI::pack_start(*retval, *content, true, true, 4);
    return retval;
}
 
unsigned int Extension::widget_visible_count() const
{
    unsigned int _visible_count = 0;
    for (auto const &widget : _widgets) {
        if (!widget->get_hidden()) {
            _visible_count++;
        }
    }
    return _visible_count;
}
 
bool Extension::prefs()
{
    if (!INKSCAPE.use_gui()) {
        return true;
    }
 
    if (!loaded())
        set_state(Extension::STATE_LOADED);
    if (!loaded())
        return false;
 
    if (auto controls = autogui(nullptr, nullptr)) {
        auto dialog = PrefDialog(get_name(), controls);
        int response = Inkscape::UI::dialog_run(dialog);
        return response == Gtk::ResponseType::OK;
    }
 
    // No controls, no prefs
    return true;
}
 
void Extension::run_processing_actions(SPDocument *doc)
{
    for (auto &process_action : _actions) {
        // Pass in the extensions internal prefs if needed in the future.
        if (process_action.is_enabled()) {
            process_action.run(doc);
        }
    }
}
 
} // namespace Inkscape::Extension
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :