blob: a78d5676c738b3ddc2ba2c7857c181fd70fac8ce [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
drhbd08af42007-04-05 21:58:33 +000012** A TCL Interface to SQLite. Append this file to sqlite3.c and
13** compile the whole thing to build a TCL-enabled version of SQLite.
drh57a02272009-10-22 20:52:05 +000014**
15** Compile-time options:
16**
drh96a206f2017-10-13 20:14:06 +000017** -DTCLSH Add a "main()" routine that works as a tclsh.
drh57a02272009-10-22 20:52:05 +000018**
drh96a206f2017-10-13 20:14:06 +000019** -DTCLSH_INIT_PROC=name
drh57a02272009-10-22 20:52:05 +000020**
drh96a206f2017-10-13 20:14:06 +000021** Invoke name(interp) to initialize the Tcl interpreter.
22** If name(interp) returns a non-NULL string, then run
23** that string as a Tcl script to launch the application.
24** If name(interp) returns NULL, then run the regular
25** tclsh-emulator code.
drh75897232000-05-29 14:26:00 +000026*/
drh96a206f2017-10-13 20:14:06 +000027#ifdef TCLSH_INIT_PROC
28# define TCLSH 1
29#endif
mistachkin27b2f052015-01-12 19:49:46 +000030
31/*
32** If requested, include the SQLite compiler options file for MSVC.
33*/
34#if defined(INCLUDE_MSVC_H)
mistachkin52b1dbb2016-07-28 14:37:04 +000035# include "msvc.h"
mistachkin27b2f052015-01-12 19:49:46 +000036#endif
37
mistachkin52b1dbb2016-07-28 14:37:04 +000038#if defined(INCLUDE_SQLITE_TCL_H)
39# include "sqlite_tcl.h"
40#else
41# include "tcl.h"
mistachkin7617e4a2016-07-28 17:11:20 +000042# ifndef SQLITE_TCLAPI
43# define SQLITE_TCLAPI
44# endif
mistachkin52b1dbb2016-07-28 14:37:04 +000045#endif
danielk1977b4e9af92007-05-01 17:49:49 +000046#include <errno.h>
drhbd08af42007-04-05 21:58:33 +000047
48/*
49** Some additional include files are needed if this file is not
50** appended to the amalgamation.
51*/
52#ifndef SQLITE_AMALGAMATION
drh65e8c822009-12-01 13:57:48 +000053# include "sqlite3.h"
drhbd08af42007-04-05 21:58:33 +000054# include <stdlib.h>
55# include <string.h>
56# include <assert.h>
drh65e8c822009-12-01 13:57:48 +000057 typedef unsigned char u8;
drhbd08af42007-04-05 21:58:33 +000058#endif
drheb206382009-10-24 15:51:33 +000059#include <ctype.h>
drh75897232000-05-29 14:26:00 +000060
mistachkin1f28e072013-08-15 08:06:15 +000061/* Used to get the current process ID */
62#if !defined(_WIN32)
mistachkin1e8487d2018-07-22 06:25:35 +000063# include <signal.h>
mistachkin1f28e072013-08-15 08:06:15 +000064# include <unistd.h>
65# define GETPID getpid
66#elif !defined(_WIN32_WCE)
67# ifndef SQLITE_AMALGAMATION
mistachkin176b3a02018-01-23 07:11:05 +000068# ifndef WIN32_LEAN_AND_MEAN
69# define WIN32_LEAN_AND_MEAN
70# endif
mistachkin1f28e072013-08-15 08:06:15 +000071# include <windows.h>
72# endif
mistachkin1e8487d2018-07-22 06:25:35 +000073# include <io.h>
74# define isatty(h) _isatty(h)
mistachkin1f28e072013-08-15 08:06:15 +000075# define GETPID (int)GetCurrentProcessId
76#endif
77
drhad6e1372006-07-10 21:15:51 +000078/*
79 * Windows needs to know which symbols to export. Unix does not.
80 * BUILD_sqlite should be undefined for Unix.
81 */
82#ifdef BUILD_sqlite
83#undef TCL_STORAGE_CLASS
84#define TCL_STORAGE_CLASS DLLEXPORT
85#endif /* BUILD_sqlite */
drh29bc4612005-10-05 10:40:15 +000086
danielk1977a21c6b62005-01-24 10:25:59 +000087#define NUM_PREPARED_STMTS 10
drhfb7e7652005-01-24 00:28:42 +000088#define MAX_PREPARED_STMTS 100
89
drhc45e6712012-10-03 11:02:33 +000090/* Forward declaration */
91typedef struct SqliteDb SqliteDb;
drh98808ba2001-10-18 12:34:46 +000092
93/*
drhcabb0812002-09-14 13:47:32 +000094** New SQL functions can be created as TCL scripts. Each such function
95** is described by an instance of the following structure.
dan89d24932019-02-27 16:38:19 +000096**
97** Variable eType may be set to SQLITE_INTEGER, SQLITE_FLOAT, SQLITE_TEXT,
98** SQLITE_BLOB or SQLITE_NULL. If it is SQLITE_NULL, then the implementation
99** attempts to determine the type of the result based on the Tcl object.
100** If it is SQLITE_TEXT or SQLITE_BLOB, then a text (sqlite3_result_text())
101** or blob (sqlite3_result_blob()) is returned. If it is SQLITE_INTEGER
102** or SQLITE_FLOAT, then an attempt is made to return an integer or float
103** value, falling back to float and then text if this is not possible.
drhcabb0812002-09-14 13:47:32 +0000104*/
105typedef struct SqlFunc SqlFunc;
106struct SqlFunc {
107 Tcl_Interp *interp; /* The TCL interpret to execute the function */
drhd1e47332005-06-26 17:55:33 +0000108 Tcl_Obj *pScript; /* The Tcl_Obj representation of the script */
drhc45e6712012-10-03 11:02:33 +0000109 SqliteDb *pDb; /* Database connection that owns this function */
drhd1e47332005-06-26 17:55:33 +0000110 int useEvalObjv; /* True if it is safe to use Tcl_EvalObjv */
dan89d24932019-02-27 16:38:19 +0000111 int eType; /* Type of value to return */
drhd1e47332005-06-26 17:55:33 +0000112 char *zName; /* Name of this function */
drhcabb0812002-09-14 13:47:32 +0000113 SqlFunc *pNext; /* Next function on the list of them all */
114};
115
116/*
danielk19770202b292004-06-09 09:55:16 +0000117** New collation sequences function can be created as TCL scripts. Each such
118** function is described by an instance of the following structure.
119*/
120typedef struct SqlCollate SqlCollate;
121struct SqlCollate {
122 Tcl_Interp *interp; /* The TCL interpret to execute the function */
123 char *zScript; /* The script to be run */
drhd1e47332005-06-26 17:55:33 +0000124 SqlCollate *pNext; /* Next function on the list of them all */
danielk19770202b292004-06-09 09:55:16 +0000125};
126
127/*
drhfb7e7652005-01-24 00:28:42 +0000128** Prepared statements are cached for faster execution. Each prepared
129** statement is described by an instance of the following structure.
130*/
131typedef struct SqlPreparedStmt SqlPreparedStmt;
132struct SqlPreparedStmt {
133 SqlPreparedStmt *pNext; /* Next in linked list */
134 SqlPreparedStmt *pPrev; /* Previous on the list */
135 sqlite3_stmt *pStmt; /* The prepared statement */
136 int nSql; /* chars in zSql[] */
danielk1977d0e2a852007-11-14 06:48:48 +0000137 const char *zSql; /* Text of the SQL statement */
dan4a4c11a2009-10-06 14:59:02 +0000138 int nParm; /* Size of apParm array */
139 Tcl_Obj **apParm; /* Array of referenced object pointers */
drhfb7e7652005-01-24 00:28:42 +0000140};
141
danielk1977d04417962007-05-02 13:16:30 +0000142typedef struct IncrblobChannel IncrblobChannel;
143
drhfb7e7652005-01-24 00:28:42 +0000144/*
drhbec3f402000-08-04 13:49:02 +0000145** There is one instance of this structure for each SQLite database
146** that has been opened by the SQLite TCL interface.
danc431fd52011-06-27 16:55:50 +0000147**
148** If this module is built with SQLITE_TEST defined (to create the SQLite
149** testfixture executable), then it may be configured to use either
150** sqlite3_prepare_v2() or sqlite3_prepare() to prepare SQL statements.
151** If SqliteDb.bLegacyPrepare is true, sqlite3_prepare() is used.
drhbec3f402000-08-04 13:49:02 +0000152*/
drhbec3f402000-08-04 13:49:02 +0000153struct SqliteDb {
drhdddca282006-01-03 00:33:50 +0000154 sqlite3 *db; /* The "real" database structure. MUST BE FIRST */
drhd1e47332005-06-26 17:55:33 +0000155 Tcl_Interp *interp; /* The interpreter used for this database */
156 char *zBusy; /* The busy callback routine */
157 char *zCommit; /* The commit hook callback routine */
158 char *zTrace; /* The trace callback routine */
mistachkinb56660f2016-07-14 21:26:09 +0000159 char *zTraceV2; /* The trace_v2 callback routine */
drh19e2d372005-08-29 23:00:03 +0000160 char *zProfile; /* The profile callback routine */
drhd1e47332005-06-26 17:55:33 +0000161 char *zProgress; /* The progress callback routine */
drhc06ede12019-02-28 17:29:19 +0000162 char *zBindFallback; /* Callback to invoke on a binding miss */
drhd1e47332005-06-26 17:55:33 +0000163 char *zAuth; /* The authorization callback routine */
drh1f1549f2008-08-26 21:33:34 +0000164 int disableAuth; /* Disable the authorizer if it exists */
drhd1e47332005-06-26 17:55:33 +0000165 char *zNull; /* Text to substitute for an SQL NULL value */
166 SqlFunc *pFunc; /* List of SQL functions */
danielk197794eb6a12005-12-15 15:22:08 +0000167 Tcl_Obj *pUpdateHook; /* Update hook script (if any) */
dan46c47d42011-03-01 18:42:07 +0000168 Tcl_Obj *pPreUpdateHook; /* Pre-update hook script (if any) */
danielk197771fd80b2005-12-16 06:54:01 +0000169 Tcl_Obj *pRollbackHook; /* Rollback hook script (if any) */
drh5def0842010-05-05 20:00:25 +0000170 Tcl_Obj *pWalHook; /* WAL hook script (if any) */
danielk1977404ca072009-03-16 13:19:36 +0000171 Tcl_Obj *pUnlockNotify; /* Unlock notify script (if any) */
drhd1e47332005-06-26 17:55:33 +0000172 SqlCollate *pCollate; /* List of SQL collation functions */
173 int rc; /* Return code of most recent sqlite3_exec() */
174 Tcl_Obj *pCollateNeeded; /* Collation needed script */
drhfb7e7652005-01-24 00:28:42 +0000175 SqlPreparedStmt *stmtList; /* List of prepared statements*/
176 SqlPreparedStmt *stmtLast; /* Last statement in the list */
177 int maxStmt; /* The next maximum number of stmtList */
178 int nStmt; /* Number of statements in stmtList */
danielk1977d04417962007-05-02 13:16:30 +0000179 IncrblobChannel *pIncrblob;/* Linked list of open incrblob channels */
drh3c379b02010-04-07 19:31:59 +0000180 int nStep, nSort, nIndex; /* Statistics for most recent operation */
danc456a762017-06-22 16:51:16 +0000181 int nVMStep; /* Another statistic for most recent operation */
danielk1977cd38d522009-01-02 17:33:46 +0000182 int nTransaction; /* Number of nested [transaction] methods */
drh147ef392016-01-22 23:17:51 +0000183 int openFlags; /* Flags used to open. (SQLITE_OPEN_URI) */
danc431fd52011-06-27 16:55:50 +0000184#ifdef SQLITE_TEST
185 int bLegacyPrepare; /* True to use sqlite3_prepare() */
186#endif
drh98808ba2001-10-18 12:34:46 +0000187};
drh297ecf12001-04-05 15:57:13 +0000188
danielk1977b4e9af92007-05-01 17:49:49 +0000189struct IncrblobChannel {
danielk1977d04417962007-05-02 13:16:30 +0000190 sqlite3_blob *pBlob; /* sqlite3 blob handle */
danielk1977dcbb5d32007-05-04 18:36:44 +0000191 SqliteDb *pDb; /* Associated database connection */
danielk1977d04417962007-05-02 13:16:30 +0000192 int iSeek; /* Current seek offset */
danielk1977d04417962007-05-02 13:16:30 +0000193 Tcl_Channel channel; /* Channel identifier */
194 IncrblobChannel *pNext; /* Linked list of all open incrblob channels */
195 IncrblobChannel *pPrev; /* Linked list of all open incrblob channels */
danielk1977b4e9af92007-05-01 17:49:49 +0000196};
197
drhea678832008-12-10 19:26:22 +0000198/*
199** Compute a string length that is limited to what can be stored in
200** lower 30 bits of a 32-bit signed integer.
201*/
drh4f21c4a2008-12-10 22:15:00 +0000202static int strlen30(const char *z){
drhea678832008-12-10 19:26:22 +0000203 const char *z2 = z;
204 while( *z2 ){ z2++; }
205 return 0x3fffffff & (int)(z2 - z);
206}
drhea678832008-12-10 19:26:22 +0000207
208
danielk197732a0d8b2007-05-04 19:03:02 +0000209#ifndef SQLITE_OMIT_INCRBLOB
danielk1977b4e9af92007-05-01 17:49:49 +0000210/*
danielk1977d04417962007-05-02 13:16:30 +0000211** Close all incrblob channels opened using database connection pDb.
212** This is called when shutting down the database connection.
213*/
214static void closeIncrblobChannels(SqliteDb *pDb){
215 IncrblobChannel *p;
216 IncrblobChannel *pNext;
217
218 for(p=pDb->pIncrblob; p; p=pNext){
219 pNext = p->pNext;
220
mistachkinb56660f2016-07-14 21:26:09 +0000221 /* Note: Calling unregister here call Tcl_Close on the incrblob channel,
danielk1977d04417962007-05-02 13:16:30 +0000222 ** which deletes the IncrblobChannel structure at *p. So do not
223 ** call Tcl_Free() here.
224 */
225 Tcl_UnregisterChannel(pDb->interp, p->channel);
226 }
227}
228
229/*
danielk1977b4e9af92007-05-01 17:49:49 +0000230** Close an incremental blob channel.
231*/
mistachkin7617e4a2016-07-28 17:11:20 +0000232static int SQLITE_TCLAPI incrblobClose(
233 ClientData instanceData,
234 Tcl_Interp *interp
235){
danielk1977b4e9af92007-05-01 17:49:49 +0000236 IncrblobChannel *p = (IncrblobChannel *)instanceData;
danielk197792d4d7a2007-05-04 12:05:56 +0000237 int rc = sqlite3_blob_close(p->pBlob);
238 sqlite3 *db = p->pDb->db;
danielk1977d04417962007-05-02 13:16:30 +0000239
240 /* Remove the channel from the SqliteDb.pIncrblob list. */
241 if( p->pNext ){
242 p->pNext->pPrev = p->pPrev;
243 }
244 if( p->pPrev ){
245 p->pPrev->pNext = p->pNext;
246 }
247 if( p->pDb->pIncrblob==p ){
248 p->pDb->pIncrblob = p->pNext;
249 }
250
danielk197792d4d7a2007-05-04 12:05:56 +0000251 /* Free the IncrblobChannel structure */
danielk1977b4e9af92007-05-01 17:49:49 +0000252 Tcl_Free((char *)p);
danielk197792d4d7a2007-05-04 12:05:56 +0000253
254 if( rc!=SQLITE_OK ){
255 Tcl_SetResult(interp, (char *)sqlite3_errmsg(db), TCL_VOLATILE);
256 return TCL_ERROR;
257 }
danielk1977b4e9af92007-05-01 17:49:49 +0000258 return TCL_OK;
259}
260
261/*
262** Read data from an incremental blob channel.
263*/
mistachkin7617e4a2016-07-28 17:11:20 +0000264static int SQLITE_TCLAPI incrblobInput(
mistachkinb56660f2016-07-14 21:26:09 +0000265 ClientData instanceData,
266 char *buf,
danielk1977b4e9af92007-05-01 17:49:49 +0000267 int bufSize,
268 int *errorCodePtr
269){
270 IncrblobChannel *p = (IncrblobChannel *)instanceData;
271 int nRead = bufSize; /* Number of bytes to read */
272 int nBlob; /* Total size of the blob */
273 int rc; /* sqlite error code */
274
275 nBlob = sqlite3_blob_bytes(p->pBlob);
276 if( (p->iSeek+nRead)>nBlob ){
277 nRead = nBlob-p->iSeek;
278 }
279 if( nRead<=0 ){
280 return 0;
281 }
282
283 rc = sqlite3_blob_read(p->pBlob, (void *)buf, nRead, p->iSeek);
284 if( rc!=SQLITE_OK ){
285 *errorCodePtr = rc;
286 return -1;
287 }
288
289 p->iSeek += nRead;
290 return nRead;
291}
292
danielk1977d04417962007-05-02 13:16:30 +0000293/*
294** Write data to an incremental blob channel.
295*/
mistachkin7617e4a2016-07-28 17:11:20 +0000296static int SQLITE_TCLAPI incrblobOutput(
mistachkinb56660f2016-07-14 21:26:09 +0000297 ClientData instanceData,
298 CONST char *buf,
danielk1977b4e9af92007-05-01 17:49:49 +0000299 int toWrite,
300 int *errorCodePtr
301){
302 IncrblobChannel *p = (IncrblobChannel *)instanceData;
303 int nWrite = toWrite; /* Number of bytes to write */
304 int nBlob; /* Total size of the blob */
305 int rc; /* sqlite error code */
306
307 nBlob = sqlite3_blob_bytes(p->pBlob);
308 if( (p->iSeek+nWrite)>nBlob ){
309 *errorCodePtr = EINVAL;
310 return -1;
311 }
312 if( nWrite<=0 ){
313 return 0;
314 }
315
316 rc = sqlite3_blob_write(p->pBlob, (void *)buf, nWrite, p->iSeek);
317 if( rc!=SQLITE_OK ){
318 *errorCodePtr = EIO;
319 return -1;
320 }
321
322 p->iSeek += nWrite;
323 return nWrite;
324}
325
326/*
327** Seek an incremental blob channel.
328*/
mistachkin7617e4a2016-07-28 17:11:20 +0000329static int SQLITE_TCLAPI incrblobSeek(
mistachkinb56660f2016-07-14 21:26:09 +0000330 ClientData instanceData,
danielk1977b4e9af92007-05-01 17:49:49 +0000331 long offset,
332 int seekMode,
333 int *errorCodePtr
334){
335 IncrblobChannel *p = (IncrblobChannel *)instanceData;
336
337 switch( seekMode ){
338 case SEEK_SET:
339 p->iSeek = offset;
340 break;
341 case SEEK_CUR:
342 p->iSeek += offset;
343 break;
344 case SEEK_END:
345 p->iSeek = sqlite3_blob_bytes(p->pBlob) + offset;
346 break;
347
348 default: assert(!"Bad seekMode");
349 }
350
351 return p->iSeek;
352}
353
354
mistachkin7617e4a2016-07-28 17:11:20 +0000355static void SQLITE_TCLAPI incrblobWatch(
356 ClientData instanceData,
357 int mode
358){
mistachkinb56660f2016-07-14 21:26:09 +0000359 /* NO-OP */
danielk1977b4e9af92007-05-01 17:49:49 +0000360}
mistachkin7617e4a2016-07-28 17:11:20 +0000361static int SQLITE_TCLAPI incrblobHandle(
362 ClientData instanceData,
363 int dir,
364 ClientData *hPtr
365){
danielk1977b4e9af92007-05-01 17:49:49 +0000366 return TCL_ERROR;
367}
368
369static Tcl_ChannelType IncrblobChannelType = {
370 "incrblob", /* typeName */
371 TCL_CHANNEL_VERSION_2, /* version */
372 incrblobClose, /* closeProc */
373 incrblobInput, /* inputProc */
374 incrblobOutput, /* outputProc */
375 incrblobSeek, /* seekProc */
376 0, /* setOptionProc */
377 0, /* getOptionProc */
378 incrblobWatch, /* watchProc (this is a no-op) */
379 incrblobHandle, /* getHandleProc (always returns error) */
380 0, /* close2Proc */
381 0, /* blockModeProc */
382 0, /* flushProc */
383 0, /* handlerProc */
384 0, /* wideSeekProc */
danielk1977b4e9af92007-05-01 17:49:49 +0000385};
386
387/*
388** Create a new incrblob channel.
389*/
390static int createIncrblobChannel(
mistachkinb56660f2016-07-14 21:26:09 +0000391 Tcl_Interp *interp,
392 SqliteDb *pDb,
danielk1977b4e9af92007-05-01 17:49:49 +0000393 const char *zDb,
mistachkinb56660f2016-07-14 21:26:09 +0000394 const char *zTable,
395 const char *zColumn,
danielk19778cbadb02007-05-03 16:31:26 +0000396 sqlite_int64 iRow,
397 int isReadonly
danielk1977b4e9af92007-05-01 17:49:49 +0000398){
399 IncrblobChannel *p;
danielk19778cbadb02007-05-03 16:31:26 +0000400 sqlite3 *db = pDb->db;
danielk1977b4e9af92007-05-01 17:49:49 +0000401 sqlite3_blob *pBlob;
402 int rc;
danielk19778cbadb02007-05-03 16:31:26 +0000403 int flags = TCL_READABLE|(isReadonly ? 0 : TCL_WRITABLE);
danielk1977b4e9af92007-05-01 17:49:49 +0000404
405 /* This variable is used to name the channels: "incrblob_[incr count]" */
406 static int count = 0;
407 char zChannel[64];
408
danielk19778cbadb02007-05-03 16:31:26 +0000409 rc = sqlite3_blob_open(db, zDb, zTable, zColumn, iRow, !isReadonly, &pBlob);
danielk1977b4e9af92007-05-01 17:49:49 +0000410 if( rc!=SQLITE_OK ){
411 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
412 return TCL_ERROR;
413 }
414
415 p = (IncrblobChannel *)Tcl_Alloc(sizeof(IncrblobChannel));
416 p->iSeek = 0;
417 p->pBlob = pBlob;
418
drh5bb3eb92007-05-04 13:15:55 +0000419 sqlite3_snprintf(sizeof(zChannel), zChannel, "incrblob_%d", ++count);
danielk1977d04417962007-05-02 13:16:30 +0000420 p->channel = Tcl_CreateChannel(&IncrblobChannelType, zChannel, p, flags);
421 Tcl_RegisterChannel(interp, p->channel);
danielk1977b4e9af92007-05-01 17:49:49 +0000422
danielk1977d04417962007-05-02 13:16:30 +0000423 /* Link the new channel into the SqliteDb.pIncrblob list. */
424 p->pNext = pDb->pIncrblob;
425 p->pPrev = 0;
426 if( p->pNext ){
427 p->pNext->pPrev = p;
428 }
429 pDb->pIncrblob = p;
430 p->pDb = pDb;
431
432 Tcl_SetResult(interp, (char *)Tcl_GetChannelName(p->channel), TCL_VOLATILE);
danielk1977b4e9af92007-05-01 17:49:49 +0000433 return TCL_OK;
434}
danielk197732a0d8b2007-05-04 19:03:02 +0000435#else /* else clause for "#ifndef SQLITE_OMIT_INCRBLOB" */
436 #define closeIncrblobChannels(pDb)
437#endif
danielk1977b4e9af92007-05-01 17:49:49 +0000438
drh6d313162000-09-21 13:01:35 +0000439/*
drhd1e47332005-06-26 17:55:33 +0000440** Look at the script prefix in pCmd. We will be executing this script
441** after first appending one or more arguments. This routine analyzes
442** the script to see if it is safe to use Tcl_EvalObjv() on the script
443** rather than the more general Tcl_EvalEx(). Tcl_EvalObjv() is much
444** faster.
445**
446** Scripts that are safe to use with Tcl_EvalObjv() consists of a
447** command name followed by zero or more arguments with no [...] or $
448** or {...} or ; to be seen anywhere. Most callback scripts consist
449** of just a single procedure name and they meet this requirement.
450*/
451static int safeToUseEvalObjv(Tcl_Interp *interp, Tcl_Obj *pCmd){
452 /* We could try to do something with Tcl_Parse(). But we will instead
453 ** just do a search for forbidden characters. If any of the forbidden
454 ** characters appear in pCmd, we will report the string as unsafe.
455 */
456 const char *z;
457 int n;
458 z = Tcl_GetStringFromObj(pCmd, &n);
459 while( n-- > 0 ){
460 int c = *(z++);
461 if( c=='$' || c=='[' || c==';' ) return 0;
462 }
463 return 1;
464}
465
466/*
467** Find an SqlFunc structure with the given name. Or create a new
468** one if an existing one cannot be found. Return a pointer to the
469** structure.
470*/
471static SqlFunc *findSqlFunc(SqliteDb *pDb, const char *zName){
472 SqlFunc *p, *pNew;
drh0425f182013-11-26 16:48:04 +0000473 int nName = strlen30(zName);
474 pNew = (SqlFunc*)Tcl_Alloc( sizeof(*pNew) + nName + 1 );
drhd1e47332005-06-26 17:55:33 +0000475 pNew->zName = (char*)&pNew[1];
drh0425f182013-11-26 16:48:04 +0000476 memcpy(pNew->zName, zName, nName+1);
mistachkinb56660f2016-07-14 21:26:09 +0000477 for(p=pDb->pFunc; p; p=p->pNext){
drh0425f182013-11-26 16:48:04 +0000478 if( sqlite3_stricmp(p->zName, pNew->zName)==0 ){
drhd1e47332005-06-26 17:55:33 +0000479 Tcl_Free((char*)pNew);
480 return p;
481 }
482 }
483 pNew->interp = pDb->interp;
drhc45e6712012-10-03 11:02:33 +0000484 pNew->pDb = pDb;
drhd1e47332005-06-26 17:55:33 +0000485 pNew->pScript = 0;
486 pNew->pNext = pDb->pFunc;
487 pDb->pFunc = pNew;
488 return pNew;
489}
490
491/*
danc431fd52011-06-27 16:55:50 +0000492** Free a single SqlPreparedStmt object.
493*/
494static void dbFreeStmt(SqlPreparedStmt *pStmt){
495#ifdef SQLITE_TEST
496 if( sqlite3_sql(pStmt->pStmt)==0 ){
497 Tcl_Free((char *)pStmt->zSql);
498 }
499#endif
500 sqlite3_finalize(pStmt->pStmt);
501 Tcl_Free((char *)pStmt);
502}
503
504/*
drhfb7e7652005-01-24 00:28:42 +0000505** Finalize and free a list of prepared statements
506*/
danc431fd52011-06-27 16:55:50 +0000507static void flushStmtCache(SqliteDb *pDb){
drhfb7e7652005-01-24 00:28:42 +0000508 SqlPreparedStmt *pPreStmt;
danc431fd52011-06-27 16:55:50 +0000509 SqlPreparedStmt *pNext;
drhfb7e7652005-01-24 00:28:42 +0000510
danc431fd52011-06-27 16:55:50 +0000511 for(pPreStmt = pDb->stmtList; pPreStmt; pPreStmt=pNext){
512 pNext = pPreStmt->pNext;
513 dbFreeStmt(pPreStmt);
drhfb7e7652005-01-24 00:28:42 +0000514 }
515 pDb->nStmt = 0;
516 pDb->stmtLast = 0;
danc431fd52011-06-27 16:55:50 +0000517 pDb->stmtList = 0;
drhfb7e7652005-01-24 00:28:42 +0000518}
519
520/*
drh895d7472004-08-20 16:02:39 +0000521** TCL calls this procedure when an sqlite3 database command is
522** deleted.
drh75897232000-05-29 14:26:00 +0000523*/
mistachkin7617e4a2016-07-28 17:11:20 +0000524static void SQLITE_TCLAPI DbDeleteCmd(void *db){
drhbec3f402000-08-04 13:49:02 +0000525 SqliteDb *pDb = (SqliteDb*)db;
drhfb7e7652005-01-24 00:28:42 +0000526 flushStmtCache(pDb);
danielk1977d04417962007-05-02 13:16:30 +0000527 closeIncrblobChannels(pDb);
danielk19776f8a5032004-05-10 10:34:51 +0000528 sqlite3_close(pDb->db);
drhcabb0812002-09-14 13:47:32 +0000529 while( pDb->pFunc ){
530 SqlFunc *pFunc = pDb->pFunc;
531 pDb->pFunc = pFunc->pNext;
drhc45e6712012-10-03 11:02:33 +0000532 assert( pFunc->pDb==pDb );
drhd1e47332005-06-26 17:55:33 +0000533 Tcl_DecrRefCount(pFunc->pScript);
drhcabb0812002-09-14 13:47:32 +0000534 Tcl_Free((char*)pFunc);
535 }
danielk19770202b292004-06-09 09:55:16 +0000536 while( pDb->pCollate ){
537 SqlCollate *pCollate = pDb->pCollate;
538 pDb->pCollate = pCollate->pNext;
539 Tcl_Free((char*)pCollate);
540 }
drhbec3f402000-08-04 13:49:02 +0000541 if( pDb->zBusy ){
542 Tcl_Free(pDb->zBusy);
543 }
drhb5a20d32003-04-23 12:25:23 +0000544 if( pDb->zTrace ){
545 Tcl_Free(pDb->zTrace);
drh0d1a6432003-04-03 15:46:04 +0000546 }
mistachkinb56660f2016-07-14 21:26:09 +0000547 if( pDb->zTraceV2 ){
548 Tcl_Free(pDb->zTraceV2);
549 }
drh19e2d372005-08-29 23:00:03 +0000550 if( pDb->zProfile ){
551 Tcl_Free(pDb->zProfile);
552 }
drhc06ede12019-02-28 17:29:19 +0000553 if( pDb->zBindFallback ){
554 Tcl_Free(pDb->zBindFallback);
555 }
drhe22a3342003-04-22 20:30:37 +0000556 if( pDb->zAuth ){
557 Tcl_Free(pDb->zAuth);
558 }
danielk197755c45f22005-04-03 23:54:43 +0000559 if( pDb->zNull ){
560 Tcl_Free(pDb->zNull);
561 }
danielk197794eb6a12005-12-15 15:22:08 +0000562 if( pDb->pUpdateHook ){
563 Tcl_DecrRefCount(pDb->pUpdateHook);
564 }
dan46c47d42011-03-01 18:42:07 +0000565 if( pDb->pPreUpdateHook ){
566 Tcl_DecrRefCount(pDb->pPreUpdateHook);
567 }
danielk197771fd80b2005-12-16 06:54:01 +0000568 if( pDb->pRollbackHook ){
569 Tcl_DecrRefCount(pDb->pRollbackHook);
570 }
drh5def0842010-05-05 20:00:25 +0000571 if( pDb->pWalHook ){
572 Tcl_DecrRefCount(pDb->pWalHook);
dan8d22a172010-04-19 18:03:51 +0000573 }
danielk197794eb6a12005-12-15 15:22:08 +0000574 if( pDb->pCollateNeeded ){
575 Tcl_DecrRefCount(pDb->pCollateNeeded);
576 }
drhbec3f402000-08-04 13:49:02 +0000577 Tcl_Free((char*)pDb);
578}
579
580/*
581** This routine is called when a database file is locked while trying
582** to execute SQL.
583*/
danielk19772a764eb2004-06-12 01:43:26 +0000584static int DbBusyHandler(void *cd, int nTries){
drhbec3f402000-08-04 13:49:02 +0000585 SqliteDb *pDb = (SqliteDb*)cd;
586 int rc;
587 char zVal[30];
drhbec3f402000-08-04 13:49:02 +0000588
drh5bb3eb92007-05-04 13:15:55 +0000589 sqlite3_snprintf(sizeof(zVal), zVal, "%d", nTries);
drhd1e47332005-06-26 17:55:33 +0000590 rc = Tcl_VarEval(pDb->interp, pDb->zBusy, " ", zVal, (char*)0);
drhbec3f402000-08-04 13:49:02 +0000591 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
592 return 0;
593 }
594 return 1;
drh75897232000-05-29 14:26:00 +0000595}
596
drh26e4a8b2008-05-01 17:16:52 +0000597#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
drh75897232000-05-29 14:26:00 +0000598/*
danielk1977348bb5d2003-10-18 09:37:26 +0000599** This routine is invoked as the 'progress callback' for the database.
600*/
601static int DbProgressHandler(void *cd){
602 SqliteDb *pDb = (SqliteDb*)cd;
603 int rc;
604
605 assert( pDb->zProgress );
606 rc = Tcl_Eval(pDb->interp, pDb->zProgress);
607 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
608 return 1;
609 }
610 return 0;
611}
drh26e4a8b2008-05-01 17:16:52 +0000612#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000613
drh2eb22af2016-09-10 19:51:40 +0000614#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
615 !defined(SQLITE_OMIT_DEPRECATED)
danielk1977348bb5d2003-10-18 09:37:26 +0000616/*
drhb5a20d32003-04-23 12:25:23 +0000617** This routine is called by the SQLite trace handler whenever a new
618** block of SQL is executed. The TCL script in pDb->zTrace is executed.
drh0d1a6432003-04-03 15:46:04 +0000619*/
drhb5a20d32003-04-23 12:25:23 +0000620static void DbTraceHandler(void *cd, const char *zSql){
drh0d1a6432003-04-03 15:46:04 +0000621 SqliteDb *pDb = (SqliteDb*)cd;
drhb5a20d32003-04-23 12:25:23 +0000622 Tcl_DString str;
drh0d1a6432003-04-03 15:46:04 +0000623
drhb5a20d32003-04-23 12:25:23 +0000624 Tcl_DStringInit(&str);
625 Tcl_DStringAppend(&str, pDb->zTrace, -1);
626 Tcl_DStringAppendElement(&str, zSql);
627 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
628 Tcl_DStringFree(&str);
629 Tcl_ResetResult(pDb->interp);
drh0d1a6432003-04-03 15:46:04 +0000630}
drhd1167392006-01-23 13:00:35 +0000631#endif
drh0d1a6432003-04-03 15:46:04 +0000632
drhd1167392006-01-23 13:00:35 +0000633#ifndef SQLITE_OMIT_TRACE
drh0d1a6432003-04-03 15:46:04 +0000634/*
mistachkinb56660f2016-07-14 21:26:09 +0000635** This routine is called by the SQLite trace_v2 handler whenever a new
636** supported event is generated. Unsupported event types are ignored.
637** The TCL script in pDb->zTraceV2 is executed, with the arguments for
638** the event appended to it (as list elements).
639*/
640static int DbTraceV2Handler(
641 unsigned type, /* One of the SQLITE_TRACE_* event types. */
642 void *cd, /* The original context data pointer. */
643 void *pd, /* Primary event data, depends on event type. */
644 void *xd /* Extra event data, depends on event type. */
645){
646 SqliteDb *pDb = (SqliteDb*)cd;
647 Tcl_Obj *pCmd;
648
649 switch( type ){
650 case SQLITE_TRACE_STMT: {
651 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
652 char *zSql = (char *)xd;
653
654 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
655 Tcl_IncrRefCount(pCmd);
656 Tcl_ListObjAppendElement(pDb->interp, pCmd,
657 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
658 Tcl_ListObjAppendElement(pDb->interp, pCmd,
659 Tcl_NewStringObj(zSql, -1));
660 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
661 Tcl_DecrRefCount(pCmd);
662 Tcl_ResetResult(pDb->interp);
663 break;
664 }
665 case SQLITE_TRACE_PROFILE: {
666 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
drhffdab722018-03-10 20:25:08 +0000667 sqlite3_int64 ns = *(sqlite3_int64*)xd;
mistachkinb56660f2016-07-14 21:26:09 +0000668
669 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
670 Tcl_IncrRefCount(pCmd);
671 Tcl_ListObjAppendElement(pDb->interp, pCmd,
672 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
673 Tcl_ListObjAppendElement(pDb->interp, pCmd,
674 Tcl_NewWideIntObj((Tcl_WideInt)ns));
675 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
676 Tcl_DecrRefCount(pCmd);
677 Tcl_ResetResult(pDb->interp);
678 break;
679 }
680 case SQLITE_TRACE_ROW: {
681 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
682
683 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
684 Tcl_IncrRefCount(pCmd);
685 Tcl_ListObjAppendElement(pDb->interp, pCmd,
686 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
687 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
688 Tcl_DecrRefCount(pCmd);
689 Tcl_ResetResult(pDb->interp);
690 break;
691 }
692 case SQLITE_TRACE_CLOSE: {
693 sqlite3 *db = (sqlite3 *)pd;
694
695 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
696 Tcl_IncrRefCount(pCmd);
697 Tcl_ListObjAppendElement(pDb->interp, pCmd,
698 Tcl_NewWideIntObj((Tcl_WideInt)db));
699 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
700 Tcl_DecrRefCount(pCmd);
701 Tcl_ResetResult(pDb->interp);
702 break;
703 }
704 }
705 return SQLITE_OK;
706}
707#endif
708
drh2eb22af2016-09-10 19:51:40 +0000709#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
710 !defined(SQLITE_OMIT_DEPRECATED)
mistachkinb56660f2016-07-14 21:26:09 +0000711/*
drh19e2d372005-08-29 23:00:03 +0000712** This routine is called by the SQLite profile handler after a statement
713** SQL has executed. The TCL script in pDb->zProfile is evaluated.
714*/
715static void DbProfileHandler(void *cd, const char *zSql, sqlite_uint64 tm){
716 SqliteDb *pDb = (SqliteDb*)cd;
717 Tcl_DString str;
718 char zTm[100];
719
720 sqlite3_snprintf(sizeof(zTm)-1, zTm, "%lld", tm);
721 Tcl_DStringInit(&str);
722 Tcl_DStringAppend(&str, pDb->zProfile, -1);
723 Tcl_DStringAppendElement(&str, zSql);
724 Tcl_DStringAppendElement(&str, zTm);
725 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
726 Tcl_DStringFree(&str);
727 Tcl_ResetResult(pDb->interp);
728}
drhd1167392006-01-23 13:00:35 +0000729#endif
drh19e2d372005-08-29 23:00:03 +0000730
731/*
drhaa940ea2004-01-15 02:44:03 +0000732** This routine is called when a transaction is committed. The
733** TCL script in pDb->zCommit is executed. If it returns non-zero or
734** if it throws an exception, the transaction is rolled back instead
735** of being committed.
736*/
737static int DbCommitHandler(void *cd){
738 SqliteDb *pDb = (SqliteDb*)cd;
739 int rc;
740
741 rc = Tcl_Eval(pDb->interp, pDb->zCommit);
742 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
743 return 1;
744 }
745 return 0;
746}
747
danielk197771fd80b2005-12-16 06:54:01 +0000748static void DbRollbackHandler(void *clientData){
749 SqliteDb *pDb = (SqliteDb*)clientData;
750 assert(pDb->pRollbackHook);
751 if( TCL_OK!=Tcl_EvalObjEx(pDb->interp, pDb->pRollbackHook, 0) ){
752 Tcl_BackgroundError(pDb->interp);
753 }
754}
755
drh5def0842010-05-05 20:00:25 +0000756/*
757** This procedure handles wal_hook callbacks.
758*/
759static int DbWalHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000760 void *clientData,
761 sqlite3 *db,
762 const char *zDb,
dan8d22a172010-04-19 18:03:51 +0000763 int nEntry
764){
drh5def0842010-05-05 20:00:25 +0000765 int ret = SQLITE_OK;
dan8d22a172010-04-19 18:03:51 +0000766 Tcl_Obj *p;
767 SqliteDb *pDb = (SqliteDb*)clientData;
768 Tcl_Interp *interp = pDb->interp;
drh5def0842010-05-05 20:00:25 +0000769 assert(pDb->pWalHook);
dan8d22a172010-04-19 18:03:51 +0000770
dan6e45e0c2014-12-10 20:29:49 +0000771 assert( db==pDb->db );
drh5def0842010-05-05 20:00:25 +0000772 p = Tcl_DuplicateObj(pDb->pWalHook);
dan8d22a172010-04-19 18:03:51 +0000773 Tcl_IncrRefCount(p);
774 Tcl_ListObjAppendElement(interp, p, Tcl_NewStringObj(zDb, -1));
775 Tcl_ListObjAppendElement(interp, p, Tcl_NewIntObj(nEntry));
mistachkinb56660f2016-07-14 21:26:09 +0000776 if( TCL_OK!=Tcl_EvalObjEx(interp, p, 0)
dan8d22a172010-04-19 18:03:51 +0000777 || TCL_OK!=Tcl_GetIntFromObj(interp, Tcl_GetObjResult(interp), &ret)
778 ){
779 Tcl_BackgroundError(interp);
780 }
781 Tcl_DecrRefCount(p);
782
783 return ret;
784}
785
drhbcf4f482009-03-27 12:44:35 +0000786#if defined(SQLITE_TEST) && defined(SQLITE_ENABLE_UNLOCK_NOTIFY)
danielk1977404ca072009-03-16 13:19:36 +0000787static void setTestUnlockNotifyVars(Tcl_Interp *interp, int iArg, int nArg){
788 char zBuf[64];
drh65545b52015-01-19 00:35:53 +0000789 sqlite3_snprintf(sizeof(zBuf), zBuf, "%d", iArg);
danielk1977404ca072009-03-16 13:19:36 +0000790 Tcl_SetVar(interp, "sqlite_unlock_notify_arg", zBuf, TCL_GLOBAL_ONLY);
drh65545b52015-01-19 00:35:53 +0000791 sqlite3_snprintf(sizeof(zBuf), zBuf, "%d", nArg);
danielk1977404ca072009-03-16 13:19:36 +0000792 Tcl_SetVar(interp, "sqlite_unlock_notify_argcount", zBuf, TCL_GLOBAL_ONLY);
793}
794#else
drhbcf4f482009-03-27 12:44:35 +0000795# define setTestUnlockNotifyVars(x,y,z)
danielk1977404ca072009-03-16 13:19:36 +0000796#endif
797
drh69910da2009-03-27 12:32:54 +0000798#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
danielk1977404ca072009-03-16 13:19:36 +0000799static void DbUnlockNotify(void **apArg, int nArg){
800 int i;
801 for(i=0; i<nArg; i++){
802 const int flags = (TCL_EVAL_GLOBAL|TCL_EVAL_DIRECT);
803 SqliteDb *pDb = (SqliteDb *)apArg[i];
804 setTestUnlockNotifyVars(pDb->interp, i, nArg);
805 assert( pDb->pUnlockNotify);
806 Tcl_EvalObjEx(pDb->interp, pDb->pUnlockNotify, flags);
807 Tcl_DecrRefCount(pDb->pUnlockNotify);
808 pDb->pUnlockNotify = 0;
809 }
810}
drh69910da2009-03-27 12:32:54 +0000811#endif
danielk1977404ca072009-03-16 13:19:36 +0000812
drh9b1c62d2011-03-30 21:04:43 +0000813#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +0000814/*
815** Pre-update hook callback.
816*/
817static void DbPreUpdateHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000818 void *p,
dan46c47d42011-03-01 18:42:07 +0000819 sqlite3 *db,
820 int op,
mistachkinb56660f2016-07-14 21:26:09 +0000821 const char *zDb,
822 const char *zTbl,
dan46c47d42011-03-01 18:42:07 +0000823 sqlite_int64 iKey1,
824 sqlite_int64 iKey2
825){
826 SqliteDb *pDb = (SqliteDb *)p;
827 Tcl_Obj *pCmd;
828 static const char *azStr[] = {"DELETE", "INSERT", "UPDATE"};
829
830 assert( (SQLITE_DELETE-1)/9 == 0 );
831 assert( (SQLITE_INSERT-1)/9 == 1 );
832 assert( (SQLITE_UPDATE-1)/9 == 2 );
833 assert( pDb->pPreUpdateHook );
834 assert( db==pDb->db );
835 assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
836
837 pCmd = Tcl_DuplicateObj(pDb->pPreUpdateHook);
838 Tcl_IncrRefCount(pCmd);
839 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(azStr[(op-1)/9], -1));
840 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
841 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
842 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(iKey1));
843 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(iKey2));
844 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
845 Tcl_DecrRefCount(pCmd);
846}
drh9b1c62d2011-03-30 21:04:43 +0000847#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +0000848
danielk197794eb6a12005-12-15 15:22:08 +0000849static void DbUpdateHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000850 void *p,
danielk197794eb6a12005-12-15 15:22:08 +0000851 int op,
mistachkinb56660f2016-07-14 21:26:09 +0000852 const char *zDb,
853 const char *zTbl,
danielk197794eb6a12005-12-15 15:22:08 +0000854 sqlite_int64 rowid
855){
856 SqliteDb *pDb = (SqliteDb *)p;
857 Tcl_Obj *pCmd;
dan46c47d42011-03-01 18:42:07 +0000858 static const char *azStr[] = {"DELETE", "INSERT", "UPDATE"};
859
860 assert( (SQLITE_DELETE-1)/9 == 0 );
861 assert( (SQLITE_INSERT-1)/9 == 1 );
862 assert( (SQLITE_UPDATE-1)/9 == 2 );
danielk197794eb6a12005-12-15 15:22:08 +0000863
864 assert( pDb->pUpdateHook );
865 assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
866
867 pCmd = Tcl_DuplicateObj(pDb->pUpdateHook);
868 Tcl_IncrRefCount(pCmd);
dan46c47d42011-03-01 18:42:07 +0000869 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(azStr[(op-1)/9], -1));
danielk197794eb6a12005-12-15 15:22:08 +0000870 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
871 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
872 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(rowid));
873 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
drhefdde162010-10-27 15:36:21 +0000874 Tcl_DecrRefCount(pCmd);
danielk197794eb6a12005-12-15 15:22:08 +0000875}
876
danielk19777cedc8d2004-06-10 10:50:08 +0000877static void tclCollateNeeded(
878 void *pCtx,
drh9bb575f2004-09-06 17:24:11 +0000879 sqlite3 *db,
danielk19777cedc8d2004-06-10 10:50:08 +0000880 int enc,
881 const char *zName
882){
883 SqliteDb *pDb = (SqliteDb *)pCtx;
884 Tcl_Obj *pScript = Tcl_DuplicateObj(pDb->pCollateNeeded);
885 Tcl_IncrRefCount(pScript);
886 Tcl_ListObjAppendElement(0, pScript, Tcl_NewStringObj(zName, -1));
887 Tcl_EvalObjEx(pDb->interp, pScript, 0);
888 Tcl_DecrRefCount(pScript);
889}
890
drhaa940ea2004-01-15 02:44:03 +0000891/*
danielk19770202b292004-06-09 09:55:16 +0000892** This routine is called to evaluate an SQL collation function implemented
893** using TCL script.
894*/
895static int tclSqlCollate(
896 void *pCtx,
897 int nA,
898 const void *zA,
899 int nB,
900 const void *zB
901){
902 SqlCollate *p = (SqlCollate *)pCtx;
903 Tcl_Obj *pCmd;
904
905 pCmd = Tcl_NewStringObj(p->zScript, -1);
906 Tcl_IncrRefCount(pCmd);
907 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zA, nA));
908 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zB, nB));
drhd1e47332005-06-26 17:55:33 +0000909 Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
danielk19770202b292004-06-09 09:55:16 +0000910 Tcl_DecrRefCount(pCmd);
911 return (atoi(Tcl_GetStringResult(p->interp)));
912}
913
914/*
drhcabb0812002-09-14 13:47:32 +0000915** This routine is called to evaluate an SQL function implemented
916** using TCL script.
917*/
drhfb7e7652005-01-24 00:28:42 +0000918static void tclSqlFunc(sqlite3_context *context, int argc, sqlite3_value**argv){
danielk19776f8a5032004-05-10 10:34:51 +0000919 SqlFunc *p = sqlite3_user_data(context);
drhd1e47332005-06-26 17:55:33 +0000920 Tcl_Obj *pCmd;
drhcabb0812002-09-14 13:47:32 +0000921 int i;
922 int rc;
923
drhd1e47332005-06-26 17:55:33 +0000924 if( argc==0 ){
925 /* If there are no arguments to the function, call Tcl_EvalObjEx on the
926 ** script object directly. This allows the TCL compiler to generate
927 ** bytecode for the command on the first invocation and thus make
928 ** subsequent invocations much faster. */
929 pCmd = p->pScript;
930 Tcl_IncrRefCount(pCmd);
931 rc = Tcl_EvalObjEx(p->interp, pCmd, 0);
932 Tcl_DecrRefCount(pCmd);
933 }else{
934 /* If there are arguments to the function, make a shallow copy of the
935 ** script object, lappend the arguments, then evaluate the copy.
936 **
peter.d.reid60ec9142014-09-06 16:39:46 +0000937 ** By "shallow" copy, we mean only the outer list Tcl_Obj is duplicated.
mistachkinb56660f2016-07-14 21:26:09 +0000938 ** The new Tcl_Obj contains pointers to the original list elements.
drhd1e47332005-06-26 17:55:33 +0000939 ** That way, when Tcl_EvalObjv() is run and shimmers the first element
940 ** of the list to tclCmdNameType, that alternate representation will
941 ** be preserved and reused on the next invocation.
942 */
943 Tcl_Obj **aArg;
944 int nArg;
945 if( Tcl_ListObjGetElements(p->interp, p->pScript, &nArg, &aArg) ){
mistachkinb56660f2016-07-14 21:26:09 +0000946 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhd1e47332005-06-26 17:55:33 +0000947 return;
mistachkinb56660f2016-07-14 21:26:09 +0000948 }
drhd1e47332005-06-26 17:55:33 +0000949 pCmd = Tcl_NewListObj(nArg, aArg);
950 Tcl_IncrRefCount(pCmd);
951 for(i=0; i<argc; i++){
952 sqlite3_value *pIn = argv[i];
953 Tcl_Obj *pVal;
mistachkinb56660f2016-07-14 21:26:09 +0000954
drhd1e47332005-06-26 17:55:33 +0000955 /* Set pVal to contain the i'th column of this row. */
956 switch( sqlite3_value_type(pIn) ){
957 case SQLITE_BLOB: {
958 int bytes = sqlite3_value_bytes(pIn);
959 pVal = Tcl_NewByteArrayObj(sqlite3_value_blob(pIn), bytes);
960 break;
961 }
962 case SQLITE_INTEGER: {
963 sqlite_int64 v = sqlite3_value_int64(pIn);
964 if( v>=-2147483647 && v<=2147483647 ){
drh7fd33922011-06-20 19:00:30 +0000965 pVal = Tcl_NewIntObj((int)v);
drhd1e47332005-06-26 17:55:33 +0000966 }else{
967 pVal = Tcl_NewWideIntObj(v);
968 }
969 break;
970 }
971 case SQLITE_FLOAT: {
972 double r = sqlite3_value_double(pIn);
973 pVal = Tcl_NewDoubleObj(r);
974 break;
975 }
976 case SQLITE_NULL: {
drhc45e6712012-10-03 11:02:33 +0000977 pVal = Tcl_NewStringObj(p->pDb->zNull, -1);
drhd1e47332005-06-26 17:55:33 +0000978 break;
979 }
980 default: {
981 int bytes = sqlite3_value_bytes(pIn);
danielk197700fd9572005-12-07 06:27:43 +0000982 pVal = Tcl_NewStringObj((char *)sqlite3_value_text(pIn), bytes);
drhd1e47332005-06-26 17:55:33 +0000983 break;
984 }
985 }
986 rc = Tcl_ListObjAppendElement(p->interp, pCmd, pVal);
987 if( rc ){
988 Tcl_DecrRefCount(pCmd);
mistachkinb56660f2016-07-14 21:26:09 +0000989 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhd1e47332005-06-26 17:55:33 +0000990 return;
991 }
danielk197751ad0ec2004-05-24 12:39:02 +0000992 }
drhd1e47332005-06-26 17:55:33 +0000993 if( !p->useEvalObjv ){
994 /* Tcl_EvalObjEx() will automatically call Tcl_EvalObjv() if pCmd
995 ** is a list without a string representation. To prevent this from
996 ** happening, make sure pCmd has a valid string representation */
997 Tcl_GetString(pCmd);
998 }
999 rc = Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
1000 Tcl_DecrRefCount(pCmd);
drhcabb0812002-09-14 13:47:32 +00001001 }
danielk1977562e8d32005-05-20 09:40:55 +00001002
drhc7f269d2005-05-05 10:30:29 +00001003 if( rc && rc!=TCL_RETURN ){
mistachkinb56660f2016-07-14 21:26:09 +00001004 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhcabb0812002-09-14 13:47:32 +00001005 }else{
drhc7f269d2005-05-05 10:30:29 +00001006 Tcl_Obj *pVar = Tcl_GetObjResult(p->interp);
1007 int n;
1008 u8 *data;
dan4a4c11a2009-10-06 14:59:02 +00001009 const char *zType = (pVar->typePtr ? pVar->typePtr->name : "");
drhc7f269d2005-05-05 10:30:29 +00001010 char c = zType[0];
dan89d24932019-02-27 16:38:19 +00001011 int eType = p->eType;
1012
1013 if( eType==SQLITE_NULL ){
1014 if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
1015 /* Only return a BLOB type if the Tcl variable is a bytearray and
1016 ** has no string representation. */
1017 eType = SQLITE_BLOB;
1018 }else if( (c=='b' && strcmp(zType,"boolean")==0)
1019 || (c=='w' && strcmp(zType,"wideInt")==0)
1020 || (c=='i' && strcmp(zType,"int")==0)
1021 ){
1022 eType = SQLITE_INTEGER;
1023 }else if( c=='d' && strcmp(zType,"double")==0 ){
1024 eType = SQLITE_FLOAT;
1025 }else{
1026 eType = SQLITE_TEXT;
1027 }
drhc7f269d2005-05-05 10:30:29 +00001028 }
dan89d24932019-02-27 16:38:19 +00001029
1030 switch( eType ){
1031 case SQLITE_BLOB: {
1032 data = Tcl_GetByteArrayFromObj(pVar, &n);
1033 sqlite3_result_blob(context, data, n, SQLITE_TRANSIENT);
1034 break;
1035 }
1036 case SQLITE_INTEGER: {
1037 Tcl_WideInt v;
1038 if( TCL_OK==Tcl_GetWideIntFromObj(0, pVar, &v) ){
1039 sqlite3_result_int64(context, v);
1040 break;
1041 }
1042 /* fall-through */
1043 }
1044 case SQLITE_FLOAT: {
1045 double r;
1046 if( TCL_OK==Tcl_GetDoubleFromObj(0, pVar, &r) ){
1047 sqlite3_result_double(context, r);
1048 break;
1049 }
1050 /* fall-through */
1051 }
1052 default: {
1053 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
1054 sqlite3_result_text(context, (char *)data, n, SQLITE_TRANSIENT);
1055 break;
1056 }
1057 }
1058
drhcabb0812002-09-14 13:47:32 +00001059 }
1060}
drh895d7472004-08-20 16:02:39 +00001061
drhe22a3342003-04-22 20:30:37 +00001062#ifndef SQLITE_OMIT_AUTHORIZATION
1063/*
1064** This is the authentication function. It appends the authentication
1065** type code and the two arguments to zCmd[] then invokes the result
1066** on the interpreter. The reply is examined to determine if the
1067** authentication fails or succeeds.
1068*/
1069static int auth_callback(
1070 void *pArg,
1071 int code,
1072 const char *zArg1,
1073 const char *zArg2,
1074 const char *zArg3,
1075 const char *zArg4
drh32c6a482014-09-11 13:44:52 +00001076#ifdef SQLITE_USER_AUTHENTICATION
1077 ,const char *zArg5
1078#endif
drhe22a3342003-04-22 20:30:37 +00001079){
mistachkin6ef5e122014-01-24 17:03:55 +00001080 const char *zCode;
drhe22a3342003-04-22 20:30:37 +00001081 Tcl_DString str;
1082 int rc;
1083 const char *zReply;
drh94189212017-05-11 13:43:57 +00001084 /* EVIDENCE-OF: R-38590-62769 The first parameter to the authorizer
1085 ** callback is a copy of the third parameter to the
1086 ** sqlite3_set_authorizer() interface.
1087 */
drhe22a3342003-04-22 20:30:37 +00001088 SqliteDb *pDb = (SqliteDb*)pArg;
drh1f1549f2008-08-26 21:33:34 +00001089 if( pDb->disableAuth ) return SQLITE_OK;
drhe22a3342003-04-22 20:30:37 +00001090
drh94189212017-05-11 13:43:57 +00001091 /* EVIDENCE-OF: R-56518-44310 The second parameter to the callback is an
1092 ** integer action code that specifies the particular action to be
1093 ** authorized. */
drhe22a3342003-04-22 20:30:37 +00001094 switch( code ){
1095 case SQLITE_COPY : zCode="SQLITE_COPY"; break;
1096 case SQLITE_CREATE_INDEX : zCode="SQLITE_CREATE_INDEX"; break;
1097 case SQLITE_CREATE_TABLE : zCode="SQLITE_CREATE_TABLE"; break;
1098 case SQLITE_CREATE_TEMP_INDEX : zCode="SQLITE_CREATE_TEMP_INDEX"; break;
1099 case SQLITE_CREATE_TEMP_TABLE : zCode="SQLITE_CREATE_TEMP_TABLE"; break;
1100 case SQLITE_CREATE_TEMP_TRIGGER: zCode="SQLITE_CREATE_TEMP_TRIGGER"; break;
1101 case SQLITE_CREATE_TEMP_VIEW : zCode="SQLITE_CREATE_TEMP_VIEW"; break;
1102 case SQLITE_CREATE_TRIGGER : zCode="SQLITE_CREATE_TRIGGER"; break;
1103 case SQLITE_CREATE_VIEW : zCode="SQLITE_CREATE_VIEW"; break;
1104 case SQLITE_DELETE : zCode="SQLITE_DELETE"; break;
1105 case SQLITE_DROP_INDEX : zCode="SQLITE_DROP_INDEX"; break;
1106 case SQLITE_DROP_TABLE : zCode="SQLITE_DROP_TABLE"; break;
1107 case SQLITE_DROP_TEMP_INDEX : zCode="SQLITE_DROP_TEMP_INDEX"; break;
1108 case SQLITE_DROP_TEMP_TABLE : zCode="SQLITE_DROP_TEMP_TABLE"; break;
1109 case SQLITE_DROP_TEMP_TRIGGER : zCode="SQLITE_DROP_TEMP_TRIGGER"; break;
1110 case SQLITE_DROP_TEMP_VIEW : zCode="SQLITE_DROP_TEMP_VIEW"; break;
1111 case SQLITE_DROP_TRIGGER : zCode="SQLITE_DROP_TRIGGER"; break;
1112 case SQLITE_DROP_VIEW : zCode="SQLITE_DROP_VIEW"; break;
1113 case SQLITE_INSERT : zCode="SQLITE_INSERT"; break;
1114 case SQLITE_PRAGMA : zCode="SQLITE_PRAGMA"; break;
1115 case SQLITE_READ : zCode="SQLITE_READ"; break;
1116 case SQLITE_SELECT : zCode="SQLITE_SELECT"; break;
1117 case SQLITE_TRANSACTION : zCode="SQLITE_TRANSACTION"; break;
1118 case SQLITE_UPDATE : zCode="SQLITE_UPDATE"; break;
drh81e293b2003-06-06 19:00:42 +00001119 case SQLITE_ATTACH : zCode="SQLITE_ATTACH"; break;
1120 case SQLITE_DETACH : zCode="SQLITE_DETACH"; break;
danielk19771c8c23c2004-11-12 15:53:37 +00001121 case SQLITE_ALTER_TABLE : zCode="SQLITE_ALTER_TABLE"; break;
danielk19771d54df82004-11-23 15:41:16 +00001122 case SQLITE_REINDEX : zCode="SQLITE_REINDEX"; break;
drhe6e04962005-07-23 02:17:03 +00001123 case SQLITE_ANALYZE : zCode="SQLITE_ANALYZE"; break;
danielk1977f1a381e2006-06-16 08:01:02 +00001124 case SQLITE_CREATE_VTABLE : zCode="SQLITE_CREATE_VTABLE"; break;
1125 case SQLITE_DROP_VTABLE : zCode="SQLITE_DROP_VTABLE"; break;
drh5169bbc2006-08-24 14:59:45 +00001126 case SQLITE_FUNCTION : zCode="SQLITE_FUNCTION"; break;
danielk1977ab9b7032008-12-30 06:24:58 +00001127 case SQLITE_SAVEPOINT : zCode="SQLITE_SAVEPOINT"; break;
drh65a2aaa2014-01-16 22:40:02 +00001128 case SQLITE_RECURSIVE : zCode="SQLITE_RECURSIVE"; break;
drhe22a3342003-04-22 20:30:37 +00001129 default : zCode="????"; break;
1130 }
1131 Tcl_DStringInit(&str);
1132 Tcl_DStringAppend(&str, pDb->zAuth, -1);
1133 Tcl_DStringAppendElement(&str, zCode);
1134 Tcl_DStringAppendElement(&str, zArg1 ? zArg1 : "");
1135 Tcl_DStringAppendElement(&str, zArg2 ? zArg2 : "");
1136 Tcl_DStringAppendElement(&str, zArg3 ? zArg3 : "");
1137 Tcl_DStringAppendElement(&str, zArg4 ? zArg4 : "");
drh32c6a482014-09-11 13:44:52 +00001138#ifdef SQLITE_USER_AUTHENTICATION
1139 Tcl_DStringAppendElement(&str, zArg5 ? zArg5 : "");
mistachkinb56660f2016-07-14 21:26:09 +00001140#endif
drhe22a3342003-04-22 20:30:37 +00001141 rc = Tcl_GlobalEval(pDb->interp, Tcl_DStringValue(&str));
1142 Tcl_DStringFree(&str);
drhb07028f2011-10-14 21:49:18 +00001143 zReply = rc==TCL_OK ? Tcl_GetStringResult(pDb->interp) : "SQLITE_DENY";
drhe22a3342003-04-22 20:30:37 +00001144 if( strcmp(zReply,"SQLITE_OK")==0 ){
1145 rc = SQLITE_OK;
1146 }else if( strcmp(zReply,"SQLITE_DENY")==0 ){
1147 rc = SQLITE_DENY;
1148 }else if( strcmp(zReply,"SQLITE_IGNORE")==0 ){
1149 rc = SQLITE_IGNORE;
1150 }else{
1151 rc = 999;
1152 }
1153 return rc;
1154}
1155#endif /* SQLITE_OMIT_AUTHORIZATION */
drhcabb0812002-09-14 13:47:32 +00001156
1157/*
tpoindex1067fe12004-12-17 15:41:11 +00001158** This routine reads a line of text from FILE in, stores
1159** the text in memory obtained from malloc() and returns a pointer
1160** to the text. NULL is returned at end of file, or if malloc()
1161** fails.
1162**
1163** The interface is like "readline" but no command-line editing
1164** is done.
1165**
1166** copied from shell.c from '.import' command
1167*/
1168static char *local_getline(char *zPrompt, FILE *in){
1169 char *zLine;
1170 int nLine;
1171 int n;
tpoindex1067fe12004-12-17 15:41:11 +00001172
1173 nLine = 100;
1174 zLine = malloc( nLine );
1175 if( zLine==0 ) return 0;
1176 n = 0;
drhb07028f2011-10-14 21:49:18 +00001177 while( 1 ){
tpoindex1067fe12004-12-17 15:41:11 +00001178 if( n+100>nLine ){
1179 nLine = nLine*2 + 100;
1180 zLine = realloc(zLine, nLine);
1181 if( zLine==0 ) return 0;
1182 }
1183 if( fgets(&zLine[n], nLine - n, in)==0 ){
1184 if( n==0 ){
1185 free(zLine);
1186 return 0;
1187 }
1188 zLine[n] = 0;
tpoindex1067fe12004-12-17 15:41:11 +00001189 break;
1190 }
1191 while( zLine[n] ){ n++; }
1192 if( n>0 && zLine[n-1]=='\n' ){
1193 n--;
1194 zLine[n] = 0;
drhb07028f2011-10-14 21:49:18 +00001195 break;
tpoindex1067fe12004-12-17 15:41:11 +00001196 }
1197 }
1198 zLine = realloc( zLine, n+1 );
1199 return zLine;
1200}
1201
danielk19778e556522007-11-13 10:30:24 +00001202
1203/*
dan4a4c11a2009-10-06 14:59:02 +00001204** This function is part of the implementation of the command:
danielk19778e556522007-11-13 10:30:24 +00001205**
dan4a4c11a2009-10-06 14:59:02 +00001206** $db transaction [-deferred|-immediate|-exclusive] SCRIPT
danielk19778e556522007-11-13 10:30:24 +00001207**
dan4a4c11a2009-10-06 14:59:02 +00001208** It is invoked after evaluating the script SCRIPT to commit or rollback
1209** the transaction or savepoint opened by the [transaction] command.
1210*/
mistachkina121cc72016-07-28 18:06:52 +00001211static int SQLITE_TCLAPI DbTransPostCmd(
dan4a4c11a2009-10-06 14:59:02 +00001212 ClientData data[], /* data[0] is the Sqlite3Db* for $db */
1213 Tcl_Interp *interp, /* Tcl interpreter */
1214 int result /* Result of evaluating SCRIPT */
1215){
mistachkin6ef5e122014-01-24 17:03:55 +00001216 static const char *const azEnd[] = {
dan4a4c11a2009-10-06 14:59:02 +00001217 "RELEASE _tcl_transaction", /* rc==TCL_ERROR, nTransaction!=0 */
1218 "COMMIT", /* rc!=TCL_ERROR, nTransaction==0 */
1219 "ROLLBACK TO _tcl_transaction ; RELEASE _tcl_transaction",
1220 "ROLLBACK" /* rc==TCL_ERROR, nTransaction==0 */
1221 };
1222 SqliteDb *pDb = (SqliteDb*)data[0];
1223 int rc = result;
1224 const char *zEnd;
1225
1226 pDb->nTransaction--;
1227 zEnd = azEnd[(rc==TCL_ERROR)*2 + (pDb->nTransaction==0)];
1228
1229 pDb->disableAuth++;
1230 if( sqlite3_exec(pDb->db, zEnd, 0, 0, 0) ){
1231 /* This is a tricky scenario to handle. The most likely cause of an
mistachkinb56660f2016-07-14 21:26:09 +00001232 ** error is that the exec() above was an attempt to commit the
dan4a4c11a2009-10-06 14:59:02 +00001233 ** top-level transaction that returned SQLITE_BUSY. Or, less likely,
mistachkin48864df2013-03-21 21:20:32 +00001234 ** that an IO-error has occurred. In either case, throw a Tcl exception
dan4a4c11a2009-10-06 14:59:02 +00001235 ** and try to rollback the transaction.
1236 **
mistachkinb56660f2016-07-14 21:26:09 +00001237 ** But it could also be that the user executed one or more BEGIN,
dan4a4c11a2009-10-06 14:59:02 +00001238 ** COMMIT, SAVEPOINT, RELEASE or ROLLBACK commands that are confusing
1239 ** this method's logic. Not clear how this would be best handled.
1240 */
1241 if( rc!=TCL_ERROR ){
drha198f2b2014-02-07 19:26:13 +00001242 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
dan4a4c11a2009-10-06 14:59:02 +00001243 rc = TCL_ERROR;
1244 }
1245 sqlite3_exec(pDb->db, "ROLLBACK", 0, 0, 0);
1246 }
1247 pDb->disableAuth--;
1248
1249 return rc;
1250}
1251
1252/*
danc431fd52011-06-27 16:55:50 +00001253** Unless SQLITE_TEST is defined, this function is a simple wrapper around
1254** sqlite3_prepare_v2(). If SQLITE_TEST is defined, then it uses either
1255** sqlite3_prepare_v2() or legacy interface sqlite3_prepare(), depending
mistachkinb56660f2016-07-14 21:26:09 +00001256** on whether or not the [db_use_legacy_prepare] command has been used to
danc431fd52011-06-27 16:55:50 +00001257** configure the connection.
1258*/
1259static int dbPrepare(
1260 SqliteDb *pDb, /* Database object */
1261 const char *zSql, /* SQL to compile */
1262 sqlite3_stmt **ppStmt, /* OUT: Prepared statement */
1263 const char **pzOut /* OUT: Pointer to next SQL statement */
1264){
drh2c2f3922017-06-01 00:54:35 +00001265 unsigned int prepFlags = 0;
danc431fd52011-06-27 16:55:50 +00001266#ifdef SQLITE_TEST
1267 if( pDb->bLegacyPrepare ){
1268 return sqlite3_prepare(pDb->db, zSql, -1, ppStmt, pzOut);
1269 }
1270#endif
drh2c2f3922017-06-01 00:54:35 +00001271 /* If the statement cache is large, use the SQLITE_PREPARE_PERSISTENT
1272 ** flags, which uses less lookaside memory. But if the cache is small,
1273 ** omit that flag to make full use of lookaside */
1274 if( pDb->maxStmt>5 ) prepFlags = SQLITE_PREPARE_PERSISTENT;
1275
1276 return sqlite3_prepare_v3(pDb->db, zSql, -1, prepFlags, ppStmt, pzOut);
danc431fd52011-06-27 16:55:50 +00001277}
1278
1279/*
dan4a4c11a2009-10-06 14:59:02 +00001280** Search the cache for a prepared-statement object that implements the
1281** first SQL statement in the buffer pointed to by parameter zIn. If
1282** no such prepared-statement can be found, allocate and prepare a new
1283** one. In either case, bind the current values of the relevant Tcl
1284** variables to any $var, :var or @var variables in the statement. Before
1285** returning, set *ppPreStmt to point to the prepared-statement object.
1286**
1287** Output parameter *pzOut is set to point to the next SQL statement in
1288** buffer zIn, or to the '\0' byte at the end of zIn if there is no
1289** next statement.
1290**
1291** If successful, TCL_OK is returned. Otherwise, TCL_ERROR is returned
1292** and an error message loaded into interpreter pDb->interp.
1293*/
1294static int dbPrepareAndBind(
1295 SqliteDb *pDb, /* Database object */
1296 char const *zIn, /* SQL to compile */
1297 char const **pzOut, /* OUT: Pointer to next SQL statement */
1298 SqlPreparedStmt **ppPreStmt /* OUT: Object used to cache statement */
1299){
1300 const char *zSql = zIn; /* Pointer to first SQL statement in zIn */
mistachkin7bb22ac2015-01-12 19:59:12 +00001301 sqlite3_stmt *pStmt = 0; /* Prepared statement object */
dan4a4c11a2009-10-06 14:59:02 +00001302 SqlPreparedStmt *pPreStmt; /* Pointer to cached statement */
1303 int nSql; /* Length of zSql in bytes */
mistachkin7bb22ac2015-01-12 19:59:12 +00001304 int nVar = 0; /* Number of variables in statement */
dan4a4c11a2009-10-06 14:59:02 +00001305 int iParm = 0; /* Next free entry in apParm */
drh0425f182013-11-26 16:48:04 +00001306 char c;
dan4a4c11a2009-10-06 14:59:02 +00001307 int i;
drhc06ede12019-02-28 17:29:19 +00001308 int needResultReset = 0; /* Need to invoke Tcl_ResetResult() */
1309 int rc = SQLITE_OK; /* Value to return */
dan4a4c11a2009-10-06 14:59:02 +00001310 Tcl_Interp *interp = pDb->interp;
1311
1312 *ppPreStmt = 0;
1313
1314 /* Trim spaces from the start of zSql and calculate the remaining length. */
drh0425f182013-11-26 16:48:04 +00001315 while( (c = zSql[0])==' ' || c=='\t' || c=='\r' || c=='\n' ){ zSql++; }
dan4a4c11a2009-10-06 14:59:02 +00001316 nSql = strlen30(zSql);
1317
1318 for(pPreStmt = pDb->stmtList; pPreStmt; pPreStmt=pPreStmt->pNext){
1319 int n = pPreStmt->nSql;
mistachkinb56660f2016-07-14 21:26:09 +00001320 if( nSql>=n
dan4a4c11a2009-10-06 14:59:02 +00001321 && memcmp(pPreStmt->zSql, zSql, n)==0
1322 && (zSql[n]==0 || zSql[n-1]==';')
1323 ){
1324 pStmt = pPreStmt->pStmt;
1325 *pzOut = &zSql[pPreStmt->nSql];
1326
1327 /* When a prepared statement is found, unlink it from the
1328 ** cache list. It will later be added back to the beginning
1329 ** of the cache list in order to implement LRU replacement.
1330 */
1331 if( pPreStmt->pPrev ){
1332 pPreStmt->pPrev->pNext = pPreStmt->pNext;
1333 }else{
1334 pDb->stmtList = pPreStmt->pNext;
1335 }
1336 if( pPreStmt->pNext ){
1337 pPreStmt->pNext->pPrev = pPreStmt->pPrev;
1338 }else{
1339 pDb->stmtLast = pPreStmt->pPrev;
1340 }
1341 pDb->nStmt--;
1342 nVar = sqlite3_bind_parameter_count(pStmt);
1343 break;
1344 }
1345 }
mistachkinb56660f2016-07-14 21:26:09 +00001346
dan4a4c11a2009-10-06 14:59:02 +00001347 /* If no prepared statement was found. Compile the SQL text. Also allocate
1348 ** a new SqlPreparedStmt structure. */
1349 if( pPreStmt==0 ){
1350 int nByte;
1351
danc431fd52011-06-27 16:55:50 +00001352 if( SQLITE_OK!=dbPrepare(pDb, zSql, &pStmt, pzOut) ){
drhc45e6712012-10-03 11:02:33 +00001353 Tcl_SetObjResult(interp, Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001354 return TCL_ERROR;
1355 }
1356 if( pStmt==0 ){
1357 if( SQLITE_OK!=sqlite3_errcode(pDb->db) ){
1358 /* A compile-time error in the statement. */
drhc45e6712012-10-03 11:02:33 +00001359 Tcl_SetObjResult(interp, Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001360 return TCL_ERROR;
1361 }else{
1362 /* The statement was a no-op. Continue to the next statement
1363 ** in the SQL string.
1364 */
1365 return TCL_OK;
1366 }
1367 }
1368
1369 assert( pPreStmt==0 );
1370 nVar = sqlite3_bind_parameter_count(pStmt);
1371 nByte = sizeof(SqlPreparedStmt) + nVar*sizeof(Tcl_Obj *);
1372 pPreStmt = (SqlPreparedStmt*)Tcl_Alloc(nByte);
1373 memset(pPreStmt, 0, nByte);
1374
1375 pPreStmt->pStmt = pStmt;
drh7ed243b2012-04-19 17:19:51 +00001376 pPreStmt->nSql = (int)(*pzOut - zSql);
dan4a4c11a2009-10-06 14:59:02 +00001377 pPreStmt->zSql = sqlite3_sql(pStmt);
1378 pPreStmt->apParm = (Tcl_Obj **)&pPreStmt[1];
danc431fd52011-06-27 16:55:50 +00001379#ifdef SQLITE_TEST
1380 if( pPreStmt->zSql==0 ){
1381 char *zCopy = Tcl_Alloc(pPreStmt->nSql + 1);
1382 memcpy(zCopy, zSql, pPreStmt->nSql);
1383 zCopy[pPreStmt->nSql] = '\0';
1384 pPreStmt->zSql = zCopy;
1385 }
1386#endif
dan4a4c11a2009-10-06 14:59:02 +00001387 }
1388 assert( pPreStmt );
1389 assert( strlen30(pPreStmt->zSql)==pPreStmt->nSql );
1390 assert( 0==memcmp(pPreStmt->zSql, zSql, pPreStmt->nSql) );
1391
mistachkinb56660f2016-07-14 21:26:09 +00001392 /* Bind values to parameters that begin with $ or : */
dan4a4c11a2009-10-06 14:59:02 +00001393 for(i=1; i<=nVar; i++){
1394 const char *zVar = sqlite3_bind_parameter_name(pStmt, i);
1395 if( zVar!=0 && (zVar[0]=='$' || zVar[0]==':' || zVar[0]=='@') ){
1396 Tcl_Obj *pVar = Tcl_GetVar2Ex(interp, &zVar[1], 0, 0);
drhc06ede12019-02-28 17:29:19 +00001397 if( pVar==0 && pDb->zBindFallback!=0 ){
1398 Tcl_Obj *pCmd;
1399 int rx;
1400 pCmd = Tcl_NewStringObj(pDb->zBindFallback, -1);
1401 Tcl_IncrRefCount(pCmd);
1402 Tcl_ListObjAppendElement(interp, pCmd, Tcl_NewStringObj(zVar,-1));
1403 if( needResultReset ) Tcl_ResetResult(interp);
1404 needResultReset = 1;
1405 rx = Tcl_EvalObjEx(interp, pCmd, TCL_EVAL_DIRECT);
1406 Tcl_DecrRefCount(pCmd);
1407 if( rx==TCL_OK ){
1408 pVar = Tcl_GetObjResult(interp);
1409 }else if( rx==TCL_ERROR ){
1410 rc = TCL_ERROR;
1411 break;
1412 }else{
1413 pVar = 0;
1414 }
1415 }
dan4a4c11a2009-10-06 14:59:02 +00001416 if( pVar ){
1417 int n;
1418 u8 *data;
1419 const char *zType = (pVar->typePtr ? pVar->typePtr->name : "");
mistachkin8e189222015-04-19 21:43:16 +00001420 c = zType[0];
dan4a4c11a2009-10-06 14:59:02 +00001421 if( zVar[0]=='@' ||
1422 (c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0) ){
1423 /* Load a BLOB type if the Tcl variable is a bytearray and
1424 ** it has no string representation or the host
1425 ** parameter name begins with "@". */
1426 data = Tcl_GetByteArrayFromObj(pVar, &n);
1427 sqlite3_bind_blob(pStmt, i, data, n, SQLITE_STATIC);
1428 Tcl_IncrRefCount(pVar);
1429 pPreStmt->apParm[iParm++] = pVar;
1430 }else if( c=='b' && strcmp(zType,"boolean")==0 ){
1431 Tcl_GetIntFromObj(interp, pVar, &n);
1432 sqlite3_bind_int(pStmt, i, n);
1433 }else if( c=='d' && strcmp(zType,"double")==0 ){
1434 double r;
1435 Tcl_GetDoubleFromObj(interp, pVar, &r);
1436 sqlite3_bind_double(pStmt, i, r);
1437 }else if( (c=='w' && strcmp(zType,"wideInt")==0) ||
1438 (c=='i' && strcmp(zType,"int")==0) ){
1439 Tcl_WideInt v;
1440 Tcl_GetWideIntFromObj(interp, pVar, &v);
1441 sqlite3_bind_int64(pStmt, i, v);
1442 }else{
1443 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
1444 sqlite3_bind_text(pStmt, i, (char *)data, n, SQLITE_STATIC);
1445 Tcl_IncrRefCount(pVar);
1446 pPreStmt->apParm[iParm++] = pVar;
1447 }
1448 }else{
1449 sqlite3_bind_null(pStmt, i);
1450 }
drhc06ede12019-02-28 17:29:19 +00001451 if( needResultReset ) Tcl_ResetResult(pDb->interp);
dan4a4c11a2009-10-06 14:59:02 +00001452 }
1453 }
1454 pPreStmt->nParm = iParm;
1455 *ppPreStmt = pPreStmt;
drhc06ede12019-02-28 17:29:19 +00001456 if( needResultReset && rc==TCL_OK ) Tcl_ResetResult(pDb->interp);
dan937d0de2009-10-15 18:35:38 +00001457
drhc06ede12019-02-28 17:29:19 +00001458 return rc;
dan4a4c11a2009-10-06 14:59:02 +00001459}
1460
dan4a4c11a2009-10-06 14:59:02 +00001461/*
1462** Release a statement reference obtained by calling dbPrepareAndBind().
1463** There should be exactly one call to this function for each call to
1464** dbPrepareAndBind().
1465**
1466** If the discard parameter is non-zero, then the statement is deleted
1467** immediately. Otherwise it is added to the LRU list and may be returned
1468** by a subsequent call to dbPrepareAndBind().
1469*/
1470static void dbReleaseStmt(
1471 SqliteDb *pDb, /* Database handle */
1472 SqlPreparedStmt *pPreStmt, /* Prepared statement handle to release */
1473 int discard /* True to delete (not cache) the pPreStmt */
1474){
1475 int i;
1476
1477 /* Free the bound string and blob parameters */
1478 for(i=0; i<pPreStmt->nParm; i++){
1479 Tcl_DecrRefCount(pPreStmt->apParm[i]);
1480 }
1481 pPreStmt->nParm = 0;
1482
1483 if( pDb->maxStmt<=0 || discard ){
1484 /* If the cache is turned off, deallocated the statement */
danc431fd52011-06-27 16:55:50 +00001485 dbFreeStmt(pPreStmt);
dan4a4c11a2009-10-06 14:59:02 +00001486 }else{
1487 /* Add the prepared statement to the beginning of the cache list. */
1488 pPreStmt->pNext = pDb->stmtList;
1489 pPreStmt->pPrev = 0;
1490 if( pDb->stmtList ){
1491 pDb->stmtList->pPrev = pPreStmt;
1492 }
1493 pDb->stmtList = pPreStmt;
1494 if( pDb->stmtLast==0 ){
1495 assert( pDb->nStmt==0 );
1496 pDb->stmtLast = pPreStmt;
1497 }else{
1498 assert( pDb->nStmt>0 );
1499 }
1500 pDb->nStmt++;
mistachkinb56660f2016-07-14 21:26:09 +00001501
1502 /* If we have too many statement in cache, remove the surplus from
dan4a4c11a2009-10-06 14:59:02 +00001503 ** the end of the cache list. */
1504 while( pDb->nStmt>pDb->maxStmt ){
danc431fd52011-06-27 16:55:50 +00001505 SqlPreparedStmt *pLast = pDb->stmtLast;
1506 pDb->stmtLast = pLast->pPrev;
dan4a4c11a2009-10-06 14:59:02 +00001507 pDb->stmtLast->pNext = 0;
1508 pDb->nStmt--;
danc431fd52011-06-27 16:55:50 +00001509 dbFreeStmt(pLast);
dan4a4c11a2009-10-06 14:59:02 +00001510 }
1511 }
1512}
1513
1514/*
1515** Structure used with dbEvalXXX() functions:
1516**
1517** dbEvalInit()
1518** dbEvalStep()
1519** dbEvalFinalize()
1520** dbEvalRowInfo()
1521** dbEvalColumnValue()
1522*/
1523typedef struct DbEvalContext DbEvalContext;
1524struct DbEvalContext {
1525 SqliteDb *pDb; /* Database handle */
1526 Tcl_Obj *pSql; /* Object holding string zSql */
1527 const char *zSql; /* Remaining SQL to execute */
1528 SqlPreparedStmt *pPreStmt; /* Current statement */
1529 int nCol; /* Number of columns returned by pStmt */
drhaf38cdb2017-06-26 21:08:32 +00001530 int evalFlags; /* Flags used */
dan4a4c11a2009-10-06 14:59:02 +00001531 Tcl_Obj *pArray; /* Name of array variable */
1532 Tcl_Obj **apColName; /* Array of column names */
1533};
1534
drhaf38cdb2017-06-26 21:08:32 +00001535#define SQLITE_EVAL_WITHOUTNULLS 0x00001 /* Unset array(*) for NULL */
1536
dan4a4c11a2009-10-06 14:59:02 +00001537/*
1538** Release any cache of column names currently held as part of
1539** the DbEvalContext structure passed as the first argument.
1540*/
1541static void dbReleaseColumnNames(DbEvalContext *p){
1542 if( p->apColName ){
1543 int i;
1544 for(i=0; i<p->nCol; i++){
1545 Tcl_DecrRefCount(p->apColName[i]);
1546 }
1547 Tcl_Free((char *)p->apColName);
1548 p->apColName = 0;
1549 }
1550 p->nCol = 0;
1551}
1552
1553/*
1554** Initialize a DbEvalContext structure.
danielk19778e556522007-11-13 10:30:24 +00001555**
1556** If pArray is not NULL, then it contains the name of a Tcl array
1557** variable. The "*" member of this array is set to a list containing
dan4a4c11a2009-10-06 14:59:02 +00001558** the names of the columns returned by the statement as part of each
mistachkinb56660f2016-07-14 21:26:09 +00001559** call to dbEvalStep(), in order from left to right. e.g. if the names
1560** of the returned columns are a, b and c, it does the equivalent of the
dan4a4c11a2009-10-06 14:59:02 +00001561** tcl command:
danielk19778e556522007-11-13 10:30:24 +00001562**
1563** set ${pArray}(*) {a b c}
1564*/
dan4a4c11a2009-10-06 14:59:02 +00001565static void dbEvalInit(
1566 DbEvalContext *p, /* Pointer to structure to initialize */
1567 SqliteDb *pDb, /* Database handle */
1568 Tcl_Obj *pSql, /* Object containing SQL script */
drhaf38cdb2017-06-26 21:08:32 +00001569 Tcl_Obj *pArray, /* Name of Tcl array to set (*) element of */
1570 int evalFlags /* Flags controlling evaluation */
danielk19778e556522007-11-13 10:30:24 +00001571){
dan4a4c11a2009-10-06 14:59:02 +00001572 memset(p, 0, sizeof(DbEvalContext));
1573 p->pDb = pDb;
1574 p->zSql = Tcl_GetString(pSql);
1575 p->pSql = pSql;
1576 Tcl_IncrRefCount(pSql);
1577 if( pArray ){
1578 p->pArray = pArray;
1579 Tcl_IncrRefCount(pArray);
1580 }
drhaf38cdb2017-06-26 21:08:32 +00001581 p->evalFlags = evalFlags;
dan4a4c11a2009-10-06 14:59:02 +00001582}
danielk19778e556522007-11-13 10:30:24 +00001583
dan4a4c11a2009-10-06 14:59:02 +00001584/*
1585** Obtain information about the row that the DbEvalContext passed as the
1586** first argument currently points to.
1587*/
1588static void dbEvalRowInfo(
1589 DbEvalContext *p, /* Evaluation context */
1590 int *pnCol, /* OUT: Number of column names */
1591 Tcl_Obj ***papColName /* OUT: Array of column names */
1592){
danielk19778e556522007-11-13 10:30:24 +00001593 /* Compute column names */
dan4a4c11a2009-10-06 14:59:02 +00001594 if( 0==p->apColName ){
1595 sqlite3_stmt *pStmt = p->pPreStmt->pStmt;
1596 int i; /* Iterator variable */
1597 int nCol; /* Number of columns returned by pStmt */
1598 Tcl_Obj **apColName = 0; /* Array of column names */
1599
1600 p->nCol = nCol = sqlite3_column_count(pStmt);
1601 if( nCol>0 && (papColName || p->pArray) ){
1602 apColName = (Tcl_Obj**)Tcl_Alloc( sizeof(Tcl_Obj*)*nCol );
1603 for(i=0; i<nCol; i++){
drhc45e6712012-10-03 11:02:33 +00001604 apColName[i] = Tcl_NewStringObj(sqlite3_column_name(pStmt,i), -1);
dan4a4c11a2009-10-06 14:59:02 +00001605 Tcl_IncrRefCount(apColName[i]);
1606 }
1607 p->apColName = apColName;
danielk19778e556522007-11-13 10:30:24 +00001608 }
1609
1610 /* If results are being stored in an array variable, then create
1611 ** the array(*) entry for that array
1612 */
dan4a4c11a2009-10-06 14:59:02 +00001613 if( p->pArray ){
1614 Tcl_Interp *interp = p->pDb->interp;
danielk19778e556522007-11-13 10:30:24 +00001615 Tcl_Obj *pColList = Tcl_NewObj();
1616 Tcl_Obj *pStar = Tcl_NewStringObj("*", -1);
dan4a4c11a2009-10-06 14:59:02 +00001617
danielk19778e556522007-11-13 10:30:24 +00001618 for(i=0; i<nCol; i++){
1619 Tcl_ListObjAppendElement(interp, pColList, apColName[i]);
1620 }
1621 Tcl_IncrRefCount(pStar);
dan4a4c11a2009-10-06 14:59:02 +00001622 Tcl_ObjSetVar2(interp, p->pArray, pStar, pColList, 0);
danielk19778e556522007-11-13 10:30:24 +00001623 Tcl_DecrRefCount(pStar);
1624 }
danielk19778e556522007-11-13 10:30:24 +00001625 }
1626
dan4a4c11a2009-10-06 14:59:02 +00001627 if( papColName ){
1628 *papColName = p->apColName;
1629 }
1630 if( pnCol ){
1631 *pnCol = p->nCol;
1632 }
1633}
1634
1635/*
1636** Return one of TCL_OK, TCL_BREAK or TCL_ERROR. If TCL_ERROR is
1637** returned, then an error message is stored in the interpreter before
1638** returning.
1639**
1640** A return value of TCL_OK means there is a row of data available. The
1641** data may be accessed using dbEvalRowInfo() and dbEvalColumnValue(). This
1642** is analogous to a return of SQLITE_ROW from sqlite3_step(). If TCL_BREAK
1643** is returned, then the SQL script has finished executing and there are
1644** no further rows available. This is similar to SQLITE_DONE.
1645*/
1646static int dbEvalStep(DbEvalContext *p){
danc431fd52011-06-27 16:55:50 +00001647 const char *zPrevSql = 0; /* Previous value of p->zSql */
1648
dan4a4c11a2009-10-06 14:59:02 +00001649 while( p->zSql[0] || p->pPreStmt ){
1650 int rc;
1651 if( p->pPreStmt==0 ){
danc431fd52011-06-27 16:55:50 +00001652 zPrevSql = (p->zSql==zPrevSql ? 0 : p->zSql);
dan4a4c11a2009-10-06 14:59:02 +00001653 rc = dbPrepareAndBind(p->pDb, p->zSql, &p->zSql, &p->pPreStmt);
1654 if( rc!=TCL_OK ) return rc;
1655 }else{
1656 int rcs;
1657 SqliteDb *pDb = p->pDb;
1658 SqlPreparedStmt *pPreStmt = p->pPreStmt;
1659 sqlite3_stmt *pStmt = pPreStmt->pStmt;
1660
1661 rcs = sqlite3_step(pStmt);
1662 if( rcs==SQLITE_ROW ){
1663 return TCL_OK;
1664 }
1665 if( p->pArray ){
1666 dbEvalRowInfo(p, 0, 0);
1667 }
1668 rcs = sqlite3_reset(pStmt);
1669
1670 pDb->nStep = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_FULLSCAN_STEP,1);
1671 pDb->nSort = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_SORT,1);
drh3c379b02010-04-07 19:31:59 +00001672 pDb->nIndex = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_AUTOINDEX,1);
danc456a762017-06-22 16:51:16 +00001673 pDb->nVMStep = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_VM_STEP,1);
dan4a4c11a2009-10-06 14:59:02 +00001674 dbReleaseColumnNames(p);
1675 p->pPreStmt = 0;
1676
1677 if( rcs!=SQLITE_OK ){
1678 /* If a run-time error occurs, report the error and stop reading
1679 ** the SQL. */
dan4a4c11a2009-10-06 14:59:02 +00001680 dbReleaseStmt(pDb, pPreStmt, 1);
danc431fd52011-06-27 16:55:50 +00001681#if SQLITE_TEST
1682 if( p->pDb->bLegacyPrepare && rcs==SQLITE_SCHEMA && zPrevSql ){
1683 /* If the runtime error was an SQLITE_SCHEMA, and the database
mistachkinb56660f2016-07-14 21:26:09 +00001684 ** handle is configured to use the legacy sqlite3_prepare()
danc431fd52011-06-27 16:55:50 +00001685 ** interface, retry prepare()/step() on the same SQL statement.
1686 ** This only happens once. If there is a second SQLITE_SCHEMA
1687 ** error, the error will be returned to the caller. */
1688 p->zSql = zPrevSql;
1689 continue;
1690 }
1691#endif
drhc45e6712012-10-03 11:02:33 +00001692 Tcl_SetObjResult(pDb->interp,
1693 Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001694 return TCL_ERROR;
1695 }else{
1696 dbReleaseStmt(pDb, pPreStmt, 0);
1697 }
1698 }
1699 }
1700
1701 /* Finished */
1702 return TCL_BREAK;
1703}
1704
1705/*
1706** Free all resources currently held by the DbEvalContext structure passed
1707** as the first argument. There should be exactly one call to this function
1708** for each call to dbEvalInit().
1709*/
1710static void dbEvalFinalize(DbEvalContext *p){
1711 if( p->pPreStmt ){
1712 sqlite3_reset(p->pPreStmt->pStmt);
1713 dbReleaseStmt(p->pDb, p->pPreStmt, 0);
1714 p->pPreStmt = 0;
1715 }
1716 if( p->pArray ){
1717 Tcl_DecrRefCount(p->pArray);
1718 p->pArray = 0;
1719 }
1720 Tcl_DecrRefCount(p->pSql);
1721 dbReleaseColumnNames(p);
1722}
1723
1724/*
1725** Return a pointer to a Tcl_Obj structure with ref-count 0 that contains
1726** the value for the iCol'th column of the row currently pointed to by
1727** the DbEvalContext structure passed as the first argument.
1728*/
1729static Tcl_Obj *dbEvalColumnValue(DbEvalContext *p, int iCol){
1730 sqlite3_stmt *pStmt = p->pPreStmt->pStmt;
1731 switch( sqlite3_column_type(pStmt, iCol) ){
1732 case SQLITE_BLOB: {
1733 int bytes = sqlite3_column_bytes(pStmt, iCol);
1734 const char *zBlob = sqlite3_column_blob(pStmt, iCol);
1735 if( !zBlob ) bytes = 0;
1736 return Tcl_NewByteArrayObj((u8*)zBlob, bytes);
1737 }
1738 case SQLITE_INTEGER: {
1739 sqlite_int64 v = sqlite3_column_int64(pStmt, iCol);
1740 if( v>=-2147483647 && v<=2147483647 ){
drh7fd33922011-06-20 19:00:30 +00001741 return Tcl_NewIntObj((int)v);
dan4a4c11a2009-10-06 14:59:02 +00001742 }else{
1743 return Tcl_NewWideIntObj(v);
1744 }
1745 }
1746 case SQLITE_FLOAT: {
1747 return Tcl_NewDoubleObj(sqlite3_column_double(pStmt, iCol));
1748 }
1749 case SQLITE_NULL: {
drhc45e6712012-10-03 11:02:33 +00001750 return Tcl_NewStringObj(p->pDb->zNull, -1);
dan4a4c11a2009-10-06 14:59:02 +00001751 }
1752 }
1753
drh325eff52012-10-03 12:56:18 +00001754 return Tcl_NewStringObj((char*)sqlite3_column_text(pStmt, iCol), -1);
dan4a4c11a2009-10-06 14:59:02 +00001755}
1756
1757/*
1758** If using Tcl version 8.6 or greater, use the NR functions to avoid
1759** recursive evalution of scripts by the [db eval] and [db trans]
1760** commands. Even if the headers used while compiling the extension
1761** are 8.6 or newer, the code still tests the Tcl version at runtime.
1762** This allows stubs-enabled builds to be used with older Tcl libraries.
1763*/
1764#if TCL_MAJOR_VERSION>8 || (TCL_MAJOR_VERSION==8 && TCL_MINOR_VERSION>=6)
drha2c8a952009-10-13 18:38:34 +00001765# define SQLITE_TCL_NRE 1
dan4a4c11a2009-10-06 14:59:02 +00001766static int DbUseNre(void){
1767 int major, minor;
1768 Tcl_GetVersion(&major, &minor, 0, 0);
1769 return( (major==8 && minor>=6) || major>8 );
1770}
1771#else
mistachkinb56660f2016-07-14 21:26:09 +00001772/*
dan4a4c11a2009-10-06 14:59:02 +00001773** Compiling using headers earlier than 8.6. In this case NR cannot be
1774** used, so DbUseNre() to always return zero. Add #defines for the other
1775** Tcl_NRxxx() functions to prevent them from causing compilation errors,
mistachkinb56660f2016-07-14 21:26:09 +00001776** even though the only invocations of them are within conditional blocks
dan4a4c11a2009-10-06 14:59:02 +00001777** of the form:
1778**
1779** if( DbUseNre() ) { ... }
1780*/
drha2c8a952009-10-13 18:38:34 +00001781# define SQLITE_TCL_NRE 0
dan4a4c11a2009-10-06 14:59:02 +00001782# define DbUseNre() 0
drha47941f2013-12-20 18:57:44 +00001783# define Tcl_NRAddCallback(a,b,c,d,e,f) (void)0
dan4a4c11a2009-10-06 14:59:02 +00001784# define Tcl_NREvalObj(a,b,c) 0
drha47941f2013-12-20 18:57:44 +00001785# define Tcl_NRCreateCommand(a,b,c,d,e,f) (void)0
dan4a4c11a2009-10-06 14:59:02 +00001786#endif
1787
1788/*
1789** This function is part of the implementation of the command:
1790**
1791** $db eval SQL ?ARRAYNAME? SCRIPT
1792*/
mistachkina121cc72016-07-28 18:06:52 +00001793static int SQLITE_TCLAPI DbEvalNextCmd(
dan4a4c11a2009-10-06 14:59:02 +00001794 ClientData data[], /* data[0] is the (DbEvalContext*) */
1795 Tcl_Interp *interp, /* Tcl interpreter */
1796 int result /* Result so far */
1797){
1798 int rc = result; /* Return code */
1799
1800 /* The first element of the data[] array is a pointer to a DbEvalContext
1801 ** structure allocated using Tcl_Alloc(). The second element of data[]
1802 ** is a pointer to a Tcl_Obj containing the script to run for each row
1803 ** returned by the queries encapsulated in data[0]. */
1804 DbEvalContext *p = (DbEvalContext *)data[0];
1805 Tcl_Obj *pScript = (Tcl_Obj *)data[1];
1806 Tcl_Obj *pArray = p->pArray;
1807
1808 while( (rc==TCL_OK || rc==TCL_CONTINUE) && TCL_OK==(rc = dbEvalStep(p)) ){
1809 int i;
1810 int nCol;
1811 Tcl_Obj **apColName;
1812 dbEvalRowInfo(p, &nCol, &apColName);
1813 for(i=0; i<nCol; i++){
dan4a4c11a2009-10-06 14:59:02 +00001814 if( pArray==0 ){
drhaf38cdb2017-06-26 21:08:32 +00001815 Tcl_ObjSetVar2(interp, apColName[i], 0, dbEvalColumnValue(p,i), 0);
1816 }else if( (p->evalFlags & SQLITE_EVAL_WITHOUTNULLS)!=0
1817 && sqlite3_column_type(p->pPreStmt->pStmt, i)==SQLITE_NULL
1818 ){
1819 Tcl_UnsetVar2(interp, Tcl_GetString(pArray),
1820 Tcl_GetString(apColName[i]), 0);
dan4a4c11a2009-10-06 14:59:02 +00001821 }else{
drhaf38cdb2017-06-26 21:08:32 +00001822 Tcl_ObjSetVar2(interp, pArray, apColName[i], dbEvalColumnValue(p,i), 0);
dan4a4c11a2009-10-06 14:59:02 +00001823 }
1824 }
1825
mistachkinb56660f2016-07-14 21:26:09 +00001826 /* The required interpreter variables are now populated with the data
dan4a4c11a2009-10-06 14:59:02 +00001827 ** from the current row. If using NRE, schedule callbacks to evaluate
1828 ** script pScript, then to invoke this function again to fetch the next
1829 ** row (or clean up if there is no next row or the script throws an
mistachkinb56660f2016-07-14 21:26:09 +00001830 ** exception). After scheduling the callbacks, return control to the
dan4a4c11a2009-10-06 14:59:02 +00001831 ** caller.
1832 **
1833 ** If not using NRE, evaluate pScript directly and continue with the
1834 ** next iteration of this while(...) loop. */
1835 if( DbUseNre() ){
1836 Tcl_NRAddCallback(interp, DbEvalNextCmd, (void*)p, (void*)pScript, 0, 0);
1837 return Tcl_NREvalObj(interp, pScript, 0);
1838 }else{
1839 rc = Tcl_EvalObjEx(interp, pScript, 0);
1840 }
1841 }
1842
1843 Tcl_DecrRefCount(pScript);
1844 dbEvalFinalize(p);
1845 Tcl_Free((char *)p);
1846
1847 if( rc==TCL_OK || rc==TCL_BREAK ){
1848 Tcl_ResetResult(interp);
1849 rc = TCL_OK;
1850 }
1851 return rc;
danielk19778e556522007-11-13 10:30:24 +00001852}
1853
tpoindex1067fe12004-12-17 15:41:11 +00001854/*
mistachkinb56660f2016-07-14 21:26:09 +00001855** This function is used by the implementations of the following database
dan46c47d42011-03-01 18:42:07 +00001856** handle sub-commands:
1857**
1858** $db update_hook ?SCRIPT?
1859** $db wal_hook ?SCRIPT?
1860** $db commit_hook ?SCRIPT?
1861** $db preupdate hook ?SCRIPT?
1862*/
1863static void DbHookCmd(
1864 Tcl_Interp *interp, /* Tcl interpreter */
1865 SqliteDb *pDb, /* Database handle */
1866 Tcl_Obj *pArg, /* SCRIPT argument (or NULL) */
1867 Tcl_Obj **ppHook /* Pointer to member of SqliteDb */
1868){
1869 sqlite3 *db = pDb->db;
1870
1871 if( *ppHook ){
1872 Tcl_SetObjResult(interp, *ppHook);
1873 if( pArg ){
1874 Tcl_DecrRefCount(*ppHook);
1875 *ppHook = 0;
1876 }
1877 }
1878 if( pArg ){
1879 assert( !(*ppHook) );
1880 if( Tcl_GetCharLength(pArg)>0 ){
1881 *ppHook = pArg;
1882 Tcl_IncrRefCount(*ppHook);
1883 }
1884 }
1885
drh9b1c62d2011-03-30 21:04:43 +00001886#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00001887 sqlite3_preupdate_hook(db, (pDb->pPreUpdateHook?DbPreUpdateHandler:0), pDb);
drh9b1c62d2011-03-30 21:04:43 +00001888#endif
dan46c47d42011-03-01 18:42:07 +00001889 sqlite3_update_hook(db, (pDb->pUpdateHook?DbUpdateHandler:0), pDb);
1890 sqlite3_rollback_hook(db, (pDb->pRollbackHook?DbRollbackHandler:0), pDb);
1891 sqlite3_wal_hook(db, (pDb->pWalHook?DbWalHandler:0), pDb);
1892}
1893
1894/*
drh75897232000-05-29 14:26:00 +00001895** The "sqlite" command below creates a new Tcl command for each
1896** connection it opens to an SQLite database. This routine is invoked
1897** whenever one of those connection-specific commands is executed
1898** in Tcl. For example, if you run Tcl code like this:
1899**
drh9bb575f2004-09-06 17:24:11 +00001900** sqlite3 db1 "my_database"
drh75897232000-05-29 14:26:00 +00001901** db1 close
1902**
1903** The first command opens a connection to the "my_database" database
1904** and calls that connection "db1". The second command causes this
1905** subroutine to be invoked.
1906*/
mistachkin7617e4a2016-07-28 17:11:20 +00001907static int SQLITE_TCLAPI DbObjCmd(
1908 void *cd,
1909 Tcl_Interp *interp,
1910 int objc,
1911 Tcl_Obj *const*objv
1912){
drhbec3f402000-08-04 13:49:02 +00001913 SqliteDb *pDb = (SqliteDb*)cd;
drh6d313162000-09-21 13:01:35 +00001914 int choice;
drh22fbcb82004-02-01 01:22:50 +00001915 int rc = TCL_OK;
drh0de8c112002-07-06 16:32:14 +00001916 static const char *DB_strs[] = {
drhc06ede12019-02-28 17:29:19 +00001917 "authorizer", "backup", "bind_fallback",
1918 "busy", "cache", "changes",
1919 "close", "collate", "collation_needed",
1920 "commit_hook", "complete", "copy",
1921 "deserialize", "enable_load_extension", "errorcode",
1922 "eval", "exists", "function",
1923 "incrblob", "interrupt", "last_insert_rowid",
1924 "nullvalue", "onecolumn", "preupdate",
1925 "profile", "progress", "rekey",
1926 "restore", "rollback_hook", "serialize",
1927 "status", "timeout", "total_changes",
1928 "trace", "trace_v2", "transaction",
1929 "unlock_notify", "update_hook", "version",
1930 "wal_hook", 0
drh6d313162000-09-21 13:01:35 +00001931 };
drh411995d2002-06-25 19:31:18 +00001932 enum DB_enum {
drhc06ede12019-02-28 17:29:19 +00001933 DB_AUTHORIZER, DB_BACKUP, DB_BIND_FALLBACK,
1934 DB_BUSY, DB_CACHE, DB_CHANGES,
1935 DB_CLOSE, DB_COLLATE, DB_COLLATION_NEEDED,
1936 DB_COMMIT_HOOK, DB_COMPLETE, DB_COPY,
1937 DB_DESERIALIZE, DB_ENABLE_LOAD_EXTENSION,DB_ERRORCODE,
1938 DB_EVAL, DB_EXISTS, DB_FUNCTION,
1939 DB_INCRBLOB, DB_INTERRUPT, DB_LAST_INSERT_ROWID,
1940 DB_NULLVALUE, DB_ONECOLUMN, DB_PREUPDATE,
1941 DB_PROFILE, DB_PROGRESS, DB_REKEY,
1942 DB_RESTORE, DB_ROLLBACK_HOOK, DB_SERIALIZE,
1943 DB_STATUS, DB_TIMEOUT, DB_TOTAL_CHANGES,
1944 DB_TRACE, DB_TRACE_V2, DB_TRANSACTION,
1945 DB_UNLOCK_NOTIFY, DB_UPDATE_HOOK, DB_VERSION,
1946 DB_WAL_HOOK
drh6d313162000-09-21 13:01:35 +00001947 };
tpoindex1067fe12004-12-17 15:41:11 +00001948 /* don't leave trailing commas on DB_enum, it confuses the AIX xlc compiler */
drh6d313162000-09-21 13:01:35 +00001949
1950 if( objc<2 ){
1951 Tcl_WrongNumArgs(interp, 1, objv, "SUBCOMMAND ...");
drh75897232000-05-29 14:26:00 +00001952 return TCL_ERROR;
1953 }
drh411995d2002-06-25 19:31:18 +00001954 if( Tcl_GetIndexFromObj(interp, objv[1], DB_strs, "option", 0, &choice) ){
drh6d313162000-09-21 13:01:35 +00001955 return TCL_ERROR;
1956 }
1957
drh411995d2002-06-25 19:31:18 +00001958 switch( (enum DB_enum)choice ){
drh75897232000-05-29 14:26:00 +00001959
drhe22a3342003-04-22 20:30:37 +00001960 /* $db authorizer ?CALLBACK?
1961 **
1962 ** Invoke the given callback to authorize each SQL operation as it is
1963 ** compiled. 5 arguments are appended to the callback before it is
1964 ** invoked:
1965 **
1966 ** (1) The authorization type (ex: SQLITE_CREATE_TABLE, SQLITE_INSERT, ...)
1967 ** (2) First descriptive name (depends on authorization type)
1968 ** (3) Second descriptive name
1969 ** (4) Name of the database (ex: "main", "temp")
1970 ** (5) Name of trigger that is doing the access
1971 **
1972 ** The callback should return on of the following strings: SQLITE_OK,
1973 ** SQLITE_IGNORE, or SQLITE_DENY. Any other return value is an error.
1974 **
1975 ** If this method is invoked with no arguments, the current authorization
1976 ** callback string is returned.
1977 */
1978 case DB_AUTHORIZER: {
drh1211de32004-07-26 12:24:22 +00001979#ifdef SQLITE_OMIT_AUTHORIZATION
drha198f2b2014-02-07 19:26:13 +00001980 Tcl_AppendResult(interp, "authorization not available in this build",
1981 (char*)0);
drh1211de32004-07-26 12:24:22 +00001982 return TCL_ERROR;
1983#else
drhe22a3342003-04-22 20:30:37 +00001984 if( objc>3 ){
1985 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drh0f14e2e2004-06-29 12:39:08 +00001986 return TCL_ERROR;
drhe22a3342003-04-22 20:30:37 +00001987 }else if( objc==2 ){
drhb5a20d32003-04-23 12:25:23 +00001988 if( pDb->zAuth ){
drha198f2b2014-02-07 19:26:13 +00001989 Tcl_AppendResult(interp, pDb->zAuth, (char*)0);
drhe22a3342003-04-22 20:30:37 +00001990 }
1991 }else{
1992 char *zAuth;
1993 int len;
1994 if( pDb->zAuth ){
1995 Tcl_Free(pDb->zAuth);
1996 }
1997 zAuth = Tcl_GetStringFromObj(objv[2], &len);
1998 if( zAuth && len>0 ){
1999 pDb->zAuth = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002000 memcpy(pDb->zAuth, zAuth, len+1);
drhe22a3342003-04-22 20:30:37 +00002001 }else{
2002 pDb->zAuth = 0;
2003 }
drhe22a3342003-04-22 20:30:37 +00002004 if( pDb->zAuth ){
drh32c6a482014-09-11 13:44:52 +00002005 typedef int (*sqlite3_auth_cb)(
2006 void*,int,const char*,const char*,
2007 const char*,const char*);
drhe22a3342003-04-22 20:30:37 +00002008 pDb->interp = interp;
drh32c6a482014-09-11 13:44:52 +00002009 sqlite3_set_authorizer(pDb->db,(sqlite3_auth_cb)auth_callback,pDb);
drhe22a3342003-04-22 20:30:37 +00002010 }else{
danielk19776f8a5032004-05-10 10:34:51 +00002011 sqlite3_set_authorizer(pDb->db, 0, 0);
drhe22a3342003-04-22 20:30:37 +00002012 }
drhe22a3342003-04-22 20:30:37 +00002013 }
drh1211de32004-07-26 12:24:22 +00002014#endif
drhe22a3342003-04-22 20:30:37 +00002015 break;
2016 }
2017
drhdc2c4912009-02-04 22:46:47 +00002018 /* $db backup ?DATABASE? FILENAME
2019 **
2020 ** Open or create a database file named FILENAME. Transfer the
2021 ** content of local database DATABASE (default: "main") into the
2022 ** FILENAME database.
2023 */
2024 case DB_BACKUP: {
2025 const char *zDestFile;
2026 const char *zSrcDb;
2027 sqlite3 *pDest;
2028 sqlite3_backup *pBackup;
2029
2030 if( objc==3 ){
2031 zSrcDb = "main";
2032 zDestFile = Tcl_GetString(objv[2]);
2033 }else if( objc==4 ){
2034 zSrcDb = Tcl_GetString(objv[2]);
2035 zDestFile = Tcl_GetString(objv[3]);
2036 }else{
2037 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? FILENAME");
2038 return TCL_ERROR;
2039 }
drh147ef392016-01-22 23:17:51 +00002040 rc = sqlite3_open_v2(zDestFile, &pDest,
2041 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE| pDb->openFlags, 0);
drhdc2c4912009-02-04 22:46:47 +00002042 if( rc!=SQLITE_OK ){
2043 Tcl_AppendResult(interp, "cannot open target database: ",
2044 sqlite3_errmsg(pDest), (char*)0);
2045 sqlite3_close(pDest);
2046 return TCL_ERROR;
2047 }
2048 pBackup = sqlite3_backup_init(pDest, "main", pDb->db, zSrcDb);
2049 if( pBackup==0 ){
2050 Tcl_AppendResult(interp, "backup failed: ",
2051 sqlite3_errmsg(pDest), (char*)0);
2052 sqlite3_close(pDest);
2053 return TCL_ERROR;
2054 }
2055 while( (rc = sqlite3_backup_step(pBackup,100))==SQLITE_OK ){}
2056 sqlite3_backup_finish(pBackup);
2057 if( rc==SQLITE_DONE ){
2058 rc = TCL_OK;
2059 }else{
2060 Tcl_AppendResult(interp, "backup failed: ",
2061 sqlite3_errmsg(pDest), (char*)0);
2062 rc = TCL_ERROR;
2063 }
2064 sqlite3_close(pDest);
2065 break;
2066 }
2067
drhc06ede12019-02-28 17:29:19 +00002068 /* $db bind_fallback ?CALLBACK?
2069 **
2070 ** When resolving bind parameters in an SQL statement, if the parameter
2071 ** cannot be associated with a TCL variable then invoke CALLBACK with a
2072 ** single argument that is the name of the parameter and use the return
2073 ** value of the CALLBACK as the binding. If CALLBACK returns something
2074 ** other than TCL_OK or TCL_ERROR then bind a NULL.
2075 **
2076 ** If CALLBACK is an empty string, then revert to the default behavior
2077 ** which is to set the binding to NULL.
2078 **
2079 ** If CALLBACK returns an error, that causes the statement execution to
2080 ** abort. Hence, to configure a connection so that it throws an error
2081 ** on an attempt to bind an unknown variable, do something like this:
2082 **
2083 ** proc bind_error {name} {error "no such variable: $name"}
2084 ** db bind_fallback bind_error
2085 */
2086 case DB_BIND_FALLBACK: {
2087 if( objc>3 ){
2088 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2089 return TCL_ERROR;
2090 }else if( objc==2 ){
2091 if( pDb->zBindFallback ){
2092 Tcl_AppendResult(interp, pDb->zBindFallback, (char*)0);
2093 }
2094 }else{
2095 char *zCallback;
2096 int len;
2097 if( pDb->zBindFallback ){
2098 Tcl_Free(pDb->zBindFallback);
2099 }
2100 zCallback = Tcl_GetStringFromObj(objv[2], &len);
2101 if( zCallback && len>0 ){
2102 pDb->zBindFallback = Tcl_Alloc( len + 1 );
2103 memcpy(pDb->zBindFallback, zCallback, len+1);
2104 }else{
2105 pDb->zBindFallback = 0;
2106 }
2107 }
2108 break;
2109 }
2110
drhbec3f402000-08-04 13:49:02 +00002111 /* $db busy ?CALLBACK?
2112 **
2113 ** Invoke the given callback if an SQL statement attempts to open
2114 ** a locked database file.
2115 */
drh6d313162000-09-21 13:01:35 +00002116 case DB_BUSY: {
2117 if( objc>3 ){
2118 Tcl_WrongNumArgs(interp, 2, objv, "CALLBACK");
drhbec3f402000-08-04 13:49:02 +00002119 return TCL_ERROR;
drh6d313162000-09-21 13:01:35 +00002120 }else if( objc==2 ){
drhbec3f402000-08-04 13:49:02 +00002121 if( pDb->zBusy ){
drha198f2b2014-02-07 19:26:13 +00002122 Tcl_AppendResult(interp, pDb->zBusy, (char*)0);
drhbec3f402000-08-04 13:49:02 +00002123 }
2124 }else{
drh6d313162000-09-21 13:01:35 +00002125 char *zBusy;
2126 int len;
drhbec3f402000-08-04 13:49:02 +00002127 if( pDb->zBusy ){
2128 Tcl_Free(pDb->zBusy);
drhbec3f402000-08-04 13:49:02 +00002129 }
drh6d313162000-09-21 13:01:35 +00002130 zBusy = Tcl_GetStringFromObj(objv[2], &len);
2131 if( zBusy && len>0 ){
2132 pDb->zBusy = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002133 memcpy(pDb->zBusy, zBusy, len+1);
drh6d313162000-09-21 13:01:35 +00002134 }else{
2135 pDb->zBusy = 0;
drhbec3f402000-08-04 13:49:02 +00002136 }
2137 if( pDb->zBusy ){
2138 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +00002139 sqlite3_busy_handler(pDb->db, DbBusyHandler, pDb);
drh6d313162000-09-21 13:01:35 +00002140 }else{
danielk19776f8a5032004-05-10 10:34:51 +00002141 sqlite3_busy_handler(pDb->db, 0, 0);
drhbec3f402000-08-04 13:49:02 +00002142 }
2143 }
drh6d313162000-09-21 13:01:35 +00002144 break;
2145 }
drhbec3f402000-08-04 13:49:02 +00002146
drhfb7e7652005-01-24 00:28:42 +00002147 /* $db cache flush
2148 ** $db cache size n
2149 **
2150 ** Flush the prepared statement cache, or set the maximum number of
2151 ** cached statements.
2152 */
2153 case DB_CACHE: {
2154 char *subCmd;
2155 int n;
2156
2157 if( objc<=2 ){
2158 Tcl_WrongNumArgs(interp, 1, objv, "cache option ?arg?");
2159 return TCL_ERROR;
2160 }
2161 subCmd = Tcl_GetStringFromObj( objv[2], 0 );
2162 if( *subCmd=='f' && strcmp(subCmd,"flush")==0 ){
2163 if( objc!=3 ){
2164 Tcl_WrongNumArgs(interp, 2, objv, "flush");
2165 return TCL_ERROR;
2166 }else{
2167 flushStmtCache( pDb );
2168 }
2169 }else if( *subCmd=='s' && strcmp(subCmd,"size")==0 ){
2170 if( objc!=4 ){
2171 Tcl_WrongNumArgs(interp, 2, objv, "size n");
2172 return TCL_ERROR;
2173 }else{
2174 if( TCL_ERROR==Tcl_GetIntFromObj(interp, objv[3], &n) ){
mistachkinb56660f2016-07-14 21:26:09 +00002175 Tcl_AppendResult( interp, "cannot convert \"",
drha198f2b2014-02-07 19:26:13 +00002176 Tcl_GetStringFromObj(objv[3],0), "\" to integer", (char*)0);
drhfb7e7652005-01-24 00:28:42 +00002177 return TCL_ERROR;
2178 }else{
2179 if( n<0 ){
2180 flushStmtCache( pDb );
2181 n = 0;
2182 }else if( n>MAX_PREPARED_STMTS ){
2183 n = MAX_PREPARED_STMTS;
2184 }
2185 pDb->maxStmt = n;
2186 }
2187 }
2188 }else{
mistachkinb56660f2016-07-14 21:26:09 +00002189 Tcl_AppendResult( interp, "bad option \"",
drha198f2b2014-02-07 19:26:13 +00002190 Tcl_GetStringFromObj(objv[2],0), "\": must be flush or size",
2191 (char*)0);
drhfb7e7652005-01-24 00:28:42 +00002192 return TCL_ERROR;
2193 }
2194 break;
2195 }
2196
danielk1977b28af712004-06-21 06:50:26 +00002197 /* $db changes
drhc8d30ac2002-04-12 10:08:59 +00002198 **
2199 ** Return the number of rows that were modified, inserted, or deleted by
mistachkinb56660f2016-07-14 21:26:09 +00002200 ** the most recent INSERT, UPDATE or DELETE statement, not including
danielk1977b28af712004-06-21 06:50:26 +00002201 ** any changes made by trigger programs.
drhc8d30ac2002-04-12 10:08:59 +00002202 */
2203 case DB_CHANGES: {
2204 Tcl_Obj *pResult;
drhc8d30ac2002-04-12 10:08:59 +00002205 if( objc!=2 ){
2206 Tcl_WrongNumArgs(interp, 2, objv, "");
2207 return TCL_ERROR;
2208 }
drhc8d30ac2002-04-12 10:08:59 +00002209 pResult = Tcl_GetObjResult(interp);
danielk1977b28af712004-06-21 06:50:26 +00002210 Tcl_SetIntObj(pResult, sqlite3_changes(pDb->db));
rdcf146a772004-02-25 22:51:06 +00002211 break;
2212 }
2213
drh75897232000-05-29 14:26:00 +00002214 /* $db close
2215 **
2216 ** Shutdown the database
2217 */
drh6d313162000-09-21 13:01:35 +00002218 case DB_CLOSE: {
2219 Tcl_DeleteCommand(interp, Tcl_GetStringFromObj(objv[0], 0));
2220 break;
2221 }
drh75897232000-05-29 14:26:00 +00002222
drh0f14e2e2004-06-29 12:39:08 +00002223 /*
2224 ** $db collate NAME SCRIPT
2225 **
2226 ** Create a new SQL collation function called NAME. Whenever
2227 ** that function is called, invoke SCRIPT to evaluate the function.
2228 */
2229 case DB_COLLATE: {
2230 SqlCollate *pCollate;
2231 char *zName;
2232 char *zScript;
2233 int nScript;
2234 if( objc!=4 ){
2235 Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
2236 return TCL_ERROR;
2237 }
2238 zName = Tcl_GetStringFromObj(objv[2], 0);
2239 zScript = Tcl_GetStringFromObj(objv[3], &nScript);
2240 pCollate = (SqlCollate*)Tcl_Alloc( sizeof(*pCollate) + nScript + 1 );
2241 if( pCollate==0 ) return TCL_ERROR;
2242 pCollate->interp = interp;
2243 pCollate->pNext = pDb->pCollate;
2244 pCollate->zScript = (char*)&pCollate[1];
2245 pDb->pCollate = pCollate;
drh5bb3eb92007-05-04 13:15:55 +00002246 memcpy(pCollate->zScript, zScript, nScript+1);
mistachkinb56660f2016-07-14 21:26:09 +00002247 if( sqlite3_create_collation(pDb->db, zName, SQLITE_UTF8,
drh0f14e2e2004-06-29 12:39:08 +00002248 pCollate, tclSqlCollate) ){
danielk19779636c4e2005-01-25 04:27:54 +00002249 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drh0f14e2e2004-06-29 12:39:08 +00002250 return TCL_ERROR;
2251 }
2252 break;
2253 }
2254
2255 /*
2256 ** $db collation_needed SCRIPT
2257 **
2258 ** Create a new SQL collation function called NAME. Whenever
2259 ** that function is called, invoke SCRIPT to evaluate the function.
2260 */
2261 case DB_COLLATION_NEEDED: {
2262 if( objc!=3 ){
2263 Tcl_WrongNumArgs(interp, 2, objv, "SCRIPT");
2264 return TCL_ERROR;
2265 }
2266 if( pDb->pCollateNeeded ){
2267 Tcl_DecrRefCount(pDb->pCollateNeeded);
2268 }
2269 pDb->pCollateNeeded = Tcl_DuplicateObj(objv[2]);
2270 Tcl_IncrRefCount(pDb->pCollateNeeded);
2271 sqlite3_collation_needed(pDb->db, pDb, tclCollateNeeded);
2272 break;
2273 }
2274
drh19e2d372005-08-29 23:00:03 +00002275 /* $db commit_hook ?CALLBACK?
2276 **
2277 ** Invoke the given callback just before committing every SQL transaction.
2278 ** If the callback throws an exception or returns non-zero, then the
2279 ** transaction is aborted. If CALLBACK is an empty string, the callback
2280 ** is disabled.
2281 */
2282 case DB_COMMIT_HOOK: {
2283 if( objc>3 ){
2284 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2285 return TCL_ERROR;
2286 }else if( objc==2 ){
2287 if( pDb->zCommit ){
drha198f2b2014-02-07 19:26:13 +00002288 Tcl_AppendResult(interp, pDb->zCommit, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002289 }
2290 }else{
mistachkin6ef5e122014-01-24 17:03:55 +00002291 const char *zCommit;
drh19e2d372005-08-29 23:00:03 +00002292 int len;
2293 if( pDb->zCommit ){
2294 Tcl_Free(pDb->zCommit);
2295 }
2296 zCommit = Tcl_GetStringFromObj(objv[2], &len);
2297 if( zCommit && len>0 ){
2298 pDb->zCommit = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002299 memcpy(pDb->zCommit, zCommit, len+1);
drh19e2d372005-08-29 23:00:03 +00002300 }else{
2301 pDb->zCommit = 0;
2302 }
2303 if( pDb->zCommit ){
2304 pDb->interp = interp;
2305 sqlite3_commit_hook(pDb->db, DbCommitHandler, pDb);
2306 }else{
2307 sqlite3_commit_hook(pDb->db, 0, 0);
2308 }
2309 }
2310 break;
2311 }
2312
drh75897232000-05-29 14:26:00 +00002313 /* $db complete SQL
2314 **
2315 ** Return TRUE if SQL is a complete SQL statement. Return FALSE if
2316 ** additional lines of input are needed. This is similar to the
2317 ** built-in "info complete" command of Tcl.
2318 */
drh6d313162000-09-21 13:01:35 +00002319 case DB_COMPLETE: {
drhccae6022005-02-26 17:31:26 +00002320#ifndef SQLITE_OMIT_COMPLETE
drh6d313162000-09-21 13:01:35 +00002321 Tcl_Obj *pResult;
2322 int isComplete;
2323 if( objc!=3 ){
2324 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
drh75897232000-05-29 14:26:00 +00002325 return TCL_ERROR;
2326 }
danielk19776f8a5032004-05-10 10:34:51 +00002327 isComplete = sqlite3_complete( Tcl_GetStringFromObj(objv[2], 0) );
drh6d313162000-09-21 13:01:35 +00002328 pResult = Tcl_GetObjResult(interp);
2329 Tcl_SetBooleanObj(pResult, isComplete);
drhccae6022005-02-26 17:31:26 +00002330#endif
drh6d313162000-09-21 13:01:35 +00002331 break;
2332 }
drhdcd997e2003-01-31 17:21:49 +00002333
drh19e2d372005-08-29 23:00:03 +00002334 /* $db copy conflict-algorithm table filename ?SEPARATOR? ?NULLINDICATOR?
2335 **
2336 ** Copy data into table from filename, optionally using SEPARATOR
2337 ** as column separators. If a column contains a null string, or the
2338 ** value of NULLINDICATOR, a NULL is inserted for the column.
2339 ** conflict-algorithm is one of the sqlite conflict algorithms:
2340 ** rollback, abort, fail, ignore, replace
2341 ** On success, return the number of lines processed, not necessarily same
2342 ** as 'db changes' due to conflict-algorithm selected.
2343 **
2344 ** This code is basically an implementation/enhancement of
2345 ** the sqlite3 shell.c ".import" command.
2346 **
2347 ** This command usage is equivalent to the sqlite2.x COPY statement,
2348 ** which imports file data into a table using the PostgreSQL COPY file format:
2349 ** $db copy $conflit_algo $table_name $filename \t \\N
2350 */
2351 case DB_COPY: {
2352 char *zTable; /* Insert data into this table */
2353 char *zFile; /* The file from which to extract data */
2354 char *zConflict; /* The conflict algorithm to use */
2355 sqlite3_stmt *pStmt; /* A statement */
drh19e2d372005-08-29 23:00:03 +00002356 int nCol; /* Number of columns in the table */
2357 int nByte; /* Number of bytes in an SQL string */
2358 int i, j; /* Loop counters */
2359 int nSep; /* Number of bytes in zSep[] */
2360 int nNull; /* Number of bytes in zNull[] */
2361 char *zSql; /* An SQL statement */
2362 char *zLine; /* A single line of input from the file */
2363 char **azCol; /* zLine[] broken up into columns */
mistachkin6ef5e122014-01-24 17:03:55 +00002364 const char *zCommit; /* How to commit changes */
drh19e2d372005-08-29 23:00:03 +00002365 FILE *in; /* The input file */
2366 int lineno = 0; /* Line number of input file */
2367 char zLineNum[80]; /* Line number print buffer */
2368 Tcl_Obj *pResult; /* interp result */
2369
mistachkin6ef5e122014-01-24 17:03:55 +00002370 const char *zSep;
2371 const char *zNull;
drh19e2d372005-08-29 23:00:03 +00002372 if( objc<5 || objc>7 ){
mistachkinb56660f2016-07-14 21:26:09 +00002373 Tcl_WrongNumArgs(interp, 2, objv,
drh19e2d372005-08-29 23:00:03 +00002374 "CONFLICT-ALGORITHM TABLE FILENAME ?SEPARATOR? ?NULLINDICATOR?");
2375 return TCL_ERROR;
2376 }
2377 if( objc>=6 ){
2378 zSep = Tcl_GetStringFromObj(objv[5], 0);
2379 }else{
2380 zSep = "\t";
2381 }
2382 if( objc>=7 ){
2383 zNull = Tcl_GetStringFromObj(objv[6], 0);
2384 }else{
2385 zNull = "";
2386 }
2387 zConflict = Tcl_GetStringFromObj(objv[2], 0);
2388 zTable = Tcl_GetStringFromObj(objv[3], 0);
2389 zFile = Tcl_GetStringFromObj(objv[4], 0);
drh4f21c4a2008-12-10 22:15:00 +00002390 nSep = strlen30(zSep);
2391 nNull = strlen30(zNull);
drh19e2d372005-08-29 23:00:03 +00002392 if( nSep==0 ){
drha198f2b2014-02-07 19:26:13 +00002393 Tcl_AppendResult(interp,"Error: non-null separator required for copy",
2394 (char*)0);
drh19e2d372005-08-29 23:00:03 +00002395 return TCL_ERROR;
2396 }
drh3e59c012008-09-23 10:12:13 +00002397 if(strcmp(zConflict, "rollback") != 0 &&
2398 strcmp(zConflict, "abort" ) != 0 &&
2399 strcmp(zConflict, "fail" ) != 0 &&
2400 strcmp(zConflict, "ignore" ) != 0 &&
2401 strcmp(zConflict, "replace" ) != 0 ) {
mistachkinb56660f2016-07-14 21:26:09 +00002402 Tcl_AppendResult(interp, "Error: \"", zConflict,
drh19e2d372005-08-29 23:00:03 +00002403 "\", conflict-algorithm must be one of: rollback, "
drha198f2b2014-02-07 19:26:13 +00002404 "abort, fail, ignore, or replace", (char*)0);
drh19e2d372005-08-29 23:00:03 +00002405 return TCL_ERROR;
2406 }
2407 zSql = sqlite3_mprintf("SELECT * FROM '%q'", zTable);
2408 if( zSql==0 ){
drha198f2b2014-02-07 19:26:13 +00002409 Tcl_AppendResult(interp, "Error: no such table: ", zTable, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002410 return TCL_ERROR;
2411 }
drh4f21c4a2008-12-10 22:15:00 +00002412 nByte = strlen30(zSql);
drh3e701a12007-02-01 01:53:44 +00002413 rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
drh19e2d372005-08-29 23:00:03 +00002414 sqlite3_free(zSql);
2415 if( rc ){
drha198f2b2014-02-07 19:26:13 +00002416 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002417 nCol = 0;
2418 }else{
2419 nCol = sqlite3_column_count(pStmt);
2420 }
2421 sqlite3_finalize(pStmt);
2422 if( nCol==0 ) {
2423 return TCL_ERROR;
2424 }
2425 zSql = malloc( nByte + 50 + nCol*2 );
2426 if( zSql==0 ) {
drha198f2b2014-02-07 19:26:13 +00002427 Tcl_AppendResult(interp, "Error: can't malloc()", (char*)0);
drh19e2d372005-08-29 23:00:03 +00002428 return TCL_ERROR;
2429 }
2430 sqlite3_snprintf(nByte+50, zSql, "INSERT OR %q INTO '%q' VALUES(?",
2431 zConflict, zTable);
drh4f21c4a2008-12-10 22:15:00 +00002432 j = strlen30(zSql);
drh19e2d372005-08-29 23:00:03 +00002433 for(i=1; i<nCol; i++){
2434 zSql[j++] = ',';
2435 zSql[j++] = '?';
2436 }
2437 zSql[j++] = ')';
2438 zSql[j] = 0;
drh3e701a12007-02-01 01:53:44 +00002439 rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
drh19e2d372005-08-29 23:00:03 +00002440 free(zSql);
2441 if( rc ){
drha198f2b2014-02-07 19:26:13 +00002442 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002443 sqlite3_finalize(pStmt);
2444 return TCL_ERROR;
2445 }
2446 in = fopen(zFile, "rb");
2447 if( in==0 ){
drhea8f0a12017-01-12 11:50:08 +00002448 Tcl_AppendResult(interp, "Error: cannot open file: ", zFile, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002449 sqlite3_finalize(pStmt);
2450 return TCL_ERROR;
2451 }
2452 azCol = malloc( sizeof(azCol[0])*(nCol+1) );
2453 if( azCol==0 ) {
drha198f2b2014-02-07 19:26:13 +00002454 Tcl_AppendResult(interp, "Error: can't malloc()", (char*)0);
drh43617e92006-03-06 20:55:46 +00002455 fclose(in);
drh19e2d372005-08-29 23:00:03 +00002456 return TCL_ERROR;
2457 }
drh37527852006-03-16 16:19:56 +00002458 (void)sqlite3_exec(pDb->db, "BEGIN", 0, 0, 0);
drh19e2d372005-08-29 23:00:03 +00002459 zCommit = "COMMIT";
2460 while( (zLine = local_getline(0, in))!=0 ){
2461 char *z;
drh19e2d372005-08-29 23:00:03 +00002462 lineno++;
2463 azCol[0] = zLine;
2464 for(i=0, z=zLine; *z; z++){
2465 if( *z==zSep[0] && strncmp(z, zSep, nSep)==0 ){
2466 *z = 0;
2467 i++;
2468 if( i<nCol ){
2469 azCol[i] = &z[nSep];
2470 z += nSep-1;
2471 }
2472 }
2473 }
2474 if( i+1!=nCol ){
2475 char *zErr;
drh4f21c4a2008-12-10 22:15:00 +00002476 int nErr = strlen30(zFile) + 200;
drh5bb3eb92007-05-04 13:15:55 +00002477 zErr = malloc(nErr);
drhc1f44942006-05-10 14:39:13 +00002478 if( zErr ){
drh5bb3eb92007-05-04 13:15:55 +00002479 sqlite3_snprintf(nErr, zErr,
drhc1f44942006-05-10 14:39:13 +00002480 "Error: %s line %d: expected %d columns of data but found %d",
2481 zFile, lineno, nCol, i+1);
drha198f2b2014-02-07 19:26:13 +00002482 Tcl_AppendResult(interp, zErr, (char*)0);
drhc1f44942006-05-10 14:39:13 +00002483 free(zErr);
2484 }
drh19e2d372005-08-29 23:00:03 +00002485 zCommit = "ROLLBACK";
2486 break;
2487 }
2488 for(i=0; i<nCol; i++){
2489 /* check for null data, if so, bind as null */
drhea678832008-12-10 19:26:22 +00002490 if( (nNull>0 && strcmp(azCol[i], zNull)==0)
mistachkinb56660f2016-07-14 21:26:09 +00002491 || strlen30(azCol[i])==0
drhea678832008-12-10 19:26:22 +00002492 ){
drh19e2d372005-08-29 23:00:03 +00002493 sqlite3_bind_null(pStmt, i+1);
2494 }else{
2495 sqlite3_bind_text(pStmt, i+1, azCol[i], -1, SQLITE_STATIC);
2496 }
2497 }
2498 sqlite3_step(pStmt);
2499 rc = sqlite3_reset(pStmt);
2500 free(zLine);
2501 if( rc!=SQLITE_OK ){
drha198f2b2014-02-07 19:26:13 +00002502 Tcl_AppendResult(interp,"Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002503 zCommit = "ROLLBACK";
2504 break;
2505 }
2506 }
2507 free(azCol);
2508 fclose(in);
2509 sqlite3_finalize(pStmt);
drh37527852006-03-16 16:19:56 +00002510 (void)sqlite3_exec(pDb->db, zCommit, 0, 0, 0);
drh19e2d372005-08-29 23:00:03 +00002511
2512 if( zCommit[0] == 'C' ){
2513 /* success, set result as number of lines processed */
2514 pResult = Tcl_GetObjResult(interp);
2515 Tcl_SetIntObj(pResult, lineno);
2516 rc = TCL_OK;
2517 }else{
2518 /* failure, append lineno where failed */
drh5bb3eb92007-05-04 13:15:55 +00002519 sqlite3_snprintf(sizeof(zLineNum), zLineNum,"%d",lineno);
drha198f2b2014-02-07 19:26:13 +00002520 Tcl_AppendResult(interp,", failed while processing line: ",zLineNum,
2521 (char*)0);
drh19e2d372005-08-29 23:00:03 +00002522 rc = TCL_ERROR;
2523 }
2524 break;
2525 }
2526
drhdcd997e2003-01-31 17:21:49 +00002527 /*
drh6ca64482019-01-22 16:06:20 +00002528 ** $db deserialize ?-maxsize N? ?-readonly BOOL? ?DATABASE? VALUE
drhcb7d5412018-01-03 16:49:52 +00002529 **
2530 ** Reopen DATABASE (default "main") using the content in $VALUE
2531 */
2532 case DB_DESERIALIZE: {
drh9c6396e2018-03-06 21:43:19 +00002533#ifndef SQLITE_ENABLE_DESERIALIZE
drh3ec86652018-01-03 19:03:31 +00002534 Tcl_AppendResult(interp, "MEMDB not available in this build",
2535 (char*)0);
2536 rc = TCL_ERROR;
2537#else
drh6ca64482019-01-22 16:06:20 +00002538 const char *zSchema = 0;
2539 Tcl_Obj *pValue = 0;
drh3ec86652018-01-03 19:03:31 +00002540 unsigned char *pBA;
2541 unsigned char *pData;
2542 int len, xrc;
drh6ca64482019-01-22 16:06:20 +00002543 sqlite3_int64 mxSize = 0;
2544 int i;
2545 int isReadonly = 0;
2546
2547
2548 if( objc<3 ){
drh3ec86652018-01-03 19:03:31 +00002549 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? VALUE");
2550 rc = TCL_ERROR;
2551 break;
2552 }
drh6ca64482019-01-22 16:06:20 +00002553 for(i=2; i<objc-1; i++){
2554 const char *z = Tcl_GetString(objv[i]);
2555 if( strcmp(z,"-maxsize")==0 && i<objc-2 ){
2556 rc = Tcl_GetWideIntFromObj(interp, objv[++i], &mxSize);
2557 if( rc ) goto deserialize_error;
2558 continue;
2559 }
2560 if( strcmp(z,"-readonly")==0 && i<objc-2 ){
2561 rc = Tcl_GetBooleanFromObj(interp, objv[++i], &isReadonly);
2562 if( rc ) goto deserialize_error;
2563 continue;
2564 }
2565 if( zSchema==0 && i==objc-2 && z[0]!='-' ){
2566 zSchema = z;
2567 continue;
2568 }
2569 Tcl_AppendResult(interp, "unknown option: ", z, (char*)0);
2570 rc = TCL_ERROR;
2571 goto deserialize_error;
2572 }
2573 pValue = objv[objc-1];
drh3ec86652018-01-03 19:03:31 +00002574 pBA = Tcl_GetByteArrayFromObj(pValue, &len);
2575 pData = sqlite3_malloc64( len );
drha5bb4352018-01-03 23:40:02 +00002576 if( pData==0 && len>0 ){
drh3ec86652018-01-03 19:03:31 +00002577 Tcl_AppendResult(interp, "out of memory", (char*)0);
2578 rc = TCL_ERROR;
2579 }else{
drh6ca64482019-01-22 16:06:20 +00002580 int flags;
drha5bb4352018-01-03 23:40:02 +00002581 if( len>0 ) memcpy(pData, pBA, len);
drh6ca64482019-01-22 16:06:20 +00002582 if( isReadonly ){
2583 flags = SQLITE_DESERIALIZE_FREEONCLOSE | SQLITE_DESERIALIZE_READONLY;
2584 }else{
2585 flags = SQLITE_DESERIALIZE_FREEONCLOSE | SQLITE_DESERIALIZE_RESIZEABLE;
2586 }
2587 xrc = sqlite3_deserialize(pDb->db, zSchema, pData, len, len, flags);
drh3ec86652018-01-03 19:03:31 +00002588 if( xrc ){
2589 Tcl_AppendResult(interp, "unable to set MEMDB content", (char*)0);
2590 rc = TCL_ERROR;
2591 }
drh6ca64482019-01-22 16:06:20 +00002592 if( mxSize>0 ){
2593 sqlite3_file_control(pDb->db, zSchema,SQLITE_FCNTL_SIZE_LIMIT,&mxSize);
2594 }
drh3ec86652018-01-03 19:03:31 +00002595 }
drh6ca64482019-01-22 16:06:20 +00002596deserialize_error:
drh3ec86652018-01-03 19:03:31 +00002597#endif
drhcb7d5412018-01-03 16:49:52 +00002598 break;
2599 }
2600
2601 /*
drh41449052006-07-06 17:08:48 +00002602 ** $db enable_load_extension BOOLEAN
2603 **
2604 ** Turn the extension loading feature on or off. It if off by
2605 ** default.
2606 */
2607 case DB_ENABLE_LOAD_EXTENSION: {
drhf533acc2006-12-19 18:57:11 +00002608#ifndef SQLITE_OMIT_LOAD_EXTENSION
drh41449052006-07-06 17:08:48 +00002609 int onoff;
2610 if( objc!=3 ){
2611 Tcl_WrongNumArgs(interp, 2, objv, "BOOLEAN");
2612 return TCL_ERROR;
2613 }
2614 if( Tcl_GetBooleanFromObj(interp, objv[2], &onoff) ){
2615 return TCL_ERROR;
2616 }
2617 sqlite3_enable_load_extension(pDb->db, onoff);
2618 break;
drhf533acc2006-12-19 18:57:11 +00002619#else
2620 Tcl_AppendResult(interp, "extension loading is turned off at compile-time",
drha198f2b2014-02-07 19:26:13 +00002621 (char*)0);
drhf533acc2006-12-19 18:57:11 +00002622 return TCL_ERROR;
2623#endif
drh41449052006-07-06 17:08:48 +00002624 }
2625
2626 /*
drhdcd997e2003-01-31 17:21:49 +00002627 ** $db errorcode
2628 **
2629 ** Return the numeric error code that was returned by the most recent
danielk19776f8a5032004-05-10 10:34:51 +00002630 ** call to sqlite3_exec().
drhdcd997e2003-01-31 17:21:49 +00002631 */
2632 case DB_ERRORCODE: {
danielk1977f3ce83f2004-06-14 11:43:46 +00002633 Tcl_SetObjResult(interp, Tcl_NewIntObj(sqlite3_errcode(pDb->db)));
drhdcd997e2003-01-31 17:21:49 +00002634 break;
2635 }
dan4a4c11a2009-10-06 14:59:02 +00002636
2637 /*
2638 ** $db exists $sql
2639 ** $db onecolumn $sql
2640 **
2641 ** The onecolumn method is the equivalent of:
2642 ** lindex [$db eval $sql] 0
2643 */
mistachkinb56660f2016-07-14 21:26:09 +00002644 case DB_EXISTS:
dan4a4c11a2009-10-06 14:59:02 +00002645 case DB_ONECOLUMN: {
drhedc40242016-06-13 12:34:38 +00002646 Tcl_Obj *pResult = 0;
dan4a4c11a2009-10-06 14:59:02 +00002647 DbEvalContext sEval;
2648 if( objc!=3 ){
2649 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
2650 return TCL_ERROR;
2651 }
2652
drhaf38cdb2017-06-26 21:08:32 +00002653 dbEvalInit(&sEval, pDb, objv[2], 0, 0);
dan4a4c11a2009-10-06 14:59:02 +00002654 rc = dbEvalStep(&sEval);
2655 if( choice==DB_ONECOLUMN ){
2656 if( rc==TCL_OK ){
drhedc40242016-06-13 12:34:38 +00002657 pResult = dbEvalColumnValue(&sEval, 0);
dand5f12cd2011-08-18 17:47:57 +00002658 }else if( rc==TCL_BREAK ){
2659 Tcl_ResetResult(interp);
dan4a4c11a2009-10-06 14:59:02 +00002660 }
2661 }else if( rc==TCL_BREAK || rc==TCL_OK ){
drhedc40242016-06-13 12:34:38 +00002662 pResult = Tcl_NewBooleanObj(rc==TCL_OK);
dan4a4c11a2009-10-06 14:59:02 +00002663 }
2664 dbEvalFinalize(&sEval);
drhedc40242016-06-13 12:34:38 +00002665 if( pResult ) Tcl_SetObjResult(interp, pResult);
dan4a4c11a2009-10-06 14:59:02 +00002666
2667 if( rc==TCL_BREAK ){
2668 rc = TCL_OK;
2669 }
2670 break;
2671 }
mistachkinb56660f2016-07-14 21:26:09 +00002672
drh75897232000-05-29 14:26:00 +00002673 /*
drhaf38cdb2017-06-26 21:08:32 +00002674 ** $db eval ?options? $sql ?array? ?{ ...code... }?
drh75897232000-05-29 14:26:00 +00002675 **
2676 ** The SQL statement in $sql is evaluated. For each row, the values are
drhbec3f402000-08-04 13:49:02 +00002677 ** placed in elements of the array named "array" and ...code... is executed.
drh75897232000-05-29 14:26:00 +00002678 ** If "array" and "code" are omitted, then no callback is every invoked.
2679 ** If "array" is an empty string, then the values are placed in variables
2680 ** that have the same name as the fields extracted by the query.
2681 */
dan4a4c11a2009-10-06 14:59:02 +00002682 case DB_EVAL: {
drhaf38cdb2017-06-26 21:08:32 +00002683 int evalFlags = 0;
2684 const char *zOpt;
2685 while( objc>3 && (zOpt = Tcl_GetString(objv[2]))!=0 && zOpt[0]=='-' ){
2686 if( strcmp(zOpt, "-withoutnulls")==0 ){
2687 evalFlags |= SQLITE_EVAL_WITHOUTNULLS;
2688 }
2689 else{
2690 Tcl_AppendResult(interp, "unknown option: \"", zOpt, "\"", (void*)0);
2691 return TCL_ERROR;
2692 }
2693 objc--;
2694 objv++;
2695 }
dan4a4c11a2009-10-06 14:59:02 +00002696 if( objc<3 || objc>5 ){
drhaf38cdb2017-06-26 21:08:32 +00002697 Tcl_WrongNumArgs(interp, 2, objv,
2698 "?OPTIONS? SQL ?ARRAY-NAME? ?SCRIPT?");
dan4a4c11a2009-10-06 14:59:02 +00002699 return TCL_ERROR;
danielk197730ccda12004-05-27 12:11:31 +00002700 }
dan4a4c11a2009-10-06 14:59:02 +00002701
drh92febd92004-08-20 18:34:20 +00002702 if( objc==3 ){
dan4a4c11a2009-10-06 14:59:02 +00002703 DbEvalContext sEval;
2704 Tcl_Obj *pRet = Tcl_NewObj();
2705 Tcl_IncrRefCount(pRet);
drhaf38cdb2017-06-26 21:08:32 +00002706 dbEvalInit(&sEval, pDb, objv[2], 0, 0);
dan4a4c11a2009-10-06 14:59:02 +00002707 while( TCL_OK==(rc = dbEvalStep(&sEval)) ){
2708 int i;
2709 int nCol;
2710 dbEvalRowInfo(&sEval, &nCol, 0);
drh92febd92004-08-20 18:34:20 +00002711 for(i=0; i<nCol; i++){
dan4a4c11a2009-10-06 14:59:02 +00002712 Tcl_ListObjAppendElement(interp, pRet, dbEvalColumnValue(&sEval, i));
danielk197730ccda12004-05-27 12:11:31 +00002713 }
2714 }
dan4a4c11a2009-10-06 14:59:02 +00002715 dbEvalFinalize(&sEval);
drh90b6bb12004-09-13 13:16:31 +00002716 if( rc==TCL_BREAK ){
dan4a4c11a2009-10-06 14:59:02 +00002717 Tcl_SetObjResult(interp, pRet);
drh90b6bb12004-09-13 13:16:31 +00002718 rc = TCL_OK;
2719 }
drh1807ce32004-09-07 13:20:35 +00002720 Tcl_DecrRefCount(pRet);
dan4a4c11a2009-10-06 14:59:02 +00002721 }else{
mistachkin8e189222015-04-19 21:43:16 +00002722 ClientData cd2[2];
dan4a4c11a2009-10-06 14:59:02 +00002723 DbEvalContext *p;
2724 Tcl_Obj *pArray = 0;
2725 Tcl_Obj *pScript;
2726
drhaf38cdb2017-06-26 21:08:32 +00002727 if( objc>=5 && *(char *)Tcl_GetString(objv[3]) ){
dan4a4c11a2009-10-06 14:59:02 +00002728 pArray = objv[3];
2729 }
2730 pScript = objv[objc-1];
2731 Tcl_IncrRefCount(pScript);
mistachkinb56660f2016-07-14 21:26:09 +00002732
dan4a4c11a2009-10-06 14:59:02 +00002733 p = (DbEvalContext *)Tcl_Alloc(sizeof(DbEvalContext));
drhaf38cdb2017-06-26 21:08:32 +00002734 dbEvalInit(p, pDb, objv[2], pArray, evalFlags);
dan4a4c11a2009-10-06 14:59:02 +00002735
mistachkin8e189222015-04-19 21:43:16 +00002736 cd2[0] = (void *)p;
2737 cd2[1] = (void *)pScript;
2738 rc = DbEvalNextCmd(cd2, interp, TCL_OK);
danielk197730ccda12004-05-27 12:11:31 +00002739 }
danielk197730ccda12004-05-27 12:11:31 +00002740 break;
2741 }
drhbec3f402000-08-04 13:49:02 +00002742
2743 /*
dan3df30592015-03-13 08:31:54 +00002744 ** $db function NAME [-argcount N] [-deterministic] SCRIPT
drhcabb0812002-09-14 13:47:32 +00002745 **
2746 ** Create a new SQL function called NAME. Whenever that function is
2747 ** called, invoke SCRIPT to evaluate the function.
2748 */
2749 case DB_FUNCTION: {
dan3df30592015-03-13 08:31:54 +00002750 int flags = SQLITE_UTF8;
drhcabb0812002-09-14 13:47:32 +00002751 SqlFunc *pFunc;
drhd1e47332005-06-26 17:55:33 +00002752 Tcl_Obj *pScript;
drhcabb0812002-09-14 13:47:32 +00002753 char *zName;
drhe3602be2008-09-09 12:31:33 +00002754 int nArg = -1;
dan3df30592015-03-13 08:31:54 +00002755 int i;
dan89d24932019-02-27 16:38:19 +00002756 int eType = SQLITE_NULL;
dan3df30592015-03-13 08:31:54 +00002757 if( objc<4 ){
2758 Tcl_WrongNumArgs(interp, 2, objv, "NAME ?SWITCHES? SCRIPT");
2759 return TCL_ERROR;
2760 }
2761 for(i=3; i<(objc-1); i++){
2762 const char *z = Tcl_GetString(objv[i]);
drh4f21c4a2008-12-10 22:15:00 +00002763 int n = strlen30(z);
dan89d24932019-02-27 16:38:19 +00002764 if( n>1 && strncmp(z, "-argcount",n)==0 ){
dan3df30592015-03-13 08:31:54 +00002765 if( i==(objc-2) ){
drhea8f0a12017-01-12 11:50:08 +00002766 Tcl_AppendResult(interp, "option requires an argument: ", z,(char*)0);
dan3df30592015-03-13 08:31:54 +00002767 return TCL_ERROR;
2768 }
2769 if( Tcl_GetIntFromObj(interp, objv[i+1], &nArg) ) return TCL_ERROR;
drhe3602be2008-09-09 12:31:33 +00002770 if( nArg<0 ){
2771 Tcl_AppendResult(interp, "number of arguments must be non-negative",
2772 (char*)0);
2773 return TCL_ERROR;
2774 }
dan3df30592015-03-13 08:31:54 +00002775 i++;
2776 }else
dan89d24932019-02-27 16:38:19 +00002777 if( n>1 && strncmp(z, "-deterministic",n)==0 ){
dan3df30592015-03-13 08:31:54 +00002778 flags |= SQLITE_DETERMINISTIC;
dan89d24932019-02-27 16:38:19 +00002779 }else
2780 if( n>1 && strncmp(z, "-returntype", n)==0 ){
2781 const char *azType[] = {"integer", "real", "text", "blob", "any", 0};
2782 assert( SQLITE_INTEGER==1 && SQLITE_FLOAT==2 && SQLITE_TEXT==3 );
2783 assert( SQLITE_BLOB==4 && SQLITE_NULL==5 );
2784 if( i==(objc-2) ){
2785 Tcl_AppendResult(interp, "option requires an argument: ", z,(char*)0);
2786 return TCL_ERROR;
2787 }
2788 i++;
2789 if( Tcl_GetIndexFromObj(interp, objv[i], azType, "type", 0, &eType) ){
2790 return TCL_ERROR;
2791 }
2792 eType++;
dan3df30592015-03-13 08:31:54 +00002793 }else{
mistachkinb56660f2016-07-14 21:26:09 +00002794 Tcl_AppendResult(interp, "bad option \"", z,
dan89d24932019-02-27 16:38:19 +00002795 "\": must be -argcount, -deterministic or -returntype", (char*)0
dan3df30592015-03-13 08:31:54 +00002796 );
2797 return TCL_ERROR;
drhe3602be2008-09-09 12:31:33 +00002798 }
drhcabb0812002-09-14 13:47:32 +00002799 }
dan3df30592015-03-13 08:31:54 +00002800
2801 pScript = objv[objc-1];
drhcabb0812002-09-14 13:47:32 +00002802 zName = Tcl_GetStringFromObj(objv[2], 0);
drhd1e47332005-06-26 17:55:33 +00002803 pFunc = findSqlFunc(pDb, zName);
drhcabb0812002-09-14 13:47:32 +00002804 if( pFunc==0 ) return TCL_ERROR;
drhd1e47332005-06-26 17:55:33 +00002805 if( pFunc->pScript ){
2806 Tcl_DecrRefCount(pFunc->pScript);
2807 }
2808 pFunc->pScript = pScript;
2809 Tcl_IncrRefCount(pScript);
2810 pFunc->useEvalObjv = safeToUseEvalObjv(interp, pScript);
dan89d24932019-02-27 16:38:19 +00002811 pFunc->eType = eType;
dan3df30592015-03-13 08:31:54 +00002812 rc = sqlite3_create_function(pDb->db, zName, nArg, flags,
danielk1977d8123362004-06-12 09:25:12 +00002813 pFunc, tclSqlFunc, 0, 0);
drhfb7e7652005-01-24 00:28:42 +00002814 if( rc!=SQLITE_OK ){
danielk19779636c4e2005-01-25 04:27:54 +00002815 rc = TCL_ERROR;
2816 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drhfb7e7652005-01-24 00:28:42 +00002817 }
drhcabb0812002-09-14 13:47:32 +00002818 break;
2819 }
2820
2821 /*
danielk19778cbadb02007-05-03 16:31:26 +00002822 ** $db incrblob ?-readonly? ?DB? TABLE COLUMN ROWID
danielk1977b4e9af92007-05-01 17:49:49 +00002823 */
2824 case DB_INCRBLOB: {
danielk197732a0d8b2007-05-04 19:03:02 +00002825#ifdef SQLITE_OMIT_INCRBLOB
drha198f2b2014-02-07 19:26:13 +00002826 Tcl_AppendResult(interp, "incrblob not available in this build", (char*)0);
danielk197732a0d8b2007-05-04 19:03:02 +00002827 return TCL_ERROR;
2828#else
danielk19778cbadb02007-05-03 16:31:26 +00002829 int isReadonly = 0;
danielk1977b4e9af92007-05-01 17:49:49 +00002830 const char *zDb = "main";
2831 const char *zTable;
2832 const char *zColumn;
drhb3f787f2012-09-29 14:45:54 +00002833 Tcl_WideInt iRow;
danielk1977b4e9af92007-05-01 17:49:49 +00002834
danielk19778cbadb02007-05-03 16:31:26 +00002835 /* Check for the -readonly option */
2836 if( objc>3 && strcmp(Tcl_GetString(objv[2]), "-readonly")==0 ){
2837 isReadonly = 1;
2838 }
2839
2840 if( objc!=(5+isReadonly) && objc!=(6+isReadonly) ){
2841 Tcl_WrongNumArgs(interp, 2, objv, "?-readonly? ?DB? TABLE COLUMN ROWID");
danielk1977b4e9af92007-05-01 17:49:49 +00002842 return TCL_ERROR;
2843 }
2844
danielk19778cbadb02007-05-03 16:31:26 +00002845 if( objc==(6+isReadonly) ){
danielk1977b4e9af92007-05-01 17:49:49 +00002846 zDb = Tcl_GetString(objv[2]);
2847 }
2848 zTable = Tcl_GetString(objv[objc-3]);
2849 zColumn = Tcl_GetString(objv[objc-2]);
2850 rc = Tcl_GetWideIntFromObj(interp, objv[objc-1], &iRow);
2851
2852 if( rc==TCL_OK ){
danielk19778cbadb02007-05-03 16:31:26 +00002853 rc = createIncrblobChannel(
danedf5b162014-08-19 09:15:41 +00002854 interp, pDb, zDb, zTable, zColumn, (sqlite3_int64)iRow, isReadonly
danielk19778cbadb02007-05-03 16:31:26 +00002855 );
danielk1977b4e9af92007-05-01 17:49:49 +00002856 }
danielk197732a0d8b2007-05-04 19:03:02 +00002857#endif
danielk1977b4e9af92007-05-01 17:49:49 +00002858 break;
2859 }
2860
2861 /*
drhf11bded2006-07-17 00:02:44 +00002862 ** $db interrupt
2863 **
2864 ** Interrupt the execution of the inner-most SQL interpreter. This
2865 ** causes the SQL statement to return an error of SQLITE_INTERRUPT.
2866 */
2867 case DB_INTERRUPT: {
2868 sqlite3_interrupt(pDb->db);
2869 break;
2870 }
2871
2872 /*
drh19e2d372005-08-29 23:00:03 +00002873 ** $db nullvalue ?STRING?
2874 **
2875 ** Change text used when a NULL comes back from the database. If ?STRING?
2876 ** is not present, then the current string used for NULL is returned.
2877 ** If STRING is present, then STRING is returned.
2878 **
2879 */
2880 case DB_NULLVALUE: {
2881 if( objc!=2 && objc!=3 ){
2882 Tcl_WrongNumArgs(interp, 2, objv, "NULLVALUE");
2883 return TCL_ERROR;
2884 }
2885 if( objc==3 ){
2886 int len;
2887 char *zNull = Tcl_GetStringFromObj(objv[2], &len);
2888 if( pDb->zNull ){
2889 Tcl_Free(pDb->zNull);
2890 }
2891 if( zNull && len>0 ){
2892 pDb->zNull = Tcl_Alloc( len + 1 );
drh7fd33922011-06-20 19:00:30 +00002893 memcpy(pDb->zNull, zNull, len);
drh19e2d372005-08-29 23:00:03 +00002894 pDb->zNull[len] = '\0';
2895 }else{
2896 pDb->zNull = 0;
2897 }
2898 }
drhc45e6712012-10-03 11:02:33 +00002899 Tcl_SetObjResult(interp, Tcl_NewStringObj(pDb->zNull, -1));
drh19e2d372005-08-29 23:00:03 +00002900 break;
2901 }
2902
2903 /*
mistachkinb56660f2016-07-14 21:26:09 +00002904 ** $db last_insert_rowid
drhaf9ff332002-01-16 21:00:27 +00002905 **
2906 ** Return an integer which is the ROWID for the most recent insert.
2907 */
2908 case DB_LAST_INSERT_ROWID: {
2909 Tcl_Obj *pResult;
drhf7e678d2006-06-21 19:30:34 +00002910 Tcl_WideInt rowid;
drhaf9ff332002-01-16 21:00:27 +00002911 if( objc!=2 ){
2912 Tcl_WrongNumArgs(interp, 2, objv, "");
2913 return TCL_ERROR;
2914 }
danielk19776f8a5032004-05-10 10:34:51 +00002915 rowid = sqlite3_last_insert_rowid(pDb->db);
drhaf9ff332002-01-16 21:00:27 +00002916 pResult = Tcl_GetObjResult(interp);
drhf7e678d2006-06-21 19:30:34 +00002917 Tcl_SetWideIntObj(pResult, rowid);
drhaf9ff332002-01-16 21:00:27 +00002918 break;
2919 }
2920
2921 /*
dan4a4c11a2009-10-06 14:59:02 +00002922 ** The DB_ONECOLUMN method is implemented together with DB_EXISTS.
drh5d9d7572003-08-19 14:31:01 +00002923 */
drh1807ce32004-09-07 13:20:35 +00002924
2925 /* $db progress ?N CALLBACK?
mistachkinb56660f2016-07-14 21:26:09 +00002926 **
drh1807ce32004-09-07 13:20:35 +00002927 ** Invoke the given callback every N virtual machine opcodes while executing
2928 ** queries.
2929 */
2930 case DB_PROGRESS: {
2931 if( objc==2 ){
2932 if( pDb->zProgress ){
drha198f2b2014-02-07 19:26:13 +00002933 Tcl_AppendResult(interp, pDb->zProgress, (char*)0);
drh1807ce32004-09-07 13:20:35 +00002934 }
2935 }else if( objc==4 ){
2936 char *zProgress;
2937 int len;
2938 int N;
2939 if( TCL_OK!=Tcl_GetIntFromObj(interp, objv[2], &N) ){
drhfd131da2007-08-07 17:13:03 +00002940 return TCL_ERROR;
drh1807ce32004-09-07 13:20:35 +00002941 };
2942 if( pDb->zProgress ){
2943 Tcl_Free(pDb->zProgress);
2944 }
2945 zProgress = Tcl_GetStringFromObj(objv[3], &len);
2946 if( zProgress && len>0 ){
2947 pDb->zProgress = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002948 memcpy(pDb->zProgress, zProgress, len+1);
drh1807ce32004-09-07 13:20:35 +00002949 }else{
2950 pDb->zProgress = 0;
2951 }
2952#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
2953 if( pDb->zProgress ){
2954 pDb->interp = interp;
2955 sqlite3_progress_handler(pDb->db, N, DbProgressHandler, pDb);
2956 }else{
2957 sqlite3_progress_handler(pDb->db, 0, 0, 0);
2958 }
2959#endif
2960 }else{
2961 Tcl_WrongNumArgs(interp, 2, objv, "N CALLBACK");
drh5d9d7572003-08-19 14:31:01 +00002962 return TCL_ERROR;
2963 }
drh5d9d7572003-08-19 14:31:01 +00002964 break;
2965 }
2966
drh19e2d372005-08-29 23:00:03 +00002967 /* $db profile ?CALLBACK?
2968 **
2969 ** Make arrangements to invoke the CALLBACK routine after each SQL statement
2970 ** that has run. The text of the SQL and the amount of elapse time are
2971 ** appended to CALLBACK before the script is run.
2972 */
2973 case DB_PROFILE: {
2974 if( objc>3 ){
2975 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2976 return TCL_ERROR;
2977 }else if( objc==2 ){
2978 if( pDb->zProfile ){
drha198f2b2014-02-07 19:26:13 +00002979 Tcl_AppendResult(interp, pDb->zProfile, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002980 }
2981 }else{
2982 char *zProfile;
2983 int len;
2984 if( pDb->zProfile ){
2985 Tcl_Free(pDb->zProfile);
2986 }
2987 zProfile = Tcl_GetStringFromObj(objv[2], &len);
2988 if( zProfile && len>0 ){
2989 pDb->zProfile = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002990 memcpy(pDb->zProfile, zProfile, len+1);
drh19e2d372005-08-29 23:00:03 +00002991 }else{
2992 pDb->zProfile = 0;
2993 }
drh2eb22af2016-09-10 19:51:40 +00002994#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
2995 !defined(SQLITE_OMIT_DEPRECATED)
drh19e2d372005-08-29 23:00:03 +00002996 if( pDb->zProfile ){
2997 pDb->interp = interp;
2998 sqlite3_profile(pDb->db, DbProfileHandler, pDb);
2999 }else{
3000 sqlite3_profile(pDb->db, 0, 0);
3001 }
3002#endif
3003 }
3004 break;
3005 }
3006
drh5d9d7572003-08-19 14:31:01 +00003007 /*
drh22fbcb82004-02-01 01:22:50 +00003008 ** $db rekey KEY
3009 **
3010 ** Change the encryption key on the currently open database.
3011 */
3012 case DB_REKEY: {
drh32f57d42016-03-16 01:03:10 +00003013#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drh22fbcb82004-02-01 01:22:50 +00003014 int nKey;
3015 void *pKey;
drhb07028f2011-10-14 21:49:18 +00003016#endif
drh22fbcb82004-02-01 01:22:50 +00003017 if( objc!=3 ){
3018 Tcl_WrongNumArgs(interp, 2, objv, "KEY");
3019 return TCL_ERROR;
3020 }
drh32f57d42016-03-16 01:03:10 +00003021#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drhb07028f2011-10-14 21:49:18 +00003022 pKey = Tcl_GetByteArrayFromObj(objv[2], &nKey);
drh2011d5f2004-07-22 02:40:37 +00003023 rc = sqlite3_rekey(pDb->db, pKey, nKey);
drh22fbcb82004-02-01 01:22:50 +00003024 if( rc ){
drha198f2b2014-02-07 19:26:13 +00003025 Tcl_AppendResult(interp, sqlite3_errstr(rc), (char*)0);
drh22fbcb82004-02-01 01:22:50 +00003026 rc = TCL_ERROR;
3027 }
3028#endif
3029 break;
3030 }
3031
drhdc2c4912009-02-04 22:46:47 +00003032 /* $db restore ?DATABASE? FILENAME
3033 **
mistachkinb56660f2016-07-14 21:26:09 +00003034 ** Open a database file named FILENAME. Transfer the content
drhdc2c4912009-02-04 22:46:47 +00003035 ** of FILENAME into the local database DATABASE (default: "main").
3036 */
3037 case DB_RESTORE: {
3038 const char *zSrcFile;
3039 const char *zDestDb;
3040 sqlite3 *pSrc;
3041 sqlite3_backup *pBackup;
3042 int nTimeout = 0;
3043
3044 if( objc==3 ){
3045 zDestDb = "main";
3046 zSrcFile = Tcl_GetString(objv[2]);
3047 }else if( objc==4 ){
3048 zDestDb = Tcl_GetString(objv[2]);
3049 zSrcFile = Tcl_GetString(objv[3]);
3050 }else{
3051 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? FILENAME");
3052 return TCL_ERROR;
3053 }
drh147ef392016-01-22 23:17:51 +00003054 rc = sqlite3_open_v2(zSrcFile, &pSrc,
3055 SQLITE_OPEN_READONLY | pDb->openFlags, 0);
drhdc2c4912009-02-04 22:46:47 +00003056 if( rc!=SQLITE_OK ){
3057 Tcl_AppendResult(interp, "cannot open source database: ",
3058 sqlite3_errmsg(pSrc), (char*)0);
3059 sqlite3_close(pSrc);
3060 return TCL_ERROR;
3061 }
3062 pBackup = sqlite3_backup_init(pDb->db, zDestDb, pSrc, "main");
3063 if( pBackup==0 ){
3064 Tcl_AppendResult(interp, "restore failed: ",
3065 sqlite3_errmsg(pDb->db), (char*)0);
3066 sqlite3_close(pSrc);
3067 return TCL_ERROR;
3068 }
3069 while( (rc = sqlite3_backup_step(pBackup,100))==SQLITE_OK
3070 || rc==SQLITE_BUSY ){
3071 if( rc==SQLITE_BUSY ){
3072 if( nTimeout++ >= 3 ) break;
3073 sqlite3_sleep(100);
3074 }
3075 }
3076 sqlite3_backup_finish(pBackup);
3077 if( rc==SQLITE_DONE ){
3078 rc = TCL_OK;
3079 }else if( rc==SQLITE_BUSY || rc==SQLITE_LOCKED ){
3080 Tcl_AppendResult(interp, "restore failed: source database busy",
3081 (char*)0);
3082 rc = TCL_ERROR;
3083 }else{
3084 Tcl_AppendResult(interp, "restore failed: ",
3085 sqlite3_errmsg(pDb->db), (char*)0);
3086 rc = TCL_ERROR;
3087 }
3088 sqlite3_close(pSrc);
3089 break;
3090 }
3091
drh22fbcb82004-02-01 01:22:50 +00003092 /*
drhcb7d5412018-01-03 16:49:52 +00003093 ** $db serialize ?DATABASE?
3094 **
3095 ** Return a serialization of a database.
3096 */
3097 case DB_SERIALIZE: {
drh9c6396e2018-03-06 21:43:19 +00003098#ifndef SQLITE_ENABLE_DESERIALIZE
drhcb7d5412018-01-03 16:49:52 +00003099 Tcl_AppendResult(interp, "MEMDB not available in this build",
3100 (char*)0);
3101 rc = TCL_ERROR;
3102#else
3103 const char *zSchema = objc>=3 ? Tcl_GetString(objv[2]) : "main";
3104 sqlite3_int64 sz = 0;
3105 unsigned char *pData;
3106 if( objc!=2 && objc!=3 ){
3107 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE?");
3108 rc = TCL_ERROR;
3109 }else{
3110 int needFree;
3111 pData = sqlite3_serialize(pDb->db, zSchema, &sz, SQLITE_SERIALIZE_NOCOPY);
3112 if( pData ){
3113 needFree = 0;
3114 }else{
3115 pData = sqlite3_serialize(pDb->db, zSchema, &sz, 0);
3116 needFree = 1;
3117 }
3118 Tcl_SetObjResult(interp, Tcl_NewByteArrayObj(pData,sz));
3119 if( needFree ) sqlite3_free(pData);
3120 }
3121#endif
3122 break;
3123 }
3124
3125 /*
danc456a762017-06-22 16:51:16 +00003126 ** $db status (step|sort|autoindex|vmstep)
drhd1d38482008-10-07 23:46:38 +00003127 **
mistachkinb56660f2016-07-14 21:26:09 +00003128 ** Display SQLITE_STMTSTATUS_FULLSCAN_STEP or
drhd1d38482008-10-07 23:46:38 +00003129 ** SQLITE_STMTSTATUS_SORT for the most recent eval.
3130 */
3131 case DB_STATUS: {
drhd1d38482008-10-07 23:46:38 +00003132 int v;
3133 const char *zOp;
3134 if( objc!=3 ){
drh1c320a42010-08-01 22:41:32 +00003135 Tcl_WrongNumArgs(interp, 2, objv, "(step|sort|autoindex)");
drhd1d38482008-10-07 23:46:38 +00003136 return TCL_ERROR;
3137 }
3138 zOp = Tcl_GetString(objv[2]);
3139 if( strcmp(zOp, "step")==0 ){
3140 v = pDb->nStep;
3141 }else if( strcmp(zOp, "sort")==0 ){
3142 v = pDb->nSort;
drh3c379b02010-04-07 19:31:59 +00003143 }else if( strcmp(zOp, "autoindex")==0 ){
3144 v = pDb->nIndex;
danc456a762017-06-22 16:51:16 +00003145 }else if( strcmp(zOp, "vmstep")==0 ){
3146 v = pDb->nVMStep;
drhd1d38482008-10-07 23:46:38 +00003147 }else{
mistachkinb56660f2016-07-14 21:26:09 +00003148 Tcl_AppendResult(interp,
danc456a762017-06-22 16:51:16 +00003149 "bad argument: should be autoindex, step, sort or vmstep",
drhd1d38482008-10-07 23:46:38 +00003150 (char*)0);
3151 return TCL_ERROR;
3152 }
3153 Tcl_SetObjResult(interp, Tcl_NewIntObj(v));
3154 break;
3155 }
mistachkinb56660f2016-07-14 21:26:09 +00003156
drhd1d38482008-10-07 23:46:38 +00003157 /*
drhbec3f402000-08-04 13:49:02 +00003158 ** $db timeout MILLESECONDS
3159 **
3160 ** Delay for the number of milliseconds specified when a file is locked.
3161 */
drh6d313162000-09-21 13:01:35 +00003162 case DB_TIMEOUT: {
drhbec3f402000-08-04 13:49:02 +00003163 int ms;
drh6d313162000-09-21 13:01:35 +00003164 if( objc!=3 ){
3165 Tcl_WrongNumArgs(interp, 2, objv, "MILLISECONDS");
drhbec3f402000-08-04 13:49:02 +00003166 return TCL_ERROR;
3167 }
drh6d313162000-09-21 13:01:35 +00003168 if( Tcl_GetIntFromObj(interp, objv[2], &ms) ) return TCL_ERROR;
danielk19776f8a5032004-05-10 10:34:51 +00003169 sqlite3_busy_timeout(pDb->db, ms);
drh6d313162000-09-21 13:01:35 +00003170 break;
drh75897232000-05-29 14:26:00 +00003171 }
mistachkinb56660f2016-07-14 21:26:09 +00003172
danielk197755c45f22005-04-03 23:54:43 +00003173 /*
drh0f14e2e2004-06-29 12:39:08 +00003174 ** $db total_changes
3175 **
mistachkinb56660f2016-07-14 21:26:09 +00003176 ** Return the number of rows that were modified, inserted, or deleted
drh0f14e2e2004-06-29 12:39:08 +00003177 ** since the database handle was created.
3178 */
3179 case DB_TOTAL_CHANGES: {
3180 Tcl_Obj *pResult;
3181 if( objc!=2 ){
3182 Tcl_WrongNumArgs(interp, 2, objv, "");
3183 return TCL_ERROR;
3184 }
3185 pResult = Tcl_GetObjResult(interp);
3186 Tcl_SetIntObj(pResult, sqlite3_total_changes(pDb->db));
3187 break;
3188 }
3189
drhb5a20d32003-04-23 12:25:23 +00003190 /* $db trace ?CALLBACK?
3191 **
3192 ** Make arrangements to invoke the CALLBACK routine for each SQL statement
3193 ** that is executed. The text of the SQL is appended to CALLBACK before
3194 ** it is executed.
3195 */
3196 case DB_TRACE: {
3197 if( objc>3 ){
3198 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drhb97759e2004-06-29 11:26:59 +00003199 return TCL_ERROR;
drhb5a20d32003-04-23 12:25:23 +00003200 }else if( objc==2 ){
3201 if( pDb->zTrace ){
drha198f2b2014-02-07 19:26:13 +00003202 Tcl_AppendResult(interp, pDb->zTrace, (char*)0);
drhb5a20d32003-04-23 12:25:23 +00003203 }
3204 }else{
3205 char *zTrace;
3206 int len;
3207 if( pDb->zTrace ){
3208 Tcl_Free(pDb->zTrace);
3209 }
3210 zTrace = Tcl_GetStringFromObj(objv[2], &len);
3211 if( zTrace && len>0 ){
3212 pDb->zTrace = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00003213 memcpy(pDb->zTrace, zTrace, len+1);
drhb5a20d32003-04-23 12:25:23 +00003214 }else{
3215 pDb->zTrace = 0;
3216 }
drh2eb22af2016-09-10 19:51:40 +00003217#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
3218 !defined(SQLITE_OMIT_DEPRECATED)
drhb5a20d32003-04-23 12:25:23 +00003219 if( pDb->zTrace ){
3220 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +00003221 sqlite3_trace(pDb->db, DbTraceHandler, pDb);
drhb5a20d32003-04-23 12:25:23 +00003222 }else{
danielk19776f8a5032004-05-10 10:34:51 +00003223 sqlite3_trace(pDb->db, 0, 0);
drhb5a20d32003-04-23 12:25:23 +00003224 }
drh19e2d372005-08-29 23:00:03 +00003225#endif
drhb5a20d32003-04-23 12:25:23 +00003226 }
3227 break;
3228 }
3229
mistachkinb56660f2016-07-14 21:26:09 +00003230 /* $db trace_v2 ?CALLBACK? ?MASK?
3231 **
3232 ** Make arrangements to invoke the CALLBACK routine for each trace event
3233 ** matching the mask that is generated. The parameters are appended to
3234 ** CALLBACK before it is executed.
3235 */
3236 case DB_TRACE_V2: {
3237 if( objc>4 ){
3238 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK? ?MASK?");
3239 return TCL_ERROR;
3240 }else if( objc==2 ){
3241 if( pDb->zTraceV2 ){
3242 Tcl_AppendResult(interp, pDb->zTraceV2, (char*)0);
3243 }
3244 }else{
mistachkinb56660f2016-07-14 21:26:09 +00003245 char *zTraceV2;
3246 int len;
mistachkinb52dcd82016-07-14 23:17:03 +00003247 Tcl_WideInt wMask = 0;
mistachkinb56660f2016-07-14 21:26:09 +00003248 if( objc==4 ){
mistachkinb52dcd82016-07-14 23:17:03 +00003249 static const char *TTYPE_strs[] = {
3250 "statement", "profile", "row", "close", 0
3251 };
3252 enum TTYPE_enum {
3253 TTYPE_STMT, TTYPE_PROFILE, TTYPE_ROW, TTYPE_CLOSE
3254 };
3255 int i;
3256 if( TCL_OK!=Tcl_ListObjLength(interp, objv[3], &len) ){
mistachkinb56660f2016-07-14 21:26:09 +00003257 return TCL_ERROR;
3258 }
mistachkinb52dcd82016-07-14 23:17:03 +00003259 for(i=0; i<len; i++){
3260 Tcl_Obj *pObj;
3261 int ttype;
3262 if( TCL_OK!=Tcl_ListObjIndex(interp, objv[3], i, &pObj) ){
3263 return TCL_ERROR;
3264 }
3265 if( Tcl_GetIndexFromObj(interp, pObj, TTYPE_strs, "trace type",
3266 0, &ttype)!=TCL_OK ){
3267 Tcl_WideInt wType;
3268 Tcl_Obj *pError = Tcl_DuplicateObj(Tcl_GetObjResult(interp));
3269 Tcl_IncrRefCount(pError);
3270 if( TCL_OK==Tcl_GetWideIntFromObj(interp, pObj, &wType) ){
3271 Tcl_DecrRefCount(pError);
3272 wMask |= wType;
3273 }else{
3274 Tcl_SetObjResult(interp, pError);
3275 Tcl_DecrRefCount(pError);
3276 return TCL_ERROR;
3277 }
3278 }else{
3279 switch( (enum TTYPE_enum)ttype ){
3280 case TTYPE_STMT: wMask |= SQLITE_TRACE_STMT; break;
3281 case TTYPE_PROFILE: wMask |= SQLITE_TRACE_PROFILE; break;
3282 case TTYPE_ROW: wMask |= SQLITE_TRACE_ROW; break;
3283 case TTYPE_CLOSE: wMask |= SQLITE_TRACE_CLOSE; break;
3284 }
3285 }
3286 }
mistachkinb56660f2016-07-14 21:26:09 +00003287 }else{
mistachkinb52dcd82016-07-14 23:17:03 +00003288 wMask = SQLITE_TRACE_STMT; /* use the "legacy" default */
mistachkinb56660f2016-07-14 21:26:09 +00003289 }
3290 if( pDb->zTraceV2 ){
3291 Tcl_Free(pDb->zTraceV2);
3292 }
3293 zTraceV2 = Tcl_GetStringFromObj(objv[2], &len);
3294 if( zTraceV2 && len>0 ){
3295 pDb->zTraceV2 = Tcl_Alloc( len + 1 );
3296 memcpy(pDb->zTraceV2, zTraceV2, len+1);
3297 }else{
3298 pDb->zTraceV2 = 0;
3299 }
3300#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT)
3301 if( pDb->zTraceV2 ){
3302 pDb->interp = interp;
3303 sqlite3_trace_v2(pDb->db, (unsigned)wMask, DbTraceV2Handler, pDb);
3304 }else{
3305 sqlite3_trace_v2(pDb->db, 0, 0, 0);
3306 }
3307#endif
3308 }
3309 break;
3310 }
3311
drh3d214232005-08-02 12:21:08 +00003312 /* $db transaction [-deferred|-immediate|-exclusive] SCRIPT
3313 **
3314 ** Start a new transaction (if we are not already in the midst of a
3315 ** transaction) and execute the TCL script SCRIPT. After SCRIPT
3316 ** completes, either commit the transaction or roll it back if SCRIPT
3317 ** throws an exception. Or if no new transation was started, do nothing.
3318 ** pass the exception on up the stack.
3319 **
3320 ** This command was inspired by Dave Thomas's talk on Ruby at the
3321 ** 2005 O'Reilly Open Source Convention (OSCON).
3322 */
3323 case DB_TRANSACTION: {
drh3d214232005-08-02 12:21:08 +00003324 Tcl_Obj *pScript;
danielk1977cd38d522009-01-02 17:33:46 +00003325 const char *zBegin = "SAVEPOINT _tcl_transaction";
drh3d214232005-08-02 12:21:08 +00003326 if( objc!=3 && objc!=4 ){
3327 Tcl_WrongNumArgs(interp, 2, objv, "[TYPE] SCRIPT");
3328 return TCL_ERROR;
3329 }
danielk1977cd38d522009-01-02 17:33:46 +00003330
dan4a4c11a2009-10-06 14:59:02 +00003331 if( pDb->nTransaction==0 && objc==4 ){
drh3d214232005-08-02 12:21:08 +00003332 static const char *TTYPE_strs[] = {
drhce604012005-08-16 11:11:34 +00003333 "deferred", "exclusive", "immediate", 0
drh3d214232005-08-02 12:21:08 +00003334 };
3335 enum TTYPE_enum {
3336 TTYPE_DEFERRED, TTYPE_EXCLUSIVE, TTYPE_IMMEDIATE
3337 };
3338 int ttype;
drhb5555e72005-08-02 17:15:14 +00003339 if( Tcl_GetIndexFromObj(interp, objv[2], TTYPE_strs, "transaction type",
drh3d214232005-08-02 12:21:08 +00003340 0, &ttype) ){
3341 return TCL_ERROR;
3342 }
3343 switch( (enum TTYPE_enum)ttype ){
3344 case TTYPE_DEFERRED: /* no-op */; break;
3345 case TTYPE_EXCLUSIVE: zBegin = "BEGIN EXCLUSIVE"; break;
3346 case TTYPE_IMMEDIATE: zBegin = "BEGIN IMMEDIATE"; break;
3347 }
drh3d214232005-08-02 12:21:08 +00003348 }
danielk1977cd38d522009-01-02 17:33:46 +00003349 pScript = objv[objc-1];
3350
dan4a4c11a2009-10-06 14:59:02 +00003351 /* Run the SQLite BEGIN command to open a transaction or savepoint. */
danielk1977cd38d522009-01-02 17:33:46 +00003352 pDb->disableAuth++;
3353 rc = sqlite3_exec(pDb->db, zBegin, 0, 0, 0);
3354 pDb->disableAuth--;
3355 if( rc!=SQLITE_OK ){
drha198f2b2014-02-07 19:26:13 +00003356 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
danielk1977cd38d522009-01-02 17:33:46 +00003357 return TCL_ERROR;
drh3d214232005-08-02 12:21:08 +00003358 }
danielk1977cd38d522009-01-02 17:33:46 +00003359 pDb->nTransaction++;
danielk1977cd38d522009-01-02 17:33:46 +00003360
dan4a4c11a2009-10-06 14:59:02 +00003361 /* If using NRE, schedule a callback to invoke the script pScript, then
3362 ** a second callback to commit (or rollback) the transaction or savepoint
3363 ** opened above. If not using NRE, evaluate the script directly, then
mistachkinb56660f2016-07-14 21:26:09 +00003364 ** call function DbTransPostCmd() to commit (or rollback) the transaction
dan4a4c11a2009-10-06 14:59:02 +00003365 ** or savepoint. */
3366 if( DbUseNre() ){
3367 Tcl_NRAddCallback(interp, DbTransPostCmd, cd, 0, 0, 0);
drha47941f2013-12-20 18:57:44 +00003368 (void)Tcl_NREvalObj(interp, pScript, 0);
danielk1977cd38d522009-01-02 17:33:46 +00003369 }else{
dan4a4c11a2009-10-06 14:59:02 +00003370 rc = DbTransPostCmd(&cd, interp, Tcl_EvalObjEx(interp, pScript, 0));
drh3d214232005-08-02 12:21:08 +00003371 }
3372 break;
3373 }
3374
danielk197794eb6a12005-12-15 15:22:08 +00003375 /*
danielk1977404ca072009-03-16 13:19:36 +00003376 ** $db unlock_notify ?script?
3377 */
3378 case DB_UNLOCK_NOTIFY: {
3379#ifndef SQLITE_ENABLE_UNLOCK_NOTIFY
drha198f2b2014-02-07 19:26:13 +00003380 Tcl_AppendResult(interp, "unlock_notify not available in this build",
3381 (char*)0);
danielk1977404ca072009-03-16 13:19:36 +00003382 rc = TCL_ERROR;
3383#else
3384 if( objc!=2 && objc!=3 ){
3385 Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
3386 rc = TCL_ERROR;
3387 }else{
3388 void (*xNotify)(void **, int) = 0;
3389 void *pNotifyArg = 0;
3390
3391 if( pDb->pUnlockNotify ){
3392 Tcl_DecrRefCount(pDb->pUnlockNotify);
3393 pDb->pUnlockNotify = 0;
3394 }
mistachkinb56660f2016-07-14 21:26:09 +00003395
danielk1977404ca072009-03-16 13:19:36 +00003396 if( objc==3 ){
3397 xNotify = DbUnlockNotify;
3398 pNotifyArg = (void *)pDb;
3399 pDb->pUnlockNotify = objv[2];
3400 Tcl_IncrRefCount(pDb->pUnlockNotify);
3401 }
mistachkinb56660f2016-07-14 21:26:09 +00003402
danielk1977404ca072009-03-16 13:19:36 +00003403 if( sqlite3_unlock_notify(pDb->db, xNotify, pNotifyArg) ){
drha198f2b2014-02-07 19:26:13 +00003404 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
danielk1977404ca072009-03-16 13:19:36 +00003405 rc = TCL_ERROR;
3406 }
3407 }
3408#endif
3409 break;
3410 }
3411
drh304637c2011-03-18 16:47:27 +00003412 /*
3413 ** $db preupdate_hook count
3414 ** $db preupdate_hook hook ?SCRIPT?
3415 ** $db preupdate_hook new INDEX
3416 ** $db preupdate_hook old INDEX
3417 */
dan46c47d42011-03-01 18:42:07 +00003418 case DB_PREUPDATE: {
drh9b1c62d2011-03-30 21:04:43 +00003419#ifndef SQLITE_ENABLE_PREUPDATE_HOOK
dan2b519ab2016-12-06 19:33:42 +00003420 Tcl_AppendResult(interp, "preupdate_hook was omitted at compile-time",
3421 (char*)0);
drh9b1c62d2011-03-30 21:04:43 +00003422 rc = TCL_ERROR;
3423#else
dan1e7a2d42011-03-22 18:45:29 +00003424 static const char *azSub[] = {"count", "depth", "hook", "new", "old", 0};
dan46c47d42011-03-01 18:42:07 +00003425 enum DbPreupdateSubCmd {
dan1e7a2d42011-03-22 18:45:29 +00003426 PRE_COUNT, PRE_DEPTH, PRE_HOOK, PRE_NEW, PRE_OLD
dan46c47d42011-03-01 18:42:07 +00003427 };
3428 int iSub;
3429
3430 if( objc<3 ){
3431 Tcl_WrongNumArgs(interp, 2, objv, "SUB-COMMAND ?ARGS?");
3432 }
3433 if( Tcl_GetIndexFromObj(interp, objv[2], azSub, "sub-command", 0, &iSub) ){
3434 return TCL_ERROR;
3435 }
3436
3437 switch( (enum DbPreupdateSubCmd)iSub ){
3438 case PRE_COUNT: {
3439 int nCol = sqlite3_preupdate_count(pDb->db);
3440 Tcl_SetObjResult(interp, Tcl_NewIntObj(nCol));
3441 break;
3442 }
3443
3444 case PRE_HOOK: {
3445 if( objc>4 ){
3446 Tcl_WrongNumArgs(interp, 2, objv, "hook ?SCRIPT?");
3447 return TCL_ERROR;
3448 }
3449 DbHookCmd(interp, pDb, (objc==4 ? objv[3] : 0), &pDb->pPreUpdateHook);
3450 break;
3451 }
3452
dan1e7a2d42011-03-22 18:45:29 +00003453 case PRE_DEPTH: {
3454 Tcl_Obj *pRet;
3455 if( objc!=3 ){
3456 Tcl_WrongNumArgs(interp, 3, objv, "");
3457 return TCL_ERROR;
3458 }
3459 pRet = Tcl_NewIntObj(sqlite3_preupdate_depth(pDb->db));
3460 Tcl_SetObjResult(interp, pRet);
3461 break;
3462 }
3463
dan37db03b2011-03-16 19:59:18 +00003464 case PRE_NEW:
dan46c47d42011-03-01 18:42:07 +00003465 case PRE_OLD: {
3466 int iIdx;
dan37db03b2011-03-16 19:59:18 +00003467 sqlite3_value *pValue;
dan46c47d42011-03-01 18:42:07 +00003468 if( objc!=4 ){
3469 Tcl_WrongNumArgs(interp, 3, objv, "INDEX");
3470 return TCL_ERROR;
3471 }
3472 if( Tcl_GetIntFromObj(interp, objv[3], &iIdx) ){
3473 return TCL_ERROR;
3474 }
3475
dan37db03b2011-03-16 19:59:18 +00003476 if( iSub==PRE_OLD ){
dan46c47d42011-03-01 18:42:07 +00003477 rc = sqlite3_preupdate_old(pDb->db, iIdx, &pValue);
dan37db03b2011-03-16 19:59:18 +00003478 }else{
3479 assert( iSub==PRE_NEW );
3480 rc = sqlite3_preupdate_new(pDb->db, iIdx, &pValue);
dan46c47d42011-03-01 18:42:07 +00003481 }
3482
dan37db03b2011-03-16 19:59:18 +00003483 if( rc==SQLITE_OK ){
drh304637c2011-03-18 16:47:27 +00003484 Tcl_Obj *pObj;
3485 pObj = Tcl_NewStringObj((char*)sqlite3_value_text(pValue), -1);
dan37db03b2011-03-16 19:59:18 +00003486 Tcl_SetObjResult(interp, pObj);
3487 }else{
drhea8f0a12017-01-12 11:50:08 +00003488 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
dan46c47d42011-03-01 18:42:07 +00003489 return TCL_ERROR;
3490 }
3491 }
3492 }
drh9b1c62d2011-03-30 21:04:43 +00003493#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00003494 break;
3495 }
3496
danielk1977404ca072009-03-16 13:19:36 +00003497 /*
drh833bf962010-04-28 14:42:19 +00003498 ** $db wal_hook ?script?
danielk197794eb6a12005-12-15 15:22:08 +00003499 ** $db update_hook ?script?
danielk197771fd80b2005-12-16 06:54:01 +00003500 ** $db rollback_hook ?script?
danielk197794eb6a12005-12-15 15:22:08 +00003501 */
mistachkinb56660f2016-07-14 21:26:09 +00003502 case DB_WAL_HOOK:
3503 case DB_UPDATE_HOOK:
dan6566ebe2011-03-16 09:49:14 +00003504 case DB_ROLLBACK_HOOK: {
mistachkinb56660f2016-07-14 21:26:09 +00003505 /* set ppHook to point at pUpdateHook or pRollbackHook, depending on
danielk197771fd80b2005-12-16 06:54:01 +00003506 ** whether [$db update_hook] or [$db rollback_hook] was invoked.
3507 */
mistachkinb56660f2016-07-14 21:26:09 +00003508 Tcl_Obj **ppHook = 0;
dan46c47d42011-03-01 18:42:07 +00003509 if( choice==DB_WAL_HOOK ) ppHook = &pDb->pWalHook;
3510 if( choice==DB_UPDATE_HOOK ) ppHook = &pDb->pUpdateHook;
3511 if( choice==DB_ROLLBACK_HOOK ) ppHook = &pDb->pRollbackHook;
3512 if( objc>3 ){
danielk197794eb6a12005-12-15 15:22:08 +00003513 Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
3514 return TCL_ERROR;
3515 }
danielk197771fd80b2005-12-16 06:54:01 +00003516
dan46c47d42011-03-01 18:42:07 +00003517 DbHookCmd(interp, pDb, (objc==3 ? objv[2] : 0), ppHook);
danielk197794eb6a12005-12-15 15:22:08 +00003518 break;
3519 }
3520
danielk19774397de52005-01-12 12:44:03 +00003521 /* $db version
3522 **
3523 ** Return the version string for this database.
3524 */
3525 case DB_VERSION: {
drh1df64702017-10-13 15:56:26 +00003526 int i;
3527 for(i=2; i<objc; i++){
3528 const char *zArg = Tcl_GetString(objv[i]);
3529 /* Optional arguments to $db version are used for testing purpose */
3530#ifdef SQLITE_TEST
3531 /* $db version -use-legacy-prepare BOOLEAN
3532 **
3533 ** Turn the use of legacy sqlite3_prepare() on or off.
3534 */
3535 if( strcmp(zArg, "-use-legacy-prepare")==0 && i+1<objc ){
3536 i++;
3537 if( Tcl_GetBooleanFromObj(interp, objv[i], &pDb->bLegacyPrepare) ){
3538 return TCL_ERROR;
3539 }
3540 }else
3541
3542 /* $db version -last-stmt-ptr
3543 **
3544 ** Return a string which is a hex encoding of the pointer to the
3545 ** most recent sqlite3_stmt in the statement cache.
3546 */
3547 if( strcmp(zArg, "-last-stmt-ptr")==0 ){
3548 char zBuf[100];
3549 sqlite3_snprintf(sizeof(zBuf), zBuf, "%p",
3550 pDb->stmtList ? pDb->stmtList->pStmt: 0);
3551 Tcl_SetResult(interp, zBuf, TCL_VOLATILE);
3552 }else
3553#endif /* SQLITE_TEST */
3554 {
3555 Tcl_AppendResult(interp, "unknown argument: ", zArg, (char*)0);
3556 return TCL_ERROR;
3557 }
3558 }
3559 if( i==2 ){
3560 Tcl_SetResult(interp, (char *)sqlite3_libversion(), TCL_STATIC);
3561 }
danielk19774397de52005-01-12 12:44:03 +00003562 break;
3563 }
3564
tpoindex1067fe12004-12-17 15:41:11 +00003565
drh6d313162000-09-21 13:01:35 +00003566 } /* End of the SWITCH statement */
drh22fbcb82004-02-01 01:22:50 +00003567 return rc;
drh75897232000-05-29 14:26:00 +00003568}
3569
drha2c8a952009-10-13 18:38:34 +00003570#if SQLITE_TCL_NRE
3571/*
3572** Adaptor that provides an objCmd interface to the NRE-enabled
3573** interface implementation.
3574*/
mistachkina121cc72016-07-28 18:06:52 +00003575static int SQLITE_TCLAPI DbObjCmdAdaptor(
drha2c8a952009-10-13 18:38:34 +00003576 void *cd,
3577 Tcl_Interp *interp,
3578 int objc,
3579 Tcl_Obj *const*objv
3580){
3581 return Tcl_NRCallObjProc(interp, DbObjCmd, cd, objc, objv);
3582}
3583#endif /* SQLITE_TCL_NRE */
3584
drh75897232000-05-29 14:26:00 +00003585/*
drh4dcac402018-01-03 13:20:02 +00003586** Issue the usage message when the "sqlite3" command arguments are
3587** incorrect.
3588*/
3589static int sqliteCmdUsage(
3590 Tcl_Interp *interp,
3591 Tcl_Obj *const*objv
3592){
3593 Tcl_WrongNumArgs(interp, 1, objv,
3594 "HANDLE ?FILENAME? ?-vfs VFSNAME? ?-readonly BOOLEAN? ?-create BOOLEAN?"
3595 " ?-nomutex BOOLEAN? ?-fullmutex BOOLEAN? ?-uri BOOLEAN?"
3596#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
3597 " ?-key CODECKEY?"
3598#endif
3599 );
3600 return TCL_ERROR;
3601}
3602
3603/*
drh3570ad92007-08-31 14:31:44 +00003604** sqlite3 DBNAME FILENAME ?-vfs VFSNAME? ?-key KEY? ?-readonly BOOLEAN?
danielk19779a6284c2008-07-10 17:52:49 +00003605** ?-create BOOLEAN? ?-nomutex BOOLEAN?
drh75897232000-05-29 14:26:00 +00003606**
3607** This is the main Tcl command. When the "sqlite" Tcl command is
3608** invoked, this routine runs to process that command.
3609**
3610** The first argument, DBNAME, is an arbitrary name for a new
3611** database connection. This command creates a new command named
3612** DBNAME that is used to control that connection. The database
3613** connection is deleted when the DBNAME command is deleted.
3614**
drh3570ad92007-08-31 14:31:44 +00003615** The second argument is the name of the database file.
drhfbc3eab2001-04-06 16:13:42 +00003616**
drh75897232000-05-29 14:26:00 +00003617*/
mistachkin7617e4a2016-07-28 17:11:20 +00003618static int SQLITE_TCLAPI DbMain(
3619 void *cd,
3620 Tcl_Interp *interp,
3621 int objc,
3622 Tcl_Obj *const*objv
3623){
drhbec3f402000-08-04 13:49:02 +00003624 SqliteDb *p;
drh22fbcb82004-02-01 01:22:50 +00003625 const char *zArg;
drh75897232000-05-29 14:26:00 +00003626 char *zErrMsg;
drh3570ad92007-08-31 14:31:44 +00003627 int i;
drh4dcac402018-01-03 13:20:02 +00003628 const char *zFile = 0;
drh3570ad92007-08-31 14:31:44 +00003629 const char *zVfs = 0;
drhd9da78a2009-03-24 15:08:09 +00003630 int flags;
drh882e8e42006-08-24 02:42:27 +00003631 Tcl_DString translatedFilename;
drh32f57d42016-03-16 01:03:10 +00003632#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drhb07028f2011-10-14 21:49:18 +00003633 void *pKey = 0;
3634 int nKey = 0;
3635#endif
mistachkin540ebf82012-09-10 07:29:29 +00003636 int rc;
drhd9da78a2009-03-24 15:08:09 +00003637
3638 /* In normal use, each TCL interpreter runs in a single thread. So
drh4dcac402018-01-03 13:20:02 +00003639 ** by default, we can turn off mutexing on SQLite database connections.
drhd9da78a2009-03-24 15:08:09 +00003640 ** However, for testing purposes it is useful to have mutexes turned
3641 ** on. So, by default, mutexes default off. But if compiled with
3642 ** SQLITE_TCL_DEFAULT_FULLMUTEX then mutexes default on.
3643 */
3644#ifdef SQLITE_TCL_DEFAULT_FULLMUTEX
3645 flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_FULLMUTEX;
3646#else
3647 flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_NOMUTEX;
3648#endif
3649
drhc6727c82018-09-19 15:08:21 +00003650 if( objc==1 ) return sqliteCmdUsage(interp, objv);
drh22fbcb82004-02-01 01:22:50 +00003651 if( objc==2 ){
3652 zArg = Tcl_GetStringFromObj(objv[1], 0);
drh22fbcb82004-02-01 01:22:50 +00003653 if( strcmp(zArg,"-version")==0 ){
drha198f2b2014-02-07 19:26:13 +00003654 Tcl_AppendResult(interp,sqlite3_libversion(), (char*)0);
drh647cb0e2002-11-04 19:32:25 +00003655 return TCL_OK;
3656 }
drh72bf6a32016-01-07 02:06:55 +00003657 if( strcmp(zArg,"-sourceid")==0 ){
3658 Tcl_AppendResult(interp,sqlite3_sourceid(), (char*)0);
3659 return TCL_OK;
3660 }
drh9eb9e262004-02-11 02:18:05 +00003661 if( strcmp(zArg,"-has-codec")==0 ){
drh32f57d42016-03-16 01:03:10 +00003662#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drha198f2b2014-02-07 19:26:13 +00003663 Tcl_AppendResult(interp,"1",(char*)0);
drh22fbcb82004-02-01 01:22:50 +00003664#else
drha198f2b2014-02-07 19:26:13 +00003665 Tcl_AppendResult(interp,"0",(char*)0);
drh22fbcb82004-02-01 01:22:50 +00003666#endif
3667 return TCL_OK;
3668 }
drh4dcac402018-01-03 13:20:02 +00003669 if( zArg[0]=='-' ) return sqliteCmdUsage(interp, objv);
drhfbc3eab2001-04-06 16:13:42 +00003670 }
drh4dcac402018-01-03 13:20:02 +00003671 for(i=2; i<objc; i++){
drh3570ad92007-08-31 14:31:44 +00003672 zArg = Tcl_GetString(objv[i]);
drh4dcac402018-01-03 13:20:02 +00003673 if( zArg[0]!='-' ){
3674 if( zFile!=0 ) return sqliteCmdUsage(interp, objv);
3675 zFile = zArg;
3676 continue;
3677 }
3678 if( i==objc-1 ) return sqliteCmdUsage(interp, objv);
3679 i++;
drh22fbcb82004-02-01 01:22:50 +00003680 if( strcmp(zArg,"-key")==0 ){
drh32f57d42016-03-16 01:03:10 +00003681#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drh4dcac402018-01-03 13:20:02 +00003682 pKey = Tcl_GetByteArrayFromObj(objv[i], &nKey);
drhb07028f2011-10-14 21:49:18 +00003683#endif
drh3570ad92007-08-31 14:31:44 +00003684 }else if( strcmp(zArg, "-vfs")==0 ){
drh4dcac402018-01-03 13:20:02 +00003685 zVfs = Tcl_GetString(objv[i]);
drh3570ad92007-08-31 14:31:44 +00003686 }else if( strcmp(zArg, "-readonly")==0 ){
3687 int b;
drh4dcac402018-01-03 13:20:02 +00003688 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh3570ad92007-08-31 14:31:44 +00003689 if( b ){
drh33f4e022007-09-03 15:19:34 +00003690 flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
drh3570ad92007-08-31 14:31:44 +00003691 flags |= SQLITE_OPEN_READONLY;
3692 }else{
3693 flags &= ~SQLITE_OPEN_READONLY;
3694 flags |= SQLITE_OPEN_READWRITE;
3695 }
3696 }else if( strcmp(zArg, "-create")==0 ){
3697 int b;
drh4dcac402018-01-03 13:20:02 +00003698 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh33f4e022007-09-03 15:19:34 +00003699 if( b && (flags & SQLITE_OPEN_READONLY)==0 ){
drh3570ad92007-08-31 14:31:44 +00003700 flags |= SQLITE_OPEN_CREATE;
3701 }else{
3702 flags &= ~SQLITE_OPEN_CREATE;
3703 }
danielk19779a6284c2008-07-10 17:52:49 +00003704 }else if( strcmp(zArg, "-nomutex")==0 ){
3705 int b;
drh4dcac402018-01-03 13:20:02 +00003706 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
danielk19779a6284c2008-07-10 17:52:49 +00003707 if( b ){
3708 flags |= SQLITE_OPEN_NOMUTEX;
drh039963a2008-09-03 00:43:15 +00003709 flags &= ~SQLITE_OPEN_FULLMUTEX;
danielk19779a6284c2008-07-10 17:52:49 +00003710 }else{
3711 flags &= ~SQLITE_OPEN_NOMUTEX;
3712 }
danc431fd52011-06-27 16:55:50 +00003713 }else if( strcmp(zArg, "-fullmutex")==0 ){
drh039963a2008-09-03 00:43:15 +00003714 int b;
drh4dcac402018-01-03 13:20:02 +00003715 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh039963a2008-09-03 00:43:15 +00003716 if( b ){
3717 flags |= SQLITE_OPEN_FULLMUTEX;
3718 flags &= ~SQLITE_OPEN_NOMUTEX;
3719 }else{
3720 flags &= ~SQLITE_OPEN_FULLMUTEX;
3721 }
drhf12b3f62011-12-21 14:42:29 +00003722 }else if( strcmp(zArg, "-uri")==0 ){
3723 int b;
drh4dcac402018-01-03 13:20:02 +00003724 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drhf12b3f62011-12-21 14:42:29 +00003725 if( b ){
3726 flags |= SQLITE_OPEN_URI;
3727 }else{
3728 flags &= ~SQLITE_OPEN_URI;
3729 }
drh3570ad92007-08-31 14:31:44 +00003730 }else{
3731 Tcl_AppendResult(interp, "unknown option: ", zArg, (char*)0);
3732 return TCL_ERROR;
drh22fbcb82004-02-01 01:22:50 +00003733 }
3734 }
drh75897232000-05-29 14:26:00 +00003735 zErrMsg = 0;
drh4cdc9e82000-08-04 14:56:24 +00003736 p = (SqliteDb*)Tcl_Alloc( sizeof(*p) );
drhbec3f402000-08-04 13:49:02 +00003737 memset(p, 0, sizeof(*p));
drh3ec86652018-01-03 19:03:31 +00003738 if( zFile==0 ) zFile = "";
3739 zFile = Tcl_TranslateFileName(interp, zFile, &translatedFilename);
3740 rc = sqlite3_open_v2(zFile, &p->db, flags, zVfs);
3741 Tcl_DStringFree(&translatedFilename);
mistachkin540ebf82012-09-10 07:29:29 +00003742 if( p->db ){
3743 if( SQLITE_OK!=sqlite3_errcode(p->db) ){
3744 zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(p->db));
3745 sqlite3_close(p->db);
3746 p->db = 0;
3747 }
3748 }else{
mistachkin5dac8432012-09-11 02:00:25 +00003749 zErrMsg = sqlite3_mprintf("%s", sqlite3_errstr(rc));
danielk197780290862004-05-22 09:21:21 +00003750 }
drh32f57d42016-03-16 01:03:10 +00003751#if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_CODEC_FROM_TCL)
drhf3a65f72007-08-22 20:18:21 +00003752 if( p->db ){
3753 sqlite3_key(p->db, pKey, nKey);
3754 }
drheb8ed702004-02-11 10:37:23 +00003755#endif
drhbec3f402000-08-04 13:49:02 +00003756 if( p->db==0 ){
drh75897232000-05-29 14:26:00 +00003757 Tcl_SetResult(interp, zErrMsg, TCL_VOLATILE);
drhbec3f402000-08-04 13:49:02 +00003758 Tcl_Free((char*)p);
drh9404d502006-12-19 18:46:08 +00003759 sqlite3_free(zErrMsg);
drh75897232000-05-29 14:26:00 +00003760 return TCL_ERROR;
3761 }
drhfb7e7652005-01-24 00:28:42 +00003762 p->maxStmt = NUM_PREPARED_STMTS;
drh147ef392016-01-22 23:17:51 +00003763 p->openFlags = flags & SQLITE_OPEN_URI;
drh5169bbc2006-08-24 14:59:45 +00003764 p->interp = interp;
drh22fbcb82004-02-01 01:22:50 +00003765 zArg = Tcl_GetStringFromObj(objv[1], 0);
dan4a4c11a2009-10-06 14:59:02 +00003766 if( DbUseNre() ){
drha2c8a952009-10-13 18:38:34 +00003767 Tcl_NRCreateCommand(interp, zArg, DbObjCmdAdaptor, DbObjCmd,
3768 (char*)p, DbDeleteCmd);
dan4a4c11a2009-10-06 14:59:02 +00003769 }else{
3770 Tcl_CreateObjCommand(interp, zArg, DbObjCmd, (char*)p, DbDeleteCmd);
3771 }
drh75897232000-05-29 14:26:00 +00003772 return TCL_OK;
3773}
3774
3775/*
drh90ca9752001-09-28 17:47:14 +00003776** Provide a dummy Tcl_InitStubs if we are using this as a static
3777** library.
3778*/
3779#ifndef USE_TCL_STUBS
3780# undef Tcl_InitStubs
drh0e85ccf2013-06-03 12:34:46 +00003781# define Tcl_InitStubs(a,b,c) TCL_VERSION
drh90ca9752001-09-28 17:47:14 +00003782#endif
3783
3784/*
drh29bc4612005-10-05 10:40:15 +00003785** Make sure we have a PACKAGE_VERSION macro defined. This will be
3786** defined automatically by the TEA makefile. But other makefiles
3787** do not define it.
3788*/
3789#ifndef PACKAGE_VERSION
3790# define PACKAGE_VERSION SQLITE_VERSION
3791#endif
3792
3793/*
drh75897232000-05-29 14:26:00 +00003794** Initialize this module.
3795**
3796** This Tcl module contains only a single new Tcl command named "sqlite".
3797** (Hence there is no namespace. There is no point in using a namespace
3798** if the extension only supplies one new name!) The "sqlite" command is
3799** used to open a new SQLite database. See the DbMain() routine above
3800** for additional information.
drhb652f432010-08-26 16:46:57 +00003801**
3802** The EXTERN macros are required by TCL in order to work on windows.
drh75897232000-05-29 14:26:00 +00003803*/
drhb652f432010-08-26 16:46:57 +00003804EXTERN int Sqlite3_Init(Tcl_Interp *interp){
mistachkin27b2f052015-01-12 19:49:46 +00003805 int rc = Tcl_InitStubs(interp, "8.4", 0) ? TCL_OK : TCL_ERROR;
drh6dc8cbe2013-05-31 15:36:07 +00003806 if( rc==TCL_OK ){
3807 Tcl_CreateObjCommand(interp, "sqlite3", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh1cca0d22010-08-25 20:35:51 +00003808#ifndef SQLITE_3_SUFFIX_ONLY
drh6dc8cbe2013-05-31 15:36:07 +00003809 /* The "sqlite" alias is undocumented. It is here only to support
3810 ** legacy scripts. All new scripts should use only the "sqlite3"
3811 ** command. */
3812 Tcl_CreateObjCommand(interp, "sqlite", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh4c0f1642010-08-25 19:39:19 +00003813#endif
drh6dc8cbe2013-05-31 15:36:07 +00003814 rc = Tcl_PkgProvide(interp, "sqlite3", PACKAGE_VERSION);
3815 }
3816 return rc;
drh90ca9752001-09-28 17:47:14 +00003817}
drhb652f432010-08-26 16:46:57 +00003818EXTERN int Tclsqlite3_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
drhb652f432010-08-26 16:46:57 +00003819EXTERN int Sqlite3_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
3820EXTERN int Tclsqlite3_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
drhe2c3a652008-09-23 09:58:46 +00003821
drhd878cab2012-03-20 15:10:42 +00003822/* Because it accesses the file-system and uses persistent state, SQLite
drhe75a9eb2016-02-13 18:54:10 +00003823** is not considered appropriate for safe interpreters. Hence, we cause
3824** the _SafeInit() interfaces return TCL_ERROR.
drhd878cab2012-03-20 15:10:42 +00003825*/
drhe75a9eb2016-02-13 18:54:10 +00003826EXTERN int Sqlite3_SafeInit(Tcl_Interp *interp){ return TCL_ERROR; }
3827EXTERN int Sqlite3_SafeUnload(Tcl_Interp *interp, int flags){return TCL_ERROR;}
3828
3829
drh49766d62005-01-08 18:42:28 +00003830
3831#ifndef SQLITE_3_SUFFIX_ONLY
dana3e63c42010-08-20 12:33:59 +00003832int Sqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
3833int Tclsqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
dana3e63c42010-08-20 12:33:59 +00003834int Sqlite_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
3835int Tclsqlite_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
drh49766d62005-01-08 18:42:28 +00003836#endif
drh75897232000-05-29 14:26:00 +00003837
drhc318f732017-10-13 15:06:06 +00003838/*
drh96a206f2017-10-13 20:14:06 +00003839** If the TCLSH macro is defined, add code to make a stand-alone program.
drhc318f732017-10-13 15:06:06 +00003840*/
drh96a206f2017-10-13 20:14:06 +00003841#if defined(TCLSH)
drh57a02272009-10-22 20:52:05 +00003842
drh96a206f2017-10-13 20:14:06 +00003843/* This is the main routine for an ordinary TCL shell. If there are
3844** are arguments, run the first argument as a script. Otherwise,
3845** read TCL commands from standard input
drh348784e2000-05-29 20:41:49 +00003846*/
dan0ae479d2011-09-21 16:43:07 +00003847static const char *tclsh_main_loop(void){
3848 static const char zMainloop[] =
drh96a206f2017-10-13 20:14:06 +00003849 "if {[llength $argv]>=1} {\n"
3850 "set argv0 [lindex $argv 0]\n"
3851 "set argv [lrange $argv 1 end]\n"
3852 "source $argv0\n"
3853 "} else {\n"
3854 "set line {}\n"
3855 "while {![eof stdin]} {\n"
3856 "if {$line!=\"\"} {\n"
3857 "puts -nonewline \"> \"\n"
3858 "} else {\n"
3859 "puts -nonewline \"% \"\n"
dan0ae479d2011-09-21 16:43:07 +00003860 "}\n"
drh96a206f2017-10-13 20:14:06 +00003861 "flush stdout\n"
3862 "append line [gets stdin]\n"
3863 "if {[info complete $line]} {\n"
3864 "if {[catch {uplevel #0 $line} result]} {\n"
3865 "puts stderr \"Error: $result\"\n"
3866 "} elseif {$result!=\"\"} {\n"
3867 "puts $result\n"
3868 "}\n"
3869 "set line {}\n"
3870 "} else {\n"
3871 "append line \\n\n"
3872 "}\n"
dan0ae479d2011-09-21 16:43:07 +00003873 "}\n"
drh348784e2000-05-29 20:41:49 +00003874 "}\n"
dan0ae479d2011-09-21 16:43:07 +00003875 ;
3876 return zMainloop;
3877}
drh3e27c022004-07-23 00:01:38 +00003878
danc1a60c52010-06-07 14:28:16 +00003879#define TCLSH_MAIN main /* Needed to fake out mktclapp */
mistachkin69def7f2016-07-28 04:14:37 +00003880int SQLITE_CDECL TCLSH_MAIN(int argc, char **argv){
danc1a60c52010-06-07 14:28:16 +00003881 Tcl_Interp *interp;
drh96a206f2017-10-13 20:14:06 +00003882 int i;
3883 const char *zScript = 0;
3884 char zArgc[32];
3885#if defined(TCLSH_INIT_PROC)
3886 extern const char *TCLSH_INIT_PROC(Tcl_Interp*);
3887#endif
mistachkin1f28e072013-08-15 08:06:15 +00003888
3889#if !defined(_WIN32_WCE)
mistachkin1e8487d2018-07-22 06:25:35 +00003890 if( getenv("SQLITE_DEBUG_BREAK") ){
3891 if( isatty(0) && isatty(2) ){
3892 fprintf(stderr,
3893 "attach debugger to process %d and press any key to continue.\n",
3894 GETPID());
3895 fgetc(stdin);
3896 }else{
3897#if defined(_WIN32) || defined(WIN32)
3898 DebugBreak();
3899#elif defined(SIGTRAP)
3900 raise(SIGTRAP);
3901#endif
3902 }
mistachkin1f28e072013-08-15 08:06:15 +00003903 }
3904#endif
3905
danc1a60c52010-06-07 14:28:16 +00003906 /* Call sqlite3_shutdown() once before doing anything else. This is to
3907 ** test that sqlite3_shutdown() can be safely called by a process before
3908 ** sqlite3_initialize() is. */
3909 sqlite3_shutdown();
3910
dan0ae479d2011-09-21 16:43:07 +00003911 Tcl_FindExecutable(argv[0]);
mistachkin2953ba92014-02-14 00:25:03 +00003912 Tcl_SetSystemEncoding(NULL, "utf-8");
dan0ae479d2011-09-21 16:43:07 +00003913 interp = Tcl_CreateInterp();
drhc318f732017-10-13 15:06:06 +00003914 Sqlite3_Init(interp);
drh96a206f2017-10-13 20:14:06 +00003915
3916 sqlite3_snprintf(sizeof(zArgc), zArgc, "%d", argc-1);
3917 Tcl_SetVar(interp,"argc", zArgc, TCL_GLOBAL_ONLY);
3918 Tcl_SetVar(interp,"argv0",argv[0],TCL_GLOBAL_ONLY);
3919 Tcl_SetVar(interp,"argv", "", TCL_GLOBAL_ONLY);
3920 for(i=1; i<argc; i++){
3921 Tcl_SetVar(interp, "argv", argv[i],
3922 TCL_GLOBAL_ONLY | TCL_LIST_ELEMENT | TCL_APPEND_VALUE);
drhc318f732017-10-13 15:06:06 +00003923 }
drh96a206f2017-10-13 20:14:06 +00003924#if defined(TCLSH_INIT_PROC)
3925 zScript = TCLSH_INIT_PROC(interp);
3926#endif
3927 if( zScript==0 ){
3928 zScript = tclsh_main_loop();
drh3e27c022004-07-23 00:01:38 +00003929 }
drh96a206f2017-10-13 20:14:06 +00003930 if( Tcl_GlobalEval(interp, zScript)!=TCL_OK ){
3931 const char *zInfo = Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY);
3932 if( zInfo==0 ) zInfo = Tcl_GetStringResult(interp);
3933 fprintf(stderr,"%s: %s\n", *argv, zInfo);
3934 return 1;
drh348784e2000-05-29 20:41:49 +00003935 }
3936 return 0;
3937}
3938#endif /* TCLSH */