]> git.stg.codes - stg.git/blobdiff - projects/stargazer/plugin_runner.cpp
Ticket 26. The const MODULE_SETTINGS & ms parameter added to the
[stg.git] / projects / stargazer / plugin_runner.cpp
index 0bf159b8ee5bf58601bbf88a35269e9772060629..e57a421ef245d955d6c0dfbd9945cf9e404d6cae 100644 (file)
 
 /*
  *    Author : Boris Mikhailenko <stg34@stargazer.dp.ua>
+ *    Author : Maxim Mamontov <faust@stargazer.dp.ua>
  */
 
-/*
- $Revision: 1.17 $
- $Date: 2010/09/13 05:52:46 $
- $Author: faust $
- */
+#include "plugin_runner.h"
+
+#include "stg/common.h"
 
 #include <dlfcn.h>
 #include <unistd.h>
 
-#include "stg/common.h"
-#include "stg/traffcounter.h"
-#include "plugin_runner.h"
-#include "settings_impl.h"
-#include "admins_impl.h"
-#include "tariffs_impl.h"
-#include "users_impl.h"
-#include "services_impl.h"
-#include "corps_impl.h"
-
 //-----------------------------------------------------------------------------
-PLUGIN_RUNNER::PLUGIN_RUNNER(const std::string & pFileName,
+PLUGIN_RUNNER::PLUGIN_RUNNER(const std::string & fileName,
+                             const std::string & name,
                              const MODULE_SETTINGS & ms,
-                             ADMINS_IMPL * a,
-                             TARIFFS_IMPL * t,
-                             USERS_IMPL * u,
-                             SERVICES_IMPL * svc,
-                             CORPORATIONS_IMPL * crp,
-                             TRAFFCOUNTER * tc,
-                             STORE * st,
-                             const SETTINGS_IMPL * s)
-    : pluginFileName(pFileName),
-      pluginSettingFileName(),
-      plugin(NULL),
-      isPluginLoaded(false),
-      errorStr(),
+                             ADMINS & admins,
+                             TARIFFS & tariffs,
+                             USERS & users,
+                             SERVICES & services,
+                             CORPORATIONS & corporations,
+                             TRAFFCOUNTER & traffcounter,
+                             STORE & store,
+                             const SETTINGS & settings)
+    : pluginFileName(fileName),
+      pluginName(name),
       libHandle(NULL),
-      isRunning(false),
-      admins(a),
-      tariffs(t),
-      users(u),
-      services(svc),
-      corps(crp),
-      store(st),
-      traffCnt(tc),
-      stgSettings(s),
-      modSettings(ms)
+      m_plugin(Load(ms, admins, tariffs, users, services, corporations,
+                    traffcounter, store, settings))
 {
 }
 //-----------------------------------------------------------------------------
-PLUGIN_RUNNER::PLUGIN_RUNNER(const PLUGIN_RUNNER & rvalue)
-    : pluginFileName(rvalue.pluginFileName),
-      pluginSettingFileName(rvalue.pluginSettingFileName),
-      plugin(rvalue.plugin),
-      isPluginLoaded(rvalue.isPluginLoaded),
-      errorStr(rvalue.errorStr),
-      libHandle(rvalue.libHandle),
-      isRunning(rvalue.isRunning),
-      admins(rvalue.admins),
-      tariffs(rvalue.tariffs),
-      users(rvalue.users),
-      services(rvalue.services),
-      corps(rvalue.corps),
-      store(rvalue.store),
-      traffCnt(rvalue.traffCnt),
-      stgSettings(rvalue.stgSettings),
-      modSettings(rvalue.modSettings)
-{
-}
-//-----------------------------------------------------------------------------
-PLUGIN_RUNNER & PLUGIN_RUNNER::operator=(const PLUGIN_RUNNER & rvalue)
-{
-pluginFileName = rvalue.pluginFileName;
-pluginSettingFileName = rvalue.pluginSettingFileName;
-plugin = rvalue.plugin;
-isPluginLoaded = rvalue.isPluginLoaded;
-errorStr = rvalue.errorStr;
-libHandle = rvalue.libHandle;
-isRunning = rvalue.isRunning;
-admins = rvalue.admins;
-tariffs = rvalue.tariffs;
-users = rvalue.users;
-services = rvalue.services;
-corps = rvalue.corps;
-store = rvalue.store;
-traffCnt = rvalue.traffCnt;
-stgSettings = rvalue.stgSettings;
-modSettings = rvalue.modSettings;
-
-return *this;
-}
-//-----------------------------------------------------------------------------
 PLUGIN_RUNNER::~PLUGIN_RUNNER()
 {
-if (isPluginLoaded)
-    {
-    Unload();
-    }
-
-isPluginLoaded = false;
-}
-//-----------------------------------------------------------------------------
-PLUGIN * PLUGIN_RUNNER::GetPlugin()
-{
-if (!isPluginLoaded)
+if (dlclose(libHandle))
     {
-    errorStr = "Plugin '" + pluginFileName + "' is not loaded yet!";
-    printfd(__FILE__, "PLUGIN_LOADER::GetPlugin() - %s\n", errorStr.c_str());
-    return NULL;
+    errorStr = "Failed to unload plugin '" + pluginFileName + "': " + dlerror();
+    printfd(__FILE__, "PLUGIN_RUNNER::Unload() - %s", errorStr.c_str());
     }
-
-return plugin;
 }
 //-----------------------------------------------------------------------------
 int PLUGIN_RUNNER::Start()
 {
-if (!isPluginLoaded)
-    if (Load())
-        return -1;
-
-if (!plugin)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not created!";
-    printfd(__FILE__, "PLUGIN_LOADER::Start() - %s\n", errorStr.c_str());
-    return -1;
-    }
-
-plugin->SetTariffs(tariffs);
-plugin->SetAdmins(admins);
-plugin->SetUsers(users);
-plugin->SetServices(services);
-plugin->SetCorporations(corps);
-plugin->SetTraffcounter(traffCnt);
-plugin->SetStore(store);
-plugin->SetStgSettings(stgSettings);
-
-if (plugin->Start())
-    {
-    errorStr = plugin->GetStrError();
-    return -1;
-    }
-
-return 0;
+int res = m_plugin.Start();
+errorStr = m_plugin.GetStrError();
+return res;
 }
 //-----------------------------------------------------------------------------
 int PLUGIN_RUNNER::Stop()
 {
-if (!isPluginLoaded)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not loaded yet!";
-    printfd(__FILE__, "PLUGIN_LOADER::Stop() - %s\n", errorStr.c_str());
-    return -1;
-    }
-
-if (!plugin)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not created!";
-    printfd(__FILE__, "PLUGIN_LOADER::Stop() - %s\n", errorStr.c_str());
-    return -1;
-    }
-
-plugin->Stop();
-
-return 0;
-}
-//-----------------------------------------------------------------------------
-int PLUGIN_RUNNER::Reload()
-{
-if (!isPluginLoaded)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not loaded yet!";
-    printfd(__FILE__, "PLUGIN_LOADER::Reload() - %s\n", errorStr.c_str());
-    return -1;
-    }
-
-if (!plugin)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not created!";
-    printfd(__FILE__, "PLUGIN_LOADER::Reload() - %s\n", errorStr.c_str());
-    return -1;
-    }
-
-int res = plugin->Reload();
-errorStr = plugin->GetStrError();
+int res = m_plugin.Stop();
+errorStr = m_plugin.GetStrError();
 return res;
 }
 //-----------------------------------------------------------------------------
-bool PLUGIN_RUNNER::IsRunning()
+int PLUGIN_RUNNER::Reload(const MODULE_SETTINGS & ms)
 {
-if (!isPluginLoaded)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not loaded yet!";
-    printfd(__FILE__, "PLUGIN_LOADER::IsRunning() - %s\n", errorStr.c_str());
-    return false;
-    }
-
-if (!plugin)
-    {
-    errorStr = "Plugin '" + pluginFileName + "' was not created!";
-    printfd(__FILE__, "PLUGIN_LOADER::IsRunning() - %s\n", errorStr.c_str());
-    return false;
-    }
-
-return plugin->IsRunning();
+int res = m_plugin.Reload(ms);
+errorStr = m_plugin.GetStrError();
+return res;
 }
 //-----------------------------------------------------------------------------
-int PLUGIN_RUNNER::Load()
+PLUGIN & PLUGIN_RUNNER::Load(const MODULE_SETTINGS & ms,
+                             ADMINS & admins,
+                             TARIFFS & tariffs,
+                             USERS & users,
+                             SERVICES & services,
+                             CORPORATIONS & corporations,
+                             TRAFFCOUNTER & traffcounter,
+                             STORE & store,
+                             const SETTINGS & settings)
 {
-if (isPluginLoaded)
+if (pluginFileName.empty())
     {
-    errorStr = "Plugin '" + pluginFileName + "' was already loaded!";
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - %s\n", errorStr.c_str());
-    return -1;
+    const std::string msg = "Empty plugin file name.";
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
 
-if (pluginFileName.empty())
+if (access(pluginFileName.c_str(), R_OK))
     {
-    errorStr = "Empty plugin file name!";
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - %s\n", errorStr.c_str());
-    return -1;
+    const std::string msg = "Plugin file '" + pluginFileName + "' is missing or inaccessible.";
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
 
 libHandle = dlopen(pluginFileName.c_str(), RTLD_NOW);
 
 if (!libHandle)
     {
-    errorStr = "Error loading plugin '"
-        + pluginFileName + "': '" + dlerror() + "'";
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - %s\n", errorStr.c_str());
-    return -1;
+    std::string msg = "Error loading plugin '" + pluginFileName + "'";
+    const char* error = dlerror();
+    if (error)
+        msg = msg + ": '" + error + "'";
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
 
-isPluginLoaded = true;
-
 PLUGIN * (*GetPlugin)();
 GetPlugin = (PLUGIN * (*)())dlsym(libHandle, "GetPlugin");
 if (!GetPlugin)
     {
-    errorStr = std::string("GetPlugin() not found. ") + dlerror();
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - %s\n", errorStr.c_str());
-    return -1;
+    const std::string msg = "Plugin '" + pluginFileName + "' does not have GetPlugin() function. ";
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
-plugin = GetPlugin();
+PLUGIN * plugin = GetPlugin();
 
 if (!plugin)
     {
-    errorStr = "Plugin was not created!";
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - %s\n", errorStr.c_str());
-    return -1;
+    const std::string msg = "Failed to create an instance of plugin '" + pluginFileName + "'.";
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
 
-plugin->SetSettings(modSettings);
+plugin->SetSettings(ms);
+plugin->SetTariffs(&tariffs);
+plugin->SetAdmins(&admins);
+plugin->SetUsers(&users);
+plugin->SetServices(&services);
+plugin->SetCorporations(&corporations);
+plugin->SetTraffcounter(&traffcounter);
+plugin->SetStore(&store);
+plugin->SetStgSettings(&settings);
+
 if (plugin->ParseSettings())
     {
-    errorStr = plugin->GetStrError();
-    printfd(__FILE__, "PLUGIN_LOADER::Load() - Failed to parse settings. Plugin reports: '%s'\n", errorStr.c_str());
-    return -1;
+    const std::string msg = "Plugin '" + pluginFileName + "' is unable to parse settings. " + plugin->GetStrError();
+    printfd(__FILE__, "PLUGIN_RUNNER::Load() - %s\n", msg.c_str());
+    throw Error(msg);
     }
 
-return 0;
-}
-//-----------------------------------------------------------------------------
-int PLUGIN_RUNNER::Unload()
-{
-if (isPluginLoaded)
-    {
-    if (dlclose(libHandle))
-        {
-        errorStr = "Failed to unload plugin '";
-        errorStr += pluginFileName + "': ";
-        errorStr += dlerror();
-        printfd(__FILE__, "PLUGIN_LOADER::Unload() - %s", errorStr.c_str());
-        return -1;
-        }
-    plugin = NULL;
-    isPluginLoaded = false;
-    }
-return 0;
+return *plugin;
 }
-//-----------------------------------------------------------------------------