1 #include <opensrf/osrf_app_session.h>
4 /** Send the given message */
5 static int _osrf_app_session_send( osrfAppSession*, osrf_message* msg );
7 static int osrfAppSessionMakeLocaleRequest(
8 osrfAppSession* session, const jsonObject* params, const char* method_name,
9 int protocol, string_array* param_strings, char* locale );
11 /* the global app_session cache */
12 osrfHash* osrfAppSessionCache = NULL;
14 // --------------------------------------------------------------------------
15 // --------------------------------------------------------------------------
17 // --------------------------------------------------------------------------
19 /** Allocates and initializes a new app_request object */
20 static osrfAppRequest* _osrf_app_request_init(
21 osrfAppSession* session, osrf_message* msg ) {
24 (osrfAppRequest*) safe_malloc(sizeof(osrfAppRequest));
26 req->session = session;
27 req->request_id = msg->thread_trace;
31 req->reset_timeout = 0;
38 void osrfAppSessionCleanup() {
39 osrfHashFree(osrfAppSessionCache);
42 /** Frees memory used by an app_request object */
43 static void _osrf_app_request_free( void * req ){
44 if( req == NULL ) return;
45 osrfAppRequest* r = (osrfAppRequest*) req;
46 if( r->payload ) osrf_message_free( r->payload );
50 /** Pushes the given message onto the list of 'responses' to this request */
51 static void _osrf_app_request_push_queue( osrfAppRequest* req, osrf_message* result ){
52 if(req == NULL || result == NULL) return;
53 osrfLogDebug( OSRF_LOG_MARK, "App Session pushing request [%d] onto request queue", result->thread_trace );
54 if(req->result == NULL) {
59 osrf_message* ptr = req->result;
60 osrf_message* ptr2 = req->result->next;
69 /** Removes this app_request from our session request set */
70 void osrf_app_session_request_finish(
71 osrfAppSession* session, int req_id ){
73 if(session == NULL) return;
74 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
75 if(req == NULL) return;
76 osrfListRemove( req->session->request_queue, req->request_id );
80 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id ) {
81 if(session == NULL) return;
82 osrfLogDebug( OSRF_LOG_MARK, "Resetting request timeout %d", req_id );
83 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
84 if(req == NULL) return;
85 req->reset_timeout = 1;
88 /** Checks the receive queue for messages. If any are found, the first
89 * is popped off and returned. Otherwise, this method will wait at most timeout
90 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
91 * If no messages arrive in the timeout provided, null is returned.
93 static osrf_message* _osrf_app_request_recv( osrfAppRequest* req, int timeout ) {
95 if(req == NULL) return NULL;
97 if( req->result != NULL ) {
98 /* pop off the first message in the list */
99 osrf_message* tmp_msg = req->result;
100 req->result = req->result->next;
104 time_t start = time(NULL);
105 time_t remaining = (time_t) timeout;
107 while( remaining >= 0 ) {
108 /* tell the session to wait for stuff */
109 osrfLogDebug( OSRF_LOG_MARK, "In app_request receive with remaining time [%d]", (int) remaining );
111 osrf_app_session_queue_wait( req->session, 0, NULL );
113 if( req->result != NULL ) { /* if we received anything */
114 /* pop off the first message in the list */
115 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
116 osrf_message* ret_msg = req->result;
117 osrf_message* tmp_msg = ret_msg->next;
118 req->result = tmp_msg;
119 if (ret_msg->sender_locale) {
120 if (req->session->session_locale)
121 free(req->session->session_locale);
122 req->session->session_locale = strdup(ret_msg->sender_locale);
130 osrf_app_session_queue_wait( req->session, (int) remaining, NULL );
132 if( req->result != NULL ) { /* if we received anything */
133 /* pop off the first message in the list */
134 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
135 osrf_message* ret_msg = req->result;
136 osrf_message* tmp_msg = ret_msg->next;
137 req->result = tmp_msg;
138 if (ret_msg->sender_locale) {
139 if (req->session->session_locale)
140 free(req->session->session_locale);
141 req->session->session_locale = strdup(ret_msg->sender_locale);
148 if(req->reset_timeout) {
149 remaining = (time_t) timeout;
150 req->reset_timeout = 0;
151 osrfLogDebug( OSRF_LOG_MARK, "Received a timeout reset");
153 remaining -= (int) (time(NULL) - start);
157 osrfLogInfo( OSRF_LOG_MARK, "Returning NULL from app_request_recv after timeout");
161 /** Resend this requests original request message */
162 static int _osrf_app_request_resend( osrfAppRequest* req ) {
163 if(req == NULL) return 0;
165 osrfLogDebug( OSRF_LOG_MARK, "Resending request [%d]", req->request_id );
166 return _osrf_app_session_send( req->session, req->payload );
173 // --------------------------------------------------------------------------
174 // --------------------------------------------------------------------------
176 // --------------------------------------------------------------------------
178 /** returns a session from the global session hash */
179 char* osrf_app_session_set_locale( osrfAppSession* session, const char* locale ) {
180 if (!session || !locale)
183 if(session->session_locale)
184 free(session->session_locale);
186 session->session_locale = strdup( locale );
187 return session->session_locale;
190 /** returns a session from the global session hash */
191 osrfAppSession* osrf_app_session_find_session( const char* session_id ) {
192 if(session_id) return osrfHashGet(osrfAppSessionCache, session_id);
197 /** adds a session to the global session cache */
198 static void _osrf_app_session_push_session( osrfAppSession* session ) {
200 if( osrfAppSessionCache == NULL ) osrfAppSessionCache = osrfNewHash();
201 if( osrfHashGet( osrfAppSessionCache, session->session_id ) ) return;
202 osrfHashSet( osrfAppSessionCache, session, session->session_id );
205 /** Allocates and initializes a new app_session */
207 osrfAppSession* osrfAppSessionClientInit( const char* remote_service ) {
208 return osrf_app_client_session_init( remote_service );
211 osrfAppSession* osrf_app_client_session_init( const char* remote_service ) {
213 if (!remote_service) {
214 osrfLogWarning( OSRF_LOG_MARK, "No remote service specified in osrf_app_client_session_init");
218 osrfAppSession* session = safe_malloc(sizeof(osrfAppSession));
220 session->transport_handle = osrfSystemGetTransportClient();
221 if( session->transport_handle == NULL ) {
222 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service 'client'");
227 osrfStringArray* arr = osrfNewStringArray(8);
228 osrfConfigGetValueList(NULL, arr, "/domains/domain");
229 char* domain = osrfStringArrayGetString(arr, 0);
232 osrfLogWarning( OSRF_LOG_MARK, "No domains specified in the OpenSRF config file");
234 osrfStringArrayFree(arr);
238 char* router_name = osrfConfigGetValue(NULL, "/router_name");
240 osrfLogWarning( OSRF_LOG_MARK, "No router name specified in the OpenSRF config file");
242 osrfStringArrayFree(arr);
246 char target_buf[512];
247 target_buf[ 0 ] = '\0';
249 int len = snprintf( target_buf, sizeof(target_buf), "%s@%s/%s",
250 router_name ? router_name : "(null)",
251 domain ? domain : "(null)",
252 remote_service ? remote_service : "(null)" );
253 osrfStringArrayFree(arr);
257 if( len >= sizeof( target_buf ) ) {
258 osrfLogWarning( OSRF_LOG_MARK, "Buffer overflow for remote_id");
263 session->request_queue = osrfNewList();
264 session->request_queue->freeItem = &_osrf_app_request_free;
265 session->remote_id = strdup(target_buf);
266 session->orig_remote_id = strdup(session->remote_id);
267 session->remote_service = strdup(remote_service);
268 session->session_locale = NULL;
270 #ifdef ASSUME_STATELESS
271 session->stateless = 1;
272 osrfLogDebug( OSRF_LOG_MARK, "%s session is stateless", remote_service );
274 session->stateless = 0;
275 osrfLogDebug( OSRF_LOG_MARK, "%s session is NOT stateless", remote_service );
278 /* build a chunky, random session id */
281 snprintf(id, sizeof(id), "%f.%d%ld", get_timestamp_millis(), (int)time(NULL), (long) getpid());
282 session->session_id = strdup(id);
283 osrfLogDebug( OSRF_LOG_MARK, "Building a new client session with id [%s] [%s]",
284 session->remote_service, session->session_id );
286 session->thread_trace = 0;
287 session->state = OSRF_SESSION_DISCONNECTED;
288 session->type = OSRF_SESSION_CLIENT;
289 //session->next = NULL;
291 session->userData = NULL;
292 session->userDataFree = NULL;
294 _osrf_app_session_push_session( session );
298 osrfAppSession* osrf_app_server_session_init(
299 const char* session_id, const char* our_app, const char* remote_id ) {
301 osrfLogDebug( OSRF_LOG_MARK, "Initing server session with session id %s, service %s,"
302 " and remote_id %s", session_id, our_app, remote_id );
304 osrfAppSession* session = osrf_app_session_find_session( session_id );
305 if(session) return session;
307 session = safe_malloc(sizeof(osrfAppSession));
309 session->transport_handle = osrfSystemGetTransportClient();
310 if( session->transport_handle == NULL ) {
311 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service '%s'", our_app );
316 char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
317 if(statel) stateless = atoi(statel);
321 session->request_queue = osrfNewList();
322 session->request_queue->freeItem = &_osrf_app_request_free;
323 session->remote_id = strdup(remote_id);
324 session->orig_remote_id = strdup(remote_id);
325 session->session_id = strdup(session_id);
326 session->remote_service = strdup(our_app);
327 session->stateless = stateless;
329 #ifdef ASSUME_STATELESS
330 session->stateless = 1;
332 session->stateless = 0;
335 session->thread_trace = 0;
336 session->state = OSRF_SESSION_DISCONNECTED;
337 session->type = OSRF_SESSION_SERVER;
338 session->session_locale = NULL;
340 session->userData = NULL;
341 session->userDataFree = NULL;
343 _osrf_app_session_push_session( session );
350 /** frees memory held by a session */
351 static void _osrf_app_session_free( osrfAppSession* session ){
355 if( session->userDataFree && session->userData )
356 session->userDataFree(session->userData);
358 if(session->session_locale)
359 free(session->session_locale);
361 free(session->remote_id);
362 free(session->orig_remote_id);
363 free(session->session_id);
364 free(session->remote_service);
365 osrfListFree(session->request_queue);
369 int osrfAppSessionMakeRequest(
370 osrfAppSession* session, const jsonObject* params,
371 const char* method_name, int protocol, string_array* param_strings ) {
373 return osrfAppSessionMakeLocaleRequest( session, params,
374 method_name, protocol, param_strings, NULL );
377 int osrf_app_session_make_req(
378 osrfAppSession* session, const jsonObject* params,
379 const char* method_name, int protocol, string_array* param_strings) {
381 return osrfAppSessionMakeLocaleRequest(session, params,
382 method_name, protocol, param_strings, NULL);
385 static int osrfAppSessionMakeLocaleRequest(
386 osrfAppSession* session, const jsonObject* params, const char* method_name,
387 int protocol, string_array* param_strings, char* locale ) {
389 if(session == NULL) return -1;
393 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
394 osrf_message_set_method(req_msg, method_name);
397 osrf_message_set_locale(req_msg, locale);
398 } else if (session->session_locale) {
399 osrf_message_set_locale(req_msg, session->session_locale);
403 osrf_message_set_params(req_msg, params);
409 for(i = 0; i!= param_strings->size ; i++ ) {
410 osrf_message_add_param(req_msg,
411 string_array_get_string(param_strings,i));
416 osrfAppRequest* req = _osrf_app_request_init( session, req_msg );
417 if(_osrf_app_session_send( session, req_msg ) ) {
418 osrfLogWarning( OSRF_LOG_MARK, "Error sending request message [%d]", session->thread_trace );
422 osrfLogDebug( OSRF_LOG_MARK, "Pushing [%d] onto request queue for session [%s] [%s]",
423 req->request_id, session->remote_service, session->session_id );
424 osrfListSet( session->request_queue, req, req->request_id );
425 return req->request_id;
428 void osrf_app_session_set_complete( osrfAppSession* session, int request_id ) {
432 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
433 if(req) req->complete = 1;
436 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id ) {
439 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
441 return req->complete;
446 /** Resets the remote connection id to that of the original*/
447 void osrf_app_session_reset_remote( osrfAppSession* session ){
451 free(session->remote_id);
452 osrfLogDebug( OSRF_LOG_MARK, "App Session [%s] [%s] resetting remote id to %s",
453 session->remote_service, session->session_id, session->orig_remote_id );
455 session->remote_id = strdup(session->orig_remote_id);
458 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id ) {
461 if( session->remote_id )
462 free(session->remote_id );
463 session->remote_id = strdup( remote_id );
466 /** pushes the given message into the result list of the app_request
467 with the given request_id */
468 int osrf_app_session_push_queue(
469 osrfAppSession* session, osrf_message* msg ){
470 if(session == NULL || msg == NULL) return 0;
472 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, msg->thread_trace );
473 if(req == NULL) return 0;
474 _osrf_app_request_push_queue( req, msg );
479 int osrfAppSessionConnect( osrfAppSession* session ) {
480 return osrf_app_session_connect(session);
484 /** Attempts to connect to the remote service */
485 int osrf_app_session_connect(osrfAppSession* session){
490 if(session->state == OSRF_SESSION_CONNECTED) {
494 int timeout = 5; /* XXX CONFIG VALUE */
496 osrfLogDebug( OSRF_LOG_MARK, "AppSession connecting to %s", session->remote_id );
498 /* defaulting to protocol 1 for now */
499 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
500 osrf_app_session_reset_remote( session );
501 session->state = OSRF_SESSION_CONNECTING;
502 int ret = _osrf_app_session_send( session, con_msg );
503 osrf_message_free(con_msg);
506 time_t start = time(NULL);
507 time_t remaining = (time_t) timeout;
509 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
510 osrf_app_session_queue_wait( session, remaining, NULL );
511 remaining -= (int) (time(NULL) - start);
514 if(session->state == OSRF_SESSION_CONNECTED)
515 osrfLogDebug( OSRF_LOG_MARK, " * Connected Successfully to %s", session->remote_service );
517 if(session->state != OSRF_SESSION_CONNECTED)
525 /** Disconnects from the remote service */
526 int osrf_app_session_disconnect( osrfAppSession* session){
530 if(session->state == OSRF_SESSION_DISCONNECTED)
533 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
534 osrfLogDebug( OSRF_LOG_MARK,
535 "Exiting disconnect on stateless session %s",
536 session->session_id);
540 osrfLogDebug(OSRF_LOG_MARK, "AppSession disconnecting from %s", session->remote_id );
542 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
543 _osrf_app_session_send( session, dis_msg );
544 session->state = OSRF_SESSION_DISCONNECTED;
546 osrf_message_free( dis_msg );
547 osrf_app_session_reset_remote( session );
551 int osrf_app_session_request_resend( osrfAppSession* session, int req_id ) {
552 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
553 return _osrf_app_request_resend( req );
557 static int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
559 if( !(session && msgs && size > 0) ) return 0;
562 osrfMessage* msg = msgs[0];
566 osrf_app_session_queue_wait( session, 0, NULL );
568 if(session->state != OSRF_SESSION_CONNECTED) {
570 if(session->stateless) { /* stateless session always send to the root listener */
571 osrf_app_session_reset_remote(session);
575 /* do an auto-connect if necessary */
576 if( ! session->stateless &&
577 (msg->m_type != CONNECT) &&
578 (msg->m_type != DISCONNECT) &&
579 (session->state != OSRF_SESSION_CONNECTED) ) {
581 if(!osrf_app_session_connect( session ))
588 char* string = osrfMessageSerializeBatch(msgs, size);
592 transport_message* t_msg = message_init(
593 string, "", session->session_id, session->remote_id, NULL );
594 message_set_osrf_xid( t_msg, osrfLogGetXid() );
596 retval = client_send_message( session->transport_handle, t_msg );
598 if( retval ) osrfLogError(OSRF_LOG_MARK, "client_send_message failed");
600 osrfLogInfo(OSRF_LOG_MARK, "[%s] sent %d bytes of data to %s",
601 session->remote_service, strlen(string), t_msg->recipient );
603 osrfLogDebug(OSRF_LOG_MARK, "Sent: %s", string );
606 message_free( t_msg );
614 static int _osrf_app_session_send( osrfAppSession* session, osrf_message* msg ){
615 if( !(session && msg) ) return 0;
618 return osrfAppSessionSendBatch( session, a, 1 );
624 /** Waits up to 'timeout' seconds for some data to arrive.
625 * Any data that arrives will be processed according to its
626 * payload and message type. This method will return after
627 * any data has arrived.
629 int osrf_app_session_queue_wait( osrfAppSession* session, int timeout, int* recvd ){
630 if(session == NULL) return 0;
631 osrfLogDebug(OSRF_LOG_MARK, "AppSession in queue_wait with timeout %d", timeout );
632 return osrf_stack_entry_point(session->transport_handle, timeout, recvd);
635 /** Disconnects (if client) and removes the given session from the global session cache
636 * ! This free's all attached app_requests !
638 void osrfAppSessionFree( osrfAppSession* ses ) {
639 osrf_app_session_destroy( ses );
643 void osrf_app_session_destroy( osrfAppSession* session ){
644 if(session == NULL) return;
646 osrfLogDebug(OSRF_LOG_MARK, "AppSession [%s] [%s] destroying self and deleting requests",
647 session->remote_service, session->session_id );
648 if(session->type == OSRF_SESSION_CLIENT
649 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
650 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
651 _osrf_app_session_send( session, dis_msg );
652 osrf_message_free(dis_msg);
655 osrfHashRemove( osrfAppSessionCache, session->session_id );
656 _osrf_app_session_free( session );
659 osrf_message* osrfAppSessionRequestRecv(
660 osrfAppSession* session, int req_id, int timeout ) {
661 return osrf_app_session_request_recv( session, req_id, timeout );
663 osrf_message* osrf_app_session_request_recv(
664 osrfAppSession* session, int req_id, int timeout ) {
665 if(req_id < 0 || session == NULL)
667 osrfAppRequest* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
668 return _osrf_app_request_recv( req, timeout );
673 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data ) {
674 if(!ses || ! data ) return -1;
676 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
677 osrf_message_set_status_info( msg, NULL, "OK", OSRF_STATUS_OK );
678 char* json = jsonObjectToJSON( data );
680 osrf_message_set_result_content( msg, json );
681 _osrf_app_session_send( ses, msg );
684 osrf_message_free( msg );
690 int osrfAppRequestRespondComplete(
691 osrfAppSession* ses, int requestId, const jsonObject* data ) {
693 osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
694 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
696 osrf_message* status = osrf_message_init( STATUS, requestId, 1);
697 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
700 char* json = jsonObjectToJSON( data );
701 osrf_message_set_result_content( payload, json );
708 osrfAppSessionSendBatch( ses, ms, 2 );
710 osrf_message_free( payload );
712 osrfAppSessionSendBatch( ses, &status, 1 );
715 osrf_message_free( status );
720 int osrfAppSessionStatus( osrfAppSession* ses, int type,
721 const char* name, int reqId, const char* message ) {
724 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
725 osrf_message_set_status_info( msg, name, message, type );
726 _osrf_app_session_send( ses, msg );
727 osrf_message_free( msg );