]> git.evergreen-ils.org Git - OpenSRF.git/blob - src/libstack/osrf_app_session.c
35036ce6c404e0a2b03dc76a2c9c85d65d5cd773
[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 osrf_app_session* app_session_cache;
6
7
8
9 // --------------------------------------------------------------------------
10 // --------------------------------------------------------------------------
11 // Request API
12 // --------------------------------------------------------------------------
13
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 ) {
17
18         osrf_app_request* req = 
19                 (osrf_app_request*) safe_malloc(sizeof(osrf_app_request));
20
21         req->session            = session;
22         req->request_id = msg->thread_trace;
23         req->complete           = 0;
24         req->payload            = msg;
25         req->result                     = NULL;
26
27         return req;
28
29 }
30
31 /** Frees memory used by an app_request object */
32 void _osrf_app_request_free( osrf_app_request * req ){
33         if( req == NULL ) return;
34
35         if( req->payload ) {
36                 osrf_message_free( req->payload );
37         }
38
39         /*
40         osrf_message* cur_msg = req->result;
41         while( cur_msg != NULL ) {
42                 osrf_message* next_msg = cur_msg->next;
43                 osrf_message_free( cur_msg );
44                 cur_msg = next_msg;
45         }
46         osrf_message_free( req->payload );
47         */
48
49         free( req );
50         debug_handler("after request free");
51 }
52
53 /** Pushes the given message onto the list of 'responses' to this request */
54 void _osrf_app_request_push_queue( osrf_app_request* req, osrf_message* result ){
55         if(req == NULL || result == NULL) return;
56         debug_handler( "App Session pushing [%d] onto request queue", result->thread_trace );
57         if(req->result == NULL)
58                 req->result = result;
59         else {
60                 result->next = req->result;
61                 req->result = result;
62         }
63 }
64
65 /** Removes this app_request from our session request set */
66 void osrf_app_session_request_finish( 
67                 osrf_app_session* session, int req_id ){
68
69         if(session == NULL) return;
70         debug_handler("Finishing request %d", req_id );
71         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
72         if(req == NULL) return;
73         _osrf_app_session_remove_request( req->session, req );
74         _osrf_app_request_free( req );
75 }
76
77
78 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id ) {
79         if(session == NULL) return;
80         debug_handler("Resetting timeout %d", req_id );
81         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
82         if(req == NULL) return;
83         req->reset_timeout = 1;
84 }
85
86 /** Checks the receive queue for messages.  If any are found, the first
87   * is popped off and returned.  Otherwise, this method will wait at most timeout 
88   * seconds for a message to appear in the receive queue.  Once it arrives it is returned.
89   * If no messages arrive in the timeout provided, null is returned.
90   */
91 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout ) {
92
93         if(req == NULL) return NULL;
94
95         if( req->result != NULL ) {
96                 debug_handler("app_request receive already has a message, returning it");
97                 /* pop off the first message in the list */
98                 osrf_message* tmp_msg = req->result;
99                 req->result = req->result->next;
100                 return tmp_msg;
101         }
102
103         time_t start = time(NULL);      
104         time_t remaining = (time_t) timeout;
105
106         while( remaining >= 0 ) {
107                 /* tell the session to wait for stuff */
108                 debug_handler( "In app_request receive with remaining time [%d]", (int) remaining );
109
110                 osrf_app_session_queue_wait( req->session, 0 );
111
112                 if( req->result != NULL ) { /* if we received anything */
113                         /* pop off the first message in the list */
114                         debug_handler( "app_request_recv received a message, returning it");
115                         osrf_message* ret_msg = req->result;
116                         osrf_message* tmp_msg = ret_msg->next;
117                         req->result = tmp_msg;
118                         return ret_msg;
119                 }
120
121                 if( req->complete )
122                         return NULL;
123
124                 osrf_app_session_queue_wait( req->session, (int) remaining );
125
126                 if( req->result != NULL ) { /* if we received anything */
127                         /* pop off the first message in the list */
128                         debug_handler( "app_request_recv received a message, returning it");
129                         osrf_message* ret_msg = req->result;
130                         osrf_message* tmp_msg = ret_msg->next;
131                         req->result = tmp_msg;
132                         return ret_msg;
133                 }
134                 if( req->complete )
135                         return NULL;
136
137                 if(req->reset_timeout) {
138                         remaining = (time_t) timeout;
139                         req->reset_timeout = 0;
140                         debug_handler("Recevied a timeout reset");
141                 } else {
142                         remaining -= (int) (time(NULL) - start);
143                 }
144         }
145
146         debug_handler("Returning NULL from app_request_recv after timeout");
147         return NULL;
148 }
149
150 /** Resend this requests original request message */
151 int _osrf_app_request_resend( osrf_app_request* req ) {
152         if(req == NULL) return 0;
153         if(!req->complete) {
154                 debug_handler( "Resending request [%d]", req->request_id );
155                 return _osrf_app_session_send( req->session, req->payload );
156         }
157         return 1;
158 }
159
160
161
162 // --------------------------------------------------------------------------
163 // --------------------------------------------------------------------------
164 // Session API
165 // --------------------------------------------------------------------------
166
167 /** returns a session from the global session hash */
168 osrf_app_session* osrf_app_session_find_session( char* session_id ) {
169         osrf_app_session* ptr = app_session_cache;
170         debug_handler("Searching for session in global cache with id [%s]", session_id );
171         while( ptr != NULL ) {
172                 if( !strcmp(ptr->session_id,session_id) )
173                         return ptr;
174                 ptr = ptr->next;
175         }
176         return NULL;
177 }
178
179
180 /** adds a session to the global session cache */
181 void _osrf_app_session_push_session( osrf_app_session* session ) {
182
183         if( app_session_cache == NULL ) {
184                 app_session_cache = session;
185                 return;
186         }
187
188         osrf_app_session* ptr = app_session_cache;
189         debug_handler( "Pushing [%s] [%s] onto global session cache", 
190                         session->remote_service, session->session_id );
191         while( ptr != NULL ) {
192                 if( !strcmp(ptr->session_id, session->session_id) )
193                         return;
194                 if( ptr->next == NULL ) {
195                         ptr->next = session;
196                         return;
197                 }
198                 ptr = ptr->next;
199         }
200 }
201
202
203 /** unlinks from global session cache */
204 void _osrf_app_session_remove_session( char* session_id ) {
205
206         if( app_session_cache == NULL )
207                 return;
208
209         debug_handler( "App Session removing session [%s] from global cache", session_id );
210         if( !strcmp(app_session_cache->session_id, session_id) ) {
211                 if( app_session_cache->next != NULL ) {
212                         osrf_app_session* next = app_session_cache->next;
213                         app_session_cache = next;
214                         return;
215                 } else {
216                         app_session_cache = NULL;
217                         return;
218                 }
219         }
220
221         if( app_session_cache->next == NULL )
222                 return;
223
224         osrf_app_session* prev = app_session_cache;
225         osrf_app_session* ptr = prev->next;
226         while( ptr != NULL ) {
227                 if( ptr->session_id == session_id ) {
228                         osrf_app_session* tmp = ptr->next;
229                         prev->next = tmp;
230                         return;
231                 }
232                 ptr = ptr->next;
233         }
234 }
235
236 /** Allocates a initializes a new app_session */
237
238 osrf_app_session* osrfAppSessionClientInit( char* remote_service ) {
239         return osrf_app_client_session_init( remote_service );
240 }
241
242 osrf_app_session* osrf_app_client_session_init( char* remote_service ) {
243
244         osrf_app_session* session = safe_malloc(sizeof(osrf_app_session));      
245
246         session->transport_handle = osrf_system_get_transport_client();
247         if( session->transport_handle == NULL ) {
248                 warning_handler("No transport client for service 'client'");
249                 return NULL;
250         }
251
252         char target_buf[512];
253         memset(target_buf,0,512);
254         //char* domain  = config_value( "opensrf.bootstrap", "//%s/domains/domain1", osrf_get_config_context() ); /* just the first for now */
255         //char* router_name = config_value( "opensrf.bootstrap", "//%s/router_name", osrf_get_config_context() );
256
257         osrfStringArray* arr = osrfNewStringArray(8);
258         osrfConfigGetValueList(NULL, arr, "/domains/domain");
259         char* domain = osrfStringArrayGetString(arr, 0);
260         char* router_name = osrfConfigGetValue(NULL, "/router_name");
261         osrfStringArrayFree(arr);
262         
263         sprintf( target_buf, "%s@%s/%s",  router_name, domain, remote_service );
264         //free(domain);
265         free(router_name);
266
267         session->request_queue = NULL;
268         session->remote_id = strdup(target_buf);
269         session->orig_remote_id = strdup(session->remote_id);
270         session->remote_service = strdup(remote_service);
271
272         #ifdef ASSUME_STATELESS
273         session->stateless = 1;
274         debug_handler("session is stateless");
275         #else
276         session->stateless = 0;
277         debug_handler("session is NOT stateless");
278         #endif
279
280         /* build a chunky, random session id */
281         char id[256];
282         memset(id,0,256);
283
284         sprintf(id, "%lf.%d%d", get_timestamp_millis(), (int)time(NULL), getpid());
285         session->session_id = strdup(id);
286         debug_handler( "Building a new client session with id [%s] [%s]", 
287                         session->remote_service, session->session_id );
288
289         session->thread_trace = 0;
290         session->state = OSRF_SESSION_DISCONNECTED;
291         session->type = OSRF_SESSION_CLIENT;
292         session->next = NULL;
293         _osrf_app_session_push_session( session );
294         return session;
295 }
296
297 osrf_app_session* osrf_app_server_session_init( 
298                 char* session_id, char* our_app, char* remote_id ) {
299
300         info_handler("Initing server session with session id %s, service %s,"
301                         " and remote_id %s", session_id, our_app, remote_id );
302
303         osrf_app_session* session = osrf_app_session_find_session( session_id );
304         if(session) return session;
305
306         session = safe_malloc(sizeof(osrf_app_session));        
307
308         session->transport_handle = osrf_system_get_transport_client();
309         if( session->transport_handle == NULL ) {
310                 warning_handler("No transport client for service '%s'", our_app );
311                 return NULL;
312         }
313
314         session->request_queue = NULL;
315         session->remote_id = strdup(remote_id);
316         session->orig_remote_id = strdup(remote_id);
317         session->session_id = strdup(session_id);
318         session->remote_service = strdup(our_app);
319
320         #ifdef ASSUME_STATELESS
321         session->stateless = 1;
322         #else
323         session->stateless = 0;
324         #endif
325
326         session->thread_trace = 0;
327         session->state = OSRF_SESSION_DISCONNECTED;
328         session->type = OSRF_SESSION_SERVER;
329         session->next = NULL;
330
331         _osrf_app_session_push_session( session );
332         return session;
333
334 }
335
336
337
338 /** frees memory held by a session */
339 void _osrf_app_session_free( osrf_app_session* session ){
340         if(session==NULL)
341                 return;
342         
343         free(session->remote_id);
344         free(session->orig_remote_id);
345         free(session->session_id);
346         free(session->remote_service);
347         free(session);
348 }
349
350 int osrfAppSessionMakeRequest(
351                 osrf_app_session* session, jsonObject* params, 
352                 char* method_name, int protocol, string_array* param_strings ) {
353
354         return osrf_app_session_make_req( session, params, 
355                         method_name, protocol, param_strings );
356 }
357
358 int osrf_app_session_make_req( 
359                 osrf_app_session* session, jsonObject* params, 
360                 char* method_name, int protocol, string_array* param_strings ) {
361         if(session == NULL) return -1;
362
363         osrf_message* req_msg = osrf_message_init( REQUEST, ++(session->thread_trace), protocol );
364         osrf_message_set_method(req_msg, method_name);
365         if(params) {
366                 osrf_message_set_params(req_msg, params);
367
368         } else {
369
370                 if(param_strings) {
371                         int i;
372                         for(i = 0; i!= param_strings->size ; i++ ) {
373                                 osrf_message_add_param(req_msg,
374                                         string_array_get_string(param_strings,i));
375                         }
376                 }
377         }
378
379         osrf_app_request* req = _osrf_app_request_init( session, req_msg );
380         if(!_osrf_app_session_send( session, req_msg ) ) {
381                 warning_handler( "Error sending request message [%d]", session->thread_trace );
382                 return -1;
383         }
384
385         _osrf_app_session_push_request( session, req );
386         return req->request_id;
387 }
388
389
390
391 /** Adds an app_request to the request set */
392 void _osrf_app_session_push_request( osrf_app_session* session, osrf_app_request* req ){
393         if(session == NULL || req == NULL)
394                 return;
395
396         debug_handler( "Pushing [%d] onto requeust queue for session [%s] [%s]",
397                         req->request_id, session->remote_service, session->session_id );
398
399         if(session->request_queue == NULL) 
400                 session->request_queue = req;
401         else {
402                 osrf_app_request* req2 = session->request_queue->next;
403                 session->request_queue = req;
404                 req->next = req2;
405         }
406 }
407
408
409
410 /** Removes an app_request from this session request set */
411 void _osrf_app_session_remove_request( osrf_app_session* session, osrf_app_request* req ){
412         if(session == NULL || req == NULL)
413                 return;
414
415         if(session->request_queue == NULL)
416                 return;
417
418         debug_handler("Removing request [%d] from session [%s] [%s]",
419                         req->request_id, session->remote_service, session->session_id );
420
421         osrf_app_request* first = session->request_queue;
422         if(first->request_id == req->request_id) {
423                 session->request_queue = first->next;
424                 return;
425                 /*
426                 if(first->next == NULL) { 
427                         session->request_queue = NULL;
428                 } else {
429                         osrf_app_request* tmp = first->next;
430                         session->request_queue = tmp;
431                 }
432                 */
433         }
434
435         osrf_app_request* lead = first->next;
436
437         while( lead != NULL ) {
438                 if(lead->request_id == req->request_id) {
439                         first->next = lead->next;
440                         return;
441                 }
442                 first = lead;
443                 lead = lead->next;
444         }
445 }
446
447
448 void osrf_app_session_set_complete( osrf_app_session* session, int request_id ) {
449         if(session == NULL)
450                 return;
451
452         osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
453         if(req) req->complete = 1;
454 }
455
456 int osrf_app_session_request_complete( osrf_app_session* session, int request_id ) {
457         if(session == NULL)
458                 return 0;
459         osrf_app_request* req = _osrf_app_session_get_request( session, request_id );
460         if(req)
461                 return req->complete;
462         return 0;
463 }
464
465 /** Returns the app_request with the given request_id (request_id) */
466 osrf_app_request* _osrf_app_session_get_request( 
467                 osrf_app_session* session, int request_id ){
468         if(session == NULL)
469                 return NULL;
470
471         debug_handler( "App Session searching for request [%d] in request queue",request_id );
472         osrf_app_request* req = session->request_queue;
473         while( req != NULL ) {
474                 if(req->request_id == request_id)
475                         return req;
476                 req = req->next;
477         }
478         return NULL;
479 }
480
481
482 /** Resets the remote connection id to that of the original*/
483 void osrf_app_session_reset_remote( osrf_app_session* session ){
484         if( session==NULL )
485                 return;
486
487         free(session->remote_id);
488         debug_handler( "App Session [%s] [%s] resetting remote id to %s",
489                         session->remote_service, session->session_id, session->orig_remote_id );
490
491         session->remote_id = strdup(session->orig_remote_id);
492 }
493
494 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id ) {
495         if(session == NULL)
496                 return;
497         if( session->remote_id )
498                 free(session->remote_id );
499         session->remote_id = strdup( remote_id );
500 }
501
502 /** pushes the given message into the result list of the app_request
503   with the given request_id */
504 int osrf_app_session_push_queue( 
505                 osrf_app_session* session, osrf_message* msg ){
506
507         if(session == NULL || msg == NULL)
508                 return 0;
509
510         debug_handler( "AppSession pushing result for [%d] onto request payload queue",
511                         msg->thread_trace );
512
513         osrf_app_request* req = session->request_queue;
514
515         if(req == NULL) {
516                 warning_handler( "app_session has no app_requests in its queue yet we have a result for [%d]", msg->thread_trace );
517                 return 0;
518         }
519
520         while( req != NULL ) {
521                 if(req->request_id == msg->thread_trace) {
522                         debug_handler( "Found app_request for tt [%d]", msg->thread_trace );
523                         _osrf_app_request_push_queue( req, msg );
524                         return 1;
525                 }
526                 req = req->next;
527         } 
528
529         return 0;
530         
531 }
532
533 /** Attempts to connect to the remote service */
534 int osrf_app_session_connect(osrf_app_session* session){
535         
536         if(session == NULL)
537                 return 0;
538
539         if(session->state == OSRF_SESSION_CONNECTED) {
540                 debug_handler("Already Connected, returning");
541                 return 1;
542         }
543
544         int timeout = 5; /* XXX CONFIG VALUE */
545
546         debug_handler( "AppSession connecting to %s", session->remote_id );
547
548         /* defaulting to protocol 1 for now */
549         osrf_message* con_msg = osrf_message_init( CONNECT, session->thread_trace, 1 );
550         osrf_app_session_reset_remote( session );
551         session->state = OSRF_SESSION_CONNECTING;
552         int ret = _osrf_app_session_send( session, con_msg );
553         osrf_message_free(con_msg);
554         if(!ret)        return 0;
555
556         time_t start = time(NULL);      
557         time_t remaining = (time_t) timeout;
558
559         while( session->state != OSRF_SESSION_CONNECTED && remaining >= 0 ) {
560                 osrf_app_session_queue_wait( session, remaining );
561                 remaining -= (int) (time(NULL) - start);
562         }
563
564         if(session->state == OSRF_SESSION_CONNECTED)
565                 debug_handler(" * Connected Successfully");
566
567         if(session->state != OSRF_SESSION_CONNECTED)
568                 return 0;
569
570         return 1;
571 }
572
573
574
575 /** Disconnects from the remote service */
576 int osrf_app_session_disconnect( osrf_app_session* session){
577         if(session == NULL)
578                 return 1;
579
580         if(session->state == OSRF_SESSION_DISCONNECTED)
581                 return 1;
582
583         if(session->stateless && session->state != OSRF_SESSION_CONNECTED) {
584                 debug_handler(
585                                 "Exiting disconnect on stateless session %s", 
586                                 session->session_id);
587                 return 1;
588         }
589
590         debug_handler( "AppSession disconnecting from %s", session->remote_id );
591
592         osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
593         session->state = OSRF_SESSION_DISCONNECTED;
594         _osrf_app_session_send( session, dis_msg );
595
596         osrf_message_free( dis_msg );
597         osrf_app_session_reset_remote( session );
598         return 1;
599 }
600
601 int osrf_app_session_request_resend( osrf_app_session* session, int req_id ) {
602         debug_handler("In reqeust resend searching for resend-able messages");
603         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
604         return _osrf_app_request_resend( req );
605 }
606
607 /** Send the given message */
608 int _osrf_app_session_send( osrf_app_session* session, osrf_message* msg ){
609         if(session == NULL) return 0;
610         int ret_val= 0;
611
612         osrf_app_session_queue_wait( session, 0 );
613         debug_handler( "AppSession sending type %d, and thread_trace %d",
614                         msg->m_type, msg->thread_trace );
615
616         if(session->stateless) {
617                 osrf_app_session_reset_remote(session);
618
619         } else {
620
621                 if( (msg->m_type != CONNECT) && (msg->m_type != DISCONNECT) &&
622                                 (session->state != OSRF_SESSION_CONNECTED) ) {
623                         if(!osrf_app_session_connect( session )) 
624                                 return 0;
625                 }
626         }
627
628         //char* xml =  osrf_message_to_xml(msg);
629         char* string =  osrf_message_serialize(msg);
630
631         debug_handler("[%s] [%s] Remote Id: %s", 
632                         session->remote_service, session->session_id, session->remote_id );
633
634         transport_message* t_msg = message_init( 
635                         string, "", session->session_id, session->remote_id, NULL );
636
637         debug_handler("Session [%s] [%s]  sending to %s \nXML:\n%s", 
638                         session->remote_service, session->session_id, t_msg->recipient, string );
639         ret_val = client_send_message( session->transport_handle, t_msg );
640         free(string);
641         message_free( t_msg );
642
643         return ret_val; 
644 }
645
646 /**  Waits up to 'timeout' seconds for some data to arrive.
647   * Any data that arrives will be processed according to its
648   * payload and message type.  This method will return after
649   * any data has arrived.
650   */
651 int osrf_app_session_queue_wait( osrf_app_session* session, int timeout ){
652         if(session == NULL) return 0;
653         int ret_val = 0;
654         debug_handler( "AppSession in queue_wait with timeout %d", timeout );
655         ret_val = osrf_stack_entry_point(session->transport_handle, timeout);
656         return ret_val;
657 }
658
659 /** Disconnects (if client) and removes the given session from the global session cache 
660   * ! This free's all attached app_requests ! 
661   */
662 void osrf_app_session_destroy ( osrf_app_session* session ){
663         if(session == NULL) return;
664
665         debug_handler( "AppSession [%s] [%s] destroying self and deleting requests", 
666                         session->remote_service, session->session_id );
667         if(session->type == OSRF_SESSION_CLIENT 
668                         && session->state != OSRF_SESSION_DISCONNECTED ) { /* disconnect if we're a client */
669                 osrf_message* dis_msg = osrf_message_init( DISCONNECT, session->thread_trace, 1 );
670                 _osrf_app_session_send( session, dis_msg ); 
671                 osrf_message_free(dis_msg);
672         }
673         //session->state = OSRF_SESSION_DISCONNECTED;
674         _osrf_app_session_remove_session(session->session_id);
675         debug_handler("AppSession [%s] [%s] removed from cache", 
676                         session->remote_service, session->session_id );
677
678         osrf_app_request* req;
679         while( session->request_queue != NULL ) {
680                 req = session->request_queue->next;
681                 _osrf_app_request_free( session->request_queue );
682                 session->request_queue = req;
683         }
684
685         _osrf_app_session_free( session );
686 }
687
688 osrf_message* osrfAppSessionRequestRecv(
689                 osrf_app_session* session, int req_id, int timeout ) {
690         return osrf_app_session_request_recv( session, req_id, timeout );
691 }
692 osrf_message* osrf_app_session_request_recv( 
693                 osrf_app_session* session, int req_id, int timeout ) {
694         if(req_id < 0 || session == NULL)
695                 return NULL;
696         debug_handler("somebody callled recv");
697         osrf_app_request* req = _osrf_app_session_get_request( session, req_id );
698         return _osrf_app_request_recv( req, timeout );
699 }
700
701
702
703 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data ) {
704         if(!ses || ! data ) return -1;
705
706         osrf_message* msg = osrf_message_init( RESULT, requestId, 1 );
707         char* json = jsonObjectToJSON( data );
708         osrf_message_set_result_content( msg, json );
709         _osrf_app_session_send( ses, msg ); 
710
711         free(json);
712         osrf_message_free( msg );
713
714         return 0;
715 }
716
717
718
719 int osrfAppSessionStatus( osrfAppSession* ses, int type, int reqId, char* message ) {
720
721         if(ses) {
722                 osrf_message* msg = osrf_message_init( STATUS, reqId, 1);
723                 osrf_message_set_status_info( msg, "Server Error", message, type );
724                 _osrf_app_session_send( ses, msg ); 
725                 osrf_message_free( msg );
726                 return 0;
727         }
728         return -1;
729 }
730
731
732
733
734
735