xref: /sqlite-3.40.0/src/tclsqlite.c (revision dcbb5d3f)
175897234Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
375897234Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
675897234Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
1075897234Sdrh **
1175897234Sdrh *************************************************************************
12bd08af48Sdrh ** A TCL Interface to SQLite.  Append this file to sqlite3.c and
13bd08af48Sdrh ** compile the whole thing to build a TCL-enabled version of SQLite.
1475897234Sdrh **
15*dcbb5d3fSdanielk1977 ** $Id: tclsqlite.c,v 1.185 2007/05/04 18:36:45 danielk1977 Exp $
1675897234Sdrh */
17bd08af48Sdrh #include "tcl.h"
18b4e9af9fSdanielk1977 #include <errno.h>
196d31316cSdrh 
20bd08af48Sdrh /*
21bd08af48Sdrh ** Some additional include files are needed if this file is not
22bd08af48Sdrh ** appended to the amalgamation.
23bd08af48Sdrh */
24bd08af48Sdrh #ifndef SQLITE_AMALGAMATION
2506b2718aSdrh # include "sqliteInt.h"
26895d7472Sdrh # include "hash.h"
2775897234Sdrh # include <stdlib.h>
2875897234Sdrh # include <string.h>
29ce927065Sdrh # include <assert.h>
30d1e4733dSdrh # include <ctype.h>
31bd08af48Sdrh #endif
3275897234Sdrh 
33ad6e1370Sdrh /*
34ad6e1370Sdrh  * Windows needs to know which symbols to export.  Unix does not.
35ad6e1370Sdrh  * BUILD_sqlite should be undefined for Unix.
36ad6e1370Sdrh  */
37ad6e1370Sdrh #ifdef BUILD_sqlite
38ad6e1370Sdrh #undef TCL_STORAGE_CLASS
39ad6e1370Sdrh #define TCL_STORAGE_CLASS DLLEXPORT
40ad6e1370Sdrh #endif /* BUILD_sqlite */
4129bc4615Sdrh 
42a21c6b6fSdanielk1977 #define NUM_PREPARED_STMTS 10
43fb7e7651Sdrh #define MAX_PREPARED_STMTS 100
44fb7e7651Sdrh 
4575897234Sdrh /*
4698808babSdrh ** If TCL uses UTF-8 and SQLite is configured to use iso8859, then we
4798808babSdrh ** have to do a translation when going between the two.  Set the
4898808babSdrh ** UTF_TRANSLATION_NEEDED macro to indicate that we need to do
4998808babSdrh ** this translation.
5098808babSdrh */
5198808babSdrh #if defined(TCL_UTF_MAX) && !defined(SQLITE_UTF8)
5298808babSdrh # define UTF_TRANSLATION_NEEDED 1
5398808babSdrh #endif
5498808babSdrh 
5598808babSdrh /*
56cabb0819Sdrh ** New SQL functions can be created as TCL scripts.  Each such function
57cabb0819Sdrh ** is described by an instance of the following structure.
58cabb0819Sdrh */
59cabb0819Sdrh typedef struct SqlFunc SqlFunc;
60cabb0819Sdrh struct SqlFunc {
61cabb0819Sdrh   Tcl_Interp *interp;   /* The TCL interpret to execute the function */
62d1e4733dSdrh   Tcl_Obj *pScript;     /* The Tcl_Obj representation of the script */
63d1e4733dSdrh   int useEvalObjv;      /* True if it is safe to use Tcl_EvalObjv */
64d1e4733dSdrh   char *zName;          /* Name of this function */
65cabb0819Sdrh   SqlFunc *pNext;       /* Next function on the list of them all */
66cabb0819Sdrh };
67cabb0819Sdrh 
68cabb0819Sdrh /*
690202b29eSdanielk1977 ** New collation sequences function can be created as TCL scripts.  Each such
700202b29eSdanielk1977 ** function is described by an instance of the following structure.
710202b29eSdanielk1977 */
720202b29eSdanielk1977 typedef struct SqlCollate SqlCollate;
730202b29eSdanielk1977 struct SqlCollate {
740202b29eSdanielk1977   Tcl_Interp *interp;   /* The TCL interpret to execute the function */
750202b29eSdanielk1977   char *zScript;        /* The script to be run */
760202b29eSdanielk1977   SqlCollate *pNext;    /* Next function on the list of them all */
770202b29eSdanielk1977 };
780202b29eSdanielk1977 
790202b29eSdanielk1977 /*
80fb7e7651Sdrh ** Prepared statements are cached for faster execution.  Each prepared
81fb7e7651Sdrh ** statement is described by an instance of the following structure.
82fb7e7651Sdrh */
83fb7e7651Sdrh typedef struct SqlPreparedStmt SqlPreparedStmt;
84fb7e7651Sdrh struct SqlPreparedStmt {
85fb7e7651Sdrh   SqlPreparedStmt *pNext;  /* Next in linked list */
86fb7e7651Sdrh   SqlPreparedStmt *pPrev;  /* Previous on the list */
87fb7e7651Sdrh   sqlite3_stmt *pStmt;     /* The prepared statement */
88fb7e7651Sdrh   int nSql;                /* chars in zSql[] */
89fb7e7651Sdrh   char zSql[1];            /* Text of the SQL statement */
90fb7e7651Sdrh };
91fb7e7651Sdrh 
92d0441796Sdanielk1977 typedef struct IncrblobChannel IncrblobChannel;
93d0441796Sdanielk1977 
94fb7e7651Sdrh /*
95bec3f402Sdrh ** There is one instance of this structure for each SQLite database
96bec3f402Sdrh ** that has been opened by the SQLite TCL interface.
97bec3f402Sdrh */
98bec3f402Sdrh typedef struct SqliteDb SqliteDb;
99bec3f402Sdrh struct SqliteDb {
100dddca286Sdrh   sqlite3 *db;               /* The "real" database structure. MUST BE FIRST */
101bec3f402Sdrh   Tcl_Interp *interp;        /* The interpreter used for this database */
1026d31316cSdrh   char *zBusy;               /* The busy callback routine */
103aa940eacSdrh   char *zCommit;             /* The commit hook callback routine */
104b5a20d3cSdrh   char *zTrace;              /* The trace callback routine */
10519e2d37fSdrh   char *zProfile;            /* The profile callback routine */
106348bb5d6Sdanielk1977   char *zProgress;           /* The progress callback routine */
107e22a334bSdrh   char *zAuth;               /* The authorization callback routine */
10855c45f2eSdanielk1977   char *zNull;               /* Text to substitute for an SQL NULL value */
109cabb0819Sdrh   SqlFunc *pFunc;            /* List of SQL functions */
11094eb6a14Sdanielk1977   Tcl_Obj *pUpdateHook;      /* Update hook script (if any) */
11171fd80bfSdanielk1977   Tcl_Obj *pRollbackHook;    /* Rollback hook script (if any) */
1120202b29eSdanielk1977   SqlCollate *pCollate;      /* List of SQL collation functions */
1136f8a503dSdanielk1977   int rc;                    /* Return code of most recent sqlite3_exec() */
1147cedc8d4Sdanielk1977   Tcl_Obj *pCollateNeeded;   /* Collation needed script */
115fb7e7651Sdrh   SqlPreparedStmt *stmtList; /* List of prepared statements*/
116fb7e7651Sdrh   SqlPreparedStmt *stmtLast; /* Last statement in the list */
117fb7e7651Sdrh   int maxStmt;               /* The next maximum number of stmtList */
118fb7e7651Sdrh   int nStmt;                 /* Number of statements in stmtList */
119d0441796Sdanielk1977   IncrblobChannel *pIncrblob;/* Linked list of open incrblob channels */
12098808babSdrh };
121297ecf14Sdrh 
122b4e9af9fSdanielk1977 struct IncrblobChannel {
123d0441796Sdanielk1977   sqlite3_blob *pBlob;      /* sqlite3 blob handle */
124*dcbb5d3fSdanielk1977   SqliteDb *pDb;            /* Associated database connection */
125b4e9af9fSdanielk1977   int iSeek;                /* Current seek offset */
126d0441796Sdanielk1977   Tcl_Channel channel;      /* Channel identifier */
127d0441796Sdanielk1977   IncrblobChannel *pNext;   /* Linked list of all open incrblob channels */
128d0441796Sdanielk1977   IncrblobChannel *pPrev;   /* Linked list of all open incrblob channels */
129b4e9af9fSdanielk1977 };
130b4e9af9fSdanielk1977 
131b4e9af9fSdanielk1977 /*
132d0441796Sdanielk1977 ** Close all incrblob channels opened using database connection pDb.
133d0441796Sdanielk1977 ** This is called when shutting down the database connection.
134d0441796Sdanielk1977 */
135d0441796Sdanielk1977 static void closeIncrblobChannels(SqliteDb *pDb){
136d0441796Sdanielk1977   IncrblobChannel *p;
137d0441796Sdanielk1977   IncrblobChannel *pNext;
138d0441796Sdanielk1977 
139d0441796Sdanielk1977   for(p=pDb->pIncrblob; p; p=pNext){
140d0441796Sdanielk1977     pNext = p->pNext;
141d0441796Sdanielk1977 
142d0441796Sdanielk1977     /* Note: Calling unregister here call Tcl_Close on the incrblob channel,
143d0441796Sdanielk1977     ** which deletes the IncrblobChannel structure at *p. So do not
144d0441796Sdanielk1977     ** call Tcl_Free() here.
145d0441796Sdanielk1977     */
146d0441796Sdanielk1977     Tcl_UnregisterChannel(pDb->interp, p->channel);
147d0441796Sdanielk1977   }
148d0441796Sdanielk1977 }
149d0441796Sdanielk1977 
150d0441796Sdanielk1977 /*
151b4e9af9fSdanielk1977 ** Close an incremental blob channel.
152b4e9af9fSdanielk1977 */
153b4e9af9fSdanielk1977 static int incrblobClose(ClientData instanceData, Tcl_Interp *interp){
154b4e9af9fSdanielk1977   IncrblobChannel *p = (IncrblobChannel *)instanceData;
15592d4d7a9Sdanielk1977   int rc = sqlite3_blob_close(p->pBlob);
15692d4d7a9Sdanielk1977   sqlite3 *db = p->pDb->db;
157d0441796Sdanielk1977 
158d0441796Sdanielk1977   /* Remove the channel from the SqliteDb.pIncrblob list. */
159d0441796Sdanielk1977   if( p->pNext ){
160d0441796Sdanielk1977     p->pNext->pPrev = p->pPrev;
161d0441796Sdanielk1977   }
162d0441796Sdanielk1977   if( p->pPrev ){
163d0441796Sdanielk1977     p->pPrev->pNext = p->pNext;
164d0441796Sdanielk1977   }
165d0441796Sdanielk1977   if( p->pDb->pIncrblob==p ){
166d0441796Sdanielk1977     p->pDb->pIncrblob = p->pNext;
167d0441796Sdanielk1977   }
168d0441796Sdanielk1977 
16992d4d7a9Sdanielk1977   /* Free the IncrblobChannel structure */
170b4e9af9fSdanielk1977   Tcl_Free((char *)p);
17192d4d7a9Sdanielk1977 
17292d4d7a9Sdanielk1977   if( rc!=SQLITE_OK ){
17392d4d7a9Sdanielk1977     Tcl_SetResult(interp, (char *)sqlite3_errmsg(db), TCL_VOLATILE);
17492d4d7a9Sdanielk1977     return TCL_ERROR;
17592d4d7a9Sdanielk1977   }
176b4e9af9fSdanielk1977   return TCL_OK;
177b4e9af9fSdanielk1977 }
178b4e9af9fSdanielk1977 
179b4e9af9fSdanielk1977 /*
180b4e9af9fSdanielk1977 ** Read data from an incremental blob channel.
181b4e9af9fSdanielk1977 */
182b4e9af9fSdanielk1977 static int incrblobInput(
183b4e9af9fSdanielk1977   ClientData instanceData,
184b4e9af9fSdanielk1977   char *buf,
185b4e9af9fSdanielk1977   int bufSize,
186b4e9af9fSdanielk1977   int *errorCodePtr
187b4e9af9fSdanielk1977 ){
188b4e9af9fSdanielk1977   IncrblobChannel *p = (IncrblobChannel *)instanceData;
189b4e9af9fSdanielk1977   int nRead = bufSize;         /* Number of bytes to read */
190b4e9af9fSdanielk1977   int nBlob;                   /* Total size of the blob */
191b4e9af9fSdanielk1977   int rc;                      /* sqlite error code */
192b4e9af9fSdanielk1977 
193b4e9af9fSdanielk1977   nBlob = sqlite3_blob_bytes(p->pBlob);
194b4e9af9fSdanielk1977   if( (p->iSeek+nRead)>nBlob ){
195b4e9af9fSdanielk1977     nRead = nBlob-p->iSeek;
196b4e9af9fSdanielk1977   }
197b4e9af9fSdanielk1977   if( nRead<=0 ){
198b4e9af9fSdanielk1977     return 0;
199b4e9af9fSdanielk1977   }
200b4e9af9fSdanielk1977 
201b4e9af9fSdanielk1977   rc = sqlite3_blob_read(p->pBlob, (void *)buf, nRead, p->iSeek);
202b4e9af9fSdanielk1977   if( rc!=SQLITE_OK ){
203b4e9af9fSdanielk1977     *errorCodePtr = rc;
204b4e9af9fSdanielk1977     return -1;
205b4e9af9fSdanielk1977   }
206b4e9af9fSdanielk1977 
207b4e9af9fSdanielk1977   p->iSeek += nRead;
208b4e9af9fSdanielk1977   return nRead;
209b4e9af9fSdanielk1977 }
210b4e9af9fSdanielk1977 
211d0441796Sdanielk1977 /*
212d0441796Sdanielk1977 ** Write data to an incremental blob channel.
213d0441796Sdanielk1977 */
214b4e9af9fSdanielk1977 static int incrblobOutput(
215b4e9af9fSdanielk1977   ClientData instanceData,
216b4e9af9fSdanielk1977   CONST char *buf,
217b4e9af9fSdanielk1977   int toWrite,
218b4e9af9fSdanielk1977   int *errorCodePtr
219b4e9af9fSdanielk1977 ){
220b4e9af9fSdanielk1977   IncrblobChannel *p = (IncrblobChannel *)instanceData;
221b4e9af9fSdanielk1977   int nWrite = toWrite;        /* Number of bytes to write */
222b4e9af9fSdanielk1977   int nBlob;                   /* Total size of the blob */
223b4e9af9fSdanielk1977   int rc;                      /* sqlite error code */
224b4e9af9fSdanielk1977 
225b4e9af9fSdanielk1977   nBlob = sqlite3_blob_bytes(p->pBlob);
226b4e9af9fSdanielk1977   if( (p->iSeek+nWrite)>nBlob ){
227b4e9af9fSdanielk1977     *errorCodePtr = EINVAL;
228b4e9af9fSdanielk1977     return -1;
229b4e9af9fSdanielk1977   }
230b4e9af9fSdanielk1977   if( nWrite<=0 ){
231b4e9af9fSdanielk1977     return 0;
232b4e9af9fSdanielk1977   }
233b4e9af9fSdanielk1977 
234b4e9af9fSdanielk1977   rc = sqlite3_blob_write(p->pBlob, (void *)buf, nWrite, p->iSeek);
235b4e9af9fSdanielk1977   if( rc!=SQLITE_OK ){
236b4e9af9fSdanielk1977     *errorCodePtr = EIO;
237b4e9af9fSdanielk1977     return -1;
238b4e9af9fSdanielk1977   }
239b4e9af9fSdanielk1977 
240b4e9af9fSdanielk1977   p->iSeek += nWrite;
241b4e9af9fSdanielk1977   return nWrite;
242b4e9af9fSdanielk1977 }
243b4e9af9fSdanielk1977 
244b4e9af9fSdanielk1977 /*
245b4e9af9fSdanielk1977 ** Seek an incremental blob channel.
246b4e9af9fSdanielk1977 */
247b4e9af9fSdanielk1977 static int incrblobSeek(
248b4e9af9fSdanielk1977   ClientData instanceData,
249b4e9af9fSdanielk1977   long offset,
250b4e9af9fSdanielk1977   int seekMode,
251b4e9af9fSdanielk1977   int *errorCodePtr
252b4e9af9fSdanielk1977 ){
253b4e9af9fSdanielk1977   IncrblobChannel *p = (IncrblobChannel *)instanceData;
254b4e9af9fSdanielk1977 
255b4e9af9fSdanielk1977   switch( seekMode ){
256b4e9af9fSdanielk1977     case SEEK_SET:
257b4e9af9fSdanielk1977       p->iSeek = offset;
258b4e9af9fSdanielk1977       break;
259b4e9af9fSdanielk1977     case SEEK_CUR:
260b4e9af9fSdanielk1977       p->iSeek += offset;
261b4e9af9fSdanielk1977       break;
262b4e9af9fSdanielk1977     case SEEK_END:
263b4e9af9fSdanielk1977       p->iSeek = sqlite3_blob_bytes(p->pBlob) + offset;
264b4e9af9fSdanielk1977       break;
265b4e9af9fSdanielk1977 
266b4e9af9fSdanielk1977     default: assert(!"Bad seekMode");
267b4e9af9fSdanielk1977   }
268b4e9af9fSdanielk1977 
269b4e9af9fSdanielk1977   return p->iSeek;
270b4e9af9fSdanielk1977 }
271b4e9af9fSdanielk1977 
272b4e9af9fSdanielk1977 
273b4e9af9fSdanielk1977 static void incrblobWatch(ClientData instanceData, int mode){
274b4e9af9fSdanielk1977   /* NO-OP */
275b4e9af9fSdanielk1977 }
276b4e9af9fSdanielk1977 static int incrblobHandle(ClientData instanceData, int dir, ClientData *hPtr){
277b4e9af9fSdanielk1977   return TCL_ERROR;
278b4e9af9fSdanielk1977 }
279b4e9af9fSdanielk1977 
280b4e9af9fSdanielk1977 static Tcl_ChannelType IncrblobChannelType = {
281b4e9af9fSdanielk1977   "incrblob",                        /* typeName                             */
282b4e9af9fSdanielk1977   TCL_CHANNEL_VERSION_2,             /* version                              */
283b4e9af9fSdanielk1977   incrblobClose,                     /* closeProc                            */
284b4e9af9fSdanielk1977   incrblobInput,                     /* inputProc                            */
285b4e9af9fSdanielk1977   incrblobOutput,                    /* outputProc                           */
286b4e9af9fSdanielk1977   incrblobSeek,                      /* seekProc                             */
287b4e9af9fSdanielk1977   0,                                 /* setOptionProc                        */
288b4e9af9fSdanielk1977   0,                                 /* getOptionProc                        */
289b4e9af9fSdanielk1977   incrblobWatch,                     /* watchProc (this is a no-op)          */
290b4e9af9fSdanielk1977   incrblobHandle,                    /* getHandleProc (always returns error) */
291b4e9af9fSdanielk1977   0,                                 /* close2Proc                           */
292b4e9af9fSdanielk1977   0,                                 /* blockModeProc                        */
293b4e9af9fSdanielk1977   0,                                 /* flushProc                            */
294b4e9af9fSdanielk1977   0,                                 /* handlerProc                          */
295b4e9af9fSdanielk1977   0,                                 /* wideSeekProc                         */
296b4e9af9fSdanielk1977   0,                                 /* threadActionProc                     */
297b4e9af9fSdanielk1977 };
298b4e9af9fSdanielk1977 
299b4e9af9fSdanielk1977 /*
300b4e9af9fSdanielk1977 ** Create a new incrblob channel.
301b4e9af9fSdanielk1977 */
302b4e9af9fSdanielk1977 static int createIncrblobChannel(
303b4e9af9fSdanielk1977   Tcl_Interp *interp,
304b4e9af9fSdanielk1977   SqliteDb *pDb,
305b4e9af9fSdanielk1977   const char *zDb,
306b4e9af9fSdanielk1977   const char *zTable,
307b4e9af9fSdanielk1977   const char *zColumn,
3088cbadb02Sdanielk1977   sqlite_int64 iRow,
3098cbadb02Sdanielk1977   int isReadonly
310b4e9af9fSdanielk1977 ){
311b4e9af9fSdanielk1977   IncrblobChannel *p;
3128cbadb02Sdanielk1977   sqlite3 *db = pDb->db;
313b4e9af9fSdanielk1977   sqlite3_blob *pBlob;
314b4e9af9fSdanielk1977   int rc;
3158cbadb02Sdanielk1977   int flags = TCL_READABLE|(isReadonly ? 0 : TCL_WRITABLE);
316b4e9af9fSdanielk1977 
317b4e9af9fSdanielk1977   /* This variable is used to name the channels: "incrblob_[incr count]" */
318b4e9af9fSdanielk1977   static int count = 0;
319b4e9af9fSdanielk1977   char zChannel[64];
320b4e9af9fSdanielk1977 
3218cbadb02Sdanielk1977   rc = sqlite3_blob_open(db, zDb, zTable, zColumn, iRow, !isReadonly, &pBlob);
322b4e9af9fSdanielk1977   if( rc!=SQLITE_OK ){
323b4e9af9fSdanielk1977     Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
324b4e9af9fSdanielk1977     return TCL_ERROR;
325b4e9af9fSdanielk1977   }
326b4e9af9fSdanielk1977 
327b4e9af9fSdanielk1977   p = (IncrblobChannel *)Tcl_Alloc(sizeof(IncrblobChannel));
328b4e9af9fSdanielk1977   p->iSeek = 0;
329b4e9af9fSdanielk1977   p->pBlob = pBlob;
330b4e9af9fSdanielk1977 
3315bb3eb9bSdrh   sqlite3_snprintf(sizeof(zChannel), zChannel, "incrblob_%d", ++count);
332d0441796Sdanielk1977   p->channel = Tcl_CreateChannel(&IncrblobChannelType, zChannel, p, flags);
333d0441796Sdanielk1977   Tcl_RegisterChannel(interp, p->channel);
334b4e9af9fSdanielk1977 
335d0441796Sdanielk1977   /* Link the new channel into the SqliteDb.pIncrblob list. */
336d0441796Sdanielk1977   p->pNext = pDb->pIncrblob;
337d0441796Sdanielk1977   p->pPrev = 0;
338d0441796Sdanielk1977   if( p->pNext ){
339d0441796Sdanielk1977     p->pNext->pPrev = p;
340d0441796Sdanielk1977   }
341d0441796Sdanielk1977   pDb->pIncrblob = p;
342d0441796Sdanielk1977   p->pDb = pDb;
343d0441796Sdanielk1977 
344d0441796Sdanielk1977   Tcl_SetResult(interp, (char *)Tcl_GetChannelName(p->channel), TCL_VOLATILE);
345b4e9af9fSdanielk1977   return TCL_OK;
346b4e9af9fSdanielk1977 }
347b4e9af9fSdanielk1977 
3486d31316cSdrh /*
349d1e4733dSdrh ** Look at the script prefix in pCmd.  We will be executing this script
350d1e4733dSdrh ** after first appending one or more arguments.  This routine analyzes
351d1e4733dSdrh ** the script to see if it is safe to use Tcl_EvalObjv() on the script
352d1e4733dSdrh ** rather than the more general Tcl_EvalEx().  Tcl_EvalObjv() is much
353d1e4733dSdrh ** faster.
354d1e4733dSdrh **
355d1e4733dSdrh ** Scripts that are safe to use with Tcl_EvalObjv() consists of a
356d1e4733dSdrh ** command name followed by zero or more arguments with no [...] or $
357d1e4733dSdrh ** or {...} or ; to be seen anywhere.  Most callback scripts consist
358d1e4733dSdrh ** of just a single procedure name and they meet this requirement.
359d1e4733dSdrh */
360d1e4733dSdrh static int safeToUseEvalObjv(Tcl_Interp *interp, Tcl_Obj *pCmd){
361d1e4733dSdrh   /* We could try to do something with Tcl_Parse().  But we will instead
362d1e4733dSdrh   ** just do a search for forbidden characters.  If any of the forbidden
363d1e4733dSdrh   ** characters appear in pCmd, we will report the string as unsafe.
364d1e4733dSdrh   */
365d1e4733dSdrh   const char *z;
366d1e4733dSdrh   int n;
367d1e4733dSdrh   z = Tcl_GetStringFromObj(pCmd, &n);
368d1e4733dSdrh   while( n-- > 0 ){
369d1e4733dSdrh     int c = *(z++);
370d1e4733dSdrh     if( c=='$' || c=='[' || c==';' ) return 0;
371d1e4733dSdrh   }
372d1e4733dSdrh   return 1;
373d1e4733dSdrh }
374d1e4733dSdrh 
375d1e4733dSdrh /*
376d1e4733dSdrh ** Find an SqlFunc structure with the given name.  Or create a new
377d1e4733dSdrh ** one if an existing one cannot be found.  Return a pointer to the
378d1e4733dSdrh ** structure.
379d1e4733dSdrh */
380d1e4733dSdrh static SqlFunc *findSqlFunc(SqliteDb *pDb, const char *zName){
381d1e4733dSdrh   SqlFunc *p, *pNew;
382d1e4733dSdrh   int i;
383d1e4733dSdrh   pNew = (SqlFunc*)Tcl_Alloc( sizeof(*pNew) + strlen(zName) + 1 );
384d1e4733dSdrh   pNew->zName = (char*)&pNew[1];
385d1e4733dSdrh   for(i=0; zName[i]; i++){ pNew->zName[i] = tolower(zName[i]); }
386d1e4733dSdrh   pNew->zName[i] = 0;
387d1e4733dSdrh   for(p=pDb->pFunc; p; p=p->pNext){
388d1e4733dSdrh     if( strcmp(p->zName, pNew->zName)==0 ){
389d1e4733dSdrh       Tcl_Free((char*)pNew);
390d1e4733dSdrh       return p;
391d1e4733dSdrh     }
392d1e4733dSdrh   }
393d1e4733dSdrh   pNew->interp = pDb->interp;
394d1e4733dSdrh   pNew->pScript = 0;
395d1e4733dSdrh   pNew->pNext = pDb->pFunc;
396d1e4733dSdrh   pDb->pFunc = pNew;
397d1e4733dSdrh   return pNew;
398d1e4733dSdrh }
399d1e4733dSdrh 
400d1e4733dSdrh /*
401fb7e7651Sdrh ** Finalize and free a list of prepared statements
402fb7e7651Sdrh */
403fb7e7651Sdrh static void flushStmtCache( SqliteDb *pDb ){
404fb7e7651Sdrh   SqlPreparedStmt *pPreStmt;
405fb7e7651Sdrh 
406fb7e7651Sdrh   while(  pDb->stmtList ){
407fb7e7651Sdrh     sqlite3_finalize( pDb->stmtList->pStmt );
408fb7e7651Sdrh     pPreStmt = pDb->stmtList;
409fb7e7651Sdrh     pDb->stmtList = pDb->stmtList->pNext;
410fb7e7651Sdrh     Tcl_Free( (char*)pPreStmt );
411fb7e7651Sdrh   }
412fb7e7651Sdrh   pDb->nStmt = 0;
413fb7e7651Sdrh   pDb->stmtLast = 0;
414fb7e7651Sdrh }
415fb7e7651Sdrh 
416fb7e7651Sdrh /*
417895d7472Sdrh ** TCL calls this procedure when an sqlite3 database command is
418895d7472Sdrh ** deleted.
41975897234Sdrh */
42075897234Sdrh static void DbDeleteCmd(void *db){
421bec3f402Sdrh   SqliteDb *pDb = (SqliteDb*)db;
422fb7e7651Sdrh   flushStmtCache(pDb);
423d0441796Sdanielk1977   closeIncrblobChannels(pDb);
4246f8a503dSdanielk1977   sqlite3_close(pDb->db);
425cabb0819Sdrh   while( pDb->pFunc ){
426cabb0819Sdrh     SqlFunc *pFunc = pDb->pFunc;
427cabb0819Sdrh     pDb->pFunc = pFunc->pNext;
428d1e4733dSdrh     Tcl_DecrRefCount(pFunc->pScript);
429cabb0819Sdrh     Tcl_Free((char*)pFunc);
430cabb0819Sdrh   }
4310202b29eSdanielk1977   while( pDb->pCollate ){
4320202b29eSdanielk1977     SqlCollate *pCollate = pDb->pCollate;
4330202b29eSdanielk1977     pDb->pCollate = pCollate->pNext;
4340202b29eSdanielk1977     Tcl_Free((char*)pCollate);
4350202b29eSdanielk1977   }
436bec3f402Sdrh   if( pDb->zBusy ){
437bec3f402Sdrh     Tcl_Free(pDb->zBusy);
438bec3f402Sdrh   }
439b5a20d3cSdrh   if( pDb->zTrace ){
440b5a20d3cSdrh     Tcl_Free(pDb->zTrace);
4410d1a643aSdrh   }
44219e2d37fSdrh   if( pDb->zProfile ){
44319e2d37fSdrh     Tcl_Free(pDb->zProfile);
44419e2d37fSdrh   }
445e22a334bSdrh   if( pDb->zAuth ){
446e22a334bSdrh     Tcl_Free(pDb->zAuth);
447e22a334bSdrh   }
44855c45f2eSdanielk1977   if( pDb->zNull ){
44955c45f2eSdanielk1977     Tcl_Free(pDb->zNull);
45055c45f2eSdanielk1977   }
45194eb6a14Sdanielk1977   if( pDb->pUpdateHook ){
45294eb6a14Sdanielk1977     Tcl_DecrRefCount(pDb->pUpdateHook);
45394eb6a14Sdanielk1977   }
45471fd80bfSdanielk1977   if( pDb->pRollbackHook ){
45571fd80bfSdanielk1977     Tcl_DecrRefCount(pDb->pRollbackHook);
45671fd80bfSdanielk1977   }
45794eb6a14Sdanielk1977   if( pDb->pCollateNeeded ){
45894eb6a14Sdanielk1977     Tcl_DecrRefCount(pDb->pCollateNeeded);
45994eb6a14Sdanielk1977   }
460bec3f402Sdrh   Tcl_Free((char*)pDb);
461bec3f402Sdrh }
462bec3f402Sdrh 
463bec3f402Sdrh /*
464bec3f402Sdrh ** This routine is called when a database file is locked while trying
465bec3f402Sdrh ** to execute SQL.
466bec3f402Sdrh */
4672a764eb0Sdanielk1977 static int DbBusyHandler(void *cd, int nTries){
468bec3f402Sdrh   SqliteDb *pDb = (SqliteDb*)cd;
469bec3f402Sdrh   int rc;
470bec3f402Sdrh   char zVal[30];
471bec3f402Sdrh 
4725bb3eb9bSdrh   sqlite3_snprintf(sizeof(zVal), zVal, "%d", nTries);
473d1e4733dSdrh   rc = Tcl_VarEval(pDb->interp, pDb->zBusy, " ", zVal, (char*)0);
474bec3f402Sdrh   if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
475bec3f402Sdrh     return 0;
476bec3f402Sdrh   }
477bec3f402Sdrh   return 1;
47875897234Sdrh }
47975897234Sdrh 
48075897234Sdrh /*
481348bb5d6Sdanielk1977 ** This routine is invoked as the 'progress callback' for the database.
482348bb5d6Sdanielk1977 */
483348bb5d6Sdanielk1977 static int DbProgressHandler(void *cd){
484348bb5d6Sdanielk1977   SqliteDb *pDb = (SqliteDb*)cd;
485348bb5d6Sdanielk1977   int rc;
486348bb5d6Sdanielk1977 
487348bb5d6Sdanielk1977   assert( pDb->zProgress );
488348bb5d6Sdanielk1977   rc = Tcl_Eval(pDb->interp, pDb->zProgress);
489348bb5d6Sdanielk1977   if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
490348bb5d6Sdanielk1977     return 1;
491348bb5d6Sdanielk1977   }
492348bb5d6Sdanielk1977   return 0;
493348bb5d6Sdanielk1977 }
494348bb5d6Sdanielk1977 
495d1167393Sdrh #ifndef SQLITE_OMIT_TRACE
496348bb5d6Sdanielk1977 /*
497b5a20d3cSdrh ** This routine is called by the SQLite trace handler whenever a new
498b5a20d3cSdrh ** block of SQL is executed.  The TCL script in pDb->zTrace is executed.
4990d1a643aSdrh */
500b5a20d3cSdrh static void DbTraceHandler(void *cd, const char *zSql){
5010d1a643aSdrh   SqliteDb *pDb = (SqliteDb*)cd;
502b5a20d3cSdrh   Tcl_DString str;
5030d1a643aSdrh 
504b5a20d3cSdrh   Tcl_DStringInit(&str);
505b5a20d3cSdrh   Tcl_DStringAppend(&str, pDb->zTrace, -1);
506b5a20d3cSdrh   Tcl_DStringAppendElement(&str, zSql);
507b5a20d3cSdrh   Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
508b5a20d3cSdrh   Tcl_DStringFree(&str);
509b5a20d3cSdrh   Tcl_ResetResult(pDb->interp);
5100d1a643aSdrh }
511d1167393Sdrh #endif
5120d1a643aSdrh 
513d1167393Sdrh #ifndef SQLITE_OMIT_TRACE
5140d1a643aSdrh /*
51519e2d37fSdrh ** This routine is called by the SQLite profile handler after a statement
51619e2d37fSdrh ** SQL has executed.  The TCL script in pDb->zProfile is evaluated.
51719e2d37fSdrh */
51819e2d37fSdrh static void DbProfileHandler(void *cd, const char *zSql, sqlite_uint64 tm){
51919e2d37fSdrh   SqliteDb *pDb = (SqliteDb*)cd;
52019e2d37fSdrh   Tcl_DString str;
52119e2d37fSdrh   char zTm[100];
52219e2d37fSdrh 
52319e2d37fSdrh   sqlite3_snprintf(sizeof(zTm)-1, zTm, "%lld", tm);
52419e2d37fSdrh   Tcl_DStringInit(&str);
52519e2d37fSdrh   Tcl_DStringAppend(&str, pDb->zProfile, -1);
52619e2d37fSdrh   Tcl_DStringAppendElement(&str, zSql);
52719e2d37fSdrh   Tcl_DStringAppendElement(&str, zTm);
52819e2d37fSdrh   Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
52919e2d37fSdrh   Tcl_DStringFree(&str);
53019e2d37fSdrh   Tcl_ResetResult(pDb->interp);
53119e2d37fSdrh }
532d1167393Sdrh #endif
53319e2d37fSdrh 
53419e2d37fSdrh /*
535aa940eacSdrh ** This routine is called when a transaction is committed.  The
536aa940eacSdrh ** TCL script in pDb->zCommit is executed.  If it returns non-zero or
537aa940eacSdrh ** if it throws an exception, the transaction is rolled back instead
538aa940eacSdrh ** of being committed.
539aa940eacSdrh */
540aa940eacSdrh static int DbCommitHandler(void *cd){
541aa940eacSdrh   SqliteDb *pDb = (SqliteDb*)cd;
542aa940eacSdrh   int rc;
543aa940eacSdrh 
544aa940eacSdrh   rc = Tcl_Eval(pDb->interp, pDb->zCommit);
545aa940eacSdrh   if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
546aa940eacSdrh     return 1;
547aa940eacSdrh   }
548aa940eacSdrh   return 0;
549aa940eacSdrh }
550aa940eacSdrh 
55171fd80bfSdanielk1977 static void DbRollbackHandler(void *clientData){
55271fd80bfSdanielk1977   SqliteDb *pDb = (SqliteDb*)clientData;
55371fd80bfSdanielk1977   assert(pDb->pRollbackHook);
55471fd80bfSdanielk1977   if( TCL_OK!=Tcl_EvalObjEx(pDb->interp, pDb->pRollbackHook, 0) ){
55571fd80bfSdanielk1977     Tcl_BackgroundError(pDb->interp);
55671fd80bfSdanielk1977   }
55771fd80bfSdanielk1977 }
55871fd80bfSdanielk1977 
55994eb6a14Sdanielk1977 static void DbUpdateHandler(
56094eb6a14Sdanielk1977   void *p,
56194eb6a14Sdanielk1977   int op,
56294eb6a14Sdanielk1977   const char *zDb,
56394eb6a14Sdanielk1977   const char *zTbl,
56494eb6a14Sdanielk1977   sqlite_int64 rowid
56594eb6a14Sdanielk1977 ){
56694eb6a14Sdanielk1977   SqliteDb *pDb = (SqliteDb *)p;
56794eb6a14Sdanielk1977   Tcl_Obj *pCmd;
56894eb6a14Sdanielk1977 
56994eb6a14Sdanielk1977   assert( pDb->pUpdateHook );
57094eb6a14Sdanielk1977   assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
57194eb6a14Sdanielk1977 
57294eb6a14Sdanielk1977   pCmd = Tcl_DuplicateObj(pDb->pUpdateHook);
57394eb6a14Sdanielk1977   Tcl_IncrRefCount(pCmd);
57494eb6a14Sdanielk1977   Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(
57594eb6a14Sdanielk1977     ( (op==SQLITE_INSERT)?"INSERT":(op==SQLITE_UPDATE)?"UPDATE":"DELETE"), -1));
57694eb6a14Sdanielk1977   Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
57794eb6a14Sdanielk1977   Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
57894eb6a14Sdanielk1977   Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(rowid));
57994eb6a14Sdanielk1977   Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
58094eb6a14Sdanielk1977 }
58194eb6a14Sdanielk1977 
5827cedc8d4Sdanielk1977 static void tclCollateNeeded(
5837cedc8d4Sdanielk1977   void *pCtx,
5849bb575fdSdrh   sqlite3 *db,
5857cedc8d4Sdanielk1977   int enc,
5867cedc8d4Sdanielk1977   const char *zName
5877cedc8d4Sdanielk1977 ){
5887cedc8d4Sdanielk1977   SqliteDb *pDb = (SqliteDb *)pCtx;
5897cedc8d4Sdanielk1977   Tcl_Obj *pScript = Tcl_DuplicateObj(pDb->pCollateNeeded);
5907cedc8d4Sdanielk1977   Tcl_IncrRefCount(pScript);
5917cedc8d4Sdanielk1977   Tcl_ListObjAppendElement(0, pScript, Tcl_NewStringObj(zName, -1));
5927cedc8d4Sdanielk1977   Tcl_EvalObjEx(pDb->interp, pScript, 0);
5937cedc8d4Sdanielk1977   Tcl_DecrRefCount(pScript);
5947cedc8d4Sdanielk1977 }
5957cedc8d4Sdanielk1977 
596aa940eacSdrh /*
5970202b29eSdanielk1977 ** This routine is called to evaluate an SQL collation function implemented
5980202b29eSdanielk1977 ** using TCL script.
5990202b29eSdanielk1977 */
6000202b29eSdanielk1977 static int tclSqlCollate(
6010202b29eSdanielk1977   void *pCtx,
6020202b29eSdanielk1977   int nA,
6030202b29eSdanielk1977   const void *zA,
6040202b29eSdanielk1977   int nB,
6050202b29eSdanielk1977   const void *zB
6060202b29eSdanielk1977 ){
6070202b29eSdanielk1977   SqlCollate *p = (SqlCollate *)pCtx;
6080202b29eSdanielk1977   Tcl_Obj *pCmd;
6090202b29eSdanielk1977 
6100202b29eSdanielk1977   pCmd = Tcl_NewStringObj(p->zScript, -1);
6110202b29eSdanielk1977   Tcl_IncrRefCount(pCmd);
6120202b29eSdanielk1977   Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zA, nA));
6130202b29eSdanielk1977   Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zB, nB));
614d1e4733dSdrh   Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
6150202b29eSdanielk1977   Tcl_DecrRefCount(pCmd);
6160202b29eSdanielk1977   return (atoi(Tcl_GetStringResult(p->interp)));
6170202b29eSdanielk1977 }
6180202b29eSdanielk1977 
6190202b29eSdanielk1977 /*
620cabb0819Sdrh ** This routine is called to evaluate an SQL function implemented
621cabb0819Sdrh ** using TCL script.
622cabb0819Sdrh */
6230ae8b831Sdanielk1977 static void tclSqlFunc(sqlite3_context *context, int argc, sqlite3_value**argv){
6246f8a503dSdanielk1977   SqlFunc *p = sqlite3_user_data(context);
625d1e4733dSdrh   Tcl_Obj *pCmd;
626cabb0819Sdrh   int i;
627cabb0819Sdrh   int rc;
628cabb0819Sdrh 
629d1e4733dSdrh   if( argc==0 ){
630d1e4733dSdrh     /* If there are no arguments to the function, call Tcl_EvalObjEx on the
631d1e4733dSdrh     ** script object directly.  This allows the TCL compiler to generate
632d1e4733dSdrh     ** bytecode for the command on the first invocation and thus make
633d1e4733dSdrh     ** subsequent invocations much faster. */
634d1e4733dSdrh     pCmd = p->pScript;
635d1e4733dSdrh     Tcl_IncrRefCount(pCmd);
636d1e4733dSdrh     rc = Tcl_EvalObjEx(p->interp, pCmd, 0);
637d1e4733dSdrh     Tcl_DecrRefCount(pCmd);
63851ad0ecdSdanielk1977   }else{
639d1e4733dSdrh     /* If there are arguments to the function, make a shallow copy of the
640d1e4733dSdrh     ** script object, lappend the arguments, then evaluate the copy.
641d1e4733dSdrh     **
642d1e4733dSdrh     ** By "shallow" copy, we mean a only the outer list Tcl_Obj is duplicated.
643d1e4733dSdrh     ** The new Tcl_Obj contains pointers to the original list elements.
644d1e4733dSdrh     ** That way, when Tcl_EvalObjv() is run and shimmers the first element
645d1e4733dSdrh     ** of the list to tclCmdNameType, that alternate representation will
646d1e4733dSdrh     ** be preserved and reused on the next invocation.
647d1e4733dSdrh     */
648d1e4733dSdrh     Tcl_Obj **aArg;
649d1e4733dSdrh     int nArg;
650d1e4733dSdrh     if( Tcl_ListObjGetElements(p->interp, p->pScript, &nArg, &aArg) ){
651d1e4733dSdrh       sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
652d1e4733dSdrh       return;
653d1e4733dSdrh     }
654d1e4733dSdrh     pCmd = Tcl_NewListObj(nArg, aArg);
655d1e4733dSdrh     Tcl_IncrRefCount(pCmd);
656d1e4733dSdrh     for(i=0; i<argc; i++){
657d1e4733dSdrh       sqlite3_value *pIn = argv[i];
658d1e4733dSdrh       Tcl_Obj *pVal;
659d1e4733dSdrh 
660d1e4733dSdrh       /* Set pVal to contain the i'th column of this row. */
661d1e4733dSdrh       switch( sqlite3_value_type(pIn) ){
662d1e4733dSdrh         case SQLITE_BLOB: {
663d1e4733dSdrh           int bytes = sqlite3_value_bytes(pIn);
664d1e4733dSdrh           pVal = Tcl_NewByteArrayObj(sqlite3_value_blob(pIn), bytes);
665d1e4733dSdrh           break;
666d1e4733dSdrh         }
667d1e4733dSdrh         case SQLITE_INTEGER: {
668d1e4733dSdrh           sqlite_int64 v = sqlite3_value_int64(pIn);
669d1e4733dSdrh           if( v>=-2147483647 && v<=2147483647 ){
670d1e4733dSdrh             pVal = Tcl_NewIntObj(v);
671d1e4733dSdrh           }else{
672d1e4733dSdrh             pVal = Tcl_NewWideIntObj(v);
673d1e4733dSdrh           }
674d1e4733dSdrh           break;
675d1e4733dSdrh         }
676d1e4733dSdrh         case SQLITE_FLOAT: {
677d1e4733dSdrh           double r = sqlite3_value_double(pIn);
678d1e4733dSdrh           pVal = Tcl_NewDoubleObj(r);
679d1e4733dSdrh           break;
680d1e4733dSdrh         }
681d1e4733dSdrh         case SQLITE_NULL: {
682d1e4733dSdrh           pVal = Tcl_NewStringObj("", 0);
683d1e4733dSdrh           break;
684d1e4733dSdrh         }
685d1e4733dSdrh         default: {
686d1e4733dSdrh           int bytes = sqlite3_value_bytes(pIn);
68700fd957bSdanielk1977           pVal = Tcl_NewStringObj((char *)sqlite3_value_text(pIn), bytes);
688d1e4733dSdrh           break;
68951ad0ecdSdanielk1977         }
690cabb0819Sdrh       }
691d1e4733dSdrh       rc = Tcl_ListObjAppendElement(p->interp, pCmd, pVal);
692d1e4733dSdrh       if( rc ){
693d1e4733dSdrh         Tcl_DecrRefCount(pCmd);
694d1e4733dSdrh         sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
695d1e4733dSdrh         return;
696d1e4733dSdrh       }
697d1e4733dSdrh     }
698d1e4733dSdrh     if( !p->useEvalObjv ){
699d1e4733dSdrh       /* Tcl_EvalObjEx() will automatically call Tcl_EvalObjv() if pCmd
700d1e4733dSdrh       ** is a list without a string representation.  To prevent this from
701d1e4733dSdrh       ** happening, make sure pCmd has a valid string representation */
702d1e4733dSdrh       Tcl_GetString(pCmd);
703d1e4733dSdrh     }
704d1e4733dSdrh     rc = Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
705d1e4733dSdrh     Tcl_DecrRefCount(pCmd);
706d1e4733dSdrh   }
707562e8d3cSdanielk1977 
708c7f269d5Sdrh   if( rc && rc!=TCL_RETURN ){
7097e18c259Sdanielk1977     sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
710cabb0819Sdrh   }else{
711c7f269d5Sdrh     Tcl_Obj *pVar = Tcl_GetObjResult(p->interp);
712c7f269d5Sdrh     int n;
713c7f269d5Sdrh     u8 *data;
714c7f269d5Sdrh     char *zType = pVar->typePtr ? pVar->typePtr->name : "";
715c7f269d5Sdrh     char c = zType[0];
716df0bddaeSdrh     if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
717d1e4733dSdrh       /* Only return a BLOB type if the Tcl variable is a bytearray and
718df0bddaeSdrh       ** has no string representation. */
719c7f269d5Sdrh       data = Tcl_GetByteArrayFromObj(pVar, &n);
720c7f269d5Sdrh       sqlite3_result_blob(context, data, n, SQLITE_TRANSIENT);
721c7f269d5Sdrh     }else if( (c=='b' && strcmp(zType,"boolean")==0) ||
722c7f269d5Sdrh           (c=='i' && strcmp(zType,"int")==0) ){
723c7f269d5Sdrh       Tcl_GetIntFromObj(0, pVar, &n);
724c7f269d5Sdrh       sqlite3_result_int(context, n);
725c7f269d5Sdrh     }else if( c=='d' && strcmp(zType,"double")==0 ){
726c7f269d5Sdrh       double r;
727c7f269d5Sdrh       Tcl_GetDoubleFromObj(0, pVar, &r);
728c7f269d5Sdrh       sqlite3_result_double(context, r);
729df0bddaeSdrh     }else if( c=='w' && strcmp(zType,"wideInt")==0 ){
730df0bddaeSdrh       Tcl_WideInt v;
731df0bddaeSdrh       Tcl_GetWideIntFromObj(0, pVar, &v);
732df0bddaeSdrh       sqlite3_result_int64(context, v);
733c7f269d5Sdrh     }else{
73400fd957bSdanielk1977       data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
73500fd957bSdanielk1977       sqlite3_result_text(context, (char *)data, n, SQLITE_TRANSIENT);
736c7f269d5Sdrh     }
737cabb0819Sdrh   }
738cabb0819Sdrh }
739895d7472Sdrh 
740e22a334bSdrh #ifndef SQLITE_OMIT_AUTHORIZATION
741e22a334bSdrh /*
742e22a334bSdrh ** This is the authentication function.  It appends the authentication
743e22a334bSdrh ** type code and the two arguments to zCmd[] then invokes the result
744e22a334bSdrh ** on the interpreter.  The reply is examined to determine if the
745e22a334bSdrh ** authentication fails or succeeds.
746e22a334bSdrh */
747e22a334bSdrh static int auth_callback(
748e22a334bSdrh   void *pArg,
749e22a334bSdrh   int code,
750e22a334bSdrh   const char *zArg1,
751e22a334bSdrh   const char *zArg2,
752e22a334bSdrh   const char *zArg3,
753e22a334bSdrh   const char *zArg4
754e22a334bSdrh ){
755e22a334bSdrh   char *zCode;
756e22a334bSdrh   Tcl_DString str;
757e22a334bSdrh   int rc;
758e22a334bSdrh   const char *zReply;
759e22a334bSdrh   SqliteDb *pDb = (SqliteDb*)pArg;
760e22a334bSdrh 
761e22a334bSdrh   switch( code ){
762e22a334bSdrh     case SQLITE_COPY              : zCode="SQLITE_COPY"; break;
763e22a334bSdrh     case SQLITE_CREATE_INDEX      : zCode="SQLITE_CREATE_INDEX"; break;
764e22a334bSdrh     case SQLITE_CREATE_TABLE      : zCode="SQLITE_CREATE_TABLE"; break;
765e22a334bSdrh     case SQLITE_CREATE_TEMP_INDEX : zCode="SQLITE_CREATE_TEMP_INDEX"; break;
766e22a334bSdrh     case SQLITE_CREATE_TEMP_TABLE : zCode="SQLITE_CREATE_TEMP_TABLE"; break;
767e22a334bSdrh     case SQLITE_CREATE_TEMP_TRIGGER: zCode="SQLITE_CREATE_TEMP_TRIGGER"; break;
768e22a334bSdrh     case SQLITE_CREATE_TEMP_VIEW  : zCode="SQLITE_CREATE_TEMP_VIEW"; break;
769e22a334bSdrh     case SQLITE_CREATE_TRIGGER    : zCode="SQLITE_CREATE_TRIGGER"; break;
770e22a334bSdrh     case SQLITE_CREATE_VIEW       : zCode="SQLITE_CREATE_VIEW"; break;
771e22a334bSdrh     case SQLITE_DELETE            : zCode="SQLITE_DELETE"; break;
772e22a334bSdrh     case SQLITE_DROP_INDEX        : zCode="SQLITE_DROP_INDEX"; break;
773e22a334bSdrh     case SQLITE_DROP_TABLE        : zCode="SQLITE_DROP_TABLE"; break;
774e22a334bSdrh     case SQLITE_DROP_TEMP_INDEX   : zCode="SQLITE_DROP_TEMP_INDEX"; break;
775e22a334bSdrh     case SQLITE_DROP_TEMP_TABLE   : zCode="SQLITE_DROP_TEMP_TABLE"; break;
776e22a334bSdrh     case SQLITE_DROP_TEMP_TRIGGER : zCode="SQLITE_DROP_TEMP_TRIGGER"; break;
777e22a334bSdrh     case SQLITE_DROP_TEMP_VIEW    : zCode="SQLITE_DROP_TEMP_VIEW"; break;
778e22a334bSdrh     case SQLITE_DROP_TRIGGER      : zCode="SQLITE_DROP_TRIGGER"; break;
779e22a334bSdrh     case SQLITE_DROP_VIEW         : zCode="SQLITE_DROP_VIEW"; break;
780e22a334bSdrh     case SQLITE_INSERT            : zCode="SQLITE_INSERT"; break;
781e22a334bSdrh     case SQLITE_PRAGMA            : zCode="SQLITE_PRAGMA"; break;
782e22a334bSdrh     case SQLITE_READ              : zCode="SQLITE_READ"; break;
783e22a334bSdrh     case SQLITE_SELECT            : zCode="SQLITE_SELECT"; break;
784e22a334bSdrh     case SQLITE_TRANSACTION       : zCode="SQLITE_TRANSACTION"; break;
785e22a334bSdrh     case SQLITE_UPDATE            : zCode="SQLITE_UPDATE"; break;
78681e293b4Sdrh     case SQLITE_ATTACH            : zCode="SQLITE_ATTACH"; break;
78781e293b4Sdrh     case SQLITE_DETACH            : zCode="SQLITE_DETACH"; break;
7881c8c23ccSdanielk1977     case SQLITE_ALTER_TABLE       : zCode="SQLITE_ALTER_TABLE"; break;
7891d54df88Sdanielk1977     case SQLITE_REINDEX           : zCode="SQLITE_REINDEX"; break;
790e6e04969Sdrh     case SQLITE_ANALYZE           : zCode="SQLITE_ANALYZE"; break;
791f1a381e7Sdanielk1977     case SQLITE_CREATE_VTABLE     : zCode="SQLITE_CREATE_VTABLE"; break;
792f1a381e7Sdanielk1977     case SQLITE_DROP_VTABLE       : zCode="SQLITE_DROP_VTABLE"; break;
7935169bbc6Sdrh     case SQLITE_FUNCTION          : zCode="SQLITE_FUNCTION"; break;
794e22a334bSdrh     default                       : zCode="????"; break;
795e22a334bSdrh   }
796e22a334bSdrh   Tcl_DStringInit(&str);
797e22a334bSdrh   Tcl_DStringAppend(&str, pDb->zAuth, -1);
798e22a334bSdrh   Tcl_DStringAppendElement(&str, zCode);
799e22a334bSdrh   Tcl_DStringAppendElement(&str, zArg1 ? zArg1 : "");
800e22a334bSdrh   Tcl_DStringAppendElement(&str, zArg2 ? zArg2 : "");
801e22a334bSdrh   Tcl_DStringAppendElement(&str, zArg3 ? zArg3 : "");
802e22a334bSdrh   Tcl_DStringAppendElement(&str, zArg4 ? zArg4 : "");
803e22a334bSdrh   rc = Tcl_GlobalEval(pDb->interp, Tcl_DStringValue(&str));
804e22a334bSdrh   Tcl_DStringFree(&str);
805e22a334bSdrh   zReply = Tcl_GetStringResult(pDb->interp);
806e22a334bSdrh   if( strcmp(zReply,"SQLITE_OK")==0 ){
807e22a334bSdrh     rc = SQLITE_OK;
808e22a334bSdrh   }else if( strcmp(zReply,"SQLITE_DENY")==0 ){
809e22a334bSdrh     rc = SQLITE_DENY;
810e22a334bSdrh   }else if( strcmp(zReply,"SQLITE_IGNORE")==0 ){
811e22a334bSdrh     rc = SQLITE_IGNORE;
812e22a334bSdrh   }else{
813e22a334bSdrh     rc = 999;
814e22a334bSdrh   }
815e22a334bSdrh   return rc;
816e22a334bSdrh }
817e22a334bSdrh #endif /* SQLITE_OMIT_AUTHORIZATION */
818cabb0819Sdrh 
819cabb0819Sdrh /*
820ef2cb63eSdanielk1977 ** zText is a pointer to text obtained via an sqlite3_result_text()
821ef2cb63eSdanielk1977 ** or similar interface. This routine returns a Tcl string object,
822ef2cb63eSdanielk1977 ** reference count set to 0, containing the text. If a translation
823ef2cb63eSdanielk1977 ** between iso8859 and UTF-8 is required, it is preformed.
824ef2cb63eSdanielk1977 */
825ef2cb63eSdanielk1977 static Tcl_Obj *dbTextToObj(char const *zText){
826ef2cb63eSdanielk1977   Tcl_Obj *pVal;
827ef2cb63eSdanielk1977 #ifdef UTF_TRANSLATION_NEEDED
828ef2cb63eSdanielk1977   Tcl_DString dCol;
829ef2cb63eSdanielk1977   Tcl_DStringInit(&dCol);
830ef2cb63eSdanielk1977   Tcl_ExternalToUtfDString(NULL, zText, -1, &dCol);
831ef2cb63eSdanielk1977   pVal = Tcl_NewStringObj(Tcl_DStringValue(&dCol), -1);
832ef2cb63eSdanielk1977   Tcl_DStringFree(&dCol);
833ef2cb63eSdanielk1977 #else
834ef2cb63eSdanielk1977   pVal = Tcl_NewStringObj(zText, -1);
835ef2cb63eSdanielk1977 #endif
836ef2cb63eSdanielk1977   return pVal;
837ef2cb63eSdanielk1977 }
838ef2cb63eSdanielk1977 
839ef2cb63eSdanielk1977 /*
8401067fe11Stpoindex ** This routine reads a line of text from FILE in, stores
8411067fe11Stpoindex ** the text in memory obtained from malloc() and returns a pointer
8421067fe11Stpoindex ** to the text.  NULL is returned at end of file, or if malloc()
8431067fe11Stpoindex ** fails.
8441067fe11Stpoindex **
8451067fe11Stpoindex ** The interface is like "readline" but no command-line editing
8461067fe11Stpoindex ** is done.
8471067fe11Stpoindex **
8481067fe11Stpoindex ** copied from shell.c from '.import' command
8491067fe11Stpoindex */
8501067fe11Stpoindex static char *local_getline(char *zPrompt, FILE *in){
8511067fe11Stpoindex   char *zLine;
8521067fe11Stpoindex   int nLine;
8531067fe11Stpoindex   int n;
8541067fe11Stpoindex   int eol;
8551067fe11Stpoindex 
8561067fe11Stpoindex   nLine = 100;
8571067fe11Stpoindex   zLine = malloc( nLine );
8581067fe11Stpoindex   if( zLine==0 ) return 0;
8591067fe11Stpoindex   n = 0;
8601067fe11Stpoindex   eol = 0;
8611067fe11Stpoindex   while( !eol ){
8621067fe11Stpoindex     if( n+100>nLine ){
8631067fe11Stpoindex       nLine = nLine*2 + 100;
8641067fe11Stpoindex       zLine = realloc(zLine, nLine);
8651067fe11Stpoindex       if( zLine==0 ) return 0;
8661067fe11Stpoindex     }
8671067fe11Stpoindex     if( fgets(&zLine[n], nLine - n, in)==0 ){
8681067fe11Stpoindex       if( n==0 ){
8691067fe11Stpoindex         free(zLine);
8701067fe11Stpoindex         return 0;
8711067fe11Stpoindex       }
8721067fe11Stpoindex       zLine[n] = 0;
8731067fe11Stpoindex       eol = 1;
8741067fe11Stpoindex       break;
8751067fe11Stpoindex     }
8761067fe11Stpoindex     while( zLine[n] ){ n++; }
8771067fe11Stpoindex     if( n>0 && zLine[n-1]=='\n' ){
8781067fe11Stpoindex       n--;
8791067fe11Stpoindex       zLine[n] = 0;
8801067fe11Stpoindex       eol = 1;
8811067fe11Stpoindex     }
8821067fe11Stpoindex   }
8831067fe11Stpoindex   zLine = realloc( zLine, n+1 );
8841067fe11Stpoindex   return zLine;
8851067fe11Stpoindex }
8861067fe11Stpoindex 
8871067fe11Stpoindex /*
88875897234Sdrh ** The "sqlite" command below creates a new Tcl command for each
88975897234Sdrh ** connection it opens to an SQLite database.  This routine is invoked
89075897234Sdrh ** whenever one of those connection-specific commands is executed
89175897234Sdrh ** in Tcl.  For example, if you run Tcl code like this:
89275897234Sdrh **
8939bb575fdSdrh **       sqlite3 db1  "my_database"
89475897234Sdrh **       db1 close
89575897234Sdrh **
89675897234Sdrh ** The first command opens a connection to the "my_database" database
89775897234Sdrh ** and calls that connection "db1".  The second command causes this
89875897234Sdrh ** subroutine to be invoked.
89975897234Sdrh */
9006d31316cSdrh static int DbObjCmd(void *cd, Tcl_Interp *interp, int objc,Tcl_Obj *const*objv){
901bec3f402Sdrh   SqliteDb *pDb = (SqliteDb*)cd;
9026d31316cSdrh   int choice;
90322fbcb8dSdrh   int rc = TCL_OK;
9040de8c112Sdrh   static const char *DB_strs[] = {
905fb7e7651Sdrh     "authorizer",         "busy",              "cache",
906fb7e7651Sdrh     "changes",            "close",             "collate",
907fb7e7651Sdrh     "collation_needed",   "commit_hook",       "complete",
9084144905bSdrh     "copy",               "enable_load_extension","errorcode",
9094144905bSdrh     "eval",               "exists",            "function",
910b4e9af9fSdanielk1977     "incrblob",
911f11bded5Sdrh     "interrupt",          "last_insert_rowid", "nullvalue",
912f11bded5Sdrh     "onecolumn",          "profile",           "progress",
913f11bded5Sdrh     "rekey",              "rollback_hook",     "timeout",
914f11bded5Sdrh     "total_changes",      "trace",             "transaction",
915f11bded5Sdrh     "update_hook",        "version",           0
9166d31316cSdrh   };
917411995dcSdrh   enum DB_enum {
918fb7e7651Sdrh     DB_AUTHORIZER,        DB_BUSY,             DB_CACHE,
919fb7e7651Sdrh     DB_CHANGES,           DB_CLOSE,            DB_COLLATE,
920fb7e7651Sdrh     DB_COLLATION_NEEDED,  DB_COMMIT_HOOK,      DB_COMPLETE,
9214144905bSdrh     DB_COPY,              DB_ENABLE_LOAD_EXTENSION,DB_ERRORCODE,
9224144905bSdrh     DB_EVAL,              DB_EXISTS,           DB_FUNCTION,
923b4e9af9fSdanielk1977     DB_INCRBLOB,
924f11bded5Sdrh     DB_INTERRUPT,         DB_LAST_INSERT_ROWID,DB_NULLVALUE,
925f11bded5Sdrh     DB_ONECOLUMN,         DB_PROFILE,          DB_PROGRESS,
926f11bded5Sdrh     DB_REKEY,             DB_ROLLBACK_HOOK,    DB_TIMEOUT,
927f11bded5Sdrh     DB_TOTAL_CHANGES,     DB_TRACE,            DB_TRANSACTION,
928f11bded5Sdrh     DB_UPDATE_HOOK,       DB_VERSION,
9296d31316cSdrh   };
9301067fe11Stpoindex   /* don't leave trailing commas on DB_enum, it confuses the AIX xlc compiler */
9316d31316cSdrh 
9326d31316cSdrh   if( objc<2 ){
9336d31316cSdrh     Tcl_WrongNumArgs(interp, 1, objv, "SUBCOMMAND ...");
93475897234Sdrh     return TCL_ERROR;
93575897234Sdrh   }
936411995dcSdrh   if( Tcl_GetIndexFromObj(interp, objv[1], DB_strs, "option", 0, &choice) ){
9376d31316cSdrh     return TCL_ERROR;
9386d31316cSdrh   }
9396d31316cSdrh 
940411995dcSdrh   switch( (enum DB_enum)choice ){
94175897234Sdrh 
942e22a334bSdrh   /*    $db authorizer ?CALLBACK?
943e22a334bSdrh   **
944e22a334bSdrh   ** Invoke the given callback to authorize each SQL operation as it is
945e22a334bSdrh   ** compiled.  5 arguments are appended to the callback before it is
946e22a334bSdrh   ** invoked:
947e22a334bSdrh   **
948e22a334bSdrh   **   (1) The authorization type (ex: SQLITE_CREATE_TABLE, SQLITE_INSERT, ...)
949e22a334bSdrh   **   (2) First descriptive name (depends on authorization type)
950e22a334bSdrh   **   (3) Second descriptive name
951e22a334bSdrh   **   (4) Name of the database (ex: "main", "temp")
952e22a334bSdrh   **   (5) Name of trigger that is doing the access
953e22a334bSdrh   **
954e22a334bSdrh   ** The callback should return on of the following strings: SQLITE_OK,
955e22a334bSdrh   ** SQLITE_IGNORE, or SQLITE_DENY.  Any other return value is an error.
956e22a334bSdrh   **
957e22a334bSdrh   ** If this method is invoked with no arguments, the current authorization
958e22a334bSdrh   ** callback string is returned.
959e22a334bSdrh   */
960e22a334bSdrh   case DB_AUTHORIZER: {
9611211de37Sdrh #ifdef SQLITE_OMIT_AUTHORIZATION
9621211de37Sdrh     Tcl_AppendResult(interp, "authorization not available in this build", 0);
9631211de37Sdrh     return TCL_ERROR;
9641211de37Sdrh #else
965e22a334bSdrh     if( objc>3 ){
966e22a334bSdrh       Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
9670f14e2ebSdrh       return TCL_ERROR;
968e22a334bSdrh     }else if( objc==2 ){
969b5a20d3cSdrh       if( pDb->zAuth ){
970e22a334bSdrh         Tcl_AppendResult(interp, pDb->zAuth, 0);
971e22a334bSdrh       }
972e22a334bSdrh     }else{
973e22a334bSdrh       char *zAuth;
974e22a334bSdrh       int len;
975e22a334bSdrh       if( pDb->zAuth ){
976e22a334bSdrh         Tcl_Free(pDb->zAuth);
977e22a334bSdrh       }
978e22a334bSdrh       zAuth = Tcl_GetStringFromObj(objv[2], &len);
979e22a334bSdrh       if( zAuth && len>0 ){
980e22a334bSdrh         pDb->zAuth = Tcl_Alloc( len + 1 );
9815bb3eb9bSdrh         memcpy(pDb->zAuth, zAuth, len+1);
982e22a334bSdrh       }else{
983e22a334bSdrh         pDb->zAuth = 0;
984e22a334bSdrh       }
985e22a334bSdrh       if( pDb->zAuth ){
986e22a334bSdrh         pDb->interp = interp;
9876f8a503dSdanielk1977         sqlite3_set_authorizer(pDb->db, auth_callback, pDb);
988e22a334bSdrh       }else{
9896f8a503dSdanielk1977         sqlite3_set_authorizer(pDb->db, 0, 0);
990e22a334bSdrh       }
991e22a334bSdrh     }
9921211de37Sdrh #endif
993e22a334bSdrh     break;
994e22a334bSdrh   }
995e22a334bSdrh 
996bec3f402Sdrh   /*    $db busy ?CALLBACK?
997bec3f402Sdrh   **
998bec3f402Sdrh   ** Invoke the given callback if an SQL statement attempts to open
999bec3f402Sdrh   ** a locked database file.
1000bec3f402Sdrh   */
10016d31316cSdrh   case DB_BUSY: {
10026d31316cSdrh     if( objc>3 ){
10036d31316cSdrh       Tcl_WrongNumArgs(interp, 2, objv, "CALLBACK");
1004bec3f402Sdrh       return TCL_ERROR;
10056d31316cSdrh     }else if( objc==2 ){
1006bec3f402Sdrh       if( pDb->zBusy ){
1007bec3f402Sdrh         Tcl_AppendResult(interp, pDb->zBusy, 0);
1008bec3f402Sdrh       }
1009bec3f402Sdrh     }else{
10106d31316cSdrh       char *zBusy;
10116d31316cSdrh       int len;
1012bec3f402Sdrh       if( pDb->zBusy ){
1013bec3f402Sdrh         Tcl_Free(pDb->zBusy);
10146d31316cSdrh       }
10156d31316cSdrh       zBusy = Tcl_GetStringFromObj(objv[2], &len);
10166d31316cSdrh       if( zBusy && len>0 ){
10176d31316cSdrh         pDb->zBusy = Tcl_Alloc( len + 1 );
10185bb3eb9bSdrh         memcpy(pDb->zBusy, zBusy, len+1);
10196d31316cSdrh       }else{
1020bec3f402Sdrh         pDb->zBusy = 0;
1021bec3f402Sdrh       }
1022bec3f402Sdrh       if( pDb->zBusy ){
1023bec3f402Sdrh         pDb->interp = interp;
10246f8a503dSdanielk1977         sqlite3_busy_handler(pDb->db, DbBusyHandler, pDb);
10256d31316cSdrh       }else{
10266f8a503dSdanielk1977         sqlite3_busy_handler(pDb->db, 0, 0);
1027bec3f402Sdrh       }
1028bec3f402Sdrh     }
10296d31316cSdrh     break;
10306d31316cSdrh   }
1031bec3f402Sdrh 
1032fb7e7651Sdrh   /*     $db cache flush
1033fb7e7651Sdrh   **     $db cache size n
1034fb7e7651Sdrh   **
1035fb7e7651Sdrh   ** Flush the prepared statement cache, or set the maximum number of
1036fb7e7651Sdrh   ** cached statements.
1037fb7e7651Sdrh   */
1038fb7e7651Sdrh   case DB_CACHE: {
1039fb7e7651Sdrh     char *subCmd;
1040fb7e7651Sdrh     int n;
1041fb7e7651Sdrh 
1042fb7e7651Sdrh     if( objc<=2 ){
1043fb7e7651Sdrh       Tcl_WrongNumArgs(interp, 1, objv, "cache option ?arg?");
1044fb7e7651Sdrh       return TCL_ERROR;
1045fb7e7651Sdrh     }
1046fb7e7651Sdrh     subCmd = Tcl_GetStringFromObj( objv[2], 0 );
1047fb7e7651Sdrh     if( *subCmd=='f' && strcmp(subCmd,"flush")==0 ){
1048fb7e7651Sdrh       if( objc!=3 ){
1049fb7e7651Sdrh         Tcl_WrongNumArgs(interp, 2, objv, "flush");
1050fb7e7651Sdrh         return TCL_ERROR;
1051fb7e7651Sdrh       }else{
1052fb7e7651Sdrh         flushStmtCache( pDb );
1053fb7e7651Sdrh       }
1054fb7e7651Sdrh     }else if( *subCmd=='s' && strcmp(subCmd,"size")==0 ){
1055fb7e7651Sdrh       if( objc!=4 ){
1056fb7e7651Sdrh         Tcl_WrongNumArgs(interp, 2, objv, "size n");
1057fb7e7651Sdrh         return TCL_ERROR;
1058fb7e7651Sdrh       }else{
1059fb7e7651Sdrh         if( TCL_ERROR==Tcl_GetIntFromObj(interp, objv[3], &n) ){
1060fb7e7651Sdrh           Tcl_AppendResult( interp, "cannot convert \"",
1061fb7e7651Sdrh                Tcl_GetStringFromObj(objv[3],0), "\" to integer", 0);
1062fb7e7651Sdrh           return TCL_ERROR;
1063fb7e7651Sdrh         }else{
1064fb7e7651Sdrh           if( n<0 ){
1065fb7e7651Sdrh             flushStmtCache( pDb );
1066fb7e7651Sdrh             n = 0;
1067fb7e7651Sdrh           }else if( n>MAX_PREPARED_STMTS ){
1068fb7e7651Sdrh             n = MAX_PREPARED_STMTS;
1069fb7e7651Sdrh           }
1070fb7e7651Sdrh           pDb->maxStmt = n;
1071fb7e7651Sdrh         }
1072fb7e7651Sdrh       }
1073fb7e7651Sdrh     }else{
1074fb7e7651Sdrh       Tcl_AppendResult( interp, "bad option \"",
1075fb7e7651Sdrh           Tcl_GetStringFromObj(objv[0],0), "\": must be flush or size", 0);
1076fb7e7651Sdrh       return TCL_ERROR;
1077fb7e7651Sdrh     }
1078fb7e7651Sdrh     break;
1079fb7e7651Sdrh   }
1080fb7e7651Sdrh 
1081b28af71aSdanielk1977   /*     $db changes
1082c8d30ac1Sdrh   **
1083c8d30ac1Sdrh   ** Return the number of rows that were modified, inserted, or deleted by
1084b28af71aSdanielk1977   ** the most recent INSERT, UPDATE or DELETE statement, not including
1085b28af71aSdanielk1977   ** any changes made by trigger programs.
1086c8d30ac1Sdrh   */
1087c8d30ac1Sdrh   case DB_CHANGES: {
1088c8d30ac1Sdrh     Tcl_Obj *pResult;
1089c8d30ac1Sdrh     if( objc!=2 ){
1090c8d30ac1Sdrh       Tcl_WrongNumArgs(interp, 2, objv, "");
1091c8d30ac1Sdrh       return TCL_ERROR;
1092c8d30ac1Sdrh     }
1093c8d30ac1Sdrh     pResult = Tcl_GetObjResult(interp);
1094b28af71aSdanielk1977     Tcl_SetIntObj(pResult, sqlite3_changes(pDb->db));
1095f146a776Srdc     break;
1096f146a776Srdc   }
1097f146a776Srdc 
109875897234Sdrh   /*    $db close
109975897234Sdrh   **
110075897234Sdrh   ** Shutdown the database
110175897234Sdrh   */
11026d31316cSdrh   case DB_CLOSE: {
11036d31316cSdrh     Tcl_DeleteCommand(interp, Tcl_GetStringFromObj(objv[0], 0));
11046d31316cSdrh     break;
11056d31316cSdrh   }
110675897234Sdrh 
11070f14e2ebSdrh   /*
11080f14e2ebSdrh   **     $db collate NAME SCRIPT
11090f14e2ebSdrh   **
11100f14e2ebSdrh   ** Create a new SQL collation function called NAME.  Whenever
11110f14e2ebSdrh   ** that function is called, invoke SCRIPT to evaluate the function.
11120f14e2ebSdrh   */
11130f14e2ebSdrh   case DB_COLLATE: {
11140f14e2ebSdrh     SqlCollate *pCollate;
11150f14e2ebSdrh     char *zName;
11160f14e2ebSdrh     char *zScript;
11170f14e2ebSdrh     int nScript;
11180f14e2ebSdrh     if( objc!=4 ){
11190f14e2ebSdrh       Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
11200f14e2ebSdrh       return TCL_ERROR;
11210f14e2ebSdrh     }
11220f14e2ebSdrh     zName = Tcl_GetStringFromObj(objv[2], 0);
11230f14e2ebSdrh     zScript = Tcl_GetStringFromObj(objv[3], &nScript);
11240f14e2ebSdrh     pCollate = (SqlCollate*)Tcl_Alloc( sizeof(*pCollate) + nScript + 1 );
11250f14e2ebSdrh     if( pCollate==0 ) return TCL_ERROR;
11260f14e2ebSdrh     pCollate->interp = interp;
11270f14e2ebSdrh     pCollate->pNext = pDb->pCollate;
11280f14e2ebSdrh     pCollate->zScript = (char*)&pCollate[1];
11290f14e2ebSdrh     pDb->pCollate = pCollate;
11305bb3eb9bSdrh     memcpy(pCollate->zScript, zScript, nScript+1);
11310f14e2ebSdrh     if( sqlite3_create_collation(pDb->db, zName, SQLITE_UTF8,
11320f14e2ebSdrh         pCollate, tclSqlCollate) ){
11339636c4e1Sdanielk1977       Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
11340f14e2ebSdrh       return TCL_ERROR;
11350f14e2ebSdrh     }
11360f14e2ebSdrh     break;
11370f14e2ebSdrh   }
11380f14e2ebSdrh 
11390f14e2ebSdrh   /*
11400f14e2ebSdrh   **     $db collation_needed SCRIPT
11410f14e2ebSdrh   **
11420f14e2ebSdrh   ** Create a new SQL collation function called NAME.  Whenever
11430f14e2ebSdrh   ** that function is called, invoke SCRIPT to evaluate the function.
11440f14e2ebSdrh   */
11450f14e2ebSdrh   case DB_COLLATION_NEEDED: {
11460f14e2ebSdrh     if( objc!=3 ){
11470f14e2ebSdrh       Tcl_WrongNumArgs(interp, 2, objv, "SCRIPT");
11480f14e2ebSdrh       return TCL_ERROR;
11490f14e2ebSdrh     }
11500f14e2ebSdrh     if( pDb->pCollateNeeded ){
11510f14e2ebSdrh       Tcl_DecrRefCount(pDb->pCollateNeeded);
11520f14e2ebSdrh     }
11530f14e2ebSdrh     pDb->pCollateNeeded = Tcl_DuplicateObj(objv[2]);
11540f14e2ebSdrh     Tcl_IncrRefCount(pDb->pCollateNeeded);
11550f14e2ebSdrh     sqlite3_collation_needed(pDb->db, pDb, tclCollateNeeded);
11560f14e2ebSdrh     break;
11570f14e2ebSdrh   }
11580f14e2ebSdrh 
115919e2d37fSdrh   /*    $db commit_hook ?CALLBACK?
116019e2d37fSdrh   **
116119e2d37fSdrh   ** Invoke the given callback just before committing every SQL transaction.
116219e2d37fSdrh   ** If the callback throws an exception or returns non-zero, then the
116319e2d37fSdrh   ** transaction is aborted.  If CALLBACK is an empty string, the callback
116419e2d37fSdrh   ** is disabled.
116519e2d37fSdrh   */
116619e2d37fSdrh   case DB_COMMIT_HOOK: {
116719e2d37fSdrh     if( objc>3 ){
116819e2d37fSdrh       Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
116919e2d37fSdrh       return TCL_ERROR;
117019e2d37fSdrh     }else if( objc==2 ){
117119e2d37fSdrh       if( pDb->zCommit ){
117219e2d37fSdrh         Tcl_AppendResult(interp, pDb->zCommit, 0);
117319e2d37fSdrh       }
117419e2d37fSdrh     }else{
117519e2d37fSdrh       char *zCommit;
117619e2d37fSdrh       int len;
117719e2d37fSdrh       if( pDb->zCommit ){
117819e2d37fSdrh         Tcl_Free(pDb->zCommit);
117919e2d37fSdrh       }
118019e2d37fSdrh       zCommit = Tcl_GetStringFromObj(objv[2], &len);
118119e2d37fSdrh       if( zCommit && len>0 ){
118219e2d37fSdrh         pDb->zCommit = Tcl_Alloc( len + 1 );
11835bb3eb9bSdrh         memcpy(pDb->zCommit, zCommit, len+1);
118419e2d37fSdrh       }else{
118519e2d37fSdrh         pDb->zCommit = 0;
118619e2d37fSdrh       }
118719e2d37fSdrh       if( pDb->zCommit ){
118819e2d37fSdrh         pDb->interp = interp;
118919e2d37fSdrh         sqlite3_commit_hook(pDb->db, DbCommitHandler, pDb);
119019e2d37fSdrh       }else{
119119e2d37fSdrh         sqlite3_commit_hook(pDb->db, 0, 0);
119219e2d37fSdrh       }
119319e2d37fSdrh     }
119419e2d37fSdrh     break;
119519e2d37fSdrh   }
119619e2d37fSdrh 
119775897234Sdrh   /*    $db complete SQL
119875897234Sdrh   **
119975897234Sdrh   ** Return TRUE if SQL is a complete SQL statement.  Return FALSE if
120075897234Sdrh   ** additional lines of input are needed.  This is similar to the
120175897234Sdrh   ** built-in "info complete" command of Tcl.
120275897234Sdrh   */
12036d31316cSdrh   case DB_COMPLETE: {
1204ccae6026Sdrh #ifndef SQLITE_OMIT_COMPLETE
12056d31316cSdrh     Tcl_Obj *pResult;
12066d31316cSdrh     int isComplete;
12076d31316cSdrh     if( objc!=3 ){
12086d31316cSdrh       Tcl_WrongNumArgs(interp, 2, objv, "SQL");
120975897234Sdrh       return TCL_ERROR;
121075897234Sdrh     }
12116f8a503dSdanielk1977     isComplete = sqlite3_complete( Tcl_GetStringFromObj(objv[2], 0) );
12126d31316cSdrh     pResult = Tcl_GetObjResult(interp);
12136d31316cSdrh     Tcl_SetBooleanObj(pResult, isComplete);
1214ccae6026Sdrh #endif
12156d31316cSdrh     break;
12166d31316cSdrh   }
121775897234Sdrh 
121819e2d37fSdrh   /*    $db copy conflict-algorithm table filename ?SEPARATOR? ?NULLINDICATOR?
121919e2d37fSdrh   **
122019e2d37fSdrh   ** Copy data into table from filename, optionally using SEPARATOR
122119e2d37fSdrh   ** as column separators.  If a column contains a null string, or the
122219e2d37fSdrh   ** value of NULLINDICATOR, a NULL is inserted for the column.
122319e2d37fSdrh   ** conflict-algorithm is one of the sqlite conflict algorithms:
122419e2d37fSdrh   **    rollback, abort, fail, ignore, replace
122519e2d37fSdrh   ** On success, return the number of lines processed, not necessarily same
122619e2d37fSdrh   ** as 'db changes' due to conflict-algorithm selected.
122719e2d37fSdrh   **
122819e2d37fSdrh   ** This code is basically an implementation/enhancement of
122919e2d37fSdrh   ** the sqlite3 shell.c ".import" command.
123019e2d37fSdrh   **
123119e2d37fSdrh   ** This command usage is equivalent to the sqlite2.x COPY statement,
123219e2d37fSdrh   ** which imports file data into a table using the PostgreSQL COPY file format:
123319e2d37fSdrh   **   $db copy $conflit_algo $table_name $filename \t \\N
123419e2d37fSdrh   */
123519e2d37fSdrh   case DB_COPY: {
123619e2d37fSdrh     char *zTable;               /* Insert data into this table */
123719e2d37fSdrh     char *zFile;                /* The file from which to extract data */
123819e2d37fSdrh     char *zConflict;            /* The conflict algorithm to use */
123919e2d37fSdrh     sqlite3_stmt *pStmt;        /* A statement */
124019e2d37fSdrh     int rc;                     /* Result code */
124119e2d37fSdrh     int nCol;                   /* Number of columns in the table */
124219e2d37fSdrh     int nByte;                  /* Number of bytes in an SQL string */
124319e2d37fSdrh     int i, j;                   /* Loop counters */
124419e2d37fSdrh     int nSep;                   /* Number of bytes in zSep[] */
124519e2d37fSdrh     int nNull;                  /* Number of bytes in zNull[] */
124619e2d37fSdrh     char *zSql;                 /* An SQL statement */
124719e2d37fSdrh     char *zLine;                /* A single line of input from the file */
124819e2d37fSdrh     char **azCol;               /* zLine[] broken up into columns */
124919e2d37fSdrh     char *zCommit;              /* How to commit changes */
125019e2d37fSdrh     FILE *in;                   /* The input file */
125119e2d37fSdrh     int lineno = 0;             /* Line number of input file */
125219e2d37fSdrh     char zLineNum[80];          /* Line number print buffer */
125319e2d37fSdrh     Tcl_Obj *pResult;           /* interp result */
125419e2d37fSdrh 
125519e2d37fSdrh     char *zSep;
125619e2d37fSdrh     char *zNull;
125719e2d37fSdrh     if( objc<5 || objc>7 ){
125819e2d37fSdrh       Tcl_WrongNumArgs(interp, 2, objv,
125919e2d37fSdrh          "CONFLICT-ALGORITHM TABLE FILENAME ?SEPARATOR? ?NULLINDICATOR?");
126019e2d37fSdrh       return TCL_ERROR;
126119e2d37fSdrh     }
126219e2d37fSdrh     if( objc>=6 ){
126319e2d37fSdrh       zSep = Tcl_GetStringFromObj(objv[5], 0);
126419e2d37fSdrh     }else{
126519e2d37fSdrh       zSep = "\t";
126619e2d37fSdrh     }
126719e2d37fSdrh     if( objc>=7 ){
126819e2d37fSdrh       zNull = Tcl_GetStringFromObj(objv[6], 0);
126919e2d37fSdrh     }else{
127019e2d37fSdrh       zNull = "";
127119e2d37fSdrh     }
127219e2d37fSdrh     zConflict = Tcl_GetStringFromObj(objv[2], 0);
127319e2d37fSdrh     zTable = Tcl_GetStringFromObj(objv[3], 0);
127419e2d37fSdrh     zFile = Tcl_GetStringFromObj(objv[4], 0);
127519e2d37fSdrh     nSep = strlen(zSep);
127619e2d37fSdrh     nNull = strlen(zNull);
127719e2d37fSdrh     if( nSep==0 ){
127819e2d37fSdrh       Tcl_AppendResult(interp,"Error: non-null separator required for copy",0);
127919e2d37fSdrh       return TCL_ERROR;
128019e2d37fSdrh     }
128119e2d37fSdrh     if(sqlite3StrICmp(zConflict, "rollback") != 0 &&
128219e2d37fSdrh        sqlite3StrICmp(zConflict, "abort"   ) != 0 &&
128319e2d37fSdrh        sqlite3StrICmp(zConflict, "fail"    ) != 0 &&
128419e2d37fSdrh        sqlite3StrICmp(zConflict, "ignore"  ) != 0 &&
128519e2d37fSdrh        sqlite3StrICmp(zConflict, "replace" ) != 0 ) {
128619e2d37fSdrh       Tcl_AppendResult(interp, "Error: \"", zConflict,
128719e2d37fSdrh             "\", conflict-algorithm must be one of: rollback, "
128819e2d37fSdrh             "abort, fail, ignore, or replace", 0);
128919e2d37fSdrh       return TCL_ERROR;
129019e2d37fSdrh     }
129119e2d37fSdrh     zSql = sqlite3_mprintf("SELECT * FROM '%q'", zTable);
129219e2d37fSdrh     if( zSql==0 ){
129319e2d37fSdrh       Tcl_AppendResult(interp, "Error: no such table: ", zTable, 0);
129419e2d37fSdrh       return TCL_ERROR;
129519e2d37fSdrh     }
129619e2d37fSdrh     nByte = strlen(zSql);
12973e701a18Sdrh     rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
129819e2d37fSdrh     sqlite3_free(zSql);
129919e2d37fSdrh     if( rc ){
130019e2d37fSdrh       Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), 0);
130119e2d37fSdrh       nCol = 0;
130219e2d37fSdrh     }else{
130319e2d37fSdrh       nCol = sqlite3_column_count(pStmt);
130419e2d37fSdrh     }
130519e2d37fSdrh     sqlite3_finalize(pStmt);
130619e2d37fSdrh     if( nCol==0 ) {
130719e2d37fSdrh       return TCL_ERROR;
130819e2d37fSdrh     }
130919e2d37fSdrh     zSql = malloc( nByte + 50 + nCol*2 );
131019e2d37fSdrh     if( zSql==0 ) {
131119e2d37fSdrh       Tcl_AppendResult(interp, "Error: can't malloc()", 0);
131219e2d37fSdrh       return TCL_ERROR;
131319e2d37fSdrh     }
131419e2d37fSdrh     sqlite3_snprintf(nByte+50, zSql, "INSERT OR %q INTO '%q' VALUES(?",
131519e2d37fSdrh          zConflict, zTable);
131619e2d37fSdrh     j = strlen(zSql);
131719e2d37fSdrh     for(i=1; i<nCol; i++){
131819e2d37fSdrh       zSql[j++] = ',';
131919e2d37fSdrh       zSql[j++] = '?';
132019e2d37fSdrh     }
132119e2d37fSdrh     zSql[j++] = ')';
132219e2d37fSdrh     zSql[j] = 0;
13233e701a18Sdrh     rc = sqlite3_prepare(pDb->db, zSql, -1, &pStmt, 0);
132419e2d37fSdrh     free(zSql);
132519e2d37fSdrh     if( rc ){
132619e2d37fSdrh       Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), 0);
132719e2d37fSdrh       sqlite3_finalize(pStmt);
132819e2d37fSdrh       return TCL_ERROR;
132919e2d37fSdrh     }
133019e2d37fSdrh     in = fopen(zFile, "rb");
133119e2d37fSdrh     if( in==0 ){
133219e2d37fSdrh       Tcl_AppendResult(interp, "Error: cannot open file: ", zFile, NULL);
133319e2d37fSdrh       sqlite3_finalize(pStmt);
133419e2d37fSdrh       return TCL_ERROR;
133519e2d37fSdrh     }
133619e2d37fSdrh     azCol = malloc( sizeof(azCol[0])*(nCol+1) );
133719e2d37fSdrh     if( azCol==0 ) {
133819e2d37fSdrh       Tcl_AppendResult(interp, "Error: can't malloc()", 0);
133943617e9aSdrh       fclose(in);
134019e2d37fSdrh       return TCL_ERROR;
134119e2d37fSdrh     }
13423752785fSdrh     (void)sqlite3_exec(pDb->db, "BEGIN", 0, 0, 0);
134319e2d37fSdrh     zCommit = "COMMIT";
134419e2d37fSdrh     while( (zLine = local_getline(0, in))!=0 ){
134519e2d37fSdrh       char *z;
134619e2d37fSdrh       i = 0;
134719e2d37fSdrh       lineno++;
134819e2d37fSdrh       azCol[0] = zLine;
134919e2d37fSdrh       for(i=0, z=zLine; *z; z++){
135019e2d37fSdrh         if( *z==zSep[0] && strncmp(z, zSep, nSep)==0 ){
135119e2d37fSdrh           *z = 0;
135219e2d37fSdrh           i++;
135319e2d37fSdrh           if( i<nCol ){
135419e2d37fSdrh             azCol[i] = &z[nSep];
135519e2d37fSdrh             z += nSep-1;
135619e2d37fSdrh           }
135719e2d37fSdrh         }
135819e2d37fSdrh       }
135919e2d37fSdrh       if( i+1!=nCol ){
136019e2d37fSdrh         char *zErr;
13615bb3eb9bSdrh         int nErr = strlen(zFile) + 200;
13625bb3eb9bSdrh         zErr = malloc(nErr);
1363c1f4494eSdrh         if( zErr ){
13645bb3eb9bSdrh           sqlite3_snprintf(nErr, zErr,
1365955de52cSdanielk1977              "Error: %s line %d: expected %d columns of data but found %d",
136619e2d37fSdrh              zFile, lineno, nCol, i+1);
136719e2d37fSdrh           Tcl_AppendResult(interp, zErr, 0);
136819e2d37fSdrh           free(zErr);
1369c1f4494eSdrh         }
137019e2d37fSdrh         zCommit = "ROLLBACK";
137119e2d37fSdrh         break;
137219e2d37fSdrh       }
137319e2d37fSdrh       for(i=0; i<nCol; i++){
137419e2d37fSdrh         /* check for null data, if so, bind as null */
137519e2d37fSdrh         if ((nNull>0 && strcmp(azCol[i], zNull)==0) || strlen(azCol[i])==0) {
137619e2d37fSdrh           sqlite3_bind_null(pStmt, i+1);
137719e2d37fSdrh         }else{
137819e2d37fSdrh           sqlite3_bind_text(pStmt, i+1, azCol[i], -1, SQLITE_STATIC);
137919e2d37fSdrh         }
138019e2d37fSdrh       }
138119e2d37fSdrh       sqlite3_step(pStmt);
138219e2d37fSdrh       rc = sqlite3_reset(pStmt);
138319e2d37fSdrh       free(zLine);
138419e2d37fSdrh       if( rc!=SQLITE_OK ){
138519e2d37fSdrh         Tcl_AppendResult(interp,"Error: ", sqlite3_errmsg(pDb->db), 0);
138619e2d37fSdrh         zCommit = "ROLLBACK";
138719e2d37fSdrh         break;
138819e2d37fSdrh       }
138919e2d37fSdrh     }
139019e2d37fSdrh     free(azCol);
139119e2d37fSdrh     fclose(in);
139219e2d37fSdrh     sqlite3_finalize(pStmt);
13933752785fSdrh     (void)sqlite3_exec(pDb->db, zCommit, 0, 0, 0);
139419e2d37fSdrh 
139519e2d37fSdrh     if( zCommit[0] == 'C' ){
139619e2d37fSdrh       /* success, set result as number of lines processed */
139719e2d37fSdrh       pResult = Tcl_GetObjResult(interp);
139819e2d37fSdrh       Tcl_SetIntObj(pResult, lineno);
139919e2d37fSdrh       rc = TCL_OK;
140019e2d37fSdrh     }else{
140119e2d37fSdrh       /* failure, append lineno where failed */
14025bb3eb9bSdrh       sqlite3_snprintf(sizeof(zLineNum), zLineNum,"%d",lineno);
140319e2d37fSdrh       Tcl_AppendResult(interp,", failed while processing line: ",zLineNum,0);
140419e2d37fSdrh       rc = TCL_ERROR;
140519e2d37fSdrh     }
140619e2d37fSdrh     break;
140719e2d37fSdrh   }
140819e2d37fSdrh 
140975897234Sdrh   /*
14104144905bSdrh   **    $db enable_load_extension BOOLEAN
14114144905bSdrh   **
14124144905bSdrh   ** Turn the extension loading feature on or off.  It if off by
14134144905bSdrh   ** default.
14144144905bSdrh   */
14154144905bSdrh   case DB_ENABLE_LOAD_EXTENSION: {
1416f533acc0Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
14174144905bSdrh     int onoff;
14184144905bSdrh     if( objc!=3 ){
14194144905bSdrh       Tcl_WrongNumArgs(interp, 2, objv, "BOOLEAN");
14204144905bSdrh       return TCL_ERROR;
14214144905bSdrh     }
14224144905bSdrh     if( Tcl_GetBooleanFromObj(interp, objv[2], &onoff) ){
14234144905bSdrh       return TCL_ERROR;
14244144905bSdrh     }
14254144905bSdrh     sqlite3_enable_load_extension(pDb->db, onoff);
14264144905bSdrh     break;
1427f533acc0Sdrh #else
1428f533acc0Sdrh     Tcl_AppendResult(interp, "extension loading is turned off at compile-time",
1429f533acc0Sdrh                      0);
1430f533acc0Sdrh     return TCL_ERROR;
1431f533acc0Sdrh #endif
14324144905bSdrh   }
14334144905bSdrh 
14344144905bSdrh   /*
1435dcd997eaSdrh   **    $db errorcode
1436dcd997eaSdrh   **
1437dcd997eaSdrh   ** Return the numeric error code that was returned by the most recent
14386f8a503dSdanielk1977   ** call to sqlite3_exec().
1439dcd997eaSdrh   */
1440dcd997eaSdrh   case DB_ERRORCODE: {
1441f3ce83f5Sdanielk1977     Tcl_SetObjResult(interp, Tcl_NewIntObj(sqlite3_errcode(pDb->db)));
1442dcd997eaSdrh     break;
1443dcd997eaSdrh   }
1444dcd997eaSdrh 
1445dcd997eaSdrh   /*
1446895d7472Sdrh   **    $db eval $sql ?array? ?{  ...code... }?
14471807ce37Sdrh   **    $db onecolumn $sql
144875897234Sdrh   **
144975897234Sdrh   ** The SQL statement in $sql is evaluated.  For each row, the values are
1450bec3f402Sdrh   ** placed in elements of the array named "array" and ...code... is executed.
145175897234Sdrh   ** If "array" and "code" are omitted, then no callback is every invoked.
145275897234Sdrh   ** If "array" is an empty string, then the values are placed in variables
145375897234Sdrh   ** that have the same name as the fields extracted by the query.
14541807ce37Sdrh   **
14551807ce37Sdrh   ** The onecolumn method is the equivalent of:
14561807ce37Sdrh   **     lindex [$db eval $sql] 0
145775897234Sdrh   */
14581807ce37Sdrh   case DB_ONECOLUMN:
145997f2ebc1Sdrh   case DB_EVAL:
146097f2ebc1Sdrh   case DB_EXISTS: {
14619d74b4c5Sdrh     char const *zSql;      /* Next SQL statement to execute */
14629d74b4c5Sdrh     char const *zLeft;     /* What is left after first stmt in zSql */
14639d74b4c5Sdrh     sqlite3_stmt *pStmt;   /* Compiled SQL statment */
146492febd92Sdrh     Tcl_Obj *pArray;       /* Name of array into which results are written */
146592febd92Sdrh     Tcl_Obj *pScript;      /* Script to run for each result set */
14661d895039Sdrh     Tcl_Obj **apParm;      /* Parameters that need a Tcl_DecrRefCount() */
14671d895039Sdrh     int nParm;             /* Number of entries used in apParm[] */
14681d895039Sdrh     Tcl_Obj *aParm[10];    /* Static space for apParm[] in the common case */
14691807ce37Sdrh     Tcl_Obj *pRet;         /* Value to be returned */
1470fb7e7651Sdrh     SqlPreparedStmt *pPreStmt;  /* Pointer to a prepared statement */
1471fb7e7651Sdrh     int rc2;
1472ef2cb63eSdanielk1977 
147397f2ebc1Sdrh     if( choice==DB_EVAL ){
147492febd92Sdrh       if( objc<3 || objc>5 ){
1475895d7472Sdrh         Tcl_WrongNumArgs(interp, 2, objv, "SQL ?ARRAY-NAME? ?SCRIPT?");
147630ccda10Sdanielk1977         return TCL_ERROR;
147730ccda10Sdanielk1977       }
14781807ce37Sdrh       pRet = Tcl_NewObj();
14791807ce37Sdrh       Tcl_IncrRefCount(pRet);
148097f2ebc1Sdrh     }else{
148197f2ebc1Sdrh       if( objc!=3 ){
148297f2ebc1Sdrh         Tcl_WrongNumArgs(interp, 2, objv, "SQL");
148397f2ebc1Sdrh         return TCL_ERROR;
148497f2ebc1Sdrh       }
148597f2ebc1Sdrh       if( choice==DB_EXISTS ){
1486446a9b82Sdrh         pRet = Tcl_NewBooleanObj(0);
1487446a9b82Sdrh         Tcl_IncrRefCount(pRet);
1488446a9b82Sdrh       }else{
1489446a9b82Sdrh         pRet = 0;
149097f2ebc1Sdrh       }
14911807ce37Sdrh     }
149292febd92Sdrh     if( objc==3 ){
149392febd92Sdrh       pArray = pScript = 0;
149492febd92Sdrh     }else if( objc==4 ){
149592febd92Sdrh       pArray = 0;
149692febd92Sdrh       pScript = objv[3];
149792febd92Sdrh     }else{
149892febd92Sdrh       pArray = objv[3];
149992febd92Sdrh       if( Tcl_GetString(pArray)[0]==0 ) pArray = 0;
150092febd92Sdrh       pScript = objv[4];
150192febd92Sdrh     }
150230ccda10Sdanielk1977 
15031d895039Sdrh     Tcl_IncrRefCount(objv[2]);
150430ccda10Sdanielk1977     zSql = Tcl_GetStringFromObj(objv[2], 0);
150590b6bb19Sdrh     while( rc==TCL_OK && zSql[0] ){
150692febd92Sdrh       int i;                     /* Loop counter */
1507fb7e7651Sdrh       int nVar;                  /* Number of bind parameters in the pStmt */
150892febd92Sdrh       int nCol;                  /* Number of columns in the result set */
150992febd92Sdrh       Tcl_Obj **apColName = 0;   /* Array of column names */
1510fb7e7651Sdrh       int len;                   /* String length of zSql */
151130ccda10Sdanielk1977 
1512fb7e7651Sdrh       /* Try to find a SQL statement that has already been compiled and
1513fb7e7651Sdrh       ** which matches the next sequence of SQL.
1514fb7e7651Sdrh       */
1515fb7e7651Sdrh       pStmt = 0;
1516fb7e7651Sdrh       pPreStmt = pDb->stmtList;
1517fb7e7651Sdrh       len = strlen(zSql);
1518fb7e7651Sdrh       if( pPreStmt && sqlite3_expired(pPreStmt->pStmt) ){
1519fb7e7651Sdrh         flushStmtCache(pDb);
1520fb7e7651Sdrh         pPreStmt = 0;
1521fb7e7651Sdrh       }
1522fb7e7651Sdrh       for(; pPreStmt; pPreStmt=pPreStmt->pNext){
1523fb7e7651Sdrh         int n = pPreStmt->nSql;
1524fb7e7651Sdrh         if( len>=n
1525fb7e7651Sdrh             && memcmp(pPreStmt->zSql, zSql, n)==0
1526fb7e7651Sdrh             && (zSql[n]==0 || zSql[n-1]==';')
1527fb7e7651Sdrh         ){
1528fb7e7651Sdrh           pStmt = pPreStmt->pStmt;
1529fb7e7651Sdrh           zLeft = &zSql[pPreStmt->nSql];
1530fb7e7651Sdrh 
1531fb7e7651Sdrh           /* When a prepared statement is found, unlink it from the
1532fb7e7651Sdrh           ** cache list.  It will later be added back to the beginning
1533fb7e7651Sdrh           ** of the cache list in order to implement LRU replacement.
1534fb7e7651Sdrh           */
1535fb7e7651Sdrh           if( pPreStmt->pPrev ){
1536fb7e7651Sdrh             pPreStmt->pPrev->pNext = pPreStmt->pNext;
1537fb7e7651Sdrh           }else{
1538fb7e7651Sdrh             pDb->stmtList = pPreStmt->pNext;
1539fb7e7651Sdrh           }
1540fb7e7651Sdrh           if( pPreStmt->pNext ){
1541fb7e7651Sdrh             pPreStmt->pNext->pPrev = pPreStmt->pPrev;
1542fb7e7651Sdrh           }else{
1543fb7e7651Sdrh             pDb->stmtLast = pPreStmt->pPrev;
1544fb7e7651Sdrh           }
1545fb7e7651Sdrh           pDb->nStmt--;
1546fb7e7651Sdrh           break;
1547fb7e7651Sdrh         }
1548fb7e7651Sdrh       }
1549fb7e7651Sdrh 
1550fb7e7651Sdrh       /* If no prepared statement was found.  Compile the SQL text
1551fb7e7651Sdrh       */
1552fb7e7651Sdrh       if( pStmt==0 ){
155330ccda10Sdanielk1977         if( SQLITE_OK!=sqlite3_prepare(pDb->db, zSql, -1, &pStmt, &zLeft) ){
1554ef2cb63eSdanielk1977           Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
155530ccda10Sdanielk1977           rc = TCL_ERROR;
155630ccda10Sdanielk1977           break;
155730ccda10Sdanielk1977         }
155892febd92Sdrh         if( pStmt==0 ){
155992febd92Sdrh           if( SQLITE_OK!=sqlite3_errcode(pDb->db) ){
1560fb7e7651Sdrh             /* A compile-time error in the statement
1561fb7e7651Sdrh             */
156292febd92Sdrh             Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
156392febd92Sdrh             rc = TCL_ERROR;
156492febd92Sdrh             break;
156592febd92Sdrh           }else{
1566fb7e7651Sdrh             /* The statement was a no-op.  Continue to the next statement
1567fb7e7651Sdrh             ** in the SQL string.
1568fb7e7651Sdrh             */
156992febd92Sdrh             zSql = zLeft;
157092febd92Sdrh             continue;
157192febd92Sdrh           }
157292febd92Sdrh         }
1573fb7e7651Sdrh         assert( pPreStmt==0 );
1574fb7e7651Sdrh       }
157530ccda10Sdanielk1977 
1576fb7e7651Sdrh       /* Bind values to parameters that begin with $ or :
1577fb7e7651Sdrh       */
157892febd92Sdrh       nVar = sqlite3_bind_parameter_count(pStmt);
15791d895039Sdrh       nParm = 0;
15801d895039Sdrh       if( nVar>sizeof(aParm)/sizeof(aParm[0]) ){
15811d895039Sdrh         apParm = (Tcl_Obj**)Tcl_Alloc(nVar*sizeof(apParm[0]));
15821d895039Sdrh       }else{
15831d895039Sdrh         apParm = aParm;
15841d895039Sdrh       }
158592febd92Sdrh       for(i=1; i<=nVar; i++){
158692febd92Sdrh         const char *zVar = sqlite3_bind_parameter_name(pStmt, i);
1587c8f9079cSdrh         if( zVar!=0 && (zVar[0]=='$' || zVar[0]==':') ){
158892febd92Sdrh           Tcl_Obj *pVar = Tcl_GetVar2Ex(interp, &zVar[1], 0, 0);
158992febd92Sdrh           if( pVar ){
159092febd92Sdrh             int n;
159192febd92Sdrh             u8 *data;
159292febd92Sdrh             char *zType = pVar->typePtr ? pVar->typePtr->name : "";
159392febd92Sdrh             char c = zType[0];
1594df0bddaeSdrh             if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
1595df0bddaeSdrh               /* Only load a BLOB type if the Tcl variable is a bytearray and
1596df0bddaeSdrh               ** has no string representation. */
159792febd92Sdrh               data = Tcl_GetByteArrayFromObj(pVar, &n);
159892febd92Sdrh               sqlite3_bind_blob(pStmt, i, data, n, SQLITE_STATIC);
15991d895039Sdrh               Tcl_IncrRefCount(pVar);
16001d895039Sdrh               apParm[nParm++] = pVar;
160192febd92Sdrh             }else if( (c=='b' && strcmp(zType,"boolean")==0) ||
160292febd92Sdrh                   (c=='i' && strcmp(zType,"int")==0) ){
160392febd92Sdrh               Tcl_GetIntFromObj(interp, pVar, &n);
160492febd92Sdrh               sqlite3_bind_int(pStmt, i, n);
160592febd92Sdrh             }else if( c=='d' && strcmp(zType,"double")==0 ){
160692febd92Sdrh               double r;
160792febd92Sdrh               Tcl_GetDoubleFromObj(interp, pVar, &r);
160892febd92Sdrh               sqlite3_bind_double(pStmt, i, r);
1609df0bddaeSdrh             }else if( c=='w' && strcmp(zType,"wideInt")==0 ){
1610df0bddaeSdrh               Tcl_WideInt v;
1611df0bddaeSdrh               Tcl_GetWideIntFromObj(interp, pVar, &v);
1612df0bddaeSdrh               sqlite3_bind_int64(pStmt, i, v);
161392febd92Sdrh             }else{
161400fd957bSdanielk1977               data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
161500fd957bSdanielk1977               sqlite3_bind_text(pStmt, i, (char *)data, n, SQLITE_STATIC);
16161d895039Sdrh               Tcl_IncrRefCount(pVar);
16171d895039Sdrh               apParm[nParm++] = pVar;
161892febd92Sdrh             }
1619fb7e7651Sdrh           }else{
1620fb7e7651Sdrh             sqlite3_bind_null( pStmt, i );
162192febd92Sdrh           }
162292febd92Sdrh         }
162392febd92Sdrh       }
162492febd92Sdrh 
162592febd92Sdrh       /* Compute column names */
162692febd92Sdrh       nCol = sqlite3_column_count(pStmt);
162792febd92Sdrh       if( pScript ){
162892febd92Sdrh         apColName = (Tcl_Obj**)Tcl_Alloc( sizeof(Tcl_Obj*)*nCol );
162992febd92Sdrh         if( apColName==0 ) break;
163092febd92Sdrh         for(i=0; i<nCol; i++){
163192febd92Sdrh           apColName[i] = dbTextToObj(sqlite3_column_name(pStmt,i));
163292febd92Sdrh           Tcl_IncrRefCount(apColName[i]);
163392febd92Sdrh         }
163492febd92Sdrh       }
163592febd92Sdrh 
163692febd92Sdrh       /* If results are being stored in an array variable, then create
163792febd92Sdrh       ** the array(*) entry for that array
163892febd92Sdrh       */
163992febd92Sdrh       if( pArray ){
164030ccda10Sdanielk1977         Tcl_Obj *pColList = Tcl_NewObj();
16413ced14a6Sdrh         Tcl_Obj *pStar = Tcl_NewStringObj("*", -1);
164230ccda10Sdanielk1977         Tcl_IncrRefCount(pColList);
164392febd92Sdrh         for(i=0; i<nCol; i++){
164492febd92Sdrh           Tcl_ListObjAppendElement(interp, pColList, apColName[i]);
164530ccda10Sdanielk1977         }
16463ced14a6Sdrh         Tcl_ObjSetVar2(interp, pArray, pStar, pColList,0);
16473ced14a6Sdrh         Tcl_DecrRefCount(pColList);
16483ced14a6Sdrh         Tcl_DecrRefCount(pStar);
164930ccda10Sdanielk1977       }
165030ccda10Sdanielk1977 
165192febd92Sdrh       /* Execute the SQL
165292febd92Sdrh       */
165390b6bb19Sdrh       while( rc==TCL_OK && pStmt && SQLITE_ROW==sqlite3_step(pStmt) ){
165492febd92Sdrh         for(i=0; i<nCol; i++){
165530ccda10Sdanielk1977           Tcl_Obj *pVal;
165630ccda10Sdanielk1977 
165730ccda10Sdanielk1977           /* Set pVal to contain the i'th column of this row. */
165892febd92Sdrh           switch( sqlite3_column_type(pStmt, i) ){
165992febd92Sdrh             case SQLITE_BLOB: {
16603fd0a736Sdanielk1977               int bytes = sqlite3_column_bytes(pStmt, i);
16613fd0a736Sdanielk1977               pVal = Tcl_NewByteArrayObj(sqlite3_column_blob(pStmt, i), bytes);
166292febd92Sdrh               break;
166392febd92Sdrh             }
166492febd92Sdrh             case SQLITE_INTEGER: {
166592febd92Sdrh               sqlite_int64 v = sqlite3_column_int64(pStmt, i);
166692febd92Sdrh               if( v>=-2147483647 && v<=2147483647 ){
166792febd92Sdrh                 pVal = Tcl_NewIntObj(v);
166892febd92Sdrh               }else{
166992febd92Sdrh                 pVal = Tcl_NewWideIntObj(v);
167092febd92Sdrh               }
167192febd92Sdrh               break;
167292febd92Sdrh             }
167392febd92Sdrh             case SQLITE_FLOAT: {
167492febd92Sdrh               double r = sqlite3_column_double(pStmt, i);
167592febd92Sdrh               pVal = Tcl_NewDoubleObj(r);
167692febd92Sdrh               break;
167792febd92Sdrh             }
167855c45f2eSdanielk1977             case SQLITE_NULL: {
167955c45f2eSdanielk1977               pVal = dbTextToObj(pDb->zNull);
168055c45f2eSdanielk1977               break;
168155c45f2eSdanielk1977             }
168292febd92Sdrh             default: {
168300fd957bSdanielk1977               pVal = dbTextToObj((char *)sqlite3_column_text(pStmt, i));
168492febd92Sdrh               break;
168592febd92Sdrh             }
168630ccda10Sdanielk1977           }
168730ccda10Sdanielk1977 
168892febd92Sdrh           if( pScript ){
168992febd92Sdrh             if( pArray==0 ){
169092febd92Sdrh               Tcl_ObjSetVar2(interp, apColName[i], 0, pVal, 0);
169130ccda10Sdanielk1977             }else{
169292febd92Sdrh               Tcl_ObjSetVar2(interp, pArray, apColName[i], pVal, 0);
169330ccda10Sdanielk1977             }
16941807ce37Sdrh           }else if( choice==DB_ONECOLUMN ){
169597f2ebc1Sdrh             assert( pRet==0 );
16961807ce37Sdrh             if( pRet==0 ){
16971807ce37Sdrh               pRet = pVal;
16981807ce37Sdrh               Tcl_IncrRefCount(pRet);
16991807ce37Sdrh             }
170090b6bb19Sdrh             rc = TCL_BREAK;
170197f2ebc1Sdrh             i = nCol;
170297f2ebc1Sdrh           }else if( choice==DB_EXISTS ){
1703446a9b82Sdrh             Tcl_DecrRefCount(pRet);
1704446a9b82Sdrh             pRet = Tcl_NewBooleanObj(1);
1705446a9b82Sdrh             Tcl_IncrRefCount(pRet);
170697f2ebc1Sdrh             rc = TCL_BREAK;
170797f2ebc1Sdrh             i = nCol;
170830ccda10Sdanielk1977           }else{
170930ccda10Sdanielk1977             Tcl_ListObjAppendElement(interp, pRet, pVal);
171030ccda10Sdanielk1977           }
171130ccda10Sdanielk1977         }
171230ccda10Sdanielk1977 
171392febd92Sdrh         if( pScript ){
171492febd92Sdrh           rc = Tcl_EvalObjEx(interp, pScript, 0);
171590b6bb19Sdrh           if( rc==TCL_CONTINUE ){
171690b6bb19Sdrh             rc = TCL_OK;
171730ccda10Sdanielk1977           }
171830ccda10Sdanielk1977         }
171990b6bb19Sdrh       }
172090b6bb19Sdrh       if( rc==TCL_BREAK ){
172190b6bb19Sdrh         rc = TCL_OK;
172290b6bb19Sdrh       }
172330ccda10Sdanielk1977 
172492febd92Sdrh       /* Free the column name objects */
172592febd92Sdrh       if( pScript ){
172692febd92Sdrh         for(i=0; i<nCol; i++){
172792febd92Sdrh           Tcl_DecrRefCount(apColName[i]);
172892febd92Sdrh         }
172992febd92Sdrh         Tcl_Free((char*)apColName);
173092febd92Sdrh       }
173192febd92Sdrh 
17321d895039Sdrh       /* Free the bound string and blob parameters */
17331d895039Sdrh       for(i=0; i<nParm; i++){
17341d895039Sdrh         Tcl_DecrRefCount(apParm[i]);
17351d895039Sdrh       }
17361d895039Sdrh       if( apParm!=aParm ){
17371d895039Sdrh         Tcl_Free((char*)apParm);
17381d895039Sdrh       }
17391d895039Sdrh 
1740fb7e7651Sdrh       /* Reset the statement.  If the result code is SQLITE_SCHEMA, then
1741fb7e7651Sdrh       ** flush the statement cache and try the statement again.
174292febd92Sdrh       */
1743fb7e7651Sdrh       rc2 = sqlite3_reset(pStmt);
1744fb7e7651Sdrh       if( SQLITE_SCHEMA==rc2 ){
1745fb7e7651Sdrh         /* After a schema change, flush the cache and try to run the
1746fb7e7651Sdrh         ** statement again
1747fb7e7651Sdrh         */
1748fb7e7651Sdrh         flushStmtCache( pDb );
1749fb7e7651Sdrh         sqlite3_finalize(pStmt);
1750fb7e7651Sdrh         if( pPreStmt ) Tcl_Free((char*)pPreStmt);
175130ccda10Sdanielk1977         continue;
1752fb7e7651Sdrh       }else if( SQLITE_OK!=rc2 ){
1753fb7e7651Sdrh         /* If a run-time error occurs, report the error and stop reading
1754fb7e7651Sdrh         ** the SQL
1755fb7e7651Sdrh         */
1756ef2cb63eSdanielk1977         Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
1757fb7e7651Sdrh         sqlite3_finalize(pStmt);
175830ccda10Sdanielk1977         rc = TCL_ERROR;
1759fb7e7651Sdrh         if( pPreStmt ) Tcl_Free((char*)pPreStmt);
176030ccda10Sdanielk1977         break;
1761fb7e7651Sdrh       }else if( pDb->maxStmt<=0 ){
1762fb7e7651Sdrh         /* If the cache is turned off, deallocated the statement */
1763fb7e7651Sdrh         if( pPreStmt ) Tcl_Free((char*)pPreStmt);
1764fb7e7651Sdrh         sqlite3_finalize(pStmt);
1765fb7e7651Sdrh       }else{
1766fb7e7651Sdrh         /* Everything worked and the cache is operational.
1767fb7e7651Sdrh         ** Create a new SqlPreparedStmt structure if we need one.
1768fb7e7651Sdrh         ** (If we already have one we can just reuse it.)
1769fb7e7651Sdrh         */
1770fb7e7651Sdrh         if( pPreStmt==0 ){
1771fb7e7651Sdrh           len = zLeft - zSql;
1772fb7e7651Sdrh           pPreStmt = (SqlPreparedStmt*)Tcl_Alloc( sizeof(*pPreStmt) + len );
1773fb7e7651Sdrh           if( pPreStmt==0 ) return TCL_ERROR;
1774fb7e7651Sdrh           pPreStmt->pStmt = pStmt;
1775fb7e7651Sdrh           pPreStmt->nSql = len;
1776fb7e7651Sdrh           memcpy(pPreStmt->zSql, zSql, len);
1777fb7e7651Sdrh           pPreStmt->zSql[len] = 0;
177830ccda10Sdanielk1977         }
177930ccda10Sdanielk1977 
1780fb7e7651Sdrh         /* Add the prepared statement to the beginning of the cache list
1781fb7e7651Sdrh         */
1782fb7e7651Sdrh         pPreStmt->pNext = pDb->stmtList;
1783fb7e7651Sdrh         pPreStmt->pPrev = 0;
1784fb7e7651Sdrh         if( pDb->stmtList ){
1785fb7e7651Sdrh          pDb->stmtList->pPrev = pPreStmt;
1786fb7e7651Sdrh         }
1787fb7e7651Sdrh         pDb->stmtList = pPreStmt;
1788fb7e7651Sdrh         if( pDb->stmtLast==0 ){
1789fb7e7651Sdrh           assert( pDb->nStmt==0 );
1790fb7e7651Sdrh           pDb->stmtLast = pPreStmt;
1791fb7e7651Sdrh         }else{
1792fb7e7651Sdrh           assert( pDb->nStmt>0 );
1793fb7e7651Sdrh         }
1794fb7e7651Sdrh         pDb->nStmt++;
1795fb7e7651Sdrh 
1796fb7e7651Sdrh         /* If we have too many statement in cache, remove the surplus from the
1797fb7e7651Sdrh         ** end of the cache list.
1798fb7e7651Sdrh         */
1799fb7e7651Sdrh         while( pDb->nStmt>pDb->maxStmt ){
1800fb7e7651Sdrh           sqlite3_finalize(pDb->stmtLast->pStmt);
1801fb7e7651Sdrh           pDb->stmtLast = pDb->stmtLast->pPrev;
1802fb7e7651Sdrh           Tcl_Free((char*)pDb->stmtLast->pNext);
1803fb7e7651Sdrh           pDb->stmtLast->pNext = 0;
1804fb7e7651Sdrh           pDb->nStmt--;
1805fb7e7651Sdrh         }
1806fb7e7651Sdrh       }
1807fb7e7651Sdrh 
1808fb7e7651Sdrh       /* Proceed to the next statement */
180930ccda10Sdanielk1977       zSql = zLeft;
181030ccda10Sdanielk1977     }
18111d895039Sdrh     Tcl_DecrRefCount(objv[2]);
181230ccda10Sdanielk1977 
18131807ce37Sdrh     if( pRet ){
1814ef2cb63eSdanielk1977       if( rc==TCL_OK ){
181530ccda10Sdanielk1977         Tcl_SetObjResult(interp, pRet);
181630ccda10Sdanielk1977       }
1817ef2cb63eSdanielk1977       Tcl_DecrRefCount(pRet);
1818050be329Sdrh     }else if( rc==TCL_OK ){
1819050be329Sdrh       Tcl_ResetResult(interp);
18201807ce37Sdrh     }
182130ccda10Sdanielk1977     break;
182230ccda10Sdanielk1977   }
1823bec3f402Sdrh 
1824bec3f402Sdrh   /*
1825cabb0819Sdrh   **     $db function NAME SCRIPT
1826cabb0819Sdrh   **
1827cabb0819Sdrh   ** Create a new SQL function called NAME.  Whenever that function is
1828cabb0819Sdrh   ** called, invoke SCRIPT to evaluate the function.
1829cabb0819Sdrh   */
1830cabb0819Sdrh   case DB_FUNCTION: {
1831cabb0819Sdrh     SqlFunc *pFunc;
1832d1e4733dSdrh     Tcl_Obj *pScript;
1833cabb0819Sdrh     char *zName;
1834cabb0819Sdrh     if( objc!=4 ){
1835cabb0819Sdrh       Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
1836cabb0819Sdrh       return TCL_ERROR;
1837cabb0819Sdrh     }
1838cabb0819Sdrh     zName = Tcl_GetStringFromObj(objv[2], 0);
1839d1e4733dSdrh     pScript = objv[3];
1840d1e4733dSdrh     pFunc = findSqlFunc(pDb, zName);
1841cabb0819Sdrh     if( pFunc==0 ) return TCL_ERROR;
1842d1e4733dSdrh     if( pFunc->pScript ){
1843d1e4733dSdrh       Tcl_DecrRefCount(pFunc->pScript);
1844d1e4733dSdrh     }
1845d1e4733dSdrh     pFunc->pScript = pScript;
1846d1e4733dSdrh     Tcl_IncrRefCount(pScript);
1847d1e4733dSdrh     pFunc->useEvalObjv = safeToUseEvalObjv(interp, pScript);
1848c8c1158bSdanielk1977     rc = sqlite3_create_function(pDb->db, zName, -1, SQLITE_UTF8,
1849d8123366Sdanielk1977         pFunc, tclSqlFunc, 0, 0);
1850fb7e7651Sdrh     if( rc!=SQLITE_OK ){
1851fb7e7651Sdrh       rc = TCL_ERROR;
18529636c4e1Sdanielk1977       Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
1853fb7e7651Sdrh     }else{
1854fb7e7651Sdrh       /* Must flush any cached statements */
1855fb7e7651Sdrh       flushStmtCache( pDb );
1856fb7e7651Sdrh     }
1857cabb0819Sdrh     break;
1858cabb0819Sdrh   }
1859cabb0819Sdrh 
1860cabb0819Sdrh   /*
18618cbadb02Sdanielk1977   **     $db incrblob ?-readonly? ?DB? TABLE COLUMN ROWID
1862b4e9af9fSdanielk1977   */
1863b4e9af9fSdanielk1977   case DB_INCRBLOB: {
18648cbadb02Sdanielk1977     int isReadonly = 0;
1865b4e9af9fSdanielk1977     const char *zDb = "main";
1866b4e9af9fSdanielk1977     const char *zTable;
1867b4e9af9fSdanielk1977     const char *zColumn;
1868b4e9af9fSdanielk1977     sqlite_int64 iRow;
1869b4e9af9fSdanielk1977 
18708cbadb02Sdanielk1977     /* Check for the -readonly option */
18718cbadb02Sdanielk1977     if( objc>3 && strcmp(Tcl_GetString(objv[2]), "-readonly")==0 ){
18728cbadb02Sdanielk1977       isReadonly = 1;
18738cbadb02Sdanielk1977     }
18748cbadb02Sdanielk1977 
18758cbadb02Sdanielk1977     if( objc!=(5+isReadonly) && objc!=(6+isReadonly) ){
18768cbadb02Sdanielk1977       Tcl_WrongNumArgs(interp, 2, objv, "?-readonly? ?DB? TABLE COLUMN ROWID");
1877b4e9af9fSdanielk1977       return TCL_ERROR;
1878b4e9af9fSdanielk1977     }
1879b4e9af9fSdanielk1977 
18808cbadb02Sdanielk1977     if( objc==(6+isReadonly) ){
1881b4e9af9fSdanielk1977       zDb = Tcl_GetString(objv[2]);
1882b4e9af9fSdanielk1977     }
1883b4e9af9fSdanielk1977     zTable = Tcl_GetString(objv[objc-3]);
1884b4e9af9fSdanielk1977     zColumn = Tcl_GetString(objv[objc-2]);
1885b4e9af9fSdanielk1977     rc = Tcl_GetWideIntFromObj(interp, objv[objc-1], &iRow);
1886b4e9af9fSdanielk1977 
1887b4e9af9fSdanielk1977     if( rc==TCL_OK ){
18888cbadb02Sdanielk1977       rc = createIncrblobChannel(
18898cbadb02Sdanielk1977           interp, pDb, zDb, zTable, zColumn, iRow, isReadonly
18908cbadb02Sdanielk1977       );
1891b4e9af9fSdanielk1977     }
1892b4e9af9fSdanielk1977     break;
1893b4e9af9fSdanielk1977   }
1894b4e9af9fSdanielk1977 
1895b4e9af9fSdanielk1977   /*
1896f11bded5Sdrh   **     $db interrupt
1897f11bded5Sdrh   **
1898f11bded5Sdrh   ** Interrupt the execution of the inner-most SQL interpreter.  This
1899f11bded5Sdrh   ** causes the SQL statement to return an error of SQLITE_INTERRUPT.
1900f11bded5Sdrh   */
1901f11bded5Sdrh   case DB_INTERRUPT: {
1902f11bded5Sdrh     sqlite3_interrupt(pDb->db);
1903f11bded5Sdrh     break;
1904f11bded5Sdrh   }
1905f11bded5Sdrh 
1906f11bded5Sdrh   /*
190719e2d37fSdrh   **     $db nullvalue ?STRING?
190819e2d37fSdrh   **
190919e2d37fSdrh   ** Change text used when a NULL comes back from the database. If ?STRING?
191019e2d37fSdrh   ** is not present, then the current string used for NULL is returned.
191119e2d37fSdrh   ** If STRING is present, then STRING is returned.
191219e2d37fSdrh   **
191319e2d37fSdrh   */
191419e2d37fSdrh   case DB_NULLVALUE: {
191519e2d37fSdrh     if( objc!=2 && objc!=3 ){
191619e2d37fSdrh       Tcl_WrongNumArgs(interp, 2, objv, "NULLVALUE");
191719e2d37fSdrh       return TCL_ERROR;
191819e2d37fSdrh     }
191919e2d37fSdrh     if( objc==3 ){
192019e2d37fSdrh       int len;
192119e2d37fSdrh       char *zNull = Tcl_GetStringFromObj(objv[2], &len);
192219e2d37fSdrh       if( pDb->zNull ){
192319e2d37fSdrh         Tcl_Free(pDb->zNull);
192419e2d37fSdrh       }
192519e2d37fSdrh       if( zNull && len>0 ){
192619e2d37fSdrh         pDb->zNull = Tcl_Alloc( len + 1 );
192719e2d37fSdrh         strncpy(pDb->zNull, zNull, len);
192819e2d37fSdrh         pDb->zNull[len] = '\0';
192919e2d37fSdrh       }else{
193019e2d37fSdrh         pDb->zNull = 0;
193119e2d37fSdrh       }
193219e2d37fSdrh     }
193319e2d37fSdrh     Tcl_SetObjResult(interp, dbTextToObj(pDb->zNull));
193419e2d37fSdrh     break;
193519e2d37fSdrh   }
193619e2d37fSdrh 
193719e2d37fSdrh   /*
1938af9ff33aSdrh   **     $db last_insert_rowid
1939af9ff33aSdrh   **
1940af9ff33aSdrh   ** Return an integer which is the ROWID for the most recent insert.
1941af9ff33aSdrh   */
1942af9ff33aSdrh   case DB_LAST_INSERT_ROWID: {
1943af9ff33aSdrh     Tcl_Obj *pResult;
1944f7e678d6Sdrh     Tcl_WideInt rowid;
1945af9ff33aSdrh     if( objc!=2 ){
1946af9ff33aSdrh       Tcl_WrongNumArgs(interp, 2, objv, "");
1947af9ff33aSdrh       return TCL_ERROR;
1948af9ff33aSdrh     }
19496f8a503dSdanielk1977     rowid = sqlite3_last_insert_rowid(pDb->db);
1950af9ff33aSdrh     pResult = Tcl_GetObjResult(interp);
1951f7e678d6Sdrh     Tcl_SetWideIntObj(pResult, rowid);
1952af9ff33aSdrh     break;
1953af9ff33aSdrh   }
1954af9ff33aSdrh 
1955af9ff33aSdrh   /*
19561807ce37Sdrh   ** The DB_ONECOLUMN method is implemented together with DB_EVAL.
19575d9d7576Sdrh   */
19581807ce37Sdrh 
19591807ce37Sdrh   /*    $db progress ?N CALLBACK?
19601807ce37Sdrh   **
19611807ce37Sdrh   ** Invoke the given callback every N virtual machine opcodes while executing
19621807ce37Sdrh   ** queries.
19631807ce37Sdrh   */
19641807ce37Sdrh   case DB_PROGRESS: {
19651807ce37Sdrh     if( objc==2 ){
19661807ce37Sdrh       if( pDb->zProgress ){
19671807ce37Sdrh         Tcl_AppendResult(interp, pDb->zProgress, 0);
19685d9d7576Sdrh       }
19691807ce37Sdrh     }else if( objc==4 ){
19701807ce37Sdrh       char *zProgress;
19711807ce37Sdrh       int len;
19721807ce37Sdrh       int N;
19731807ce37Sdrh       if( TCL_OK!=Tcl_GetIntFromObj(interp, objv[2], &N) ){
19741807ce37Sdrh 	return TCL_ERROR;
19751807ce37Sdrh       };
19761807ce37Sdrh       if( pDb->zProgress ){
19771807ce37Sdrh         Tcl_Free(pDb->zProgress);
19781807ce37Sdrh       }
19791807ce37Sdrh       zProgress = Tcl_GetStringFromObj(objv[3], &len);
19801807ce37Sdrh       if( zProgress && len>0 ){
19811807ce37Sdrh         pDb->zProgress = Tcl_Alloc( len + 1 );
19825bb3eb9bSdrh         memcpy(pDb->zProgress, zProgress, len+1);
19831807ce37Sdrh       }else{
19841807ce37Sdrh         pDb->zProgress = 0;
19851807ce37Sdrh       }
19861807ce37Sdrh #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
19871807ce37Sdrh       if( pDb->zProgress ){
19881807ce37Sdrh         pDb->interp = interp;
19891807ce37Sdrh         sqlite3_progress_handler(pDb->db, N, DbProgressHandler, pDb);
19901807ce37Sdrh       }else{
19911807ce37Sdrh         sqlite3_progress_handler(pDb->db, 0, 0, 0);
19921807ce37Sdrh       }
19931807ce37Sdrh #endif
19941807ce37Sdrh     }else{
19951807ce37Sdrh       Tcl_WrongNumArgs(interp, 2, objv, "N CALLBACK");
19961807ce37Sdrh       return TCL_ERROR;
19975d9d7576Sdrh     }
19985d9d7576Sdrh     break;
19995d9d7576Sdrh   }
20005d9d7576Sdrh 
200119e2d37fSdrh   /*    $db profile ?CALLBACK?
200219e2d37fSdrh   **
200319e2d37fSdrh   ** Make arrangements to invoke the CALLBACK routine after each SQL statement
200419e2d37fSdrh   ** that has run.  The text of the SQL and the amount of elapse time are
200519e2d37fSdrh   ** appended to CALLBACK before the script is run.
200619e2d37fSdrh   */
200719e2d37fSdrh   case DB_PROFILE: {
200819e2d37fSdrh     if( objc>3 ){
200919e2d37fSdrh       Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
201019e2d37fSdrh       return TCL_ERROR;
201119e2d37fSdrh     }else if( objc==2 ){
201219e2d37fSdrh       if( pDb->zProfile ){
201319e2d37fSdrh         Tcl_AppendResult(interp, pDb->zProfile, 0);
201419e2d37fSdrh       }
201519e2d37fSdrh     }else{
201619e2d37fSdrh       char *zProfile;
201719e2d37fSdrh       int len;
201819e2d37fSdrh       if( pDb->zProfile ){
201919e2d37fSdrh         Tcl_Free(pDb->zProfile);
202019e2d37fSdrh       }
202119e2d37fSdrh       zProfile = Tcl_GetStringFromObj(objv[2], &len);
202219e2d37fSdrh       if( zProfile && len>0 ){
202319e2d37fSdrh         pDb->zProfile = Tcl_Alloc( len + 1 );
20245bb3eb9bSdrh         memcpy(pDb->zProfile, zProfile, len+1);
202519e2d37fSdrh       }else{
202619e2d37fSdrh         pDb->zProfile = 0;
202719e2d37fSdrh       }
202819e2d37fSdrh #ifndef SQLITE_OMIT_TRACE
202919e2d37fSdrh       if( pDb->zProfile ){
203019e2d37fSdrh         pDb->interp = interp;
203119e2d37fSdrh         sqlite3_profile(pDb->db, DbProfileHandler, pDb);
203219e2d37fSdrh       }else{
203319e2d37fSdrh         sqlite3_profile(pDb->db, 0, 0);
203419e2d37fSdrh       }
203519e2d37fSdrh #endif
203619e2d37fSdrh     }
203719e2d37fSdrh     break;
203819e2d37fSdrh   }
203919e2d37fSdrh 
20405d9d7576Sdrh   /*
204122fbcb8dSdrh   **     $db rekey KEY
204222fbcb8dSdrh   **
204322fbcb8dSdrh   ** Change the encryption key on the currently open database.
204422fbcb8dSdrh   */
204522fbcb8dSdrh   case DB_REKEY: {
204622fbcb8dSdrh     int nKey;
204722fbcb8dSdrh     void *pKey;
204822fbcb8dSdrh     if( objc!=3 ){
204922fbcb8dSdrh       Tcl_WrongNumArgs(interp, 2, objv, "KEY");
205022fbcb8dSdrh       return TCL_ERROR;
205122fbcb8dSdrh     }
205222fbcb8dSdrh     pKey = Tcl_GetByteArrayFromObj(objv[2], &nKey);
20539eb9e26bSdrh #ifdef SQLITE_HAS_CODEC
20542011d5f5Sdrh     rc = sqlite3_rekey(pDb->db, pKey, nKey);
205522fbcb8dSdrh     if( rc ){
2056f20b21c8Sdanielk1977       Tcl_AppendResult(interp, sqlite3ErrStr(rc), 0);
205722fbcb8dSdrh       rc = TCL_ERROR;
205822fbcb8dSdrh     }
205922fbcb8dSdrh #endif
206022fbcb8dSdrh     break;
206122fbcb8dSdrh   }
206222fbcb8dSdrh 
206322fbcb8dSdrh   /*
2064bec3f402Sdrh   **     $db timeout MILLESECONDS
2065bec3f402Sdrh   **
2066bec3f402Sdrh   ** Delay for the number of milliseconds specified when a file is locked.
2067bec3f402Sdrh   */
20686d31316cSdrh   case DB_TIMEOUT: {
2069bec3f402Sdrh     int ms;
20706d31316cSdrh     if( objc!=3 ){
20716d31316cSdrh       Tcl_WrongNumArgs(interp, 2, objv, "MILLISECONDS");
2072bec3f402Sdrh       return TCL_ERROR;
207375897234Sdrh     }
20746d31316cSdrh     if( Tcl_GetIntFromObj(interp, objv[2], &ms) ) return TCL_ERROR;
20756f8a503dSdanielk1977     sqlite3_busy_timeout(pDb->db, ms);
20766d31316cSdrh     break;
207775897234Sdrh   }
2078b5a20d3cSdrh 
20790f14e2ebSdrh   /*
20800f14e2ebSdrh   **     $db total_changes
20810f14e2ebSdrh   **
20820f14e2ebSdrh   ** Return the number of rows that were modified, inserted, or deleted
20830f14e2ebSdrh   ** since the database handle was created.
20840f14e2ebSdrh   */
20850f14e2ebSdrh   case DB_TOTAL_CHANGES: {
20860f14e2ebSdrh     Tcl_Obj *pResult;
20870f14e2ebSdrh     if( objc!=2 ){
20880f14e2ebSdrh       Tcl_WrongNumArgs(interp, 2, objv, "");
20890f14e2ebSdrh       return TCL_ERROR;
20900f14e2ebSdrh     }
20910f14e2ebSdrh     pResult = Tcl_GetObjResult(interp);
20920f14e2ebSdrh     Tcl_SetIntObj(pResult, sqlite3_total_changes(pDb->db));
20930f14e2ebSdrh     break;
20940f14e2ebSdrh   }
20950f14e2ebSdrh 
2096b5a20d3cSdrh   /*    $db trace ?CALLBACK?
2097b5a20d3cSdrh   **
2098b5a20d3cSdrh   ** Make arrangements to invoke the CALLBACK routine for each SQL statement
2099b5a20d3cSdrh   ** that is executed.  The text of the SQL is appended to CALLBACK before
2100b5a20d3cSdrh   ** it is executed.
2101b5a20d3cSdrh   */
2102b5a20d3cSdrh   case DB_TRACE: {
2103b5a20d3cSdrh     if( objc>3 ){
2104b5a20d3cSdrh       Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
2105b97759edSdrh       return TCL_ERROR;
2106b5a20d3cSdrh     }else if( objc==2 ){
2107b5a20d3cSdrh       if( pDb->zTrace ){
2108b5a20d3cSdrh         Tcl_AppendResult(interp, pDb->zTrace, 0);
2109b5a20d3cSdrh       }
2110b5a20d3cSdrh     }else{
2111b5a20d3cSdrh       char *zTrace;
2112b5a20d3cSdrh       int len;
2113b5a20d3cSdrh       if( pDb->zTrace ){
2114b5a20d3cSdrh         Tcl_Free(pDb->zTrace);
2115b5a20d3cSdrh       }
2116b5a20d3cSdrh       zTrace = Tcl_GetStringFromObj(objv[2], &len);
2117b5a20d3cSdrh       if( zTrace && len>0 ){
2118b5a20d3cSdrh         pDb->zTrace = Tcl_Alloc( len + 1 );
21195bb3eb9bSdrh         memcpy(pDb->zTrace, zTrace, len+1);
2120b5a20d3cSdrh       }else{
2121b5a20d3cSdrh         pDb->zTrace = 0;
2122b5a20d3cSdrh       }
212319e2d37fSdrh #ifndef SQLITE_OMIT_TRACE
2124b5a20d3cSdrh       if( pDb->zTrace ){
2125b5a20d3cSdrh         pDb->interp = interp;
21266f8a503dSdanielk1977         sqlite3_trace(pDb->db, DbTraceHandler, pDb);
2127b5a20d3cSdrh       }else{
21286f8a503dSdanielk1977         sqlite3_trace(pDb->db, 0, 0);
2129b5a20d3cSdrh       }
213019e2d37fSdrh #endif
2131b5a20d3cSdrh     }
2132b5a20d3cSdrh     break;
2133b5a20d3cSdrh   }
2134b5a20d3cSdrh 
21353d21423cSdrh   /*    $db transaction [-deferred|-immediate|-exclusive] SCRIPT
21363d21423cSdrh   **
21373d21423cSdrh   ** Start a new transaction (if we are not already in the midst of a
21383d21423cSdrh   ** transaction) and execute the TCL script SCRIPT.  After SCRIPT
21393d21423cSdrh   ** completes, either commit the transaction or roll it back if SCRIPT
21403d21423cSdrh   ** throws an exception.  Or if no new transation was started, do nothing.
21413d21423cSdrh   ** pass the exception on up the stack.
21423d21423cSdrh   **
21433d21423cSdrh   ** This command was inspired by Dave Thomas's talk on Ruby at the
21443d21423cSdrh   ** 2005 O'Reilly Open Source Convention (OSCON).
21453d21423cSdrh   */
21463d21423cSdrh   case DB_TRANSACTION: {
21473d21423cSdrh     int inTrans;
21483d21423cSdrh     Tcl_Obj *pScript;
21493d21423cSdrh     const char *zBegin = "BEGIN";
21503d21423cSdrh     if( objc!=3 && objc!=4 ){
21513d21423cSdrh       Tcl_WrongNumArgs(interp, 2, objv, "[TYPE] SCRIPT");
21523d21423cSdrh       return TCL_ERROR;
21533d21423cSdrh     }
21543d21423cSdrh     if( objc==3 ){
21553d21423cSdrh       pScript = objv[2];
21563d21423cSdrh     } else {
21573d21423cSdrh       static const char *TTYPE_strs[] = {
2158ce604012Sdrh         "deferred",   "exclusive",  "immediate", 0
21593d21423cSdrh       };
21603d21423cSdrh       enum TTYPE_enum {
21613d21423cSdrh         TTYPE_DEFERRED, TTYPE_EXCLUSIVE, TTYPE_IMMEDIATE
21623d21423cSdrh       };
21633d21423cSdrh       int ttype;
2164b5555e7eSdrh       if( Tcl_GetIndexFromObj(interp, objv[2], TTYPE_strs, "transaction type",
21653d21423cSdrh                               0, &ttype) ){
21663d21423cSdrh         return TCL_ERROR;
21673d21423cSdrh       }
21683d21423cSdrh       switch( (enum TTYPE_enum)ttype ){
21693d21423cSdrh         case TTYPE_DEFERRED:    /* no-op */;                 break;
21703d21423cSdrh         case TTYPE_EXCLUSIVE:   zBegin = "BEGIN EXCLUSIVE";  break;
21713d21423cSdrh         case TTYPE_IMMEDIATE:   zBegin = "BEGIN IMMEDIATE";  break;
21723d21423cSdrh       }
21733d21423cSdrh       pScript = objv[3];
21743d21423cSdrh     }
21753d21423cSdrh     inTrans = !sqlite3_get_autocommit(pDb->db);
21763d21423cSdrh     if( !inTrans ){
21773752785fSdrh       (void)sqlite3_exec(pDb->db, zBegin, 0, 0, 0);
21783d21423cSdrh     }
21793d21423cSdrh     rc = Tcl_EvalObjEx(interp, pScript, 0);
21803d21423cSdrh     if( !inTrans ){
21813d21423cSdrh       const char *zEnd;
21823d21423cSdrh       if( rc==TCL_ERROR ){
21833d21423cSdrh         zEnd = "ROLLBACK";
21843d21423cSdrh       } else {
21853d21423cSdrh         zEnd = "COMMIT";
21863d21423cSdrh       }
21873752785fSdrh       (void)sqlite3_exec(pDb->db, zEnd, 0, 0, 0);
21883d21423cSdrh     }
21893d21423cSdrh     break;
21903d21423cSdrh   }
21913d21423cSdrh 
219294eb6a14Sdanielk1977   /*
219394eb6a14Sdanielk1977   **    $db update_hook ?script?
219471fd80bfSdanielk1977   **    $db rollback_hook ?script?
219594eb6a14Sdanielk1977   */
219671fd80bfSdanielk1977   case DB_UPDATE_HOOK:
219771fd80bfSdanielk1977   case DB_ROLLBACK_HOOK: {
219871fd80bfSdanielk1977 
219971fd80bfSdanielk1977     /* set ppHook to point at pUpdateHook or pRollbackHook, depending on
220071fd80bfSdanielk1977     ** whether [$db update_hook] or [$db rollback_hook] was invoked.
220171fd80bfSdanielk1977     */
220271fd80bfSdanielk1977     Tcl_Obj **ppHook;
220371fd80bfSdanielk1977     if( choice==DB_UPDATE_HOOK ){
220471fd80bfSdanielk1977       ppHook = &pDb->pUpdateHook;
220571fd80bfSdanielk1977     }else{
220671fd80bfSdanielk1977       ppHook = &pDb->pRollbackHook;
220771fd80bfSdanielk1977     }
220871fd80bfSdanielk1977 
220994eb6a14Sdanielk1977     if( objc!=2 && objc!=3 ){
221094eb6a14Sdanielk1977        Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
221194eb6a14Sdanielk1977        return TCL_ERROR;
221294eb6a14Sdanielk1977     }
221371fd80bfSdanielk1977     if( *ppHook ){
221471fd80bfSdanielk1977       Tcl_SetObjResult(interp, *ppHook);
221594eb6a14Sdanielk1977       if( objc==3 ){
221671fd80bfSdanielk1977         Tcl_DecrRefCount(*ppHook);
221771fd80bfSdanielk1977         *ppHook = 0;
221894eb6a14Sdanielk1977       }
221994eb6a14Sdanielk1977     }
222094eb6a14Sdanielk1977     if( objc==3 ){
222171fd80bfSdanielk1977       assert( !(*ppHook) );
222294eb6a14Sdanielk1977       if( Tcl_GetCharLength(objv[2])>0 ){
222371fd80bfSdanielk1977         *ppHook = objv[2];
222471fd80bfSdanielk1977         Tcl_IncrRefCount(*ppHook);
222594eb6a14Sdanielk1977       }
222694eb6a14Sdanielk1977     }
222771fd80bfSdanielk1977 
222871fd80bfSdanielk1977     sqlite3_update_hook(pDb->db, (pDb->pUpdateHook?DbUpdateHandler:0), pDb);
222971fd80bfSdanielk1977     sqlite3_rollback_hook(pDb->db,(pDb->pRollbackHook?DbRollbackHandler:0),pDb);
223071fd80bfSdanielk1977 
223194eb6a14Sdanielk1977     break;
223294eb6a14Sdanielk1977   }
223394eb6a14Sdanielk1977 
22344397de57Sdanielk1977   /*    $db version
22354397de57Sdanielk1977   **
22364397de57Sdanielk1977   ** Return the version string for this database.
22374397de57Sdanielk1977   */
22384397de57Sdanielk1977   case DB_VERSION: {
22394397de57Sdanielk1977     Tcl_SetResult(interp, (char *)sqlite3_libversion(), TCL_STATIC);
22404397de57Sdanielk1977     break;
22414397de57Sdanielk1977   }
22424397de57Sdanielk1977 
22431067fe11Stpoindex 
22446d31316cSdrh   } /* End of the SWITCH statement */
224522fbcb8dSdrh   return rc;
224675897234Sdrh }
224775897234Sdrh 
224875897234Sdrh /*
22499bb575fdSdrh **   sqlite3 DBNAME FILENAME ?MODE? ?-key KEY?
225075897234Sdrh **
225175897234Sdrh ** This is the main Tcl command.  When the "sqlite" Tcl command is
225275897234Sdrh ** invoked, this routine runs to process that command.
225375897234Sdrh **
225475897234Sdrh ** The first argument, DBNAME, is an arbitrary name for a new
225575897234Sdrh ** database connection.  This command creates a new command named
225675897234Sdrh ** DBNAME that is used to control that connection.  The database
225775897234Sdrh ** connection is deleted when the DBNAME command is deleted.
225875897234Sdrh **
225975897234Sdrh ** The second argument is the name of the directory that contains
226075897234Sdrh ** the sqlite database that is to be accessed.
2261fbc3eab8Sdrh **
2262fbc3eab8Sdrh ** For testing purposes, we also support the following:
2263fbc3eab8Sdrh **
22649bb575fdSdrh **  sqlite3 -encoding
2265fbc3eab8Sdrh **
2266fbc3eab8Sdrh **       Return the encoding used by LIKE and GLOB operators.  Choices
2267fbc3eab8Sdrh **       are UTF-8 and iso8859.
2268fbc3eab8Sdrh **
22699bb575fdSdrh **  sqlite3 -version
2270647cb0e1Sdrh **
2271647cb0e1Sdrh **       Return the version number of the SQLite library.
2272647cb0e1Sdrh **
22739bb575fdSdrh **  sqlite3 -tcl-uses-utf
2274fbc3eab8Sdrh **
2275fbc3eab8Sdrh **       Return "1" if compiled with a Tcl uses UTF-8.  Return "0" if
2276fbc3eab8Sdrh **       not.  Used by tests to make sure the library was compiled
2277fbc3eab8Sdrh **       correctly.
227875897234Sdrh */
227922fbcb8dSdrh static int DbMain(void *cd, Tcl_Interp *interp, int objc,Tcl_Obj *const*objv){
2280bec3f402Sdrh   SqliteDb *p;
228122fbcb8dSdrh   void *pKey = 0;
228222fbcb8dSdrh   int nKey = 0;
228322fbcb8dSdrh   const char *zArg;
228475897234Sdrh   char *zErrMsg;
228522fbcb8dSdrh   const char *zFile;
2286882e8e4dSdrh   Tcl_DString translatedFilename;
228722fbcb8dSdrh   if( objc==2 ){
228822fbcb8dSdrh     zArg = Tcl_GetStringFromObj(objv[1], 0);
228922fbcb8dSdrh     if( strcmp(zArg,"-version")==0 ){
22906f8a503dSdanielk1977       Tcl_AppendResult(interp,sqlite3_version,0);
2291647cb0e1Sdrh       return TCL_OK;
2292647cb0e1Sdrh     }
22939eb9e26bSdrh     if( strcmp(zArg,"-has-codec")==0 ){
22949eb9e26bSdrh #ifdef SQLITE_HAS_CODEC
229522fbcb8dSdrh       Tcl_AppendResult(interp,"1",0);
229622fbcb8dSdrh #else
229722fbcb8dSdrh       Tcl_AppendResult(interp,"0",0);
229822fbcb8dSdrh #endif
229922fbcb8dSdrh       return TCL_OK;
230022fbcb8dSdrh     }
230122fbcb8dSdrh     if( strcmp(zArg,"-tcl-uses-utf")==0 ){
2302fbc3eab8Sdrh #ifdef TCL_UTF_MAX
2303fbc3eab8Sdrh       Tcl_AppendResult(interp,"1",0);
2304fbc3eab8Sdrh #else
2305fbc3eab8Sdrh       Tcl_AppendResult(interp,"0",0);
2306fbc3eab8Sdrh #endif
2307fbc3eab8Sdrh       return TCL_OK;
2308fbc3eab8Sdrh     }
2309fbc3eab8Sdrh   }
231022fbcb8dSdrh   if( objc==5 || objc==6 ){
231122fbcb8dSdrh     zArg = Tcl_GetStringFromObj(objv[objc-2], 0);
231222fbcb8dSdrh     if( strcmp(zArg,"-key")==0 ){
231322fbcb8dSdrh       pKey = Tcl_GetByteArrayFromObj(objv[objc-1], &nKey);
231422fbcb8dSdrh       objc -= 2;
231522fbcb8dSdrh     }
231622fbcb8dSdrh   }
231722fbcb8dSdrh   if( objc!=3 && objc!=4 ){
231822fbcb8dSdrh     Tcl_WrongNumArgs(interp, 1, objv,
23199eb9e26bSdrh #ifdef SQLITE_HAS_CODEC
23209eb9e26bSdrh       "HANDLE FILENAME ?-key CODEC-KEY?"
232122fbcb8dSdrh #else
232222fbcb8dSdrh       "HANDLE FILENAME ?MODE?"
232322fbcb8dSdrh #endif
232422fbcb8dSdrh     );
232575897234Sdrh     return TCL_ERROR;
232675897234Sdrh   }
232775897234Sdrh   zErrMsg = 0;
23284cdc9e84Sdrh   p = (SqliteDb*)Tcl_Alloc( sizeof(*p) );
232975897234Sdrh   if( p==0 ){
2330bec3f402Sdrh     Tcl_SetResult(interp, "malloc failed", TCL_STATIC);
2331bec3f402Sdrh     return TCL_ERROR;
2332bec3f402Sdrh   }
2333bec3f402Sdrh   memset(p, 0, sizeof(*p));
233422fbcb8dSdrh   zFile = Tcl_GetStringFromObj(objv[2], 0);
2335882e8e4dSdrh   zFile = Tcl_TranslateFileName(interp, zFile, &translatedFilename);
23364f057f90Sdanielk1977   sqlite3_open(zFile, &p->db);
2337882e8e4dSdrh   Tcl_DStringFree(&translatedFilename);
233880290863Sdanielk1977   if( SQLITE_OK!=sqlite3_errcode(p->db) ){
23399404d50eSdrh     zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(p->db));
234080290863Sdanielk1977     sqlite3_close(p->db);
234180290863Sdanielk1977     p->db = 0;
234280290863Sdanielk1977   }
23432011d5f5Sdrh #ifdef SQLITE_HAS_CODEC
23442011d5f5Sdrh   sqlite3_key(p->db, pKey, nKey);
2345eb8ed70dSdrh #endif
2346bec3f402Sdrh   if( p->db==0 ){
234775897234Sdrh     Tcl_SetResult(interp, zErrMsg, TCL_VOLATILE);
2348bec3f402Sdrh     Tcl_Free((char*)p);
23499404d50eSdrh     sqlite3_free(zErrMsg);
235075897234Sdrh     return TCL_ERROR;
235175897234Sdrh   }
2352fb7e7651Sdrh   p->maxStmt = NUM_PREPARED_STMTS;
23535169bbc6Sdrh   p->interp = interp;
235422fbcb8dSdrh   zArg = Tcl_GetStringFromObj(objv[1], 0);
235522fbcb8dSdrh   Tcl_CreateObjCommand(interp, zArg, DbObjCmd, (char*)p, DbDeleteCmd);
2356c22bd47dSdrh 
2357c22bd47dSdrh   /* If compiled with SQLITE_TEST turned on, then register the "md5sum"
235806b2718aSdrh   ** SQL function.
2359c22bd47dSdrh   */
236028b4e489Sdrh #ifdef SQLITE_TEST
236128b4e489Sdrh   {
23629bb575fdSdrh     extern void Md5_Register(sqlite3*);
23633b93bc8cSdrh #ifdef SQLITE_MEMDEBUG
236413073931Sdanielk1977     int mallocfail = sqlite3_iMallocFail;
236513073931Sdanielk1977     sqlite3_iMallocFail = 0;
23665b59af85Sdanielk1977 #endif
236728b4e489Sdrh     Md5_Register(p->db);
23683b93bc8cSdrh #ifdef SQLITE_MEMDEBUG
236913073931Sdanielk1977     sqlite3_iMallocFail = mallocfail;
23705b59af85Sdanielk1977 #endif
237128b4e489Sdrh   }
237228b4e489Sdrh #endif
237375897234Sdrh   return TCL_OK;
237475897234Sdrh }
237575897234Sdrh 
237675897234Sdrh /*
237790ca9753Sdrh ** Provide a dummy Tcl_InitStubs if we are using this as a static
237890ca9753Sdrh ** library.
237990ca9753Sdrh */
238090ca9753Sdrh #ifndef USE_TCL_STUBS
238190ca9753Sdrh # undef  Tcl_InitStubs
238290ca9753Sdrh # define Tcl_InitStubs(a,b,c)
238390ca9753Sdrh #endif
238490ca9753Sdrh 
238590ca9753Sdrh /*
238629bc4615Sdrh ** Make sure we have a PACKAGE_VERSION macro defined.  This will be
238729bc4615Sdrh ** defined automatically by the TEA makefile.  But other makefiles
238829bc4615Sdrh ** do not define it.
238929bc4615Sdrh */
239029bc4615Sdrh #ifndef PACKAGE_VERSION
239129bc4615Sdrh # define PACKAGE_VERSION SQLITE_VERSION
239229bc4615Sdrh #endif
239329bc4615Sdrh 
239429bc4615Sdrh /*
239575897234Sdrh ** Initialize this module.
239675897234Sdrh **
239775897234Sdrh ** This Tcl module contains only a single new Tcl command named "sqlite".
239875897234Sdrh ** (Hence there is no namespace.  There is no point in using a namespace
239975897234Sdrh ** if the extension only supplies one new name!)  The "sqlite" command is
240075897234Sdrh ** used to open a new SQLite database.  See the DbMain() routine above
240175897234Sdrh ** for additional information.
240275897234Sdrh */
2403ad6e1370Sdrh EXTERN int Sqlite3_Init(Tcl_Interp *interp){
240492febd92Sdrh   Tcl_InitStubs(interp, "8.4", 0);
2405ef4ac8f9Sdrh   Tcl_CreateObjCommand(interp, "sqlite3", (Tcl_ObjCmdProc*)DbMain, 0, 0);
240629bc4615Sdrh   Tcl_PkgProvide(interp, "sqlite3", PACKAGE_VERSION);
240749766d6cSdrh   Tcl_CreateObjCommand(interp, "sqlite", (Tcl_ObjCmdProc*)DbMain, 0, 0);
240829bc4615Sdrh   Tcl_PkgProvide(interp, "sqlite", PACKAGE_VERSION);
240990ca9753Sdrh   return TCL_OK;
241090ca9753Sdrh }
2411ad6e1370Sdrh EXTERN int Tclsqlite3_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2412ad6e1370Sdrh EXTERN int Sqlite3_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
2413ad6e1370Sdrh EXTERN int Tclsqlite3_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
241449766d6cSdrh 
241549766d6cSdrh #ifndef SQLITE_3_SUFFIX_ONLY
2416ad6e1370Sdrh EXTERN int Sqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2417ad6e1370Sdrh EXTERN int Tclsqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2418ad6e1370Sdrh EXTERN int Sqlite_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
2419ad6e1370Sdrh EXTERN int Tclsqlite_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
242049766d6cSdrh #endif
242175897234Sdrh 
24223e27c026Sdrh #ifdef TCLSH
24233e27c026Sdrh /*****************************************************************************
24243e27c026Sdrh ** The code that follows is used to build standalone TCL interpreters
242575897234Sdrh */
2426348784efSdrh 
2427348784efSdrh /*
24283e27c026Sdrh ** If the macro TCLSH is one, then put in code this for the
24293e27c026Sdrh ** "main" routine that will initialize Tcl and take input from
24303e27c026Sdrh ** standard input.
2431348784efSdrh */
24323e27c026Sdrh #if TCLSH==1
2433348784efSdrh static char zMainloop[] =
2434348784efSdrh   "set line {}\n"
2435348784efSdrh   "while {![eof stdin]} {\n"
2436348784efSdrh     "if {$line!=\"\"} {\n"
2437348784efSdrh       "puts -nonewline \"> \"\n"
2438348784efSdrh     "} else {\n"
2439348784efSdrh       "puts -nonewline \"% \"\n"
2440348784efSdrh     "}\n"
2441348784efSdrh     "flush stdout\n"
2442348784efSdrh     "append line [gets stdin]\n"
2443348784efSdrh     "if {[info complete $line]} {\n"
2444348784efSdrh       "if {[catch {uplevel #0 $line} result]} {\n"
2445348784efSdrh         "puts stderr \"Error: $result\"\n"
2446348784efSdrh       "} elseif {$result!=\"\"} {\n"
2447348784efSdrh         "puts $result\n"
2448348784efSdrh       "}\n"
2449348784efSdrh       "set line {}\n"
2450348784efSdrh     "} else {\n"
2451348784efSdrh       "append line \\n\n"
2452348784efSdrh     "}\n"
2453348784efSdrh   "}\n"
2454348784efSdrh ;
24553e27c026Sdrh #endif
24563e27c026Sdrh 
24573e27c026Sdrh /*
24583e27c026Sdrh ** If the macro TCLSH is two, then get the main loop code out of
24593e27c026Sdrh ** the separate file "spaceanal_tcl.h".
24603e27c026Sdrh */
24613e27c026Sdrh #if TCLSH==2
24623e27c026Sdrh static char zMainloop[] =
24633e27c026Sdrh #include "spaceanal_tcl.h"
24643e27c026Sdrh ;
24653e27c026Sdrh #endif
2466348784efSdrh 
2467348784efSdrh #define TCLSH_MAIN main   /* Needed to fake out mktclapp */
2468348784efSdrh int TCLSH_MAIN(int argc, char **argv){
2469348784efSdrh   Tcl_Interp *interp;
2470297ecf14Sdrh   Tcl_FindExecutable(argv[0]);
2471348784efSdrh   interp = Tcl_CreateInterp();
247238f8271fSdrh   Sqlite3_Init(interp);
2473d9b0257aSdrh #ifdef SQLITE_TEST
2474d1bf3512Sdrh   {
2475d1bf3512Sdrh     extern int Sqlitetest1_Init(Tcl_Interp*);
24765c4d9703Sdrh     extern int Sqlitetest2_Init(Tcl_Interp*);
24775c4d9703Sdrh     extern int Sqlitetest3_Init(Tcl_Interp*);
2478a6064dcfSdrh     extern int Sqlitetest4_Init(Tcl_Interp*);
2479998b56c3Sdanielk1977     extern int Sqlitetest5_Init(Tcl_Interp*);
24809c06c953Sdrh     extern int Sqlitetest6_Init(Tcl_Interp*);
248129c636bcSdrh     extern int Sqlitetest7_Init(Tcl_Interp*);
2482b9bb7c18Sdrh     extern int Sqlitetest8_Init(Tcl_Interp*);
2483a713f2c3Sdanielk1977     extern int Sqlitetest9_Init(Tcl_Interp*);
2484efc251daSdrh     extern int Md5_Init(Tcl_Interp*);
24852e66f0b9Sdrh     extern int Sqlitetestsse_Init(Tcl_Interp*);
24862366940dSdrh     extern int Sqlitetestasync_Init(Tcl_Interp*);
24874be8b51eSdrh     extern int Sqlitetesttclvar_Init(Tcl_Interp*);
2488954ce99cSdanielk1977     extern int Sqlitetestschema_Init(Tcl_Interp*);
24891409be69Sdrh     extern int Sqlitetest_autoext_Init(Tcl_Interp*);
249015926590Sdrh     extern int Sqlitetest_hexio_Init(Tcl_Interp*);
24912e66f0b9Sdrh 
24926490bebdSdanielk1977     Sqlitetest1_Init(interp);
24935c4d9703Sdrh     Sqlitetest2_Init(interp);
2494de647130Sdrh     Sqlitetest3_Init(interp);
2495fc57d7bfSdanielk1977     Sqlitetest4_Init(interp);
2496998b56c3Sdanielk1977     Sqlitetest5_Init(interp);
24979c06c953Sdrh     Sqlitetest6_Init(interp);
249829c636bcSdrh     Sqlitetest7_Init(interp);
2499b9bb7c18Sdrh     Sqlitetest8_Init(interp);
2500a713f2c3Sdanielk1977     Sqlitetest9_Init(interp);
25012366940dSdrh     Sqlitetestasync_Init(interp);
25024be8b51eSdrh     Sqlitetesttclvar_Init(interp);
2503954ce99cSdanielk1977     Sqlitetestschema_Init(interp);
25041409be69Sdrh     Sqlitetest_autoext_Init(interp);
250515926590Sdrh     Sqlitetest_hexio_Init(interp);
2506efc251daSdrh     Md5_Init(interp);
250789dec819Sdrh #ifdef SQLITE_SSE
25082e66f0b9Sdrh     Sqlitetestsse_Init(interp);
25092e66f0b9Sdrh #endif
2510d1bf3512Sdrh   }
2511d1bf3512Sdrh #endif
25123e27c026Sdrh   if( argc>=2 || TCLSH==2 ){
2513348784efSdrh     int i;
2514ad42c3a3Sshess     char zArgc[32];
2515ad42c3a3Sshess     sqlite3_snprintf(sizeof(zArgc), zArgc, "%d", argc-(3-TCLSH));
2516ad42c3a3Sshess     Tcl_SetVar(interp,"argc", zArgc, TCL_GLOBAL_ONLY);
2517348784efSdrh     Tcl_SetVar(interp,"argv0",argv[1],TCL_GLOBAL_ONLY);
2518348784efSdrh     Tcl_SetVar(interp,"argv", "", TCL_GLOBAL_ONLY);
251961212b69Sdrh     for(i=3-TCLSH; i<argc; i++){
2520348784efSdrh       Tcl_SetVar(interp, "argv", argv[i],
2521348784efSdrh           TCL_GLOBAL_ONLY | TCL_LIST_ELEMENT | TCL_APPEND_VALUE);
2522348784efSdrh     }
25233e27c026Sdrh     if( TCLSH==1 && Tcl_EvalFile(interp, argv[1])!=TCL_OK ){
25240de8c112Sdrh       const char *zInfo = Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY);
2525c61053b7Sdrh       if( zInfo==0 ) zInfo = interp->result;
2526c61053b7Sdrh       fprintf(stderr,"%s: %s\n", *argv, zInfo);
2527348784efSdrh       return 1;
2528348784efSdrh     }
25293e27c026Sdrh   }
25303e27c026Sdrh   if( argc<=1 || TCLSH==2 ){
2531348784efSdrh     Tcl_GlobalEval(interp, zMainloop);
2532348784efSdrh   }
2533348784efSdrh   return 0;
2534348784efSdrh }
2535348784efSdrh #endif /* TCLSH */
2536