mysql.c File Reference

library to help with access to a MySQL database More...

#include "platform.h"
#include <mysql/mysql.h>
#include "gnunet_mysql_lib.h"

Include dependency graph for mysql.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_MYSQL_Context
	Mysql context. More...
struct	GNUNET_MYSQL_StatementHandle
	Handle for a prepared statement. More...

Macros
#define	MAX_PARAM   16
	Maximum number of supported parameters for a prepared statement. More...
#define	DIE_MYSQL(cmd, dbh)
	Die with an error message that indicates a failure of the command 'cmd' with the message given by strerror(errno). More...
#define	LOG_MYSQL(level, cmd, dbh)
	Log an error message at log-level 'level' that indicates a failure of the command 'cmd' on file 'filename' with the message given by strerror(errno). More...

Functions
static char *	get_my_cnf_path (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
	Obtain the location of ".my.cnf". More...
static int	iopen (struct GNUNET_MYSQL_Context *mc)
	Open the connection with the database (and initialize our default options). More...
struct GNUNET_MYSQL_Context *	GNUNET_MYSQL_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
	Create a mysql context. More...
void	GNUNET_MYSQL_statements_invalidate (struct GNUNET_MYSQL_Context *mc)
	Close database connection and all prepared statements (we got a DB error). More...
void	GNUNET_MYSQL_context_destroy (struct GNUNET_MYSQL_Context *mc)
	Destroy a mysql context. More...
struct GNUNET_MYSQL_StatementHandle *	GNUNET_MYSQL_statement_prepare (struct GNUNET_MYSQL_Context *mc, const char *query)
	Prepare a statement. More...
int	GNUNET_MYSQL_statement_run (struct GNUNET_MYSQL_Context *mc, const char *sql)
	Run a SQL statement. More...
static int	prepare_statement (struct GNUNET_MYSQL_StatementHandle *sh)
	Prepare a statement for running. More...
MYSQL_STMT *	GNUNET_MYSQL_statement_get_stmt (struct GNUNET_MYSQL_StatementHandle *sh)
	Get internal handle for a prepared statement. More...

Detailed Description

library to help with access to a MySQL database

Author

Christian Grothoff

Definition in file mysql.c.

Macro Definition Documentation

MAX_PARAM

#define MAX_PARAM   16

Maximum number of supported parameters for a prepared statement.

Increase if needed.

Definition at line 34 of file mysql.c.

DIE_MYSQL

#define DIE_MYSQL	(		cmd,
			dbh
	)

Value:

do                                                              \
    {                                                               \
      GNUNET_log_from(GNUNET_ERROR_TYPE_ERROR,                     \
                      "mysql",                                     \
                      _("`%s' failed at %s:%d with error: %s\n"), \
                      cmd,                                         \
                      __FILE__,                                    \
                      __LINE__,                                    \
                      mysql_error((dbh)->dbf));                   \
      GNUNET_assert(0);                                            \
    } while (0);

Die with an error message that indicates a failure of the command 'cmd' with the message given by strerror(errno).

Definition at line 42 of file mysql.c.

LOG_MYSQL

#define LOG_MYSQL	(		level,
			cmd,
			dbh
	)

Value:

do                                                              \
    {                                                               \
      GNUNET_log_from(level,                                       \
                      "mysql",                                     \
                      _("`%s' failed at %s:%d with error: %s\n"), \
                      cmd,                                         \
                      __FILE__,                                    \
                      __LINE__,                                    \
                      mysql_error((dbh)->dbf));                   \
    } while (0);

Log an error message at log-level 'level' that indicates a failure of the command 'cmd' on file 'filename' with the message given by strerror(errno).

Definition at line 60 of file mysql.c.

Referenced by GNUNET_MYSQL_statement_run(), iopen(), and prepare_statement().

Function Documentation

get_my_cnf_path()

static char* get_my_cnf_path ( const struct GNUNET_CONFIGURATION_Handle *  cfg, const char *  section  )

static

Obtain the location of ".my.cnf".

Parameters

cfg	our configuration
section	the section

Returns

NULL on error

Definition at line 153 of file mysql.c.

