Annotation of parser3/src/main/pa_sql_driver_manager.C, revision 1.105

1.54      paf         1: /** @file
                      2:        Parser: sql driver manager implementation.
                      3: 
1.105   ! moko        4:        Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
1.102     moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.63      paf         6: */
1.54      paf         7: 
                      8: #include "pa_sql_driver_manager.h"
                      9: #include "ltdl.h"
1.71      paf        10: #include "pa_threads.h"
1.54      paf        11: #include "pa_sql_connection.h"
                     12: #include "pa_exception.h"
                     13: #include "pa_common.h"
                     14: #include "pa_vhash.h"
                     15: #include "pa_vtable.h"
1.80      paf        16: #include "pa_charsets.h"
1.54      paf        17: 
1.105   ! moko       18: volatile const char * IDENT_PA_SQL_DRIVER_MANAGER_C="$Id: pa_sql_driver_manager.C,v 1.104 2024/09/28 14:37:54 moko Exp $" IDENT_PA_SQL_DRIVER_MANAGER_H IDENT_PA_SQL_CONNECTION_H;
1.91      moko       19: 
1.54      paf        20: // globals
                     21: 
1.78      paf        22: SQL_Driver_manager* SQL_driver_manager=0;
1.54      paf        23: 
                     24: // consts
                     25: 
1.100     moko       26: const time_t EXPIRE_UNUSED_CONNECTION_SECONDS=10;
1.71      paf        27: const time_t CHECK_EXPIRED_CONNECTIONS_SECONDS=EXPIRE_UNUSED_CONNECTION_SECONDS*2;
1.54      paf        28: 
                     29: // helpers
                     30: 
1.71      paf        31: const String& SQL_Driver_services_impl::url_without_login() const {
                     32:        String& result=*new String;
                     33:        result << furl->mid(0, furl->pos(':')) << "://****";
                     34: 
1.84      paf        35:        size_t at_pos=0;
                     36:        size_t new_at_pos;
                     37:        while( (new_at_pos=furl->pos('@', at_pos+1))!=STRING_NOT_FOUND)
                     38:                at_pos=new_at_pos;
                     39:        if(at_pos)
1.71      paf        40:                result << furl->mid(at_pos, furl->length());
1.54      paf        41: 
                     42:        return result;
                     43: }
                     44: 
1.80      paf        45: void SQL_Driver_services_impl::transcode(const char* src, size_t src_length,
                     46:        const char*& dst, size_t& dst_length,
                     47:        const char* charset_from_name,
                     48:        const char* charset_to_name
                     49:        ) 
                     50: {
                     51:        try {
1.83      paf        52:                // to speed up sql transcode [lots of charsets::get-s -- twice for each cell]
                     53:                // without complicating sql driver API
                     54:                // we need to cache couple of name->charset pairs
                     55:                // assuming pointers to names are are NOT to local vars 
                     56: 
                     57:                struct cache_record {
                     58:                        const char* name;
                     59:                        Charset* object;
                     60:                } cache[2]={{0,0}, {0,0}};
                     61: 
                     62:                Charset* charset_from_object;
                     63:                Charset* charset_to_object;
                     64:                if(charset_from_name==cache[0].name) {
                     65:                        charset_from_object=cache[0].object;
                     66:                } else {
                     67:                        cache[0].name=charset_from_name;
1.96      moko       68:                        cache[0].object=charset_from_object=&pa_charsets.get_direct(charset_from_name);
1.83      paf        69:                }
                     70:                if(charset_to_name==cache[1].name) {
                     71:                        charset_to_object=cache[1].object;
                     72:                } else {
                     73:                        cache[1].name=charset_to_name;
1.96      moko       74:                        cache[1].object=charset_to_object=&pa_charsets.get_direct(charset_to_name);
1.83      paf        75:                }
                     76: 
1.95      moko       77:                String::C result=Charset::transcode(String::C(src, src_length), *charset_from_object, *charset_to_object);
1.80      paf        78:                dst=result.str;
                     79:                dst_length=result.length;
                     80:        } catch(const Exception& e) {
                     81:                _throw(SQL_Error(e.type(), e.comment()));
                     82:        } catch(...) {
1.98      moko       83:                _throw(SQL_Error("unknown error while transcoding in sql driver"));
1.80      paf        84:        }
                     85: }
                     86: 
