src/my/my.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2016 Inria & GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file my/my.c
  22  * @brief library to help with access to a MySQL database
  23  * @author Christophe Genevey
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include <mysql/mysql.h>
  28 #include "gnunet_my_lib.h"
  29
  30
  31 /**
  32  * Run a prepared SELECT statement.
  33  *
  34  * @param mc mysql context
  35  * @param sh handle to SELECT statment
  36  * @param params parameters to the statement
  37  * @return
  38       #GNUNET_YES if we can prepare all statement
  39       #GNUNET_SYSERR if we can't prepare all statement
  40  */
  41 int
  42 GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc,
  43                          struct GNUNET_MYSQL_StatementHandle *sh,
  44                          struct GNUNET_MY_QueryParam *params)
  45 {
  46   const struct GNUNET_MY_QueryParam *p;
  47   unsigned int num;
  48   unsigned int i;
  49   MYSQL_STMT *stmt;
  50
  51   num = 0;
  52   for (i=0;NULL != params[i].conv;i++)
  53     num += params[i].num_params;
  54   {
  55     MYSQL_BIND qbind[num];
  56     unsigned int off;
  57
  58     memset(qbind, 0, sizeof(qbind));
  59     off = 0;
  60     for (i=0;NULL != (p = &params[i])->conv;i++)
  61     {
  62       if (GNUNET_OK !=
  63           p->conv (p->conv_cls,
  64                    p,
  65                    &qbind[off]))
  66       {
  67         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
  68                     "Conversion for MySQL query failed at offset %u\n",
  69                     i);
  70         return GNUNET_SYSERR;
  71       }
  72       off += p->num_params;
  73     }
  74     stmt = GNUNET_MYSQL_statement_get_stmt (mc, sh);
  75     if (mysql_stmt_bind_param (stmt,
  76                                qbind))
  77     {
  78       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "mysql",
  79                        _("`%s' failed at %s:%d with error: %s\n"),
  80                        "mysql_stmt_bind_param", __FILE__, __LINE__,
  81                        mysql_stmt_error (stmt));
  82       GNUNET_MYSQL_statements_invalidate (mc);
  83       return GNUNET_SYSERR;
  84     }
  85
  86     if (mysql_stmt_execute (stmt))
  87     {
  88       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "mysql",
  89                        _("`%s' failed at %s:%d with error: %s\n"),
  90                        "mysql_stmt_execute", __FILE__, __LINE__,
  91                        mysql_stmt_error (stmt));
  92       GNUNET_MYSQL_statements_invalidate (mc);
  93       return GNUNET_SYSERR;
  94     }
  95
  96     GNUNET_MY_cleanup_query (params,
  97                              qbind);
  98   }
  99
 100   return GNUNET_OK;
 101 }
 102
 103
 104 /**
 105  * Free all memory that was allocated in @a qp during
 106  * #GNUNET_MY_exect_prepared().
 107  *
 108  * @param qp query specification to clean up
 109  * @param qbind array of parameter to clean up
 110  */
 111 void
 112 GNUNET_MY_cleanup_query (struct GNUNET_MY_QueryParam *qp,
 113                          MYSQL_BIND *qbind)
 114 {
 115   unsigned int i;
 116
 117   for (i=0; NULL != qp[i].conv ;i++)
 118     if (NULL != qp[i].cleaner)
 119       qp[i].cleaner (qp[i].conv_cls,
 120                      &qbind[i]);
 121 }
 122
 123
 124 /**
 125  * Extract results from a query result according to the given
 126  * specification.  Always fetches the next row.
 127  *
 128  *
 129  * @param sh statement that returned results
 130  * @param rs specification to extract for
 131  * @return
 132  *  #GNUNET_YES if all results could be extracted
 133  *  #GNUNET_NO if there is no more data in the result set
 134  *  #GNUNET_SYSERR if a result was invalid
 135  */
 136 int
 137 GNUNET_MY_extract_result (struct GNUNET_MYSQL_StatementHandle *sh,
 138                           struct GNUNET_MY_ResultSpec *rs)
 139 {
 140   unsigned int num_fields;
 141   unsigned int i;
 142   int ret;
 143   MYSQL_STMT *stmt;
 144
 145   stmt = GNUNET_MYSQL_statement_get_stmt (NULL, sh);
 146   if (NULL == stmt)
 147   {
 148     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "mysql",
 149                     ("`%s' failed at %s:%d with error: %s\n"),
 150                        "mysql_stmt_bind_result", __FILE__, __LINE__,
 151                        mysql_stmt_error (stmt));
 152     return GNUNET_SYSERR;
 153   }
 154
 155   num_fields = 0;
 156   for (i=0;NULL != rs[i].pre_conv;i++)
 157     num_fields += rs[i].num_fields;
 158
 159   if (mysql_stmt_field_count (stmt) != num_fields)
 160   {
 161     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 162                 "Number of fields missmatch between SQL result and result specification\n");
 163     return GNUNET_SYSERR;
 164   }
 165
 166   {
 167     MYSQL_BIND result[num_fields];
 168     unsigned int field_off;
 169
 170     memset (result, 0, sizeof (MYSQL_BIND) * num_fields);
 171     field_off = 0;
 172     for (i=0;NULL != rs[i].pre_conv;i++)
 173     {
 174       struct GNUNET_MY_ResultSpec *rp = &rs[i];
 175
 176       if (GNUNET_OK !=
 177           rp->pre_conv (rp->conv_cls,
 178                         rp,
 179                         stmt,
 180                         field_off,
 181                         &result[field_off]))
 182       {
 183         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 184                     "Pre-conversion for MySQL result failed at offset %u\n",
 185                     i);
 186         return GNUNET_SYSERR;
 187       }
 188       field_off += rp->num_fields;
 189     }
 190     if (mysql_stmt_bind_result (stmt, result))
 191     {
 192       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 193                        "my",
 194                        _("`%s' failed at %s:%d with error: %s\n"),
 195                        "mysql_stmt_bind_result", __FILE__, __LINE__,
 196                        mysql_stmt_error (stmt));
 197       return GNUNET_SYSERR;
 198     }
 199
 200     ret = mysql_stmt_fetch (stmt);
 201
 202     if (MYSQL_NO_DATA == ret)
 203       return GNUNET_NO;
 204     if ((0 != ret ) && (MYSQL_DATA_TRUNCATED != ret))
 205     {
 206       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 207                        "my",
 208                        _("mysql_stmt_fetch failed at %s:%d with error: %s\n"),
 209                        __FILE__, __LINE__,
 210                        mysql_stmt_error (stmt));
 211       GNUNET_MY_cleanup_result (rs);
 212       return GNUNET_SYSERR;
 213     }
 214     field_off = 0;
 215     for (i=0;NULL != rs[i].post_conv;i++)
 216     {
 217       struct GNUNET_MY_ResultSpec *rp = &rs[i];
 218
 219       if (NULL != rp->post_conv)
 220         if (GNUNET_OK !=
 221             rp->post_conv (rp->conv_cls,
 222                            rp,
 223                            stmt,
 224                            field_off,
 225                            &result[field_off]))
 226         {
 227           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 228                       "Post-conversion for MySQL result failed at offset %u\n",
 229                       i);
 230           GNUNET_MY_cleanup_result (rs);
 231           return GNUNET_SYSERR;
 232         }
 233       field_off += rp->num_fields;
 234     }
 235   }
 236   return GNUNET_OK;
 237 }
 238
 239
 240 /**
 241  * Free all memory that was allocated in @a rs during
 242  * #GNUNET_MY_extract_result().
 243  *
 244  * @param rs result specification to clean up
 245  */
 246 void
 247 GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs)
 248 {
 249   unsigned int i;
 250
 251   for (i=0;NULL != rs[i].post_conv;i++)
 252     if (NULL != rs[i].cleaner)
 253       rs[i].cleaner (rs[i].conv_cls,
 254                      &rs[i]);
 255 }
 256
 257
 258 /* end of my.c */