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 );
52 /** Pushes the given message onto the list of 'responses' to this request */
53 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
54 if(req == NULL || result == NULL) return;
55 debug_handler( "App Session pushing request [%d] onto request queue", result->thread_trace );
56 if(req->result == NULL)
59 result->next = req->result;
64 /** Removes this app_request from our session request set */
65 void osrf_app_session_request_finish(
66 osrf_app_session* session, int req_id ){
68 if(session == NULL) return;
69 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
70 if(req == NULL) return;
71 _osrf_app_session_remove_request( req->session, req );
72 _osrf_app_request_free( req );
76 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id ) {
77 if(session == NULL) return;
78 debug_handler("Resetting request timeout %d", req_id );
79 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
80 if(req == NULL) return;
81 req->reset_timeout = 1;
84 /** Checks the receive queue for messages. If any are found, the first
85 * is popped off and returned. Otherwise, this method will wait at most timeout
86 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
87 * If no messages arrive in the timeout provided, null is returned.
89 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
91 if(req == NULL) return NULL;
93 if( req->result != NULL ) {
94 /* pop off the first message in the list */
95 osrf_message* tmp_msg = req->result;
96 req->result = req->result->next;
100 time_t start = time(NULL);
101 time_t remaining = (time_t) timeout;
103 while( remaining >= 0 ) {
104 /* tell the session to wait for stuff */
105 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
107 osrf_app_session_queue_wait( req->session, 0 );
109 if( req->result != NULL ) { /* if we received anything */
110 /* pop off the first message in the list */
111 debug_handler( "app_request_recv received a message, returning it");
112 osrf_message* ret_msg = req->result;
113 osrf_message* tmp_msg = ret_msg->next;
114 req->result = tmp_msg;
121 osrf_app_session_queue_wait( req->session, (int) remaining );
123 if( req->result != NULL ) { /* if we received anything */
124 /* pop off the first message in the list */
125 debug_handler( "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;
134 if(req->reset_timeout) {
135 remaining = (time_t) timeout;
136 req->reset_timeout = 0;
137 debug_handler("Recevied a timeout reset");
139 remaining -= (int) (time(NULL) - start);
143 debug_handler("Returning NULL from app_request_recv after timeout");
147 /** Resend this requests original request message */
148 int _osrf_app_request_resend( osrf_app_request* req ) {
149 if(req == NULL) return 0;
151 debug_handler( "Resending request [%d]", req->request_id );
152 return _osrf_app_session_send( req->session, req->payload );
159 // --------------------------------------------------------------------------
160 // --------------------------------------------------------------------------
162 // --------------------------------------------------------------------------
164 /** returns a session from the global session hash */
165 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
166 osrf_app_session* ptr = app_session_cache;
167 while( ptr != NULL ) {
168 if( !strcmp(ptr->session_id,session_id) )
176 /** adds a session to the global session cache */
177 void _osrf_app_session_push_session( osrf_app_session* session ) {
179 if( app_session_cache == NULL ) {
180 app_session_cache = session;
184 osrf_app_session* ptr = app_session_cache;
185 while( ptr != NULL ) {
186 if( !strcmp(ptr->session_id, session->session_id) )
188 if( ptr->next == NULL ) {
197 /** unlinks from global session cache */
198 void _osrf_app_session_remove_session( char* session_id ) {
200 if( app_session_cache == NULL )
203 debug_handler( "App Session removing session [%s] from global cache", session_id );
204 if( !strcmp(app_session_cache->session_id, session_id) ) {
205 if( app_session_cache->next != NULL ) {
206 osrf_app_session* next = app_session_cache->next;
207 app_session_cache = next;
210 app_session_cache = NULL;
215 if( app_session_cache->next == NULL )
218 osrf_app_session* prev = app_session_cache;
219 osrf_app_session* ptr = prev->next;
220 while( ptr != NULL ) {
221 if( ptr->session_id == session_id ) {
222 osrf_app_session* tmp = ptr->next;
230 /** Allocates a initializes a new app_session */
232 osrf_app_session* osrfAppSessionClientInit( char* remote_service ) {
233 return osrf_app_client_session_init( remote_service );
236 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
238 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
240 session->transport_handle = osrf_system_get_transport_client();
241 if( session->transport_handle == NULL ) {
242 warning_handler("No transport client for service 'client'");
246 char target_buf[512];
247 memset(target_buf,0,512);
249 osrfStringArray* arr = osrfNewStringArray(8);
250 osrfConfigGetValueList(NULL, arr, "/domains/domain");
251 char* domain = osrfStringArrayGetString(arr, 0);
252 char* router_name = osrfConfigGetValue(NULL, "/router_name");
254 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
255 osrfStringArrayFree(arr);
259 session->request_queue = NULL;
260 session->remote_id = strdup(target_buf);
261 session->orig_remote_id = strdup(session->remote_id);
262 session->remote_service = strdup(remote_service);
264 #ifdef ASSUME_STATELESS
265 session->stateless = 1;
266 debug_handler("%s session is stateless", remote_service );
268 session->stateless = 0;
269 debug_handler("%s session is NOT stateless", remote_service );
272 /* build a chunky, random session id */
276 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
277 session->session_id = strdup(id);
278 debug_handler( "Building a new client session with id [%s] [%s]",
279 session->remote_service, session->session_id );
281 session->thread_trace = 0;
282 session->state = OSRF_SESSION_DISCONNECTED;
283 session->type = OSRF_SESSION_CLIENT;
284 session->next = NULL;
285 _osrf_app_session_push_session( session );
289 osrf_app_session* osrf_app_server_session_init(
290 char* session_id, char* our_app, char* remote_id ) {
292 info_handler("Initing server session with session id %s, service %s,"
293 " and remote_id %s", session_id, our_app, remote_id );
295 osrf_app_session* session = osrf_app_session_find_session( session_id );
296 if(session) return session;
298 session = safe_malloc(sizeof(osrf_app_session));
300 session->transport_handle = osrf_system_get_transport_client();
301 if( session->transport_handle == NULL ) {
302 warning_handler("No transport client for service '%s'", our_app );
307 char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
308 if(statel) stateless = atoi(statel);
312 session->request_queue = NULL;
313 session->remote_id = strdup(remote_id);
314 session->orig_remote_id = strdup(remote_id);
315 session->session_id = strdup(session_id);
316 session->remote_service = strdup(our_app);
317 session->stateless = stateless;
319 #ifdef ASSUME_STATELESS
320 session->stateless = 1;
323 session->thread_trace = 0;
324 session->state = OSRF_SESSION_DISCONNECTED;
325 session->type = OSRF_SESSION_SERVER;
326 session->next = NULL;
328 _osrf_app_session_push_session( session );
335 /** frees memory held by a session */
336 void _osrf_app_session_free( osrf_app_session* session ){
340 free(session->remote_id);
341 free(session->orig_remote_id);
342 free(session->session_id);
343 free(session->remote_service);
347 int osrfAppSessionMakeRequest(
348 osrf_app_session* session, jsonObject* params,
349 char* method_name, int protocol, string_array* param_strings ) {
351 return osrf_app_session_make_req( session, params,
352 method_name, protocol, param_strings );
355 int osrf_app_session_make_req(
356 osrf_app_session* session, jsonObject* params,
357 char* method_name, int protocol, string_array* param_strings ) {
358 if(session == NULL) return -1;
360 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
361 osrf_message_set_method(req_msg, method_name);
363 osrf_message_set_params(req_msg, params);
369 for(i = 0; i!= param_strings->size ; i++ ) {
370 osrf_message_add_param(req_msg,
371 string_array_get_string(param_strings,i));
376 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
377 if(_osrf_app_session_send( session, req_msg ) ) {
378 warning_handler( "Error sending request message [%d]", session->thread_trace );
382 _osrf_app_session_push_request( session, req );
383 return req->request_id;
388 /** Adds an app_request to the request set */
389 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
390 if(session == NULL || req == NULL)
393 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
394 req->request_id, session->remote_service, session->session_id );
396 if(session->request_queue == NULL)
397 session->request_queue = req;
399 osrf_app_request* req2 = session->request_queue->next;
400 session->request_queue = req;
407 /** Removes an app_request from this session request set */
408 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
409 if(session == NULL || req == NULL)
412 if(session->request_queue == NULL)
415 debug_handler("Removing request [%d] from session [%s] [%s]",
416 req->request_id, session->remote_service, session->session_id );
418 osrf_app_request* first = session->request_queue;
419 if(first->request_id == req->request_id) {
420 session->request_queue = first->next;
423 if(first->next == NULL) {
424 session->request_queue = NULL;
426 osrf_app_request* tmp = first->next;
427 session->request_queue = tmp;
432 osrf_app_request* lead = first->next;
434 while( lead != NULL ) {
435 if(lead->request_id == req->request_id) {
436 first->next = lead->next;
445 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
449 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
450 if(req) req->complete = 1;
453 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
456 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
458 return req->complete;
462 /** Returns the app_request with the given request_id (request_id) */
463 osrf_app_request* _osrf_app_session_get_request(
464 osrf_app_session* session, int request_id ){
468 osrf_app_request* req = session->request_queue;
469 while( req != NULL ) {
470 if(req->request_id == request_id)
478 /** Resets the remote connection id to that of the original*/
479 void osrf_app_session_reset_remote( osrf_app_session* session ){
483 free(session->remote_id);
484 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
485 session->remote_service, session->session_id, session->orig_remote_id );
487 session->remote_id = strdup(session->orig_remote_id);
490 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
493 if( session->remote_id )
494 free(session->remote_id );
495 session->remote_id = strdup( remote_id );
498 /** pushes the given message into the result list of the app_request
499 with the given request_id */
500 int osrf_app_session_push_queue(
501 osrf_app_session* session, osrf_message* msg ){
503 if(session == NULL || msg == NULL)
506 osrf_app_request* req = session->request_queue;
508 if(req == NULL) return 0;
510 while( req != NULL ) {
511 if(req->request_id == msg->thread_trace) {
512 _osrf_app_request_push_queue( req, msg );
522 /** Attempts to connect to the remote service */
523 int osrf_app_session_connect(osrf_app_session* session){
528 if(session->state == OSRF_SESSION_CONNECTED) {
532 int timeout = 5; /* XXX CONFIG VALUE */
534 debug_handler( "AppSession connecting to %s", session->remote_id );
536 /* defaulting to protocol 1 for now */
537 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
538 osrf_app_session_reset_remote( session );
539 session->state = OSRF_SESSION_CONNECTING;
540 int ret = _osrf_app_session_send( session, con_msg );
541 osrf_message_free(con_msg);
544 time_t start = time(NULL);
545 time_t remaining = (time_t) timeout;
547 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
548 osrf_app_session_queue_wait( session, remaining );
549 remaining -= (int) (time(NULL) - start);
552 if(session->state == OSRF_SESSION_CONNECTED)
553 debug_handler(" * Connected Successfully to %s", session->remote_service );
555 if(session->state != OSRF_SESSION_CONNECTED)
563 /** Disconnects from the remote service */
564 int osrf_app_session_disconnect( osrf_app_session* session){
568 if(session->state == OSRF_SESSION_DISCONNECTED)
571 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
573 "Exiting disconnect on stateless session %s",
574 session->session_id);
578 debug_handler( "AppSession disconnecting from %s", session->remote_id );
580 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
581 session->state = OSRF_SESSION_DISCONNECTED;
582 _osrf_app_session_send( session, dis_msg );
584 osrf_message_free( dis_msg );
585 osrf_app_session_reset_remote( session );
589 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
590 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
591 return _osrf_app_request_resend( req );
595 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
597 if( !(session && msgs && size > 0) ) return 0;
601 osrfMessage* msg = msgs[0];
605 osrf_app_session_queue_wait( session, 0 );
607 /* if we're not stateless and the first message is not a connect
608 message, then we do the connect first */
609 if(session->stateless) {
610 osrf_app_session_reset_remote(session);
614 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
615 (session->state != OSRF_SESSION_CONNECTED) ) {
616 if(!osrf_app_session_connect( session ))
622 char* string = osrfMessageSerializeBatch(msgs, size);
626 transport_message* t_msg = message_init(
627 string, "", session->session_id, session->remote_id, NULL );
629 debug_handler("Session [%s] [%s] sending to %s \nData: %s",
630 session->remote_service, session->session_id, t_msg->recipient, string );
632 retval = client_send_message( session->transport_handle, t_msg );
635 message_free( t_msg );
645 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
646 if( !(session && msg) ) return 0;
649 return osrfAppSessionSendBatch( session, a, 1 );
655 /** Waits up to 'timeout' seconds for some data to arrive.
656 * Any data that arrives will be processed according to its
657 * payload and message type. This method will return after
658 * any data has arrived.
660 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
661 if(session == NULL) return 0;
663 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
664 ret_val = osrf_stack_entry_point(session->transport_handle, timeout);
668 /** Disconnects (if client) and removes the given session from the global session cache
669 * ! This free's all attached app_requests !
671 void osrfAppSessionFree( osrfAppSession* ses ) {
672 osrf_app_session_destroy( ses );
676 void osrf_app_session_destroy( osrf_app_session* session ){
677 if(session == NULL) return;
679 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
680 session->remote_service, session->session_id );
681 if(session->type == OSRF_SESSION_CLIENT
682 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
683 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
684 _osrf_app_session_send( session, dis_msg );
685 osrf_message_free(dis_msg);
687 //session->state = OSRF_SESSION_DISCONNECTED;
688 _osrf_app_session_remove_session(session->session_id);
690 osrf_app_request* req;
691 while( session->request_queue != NULL ) {
692 req = session->request_queue->next;
693 _osrf_app_request_free( session->request_queue );
694 session->request_queue = req;
697 _osrf_app_session_free( session );
700 osrf_message* osrfAppSessionRequestRecv(
701 osrf_app_session* session, int req_id, int timeout ) {
702 return osrf_app_session_request_recv( session, req_id, timeout );
704 osrf_message* osrf_app_session_request_recv(
705 osrf_app_session* session, int req_id, int timeout ) {
706 if(req_id < 0 || session == NULL)
708 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
709 return _osrf_app_request_recv( req, timeout );
714 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
715 if(!ses || ! data ) return -1;
717 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
718 char* json = jsonObjectToJSON( data );
719 osrf_message_set_result_content( msg, json );
720 _osrf_app_session_send( ses, msg );
723 osrf_message_free( msg );
729 int osrfAppRequestRespondComplete(
730 osrfAppSession* ses, int requestId, jsonObject* data ) {
732 osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
733 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
735 char* json = jsonObjectToJSON( data );
736 osrf_message_set_result_content( payload, json );
739 osrf_message* status = osrf_message_init( STATUS, requestId, 1);
740 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
746 osrfAppSessionSendBatch( ses, ms, 2 );
748 osrf_message_free( payload );
749 osrf_message_free( status );
758 int osrfAppSessionStatus( osrfAppSession* ses, int type, char* name, int reqId, char* message ) {
761 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
762 osrf_message_set_status_info( msg, name, message, type );
763 _osrf_app_session_send( ses, msg );
764 osrf_message_free( msg );