path: root/src/libaudcore/plugin-registry.cc

/*
 * plugin-registry.c
 * Copyright 2009-2013 John Lindgren
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions, and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions, and the following disclaimer in the documentation
 *    provided with the distribution.
 *
 * This software is provided "as is" and without any warranty, express or
 * implied. In no event shall the authors be liable for any damages arising from
 * the use of this software.
 */

#include "plugins-internal.h"

#include <errno.h>
#include <string.h>

#include <glib/gstdio.h>

#include "audstrings.h"
#include "i18n.h"
#include "interface.h"
#include "parse.h"
#include "plugin.h"
#include "runtime.h"
#include "threads.h"

#define FILENAME "plugin-registry"

/* Increment this when the format of the plugin-registry file changes.
 * Add 10 if the format changes in a way that will break
 * parse_plugins_fallback(). */
#define FORMAT 11

/* Oldest file format supported by parse_plugins_fallback() */
#define MIN_FORMAT 2 // "enabled" flag was added in Audacious 2.4

struct PluginWatch
{
    PluginWatchFunc func;
    void * data;
};

class PluginHandle
{
public:
    String basename, path;
    bool loaded;
    int timestamp, version, flags;
    PluginType type;
    Plugin * header;
    String name, domain;
    int priority;
    int has_about, has_configure;
    PluginEnabled enabled;
    Index<PluginWatch> watches;

    /* for transport plugins */
    Index<String> schemes;

    /* for playlist plugins */
    Index<String> exts;
    int can_save;

    /* for input plugins */
    aud::array<InputKey, Index<String>> keys;
    int has_subtunes, writes_tag;

    PluginHandle(const char * basename, const char * path, bool loaded,
                 int timestamp, int version, int flags, PluginType type,
                 Plugin * header)
        : basename(basename), path(path), loaded(loaded), timestamp(timestamp),
          version(version), flags(flags), type(type), header(header),
          priority(0), has_about(false), has_configure(false),
          enabled((type == PluginType::Transport ||
                   type == PluginType::Playlist || type == PluginType::Input)
                      ? PluginEnabled::Primary
                      : PluginEnabled::Disabled),
          can_save(false), has_subtunes(false), writes_tag(false)
    {
    }

    ~PluginHandle()
    {
        if (watches.len())
            AUDWARN("Plugin watch count not zero at exit!\n");
    }
};

static constexpr aud::array<PluginType, const char *> plugin_type_names = {
    "transport", "playlist", "input",   "effect",
    "output",    "vis",      "general", "iface"};

static constexpr aud::array<InputKey, const char *> input_key_names = {
    "scheme", "ext", "mime"};

static aud::array<PluginType, Index<PluginHandle *>> plugins;
static aud::array<PluginType, Index<PluginHandle *>> compatible;
static aud::mutex mutex;
static bool modified = false;

static StringBuf get_basename(const char * path)
{
    const char * slash = strrchr(path, G_DIR_SEPARATOR);
    const char * dot = slash ? strrchr(slash + 1, '.') : nullptr;

    return dot ? str_copy(slash + 1, dot - (slash + 1)) : StringBuf();
}

static FILE * open_registry_file(const char * mode)
{
    StringBuf path = filename_build({aud_get_path(AudPath::UserDir), FILENAME});
    FILE * handle = g_fopen(path, mode);

    if (!handle && errno != ENOENT)
        AUDWARN("%s: %s\n", (const char *)path, strerror(errno));

    return handle;
}

static void transport_plugin_save(PluginHandle * plugin, FILE * handle)
{
    for (const String & scheme : plugin->schemes)
        fprintf(handle, "scheme %s\n", (const char *)scheme);
}

static void playlist_plugin_save(PluginHandle * plugin, FILE * handle)
{
    for (const String & ext : plugin->exts)
        fprintf(handle, "ext %s\n", (const char *)ext);

    fprintf(handle, "saves %d\n", plugin->can_save);
}

