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* );
37 time_t my_timegm (struct tm*);
39 dbi_conn dbhandle; /* our db connection */
40 xmlDocPtr idlDoc = NULL; // parse and store the IDL here
43 /* parse and store the IDL here */
46 /* handy NULL json object to have around */
47 static jsonObject* oilsNULL = NULL;
49 int osrfAppInitialize() {
51 idlHash = osrfNewHash();
53 osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
54 osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
56 char * idl_filename = osrf_settings_host_value("/apps/%s/app_settings/IDL", MODULENAME);
57 osrfLogInfo(OSRF_LOG_MARK, "Found file:");
58 osrfLogInfo(OSRF_LOG_MARK, idl_filename);
60 osrfLogInfo(OSRF_LOG_MARK, "Parsing the IDL XML...");
61 idlDoc = xmlReadFile( idl_filename, NULL, XML_PARSE_XINCLUDE );
64 osrfLogError(OSRF_LOG_MARK, "Could not load or parse the IDL XML file!");
68 osrfLogInfo(OSRF_LOG_MARK, "...IDL XML parsed");
70 osrfStringArray* global_methods = osrfNewStringArray(1);
72 //osrfStringArrayAdd( global_methods, "create" );
73 osrfStringArrayAdd( global_methods, "retrieve" );
74 //osrfStringArrayAdd( global_methods, "update" );
75 //osrfStringArrayAdd( global_methods, "delete" );
77 xmlNodePtr docRoot = xmlDocGetRootElement(idlDoc);
78 xmlNodePtr kid = docRoot->children;
80 if (!strcmp( (char*)kid->name, "class" )) {
83 while ( (method_type = osrfStringArrayGetString(global_methods, i++)) ) {
85 osrfHash * usrData = osrfNewHash();
86 osrfHashSet( usrData, xmlGetProp(kid, "id"), "classname");
87 osrfHashSet( usrData, xmlGetNsProp(kid, "tablename", PERSIST_NS), "tablename");
88 osrfHashSet( usrData, xmlGetNsProp(kid, "fieldmapper", OBJECT_NS), "fieldmapper");
90 if(!strcmp(method_type, "retrieve"))
91 osrfHashSet( idlHash, usrData, (char*)osrfHashGet(usrData, "classname") );
93 osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", osrfHashGet(usrData, "fieldmapper") );
96 osrfHash* links = osrfNewHash();
97 osrfHash* fields = osrfNewHash();
99 osrfHashSet( usrData, fields, "fields" );
100 osrfHashSet( usrData, links, "links" );
102 xmlNodePtr _cur = kid->children;
105 char* string_tmp = NULL;
107 if (!strcmp( (char*)_cur->name, "fields" )) {
109 if( (string_tmp = (char*)xmlGetNsProp(_cur, "primary", PERSIST_NS)) ) {
112 strdup( string_tmp ),
118 xmlNodePtr _f = _cur->children;
121 if (strcmp( (char*)_f->name, "field" )) {
126 _tmp = osrfNewHash();
128 if( (string_tmp = (char*)xmlGetNsProp(_f, "array_position", OBJECT_NS)) ) {
131 strdup( string_tmp ),
137 if( (string_tmp = (char*)xmlGetNsProp(_f, "virtual", PERSIST_NS)) ) {
140 strdup( string_tmp ),
146 if( (string_tmp = (char*)xmlGetProp(_f, "name")) ) {
149 strdup( string_tmp ),
154 osrfLogInfo(OSRF_LOG_MARK, "Found field %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
165 if (!strcmp( (char*)_cur->name, "links" )) {
166 xmlNodePtr _l = _cur->children;
169 if (strcmp( (char*)_l->name, "link" )) {
174 _tmp = osrfNewHash();
176 if( (string_tmp = (char*)xmlGetProp(_l, "reltype")) ) {
179 strdup( string_tmp ),
183 osrfLogInfo(OSRF_LOG_MARK, "Adding link with reltype %s", string_tmp );
186 if( (string_tmp = (char*)xmlGetProp(_l, "key")) ) {
189 strdup( string_tmp ),
193 osrfLogInfo(OSRF_LOG_MARK, "Link fkey is %s", string_tmp );
196 if( (string_tmp = (char*)xmlGetProp(_l, "class")) ) {
199 strdup( string_tmp ),
203 osrfLogInfo(OSRF_LOG_MARK, "Link fclass is %s", string_tmp );
206 osrfStringArray* map = osrfNewStringArray(0);
208 if( (string_tmp = (char*)xmlGetProp(_l, "map") )) {
209 char* map_list = strdup( string_tmp );
210 osrfLogInfo(OSRF_LOG_MARK, "Link mapping list is %s", string_tmp );
212 if (strlen( map_list ) > 0) {
214 char* _map_class = strtok_r(map_list, " ", &st_tmp);
215 osrfStringArrayAdd(map, strdup(_map_class));
217 while ((_map_class = strtok_r(NULL, " ", &st_tmp))) {
218 osrfStringArrayAdd(map, strdup(_map_class));
222 osrfHashSet( _tmp, map, "map");
224 if( (string_tmp = (char*)xmlGetProp(_l, "field")) ) {
227 strdup( string_tmp ),
238 osrfLogInfo(OSRF_LOG_MARK, "Found link %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
250 if (!osrfHashGet(usrData, "fieldmapper")) continue;
252 _fm = strdup( (char*)osrfHashGet(usrData, "fieldmapper") );
253 char* part = strtok_r(_fm, ":", &st_tmp);
255 growing_buffer* method_name = buffer_init(64);
256 buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
258 while ((part = strtok_r(NULL, ":", &st_tmp))) {
259 buffer_fadd(method_name, ".%s", part);
261 buffer_fadd(method_name, ".%s", method_type);
263 char* method = buffer_data(method_name);
264 buffer_free(method_name);
266 osrfHashSet( usrData, method, "methodname" );
267 osrfHashSet( usrData, strdup(method_type), "methodtype" );
269 osrfAppRegisterExtendedMethod(
272 "dispatchCRUDMethod",
287 * Connects to the database
289 int osrfAppChildInit() {
291 osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
292 dbi_initialize(NULL);
293 osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
295 char* driver = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
296 char* user = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
297 char* host = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
298 char* port = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
299 char* db = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
300 char* pw = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
302 osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
303 dbhandle = dbi_conn_new(driver);
306 osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
309 osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
311 osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database. host=%s, "
312 "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
314 if(host) dbi_conn_set_option(dbhandle, "host", host );
315 if(port) dbi_conn_set_option_numeric( dbhandle, "port", atoi(port) );
316 if(user) dbi_conn_set_option(dbhandle, "username", user);
317 if(pw) dbi_conn_set_option(dbhandle, "password", pw );
318 if(db) dbi_conn_set_option(dbhandle, "dbname", db );
327 if (dbi_conn_connect(dbhandle) < 0) {
328 dbi_conn_error(dbhandle, &err);
329 osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
333 osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
339 osrfStringArray* classes = osrfHashKeys( idlHash );
341 while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
342 osrfHash* class = osrfHashGet( idlHash, classname );
343 osrfHash* fields = osrfHashGet( class, "fields" );
345 growing_buffer* sql_buf = buffer_init(32);
346 buffer_fadd( sql_buf, "SELECT * FROM %s WHERE 1=0;", osrfHashGet(class, "tablename") );
348 char* sql = buffer_data(sql_buf);
349 buffer_free(sql_buf);
350 osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
352 dbi_result result = dbi_conn_query(dbhandle, sql);
358 const char* columnName;
360 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
362 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
364 /* fetch the fieldmapper index */
365 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
367 osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
369 /* determine the field type and storage attributes */
370 type = dbi_result_get_field_type(result, columnName);
371 attr = dbi_result_get_field_attribs(result, columnName);
375 case DBI_TYPE_INTEGER :
377 osrfHashSet(_f,"number", "primitive");
379 if( attr & DBI_INTEGER_SIZE8 )
380 osrfHashSet(_f,"INT8", "datatype");
382 osrfHashSet(_f,"INT", "datatype");
385 case DBI_TYPE_DECIMAL :
386 osrfHashSet(_f,"number", "primitive");
387 osrfHashSet(_f,"NUMERIC", "datatype");
390 case DBI_TYPE_STRING :
391 osrfHashSet(_f,"string", "primitive");
392 osrfHashSet(_f,"TEXT", "datatype");
395 case DBI_TYPE_DATETIME :
396 osrfHashSet(_f,"string", "primitive");
397 osrfHashSet(_f,"TIMESTAMP", "datatype");
400 case DBI_TYPE_BINARY :
401 osrfHashSet(_f,"string", "primitive");
402 osrfHashSet(_f,"BYTEA", "datatype");
407 "Setting [%s] to primitive [%s] and datatype [%s]...",
409 osrfHashGet(_f, "primitive"),
410 osrfHashGet(_f, "datatype")
414 dbi_result_free(result);
416 osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
420 osrfStringArrayFree(classes);
426 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
427 OSRF_METHOD_VERIFY_CONTEXT(ctx);
429 osrfHash* meta = (osrfHash*) ctx->method->userData;
431 jsonObject * obj = NULL;
432 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "create"))
433 obj = doCreate(meta, ctx->params);
435 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "retrieve"))
436 obj = doRetrieve(meta, ctx->params);
438 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "update"))
439 obj = doUpdate(meta, ctx->params);
441 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "delete"))
442 obj = doDelete(meta, ctx->params);
444 osrfAppRespondComplete( ctx, obj );
451 jsonObject* doCreate( osrfHash* meta, jsonObject* params ) { return NULL; }
453 jsonObject* doRetrieve( osrfHash* meta, jsonObject* params ) {
455 char* id = jsonObjectToSimpleString(jsonObjectGetIndex(params, 0));
459 "%s retrieving %s object with id %s",
461 osrfHashGet(meta, "fieldmapper"),
467 growing_buffer* sql_buf = buffer_init(128);
470 "SELECT * FROM %s WHERE %s = %d;",
471 osrfHashGet(meta, "tablename"),
472 osrfHashGet(meta, "primarykey"),
476 char* sql = buffer_data(sql_buf);
477 buffer_free(sql_buf);
479 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
481 dbi_result result = dbi_conn_query(dbhandle, sql);
483 jsonObject* obj = NULL;
486 /* there should be one row at the most */
487 if (!dbi_result_first_row(result)) {
488 osrfLogDebug(OSRF_LOG_MARK, "%s: Error retrieving %s with key %s", MODULENAME, osrfHashGet(meta, "fieldmapper"), id);
489 dbi_result_free(result);
493 /* JSONify the result */
494 obj = oilsMakeJSONFromResult( result, meta );
496 /* clean up the query */
497 dbi_result_free(result);
500 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
509 jsonObject* doUpdate( osrfHash* meta, jsonObject* params ) { return NULL; }
511 jsonObject* doDelete( osrfHash* meta, jsonObject* params ) { return NULL; }
514 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta) {
515 if(!(result && meta)) return NULL;
517 jsonObject* object = jsonParseString("[]");
518 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
520 osrfHash* fields = osrfHashGet(meta, "fields");
522 osrfLogDebug(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
533 const char* columnName;
536 /* cycle through the column list */
537 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
539 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
541 fmIndex = -1; // reset the position
543 /* determine the field type and storage attributes */
544 type = dbi_result_get_field_type(result, columnName);
545 attr = dbi_result_get_field_attribs(result, columnName);
547 /* fetch the fieldmapper index */
548 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
549 char* virt = (char*)osrfHashGet(_f, "virtual");
550 char* pos = (char*)osrfHashGet(_f, "array_position");
552 if ( !virt || !pos || !(strcmp( virt, "true" )) ) continue;
554 fmIndex = atoi( pos );
555 osrfLogDebug(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
558 if (dbi_result_field_is_null(result, columnName)) {
559 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
564 case DBI_TYPE_INTEGER :
566 if( attr & DBI_INTEGER_SIZE8 )
567 jsonObjectSetIndex( object, fmIndex,
568 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
570 jsonObjectSetIndex( object, fmIndex,
571 jsonNewNumberObject(dbi_result_get_long(result, columnName)));
575 case DBI_TYPE_DECIMAL :
576 jsonObjectSetIndex( object, fmIndex,
577 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
580 case DBI_TYPE_STRING :
582 str = dbi_result_get_string(result, columnName);
584 if ( !(strcmp(str,"t")) ) {
585 jsonObjectSetIndex( object, fmIndex, jsonNewNumberObject(1) );
586 } else if ( !(strcmp(str,"f")) ) {
587 jsonObjectSetIndex( object, fmIndex, jsonNewNumberObject(0) );
589 jsonObjectSetIndex( object, fmIndex, jsonNewObject( str ));
593 case DBI_TYPE_DATETIME :
595 _tmp_dt = dbi_result_get_datetime(result, columnName);
597 struct tm* gmdt = gmtime( &_tmp_dt );
599 if (!(attr & DBI_DATETIME_TIME)) {
600 strftime(dt_string, 255, "%F", gmdt);
601 } else if (!(attr & DBI_DATETIME_DATE)) {
602 strftime(dt_string, 255, "%T", gmdt);
604 /* XXX ARG! My eyes! The goggles, they do nothing! */
607 strftime(tmp_time, 255, "%FT%T", gmdt);
609 time_t tmp_t = time(NULL);
610 struct tm* ldt = localtime( &tmp_t );
613 strftime(tz_part,7,"%z",ldt);
614 tz_part[5] = tz_part[4];
615 tz_part[4] = tz_part[3];
618 snprintf(dt_string, 255, "%s%s", tmp_time, tz_part);
621 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
625 case DBI_TYPE_BINARY :
626 osrfLogError( OSRF_LOG_MARK,
627 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);