292e7af86c2e7cd9aa9547d6583b19e4c61c8366
[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         int counter = 0;
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                         counter++;
348                 }
349         }
350         ast_mutex_unlock(&dblock);
351         ast_cli(fd, "%d results found.\n", counter);
352         return RESULT_SUCCESS;  
353 }
354
355 static int database_showkey(int fd, int argc, char *argv[])
356 {
357         char suffix[256];
358         DBT key, data;
359         char *keys, *values;
360         int res;
361         int pass;
362         int counter = 0;
363
364         if (argc == 3) {
365                 /* Key only */
366                 snprintf(suffix, sizeof(suffix), "/%s", argv[2]);
367         } else {
368                 return RESULT_SHOWUSAGE;
369         }
370         ast_mutex_lock(&dblock);
371         if (dbinit()) {
372                 ast_mutex_unlock(&dblock);
373                 ast_cli(fd, "Database unavailable\n");
374                 return RESULT_SUCCESS;  
375         }
376         memset(&key, 0, sizeof(key));
377         memset(&data, 0, sizeof(data));
378         pass = 0;
379         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
380                 if (key.size) {
381                         keys = key.data;
382                         keys[key.size - 1] = '\0';
383                 } else {
384                         keys = "<bad key>";
385                 }
386                 if (data.size) {
387                         values = data.data;
388                         values[data.size - 1]='\0';
389                 } else {
390                         values = "<bad value>";
391                 }
392                 if (subkeymatch(keys, suffix)) {
393                         ast_cli(fd, "%-50s: %-25s\n", keys, values);
394                         counter++;
395                 }
396         }
397         ast_mutex_unlock(&dblock);
398         ast_cli(fd, "%d results found.\n", counter);
399         return RESULT_SUCCESS;  
400 }
401
402 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree)
403 {
404         char prefix[256];
405         DBT key, data;
406         char *keys, *values;
407         int values_len;
408         int res;
409         int pass;
410         struct ast_db_entry *last = NULL;
411         struct ast_db_entry *cur, *ret=NULL;
412
413         if (!ast_strlen_zero(family)) {
414                 if (!ast_strlen_zero(keytree)) {
415                         /* Family and key tree */
416                         snprintf(prefix, sizeof(prefix), "/%s/%s", family, prefix);
417                 } else {
418                         /* Family only */
419                         snprintf(prefix, sizeof(prefix), "/%s", family);
420                 }
421         } else {
422                 prefix[0] = '\0';
423         }
424         ast_mutex_lock(&dblock);
425         if (dbinit()) {
426                 ast_mutex_unlock(&dblock);
427                 ast_log(LOG_WARNING, "Database unavailable\n");
428                 return NULL;    
429         }
430         memset(&key, 0, sizeof(key));
431         memset(&data, 0, sizeof(data));
432         pass = 0;
433         while (!(res = astdb->seq(astdb, &key, &data, pass++ ? R_NEXT : R_FIRST))) {
434                 if (key.size) {
435                         keys = key.data;
436                         keys[key.size - 1] = '\0';
437                 } else {
438                         keys = "<bad key>";
439                 }
440                 if (data.size) {
441                         values = data.data;
442                         values[data.size - 1] = '\0';
443                 } else {
444                         values = "<bad value>";
445                 }
446                 values_len = strlen(values) + 1;
447                 if (keymatch(keys, prefix) && (cur = ast_malloc(sizeof(*cur) + strlen(keys) + 1 + values_len))) {
448                         cur->next = NULL;
449                         cur->key = cur->data + values_len;
450                         strcpy(cur->data, values);
451                         strcpy(cur->key, keys);
452                         if (last) {
453                                 last->next = cur;
454                         } else {
455                                 ret = cur;
456                         }
457                         last = cur;
458                 }
459         }
460         ast_mutex_unlock(&dblock);
461         return ret;     
462 }
463
464 void ast_db_freetree(struct ast_db_entry *dbe)
465 {
466         struct ast_db_entry *last;
467         while (dbe) {
468                 last = dbe;
469                 dbe = dbe->next;
470                 ast_free(last);
471         }
472 }
473
474 static const char database_show_usage[] =
475 "Usage: database show [family [keytree]]\n"
476 "       Shows Asterisk database contents, optionally restricted\n"
477 "to a given family, or family and keytree.\n";
478
479 static const char database_showkey_usage[] =
480 "Usage: database showkey <keytree>\n"
481 "       Shows Asterisk database contents, restricted to a given key.\n";
482
483 static const char database_put_usage[] =
484 "Usage: database put <family> <key> <value>\n"
485 "       Adds or updates an entry in the Asterisk database for\n"
486 "a given family, key, and value.\n";
487
488 static const char database_get_usage[] =
489 "Usage: database get <family> <key>\n"
490 "       Retrieves an entry in the Asterisk database for a given\n"
491 "family and key.\n";
492
493 static const char database_del_usage[] =
494 "Usage: database del <family> <key>\n"
495 "       Deletes an entry in the Asterisk database for a given\n"
496 "family and key.\n";
497
498 static const char database_deltree_usage[] =
499 "Usage: database deltree <family> [keytree]\n"
500 "       Deletes a family or specific keytree within a family\n"
501 "in the Asterisk database.\n";
502
503 struct ast_cli_entry cli_database[] = {
504         { { "database", "show", NULL },
505         database_show, "Shows database contents",
506         database_show_usage },
507
508         { { "database", "showkey", NULL },
509         database_showkey, "Shows database contents",
510         database_showkey_usage },
511
512         { { "database", "get", NULL },
513         database_get, "Gets database value",
514         database_get_usage },
515
516         { { "database", "put", NULL },
517         database_put, "Adds/updates database value",
518         database_put_usage },
519
520         { { "database", "del", NULL },
521         database_del, "Removes database key/value",
522         database_del_usage },
523
524         { { "database", "deltree", NULL },
525         database_deltree, "Removes database keytree/values",
526         database_deltree_usage },
527 };
528
529 static int manager_dbput(struct mansession *s, const struct message *m)
530 {
531         const char *family = astman_get_header(m, "Family");
532         const char *key = astman_get_header(m, "Key");
533         const char *val = astman_get_header(m, "Val");
534         int res;
535
536         if (ast_strlen_zero(family)) {
537                 astman_send_error(s, m, "No family specified");
538                 return 0;
539         }
540         if (ast_strlen_zero(key)) {
541                 astman_send_error(s, m, "No key specified");
542                 return 0;
543         }
544
545         res = ast_db_put(family, key, S_OR(val, ""));
546         if (res) {
547                 astman_send_error(s, m, "Failed to update entry");
548         } else {
549                 astman_send_ack(s, m, "Updated database successfully");
550         }
551         return 0;
552 }
553
554 static int manager_dbget(struct mansession *s, const struct message *m)
555 {
556         const char *id = astman_get_header(m,"ActionID");
557         char idText[256] = "";
558         const char *family = astman_get_header(m, "Family");
559         const char *key = astman_get_header(m, "Key");
560         char tmp[256];
561         int res;
562
563         if (ast_strlen_zero(family)) {
564                 astman_send_error(s, m, "No family specified.");
565                 return 0;
566         }
567         if (ast_strlen_zero(key)) {
568                 astman_send_error(s, m, "No key specified.");
569                 return 0;
570         }
571
572         if (!ast_strlen_zero(id))
573                 snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
574
575         res = ast_db_get(family, key, tmp, sizeof(tmp));
576         if (res) {
577                 astman_send_error(s, m, "Database entry not found");
578         } else {
579                 astman_send_ack(s, m, "Result will follow");
580                 astman_append(s, "Event: DBGetResponse\r\n"
581                                 "Family: %s\r\n"
582                                 "Key: %s\r\n"
583                                 "Val: %s\r\n"
584                                 "%s"
585                                 "\r\n",
586                                 family, key, tmp, idText);
587         }
588         return 0;
589 }
590
591 static int manager_dbdel(struct mansession *s, const struct message *m)
592 {
593         const char *family = astman_get_header(m, "Family");
594         const char *key = astman_get_header(m, "Key");
595         int res;
596
597         if (ast_strlen_zero(family)) {
598                 astman_send_error(s, m, "No family specified.");
599                 return 0;
600         }
601
602         if (ast_strlen_zero(key)) {
603                 astman_send_error(s, m, "No key specified.");
604                 return 0;
605         }
606
607         res = ast_db_del(family, key);
608         if (res)
609                 astman_send_error(s, m, "Database entry not found");
610         else
611                 astman_send_ack(s, m, "Key deleted successfully");
612
613         return 0;
614 }
615
616 static int manager_dbdeltree(struct mansession *s, const struct message *m)
617 {
618         const char *family = astman_get_header(m, "Family");
619         const char *key = astman_get_header(m, "Key");
620         int res;
621
622         if (ast_strlen_zero(family)) {
623                 astman_send_error(s, m, "No family specified.");
624                 return 0;
625         }
626
627         if (!ast_strlen_zero(key))
628                 res = ast_db_deltree(family, key);
629         else
630                 res = ast_db_deltree(family, NULL);
631
632         if (res)
633                 astman_send_error(s, m, "Database entry not found");
634         else
635                 astman_send_ack(s, m, "Key tree deleted successfully");
636         
637         return 0;
638 }
639
640 int astdb_init(void)
641 {
642         dbinit();
643         ast_cli_register_multiple(cli_database, sizeof(cli_database) / sizeof(struct ast_cli_entry));
644         ast_manager_register("DBGet", EVENT_FLAG_SYSTEM, manager_dbget, "Get DB Entry");
645         ast_manager_register("DBPut", EVENT_FLAG_SYSTEM, manager_dbput, "Put DB Entry");
646         ast_manager_register("DBDel", EVENT_FLAG_SYSTEM, manager_dbdel, "Delete DB Entry");
647         ast_manager_register("DBDelTree", EVENT_FLAG_SYSTEM, manager_dbdeltree, "Delete DB Tree");
648         return 0;
649 }