~drizzle-trunk/drizzle/development

/* Copyright (C) 2005 MySQL AB

   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; version 2 of the License.

   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, write to the Free Software

   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

#include <drizzled/server_includes.h>

#include <mysys/my_getopt.h>

#include <mysys/hash.h>

#include <drizzled/authentication.h>

#include <drizzled/logging.h>

#include <drizzled/errmsg.h>

#include <drizzled/qcache.h>

#include <drizzled/protocol.h>

#include <drizzled/sql_parse.h>

#include <drizzled/scheduling.h>

#include <drizzled/transaction_services.h>

#include <drizzled/show.h>

#include <drizzled/handler.h>

#include <drizzled/set_var.h>

#include <drizzled/session.h>

#include <drizzled/item/null.h>

#include <drizzled/plugin_registry.h>

#include <string>

#include <vector>

#include <map>

#include <drizzled/error.h>

#include <drizzled/gettext.h>

#define REPORT_TO_LOG  1

#define REPORT_TO_USER 2

using namespace std;

typedef struct drizzled_plugin_manifest builtin_plugin[];

extern builtin_plugin DRIZZLED_BUILTIN_LIST;

static drizzled_plugin_manifest *drizzled_builtins[]=

{

  DRIZZLED_BUILTIN_LIST,(struct drizzled_plugin_manifest *)0

};

char *opt_plugin_load= NULL;

const char *opt_plugin_load_default= QUOTE_ARG(DRIZZLED_PLUGIN_LIST);

char *opt_plugin_dir_ptr;

char opt_plugin_dir[FN_REFLEN];

static const char *plugin_declarations_sym= "_mysql_plugin_declarations_";

/* Note that 'int version' must be the first field of every plugin

   sub-structure (plugin->info).

*/

static bool initialized= false;

static DYNAMIC_ARRAY plugin_dl_array;

static DYNAMIC_ARRAY plugin_array;

static bool reap_needed= false;

/*

  write-lock on LOCK_system_variables_hash is required before modifying

  the following variables/structures

*/

static MEM_ROOT plugin_mem_root;

static uint32_t global_variables_dynamic_size= 0;

static HASH bookmark_hash;

/*

  hidden part of opaque value passed to variable check functions.

  Used to provide a object-like structure to non C++ consumers.

*/

struct st_item_value_holder : public st_mysql_value

{

  Item *item;

};

/*

  stored in bookmark_hash, this structure is never removed from the

  hash and is used to mark a single offset for a session local variable

  even if plugins have been uninstalled and reinstalled, repeatedly.

  This structure is allocated from plugin_mem_root.

  The key format is as follows:

    1 byte         - variable type code

    name_len bytes - variable name

    '\0'           - end of key

*/

struct st_bookmark

{

  uint32_t name_len;

  int offset;

  uint32_t version;

  char key[1];

};

/*

  skeleton of a plugin variable - portion of structure common to all.

*/

struct st_mysql_sys_var

{

  DRIZZLE_PLUGIN_VAR_HEADER;

};

/*

  sys_var class for access to all plugin variables visible to the user

*/

class sys_var_pluginvar: public sys_var

{

public:

  struct st_plugin_int *plugin;

  struct st_mysql_sys_var *plugin_var;

  static void *operator new(size_t size, MEM_ROOT *mem_root)

  { return (void*) alloc_root(mem_root, (uint32_t) size); }

  static void operator delete(void *, size_t)

  { TRASH(ptr_arg, size); }

  sys_var_pluginvar(const char *name_arg,

                    struct st_mysql_sys_var *plugin_var_arg)

    :sys_var(name_arg), plugin_var(plugin_var_arg) {}

  sys_var_pluginvar *cast_pluginvar() { return this; }

  bool is_readonly() const { return plugin_var->flags & PLUGIN_VAR_READONLY; }

  bool check_type(enum_var_type type)

  { return !(plugin_var->flags & PLUGIN_VAR_SessionLOCAL) && type != OPT_GLOBAL; }

  bool check_update_type(Item_result type);

  SHOW_TYPE show_type();

  unsigned char* real_value_ptr(Session *session, enum_var_type type);

  TYPELIB* plugin_var_typelib(void);

