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 debug_handler("Finishing request %d", req_id );
69 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
70 if(req == NULL) return;
71 _osrf_app_session_remove_request( req->session, req );
72 _osrf_app_request_free( req );
75 /** Checks the receive queue for messages. If any are found, the first
76 * is popped off and returned. Otherwise, this method will wait at most timeout
77 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
78 * If no messages arrive in the timeout provided, null is returned.
80 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
82 if(req == NULL) return NULL;
84 if( req->result != NULL ) {
85 debug_handler("app_request receive already has a message, returning it");
86 /* pop off the first message in the list */
87 osrf_message* tmp_msg = req->result;
88 req->result = req->result->next;
92 time_t start = time(NULL);
93 time_t remaining = (time_t) timeout;
95 while( remaining >= 0 ) {
96 /* tell the session to wait for stuff */
97 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
99 osrf_app_session_queue_wait( req->session, 0 );
101 if( req->result != NULL ) { /* if we received anything */
102 /* pop off the first message in the list */
103 debug_handler( "app_request_recv received a message, returning it");
104 osrf_message* ret_msg = req->result;
105 osrf_message* tmp_msg = ret_msg->next;
106 req->result = tmp_msg;
113 osrf_app_session_queue_wait( req->session, (int) remaining );
115 if( req->result != NULL ) { /* if we received anything */
116 /* pop off the first message in the list */
117 debug_handler( "app_request_recv received a message, returning it");
118 osrf_message* ret_msg = req->result;
119 osrf_message* tmp_msg = ret_msg->next;
120 req->result = tmp_msg;
126 remaining -= (int) (time(NULL) - start);
129 debug_handler("Returning NULL from app_request_recv after timeout");
133 /** Resend this requests original request message */
134 int _osrf_app_request_resend( osrf_app_request* req ) {
135 if(req == NULL) return 0;
137 debug_handler( "Resending request [%d]", req->request_id );
138 return _osrf_app_session_send( req->session, req->payload );
145 // --------------------------------------------------------------------------
146 // --------------------------------------------------------------------------
148 // --------------------------------------------------------------------------
150 /** returns a session from the global session hash */
151 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
152 osrf_app_session* ptr = app_session_cache;
153 debug_handler("Searching for session in global cache with id [%s]", session_id );
154 while( ptr != NULL ) {
155 if( !strcmp(ptr->session_id,session_id) )
163 /** adds a session to the global session cache */
164 void _osrf_app_session_push_session( osrf_app_session* session ) {
166 if( app_session_cache == NULL ) {
167 app_session_cache = session;
171 osrf_app_session* ptr = app_session_cache;
172 debug_handler( "Pushing [%s] [%s] onto global session cache",
173 session->remote_service, session->session_id );
174 while( ptr != NULL ) {
175 if( !strcmp(ptr->session_id, session->session_id) )
177 if( ptr->next == NULL ) {
186 /** unlinks from global session cache */
187 void _osrf_app_session_remove_session( char* session_id ) {
189 if( app_session_cache == NULL )
192 debug_handler( "App Session removing session [%s] from global cache", session_id );
193 if( !strcmp(app_session_cache->session_id, session_id) ) {
194 if( app_session_cache->next != NULL ) {
195 osrf_app_session* next = app_session_cache->next;
196 app_session_cache = next;
199 app_session_cache = NULL;
204 if( app_session_cache->next == NULL )
207 osrf_app_session* prev = app_session_cache;
208 osrf_app_session* ptr = prev->next;
209 while( ptr != NULL ) {
210 if( ptr->session_id == session_id ) {
211 osrf_app_session* tmp = ptr->next;
219 /** Allocates a initializes a new app_session */
221 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
223 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
225 session->transport_handle = osrf_system_get_transport_client();
226 if( session->transport_handle == NULL ) {
227 warning_handler("No transport client for service 'client'");
231 char target_buf[512];
232 memset(target_buf,0,512);
233 char* domain = config_value( "opensrf.bootstrap", "//bootstrap/domains/domain1" ); /* just the first for now */
234 char* router_name = config_value( "opensrf.bootstrap", "//bootstrap/router_name" );
235 sprintf( target_buf, "%s@%s/%s", router_name, domain, remote_service );
239 session->request_queue = NULL;
240 session->remote_id = strdup(target_buf);
241 session->orig_remote_id = strdup(session->remote_id);
242 session->remote_service = strdup(remote_service);
244 /* build a chunky, random session id */
247 //srand((int)time(NULL));
249 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
250 session->session_id = strdup(id);
251 debug_handler( "Building a new client session with id [%s] [%s]",
252 session->remote_service, session->session_id );
254 session->thread_trace = 0;
255 session->state = OSRF_SESSION_DISCONNECTED;
256 session->type = OSRF_SESSION_CLIENT;
257 session->next = NULL;
258 _osrf_app_session_push_session( session );
262 osrf_app_session* osrf_app_server_session_init(
263 char* session_id, char* our_app, char* remote_service, char* remote_id ) {
265 osrf_app_session* session = osrf_app_session_find_session( session_id );
270 session = safe_malloc(sizeof(osrf_app_session));
272 session->transport_handle = osrf_system_get_transport_client();
273 if( session->transport_handle == NULL ) {
274 warning_handler("No transport client for service '%s'", our_app );
277 session->request_queue = NULL;
278 session->remote_id = strdup(remote_id);
279 session->orig_remote_id = strdup(remote_id);
280 session->session_id = strdup(session_id);
281 session->remote_service = strdup(remote_service);
283 debug_handler( "Building a new server session [%s] with id [%s]",
284 session->remote_service, session_id );
286 session->thread_trace = 0;
287 session->state = OSRF_SESSION_DISCONNECTED;
288 session->type = OSRF_SESSION_CLIENT;
289 session->next = NULL;
291 _osrf_app_session_push_session( session );
298 /** frees memory held by a session */
299 void _osrf_app_session_free( osrf_app_session* session ){
303 free(session->remote_id);
304 free(session->orig_remote_id);
305 free(session->session_id);
306 free(session->remote_service);
311 int osrf_app_session_make_request(
312 osrf_app_session* session, json* params,
313 char* method_name, int protocol, string_array* param_strings ) {
314 if(session == NULL) return -1;
316 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
317 osrf_message_set_request_info( req_msg, method_name, params );
319 /* if we're not parsing the json, shove the strings in manually */
320 if(!req_msg->parse_json_params && param_strings) {
322 for(i = 0; i!= param_strings->size ; i++ ) {
323 osrf_message_add_param(req_msg,
324 string_array_get_string(param_strings,i));
328 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
329 if(!_osrf_app_session_send( session, req_msg ) ) {
330 warning_handler( "Error sending request message [%d]", session->thread_trace );
334 _osrf_app_session_push_request( session, req );
335 return req->request_id;
338 /** Adds an app_request to the request set */
339 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
340 if(session == NULL || req == NULL)
343 debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
344 req->request_id, session->remote_service, session->session_id );
346 if(session->request_queue == NULL)
347 session->request_queue = req;
349 osrf_app_request* req2 = session->request_queue->next;
350 session->request_queue = req;
357 /** Removes an app_request from this session request set */
358 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
359 if(session == NULL || req == NULL)
362 if(session->request_queue == NULL)
365 debug_handler("Removing request [%d] from session [%s] [%s]",
366 req->request_id, session->remote_service, session->session_id );
367 osrf_app_request* first = session->request_queue;
368 if(first->request_id == req->request_id) {
369 if(first->next == NULL) { /* only one in the list */
370 session->request_queue = NULL;
372 osrf_app_request* tmp = first->next;
373 session->request_queue = tmp;
377 osrf_app_request* lead = first->next;
379 while( lead != NULL ) {
380 if(lead->request_id == req->request_id) {
381 osrf_app_request* tmp = lead->next;
391 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
395 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
396 if(req) req->complete = 1;
399 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
402 osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
404 return req->complete;
408 /** Returns the app_request with the given request_id (request_id) */
409 osrf_app_request* _osrf_app_session_get_request(
410 osrf_app_session* session, int request_id ){
414 debug_handler( "App Session searching for request [%d] in request queue",request_id );
415 osrf_app_request* req = session->request_queue;
416 while( req != NULL ) {
417 if(req->request_id == request_id)
425 /** Resets the remote connection id to that of the original*/
426 void osrf_app_session_reset_remote( osrf_app_session* session ){
430 free(session->remote_id);
431 debug_handler( "App Session [%s] [%s] resetting remote id to %s",
432 session->remote_service, session->session_id, session->orig_remote_id );
434 session->remote_id = strdup(session->orig_remote_id);
437 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
440 if( session->remote_id )
441 free(session->remote_id );
442 session->remote_id = strdup( remote_id );
445 /** pushes the given message into the result list of the app_request
446 with the given request_id */
447 int osrf_app_session_push_queue(
448 osrf_app_session* session, osrf_message* msg ){
450 if(session == NULL || msg == NULL)
453 debug_handler( "AppSession pushing result for [%d] onto request payload queue",
456 osrf_app_request* req = session->request_queue;
459 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
463 while( req != NULL ) {
464 if(req->request_id == msg->thread_trace) {
465 debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
466 _osrf_app_request_push_queue( req, msg );
476 /** Attempts to connect to the remote service */
477 int osrf_app_session_connect(osrf_app_session* session){
482 if(session->state == OSRF_SESSION_CONNECTED) {
483 debug_handler("Already Connected, returning");
487 int timeout = 5; /* XXX CONFIG VALUE */
489 debug_handler( "AppSession connecting to %s", session->remote_id );
491 /* defaulting to protocol 1 for now */
492 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
493 osrf_app_session_reset_remote( session );
494 session->state = OSRF_SESSION_CONNECTING;
495 int ret = _osrf_app_session_send( session, con_msg );
496 osrf_message_free(con_msg);
499 time_t start = time(NULL);
500 time_t remaining = (time_t) timeout;
502 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
503 osrf_app_session_queue_wait( session, remaining );
504 remaining -= (int) (time(NULL) - start);
507 if(session->state == OSRF_SESSION_CONNECTED)
508 debug_handler(" * Connected Successfully");
510 if(session->state != OSRF_SESSION_CONNECTED)
518 /** Disconnects from the remote service */
519 int osrf_app_session_disconnect( osrf_app_session* session){
523 if(session->state == OSRF_SESSION_DISCONNECTED)
525 debug_handler( "AppSession disconnecting from %s", session->remote_id );
527 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
528 session->state = OSRF_SESSION_DISCONNECTED;
529 _osrf_app_session_send( session, dis_msg );
531 osrf_message_free( dis_msg );
532 osrf_app_session_reset_remote( session );
536 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
537 debug_handler("In reqeust resend searching for resend-able messages");
538 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
539 return _osrf_app_request_resend( req );
542 /** Send the given message */
543 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
544 if(session == NULL) return 0;
547 osrf_app_session_queue_wait( session, 0 );
548 debug_handler( "AppSession sending type %d, and thread_trace %d",
549 msg->m_type, msg->thread_trace );
551 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
552 (session->state != OSRF_SESSION_CONNECTED) ) {
553 if(!osrf_app_session_connect( session ))
557 char* xml = osrf_message_to_xml(msg);
559 debug_handler("[%s] [%s] Remote Id: %s",
560 session->remote_service, session->session_id, session->remote_id );
562 transport_message* t_msg = message_init(
563 xml, "", session->session_id, session->remote_id, NULL );
565 debug_handler("Session [%s] [%s] sending to %s \nXML:\n%s",
566 session->remote_service, session->session_id, t_msg->recipient, xml );
567 ret_val = client_send_message( session->transport_handle, t_msg );
569 message_free( t_msg );
574 /** Waits up to 'timeout' seconds for some data to arrive.
575 * Any data that arrives will be processed according to its
576 * payload and message type. This method will return after
577 * any data has arrived.
579 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
580 if(session == NULL) return 0;
582 debug_handler( "AppSession in queue_wait with timeout %d", timeout );
583 ret_val = osrf_stack_process(session->transport_handle, timeout );
587 /** Disconnects (if client) and removes the given session from the global session cache
588 * ! This free's all attached app_requests !
590 void osrf_app_session_destroy ( osrf_app_session* session ){
591 if(session == NULL) return;
593 debug_handler( "AppSession [%s] [%s] destroying self and deleting requests",
594 session->remote_service, session->session_id );
595 if(session->type == OSRF_SESSION_CLIENT
596 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
597 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
598 _osrf_app_session_send( session, dis_msg );
599 osrf_message_free(dis_msg);
601 //session->state = OSRF_SESSION_DISCONNECTED;
602 _osrf_app_session_remove_session(session->session_id);
603 debug_handler("AppSession [%s] [%s] removed from cache",
604 session->remote_service, session->session_id );
606 osrf_app_request* req;
607 while( session->request_queue != NULL ) {
608 req = session->request_queue->next;
609 _osrf_app_request_free( session->request_queue );
610 session->request_queue = req;
613 _osrf_app_session_free( session );
616 osrf_message* osrf_app_session_request_recv(
617 osrf_app_session* session, int req_id, int timeout ) {
618 if(req_id < 0 || session == NULL)
620 debug_handler("somebody callled recv");
621 osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
622 return _osrf_app_request_recv( req, timeout );