ll-database-binding/src/ll-database-binding.c

   1 /*
   2  * Copyright 2017 IoT.bzh
   3  *
   4  * author: Loïc Collignon <loic.collignon@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <unistd.h>
  21 #include <sys/types.h>
  22 #include <pwd.h>
  23 #include <stdio.h>
  24 #include <string.h>
  25 #include <linux/limits.h>
  26 #include <json-c/json.h>
  27 #include <db.h>
  28
  29 #define AFB_BINDING_VERSION 2
  30 #include <afb/afb-binding.h>
  31
  32 #include "utils.h"
  33
  34 #ifndef MAX_PATH
  35 #define MAX_PATH 1024
  36 #endif
  37
  38 #define DBFILE          "ll-database-binding.db"
  39
  40 #if !defined(TO_STRING_FLAGS)
  41 # if !defined(JSON_C_TO_STRING_NOSLASHESCAPE)
  42 #  define JSON_C_TO_STRING_NOSLASHESCAPE (1<<4)
  43 # endif
  44 # define TO_STRING_FLAGS (JSON_C_TO_STRING_PLAIN | JSON_C_TO_STRING_NOSLASHESCAPE)
  45 #endif
  46
  47 // ----- Globals -----
  48 static DB *database;
  49
  50 // ----- Binding's declarations -----
  51 static int ll_database_binding_init();
  52 static void verb_insert(struct afb_req req);
  53 static void verb_update(struct afb_req req);
  54 static void verb_delete(struct afb_req req);
  55 static void verb_read(struct afb_req req);
  56
  57 // ----- Binding's implementations -----
  58
  59 /**
  60  * @brief Get the path to the database
  61  */
  62 static int get_database_path(char *buffer, size_t size)
  63 {
  64         static const char dbfile[] = DBFILE;
  65
  66         char *home, *config;
  67         int rc;
  68
  69         config = secure_getenv("XDG_CONFIG_HOME");
  70         if (config)
  71                 rc = snprintf(buffer, size, "%s/.config/%s", home, dbfile);
  72         else
  73         {
  74                 home = secure_getenv("HOME");
  75                 if (home)
  76                         rc = snprintf(buffer, size, "%s/.config/%s", home, dbfile);
  77                 else
  78                 {
  79                         struct passwd *pwd = getpwuid(getuid());
  80                         if (pwd)
  81                                 rc = snprintf(buffer, size, "%s/.config/%s", result->pw_dir, dbfile);
  82                         else
  83                                 rc = snprintf(buffer, size, "/home/%d/.config/%s", (int)getuid(), dbfile);
  84                 }
  85         }
  86         return rc;
  87 }
  88
  89 /**
  90  * @brief Initialize the binding.
  91  * @return Exit code, zero if success.
  92  */
  93 static int ll_database_binding_init()
  94 {
  95         char path[MAX_PATH];
  96         int ret;
  97
  98         ret = get_database_path(path, sizeof path);
  99         if (ret < 0 || (int)ret >=  (int)(sizeof path))
 100         {
 101                 AFB_ERROR("Can't compute the database filename");
 102                 return -1;
 103         }
 104
 105         AFB_INFO("opening database %s", path);
 106
 107         if ((ret = db_create(&database, NULL, 0)) != 0)
 108         {
 109                 AFB_ERROR("Failed to create database: %s.", db_strerror(ret));
 110                 return -1;
 111         }
 112
 113         if ((ret = database->open(database, NULL, path, NULL, DB_BTREE, DB_CREATE, 0664)) != 0)
 114         {
 115                 AFB_ERROR("Failed to open the '%s' database: %s.", path, db_strerror(ret));
 116                 database->close(database, 0);
 117                 return -1;
 118         }
 119
 120         return 0;
 121 }
 122
 123 /**
 124  * Returns the database key for the 'req'
 125  */
 126 static int get_key(struct afb_req req, DBT *key)
 127 {
 128         char *appid, *data;
 129         const char *jkey;
 130
 131         size_t ljkey, lappid, size;
 132
 133         struct json_object* args;
 134         struct json_object* item;
 135
 136         /* get the key */
 137         args = afb_req_json(req);
 138         if (!json_object_object_get_ex(args, "key", &item))
 139         {
 140                 afb_req_fail(req, "no-key", NULL);
 141                 return -1;
 142         }
 143         if (!item
 144          || !(jkey = json_object_get_string(item))
 145          || !(ljkey = strlen(jkey)))
 146         {
 147                 afb_req_fail(req, "bad-key", NULL);
 148                 return -1;
 149         }
 150
 151         /* get the appid */
 152         appid = afb_req_get_application_id(req);
 153 #if 1
 154         if (!appid)
 155                 appid = strdup("#UNKNOWN-APP#");
 156 #endif
 157         if (!appid)
 158         {
 159                 afb_req_fail(req, "bad-context", NULL);
 160                 return -1;
 161         }
 162
 163         /* make the db-key */
 164         lappid = strlen(appid);
 165         size = lappid + ljkey + 2;
 166         data = realloc(appid, size);
 167         if (!data)
 168         {
 169                 free(appid);
 170                 afb_req_fail(req, "out-of-memory", NULL);
 171                 return -1;
 172         }
 173         data[lappid] = ':';
 174         memcpy(&data[lappid + 1], jkey, ljkey + 1);
 175
 176         /* return the key */
 177         key->data = data;
 178         key->size = (uint32_t)size;
 179         return 0;
 180 }
 181
 182 static void put(struct afb_req req, int replace)
 183 {
 184         int ret;
 185         DBT key;
 186         DBT data;
 187
 188         const char* value;
 189
 190         struct json_object* args;
 191         struct json_object* item;
 192
 193         args = afb_req_json(req);
 194
 195         if (!json_object_object_get_ex(args, "value", &item))
 196         {
 197                 afb_req_fail(req, "no-value", NULL);
 198                 return;
 199         }
 200
 201         value = json_object_to_json_string_ext(item, TO_STRING_FLAGS);
 202         if (!value)
 203         {
 204                 afb_req_fail(req, "out-of-memory", NULL);
 205                 return;
 206         }
 207
 208         if (get_key(req, &key))
 209                 return;
 210
 211         AFB_INFO("put: key=%s, value=%s", (char*)key.data, value);
 212
 213         data.data = (void*)value;
 214         data.size = (uint32_t)strlen(value);
 215
 216         ret = database->put(database, NULL, &key, &data, replace ? 0 : DB_NOOVERWRITE);
 217         if (ret == 0)
 218                 afb_req_success(req, NULL, NULL);
 219         else
 220         {
 221                 AFB_ERROR("can't %s key %s with %s", replace ? "replace" : "insert", (char*)key.data, (char*)data.data);
 222                 afb_req_fail_f(req, "failed", "%s", db_strerror(ret));
 223         }
 224         free(key.data);
 225 }
 226
 227 static void verb_insert(struct afb_req req)
 228 {
 229         put(req, 0);
 230 }
 231
 232 static void verb_update(struct afb_req req)
 233 {
 234         put(req, 1);
 235 }
 236
 237 static void verb_delete(struct afb_req req)
 238 {
 239         DBT key;
 240         int ret;
 241
 242         if (get_key(req, &key))
 243                 return;
 244
 245         AFB_INFO("delete: key=%s", (char*)key.data);
 246
 247         if ((ret = database->del(database, NULL, &key, 0)) == 0)
 248                 afb_req_success_f(req, NULL, "db success: delete %s.", (char *)key.data);
 249         else
 250                 afb_req_fail_f(req, "Failed to delete datas.", "db fail: delete %s - %s", (char*)key.data, db_strerror(ret));
 251
 252         free(key.data);
 253 }
 254
 255 static void verb_read(struct afb_req req)
 256 {
 257         DBT key;
 258         DBT data;
 259         int ret;
 260
 261         char value[4096];
 262
 263         struct json_object* result;
 264         struct json_object* val;
 265
 266
 267         if (get_key(req, &key))
 268                 return;
 269
 270         AFB_INFO("read: key=%s", (char*)key.data);
 271
 272         data.data = value;
 273         data.ulen = 4096;
 274         data.flags = DB_DBT_USERMEM;
 275
 276         if ((ret = database->get(database, NULL, &key, &data, 0)) == 0)
 277         {
 278                 result = json_object_new_object();
 279                 val = json_tokener_parse((char*)data.data);
 280                 json_object_object_add(result, "value", val ? val : json_object_new_string((char*)data.data));
 281
 282                 afb_req_success_f(req, result, "db success: read %s=%s.", (char*)key.data, (char*)data.data);
 283         }
 284         else
 285                 afb_req_fail_f(req, "Failed to read datas.", "db fail: read %s - %s", (char*)key.data, db_strerror(ret));
 286
 287         free(key.data);
 288 }
 289
 290 // ----- Binding's configuration -----
 291 /*
 292 static const struct afb_auth ll_database_binding_auths[] = {
 293 };
 294 */
 295
 296 static const afb_verb_v2 ll_database_binding_verbs[]= {
 297                 REGISTER_VERB(insert,   NULL, NULL, AFB_SESSION_NONE_V2),
 298                 REGISTER_VERB(update,   NULL, NULL, AFB_SESSION_NONE_V2),
 299                 REGISTER_VERB(delete,   NULL, NULL, AFB_SESSION_NONE_V2),
 300                 REGISTER_VERB(read,             NULL, NULL, AFB_SESSION_NONE_V2),
 301         { .verb = NULL}
 302 };
 303
 304 const struct afb_binding_v2 afbBindingV2 = {
 305                 .api = "ll-database",
 306                 .specification = NULL,
 307                 .verbs = ll_database_binding_verbs,
 308                 .preinit = NULL,
 309                 .init = ll_database_binding_init,
 310                 .onevent = NULL,
 311                 .noconcurrency = 0
 312 };