1 #include <opensrf/osrf_app_session.h>
4 struct osrf_app_request_struct {
5 /** Our controlling session */
6 struct osrf_app_session_struct* session;
10 /** True if we have received a 'request complete' message from our request */
12 /** Our original request payload */
14 /** List of responses to our request */
17 /* if set to true, then a call that is waiting on a response, will reset the
18 timeout and set this variable back to false */
21 typedef struct osrf_app_request_struct osrfAppRequest;
23 /** Send the given message */
24 static int _osrf_app_session_send( osrfAppSession*, osrfMessage* msg );
26 static int osrfAppSessionMakeLocaleRequest(
27 osrfAppSession* session, const jsonObject* params, const char* method_name,
28 int protocol, osrfStringArray* param_strings, char* locale );
30 /* the global app_session cache */
31 static osrfHash* osrfAppSessionCache = NULL;
33 // --------------------------------------------------------------------------
34 // --------------------------------------------------------------------------
36 // --------------------------------------------------------------------------
38 /** Allocates and initializes a new app_request object */
39 static osrfAppRequest* _osrf_app_request_init(
40 osrfAppSession* session, osrfMessage* msg ) {
43 (osrfAppRequest*) safe_malloc(sizeof(osrfAppRequest));
45 req->session = session;
46 req->request_id = msg->thread_trace;
50 req->reset_timeout = 0;
57 void osrfAppSessionCleanup() {
58 osrfHashFree(osrfAppSessionCache);
59 osrfAppSessionCache = NULL;
62 /** Frees memory used by an app_request object */
63 static void _osrf_app_request_free( void * req ){
64 if( req == NULL ) return;
65 osrfAppRequest* r = (osrfAppRequest*) req;
66 if( r->payload ) osrfMessageFree( r->payload );
68 /* Free the messages in the result queue */
70 osrfMessage* next_msg;
72 next_msg = r->result->next;
73 osrfMessageFree( r->result );
80 /** Pushes the given message onto the list of 'responses' to this request */
81 static void _osrf_app_request_push_queue( osrfAppRequest* req, osrfMessage* result ){
82 if(req == NULL || result == NULL) return;
83 osrfLogDebug( OSRF_LOG_MARK, "App Session pushing request [%d] onto request queue", result->thread_trace );
84 if(req->result == NULL) {
89 osrfMessage* ptr = req->result;
90 osrfMessage* ptr2 = req->result->next;
99 /** Removes this app_request from our session request set */
100 void osrf_app_session_request_finish(
101 osrfAppSession* session, int req_id ){
103 if(session == NULL) return;
104 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
105 if(req == NULL) return;
106 osrfListRemove( req->session->request_queue, req->request_id );
110 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id ) {
111 if(session == NULL) return;
112 osrfLogDebug( OSRF_LOG_MARK, "Resetting request timeout %d", req_id );
113 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
114 if(req == NULL) return;
115 req->reset_timeout = 1;
118 /** Checks the receive queue for messages. If any are found, the first
119 * is popped off and returned. Otherwise, this method will wait at most timeout
120 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
121 * If no messages arrive in the timeout provided, null is returned.
123 static osrfMessage* _osrf_app_request_recv( osrfAppRequest* req, int timeout ) {
125 if(req == NULL) return NULL;
127 if( req->result != NULL ) {
128 /* pop off the first message in the list */
129 osrfMessage* tmp_msg = req->result;
130 req->result = req->result->next;
134 time_t start = time(NULL);
135 time_t remaining = (time_t) timeout;
137 while( remaining >= 0 ) {
138 /* tell the session to wait for stuff */
139 osrfLogDebug( OSRF_LOG_MARK, "In app_request receive with remaining time [%d]", (int) remaining );
141 osrf_app_session_queue_wait( req->session, 0, NULL );
142 if(req->session->transport_error) {
143 osrfLogError(OSRF_LOG_MARK, "Transport error in recv()");
147 if( req->result != NULL ) { /* if we received anything */
148 /* pop off the first message in the list */
149 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
150 osrfMessage* ret_msg = req->result;
151 req->result = ret_msg->next;
152 if (ret_msg->sender_locale)
153 osrf_app_session_set_locale(req->session, ret_msg->sender_locale);
161 osrf_app_session_queue_wait( req->session, (int) remaining, NULL );
163 if(req->session->transport_error) {
164 osrfLogError(OSRF_LOG_MARK, "Transport error in recv()");
168 if( req->result != NULL ) { /* if we received anything */
169 /* pop off the first message in the list */
170 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
171 osrfMessage* ret_msg = req->result;
172 req->result = ret_msg->next;
173 if (ret_msg->sender_locale)
174 osrf_app_session_set_locale(req->session, ret_msg->sender_locale);
181 if(req->reset_timeout) {
182 remaining = (time_t) timeout;
183 req->reset_timeout = 0;
184 osrfLogDebug( OSRF_LOG_MARK, "Received a timeout reset");
186 remaining -= (int) (time(NULL) - start);
190 char* paramString = jsonObjectToJSON(req->payload->_params);
191 osrfLogInfo( OSRF_LOG_MARK, "Returning NULL from app_request_recv after timeout: %s %s",
192 req->payload->method_name, paramString);
198 /** Resend this requests original request message */
199 static int _osrf_app_request_resend( osrfAppRequest* req ) {
200 if(req == NULL) return 0;
202 osrfLogDebug( OSRF_LOG_MARK, "Resending request [%d]", req->request_id );
203 return _osrf_app_session_send( req->session, req->payload );
210 // --------------------------------------------------------------------------
211 // --------------------------------------------------------------------------
213 // --------------------------------------------------------------------------
215 /** Install a locale for the session */
216 char* osrf_app_session_set_locale( osrfAppSession* session, const char* locale ) {
217 if (!session || !locale)
220 if(session->session_locale) {
221 if( strlen(session->session_locale) >= strlen(locale) ) {
222 /* There's room available; just copy */
223 strcpy(session->session_locale, locale);
225 free(session->session_locale);
226 session->session_locale = strdup( locale );
229 session->session_locale = strdup( locale );
232 return session->session_locale;
235 /** returns a session from the global session hash */
236 osrfAppSession* osrf_app_session_find_session( const char* session_id ) {
237 if(session_id) return osrfHashGet(osrfAppSessionCache, session_id);
242 /** adds a session to the global session cache */
243 static void _osrf_app_session_push_session( osrfAppSession* session ) {
245 if( osrfAppSessionCache == NULL ) osrfAppSessionCache = osrfNewHash();
246 if( osrfHashGet( osrfAppSessionCache, session->session_id ) ) return;
247 osrfHashSet( osrfAppSessionCache, session, session->session_id );
250 /** Allocates and initializes a new app_session */
252 osrfAppSession* osrfAppSessionClientInit( const char* remote_service ) {
254 if (!remote_service) {
255 osrfLogWarning( OSRF_LOG_MARK, "No remote service specified in osrfAppSessionClientInit");
259 osrfAppSession* session = safe_malloc(sizeof(osrfAppSession));
261 session->transport_handle = osrfSystemGetTransportClient();
262 if( session->transport_handle == NULL ) {
263 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service 'client'");
268 osrfStringArray* arr = osrfNewStringArray(8);
269 osrfConfigGetValueList(NULL, arr, "/domain");
270 char* domain = osrfStringArrayGetString(arr, 0);
273 osrfLogWarning( OSRF_LOG_MARK, "No domains specified in the OpenSRF config file");
275 osrfStringArrayFree(arr);
279 char* router_name = osrfConfigGetValue(NULL, "/router_name");
281 osrfLogWarning( OSRF_LOG_MARK, "No router name specified in the OpenSRF config file");
283 osrfStringArrayFree(arr);
287 char target_buf[512];
288 target_buf[ 0 ] = '\0';
290 int len = snprintf( target_buf, sizeof(target_buf), "%s@%s/%s",
291 router_name ? router_name : "(null)",
292 domain ? domain : "(null)",
293 remote_service ? remote_service : "(null)" );
294 osrfStringArrayFree(arr);
298 if( len >= sizeof( target_buf ) ) {
299 osrfLogWarning( OSRF_LOG_MARK, "Buffer overflow for remote_id");
304 session->request_queue = osrfNewList();
305 session->request_queue->freeItem = &_osrf_app_request_free;
306 session->remote_id = strdup(target_buf);
307 session->orig_remote_id = strdup(session->remote_id);
308 session->remote_service = strdup(remote_service);
309 session->session_locale = NULL;
310 session->transport_error = 0;
312 #ifdef ASSUME_STATELESS
313 session->stateless = 1;
314 osrfLogDebug( OSRF_LOG_MARK, "%s session is stateless", remote_service );
316 session->stateless = 0;
317 osrfLogDebug( OSRF_LOG_MARK, "%s session is NOT stateless", remote_service );
320 /* build a chunky, random session id */
323 snprintf(id, sizeof(id), "%f.%d%ld", get_timestamp_millis(), (int)time(NULL), (long) getpid());
324 session->session_id = strdup(id);
325 osrfLogDebug( OSRF_LOG_MARK, "Building a new client session with id [%s] [%s]",
326 session->remote_service, session->session_id );
328 session->thread_trace = 0;
329 session->state = OSRF_SESSION_DISCONNECTED;
330 session->type = OSRF_SESSION_CLIENT;
331 //session->next = NULL;
333 session->userData = NULL;
334 session->userDataFree = NULL;
336 _osrf_app_session_push_session( session );
340 osrfAppSession* osrf_app_server_session_init(
341 const char* session_id, const char* our_app, const char* remote_id ) {
343 osrfLogDebug( OSRF_LOG_MARK, "Initing server session with session id %s, service %s,"
344 " and remote_id %s", session_id, our_app, remote_id );
346 osrfAppSession* session = osrf_app_session_find_session( session_id );
347 if(session) return session;
349 session = safe_malloc(sizeof(osrfAppSession));
351 session->transport_handle = osrfSystemGetTransportClient();
352 if( session->transport_handle == NULL ) {
353 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service '%s'", our_app );
359 char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
360 if(statel) stateless = atoi(statel);
364 session->request_queue = osrfNewList();
365 session->request_queue->freeItem = &_osrf_app_request_free;
366 session->remote_id = strdup(remote_id);
367 session->orig_remote_id = strdup(remote_id);
368 session->session_id = strdup(session_id);
369 session->remote_service = strdup(our_app);
370 session->stateless = stateless;
372 #ifdef ASSUME_STATELESS
373 session->stateless = 1;
375 session->stateless = 0;
378 session->thread_trace = 0;
379 session->state = OSRF_SESSION_DISCONNECTED;
380 session->type = OSRF_SESSION_SERVER;
381 session->session_locale = NULL;
383 session->userData = NULL;
384 session->userDataFree = NULL;
386 _osrf_app_session_push_session( session );
391 int osrfAppSessionMakeRequest(
392 osrfAppSession* session, const jsonObject* params,
393 const char* method_name, int protocol, osrfStringArray* param_strings ) {
395 return osrfAppSessionMakeLocaleRequest( session, params,
396 method_name, protocol, param_strings, NULL );
399 static int osrfAppSessionMakeLocaleRequest(
400 osrfAppSession* session, const jsonObject* params, const char* method_name,
401 int protocol, osrfStringArray* param_strings, char* locale ) {
403 if(session == NULL) return -1;
407 osrfMessage* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
408 osrf_message_set_method(req_msg, method_name);
411 osrf_message_set_locale(req_msg, locale);
412 } else if (session->session_locale) {
413 osrf_message_set_locale(req_msg, session->session_locale);
417 osrf_message_set_params(req_msg, params);
423 for(i = 0; i!= param_strings->size ; i++ ) {
424 osrf_message_add_param(req_msg,
425 osrfStringArrayGetString(param_strings,i));
430 osrfAppRequest* req = _osrf_app_request_init( session, req_msg );
431 if(_osrf_app_session_send( session, req_msg ) ) {
432 osrfLogWarning( OSRF_LOG_MARK, "Error sending request message [%d]", session->thread_trace );
433 _osrf_app_request_free(req);
437 osrfLogDebug( OSRF_LOG_MARK, "Pushing [%d] onto request queue for session [%s] [%s]",
438 req->request_id, session->remote_service, session->session_id );
439 osrfListSet( session->request_queue, req, req->request_id );
440 return req->request_id;
443 void osrf_app_session_set_complete( osrfAppSession* session, int request_id ) {
447 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
448 if(req) req->complete = 1;
451 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id ) {
454 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
456 return req->complete;
461 /** Resets the remote connection id to that of the original*/
462 void osrf_app_session_reset_remote( osrfAppSession* session ){
466 osrfLogDebug( OSRF_LOG_MARK, "App Session [%s] [%s] resetting remote id to %s",
467 session->remote_service, session->session_id, session->orig_remote_id );
469 osrf_app_session_set_remote( session, session->orig_remote_id );
472 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id ) {
476 if( session->remote_id ) {
477 if( strlen(session->remote_id) >= strlen(remote_id) ) {
478 // There's enough room; just copy it
479 strcpy(session->remote_id, remote_id);
481 free(session->remote_id );
482 session->remote_id = strdup( remote_id );
485 session->remote_id = strdup( remote_id );
488 /** pushes the given message into the result list of the app_request
489 with the given request_id */
490 int osrf_app_session_push_queue(
491 osrfAppSession* session, osrfMessage* msg ){
492 if(session == NULL || msg == NULL) return 0;
494 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, msg->thread_trace );
495 if(req == NULL) return 0;
496 _osrf_app_request_push_queue( req, msg );
501 int osrfAppSessionConnect( osrfAppSession* session ) {
502 return osrf_app_session_connect(session);
506 /** Attempts to connect to the remote service */
507 int osrf_app_session_connect(osrfAppSession* session){
512 if(session->state == OSRF_SESSION_CONNECTED) {
516 int timeout = 5; /* XXX CONFIG VALUE */
518 osrfLogDebug( OSRF_LOG_MARK, "AppSession connecting to %s", session->remote_id );
520 /* defaulting to protocol 1 for now */
521 osrfMessage* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
522 osrf_app_session_reset_remote( session );
523 session->state = OSRF_SESSION_CONNECTING;
524 int ret = _osrf_app_session_send( session, con_msg );
525 osrfMessageFree(con_msg);
528 time_t start = time(NULL);
529 time_t remaining = (time_t) timeout;
531 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
532 osrf_app_session_queue_wait( session, remaining, NULL );
533 if(session->transport_error) {
534 osrfLogError(OSRF_LOG_MARK, "cannot communicate with %s", session->remote_service);
537 remaining -= (int) (time(NULL) - start);
540 if(session->state == OSRF_SESSION_CONNECTED)
541 osrfLogDebug( OSRF_LOG_MARK, " * Connected Successfully to %s", session->remote_service );
543 if(session->state != OSRF_SESSION_CONNECTED)
551 /** Disconnects from the remote service */
552 int osrf_app_session_disconnect( osrfAppSession* session){
556 if(session->state == OSRF_SESSION_DISCONNECTED)
559 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
560 osrfLogDebug( OSRF_LOG_MARK,
561 "Exiting disconnect on stateless session %s",
562 session->session_id);
566 osrfLogDebug(OSRF_LOG_MARK, "AppSession disconnecting from %s", session->remote_id );
568 osrfMessage* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
569 _osrf_app_session_send( session, dis_msg );
570 session->state = OSRF_SESSION_DISCONNECTED;
572 osrfMessageFree( dis_msg );
573 osrf_app_session_reset_remote( session );
577 int osrf_app_session_request_resend( osrfAppSession* session, int req_id ) {
578 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
579 return _osrf_app_request_resend( req );
583 static int osrfAppSessionSendBatch( osrfAppSession* session, osrfMessage* msgs[], int size ) {
585 if( !(session && msgs && size > 0) ) return 0;
588 osrfMessage* msg = msgs[0];
592 osrf_app_session_queue_wait( session, 0, NULL );
594 if(session->state != OSRF_SESSION_CONNECTED) {
596 if(session->stateless) { /* stateless session always send to the root listener */
597 osrf_app_session_reset_remote(session);
601 /* do an auto-connect if necessary */
602 if( ! session->stateless &&
603 (msg->m_type != CONNECT) &&
604 (msg->m_type != DISCONNECT) &&
605 (session->state != OSRF_SESSION_CONNECTED) ) {
607 if(!osrf_app_session_connect( session ))
614 char* string = osrfMessageSerializeBatch(msgs, size);
618 transport_message* t_msg = message_init(
619 string, "", session->session_id, session->remote_id, NULL );
620 message_set_osrf_xid( t_msg, osrfLogGetXid() );
622 retval = client_send_message( session->transport_handle, t_msg );
624 if( retval ) osrfLogError(OSRF_LOG_MARK, "client_send_message failed");
626 osrfLogInfo(OSRF_LOG_MARK, "[%s] sent %d bytes of data to %s",
627 session->remote_service, strlen(string), t_msg->recipient );
629 osrfLogDebug(OSRF_LOG_MARK, "Sent: %s", string );
632 message_free( t_msg );
640 static int _osrf_app_session_send( osrfAppSession* session, osrfMessage* msg ){
641 if( !(session && msg) ) return 0;
644 return osrfAppSessionSendBatch( session, a, 1 );
650 /** Waits up to 'timeout' seconds for some data to arrive.
651 * Any data that arrives will be processed according to its
652 * payload and message type. This method will return after
653 * any data has arrived.
655 int osrf_app_session_queue_wait( osrfAppSession* session, int timeout, int* recvd ){
656 if(session == NULL) return 0;
657 osrfLogDebug(OSRF_LOG_MARK, "AppSession in queue_wait with timeout %d", timeout );
658 return osrf_stack_entry_point(session->transport_handle, timeout, recvd);
661 /** Disconnects (if client) and removes the given session from the global session cache
662 * ! This frees all attached app_requests !
664 void osrfAppSessionFree( osrfAppSession* session ){
665 if(session == NULL) return;
669 osrfLogDebug(OSRF_LOG_MARK, "AppSession [%s] [%s] destroying self and deleting requests",
670 session->remote_service, session->session_id );
671 if(session->type == OSRF_SESSION_CLIENT
672 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
673 osrfMessage* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
674 _osrf_app_session_send( session, dis_msg );
675 osrfMessageFree(dis_msg);
678 /* Remove self from the global session cache */
680 osrfHashRemove( osrfAppSessionCache, session->session_id );
682 /* Free the memory */
684 if( session->userDataFree && session->userData )
685 session->userDataFree(session->userData);
687 if(session->session_locale)
688 free(session->session_locale);
690 free(session->remote_id);
691 free(session->orig_remote_id);
692 free(session->session_id);
693 free(session->remote_service);
694 osrfListFree(session->request_queue);
698 osrfMessage* osrfAppSessionRequestRecv(
699 osrfAppSession* session, int req_id, int timeout ) {
700 if(req_id < 0 || session == NULL)
702 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
703 return _osrf_app_request_recv( req, timeout );
708 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data ) {
709 if(!ses || ! data ) return -1;
711 osrfMessage* msg = osrf_message_init( RESULT, requestId, 1 );
712 osrf_message_set_status_info( msg, NULL, "OK", OSRF_STATUS_OK );
713 char* json = jsonObjectToJSON( data );
715 osrf_message_set_result_content( msg, json );
716 _osrf_app_session_send( ses, msg );
719 osrfMessageFree( msg );
725 int osrfAppRequestRespondComplete(
726 osrfAppSession* ses, int requestId, const jsonObject* data ) {
728 osrfMessage* status = osrf_message_init( STATUS, requestId, 1);
729 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
732 osrfMessage* payload = osrf_message_init( RESULT, requestId, 1 );
733 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
735 char* json = jsonObjectToJSON( data );
736 osrf_message_set_result_content( payload, json );
743 osrfAppSessionSendBatch( ses, ms, 2 );
745 osrfMessageFree( payload );
747 osrfAppSessionSendBatch( ses, &status, 1 );
750 osrfMessageFree( status );
755 int osrfAppSessionStatus( osrfAppSession* ses, int type,
756 const char* name, int reqId, const char* message ) {
759 osrfMessage* msg = osrf_message_init( STATUS, reqId, 1);
760 osrf_message_set_status_info( msg, name, message, type );
761 _osrf_app_session_send( ses, msg );
762 osrfMessageFree( msg );