OpenSRF/src/libstack/osrf_app_session.c

   1 #include "osrf_app_session.h"
   2 #include <time.h>
   3
   4 /* the global app_session cache */
   5 osrf_app_session* app_session_cache;
   6
   7
   8
   9 // --------------------------------------------------------------------------
  10 // --------------------------------------------------------------------------
  11 // Request API
  12 // --------------------------------------------------------------------------
  13
  14 /** Allocation and initializes a new app_request object */
  15 osrf_app_request* _osrf_app_request_init(
  16                 osrf_app_session* session, osrf_message* msg ) {
  17
  18         osrf_app_request* req =
  19                 (osrf_app_request*) safe_malloc(sizeof(osrf_app_request));
  20
  21         req->session            = session;
  22         req->request_id = msg->thread_trace;
  23         req->complete           = 0;
  24         req->payload            = msg;
  25         req->result                     = NULL;
  26
  27         return req;
  28
  29 }
  30
  31 /** Frees memory used by an app_request object */
  32 void _osrf_app_request_free( osrf_app_request * req ){
  33         if( req == NULL ) return;
  34
  35         if( req->payload ) {
  36                 osrf_message_free( req->payload );
  37         }
  38
  39         /*
  40         osrf_message* cur_msg = req->result;
  41         while( cur_msg != NULL ) {
  42                 osrf_message* next_msg = cur_msg->next;
  43                 osrf_message_free( cur_msg );
  44                 cur_msg = next_msg;
  45         }
  46         osrf_message_free( req->payload );
  47         */
  48
  49         free( req );
  50         debug_handler("after request free");
  51 }
  52
  53 /** Pushes the given message onto the list of 'responses' to this request */
  54 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
  55         if(req == NULL || result == NULL) return;
  56         debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
  57         if(req->result == NULL)
  58                 req->result = result;
  59         else {
  60                 result->next = req->result;
  61                 req->result = result;
  62         }
  63 }
  64
  65 /** Removes this app_request from our session request set */
  66 void osrf_app_session_request_finish(
  67                 osrf_app_session* session, int req_id ){
  68
  69         if(session == NULL) return;
  70         debug_handler("Finishing request %d", req_id );
  71         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
  72         if(req == NULL) return;
  73         _osrf_app_session_remove_request( req->session, req );
  74         _osrf_app_request_free( req );
  75 }
  76
  77
  78 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id ) {
  79         if(session == NULL) return;
  80         debug_handler("Resetting timeout %d", req_id );
  81         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
  82         if(req == NULL) return;
  83         req->reset_timeout = 1;
  84 }
  85
  86 /** Checks the receive queue for messages.  If any are found, the first
  87   * is popped off and returned.  Otherwise, this method will wait at most timeout
  88   * seconds for a message to appear in the receive queue.  Once it arrives it is returned.
  89   * If no messages arrive in the timeout provided, null is returned.
  90   */
  91 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
  92
  93         if(req == NULL) return NULL;
  94
  95         if( req->result != NULL ) {
  96                 debug_handler("app_request receive already has a message, returning it");
  97                 /* pop off the first message in the list */
  98                 osrf_message* tmp_msg = req->result;
  99                 req->result = req->result->next;
 100                 return tmp_msg;
 101         }
 102
 103         time_t start = time(NULL);
 104         time_t remaining = (time_t) timeout;
 105
 106         while( remaining >= 0 ) {
 107                 /* tell the session to wait for stuff */
 108                 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
 109
 110                 osrf_app_session_queue_wait( req->session, 0 );
 111
 112                 if( req->result != NULL ) { /* if we received anything */
 113                         /* pop off the first message in the list */
 114                         debug_handler( "app_request_recv received a message, returning it");
 115                         osrf_message* ret_msg = req->result;
 116                         osrf_message* tmp_msg = ret_msg->next;
 117                         req->result = tmp_msg;
 118                         return ret_msg;
 119                 }
 120
 121                 if( req->complete )
 122                         return NULL;
 123
 124                 osrf_app_session_queue_wait( req->session, (int) remaining );
 125
 126                 if( req->result != NULL ) { /* if we received anything */
 127                         /* pop off the first message in the list */
 128                         debug_handler( "app_request_recv received a message, returning it");
 129                         osrf_message* ret_msg = req->result;
 130                         osrf_message* tmp_msg = ret_msg->next;
 131                         req->result = tmp_msg;
 132                         return ret_msg;
 133                 }
 134                 if( req->complete )
 135                         return NULL;
 136
 137                 if(req->reset_timeout) {
 138                         remaining = (time_t) timeout;
 139                         req->reset_timeout = 0;
 140                         debug_handler("Recevied a timeout reset");
 141                 } else {
 142                         remaining -= (int) (time(NULL) - start);
 143                 }
 144         }
 145
 146         debug_handler("Returning NULL from app_request_recv after timeout");
 147         return NULL;
 148 }
 149
 150 /** Resend this requests original request message */
 151 int _osrf_app_request_resend( osrf_app_request* req ) {
 152         if(req == NULL) return 0;
 153         if(!req->complete) {
 154                 debug_handler( "Resending request [%d]", req->request_id );
 155                 return _osrf_app_session_send( req->session, req->payload );
 156         }
 157         return 1;
 158 }
 159
 160
 161
 162 // --------------------------------------------------------------------------
 163 // --------------------------------------------------------------------------
 164 // Session API
 165 // --------------------------------------------------------------------------
 166
 167 /** returns a session from the global session hash */
 168 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
 169         osrf_app_session* ptr = app_session_cache;
 170         debug_handler("Searching for session in global cache with id [%s]", session_id );
 171         while( ptr != NULL ) {
 172                 if( !strcmp(ptr->session_id,session_id) )
 173                         return ptr;
 174                 ptr = ptr->next;
 175         }
 176         return NULL;
 177 }
 178
 179
 180 /** adds a session to the global session cache */
 181 void _osrf_app_session_push_session( osrf_app_session* session ) {
 182
 183         if( app_session_cache == NULL ) {
 184                 app_session_cache = session;
 185                 return;
 186         }
 187
 188         osrf_app_session* ptr = app_session_cache;
 189         debug_handler( "Pushing [%s] [%s] onto global session cache",
 190                         session->remote_service, session->session_id );
 191         while( ptr != NULL ) {
 192                 if( !strcmp(ptr->session_id, session->session_id) )
 193                         return;
 194                 if( ptr->next == NULL ) {
 195                         ptr->next = session;
 196                         return;
 197                 }
 198                 ptr = ptr->next;
 199         }
 200 }
 201
 202
 203 /** unlinks from global session cache */
 204 void _osrf_app_session_remove_session( char* session_id ) {
 205
 206         if( app_session_cache == NULL )
 207                 return;
 208
 209         debug_handler( "App Session removing session [%s] from global cache", session_id );
 210         if( !strcmp(app_session_cache->session_id, session_id) ) {
 211                 if( app_session_cache->next != NULL ) {
 212                         osrf_app_session* next = app_session_cache->next;
 213                         app_session_cache = next;
 214                         return;
 215                 } else {
 216                         app_session_cache = NULL;
 217                         return;
 218                 }
 219         }
 220
 221         if( app_session_cache->next == NULL )
 222                 return;
 223
 224         osrf_app_session* prev = app_session_cache;
 225         osrf_app_session* ptr = prev->next;
 226         while( ptr != NULL ) {
 227                 if( ptr->session_id == session_id ) {
 228                         osrf_app_session* tmp = ptr->next;
 229                         prev->next = tmp;
 230                         return;
 231                 }
 232                 ptr = ptr->next;
 233         }
 234 }
 235
 236 /** Allocates a initializes a new app_session */
 237
 238 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
 239
 240         osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
 241
 242         session->transport_handle = osrf_system_get_transport_client();
 243         if( session->transport_handle == NULL ) {
 244                 warning_handler("No transport client for service 'client'");
 245                 return NULL;
 246         }
 247
 248         char target_buf[512];
 249         memset(target_buf,0,512);
 250         char* domain    = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
 251         char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
 252         sprintf( target_buf, "%s@%s/%s",  router_name, domain, remote_service );
 253         free(domain);
 254         free(router_name);
 255
 256         session->request_queue = NULL;
 257         session->remote_id = strdup(target_buf);
 258         session->orig_remote_id = strdup(session->remote_id);
 259         session->remote_service = strdup(remote_service);
 260
 261         #ifdef ASSUME_STATELESS
 262         session->stateless = 1;
 263         debug_handler("session is stateless");
 264         #else
 265         session->stateless = 0;
 266         debug_handler("session is NOT stateless");
 267         #endif
 268
 269         /* build a chunky, random session id */
 270         char id[256];
 271         memset(id,0,256);
 272
 273         sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
 274         session->session_id = strdup(id);
 275         debug_handler( "Building a new client session with id [%s] [%s]",
 276                         session->remote_service, session->session_id );
 277
 278         session->thread_trace = 0;
 279         session->state = OSRF_SESSION_DISCONNECTED;
 280         session->type = OSRF_SESSION_CLIENT;
 281         session->next = NULL;
 282         _osrf_app_session_push_session( session );
 283         return session;
 284 }
 285
 286 osrf_app_session* osrf_app_server_session_init(
 287                 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
 288
 289         osrf_app_session* session = osrf_app_session_find_session( session_id );
 290         if(session)
 291                 return session;
 292
 293
 294         session = safe_malloc(sizeof(osrf_app_session));
 295
 296         session->transport_handle = osrf_system_get_transport_client();
 297         if( session->transport_handle == NULL ) {
 298                 warning_handler("No transport client for service '%s'", our_app );
 299                 return NULL;
 300         }
 301         session->request_queue = NULL;
 302         session->remote_id = strdup(remote_id);
 303         session->orig_remote_id = strdup(remote_id);
 304         session->session_id = strdup(session_id);
 305         session->remote_service = strdup(remote_service);
 306
 307         #ifdef ASSUME_STATELESS
 308         session->stateless = 1;
 309         #else
 310         session->stateless = 0;
 311         #endif
 312
 313         debug_handler( "Building a new server session [%s] with id [%s]",
 314                         session->remote_service,  session_id );
 315
 316         session->thread_trace = 0;
 317         session->state = OSRF_SESSION_DISCONNECTED;
 318         session->type = OSRF_SESSION_CLIENT;
 319         session->next = NULL;
 320
 321         _osrf_app_session_push_session( session );
 322         return session;
 323
 324 }
 325
 326
 327
 328 /** frees memory held by a session */
 329 void _osrf_app_session_free( osrf_app_session* session ){
 330         if(session==NULL)
 331                 return;
 332
 333         free(session->remote_id);
 334         free(session->orig_remote_id);
 335         free(session->session_id);
 336         free(session->remote_service);
 337         free(session);
 338 }
 339
 340
 341 /*
 342 int osrf_app_session_make_request(
 343                 osrf_app_session* session, json* params,
 344                 char* method_name, int protocol, string_array* param_strings ) {
 345         if(session == NULL) return -1;
 346
 347         osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
 348         osrf_message_set_request_info( req_msg,  method_name, params );
 349
 350         if(!req_msg->parse_json_params && param_strings) {
 351                 int i;
 352                 for(i = 0; i!= param_strings->size ; i++ ) {
 353                         osrf_message_add_param(req_msg,
 354                                 string_array_get_string(param_strings,i));
 355                 }
 356         }
 357
 358         osrf_app_request* req = _osrf_app_request_init( session, req_msg );
 359         if(!_osrf_app_session_send( session, req_msg ) ) {
 360                 warning_handler( "Error sending request message [%d]", session->thread_trace );
 361                 return -1;
 362         }
 363
 364         _osrf_app_session_push_request( session, req );
 365         return req->request_id;
 366 }
 367 */
 368
 369
 370
 371
 372 int osrf_app_session_make_req(
 373                 osrf_app_session* session, object* params,
 374                 char* method_name, int protocol, string_array* param_strings ) {
 375         if(session == NULL) return -1;
 376
 377         osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
 378         osrf_message_set_method(req_msg, method_name);
 379         if(params) {
 380                 osrf_message_set_params(req_msg, params);
 381
 382         } else {
 383
 384                 if(param_strings) {
 385                         int i;
 386                         for(i = 0; i!= param_strings->size ; i++ ) {
 387                                 osrf_message_add_param(req_msg,
 388                                         string_array_get_string(param_strings,i));
 389                         }
 390                 }
 391         }
 392
 393         osrf_app_request* req = _osrf_app_request_init( session, req_msg );
 394         if(!_osrf_app_session_send( session, req_msg ) ) {
 395                 warning_handler( "Error sending request message [%d]", session->thread_trace );
 396                 return -1;
 397         }
 398
 399         _osrf_app_session_push_request( session, req );
 400         return req->request_id;
 401 }
 402
 403
 404
 405 /** Adds an app_request to the request set */
 406 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
 407         if(session == NULL || req == NULL)
 408                 return;
 409
 410         debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
 411                         req->request_id, session->remote_service, session->session_id );
 412
 413         if(session->request_queue == NULL)
 414                 session->request_queue = req;
 415         else {
 416                 osrf_app_request* req2 = session->request_queue->next;
 417                 session->request_queue = req;
 418                 req->next = req2;
 419         }
 420 }
 421
 422
 423
 424 /** Removes an app_request from this session request set */
 425 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
 426         if(session == NULL || req == NULL)
 427                 return;
 428
 429         if(session->request_queue == NULL)
 430                 return;
 431
 432         debug_handler("Removing request [%d] from session [%s] [%s]",
 433                         req->request_id, session->remote_service, session->session_id );
 434
 435         osrf_app_request* first = session->request_queue;
 436         if(first->request_id == req->request_id) {
 437                 session->request_queue = first->next;
 438                 return;
 439                 /*
 440                 if(first->next == NULL) {
 441                         session->request_queue = NULL;
 442                 } else {
 443                         osrf_app_request* tmp = first->next;
 444                         session->request_queue = tmp;
 445                 }
 446                 */
 447         }
 448
 449         osrf_app_request* lead = first->next;
 450
 451         while( lead != NULL ) {
 452                 if(lead->request_id == req->request_id) {
 453                         first->next = lead->next;
 454                         return;
 455                 }
 456                 first = lead;
 457                 lead = lead->next;
 458         }
 459 }
 460
 461
 462 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
 463         if(session == NULL)
 464                 return;
 465
 466         osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
 467         if(req) req->complete = 1;
 468 }
 469
 470 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
 471         if(session == NULL)
 472                 return 0;
 473         osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
 474         if(req)
 475                 return req->complete;
 476         return 0;
 477 }
 478
 479 /** Returns the app_request with the given request_id (request_id) */
 480 osrf_app_request* _osrf_app_session_get_request(
 481                 osrf_app_session* session, int request_id ){
 482         if(session == NULL)
 483                 return NULL;
 484
 485         debug_handler( "App Session searching for request [%d] in request queue",request_id );
 486         osrf_app_request* req = session->request_queue;
 487         while( req != NULL ) {
 488                 if(req->request_id == request_id)
 489                         return req;
 490                 req = req->next;
 491         }
 492         return NULL;
 493 }
 494
 495
 496 /** Resets the remote connection id to that of the original*/
 497 void osrf_app_session_reset_remote( osrf_app_session* session ){
 498         if( session==NULL )
 499                 return;
 500
 501         free(session->remote_id);
 502         debug_handler( "App Session [%s] [%s] resetting remote id to %s",
 503                         session->remote_service, session->session_id, session->orig_remote_id );
 504
 505         session->remote_id = strdup(session->orig_remote_id);
 506 }
 507
 508 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
 509         if(session == NULL)
 510                 return;
 511         if( session->remote_id )
 512                 free(session->remote_id );
 513         session->remote_id = strdup( remote_id );
 514 }
 515
 516 /** pushes the given message into the result list of the app_request
 517   with the given request_id */
 518 int osrf_app_session_push_queue(
 519                 osrf_app_session* session, osrf_message* msg ){
 520
 521         if(session == NULL || msg == NULL)
 522                 return 0;
 523
 524         debug_handler( "AppSession pushing result for [%d] onto request payload queue",
 525                         msg->thread_trace );
 526
 527         osrf_app_request* req = session->request_queue;
 528
 529         if(req == NULL) {
 530                 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
 531                 return 0;
 532         }
 533
 534         while( req != NULL ) {
 535                 if(req->request_id == msg->thread_trace) {
 536                         debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
 537                         _osrf_app_request_push_queue( req, msg );
 538                         return 1;
 539                 }
 540                 req = req->next;
 541         }
 542
 543         return 0;
 544
 545 }
 546
 547 /** Attempts to connect to the remote service */
 548 int osrf_app_session_connect(osrf_app_session* session){
 549
 550         if(session == NULL)
 551                 return 0;
 552
 553         if(session->state == OSRF_SESSION_CONNECTED) {
 554                 debug_handler("Already Connected, returning");
 555                 return 1;
 556         }
 557
 558         int timeout = 5; /* XXX CONFIG VALUE */
 559
 560         debug_handler( "AppSession connecting to %s", session->remote_id );
 561
 562         /* defaulting to protocol 1 for now */
 563         osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
 564         osrf_app_session_reset_remote( session );
 565         session->state = OSRF_SESSION_CONNECTING;
 566         int ret = _osrf_app_session_send( session, con_msg );
 567         osrf_message_free(con_msg);
 568         if(!ret)        return 0;
 569
 570         time_t start = time(NULL);
 571         time_t remaining = (time_t) timeout;
 572
 573         while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
 574                 osrf_app_session_queue_wait( session, remaining );
 575                 remaining -= (int) (time(NULL) - start);
 576         }
 577
 578         if(session->state == OSRF_SESSION_CONNECTED)
 579                 debug_handler(" * Connected Successfully");
 580
 581         if(session->state != OSRF_SESSION_CONNECTED)
 582                 return 0;
 583
 584         return 1;
 585 }
 586
 587
 588
 589 /** Disconnects from the remote service */
 590 int osrf_app_session_disconnect( osrf_app_session* session){
 591         if(session == NULL)
 592                 return 1;
 593
 594         if(session->state == OSRF_SESSION_DISCONNECTED)
 595                 return 1;
 596
 597         if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
 598                 debug_handler(
 599                                 "Exiting disconnect on stateless session %s",
 600                                 session->session_id);
 601                 return 1;
 602         }
 603
 604         debug_handler( "AppSession disconnecting from %s", session->remote_id );
 605
 606         osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
 607         session->state = OSRF_SESSION_DISCONNECTED;
 608         _osrf_app_session_send( session, dis_msg );
 609
 610         osrf_message_free( dis_msg );
 611         osrf_app_session_reset_remote( session );
 612         return 1;
 613 }
 614
 615 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
 616         debug_handler("In reqeust resend searching for resend-able messages");
 617         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
 618         return _osrf_app_request_resend( req );
 619 }
 620
 621 /** Send the given message */
 622 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
 623         if(session == NULL) return 0;
 624         int ret_val= 0;
 625
 626         osrf_app_session_queue_wait( session, 0 );
 627         debug_handler( "AppSession sending type %d, and thread_trace %d",
 628                         msg->m_type, msg->thread_trace );
 629
 630         if(session->stateless) {
 631                 osrf_app_session_reset_remote(session);
 632
 633         } else {
 634
 635                 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
 636                                 (session->state != OSRF_SESSION_CONNECTED) ) {
 637                         if(!osrf_app_session_connect( session ))
 638                                 return 0;
 639                 }
 640         }
 641
 642         //char* xml =  osrf_message_to_xml(msg);
 643         char* string =  osrf_message_serialize(msg);
 644
 645         debug_handler("[%s] [%s] Remote Id: %s",
 646                         session->remote_service, session->session_id, session->remote_id );
 647
 648         transport_message* t_msg = message_init(
 649                         string, "", session->session_id, session->remote_id, NULL );
 650
 651         debug_handler("Session [%s] [%s]  sending to %s \nXML:\n%s",
 652                         session->remote_service, session->session_id, t_msg->recipient, string );
 653         ret_val = client_send_message( session->transport_handle, t_msg );
 654         free(string);
 655         message_free( t_msg );
 656
 657         return ret_val;
 658 }
 659
 660 /**  Waits up to 'timeout' seconds for some data to arrive.
 661   * Any data that arrives will be processed according to its
 662   * payload and message type.  This method will return after
 663   * any data has arrived.
 664   */
 665 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
 666         if(session == NULL) return 0;
 667         int ret_val = 0;
 668         debug_handler( "AppSession in queue_wait with timeout %d", timeout );
 669         ret_val = osrf_stack_process(session->transport_handle, timeout );
 670         return ret_val;
 671 }
 672
 673 /** Disconnects (if client) and removes the given session from the global session cache
 674   * ! This free's all attached app_requests !
 675   */
 676 void osrf_app_session_destroy ( osrf_app_session* session ){
 677         if(session == NULL) return;
 678
 679         debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
 680                         session->remote_service, session->session_id );
 681         if(session->type == OSRF_SESSION_CLIENT
 682                         && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
 683                 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
 684                 _osrf_app_session_send( session, dis_msg );
 685                 osrf_message_free(dis_msg);
 686         }
 687         //session->state = OSRF_SESSION_DISCONNECTED;
 688         _osrf_app_session_remove_session(session->session_id);
 689         debug_handler("AppSession [%s] [%s] removed from cache",
 690                         session->remote_service, session->session_id );
 691
 692         osrf_app_request* req;
 693         while( session->request_queue != NULL ) {
 694                 req = session->request_queue->next;
 695                 _osrf_app_request_free( session->request_queue );
 696                 session->request_queue = req;
 697         }
 698
 699         _osrf_app_session_free( session );
 700 }
 701
 702 osrf_message* osrf_app_session_request_recv(
 703                 osrf_app_session* session, int req_id, int timeout ) {
 704         if(req_id < 0 || session == NULL)
 705                 return NULL;
 706         debug_handler("somebody callled recv");
 707         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
 708         return _osrf_app_request_recv( req, timeout );
 709 }
 710