static void input_plugin_save(PluginHandle * plugin, FILE * handle)
{
    for (auto k : aud::range<InputKey>())
    {
        for (const String & key : plugin->keys[k])
            fprintf(handle, "%s %s\n", input_key_names[k], (const char *)key);
    }

    fprintf(handle, "subtunes %d\n", plugin->has_subtunes);
    fprintf(handle, "writes %d\n", plugin->writes_tag);
}

static void plugin_save(PluginHandle * plugin, FILE * handle)
{
    fprintf(handle, "%s %s\n", plugin_type_names[plugin->type],
            (const char *)plugin->path);
    fprintf(handle, "stamp %d\n", plugin->timestamp);
    fprintf(handle, "version %d\n", plugin->version);
    fprintf(handle, "flags %d\n", plugin->flags);
    fprintf(handle, "name %s\n", (const char *)plugin->name);

    if (plugin->domain)
        fprintf(handle, "domain %s\n", (const char *)plugin->domain);

    fprintf(handle, "priority %d\n", plugin->priority);
    fprintf(handle, "about %d\n", plugin->has_about);
    fprintf(handle, "config %d\n", plugin->has_configure);
    fprintf(handle, "enabled %d\n", (int)plugin->enabled);

    if (plugin->type == PluginType::Transport)
        transport_plugin_save(plugin, handle);
    else if (plugin->type == PluginType::Playlist)
        playlist_plugin_save(plugin, handle);
    else if (plugin->type == PluginType::Input)
        input_plugin_save(plugin, handle);
}

void plugin_registry_save()
{
    if (!modified)
        return;

    FILE * handle = open_registry_file("w");
    if (!handle)
        return;

    fprintf(handle, "format %d\n", FORMAT);

    for (auto & list : plugins)
    {
        for (PluginHandle * plugin : list)
            plugin_save(plugin, handle);
    }

    fclose(handle);
    modified = false;
}

void plugin_registry_cleanup()
{
    for (auto & list : plugins)
    {
        for (PluginHandle * plugin : list)
            delete plugin;

        list.clear();
    }

    for (auto & list : compatible)
        list.clear();
}

static void transport_plugin_parse(PluginHandle * plugin, TextParser & parser)
{
    while (1)
    {
        String value = parser.get_str("scheme");
        if (!value)
            break;

        plugin->schemes.append(std::move(value));
        parser.next();
    }
}

static void playlist_plugin_parse(PluginHandle * plugin, TextParser & parser)
{
    while (1)
    {
        String value = parser.get_str("ext");
        if (!value)
            break;

        plugin->exts.append(std::move(value));
        parser.next();
    }

    if (parser.get_int("saves", plugin->can_save))
        parser.next();
}

static void input_plugin_parse(PluginHandle * plugin, TextParser & parser)
{
    for (auto key : aud::range<InputKey>())
    {
        while (1)
        {
            String value = parser.get_str(input_key_names[key]);
            if (!value)
                break;

            plugin->keys[key].append(std::move(value));
            parser.next();
        }
    }

    if (parser.get_int("subtunes", plugin->has_subtunes))
        parser.next();
    if (parser.get_int("writes", plugin->writes_tag))
        parser.next();
}

