all: updated FSF address in GPL text
[sip-router] / modules / cpl-c / cpl_db.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * This file is part of Kamailio, a free SIP server.
7  *
8  * Kamailio is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * Kamailio is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef _CPL_DB_H
24 #define _CPL_DB_H
25
26 #include "../../lib/srdb1/db.h"
27
28
29 int cpl_db_bind(const str* db_url, const str* db_table);
30 int cpl_db_init(const str* db_url, const str* db_table);
31 void cpl_db_close(void);
32
33 extern str cpl_username_col;
34 extern str cpl_domain_col;
35 extern str cpl_xml_col;
36 extern str cpl_bin_col;
37
38 /* inserts into database a cpl script in XML format(xml) along with its binary
39  * format (bin)
40  * Returns:  1 - success
41  *          -1 - error
42  */
43 int write_to_db(str *username, str*domain, str *xml, str *bin);
44
45
46 /* fetch from database the binary format of the cpl script for a given user
47  * Returns:  1 - success
48  *          -1 - error
49  */
50 int get_user_script(str *username, str*domain, str *script, str *key);
51
52
53 /* delete from database the entire record for a given user - if a user has no
54  * script, he will be removed completely from db; users without script are not
55  * allowed into db ;-)
56  * Returns:  1 - success
57  *          -1 - error
58  */
59 int rmv_from_db(str *username, str *domain);
60
61
62 #endif