sl@0: /* sl@0: ** 2006 June 7 sl@0: ** sl@0: ** The author disclaims copyright to this source code. In place of sl@0: ** a legal notice, here is a blessing: sl@0: ** sl@0: ** May you do good and not evil. sl@0: ** May you find forgiveness for yourself and forgive others. sl@0: ** May you share freely, never taking more than you give. sl@0: ** sl@0: ************************************************************************* sl@0: ** This file contains code used to dynamically load extensions into sl@0: ** the SQLite library. sl@0: ** sl@0: ** $Id: loadext.c,v 1.53 2008/08/02 03:50:39 drh Exp $ sl@0: */ sl@0: sl@0: #ifndef SQLITE_CORE sl@0: #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */ sl@0: #endif sl@0: #include "sqlite3ext.h" sl@0: #include "sqliteInt.h" sl@0: #include sl@0: #include sl@0: sl@0: #ifndef SQLITE_OMIT_LOAD_EXTENSION sl@0: sl@0: /* sl@0: ** Some API routines are omitted when various features are sl@0: ** excluded from a build of SQLite. Substitute a NULL pointer sl@0: ** for any missing APIs. sl@0: */ sl@0: #ifndef SQLITE_ENABLE_COLUMN_METADATA sl@0: # define sqlite3_column_database_name 0 sl@0: # define sqlite3_column_database_name16 0 sl@0: # define sqlite3_column_table_name 0 sl@0: # define sqlite3_column_table_name16 0 sl@0: # define sqlite3_column_origin_name 0 sl@0: # define sqlite3_column_origin_name16 0 sl@0: # define sqlite3_table_column_metadata 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_AUTHORIZATION sl@0: # define sqlite3_set_authorizer 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_UTF16 sl@0: # define sqlite3_bind_text16 0 sl@0: # define sqlite3_collation_needed16 0 sl@0: # define sqlite3_column_decltype16 0 sl@0: # define sqlite3_column_name16 0 sl@0: # define sqlite3_column_text16 0 sl@0: # define sqlite3_complete16 0 sl@0: # define sqlite3_create_collation16 0 sl@0: # define sqlite3_create_function16 0 sl@0: # define sqlite3_errmsg16 0 sl@0: # define sqlite3_open16 0 sl@0: # define sqlite3_prepare16 0 sl@0: # define sqlite3_prepare16_v2 0 sl@0: # define sqlite3_result_error16 0 sl@0: # define sqlite3_result_text16 0 sl@0: # define sqlite3_result_text16be 0 sl@0: # define sqlite3_result_text16le 0 sl@0: # define sqlite3_value_text16 0 sl@0: # define sqlite3_value_text16be 0 sl@0: # define sqlite3_value_text16le 0 sl@0: # define sqlite3_column_database_name16 0 sl@0: # define sqlite3_column_table_name16 0 sl@0: # define sqlite3_column_origin_name16 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_COMPLETE sl@0: # define sqlite3_complete 0 sl@0: # define sqlite3_complete16 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_PROGRESS_CALLBACK sl@0: # define sqlite3_progress_handler 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_VIRTUALTABLE sl@0: # define sqlite3_create_module 0 sl@0: # define sqlite3_create_module_v2 0 sl@0: # define sqlite3_declare_vtab 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_SHARED_CACHE sl@0: # define sqlite3_enable_shared_cache 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_TRACE sl@0: # define sqlite3_profile 0 sl@0: # define sqlite3_trace 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_GET_TABLE sl@0: # define sqlite3_free_table 0 sl@0: # define sqlite3_get_table 0 sl@0: #endif sl@0: sl@0: #ifdef SQLITE_OMIT_INCRBLOB sl@0: #define sqlite3_bind_zeroblob 0 sl@0: #define sqlite3_blob_bytes 0 sl@0: #define sqlite3_blob_close 0 sl@0: #define sqlite3_blob_open 0 sl@0: #define sqlite3_blob_read 0 sl@0: #define sqlite3_blob_write 0 sl@0: #endif sl@0: sl@0: /* sl@0: ** The following structure contains pointers to all SQLite API routines. sl@0: ** A pointer to this structure is passed into extensions when they are sl@0: ** loaded so that the extension can make calls back into the SQLite sl@0: ** library. sl@0: ** sl@0: ** When adding new APIs, add them to the bottom of this structure sl@0: ** in order to preserve backwards compatibility. sl@0: ** sl@0: ** Extensions that use newer APIs should first call the sl@0: ** sqlite3_libversion_number() to make sure that the API they sl@0: ** intend to use is supported by the library. Extensions should sl@0: ** also check to make sure that the pointer to the function is sl@0: ** not NULL before calling it. sl@0: */ sl@0: static const sqlite3_api_routines sqlite3Apis = { sl@0: sqlite3_aggregate_context, sl@0: sqlite3_aggregate_count, sl@0: sqlite3_bind_blob, sl@0: sqlite3_bind_double, sl@0: sqlite3_bind_int, sl@0: sqlite3_bind_int64, sl@0: sqlite3_bind_null, sl@0: sqlite3_bind_parameter_count, sl@0: sqlite3_bind_parameter_index, sl@0: sqlite3_bind_parameter_name, sl@0: sqlite3_bind_text, sl@0: sqlite3_bind_text16, sl@0: sqlite3_bind_value, sl@0: sqlite3_busy_handler, sl@0: sqlite3_busy_timeout, sl@0: sqlite3_changes, sl@0: sqlite3_close, sl@0: sqlite3_collation_needed, sl@0: sqlite3_collation_needed16, sl@0: sqlite3_column_blob, sl@0: sqlite3_column_bytes, sl@0: sqlite3_column_bytes16, sl@0: sqlite3_column_count, sl@0: sqlite3_column_database_name, sl@0: sqlite3_column_database_name16, sl@0: sqlite3_column_decltype, sl@0: sqlite3_column_decltype16, sl@0: sqlite3_column_double, sl@0: sqlite3_column_int, sl@0: sqlite3_column_int64, sl@0: sqlite3_column_name, sl@0: sqlite3_column_name16, sl@0: sqlite3_column_origin_name, sl@0: sqlite3_column_origin_name16, sl@0: sqlite3_column_table_name, sl@0: sqlite3_column_table_name16, sl@0: sqlite3_column_text, sl@0: sqlite3_column_text16, sl@0: sqlite3_column_type, sl@0: sqlite3_column_value, sl@0: sqlite3_commit_hook, sl@0: sqlite3_complete, sl@0: sqlite3_complete16, sl@0: sqlite3_create_collation, sl@0: sqlite3_create_collation16, sl@0: sqlite3_create_function, sl@0: sqlite3_create_function16, sl@0: sqlite3_create_module, sl@0: sqlite3_data_count, sl@0: sqlite3_db_handle, sl@0: sqlite3_declare_vtab, sl@0: sqlite3_enable_shared_cache, sl@0: sqlite3_errcode, sl@0: sqlite3_errmsg, sl@0: sqlite3_errmsg16, sl@0: sqlite3_exec, sl@0: sqlite3_expired, sl@0: sqlite3_finalize, sl@0: sqlite3_free, sl@0: sqlite3_free_table, sl@0: sqlite3_get_autocommit, sl@0: sqlite3_get_auxdata, sl@0: sqlite3_get_table, sl@0: 0, /* Was sqlite3_global_recover(), but that function is deprecated */ sl@0: sqlite3_interrupt, sl@0: sqlite3_last_insert_rowid, sl@0: sqlite3_libversion, sl@0: sqlite3_libversion_number, sl@0: sqlite3_malloc, sl@0: sqlite3_mprintf, sl@0: sqlite3_open, sl@0: sqlite3_open16, sl@0: sqlite3_prepare, sl@0: sqlite3_prepare16, sl@0: sqlite3_profile, sl@0: sqlite3_progress_handler, sl@0: sqlite3_realloc, sl@0: sqlite3_reset, sl@0: sqlite3_result_blob, sl@0: sqlite3_result_double, sl@0: sqlite3_result_error, sl@0: sqlite3_result_error16, sl@0: sqlite3_result_int, sl@0: sqlite3_result_int64, sl@0: sqlite3_result_null, sl@0: sqlite3_result_text, sl@0: sqlite3_result_text16, sl@0: sqlite3_result_text16be, sl@0: sqlite3_result_text16le, sl@0: sqlite3_result_value, sl@0: sqlite3_rollback_hook, sl@0: sqlite3_set_authorizer, sl@0: sqlite3_set_auxdata, sl@0: sqlite3_snprintf, sl@0: sqlite3_step, sl@0: sqlite3_table_column_metadata, sl@0: sqlite3_thread_cleanup, sl@0: sqlite3_total_changes, sl@0: sqlite3_trace, sl@0: sqlite3_transfer_bindings, sl@0: sqlite3_update_hook, sl@0: sqlite3_user_data, sl@0: sqlite3_value_blob, sl@0: sqlite3_value_bytes, sl@0: sqlite3_value_bytes16, sl@0: sqlite3_value_double, sl@0: sqlite3_value_int, sl@0: sqlite3_value_int64, sl@0: sqlite3_value_numeric_type, sl@0: sqlite3_value_text, sl@0: sqlite3_value_text16, sl@0: sqlite3_value_text16be, sl@0: sqlite3_value_text16le, sl@0: sqlite3_value_type, sl@0: sqlite3_vmprintf, sl@0: /* sl@0: ** The original API set ends here. All extensions can call any sl@0: ** of the APIs above provided that the pointer is not NULL. But sl@0: ** before calling APIs that follow, extension should check the sl@0: ** sqlite3_libversion_number() to make sure they are dealing with sl@0: ** a library that is new enough to support that API. sl@0: ************************************************************************* sl@0: */ sl@0: sqlite3_overload_function, sl@0: sl@0: /* sl@0: ** Added after 3.3.13 sl@0: */ sl@0: sqlite3_prepare_v2, sl@0: sqlite3_prepare16_v2, sl@0: sqlite3_clear_bindings, sl@0: sl@0: /* sl@0: ** Added for 3.4.1 sl@0: */ sl@0: sqlite3_create_module_v2, sl@0: sl@0: /* sl@0: ** Added for 3.5.0 sl@0: */ sl@0: sqlite3_bind_zeroblob, sl@0: sqlite3_blob_bytes, sl@0: sqlite3_blob_close, sl@0: sqlite3_blob_open, sl@0: sqlite3_blob_read, sl@0: sqlite3_blob_write, sl@0: sqlite3_create_collation_v2, sl@0: sqlite3_file_control, sl@0: sqlite3_memory_highwater, sl@0: sqlite3_memory_used, sl@0: #ifdef SQLITE_MUTEX_NOOP sl@0: 0, sl@0: 0, sl@0: 0, sl@0: 0, sl@0: 0, sl@0: #else sl@0: sqlite3_mutex_alloc, sl@0: sqlite3_mutex_enter, sl@0: sqlite3_mutex_free, sl@0: sqlite3_mutex_leave, sl@0: sqlite3_mutex_try, sl@0: #endif sl@0: sqlite3_open_v2, sl@0: sqlite3_release_memory, sl@0: sqlite3_result_error_nomem, sl@0: sqlite3_result_error_toobig, sl@0: sqlite3_sleep, sl@0: sqlite3_soft_heap_limit, sl@0: sqlite3_vfs_find, sl@0: sqlite3_vfs_register, sl@0: sqlite3_vfs_unregister, sl@0: sl@0: /* sl@0: ** Added for 3.5.8 sl@0: */ sl@0: sqlite3_threadsafe, sl@0: sqlite3_result_zeroblob, sl@0: sqlite3_result_error_code, sl@0: sqlite3_test_control, sl@0: sqlite3_randomness, sl@0: sqlite3_context_db_handle, sl@0: sl@0: /* sl@0: ** Added for 3.6.0 sl@0: */ sl@0: sqlite3_extended_result_codes, sl@0: sqlite3_limit, sl@0: sqlite3_next_stmt, sl@0: sqlite3_sql, sl@0: sqlite3_status, sl@0: }; sl@0: sl@0: /* sl@0: ** Attempt to load an SQLite extension library contained in the file sl@0: ** zFile. The entry point is zProc. zProc may be 0 in which case a sl@0: ** default entry point name (sqlite3_extension_init) is used. Use sl@0: ** of the default name is recommended. sl@0: ** sl@0: ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong. sl@0: ** sl@0: ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with sl@0: ** error message text. The calling function should free this memory sl@0: ** by calling sqlite3DbFree(db, ). sl@0: */ sl@0: static int sqlite3LoadExtension( sl@0: sqlite3 *db, /* Load the extension into this database connection */ sl@0: const char *zFile, /* Name of the shared library containing extension */ sl@0: const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */ sl@0: char **pzErrMsg /* Put error message here if not 0 */ sl@0: ){ sl@0: sqlite3_vfs *pVfs = db->pVfs; sl@0: void *handle; sl@0: int (*xInit)(sqlite3*,char**,const sqlite3_api_routines*); sl@0: char *zErrmsg = 0; sl@0: void **aHandle; sl@0: sl@0: /* Ticket #1863. To avoid a creating security problems for older sl@0: ** applications that relink against newer versions of SQLite, the sl@0: ** ability to run load_extension is turned off by default. One sl@0: ** must call sqlite3_enable_load_extension() to turn on extension sl@0: ** loading. Otherwise you get the following error. sl@0: */ sl@0: if( (db->flags & SQLITE_LoadExtension)==0 ){ sl@0: if( pzErrMsg ){ sl@0: *pzErrMsg = sqlite3_mprintf("not authorized"); sl@0: } sl@0: return SQLITE_ERROR; sl@0: } sl@0: sl@0: if( zProc==0 ){ sl@0: zProc = "sqlite3_extension_init"; sl@0: } sl@0: sl@0: handle = sqlite3OsDlOpen(pVfs, zFile); sl@0: if( handle==0 ){ sl@0: if( pzErrMsg ){ sl@0: char zErr[256]; sl@0: zErr[sizeof(zErr)-1] = '\0'; sl@0: sqlite3_snprintf(sizeof(zErr)-1, zErr, sl@0: "unable to open shared library [%s]", zFile); sl@0: sqlite3OsDlError(pVfs, sizeof(zErr)-1, zErr); sl@0: *pzErrMsg = sqlite3DbStrDup(0, zErr); sl@0: } sl@0: return SQLITE_ERROR; sl@0: } sl@0: xInit = (int(*)(sqlite3*,char**,const sqlite3_api_routines*)) sl@0: sqlite3OsDlSym(pVfs, handle, zProc); sl@0: if( xInit==0 ){ sl@0: if( pzErrMsg ){ sl@0: char zErr[256]; sl@0: zErr[sizeof(zErr)-1] = '\0'; sl@0: sqlite3_snprintf(sizeof(zErr)-1, zErr, sl@0: "no entry point [%s] in shared library [%s]", zProc,zFile); sl@0: sqlite3OsDlError(pVfs, sizeof(zErr)-1, zErr); sl@0: *pzErrMsg = sqlite3DbStrDup(0, zErr); sl@0: sqlite3OsDlClose(pVfs, handle); sl@0: } sl@0: return SQLITE_ERROR; sl@0: }else if( xInit(db, &zErrmsg, &sqlite3Apis) ){ sl@0: if( pzErrMsg ){ sl@0: *pzErrMsg = sqlite3_mprintf("error during initialization: %s", zErrmsg); sl@0: } sl@0: sqlite3_free(zErrmsg); sl@0: sqlite3OsDlClose(pVfs, handle); sl@0: return SQLITE_ERROR; sl@0: } sl@0: sl@0: /* Append the new shared library handle to the db->aExtension array. */ sl@0: aHandle = sqlite3DbMallocZero(db, sizeof(handle)*(db->nExtension+1)); sl@0: if( aHandle==0 ){ sl@0: return SQLITE_NOMEM; sl@0: } sl@0: if( db->nExtension>0 ){ sl@0: memcpy(aHandle, db->aExtension, sizeof(handle)*db->nExtension); sl@0: } sl@0: sqlite3DbFree(db, db->aExtension); sl@0: db->aExtension = aHandle; sl@0: sl@0: db->aExtension[db->nExtension++] = handle; sl@0: return SQLITE_OK; sl@0: } sl@0: int sqlite3_load_extension( sl@0: sqlite3 *db, /* Load the extension into this database connection */ sl@0: const char *zFile, /* Name of the shared library containing extension */ sl@0: const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */ sl@0: char **pzErrMsg /* Put error message here if not 0 */ sl@0: ){ sl@0: int rc; sl@0: sqlite3_mutex_enter(db->mutex); sl@0: rc = sqlite3LoadExtension(db, zFile, zProc, pzErrMsg); sl@0: sqlite3_mutex_leave(db->mutex); sl@0: return rc; sl@0: } sl@0: sl@0: /* sl@0: ** Call this routine when the database connection is closing in order sl@0: ** to clean up loaded extensions sl@0: */ sl@0: void sqlite3CloseExtensions(sqlite3 *db){ sl@0: int i; sl@0: assert( sqlite3_mutex_held(db->mutex) ); sl@0: for(i=0; inExtension; i++){ sl@0: sqlite3OsDlClose(db->pVfs, db->aExtension[i]); sl@0: } sl@0: sqlite3DbFree(db, db->aExtension); sl@0: } sl@0: sl@0: /* sl@0: ** Enable or disable extension loading. Extension loading is disabled by sl@0: ** default so as not to open security holes in older applications. sl@0: */ sl@0: int sqlite3_enable_load_extension(sqlite3 *db, int onoff){ sl@0: sqlite3_mutex_enter(db->mutex); sl@0: if( onoff ){ sl@0: db->flags |= SQLITE_LoadExtension; sl@0: }else{ sl@0: db->flags &= ~SQLITE_LoadExtension; sl@0: } sl@0: sqlite3_mutex_leave(db->mutex); sl@0: return SQLITE_OK; sl@0: } sl@0: sl@0: #endif /* SQLITE_OMIT_LOAD_EXTENSION */ sl@0: sl@0: /* sl@0: ** The auto-extension code added regardless of whether or not extension sl@0: ** loading is supported. We need a dummy sqlite3Apis pointer for that sl@0: ** code if regular extension loading is not available. This is that sl@0: ** dummy pointer. sl@0: */ sl@0: #ifdef SQLITE_OMIT_LOAD_EXTENSION sl@0: static const sqlite3_api_routines sqlite3Apis = { 0 }; sl@0: #endif sl@0: sl@0: sl@0: /* sl@0: ** The following object holds the list of automatically loaded sl@0: ** extensions. sl@0: ** sl@0: ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER sl@0: ** mutex must be held while accessing this list. sl@0: */ sl@0: static struct { sl@0: int nExt; /* Number of entries in aExt[] */ sl@0: void **aExt; /* Pointers to the extension init functions */ sl@0: } autoext = { 0, 0 }; sl@0: sl@0: sl@0: /* sl@0: ** Register a statically linked extension that is automatically sl@0: ** loaded by every new database connection. sl@0: */ sl@0: int sqlite3_auto_extension(void *xInit){ sl@0: int rc = SQLITE_OK; sl@0: #ifndef SQLITE_OMIT_AUTOINIT sl@0: rc = sqlite3_initialize(); sl@0: if( rc ){ sl@0: return rc; sl@0: }else sl@0: #endif sl@0: { sl@0: int i; sl@0: #ifndef SQLITE_MUTEX_NOOP sl@0: sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); sl@0: #endif sl@0: sqlite3_mutex_enter(mutex); sl@0: for(i=0; i=autoext.nExt ){ sl@0: xInit = 0; sl@0: go = 0; sl@0: }else{ sl@0: xInit = (int(*)(sqlite3*,char**,const sqlite3_api_routines*)) sl@0: autoext.aExt[i]; sl@0: } sl@0: sqlite3_mutex_leave(mutex); sl@0: if( xInit && xInit(db, &zErrmsg, &sqlite3Apis) ){ sl@0: sqlite3Error(db, SQLITE_ERROR, sl@0: "automatic extension loading failed: %s", zErrmsg); sl@0: go = 0; sl@0: rc = SQLITE_ERROR; sl@0: sqlite3_free(zErrmsg); sl@0: } sl@0: } sl@0: return rc; sl@0: }