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