1.54      paf        87: // helpers
                     88: 
1.71      paf        89: static void expire_connection(SQL_Connection& connection, time_t older_dies) {
1.54      paf        90:        if(connection.connected() && connection.expired(older_dies))
                     91:                connection.disconnect();
                     92: }
1.99      moko       93: 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) {
1.73      paf        94:        for(size_t i=0; i<stack->top_index(); i++)
1.71      paf        95:                expire_connection(*stack->get(i), older_dies);
1.54      paf        96: }
                     97: 
                     98: // SQL_Driver_manager
                     99: 
1.92      moko      100: SQL_Driver_manager::SQL_Driver_manager(): prev_expiration_pass_time(0) {}
1.54      paf       101: 
                    102: SQL_Driver_manager::~SQL_Driver_manager() {
1.86      paf       103:        connection_cache.for_each<time_t>(expire_connections, time(0)+(time_t)10/*=in future=expire all*/);
1.54      paf       104: }
                    105: 
1.71      paf       106: /// @param aurl protocol://[driver-dependent]
1.99      moko      107: SQL_Connection* SQL_Driver_manager::get_connection(const String& aurl, Table *protocol2driver_and_client, const char* arequest_charset, const char* adocument_root) {
1.54      paf       108:        // we have table for locating protocol's library
                    109:        if(!protocol2driver_and_client)
1.99      moko      110:                throw Exception(PARSER_RUNTIME, &aurl, "$" MAIN_SQL_NAME ":" MAIN_SQL_DRIVERS_NAME " table must be defined");
1.54      paf       111: 
                    112:        // first trying to get cached connection
1.71      paf       113:        SQL_Connection* connection=get_connection_from_cache(aurl);
1.58      paf       114:        if(connection) {
1.71      paf       115:                connection->set_url();
1.58      paf       116:                if(!connection->ping()) { // we have some cached connection, is it pingable?
                    117:                        connection->disconnect(); // kill unpingabe=dead connection
                    118:                        connection=0;
1.54      paf       119:                }
                    120:        }
                    121: 
1.71      paf       122:        char *url_cstr;
1.58      paf       123:        if(connection)
1.71      paf       124:                url_cstr=0; // calm, compiler
1.54      paf       125:        else { // no cached connection or it were unpingabe: connect/reconnect
1.71      paf       126:                url_cstr=aurl.cstrm();
                    127:                if(!strstr(url_cstr, "://"))
1.99      moko      128:                        throw Exception(PARSER_RUNTIME, aurl.length()?&aurl:0, "connection string must start with protocol://");
1.54      paf       129: 
1.71      paf       130: 
                    131:                char *protocol_cstr=lsplit(&url_cstr, ':');
1.54      paf       132:                // skip "//" after ':'
1.71      paf       133:                while(*url_cstr=='/')
                    134:                        url_cstr++;
                    135:                const String& protocol=*new String(protocol_cstr);
1.54      paf       136: 
                    137:                SQL_Driver *driver;
                    138:                // first trying to get cached driver
1.71      paf       139:                if(!(driver=get_driver_from_cache(protocol))) {
1.54      paf       140:                        // no cached
1.71      paf       141:                        const String* library=0;
                    142:                        const String* dlopen_file_spec=0;
1.70      paf       143:                        Table::Action_options options;
1.71      paf       144:                        if(protocol2driver_and_client->locate(0, protocol, options)) {
                    145:                                if(!(library=protocol2driver_and_client->item(1)) || library->length()==0)
1.99      moko      146:                                        throw Exception(PARSER_RUNTIME, 0, "driver library column for protocol '%s' is empty", protocol_cstr);
1.54      paf       147:                                dlopen_file_spec=protocol2driver_and_client->item(2);
                    148:                        } else
1.99      moko      149:                                throw Exception(PARSER_RUNTIME, &aurl, "undefined protocol '%s'", protocol_cstr);
1.71      paf       150: 
1.92      moko      151:                        pa_dlinit();
1.54      paf       152: 
1.90      misha     153:                        const char* filename=library->taint_cstr(String::L_FILE_SPEC);
1.54      paf       154:                        lt_dlhandle handle=lt_dlopen(filename);
1.79      paf       155:                        if (!handle) {
                    156:                                const char* error=lt_dlerror();
1.104     moko      157:                                throw Exception(0, library, error ? error : "cannot open the module");
1.79      paf       158:                        }
1.54      paf       159: 
1.86      paf       160:                        SQL_Driver_create_func create=(SQL_Driver_create_func)(lt_dlsym(handle, 
                    161:                                SQL_DRIVER_CREATE_NAME));
1.54      paf       162:                        if(!create)
1.99      moko      163:                                throw Exception(0, library, "function '" SQL_DRIVER_CREATE_NAME "' was not found");
1.54      paf       164: 
                    165:                        // create library-driver!
                    166:                        driver=(*create)();
                    167: 
                    168:                        // validate driver api version
                    169:                        int driver_api_version=driver->api_version();
                    170:                        if(driver_api_version!=SQL_DRIVER_API_VERSION)
1.99      moko      171:                                throw Exception(0, library, "driver implements API version 0x%04X not equal to 0x%04X", driver_api_version, SQL_DRIVER_API_VERSION);
1.54      paf       172: 
                    173:                        // initialise by connecting to sql client dynamic link library
1.71      paf       174:                        char* dlopen_file_spec_cstr=
                    175:                                dlopen_file_spec && dlopen_file_spec->length()?
1.90      misha     176:                                dlopen_file_spec->taint_cstrm(String::L_AS_IS):0;
1.71      paf       177:                        if(const char* error=driver->initialize(dlopen_file_spec_cstr))
1.99      moko      178:                                throw Exception(0, library, "driver failed to initialize client library '%s', %s", dlopen_file_spec_cstr ? dlopen_file_spec_cstr : "unspecifed", error);
1.54      paf       179: 
                    180:                        // cache it
1.71      paf       181:                        put_driver_to_cache(protocol, driver);
1.54      paf       182:                }
                    183:        
1.88      misha     184:                connection=new SQL_Connection(aurl, *driver, arequest_charset, adocument_root);
1.71      paf       185:                // associate with pool[request]  (deassociates at close)
                    186:                connection->set_url(); 
1.54      paf       187:        }
                    188: 
1.58      paf       189:        // if not connected yet, do that now, when connection has services
                    190:        if(!connection->connected())
1.71      paf       191:                connection->connect(url_cstr);
1.58      paf       192:        // return autoclosing object for it
1.71      paf       193:        return connection;
1.54      paf       194: }
                    195: 
