pluginmanager.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2025 Savoir-faire Linux Inc.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#include "noncopyable.h"
#include "jamiplugin.h"
#include "pluginloader.h"
 
#include <functional>
#include <map>
#include <mutex>
#include <vector>
#include <list>
 
#include <inttypes.h>
 
namespace jami {
 
class PluginManager
{
public:
    PluginManager();
    ~PluginManager();
 
private:
    using ObjectDeleter = std::function<void(void*)>;
 
    // Function that may be called from plugin implementation
    using ServiceFunction = std::function<int32_t(const DLPlugin*, void*)>;
 
    // A Component is either a MediaHandler or a ChatHandler.
    // A ComponentFunction is a function that may start or end a component life.
    using ComponentFunction = std::function<int32_t(void*, std::mutex&)>;
 
    // A list of component type (MediaHandler or ChatHandler), and component pointer pairs
    using ComponentPtrList = std::list<std::pair<std::string, void*>>;
 
    struct ObjectFactory
    {
        JAMI_PluginObjectFactory data;
        ObjectDeleter deleter;
    };
 
    struct ComponentLifeCycleManager
    {
        // Register component to servicesmanager
        ComponentFunction takeComponentOwnership;
 
        // Destroys component in servicesmanager
        ComponentFunction destroyComponent;
    };
 
    // Map between plugin's library path and loader pointer
    using PluginMap = std::map<std::string, std::pair<std::shared_ptr<Plugin>, bool>>;
 
    // Map between plugins' library path and their components list
    using PluginComponentsMap = std::map<std::string, ComponentPtrList>;
 
    // Map with plugins' destruction functions
    using ExitFuncMap = std::map<std::string, JAMI_PluginExitFunc>;
    using ObjectFactoryVec = std::vector<ObjectFactory>;
    using ObjectFactoryMap = std::map<std::string, ObjectFactory>;
 
public:
    bool load(const std::string& path);
 
    bool unload(const std::string& path);
 
    std::vector<std::string> getLoadedPlugins() const;
 
    bool checkLoadedPlugin(const std::string& rootPath) const;
 
    bool registerService(const std::string& name, ServiceFunction&& func);
 
    void unRegisterService(const std::string& name);
 
    bool registerObjectFactory(const char* type, const JAMI_PluginObjectFactory& factory);
 
    bool registerComponentManager(const std::string& name,
                                  ComponentFunction&& takeOwnership,
                                  ComponentFunction&& destroyComponent);
 
private:
    NON_COPYABLE(PluginManager);
 
    void destroyPluginComponents(const std::string& path);
 
    bool callPluginInitFunction(const std::string& path);
 
    bool registerPlugin(std::unique_ptr<Plugin>& plugin);
 
    std::unique_ptr<void, ObjectDeleter> createObject(const std::string& type);
 
    static int32_t registerObjectFactory_(const JAMI_PluginAPI* api, const char* type, void* data);
 
    int32_t invokeService(const DLPlugin* plugin, const std::string& name, void* data);
 
    int32_t manageComponent(const DLPlugin* plugin, const std::string& name, void* data);
 
    std::mutex mutex_ {};
    JAMI_PluginAPI pluginApi_ = {{JAMI_PLUGIN_ABI_VERSION, JAMI_PLUGIN_API_VERSION},
                                 nullptr, // set by PluginManager constructor
                                 registerObjectFactory_,
                                 nullptr,
                                 nullptr};
    // Keeps a map between plugin library path and a Plugin instance
    // for dynamically loaded plugins.
    PluginMap dynPluginMap_ {};
 
    // Should keep reference to plugins' destruction functions read during library loading.
    ExitFuncMap exitFunc_ {};
 
    ObjectFactoryMap exactMatchMap_ {};
    ObjectFactoryVec wildCardVec_ {};
 
    // Keeps a map between services names and service functions.
    std::map<std::string, ServiceFunction> services_ {};
 
    // Keeps a ComponentsLifeCycleManager for each available Handler API.
    std::map<std::string, ComponentLifeCycleManager> componentsLifeCycleManagers_ {};
 
    // Keeps a map between plugins' library path and their components list.
    PluginComponentsMap pluginComponentsMap_ {};
 
    std::mutex mtx_;
};
} // namespace jami