1 #include "osrf_app_session.h"
4 /* the global app_session cache */
5 osrfHash* osrfAppSessionCache = NULL;
8 // --------------------------------------------------------------------------
9 // --------------------------------------------------------------------------
11 // --------------------------------------------------------------------------
13 /** Allocation and initializes a new app_request object */
14 osrf_app_request* _osrf_app_request_init(
15 osrf_app_session* session, osrf_message* msg ) {
17 osrf_app_request* req =
18 (osrf_app_request*) safe_malloc(sizeof(osrf_app_request));
20 req->session = session;
21 req->request_id = msg->thread_trace;
31 void osrfAppSessionCleanup() {
32 osrfHashFree(osrfAppSessionCache);
37 /** Frees memory used by an app_request object */
38 void _osrf_app_request_free( void * req ){
39 if( req == NULL ) return;
40 osrfAppRequest* r = (osrfAppRequest*) req;
41 if( r->payload ) osrf_message_free( r->payload );
45 /** Pushes the given message onto the list of 'responses' to this request */
46 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
47 if(req == NULL || result == NULL) return;
48 osrfLogDebug( OSRF_LOG_MARK, "App Session pushing request [%d] onto request queue", result->thread_trace );
49 if(req->result == NULL) {
54 osrf_message* ptr = req->result;
55 osrf_message* ptr2 = req->result->next;
64 /** Removes this app_request from our session request set */
65 void osrf_app_session_request_finish(
66 osrf_app_session* session, int req_id ){
68 if(session == NULL) return;
69 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
70 if(req == NULL) return;
71 osrfListRemove( req->session->request_queue, req->request_id );
75 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id ) {
76 if(session == NULL) return;
77 osrfLogDebug( OSRF_LOG_MARK, "Resetting request timeout %d", req_id );
78 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
79 if(req == NULL) return;
80 req->reset_timeout = 1;
83 /** Checks the receive queue for messages. If any are found, the first
84 * is popped off and returned. Otherwise, this method will wait at most timeout
85 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
86 * If no messages arrive in the timeout provided, null is returned.
88 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
90 if(req == NULL) return NULL;
92 if( req->result != NULL ) {
93 /* pop off the first message in the list */
94 osrf_message* tmp_msg = req->result;
95 req->result = req->result->next;
99 time_t start = time(NULL);
100 time_t remaining = (time_t) timeout;
102 while( remaining >= 0 ) {
103 /* tell the session to wait for stuff */
104 osrfLogDebug( OSRF_LOG_MARK, "In app_request receive with remaining time [%d]", (int) remaining );
106 osrf_app_session_queue_wait( req->session, 0, NULL );
108 if( req->result != NULL ) { /* if we received anything */
109 /* pop off the first message in the list */
110 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
111 osrf_message* ret_msg = req->result;
112 osrf_message* tmp_msg = ret_msg->next;
113 req->result = tmp_msg;
120 osrf_app_session_queue_wait( req->session, (int) remaining, NULL );
122 if( req->result != NULL ) { /* if we received anything */
123 /* pop off the first message in the list */
124 osrfLogDebug( OSRF_LOG_MARK, "app_request_recv received a message, returning it");
125 osrf_message* ret_msg = req->result;
126 osrf_message* tmp_msg = ret_msg->next;
127 req->result = tmp_msg;
133 if(req->reset_timeout) {
134 remaining = (time_t) timeout;
135 req->reset_timeout = 0;
136 osrfLogDebug( OSRF_LOG_MARK, "Recevied a timeout reset");
138 remaining -= (int) (time(NULL) - start);
142 osrfLogInfo( OSRF_LOG_MARK, "Returning NULL from app_request_recv after timeout");
146 /** Resend this requests original request message */
147 int _osrf_app_request_resend( osrf_app_request* req ) {
148 if(req == NULL) return 0;
150 osrfLogDebug( OSRF_LOG_MARK, "Resending request [%d]", req->request_id );
151 return _osrf_app_session_send( req->session, req->payload );
158 // --------------------------------------------------------------------------
159 // --------------------------------------------------------------------------
161 // --------------------------------------------------------------------------
163 /** returns a session from the global session hash */
164 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
165 if(session_id) return osrfHashGet(osrfAppSessionCache, session_id);
170 /** adds a session to the global session cache */
171 void _osrf_app_session_push_session( osrf_app_session* session ) {
173 if( osrfAppSessionCache == NULL ) osrfAppSessionCache = osrfNewHash();
174 if( osrfHashGet( osrfAppSessionCache, session->session_id ) ) return;
175 osrfHashSet( osrfAppSessionCache, session, session->session_id );
178 /** Allocates a initializes a new app_session */
180 osrf_app_session* osrfAppSessionClientInit( char* remote_service ) {
181 return osrf_app_client_session_init( remote_service );
184 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
186 osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));
188 session->transport_handle = osrf_system_get_transport_client();
189 if( session->transport_handle == NULL ) {
190 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service 'client'");
195 char target_buf[512];
196 target_buf[ 0 ] = '\0';
198 osrfStringArray* arr = osrfNewStringArray(8);
199 osrfConfigGetValueList(NULL, arr, "/domains/domain");
200 char* domain = osrfStringArrayGetString(arr, 0);
201 char* router_name = osrfConfigGetValue(NULL, "/router_name");
203 int len = snprintf( target_buf, 512, "%s@%s/%s", router_name, domain, remote_service );
204 osrfStringArrayFree(arr);
208 if( len >= sizeof( target_buf ) ) {
209 osrfLogWarning( OSRF_LOG_MARK, "Buffer overflow for remote_id");
214 session->request_queue = osrfNewList();
215 session->request_queue->freeItem = &_osrf_app_request_free;
216 session->remote_id = strdup(target_buf);
217 session->orig_remote_id = strdup(session->remote_id);
218 session->remote_service = strdup(remote_service);
220 #ifdef ASSUME_STATELESS
221 session->stateless = 1;
222 osrfLogDebug( OSRF_LOG_MARK, "%s session is stateless", remote_service );
224 session->stateless = 0;
225 osrfLogDebug( OSRF_LOG_MARK, "%s session is NOT stateless", remote_service );
228 /* build a chunky, random session id */
232 sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
233 session->session_id = strdup(id);
234 osrfLogDebug( OSRF_LOG_MARK, "Building a new client session with id [%s] [%s]",
235 session->remote_service, 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_id ) {
248 osrfLogDebug( OSRF_LOG_MARK, "Initing server session with session id %s, service %s,"
249 " and remote_id %s", session_id, our_app, remote_id );
251 osrf_app_session* session = osrf_app_session_find_session( session_id );
252 if(session) return session;
254 session = safe_malloc(sizeof(osrf_app_session));
256 session->transport_handle = osrf_system_get_transport_client();
257 if( session->transport_handle == NULL ) {
258 osrfLogWarning( OSRF_LOG_MARK, "No transport client for service '%s'", our_app );
263 char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
264 if(statel) stateless = atoi(statel);
268 session->request_queue = osrfNewList();
269 session->request_queue->freeItem = &_osrf_app_request_free;
270 session->remote_id = strdup(remote_id);
271 session->orig_remote_id = strdup(remote_id);
272 session->session_id = strdup(session_id);
273 session->remote_service = strdup(our_app);
274 session->stateless = stateless;
276 #ifdef ASSUME_STATELESS
277 session->stateless = 1;
280 session->thread_trace = 0;
281 session->state = OSRF_SESSION_DISCONNECTED;
282 session->type = OSRF_SESSION_SERVER;
284 _osrf_app_session_push_session( session );
291 /** frees memory held by a session */
292 void _osrf_app_session_free( osrf_app_session* session ){
296 if( session->userDataFree && session->userData )
297 session->userDataFree(session->userData);
299 free(session->remote_id);
300 free(session->orig_remote_id);
301 free(session->session_id);
302 free(session->remote_service);
303 osrfListFree(session->request_queue);
307 int osrfAppSessionMakeRequest(
308 osrf_app_session* session, jsonObject* params,
309 char* method_name, int protocol, string_array* param_strings ) {
311 return osrf_app_session_make_req( session, params,
312 method_name, protocol, param_strings );
315 int osrf_app_session_make_req(
316 osrf_app_session* session, jsonObject* params,
317 char* method_name, int protocol, string_array* param_strings ) {
318 if(session == NULL) return -1;
322 osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
323 osrf_message_set_method(req_msg, method_name);
325 osrf_message_set_params(req_msg, params);
331 for(i = 0; i!= param_strings->size ; i++ ) {
332 osrf_message_add_param(req_msg,
333 string_array_get_string(param_strings,i));
338 osrf_app_request* req = _osrf_app_request_init( session, req_msg );
339 if(_osrf_app_session_send( session, req_msg ) ) {
340 osrfLogWarning( OSRF_LOG_MARK, "Error sending request message [%d]", session->thread_trace );
344 osrfLogDebug( OSRF_LOG_MARK, "Pushing [%d] onto requeust queue for session [%s] [%s]",
345 req->request_id, session->remote_service, session->session_id );
346 osrfListSet( session->request_queue, req, req->request_id );
347 return req->request_id;
350 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
354 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
355 if(req) req->complete = 1;
358 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
361 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
363 return req->complete;
368 /** Resets the remote connection id to that of the original*/
369 void osrf_app_session_reset_remote( osrf_app_session* session ){
373 free(session->remote_id);
374 osrfLogDebug( OSRF_LOG_MARK, "App Session [%s] [%s] resetting remote id to %s",
375 session->remote_service, session->session_id, session->orig_remote_id );
377 session->remote_id = strdup(session->orig_remote_id);
380 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
383 if( session->remote_id )
384 free(session->remote_id );
385 session->remote_id = strdup( remote_id );
388 /** pushes the given message into the result list of the app_request
389 with the given request_id */
390 int osrf_app_session_push_queue(
391 osrf_app_session* session, osrf_message* msg ){
392 if(session == NULL || msg == NULL) return 0;
394 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, msg->thread_trace );
395 if(req == NULL) return 0;
396 _osrf_app_request_push_queue( req, msg );
401 int osrfAppSessionConnect( osrf_app_session* session ) {
402 return osrf_app_session_connect(session);
406 /** Attempts to connect to the remote service */
407 int osrf_app_session_connect(osrf_app_session* session){
412 if(session->state == OSRF_SESSION_CONNECTED) {
416 int timeout = 5; /* XXX CONFIG VALUE */
418 osrfLogDebug( OSRF_LOG_MARK, "AppSession connecting to %s", session->remote_id );
420 /* defaulting to protocol 1 for now */
421 osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
422 osrf_app_session_reset_remote( session );
423 session->state = OSRF_SESSION_CONNECTING;
424 int ret = _osrf_app_session_send( session, con_msg );
425 osrf_message_free(con_msg);
428 time_t start = time(NULL);
429 time_t remaining = (time_t) timeout;
431 while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
432 osrf_app_session_queue_wait( session, remaining, NULL );
433 remaining -= (int) (time(NULL) - start);
436 if(session->state == OSRF_SESSION_CONNECTED)
437 osrfLogDebug( OSRF_LOG_MARK, " * Connected Successfully to %s", session->remote_service );
439 if(session->state != OSRF_SESSION_CONNECTED)
447 /** Disconnects from the remote service */
448 int osrf_app_session_disconnect( osrf_app_session* session){
452 if(session->state == OSRF_SESSION_DISCONNECTED)
455 if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
456 osrfLogDebug( OSRF_LOG_MARK,
457 "Exiting disconnect on stateless session %s",
458 session->session_id);
462 osrfLogDebug(OSRF_LOG_MARK, "AppSession disconnecting from %s", session->remote_id );
464 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
465 _osrf_app_session_send( session, dis_msg );
466 session->state = OSRF_SESSION_DISCONNECTED;
468 osrf_message_free( dis_msg );
469 osrf_app_session_reset_remote( session );
473 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
474 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
475 return _osrf_app_request_resend( req );
479 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
481 if( !(session && msgs && size > 0) ) return 0;
484 osrfMessage* msg = msgs[0];
488 osrf_app_session_queue_wait( session, 0, NULL );
490 if(session->state != OSRF_SESSION_CONNECTED) {
492 if(session->stateless) { /* stateless session always send to the root listener */
493 osrf_app_session_reset_remote(session);
497 /* do an auto-connect if necessary */
498 if( ! session->stateless &&
499 (msg->m_type != CONNECT) &&
500 (msg->m_type != DISCONNECT) &&
501 (session->state != OSRF_SESSION_CONNECTED) ) {
503 if(!osrf_app_session_connect( session ))
510 char* string = osrfMessageSerializeBatch(msgs, size);
514 transport_message* t_msg = message_init(
515 string, "", session->session_id, session->remote_id, NULL );
516 message_set_osrf_xid( t_msg, osrfLogGetXid() );
518 retval = client_send_message( session->transport_handle, t_msg );
520 if( retval ) osrfLogError(OSRF_LOG_MARK, "client_send_message failed");
522 osrfLogInfo(OSRF_LOG_MARK, "[%s] sent %d bytes of data to %s",
523 session->remote_service, strlen(string), t_msg->recipient );
525 osrfLogDebug(OSRF_LOG_MARK, "Sent: %s", string );
528 message_free( t_msg );
536 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
537 if( !(session && msg) ) return 0;
540 return osrfAppSessionSendBatch( session, a, 1 );
546 /** Waits up to 'timeout' seconds for some data to arrive.
547 * Any data that arrives will be processed according to its
548 * payload and message type. This method will return after
549 * any data has arrived.
551 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout, int* recvd ){
552 if(session == NULL) return 0;
554 osrfLogDebug(OSRF_LOG_MARK, "AppSession in queue_wait with timeout %d", timeout );
555 ret_val = osrf_stack_entry_point(session->transport_handle, timeout, recvd);
559 /** Disconnects (if client) and removes the given session from the global session cache
560 * ! This free's all attached app_requests !
562 void osrfAppSessionFree( osrfAppSession* ses ) {
563 osrf_app_session_destroy( ses );
567 void osrf_app_session_destroy( osrf_app_session* session ){
568 if(session == NULL) return;
570 osrfLogDebug(OSRF_LOG_MARK, "AppSession [%s] [%s] destroying self and deleting requests",
571 session->remote_service, session->session_id );
572 if(session->type == OSRF_SESSION_CLIENT
573 && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
574 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
575 _osrf_app_session_send( session, dis_msg );
576 osrf_message_free(dis_msg);
579 osrfHashRemove( osrfAppSessionCache, session->session_id );
580 _osrf_app_session_free( session );
583 osrf_message* osrfAppSessionRequestRecv(
584 osrf_app_session* session, int req_id, int timeout ) {
585 return osrf_app_session_request_recv( session, req_id, timeout );
587 osrf_message* osrf_app_session_request_recv(
588 osrf_app_session* session, int req_id, int timeout ) {
589 if(req_id < 0 || session == NULL)
591 osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
592 return _osrf_app_request_recv( req, timeout );
597 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
598 if(!ses || ! data ) return -1;
600 osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
601 char* json = jsonObjectToJSON( data );
603 osrf_message_set_result_content( msg, json );
604 _osrf_app_session_send( ses, msg );
607 osrf_message_free( msg );
613 int osrfAppRequestRespondComplete(
614 osrfAppSession* ses, int requestId, jsonObject* data ) {
616 osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
617 osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
619 osrf_message* status = osrf_message_init( STATUS, requestId, 1);
620 osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
623 char* json = jsonObjectToJSON( data );
624 osrf_message_set_result_content( payload, json );
631 osrfAppSessionSendBatch( ses, ms, 2 );
633 osrf_message_free( payload );
635 osrfAppSessionSendBatch( ses, &status, 1 );
638 osrf_message_free( status );
643 int osrfAppSessionStatus( osrfAppSession* ses, int type, char* name, int reqId, char* message ) {
646 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
647 osrf_message_set_status_info( msg, name, message, type );
648 _osrf_app_session_send( ses, msg );
649 osrf_message_free( msg );