vtab.c
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:23k
源码类别:

数据库系统

开发平台:

C/C++

  1. /*
  2. ** 2006 June 10
  3. **
  4. ** The author disclaims copyright to this source code.  In place of
  5. ** a legal notice, here is a blessing:
  6. **
  7. **    May you do good and not evil.
  8. **    May you find forgiveness for yourself and forgive others.
  9. **    May you share freely, never taking more than you give.
  10. **
  11. *************************************************************************
  12. ** This file contains code used to help implement virtual tables.
  13. **
  14. ** $Id: vtab.c,v 1.66 2008/04/10 18:35:22 drh Exp $
  15. */
  16. #ifndef SQLITE_OMIT_VIRTUALTABLE
  17. #include "sqliteInt.h"
  18. static int createModule(
  19.   sqlite3 *db,                    /* Database in which module is registered */
  20.   const char *zName,              /* Name assigned to this module */
  21.   const sqlite3_module *pModule,  /* The definition of the module */
  22.   void *pAux,                     /* Context pointer for xCreate/xConnect */
  23.   void (*xDestroy)(void *)        /* Module destructor function */
  24. ) {
  25.   int rc, nName;
  26.   Module *pMod;
  27.   sqlite3_mutex_enter(db->mutex);
  28.   nName = strlen(zName);
  29.   pMod = (Module *)sqlite3DbMallocRaw(db, sizeof(Module) + nName + 1);
  30.   if( pMod ){
  31.     char *zCopy = (char *)(&pMod[1]);
  32.     memcpy(zCopy, zName, nName+1);
  33.     pMod->zName = zCopy;
  34.     pMod->pModule = pModule;
  35.     pMod->pAux = pAux;
  36.     pMod->xDestroy = xDestroy;
  37.     pMod = (Module *)sqlite3HashInsert(&db->aModule, zCopy, nName, (void*)pMod);
  38.     if( pMod && pMod->xDestroy ){
  39.       pMod->xDestroy(pMod->pAux);
  40.     }
  41.     sqlite3_free(pMod);
  42.     sqlite3ResetInternalSchema(db, 0);
  43.   }
  44.   rc = sqlite3ApiExit(db, SQLITE_OK);
  45.   sqlite3_mutex_leave(db->mutex);
  46.   return rc;
  47. }
  48. /*
  49. ** External API function used to create a new virtual-table module.
  50. */
  51. int sqlite3_create_module(
  52.   sqlite3 *db,                    /* Database in which module is registered */
  53.   const char *zName,              /* Name assigned to this module */
  54.   const sqlite3_module *pModule,  /* The definition of the module */
  55.   void *pAux                      /* Context pointer for xCreate/xConnect */
  56. ){
  57.   return createModule(db, zName, pModule, pAux, 0);
  58. }
  59. /*
  60. ** External API function used to create a new virtual-table module.
  61. */
  62. int sqlite3_create_module_v2(
  63.   sqlite3 *db,                    /* Database in which module is registered */
  64.   const char *zName,              /* Name assigned to this module */
  65.   const sqlite3_module *pModule,  /* The definition of the module */
  66.   void *pAux,                     /* Context pointer for xCreate/xConnect */
  67.   void (*xDestroy)(void *)        /* Module destructor function */
  68. ){
  69.   return createModule(db, zName, pModule, pAux, xDestroy);
  70. }
  71. /*
  72. ** Lock the virtual table so that it cannot be disconnected.
  73. ** Locks nest.  Every lock should have a corresponding unlock.
  74. ** If an unlock is omitted, resources leaks will occur.  
  75. **
  76. ** If a disconnect is attempted while a virtual table is locked,
  77. ** the disconnect is deferred until all locks have been removed.
  78. */
  79. void sqlite3VtabLock(sqlite3_vtab *pVtab){
  80.   pVtab->nRef++;
  81. }
  82. /*
  83. ** Unlock a virtual table.  When the last lock is removed,
  84. ** disconnect the virtual table.
  85. */
  86. void sqlite3VtabUnlock(sqlite3 *db, sqlite3_vtab *pVtab){
  87.   pVtab->nRef--;
  88.   assert(db);
  89.   assert( sqlite3SafetyCheckOk(db) );
  90.   if( pVtab->nRef==0 ){
  91.     if( db->magic==SQLITE_MAGIC_BUSY ){
  92.       (void)sqlite3SafetyOff(db);
  93.       pVtab->pModule->xDisconnect(pVtab);
  94.       (void)sqlite3SafetyOn(db);
  95.     } else {
  96.       pVtab->pModule->xDisconnect(pVtab);
  97.     }
  98.   }
  99. }
  100. /*
  101. ** Clear any and all virtual-table information from the Table record.
  102. ** This routine is called, for example, just before deleting the Table
  103. ** record.
  104. */
  105. void sqlite3VtabClear(Table *p){
  106.   sqlite3_vtab *pVtab = p->pVtab;
  107.   if( pVtab ){
  108.     assert( p->pMod && p->pMod->pModule );
  109.     sqlite3VtabUnlock(p->pSchema->db, pVtab);
  110.     p->pVtab = 0;
  111.   }
  112.   if( p->azModuleArg ){
  113.     int i;
  114.     for(i=0; i<p->nModuleArg; i++){
  115.       sqlite3_free(p->azModuleArg[i]);
  116.     }
  117.     sqlite3_free(p->azModuleArg);
  118.   }
  119. }
  120. /*
  121. ** Add a new module argument to pTable->azModuleArg[].
  122. ** The string is not copied - the pointer is stored.  The
  123. ** string will be freed automatically when the table is
  124. ** deleted.
  125. */
  126. static void addModuleArgument(sqlite3 *db, Table *pTable, char *zArg){
  127.   int i = pTable->nModuleArg++;
  128.   int nBytes = sizeof(char *)*(1+pTable->nModuleArg);
  129.   char **azModuleArg;
  130.   azModuleArg = sqlite3DbRealloc(db, pTable->azModuleArg, nBytes);
  131.   if( azModuleArg==0 ){
  132.     int j;
  133.     for(j=0; j<i; j++){
  134.       sqlite3_free(pTable->azModuleArg[j]);
  135.     }
  136.     sqlite3_free(zArg);
  137.     sqlite3_free(pTable->azModuleArg);
  138.     pTable->nModuleArg = 0;
  139.   }else{
  140.     azModuleArg[i] = zArg;
  141.     azModuleArg[i+1] = 0;
  142.   }
  143.   pTable->azModuleArg = azModuleArg;
  144. }
  145. /*
  146. ** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
  147. ** statement.  The module name has been parsed, but the optional list
  148. ** of parameters that follow the module name are still pending.
  149. */
  150. void sqlite3VtabBeginParse(
  151.   Parse *pParse,        /* Parsing context */
  152.   Token *pName1,        /* Name of new table, or database name */
  153.   Token *pName2,        /* Name of new table or NULL */
  154.   Token *pModuleName    /* Name of the module for the virtual table */
  155. ){
  156.   int iDb;              /* The database the table is being created in */
  157.   Table *pTable;        /* The new virtual table */
  158.   sqlite3 *db;          /* Database connection */
  159.   if( pParse->db->flags & SQLITE_SharedCache ){
  160.     sqlite3ErrorMsg(pParse, "Cannot use virtual tables in shared-cache mode");
  161.     return;
  162.   }
  163.   sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, 0);
  164.   pTable = pParse->pNewTable;
  165.   if( pTable==0 || pParse->nErr ) return;
  166.   assert( 0==pTable->pIndex );
  167.   db = pParse->db;
  168.   iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
  169.   assert( iDb>=0 );
  170.   pTable->isVirtual = 1;
  171.   pTable->nModuleArg = 0;
  172.   addModuleArgument(db, pTable, sqlite3NameFromToken(db, pModuleName));
  173.   addModuleArgument(db, pTable, sqlite3DbStrDup(db, db->aDb[iDb].zName));
  174.   addModuleArgument(db, pTable, sqlite3DbStrDup(db, pTable->zName));
  175.   pParse->sNameToken.n = pModuleName->z + pModuleName->n - pName1->z;
  176. #ifndef SQLITE_OMIT_AUTHORIZATION
  177.   /* Creating a virtual table invokes the authorization callback twice.
  178.   ** The first invocation, to obtain permission to INSERT a row into the
  179.   ** sqlite_master table, has already been made by sqlite3StartTable().
  180.   ** The second call, to obtain permission to create the table, is made now.
  181.   */
  182.   if( pTable->azModuleArg ){
  183.     sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName, 
  184.             pTable->azModuleArg[0], pParse->db->aDb[iDb].zName);
  185.   }
  186. #endif
  187. }
  188. /*
  189. ** This routine takes the module argument that has been accumulating
  190. ** in pParse->zArg[] and appends it to the list of arguments on the
  191. ** virtual table currently under construction in pParse->pTable.
  192. */
  193. static void addArgumentToVtab(Parse *pParse){
  194.   if( pParse->sArg.z && pParse->pNewTable ){
  195.     const char *z = (const char*)pParse->sArg.z;
  196.     int n = pParse->sArg.n;
  197.     sqlite3 *db = pParse->db;
  198.     addModuleArgument(db, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
  199.   }
  200. }
  201. /*
  202. ** The parser calls this routine after the CREATE VIRTUAL TABLE statement
  203. ** has been completely parsed.
  204. */
  205. void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
  206.   Table *pTab;        /* The table being constructed */
  207.   sqlite3 *db;        /* The database connection */
  208.   char *zModule;      /* The module name of the table: USING modulename */
  209.   Module *pMod = 0;
  210.   addArgumentToVtab(pParse);
  211.   pParse->sArg.z = 0;
  212.   /* Lookup the module name. */
  213.   pTab = pParse->pNewTable;
  214.   if( pTab==0 ) return;
  215.   db = pParse->db;
  216.   if( pTab->nModuleArg<1 ) return;
  217.   zModule = pTab->azModuleArg[0];
  218.   pMod = (Module *)sqlite3HashFind(&db->aModule, zModule, strlen(zModule));
  219.   pTab->pMod = pMod;
  220.   
  221.   /* If the CREATE VIRTUAL TABLE statement is being entered for the
  222.   ** first time (in other words if the virtual table is actually being
  223.   ** created now instead of just being read out of sqlite_master) then
  224.   ** do additional initialization work and store the statement text
  225.   ** in the sqlite_master table.
  226.   */
  227.   if( !db->init.busy ){
  228.     char *zStmt;
  229.     char *zWhere;
  230.     int iDb;
  231.     Vdbe *v;
  232.     /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
  233.     if( pEnd ){
  234.       pParse->sNameToken.n = pEnd->z - pParse->sNameToken.z + pEnd->n;
  235.     }
  236.     zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
  237.     /* A slot for the record has already been allocated in the 
  238.     ** SQLITE_MASTER table.  We just need to update that slot with all
  239.     ** the information we've collected.  
  240.     **
  241.     ** The VM register number pParse->regRowid holds the rowid of an
  242.     ** entry in the sqlite_master table tht was created for this vtab
  243.     ** by sqlite3StartTable().
  244.     */
  245.     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  246.     sqlite3NestedParse(pParse,
  247.       "UPDATE %Q.%s "
  248.          "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
  249.        "WHERE rowid=#%d",
  250.       db->aDb[iDb].zName, SCHEMA_TABLE(iDb),
  251.       pTab->zName,
  252.       pTab->zName,
  253.       zStmt,
  254.       pParse->regRowid
  255.     );
  256.     sqlite3_free(zStmt);
  257.     v = sqlite3GetVdbe(pParse);
  258.     sqlite3ChangeCookie(pParse, iDb);
  259.     sqlite3VdbeAddOp2(v, OP_Expire, 0, 0);
  260.     zWhere = sqlite3MPrintf(db, "name='%q'", pTab->zName);
  261.     sqlite3VdbeAddOp4(v, OP_ParseSchema, iDb, 1, 0, zWhere, P4_DYNAMIC);
  262.     sqlite3VdbeAddOp4(v, OP_VCreate, iDb, 0, 0, 
  263.                          pTab->zName, strlen(pTab->zName) + 1);
  264.   }
  265.   /* If we are rereading the sqlite_master table create the in-memory
  266.   ** record of the table. If the module has already been registered,
  267.   ** also call the xConnect method here.
  268.   */
  269.   else {
  270.     Table *pOld;
  271.     Schema *pSchema = pTab->pSchema;
  272.     const char *zName = pTab->zName;
  273.     int nName = strlen(zName) + 1;
  274.     pOld = sqlite3HashInsert(&pSchema->tblHash, zName, nName, pTab);
  275.     if( pOld ){
  276.       db->mallocFailed = 1;
  277.       assert( pTab==pOld );  /* Malloc must have failed inside HashInsert() */
  278.       return;
  279.     }
  280.     pSchema->db = pParse->db;
  281.     pParse->pNewTable = 0;
  282.   }
  283. }
  284. /*
  285. ** The parser calls this routine when it sees the first token
  286. ** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
  287. */
  288. void sqlite3VtabArgInit(Parse *pParse){
  289.   addArgumentToVtab(pParse);
  290.   pParse->sArg.z = 0;
  291.   pParse->sArg.n = 0;
  292. }
  293. /*
  294. ** The parser calls this routine for each token after the first token
  295. ** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
  296. */
  297. void sqlite3VtabArgExtend(Parse *pParse, Token *p){
  298.   Token *pArg = &pParse->sArg;
  299.   if( pArg->z==0 ){
  300.     pArg->z = p->z;
  301.     pArg->n = p->n;
  302.   }else{
  303.     assert(pArg->z < p->z);
  304.     pArg->n = (p->z + p->n - pArg->z);
  305.   }
  306. }
  307. /*
  308. ** Invoke a virtual table constructor (either xCreate or xConnect). The
  309. ** pointer to the function to invoke is passed as the fourth parameter
  310. ** to this procedure.
  311. */
  312. static int vtabCallConstructor(
  313.   sqlite3 *db, 
  314.   Table *pTab,
  315.   Module *pMod,
  316.   int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
  317.   char **pzErr
  318. ){
  319.   int rc;
  320.   int rc2;
  321.   sqlite3_vtab *pVtab = 0;
  322.   const char *const*azArg = (const char *const*)pTab->azModuleArg;
  323.   int nArg = pTab->nModuleArg;
  324.   char *zErr = 0;
  325.   char *zModuleName = sqlite3MPrintf(db, "%s", pTab->zName);
  326.   if( !zModuleName ){
  327.     return SQLITE_NOMEM;
  328.   }
  329.   assert( !db->pVTab );
  330.   assert( xConstruct );
  331.   db->pVTab = pTab;
  332.   rc = sqlite3SafetyOff(db);
  333.   assert( rc==SQLITE_OK );
  334.   rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVtab, &zErr);
  335.   rc2 = sqlite3SafetyOn(db);
  336.   if( rc==SQLITE_OK && pVtab ){
  337.     pVtab->pModule = pMod->pModule;
  338.     pVtab->nRef = 1;
  339.     pTab->pVtab = pVtab;
  340.   }
  341.   if( SQLITE_OK!=rc ){
  342.     if( zErr==0 ){
  343.       *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
  344.     }else {
  345.       *pzErr = sqlite3MPrintf(db, "%s", zErr);
  346.       sqlite3_free(zErr);
  347.     }
  348.   }else if( db->pVTab ){
  349.     const char *zFormat = "vtable constructor did not declare schema: %s";
  350.     *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
  351.     rc = SQLITE_ERROR;
  352.   } 
  353.   if( rc==SQLITE_OK ){
  354.     rc = rc2;
  355.   }
  356.   db->pVTab = 0;
  357.   sqlite3_free(zModuleName);
  358.   /* If everything went according to plan, loop through the columns
  359.   ** of the table to see if any of them contain the token "hidden".
  360.   ** If so, set the Column.isHidden flag and remove the token from
  361.   ** the type string.
  362.   */
  363.   if( rc==SQLITE_OK ){
  364.     int iCol;
  365.     for(iCol=0; iCol<pTab->nCol; iCol++){
  366.       char *zType = pTab->aCol[iCol].zType;
  367.       int nType;
  368.       int i = 0;
  369.       if( !zType ) continue;
  370.       nType = strlen(zType);
  371.       if( sqlite3StrNICmp("hidden", zType, 6) || (zType[6] && zType[6]!=' ') ){
  372.         for(i=0; i<nType; i++){
  373.           if( (0==sqlite3StrNICmp(" hidden", &zType[i], 7))
  374.            && (zType[i+7]=='' || zType[i+7]==' ')
  375.           ){
  376.             i++;
  377.             break;
  378.           }
  379.         }
  380.       }
  381.       if( i<nType ){
  382.         int j;
  383.         int nDel = 6 + (zType[i+6] ? 1 : 0);
  384.         for(j=i; (j+nDel)<=nType; j++){
  385.           zType[j] = zType[j+nDel];
  386.         }
  387.         if( zType[i]=='' && i>0 ){
  388.           assert(zType[i-1]==' ');
  389.           zType[i-1] = '';
  390.         }
  391.         pTab->aCol[iCol].isHidden = 1;
  392.       }
  393.     }
  394.   }
  395.   return rc;
  396. }
  397. /*
  398. ** This function is invoked by the parser to call the xConnect() method
  399. ** of the virtual table pTab. If an error occurs, an error code is returned 
  400. ** and an error left in pParse.
  401. **
  402. ** This call is a no-op if table pTab is not a virtual table.
  403. */
  404. int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
  405.   Module *pMod;
  406.   int rc = SQLITE_OK;
  407.   if( !pTab || !pTab->isVirtual || pTab->pVtab ){
  408.     return SQLITE_OK;
  409.   }
  410.   pMod = pTab->pMod;
  411.   if( !pMod ){
  412.     const char *zModule = pTab->azModuleArg[0];
  413.     sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
  414.     rc = SQLITE_ERROR;
  415.   } else {
  416.     char *zErr = 0;
  417.     sqlite3 *db = pParse->db;
  418.     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
  419.     if( rc!=SQLITE_OK ){
  420.       sqlite3ErrorMsg(pParse, "%s", zErr);
  421.     }
  422.     sqlite3_free(zErr);
  423.   }
  424.   return rc;
  425. }
  426. /*
  427. ** Add the virtual table pVtab to the array sqlite3.aVTrans[].
  428. */
  429. static int addToVTrans(sqlite3 *db, sqlite3_vtab *pVtab){
  430.   const int ARRAY_INCR = 5;
  431.   /* Grow the sqlite3.aVTrans array if required */
  432.   if( (db->nVTrans%ARRAY_INCR)==0 ){
  433.     sqlite3_vtab **aVTrans;
  434.     int nBytes = sizeof(sqlite3_vtab *) * (db->nVTrans + ARRAY_INCR);
  435.     aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
  436.     if( !aVTrans ){
  437.       return SQLITE_NOMEM;
  438.     }
  439.     memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
  440.     db->aVTrans = aVTrans;
  441.   }
  442.   /* Add pVtab to the end of sqlite3.aVTrans */
  443.   db->aVTrans[db->nVTrans++] = pVtab;
  444.   sqlite3VtabLock(pVtab);
  445.   return SQLITE_OK;
  446. }
  447. /*
  448. ** This function is invoked by the vdbe to call the xCreate method
  449. ** of the virtual table named zTab in database iDb. 
  450. **
  451. ** If an error occurs, *pzErr is set to point an an English language
  452. ** description of the error and an SQLITE_XXX error code is returned.
  453. ** In this case the caller must call sqlite3_free() on *pzErr.
  454. */
  455. int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
  456.   int rc = SQLITE_OK;
  457.   Table *pTab;
  458.   Module *pMod;
  459.   const char *zModule;
  460.   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zName);
  461.   assert(pTab && pTab->isVirtual && !pTab->pVtab);
  462.   pMod = pTab->pMod;
  463.   zModule = pTab->azModuleArg[0];
  464.   /* If the module has been registered and includes a Create method, 
  465.   ** invoke it now. If the module has not been registered, return an 
  466.   ** error. Otherwise, do nothing.
  467.   */
  468.   if( !pMod ){
  469.     *pzErr = sqlite3MPrintf(db, "no such module: %s", zModule);
  470.     rc = SQLITE_ERROR;
  471.   }else{
  472.     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
  473.   }
  474.   if( rc==SQLITE_OK && pTab->pVtab ){
  475.       rc = addToVTrans(db, pTab->pVtab);
  476.   }
  477.   return rc;
  478. }
  479. /*
  480. ** This function is used to set the schema of a virtual table.  It is only
  481. ** valid to call this function from within the xCreate() or xConnect() of a
  482. ** virtual table module.
  483. */
  484. int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
  485.   Parse sParse;
  486.   int rc = SQLITE_OK;
  487.   Table *pTab;
  488.   char *zErr = 0;
  489.   sqlite3_mutex_enter(db->mutex);
  490.   pTab = db->pVTab;
  491.   if( !pTab ){
  492.     sqlite3Error(db, SQLITE_MISUSE, 0);
  493.     sqlite3_mutex_leave(db->mutex);
  494.     return SQLITE_MISUSE;
  495.   }
  496.   assert(pTab->isVirtual && pTab->nCol==0 && pTab->aCol==0);
  497.   memset(&sParse, 0, sizeof(Parse));
  498.   sParse.declareVtab = 1;
  499.   sParse.db = db;
  500.   if( 
  501.       SQLITE_OK == sqlite3RunParser(&sParse, zCreateTable, &zErr) && 
  502.       sParse.pNewTable && 
  503.       !sParse.pNewTable->pSelect && 
  504.       !sParse.pNewTable->isVirtual 
  505.   ){
  506.     pTab->aCol = sParse.pNewTable->aCol;
  507.     pTab->nCol = sParse.pNewTable->nCol;
  508.     sParse.pNewTable->nCol = 0;
  509.     sParse.pNewTable->aCol = 0;
  510.     db->pVTab = 0;
  511.   } else {
  512.     sqlite3Error(db, SQLITE_ERROR, zErr);
  513.     sqlite3_free(zErr);
  514.     rc = SQLITE_ERROR;
  515.   }
  516.   sParse.declareVtab = 0;
  517.   sqlite3_finalize((sqlite3_stmt*)sParse.pVdbe);
  518.   sqlite3DeleteTable(sParse.pNewTable);
  519.   sParse.pNewTable = 0;
  520.   assert( (rc&0xff)==rc );
  521.   rc = sqlite3ApiExit(db, rc);
  522.   sqlite3_mutex_leave(db->mutex);
  523.   return rc;
  524. }
  525. /*
  526. ** This function is invoked by the vdbe to call the xDestroy method
  527. ** of the virtual table named zTab in database iDb. This occurs
  528. ** when a DROP TABLE is mentioned.
  529. **
  530. ** This call is a no-op if zTab is not a virtual table.
  531. */
  532. int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab)
  533. {
  534.   int rc = SQLITE_OK;
  535.   Table *pTab;
  536.   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zName);
  537.   assert(pTab);
  538.   if( pTab->pVtab ){
  539.     int (*xDestroy)(sqlite3_vtab *pVTab) = pTab->pMod->pModule->xDestroy;
  540.     rc = sqlite3SafetyOff(db);
  541.     assert( rc==SQLITE_OK );
  542.     if( xDestroy ){
  543.       rc = xDestroy(pTab->pVtab);
  544.     }
  545.     (void)sqlite3SafetyOn(db);
  546.     if( rc==SQLITE_OK ){
  547.       int i;
  548.       for(i=0; i<db->nVTrans; i++){
  549.         if( db->aVTrans[i]==pTab->pVtab ){
  550.           db->aVTrans[i] = db->aVTrans[--db->nVTrans];
  551.           break;
  552.         }
  553.       }
  554.       pTab->pVtab = 0;
  555.     }
  556.   }
  557.   return rc;
  558. }
  559. /*
  560. ** This function invokes either the xRollback or xCommit method
  561. ** of each of the virtual tables in the sqlite3.aVTrans array. The method
  562. ** called is identified by the second argument, "offset", which is
  563. ** the offset of the method to call in the sqlite3_module structure.
  564. **
  565. ** The array is cleared after invoking the callbacks. 
  566. */
  567. static void callFinaliser(sqlite3 *db, sqlite3_intptr_t offset){
  568.   int i;
  569.   if( db->aVTrans ){
  570.     for(i=0; i<db->nVTrans && db->aVTrans[i]; i++){
  571.       sqlite3_vtab *pVtab = db->aVTrans[i];
  572.       int (*x)(sqlite3_vtab *);
  573.       x = *(int (**)(sqlite3_vtab *))((char *)pVtab->pModule + offset);
  574.       if( x ) x(pVtab);
  575.       sqlite3VtabUnlock(db, pVtab);
  576.     }
  577.     sqlite3_free(db->aVTrans);
  578.     db->nVTrans = 0;
  579.     db->aVTrans = 0;
  580.   }
  581. }
  582. /*
  583. ** If argument rc2 is not SQLITE_OK, then return it and do nothing. 
  584. ** Otherwise, invoke the xSync method of all virtual tables in the 
  585. ** sqlite3.aVTrans array. Return the error code for the first error 
  586. ** that occurs, or SQLITE_OK if all xSync operations are successful.
  587. */
  588. int sqlite3VtabSync(sqlite3 *db, int rc2){
  589.   int i;
  590.   int rc = SQLITE_OK;
  591.   int rcsafety;
  592.   sqlite3_vtab **aVTrans = db->aVTrans;
  593.   if( rc2!=SQLITE_OK ) return rc2;
  594.   rc = sqlite3SafetyOff(db);
  595.   db->aVTrans = 0;
  596.   for(i=0; rc==SQLITE_OK && i<db->nVTrans && aVTrans[i]; i++){
  597.     sqlite3_vtab *pVtab = aVTrans[i];
  598.     int (*x)(sqlite3_vtab *);
  599.     x = pVtab->pModule->xSync;
  600.     if( x ){
  601.       rc = x(pVtab);
  602.     }
  603.   }
  604.   db->aVTrans = aVTrans;
  605.   rcsafety = sqlite3SafetyOn(db);
  606.   if( rc==SQLITE_OK ){
  607.     rc = rcsafety;
  608.   }
  609.   return rc;
  610. }
  611. /*
  612. ** Invoke the xRollback method of all virtual tables in the 
  613. ** sqlite3.aVTrans array. Then clear the array itself.
  614. */
  615. int sqlite3VtabRollback(sqlite3 *db){
  616.   callFinaliser(db, (sqlite3_intptr_t)(&((sqlite3_module *)0)->xRollback));
  617.   return SQLITE_OK;
  618. }
  619. /*
  620. ** Invoke the xCommit method of all virtual tables in the 
  621. ** sqlite3.aVTrans array. Then clear the array itself.
  622. */
  623. int sqlite3VtabCommit(sqlite3 *db){
  624.   callFinaliser(db, (sqlite3_intptr_t)(&((sqlite3_module *)0)->xCommit));
  625.   return SQLITE_OK;
  626. }
  627. /*
  628. ** If the virtual table pVtab supports the transaction interface
  629. ** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
  630. ** not currently open, invoke the xBegin method now.
  631. **
  632. ** If the xBegin call is successful, place the sqlite3_vtab pointer
  633. ** in the sqlite3.aVTrans array.
  634. */
  635. int sqlite3VtabBegin(sqlite3 *db, sqlite3_vtab *pVtab){
  636.   int rc = SQLITE_OK;
  637.   const sqlite3_module *pModule;
  638.   /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
  639.   ** than zero, then this function is being called from within a
  640.   ** virtual module xSync() callback. It is illegal to write to 
  641.   ** virtual module tables in this case, so return SQLITE_LOCKED.
  642.   */
  643.   if( 0==db->aVTrans && db->nVTrans>0 ){
  644.     return SQLITE_LOCKED;
  645.   }
  646.   if( !pVtab ){
  647.     return SQLITE_OK;
  648.   } 
  649.   pModule = pVtab->pModule;
  650.   if( pModule->xBegin ){
  651.     int i;
  652.     /* If pVtab is already in the aVTrans array, return early */
  653.     for(i=0; (i<db->nVTrans) && 0!=db->aVTrans[i]; i++){
  654.       if( db->aVTrans[i]==pVtab ){
  655.         return SQLITE_OK;
  656.       }
  657.     }
  658.     /* Invoke the xBegin method */
  659.     rc = pModule->xBegin(pVtab);
  660.     if( rc!=SQLITE_OK ){
  661.       return rc;
  662.     }
  663.     rc = addToVTrans(db, pVtab);
  664.   }
  665.   return rc;
  666. }
  667. /*
  668. ** The first parameter (pDef) is a function implementation.  The
  669. ** second parameter (pExpr) is the first argument to this function.
  670. ** If pExpr is a column in a virtual table, then let the virtual
  671. ** table implementation have an opportunity to overload the function.
  672. **
  673. ** This routine is used to allow virtual table implementations to
  674. ** overload MATCH, LIKE, GLOB, and REGEXP operators.
  675. **
  676. ** Return either the pDef argument (indicating no change) or a 
  677. ** new FuncDef structure that is marked as ephemeral using the
  678. ** SQLITE_FUNC_EPHEM flag.
  679. */
  680. FuncDef *sqlite3VtabOverloadFunction(
  681.   sqlite3 *db,    /* Database connection for reporting malloc problems */
  682.   FuncDef *pDef,  /* Function to possibly overload */
  683.   int nArg,       /* Number of arguments to the function */
  684.   Expr *pExpr     /* First argument to the function */
  685. ){
  686.   Table *pTab;
  687.   sqlite3_vtab *pVtab;
  688.   sqlite3_module *pMod;
  689.   void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  690.   void *pArg;
  691.   FuncDef *pNew;
  692.   int rc = 0;
  693.   char *zLowerName;
  694.   unsigned char *z;
  695.   /* Check to see the left operand is a column in a virtual table */
  696.   if( pExpr==0 ) return pDef;
  697.   if( pExpr->op!=TK_COLUMN ) return pDef;
  698.   pTab = pExpr->pTab;
  699.   if( pTab==0 ) return pDef;
  700.   if( !pTab->isVirtual ) return pDef;
  701.   pVtab = pTab->pVtab;
  702.   assert( pVtab!=0 );
  703.   assert( pVtab->pModule!=0 );
  704.   pMod = (sqlite3_module *)pVtab->pModule;
  705.   if( pMod->xFindFunction==0 ) return pDef;
  706.  
  707.   /* Call the xFindFunction method on the virtual table implementation
  708.   ** to see if the implementation wants to overload this function 
  709.   */
  710.   zLowerName = sqlite3DbStrDup(db, pDef->zName);
  711.   if( zLowerName ){
  712.     for(z=(unsigned char*)zLowerName; *z; z++){
  713.       *z = sqlite3UpperToLower[*z];
  714.     }
  715.     rc = pMod->xFindFunction(pVtab, nArg, zLowerName, &xFunc, &pArg);
  716.     sqlite3_free(zLowerName);
  717.   }
  718.   if( rc==0 ){
  719.     return pDef;
  720.   }
  721.   /* Create a new ephemeral function definition for the overloaded
  722.   ** function */
  723.   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) + strlen(pDef->zName) );
  724.   if( pNew==0 ){
  725.     return pDef;
  726.   }
  727.   *pNew = *pDef;
  728.   memcpy(pNew->zName, pDef->zName, strlen(pDef->zName)+1);
  729.   pNew->xFunc = xFunc;
  730.   pNew->pUserData = pArg;
  731.   pNew->flags |= SQLITE_FUNC_EPHEM;
  732.   return pNew;
  733. }
  734. #endif /* SQLITE_OMIT_VIRTUALTABLE */