1 #include "opensrf/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 );
39 osrf_message* cur_msg = req->result;
40 while( cur_msg != NULL ) {
41 osrf_message* next_msg = cur_msg->next;
42 osrf_message_free( cur_msg );
45 osrf_message_free( req->payload );
51 /** Pushes the given message onto the list of 'responses' to this request */
52 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
53 if(req == NULL || result == NULL) return;
54 debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
55 if(req->result == NULL)
58 result->next = req->result;
63 /** Removes this app_request from our session request set */
64 void osrf_app_session_request_finish(
65 osrf_app_session* session, int req_id ){
67 if(session == NULL) return;
68 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
69 if(req == NULL) return;
70 _osrf_app_session_remove_request( req->session, req );
71 _osrf_app_request_free( req );
74 /** Checks the receive queue for messages. If any are found, the first
75 * is popped off and returned. Otherwise, this method will wait at most timeout
76 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
77 * If no messages arrive in the timeout provided, null is returned.
79 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
81 if(req == NULL) return NULL;
83 if( req->result != NULL ) {
84 debug_handler("app_request receive already has a message, returning it");
85 /* pop off the first message in the list */
86 osrf_message* tmp_msg = req->result->next;
87 req->result = tmp_msg;
91 time_t start = time(NULL);
92 time_t remaining = (time_t) timeout;
94 while( remaining >= 0 ) {
95 /* tell the session to wait for stuff */
96 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
98 osrf_app_session_queue_wait( req->session, 0 );
100 if( req->result != NULL ) { /* if we received anything */
101 /* pop off the first message in the list */
102 debug_handler( "app_request_recv received a message, returning it");
103 osrf_message* ret_msg = req->result;
104 osrf_message* tmp_msg = ret_msg->next;
105 req->result = tmp_msg;
112 osrf_app_session_queue_wait( req->session, (int) remaining );
114 if( req->result != NULL ) { /* if we received anything */
115 /* pop off the first message in the list */
116 debug_handler( "app_request_recv received a message, returning it");
117 osrf_message* ret_msg = req->result;
118 osrf_message* tmp_msg = ret_msg->next;
119 req->result = tmp_msg;
125 remaining -= (int) (time(NULL) - start);
131 /** Resend this requests original request message */
132 int _osrf_app_request_resend( osrf_app_request* req ) {
133 if(req == NULL) return 0;
135 debug_handler( "Resending request [%d]", req->request_id );
136 return _osrf_app_session_send( req->session, req->payload );
143 // --------------------------------------------------------------------------
144 // --------------------------------------------------------------------------
146 // --------------------------------------------------------------------------
148 /** returns a session from the global session hash */
149 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
150 osrf_app_session* ptr = app_session_cache;
151 debug_handler("Searching for session in global cache with id [%s]", session_id );
152 while( ptr != NULL ) {
153 if( !strcmp(ptr->session_id,session_id) )
161 /** adds a session to the global session cache */
162 void _osrf_app_session_push_session( osrf_app_session* session ) {
164 if( app_session_cache == NULL ) {
165 app_session_cache = session;
169 osrf_app_session* ptr = app_session_cache;
170 debug_handler( "Pushing [%s] onto global session cache", session->session_id );
171 while( ptr != NULL ) {
172 if( !strcmp(ptr->session_id, session->session_id) )
174 if( ptr->next == NULL ) {
183 /** unlinks from global session cache */
184 void _osrf_app_session_remove_session( char* session_id ) {
186 if( app_session_cache == NULL )
189 debug_handler( "App Session removing session [%s] from global cache", session_id );
190 if( !strcmp(app_session_cache->session_id, session_id) ) {
191 if( app_session_cache->next != NULL ) {
192 osrf_app_session* next = app_session_cache->next;
193 app_session_cache = next;
196 app_session_cache = NULL;
201 if( app_session_cache->next == NULL )
204 osrf_app_session* prev = app_session_cache;
205 osrf_app_session* ptr = prev->next;
206 while( ptr != NULL ) {
207 if( ptr->session_id == session_id ) {
208 osrf_app_session* tmp = ptr->next;
216 /** Allocates a initializes a new app_session */
218 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
219 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
221 session->transport_handle = osrf_system_get_transport_client();
222 if( session->transport_handle == NULL ) {
223 warning_handler("No transport client for service 'client'");
227 char target_buf[512];
228 memset(target_buf,0,512);
229 char* domain = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
230 char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
231 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
235 session->request_queue = NULL;
236 session->remote_id = strdup(target_buf);
237 session->orig_remote_id = strdup(session->remote_id);
239 /* build a chunky, random session id */
242 srand((int)time(NULL));
243 sprintf(id, "%d.%d%d", rand(), (int)time(NULL), getpid());
244 session->session_id = strdup(id);
245 debug_handler( "Building a new client session with id [%s]", session->session_id );
247 session->thread_trace = 0;
248 session->state = OSRF_SESSION_DISCONNECTED;
249 session->type = OSRF_SESSION_CLIENT;
250 session->next = NULL;
251 _osrf_app_session_push_session( session );
255 osrf_app_session* osrf_app_server_session_init(
256 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
258 osrf_app_session* session = osrf_app_session_find_session( session_id );
262 debug_handler( "Building a new server session with id [%s]", session_id );
264 session = safe_malloc(sizeof(osrf_app_session));
266 session->transport_handle = osrf_system_get_transport_client();
267 if( session->transport_handle == NULL ) {
268 warning_handler("No transport client for service '%s'", our_app );
271 session->request_queue = NULL;
272 session->remote_id = strdup(remote_id);
273 session->orig_remote_id = strdup(remote_id);
274 session->session_id = strdup(session_id);
276 session->thread_trace = 0;
277 session->state = OSRF_SESSION_DISCONNECTED;
278 session->type = OSRF_SESSION_CLIENT;
279 session->next = NULL;
281 _osrf_app_session_push_session( session );
288 /** frees memory held by a session */
289 void _osrf_app_session_free( osrf_app_session* session ){
293 free(session->remote_id);
294 free(session->orig_remote_id);
299 int osrf_app_session_make_request(
300 osrf_app_session* session, json* params, char* method_name, int protocol ) {
301 if(session == NULL) return -1;
303 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
304 osrf_message_set_request_info( req_msg, method_name, params );
305 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
306 if(!_osrf_app_session_send( session, req_msg ) ) {
307 warning_handler( "Error sending request message [%d]", session->thread_trace );
311 _osrf_app_session_push_request( session, req );
312 return req->request_id;
315 /** Adds an app_request to the request set */
316 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
317 if(session == NULL || req == NULL)
320 debug_handler( "Pushing [%d] onto requeust queue for session [%s]",
321 req->request_id, session->session_id );
323 if(session->request_queue == NULL)
324 session->request_queue = req;
326 osrf_app_request* req2 = session->request_queue->next;
327 session->request_queue = req;
334 /** Removes an app_request from this session request set */
335 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
336 if(session == NULL || req == NULL)
339 if(session->request_queue == NULL)
342 debug_handler("Removing request [%d] from session [%s]",
343 req->request_id, session->session_id );
344 osrf_app_request* first = session->request_queue;
345 if(first->request_id == req->request_id) {
346 if(first->next == NULL) { /* only one in the list */
347 session->request_queue = NULL;
349 osrf_app_request* tmp = first->next;
350 session->request_queue = tmp;
354 osrf_app_request* lead = first->next;
356 while( lead != NULL ) {
357 if(lead->request_id == req->request_id) {
358 osrf_app_request* tmp = lead->next;
368 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
372 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
373 if(req) req->complete = 1;
376 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
379 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
381 return req->complete;
385 /** Returns the app_request with the given request_id (request_id) */
386 osrf_app_request* _osrf_app_session_get_request(
387 osrf_app_session* session, int request_id ){
391 debug_handler( "App Session searching for request [%d] in request queue",request_id );
392 osrf_app_request* req = session->request_queue;
393 while( req != NULL ) {
394 if(req->request_id == request_id)
402 /** Resets the remote connection id to that of the original*/
403 void osrf_app_session_reset_remote( osrf_app_session* session ){
407 free(session->remote_id);
408 debug_handler( "App Session [%s] resetting remote id to %s",
409 session->session_id, session->orig_remote_id );
411 session->remote_id = strdup(session->orig_remote_id);
414 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
417 if( session->remote_id )
418 free(session->remote_id );
419 session->remote_id = strdup( remote_id );
422 /** pushes the given message into the result list of the app_request
423 with the given request_id */
424 int osrf_app_session_push_queue(
425 osrf_app_session* session, osrf_message* msg ){
427 if(session == NULL || msg == NULL)
430 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
433 osrf_app_request* req = session->request_queue;
436 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
440 debug_handler( "The first request in the request queue has tt [%d]", req->request_id );
442 while( req != NULL ) {
443 if(req->request_id == msg->thread_trace) {
444 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
445 _osrf_app_request_push_queue( req, msg );
455 /** Attempts to connect to the remote service */
456 int osrf_app_session_connect(osrf_app_session* session){
461 int timeout = 5; /* XXX CONFIG VALUE */
463 debug_handler( "AppSession connecting to %s", session->remote_id );
465 /* defaulting to protocol 1 for now */
466 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
467 osrf_app_session_reset_remote( session );
468 session->state = OSRF_SESSION_CONNECTING;
469 int ret = _osrf_app_session_send( session, con_msg );
470 osrf_message_free(con_msg);
473 time_t start = time(NULL);
474 time_t remaining = (time_t) timeout;
476 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
477 osrf_app_session_queue_wait( session, remaining );
478 remaining -= (int) (time(NULL) - start);
481 if(session->state != OSRF_SESSION_CONNECTED)
489 /** Disconnects from the remote service */
490 int osrf_app_session_disconnect( osrf_app_session* session){
494 if(session->state == OSRF_SESSION_DISCONNECTED)
496 debug_handler( "AppSession disconnecting from %s", session->remote_id );
498 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
499 session->state = OSRF_SESSION_DISCONNECTED;
500 _osrf_app_session_send( session, dis_msg );
502 osrf_message_free( dis_msg );
503 osrf_app_session_reset_remote( session );
507 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
508 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
509 return _osrf_app_request_resend( req );
512 /** Send the given message */
513 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
514 if(session == NULL) return 0;
517 osrf_app_session_queue_wait( session, 0 );
518 debug_handler( "AppSession sending type %d, and thread_trace %d",
519 msg->m_type, msg->thread_trace );
521 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
522 (session->state != OSRF_SESSION_CONNECTED) ) {
523 if(!osrf_app_session_connect( session ))
527 char* xml = osrf_message_to_xml(msg);
529 transport_message* t_msg = message_init(
530 xml, "", session->session_id, session->remote_id, NULL );
532 debug_handler("Sending XML:\n%s", xml );
533 ret_val = client_send_message( session->transport_handle, t_msg );
535 message_free( t_msg );
540 /** Waits up to 'timeout' seconds for some data to arrive.
541 * Any data that arrives will be processed according to its
542 * payload and message type. This method will return after
543 * any data has arrived.
545 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
546 if(session == NULL) return 0;
548 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
549 ret_val = osrf_stack_process(session->transport_handle, timeout );
553 /** Disconnects (if client) and removes the given session from the global session cache
554 * ! This free's all attached app_requests !
556 void osrf_app_session_destroy ( osrf_app_session* session ){
557 if(session == NULL) return;
559 debug_handler( "AppSession [%s] destroying self and deleting requests", session->session_id );
560 if(session->type == OSRF_SESSION_CLIENT
561 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
562 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
563 _osrf_app_session_send( session, dis_msg );
564 osrf_message_free(dis_msg);
566 //session->state = OSRF_SESSION_DISCONNECTED;
567 _osrf_app_session_remove_session(session->session_id);
568 debug_handler("AppSession [%s] removed from cache", session->session_id );
570 osrf_app_request* req;
571 while( session->request_queue != NULL ) {
572 req = session->request_queue->next;
573 _osrf_app_request_free( session->request_queue );
574 session->request_queue = req;
577 _osrf_app_session_free( session );
580 osrf_message* osrf_app_session_request_recv(
581 osrf_app_session* session, int req_id, int timeout ) {
582 if(req_id < 0 || session == NULL)
584 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
585 return _osrf_app_request_recv( req, timeout );