2 #include "opensrf/osrf_application.h"
3 #include "opensrf/osrf_settings.h"
4 #include "opensrf/osrf_message.h"
5 #include "opensrf/utils.h"
6 #include "opensrf/osrf_json.h"
7 #include "opensrf/log.h"
8 #include "openils/oils_utils.h"
17 # define MODULENAME "open-ils.reporter-store"
20 # define MODULENAME "open-ils.pcrud"
22 # define MODULENAME "open-ils.cstore"
27 #define DISABLE_I18N 2
28 #define SELECT_DISTINCT 1
32 int osrfAppChildInit();
33 int osrfAppInitialize();
34 void osrfAppChildExit();
36 static int verifyObjectClass ( osrfMethodContext*, const jsonObject* );
38 int beginTransaction ( osrfMethodContext* );
39 int commitTransaction ( osrfMethodContext* );
40 int rollbackTransaction ( osrfMethodContext* );
42 int setSavepoint ( osrfMethodContext* );
43 int releaseSavepoint ( osrfMethodContext* );
44 int rollbackSavepoint ( osrfMethodContext* );
46 int doJSONSearch ( osrfMethodContext* );
48 int dispatchCRUDMethod ( osrfMethodContext* );
49 static jsonObject* doCreate ( osrfMethodContext*, int* );
50 static jsonObject* doRetrieve ( osrfMethodContext*, int* );
51 static jsonObject* doUpdate ( osrfMethodContext*, int* );
52 static jsonObject* doDelete ( osrfMethodContext*, int* );
53 static jsonObject* doFieldmapperSearch ( osrfMethodContext*, osrfHash*,
54 const jsonObject*, int* );
55 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result, osrfHash* );
56 static jsonObject* oilsMakeJSONFromResult( dbi_result );
58 static char* searchSimplePredicate ( const char* op, const char* class,
59 osrfHash* field, const jsonObject* node );
60 static char* searchFunctionPredicate ( const char*, osrfHash*, const jsonObject*, const char* );
61 static char* searchFieldTransform ( const char*, osrfHash*, const jsonObject*);
62 static char* searchFieldTransformPredicate ( const char*, osrfHash*, const jsonObject*, const char* );
63 static char* searchBETWEENPredicate ( const char*, osrfHash*, const jsonObject* );
64 static char* searchINPredicate ( const char*, osrfHash*,
65 jsonObject*, const char*, osrfMethodContext* );
66 static char* searchPredicate ( const char*, osrfHash*, jsonObject*, osrfMethodContext* );
67 static char* searchJOIN ( const jsonObject*, osrfHash* );
68 static char* searchWHERE ( const jsonObject*, osrfHash*, int, osrfMethodContext* );
69 static char* buildSELECT ( jsonObject*, jsonObject*, osrfHash*, osrfMethodContext* );
71 char* SELECT ( osrfMethodContext*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, int );
73 void userDataFree( void* );
74 static void sessionDataFree( char*, void* );
75 static char* getSourceDefinition( osrfHash* );
76 static int str_is_true( const char* str );
77 static int obj_is_true( const jsonObject* obj );
78 static const char* json_type( int code );
79 static const char* get_primitive( osrfHash* field );
80 static const char* get_datatype( osrfHash* field );
81 static int is_identifier( const char* s);
82 static int is_good_operator( const char* op );
85 static jsonObject* verifyUserPCRUD( osrfMethodContext* );
86 static int verifyObjectPCRUD( osrfMethodContext*, const jsonObject* );
89 static int child_initialized = 0; /* boolean */
91 static dbi_conn writehandle; /* our MASTER db connection */
92 static dbi_conn dbhandle; /* our CURRENT db connection */
93 //static osrfHash * readHandles;
94 static jsonObject* jsonNULL = NULL; //
95 static int max_flesh_depth = 100;
97 /* called when this process is about to exit */
98 void osrfAppChildExit() {
99 osrfLogDebug(OSRF_LOG_MARK, "Child is exiting, disconnecting from database...");
102 if (writehandle == dbhandle) same = 1;
104 dbi_conn_query(writehandle, "ROLLBACK;");
105 dbi_conn_close(writehandle);
108 if (dbhandle && !same)
109 dbi_conn_close(dbhandle);
111 // XXX add cleanup of readHandles whenever that gets used
116 int osrfAppInitialize() {
118 osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
119 osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
121 if (!oilsIDLInit( osrf_settings_host_value("/IDL") )) return 1; /* return non-zero to indicate error */
123 growing_buffer* method_name = buffer_init(64);
125 // Generic search thingy
126 buffer_add(method_name, MODULENAME);
127 buffer_add(method_name, ".json_query");
128 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
129 "doJSONSearch", "", 1, OSRF_METHOD_STREAMING );
132 // first we register all the transaction and savepoint methods
133 buffer_reset(method_name);
134 OSRF_BUFFER_ADD(method_name, MODULENAME);
135 OSRF_BUFFER_ADD(method_name, ".transaction.begin");
136 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
137 "beginTransaction", "", 0, 0 );
139 buffer_reset(method_name);
140 OSRF_BUFFER_ADD(method_name, MODULENAME);
141 OSRF_BUFFER_ADD(method_name, ".transaction.commit");
142 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
143 "commitTransaction", "", 0, 0 );
145 buffer_reset(method_name);
146 OSRF_BUFFER_ADD(method_name, MODULENAME);
147 OSRF_BUFFER_ADD(method_name, ".transaction.rollback");
148 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
149 "rollbackTransaction", "", 0, 0 );
151 buffer_reset(method_name);
152 OSRF_BUFFER_ADD(method_name, MODULENAME);
153 OSRF_BUFFER_ADD(method_name, ".savepoint.set");
154 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
155 "setSavepoint", "", 1, 0 );
157 buffer_reset(method_name);
158 OSRF_BUFFER_ADD(method_name, MODULENAME);
159 OSRF_BUFFER_ADD(method_name, ".savepoint.release");
160 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
161 "releaseSavepoint", "", 1, 0 );
163 buffer_reset(method_name);
164 OSRF_BUFFER_ADD(method_name, MODULENAME);
165 OSRF_BUFFER_ADD(method_name, ".savepoint.rollback");
166 osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
167 "rollbackSavepoint", "", 1, 0 );
169 buffer_free(method_name);
171 static const char* global_method[] = {
179 const int global_method_count
180 = sizeof( global_method ) / sizeof ( global_method[0] );
184 osrfStringArray* classes = osrfHashKeys( oilsIDL() );
185 osrfLogDebug(OSRF_LOG_MARK, "%d classes loaded", classes->size );
186 osrfLogDebug(OSRF_LOG_MARK,
187 "At least %d methods will be generated", classes->size * global_method_count);
189 while ( (classname = osrfStringArrayGetString(classes, c_index++)) ) {
190 osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", classname);
192 osrfHash* idlClass = osrfHashGet(oilsIDL(), classname);
194 if (!osrfStringArrayContains( osrfHashGet(idlClass, "controller"), MODULENAME )) {
195 osrfLogInfo(OSRF_LOG_MARK, "%s is not listed as a controller for %s, moving on", MODULENAME, classname);
199 if ( str_is_true( osrfHashGet(idlClass, "virtual") ) ) {
200 osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
204 // Look up some other attributes of the current class
205 const char* idlClass_fieldmapper = osrfHashGet(idlClass, "fieldmapper");
206 const char* readonly = osrfHashGet(idlClass, "readonly");
208 osrfHash* idlClass_permacrud = osrfHashGet(idlClass, "permacrud");
212 for( i = 0; i < global_method_count; ++i ) {
213 const char* method_type = global_method[ i ];
214 osrfLogDebug(OSRF_LOG_MARK,
215 "Using files to build %s class methods for %s", method_type, classname);
217 if (!idlClass_fieldmapper) continue;
220 if (!idlClass_permacrud) continue;
222 const char* tmp_method = method_type;
223 if ( *tmp_method == 'i' || *tmp_method == 's') {
224 tmp_method = "retrieve";
226 if (!osrfHashGet( idlClass_permacrud, tmp_method )) continue;
229 if ( str_is_true( readonly ) &&
230 ( *method_type == 'c' || *method_type == 'u' || *method_type == 'd')
233 osrfHash* method_meta = osrfNewHash();
234 osrfHashSet(method_meta, idlClass, "class");
236 method_name = buffer_init(64);
238 buffer_fadd(method_name, "%s.%s.%s", MODULENAME, method_type, classname);
242 char* _fm = strdup( idlClass_fieldmapper );
243 part = strtok_r(_fm, ":", &st_tmp);
245 buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
247 while ((part = strtok_r(NULL, ":", &st_tmp))) {
248 OSRF_BUFFER_ADD_CHAR(method_name, '.');
249 OSRF_BUFFER_ADD(method_name, part);
251 OSRF_BUFFER_ADD_CHAR(method_name, '.');
252 OSRF_BUFFER_ADD(method_name, method_type);
256 char* method = buffer_release(method_name);
258 osrfHashSet( method_meta, method, "methodname" );
259 osrfHashSet( method_meta, strdup(method_type), "methodtype" );
262 if (*method_type == 'i' || *method_type == 's') {
263 flags = flags | OSRF_METHOD_STREAMING;
266 osrfAppRegisterExtendedMethod(
269 "dispatchCRUDMethod",
283 static char* getSourceDefinition( osrfHash* class ) {
285 char* tabledef = osrfHashGet(class, "tablename");
288 tabledef = strdup(tabledef);
290 tabledef = osrfHashGet(class, "source_definition");
292 growing_buffer* tablebuf = buffer_init(128);
293 buffer_fadd( tablebuf, "(%s)", tabledef );
294 tabledef = buffer_release(tablebuf);
296 const char* classname = osrfHashGet( class, "classname" );
301 "%s ERROR No tablename or source_definition for class \"%s\"",
312 * Connects to the database
314 int osrfAppChildInit() {
316 osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
317 dbi_initialize(NULL);
318 osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
320 char* driver = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
321 char* user = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
322 char* host = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
323 char* port = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
324 char* db = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
325 char* pw = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
326 char* md = osrf_settings_host_value("/apps/%s/app_settings/max_query_recursion", MODULENAME);
328 osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
329 writehandle = dbi_conn_new(driver);
332 osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
335 osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
337 osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database. host=%s, "
338 "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
340 if(host) dbi_conn_set_option(writehandle, "host", host );
341 if(port) dbi_conn_set_option_numeric( writehandle, "port", atoi(port) );
342 if(user) dbi_conn_set_option(writehandle, "username", user);
343 if(pw) dbi_conn_set_option(writehandle, "password", pw );
344 if(db) dbi_conn_set_option(writehandle, "dbname", db );
346 if(md) max_flesh_depth = atoi(md);
347 if(max_flesh_depth < 0) max_flesh_depth = 1;
348 if(max_flesh_depth > 1000) max_flesh_depth = 1000;
357 if (dbi_conn_connect(writehandle) < 0) {
359 if (dbi_conn_connect(writehandle) < 0) {
360 dbi_conn_error(writehandle, &err);
361 osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
366 osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
371 osrfStringArray* classes = osrfHashKeys( oilsIDL() );
373 while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
374 osrfHash* class = osrfHashGet( oilsIDL(), classname );
375 osrfHash* fields = osrfHashGet( class, "fields" );
377 if( str_is_true( osrfHashGet(class, "virtual") ) ) {
378 osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
382 char* tabledef = getSourceDefinition(class);
384 tabledef = strdup( "(null)" );
386 growing_buffer* sql_buf = buffer_init(32);
387 buffer_fadd( sql_buf, "SELECT * FROM %s AS x WHERE 1=0;", tabledef );
391 char* sql = buffer_release(sql_buf);
392 osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
394 dbi_result result = dbi_conn_query(writehandle, sql);
400 const char* columnName;
402 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
404 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
406 /* fetch the fieldmapper index */
407 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
409 osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
411 /* determine the field type and storage attributes */
412 type = dbi_result_get_field_type(result, columnName);
416 case DBI_TYPE_INTEGER : {
418 if ( !osrfHashGet(_f, "primitive") )
419 osrfHashSet(_f,"number", "primitive");
421 int attr = dbi_result_get_field_attribs(result, columnName);
422 if( attr & DBI_INTEGER_SIZE8 )
423 osrfHashSet(_f,"INT8", "datatype");
425 osrfHashSet(_f,"INT", "datatype");
428 case DBI_TYPE_DECIMAL :
429 if ( !osrfHashGet(_f, "primitive") )
430 osrfHashSet(_f,"number", "primitive");
432 osrfHashSet(_f,"NUMERIC", "datatype");
435 case DBI_TYPE_STRING :
436 if ( !osrfHashGet(_f, "primitive") )
437 osrfHashSet(_f,"string", "primitive");
438 osrfHashSet(_f,"TEXT", "datatype");
441 case DBI_TYPE_DATETIME :
442 if ( !osrfHashGet(_f, "primitive") )
443 osrfHashSet(_f,"string", "primitive");
445 osrfHashSet(_f,"TIMESTAMP", "datatype");
448 case DBI_TYPE_BINARY :
449 if ( !osrfHashGet(_f, "primitive") )
450 osrfHashSet(_f,"string", "primitive");
452 osrfHashSet(_f,"BYTEA", "datatype");
457 "Setting [%s] to primitive [%s] and datatype [%s]...",
459 osrfHashGet(_f, "primitive"),
460 osrfHashGet(_f, "datatype")
464 dbi_result_free(result);
466 osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
470 osrfStringArrayFree(classes);
472 child_initialized = 1;
477 This function is a sleazy hack intended *only* for testing and
478 debugging. Any real server process should initialize the
479 database connection by calling osrfAppChildInit().
481 void set_cstore_dbi_conn( dbi_conn conn ) {
482 dbhandle = writehandle = conn;
485 void userDataFree( void* blob ) {
486 osrfHashFree( (osrfHash*)blob );
490 static void sessionDataFree( char* key, void* item ) {
491 if (!(strcmp(key,"xact_id"))) {
493 dbi_conn_query(writehandle, "ROLLBACK;");
500 int beginTransaction ( osrfMethodContext* ctx ) {
501 if(osrfMethodVerifyContext( ctx )) {
502 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
507 jsonObject* user = verifyUserPCRUD( ctx );
508 if (!user) return -1;
509 jsonObjectFree(user);
512 dbi_result result = dbi_conn_query(writehandle, "START TRANSACTION;");
514 osrfLogError(OSRF_LOG_MARK, "%s: Error starting transaction", MODULENAME );
515 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error starting transaction" );
518 jsonObject* ret = jsonNewObject(ctx->session->session_id);
519 osrfAppRespondComplete( ctx, ret );
522 if (!ctx->session->userData) {
523 ctx->session->userData = osrfNewHash();
524 osrfHashSetCallback((osrfHash*)ctx->session->userData, &sessionDataFree);
527 osrfHashSet( (osrfHash*)ctx->session->userData, strdup( ctx->session->session_id ), "xact_id" );
528 ctx->session->userDataFree = &userDataFree;
534 int setSavepoint ( osrfMethodContext* ctx ) {
535 if(osrfMethodVerifyContext( ctx )) {
536 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
543 jsonObject* user = verifyUserPCRUD( ctx );
544 if (!user) return -1;
545 jsonObjectFree(user);
548 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
549 osrfAppSessionStatus(
551 OSRF_STATUS_INTERNALSERVERERROR,
552 "osrfMethodException",
554 "No active transaction -- required for savepoints"
559 const char* spName = jsonObjectGetString(jsonObjectGetIndex(ctx->params, spNamePos));
561 dbi_result result = dbi_conn_queryf(writehandle, "SAVEPOINT \"%s\";", spName);
565 "%s: Error creating savepoint %s in transaction %s",
568 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
570 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
571 "osrfMethodException", ctx->request, "Error creating savepoint" );
574 jsonObject* ret = jsonNewObject(spName);
575 osrfAppRespondComplete( ctx, ret );
581 int releaseSavepoint ( osrfMethodContext* ctx ) {
582 if(osrfMethodVerifyContext( ctx )) {
583 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
590 jsonObject* user = verifyUserPCRUD( ctx );
591 if (!user) return -1;
592 jsonObjectFree(user);
595 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
596 osrfAppSessionStatus(
598 OSRF_STATUS_INTERNALSERVERERROR,
599 "osrfMethodException",
601 "No active transaction -- required for savepoints"
606 const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
608 dbi_result result = dbi_conn_queryf(writehandle, "RELEASE SAVEPOINT \"%s\";", spName);
612 "%s: Error releasing savepoint %s in transaction %s",
615 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
617 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
618 "osrfMethodException", ctx->request, "Error releasing savepoint" );
621 jsonObject* ret = jsonNewObject(spName);
622 osrfAppRespondComplete( ctx, ret );
628 int rollbackSavepoint ( osrfMethodContext* ctx ) {
629 if(osrfMethodVerifyContext( ctx )) {
630 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
637 jsonObject* user = verifyUserPCRUD( ctx );
638 if (!user) return -1;
639 jsonObjectFree(user);
642 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
643 osrfAppSessionStatus(
645 OSRF_STATUS_INTERNALSERVERERROR,
646 "osrfMethodException",
648 "No active transaction -- required for savepoints"
653 const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
655 dbi_result result = dbi_conn_queryf(writehandle, "ROLLBACK TO SAVEPOINT \"%s\";", spName);
659 "%s: Error rolling back savepoint %s in transaction %s",
662 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
664 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
665 "osrfMethodException", ctx->request, "Error rolling back savepoint" );
668 jsonObject* ret = jsonNewObject(spName);
669 osrfAppRespondComplete( ctx, ret );
675 int commitTransaction ( osrfMethodContext* ctx ) {
676 if(osrfMethodVerifyContext( ctx )) {
677 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
682 jsonObject* user = verifyUserPCRUD( ctx );
683 if (!user) return -1;
684 jsonObjectFree(user);
687 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
688 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "No active transaction to commit" );
692 dbi_result result = dbi_conn_query(writehandle, "COMMIT;");
694 osrfLogError(OSRF_LOG_MARK, "%s: Error committing transaction", MODULENAME );
695 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error committing transaction" );
698 osrfHashRemove(ctx->session->userData, "xact_id");
699 jsonObject* ret = jsonNewObject(ctx->session->session_id);
700 osrfAppRespondComplete( ctx, ret );
706 int rollbackTransaction ( osrfMethodContext* ctx ) {
707 if(osrfMethodVerifyContext( ctx )) {
708 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
713 jsonObject* user = verifyUserPCRUD( ctx );
714 if (!user) return -1;
715 jsonObjectFree(user);
718 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
719 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "No active transaction to roll back" );
723 dbi_result result = dbi_conn_query(writehandle, "ROLLBACK;");
725 osrfLogError(OSRF_LOG_MARK, "%s: Error rolling back transaction", MODULENAME );
726 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error rolling back transaction" );
729 osrfHashRemove(ctx->session->userData, "xact_id");
730 jsonObject* ret = jsonNewObject(ctx->session->session_id);
731 osrfAppRespondComplete( ctx, ret );
737 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
738 if(osrfMethodVerifyContext( ctx )) {
739 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
743 osrfHash* meta = (osrfHash*) ctx->method->userData;
744 osrfHash* class_obj = osrfHashGet( meta, "class" );
748 const char* methodtype = osrfHashGet(meta, "methodtype");
749 jsonObject * obj = NULL;
751 if (!strcmp(methodtype, "create")) {
752 obj = doCreate(ctx, &err);
753 osrfAppRespondComplete( ctx, obj );
755 else if (!strcmp(methodtype, "retrieve")) {
756 obj = doRetrieve(ctx, &err);
757 osrfAppRespondComplete( ctx, obj );
759 else if (!strcmp(methodtype, "update")) {
760 obj = doUpdate(ctx, &err);
761 osrfAppRespondComplete( ctx, obj );
763 else if (!strcmp(methodtype, "delete")) {
764 obj = doDelete(ctx, &err);
765 osrfAppRespondComplete( ctx, obj );
767 else if (!strcmp(methodtype, "search")) {
769 jsonObject* _p = jsonObjectClone( ctx->params );
772 _p = jsonParseString("[]");
773 jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 1)));
774 jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 2)));
777 obj = doFieldmapperSearch(ctx, class_obj, _p, &err);
783 jsonIterator* itr = jsonNewIterator( obj );
784 while ((cur = jsonIteratorNext( itr ))) {
786 if(!verifyObjectPCRUD(ctx, cur)) continue;
788 osrfAppRespond( ctx, cur );
790 jsonIteratorFree(itr);
791 osrfAppRespondComplete( ctx, NULL );
793 } else if (!strcmp(methodtype, "id_list")) {
795 jsonObject* _p = jsonObjectClone( ctx->params );
798 _p = jsonParseString("[]");
799 jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 1)));
800 jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 2)));
803 if (jsonObjectGetIndex( _p, 1 )) {
804 jsonObjectRemoveKey( jsonObjectGetIndex( _p, 1 ), "select" );
805 jsonObjectRemoveKey( jsonObjectGetIndex( _p, 1 ), "no_i18n" );
806 jsonObjectRemoveKey( jsonObjectGetIndex( _p, 1 ), "flesh" );
807 jsonObjectRemoveKey( jsonObjectGetIndex( _p, 1 ), "flesh_columns" );
809 jsonObjectSetIndex( _p, 1, jsonNewObjectType(JSON_HASH) );
812 jsonObjectSetKey( jsonObjectGetIndex( _p, 1 ), "no_i18n", jsonNewBoolObject( 1 ) );
815 jsonObjectGetIndex( _p, 1 ),
818 "{ \"%s\":[\"%s\"] }",
819 osrfHashGet( class_obj, "classname" ),
820 osrfHashGet( class_obj, "primarykey" )
824 obj = doFieldmapperSearch(ctx, class_obj, _p, &err);
830 jsonIterator* itr = jsonNewIterator( obj );
831 while ((cur = jsonIteratorNext( itr ))) {
833 if(!verifyObjectPCRUD(ctx, cur)) continue;
837 oilsFMGetObject( cur, osrfHashGet( class_obj, "primarykey" ) )
840 jsonIteratorFree(itr);
841 osrfAppRespondComplete( ctx, NULL );
844 osrfAppRespondComplete( ctx, obj );
852 static int verifyObjectClass ( osrfMethodContext* ctx, const jsonObject* param ) {
855 osrfHash* meta = (osrfHash*) ctx->method->userData;
856 osrfHash* class = osrfHashGet( meta, "class" );
858 if (!param->classname || (strcmp( osrfHashGet(class, "classname"), param->classname ))) {
860 growing_buffer* msg = buffer_init(128);
863 "%s: %s method for type %s was passed a %s",
865 osrfHashGet(meta, "methodtype"),
866 osrfHashGet(class, "classname"),
870 char* m = buffer_release(msg);
871 osrfAppSessionStatus( ctx->session, OSRF_STATUS_BADREQUEST, "osrfMethodException", ctx->request, m );
879 ret = verifyObjectPCRUD( ctx, param );
887 static jsonObject* verifyUserPCRUD( osrfMethodContext* ctx ) {
888 const char* auth = jsonObjectGetString( jsonObjectGetIndex( ctx->params, 0 ) );
889 jsonObject* auth_object = jsonNewObject(auth);
890 jsonObject* user = oilsUtilsQuickReq("open-ils.auth","open-ils.auth.session.retrieve", auth_object);
891 jsonObjectFree(auth_object);
893 if (!user->classname || strcmp(user->classname, "au")) {
895 growing_buffer* msg = buffer_init(128);
898 "%s: permacrud received a bad auth token: %s",
903 char* m = buffer_release(msg);
904 osrfAppSessionStatus( ctx->session, OSRF_STATUS_UNAUTHORIZED, "osrfMethodException", ctx->request, m );
907 jsonObjectFree(user);
915 static int verifyObjectPCRUD ( osrfMethodContext* ctx, const jsonObject* obj ) {
917 dbhandle = writehandle;
919 osrfHash* meta = (osrfHash*) ctx->method->userData;
920 osrfHash* class = osrfHashGet( meta, "class" );
921 char* method_type = strdup( osrfHashGet(meta, "methodtype") );
924 if ( ( *method_type == 's' || *method_type == 'i' ) ) {
926 method_type = strdup("retrieve"); // search and id_list are equivelant to retrieve for this
927 } else if ( *method_type == 'u' || *method_type == 'd' ) {
928 fetch = 1; // MUST go to the db for the object for update and delete
931 osrfHash* pcrud = osrfHashGet( osrfHashGet(class, "permacrud"), method_type );
935 // No permacrud for this method type on this class
937 growing_buffer* msg = buffer_init(128);
940 "%s: %s on class %s has no permacrud IDL entry",
942 osrfHashGet(meta, "methodtype"),
943 osrfHashGet(class, "classname")
946 char* m = buffer_release(msg);
947 osrfAppSessionStatus( ctx->session, OSRF_STATUS_FORBIDDEN, "osrfMethodException", ctx->request, m );
954 jsonObject* user = verifyUserPCRUD( ctx );
957 int userid = atoi( oilsFMGetString( user, "id" ) );
958 jsonObjectFree(user);
960 osrfStringArray* permission = osrfHashGet(pcrud, "permission");
961 osrfStringArray* local_context = osrfHashGet(pcrud, "local_context");
962 osrfHash* foreign_context = osrfHashGet(pcrud, "foreign_context");
964 osrfStringArray* context_org_array = osrfNewStringArray(1);
967 char* pkey_value = NULL;
968 if ( str_is_true( osrfHashGet(pcrud, "global_required") ) ) {
969 osrfLogDebug( OSRF_LOG_MARK, "global-level permissions required, fetching top of the org tree" );
971 // check for perm at top of org tree
972 jsonObject* _tmp_params = jsonParseString("[{\"parent_ou\":null}]");
973 jsonObject* _list = doFieldmapperSearch(ctx, osrfHashGet( oilsIDL(), "aou" ), _tmp_params, &err);
975 jsonObject* _tree_top = jsonObjectGetIndex(_list, 0);
978 jsonObjectFree(_tmp_params);
979 jsonObjectFree(_list);
981 growing_buffer* msg = buffer_init(128);
982 OSRF_BUFFER_ADD( msg, MODULENAME );
983 OSRF_BUFFER_ADD( msg,
984 ": Internal error, could not find the top of the org tree (parent_ou = NULL)" );
986 char* m = buffer_release(msg);
987 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, m );
993 osrfStringArrayAdd( context_org_array, oilsFMGetString( _tree_top, "id" ) );
994 osrfLogDebug( OSRF_LOG_MARK, "top of the org tree is %s", osrfStringArrayGetString(context_org_array, 0) );
996 jsonObjectFree(_tmp_params);
997 jsonObjectFree(_list);
1000 osrfLogDebug( OSRF_LOG_MARK, "global-level permissions not required, fetching context org ids" );
1001 char* pkey = osrfHashGet(class, "primarykey");
1002 jsonObject *param = NULL;
1004 if (obj->classname) {
1005 pkey_value = oilsFMGetString( obj, pkey );
1006 if (!fetch) param = jsonObjectClone(obj);
1007 osrfLogDebug( OSRF_LOG_MARK, "Object supplied, using primary key value of %s", pkey_value );
1009 pkey_value = jsonObjectToSimpleString( obj );
1011 osrfLogDebug( OSRF_LOG_MARK, "Object not supplied, using primary key value of %s and retrieving from the database", pkey_value );
1015 jsonObject* _tmp_params = jsonParseStringFmt("[{\"%s\":\"%s\"}]", pkey, pkey_value);
1016 jsonObject* _list = doFieldmapperSearch(
1023 param = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1025 jsonObjectFree(_tmp_params);
1026 jsonObjectFree(_list);
1030 osrfLogDebug( OSRF_LOG_MARK, "Object not found in the database with primary key %s of %s", pkey, pkey_value );
1032 growing_buffer* msg = buffer_init(128);
1035 "%s: no object found with primary key %s of %s",
1041 char* m = buffer_release(msg);
1042 osrfAppSessionStatus(
1044 OSRF_STATUS_INTERNALSERVERERROR,
1045 "osrfMethodException",
1051 if (pkey_value) free(pkey_value);
1056 if (local_context->size > 0) {
1057 osrfLogDebug( OSRF_LOG_MARK, "%d class-local context field(s) specified", local_context->size);
1059 char* lcontext = NULL;
1060 while ( (lcontext = osrfStringArrayGetString(local_context, i++)) ) {
1061 osrfStringArrayAdd( context_org_array, oilsFMGetString( param, lcontext ) );
1064 "adding class-local field %s (value: %s) to the context org list",
1066 osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1071 osrfStringArray* class_list;
1073 if (foreign_context) {
1074 class_list = osrfHashKeys( foreign_context );
1075 osrfLogDebug( OSRF_LOG_MARK, "%d foreign context classes(s) specified", class_list->size);
1077 if (class_list->size > 0) {
1080 char* class_name = NULL;
1081 while ( (class_name = osrfStringArrayGetString(class_list, i++)) ) {
1082 osrfHash* fcontext = osrfHashGet(foreign_context, class_name);
1086 "%d foreign context fields(s) specified for class %s",
1087 ((osrfStringArray*)osrfHashGet(fcontext,"context"))->size,
1091 char* foreign_pkey = osrfHashGet(fcontext, "field");
1092 char* foreign_pkey_value = oilsFMGetString(param, osrfHashGet(fcontext, "fkey"));
1094 jsonObject* _tmp_params = jsonParseStringFmt(
1095 "[{\"%s\":\"%s\"}]",
1100 jsonObject* _list = doFieldmapperSearch(
1102 osrfHashGet( oilsIDL(), class_name ),
1107 jsonObject* _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1108 jsonObjectFree(_tmp_params);
1109 jsonObjectFree(_list);
1111 osrfStringArray* jump_list = osrfHashGet(fcontext, "jump");
1113 if (_fparam && jump_list) {
1116 while ( (flink = osrfStringArrayGetString(jump_list, k++)) && _fparam ) {
1117 free(foreign_pkey_value);
1119 osrfHash* foreign_link_hash = oilsIDLFindPath( "/%s/links/%s", _fparam->classname, flink );
1121 foreign_pkey_value = oilsFMGetString(_fparam, flink);
1122 foreign_pkey = osrfHashGet( foreign_link_hash, "key" );
1124 _tmp_params = jsonParseStringFmt(
1125 "[{\"%s\":\"%s\"}]",
1130 _list = doFieldmapperSearch(
1132 osrfHashGet( oilsIDL(), osrfHashGet( foreign_link_hash, "class" ) ),
1137 _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1138 jsonObjectFree(_tmp_params);
1139 jsonObjectFree(_list);
1146 growing_buffer* msg = buffer_init(128);
1149 "%s: no object found with primary key %s of %s",
1155 char* m = buffer_release(msg);
1156 osrfAppSessionStatus(
1158 OSRF_STATUS_INTERNALSERVERERROR,
1159 "osrfMethodException",
1165 osrfStringArrayFree(class_list);
1166 free(foreign_pkey_value);
1167 jsonObjectFree(param);
1172 free(foreign_pkey_value);
1175 char* foreign_field = NULL;
1176 while ( (foreign_field = osrfStringArrayGetString(osrfHashGet(fcontext,"context"), j++)) ) {
1177 osrfStringArrayAdd( context_org_array, oilsFMGetString( _fparam, foreign_field ) );
1180 "adding foreign class %s field %s (value: %s) to the context org list",
1183 osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1187 jsonObjectFree(_fparam);
1190 osrfStringArrayFree(class_list);
1194 jsonObjectFree(param);
1197 char* context_org = NULL;
1201 if (permission->size == 0) {
1202 osrfLogDebug( OSRF_LOG_MARK, "No permission specified for this action, passing through" );
1207 while ( (perm = osrfStringArrayGetString(permission, i++)) ) {
1209 while ( (context_org = osrfStringArrayGetString(context_org_array, j++)) ) {
1215 "Checking object permission [%s] for user %d on object %s (class %s) at org %d",
1219 osrfHashGet(class, "classname"),
1223 result = dbi_conn_queryf(
1225 "SELECT permission.usr_has_object_perm(%d, '%s', '%s', '%s', %d) AS has_perm;",
1228 osrfHashGet(class, "classname"),
1236 "Recieved a result for object permission [%s] for user %d on object %s (class %s) at org %d",
1240 osrfHashGet(class, "classname"),
1244 if (dbi_result_first_row(result)) {
1245 jsonObject* return_val = oilsMakeJSONFromResult( result );
1246 const char* has_perm = jsonObjectGetString( jsonObjectGetKeyConst(return_val, "has_perm") );
1250 "Status of object permission [%s] for user %d on object %s (class %s) at org %d is %s",
1254 osrfHashGet(class, "classname"),
1259 if ( *has_perm == 't' ) OK = 1;
1260 jsonObjectFree(return_val);
1263 dbi_result_free(result);
1268 osrfLogDebug( OSRF_LOG_MARK, "Checking non-object permission [%s] for user %d at org %d", perm, userid, atoi(context_org) );
1269 result = dbi_conn_queryf(
1271 "SELECT permission.usr_has_perm(%d, '%s', %d) AS has_perm;",
1278 osrfLogDebug( OSRF_LOG_MARK, "Received a result for permission [%s] for user %d at org %d",
1279 perm, userid, atoi(context_org) );
1280 if ( dbi_result_first_row(result) ) {
1281 jsonObject* return_val = oilsMakeJSONFromResult( result );
1282 const char* has_perm = jsonObjectGetString( jsonObjectGetKeyConst(return_val, "has_perm") );
1283 osrfLogDebug( OSRF_LOG_MARK, "Status of permission [%s] for user %d at org %d is [%s]",
1284 perm, userid, atoi(context_org), has_perm );
1285 if ( *has_perm == 't' ) OK = 1;
1286 jsonObjectFree(return_val);
1289 dbi_result_free(result);
1297 if (pkey_value) free(pkey_value);
1298 osrfStringArrayFree(context_org_array);
1305 static jsonObject* doCreate(osrfMethodContext* ctx, int* err ) {
1307 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1309 jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
1310 jsonObject* options = jsonObjectGetIndex( ctx->params, 2 );
1312 jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
1313 jsonObject* options = jsonObjectGetIndex( ctx->params, 1 );
1316 if (!verifyObjectClass(ctx, target)) {
1321 osrfLogDebug( OSRF_LOG_MARK, "Object seems to be of the correct type" );
1323 char* trans_id = NULL;
1324 if( ctx->session && ctx->session->userData )
1325 trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
1328 osrfLogError( OSRF_LOG_MARK, "No active transaction -- required for CREATE" );
1330 osrfAppSessionStatus(
1332 OSRF_STATUS_BADREQUEST,
1333 "osrfMethodException",
1335 "No active transaction -- required for CREATE"
1341 // The following test is harmless but redundant. If a class is
1342 // readonly, we don't register a create method for it.
1343 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
1344 osrfAppSessionStatus(
1346 OSRF_STATUS_BADREQUEST,
1347 "osrfMethodException",
1349 "Cannot INSERT readonly class"
1355 // Set the last_xact_id
1356 int index = oilsIDL_ntop( target->classname, "last_xact_id" );
1358 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
1359 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
1362 osrfLogDebug( OSRF_LOG_MARK, "There is a transaction running..." );
1364 dbhandle = writehandle;
1366 osrfHash* fields = osrfHashGet(meta, "fields");
1367 char* pkey = osrfHashGet(meta, "primarykey");
1368 char* seq = osrfHashGet(meta, "sequence");
1370 growing_buffer* table_buf = buffer_init(128);
1371 growing_buffer* col_buf = buffer_init(128);
1372 growing_buffer* val_buf = buffer_init(128);
1374 OSRF_BUFFER_ADD(table_buf, "INSERT INTO ");
1375 OSRF_BUFFER_ADD(table_buf, osrfHashGet(meta, "tablename"));
1376 OSRF_BUFFER_ADD_CHAR( col_buf, '(' );
1377 buffer_add(val_buf,"VALUES (");
1383 osrfStringArray* field_list = osrfHashKeys( fields );
1384 while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
1386 osrfHash* field = osrfHashGet( fields, field_name );
1388 if( str_is_true( osrfHashGet( field, "virtual" ) ) )
1391 const jsonObject* field_object = oilsFMGetObject( target, field_name );
1394 if (field_object && field_object->classname) {
1395 value = oilsFMGetString(
1397 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
1400 value = jsonObjectToSimpleString( field_object );
1407 OSRF_BUFFER_ADD_CHAR( col_buf, ',' );
1408 OSRF_BUFFER_ADD_CHAR( val_buf, ',' );
1411 buffer_add(col_buf, field_name);
1413 if (!field_object || field_object->type == JSON_NULL) {
1414 buffer_add( val_buf, "DEFAULT" );
1416 } else if ( !strcmp(get_primitive( field ), "number") ) {
1417 const char* numtype = get_datatype( field );
1418 if ( !strcmp( numtype, "INT8") ) {
1419 buffer_fadd( val_buf, "%lld", atoll(value) );
1421 } else if ( !strcmp( numtype, "INT") ) {
1422 buffer_fadd( val_buf, "%d", atoi(value) );
1424 } else if ( !strcmp( numtype, "NUMERIC") ) {
1425 buffer_fadd( val_buf, "%f", atof(value) );
1428 if ( dbi_conn_quote_string(writehandle, &value) ) {
1429 OSRF_BUFFER_ADD( val_buf, value );
1432 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
1433 osrfAppSessionStatus(
1435 OSRF_STATUS_INTERNALSERVERERROR,
1436 "osrfMethodException",
1438 "Error quoting string -- please see the error log for more details"
1441 buffer_free(table_buf);
1442 buffer_free(col_buf);
1443 buffer_free(val_buf);
1454 OSRF_BUFFER_ADD_CHAR( col_buf, ')' );
1455 OSRF_BUFFER_ADD_CHAR( val_buf, ')' );
1457 char* table_str = buffer_release(table_buf);
1458 char* col_str = buffer_release(col_buf);
1459 char* val_str = buffer_release(val_buf);
1460 growing_buffer* sql = buffer_init(128);
1461 buffer_fadd( sql, "%s %s %s;", table_str, col_str, val_str );
1466 char* query = buffer_release(sql);
1468 osrfLogDebug(OSRF_LOG_MARK, "%s: Insert SQL [%s]", MODULENAME, query);
1471 dbi_result result = dbi_conn_query(writehandle, query);
1473 jsonObject* obj = NULL;
1476 obj = jsonNewObject(NULL);
1479 "%s ERROR inserting %s object using query [%s]",
1481 osrfHashGet(meta, "fieldmapper"),
1484 osrfAppSessionStatus(
1486 OSRF_STATUS_INTERNALSERVERERROR,
1487 "osrfMethodException",
1489 "INSERT error -- please see the error log for more details"
1494 char* id = oilsFMGetString(target, pkey);
1496 unsigned long long new_id = dbi_conn_sequence_last(writehandle, seq);
1497 growing_buffer* _id = buffer_init(10);
1498 buffer_fadd(_id, "%lld", new_id);
1499 id = buffer_release(_id);
1502 // Find quietness specification, if present
1503 const char* quiet_str = NULL;
1505 const jsonObject* quiet_obj = jsonObjectGetKeyConst( options, "quiet" );
1507 quiet_str = jsonObjectGetString( quiet_obj );
1510 if( str_is_true( quiet_str ) ) { // if quietness is specified
1511 obj = jsonNewObject(id);
1515 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
1516 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH));
1519 jsonObjectGetIndex(fake_params, 0),
1524 jsonObject* list = doFieldmapperSearch( ctx,meta, fake_params, err);
1527 jsonObjectFree( fake_params );
1530 obj = jsonObjectClone( jsonObjectGetIndex(list, 0) );
1533 jsonObjectFree( list );
1534 jsonObjectFree( fake_params );
1547 static jsonObject* doRetrieve(osrfMethodContext* ctx, int* err ) {
1557 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1559 const char* id = jsonObjectGetString(jsonObjectGetIndex(ctx->params, id_pos));
1560 jsonObject* order_hash = jsonObjectGetIndex(ctx->params, order_pos);
1564 "%s retrieving %s object with primary key value of %s",
1566 osrfHashGet(meta, "fieldmapper"),
1570 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
1571 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH));
1574 jsonObjectGetIndex(fake_params, 0),
1575 osrfHashGet(meta, "primarykey"),
1576 jsonObjectClone(jsonObjectGetIndex(ctx->params, id_pos))
1580 if (order_hash) jsonObjectPush(fake_params, jsonObjectClone(order_hash) );
1582 jsonObject* list = doFieldmapperSearch( ctx,meta, fake_params, err);
1585 jsonObjectFree( fake_params );
1589 jsonObject* obj = jsonObjectClone( jsonObjectGetIndex(list, 0) );
1591 jsonObjectFree( list );
1592 jsonObjectFree( fake_params );
1595 if(!verifyObjectPCRUD(ctx, obj)) {
1596 jsonObjectFree(obj);
1599 growing_buffer* msg = buffer_init(128);
1600 OSRF_BUFFER_ADD( msg, MODULENAME );
1601 OSRF_BUFFER_ADD( msg, ": Insufficient permissions to retrieve object" );
1603 char* m = buffer_release(msg);
1604 osrfAppSessionStatus( ctx->session, OSRF_STATUS_NOTALLOWED, "osrfMethodException", ctx->request, m );
1615 static char* jsonNumberToDBString ( osrfHash* field, const jsonObject* value ) {
1616 growing_buffer* val_buf = buffer_init(32);
1617 const char* numtype = get_datatype( field );
1619 if ( !strncmp( numtype, "INT", 3 ) ) {
1620 if (value->type == JSON_NUMBER)
1621 //buffer_fadd( val_buf, "%ld", (long)jsonObjectGetNumber(value) );
1622 buffer_fadd( val_buf, jsonObjectGetString( value ) );
1624 //const char* val_str = jsonObjectGetString( value );
1625 //buffer_fadd( val_buf, "%ld", atol(val_str) );
1626 buffer_fadd( val_buf, jsonObjectGetString( value ) );
1629 } else if ( !strcmp( numtype, "NUMERIC" ) ) {
1630 if (value->type == JSON_NUMBER)
1631 //buffer_fadd( val_buf, "%f", jsonObjectGetNumber(value) );
1632 buffer_fadd( val_buf, jsonObjectGetString( value ) );
1634 //const char* val_str = jsonObjectGetString( value );
1635 //buffer_fadd( val_buf, "%f", atof(val_str) );
1636 buffer_fadd( val_buf, jsonObjectGetString( value ) );
1640 // Presumably this was really intended ot be a string, so quote it
1641 char* str = jsonObjectToSimpleString( value );
1642 if ( dbi_conn_quote_string(dbhandle, &str) ) {
1643 OSRF_BUFFER_ADD( val_buf, str );
1646 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, str);
1648 buffer_free(val_buf);
1653 return buffer_release(val_buf);
1656 static char* searchINPredicate (const char* class, osrfHash* field,
1657 jsonObject* node, const char* op, osrfMethodContext* ctx ) {
1658 growing_buffer* sql_buf = buffer_init(32);
1664 osrfHashGet(field, "name")
1668 buffer_add(sql_buf, "IN (");
1669 } else if (!(strcasecmp(op,"not in"))) {
1670 buffer_add(sql_buf, "NOT IN (");
1672 buffer_add(sql_buf, "IN (");
1675 if (node->type == JSON_HASH) {
1676 // subquery predicate
1677 char* subpred = SELECT(
1679 jsonObjectGetKey( node, "select" ),
1680 jsonObjectGetKey( node, "from" ),
1681 jsonObjectGetKey( node, "where" ),
1682 jsonObjectGetKey( node, "having" ),
1683 jsonObjectGetKey( node, "order_by" ),
1684 jsonObjectGetKey( node, "limit" ),
1685 jsonObjectGetKey( node, "offset" ),
1690 buffer_add(sql_buf, subpred);
1693 buffer_free( sql_buf );
1697 } else if (node->type == JSON_ARRAY) {
1698 // literal value list
1699 int in_item_index = 0;
1700 int in_item_first = 1;
1701 const jsonObject* in_item;
1702 while ( (in_item = jsonObjectGetIndex(node, in_item_index++)) ) {
1707 buffer_add(sql_buf, ", ");
1710 if ( in_item->type != JSON_STRING && in_item->type != JSON_NUMBER ) {
1711 osrfLogError(OSRF_LOG_MARK, "%s: Expected string or number within IN list; found %s",
1712 MODULENAME, json_type( in_item->type ) );
1713 buffer_free(sql_buf);
1717 // Append the literal value -- quoted if not a number
1718 if ( JSON_NUMBER == in_item->type ) {
1719 char* val = jsonNumberToDBString( field, in_item );
1720 OSRF_BUFFER_ADD( sql_buf, val );
1723 } else if ( !strcmp( get_primitive( field ), "number") ) {
1724 char* val = jsonNumberToDBString( field, in_item );
1725 OSRF_BUFFER_ADD( sql_buf, val );
1729 char* key_string = jsonObjectToSimpleString(in_item);
1730 if ( dbi_conn_quote_string(dbhandle, &key_string) ) {
1731 OSRF_BUFFER_ADD( sql_buf, key_string );
1734 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, key_string);
1736 buffer_free(sql_buf);
1742 if( in_item_first ) {
1743 osrfLogError(OSRF_LOG_MARK, "%s: Empty IN list", MODULENAME );
1744 buffer_free( sql_buf );
1748 osrfLogError(OSRF_LOG_MARK, "%s: Expected object or array for IN clause; found %s",
1749 MODULENAME, json_type( node->type ) );
1750 buffer_free(sql_buf);
1754 OSRF_BUFFER_ADD_CHAR( sql_buf, ')' );
1756 return buffer_release(sql_buf);
1759 // Receive a JSON_ARRAY representing a function call. The first
1760 // entry in the array is the function name. The rest are parameters.
1761 static char* searchValueTransform( const jsonObject* array ) {
1763 if( array->size < 1 ) {
1764 osrfLogError(OSRF_LOG_MARK, "%s: Empty array for value transform", MODULENAME);
1768 // Get the function name
1769 jsonObject* func_item = jsonObjectGetIndex( array, 0 );
1770 if( func_item->type != JSON_STRING ) {
1771 osrfLogError(OSRF_LOG_MARK, "%s: Error: expected function name, found %s",
1772 MODULENAME, json_type( func_item->type ) );
1776 growing_buffer* sql_buf = buffer_init(32);
1778 OSRF_BUFFER_ADD( sql_buf, jsonObjectGetString( func_item ) );
1779 OSRF_BUFFER_ADD( sql_buf, "( " );
1781 // Get the parameters
1782 int func_item_index = 1; // We already grabbed the zeroth entry
1783 while ( (func_item = jsonObjectGetIndex(array, func_item_index++)) ) {
1785 // Add a separator comma, if we need one
1786 if( func_item_index > 2 )
1787 buffer_add( sql_buf, ", " );
1789 // Add the current parameter
1790 if (func_item->type == JSON_NULL) {
1791 buffer_add( sql_buf, "NULL" );
1793 char* val = jsonObjectToSimpleString(func_item);
1794 if ( dbi_conn_quote_string(dbhandle, &val) ) {
1795 OSRF_BUFFER_ADD( sql_buf, val );
1798 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1799 buffer_free(sql_buf);
1806 buffer_add( sql_buf, " )" );
1808 return buffer_release(sql_buf);
1811 static char* searchFunctionPredicate (const char* class, osrfHash* field,
1812 const jsonObject* node, const char* op) {
1814 if( ! is_good_operator( op ) ) {
1815 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
1819 char* val = searchValueTransform(node);
1823 growing_buffer* sql_buf = buffer_init(32);
1828 osrfHashGet(field, "name"),
1835 return buffer_release(sql_buf);
1838 // class is a class name
1839 // field is a field definition as stored in the IDL
1840 // node comes from the method parameter, and may represent an entry in the SELECT list
1841 static char* searchFieldTransform (const char* class, osrfHash* field, const jsonObject* node) {
1842 growing_buffer* sql_buf = buffer_init(32);
1844 const char* field_transform = jsonObjectGetString( jsonObjectGetKeyConst( node, "transform" ) );
1845 const char* transform_subcolumn = jsonObjectGetString( jsonObjectGetKeyConst( node, "result_field" ) );
1847 if(transform_subcolumn) {
1848 if( ! is_identifier( transform_subcolumn ) ) {
1849 osrfLogError( OSRF_LOG_MARK, "%s: Invalid subfield name: \"%s\"\n",
1850 MODULENAME, transform_subcolumn );
1851 buffer_free( sql_buf );
1854 OSRF_BUFFER_ADD_CHAR( sql_buf, '(' ); // enclose transform in parentheses
1857 if (field_transform) {
1859 if( ! is_identifier( field_transform ) ) {
1860 osrfLogError( OSRF_LOG_MARK, "%s: Expected function name, found \"%s\"\n",
1861 MODULENAME, field_transform );
1862 buffer_free( sql_buf );
1866 buffer_fadd( sql_buf, "%s(\"%s\".%s", field_transform, class, osrfHashGet(field, "name"));
1867 const jsonObject* array = jsonObjectGetKeyConst( node, "params" );
1870 if( array->type != JSON_ARRAY ) {
1871 osrfLogError( OSRF_LOG_MARK,
1872 "%s: Expected JSON_ARRAY for function params; found %s",
1873 MODULENAME, json_type( array->type ) );
1874 buffer_free( sql_buf );
1877 int func_item_index = 0;
1878 jsonObject* func_item;
1879 while ( (func_item = jsonObjectGetIndex(array, func_item_index++)) ) {
1881 char* val = jsonObjectToSimpleString(func_item);
1884 buffer_add( sql_buf, ",NULL" );
1885 } else if ( dbi_conn_quote_string(dbhandle, &val) ) {
1886 OSRF_BUFFER_ADD_CHAR( sql_buf, ',' );
1887 OSRF_BUFFER_ADD( sql_buf, val );
1889 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1891 buffer_free(sql_buf);
1898 buffer_add( sql_buf, " )" );
1901 buffer_fadd( sql_buf, "\"%s\".%s", class, osrfHashGet(field, "name"));
1904 if (transform_subcolumn)
1905 buffer_fadd( sql_buf, ").\"%s\"", transform_subcolumn );
1907 return buffer_release(sql_buf);
1910 static char* searchFieldTransformPredicate (const char* class, osrfHash* field,
1911 const jsonObject* node, const char* op ) {
1913 if( ! is_good_operator( op ) ) {
1914 osrfLogError(OSRF_LOG_MARK, "%s: Error: Invalid operator %s", MODULENAME, op);
1918 char* field_transform = searchFieldTransform( class, field, node );
1919 if( ! field_transform )
1922 int extra_parens = 0; // boolean
1924 const jsonObject* value_obj = jsonObjectGetKeyConst( node, "value" );
1925 if ( ! value_obj ) {
1926 value = searchWHERE( node, osrfHashGet( oilsIDL(), class ), AND_OP_JOIN, NULL );
1928 osrfLogError(OSRF_LOG_MARK, "%s: Error building condition for field transform", MODULENAME);
1929 free(field_transform);
1933 } else if ( value_obj->type == JSON_ARRAY ) {
1934 value = searchValueTransform( value_obj );
1936 osrfLogError(OSRF_LOG_MARK, "%s: Error building value transform for field transform", MODULENAME);
1937 free( field_transform );
1940 } else if ( value_obj->type == JSON_HASH ) {
1941 value = searchWHERE( value_obj, osrfHashGet( oilsIDL(), class ), AND_OP_JOIN, NULL );
1943 osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform", MODULENAME);
1944 free(field_transform);
1948 } else if ( value_obj->type == JSON_NUMBER ) {
1949 value = jsonNumberToDBString( field, value_obj );
1950 } else if ( value_obj->type == JSON_NULL ) {
1951 osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform: null value", MODULENAME);
1952 free(field_transform);
1954 } else if ( value_obj->type == JSON_BOOL ) {
1955 osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform: boolean value", MODULENAME);
1956 free(field_transform);
1959 if ( !strcmp( get_primitive( field ), "number") ) {
1960 value = jsonNumberToDBString( field, value_obj );
1962 value = jsonObjectToSimpleString( value_obj );
1963 if ( !dbi_conn_quote_string(dbhandle, &value) ) {
1964 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, value);
1966 free(field_transform);
1972 const char* left_parens = "";
1973 const char* right_parens = "";
1975 if( extra_parens ) {
1980 growing_buffer* sql_buf = buffer_init(32);
1984 "%s%s %s %s %s %s%s",
1995 free(field_transform);
1997 return buffer_release(sql_buf);
2000 static char* searchSimplePredicate (const char* op, const char* class,
2001 osrfHash* field, const jsonObject* node) {
2003 if( ! is_good_operator( op ) ) {
2004 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
2010 // Get the value to which we are comparing the specified column
2011 if (node->type != JSON_NULL) {
2012 if ( node->type == JSON_NUMBER ) {
2013 val = jsonNumberToDBString( field, node );
2014 } else if ( !strcmp( get_primitive( field ), "number" ) ) {
2015 val = jsonNumberToDBString( field, node );
2017 val = jsonObjectToSimpleString(node);
2022 if( JSON_NUMBER != node->type && strcmp( get_primitive( field ), "number") ) {
2023 // Value is not numeric; enclose it in quotes
2024 if ( !dbi_conn_quote_string( dbhandle, &val ) ) {
2025 osrfLogError( OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val );
2031 // Compare to a null value
2032 val = strdup( "NULL" );
2033 if (strcmp( op, "=" ))
2039 growing_buffer* sql_buf = buffer_init(32);
2040 buffer_fadd( sql_buf, "\"%s\".%s %s %s", class, osrfHashGet(field, "name"), op, val );
2041 char* pred = buffer_release( sql_buf );
2048 static char* searchBETWEENPredicate (const char* class, osrfHash* field, const jsonObject* node) {
2050 const jsonObject* x_node = jsonObjectGetIndex( node, 0 );
2051 const jsonObject* y_node = jsonObjectGetIndex( node, 1 );
2053 if( NULL == y_node ) {
2054 osrfLogError( OSRF_LOG_MARK, "%s: Not enough operands for BETWEEN operator", MODULENAME );
2057 else if( NULL != jsonObjectGetIndex( node, 2 ) ) {
2058 osrfLogError( OSRF_LOG_MARK, "%s: Too many operands for BETWEEN operator", MODULENAME );
2065 if ( !strcmp( get_primitive( field ), "number") ) {
2066 x_string = jsonNumberToDBString(field, x_node);
2067 y_string = jsonNumberToDBString(field, y_node);
2070 x_string = jsonObjectToSimpleString(x_node);
2071 y_string = jsonObjectToSimpleString(y_node);
2072 if ( !(dbi_conn_quote_string(dbhandle, &x_string) && dbi_conn_quote_string(dbhandle, &y_string)) ) {
2073 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key strings [%s] and [%s]",
2074 MODULENAME, x_string, y_string);
2081 growing_buffer* sql_buf = buffer_init(32);
2082 buffer_fadd( sql_buf, "%s BETWEEN %s AND %s", osrfHashGet(field, "name"), x_string, y_string );
2086 return buffer_release(sql_buf);
2089 static char* searchPredicate ( const char* class, osrfHash* field,
2090 jsonObject* node, osrfMethodContext* ctx ) {
2093 if (node->type == JSON_ARRAY) { // equality IN search
2094 pred = searchINPredicate( class, field, node, NULL, ctx );
2095 } else if (node->type == JSON_HASH) { // other search
2096 jsonIterator* pred_itr = jsonNewIterator( node );
2097 if( !jsonIteratorHasNext( pred_itr ) ) {
2098 osrfLogError( OSRF_LOG_MARK, "%s: Empty predicate for field \"%s\"",
2099 MODULENAME, osrfHashGet(field, "name") );
2101 jsonObject* pred_node = jsonIteratorNext( pred_itr );
2103 // Verify that there are no additional predicates
2104 if( jsonIteratorHasNext( pred_itr ) ) {
2105 osrfLogError( OSRF_LOG_MARK, "%s: Multiple predicates for field \"%s\"",
2106 MODULENAME, osrfHashGet(field, "name") );
2107 } else if ( !(strcasecmp( pred_itr->key,"between" )) )
2108 pred = searchBETWEENPredicate( class, field, pred_node );
2109 else if ( !(strcasecmp( pred_itr->key,"in" )) || !(strcasecmp( pred_itr->key,"not in" )) )
2110 pred = searchINPredicate( class, field, pred_node, pred_itr->key, ctx );
2111 else if ( pred_node->type == JSON_ARRAY )
2112 pred = searchFunctionPredicate( class, field, pred_node, pred_itr->key );
2113 else if ( pred_node->type == JSON_HASH )
2114 pred = searchFieldTransformPredicate( class, field, pred_node, pred_itr->key );
2116 pred = searchSimplePredicate( pred_itr->key, class, field, pred_node );
2118 jsonIteratorFree(pred_itr);
2120 } else if (node->type == JSON_NULL) { // IS NULL search
2121 growing_buffer* _p = buffer_init(64);
2124 "\"%s\".%s IS NULL",
2126 osrfHashGet(field, "name")
2128 pred = buffer_release(_p);
2129 } else { // equality search
2130 pred = searchSimplePredicate( "=", class, field, node );
2149 field : call_number,
2165 static char* searchJOIN ( const jsonObject* join_hash, osrfHash* leftmeta ) {
2167 const jsonObject* working_hash;
2168 jsonObject* freeable_hash = NULL;
2170 if (join_hash->type == JSON_STRING) {
2171 // create a wrapper around a copy of the original
2172 const char* _tmp = jsonObjectGetString( join_hash );
2173 freeable_hash = jsonNewObjectType(JSON_HASH);
2174 jsonObjectSetKey(freeable_hash, _tmp, NULL);
2175 working_hash = freeable_hash;
2178 if( join_hash->type != JSON_HASH ) {
2181 "%s: JOIN failed; expected JSON object type not found",
2186 working_hash = join_hash;
2189 growing_buffer* join_buf = buffer_init(128);
2190 const char* leftclass = osrfHashGet(leftmeta, "classname");
2192 jsonObject* snode = NULL;
2193 jsonIterator* search_itr = jsonNewIterator( working_hash );
2195 while ( (snode = jsonIteratorNext( search_itr )) ) {
2196 const char* class = search_itr->key;
2197 osrfHash* idlClass = osrfHashGet( oilsIDL(), class );
2201 "%s: JOIN failed. No class \"%s\" defined in IDL",
2205 jsonIteratorFree( search_itr );
2206 buffer_free( join_buf );
2208 jsonObjectFree( freeable_hash );
2212 const char* fkey = jsonObjectGetString( jsonObjectGetKeyConst( snode, "fkey" ) );
2213 const char* field = jsonObjectGetString( jsonObjectGetKeyConst( snode, "field" ) );
2215 if (field && !fkey) {
2216 // Look up the corresponding join column in the IDL.
2217 // The link must be defined in the child table,
2218 // and point to the right parent table.
2219 osrfHash* idl_link = (osrfHash*) oilsIDLFindPath( "/%s/links/%s", class, field );
2220 const char* reltype = NULL;
2221 const char* other_class = NULL;
2222 reltype = osrfHashGet( idl_link, "reltype" );
2223 if( reltype && strcmp( reltype, "has_many" ) )
2224 other_class = osrfHashGet( idl_link, "class" );
2225 if( other_class && !strcmp( other_class, leftclass ) )
2226 fkey = osrfHashGet( idl_link, "key" );
2230 "%s: JOIN failed. No link defined from %s.%s to %s",
2236 buffer_free(join_buf);
2238 jsonObjectFree(freeable_hash);
2239 jsonIteratorFree(search_itr);
2243 } else if (!field && fkey) {
2244 // Look up the corresponding join column in the IDL.
2245 // The link must be defined in the child table,
2246 // and point to the right parent table.
2247 osrfHash* idl_link = (osrfHash*) oilsIDLFindPath( "/%s/links/%s", leftclass, fkey );
2248 const char* reltype = NULL;
2249 const char* other_class = NULL;
2250 reltype = osrfHashGet( idl_link, "reltype" );
2251 if( reltype && strcmp( reltype, "has_many" ) )
2252 other_class = osrfHashGet( idl_link, "class" );
2253 if( other_class && !strcmp( other_class, class ) )
2254 field = osrfHashGet( idl_link, "key" );
2258 "%s: JOIN failed. No link defined from %s.%s to %s",
2264 buffer_free(join_buf);
2266 jsonObjectFree(freeable_hash);
2267 jsonIteratorFree(search_itr);
2271 } else if (!field && !fkey) {
2272 osrfHash* _links = oilsIDL_links( leftclass );
2274 // For each link defined for the left class:
2275 // see if the link references the joined class
2276 osrfHashIterator* itr = osrfNewHashIterator( _links );
2277 osrfHash* curr_link = NULL;
2278 while( (curr_link = osrfHashIteratorNext( itr ) ) ) {
2279 const char* other_class = osrfHashGet( curr_link, "class" );
2280 if( other_class && !strcmp( other_class, class ) ) {
2282 // In the IDL, the parent class doesn't know then names of the child
2283 // columns that are pointing to it, so don't use that end of the link
2284 const char* reltype = osrfHashGet( curr_link, "reltype" );
2285 if( reltype && strcmp( reltype, "has_many" ) ) {
2286 // Found a link between the classes
2287 fkey = osrfHashIteratorKey( itr );
2288 field = osrfHashGet( curr_link, "key" );
2293 osrfHashIteratorFree( itr );
2295 if (!field || !fkey) {
2296 // Do another such search, with the classes reversed
2297 _links = oilsIDL_links( class );
2299 // For each link defined for the joined class:
2300 // see if the link references the left class
2301 osrfHashIterator* itr = osrfNewHashIterator( _links );
2302 osrfHash* curr_link = NULL;
2303 while( (curr_link = osrfHashIteratorNext( itr ) ) ) {
2304 const char* other_class = osrfHashGet( curr_link, "class" );
2305 if( other_class && !strcmp( other_class, leftclass ) ) {
2307 // In the IDL, the parent class doesn't know then names of the child
2308 // columns that are pointing to it, so don't use that end of the link
2309 const char* reltype = osrfHashGet( curr_link, "reltype" );
2310 if( reltype && strcmp( reltype, "has_many" ) ) {
2311 // Found a link between the classes
2312 field = osrfHashIteratorKey( itr );
2313 fkey = osrfHashGet( curr_link, "key" );
2318 osrfHashIteratorFree( itr );
2321 if (!field || !fkey) {
2324 "%s: JOIN failed. No link defined between %s and %s",
2329 buffer_free(join_buf);
2331 jsonObjectFree(freeable_hash);
2332 jsonIteratorFree(search_itr);
2338 const char* type = jsonObjectGetString( jsonObjectGetKeyConst( snode, "type" ) );
2340 if ( !strcasecmp(type,"left") ) {
2341 buffer_add(join_buf, " LEFT JOIN");
2342 } else if ( !strcasecmp(type,"right") ) {
2343 buffer_add(join_buf, " RIGHT JOIN");
2344 } else if ( !strcasecmp(type,"full") ) {
2345 buffer_add(join_buf, " FULL JOIN");
2347 buffer_add(join_buf, " INNER JOIN");
2350 buffer_add(join_buf, " INNER JOIN");
2353 char* table = getSourceDefinition(idlClass);
2355 jsonIteratorFree( search_itr );
2356 buffer_free( join_buf );
2358 jsonObjectFree( freeable_hash );
2362 buffer_fadd(join_buf, " %s AS \"%s\" ON ( \"%s\".%s = \"%s\".%s",
2363 table, class, class, field, leftclass, fkey);
2366 const jsonObject* filter = jsonObjectGetKeyConst( snode, "filter" );
2368 const char* filter_op = jsonObjectGetString( jsonObjectGetKeyConst( snode, "filter_op" ) );
2369 if ( filter_op && !strcasecmp("or",filter_op) ) {
2370 buffer_add( join_buf, " OR " );
2372 buffer_add( join_buf, " AND " );
2375 char* jpred = searchWHERE( filter, idlClass, AND_OP_JOIN, NULL );
2377 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2378 OSRF_BUFFER_ADD( join_buf, jpred );
2383 "%s: JOIN failed. Invalid conditional expression.",
2386 jsonIteratorFree( search_itr );
2387 buffer_free( join_buf );
2389 jsonObjectFree( freeable_hash );
2394 buffer_add(join_buf, " ) ");
2396 const jsonObject* join_filter = jsonObjectGetKeyConst( snode, "join" );
2398 char* jpred = searchJOIN( join_filter, idlClass );
2399 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2400 OSRF_BUFFER_ADD( join_buf, jpred );
2406 jsonObjectFree(freeable_hash);
2407 jsonIteratorFree(search_itr);
2409 return buffer_release(join_buf);
2414 { +class : { -or|-and : { field : { op : value }, ... } ... }, ... }
2415 { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }
2416 [ { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }, ... ]
2418 Generate code to express a set of conditions, as for a WHERE clause. Parameters:
2420 search_hash is the JSON expression of the conditions.
2421 meta is the class definition from the IDL, for the relevant table.
2422 opjoin_type indicates whether multiple conditions, if present, should be
2423 connected by AND or OR.
2424 osrfMethodContext is loaded with all sorts of stuff, but all we do with it here is
2425 to pass it to other functions -- and all they do with it is to use the session
2426 and request members to send error messages back to the client.
2430 static char* searchWHERE ( const jsonObject* search_hash, osrfHash* meta, int opjoin_type, osrfMethodContext* ctx ) {
2434 "%s: Entering searchWHERE; search_hash addr = %p, meta addr = %p, opjoin_type = %d, ctx addr = %p",
2442 growing_buffer* sql_buf = buffer_init(128);
2444 jsonObject* node = NULL;
2447 if ( search_hash->type == JSON_ARRAY ) {
2448 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_ARRAY", MODULENAME);
2449 jsonIterator* search_itr = jsonNewIterator( search_hash );
2450 if( !jsonIteratorHasNext( search_itr ) ) {
2453 "%s: Invalid predicate structure: empty JSON array",
2456 jsonIteratorFree( search_itr );
2457 buffer_free( sql_buf );
2461 while ( (node = jsonIteratorNext( search_itr )) ) {
2465 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2466 else buffer_add(sql_buf, " AND ");
2469 char* subpred = searchWHERE( node, meta, opjoin_type, ctx );
2471 buffer_fadd(sql_buf, "( %s )", subpred);
2474 jsonIteratorFree( search_itr );
2475 buffer_free( sql_buf );
2479 jsonIteratorFree(search_itr);
2481 } else if ( search_hash->type == JSON_HASH ) {
2482 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_HASH", MODULENAME);
2483 jsonIterator* search_itr = jsonNewIterator( search_hash );
2484 if( !jsonIteratorHasNext( search_itr ) ) {
2487 "%s: Invalid predicate structure: empty JSON object",
2490 jsonIteratorFree( search_itr );
2491 buffer_free( sql_buf );
2495 while ( (node = jsonIteratorNext( search_itr )) ) {
2500 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2501 else buffer_add(sql_buf, " AND ");
2504 if ( '+' == search_itr->key[ 0 ] ) {
2505 if ( node->type == JSON_STRING ) {
2506 // Intended purpose; to allow reference to a Boolean column
2508 // Verify that the class alias is not empty
2509 if( '\0' == search_itr->key[ 1 ] ) {
2512 "%s: Table alias is empty",
2515 jsonIteratorFree( search_itr );
2516 buffer_free( sql_buf );
2520 // Verify that the string looks like an identifier.
2521 const char* subpred = jsonObjectGetString( node );
2522 if( ! is_identifier( subpred ) ) {
2525 "%s: Invalid boolean identifier in WHERE clause: \"%s\"",
2529 jsonIteratorFree( search_itr );
2530 buffer_free( sql_buf );
2534 buffer_fadd(sql_buf, " \"%s\".%s ", search_itr->key + 1, subpred);
2536 char* subpred = searchWHERE( node, osrfHashGet( oilsIDL(), search_itr->key + 1 ), AND_OP_JOIN, ctx );
2538 buffer_fadd(sql_buf, "( %s )", subpred);
2541 jsonIteratorFree( search_itr );
2542 buffer_free( sql_buf );
2546 } else if ( !strcasecmp("-or",search_itr->key) ) {
2547 char* subpred = searchWHERE( node, meta, OR_OP_JOIN, ctx );
2549 buffer_fadd(sql_buf, "( %s )", subpred);
2552 buffer_free( sql_buf );
2555 } else if ( !strcasecmp("-and",search_itr->key) ) {
2556 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2558 buffer_fadd(sql_buf, "( %s )", subpred);
2561 buffer_free( sql_buf );
2564 } else if ( !strcasecmp("-not",search_itr->key) ) {
2565 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2567 buffer_fadd(sql_buf, " NOT ( %s )", subpred);
2570 buffer_free( sql_buf );
2573 } else if ( !strcasecmp("-exists",search_itr->key) ) {
2574 char* subpred = SELECT(
2576 jsonObjectGetKey( node, "select" ),
2577 jsonObjectGetKey( node, "from" ),
2578 jsonObjectGetKey( node, "where" ),
2579 jsonObjectGetKey( node, "having" ),
2580 jsonObjectGetKey( node, "order_by" ),
2581 jsonObjectGetKey( node, "limit" ),
2582 jsonObjectGetKey( node, "offset" ),
2587 buffer_fadd(sql_buf, "EXISTS ( %s )", subpred);
2590 buffer_free( sql_buf );
2593 } else if ( !strcasecmp("-not-exists",search_itr->key) ) {
2594 char* subpred = SELECT(
2596 jsonObjectGetKey( node, "select" ),
2597 jsonObjectGetKey( node, "from" ),
2598 jsonObjectGetKey( node, "where" ),
2599 jsonObjectGetKey( node, "having" ),
2600 jsonObjectGetKey( node, "order_by" ),
2601 jsonObjectGetKey( node, "limit" ),
2602 jsonObjectGetKey( node, "offset" ),
2607 buffer_fadd(sql_buf, "NOT EXISTS ( %s )", subpred);
2610 buffer_free( sql_buf );
2616 char* class = osrfHashGet(meta, "classname");
2617 osrfHash* fields = osrfHashGet(meta, "fields");
2618 osrfHash* field = osrfHashGet( fields, search_itr->key );
2622 char* table = getSourceDefinition(meta);
2624 table = strdup( "(?)" );
2627 "%s: Attempt to reference non-existent column \"%s\" on %s (%s)",
2633 buffer_free(sql_buf);
2635 jsonIteratorFree(search_itr);
2639 char* subpred = searchPredicate( class, field, node, ctx );
2641 buffer_add( sql_buf, subpred );
2644 buffer_free(sql_buf);
2645 jsonIteratorFree(search_itr);
2650 jsonIteratorFree(search_itr);
2653 // ERROR ... only hash and array allowed at this level
2654 char* predicate_string = jsonObjectToJSON( search_hash );
2657 "%s: Invalid predicate structure: %s",
2661 buffer_free(sql_buf);
2662 free(predicate_string);
2666 return buffer_release(sql_buf);
2670 /* method context */ osrfMethodContext* ctx,
2672 /* SELECT */ jsonObject* selhash,
2673 /* FROM */ jsonObject* join_hash,
2674 /* WHERE */ jsonObject* search_hash,
2675 /* HAVING */ jsonObject* having_hash,
2676 /* ORDER BY */ jsonObject* order_hash,
2677 /* LIMIT */ jsonObject* limit,
2678 /* OFFSET */ jsonObject* offset,
2679 /* flags */ int flags
2681 const char* locale = osrf_message_get_last_locale();
2683 // in case we don't get a select list
2684 jsonObject* defaultselhash = NULL;
2686 // general tmp objects
2687 const jsonObject* tmp_const;
2688 jsonObject* selclass = NULL;
2689 jsonObject* selfield = NULL;
2690 jsonObject* snode = NULL;
2691 jsonObject* onode = NULL;
2693 char* string = NULL;
2694 int from_function = 0;
2699 // the core search class
2700 char* core_class = NULL;
2702 // metadata about the core search class
2703 osrfHash* core_meta = NULL;
2705 osrfLogDebug(OSRF_LOG_MARK, "cstore SELECT locale: %s", locale);
2707 // punt if there's no core class
2708 if (!join_hash || ( join_hash->type == JSON_HASH && !join_hash->size )) {
2711 "%s: FROM clause is missing or empty",
2715 osrfAppSessionStatus(
2717 OSRF_STATUS_INTERNALSERVERERROR,
2718 "osrfMethodException",
2720 "FROM clause is missing or empty in JSON query"
2725 // get the core class -- the only key of the top level FROM clause, or a string
2726 if (join_hash->type == JSON_HASH) {
2727 jsonIterator* tmp_itr = jsonNewIterator( join_hash );
2728 snode = jsonIteratorNext( tmp_itr );
2730 core_class = strdup( tmp_itr->key );
2733 jsonObject* extra = jsonIteratorNext( tmp_itr );
2735 jsonIteratorFree( tmp_itr );
2738 // There shouldn't be more than one entry in join_hash
2742 "%s: Malformed FROM clause: extra entry in JSON_HASH",
2746 osrfAppSessionStatus(
2748 OSRF_STATUS_INTERNALSERVERERROR,
2749 "osrfMethodException",
2751 "Malformed FROM clause in JSON query"
2754 return NULL; // Malformed join_hash; extra entry
2756 } else if (join_hash->type == JSON_ARRAY) {
2758 core_class = jsonObjectToSimpleString( jsonObjectGetIndex(join_hash, 0) );
2761 } else if (join_hash->type == JSON_STRING) {
2762 core_class = jsonObjectToSimpleString( join_hash );
2768 "%s: FROM clause is unexpected JSON type: %s",
2770 json_type( join_hash->type )
2773 osrfAppSessionStatus(
2775 OSRF_STATUS_INTERNALSERVERERROR,
2776 "osrfMethodException",
2778 "Ill-formed FROM clause in JSON query"
2784 if (!from_function) {
2785 // Get the IDL class definition for the core class
2786 core_meta = osrfHashGet( oilsIDL(), core_class );
2787 if( !core_meta ) { // Didn't find it?
2790 "%s: SELECT clause references undefined class: \"%s\"",
2795 osrfAppSessionStatus(
2797 OSRF_STATUS_INTERNALSERVERERROR,
2798 "osrfMethodException",
2800 "SELECT clause references undefined class in JSON query"
2806 // Make sure the class isn't virtual
2807 if( str_is_true( osrfHashGet( core_meta, "virtual" ) ) ) {
2810 "%s: Core class is virtual: \"%s\"",
2815 osrfAppSessionStatus(
2817 OSRF_STATUS_INTERNALSERVERERROR,
2818 "osrfMethodException",
2820 "FROM clause references virtual class in JSON query"
2827 // if the select list is empty, or the core class field list is '*',
2828 // build the default select list ...
2830 selhash = defaultselhash = jsonNewObjectType(JSON_HASH);
2831 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2832 } else if( selhash->type != JSON_HASH ) {
2835 "%s: Expected JSON_HASH for SELECT clause; found %s",
2837 json_type( selhash->type )
2841 osrfAppSessionStatus(
2843 OSRF_STATUS_INTERNALSERVERERROR,
2844 "osrfMethodException",
2846 "Malformed SELECT clause in JSON query"
2850 } else if ( (tmp_const = jsonObjectGetKeyConst( selhash, core_class )) && tmp_const->type == JSON_STRING ) {
2851 const char* _x = jsonObjectGetString( tmp_const );
2852 if (!strncmp( "*", _x, 1 )) {
2853 jsonObjectRemoveKey( selhash, core_class );
2854 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2859 growing_buffer* sql_buf = buffer_init(128);
2861 // temp buffer for the SELECT list
2862 growing_buffer* select_buf = buffer_init(128);
2863 growing_buffer* order_buf = buffer_init(128);
2864 growing_buffer* group_buf = buffer_init(128);
2865 growing_buffer* having_buf = buffer_init(128);
2867 int aggregate_found = 0; // boolean
2869 // Build a select list
2870 if(from_function) // From a function we select everything
2871 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
2874 // If we need to build a default list, prepare to do so
2875 jsonObject* _tmp = jsonObjectGetKey( selhash, core_class );
2876 if ( _tmp && !_tmp->size ) {
2878 osrfHash* core_fields = osrfHashGet( core_meta, "fields" );
2880 osrfHashIterator* field_itr = osrfNewHashIterator( core_fields );
2881 osrfHash* field_def;
2882 while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
2883 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
2884 // This field is not virtual, so add it to the list
2885 jsonObjectPush( _tmp, jsonNewObject( osrfHashIteratorKey( field_itr ) ) );
2888 osrfHashIteratorFree( field_itr );
2891 // Now build the actual select list
2895 jsonIterator* selclass_itr = jsonNewIterator( selhash );
2896 while ( (selclass = jsonIteratorNext( selclass_itr )) ) { // For each class
2898 // Make sure the class is defined in the IDL
2899 const char* cname = selclass_itr->key;
2900 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
2904 "%s: Selected class \"%s\" not defined in IDL",
2910 osrfAppSessionStatus(
2912 OSRF_STATUS_INTERNALSERVERERROR,
2913 "osrfMethodException",
2915 "Selected class is not defined"
2917 jsonIteratorFree( selclass_itr );
2918 buffer_free( sql_buf );
2919 buffer_free( select_buf );
2920 buffer_free( order_buf );
2921 buffer_free( group_buf );
2922 buffer_free( having_buf );
2923 if( defaultselhash ) jsonObjectFree( defaultselhash );
2928 // Make sure the target relation is in the join tree.
2930 // At this point join_hash is a step down from the join_hash we
2931 // received as a parameter. If the original was a JSON_STRING,
2932 // then json_hash is now NULL. If the original was a JSON_HASH,
2933 // then json_hash is now the first (and only) entry in it,
2934 // denoting the core class. We've already excluded the
2935 // possibility that the original was a JSON_ARRAY, because in
2936 // that case from_function would be non-NULL, and we wouldn't
2939 int class_in_from_clause; // boolean
2941 if ( ! strcmp( core_class, cname ))
2942 // This is the core class -- no problem
2943 class_in_from_clause = 1;
2946 // There's only one class in the FROM clause, and this isn't it
2947 class_in_from_clause = 0;
2948 else if (join_hash->type == JSON_STRING) {
2949 // There's only one class in the FROM clause
2950 const char* str = jsonObjectGetString(join_hash);
2951 if ( strcmp( str, cname ) )
2952 class_in_from_clause = 0; // This isn't it
2954 class_in_from_clause = 1; // This is it
2956 jsonObject* found = jsonObjectFindPath(join_hash, "//%s", cname);
2957 if ( 0 == found->size )
2958 class_in_from_clause = 0; // Nowhere in the join tree
2960 class_in_from_clause = 1; // Found it
2961 jsonObjectFree( found );
2965 // If the class isn't in the FROM clause, bail out
2966 if( ! class_in_from_clause ) {
2969 "%s: SELECT clause references class not in FROM clause: \"%s\"",
2974 osrfAppSessionStatus(
2976 OSRF_STATUS_INTERNALSERVERERROR,
2977 "osrfMethodException",
2979 "Selected class not in FROM clause in JSON query"
2981 jsonIteratorFree( selclass_itr );
2982 buffer_free( sql_buf );
2983 buffer_free( select_buf );
2984 buffer_free( order_buf );
2985 buffer_free( group_buf );
2986 buffer_free( having_buf );
2987 if( defaultselhash ) jsonObjectFree( defaultselhash );
2992 // Look up some attributes of the current class, so that we
2993 // don't have to look them up again for each field
2994 osrfHash* class_field_set = osrfHashGet( idlClass, "fields" );
2995 const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
2996 const char* class_tname = osrfHashGet( idlClass, "tablename" );
2998 // stitch together the column list ...
2999 jsonIterator* select_itr = jsonNewIterator( selclass );
3000 while ( (selfield = jsonIteratorNext( select_itr )) ) { // for each SELECT column
3002 // If we need a separator comma, add one
3006 OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3009 // ... if it's a string, just toss it on the pile
3010 if (selfield->type == JSON_STRING) {
3012 // Look up the field in the IDL
3013 const char* col_name = jsonObjectGetString( selfield );
3014 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3016 // No such field in current class
3019 "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3025 osrfAppSessionStatus(
3027 OSRF_STATUS_INTERNALSERVERERROR,
3028 "osrfMethodException",
3030 "Selected column not defined in JSON query"
3032 jsonIteratorFree( select_itr );
3033 jsonIteratorFree( selclass_itr );
3034 buffer_free( sql_buf );
3035 buffer_free( select_buf );
3036 buffer_free( order_buf );
3037 buffer_free( group_buf );
3038 buffer_free( having_buf );
3039 if( defaultselhash ) jsonObjectFree( defaultselhash );
3042 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3043 // Virtual field not allowed
3046 "%s: Selected column \"%s\" for class \"%s\" is virtual",
3052 osrfAppSessionStatus(
3054 OSRF_STATUS_INTERNALSERVERERROR,
3055 "osrfMethodException",
3057 "Selected column may not be virtual in JSON query"
3059 jsonIteratorFree( select_itr );
3060 jsonIteratorFree( selclass_itr );
3061 buffer_free( sql_buf );
3062 buffer_free( select_buf );
3063 buffer_free( order_buf );
3064 buffer_free( group_buf );
3065 buffer_free( having_buf );
3066 if( defaultselhash ) jsonObjectFree( defaultselhash );
3073 if (flags & DISABLE_I18N)
3076 i18n = osrfHashGet(field_def, "i18n");
3078 if( str_is_true( i18n ) ) {
3079 buffer_fadd( select_buf,
3080 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3081 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3083 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3086 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3089 // ... but it could be an object, in which case we check for a Field Transform
3090 } else if (selfield->type == JSON_HASH) {
3092 const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3094 // Get the field definition from the IDL
3095 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3097 // No such field in current class
3100 "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3106 osrfAppSessionStatus(
3108 OSRF_STATUS_INTERNALSERVERERROR,
3109 "osrfMethodException",
3111 "Selected column is not defined in JSON query"
3113 jsonIteratorFree( select_itr );
3114 jsonIteratorFree( selclass_itr );
3115 buffer_free( sql_buf );
3116 buffer_free( select_buf );
3117 buffer_free( order_buf );
3118 buffer_free( group_buf );
3119 buffer_free( having_buf );
3120 if( defaultselhash ) jsonObjectFree( defaultselhash );
3123 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3124 // No such field in current class
3127 "%s: Selected column \"%s\" is virtual for class \"%s\"",
3133 osrfAppSessionStatus(
3135 OSRF_STATUS_INTERNALSERVERERROR,
3136 "osrfMethodException",
3138 "Selected column is virtual in JSON query"
3140 jsonIteratorFree( select_itr );
3141 jsonIteratorFree( selclass_itr );
3142 buffer_free( sql_buf );
3143 buffer_free( select_buf );
3144 buffer_free( order_buf );
3145 buffer_free( group_buf );
3146 buffer_free( having_buf );
3147 if( defaultselhash ) jsonObjectFree( defaultselhash );
3152 // Decide what to use as a column alias
3154 if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3155 _alias = jsonObjectGetString( tmp_const );
3156 } else { // Use field name as the alias
3160 if (jsonObjectGetKeyConst( selfield, "transform" )) {
3161 char* transform_str = searchFieldTransform(cname, field_def, selfield);
3162 if( transform_str ) {
3163 buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3164 free(transform_str);
3167 osrfAppSessionStatus(
3169 OSRF_STATUS_INTERNALSERVERERROR,
3170 "osrfMethodException",
3172 "Unable to generate transform function in JSON query"
3174 jsonIteratorFree( select_itr );
3175 jsonIteratorFree( selclass_itr );
3176 buffer_free( sql_buf );
3177 buffer_free( select_buf );
3178 buffer_free( order_buf );
3179 buffer_free( group_buf );
3180 buffer_free( having_buf );
3181 if( defaultselhash ) jsonObjectFree( defaultselhash );
3189 if (flags & DISABLE_I18N)
3192 i18n = osrfHashGet(field_def, "i18n");
3194 if( str_is_true( i18n ) ) {
3195 buffer_fadd( select_buf,
3196 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3197 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3199 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3202 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3209 "%s: Selected item is unexpected JSON type: %s",
3211 json_type( selfield->type )
3214 osrfAppSessionStatus(
3216 OSRF_STATUS_INTERNALSERVERERROR,
3217 "osrfMethodException",
3219 "Ill-formed SELECT item in JSON query"
3221 jsonIteratorFree( select_itr );
3222 jsonIteratorFree( selclass_itr );
3223 buffer_free( sql_buf );
3224 buffer_free( select_buf );
3225 buffer_free( order_buf );
3226 buffer_free( group_buf );
3227 buffer_free( having_buf );
3228 if( defaultselhash ) jsonObjectFree( defaultselhash );
3233 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3234 if( obj_is_true( agg_obj ) )
3235 aggregate_found = 1;
3237 // Append a comma (except for the first one)
3238 // and add the column to a GROUP BY clause
3242 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3244 buffer_fadd(group_buf, " %d", sel_pos);
3248 if (is_agg->size || (flags & SELECT_DISTINCT)) {
3250 const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3251 if ( ! obj_is_true( aggregate_obj ) ) {
3255 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3258 buffer_fadd(group_buf, " %d", sel_pos);
3261 } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3265 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3268 _column = searchFieldTransform(cname, field, selfield);
3269 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3270 OSRF_BUFFER_ADD(group_buf, _column);
3271 _column = searchFieldTransform(cname, field, selfield);
3278 } // end while -- iterating across SELECT columns
3280 jsonIteratorFree(select_itr);
3281 } // end while -- iterating across classes
3283 jsonIteratorFree(selclass_itr);
3287 char* col_list = buffer_release(select_buf);
3289 if (from_function) table = searchValueTransform(join_hash);
3290 else table = getSourceDefinition(core_meta);
3294 osrfAppSessionStatus(
3296 OSRF_STATUS_INTERNALSERVERERROR,
3297 "osrfMethodException",
3299 "Unable to identify table for core class"
3302 buffer_free( sql_buf );
3303 buffer_free( order_buf );
3304 buffer_free( group_buf );
3305 buffer_free( having_buf );
3306 if( defaultselhash ) jsonObjectFree( defaultselhash );
3311 // Put it all together
3312 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3316 if (!from_function) {
3317 // Now, walk the join tree and add that clause
3319 char* join_clause = searchJOIN( join_hash, core_meta );
3321 buffer_add(sql_buf, join_clause);
3325 osrfAppSessionStatus(
3327 OSRF_STATUS_INTERNALSERVERERROR,
3328 "osrfMethodException",
3330 "Unable to construct JOIN clause(s)"
3332 buffer_free( sql_buf );
3333 buffer_free( order_buf );
3334 buffer_free( group_buf );
3335 buffer_free( having_buf );
3336 if( defaultselhash ) jsonObjectFree( defaultselhash );
3342 // Build a WHERE clause, if there is one
3343 if ( search_hash ) {
3344 buffer_add(sql_buf, " WHERE ");
3346 // and it's on the WHERE clause
3347 char* pred = searchWHERE( search_hash, core_meta, AND_OP_JOIN, ctx );
3350 buffer_add(sql_buf, pred);
3354 osrfAppSessionStatus(
3356 OSRF_STATUS_INTERNALSERVERERROR,
3357 "osrfMethodException",
3359 "Severe query error in WHERE predicate -- see error log for more details"
3363 buffer_free(having_buf);
3364 buffer_free(group_buf);
3365 buffer_free(order_buf);
3366 buffer_free(sql_buf);
3367 if (defaultselhash) jsonObjectFree(defaultselhash);
3372 // Build a HAVING clause, if there is one
3373 if ( having_hash ) {
3374 buffer_add(sql_buf, " HAVING ");
3376 // and it's on the the WHERE clause
3377 char* pred = searchWHERE( having_hash, core_meta, AND_OP_JOIN, ctx );
3380 buffer_add(sql_buf, pred);
3384 osrfAppSessionStatus(
3386 OSRF_STATUS_INTERNALSERVERERROR,
3387 "osrfMethodException",
3389 "Severe query error in HAVING predicate -- see error log for more details"
3393 buffer_free(having_buf);
3394 buffer_free(group_buf);
3395 buffer_free(order_buf);
3396 buffer_free(sql_buf);
3397 if (defaultselhash) jsonObjectFree(defaultselhash);
3402 // Build an ORDER BY clause, if there is one
3404 jsonIterator* class_itr = jsonNewIterator( order_hash );
3405 while ( (snode = jsonIteratorNext( class_itr )) ) {
3407 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
3410 if ( snode->type == JSON_HASH ) {
3412 jsonIterator* order_itr = jsonNewIterator( snode );
3413 while ( (onode = jsonIteratorNext( order_itr )) ) {
3415 if (!oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ))
3418 const char* direction = NULL;
3419 if ( onode->type == JSON_HASH ) {
3420 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3421 string = searchFieldTransform(
3423 oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
3427 osrfAppSessionStatus(
3429 OSRF_STATUS_INTERNALSERVERERROR,
3430 "osrfMethodException",
3432 "Severe query error in ORDER BY clause -- see error log for more details"
3434 jsonIteratorFree( order_itr );
3435 jsonIteratorFree( class_itr );
3437 buffer_free(having_buf);
3438 buffer_free(group_buf);
3439 buffer_free(order_buf);
3440 buffer_free(sql_buf);
3441 if (defaultselhash) jsonObjectFree(defaultselhash);
3445 growing_buffer* field_buf = buffer_init(16);
3446 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3447 string = buffer_release(field_buf);
3450 if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3451 const char* dir = jsonObjectGetString(tmp_const);
3452 if (!strncasecmp(dir, "d", 1)) {
3453 direction = " DESC";
3460 string = strdup(order_itr->key);
3461 const char* dir = jsonObjectGetString(onode);
3462 if (!strncasecmp(dir, "d", 1)) {
3463 direction = " DESC";
3472 buffer_add(order_buf, ", ");
3475 buffer_add(order_buf, string);
3479 buffer_add(order_buf, direction);
3483 // jsonIteratorFree(order_itr);
3485 } else if ( snode->type == JSON_ARRAY ) {
3487 jsonIterator* order_itr = jsonNewIterator( snode );
3488 while ( (onode = jsonIteratorNext( order_itr )) ) {
3490 const char* _f = jsonObjectGetString( onode );
3492 if (!oilsIDLFindPath( "/%s/fields/%s", class_itr->key, _f))
3498 buffer_add(order_buf, ", ");
3501 buffer_add(order_buf, _f);
3504 // jsonIteratorFree(order_itr);
3507 // IT'S THE OOOOOOOOOOOLD STYLE!
3509 osrfLogError(OSRF_LOG_MARK, "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3511 osrfAppSessionStatus(
3513 OSRF_STATUS_INTERNALSERVERERROR,
3514 "osrfMethodException",
3516 "Severe query error -- see error log for more details"
3521 buffer_free(having_buf);
3522 buffer_free(group_buf);
3523 buffer_free(order_buf);
3524 buffer_free(sql_buf);
3525 if (defaultselhash) jsonObjectFree(defaultselhash);
3526 jsonIteratorFree(class_itr);
3531 // jsonIteratorFree(class_itr);
3535 string = buffer_release(group_buf);
3537 if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3538 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3539 OSRF_BUFFER_ADD( sql_buf, string );
3544 string = buffer_release(having_buf);
3547 OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3548 OSRF_BUFFER_ADD( sql_buf, string );
3553 string = buffer_release(order_buf);
3556 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3557 OSRF_BUFFER_ADD( sql_buf, string );
3563 const char* str = jsonObjectGetString(limit);
3564 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3568 const char* str = jsonObjectGetString(offset);
3569 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3572 if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3575 if (defaultselhash) jsonObjectFree(defaultselhash);
3577 return buffer_release(sql_buf);
3581 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3583 const char* locale = osrf_message_get_last_locale();
3585 osrfHash* fields = osrfHashGet(meta, "fields");
3586 char* core_class = osrfHashGet(meta, "classname");
3588 const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3590 jsonObject* node = NULL;
3591 jsonObject* snode = NULL;
3592 jsonObject* onode = NULL;
3593 const jsonObject* _tmp = NULL;
3594 jsonObject* selhash = NULL;
3595 jsonObject* defaultselhash = NULL;
3597 growing_buffer* sql_buf = buffer_init(128);
3598 growing_buffer* select_buf = buffer_init(128);
3600 if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
3601 defaultselhash = jsonNewObjectType(JSON_HASH);
3602 selhash = defaultselhash;
3605 if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
3606 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
3607 jsonObject* flist = jsonObjectGetKey( selhash, core_class );
3612 osrfStringArray* keys = osrfHashKeys( fields );
3613 while ( (field = osrfStringArrayGetString(keys, i++)) ) {
3614 if( ! str_is_true( osrfHashGet( osrfHashGet( fields, field ), "virtual" ) ) )
3615 jsonObjectPush( flist, jsonNewObject( field ) );
3617 osrfStringArrayFree(keys);
3621 jsonIterator* class_itr = jsonNewIterator( selhash );
3622 while ( (snode = jsonIteratorNext( class_itr )) ) {
3624 char* cname = class_itr->key;
3625 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
3626 if (!idlClass) continue;
3628 if (strcmp(core_class,class_itr->key)) {
3629 if (!join_hash) continue;
3631 jsonObject* found = jsonObjectFindPath(join_hash, "//%s", class_itr->key);
3633 jsonObjectFree(found);
3637 jsonObjectFree(found);
3640 jsonIterator* select_itr = jsonNewIterator( snode );
3641 while ( (node = jsonIteratorNext( select_itr )) ) {
3642 const char* item_str = jsonObjectGetString( node );
3643 osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
3644 char* fname = osrfHashGet(field, "name");
3646 if (!field) continue;
3651 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
3656 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
3657 if ( obj_is_true( no_i18n_obj ) ) // Suppress internationalization?
3660 i18n = osrfHashGet(field, "i18n");
3662 if( str_is_true( i18n ) ) {
3663 char* pkey = osrfHashGet(idlClass, "primarykey");
3664 char* tname = osrfHashGet(idlClass, "tablename");
3666 buffer_fadd(select_buf, " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"", tname, cname, fname, pkey, cname, pkey, locale, fname);
3668 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3671 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3675 jsonIteratorFree(select_itr);
3678 jsonIteratorFree(class_itr);
3680 char* col_list = buffer_release(select_buf);
3681 char* table = getSourceDefinition(meta);
3683 table = strdup( "(null)" );
3685 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
3690 char* join_clause = searchJOIN( join_hash, meta );
3691 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
3692 OSRF_BUFFER_ADD(sql_buf, join_clause);
3696 osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL = %s",
3697 MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
3699 buffer_add(sql_buf, " WHERE ");
3701 char* pred = searchWHERE( search_hash, meta, AND_OP_JOIN, ctx );
3703 osrfAppSessionStatus(
3705 OSRF_STATUS_INTERNALSERVERERROR,
3706 "osrfMethodException",
3708 "Severe query error -- see error log for more details"
3710 buffer_free(sql_buf);
3711 if(defaultselhash) jsonObjectFree(defaultselhash);
3714 buffer_add(sql_buf, pred);
3719 char* string = NULL;
3720 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
3722 growing_buffer* order_buf = buffer_init(128);
3725 jsonIterator* class_itr = jsonNewIterator( _tmp );
3726 while ( (snode = jsonIteratorNext( class_itr )) ) {
3728 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
3731 if ( snode->type == JSON_HASH ) {
3733 jsonIterator* order_itr = jsonNewIterator( snode );
3734 while ( (onode = jsonIteratorNext( order_itr )) ) {
3736 if (!oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ))
3739 char* direction = NULL;
3740 if ( onode->type == JSON_HASH ) {
3741 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3742 string = searchFieldTransform(
3744 oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
3748 osrfAppSessionStatus(
3750 OSRF_STATUS_INTERNALSERVERERROR,
3751 "osrfMethodException",
3753 "Severe query error in ORDER BY clause -- see error log for more details"
3755 jsonIteratorFree( order_itr );
3756 jsonIteratorFree( class_itr );
3757 buffer_free( order_buf );
3758 buffer_free( sql_buf );
3759 if( defaultselhash ) jsonObjectFree( defaultselhash );
3763 growing_buffer* field_buf = buffer_init(16);
3764 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3765 string = buffer_release(field_buf);
3768 if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
3769 const char* dir = jsonObjectGetString(_tmp);
3770 if (!strncasecmp(dir, "d", 1)) {
3771 direction = " DESC";
3778 string = strdup(order_itr->key);
3779 const char* dir = jsonObjectGetString(onode);
3780 if (!strncasecmp(dir, "d", 1)) {
3781 direction = " DESC";
3790 buffer_add(order_buf, ", ");
3793 buffer_add(order_buf, string);
3797 buffer_add(order_buf, direction);
3802 jsonIteratorFree(order_itr);
3805 const char* str = jsonObjectGetString(snode);
3806 buffer_add(order_buf, str);
3812 jsonIteratorFree(class_itr);
3814 string = buffer_release(order_buf);
3817 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3818 OSRF_BUFFER_ADD( sql_buf, string );
3824 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
3825 const char* str = jsonObjectGetString(_tmp);
3833 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
3835 const char* str = jsonObjectGetString(_tmp);
3844 if (defaultselhash) jsonObjectFree(defaultselhash);
3846 OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3847 return buffer_release(sql_buf);
3850 int doJSONSearch ( osrfMethodContext* ctx ) {
3851 if(osrfMethodVerifyContext( ctx )) {
3852 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
3856 osrfLogDebug(OSRF_LOG_MARK, "Recieved query request");
3861 dbhandle = writehandle;
3863 jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
3867 if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
3868 flags |= SELECT_DISTINCT;
3870 if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
3871 flags |= DISABLE_I18N;
3873 osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
3876 jsonObjectGetKey( hash, "select" ),
3877 jsonObjectGetKey( hash, "from" ),
3878 jsonObjectGetKey( hash, "where" ),
3879 jsonObjectGetKey( hash, "having" ),
3880 jsonObjectGetKey( hash, "order_by" ),
3881 jsonObjectGetKey( hash, "limit" ),
3882 jsonObjectGetKey( hash, "offset" ),
3891 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
3892 dbi_result result = dbi_conn_query(dbhandle, sql);
3895 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
3897 if (dbi_result_first_row(result)) {
3898 /* JSONify the result */
3899 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
3902 jsonObject* return_val = oilsMakeJSONFromResult( result );
3903 osrfAppRespond( ctx, return_val );
3904 jsonObjectFree( return_val );
3905 } while (dbi_result_next_row(result));
3908 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
3911 osrfAppRespondComplete( ctx, NULL );
3913 /* clean up the query */
3914 dbi_result_free(result);
3918 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
3919 osrfAppSessionStatus(
3921 OSRF_STATUS_INTERNALSERVERERROR,
3922 "osrfMethodException",
3924 "Severe query error -- see error log for more details"
3932 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
3933 const jsonObject* params, int* err ) {
3936 dbhandle = writehandle;
3938 osrfHash* links = osrfHashGet(meta, "links");
3939 osrfHash* fields = osrfHashGet(meta, "fields");
3940 char* core_class = osrfHashGet(meta, "classname");
3941 char* pkey = osrfHashGet(meta, "primarykey");
3943 const jsonObject* _tmp;
3945 jsonObject* search_hash = jsonObjectGetIndex(params, 0);
3946 jsonObject* order_hash = jsonObjectGetIndex(params, 1);
3948 char* sql = buildSELECT( search_hash, order_hash, meta, ctx );
3950 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
3955 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
3957 dbi_result result = dbi_conn_query(dbhandle, sql);
3958 if( NULL == result ) {
3959 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
3960 MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
3961 osrfAppSessionStatus(
3963 OSRF_STATUS_INTERNALSERVERERROR,
3964 "osrfMethodException",
3966 "Severe query error -- see error log for more details"
3973 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
3976 jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
3977 osrfHash* dedup = osrfNewHash();
3979 if (dbi_result_first_row(result)) {
3980 /* JSONify the result */
3981 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
3983 obj = oilsMakeFieldmapperFromResult( result, meta );
3984 char* pkey_val = oilsFMGetString( obj, pkey );
3985 if ( osrfHashGet( dedup, pkey_val ) ) {
3986 jsonObjectFree(obj);
3989 osrfHashSet( dedup, pkey_val, pkey_val );
3990 jsonObjectPush(res_list, obj);
3992 } while (dbi_result_next_row(result));
3994 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
3998 osrfHashFree(dedup);
3999 /* clean up the query */
4000 dbi_result_free(result);
4003 if (res_list->size && order_hash) {
4004 _tmp = jsonObjectGetKeyConst( order_hash, "flesh" );
4006 int x = (int)jsonObjectGetNumber(_tmp);
4007 if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4009 const jsonObject* temp_blob;
4010 if ((temp_blob = jsonObjectGetKeyConst( order_hash, "flesh_fields" )) && x > 0) {
4012 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4013 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4015 osrfStringArray* link_fields = NULL;
4018 if (flesh_fields->size == 1) {
4019 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4020 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4025 link_fields = osrfNewStringArray(1);
4026 jsonIterator* _i = jsonNewIterator( flesh_fields );
4027 while ((_f = jsonIteratorNext( _i ))) {
4028 osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4030 jsonIteratorFree(_i);
4035 jsonIterator* itr = jsonNewIterator( res_list );
4036 while ((cur = jsonIteratorNext( itr ))) {
4041 while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4043 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4045 osrfHash* kid_link = osrfHashGet(links, link_field);
4046 if (!kid_link) continue;
4048 osrfHash* field = osrfHashGet(fields, link_field);
4049 if (!field) continue;
4051 osrfHash* value_field = field;
4053 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4054 if (!kid_idl) continue;
4056 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4057 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4060 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4061 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4064 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4066 if (link_map->size > 0) {
4067 jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4070 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4075 osrfHashGet(kid_link, "class"),
4082 "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4083 osrfHashGet(kid_link, "field"),
4084 osrfHashGet(kid_link, "class"),
4085 osrfHashGet(kid_link, "key"),
4086 osrfHashGet(kid_link, "reltype")
4089 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
4090 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // search hash
4091 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // order/flesh hash
4093 osrfLogDebug(OSRF_LOG_MARK, "Creating dummy params object...");
4095 const char* search_key = jsonObjectGetString(
4098 atoi( osrfHashGet(value_field, "array_position") )
4103 osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4108 jsonObjectGetIndex(fake_params, 0),
4109 osrfHashGet(kid_link, "key"),
4110 jsonNewObject( search_key )
4114 jsonObjectGetIndex(fake_params, 1),
4116 jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4120 jsonObjectSetKey( jsonObjectGetIndex(fake_params, 1), "flesh_fields", jsonObjectClone(flesh_blob) );
4122 if (jsonObjectGetKeyConst(order_hash, "order_by")) {
4124 jsonObjectGetIndex(fake_params, 1),
4126 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "order_by"))
4130 if (jsonObjectGetKeyConst(order_hash, "select")) {
4132 jsonObjectGetIndex(fake_params, 1),
4134 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "select"))
4138 jsonObject* kids = doFieldmapperSearch(ctx, kid_idl, fake_params, err);
4141 jsonObjectFree( fake_params );
4142 osrfStringArrayFree(link_fields);
4143 jsonIteratorFree(itr);
4144 jsonObjectFree(res_list);
4145 jsonObjectFree(flesh_blob);
4149 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4151 jsonObject* X = NULL;
4152 if ( link_map->size > 0 && kids->size > 0 ) {
4154 kids = jsonNewObjectType(JSON_ARRAY);
4156 jsonObject* _k_node;
4157 jsonIterator* _k = jsonNewIterator( X );
4158 while ((_k_node = jsonIteratorNext( _k ))) {
4164 (unsigned long)atoi(
4170 osrfHashGet(kid_link, "class")
4174 osrfStringArrayGetString( link_map, 0 )
4183 jsonIteratorFree(_k);
4186 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4187 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4190 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4191 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4195 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4196 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4199 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4200 jsonObjectClone( kids )
4205 jsonObjectFree(kids);
4209 jsonObjectFree( kids );
4210 jsonObjectFree( fake_params );
4212 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4213 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4217 jsonObjectFree( flesh_blob );
4218 osrfStringArrayFree(link_fields);
4219 jsonIteratorFree(itr);
4228 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4230 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4232 jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4234 jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4237 if (!verifyObjectClass(ctx, target)) {
4242 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4243 osrfAppSessionStatus(
4245 OSRF_STATUS_BADREQUEST,
4246 "osrfMethodException",
4248 "No active transaction -- required for UPDATE"
4254 // The following test is harmless but redundant. If a class is
4255 // readonly, we don't register an update method for it.
4256 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4257 osrfAppSessionStatus(
4259 OSRF_STATUS_BADREQUEST,
4260 "osrfMethodException",
4262 "Cannot UPDATE readonly class"
4268 dbhandle = writehandle;
4270 char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4272 // Set the last_xact_id
4273 int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4275 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
4276 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4279 char* pkey = osrfHashGet(meta, "primarykey");
4280 osrfHash* fields = osrfHashGet(meta, "fields");
4282 char* id = oilsFMGetString( target, pkey );
4286 "%s updating %s object with %s = %s",
4288 osrfHashGet(meta, "fieldmapper"),
4293 growing_buffer* sql = buffer_init(128);
4294 buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4299 osrfStringArray* field_list = osrfHashKeys( fields );
4300 while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
4302 osrfHash* field = osrfHashGet( fields, field_name );
4304 if(!( strcmp( field_name, pkey ) )) continue;
4305 if( str_is_true( osrfHashGet(osrfHashGet(fields,field_name), "virtual") ) )
4308 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4310 int value_is_numeric = 0; // boolean
4312 if (field_object && field_object->classname) {
4313 value = oilsFMGetString(
4315 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4318 value = jsonObjectToSimpleString( field_object );
4319 if( field_object && JSON_NUMBER == field_object->type )
4320 value_is_numeric = 1;
4323 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s", osrfHashGet(meta, "fieldmapper"), field_name, value);
4325 if (!field_object || field_object->type == JSON_NULL) {
4326 if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) ) && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4327 if (first) first = 0;
4328 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4329 buffer_fadd( sql, " %s = NULL", field_name );
4332 } else if ( value_is_numeric || !strcmp( get_primitive( field ), "number") ) {
4333 if (first) first = 0;
4334 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4336 const char* numtype = get_datatype( field );
4337 if ( !strncmp( numtype, "INT", 3 ) ) {
4338 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4339 } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4340 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4342 // Must really be intended as a string, so quote it
4343 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4344 buffer_fadd( sql, " %s = %s", field_name, value );
4346 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4347 osrfAppSessionStatus(
4349 OSRF_STATUS_INTERNALSERVERERROR,
4350 "osrfMethodException",
4352 "Error quoting string -- please see the error log for more details"
4362 osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4365 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4366 if (first) first = 0;
4367 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4368 buffer_fadd( sql, " %s = %s", field_name, value );
4371 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4372 osrfAppSessionStatus(
4374 OSRF_STATUS_INTERNALSERVERERROR,
4375 "osrfMethodException",
4377 "Error quoting string -- please see the error log for more details"
4391 jsonObject* obj = jsonNewObject(id);
4393 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4394 dbi_conn_quote_string(dbhandle, &id);
4396 buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4398 char* query = buffer_release(sql);
4399 osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4401 dbi_result result = dbi_conn_query(dbhandle, query);
4405 jsonObjectFree(obj);
4406 obj = jsonNewObject(NULL);
4409 "%s ERROR updating %s object with %s = %s",
4411 osrfHashGet(meta, "fieldmapper"),
4422 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4424 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4426 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4427 osrfAppSessionStatus(
4429 OSRF_STATUS_BADREQUEST,
4430 "osrfMethodException",
4432 "No active transaction -- required for DELETE"
4438 // The following test is harmless but redundant. If a class is
4439 // readonly, we don't register a delete method for it.
4440 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4441 osrfAppSessionStatus(
4443 OSRF_STATUS_BADREQUEST,
4444 "osrfMethodException",
4446 "Cannot DELETE readonly class"
4452 dbhandle = writehandle;
4456 char* pkey = osrfHashGet(meta, "primarykey");
4464 if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4465 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4470 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4473 if (!verifyObjectPCRUD( ctx, NULL )) {
4478 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4483 "%s deleting %s object with %s = %s",
4485 osrfHashGet(meta, "fieldmapper"),
4490 obj = jsonNewObject(id);
4492 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4493 dbi_conn_quote_string(writehandle, &id);
4495 dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4498 jsonObjectFree(obj);
4499 obj = jsonNewObject(NULL);
4502 "%s ERROR deleting %s object with %s = %s",
4504 osrfHashGet(meta, "fieldmapper"),
4517 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4518 if(!(result && meta)) return jsonNULL;
4520 jsonObject* object = jsonNewObject(NULL);
4521 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4523 osrfHash* fields = osrfHashGet(meta, "fields");
4525 osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4529 char dt_string[256];
4533 int columnIndex = 1;
4535 unsigned short type;
4536 const char* columnName;
4538 /* cycle through the column list */
4539 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4541 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4543 fmIndex = -1; // reset the position
4545 /* determine the field type and storage attributes */
4546 type = dbi_result_get_field_type(result, columnName);
4547 attr = dbi_result_get_field_attribs(result, columnName);
4549 /* fetch the fieldmapper index */
4550 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4552 if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4555 const char* pos = (char*)osrfHashGet(_f, "array_position");
4556 if ( !pos ) continue;
4558 fmIndex = atoi( pos );
4559 osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4564 if (dbi_result_field_is_null(result, columnName)) {
4565 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4570 case DBI_TYPE_INTEGER :
4572 if( attr & DBI_INTEGER_SIZE8 )
4573 jsonObjectSetIndex( object, fmIndex,
4574 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
4576 jsonObjectSetIndex( object, fmIndex,
4577 jsonNewNumberObject(dbi_result_get_int(result, columnName)));
4581 case DBI_TYPE_DECIMAL :
4582 jsonObjectSetIndex( object, fmIndex,
4583 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
4586 case DBI_TYPE_STRING :
4592 jsonNewObject( dbi_result_get_string(result, columnName) )
4597 case DBI_TYPE_DATETIME :
4599 memset(dt_string, '\0', sizeof(dt_string));
4600 memset(&gmdt, '\0', sizeof(gmdt));
4602 _tmp_dt = dbi_result_get_datetime(result, columnName);
4605 if (!(attr & DBI_DATETIME_DATE)) {
4606 gmtime_r( &_tmp_dt, &gmdt );
4607 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4608 } else if (!(attr & DBI_DATETIME_TIME)) {
4609 localtime_r( &_tmp_dt, &gmdt );
4610 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4612 localtime_r( &_tmp_dt, &gmdt );
4613 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4616 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
4620 case DBI_TYPE_BINARY :
4621 osrfLogError( OSRF_LOG_MARK,
4622 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4630 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
4631 if(!result) return jsonNULL;
4633 jsonObject* object = jsonNewObject(NULL);
4636 char dt_string[256];
4640 int columnIndex = 1;
4642 unsigned short type;
4643 const char* columnName;
4645 /* cycle through the column list */
4646 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4648 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4650 fmIndex = -1; // reset the position
4652 /* determine the field type and storage attributes */
4653 type = dbi_result_get_field_type(result, columnName);
4654 attr = dbi_result_get_field_attribs(result, columnName);
4656 if (dbi_result_field_is_null(result, columnName)) {
4657 jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
4662 case DBI_TYPE_INTEGER :
4664 if( attr & DBI_INTEGER_SIZE8 )
4665 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_longlong(result, columnName)) );
4667 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_int(result, columnName)) );
4670 case DBI_TYPE_DECIMAL :
4671 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_double(result, columnName)) );
4674 case DBI_TYPE_STRING :
4675 jsonObjectSetKey( object, columnName, jsonNewObject(dbi_result_get_string(result, columnName)) );
4678 case DBI_TYPE_DATETIME :
4680 memset(dt_string, '\0', sizeof(dt_string));
4681 memset(&gmdt, '\0', sizeof(gmdt));
4683 _tmp_dt = dbi_result_get_datetime(result, columnName);
4686 if (!(attr & DBI_DATETIME_DATE)) {
4687 gmtime_r( &_tmp_dt, &gmdt );
4688 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4689 } else if (!(attr & DBI_DATETIME_TIME)) {
4690 localtime_r( &_tmp_dt, &gmdt );
4691 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4693 localtime_r( &_tmp_dt, &gmdt );
4694 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4697 jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
4700 case DBI_TYPE_BINARY :
4701 osrfLogError( OSRF_LOG_MARK,
4702 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4710 // Interpret a string as true or false
4711 static int str_is_true( const char* str ) {
4712 if( NULL == str || strcasecmp( str, "true" ) )
4718 // Interpret a jsonObject as true or false
4719 static int obj_is_true( const jsonObject* obj ) {
4722 else switch( obj->type )
4730 if( strcasecmp( obj->value.s, "true" ) )
4734 case JSON_NUMBER : // Support 1/0 for perl's sake
4735 if( jsonObjectGetNumber( obj ) == 1.0 )
4744 // Translate a numeric code into a text string identifying a type of
4745 // jsonObject. To be used for building error messages.
4746 static const char* json_type( int code ) {
4752 return "JSON_ARRAY";
4754 return "JSON_STRING";
4756 return "JSON_NUMBER";
4762 return "(unrecognized)";
4766 // Extract the "primitive" attribute from an IDL field definition.
4767 // If we haven't initialized the app, then we must be running in
4768 // some kind of testbed. In that case, default to "string".
4769 static const char* get_primitive( osrfHash* field ) {
4770 const char* s = osrfHashGet( field, "primitive" );
4772 if( child_initialized )
4775 "%s ERROR No \"datatype\" attribute for field \"%s\"",
4777 osrfHashGet( field, "name" )
4785 // Extract the "datatype" attribute from an IDL field definition.
4786 // If we haven't initialized the app, then we must be running in
4787 // some kind of testbed. In that case, default to to NUMERIC,
4788 // since we look at the datatype only for numbers.
4789 static const char* get_datatype( osrfHash* field ) {
4790 const char* s = osrfHashGet( field, "datatype" );
4792 if( child_initialized )
4795 "%s ERROR No \"datatype\" attribute for field \"%s\"",
4797 osrfHashGet( field, "name" )
4806 If the input string is potentially a valid SQL identifier, return 1.
4809 Purpose: to prevent certain kinds of SQL injection. To that end we
4810 don't necessarily need to follow all the rules exactly, such as requiring
4811 that the first character not be a digit.
4813 We allow leading and trailing white space. In between, we do not allow
4814 punctuation (except for underscores and dollar signs), control
4815 characters, or embedded white space.
4817 More pedantically we should allow quoted identifiers containing arbitrary
4818 characters, but for the foreseeable future such quoted identifiers are not
4819 likely to be an issue.
4821 static int is_identifier( const char* s) {
4825 // Skip leading white space
4826 while( isspace( (unsigned char) *s ) )
4830 return 0; // Nothing but white space? Not okay.
4832 // Check each character until we reach white space or
4833 // end-of-string. Letters, digits, underscores, and
4834 // dollar signs are okay. With the exception of periods
4835 // (as in schema.identifier), control characters and other
4836 // punctuation characters are not okay. Anything else
4837 // is okay -- it could for example be part of a multibyte
4838 // UTF8 character such as a letter with diacritical marks,
4839 // and those are allowed.
4841 if( isalnum( (unsigned char) *s )
4845 ; // Fine; keep going
4846 else if( ispunct( (unsigned char) *s )
4847 || iscntrl( (unsigned char) *s ) )
4850 } while( *s && ! isspace( (unsigned char) *s ) );
4852 // If we found any white space in the above loop,
4853 // the rest had better be all white space.
4855 while( isspace( (unsigned char) *s ) )
4859 return 0; // White space was embedded within non-white space
4865 Determine whether to accept a character string as a comparison operator.
4866 Return 1 if it's good, or 0 if it's bad.
4868 We don't validate it for real. We just make sure that it doesn't contain
4869 any semicolons or white space (with a special exception for the
4870 "SIMILAR TO" operator). The idea is to block certain kinds of SQL
4871 injection. If it has no semicolons or white space but it's still not a
4872 valid operator, then the database will complain.
4874 Another approach would be to compare the string against a short list of
4875 approved operators. We don't do that because we want to allow custom
4876 operators like ">100*", which would be difficult or impossible to
4877 express otherwise in a JSON query.
4879 static int is_good_operator( const char* op ) {
4880 if( !op ) return 0; // Sanity check
4884 if( isspace( (unsigned char) *s ) ) {
4885 // Special exception for SIMILAR TO. Someday we might make
4886 // exceptions for IS DISTINCT FROM and IS NOT DISTINCT FROM.
4887 if( !strcasecmp( op, "similar to" ) )
4892 else if( ';' == *s )