4286272fcce0e37a3be02db479fd164deed6c574
[asterisk/asterisk.git] / include / asterisk / res_odbc.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  * Copyright (C) 2004 - 2005, Anthony Minessale II
6  * Copyright (C) 2006, Tilghman Lesher
7  *
8  * Mark Spencer <markster@digium.com>
9  * Anthony Minessale <anthmct@yahoo.com>
10  * Tilghman Lesher <res_odbc_200603@the-tilghman.com>
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  * This program is free software, distributed under the terms of
19  * the GNU General Public License Version 2. See the LICENSE file
20  * at the top of the source tree.
21  */
22
23 /*! \file
24  * \brief ODBC resource manager
25  */
26
27 #ifndef _ASTERISK_RES_ODBC_H
28 #define _ASTERISK_RES_ODBC_H
29
30 #include <sql.h>
31 #include <sqlext.h>
32 #include <sqltypes.h>
33 #include "asterisk/linkedlists.h"
34 #include "asterisk/strings.h"
35
36 typedef enum { ODBC_SUCCESS=0, ODBC_FAIL=-1} odbc_status;
37
38 /*! \brief Flags for use with \see ast_odbc_request_obj2 */
39 enum {
40         RES_ODBC_SANITY_CHECK = (1 << 0),
41         RES_ODBC_INDEPENDENT_CONNECTION = (1 << 1),
42         RES_ODBC_CONNECTED = (1 << 2),
43 };
44
45 /*! \brief ODBC container */
46 struct odbc_obj {
47         SQLHDBC  con;                   /*!< ODBC Connection Handle */
48         struct odbc_class *parent;      /*!< Information about the connection is protected */
49 #ifdef DEBUG_THREADS
50         char file[80];
51         char function[80];
52         int lineno;
53 #endif
54         AST_LIST_ENTRY(odbc_obj) list;
55 };
56
57 /*!\brief These structures are used for adaptive capabilities */
58 struct odbc_cache_columns {
59         char *name;
60         SQLSMALLINT type;
61         SQLINTEGER size;
62         SQLSMALLINT decimals;
63         SQLSMALLINT radix;
64         SQLSMALLINT nullable;
65         SQLINTEGER octetlen;
66         AST_RWLIST_ENTRY(odbc_cache_columns) list;
67 };
68
69 struct odbc_cache_tables {
70         char *connection;
71         char *table;
72         AST_RWLIST_HEAD(_columns, odbc_cache_columns) columns;
73         AST_RWLIST_ENTRY(odbc_cache_tables) list;
74 };
75
76 /* functions */
77
78 /*!
79  * \brief Executes a prepared statement handle
80  * \param obj The non-NULL result of odbc_request_obj()
81  * \param stmt The prepared statement handle
82  * \retval 0 on success
83  * \retval -1 on failure
84  *
85  * This function was originally designed simply to execute a prepared
86  * statement handle and to retry if the initial execution failed.
87  * Unfortunately, it did this by disconnecting and reconnecting the database
88  * handle which on most databases causes the statement handle to become
89  * invalid.  Therefore, this method has been deprecated in favor of
90  * odbc_prepare_and_execute() which allows the statement to be prepared
91  * multiple times, if necessary, in case of a loss of connection.
92  *
93  * This function really only ever worked with MySQL, where the statement handle is
94  * not prepared on the server.  If you are not using MySQL, you should avoid it.
95  */
96 int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt) __attribute__((deprecated));
97
98 /*!
99  * \brief Retrieves a connected ODBC object
100  *
101  * \deprecated
102  *
103  * This is only around for backwards-compatibility with older versions of Asterisk.
104  */
105 struct odbc_obj *_ast_odbc_request_obj2(const char *name, struct ast_flags flags, const char *file, const char *function, int lineno);
106
107 /*!
108  * \brief Get a ODBC connection object
109  *
110  * The "check" parameter is leftover from an earlier implementation where database connections
111  * were cached by res_odbc. Since connections are managed by unixODBC now, this parameter is
112  * only kept around for API compatibility.
113  *
114  * \param name The name of the res_odbc.conf section describing the database to connect to
115  * \param check unused
116  * \return A connection to the database. Call ast_odbc_release_obj() when finished.
117  */
118 struct odbc_obj *_ast_odbc_request_obj(const char *name, int check, const char *file, const char *function, int lineno);
119
120 #define ast_odbc_request_obj2(a, b)     _ast_odbc_request_obj2(a, b, __FILE__, __PRETTY_FUNCTION__, __LINE__)
121 #define ast_odbc_request_obj(a, b)      _ast_odbc_request_obj(a, b, __FILE__, __PRETTY_FUNCTION__, __LINE__)
122
123 /*!
124  * \brief Releases an ODBC object previously allocated by ast_odbc_request_obj()
125  * \param obj The ODBC object
126  */
127 void ast_odbc_release_obj(struct odbc_obj *obj);
128
129 /*!
130  * \brief Checks an ODBC object to ensure it is still connected
131  * \param obj The ODBC object
132  * \retval 0 if connected
133  * \retval -1 otherwise.
134  */
135 int ast_odbc_sanity_check(struct odbc_obj *obj);
136
137 /*! \brief Checks if the database natively supports backslash as an escape character.
138  * \param obj The ODBC object
139  * \return Returns 1 if backslash is a native escape character, 0 if an ESCAPE clause is needed to support '\'
140  */
141 int ast_odbc_backslash_is_escape(struct odbc_obj *obj);
142
143 /*! \brief Executes an non prepared statement and returns the resulting
144  * statement handle.
145  * \param obj The ODBC object
146  * \param exec_cb A function callback, which, when called, should return a statement handle with result columns bound.
147  * \param data A parameter to be passed to the exec_cb parameter function, indicating which statement handle is to be prepared.
148  * \retval a statement handle
149  * \retval NULL on error
150  */
151 SQLHSTMT ast_odbc_direct_execute(struct odbc_obj *obj, SQLHSTMT (*exec_cb)(struct odbc_obj *obj, void *data), void *data);
152
153 /*!
154  * \brief Prepares, executes, and returns the resulting statement handle.
155  * \param obj The ODBC object
156  * \param prepare_cb A function callback, which, when called, should return a statement handle prepared, with any necessary parameters or result columns bound.
157  * \param data A parameter to be passed to the prepare_cb parameter function, indicating which statement handle is to be prepared.
158  * \retval a statement handle
159  * \retval NULL on error
160  */
161 SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_cb)(struct odbc_obj *obj, void *data), void *data);
162
163 /*!
164  * \brief Find or create an entry describing the table specified.
165  * \param database Name of an ODBC class on which to query the table
166  * \param tablename Tablename to describe
167  * \retval A structure describing the table layout, or NULL, if the table is not found or another error occurs.
168  * When a structure is returned, the contained columns list will be
169  * rdlock'ed, to ensure that it will be retained in memory.  The information
170  * will be cached until a reload event or when ast_odbc_clear_cache() is called
171  * with the relevant parameters.
172  * \since 1.6.1
173  */
174 struct odbc_cache_tables *ast_odbc_find_table(const char *database, const char *tablename);
175
176 /*!
177  * \brief Find a column entry within a cached table structure
178  * \param table Cached table structure, as returned from ast_odbc_find_table()
179  * \param colname The column name requested
180  * \retval A structure describing the column type, or NULL, if the column is not found.
181  * \since 1.6.1
182  */
183 struct odbc_cache_columns *ast_odbc_find_column(struct odbc_cache_tables *table, const char *colname);
184
185 /*!
186  * \brief Remove a cache entry from memory
187  * This function may be called to clear entries created and cached by the
188  * ast_odbc_find_table() API call.
189  * \param database Name of an ODBC class (used to ensure like-named tables in different databases are not confused)
190  * \param tablename Tablename for which a cached record should be removed
191  * \retval 0 if the cache entry was removed, or -1 if no matching entry was found.
192  * \since 1.6.1
193  */
194 int ast_odbc_clear_cache(const char *database, const char *tablename);
195
196 /*!
197  * \brief Release a table returned from ast_odbc_find_table
198  */
199 #define ast_odbc_release_table(ptr) if (ptr) { AST_RWLIST_UNLOCK(&(ptr)->columns); }
200
201 /*!\brief Wrapper for SQLGetData to use with dynamic strings
202  * \param buf Address of the pointer to the ast_str structure.
203  * \param pmaxlen The maximum size of the resulting string, or 0 for no limit.
204  * \param StatementHandle The statement handle from which to retrieve data.
205  * \param ColumnNumber Column number (1-based offset) for which to retrieve data.
206  * \param TargetType The SQL constant indicating what kind of data is to be retrieved (usually SQL_CHAR)
207  * \param StrLen_or_Ind A pointer to a length indicator, specifying the total length of data.
208  */
209 SQLRETURN ast_odbc_ast_str_SQLGetData(struct ast_str **buf, int pmaxlen, SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLSMALLINT TargetType, SQLLEN *StrLen_or_Ind);
210
211 /*!
212  * \brief Shortcut for printing errors to logs after a failed SQL operation.
213  *
214  * \param handle_type The type of SQL handle on which to gather diagnostics
215  * \param handle The SQL handle to gather diagnostics from
216  * \param operation The name of the failed operation.
217  * \return The error string that was printed to the logs
218  */
219 struct ast_str *ast_odbc_print_errors(SQLSMALLINT handle_type, SQLHANDLE handle, const char *operation);
220
221 /*!
222  * \brief Get the transaction isolation setting for an ODBC class
223  */
224 unsigned int ast_odbc_class_get_isolation(struct odbc_class *class);
225
226 /*!
227  * \brief Get the transaction forcecommit setting for an ODBC class
228  */
229 unsigned int ast_odbc_class_get_forcecommit(struct odbc_class *class);
230
231 /*!
232  * \brief Get the name of an ODBC class.
233  */
234 const char *ast_odbc_class_get_name(struct odbc_class *class);
235
236 /*!
237  * \brief Convert from textual transaction isolation values to their numeric constants
238  */
239 int ast_odbc_text2isolation(const char *txt);
240
241 /*!
242  * \brief Convert from numeric transaction isolation values to their textual counterparts
243  */
244 const char *ast_odbc_isolation2text(int iso);
245
246 /*!
247  * \brief Return the current configured maximum number of connections for a class
248  */
249 unsigned int ast_odbc_get_max_connections(const char *name);
250
251 #endif /* _ASTERISK_RES_ODBC_H */