static bool plugin_parse(TextParser & parser)
{
    PluginType type;
    String path;

    for (auto type2 : aud::range<PluginType>())
    {
        type = type2;
        if ((path = parser.get_str(plugin_type_names[type2])))
            break;
    }

    if (!path)
        return false;

    StringBuf basename = get_basename(path);
    if (!basename)
        return false;

    parser.next();

    int timestamp;
    if (!parser.get_int("stamp", timestamp))
        return false;

    parser.next();

    int version = 0, flags = 0;
    if (parser.get_int("version", version))
        parser.next();
    if (parser.get_int("flags", flags))
        parser.next();

    auto plugin = new PluginHandle(basename, String(), false, timestamp,
                                   version, flags, type, nullptr);

    plugins[type].append(plugin);

    plugin->name = parser.get_str("name");
    if (plugin->name)
        parser.next();

    plugin->domain = parser.get_str("domain");
    if (plugin->domain)
        parser.next();

    if (parser.get_int("priority", plugin->priority))
        parser.next();
    if (parser.get_int("about", plugin->has_about))
        parser.next();
    if (parser.get_int("config", plugin->has_configure))
        parser.next();

    int enabled;
    if (parser.get_int("enabled", enabled))
    {
        plugin->enabled = (PluginEnabled)enabled;
        parser.next();
    }

    if (type == PluginType::Transport)
        transport_plugin_parse(plugin, parser);
    else if (type == PluginType::Playlist)
        playlist_plugin_parse(plugin, parser);
    else if (type == PluginType::Input)
        input_plugin_parse(plugin, parser);

    return true;
}

/* try to migrate enabled status from another version */
static void parse_plugins_fallback(TextParser & parser)
{
    for (; !parser.eof(); parser.next())
    {
        PluginType type;
        String path;
        int enabled;

        for (auto type2 : aud::range<PluginType>())
        {
            type = type2;
            if ((path = parser.get_str(plugin_type_names[type2])))
                break;
        }

        if (!path)
            continue;

        StringBuf basename = get_basename(path);
        if (!basename)
            continue;

        parser.next();

        for (; !parser.eof(); parser.next())
        {
            if (parser.get_int("enabled", enabled))
                break;
        }

        if (parser.eof())
            return;

        // setting timestamp to zero forces a rescan
        auto plugin =
            new PluginHandle(basename, String(), false, 0, 0, 0, type, nullptr);
        plugins[type].append(plugin);
        plugin->enabled = (PluginEnabled)enabled;
    }
}

void plugin_registry_load()
{
    FILE * handle = open_registry_file("r");
    if (!handle)
        return;

    TextParser parser(handle);

    int format;
    if (!parser.get_int("format", format))
        goto ERR;

    parser.next();

    if (format == FORMAT)
    {
        while (plugin_parse(parser))
            continue;
    }
    else if (format >= MIN_FORMAT && format < FORMAT + 10)
        parse_plugins_fallback(parser);

ERR:
    fclose(handle);
}

static int plugin_compare(PluginHandle * const & a, PluginHandle * const & b)
{
    if (a->type < b->type)
        return -1;
    if (a->type > b->type)
        return 1;
    if (a->priority < b->priority)
        return -1;
    if (a->priority > b->priority)
        return 1;

    int diff;
    if ((diff = str_compare(dgettext(a->domain, a->name),
                            dgettext(b->domain, b->name))))
        return diff;

    return str_compare(a->path, b->path);
}

void plugin_registry_prune()
{
    auto check_not_found = [](PluginHandle * plugin) {
        if (plugin->path)
            return false;

        AUDINFO("Plugin not found: %s\n", (const char *)plugin->basename);
        delete plugin;
        return true;
    };

    auto check_incompatible = [](PluginHandle * plugin) {
        if (plugin_check_flags(plugin->flags))
            return false;

        AUDINFO("Incompatible plugin flags: %s\n",
                (const char *)plugin->basename);
        return true;
    };

    for (auto type : aud::range<PluginType>())
    {
        plugins[type].remove_if(check_not_found);
        plugins[type].sort(plugin_compare);
        compatible[type].insert(plugins[type].begin(), 0, plugins[type].len());
        compatible[type].remove_if(check_incompatible);
    }
}

/* Note: If there are multiple plugins with the same basename, this returns only
 * one of them.  Different plugins should be given different basenames. */
static PluginHandle * plugin_lookup_basename(const char * basename,
                                             bool compat_only)
{
    for (auto & list : (compat_only ? compatible : plugins))
    {
        for (PluginHandle * plugin : list)
        {
            if (!strcmp(plugin->basename, basename))
                return plugin;
        }
    }

    return nullptr;
}

EXPORT PluginHandle * aud_plugin_lookup_basename(const char * basename)
{
    return plugin_lookup_basename(basename, true);
}