References _, GNUNET_MYSQL_Context::cnffile, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_have_value(), GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log_from, GNUNET_log_from_strerror, GNUNET_NO, GNUNET_OK, GNUNET_strdup, and GNUNET_YES.

Referenced by GNUNET_MYSQL_context_create().

{
  char *cnffile;
  char *home_dir;
  struct stat st;

  struct passwd *pw;

  int configured;

  pw = getpwuid(getuid());
  if (!pw)
    {
      GNUNET_log_from_strerror(GNUNET_ERROR_TYPE_ERROR, "mysql", "getpwuid");
      return NULL;
    }
  if (GNUNET_YES == GNUNET_CONFIGURATION_have_value(cfg, section, "CONFIG"))
    {
      GNUNET_assert(GNUNET_OK ==
                    GNUNET_CONFIGURATION_get_value_filename(cfg,
                                                            section,
                                                            "CONFIG",
                                                            &cnffile));
      configured = GNUNET_YES;
    }
  else
    {
      home_dir = GNUNET_strdup(pw->pw_dir);
      GNUNET_asprintf(&cnffile, "%s/.my.cnf", home_dir);
      GNUNET_free(home_dir);
      configured = GNUNET_NO;
    }

  GNUNET_log_from(GNUNET_ERROR_TYPE_INFO,
                  "mysql",
                  _("Trying to use file `%s' for MySQL configuration.\n"),
                  cnffile);
  if ((0 != stat(cnffile, &st)) || (0 != access(cnffile, R_OK)) ||
      (!S_ISREG(st.st_mode)))
    {
      if (configured == GNUNET_YES)
        GNUNET_log_from(GNUNET_ERROR_TYPE_ERROR,
                        "mysql",
                        _("Could not access file `%s': %s\n"),
                        cnffile,
                        strerror(errno));
      GNUNET_free(cnffile);
      return NULL;
    }
  return cnffile;
}

Here is the call graph for this function:

Here is the caller graph for this function:

iopen()

static int iopen ( struct GNUNET_MYSQL_Context *  mc )

static

Open the connection with the database (and initialize our default options).

Parameters

mc	database context to initialze

Returns

GNUNET_OK on success

Definition at line 215 of file mysql.c.

