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;
35 osrf_message* cur_msg = req->result;
36 while( cur_msg != NULL ) {
37 osrf_message* next_msg = cur_msg->next;
38 osrf_message_free( cur_msg );
41 osrf_message_free( req->payload );
46 /** Pushes the given message onto the list of 'responses' to this request */
47 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
48 if(req == NULL || result == NULL) return;
49 debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
50 if(req->result == NULL)
53 result->next = req->result;
58 /** Removes this app_request from our session request set */
59 void osrf_app_session_request_finish(
60 osrf_app_session* session, int req_id ){
62 if(session == NULL) return;
63 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
64 if(req == NULL) return;
65 _osrf_app_session_remove_request( req->session, req );
66 _osrf_app_request_free( req );
69 /** Checks the receive queue for messages. If any are found, the first
70 * is popped off and returned. Otherwise, this method will wait at most timeout
71 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
72 * If no messages arrive in the timeout provided, null is returned.
74 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
76 if(req == NULL) return NULL;
78 if( req->result != NULL ) {
79 debug_handler("app_request receive already has a message, returning it");
80 /* pop off the first message in the list */
81 osrf_message* tmp_msg = req->result->next;
82 req->result = tmp_msg;
86 time_t start = time(NULL);
87 time_t remaining = (time_t) timeout;
89 while( remaining >= 0 ) {
90 /* tell the session to wait for stuff */
91 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
93 osrf_app_session_queue_wait( req->session, 0 );
95 if( req->result != NULL ) { /* if we received anything */
96 /* pop off the first message in the list */
97 debug_handler( "app_request_recv received a message, returning it");
98 osrf_message* ret_msg = req->result;
99 osrf_message* tmp_msg = ret_msg->next;
100 req->result = tmp_msg;
107 osrf_app_session_queue_wait( req->session, (int) remaining );
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;
120 remaining -= (int) (time(NULL) - start);
126 /** Resend this requests original request message */
127 int _osrf_app_request_resend( osrf_app_request* req ) {
128 if(req == NULL) return 0;
130 debug_handler( "Resending request [%d]", req->request_id );
131 return _osrf_app_session_send( req->session, req->payload );
138 // --------------------------------------------------------------------------
139 // --------------------------------------------------------------------------
141 // --------------------------------------------------------------------------
143 /** returns a session from the global session hash */
144 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
145 osrf_app_session* ptr = app_session_cache;
146 debug_handler("Searching for session in global cache with id [%s]", session_id );
147 while( ptr != NULL ) {
148 if( !strcmp(ptr->session_id,session_id) )
156 /** adds a session to the global session cache */
157 void _osrf_app_session_push_session( osrf_app_session* session ) {
159 if( app_session_cache == NULL ) {
160 app_session_cache = session;
164 osrf_app_session* ptr = app_session_cache;
165 debug_handler( "Pushing [%s] onto global session cache", session->session_id );
166 while( ptr != NULL ) {
167 if( !strcmp(ptr->session_id, session->session_id) )
169 if( ptr->next == NULL ) {
178 /** unlinks from global session cache */
179 void _osrf_app_session_remove_session( char* session_id ) {
181 if( app_session_cache == NULL )
184 debug_handler( "App Session removing session [%s] from global cache", session_id );
185 if( !strcmp(app_session_cache->session_id, session_id) ) {
186 if( app_session_cache->next != NULL ) {
187 osrf_app_session* next = app_session_cache->next;
188 app_session_cache = next;
191 app_session_cache = NULL;
196 if( app_session_cache->next == NULL )
199 osrf_app_session* prev = app_session_cache;
200 osrf_app_session* ptr = prev->next;
201 while( ptr != NULL ) {
202 if( ptr->session_id == session_id ) {
203 osrf_app_session* tmp = ptr->next;
211 /** Allocates a initializes a new app_session */
213 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
214 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
216 session->transport_handle = osrf_system_get_transport_client();
217 if( session->transport_handle == NULL ) {
218 warning_handler("No transport client for service 'client'");
222 char target_buf[512];
223 memset(target_buf,0,512);
224 char* domain = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
225 char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
226 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
230 session->request_queue = NULL;
231 session->remote_id = strdup(target_buf);
232 session->orig_remote_id = strdup(session->remote_id);
234 /* build a chunky, random session id */
237 srand((int)time(NULL));
238 sprintf(id, "%d.%d%d", rand(), (int)time(NULL), getpid());
239 session->session_id = strdup(id);
240 debug_handler( "Building a new client session with id [%s]", session->session_id );
242 session->thread_trace = 0;
243 session->state = OSRF_SESSION_DISCONNECTED;
244 session->type = OSRF_SESSION_CLIENT;
245 session->next = NULL;
246 _osrf_app_session_push_session( session );
250 osrf_app_session* osrf_app_server_session_init(
251 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
253 osrf_app_session* session = osrf_app_session_find_session( session_id );
257 debug_handler( "Building a new server session with id [%s]", session_id );
259 session = safe_malloc(sizeof(osrf_app_session));
261 session->transport_handle = osrf_system_get_transport_client();
262 if( session->transport_handle == NULL ) {
263 warning_handler("No transport client for service '%s'", our_app );
266 session->request_queue = NULL;
267 session->remote_id = strdup(remote_id);
268 session->orig_remote_id = strdup(remote_id);
269 session->session_id = strdup(session_id);
271 session->thread_trace = 0;
272 session->state = OSRF_SESSION_DISCONNECTED;
273 session->type = OSRF_SESSION_CLIENT;
274 session->next = NULL;
276 _osrf_app_session_push_session( session );
283 /** frees memory held by a session */
284 void _osrf_app_session_free( osrf_app_session* session ){
288 free(session->remote_id);
289 free(session->orig_remote_id);
294 int osrf_app_session_make_request(
295 osrf_app_session* session, json* params, char* method_name, int protocol ) {
296 if(session == NULL) return -1;
298 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
299 osrf_message_set_request_info( req_msg, method_name, params );
300 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
301 if(!_osrf_app_session_send( session, req_msg ) ) {
302 warning_handler( "Error sending request message [%d]", session->thread_trace );
306 _osrf_app_session_push_request( session, req );
307 return req->request_id;
310 /** Adds an app_request to the request set */
311 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
312 if(session == NULL || req == NULL)
315 debug_handler( "Pushing [%d] onto requeust queue for session [%s]",
316 req->request_id, session->session_id );
318 if(session->request_queue == NULL)
319 session->request_queue = req;
321 osrf_app_request* req2 = session->request_queue->next;
322 session->request_queue = req;
329 /** Removes an app_request from this session request set */
330 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
331 if(session == NULL || req == NULL)
334 if(session->request_queue == NULL)
337 debug_handler("Removing request [%d] from session [%s]",
338 req->request_id, session->session_id );
339 osrf_app_request* first = session->request_queue;
340 if(first->request_id == req->request_id) {
341 if(first->next == NULL) { /* only one in the list */
342 session->request_queue = NULL;
344 osrf_app_request* tmp = first->next;
345 session->request_queue = tmp;
349 osrf_app_request* lead = first->next;
351 while( lead != NULL ) {
352 if(lead->request_id == req->request_id) {
353 osrf_app_request* tmp = lead->next;
363 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
367 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
368 if(req) req->complete = 1;
371 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
374 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
376 return req->complete;
380 /** Returns the app_request with the given request_id (request_id) */
381 osrf_app_request* _osrf_app_session_get_request(
382 osrf_app_session* session, int request_id ){
386 debug_handler( "App Session searching for request [%d] in request queue",request_id );
387 osrf_app_request* req = session->request_queue;
388 while( req != NULL ) {
389 if(req->request_id == request_id)
397 /** Resets the remote connection id to that of the original*/
398 void osrf_app_session_reset_remote( osrf_app_session* session ){
402 free(session->remote_id);
403 debug_handler( "App Session [%s] resetting remote it to %s",
404 session->session_id, session->orig_remote_id );
406 session->remote_id = strdup(session->orig_remote_id);
409 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
412 if( session->remote_id )
413 free(session->remote_id );
414 session->remote_id = strdup( remote_id );
417 /** pushes the given message into the result list of the app_request
418 with the given request_id */
419 int osrf_app_session_push_queue(
420 osrf_app_session* session, osrf_message* msg ){
422 if(session == NULL || msg == NULL)
425 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
428 osrf_app_request* req = session->request_queue;
431 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
435 debug_handler( "The first request in the request queue has tt [%d]", req->request_id );
437 while( req != NULL ) {
438 if(req->request_id == msg->thread_trace) {
439 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
440 _osrf_app_request_push_queue( req, msg );
450 /** Attempts to connect to the remote service */
451 int osrf_app_session_connect(osrf_app_session* session){
456 int timeout = 5; /* XXX CONFIG VALUE */
458 debug_handler( "AppSession connecting to %s", session->remote_id );
460 /* defaulting to protocol 1 for now */
461 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
462 osrf_app_session_reset_remote( session );
463 session->state = OSRF_SESSION_CONNECTING;
464 int ret = _osrf_app_session_send( session, con_msg );
465 osrf_message_free(con_msg);
468 time_t start = time(NULL);
469 time_t remaining = (time_t) timeout;
471 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
472 osrf_app_session_queue_wait( session, remaining );
473 remaining -= (int) (time(NULL) - start);
476 if(session->state != OSRF_SESSION_CONNECTED)
484 /** Disconnects from the remote service */
485 int osrf_app_session_disconnect( osrf_app_session* session){
489 if(session->state == OSRF_SESSION_DISCONNECTED)
491 debug_handler( "AppSession disconnecting from %s", session->remote_id );
493 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
494 session->state = OSRF_SESSION_DISCONNECTED;
495 _osrf_app_session_send( session, dis_msg );
497 osrf_message_free( dis_msg );
498 osrf_app_session_reset_remote( session );
502 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
503 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
504 return _osrf_app_request_resend( req );
507 /** Send the given message */
508 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
509 if(session == NULL) return 0;
512 osrf_app_session_queue_wait( session, 0 );
513 debug_handler( "AppSession sending type %d, and thread_trace %d",
514 msg->m_type, msg->thread_trace );
516 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
517 (session->state != OSRF_SESSION_CONNECTED) ) {
518 if(!osrf_app_session_connect( session ))
522 char* xml = osrf_message_to_xml(msg);
524 transport_message* t_msg = message_init(
525 xml, "", session->session_id, session->remote_id, NULL );
527 debug_handler("Sending XML:\n%s", xml );
528 ret_val = client_send_message( session->transport_handle, t_msg );
529 message_free( t_msg );
534 /** Waits up to 'timeout' seconds for some data to arrive.
535 * Any data that arrives will be processed according to its
536 * payload and message type. This method will return after
537 * any data has arrived.
539 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
540 if(session == NULL) return 0;
542 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
543 ret_val = osrf_stack_process(session->transport_handle, timeout );
547 /** Disconnects (if client) and removes the given session from the global session cache
548 * ! This free's all attached app_requests !
550 void osrf_app_session_destroy ( osrf_app_session* session ){
551 if(session == NULL) return;
553 debug_handler( "AppSession [%s] destroying self and deleting requests", session->session_id );
554 if(session->type == OSRF_SESSION_CLIENT) { /* disconnect if we're a client */
555 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
556 _osrf_app_session_send( session, dis_msg );
557 //osrf_app_session_reset_remote( session );
559 //session->state = OSRF_SESSION_DISCONNECTED;
560 _osrf_app_session_remove_session(session->session_id);
561 debug_handler("AppSession [%s] removed from cache", session->session_id );
563 osrf_app_request* req;
564 while( session->request_queue != NULL ) {
565 req = session->request_queue->next;
566 _osrf_app_request_free( session->request_queue );
567 session->request_queue = req;
570 _osrf_app_session_free( session );
573 osrf_message* osrf_app_session_request_recv(
574 osrf_app_session* session, int req_id, int timeout ) {
575 if(req_id < 0 || session == NULL)
577 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
578 return _osrf_app_request_recv( req, timeout );