static void plugin_get_info(PluginHandle * plugin, bool is_new)
{
    Plugin * header = plugin->header;

    plugin->version = header->version;
    plugin->flags = header->info.flags;
    plugin->name = String(header->info.name);
    plugin->domain = String(header->info.domain);
    plugin->has_about = (bool)header->info.about;
    plugin->has_configure = (bool)header->info.prefs;

    if (header->type == PluginType::Transport)
    {
        TransportPlugin * tp = (TransportPlugin *)header;

        plugin->schemes.clear();
        for (const char * scheme : tp->schemes)
            plugin->schemes.append(String(scheme));
    }
    else if (header->type == PluginType::Playlist)
    {
        PlaylistPlugin * pp = (PlaylistPlugin *)header;

        plugin->exts.clear();
        for (const char * ext : pp->extensions)
            plugin->exts.append(String(ext));

        plugin->can_save = pp->can_save;
    }
    else if (header->type == PluginType::Input)
    {
        InputPlugin * ip = (InputPlugin *)header;
        plugin->priority = ip->input_info.priority;

        for (auto k : aud::range<InputKey>())
        {
            plugin->keys[k].clear();
            for (auto key = ip->input_info.keys[k]; key && *key; key++)
                plugin->keys[k].append(String(*key));
        }

        plugin->has_subtunes =
            (ip->input_info.flags & InputPlugin::FlagSubtunes);
        plugin->writes_tag =
            (ip->input_info.flags & InputPlugin::FlagWritesTag);
    }
    else if (header->type == PluginType::Output)
    {
        OutputPlugin * op = (OutputPlugin *)header;
        plugin->priority = 10 - op->priority;
    }
    else if (header->type == PluginType::Effect)
    {
        EffectPlugin * ep = (EffectPlugin *)header;
        plugin->priority = ep->order;
    }
    else if (header->type == PluginType::General)
    {
        GeneralPlugin * gp = (GeneralPlugin *)header;
        if (is_new && gp->enabled_by_default)
            plugin->enabled = PluginEnabled::Primary;
    }
}

void plugin_register(const char * path, int timestamp)
{
    StringBuf basename = get_basename(path);
    if (!basename)
        return;

    PluginHandle * plugin = plugin_lookup_basename(basename, false);

    if (plugin)
    {
        AUDINFO("Register plugin: %s\n", path);
        plugin->path = String(path);

        if (plugin->timestamp != timestamp)
        {
            AUDINFO("Rescan plugin: %s\n", path);
            Plugin * header = plugin_load(path);
            if (!header || header->type != plugin->type)
                return;

            plugin->loaded = true;
            plugin->header = header;
            plugin->timestamp = timestamp;

            plugin_get_info(plugin, false);
            modified = true;
        }
    }
    else
    {
        AUDINFO("New plugin: %s\n", path);
        Plugin * header = plugin_load(path);
        if (!header)
            return;

        plugin =
            new PluginHandle(basename, path, true, timestamp, header->version,
                             header->info.flags, header->type, header);
        plugins[plugin->type].append(plugin);

        plugin_get_info(plugin, true);
        modified = true;
    }
}

EXPORT PluginType aud_plugin_get_type(PluginHandle * plugin)
{
    return plugin->type;
}

EXPORT const char * aud_plugin_get_basename(PluginHandle * plugin)
{
    return plugin->basename;
}

EXPORT const void * aud_plugin_get_header(PluginHandle * plugin)
{
    auto mh = mutex.take();

    if (!plugin->loaded)
    {
        Plugin * header = plugin_load(plugin->path);
        if (header && header->type == plugin->type)
            plugin->header = header;

        plugin->loaded = true;
    }

    return plugin->header;
}

EXPORT PluginHandle * aud_plugin_by_header(const void * header)
{
    for (auto & list : compatible)
    {
        for (PluginHandle * plugin : list)
        {
            if (plugin->header == header)
                return plugin;
        }
    }

    return nullptr;
}

