Annotation of sql/sqlite/parser3sqlite.C, revision 1.17
1.1 misha 1: /** @file
2: Parser SQLite driver.
3:
4: (c) Dmitry "Creator" Bobrik, 2004
5: */
6:
7: #include "config_includes.h"
8:
9: #include "pa_sql_driver.h"
1.16 moko 10:
1.17 ! moko 11: volatile const char * IDENT_PARSER3SQLITE_C="$Id: parser3sqlite.C,v 1.16 2019/11/30 21:51:35 moko Exp $" IDENT_PA_SQL_DRIVER_H;
1.1 misha 12:
13: #define NO_CLIENT_LONG_LONG
14: #include "sqlite3.h"
15: #include "ltdl.h"
16:
17: #define MAX_STRING 0x400
18: #define MAX_NUMBER 20
19:
1.4 misha 20: #define SQLITE_DEFAULT_CHARSET "UTF-8"
21:
1.1 misha 22: #if _MSC_VER
23: # define snprintf _snprintf
24: # define strcasecmp _stricmp
25: #endif
26:
27: static char *lsplit(char *string, char delim) {
1.6 misha 28: if(string) {
1.1 misha 29: char *v=strchr(string, delim);
1.6 misha 30: if(v) {
1.1 misha 31: *v=0;
32: return v+1;
33: }
1.6 misha 34: }
35: return 0;
1.1 misha 36: }
37:
38: static char *lsplit(char **string_ref, char delim) {
1.6 misha 39: char *result=*string_ref;
1.1 misha 40: char *next=lsplit(*string_ref, delim);
1.6 misha 41: *string_ref=next;
42: return result;
1.1 misha 43: }
44:
45: static void toupper_str(char *out, const char *in, size_t size) {
46: while(size--)
47: *out++=(char)toupper(*in++);
48: }
49:
50: struct Connection {
51: SQL_Driver_services* services;
52:
53: sqlite3* handle;
1.6 misha 54: const char* client_charset;
55: bool multi_statements;
1.1 misha 56: bool autocommit;
1.12 moko 57: int busy_timeout;
1.1 misha 58: };
59:
1.17 ! moko 60: // sqlite client library funcs
1.1 misha 61:
1.17 ! moko 62: typedef int (*t_sqlite3_open)(const char *filename, sqlite3 **ppDb); t_sqlite3_open pa_sqlite3_open;
! 63:
! 64: typedef int (*t_sqlite3_close)(sqlite3 *); t_sqlite3_close pa_sqlite3_close;
! 65:
! 66: typedef int (*t_sqlite3_busy_timeout)(sqlite3*, int ms); t_sqlite3_busy_timeout pa_sqlite3_busy_timeout;
! 67:
! 68: typedef int (*t_sqlite3_exec)(sqlite3*, const char *sql, sqlite3_callback, void *, char **errmsg); t_sqlite3_exec pa_sqlite3_exec;
! 69:
! 70: typedef void (*t_sqlite3_free)(char *z); t_sqlite3_free pa_sqlite3_free;
! 71:
! 72: typedef const char *(* t_sqlite3_errmsg)(sqlite3*); t_sqlite3_errmsg pa_sqlite3_errmsg;
! 73:
! 74: typedef int (* t_sqlite3_prepare)(sqlite3 *db, const char *zSql, int nBytes, sqlite3_stmt **ppStmt, const char **pzTail); t_sqlite3_prepare pa_sqlite3_prepare;
! 75:
! 76: typedef int (* t_sqlite3_column_count)(sqlite3_stmt *pStmt); t_sqlite3_column_count pa_sqlite3_column_count;
! 77:
! 78: typedef int (* t_sqlite3_finalize)(sqlite3_stmt *pStmt); t_sqlite3_finalize pa_sqlite3_finalize;
! 79:
! 80: typedef const char *(* t_sqlite3_column_name)(sqlite3_stmt*,int); t_sqlite3_column_name pa_sqlite3_column_name;
! 81:
! 82: typedef int (* t_sqlite3_step)(sqlite3_stmt*); t_sqlite3_step pa_sqlite3_step;
! 83:
! 84: typedef int (* t_sqlite3_column_type)(sqlite3_stmt*, int iCol); t_sqlite3_column_type pa_sqlite3_column_type;
! 85:
! 86: typedef const unsigned char *(* t_sqlite3_column_text)(sqlite3_stmt*, int iCol); t_sqlite3_column_text pa_sqlite3_column_text;
! 87:
! 88: typedef const unsigned char *(* t_sqlite3_column_blob)(sqlite3_stmt*, int iCol); t_sqlite3_column_blob pa_sqlite3_column_blob;
! 89:
! 90: typedef int (* t_sqlite3_column_bytes)(sqlite3_stmt*, int iCol); t_sqlite3_column_bytes pa_sqlite3_column_bytes;
1.1 misha 91:
92: /**
93: SQLite server driver
94: */
95: class SQLite_Driver : public SQL_Driver {
96: public:
97:
98: SQLite_Driver() : SQL_Driver() {
99: }
100:
101: /// get api version
102: int api_version() { return SQL_DRIVER_API_VERSION; }
1.4 misha 103:
1.1 misha 104: /// initialize driver by loading sql dynamic link library
105: const char *initialize(char *dlopen_file_spec) {
106: return dlopen_file_spec?
107: dlink(dlopen_file_spec):"client library column is empty";
108: }
1.4 misha 109:
1.1 misha 110: /** connect
111: @param url
1.8 misha 112: format: @b db-file|:memory:|temporary:?
113: autocommit=1& // =0 disable autocommit. in this case 1 connect == 1 transaction.
114: // or you can use begin/commit|rollback explicitly
115: multi_statements=0& // =1 allow many statements in 1 query
116: ClientCharset=UTF-8 // will transcode to/from specified charset instead of UTF-8 (default for sqlite)
1.1 misha 117: */
118: void connect(
1.6 misha 119: char *url,
120: SQL_Driver_services& services,
121: void **connection_ref ///< output: Connection*
1.4 misha 122: ){
1.1 misha 123:
1.4 misha 124: Connection& connection=*(Connection *)services.malloc(sizeof(Connection));
1.6 misha 125: *connection_ref=&connection;
1.4 misha 126: connection.services=&services;
1.6 misha 127:
1.12 moko 128: connection.client_charset=SQLITE_DEFAULT_CHARSET;
1.6 misha 129: connection.multi_statements=false;
1.4 misha 130: connection.autocommit=true;
1.12 moko 131: connection.busy_timeout=4000;
1.1 misha 132:
1.6 misha 133: char* db_path=0;
134: char* db=url;
135: char* options=lsplit(db, '?');
136:
1.8 misha 137: if(strcmp(db, ":memory:")==0){ // in-memory temporary DB
1.6 misha 138: db_path=db;
1.8 misha 139: } else if(strcmp(db, ":temporary:")==0){ // on-disk temporary DB
1.6 misha 140: // do nothing: empty path mean temporary table on disk
1.8 misha 141: } else {
142: char* document_root=(char*)services.request_document_root();
143: if(!document_root) // path to DB-file which was specified by user is path from document_root as anywhere in parser
144: services._throw("document_root is empty");
145:
146: db_path=(char*)services.malloc_atomic(strlen(document_root)+1+strlen(db)+1);
1.9 misha 147: strcpy(db_path, document_root);
148: strcat(db_path, "/");
149: strcat(db_path, db);
1.5 misha 150: }
1.4 misha 151:
1.6 misha 152: //services._throw(db_path);
153:
154: while(options){
155: if(char* key=lsplit(&options, '&')){
1.4 misha 156: if(*key) {
1.6 misha 157: if(char* value=lsplit(key, '=')){
1.8 misha 158: if(strcasecmp(key, "multi_statements")==0){
1.6 misha 159: if(atoi(value)!=0)
160: connection.multi_statements=true;
1.12 moko 161: } else if(strcasecmp(key, "busy_timeout")==0){
162: connection.busy_timeout=atoi(value);
1.6 misha 163: } else if(strcasecmp(key, "autocommit")==0){
1.4 misha 164: if(atoi(value)==0)
165: connection.autocommit=false;
1.8 misha 166: } else if(strcmp(key, "ClientCharset")==0){
1.6 misha 167: toupper_str(value, value, strlen(value));
168: connection.client_charset=value;
1.4 misha 169: } else
170: services._throw("unknown connect option" /*key*/);
171: } else
172: services._throw("connect option without =value" /*key*/);
173: }
174: }
175: }
176:
177: // transcode database_name from $request:charset to UTF-8
1.6 misha 178: if(db_path && _transcode_required(connection, SQLITE_DEFAULT_CHARSET)){
179: size_t length=strlen(db_path);
180: services.transcode((const char*)db_path, length,
181: (const char*&)db_path, length,
182: services.request_charset(),
183: SQLITE_DEFAULT_CHARSET);
184:
185: }
1.4 misha 186:
1.1 misha 187:
1.17 ! moko 188: int rc=pa_sqlite3_open(db_path, &connection.handle);
1.5 misha 189: if(rc!=SQLITE_OK){
1.17 ! moko 190: const char* error_msg=pa_sqlite3_errmsg(connection.handle);
! 191: pa_sqlite3_close(connection.handle);
1.6 misha 192: _throw(connection, error_msg);
1.1 misha 193: }
1.6 misha 194:
1.17 ! moko 195: pa_sqlite3_busy_timeout(connection.handle, connection.busy_timeout);
1.12 moko 196:
1.6 misha 197: _begin_transaction(connection);
1.1 misha 198: }
199:
1.6 misha 200: void disconnect(void *aconnection){
1.1 misha 201: Connection& connection=*static_cast<Connection*>(aconnection);
1.17 ! moko 202: pa_sqlite3_close(connection.handle);
1.1 misha 203: connection.handle=0;
1.4 misha 204: }
1.1 misha 205:
1.6 misha 206: void commit(void *aconnection){
1.1 misha 207: Connection& connection=*static_cast<Connection*>(aconnection);
208: if(!connection.autocommit)
1.6 misha 209: _execute_cmd(connection, "COMMIT");
210:
211: _begin_transaction(connection);
1.1 misha 212: }
1.4 misha 213:
1.6 misha 214: void rollback(void *aconnection){
1.1 misha 215: Connection& connection=*static_cast<Connection*>(aconnection);
216: if(!connection.autocommit)
1.6 misha 217: _execute_cmd(connection, "ROLLBACK");
218:
219: _begin_transaction(connection);
1.1 misha 220: }
221:
1.6 misha 222: bool ping(void *aconnection){
223: return true; // not needed
1.1 misha 224: }
225:
1.11 moko 226: // charset here is services.request_charset(), not connection.client_charset
227: // thus we can't use the sql server quoting support
228: const char* quote(void *aconnection, const char *str, unsigned int length)
229: {
230: const char* from;
231: const char* from_end=str+length;
232:
233: size_t quoted=0;
234:
235: for(from=str; from<from_end; from++){
236: if(*from=='\'')
237: quoted++;
238: }
239:
240: if(!quoted)
241: return str;
242:
1.1 misha 243: Connection& connection=*static_cast<Connection*>(aconnection);
1.11 moko 244: char *result=(char*)connection.services->malloc_atomic(length + quoted + 1);
245: char *to = result;
246:
247: for(from=str; from<from_end; from++){
248: if(*from=='\'')
249: *to++= '\''; // ' -> ''
250: *to++=*from;
1.1 misha 251: }
1.11 moko 252:
1.1 misha 253: *to=0;
254: return result;
255: }
1.4 misha 256:
1.1 misha 257: void query(void *aconnection,
1.6 misha 258: const char *astatement,
259: size_t placeholders_count, Placeholder* placeholders,
260: unsigned long offset, unsigned long limit,
261: SQL_Driver_query_event_handlers& handlers
262: ){
1.1 misha 263:
264: Connection& connection=*static_cast<Connection*>(aconnection);
265: SQL_Driver_services& services=*connection.services;
266:
267: if(placeholders_count>0)
1.5 misha 268: services._throw("bind variables not supported yet");
1.9 misha 269:
270: const char* request_charset=services.request_charset();
271: const char* client_charset=connection.client_charset;
1.6 misha 272: bool transcode_needed=_transcode_required(connection);
273:
274: // transcode query from $request:charset to ?ClientCharset
275: if(transcode_needed){
276: size_t length=strlen(astatement);
277: services.transcode(astatement, length,
278: astatement, length,
1.9 misha 279: request_charset,
280: client_charset);
1.4 misha 281: }
282:
1.1 misha 283: const char *statement;
1.6 misha 284: if(offset || limit!=SQL_NO_LIMIT){
1.1 misha 285: size_t statement_size=strlen(astatement);
286: char *statement_limited=(char *)services.malloc_atomic(
1.6 misha 287: statement_size+MAX_NUMBER*2+8/* LIMIT #,#*/+1);
1.1 misha 288: char *cur=statement_limited;
1.6 misha 289: memcpy(cur, astatement, statement_size);
290: cur+=statement_size;
291: cur+=sprintf(cur, " LIMIT ");
1.1 misha 292: if(offset)
1.12 moko 293: cur+=snprintf(cur, MAX_NUMBER+1, "%lu,", offset);
1.6 misha 294: if(limit!=SQL_NO_LIMIT)
1.12 moko 295: cur+=snprintf(cur, MAX_NUMBER, "%lu", limit);
1.1 misha 296: statement=statement_limited;
297: } else
298: statement=astatement;
299:
300:
301: const char *pzTail;
1.6 misha 302: int next_statement_length=0;
1.1 misha 303: sqlite3_stmt *SQL;
304: int rc;
305: SQL_Error sql_error;
1.5 misha 306: bool failed=false;
1.1 misha 307:
308: do{ // cycling through SQL commands
1.17 ! moko 309: rc=pa_sqlite3_prepare(connection.handle, statement, -1, &SQL, &pzTail);
1.6 misha 310: next_statement_length=strlen(pzTail);
1.4 misha 311: if(rc!=SQLITE_OK){
1.17 ! moko 312: //pa_sqlite3_free((char*)pzTail);
! 313: _throw(connection, pa_sqlite3_errmsg(connection.handle));
1.6 misha 314: }
315: if(!connection.multi_statements && next_statement_length>0){ // multi statements was not allowed but pzTail point to not empty one
1.17 ! moko 316: //pa_sqlite3_free((char*)pzTail);
1.15 moko 317: _throw(connection, "multi statements are not allowed until option ?multi_statements=1 in connect string is specified.");
1.1 misha 318: }
319:
1.6 misha 320: #define CHECK(afailed) if(afailed){ failed=true; goto cleanup; }
1.1 misha 321:
1.17 ! moko 322: int column_count=pa_sqlite3_column_count(SQL);
1.1 misha 323:
1.6 misha 324: if(!column_count){ // empty result: insert|delete|update|...
1.17 ! moko 325: rc=pa_sqlite3_step(SQL);
1.1 misha 326: } else {
1.6 misha 327: for(int i=0; i<column_count; i++){
1.17 ! moko 328: const char *column_name=pa_sqlite3_column_name(SQL, i);
1.6 misha 329: size_t length=strlen(column_name);
1.1 misha 330:
331: char* strm=(char*)services.malloc_atomic(length+1);
332: memcpy(strm, column_name, length+1);
1.6 misha 333: const char* str=strm;
334: // transcode column name from ?ClientCharset to $request:charset
335: if(transcode_needed){
1.4 misha 336: services.transcode(str, length,
337: str, length,
1.9 misha 338: client_charset,
339: request_charset);
1.4 misha 340: }
341:
1.6 misha 342: CHECK(handlers.add_column(sql_error, (const char*)str, length));
1.1 misha 343: }
344: CHECK(handlers.before_rows(sql_error));
345:
1.5 misha 346: const char *str;
1.6 misha 347: size_t length=0;
1.1 misha 348:
349: do{
1.17 ! moko 350: rc=pa_sqlite3_step(SQL);
1.6 misha 351: if(rc==SQLITE_ROW){ // new line!!
1.1 misha 352:
353: CHECK(handlers.add_row(sql_error));
354:
1.6 misha 355: for(int i=0; i<column_count; i++){
1.17 ! moko 356: // SQLite allow to get value of any type using pa_sqlite3_column_text function
1.14 moko 357: bool transcode_value=false;
1.17 ! moko 358: int column_type=pa_sqlite3_column_type(SQL, i);
1.14 moko 359: switch(column_type){
1.2 misha 360: case SQLITE_NULL:
1.6 misha 361: length=0;
1.4 misha 362: str=NULL;
1.2 misha 363: break;
1.6 misha 364: case SQLITE_BLOB:
1.17 ! moko 365: str=(const char*)pa_sqlite3_column_blob(SQL, i);
! 366: length=(size_t)pa_sqlite3_column_bytes(SQL, i);
1.6 misha 367: break;
1.14 moko 368: case SQLITE_TEXT: // for text transcoding can be required
1.9 misha 369: default: // anything else?
1.14 moko 370: transcode_value=transcode_needed;
371: case SQLITE_INTEGER:
372: case SQLITE_FLOAT:
1.17 ! moko 373: str=(const char*)pa_sqlite3_column_text(SQL, i);
! 374: length=(size_t)pa_sqlite3_column_bytes(SQL, i);
1.1 misha 375: break;
376: }
377:
1.4 misha 378: if(length){
379: char* strm=(char*)services.malloc_atomic(length+1);
1.14 moko 380: memcpy(strm, str, length);
381: strm[length]=0;
1.5 misha 382: str=strm;
1.4 misha 383:
1.14 moko 384: if(transcode_value){
1.9 misha 385: // transcode cell value from ?ClientCharset to $request:charset
1.4 misha 386: services.transcode(str, length,
387: str, length,
1.9 misha 388: client_charset,
389: request_charset);
1.4 misha 390: }
391: } else
1.6 misha 392: str=0;
1.4 misha 393:
394: CHECK(handlers.add_row_cell(sql_error, str, length));
1.1 misha 395:
396: }
397: }
1.6 misha 398: } while(rc==SQLITE_BUSY || rc==SQLITE_ROW);
1.1 misha 399:
1.6 misha 400: }
1.1 misha 401:
1.6 misha 402: if(rc==SQLITE_ERROR || rc==SQLITE_MISUSE){
1.17 ! moko 403: _throw(connection, pa_sqlite3_errmsg(connection.handle));
1.1 misha 404: }
405:
406: cleanup:
1.17 ! moko 407: pa_sqlite3_finalize(SQL);
1.6 misha 408: statement=pzTail;
409: } while (next_statement_length>0);
1.1 misha 410:
411: if(failed)
1.5 misha 412: services._throw(sql_error);
1.1 misha 413: }
414:
1.4 misha 415: private:
1.6 misha 416: void _begin_transaction(Connection& connection) {
417: if(!connection.autocommit){
418: _execute_cmd(connection, "BEGIN");
419: }
420: }
421:
422: void _execute_cmd(Connection& connection, const char* statement){
423: char* zErr;
1.17 ! moko 424: int rc=pa_sqlite3_exec(connection.handle, statement, 0, 0, &zErr);
1.6 misha 425: if(rc!=SQLITE_OK){
426: size_t length=strlen(zErr);
427: char* err_msg=(char *)connection.services->malloc_atomic(length+1);
428: memcpy(err_msg, zErr, length);
429:
1.17 ! moko 430: pa_sqlite3_free(zErr);
1.6 misha 431: _throw(connection, err_msg);
432: }
433:
434: }
435:
436: void _throw(Connection& connection, const char* aerr_msg){
437: size_t length=strlen(aerr_msg);
438: if(length && _transcode_required(connection)){
439: // transcode server error message from ?ClientCharset to $request:charset
440: connection.services->transcode(aerr_msg, length,
441: aerr_msg, length,
442: connection.client_charset,
443: connection.services->request_charset());
444: }
445: connection.services->_throw(aerr_msg);
446: }
447:
448: bool _transcode_required(Connection& connection, const char* charset=0){
449: return (strcmp(charset?charset:connection.client_charset, connection.services->request_charset())!=0);
450: }
451:
1.4 misha 452:
1.1 misha 453: private: // sqlite client library funcs linking
454:
455: const char *dlink(const char *dlopen_file_spec) {
1.13 moko 456: if(lt_dlinit()){
457: if(const char* result=lt_dlerror())
458: return result;
459: return "can not prepare to dynamic loading";
460: }
461:
462: lt_dlhandle handle=lt_dlopen(dlopen_file_spec);
1.1 misha 463:
1.13 moko 464: if(!handle){
465: if(const char* result=lt_dlerror())
466: return result;
1.1 misha 467: return "can not open the dynamic link module";
468: }
469:
470: #define DSLINK(name, action) \
1.17 ! moko 471: pa_##name=(t_##name)lt_dlsym(handle, #name); \
1.1 misha 472: if(!name) \
473: action;
474:
475: #define DLINK(name) DSLINK(name, return "function " #name " was not found")
476: #define SLINK(name) DSLINK(name, name=subst_##name)
477:
478: DLINK(sqlite3_open);
479: DLINK(sqlite3_close);
1.12 moko 480: DLINK(sqlite3_busy_timeout);
1.1 misha 481: DLINK(sqlite3_exec);
482: DLINK(sqlite3_free);
483: DLINK(sqlite3_errmsg);
484: DLINK(sqlite3_prepare);
485: DLINK(sqlite3_column_count);
486: DLINK(sqlite3_finalize);
487: DLINK(sqlite3_column_name);
488: DLINK(sqlite3_step);
489: DLINK(sqlite3_column_type);
490: DLINK(sqlite3_column_text);
1.6 misha 491: DLINK(sqlite3_column_blob);
492: DLINK(sqlite3_column_bytes);
1.1 misha 493: return 0;
494: }
495:
496: };
497:
498: extern "C" SQL_Driver *SQL_DRIVER_CREATE() {
499: return new SQLite_Driver();
500: }
E-mail: