summaryrefslogtreecommitdiffstats
path: root/src/persistence-binding.c
blob: 3efb1f0cfb5fe7301c9fcef97595bfd3ab45fe91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/*
 * Copyright 2017 IoT.bzh
 *
 * author: Loïc Collignon <loic.collignon@iot.bzh>
 * author: Jose Bollo <jose.bollo@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#define _GNU_SOURCE
#include <unistd.h>
#include <sys/types.h>
#include <pwd.h>
#include <stdio.h>
#include <string.h>
#include <limits.h>

#include <json-c/json.h>

#define AFB_BINDING_VERSION 3
#include <afb/afb-binding.h>

#if !defined(TO_STRING_FLAGS)
# if !defined(JSON_C_TO_STRING_NOSLASHESCAPE)
#  define JSON_C_TO_STRING_NOSLASHESCAPE (1<<4)
# endif
# define TO_STRING_FLAGS (JSON_C_TO_STRING_PLAIN | JSON_C_TO_STRING_NOSLASHESCAPE)
#endif

#if defined(USE_BERKELEY_DB)
#  undef USE_BERKELEY_DB
#endif

#if defined(USE_GDBM)
#  undef USE_GDBM
#  define USE_GDBM        1
#  define USE_BERKELEY_DB 0
#else
#  define USE_GDBM        0
#  define USE_BERKELEY_DB 1
#endif

// ----- Berkeley database -----
#if USE_BERKELEY_DB

#include <db.h>

#define DBFILE	"ll-database-binding.db"
#define DATA	DBT
#define DATA_SET(k,d,s)  do{memset((k),0,sizeof*(k));(k)->data=(void*)d;(k)->size=(uint32_t)s;}while(0)
#define DATA_PTR(k)      ((void*)((k).data))
#define DATA_STR(k)      ((char*)((k).data))
#define DATA_SZ(k)       ((size_t)((k).size))

static DB *database;

static int xdb_open(const char *path)
{
	int ret;

	ret = db_create(&database, NULL, 0);
	if (ret != 0)
	{
		AFB_API_ERROR(afbBindingRoot, "Failed to create database: %s.", db_strerror(ret));
		return -1;
	}

	ret = database->open(database, NULL, path, NULL, DB_BTREE, DB_CREATE, 0600);
	if (ret != 0)
	{
		AFB_API_ERROR(afbBindingRoot, "Failed to open the '%s' database: %s.", path, db_strerror(ret));
		database->close(database, 0);
		return -1;
	}
	return 0;
}

static void xdb_put(afb_req_t req, DBT *key, DBT *data, int replace)
{
	int ret;

	ret = database->put(database, NULL, key, data, replace ? 0 : DB_NOOVERWRITE);
	if (ret == 0)
		afb_req_reply(req, NULL, NULL, NULL);
	else
	{
		AFB_API_ERROR(afbBindingRoot, "can't %s key %s with %s", replace ? "replace" : "insert", DATA_STR(*key), DATA_STR(*data));
		afb_req_reply_f(req, NULL, "failed", "%s", db_strerror(ret));
	}
}

static void xdb_delete(afb_req_t req, DBT *key)
{
	int ret;

	ret = database->del(database, NULL, key, 0);
	if (ret == 0)
		afb_req_reply_f(req, NULL, NULL, NULL);
	else
	{
		AFB_API_ERROR(afbBindingRoot, "can't delete key %s", DATA_STR(*key));
		afb_req_reply_f(req, NULL, "failed", "%s", db_strerror(ret));
	}

	free(DATA_PTR(key));
}

static void verb_read(afb_req_t req)
{
	DATA key;
	DATA data;
	int ret;

	char value[4096];

	struct json_object* result;
	struct json_object* val;


	if (get_key(req, &key))
		return;

	AFB_API_DEBUG(afbBindingRoot, "read: key=%s", DATA_STR(key));

	memset(&data, 0, sizeof data);
	data.data = value;
	data.ulen = 4096;
	data.flags = DB_DBT_USERMEM;

	ret = database->get(database, NULL, &key, &data, 0);
	if (ret == 0)
	{
		result = json_object_new_object();
		val = json_tokener_parse(DATA_STR(data));
		json_object_object_add(result, "value", val ? val : json_object_new_string(DATA_STR(data)));

		afb_req_reply_f(req, result, NULL, "db success: read %s=%s.", DATA_STR(key), DATA_STR(data));
	}
	else
		afb_req_reply_f(req, NULL, "Failed to read datas.", "db fail: read %s - %s", DATA_STR(key), db_strerror(ret));

	free(DATA_PTR(key));
}

#endif

// ----- gdbm database -----
#if USE_GDBM

#include <errno.h>
#include <gdbm.h>

#define DBFILE	"ll-database-binding.dbm"
#define DATA	datum
#define DATA_SET(k,d,s)  do{(k)->dptr=(char*)d;(k)->dsize=(int)s;}while(0)
#define DATA_PTR(k)      ((void*)((k).dptr))
#define DATA_STR(k)      ((char*)((k).dptr))
#define DATA_SZ(k)       ((size_t)((k).dsize))

#if GDBM_VERSION_MAJOR > 1 || (GDBM_VERSION_MAJOR == 1 && GDBM_VERSION_MINOR >= 13)
# define IFSYS(yes,no)   (gdbm_syserr[gdbm_errno] ? (yes) : (no))
#else
# define IFSYS(yes,no)   (no)
#endif

static GDBM_FILE database;

static void onfatal(const char *text)
{
	AFB_API_ERROR(afbBindingRoot, "fatal gdbm message: %s", text);
}

static int xdb_open(const char *path)
{
	database = gdbm_open(path, 512, GDBM_WRCREAT|GDBM_SYNC, 0600, onfatal);
	if (!database)
	{
		AFB_API_ERROR(afbBindingRoot, "Fail to open/create database: %s%s%s",
			gdbm_strerror(gdbm_errno),
			IFSYS(", ", ""),
			IFSYS(strerror(errno), ""));
		return -1;
		
	}
	return 0;
}

static void xdb_put(afb_req_t req, datum *key, datum *data, int replace)
{
	int ret;

	ret = gdbm_store(database, *key, *data, replace ? GDBM_REPLACE : GDBM_INSERT);
	if (ret == 0)
		afb_req_reply(req, NULL, NULL, NULL);
	else
	{
		AFB_API_ERROR(afbBindingRoot, "can't %s key %s with %s: %s%s%s",
			replace ? "replace" : "insert",
			DATA_STR(*key),
			DATA_STR(*data),
			gdbm_strerror(gdbm_errno),
			IFSYS(", ", ""),
			IFSYS(strerror(errno), ""));
		afb_req_reply_f(req, NULL, "failed", "%s", ret > 0 ? "key already exists" : gdbm_strerror(gdbm_errno));
	}
}

static void xdb_delete(afb_req_t req, datum *key)
{
	int ret;

	ret = gdbm_delete(database, *key);
	if (ret == 0)
		afb_req_reply_f(req, NULL, NULL, NULL);
	else
	{
		AFB_API_ERROR(afbBindingRoot, "can't delete key %s: %s%s%s",
			DATA_STR(*key),
			gdbm_strerror(gdbm_errno),
			IFSYS(", ", ""),
			IFSYS(strerror(errno), ""));
		afb_req_reply_f(req, NULL, "failed", "%s", gdbm_strerror(gdbm_errno));
	}
}

static void xdb_get(afb_req_t req, datum *key)
{
	struct json_object* obj;
	datum result;

	result = gdbm_fetch(database, *key);
	if (result.dptr)
	{
		obj = json_object_new_object();
		json_object_object_add(obj, "value", json_tokener_parse(result.dptr));
		afb_req_reply(req, obj, NULL, NULL);
		free(result.dptr);
	}
	else
	{
		AFB_API_ERROR(afbBindingRoot, "can't get key %s: %s%s%s",
			DATA_STR(*key),
			gdbm_strerror(gdbm_errno),
			IFSYS(", ", ""),
			IFSYS(strerror(errno), ""));
		afb_req_reply_f(req, NULL, "failed", "%s", gdbm_strerror(gdbm_errno));
	}
}
#endif

// ----- Binding's implementations -----

/**
 * @brief Get the path to the database
 */