EXPORT const Index<PluginHandle *> & aud_plugin_list(PluginType type)
{
    return compatible[type];
}

EXPORT const char * aud_plugin_get_name(PluginHandle * plugin)
{
    return dgettext(plugin->domain, plugin->name);
}

EXPORT bool aud_plugin_has_about(PluginHandle * plugin)
{
    return plugin->has_about;
}

EXPORT bool aud_plugin_has_configure(PluginHandle * plugin)
{
    return plugin->has_configure;
}

EXPORT bool aud_plugin_get_enabled(PluginHandle * plugin)
{
    return plugin->enabled != PluginEnabled::Disabled;
}

static void plugin_call_watches(PluginHandle * plugin)
{
    auto call_and_check_remove = [=](const PluginWatch & watch) {
        return !watch.func(plugin, watch.data);
    };

    plugin->watches.remove_if(call_and_check_remove);
}

PluginEnabled plugin_get_enabled(PluginHandle * plugin)
{
    return plugin->enabled;
}

void plugin_set_enabled(PluginHandle * plugin, PluginEnabled enabled)
{
    plugin->enabled = enabled;
    plugin_call_watches(plugin);
    modified = true;
}

void plugin_set_failed(PluginHandle * plugin)
{
    plugin->header = nullptr;
    plugin_set_enabled(plugin, PluginEnabled::Disabled);
}

EXPORT void aud_plugin_add_watch(PluginHandle * plugin, PluginWatchFunc func,
                                 void * data)
{
    plugin->watches.append(func, data);
}

EXPORT void aud_plugin_remove_watch(PluginHandle * plugin, PluginWatchFunc func,
                                    void * data)
{
    auto is_match = [=](const PluginWatch & watch) {
        return watch.func == func && watch.data == data;
    };

    plugin->watches.remove_if(is_match);
}

const Index<String> & transport_plugin_get_schemes(PluginHandle * plugin)
{
    return plugin->schemes;
}

bool transport_plugin_has_scheme(PluginHandle * plugin, const char * scheme)
{
    for (String & s : plugin->schemes)
    {
        if (!strcmp(s, scheme))
            return true;
    }

    return false;
}

bool playlist_plugin_can_save(PluginHandle * plugin)
{
    return plugin->can_save;
}

const Index<String> & playlist_plugin_get_exts(PluginHandle * plugin)
{
    return plugin->exts;
}

bool playlist_plugin_has_ext(PluginHandle * plugin, const char * ext)
{
    for (String & e : plugin->exts)
    {
        if (!strcmp_nocase(e, ext))
            return true;
    }

    return false;
}

bool input_plugin_has_key(PluginHandle * plugin, InputKey key,
                          const char * value)
{
    for (String & s : plugin->keys[key])
    {
        if (!strcmp_nocase(s, value))
            return true;
    }

    return false;
}

bool input_plugin_has_subtunes(PluginHandle * plugin)
{
    return plugin->has_subtunes;
}

bool input_plugin_can_write_tuple(PluginHandle * plugin)
{
    return plugin->writes_tag;
}

EXPORT Index<const char *> aud_plugin_get_supported_mime_types()
{
    Index<const char *> mimes;

    for (PluginHandle * p : aud_plugin_list(PluginType::Input))
    {
        if (!aud_plugin_get_enabled(p))
            continue;

        for (auto k : p->keys[InputKey::MIME])
            mimes.append((const char *)k);
    }

    /* sort and remove duplicates */
    /* lambda needed to avoid -Wnoexcept-type with GCC */
    mimes.sort([](const char * a, const char * b) { return strcmp(a, b); });

    int len = mimes.len();
    for (int i = 0; i + 1 < len; i++)
    {
        if (!strcmp(mimes[i], mimes[i + 1]))
            mimes[i] = nullptr;
    }

    mimes.remove_if([](const char * m) { return m == nullptr; });
    mimes.append(nullptr);

    return mimes;
}