src/libstack/osrf_app_session.c

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