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* osrfAppSessionClientInit( char* remote_service ) {
239 return osrf_app_client_session_init( remote_service );
242 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
244 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
246 session->transport_handle = osrf_system_get_transport_client();
247 if( session->transport_handle == NULL ) {
248 warning_handler("No transport client for service 'client'");
252 char target_buf[512];
253 memset(target_buf,0,512);
254 //char* domain = config_value( "opensrf.bootstrap", "//%s/domains/domain1", osrf_get_config_context() ); /* just the first for now */
255 //char* router_name = config_value( "opensrf.bootstrap", "//%s/router_name", osrf_get_config_context() );
257 osrfStringArray* arr = osrfNewStringArray(8);
258 osrfConfigGetValueList(NULL, arr, "/domains/domain");
259 char* domain = osrfStringArrayGetString(arr, 0);
260 char* router_name = osrfConfigGetValue(NULL, "/router_name");
261 osrfStringArrayFree(arr);
263 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
267 session->request_queue = NULL;
268 session->remote_id = strdup(target_buf);
269 session->orig_remote_id = strdup(session->remote_id);
270 session->remote_service = strdup(remote_service);
272 #ifdef ASSUME_STATELESS
273 session->stateless = 1;
274 debug_handler("session is stateless");
276 session->stateless = 0;
277 debug_handler("session is NOT stateless");
280 /* build a chunky, random session id */
284 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
285 session->session_id = strdup(id);
286 debug_handler( "Building a new client session with id [%s] [%s]",
287 session->remote_service, session->session_id );
289 session->thread_trace = 0;
290 session->state = OSRF_SESSION_DISCONNECTED;
291 session->type = OSRF_SESSION_CLIENT;
292 session->next = NULL;
293 _osrf_app_session_push_session( session );
297 osrf_app_session* osrf_app_server_session_init(
298 char* session_id, char* our_app, char* remote_id ) {
300 info_handler("Initing server session with session id %s, service %s,"
301 " and remote_id %s", session_id, our_app, remote_id );
303 osrf_app_session* session = osrf_app_session_find_session( session_id );
304 if(session) return session;
306 session = safe_malloc(sizeof(osrf_app_session));
308 session->transport_handle = osrf_system_get_transport_client();
309 if( session->transport_handle == NULL ) {
310 warning_handler("No transport client for service '%s'", our_app );
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);
320 #ifdef ASSUME_STATELESS
321 session->stateless = 1;
323 session->stateless = 0;
326 session->thread_trace = 0;
327 session->state = OSRF_SESSION_DISCONNECTED;
328 session->type = OSRF_SESSION_SERVER;
329 session->next = NULL;
331 _osrf_app_session_push_session( session );
338 /** frees memory held by a session */
339 void _osrf_app_session_free( osrf_app_session* session ){
343 free(session->remote_id);
344 free(session->orig_remote_id);
345 free(session->session_id);
346 free(session->remote_service);
350 int osrfAppSessionMakeRequest(
351 osrf_app_session* session, jsonObject* params,
352 char* method_name, int protocol, string_array* param_strings ) {
354 return osrf_app_session_make_req( session, params,
355 method_name, protocol, param_strings );
358 int osrf_app_session_make_req(
359 osrf_app_session* session, jsonObject* params,
360 char* method_name, int protocol, string_array* param_strings ) {
361 if(session == NULL) return -1;
363 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
364 osrf_message_set_method(req_msg, method_name);
366 osrf_message_set_params(req_msg, params);
372 for(i = 0; i!= param_strings->size ; i++ ) {
373 osrf_message_add_param(req_msg,
374 string_array_get_string(param_strings,i));
379 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
380 if(!_osrf_app_session_send( session, req_msg ) ) {
381 warning_handler( "Error sending request message [%d]", session->thread_trace );
385 _osrf_app_session_push_request( session, req );
386 return req->request_id;
391 /** Adds an app_request to the request set */
392 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
393 if(session == NULL || req == NULL)
396 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
397 req->request_id, session->remote_service, session->session_id );
399 if(session->request_queue == NULL)
400 session->request_queue = req;
402 osrf_app_request* req2 = session->request_queue->next;
403 session->request_queue = req;
410 /** Removes an app_request from this session request set */
411 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
412 if(session == NULL || req == NULL)
415 if(session->request_queue == NULL)
418 debug_handler("Removing request [%d] from session [%s] [%s]",
419 req->request_id, session->remote_service, session->session_id );
421 osrf_app_request* first = session->request_queue;
422 if(first->request_id == req->request_id) {
423 session->request_queue = first->next;
426 if(first->next == NULL) {
427 session->request_queue = NULL;
429 osrf_app_request* tmp = first->next;
430 session->request_queue = tmp;
435 osrf_app_request* lead = first->next;
437 while( lead != NULL ) {
438 if(lead->request_id == req->request_id) {
439 first->next = lead->next;
448 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
452 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
453 if(req) req->complete = 1;
456 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
459 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
461 return req->complete;
465 /** Returns the app_request with the given request_id (request_id) */
466 osrf_app_request* _osrf_app_session_get_request(
467 osrf_app_session* session, int request_id ){
471 debug_handler( "App Session searching for request [%d] in request queue",request_id );
472 osrf_app_request* req = session->request_queue;
473 while( req != NULL ) {
474 if(req->request_id == request_id)
482 /** Resets the remote connection id to that of the original*/
483 void osrf_app_session_reset_remote( osrf_app_session* session ){
487 free(session->remote_id);
488 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
489 session->remote_service, session->session_id, session->orig_remote_id );
491 session->remote_id = strdup(session->orig_remote_id);
494 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
497 if( session->remote_id )
498 free(session->remote_id );
499 session->remote_id = strdup( remote_id );
502 /** pushes the given message into the result list of the app_request
503 with the given request_id */
504 int osrf_app_session_push_queue(
505 osrf_app_session* session, osrf_message* msg ){
507 if(session == NULL || msg == NULL)
510 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
513 osrf_app_request* req = session->request_queue;
516 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
520 while( req != NULL ) {
521 if(req->request_id == msg->thread_trace) {
522 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
523 _osrf_app_request_push_queue( req, msg );
533 /** Attempts to connect to the remote service */
534 int osrf_app_session_connect(osrf_app_session* session){
539 if(session->state == OSRF_SESSION_CONNECTED) {
540 debug_handler("Already Connected, returning");
544 int timeout = 5; /* XXX CONFIG VALUE */
546 debug_handler( "AppSession connecting to %s", session->remote_id );
548 /* defaulting to protocol 1 for now */
549 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
550 osrf_app_session_reset_remote( session );
551 session->state = OSRF_SESSION_CONNECTING;
552 int ret = _osrf_app_session_send( session, con_msg );
553 osrf_message_free(con_msg);
556 time_t start = time(NULL);
557 time_t remaining = (time_t) timeout;
559 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
560 osrf_app_session_queue_wait( session, remaining );
561 remaining -= (int) (time(NULL) - start);
564 if(session->state == OSRF_SESSION_CONNECTED)
565 debug_handler(" * Connected Successfully");
567 if(session->state != OSRF_SESSION_CONNECTED)
575 /** Disconnects from the remote service */
576 int osrf_app_session_disconnect( osrf_app_session* session){
580 if(session->state == OSRF_SESSION_DISCONNECTED)
583 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
585 "Exiting disconnect on stateless session %s",
586 session->session_id);
590 debug_handler( "AppSession disconnecting from %s", session->remote_id );
592 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
593 session->state = OSRF_SESSION_DISCONNECTED;
594 _osrf_app_session_send( session, dis_msg );
596 osrf_message_free( dis_msg );
597 osrf_app_session_reset_remote( session );
601 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
602 debug_handler("In reqeust resend searching for resend-able messages");
603 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
604 return _osrf_app_request_resend( req );
608 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
610 if( !(session && msgs && size > 0) ) return 0;
614 osrfMessage* msg = msgs[0];
618 osrf_app_session_queue_wait( session, 0 );
620 /* if we're not stateless and the first message is not a connect
621 message, then we do the connect first */
622 if(session->stateless) {
623 osrf_app_session_reset_remote(session);
627 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
628 (session->state != OSRF_SESSION_CONNECTED) ) {
629 if(!osrf_app_session_connect( session ))
635 char* string = osrfMessageSerializeBatch(msgs, size);
639 transport_message* t_msg = message_init(
640 string, "", session->session_id, session->remote_id, NULL );
642 debug_handler("Session [%s] [%s] sending to %s \nXML:\n%s",
643 session->remote_service, session->session_id, t_msg->recipient, string );
645 retval = client_send_message( session->transport_handle, t_msg );
648 message_free( t_msg );
658 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
659 if( !(session && msg) ) return 0;
662 return osrfAppSessionSendBatch( session, a, 1 );
668 /** Waits up to 'timeout' seconds for some data to arrive.
669 * Any data that arrives will be processed according to its
670 * payload and message type. This method will return after
671 * any data has arrived.
673 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
674 if(session == NULL) return 0;
676 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
677 ret_val = osrf_stack_entry_point(session->transport_handle, timeout);
681 /** Disconnects (if client) and removes the given session from the global session cache
682 * ! This free's all attached app_requests !
684 void osrf_app_session_destroy ( osrf_app_session* session ){
685 if(session == NULL) return;
687 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
688 session->remote_service, session->session_id );
689 if(session->type == OSRF_SESSION_CLIENT
690 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
691 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
692 _osrf_app_session_send( session, dis_msg );
693 osrf_message_free(dis_msg);
695 //session->state = OSRF_SESSION_DISCONNECTED;
696 _osrf_app_session_remove_session(session->session_id);
697 debug_handler("AppSession [%s] [%s] removed from cache",
698 session->remote_service, session->session_id );
700 osrf_app_request* req;
701 while( session->request_queue != NULL ) {
702 req = session->request_queue->next;
703 _osrf_app_request_free( session->request_queue );
704 session->request_queue = req;
707 _osrf_app_session_free( session );
710 osrf_message* osrfAppSessionRequestRecv(
711 osrf_app_session* session, int req_id, int timeout ) {
712 return osrf_app_session_request_recv( session, req_id, timeout );
714 osrf_message* osrf_app_session_request_recv(
715 osrf_app_session* session, int req_id, int timeout ) {
716 if(req_id < 0 || session == NULL)
718 debug_handler("somebody callled recv");
719 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
720 return _osrf_app_request_recv( req, timeout );
725 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
726 if(!ses || ! data ) return -1;
728 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
729 char* json = jsonObjectToJSON( data );
730 osrf_message_set_result_content( msg, json );
731 _osrf_app_session_send( ses, msg );
734 osrf_message_free( msg );
740 int osrfAppRequestRespondComplete(
741 osrfAppSession* ses, int requestId, jsonObject* data ) {
743 osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
744 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
746 char* json = jsonObjectToJSON( data );
747 osrf_message_set_result_content( payload, json );
750 osrf_message* status = osrf_message_init( STATUS, requestId, 1);
751 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
757 osrfAppSessionSendBatch( ses, ms, 2 );
759 osrf_message_free( payload );
760 osrf_message_free( status );
769 int osrfAppSessionStatus( osrfAppSession* ses, int type, int reqId, char* message ) {
772 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
773 osrf_message_set_status_info( msg, "Server Error", message, type );
774 _osrf_app_session_send( ses, msg );
775 osrf_message_free( msg );