-fix
[oweals/gnunet.git] / src / datacache / plugin_datacache_postgres.c
index fdc377b8fb005a558683e84bf1e532e985215ded..b40f1fd04a293576b01a672d7d7754e7bfe04ce0 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2006, 2009, 2010 Christian Grothoff (and other contributing authors)
+     (C) 2006, 2009, 2010, 2012 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
+#include "gnunet_postgres_lib.h"
 #include "gnunet_datacache_plugin.h"
 #include <postgresql/libpq-fe.h>
 
-#define DEBUG_POSTGRES GNUNET_NO
+#define LOG(kind,...) GNUNET_log_from (kind, "datacache-postgres", __VA_ARGS__)
 
 /**
  * Per-entry overhead estimate
@@ -53,123 +54,35 @@ struct Plugin
 };
 
 
-/**
- * Check if the result obtained from Postgres has
- * the desired status code.  If not, log an error, clear the
- * result and return GNUNET_SYSERR.
- * 
- * @return GNUNET_OK if the result is acceptable
- */
-static int
-check_result (struct Plugin *plugin,
-              PGresult * ret,
-              int expected_status,
-              const char *command, const char *args, int line)
-{
-  if (ret == NULL)
-  {
-    GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
-                     "datastore-postgres",
-                     "Postgres failed to allocate result for `%s:%s' at %d\n",
-                     command, args, line);
-    return GNUNET_SYSERR;
-  }
-  if (PQresultStatus (ret) != expected_status)
-  {
-    GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
-                     "datastore-postgres",
-                     _("`%s:%s' failed at %s:%d with error: %s"),
-                     command, args, __FILE__, line,
-                     PQerrorMessage (plugin->dbh));
-    PQclear (ret);
-    return GNUNET_SYSERR;
-  }
-  return GNUNET_OK;
-}
-
-
-/**
- * Run simple SQL statement (without results).
- */
-static int
-pq_exec (struct Plugin *plugin, const char *sql, int line)
-{
-  PGresult *ret;
-
-  ret = PQexec (plugin->dbh, sql);
-  if (GNUNET_OK != check_result (plugin,
-                                 ret, PGRES_COMMAND_OK, "PQexec", sql, line))
-    return GNUNET_SYSERR;
-  PQclear (ret);
-  return GNUNET_OK;
-}
-
-
-/**
- * Prepare SQL statement.
- */
-static int
-pq_prepare (struct Plugin *plugin,
-            const char *name, const char *sql, int nparms, int line)
-{
-  PGresult *ret;
-
-  ret = PQprepare (plugin->dbh, name, sql, nparms, NULL);
-  if (GNUNET_OK !=
-      check_result (plugin, ret, PGRES_COMMAND_OK, "PQprepare", sql, line))
-    return GNUNET_SYSERR;
-  PQclear (ret);
-  return GNUNET_OK;
-}
-
-
 /**
  * @brief Get a database handle
+ *
+ * @param plugin global context
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 static int
 init_connection (struct Plugin *plugin)
 {
-  char *conninfo;
   PGresult *ret;
 
-  /* Open database and precompile statements */
-  if (GNUNET_OK !=
-      GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
-                                             "datacache-postgres",
-                                             "CONFIG", &conninfo))
-    conninfo = NULL;
-  plugin->dbh = PQconnectdb (conninfo == NULL ? "" : conninfo);
-  GNUNET_free_non_null (conninfo);
+  plugin->dbh = GNUNET_POSTGRES_connect (plugin->env->cfg,
+                                        "datacache-postgres");
   if (NULL == plugin->dbh)
-  {
-    /* FIXME: warn about out-of-memory? */
     return GNUNET_SYSERR;
-  }
-  if (PQstatus (plugin->dbh) != CONNECTION_OK)
-  {
-    GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
-                     "datacache-postgres",
-                     _("Unable to initialize Postgres: %s"),
-                     PQerrorMessage (plugin->dbh));
-    PQfinish (plugin->dbh);
-    plugin->dbh = NULL;
-    return GNUNET_SYSERR;
-  }
-  ret = PQexec (plugin->dbh,
-                "CREATE TEMPORARY TABLE gn090dc ("
-                "  type INTEGER NOT NULL DEFAULT 0,"
-                "  discard_time BIGINT NOT NULL DEFAULT 0,"
-                "  key BYTEA NOT NULL DEFAULT '',"
-                "  value BYTEA NOT NULL DEFAULT '')" "WITH OIDS");
+  ret =
+      PQexec (plugin->dbh,
+              "CREATE TEMPORARY TABLE gn090dc ("
+              "  type INTEGER NOT NULL DEFAULT 0,"
+              "  discard_time BIGINT NOT NULL DEFAULT 0,"
+              "  key BYTEA NOT NULL DEFAULT '',"
+              "  value BYTEA NOT NULL DEFAULT '')" "WITH OIDS");
   if ((ret == NULL) || ((PQresultStatus (ret) != PGRES_COMMAND_OK) && (0 != strcmp ("42P07",    /* duplicate table */
                                                                                     PQresultErrorField
                                                                                     (ret,
                                                                                      PG_DIAG_SQLSTATE)))))
   {
-    (void) check_result (plugin,
-                         ret, PGRES_COMMAND_OK, "CREATE TABLE", "gn090dc",
-                         __LINE__);
+    (void) GNUNET_POSTGRES_check_result (plugin->dbh, ret, PGRES_COMMAND_OK, "CREATE TABLE",
+                                        "gn090dc");
     PQfinish (plugin->dbh);
     plugin->dbh = NULL;
     return GNUNET_SYSERR;
@@ -177,10 +90,9 @@ init_connection (struct Plugin *plugin)
   if (PQresultStatus (ret) == PGRES_COMMAND_OK)
   {
     if ((GNUNET_OK !=
-         pq_exec (plugin, "CREATE INDEX idx_key ON gn090dc (key)", __LINE__)) ||
+         GNUNET_POSTGRES_exec (plugin->dbh, "CREATE INDEX idx_key ON gn090dc (key)")) ||
         (GNUNET_OK !=
-         pq_exec (plugin, "CREATE INDEX idx_dt ON gn090dc (discard_time)",
-                  __LINE__)))
+         GNUNET_POSTGRES_exec (plugin->dbh, "CREATE INDEX idx_dt ON gn090dc (discard_time)")))
     {
       PQclear (ret);
       PQfinish (plugin->dbh);
@@ -189,12 +101,11 @@ init_connection (struct Plugin *plugin)
     }
   }
   PQclear (ret);
-#if 1
-  ret = PQexec (plugin->dbh,
-                "ALTER TABLE gn090dc ALTER value SET STORAGE EXTERNAL");
+  ret =
+      PQexec (plugin->dbh,
+              "ALTER TABLE gn090dc ALTER value SET STORAGE EXTERNAL");
   if (GNUNET_OK !=
-      check_result (plugin,
-                    ret, PGRES_COMMAND_OK, "ALTER TABLE", "gn090dc", __LINE__))
+      GNUNET_POSTGRES_check_result (plugin->dbh, ret, PGRES_COMMAND_OK, "ALTER TABLE", "gn090dc"))
   {
     PQfinish (plugin->dbh);
     plugin->dbh = NULL;
@@ -203,47 +114,31 @@ init_connection (struct Plugin *plugin)
   PQclear (ret);
   ret = PQexec (plugin->dbh, "ALTER TABLE gn090dc ALTER key SET STORAGE PLAIN");
   if (GNUNET_OK !=
-      check_result (plugin,
-                    ret, PGRES_COMMAND_OK, "ALTER TABLE", "gn090dc", __LINE__))
+      GNUNET_POSTGRES_check_result (plugin->dbh, ret, PGRES_COMMAND_OK, "ALTER TABLE", "gn090dc"))
   {
     PQfinish (plugin->dbh);
     plugin->dbh = NULL;
     return GNUNET_SYSERR;
   }
   PQclear (ret);
