2 #include <sys/resource.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>
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"
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"
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
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"
35 char* configFile = DEFAULT_TRANSLATOR_CONFIG_FILE;
36 char* configCtx = DEFAULT_TRANSLATOR_CONFIG_CTX;
37 char* cacheServers = DEFAULT_TRANSLATOR_CACHE_SERVERS;
39 char* routerName = NULL;
40 char* domainName = NULL;
41 int osrfConnected = 0;
42 char recipientBuf[128];
43 char contentTypeBuf[80];
45 // for development only, writes to apache error log
46 static void _dbg(char* s, ...) {
48 fprintf(stderr, "%s\n", VA_BUF);
55 transport_client* handle;
59 const char* recipient;
62 const char* remoteHost;
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
74 static const char* osrfHttpTranslatorGetConfigFile(cmd_parms *parms, void *config, const char *arg) {
75 configFile = (char*) arg;
78 static const char* osrfHttpTranslatorGetConfigFileCtx(cmd_parms *parms, void *config, const char *arg) {
79 configCtx = (char*) arg;
82 static const char* osrfHttpTranslatorGetCacheServer(cmd_parms *parms, void *config, const char *arg) {
83 cacheServers = (char*) arg;
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"),
99 // there can only be one, so use a global static one
100 static osrfHttpTranslator globalTranslator;
103 * Constructs a new translator object based on the current apache
104 * request_rec. Reads the request body and headers.
106 static osrfHttpTranslator* osrfNewHttpTranslator(request_rec* apreq) {
107 osrfHttpTranslator* trans = &globalTranslator;
108 trans->apreq = apreq;
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;
117 /* load the message body */
118 osrfStringArray* params = apacheParseParms(apreq);
119 trans->body = apacheGetFirstParamValue(params, "osrf-msg");
120 osrfStringArrayFree(params);
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)));
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 */
131 const char* timeout = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_TIMEOUT);
133 trans->timeout = atoi(timeout);
135 trans->timeout = DEFAULT_TRANSLATOR_TIMEOUT;
137 const char* multipart = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_MULTIPART);
138 if(multipart && !strcasecmp(multipart, "true"))
139 trans->multipart = 1;
141 trans->multipart = 0;
144 snprintf(buf, sizeof(buf), "%d%ld", getpid(), time(NULL));
145 trans->delim = md5sum(buf);
150 static void osrfHttpTranslatorFree(osrfHttpTranslator* trans) {
156 osrfListFree(trans->messages);
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);
169 * Determines the correct recipient address based on the requested
170 * service or recipient address.
172 static int osrfHttpTranslatorSetTo(osrfHttpTranslator* trans) {
174 jsonObject* sessionCache = NULL;
177 if(trans->recipient) {
178 osrfLogError(OSRF_LOG_MARK, "Specifying both SERVICE and TO are not allowed");
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;
192 if(trans->recipient) {
193 sessionCache = osrfCacheGetObject(trans->thread);
196 char* ipAddr = jsonObjectGetString(jsonObjectGetKey(sessionCache, "ip"));
197 char* recipient = jsonObjectGetString(jsonObjectGetKey(sessionCache, "jid"));
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);
205 trans->service = jsonObjectGetString(jsonObjectGetKey(sessionCache, "service"));
208 osrfLogError(OSRF_LOG_MARK,
209 "Session cache for thread %s does not match request", trans->thread);
212 osrfLogError(OSRF_LOG_MARK,
213 "attempt to send directly to %s without a session", trans->recipient);
216 osrfLogError(OSRF_LOG_MARK, "No SERVICE or RECIPIENT defined");
220 jsonObjectFree(sessionCache);
225 * Parses the request body and logs any REQUEST messages to the activity log
227 static int osrfHttpTranslatorParseRequest(osrfHttpTranslator* trans) {
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);
238 if(msg->m_type == CONNECT) {
239 trans->connectOnly = 1;
242 if(msg->m_type == DISCONNECT) {
243 trans->disconnectOnly = 1;
248 // log request messages to the activity log
250 for(i = 0; i < numMsgs; i++) {
253 switch(msg->m_type) {
256 jsonObject* params = msg->_params;
257 growing_buffer* act = buffer_init(128);
258 buffer_fadd(act, "[%s] [%s] %s %s", trans->remoteHost, "", trans->service, msg->method_name);
262 while((str = jsonObjectGetString(jsonObjectGetIndex(params, i++)))) {
264 OSRF_BUFFER_ADD(act, " ");
266 OSRF_BUFFER_ADD(act, ", ");
267 OSRF_BUFFER_ADD(act, str);
269 osrfLogActivity(OSRF_LOG_MARK, act->buf);
275 trans->connecting = 1;
279 trans->disconnecting = 1;
287 static int osrfHttpTranslatorCheckStatus(osrfHttpTranslator* trans, transport_message* msg) {
288 osrfMessage* omsgList[MAX_MSGS_PER_PACKET];
289 int numMsgs = osrf_message_deserialize(msg->body, omsgList, MAX_MSGS_PER_PACKET);
290 osrfLogDebug(OSRF_LOG_MARK, "parsed %d response messages", numMsgs);
291 if(numMsgs == 0) return 0;
293 osrfMessage* last = omsgList[numMsgs-1];
294 if(last->m_type == STATUS) {
295 if(last->status_code == OSRF_STATUS_TIMEOUT) {
296 osrfLogDebug(OSRF_LOG_MARK, "removing cached session on request timeout");
297 osrfCacheRemove(trans->thread);
300 // XXX hm, check for explicit status=COMPLETE message instead??
301 if(last->status_code != OSRF_STATUS_CONTINUE)
308 static void osrfHttpTranslatorInitHeaders(osrfHttpTranslator* trans, transport_message* msg) {
309 apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_FROM, msg->sender);
310 apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_THREAD, trans->thread);
311 if(trans->multipart) {
312 sprintf(contentTypeBuf, MULTIPART_CONTENT_TYPE, trans->delim);
313 contentTypeBuf[79] = '\0';
314 osrfLogDebug(OSRF_LOG_MARK, "content type %s : %s : %s", MULTIPART_CONTENT_TYPE, trans->delim, contentTypeBuf);
315 ap_set_content_type(trans->apreq, contentTypeBuf);
316 ap_rprintf(trans->apreq, "--%s\n", trans->delim);
318 ap_set_content_type(trans->apreq, JSON_CONTENT_TYPE);
323 * Cache the transaction with the JID of the backend process we are talking to
325 static void osrfHttpTranslatorCacheSession(osrfHttpTranslator* trans, const char* jid) {
326 jsonObject* cacheObj = jsonNewObject(NULL);
327 jsonObjectSetKey(cacheObj, "ip", jsonNewObject(trans->remoteHost));
328 jsonObjectSetKey(cacheObj, "jid", jsonNewObject(jid));
329 jsonObjectSetKey(cacheObj, "service", jsonNewObject(trans->service));
330 osrfCachePutObject((char*) trans->thread, cacheObj, CACHE_TIME);
335 * Writes a single chunk of multipart/x-mixed-replace content
337 static void osrfHttpTranslatorWriteChunk(osrfHttpTranslator* trans, transport_message* msg) {
338 osrfLogInternal(OSRF_LOG_MARK, "sending multipart chunk %s", msg->body);
339 ap_rprintf(trans->apreq,
340 "Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
341 //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
342 if(trans->complete) {
343 ap_rprintf(trans->apreq, "--%s--\n", trans->delim);
344 //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s--\n", trans->delim);
346 ap_rprintf(trans->apreq, "--%s\n", trans->delim);
347 //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s\n", trans->delim);
349 ap_rflush(trans->apreq);
352 static int osrfHttpTranslatorProcess(osrfHttpTranslator* trans) {
353 if(trans->body == NULL)
354 return HTTP_BAD_REQUEST;
356 if(!osrfHttpTranslatorSetTo(trans))
357 return HTTP_BAD_REQUEST;
359 if(!osrfHttpTranslatorParseRequest(trans))
360 return HTTP_BAD_REQUEST;
362 while(client_recv(trans->handle, 0))
363 continue; // discard any old status messages in the recv queue
365 // send the message to the recipient
366 transport_message* tmsg = message_init(
367 trans->body, NULL, trans->thread, trans->recipient, NULL);
368 message_set_osrf_xid(tmsg, osrfLogGetXid());
369 client_send_message(trans->handle, tmsg);
372 if(trans->disconnectOnly) {
373 osrfLogDebug(OSRF_LOG_MARK, "exiting early on disconnect");
374 osrfCacheRemove(trans->thread);
378 // process the response from the opensrf service
380 while(!trans->complete) {
381 transport_message* msg = client_recv(trans->handle, trans->timeout);
383 if(trans->handle->error) {
384 osrfLogError(OSRF_LOG_MARK, "Transport error");
385 osrfCacheRemove(trans->thread);
386 return HTTP_INTERNAL_SERVER_ERROR;
390 return HTTP_GATEWAY_TIME_OUT;
393 osrfLogError(OSRF_LOG_MARK, "XMPP message resulted in error code %d", msg->error_code);
394 osrfCacheRemove(trans->thread);
395 return HTTP_NOT_FOUND;
398 if(!osrfHttpTranslatorCheckStatus(trans, msg))
402 osrfHttpTranslatorInitHeaders(trans, msg);
403 if(trans->connecting)
404 osrfHttpTranslatorCacheSession(trans, msg->sender);
408 if(trans->multipart) {
409 osrfHttpTranslatorWriteChunk(trans, msg);
410 if(trans->connectOnly)
414 trans->messages = osrfNewList();
415 osrfListPush(trans->messages, msg->body);
417 if(trans->complete || trans->connectOnly) {
418 growing_buffer* buf = buffer_init(128);
420 OSRF_BUFFER_ADD(buf, osrfListGetIndex(trans->messages, 0));
421 for(i = 1; i < trans->messages->size; i++) {
422 buffer_chomp(buf); // chomp off the closing array bracket
423 char* body = osrfListGetIndex(trans->messages, i);
424 char newbuf[strlen(body)];
425 sprintf(newbuf, body+1); // chomp off the opening array bracket
426 OSRF_BUFFER_ADD_CHAR(buf, ',');
427 OSRF_BUFFER_ADD(buf, newbuf);
430 ap_rputs(buf->buf, trans->apreq);
436 if(trans->disconnecting) // DISCONNECT within a multi-message batch
437 osrfCacheRemove(trans->thread);
442 static void testConnection(request_rec* r) {
443 if(!osrfConnected || !osrfSystemGetTransportClient()) {
444 osrfLogError(OSRF_LOG_MARK, "We're not connected to OpenSRF");
445 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "We're not connected to OpenSRF");
446 usleep(100000); // .1 second to prevent process die/start overload
452 static apr_status_t childExit(void* data) {
453 osrf_system_shutdown();
457 static void childInit(apr_pool_t *p, server_rec *s) {
458 if(!osrfSystemBootstrapClientResc(configFile, configCtx, "translator")) {
459 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
460 "Unable to Bootstrap OpenSRF Client with config %s..", configFile);
464 routerName = osrfConfigGetValue(NULL, "/router_name");
465 domainName = osrfConfigGetValue(NULL, "/domain");
466 const char* servers[] = {cacheServers};
467 osrfCacheInit(servers, 1, 86400);
470 // at pool destroy time (= child exit time), cleanup
471 // XXX causes us to disconnect even for clone()'d process cleanup (as in mod_cgi)
472 //apr_pool_cleanup_register(p, NULL, childExit, apr_pool_cleanup_null);
475 static int handler(request_rec *r) {
477 if(strcmp(r->handler, MODULE_NAME)) return DECLINED;
478 if(r->header_only) return stat;
480 r->allowed |= (AP_METHOD_BIT << M_GET);
481 r->allowed |= (AP_METHOD_BIT << M_POST);
483 osrfLogSetAppname("osrf_http_translator");
486 osrfHttpTranslator* trans = osrfNewHttpTranslator(r);
489 stat = osrfHttpTranslatorProcess(trans);
490 //osrfHttpTranslatorDebug(trans);
491 osrfLogInfo(OSRF_LOG_MARK, "translator resulted in status %d", stat);
493 osrfLogWarning(OSRF_LOG_MARK, "no message body to process");
495 osrfHttpTranslatorFree(trans);
500 static void registerHooks (apr_pool_t *p) {
501 ap_hook_handler(handler, NULL, NULL, APR_HOOK_MIDDLE);
502 ap_hook_child_init(childInit, NULL, NULL, APR_HOOK_MIDDLE);
506 module AP_MODULE_DECLARE_DATA osrf_http_translator_module = {
507 STANDARD20_MODULE_STUFF,