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 );
2400 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2401 OSRF_BUFFER_ADD( join_buf, jpred );
2404 osrfLogError( OSRF_LOG_MARK, "%s: Invalid nested join.", MODULENAME );
2405 jsonIteratorFree( search_itr );
2406 buffer_free( join_buf );
2408 jsonObjectFree( freeable_hash );
2415 jsonObjectFree(freeable_hash);
2416 jsonIteratorFree(search_itr);
2418 return buffer_release(join_buf);
2423 { +class : { -or|-and : { field : { op : value }, ... } ... }, ... }
2424 { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }
2425 [ { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }, ... ]
2427 Generate code to express a set of conditions, as for a WHERE clause. Parameters:
2429 search_hash is the JSON expression of the conditions.
2430 meta is the class definition from the IDL, for the relevant table.
2431 opjoin_type indicates whether multiple conditions, if present, should be
2432 connected by AND or OR.
2433 osrfMethodContext is loaded with all sorts of stuff, but all we do with it here is
2434 to pass it to other functions -- and all they do with it is to use the session
2435 and request members to send error messages back to the client.
2439 static char* searchWHERE ( const jsonObject* search_hash, osrfHash* meta, int opjoin_type, osrfMethodContext* ctx ) {
2443 "%s: Entering searchWHERE; search_hash addr = %p, meta addr = %p, opjoin_type = %d, ctx addr = %p",
2451 growing_buffer* sql_buf = buffer_init(128);
2453 jsonObject* node = NULL;
2456 if ( search_hash->type == JSON_ARRAY ) {
2457 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_ARRAY", MODULENAME);
2458 jsonIterator* search_itr = jsonNewIterator( search_hash );
2459 if( !jsonIteratorHasNext( search_itr ) ) {
2462 "%s: Invalid predicate structure: empty JSON array",
2465 jsonIteratorFree( search_itr );
2466 buffer_free( sql_buf );
2470 while ( (node = jsonIteratorNext( search_itr )) ) {
2474 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2475 else buffer_add(sql_buf, " AND ");
2478 char* subpred = searchWHERE( node, meta, opjoin_type, ctx );
2480 buffer_fadd(sql_buf, "( %s )", subpred);
2483 jsonIteratorFree( search_itr );
2484 buffer_free( sql_buf );
2488 jsonIteratorFree(search_itr);
2490 } else if ( search_hash->type == JSON_HASH ) {
2491 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_HASH", MODULENAME);
2492 jsonIterator* search_itr = jsonNewIterator( search_hash );
2493 if( !jsonIteratorHasNext( search_itr ) ) {
2496 "%s: Invalid predicate structure: empty JSON object",
2499 jsonIteratorFree( search_itr );
2500 buffer_free( sql_buf );
2504 while ( (node = jsonIteratorNext( search_itr )) ) {
2509 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2510 else buffer_add(sql_buf, " AND ");
2513 if ( '+' == search_itr->key[ 0 ] ) {
2514 if ( node->type == JSON_STRING ) {
2515 // Intended purpose; to allow reference to a Boolean column
2517 // Verify that the class alias is not empty
2518 if( '\0' == search_itr->key[ 1 ] ) {
2521 "%s: Table alias is empty",
2524 jsonIteratorFree( search_itr );
2525 buffer_free( sql_buf );
2529 // Verify that the string looks like an identifier.
2530 const char* subpred = jsonObjectGetString( node );
2531 if( ! is_identifier( subpred ) ) {
2534 "%s: Invalid boolean identifier in WHERE clause: \"%s\"",
2538 jsonIteratorFree( search_itr );
2539 buffer_free( sql_buf );
2543 buffer_fadd(sql_buf, " \"%s\".%s ", search_itr->key + 1, subpred);
2545 char* subpred = searchWHERE( node, osrfHashGet( oilsIDL(), search_itr->key + 1 ), AND_OP_JOIN, ctx );
2547 buffer_fadd(sql_buf, "( %s )", subpred);
2550 jsonIteratorFree( search_itr );
2551 buffer_free( sql_buf );
2555 } else if ( !strcasecmp("-or",search_itr->key) ) {
2556 char* subpred = searchWHERE( node, meta, OR_OP_JOIN, ctx );
2558 buffer_fadd(sql_buf, "( %s )", subpred);
2561 buffer_free( sql_buf );
2564 } else if ( !strcasecmp("-and",search_itr->key) ) {
2565 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2567 buffer_fadd(sql_buf, "( %s )", subpred);
2570 buffer_free( sql_buf );
2573 } else if ( !strcasecmp("-not",search_itr->key) ) {
2574 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2576 buffer_fadd(sql_buf, " NOT ( %s )", subpred);
2579 buffer_free( sql_buf );
2582 } else if ( !strcasecmp("-exists",search_itr->key) ) {
2583 char* subpred = SELECT(
2585 jsonObjectGetKey( node, "select" ),
2586 jsonObjectGetKey( node, "from" ),
2587 jsonObjectGetKey( node, "where" ),
2588 jsonObjectGetKey( node, "having" ),
2589 jsonObjectGetKey( node, "order_by" ),
2590 jsonObjectGetKey( node, "limit" ),
2591 jsonObjectGetKey( node, "offset" ),
2596 buffer_fadd(sql_buf, "EXISTS ( %s )", subpred);
2599 buffer_free( sql_buf );
2602 } else if ( !strcasecmp("-not-exists",search_itr->key) ) {
2603 char* subpred = SELECT(
2605 jsonObjectGetKey( node, "select" ),
2606 jsonObjectGetKey( node, "from" ),
2607 jsonObjectGetKey( node, "where" ),
2608 jsonObjectGetKey( node, "having" ),
2609 jsonObjectGetKey( node, "order_by" ),
2610 jsonObjectGetKey( node, "limit" ),
2611 jsonObjectGetKey( node, "offset" ),
2616 buffer_fadd(sql_buf, "NOT EXISTS ( %s )", subpred);
2619 buffer_free( sql_buf );
2625 char* class = osrfHashGet(meta, "classname");
2626 osrfHash* fields = osrfHashGet(meta, "fields");
2627 osrfHash* field = osrfHashGet( fields, search_itr->key );
2631 char* table = getSourceDefinition(meta);
2633 table = strdup( "(?)" );
2636 "%s: Attempt to reference non-existent column \"%s\" on %s (%s)",
2642 buffer_free(sql_buf);
2644 jsonIteratorFree(search_itr);
2648 char* subpred = searchPredicate( class, field, node, ctx );
2650 buffer_add( sql_buf, subpred );
2653 buffer_free(sql_buf);
2654 jsonIteratorFree(search_itr);
2659 jsonIteratorFree(search_itr);
2662 // ERROR ... only hash and array allowed at this level
2663 char* predicate_string = jsonObjectToJSON( search_hash );
2666 "%s: Invalid predicate structure: %s",
2670 buffer_free(sql_buf);
2671 free(predicate_string);
2675 return buffer_release(sql_buf);
2678 // Return 1 if the class is in the FROM clause, or 0 if not
2679 static int is_joined( jsonObject* from_clause, const char* class ) {
2683 else if( from_clause->type == JSON_STRING ) {
2684 if( strcmp( class, jsonObjectGetString( from_clause ) ) )
2688 } else if( from_clause->type != JSON_HASH ) {
2690 } else { // Look at any subjoins
2691 jsonIterator* class_itr = jsonNewIterator( from_clause );
2692 jsonObject* curr_class;
2693 int rc = 0; // return code
2694 while ( ( curr_class = jsonIteratorNext( class_itr ) ) ) {
2695 if( ! strcmp( class_itr->key, class ) ) {
2699 jsonObject* subjoin = jsonObjectGetKey( curr_class, "join" );
2700 if( subjoin && is_joined( subjoin, class ) ) {
2706 jsonIteratorFree( class_itr );
2713 /* method context */ osrfMethodContext* ctx,
2715 /* SELECT */ jsonObject* selhash,
2716 /* FROM */ jsonObject* join_hash,
2717 /* WHERE */ jsonObject* search_hash,
2718 /* HAVING */ jsonObject* having_hash,
2719 /* ORDER BY */ jsonObject* order_hash,
2720 /* LIMIT */ jsonObject* limit,
2721 /* OFFSET */ jsonObject* offset,
2722 /* flags */ int flags
2724 const char* locale = osrf_message_get_last_locale();
2726 // in case we don't get a select list
2727 jsonObject* defaultselhash = NULL;
2729 // general tmp objects
2730 const jsonObject* tmp_const;
2731 jsonObject* selclass = NULL;
2732 jsonObject* selfield = NULL;
2733 jsonObject* snode = NULL;
2734 jsonObject* onode = NULL;
2736 char* string = NULL;
2737 int from_function = 0;
2742 // the core search class
2743 char* core_class = NULL;
2745 // metadata about the core search class
2746 osrfHash* core_meta = NULL;
2748 osrfLogDebug(OSRF_LOG_MARK, "cstore SELECT locale: %s", locale);
2750 // punt if there's no core class
2751 if (!join_hash || ( join_hash->type == JSON_HASH && !join_hash->size )) {
2754 "%s: FROM clause is missing or empty",
2758 osrfAppSessionStatus(
2760 OSRF_STATUS_INTERNALSERVERERROR,
2761 "osrfMethodException",
2763 "FROM clause is missing or empty in JSON query"
2768 // get the core class -- the only key of the top level FROM clause, or a string
2769 if (join_hash->type == JSON_HASH) {
2770 jsonIterator* tmp_itr = jsonNewIterator( join_hash );
2771 snode = jsonIteratorNext( tmp_itr );
2773 core_class = strdup( tmp_itr->key );
2776 jsonObject* extra = jsonIteratorNext( tmp_itr );
2778 jsonIteratorFree( tmp_itr );
2781 // There shouldn't be more than one entry in join_hash
2785 "%s: Malformed FROM clause: extra entry in JSON_HASH",
2789 osrfAppSessionStatus(
2791 OSRF_STATUS_INTERNALSERVERERROR,
2792 "osrfMethodException",
2794 "Malformed FROM clause in JSON query"
2797 return NULL; // Malformed join_hash; extra entry
2799 } else if (join_hash->type == JSON_ARRAY) {
2801 core_class = jsonObjectToSimpleString( jsonObjectGetIndex(join_hash, 0) );
2804 } else if (join_hash->type == JSON_STRING) {
2805 core_class = jsonObjectToSimpleString( join_hash );
2811 "%s: FROM clause is unexpected JSON type: %s",
2813 json_type( join_hash->type )
2816 osrfAppSessionStatus(
2818 OSRF_STATUS_INTERNALSERVERERROR,
2819 "osrfMethodException",
2821 "Ill-formed FROM clause in JSON query"
2827 if (!from_function) {
2828 // Get the IDL class definition for the core class
2829 core_meta = osrfHashGet( oilsIDL(), core_class );
2830 if( !core_meta ) { // Didn't find it?
2833 "%s: SELECT clause references undefined class: \"%s\"",
2838 osrfAppSessionStatus(
2840 OSRF_STATUS_INTERNALSERVERERROR,
2841 "osrfMethodException",
2843 "SELECT clause references undefined class in JSON query"
2849 // Make sure the class isn't virtual
2850 if( str_is_true( osrfHashGet( core_meta, "virtual" ) ) ) {
2853 "%s: Core class is virtual: \"%s\"",
2858 osrfAppSessionStatus(
2860 OSRF_STATUS_INTERNALSERVERERROR,
2861 "osrfMethodException",
2863 "FROM clause references virtual class in JSON query"
2870 // if the select list is empty, or the core class field list is '*',
2871 // build the default select list ...
2873 selhash = defaultselhash = jsonNewObjectType(JSON_HASH);
2874 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2875 } else if( selhash->type != JSON_HASH ) {
2878 "%s: Expected JSON_HASH for SELECT clause; found %s",
2880 json_type( selhash->type )
2884 osrfAppSessionStatus(
2886 OSRF_STATUS_INTERNALSERVERERROR,
2887 "osrfMethodException",
2889 "Malformed SELECT clause in JSON query"
2893 } else if ( (tmp_const = jsonObjectGetKeyConst( selhash, core_class )) && tmp_const->type == JSON_STRING ) {
2894 const char* _x = jsonObjectGetString( tmp_const );
2895 if (!strncmp( "*", _x, 1 )) {
2896 jsonObjectRemoveKey( selhash, core_class );
2897 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2902 growing_buffer* sql_buf = buffer_init(128);
2904 // temp buffers for the SELECT list and GROUP BY clause
2905 growing_buffer* select_buf = buffer_init(128);
2906 growing_buffer* group_buf = buffer_init(128);
2908 int aggregate_found = 0; // boolean
2910 // Build a select list
2911 if(from_function) // From a function we select everything
2912 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
2915 // If we need to build a default list, prepare to do so
2916 jsonObject* _tmp = jsonObjectGetKey( selhash, core_class );
2917 if ( _tmp && !_tmp->size ) {
2919 osrfHash* core_fields = osrfHashGet( core_meta, "fields" );
2921 osrfHashIterator* field_itr = osrfNewHashIterator( core_fields );
2922 osrfHash* field_def;
2923 while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
2924 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
2925 // This field is not virtual, so add it to the list
2926 jsonObjectPush( _tmp, jsonNewObject( osrfHashIteratorKey( field_itr ) ) );
2929 osrfHashIteratorFree( field_itr );
2932 // Now build the actual select list
2936 jsonIterator* selclass_itr = jsonNewIterator( selhash );
2937 while ( (selclass = jsonIteratorNext( selclass_itr )) ) { // For each class
2939 // Make sure the class is defined in the IDL
2940 const char* cname = selclass_itr->key;
2941 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
2945 "%s: Selected class \"%s\" not defined in IDL",
2951 osrfAppSessionStatus(
2953 OSRF_STATUS_INTERNALSERVERERROR,
2954 "osrfMethodException",
2956 "Selected class is not defined"
2958 jsonIteratorFree( selclass_itr );
2959 buffer_free( sql_buf );
2960 buffer_free( select_buf );
2961 buffer_free( group_buf );
2962 if( defaultselhash ) jsonObjectFree( defaultselhash );
2967 // Make sure the target relation is in the FROM clause.
2969 // At this point join_hash is a step down from the join_hash we
2970 // received as a parameter. If the original was a JSON_STRING,
2971 // then json_hash is now NULL. If the original was a JSON_HASH,
2972 // then json_hash is now the first (and only) entry in it,
2973 // denoting the core class. We've already excluded the
2974 // possibility that the original was a JSON_ARRAY, because in
2975 // that case from_function would be non-NULL, and we wouldn't
2978 // If the current class isn't the core class
2979 // and it isn't in the join tree, bail out
2980 if ( strcmp( core_class, cname ) && ! is_joined( join_hash, cname ) ) {
2983 "%s: SELECT clause references class not in FROM clause: \"%s\"",
2988 osrfAppSessionStatus(
2990 OSRF_STATUS_INTERNALSERVERERROR,
2991 "osrfMethodException",
2993 "Selected class not in FROM clause in JSON query"
2995 jsonIteratorFree( selclass_itr );
2996 buffer_free( sql_buf );
2997 buffer_free( select_buf );
2998 buffer_free( group_buf );
2999 if( defaultselhash ) jsonObjectFree( defaultselhash );
3004 // Look up some attributes of the current class, so that we
3005 // don't have to look them up again for each field
3006 osrfHash* class_field_set = osrfHashGet( idlClass, "fields" );
3007 const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
3008 const char* class_tname = osrfHashGet( idlClass, "tablename" );
3010 // stitch together the column list ...
3011 jsonIterator* select_itr = jsonNewIterator( selclass );
3012 while ( (selfield = jsonIteratorNext( select_itr )) ) { // for each SELECT column
3014 // If we need a separator comma, add one
3018 OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3021 // ... if it's a string, just toss it on the pile
3022 if (selfield->type == JSON_STRING) {
3024 // Look up the field in the IDL
3025 const char* col_name = jsonObjectGetString( selfield );
3026 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3028 // No such field in current class
3031 "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3037 osrfAppSessionStatus(
3039 OSRF_STATUS_INTERNALSERVERERROR,
3040 "osrfMethodException",
3042 "Selected column not defined in JSON query"
3044 jsonIteratorFree( select_itr );
3045 jsonIteratorFree( selclass_itr );
3046 buffer_free( sql_buf );
3047 buffer_free( select_buf );
3048 buffer_free( group_buf );
3049 if( defaultselhash ) jsonObjectFree( defaultselhash );
3052 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3053 // Virtual field not allowed
3056 "%s: Selected column \"%s\" for class \"%s\" is virtual",
3062 osrfAppSessionStatus(
3064 OSRF_STATUS_INTERNALSERVERERROR,
3065 "osrfMethodException",
3067 "Selected column may not be virtual in JSON query"
3069 jsonIteratorFree( select_itr );
3070 jsonIteratorFree( selclass_itr );
3071 buffer_free( sql_buf );
3072 buffer_free( select_buf );
3073 buffer_free( group_buf );
3074 if( defaultselhash ) jsonObjectFree( defaultselhash );
3081 if (flags & DISABLE_I18N)
3084 i18n = osrfHashGet(field_def, "i18n");
3086 if( str_is_true( i18n ) ) {
3087 buffer_fadd( select_buf,
3088 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3089 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3091 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3094 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3097 // ... but it could be an object, in which case we check for a Field Transform
3098 } else if (selfield->type == JSON_HASH) {
3100 const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3102 // Get the field definition from the IDL
3103 osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3105 // No such field in current class
3108 "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3114 osrfAppSessionStatus(
3116 OSRF_STATUS_INTERNALSERVERERROR,
3117 "osrfMethodException",
3119 "Selected column is not defined in JSON query"
3121 jsonIteratorFree( select_itr );
3122 jsonIteratorFree( selclass_itr );
3123 buffer_free( sql_buf );
3124 buffer_free( select_buf );
3125 buffer_free( group_buf );
3126 if( defaultselhash ) jsonObjectFree( defaultselhash );
3129 } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3130 // No such field in current class
3133 "%s: Selected column \"%s\" is virtual for class \"%s\"",
3139 osrfAppSessionStatus(
3141 OSRF_STATUS_INTERNALSERVERERROR,
3142 "osrfMethodException",
3144 "Selected column is virtual in JSON query"
3146 jsonIteratorFree( select_itr );
3147 jsonIteratorFree( selclass_itr );
3148 buffer_free( sql_buf );
3149 buffer_free( select_buf );
3150 buffer_free( group_buf );
3151 if( defaultselhash ) jsonObjectFree( defaultselhash );
3156 // Decide what to use as a column alias
3158 if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3159 _alias = jsonObjectGetString( tmp_const );
3160 } else { // Use field name as the alias
3164 if (jsonObjectGetKeyConst( selfield, "transform" )) {
3165 char* transform_str = searchFieldTransform(cname, field_def, selfield);
3166 if( transform_str ) {
3167 buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3168 free(transform_str);
3171 osrfAppSessionStatus(
3173 OSRF_STATUS_INTERNALSERVERERROR,
3174 "osrfMethodException",
3176 "Unable to generate transform function in JSON query"
3178 jsonIteratorFree( select_itr );
3179 jsonIteratorFree( selclass_itr );
3180 buffer_free( sql_buf );
3181 buffer_free( select_buf );
3182 buffer_free( group_buf );
3183 if( defaultselhash ) jsonObjectFree( defaultselhash );
3191 if (flags & DISABLE_I18N)
3194 i18n = osrfHashGet(field_def, "i18n");
3196 if( str_is_true( i18n ) ) {
3197 buffer_fadd( select_buf,
3198 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3199 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3201 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3204 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3211 "%s: Selected item is unexpected JSON type: %s",
3213 json_type( selfield->type )
3216 osrfAppSessionStatus(
3218 OSRF_STATUS_INTERNALSERVERERROR,
3219 "osrfMethodException",
3221 "Ill-formed SELECT item in JSON query"
3223 jsonIteratorFree( select_itr );
3224 jsonIteratorFree( selclass_itr );
3225 buffer_free( sql_buf );
3226 buffer_free( select_buf );
3227 buffer_free( group_buf );
3228 if( defaultselhash ) jsonObjectFree( defaultselhash );
3233 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3234 if( obj_is_true( agg_obj ) )
3235 aggregate_found = 1;
3237 // Append a comma (except for the first one)
3238 // and add the column to a GROUP BY clause
3242 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3244 buffer_fadd(group_buf, " %d", sel_pos);
3248 if (is_agg->size || (flags & SELECT_DISTINCT)) {
3250 const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3251 if ( ! obj_is_true( aggregate_obj ) ) {
3255 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3258 buffer_fadd(group_buf, " %d", sel_pos);
3261 } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3265 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3268 _column = searchFieldTransform(cname, field, selfield);
3269 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3270 OSRF_BUFFER_ADD(group_buf, _column);
3271 _column = searchFieldTransform(cname, field, selfield);
3278 } // end while -- iterating across SELECT columns
3280 jsonIteratorFree(select_itr);
3281 } // end while -- iterating across classes
3283 jsonIteratorFree(selclass_itr);
3287 char* col_list = buffer_release(select_buf);
3289 if (from_function) table = searchValueTransform(join_hash);
3290 else table = getSourceDefinition(core_meta);
3294 osrfAppSessionStatus(
3296 OSRF_STATUS_INTERNALSERVERERROR,
3297 "osrfMethodException",
3299 "Unable to identify table for core class"
3302 buffer_free( sql_buf );
3303 buffer_free( group_buf );
3304 if( defaultselhash ) jsonObjectFree( defaultselhash );
3309 // Put it all together
3310 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3314 char* order_by_list = NULL;
3315 char* having_buf = NULL;
3317 if (!from_function) {
3319 // Now, walk the join tree and add that clause
3321 char* join_clause = searchJOIN( join_hash, core_meta );
3323 buffer_add(sql_buf, join_clause);
3327 osrfAppSessionStatus(
3329 OSRF_STATUS_INTERNALSERVERERROR,
3330 "osrfMethodException",
3332 "Unable to construct JOIN clause(s)"
3334 buffer_free( sql_buf );
3335 buffer_free( group_buf );
3336 if( defaultselhash ) jsonObjectFree( defaultselhash );
3342 // Build a WHERE clause, if there is one
3343 if ( search_hash ) {
3344 buffer_add(sql_buf, " WHERE ");
3346 // and it's on the WHERE clause
3347 char* pred = searchWHERE( search_hash, core_meta, AND_OP_JOIN, ctx );
3350 buffer_add(sql_buf, pred);
3354 osrfAppSessionStatus(
3356 OSRF_STATUS_INTERNALSERVERERROR,
3357 "osrfMethodException",
3359 "Severe query error in WHERE predicate -- see error log for more details"
3363 buffer_free(group_buf);
3364 buffer_free(sql_buf);
3365 if (defaultselhash) jsonObjectFree(defaultselhash);
3370 // Build a HAVING clause, if there is one
3371 if ( having_hash ) {
3373 // and it's on the the WHERE clause
3374 having_buf = searchWHERE( having_hash, core_meta, AND_OP_JOIN, ctx );
3376 if( ! having_buf ) {
3378 osrfAppSessionStatus(
3380 OSRF_STATUS_INTERNALSERVERERROR,
3381 "osrfMethodException",
3383 "Severe query error in HAVING predicate -- see error log for more details"
3387 buffer_free(group_buf);
3388 buffer_free(sql_buf);
3389 if (defaultselhash) jsonObjectFree(defaultselhash);
3394 growing_buffer* order_buf = NULL; // to collect ORDER BY list
3396 // Build an ORDER BY clause, if there is one
3397 if( NULL == order_hash )
3398 ; // No ORDER BY? do nothing
3399 else if( JSON_ARRAY == order_hash->type ) {
3400 // Array of field specifications, each specification being a
3401 // hash to define the class, field, and other details
3403 jsonObject* order_spec;
3404 while( (order_spec = jsonObjectGetIndex( order_hash, order_idx++ ) ) ) {
3406 if( JSON_HASH != order_spec->type ) {
3407 osrfLogError(OSRF_LOG_MARK,
3408 "%s: Malformed field specification in ORDER BY clause; expected JSON_HASH, found %s",
3409 MODULENAME, json_type( order_spec->type ) );
3411 osrfAppSessionStatus(
3413 OSRF_STATUS_INTERNALSERVERERROR,
3414 "osrfMethodException",
3416 "Malformed ORDER BY clause -- see error log for more details"
3418 buffer_free( order_buf );
3421 buffer_free(group_buf);
3422 buffer_free(sql_buf);
3423 if (defaultselhash) jsonObjectFree(defaultselhash);
3428 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "class" ) );
3430 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "field" ) );
3433 OSRF_BUFFER_ADD(order_buf, ", ");
3435 order_buf = buffer_init(128);
3437 if( !field || !class ) {
3438 osrfLogError(OSRF_LOG_MARK,
3439 "%s: Missing class or field name in field specification of ORDER BY clause",
3442 osrfAppSessionStatus(
3444 OSRF_STATUS_INTERNALSERVERERROR,
3445 "osrfMethodException",
3447 "Malformed ORDER BY clause -- see error log for more details"
3449 buffer_free( order_buf );
3452 buffer_free(group_buf);
3453 buffer_free(sql_buf);
3454 if (defaultselhash) jsonObjectFree(defaultselhash);
3458 if ( ! jsonObjectGetKeyConst( selhash, class )
3459 && strcmp( core_class, class )
3460 && ! is_joined( join_hash, class ) ) {
3461 osrfLogError(OSRF_LOG_MARK, "%s: ORDER BY clause references class \"%s\" "
3462 "not in FROM clause", MODULENAME, class );
3464 osrfAppSessionStatus(
3466 OSRF_STATUS_INTERNALSERVERERROR,
3467 "osrfMethodException",
3469 "Invalid class referenced in ORDER BY clause -- see error log for more details"
3473 buffer_free(group_buf);
3474 buffer_free(sql_buf);
3475 if (defaultselhash) jsonObjectFree(defaultselhash);
3479 osrfHash* field_def = oilsIDLFindPath( "/%s/fields/%s", class, field );
3481 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\".%s referenced in ORDER BY clause",
3482 MODULENAME, class, field );
3484 osrfAppSessionStatus(
3486 OSRF_STATUS_INTERNALSERVERERROR,
3487 "osrfMethodException",
3489 "Invalid field referenced in ORDER BY clause -- see error log for more details"
3493 buffer_free(group_buf);
3494 buffer_free(sql_buf);
3495 if (defaultselhash) jsonObjectFree(defaultselhash);
3497 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3498 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3499 MODULENAME, field );
3501 osrfAppSessionStatus(
3503 OSRF_STATUS_INTERNALSERVERERROR,
3504 "osrfMethodException",
3506 "Virtual field in ORDER BY clause -- see error log for more details"
3508 buffer_free( order_buf );
3511 buffer_free(group_buf);
3512 buffer_free(sql_buf);
3513 if (defaultselhash) jsonObjectFree(defaultselhash);
3517 if( jsonObjectGetKeyConst( order_spec, "transform" ) ) {
3518 char* transform_str = searchFieldTransform( class, field_def, order_spec );
3519 if( ! transform_str ) {
3521 osrfAppSessionStatus(
3523 OSRF_STATUS_INTERNALSERVERERROR,
3524 "osrfMethodException",
3526 "Severe query error in ORDER BY clause -- see error log for more details"
3528 buffer_free( order_buf );
3531 buffer_free(group_buf);
3532 buffer_free(sql_buf);
3533 if (defaultselhash) jsonObjectFree(defaultselhash);
3537 OSRF_BUFFER_ADD( order_buf, transform_str );
3538 free( transform_str );
3541 buffer_fadd( order_buf, "\"%s\".%s", class, field );
3543 const char* direction =
3544 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "direction" ) );
3546 if( direction[ 0 ] || 'D' == direction[ 0 ] )
3547 OSRF_BUFFER_ADD( order_buf, " DESC" );
3549 OSRF_BUFFER_ADD( order_buf, " ASC" );
3552 } else if( JSON_HASH == order_hash->type ) {
3553 // This hash is keyed on class name. Each class has either
3554 // an array of field names or a hash keyed on field name.
3555 jsonIterator* class_itr = jsonNewIterator( order_hash );
3556 while ( (snode = jsonIteratorNext( class_itr )) ) {
3558 if ( ! jsonObjectGetKeyConst( selhash,class_itr->key )
3559 && strcmp( core_class, class_itr->key )
3560 && ! is_joined( join_hash, class_itr->key ) ) {
3561 osrfLogError(OSRF_LOG_MARK, "%s: Invalid class \"%s\" referenced in ORDER BY clause",
3562 MODULENAME, class_itr->key );
3564 osrfAppSessionStatus(
3566 OSRF_STATUS_INTERNALSERVERERROR,
3567 "osrfMethodException",
3569 "Invalid class referenced in ORDER BY clause -- see error log for more details"
3571 jsonIteratorFree( class_itr );
3572 buffer_free( order_buf );
3575 buffer_free(group_buf);
3576 buffer_free(sql_buf);
3577 if (defaultselhash) jsonObjectFree(defaultselhash);
3581 osrfHash* field_list_def = oilsIDLFindPath( "/%s/fields", class_itr->key );
3583 if ( snode->type == JSON_HASH ) {
3585 // Hash is keyed on field names from the current class. For each field
3586 // there is another layer of hash to define the sorting details, if any,
3587 // or a string to indicate direction of sorting.
3588 jsonIterator* order_itr = jsonNewIterator( snode );
3589 while ( (onode = jsonIteratorNext( order_itr )) ) {
3591 osrfHash* field_def = osrfHashGet( field_list_def, order_itr->key );
3593 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3594 MODULENAME, order_itr->key );
3596 osrfAppSessionStatus(
3598 OSRF_STATUS_INTERNALSERVERERROR,
3599 "osrfMethodException",
3601 "Invalid field in ORDER BY clause -- see error log for more details"
3603 jsonIteratorFree( order_itr );
3604 jsonIteratorFree( class_itr );
3605 buffer_free( order_buf );
3608 buffer_free(group_buf);
3609 buffer_free(sql_buf);
3610 if (defaultselhash) jsonObjectFree(defaultselhash);
3612 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3613 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3614 MODULENAME, order_itr->key );
3616 osrfAppSessionStatus(
3618 OSRF_STATUS_INTERNALSERVERERROR,
3619 "osrfMethodException",
3621 "Virtual field in ORDER BY clause -- see error log for more details"
3623 jsonIteratorFree( order_itr );
3624 jsonIteratorFree( class_itr );
3625 buffer_free( order_buf );
3628 buffer_free(group_buf);
3629 buffer_free(sql_buf);
3630 if (defaultselhash) jsonObjectFree(defaultselhash);
3634 const char* direction = NULL;
3635 if ( onode->type == JSON_HASH ) {
3636 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3637 string = searchFieldTransform(
3639 osrfHashGet( field_list_def, order_itr->key ),
3643 if( ctx ) osrfAppSessionStatus(
3645 OSRF_STATUS_INTERNALSERVERERROR,
3646 "osrfMethodException",
3648 "Severe query error in ORDER BY clause -- see error log for more details"
3650 jsonIteratorFree( order_itr );
3651 jsonIteratorFree( class_itr );
3654 buffer_free(group_buf);
3655 buffer_free(order_buf);
3656 buffer_free(sql_buf);
3657 if (defaultselhash) jsonObjectFree(defaultselhash);
3661 growing_buffer* field_buf = buffer_init(16);
3662 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3663 string = buffer_release(field_buf);
3666 if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3667 const char* dir = jsonObjectGetString(tmp_const);
3668 if (!strncasecmp(dir, "d", 1)) {
3669 direction = " DESC";
3675 } else if ( JSON_NULL == onode->type || JSON_ARRAY == onode->type ) {
3676 osrfLogError( OSRF_LOG_MARK,
3677 "%s: Expected JSON_STRING in ORDER BY clause; found %s",
3678 MODULENAME, json_type( onode->type ) );
3680 osrfAppSessionStatus(
3682 OSRF_STATUS_INTERNALSERVERERROR,
3683 "osrfMethodException",
3685 "Malformed ORDER BY clause -- see error log for more details"
3687 jsonIteratorFree( order_itr );
3688 jsonIteratorFree( class_itr );
3691 buffer_free(group_buf);
3692 buffer_free(order_buf);
3693 buffer_free(sql_buf);
3694 if (defaultselhash) jsonObjectFree(defaultselhash);
3698 string = strdup(order_itr->key);
3699 const char* dir = jsonObjectGetString(onode);
3700 if (!strncasecmp(dir, "d", 1)) {
3701 direction = " DESC";
3708 OSRF_BUFFER_ADD(order_buf, ", ");
3710 order_buf = buffer_init(128);
3712 OSRF_BUFFER_ADD(order_buf, string);
3716 OSRF_BUFFER_ADD(order_buf, direction);
3720 jsonIteratorFree(order_itr);
3722 } else if ( snode->type == JSON_ARRAY ) {
3724 // Array is a list of fields from the current class
3725 jsonIterator* order_itr = jsonNewIterator( snode );
3726 while ( (onode = jsonIteratorNext( order_itr )) ) {
3728 const char* _f = jsonObjectGetString( onode );
3730 osrfHash* field_def = osrfHashGet( field_list_def, _f );
3732 osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3735 osrfAppSessionStatus(
3737 OSRF_STATUS_INTERNALSERVERERROR,
3738 "osrfMethodException",
3740 "Invalid field in ORDER BY clause -- see error log for more details"
3742 jsonIteratorFree( order_itr );
3743 jsonIteratorFree( class_itr );
3744 buffer_free( order_buf );
3747 buffer_free(group_buf);
3748 buffer_free(sql_buf);
3749 if (defaultselhash) jsonObjectFree(defaultselhash);
3751 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3752 osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3755 osrfAppSessionStatus(
3757 OSRF_STATUS_INTERNALSERVERERROR,
3758 "osrfMethodException",
3760 "Virtual field in ORDER BY clause -- see error log for more details"
3762 jsonIteratorFree( order_itr );
3763 jsonIteratorFree( class_itr );
3764 buffer_free( order_buf );
3767 buffer_free(group_buf);
3768 buffer_free(sql_buf);
3769 if (defaultselhash) jsonObjectFree(defaultselhash);
3774 OSRF_BUFFER_ADD(order_buf, ", ");
3776 order_buf = buffer_init(128);
3778 buffer_fadd( order_buf, "\"%s\".%s", class_itr->key, _f);
3781 // jsonIteratorFree(order_itr);
3784 // IT'S THE OOOOOOOOOOOLD STYLE!
3786 osrfLogError(OSRF_LOG_MARK,
3787 "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3789 osrfAppSessionStatus(
3791 OSRF_STATUS_INTERNALSERVERERROR,
3792 "osrfMethodException",
3794 "Severe query error -- see error log for more details"
3800 buffer_free(group_buf);
3801 buffer_free(order_buf);
3802 buffer_free(sql_buf);
3803 if (defaultselhash) jsonObjectFree(defaultselhash);
3804 jsonIteratorFree(class_itr);
3809 osrfLogError(OSRF_LOG_MARK,
3810 "%s: Malformed ORDER BY clause; expected JSON_HASH or JSON_ARRAY, found %s",
3811 MODULENAME, json_type( order_hash->type ) );
3813 osrfAppSessionStatus(
3815 OSRF_STATUS_INTERNALSERVERERROR,
3816 "osrfMethodException",
3818 "Malformed ORDER BY clause -- see error log for more details"
3820 buffer_free( order_buf );
3823 buffer_free(group_buf);
3824 buffer_free(sql_buf);
3825 if (defaultselhash) jsonObjectFree(defaultselhash);
3828 // jsonIteratorFree(class_itr);
3831 order_by_list = buffer_release( order_buf );
3835 string = buffer_release(group_buf);
3837 if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3838 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3839 OSRF_BUFFER_ADD( sql_buf, string );
3844 if( having_buf && *having_buf ) {
3845 OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3846 OSRF_BUFFER_ADD( sql_buf, having_buf );
3850 if( order_by_list ) {
3852 if ( *order_by_list ) {
3853 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3854 OSRF_BUFFER_ADD( sql_buf, order_by_list );
3857 free( order_by_list );
3861 const char* str = jsonObjectGetString(limit);
3862 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3866 const char* str = jsonObjectGetString(offset);
3867 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3870 if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3873 if (defaultselhash) jsonObjectFree(defaultselhash);
3875 return buffer_release(sql_buf);
3879 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3881 const char* locale = osrf_message_get_last_locale();
3883 osrfHash* fields = osrfHashGet(meta, "fields");
3884 char* core_class = osrfHashGet(meta, "classname");
3886 const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3888 jsonObject* node = NULL;
3889 jsonObject* snode = NULL;
3890 jsonObject* onode = NULL;
3891 const jsonObject* _tmp = NULL;
3892 jsonObject* selhash = NULL;
3893 jsonObject* defaultselhash = NULL;
3895 growing_buffer* sql_buf = buffer_init(128);
3896 growing_buffer* select_buf = buffer_init(128);
3898 if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
3899 defaultselhash = jsonNewObjectType(JSON_HASH);
3900 selhash = defaultselhash;
3903 if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
3904 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
3905 jsonObject* flist = jsonObjectGetKey( selhash, core_class );
3910 osrfStringArray* keys = osrfHashKeys( fields );
3911 while ( (field = osrfStringArrayGetString(keys, i++)) ) {
3912 if( ! str_is_true( osrfHashGet( osrfHashGet( fields, field ), "virtual" ) ) )
3913 jsonObjectPush( flist, jsonNewObject( field ) );
3915 osrfStringArrayFree(keys);
3919 jsonIterator* class_itr = jsonNewIterator( selhash );
3920 while ( (snode = jsonIteratorNext( class_itr )) ) {
3922 char* cname = class_itr->key;
3923 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
3924 if (!idlClass) continue;
3926 if (strcmp(core_class,class_itr->key)) {
3927 if (!join_hash) continue;
3929 jsonObject* found = jsonObjectFindPath(join_hash, "//%s", class_itr->key);
3931 jsonObjectFree(found);
3935 jsonObjectFree(found);
3938 jsonIterator* select_itr = jsonNewIterator( snode );
3939 while ( (node = jsonIteratorNext( select_itr )) ) {
3940 const char* item_str = jsonObjectGetString( node );
3941 osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
3942 char* fname = osrfHashGet(field, "name");
3944 if (!field) continue;
3949 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
3954 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
3955 if ( obj_is_true( no_i18n_obj ) ) // Suppress internationalization?
3958 i18n = osrfHashGet(field, "i18n");
3960 if( str_is_true( i18n ) ) {
3961 char* pkey = osrfHashGet(idlClass, "primarykey");
3962 char* tname = osrfHashGet(idlClass, "tablename");
3964 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);
3966 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3969 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3973 jsonIteratorFree(select_itr);
3976 jsonIteratorFree(class_itr);
3978 char* col_list = buffer_release(select_buf);
3979 char* table = getSourceDefinition(meta);
3981 table = strdup( "(null)" );
3983 buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
3988 char* join_clause = searchJOIN( join_hash, meta );
3989 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
3990 OSRF_BUFFER_ADD(sql_buf, join_clause);
3994 osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL = %s",
3995 MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
3997 OSRF_BUFFER_ADD(sql_buf, " WHERE ");
3999 char* pred = searchWHERE( search_hash, meta, AND_OP_JOIN, ctx );
4001 osrfAppSessionStatus(
4003 OSRF_STATUS_INTERNALSERVERERROR,
4004 "osrfMethodException",
4006 "Severe query error -- see error log for more details"
4008 buffer_free(sql_buf);
4009 if(defaultselhash) jsonObjectFree(defaultselhash);
4012 buffer_add(sql_buf, pred);
4017 char* string = NULL;
4018 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
4020 growing_buffer* order_buf = buffer_init(128);
4023 jsonIterator* class_itr = jsonNewIterator( _tmp );
4024 while ( (snode = jsonIteratorNext( class_itr )) ) {
4026 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
4029 if ( snode->type == JSON_HASH ) {
4031 jsonIterator* order_itr = jsonNewIterator( snode );
4032 while ( (onode = jsonIteratorNext( order_itr )) ) {
4034 osrfHash* field_def = oilsIDLFindPath( "/%s/fields/%s",
4035 class_itr->key, order_itr->key );
4039 char* direction = NULL;
4040 if ( onode->type == JSON_HASH ) {
4041 if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
4042 string = searchFieldTransform( class_itr->key, field_def, onode );
4044 osrfAppSessionStatus(
4046 OSRF_STATUS_INTERNALSERVERERROR,
4047 "osrfMethodException",
4049 "Severe query error in ORDER BY clause -- see error log for more details"
4051 jsonIteratorFree( order_itr );
4052 jsonIteratorFree( class_itr );
4053 buffer_free( order_buf );
4054 buffer_free( sql_buf );
4055 if( defaultselhash ) jsonObjectFree( defaultselhash );
4059 growing_buffer* field_buf = buffer_init(16);
4060 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
4061 string = buffer_release(field_buf);
4064 if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
4065 const char* dir = jsonObjectGetString(_tmp);
4066 if (!strncasecmp(dir, "d", 1)) {
4067 direction = " DESC";
4074 string = strdup(order_itr->key);
4075 const char* dir = jsonObjectGetString(onode);
4076 if (!strncasecmp(dir, "d", 1)) {
4077 direction = " DESC";
4086 buffer_add(order_buf, ", ");
4089 buffer_add(order_buf, string);
4093 buffer_add(order_buf, direction);
4098 jsonIteratorFree(order_itr);
4101 const char* str = jsonObjectGetString(snode);
4102 buffer_add(order_buf, str);
4108 jsonIteratorFree(class_itr);
4110 string = buffer_release(order_buf);
4113 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
4114 OSRF_BUFFER_ADD( sql_buf, string );
4120 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
4121 const char* str = jsonObjectGetString(_tmp);
4129 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
4131 const char* str = jsonObjectGetString(_tmp);
4140 if (defaultselhash) jsonObjectFree(defaultselhash);
4142 OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
4143 return buffer_release(sql_buf);
4146 int doJSONSearch ( osrfMethodContext* ctx ) {
4147 if(osrfMethodVerifyContext( ctx )) {
4148 osrfLogError( OSRF_LOG_MARK, "Invalid method context" );
4152 osrfLogDebug(OSRF_LOG_MARK, "Recieved query request");
4157 dbhandle = writehandle;
4159 jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
4163 if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
4164 flags |= SELECT_DISTINCT;
4166 if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
4167 flags |= DISABLE_I18N;
4169 osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
4172 jsonObjectGetKey( hash, "select" ),
4173 jsonObjectGetKey( hash, "from" ),
4174 jsonObjectGetKey( hash, "where" ),
4175 jsonObjectGetKey( hash, "having" ),
4176 jsonObjectGetKey( hash, "order_by" ),
4177 jsonObjectGetKey( hash, "limit" ),
4178 jsonObjectGetKey( hash, "offset" ),
4187 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
4188 dbi_result result = dbi_conn_query(dbhandle, sql);
4191 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4193 if (dbi_result_first_row(result)) {
4194 /* JSONify the result */
4195 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4198 jsonObject* return_val = oilsMakeJSONFromResult( result );
4199 osrfAppRespond( ctx, return_val );
4200 jsonObjectFree( return_val );
4201 } while (dbi_result_next_row(result));
4204 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
4207 osrfAppRespondComplete( ctx, NULL );
4209 /* clean up the query */
4210 dbi_result_free(result);
4214 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
4215 osrfAppSessionStatus(
4217 OSRF_STATUS_INTERNALSERVERERROR,
4218 "osrfMethodException",
4220 "Severe query error -- see error log for more details"
4228 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
4229 const jsonObject* params, int* err ) {
4232 dbhandle = writehandle;
4234 osrfHash* links = osrfHashGet(meta, "links");
4235 osrfHash* fields = osrfHashGet(meta, "fields");
4236 char* core_class = osrfHashGet(meta, "classname");
4237 char* pkey = osrfHashGet(meta, "primarykey");
4239 const jsonObject* _tmp;
4241 jsonObject* search_hash = jsonObjectGetIndex(params, 0);
4242 jsonObject* order_hash = jsonObjectGetIndex(params, 1);
4244 char* sql = buildSELECT( search_hash, order_hash, meta, ctx );
4246 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
4251 osrfLogDebug(OSRF_LOG_MARK, "%s SQL = %s", MODULENAME, sql);
4253 dbi_result result = dbi_conn_query(dbhandle, sql);
4254 if( NULL == result ) {
4255 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
4256 MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
4257 osrfAppSessionStatus(
4259 OSRF_STATUS_INTERNALSERVERERROR,
4260 "osrfMethodException",
4262 "Severe query error -- see error log for more details"
4269 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4272 jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
4273 osrfHash* dedup = osrfNewHash();
4275 if (dbi_result_first_row(result)) {
4276 /* JSONify the result */
4277 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4279 obj = oilsMakeFieldmapperFromResult( result, meta );
4280 char* pkey_val = oilsFMGetString( obj, pkey );
4281 if ( osrfHashGet( dedup, pkey_val ) ) {
4282 jsonObjectFree(obj);
4285 osrfHashSet( dedup, pkey_val, pkey_val );
4286 jsonObjectPush(res_list, obj);
4288 } while (dbi_result_next_row(result));
4290 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
4294 osrfHashFree(dedup);
4295 /* clean up the query */
4296 dbi_result_free(result);
4299 if (res_list->size && order_hash) {
4300 _tmp = jsonObjectGetKeyConst( order_hash, "flesh" );
4302 int x = (int)jsonObjectGetNumber(_tmp);
4303 if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4305 const jsonObject* temp_blob;
4306 if ((temp_blob = jsonObjectGetKeyConst( order_hash, "flesh_fields" )) && x > 0) {
4308 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4309 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4311 osrfStringArray* link_fields = NULL;
4314 if (flesh_fields->size == 1) {
4315 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4316 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4321 link_fields = osrfNewStringArray(1);
4322 jsonIterator* _i = jsonNewIterator( flesh_fields );
4323 while ((_f = jsonIteratorNext( _i ))) {
4324 osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4326 jsonIteratorFree(_i);
4331 jsonIterator* itr = jsonNewIterator( res_list );
4332 while ((cur = jsonIteratorNext( itr ))) {
4337 while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4339 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4341 osrfHash* kid_link = osrfHashGet(links, link_field);
4342 if (!kid_link) continue;
4344 osrfHash* field = osrfHashGet(fields, link_field);
4345 if (!field) continue;
4347 osrfHash* value_field = field;
4349 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4350 if (!kid_idl) continue;
4352 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4353 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4356 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4357 value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4360 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4362 if (link_map->size > 0) {
4363 jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4366 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4371 osrfHashGet(kid_link, "class"),
4378 "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4379 osrfHashGet(kid_link, "field"),
4380 osrfHashGet(kid_link, "class"),
4381 osrfHashGet(kid_link, "key"),
4382 osrfHashGet(kid_link, "reltype")
4385 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
4386 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // search hash
4387 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // order/flesh hash
4389 osrfLogDebug(OSRF_LOG_MARK, "Creating dummy params object...");
4391 const char* search_key = jsonObjectGetString(
4394 atoi( osrfHashGet(value_field, "array_position") )
4399 osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4404 jsonObjectGetIndex(fake_params, 0),
4405 osrfHashGet(kid_link, "key"),
4406 jsonNewObject( search_key )
4410 jsonObjectGetIndex(fake_params, 1),
4412 jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4416 jsonObjectSetKey( jsonObjectGetIndex(fake_params, 1), "flesh_fields", jsonObjectClone(flesh_blob) );
4418 if (jsonObjectGetKeyConst(order_hash, "order_by")) {
4420 jsonObjectGetIndex(fake_params, 1),
4422 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "order_by"))
4426 if (jsonObjectGetKeyConst(order_hash, "select")) {
4428 jsonObjectGetIndex(fake_params, 1),
4430 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "select"))
4434 jsonObject* kids = doFieldmapperSearch(ctx, kid_idl, fake_params, err);
4437 jsonObjectFree( fake_params );
4438 osrfStringArrayFree(link_fields);
4439 jsonIteratorFree(itr);
4440 jsonObjectFree(res_list);
4441 jsonObjectFree(flesh_blob);
4445 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4447 jsonObject* X = NULL;
4448 if ( link_map->size > 0 && kids->size > 0 ) {
4450 kids = jsonNewObjectType(JSON_ARRAY);
4452 jsonObject* _k_node;
4453 jsonIterator* _k = jsonNewIterator( X );
4454 while ((_k_node = jsonIteratorNext( _k ))) {
4460 (unsigned long)atoi(
4466 osrfHashGet(kid_link, "class")
4470 osrfStringArrayGetString( link_map, 0 )
4479 jsonIteratorFree(_k);
4482 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4483 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4486 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4487 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4491 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4492 osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4495 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4496 jsonObjectClone( kids )
4501 jsonObjectFree(kids);
4505 jsonObjectFree( kids );
4506 jsonObjectFree( fake_params );
4508 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4509 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4513 jsonObjectFree( flesh_blob );
4514 osrfStringArrayFree(link_fields);
4515 jsonIteratorFree(itr);
4524 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4526 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4528 jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4530 jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4533 if (!verifyObjectClass(ctx, target)) {
4538 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4539 osrfAppSessionStatus(
4541 OSRF_STATUS_BADREQUEST,
4542 "osrfMethodException",
4544 "No active transaction -- required for UPDATE"
4550 // The following test is harmless but redundant. If a class is
4551 // readonly, we don't register an update method for it.
4552 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4553 osrfAppSessionStatus(
4555 OSRF_STATUS_BADREQUEST,
4556 "osrfMethodException",
4558 "Cannot UPDATE readonly class"
4564 dbhandle = writehandle;
4566 char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4568 // Set the last_xact_id
4569 int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4571 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
4572 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4575 char* pkey = osrfHashGet(meta, "primarykey");
4576 osrfHash* fields = osrfHashGet(meta, "fields");
4578 char* id = oilsFMGetString( target, pkey );
4582 "%s updating %s object with %s = %s",
4584 osrfHashGet(meta, "fieldmapper"),
4589 growing_buffer* sql = buffer_init(128);
4590 buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4595 osrfStringArray* field_list = osrfHashKeys( fields );
4596 while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
4598 osrfHash* field = osrfHashGet( fields, field_name );
4600 if(!( strcmp( field_name, pkey ) )) continue;
4601 if( str_is_true( osrfHashGet(osrfHashGet(fields,field_name), "virtual") ) )
4604 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4606 int value_is_numeric = 0; // boolean
4608 if (field_object && field_object->classname) {
4609 value = oilsFMGetString(
4611 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4614 value = jsonObjectToSimpleString( field_object );
4615 if( field_object && JSON_NUMBER == field_object->type )
4616 value_is_numeric = 1;
4619 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s", osrfHashGet(meta, "fieldmapper"), field_name, value);
4621 if (!field_object || field_object->type == JSON_NULL) {
4622 if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) ) && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4623 if (first) first = 0;
4624 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4625 buffer_fadd( sql, " %s = NULL", field_name );
4628 } else if ( value_is_numeric || !strcmp( get_primitive( field ), "number") ) {
4629 if (first) first = 0;
4630 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4632 const char* numtype = get_datatype( field );
4633 if ( !strncmp( numtype, "INT", 3 ) ) {
4634 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4635 } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4636 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4638 // Must really be intended as a string, so quote it
4639 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4640 buffer_fadd( sql, " %s = %s", field_name, value );
4642 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4643 osrfAppSessionStatus(
4645 OSRF_STATUS_INTERNALSERVERERROR,
4646 "osrfMethodException",
4648 "Error quoting string -- please see the error log for more details"
4658 osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4661 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4662 if (first) first = 0;
4663 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4664 buffer_fadd( sql, " %s = %s", field_name, value );
4667 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4668 osrfAppSessionStatus(
4670 OSRF_STATUS_INTERNALSERVERERROR,
4671 "osrfMethodException",
4673 "Error quoting string -- please see the error log for more details"
4687 jsonObject* obj = jsonNewObject(id);
4689 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4690 dbi_conn_quote_string(dbhandle, &id);
4692 buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4694 char* query = buffer_release(sql);
4695 osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4697 dbi_result result = dbi_conn_query(dbhandle, query);
4701 jsonObjectFree(obj);
4702 obj = jsonNewObject(NULL);
4705 "%s ERROR updating %s object with %s = %s",
4707 osrfHashGet(meta, "fieldmapper"),
4718 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4720 osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4722 if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4723 osrfAppSessionStatus(
4725 OSRF_STATUS_BADREQUEST,
4726 "osrfMethodException",
4728 "No active transaction -- required for DELETE"
4734 // The following test is harmless but redundant. If a class is
4735 // readonly, we don't register a delete method for it.
4736 if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4737 osrfAppSessionStatus(
4739 OSRF_STATUS_BADREQUEST,
4740 "osrfMethodException",
4742 "Cannot DELETE readonly class"
4748 dbhandle = writehandle;
4752 char* pkey = osrfHashGet(meta, "primarykey");
4760 if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4761 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4766 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4769 if (!verifyObjectPCRUD( ctx, NULL )) {
4774 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4779 "%s deleting %s object with %s = %s",
4781 osrfHashGet(meta, "fieldmapper"),
4786 obj = jsonNewObject(id);
4788 if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4789 dbi_conn_quote_string(writehandle, &id);
4791 dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4794 jsonObjectFree(obj);
4795 obj = jsonNewObject(NULL);
4798 "%s ERROR deleting %s object with %s = %s",
4800 osrfHashGet(meta, "fieldmapper"),
4813 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4814 if(!(result && meta)) return jsonNULL;
4816 jsonObject* object = jsonNewObject(NULL);
4817 jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4819 osrfHash* fields = osrfHashGet(meta, "fields");
4821 osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4825 char dt_string[256];
4829 int columnIndex = 1;
4831 unsigned short type;
4832 const char* columnName;
4834 /* cycle through the column list */
4835 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4837 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4839 fmIndex = -1; // reset the position
4841 /* determine the field type and storage attributes */
4842 type = dbi_result_get_field_type(result, columnName);
4843 attr = dbi_result_get_field_attribs(result, columnName);
4845 /* fetch the fieldmapper index */
4846 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4848 if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4851 const char* pos = (char*)osrfHashGet(_f, "array_position");
4852 if ( !pos ) continue;
4854 fmIndex = atoi( pos );
4855 osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4860 if (dbi_result_field_is_null(result, columnName)) {
4861 jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4866 case DBI_TYPE_INTEGER :
4868 if( attr & DBI_INTEGER_SIZE8 )
4869 jsonObjectSetIndex( object, fmIndex,
4870 jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
4872 jsonObjectSetIndex( object, fmIndex,
4873 jsonNewNumberObject(dbi_result_get_int(result, columnName)));
4877 case DBI_TYPE_DECIMAL :
4878 jsonObjectSetIndex( object, fmIndex,
4879 jsonNewNumberObject(dbi_result_get_double(result, columnName)));
4882 case DBI_TYPE_STRING :
4888 jsonNewObject( dbi_result_get_string(result, columnName) )
4893 case DBI_TYPE_DATETIME :
4895 memset(dt_string, '\0', sizeof(dt_string));
4896 memset(&gmdt, '\0', sizeof(gmdt));
4898 _tmp_dt = dbi_result_get_datetime(result, columnName);
4901 if (!(attr & DBI_DATETIME_DATE)) {
4902 gmtime_r( &_tmp_dt, &gmdt );
4903 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4904 } else if (!(attr & DBI_DATETIME_TIME)) {
4905 localtime_r( &_tmp_dt, &gmdt );
4906 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4908 localtime_r( &_tmp_dt, &gmdt );
4909 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4912 jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
4916 case DBI_TYPE_BINARY :
4917 osrfLogError( OSRF_LOG_MARK,
4918 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4926 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
4927 if(!result) return jsonNULL;
4929 jsonObject* object = jsonNewObject(NULL);
4932 char dt_string[256];
4936 int columnIndex = 1;
4938 unsigned short type;
4939 const char* columnName;
4941 /* cycle through the column list */
4942 while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4944 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4946 fmIndex = -1; // reset the position
4948 /* determine the field type and storage attributes */
4949 type = dbi_result_get_field_type(result, columnName);
4950 attr = dbi_result_get_field_attribs(result, columnName);
4952 if (dbi_result_field_is_null(result, columnName)) {
4953 jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
4958 case DBI_TYPE_INTEGER :
4960 if( attr & DBI_INTEGER_SIZE8 )
4961 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_longlong(result, columnName)) );
4963 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_int(result, columnName)) );
4966 case DBI_TYPE_DECIMAL :
4967 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_double(result, columnName)) );
4970 case DBI_TYPE_STRING :
4971 jsonObjectSetKey( object, columnName, jsonNewObject(dbi_result_get_string(result, columnName)) );
4974 case DBI_TYPE_DATETIME :
4976 memset(dt_string, '\0', sizeof(dt_string));
4977 memset(&gmdt, '\0', sizeof(gmdt));
4979 _tmp_dt = dbi_result_get_datetime(result, columnName);
4982 if (!(attr & DBI_DATETIME_DATE)) {
4983 gmtime_r( &_tmp_dt, &gmdt );
4984 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4985 } else if (!(attr & DBI_DATETIME_TIME)) {
4986 localtime_r( &_tmp_dt, &gmdt );
4987 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4989 localtime_r( &_tmp_dt, &gmdt );
4990 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4993 jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
4996 case DBI_TYPE_BINARY :
4997 osrfLogError( OSRF_LOG_MARK,
4998 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
5006 // Interpret a string as true or false
5007 static int str_is_true( const char* str ) {
5008 if( NULL == str || strcasecmp( str, "true" ) )
5014 // Interpret a jsonObject as true or false
5015 static int obj_is_true( const jsonObject* obj ) {
5018 else switch( obj->type )
5026 if( strcasecmp( obj->value.s, "true" ) )
5030 case JSON_NUMBER : // Support 1/0 for perl's sake
5031 if( jsonObjectGetNumber( obj ) == 1.0 )
5040 // Translate a numeric code into a text string identifying a type of
5041 // jsonObject. To be used for building error messages.
5042 static const char* json_type( int code ) {
5048 return "JSON_ARRAY";
5050 return "JSON_STRING";
5052 return "JSON_NUMBER";
5058 return "(unrecognized)";
5062 // Extract the "primitive" attribute from an IDL field definition.
5063 // If we haven't initialized the app, then we must be running in
5064 // some kind of testbed. In that case, default to "string".
5065 static const char* get_primitive( osrfHash* field ) {
5066 const char* s = osrfHashGet( field, "primitive" );
5068 if( child_initialized )
5071 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5073 osrfHashGet( field, "name" )
5081 // Extract the "datatype" attribute from an IDL field definition.
5082 // If we haven't initialized the app, then we must be running in
5083 // some kind of testbed. In that case, default to to NUMERIC,
5084 // since we look at the datatype only for numbers.
5085 static const char* get_datatype( osrfHash* field ) {
5086 const char* s = osrfHashGet( field, "datatype" );
5088 if( child_initialized )
5091 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5093 osrfHashGet( field, "name" )
5102 If the input string is potentially a valid SQL identifier, return 1.
5105 Purpose: to prevent certain kinds of SQL injection. To that end we
5106 don't necessarily need to follow all the rules exactly, such as requiring
5107 that the first character not be a digit.
5109 We allow leading and trailing white space. In between, we do not allow
5110 punctuation (except for underscores and dollar signs), control
5111 characters, or embedded white space.
5113 More pedantically we should allow quoted identifiers containing arbitrary
5114 characters, but for the foreseeable future such quoted identifiers are not
5115 likely to be an issue.
5117 static int is_identifier( const char* s) {
5121 // Skip leading white space
5122 while( isspace( (unsigned char) *s ) )
5126 return 0; // Nothing but white space? Not okay.
5128 // Check each character until we reach white space or
5129 // end-of-string. Letters, digits, underscores, and
5130 // dollar signs are okay. With the exception of periods
5131 // (as in schema.identifier), control characters and other
5132 // punctuation characters are not okay. Anything else
5133 // is okay -- it could for example be part of a multibyte
5134 // UTF8 character such as a letter with diacritical marks,
5135 // and those are allowed.
5137 if( isalnum( (unsigned char) *s )
5141 ; // Fine; keep going
5142 else if( ispunct( (unsigned char) *s )
5143 || iscntrl( (unsigned char) *s ) )
5146 } while( *s && ! isspace( (unsigned char) *s ) );
5148 // If we found any white space in the above loop,
5149 // the rest had better be all white space.
5151 while( isspace( (unsigned char) *s ) )
5155 return 0; // White space was embedded within non-white space
5161 Determine whether to accept a character string as a comparison operator.
5162 Return 1 if it's good, or 0 if it's bad.
5164 We don't validate it for real. We just make sure that it doesn't contain
5165 any semicolons or white space (with a special exception for the
5166 "SIMILAR TO" operator). The idea is to block certain kinds of SQL
5167 injection. If it has no semicolons or white space but it's still not a
5168 valid operator, then the database will complain.
5170 Another approach would be to compare the string against a short list of
5171 approved operators. We don't do that because we want to allow custom
5172 operators like ">100*", which would be difficult or impossible to
5173 express otherwise in a JSON query.
5175 static int is_good_operator( const char* op ) {
5176 if( !op ) return 0; // Sanity check
5180 if( isspace( (unsigned char) *s ) ) {
5181 // Special exception for SIMILAR TO. Someday we might make
5182 // exceptions for IS DISTINCT FROM and IS NOT DISTINCT FROM.
5183 if( !strcasecmp( op, "similar to" ) )
5188 else if( ';' == *s )