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         if( session->userDataFree && session->userData )
 305                 session->userDataFree(session->userData);
 306
 307         free(session->remote_id);
 308         free(session->orig_remote_id);
 309         free(session->session_id);
 310         free(session->remote_service);
 311         osrfListFree(session->request_queue);
 312         free(session);
 313 }
 314
 315 int osrfAppSessionMakeRequest(
 316                 osrf_app_session* session, jsonObject* params,
 317                 char* method_name, int protocol, string_array* param_strings ) {
 318
 319         return osrf_app_session_make_req( session, params,
 320                         method_name, protocol, param_strings );
 321 }
 322
 323 int osrf_app_session_make_req(
 324                 osrf_app_session* session, jsonObject* params,
 325                 char* method_name, int protocol, string_array* param_strings ) {
 326         if(session == NULL) return -1;
 327
 328         osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
 329         osrf_message_set_method(req_msg, method_name);
 330         if(params) {
 331                 osrf_message_set_params(req_msg, params);
 332
 333         } else {
 334
 335                 if(param_strings) {
 336                         int i;
 337                         for(i = 0; i!= param_strings->size ; i++ ) {
 338                                 osrf_message_add_param(req_msg,
 339                                         string_array_get_string(param_strings,i));
 340                         }
 341                 }
 342         }
 343
 344         osrf_app_request* req = _osrf_app_request_init( session, req_msg );
 345         if(_osrf_app_session_send( session, req_msg ) ) {
 346                 osrfLogWarning( OSRF_LOG_MARK,  "Error sending request message [%d]", session->thread_trace );
 347                 return -1;
 348         }
 349
 350         osrfLogDebug( OSRF_LOG_MARK,  "Pushing [%d] onto requeust queue for session [%s] [%s]",
 351                         req->request_id, session->remote_service, session->session_id );
 352         osrfListSet( session->request_queue, req, req->request_id );
 353         return req->request_id;
 354 }
 355
 356 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
 357         if(session == NULL)
 358                 return;
 359
 360         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
 361         if(req) req->complete = 1;
 362 }
 363
 364 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
 365         if(session == NULL)
 366                 return 0;
 367         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
 368         if(req)
 369                 return req->complete;
 370         return 0;
 371 }
 372
 373
 374 /** Resets the remote connection id to that of the original*/
 375 void osrf_app_session_reset_remote( osrf_app_session* session ){
 376         if( session==NULL )
 377                 return;
 378
 379         free(session->remote_id);
 380         osrfLogDebug( OSRF_LOG_MARK,  "App Session [%s] [%s] resetting remote id to %s",
 381                         session->remote_service, session->session_id, session->orig_remote_id );
 382
 383         session->remote_id = strdup(session->orig_remote_id);
 384 }
 385
 386 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
 387         if(session == NULL)
 388                 return;
 389         if( session->remote_id )
 390                 free(session->remote_id );
 391         session->remote_id = strdup( remote_id );
 392 }
 393
 394 /** pushes the given message into the result list of the app_request
 395   with the given request_id */
 396 int osrf_app_session_push_queue(
 397                 osrf_app_session* session, osrf_message* msg ){
 398         if(session == NULL || msg == NULL) return 0;
 399
 400         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, msg->thread_trace );
 401         if(req == NULL) return 0;
 402         _osrf_app_request_push_queue( req, msg );
 403
 404         return 0;
 405 }
 406
 407 int osrfAppSessionConnect( osrf_app_session* session ) {
 408         return osrf_app_session_connect(session);
 409 }
 410
 411
 412 /** Attempts to connect to the remote service */
 413 int osrf_app_session_connect(osrf_app_session* session){
 414
 415         if(session == NULL)
 416                 return 0;
 417
 418         if(session->state == OSRF_SESSION_CONNECTED) {
 419                 return 1;
 420         }
 421
 422         int timeout = 5; /* XXX CONFIG VALUE */
 423
 424         osrfLogDebug( OSRF_LOG_MARK,  "AppSession connecting to %s", session->remote_id );
 425
 426         /* defaulting to protocol 1 for now */
 427         osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
 428         osrf_app_session_reset_remote( session );
 429         session->state = OSRF_SESSION_CONNECTING;
 430         int ret = _osrf_app_session_send( session, con_msg );
 431         osrf_message_free(con_msg);
 432         if(ret) return 0;
 433
 434         time_t start = time(NULL);
 435         time_t remaining = (time_t) timeout;
 436
 437         while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
 438                 osrf_app_session_queue_wait( session, remaining );
 439                 remaining -= (int) (time(NULL) - start);
 440         }
 441
 442         if(session->state == OSRF_SESSION_CONNECTED)
 443                 osrfLogDebug( OSRF_LOG_MARK, " * Connected Successfully to %s", session->remote_service );
 444
 445         if(session->state != OSRF_SESSION_CONNECTED)
 446                 return 0;
 447
 448         return 1;
 449 }
 450
 451
 452
 453 /** Disconnects from the remote service */
 454 int osrf_app_session_disconnect( osrf_app_session* session){
 455         if(session == NULL)
 456                 return 1;
 457
 458         if(session->state == OSRF_SESSION_DISCONNECTED)
 459                 return 1;
 460
 461         if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
 462                 osrfLogDebug( OSRF_LOG_MARK,
 463                                 "Exiting disconnect on stateless session %s",
 464                                 session->session_id);
 465                 return 1;
 466         }
 467
 468         osrfLogDebug(OSRF_LOG_MARK,  "AppSession disconnecting from %s", session->remote_id );
 469
 470         osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
 471         _osrf_app_session_send( session, dis_msg );
 472         session->state = OSRF_SESSION_DISCONNECTED;
 473
 474         osrf_message_free( dis_msg );
 475         osrf_app_session_reset_remote( session );
 476         return 1;
 477 }
 478
 479 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
 480         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
 481         return _osrf_app_request_resend( req );
 482 }
 483
 484
 485 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
 486
 487         if( !(session && msgs && size > 0) ) return 0;
 488         int retval = 0;
 489
 490
 491         osrfMessage* msg = msgs[0];
 492
 493         if(msg) {
 494
 495                 osrf_app_session_queue_wait( session, 0 );
 496
 497                 if(session->state != OSRF_SESSION_CONNECTED)  {
 498
 499                         if(session->stateless) { /* stateless session always send to the root listener */
 500                                 osrf_app_session_reset_remote(session);
 501
 502                         } else {
 503
 504                                 /* do an auto-connect if necessary */
 505                                 if( ! session->stateless &&
 506                                         (msg->m_type != CONNECT) &&
 507                                         (msg->m_type != DISCONNECT) &&
 508                                         (session->state != OSRF_SESSION_CONNECTED) ) {
 509
 510                                         if(!osrf_app_session_connect( session ))
 511                                                 return 0;
 512                                 }
 513                         }
 514                 }
 515         }
 516
 517         char* string = osrfMessageSerializeBatch(msgs, size);
 518
 519         if( string ) {
 520
 521                 transport_message* t_msg = message_init(
 522                                 string, "", session->session_id, session->remote_id, NULL );
 523
 524                 osrfLogDebug(OSRF_LOG_MARK, "Session [%s] [%s]  sending to %s \nData: %s",
 525                                 session->remote_service, session->session_id, t_msg->recipient, string );
 526
 527                 retval = client_send_message( session->transport_handle, t_msg );
 528
 529                 free(string);
 530                 message_free( t_msg );
 531         }
 532
 533         return retval;
 534
 535 }
 536
 537
 538
 539 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
 540         if( !(session && msg) ) return 0;
 541         osrfMessage* a[1];
 542         a[0] = msg;
 543         return osrfAppSessionSendBatch( session, a, 1 );
 544 }
 545
 546
 547
 548
 549 /**  Waits up to 'timeout' seconds for some data to arrive.
 550   * Any data that arrives will be processed according to its
 551   * payload and message type.  This method will return after
 552   * any data has arrived.
 553   */
 554 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
 555         if(session == NULL) return 0;
 556         int ret_val = 0;
 557         osrfLogDebug(OSRF_LOG_MARK,  "AppSession in queue_wait with timeout %d", timeout );
 558         ret_val = osrf_stack_entry_point(session->transport_handle, timeout);
 559         return ret_val;
 560 }
 561
 562 /** Disconnects (if client) and removes the given session from the global session cache
 563   * ! This free's all attached app_requests !
 564   */
 565 void osrfAppSessionFree( osrfAppSession* ses ) {
 566         osrf_app_session_destroy( ses );
 567 }
 568
 569
 570 void osrf_app_session_destroy( osrf_app_session* session ){
 571         if(session == NULL) return;
 572
 573         osrfLogDebug(OSRF_LOG_MARK,  "AppSession [%s] [%s] destroying self and deleting requests",
 574                         session->remote_service, session->session_id );
 575         if(session->type == OSRF_SESSION_CLIENT
 576                         && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
 577                 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
 578                 _osrf_app_session_send( session, dis_msg );
 579                 osrf_message_free(dis_msg);
 580         }
 581
 582         osrfHashRemove( osrfAppSessionCache, session->session_id );
 583         _osrf_app_session_free( session );
 584 }
 585
 586 osrf_message* osrfAppSessionRequestRecv(
 587                 osrf_app_session* session, int req_id, int timeout ) {
 588         return osrf_app_session_request_recv( session, req_id, timeout );
 589 }
 590 osrf_message* osrf_app_session_request_recv(
 591                 osrf_app_session* session, int req_id, int timeout ) {
 592         if(req_id < 0 || session == NULL)
 593                 return NULL;
 594         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
 595         return _osrf_app_request_recv( req, timeout );
 596 }
 597
 598
 599
 600 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
 601         if(!ses || ! data ) return -1;
 602
 603         osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
 604         char* json = jsonObjectToJSON( data );
 605         osrf_message_set_result_content( msg, json );
 606         _osrf_app_session_send( ses, msg );
 607
 608         free(json);
 609         osrf_message_free( msg );
 610
 611         return 0;
 612 }
 613
 614
 615 int osrfAppRequestRespondComplete(
 616                 osrfAppSession* ses, int requestId, jsonObject* data ) {
 617
 618         osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
 619         osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
 620
 621         osrf_message* status = osrf_message_init( STATUS, requestId, 1);
 622         osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
 623
 624         if (data) {
 625                 char* json = jsonObjectToJSON( data );
 626                 osrf_message_set_result_content( payload, json );
 627                 free(json);
 628
 629                 osrfMessage* ms[2];
 630                 ms[0] = payload;
 631                 ms[1] = status;
 632
 633                 osrfAppSessionSendBatch( ses, ms, 2 );
 634
 635                 osrf_message_free( payload );
 636         } else {
 637                 osrfAppSessionSendBatch( ses, &status, 1 );
 638         }
 639
 640         osrf_message_free( status );
 641
 642         /* join and free */
 643
 644         return 0;
 645 }
 646
 647 int osrfAppSessionStatus( osrfAppSession* ses, int type, char* name, int reqId, char* message ) {
 648
 649         if(ses) {
 650                 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
 651                 osrf_message_set_status_info( msg, name, message, type );
 652                 _osrf_app_session_send( ses, msg );
 653                 osrf_message_free( msg );
 654                 return 0;
 655         }
 656         return -1;
 657 }
 658
 659
 660
 661
 662
 663