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);
248 //char* domain = config_value( "opensrf.bootstrap", "//%s/domains/domain1", osrf_get_config_context() ); /* just the first for now */
249 //char* router_name = config_value( "opensrf.bootstrap", "//%s/router_name", osrf_get_config_context() );
251 osrfStringArray* arr = osrfNewStringArray(8);
252 osrfConfigGetValueList(NULL, arr, "/domains/domain");
253 char* domain = osrfStringArrayGetString(arr, 0);
254 char* router_name = osrfConfigGetValue(NULL, "/router_name");
255 osrfStringArrayFree(arr);
257 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
261 session->request_queue = NULL;
262 session->remote_id = strdup(target_buf);
263 session->orig_remote_id = strdup(session->remote_id);
264 session->remote_service = strdup(remote_service);
266 #ifdef ASSUME_STATELESS
267 session->stateless = 1;
268 debug_handler("%s session is stateless", remote_service );
270 session->stateless = 0;
271 debug_handler("%s session is NOT stateless", remote_service );
274 /* build a chunky, random session id */
278 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
279 session->session_id = strdup(id);
280 debug_handler( "Building a new client session with id [%s] [%s]",
281 session->remote_service, session->session_id );
283 session->thread_trace = 0;
284 session->state = OSRF_SESSION_DISCONNECTED;
285 session->type = OSRF_SESSION_CLIENT;
286 session->next = NULL;
287 _osrf_app_session_push_session( session );
291 osrf_app_session* osrf_app_server_session_init(
292 char* session_id, char* our_app, char* remote_id ) {
294 info_handler("Initing server session with session id %s, service %s,"
295 " and remote_id %s", session_id, our_app, remote_id );
297 osrf_app_session* session = osrf_app_session_find_session( session_id );
298 if(session) return session;
300 session = safe_malloc(sizeof(osrf_app_session));
302 session->transport_handle = osrf_system_get_transport_client();
303 if( session->transport_handle == NULL ) {
304 warning_handler("No transport client for service '%s'", our_app );
309 char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
310 if(statel) stateless = atoi(statel);
314 session->request_queue = NULL;
315 session->remote_id = strdup(remote_id);
316 session->orig_remote_id = strdup(remote_id);
317 session->session_id = strdup(session_id);
318 session->remote_service = strdup(our_app);
319 session->stateless = stateless;
321 #ifdef ASSUME_STATELESS
322 session->stateless = 1;
325 session->thread_trace = 0;
326 session->state = OSRF_SESSION_DISCONNECTED;
327 session->type = OSRF_SESSION_SERVER;
328 session->next = NULL;
330 _osrf_app_session_push_session( session );
337 /** frees memory held by a session */
338 void _osrf_app_session_free( osrf_app_session* session ){
342 free(session->remote_id);
343 free(session->orig_remote_id);
344 free(session->session_id);
345 free(session->remote_service);
349 int osrfAppSessionMakeRequest(
350 osrf_app_session* session, jsonObject* params,
351 char* method_name, int protocol, string_array* param_strings ) {
353 return osrf_app_session_make_req( session, params,
354 method_name, protocol, param_strings );
357 int osrf_app_session_make_req(
358 osrf_app_session* session, jsonObject* params,
359 char* method_name, int protocol, string_array* param_strings ) {
360 if(session == NULL) return -1;
362 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
363 osrf_message_set_method(req_msg, method_name);
365 osrf_message_set_params(req_msg, params);
371 for(i = 0; i!= param_strings->size ; i++ ) {
372 osrf_message_add_param(req_msg,
373 string_array_get_string(param_strings,i));
378 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
379 if(!_osrf_app_session_send( session, req_msg ) ) {
380 warning_handler( "Error sending request message [%d]", session->thread_trace );
384 _osrf_app_session_push_request( session, req );
385 return req->request_id;
390 /** Adds an app_request to the request set */
391 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
392 if(session == NULL || req == NULL)
395 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
396 req->request_id, session->remote_service, session->session_id );
398 if(session->request_queue == NULL)
399 session->request_queue = req;
401 osrf_app_request* req2 = session->request_queue->next;
402 session->request_queue = req;
409 /** Removes an app_request from this session request set */
410 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
411 if(session == NULL || req == NULL)
414 if(session->request_queue == NULL)
417 debug_handler("Removing request [%d] from session [%s] [%s]",
418 req->request_id, session->remote_service, session->session_id );
420 osrf_app_request* first = session->request_queue;
421 if(first->request_id == req->request_id) {
422 session->request_queue = first->next;
425 if(first->next == NULL) {
426 session->request_queue = NULL;
428 osrf_app_request* tmp = first->next;
429 session->request_queue = tmp;
434 osrf_app_request* lead = first->next;
436 while( lead != NULL ) {
437 if(lead->request_id == req->request_id) {
438 first->next = lead->next;
447 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
451 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
452 if(req) req->complete = 1;
455 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
458 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
460 return req->complete;
464 /** Returns the app_request with the given request_id (request_id) */
465 osrf_app_request* _osrf_app_session_get_request(
466 osrf_app_session* session, int request_id ){
470 osrf_app_request* req = session->request_queue;
471 while( req != NULL ) {
472 if(req->request_id == request_id)
480 /** Resets the remote connection id to that of the original*/
481 void osrf_app_session_reset_remote( osrf_app_session* session ){
485 free(session->remote_id);
486 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
487 session->remote_service, session->session_id, session->orig_remote_id );
489 session->remote_id = strdup(session->orig_remote_id);
492 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
495 if( session->remote_id )
496 free(session->remote_id );
497 session->remote_id = strdup( remote_id );
500 /** pushes the given message into the result list of the app_request
501 with the given request_id */
502 int osrf_app_session_push_queue(
503 osrf_app_session* session, osrf_message* msg ){
505 if(session == NULL || msg == NULL)
508 osrf_app_request* req = session->request_queue;
510 if(req == NULL) return 0;
512 while( req != NULL ) {
513 if(req->request_id == msg->thread_trace) {
514 _osrf_app_request_push_queue( req, msg );
524 /** Attempts to connect to the remote service */
525 int osrf_app_session_connect(osrf_app_session* session){
530 if(session->state == OSRF_SESSION_CONNECTED) {
534 int timeout = 5; /* XXX CONFIG VALUE */
536 debug_handler( "AppSession connecting to %s", session->remote_id );
538 /* defaulting to protocol 1 for now */
539 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
540 osrf_app_session_reset_remote( session );
541 session->state = OSRF_SESSION_CONNECTING;
542 int ret = _osrf_app_session_send( session, con_msg );
543 osrf_message_free(con_msg);
546 time_t start = time(NULL);
547 time_t remaining = (time_t) timeout;
549 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
550 osrf_app_session_queue_wait( session, remaining );
551 remaining -= (int) (time(NULL) - start);
554 if(session->state == OSRF_SESSION_CONNECTED)
555 debug_handler(" * Connected Successfully to %s", session->remote_service );
557 if(session->state != OSRF_SESSION_CONNECTED)
565 /** Disconnects from the remote service */
566 int osrf_app_session_disconnect( osrf_app_session* session){
570 if(session->state == OSRF_SESSION_DISCONNECTED)
573 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
575 "Exiting disconnect on stateless session %s",
576 session->session_id);
580 debug_handler( "AppSession disconnecting from %s", session->remote_id );
582 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
583 session->state = OSRF_SESSION_DISCONNECTED;
584 _osrf_app_session_send( session, dis_msg );
586 osrf_message_free( dis_msg );
587 osrf_app_session_reset_remote( session );
591 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
592 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
593 return _osrf_app_request_resend( req );
597 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
599 if( !(session && msgs && size > 0) ) return 0;
603 osrfMessage* msg = msgs[0];
607 osrf_app_session_queue_wait( session, 0 );
609 /* if we're not stateless and the first message is not a connect
610 message, then we do the connect first */
611 if(session->stateless) {
612 osrf_app_session_reset_remote(session);
616 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
617 (session->state != OSRF_SESSION_CONNECTED) ) {
618 if(!osrf_app_session_connect( session ))
624 char* string = osrfMessageSerializeBatch(msgs, size);
628 transport_message* t_msg = message_init(
629 string, "", session->session_id, session->remote_id, NULL );
631 debug_handler("Session [%s] [%s] sending to %s \nData: %s",
632 session->remote_service, session->session_id, t_msg->recipient, string );
634 retval = client_send_message( session->transport_handle, t_msg );
637 message_free( t_msg );
647 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
648 if( !(session && msg) ) return 0;
651 return osrfAppSessionSendBatch( session, a, 1 );
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_entry_point(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 osrfAppSessionFree( osrfAppSession* ses ) {
674 osrf_app_session_destroy( ses );
678 void osrf_app_session_destroy( osrf_app_session* session ){
679 if(session == NULL) return;
681 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
682 session->remote_service, session->session_id );
683 if(session->type == OSRF_SESSION_CLIENT
684 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
685 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
686 _osrf_app_session_send( session, dis_msg );
687 osrf_message_free(dis_msg);
689 //session->state = OSRF_SESSION_DISCONNECTED;
690 _osrf_app_session_remove_session(session->session_id);
692 osrf_app_request* req;
693 while( session->request_queue != NULL ) {
694 req = session->request_queue->next;
695 _osrf_app_request_free( session->request_queue );
696 session->request_queue = req;
699 _osrf_app_session_free( session );
702 osrf_message* osrfAppSessionRequestRecv(
703 osrf_app_session* session, int req_id, int timeout ) {
704 return osrf_app_session_request_recv( session, req_id, timeout );
706 osrf_message* osrf_app_session_request_recv(
707 osrf_app_session* session, int req_id, int timeout ) {
708 if(req_id < 0 || session == NULL)
710 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
711 return _osrf_app_request_recv( req, timeout );
716 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
717 if(!ses || ! data ) return -1;
719 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
720 char* json = jsonObjectToJSON( data );
721 osrf_message_set_result_content( msg, json );
722 _osrf_app_session_send( ses, msg );
725 osrf_message_free( msg );
731 int osrfAppRequestRespondComplete(
732 osrfAppSession* ses, int requestId, jsonObject* data ) {
734 osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
735 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
737 char* json = jsonObjectToJSON( data );
738 osrf_message_set_result_content( payload, json );
741 osrf_message* status = osrf_message_init( STATUS, requestId, 1);
742 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
748 osrfAppSessionSendBatch( ses, ms, 2 );
750 osrf_message_free( payload );
751 osrf_message_free( status );
760 int osrfAppSessionStatus( osrfAppSession* ses, int type, char* name, int reqId, char* message ) {
763 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
764 osrf_message_set_status_info( msg, name, message, type );
765 _osrf_app_session_send( ses, msg );
766 osrf_message_free( msg );