Imported Upstream version 2.6.3
[joel/debian/python-pysqlite2.git] / src / module.c
1 /* module.c - the module itself
2  *
3  * Copyright (C) 2004-2010 Gerhard Häring <gh@ghaering.de>
4  *
5  * This file is part of pysqlite.
6  *
7  * This software is provided 'as-is', without any express or implied
8  * warranty.  In no event will the authors be held liable for any damages
9  * arising from the use of this software.
10  *
11  * Permission is granted to anyone to use this software for any purpose,
12  * including commercial applications, and to alter it and redistribute it
13  * freely, subject to the following restrictions:
14  *
15  * 1. The origin of this software must not be misrepresented; you must not
16  *    claim that you wrote the original software. If you use this software
17  *    in a product, an acknowledgment in the product documentation would be
18  *    appreciated but is not required.
19  * 2. Altered source versions must be plainly marked as such, and must not be
20  *    misrepresented as being the original software.
21  * 3. This notice may not be removed or altered from any source distribution.
22  */
23
24 #include "connection.h"
25 #include "statement.h"
26 #include "cursor.h"
27 #include "cache.h"
28 #include "prepare_protocol.h"
29 #include "microprotocols.h"
30 #include "row.h"
31
32 #ifdef PYSQLITE_EXPERIMENTAL
33 #include "backup.h"
34 #endif
35
36 #if SQLITE_VERSION_NUMBER >= 3003003
37 #define HAVE_SHARED_CACHE
38 #endif
39
40 /* static objects at module-level */
41
42 PyObject* pysqlite_Error, *pysqlite_Warning, *pysqlite_InterfaceError, *pysqlite_DatabaseError,
43     *pysqlite_InternalError, *pysqlite_OperationalError, *pysqlite_ProgrammingError,
44     *pysqlite_IntegrityError, *pysqlite_DataError, *pysqlite_NotSupportedError, *pysqlite_OptimizedUnicode;
45
46 PyObject* converters;
47 int _enable_callback_tracebacks;
48 int pysqlite_BaseTypeAdapted;
49
50 static PyObject* module_connect(PyObject* self, PyObject* args, PyObject*
51         kwargs)
52 {
53     /* Python seems to have no way of extracting a single keyword-arg at
54      * C-level, so this code is redundant with the one in connection_init in
55      * connection.c and must always be copied from there ... */
56
57     static char *kwlist[] = {"database", "timeout", "detect_types", "isolation_level", "check_same_thread", "factory", "cached_statements", NULL, NULL};
58     PyObject* database;
59     int detect_types = 0;
60     PyObject* isolation_level;
61     PyObject* factory = NULL;
62     int check_same_thread = 1;
63     int cached_statements;
64     double timeout = 5.0;
65
66     PyObject* result;
67
68     if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|diOiOi", kwlist,
69                                      &database, &timeout, &detect_types, &isolation_level, &check_same_thread, &factory, &cached_statements))
70     {
71         return NULL; 
72     }
73
74     if (factory == NULL) {
75         factory = (PyObject*)&pysqlite_ConnectionType;
76     }
77
78     result = PyObject_Call(factory, args, kwargs);
79
80     return result;
81 }
82
83 PyDoc_STRVAR(module_connect_doc,
84 "connect(database[, timeout, isolation_level, detect_types, factory])\n\
85 \n\
86 Opens a connection to the SQLite database file *database*. You can use\n\
87 \":memory:\" to open a database connection to a database that resides in\n\
88 RAM instead of on disk.");
89
90 static PyObject* module_complete(PyObject* self, PyObject* args, PyObject*
91         kwargs)
92 {
93     static char *kwlist[] = {"statement", NULL, NULL};
94     char* statement;
95
96     PyObject* result;
97
98     if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s", kwlist, &statement))
99     {
100         return NULL; 
101     }
102
103     if (sqlite3_complete(statement)) {
104         result = Py_True;
105     } else {
106         result = Py_False;
107     }
108
109     Py_INCREF(result);
110
111     return result;
112 }
113
114 PyDoc_STRVAR(module_complete_doc,
115 "complete_statement(sql)\n\
116 \n\
117 Checks if a string contains a complete SQL statement. Non-standard.");
118
119 #ifdef HAVE_SHARED_CACHE
120 static PyObject* module_enable_shared_cache(PyObject* self, PyObject* args, PyObject*
121         kwargs)
122 {
123     static char *kwlist[] = {"do_enable", NULL, NULL};
124     int do_enable;
125     int rc;
126
127     if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", kwlist, &do_enable))
128     {
129         return NULL; 
130     }
131
132     rc = sqlite3_enable_shared_cache(do_enable);
133
134     if (rc != SQLITE_OK) {
135         PyErr_SetString(pysqlite_OperationalError, "Changing the shared_cache flag failed");
136         return NULL;
137     } else {
138         Py_INCREF(Py_None);
139         return Py_None;
140     }
141 }
142
143 PyDoc_STRVAR(module_enable_shared_cache_doc,
144 "enable_shared_cache(do_enable)\n\
145 \n\
146 Enable or disable shared cache mode for the calling thread.\n\
147 Experimental/Non-standard.");
148 #endif /* HAVE_SHARED_CACHE */
149
150 static PyObject* module_register_adapter(PyObject* self, PyObject* args)
151 {
152     PyTypeObject* type;
153     PyObject* caster;
154     int rc;
155
156     if (!PyArg_ParseTuple(args, "OO", &type, &caster)) {
157         return NULL;
158     }
159
160     /* a basic type is adapted; there's a performance optimization if that's not the case
161      * (99 % of all usages) */
162     if (type == &PyInt_Type || type == &PyLong_Type || type == &PyFloat_Type
163             || type == &PyString_Type || type == &PyUnicode_Type || type == &PyBuffer_Type) {
164         pysqlite_BaseTypeAdapted = 1;
165     }
166
167     rc = pysqlite_microprotocols_add(type, (PyObject*)&pysqlite_PrepareProtocolType, caster);
168     if (rc == -1)
169         return NULL;
170
171     Py_INCREF(Py_None);
172     return Py_None;
173 }
174
175 PyDoc_STRVAR(module_register_adapter_doc,
176 "register_adapter(type, callable)\n\
177 \n\
178 Registers an adapter with pysqlite's adapter registry. Non-standard.");
179
180 static PyObject* module_register_converter(PyObject* self, PyObject* args)
181 {
182     PyObject* orig_name;
183     PyObject* name = NULL;
184     PyObject* callable;
185     PyObject* retval = NULL;
186
187     if (!PyArg_ParseTuple(args, "SO", &orig_name, &callable)) {
188         return NULL;
189     }
190
191     /* convert the name to upper case */
192     name = PyObject_CallMethod(orig_name, "upper", "");
193     if (!name) {
194         goto error;
195     }
196
197     if (PyDict_SetItem(converters, name, callable) != 0) {
198         goto error;
199     }
200
201     Py_INCREF(Py_None);
202     retval = Py_None;
203 error:
204     Py_XDECREF(name);
205     return retval;
206 }
207
208 PyDoc_STRVAR(module_register_converter_doc,
209 "register_converter(typename, callable)\n\
210 \n\
211 Registers a converter with pysqlite. Non-standard.");
212
213 static PyObject* enable_callback_tracebacks(PyObject* self, PyObject* args)
214 {
215     if (!PyArg_ParseTuple(args, "i", &_enable_callback_tracebacks)) {
216         return NULL;
217     }
218
219     Py_INCREF(Py_None);
220     return Py_None;
221 }
222
223 PyDoc_STRVAR(enable_callback_tracebacks_doc,
224 "enable_callback_tracebacks(flag)\n\
225 \n\
226 Enable or disable callback functions throwing errors to stderr.");
227
228 static void converters_init(PyObject* dict)
229 {
230     converters = PyDict_New();
231     if (!converters) {
232         return;
233     }
234
235     PyDict_SetItemString(dict, "converters", converters);
236 }
237
238 static PyMethodDef module_methods[] = {
239     {"connect",  (PyCFunction)module_connect,
240      METH_VARARGS | METH_KEYWORDS, module_connect_doc},
241     {"complete_statement",  (PyCFunction)module_complete,
242      METH_VARARGS | METH_KEYWORDS, module_complete_doc},
243 #ifdef HAVE_SHARED_CACHE
244     {"enable_shared_cache",  (PyCFunction)module_enable_shared_cache,
245      METH_VARARGS | METH_KEYWORDS, module_enable_shared_cache_doc},
246 #endif
247     {"register_adapter", (PyCFunction)module_register_adapter,
248      METH_VARARGS, module_register_adapter_doc},
249     {"register_converter", (PyCFunction)module_register_converter,
250      METH_VARARGS, module_register_converter_doc},
251     {"adapt",  (PyCFunction)pysqlite_adapt, METH_VARARGS,
252      pysqlite_adapt_doc},
253     {"enable_callback_tracebacks",  (PyCFunction)enable_callback_tracebacks,
254      METH_VARARGS, enable_callback_tracebacks_doc},
255     {NULL, NULL}
256 };
257
258 struct _IntConstantPair {
259     char* constant_name;
260     int constant_value;
261 };
262
263 typedef struct _IntConstantPair IntConstantPair;
264
265 static IntConstantPair _int_constants[] = {
266     {"PARSE_DECLTYPES", PARSE_DECLTYPES},
267     {"PARSE_COLNAMES", PARSE_COLNAMES},
268
269     {"SQLITE_OK", SQLITE_OK},
270     {"SQLITE_DENY", SQLITE_DENY},
271     {"SQLITE_IGNORE", SQLITE_IGNORE},
272     {"SQLITE_CREATE_INDEX", SQLITE_CREATE_INDEX},
273     {"SQLITE_CREATE_TABLE", SQLITE_CREATE_TABLE},
274     {"SQLITE_CREATE_TEMP_INDEX", SQLITE_CREATE_TEMP_INDEX},
275     {"SQLITE_CREATE_TEMP_TABLE", SQLITE_CREATE_TEMP_TABLE},
276     {"SQLITE_CREATE_TEMP_TRIGGER", SQLITE_CREATE_TEMP_TRIGGER},
277     {"SQLITE_CREATE_TEMP_VIEW", SQLITE_CREATE_TEMP_VIEW},
278     {"SQLITE_CREATE_TRIGGER", SQLITE_CREATE_TRIGGER},
279     {"SQLITE_CREATE_VIEW", SQLITE_CREATE_VIEW},
280     {"SQLITE_DELETE", SQLITE_DELETE},
281     {"SQLITE_DROP_INDEX", SQLITE_DROP_INDEX},
282     {"SQLITE_DROP_TABLE", SQLITE_DROP_TABLE},
283     {"SQLITE_DROP_TEMP_INDEX", SQLITE_DROP_TEMP_INDEX},
284     {"SQLITE_DROP_TEMP_TABLE", SQLITE_DROP_TEMP_TABLE},
285     {"SQLITE_DROP_TEMP_TRIGGER", SQLITE_DROP_TEMP_TRIGGER},
286     {"SQLITE_DROP_TEMP_VIEW", SQLITE_DROP_TEMP_VIEW},
287     {"SQLITE_DROP_TRIGGER", SQLITE_DROP_TRIGGER},
288     {"SQLITE_DROP_VIEW", SQLITE_DROP_VIEW},
289     {"SQLITE_INSERT", SQLITE_INSERT},
290     {"SQLITE_PRAGMA", SQLITE_PRAGMA},
291     {"SQLITE_READ", SQLITE_READ},
292     {"SQLITE_SELECT", SQLITE_SELECT},
293     {"SQLITE_TRANSACTION", SQLITE_TRANSACTION},
294     {"SQLITE_UPDATE", SQLITE_UPDATE},
295     {"SQLITE_ATTACH", SQLITE_ATTACH},
296     {"SQLITE_DETACH", SQLITE_DETACH},
297 #if SQLITE_VERSION_NUMBER >= 3002001
298     {"SQLITE_ALTER_TABLE", SQLITE_ALTER_TABLE},
299     {"SQLITE_REINDEX", SQLITE_REINDEX},
300 #endif
301 #if SQLITE_VERSION_NUMBER >= 3003000
302     {"SQLITE_ANALYZE", SQLITE_ANALYZE},
303 #endif
304     {(char*)NULL, 0}
305 };
306
307 PyMODINIT_FUNC init_sqlite(void)
308 {
309     PyObject *module, *dict;
310     PyObject *tmp_obj;
311     int i;
312
313     module = Py_InitModule("pysqlite2._sqlite", module_methods);
314
315     if (!module ||
316         (pysqlite_row_setup_types() < 0) ||
317         (pysqlite_cursor_setup_types() < 0) ||
318         (pysqlite_connection_setup_types() < 0) ||
319         (pysqlite_cache_setup_types() < 0) ||
320         (pysqlite_statement_setup_types() < 0) ||
321         #ifdef PYSQLITE_EXPERIMENTAL
322         (pysqlite_backup_setup_types() < 0) ||
323         #endif
324         (pysqlite_prepare_protocol_setup_types() < 0)
325        ) {
326         return;
327     }
328
329     Py_INCREF(&pysqlite_ConnectionType);
330     PyModule_AddObject(module, "Connection", (PyObject*) &pysqlite_ConnectionType);
331     Py_INCREF(&pysqlite_CursorType);
332     PyModule_AddObject(module, "Cursor", (PyObject*) &pysqlite_CursorType);
333     Py_INCREF(&pysqlite_CacheType);
334     PyModule_AddObject(module, "Statement", (PyObject*)&pysqlite_StatementType);
335     Py_INCREF(&pysqlite_StatementType);
336     PyModule_AddObject(module, "Cache", (PyObject*) &pysqlite_CacheType);
337     Py_INCREF(&pysqlite_PrepareProtocolType);
338     PyModule_AddObject(module, "PrepareProtocol", (PyObject*) &pysqlite_PrepareProtocolType);
339     Py_INCREF(&pysqlite_RowType);
340     PyModule_AddObject(module, "Row", (PyObject*) &pysqlite_RowType);
341
342     if (!(dict = PyModule_GetDict(module))) {
343         goto error;
344     }
345
346     /*** Create DB-API Exception hierarchy */
347
348     if (!(pysqlite_Error = PyErr_NewException(MODULE_NAME ".Error", PyExc_StandardError, NULL))) {
349         goto error;
350     }
351     PyDict_SetItemString(dict, "Error", pysqlite_Error);
352
353     if (!(pysqlite_Warning = PyErr_NewException(MODULE_NAME ".Warning", PyExc_StandardError, NULL))) {
354         goto error;
355     }
356     PyDict_SetItemString(dict, "Warning", pysqlite_Warning);
357
358     /* Error subclasses */
359
360     if (!(pysqlite_InterfaceError = PyErr_NewException(MODULE_NAME ".InterfaceError", pysqlite_Error, NULL))) {
361         goto error;
362     }
363     PyDict_SetItemString(dict, "InterfaceError", pysqlite_InterfaceError);
364
365     if (!(pysqlite_DatabaseError = PyErr_NewException(MODULE_NAME ".DatabaseError", pysqlite_Error, NULL))) {
366         goto error;
367     }
368     PyDict_SetItemString(dict, "DatabaseError", pysqlite_DatabaseError);
369
370     /* pysqlite_DatabaseError subclasses */
371
372     if (!(pysqlite_InternalError = PyErr_NewException(MODULE_NAME ".InternalError", pysqlite_DatabaseError, NULL))) {
373         goto error;
374     }
375     PyDict_SetItemString(dict, "InternalError", pysqlite_InternalError);
376
377     if (!(pysqlite_OperationalError = PyErr_NewException(MODULE_NAME ".OperationalError", pysqlite_DatabaseError, NULL))) {
378         goto error;
379     }
380     PyDict_SetItemString(dict, "OperationalError", pysqlite_OperationalError);
381
382     if (!(pysqlite_ProgrammingError = PyErr_NewException(MODULE_NAME ".ProgrammingError", pysqlite_DatabaseError, NULL))) {
383         goto error;
384     }
385     PyDict_SetItemString(dict, "ProgrammingError", pysqlite_ProgrammingError);
386
387     if (!(pysqlite_IntegrityError = PyErr_NewException(MODULE_NAME ".IntegrityError", pysqlite_DatabaseError,NULL))) {
388         goto error;
389     }
390     PyDict_SetItemString(dict, "IntegrityError", pysqlite_IntegrityError);
391
392     if (!(pysqlite_DataError = PyErr_NewException(MODULE_NAME ".DataError", pysqlite_DatabaseError, NULL))) {
393         goto error;
394     }
395     PyDict_SetItemString(dict, "DataError", pysqlite_DataError);
396
397     if (!(pysqlite_NotSupportedError = PyErr_NewException(MODULE_NAME ".NotSupportedError", pysqlite_DatabaseError, NULL))) {
398         goto error;
399     }
400     PyDict_SetItemString(dict, "NotSupportedError", pysqlite_NotSupportedError);
401
402     /* We just need "something" unique for pysqlite_OptimizedUnicode. It does not really
403      * need to be a string subclass. Just anything that can act as a special
404      * marker for us. So I pulled PyCell_Type out of my magic hat.
405      */
406     Py_INCREF((PyObject*)&PyCell_Type);
407     pysqlite_OptimizedUnicode = (PyObject*)&PyCell_Type;
408     PyDict_SetItemString(dict, "OptimizedUnicode", pysqlite_OptimizedUnicode);
409
410     /* Set integer constants */
411     for (i = 0; _int_constants[i].constant_name != 0; i++) {
412         tmp_obj = PyInt_FromLong(_int_constants[i].constant_value);
413         if (!tmp_obj) {
414             goto error;
415         }
416         PyDict_SetItemString(dict, _int_constants[i].constant_name, tmp_obj);
417         Py_DECREF(tmp_obj);
418     }
419
420     if (!(tmp_obj = PyString_FromString(PYSQLITE_VERSION))) {
421         goto error;
422     }
423     PyDict_SetItemString(dict, "version", tmp_obj);
424     Py_DECREF(tmp_obj);
425
426     if (!(tmp_obj = PyString_FromString(sqlite3_libversion()))) {
427         goto error;
428     }
429     PyDict_SetItemString(dict, "sqlite_version", tmp_obj);
430     Py_DECREF(tmp_obj);
431
432     /* initialize microprotocols layer */
433     pysqlite_microprotocols_init(dict);
434
435     /* initialize the default converters */
436     converters_init(dict);
437
438     _enable_callback_tracebacks = 0;
439
440     pysqlite_BaseTypeAdapted = 0;
441
442     /* Original comment from _bsddb.c in the Python core. This is also still
443      * needed nowadays for Python 2.3/2.4.
444      * 
445      * PyEval_InitThreads is called here due to a quirk in python 1.5
446      * - 2.2.1 (at least) according to Russell Williamson <merel@wt.net>:
447      * The global interpreter lock is not initialized until the first
448      * thread is created using thread.start_new_thread() or fork() is
449      * called.  that would cause the ALLOW_THREADS here to segfault due
450      * to a null pointer reference if no threads or child processes
451      * have been created.  This works around that and is a no-op if
452      * threads have already been initialized.
453      *  (see pybsddb-users mailing list post on 2002-08-07)
454      */
455 #ifdef WITH_THREAD
456     PyEval_InitThreads();
457 #endif
458
459 error:
460     if (PyErr_Occurred())
461     {
462         PyErr_SetString(PyExc_ImportError, "pysqlite2._sqlite: init failed");
463     }
464 }