  unsigned char* value_ptr(Session *session, enum_var_type type,

                           const LEX_STRING *base);

  bool check(Session *session, set_var *var);

  bool check_default(enum_var_type)

    { return is_readonly(); }

  void set_default(Session *session, enum_var_type);

  bool update(Session *session, set_var *var);

};

/* prototypes */

static bool plugin_load_list(MEM_ROOT *tmp_root, int *argc, char **argv,

                             const char *list);

static int test_plugin_options(MEM_ROOT *, struct st_plugin_int *,

                               int *, char **);

static bool register_builtin(struct st_plugin_int *,

                             struct st_plugin_int **);

static void unlock_variables(Session *session, struct system_variables *vars);

static void cleanup_variables(Session *session, struct system_variables *vars);

static void plugin_vars_free_values(sys_var *vars);

static void plugin_opt_set_limits(struct my_option *options,

                                  const struct st_mysql_sys_var *opt);

static void reap_plugins(void);

/* declared in set_var.cc */

extern sys_var *intern_find_sys_var(const char *str, uint32_t length, bool no_error);

extern bool throw_bounds_warning(Session *session, bool fixed, bool unsignd,

                                 const char *name, int64_t val);

/****************************************************************************

  Value type thunks, allows the C world to play in the C++ world

****************************************************************************/

static int item_value_type(struct st_mysql_value *value)

{

  switch (((st_item_value_holder*)value)->item->result_type()) {

  case INT_RESULT:

    return DRIZZLE_VALUE_TYPE_INT;

  case REAL_RESULT:

    return DRIZZLE_VALUE_TYPE_REAL;

  default:

    return DRIZZLE_VALUE_TYPE_STRING;

  }

}

static const char *item_val_str(struct st_mysql_value *value,

                                char *buffer, int *length)

{

  String str(buffer, *length, system_charset_info), *res;

  if (!(res= ((st_item_value_holder*)value)->item->val_str(&str)))

    return NULL;

  *length= res->length();

  if (res->c_ptr_quick() == buffer)

    return buffer;

  /*

    Lets be nice and create a temporary string since the

    buffer was too small

  */

  return current_session->strmake(res->c_ptr_quick(), res->length());

}

static int item_val_int(struct st_mysql_value *value, int64_t *buf)

{

  Item *item= ((st_item_value_holder*)value)->item;

  *buf= item->val_int();

  if (item->is_null())

    return 1;

  return 0;

}

static int item_val_real(struct st_mysql_value *value, double *buf)

{

  Item *item= ((st_item_value_holder*)value)->item;

  *buf= item->val_real();

  if (item->is_null())

    return 1;

  return 0;

}

/****************************************************************************

  Plugin support code

****************************************************************************/

static struct st_plugin_dl *plugin_dl_find(const LEX_STRING *dl)

{

  uint32_t i;

  struct st_plugin_dl *tmp;

  for (i= 0; i < plugin_dl_array.elements; i++)

  {

    tmp= *dynamic_element(&plugin_dl_array, i, struct st_plugin_dl **);

    if (! my_strnncoll(files_charset_info,

                       (const unsigned char *)dl->str, dl->length,

                       (const unsigned char *)tmp->dl.str, tmp->dl.length))

      return(tmp);

  }

  return(0);

}

static st_plugin_dl *plugin_dl_insert_or_reuse(struct st_plugin_dl *plugin_dl)

{

  uint32_t i;

  struct st_plugin_dl *tmp;

  for (i= 0; i < plugin_dl_array.elements; i++)

  {

    tmp= *dynamic_element(&plugin_dl_array, i, struct st_plugin_dl **);

    {

      memcpy(tmp, plugin_dl, sizeof(struct st_plugin_dl));

      return(tmp);

    }

  }

  if (insert_dynamic(&plugin_dl_array, (unsigned char*)&plugin_dl))

    return(0);

  tmp= *dynamic_element(&plugin_dl_array, plugin_dl_array.elements - 1,

                        struct st_plugin_dl **)=

      (struct st_plugin_dl *) memdup_root(&plugin_mem_root, (unsigned char*)plugin_dl,

                                           sizeof(struct st_plugin_dl));

  return(tmp);

}

