1 #include "opensrf/osrf_application.h"
2 #include "opensrf/osrf_settings.h"
3 #include "opensrf/utils.h"
4 #include "objson/object.h"
5 #include "opensrf/log.h"
6 #include "oils_utils.h"
7 #include "oils_constants.h"
8 #include "oils_event.h"
14 #include <libxml/globals.h>
15 #include <libxml/xmlerror.h>
16 #include <libxml/parser.h>
17 #include <libxml/tree.h>
18 #include <libxml/debugXML.h>
19 #include <libxml/xmlmemory.h>
20 //#include <openils/fieldmapper_lookup.h>
22 #define OILS_AUTH_CACHE_PRFX "oils_cstore_"
23 #define MODULENAME "open-ils.cstore"
24 #define PERSIST_NS "http://open-ils.org/spec/opensrf/IDL/persistance/v1"
25 #define OBJECT_NS "http://open-ils.org/spec/opensrf/IDL/objects/v1"
26 #define BASE_NS "http://opensrf.org/spec/IDL/base/v1"
28 int osrfAppChildInit();
29 int osrfAppInitialize();
31 int dispatchCRUDMethod ( osrfMethodContext* );
32 jsonObject* doCreate ( osrfHash*, jsonObject* );
33 jsonObject* doRetrieve ( osrfHash*, jsonObject* );
34 jsonObject* doUpdate ( osrfHash*, jsonObject* );
35 jsonObject* doDelete ( osrfHash*, jsonObject* );
36 jsonObject* oilsMakeJSONFromResult( dbi_result, osrfHash* );
38 dbi_conn dbhandle; /* our db connection */
39 xmlDocPtr idlDoc = NULL; // parse and store the IDL here
42 /* parse and store the IDL here */
45 int osrfAppInitialize() {
47 idlHash = osrfNewHash();
49 osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
50 osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
52 char * idl_filename = osrf_settings_host_value("/apps/%s/app_settings/IDL", MODULENAME);
53 osrfLogInfo(OSRF_LOG_MARK, "Found file:");
54 osrfLogInfo(OSRF_LOG_MARK, idl_filename);
56 osrfLogInfo(OSRF_LOG_MARK, "Parsing the IDL XML...");
57 idlDoc = xmlReadFile( idl_filename, NULL, XML_PARSE_XINCLUDE );
60 osrfLogError(OSRF_LOG_MARK, "Could not load or parse the IDL XML file!");
64 osrfLogInfo(OSRF_LOG_MARK, "...IDL XML parsed");
66 osrfStringArray* global_methods = osrfNewStringArray(1);
68 //osrfStringArrayAdd( global_methods, "create" );
69 osrfStringArrayAdd( global_methods, "retrieve" );
70 //osrfStringArrayAdd( global_methods, "update" );
71 //osrfStringArrayAdd( global_methods, "delete" );
73 xmlNodePtr docRoot = xmlDocGetRootElement(idlDoc);
74 xmlNodePtr kid = docRoot->children;
76 if (!strcmp( (char*)kid->name, "class" )) {
79 while ( (method_type = osrfStringArrayGetString(global_methods, i++)) ) {
81 osrfHash * usrData = osrfNewHash();
82 osrfHashSet( usrData, xmlGetProp(kid, "id"), "classname");
83 osrfHashSet( usrData, xmlGetNsProp(kid, "tablename", PERSIST_NS), "tablename");
84 osrfHashSet( usrData, xmlGetNsProp(kid, "fieldmapper", OBJECT_NS), "fieldmapper");
86 if(!strcmp(method_type, "retrieve"))
87 osrfHashSet( idlHash, usrData, (char*)osrfHashGet(usrData, "classname") );
89 osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", osrfHashGet(usrData, "fieldmapper") );
92 osrfHash* links = osrfNewHash();
93 osrfHash* fields = osrfNewHash();
95 osrfHashSet( usrData, fields, "fields" );
96 osrfHashSet( usrData, links, "links" );
98 xmlNodePtr _cur = kid->children;
101 char* string_tmp = NULL;
103 if (!strcmp( (char*)_cur->name, "fields" )) {
105 if( (string_tmp = (char*)xmlGetNsProp(_cur, "primary", PERSIST_NS)) ) {
108 strdup( string_tmp ),
114 xmlNodePtr _f = _cur->children;
117 if (strcmp( (char*)_f->name, "field" )) {
122 _tmp = osrfNewHash();
124 if( (string_tmp = (char*)xmlGetNsProp(_f, "array_position", OBJECT_NS)) ) {
127 strdup( string_tmp ),
133 if( (string_tmp = (char*)xmlGetNsProp(_f, "virtual", PERSIST_NS)) ) {
136 strdup( string_tmp ),
142 if( (string_tmp = (char*)xmlGetProp(_f, "name")) ) {
145 strdup( string_tmp ),
150 osrfLogInfo(OSRF_LOG_MARK, "Found field %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
161 if (!strcmp( (char*)_cur->name, "links" )) {
162 xmlNodePtr _l = _cur->children;
165 if (strcmp( (char*)_l->name, "link" )) {
170 _tmp = osrfNewHash();
172 if( (string_tmp = (char*)xmlGetProp(_l, "reltype")) ) {
175 strdup( string_tmp ),
179 osrfLogInfo(OSRF_LOG_MARK, "Adding link with reltype %s", string_tmp );
182 if( (string_tmp = (char*)xmlGetProp(_l, "key")) ) {
185 strdup( string_tmp ),
189 osrfLogInfo(OSRF_LOG_MARK, "Link fkey is %s", string_tmp );
192 if( (string_tmp = (char*)xmlGetProp(_l, "class")) ) {
195 strdup( string_tmp ),
199 osrfLogInfo(OSRF_LOG_MARK, "Link fclass is %s", string_tmp );
202 osrfStringArray* map = osrfNewStringArray(0);
204 if( (string_tmp = (char*)xmlGetProp(_l, "map") )) {
205 char* map_list = strdup( string_tmp );
206 osrfLogInfo(OSRF_LOG_MARK, "Link mapping list is %s", string_tmp );
208 if (strlen( map_list ) > 0) {
210 char* _map_class = strtok_r(map_list, " ", &st_tmp);
211 osrfStringArrayAdd(map, strdup(_map_class));
213 while ((_map_class = strtok_r(NULL, " ", &st_tmp))) {
214 osrfStringArrayAdd(map, strdup(_map_class));
218 osrfHashSet( _tmp, map, "map");
220 if( (string_tmp = (char*)xmlGetProp(_l, "field")) ) {
223 strdup( string_tmp ),
234 osrfLogInfo(OSRF_LOG_MARK, "Found link %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
246 if (!osrfHashGet(usrData, "fieldmapper")) continue;
248 _fm = strdup( (char*)osrfHashGet(usrData, "fieldmapper") );
249 char* part = strtok_r(_fm, ":", &st_tmp);
251 growing_buffer* method_name = buffer_init(64);
252 buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
254 while ((part = strtok_r(NULL, ":", &st_tmp))) {
255 buffer_fadd(method_name, ".%s", part);
257 buffer_fadd(method_name, ".%s", method_type);
259 char* method = buffer_data(method_name);
260 buffer_free(method_name);
262 osrfHashSet( usrData, method, "methodname" );
263 osrfHashSet( usrData, strdup(method_type), "methodtype" );
265 osrfAppRegisterExtendedMethod(
268 "dispatchCRUDMethod",
283 * Connects to the database
285 int osrfAppChildInit() {
287 osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
288 dbi_initialize(NULL);
289 osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
291 char* driver = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
292 char* user = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
293 char* host = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
294 char* port = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
295 char* db = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
296 char* pw = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
298 osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
299 dbhandle = dbi_conn_new(driver);
302 osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
305 osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
307 osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database. host=%s, "
308 "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
310 if(host) dbi_conn_set_option(dbhandle, "host", host );
311 if(port) dbi_conn_set_option_numeric( dbhandle, "port", atoi(port) );
312 if(user) dbi_conn_set_option(dbhandle, "username", user);
313 if(pw) dbi_conn_set_option(dbhandle, "password", pw );
314 if(db) dbi_conn_set_option(dbhandle, "dbname", db );
323 if (dbi_conn_connect(dbhandle) < 0) {
324 dbi_conn_error(dbhandle, &err);
325 osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
329 osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
335 osrfStringArray* classes = osrfHashKeys( idlHash );
337 while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
338 osrfHash* class = osrfHashGet( idlHash, classname );
339 osrfHash* fields = osrfHashGet( class, "fields" );
341 growing_buffer* sql_buf = buffer_init(32);
342 buffer_fadd( sql_buf, "SELECT * FROM %s WHERE 1=0;", osrfHashGet(class, "tablename") );
344 char* sql = buffer_data(sql_buf);
345 buffer_free(sql_buf);
346 osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
348 dbi_result result = dbi_conn_query(dbhandle, sql);
354 const char* columnName;
356 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
358 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
360 /* fetch the fieldmapper index */
361 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
363 osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
365 /* determine the field type and storage attributes */
366 type = dbi_result_get_field_type(result, columnName);
367 attr = dbi_result_get_field_attribs(result, columnName);
371 case DBI_TYPE_INTEGER :
373 osrfHashSet(_f,"number", "primitive");
375 if( attr & DBI_INTEGER_SIZE8 )
376 osrfHashSet(_f,"INT8", "datatype");
378 osrfHashSet(_f,"INT", "datatype");
381 case DBI_TYPE_DECIMAL :
382 osrfHashSet(_f,"number", "primitive");
383 osrfHashSet(_f,"NUMERIC", "datatype");
386 case DBI_TYPE_STRING :
387 osrfHashSet(_f,"string", "primitive");
388 osrfHashSet(_f,"TEXT", "datatype");
391 case DBI_TYPE_DATETIME :
392 osrfHashSet(_f,"string", "primitive");
393 osrfHashSet(_f,"TIMESTAMP", "datatype");
396 case DBI_TYPE_BINARY :
397 osrfHashSet(_f,"string", "primitive");
398 osrfHashSet(_f,"BYTEA", "datatype");
403 "Setting [%s] to primitive [%s] and datatype [%s]...",
405 osrfHashGet(_f, "primitive"),
406 osrfHashGet(_f, "datatype")
410 dbi_result_free(result);
412 osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
416 osrfStringArrayFree(classes);
422 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
423 OSRF_METHOD_VERIFY_CONTEXT(ctx);
425 osrfHash* meta = (osrfHash*) ctx->method->userData;
427 jsonObject * obj = NULL;
428 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "create"))
429 obj = doCreate(meta, ctx->params);
431 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "retrieve"))
432 obj = doRetrieve(meta, ctx->params);
434 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "update"))
435 obj = doUpdate(meta, ctx->params);
437 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "delete"))
438 obj = doDelete(meta, ctx->params);
440 osrfAppRespondComplete( ctx, obj );
442 //jsonObjectFree(obj);
447 jsonObject* doCreate( osrfHash* meta, jsonObject* params ) { return NULL; }
449 jsonObject* doRetrieve( osrfHash* meta, jsonObject* params ) {
452 char* id = jsonObjectToSimpleString(jsonObjectGetIndex(params, 0));
456 "%s retrieving %s object with id %s",
458 osrfHashGet(meta, "fieldmapper"),
464 growing_buffer* sql_buf = buffer_init(128);
467 "SELECT * FROM %s WHERE %s = %d;",
468 osrfHashGet(meta, "tablename"),
469 osrfHashGet(meta, "primarykey"),
473 char* sql = buffer_data(sql_buf);
474 buffer_free(sql_buf);
476 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
478 dbi_result result = dbi_conn_query(dbhandle, sql);
481 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
483 /* there should be one row at the most */
484 if (dbi_result_next_row(result)) {
485 /* JSONify the result */
486 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
487 obj = oilsMakeJSONFromResult( result, meta );
489 osrfLogDebug(OSRF_LOG_MARK, "%s: Error retrieving %s with key %s", MODULENAME, osrfHashGet(meta, "fieldmapper"), id);
490 obj = jsonNewObject(NULL);
493 /* clean up the query */
494 dbi_result_free(result);
497 obj = jsonNewObject(NULL);
498 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
508 jsonObject* doUpdate( osrfHash* meta, jsonObject* params ) { return NULL; }
510 jsonObject* doDelete( osrfHash* meta, jsonObject* params ) { return NULL; }
513 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta) {
514 if(!(result && meta)) return NULL;
516 jsonObject* object = jsonParseString("[]");
517 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
519 osrfHash* fields = osrfHashGet(meta, "fields");
521 osrfLogDebug(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
532 const char* columnName;
534 // this block gets the local timezone. until we can patch libdbi this'll have to do, pig.
535 time_t tmp_t = time(NULL);
537 localtime_r( &tmp_t, &ldt );
540 memset(tz_part,'\0',8);
542 strftime(tz_part,7,"%z",&ldt);
543 tz_part[5] = tz_part[4];
544 tz_part[4] = tz_part[3];
548 /* cycle through the column list */
549 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
551 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
553 fmIndex = -1; // reset the position
555 /* determine the field type and storage attributes */
556 type = dbi_result_get_field_type(result, columnName);
557 attr = dbi_result_get_field_attribs(result, columnName);
559 /* fetch the fieldmapper index */
560 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
561 char* virt = (char*)osrfHashGet(_f, "virtual");
562 char* pos = (char*)osrfHashGet(_f, "array_position");
564 if ( !virt || !pos || !(strcmp( virt, "true" )) ) continue;
566 fmIndex = atoi( pos );
567 osrfLogDebug(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
570 if (dbi_result_field_is_null(result, columnName)) {
571 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
576 case DBI_TYPE_INTEGER :
578 if( attr & DBI_INTEGER_SIZE8 )
579 jsonObjectSetIndex( object, fmIndex,
580 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
582 jsonObjectSetIndex( object, fmIndex,
583 jsonNewNumberObject(dbi_result_get_long(result, columnName)));
587 case DBI_TYPE_DECIMAL :
588 jsonObjectSetIndex( object, fmIndex,
589 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
592 case DBI_TYPE_STRING :
598 jsonNewObject( dbi_result_get_string(result, columnName) )
603 case DBI_TYPE_DATETIME :
605 memset(dt_string, '\0', 256);
606 memset(&gmdt, '\0', sizeof(gmdt));
607 memset(&_tmp_dt, '\0', sizeof(_tmp_dt));
609 _tmp_dt = dbi_result_get_datetime(result, columnName);
611 localtime_r( &_tmp_dt, &gmdt );
613 if (!(attr & DBI_DATETIME_DATE)) {
614 strftime(dt_string, 255, "%T", &gmdt);
615 } else if (!(attr & DBI_DATETIME_TIME)) {
616 strftime(dt_string, 255, "%F", &gmdt);
618 /* XXX ARG! My eyes! The goggles, they do nothing! */
620 strftime(dt_string, 255, "%FT%T%z", &gmdt);
623 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
627 case DBI_TYPE_BINARY :
628 osrfLogError( OSRF_LOG_MARK,
629 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);