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"
12 #include <libxml/globals.h>
13 #include <libxml/xmlerror.h>
14 #include <libxml/parser.h>
15 #include <libxml/tree.h>
16 #include <libxml/debugXML.h>
17 #include <libxml/xmlmemory.h>
18 //#include <openils/fieldmapper_lookup.h>
20 #define OILS_AUTH_CACHE_PRFX "oils_cstore_"
21 #define MODULENAME "open-ils.cstore"
22 #define PERSIST_NS "http://open-ils.org/spec/opensrf/IDL/persistance/v1"
23 #define OBJECT_NS "http://open-ils.org/spec/opensrf/IDL/objects/v1"
24 #define BASE_NS "http://opensrf.org/spec/IDL/base/v1"
26 int osrfAppChildInit();
27 int osrfAppInitialize();
29 int dispatchCRUDMethod ( osrfMethodContext* ctx );
30 jsonObject* doCreate ( osrfHash* metadata, jsonObject* params );
31 jsonObject* doRetrieve ( osrfHash* metadata, jsonObject* params );
32 jsonObject* doUpdate ( osrfHash* metadata, jsonObject* params );
33 jsonObject* doDelete ( osrfHash* metadata, jsonObject* params );
34 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta);
36 dbi_conn dbhandle; /* our db connection */
37 xmlDocPtr idlDoc = NULL; // parse and store the IDL here
40 /* parse and store the IDL here */
43 /* handy NULL json object to have around */
44 static jsonObject* oilsNULL = NULL;
46 int osrfAppInitialize() {
48 idlHash = osrfNewHash();
50 osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
51 osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
53 char * idl_filename = osrf_settings_host_value("/apps/%s/app_settings/IDL", MODULENAME);
54 osrfLogInfo(OSRF_LOG_MARK, "Found file:");
55 osrfLogInfo(OSRF_LOG_MARK, idl_filename);
57 osrfLogInfo(OSRF_LOG_MARK, "Parsing the IDL XML...");
58 idlDoc = xmlReadFile( idl_filename, NULL, XML_PARSE_XINCLUDE );
61 osrfLogError(OSRF_LOG_MARK, "Could not load or parse the IDL XML file!");
65 osrfLogInfo(OSRF_LOG_MARK, "...IDL XML parsed");
67 osrfStringArray* global_methods = osrfNewStringArray(1);
69 //osrfStringArrayAdd( global_methods, "create" );
70 osrfStringArrayAdd( global_methods, "retrieve" );
71 //osrfStringArrayAdd( global_methods, "update" );
72 //osrfStringArrayAdd( global_methods, "delete" );
74 xmlNodePtr docRoot = xmlDocGetRootElement(idlDoc);
75 xmlNodePtr kid = docRoot->children;
77 if (!strcmp( (char*)kid->name, "class" )) {
80 while ( (method_type = osrfStringArrayGetString(global_methods, i++)) ) {
82 osrfHash * usrData = osrfNewHash();
83 osrfHashSet( usrData, xmlGetProp(kid, "id"), "classname");
84 osrfHashSet( usrData, xmlGetNsProp(kid, "tablename", PERSIST_NS), "tablename");
85 osrfHashSet( usrData, xmlGetNsProp(kid, "fieldmapper", OBJECT_NS), "fieldmapper");
87 if(!strcmp(method_type, "retrieve"))
88 osrfHashSet( idlHash, usrData, (char*)osrfHashGet(usrData, "classname") );
90 osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", osrfHashGet(usrData, "fieldmapper") );
93 osrfHash* links = osrfNewHash();
94 osrfHash* fields = osrfNewHash();
96 osrfHashSet( usrData, fields, "fields" );
97 osrfHashSet( usrData, links, "links" );
99 xmlNodePtr _cur = kid->children;
102 char* string_tmp = NULL;
104 if (!strcmp( (char*)_cur->name, "fields" )) {
106 if( (string_tmp = (char*)xmlGetNsProp(_cur, "primary", PERSIST_NS)) ) {
109 strdup( string_tmp ),
115 xmlNodePtr _f = _cur->children;
118 if (strcmp( (char*)_f->name, "field" )) {
123 _tmp = osrfNewHash();
125 if( (string_tmp = (char*)xmlGetNsProp(_f, "array_position", OBJECT_NS)) ) {
128 strdup( string_tmp ),
134 if( (string_tmp = (char*)xmlGetNsProp(_f, "virtual", PERSIST_NS)) ) {
137 strdup( string_tmp ),
143 if( (string_tmp = (char*)xmlGetProp(_f, "name")) ) {
146 strdup( string_tmp ),
151 osrfLogInfo(OSRF_LOG_MARK, "Found field %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
162 if (!strcmp( (char*)_cur->name, "links" )) {
163 xmlNodePtr _l = _cur->children;
166 if (strcmp( (char*)_l->name, "link" )) {
171 _tmp = osrfNewHash();
173 if( (string_tmp = (char*)xmlGetProp(_l, "reltype")) ) {
176 strdup( string_tmp ),
180 osrfLogInfo(OSRF_LOG_MARK, "Adding link with reltype %s", string_tmp );
183 if( (string_tmp = (char*)xmlGetProp(_l, "key")) ) {
186 strdup( string_tmp ),
190 osrfLogInfo(OSRF_LOG_MARK, "Link fkey is %s", string_tmp );
193 if( (string_tmp = (char*)xmlGetProp(_l, "class")) ) {
196 strdup( string_tmp ),
200 osrfLogInfo(OSRF_LOG_MARK, "Link fclass is %s", string_tmp );
203 osrfStringArray* map = osrfNewStringArray(0);
205 if( (string_tmp = (char*)xmlGetProp(_l, "map") )) {
206 char* map_list = strdup( string_tmp );
207 osrfLogInfo(OSRF_LOG_MARK, "Link mapping list is %s", string_tmp );
209 if (strlen( map_list ) > 0) {
211 char* _map_class = strtok_r(map_list, " ", &st_tmp);
212 osrfStringArrayAdd(map, strdup(_map_class));
214 while ((_map_class = strtok_r(NULL, " ", &st_tmp))) {
215 osrfStringArrayAdd(map, strdup(_map_class));
219 osrfHashSet( _tmp, map, "map");
221 if( (string_tmp = (char*)xmlGetProp(_l, "field")) ) {
224 strdup( string_tmp ),
235 osrfLogInfo(OSRF_LOG_MARK, "Found link %s for class %s", string_tmp, osrfHashGet(usrData, "classname") );
247 if (!osrfHashGet(usrData, "fieldmapper")) continue;
249 _fm = strdup( (char*)osrfHashGet(usrData, "fieldmapper") );
250 char* part = strtok_r(_fm, ":", &st_tmp);
252 growing_buffer* method_name = buffer_init(64);
253 buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
255 while ((part = strtok_r(NULL, ":", &st_tmp))) {
256 buffer_fadd(method_name, ".%s", part);
258 buffer_fadd(method_name, ".%s", method_type);
260 char* method = buffer_data(method_name);
261 buffer_free(method_name);
263 osrfHashSet( usrData, method, "methodname" );
264 osrfHashSet( usrData, strdup(method_type), "methodtype" );
266 osrfAppRegisterExtendedMethod(
269 "dispatchCRUDMethod",
284 * Connects to the database
286 int osrfAppChildInit() {
288 osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
289 dbi_initialize(NULL);
290 osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
292 char* driver = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
293 char* user = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
294 char* host = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
295 char* port = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
296 char* db = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
297 char* pw = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
299 osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
300 dbhandle = dbi_conn_new(driver);
303 osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
306 osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
308 osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database. host=%s, "
309 "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
311 if(host) dbi_conn_set_option(dbhandle, "host", host );
312 if(port) dbi_conn_set_option_numeric( dbhandle, "port", atoi(port) );
313 if(user) dbi_conn_set_option(dbhandle, "username", user);
314 if(pw) dbi_conn_set_option(dbhandle, "password", pw );
315 if(db) dbi_conn_set_option(dbhandle, "dbname", db );
324 if (dbi_conn_connect(dbhandle) < 0) {
325 dbi_conn_error(dbhandle, &err);
326 osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
330 osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
336 osrfStringArray* classes = osrfHashKeys( idlHash );
338 while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
339 osrfHash* class = osrfHashGet( idlHash, classname );
340 osrfHash* fields = osrfHashGet( class, "fields" );
342 growing_buffer* sql_buf = buffer_init(32);
343 buffer_fadd( sql_buf, "SELECT * FROM %s WHERE 1=0;", osrfHashGet(class, "tablename") );
345 char* sql = buffer_data(sql_buf);
346 buffer_free(sql_buf);
347 osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
349 dbi_result result = dbi_conn_query(dbhandle, sql);
353 const char* columnName;
355 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
357 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
359 /* fetch the fieldmapper index */
360 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
362 osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
364 /* determine the field type and storage attributes */
365 type = dbi_result_get_field_type(result, columnName);
366 attr = dbi_result_get_field_attribs(result, columnName);
370 case DBI_TYPE_INTEGER :
372 osrfHashSet(_f,"number", "primative");
374 if( attr & DBI_INTEGER_SIZE8 )
375 osrfHashSet(_f,"INT8", "datatype");
377 osrfHashSet(_f,"INT", "datatype");
380 case DBI_TYPE_DECIMAL :
381 osrfHashSet(_f,"number", "primative");
382 osrfHashSet(_f,"NUMERIC", "datatype");
385 case DBI_TYPE_STRING :
386 osrfHashSet(_f,"string", "primative");
387 osrfHashSet(_f,"TEXT", "datatype");
390 case DBI_TYPE_DATETIME :
391 osrfHashSet(_f,"string", "primative");
392 osrfHashSet(_f,"TIMESTAMP", "datatype");
395 case DBI_TYPE_BINARY :
396 osrfHashSet(_f,"string", "primative");
397 osrfHashSet(_f,"BYTEA", "datatype");
402 "Setting [%s] to primitive [%s] and datatype [%s]...",
404 osrfHashGet(_f, "primitive"),
405 osrfHashGet(_f, "datatype")
410 dbi_result_free(result);
413 osrfStringArrayFree(classes);
419 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
420 OSRF_METHOD_VERIFY_CONTEXT(ctx);
422 osrfHash* meta = (osrfHash*) ctx->method->userData;
424 jsonObject * obj = NULL;
425 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "create"))
426 obj = doCreate(meta, ctx->params);
428 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "retrieve"))
429 obj = doRetrieve(meta, ctx->params);
431 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "update"))
432 obj = doUpdate(meta, ctx->params);
434 if (!strcmp( (char*)osrfHashGet(meta, "methodtype"), "delete"))
435 obj = doDelete(meta, ctx->params);
437 osrfAppRespondComplete( ctx, obj );
444 jsonObject* doCreate( osrfHash* meta, jsonObject* params ) { return NULL; }
446 jsonObject* doRetrieve( osrfHash* meta, jsonObject* params ) {
448 char* id = jsonObjectToSimpleString(jsonObjectGetIndex(params, 0));
452 "%s retrieving %s object with id %s",
454 osrfHashGet(meta, "fieldmapper"),
460 growing_buffer* sql_buf = buffer_init(128);
463 "SELECT * FROM %s WHERE %s = %d;",
464 osrfHashGet(meta, "tablename"),
465 osrfHashGet(meta, "primarykey"),
469 char* sql = buffer_data(sql_buf);
470 buffer_free(sql_buf);
472 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
474 dbi_result result = dbi_conn_query(dbhandle, sql);
476 jsonObject* obj = NULL;
479 /* there should be one row at the most */
480 if (!dbi_result_first_row(result)) {
481 osrfLogDebug(OSRF_LOG_MARK, "%s: Error retrieving %s with key %s", MODULENAME, osrfHashGet(meta, "fieldmapper"), id);
482 dbi_result_free(result);
486 /* JSONify the result */
487 obj = oilsMakeJSONFromResult( result, meta );
489 /* clean up the query */
490 dbi_result_free(result);
493 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
502 jsonObject* doUpdate( osrfHash* meta, jsonObject* params ) { return NULL; }
504 jsonObject* doDelete( osrfHash* meta, jsonObject* params ) { return NULL; }
507 jsonObject* oilsMakeJSONFromResult( dbi_result result, osrfHash* meta) {
508 if(!(result && meta)) return NULL;
510 jsonObject* object = jsonParseString("[]");
511 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
513 osrfHash* fields = osrfHashGet(meta, "fields");
515 osrfLogDebug(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
522 const char* columnName;
524 /* cycle through the column list */
525 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
527 osrfLogDebug(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
529 fmIndex = -1; // reset the position
531 /* determine the field type and storage attributes */
532 type = dbi_result_get_field_type(result, columnName);
533 attr = dbi_result_get_field_attribs(result, columnName);
535 /* fetch the fieldmapper index */
536 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
537 char* virt = (char*)osrfHashGet(_f, "virtual");
538 char* pos = (char*)osrfHashGet(_f, "array_position");
540 if ( !virt || !pos || !(strcmp( virt, "true" )) ) continue;
542 fmIndex = atoi( pos );
543 osrfLogDebug(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
548 case DBI_TYPE_INTEGER :
550 if( attr & DBI_INTEGER_SIZE8 )
551 jsonObjectSetIndex( object, fmIndex,
552 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
554 jsonObjectSetIndex( object, fmIndex,
555 jsonNewNumberObject(dbi_result_get_long(result, columnName)));
559 case DBI_TYPE_DECIMAL :
560 jsonObjectSetIndex( object, fmIndex,
561 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
564 case DBI_TYPE_STRING :
565 jsonObjectSetIndex( object, fmIndex,
566 jsonNewObject(dbi_result_get_string(result, columnName)));
569 case DBI_TYPE_DATETIME :
570 jsonObjectSetIndex( object, fmIndex,
571 jsonNewNumberObject(dbi_result_get_datetime(result, columnName)));
574 case DBI_TYPE_BINARY :
575 osrfLogError( OSRF_LOG_MARK,
576 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);