1.99      moko      196: void SQL_Driver_manager::close_connection(connection_cache_type::key_type url, SQL_Connection* connection) {
1.54      paf       197:        put_connection_to_cache(url, connection);
                    198: }
                    199: 
                    200: 
                    201: // driver cache
                    202: 
1.71      paf       203: SQL_Driver *SQL_Driver_manager::get_driver_from_cache(driver_cache_type::key_type protocol) {
1.54      paf       204:        SYNCHRONIZED;
                    205: 
1.71      paf       206:        return driver_cache.get(protocol);
1.54      paf       207: }
                    208: 
1.99      moko      209: void SQL_Driver_manager::put_driver_to_cache(driver_cache_type::key_type protocol, driver_cache_type::value_type driver) {
1.54      paf       210:        SYNCHRONIZED;
                    211: 
1.71      paf       212:        driver_cache.put(protocol, driver);
1.54      paf       213: }
                    214: 
                    215: // connection cache
                    216: /// @todo get rid of memory spending Stack [zeros deep inside got accumulated]
1.99      moko      217: SQL_Connection* SQL_Driver_manager::get_connection_from_cache(connection_cache_type::key_type url) {
1.54      paf       218:        SYNCHRONIZED;
                    219: 
1.71      paf       220:        if(connection_cache_type::value_type connections=connection_cache.get(url))
                    221:                while(!connections->is_empty()) { // there are cached connections to that 'url'
                    222:                        SQL_Connection* result=connections->pop();
1.54      paf       223:                        if(result->connected()) // not expired?
                    224:                                return result;
                    225:                }
                    226: 
                    227:        return 0;
                    228: }
                    229: 
