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"
13 #include <libxml/globals.h>
14 #include <libxml/xmlerror.h>
15 #include <libxml/parser.h>
16 #include <libxml/tree.h>
17 #include <libxml/debugXML.h>
18 #include <libxml/xmlmemory.h>
19 //#include <openils/fieldmapper_lookup.h>
21 #define OILS_AUTH_CACHE_PRFX "oils_cstore_"
22 #define MODULENAME "open-ils.cstore"
23 #define PERSIST_NS "http://open-ils.org/spec/opensrf/IDL/persistance/v1"
24 #define OBJECT_NS "http://open-ils.org/spec/opensrf/IDL/objects/v1"
25 #define BASE_NS "http://opensrf.org/spec/IDL/base/v1"
27 int osrfAppChildInit();
28 int osrfAppInitialize();
30 int dispatchCRUDMethod ( osrfMethodContext* ctx );
31 jsonObject* doCreate ( osrfHash* metadata, jsonObject* params );
32 jsonObject* doRetrieve ( osrfHash* metadata, jsonObject* params );
33 jsonObject* doUpdate ( osrfHash* metadata, jsonObject* params );
34 jsonObject* doDelete ( osrfHash* metadata, jsonObject* params );
35 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta);
37 dbi_conn dbhandle; /* our db connection */
38 xmlDocPtr idlDoc = NULL; // parse and store the IDL here
41 /* parse and store the IDL here */
44 /* handy NULL json object to have around */
45 static jsonObject* oilsNULL = NULL;
47 int osrfAppInitialize() {
49 idlHash = osrfNewHash();
51 osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
52 osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
54 char * idl_filename = osrf_settings_host_value("/apps/%s/app_settings/IDL", MODULENAME);
55 osrfLogInfo(OSRF_LOG_MARK, "Found file:");
56 osrfLogInfo(OSRF_LOG_MARK, idl_filename);
58 osrfLogInfo(OSRF_LOG_MARK, "Parsing the IDL XML...");
59 idlDoc = xmlReadFile( idl_filename, NULL, XML_PARSE_XINCLUDE );
62 osrfLogError(OSRF_LOG_MARK, "Could not load or parse the IDL XML file!");
66 osrfLogInfo(OSRF_LOG_MARK, "...IDL XML parsed");
68 osrfStringArray* global_methods = osrfNewStringArray(1);
70 //osrfStringArrayAdd( global_methods, "create" );
71 osrfStringArrayAdd( global_methods, "retrieve" );
72 //osrfStringArrayAdd( global_methods, "update" );
73 //osrfStringArrayAdd( global_methods, "delete" );
75 xmlNodePtr docRoot = xmlDocGetRootElement(idlDoc);
76 xmlNodePtr kid = docRoot->children;
78 if (!strcmp( (char*)kid->name, "class" )) {
81 while ( (method_type = osrfStringArrayGetString(global_methods, i++)) ) {
83 osrfHash * usrData = osrfNewHash();
84 osrfHashSet( usrData, xmlGetProp(kid, "id"), "classname");
85 osrfHashSet( usrData, xmlGetNsProp(kid, "tablename", PERSIST_NS), "tablename");
86 osrfHashSet( usrData, xmlGetNsProp(kid, "fieldmapper", OBJECT_NS), "fieldmapper");
88 if(!strcmp(method_type, "retrieve"))
89 osrfHashSet( idlHash, usrData, (char*)osrfHashGet(usrData, "classname") );
91 osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", osrfHashGet(usrData, "fieldmapper") );
94 osrfHash* links = osrfNewHash();
95 osrfHash* fields = osrfNewHash();
97 osrfHashSet( usrData, fields, "fields" );
98 osrfHashSet( usrData, links, "links" );
100 xmlNodePtr _cur = kid->children;
103 char* string_tmp = NULL;
105 if (!strcmp( (char*)_cur->name, "fields" )) {
107 if( (string_tmp = (char*)xmlGetNsProp(_cur, "primary", PERSIST_NS)) ) {
110 strdup( string_tmp ),
116 xmlNodePtr _f = _cur->children;
119 if (strcmp( (char*)_f->name, "field" )) {
124 _tmp = osrfNewHash();
126 if( (string_tmp = (char*)xmlGetNsProp(_f, "array_position", OBJECT_NS)) ) {
129 strdup( string_tmp ),
135 if( (string_tmp = (char*)xmlGetNsProp(_f, "virtual", PERSIST_NS)) ) {
138 strdup( string_tmp ),
144 if( (string_tmp = (char*)xmlGetProp(_f, "name")) ) {
147 strdup( string_tmp ),
152 osrfLogInfo(OSRF_LOG_MARK, "Found field %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
163 if (!strcmp( (char*)_cur->name, "links" )) {
164 xmlNodePtr _l = _cur->children;
167 if (strcmp( (char*)_l->name, "link" )) {
172 _tmp = osrfNewHash();
174 if( (string_tmp = (char*)xmlGetProp(_l, "reltype")) ) {
177 strdup( string_tmp ),
181 osrfLogInfo(OSRF_LOG_MARK, "Adding link with reltype %s", string_tmp );
184 if( (string_tmp = (char*)xmlGetProp(_l, "key")) ) {
187 strdup( string_tmp ),
191 osrfLogInfo(OSRF_LOG_MARK, "Link fkey is %s", string_tmp );
194 if( (string_tmp = (char*)xmlGetProp(_l, "class")) ) {
197 strdup( string_tmp ),
201 osrfLogInfo(OSRF_LOG_MARK, "Link fclass is %s", string_tmp );
204 osrfStringArray* map = osrfNewStringArray(0);
206 if( (string_tmp = (char*)xmlGetProp(_l, "map") )) {
207 char* map_list = strdup( string_tmp );
208 osrfLogInfo(OSRF_LOG_MARK, "Link mapping list is %s", string_tmp );
210 if (strlen( map_list ) > 0) {
212 char* _map_class = strtok_r(map_list, " ", &st_tmp);
213 osrfStringArrayAdd(map, strdup(_map_class));
215 while ((_map_class = strtok_r(NULL, " ", &st_tmp))) {
216 osrfStringArrayAdd(map, strdup(_map_class));
220 osrfHashSet( _tmp, map, "map");
222 if( (string_tmp = (char*)xmlGetProp(_l, "field")) ) {
225 strdup( string_tmp ),
236 osrfLogInfo(OSRF_LOG_MARK, "Found link %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
248 if (!osrfHashGet(usrData, "fieldmapper")) continue;
250 _fm = strdup( (char*)osrfHashGet(usrData, "fieldmapper") );
251 char* part = strtok_r(_fm, ":", &st_tmp);
253 growing_buffer* method_name = buffer_init(64);
254 buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
256 while ((part = strtok_r(NULL, ":", &st_tmp))) {
257 buffer_fadd(method_name, ".%s", part);
259 buffer_fadd(method_name, ".%s", method_type);
261 char* method = buffer_data(method_name);
262 buffer_free(method_name);
264 osrfHashSet( usrData, method, "methodname" );
265 osrfHashSet( usrData, strdup(method_type), "methodtype" );
267 osrfAppRegisterExtendedMethod(
270 "dispatchCRUDMethod",
285 * Connects to the database
287 int osrfAppChildInit() {
289 osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
290 dbi_initialize(NULL);
291 osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
293 char* driver = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
294 char* user = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
295 char* host = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
296 char* port = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
297 char* db = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
298 char* pw = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
300 osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
301 dbhandle = dbi_conn_new(driver);
304 osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
307 osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
309 osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database. host=%s, "
310 "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
312 if(host) dbi_conn_set_option(dbhandle, "host", host );
313 if(port) dbi_conn_set_option_numeric( dbhandle, "port", atoi(port) );
314 if(user) dbi_conn_set_option(dbhandle, "username", user);
315 if(pw) dbi_conn_set_option(dbhandle, "password", pw );
316 if(db) dbi_conn_set_option(dbhandle, "dbname", db );
325 if (dbi_conn_connect(dbhandle) < 0) {
326 dbi_conn_error(dbhandle, &err);
327 osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
331 osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
337 osrfStringArray* classes = osrfHashKeys( idlHash );
339 while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
340 osrfHash* class = osrfHashGet( idlHash, classname );
341 osrfHash* fields = osrfHashGet( class, "fields" );
343 growing_buffer* sql_buf = buffer_init(32);
344 buffer_fadd( sql_buf, "SELECT * FROM %s WHERE 1=0;", osrfHashGet(class, "tablename") );
346 char* sql = buffer_data(sql_buf);
347 buffer_free(sql_buf);
348 osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
350 dbi_result result = dbi_conn_query(dbhandle, sql);
356 const char* columnName;
358 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
360 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
362 /* fetch the fieldmapper index */
363 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
365 osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
367 /* determine the field type and storage attributes */
368 type = dbi_result_get_field_type(result, columnName);
369 attr = dbi_result_get_field_attribs(result, columnName);
373 case DBI_TYPE_INTEGER :
375 osrfHashSet(_f,"number", "primitive");
377 if( attr & DBI_INTEGER_SIZE8 )
378 osrfHashSet(_f,"INT8", "datatype");
380 osrfHashSet(_f,"INT", "datatype");
383 case DBI_TYPE_DECIMAL :
384 osrfHashSet(_f,"number", "primitive");
385 osrfHashSet(_f,"NUMERIC", "datatype");
388 case DBI_TYPE_STRING :
389 osrfHashSet(_f,"string", "primitive");
390 osrfHashSet(_f,"TEXT", "datatype");
393 case DBI_TYPE_DATETIME :
394 osrfHashSet(_f,"string", "primitive");
395 osrfHashSet(_f,"TIMESTAMP", "datatype");
398 case DBI_TYPE_BINARY :
399 osrfHashSet(_f,"string", "primitive");
400 osrfHashSet(_f,"BYTEA", "datatype");
405 "Setting [%s] to primitive [%s] and datatype [%s]...",
407 osrfHashGet(_f, "primitive"),
408 osrfHashGet(_f, "datatype")
412 dbi_result_free(result);
414 osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
418 osrfStringArrayFree(classes);
424 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
425 OSRF_METHOD_VERIFY_CONTEXT(ctx);
427 osrfHash* meta = (osrfHash*) ctx->method->userData;
429 jsonObject * obj = NULL;
430 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "create"))
431 obj = doCreate(meta, ctx->params);
433 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "retrieve"))
434 obj = doRetrieve(meta, ctx->params);
436 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "update"))
437 obj = doUpdate(meta, ctx->params);
439 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "delete"))
440 obj = doDelete(meta, ctx->params);
442 osrfAppRespondComplete( ctx, obj );
449 jsonObject* doCreate( osrfHash* meta, jsonObject* params ) { return NULL; }
451 jsonObject* doRetrieve( osrfHash* meta, jsonObject* params ) {
453 char* id = jsonObjectToSimpleString(jsonObjectGetIndex(params, 0));
457 "%s retrieving %s object with id %s",
459 osrfHashGet(meta, "fieldmapper"),
465 growing_buffer* sql_buf = buffer_init(128);
468 "SELECT * FROM %s WHERE %s = %d;",
469 osrfHashGet(meta, "tablename"),
470 osrfHashGet(meta, "primarykey"),
474 char* sql = buffer_data(sql_buf);
475 buffer_free(sql_buf);
477 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
479 dbi_result result = dbi_conn_query(dbhandle, sql);
481 jsonObject* obj = NULL;
484 /* there should be one row at the most */
485 if (!dbi_result_first_row(result)) {
486 osrfLogDebug(OSRF_LOG_MARK, "%s: Error retrieving %s with key %s", MODULENAME, osrfHashGet(meta, "fieldmapper"), id);
487 dbi_result_free(result);
491 /* JSONify the result */
492 obj = oilsMakeJSONFromResult( result, meta );
494 /* clean up the query */
495 dbi_result_free(result);
498 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
507 jsonObject* doUpdate( osrfHash* meta, jsonObject* params ) { return NULL; }
509 jsonObject* doDelete( osrfHash* meta, jsonObject* params ) { return NULL; }
512 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta) {
513 if(!(result && meta)) return NULL;
515 jsonObject* object = jsonParseString("[]");
516 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
518 osrfHash* fields = osrfHashGet(meta, "fields");
520 osrfLogDebug(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
530 const char* columnName;
532 /* cycle through the column list */
533 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
535 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
537 fmIndex = -1; // reset the position
539 /* determine the field type and storage attributes */
540 type = dbi_result_get_field_type(result, columnName);
541 attr = dbi_result_get_field_attribs(result, columnName);
543 /* fetch the fieldmapper index */
544 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
545 char* virt = (char*)osrfHashGet(_f, "virtual");
546 char* pos = (char*)osrfHashGet(_f, "array_position");
548 if ( !virt || !pos || !(strcmp( virt, "true" )) ) continue;
550 fmIndex = atoi( pos );
551 osrfLogDebug(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
554 if (dbi_result_field_is_null(result, columnName)) {
555 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
560 case DBI_TYPE_INTEGER :
562 if( attr & DBI_INTEGER_SIZE8 )
563 jsonObjectSetIndex( object, fmIndex,
564 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
566 jsonObjectSetIndex( object, fmIndex,
567 jsonNewNumberObject(dbi_result_get_long(result, columnName)));
571 case DBI_TYPE_DECIMAL :
572 jsonObjectSetIndex( object, fmIndex,
573 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
576 case DBI_TYPE_STRING :
577 jsonObjectSetIndex( object, fmIndex,
578 jsonNewObject(dbi_result_get_string(result, columnName)));
581 case DBI_TYPE_DATETIME :
582 _tmp_dt = dbi_result_get_datetime(result, columnName);
584 struct tm* gmdt = gmtime_r( &_tmp_dt, &_tmp_tm );
585 _tmp_dt = mktime( gmdt );
586 gmdt = gmtime_r( &_tmp_dt, &_tmp_tm );
589 if (!(attr & DBI_DATETIME_DATE)) {
590 snprintf(dt_string, 255,
596 } else if (!(attr & DBI_DATETIME_TIME)) {
597 snprintf(dt_string, 255,
599 gmdt->tm_year + 1900,
604 snprintf(dt_string, 255,
605 "%4d-%02d-%02dT%02d:%02d:%02dZ",
606 gmdt->tm_year + 1900,
615 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
619 case DBI_TYPE_BINARY :
620 osrfLogError( OSRF_LOG_MARK,
621 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);