static int get_database_path(char *buffer, size_t size)
{
	static const char dbfile[] = DBFILE;

	char *home, *config;
	int rc;

	config = secure_getenv("XDG_CONFIG_HOME");
	if (config)
		rc = snprintf(buffer, size, "%s/%s", config, dbfile);
	else
	{
		home = secure_getenv("HOME");
		if (home)
			rc = snprintf(buffer, size, "%s/.config/%s", home, dbfile);
		else
		{
			uid_t uid = getuid();
			struct passwd *pwd = getpwuid(uid);
			if (pwd)
				rc = snprintf(buffer, size, "%s/.config/%s", pwd->pw_dir, dbfile);
			else
				rc = snprintf(buffer, size, "/home/%d/.config/%s", (int)uid, dbfile);
		}
	}
	return rc;
}

/**
 * @brief Initialize the binding.
 * @return Exit code, zero if success.
 */
static int ll_database_binding_init(afb_api_t api)
{
	char path[PATH_MAX];
	int ret;

	ret = get_database_path(path, sizeof path);
	if (ret < 0 || (int)ret >=  (int)(sizeof path))
	{
		AFB_API_ERROR(afbBindingRoot, "Can't compute the database filename");
		return -1;
	}

	AFB_API_INFO(afbBindingRoot, "opening database %s", path);
	return xdb_open(path);
}

