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 buffers for the SELECT list and GROUP BY clause
2862 growing_buffer* select_buf = buffer_init(128);
2863 growing_buffer* group_buf = buffer_init(128);
2865 int aggregate_found = 0; // boolean
2867 // Build a select list
2868 if(from_function) // From a function we select everything
2869 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
2872 // If we need to build a default list, prepare to do so
2873 jsonObject* _tmp = jsonObjectGetKey( selhash, core_class );
2874 if ( _tmp && !_tmp->size ) {
2876 osrfHash* core_fields = osrfHashGet( core_meta, "fields" );
2878 osrfHashIterator* field_itr = osrfNewHashIterator( core_fields );
2879 osrfHash* field_def;
2880 while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
2881 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
2882 // This field is not virtual, so add it to the list
2883 jsonObjectPush( _tmp, jsonNewObject( osrfHashIteratorKey( field_itr ) ) );
2886 osrfHashIteratorFree( field_itr );
2889 // Now build the actual select list
2893 jsonIterator* selclass_itr = jsonNewIterator( selhash );
2894 while ( (selclass = jsonIteratorNext( selclass_itr )) ) { // For each class
2896 // Make sure the class is defined in the IDL
2897 const char* cname = selclass_itr->key;
2898 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
2902 "%s: Selected class \"%s\" not defined in IDL",
2908 osrfAppSessionStatus(
2910 OSRF_STATUS_INTERNALSERVERERROR,
2911 "osrfMethodException",
2913 "Selected class is not defined"
2915 jsonIteratorFree( selclass_itr );
2916 buffer_free( sql_buf );
2917 buffer_free( select_buf );
2918 buffer_free( group_buf );
2919 if( defaultselhash ) jsonObjectFree( defaultselhash );
2924 // Make sure the target relation is in the join tree.
2926 // At this point join_hash is a step down from the join_hash we
2927 // received as a parameter. If the original was a JSON_STRING,
2928 // then json_hash is now NULL. If the original was a JSON_HASH,
2929 // then json_hash is now the first (and only) entry in it,
2930 // denoting the core class. We've already excluded the
2931 // possibility that the original was a JSON_ARRAY, because in
2932 // that case from_function would be non-NULL, and we wouldn't
2935 int class_in_from_clause; // boolean
2937 if ( ! strcmp( core_class, cname ))
2938 // This is the core class -- no problem
2939 class_in_from_clause = 1;
2942 // There's only one class in the FROM clause, and this isn't it
2943 class_in_from_clause = 0;
2944 else if (join_hash->type == JSON_STRING) {
2945 // There's only one class in the FROM clause
2946 const char* str = jsonObjectGetString(join_hash);
2947 if ( strcmp( str, cname ) )
2948 class_in_from_clause = 0; // This isn't it
2950 class_in_from_clause = 1; // This is it
2952 jsonObject* found = jsonObjectFindPath(join_hash, "//%s", cname);
2953 if ( 0 == found->size )
2954 class_in_from_clause = 0; // Nowhere in the join tree
2956 class_in_from_clause = 1; // Found it
2957 jsonObjectFree( found );
2961 // If the class isn't in the FROM clause, bail out
2962 if( ! class_in_from_clause ) {
2965 "%s: SELECT clause references class not in FROM clause: \"%s\"",
2970 osrfAppSessionStatus(
2972 OSRF_STATUS_INTERNALSERVERERROR,
2973 "osrfMethodException",
2975 "Selected class not in FROM clause in JSON query"
2977 jsonIteratorFree( selclass_itr );
2978 buffer_free( sql_buf );
2979 buffer_free( select_buf );
2980 buffer_free( group_buf );
2981 if( defaultselhash ) jsonObjectFree( defaultselhash );
2986 // Look up some attributes of the current class, so that we
2987 // don't have to look them up again for each field
2988 osrfHash* class_field_set = osrfHashGet( idlClass, "fields" );
2989 const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
2990 const char* class_tname = osrfHashGet( idlClass, "tablename" );
2992 // stitch together the column list ...
2993 jsonIterator* select_itr = jsonNewIterator( selclass );
2994 while ( (selfield = jsonIteratorNext( select_itr )) ) { // for each SELECT column
2996 // If we need a separator comma, add one
3000 OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3003 // ... if it's a string, just toss it on the pile
3004 if (selfield->type == JSON_STRING) {
3006 // Look up the field in the IDL
3007 const char* col_name = jsonObjectGetString( selfield );
3008 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3010 // No such field in current class
3013 "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3019 osrfAppSessionStatus(
3021 OSRF_STATUS_INTERNALSERVERERROR,
3022 "osrfMethodException",
3024 "Selected column not defined in JSON query"
3026 jsonIteratorFree( select_itr );
3027 jsonIteratorFree( selclass_itr );
3028 buffer_free( sql_buf );
3029 buffer_free( select_buf );
3030 buffer_free( group_buf );
3031 if( defaultselhash ) jsonObjectFree( defaultselhash );
3034 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3035 // Virtual field not allowed
3038 "%s: Selected column \"%s\" for class \"%s\" is virtual",
3044 osrfAppSessionStatus(
3046 OSRF_STATUS_INTERNALSERVERERROR,
3047 "osrfMethodException",
3049 "Selected column may not be virtual in JSON query"
3051 jsonIteratorFree( select_itr );
3052 jsonIteratorFree( selclass_itr );
3053 buffer_free( sql_buf );
3054 buffer_free( select_buf );
3055 buffer_free( group_buf );
3056 if( defaultselhash ) jsonObjectFree( defaultselhash );
3063 if (flags & DISABLE_I18N)
3066 i18n = osrfHashGet(field_def, "i18n");
3068 if( str_is_true( i18n ) ) {
3069 buffer_fadd( select_buf,
3070 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3071 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3073 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3076 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3079 // ... but it could be an object, in which case we check for a Field Transform
3080 } else if (selfield->type == JSON_HASH) {
3082 const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3084 // Get the field definition from the IDL
3085 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3087 // No such field in current class
3090 "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3096 osrfAppSessionStatus(
3098 OSRF_STATUS_INTERNALSERVERERROR,
3099 "osrfMethodException",
3101 "Selected column is not defined in JSON query"
3103 jsonIteratorFree( select_itr );
3104 jsonIteratorFree( selclass_itr );
3105 buffer_free( sql_buf );
3106 buffer_free( select_buf );
3107 buffer_free( group_buf );
3108 if( defaultselhash ) jsonObjectFree( defaultselhash );
3111 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3112 // No such field in current class
3115 "%s: Selected column \"%s\" is virtual for class \"%s\"",
3121 osrfAppSessionStatus(
3123 OSRF_STATUS_INTERNALSERVERERROR,
3124 "osrfMethodException",
3126 "Selected column is virtual in JSON query"
3128 jsonIteratorFree( select_itr );
3129 jsonIteratorFree( selclass_itr );
3130 buffer_free( sql_buf );
3131 buffer_free( select_buf );
3132 buffer_free( group_buf );
3133 if( defaultselhash ) jsonObjectFree( defaultselhash );
3138 // Decide what to use as a column alias
3140 if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3141 _alias = jsonObjectGetString( tmp_const );
3142 } else { // Use field name as the alias
3146 if (jsonObjectGetKeyConst( selfield, "transform" )) {
3147 char* transform_str = searchFieldTransform(cname, field_def, selfield);
3148 if( transform_str ) {
3149 buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3150 free(transform_str);
3153 osrfAppSessionStatus(
3155 OSRF_STATUS_INTERNALSERVERERROR,
3156 "osrfMethodException",
3158 "Unable to generate transform function in JSON query"
3160 jsonIteratorFree( select_itr );
3161 jsonIteratorFree( selclass_itr );
3162 buffer_free( sql_buf );
3163 buffer_free( select_buf );
3164 buffer_free( group_buf );
3165 if( defaultselhash ) jsonObjectFree( defaultselhash );
3173 if (flags & DISABLE_I18N)
3176 i18n = osrfHashGet(field_def, "i18n");
3178 if( str_is_true( i18n ) ) {
3179 buffer_fadd( select_buf,
3180 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3181 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3183 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3186 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3193 "%s: Selected item is unexpected JSON type: %s",
3195 json_type( selfield->type )
3198 osrfAppSessionStatus(
3200 OSRF_STATUS_INTERNALSERVERERROR,
3201 "osrfMethodException",
3203 "Ill-formed SELECT item in JSON query"
3205 jsonIteratorFree( select_itr );
3206 jsonIteratorFree( selclass_itr );
3207 buffer_free( sql_buf );
3208 buffer_free( select_buf );
3209 buffer_free( group_buf );
3210 if( defaultselhash ) jsonObjectFree( defaultselhash );
3215 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3216 if( obj_is_true( agg_obj ) )
3217 aggregate_found = 1;
3219 // Append a comma (except for the first one)
3220 // and add the column to a GROUP BY clause
3224 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3226 buffer_fadd(group_buf, " %d", sel_pos);
3230 if (is_agg->size || (flags & SELECT_DISTINCT)) {
3232 const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3233 if ( ! obj_is_true( aggregate_obj ) ) {
3237 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3240 buffer_fadd(group_buf, " %d", sel_pos);
3243 } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3247 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3250 _column = searchFieldTransform(cname, field, selfield);
3251 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3252 OSRF_BUFFER_ADD(group_buf, _column);
3253 _column = searchFieldTransform(cname, field, selfield);
3260 } // end while -- iterating across SELECT columns
3262 jsonIteratorFree(select_itr);
3263 } // end while -- iterating across classes
3265 jsonIteratorFree(selclass_itr);
3269 char* col_list = buffer_release(select_buf);
3271 if (from_function) table = searchValueTransform(join_hash);
3272 else table = getSourceDefinition(core_meta);
3276 osrfAppSessionStatus(
3278 OSRF_STATUS_INTERNALSERVERERROR,
3279 "osrfMethodException",
3281 "Unable to identify table for core class"
3284 buffer_free( sql_buf );
3285 buffer_free( group_buf );
3286 if( defaultselhash ) jsonObjectFree( defaultselhash );
3291 // Put it all together
3292 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3296 char* order_by_list = NULL;
3297 growing_buffer* having_buf = buffer_init(128);
3299 if (!from_function) {
3301 // Now, walk the join tree and add that clause
3303 char* join_clause = searchJOIN( join_hash, core_meta );
3305 buffer_add(sql_buf, join_clause);
3309 osrfAppSessionStatus(
3311 OSRF_STATUS_INTERNALSERVERERROR,
3312 "osrfMethodException",
3314 "Unable to construct JOIN clause(s)"
3316 buffer_free( sql_buf );
3317 buffer_free( group_buf );
3318 buffer_free( having_buf );
3319 if( defaultselhash ) jsonObjectFree( defaultselhash );
3325 // Build a WHERE clause, if there is one
3326 if ( search_hash ) {
3327 buffer_add(sql_buf, " WHERE ");
3329 // and it's on the WHERE clause
3330 char* pred = searchWHERE( search_hash, core_meta, AND_OP_JOIN, ctx );
3333 buffer_add(sql_buf, pred);
3337 osrfAppSessionStatus(
3339 OSRF_STATUS_INTERNALSERVERERROR,
3340 "osrfMethodException",
3342 "Severe query error in WHERE predicate -- see error log for more details"
3346 buffer_free(having_buf);
3347 buffer_free(group_buf);
3348 buffer_free(sql_buf);
3349 if (defaultselhash) jsonObjectFree(defaultselhash);
3354 // Build a HAVING clause, if there is one
3355 if ( having_hash ) {
3356 buffer_add(sql_buf, " HAVING ");
3358 // and it's on the the WHERE clause
3359 char* pred = searchWHERE( having_hash, core_meta, AND_OP_JOIN, ctx );
3362 buffer_add(sql_buf, pred);
3366 osrfAppSessionStatus(
3368 OSRF_STATUS_INTERNALSERVERERROR,
3369 "osrfMethodException",
3371 "Severe query error in HAVING predicate -- see error log for more details"
3375 buffer_free(having_buf);
3376 buffer_free(group_buf);
3377 buffer_free(sql_buf);
3378 if (defaultselhash) jsonObjectFree(defaultselhash);
3383 growing_buffer* order_buf = NULL; // to collect ORDER BY list
3385 // Build an ORDER BY clause, if there is one
3386 if( NULL == order_hash )
3387 ; // No ORDER BY? do nothing
3388 else if( JSON_ARRAY == order_hash->type ) {
3389 // Array of field specifications, each specification being a
3390 // hash to define the class, field, and other details
3392 jsonObject* order_spec;
3393 while( (order_spec = jsonObjectGetIndex( order_hash, order_idx++ ) ) ) {
3395 if( JSON_HASH != order_spec->type ) {
3396 osrfLogError(OSRF_LOG_MARK,
3397 "%s: Malformed field specification in ORDER BY clause; expected JSON_HASH, found %s",
3398 MODULENAME, json_type( order_spec->type ) );
3400 osrfAppSessionStatus(
3402 OSRF_STATUS_INTERNALSERVERERROR,
3403 "osrfMethodException",
3405 "Malformed ORDER BY clause -- see error log for more details"
3407 buffer_free( order_buf );
3409 buffer_free(having_buf);
3410 buffer_free(group_buf);
3411 buffer_free(sql_buf);
3412 if (defaultselhash) jsonObjectFree(defaultselhash);
3417 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "class" ) );
3419 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "field" ) );
3422 OSRF_BUFFER_ADD(order_buf, ", ");
3424 order_buf = buffer_init(128);
3426 if( !field || !class ) {
3427 osrfLogError(OSRF_LOG_MARK,
3428 "%s: Missing class or field name in field specification of ORDER BY clause",
3431 osrfAppSessionStatus(
3433 OSRF_STATUS_INTERNALSERVERERROR,
3434 "osrfMethodException",
3436 "Malformed ORDER BY clause -- see error log for more details"
3438 buffer_free( order_buf );
3440 buffer_free(having_buf);
3441 buffer_free(group_buf);
3442 buffer_free(sql_buf);
3443 if (defaultselhash) jsonObjectFree(defaultselhash);
3447 if (!jsonObjectGetKeyConst( selhash,class ) ) {
3448 osrfLogError(OSRF_LOG_MARK, "%s: ORDER BY clause references class \"%s\" "
3449 "not in SELECT clause", MODULENAME, class );
3451 osrfAppSessionStatus(
3453 OSRF_STATUS_INTERNALSERVERERROR,
3454 "osrfMethodException",
3456 "Invalid class referenced in ORDER BY clause -- see error log for more details"
3459 buffer_free(having_buf);
3460 buffer_free(group_buf);
3461 buffer_free(sql_buf);
3462 if (defaultselhash) jsonObjectFree(defaultselhash);
3466 osrfHash* field_def = oilsIDLFindPath( "/%s/fields/%s", class, field );
3468 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\".%s referenced in ORDER BY clause",
3469 MODULENAME, class, field );
3471 osrfAppSessionStatus(
3473 OSRF_STATUS_INTERNALSERVERERROR,
3474 "osrfMethodException",
3476 "Invalid field referenced in ORDER BY clause -- see error log for more details"
3479 buffer_free(having_buf);
3480 buffer_free(group_buf);
3481 buffer_free(sql_buf);
3482 if (defaultselhash) jsonObjectFree(defaultselhash);
3484 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3485 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3486 MODULENAME, field );
3488 osrfAppSessionStatus(
3490 OSRF_STATUS_INTERNALSERVERERROR,
3491 "osrfMethodException",
3493 "Virtual field in ORDER BY clause -- see error log for more details"
3495 buffer_free( order_buf );
3497 buffer_free(having_buf);
3498 buffer_free(group_buf);
3499 buffer_free(sql_buf);
3500 if (defaultselhash) jsonObjectFree(defaultselhash);
3504 if( jsonObjectGetKeyConst( order_spec, "transform" ) ) {
3505 char* transform_str = searchFieldTransform( class, field_def, order_spec );
3506 if( ! transform_str ) {
3508 osrfAppSessionStatus(
3510 OSRF_STATUS_INTERNALSERVERERROR,
3511 "osrfMethodException",
3513 "Severe query error in ORDER BY clause -- see error log for more details"
3515 buffer_free( order_buf );
3517 buffer_free(having_buf);
3518 buffer_free(group_buf);
3519 buffer_free(sql_buf);
3520 if (defaultselhash) jsonObjectFree(defaultselhash);
3524 OSRF_BUFFER_ADD( order_buf, transform_str );
3525 free( transform_str );
3528 buffer_fadd( order_buf, "\"%s\".%s", class, field );
3530 const char* direction =
3531 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "direction" ) );
3533 if( direction[ 0 ] || 'D' == direction[ 0 ] )
3534 OSRF_BUFFER_ADD( order_buf, " DESC" );
3536 OSRF_BUFFER_ADD( order_buf, " ASC" );
3539 } else if( JSON_HASH == order_hash->type ) {
3540 // This hash is keyed on class name. Each class has either
3541 // an array of field names or a hash keyed on field name.
3542 jsonIterator* class_itr = jsonNewIterator( order_hash );
3543 while ( (snode = jsonIteratorNext( class_itr )) ) {
3545 if (!jsonObjectGetKeyConst(selhash,class_itr->key)) {
3546 osrfLogError(OSRF_LOG_MARK, "%s: Invalid class \"%s\" referenced in ORDER BY clause",
3547 MODULENAME, class_itr->key );
3549 osrfAppSessionStatus(
3551 OSRF_STATUS_INTERNALSERVERERROR,
3552 "osrfMethodException",
3554 "Invalid class referenced in ORDER BY clause -- see error log for more details"
3556 jsonIteratorFree( class_itr );
3557 buffer_free( order_buf );
3559 buffer_free(having_buf);
3560 buffer_free(group_buf);
3561 buffer_free(sql_buf);
3562 if (defaultselhash) jsonObjectFree(defaultselhash);
3566 osrfHash* field_list_def = oilsIDLFindPath( "/%s/fields", class_itr->key );
3568 if ( snode->type == JSON_HASH ) {
3570 // Hash is keyed on field names from the current class. For each field
3571 // there is another layer of hash to define the sorting details, if any,
3572 // or a string to indicate direction of sorting.
3573 jsonIterator* order_itr = jsonNewIterator( snode );
3574 while ( (onode = jsonIteratorNext( order_itr )) ) {
3576 osrfHash* field_def = osrfHashGet( field_list_def, order_itr->key );
3578 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3579 MODULENAME, order_itr->key );
3581 osrfAppSessionStatus(
3583 OSRF_STATUS_INTERNALSERVERERROR,
3584 "osrfMethodException",
3586 "Invalid field in ORDER BY clause -- see error log for more details"
3588 jsonIteratorFree( order_itr );
3589 jsonIteratorFree( class_itr );
3590 buffer_free( order_buf );
3592 buffer_free(having_buf);
3593 buffer_free(group_buf);
3594 buffer_free(sql_buf);
3595 if (defaultselhash) jsonObjectFree(defaultselhash);
3597 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3598 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3599 MODULENAME, order_itr->key );
3601 osrfAppSessionStatus(
3603 OSRF_STATUS_INTERNALSERVERERROR,
3604 "osrfMethodException",
3606 "Virtual field in ORDER BY clause -- see error log for more details"
3608 jsonIteratorFree( order_itr );
3609 jsonIteratorFree( class_itr );
3610 buffer_free( order_buf );
3612 buffer_free(having_buf);
3613 buffer_free(group_buf);
3614 buffer_free(sql_buf);
3615 if (defaultselhash) jsonObjectFree(defaultselhash);
3619 const char* direction = NULL;
3620 if ( onode->type == JSON_HASH ) {
3621 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3622 string = searchFieldTransform(
3624 oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
3628 if( ctx ) osrfAppSessionStatus(
3630 OSRF_STATUS_INTERNALSERVERERROR,
3631 "osrfMethodException",
3633 "Severe query error in ORDER BY clause -- see error log for more details"
3635 jsonIteratorFree( order_itr );
3636 jsonIteratorFree( class_itr );
3638 buffer_free(having_buf);
3639 buffer_free(group_buf);
3640 buffer_free(order_buf);
3641 buffer_free(sql_buf);
3642 if (defaultselhash) jsonObjectFree(defaultselhash);
3646 growing_buffer* field_buf = buffer_init(16);
3647 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3648 string = buffer_release(field_buf);
3651 if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3652 const char* dir = jsonObjectGetString(tmp_const);
3653 if (!strncasecmp(dir, "d", 1)) {
3654 direction = " DESC";
3660 } else if ( JSON_NULL == onode->type || JSON_ARRAY == onode->type ) {
3661 osrfLogError( OSRF_LOG_MARK,
3662 "%s: Expected JSON_STRING in ORDER BY clause; found %s",
3663 MODULENAME, json_type( onode->type ) );
3665 osrfAppSessionStatus(
3667 OSRF_STATUS_INTERNALSERVERERROR,
3668 "osrfMethodException",
3670 "Malformed ORDER BY clause -- see error log for more details"
3672 jsonIteratorFree( order_itr );
3673 jsonIteratorFree( class_itr );
3675 buffer_free(having_buf);
3676 buffer_free(group_buf);
3677 buffer_free(order_buf);
3678 buffer_free(sql_buf);
3679 if (defaultselhash) jsonObjectFree(defaultselhash);
3683 string = strdup(order_itr->key);
3684 const char* dir = jsonObjectGetString(onode);
3685 if (!strncasecmp(dir, "d", 1)) {
3686 direction = " DESC";
3693 OSRF_BUFFER_ADD(order_buf, ", ");
3695 order_buf = buffer_init(128);
3697 OSRF_BUFFER_ADD(order_buf, string);
3701 OSRF_BUFFER_ADD(order_buf, direction);
3705 // jsonIteratorFree(order_itr);
3707 } else if ( snode->type == JSON_ARRAY ) {
3709 // Array is a list of fields from the current class
3710 jsonIterator* order_itr = jsonNewIterator( snode );
3711 while ( (onode = jsonIteratorNext( order_itr )) ) {
3713 const char* _f = jsonObjectGetString( onode );
3715 osrfHash* field_def = osrfHashGet( field_list_def, _f );
3717 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3720 osrfAppSessionStatus(
3722 OSRF_STATUS_INTERNALSERVERERROR,
3723 "osrfMethodException",
3725 "Invalid field in ORDER BY clause -- see error log for more details"
3727 jsonIteratorFree( order_itr );
3728 jsonIteratorFree( class_itr );
3729 buffer_free( order_buf );
3731 buffer_free(having_buf);
3732 buffer_free(group_buf);
3733 buffer_free(sql_buf);
3734 if (defaultselhash) jsonObjectFree(defaultselhash);
3736 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3737 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3740 osrfAppSessionStatus(
3742 OSRF_STATUS_INTERNALSERVERERROR,
3743 "osrfMethodException",
3745 "Virtual field in ORDER BY clause -- see error log for more details"
3747 jsonIteratorFree( order_itr );
3748 jsonIteratorFree( class_itr );
3749 buffer_free( order_buf );
3751 buffer_free(having_buf);
3752 buffer_free(group_buf);
3753 buffer_free(sql_buf);
3754 if (defaultselhash) jsonObjectFree(defaultselhash);
3759 OSRF_BUFFER_ADD(order_buf, ", ");
3761 order_buf = buffer_init(128);
3763 OSRF_BUFFER_ADD(order_buf, _f);
3766 // jsonIteratorFree(order_itr);
3769 // IT'S THE OOOOOOOOOOOLD STYLE!
3771 osrfLogError(OSRF_LOG_MARK,
3772 "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3774 osrfAppSessionStatus(
3776 OSRF_STATUS_INTERNALSERVERERROR,
3777 "osrfMethodException",
3779 "Severe query error -- see error log for more details"
3784 buffer_free(having_buf);
3785 buffer_free(group_buf);
3786 buffer_free(order_buf);
3787 buffer_free(sql_buf);
3788 if (defaultselhash) jsonObjectFree(defaultselhash);
3789 jsonIteratorFree(class_itr);
3794 osrfLogError(OSRF_LOG_MARK,
3795 "%s: Malformed ORDER BY clause; expected JSON_HASH or JSON_ARRAY, found %s",
3796 MODULENAME, json_type( order_hash->type ) );
3798 osrfAppSessionStatus(
3800 OSRF_STATUS_INTERNALSERVERERROR,
3801 "osrfMethodException",
3803 "Malformed ORDER BY clause -- see error log for more details"
3805 buffer_free( order_buf );
3807 buffer_free(having_buf);
3808 buffer_free(group_buf);
3809 buffer_free(sql_buf);
3810 if (defaultselhash) jsonObjectFree(defaultselhash);
3813 // jsonIteratorFree(class_itr);
3816 order_by_list = buffer_release( order_buf );
3820 string = buffer_release(group_buf);
3822 if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3823 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3824 OSRF_BUFFER_ADD( sql_buf, string );
3830 string = buffer_release(having_buf);
3833 OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3834 OSRF_BUFFER_ADD( sql_buf, string );
3840 if( order_by_list ) {
3842 if ( *order_by_list ) {
3843 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3844 OSRF_BUFFER_ADD( sql_buf, order_by_list );
3847 free( order_by_list );
3851 const char* str = jsonObjectGetString(limit);
3852 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3856 const char* str = jsonObjectGetString(offset);
3857 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3860 if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3863 if (defaultselhash) jsonObjectFree(defaultselhash);
3865 return buffer_release(sql_buf);
3869 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3871 const char* locale = osrf_message_get_last_locale();
3873 osrfHash* fields = osrfHashGet(meta, "fields");
3874 char* core_class = osrfHashGet(meta, "classname");
3876 const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3878 jsonObject* node = NULL;
3879 jsonObject* snode = NULL;
3880 jsonObject* onode = NULL;
3881 const jsonObject* _tmp = NULL;
3882 jsonObject* selhash = NULL;
3883 jsonObject* defaultselhash = NULL;
3885 growing_buffer* sql_buf = buffer_init(128);
3886 growing_buffer* select_buf = buffer_init(128);
3888 if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
3889 defaultselhash = jsonNewObjectType(JSON_HASH);
3890 selhash = defaultselhash;
3893 if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
3894 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
3895 jsonObject* flist = jsonObjectGetKey( selhash, core_class );
3900 osrfStringArray* keys = osrfHashKeys( fields );
3901 while ( (field = osrfStringArrayGetString(keys, i++)) ) {
3902 if( ! str_is_true( osrfHashGet( osrfHashGet( fields, field ), "virtual" ) ) )
3903 jsonObjectPush( flist, jsonNewObject( field ) );
3905 osrfStringArrayFree(keys);
3909 jsonIterator* class_itr = jsonNewIterator( selhash );
3910 while ( (snode = jsonIteratorNext( class_itr )) ) {
3912 char* cname = class_itr->key;
3913 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
3914 if (!idlClass) continue;
3916 if (strcmp(core_class,class_itr->key)) {
3917 if (!join_hash) continue;
3919 jsonObject* found = jsonObjectFindPath(join_hash, "//%s", class_itr->key);
3921 jsonObjectFree(found);
3925 jsonObjectFree(found);
3928 jsonIterator* select_itr = jsonNewIterator( snode );
3929 while ( (node = jsonIteratorNext( select_itr )) ) {
3930 const char* item_str = jsonObjectGetString( node );
3931 osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
3932 char* fname = osrfHashGet(field, "name");
3934 if (!field) continue;
3939 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
3944 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
3945 if ( obj_is_true( no_i18n_obj ) ) // Suppress internationalization?
3948 i18n = osrfHashGet(field, "i18n");
3950 if( str_is_true( i18n ) ) {
3951 char* pkey = osrfHashGet(idlClass, "primarykey");
3952 char* tname = osrfHashGet(idlClass, "tablename");
3954 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);
3956 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3959 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3963 jsonIteratorFree(select_itr);
3966 jsonIteratorFree(class_itr);
3968 char* col_list = buffer_release(select_buf);
3969 char* table = getSourceDefinition(meta);
3971 table = strdup( "(null)" );
3973 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
3978 char* join_clause = searchJOIN( join_hash, meta );
3979 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
3980 OSRF_BUFFER_ADD(sql_buf, join_clause);
3984 osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL = %s",
3985 MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
3987 OSRF_BUFFER_ADD(sql_buf, " WHERE ");
3989 char* pred = searchWHERE( search_hash, meta, AND_OP_JOIN, ctx );
3991 osrfAppSessionStatus(
3993 OSRF_STATUS_INTERNALSERVERERROR,
3994 "osrfMethodException",
3996 "Severe query error -- see error log for more details"
3998 buffer_free(sql_buf);
3999 if(defaultselhash) jsonObjectFree(defaultselhash);
4002 buffer_add(sql_buf, pred);
4007 char* string = NULL;
4008 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
4010 growing_buffer* order_buf = buffer_init(128);
4013 jsonIterator* class_itr = jsonNewIterator( _tmp );
4014 while ( (snode = jsonIteratorNext( class_itr )) ) {
4016 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
4019 if ( snode->type == JSON_HASH ) {
4021 jsonIterator* order_itr = jsonNewIterator( snode );
4022 while ( (onode = jsonIteratorNext( order_itr )) ) {
4024 if (!oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ))
4027 char* direction = NULL;
4028 if ( onode->type == JSON_HASH ) {
4029 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
4030 string = searchFieldTransform(
4032 oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
4036 osrfAppSessionStatus(
4038 OSRF_STATUS_INTERNALSERVERERROR,
4039 "osrfMethodException",
4041 "Severe query error in ORDER BY clause -- see error log for more details"
4043 jsonIteratorFree( order_itr );
4044 jsonIteratorFree( class_itr );
4045 buffer_free( order_buf );
4046 buffer_free( sql_buf );
4047 if( defaultselhash ) jsonObjectFree( defaultselhash );
4051 growing_buffer* field_buf = buffer_init(16);
4052 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
4053 string = buffer_release(field_buf);
4056 if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
4057 const char* dir = jsonObjectGetString(_tmp);
4058 if (!strncasecmp(dir, "d", 1)) {
4059 direction = " DESC";
4066 string = strdup(order_itr->key);
4067 const char* dir = jsonObjectGetString(onode);
4068 if (!strncasecmp(dir, "d", 1)) {
4069 direction = " DESC";
4078 buffer_add(order_buf, ", ");
4081 buffer_add(order_buf, string);
4085 buffer_add(order_buf, direction);
4090 jsonIteratorFree(order_itr);
4093 const char* str = jsonObjectGetString(snode);
4094 buffer_add(order_buf, str);
4100 jsonIteratorFree(class_itr);
4102 string = buffer_release(order_buf);
4105 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
4106 OSRF_BUFFER_ADD( sql_buf, string );
4112 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
4113 const char* str = jsonObjectGetString(_tmp);
4121 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
4123 const char* str = jsonObjectGetString(_tmp);
4132 if (defaultselhash) jsonObjectFree(defaultselhash);
4134 OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
4135 return buffer_release(sql_buf);
4138 int doJSONSearch ( osrfMethodContext* ctx ) {
4139 if(osrfMethodVerifyContext( ctx )) {
4140 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
4144 osrfLogDebug(OSRF_LOG_MARK, "Recieved query request");
4149 dbhandle = writehandle;
4151 jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
4155 if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
4156 flags |= SELECT_DISTINCT;
4158 if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
4159 flags |= DISABLE_I18N;
4161 osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
4164 jsonObjectGetKey( hash, "select" ),
4165 jsonObjectGetKey( hash, "from" ),
4166 jsonObjectGetKey( hash, "where" ),
4167 jsonObjectGetKey( hash, "having" ),
4168 jsonObjectGetKey( hash, "order_by" ),
4169 jsonObjectGetKey( hash, "limit" ),
4170 jsonObjectGetKey( hash, "offset" ),
4179 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
4180 dbi_result result = dbi_conn_query(dbhandle, sql);
4183 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4185 if (dbi_result_first_row(result)) {
4186 /* JSONify the result */
4187 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4190 jsonObject* return_val = oilsMakeJSONFromResult( result );
4191 osrfAppRespond( ctx, return_val );
4192 jsonObjectFree( return_val );
4193 } while (dbi_result_next_row(result));
4196 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
4199 osrfAppRespondComplete( ctx, NULL );
4201 /* clean up the query */
4202 dbi_result_free(result);
4206 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
4207 osrfAppSessionStatus(
4209 OSRF_STATUS_INTERNALSERVERERROR,
4210 "osrfMethodException",
4212 "Severe query error -- see error log for more details"
4220 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
4221 const jsonObject* params, int* err ) {
4224 dbhandle = writehandle;
4226 osrfHash* links = osrfHashGet(meta, "links");
4227 osrfHash* fields = osrfHashGet(meta, "fields");
4228 char* core_class = osrfHashGet(meta, "classname");
4229 char* pkey = osrfHashGet(meta, "primarykey");
4231 const jsonObject* _tmp;
4233 jsonObject* search_hash = jsonObjectGetIndex(params, 0);
4234 jsonObject* order_hash = jsonObjectGetIndex(params, 1);
4236 char* sql = buildSELECT( search_hash, order_hash, meta, ctx );
4238 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
4243 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
4245 dbi_result result = dbi_conn_query(dbhandle, sql);
4246 if( NULL == result ) {
4247 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
4248 MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
4249 osrfAppSessionStatus(
4251 OSRF_STATUS_INTERNALSERVERERROR,
4252 "osrfMethodException",
4254 "Severe query error -- see error log for more details"
4261 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4264 jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
4265 osrfHash* dedup = osrfNewHash();
4267 if (dbi_result_first_row(result)) {
4268 /* JSONify the result */
4269 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4271 obj = oilsMakeFieldmapperFromResult( result, meta );
4272 char* pkey_val = oilsFMGetString( obj, pkey );
4273 if ( osrfHashGet( dedup, pkey_val ) ) {
4274 jsonObjectFree(obj);
4277 osrfHashSet( dedup, pkey_val, pkey_val );
4278 jsonObjectPush(res_list, obj);
4280 } while (dbi_result_next_row(result));
4282 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
4286 osrfHashFree(dedup);
4287 /* clean up the query */
4288 dbi_result_free(result);
4291 if (res_list->size && order_hash) {
4292 _tmp = jsonObjectGetKeyConst( order_hash, "flesh" );
4294 int x = (int)jsonObjectGetNumber(_tmp);
4295 if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4297 const jsonObject* temp_blob;
4298 if ((temp_blob = jsonObjectGetKeyConst( order_hash, "flesh_fields" )) && x > 0) {
4300 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4301 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4303 osrfStringArray* link_fields = NULL;
4306 if (flesh_fields->size == 1) {
4307 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4308 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4313 link_fields = osrfNewStringArray(1);
4314 jsonIterator* _i = jsonNewIterator( flesh_fields );
4315 while ((_f = jsonIteratorNext( _i ))) {
4316 osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4318 jsonIteratorFree(_i);
4323 jsonIterator* itr = jsonNewIterator( res_list );
4324 while ((cur = jsonIteratorNext( itr ))) {
4329 while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4331 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4333 osrfHash* kid_link = osrfHashGet(links, link_field);
4334 if (!kid_link) continue;
4336 osrfHash* field = osrfHashGet(fields, link_field);
4337 if (!field) continue;
4339 osrfHash* value_field = field;
4341 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4342 if (!kid_idl) continue;
4344 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4345 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4348 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4349 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4352 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4354 if (link_map->size > 0) {
4355 jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4358 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4363 osrfHashGet(kid_link, "class"),
4370 "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4371 osrfHashGet(kid_link, "field"),
4372 osrfHashGet(kid_link, "class"),
4373 osrfHashGet(kid_link, "key"),
4374 osrfHashGet(kid_link, "reltype")
4377 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
4378 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // search hash
4379 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // order/flesh hash
4381 osrfLogDebug(OSRF_LOG_MARK, "Creating dummy params object...");
4383 const char* search_key = jsonObjectGetString(
4386 atoi( osrfHashGet(value_field, "array_position") )
4391 osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4396 jsonObjectGetIndex(fake_params, 0),
4397 osrfHashGet(kid_link, "key"),
4398 jsonNewObject( search_key )
4402 jsonObjectGetIndex(fake_params, 1),
4404 jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4408 jsonObjectSetKey( jsonObjectGetIndex(fake_params, 1), "flesh_fields", jsonObjectClone(flesh_blob) );
4410 if (jsonObjectGetKeyConst(order_hash, "order_by")) {
4412 jsonObjectGetIndex(fake_params, 1),
4414 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "order_by"))
4418 if (jsonObjectGetKeyConst(order_hash, "select")) {
4420 jsonObjectGetIndex(fake_params, 1),
4422 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "select"))
4426 jsonObject* kids = doFieldmapperSearch(ctx, kid_idl, fake_params, err);
4429 jsonObjectFree( fake_params );
4430 osrfStringArrayFree(link_fields);
4431 jsonIteratorFree(itr);
4432 jsonObjectFree(res_list);
4433 jsonObjectFree(flesh_blob);
4437 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4439 jsonObject* X = NULL;
4440 if ( link_map->size > 0 && kids->size > 0 ) {
4442 kids = jsonNewObjectType(JSON_ARRAY);
4444 jsonObject* _k_node;
4445 jsonIterator* _k = jsonNewIterator( X );
4446 while ((_k_node = jsonIteratorNext( _k ))) {
4452 (unsigned long)atoi(
4458 osrfHashGet(kid_link, "class")
4462 osrfStringArrayGetString( link_map, 0 )
4471 jsonIteratorFree(_k);
4474 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4475 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4478 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4479 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4483 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4484 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4487 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4488 jsonObjectClone( kids )
4493 jsonObjectFree(kids);
4497 jsonObjectFree( kids );
4498 jsonObjectFree( fake_params );
4500 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4501 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4505 jsonObjectFree( flesh_blob );
4506 osrfStringArrayFree(link_fields);
4507 jsonIteratorFree(itr);
4516 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4518 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4520 jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4522 jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4525 if (!verifyObjectClass(ctx, target)) {
4530 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4531 osrfAppSessionStatus(
4533 OSRF_STATUS_BADREQUEST,
4534 "osrfMethodException",
4536 "No active transaction -- required for UPDATE"
4542 // The following test is harmless but redundant. If a class is
4543 // readonly, we don't register an update method for it.
4544 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4545 osrfAppSessionStatus(
4547 OSRF_STATUS_BADREQUEST,
4548 "osrfMethodException",
4550 "Cannot UPDATE readonly class"
4556 dbhandle = writehandle;
4558 char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4560 // Set the last_xact_id
4561 int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4563 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
4564 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4567 char* pkey = osrfHashGet(meta, "primarykey");
4568 osrfHash* fields = osrfHashGet(meta, "fields");
4570 char* id = oilsFMGetString( target, pkey );
4574 "%s updating %s object with %s = %s",
4576 osrfHashGet(meta, "fieldmapper"),
4581 growing_buffer* sql = buffer_init(128);
4582 buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4587 osrfStringArray* field_list = osrfHashKeys( fields );
4588 while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
4590 osrfHash* field = osrfHashGet( fields, field_name );
4592 if(!( strcmp( field_name, pkey ) )) continue;
4593 if( str_is_true( osrfHashGet(osrfHashGet(fields,field_name), "virtual") ) )
4596 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4598 int value_is_numeric = 0; // boolean
4600 if (field_object && field_object->classname) {
4601 value = oilsFMGetString(
4603 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4606 value = jsonObjectToSimpleString( field_object );
4607 if( field_object && JSON_NUMBER == field_object->type )
4608 value_is_numeric = 1;
4611 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s", osrfHashGet(meta, "fieldmapper"), field_name, value);
4613 if (!field_object || field_object->type == JSON_NULL) {
4614 if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) ) && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4615 if (first) first = 0;
4616 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4617 buffer_fadd( sql, " %s = NULL", field_name );
4620 } else if ( value_is_numeric || !strcmp( get_primitive( field ), "number") ) {
4621 if (first) first = 0;
4622 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4624 const char* numtype = get_datatype( field );
4625 if ( !strncmp( numtype, "INT", 3 ) ) {
4626 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4627 } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4628 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4630 // Must really be intended as a string, so quote it
4631 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4632 buffer_fadd( sql, " %s = %s", field_name, value );
4634 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4635 osrfAppSessionStatus(
4637 OSRF_STATUS_INTERNALSERVERERROR,
4638 "osrfMethodException",
4640 "Error quoting string -- please see the error log for more details"
4650 osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4653 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4654 if (first) first = 0;
4655 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4656 buffer_fadd( sql, " %s = %s", field_name, value );
4659 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4660 osrfAppSessionStatus(
4662 OSRF_STATUS_INTERNALSERVERERROR,
4663 "osrfMethodException",
4665 "Error quoting string -- please see the error log for more details"
4679 jsonObject* obj = jsonNewObject(id);
4681 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4682 dbi_conn_quote_string(dbhandle, &id);
4684 buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4686 char* query = buffer_release(sql);
4687 osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4689 dbi_result result = dbi_conn_query(dbhandle, query);
4693 jsonObjectFree(obj);
4694 obj = jsonNewObject(NULL);
4697 "%s ERROR updating %s object with %s = %s",
4699 osrfHashGet(meta, "fieldmapper"),
4710 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4712 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4714 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4715 osrfAppSessionStatus(
4717 OSRF_STATUS_BADREQUEST,
4718 "osrfMethodException",
4720 "No active transaction -- required for DELETE"
4726 // The following test is harmless but redundant. If a class is
4727 // readonly, we don't register a delete method for it.
4728 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4729 osrfAppSessionStatus(
4731 OSRF_STATUS_BADREQUEST,
4732 "osrfMethodException",
4734 "Cannot DELETE readonly class"
4740 dbhandle = writehandle;
4744 char* pkey = osrfHashGet(meta, "primarykey");
4752 if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4753 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4758 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4761 if (!verifyObjectPCRUD( ctx, NULL )) {
4766 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4771 "%s deleting %s object with %s = %s",
4773 osrfHashGet(meta, "fieldmapper"),
4778 obj = jsonNewObject(id);
4780 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4781 dbi_conn_quote_string(writehandle, &id);
4783 dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4786 jsonObjectFree(obj);
4787 obj = jsonNewObject(NULL);
4790 "%s ERROR deleting %s object with %s = %s",
4792 osrfHashGet(meta, "fieldmapper"),
4805 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4806 if(!(result && meta)) return jsonNULL;
4808 jsonObject* object = jsonNewObject(NULL);
4809 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4811 osrfHash* fields = osrfHashGet(meta, "fields");
4813 osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4817 char dt_string[256];
4821 int columnIndex = 1;
4823 unsigned short type;
4824 const char* columnName;
4826 /* cycle through the column list */
4827 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4829 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4831 fmIndex = -1; // reset the position
4833 /* determine the field type and storage attributes */
4834 type = dbi_result_get_field_type(result, columnName);
4835 attr = dbi_result_get_field_attribs(result, columnName);
4837 /* fetch the fieldmapper index */
4838 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4840 if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4843 const char* pos = (char*)osrfHashGet(_f, "array_position");
4844 if ( !pos ) continue;
4846 fmIndex = atoi( pos );
4847 osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4852 if (dbi_result_field_is_null(result, columnName)) {
4853 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4858 case DBI_TYPE_INTEGER :
4860 if( attr & DBI_INTEGER_SIZE8 )
4861 jsonObjectSetIndex( object, fmIndex,
4862 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
4864 jsonObjectSetIndex( object, fmIndex,
4865 jsonNewNumberObject(dbi_result_get_int(result, columnName)));
4869 case DBI_TYPE_DECIMAL :
4870 jsonObjectSetIndex( object, fmIndex,
4871 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
4874 case DBI_TYPE_STRING :
4880 jsonNewObject( dbi_result_get_string(result, columnName) )
4885 case DBI_TYPE_DATETIME :
4887 memset(dt_string, '\0', sizeof(dt_string));
4888 memset(&gmdt, '\0', sizeof(gmdt));
4890 _tmp_dt = dbi_result_get_datetime(result, columnName);
4893 if (!(attr & DBI_DATETIME_DATE)) {
4894 gmtime_r( &_tmp_dt, &gmdt );
4895 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4896 } else if (!(attr & DBI_DATETIME_TIME)) {
4897 localtime_r( &_tmp_dt, &gmdt );
4898 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4900 localtime_r( &_tmp_dt, &gmdt );
4901 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4904 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
4908 case DBI_TYPE_BINARY :
4909 osrfLogError( OSRF_LOG_MARK,
4910 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4918 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
4919 if(!result) return jsonNULL;
4921 jsonObject* object = jsonNewObject(NULL);
4924 char dt_string[256];
4928 int columnIndex = 1;
4930 unsigned short type;
4931 const char* columnName;
4933 /* cycle through the column list */
4934 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4936 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4938 fmIndex = -1; // reset the position
4940 /* determine the field type and storage attributes */
4941 type = dbi_result_get_field_type(result, columnName);
4942 attr = dbi_result_get_field_attribs(result, columnName);
4944 if (dbi_result_field_is_null(result, columnName)) {
4945 jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
4950 case DBI_TYPE_INTEGER :
4952 if( attr & DBI_INTEGER_SIZE8 )
4953 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_longlong(result, columnName)) );
4955 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_int(result, columnName)) );
4958 case DBI_TYPE_DECIMAL :
4959 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_double(result, columnName)) );
4962 case DBI_TYPE_STRING :
4963 jsonObjectSetKey( object, columnName, jsonNewObject(dbi_result_get_string(result, columnName)) );
4966 case DBI_TYPE_DATETIME :
4968 memset(dt_string, '\0', sizeof(dt_string));
4969 memset(&gmdt, '\0', sizeof(gmdt));
4971 _tmp_dt = dbi_result_get_datetime(result, columnName);
4974 if (!(attr & DBI_DATETIME_DATE)) {
4975 gmtime_r( &_tmp_dt, &gmdt );
4976 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4977 } else if (!(attr & DBI_DATETIME_TIME)) {
4978 localtime_r( &_tmp_dt, &gmdt );
4979 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4981 localtime_r( &_tmp_dt, &gmdt );
4982 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4985 jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
4988 case DBI_TYPE_BINARY :
4989 osrfLogError( OSRF_LOG_MARK,
4990 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4998 // Interpret a string as true or false
4999 static int str_is_true( const char* str ) {
5000 if( NULL == str || strcasecmp( str, "true" ) )
5006 // Interpret a jsonObject as true or false
5007 static int obj_is_true( const jsonObject* obj ) {
5010 else switch( obj->type )
5018 if( strcasecmp( obj->value.s, "true" ) )
5022 case JSON_NUMBER : // Support 1/0 for perl's sake
5023 if( jsonObjectGetNumber( obj ) == 1.0 )
5032 // Translate a numeric code into a text string identifying a type of
5033 // jsonObject. To be used for building error messages.
5034 static const char* json_type( int code ) {
5040 return "JSON_ARRAY";
5042 return "JSON_STRING";
5044 return "JSON_NUMBER";
5050 return "(unrecognized)";
5054 // Extract the "primitive" attribute from an IDL field definition.
5055 // If we haven't initialized the app, then we must be running in
5056 // some kind of testbed. In that case, default to "string".
5057 static const char* get_primitive( osrfHash* field ) {
5058 const char* s = osrfHashGet( field, "primitive" );
5060 if( child_initialized )
5063 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5065 osrfHashGet( field, "name" )
5073 // Extract the "datatype" attribute from an IDL field definition.
5074 // If we haven't initialized the app, then we must be running in
5075 // some kind of testbed. In that case, default to to NUMERIC,
5076 // since we look at the datatype only for numbers.
5077 static const char* get_datatype( osrfHash* field ) {
5078 const char* s = osrfHashGet( field, "datatype" );
5080 if( child_initialized )
5083 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5085 osrfHashGet( field, "name" )
5094 If the input string is potentially a valid SQL identifier, return 1.
5097 Purpose: to prevent certain kinds of SQL injection. To that end we
5098 don't necessarily need to follow all the rules exactly, such as requiring
5099 that the first character not be a digit.
5101 We allow leading and trailing white space. In between, we do not allow
5102 punctuation (except for underscores and dollar signs), control
5103 characters, or embedded white space.
5105 More pedantically we should allow quoted identifiers containing arbitrary
5106 characters, but for the foreseeable future such quoted identifiers are not
5107 likely to be an issue.
5109 static int is_identifier( const char* s) {
5113 // Skip leading white space
5114 while( isspace( (unsigned char) *s ) )
5118 return 0; // Nothing but white space? Not okay.
5120 // Check each character until we reach white space or
5121 // end-of-string. Letters, digits, underscores, and
5122 // dollar signs are okay. With the exception of periods
5123 // (as in schema.identifier), control characters and other
5124 // punctuation characters are not okay. Anything else
5125 // is okay -- it could for example be part of a multibyte
5126 // UTF8 character such as a letter with diacritical marks,
5127 // and those are allowed.
5129 if( isalnum( (unsigned char) *s )
5133 ; // Fine; keep going
5134 else if( ispunct( (unsigned char) *s )
5135 || iscntrl( (unsigned char) *s ) )
5138 } while( *s && ! isspace( (unsigned char) *s ) );
5140 // If we found any white space in the above loop,
5141 // the rest had better be all white space.
5143 while( isspace( (unsigned char) *s ) )
5147 return 0; // White space was embedded within non-white space
5153 Determine whether to accept a character string as a comparison operator.
5154 Return 1 if it's good, or 0 if it's bad.
5156 We don't validate it for real. We just make sure that it doesn't contain
5157 any semicolons or white space (with a special exception for the
5158 "SIMILAR TO" operator). The idea is to block certain kinds of SQL
5159 injection. If it has no semicolons or white space but it's still not a
5160 valid operator, then the database will complain.
5162 Another approach would be to compare the string against a short list of
5163 approved operators. We don't do that because we want to allow custom
5164 operators like ">100*", which would be difficult or impossible to
5165 express otherwise in a JSON query.
5167 static int is_good_operator( const char* op ) {
5168 if( !op ) return 0; // Sanity check
5172 if( isspace( (unsigned char) *s ) ) {
5173 // Special exception for SIMILAR TO. Someday we might make
5174 // exceptions for IS DISTINCT FROM and IS NOT DISTINCT FROM.
5175 if( !strcasecmp( op, "similar to" ) )
5180 else if( ';' == *s )