Merged revisions 71289 via svnmerge from
[asterisk/asterisk.git] / main / 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  * \author Mark Spencer <markster@digium.com> 
24  *
25  * \note DB3 is licensed under Sleepycat Public License and is thus incompatible
26  * with GPL.  To avoid having to make another exception (and complicate 
27  * licensing even further) we elect to use DB1 which is BSD licensed 
28  */
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sys/time.h>
38 #include <signal.h>
39 #include <errno.h>
40 #include <unistd.h>
41 #include <dirent.h>
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 && !(astdb = dbopen((char *)ast_config_AST_DB, O_CREAT | O_RDWR, AST_FILE_MODE, DB_BTREE, NULL))) {
66                 ast_log(LOG_WARNING, "Unable to open Asterisk database\n");
67                 return -1;
68         }
69         return 0;
70 }
71
72
73 static inline int keymatch(const char *key, const char *prefix)
74 {
75         int preflen = strlen(prefix);
76         if (!preflen)
77                 return 1;
78         if (!strcasecmp(key, prefix))
79                 return 1;
80         if ((strlen(key) > preflen) && !strncasecmp(key, prefix, preflen)) {
81                 if (key[preflen] == '/')
82                         return 1;
83         }
84         return 0;
85 }
86
87 static inline int subkeymatch(const char *key, const char *suffix)
88 {
89         int suffixlen = strlen(suffix);
90         if (suffixlen) {
91                 const char *subkey = key + strlen(key) - suffixlen;
92                 if (subkey < key)
93                         return 0;
94                 if (!strcasecmp(subkey, suffix))
95                         return 1;
96         }
97         return 0;
98 }
99
100 int ast_db_deltree(const char *family, const char *keytree)
101 {
102         char prefix[256];
103         DBT key, data;
104         char *keys;
105         int res;
106         int pass;
107         
108         if (family) {
109                 if (keytree) {
110                         snprintf(prefix, sizeof(prefix), "/%s/%s", family, keytree);
111                 } else {
112                         snprintf(prefix, sizeof(prefix), "/%s", family);
113                 }
114         } else if (keytree) {
115                 return -1;
116         } else {
117                 prefix[0] = '\0';
118         }
119         
120         ast_mutex_lock(&dblock);
121         if (dbinit()) {
122                 ast_mutex_unlock(&dblock);
123                 return -1;
124         }
125         
126         memset(&key, 0, sizeof(key));
127         memset(&data, 0, sizeof(data));
128         pass = 0;
129         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
130                 if (key.size) {
131                         keys = key.data;
132                         keys[key.size - 1] = '\0';
133                 } else {
134                         keys = "<bad key>";
135                 }
136                 if (keymatch(keys, prefix)) {
137                         astdb->del(astdb, &key, 0);
138                 }
139         }
140         astdb->sync(astdb, 0);
141         ast_mutex_unlock(&dblock);
142         return 0;
143 }
144
145 int ast_db_put(const char *family, const char *keys, const char *value)
146 {
147         char fullkey[256];
148         DBT key, data;
149         int res, fullkeylen;
150
151         ast_mutex_lock(&dblock);
152         if (dbinit()) {
153                 ast_mutex_unlock(&dblock);
154                 return -1;
155         }
156
157         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
158         memset(&key, 0, sizeof(key));
159         memset(&data, 0, sizeof(data));
160         key.data = fullkey;
161         key.size = fullkeylen + 1;
162         data.data = (char *) value;
163         data.size = strlen(value) + 1;
164         res = astdb->put(astdb, &key, &data, 0);
165         astdb->sync(astdb, 0);
166         ast_mutex_unlock(&dblock);
167         if (res)
168                 ast_log(LOG_WARNING, "Unable to put value '%s' for key '%s' in family '%s'\n", value, keys, family);
169         return res;
170 }
171
172 int ast_db_get(const char *family, const char *keys, char *value, int valuelen)
173 {
174         char fullkey[256] = "";
175         DBT key, data;
176         int res, fullkeylen;
177
178         ast_mutex_lock(&dblock);
179         if (dbinit()) {
180                 ast_mutex_unlock(&dblock);
181                 return -1;
182         }
183
184         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
185         memset(&key, 0, sizeof(key));
186         memset(&data, 0, sizeof(data));
187         memset(value, 0, valuelen);
188         key.data = fullkey;
189         key.size = fullkeylen + 1;
190         
191         res = astdb->get(astdb, &key, &data, 0);
192         
193         ast_mutex_unlock(&dblock);
194
195         /* Be sure to NULL terminate our data either way */
196         if (res) {
197                 ast_debug(1, "Unable to find key '%s' in family '%s'\n", keys, family);
198         } else {
199 #if 0
200                 printf("Got value of size %d\n", data.size);
201 #endif
202                 if (data.size) {
203                         ((char *)data.data)[data.size - 1] = '\0';
204                         /* Make sure that we don't write too much to the dst pointer or we don't read too much from the source pointer */
205                         ast_copy_string(value, data.data, (valuelen > data.size) ? data.size : valuelen);
206                 } else {
207                         ast_log(LOG_NOTICE, "Strange, empty value for /%s/%s\n", family, keys);
208                 }
209         }
210         return res;
211 }
212
213 int ast_db_del(const char *family, const char *keys)
214 {
215         char fullkey[256];
216         DBT key;
217         int res, fullkeylen;
218
219         ast_mutex_lock(&dblock);
220         if (dbinit()) {
221                 ast_mutex_unlock(&dblock);
222                 return -1;
223         }
224         
225         fullkeylen = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, keys);
226         memset(&key, 0, sizeof(key));
227         key.data = fullkey;
228         key.size = fullkeylen + 1;
229         
230         res = astdb->del(astdb, &key, 0);
231         astdb->sync(astdb, 0);
232         
233         ast_mutex_unlock(&dblock);
234
235         if (res) {
236                 ast_debug(1, "Unable to find key '%s' in family '%s'\n", keys, family);
237         }
238         return res;
239 }
240
241 static int database_put(int fd, int argc, char *argv[])
242 {
243         int res;
244         if (argc != 5)
245                 return RESULT_SHOWUSAGE;
246         res = ast_db_put(argv[2], argv[3], argv[4]);
247         if (res)  {
248                 ast_cli(fd, "Failed to update entry\n");
249         } else {
250                 ast_cli(fd, "Updated database successfully\n");
251         }
252         return RESULT_SUCCESS;
253 }
254
255 static int database_get(int fd, int argc, char *argv[])
256 {
257         int res;
258         char tmp[256];
259         if (argc != 4)
260                 return RESULT_SHOWUSAGE;
261         res = ast_db_get(argv[2], argv[3], tmp, sizeof(tmp));
262         if (res) {
263                 ast_cli(fd, "Database entry not found.\n");
264         } else {
265                 ast_cli(fd, "Value: %s\n", tmp);
266         }
267         return RESULT_SUCCESS;
268 }
269
270 static int database_del(int fd, int argc, char *argv[])
271 {
272         int res;
273         if (argc != 4)
274                 return RESULT_SHOWUSAGE;
275         res = ast_db_del(argv[2], argv[3]);
276         if (res) {
277                 ast_cli(fd, "Database entry does not exist.\n");
278         } else {
279                 ast_cli(fd, "Database entry removed.\n");
280         }
281         return RESULT_SUCCESS;
282 }
283
284 static int database_deltree(int fd, int argc, char *argv[])
285 {
286         int res;
287         if ((argc < 3) || (argc > 4))
288                 return RESULT_SHOWUSAGE;
289         if (argc == 4) {
290                 res = ast_db_deltree(argv[2], argv[3]);
291         } else {
292                 res = ast_db_deltree(argv[2], NULL);
293         }
294         if (res) {
295                 ast_cli(fd, "Database entries do not exist.\n");
296         } else {
297                 ast_cli(fd, "Database entries removed.\n");
298         }
299         return RESULT_SUCCESS;
300 }
301
302 static int database_show(int fd, int argc, char *argv[])
303 {
304         char prefix[256];
305         DBT key, data;
306         char *keys, *values;
307         int res;
308         int pass;
309
310         if (argc == 4) {
311                 /* Family and key tree */
312                 snprintf(prefix, sizeof(prefix), "/%s/%s", argv[2], argv[3]);
313         } else if (argc == 3) {
314                 /* Family only */
315                 snprintf(prefix, sizeof(prefix), "/%s", argv[2]);
316         } else if (argc == 2) {
317                 /* Neither */
318                 prefix[0] = '\0';
319         } else {
320                 return RESULT_SHOWUSAGE;
321         }
322         ast_mutex_lock(&dblock);
323         if (dbinit()) {
324                 ast_mutex_unlock(&dblock);
325                 ast_cli(fd, "Database unavailable\n");
326                 return RESULT_SUCCESS;  
327         }
328         memset(&key, 0, sizeof(key));
329         memset(&data, 0, sizeof(data));
330         pass = 0;
331         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
332                 if (key.size) {
333                         keys = key.data;
334                         keys[key.size - 1] = '\0';
335                 } else {
336                         keys = "<bad key>";
337                 }
338                 if (data.size) {
339                         values = data.data;
340                         values[data.size - 1]='\0';
341                 } else {
342                         values = "<bad value>";
343                 }
344                 if (keymatch(keys, prefix)) {
345                                 ast_cli(fd, "%-50s: %-25s\n", keys, values);
346                 }
347         }
348         ast_mutex_unlock(&dblock);
349         return RESULT_SUCCESS;  
350 }
351
352 static int database_showkey(int fd, int argc, char *argv[])
353 {
354         char suffix[256];
355         DBT key, data;
356         char *keys, *values;
357         int res;
358         int pass;
359         int counter = 0;
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                                 counter++;
392                 }
393         }
394         ast_mutex_unlock(&dblock);
395         ast_cli(fd, "%d results found.\n", counter);
396         return RESULT_SUCCESS;  
397 }
398
399 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree)
400 {
401         char prefix[256];
402         DBT key, data;
403         char *keys, *values;
404         int values_len;
405         int res;
406         int pass;
407         struct ast_db_entry *last = NULL;
408         struct ast_db_entry *cur, *ret=NULL;
409
410         if (!ast_strlen_zero(family)) {
411                 if (!ast_strlen_zero(keytree)) {
412                         /* Family and key tree */
413                         snprintf(prefix, sizeof(prefix), "/%s/%s", family, prefix);
414                 } else {
415                         /* Family only */
416                         snprintf(prefix, sizeof(prefix), "/%s", family);
417                 }
418         } else {
419                 prefix[0] = '\0';
420         }
421         ast_mutex_lock(&dblock);
422         if (dbinit()) {
423                 ast_mutex_unlock(&dblock);
424                 ast_log(LOG_WARNING, "Database unavailable\n");
425                 return NULL;    
426         }
427         memset(&key, 0, sizeof(key));
428         memset(&data, 0, sizeof(data));
429         pass = 0;
430         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
431                 if (key.size) {
432                         keys = key.data;
433                         keys[key.size - 1] = '\0';
434                 } else {
435                         keys = "<bad key>";
436                 }
437                 if (data.size) {
438                         values = data.data;
439                         values[data.size - 1] = '\0';
440                 } else {
441                         values = "<bad value>";
442                 }
443                 values_len = strlen(values) + 1;
444                 if (keymatch(keys, prefix) && (cur = ast_malloc(sizeof(*cur) + strlen(keys) + 1 + values_len))) {
445                         cur->next = NULL;
446                         cur->key = cur->data + values_len;
447                         strcpy(cur->data, values);
448                         strcpy(cur->key, keys);
449                         if (last) {
450                                 last->next = cur;
451                         } else {
452                                 ret = cur;
453                         }
454                         last = cur;
455                 }
456         }
457         ast_mutex_unlock(&dblock);
458         return ret;     
459 }
460
461 void ast_db_freetree(struct ast_db_entry *dbe)
462 {
463         struct ast_db_entry *last;
464         while (dbe) {
465                 last = dbe;
466                 dbe = dbe->next;
467                 ast_free(last);
468         }
469 }
470
471 static const char database_show_usage[] =
472 "Usage: database show [family [keytree]]\n"
473 "       Shows Asterisk database contents, optionally restricted\n"
474 "to a given family, or family and keytree.\n";
475
476 static const char database_showkey_usage[] =
477 "Usage: database showkey <keytree>\n"
478 "       Shows Asterisk database contents, restricted to a given key.\n";
479
480 static const char database_put_usage[] =
481 "Usage: database put <family> <key> <value>\n"
482 "       Adds or updates an entry in the Asterisk database for\n"
483 "a given family, key, and value.\n";
484
485 static const char database_get_usage[] =
486 "Usage: database get <family> <key>\n"
487 "       Retrieves an entry in the Asterisk database for a given\n"
488 "family and key.\n";
489
490 static const char database_del_usage[] =
491 "Usage: database del <family> <key>\n"
492 "       Deletes an entry in the Asterisk database for a given\n"
493 "family and key.\n";
494
495 static const char database_deltree_usage[] =
496 "Usage: database deltree <family> [keytree]\n"
497 "       Deletes a family or specific keytree within a family\n"
498 "in the Asterisk database.\n";
499
500 struct ast_cli_entry cli_database[] = {
501         { { "database", "show", NULL },
502         database_show, "Shows database contents",
503         database_show_usage },
504
505         { { "database", "showkey", NULL },
506         database_showkey, "Shows database contents",
507         database_showkey_usage },
508
509         { { "database", "get", NULL },
510         database_get, "Gets database value",
511         database_get_usage },
512
513         { { "database", "put", NULL },
514         database_put, "Adds/updates database value",
515         database_put_usage },
516
517         { { "database", "del", NULL },
518         database_del, "Removes database key/value",
519         database_del_usage },
520
521         { { "database", "deltree", NULL },
522         database_deltree, "Removes database keytree/values",
523         database_deltree_usage },
524 };
525
526 static int manager_dbput(struct mansession *s, const struct message *m)
527 {
528         const char *family = astman_get_header(m, "Family");
529         const char *key = astman_get_header(m, "Key");
530         const char *val = astman_get_header(m, "Val");
531         int res;
532
533         if (ast_strlen_zero(family)) {
534                 astman_send_error(s, m, "No family specified");
535                 return 0;
536         }
537         if (ast_strlen_zero(key)) {
538                 astman_send_error(s, m, "No key specified");
539                 return 0;
540         }
541
542         res = ast_db_put(family, key, S_OR(val, ""));
543         if (res) {
544                 astman_send_error(s, m, "Failed to update entry");
545         } else {
546                 astman_send_ack(s, m, "Updated database successfully");
547         }
548         return 0;
549 }
550
551 static int manager_dbget(struct mansession *s, const struct message *m)
552 {
553         const char *id = astman_get_header(m,"ActionID");
554         char idText[256] = "";
555         const char *family = astman_get_header(m, "Family");
556         const char *key = astman_get_header(m, "Key");
557         char tmp[256];
558         int res;
559
560         if (ast_strlen_zero(family)) {
561                 astman_send_error(s, m, "No family specified.");
562                 return 0;
563         }
564         if (ast_strlen_zero(key)) {
565                 astman_send_error(s, m, "No key specified.");
566                 return 0;
567         }
568
569         if (!ast_strlen_zero(id))
570                 snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
571
572         res = ast_db_get(family, key, tmp, sizeof(tmp));
573         if (res) {
574                 astman_send_error(s, m, "Database entry not found");
575         } else {
576                 astman_send_ack(s, m, "Result will follow");
577                 astman_append(s, "Event: DBGetResponse\r\n"
578                                 "Family: %s\r\n"
579                                 "Key: %s\r\n"
580                                 "Val: %s\r\n"
581                                 "%s"
582                                 "\r\n",
583                                 family, key, tmp, idText);
584         }
585         return 0;
586 }
587
588 static int manager_dbdel(struct mansession *s, const struct message *m)
589 {
590         const char *family = astman_get_header(m, "Family");
591         const char *key = astman_get_header(m, "Key");
592         int res;
593
594         if (ast_strlen_zero(family)) {
595                 astman_send_error(s, m, "No family specified.");
596                 return 0;
597         }
598
599         if (ast_strlen_zero(key)) {
600                 astman_send_error(s, m, "No key specified.");
601                 return 0;
602         }
603
604         res = ast_db_del(family, key);
605         if (res)
606                 astman_send_error(s, m, "Database entry not found");
607         else
608                 astman_send_ack(s, m, "Key deleted successfully");
609
610         return 0;
611 }
612
613 static int manager_dbdeltree(struct mansession *s, const struct message *m)
614 {
615         const char *family = astman_get_header(m, "Family");
616         const char *key = astman_get_header(m, "Key");
617         int res;
618
619         if (ast_strlen_zero(family)) {
620                 astman_send_error(s, m, "No family specified.");
621                 return 0;
622         }
623
624         if (!ast_strlen_zero(key))
625                 res = ast_db_deltree(family, key);
626         else
627                 res = ast_db_deltree(family, NULL);
628
629         if (res)
630                 astman_send_error(s, m, "Database entry not found");
631         else
632                 astman_send_ack(s, m, "Key tree deleted successfully");
633         
634         return 0;
635 }
636
637 int astdb_init(void)
638 {
639         dbinit();
640         ast_cli_register_multiple(cli_database, sizeof(cli_database) / sizeof(struct ast_cli_entry));
641         ast_manager_register("DBGet", EVENT_FLAG_SYSTEM, manager_dbget, "Get DB Entry");
642         ast_manager_register("DBPut", EVENT_FLAG_SYSTEM, manager_dbput, "Put DB Entry");
643         ast_manager_register("DBDel", EVENT_FLAG_SYSTEM, manager_dbdel, "Delete DB Entry");
644         ast_manager_register("DBDelTree", EVENT_FLAG_SYSTEM, manager_dbdeltree, "Delete DB Tree");
645         return 0;
646 }