1.99      moko      230: void SQL_Driver_manager::put_connection_to_cache(connection_cache_type::key_type url, SQL_Connection* connection) {
1.54      paf       231:        SYNCHRONIZED;
                    232: 
1.71      paf       233:        connection_cache_type::value_type connections=connection_cache.get(url);
1.54      paf       234:        if(!connections) { // there are no cached connections to that 'url' yet?
1.71      paf       235:                connections=new connection_cache_element_base_type;
1.54      paf       236:                connection_cache.put(url, connections);
                    237:        }       
1.71      paf       238:        connections->push(connection);
1.54      paf       239: }
                    240: 
                    241: void SQL_Driver_manager::maybe_expire_cache() {
                    242:        time_t now=time(0);
                    243: 
                    244:        if(prev_expiration_pass_time<now-CHECK_EXPIRED_CONNECTIONS_SECONDS) {
1.86      paf       245:                connection_cache.for_each<time_t>(expire_connections, time_t(now-EXPIRE_UNUSED_CONNECTION_SECONDS));
1.54      paf       246: 
                    247:                prev_expiration_pass_time=now;
                    248:        }
                    249: }
                    250: 
1.76      paf       251: static void add_connection_to_status_cache_table(SQL_Connection& connection, Table* table) {
1.54      paf       252:        if(connection.connected()) {
1.76      paf       253:                ArrayString& row=*new ArrayString;
1.54      paf       254: 
                    255:                // url
1.76      paf       256:                row+=&connection.services().url_without_login();
1.54      paf       257:                // time
1.58      paf       258:                time_t time_used=connection.get_time_used();
1.76      paf       259:                row+=new String(pa_strdup(ctime(&time_used)));
1.54      paf       260: 
1.76      paf       261:                *table+=&row;
1.54      paf       262:        }
                    263: }
1.99      moko      264: 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) {
1.103     moko      265:        for(Array_iterator<SQL_Connection*> i(*stack); i; )
1.77      paf       266:                add_connection_to_status_cache_table(*i.next(), table);
1.76      paf       267: }
                    268: 
1.71      paf       269: Value* SQL_Driver_manager::get_status() {
                    270:        Value* result=new VHash;
1.76      paf       271: 
1.54      paf       272:        // cache
                    273:        {
1.76      paf       274:                ArrayString& columns=*new ArrayString;
1.71      paf       275:                columns+=new String("url");
                    276:                columns+=new String("time");
1.76      paf       277:                Table& table=*new Table(&columns, connection_cache.count());
1.54      paf       278: 
1.86      paf       279:                connection_cache.for_each<Table*>(add_connections_to_status_cache_table, &table);
1.54      paf       280: 
1.76      paf       281:                result->get_hash()->put(*new String("cache"), new VTable(&table));
                    282:        }
1.54      paf       283: 
                    284:        return result;
1.57      paf       285: }

E-mail: