git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/plugins.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation, which is
  11    listed in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *    Plugin load/unloader for all Bacula daemons
  30  *
  31  * Kern Sibbald, October 2007
  32  */
  33 #include "bacula.h"
  34 #include "plugins.h"
  35
  36 /* All loaded plugins */
  37 alist *plugin_list = NULL;
  38
  39 /*
  40  * Create a new plugin "class" entry and enter it in the
  41  *  list of plugins.  Note, this is not the same as
  42  *  an instance of the plugin.
  43  */
  44 Plugin *new_plugin()
  45 {
  46    Plugin *plugin;
  47
  48    plugin = (Plugin *)malloc(sizeof(Plugin));
  49    memset(plugin, 0, sizeof(Plugin));
  50    plugin_list->append(plugin);
  51    return plugin;
  52 }
  53
  54
  55 /*
  56  * Load all the plugins in the specified directory.
  57  */
  58 bool load_plugins(void *binfo, void *bfuncs, const char *plugin_dir, const char *type)
  59 {
  60    bool found = false;
  61    t_loadPlugin loadPlugin;
  62    Plugin *plugin;
  63    DIR* dp = NULL;
  64    struct dirent *entry = NULL, *result;
  65    int name_max;
  66    struct stat statp;
  67    POOL_MEM fname(PM_FNAME);
  68    bool need_slash = false;
  69    int len, type_len;
  70
  71
  72    name_max = pathconf(".", _PC_NAME_MAX);
  73    if (name_max < 1024) {
  74       name_max = 1024;
  75    }
  76
  77    if (!(dp = opendir(plugin_dir))) {
  78       berrno be;
  79       Jmsg(NULL, M_ERROR_TERM, 0, _("Failed to open Plugin directory %s: ERR=%s\n"),
  80             plugin_dir, be.bstrerror());
  81       goto get_out;
  82    }
  83
  84    len = strlen(plugin_dir);
  85    if (len > 0) {
  86       need_slash = !IsPathSeparator(plugin_dir[len - 1]);
  87    }
  88    entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 1000);
  89    for ( ;; ) {
  90       if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
  91          if (!found) {
  92             Jmsg(NULL, M_WARNING, 0, _("Failed to find any plugins in %s\n"),
  93                   plugin_dir);
  94          }
  95          break;
  96       }
  97       if (strcmp(result->d_name, ".") == 0 ||
  98           strcmp(result->d_name, "..") == 0) {
  99          continue;
 100       }
 101
 102       len = strlen(result->d_name);
 103       type_len = strlen(type);
 104       if (len < type_len+1 || strcmp(&result->d_name[len-type_len], type) != 0) {
 105          Dmsg3(100, "Rejected plugin: want=%s name=%s len=%d\n", type, result->d_name, len);
 106          continue;
 107       }
 108       Dmsg2(100, "Loaded plugin: name=%s len=%d\n", result->d_name, len);
 109
 110       pm_strcpy(fname, plugin_dir);
 111       if (need_slash) {
 112          pm_strcat(fname, "/");
 113       }
 114       pm_strcat(fname, result->d_name);
 115       if (lstat(fname.c_str(), &statp) != 0 || !S_ISREG(statp.st_mode)) {
 116          continue;                 /* ignore directories & special files */
 117       }
 118
 119       plugin = new_plugin();
 120       plugin->file = bstrdup(result->d_name);
 121       plugin->pHandle = dlopen(fname.c_str(), RTLD_NOW);
 122       if (!plugin->pHandle) {
 123          Jmsg(NULL, M_ERROR, 0, _("Plugin load %s failed: ERR=%s\n"),
 124               fname.c_str(), NPRT(dlerror()));
 125          goto get_out;
 126       }
 127
 128       /* Get two global entry points */
 129       loadPlugin = (t_loadPlugin)dlsym(plugin->pHandle, "loadPlugin");
 130       if (!loadPlugin) {
 131          Jmsg(NULL, M_ERROR, 0, _("Lookup of loadPlugin in plugin %s failed: ERR=%s\n"),
 132             fname.c_str(), NPRT(dlerror()));
 133          goto get_out;
 134       }
 135       plugin->unloadPlugin = (t_unloadPlugin)dlsym(plugin->pHandle, "unloadPlugin");
 136       if (!plugin->unloadPlugin) {
 137          Jmsg(NULL, M_ERROR, 0, _("Lookup of unloadPlugin in plugin %s failed: ERR=%s\n"),
 138             fname.c_str(), NPRT(dlerror()));
 139          goto get_out;
 140       }
 141
 142       /* Initialize the plugin */
 143       loadPlugin(binfo, bfuncs, &plugin->pinfo, &plugin->pfuncs);
 144
 145       found = true;                /* found a plugin */
 146    }
 147
 148 get_out:
 149    if (entry) {
 150       free(entry);
 151    }
 152    if (dp) {
 153       closedir(dp);
 154    }
 155    return found;
 156 }
 157
 158 /*
 159  * Unload all the loaded plugins
 160  */
 161 void unload_plugins()
 162 {
 163    Plugin *plugin;
 164
 165    if (!plugin_list) {
 166       return;
 167    }
 168    foreach_alist(plugin, plugin_list) {
 169       /* Shut it down and unload it */
 170       plugin->unloadPlugin();
 171       dlclose(plugin->pHandle);
 172       if (plugin->file) {
 173          free(plugin->file);
 174       }
 175       free(plugin);
 176    }
 177    delete plugin_list;
 178    plugin_list = NULL;
 179 }