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", "//%s/domains/domain1", osrf_get_config_context() ); /* just the first for now */
251 //char* router_name = config_value( "opensrf.bootstrap", "//%s/router_name", osrf_get_config_context() );
253 osrfStringArray* arr = osrfNewStringArray(8);
254 osrfConfigGetValueList(NULL, arr, "/domains/domain");
255 char* domain = osrfStringArrayGetString(arr, 0);
256 char* router_name = osrfConfigGetValue(NULL, "/router_name");
257 osrfStringArrayFree(arr);
259 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
263 session->request_queue = NULL;
264 session->remote_id = strdup(target_buf);
265 session->orig_remote_id = strdup(session->remote_id);
266 session->remote_service = strdup(remote_service);
268 #ifdef ASSUME_STATELESS
269 session->stateless = 1;
270 debug_handler("session is stateless");
272 session->stateless = 0;
273 debug_handler("session is NOT stateless");
276 /* build a chunky, random session id */
280 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
281 session->session_id = strdup(id);
282 debug_handler( "Building a new client session with id [%s] [%s]",
283 session->remote_service, session->session_id );
285 session->thread_trace = 0;
286 session->state = OSRF_SESSION_DISCONNECTED;
287 session->type = OSRF_SESSION_CLIENT;
288 session->next = NULL;
289 _osrf_app_session_push_session( session );
293 osrf_app_session* osrf_app_server_session_init(
294 char* session_id, char* our_app, char* remote_id ) {
296 info_handler("Initing server session with session id %s, service %s,"
297 " and remote_id %s", session_id, our_app, remote_id );
299 osrf_app_session* session = osrf_app_session_find_session( session_id );
300 if(session) return session;
302 session = safe_malloc(sizeof(osrf_app_session));
304 session->transport_handle = osrf_system_get_transport_client();
305 if( session->transport_handle == NULL ) {
306 warning_handler("No transport client for service '%s'", our_app );
310 session->request_queue = NULL;
311 session->remote_id = strdup(remote_id);
312 session->orig_remote_id = strdup(remote_id);
313 session->session_id = strdup(session_id);
314 session->remote_service = strdup(our_app);
316 #ifdef ASSUME_STATELESS
317 session->stateless = 1;
319 session->stateless = 0;
322 session->thread_trace = 0;
323 session->state = OSRF_SESSION_DISCONNECTED;
324 session->type = OSRF_SESSION_SERVER;
325 session->next = NULL;
327 _osrf_app_session_push_session( session );
334 /** frees memory held by a session */
335 void _osrf_app_session_free( osrf_app_session* session ){
339 free(session->remote_id);
340 free(session->orig_remote_id);
341 free(session->session_id);
342 free(session->remote_service);
346 int osrf_app_session_make_req(
347 osrf_app_session* session, jsonObject* params,
348 char* method_name, int protocol, string_array* param_strings ) {
349 if(session == NULL) return -1;
351 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
352 osrf_message_set_method(req_msg, method_name);
354 osrf_message_set_params(req_msg, params);
360 for(i = 0; i!= param_strings->size ; i++ ) {
361 osrf_message_add_param(req_msg,
362 string_array_get_string(param_strings,i));
367 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
368 if(!_osrf_app_session_send( session, req_msg ) ) {
369 warning_handler( "Error sending request message [%d]", session->thread_trace );
373 _osrf_app_session_push_request( session, req );
374 return req->request_id;
379 /** Adds an app_request to the request set */
380 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
381 if(session == NULL || req == NULL)
384 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
385 req->request_id, session->remote_service, session->session_id );
387 if(session->request_queue == NULL)
388 session->request_queue = req;
390 osrf_app_request* req2 = session->request_queue->next;
391 session->request_queue = req;
398 /** Removes an app_request from this session request set */
399 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
400 if(session == NULL || req == NULL)
403 if(session->request_queue == NULL)
406 debug_handler("Removing request [%d] from session [%s] [%s]",
407 req->request_id, session->remote_service, session->session_id );
409 osrf_app_request* first = session->request_queue;
410 if(first->request_id == req->request_id) {
411 session->request_queue = first->next;
414 if(first->next == NULL) {
415 session->request_queue = NULL;
417 osrf_app_request* tmp = first->next;
418 session->request_queue = tmp;
423 osrf_app_request* lead = first->next;
425 while( lead != NULL ) {
426 if(lead->request_id == req->request_id) {
427 first->next = lead->next;
436 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
440 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
441 if(req) req->complete = 1;
444 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
447 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
449 return req->complete;
453 /** Returns the app_request with the given request_id (request_id) */
454 osrf_app_request* _osrf_app_session_get_request(
455 osrf_app_session* session, int request_id ){
459 debug_handler( "App Session searching for request [%d] in request queue",request_id );
460 osrf_app_request* req = session->request_queue;
461 while( req != NULL ) {
462 if(req->request_id == request_id)
470 /** Resets the remote connection id to that of the original*/
471 void osrf_app_session_reset_remote( osrf_app_session* session ){
475 free(session->remote_id);
476 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
477 session->remote_service, session->session_id, session->orig_remote_id );
479 session->remote_id = strdup(session->orig_remote_id);
482 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
485 if( session->remote_id )
486 free(session->remote_id );
487 session->remote_id = strdup( remote_id );
490 /** pushes the given message into the result list of the app_request
491 with the given request_id */
492 int osrf_app_session_push_queue(
493 osrf_app_session* session, osrf_message* msg ){
495 if(session == NULL || msg == NULL)
498 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
501 osrf_app_request* req = session->request_queue;
504 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
508 while( req != NULL ) {
509 if(req->request_id == msg->thread_trace) {
510 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
511 _osrf_app_request_push_queue( req, msg );
521 /** Attempts to connect to the remote service */
522 int osrf_app_session_connect(osrf_app_session* session){
527 if(session->state == OSRF_SESSION_CONNECTED) {
528 debug_handler("Already Connected, returning");
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");
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 debug_handler("In reqeust resend searching for resend-able messages");
591 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
592 return _osrf_app_request_resend( req );
595 /** Send the given message */
596 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
597 if(session == NULL) return 0;
600 osrf_app_session_queue_wait( session, 0 );
601 debug_handler( "AppSession sending type %d, and thread_trace %d",
602 msg->m_type, msg->thread_trace );
604 if(session->stateless) {
605 osrf_app_session_reset_remote(session);
609 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
610 (session->state != OSRF_SESSION_CONNECTED) ) {
611 if(!osrf_app_session_connect( session ))
616 //char* xml = osrf_message_to_xml(msg);
617 char* string = osrf_message_serialize(msg);
619 debug_handler("[%s] [%s] Remote Id: %s",
620 session->remote_service, session->session_id, session->remote_id );
622 transport_message* t_msg = message_init(
623 string, "", session->session_id, session->remote_id, NULL );
625 debug_handler("Session [%s] [%s] sending to %s \nXML:\n%s",
626 session->remote_service, session->session_id, t_msg->recipient, string );
627 ret_val = client_send_message( session->transport_handle, t_msg );
629 message_free( t_msg );
634 /** Waits up to 'timeout' seconds for some data to arrive.
635 * Any data that arrives will be processed according to its
636 * payload and message type. This method will return after
637 * any data has arrived.
639 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
640 if(session == NULL) return 0;
642 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
643 ret_val = osrf_stack_entry_point(session->transport_handle, timeout);
647 /** Disconnects (if client) and removes the given session from the global session cache
648 * ! This free's all attached app_requests !
650 void osrf_app_session_destroy ( osrf_app_session* session ){
651 if(session == NULL) return;
653 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
654 session->remote_service, session->session_id );
655 if(session->type == OSRF_SESSION_CLIENT
656 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
657 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
658 _osrf_app_session_send( session, dis_msg );
659 osrf_message_free(dis_msg);
661 //session->state = OSRF_SESSION_DISCONNECTED;
662 _osrf_app_session_remove_session(session->session_id);
663 debug_handler("AppSession [%s] [%s] removed from cache",
664 session->remote_service, session->session_id );
666 osrf_app_request* req;
667 while( session->request_queue != NULL ) {
668 req = session->request_queue->next;
669 _osrf_app_request_free( session->request_queue );
670 session->request_queue = req;
673 _osrf_app_session_free( session );
676 osrf_message* osrf_app_session_request_recv(
677 osrf_app_session* session, int req_id, int timeout ) {
678 if(req_id < 0 || session == NULL)
680 debug_handler("somebody callled recv");
681 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
682 return _osrf_app_request_recv( req, timeout );
687 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
688 if(!ses || ! data ) return -1;
690 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
691 char* json = jsonObjectToJSON( data );
692 osrf_message_set_result_content( msg, json );
693 _osrf_app_session_send( ses, msg );
696 osrf_message_free( msg );
703 int osrfAppSessionStatus( osrfAppSession* ses, int type, int reqId, char* message ) {
706 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
707 osrf_message_set_status_info( msg, "Server Error", message, type );
708 _osrf_app_session_send( ses, msg );
709 osrf_message_free( msg );