issue #5590
[asterisk/asterisk.git] / db.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief ASTdb Management
22  * 
23  *
24  * DB3 is licensed under Sleepycat Public License and is thus incompatible
25  * with GPL.  To avoid having to make another exception (and complicate 
26  * licensing even further) we elect to use DB1 which is BSD licensed 
27  */
28
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <sys/time.h>
34 #include <signal.h>
35 #include <errno.h>
36 #include <unistd.h>
37 #include <dirent.h>
38
39 #include "asterisk.h"
40
41 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
42
43 #include "asterisk/channel.h"
44 #include "asterisk/file.h"
45 #include "asterisk/app.h"
46 #include "asterisk/dsp.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/options.h"
49 #include "asterisk/astdb.h"
50 #include "asterisk/cli.h"
51 #include "asterisk/utils.h"
52 #include "asterisk/lock.h"
53 #include "asterisk/manager.h"
54 #include "db1-ast/include/db.h"
55
56 #ifdef __CYGWIN__
57 #define dbopen __dbopen
58 #endif
59
60 static DB *astdb;
61 AST_MUTEX_DEFINE_STATIC(dblock);
62
63 static int dbinit(void) 
64 {
65         if (!astdb) {
66                 if (!(astdb = dbopen((char *)ast_config_AST_DB, O_CREAT | O_RDWR, 0664, DB_BTREE, NULL))) {
67                         ast_log(LOG_WARNING, "Unable to open Asterisk database\n");
68                 }
69         }
70         if (astdb)
71                 return 0;
72         return -1;
73 }
74
75
76 static inline int keymatch(const char *key, const char *prefix)
77 {
78         int preflen = strlen(prefix);
79         if (!preflen)
80                 return 1;
81         if (!strcasecmp(key, prefix))
82                 return 1;
83         if ((strlen(key) > preflen) && !strncasecmp(key, prefix, preflen)) {
84                 if (key[preflen] == '/')
85                         return 1;
86         }
87         return 0;
88 }
89
90 static inline int subkeymatch(const char *key, const char *suffix)
91 {
92         int suffixlen = strlen(suffix);
93         if (suffixlen) {
94                 const char *subkey = key + strlen(key) - suffixlen;
95                 if (subkey < key)
96                         return 0;
97                 if (!strcasecmp(subkey, suffix))
98                         return 1;
99         }
100         return 0;
101 }
102
103 int ast_db_deltree(const char *family, const char *keytree)
104 {
105         char prefix[256];
106         DBT key, data;
107         char *keys;
108         int res;
109         int pass;
110         
111         if (family) {
112                 if (keytree) {
113                         snprintf(prefix, sizeof(prefix), "/%s/%s", family, keytree);
114                 } else {
115                         snprintf(prefix, sizeof(prefix), "/%s", family);
116                 }
117         } else if (keytree) {
118                 return -1;
119         } else {
120                 prefix[0] = '\0';
121         }
122         
123         ast_mutex_lock(&dblock);
124         if (dbinit()) 
125                 return -1;
126         
127         memset(&key, 0, sizeof(key));
128         memset(&data, 0, sizeof(data));
129         pass = 0;
130         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
131                 if (key.size) {
132                         keys = key.data;
133                         keys[key.size - 1] = '\0';
134                 } else {
135                         keys = "<bad key>";
136                 }
137                 if (keymatch(keys, prefix)) {
138                         astdb->del(astdb, &key, 0);
139                 }
140         }
141         astdb->sync(astdb, 0);
142         ast_mutex_unlock(&dblock);
143         return 0;
144 }
145
146 int ast_db_put(const char *family, const char *keys, char *value)
147 {
148         char fullkey[256];
149         DBT key, data;
150         int res, fullkeylen;
151
152         ast_mutex_lock(&dblock);
153         if (dbinit()) {
154                 ast_mutex_unlock(&dblock);
155                 return -1;
156         }
157
158         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
159         memset(&key, 0, sizeof(key));
160         memset(&data, 0, sizeof(data));
161         key.data = fullkey;
162         key.size = fullkeylen + 1;
163         data.data = value;
164         data.size = strlen(value) + 1;
165         res = astdb->put(astdb, &key, &data, 0);
166         astdb->sync(astdb, 0);
167         ast_mutex_unlock(&dblock);
168         if (res)
169                 ast_log(LOG_WARNING, "Unable to put value '%s' for key '%s' in family '%s'\n", value, keys, family);
170         return res;
171 }
172
173 int ast_db_get(const char *family, const char *keys, char *value, int valuelen)
174 {
175         char fullkey[256] = "";
176         DBT key, data;
177         int res, fullkeylen;
178
179         ast_mutex_lock(&dblock);
180         if (dbinit()) {
181                 ast_mutex_unlock(&dblock);
182                 return -1;
183         }
184
185         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
186         memset(&key, 0, sizeof(key));
187         memset(&data, 0, sizeof(data));
188         memset(value, 0, valuelen);
189         key.data = fullkey;
190         key.size = fullkeylen + 1;
191         
192         res = astdb->get(astdb, &key, &data, 0);
193         
194         ast_mutex_unlock(&dblock);
195
196         /* Be sure to NULL terminate our data either way */
197         if (res) {
198                 ast_log(LOG_DEBUG, "Unable to find key '%s' in family '%s'\n", keys, family);
199         } else {
200 #if 0
201                 printf("Got value of size %d\n", data.size);
202 #endif
203                 if (data.size) {
204                         ((char *)data.data)[data.size - 1] = '\0';
205                         /* Make sure that we don't write too much to the dst pointer or we don't read too much from the source pointer */
206                         strncpy(value, data.data, (valuelen > data.size) ? data.size : valuelen);
207                         value[valuelen - 1] = '\0';
208                 } else {
209                         ast_log(LOG_NOTICE, "Strange, empty value for /%s/%s\n", family, keys);
210                 }
211         }
212         return res;
213 }
214
215 int ast_db_del(const char *family, const char *keys)
216 {
217         char fullkey[256];
218         DBT key;
219         int res, fullkeylen;
220
221         ast_mutex_lock(&dblock);
222         if (dbinit()) {
223                 ast_mutex_unlock(&dblock);
224                 return -1;
225         }
226         
227         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
228         memset(&key, 0, sizeof(key));
229         key.data = fullkey;
230         key.size = fullkeylen + 1;
231         
232         res = astdb->del(astdb, &key, 0);
233         astdb->sync(astdb, 0);
234         
235         ast_mutex_unlock(&dblock);
236
237         if (res) 
238                 ast_log(LOG_DEBUG, "Unable to find key '%s' in family '%s'\n", keys, family);
239         return res;
240 }
241
242 static int database_put(int fd, int argc, char *argv[])
243 {
244         int res;
245         if (argc != 5)
246                 return RESULT_SHOWUSAGE;
247         res = ast_db_put(argv[2], argv[3], argv[4]);
248         if (res)  {
249                 ast_cli(fd, "Failed to update entry\n");
250         } else {
251                 ast_cli(fd, "Updated database successfully\n");
252         }
253         return RESULT_SUCCESS;
254 }
255
256 static int database_get(int fd, int argc, char *argv[])
257 {
258         int res;
259         char tmp[256];
260         if (argc != 4)
261                 return RESULT_SHOWUSAGE;
262         res = ast_db_get(argv[2], argv[3], tmp, sizeof(tmp));
263         if (res) {
264                 ast_cli(fd, "Database entry not found.\n");
265         } else {
266                 ast_cli(fd, "Value: %s\n", tmp);
267         }
268         return RESULT_SUCCESS;
269 }
270
271 static int database_del(int fd, int argc, char *argv[])
272 {
273         int res;
274         if (argc != 4)
275                 return RESULT_SHOWUSAGE;
276         res = ast_db_del(argv[2], argv[3]);
277         if (res) {
278                 ast_cli(fd, "Database entry does not exist.\n");
279         } else {
280                 ast_cli(fd, "Database entry removed.\n");
281         }
282         return RESULT_SUCCESS;
283 }
284
285 static int database_deltree(int fd, int argc, char *argv[])
286 {
287         int res;
288         if ((argc < 3) || (argc > 4))
289                 return RESULT_SHOWUSAGE;
290         if (argc == 4) {
291                 res = ast_db_deltree(argv[2], argv[3]);
292         } else {
293                 res = ast_db_deltree(argv[2], NULL);
294         }
295         if (res) {
296                 ast_cli(fd, "Database entries do not exist.\n");
297         } else {
298                 ast_cli(fd, "Database entries removed.\n");
299         }
300         return RESULT_SUCCESS;
301 }
302
303 static int database_show(int fd, int argc, char *argv[])
304 {
305         char prefix[256];
306         DBT key, data;
307         char *keys, *values;
308         int res;
309         int pass;
310
311         if (argc == 4) {
312                 /* Family and key tree */
313                 snprintf(prefix, sizeof(prefix), "/%s/%s", argv[2], argv[3]);
314         } else if (argc == 3) {
315                 /* Family only */
316                 snprintf(prefix, sizeof(prefix), "/%s", argv[2]);
317         } else if (argc == 2) {
318                 /* Neither */
319                 prefix[0] = '\0';
320         } else {
321                 return RESULT_SHOWUSAGE;
322         }
323         ast_mutex_lock(&dblock);
324         if (dbinit()) {
325                 ast_mutex_unlock(&dblock);
326                 ast_cli(fd, "Database unavailable\n");
327                 return RESULT_SUCCESS;  
328         }
329         memset(&key, 0, sizeof(key));
330         memset(&data, 0, sizeof(data));
331         pass = 0;
332         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
333                 if (key.size) {
334                         keys = key.data;
335                         keys[key.size - 1] = '\0';
336                 } else {
337                         keys = "<bad key>";
338                 }
339                 if (data.size) {
340                         values = data.data;
341                         values[data.size - 1]='\0';
342                 } else {
343                         values = "<bad value>";
344                 }
345                 if (keymatch(keys, prefix)) {
346                                 ast_cli(fd, "%-50s: %-25s\n", keys, values);
347                 }
348         }
349         ast_mutex_unlock(&dblock);
350         return RESULT_SUCCESS;  
351 }
352
353 static int database_showkey(int fd, int argc, char *argv[])
354 {
355         char suffix[256];
356         DBT key, data;
357         char *keys, *values;
358         int res;
359         int pass;
360
361         if (argc == 3) {
362                 /* Key only */
363                 snprintf(suffix, sizeof(suffix), "/%s", argv[2]);
364         } else {
365                 return RESULT_SHOWUSAGE;
366         }
367         ast_mutex_lock(&dblock);
368         if (dbinit()) {
369                 ast_mutex_unlock(&dblock);
370                 ast_cli(fd, "Database unavailable\n");
371                 return RESULT_SUCCESS;  
372         }
373         memset(&key, 0, sizeof(key));
374         memset(&data, 0, sizeof(data));
375         pass = 0;
376         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
377                 if (key.size) {
378                         keys = key.data;
379                         keys[key.size - 1] = '\0';
380                 } else {
381                         keys = "<bad key>";
382                 }
383                 if (data.size) {
384                         values = data.data;
385                         values[data.size - 1]='\0';
386                 } else {
387                         values = "<bad value>";
388                 }
389                 if (subkeymatch(keys, suffix)) {
390                                 ast_cli(fd, "%-50s: %-25s\n", keys, values);
391                 }
392         }
393         ast_mutex_unlock(&dblock);
394         return RESULT_SUCCESS;  
395 }
396
397 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree)
398 {
399         char prefix[256];
400         DBT key, data;
401         char *keys, *values;
402         int res;
403         int pass;
404         struct ast_db_entry *last = NULL;
405         struct ast_db_entry *cur, *ret=NULL;
406
407         if (!ast_strlen_zero(family)) {
408                 if (!ast_strlen_zero(keytree)) {
409                         /* Family and key tree */
410                         snprintf(prefix, sizeof(prefix), "/%s/%s", family, prefix);
411                 } else {
412                         /* Family only */
413                         snprintf(prefix, sizeof(prefix), "/%s", family);
414                 }
415         } else {
416                 prefix[0] = '\0';
417         }
418         ast_mutex_lock(&dblock);
419         if (dbinit()) {
420                 ast_mutex_unlock(&dblock);
421                 ast_log(LOG_WARNING, "Database unavailable\n");
422                 return NULL;    
423         }
424         memset(&key, 0, sizeof(key));
425         memset(&data, 0, sizeof(data));
426         pass = 0;
427         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
428                 if (key.size) {
429                         keys = key.data;
430                         keys[key.size - 1] = '\0';
431                 } else {
432                         keys = "<bad key>";
433                 }
434                 if (data.size) {
435                         values = data.data;
436                         values[data.size - 1] = '\0';
437                 } else {
438                         values = "<bad value>";
439                 }
440                 if (keymatch(keys, prefix)) {
441                         cur = malloc(sizeof(struct ast_db_entry) + strlen(keys) + strlen(values) + 2);
442                         if (cur) {
443                                 cur->next = NULL;
444                                 cur->key = cur->data + strlen(values) + 1;
445                                 strcpy(cur->data, values);
446                                 strcpy(cur->key, keys);
447                                 if (last) {
448                                         last->next = cur;
449                                 } else {
450                                         ret = cur;
451                                 }
452                                 last = cur;
453                         }
454                 }
455         }
456         ast_mutex_unlock(&dblock);
457         return ret;     
458 }
459
460 void ast_db_freetree(struct ast_db_entry *dbe)
461 {
462         struct ast_db_entry *last;
463         while (dbe) {
464                 last = dbe;
465                 dbe = dbe->next;
466                 free(last);
467         }
468 }
469
470 static char database_show_usage[] =
471 "Usage: database show [family [keytree]]\n"
472 "       Shows Asterisk database contents, optionally restricted\n"
473 "to a given family, or family and keytree.\n";
474
475 static char database_showkey_usage[] =
476 "Usage: database showkey <keytree>\n"
477 "       Shows Asterisk database contents, restricted to a given key.\n";
478
479 static char database_put_usage[] =
480 "Usage: database put <family> <key> <value>\n"
481 "       Adds or updates an entry in the Asterisk database for\n"
482 "a given family, key, and value.\n";
483
484 static char database_get_usage[] =
485 "Usage: database get <family> <key>\n"
486 "       Retrieves an entry in the Asterisk database for a given\n"
487 "family and key.\n";
488
489 static char database_del_usage[] =
490 "Usage: database del <family> <key>\n"
491 "       Deletes an entry in the Asterisk database for a given\n"
492 "family and key.\n";
493
494 static char database_deltree_usage[] =
495 "Usage: database deltree <family> [keytree]\n"
496 "       Deletes a family or specific keytree within a family\n"
497 "in the Asterisk database.\n";
498
499 struct ast_cli_entry cli_database_show =
500 { { "database", "show", NULL }, database_show, "Shows database contents", database_show_usage };
501
502 struct ast_cli_entry cli_database_showkey =
503 { { "database", "showkey", NULL }, database_showkey, "Shows database contents", database_showkey_usage };
504
505 struct ast_cli_entry cli_database_get =
506 { { "database", "get", NULL }, database_get, "Gets database value", database_get_usage };
507
508 struct ast_cli_entry cli_database_put =
509 { { "database", "put", NULL }, database_put, "Adds/updates database value", database_put_usage };
510
511 struct ast_cli_entry cli_database_del =
512 { { "database", "del", NULL }, database_del, "Removes database key/value", database_del_usage };
513
514 struct ast_cli_entry cli_database_deltree =
515 { { "database", "deltree", NULL }, database_deltree, "Removes database keytree/values", database_deltree_usage };
516
517 static int manager_dbput(struct mansession *s, struct message *m)
518 {
519         char *family = astman_get_header(m, "Family");
520         char *key = astman_get_header(m, "Key");
521         char *val = astman_get_header(m, "Val");
522         int res;
523
524         if (!strlen(family)) {
525                 astman_send_error(s, m, "No family specified");
526                 return 0;
527         }
528         if (!strlen(key)) {
529                 astman_send_error(s, m, "No key specified");
530                 return 0;
531         }
532         if (!strlen(val)) {
533                 astman_send_error(s, m, "No val specified");
534                 return 0;
535         }
536
537         res = ast_db_put(family, key, val);
538         if (res) {
539                 astman_send_error(s, m, "Failed to update entry");
540         } else {
541                 astman_send_ack(s, m, "Updated database successfully");
542         }
543         return 0;
544 }
545
546 static int manager_dbget(struct mansession *s, struct message *m)
547 {
548         char *id = astman_get_header(m,"ActionID");
549         char idText[256] = "";
550         char *family = astman_get_header(m, "Family");
551         char *key = astman_get_header(m, "Key");
552         char tmp[256];
553         int res;
554
555         if (!strlen(family)) {
556                 astman_send_error(s, m, "No family specified.");
557                 return 0;
558         }
559         if (!strlen(key)) {
560                 astman_send_error(s, m, "No key specified.");
561                 return 0;
562         }
563
564         if (!ast_strlen_zero(id))
565                 snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
566
567         res = ast_db_get(family, key, tmp, sizeof(tmp));
568         if (res) {
569                 astman_send_error(s, m, "Database entry not found");
570         } else {
571                 astman_send_ack(s, m, "Result will follow");
572                 ast_cli(s->fd, "Event: DBGetResponse\r\n"
573                                 "Family: %s\r\n"
574                                 "Key: %s\r\n"
575                                 "Val: %s\r\n"
576                                 "%s"
577                                 "\r\n",
578                                 family, key, tmp, idText);
579         }
580         return 0;
581 }
582
583 int astdb_init(void)
584 {
585         dbinit();
586         ast_cli_register(&cli_database_show);
587         ast_cli_register(&cli_database_showkey);
588         ast_cli_register(&cli_database_get);
589         ast_cli_register(&cli_database_put);
590         ast_cli_register(&cli_database_del);
591         ast_cli_register(&cli_database_deltree);
592         ast_manager_register("DBGet", EVENT_FLAG_SYSTEM, manager_dbget, "Get DB Entry");
593         ast_manager_register("DBPut", EVENT_FLAG_SYSTEM, manager_dbput, "Put DB Entry");
594         return 0;
595 }