-#endif
   if ((GNUNET_OK !=
-       pq_prepare (plugin,
-                   "getkt",
+       GNUNET_POSTGRES_prepare (plugin->dbh, "getkt",
                    "SELECT discard_time,type,value FROM gn090dc "
-                   "WHERE key=$1 AND type=$2 ",
-                   2,
-                   __LINE__)) ||
+                   "WHERE key=$1 AND type=$2 ", 2)) ||
       (GNUNET_OK !=
-       pq_prepare (plugin,
-                   "getk",
+       GNUNET_POSTGRES_prepare (plugin->dbh, "getk",
                    "SELECT discard_time,type,value FROM gn090dc "
-                   "WHERE key=$1",
-                   1,
-                   __LINE__)) ||
+                   "WHERE key=$1", 1)) ||
       (GNUNET_OK !=
-       pq_prepare (plugin,
-                   "getm",
+       GNUNET_POSTGRES_prepare (plugin->dbh, "getm",
                    "SELECT length(value),oid,key FROM gn090dc "
-                   "ORDER BY discard_time ASC LIMIT 1",
-                   0,
-                   __LINE__)) ||
+                   "ORDER BY discard_time ASC LIMIT 1", 0)) ||
       (GNUNET_OK !=
-       pq_prepare (plugin,
-                   "delrow",
-                   "DELETE FROM gn090dc WHERE oid=$1",
-                   1,
-                   __LINE__)) ||
+       GNUNET_POSTGRES_prepare (plugin->dbh, "delrow", "DELETE FROM gn090dc WHERE oid=$1", 1)) ||
       (GNUNET_OK !=
-       pq_prepare (plugin,
-                   "put",
+       GNUNET_POSTGRES_prepare (plugin->dbh, "put",
                    "INSERT INTO gn090dc (type, discard_time, key, value) "
-                   "VALUES ($1, $2, $3, $4)", 4, __LINE__)))
+                   "VALUES ($1, $2, $3, $4)", 4)))
   {
     PQfinish (plugin->dbh);
     plugin->dbh = NULL;
@@ -253,36 +148,6 @@ init_connection (struct Plugin *plugin)
 }
 
 
-/**
- * Delete the row identified by the given rowid (qid
- * in postgres).
- *
- * @return GNUNET_OK on success
- */
-static int
-delete_by_rowid (struct Plugin *plugin, uint32_t rowid)
-{
-  uint32_t brow = htonl (rowid);
-  const char *paramValues[] = { (const char *) &brow };
-  int paramLengths[] = { sizeof (brow) };
-  const int paramFormats[] = { 1 };
-  PGresult *ret;
-
-  ret = PQexecPrepared (plugin->dbh,
-                        "delrow",
-                        1, paramValues, paramLengths, paramFormats, 1);
-  if (GNUNET_OK !=
-      check_result (plugin,
-                    ret, PGRES_COMMAND_OK, "PQexecPrepared", "delrow",
-                    __LINE__))
-  {
-    return GNUNET_SYSERR;
-  }
-  PQclear (ret);
-  return GNUNET_OK;
-}
-
-
 /**
  * Store an item in the datastore.
  *
@@ -295,11 +160,8 @@ delete_by_rowid (struct Plugin *plugin, uint32_t rowid)
  * @return 0 on error, number of bytes used otherwise
  */
 static size_t
