|
|
| version 1.10, 2001/05/07 13:30:04 | version 1.88, 2008/06/26 09:41:55 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: sql driver manager implementation. | Parser: sql driver manager implementation. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf) | |
| $Id$ | |
| */ | */ |
| #include "pa_config_includes.h" | static const char * const IDENT_SQL_DRIVER_MANAGER_C="$Date$"; |
| #include "ltdl.h" | |
| #include "pa_sql_driver_manager.h" | #include "pa_sql_driver_manager.h" |
| #include "ltdl.h" | |
| #include "pa_threads.h" | |
| #include "pa_sql_connection.h" | #include "pa_sql_connection.h" |
| #include "pa_exception.h" | #include "pa_exception.h" |
| #include "pa_common.h" | #include "pa_common.h" |
| #include "pa_vhash.h" | |
| #include "pa_vtable.h" | |
| #include "pa_charsets.h" | |
| // globals | // globals |
| SQL_Driver_manager *SQL_driver_manager; | SQL_Driver_manager* SQL_driver_manager=0; |
| // consts | // consts |
| const int MAX_PROTOCOL=20; | const time_t EXPIRE_UNUSED_CONNECTION_SECONDS=60; |
| const char *LIBRARY_CREATE_FUNC_NAME="create"; | const time_t CHECK_EXPIRED_CONNECTIONS_SECONDS=EXPIRE_UNUSED_CONNECTION_SECONDS*2; |
| // helpers | |
| const String& SQL_Driver_services_impl::url_without_login() const { | |
| String& result=*new String; | |
| result << furl->mid(0, furl->pos(':')) << "://****"; | |
| size_t at_pos=0; | |
| size_t new_at_pos; | |
| while( (new_at_pos=furl->pos('@', at_pos+1))!=STRING_NOT_FOUND) | |
| at_pos=new_at_pos; | |
| if(at_pos) | |
| result << furl->mid(at_pos, furl->length()); | |
| return result; | |
| } | |
| void SQL_Driver_services_impl::transcode(const char* src, size_t src_length, | |
| const char*& dst, size_t& dst_length, | |
| const char* charset_from_name, | |
| const char* charset_to_name | |
| ) | |
| { | |
| try { | |
| // to speed up sql transcode [lots of charsets::get-s -- twice for each cell] | |
| // without complicating sql driver API | |
| // we need to cache couple of name->charset pairs | |
| // assuming pointers to names are are NOT to local vars | |
| struct cache_record { | |
| const char* name; | |
| Charset* object; | |
| } cache[2]={{0,0}, {0,0}}; | |
| Charset* charset_from_object; | |
| Charset* charset_to_object; | |
| if(charset_from_name==cache[0].name) { | |
| charset_from_object=cache[0].object; | |
| } else { | |
| cache[0].name=charset_from_name; | |
| cache[0].object=charset_from_object=&charsets.get(charset_from_name); | |
| } | |
| if(charset_to_name==cache[1].name) { | |
| charset_to_object=cache[1].object; | |
| } else { | |
| cache[1].name=charset_to_name; | |
| cache[1].object=charset_to_object=&charsets.get(charset_to_name); | |
| } | |
| String::C result=Charset::transcode(String::C(src, src_length), | |
| *charset_from_object, | |
| *charset_to_object); | |
| dst=result.str; | |
| dst_length=result.length; | |
| } catch(const Exception& e) { | |
| _throw(SQL_Error(e.type(), e.comment())); | |
| } catch(...) { | |
| _throw(SQL_Error(0, "unknown error while transcoding in sql driver")); | |
| } | |
| } | |
| // helpers | |
| /// SQL_Driver_services Pooled implementation | static void expire_connection(SQL_Connection& connection, time_t older_dies) { |
| class SQL_Driver_services_impl : public SQL_Driver_services, public Pooled { | if(connection.connected() && connection.expired(older_dies)) |
| public: | connection.disconnect(); |
| SQL_Driver_services_impl(Pool& apool, const String& aurl) : Pooled(apool), | } |
| furl(aurl) { | static void expire_connections(SQL_Driver_manager::connection_cache_type::key_type /*key*/, |
| } | SQL_Driver_manager::connection_cache_type::value_type stack, |
| time_t older_dies) { | |
| /// allocates some bytes on pool | for(size_t i=0; i<stack->top_index(); i++) |
| void *malloc(size_t size) { return Pooled::malloc(size); } | expire_connection(*stack->get(i), older_dies); |
| /// allocates some bytes clearing them with zeros | } |
| void *calloc(size_t size) { return Pooled::calloc(size); } | |
| /// throw exception | |
| void _throw(const char *comment) { | |
| THROW(0, 0, | |
| &furl, | |
| comment); | |
| } | |
| private: | |
| const String& furl; | |
| }; | |
| // SQL_Driver_manager | // SQL_Driver_manager |
| // url: | SQL_Driver_manager::SQL_Driver_manager(): |
| // protocol://user:pass@host:port/database | is_dlinited(false), prev_expiration_pass_time(0) { |
| // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this is driver-dependent | } |
| SQL_Connection& SQL_Driver_manager::get_connection(const String& request_owned_url, | |
| Table *protocol2driver_and_client) { | SQL_Driver_manager::~SQL_Driver_manager() { |
| SYNCHRONIZED(true); | connection_cache.for_each<time_t>(expire_connections, time(0)+(time_t)10/*=in future=expire all*/); |
| Pool& pool=request_owned_url.pool(); // request pool | if(is_dlinited) |
| lt_dlexit(); | |
| } | |
| /// @param aurl protocol://[driver-dependent] | |
| SQL_Connection* SQL_Driver_manager::get_connection(const String& aurl, | |
| Table *protocol2driver_and_client, | |
| const char* arequest_charset, | |
| const char* adocument_root) { | |
| // we have table for locating protocol's library | // we have table for locating protocol's library |
| if(!protocol2driver_and_client) | if(!protocol2driver_and_client) |
| PTHROW(0, 0, | throw Exception(PARSER_RUNTIME, |
| &request_owned_url, | &aurl, |
| "$SQL:drivers table must be defined"); | "$"MAIN_SQL_NAME":"MAIN_SQL_DRIVERS_NAME" table must be defined"); |
| // first trying to get cached connection | // first trying to get cached connection |
| if(SQL_Connection *result=get_connection_from_cache(request_owned_url)) | SQL_Connection* connection=get_connection_from_cache(aurl); |
| if(result->ping()) | if(connection) { |
| return *result; | connection->set_url(); |
| else | if(!connection->ping()) { // we have some cached connection, is it pingable? |
| result->disconnect(); // kill unpingabe=dead connection | connection->disconnect(); // kill unpingabe=dead connection |
| // no cached connection | connection=0; |
| } | |
| int pos=request_owned_url.pos("://", 3); | |
| if(pos<0) | |
| PTHROW(0, 0, | |
| &request_owned_url, | |
| "no protocol specified"); // NOTE: not THROW, but PTHROW | |
| // make url C-string on global pool | |
| char *url_cstr=(char *)malloc(MAX_STRING); | |
| strncpy(url_cstr, request_owned_url.cstr(String::UL_AS_IS), MAX_STRING); | |
| // make url string on global pool | |
| String& url=*new(this->pool()) String(this->pool(), url_cstr); | |
| char *protocol_cstr=lsplit(&url_cstr, ':'); | |
| String& protocol=*new(this->pool()) String(this->pool(), protocol_cstr); | |
| // skip // after : | |
| while(*url_cstr=='/') | |
| url_cstr++; | |
| SQL_Driver *driver; | |
| const String *dlopen_file_spec=0; | |
| // first trying to get cached driver | |
| if(!(driver=get_driver_from_cache(protocol))) { | |
| // no cached | |
| const String *library=0; | |
| if(protocol2driver_and_client->locate(0, protocol)) { | |
| if(!(library=protocol2driver_and_client->item(1)) || library->size()==0) | |
| PTHROW(0, 0, | |
| protocol2driver_and_client->origin_string(), | |
| "driver library column for protocol '%s' is empty", protocol_cstr); | |
| if(!(dlopen_file_spec=protocol2driver_and_client->item(2)) || dlopen_file_spec->size()==0) | |
| PTHROW(0, 0, | |
| protocol2driver_and_client->origin_string(), | |
| "client library column for protocol '%s' is empty", protocol_cstr); | |
| } else | |
| PTHROW(0, 0, | |
| &url, | |
| "undefined protocol '%s'", protocol_cstr); | |
| const char *filename=library->cstr(String::UL_FILE_NAME); | |
| lt_dlhandle handle=lt_dlopen(filename); | |
| if (!handle) | |
| PTHROW(0, 0, | |
| library, | |
| "can not open the module, %s", lt_dlerror()); | |
| SQL_Driver_create_func create=(SQL_Driver_create_func)lt_dlsym(handle, | |
| LIBRARY_CREATE_FUNC_NAME); | |
| if(!create) | |
| PTHROW(0, 0, | |
| library, | |
| "function '%s' was not found", LIBRARY_CREATE_FUNC_NAME); | |
| // create library-driver! | |
| driver=(*create)(); | |
| // validate driver api version | |
| int driver_api_version=driver->api_version(); | |
| if(driver_api_version!=SQL_DRIVER_API_VERSION) | |
| PTHROW(0, 0, | |
| library, | |
| "driver implements API version 0x%04X not equal to 0x%04X", | |
| driver_api_version, SQL_DRIVER_API_VERSION); | |
| // initialise by connecting to sql client dynamic link library | |
| const char *dlopen_file_spec_cstr=dlopen_file_spec->cstr(String::UL_FILE_NAME); | |
| if(const char *error=driver->initialize( | |
| dlopen_file_spec_cstr)) | |
| PTHROW(0, 0, | |
| library, | |
| "driver failed to initialize client library '%s', %s", | |
| dlopen_file_spec_cstr, error); | |
| // cache it | |
| put_driver_to_cache(protocol, *driver); | |
| } | } |
| char *url_cstr; | |
| if(connection) | |
| url_cstr=0; // calm, compiler | |
| else { // no cached connection or it were unpingabe: connect/reconnect | |
| url_cstr=aurl.cstrm(); | |
| if(!strstr(url_cstr, "://")) | |
| throw Exception(PARSER_RUNTIME, | |
| aurl.length()?&aurl:0, | |
| "connection string must start with protocol://"); | |
| char *protocol_cstr=lsplit(&url_cstr, ':'); | |
| // skip "//" after ':' | |
| while(*url_cstr=='/') | |
| url_cstr++; | |
| const String& protocol=*new String(protocol_cstr); | |
| SQL_Driver *driver; | |
| // first trying to get cached driver | |
| if(!(driver=get_driver_from_cache(protocol))) { | |
| // no cached | |
| const String* library=0; | |
| const String* dlopen_file_spec=0; | |
| Table::Action_options options; | |
| if(protocol2driver_and_client->locate(0, protocol, options)) { | |
| if(!(library=protocol2driver_and_client->item(1)) || library->length()==0) | |
| throw Exception(PARSER_RUNTIME, | |
| 0, | |
| "driver library column for protocol '%s' is empty", | |
| protocol_cstr); | |
| dlopen_file_spec=protocol2driver_and_client->item(2); | |
| } else | |
| throw Exception(PARSER_RUNTIME, | |
| &aurl, | |
| "undefined protocol '%s'", | |
| protocol_cstr); | |
| if(!is_dlinited) { | |
| if(lt_dlinit()) | |
| throw Exception(0, | |
| library, | |
| "prepare to dynamic loading failed, %s", lt_dlerror()); | |
| is_dlinited=true; | |
| } | |
| const char* filename=library->cstr(String::L_FILE_SPEC); | |
| lt_dlhandle handle=lt_dlopen(filename); | |
| if (!handle) { | |
| const char* error=lt_dlerror(); | |
| throw Exception(0, | |
| library, | |
| error?error:"can not open the module"); | |
| } | |
| SQL_Driver_create_func create=(SQL_Driver_create_func)(lt_dlsym(handle, | |
| SQL_DRIVER_CREATE_NAME)); | |
| if(!create) | |
| throw Exception(0, | |
| library, | |
| "function '"SQL_DRIVER_CREATE_NAME"' was not found"); | |
| // create library-driver! | |
| driver=(*create)(); | |
| // validate driver api version | |
| int driver_api_version=driver->api_version(); | |
| if(driver_api_version!=SQL_DRIVER_API_VERSION) | |
| throw Exception(0, | |
| library, | |
| "driver implements API version 0x%04X not equal to 0x%04X", | |
| driver_api_version, SQL_DRIVER_API_VERSION); | |
| // initialise by connecting to sql client dynamic link library | |
| char* dlopen_file_spec_cstr= | |
| dlopen_file_spec && dlopen_file_spec->length()? | |
| dlopen_file_spec->cstrm(String::L_AS_IS):0; | |
| if(const char* error=driver->initialize(dlopen_file_spec_cstr)) | |
| throw Exception(0, | |
| library, | |
| "driver failed to initialize client library '%s', %s", | |
| dlopen_file_spec_cstr?dlopen_file_spec_cstr:"unspecifed", | |
| error); | |
| // cache it | |
| put_driver_to_cache(protocol, driver); | |
| } | |
| // services associated with request | connection=new SQL_Connection(aurl, *driver, arequest_charset, adocument_root); |
| SQL_Driver_services_impl& services= | // associate with pool[request] (deassociates at close) |
| *new(pool) SQL_Driver_services_impl(pool, url); | connection->set_url(); |
| } | |
| // allocate in global pool | |
| // associate with services[request], deassociates at close | |
| SQL_Connection& result= | |
| *new(this->pool()) SQL_Connection(this->pool(), | |
| url, *driver, services, url_cstr); | |
| return result; | |
| } | |
| void SQL_Driver_manager::close_connection(const String& url, | // if not connected yet, do that now, when connection has services |
| SQL_Connection& connection) { | if(!connection->connected()) |
| SYNCHRONIZED(true); | connection->connect(url_cstr); |
| // return autoclosing object for it | |
| return connection; | |
| } | |
| void SQL_Driver_manager::close_connection(connection_cache_type::key_type url, | |
| SQL_Connection* connection) { | |
| put_connection_to_cache(url, connection); | put_connection_to_cache(url, connection); |
| } | } |
| // driver cache | // driver cache |
| SQL_Driver *SQL_Driver_manager::get_driver_from_cache(const String& protocol) { | SQL_Driver *SQL_Driver_manager::get_driver_from_cache(driver_cache_type::key_type protocol) { |
| if(SQL_Driver *result=static_cast<SQL_Driver *>(driver_cache.get(protocol))) | SYNCHRONIZED; |
| return result; | |
| return 0; | return driver_cache.get(protocol); |
| } | } |
| void SQL_Driver_manager::put_driver_to_cache(const String& protocol, | void SQL_Driver_manager::put_driver_to_cache( |
| SQL_Driver& driver) { | driver_cache_type::key_type protocol, |
| driver_cache.put(protocol, &driver); | driver_cache_type::value_type driver) { |
| SYNCHRONIZED; | |
| driver_cache.put(protocol, driver); | |
| } | } |
| // connection cache | // connection cache |
| /// @todo get rid of memory spending Stack [zeros deep inside got accumulated] | |
| SQL_Connection *SQL_Driver_manager::get_connection_from_cache(const String& url) { | SQL_Connection* SQL_Driver_manager::get_connection_from_cache(connection_cache_type::key_type url) { |
| if(Stack *connections=static_cast<Stack *>(connection_cache.get(url))) | SYNCHRONIZED; |
| if(connections->size()) // there are cached connections to that 'url' | |
| return static_cast<SQL_Connection *>(connections->pop()); | if(connection_cache_type::value_type connections=connection_cache.get(url)) |
| while(!connections->is_empty()) { // there are cached connections to that 'url' | |
| SQL_Connection* result=connections->pop(); | |
| if(result->connected()) // not expired? | |
| return result; | |
| } | |
| return 0; | return 0; |
| } | } |
| /// @todo cache expiration[use SQL_Driver::disconnect] | void SQL_Driver_manager::put_connection_to_cache( |
| void SQL_Driver_manager::put_connection_to_cache(const String& url, | connection_cache_type::key_type url, |
| SQL_Connection& connection) { | SQL_Connection* connection) { |
| Stack *connections; | SYNCHRONIZED; |
| if(!(connections=static_cast<Stack *>(connection_cache.get(url)))) { | |
| // there are no cached connections to that 'url' yet | connection_cache_type::value_type connections=connection_cache.get(url); |
| connections=NEW Stack(pool()); // NOTE: never freed up! | if(!connections) { // there are no cached connections to that 'url' yet? |
| connections=new connection_cache_element_base_type; | |
| connection_cache.put(url, connections); | connection_cache.put(url, connections); |
| } | } |
| connections->push(&connection); | connections->push(connection); |
| } | |
| void SQL_Driver_manager::maybe_expire_cache() { | |
| time_t now=time(0); | |
| if(prev_expiration_pass_time<now-CHECK_EXPIRED_CONNECTIONS_SECONDS) { | |
| connection_cache.for_each<time_t>(expire_connections, time_t(now-EXPIRE_UNUSED_CONNECTION_SECONDS)); | |
| prev_expiration_pass_time=now; | |
| } | |
| } | |
| static void add_connection_to_status_cache_table(SQL_Connection& connection, Table* table) { | |
| if(connection.connected()) { | |
| ArrayString& row=*new ArrayString; | |
| // url | |
| row+=&connection.services().url_without_login(); | |
| // time | |
| time_t time_used=connection.get_time_used(); | |
| row+=new String(pa_strdup(ctime(&time_used))); | |
| *table+=&row; | |
| } | |
| } | |
| static void add_connections_to_status_cache_table( | |
| SQL_Driver_manager::connection_cache_type::key_type /*key*/, | |
| SQL_Driver_manager::connection_cache_type::value_type stack, Table* table) | |
| { | |
| for(Array_iterator<SQL_Connection*> i(*stack); i.has_next(); ) | |
| add_connection_to_status_cache_table(*i.next(), table); | |
| } | |
| Value* SQL_Driver_manager::get_status() { | |
| Value* result=new VHash; | |
| // cache | |
| { | |
| ArrayString& columns=*new ArrayString; | |
| columns+=new String("url"); | |
| columns+=new String("time"); | |
| Table& table=*new Table(&columns, connection_cache.count()); | |
| connection_cache.for_each<Table*>(add_connections_to_status_cache_table, &table); | |
| result->get_hash()->put(*new String("cache"), new VTable(&table)); | |
| } | |
| return result; | |
| } | } |