static inline void free_plugin_mem(struct st_plugin_dl *p)

{

  if (p->handle)

    dlclose(p->handle);

  free(p->dl.str);

}

static st_plugin_dl *plugin_dl_add(const LEX_STRING *dl, int report)

{

  string dlpath;

  uint32_t plugin_dir_len, dummy_errors;

  struct st_plugin_dl *tmp, plugin_dl;

  void *sym;

  plugin_dir_len= strlen(opt_plugin_dir);

  dlpath.reserve(FN_REFLEN);

  /*

    Ensure that the dll doesn't have a path.

    This is done to ensure that only approved libraries from the

    plugin directory are used (to make this even remotely secure).

  */

  if (strchr(dl->str, FN_LIBCHAR) ||

      check_string_char_length((LEX_STRING *) dl, "", NAME_CHAR_LEN,

                               system_charset_info, 1) ||

      plugin_dir_len + dl->length + 1 >= FN_REFLEN)

  {

    if (report & REPORT_TO_USER)

      my_error(ER_UDF_NO_PATHS, MYF(0));

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, "%s",ER(ER_UDF_NO_PATHS));

    return(0);

  }

  /* If this dll is already loaded just increase ref_count. */

  if ((tmp= plugin_dl_find(dl)))

  {

    return(tmp);

  }

  memset(&plugin_dl, 0, sizeof(plugin_dl));

  /* Compile dll path */

  dlpath.append(opt_plugin_dir);

  dlpath.append("/");

  dlpath.append(dl->str);

  /* Open new dll handle */

  if (!(plugin_dl.handle= dlopen(dlpath.c_str(), RTLD_LAZY|RTLD_GLOBAL)))

  {

    const char *errmsg=dlerror();

    uint32_t dlpathlen= dlpath.length();

    if (!dlpath.compare(0, dlpathlen, errmsg))

    { // if errmsg starts from dlpath, trim this prefix.

      errmsg+=dlpathlen;

      if (*errmsg == ':') errmsg++;

      if (*errmsg == ' ') errmsg++;

    }

    if (report & REPORT_TO_USER)

      my_error(ER_CANT_OPEN_LIBRARY, MYF(0), dlpath.c_str(), errno, errmsg);

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_CANT_OPEN_LIBRARY), dlpath.c_str(), errno, errmsg);

    return(0);

  }

  /* Find plugin declarations */

  if (!(sym= dlsym(plugin_dl.handle, plugin_declarations_sym)))

  {

    free_plugin_mem(&plugin_dl);

    if (report & REPORT_TO_USER)

      my_error(ER_CANT_FIND_DL_ENTRY, MYF(0), plugin_declarations_sym);

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_CANT_FIND_DL_ENTRY), plugin_declarations_sym);

    return(0);

  }

  plugin_dl.plugins= (struct drizzled_plugin_manifest *)sym;

  /* Duplicate and convert dll name */

  plugin_dl.dl.length= dl->length * files_charset_info->mbmaxlen + 1;

  if (! (plugin_dl.dl.str= (char*) malloc(plugin_dl.dl.length)))

  {

    free_plugin_mem(&plugin_dl);

    if (report & REPORT_TO_USER)

      my_error(ER_OUTOFMEMORY, MYF(0), plugin_dl.dl.length);

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_OUTOFMEMORY), plugin_dl.dl.length);

    return(0);

  }

  plugin_dl.dl.length= copy_and_convert(plugin_dl.dl.str, plugin_dl.dl.length,

    files_charset_info, dl->str, dl->length, system_charset_info,

    &dummy_errors);

  plugin_dl.dl.str[plugin_dl.dl.length]= 0;

  /* Add this dll to array */

  if (! (tmp= plugin_dl_insert_or_reuse(&plugin_dl)))

  {

    free_plugin_mem(&plugin_dl);

    if (report & REPORT_TO_USER)

      my_error(ER_OUTOFMEMORY, MYF(0), sizeof(struct st_plugin_dl));

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_OUTOFMEMORY), sizeof(struct st_plugin_dl));

    return(0);

  }

  return(tmp);

}

static void plugin_dl_del(const LEX_STRING *dl)

