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