1 #include "osrf_app_session.h"
4 /* the global app_session cache */
5 osrf_app_session* app_session_cache;
9 // --------------------------------------------------------------------------
10 // --------------------------------------------------------------------------
12 // --------------------------------------------------------------------------
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 ) {
18 osrf_app_request* req =
19 (osrf_app_request*) safe_malloc(sizeof(osrf_app_request));
21 req->session = session;
22 req->request_id = msg->thread_trace;
31 /** Frees memory used by an app_request object */
32 void _osrf_app_request_free( osrf_app_request * req ){
33 if( req == NULL ) return;
36 osrf_message_free( req->payload );
40 osrf_message* cur_msg = req->result;
41 while( cur_msg != NULL ) {
42 osrf_message* next_msg = cur_msg->next;
43 osrf_message_free( cur_msg );
46 osrf_message_free( req->payload );
50 debug_handler("after request free");
53 /** Pushes the given message onto the list of 'responses' to this request */
54 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
55 if(req == NULL || result == NULL) return;
56 debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
57 if(req->result == NULL)
60 result->next = req->result;
65 /** Removes this app_request from our session request set */
66 void osrf_app_session_request_finish(
67 osrf_app_session* session, int req_id ){
69 if(session == NULL) return;
70 debug_handler("Finishing request %d", req_id );
71 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
72 if(req == NULL) return;
73 _osrf_app_session_remove_request( req->session, req );
74 _osrf_app_request_free( req );
78 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id ) {
79 if(session == NULL) return;
80 debug_handler("Resetting timeout %d", req_id );
81 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
82 if(req == NULL) return;
83 req->reset_timeout = 1;
86 /** Checks the receive queue for messages. If any are found, the first
87 * is popped off and returned. Otherwise, this method will wait at most timeout
88 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
89 * If no messages arrive in the timeout provided, null is returned.
91 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
93 if(req == NULL) return NULL;
95 if( req->result != NULL ) {
96 debug_handler("app_request receive already has a message, returning it");
97 /* pop off the first message in the list */
98 osrf_message* tmp_msg = req->result;
99 req->result = req->result->next;
103 time_t start = time(NULL);
104 time_t remaining = (time_t) timeout;
106 while( remaining >= 0 ) {
107 /* tell the session to wait for stuff */
108 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
110 osrf_app_session_queue_wait( req->session, 0 );
112 if( req->result != NULL ) { /* if we received anything */
113 /* pop off the first message in the list */
114 debug_handler( "app_request_recv received a message, returning it");
115 osrf_message* ret_msg = req->result;
116 osrf_message* tmp_msg = ret_msg->next;
117 req->result = tmp_msg;
124 osrf_app_session_queue_wait( req->session, (int) remaining );
126 if( req->result != NULL ) { /* if we received anything */
127 /* pop off the first message in the list */
128 debug_handler( "app_request_recv received a message, returning it");
129 osrf_message* ret_msg = req->result;
130 osrf_message* tmp_msg = ret_msg->next;
131 req->result = tmp_msg;
137 if(req->reset_timeout) {
138 remaining = (time_t) timeout;
139 req->reset_timeout = 0;
140 debug_handler("Recevied a timeout reset");
142 remaining -= (int) (time(NULL) - start);
146 debug_handler("Returning NULL from app_request_recv after timeout");
150 /** Resend this requests original request message */
151 int _osrf_app_request_resend( osrf_app_request* req ) {
152 if(req == NULL) return 0;
154 debug_handler( "Resending request [%d]", req->request_id );
155 return _osrf_app_session_send( req->session, req->payload );
162 // --------------------------------------------------------------------------
163 // --------------------------------------------------------------------------
165 // --------------------------------------------------------------------------
167 /** returns a session from the global session hash */
168 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
169 osrf_app_session* ptr = app_session_cache;
170 debug_handler("Searching for session in global cache with id [%s]", session_id );
171 while( ptr != NULL ) {
172 if( !strcmp(ptr->session_id,session_id) )
180 /** adds a session to the global session cache */
181 void _osrf_app_session_push_session( osrf_app_session* session ) {
183 if( app_session_cache == NULL ) {
184 app_session_cache = session;
188 osrf_app_session* ptr = app_session_cache;
189 debug_handler( "Pushing [%s] [%s] onto global session cache",
190 session->remote_service, session->session_id );
191 while( ptr != NULL ) {
192 if( !strcmp(ptr->session_id, session->session_id) )
194 if( ptr->next == NULL ) {
203 /** unlinks from global session cache */
204 void _osrf_app_session_remove_session( char* session_id ) {
206 if( app_session_cache == NULL )
209 debug_handler( "App Session removing session [%s] from global cache", session_id );
210 if( !strcmp(app_session_cache->session_id, session_id) ) {
211 if( app_session_cache->next != NULL ) {
212 osrf_app_session* next = app_session_cache->next;
213 app_session_cache = next;
216 app_session_cache = NULL;
221 if( app_session_cache->next == NULL )
224 osrf_app_session* prev = app_session_cache;
225 osrf_app_session* ptr = prev->next;
226 while( ptr != NULL ) {
227 if( ptr->session_id == session_id ) {
228 osrf_app_session* tmp = ptr->next;
236 /** Allocates a initializes a new app_session */
238 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
240 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
242 session->transport_handle = osrf_system_get_transport_client();
243 if( session->transport_handle == NULL ) {
244 warning_handler("No transport client for service 'client'");
248 char target_buf[512];
249 memset(target_buf,0,512);
250 char* domain = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
251 char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
252 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
256 session->request_queue = NULL;
257 session->remote_id = strdup(target_buf);
258 session->orig_remote_id = strdup(session->remote_id);
259 session->remote_service = strdup(remote_service);
261 #ifdef ASSUME_STATELESS
262 session->stateless = 1;
263 debug_handler("session is stateless");
265 session->stateless = 0;
266 debug_handler("session is NOT stateless");
269 /* build a chunky, random session id */
273 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
274 session->session_id = strdup(id);
275 debug_handler( "Building a new client session with id [%s] [%s]",
276 session->remote_service, session->session_id );
278 session->thread_trace = 0;
279 session->state = OSRF_SESSION_DISCONNECTED;
280 session->type = OSRF_SESSION_CLIENT;
281 session->next = NULL;
282 _osrf_app_session_push_session( session );
286 osrf_app_session* osrf_app_server_session_init(
287 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
289 osrf_app_session* session = osrf_app_session_find_session( session_id );
294 session = safe_malloc(sizeof(osrf_app_session));
296 session->transport_handle = osrf_system_get_transport_client();
297 if( session->transport_handle == NULL ) {
298 warning_handler("No transport client for service '%s'", our_app );
301 session->request_queue = NULL;
302 session->remote_id = strdup(remote_id);
303 session->orig_remote_id = strdup(remote_id);
304 session->session_id = strdup(session_id);
305 session->remote_service = strdup(remote_service);
307 #ifdef ASSUME_STATELESS
308 session->stateless = 1;
310 session->stateless = 0;
313 debug_handler( "Building a new server session [%s] with id [%s]",
314 session->remote_service, session_id );
316 session->thread_trace = 0;
317 session->state = OSRF_SESSION_DISCONNECTED;
318 session->type = OSRF_SESSION_CLIENT;
319 session->next = NULL;
321 _osrf_app_session_push_session( session );
328 /** frees memory held by a session */
329 void _osrf_app_session_free( osrf_app_session* session ){
333 free(session->remote_id);
334 free(session->orig_remote_id);
335 free(session->session_id);
336 free(session->remote_service);
342 int osrf_app_session_make_request(
343 osrf_app_session* session, json* params,
344 char* method_name, int protocol, string_array* param_strings ) {
345 if(session == NULL) return -1;
347 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
348 osrf_message_set_request_info( req_msg, method_name, params );
350 if(!req_msg->parse_json_params && param_strings) {
352 for(i = 0; i!= param_strings->size ; i++ ) {
353 osrf_message_add_param(req_msg,
354 string_array_get_string(param_strings,i));
358 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
359 if(!_osrf_app_session_send( session, req_msg ) ) {
360 warning_handler( "Error sending request message [%d]", session->thread_trace );
364 _osrf_app_session_push_request( session, req );
365 return req->request_id;
372 int osrf_app_session_make_req(
373 osrf_app_session* session, object* params,
374 char* method_name, int protocol, string_array* param_strings ) {
375 if(session == NULL) return -1;
377 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
378 //osrf_message_set_request_info( req_msg, method_name, params );
379 osrf_message_set_method(req_msg, method_name);
380 if(params) osrf_message_set_params(req_msg, params);
382 /* if we're not parsing the json, shove the strings in manually */
383 if(!req_msg->parse_json_params && param_strings) {
385 for(i = 0; i!= param_strings->size ; i++ ) {
386 osrf_message_add_param(req_msg,
387 string_array_get_string(param_strings,i));
391 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
392 if(!_osrf_app_session_send( session, req_msg ) ) {
393 warning_handler( "Error sending request message [%d]", session->thread_trace );
397 _osrf_app_session_push_request( session, req );
398 return req->request_id;
403 /** Adds an app_request to the request set */
404 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
405 if(session == NULL || req == NULL)
408 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
409 req->request_id, session->remote_service, session->session_id );
411 if(session->request_queue == NULL)
412 session->request_queue = req;
414 osrf_app_request* req2 = session->request_queue->next;
415 session->request_queue = req;
422 /** Removes an app_request from this session request set */
423 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
424 if(session == NULL || req == NULL)
427 if(session->request_queue == NULL)
430 debug_handler("Removing request [%d] from session [%s] [%s]",
431 req->request_id, session->remote_service, session->session_id );
433 osrf_app_request* first = session->request_queue;
434 if(first->request_id == req->request_id) {
435 session->request_queue = first->next;
438 if(first->next == NULL) {
439 session->request_queue = NULL;
441 osrf_app_request* tmp = first->next;
442 session->request_queue = tmp;
447 osrf_app_request* lead = first->next;
449 while( lead != NULL ) {
450 if(lead->request_id == req->request_id) {
451 first->next = lead->next;
460 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
464 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
465 if(req) req->complete = 1;
468 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
471 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
473 return req->complete;
477 /** Returns the app_request with the given request_id (request_id) */
478 osrf_app_request* _osrf_app_session_get_request(
479 osrf_app_session* session, int request_id ){
483 debug_handler( "App Session searching for request [%d] in request queue",request_id );
484 osrf_app_request* req = session->request_queue;
485 while( req != NULL ) {
486 if(req->request_id == request_id)
494 /** Resets the remote connection id to that of the original*/
495 void osrf_app_session_reset_remote( osrf_app_session* session ){
499 free(session->remote_id);
500 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
501 session->remote_service, session->session_id, session->orig_remote_id );
503 session->remote_id = strdup(session->orig_remote_id);
506 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
509 if( session->remote_id )
510 free(session->remote_id );
511 session->remote_id = strdup( remote_id );
514 /** pushes the given message into the result list of the app_request
515 with the given request_id */
516 int osrf_app_session_push_queue(
517 osrf_app_session* session, osrf_message* msg ){
519 if(session == NULL || msg == NULL)
522 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
525 osrf_app_request* req = session->request_queue;
528 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
532 while( req != NULL ) {
533 if(req->request_id == msg->thread_trace) {
534 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
535 _osrf_app_request_push_queue( req, msg );
545 /** Attempts to connect to the remote service */
546 int osrf_app_session_connect(osrf_app_session* session){
551 if(session->state == OSRF_SESSION_CONNECTED) {
552 debug_handler("Already Connected, returning");
556 int timeout = 5; /* XXX CONFIG VALUE */
558 debug_handler( "AppSession connecting to %s", session->remote_id );
560 /* defaulting to protocol 1 for now */
561 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
562 osrf_app_session_reset_remote( session );
563 session->state = OSRF_SESSION_CONNECTING;
564 int ret = _osrf_app_session_send( session, con_msg );
565 osrf_message_free(con_msg);
568 time_t start = time(NULL);
569 time_t remaining = (time_t) timeout;
571 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
572 osrf_app_session_queue_wait( session, remaining );
573 remaining -= (int) (time(NULL) - start);
576 if(session->state == OSRF_SESSION_CONNECTED)
577 debug_handler(" * Connected Successfully");
579 if(session->state != OSRF_SESSION_CONNECTED)
587 /** Disconnects from the remote service */
588 int osrf_app_session_disconnect( osrf_app_session* session){
592 if(session->state == OSRF_SESSION_DISCONNECTED)
595 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
597 "Exiting disconnect on stateless session %s",
598 session->session_id);
602 debug_handler( "AppSession disconnecting from %s", session->remote_id );
604 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
605 session->state = OSRF_SESSION_DISCONNECTED;
606 _osrf_app_session_send( session, dis_msg );
608 osrf_message_free( dis_msg );
609 osrf_app_session_reset_remote( session );
613 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
614 debug_handler("In reqeust resend searching for resend-able messages");
615 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
616 return _osrf_app_request_resend( req );
619 /** Send the given message */
620 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
621 if(session == NULL) return 0;
624 osrf_app_session_queue_wait( session, 0 );
625 debug_handler( "AppSession sending type %d, and thread_trace %d",
626 msg->m_type, msg->thread_trace );
628 if(session->stateless) {
629 osrf_app_session_reset_remote(session);
633 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
634 (session->state != OSRF_SESSION_CONNECTED) ) {
635 if(!osrf_app_session_connect( session ))
640 char* xml = osrf_message_to_xml(msg);
642 debug_handler("[%s] [%s] Remote Id: %s",
643 session->remote_service, session->session_id, session->remote_id );
645 transport_message* t_msg = message_init(
646 xml, "", session->session_id, session->remote_id, NULL );
648 debug_handler("Session [%s] [%s] sending to %s \nXML:\n%s",
649 session->remote_service, session->session_id, t_msg->recipient, xml );
650 ret_val = client_send_message( session->transport_handle, t_msg );
652 message_free( t_msg );
657 /** Waits up to 'timeout' seconds for some data to arrive.
658 * Any data that arrives will be processed according to its
659 * payload and message type. This method will return after
660 * any data has arrived.
662 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
663 if(session == NULL) return 0;
665 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
666 ret_val = osrf_stack_process(session->transport_handle, timeout );
670 /** Disconnects (if client) and removes the given session from the global session cache
671 * ! This free's all attached app_requests !
673 void osrf_app_session_destroy ( osrf_app_session* session ){
674 if(session == NULL) return;
676 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
677 session->remote_service, session->session_id );
678 if(session->type == OSRF_SESSION_CLIENT
679 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
680 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
681 _osrf_app_session_send( session, dis_msg );
682 osrf_message_free(dis_msg);
684 //session->state = OSRF_SESSION_DISCONNECTED;
685 _osrf_app_session_remove_session(session->session_id);
686 debug_handler("AppSession [%s] [%s] removed from cache",
687 session->remote_service, session->session_id );
689 osrf_app_request* req;
690 while( session->request_queue != NULL ) {
691 req = session->request_queue->next;
692 _osrf_app_request_free( session->request_queue );
693 session->request_queue = req;
696 _osrf_app_session_free( session );
699 osrf_message* osrf_app_session_request_recv(
700 osrf_app_session* session, int req_id, int timeout ) {
701 if(req_id < 0 || session == NULL)
703 debug_handler("somebody callled recv");
704 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
705 return _osrf_app_request_recv( req, timeout );