src/libstack/osrf_app_session.c

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