{

  uint32_t i;

  for (i= 0; i < plugin_dl_array.elements; i++)

  {

    struct st_plugin_dl *tmp= *dynamic_element(&plugin_dl_array, i,

                                               struct st_plugin_dl **);

    if (! my_strnncoll(files_charset_info,

                       (const unsigned char *)dl->str, dl->length,

                       (const unsigned char *)tmp->dl.str, tmp->dl.length))

    {

      /* Do not remove this element, unless no other plugin uses this dll. */

      {

        free_plugin_mem(tmp);

        memset(tmp, 0, sizeof(struct st_plugin_dl));

      }

      break;

    }

  }

  return;

}

static st_plugin_int *plugin_insert_or_reuse(struct st_plugin_int *plugin)

{

  struct st_plugin_int *tmp;

  if (insert_dynamic(&plugin_array, (unsigned char*)&plugin))

    return(0);

  tmp= *dynamic_element(&plugin_array, plugin_array.elements - 1,

                        struct st_plugin_int **)=

       (struct st_plugin_int *) memdup_root(&plugin_mem_root, (unsigned char*)plugin,

                                            sizeof(struct st_plugin_int));

  return(tmp);

}

/*

  NOTE

    Requires that a write-lock is held on LOCK_system_variables_hash

*/

static bool plugin_add(MEM_ROOT *tmp_root,

                       const LEX_STRING *name, const LEX_STRING *dl,

                       int *argc, char **argv, int report)

{

  PluginRegistry &registry= PluginRegistry::getPluginRegistry();

  struct st_plugin_int tmp;

  struct drizzled_plugin_manifest *plugin;

  if (! initialized)

    return(0);

  if (registry.find(name))

  {

    if (report & REPORT_TO_USER)

      my_error(ER_UDF_EXISTS, MYF(0), name->str);

    if (report & REPORT_TO_LOG)

      errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_UDF_EXISTS), name->str);

    return(true);

  }

  /* Clear the whole struct to catch future extensions. */

  memset(&tmp, 0, sizeof(tmp));

  if (! (tmp.plugin_dl= plugin_dl_add(dl, report)))

    return(true);

  /* Find plugin by name */

  for (plugin= tmp.plugin_dl->plugins; plugin->name; plugin++)

  {

    uint32_t name_len= strlen(plugin->name);

    if (! my_strnncoll(system_charset_info,

                       (const unsigned char *)name->str, name->length,

                       (const unsigned char *)plugin->name,

                       name_len))

    {

      struct st_plugin_int *tmp_plugin_ptr;

      tmp.plugin= plugin;

      tmp.name.str= (char *)plugin->name;

      tmp.name.length= name_len;

      tmp.isInited= false;

      if (!test_plugin_options(tmp_root, &tmp, argc, argv))

      {

        if ((tmp_plugin_ptr= plugin_insert_or_reuse(&tmp)))

        {

          registry.add(tmp_plugin_ptr);

          init_alloc_root(&tmp_plugin_ptr->mem_root, 4096, 4096);

          return(false);

        }

        mysql_del_sys_var_chain(tmp.system_vars);

        goto err;

      }

      /* plugin was disabled */

      plugin_dl_del(dl);

      return(false);

    }

  }

  if (report & REPORT_TO_USER)

    my_error(ER_CANT_FIND_DL_ENTRY, MYF(0), name->str);

  if (report & REPORT_TO_LOG)

    errmsg_printf(ERRMSG_LVL_ERROR, ER(ER_CANT_FIND_DL_ENTRY), name->str);

err:

  plugin_dl_del(dl);

  return(true);

}

static void plugin_del(struct st_plugin_int *plugin)

{

  PluginRegistry &registry= PluginRegistry::getPluginRegistry();

  if (plugin->isInited)

  {

    if (plugin->plugin->status_vars)

    {

      remove_status_vars(plugin->plugin->status_vars);

    }

    if (plugin->plugin->deinit)

      plugin->plugin->deinit(registry);

  }

  /* Free allocated strings before deleting the plugin. */

  plugin_vars_free_values(plugin->system_vars);

  if (plugin->plugin_dl)

    plugin_dl_del(&plugin->plugin_dl->dl);

  plugin->isInited= false;

  pthread_rwlock_wrlock(&LOCK_system_variables_hash);

  mysql_del_sys_var_chain(plugin->system_vars);

  pthread_rwlock_unlock(&LOCK_system_variables_hash);

  free_root(&plugin->mem_root, MYF(0));

}

static void reap_plugins(void)

{

  size_t count;

  uint32_t idx;

  struct st_plugin_int *plugin;

  count= plugin_array.elements;

  for (idx= 0; idx < count; idx++)

  {

    plugin= *dynamic_element(&plugin_array, idx, struct st_plugin_int **);

    plugin_del(plugin);

  }

}

static bool plugin_initialize(struct st_plugin_int *plugin)

{

  assert(plugin->isInited == false);

  PluginRegistry &registry= PluginRegistry::getPluginRegistry();

  if (plugin->plugin->init)

  {

    if (plugin->plugin->init(registry))

    {

      errmsg_printf(ERRMSG_LVL_ERROR,

                    _("Plugin '%s' init function returned error."),

                    plugin->name.str);

      goto err;

    }

  }

  plugin->isInited= true;

  if (plugin->plugin->status_vars)

  {

    add_status_vars(plugin->plugin->status_vars); // add_status_vars makes a copy

  }

  /*

    set the plugin attribute of plugin's sys vars so they are pointing

    to the active plugin

  */

  if (plugin->system_vars)

  {

    sys_var_pluginvar *var= plugin->system_vars->cast_pluginvar();

    for (;;)

    {

      var->plugin= plugin;

      if (!var->next)

        break;

      var= var->next->cast_pluginvar();

    }

  }

  return false;

err:

  return true;

}

extern "C" unsigned char *get_bookmark_hash_key(const unsigned char *, size_t *, bool);

unsigned char *get_bookmark_hash_key(const unsigned char *buff, size_t *length, bool)

{

  struct st_bookmark *var= (st_bookmark *)buff;

  *length= var->name_len + 1;

  return (unsigned char*) var->key;

}

/*

  The logic is that we first load and initialize all compiled in plugins.

  From there we load up the dynamic types (assuming we have not been told to

  skip this part).

  Finally we initialize everything, aka the dynamic that have yet to initialize.

*/

int plugin_init(int *argc, char **argv, int flags)

{

  uint32_t idx;

  struct drizzled_plugin_manifest **builtins;

  struct drizzled_plugin_manifest *plugin;

  struct st_plugin_int tmp, *plugin_ptr;

  MEM_ROOT tmp_root;

  if (initialized)

    return(0);

  init_alloc_root(&plugin_mem_root, 4096, 4096);

  init_alloc_root(&tmp_root, 4096, 4096);

  if (hash_init(&bookmark_hash, &my_charset_bin, 16, 0, 0,

                  get_bookmark_hash_key, NULL, HASH_UNIQUE))

      goto err;

  if (my_init_dynamic_array(&plugin_dl_array,

                            sizeof(struct st_plugin_dl *),16,16) ||

      my_init_dynamic_array(&plugin_array,

                            sizeof(struct st_plugin_int *),16,16))

    goto err;

  initialized= 1;

  /*

    First we register builtin plugins

  */

  for (builtins= drizzled_builtins; *builtins; builtins++)

  {

    for (plugin= *builtins; plugin->name; plugin++)

    {

      memset(&tmp, 0, sizeof(tmp));

      tmp.plugin= plugin;

      tmp.name.str= (char *)plugin->name;

      tmp.name.length= strlen(plugin->name);

      free_root(&tmp_root, MYF(MY_MARK_BLOCKS_FREE));

      if (test_plugin_options(&tmp_root, &tmp, argc, argv))

        continue;

      if (register_builtin(&tmp, &plugin_ptr))

        goto err_unlock;

      if (plugin_initialize(plugin_ptr))

        goto err_unlock;

    }

  }

  /* Register all dynamic plugins */

  if (!(flags & PLUGIN_INIT_SKIP_DYNAMIC_LOADING))

  {

    if (opt_plugin_load)

      plugin_load_list(&tmp_root, argc, argv, opt_plugin_load);

  }

  if (flags & PLUGIN_INIT_SKIP_INITIALIZATION)

    goto end;

  /*

    Now we initialize all remaining plugins

  */