184604dfa799dee2a964938e82d6334577a78ed4
[OpenSRF.git] / src / gateway / osrf_http_translator.c
1 #include <sys/time.h>
2 #include <sys/resource.h>
3 #include <unistd.h>
4 #include <strings.h>
5 #include "apachetools.h"
6 #include <opensrf/osrf_app_session.h>
7 #include <opensrf/osrf_system.h>
8 #include <opensrf/osrfConfig.h>
9 #include <opensrf/osrf_json.h>
10 #include <opensrf/osrf_cache.h>
11
12 #define MODULE_NAME "osrf_http_translator_module"
13 #define OSRF_TRANSLATOR_CONFIG_FILE "OSRFTranslatorConfig"
14 #define OSRF_TRANSLATOR_CONFIG_CTX "OSRFTranslatorConfigContext"
15 #define OSRF_TRANSLATOR_CACHE_SERVER "OSRFTranslatorCacheServer"
16
17 #define DEFAULT_TRANSLATOR_CONFIG_CTX "gateway"
18 #define DEFAULT_TRANSLATOR_CONFIG_FILE "/openils/conf/opensrf_core.xml"
19 #define DEFAULT_TRANSLATOR_TIMEOUT 1200
20 #define DEFAULT_TRANSLATOR_CACHE_SERVERS "127.0.0.1:11211"
21
22 #define MULTIPART_CONTENT_TYPE "multipart/x-mixed-replace;boundary=\"%s\""
23 #define JSON_CONTENT_TYPE "text/plain"
24 #define MAX_MSGS_PER_PACKET 256
25 #define CACHE_TIME 300
26
27 #define OSRF_HTTP_HEADER_TO "X-OpenSRF-to"
28 #define OSRF_HTTP_HEADER_XID "X-OpenSRF-xid"
29 #define OSRF_HTTP_HEADER_FROM "X-OpenSRF-from"
30 #define OSRF_HTTP_HEADER_THREAD "X-OpenSRF-thread"
31 #define OSRF_HTTP_HEADER_TIMEOUT "X-OpenSRF-timeout"
32 #define OSRF_HTTP_HEADER_SERVICE "X-OpenSRF-service"
33 #define OSRF_HTTP_HEADER_MULTIPART "X-OpenSRF-multipart"
34
35 char* configFile = DEFAULT_TRANSLATOR_CONFIG_FILE;
36 char* configCtx = DEFAULT_TRANSLATOR_CONFIG_CTX;
37 char* cacheServers = DEFAULT_TRANSLATOR_CACHE_SERVERS;
38
39 char* routerName = NULL;
40 char* domainName = NULL;
41 int osrfConnected = 0;
42 char recipientBuf[128];
43 char contentTypeBuf[80];
44
45 // for development only, writes to apache error log
46 static void _dbg(char* s, ...) {
47     VA_LIST_TO_STRING(s);
48     fprintf(stderr, "%s\n", VA_BUF);
49     fflush(stderr);
50 }
51
52 // Translator struct
53 typedef struct {
54     request_rec* apreq;
55     transport_client* handle;
56     osrfList* messages;
57     char* body;
58     char* delim;
59     const char* recipient;
60     const char* service;
61     const char* thread;
62     const char* remoteHost;
63     int complete;
64     int timeout;
65     int multipart;
66     int connectOnly; // there is only 1 message, a CONNECT
67     int disconnectOnly; // there is only 1 message, a DISCONNECT
68     int connecting; // there is a connect message in this batch
69     int disconnecting; // there is a connect message in this batch
70     int localXid;
71 } osrfHttpTranslator;
72
73
74 static const char* osrfHttpTranslatorGetConfigFile(cmd_parms *parms, void *config, const char *arg) {
75     configFile = (char*) arg;
76         return NULL;
77 }
78 static const char* osrfHttpTranslatorGetConfigFileCtx(cmd_parms *parms, void *config, const char *arg) {
79     configCtx = (char*) arg;
80         return NULL;
81 }
82 static const char* osrfHttpTranslatorGetCacheServer(cmd_parms *parms, void *config, const char *arg) {
83     cacheServers = (char*) arg;
84         return NULL;
85 }
86
87 /** set up the configuratoin handlers */
88 static const command_rec osrf_json_gateway_cmds[] = {
89         AP_INIT_TAKE1( OSRF_TRANSLATOR_CONFIG_FILE, osrfHttpTranslatorGetConfigFile,
90                         NULL, RSRC_CONF, "osrf translator config file"),
91         AP_INIT_TAKE1( OSRF_TRANSLATOR_CONFIG_CTX, osrfHttpTranslatorGetConfigFileCtx,
92                         NULL, RSRC_CONF, "osrf translator config file context"),
93         AP_INIT_TAKE1( OSRF_TRANSLATOR_CACHE_SERVER, osrfHttpTranslatorGetCacheServer,
94                         NULL, RSRC_CONF, "osrf translator cache server"),
95     {NULL}
96 };
97
98
99 // there can only be one, so use a global static one
100 static osrfHttpTranslator globalTranslator;
101
102 /*
103  * Constructs a new translator object based on the current apache 
104  * request_rec.  Reads the request body and headers.
105  */
106 static osrfHttpTranslator* osrfNewHttpTranslator(request_rec* apreq) {
107     osrfHttpTranslator* trans = &globalTranslator;
108     trans->apreq = apreq;
109     trans->complete = 0;
110     trans->connectOnly = 0;
111     trans->disconnectOnly = 0;
112     trans->connecting = 0;
113     trans->disconnecting = 0;
114     trans->remoteHost = apreq->connection->remote_ip;
115     trans->messages = NULL;
116
117     /* load the message body */
118         osrfStringArray* params = apacheParseParms(apreq);
119     trans->body = apacheGetFirstParamValue(params, "osrf-msg");
120     osrfStringArrayFree(params);
121
122     /* load the request headers */
123     if (apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_XID)) // force our log xid to match the caller
124             osrfLogForceXid(strdup(apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_XID)));
125
126     trans->handle = osrfSystemGetTransportClient();
127     trans->recipient = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_TO);
128     trans->service = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_SERVICE);
129     trans->thread = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_THREAD); /* XXX create thread if necessary */
130
131     const char* timeout = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_TIMEOUT);
132     if(timeout) 
133         trans->timeout = atoi(timeout);
134     else 
135         trans->timeout = DEFAULT_TRANSLATOR_TIMEOUT;
136
137     const char* multipart = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_MULTIPART);
138     if(multipart && !strcasecmp(multipart, "true"))
139         trans->multipart = 1;
140     else
141         trans->multipart = 0;
142
143     char buf[32];
144     snprintf(buf, sizeof(buf), "%d%ld", getpid(), time(NULL));
145     trans->delim = md5sum(buf);
146
147     return trans;
148 }
149
150 static void osrfHttpTranslatorFree(osrfHttpTranslator* trans) {
151     if(!trans) return;
152     if(trans->body)
153         free(trans->body);
154     if(trans->delim)
155         free(trans->delim);
156     osrfListFree(trans->messages);
157 }
158
159 static void osrfHttpTranslatorDebug(osrfHttpTranslator* trans) {
160     _dbg("-----------------------------------");
161     _dbg("body = %s", trans->body);
162     _dbg("service = %s", trans->service);
163     _dbg("thread = %s", trans->thread);
164     _dbg("multipart = %d", trans->multipart);
165     _dbg("recipient = %s", trans->recipient);
166 }
167
168 /**
169  * Determines the correct recipient address based on the requested 
170  * service or recipient address.  
171  */
172 static int osrfHttpTranslatorSetTo(osrfHttpTranslator* trans) {
173     int stat = 0;
174     jsonObject* sessionCache = NULL;
175
176     if(trans->service) {
177         if(trans->recipient) {
178             osrfLogError(OSRF_LOG_MARK, "Specifying both SERVICE and TO are not allowed");
179
180         } else {
181             // service is specified, build a recipient address 
182             // from the router, domain, and service
183             int size = snprintf(recipientBuf, 128, "%s@%s/%s", routerName, domainName, trans->service);
184             recipientBuf[size] = '\0';
185             osrfLogDebug(OSRF_LOG_MARK, "Set recipient to %s", recipientBuf);
186             trans->recipient = recipientBuf;
187             stat = 1;
188         }
189
190     } else {
191
192         if(trans->recipient) {
193             sessionCache = osrfCacheGetObject(trans->thread);
194
195             if(sessionCache) {
196                 char* ipAddr = jsonObjectGetString(jsonObjectGetKey(sessionCache, "ip"));
197                 char* recipient = jsonObjectGetString(jsonObjectGetKey(sessionCache, "jid"));
198
199                 // choosing a specific recipient address requires that the recipient and 
200                 // thread be cached on the server (so drone processes cannot be hijacked)
201                 if(!strcmp(ipAddr, trans->remoteHost) && !strcmp(recipient, trans->recipient)) {
202                     osrfLogDebug(OSRF_LOG_MARK, "Found cached session from host %s and recipient %s", 
203                         trans->remoteHost, trans->recipient);
204                     stat = 1;
205                     trans->service = jsonObjectGetString(jsonObjectGetKey(sessionCache, "service"));
206
207                 } else {
208                     osrfLogError(OSRF_LOG_MARK, 
209                         "Session cache for thread %s does not match request", trans->thread);
210                 }
211             }  else {
212                 osrfLogError(OSRF_LOG_MARK, 
213                     "attempt to send directly to %s without a session", trans->recipient);
214             }
215         } else {
216             osrfLogError(OSRF_LOG_MARK, "No SERVICE or RECIPIENT defined");
217         } 
218     }
219
220     jsonObjectFree(sessionCache);
221     return stat;
222 }
223
224 /**
225  * Parses the request body and logs any REQUEST messages to the activity log
226  */
227 static int osrfHttpTranslatorParseRequest(osrfHttpTranslator* trans) {
228     osrfMessage* msg;
229     osrfMessage* msgList[MAX_MSGS_PER_PACKET];
230     int numMsgs = osrf_message_deserialize(trans->body, msgList, MAX_MSGS_PER_PACKET);
231     osrfLogDebug(OSRF_LOG_MARK, "parsed %d opensrf messages in this packet", numMsgs);
232
233     if(numMsgs == 0)
234         return 0;
235
236     if(numMsgs == 1) {
237         msg = msgList[0];
238         if(msg->m_type == CONNECT) {
239             trans->connectOnly = 1;
240             trans->connecting = 1;
241             return 1;
242         }
243         if(msg->m_type == DISCONNECT) {
244             trans->disconnectOnly = 1;
245             trans->disconnecting = 1;
246             return 1;
247         }
248     }
249
250     // log request messages to the activity log
251     int i;
252     for(i = 0; i < numMsgs; i++) {
253         msg = msgList[i];
254
255         switch(msg->m_type) {
256
257             case REQUEST: {
258                 jsonObject* params = msg->_params;
259                 growing_buffer* act = buffer_init(128); 
260                 buffer_fadd(act, "[%s] [%s] %s %s", trans->remoteHost, "", trans->service, msg->method_name);
261
262                 char* str; 
263                 int i = 0;
264                 while((str = jsonObjectGetString(jsonObjectGetIndex(params, i++)))) {
265                     if( i == 1 )
266                         OSRF_BUFFER_ADD(act, " ");
267                     else 
268                         OSRF_BUFFER_ADD(act, ", ");
269                     OSRF_BUFFER_ADD(act, str);
270                 }
271                 osrfLogActivity(OSRF_LOG_MARK, act->buf);
272                 buffer_free(act);
273                 break;
274             }
275
276             case CONNECT:
277                 trans->connecting = 1;
278                 break;
279
280             case DISCONNECT:
281                 trans->disconnecting = 1;
282                 break;
283         }
284     }
285
286     return 1;
287 }
288
289 static int osrfHttpTranslatorCheckStatus(osrfHttpTranslator* trans, transport_message* msg) {
290     osrfMessage* omsgList[MAX_MSGS_PER_PACKET];
291     int numMsgs = osrf_message_deserialize(msg->body, omsgList, MAX_MSGS_PER_PACKET);
292     osrfLogDebug(OSRF_LOG_MARK, "parsed %d response messages", numMsgs);
293     if(numMsgs == 0) return 0;
294
295     osrfMessage* last = omsgList[numMsgs-1];
296     if(last->m_type == STATUS) {
297         if(last->status_code == OSRF_STATUS_TIMEOUT) {
298             osrfLogDebug(OSRF_LOG_MARK, "removing cached session on request timeout");
299             osrfCacheRemove(trans->thread);
300             return 0;
301         }
302         // XXX hm, check for explicit status=COMPLETE message instead??
303         if(last->status_code != OSRF_STATUS_CONTINUE)
304             trans->complete = 1;
305     }
306
307     return 1;
308 }
309
310 static void osrfHttpTranslatorInitHeaders(osrfHttpTranslator* trans, transport_message* msg) {
311     apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_FROM, msg->sender);
312     apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_THREAD, trans->thread);
313     if(trans->multipart) {
314         sprintf(contentTypeBuf, MULTIPART_CONTENT_TYPE, trans->delim);
315         contentTypeBuf[79] = '\0';
316         osrfLogDebug(OSRF_LOG_MARK, "content type %s : %s : %s", MULTIPART_CONTENT_TYPE, trans->delim, contentTypeBuf);
317             ap_set_content_type(trans->apreq, contentTypeBuf);
318         ap_rprintf(trans->apreq, "--%s\n", trans->delim);
319     } else {
320             ap_set_content_type(trans->apreq, JSON_CONTENT_TYPE);
321     }
322 }
323
324 /**
325  * Cache the transaction with the JID of the backend process we are talking to
326  */
327 static void osrfHttpTranslatorCacheSession(osrfHttpTranslator* trans, const char* jid) {
328     jsonObject* cacheObj = jsonNewObject(NULL);
329     jsonObjectSetKey(cacheObj, "ip", jsonNewObject(trans->remoteHost));
330     jsonObjectSetKey(cacheObj, "jid", jsonNewObject(jid));
331     jsonObjectSetKey(cacheObj, "service", jsonNewObject(trans->service));
332     osrfCachePutObject((char*) trans->thread, cacheObj, CACHE_TIME);
333 }
334
335            
336 /**
337  * Writes a single chunk of multipart/x-mixed-replace content
338  */
339 static void osrfHttpTranslatorWriteChunk(osrfHttpTranslator* trans, transport_message* msg) {
340     osrfLogInternal(OSRF_LOG_MARK, "sending multipart chunk %s", msg->body);
341     ap_rprintf(trans->apreq, 
342         "Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
343     //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
344     if(trans->complete) {
345         ap_rprintf(trans->apreq, "--%s--\n", trans->delim);
346         //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s--\n", trans->delim);
347     } else {
348         ap_rprintf(trans->apreq, "--%s\n", trans->delim);
349         //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s\n", trans->delim);
350     }
351     ap_rflush(trans->apreq);
352 }
353
354 static int osrfHttpTranslatorProcess(osrfHttpTranslator* trans) {
355     if(trans->body == NULL)
356         return HTTP_BAD_REQUEST;
357
358     if(!osrfHttpTranslatorSetTo(trans))
359         return HTTP_BAD_REQUEST;
360
361     if(!osrfHttpTranslatorParseRequest(trans))
362         return HTTP_BAD_REQUEST;
363
364     while(client_recv(trans->handle, 0))
365         continue; // discard any old status messages in the recv queue
366
367     // send the message to the recipient
368     transport_message* tmsg = message_init(
369         trans->body, NULL, trans->thread, trans->recipient, NULL);
370     message_set_osrf_xid(tmsg, osrfLogGetXid());
371     client_send_message(trans->handle, tmsg);
372     message_free(tmsg); 
373
374     if(trans->disconnectOnly) {
375         osrfLogDebug(OSRF_LOG_MARK, "exiting early on disconnect");
376         osrfCacheRemove(trans->thread);
377         return OK;
378     }
379
380     // process the response from the opensrf service
381     int firstWrite = 1;
382     while(!trans->complete) {
383         transport_message* msg = client_recv(trans->handle, trans->timeout);
384
385         if(trans->handle->error) {
386             osrfLogError(OSRF_LOG_MARK, "Transport error");
387             osrfCacheRemove(trans->thread);
388             return HTTP_INTERNAL_SERVER_ERROR;
389         }
390
391         if(msg == NULL)
392             return HTTP_GATEWAY_TIME_OUT;
393
394         if(msg->is_error) {
395             osrfLogError(OSRF_LOG_MARK, "XMPP message resulted in error code %d", msg->error_code);
396             osrfCacheRemove(trans->thread);
397             return HTTP_NOT_FOUND;
398         }
399
400         if(!osrfHttpTranslatorCheckStatus(trans, msg))
401             continue;
402
403         if(firstWrite) {
404             osrfHttpTranslatorInitHeaders(trans, msg);
405             if(trans->connecting)
406                 osrfHttpTranslatorCacheSession(trans, msg->sender);
407             firstWrite = 0;
408         }
409
410         if(trans->multipart) {
411             osrfHttpTranslatorWriteChunk(trans, msg);
412             if(trans->connectOnly)
413                 break;
414         } else {
415             if(!trans->messages)
416                 trans->messages = osrfNewList();
417             osrfListPush(trans->messages, msg->body);
418
419             if(trans->complete || trans->connectOnly) {
420                 growing_buffer* buf = buffer_init(128);
421                 int i;
422                 OSRF_BUFFER_ADD(buf, osrfListGetIndex(trans->messages, 0));
423                 for(i = 1; i < trans->messages->size; i++) {
424                     buffer_chomp(buf); // chomp off the closing array bracket
425                     char* body = osrfListGetIndex(trans->messages, i);
426                     char newbuf[strlen(body)];
427                     sprintf(newbuf, body+1); // chomp off the opening array bracket
428                     OSRF_BUFFER_ADD_CHAR(buf, ',');
429                     OSRF_BUFFER_ADD(buf, newbuf);
430                 }
431                 
432                 ap_rputs(buf->buf, trans->apreq);
433                 buffer_free(buf);
434             }
435         }
436     }
437
438     if(trans->disconnecting) // DISCONNECT within a multi-message batch
439         osrfCacheRemove(trans->thread);
440
441     return OK;
442 }
443
444 static void testConnection(request_rec* r) {
445         if(!osrfConnected || !osrfSystemGetTransportClient()) {
446         osrfLogError(OSRF_LOG_MARK, "We're not connected to OpenSRF");
447                 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "We're not connected to OpenSRF");
448                 usleep(100000); // .1 second to prevent process die/start overload
449                 exit(1);
450         }
451 }
452
453 // it's dead, Jim
454 static apr_status_t childExit(void* data) {
455     osrf_system_shutdown();
456     return OK;
457 }
458
459 static void childInit(apr_pool_t *p, server_rec *s) {
460         if(!osrfSystemBootstrapClientResc(configFile, configCtx, "translator")) {
461                 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s, 
462                         "Unable to Bootstrap OpenSRF Client with config %s..", configFile);
463                 return;
464         }
465
466     routerName = osrfConfigGetValue(NULL, "/router_name");
467     domainName = osrfConfigGetValue(NULL, "/domain");
468     const char* servers[] = {cacheServers};
469     osrfCacheInit(servers, 1, 86400);
470         osrfConnected = 1;
471
472     // at pool destroy time (= child exit time), cleanup
473     // XXX causes us to disconnect even for clone()'d process cleanup (as in mod_cgi)
474     //apr_pool_cleanup_register(p, NULL, childExit, apr_pool_cleanup_null);
475 }
476
477 static int handler(request_rec *r) {
478     int stat = OK;
479         if(strcmp(r->handler, MODULE_NAME)) return DECLINED;
480     if(r->header_only) return stat;
481
482         r->allowed |= (AP_METHOD_BIT << M_GET);
483         r->allowed |= (AP_METHOD_BIT << M_POST);
484
485         osrfLogSetAppname("osrf_http_translator");
486     testConnection(r);
487
488     osrfHttpTranslator* trans = osrfNewHttpTranslator(r);
489         osrfLogMkXid();
490     if(trans->body) {
491         stat = osrfHttpTranslatorProcess(trans);
492         //osrfHttpTranslatorDebug(trans);
493         osrfLogInfo(OSRF_LOG_MARK, "translator resulted in status %d", stat);
494     } else {
495         osrfLogWarning(OSRF_LOG_MARK, "no message body to process");
496     }
497     osrfHttpTranslatorFree(trans);
498         return stat;
499 }
500
501
502 static void registerHooks (apr_pool_t *p) {
503         ap_hook_handler(handler, NULL, NULL, APR_HOOK_MIDDLE);
504         ap_hook_child_init(childInit, NULL, NULL, APR_HOOK_MIDDLE);
505 }
506
507
508 module AP_MODULE_DECLARE_DATA osrf_http_translator_module = {
509         STANDARD20_MODULE_STUFF,
510     NULL,
511         NULL,
512     NULL,
513         NULL,
514     NULL,
515         registerHooks,
516 };
517
518
519
520