References GNUNET_MYSQL_Context::cfg, GNUNET_MYSQL_Context::cnffile, GNUNET_MYSQL_Context::dbf, GNUNET_assert, GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_have_value(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_free_non_null, GNUNET_OK, GNUNET_strdup, GNUNET_SYSERR, GNUNET_YES, LOG_MYSQL, reconnect(), GNUNET_MYSQL_Context::section, and timeout.

Referenced by GNUNET_MYSQL_statement_run(), and prepare_statement().

{
  char *mysql_dbname;
  char *mysql_server;
  char *mysql_user;
  char *mysql_password;
  unsigned long long mysql_port;
  my_bool reconnect;
  unsigned int timeout;

  mc->dbf = mysql_init(NULL);
  if (mc->dbf == NULL)
    return GNUNET_SYSERR;
  if (mc->cnffile != NULL)
    mysql_options(mc->dbf, MYSQL_READ_DEFAULT_FILE, mc->cnffile);
  mysql_options(mc->dbf, MYSQL_READ_DEFAULT_GROUP, "client");
  reconnect = 0;
  mysql_options(mc->dbf, MYSQL_OPT_RECONNECT, &reconnect);
  mysql_options(mc->dbf, MYSQL_OPT_CONNECT_TIMEOUT, (const void *)&timeout);
  mysql_options(mc->dbf, MYSQL_SET_CHARSET_NAME, "UTF8");
  timeout = 60; /* in seconds */
  mysql_options(mc->dbf, MYSQL_OPT_READ_TIMEOUT, (const void *)&timeout);
  mysql_options(mc->dbf, MYSQL_OPT_WRITE_TIMEOUT, (const void *)&timeout);
  mysql_dbname = NULL;
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_have_value(mc->cfg, mc->section, "DATABASE"))
    GNUNET_assert(GNUNET_OK ==
                  GNUNET_CONFIGURATION_get_value_string(mc->cfg,
                                                        mc->section,
                                                        "DATABASE",
                                                        &mysql_dbname));
  else
    mysql_dbname = GNUNET_strdup("gnunet");
  mysql_user = NULL;
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_have_value(mc->cfg, mc->section, "USER"))
    {
      GNUNET_assert(GNUNET_OK ==
                    GNUNET_CONFIGURATION_get_value_string(mc->cfg,
                                                          mc->section,
                                                          "USER",
                                                          &mysql_user));
    }
  mysql_password = NULL;
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_have_value(mc->cfg, mc->section, "PASSWORD"))
    {
      GNUNET_assert(GNUNET_OK ==
                    GNUNET_CONFIGURATION_get_value_string(mc->cfg,
                                                          mc->section,
                                                          "PASSWORD",
                                                          &mysql_password));
    }
  mysql_server = NULL;
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_have_value(mc->cfg, mc->section, "HOST"))
    {
      GNUNET_assert(GNUNET_OK ==
                    GNUNET_CONFIGURATION_get_value_string(mc->cfg,
                                                          mc->section,
                                                          "HOST",
                                                          &mysql_server));
    }
  mysql_port = 0;
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_have_value(mc->cfg, mc->section, "PORT"))
    {
      GNUNET_assert(GNUNET_OK ==
                    GNUNET_CONFIGURATION_get_value_number(mc->cfg,
                                                          mc->section,
                                                          "PORT",
                                                          &mysql_port));
    }

  GNUNET_assert(mysql_dbname != NULL);
  mysql_real_connect(mc->dbf,
                     mysql_server,
                     mysql_user,
                     mysql_password,
                     mysql_dbname,
                     (unsigned int)mysql_port,
                     NULL,
                     CLIENT_IGNORE_SIGPIPE);
  GNUNET_free_non_null(mysql_server);
  GNUNET_free_non_null(mysql_user);
  GNUNET_free_non_null(mysql_password);
  GNUNET_free(mysql_dbname);
  if (mysql_error(mc->dbf)[0])
    {
      LOG_MYSQL(GNUNET_ERROR_TYPE_ERROR, "mysql_real_connect", mc);
      return GNUNET_SYSERR;
    }
  return GNUNET_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

prepare_statement()

static int prepare_statement ( struct GNUNET_MYSQL_StatementHandle *  sh )

static

Prepare a statement for running.

Parameters

mc	mysql context
sh	statement handle to prepare

Returns

GNUNET_OK on success

Definition at line 437 of file mysql.c.

References GNUNET_MYSQL_Context::dbf, GNUNET_ERROR_TYPE_ERROR, GNUNET_log_from, GNUNET_MYSQL_statements_invalidate(), GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, iopen(), LOG_MYSQL, GNUNET_MYSQL_StatementHandle::mc, mc, GNUNET_MYSQL_StatementHandle::query, GNUNET_MYSQL_StatementHandle::statement, and GNUNET_MYSQL_StatementHandle::valid.

Referenced by GNUNET_MYSQL_statement_get_stmt().

{
  struct GNUNET_MYSQL_Context *mc = sh->mc;

  if (GNUNET_YES == sh->valid)
    return GNUNET_OK;
  if ((NULL == mc->dbf) && (GNUNET_OK != iopen(mc)))
    return GNUNET_SYSERR;
  sh->statement = mysql_stmt_init(mc->dbf);
  if (NULL == sh->statement)
    {
      GNUNET_MYSQL_statements_invalidate(mc);
      return GNUNET_SYSERR;
    }
  if (0 != mysql_stmt_prepare(sh->statement, sh->query, strlen(sh->query)))
    {
      GNUNET_log_from(GNUNET_ERROR_TYPE_ERROR,
                      "mysql",
                      "prepare_statement: %s\n",
                      sh->query);
      LOG_MYSQL(GNUNET_ERROR_TYPE_ERROR, "mysql_stmt_prepare", mc);
      mysql_stmt_close(sh->statement);
      sh->statement = NULL;
      GNUNET_MYSQL_statements_invalidate(mc);
      return GNUNET_SYSERR;
    }
  sh->valid = GNUNET_YES;
  return GNUNET_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function: