1 #include "opensrf/osrf_app_session.h"
4 /* the global app_session cache */
5 osrf_app_session* app_session_cache;
9 // --------------------------------------------------------------------------
10 // --------------------------------------------------------------------------
12 // --------------------------------------------------------------------------
14 /** Allocations 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;
34 osrf_message* cur_msg = req->result;
35 while( cur_msg != NULL ) {
36 osrf_message* next_msg = cur_msg->next;
37 osrf_message_free( cur_msg );
40 osrf_message_free( req->payload );
44 /** Pushes the given message onto the list of 'responses' to this request */
45 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
46 if(req == NULL || result == NULL) return;
47 debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
48 if(req->result == NULL)
51 result->next = req->result;
56 /** Removes this app_request from our session request set */
57 void osrf_app_session_request_finish(
58 osrf_app_session* session, int req_id ){
60 if(session == NULL) return;
61 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
62 if(req == NULL) return;
63 _osrf_app_session_remove_request( req->session, req );
64 _osrf_app_request_free( req );
67 /** Checks the receive queue for messages. If any are found, the first
68 * is popped off and returned. Otherwise, this method will wait at most timeout
69 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
70 * If no messages arrive in the timeout provided, null is returned.
72 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
74 if(req == NULL) return NULL;
76 if( req->result != NULL ) {
77 debug_handler("app_request receive already has a message, returning it");
78 /* pop off the first message in the list */
79 osrf_message* tmp_msg = req->result->next;
80 req->result = tmp_msg;
84 time_t start = time(NULL);
85 time_t remaining = (time_t) timeout;
87 while( remaining >= 0 ) {
88 /* tell the session to wait for stuff */
89 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
91 osrf_app_session_queue_wait( req->session, 0 );
93 if( req->result != NULL ) { /* if we received anything */
94 /* pop off the first message in the list */
95 debug_handler( "app_request_recv received a message, returning it");
96 osrf_message* ret_msg = req->result;
97 osrf_message* tmp_msg = ret_msg->next;
98 req->result = tmp_msg;
105 osrf_app_session_queue_wait( req->session, (int) remaining );
107 if( req->result != NULL ) { /* if we received anything */
108 /* pop off the first message in the list */
109 debug_handler( "app_request_recv received a message, returning it");
110 osrf_message* ret_msg = req->result;
111 osrf_message* tmp_msg = ret_msg->next;
112 req->result = tmp_msg;
118 remaining -= (int) (time(NULL) - start);
124 /** Resend this requests original request message */
125 int _osrf_app_request_resend( osrf_app_request* req ) {
126 if(req == NULL) return 0;
127 debug_handler( "Resending request [%d]", req->request_id );
128 return _osrf_app_session_send( req->session, req->payload );
133 // --------------------------------------------------------------------------
134 // --------------------------------------------------------------------------
136 // --------------------------------------------------------------------------
138 /** returns a session from the global session hash */
139 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
140 osrf_app_session* ptr = app_session_cache;
141 debug_handler("Searching for session in global cache with id [%s]", session_id );
142 while( ptr != NULL ) {
143 if( !strcmp(ptr->session_id,session_id) )
151 /** adds a session to the global session cache */
152 void _osrf_app_session_push_session( osrf_app_session* session ) {
154 if( app_session_cache == NULL ) {
155 app_session_cache = session;
159 osrf_app_session* ptr = app_session_cache;
160 debug_handler( "Pushing [%s] onto global session cache", session->session_id );
161 while( ptr != NULL ) {
162 if( !strcmp(ptr->session_id, session->session_id) )
164 if( ptr->next == NULL ) {
173 /** unlinks from global session cache */
174 void _osrf_app_session_remove_session( char* session_id ) {
176 if( app_session_cache == NULL )
179 debug_handler( "App Session removing session [%s] from global cache", session_id );
180 if( !strcmp(app_session_cache->session_id, session_id) ) {
181 if( app_session_cache->next != NULL ) {
182 osrf_app_session* next = app_session_cache->next;
183 app_session_cache = next;
186 app_session_cache = NULL;
191 if( app_session_cache->next == NULL )
194 osrf_app_session* prev = app_session_cache;
195 osrf_app_session* ptr = prev->next;
196 while( ptr != NULL ) {
197 if( ptr->session_id == session_id ) {
198 osrf_app_session* tmp = ptr->next;
206 /** Allocates a initializes a new app_session */
208 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
209 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
211 session->transport_handle = osrf_system_get_transport_client();
212 if( session->transport_handle == NULL ) {
213 warning_handler("No transport client for service 'client'");
217 char target_buf[512];
218 memset(target_buf,0,512);
219 char* domain = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
220 char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
221 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
225 session->request_queue = NULL;
226 session->remote_id = strdup(target_buf);
227 session->orig_remote_id = strdup(session->remote_id);
229 /* build a chunky, random session id */
232 srand((int)time(NULL));
233 sprintf(id, "%d.%d%d", rand(), (int)time(NULL), getpid());
234 session->session_id = strdup(id);
235 debug_handler( "Building a new client session with id [%s]", session->session_id );
237 session->thread_trace = 0;
238 session->state = OSRF_SESSION_DISCONNECTED;
239 session->type = OSRF_SESSION_CLIENT;
240 session->next = NULL;
241 _osrf_app_session_push_session( session );
245 osrf_app_session* osrf_app_server_session_init(
246 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
248 osrf_app_session* session = osrf_app_session_find_session( session_id );
252 debug_handler( "Building a new server session with id [%s]", session_id );
254 session = safe_malloc(sizeof(osrf_app_session));
256 session->transport_handle = osrf_system_get_transport_client();
257 if( session->transport_handle == NULL ) {
258 warning_handler("No transport client for service '%s'", our_app );
261 session->request_queue = NULL;
262 session->remote_id = strdup(remote_id);
263 session->orig_remote_id = strdup(remote_id);
264 session->session_id = strdup(session_id);
266 session->thread_trace = 0;
267 session->state = OSRF_SESSION_DISCONNECTED;
268 session->type = OSRF_SESSION_CLIENT;
269 session->next = NULL;
271 _osrf_app_session_push_session( session );
278 /** frees memory held by a session */
279 void _osrf_app_session_free( osrf_app_session* session ){
283 free(session->remote_id);
284 free(session->orig_remote_id);
289 int osrf_app_session_make_request(
290 osrf_app_session* session, json* params, char* method_name, int protocol ) {
291 if(session == NULL) return -1;
293 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
294 osrf_message_set_request_info( req_msg, method_name, params );
295 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
296 if(!_osrf_app_session_send( session, req_msg ) ) {
297 warning_handler( "Error sending request message [%d]", session->thread_trace );
301 _osrf_app_session_push_request( session, req );
302 return req->request_id;
305 /** Adds an app_request to the request set */
306 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
307 if(session == NULL || req == NULL)
310 debug_handler( "Pushing [%d] onto requeust queue for session [%s]",
311 req->request_id, session->session_id );
313 if(session->request_queue == NULL)
314 session->request_queue = req;
316 osrf_app_request* req2 = session->request_queue->next;
317 session->request_queue = req;
324 /** Removes an app_request from this session request set */
325 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
326 if(session == NULL || req == NULL)
329 if(session->request_queue == NULL)
332 debug_handler("Removing request [%d] from session [%s]",
333 req->request_id, session->session_id );
334 osrf_app_request* first = session->request_queue;
335 if(first->request_id == req->request_id) {
336 if(first->next == NULL) { /* only one in the list */
337 session->request_queue = NULL;
339 osrf_app_request* tmp = first->next;
340 session->request_queue = tmp;
344 osrf_app_request* lead = first->next;
346 while( lead != NULL ) {
347 if(lead->request_id == req->request_id) {
348 osrf_app_request* tmp = lead->next;
358 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
362 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
363 if(req) req->complete = 1;
366 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
369 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
371 return req->complete;
375 /** Returns the app_request with the given request_id (request_id) */
376 osrf_app_request* _osrf_app_session_get_request(
377 osrf_app_session* session, int request_id ){
381 debug_handler( "App Session searching for request [%d] in request queue",request_id );
382 osrf_app_request* req = session->request_queue;
383 while( req != NULL ) {
384 if(req->request_id == request_id)
392 /** Resets the remote connection id to that of the original*/
393 void osrf_app_session_reset_remote( osrf_app_session* session ){
397 free(session->remote_id);
398 debug_handler( "App Session [%s] resetting remote it to %s",
399 session->session_id, session->orig_remote_id );
401 session->remote_id = strdup(session->orig_remote_id);
404 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
407 if( session->remote_id )
408 free(session->remote_id );
409 session->remote_id = strdup( remote_id );
412 /** pushes the given message into the result list of the app_request
413 with the given request_id */
414 int osrf_app_session_push_queue(
415 osrf_app_session* session, osrf_message* msg ){
417 if(session == NULL || msg == NULL)
420 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
423 osrf_app_request* req = session->request_queue;
426 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
430 debug_handler( "The first request in the request queue has tt [%d]", req->request_id );
432 while( req != NULL ) {
433 if(req->request_id == msg->thread_trace) {
434 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
435 _osrf_app_request_push_queue( req, msg );
445 /** Attempts to connect to the remote service */
446 int osrf_app_session_connect(osrf_app_session* session){
451 int timeout = 5; /* XXX CONFIG VALUE */
453 debug_handler( "AppSession connecting to %s", session->remote_id );
455 /* defaulting to protocol 1 for now */
456 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
457 osrf_app_session_reset_remote( session );
458 session->state = OSRF_SESSION_CONNECTING;
459 if(!_osrf_app_session_send( session, con_msg ) )
462 time_t start = time(NULL);
463 time_t remaining = (time_t) timeout;
465 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
466 osrf_app_session_queue_wait( session, remaining );
467 remaining -= (int) (time(NULL) - start);
470 if(session->state != OSRF_SESSION_CONNECTED)
478 /** Disconnects from the remote service */
479 int osrf_app_session_disconnect( osrf_app_session* session){
483 if(session->state == OSRF_SESSION_DISCONNECTED)
485 debug_handler( "AppSession disconnecting from %s", session->remote_id );
487 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
488 session->state = OSRF_SESSION_DISCONNECTED;
489 _osrf_app_session_send( session, dis_msg );
491 osrf_message_free( dis_msg );
492 osrf_app_session_reset_remote( session );
496 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
497 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
498 return _osrf_app_request_resend( req );
501 /** Send the given message */
502 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
503 if(session == NULL) return 0;
506 osrf_app_session_queue_wait( session, 0 );
507 debug_handler( "AppSession sending type %d, and thread_trace %d",
508 msg->m_type, msg->thread_trace );
510 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
511 (session->state != OSRF_SESSION_CONNECTED) ) {
512 if(!osrf_app_session_connect( session ))
516 char* xml = osrf_message_to_xml(msg);
518 transport_message* t_msg = message_init(
519 xml, "", session->session_id, session->remote_id, NULL );
521 debug_handler("Sending XML:\n%s", xml );
522 ret_val = client_send_message( session->transport_handle, t_msg );
523 message_free( t_msg );
528 /** Waits up to 'timeout' seconds for some data to arrive.
529 * Any data that arrives will be processed according to its
530 * payload and message type. This method will return after
531 * any data has arrived.
533 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
534 if(session == NULL) return 0;
536 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
537 ret_val = osrf_stack_process(session->transport_handle, timeout );
541 /** Disconnects (if client) and removes the given session from the global session cache
542 * ! This free's all attached app_requests !
544 void osrf_app_session_destroy ( osrf_app_session* session ){
545 if(session == NULL) return;
547 debug_handler( "AppSession [%s] destroying self and deleting requests", session->session_id );
548 if(session->type == OSRF_SESSION_CLIENT) { /* disconnect if we're a client */
549 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
550 _osrf_app_session_send( session, dis_msg );
551 //osrf_app_session_reset_remote( session );
553 //session->state = OSRF_SESSION_DISCONNECTED;
554 _osrf_app_session_remove_session(session->session_id);
555 debug_handler("AppSession [%s] removed from cache", session->session_id );
557 osrf_app_request* req;
558 while( session->request_queue != NULL ) {
559 req = session->request_queue->next;
560 _osrf_app_request_free( session->request_queue );
561 session->request_queue = req;
564 _osrf_app_session_free( session );
567 osrf_message* osrf_app_session_request_recv(
568 osrf_app_session* session, int req_id, int timeout ) {
569 if(req_id < 0 || session == NULL)
571 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
572 return _osrf_app_request_recv( req, timeout );