src/callback.c

   1 /*
   2 ** 2005 May 23
   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 **
  13 ** This file contains functions used to access the internal hash tables
  14 ** of user defined functions and collation sequences.
  15 */
  16
  17 #include "sqliteInt.h"
  18
  19 /*
  20 ** Invoke the 'collation needed' callback to request a collation sequence
  21 ** in the encoding enc of name zName, length nName.
  22 */
  23 static void callCollNeeded(sqlite3 *db, int enc, const char *zName){
  24   assert( !db->xCollNeeded || !db->xCollNeeded16 );
  25   if( db->xCollNeeded ){
  26     char *zExternal = sqlite3DbStrDup(db, zName);
  27     if( !zExternal ) return;
  28     db->xCollNeeded(db->pCollNeededArg, db, enc, zExternal);
  29     sqlite3DbFree(db, zExternal);
  30   }
  31 #ifndef SQLITE_OMIT_UTF16
  32   if( db->xCollNeeded16 ){
  33     char const *zExternal;
  34     sqlite3_value *pTmp = sqlite3ValueNew(db);
  35     sqlite3ValueSetStr(pTmp, -1, zName, SQLITE_UTF8, SQLITE_STATIC);
  36     zExternal = sqlite3ValueText(pTmp, SQLITE_UTF16NATIVE);
  37     if( zExternal ){
  38       db->xCollNeeded16(db->pCollNeededArg, db, (int)ENC(db), zExternal);
  39     }
  40     sqlite3ValueFree(pTmp);
  41   }
  42 #endif
  43 }
  44
  45 /*
  46 ** This routine is called if the collation factory fails to deliver a
  47 ** collation function in the best encoding but there may be other versions
  48 ** of this collation function (for other text encodings) available. Use one
  49 ** of these instead if they exist. Avoid a UTF-8 <-> UTF-16 conversion if
  50 ** possible.
  51 */
  52 static int synthCollSeq(sqlite3 *db, CollSeq *pColl){
  53   CollSeq *pColl2;
  54   char *z = pColl->zName;
  55   int i;
  56   static const u8 aEnc[] = { SQLITE_UTF16BE, SQLITE_UTF16LE, SQLITE_UTF8 };
  57   for(i=0; i<3; i++){
  58     pColl2 = sqlite3FindCollSeq(db, aEnc[i], z, 0);
  59     if( pColl2->xCmp!=0 ){
  60       memcpy(pColl, pColl2, sizeof(CollSeq));
  61       pColl->xDel = 0;         /* Do not copy the destructor */
  62       return SQLITE_OK;
  63     }
  64   }
  65   return SQLITE_ERROR;
  66 }
  67
  68 /*
  69 ** This function is responsible for invoking the collation factory callback
  70 ** or substituting a collation sequence of a different encoding when the
  71 ** requested collation sequence is not available in the desired encoding.
  72 **
  73 ** If it is not NULL, then pColl must point to the database native encoding
  74 ** collation sequence with name zName, length nName.
  75 **
  76 ** The return value is either the collation sequence to be used in database
  77 ** db for collation type name zName, length nName, or NULL, if no collation
  78 ** sequence can be found.  If no collation is found, leave an error message.
  79 **
  80 ** See also: sqlite3LocateCollSeq(), sqlite3FindCollSeq()
  81 */
  82 CollSeq *sqlite3GetCollSeq(
  83   Parse *pParse,        /* Parsing context */
  84   u8 enc,               /* The desired encoding for the collating sequence */
  85   CollSeq *pColl,       /* Collating sequence with native encoding, or NULL */
  86   const char *zName     /* Collating sequence name */
  87 ){
  88   CollSeq *p;
  89   sqlite3 *db = pParse->db;
  90
  91   p = pColl;
  92   if( !p ){
  93     p = sqlite3FindCollSeq(db, enc, zName, 0);
  94   }
  95   if( !p || !p->xCmp ){
  96     /* No collation sequence of this type for this encoding is registered.
  97     ** Call the collation factory to see if it can supply us with one.
  98     */
  99     callCollNeeded(db, enc, zName);
 100     p = sqlite3FindCollSeq(db, enc, zName, 0);
 101   }
 102   if( p && !p->xCmp && synthCollSeq(db, p) ){
 103     p = 0;
 104   }
 105   assert( !p || p->xCmp );
 106   if( p==0 ){
 107     sqlite3ErrorMsg(pParse, "no such collation sequence: %s", zName);
 108     pParse->rc = SQLITE_ERROR_MISSING_COLLSEQ;
 109   }
 110   return p;
 111 }
 112
 113 /*
 114 ** This routine is called on a collation sequence before it is used to
 115 ** check that it is defined. An undefined collation sequence exists when
 116 ** a database is loaded that contains references to collation sequences
 117 ** that have not been defined by sqlite3_create_collation() etc.
 118 **
 119 ** If required, this routine calls the 'collation needed' callback to
 120 ** request a definition of the collating sequence. If this doesn't work,
 121 ** an equivalent collating sequence that uses a text encoding different
 122 ** from the main database is substituted, if one is available.
 123 */
 124 int sqlite3CheckCollSeq(Parse *pParse, CollSeq *pColl){
 125   if( pColl && pColl->xCmp==0 ){
 126     const char *zName = pColl->zName;
 127     sqlite3 *db = pParse->db;
 128     CollSeq *p = sqlite3GetCollSeq(pParse, ENC(db), pColl, zName);
 129     if( !p ){
 130       return SQLITE_ERROR;
 131     }
 132     assert( p==pColl );
 133   }
 134   return SQLITE_OK;
 135 }
 136
 137
 138
 139 /*
 140 ** Locate and return an entry from the db.aCollSeq hash table. If the entry
 141 ** specified by zName and nName is not found and parameter 'create' is
 142 ** true, then create a new entry. Otherwise return NULL.
 143 **
 144 ** Each pointer stored in the sqlite3.aCollSeq hash table contains an
 145 ** array of three CollSeq structures. The first is the collation sequence
 146 ** preferred for UTF-8, the second UTF-16le, and the third UTF-16be.
 147 **
 148 ** Stored immediately after the three collation sequences is a copy of
 149 ** the collation sequence name. A pointer to this string is stored in
 150 ** each collation sequence structure.
 151 */
 152 static CollSeq *findCollSeqEntry(
 153   sqlite3 *db,          /* Database connection */
 154   const char *zName,    /* Name of the collating sequence */
 155   int create            /* Create a new entry if true */
 156 ){
 157   CollSeq *pColl;
 158   pColl = sqlite3HashFind(&db->aCollSeq, zName);
 159
 160   if( 0==pColl && create ){
 161     int nName = sqlite3Strlen30(zName) + 1;
 162     pColl = sqlite3DbMallocZero(db, 3*sizeof(*pColl) + nName);
 163     if( pColl ){
 164       CollSeq *pDel = 0;
 165       pColl[0].zName = (char*)&pColl[3];
 166       pColl[0].enc = SQLITE_UTF8;
 167       pColl[1].zName = (char*)&pColl[3];
 168       pColl[1].enc = SQLITE_UTF16LE;
 169       pColl[2].zName = (char*)&pColl[3];
 170       pColl[2].enc = SQLITE_UTF16BE;
 171       memcpy(pColl[0].zName, zName, nName);
 172       pDel = sqlite3HashInsert(&db->aCollSeq, pColl[0].zName, pColl);
 173
 174       /* If a malloc() failure occurred in sqlite3HashInsert(), it will
 175       ** return the pColl pointer to be deleted (because it wasn't added
 176       ** to the hash table).
 177       */
 178       assert( pDel==0 || pDel==pColl );
 179       if( pDel!=0 ){
 180         sqlite3OomFault(db);
 181         sqlite3DbFree(db, pDel);
 182         pColl = 0;
 183       }
 184     }
 185   }
 186   return pColl;
 187 }
 188
 189 /*
 190 ** Parameter zName points to a UTF-8 encoded string nName bytes long.
 191 ** Return the CollSeq* pointer for the collation sequence named zName
 192 ** for the encoding 'enc' from the database 'db'.
 193 **
 194 ** If the entry specified is not found and 'create' is true, then create a
 195 ** new entry.  Otherwise return NULL.
 196 **
 197 ** A separate function sqlite3LocateCollSeq() is a wrapper around
 198 ** this routine.  sqlite3LocateCollSeq() invokes the collation factory
 199 ** if necessary and generates an error message if the collating sequence
 200 ** cannot be found.
 201 **
 202 ** See also: sqlite3LocateCollSeq(), sqlite3GetCollSeq()
 203 */
 204 CollSeq *sqlite3FindCollSeq(
 205   sqlite3 *db,
 206   u8 enc,
 207   const char *zName,
 208   int create
 209 ){
 210   CollSeq *pColl;
 211   if( zName ){
 212     pColl = findCollSeqEntry(db, zName, create);
 213   }else{
 214     pColl = db->pDfltColl;
 215   }
 216   assert( SQLITE_UTF8==1 && SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
 217   assert( enc>=SQLITE_UTF8 && enc<=SQLITE_UTF16BE );
 218   if( pColl ) pColl += enc-1;
 219   return pColl;
 220 }
 221
 222 /* During the search for the best function definition, this procedure
 223 ** is called to test how well the function passed as the first argument
 224 ** matches the request for a function with nArg arguments in a system
 225 ** that uses encoding enc. The value returned indicates how well the
 226 ** request is matched. A higher value indicates a better match.
 227 **
 228 ** If nArg is -1 that means to only return a match (non-zero) if p->nArg
 229 ** is also -1.  In other words, we are searching for a function that
 230 ** takes a variable number of arguments.
 231 **
 232 ** If nArg is -2 that means that we are searching for any function
 233 ** regardless of the number of arguments it uses, so return a positive
 234 ** match score for any
 235 **
 236 ** The returned value is always between 0 and 6, as follows:
 237 **
 238 ** 0: Not a match.
 239 ** 1: UTF8/16 conversion required and function takes any number of arguments.
 240 ** 2: UTF16 byte order change required and function takes any number of args.
 241 ** 3: encoding matches and function takes any number of arguments
 242 ** 4: UTF8/16 conversion required - argument count matches exactly
 243 ** 5: UTF16 byte order conversion required - argument count matches exactly
 244 ** 6: Perfect match:  encoding and argument count match exactly.
 245 **
 246 ** If nArg==(-2) then any function with a non-null xSFunc is
 247 ** a perfect match and any function with xSFunc NULL is
 248 ** a non-match.
 249 */
 250 #define FUNC_PERFECT_MATCH 6  /* The score for a perfect match */
 251 static int matchQuality(
 252   FuncDef *p,     /* The function we are evaluating for match quality */
 253   int nArg,       /* Desired number of arguments.  (-1)==any */
 254   u8 enc          /* Desired text encoding */
 255 ){
 256   int match;
 257
 258   /* nArg of -2 is a special case */
 259   if( nArg==(-2) ) return (p->xSFunc==0) ? 0 : FUNC_PERFECT_MATCH;
 260
 261   /* Wrong number of arguments means "no match" */
 262   if( p->nArg!=nArg && p->nArg>=0 ) return 0;
 263
 264   /* Give a better score to a function with a specific number of arguments
 265   ** than to function that accepts any number of arguments. */
 266   if( p->nArg==nArg ){
 267     match = 4;
 268   }else{
 269     match = 1;
 270   }
 271
 272   /* Bonus points if the text encoding matches */
 273   if( enc==(p->funcFlags & SQLITE_FUNC_ENCMASK) ){
 274     match += 2;  /* Exact encoding match */
 275   }else if( (enc & p->funcFlags & 2)!=0 ){
 276     match += 1;  /* Both are UTF16, but with different byte orders */
 277   }
 278
 279   return match;
 280 }
 281
 282 /*
 283 ** Search a FuncDefHash for a function with the given name.  Return
 284 ** a pointer to the matching FuncDef if found, or 0 if there is no match.
 285 */
 286 static FuncDef *functionSearch(
 287   int h,               /* Hash of the name */
 288   const char *zFunc    /* Name of function */
 289 ){
 290   FuncDef *p;
 291   for(p=sqlite3BuiltinFunctions.a[h]; p; p=p->u.pHash){
 292     if( sqlite3StrICmp(p->zName, zFunc)==0 ){
 293       return p;
 294     }
 295   }
 296   return 0;
 297 }
 298
 299 /*
 300 ** Insert a new FuncDef into a FuncDefHash hash table.
 301 */
 302 void sqlite3InsertBuiltinFuncs(
 303   FuncDef *aDef,      /* List of global functions to be inserted */
 304   int nDef            /* Length of the apDef[] list */
 305 ){
 306   int i;
 307   for(i=0; i<nDef; i++){
 308     FuncDef *pOther;
 309     const char *zName = aDef[i].zName;
 310     int nName = sqlite3Strlen30(zName);
 311     int h = (zName[0] + nName) % SQLITE_FUNC_HASH_SZ;
 312     assert( zName[0]>='a' && zName[0]<='z' );
 313     pOther = functionSearch(h, zName);
 314     if( pOther ){
 315       assert( pOther!=&aDef[i] && pOther->pNext!=&aDef[i] );
 316       aDef[i].pNext = pOther->pNext;
 317       pOther->pNext = &aDef[i];
 318     }else{
 319       aDef[i].pNext = 0;
 320       aDef[i].u.pHash = sqlite3BuiltinFunctions.a[h];
 321       sqlite3BuiltinFunctions.a[h] = &aDef[i];
 322     }
 323   }
 324 }
 325
 326
 327
 328 /*
 329 ** Locate a user function given a name, a number of arguments and a flag
 330 ** indicating whether the function prefers UTF-16 over UTF-8.  Return a
 331 ** pointer to the FuncDef structure that defines that function, or return
 332 ** NULL if the function does not exist.
 333 **
 334 ** If the createFlag argument is true, then a new (blank) FuncDef
 335 ** structure is created and liked into the "db" structure if a
 336 ** no matching function previously existed.
 337 **
 338 ** If nArg is -2, then the first valid function found is returned.  A
 339 ** function is valid if xSFunc is non-zero.  The nArg==(-2)
 340 ** case is used to see if zName is a valid function name for some number
 341 ** of arguments.  If nArg is -2, then createFlag must be 0.
 342 **
 343 ** If createFlag is false, then a function with the required name and
 344 ** number of arguments may be returned even if the eTextRep flag does not
 345 ** match that requested.
 346 */
 347 FuncDef *sqlite3FindFunction(
 348   sqlite3 *db,       /* An open database */
 349   const char *zName, /* Name of the function.  zero-terminated */
 350   int nArg,          /* Number of arguments.  -1 means any number */
 351   u8 enc,            /* Preferred text encoding */
 352   u8 createFlag      /* Create new entry if true and does not otherwise exist */
 353 ){
 354   FuncDef *p;         /* Iterator variable */
 355   FuncDef *pBest = 0; /* Best match found so far */
 356   int bestScore = 0;  /* Score of best match */
 357   int h;              /* Hash value */
 358   int nName;          /* Length of the name */
 359
 360   assert( nArg>=(-2) );
 361   assert( nArg>=(-1) || createFlag==0 );
 362   nName = sqlite3Strlen30(zName);
 363
 364   /* First search for a match amongst the application-defined functions.
 365   */
 366   p = (FuncDef*)sqlite3HashFind(&db->aFunc, zName);
 367   while( p ){
 368     int score = matchQuality(p, nArg, enc);
 369     if( score>bestScore ){
 370       pBest = p;
 371       bestScore = score;
 372     }
 373     p = p->pNext;
 374   }
 375
 376   /* If no match is found, search the built-in functions.
 377   **
 378   ** If the DBFLAG_PreferBuiltin flag is set, then search the built-in
 379   ** functions even if a prior app-defined function was found.  And give
 380   ** priority to built-in functions.
 381   **
 382   ** Except, if createFlag is true, that means that we are trying to
 383   ** install a new function.  Whatever FuncDef structure is returned it will
 384   ** have fields overwritten with new information appropriate for the
 385   ** new function.  But the FuncDefs for built-in functions are read-only.
 386   ** So we must not search for built-ins when creating a new function.
 387   */
 388   if( !createFlag && (pBest==0 || (db->mDbFlags & DBFLAG_PreferBuiltin)!=0) ){
 389     bestScore = 0;
 390     h = (sqlite3UpperToLower[(u8)zName[0]] + nName) % SQLITE_FUNC_HASH_SZ;
 391     p = functionSearch(h, zName);
 392     while( p ){
 393       int score = matchQuality(p, nArg, enc);
 394       if( score>bestScore ){
 395         pBest = p;
 396         bestScore = score;
 397       }
 398       p = p->pNext;
 399     }
 400   }
 401
 402   /* If the createFlag parameter is true and the search did not reveal an
 403   ** exact match for the name, number of arguments and encoding, then add a
 404   ** new entry to the hash table and return it.
 405   */
 406   if( createFlag && bestScore<FUNC_PERFECT_MATCH &&
 407       (pBest = sqlite3DbMallocZero(db, sizeof(*pBest)+nName+1))!=0 ){
 408     FuncDef *pOther;
 409     u8 *z;
 410     pBest->zName = (const char*)&pBest[1];
 411     pBest->nArg = (u16)nArg;
 412     pBest->funcFlags = enc;
 413     memcpy((char*)&pBest[1], zName, nName+1);
 414     for(z=(u8*)pBest->zName; *z; z++) *z = sqlite3UpperToLower[*z];
 415     pOther = (FuncDef*)sqlite3HashInsert(&db->aFunc, pBest->zName, pBest);
 416     if( pOther==pBest ){
 417       sqlite3DbFree(db, pBest);
 418       sqlite3OomFault(db);
 419       return 0;
 420     }else{
 421       pBest->pNext = pOther;
 422     }
 423   }
 424
 425   if( pBest && (pBest->xSFunc || createFlag) ){
 426     return pBest;
 427   }
 428   return 0;
 429 }
 430
 431 /*
 432 ** Free all resources held by the schema structure. The void* argument points
 433 ** at a Schema struct. This function does not call sqlite3DbFree(db, ) on the
 434 ** pointer itself, it just cleans up subsidiary resources (i.e. the contents
 435 ** of the schema hash tables).
 436 **
 437 ** The Schema.cache_size variable is not cleared.
 438 */
 439 void sqlite3SchemaClear(void *p){
 440   Hash temp1;
 441   Hash temp2;
 442   HashElem *pElem;
 443   Schema *pSchema = (Schema *)p;
 444
 445   temp1 = pSchema->tblHash;
 446   temp2 = pSchema->trigHash;
 447   sqlite3HashInit(&pSchema->trigHash);
 448   sqlite3HashClear(&pSchema->idxHash);
 449   for(pElem=sqliteHashFirst(&temp2); pElem; pElem=sqliteHashNext(pElem)){
 450     sqlite3DeleteTrigger(0, (Trigger*)sqliteHashData(pElem));
 451   }
 452   sqlite3HashClear(&temp2);
 453   sqlite3HashInit(&pSchema->tblHash);
 454   for(pElem=sqliteHashFirst(&temp1); pElem; pElem=sqliteHashNext(pElem)){
 455     Table *pTab = sqliteHashData(pElem);
 456     sqlite3DeleteTable(0, pTab);
 457   }
 458   sqlite3HashClear(&temp1);
 459   sqlite3HashClear(&pSchema->fkeyHash);
 460   pSchema->pSeqTab = 0;
 461   if( pSchema->schemaFlags & DB_SchemaLoaded ){
 462     pSchema->iGeneration++;
 463   }
 464   pSchema->schemaFlags &= ~(DB_SchemaLoaded|DB_ResetWanted);
 465 }
 466
 467 /*
 468 ** Find and return the schema associated with a BTree.  Create
 469 ** a new one if necessary.
 470 */
 471 Schema *sqlite3SchemaGet(sqlite3 *db, Btree *pBt){
 472   Schema * p;
 473   if( pBt ){
 474     p = (Schema *)sqlite3BtreeSchema(pBt, sizeof(Schema), sqlite3SchemaClear);
 475   }else{
 476     p = (Schema *)sqlite3DbMallocZero(0, sizeof(Schema));
 477   }
 478   if( !p ){
 479     sqlite3OomFault(db);
 480   }else if ( 0==p->file_format ){
 481     sqlite3HashInit(&p->tblHash);
 482     sqlite3HashInit(&p->idxHash);
 483     sqlite3HashInit(&p->trigHash);
 484     sqlite3HashInit(&p->fkeyHash);
 485     p->enc = SQLITE_UTF8;
 486   }
 487   return p;
 488 }