/**
 * Returns the database key for the 'req'
 */
static int get_key(afb_req_t req, DATA *key)
{
	char *appid, *data;
	const char *jkey;

	size_t ljkey, lappid, size;

	struct json_object* args;
	struct json_object* item;

	/* get the key */
	args = afb_req_json(req);
	if (!json_object_object_get_ex(args, "key", &item))
	{
		afb_req_reply(req, NULL, "no-key", NULL);
		return -1;
	}
	if (!item
     || !(jkey = json_object_to_json_string_ext(item, JSON_C_TO_STRING_PLAIN))
	 || !(ljkey = strlen(jkey)))
	{
		afb_req_reply(req, NULL, "bad-key", NULL);
		return -1;
	}

	/* get the appid */
	appid = afb_req_get_application_id(req);
#if 1
	if (!appid)
		appid = strdup("#UNKNOWN-APP#");
#endif
	if (!appid)
	{
		afb_req_reply(req, NULL, "bad-context", NULL);
		return -1;
	}

	/* make the db-key */
	lappid = strlen(appid);
	size = lappid + ljkey + 2;
	data = realloc(appid, size);
	if (!data)
	{
		free(appid);
		afb_req_reply(req, NULL, "out-of-memory", NULL);
		return -1;
	}
	data[lappid] = ':';
	memcpy(&data[lappid + 1], jkey, ljkey + 1);

	/* return the key */
	DATA_SET(key, data, size);
	return 0;
}

static void put(afb_req_t req, int replace)
{
	DATA key;
	DATA data;

	const char* value;

	struct json_object* args;
	struct json_object* item;

	/* get the value */
	args = afb_req_json(req);
	if (!json_object_object_get_ex(args, "value", &item))
	{
		afb_req_reply(req, NULL, "no-value", NULL);
		return;
	}
	value = json_object_to_json_string_ext(item, TO_STRING_FLAGS);
	if (!value)
	{
		afb_req_reply(req, NULL, "out-of-memory", NULL);
		return;
	}
	DATA_SET(&data, value, strlen(value) + 1); /* includes the tailing null */

	/* get the key */
	if (get_key(req, &key))
		return;

	AFB_API_DEBUG(afbBindingRoot, "put: key=%s, value=%s", DATA_STR(key), DATA_STR(data));
	xdb_put(req, &key, &data, replace);
	free(DATA_PTR(key));
}

static void verb_insert(afb_req_t req)
{
	put(req, 0);
}

static void verb_update(afb_req_t req)
{
	put(req, 1);
}

static void verb_delete(afb_req_t req)
{
	DATA key;

	if (get_key(req, &key))
		return;

	AFB_API_DEBUG(afbBindingRoot, "delete: key=%s", DATA_STR(key));
	xdb_delete(req, &key);
	free(DATA_PTR(key));
}

static void verb_read(afb_req_t req)
{
	DATA key;

	if (get_key(req, &key))
		return;

	AFB_API_DEBUG(afbBindingRoot, "read: key=%s", DATA_STR(key));
	xdb_get(req, &key);
	free(DATA_PTR(key));
}

// ----- Binding's configuration -----
/*
static const struct afb_auth ll_database_binding_auths[] = {
};
*/

#define VERB(name_,auth_,info_,sess_) {\
	.verb = #name_, \
	.callback = verb_##name_, \
	.auth = auth_, \
	.info = info_, \
	.session = sess_ }

static const afb_verb_t ll_database_binding_verbs[]= {
	VERB(insert,	NULL, NULL, AFB_SESSION_NONE),
	VERB(update,	NULL, NULL, AFB_SESSION_NONE),
	VERB(delete,	NULL, NULL, AFB_SESSION_NONE),
	VERB(read,	NULL, NULL, AFB_SESSION_NONE),
        { .verb = NULL}
};

const afb_binding_t afbBindingExport = {
	.api = "persistence",
	.specification = NULL,
	.verbs = ll_database_binding_verbs,
	.preinit = NULL,
	.init = ll_database_binding_init,
	.onevent = NULL,
	.noconcurrency = 0
};