blob: 8c184809f1ddcde8976ade883858f94bc1834e82 [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) */
danbea28c72021-09-16 14:17:14 +0000184 int nRef; /* Delete object when this reaches 0 */
danc431fd52011-06-27 16:55:50 +0000185#ifdef SQLITE_TEST
186 int bLegacyPrepare; /* True to use sqlite3_prepare() */
187#endif
drh98808ba2001-10-18 12:34:46 +0000188};
drh297ecf12001-04-05 15:57:13 +0000189
danielk1977b4e9af92007-05-01 17:49:49 +0000190struct IncrblobChannel {
danielk1977d04417962007-05-02 13:16:30 +0000191 sqlite3_blob *pBlob; /* sqlite3 blob handle */
danielk1977dcbb5d32007-05-04 18:36:44 +0000192 SqliteDb *pDb; /* Associated database connection */
danielk1977d04417962007-05-02 13:16:30 +0000193 int iSeek; /* Current seek offset */
danielk1977d04417962007-05-02 13:16:30 +0000194 Tcl_Channel channel; /* Channel identifier */
195 IncrblobChannel *pNext; /* Linked list of all open incrblob channels */
196 IncrblobChannel *pPrev; /* Linked list of all open incrblob channels */
danielk1977b4e9af92007-05-01 17:49:49 +0000197};
198
drhea678832008-12-10 19:26:22 +0000199/*
200** Compute a string length that is limited to what can be stored in
201** lower 30 bits of a 32-bit signed integer.
202*/
drh4f21c4a2008-12-10 22:15:00 +0000203static int strlen30(const char *z){
drhea678832008-12-10 19:26:22 +0000204 const char *z2 = z;
205 while( *z2 ){ z2++; }
206 return 0x3fffffff & (int)(z2 - z);
207}
drhea678832008-12-10 19:26:22 +0000208
209
danielk197732a0d8b2007-05-04 19:03:02 +0000210#ifndef SQLITE_OMIT_INCRBLOB
danielk1977b4e9af92007-05-01 17:49:49 +0000211/*
danielk1977d04417962007-05-02 13:16:30 +0000212** Close all incrblob channels opened using database connection pDb.
213** This is called when shutting down the database connection.
214*/
215static void closeIncrblobChannels(SqliteDb *pDb){
216 IncrblobChannel *p;
217 IncrblobChannel *pNext;
218
219 for(p=pDb->pIncrblob; p; p=pNext){
220 pNext = p->pNext;
221
mistachkinb56660f2016-07-14 21:26:09 +0000222 /* Note: Calling unregister here call Tcl_Close on the incrblob channel,
danielk1977d04417962007-05-02 13:16:30 +0000223 ** which deletes the IncrblobChannel structure at *p. So do not
224 ** call Tcl_Free() here.
225 */
226 Tcl_UnregisterChannel(pDb->interp, p->channel);
227 }
228}
229
230/*
danielk1977b4e9af92007-05-01 17:49:49 +0000231** Close an incremental blob channel.
232*/
mistachkin7617e4a2016-07-28 17:11:20 +0000233static int SQLITE_TCLAPI incrblobClose(
234 ClientData instanceData,
235 Tcl_Interp *interp
236){
danielk1977b4e9af92007-05-01 17:49:49 +0000237 IncrblobChannel *p = (IncrblobChannel *)instanceData;
danielk197792d4d7a2007-05-04 12:05:56 +0000238 int rc = sqlite3_blob_close(p->pBlob);
239 sqlite3 *db = p->pDb->db;
danielk1977d04417962007-05-02 13:16:30 +0000240
241 /* Remove the channel from the SqliteDb.pIncrblob list. */
242 if( p->pNext ){
243 p->pNext->pPrev = p->pPrev;
244 }
245 if( p->pPrev ){
246 p->pPrev->pNext = p->pNext;
247 }
248 if( p->pDb->pIncrblob==p ){
249 p->pDb->pIncrblob = p->pNext;
250 }
251
danielk197792d4d7a2007-05-04 12:05:56 +0000252 /* Free the IncrblobChannel structure */
danielk1977b4e9af92007-05-01 17:49:49 +0000253 Tcl_Free((char *)p);
danielk197792d4d7a2007-05-04 12:05:56 +0000254
255 if( rc!=SQLITE_OK ){
256 Tcl_SetResult(interp, (char *)sqlite3_errmsg(db), TCL_VOLATILE);
257 return TCL_ERROR;
258 }
danielk1977b4e9af92007-05-01 17:49:49 +0000259 return TCL_OK;
260}
261
262/*
263** Read data from an incremental blob channel.
264*/
mistachkin7617e4a2016-07-28 17:11:20 +0000265static int SQLITE_TCLAPI incrblobInput(
mistachkinb56660f2016-07-14 21:26:09 +0000266 ClientData instanceData,
267 char *buf,
danielk1977b4e9af92007-05-01 17:49:49 +0000268 int bufSize,
269 int *errorCodePtr
270){
271 IncrblobChannel *p = (IncrblobChannel *)instanceData;
272 int nRead = bufSize; /* Number of bytes to read */
273 int nBlob; /* Total size of the blob */
274 int rc; /* sqlite error code */
275
276 nBlob = sqlite3_blob_bytes(p->pBlob);
277 if( (p->iSeek+nRead)>nBlob ){
278 nRead = nBlob-p->iSeek;
279 }
280 if( nRead<=0 ){
281 return 0;
282 }
283
284 rc = sqlite3_blob_read(p->pBlob, (void *)buf, nRead, p->iSeek);
285 if( rc!=SQLITE_OK ){
286 *errorCodePtr = rc;
287 return -1;
288 }
289
290 p->iSeek += nRead;
291 return nRead;
292}
293
danielk1977d04417962007-05-02 13:16:30 +0000294/*
295** Write data to an incremental blob channel.
296*/
mistachkin7617e4a2016-07-28 17:11:20 +0000297static int SQLITE_TCLAPI incrblobOutput(
mistachkinb56660f2016-07-14 21:26:09 +0000298 ClientData instanceData,
299 CONST char *buf,
danielk1977b4e9af92007-05-01 17:49:49 +0000300 int toWrite,
301 int *errorCodePtr
302){
303 IncrblobChannel *p = (IncrblobChannel *)instanceData;
304 int nWrite = toWrite; /* Number of bytes to write */
305 int nBlob; /* Total size of the blob */
306 int rc; /* sqlite error code */
307
308 nBlob = sqlite3_blob_bytes(p->pBlob);
309 if( (p->iSeek+nWrite)>nBlob ){
310 *errorCodePtr = EINVAL;
311 return -1;
312 }
313 if( nWrite<=0 ){
314 return 0;
315 }
316
317 rc = sqlite3_blob_write(p->pBlob, (void *)buf, nWrite, p->iSeek);
318 if( rc!=SQLITE_OK ){
319 *errorCodePtr = EIO;
320 return -1;
321 }
322
323 p->iSeek += nWrite;
324 return nWrite;
325}
326
327/*
328** Seek an incremental blob channel.
329*/
mistachkin7617e4a2016-07-28 17:11:20 +0000330static int SQLITE_TCLAPI incrblobSeek(
mistachkinb56660f2016-07-14 21:26:09 +0000331 ClientData instanceData,
danielk1977b4e9af92007-05-01 17:49:49 +0000332 long offset,
333 int seekMode,
334 int *errorCodePtr
335){
336 IncrblobChannel *p = (IncrblobChannel *)instanceData;
337
338 switch( seekMode ){
339 case SEEK_SET:
340 p->iSeek = offset;
341 break;
342 case SEEK_CUR:
343 p->iSeek += offset;
344 break;
345 case SEEK_END:
346 p->iSeek = sqlite3_blob_bytes(p->pBlob) + offset;
347 break;
348
349 default: assert(!"Bad seekMode");
350 }
351
352 return p->iSeek;
353}
354
355
mistachkin7617e4a2016-07-28 17:11:20 +0000356static void SQLITE_TCLAPI incrblobWatch(
357 ClientData instanceData,
358 int mode
359){
mistachkinb56660f2016-07-14 21:26:09 +0000360 /* NO-OP */
danielk1977b4e9af92007-05-01 17:49:49 +0000361}
mistachkin7617e4a2016-07-28 17:11:20 +0000362static int SQLITE_TCLAPI incrblobHandle(
363 ClientData instanceData,
364 int dir,
365 ClientData *hPtr
366){
danielk1977b4e9af92007-05-01 17:49:49 +0000367 return TCL_ERROR;
368}
369
370static Tcl_ChannelType IncrblobChannelType = {
371 "incrblob", /* typeName */
372 TCL_CHANNEL_VERSION_2, /* version */
373 incrblobClose, /* closeProc */
374 incrblobInput, /* inputProc */
375 incrblobOutput, /* outputProc */
376 incrblobSeek, /* seekProc */
377 0, /* setOptionProc */
378 0, /* getOptionProc */
379 incrblobWatch, /* watchProc (this is a no-op) */
380 incrblobHandle, /* getHandleProc (always returns error) */
381 0, /* close2Proc */
382 0, /* blockModeProc */
383 0, /* flushProc */
384 0, /* handlerProc */
385 0, /* wideSeekProc */
danielk1977b4e9af92007-05-01 17:49:49 +0000386};
387
388/*
389** Create a new incrblob channel.
390*/
391static int createIncrblobChannel(
mistachkinb56660f2016-07-14 21:26:09 +0000392 Tcl_Interp *interp,
393 SqliteDb *pDb,
danielk1977b4e9af92007-05-01 17:49:49 +0000394 const char *zDb,
mistachkinb56660f2016-07-14 21:26:09 +0000395 const char *zTable,
396 const char *zColumn,
danielk19778cbadb02007-05-03 16:31:26 +0000397 sqlite_int64 iRow,
398 int isReadonly
danielk1977b4e9af92007-05-01 17:49:49 +0000399){
400 IncrblobChannel *p;
danielk19778cbadb02007-05-03 16:31:26 +0000401 sqlite3 *db = pDb->db;
danielk1977b4e9af92007-05-01 17:49:49 +0000402 sqlite3_blob *pBlob;
403 int rc;
danielk19778cbadb02007-05-03 16:31:26 +0000404 int flags = TCL_READABLE|(isReadonly ? 0 : TCL_WRITABLE);
danielk1977b4e9af92007-05-01 17:49:49 +0000405
406 /* This variable is used to name the channels: "incrblob_[incr count]" */
407 static int count = 0;
408 char zChannel[64];
409
danielk19778cbadb02007-05-03 16:31:26 +0000410 rc = sqlite3_blob_open(db, zDb, zTable, zColumn, iRow, !isReadonly, &pBlob);
danielk1977b4e9af92007-05-01 17:49:49 +0000411 if( rc!=SQLITE_OK ){
412 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
413 return TCL_ERROR;
414 }
415
416 p = (IncrblobChannel *)Tcl_Alloc(sizeof(IncrblobChannel));
417 p->iSeek = 0;
418 p->pBlob = pBlob;
419
drh5bb3eb92007-05-04 13:15:55 +0000420 sqlite3_snprintf(sizeof(zChannel), zChannel, "incrblob_%d", ++count);
danielk1977d04417962007-05-02 13:16:30 +0000421 p->channel = Tcl_CreateChannel(&IncrblobChannelType, zChannel, p, flags);
422 Tcl_RegisterChannel(interp, p->channel);
danielk1977b4e9af92007-05-01 17:49:49 +0000423
danielk1977d04417962007-05-02 13:16:30 +0000424 /* Link the new channel into the SqliteDb.pIncrblob list. */
425 p->pNext = pDb->pIncrblob;
426 p->pPrev = 0;
427 if( p->pNext ){
428 p->pNext->pPrev = p;
429 }
430 pDb->pIncrblob = p;
431 p->pDb = pDb;
432
433 Tcl_SetResult(interp, (char *)Tcl_GetChannelName(p->channel), TCL_VOLATILE);
danielk1977b4e9af92007-05-01 17:49:49 +0000434 return TCL_OK;
435}
danielk197732a0d8b2007-05-04 19:03:02 +0000436#else /* else clause for "#ifndef SQLITE_OMIT_INCRBLOB" */
437 #define closeIncrblobChannels(pDb)
438#endif
danielk1977b4e9af92007-05-01 17:49:49 +0000439
drh6d313162000-09-21 13:01:35 +0000440/*
drhd1e47332005-06-26 17:55:33 +0000441** Look at the script prefix in pCmd. We will be executing this script
442** after first appending one or more arguments. This routine analyzes
443** the script to see if it is safe to use Tcl_EvalObjv() on the script
444** rather than the more general Tcl_EvalEx(). Tcl_EvalObjv() is much
445** faster.
446**
447** Scripts that are safe to use with Tcl_EvalObjv() consists of a
448** command name followed by zero or more arguments with no [...] or $
449** or {...} or ; to be seen anywhere. Most callback scripts consist
450** of just a single procedure name and they meet this requirement.
451*/
452static int safeToUseEvalObjv(Tcl_Interp *interp, Tcl_Obj *pCmd){
453 /* We could try to do something with Tcl_Parse(). But we will instead
454 ** just do a search for forbidden characters. If any of the forbidden
455 ** characters appear in pCmd, we will report the string as unsafe.
456 */
457 const char *z;
458 int n;
459 z = Tcl_GetStringFromObj(pCmd, &n);
460 while( n-- > 0 ){
461 int c = *(z++);
462 if( c=='$' || c=='[' || c==';' ) return 0;
463 }
464 return 1;
465}
466
467/*
468** Find an SqlFunc structure with the given name. Or create a new
469** one if an existing one cannot be found. Return a pointer to the
470** structure.
471*/
472static SqlFunc *findSqlFunc(SqliteDb *pDb, const char *zName){
473 SqlFunc *p, *pNew;
drh0425f182013-11-26 16:48:04 +0000474 int nName = strlen30(zName);
475 pNew = (SqlFunc*)Tcl_Alloc( sizeof(*pNew) + nName + 1 );
drhd1e47332005-06-26 17:55:33 +0000476 pNew->zName = (char*)&pNew[1];
drh0425f182013-11-26 16:48:04 +0000477 memcpy(pNew->zName, zName, nName+1);
mistachkinb56660f2016-07-14 21:26:09 +0000478 for(p=pDb->pFunc; p; p=p->pNext){
drh0425f182013-11-26 16:48:04 +0000479 if( sqlite3_stricmp(p->zName, pNew->zName)==0 ){
drhd1e47332005-06-26 17:55:33 +0000480 Tcl_Free((char*)pNew);
481 return p;
482 }
483 }
484 pNew->interp = pDb->interp;
drhc45e6712012-10-03 11:02:33 +0000485 pNew->pDb = pDb;
drhd1e47332005-06-26 17:55:33 +0000486 pNew->pScript = 0;
487 pNew->pNext = pDb->pFunc;
488 pDb->pFunc = pNew;
489 return pNew;
490}
491
492/*
danc431fd52011-06-27 16:55:50 +0000493** Free a single SqlPreparedStmt object.
494*/
495static void dbFreeStmt(SqlPreparedStmt *pStmt){
496#ifdef SQLITE_TEST
497 if( sqlite3_sql(pStmt->pStmt)==0 ){
498 Tcl_Free((char *)pStmt->zSql);
499 }
500#endif
501 sqlite3_finalize(pStmt->pStmt);
502 Tcl_Free((char *)pStmt);
503}
504
505/*
drhfb7e7652005-01-24 00:28:42 +0000506** Finalize and free a list of prepared statements
507*/
danc431fd52011-06-27 16:55:50 +0000508static void flushStmtCache(SqliteDb *pDb){
drhfb7e7652005-01-24 00:28:42 +0000509 SqlPreparedStmt *pPreStmt;
danc431fd52011-06-27 16:55:50 +0000510 SqlPreparedStmt *pNext;
drhfb7e7652005-01-24 00:28:42 +0000511
danc431fd52011-06-27 16:55:50 +0000512 for(pPreStmt = pDb->stmtList; pPreStmt; pPreStmt=pNext){
513 pNext = pPreStmt->pNext;
514 dbFreeStmt(pPreStmt);
drhfb7e7652005-01-24 00:28:42 +0000515 }
516 pDb->nStmt = 0;
517 pDb->stmtLast = 0;
danc431fd52011-06-27 16:55:50 +0000518 pDb->stmtList = 0;
drhfb7e7652005-01-24 00:28:42 +0000519}
520
521/*
danbea28c72021-09-16 14:17:14 +0000522** Increment the reference counter on the SqliteDb object. The reference
523** should be released by calling delDatabaseRef().
524*/
525static void addDatabaseRef(SqliteDb *pDb){
526 pDb->nRef++;
527}
528
529/*
530** Decrement the reference counter associated with the SqliteDb object.
531** If it reaches zero, delete the object.
532*/
533static void delDatabaseRef(SqliteDb *pDb){
534 assert( pDb->nRef>0 );
535 pDb->nRef--;
536 if( pDb->nRef==0 ){
537 flushStmtCache(pDb);
538 closeIncrblobChannels(pDb);
539 sqlite3_close(pDb->db);
540 while( pDb->pFunc ){
541 SqlFunc *pFunc = pDb->pFunc;
542 pDb->pFunc = pFunc->pNext;
543 assert( pFunc->pDb==pDb );
544 Tcl_DecrRefCount(pFunc->pScript);
545 Tcl_Free((char*)pFunc);
546 }
547 while( pDb->pCollate ){
548 SqlCollate *pCollate = pDb->pCollate;
549 pDb->pCollate = pCollate->pNext;
550 Tcl_Free((char*)pCollate);
551 }
552 if( pDb->zBusy ){
553 Tcl_Free(pDb->zBusy);
554 }
555 if( pDb->zTrace ){
556 Tcl_Free(pDb->zTrace);
557 }
558 if( pDb->zTraceV2 ){
559 Tcl_Free(pDb->zTraceV2);
560 }
561 if( pDb->zProfile ){
562 Tcl_Free(pDb->zProfile);
563 }
564 if( pDb->zBindFallback ){
565 Tcl_Free(pDb->zBindFallback);
566 }
567 if( pDb->zAuth ){
568 Tcl_Free(pDb->zAuth);
569 }
570 if( pDb->zNull ){
571 Tcl_Free(pDb->zNull);
572 }
573 if( pDb->pUpdateHook ){
574 Tcl_DecrRefCount(pDb->pUpdateHook);
575 }
576 if( pDb->pPreUpdateHook ){
577 Tcl_DecrRefCount(pDb->pPreUpdateHook);
578 }
579 if( pDb->pRollbackHook ){
580 Tcl_DecrRefCount(pDb->pRollbackHook);
581 }
582 if( pDb->pWalHook ){
583 Tcl_DecrRefCount(pDb->pWalHook);
584 }
585 if( pDb->pCollateNeeded ){
586 Tcl_DecrRefCount(pDb->pCollateNeeded);
587 }
588 Tcl_Free((char*)pDb);
589 }
590}
591
592/*
drh895d7472004-08-20 16:02:39 +0000593** TCL calls this procedure when an sqlite3 database command is
594** deleted.
drh75897232000-05-29 14:26:00 +0000595*/
mistachkin7617e4a2016-07-28 17:11:20 +0000596static void SQLITE_TCLAPI DbDeleteCmd(void *db){
drhbec3f402000-08-04 13:49:02 +0000597 SqliteDb *pDb = (SqliteDb*)db;
danbea28c72021-09-16 14:17:14 +0000598 delDatabaseRef(pDb);
drhbec3f402000-08-04 13:49:02 +0000599}
600
601/*
602** This routine is called when a database file is locked while trying
603** to execute SQL.
604*/
danielk19772a764eb2004-06-12 01:43:26 +0000605static int DbBusyHandler(void *cd, int nTries){
drhbec3f402000-08-04 13:49:02 +0000606 SqliteDb *pDb = (SqliteDb*)cd;
607 int rc;
608 char zVal[30];
drhbec3f402000-08-04 13:49:02 +0000609
drh5bb3eb92007-05-04 13:15:55 +0000610 sqlite3_snprintf(sizeof(zVal), zVal, "%d", nTries);
drhd1e47332005-06-26 17:55:33 +0000611 rc = Tcl_VarEval(pDb->interp, pDb->zBusy, " ", zVal, (char*)0);
drhbec3f402000-08-04 13:49:02 +0000612 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
613 return 0;
614 }
615 return 1;
drh75897232000-05-29 14:26:00 +0000616}
617
drh26e4a8b2008-05-01 17:16:52 +0000618#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
drh75897232000-05-29 14:26:00 +0000619/*
danielk1977348bb5d2003-10-18 09:37:26 +0000620** This routine is invoked as the 'progress callback' for the database.
621*/
622static int DbProgressHandler(void *cd){
623 SqliteDb *pDb = (SqliteDb*)cd;
624 int rc;
625
626 assert( pDb->zProgress );
627 rc = Tcl_Eval(pDb->interp, pDb->zProgress);
628 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
629 return 1;
630 }
631 return 0;
632}
drh26e4a8b2008-05-01 17:16:52 +0000633#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000634
drh2eb22af2016-09-10 19:51:40 +0000635#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
636 !defined(SQLITE_OMIT_DEPRECATED)
danielk1977348bb5d2003-10-18 09:37:26 +0000637/*
drhb5a20d32003-04-23 12:25:23 +0000638** This routine is called by the SQLite trace handler whenever a new
639** block of SQL is executed. The TCL script in pDb->zTrace is executed.
drh0d1a6432003-04-03 15:46:04 +0000640*/
drhb5a20d32003-04-23 12:25:23 +0000641static void DbTraceHandler(void *cd, const char *zSql){
drh0d1a6432003-04-03 15:46:04 +0000642 SqliteDb *pDb = (SqliteDb*)cd;
drhb5a20d32003-04-23 12:25:23 +0000643 Tcl_DString str;
drh0d1a6432003-04-03 15:46:04 +0000644
drhb5a20d32003-04-23 12:25:23 +0000645 Tcl_DStringInit(&str);
646 Tcl_DStringAppend(&str, pDb->zTrace, -1);
647 Tcl_DStringAppendElement(&str, zSql);
648 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
649 Tcl_DStringFree(&str);
650 Tcl_ResetResult(pDb->interp);
drh0d1a6432003-04-03 15:46:04 +0000651}
drhd1167392006-01-23 13:00:35 +0000652#endif
drh0d1a6432003-04-03 15:46:04 +0000653
drhd1167392006-01-23 13:00:35 +0000654#ifndef SQLITE_OMIT_TRACE
drh0d1a6432003-04-03 15:46:04 +0000655/*
mistachkinb56660f2016-07-14 21:26:09 +0000656** This routine is called by the SQLite trace_v2 handler whenever a new
657** supported event is generated. Unsupported event types are ignored.
658** The TCL script in pDb->zTraceV2 is executed, with the arguments for
659** the event appended to it (as list elements).
660*/
661static int DbTraceV2Handler(
662 unsigned type, /* One of the SQLITE_TRACE_* event types. */
663 void *cd, /* The original context data pointer. */
664 void *pd, /* Primary event data, depends on event type. */
665 void *xd /* Extra event data, depends on event type. */
666){
667 SqliteDb *pDb = (SqliteDb*)cd;
668 Tcl_Obj *pCmd;
669
670 switch( type ){
671 case SQLITE_TRACE_STMT: {
672 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
673 char *zSql = (char *)xd;
674
675 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
676 Tcl_IncrRefCount(pCmd);
677 Tcl_ListObjAppendElement(pDb->interp, pCmd,
678 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
679 Tcl_ListObjAppendElement(pDb->interp, pCmd,
680 Tcl_NewStringObj(zSql, -1));
681 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
682 Tcl_DecrRefCount(pCmd);
683 Tcl_ResetResult(pDb->interp);
684 break;
685 }
686 case SQLITE_TRACE_PROFILE: {
687 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
drhffdab722018-03-10 20:25:08 +0000688 sqlite3_int64 ns = *(sqlite3_int64*)xd;
mistachkinb56660f2016-07-14 21:26:09 +0000689
690 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
691 Tcl_IncrRefCount(pCmd);
692 Tcl_ListObjAppendElement(pDb->interp, pCmd,
693 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
694 Tcl_ListObjAppendElement(pDb->interp, pCmd,
695 Tcl_NewWideIntObj((Tcl_WideInt)ns));
696 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
697 Tcl_DecrRefCount(pCmd);
698 Tcl_ResetResult(pDb->interp);
699 break;
700 }
701 case SQLITE_TRACE_ROW: {
702 sqlite3_stmt *pStmt = (sqlite3_stmt *)pd;
703
704 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
705 Tcl_IncrRefCount(pCmd);
706 Tcl_ListObjAppendElement(pDb->interp, pCmd,
707 Tcl_NewWideIntObj((Tcl_WideInt)pStmt));
708 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
709 Tcl_DecrRefCount(pCmd);
710 Tcl_ResetResult(pDb->interp);
711 break;
712 }
713 case SQLITE_TRACE_CLOSE: {
714 sqlite3 *db = (sqlite3 *)pd;
715
716 pCmd = Tcl_NewStringObj(pDb->zTraceV2, -1);
717 Tcl_IncrRefCount(pCmd);
718 Tcl_ListObjAppendElement(pDb->interp, pCmd,
719 Tcl_NewWideIntObj((Tcl_WideInt)db));
720 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
721 Tcl_DecrRefCount(pCmd);
722 Tcl_ResetResult(pDb->interp);
723 break;
724 }
725 }
726 return SQLITE_OK;
727}
728#endif
729
drh2eb22af2016-09-10 19:51:40 +0000730#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
731 !defined(SQLITE_OMIT_DEPRECATED)
mistachkinb56660f2016-07-14 21:26:09 +0000732/*
drh19e2d372005-08-29 23:00:03 +0000733** This routine is called by the SQLite profile handler after a statement
734** SQL has executed. The TCL script in pDb->zProfile is evaluated.
735*/
736static void DbProfileHandler(void *cd, const char *zSql, sqlite_uint64 tm){
737 SqliteDb *pDb = (SqliteDb*)cd;
738 Tcl_DString str;
739 char zTm[100];
740
741 sqlite3_snprintf(sizeof(zTm)-1, zTm, "%lld", tm);
742 Tcl_DStringInit(&str);
743 Tcl_DStringAppend(&str, pDb->zProfile, -1);
744 Tcl_DStringAppendElement(&str, zSql);
745 Tcl_DStringAppendElement(&str, zTm);
746 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
747 Tcl_DStringFree(&str);
748 Tcl_ResetResult(pDb->interp);
749}
drhd1167392006-01-23 13:00:35 +0000750#endif
drh19e2d372005-08-29 23:00:03 +0000751
752/*
drhaa940ea2004-01-15 02:44:03 +0000753** This routine is called when a transaction is committed. The
754** TCL script in pDb->zCommit is executed. If it returns non-zero or
755** if it throws an exception, the transaction is rolled back instead
756** of being committed.
757*/
758static int DbCommitHandler(void *cd){
759 SqliteDb *pDb = (SqliteDb*)cd;
760 int rc;
761
762 rc = Tcl_Eval(pDb->interp, pDb->zCommit);
763 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
764 return 1;
765 }
766 return 0;
767}
768
danielk197771fd80b2005-12-16 06:54:01 +0000769static void DbRollbackHandler(void *clientData){
770 SqliteDb *pDb = (SqliteDb*)clientData;
771 assert(pDb->pRollbackHook);
772 if( TCL_OK!=Tcl_EvalObjEx(pDb->interp, pDb->pRollbackHook, 0) ){
773 Tcl_BackgroundError(pDb->interp);
774 }
775}
776
drh5def0842010-05-05 20:00:25 +0000777/*
778** This procedure handles wal_hook callbacks.
779*/
780static int DbWalHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000781 void *clientData,
782 sqlite3 *db,
783 const char *zDb,
dan8d22a172010-04-19 18:03:51 +0000784 int nEntry
785){
drh5def0842010-05-05 20:00:25 +0000786 int ret = SQLITE_OK;
dan8d22a172010-04-19 18:03:51 +0000787 Tcl_Obj *p;
788 SqliteDb *pDb = (SqliteDb*)clientData;
789 Tcl_Interp *interp = pDb->interp;
drh5def0842010-05-05 20:00:25 +0000790 assert(pDb->pWalHook);
dan8d22a172010-04-19 18:03:51 +0000791
dan6e45e0c2014-12-10 20:29:49 +0000792 assert( db==pDb->db );
drh5def0842010-05-05 20:00:25 +0000793 p = Tcl_DuplicateObj(pDb->pWalHook);
dan8d22a172010-04-19 18:03:51 +0000794 Tcl_IncrRefCount(p);
795 Tcl_ListObjAppendElement(interp, p, Tcl_NewStringObj(zDb, -1));
796 Tcl_ListObjAppendElement(interp, p, Tcl_NewIntObj(nEntry));
mistachkinb56660f2016-07-14 21:26:09 +0000797 if( TCL_OK!=Tcl_EvalObjEx(interp, p, 0)
dan8d22a172010-04-19 18:03:51 +0000798 || TCL_OK!=Tcl_GetIntFromObj(interp, Tcl_GetObjResult(interp), &ret)
799 ){
800 Tcl_BackgroundError(interp);
801 }
802 Tcl_DecrRefCount(p);
803
804 return ret;
805}
806
drhbcf4f482009-03-27 12:44:35 +0000807#if defined(SQLITE_TEST) && defined(SQLITE_ENABLE_UNLOCK_NOTIFY)
danielk1977404ca072009-03-16 13:19:36 +0000808static void setTestUnlockNotifyVars(Tcl_Interp *interp, int iArg, int nArg){
809 char zBuf[64];
drh65545b52015-01-19 00:35:53 +0000810 sqlite3_snprintf(sizeof(zBuf), zBuf, "%d", iArg);
danielk1977404ca072009-03-16 13:19:36 +0000811 Tcl_SetVar(interp, "sqlite_unlock_notify_arg", zBuf, TCL_GLOBAL_ONLY);
drh65545b52015-01-19 00:35:53 +0000812 sqlite3_snprintf(sizeof(zBuf), zBuf, "%d", nArg);
danielk1977404ca072009-03-16 13:19:36 +0000813 Tcl_SetVar(interp, "sqlite_unlock_notify_argcount", zBuf, TCL_GLOBAL_ONLY);
814}
815#else
drhbcf4f482009-03-27 12:44:35 +0000816# define setTestUnlockNotifyVars(x,y,z)
danielk1977404ca072009-03-16 13:19:36 +0000817#endif
818
drh69910da2009-03-27 12:32:54 +0000819#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
danielk1977404ca072009-03-16 13:19:36 +0000820static void DbUnlockNotify(void **apArg, int nArg){
821 int i;
822 for(i=0; i<nArg; i++){
823 const int flags = (TCL_EVAL_GLOBAL|TCL_EVAL_DIRECT);
824 SqliteDb *pDb = (SqliteDb *)apArg[i];
825 setTestUnlockNotifyVars(pDb->interp, i, nArg);
826 assert( pDb->pUnlockNotify);
827 Tcl_EvalObjEx(pDb->interp, pDb->pUnlockNotify, flags);
828 Tcl_DecrRefCount(pDb->pUnlockNotify);
829 pDb->pUnlockNotify = 0;
830 }
831}
drh69910da2009-03-27 12:32:54 +0000832#endif
danielk1977404ca072009-03-16 13:19:36 +0000833
drh9b1c62d2011-03-30 21:04:43 +0000834#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +0000835/*
836** Pre-update hook callback.
837*/
838static void DbPreUpdateHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000839 void *p,
dan46c47d42011-03-01 18:42:07 +0000840 sqlite3 *db,
841 int op,
mistachkinb56660f2016-07-14 21:26:09 +0000842 const char *zDb,
843 const char *zTbl,
dan46c47d42011-03-01 18:42:07 +0000844 sqlite_int64 iKey1,
845 sqlite_int64 iKey2
846){
847 SqliteDb *pDb = (SqliteDb *)p;
848 Tcl_Obj *pCmd;
849 static const char *azStr[] = {"DELETE", "INSERT", "UPDATE"};
850
851 assert( (SQLITE_DELETE-1)/9 == 0 );
852 assert( (SQLITE_INSERT-1)/9 == 1 );
853 assert( (SQLITE_UPDATE-1)/9 == 2 );
854 assert( pDb->pPreUpdateHook );
855 assert( db==pDb->db );
856 assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
857
858 pCmd = Tcl_DuplicateObj(pDb->pPreUpdateHook);
859 Tcl_IncrRefCount(pCmd);
860 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(azStr[(op-1)/9], -1));
861 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
862 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
863 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(iKey1));
864 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(iKey2));
865 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
866 Tcl_DecrRefCount(pCmd);
867}
drh9b1c62d2011-03-30 21:04:43 +0000868#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +0000869
danielk197794eb6a12005-12-15 15:22:08 +0000870static void DbUpdateHandler(
mistachkinb56660f2016-07-14 21:26:09 +0000871 void *p,
danielk197794eb6a12005-12-15 15:22:08 +0000872 int op,
mistachkinb56660f2016-07-14 21:26:09 +0000873 const char *zDb,
874 const char *zTbl,
danielk197794eb6a12005-12-15 15:22:08 +0000875 sqlite_int64 rowid
876){
877 SqliteDb *pDb = (SqliteDb *)p;
878 Tcl_Obj *pCmd;
dan46c47d42011-03-01 18:42:07 +0000879 static const char *azStr[] = {"DELETE", "INSERT", "UPDATE"};
880
881 assert( (SQLITE_DELETE-1)/9 == 0 );
882 assert( (SQLITE_INSERT-1)/9 == 1 );
883 assert( (SQLITE_UPDATE-1)/9 == 2 );
danielk197794eb6a12005-12-15 15:22:08 +0000884
885 assert( pDb->pUpdateHook );
886 assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
887
888 pCmd = Tcl_DuplicateObj(pDb->pUpdateHook);
889 Tcl_IncrRefCount(pCmd);
dan46c47d42011-03-01 18:42:07 +0000890 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(azStr[(op-1)/9], -1));
danielk197794eb6a12005-12-15 15:22:08 +0000891 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
892 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
893 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(rowid));
894 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
drhefdde162010-10-27 15:36:21 +0000895 Tcl_DecrRefCount(pCmd);
danielk197794eb6a12005-12-15 15:22:08 +0000896}
897
danielk19777cedc8d2004-06-10 10:50:08 +0000898static void tclCollateNeeded(
899 void *pCtx,
drh9bb575f2004-09-06 17:24:11 +0000900 sqlite3 *db,
danielk19777cedc8d2004-06-10 10:50:08 +0000901 int enc,
902 const char *zName
903){
904 SqliteDb *pDb = (SqliteDb *)pCtx;
905 Tcl_Obj *pScript = Tcl_DuplicateObj(pDb->pCollateNeeded);
906 Tcl_IncrRefCount(pScript);
907 Tcl_ListObjAppendElement(0, pScript, Tcl_NewStringObj(zName, -1));
908 Tcl_EvalObjEx(pDb->interp, pScript, 0);
909 Tcl_DecrRefCount(pScript);
910}
911
drhaa940ea2004-01-15 02:44:03 +0000912/*
danielk19770202b292004-06-09 09:55:16 +0000913** This routine is called to evaluate an SQL collation function implemented
914** using TCL script.
915*/
916static int tclSqlCollate(
917 void *pCtx,
918 int nA,
919 const void *zA,
920 int nB,
921 const void *zB
922){
923 SqlCollate *p = (SqlCollate *)pCtx;
924 Tcl_Obj *pCmd;
925
926 pCmd = Tcl_NewStringObj(p->zScript, -1);
927 Tcl_IncrRefCount(pCmd);
928 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zA, nA));
929 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zB, nB));
drhd1e47332005-06-26 17:55:33 +0000930 Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
danielk19770202b292004-06-09 09:55:16 +0000931 Tcl_DecrRefCount(pCmd);
932 return (atoi(Tcl_GetStringResult(p->interp)));
933}
934
935/*
drhcabb0812002-09-14 13:47:32 +0000936** This routine is called to evaluate an SQL function implemented
937** using TCL script.
938*/
drhfb7e7652005-01-24 00:28:42 +0000939static void tclSqlFunc(sqlite3_context *context, int argc, sqlite3_value**argv){
danielk19776f8a5032004-05-10 10:34:51 +0000940 SqlFunc *p = sqlite3_user_data(context);
drhd1e47332005-06-26 17:55:33 +0000941 Tcl_Obj *pCmd;
drhcabb0812002-09-14 13:47:32 +0000942 int i;
943 int rc;
944
drhd1e47332005-06-26 17:55:33 +0000945 if( argc==0 ){
946 /* If there are no arguments to the function, call Tcl_EvalObjEx on the
947 ** script object directly. This allows the TCL compiler to generate
948 ** bytecode for the command on the first invocation and thus make
949 ** subsequent invocations much faster. */
950 pCmd = p->pScript;
951 Tcl_IncrRefCount(pCmd);
952 rc = Tcl_EvalObjEx(p->interp, pCmd, 0);
953 Tcl_DecrRefCount(pCmd);
954 }else{
955 /* If there are arguments to the function, make a shallow copy of the
956 ** script object, lappend the arguments, then evaluate the copy.
957 **
peter.d.reid60ec9142014-09-06 16:39:46 +0000958 ** By "shallow" copy, we mean only the outer list Tcl_Obj is duplicated.
mistachkinb56660f2016-07-14 21:26:09 +0000959 ** The new Tcl_Obj contains pointers to the original list elements.
drhd1e47332005-06-26 17:55:33 +0000960 ** That way, when Tcl_EvalObjv() is run and shimmers the first element
961 ** of the list to tclCmdNameType, that alternate representation will
962 ** be preserved and reused on the next invocation.
963 */
964 Tcl_Obj **aArg;
965 int nArg;
966 if( Tcl_ListObjGetElements(p->interp, p->pScript, &nArg, &aArg) ){
mistachkinb56660f2016-07-14 21:26:09 +0000967 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhd1e47332005-06-26 17:55:33 +0000968 return;
mistachkinb56660f2016-07-14 21:26:09 +0000969 }
drhd1e47332005-06-26 17:55:33 +0000970 pCmd = Tcl_NewListObj(nArg, aArg);
971 Tcl_IncrRefCount(pCmd);
972 for(i=0; i<argc; i++){
973 sqlite3_value *pIn = argv[i];
974 Tcl_Obj *pVal;
mistachkinb56660f2016-07-14 21:26:09 +0000975
drhd1e47332005-06-26 17:55:33 +0000976 /* Set pVal to contain the i'th column of this row. */
977 switch( sqlite3_value_type(pIn) ){
978 case SQLITE_BLOB: {
979 int bytes = sqlite3_value_bytes(pIn);
980 pVal = Tcl_NewByteArrayObj(sqlite3_value_blob(pIn), bytes);
981 break;
982 }
983 case SQLITE_INTEGER: {
984 sqlite_int64 v = sqlite3_value_int64(pIn);
985 if( v>=-2147483647 && v<=2147483647 ){
drh7fd33922011-06-20 19:00:30 +0000986 pVal = Tcl_NewIntObj((int)v);
drhd1e47332005-06-26 17:55:33 +0000987 }else{
988 pVal = Tcl_NewWideIntObj(v);
989 }
990 break;
991 }
992 case SQLITE_FLOAT: {
993 double r = sqlite3_value_double(pIn);
994 pVal = Tcl_NewDoubleObj(r);
995 break;
996 }
997 case SQLITE_NULL: {
drhc45e6712012-10-03 11:02:33 +0000998 pVal = Tcl_NewStringObj(p->pDb->zNull, -1);
drhd1e47332005-06-26 17:55:33 +0000999 break;
1000 }
1001 default: {
1002 int bytes = sqlite3_value_bytes(pIn);
danielk197700fd9572005-12-07 06:27:43 +00001003 pVal = Tcl_NewStringObj((char *)sqlite3_value_text(pIn), bytes);
drhd1e47332005-06-26 17:55:33 +00001004 break;
1005 }
1006 }
1007 rc = Tcl_ListObjAppendElement(p->interp, pCmd, pVal);
1008 if( rc ){
1009 Tcl_DecrRefCount(pCmd);
mistachkinb56660f2016-07-14 21:26:09 +00001010 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhd1e47332005-06-26 17:55:33 +00001011 return;
1012 }
danielk197751ad0ec2004-05-24 12:39:02 +00001013 }
drhd1e47332005-06-26 17:55:33 +00001014 if( !p->useEvalObjv ){
1015 /* Tcl_EvalObjEx() will automatically call Tcl_EvalObjv() if pCmd
1016 ** is a list without a string representation. To prevent this from
1017 ** happening, make sure pCmd has a valid string representation */
1018 Tcl_GetString(pCmd);
1019 }
1020 rc = Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
1021 Tcl_DecrRefCount(pCmd);
drhcabb0812002-09-14 13:47:32 +00001022 }
danielk1977562e8d32005-05-20 09:40:55 +00001023
drhc7f269d2005-05-05 10:30:29 +00001024 if( rc && rc!=TCL_RETURN ){
mistachkinb56660f2016-07-14 21:26:09 +00001025 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhcabb0812002-09-14 13:47:32 +00001026 }else{
drhc7f269d2005-05-05 10:30:29 +00001027 Tcl_Obj *pVar = Tcl_GetObjResult(p->interp);
1028 int n;
1029 u8 *data;
dan4a4c11a2009-10-06 14:59:02 +00001030 const char *zType = (pVar->typePtr ? pVar->typePtr->name : "");
drhc7f269d2005-05-05 10:30:29 +00001031 char c = zType[0];
dan89d24932019-02-27 16:38:19 +00001032 int eType = p->eType;
1033
1034 if( eType==SQLITE_NULL ){
1035 if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
1036 /* Only return a BLOB type if the Tcl variable is a bytearray and
1037 ** has no string representation. */
1038 eType = SQLITE_BLOB;
1039 }else if( (c=='b' && strcmp(zType,"boolean")==0)
1040 || (c=='w' && strcmp(zType,"wideInt")==0)
1041 || (c=='i' && strcmp(zType,"int")==0)
1042 ){
1043 eType = SQLITE_INTEGER;
1044 }else if( c=='d' && strcmp(zType,"double")==0 ){
1045 eType = SQLITE_FLOAT;
1046 }else{
1047 eType = SQLITE_TEXT;
1048 }
drhc7f269d2005-05-05 10:30:29 +00001049 }
dan89d24932019-02-27 16:38:19 +00001050
1051 switch( eType ){
1052 case SQLITE_BLOB: {
1053 data = Tcl_GetByteArrayFromObj(pVar, &n);
1054 sqlite3_result_blob(context, data, n, SQLITE_TRANSIENT);
1055 break;
1056 }
1057 case SQLITE_INTEGER: {
1058 Tcl_WideInt v;
1059 if( TCL_OK==Tcl_GetWideIntFromObj(0, pVar, &v) ){
1060 sqlite3_result_int64(context, v);
1061 break;
1062 }
1063 /* fall-through */
1064 }
1065 case SQLITE_FLOAT: {
1066 double r;
1067 if( TCL_OK==Tcl_GetDoubleFromObj(0, pVar, &r) ){
1068 sqlite3_result_double(context, r);
1069 break;
1070 }
1071 /* fall-through */
1072 }
1073 default: {
1074 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
1075 sqlite3_result_text(context, (char *)data, n, SQLITE_TRANSIENT);
1076 break;
1077 }
1078 }
1079
drhcabb0812002-09-14 13:47:32 +00001080 }
1081}
drh895d7472004-08-20 16:02:39 +00001082
drhe22a3342003-04-22 20:30:37 +00001083#ifndef SQLITE_OMIT_AUTHORIZATION
1084/*
1085** This is the authentication function. It appends the authentication
1086** type code and the two arguments to zCmd[] then invokes the result
1087** on the interpreter. The reply is examined to determine if the
1088** authentication fails or succeeds.
1089*/
1090static int auth_callback(
1091 void *pArg,
1092 int code,
1093 const char *zArg1,
1094 const char *zArg2,
1095 const char *zArg3,
1096 const char *zArg4
drh32c6a482014-09-11 13:44:52 +00001097#ifdef SQLITE_USER_AUTHENTICATION
1098 ,const char *zArg5
1099#endif
drhe22a3342003-04-22 20:30:37 +00001100){
mistachkin6ef5e122014-01-24 17:03:55 +00001101 const char *zCode;
drhe22a3342003-04-22 20:30:37 +00001102 Tcl_DString str;
1103 int rc;
1104 const char *zReply;
drh94189212017-05-11 13:43:57 +00001105 /* EVIDENCE-OF: R-38590-62769 The first parameter to the authorizer
1106 ** callback is a copy of the third parameter to the
1107 ** sqlite3_set_authorizer() interface.
1108 */
drhe22a3342003-04-22 20:30:37 +00001109 SqliteDb *pDb = (SqliteDb*)pArg;
drh1f1549f2008-08-26 21:33:34 +00001110 if( pDb->disableAuth ) return SQLITE_OK;
drhe22a3342003-04-22 20:30:37 +00001111
drh94189212017-05-11 13:43:57 +00001112 /* EVIDENCE-OF: R-56518-44310 The second parameter to the callback is an
1113 ** integer action code that specifies the particular action to be
1114 ** authorized. */
drhe22a3342003-04-22 20:30:37 +00001115 switch( code ){
1116 case SQLITE_COPY : zCode="SQLITE_COPY"; break;
1117 case SQLITE_CREATE_INDEX : zCode="SQLITE_CREATE_INDEX"; break;
1118 case SQLITE_CREATE_TABLE : zCode="SQLITE_CREATE_TABLE"; break;
1119 case SQLITE_CREATE_TEMP_INDEX : zCode="SQLITE_CREATE_TEMP_INDEX"; break;
1120 case SQLITE_CREATE_TEMP_TABLE : zCode="SQLITE_CREATE_TEMP_TABLE"; break;
1121 case SQLITE_CREATE_TEMP_TRIGGER: zCode="SQLITE_CREATE_TEMP_TRIGGER"; break;
1122 case SQLITE_CREATE_TEMP_VIEW : zCode="SQLITE_CREATE_TEMP_VIEW"; break;
1123 case SQLITE_CREATE_TRIGGER : zCode="SQLITE_CREATE_TRIGGER"; break;
1124 case SQLITE_CREATE_VIEW : zCode="SQLITE_CREATE_VIEW"; break;
1125 case SQLITE_DELETE : zCode="SQLITE_DELETE"; break;
1126 case SQLITE_DROP_INDEX : zCode="SQLITE_DROP_INDEX"; break;
1127 case SQLITE_DROP_TABLE : zCode="SQLITE_DROP_TABLE"; break;
1128 case SQLITE_DROP_TEMP_INDEX : zCode="SQLITE_DROP_TEMP_INDEX"; break;
1129 case SQLITE_DROP_TEMP_TABLE : zCode="SQLITE_DROP_TEMP_TABLE"; break;
1130 case SQLITE_DROP_TEMP_TRIGGER : zCode="SQLITE_DROP_TEMP_TRIGGER"; break;
1131 case SQLITE_DROP_TEMP_VIEW : zCode="SQLITE_DROP_TEMP_VIEW"; break;
1132 case SQLITE_DROP_TRIGGER : zCode="SQLITE_DROP_TRIGGER"; break;
1133 case SQLITE_DROP_VIEW : zCode="SQLITE_DROP_VIEW"; break;
1134 case SQLITE_INSERT : zCode="SQLITE_INSERT"; break;
1135 case SQLITE_PRAGMA : zCode="SQLITE_PRAGMA"; break;
1136 case SQLITE_READ : zCode="SQLITE_READ"; break;
1137 case SQLITE_SELECT : zCode="SQLITE_SELECT"; break;
1138 case SQLITE_TRANSACTION : zCode="SQLITE_TRANSACTION"; break;
1139 case SQLITE_UPDATE : zCode="SQLITE_UPDATE"; break;
drh81e293b2003-06-06 19:00:42 +00001140 case SQLITE_ATTACH : zCode="SQLITE_ATTACH"; break;
1141 case SQLITE_DETACH : zCode="SQLITE_DETACH"; break;
danielk19771c8c23c2004-11-12 15:53:37 +00001142 case SQLITE_ALTER_TABLE : zCode="SQLITE_ALTER_TABLE"; break;
danielk19771d54df82004-11-23 15:41:16 +00001143 case SQLITE_REINDEX : zCode="SQLITE_REINDEX"; break;
drhe6e04962005-07-23 02:17:03 +00001144 case SQLITE_ANALYZE : zCode="SQLITE_ANALYZE"; break;
danielk1977f1a381e2006-06-16 08:01:02 +00001145 case SQLITE_CREATE_VTABLE : zCode="SQLITE_CREATE_VTABLE"; break;
1146 case SQLITE_DROP_VTABLE : zCode="SQLITE_DROP_VTABLE"; break;
drh5169bbc2006-08-24 14:59:45 +00001147 case SQLITE_FUNCTION : zCode="SQLITE_FUNCTION"; break;
danielk1977ab9b7032008-12-30 06:24:58 +00001148 case SQLITE_SAVEPOINT : zCode="SQLITE_SAVEPOINT"; break;
drh65a2aaa2014-01-16 22:40:02 +00001149 case SQLITE_RECURSIVE : zCode="SQLITE_RECURSIVE"; break;
drhe22a3342003-04-22 20:30:37 +00001150 default : zCode="????"; break;
1151 }
1152 Tcl_DStringInit(&str);
1153 Tcl_DStringAppend(&str, pDb->zAuth, -1);
1154 Tcl_DStringAppendElement(&str, zCode);
1155 Tcl_DStringAppendElement(&str, zArg1 ? zArg1 : "");
1156 Tcl_DStringAppendElement(&str, zArg2 ? zArg2 : "");
1157 Tcl_DStringAppendElement(&str, zArg3 ? zArg3 : "");
1158 Tcl_DStringAppendElement(&str, zArg4 ? zArg4 : "");
drh32c6a482014-09-11 13:44:52 +00001159#ifdef SQLITE_USER_AUTHENTICATION
1160 Tcl_DStringAppendElement(&str, zArg5 ? zArg5 : "");
mistachkinb56660f2016-07-14 21:26:09 +00001161#endif
drhe22a3342003-04-22 20:30:37 +00001162 rc = Tcl_GlobalEval(pDb->interp, Tcl_DStringValue(&str));
1163 Tcl_DStringFree(&str);
drhb07028f2011-10-14 21:49:18 +00001164 zReply = rc==TCL_OK ? Tcl_GetStringResult(pDb->interp) : "SQLITE_DENY";
drhe22a3342003-04-22 20:30:37 +00001165 if( strcmp(zReply,"SQLITE_OK")==0 ){
1166 rc = SQLITE_OK;
1167 }else if( strcmp(zReply,"SQLITE_DENY")==0 ){
1168 rc = SQLITE_DENY;
1169 }else if( strcmp(zReply,"SQLITE_IGNORE")==0 ){
1170 rc = SQLITE_IGNORE;
1171 }else{
1172 rc = 999;
1173 }
1174 return rc;
1175}
1176#endif /* SQLITE_OMIT_AUTHORIZATION */
drhcabb0812002-09-14 13:47:32 +00001177
1178/*
tpoindex1067fe12004-12-17 15:41:11 +00001179** This routine reads a line of text from FILE in, stores
1180** the text in memory obtained from malloc() and returns a pointer
1181** to the text. NULL is returned at end of file, or if malloc()
1182** fails.
1183**
1184** The interface is like "readline" but no command-line editing
1185** is done.
1186**
1187** copied from shell.c from '.import' command
1188*/
1189static char *local_getline(char *zPrompt, FILE *in){
1190 char *zLine;
1191 int nLine;
1192 int n;
tpoindex1067fe12004-12-17 15:41:11 +00001193
1194 nLine = 100;
1195 zLine = malloc( nLine );
1196 if( zLine==0 ) return 0;
1197 n = 0;
drhb07028f2011-10-14 21:49:18 +00001198 while( 1 ){
tpoindex1067fe12004-12-17 15:41:11 +00001199 if( n+100>nLine ){
1200 nLine = nLine*2 + 100;
1201 zLine = realloc(zLine, nLine);
1202 if( zLine==0 ) return 0;
1203 }
1204 if( fgets(&zLine[n], nLine - n, in)==0 ){
1205 if( n==0 ){
1206 free(zLine);
1207 return 0;
1208 }
1209 zLine[n] = 0;
tpoindex1067fe12004-12-17 15:41:11 +00001210 break;
1211 }
1212 while( zLine[n] ){ n++; }
1213 if( n>0 && zLine[n-1]=='\n' ){
1214 n--;
1215 zLine[n] = 0;
drhb07028f2011-10-14 21:49:18 +00001216 break;
tpoindex1067fe12004-12-17 15:41:11 +00001217 }
1218 }
1219 zLine = realloc( zLine, n+1 );
1220 return zLine;
1221}
1222
danielk19778e556522007-11-13 10:30:24 +00001223
1224/*
dan4a4c11a2009-10-06 14:59:02 +00001225** This function is part of the implementation of the command:
danielk19778e556522007-11-13 10:30:24 +00001226**
dan4a4c11a2009-10-06 14:59:02 +00001227** $db transaction [-deferred|-immediate|-exclusive] SCRIPT
danielk19778e556522007-11-13 10:30:24 +00001228**
dan4a4c11a2009-10-06 14:59:02 +00001229** It is invoked after evaluating the script SCRIPT to commit or rollback
1230** the transaction or savepoint opened by the [transaction] command.
1231*/
mistachkina121cc72016-07-28 18:06:52 +00001232static int SQLITE_TCLAPI DbTransPostCmd(
dan4a4c11a2009-10-06 14:59:02 +00001233 ClientData data[], /* data[0] is the Sqlite3Db* for $db */
1234 Tcl_Interp *interp, /* Tcl interpreter */
1235 int result /* Result of evaluating SCRIPT */
1236){
mistachkin6ef5e122014-01-24 17:03:55 +00001237 static const char *const azEnd[] = {
dan4a4c11a2009-10-06 14:59:02 +00001238 "RELEASE _tcl_transaction", /* rc==TCL_ERROR, nTransaction!=0 */
1239 "COMMIT", /* rc!=TCL_ERROR, nTransaction==0 */
1240 "ROLLBACK TO _tcl_transaction ; RELEASE _tcl_transaction",
1241 "ROLLBACK" /* rc==TCL_ERROR, nTransaction==0 */
1242 };
1243 SqliteDb *pDb = (SqliteDb*)data[0];
1244 int rc = result;
1245 const char *zEnd;
1246
1247 pDb->nTransaction--;
1248 zEnd = azEnd[(rc==TCL_ERROR)*2 + (pDb->nTransaction==0)];
1249
1250 pDb->disableAuth++;
1251 if( sqlite3_exec(pDb->db, zEnd, 0, 0, 0) ){
1252 /* This is a tricky scenario to handle. The most likely cause of an
mistachkinb56660f2016-07-14 21:26:09 +00001253 ** error is that the exec() above was an attempt to commit the
dan4a4c11a2009-10-06 14:59:02 +00001254 ** top-level transaction that returned SQLITE_BUSY. Or, less likely,
mistachkin48864df2013-03-21 21:20:32 +00001255 ** that an IO-error has occurred. In either case, throw a Tcl exception
dan4a4c11a2009-10-06 14:59:02 +00001256 ** and try to rollback the transaction.
1257 **
mistachkinb56660f2016-07-14 21:26:09 +00001258 ** But it could also be that the user executed one or more BEGIN,
dan4a4c11a2009-10-06 14:59:02 +00001259 ** COMMIT, SAVEPOINT, RELEASE or ROLLBACK commands that are confusing
1260 ** this method's logic. Not clear how this would be best handled.
1261 */
1262 if( rc!=TCL_ERROR ){
drha198f2b2014-02-07 19:26:13 +00001263 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
dan4a4c11a2009-10-06 14:59:02 +00001264 rc = TCL_ERROR;
1265 }
1266 sqlite3_exec(pDb->db, "ROLLBACK", 0, 0, 0);
1267 }
1268 pDb->disableAuth--;
1269
danbea28c72021-09-16 14:17:14 +00001270 delDatabaseRef(pDb);
dan4a4c11a2009-10-06 14:59:02 +00001271 return rc;
1272}
1273
1274/*
danc431fd52011-06-27 16:55:50 +00001275** Unless SQLITE_TEST is defined, this function is a simple wrapper around
1276** sqlite3_prepare_v2(). If SQLITE_TEST is defined, then it uses either
1277** sqlite3_prepare_v2() or legacy interface sqlite3_prepare(), depending
mistachkinb56660f2016-07-14 21:26:09 +00001278** on whether or not the [db_use_legacy_prepare] command has been used to
danc431fd52011-06-27 16:55:50 +00001279** configure the connection.
1280*/
1281static int dbPrepare(
1282 SqliteDb *pDb, /* Database object */
1283 const char *zSql, /* SQL to compile */
1284 sqlite3_stmt **ppStmt, /* OUT: Prepared statement */
1285 const char **pzOut /* OUT: Pointer to next SQL statement */
1286){
drh2c2f3922017-06-01 00:54:35 +00001287 unsigned int prepFlags = 0;
danc431fd52011-06-27 16:55:50 +00001288#ifdef SQLITE_TEST
1289 if( pDb->bLegacyPrepare ){
1290 return sqlite3_prepare(pDb->db, zSql, -1, ppStmt, pzOut);
1291 }
1292#endif
drh2c2f3922017-06-01 00:54:35 +00001293 /* If the statement cache is large, use the SQLITE_PREPARE_PERSISTENT
1294 ** flags, which uses less lookaside memory. But if the cache is small,
1295 ** omit that flag to make full use of lookaside */
1296 if( pDb->maxStmt>5 ) prepFlags = SQLITE_PREPARE_PERSISTENT;
1297
1298 return sqlite3_prepare_v3(pDb->db, zSql, -1, prepFlags, ppStmt, pzOut);
danc431fd52011-06-27 16:55:50 +00001299}
1300
1301/*
dan4a4c11a2009-10-06 14:59:02 +00001302** Search the cache for a prepared-statement object that implements the
1303** first SQL statement in the buffer pointed to by parameter zIn. If
1304** no such prepared-statement can be found, allocate and prepare a new
1305** one. In either case, bind the current values of the relevant Tcl
1306** variables to any $var, :var or @var variables in the statement. Before
1307** returning, set *ppPreStmt to point to the prepared-statement object.
1308**
1309** Output parameter *pzOut is set to point to the next SQL statement in
1310** buffer zIn, or to the '\0' byte at the end of zIn if there is no
1311** next statement.
1312**
1313** If successful, TCL_OK is returned. Otherwise, TCL_ERROR is returned
1314** and an error message loaded into interpreter pDb->interp.
1315*/
1316static int dbPrepareAndBind(
1317 SqliteDb *pDb, /* Database object */
1318 char const *zIn, /* SQL to compile */
1319 char const **pzOut, /* OUT: Pointer to next SQL statement */
1320 SqlPreparedStmt **ppPreStmt /* OUT: Object used to cache statement */
1321){
1322 const char *zSql = zIn; /* Pointer to first SQL statement in zIn */
mistachkin7bb22ac2015-01-12 19:59:12 +00001323 sqlite3_stmt *pStmt = 0; /* Prepared statement object */
dan4a4c11a2009-10-06 14:59:02 +00001324 SqlPreparedStmt *pPreStmt; /* Pointer to cached statement */
1325 int nSql; /* Length of zSql in bytes */
mistachkin7bb22ac2015-01-12 19:59:12 +00001326 int nVar = 0; /* Number of variables in statement */
dan4a4c11a2009-10-06 14:59:02 +00001327 int iParm = 0; /* Next free entry in apParm */
drh0425f182013-11-26 16:48:04 +00001328 char c;
dan4a4c11a2009-10-06 14:59:02 +00001329 int i;
drhc06ede12019-02-28 17:29:19 +00001330 int needResultReset = 0; /* Need to invoke Tcl_ResetResult() */
1331 int rc = SQLITE_OK; /* Value to return */
dan4a4c11a2009-10-06 14:59:02 +00001332 Tcl_Interp *interp = pDb->interp;
1333
1334 *ppPreStmt = 0;
1335
1336 /* Trim spaces from the start of zSql and calculate the remaining length. */
drh0425f182013-11-26 16:48:04 +00001337 while( (c = zSql[0])==' ' || c=='\t' || c=='\r' || c=='\n' ){ zSql++; }
dan4a4c11a2009-10-06 14:59:02 +00001338 nSql = strlen30(zSql);
1339
1340 for(pPreStmt = pDb->stmtList; pPreStmt; pPreStmt=pPreStmt->pNext){
1341 int n = pPreStmt->nSql;
mistachkinb56660f2016-07-14 21:26:09 +00001342 if( nSql>=n
dan4a4c11a2009-10-06 14:59:02 +00001343 && memcmp(pPreStmt->zSql, zSql, n)==0
1344 && (zSql[n]==0 || zSql[n-1]==';')
1345 ){
1346 pStmt = pPreStmt->pStmt;
1347 *pzOut = &zSql[pPreStmt->nSql];
1348
1349 /* When a prepared statement is found, unlink it from the
1350 ** cache list. It will later be added back to the beginning
1351 ** of the cache list in order to implement LRU replacement.
1352 */
1353 if( pPreStmt->pPrev ){
1354 pPreStmt->pPrev->pNext = pPreStmt->pNext;
1355 }else{
1356 pDb->stmtList = pPreStmt->pNext;
1357 }
1358 if( pPreStmt->pNext ){
1359 pPreStmt->pNext->pPrev = pPreStmt->pPrev;
1360 }else{
1361 pDb->stmtLast = pPreStmt->pPrev;
1362 }
1363 pDb->nStmt--;
1364 nVar = sqlite3_bind_parameter_count(pStmt);
1365 break;
1366 }
1367 }
mistachkinb56660f2016-07-14 21:26:09 +00001368
dan4a4c11a2009-10-06 14:59:02 +00001369 /* If no prepared statement was found. Compile the SQL text. Also allocate
1370 ** a new SqlPreparedStmt structure. */
1371 if( pPreStmt==0 ){
1372 int nByte;
1373
danc431fd52011-06-27 16:55:50 +00001374 if( SQLITE_OK!=dbPrepare(pDb, zSql, &pStmt, pzOut) ){
drhc45e6712012-10-03 11:02:33 +00001375 Tcl_SetObjResult(interp, Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001376 return TCL_ERROR;
1377 }
1378 if( pStmt==0 ){
1379 if( SQLITE_OK!=sqlite3_errcode(pDb->db) ){
1380 /* A compile-time error in the statement. */
drhc45e6712012-10-03 11:02:33 +00001381 Tcl_SetObjResult(interp, Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001382 return TCL_ERROR;
1383 }else{
1384 /* The statement was a no-op. Continue to the next statement
1385 ** in the SQL string.
1386 */
1387 return TCL_OK;
1388 }
1389 }
1390
1391 assert( pPreStmt==0 );
1392 nVar = sqlite3_bind_parameter_count(pStmt);
1393 nByte = sizeof(SqlPreparedStmt) + nVar*sizeof(Tcl_Obj *);
1394 pPreStmt = (SqlPreparedStmt*)Tcl_Alloc(nByte);
1395 memset(pPreStmt, 0, nByte);
1396
1397 pPreStmt->pStmt = pStmt;
drh7ed243b2012-04-19 17:19:51 +00001398 pPreStmt->nSql = (int)(*pzOut - zSql);
dan4a4c11a2009-10-06 14:59:02 +00001399 pPreStmt->zSql = sqlite3_sql(pStmt);
1400 pPreStmt->apParm = (Tcl_Obj **)&pPreStmt[1];
danc431fd52011-06-27 16:55:50 +00001401#ifdef SQLITE_TEST
1402 if( pPreStmt->zSql==0 ){
1403 char *zCopy = Tcl_Alloc(pPreStmt->nSql + 1);
1404 memcpy(zCopy, zSql, pPreStmt->nSql);
1405 zCopy[pPreStmt->nSql] = '\0';
1406 pPreStmt->zSql = zCopy;
1407 }
1408#endif
dan4a4c11a2009-10-06 14:59:02 +00001409 }
1410 assert( pPreStmt );
1411 assert( strlen30(pPreStmt->zSql)==pPreStmt->nSql );
1412 assert( 0==memcmp(pPreStmt->zSql, zSql, pPreStmt->nSql) );
1413
mistachkinb56660f2016-07-14 21:26:09 +00001414 /* Bind values to parameters that begin with $ or : */
dan4a4c11a2009-10-06 14:59:02 +00001415 for(i=1; i<=nVar; i++){
1416 const char *zVar = sqlite3_bind_parameter_name(pStmt, i);
1417 if( zVar!=0 && (zVar[0]=='$' || zVar[0]==':' || zVar[0]=='@') ){
1418 Tcl_Obj *pVar = Tcl_GetVar2Ex(interp, &zVar[1], 0, 0);
drhc06ede12019-02-28 17:29:19 +00001419 if( pVar==0 && pDb->zBindFallback!=0 ){
1420 Tcl_Obj *pCmd;
1421 int rx;
1422 pCmd = Tcl_NewStringObj(pDb->zBindFallback, -1);
1423 Tcl_IncrRefCount(pCmd);
1424 Tcl_ListObjAppendElement(interp, pCmd, Tcl_NewStringObj(zVar,-1));
1425 if( needResultReset ) Tcl_ResetResult(interp);
1426 needResultReset = 1;
1427 rx = Tcl_EvalObjEx(interp, pCmd, TCL_EVAL_DIRECT);
1428 Tcl_DecrRefCount(pCmd);
1429 if( rx==TCL_OK ){
1430 pVar = Tcl_GetObjResult(interp);
1431 }else if( rx==TCL_ERROR ){
1432 rc = TCL_ERROR;
1433 break;
1434 }else{
1435 pVar = 0;
1436 }
1437 }
dan4a4c11a2009-10-06 14:59:02 +00001438 if( pVar ){
1439 int n;
1440 u8 *data;
1441 const char *zType = (pVar->typePtr ? pVar->typePtr->name : "");
mistachkin8e189222015-04-19 21:43:16 +00001442 c = zType[0];
dan4a4c11a2009-10-06 14:59:02 +00001443 if( zVar[0]=='@' ||
1444 (c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0) ){
1445 /* Load a BLOB type if the Tcl variable is a bytearray and
1446 ** it has no string representation or the host
1447 ** parameter name begins with "@". */
1448 data = Tcl_GetByteArrayFromObj(pVar, &n);
1449 sqlite3_bind_blob(pStmt, i, data, n, SQLITE_STATIC);
1450 Tcl_IncrRefCount(pVar);
1451 pPreStmt->apParm[iParm++] = pVar;
1452 }else if( c=='b' && strcmp(zType,"boolean")==0 ){
1453 Tcl_GetIntFromObj(interp, pVar, &n);
1454 sqlite3_bind_int(pStmt, i, n);
1455 }else if( c=='d' && strcmp(zType,"double")==0 ){
1456 double r;
1457 Tcl_GetDoubleFromObj(interp, pVar, &r);
1458 sqlite3_bind_double(pStmt, i, r);
1459 }else if( (c=='w' && strcmp(zType,"wideInt")==0) ||
1460 (c=='i' && strcmp(zType,"int")==0) ){
1461 Tcl_WideInt v;
1462 Tcl_GetWideIntFromObj(interp, pVar, &v);
1463 sqlite3_bind_int64(pStmt, i, v);
1464 }else{
1465 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
1466 sqlite3_bind_text(pStmt, i, (char *)data, n, SQLITE_STATIC);
1467 Tcl_IncrRefCount(pVar);
1468 pPreStmt->apParm[iParm++] = pVar;
1469 }
1470 }else{
1471 sqlite3_bind_null(pStmt, i);
1472 }
drhc06ede12019-02-28 17:29:19 +00001473 if( needResultReset ) Tcl_ResetResult(pDb->interp);
dan4a4c11a2009-10-06 14:59:02 +00001474 }
1475 }
1476 pPreStmt->nParm = iParm;
1477 *ppPreStmt = pPreStmt;
drhc06ede12019-02-28 17:29:19 +00001478 if( needResultReset && rc==TCL_OK ) Tcl_ResetResult(pDb->interp);
dan937d0de2009-10-15 18:35:38 +00001479
drhc06ede12019-02-28 17:29:19 +00001480 return rc;
dan4a4c11a2009-10-06 14:59:02 +00001481}
1482
dan4a4c11a2009-10-06 14:59:02 +00001483/*
1484** Release a statement reference obtained by calling dbPrepareAndBind().
1485** There should be exactly one call to this function for each call to
1486** dbPrepareAndBind().
1487**
1488** If the discard parameter is non-zero, then the statement is deleted
1489** immediately. Otherwise it is added to the LRU list and may be returned
1490** by a subsequent call to dbPrepareAndBind().
1491*/
1492static void dbReleaseStmt(
1493 SqliteDb *pDb, /* Database handle */
1494 SqlPreparedStmt *pPreStmt, /* Prepared statement handle to release */
1495 int discard /* True to delete (not cache) the pPreStmt */
1496){
1497 int i;
1498
1499 /* Free the bound string and blob parameters */
1500 for(i=0; i<pPreStmt->nParm; i++){
1501 Tcl_DecrRefCount(pPreStmt->apParm[i]);
1502 }
1503 pPreStmt->nParm = 0;
1504
1505 if( pDb->maxStmt<=0 || discard ){
1506 /* If the cache is turned off, deallocated the statement */
danc431fd52011-06-27 16:55:50 +00001507 dbFreeStmt(pPreStmt);
dan4a4c11a2009-10-06 14:59:02 +00001508 }else{
1509 /* Add the prepared statement to the beginning of the cache list. */
1510 pPreStmt->pNext = pDb->stmtList;
1511 pPreStmt->pPrev = 0;
1512 if( pDb->stmtList ){
1513 pDb->stmtList->pPrev = pPreStmt;
1514 }
1515 pDb->stmtList = pPreStmt;
1516 if( pDb->stmtLast==0 ){
1517 assert( pDb->nStmt==0 );
1518 pDb->stmtLast = pPreStmt;
1519 }else{
1520 assert( pDb->nStmt>0 );
1521 }
1522 pDb->nStmt++;
mistachkinb56660f2016-07-14 21:26:09 +00001523
1524 /* If we have too many statement in cache, remove the surplus from
dan4a4c11a2009-10-06 14:59:02 +00001525 ** the end of the cache list. */
1526 while( pDb->nStmt>pDb->maxStmt ){
danc431fd52011-06-27 16:55:50 +00001527 SqlPreparedStmt *pLast = pDb->stmtLast;
1528 pDb->stmtLast = pLast->pPrev;
dan4a4c11a2009-10-06 14:59:02 +00001529 pDb->stmtLast->pNext = 0;
1530 pDb->nStmt--;
danc431fd52011-06-27 16:55:50 +00001531 dbFreeStmt(pLast);
dan4a4c11a2009-10-06 14:59:02 +00001532 }
1533 }
1534}
1535
1536/*
1537** Structure used with dbEvalXXX() functions:
1538**
1539** dbEvalInit()
1540** dbEvalStep()
1541** dbEvalFinalize()
1542** dbEvalRowInfo()
1543** dbEvalColumnValue()
1544*/
1545typedef struct DbEvalContext DbEvalContext;
1546struct DbEvalContext {
1547 SqliteDb *pDb; /* Database handle */
1548 Tcl_Obj *pSql; /* Object holding string zSql */
1549 const char *zSql; /* Remaining SQL to execute */
1550 SqlPreparedStmt *pPreStmt; /* Current statement */
1551 int nCol; /* Number of columns returned by pStmt */
drhaf38cdb2017-06-26 21:08:32 +00001552 int evalFlags; /* Flags used */
dan4a4c11a2009-10-06 14:59:02 +00001553 Tcl_Obj *pArray; /* Name of array variable */
1554 Tcl_Obj **apColName; /* Array of column names */
1555};
1556
drhaf38cdb2017-06-26 21:08:32 +00001557#define SQLITE_EVAL_WITHOUTNULLS 0x00001 /* Unset array(*) for NULL */
1558
dan4a4c11a2009-10-06 14:59:02 +00001559/*
1560** Release any cache of column names currently held as part of
1561** the DbEvalContext structure passed as the first argument.
1562*/
1563static void dbReleaseColumnNames(DbEvalContext *p){
1564 if( p->apColName ){
1565 int i;
1566 for(i=0; i<p->nCol; i++){
1567 Tcl_DecrRefCount(p->apColName[i]);
1568 }
1569 Tcl_Free((char *)p->apColName);
1570 p->apColName = 0;
1571 }
1572 p->nCol = 0;
1573}
1574
1575/*
1576** Initialize a DbEvalContext structure.
danielk19778e556522007-11-13 10:30:24 +00001577**
1578** If pArray is not NULL, then it contains the name of a Tcl array
1579** variable. The "*" member of this array is set to a list containing
dan4a4c11a2009-10-06 14:59:02 +00001580** the names of the columns returned by the statement as part of each
mistachkinb56660f2016-07-14 21:26:09 +00001581** call to dbEvalStep(), in order from left to right. e.g. if the names
1582** of the returned columns are a, b and c, it does the equivalent of the
dan4a4c11a2009-10-06 14:59:02 +00001583** tcl command:
danielk19778e556522007-11-13 10:30:24 +00001584**
1585** set ${pArray}(*) {a b c}
1586*/
dan4a4c11a2009-10-06 14:59:02 +00001587static void dbEvalInit(
1588 DbEvalContext *p, /* Pointer to structure to initialize */
1589 SqliteDb *pDb, /* Database handle */
1590 Tcl_Obj *pSql, /* Object containing SQL script */
drhaf38cdb2017-06-26 21:08:32 +00001591 Tcl_Obj *pArray, /* Name of Tcl array to set (*) element of */
1592 int evalFlags /* Flags controlling evaluation */
danielk19778e556522007-11-13 10:30:24 +00001593){
dan4a4c11a2009-10-06 14:59:02 +00001594 memset(p, 0, sizeof(DbEvalContext));
1595 p->pDb = pDb;
1596 p->zSql = Tcl_GetString(pSql);
1597 p->pSql = pSql;
1598 Tcl_IncrRefCount(pSql);
1599 if( pArray ){
1600 p->pArray = pArray;
1601 Tcl_IncrRefCount(pArray);
1602 }
drhaf38cdb2017-06-26 21:08:32 +00001603 p->evalFlags = evalFlags;
danbea28c72021-09-16 14:17:14 +00001604 addDatabaseRef(p->pDb);
dan4a4c11a2009-10-06 14:59:02 +00001605}
danielk19778e556522007-11-13 10:30:24 +00001606
dan4a4c11a2009-10-06 14:59:02 +00001607/*
1608** Obtain information about the row that the DbEvalContext passed as the
1609** first argument currently points to.
1610*/
1611static void dbEvalRowInfo(
1612 DbEvalContext *p, /* Evaluation context */
1613 int *pnCol, /* OUT: Number of column names */
1614 Tcl_Obj ***papColName /* OUT: Array of column names */
1615){
danielk19778e556522007-11-13 10:30:24 +00001616 /* Compute column names */
dan4a4c11a2009-10-06 14:59:02 +00001617 if( 0==p->apColName ){
1618 sqlite3_stmt *pStmt = p->pPreStmt->pStmt;
1619 int i; /* Iterator variable */
1620 int nCol; /* Number of columns returned by pStmt */
1621 Tcl_Obj **apColName = 0; /* Array of column names */
1622
1623 p->nCol = nCol = sqlite3_column_count(pStmt);
1624 if( nCol>0 && (papColName || p->pArray) ){
1625 apColName = (Tcl_Obj**)Tcl_Alloc( sizeof(Tcl_Obj*)*nCol );
1626 for(i=0; i<nCol; i++){
drhc45e6712012-10-03 11:02:33 +00001627 apColName[i] = Tcl_NewStringObj(sqlite3_column_name(pStmt,i), -1);
dan4a4c11a2009-10-06 14:59:02 +00001628 Tcl_IncrRefCount(apColName[i]);
1629 }
1630 p->apColName = apColName;
danielk19778e556522007-11-13 10:30:24 +00001631 }
1632
1633 /* If results are being stored in an array variable, then create
1634 ** the array(*) entry for that array
1635 */
dan4a4c11a2009-10-06 14:59:02 +00001636 if( p->pArray ){
1637 Tcl_Interp *interp = p->pDb->interp;
danielk19778e556522007-11-13 10:30:24 +00001638 Tcl_Obj *pColList = Tcl_NewObj();
1639 Tcl_Obj *pStar = Tcl_NewStringObj("*", -1);
dan4a4c11a2009-10-06 14:59:02 +00001640
danielk19778e556522007-11-13 10:30:24 +00001641 for(i=0; i<nCol; i++){
1642 Tcl_ListObjAppendElement(interp, pColList, apColName[i]);
1643 }
1644 Tcl_IncrRefCount(pStar);
dan4a4c11a2009-10-06 14:59:02 +00001645 Tcl_ObjSetVar2(interp, p->pArray, pStar, pColList, 0);
danielk19778e556522007-11-13 10:30:24 +00001646 Tcl_DecrRefCount(pStar);
1647 }
danielk19778e556522007-11-13 10:30:24 +00001648 }
1649
dan4a4c11a2009-10-06 14:59:02 +00001650 if( papColName ){
1651 *papColName = p->apColName;
1652 }
1653 if( pnCol ){
1654 *pnCol = p->nCol;
1655 }
1656}
1657
1658/*
1659** Return one of TCL_OK, TCL_BREAK or TCL_ERROR. If TCL_ERROR is
1660** returned, then an error message is stored in the interpreter before
1661** returning.
1662**
1663** A return value of TCL_OK means there is a row of data available. The
1664** data may be accessed using dbEvalRowInfo() and dbEvalColumnValue(). This
1665** is analogous to a return of SQLITE_ROW from sqlite3_step(). If TCL_BREAK
1666** is returned, then the SQL script has finished executing and there are
1667** no further rows available. This is similar to SQLITE_DONE.
1668*/
1669static int dbEvalStep(DbEvalContext *p){
danc431fd52011-06-27 16:55:50 +00001670 const char *zPrevSql = 0; /* Previous value of p->zSql */
1671
dan4a4c11a2009-10-06 14:59:02 +00001672 while( p->zSql[0] || p->pPreStmt ){
1673 int rc;
1674 if( p->pPreStmt==0 ){
danc431fd52011-06-27 16:55:50 +00001675 zPrevSql = (p->zSql==zPrevSql ? 0 : p->zSql);
dan4a4c11a2009-10-06 14:59:02 +00001676 rc = dbPrepareAndBind(p->pDb, p->zSql, &p->zSql, &p->pPreStmt);
1677 if( rc!=TCL_OK ) return rc;
1678 }else{
1679 int rcs;
1680 SqliteDb *pDb = p->pDb;
1681 SqlPreparedStmt *pPreStmt = p->pPreStmt;
1682 sqlite3_stmt *pStmt = pPreStmt->pStmt;
1683
1684 rcs = sqlite3_step(pStmt);
1685 if( rcs==SQLITE_ROW ){
1686 return TCL_OK;
1687 }
1688 if( p->pArray ){
1689 dbEvalRowInfo(p, 0, 0);
1690 }
1691 rcs = sqlite3_reset(pStmt);
1692
1693 pDb->nStep = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_FULLSCAN_STEP,1);
1694 pDb->nSort = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_SORT,1);
drh3c379b02010-04-07 19:31:59 +00001695 pDb->nIndex = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_AUTOINDEX,1);
danc456a762017-06-22 16:51:16 +00001696 pDb->nVMStep = sqlite3_stmt_status(pStmt,SQLITE_STMTSTATUS_VM_STEP,1);
dan4a4c11a2009-10-06 14:59:02 +00001697 dbReleaseColumnNames(p);
1698 p->pPreStmt = 0;
1699
1700 if( rcs!=SQLITE_OK ){
1701 /* If a run-time error occurs, report the error and stop reading
1702 ** the SQL. */
dan4a4c11a2009-10-06 14:59:02 +00001703 dbReleaseStmt(pDb, pPreStmt, 1);
danc431fd52011-06-27 16:55:50 +00001704#if SQLITE_TEST
1705 if( p->pDb->bLegacyPrepare && rcs==SQLITE_SCHEMA && zPrevSql ){
1706 /* If the runtime error was an SQLITE_SCHEMA, and the database
mistachkinb56660f2016-07-14 21:26:09 +00001707 ** handle is configured to use the legacy sqlite3_prepare()
danc431fd52011-06-27 16:55:50 +00001708 ** interface, retry prepare()/step() on the same SQL statement.
1709 ** This only happens once. If there is a second SQLITE_SCHEMA
1710 ** error, the error will be returned to the caller. */
1711 p->zSql = zPrevSql;
1712 continue;
1713 }
1714#endif
drhc45e6712012-10-03 11:02:33 +00001715 Tcl_SetObjResult(pDb->interp,
1716 Tcl_NewStringObj(sqlite3_errmsg(pDb->db), -1));
dan4a4c11a2009-10-06 14:59:02 +00001717 return TCL_ERROR;
1718 }else{
1719 dbReleaseStmt(pDb, pPreStmt, 0);
1720 }
1721 }
1722 }
1723
1724 /* Finished */
1725 return TCL_BREAK;
1726}
1727
1728/*
1729** Free all resources currently held by the DbEvalContext structure passed
1730** as the first argument. There should be exactly one call to this function
1731** for each call to dbEvalInit().
1732*/
1733static void dbEvalFinalize(DbEvalContext *p){
1734 if( p->pPreStmt ){
1735 sqlite3_reset(p->pPreStmt->pStmt);
1736 dbReleaseStmt(p->pDb, p->pPreStmt, 0);
1737 p->pPreStmt = 0;
1738 }
1739 if( p->pArray ){
1740 Tcl_DecrRefCount(p->pArray);
1741 p->pArray = 0;
1742 }
1743 Tcl_DecrRefCount(p->pSql);
1744 dbReleaseColumnNames(p);
danbea28c72021-09-16 14:17:14 +00001745 delDatabaseRef(p->pDb);
dan4a4c11a2009-10-06 14:59:02 +00001746}
1747
1748/*
1749** Return a pointer to a Tcl_Obj structure with ref-count 0 that contains
1750** the value for the iCol'th column of the row currently pointed to by
1751** the DbEvalContext structure passed as the first argument.
1752*/
1753static Tcl_Obj *dbEvalColumnValue(DbEvalContext *p, int iCol){
1754 sqlite3_stmt *pStmt = p->pPreStmt->pStmt;
1755 switch( sqlite3_column_type(pStmt, iCol) ){
1756 case SQLITE_BLOB: {
1757 int bytes = sqlite3_column_bytes(pStmt, iCol);
1758 const char *zBlob = sqlite3_column_blob(pStmt, iCol);
1759 if( !zBlob ) bytes = 0;
1760 return Tcl_NewByteArrayObj((u8*)zBlob, bytes);
1761 }
1762 case SQLITE_INTEGER: {
1763 sqlite_int64 v = sqlite3_column_int64(pStmt, iCol);
1764 if( v>=-2147483647 && v<=2147483647 ){
drh7fd33922011-06-20 19:00:30 +00001765 return Tcl_NewIntObj((int)v);
dan4a4c11a2009-10-06 14:59:02 +00001766 }else{
1767 return Tcl_NewWideIntObj(v);
1768 }
1769 }
1770 case SQLITE_FLOAT: {
1771 return Tcl_NewDoubleObj(sqlite3_column_double(pStmt, iCol));
1772 }
1773 case SQLITE_NULL: {
drhc45e6712012-10-03 11:02:33 +00001774 return Tcl_NewStringObj(p->pDb->zNull, -1);
dan4a4c11a2009-10-06 14:59:02 +00001775 }
1776 }
1777
drh325eff52012-10-03 12:56:18 +00001778 return Tcl_NewStringObj((char*)sqlite3_column_text(pStmt, iCol), -1);
dan4a4c11a2009-10-06 14:59:02 +00001779}
1780
1781/*
1782** If using Tcl version 8.6 or greater, use the NR functions to avoid
1783** recursive evalution of scripts by the [db eval] and [db trans]
1784** commands. Even if the headers used while compiling the extension
1785** are 8.6 or newer, the code still tests the Tcl version at runtime.
1786** This allows stubs-enabled builds to be used with older Tcl libraries.
1787*/
1788#if TCL_MAJOR_VERSION>8 || (TCL_MAJOR_VERSION==8 && TCL_MINOR_VERSION>=6)
drha2c8a952009-10-13 18:38:34 +00001789# define SQLITE_TCL_NRE 1
dan4a4c11a2009-10-06 14:59:02 +00001790static int DbUseNre(void){
1791 int major, minor;
1792 Tcl_GetVersion(&major, &minor, 0, 0);
1793 return( (major==8 && minor>=6) || major>8 );
1794}
1795#else
mistachkinb56660f2016-07-14 21:26:09 +00001796/*
dan4a4c11a2009-10-06 14:59:02 +00001797** Compiling using headers earlier than 8.6. In this case NR cannot be
1798** used, so DbUseNre() to always return zero. Add #defines for the other
1799** Tcl_NRxxx() functions to prevent them from causing compilation errors,
mistachkinb56660f2016-07-14 21:26:09 +00001800** even though the only invocations of them are within conditional blocks
dan4a4c11a2009-10-06 14:59:02 +00001801** of the form:
1802**
1803** if( DbUseNre() ) { ... }
1804*/
drha2c8a952009-10-13 18:38:34 +00001805# define SQLITE_TCL_NRE 0
dan4a4c11a2009-10-06 14:59:02 +00001806# define DbUseNre() 0
drha47941f2013-12-20 18:57:44 +00001807# define Tcl_NRAddCallback(a,b,c,d,e,f) (void)0
dan4a4c11a2009-10-06 14:59:02 +00001808# define Tcl_NREvalObj(a,b,c) 0
drha47941f2013-12-20 18:57:44 +00001809# define Tcl_NRCreateCommand(a,b,c,d,e,f) (void)0
dan4a4c11a2009-10-06 14:59:02 +00001810#endif
1811
1812/*
1813** This function is part of the implementation of the command:
1814**
1815** $db eval SQL ?ARRAYNAME? SCRIPT
1816*/
mistachkina121cc72016-07-28 18:06:52 +00001817static int SQLITE_TCLAPI DbEvalNextCmd(
dan4a4c11a2009-10-06 14:59:02 +00001818 ClientData data[], /* data[0] is the (DbEvalContext*) */
1819 Tcl_Interp *interp, /* Tcl interpreter */
1820 int result /* Result so far */
1821){
1822 int rc = result; /* Return code */
1823
1824 /* The first element of the data[] array is a pointer to a DbEvalContext
1825 ** structure allocated using Tcl_Alloc(). The second element of data[]
1826 ** is a pointer to a Tcl_Obj containing the script to run for each row
1827 ** returned by the queries encapsulated in data[0]. */
1828 DbEvalContext *p = (DbEvalContext *)data[0];
1829 Tcl_Obj *pScript = (Tcl_Obj *)data[1];
1830 Tcl_Obj *pArray = p->pArray;
1831
1832 while( (rc==TCL_OK || rc==TCL_CONTINUE) && TCL_OK==(rc = dbEvalStep(p)) ){
1833 int i;
1834 int nCol;
1835 Tcl_Obj **apColName;
1836 dbEvalRowInfo(p, &nCol, &apColName);
1837 for(i=0; i<nCol; i++){
dan4a4c11a2009-10-06 14:59:02 +00001838 if( pArray==0 ){
drhaf38cdb2017-06-26 21:08:32 +00001839 Tcl_ObjSetVar2(interp, apColName[i], 0, dbEvalColumnValue(p,i), 0);
1840 }else if( (p->evalFlags & SQLITE_EVAL_WITHOUTNULLS)!=0
1841 && sqlite3_column_type(p->pPreStmt->pStmt, i)==SQLITE_NULL
1842 ){
1843 Tcl_UnsetVar2(interp, Tcl_GetString(pArray),
1844 Tcl_GetString(apColName[i]), 0);
dan4a4c11a2009-10-06 14:59:02 +00001845 }else{
drhaf38cdb2017-06-26 21:08:32 +00001846 Tcl_ObjSetVar2(interp, pArray, apColName[i], dbEvalColumnValue(p,i), 0);
dan4a4c11a2009-10-06 14:59:02 +00001847 }
1848 }
1849
mistachkinb56660f2016-07-14 21:26:09 +00001850 /* The required interpreter variables are now populated with the data
dan4a4c11a2009-10-06 14:59:02 +00001851 ** from the current row. If using NRE, schedule callbacks to evaluate
1852 ** script pScript, then to invoke this function again to fetch the next
1853 ** row (or clean up if there is no next row or the script throws an
mistachkinb56660f2016-07-14 21:26:09 +00001854 ** exception). After scheduling the callbacks, return control to the
dan4a4c11a2009-10-06 14:59:02 +00001855 ** caller.
1856 **
1857 ** If not using NRE, evaluate pScript directly and continue with the
1858 ** next iteration of this while(...) loop. */
1859 if( DbUseNre() ){
1860 Tcl_NRAddCallback(interp, DbEvalNextCmd, (void*)p, (void*)pScript, 0, 0);
1861 return Tcl_NREvalObj(interp, pScript, 0);
1862 }else{
1863 rc = Tcl_EvalObjEx(interp, pScript, 0);
1864 }
1865 }
1866
1867 Tcl_DecrRefCount(pScript);
1868 dbEvalFinalize(p);
1869 Tcl_Free((char *)p);
1870
1871 if( rc==TCL_OK || rc==TCL_BREAK ){
1872 Tcl_ResetResult(interp);
1873 rc = TCL_OK;
1874 }
1875 return rc;
danielk19778e556522007-11-13 10:30:24 +00001876}
1877
tpoindex1067fe12004-12-17 15:41:11 +00001878/*
mistachkinb56660f2016-07-14 21:26:09 +00001879** This function is used by the implementations of the following database
dan46c47d42011-03-01 18:42:07 +00001880** handle sub-commands:
1881**
1882** $db update_hook ?SCRIPT?
1883** $db wal_hook ?SCRIPT?
1884** $db commit_hook ?SCRIPT?
1885** $db preupdate hook ?SCRIPT?
1886*/
1887static void DbHookCmd(
1888 Tcl_Interp *interp, /* Tcl interpreter */
1889 SqliteDb *pDb, /* Database handle */
1890 Tcl_Obj *pArg, /* SCRIPT argument (or NULL) */
1891 Tcl_Obj **ppHook /* Pointer to member of SqliteDb */
1892){
1893 sqlite3 *db = pDb->db;
1894
1895 if( *ppHook ){
1896 Tcl_SetObjResult(interp, *ppHook);
1897 if( pArg ){
1898 Tcl_DecrRefCount(*ppHook);
1899 *ppHook = 0;
1900 }
1901 }
1902 if( pArg ){
1903 assert( !(*ppHook) );
1904 if( Tcl_GetCharLength(pArg)>0 ){
1905 *ppHook = pArg;
1906 Tcl_IncrRefCount(*ppHook);
1907 }
1908 }
1909
drh9b1c62d2011-03-30 21:04:43 +00001910#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00001911 sqlite3_preupdate_hook(db, (pDb->pPreUpdateHook?DbPreUpdateHandler:0), pDb);
drh9b1c62d2011-03-30 21:04:43 +00001912#endif
dan46c47d42011-03-01 18:42:07 +00001913 sqlite3_update_hook(db, (pDb->pUpdateHook?DbUpdateHandler:0), pDb);
1914 sqlite3_rollback_hook(db, (pDb->pRollbackHook?DbRollbackHandler:0), pDb);
1915 sqlite3_wal_hook(db, (pDb->pWalHook?DbWalHandler:0), pDb);
1916}
1917
1918/*
drh75897232000-05-29 14:26:00 +00001919** The "sqlite" command below creates a new Tcl command for each
1920** connection it opens to an SQLite database. This routine is invoked
1921** whenever one of those connection-specific commands is executed
1922** in Tcl. For example, if you run Tcl code like this:
1923**
drh9bb575f2004-09-06 17:24:11 +00001924** sqlite3 db1 "my_database"
drh75897232000-05-29 14:26:00 +00001925** db1 close
1926**
1927** The first command opens a connection to the "my_database" database
1928** and calls that connection "db1". The second command causes this
1929** subroutine to be invoked.
1930*/
mistachkin7617e4a2016-07-28 17:11:20 +00001931static int SQLITE_TCLAPI DbObjCmd(
1932 void *cd,
1933 Tcl_Interp *interp,
1934 int objc,
1935 Tcl_Obj *const*objv
1936){
drhbec3f402000-08-04 13:49:02 +00001937 SqliteDb *pDb = (SqliteDb*)cd;
drh6d313162000-09-21 13:01:35 +00001938 int choice;
drh22fbcb82004-02-01 01:22:50 +00001939 int rc = TCL_OK;
drh0de8c112002-07-06 16:32:14 +00001940 static const char *DB_strs[] = {
drhc06ede12019-02-28 17:29:19 +00001941 "authorizer", "backup", "bind_fallback",
1942 "busy", "cache", "changes",
1943 "close", "collate", "collation_needed",
drh11d88e62019-08-15 21:27:20 +00001944 "commit_hook", "complete", "config",
1945 "copy", "deserialize", "enable_load_extension",
drhbe4e3c82022-02-16 15:11:01 +00001946 "errorcode", "erroroffset", "eval",
1947 "exists", "function", "incrblob",
1948 "interrupt", "last_insert_rowid", "nullvalue",
1949 "onecolumn", "preupdate", "profile",
1950 "progress", "rekey", "restore",
1951 "rollback_hook", "serialize", "status",
1952 "timeout", "total_changes", "trace",
1953 "trace_v2", "transaction", "unlock_notify",
1954 "update_hook", "version", "wal_hook",
1955 0
drh6d313162000-09-21 13:01:35 +00001956 };
drh411995d2002-06-25 19:31:18 +00001957 enum DB_enum {
drhc06ede12019-02-28 17:29:19 +00001958 DB_AUTHORIZER, DB_BACKUP, DB_BIND_FALLBACK,
1959 DB_BUSY, DB_CACHE, DB_CHANGES,
1960 DB_CLOSE, DB_COLLATE, DB_COLLATION_NEEDED,
drh11d88e62019-08-15 21:27:20 +00001961 DB_COMMIT_HOOK, DB_COMPLETE, DB_CONFIG,
1962 DB_COPY, DB_DESERIALIZE, DB_ENABLE_LOAD_EXTENSION,
drhbe4e3c82022-02-16 15:11:01 +00001963 DB_ERRORCODE, DB_ERROROFFSET, DB_EVAL,
1964 DB_EXISTS, DB_FUNCTION, DB_INCRBLOB,
1965 DB_INTERRUPT, DB_LAST_INSERT_ROWID, DB_NULLVALUE,
1966 DB_ONECOLUMN, DB_PREUPDATE, DB_PROFILE,
1967 DB_PROGRESS, DB_REKEY, DB_RESTORE,
1968 DB_ROLLBACK_HOOK, DB_SERIALIZE, DB_STATUS,
1969 DB_TIMEOUT, DB_TOTAL_CHANGES, DB_TRACE,
1970 DB_TRACE_V2, DB_TRANSACTION, DB_UNLOCK_NOTIFY,
1971 DB_UPDATE_HOOK, DB_VERSION, DB_WAL_HOOK,
drh6d313162000-09-21 13:01:35 +00001972 };
tpoindex1067fe12004-12-17 15:41:11 +00001973 /* don't leave trailing commas on DB_enum, it confuses the AIX xlc compiler */
drh6d313162000-09-21 13:01:35 +00001974
1975 if( objc<2 ){
1976 Tcl_WrongNumArgs(interp, 1, objv, "SUBCOMMAND ...");
drh75897232000-05-29 14:26:00 +00001977 return TCL_ERROR;
1978 }
drh411995d2002-06-25 19:31:18 +00001979 if( Tcl_GetIndexFromObj(interp, objv[1], DB_strs, "option", 0, &choice) ){
drh6d313162000-09-21 13:01:35 +00001980 return TCL_ERROR;
1981 }
1982
drh411995d2002-06-25 19:31:18 +00001983 switch( (enum DB_enum)choice ){
drh75897232000-05-29 14:26:00 +00001984
drhe22a3342003-04-22 20:30:37 +00001985 /* $db authorizer ?CALLBACK?
1986 **
1987 ** Invoke the given callback to authorize each SQL operation as it is
1988 ** compiled. 5 arguments are appended to the callback before it is
1989 ** invoked:
1990 **
1991 ** (1) The authorization type (ex: SQLITE_CREATE_TABLE, SQLITE_INSERT, ...)
1992 ** (2) First descriptive name (depends on authorization type)
1993 ** (3) Second descriptive name
1994 ** (4) Name of the database (ex: "main", "temp")
1995 ** (5) Name of trigger that is doing the access
1996 **
1997 ** The callback should return on of the following strings: SQLITE_OK,
1998 ** SQLITE_IGNORE, or SQLITE_DENY. Any other return value is an error.
1999 **
2000 ** If this method is invoked with no arguments, the current authorization
2001 ** callback string is returned.
2002 */
2003 case DB_AUTHORIZER: {
drh1211de32004-07-26 12:24:22 +00002004#ifdef SQLITE_OMIT_AUTHORIZATION
drha198f2b2014-02-07 19:26:13 +00002005 Tcl_AppendResult(interp, "authorization not available in this build",
2006 (char*)0);
drh1211de32004-07-26 12:24:22 +00002007 return TCL_ERROR;
2008#else
drhe22a3342003-04-22 20:30:37 +00002009 if( objc>3 ){
2010 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drh0f14e2e2004-06-29 12:39:08 +00002011 return TCL_ERROR;
drhe22a3342003-04-22 20:30:37 +00002012 }else if( objc==2 ){
drhb5a20d32003-04-23 12:25:23 +00002013 if( pDb->zAuth ){
drha198f2b2014-02-07 19:26:13 +00002014 Tcl_AppendResult(interp, pDb->zAuth, (char*)0);
drhe22a3342003-04-22 20:30:37 +00002015 }
2016 }else{
2017 char *zAuth;
2018 int len;
2019 if( pDb->zAuth ){
2020 Tcl_Free(pDb->zAuth);
2021 }
2022 zAuth = Tcl_GetStringFromObj(objv[2], &len);
2023 if( zAuth && len>0 ){
2024 pDb->zAuth = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002025 memcpy(pDb->zAuth, zAuth, len+1);
drhe22a3342003-04-22 20:30:37 +00002026 }else{
2027 pDb->zAuth = 0;
2028 }
drhe22a3342003-04-22 20:30:37 +00002029 if( pDb->zAuth ){
drh32c6a482014-09-11 13:44:52 +00002030 typedef int (*sqlite3_auth_cb)(
2031 void*,int,const char*,const char*,
2032 const char*,const char*);
drhe22a3342003-04-22 20:30:37 +00002033 pDb->interp = interp;
drh32c6a482014-09-11 13:44:52 +00002034 sqlite3_set_authorizer(pDb->db,(sqlite3_auth_cb)auth_callback,pDb);
drhe22a3342003-04-22 20:30:37 +00002035 }else{
danielk19776f8a5032004-05-10 10:34:51 +00002036 sqlite3_set_authorizer(pDb->db, 0, 0);
drhe22a3342003-04-22 20:30:37 +00002037 }
drhe22a3342003-04-22 20:30:37 +00002038 }
drh1211de32004-07-26 12:24:22 +00002039#endif
drhe22a3342003-04-22 20:30:37 +00002040 break;
2041 }
2042
drhdc2c4912009-02-04 22:46:47 +00002043 /* $db backup ?DATABASE? FILENAME
2044 **
2045 ** Open or create a database file named FILENAME. Transfer the
2046 ** content of local database DATABASE (default: "main") into the
2047 ** FILENAME database.
2048 */
2049 case DB_BACKUP: {
2050 const char *zDestFile;
2051 const char *zSrcDb;
2052 sqlite3 *pDest;
2053 sqlite3_backup *pBackup;
2054
2055 if( objc==3 ){
2056 zSrcDb = "main";
2057 zDestFile = Tcl_GetString(objv[2]);
2058 }else if( objc==4 ){
2059 zSrcDb = Tcl_GetString(objv[2]);
2060 zDestFile = Tcl_GetString(objv[3]);
2061 }else{
2062 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? FILENAME");
2063 return TCL_ERROR;
2064 }
drh147ef392016-01-22 23:17:51 +00002065 rc = sqlite3_open_v2(zDestFile, &pDest,
2066 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE| pDb->openFlags, 0);
drhdc2c4912009-02-04 22:46:47 +00002067 if( rc!=SQLITE_OK ){
2068 Tcl_AppendResult(interp, "cannot open target database: ",
2069 sqlite3_errmsg(pDest), (char*)0);
2070 sqlite3_close(pDest);
2071 return TCL_ERROR;
2072 }
2073 pBackup = sqlite3_backup_init(pDest, "main", pDb->db, zSrcDb);
2074 if( pBackup==0 ){
2075 Tcl_AppendResult(interp, "backup failed: ",
2076 sqlite3_errmsg(pDest), (char*)0);
2077 sqlite3_close(pDest);
2078 return TCL_ERROR;
2079 }
2080 while( (rc = sqlite3_backup_step(pBackup,100))==SQLITE_OK ){}
2081 sqlite3_backup_finish(pBackup);
2082 if( rc==SQLITE_DONE ){
2083 rc = TCL_OK;
2084 }else{
2085 Tcl_AppendResult(interp, "backup failed: ",
2086 sqlite3_errmsg(pDest), (char*)0);
2087 rc = TCL_ERROR;
2088 }
2089 sqlite3_close(pDest);
2090 break;
2091 }
2092
drhc06ede12019-02-28 17:29:19 +00002093 /* $db bind_fallback ?CALLBACK?
2094 **
2095 ** When resolving bind parameters in an SQL statement, if the parameter
2096 ** cannot be associated with a TCL variable then invoke CALLBACK with a
2097 ** single argument that is the name of the parameter and use the return
2098 ** value of the CALLBACK as the binding. If CALLBACK returns something
2099 ** other than TCL_OK or TCL_ERROR then bind a NULL.
2100 **
2101 ** If CALLBACK is an empty string, then revert to the default behavior
2102 ** which is to set the binding to NULL.
2103 **
2104 ** If CALLBACK returns an error, that causes the statement execution to
2105 ** abort. Hence, to configure a connection so that it throws an error
2106 ** on an attempt to bind an unknown variable, do something like this:
2107 **
2108 ** proc bind_error {name} {error "no such variable: $name"}
2109 ** db bind_fallback bind_error
2110 */
2111 case DB_BIND_FALLBACK: {
2112 if( objc>3 ){
2113 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2114 return TCL_ERROR;
2115 }else if( objc==2 ){
2116 if( pDb->zBindFallback ){
2117 Tcl_AppendResult(interp, pDb->zBindFallback, (char*)0);
2118 }
2119 }else{
2120 char *zCallback;
2121 int len;
2122 if( pDb->zBindFallback ){
2123 Tcl_Free(pDb->zBindFallback);
2124 }
2125 zCallback = Tcl_GetStringFromObj(objv[2], &len);
2126 if( zCallback && len>0 ){
2127 pDb->zBindFallback = Tcl_Alloc( len + 1 );
2128 memcpy(pDb->zBindFallback, zCallback, len+1);
2129 }else{
2130 pDb->zBindFallback = 0;
2131 }
2132 }
2133 break;
2134 }
2135
drhbec3f402000-08-04 13:49:02 +00002136 /* $db busy ?CALLBACK?
2137 **
2138 ** Invoke the given callback if an SQL statement attempts to open
2139 ** a locked database file.
2140 */
drh6d313162000-09-21 13:01:35 +00002141 case DB_BUSY: {
2142 if( objc>3 ){
2143 Tcl_WrongNumArgs(interp, 2, objv, "CALLBACK");
drhbec3f402000-08-04 13:49:02 +00002144 return TCL_ERROR;
drh6d313162000-09-21 13:01:35 +00002145 }else if( objc==2 ){
drhbec3f402000-08-04 13:49:02 +00002146 if( pDb->zBusy ){
drha198f2b2014-02-07 19:26:13 +00002147 Tcl_AppendResult(interp, pDb->zBusy, (char*)0);
drhbec3f402000-08-04 13:49:02 +00002148 }
2149 }else{
drh6d313162000-09-21 13:01:35 +00002150 char *zBusy;
2151 int len;
drhbec3f402000-08-04 13:49:02 +00002152 if( pDb->zBusy ){
2153 Tcl_Free(pDb->zBusy);
drhbec3f402000-08-04 13:49:02 +00002154 }
drh6d313162000-09-21 13:01:35 +00002155 zBusy = Tcl_GetStringFromObj(objv[2], &len);
2156 if( zBusy && len>0 ){
2157 pDb->zBusy = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002158 memcpy(pDb->zBusy, zBusy, len+1);
drh6d313162000-09-21 13:01:35 +00002159 }else{
2160 pDb->zBusy = 0;
drhbec3f402000-08-04 13:49:02 +00002161 }
2162 if( pDb->zBusy ){
2163 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +00002164 sqlite3_busy_handler(pDb->db, DbBusyHandler, pDb);
drh6d313162000-09-21 13:01:35 +00002165 }else{
danielk19776f8a5032004-05-10 10:34:51 +00002166 sqlite3_busy_handler(pDb->db, 0, 0);
drhbec3f402000-08-04 13:49:02 +00002167 }
2168 }
drh6d313162000-09-21 13:01:35 +00002169 break;
2170 }
drhbec3f402000-08-04 13:49:02 +00002171
drhfb7e7652005-01-24 00:28:42 +00002172 /* $db cache flush
2173 ** $db cache size n
2174 **
2175 ** Flush the prepared statement cache, or set the maximum number of
2176 ** cached statements.
2177 */
2178 case DB_CACHE: {
2179 char *subCmd;
2180 int n;
2181
2182 if( objc<=2 ){
2183 Tcl_WrongNumArgs(interp, 1, objv, "cache option ?arg?");
2184 return TCL_ERROR;
2185 }
2186 subCmd = Tcl_GetStringFromObj( objv[2], 0 );
2187 if( *subCmd=='f' && strcmp(subCmd,"flush")==0 ){
2188 if( objc!=3 ){
2189 Tcl_WrongNumArgs(interp, 2, objv, "flush");
2190 return TCL_ERROR;
2191 }else{
2192 flushStmtCache( pDb );
2193 }
2194 }else if( *subCmd=='s' && strcmp(subCmd,"size")==0 ){
2195 if( objc!=4 ){
2196 Tcl_WrongNumArgs(interp, 2, objv, "size n");
2197 return TCL_ERROR;
2198 }else{
2199 if( TCL_ERROR==Tcl_GetIntFromObj(interp, objv[3], &n) ){
mistachkinb56660f2016-07-14 21:26:09 +00002200 Tcl_AppendResult( interp, "cannot convert \"",
drha198f2b2014-02-07 19:26:13 +00002201 Tcl_GetStringFromObj(objv[3],0), "\" to integer", (char*)0);
drhfb7e7652005-01-24 00:28:42 +00002202 return TCL_ERROR;
2203 }else{
2204 if( n<0 ){
2205 flushStmtCache( pDb );
2206 n = 0;
2207 }else if( n>MAX_PREPARED_STMTS ){
2208 n = MAX_PREPARED_STMTS;
2209 }
2210 pDb->maxStmt = n;
2211 }
2212 }
2213 }else{
mistachkinb56660f2016-07-14 21:26:09 +00002214 Tcl_AppendResult( interp, "bad option \"",
drha198f2b2014-02-07 19:26:13 +00002215 Tcl_GetStringFromObj(objv[2],0), "\": must be flush or size",
2216 (char*)0);
drhfb7e7652005-01-24 00:28:42 +00002217 return TCL_ERROR;
2218 }
2219 break;
2220 }
2221
danielk1977b28af712004-06-21 06:50:26 +00002222 /* $db changes
drhc8d30ac2002-04-12 10:08:59 +00002223 **
2224 ** Return the number of rows that were modified, inserted, or deleted by
mistachkinb56660f2016-07-14 21:26:09 +00002225 ** the most recent INSERT, UPDATE or DELETE statement, not including
danielk1977b28af712004-06-21 06:50:26 +00002226 ** any changes made by trigger programs.
drhc8d30ac2002-04-12 10:08:59 +00002227 */
2228 case DB_CHANGES: {
2229 Tcl_Obj *pResult;
drhc8d30ac2002-04-12 10:08:59 +00002230 if( objc!=2 ){
2231 Tcl_WrongNumArgs(interp, 2, objv, "");
2232 return TCL_ERROR;
2233 }
drhc8d30ac2002-04-12 10:08:59 +00002234 pResult = Tcl_GetObjResult(interp);
dan2c718872021-06-22 18:32:05 +00002235 Tcl_SetWideIntObj(pResult, sqlite3_changes64(pDb->db));
rdcf146a772004-02-25 22:51:06 +00002236 break;
2237 }
2238
drh75897232000-05-29 14:26:00 +00002239 /* $db close
2240 **
2241 ** Shutdown the database
2242 */
drh6d313162000-09-21 13:01:35 +00002243 case DB_CLOSE: {
2244 Tcl_DeleteCommand(interp, Tcl_GetStringFromObj(objv[0], 0));
2245 break;
2246 }
drh75897232000-05-29 14:26:00 +00002247
drh0f14e2e2004-06-29 12:39:08 +00002248 /*
2249 ** $db collate NAME SCRIPT
2250 **
2251 ** Create a new SQL collation function called NAME. Whenever
2252 ** that function is called, invoke SCRIPT to evaluate the function.
2253 */
2254 case DB_COLLATE: {
2255 SqlCollate *pCollate;
2256 char *zName;
2257 char *zScript;
2258 int nScript;
2259 if( objc!=4 ){
2260 Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
2261 return TCL_ERROR;
2262 }
2263 zName = Tcl_GetStringFromObj(objv[2], 0);
2264 zScript = Tcl_GetStringFromObj(objv[3], &nScript);
2265 pCollate = (SqlCollate*)Tcl_Alloc( sizeof(*pCollate) + nScript + 1 );
2266 if( pCollate==0 ) return TCL_ERROR;
2267 pCollate->interp = interp;
2268 pCollate->pNext = pDb->pCollate;
2269 pCollate->zScript = (char*)&pCollate[1];
2270 pDb->pCollate = pCollate;
drh5bb3eb92007-05-04 13:15:55 +00002271 memcpy(pCollate->zScript, zScript, nScript+1);
mistachkinb56660f2016-07-14 21:26:09 +00002272 if( sqlite3_create_collation(pDb->db, zName, SQLITE_UTF8,
drh0f14e2e2004-06-29 12:39:08 +00002273 pCollate, tclSqlCollate) ){
danielk19779636c4e2005-01-25 04:27:54 +00002274 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drh0f14e2e2004-06-29 12:39:08 +00002275 return TCL_ERROR;
2276 }
2277 break;
2278 }
2279
2280 /*
2281 ** $db collation_needed SCRIPT
2282 **
2283 ** Create a new SQL collation function called NAME. Whenever
2284 ** that function is called, invoke SCRIPT to evaluate the function.
2285 */
2286 case DB_COLLATION_NEEDED: {
2287 if( objc!=3 ){
2288 Tcl_WrongNumArgs(interp, 2, objv, "SCRIPT");
2289 return TCL_ERROR;
2290 }
2291 if( pDb->pCollateNeeded ){
2292 Tcl_DecrRefCount(pDb->pCollateNeeded);
2293 }
2294 pDb->pCollateNeeded = Tcl_DuplicateObj(objv[2]);
2295 Tcl_IncrRefCount(pDb->pCollateNeeded);
2296 sqlite3_collation_needed(pDb->db, pDb, tclCollateNeeded);
2297 break;
2298 }
2299
drh19e2d372005-08-29 23:00:03 +00002300 /* $db commit_hook ?CALLBACK?
2301 **
2302 ** Invoke the given callback just before committing every SQL transaction.
2303 ** If the callback throws an exception or returns non-zero, then the
2304 ** transaction is aborted. If CALLBACK is an empty string, the callback
2305 ** is disabled.
2306 */
2307 case DB_COMMIT_HOOK: {
2308 if( objc>3 ){
2309 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2310 return TCL_ERROR;
2311 }else if( objc==2 ){
2312 if( pDb->zCommit ){
drha198f2b2014-02-07 19:26:13 +00002313 Tcl_AppendResult(interp, pDb->zCommit, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002314 }
2315 }else{
mistachkin6ef5e122014-01-24 17:03:55 +00002316 const char *zCommit;
drh19e2d372005-08-29 23:00:03 +00002317 int len;
2318 if( pDb->zCommit ){
2319 Tcl_Free(pDb->zCommit);
2320 }
2321 zCommit = Tcl_GetStringFromObj(objv[2], &len);
2322 if( zCommit && len>0 ){
2323 pDb->zCommit = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00002324 memcpy(pDb->zCommit, zCommit, len+1);
drh19e2d372005-08-29 23:00:03 +00002325 }else{
2326 pDb->zCommit = 0;
2327 }
2328 if( pDb->zCommit ){
2329 pDb->interp = interp;
2330 sqlite3_commit_hook(pDb->db, DbCommitHandler, pDb);
2331 }else{
2332 sqlite3_commit_hook(pDb->db, 0, 0);
2333 }
2334 }
2335 break;
2336 }
2337
drh75897232000-05-29 14:26:00 +00002338 /* $db complete SQL
2339 **
2340 ** Return TRUE if SQL is a complete SQL statement. Return FALSE if
2341 ** additional lines of input are needed. This is similar to the
2342 ** built-in "info complete" command of Tcl.
2343 */
drh6d313162000-09-21 13:01:35 +00002344 case DB_COMPLETE: {
drhccae6022005-02-26 17:31:26 +00002345#ifndef SQLITE_OMIT_COMPLETE
drh6d313162000-09-21 13:01:35 +00002346 Tcl_Obj *pResult;
2347 int isComplete;
2348 if( objc!=3 ){
2349 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
drh75897232000-05-29 14:26:00 +00002350 return TCL_ERROR;
2351 }
danielk19776f8a5032004-05-10 10:34:51 +00002352 isComplete = sqlite3_complete( Tcl_GetStringFromObj(objv[2], 0) );
drh6d313162000-09-21 13:01:35 +00002353 pResult = Tcl_GetObjResult(interp);
2354 Tcl_SetBooleanObj(pResult, isComplete);
drhccae6022005-02-26 17:31:26 +00002355#endif
drh6d313162000-09-21 13:01:35 +00002356 break;
2357 }
drhdcd997e2003-01-31 17:21:49 +00002358
drh11d88e62019-08-15 21:27:20 +00002359 /* $db config ?OPTION? ?BOOLEAN?
2360 **
2361 ** Configure the database connection using the sqlite3_db_config()
2362 ** interface.
2363 */
2364 case DB_CONFIG: {
2365 static const struct DbConfigChoices {
2366 const char *zName;
2367 int op;
2368 } aDbConfig[] = {
drh76a1fce2020-01-18 22:20:14 +00002369 { "defensive", SQLITE_DBCONFIG_DEFENSIVE },
2370 { "dqs_ddl", SQLITE_DBCONFIG_DQS_DDL },
2371 { "dqs_dml", SQLITE_DBCONFIG_DQS_DML },
drh11d88e62019-08-15 21:27:20 +00002372 { "enable_fkey", SQLITE_DBCONFIG_ENABLE_FKEY },
drh76a1fce2020-01-18 22:20:14 +00002373 { "enable_qpsg", SQLITE_DBCONFIG_ENABLE_QPSG },
drh11d88e62019-08-15 21:27:20 +00002374 { "enable_trigger", SQLITE_DBCONFIG_ENABLE_TRIGGER },
2375 { "enable_view", SQLITE_DBCONFIG_ENABLE_VIEW },
2376 { "fts3_tokenizer", SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER },
drh76a1fce2020-01-18 22:20:14 +00002377 { "legacy_alter_table", SQLITE_DBCONFIG_LEGACY_ALTER_TABLE },
2378 { "legacy_file_format", SQLITE_DBCONFIG_LEGACY_FILE_FORMAT },
drh11d88e62019-08-15 21:27:20 +00002379 { "load_extension", SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION },
2380 { "no_ckpt_on_close", SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE },
drh11d88e62019-08-15 21:27:20 +00002381 { "reset_database", SQLITE_DBCONFIG_RESET_DATABASE },
drh76a1fce2020-01-18 22:20:14 +00002382 { "trigger_eqp", SQLITE_DBCONFIG_TRIGGER_EQP },
2383 { "trusted_schema", SQLITE_DBCONFIG_TRUSTED_SCHEMA },
drh11d88e62019-08-15 21:27:20 +00002384 { "writable_schema", SQLITE_DBCONFIG_WRITABLE_SCHEMA },
drh11d88e62019-08-15 21:27:20 +00002385 };
2386 Tcl_Obj *pResult;
2387 int ii;
2388 if( objc>4 ){
2389 Tcl_WrongNumArgs(interp, 2, objv, "?OPTION? ?BOOLEAN?");
2390 return TCL_ERROR;
2391 }
2392 if( objc==2 ){
2393 /* With no arguments, list all configuration options and with the
2394 ** current value */
2395 pResult = Tcl_NewListObj(0,0);
2396 for(ii=0; ii<sizeof(aDbConfig)/sizeof(aDbConfig[0]); ii++){
2397 int v = 0;
drh4043cfe2019-08-15 23:11:42 +00002398 sqlite3_db_config(pDb->db, aDbConfig[ii].op, -1, &v);
drh11d88e62019-08-15 21:27:20 +00002399 Tcl_ListObjAppendElement(interp, pResult,
2400 Tcl_NewStringObj(aDbConfig[ii].zName,-1));
2401 Tcl_ListObjAppendElement(interp, pResult,
2402 Tcl_NewIntObj(v));
2403 }
2404 }else{
2405 const char *zOpt = Tcl_GetString(objv[2]);
drh11d88e62019-08-15 21:27:20 +00002406 int onoff = -1;
2407 int v = 0;
2408 if( zOpt[0]=='-' ) zOpt++;
2409 for(ii=0; ii<sizeof(aDbConfig)/sizeof(aDbConfig[0]); ii++){
2410 if( strcmp(aDbConfig[ii].zName, zOpt)==0 ) break;
2411 }
2412 if( ii>=sizeof(aDbConfig)/sizeof(aDbConfig[0]) ){
2413 Tcl_AppendResult(interp, "unknown config option: \"", zOpt,
2414 "\"", (void*)0);
2415 return TCL_ERROR;
2416 }
2417 if( objc==4 ){
2418 if( Tcl_GetBooleanFromObj(interp, objv[3], &onoff) ){
2419 return TCL_ERROR;
2420 }
2421 }
drh4043cfe2019-08-15 23:11:42 +00002422 sqlite3_db_config(pDb->db, aDbConfig[ii].op, onoff, &v);
drh11d88e62019-08-15 21:27:20 +00002423 pResult = Tcl_NewIntObj(v);
2424 }
2425 Tcl_SetObjResult(interp, pResult);
2426 break;
2427 }
2428
drh19e2d372005-08-29 23:00:03 +00002429 /* $db copy conflict-algorithm table filename ?SEPARATOR? ?NULLINDICATOR?
2430 **
2431 ** Copy data into table from filename, optionally using SEPARATOR
2432 ** as column separators. If a column contains a null string, or the
2433 ** value of NULLINDICATOR, a NULL is inserted for the column.
2434 ** conflict-algorithm is one of the sqlite conflict algorithms:
2435 ** rollback, abort, fail, ignore, replace
2436 ** On success, return the number of lines processed, not necessarily same
2437 ** as 'db changes' due to conflict-algorithm selected.
2438 **
2439 ** This code is basically an implementation/enhancement of
2440 ** the sqlite3 shell.c ".import" command.
2441 **
2442 ** This command usage is equivalent to the sqlite2.x COPY statement,
2443 ** which imports file data into a table using the PostgreSQL COPY file format:
2444 ** $db copy $conflit_algo $table_name $filename \t \\N
2445 */
2446 case DB_COPY: {
2447 char *zTable; /* Insert data into this table */
2448 char *zFile; /* The file from which to extract data */
2449 char *zConflict; /* The conflict algorithm to use */
2450 sqlite3_stmt *pStmt; /* A statement */
drh19e2d372005-08-29 23:00:03 +00002451 int nCol; /* Number of columns in the table */
2452 int nByte; /* Number of bytes in an SQL string */
2453 int i, j; /* Loop counters */
2454 int nSep; /* Number of bytes in zSep[] */
2455 int nNull; /* Number of bytes in zNull[] */
2456 char *zSql; /* An SQL statement */
2457 char *zLine; /* A single line of input from the file */
2458 char **azCol; /* zLine[] broken up into columns */
mistachkin6ef5e122014-01-24 17:03:55 +00002459 const char *zCommit; /* How to commit changes */
drh19e2d372005-08-29 23:00:03 +00002460 FILE *in; /* The input file */
2461 int lineno = 0; /* Line number of input file */
2462 char zLineNum[80]; /* Line number print buffer */
2463 Tcl_Obj *pResult; /* interp result */
2464
mistachkin6ef5e122014-01-24 17:03:55 +00002465 const char *zSep;
2466 const char *zNull;
drh19e2d372005-08-29 23:00:03 +00002467 if( objc<5 || objc>7 ){
mistachkinb56660f2016-07-14 21:26:09 +00002468 Tcl_WrongNumArgs(interp, 2, objv,
drh19e2d372005-08-29 23:00:03 +00002469 "CONFLICT-ALGORITHM TABLE FILENAME ?SEPARATOR? ?NULLINDICATOR?");
2470 return TCL_ERROR;
2471 }
2472 if( objc>=6 ){
2473 zSep = Tcl_GetStringFromObj(objv[5], 0);
2474 }else{
2475 zSep = "\t";
2476 }
2477 if( objc>=7 ){
2478 zNull = Tcl_GetStringFromObj(objv[6], 0);
2479 }else{
2480 zNull = "";
2481 }
2482 zConflict = Tcl_GetStringFromObj(objv[2], 0);
2483 zTable = Tcl_GetStringFromObj(objv[3], 0);
2484 zFile = Tcl_GetStringFromObj(objv[4], 0);
drh4f21c4a2008-12-10 22:15:00 +00002485 nSep = strlen30(zSep);
2486 nNull = strlen30(zNull);
drh19e2d372005-08-29 23:00:03 +00002487 if( nSep==0 ){
drha198f2b2014-02-07 19:26:13 +00002488 Tcl_AppendResult(interp,"Error: non-null separator required for copy",
2489 (char*)0);
drh19e2d372005-08-29 23:00:03 +00002490 return TCL_ERROR;
2491 }
drh3e59c012008-09-23 10:12:13 +00002492 if(strcmp(zConflict, "rollback") != 0 &&
2493 strcmp(zConflict, "abort" ) != 0 &&
2494 strcmp(zConflict, "fail" ) != 0 &&
2495 strcmp(zConflict, "ignore" ) != 0 &&
2496 strcmp(zConflict, "replace" ) != 0 ) {
mistachkinb56660f2016-07-14 21:26:09 +00002497 Tcl_AppendResult(interp, "Error: \"", zConflict,
drh19e2d372005-08-29 23:00:03 +00002498 "\", conflict-algorithm must be one of: rollback, "
drha198f2b2014-02-07 19:26:13 +00002499 "abort, fail, ignore, or replace", (char*)0);
drh19e2d372005-08-29 23:00:03 +00002500 return TCL_ERROR;
2501 }
2502 zSql = sqlite3_mprintf("SELECT * FROM '%q'", zTable);
2503 if( zSql==0 ){
drha198f2b2014-02-07 19:26:13 +00002504 Tcl_AppendResult(interp, "Error: no such table: ", zTable, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002505 return TCL_ERROR;
2506 }
drh4f21c4a2008-12-10 22:15:00 +00002507 nByte = strlen30(zSql);
drh3e701a12007-02-01 01:53:44 +00002508 rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
drh19e2d372005-08-29 23:00:03 +00002509 sqlite3_free(zSql);
2510 if( rc ){
drha198f2b2014-02-07 19:26:13 +00002511 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002512 nCol = 0;
2513 }else{
2514 nCol = sqlite3_column_count(pStmt);
2515 }
2516 sqlite3_finalize(pStmt);
2517 if( nCol==0 ) {
2518 return TCL_ERROR;
2519 }
2520 zSql = malloc( nByte + 50 + nCol*2 );
2521 if( zSql==0 ) {
drha198f2b2014-02-07 19:26:13 +00002522 Tcl_AppendResult(interp, "Error: can't malloc()", (char*)0);
drh19e2d372005-08-29 23:00:03 +00002523 return TCL_ERROR;
2524 }
2525 sqlite3_snprintf(nByte+50, zSql, "INSERT OR %q INTO '%q' VALUES(?",
2526 zConflict, zTable);
drh4f21c4a2008-12-10 22:15:00 +00002527 j = strlen30(zSql);
drh19e2d372005-08-29 23:00:03 +00002528 for(i=1; i<nCol; i++){
2529 zSql[j++] = ',';
2530 zSql[j++] = '?';
2531 }
2532 zSql[j++] = ')';
2533 zSql[j] = 0;
drh3e701a12007-02-01 01:53:44 +00002534 rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
drh19e2d372005-08-29 23:00:03 +00002535 free(zSql);
2536 if( rc ){
drha198f2b2014-02-07 19:26:13 +00002537 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002538 sqlite3_finalize(pStmt);
2539 return TCL_ERROR;
2540 }
2541 in = fopen(zFile, "rb");
2542 if( in==0 ){
drhea8f0a12017-01-12 11:50:08 +00002543 Tcl_AppendResult(interp, "Error: cannot open file: ", zFile, (char*)0);
drh19e2d372005-08-29 23:00:03 +00002544 sqlite3_finalize(pStmt);
2545 return TCL_ERROR;
2546 }
2547 azCol = malloc( sizeof(azCol[0])*(nCol+1) );
2548 if( azCol==0 ) {
drha198f2b2014-02-07 19:26:13 +00002549 Tcl_AppendResult(interp, "Error: can't malloc()", (char*)0);
drh43617e92006-03-06 20:55:46 +00002550 fclose(in);
drh19e2d372005-08-29 23:00:03 +00002551 return TCL_ERROR;
2552 }
drh37527852006-03-16 16:19:56 +00002553 (void)sqlite3_exec(pDb->db, "BEGIN", 0, 0, 0);
drh19e2d372005-08-29 23:00:03 +00002554 zCommit = "COMMIT";
2555 while( (zLine = local_getline(0, in))!=0 ){
2556 char *z;
drh19e2d372005-08-29 23:00:03 +00002557 lineno++;
2558 azCol[0] = zLine;
2559 for(i=0, z=zLine; *z; z++){
2560 if( *z==zSep[0] && strncmp(z, zSep, nSep)==0 ){
2561 *z = 0;
2562 i++;
2563 if( i<nCol ){
2564 azCol[i] = &z[nSep];
2565 z += nSep-1;
2566 }
2567 }
2568 }
2569 if( i+1!=nCol ){
2570 char *zErr;
drh4f21c4a2008-12-10 22:15:00 +00002571 int nErr = strlen30(zFile) + 200;
drh5bb3eb92007-05-04 13:15:55 +00002572 zErr = malloc(nErr);
drhc1f44942006-05-10 14:39:13 +00002573 if( zErr ){
drh5bb3eb92007-05-04 13:15:55 +00002574 sqlite3_snprintf(nErr, zErr,
drhc1f44942006-05-10 14:39:13 +00002575 "Error: %s line %d: expected %d columns of data but found %d",
2576 zFile, lineno, nCol, i+1);
drha198f2b2014-02-07 19:26:13 +00002577 Tcl_AppendResult(interp, zErr, (char*)0);
drhc1f44942006-05-10 14:39:13 +00002578 free(zErr);
2579 }
drh19e2d372005-08-29 23:00:03 +00002580 zCommit = "ROLLBACK";
2581 break;
2582 }
2583 for(i=0; i<nCol; i++){
2584 /* check for null data, if so, bind as null */
drhea678832008-12-10 19:26:22 +00002585 if( (nNull>0 && strcmp(azCol[i], zNull)==0)
mistachkinb56660f2016-07-14 21:26:09 +00002586 || strlen30(azCol[i])==0
drhea678832008-12-10 19:26:22 +00002587 ){
drh19e2d372005-08-29 23:00:03 +00002588 sqlite3_bind_null(pStmt, i+1);
2589 }else{
2590 sqlite3_bind_text(pStmt, i+1, azCol[i], -1, SQLITE_STATIC);
2591 }
2592 }
2593 sqlite3_step(pStmt);
2594 rc = sqlite3_reset(pStmt);
2595 free(zLine);
2596 if( rc!=SQLITE_OK ){
drha198f2b2014-02-07 19:26:13 +00002597 Tcl_AppendResult(interp,"Error: ", sqlite3_errmsg(pDb->db), (char*)0);
drh19e2d372005-08-29 23:00:03 +00002598 zCommit = "ROLLBACK";
2599 break;
2600 }
2601 }
2602 free(azCol);
2603 fclose(in);
2604 sqlite3_finalize(pStmt);
drh37527852006-03-16 16:19:56 +00002605 (void)sqlite3_exec(pDb->db, zCommit, 0, 0, 0);
drh19e2d372005-08-29 23:00:03 +00002606
2607 if( zCommit[0] == 'C' ){
2608 /* success, set result as number of lines processed */
2609 pResult = Tcl_GetObjResult(interp);
2610 Tcl_SetIntObj(pResult, lineno);
2611 rc = TCL_OK;
2612 }else{
2613 /* failure, append lineno where failed */
drh5bb3eb92007-05-04 13:15:55 +00002614 sqlite3_snprintf(sizeof(zLineNum), zLineNum,"%d",lineno);
drha198f2b2014-02-07 19:26:13 +00002615 Tcl_AppendResult(interp,", failed while processing line: ",zLineNum,
2616 (char*)0);
drh19e2d372005-08-29 23:00:03 +00002617 rc = TCL_ERROR;
2618 }
2619 break;
2620 }
2621
drhdcd997e2003-01-31 17:21:49 +00002622 /*
drh6ca64482019-01-22 16:06:20 +00002623 ** $db deserialize ?-maxsize N? ?-readonly BOOL? ?DATABASE? VALUE
drhcb7d5412018-01-03 16:49:52 +00002624 **
2625 ** Reopen DATABASE (default "main") using the content in $VALUE
2626 */
2627 case DB_DESERIALIZE: {
drh8d889af2021-05-08 17:18:23 +00002628#ifdef SQLITE_OMIT_DESERIALIZE
drh3ec86652018-01-03 19:03:31 +00002629 Tcl_AppendResult(interp, "MEMDB not available in this build",
2630 (char*)0);
2631 rc = TCL_ERROR;
2632#else
drh6ca64482019-01-22 16:06:20 +00002633 const char *zSchema = 0;
2634 Tcl_Obj *pValue = 0;
drh3ec86652018-01-03 19:03:31 +00002635 unsigned char *pBA;
2636 unsigned char *pData;
2637 int len, xrc;
drh6ca64482019-01-22 16:06:20 +00002638 sqlite3_int64 mxSize = 0;
2639 int i;
2640 int isReadonly = 0;
2641
2642
2643 if( objc<3 ){
drh3ec86652018-01-03 19:03:31 +00002644 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? VALUE");
2645 rc = TCL_ERROR;
2646 break;
2647 }
drh6ca64482019-01-22 16:06:20 +00002648 for(i=2; i<objc-1; i++){
2649 const char *z = Tcl_GetString(objv[i]);
2650 if( strcmp(z,"-maxsize")==0 && i<objc-2 ){
drh7907d372021-11-23 12:59:25 +00002651 Tcl_WideInt x;
2652 rc = Tcl_GetWideIntFromObj(interp, objv[++i], &x);
drh6ca64482019-01-22 16:06:20 +00002653 if( rc ) goto deserialize_error;
drh7907d372021-11-23 12:59:25 +00002654 mxSize = x;
drh6ca64482019-01-22 16:06:20 +00002655 continue;
2656 }
2657 if( strcmp(z,"-readonly")==0 && i<objc-2 ){
2658 rc = Tcl_GetBooleanFromObj(interp, objv[++i], &isReadonly);
2659 if( rc ) goto deserialize_error;
2660 continue;
2661 }
2662 if( zSchema==0 && i==objc-2 && z[0]!='-' ){
2663 zSchema = z;
2664 continue;
2665 }
2666 Tcl_AppendResult(interp, "unknown option: ", z, (char*)0);
2667 rc = TCL_ERROR;
2668 goto deserialize_error;
2669 }
2670 pValue = objv[objc-1];
drh3ec86652018-01-03 19:03:31 +00002671 pBA = Tcl_GetByteArrayFromObj(pValue, &len);
2672 pData = sqlite3_malloc64( len );
drha5bb4352018-01-03 23:40:02 +00002673 if( pData==0 && len>0 ){
drh3ec86652018-01-03 19:03:31 +00002674 Tcl_AppendResult(interp, "out of memory", (char*)0);
2675 rc = TCL_ERROR;
2676 }else{
drh6ca64482019-01-22 16:06:20 +00002677 int flags;
drha5bb4352018-01-03 23:40:02 +00002678 if( len>0 ) memcpy(pData, pBA, len);
drh6ca64482019-01-22 16:06:20 +00002679 if( isReadonly ){
2680 flags = SQLITE_DESERIALIZE_FREEONCLOSE | SQLITE_DESERIALIZE_READONLY;
2681 }else{
2682 flags = SQLITE_DESERIALIZE_FREEONCLOSE | SQLITE_DESERIALIZE_RESIZEABLE;
2683 }
2684 xrc = sqlite3_deserialize(pDb->db, zSchema, pData, len, len, flags);
drh3ec86652018-01-03 19:03:31 +00002685 if( xrc ){
2686 Tcl_AppendResult(interp, "unable to set MEMDB content", (char*)0);
2687 rc = TCL_ERROR;
2688 }
drh6ca64482019-01-22 16:06:20 +00002689 if( mxSize>0 ){
2690 sqlite3_file_control(pDb->db, zSchema,SQLITE_FCNTL_SIZE_LIMIT,&mxSize);
2691 }
drh3ec86652018-01-03 19:03:31 +00002692 }
drh6ca64482019-01-22 16:06:20 +00002693deserialize_error:
drh3ec86652018-01-03 19:03:31 +00002694#endif
drhcb7d5412018-01-03 16:49:52 +00002695 break;
2696 }
2697
2698 /*
drh41449052006-07-06 17:08:48 +00002699 ** $db enable_load_extension BOOLEAN
2700 **
2701 ** Turn the extension loading feature on or off. It if off by
2702 ** default.
2703 */
2704 case DB_ENABLE_LOAD_EXTENSION: {
drhf533acc2006-12-19 18:57:11 +00002705#ifndef SQLITE_OMIT_LOAD_EXTENSION
drh41449052006-07-06 17:08:48 +00002706 int onoff;
2707 if( objc!=3 ){
2708 Tcl_WrongNumArgs(interp, 2, objv, "BOOLEAN");
2709 return TCL_ERROR;
2710 }
2711 if( Tcl_GetBooleanFromObj(interp, objv[2], &onoff) ){
2712 return TCL_ERROR;
2713 }
2714 sqlite3_enable_load_extension(pDb->db, onoff);
2715 break;
drhf533acc2006-12-19 18:57:11 +00002716#else
2717 Tcl_AppendResult(interp, "extension loading is turned off at compile-time",
drha198f2b2014-02-07 19:26:13 +00002718 (char*)0);
drhf533acc2006-12-19 18:57:11 +00002719 return TCL_ERROR;
2720#endif
drh41449052006-07-06 17:08:48 +00002721 }
2722
2723 /*
drhdcd997e2003-01-31 17:21:49 +00002724 ** $db errorcode
2725 **
2726 ** Return the numeric error code that was returned by the most recent
danielk19776f8a5032004-05-10 10:34:51 +00002727 ** call to sqlite3_exec().
drhdcd997e2003-01-31 17:21:49 +00002728 */
2729 case DB_ERRORCODE: {
danielk1977f3ce83f2004-06-14 11:43:46 +00002730 Tcl_SetObjResult(interp, Tcl_NewIntObj(sqlite3_errcode(pDb->db)));
drhdcd997e2003-01-31 17:21:49 +00002731 break;
2732 }
dan4a4c11a2009-10-06 14:59:02 +00002733
2734 /*
drhbe4e3c82022-02-16 15:11:01 +00002735 ** $db erroroffset
2736 **
2737 ** Return the numeric error code that was returned by the most recent
2738 ** call to sqlite3_exec().
2739 */
2740 case DB_ERROROFFSET: {
2741 Tcl_SetObjResult(interp, Tcl_NewIntObj(sqlite3_error_offset(pDb->db)));
2742 break;
2743 }
2744
2745 /*
dan4a4c11a2009-10-06 14:59:02 +00002746 ** $db exists $sql
2747 ** $db onecolumn $sql
2748 **
2749 ** The onecolumn method is the equivalent of:
2750 ** lindex [$db eval $sql] 0
2751 */
mistachkinb56660f2016-07-14 21:26:09 +00002752 case DB_EXISTS:
dan4a4c11a2009-10-06 14:59:02 +00002753 case DB_ONECOLUMN: {
drhedc40242016-06-13 12:34:38 +00002754 Tcl_Obj *pResult = 0;
dan4a4c11a2009-10-06 14:59:02 +00002755 DbEvalContext sEval;
2756 if( objc!=3 ){
2757 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
2758 return TCL_ERROR;
2759 }
2760
drhaf38cdb2017-06-26 21:08:32 +00002761 dbEvalInit(&sEval, pDb, objv[2], 0, 0);
dan4a4c11a2009-10-06 14:59:02 +00002762 rc = dbEvalStep(&sEval);
2763 if( choice==DB_ONECOLUMN ){
2764 if( rc==TCL_OK ){
drhedc40242016-06-13 12:34:38 +00002765 pResult = dbEvalColumnValue(&sEval, 0);
dand5f12cd2011-08-18 17:47:57 +00002766 }else if( rc==TCL_BREAK ){
2767 Tcl_ResetResult(interp);
dan4a4c11a2009-10-06 14:59:02 +00002768 }
2769 }else if( rc==TCL_BREAK || rc==TCL_OK ){
drhedc40242016-06-13 12:34:38 +00002770 pResult = Tcl_NewBooleanObj(rc==TCL_OK);
dan4a4c11a2009-10-06 14:59:02 +00002771 }
2772 dbEvalFinalize(&sEval);
drhedc40242016-06-13 12:34:38 +00002773 if( pResult ) Tcl_SetObjResult(interp, pResult);
dan4a4c11a2009-10-06 14:59:02 +00002774
2775 if( rc==TCL_BREAK ){
2776 rc = TCL_OK;
2777 }
2778 break;
2779 }
mistachkinb56660f2016-07-14 21:26:09 +00002780
drh75897232000-05-29 14:26:00 +00002781 /*
drhaf38cdb2017-06-26 21:08:32 +00002782 ** $db eval ?options? $sql ?array? ?{ ...code... }?
drh75897232000-05-29 14:26:00 +00002783 **
2784 ** The SQL statement in $sql is evaluated. For each row, the values are
drhbec3f402000-08-04 13:49:02 +00002785 ** placed in elements of the array named "array" and ...code... is executed.
drh75897232000-05-29 14:26:00 +00002786 ** If "array" and "code" are omitted, then no callback is every invoked.
2787 ** If "array" is an empty string, then the values are placed in variables
2788 ** that have the same name as the fields extracted by the query.
2789 */
dan4a4c11a2009-10-06 14:59:02 +00002790 case DB_EVAL: {
drhaf38cdb2017-06-26 21:08:32 +00002791 int evalFlags = 0;
2792 const char *zOpt;
2793 while( objc>3 && (zOpt = Tcl_GetString(objv[2]))!=0 && zOpt[0]=='-' ){
2794 if( strcmp(zOpt, "-withoutnulls")==0 ){
2795 evalFlags |= SQLITE_EVAL_WITHOUTNULLS;
2796 }
2797 else{
2798 Tcl_AppendResult(interp, "unknown option: \"", zOpt, "\"", (void*)0);
2799 return TCL_ERROR;
2800 }
2801 objc--;
2802 objv++;
2803 }
dan4a4c11a2009-10-06 14:59:02 +00002804 if( objc<3 || objc>5 ){
drhaf38cdb2017-06-26 21:08:32 +00002805 Tcl_WrongNumArgs(interp, 2, objv,
2806 "?OPTIONS? SQL ?ARRAY-NAME? ?SCRIPT?");
dan4a4c11a2009-10-06 14:59:02 +00002807 return TCL_ERROR;
danielk197730ccda12004-05-27 12:11:31 +00002808 }
dan4a4c11a2009-10-06 14:59:02 +00002809
drh92febd92004-08-20 18:34:20 +00002810 if( objc==3 ){
dan4a4c11a2009-10-06 14:59:02 +00002811 DbEvalContext sEval;
2812 Tcl_Obj *pRet = Tcl_NewObj();
2813 Tcl_IncrRefCount(pRet);
drhaf38cdb2017-06-26 21:08:32 +00002814 dbEvalInit(&sEval, pDb, objv[2], 0, 0);
dan4a4c11a2009-10-06 14:59:02 +00002815 while( TCL_OK==(rc = dbEvalStep(&sEval)) ){
2816 int i;
2817 int nCol;
2818 dbEvalRowInfo(&sEval, &nCol, 0);
drh92febd92004-08-20 18:34:20 +00002819 for(i=0; i<nCol; i++){
dan4a4c11a2009-10-06 14:59:02 +00002820 Tcl_ListObjAppendElement(interp, pRet, dbEvalColumnValue(&sEval, i));
danielk197730ccda12004-05-27 12:11:31 +00002821 }
2822 }
dan4a4c11a2009-10-06 14:59:02 +00002823 dbEvalFinalize(&sEval);
drh90b6bb12004-09-13 13:16:31 +00002824 if( rc==TCL_BREAK ){
dan4a4c11a2009-10-06 14:59:02 +00002825 Tcl_SetObjResult(interp, pRet);
drh90b6bb12004-09-13 13:16:31 +00002826 rc = TCL_OK;
2827 }
drh1807ce32004-09-07 13:20:35 +00002828 Tcl_DecrRefCount(pRet);
dan4a4c11a2009-10-06 14:59:02 +00002829 }else{
mistachkin8e189222015-04-19 21:43:16 +00002830 ClientData cd2[2];
dan4a4c11a2009-10-06 14:59:02 +00002831 DbEvalContext *p;
2832 Tcl_Obj *pArray = 0;
2833 Tcl_Obj *pScript;
2834
drhaf38cdb2017-06-26 21:08:32 +00002835 if( objc>=5 && *(char *)Tcl_GetString(objv[3]) ){
dan4a4c11a2009-10-06 14:59:02 +00002836 pArray = objv[3];
2837 }
2838 pScript = objv[objc-1];
2839 Tcl_IncrRefCount(pScript);
mistachkinb56660f2016-07-14 21:26:09 +00002840
dan4a4c11a2009-10-06 14:59:02 +00002841 p = (DbEvalContext *)Tcl_Alloc(sizeof(DbEvalContext));
drhaf38cdb2017-06-26 21:08:32 +00002842 dbEvalInit(p, pDb, objv[2], pArray, evalFlags);
dan4a4c11a2009-10-06 14:59:02 +00002843
mistachkin8e189222015-04-19 21:43:16 +00002844 cd2[0] = (void *)p;
2845 cd2[1] = (void *)pScript;
2846 rc = DbEvalNextCmd(cd2, interp, TCL_OK);
danielk197730ccda12004-05-27 12:11:31 +00002847 }
danielk197730ccda12004-05-27 12:11:31 +00002848 break;
2849 }
drhbec3f402000-08-04 13:49:02 +00002850
2851 /*
drh42d2fce2019-08-15 20:04:09 +00002852 ** $db function NAME [OPTIONS] SCRIPT
drhcabb0812002-09-14 13:47:32 +00002853 **
2854 ** Create a new SQL function called NAME. Whenever that function is
2855 ** called, invoke SCRIPT to evaluate the function.
drh42d2fce2019-08-15 20:04:09 +00002856 **
2857 ** Options:
2858 ** --argcount N Function has exactly N arguments
2859 ** --deterministic The function is pure
2860 ** --directonly Prohibit use inside triggers and views
drh15f3eac2020-01-08 15:44:10 +00002861 ** --innocuous Has no side effects or information leaks
drh42d2fce2019-08-15 20:04:09 +00002862 ** --returntype TYPE Specify the return type of the function
drhcabb0812002-09-14 13:47:32 +00002863 */
2864 case DB_FUNCTION: {
dan3df30592015-03-13 08:31:54 +00002865 int flags = SQLITE_UTF8;
drhcabb0812002-09-14 13:47:32 +00002866 SqlFunc *pFunc;
drhd1e47332005-06-26 17:55:33 +00002867 Tcl_Obj *pScript;
drhcabb0812002-09-14 13:47:32 +00002868 char *zName;
drhe3602be2008-09-09 12:31:33 +00002869 int nArg = -1;
dan3df30592015-03-13 08:31:54 +00002870 int i;
dan89d24932019-02-27 16:38:19 +00002871 int eType = SQLITE_NULL;
dan3df30592015-03-13 08:31:54 +00002872 if( objc<4 ){
2873 Tcl_WrongNumArgs(interp, 2, objv, "NAME ?SWITCHES? SCRIPT");
2874 return TCL_ERROR;
2875 }
2876 for(i=3; i<(objc-1); i++){
2877 const char *z = Tcl_GetString(objv[i]);
drh4f21c4a2008-12-10 22:15:00 +00002878 int n = strlen30(z);
dan89d24932019-02-27 16:38:19 +00002879 if( n>1 && strncmp(z, "-argcount",n)==0 ){
dan3df30592015-03-13 08:31:54 +00002880 if( i==(objc-2) ){
drhea8f0a12017-01-12 11:50:08 +00002881 Tcl_AppendResult(interp, "option requires an argument: ", z,(char*)0);
dan3df30592015-03-13 08:31:54 +00002882 return TCL_ERROR;
2883 }
2884 if( Tcl_GetIntFromObj(interp, objv[i+1], &nArg) ) return TCL_ERROR;
drhe3602be2008-09-09 12:31:33 +00002885 if( nArg<0 ){
2886 Tcl_AppendResult(interp, "number of arguments must be non-negative",
2887 (char*)0);
2888 return TCL_ERROR;
2889 }
dan3df30592015-03-13 08:31:54 +00002890 i++;
2891 }else
dan89d24932019-02-27 16:38:19 +00002892 if( n>1 && strncmp(z, "-deterministic",n)==0 ){
dan3df30592015-03-13 08:31:54 +00002893 flags |= SQLITE_DETERMINISTIC;
dan89d24932019-02-27 16:38:19 +00002894 }else
drh42d2fce2019-08-15 20:04:09 +00002895 if( n>1 && strncmp(z, "-directonly",n)==0 ){
2896 flags |= SQLITE_DIRECTONLY;
2897 }else
drh15f3eac2020-01-08 15:44:10 +00002898 if( n>1 && strncmp(z, "-innocuous",n)==0 ){
2899 flags |= SQLITE_INNOCUOUS;
2900 }else
dan89d24932019-02-27 16:38:19 +00002901 if( n>1 && strncmp(z, "-returntype", n)==0 ){
2902 const char *azType[] = {"integer", "real", "text", "blob", "any", 0};
2903 assert( SQLITE_INTEGER==1 && SQLITE_FLOAT==2 && SQLITE_TEXT==3 );
2904 assert( SQLITE_BLOB==4 && SQLITE_NULL==5 );
2905 if( i==(objc-2) ){
2906 Tcl_AppendResult(interp, "option requires an argument: ", z,(char*)0);
2907 return TCL_ERROR;
2908 }
2909 i++;
2910 if( Tcl_GetIndexFromObj(interp, objv[i], azType, "type", 0, &eType) ){
2911 return TCL_ERROR;
2912 }
2913 eType++;
dan3df30592015-03-13 08:31:54 +00002914 }else{
mistachkinb56660f2016-07-14 21:26:09 +00002915 Tcl_AppendResult(interp, "bad option \"", z,
drh42d2fce2019-08-15 20:04:09 +00002916 "\": must be -argcount, -deterministic, -directonly,"
drh15f3eac2020-01-08 15:44:10 +00002917 " -innocuous, or -returntype", (char*)0
dan3df30592015-03-13 08:31:54 +00002918 );
2919 return TCL_ERROR;
drhe3602be2008-09-09 12:31:33 +00002920 }
drhcabb0812002-09-14 13:47:32 +00002921 }
dan3df30592015-03-13 08:31:54 +00002922
2923 pScript = objv[objc-1];
drhcabb0812002-09-14 13:47:32 +00002924 zName = Tcl_GetStringFromObj(objv[2], 0);
drhd1e47332005-06-26 17:55:33 +00002925 pFunc = findSqlFunc(pDb, zName);
drhcabb0812002-09-14 13:47:32 +00002926 if( pFunc==0 ) return TCL_ERROR;
drhd1e47332005-06-26 17:55:33 +00002927 if( pFunc->pScript ){
2928 Tcl_DecrRefCount(pFunc->pScript);
2929 }
2930 pFunc->pScript = pScript;
2931 Tcl_IncrRefCount(pScript);
2932 pFunc->useEvalObjv = safeToUseEvalObjv(interp, pScript);
dan89d24932019-02-27 16:38:19 +00002933 pFunc->eType = eType;
dan3df30592015-03-13 08:31:54 +00002934 rc = sqlite3_create_function(pDb->db, zName, nArg, flags,
danielk1977d8123362004-06-12 09:25:12 +00002935 pFunc, tclSqlFunc, 0, 0);
drhfb7e7652005-01-24 00:28:42 +00002936 if( rc!=SQLITE_OK ){
danielk19779636c4e2005-01-25 04:27:54 +00002937 rc = TCL_ERROR;
2938 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drhfb7e7652005-01-24 00:28:42 +00002939 }
drhcabb0812002-09-14 13:47:32 +00002940 break;
2941 }
2942
2943 /*
danielk19778cbadb02007-05-03 16:31:26 +00002944 ** $db incrblob ?-readonly? ?DB? TABLE COLUMN ROWID
danielk1977b4e9af92007-05-01 17:49:49 +00002945 */
2946 case DB_INCRBLOB: {
danielk197732a0d8b2007-05-04 19:03:02 +00002947#ifdef SQLITE_OMIT_INCRBLOB
drha198f2b2014-02-07 19:26:13 +00002948 Tcl_AppendResult(interp, "incrblob not available in this build", (char*)0);
danielk197732a0d8b2007-05-04 19:03:02 +00002949 return TCL_ERROR;
2950#else
danielk19778cbadb02007-05-03 16:31:26 +00002951 int isReadonly = 0;
danielk1977b4e9af92007-05-01 17:49:49 +00002952 const char *zDb = "main";
2953 const char *zTable;
2954 const char *zColumn;
drhb3f787f2012-09-29 14:45:54 +00002955 Tcl_WideInt iRow;
danielk1977b4e9af92007-05-01 17:49:49 +00002956
danielk19778cbadb02007-05-03 16:31:26 +00002957 /* Check for the -readonly option */
2958 if( objc>3 && strcmp(Tcl_GetString(objv[2]), "-readonly")==0 ){
2959 isReadonly = 1;
2960 }
2961
2962 if( objc!=(5+isReadonly) && objc!=(6+isReadonly) ){
2963 Tcl_WrongNumArgs(interp, 2, objv, "?-readonly? ?DB? TABLE COLUMN ROWID");
danielk1977b4e9af92007-05-01 17:49:49 +00002964 return TCL_ERROR;
2965 }
2966
danielk19778cbadb02007-05-03 16:31:26 +00002967 if( objc==(6+isReadonly) ){
danielk1977b4e9af92007-05-01 17:49:49 +00002968 zDb = Tcl_GetString(objv[2]);
2969 }
2970 zTable = Tcl_GetString(objv[objc-3]);
2971 zColumn = Tcl_GetString(objv[objc-2]);
2972 rc = Tcl_GetWideIntFromObj(interp, objv[objc-1], &iRow);
2973
2974 if( rc==TCL_OK ){
danielk19778cbadb02007-05-03 16:31:26 +00002975 rc = createIncrblobChannel(
danedf5b162014-08-19 09:15:41 +00002976 interp, pDb, zDb, zTable, zColumn, (sqlite3_int64)iRow, isReadonly
danielk19778cbadb02007-05-03 16:31:26 +00002977 );
danielk1977b4e9af92007-05-01 17:49:49 +00002978 }
danielk197732a0d8b2007-05-04 19:03:02 +00002979#endif
danielk1977b4e9af92007-05-01 17:49:49 +00002980 break;
2981 }
2982
2983 /*
drhf11bded2006-07-17 00:02:44 +00002984 ** $db interrupt
2985 **
2986 ** Interrupt the execution of the inner-most SQL interpreter. This
2987 ** causes the SQL statement to return an error of SQLITE_INTERRUPT.
2988 */
2989 case DB_INTERRUPT: {
2990 sqlite3_interrupt(pDb->db);
2991 break;
2992 }
2993
2994 /*
drh19e2d372005-08-29 23:00:03 +00002995 ** $db nullvalue ?STRING?
2996 **
2997 ** Change text used when a NULL comes back from the database. If ?STRING?
2998 ** is not present, then the current string used for NULL is returned.
2999 ** If STRING is present, then STRING is returned.
3000 **
3001 */
3002 case DB_NULLVALUE: {
3003 if( objc!=2 && objc!=3 ){
3004 Tcl_WrongNumArgs(interp, 2, objv, "NULLVALUE");
3005 return TCL_ERROR;
3006 }
3007 if( objc==3 ){
3008 int len;
3009 char *zNull = Tcl_GetStringFromObj(objv[2], &len);
3010 if( pDb->zNull ){
3011 Tcl_Free(pDb->zNull);
3012 }
3013 if( zNull && len>0 ){
3014 pDb->zNull = Tcl_Alloc( len + 1 );
drh7fd33922011-06-20 19:00:30 +00003015 memcpy(pDb->zNull, zNull, len);
drh19e2d372005-08-29 23:00:03 +00003016 pDb->zNull[len] = '\0';
3017 }else{
3018 pDb->zNull = 0;
3019 }
3020 }
drhc45e6712012-10-03 11:02:33 +00003021 Tcl_SetObjResult(interp, Tcl_NewStringObj(pDb->zNull, -1));
drh19e2d372005-08-29 23:00:03 +00003022 break;
3023 }
3024
3025 /*
mistachkinb56660f2016-07-14 21:26:09 +00003026 ** $db last_insert_rowid
drhaf9ff332002-01-16 21:00:27 +00003027 **
3028 ** Return an integer which is the ROWID for the most recent insert.
3029 */
3030 case DB_LAST_INSERT_ROWID: {
3031 Tcl_Obj *pResult;
drhf7e678d2006-06-21 19:30:34 +00003032 Tcl_WideInt rowid;
drhaf9ff332002-01-16 21:00:27 +00003033 if( objc!=2 ){
3034 Tcl_WrongNumArgs(interp, 2, objv, "");
3035 return TCL_ERROR;
3036 }
danielk19776f8a5032004-05-10 10:34:51 +00003037 rowid = sqlite3_last_insert_rowid(pDb->db);
drhaf9ff332002-01-16 21:00:27 +00003038 pResult = Tcl_GetObjResult(interp);
drhf7e678d2006-06-21 19:30:34 +00003039 Tcl_SetWideIntObj(pResult, rowid);
drhaf9ff332002-01-16 21:00:27 +00003040 break;
3041 }
3042
3043 /*
dan4a4c11a2009-10-06 14:59:02 +00003044 ** The DB_ONECOLUMN method is implemented together with DB_EXISTS.
drh5d9d7572003-08-19 14:31:01 +00003045 */
drh1807ce32004-09-07 13:20:35 +00003046
3047 /* $db progress ?N CALLBACK?
mistachkinb56660f2016-07-14 21:26:09 +00003048 **
drh1807ce32004-09-07 13:20:35 +00003049 ** Invoke the given callback every N virtual machine opcodes while executing
3050 ** queries.
3051 */
3052 case DB_PROGRESS: {
3053 if( objc==2 ){
3054 if( pDb->zProgress ){
drha198f2b2014-02-07 19:26:13 +00003055 Tcl_AppendResult(interp, pDb->zProgress, (char*)0);
drh1807ce32004-09-07 13:20:35 +00003056 }
3057 }else if( objc==4 ){
3058 char *zProgress;
3059 int len;
3060 int N;
3061 if( TCL_OK!=Tcl_GetIntFromObj(interp, objv[2], &N) ){
drhfd131da2007-08-07 17:13:03 +00003062 return TCL_ERROR;
drh1807ce32004-09-07 13:20:35 +00003063 };
3064 if( pDb->zProgress ){
3065 Tcl_Free(pDb->zProgress);
3066 }
3067 zProgress = Tcl_GetStringFromObj(objv[3], &len);
3068 if( zProgress && len>0 ){
3069 pDb->zProgress = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00003070 memcpy(pDb->zProgress, zProgress, len+1);
drh1807ce32004-09-07 13:20:35 +00003071 }else{
3072 pDb->zProgress = 0;
3073 }
3074#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
3075 if( pDb->zProgress ){
3076 pDb->interp = interp;
3077 sqlite3_progress_handler(pDb->db, N, DbProgressHandler, pDb);
3078 }else{
3079 sqlite3_progress_handler(pDb->db, 0, 0, 0);
3080 }
3081#endif
3082 }else{
3083 Tcl_WrongNumArgs(interp, 2, objv, "N CALLBACK");
drh5d9d7572003-08-19 14:31:01 +00003084 return TCL_ERROR;
3085 }
drh5d9d7572003-08-19 14:31:01 +00003086 break;
3087 }
3088
drh19e2d372005-08-29 23:00:03 +00003089 /* $db profile ?CALLBACK?
3090 **
3091 ** Make arrangements to invoke the CALLBACK routine after each SQL statement
3092 ** that has run. The text of the SQL and the amount of elapse time are
3093 ** appended to CALLBACK before the script is run.
3094 */
3095 case DB_PROFILE: {
3096 if( objc>3 ){
3097 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
3098 return TCL_ERROR;
3099 }else if( objc==2 ){
3100 if( pDb->zProfile ){
drha198f2b2014-02-07 19:26:13 +00003101 Tcl_AppendResult(interp, pDb->zProfile, (char*)0);
drh19e2d372005-08-29 23:00:03 +00003102 }
3103 }else{
3104 char *zProfile;
3105 int len;
3106 if( pDb->zProfile ){
3107 Tcl_Free(pDb->zProfile);
3108 }
3109 zProfile = Tcl_GetStringFromObj(objv[2], &len);
3110 if( zProfile && len>0 ){
3111 pDb->zProfile = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00003112 memcpy(pDb->zProfile, zProfile, len+1);
drh19e2d372005-08-29 23:00:03 +00003113 }else{
3114 pDb->zProfile = 0;
3115 }
drh2eb22af2016-09-10 19:51:40 +00003116#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
3117 !defined(SQLITE_OMIT_DEPRECATED)
drh19e2d372005-08-29 23:00:03 +00003118 if( pDb->zProfile ){
3119 pDb->interp = interp;
3120 sqlite3_profile(pDb->db, DbProfileHandler, pDb);
3121 }else{
3122 sqlite3_profile(pDb->db, 0, 0);
3123 }
3124#endif
3125 }
3126 break;
3127 }
3128
drh5d9d7572003-08-19 14:31:01 +00003129 /*
drh22fbcb82004-02-01 01:22:50 +00003130 ** $db rekey KEY
3131 **
3132 ** Change the encryption key on the currently open database.
3133 */
3134 case DB_REKEY: {
drh22fbcb82004-02-01 01:22:50 +00003135 if( objc!=3 ){
3136 Tcl_WrongNumArgs(interp, 2, objv, "KEY");
3137 return TCL_ERROR;
3138 }
drh22fbcb82004-02-01 01:22:50 +00003139 break;
3140 }
3141
drhdc2c4912009-02-04 22:46:47 +00003142 /* $db restore ?DATABASE? FILENAME
3143 **
mistachkinb56660f2016-07-14 21:26:09 +00003144 ** Open a database file named FILENAME. Transfer the content
drhdc2c4912009-02-04 22:46:47 +00003145 ** of FILENAME into the local database DATABASE (default: "main").
3146 */
3147 case DB_RESTORE: {
3148 const char *zSrcFile;
3149 const char *zDestDb;
3150 sqlite3 *pSrc;
3151 sqlite3_backup *pBackup;
3152 int nTimeout = 0;
3153
3154 if( objc==3 ){
3155 zDestDb = "main";
3156 zSrcFile = Tcl_GetString(objv[2]);
3157 }else if( objc==4 ){
3158 zDestDb = Tcl_GetString(objv[2]);
3159 zSrcFile = Tcl_GetString(objv[3]);
3160 }else{
3161 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE? FILENAME");
3162 return TCL_ERROR;
3163 }
drh147ef392016-01-22 23:17:51 +00003164 rc = sqlite3_open_v2(zSrcFile, &pSrc,
3165 SQLITE_OPEN_READONLY | pDb->openFlags, 0);
drhdc2c4912009-02-04 22:46:47 +00003166 if( rc!=SQLITE_OK ){
3167 Tcl_AppendResult(interp, "cannot open source database: ",
3168 sqlite3_errmsg(pSrc), (char*)0);
3169 sqlite3_close(pSrc);
3170 return TCL_ERROR;
3171 }
3172 pBackup = sqlite3_backup_init(pDb->db, zDestDb, pSrc, "main");
3173 if( pBackup==0 ){
3174 Tcl_AppendResult(interp, "restore failed: ",
3175 sqlite3_errmsg(pDb->db), (char*)0);
3176 sqlite3_close(pSrc);
3177 return TCL_ERROR;
3178 }
3179 while( (rc = sqlite3_backup_step(pBackup,100))==SQLITE_OK
3180 || rc==SQLITE_BUSY ){
3181 if( rc==SQLITE_BUSY ){
3182 if( nTimeout++ >= 3 ) break;
3183 sqlite3_sleep(100);
3184 }
3185 }
3186 sqlite3_backup_finish(pBackup);
3187 if( rc==SQLITE_DONE ){
3188 rc = TCL_OK;
3189 }else if( rc==SQLITE_BUSY || rc==SQLITE_LOCKED ){
3190 Tcl_AppendResult(interp, "restore failed: source database busy",
3191 (char*)0);
3192 rc = TCL_ERROR;
3193 }else{
3194 Tcl_AppendResult(interp, "restore failed: ",
3195 sqlite3_errmsg(pDb->db), (char*)0);
3196 rc = TCL_ERROR;
3197 }
3198 sqlite3_close(pSrc);
3199 break;
3200 }
3201
drh22fbcb82004-02-01 01:22:50 +00003202 /*
drhcb7d5412018-01-03 16:49:52 +00003203 ** $db serialize ?DATABASE?
3204 **
3205 ** Return a serialization of a database.
3206 */
3207 case DB_SERIALIZE: {
drh8d889af2021-05-08 17:18:23 +00003208#ifdef SQLITE_OMIT_DESERIALIZE
drhcb7d5412018-01-03 16:49:52 +00003209 Tcl_AppendResult(interp, "MEMDB not available in this build",
3210 (char*)0);
3211 rc = TCL_ERROR;
3212#else
3213 const char *zSchema = objc>=3 ? Tcl_GetString(objv[2]) : "main";
3214 sqlite3_int64 sz = 0;
3215 unsigned char *pData;
3216 if( objc!=2 && objc!=3 ){
3217 Tcl_WrongNumArgs(interp, 2, objv, "?DATABASE?");
3218 rc = TCL_ERROR;
3219 }else{
3220 int needFree;
3221 pData = sqlite3_serialize(pDb->db, zSchema, &sz, SQLITE_SERIALIZE_NOCOPY);
3222 if( pData ){
3223 needFree = 0;
3224 }else{
3225 pData = sqlite3_serialize(pDb->db, zSchema, &sz, 0);
3226 needFree = 1;
3227 }
3228 Tcl_SetObjResult(interp, Tcl_NewByteArrayObj(pData,sz));
3229 if( needFree ) sqlite3_free(pData);
3230 }
3231#endif
3232 break;
3233 }
3234
3235 /*
danc456a762017-06-22 16:51:16 +00003236 ** $db status (step|sort|autoindex|vmstep)
drhd1d38482008-10-07 23:46:38 +00003237 **
mistachkinb56660f2016-07-14 21:26:09 +00003238 ** Display SQLITE_STMTSTATUS_FULLSCAN_STEP or
drhd1d38482008-10-07 23:46:38 +00003239 ** SQLITE_STMTSTATUS_SORT for the most recent eval.
3240 */
3241 case DB_STATUS: {
drhd1d38482008-10-07 23:46:38 +00003242 int v;
3243 const char *zOp;
3244 if( objc!=3 ){
drh1c320a42010-08-01 22:41:32 +00003245 Tcl_WrongNumArgs(interp, 2, objv, "(step|sort|autoindex)");
drhd1d38482008-10-07 23:46:38 +00003246 return TCL_ERROR;
3247 }
3248 zOp = Tcl_GetString(objv[2]);
3249 if( strcmp(zOp, "step")==0 ){
3250 v = pDb->nStep;
3251 }else if( strcmp(zOp, "sort")==0 ){
3252 v = pDb->nSort;
drh3c379b02010-04-07 19:31:59 +00003253 }else if( strcmp(zOp, "autoindex")==0 ){
3254 v = pDb->nIndex;
danc456a762017-06-22 16:51:16 +00003255 }else if( strcmp(zOp, "vmstep")==0 ){
3256 v = pDb->nVMStep;
drhd1d38482008-10-07 23:46:38 +00003257 }else{
mistachkinb56660f2016-07-14 21:26:09 +00003258 Tcl_AppendResult(interp,
danc456a762017-06-22 16:51:16 +00003259 "bad argument: should be autoindex, step, sort or vmstep",
drhd1d38482008-10-07 23:46:38 +00003260 (char*)0);
3261 return TCL_ERROR;
3262 }
3263 Tcl_SetObjResult(interp, Tcl_NewIntObj(v));
3264 break;
3265 }
mistachkinb56660f2016-07-14 21:26:09 +00003266
drhd1d38482008-10-07 23:46:38 +00003267 /*
drhbec3f402000-08-04 13:49:02 +00003268 ** $db timeout MILLESECONDS
3269 **
3270 ** Delay for the number of milliseconds specified when a file is locked.
3271 */
drh6d313162000-09-21 13:01:35 +00003272 case DB_TIMEOUT: {
drhbec3f402000-08-04 13:49:02 +00003273 int ms;
drh6d313162000-09-21 13:01:35 +00003274 if( objc!=3 ){
3275 Tcl_WrongNumArgs(interp, 2, objv, "MILLISECONDS");
drhbec3f402000-08-04 13:49:02 +00003276 return TCL_ERROR;
3277 }
drh6d313162000-09-21 13:01:35 +00003278 if( Tcl_GetIntFromObj(interp, objv[2], &ms) ) return TCL_ERROR;
danielk19776f8a5032004-05-10 10:34:51 +00003279 sqlite3_busy_timeout(pDb->db, ms);
drh6d313162000-09-21 13:01:35 +00003280 break;
drh75897232000-05-29 14:26:00 +00003281 }
mistachkinb56660f2016-07-14 21:26:09 +00003282
danielk197755c45f22005-04-03 23:54:43 +00003283 /*
drh0f14e2e2004-06-29 12:39:08 +00003284 ** $db total_changes
3285 **
mistachkinb56660f2016-07-14 21:26:09 +00003286 ** Return the number of rows that were modified, inserted, or deleted
drh0f14e2e2004-06-29 12:39:08 +00003287 ** since the database handle was created.
3288 */
3289 case DB_TOTAL_CHANGES: {
3290 Tcl_Obj *pResult;
3291 if( objc!=2 ){
3292 Tcl_WrongNumArgs(interp, 2, objv, "");
3293 return TCL_ERROR;
3294 }
3295 pResult = Tcl_GetObjResult(interp);
dan2c718872021-06-22 18:32:05 +00003296 Tcl_SetWideIntObj(pResult, sqlite3_total_changes64(pDb->db));
drh0f14e2e2004-06-29 12:39:08 +00003297 break;
3298 }
3299
drhb5a20d32003-04-23 12:25:23 +00003300 /* $db trace ?CALLBACK?
3301 **
3302 ** Make arrangements to invoke the CALLBACK routine for each SQL statement
3303 ** that is executed. The text of the SQL is appended to CALLBACK before
3304 ** it is executed.
3305 */
3306 case DB_TRACE: {
3307 if( objc>3 ){
3308 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drhb97759e2004-06-29 11:26:59 +00003309 return TCL_ERROR;
drhb5a20d32003-04-23 12:25:23 +00003310 }else if( objc==2 ){
3311 if( pDb->zTrace ){
drha198f2b2014-02-07 19:26:13 +00003312 Tcl_AppendResult(interp, pDb->zTrace, (char*)0);
drhb5a20d32003-04-23 12:25:23 +00003313 }
3314 }else{
3315 char *zTrace;
3316 int len;
3317 if( pDb->zTrace ){
3318 Tcl_Free(pDb->zTrace);
3319 }
3320 zTrace = Tcl_GetStringFromObj(objv[2], &len);
3321 if( zTrace && len>0 ){
3322 pDb->zTrace = Tcl_Alloc( len + 1 );
drh5bb3eb92007-05-04 13:15:55 +00003323 memcpy(pDb->zTrace, zTrace, len+1);
drhb5a20d32003-04-23 12:25:23 +00003324 }else{
3325 pDb->zTrace = 0;
3326 }
drh2eb22af2016-09-10 19:51:40 +00003327#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT) && \
3328 !defined(SQLITE_OMIT_DEPRECATED)
drhb5a20d32003-04-23 12:25:23 +00003329 if( pDb->zTrace ){
3330 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +00003331 sqlite3_trace(pDb->db, DbTraceHandler, pDb);
drhb5a20d32003-04-23 12:25:23 +00003332 }else{
danielk19776f8a5032004-05-10 10:34:51 +00003333 sqlite3_trace(pDb->db, 0, 0);
drhb5a20d32003-04-23 12:25:23 +00003334 }
drh19e2d372005-08-29 23:00:03 +00003335#endif
drhb5a20d32003-04-23 12:25:23 +00003336 }
3337 break;
3338 }
3339
mistachkinb56660f2016-07-14 21:26:09 +00003340 /* $db trace_v2 ?CALLBACK? ?MASK?
3341 **
3342 ** Make arrangements to invoke the CALLBACK routine for each trace event
3343 ** matching the mask that is generated. The parameters are appended to
3344 ** CALLBACK before it is executed.
3345 */
3346 case DB_TRACE_V2: {
3347 if( objc>4 ){
3348 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK? ?MASK?");
3349 return TCL_ERROR;
3350 }else if( objc==2 ){
3351 if( pDb->zTraceV2 ){
3352 Tcl_AppendResult(interp, pDb->zTraceV2, (char*)0);
3353 }
3354 }else{
mistachkinb56660f2016-07-14 21:26:09 +00003355 char *zTraceV2;
3356 int len;
mistachkinb52dcd82016-07-14 23:17:03 +00003357 Tcl_WideInt wMask = 0;
mistachkinb56660f2016-07-14 21:26:09 +00003358 if( objc==4 ){
mistachkinb52dcd82016-07-14 23:17:03 +00003359 static const char *TTYPE_strs[] = {
3360 "statement", "profile", "row", "close", 0
3361 };
3362 enum TTYPE_enum {
3363 TTYPE_STMT, TTYPE_PROFILE, TTYPE_ROW, TTYPE_CLOSE
3364 };
3365 int i;
3366 if( TCL_OK!=Tcl_ListObjLength(interp, objv[3], &len) ){
mistachkinb56660f2016-07-14 21:26:09 +00003367 return TCL_ERROR;
3368 }
mistachkinb52dcd82016-07-14 23:17:03 +00003369 for(i=0; i<len; i++){
3370 Tcl_Obj *pObj;
3371 int ttype;
3372 if( TCL_OK!=Tcl_ListObjIndex(interp, objv[3], i, &pObj) ){
3373 return TCL_ERROR;
3374 }
3375 if( Tcl_GetIndexFromObj(interp, pObj, TTYPE_strs, "trace type",
3376 0, &ttype)!=TCL_OK ){
3377 Tcl_WideInt wType;
3378 Tcl_Obj *pError = Tcl_DuplicateObj(Tcl_GetObjResult(interp));
3379 Tcl_IncrRefCount(pError);
3380 if( TCL_OK==Tcl_GetWideIntFromObj(interp, pObj, &wType) ){
3381 Tcl_DecrRefCount(pError);
3382 wMask |= wType;
3383 }else{
3384 Tcl_SetObjResult(interp, pError);
3385 Tcl_DecrRefCount(pError);
3386 return TCL_ERROR;
3387 }
3388 }else{
3389 switch( (enum TTYPE_enum)ttype ){
3390 case TTYPE_STMT: wMask |= SQLITE_TRACE_STMT; break;
3391 case TTYPE_PROFILE: wMask |= SQLITE_TRACE_PROFILE; break;
3392 case TTYPE_ROW: wMask |= SQLITE_TRACE_ROW; break;
3393 case TTYPE_CLOSE: wMask |= SQLITE_TRACE_CLOSE; break;
3394 }
3395 }
3396 }
mistachkinb56660f2016-07-14 21:26:09 +00003397 }else{
mistachkinb52dcd82016-07-14 23:17:03 +00003398 wMask = SQLITE_TRACE_STMT; /* use the "legacy" default */
mistachkinb56660f2016-07-14 21:26:09 +00003399 }
3400 if( pDb->zTraceV2 ){
3401 Tcl_Free(pDb->zTraceV2);
3402 }
3403 zTraceV2 = Tcl_GetStringFromObj(objv[2], &len);
3404 if( zTraceV2 && len>0 ){
3405 pDb->zTraceV2 = Tcl_Alloc( len + 1 );
3406 memcpy(pDb->zTraceV2, zTraceV2, len+1);
3407 }else{
3408 pDb->zTraceV2 = 0;
3409 }
3410#if !defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_OMIT_FLOATING_POINT)
3411 if( pDb->zTraceV2 ){
3412 pDb->interp = interp;
3413 sqlite3_trace_v2(pDb->db, (unsigned)wMask, DbTraceV2Handler, pDb);
3414 }else{
3415 sqlite3_trace_v2(pDb->db, 0, 0, 0);
3416 }
3417#endif
3418 }
3419 break;
3420 }
3421
drh3d214232005-08-02 12:21:08 +00003422 /* $db transaction [-deferred|-immediate|-exclusive] SCRIPT
3423 **
3424 ** Start a new transaction (if we are not already in the midst of a
3425 ** transaction) and execute the TCL script SCRIPT. After SCRIPT
3426 ** completes, either commit the transaction or roll it back if SCRIPT
3427 ** throws an exception. Or if no new transation was started, do nothing.
3428 ** pass the exception on up the stack.
3429 **
3430 ** This command was inspired by Dave Thomas's talk on Ruby at the
3431 ** 2005 O'Reilly Open Source Convention (OSCON).
3432 */
3433 case DB_TRANSACTION: {
drh3d214232005-08-02 12:21:08 +00003434 Tcl_Obj *pScript;
danielk1977cd38d522009-01-02 17:33:46 +00003435 const char *zBegin = "SAVEPOINT _tcl_transaction";
drh3d214232005-08-02 12:21:08 +00003436 if( objc!=3 && objc!=4 ){
3437 Tcl_WrongNumArgs(interp, 2, objv, "[TYPE] SCRIPT");
3438 return TCL_ERROR;
3439 }
danielk1977cd38d522009-01-02 17:33:46 +00003440
dan4a4c11a2009-10-06 14:59:02 +00003441 if( pDb->nTransaction==0 && objc==4 ){
drh3d214232005-08-02 12:21:08 +00003442 static const char *TTYPE_strs[] = {
drhce604012005-08-16 11:11:34 +00003443 "deferred", "exclusive", "immediate", 0
drh3d214232005-08-02 12:21:08 +00003444 };
3445 enum TTYPE_enum {
3446 TTYPE_DEFERRED, TTYPE_EXCLUSIVE, TTYPE_IMMEDIATE
3447 };
3448 int ttype;
drhb5555e72005-08-02 17:15:14 +00003449 if( Tcl_GetIndexFromObj(interp, objv[2], TTYPE_strs, "transaction type",
drh3d214232005-08-02 12:21:08 +00003450 0, &ttype) ){
3451 return TCL_ERROR;
3452 }
3453 switch( (enum TTYPE_enum)ttype ){
3454 case TTYPE_DEFERRED: /* no-op */; break;
3455 case TTYPE_EXCLUSIVE: zBegin = "BEGIN EXCLUSIVE"; break;
3456 case TTYPE_IMMEDIATE: zBegin = "BEGIN IMMEDIATE"; break;
3457 }
drh3d214232005-08-02 12:21:08 +00003458 }
danielk1977cd38d522009-01-02 17:33:46 +00003459 pScript = objv[objc-1];
3460
dan4a4c11a2009-10-06 14:59:02 +00003461 /* Run the SQLite BEGIN command to open a transaction or savepoint. */
danielk1977cd38d522009-01-02 17:33:46 +00003462 pDb->disableAuth++;
3463 rc = sqlite3_exec(pDb->db, zBegin, 0, 0, 0);
3464 pDb->disableAuth--;
3465 if( rc!=SQLITE_OK ){
drha198f2b2014-02-07 19:26:13 +00003466 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
danielk1977cd38d522009-01-02 17:33:46 +00003467 return TCL_ERROR;
drh3d214232005-08-02 12:21:08 +00003468 }
danielk1977cd38d522009-01-02 17:33:46 +00003469 pDb->nTransaction++;
danielk1977cd38d522009-01-02 17:33:46 +00003470
dan4a4c11a2009-10-06 14:59:02 +00003471 /* If using NRE, schedule a callback to invoke the script pScript, then
3472 ** a second callback to commit (or rollback) the transaction or savepoint
3473 ** opened above. If not using NRE, evaluate the script directly, then
mistachkinb56660f2016-07-14 21:26:09 +00003474 ** call function DbTransPostCmd() to commit (or rollback) the transaction
dan4a4c11a2009-10-06 14:59:02 +00003475 ** or savepoint. */
danbea28c72021-09-16 14:17:14 +00003476 addDatabaseRef(pDb); /* DbTransPostCmd() calls delDatabaseRef() */
dan4a4c11a2009-10-06 14:59:02 +00003477 if( DbUseNre() ){
3478 Tcl_NRAddCallback(interp, DbTransPostCmd, cd, 0, 0, 0);
drha47941f2013-12-20 18:57:44 +00003479 (void)Tcl_NREvalObj(interp, pScript, 0);
danielk1977cd38d522009-01-02 17:33:46 +00003480 }else{
dan4a4c11a2009-10-06 14:59:02 +00003481 rc = DbTransPostCmd(&cd, interp, Tcl_EvalObjEx(interp, pScript, 0));
drh3d214232005-08-02 12:21:08 +00003482 }
3483 break;
3484 }
3485
danielk197794eb6a12005-12-15 15:22:08 +00003486 /*
danielk1977404ca072009-03-16 13:19:36 +00003487 ** $db unlock_notify ?script?
3488 */
3489 case DB_UNLOCK_NOTIFY: {
3490#ifndef SQLITE_ENABLE_UNLOCK_NOTIFY
drha198f2b2014-02-07 19:26:13 +00003491 Tcl_AppendResult(interp, "unlock_notify not available in this build",
3492 (char*)0);
danielk1977404ca072009-03-16 13:19:36 +00003493 rc = TCL_ERROR;
3494#else
3495 if( objc!=2 && objc!=3 ){
3496 Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
3497 rc = TCL_ERROR;
3498 }else{
3499 void (*xNotify)(void **, int) = 0;
3500 void *pNotifyArg = 0;
3501
3502 if( pDb->pUnlockNotify ){
3503 Tcl_DecrRefCount(pDb->pUnlockNotify);
3504 pDb->pUnlockNotify = 0;
3505 }
mistachkinb56660f2016-07-14 21:26:09 +00003506
danielk1977404ca072009-03-16 13:19:36 +00003507 if( objc==3 ){
3508 xNotify = DbUnlockNotify;
3509 pNotifyArg = (void *)pDb;
3510 pDb->pUnlockNotify = objv[2];
3511 Tcl_IncrRefCount(pDb->pUnlockNotify);
3512 }
mistachkinb56660f2016-07-14 21:26:09 +00003513
danielk1977404ca072009-03-16 13:19:36 +00003514 if( sqlite3_unlock_notify(pDb->db, xNotify, pNotifyArg) ){
drha198f2b2014-02-07 19:26:13 +00003515 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
danielk1977404ca072009-03-16 13:19:36 +00003516 rc = TCL_ERROR;
3517 }
3518 }
3519#endif
3520 break;
3521 }
3522
drh304637c2011-03-18 16:47:27 +00003523 /*
3524 ** $db preupdate_hook count
3525 ** $db preupdate_hook hook ?SCRIPT?
3526 ** $db preupdate_hook new INDEX
3527 ** $db preupdate_hook old INDEX
3528 */
dan46c47d42011-03-01 18:42:07 +00003529 case DB_PREUPDATE: {
drh9b1c62d2011-03-30 21:04:43 +00003530#ifndef SQLITE_ENABLE_PREUPDATE_HOOK
dan2b519ab2016-12-06 19:33:42 +00003531 Tcl_AppendResult(interp, "preupdate_hook was omitted at compile-time",
3532 (char*)0);
drh9b1c62d2011-03-30 21:04:43 +00003533 rc = TCL_ERROR;
3534#else
dan1e7a2d42011-03-22 18:45:29 +00003535 static const char *azSub[] = {"count", "depth", "hook", "new", "old", 0};
dan46c47d42011-03-01 18:42:07 +00003536 enum DbPreupdateSubCmd {
dan1e7a2d42011-03-22 18:45:29 +00003537 PRE_COUNT, PRE_DEPTH, PRE_HOOK, PRE_NEW, PRE_OLD
dan46c47d42011-03-01 18:42:07 +00003538 };
3539 int iSub;
3540
3541 if( objc<3 ){
3542 Tcl_WrongNumArgs(interp, 2, objv, "SUB-COMMAND ?ARGS?");
3543 }
3544 if( Tcl_GetIndexFromObj(interp, objv[2], azSub, "sub-command", 0, &iSub) ){
3545 return TCL_ERROR;
3546 }
3547
3548 switch( (enum DbPreupdateSubCmd)iSub ){
3549 case PRE_COUNT: {
3550 int nCol = sqlite3_preupdate_count(pDb->db);
3551 Tcl_SetObjResult(interp, Tcl_NewIntObj(nCol));
3552 break;
3553 }
3554
3555 case PRE_HOOK: {
3556 if( objc>4 ){
3557 Tcl_WrongNumArgs(interp, 2, objv, "hook ?SCRIPT?");
3558 return TCL_ERROR;
3559 }
3560 DbHookCmd(interp, pDb, (objc==4 ? objv[3] : 0), &pDb->pPreUpdateHook);
3561 break;
3562 }
3563
dan1e7a2d42011-03-22 18:45:29 +00003564 case PRE_DEPTH: {
3565 Tcl_Obj *pRet;
3566 if( objc!=3 ){
3567 Tcl_WrongNumArgs(interp, 3, objv, "");
3568 return TCL_ERROR;
3569 }
3570 pRet = Tcl_NewIntObj(sqlite3_preupdate_depth(pDb->db));
3571 Tcl_SetObjResult(interp, pRet);
3572 break;
3573 }
3574
dan37db03b2011-03-16 19:59:18 +00003575 case PRE_NEW:
dan46c47d42011-03-01 18:42:07 +00003576 case PRE_OLD: {
3577 int iIdx;
dan37db03b2011-03-16 19:59:18 +00003578 sqlite3_value *pValue;
dan46c47d42011-03-01 18:42:07 +00003579 if( objc!=4 ){
3580 Tcl_WrongNumArgs(interp, 3, objv, "INDEX");
3581 return TCL_ERROR;
3582 }
3583 if( Tcl_GetIntFromObj(interp, objv[3], &iIdx) ){
3584 return TCL_ERROR;
3585 }
3586
dan37db03b2011-03-16 19:59:18 +00003587 if( iSub==PRE_OLD ){
dan46c47d42011-03-01 18:42:07 +00003588 rc = sqlite3_preupdate_old(pDb->db, iIdx, &pValue);
dan37db03b2011-03-16 19:59:18 +00003589 }else{
3590 assert( iSub==PRE_NEW );
3591 rc = sqlite3_preupdate_new(pDb->db, iIdx, &pValue);
dan46c47d42011-03-01 18:42:07 +00003592 }
3593
dan37db03b2011-03-16 19:59:18 +00003594 if( rc==SQLITE_OK ){
drh304637c2011-03-18 16:47:27 +00003595 Tcl_Obj *pObj;
3596 pObj = Tcl_NewStringObj((char*)sqlite3_value_text(pValue), -1);
dan37db03b2011-03-16 19:59:18 +00003597 Tcl_SetObjResult(interp, pObj);
3598 }else{
drhea8f0a12017-01-12 11:50:08 +00003599 Tcl_AppendResult(interp, sqlite3_errmsg(pDb->db), (char*)0);
dan46c47d42011-03-01 18:42:07 +00003600 return TCL_ERROR;
3601 }
3602 }
3603 }
drh9b1c62d2011-03-30 21:04:43 +00003604#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00003605 break;
3606 }
3607
danielk1977404ca072009-03-16 13:19:36 +00003608 /*
drh833bf962010-04-28 14:42:19 +00003609 ** $db wal_hook ?script?
danielk197794eb6a12005-12-15 15:22:08 +00003610 ** $db update_hook ?script?
danielk197771fd80b2005-12-16 06:54:01 +00003611 ** $db rollback_hook ?script?
danielk197794eb6a12005-12-15 15:22:08 +00003612 */
mistachkinb56660f2016-07-14 21:26:09 +00003613 case DB_WAL_HOOK:
3614 case DB_UPDATE_HOOK:
dan6566ebe2011-03-16 09:49:14 +00003615 case DB_ROLLBACK_HOOK: {
mistachkinb56660f2016-07-14 21:26:09 +00003616 /* set ppHook to point at pUpdateHook or pRollbackHook, depending on
danielk197771fd80b2005-12-16 06:54:01 +00003617 ** whether [$db update_hook] or [$db rollback_hook] was invoked.
3618 */
mistachkinb56660f2016-07-14 21:26:09 +00003619 Tcl_Obj **ppHook = 0;
dan46c47d42011-03-01 18:42:07 +00003620 if( choice==DB_WAL_HOOK ) ppHook = &pDb->pWalHook;
3621 if( choice==DB_UPDATE_HOOK ) ppHook = &pDb->pUpdateHook;
3622 if( choice==DB_ROLLBACK_HOOK ) ppHook = &pDb->pRollbackHook;
3623 if( objc>3 ){
danielk197794eb6a12005-12-15 15:22:08 +00003624 Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
3625 return TCL_ERROR;
3626 }
danielk197771fd80b2005-12-16 06:54:01 +00003627
dan46c47d42011-03-01 18:42:07 +00003628 DbHookCmd(interp, pDb, (objc==3 ? objv[2] : 0), ppHook);
danielk197794eb6a12005-12-15 15:22:08 +00003629 break;
3630 }
3631
danielk19774397de52005-01-12 12:44:03 +00003632 /* $db version
3633 **
3634 ** Return the version string for this database.
3635 */
3636 case DB_VERSION: {
drh1df64702017-10-13 15:56:26 +00003637 int i;
3638 for(i=2; i<objc; i++){
3639 const char *zArg = Tcl_GetString(objv[i]);
3640 /* Optional arguments to $db version are used for testing purpose */
3641#ifdef SQLITE_TEST
3642 /* $db version -use-legacy-prepare BOOLEAN
3643 **
3644 ** Turn the use of legacy sqlite3_prepare() on or off.
3645 */
3646 if( strcmp(zArg, "-use-legacy-prepare")==0 && i+1<objc ){
3647 i++;
3648 if( Tcl_GetBooleanFromObj(interp, objv[i], &pDb->bLegacyPrepare) ){
3649 return TCL_ERROR;
3650 }
3651 }else
3652
3653 /* $db version -last-stmt-ptr
3654 **
3655 ** Return a string which is a hex encoding of the pointer to the
3656 ** most recent sqlite3_stmt in the statement cache.
3657 */
3658 if( strcmp(zArg, "-last-stmt-ptr")==0 ){
3659 char zBuf[100];
3660 sqlite3_snprintf(sizeof(zBuf), zBuf, "%p",
3661 pDb->stmtList ? pDb->stmtList->pStmt: 0);
3662 Tcl_SetResult(interp, zBuf, TCL_VOLATILE);
3663 }else
3664#endif /* SQLITE_TEST */
3665 {
3666 Tcl_AppendResult(interp, "unknown argument: ", zArg, (char*)0);
3667 return TCL_ERROR;
3668 }
3669 }
3670 if( i==2 ){
3671 Tcl_SetResult(interp, (char *)sqlite3_libversion(), TCL_STATIC);
3672 }
danielk19774397de52005-01-12 12:44:03 +00003673 break;
3674 }
3675
tpoindex1067fe12004-12-17 15:41:11 +00003676
drh6d313162000-09-21 13:01:35 +00003677 } /* End of the SWITCH statement */
drh22fbcb82004-02-01 01:22:50 +00003678 return rc;
drh75897232000-05-29 14:26:00 +00003679}
3680
drha2c8a952009-10-13 18:38:34 +00003681#if SQLITE_TCL_NRE
3682/*
3683** Adaptor that provides an objCmd interface to the NRE-enabled
3684** interface implementation.
3685*/
mistachkina121cc72016-07-28 18:06:52 +00003686static int SQLITE_TCLAPI DbObjCmdAdaptor(
drha2c8a952009-10-13 18:38:34 +00003687 void *cd,
3688 Tcl_Interp *interp,
3689 int objc,
3690 Tcl_Obj *const*objv
3691){
3692 return Tcl_NRCallObjProc(interp, DbObjCmd, cd, objc, objv);
3693}
3694#endif /* SQLITE_TCL_NRE */
3695
drh75897232000-05-29 14:26:00 +00003696/*
drh4dcac402018-01-03 13:20:02 +00003697** Issue the usage message when the "sqlite3" command arguments are
3698** incorrect.
3699*/
3700static int sqliteCmdUsage(
3701 Tcl_Interp *interp,
3702 Tcl_Obj *const*objv
3703){
3704 Tcl_WrongNumArgs(interp, 1, objv,
3705 "HANDLE ?FILENAME? ?-vfs VFSNAME? ?-readonly BOOLEAN? ?-create BOOLEAN?"
drh0933aad2019-11-18 17:46:38 +00003706 " ?-nofollow BOOLEAN?"
drh4dcac402018-01-03 13:20:02 +00003707 " ?-nomutex BOOLEAN? ?-fullmutex BOOLEAN? ?-uri BOOLEAN?"
drh4dcac402018-01-03 13:20:02 +00003708 );
3709 return TCL_ERROR;
3710}
3711
3712/*
drh3570ad92007-08-31 14:31:44 +00003713** sqlite3 DBNAME FILENAME ?-vfs VFSNAME? ?-key KEY? ?-readonly BOOLEAN?
danielk19779a6284c2008-07-10 17:52:49 +00003714** ?-create BOOLEAN? ?-nomutex BOOLEAN?
drh0933aad2019-11-18 17:46:38 +00003715** ?-nofollow BOOLEAN?
drh75897232000-05-29 14:26:00 +00003716**
3717** This is the main Tcl command. When the "sqlite" Tcl command is
3718** invoked, this routine runs to process that command.
3719**
3720** The first argument, DBNAME, is an arbitrary name for a new
3721** database connection. This command creates a new command named
3722** DBNAME that is used to control that connection. The database
3723** connection is deleted when the DBNAME command is deleted.
3724**
drh3570ad92007-08-31 14:31:44 +00003725** The second argument is the name of the database file.
drhfbc3eab2001-04-06 16:13:42 +00003726**
drh75897232000-05-29 14:26:00 +00003727*/
mistachkin7617e4a2016-07-28 17:11:20 +00003728static int SQLITE_TCLAPI DbMain(
3729 void *cd,
3730 Tcl_Interp *interp,
3731 int objc,
3732 Tcl_Obj *const*objv
3733){
drhbec3f402000-08-04 13:49:02 +00003734 SqliteDb *p;
drh22fbcb82004-02-01 01:22:50 +00003735 const char *zArg;
drh75897232000-05-29 14:26:00 +00003736 char *zErrMsg;
drh3570ad92007-08-31 14:31:44 +00003737 int i;
drh4dcac402018-01-03 13:20:02 +00003738 const char *zFile = 0;
drh3570ad92007-08-31 14:31:44 +00003739 const char *zVfs = 0;
drhd9da78a2009-03-24 15:08:09 +00003740 int flags;
mistachkina8e41ec2020-05-15 01:18:07 +00003741 int bTranslateFileName = 1;
drh882e8e42006-08-24 02:42:27 +00003742 Tcl_DString translatedFilename;
mistachkin540ebf82012-09-10 07:29:29 +00003743 int rc;
drhd9da78a2009-03-24 15:08:09 +00003744
3745 /* In normal use, each TCL interpreter runs in a single thread. So
drh4dcac402018-01-03 13:20:02 +00003746 ** by default, we can turn off mutexing on SQLite database connections.
drhd9da78a2009-03-24 15:08:09 +00003747 ** However, for testing purposes it is useful to have mutexes turned
3748 ** on. So, by default, mutexes default off. But if compiled with
3749 ** SQLITE_TCL_DEFAULT_FULLMUTEX then mutexes default on.
3750 */
3751#ifdef SQLITE_TCL_DEFAULT_FULLMUTEX
3752 flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_FULLMUTEX;
3753#else
3754 flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_NOMUTEX;
3755#endif
3756
drhc6727c82018-09-19 15:08:21 +00003757 if( objc==1 ) return sqliteCmdUsage(interp, objv);
drh22fbcb82004-02-01 01:22:50 +00003758 if( objc==2 ){
3759 zArg = Tcl_GetStringFromObj(objv[1], 0);
drh22fbcb82004-02-01 01:22:50 +00003760 if( strcmp(zArg,"-version")==0 ){
drha198f2b2014-02-07 19:26:13 +00003761 Tcl_AppendResult(interp,sqlite3_libversion(), (char*)0);
drh647cb0e2002-11-04 19:32:25 +00003762 return TCL_OK;
3763 }
drh72bf6a32016-01-07 02:06:55 +00003764 if( strcmp(zArg,"-sourceid")==0 ){
3765 Tcl_AppendResult(interp,sqlite3_sourceid(), (char*)0);
3766 return TCL_OK;
3767 }
drh9eb9e262004-02-11 02:18:05 +00003768 if( strcmp(zArg,"-has-codec")==0 ){
drha198f2b2014-02-07 19:26:13 +00003769 Tcl_AppendResult(interp,"0",(char*)0);
drh22fbcb82004-02-01 01:22:50 +00003770 return TCL_OK;
3771 }
drh4dcac402018-01-03 13:20:02 +00003772 if( zArg[0]=='-' ) return sqliteCmdUsage(interp, objv);
drhfbc3eab2001-04-06 16:13:42 +00003773 }
drh4dcac402018-01-03 13:20:02 +00003774 for(i=2; i<objc; i++){
drh3570ad92007-08-31 14:31:44 +00003775 zArg = Tcl_GetString(objv[i]);
drh4dcac402018-01-03 13:20:02 +00003776 if( zArg[0]!='-' ){
3777 if( zFile!=0 ) return sqliteCmdUsage(interp, objv);
3778 zFile = zArg;
3779 continue;
3780 }
3781 if( i==objc-1 ) return sqliteCmdUsage(interp, objv);
3782 i++;
drh22fbcb82004-02-01 01:22:50 +00003783 if( strcmp(zArg,"-key")==0 ){
drhb48c0d52020-02-07 01:12:53 +00003784 /* no-op */
drh3570ad92007-08-31 14:31:44 +00003785 }else if( strcmp(zArg, "-vfs")==0 ){
drh4dcac402018-01-03 13:20:02 +00003786 zVfs = Tcl_GetString(objv[i]);
drh3570ad92007-08-31 14:31:44 +00003787 }else if( strcmp(zArg, "-readonly")==0 ){
3788 int b;
drh4dcac402018-01-03 13:20:02 +00003789 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh3570ad92007-08-31 14:31:44 +00003790 if( b ){
drh33f4e022007-09-03 15:19:34 +00003791 flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
drh3570ad92007-08-31 14:31:44 +00003792 flags |= SQLITE_OPEN_READONLY;
3793 }else{
3794 flags &= ~SQLITE_OPEN_READONLY;
3795 flags |= SQLITE_OPEN_READWRITE;
3796 }
3797 }else if( strcmp(zArg, "-create")==0 ){
3798 int b;
drh4dcac402018-01-03 13:20:02 +00003799 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh33f4e022007-09-03 15:19:34 +00003800 if( b && (flags & SQLITE_OPEN_READONLY)==0 ){
drh3570ad92007-08-31 14:31:44 +00003801 flags |= SQLITE_OPEN_CREATE;
3802 }else{
3803 flags &= ~SQLITE_OPEN_CREATE;
3804 }
drh0933aad2019-11-18 17:46:38 +00003805 }else if( strcmp(zArg, "-nofollow")==0 ){
3806 int b;
3807 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
3808 if( b ){
3809 flags |= SQLITE_OPEN_NOFOLLOW;
3810 }else{
3811 flags &= ~SQLITE_OPEN_NOFOLLOW;
3812 }
danielk19779a6284c2008-07-10 17:52:49 +00003813 }else if( strcmp(zArg, "-nomutex")==0 ){
3814 int b;
drh4dcac402018-01-03 13:20:02 +00003815 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
danielk19779a6284c2008-07-10 17:52:49 +00003816 if( b ){
3817 flags |= SQLITE_OPEN_NOMUTEX;
drh039963a2008-09-03 00:43:15 +00003818 flags &= ~SQLITE_OPEN_FULLMUTEX;
danielk19779a6284c2008-07-10 17:52:49 +00003819 }else{
3820 flags &= ~SQLITE_OPEN_NOMUTEX;
3821 }
danc431fd52011-06-27 16:55:50 +00003822 }else if( strcmp(zArg, "-fullmutex")==0 ){
drh039963a2008-09-03 00:43:15 +00003823 int b;
drh4dcac402018-01-03 13:20:02 +00003824 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drh039963a2008-09-03 00:43:15 +00003825 if( b ){
3826 flags |= SQLITE_OPEN_FULLMUTEX;
3827 flags &= ~SQLITE_OPEN_NOMUTEX;
3828 }else{
3829 flags &= ~SQLITE_OPEN_FULLMUTEX;
3830 }
drhf12b3f62011-12-21 14:42:29 +00003831 }else if( strcmp(zArg, "-uri")==0 ){
3832 int b;
drh4dcac402018-01-03 13:20:02 +00003833 if( Tcl_GetBooleanFromObj(interp, objv[i], &b) ) return TCL_ERROR;
drhf12b3f62011-12-21 14:42:29 +00003834 if( b ){
3835 flags |= SQLITE_OPEN_URI;
3836 }else{
3837 flags &= ~SQLITE_OPEN_URI;
3838 }
mistachkina8e41ec2020-05-15 01:18:07 +00003839 }else if( strcmp(zArg, "-translatefilename")==0 ){
3840 if( Tcl_GetBooleanFromObj(interp, objv[i], &bTranslateFileName) ){
3841 return TCL_ERROR;
3842 }
drh3570ad92007-08-31 14:31:44 +00003843 }else{
3844 Tcl_AppendResult(interp, "unknown option: ", zArg, (char*)0);
3845 return TCL_ERROR;
drh22fbcb82004-02-01 01:22:50 +00003846 }
3847 }
drh75897232000-05-29 14:26:00 +00003848 zErrMsg = 0;
drh4cdc9e82000-08-04 14:56:24 +00003849 p = (SqliteDb*)Tcl_Alloc( sizeof(*p) );
drhbec3f402000-08-04 13:49:02 +00003850 memset(p, 0, sizeof(*p));
drh3ec86652018-01-03 19:03:31 +00003851 if( zFile==0 ) zFile = "";
mistachkina8e41ec2020-05-15 01:18:07 +00003852 if( bTranslateFileName ){
3853 zFile = Tcl_TranslateFileName(interp, zFile, &translatedFilename);
3854 }
drh3ec86652018-01-03 19:03:31 +00003855 rc = sqlite3_open_v2(zFile, &p->db, flags, zVfs);
mistachkina8e41ec2020-05-15 01:18:07 +00003856 if( bTranslateFileName ){
3857 Tcl_DStringFree(&translatedFilename);
3858 }
mistachkin540ebf82012-09-10 07:29:29 +00003859 if( p->db ){
3860 if( SQLITE_OK!=sqlite3_errcode(p->db) ){
3861 zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(p->db));
3862 sqlite3_close(p->db);
3863 p->db = 0;
3864 }
3865 }else{
mistachkin5dac8432012-09-11 02:00:25 +00003866 zErrMsg = sqlite3_mprintf("%s", sqlite3_errstr(rc));
danielk197780290862004-05-22 09:21:21 +00003867 }
drhbec3f402000-08-04 13:49:02 +00003868 if( p->db==0 ){
drh75897232000-05-29 14:26:00 +00003869 Tcl_SetResult(interp, zErrMsg, TCL_VOLATILE);
drhbec3f402000-08-04 13:49:02 +00003870 Tcl_Free((char*)p);
drh9404d502006-12-19 18:46:08 +00003871 sqlite3_free(zErrMsg);
drh75897232000-05-29 14:26:00 +00003872 return TCL_ERROR;
3873 }
drhfb7e7652005-01-24 00:28:42 +00003874 p->maxStmt = NUM_PREPARED_STMTS;
drh147ef392016-01-22 23:17:51 +00003875 p->openFlags = flags & SQLITE_OPEN_URI;
drh5169bbc2006-08-24 14:59:45 +00003876 p->interp = interp;
drh22fbcb82004-02-01 01:22:50 +00003877 zArg = Tcl_GetStringFromObj(objv[1], 0);
dan4a4c11a2009-10-06 14:59:02 +00003878 if( DbUseNre() ){
drha2c8a952009-10-13 18:38:34 +00003879 Tcl_NRCreateCommand(interp, zArg, DbObjCmdAdaptor, DbObjCmd,
3880 (char*)p, DbDeleteCmd);
dan4a4c11a2009-10-06 14:59:02 +00003881 }else{
3882 Tcl_CreateObjCommand(interp, zArg, DbObjCmd, (char*)p, DbDeleteCmd);
3883 }
danbea28c72021-09-16 14:17:14 +00003884 p->nRef = 1;
drh75897232000-05-29 14:26:00 +00003885 return TCL_OK;
3886}
3887
3888/*
drh90ca9752001-09-28 17:47:14 +00003889** Provide a dummy Tcl_InitStubs if we are using this as a static
3890** library.
3891*/
3892#ifndef USE_TCL_STUBS
3893# undef Tcl_InitStubs
drh0e85ccf2013-06-03 12:34:46 +00003894# define Tcl_InitStubs(a,b,c) TCL_VERSION
drh90ca9752001-09-28 17:47:14 +00003895#endif
3896
3897/*
drh29bc4612005-10-05 10:40:15 +00003898** Make sure we have a PACKAGE_VERSION macro defined. This will be
3899** defined automatically by the TEA makefile. But other makefiles
3900** do not define it.
3901*/
3902#ifndef PACKAGE_VERSION
3903# define PACKAGE_VERSION SQLITE_VERSION
3904#endif
3905
3906/*
drh75897232000-05-29 14:26:00 +00003907** Initialize this module.
3908**
3909** This Tcl module contains only a single new Tcl command named "sqlite".
3910** (Hence there is no namespace. There is no point in using a namespace
3911** if the extension only supplies one new name!) The "sqlite" command is
3912** used to open a new SQLite database. See the DbMain() routine above
3913** for additional information.
drhb652f432010-08-26 16:46:57 +00003914**
3915** The EXTERN macros are required by TCL in order to work on windows.
drh75897232000-05-29 14:26:00 +00003916*/
drhb652f432010-08-26 16:46:57 +00003917EXTERN int Sqlite3_Init(Tcl_Interp *interp){
mistachkin27b2f052015-01-12 19:49:46 +00003918 int rc = Tcl_InitStubs(interp, "8.4", 0) ? TCL_OK : TCL_ERROR;
drh6dc8cbe2013-05-31 15:36:07 +00003919 if( rc==TCL_OK ){
3920 Tcl_CreateObjCommand(interp, "sqlite3", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh1cca0d22010-08-25 20:35:51 +00003921#ifndef SQLITE_3_SUFFIX_ONLY
drh6dc8cbe2013-05-31 15:36:07 +00003922 /* The "sqlite" alias is undocumented. It is here only to support
3923 ** legacy scripts. All new scripts should use only the "sqlite3"
3924 ** command. */
3925 Tcl_CreateObjCommand(interp, "sqlite", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh4c0f1642010-08-25 19:39:19 +00003926#endif
drh6dc8cbe2013-05-31 15:36:07 +00003927 rc = Tcl_PkgProvide(interp, "sqlite3", PACKAGE_VERSION);
3928 }
3929 return rc;
drh90ca9752001-09-28 17:47:14 +00003930}
drhb652f432010-08-26 16:46:57 +00003931EXTERN int Tclsqlite3_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
drhb652f432010-08-26 16:46:57 +00003932EXTERN int Sqlite3_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
3933EXTERN int Tclsqlite3_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
drhe2c3a652008-09-23 09:58:46 +00003934
drhd878cab2012-03-20 15:10:42 +00003935/* Because it accesses the file-system and uses persistent state, SQLite
drhe75a9eb2016-02-13 18:54:10 +00003936** is not considered appropriate for safe interpreters. Hence, we cause
3937** the _SafeInit() interfaces return TCL_ERROR.
drhd878cab2012-03-20 15:10:42 +00003938*/
drhe75a9eb2016-02-13 18:54:10 +00003939EXTERN int Sqlite3_SafeInit(Tcl_Interp *interp){ return TCL_ERROR; }
3940EXTERN int Sqlite3_SafeUnload(Tcl_Interp *interp, int flags){return TCL_ERROR;}
3941
3942
drh49766d62005-01-08 18:42:28 +00003943
3944#ifndef SQLITE_3_SUFFIX_ONLY
dana3e63c42010-08-20 12:33:59 +00003945int Sqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
3946int Tclsqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
dana3e63c42010-08-20 12:33:59 +00003947int Sqlite_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
3948int Tclsqlite_Unload(Tcl_Interp *interp, int flags){ return TCL_OK; }
drh49766d62005-01-08 18:42:28 +00003949#endif
drh75897232000-05-29 14:26:00 +00003950
drhc318f732017-10-13 15:06:06 +00003951/*
drh96a206f2017-10-13 20:14:06 +00003952** If the TCLSH macro is defined, add code to make a stand-alone program.
drhc318f732017-10-13 15:06:06 +00003953*/
drh96a206f2017-10-13 20:14:06 +00003954#if defined(TCLSH)
drh57a02272009-10-22 20:52:05 +00003955
drh96a206f2017-10-13 20:14:06 +00003956/* This is the main routine for an ordinary TCL shell. If there are
3957** are arguments, run the first argument as a script. Otherwise,
3958** read TCL commands from standard input
drh348784e2000-05-29 20:41:49 +00003959*/
dan0ae479d2011-09-21 16:43:07 +00003960static const char *tclsh_main_loop(void){
3961 static const char zMainloop[] =
drh96a206f2017-10-13 20:14:06 +00003962 "if {[llength $argv]>=1} {\n"
3963 "set argv0 [lindex $argv 0]\n"
3964 "set argv [lrange $argv 1 end]\n"
3965 "source $argv0\n"
3966 "} else {\n"
3967 "set line {}\n"
3968 "while {![eof stdin]} {\n"
3969 "if {$line!=\"\"} {\n"
3970 "puts -nonewline \"> \"\n"
3971 "} else {\n"
3972 "puts -nonewline \"% \"\n"
dan0ae479d2011-09-21 16:43:07 +00003973 "}\n"
drh96a206f2017-10-13 20:14:06 +00003974 "flush stdout\n"
3975 "append line [gets stdin]\n"
3976 "if {[info complete $line]} {\n"
3977 "if {[catch {uplevel #0 $line} result]} {\n"
3978 "puts stderr \"Error: $result\"\n"
3979 "} elseif {$result!=\"\"} {\n"
3980 "puts $result\n"
3981 "}\n"
3982 "set line {}\n"
3983 "} else {\n"
3984 "append line \\n\n"
3985 "}\n"
dan0ae479d2011-09-21 16:43:07 +00003986 "}\n"
drh348784e2000-05-29 20:41:49 +00003987 "}\n"
dan0ae479d2011-09-21 16:43:07 +00003988 ;
3989 return zMainloop;
3990}
drh3e27c022004-07-23 00:01:38 +00003991
drh5e907942021-11-18 20:56:59 +00003992#ifndef TCLSH_MAIN
3993# define TCLSH_MAIN main
3994#endif
mistachkin69def7f2016-07-28 04:14:37 +00003995int SQLITE_CDECL TCLSH_MAIN(int argc, char **argv){
danc1a60c52010-06-07 14:28:16 +00003996 Tcl_Interp *interp;
drh96a206f2017-10-13 20:14:06 +00003997 int i;
3998 const char *zScript = 0;
3999 char zArgc[32];
4000#if defined(TCLSH_INIT_PROC)
4001 extern const char *TCLSH_INIT_PROC(Tcl_Interp*);
4002#endif
mistachkin1f28e072013-08-15 08:06:15 +00004003
4004#if !defined(_WIN32_WCE)
mistachkin1e8487d2018-07-22 06:25:35 +00004005 if( getenv("SQLITE_DEBUG_BREAK") ){
4006 if( isatty(0) && isatty(2) ){
4007 fprintf(stderr,
4008 "attach debugger to process %d and press any key to continue.\n",
4009 GETPID());
4010 fgetc(stdin);
4011 }else{
4012#if defined(_WIN32) || defined(WIN32)
4013 DebugBreak();
4014#elif defined(SIGTRAP)
4015 raise(SIGTRAP);
4016#endif
4017 }
mistachkin1f28e072013-08-15 08:06:15 +00004018 }
4019#endif
4020
danc1a60c52010-06-07 14:28:16 +00004021 /* Call sqlite3_shutdown() once before doing anything else. This is to
4022 ** test that sqlite3_shutdown() can be safely called by a process before
4023 ** sqlite3_initialize() is. */
4024 sqlite3_shutdown();
4025
dan0ae479d2011-09-21 16:43:07 +00004026 Tcl_FindExecutable(argv[0]);
mistachkin2953ba92014-02-14 00:25:03 +00004027 Tcl_SetSystemEncoding(NULL, "utf-8");
dan0ae479d2011-09-21 16:43:07 +00004028 interp = Tcl_CreateInterp();
drhc318f732017-10-13 15:06:06 +00004029 Sqlite3_Init(interp);
drh96a206f2017-10-13 20:14:06 +00004030
4031 sqlite3_snprintf(sizeof(zArgc), zArgc, "%d", argc-1);
4032 Tcl_SetVar(interp,"argc", zArgc, TCL_GLOBAL_ONLY);
4033 Tcl_SetVar(interp,"argv0",argv[0],TCL_GLOBAL_ONLY);
4034 Tcl_SetVar(interp,"argv", "", TCL_GLOBAL_ONLY);
4035 for(i=1; i<argc; i++){
4036 Tcl_SetVar(interp, "argv", argv[i],
4037 TCL_GLOBAL_ONLY | TCL_LIST_ELEMENT | TCL_APPEND_VALUE);
drhc318f732017-10-13 15:06:06 +00004038 }
drh96a206f2017-10-13 20:14:06 +00004039#if defined(TCLSH_INIT_PROC)
4040 zScript = TCLSH_INIT_PROC(interp);
4041#endif
4042 if( zScript==0 ){
4043 zScript = tclsh_main_loop();
drh3e27c022004-07-23 00:01:38 +00004044 }
drh96a206f2017-10-13 20:14:06 +00004045 if( Tcl_GlobalEval(interp, zScript)!=TCL_OK ){
4046 const char *zInfo = Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY);
4047 if( zInfo==0 ) zInfo = Tcl_GetStringResult(interp);
4048 fprintf(stderr,"%s: %s\n", *argv, zInfo);
4049 return 1;
drh348784e2000-05-29 20:41:49 +00004050 }
4051 return 0;
4052}
4053#endif /* TCLSH */