printf family format fixup found (har har) and suggested by Scott McKellar -- %lf...
[OpenSRF.git] / src / libstack / osrf_app_session.c
1 #include "osrf_app_session.h"
2 #include <time.h>
3
4 /* the global app_session cache */
5 osrfHash* osrfAppSessionCache = NULL;
6
7
8 // --------------------------------------------------------------------------
9 // --------------------------------------------------------------------------
10 // Request API
11 // --------------------------------------------------------------------------
12
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 ) {
16
17         osrf_app_request* req = 
18                 (osrf_app_request*) safe_malloc(sizeof(osrf_app_request));
19
20         req->session            = session;
21         req->request_id = msg->thread_trace;
22         req->complete           = 0;
23         req->payload            = msg;
24         req->result                     = NULL;
25
26         return req;
27
28 }
29
30
31 void osrfAppSessionCleanup() {
32         osrfHashFree(osrfAppSessionCache);      
33 }
34
35
36
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 );
42         free( r );
43 }
44
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) {
50                 req->result = result;
51
52         } else {
53                 
54                 osrf_message* ptr = req->result;
55                 osrf_message* ptr2 = req->result->next;
56                 while( ptr2 ) {
57                         ptr = ptr2;
58                         ptr2 = ptr2->next;
59                 }
60                 ptr->next = result;
61         }
62 }
63
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 ){
67
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 );
72 }
73
74
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;
81 }
82
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.
87   */
88 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
89
90         if(req == NULL) return NULL;
91
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;
96                 return tmp_msg;
97         }
98
99         time_t start = time(NULL);      
100         time_t remaining = (time_t) timeout;
101
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 );
105
106                 osrf_app_session_queue_wait( req->session, 0, NULL );
107
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;
114                         return ret_msg;
115                 }
116
117                 if( req->complete )
118                         return NULL;
119
120                 osrf_app_session_queue_wait( req->session, (int) remaining, NULL );
121
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;
128                         return ret_msg;
129                 }
130                 if( req->complete )
131                         return NULL;
132
133                 if(req->reset_timeout) {
134                         remaining = (time_t) timeout;
135                         req->reset_timeout = 0;
136                         osrfLogDebug( OSRF_LOG_MARK, "Recevied a timeout reset");
137                 } else {
138                         remaining -= (int) (time(NULL) - start);
139                 }
140         }
141
142         osrfLogInfo( OSRF_LOG_MARK, "Returning NULL from app_request_recv after timeout");
143         return NULL;
144 }
145
146 /** Resend this requests original request message */
147 int _osrf_app_request_resend( osrf_app_request* req ) {
148         if(req == NULL) return 0;
149         if(!req->complete) {
150                 osrfLogDebug( OSRF_LOG_MARK,  "Resending request [%d]", req->request_id );
151                 return _osrf_app_session_send( req->session, req->payload );
152         }
153         return 1;
154 }
155
156
157
158 // --------------------------------------------------------------------------
159 // --------------------------------------------------------------------------
160 // Session API
161 // --------------------------------------------------------------------------
162
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);
166         return NULL;
167 }
168
169
170 /** adds a session to the global session cache */
171 void _osrf_app_session_push_session( osrf_app_session* session ) {
172         if(!session) return;
173         if( osrfAppSessionCache == NULL ) osrfAppSessionCache = osrfNewHash();
174         if( osrfHashGet( osrfAppSessionCache, session->session_id ) ) return;
175         osrfHashSet( osrfAppSessionCache, session, session->session_id );
176 }
177
178 /** Allocates a initializes a new app_session */
179
180 osrf_app_session* osrfAppSessionClientInit( char* remote_service ) {
181         return osrf_app_client_session_init( remote_service );
182 }
183
184 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
185
186         osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));      
187
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'");
191                 free( session );
192                 return NULL;
193         }
194
195         char target_buf[512];
196         target_buf[ 0 ] = '\0';
197
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");
202         
203         int len = snprintf( target_buf, 512, "%s@%s/%s",  router_name, domain, remote_service );
204         osrfStringArrayFree(arr);
205         //free(domain);
206         free(router_name);
207
208         if( len >= sizeof( target_buf ) ) {
209                 osrfLogWarning( OSRF_LOG_MARK, "Buffer overflow for remote_id");
210                 free( session );
211                 return NULL;
212         }
213
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);
219
220         #ifdef ASSUME_STATELESS
221         session->stateless = 1;
222         osrfLogDebug( OSRF_LOG_MARK, "%s session is stateless", remote_service );
223         #else
224         session->stateless = 0;
225         osrfLogDebug( OSRF_LOG_MARK, "%s session is NOT stateless", remote_service );
226         #endif
227
228         /* build a chunky, random session id */
229         char id[256];
230         memset(id,0,256);
231
232         sprintf(id, "%f.%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 );
236
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 );
242         return session;
243 }
244
245 osrf_app_session* osrf_app_server_session_init( 
246                 char* session_id, char* our_app, char* remote_id ) {
247
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 );
250
251         osrf_app_session* session = osrf_app_session_find_session( session_id );
252         if(session) return session;
253
254         session = safe_malloc(sizeof(osrf_app_session));        
255
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 );
259                 return NULL;
260         }
261
262         int stateless = 0;
263         char* statel = osrf_settings_host_value("/apps/%s/stateless", our_app );
264         if(statel) stateless = atoi(statel);
265         free(statel);
266
267
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;
275
276         #ifdef ASSUME_STATELESS
277         session->stateless = 1;
278         #endif
279
280         session->thread_trace = 0;
281         session->state = OSRF_SESSION_DISCONNECTED;
282         session->type = OSRF_SESSION_SERVER;
283
284         _osrf_app_session_push_session( session );
285         return session;
286
287 }
288
289
290
291 /** frees memory held by a session */
292 void _osrf_app_session_free( osrf_app_session* session ){
293         if(session==NULL)
294                 return;
295
296         if( session->userDataFree && session->userData ) 
297                 session->userDataFree(session->userData);
298         
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);
304         free(session);
305 }
306
307 int osrfAppSessionMakeRequest(
308                 osrf_app_session* session, jsonObject* params, 
309                 char* method_name, int protocol, string_array* param_strings ) {
310
311         return osrf_app_session_make_req( session, params, 
312                         method_name, protocol, param_strings );
313 }
314
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;
319
320    osrfLogMkXid();
321
322         osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
323         osrf_message_set_method(req_msg, method_name);
324         if(params) {
325                 osrf_message_set_params(req_msg, params);
326
327         } else {
328
329                 if(param_strings) {
330                         int i;
331                         for(i = 0; i!= param_strings->size ; i++ ) {
332                                 osrf_message_add_param(req_msg,
333                                         string_array_get_string(param_strings,i));
334                         }
335                 }
336         }
337
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 );
341                 return -1;
342         }
343
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;
348 }
349
350 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
351         if(session == NULL)
352                 return;
353
354         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
355         if(req) req->complete = 1;
356 }
357
358 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
359         if(session == NULL)
360                 return 0;
361         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, request_id );
362         if(req)
363                 return req->complete;
364         return 0;
365 }
366
367
368 /** Resets the remote connection id to that of the original*/
369 void osrf_app_session_reset_remote( osrf_app_session* session ){
370         if( session==NULL )
371                 return;
372
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 );
376
377         session->remote_id = strdup(session->orig_remote_id);
378 }
379
380 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
381         if(session == NULL)
382                 return;
383         if( session->remote_id )
384                 free(session->remote_id );
385         session->remote_id = strdup( remote_id );
386 }
387
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;
393
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 );
397
398         return 0;
399 }
400
401 int osrfAppSessionConnect( osrf_app_session* session ) { 
402         return osrf_app_session_connect(session);
403 }
404
405
406 /** Attempts to connect to the remote service */
407 int osrf_app_session_connect(osrf_app_session* session){
408         
409         if(session == NULL)
410                 return 0;
411
412         if(session->state == OSRF_SESSION_CONNECTED) {
413                 return 1;
414         }
415
416         int timeout = 5; /* XXX CONFIG VALUE */
417
418         osrfLogDebug( OSRF_LOG_MARK,  "AppSession connecting to %s", session->remote_id );
419
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);
426         if(ret) return 0;
427
428         time_t start = time(NULL);      
429         time_t remaining = (time_t) timeout;
430
431         while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
432                 osrf_app_session_queue_wait( session, remaining, NULL );
433                 remaining -= (int) (time(NULL) - start);
434         }
435
436         if(session->state == OSRF_SESSION_CONNECTED)
437                 osrfLogDebug( OSRF_LOG_MARK, " * Connected Successfully to %s", session->remote_service );
438
439         if(session->state != OSRF_SESSION_CONNECTED)
440                 return 0;
441
442         return 1;
443 }
444
445
446
447 /** Disconnects from the remote service */
448 int osrf_app_session_disconnect( osrf_app_session* session){
449         if(session == NULL)
450                 return 1;
451
452         if(session->state == OSRF_SESSION_DISCONNECTED)
453                 return 1;
454
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);
459                 return 1;
460         }
461
462         osrfLogDebug(OSRF_LOG_MARK,  "AppSession disconnecting from %s", session->remote_id );
463
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;
467
468         osrf_message_free( dis_msg );
469         osrf_app_session_reset_remote( session );
470         return 1;
471 }
472
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 );
476 }
477
478
479 int osrfAppSessionSendBatch( osrfAppSession* session, osrf_message* msgs[], int size ) {
480
481         if( !(session && msgs && size > 0) ) return 0;
482         int retval = 0;
483
484         osrfMessage* msg = msgs[0];
485
486         if(msg) {
487
488                 osrf_app_session_queue_wait( session, 0, NULL );
489
490                 if(session->state != OSRF_SESSION_CONNECTED)  {
491
492                         if(session->stateless) { /* stateless session always send to the root listener */
493                                 osrf_app_session_reset_remote(session);
494
495                         } else { 
496
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) ) {
502
503                                         if(!osrf_app_session_connect( session )) 
504                                                 return 0;
505                                 }
506                         }
507                 }
508         }
509
510         char* string = osrfMessageSerializeBatch(msgs, size);
511
512         if( string ) {
513
514                 transport_message* t_msg = message_init( 
515                                 string, "", session->session_id, session->remote_id, NULL );
516       message_set_osrf_xid( t_msg, osrfLogGetXid() );
517
518                 retval = client_send_message( session->transport_handle, t_msg );
519
520                 if( retval ) osrfLogError(OSRF_LOG_MARK, "client_send_message failed");
521
522                 osrfLogInfo(OSRF_LOG_MARK, "[%s] sent %d bytes of data to %s",
523                         session->remote_service, strlen(string), t_msg->recipient );
524
525                 osrfLogDebug(OSRF_LOG_MARK, "Sent: %s", string );
526
527                 free(string);
528                 message_free( t_msg );
529         }
530
531         return retval; 
532 }
533
534
535
536 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
537         if( !(session && msg) ) return 0;
538         osrfMessage* a[1];
539         a[0] = msg;
540         return osrfAppSessionSendBatch( session, a, 1 );
541 }
542
543
544
545
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.
550   */
551 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout, int* recvd ){
552         if(session == NULL) return 0;
553         int ret_val = 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);
556         return ret_val;
557 }
558
559 /** Disconnects (if client) and removes the given session from the global session cache 
560   * ! This free's all attached app_requests ! 
561   */
562 void osrfAppSessionFree( osrfAppSession* ses ) {
563         osrf_app_session_destroy( ses );
564 }
565
566
567 void osrf_app_session_destroy( osrf_app_session* session ){
568         if(session == NULL) return;
569
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);
577         }
578
579         osrfHashRemove( osrfAppSessionCache, session->session_id );
580         _osrf_app_session_free( session );
581 }
582
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 );
586 }
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)
590                 return NULL;
591         osrf_app_request* req = OSRF_LIST_GET_INDEX( session->request_queue, req_id );
592         return _osrf_app_request_recv( req, timeout );
593 }
594
595
596
597 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
598         if(!ses || ! data ) return -1;
599
600         osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
601         char* json = jsonObjectToJSON( data );
602
603         osrf_message_set_result_content( msg, json );
604         _osrf_app_session_send( ses, msg ); 
605
606         free(json);
607         osrf_message_free( msg );
608
609         return 0;
610 }
611
612
613 int osrfAppRequestRespondComplete( 
614                 osrfAppSession* ses, int requestId, jsonObject* data ) {
615
616         osrf_message* payload = osrf_message_init( RESULT, requestId, 1 );
617         osrf_message_set_status_info( payload, NULL, "OK", OSRF_STATUS_OK );
618
619         osrf_message* status = osrf_message_init( STATUS, requestId, 1);
620         osrf_message_set_status_info( status, "osrfConnectStatus", "Request Complete", OSRF_STATUS_COMPLETE );
621         
622         if (data) {
623                 char* json = jsonObjectToJSON( data );
624                 osrf_message_set_result_content( payload, json );
625                 free(json);
626
627                 osrfMessage* ms[2];
628                 ms[0] = payload;
629                 ms[1] = status;
630
631                 osrfAppSessionSendBatch( ses, ms, 2 );
632
633                 osrf_message_free( payload );
634         } else {
635                 osrfAppSessionSendBatch( ses, &status, 1 );
636         }
637
638         osrf_message_free( status );
639
640         return 0;
641 }
642
643 int osrfAppSessionStatus( osrfAppSession* ses, int type, char* name, int reqId, char* message ) {
644
645         if(ses) {
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 );
650                 return 0;
651         }
652         return -1;
653 }
654
655
656
657
658
659