-postgres_plugin_put (void *cls,
-                     const GNUNET_HashCode * key,
-                     size_t size,
-                     const char *data,
-                     enum GNUNET_BLOCK_Type type,
+postgres_plugin_put (void *cls, const GNUNET_HashCode * key, size_t size,
+                     const char *data, enum GNUNET_BLOCK_Type type,
                      struct GNUNET_TIME_Absolute discard_time)
 {
   struct Plugin *plugin = cls;
@@ -321,11 +183,11 @@ postgres_plugin_put (void *cls,
   };
   const int paramFormats[] = { 1, 1, 1, 1 };
 
-  ret = PQexecPrepared (plugin->dbh,
-                        "put", 4, paramValues, paramLengths, paramFormats, 1);
-  if (GNUNET_OK != check_result (plugin, ret,
-                                 PGRES_COMMAND_OK,
-                                 "PQexecPrepared", "put", __LINE__))
+  ret =
+      PQexecPrepared (plugin->dbh, "put", 4, paramValues, paramLengths,
+                      paramFormats, 1);
+  if (GNUNET_OK !=
+      GNUNET_POSTGRES_check_result (plugin->dbh, ret, PGRES_COMMAND_OK, "PQexecPrepared", "put"))
     return GNUNET_SYSERR;
   PQclear (ret);
   return size + OVERHEAD;
@@ -344,8 +206,7 @@ postgres_plugin_put (void *cls,
  * @return the number of results found
  */
 static unsigned int
-postgres_plugin_get (void *cls,
-                     const GNUNET_HashCode * key,
+postgres_plugin_get (void *cls, const GNUNET_HashCode * key,
                      enum GNUNET_BLOCK_Type type,
                      GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 {
@@ -367,33 +228,24 @@ postgres_plugin_get (void *cls,
   unsigned int i;
   PGresult *res;
 
-  cnt = 0;
-  res = PQexecPrepared (plugin->dbh,
-                        (type == 0) ? "getk" : "getkt",
-                        (type == 0) ? 1 : 2,
-                        paramValues, paramLengths, paramFormats, 1);
-  if (GNUNET_OK != check_result (plugin,
-                                 res,
-                                 PGRES_TUPLES_OK,
-                                 "PQexecPrepared",
-                                 (type == 0) ? "getk" : "getkt", __LINE__))
+  res =
+      PQexecPrepared (plugin->dbh, (type == 0) ? "getk" : "getkt",
+                      (type == 0) ? 1 : 2, paramValues, paramLengths,
+                      paramFormats, 1);
+  if (GNUNET_OK !=
+      GNUNET_POSTGRES_check_result (plugin->dbh, res, PGRES_TUPLES_OK, "PQexecPrepared",
+                                   (type == 0) ? "getk" : "getkt"))
   {
-#if DEBUG_POSTGRES
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                     "datacache-postgres",
-                     "Ending iteration (postgres error)\n");
-#endif
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Ending iteration (postgres error)\n");
     return 0;
   }
 
   if (0 == (cnt = PQntuples (res)))
   {
     /* no result */
-#if DEBUG_POSTGRES
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                     "datacache-postgres",
-                     "Ending iteration (no more results)\n");
-#endif
+    LOG (GNUNET_ERROR_TYPE_DEBUG, 
+        "Ending iteration (no more results)\n");
     PQclear (res);
     return 0;
   }
@@ -402,8 +254,7 @@ postgres_plugin_get (void *cls,
     PQclear (res);
     return cnt;
   }
-  if ((3 != PQnfields (res)) ||
-      (sizeof (uint64_t) != PQfsize (res, 0)) ||
+  if ((3 != PQnfields (res)) || (sizeof (uint64_t) != PQfsize (res, 0)) ||
       (sizeof (uint32_t) != PQfsize (res, 1)))
   {
     GNUNET_break (0);
@@ -416,22 +267,15 @@ postgres_plugin_get (void *cls,
         GNUNET_ntohll (*(uint64_t *) PQgetvalue (res, i, 0));
     type = ntohl (*(uint32_t *) PQgetvalue (res, i, 1));
     size = PQgetlength (res, i, 2);
-#if DEBUG_POSTGRES
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                     "datacache-postgres",
-                     "Found result of size %u bytes and type %u in database\n",
-                     (unsigned int) size, (unsigned int) type);
-#endif
+    LOG (GNUNET_ERROR_TYPE_DEBUG, 
+        "Found result of size %u bytes and type %u in database\n",
+        (unsigned int) size, (unsigned int) type);
     if (GNUNET_SYSERR ==
-        iter (iter_cls,
-              expiration_time,
-              key, size, PQgetvalue (res, i, 2), (enum GNUNET_BLOCK_Type) type))
+        iter (iter_cls, expiration_time, key, size, PQgetvalue (res, i, 2),
+              (enum GNUNET_BLOCK_Type) type))
     {
-#if DEBUG_POSTGRES
-      GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                       "datacache-postgres",
-                       "Ending iteration (client error)\n");
-#endif
+      LOG (GNUNET_ERROR_TYPE_DEBUG, 
+          "Ending iteration (client error)\n");
       PQclear (res);
       return cnt;
     }
@@ -444,7 +288,7 @@ postgres_plugin_get (void *cls,
 /**
  * Delete the entry with the lowest expiration value
  * from the datacache right now.
- * 
+ *
  * @param cls closure (our "struct Plugin")
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
@@ -458,31 +302,22 @@ postgres_plugin_del (void *cls)
   PGresult *res;
 
   res = PQexecPrepared (plugin->dbh, "getm", 0, NULL, NULL, NULL, 1);
-  if (GNUNET_OK != check_result (plugin,
-                                 res,
-                                 PGRES_TUPLES_OK,
-                                 "PQexecPrepared", "getm", __LINE__))
+  if (GNUNET_OK !=
+      GNUNET_POSTGRES_check_result (plugin->dbh, res, PGRES_TUPLES_OK, "PQexecPrepared", "getm"))
   {
-#if DEBUG_POSTGRES
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                     "datacache-postgres",
-                     "Ending iteration (postgres error)\n");
-#endif
+    LOG (GNUNET_ERROR_TYPE_DEBUG, 
+        "Ending iteration (postgres error)\n");
     return 0;
   }
   if (0 == PQntuples (res))
   {
     /* no result */
-#if DEBUG_POSTGRES
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
-                     "datacache-postgres",
-                     "Ending iteration (no more results)\n");
-#endif
+    LOG (GNUNET_ERROR_TYPE_DEBUG, 
+        "Ending iteration (no more results)\n");
     PQclear (res);
     return GNUNET_SYSERR;
   }
-  if ((3 != PQnfields (res)) ||
-      (sizeof (size) != PQfsize (res, 0)) ||
+  if ((3 != PQnfields (res)) || (sizeof (size) != PQfsize (res, 0)) ||
       (sizeof (oid) != PQfsize (res, 1)) ||
       (sizeof (GNUNET_HashCode) != PQgetlength (res, 0, 2)))
   {
@@ -494,7 +329,7 @@ postgres_plugin_del (void *cls)
   oid = ntohl (*(uint32_t *) PQgetvalue (res, 0, 1));
   memcpy (&key, PQgetvalue (res, 0, 2), sizeof (GNUNET_HashCode));
   PQclear (res);
-  if (GNUNET_OK != delete_by_rowid (plugin, oid))
+  if (GNUNET_OK != GNUNET_POSTGRES_delete_by_rowid (plugin->dbh, "delrow", oid))
     return GNUNET_SYSERR;
   plugin->env->delete_notify (plugin->env->cls, &key, size + OVERHEAD);
   return GNUNET_OK;
@@ -528,8 +363,8 @@ libgnunet_plugin_datacache_postgres_init (void *cls)
   api->get = &postgres_plugin_get;
   api->put = &postgres_plugin_put;
   api->del = &postgres_plugin_del;
-  GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
-                   "datacache-postgres", _("Postgres datacache running\n"));
+  LOG (GNUNET_ERROR_TYPE_INFO, 
+       _("Postgres datacache running\n"));
   return api;
 }