db_postgres: fix doxygen errors, small extensions and cleanups in comments
[sip-router] / modules / db_postgres / km_pg_con.c
1 /* 
2  * Copyright (C) 2001-2004 iptel.org
3  * Copyright (C) 2008 1&1 Internet AG
4  *
5  * This file is part of Kamailio, a free SIP server.
6  *
7  * Kamailio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version
11  *
12  * Kamailio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License 
18  * along with this program; if not, write to the Free Software 
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 /*! \file
23  *  \brief DB_POSTGRES :: Core
24  *  \ingroup db_postgres
25  *  Module: \ref db_postgres
26  */
27
28 #include "km_pg_con.h"
29 #include "../../mem/mem.h"
30 #include "../../dprint.h"
31 #include "../../ut.h"
32 #include <string.h>
33 #include <time.h>
34
35
36 /*!
37  * \brief Create a new connection
38  *
39  * Create a new connection structure in private memory, open the PostgreSQL
40  * connection and set reference count to 1
41  * \param id database id
42  * \return postgres connection structure, 0 on error
43  */
44 struct pg_con* db_postgres_new_connection(struct db_id* id)
45 {
46         struct pg_con* ptr;
47         char *ports;
48
49         LM_DBG("db_id = %p\n", id);
50  
51         if (!id) {
52                 LM_ERR("invalid db_id parameter value\n");
53                 return 0;
54         }
55
56         ptr = (struct pg_con*)pkg_malloc(sizeof(struct pg_con));
57         if (!ptr) {
58                 LM_ERR("failed trying to allocated %lu bytes for connection structure."
59                                 "\n", (unsigned long)sizeof(struct pg_con));
60                 return 0;
61         }
62         LM_DBG("%p=pkg_malloc(%lu)\n", ptr, (unsigned long)sizeof(struct pg_con));
63
64         memset(ptr, 0, sizeof(struct pg_con));
65         ptr->ref = 1;
66
67         if (id->port) {
68                 ports = int2str(id->port, 0);
69                 LM_DBG("opening connection: postgres://xxxx:xxxx@%s:%d/%s\n", ZSW(id->host),
70                         id->port, ZSW(id->database));
71         } else {
72                 ports = NULL;
73                 LM_DBG("opening connection: postgres://xxxx:xxxx@%s/%s\n", ZSW(id->host),
74                         ZSW(id->database));
75         }
76
77         ptr->con = PQsetdbLogin(id->host, ports, NULL, NULL, id->database, id->username, id->password);
78         LM_DBG("PQsetdbLogin(%p)\n", ptr->con);
79
80         if( (ptr->con == 0) || (PQstatus(ptr->con) != CONNECTION_OK) )
81         {
82                 LM_ERR("%s\n", PQerrorMessage(ptr->con));
83                 PQfinish(ptr->con);
84                 goto err;
85         }
86
87         ptr->connected = 1;
88         ptr->timestamp = time(0);
89         ptr->id = id;
90
91         return ptr;
92
93  err:
94         if (ptr) {
95                 LM_ERR("cleaning up %p=pkg_free()\n", ptr);
96                 pkg_free(ptr);
97         }
98         return 0;
99 }
100
101
102 /*!
103  * \brief Close the connection and release memory
104  * \param con connection
105  */
106 void db_postgres_free_connection(struct pool_con* con)
107 {
108
109         struct pg_con * _c;
110         
111         if (!con) return;
112
113         _c = (struct pg_con*)con;
114
115         if (_c->res) {
116                 LM_DBG("PQclear(%p)\n", _c->res);
117                 PQclear(_c->res);
118                 _c->res = 0;
119         }
120         if (_c->id) free_db_id(_c->id);
121         if (_c->con) {
122                 LM_DBG("PQfinish(%p)\n", _c->con);
123                 PQfinish(_c->con);
124                 _c->con = 0;
125         }
126         LM_DBG("pkg_free(%p)\n", _c);
127         pkg_free(_c);
128 }