Open-ILS/src/c-apps/oils_cstore.c

   1 #include <ctype.h>
   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"
   9 #include <dbi/dbi.h>
  10
  11 #include <time.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <unistd.h>
  15
  16 #ifdef RSTORE
  17 #  define MODULENAME "open-ils.reporter-store"
  18 #else
  19 #  ifdef PCRUD
  20 #    define MODULENAME "open-ils.pcrud"
  21 #  else
  22 #    define MODULENAME "open-ils.cstore"
  23 #  endif
  24 #endif
  25
  26 #define SUBSELECT       4
  27 #define DISABLE_I18N    2
  28 #define SELECT_DISTINCT 1
  29 #define AND_OP_JOIN     0
  30 #define OR_OP_JOIN      1
  31
  32 int osrfAppChildInit();
  33 int osrfAppInitialize();
  34 void osrfAppChildExit();
  35
  36 static int verifyObjectClass ( osrfMethodContext*, const jsonObject* );
  37
  38 int beginTransaction ( osrfMethodContext* );
  39 int commitTransaction ( osrfMethodContext* );
  40 int rollbackTransaction ( osrfMethodContext* );
  41
  42 int setSavepoint ( osrfMethodContext* );
  43 int releaseSavepoint ( osrfMethodContext* );
  44 int rollbackSavepoint ( osrfMethodContext* );
  45
  46 int doJSONSearch ( osrfMethodContext* );
  47
  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 );
  57
  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* );
  70
  71 char* SELECT ( osrfMethodContext*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, int );
  72
  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 );
  83
  84 #ifdef PCRUD
  85 static jsonObject* verifyUserPCRUD( osrfMethodContext* );
  86 static int verifyObjectPCRUD( osrfMethodContext*, const jsonObject* );
  87 #endif
  88
  89 static int child_initialized = 0;   /* boolean */
  90
  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;
  96
  97 /* called when this process is about to exit */
  98 void osrfAppChildExit() {
  99     osrfLogDebug(OSRF_LOG_MARK, "Child is exiting, disconnecting from database...");
 100
 101     int same = 0;
 102     if (writehandle == dbhandle) same = 1;
 103     if (writehandle) {
 104         dbi_conn_query(writehandle, "ROLLBACK;");
 105         dbi_conn_close(writehandle);
 106         writehandle = NULL;
 107     }
 108     if (dbhandle && !same)
 109         dbi_conn_close(dbhandle);
 110
 111     // XXX add cleanup of readHandles whenever that gets used
 112
 113     return;
 114 }
 115
 116 int osrfAppInitialize() {
 117
 118     osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
 119     osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
 120
 121     if (!oilsIDLInit( osrf_settings_host_value("/IDL") )) return 1; /* return non-zero to indicate error */
 122
 123     growing_buffer* method_name = buffer_init(64);
 124 #ifndef PCRUD
 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 );
 130 #endif
 131
 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 );
 138
 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 );
 144
 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 );
 150
 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 );
 156
 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 );
 162
 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 );
 168
 169     buffer_free(method_name);
 170
 171         static const char* global_method[] = {
 172                 "create",
 173                 "retrieve",
 174                 "update",
 175                 "delete",
 176                 "search",
 177                 "id_list"
 178         };
 179         const int global_method_count
 180                 = sizeof( global_method ) / sizeof ( global_method[0] );
 181
 182     int c_index = 0;
 183     char* classname;
 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);
 188
 189     while ( (classname = osrfStringArrayGetString(classes, c_index++)) ) {
 190         osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", classname);
 191
 192         osrfHash* idlClass = osrfHashGet(oilsIDL(), classname);
 193
 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);
 196             continue;
 197         }
 198
 199                 if ( str_is_true( osrfHashGet(idlClass, "virtual") ) ) {
 200                         osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
 201                         continue;
 202                 }
 203
 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");
 207 #ifdef PCRUD
 208         osrfHash* idlClass_permacrud = osrfHashGet(idlClass, "permacrud");
 209 #endif
 210
 211         int i;
 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);
 216
 217             if (!idlClass_fieldmapper) continue;
 218
 219 #ifdef PCRUD
 220             if (!idlClass_permacrud) continue;
 221
 222             const char* tmp_method = method_type;
 223             if ( *tmp_method == 'i' || *tmp_method == 's') {
 224                 tmp_method = "retrieve";
 225             }
 226             if (!osrfHashGet( idlClass_permacrud, tmp_method )) continue;
 227 #endif
 228
 229             if (    str_is_true( readonly ) &&
 230                     ( *method_type == 'c' || *method_type == 'u' || *method_type == 'd')
 231                ) continue;
 232
 233             osrfHash* method_meta = osrfNewHash();
 234             osrfHashSet(method_meta, idlClass, "class");
 235
 236             method_name =  buffer_init(64);
 237 #ifdef PCRUD
 238             buffer_fadd(method_name, "%s.%s.%s", MODULENAME, method_type, classname);
 239 #else
 240             char* st_tmp = NULL;
 241             char* part = NULL;
 242             char* _fm = strdup( idlClass_fieldmapper );
 243             part = strtok_r(_fm, ":", &st_tmp);
 244
 245             buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
 246
 247             while ((part = strtok_r(NULL, ":", &st_tmp))) {
 248                                 OSRF_BUFFER_ADD_CHAR(method_name, '.');
 249                                 OSRF_BUFFER_ADD(method_name, part);
 250             }
 251                         OSRF_BUFFER_ADD_CHAR(method_name, '.');
 252                         OSRF_BUFFER_ADD(method_name, method_type);
 253             free(_fm);
 254 #endif
 255
 256             char* method = buffer_release(method_name);
 257
 258             osrfHashSet( method_meta, method, "methodname" );
 259             osrfHashSet( method_meta, strdup(method_type), "methodtype" );
 260
 261             int flags = 0;
 262             if (*method_type == 'i' || *method_type == 's') {
 263                 flags = flags | OSRF_METHOD_STREAMING;
 264             }
 265
 266             osrfAppRegisterExtendedMethod(
 267                     MODULENAME,
 268                     method,
 269                     "dispatchCRUDMethod",
 270                     "",
 271                     1,
 272                     flags,
 273                     (void*)method_meta
 274                     );
 275
 276             free(method);
 277         }
 278     }
 279
 280     return 0;
 281 }
 282
 283 static char* getSourceDefinition( osrfHash* class ) {
 284
 285         char* tabledef = osrfHashGet(class, "tablename");
 286
 287         if (tabledef) {
 288                 tabledef = strdup(tabledef);
 289         } else {
 290                 tabledef = osrfHashGet(class, "source_definition");
 291                 if( tabledef ) {
 292                         growing_buffer* tablebuf = buffer_init(128);
 293                         buffer_fadd( tablebuf, "(%s)", tabledef );
 294                         tabledef = buffer_release(tablebuf);
 295                 } else {
 296                         const char* classname = osrfHashGet( class, "classname" );
 297                         if( !classname )
 298                                 classname = "???";
 299                         osrfLogError(
 300                                 OSRF_LOG_MARK,
 301                                 "%s ERROR No tablename or source_definition for class \"%s\"",
 302                                 MODULENAME,
 303                                 classname
 304                         );
 305                 }
 306         }
 307
 308         return tabledef;
 309 }
 310
 311 /**
 312  * Connects to the database
 313  */
 314 int osrfAppChildInit() {
 315
 316     osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
 317     dbi_initialize(NULL);
 318     osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
 319
 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);
 327
 328     osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
 329     writehandle = dbi_conn_new(driver);
 330
 331     if(!writehandle) {
 332         osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
 333         return -1;
 334     }
 335     osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
 336
 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 );
 339
 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 );
 345
 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;
 349
 350     free(user);
 351     free(host);
 352     free(port);
 353     free(db);
 354     free(pw);
 355
 356     const char* err;
 357     if (dbi_conn_connect(writehandle) < 0) {
 358         sleep(1);
 359         if (dbi_conn_connect(writehandle) < 0) {
 360             dbi_conn_error(writehandle, &err);
 361             osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
 362             return -1;
 363         }
 364     }
 365
 366     osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
 367
 368     unsigned short type;
 369     int i = 0;
 370     char* classname;
 371     osrfStringArray* classes = osrfHashKeys( oilsIDL() );
 372
 373     while ( (classname = osrfStringArrayGetString(classes, i++)) ) {
 374         osrfHash* class = osrfHashGet( oilsIDL(), classname );
 375         osrfHash* fields = osrfHashGet( class, "fields" );
 376
 377                 if( str_is_true( osrfHashGet(class, "virtual") ) ) {
 378                         osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
 379                         continue;
 380                 }
 381
 382         char* tabledef = getSourceDefinition(class);
 383                 if( !tabledef )
 384                         tabledef = strdup( "(null)" );
 385
 386         growing_buffer* sql_buf = buffer_init(32);
 387         buffer_fadd( sql_buf, "SELECT * FROM %s AS x WHERE 1=0;", tabledef );
 388
 389         free(tabledef);
 390
 391         char* sql = buffer_release(sql_buf);
 392         osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
 393
 394         dbi_result result = dbi_conn_query(writehandle, sql);
 395         free(sql);
 396
 397         if (result) {
 398
 399             int columnIndex = 1;
 400             const char* columnName;
 401             osrfHash* _f;
 402             while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
 403
 404                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
 405
 406                 /* fetch the fieldmapper index */
 407                 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
 408
 409                     osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
 410
 411                     /* determine the field type and storage attributes */
 412                     type = dbi_result_get_field_type(result, columnName);
 413
 414                     switch( type ) {
 415
 416                                                 case DBI_TYPE_INTEGER : {
 417
 418                                                         if ( !osrfHashGet(_f, "primitive") )
 419                                                                 osrfHashSet(_f,"number", "primitive");
 420
 421                                                         int attr = dbi_result_get_field_attribs(result, columnName);
 422                                                         if( attr & DBI_INTEGER_SIZE8 )
 423                                                                 osrfHashSet(_f,"INT8", "datatype");
 424                                                         else
 425                                                                 osrfHashSet(_f,"INT", "datatype");
 426                                                         break;
 427                                                 }
 428                         case DBI_TYPE_DECIMAL :
 429                             if ( !osrfHashGet(_f, "primitive") )
 430                                 osrfHashSet(_f,"number", "primitive");
 431
 432                             osrfHashSet(_f,"NUMERIC", "datatype");
 433                             break;
 434
 435                         case DBI_TYPE_STRING :
 436                             if ( !osrfHashGet(_f, "primitive") )
 437                                 osrfHashSet(_f,"string", "primitive");
 438                             osrfHashSet(_f,"TEXT", "datatype");
 439                             break;
 440
 441                         case DBI_TYPE_DATETIME :
 442                             if ( !osrfHashGet(_f, "primitive") )
 443                                 osrfHashSet(_f,"string", "primitive");
 444
 445                             osrfHashSet(_f,"TIMESTAMP", "datatype");
 446                             break;
 447
 448                         case DBI_TYPE_BINARY :
 449                             if ( !osrfHashGet(_f, "primitive") )
 450                                 osrfHashSet(_f,"string", "primitive");
 451
 452                             osrfHashSet(_f,"BYTEA", "datatype");
 453                     }
 454
 455                     osrfLogDebug(
 456                             OSRF_LOG_MARK,
 457                             "Setting [%s] to primitive [%s] and datatype [%s]...",
 458                             (char*)columnName,
 459                             osrfHashGet(_f, "primitive"),
 460                             osrfHashGet(_f, "datatype")
 461                             );
 462                 }
 463             }
 464             dbi_result_free(result);
 465         } else {
 466             osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
 467         }
 468     }
 469
 470     osrfStringArrayFree(classes);
 471
 472         child_initialized = 1;
 473     return 0;
 474 }
 475
 476 /*
 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().
 480 */
 481 void set_cstore_dbi_conn( dbi_conn conn ) {
 482         dbhandle = writehandle = conn;
 483 }
 484
 485 void userDataFree( void* blob ) {
 486     osrfHashFree( (osrfHash*)blob );
 487     return;
 488 }
 489
 490 static void sessionDataFree( char* key, void* item ) {
 491     if (!(strcmp(key,"xact_id"))) {
 492         if (writehandle)
 493             dbi_conn_query(writehandle, "ROLLBACK;");
 494         free(item);
 495     }
 496
 497     return;
 498 }
 499
 500 int beginTransaction ( osrfMethodContext* ctx ) {
 501         if(osrfMethodVerifyContext( ctx )) {
 502                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 503                 return -1;
 504         }
 505
 506 #ifdef PCRUD
 507     jsonObject* user = verifyUserPCRUD( ctx );
 508     if (!user) return -1;
 509     jsonObjectFree(user);
 510 #endif
 511
 512     dbi_result result = dbi_conn_query(writehandle, "START TRANSACTION;");
 513     if (!result) {
 514         osrfLogError(OSRF_LOG_MARK, "%s: Error starting transaction", MODULENAME );
 515         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error starting transaction" );
 516         return -1;
 517     } else {
 518         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 519         osrfAppRespondComplete( ctx, ret );
 520         jsonObjectFree(ret);
 521
 522         if (!ctx->session->userData) {
 523             ctx->session->userData = osrfNewHash();
 524             osrfHashSetCallback((osrfHash*)ctx->session->userData, &sessionDataFree);
 525         }
 526
 527         osrfHashSet( (osrfHash*)ctx->session->userData, strdup( ctx->session->session_id ), "xact_id" );
 528         ctx->session->userDataFree = &userDataFree;
 529
 530     }
 531     return 0;
 532 }
 533
 534 int setSavepoint ( osrfMethodContext* ctx ) {
 535         if(osrfMethodVerifyContext( ctx )) {
 536                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 537                 return -1;
 538         }
 539
 540     int spNamePos = 0;
 541 #ifdef PCRUD
 542     spNamePos = 1;
 543     jsonObject* user = verifyUserPCRUD( ctx );
 544     if (!user) return -1;
 545     jsonObjectFree(user);
 546 #endif
 547
 548     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 549         osrfAppSessionStatus(
 550                 ctx->session,
 551                 OSRF_STATUS_INTERNALSERVERERROR,
 552                 "osrfMethodException",
 553                 ctx->request,
 554                 "No active transaction -- required for savepoints"
 555                 );
 556         return -1;
 557     }
 558
 559         const char* spName = jsonObjectGetString(jsonObjectGetIndex(ctx->params, spNamePos));
 560
 561         dbi_result result = dbi_conn_queryf(writehandle, "SAVEPOINT \"%s\";", spName);
 562         if (!result) {
 563                 osrfLogError(
 564                         OSRF_LOG_MARK,
 565                         "%s: Error creating savepoint %s in transaction %s",
 566                         MODULENAME,
 567                         spName,
 568                         osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 569                 );
 570                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 571                                 "osrfMethodException", ctx->request, "Error creating savepoint" );
 572                 return -1;
 573         } else {
 574                 jsonObject* ret = jsonNewObject(spName);
 575                 osrfAppRespondComplete( ctx, ret );
 576                 jsonObjectFree(ret);
 577         }
 578         return 0;
 579 }
 580
 581 int releaseSavepoint ( osrfMethodContext* ctx ) {
 582         if(osrfMethodVerifyContext( ctx )) {
 583                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 584                 return -1;
 585         }
 586
 587         int spNamePos = 0;
 588 #ifdef PCRUD
 589     spNamePos = 1;
 590     jsonObject* user = verifyUserPCRUD( ctx );
 591     if (!user) return -1;
 592     jsonObjectFree(user);
 593 #endif
 594
 595     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 596         osrfAppSessionStatus(
 597                 ctx->session,
 598                 OSRF_STATUS_INTERNALSERVERERROR,
 599                 "osrfMethodException",
 600                 ctx->request,
 601                 "No active transaction -- required for savepoints"
 602                 );
 603         return -1;
 604     }
 605
 606         const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
 607
 608     dbi_result result = dbi_conn_queryf(writehandle, "RELEASE SAVEPOINT \"%s\";", spName);
 609     if (!result) {
 610         osrfLogError(
 611                 OSRF_LOG_MARK,
 612                 "%s: Error releasing savepoint %s in transaction %s",
 613                 MODULENAME,
 614                 spName,
 615                 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 616                 );
 617                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 618                                 "osrfMethodException", ctx->request, "Error releasing savepoint" );
 619         return -1;
 620     } else {
 621         jsonObject* ret = jsonNewObject(spName);
 622         osrfAppRespondComplete( ctx, ret );
 623         jsonObjectFree(ret);
 624     }
 625     return 0;
 626 }
 627
 628 int rollbackSavepoint ( osrfMethodContext* ctx ) {
 629         if(osrfMethodVerifyContext( ctx )) {
 630                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 631                 return -1;
 632         }
 633
 634         int spNamePos = 0;
 635 #ifdef PCRUD
 636     spNamePos = 1;
 637     jsonObject* user = verifyUserPCRUD( ctx );
 638     if (!user) return -1;
 639     jsonObjectFree(user);
 640 #endif
 641
 642     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 643         osrfAppSessionStatus(
 644                 ctx->session,
 645                 OSRF_STATUS_INTERNALSERVERERROR,
 646                 "osrfMethodException",
 647                 ctx->request,
 648                 "No active transaction -- required for savepoints"
 649                 );
 650         return -1;
 651     }
 652
 653         const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
 654
 655     dbi_result result = dbi_conn_queryf(writehandle, "ROLLBACK TO SAVEPOINT \"%s\";", spName);
 656     if (!result) {
 657         osrfLogError(
 658                 OSRF_LOG_MARK,
 659                 "%s: Error rolling back savepoint %s in transaction %s",
 660                 MODULENAME,
 661                 spName,
 662                 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 663                 );
 664                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 665                                 "osrfMethodException", ctx->request, "Error rolling back savepoint" );
 666         return -1;
 667     } else {
 668         jsonObject* ret = jsonNewObject(spName);
 669         osrfAppRespondComplete( ctx, ret );
 670         jsonObjectFree(ret);
 671     }
 672     return 0;
 673 }
 674
 675 int commitTransaction ( osrfMethodContext* ctx ) {
 676         if(osrfMethodVerifyContext( ctx )) {
 677                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 678                 return -1;
 679         }
 680
 681 #ifdef PCRUD
 682     jsonObject* user = verifyUserPCRUD( ctx );
 683     if (!user) return -1;
 684     jsonObjectFree(user);
 685 #endif
 686
 687     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 688         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "No active transaction to commit" );
 689         return -1;
 690     }
 691
 692     dbi_result result = dbi_conn_query(writehandle, "COMMIT;");
 693     if (!result) {
 694         osrfLogError(OSRF_LOG_MARK, "%s: Error committing transaction", MODULENAME );
 695         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error committing transaction" );
 696         return -1;
 697     } else {
 698         osrfHashRemove(ctx->session->userData, "xact_id");
 699         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 700         osrfAppRespondComplete( ctx, ret );
 701         jsonObjectFree(ret);
 702     }
 703     return 0;
 704 }
 705
 706 int rollbackTransaction ( osrfMethodContext* ctx ) {
 707         if(osrfMethodVerifyContext( ctx )) {
 708                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 709                 return -1;
 710         }
 711
 712 #ifdef PCRUD
 713     jsonObject* user = verifyUserPCRUD( ctx );
 714     if (!user) return -1;
 715     jsonObjectFree(user);
 716 #endif
 717
 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" );
 720         return -1;
 721     }
 722
 723     dbi_result result = dbi_conn_query(writehandle, "ROLLBACK;");
 724     if (!result) {
 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" );
 727         return -1;
 728     } else {
 729         osrfHashRemove(ctx->session->userData, "xact_id");
 730         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 731         osrfAppRespondComplete( ctx, ret );
 732         jsonObjectFree(ret);
 733     }
 734     return 0;
 735 }
 736
 737 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
 738         if(osrfMethodVerifyContext( ctx )) {
 739                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 740                 return -1;
 741         }
 742
 743         osrfHash* meta = (osrfHash*) ctx->method->userData;
 744     osrfHash* class_obj = osrfHashGet( meta, "class" );
 745
 746     int err = 0;
 747
 748     const char* methodtype = osrfHashGet(meta, "methodtype");
 749     jsonObject * obj = NULL;
 750
 751     if (!strcmp(methodtype, "create")) {
 752         obj = doCreate(ctx, &err);
 753         osrfAppRespondComplete( ctx, obj );
 754     }
 755     else if (!strcmp(methodtype, "retrieve")) {
 756         obj = doRetrieve(ctx, &err);
 757         osrfAppRespondComplete( ctx, obj );
 758     }
 759     else if (!strcmp(methodtype, "update")) {
 760         obj = doUpdate(ctx, &err);
 761         osrfAppRespondComplete( ctx, obj );
 762     }
 763     else if (!strcmp(methodtype, "delete")) {
 764         obj = doDelete(ctx, &err);
 765         osrfAppRespondComplete( ctx, obj );
 766     }
 767     else if (!strcmp(methodtype, "search")) {
 768
 769         jsonObject* _p = jsonObjectClone( ctx->params );
 770 #ifdef PCRUD
 771         jsonObjectFree(_p);
 772         _p = jsonParseString("[]");
 773         jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 1)));
 774         jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 2)));
 775 #endif
 776
 777         obj = doFieldmapperSearch(ctx, class_obj, _p, &err);
 778
 779         jsonObjectFree(_p);
 780         if(err) return err;
 781
 782         jsonObject* cur;
 783         jsonIterator* itr = jsonNewIterator( obj );
 784         while ((cur = jsonIteratorNext( itr ))) {
 785 #ifdef PCRUD
 786             if(!verifyObjectPCRUD(ctx, cur)) continue;
 787 #endif
 788             osrfAppRespond( ctx, cur );
 789         }
 790         jsonIteratorFree(itr);
 791         osrfAppRespondComplete( ctx, NULL );
 792
 793     } else if (!strcmp(methodtype, "id_list")) {
 794
 795         jsonObject* _p = jsonObjectClone( ctx->params );
 796 #ifdef PCRUD
 797         jsonObjectFree(_p);
 798         _p = jsonParseString("[]");
 799         jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 1)));
 800         jsonObjectPush(_p, jsonObjectClone(jsonObjectGetIndex(ctx->params, 2)));
 801 #endif
 802
 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" );
 808         } else {
 809             jsonObjectSetIndex( _p, 1, jsonNewObjectType(JSON_HASH) );
 810         }
 811
 812                 jsonObjectSetKey( jsonObjectGetIndex( _p, 1 ), "no_i18n", jsonNewBoolObject( 1 ) );
 813
 814         jsonObjectSetKey(
 815             jsonObjectGetIndex( _p, 1 ),
 816             "select",
 817             jsonParseStringFmt(
 818                 "{ \"%s\":[\"%s\"] }",
 819                 osrfHashGet( class_obj, "classname" ),
 820                 osrfHashGet( class_obj, "primarykey" )
 821             )
 822         );
 823
 824         obj = doFieldmapperSearch(ctx, class_obj, _p, &err);
 825
 826         jsonObjectFree(_p);
 827         if(err) return err;
 828
 829         jsonObject* cur;
 830         jsonIterator* itr = jsonNewIterator( obj );
 831         while ((cur = jsonIteratorNext( itr ))) {
 832 #ifdef PCRUD
 833             if(!verifyObjectPCRUD(ctx, cur)) continue;
 834 #endif
 835             osrfAppRespond(
 836                     ctx,
 837                     oilsFMGetObject( cur, osrfHashGet( class_obj, "primarykey" ) )
 838                     );
 839         }
 840         jsonIteratorFree(itr);
 841         osrfAppRespondComplete( ctx, NULL );
 842
 843     } else {
 844         osrfAppRespondComplete( ctx, obj );
 845     }
 846
 847     jsonObjectFree(obj);
 848
 849     return err;
 850 }
 851
 852 static int verifyObjectClass ( osrfMethodContext* ctx, const jsonObject* param ) {
 853
 854     int ret = 1;
 855     osrfHash* meta = (osrfHash*) ctx->method->userData;
 856     osrfHash* class = osrfHashGet( meta, "class" );
 857
 858     if (!param->classname || (strcmp( osrfHashGet(class, "classname"), param->classname ))) {
 859
 860         growing_buffer* msg = buffer_init(128);
 861         buffer_fadd(
 862                 msg,
 863                 "%s: %s method for type %s was passed a %s",
 864                 MODULENAME,
 865                 osrfHashGet(meta, "methodtype"),
 866                 osrfHashGet(class, "classname"),
 867                 param->classname
 868                 );
 869
 870         char* m = buffer_release(msg);
 871         osrfAppSessionStatus( ctx->session, OSRF_STATUS_BADREQUEST, "osrfMethodException", ctx->request, m );
 872
 873         free(m);
 874
 875         return 0;
 876     }
 877
 878 #ifdef PCRUD
 879     ret = verifyObjectPCRUD( ctx, param );
 880 #endif
 881
 882     return ret;
 883 }
 884
 885 #ifdef PCRUD
 886
 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);
 892
 893     if (!user->classname || strcmp(user->classname, "au")) {
 894
 895         growing_buffer* msg = buffer_init(128);
 896         buffer_fadd(
 897             msg,
 898             "%s: permacrud received a bad auth token: %s",
 899             MODULENAME,
 900             auth
 901         );
 902
 903         char* m = buffer_release(msg);
 904         osrfAppSessionStatus( ctx->session, OSRF_STATUS_UNAUTHORIZED, "osrfMethodException", ctx->request, m );
 905
 906         free(m);
 907         jsonObjectFree(user);
 908         user = jsonNULL;
 909     }
 910
 911     return user;
 912
 913 }
 914
 915 static int verifyObjectPCRUD (  osrfMethodContext* ctx, const jsonObject* obj ) {
 916
 917     dbhandle = writehandle;
 918
 919     osrfHash* meta = (osrfHash*) ctx->method->userData;
 920     osrfHash* class = osrfHashGet( meta, "class" );
 921     char* method_type = strdup( osrfHashGet(meta, "methodtype") );
 922     int fetch = 0;
 923
 924     if ( ( *method_type == 's' || *method_type == 'i' ) ) {
 925         free(method_type);
 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
 929     }
 930
 931     osrfHash* pcrud = osrfHashGet( osrfHashGet(class, "permacrud"), method_type );
 932     free(method_type);
 933
 934     if (!pcrud) {
 935         // No permacrud for this method type on this class
 936
 937         growing_buffer* msg = buffer_init(128);
 938         buffer_fadd(
 939             msg,
 940             "%s: %s on class %s has no permacrud IDL entry",
 941             MODULENAME,
 942             osrfHashGet(meta, "methodtype"),
 943             osrfHashGet(class, "classname")
 944         );
 945
 946         char* m = buffer_release(msg);
 947         osrfAppSessionStatus( ctx->session, OSRF_STATUS_FORBIDDEN, "osrfMethodException", ctx->request, m );
 948
 949         free(m);
 950
 951         return 0;
 952     }
 953
 954     jsonObject* user = verifyUserPCRUD( ctx );
 955     if (!user) return 0;
 956
 957     int userid = atoi( oilsFMGetString( user, "id" ) );
 958     jsonObjectFree(user);
 959
 960     osrfStringArray* permission = osrfHashGet(pcrud, "permission");
 961     osrfStringArray* local_context = osrfHashGet(pcrud, "local_context");
 962     osrfHash* foreign_context = osrfHashGet(pcrud, "foreign_context");
 963
 964     osrfStringArray* context_org_array = osrfNewStringArray(1);
 965
 966     int err = 0;
 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" );
 970
 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);
 974
 975         jsonObject* _tree_top = jsonObjectGetIndex(_list, 0);
 976
 977         if (!_tree_top) {
 978             jsonObjectFree(_tmp_params);
 979             jsonObjectFree(_list);
 980
 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)" );
 985
 986             char* m = buffer_release(msg);
 987             osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, m );
 988             free(m);
 989
 990             return 0;
 991         }
 992
 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) );
 995
 996         jsonObjectFree(_tmp_params);
 997         jsonObjectFree(_list);
 998
 999     } else {
1000             osrfLogDebug( OSRF_LOG_MARK, "global-level permissions not required, fetching context org ids" );
1001             char* pkey = osrfHashGet(class, "primarykey");
1002         jsonObject *param = NULL;
1003
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 );
1008         } else {
1009             pkey_value = jsonObjectToSimpleString( obj );
1010             fetch = 1;
1011                 osrfLogDebug( OSRF_LOG_MARK, "Object not supplied, using primary key value of %s and retrieving from the database", pkey_value );
1012         }
1013
1014         if (fetch) {
1015             jsonObject* _tmp_params = jsonParseStringFmt("[{\"%s\":\"%s\"}]", pkey, pkey_value);
1016                 jsonObject* _list = doFieldmapperSearch(
1017                 ctx,
1018                 class,
1019                 _tmp_params,
1020                 &err
1021             );
1022
1023             param = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1024
1025             jsonObjectFree(_tmp_params);
1026             jsonObjectFree(_list);
1027         }
1028
1029         if (!param) {
1030             osrfLogDebug( OSRF_LOG_MARK, "Object not found in the database with primary key %s of %s", pkey, pkey_value );
1031
1032             growing_buffer* msg = buffer_init(128);
1033             buffer_fadd(
1034                 msg,
1035                 "%s: no object found with primary key %s of %s",
1036                 MODULENAME,
1037                 pkey,
1038                 pkey_value
1039             );
1040
1041             char* m = buffer_release(msg);
1042             osrfAppSessionStatus(
1043                 ctx->session,
1044                 OSRF_STATUS_INTERNALSERVERERROR,
1045                 "osrfMethodException",
1046                 ctx->request,
1047                 m
1048             );
1049
1050             free(m);
1051             if (pkey_value) free(pkey_value);
1052
1053             return 0;
1054         }
1055
1056         if (local_context->size > 0) {
1057                 osrfLogDebug( OSRF_LOG_MARK, "%d class-local context field(s) specified", local_context->size);
1058             int i = 0;
1059             char* lcontext = NULL;
1060             while ( (lcontext = osrfStringArrayGetString(local_context, i++)) ) {
1061                 osrfStringArrayAdd( context_org_array, oilsFMGetString( param, lcontext ) );
1062                     osrfLogDebug(
1063                     OSRF_LOG_MARK,
1064                     "adding class-local field %s (value: %s) to the context org list",
1065                     lcontext,
1066                     osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1067                 );
1068             }
1069         }
1070
1071         osrfStringArray* class_list;
1072
1073         if (foreign_context) {
1074             class_list = osrfHashKeys( foreign_context );
1075                 osrfLogDebug( OSRF_LOG_MARK, "%d foreign context classes(s) specified", class_list->size);
1076
1077             if (class_list->size > 0) {
1078
1079                 int i = 0;
1080                 char* class_name = NULL;
1081                 while ( (class_name = osrfStringArrayGetString(class_list, i++)) ) {
1082                     osrfHash* fcontext = osrfHashGet(foreign_context, class_name);
1083
1084                         osrfLogDebug(
1085                         OSRF_LOG_MARK,
1086                         "%d foreign context fields(s) specified for class %s",
1087                         ((osrfStringArray*)osrfHashGet(fcontext,"context"))->size,
1088                         class_name
1089                     );
1090
1091                     char* foreign_pkey = osrfHashGet(fcontext, "field");
1092                     char* foreign_pkey_value = oilsFMGetString(param, osrfHashGet(fcontext, "fkey"));
1093
1094                     jsonObject* _tmp_params = jsonParseStringFmt(
1095                         "[{\"%s\":\"%s\"}]",
1096                         foreign_pkey,
1097                         foreign_pkey_value
1098                     );
1099
1100                         jsonObject* _list = doFieldmapperSearch(
1101                         ctx,
1102                         osrfHashGet( oilsIDL(), class_name ),
1103                         _tmp_params,
1104                         &err
1105                     );
1106
1107                     jsonObject* _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1108                     jsonObjectFree(_tmp_params);
1109                     jsonObjectFree(_list);
1110
1111                     osrfStringArray* jump_list = osrfHashGet(fcontext, "jump");
1112
1113                     if (_fparam && jump_list) {
1114                         char* flink = NULL;
1115                         int k = 0;
1116                         while ( (flink = osrfStringArrayGetString(jump_list, k++)) && _fparam ) {
1117                             free(foreign_pkey_value);
1118
1119                             osrfHash* foreign_link_hash = oilsIDLFindPath( "/%s/links/%s", _fparam->classname, flink );
1120
1121                             foreign_pkey_value = oilsFMGetString(_fparam, flink);
1122                             foreign_pkey = osrfHashGet( foreign_link_hash, "key" );
1123
1124                             _tmp_params = jsonParseStringFmt(
1125                                 "[{\"%s\":\"%s\"}]",
1126                                 foreign_pkey,
1127                                 foreign_pkey_value
1128                             );
1129
1130                                 _list = doFieldmapperSearch(
1131                                 ctx,
1132                                 osrfHashGet( oilsIDL(), osrfHashGet( foreign_link_hash, "class" ) ),
1133                                 _tmp_params,
1134                                 &err
1135                             );
1136
1137                             _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1138                             jsonObjectFree(_tmp_params);
1139                             jsonObjectFree(_list);
1140                         }
1141                     }
1142
1143
1144                     if (!_fparam) {
1145
1146                         growing_buffer* msg = buffer_init(128);
1147                         buffer_fadd(
1148                             msg,
1149                             "%s: no object found with primary key %s of %s",
1150                             MODULENAME,
1151                             foreign_pkey,
1152                             foreign_pkey_value
1153                         );
1154
1155                         char* m = buffer_release(msg);
1156                         osrfAppSessionStatus(
1157                             ctx->session,
1158                             OSRF_STATUS_INTERNALSERVERERROR,
1159                             "osrfMethodException",
1160                             ctx->request,
1161                             m
1162                         );
1163
1164                         free(m);
1165                         osrfStringArrayFree(class_list);
1166                         free(foreign_pkey_value);
1167                         jsonObjectFree(param);
1168
1169                         return 0;
1170                     }
1171
1172                     free(foreign_pkey_value);
1173
1174                     int j = 0;
1175                     char* foreign_field = NULL;
1176                     while ( (foreign_field = osrfStringArrayGetString(osrfHashGet(fcontext,"context"), j++)) ) {
1177                         osrfStringArrayAdd( context_org_array, oilsFMGetString( _fparam, foreign_field ) );
1178                             osrfLogDebug(
1179                             OSRF_LOG_MARK,
1180                             "adding foreign class %s field %s (value: %s) to the context org list",
1181                             class_name,
1182                             foreign_field,
1183                             osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1184                         );
1185                     }
1186
1187                     jsonObjectFree(_fparam);
1188                 }
1189
1190                 osrfStringArrayFree(class_list);
1191             }
1192         }
1193
1194         jsonObjectFree(param);
1195     }
1196
1197     char* context_org = NULL;
1198     char* perm = NULL;
1199     int OK = 0;
1200
1201     if (permission->size == 0) {
1202             osrfLogDebug( OSRF_LOG_MARK, "No permission specified for this action, passing through" );
1203         OK = 1;
1204     }
1205
1206     int i = 0;
1207     while ( (perm = osrfStringArrayGetString(permission, i++)) ) {
1208         int j = 0;
1209         while ( (context_org = osrfStringArrayGetString(context_org_array, j++)) ) {
1210             dbi_result result;
1211
1212             if (pkey_value) {
1213                     osrfLogDebug(
1214                     OSRF_LOG_MARK,
1215                     "Checking object permission [%s] for user %d on object %s (class %s) at org %d",
1216                     perm,
1217                     userid,
1218                     pkey_value,
1219                     osrfHashGet(class, "classname"),
1220                     atoi(context_org)
1221                 );
1222
1223                 result = dbi_conn_queryf(
1224                     writehandle,
1225                     "SELECT permission.usr_has_object_perm(%d, '%s', '%s', '%s', %d) AS has_perm;",
1226                     userid,
1227                     perm,
1228                     osrfHashGet(class, "classname"),
1229                     pkey_value,
1230                     atoi(context_org)
1231                 );
1232
1233                 if (result) {
1234                     osrfLogDebug(
1235                         OSRF_LOG_MARK,
1236                         "Recieved a result for object permission [%s] for user %d on object %s (class %s) at org %d",
1237                         perm,
1238                         userid,
1239                         pkey_value,
1240                         osrfHashGet(class, "classname"),
1241                         atoi(context_org)
1242                     );
1243
1244                     if (dbi_result_first_row(result)) {
1245                         jsonObject* return_val = oilsMakeJSONFromResult( result );
1246                                                 const char* has_perm = jsonObjectGetString( jsonObjectGetKeyConst(return_val, "has_perm") );
1247
1248                             osrfLogDebug(
1249                             OSRF_LOG_MARK,
1250                             "Status of object permission [%s] for user %d on object %s (class %s) at org %d is %s",
1251                             perm,
1252                             userid,
1253                             pkey_value,
1254                             osrfHashGet(class, "classname"),
1255                             atoi(context_org),
1256                             has_perm
1257                         );
1258
1259                         if ( *has_perm == 't' ) OK = 1;
1260                         jsonObjectFree(return_val);
1261                     }
1262
1263                     dbi_result_free(result);
1264                     if (OK) break;
1265                 }
1266             }
1267
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(
1270                 writehandle,
1271                 "SELECT permission.usr_has_perm(%d, '%s', %d) AS has_perm;",
1272                 userid,
1273                 perm,
1274                 atoi(context_org)
1275             );
1276
1277                         if (result) {
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);
1287                                 }
1288
1289                                 dbi_result_free(result);
1290                                 if (OK) break;
1291                         }
1292
1293         }
1294         if (OK) break;
1295     }
1296
1297     if (pkey_value) free(pkey_value);
1298     osrfStringArrayFree(context_org_array);
1299
1300     return OK;
1301 }
1302 #endif
1303
1304
1305 static jsonObject* doCreate(osrfMethodContext* ctx, int* err ) {
1306
1307         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1308 #ifdef PCRUD
1309         jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
1310         jsonObject* options = jsonObjectGetIndex( ctx->params, 2 );
1311 #else
1312         jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
1313         jsonObject* options = jsonObjectGetIndex( ctx->params, 1 );
1314 #endif
1315
1316         if (!verifyObjectClass(ctx, target)) {
1317                 *err = -1;
1318                 return jsonNULL;
1319         }
1320
1321         osrfLogDebug( OSRF_LOG_MARK, "Object seems to be of the correct type" );
1322
1323         char* trans_id = NULL;
1324         if( ctx->session && ctx->session->userData )
1325                 trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
1326
1327         if ( !trans_id ) {
1328                 osrfLogError( OSRF_LOG_MARK, "No active transaction -- required for CREATE" );
1329
1330                 osrfAppSessionStatus(
1331                         ctx->session,
1332                         OSRF_STATUS_BADREQUEST,
1333                         "osrfMethodException",
1334                         ctx->request,
1335                         "No active transaction -- required for CREATE"
1336                 );
1337                 *err = -1;
1338                 return jsonNULL;
1339         }
1340
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(
1345                         ctx->session,
1346                         OSRF_STATUS_BADREQUEST,
1347                         "osrfMethodException",
1348                         ctx->request,
1349                         "Cannot INSERT readonly class"
1350                 );
1351                 *err = -1;
1352                 return jsonNULL;
1353         }
1354
1355         // Set the last_xact_id
1356         int index = oilsIDL_ntop( target->classname, "last_xact_id" );
1357         if (index > -1) {
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));
1360         }
1361
1362         osrfLogDebug( OSRF_LOG_MARK, "There is a transaction running..." );
1363
1364         dbhandle = writehandle;
1365
1366         osrfHash* fields = osrfHashGet(meta, "fields");
1367         char* pkey = osrfHashGet(meta, "primarykey");
1368         char* seq = osrfHashGet(meta, "sequence");
1369
1370         growing_buffer* table_buf = buffer_init(128);
1371         growing_buffer* col_buf = buffer_init(128);
1372         growing_buffer* val_buf = buffer_init(128);
1373
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 (");
1378
1379
1380         int i = 0;
1381         int first = 1;
1382         char* field_name;
1383         osrfStringArray* field_list = osrfHashKeys( fields );
1384         while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
1385
1386                 osrfHash* field = osrfHashGet( fields, field_name );
1387
1388                 if( str_is_true( osrfHashGet( field, "virtual" ) ) )
1389                         continue;
1390
1391                 const jsonObject* field_object = oilsFMGetObject( target, field_name );
1392
1393                 char* value;
1394                 if (field_object && field_object->classname) {
1395                         value = oilsFMGetString(
1396                                 field_object,
1397                                 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
1398                         );
1399                 } else {
1400                         value = jsonObjectToSimpleString( field_object );
1401                 }
1402
1403
1404                 if (first) {
1405                         first = 0;
1406                 } else {
1407                         OSRF_BUFFER_ADD_CHAR( col_buf, ',' );
1408                         OSRF_BUFFER_ADD_CHAR( val_buf, ',' );
1409                 }
1410
1411                 buffer_add(col_buf, field_name);
1412
1413                 if (!field_object || field_object->type == JSON_NULL) {
1414                         buffer_add( val_buf, "DEFAULT" );
1415
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) );
1420
1421                         } else if ( !strcmp( numtype, "INT") ) {
1422                                 buffer_fadd( val_buf, "%d", atoi(value) );
1423
1424                         } else if ( !strcmp( numtype, "NUMERIC") ) {
1425                                 buffer_fadd( val_buf, "%f", atof(value) );
1426                         }
1427                 } else {
1428                         if ( dbi_conn_quote_string(writehandle, &value) ) {
1429                                 OSRF_BUFFER_ADD( val_buf, value );
1430
1431                         } else {
1432                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
1433                                 osrfAppSessionStatus(
1434                                         ctx->session,
1435                                         OSRF_STATUS_INTERNALSERVERERROR,
1436                                         "osrfMethodException",
1437                                         ctx->request,
1438                                         "Error quoting string -- please see the error log for more details"
1439                                 );
1440                                 free(value);
1441                                 buffer_free(table_buf);
1442                                 buffer_free(col_buf);
1443                                 buffer_free(val_buf);
1444                                 *err = -1;
1445                                 return jsonNULL;
1446                         }
1447                 }
1448
1449                 free(value);
1450
1451         }
1452
1453
1454         OSRF_BUFFER_ADD_CHAR( col_buf, ')' );
1455         OSRF_BUFFER_ADD_CHAR( val_buf, ')' );
1456
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 );
1462         free(table_str);
1463         free(col_str);
1464         free(val_str);
1465
1466         char* query = buffer_release(sql);
1467
1468         osrfLogDebug(OSRF_LOG_MARK, "%s: Insert SQL [%s]", MODULENAME, query);
1469
1470
1471         dbi_result result = dbi_conn_query(writehandle, query);
1472
1473         jsonObject* obj = NULL;
1474
1475         if (!result) {
1476                 obj = jsonNewObject(NULL);
1477                 osrfLogError(
1478                         OSRF_LOG_MARK,
1479                         "%s ERROR inserting %s object using query [%s]",
1480                         MODULENAME,
1481                         osrfHashGet(meta, "fieldmapper"),
1482                         query
1483                 );
1484                 osrfAppSessionStatus(
1485                         ctx->session,
1486                         OSRF_STATUS_INTERNALSERVERERROR,
1487                         "osrfMethodException",
1488                         ctx->request,
1489                         "INSERT error -- please see the error log for more details"
1490                 );
1491                 *err = -1;
1492         } else {
1493
1494                 char* id = oilsFMGetString(target, pkey);
1495                 if (!id) {
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);
1500                 }
1501
1502                 // Find quietness specification, if present
1503                 const char* quiet_str = NULL;
1504                 if ( options ) {
1505                         const jsonObject* quiet_obj = jsonObjectGetKeyConst( options, "quiet" );
1506                         if( quiet_obj )
1507                                 quiet_str = jsonObjectGetString( quiet_obj );
1508                 }
1509
1510                 if( str_is_true( quiet_str ) ) {  // if quietness is specified
1511                         obj = jsonNewObject(id);
1512                 }
1513                 else {
1514
1515                         jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
1516                         jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH));
1517
1518                         jsonObjectSetKey(
1519                                 jsonObjectGetIndex(fake_params, 0),
1520                                 pkey,
1521                                 jsonNewObject(id)
1522                         );
1523
1524                         jsonObject* list = doFieldmapperSearch( ctx,meta, fake_params, err);
1525
1526                         if(*err) {
1527                                 jsonObjectFree( fake_params );
1528                                 obj = jsonNULL;
1529                         } else {
1530                                 obj = jsonObjectClone( jsonObjectGetIndex(list, 0) );
1531                         }
1532
1533                         jsonObjectFree( list );
1534                         jsonObjectFree( fake_params );
1535                 }
1536
1537                 free(id);
1538         }
1539
1540         free(query);
1541
1542         return obj;
1543
1544 }
1545
1546
1547 static jsonObject* doRetrieve(osrfMethodContext* ctx, int* err ) {
1548
1549     int id_pos = 0;
1550     int order_pos = 1;
1551
1552 #ifdef PCRUD
1553     id_pos = 1;
1554     order_pos = 2;
1555 #endif
1556
1557         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1558
1559         const char* id = jsonObjectGetString(jsonObjectGetIndex(ctx->params, id_pos));
1560         jsonObject* order_hash = jsonObjectGetIndex(ctx->params, order_pos);
1561
1562         osrfLogDebug(
1563                 OSRF_LOG_MARK,
1564                 "%s retrieving %s object with primary key value of %s",
1565                 MODULENAME,
1566                 osrfHashGet(meta, "fieldmapper"),
1567                 id
1568         );
1569
1570         jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
1571         jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH));
1572
1573         jsonObjectSetKey(
1574                 jsonObjectGetIndex(fake_params, 0),
1575                 osrfHashGet(meta, "primarykey"),
1576                 jsonObjectClone(jsonObjectGetIndex(ctx->params, id_pos))
1577         );
1578
1579
1580         if (order_hash) jsonObjectPush(fake_params, jsonObjectClone(order_hash) );
1581
1582         jsonObject* list = doFieldmapperSearch( ctx,meta, fake_params, err);
1583
1584         if(*err) {
1585                 jsonObjectFree( fake_params );
1586                 return jsonNULL;
1587         }
1588
1589         jsonObject* obj = jsonObjectClone( jsonObjectGetIndex(list, 0) );
1590
1591         jsonObjectFree( list );
1592         jsonObjectFree( fake_params );
1593
1594 #ifdef PCRUD
1595         if(!verifyObjectPCRUD(ctx, obj)) {
1596         jsonObjectFree(obj);
1597         *err = -1;
1598
1599         growing_buffer* msg = buffer_init(128);
1600                 OSRF_BUFFER_ADD( msg, MODULENAME );
1601                 OSRF_BUFFER_ADD( msg, ": Insufficient permissions to retrieve object" );
1602
1603         char* m = buffer_release(msg);
1604         osrfAppSessionStatus( ctx->session, OSRF_STATUS_NOTALLOWED, "osrfMethodException", ctx->request, m );
1605
1606         free(m);
1607
1608                 return jsonNULL;
1609         }
1610 #endif
1611
1612         return obj;
1613 }
1614
1615 static char* jsonNumberToDBString ( osrfHash* field, const jsonObject* value ) {
1616         growing_buffer* val_buf = buffer_init(32);
1617         const char* numtype = get_datatype( field );
1618
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 ) );
1623                 else {
1624                         //const char* val_str = jsonObjectGetString( value );
1625                         //buffer_fadd( val_buf, "%ld", atol(val_str) );
1626                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1627                 }
1628
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 ) );
1633                 else {
1634                         //const char* val_str = jsonObjectGetString( value );
1635                         //buffer_fadd( val_buf, "%f", atof(val_str) );
1636                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1637                 }
1638
1639         } else {
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 );
1644                         free(str);
1645                 } else {
1646                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, str);
1647                         free(str);
1648                         buffer_free(val_buf);
1649                         return NULL;
1650                 }
1651         }
1652
1653         return buffer_release(val_buf);
1654 }
1655
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);
1659
1660         buffer_fadd(
1661                 sql_buf,
1662                 "\"%s\".%s ",
1663                 class,
1664                 osrfHashGet(field, "name")
1665         );
1666
1667         if (!op) {
1668                 buffer_add(sql_buf, "IN (");
1669         } else if (!(strcasecmp(op,"not in"))) {
1670                 buffer_add(sql_buf, "NOT IN (");
1671         } else {
1672                 buffer_add(sql_buf, "IN (");
1673         }
1674
1675     if (node->type == JSON_HASH) {
1676         // subquery predicate
1677         char* subpred = SELECT(
1678             ctx,
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" ),
1686             SUBSELECT
1687         );
1688
1689                 if( subpred ) {
1690                         buffer_add(sql_buf, subpred);
1691                         free(subpred);
1692                 } else {
1693                         buffer_free( sql_buf );
1694                         return NULL;
1695                 }
1696
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++)) ) {
1703
1704                         if (in_item_first)
1705                                 in_item_first = 0;
1706                         else
1707                                 buffer_add(sql_buf, ", ");
1708
1709                         // Sanity check
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);
1714                                 return NULL;
1715                         }
1716
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 );
1721                                 free(val);
1722
1723                         } else if ( !strcmp( get_primitive( field ), "number") ) {
1724                                 char* val = jsonNumberToDBString( field, in_item );
1725                                 OSRF_BUFFER_ADD( sql_buf, val );
1726                                 free(val);
1727
1728                         } else {
1729                                 char* key_string = jsonObjectToSimpleString(in_item);
1730                                 if ( dbi_conn_quote_string(dbhandle, &key_string) ) {
1731                                         OSRF_BUFFER_ADD( sql_buf, key_string );
1732                                         free(key_string);
1733                                 } else {
1734                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, key_string);
1735                                         free(key_string);
1736                                         buffer_free(sql_buf);
1737                                         return NULL;
1738                                 }
1739                         }
1740                 }
1741
1742                 if( in_item_first ) {
1743                         osrfLogError(OSRF_LOG_MARK, "%s: Empty IN list", MODULENAME );
1744                         buffer_free( sql_buf );
1745                         return NULL;
1746                 }
1747         } else {
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);
1751                 return NULL;
1752         }
1753
1754         OSRF_BUFFER_ADD_CHAR( sql_buf, ')' );
1755
1756         return buffer_release(sql_buf);
1757 }
1758
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 ) {
1762
1763         if( array->size < 1 ) {
1764                 osrfLogError(OSRF_LOG_MARK, "%s: Empty array for value transform", MODULENAME);
1765                 return NULL;
1766         }
1767
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 ) );
1773                 return NULL;
1774         }
1775
1776         growing_buffer* sql_buf = buffer_init(32);
1777
1778         OSRF_BUFFER_ADD( sql_buf, jsonObjectGetString( func_item ) );
1779         OSRF_BUFFER_ADD( sql_buf, "( " );
1780
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++)) ) {
1784
1785                 // Add a separator comma, if we need one
1786                 if( func_item_index > 2 )
1787                         buffer_add( sql_buf, ", " );
1788
1789                 // Add the current parameter
1790                 if (func_item->type == JSON_NULL) {
1791                         buffer_add( sql_buf, "NULL" );
1792                 } else {
1793                         char* val = jsonObjectToSimpleString(func_item);
1794                         if ( dbi_conn_quote_string(dbhandle, &val) ) {
1795                                 OSRF_BUFFER_ADD( sql_buf, val );
1796                                 free(val);
1797                         } else {
1798                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1799                                 buffer_free(sql_buf);
1800                                 free(val);
1801                                 return NULL;
1802                         }
1803                 }
1804         }
1805
1806         buffer_add( sql_buf, " )" );
1807
1808         return buffer_release(sql_buf);
1809 }
1810
1811 static char* searchFunctionPredicate (const char* class, osrfHash* field,
1812                 const jsonObject* node, const char* op) {
1813
1814         if( ! is_good_operator( op ) ) {
1815                 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
1816                 return NULL;
1817         }
1818
1819         char* val = searchValueTransform(node);
1820         if( !val )
1821                 return NULL;
1822
1823         growing_buffer* sql_buf = buffer_init(32);
1824         buffer_fadd(
1825                 sql_buf,
1826                 "\"%s\".%s %s %s",
1827                 class,
1828                 osrfHashGet(field, "name"),
1829                 op,
1830                 val
1831         );
1832
1833         free(val);
1834
1835         return buffer_release(sql_buf);
1836 }
1837
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);
1843
1844         const char* field_transform = jsonObjectGetString( jsonObjectGetKeyConst( node, "transform" ) );
1845         const char* transform_subcolumn = jsonObjectGetString( jsonObjectGetKeyConst( node, "result_field" ) );
1846
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 );
1852                         return NULL;
1853                 }
1854                 OSRF_BUFFER_ADD_CHAR( sql_buf, '(' );    // enclose transform in parentheses
1855         }
1856
1857         if (field_transform) {
1858
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 );
1863                         return NULL;
1864                 }
1865
1866                 buffer_fadd( sql_buf, "%s(\"%s\".%s", field_transform, class, osrfHashGet(field, "name"));
1867                 const jsonObject* array = jsonObjectGetKeyConst( node, "params" );
1868
1869                 if (array) {
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 );
1875                                 return NULL;
1876                         }
1877                         int func_item_index = 0;
1878                         jsonObject* func_item;
1879                         while ( (func_item = jsonObjectGetIndex(array, func_item_index++)) ) {
1880
1881                                 char* val = jsonObjectToSimpleString(func_item);
1882
1883                                 if ( !val ) {
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 );
1888                                 } else {
1889                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1890                                         free(val);
1891                                         buffer_free(sql_buf);
1892                                         return NULL;
1893                         }
1894                                 free(val);
1895                         }
1896                 }
1897
1898                 buffer_add( sql_buf, " )" );
1899
1900         } else {
1901                 buffer_fadd( sql_buf, "\"%s\".%s", class, osrfHashGet(field, "name"));
1902         }
1903
1904         if (transform_subcolumn)
1905                 buffer_fadd( sql_buf, ").\"%s\"", transform_subcolumn );
1906
1907         return buffer_release(sql_buf);
1908 }
1909
1910 static char* searchFieldTransformPredicate (const char* class, osrfHash* field,
1911                 const jsonObject* node, const char* op ) {
1912
1913         if( ! is_good_operator( op ) ) {
1914                 osrfLogError(OSRF_LOG_MARK, "%s: Error: Invalid operator %s", MODULENAME, op);
1915                 return NULL;
1916         }
1917
1918         char* field_transform = searchFieldTransform( class, field, node );
1919         if( ! field_transform )
1920                 return NULL;
1921         char* value = NULL;
1922         int extra_parens = 0;   // boolean
1923
1924         const jsonObject* value_obj = jsonObjectGetKeyConst( node, "value" );
1925         if ( ! value_obj ) {
1926                 value = searchWHERE( node, osrfHashGet( oilsIDL(), class ), AND_OP_JOIN, NULL );
1927                 if( !value ) {
1928                         osrfLogError(OSRF_LOG_MARK, "%s: Error building condition for field transform", MODULENAME);
1929                         free(field_transform);
1930                         return NULL;
1931                 }
1932                 extra_parens = 1;
1933         } else if ( value_obj->type == JSON_ARRAY ) {
1934                 value = searchValueTransform( value_obj );
1935                 if( !value ) {
1936                         osrfLogError(OSRF_LOG_MARK, "%s: Error building value transform for field transform", MODULENAME);
1937                         free( field_transform );
1938                         return NULL;
1939                 }
1940         } else if ( value_obj->type == JSON_HASH ) {
1941                 value = searchWHERE( value_obj, osrfHashGet( oilsIDL(), class ), AND_OP_JOIN, NULL );
1942                 if( !value ) {
1943                         osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform", MODULENAME);
1944                         free(field_transform);
1945                         return NULL;
1946                 }
1947                 extra_parens = 1;
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);
1953                 return NULL;
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);
1957                 return NULL;
1958         } else {
1959                 if ( !strcmp( get_primitive( field ), "number") ) {
1960                         value = jsonNumberToDBString( field, value_obj );
1961                 } else {
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);
1965                                 free(value);
1966                                 free(field_transform);
1967                                 return NULL;
1968                         }
1969                 }
1970         }
1971
1972         const char* left_parens  = "";
1973         const char* right_parens = "";
1974
1975         if( extra_parens ) {
1976                 left_parens  = "(";
1977                 right_parens = ")";
1978         }
1979
1980         growing_buffer* sql_buf = buffer_init(32);
1981
1982         buffer_fadd(
1983                 sql_buf,
1984                 "%s%s %s %s %s %s%s",
1985                 left_parens,
1986                 field_transform,
1987                 op,
1988                 left_parens,
1989                 value,
1990                 right_parens,
1991                 right_parens
1992         );
1993
1994         free(value);
1995         free(field_transform);
1996
1997         return buffer_release(sql_buf);
1998 }
1999
2000 static char* searchSimplePredicate (const char* op, const char* class,
2001                 osrfHash* field, const jsonObject* node) {
2002
2003         if( ! is_good_operator( op ) ) {
2004                 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
2005                 return NULL;
2006         }
2007
2008         char* val = NULL;
2009
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 );
2016                 } else {
2017                         val = jsonObjectToSimpleString(node);
2018                 }
2019         }
2020
2021         if( val ) {
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 );
2026                                 free( val );
2027                                 return NULL;
2028                         }
2029                 }
2030         } else {
2031                 // Compare to a null value
2032                 val = strdup( "NULL" );
2033                 if (strcmp( op, "=" ))
2034                         op = "IS NOT";
2035                 else
2036                         op = "IS";
2037         }
2038
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 );
2042
2043         free(val);
2044
2045         return pred;
2046 }
2047
2048 static char* searchBETWEENPredicate (const char* class, osrfHash* field, const jsonObject* node) {
2049
2050         const jsonObject* x_node = jsonObjectGetIndex( node, 0 );
2051         const jsonObject* y_node = jsonObjectGetIndex( node, 1 );
2052
2053         if( NULL == y_node ) {
2054                 osrfLogError( OSRF_LOG_MARK, "%s: Not enough operands for BETWEEN operator", MODULENAME );
2055                 return NULL;
2056         }
2057         else if( NULL != jsonObjectGetIndex( node, 2 ) ) {
2058                 osrfLogError( OSRF_LOG_MARK, "%s: Too many operands for BETWEEN operator", MODULENAME );
2059                 return NULL;
2060         }
2061
2062         char* x_string;
2063         char* y_string;
2064
2065         if ( !strcmp( get_primitive( field ), "number") ) {
2066                 x_string = jsonNumberToDBString(field, x_node);
2067                 y_string = jsonNumberToDBString(field, y_node);
2068
2069         } else {
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);
2075                         free(x_string);
2076                         free(y_string);
2077                         return NULL;
2078                 }
2079         }
2080
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 );
2083         free(x_string);
2084         free(y_string);
2085
2086         return buffer_release(sql_buf);
2087 }
2088
2089 static char* searchPredicate ( const char* class, osrfHash* field,
2090                                                            jsonObject* node, osrfMethodContext* ctx ) {
2091
2092         char* pred = NULL;
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") );
2100                 } else {
2101                         jsonObject* pred_node = jsonIteratorNext( pred_itr );
2102
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 );
2115                         else
2116                                 pred = searchSimplePredicate( pred_itr->key, class, field, pred_node );
2117                 }
2118                 jsonIteratorFree(pred_itr);
2119
2120         } else if (node->type == JSON_NULL) { // IS NULL search
2121                 growing_buffer* _p = buffer_init(64);
2122                 buffer_fadd(
2123                         _p,
2124                         "\"%s\".%s IS NULL",
2125                         class,
2126                         osrfHashGet(field, "name")
2127                 );
2128                 pred = buffer_release(_p);
2129         } else { // equality search
2130                 pred = searchSimplePredicate( "=", class, field, node );
2131         }
2132
2133         return pred;
2134
2135 }
2136
2137
2138 /*
2139
2140 join : {
2141         acn : {
2142                 field : record,
2143                 fkey : id
2144                 type : left
2145                 filter_op : or
2146                 filter : { ... },
2147                 join : {
2148                         acp : {
2149                                 field : call_number,
2150                                 fkey : id,
2151                                 filter : { ... },
2152                         },
2153                 },
2154         },
2155         mrd : {
2156                 field : record,
2157                 type : inner
2158                 fkey : id,
2159                 filter : { ... },
2160         }
2161 }
2162
2163 */
2164
2165 static char* searchJOIN ( const jsonObject* join_hash, osrfHash* leftmeta ) {
2166
2167         const jsonObject* working_hash;
2168         jsonObject* freeable_hash = NULL;
2169
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;
2176         }
2177         else {
2178                 if( join_hash->type != JSON_HASH ) {
2179                         osrfLogError(
2180                                 OSRF_LOG_MARK,
2181                                 "%s: JOIN failed; expected JSON object type not found",
2182                                 MODULENAME
2183                         );
2184                         return NULL;
2185                 }
2186                 working_hash = join_hash;
2187         }
2188
2189         growing_buffer* join_buf = buffer_init(128);
2190         const char* leftclass = osrfHashGet(leftmeta, "classname");
2191
2192         jsonObject* snode = NULL;
2193         jsonIterator* search_itr = jsonNewIterator( working_hash );
2194
2195         while ( (snode = jsonIteratorNext( search_itr )) ) {
2196                 const char* class = search_itr->key;
2197                 osrfHash* idlClass = osrfHashGet( oilsIDL(), class );
2198                 if( !idlClass ) {
2199                         osrfLogError(
2200                                 OSRF_LOG_MARK,
2201                                 "%s: JOIN failed.  No class \"%s\" defined in IDL",
2202                                 MODULENAME,
2203                                 search_itr->key
2204                         );
2205                         jsonIteratorFree( search_itr );
2206                         buffer_free( join_buf );
2207                         if( freeable_hash )
2208                                 jsonObjectFree( freeable_hash );
2209                         return NULL;
2210                 }
2211
2212                 const char* fkey = jsonObjectGetString( jsonObjectGetKeyConst( snode, "fkey" ) );
2213                 const char* field = jsonObjectGetString( jsonObjectGetKeyConst( snode, "field" ) );
2214
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" );
2227                         if (!fkey) {
2228                                 osrfLogError(
2229                                         OSRF_LOG_MARK,
2230                                         "%s: JOIN failed.  No link defined from %s.%s to %s",
2231                                         MODULENAME,
2232                                         class,
2233                                         field,
2234                                         leftclass
2235                                 );
2236                                 buffer_free(join_buf);
2237                                 if(freeable_hash)
2238                                         jsonObjectFree(freeable_hash);
2239                                 jsonIteratorFree(search_itr);
2240                                 return NULL;
2241                         }
2242
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" );
2255                         if (!field) {
2256                                 osrfLogError(
2257                                         OSRF_LOG_MARK,
2258                                         "%s: JOIN failed.  No link defined from %s.%s to %s",
2259                                         MODULENAME,
2260                                         leftclass,
2261                                         fkey,
2262                                         class
2263                                 );
2264                                 buffer_free(join_buf);
2265                                 if(freeable_hash)
2266                                         jsonObjectFree(freeable_hash);
2267                                 jsonIteratorFree(search_itr);
2268                                 return NULL;
2269                         }
2270
2271                 } else if (!field && !fkey) {
2272                         osrfHash* _links = oilsIDL_links( leftclass );
2273
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 ) ) {
2281
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" );
2289                                                 break;
2290                                         }
2291                                 }
2292                         }
2293                         osrfHashIteratorFree( itr );
2294
2295                         if (!field || !fkey) {
2296                                 // Do another such search, with the classes reversed
2297                                 _links = oilsIDL_links( class );
2298
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 ) ) {
2306
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" );
2314                                                         break;
2315                                                 }
2316                                         }
2317                                 }
2318                                 osrfHashIteratorFree( itr );
2319                         }
2320
2321                         if (!field || !fkey) {
2322                                 osrfLogError(
2323                                         OSRF_LOG_MARK,
2324                                         "%s: JOIN failed.  No link defined between %s and %s",
2325                                         MODULENAME,
2326                                         leftclass,
2327                                         class
2328                                 );
2329                                 buffer_free(join_buf);
2330                                 if(freeable_hash)
2331                                         jsonObjectFree(freeable_hash);
2332                                 jsonIteratorFree(search_itr);
2333                                 return NULL;
2334                         }
2335
2336                 }
2337
2338                 const char* type = jsonObjectGetString( jsonObjectGetKeyConst( snode, "type" ) );
2339                 if (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");
2346                         } else {
2347                                 buffer_add(join_buf, " INNER JOIN");
2348                         }
2349                 } else {
2350                         buffer_add(join_buf, " INNER JOIN");
2351                 }
2352
2353                 char* table = getSourceDefinition(idlClass);
2354                 if( !table ) {
2355                         jsonIteratorFree( search_itr );
2356                         buffer_free( join_buf );
2357                         if( freeable_hash )
2358                                 jsonObjectFree( freeable_hash );
2359                         return NULL;
2360                 }
2361
2362                 buffer_fadd(join_buf, " %s AS \"%s\" ON ( \"%s\".%s = \"%s\".%s",
2363                                         table, class, class, field, leftclass, fkey);
2364                 free(table);
2365
2366                 const jsonObject* filter = jsonObjectGetKeyConst( snode, "filter" );
2367                 if (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 " );
2371                         } else {
2372                                 buffer_add( join_buf, " AND " );
2373                         }
2374
2375                         char* jpred = searchWHERE( filter, idlClass, AND_OP_JOIN, NULL );
2376                         if( jpred ) {
2377                                 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2378                                 OSRF_BUFFER_ADD( join_buf, jpred );
2379                                 free(jpred);
2380                         } else {
2381                                 osrfLogError(
2382                                         OSRF_LOG_MARK,
2383                                         "%s: JOIN failed.  Invalid conditional expression.",
2384                                         MODULENAME
2385                                 );
2386                                 jsonIteratorFree( search_itr );
2387                                 buffer_free( join_buf );
2388                                 if( freeable_hash )
2389                                         jsonObjectFree( freeable_hash );
2390                                 return NULL;
2391                         }
2392                 }
2393
2394                 buffer_add(join_buf, " ) ");
2395
2396                 const jsonObject* join_filter = jsonObjectGetKeyConst( snode, "join" );
2397                 if (join_filter) {
2398                         char* jpred = searchJOIN( join_filter, idlClass );
2399                         OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2400                         OSRF_BUFFER_ADD( join_buf, jpred );
2401                         free(jpred);
2402                 }
2403         }
2404
2405         if(freeable_hash)
2406                 jsonObjectFree(freeable_hash);
2407         jsonIteratorFree(search_itr);
2408
2409         return buffer_release(join_buf);
2410 }
2411
2412 /*
2413
2414 { +class : { -or|-and : { field : { op : value }, ... } ... }, ... }
2415 { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }
2416 [ { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }, ... ]
2417
2418 Generate code to express a set of conditions, as for a WHERE clause.  Parameters:
2419
2420 search_hash is the JSON expression of the conditions.
2421 meta is the class definition from the IDL, for the relevant table.
2422 opjoin_type indicates whether multiple conditions, if present, should be
2423         connected by AND or OR.
2424 osrfMethodContext is loaded with all sorts of stuff, but all we do with it here is
2425         to pass it to other functions -- and all they do with it is to use the session
2426         and request members to send error messages back to the client.
2427
2428 */
2429
2430 static char* searchWHERE ( const jsonObject* search_hash, osrfHash* meta, int opjoin_type, osrfMethodContext* ctx ) {
2431
2432         osrfLogDebug(
2433         OSRF_LOG_MARK,
2434         "%s: Entering searchWHERE; search_hash addr = %p, meta addr = %p, opjoin_type = %d, ctx addr = %p",
2435         MODULENAME,
2436         search_hash,
2437         meta,
2438         opjoin_type,
2439         ctx
2440     );
2441
2442         growing_buffer* sql_buf = buffer_init(128);
2443
2444         jsonObject* node = NULL;
2445
2446         int first = 1;
2447         if ( search_hash->type == JSON_ARRAY ) {
2448                 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_ARRAY", MODULENAME);
2449                 jsonIterator* search_itr = jsonNewIterator( search_hash );
2450                 if( !jsonIteratorHasNext( search_itr ) ) {
2451                         osrfLogError(
2452                                 OSRF_LOG_MARK,
2453                                 "%s: Invalid predicate structure: empty JSON array",
2454                                 MODULENAME
2455                         );
2456                         jsonIteratorFree( search_itr );
2457                         buffer_free( sql_buf );
2458                         return NULL;
2459                 }
2460
2461                 while ( (node = jsonIteratorNext( search_itr )) ) {
2462             if (first) {
2463                 first = 0;
2464             } else {
2465                 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2466                 else buffer_add(sql_buf, " AND ");
2467             }
2468
2469             char* subpred = searchWHERE( node, meta, opjoin_type, ctx );
2470                         if( subpred ) {
2471                 buffer_fadd(sql_buf, "( %s )", subpred);
2472                 free(subpred);
2473                         } else {
2474                                 jsonIteratorFree( search_itr );
2475                                 buffer_free( sql_buf );
2476                                 return NULL;
2477                         }
2478         }
2479         jsonIteratorFree(search_itr);
2480
2481         } else if ( search_hash->type == JSON_HASH ) {
2482                 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_HASH", MODULENAME);
2483                 jsonIterator* search_itr = jsonNewIterator( search_hash );
2484                 if( !jsonIteratorHasNext( search_itr ) ) {
2485                         osrfLogError(
2486                                 OSRF_LOG_MARK,
2487                                 "%s: Invalid predicate structure: empty JSON object",
2488                                 MODULENAME
2489                         );
2490                         jsonIteratorFree( search_itr );
2491                         buffer_free( sql_buf );
2492                         return NULL;
2493                 }
2494
2495                 while ( (node = jsonIteratorNext( search_itr )) ) {
2496
2497             if (first) {
2498                 first = 0;
2499             } else {
2500                 if (opjoin_type == OR_OP_JOIN) buffer_add(sql_buf, " OR ");
2501                 else buffer_add(sql_buf, " AND ");
2502             }
2503
2504                         if ( '+' == search_itr->key[ 0 ] ) {
2505                                 if ( node->type == JSON_STRING ) {
2506                                         // Intended purpose; to allow reference to a Boolean column
2507
2508                                         // Verify that the class alias is not empty
2509                                         if( '\0' == search_itr->key[ 1 ] ) {
2510                                                 osrfLogError(
2511                                                         OSRF_LOG_MARK,
2512                                                         "%s: Table alias is empty",
2513                                                         MODULENAME
2514                                                 );
2515                                                 jsonIteratorFree( search_itr );
2516                                                 buffer_free( sql_buf );
2517                                                 return NULL;
2518                                         }
2519
2520                                         // Verify that the string looks like an identifier.
2521                                         const char* subpred = jsonObjectGetString( node );
2522                                         if( ! is_identifier( subpred ) ) {
2523                                                 osrfLogError(
2524                                                          OSRF_LOG_MARK,
2525                                                         "%s: Invalid boolean identifier in WHERE clause: \"%s\"",
2526                                                         MODULENAME,
2527                                                         subpred
2528                                                 );
2529                                                 jsonIteratorFree( search_itr );
2530                                                 buffer_free( sql_buf );
2531                                                 return NULL;
2532                                         }
2533
2534                                         buffer_fadd(sql_buf, " \"%s\".%s ", search_itr->key + 1, subpred);
2535                                 } else {
2536                                         char* subpred = searchWHERE( node, osrfHashGet( oilsIDL(), search_itr->key + 1 ), AND_OP_JOIN, ctx );
2537                                         if( subpred ) {
2538                                                 buffer_fadd(sql_buf, "( %s )", subpred);
2539                                                 free(subpred);
2540                                         } else {
2541                                                 jsonIteratorFree( search_itr );
2542                                                 buffer_free( sql_buf );
2543                                                 return NULL;
2544                                         }
2545                                 }
2546                         } else if ( !strcasecmp("-or",search_itr->key) ) {
2547                                 char* subpred = searchWHERE( node, meta, OR_OP_JOIN, ctx );
2548                                 if( subpred ) {
2549                                         buffer_fadd(sql_buf, "( %s )", subpred);
2550                                         free( subpred );
2551                                 } else {
2552                                         buffer_free( sql_buf );
2553                                         return NULL;
2554                                 }
2555                         } else if ( !strcasecmp("-and",search_itr->key) ) {
2556                                 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2557                                 if( subpred ) {
2558                                         buffer_fadd(sql_buf, "( %s )", subpred);
2559                                         free( subpred );
2560                                 } else {
2561                                         buffer_free( sql_buf );
2562                                         return NULL;
2563                                 }
2564                         } else if ( !strcasecmp("-not",search_itr->key) ) {
2565                                 char* subpred = searchWHERE( node, meta, AND_OP_JOIN, ctx );
2566                                 if( subpred ) {
2567                                         buffer_fadd(sql_buf, " NOT ( %s )", subpred);
2568                                         free( subpred );
2569                                 } else {
2570                                         buffer_free( sql_buf );
2571                                         return NULL;
2572                                 }
2573                         } else if ( !strcasecmp("-exists",search_itr->key) ) {
2574                 char* subpred = SELECT(
2575                     ctx,
2576                     jsonObjectGetKey( node, "select" ),
2577                     jsonObjectGetKey( node, "from" ),
2578                     jsonObjectGetKey( node, "where" ),
2579                     jsonObjectGetKey( node, "having" ),
2580                     jsonObjectGetKey( node, "order_by" ),
2581                     jsonObjectGetKey( node, "limit" ),
2582                     jsonObjectGetKey( node, "offset" ),
2583                     SUBSELECT
2584                 );
2585
2586                                 if( subpred ) {
2587                                         buffer_fadd(sql_buf, "EXISTS ( %s )", subpred);
2588                                         free(subpred);
2589                                 } else {
2590                                         buffer_free( sql_buf );
2591                                         return NULL;
2592                                 }
2593             } else if ( !strcasecmp("-not-exists",search_itr->key) ) {
2594                 char* subpred = SELECT(
2595                     ctx,
2596                     jsonObjectGetKey( node, "select" ),
2597                     jsonObjectGetKey( node, "from" ),
2598                     jsonObjectGetKey( node, "where" ),
2599                     jsonObjectGetKey( node, "having" ),
2600                     jsonObjectGetKey( node, "order_by" ),
2601                     jsonObjectGetKey( node, "limit" ),
2602                     jsonObjectGetKey( node, "offset" ),
2603                     SUBSELECT
2604                 );
2605
2606                                 if( subpred ) {
2607                                         buffer_fadd(sql_buf, "NOT EXISTS ( %s )", subpred);
2608                                         free(subpred);
2609                                 } else {
2610                                         buffer_free( sql_buf );
2611                                         return NULL;
2612                                 }
2613
2614             } else {
2615
2616                 char* class = osrfHashGet(meta, "classname");
2617                 osrfHash* fields = osrfHashGet(meta, "fields");
2618                 osrfHash* field = osrfHashGet( fields, search_itr->key );
2619
2620
2621                 if (!field) {
2622                     char* table = getSourceDefinition(meta);
2623                                         if( !table )
2624                                                 table = strdup( "(?)" );
2625                     osrfLogError(
2626                         OSRF_LOG_MARK,
2627                         "%s: Attempt to reference non-existent column \"%s\" on %s (%s)",
2628                         MODULENAME,
2629                         search_itr->key,
2630                         table,
2631                         class ? class : "?"
2632                     );
2633                     buffer_free(sql_buf);
2634                     free(table);
2635                                         jsonIteratorFree(search_itr);
2636                                         return NULL;
2637                                 }
2638
2639                                 char* subpred = searchPredicate( class, field, node, ctx );
2640                                 if( subpred ) {
2641                                         buffer_add( sql_buf, subpred );
2642                                         free(subpred);
2643                                 } else {
2644                                         buffer_free(sql_buf);
2645                                         jsonIteratorFree(search_itr);
2646                                         return NULL;
2647                                 }
2648                         }
2649                 }
2650                 jsonIteratorFree(search_itr);
2651
2652     } else {
2653         // ERROR ... only hash and array allowed at this level
2654         char* predicate_string = jsonObjectToJSON( search_hash );
2655         osrfLogError(
2656             OSRF_LOG_MARK,
2657             "%s: Invalid predicate structure: %s",
2658             MODULENAME,
2659             predicate_string
2660         );
2661         buffer_free(sql_buf);
2662         free(predicate_string);
2663         return NULL;
2664     }
2665
2666         return buffer_release(sql_buf);
2667 }
2668
2669 char* SELECT (
2670                 /* method context */ osrfMethodContext* ctx,
2671
2672                 /* SELECT   */ jsonObject* selhash,
2673                 /* FROM     */ jsonObject* join_hash,
2674                 /* WHERE    */ jsonObject* search_hash,
2675                 /* HAVING   */ jsonObject* having_hash,
2676                 /* ORDER BY */ jsonObject* order_hash,
2677                 /* LIMIT    */ jsonObject* limit,
2678                 /* OFFSET   */ jsonObject* offset,
2679                 /* flags    */ int flags
2680 ) {
2681         const char* locale = osrf_message_get_last_locale();
2682
2683         // in case we don't get a select list
2684         jsonObject* defaultselhash = NULL;
2685
2686         // general tmp objects
2687         const jsonObject* tmp_const;
2688         jsonObject* selclass = NULL;
2689         jsonObject* selfield = NULL;
2690         jsonObject* snode = NULL;
2691         jsonObject* onode = NULL;
2692
2693         char* string = NULL;
2694         int from_function = 0;
2695         int first = 1;
2696         int gfirst = 1;
2697         //int hfirst = 1;
2698
2699         // the core search class
2700         char* core_class = NULL;
2701
2702         // metadata about the core search class
2703         osrfHash* core_meta = NULL;
2704
2705         osrfLogDebug(OSRF_LOG_MARK, "cstore SELECT locale: %s", locale);
2706
2707         // punt if there's no core class
2708         if (!join_hash || ( join_hash->type == JSON_HASH && !join_hash->size )) {
2709                 osrfLogError(
2710                         OSRF_LOG_MARK,
2711                         "%s: FROM clause is missing or empty",
2712                         MODULENAME
2713                 );
2714                 if( ctx )
2715                         osrfAppSessionStatus(
2716                                 ctx->session,
2717                                 OSRF_STATUS_INTERNALSERVERERROR,
2718                                 "osrfMethodException",
2719                                 ctx->request,
2720                                 "FROM clause is missing or empty in JSON query"
2721                         );
2722                 return NULL;
2723         }
2724
2725         // get the core class -- the only key of the top level FROM clause, or a string
2726         if (join_hash->type == JSON_HASH) {
2727                 jsonIterator* tmp_itr = jsonNewIterator( join_hash );
2728                 snode = jsonIteratorNext( tmp_itr );
2729
2730                 core_class = strdup( tmp_itr->key );
2731                 join_hash = snode;
2732
2733                 jsonObject* extra = jsonIteratorNext( tmp_itr );
2734
2735                 jsonIteratorFree( tmp_itr );
2736                 snode = NULL;
2737
2738                 // There shouldn't be more than one entry in join_hash
2739                 if( extra ) {
2740                         osrfLogError(
2741                                 OSRF_LOG_MARK,
2742                                 "%s: Malformed FROM clause: extra entry in JSON_HASH",
2743                                 MODULENAME
2744                         );
2745                         if( ctx )
2746                                 osrfAppSessionStatus(
2747                                         ctx->session,
2748                                         OSRF_STATUS_INTERNALSERVERERROR,
2749                                         "osrfMethodException",
2750                                         ctx->request,
2751                                         "Malformed FROM clause in JSON query"
2752                                 );
2753                         free( core_class );
2754                         return NULL;    // Malformed join_hash; extra entry
2755                 }
2756         } else if (join_hash->type == JSON_ARRAY) {
2757                 from_function = 1;
2758                 core_class = jsonObjectToSimpleString( jsonObjectGetIndex(join_hash, 0) );
2759                 selhash = NULL;
2760
2761         } else if (join_hash->type == JSON_STRING) {
2762                 core_class = jsonObjectToSimpleString( join_hash );
2763                 join_hash = NULL;
2764         }
2765         else {
2766                 osrfLogError(
2767                         OSRF_LOG_MARK,
2768                         "%s: FROM clause is unexpected JSON type: %s",
2769                         MODULENAME,
2770                         json_type( join_hash->type )
2771                 );
2772                 if( ctx )
2773                         osrfAppSessionStatus(
2774                                 ctx->session,
2775                                 OSRF_STATUS_INTERNALSERVERERROR,
2776                                 "osrfMethodException",
2777                                 ctx->request,
2778                                 "Ill-formed FROM clause in JSON query"
2779                         );
2780                 free( core_class );
2781                 return NULL;
2782         }
2783
2784         if (!from_function) {
2785                 // Get the IDL class definition for the core class
2786                 core_meta = osrfHashGet( oilsIDL(), core_class );
2787                 if( !core_meta ) {    // Didn't find it?
2788                         osrfLogError(
2789                                 OSRF_LOG_MARK,
2790                                 "%s: SELECT clause references undefined class: \"%s\"",
2791                                 MODULENAME,
2792                                 core_class
2793                         );
2794                         if( ctx )
2795                                 osrfAppSessionStatus(
2796                                         ctx->session,
2797                                         OSRF_STATUS_INTERNALSERVERERROR,
2798                                         "osrfMethodException",
2799                                         ctx->request,
2800                                         "SELECT clause references undefined class in JSON query"
2801                                 );
2802                         free( core_class );
2803                         return NULL;
2804                 }
2805
2806                 // Make sure the class isn't virtual
2807                 if( str_is_true( osrfHashGet( core_meta, "virtual" ) ) ) {
2808                         osrfLogError(
2809                                 OSRF_LOG_MARK,
2810                                 "%s: Core class is virtual: \"%s\"",
2811                                 MODULENAME,
2812                                 core_class
2813                         );
2814                         if( ctx )
2815                                 osrfAppSessionStatus(
2816                                         ctx->session,
2817                                         OSRF_STATUS_INTERNALSERVERERROR,
2818                                         "osrfMethodException",
2819                                         ctx->request,
2820                                         "FROM clause references virtual class in JSON query"
2821                                 );
2822                         free( core_class );
2823                         return NULL;
2824                 }
2825         }
2826
2827         // if the select list is empty, or the core class field list is '*',
2828         // build the default select list ...
2829         if (!selhash) {
2830                 selhash = defaultselhash = jsonNewObjectType(JSON_HASH);
2831                 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2832         } else if( selhash->type != JSON_HASH ) {
2833                 osrfLogError(
2834                         OSRF_LOG_MARK,
2835                         "%s: Expected JSON_HASH for SELECT clause; found %s",
2836                         MODULENAME,
2837                         json_type( selhash->type )
2838                 );
2839
2840                 if (ctx)
2841                         osrfAppSessionStatus(
2842                                 ctx->session,
2843                                 OSRF_STATUS_INTERNALSERVERERROR,
2844                                 "osrfMethodException",
2845                                 ctx->request,
2846                                 "Malformed SELECT clause in JSON query"
2847                         );
2848                 free( core_class );
2849                 return NULL;
2850         } else if ( (tmp_const = jsonObjectGetKeyConst( selhash, core_class )) && tmp_const->type == JSON_STRING ) {
2851                 const char* _x = jsonObjectGetString( tmp_const );
2852                 if (!strncmp( "*", _x, 1 )) {
2853                         jsonObjectRemoveKey( selhash, core_class );
2854                         jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2855                 }
2856         }
2857
2858         // the query buffer
2859         growing_buffer* sql_buf = buffer_init(128);
2860
2861         // temp buffers for the SELECT list and GROUP BY clause
2862         growing_buffer* select_buf = buffer_init(128);
2863         growing_buffer* group_buf = buffer_init(128);
2864
2865         int aggregate_found = 0;     // boolean
2866
2867         // Build a select list
2868         if(from_function)   // From a function we select everything
2869                 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
2870         else {
2871
2872                 // If we need to build a default list, prepare to do so
2873                 jsonObject* _tmp = jsonObjectGetKey( selhash, core_class );
2874                 if ( _tmp && !_tmp->size ) {
2875
2876                         osrfHash* core_fields = osrfHashGet( core_meta, "fields" );
2877
2878                         osrfHashIterator* field_itr = osrfNewHashIterator( core_fields );
2879                         osrfHash* field_def;
2880                         while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
2881                                 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
2882                                         // This field is not virtual, so add it to the list
2883                                         jsonObjectPush( _tmp, jsonNewObject( osrfHashIteratorKey( field_itr ) ) );
2884                                 }
2885                         }
2886                         osrfHashIteratorFree( field_itr );
2887                 }
2888
2889                 // Now build the actual select list
2890             int sel_pos = 1;
2891             first = 1;
2892             gfirst = 1;
2893             jsonIterator* selclass_itr = jsonNewIterator( selhash );
2894             while ( (selclass = jsonIteratorNext( selclass_itr )) ) {    // For each class
2895
2896                     // Make sure the class is defined in the IDL
2897                         const char* cname = selclass_itr->key;
2898                         osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
2899                     if (!idlClass) {
2900                                 osrfLogError(
2901                                         OSRF_LOG_MARK,
2902                                         "%s: Selected class \"%s\" not defined in IDL",
2903                                         MODULENAME,
2904                                         cname
2905                                 );
2906
2907                                 if (ctx)
2908                                         osrfAppSessionStatus(
2909                                                 ctx->session,
2910                                                 OSRF_STATUS_INTERNALSERVERERROR,
2911                                                 "osrfMethodException",
2912                                                 ctx->request,
2913                                                 "Selected class is not defined"
2914                                         );
2915                                 jsonIteratorFree( selclass_itr );
2916                                 buffer_free( sql_buf );
2917                                 buffer_free( select_buf );
2918                                 buffer_free( group_buf );
2919                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
2920                                 free( core_class );
2921                                 return NULL;
2922                         }
2923
2924                     // Make sure the target relation is in the join tree.
2925
2926                         // At this point join_hash is a step down from the join_hash we
2927                         // received as a parameter.  If the original was a JSON_STRING,
2928                         // then json_hash is now NULL.  If the original was a JSON_HASH,
2929                         // then json_hash is now the first (and only) entry in it,
2930                         // denoting the core class.  We've already excluded the
2931                         // possibility that the original was a JSON_ARRAY, because in
2932                         // that case from_function would be non-NULL, and we wouldn't
2933                         // be here.
2934
2935                         int class_in_from_clause;    // boolean
2936
2937                     if ( ! strcmp( core_class, cname ))
2938                                 // This is the core class -- no problem
2939                                 class_in_from_clause = 1;
2940                         else {
2941                                 if (!join_hash)
2942                                         // There's only one class in the FROM clause, and this isn't it
2943                                         class_in_from_clause = 0;
2944                                 else if (join_hash->type == JSON_STRING) {
2945                                         // There's only one class in the FROM clause
2946                                         const char* str = jsonObjectGetString(join_hash);
2947                                         if ( strcmp( str, cname ) )
2948                                                 class_in_from_clause = 0;    // This isn't it
2949                                         else
2950                                                 class_in_from_clause = 1;    // This is it
2951                                 } else {
2952                                         jsonObject* found = jsonObjectFindPath(join_hash, "//%s", cname);
2953                                         if ( 0 == found->size )
2954                                                 class_in_from_clause = 0;   // Nowhere in the join tree
2955                                         else
2956                                                 class_in_from_clause = 1;   // Found it
2957                                         jsonObjectFree( found );
2958                                 }
2959                         }
2960
2961                         // If the class isn't in the FROM clause, bail out
2962                         if( ! class_in_from_clause ) {
2963                                 osrfLogError(
2964                                         OSRF_LOG_MARK,
2965                                         "%s: SELECT clause references class not in FROM clause: \"%s\"",
2966                                         MODULENAME,
2967                                         cname
2968                                 );
2969                                 if( ctx )
2970                                         osrfAppSessionStatus(
2971                                                 ctx->session,
2972                                                 OSRF_STATUS_INTERNALSERVERERROR,
2973                                                 "osrfMethodException",
2974                                                 ctx->request,
2975                                                 "Selected class not in FROM clause in JSON query"
2976                                         );
2977                                 jsonIteratorFree( selclass_itr );
2978                                 buffer_free( sql_buf );
2979                                 buffer_free( select_buf );
2980                                 buffer_free( group_buf );
2981                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
2982                                 free( core_class );
2983                                 return NULL;
2984                         }
2985
2986                         // Look up some attributes of the current class, so that we
2987                         // don't have to look them up again for each field
2988                         osrfHash* class_field_set = osrfHashGet( idlClass, "fields" );
2989                         const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
2990                         const char* class_tname = osrfHashGet( idlClass, "tablename" );
2991
2992                     // stitch together the column list ...
2993                     jsonIterator* select_itr = jsonNewIterator( selclass );
2994                     while ( (selfield = jsonIteratorNext( select_itr )) ) {   // for each SELECT column
2995
2996                                 // If we need a separator comma, add one
2997                                 if (first) {
2998                                         first = 0;
2999                                 } else {
3000                                         OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3001                                 }
3002
3003                                 // ... if it's a string, just toss it on the pile
3004                                 if (selfield->type == JSON_STRING) {
3005
3006                                         // Look up the field in the IDL
3007                                         const char* col_name = jsonObjectGetString( selfield );
3008                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3009                                         if ( !field_def ) {
3010                                                 // No such field in current class
3011                                                 osrfLogError(
3012                                                         OSRF_LOG_MARK,
3013                                                         "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3014                                                         MODULENAME,
3015                                                         col_name,
3016                                                         cname
3017                                                 );
3018                                                 if( ctx )
3019                                                         osrfAppSessionStatus(
3020                                                                 ctx->session,
3021                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3022                                                                 "osrfMethodException",
3023                                                                 ctx->request,
3024                                                                 "Selected column not defined in JSON query"
3025                                                         );
3026                                                 jsonIteratorFree( select_itr );
3027                                                 jsonIteratorFree( selclass_itr );
3028                                                 buffer_free( sql_buf );
3029                                                 buffer_free( select_buf );
3030                                                 buffer_free( group_buf );
3031                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3032                                                 free( core_class );
3033                                                 return NULL;
3034                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3035                                                 // Virtual field not allowed
3036                                                 osrfLogError(
3037                                                         OSRF_LOG_MARK,
3038                                                         "%s: Selected column \"%s\" for class \"%s\" is virtual",
3039                                                         MODULENAME,
3040                                                         col_name,
3041                                                         cname
3042                                                 );
3043                                                 if( ctx )
3044                                                         osrfAppSessionStatus(
3045                                                                 ctx->session,
3046                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3047                                                                 "osrfMethodException",
3048                                                                 ctx->request,
3049                                                                 "Selected column may not be virtual in JSON query"
3050                                                         );
3051                                                 jsonIteratorFree( select_itr );
3052                                                 jsonIteratorFree( selclass_itr );
3053                                                 buffer_free( sql_buf );
3054                                                 buffer_free( select_buf );
3055                                                 buffer_free( group_buf );
3056                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3057                                                 free( core_class );
3058                                                 return NULL;
3059                                         }
3060
3061                                         if (locale) {
3062                                                 const char* i18n;
3063                                                 if (flags & DISABLE_I18N)
3064                                                         i18n = NULL;
3065                                                 else
3066                                                         i18n = osrfHashGet(field_def, "i18n");
3067
3068                                                 if( str_is_true( i18n ) ) {
3069                             buffer_fadd( select_buf,
3070                                                                 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3071                                                                 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3072                         } else {
3073                                             buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3074                         }
3075                     } else {
3076                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3077                     }
3078
3079                                 // ... but it could be an object, in which case we check for a Field Transform
3080                                 } else if (selfield->type == JSON_HASH) {
3081
3082                                         const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3083
3084                                         // Get the field definition from the IDL
3085                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3086                                         if ( !field_def ) {
3087                                                 // No such field in current class
3088                                                 osrfLogError(
3089                                                         OSRF_LOG_MARK,
3090                                                         "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3091                                                         MODULENAME,
3092                                                         col_name,
3093                                                         cname
3094                                                 );
3095                                                 if( ctx )
3096                                                         osrfAppSessionStatus(
3097                                                                 ctx->session,
3098                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3099                                                                 "osrfMethodException",
3100                                                                 ctx->request,
3101                                                                 "Selected column is not defined in JSON query"
3102                                                         );
3103                                                 jsonIteratorFree( select_itr );
3104                                                 jsonIteratorFree( selclass_itr );
3105                                                 buffer_free( sql_buf );
3106                                                 buffer_free( select_buf );
3107                                                 buffer_free( group_buf );
3108                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3109                                                 free( core_class );
3110                                                 return NULL;
3111                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3112                                                 // No such field in current class
3113                                                 osrfLogError(
3114                                                         OSRF_LOG_MARK,
3115                                                         "%s: Selected column \"%s\" is virtual for class \"%s\"",
3116                                                         MODULENAME,
3117                                                         col_name,
3118                                                         cname
3119                                                 );
3120                                                 if( ctx )
3121                                                         osrfAppSessionStatus(
3122                                                                 ctx->session,
3123                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3124                                                                 "osrfMethodException",
3125                                                                 ctx->request,
3126                                                                 "Selected column is virtual in JSON query"
3127                                                         );
3128                                                 jsonIteratorFree( select_itr );
3129                                                 jsonIteratorFree( selclass_itr );
3130                                                 buffer_free( sql_buf );
3131                                                 buffer_free( select_buf );
3132                                                 buffer_free( group_buf );
3133                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3134                                                 free( core_class );
3135                                                 return NULL;
3136                                         }
3137
3138                                         // Decide what to use as a column alias
3139                                         const char* _alias;
3140                                         if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3141                                                 _alias = jsonObjectGetString( tmp_const );
3142                                         } else {         // Use field name as the alias
3143                                                 _alias = col_name;
3144                                         }
3145
3146                                         if (jsonObjectGetKeyConst( selfield, "transform" )) {
3147                                                 char* transform_str = searchFieldTransform(cname, field_def, selfield);
3148                                                 if( transform_str ) {
3149                                                         buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3150                                                         free(transform_str);
3151                                                 } else {
3152                                                         if( ctx )
3153                                                                 osrfAppSessionStatus(
3154                                                                         ctx->session,
3155                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3156                                                                         "osrfMethodException",
3157                                                                         ctx->request,
3158                                                                         "Unable to generate transform function in JSON query"
3159                                                                 );
3160                                                         jsonIteratorFree( select_itr );
3161                                                         jsonIteratorFree( selclass_itr );
3162                                                         buffer_free( sql_buf );
3163                                                         buffer_free( select_buf );
3164                                                         buffer_free( group_buf );
3165                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3166                                                         free( core_class );
3167                                                         return NULL;
3168                                                 }
3169                                         } else {
3170
3171                                                 if (locale) {
3172                                                         const char* i18n;
3173                                                         if (flags & DISABLE_I18N)
3174                                                                 i18n = NULL;
3175                                                         else
3176                                                                 i18n = osrfHashGet(field_def, "i18n");
3177
3178                                                         if( str_is_true( i18n ) ) {
3179                                                                 buffer_fadd( select_buf,
3180                                                                         " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3181                                                                         class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3182                                                         } else {
3183                                                                 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3184                                                         }
3185                                                 } else {
3186                                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3187                                                 }
3188                                         }
3189                                 }
3190                                 else {
3191                                         osrfLogError(
3192                                                 OSRF_LOG_MARK,
3193                                                 "%s: Selected item is unexpected JSON type: %s",
3194                                                 MODULENAME,
3195                                                 json_type( selfield->type )
3196                                         );
3197                                         if( ctx )
3198                                                 osrfAppSessionStatus(
3199                                                         ctx->session,
3200                                                         OSRF_STATUS_INTERNALSERVERERROR,
3201                                                         "osrfMethodException",
3202                                                         ctx->request,
3203                                                         "Ill-formed SELECT item in JSON query"
3204                                                 );
3205                                         jsonIteratorFree( select_itr );
3206                                         jsonIteratorFree( selclass_itr );
3207                                         buffer_free( sql_buf );
3208                                         buffer_free( select_buf );
3209                                         buffer_free( group_buf );
3210                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3211                                         free( core_class );
3212                                         return NULL;
3213                                 }
3214
3215                                 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3216                                 if( obj_is_true( agg_obj ) )
3217                                         aggregate_found = 1;
3218                                 else {
3219                                         // Append a comma (except for the first one)
3220                                         // and add the column to a GROUP BY clause
3221                                         if (gfirst)
3222                                                 gfirst = 0;
3223                                         else
3224                                                 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3225
3226                                         buffer_fadd(group_buf, " %d", sel_pos);
3227                                 }
3228
3229 #if 0
3230                             if (is_agg->size || (flags & SELECT_DISTINCT)) {
3231
3232                                         const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3233                                     if ( ! obj_is_true( aggregate_obj ) ) {
3234                                             if (gfirst) {
3235                                                     gfirst = 0;
3236                                             } else {
3237                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3238                                             }
3239
3240                                             buffer_fadd(group_buf, " %d", sel_pos);
3241
3242                                         /*
3243                                     } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3244                                             if (gfirst) {
3245                                                     gfirst = 0;
3246                                             } else {
3247                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3248                                             }
3249
3250                                             _column = searchFieldTransform(cname, field, selfield);
3251                                                 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3252                                                 OSRF_BUFFER_ADD(group_buf, _column);
3253                                             _column = searchFieldTransform(cname, field, selfield);
3254                                         */
3255                                     }
3256                             }
3257 #endif
3258
3259                             sel_pos++;
3260                     } // end while -- iterating across SELECT columns
3261
3262             jsonIteratorFree(select_itr);
3263             } // end while -- iterating across classes
3264
3265         jsonIteratorFree(selclass_itr);
3266     }
3267
3268
3269         char* col_list = buffer_release(select_buf);
3270         char* table = NULL;
3271         if (from_function) table = searchValueTransform(join_hash);
3272         else table = getSourceDefinition(core_meta);
3273
3274         if( !table ) {
3275                 if (ctx)
3276                         osrfAppSessionStatus(
3277                                 ctx->session,
3278                                 OSRF_STATUS_INTERNALSERVERERROR,
3279                                 "osrfMethodException",
3280                                 ctx->request,
3281                                 "Unable to identify table for core class"
3282                         );
3283                 free( col_list );
3284                 buffer_free( sql_buf );
3285                 buffer_free( group_buf );
3286                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3287                 free( core_class );
3288                 return NULL;
3289         }
3290
3291         // Put it all together
3292         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3293         free(col_list);
3294         free(table);
3295
3296         char* order_by_list = NULL;
3297         growing_buffer* having_buf = buffer_init(128);
3298
3299         if (!from_function) {
3300
3301                 // Now, walk the join tree and add that clause
3302                 if ( join_hash ) {
3303                         char* join_clause = searchJOIN( join_hash, core_meta );
3304                         if( join_clause ) {
3305                                 buffer_add(sql_buf, join_clause);
3306                                 free(join_clause);
3307                         } else {
3308                                 if (ctx)
3309                                         osrfAppSessionStatus(
3310                                                 ctx->session,
3311                                                 OSRF_STATUS_INTERNALSERVERERROR,
3312                                                 "osrfMethodException",
3313                                                 ctx->request,
3314                                                 "Unable to construct JOIN clause(s)"
3315                                         );
3316                                 buffer_free( sql_buf );
3317                                 buffer_free( group_buf );
3318                                 buffer_free( having_buf );
3319                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3320                                 free( core_class );
3321                                 return NULL;
3322                         }
3323             }
3324
3325                 // Build a WHERE clause, if there is one
3326             if ( search_hash ) {
3327                     buffer_add(sql_buf, " WHERE ");
3328
3329                     // and it's on the WHERE clause
3330                     char* pred = searchWHERE( search_hash, core_meta, AND_OP_JOIN, ctx );
3331
3332                     if (pred) {
3333                                 buffer_add(sql_buf, pred);
3334                                 free(pred);
3335                         } else {
3336                                 if (ctx) {
3337                                 osrfAppSessionStatus(
3338                                         ctx->session,
3339                                         OSRF_STATUS_INTERNALSERVERERROR,
3340                                         "osrfMethodException",
3341                                         ctx->request,
3342                                         "Severe query error in WHERE predicate -- see error log for more details"
3343                                 );
3344                             }
3345                             free(core_class);
3346                             buffer_free(having_buf);
3347                             buffer_free(group_buf);
3348                             buffer_free(sql_buf);
3349                             if (defaultselhash) jsonObjectFree(defaultselhash);
3350                             return NULL;
3351                     }
3352         }
3353
3354                 // Build a HAVING clause, if there is one
3355             if ( having_hash ) {
3356                     buffer_add(sql_buf, " HAVING ");
3357
3358                     // and it's on the the WHERE clause
3359                     char* pred = searchWHERE( having_hash, core_meta, AND_OP_JOIN, ctx );
3360
3361                     if (pred) {
3362                                 buffer_add(sql_buf, pred);
3363                                 free(pred);
3364                         } else {
3365                                 if (ctx) {
3366                                 osrfAppSessionStatus(
3367                                         ctx->session,
3368                                         OSRF_STATUS_INTERNALSERVERERROR,
3369                                         "osrfMethodException",
3370                                         ctx->request,
3371                                         "Severe query error in HAVING predicate -- see error log for more details"
3372                                         );
3373                                 }
3374                                 free(core_class);
3375                                 buffer_free(having_buf);
3376                                 buffer_free(group_buf);
3377                                 buffer_free(sql_buf);
3378                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3379                                 return NULL;
3380                         }
3381                 }
3382
3383                 growing_buffer* order_buf = NULL;  // to collect ORDER BY list
3384
3385                 // Build an ORDER BY clause, if there is one
3386                 if( NULL == order_hash )
3387                         ;  // No ORDER BY? do nothing
3388                 else if( JSON_HASH == order_hash->type )
3389                 {
3390                         jsonIterator* class_itr = jsonNewIterator( order_hash );
3391                         while ( (snode = jsonIteratorNext( class_itr )) ) {
3392
3393                                 if (!jsonObjectGetKeyConst(selhash,class_itr->key)) {
3394                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid class \"%s\" referenced in ORDER BY clause",
3395                                                                  MODULENAME, class_itr->key );
3396                                         if( ctx )
3397                                                 osrfAppSessionStatus(
3398                                                         ctx->session,
3399                                                         OSRF_STATUS_INTERNALSERVERERROR,
3400                                                         "osrfMethodException",
3401                                                         ctx->request,
3402                                                         "Invalid class referenced in ORDER BY clause -- see error log for more details"
3403                                                 );
3404                                         jsonIteratorFree( class_itr );
3405                                         buffer_free( order_buf );
3406                                         free(core_class);
3407                                         buffer_free(having_buf);
3408                                         buffer_free(group_buf);
3409                                         buffer_free(sql_buf);
3410                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3411                                         return NULL;
3412                                 }
3413
3414                                 osrfHash* field_list_def = oilsIDLFindPath( "/%s/fields", class_itr->key );
3415
3416                                 if ( snode->type == JSON_HASH ) {
3417
3418                                         jsonIterator* order_itr = jsonNewIterator( snode );
3419                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
3420
3421                                                 osrfHash* field_def = osrfHashGet( field_list_def, order_itr->key );
3422                                                 if( !field_def ) {
3423                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3424                                                                         MODULENAME, order_itr->key );
3425                                                         if( ctx )
3426                                                                 osrfAppSessionStatus(
3427                                                                         ctx->session,
3428                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3429                                                                         "osrfMethodException",
3430                                                                         ctx->request,
3431                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3432                                                                 );
3433                                                         jsonIteratorFree( order_itr );
3434                                                         jsonIteratorFree( class_itr );
3435                                                         buffer_free( order_buf );
3436                                                         free(core_class);
3437                                                         buffer_free(having_buf);
3438                                                         buffer_free(group_buf);
3439                                                         buffer_free(sql_buf);
3440                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3441                                                         return NULL;
3442                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3443                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3444                                                                  MODULENAME, order_itr->key );
3445                                                         if( ctx )
3446                                                                 osrfAppSessionStatus(
3447                                                                         ctx->session,
3448                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3449                                                                         "osrfMethodException",
3450                                                                         ctx->request,
3451                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3452                                                         );
3453                                                         jsonIteratorFree( order_itr );
3454                                                         jsonIteratorFree( class_itr );
3455                                                         buffer_free( order_buf );
3456                                                         free(core_class);
3457                                                         buffer_free(having_buf);
3458                                                         buffer_free(group_buf);
3459                                                         buffer_free(sql_buf);
3460                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3461                                                         return NULL;
3462                                                 }
3463
3464                                                 const char* direction = NULL;
3465                                                 if ( onode->type == JSON_HASH ) {
3466                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3467                                                                 string = searchFieldTransform(
3468                                                                         class_itr->key,
3469                                                                         oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
3470                                                                         onode
3471                                                                 );
3472                                                                 if( ! string ) {
3473                                                                         if( ctx ) osrfAppSessionStatus(
3474                                                                                 ctx->session,
3475                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3476                                                                                 "osrfMethodException",
3477                                                                                 ctx->request,
3478                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3479                                                                         );
3480                                                                         jsonIteratorFree( order_itr );
3481                                                                         jsonIteratorFree( class_itr );
3482                                                                         free(core_class);
3483                                                                         buffer_free(having_buf);
3484                                                                         buffer_free(group_buf);
3485                                                                         buffer_free(order_buf);
3486                                                                         buffer_free(sql_buf);
3487                                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3488                                                                         return NULL;
3489                                                                 }
3490                                                         } else {
3491                                                                 growing_buffer* field_buf = buffer_init(16);
3492                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3493                                                                 string = buffer_release(field_buf);
3494                                                         }
3495
3496                                                         if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3497                                                                 const char* dir = jsonObjectGetString(tmp_const);
3498                                                                 if (!strncasecmp(dir, "d", 1)) {
3499                                                                         direction = " DESC";
3500                                                                 } else {
3501                                                                         direction = " ASC";
3502                                                                 }
3503                                                         }
3504
3505                                                 } else {
3506                                                         string = strdup(order_itr->key);
3507                                                         const char* dir = jsonObjectGetString(onode);
3508                                                         if (!strncasecmp(dir, "d", 1)) {
3509                                                                 direction = " DESC";
3510                                                         } else {
3511                                                                 direction = " ASC";
3512                                                         }
3513                                                 }
3514
3515                                                 if ( order_buf )
3516                                                         buffer_add(order_buf, ", ");
3517                                                 else
3518                                                         order_buf = buffer_init(128);
3519
3520                                                 buffer_add(order_buf, string);
3521                                                 free(string);
3522
3523                                                 if (direction) {
3524                                                          buffer_add(order_buf, direction);
3525                                                 }
3526
3527                                         } // end while
3528                     // jsonIteratorFree(order_itr);
3529
3530                                 } else if ( snode->type == JSON_ARRAY ) {
3531
3532                                         jsonIterator* order_itr = jsonNewIterator( snode );
3533                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
3534
3535                                                 const char* _f = jsonObjectGetString( onode );
3536
3537                                                 osrfHash* field_def = osrfHashGet( field_list_def, _f );
3538                                                 if( !field_def ) {
3539                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3540                                                                         MODULENAME, _f );
3541                                                         if( ctx )
3542                                                                 osrfAppSessionStatus(
3543                                                                         ctx->session,
3544                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3545                                                                         "osrfMethodException",
3546                                                                         ctx->request,
3547                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3548                                                                 );
3549                                                         jsonIteratorFree( order_itr );
3550                                                         jsonIteratorFree( class_itr );
3551                                                         buffer_free( order_buf );
3552                                                         free(core_class);
3553                                                         buffer_free(having_buf);
3554                                                         buffer_free(group_buf);
3555                                                         buffer_free(sql_buf);
3556                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3557                                                         return NULL;
3558                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3559                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3560                                                                         MODULENAME, _f );
3561                                                         if( ctx )
3562                                                                 osrfAppSessionStatus(
3563                                                                         ctx->session,
3564                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3565                                                                         "osrfMethodException",
3566                                                                         ctx->request,
3567                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3568                                                                 );
3569                                                         jsonIteratorFree( order_itr );
3570                                                         jsonIteratorFree( class_itr );
3571                                                         buffer_free( order_buf );
3572                                                         free(core_class);
3573                                                         buffer_free(having_buf);
3574                                                         buffer_free(group_buf);
3575                                                         buffer_free(sql_buf);
3576                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3577                                                         return NULL;
3578                                                 }
3579
3580                                                 if ( order_buf )
3581                                                         buffer_add(order_buf, ", ");
3582                                                 else
3583                                                         order_buf = buffer_init(128);
3584
3585                                                 buffer_add(order_buf, _f);
3586
3587                                         } // end while
3588                                 // jsonIteratorFree(order_itr);
3589
3590
3591                                 // IT'S THE OOOOOOOOOOOLD STYLE!
3592                                 } else {
3593                                         osrfLogError(OSRF_LOG_MARK,
3594                                                         "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3595                                         if (ctx) {
3596                                                 osrfAppSessionStatus(
3597                                                         ctx->session,
3598                                                         OSRF_STATUS_INTERNALSERVERERROR,
3599                                                         "osrfMethodException",
3600                                                         ctx->request,
3601                                                         "Severe query error -- see error log for more details"
3602                                                 );
3603                                         }
3604
3605                                         free(core_class);
3606                                         buffer_free(having_buf);
3607                                         buffer_free(group_buf);
3608                                         buffer_free(order_buf);
3609                                         buffer_free(sql_buf);
3610                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3611                                         jsonIteratorFree(class_itr);
3612                                         return NULL;
3613                                 }
3614                         } // end while
3615                 } else {
3616                         osrfLogError(OSRF_LOG_MARK,
3617                                 "%s: Malformed ORDER BY clause; expected JSON_HASH, found %s",
3618                                 MODULENAME, json_type( order_hash->type ) );
3619                         if( ctx )
3620                                 osrfAppSessionStatus(
3621                                         ctx->session,
3622                                         OSRF_STATUS_INTERNALSERVERERROR,
3623                                         "osrfMethodException",
3624                                         ctx->request,
3625                                         "Malformed ORDER BY clause -- see error log for more details"
3626                                 );
3627                         buffer_free( order_buf );
3628                         free(core_class);
3629                         buffer_free(having_buf);
3630                         buffer_free(group_buf);
3631                         buffer_free(sql_buf);
3632                         if (defaultselhash) jsonObjectFree(defaultselhash);
3633                         return NULL;
3634                 }
3635                 // jsonIteratorFree(class_itr);
3636
3637                 if( order_buf )
3638                         order_by_list = buffer_release( order_buf );
3639         }
3640
3641
3642         string = buffer_release(group_buf);
3643
3644         if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3645                 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3646                 OSRF_BUFFER_ADD( sql_buf, string );
3647         }
3648
3649         free(string);
3650
3651         if( having_buf ) {
3652                 string = buffer_release(having_buf);
3653
3654                 if ( *string ) {
3655                         OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3656                         OSRF_BUFFER_ADD( sql_buf, string );
3657                 }
3658
3659                 free(string);
3660         }
3661
3662         if( order_by_list ) {
3663
3664                 if ( *order_by_list ) {
3665                         OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3666                         OSRF_BUFFER_ADD( sql_buf, order_by_list );
3667                 }
3668
3669                 free( order_by_list );
3670         }
3671
3672         if ( limit ){
3673                 const char* str = jsonObjectGetString(limit);
3674                 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3675         }
3676
3677         if (offset) {
3678                 const char* str = jsonObjectGetString(offset);
3679                 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3680         }
3681
3682         if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3683
3684         free(core_class);
3685         if (defaultselhash) jsonObjectFree(defaultselhash);
3686
3687         return buffer_release(sql_buf);
3688
3689 }
3690
3691 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3692
3693         const char* locale = osrf_message_get_last_locale();
3694
3695         osrfHash* fields = osrfHashGet(meta, "fields");
3696         char* core_class = osrfHashGet(meta, "classname");
3697
3698         const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3699
3700         jsonObject* node = NULL;
3701         jsonObject* snode = NULL;
3702         jsonObject* onode = NULL;
3703         const jsonObject* _tmp = NULL;
3704         jsonObject* selhash = NULL;
3705         jsonObject* defaultselhash = NULL;
3706
3707         growing_buffer* sql_buf = buffer_init(128);
3708         growing_buffer* select_buf = buffer_init(128);
3709
3710         if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
3711                 defaultselhash = jsonNewObjectType(JSON_HASH);
3712                 selhash = defaultselhash;
3713         }
3714
3715         if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
3716                 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
3717                 jsonObject* flist = jsonObjectGetKey( selhash, core_class );
3718
3719                 int i = 0;
3720                 char* field;
3721
3722                 osrfStringArray* keys = osrfHashKeys( fields );
3723                 while ( (field = osrfStringArrayGetString(keys, i++)) ) {
3724                         if( ! str_is_true( osrfHashGet( osrfHashGet( fields, field ), "virtual" ) ) )
3725                                 jsonObjectPush( flist, jsonNewObject( field ) );
3726                 }
3727                 osrfStringArrayFree(keys);
3728         }
3729
3730         int first = 1;
3731         jsonIterator* class_itr = jsonNewIterator( selhash );
3732         while ( (snode = jsonIteratorNext( class_itr )) ) {
3733
3734                 char* cname = class_itr->key;
3735                 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
3736                 if (!idlClass) continue;
3737
3738                 if (strcmp(core_class,class_itr->key)) {
3739                         if (!join_hash) continue;
3740
3741                         jsonObject* found =  jsonObjectFindPath(join_hash, "//%s", class_itr->key);
3742                         if (!found->size) {
3743                                 jsonObjectFree(found);
3744                                 continue;
3745                         }
3746
3747                         jsonObjectFree(found);
3748                 }
3749
3750                 jsonIterator* select_itr = jsonNewIterator( snode );
3751                 while ( (node = jsonIteratorNext( select_itr )) ) {
3752                         const char* item_str = jsonObjectGetString( node );
3753                         osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
3754                         char* fname = osrfHashGet(field, "name");
3755
3756                         if (!field) continue;
3757
3758                         if (first) {
3759                                 first = 0;
3760                         } else {
3761                                 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
3762                         }
3763
3764             if (locale) {
3765                         const char* i18n;
3766                                 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
3767                                 if ( obj_is_true( no_i18n_obj ) )    // Suppress internationalization?
3768                                         i18n = NULL;
3769                                 else
3770                                         i18n = osrfHashGet(field, "i18n");
3771
3772                                 if( str_is_true( i18n ) ) {
3773                         char* pkey = osrfHashGet(idlClass, "primarykey");
3774                         char* tname = osrfHashGet(idlClass, "tablename");
3775
3776                     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);
3777                 } else {
3778                                 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3779                 }
3780             } else {
3781                             buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
3782             }
3783                 }
3784
3785         jsonIteratorFree(select_itr);
3786         }
3787
3788     jsonIteratorFree(class_itr);
3789
3790         char* col_list = buffer_release(select_buf);
3791         char* table = getSourceDefinition(meta);
3792         if( !table )
3793                 table = strdup( "(null)" );
3794
3795         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
3796         free(col_list);
3797         free(table);
3798
3799         if ( join_hash ) {
3800                 char* join_clause = searchJOIN( join_hash, meta );
3801                 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
3802                 OSRF_BUFFER_ADD(sql_buf, join_clause);
3803                 free(join_clause);
3804         }
3805
3806         osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL =  %s",
3807                                  MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
3808
3809         buffer_add(sql_buf, " WHERE ");
3810
3811         char* pred = searchWHERE( search_hash, meta, AND_OP_JOIN, ctx );
3812         if (!pred) {
3813                 osrfAppSessionStatus(
3814                         ctx->session,
3815                         OSRF_STATUS_INTERNALSERVERERROR,
3816                                 "osrfMethodException",
3817                                 ctx->request,
3818                                 "Severe query error -- see error log for more details"
3819                         );
3820                 buffer_free(sql_buf);
3821                 if(defaultselhash) jsonObjectFree(defaultselhash);
3822                 return NULL;
3823         } else {
3824                 buffer_add(sql_buf, pred);
3825                 free(pred);
3826         }
3827
3828         if (order_hash) {
3829                 char* string = NULL;
3830                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
3831
3832                         growing_buffer* order_buf = buffer_init(128);
3833
3834                         first = 1;
3835                         jsonIterator* class_itr = jsonNewIterator( _tmp );
3836                         while ( (snode = jsonIteratorNext( class_itr )) ) {
3837
3838                                 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
3839                                         continue;
3840
3841                                 if ( snode->type == JSON_HASH ) {
3842
3843                                         jsonIterator* order_itr = jsonNewIterator( snode );
3844                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
3845
3846                                                 if (!oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ))
3847                                                         continue;
3848
3849                                                 char* direction = NULL;
3850                                                 if ( onode->type == JSON_HASH ) {
3851                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3852                                                                 string = searchFieldTransform(
3853                                                                         class_itr->key,
3854                                                                         oilsIDLFindPath( "/%s/fields/%s", class_itr->key, order_itr->key ),
3855                                                                         onode
3856                                                                 );
3857                                                                 if( ! string ) {
3858                                                                         osrfAppSessionStatus(
3859                                                                                 ctx->session,
3860                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3861                                                                                 "osrfMethodException",
3862                                                                                 ctx->request,
3863                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3864                                                                         );
3865                                                                         jsonIteratorFree( order_itr );
3866                                                                         jsonIteratorFree( class_itr );
3867                                                                         buffer_free( order_buf );
3868                                                                         buffer_free( sql_buf );
3869                                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3870                                                                         return NULL;
3871                                                                 }
3872                                                         } else {
3873                                                                 growing_buffer* field_buf = buffer_init(16);
3874                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3875                                                                 string = buffer_release(field_buf);
3876                                                         }
3877
3878                                                         if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
3879                                                                 const char* dir = jsonObjectGetString(_tmp);
3880                                                                 if (!strncasecmp(dir, "d", 1)) {
3881                                                                         direction = " DESC";
3882                                                                 } else {
3883                                                                         free(direction);
3884                                                                 }
3885                                                         }
3886
3887                                                 } else {
3888                                                         string = strdup(order_itr->key);
3889                                                         const char* dir = jsonObjectGetString(onode);
3890                                                         if (!strncasecmp(dir, "d", 1)) {
3891                                                                 direction = " DESC";
3892                                                         } else {
3893                                                                 direction = " ASC";
3894                                                         }
3895                                                 }
3896
3897                                                 if (first) {
3898                                                         first = 0;
3899                                                 } else {
3900                                                         buffer_add(order_buf, ", ");
3901                                                 }
3902
3903                                                 buffer_add(order_buf, string);
3904                                                 free(string);
3905
3906                                                 if (direction) {
3907                                                         buffer_add(order_buf, direction);
3908                                                 }
3909
3910                                         }
3911
3912                     jsonIteratorFree(order_itr);
3913
3914                                 } else {
3915                                         const char* str = jsonObjectGetString(snode);
3916                                         buffer_add(order_buf, str);
3917                                         break;
3918                                 }
3919
3920                         }
3921
3922                         jsonIteratorFree(class_itr);
3923
3924                         string = buffer_release(order_buf);
3925
3926                         if ( *string ) {
3927                                 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3928                                 OSRF_BUFFER_ADD( sql_buf, string );
3929                         }
3930
3931                         free(string);
3932                 }
3933
3934                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
3935                         const char* str = jsonObjectGetString(_tmp);
3936                         buffer_fadd(
3937                                 sql_buf,
3938                                 " LIMIT %d",
3939                                 atoi(str)
3940                         );
3941                 }
3942
3943                 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
3944                 if (_tmp) {
3945                         const char* str = jsonObjectGetString(_tmp);
3946                         buffer_fadd(
3947                                 sql_buf,
3948                                 " OFFSET %d",
3949                                 atoi(str)
3950                         );
3951                 }
3952         }
3953
3954         if (defaultselhash) jsonObjectFree(defaultselhash);
3955
3956         OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3957         return buffer_release(sql_buf);
3958 }
3959
3960 int doJSONSearch ( osrfMethodContext* ctx ) {
3961         if(osrfMethodVerifyContext( ctx )) {
3962                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
3963                 return -1;
3964         }
3965
3966         osrfLogDebug(OSRF_LOG_MARK, "Recieved query request");
3967
3968         int err = 0;
3969
3970         // XXX for now...
3971         dbhandle = writehandle;
3972
3973         jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
3974
3975         int flags = 0;
3976
3977         if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
3978                 flags |= SELECT_DISTINCT;
3979
3980         if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
3981                 flags |= DISABLE_I18N;
3982
3983         osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
3984         char* sql = SELECT(
3985                         ctx,
3986                         jsonObjectGetKey( hash, "select" ),
3987                         jsonObjectGetKey( hash, "from" ),
3988                         jsonObjectGetKey( hash, "where" ),
3989                         jsonObjectGetKey( hash, "having" ),
3990                         jsonObjectGetKey( hash, "order_by" ),
3991                         jsonObjectGetKey( hash, "limit" ),
3992                         jsonObjectGetKey( hash, "offset" ),
3993                         flags
3994         );
3995
3996         if (!sql) {
3997                 err = -1;
3998                 return err;
3999         }
4000
4001         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4002         dbi_result result = dbi_conn_query(dbhandle, sql);
4003
4004         if(result) {
4005                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4006
4007                 if (dbi_result_first_row(result)) {
4008                         /* JSONify the result */
4009                         osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4010
4011                         do {
4012                                 jsonObject* return_val = oilsMakeJSONFromResult( result );
4013                                 osrfAppRespond( ctx, return_val );
4014                 jsonObjectFree( return_val );
4015                         } while (dbi_result_next_row(result));
4016
4017                 } else {
4018                         osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
4019                 }
4020
4021                 osrfAppRespondComplete( ctx, NULL );
4022
4023                 /* clean up the query */
4024                 dbi_result_free(result);
4025
4026         } else {
4027                 err = -1;
4028                 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
4029                 osrfAppSessionStatus(
4030                         ctx->session,
4031                         OSRF_STATUS_INTERNALSERVERERROR,
4032                         "osrfMethodException",
4033                         ctx->request,
4034                         "Severe query error -- see error log for more details"
4035                 );
4036         }
4037
4038         free(sql);
4039         return err;
4040 }
4041
4042 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
4043                 const jsonObject* params, int* err ) {
4044
4045         // XXX for now...
4046         dbhandle = writehandle;
4047
4048         osrfHash* links = osrfHashGet(meta, "links");
4049         osrfHash* fields = osrfHashGet(meta, "fields");
4050         char* core_class = osrfHashGet(meta, "classname");
4051         char* pkey = osrfHashGet(meta, "primarykey");
4052
4053         const jsonObject* _tmp;
4054         jsonObject* obj;
4055         jsonObject* search_hash = jsonObjectGetIndex(params, 0);
4056         jsonObject* order_hash = jsonObjectGetIndex(params, 1);
4057
4058         char* sql = buildSELECT( search_hash, order_hash, meta, ctx );
4059         if (!sql) {
4060                 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
4061                 *err = -1;
4062                 return NULL;
4063         }
4064
4065         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4066
4067         dbi_result result = dbi_conn_query(dbhandle, sql);
4068         if( NULL == result ) {
4069                 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
4070                         MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
4071                 osrfAppSessionStatus(
4072                         ctx->session,
4073                         OSRF_STATUS_INTERNALSERVERERROR,
4074                         "osrfMethodException",
4075                         ctx->request,
4076                         "Severe query error -- see error log for more details"
4077                 );
4078                 *err = -1;
4079                 free(sql);
4080                 return jsonNULL;
4081
4082         } else {
4083                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4084         }
4085
4086         jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
4087         osrfHash* dedup = osrfNewHash();
4088
4089         if (dbi_result_first_row(result)) {
4090                 /* JSONify the result */
4091                 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4092                 do {
4093                         obj = oilsMakeFieldmapperFromResult( result, meta );
4094                         char* pkey_val = oilsFMGetString( obj, pkey );
4095                         if ( osrfHashGet( dedup, pkey_val ) ) {
4096                                 jsonObjectFree(obj);
4097                                 free(pkey_val);
4098                         } else {
4099                                 osrfHashSet( dedup, pkey_val, pkey_val );
4100                                 jsonObjectPush(res_list, obj);
4101                         }
4102                 } while (dbi_result_next_row(result));
4103         } else {
4104                 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
4105                         MODULENAME, sql );
4106         }
4107
4108         osrfHashFree(dedup);
4109         /* clean up the query */
4110         dbi_result_free(result);
4111         free(sql);
4112
4113         if (res_list->size && order_hash) {
4114                 _tmp = jsonObjectGetKeyConst( order_hash, "flesh" );
4115                 if (_tmp) {
4116                         int x = (int)jsonObjectGetNumber(_tmp);
4117                         if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4118
4119                         const jsonObject* temp_blob;
4120                         if ((temp_blob = jsonObjectGetKeyConst( order_hash, "flesh_fields" )) && x > 0) {
4121
4122                                 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4123                                 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4124
4125                                 osrfStringArray* link_fields = NULL;
4126
4127                                 if (flesh_fields) {
4128                                         if (flesh_fields->size == 1) {
4129                                                 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4130                                                 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4131                                         }
4132
4133                                         if (!link_fields) {
4134                                                 jsonObject* _f;
4135                                                 link_fields = osrfNewStringArray(1);
4136                                                 jsonIterator* _i = jsonNewIterator( flesh_fields );
4137                                                 while ((_f = jsonIteratorNext( _i ))) {
4138                                                         osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4139                                                 }
4140                         jsonIteratorFree(_i);
4141                                         }
4142                                 }
4143
4144                                 jsonObject* cur;
4145                                 jsonIterator* itr = jsonNewIterator( res_list );
4146                                 while ((cur = jsonIteratorNext( itr ))) {
4147
4148                                         int i = 0;
4149                                         char* link_field;
4150
4151                                         while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4152
4153                                                 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4154
4155                                                 osrfHash* kid_link = osrfHashGet(links, link_field);
4156                                                 if (!kid_link) continue;
4157
4158                                                 osrfHash* field = osrfHashGet(fields, link_field);
4159                                                 if (!field) continue;
4160
4161                                                 osrfHash* value_field = field;
4162
4163                                                 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4164                                                 if (!kid_idl) continue;
4165
4166                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4167                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4168                                                 }
4169
4170                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4171                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4172                                                 }
4173
4174                                                 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4175
4176                                                 if (link_map->size > 0) {
4177                                                         jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4178                                                         jsonObjectPush(
4179                                                                 _kid_key,
4180                                                                 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4181                                                         );
4182
4183                                                         jsonObjectSetKey(
4184                                                                 flesh_blob,
4185                                                                 osrfHashGet(kid_link, "class"),
4186                                                                 _kid_key
4187                                                         );
4188                                                 };
4189
4190                                                 osrfLogDebug(
4191                                                         OSRF_LOG_MARK,
4192                                                         "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4193                                                         osrfHashGet(kid_link, "field"),
4194                                                         osrfHashGet(kid_link, "class"),
4195                                                         osrfHashGet(kid_link, "key"),
4196                                                         osrfHashGet(kid_link, "reltype")
4197                                                 );
4198
4199                                                 jsonObject* fake_params = jsonNewObjectType(JSON_ARRAY);
4200                                                 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // search hash
4201                                                 jsonObjectPush(fake_params, jsonNewObjectType(JSON_HASH)); // order/flesh hash
4202
4203                                                 osrfLogDebug(OSRF_LOG_MARK, "Creating dummy params object...");
4204
4205                                                 const char* search_key = jsonObjectGetString(
4206                                                         jsonObjectGetIndex(
4207                                                                 cur,
4208                                                                 atoi( osrfHashGet(value_field, "array_position") )
4209                                                         )
4210                                                 );
4211
4212                                                 if (!search_key) {
4213                                                         osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4214                                                         continue;
4215                                                 }
4216
4217                                                 jsonObjectSetKey(
4218                                                         jsonObjectGetIndex(fake_params, 0),
4219                                                         osrfHashGet(kid_link, "key"),
4220                                                         jsonNewObject( search_key )
4221                                                 );
4222
4223                                                 jsonObjectSetKey(
4224                                                         jsonObjectGetIndex(fake_params, 1),
4225                                                         "flesh",
4226                                                         jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4227                                                 );
4228
4229                                                 if (flesh_blob)
4230                                                         jsonObjectSetKey( jsonObjectGetIndex(fake_params, 1), "flesh_fields", jsonObjectClone(flesh_blob) );
4231
4232                                                 if (jsonObjectGetKeyConst(order_hash, "order_by")) {
4233                                                         jsonObjectSetKey(
4234                                                                 jsonObjectGetIndex(fake_params, 1),
4235                                                                 "order_by",
4236                                                                 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "order_by"))
4237                                                         );
4238                                                 }
4239
4240                                                 if (jsonObjectGetKeyConst(order_hash, "select")) {
4241                                                         jsonObjectSetKey(
4242                                                                 jsonObjectGetIndex(fake_params, 1),
4243                                                                 "select",
4244                                                                 jsonObjectClone(jsonObjectGetKeyConst(order_hash, "select"))
4245                                                         );
4246                                                 }
4247
4248                                                 jsonObject* kids = doFieldmapperSearch(ctx, kid_idl, fake_params, err);
4249
4250                                                 if(*err) {
4251                                                         jsonObjectFree( fake_params );
4252                                                         osrfStringArrayFree(link_fields);
4253                                                         jsonIteratorFree(itr);
4254                                                         jsonObjectFree(res_list);
4255                                                         jsonObjectFree(flesh_blob);
4256                                                         return jsonNULL;
4257                                                 }
4258
4259                                                 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4260
4261                                                 jsonObject* X = NULL;
4262                                                 if ( link_map->size > 0 && kids->size > 0 ) {
4263                                                         X = kids;
4264                                                         kids = jsonNewObjectType(JSON_ARRAY);
4265
4266                                                         jsonObject* _k_node;
4267                                                         jsonIterator* _k = jsonNewIterator( X );
4268                                                         while ((_k_node = jsonIteratorNext( _k ))) {
4269                                                                 jsonObjectPush(
4270                                                                         kids,
4271                                                                         jsonObjectClone(
4272                                                                                 jsonObjectGetIndex(
4273                                                                                         _k_node,
4274                                                                                         (unsigned long)atoi(
4275                                                                                                 osrfHashGet(
4276                                                                                                         osrfHashGet(
4277                                                                                                                 osrfHashGet(
4278                                                                                                                         osrfHashGet(
4279                                                                                                                                 oilsIDL(),
4280                                                                                                                                 osrfHashGet(kid_link, "class")
4281                                                                                                                         ),
4282                                                                                                                         "fields"
4283                                                                                                                 ),
4284                                                                                                                 osrfStringArrayGetString( link_map, 0 )
4285                                                                                                         ),
4286                                                                                                         "array_position"
4287                                                                                                 )
4288                                                                                         )
4289                                                                                 )
4290                                                                         )
4291                                                                 );
4292                                                         }
4293                                                         jsonIteratorFree(_k);
4294                                                 }
4295
4296                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4297                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4298                                                         jsonObjectSetIndex(
4299                                                                 cur,
4300                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4301                                                                 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4302                                                         );
4303                                                 }
4304
4305                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4306                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4307                                                         jsonObjectSetIndex(
4308                                                                 cur,
4309                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4310                                                                 jsonObjectClone( kids )
4311                                                         );
4312                                                 }
4313
4314                                                 if (X) {
4315                                                         jsonObjectFree(kids);
4316                                                         kids = X;
4317                                                 }
4318
4319                                                 jsonObjectFree( kids );
4320                                                 jsonObjectFree( fake_params );
4321
4322                                                 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4323                                                 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4324
4325                                         }
4326                                 }
4327                                 jsonObjectFree( flesh_blob );
4328                                 osrfStringArrayFree(link_fields);
4329                                 jsonIteratorFree(itr);
4330                         }
4331                 }
4332         }
4333
4334         return res_list;
4335 }
4336
4337
4338 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4339
4340         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4341 #ifdef PCRUD
4342         jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4343 #else
4344         jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4345 #endif
4346
4347         if (!verifyObjectClass(ctx, target)) {
4348                 *err = -1;
4349                 return jsonNULL;
4350         }
4351
4352         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4353                 osrfAppSessionStatus(
4354                         ctx->session,
4355                         OSRF_STATUS_BADREQUEST,
4356                         "osrfMethodException",
4357                         ctx->request,
4358                         "No active transaction -- required for UPDATE"
4359                 );
4360                 *err = -1;
4361                 return jsonNULL;
4362         }
4363
4364         // The following test is harmless but redundant.  If a class is
4365         // readonly, we don't register an update method for it.
4366         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4367                 osrfAppSessionStatus(
4368                         ctx->session,
4369                         OSRF_STATUS_BADREQUEST,
4370                         "osrfMethodException",
4371                         ctx->request,
4372                         "Cannot UPDATE readonly class"
4373                 );
4374                 *err = -1;
4375                 return jsonNULL;
4376         }
4377
4378         dbhandle = writehandle;
4379
4380         char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4381
4382         // Set the last_xact_id
4383         int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4384         if (index > -1) {
4385                 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
4386                 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4387         }
4388
4389         char* pkey = osrfHashGet(meta, "primarykey");
4390         osrfHash* fields = osrfHashGet(meta, "fields");
4391
4392         char* id = oilsFMGetString( target, pkey );
4393
4394         osrfLogDebug(
4395                 OSRF_LOG_MARK,
4396                 "%s updating %s object with %s = %s",
4397                 MODULENAME,
4398                 osrfHashGet(meta, "fieldmapper"),
4399                 pkey,
4400                 id
4401         );
4402
4403         growing_buffer* sql = buffer_init(128);
4404         buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4405
4406         int i = 0;
4407         int first = 1;
4408         char* field_name;
4409         osrfStringArray* field_list = osrfHashKeys( fields );
4410         while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
4411
4412                 osrfHash* field = osrfHashGet( fields, field_name );
4413
4414                 if(!( strcmp( field_name, pkey ) )) continue;
4415                 if( str_is_true( osrfHashGet(osrfHashGet(fields,field_name), "virtual") ) )
4416                         continue;
4417
4418                 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4419
4420                 int value_is_numeric = 0;    // boolean
4421                 char* value;
4422                 if (field_object && field_object->classname) {
4423                         value = oilsFMGetString(
4424                                 field_object,
4425                                 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4426             );
4427                 } else {
4428                         value = jsonObjectToSimpleString( field_object );
4429                         if( field_object && JSON_NUMBER == field_object->type )
4430                                 value_is_numeric = 1;
4431                 }
4432
4433                 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s", osrfHashGet(meta, "fieldmapper"), field_name, value);
4434
4435                 if (!field_object || field_object->type == JSON_NULL) {
4436                         if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) ) && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4437                                 if (first) first = 0;
4438                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4439                                 buffer_fadd( sql, " %s = NULL", field_name );
4440                         }
4441
4442                 } else if ( value_is_numeric || !strcmp( get_primitive( field ), "number") ) {
4443                         if (first) first = 0;
4444                         else OSRF_BUFFER_ADD_CHAR(sql, ',');
4445
4446                         const char* numtype = get_datatype( field );
4447                         if ( !strncmp( numtype, "INT", 3 ) ) {
4448                                 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4449                         } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4450                                 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4451                         } else {
4452                                 // Must really be intended as a string, so quote it
4453                                 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4454                                         buffer_fadd( sql, " %s = %s", field_name, value );
4455                                 } else {
4456                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4457                                         osrfAppSessionStatus(
4458                                                 ctx->session,
4459                                                 OSRF_STATUS_INTERNALSERVERERROR,
4460                                                 "osrfMethodException",
4461                                                 ctx->request,
4462                                                 "Error quoting string -- please see the error log for more details"
4463                                         );
4464                                         free(value);
4465                                         free(id);
4466                                         buffer_free(sql);
4467                                         *err = -1;
4468                                         return jsonNULL;
4469                                 }
4470                         }
4471
4472                         osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4473
4474                 } else {
4475                         if ( dbi_conn_quote_string(dbhandle, &value) ) {
4476                                 if (first) first = 0;
4477                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4478                                 buffer_fadd( sql, " %s = %s", field_name, value );
4479
4480                         } else {
4481                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4482                                 osrfAppSessionStatus(
4483                                         ctx->session,
4484                                         OSRF_STATUS_INTERNALSERVERERROR,
4485                                         "osrfMethodException",
4486                                         ctx->request,
4487                                         "Error quoting string -- please see the error log for more details"
4488                                 );
4489                                 free(value);
4490                                 free(id);
4491                                 buffer_free(sql);
4492                                 *err = -1;
4493                                 return jsonNULL;
4494                         }
4495                 }
4496
4497                 free(value);
4498
4499         }
4500
4501         jsonObject* obj = jsonNewObject(id);
4502
4503         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4504                 dbi_conn_quote_string(dbhandle, &id);
4505
4506         buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4507
4508         char* query = buffer_release(sql);
4509         osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4510
4511         dbi_result result = dbi_conn_query(dbhandle, query);
4512         free(query);
4513
4514         if (!result) {
4515                 jsonObjectFree(obj);
4516                 obj = jsonNewObject(NULL);
4517                 osrfLogError(
4518                         OSRF_LOG_MARK,
4519                         "%s ERROR updating %s object with %s = %s",
4520                         MODULENAME,
4521                         osrfHashGet(meta, "fieldmapper"),
4522                         pkey,
4523                         id
4524                 );
4525         }
4526
4527         free(id);
4528
4529         return obj;
4530 }
4531
4532 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4533
4534         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4535
4536         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4537                 osrfAppSessionStatus(
4538                         ctx->session,
4539                         OSRF_STATUS_BADREQUEST,
4540                         "osrfMethodException",
4541                         ctx->request,
4542                         "No active transaction -- required for DELETE"
4543                 );
4544                 *err = -1;
4545                 return jsonNULL;
4546         }
4547
4548         // The following test is harmless but redundant.  If a class is
4549         // readonly, we don't register a delete method for it.
4550         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4551                 osrfAppSessionStatus(
4552                         ctx->session,
4553                         OSRF_STATUS_BADREQUEST,
4554                         "osrfMethodException",
4555                         ctx->request,
4556                         "Cannot DELETE readonly class"
4557                 );
4558                 *err = -1;
4559                 return jsonNULL;
4560         }
4561
4562         dbhandle = writehandle;
4563
4564         jsonObject* obj;
4565
4566         char* pkey = osrfHashGet(meta, "primarykey");
4567
4568         int _obj_pos = 0;
4569 #ifdef PCRUD
4570                 _obj_pos = 1;
4571 #endif
4572
4573         char* id;
4574         if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4575                 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4576                         *err = -1;
4577                         return jsonNULL;
4578                 }
4579
4580                 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4581         } else {
4582 #ifdef PCRUD
4583         if (!verifyObjectPCRUD( ctx, NULL )) {
4584                         *err = -1;
4585                         return jsonNULL;
4586         }
4587 #endif
4588                 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4589         }
4590
4591         osrfLogDebug(
4592                 OSRF_LOG_MARK,
4593                 "%s deleting %s object with %s = %s",
4594                 MODULENAME,
4595                 osrfHashGet(meta, "fieldmapper"),
4596                 pkey,
4597                 id
4598         );
4599
4600         obj = jsonNewObject(id);
4601
4602         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4603                 dbi_conn_quote_string(writehandle, &id);
4604
4605         dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4606
4607         if (!result) {
4608                 jsonObjectFree(obj);
4609                 obj = jsonNewObject(NULL);
4610                 osrfLogError(
4611                         OSRF_LOG_MARK,
4612                         "%s ERROR deleting %s object with %s = %s",
4613                         MODULENAME,
4614                         osrfHashGet(meta, "fieldmapper"),
4615                         pkey,
4616                         id
4617                 );
4618         }
4619
4620         free(id);
4621
4622         return obj;
4623
4624 }
4625
4626
4627 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4628         if(!(result && meta)) return jsonNULL;
4629
4630         jsonObject* object = jsonNewObject(NULL);
4631         jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4632
4633         osrfHash* fields = osrfHashGet(meta, "fields");
4634
4635         osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4636
4637         osrfHash* _f;
4638         time_t _tmp_dt;
4639         char dt_string[256];
4640         struct tm gmdt;
4641
4642         int fmIndex;
4643         int columnIndex = 1;
4644         int attr;
4645         unsigned short type;
4646         const char* columnName;
4647
4648         /* cycle through the column list */
4649         while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4650
4651                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4652
4653                 fmIndex = -1; // reset the position
4654
4655                 /* determine the field type and storage attributes */
4656                 type = dbi_result_get_field_type(result, columnName);
4657                 attr = dbi_result_get_field_attribs(result, columnName);
4658
4659                 /* fetch the fieldmapper index */
4660                 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4661
4662                         if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4663                                 continue;
4664
4665                         const char* pos = (char*)osrfHashGet(_f, "array_position");
4666                         if ( !pos ) continue;
4667
4668                         fmIndex = atoi( pos );
4669                         osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4670                 } else {
4671                         continue;
4672                 }
4673
4674                 if (dbi_result_field_is_null(result, columnName)) {
4675                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4676                 } else {
4677
4678                         switch( type ) {
4679
4680                                 case DBI_TYPE_INTEGER :
4681
4682                                         if( attr & DBI_INTEGER_SIZE8 )
4683                                                 jsonObjectSetIndex( object, fmIndex,
4684                                                         jsonNewNumberObject(dbi_result_get_longlong(result, columnName)));
4685                                         else
4686                                                 jsonObjectSetIndex( object, fmIndex,
4687                                                         jsonNewNumberObject(dbi_result_get_int(result, columnName)));
4688
4689                                         break;
4690
4691                                 case DBI_TYPE_DECIMAL :
4692                                         jsonObjectSetIndex( object, fmIndex,
4693                                                         jsonNewNumberObject(dbi_result_get_double(result, columnName)));
4694                                         break;
4695
4696                                 case DBI_TYPE_STRING :
4697
4698
4699                                         jsonObjectSetIndex(
4700                                                 object,
4701                                                 fmIndex,
4702                                                 jsonNewObject( dbi_result_get_string(result, columnName) )
4703                                         );
4704
4705                                         break;
4706
4707                                 case DBI_TYPE_DATETIME :
4708
4709                                         memset(dt_string, '\0', sizeof(dt_string));
4710                                         memset(&gmdt, '\0', sizeof(gmdt));
4711
4712                                         _tmp_dt = dbi_result_get_datetime(result, columnName);
4713
4714
4715                                         if (!(attr & DBI_DATETIME_DATE)) {
4716                                                 gmtime_r( &_tmp_dt, &gmdt );
4717                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4718                                         } else if (!(attr & DBI_DATETIME_TIME)) {
4719                                                 localtime_r( &_tmp_dt, &gmdt );
4720                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4721                                         } else {
4722                                                 localtime_r( &_tmp_dt, &gmdt );
4723                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4724                                         }
4725
4726                                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
4727
4728                                         break;
4729
4730                                 case DBI_TYPE_BINARY :
4731                                         osrfLogError( OSRF_LOG_MARK,
4732                                                 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4733                         }
4734                 }
4735         }
4736
4737         return object;
4738 }
4739
4740 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
4741         if(!result) return jsonNULL;
4742
4743         jsonObject* object = jsonNewObject(NULL);
4744
4745         time_t _tmp_dt;
4746         char dt_string[256];
4747         struct tm gmdt;
4748
4749         int fmIndex;
4750         int columnIndex = 1;
4751         int attr;
4752         unsigned short type;
4753         const char* columnName;
4754
4755         /* cycle through the column list */
4756         while( (columnName = dbi_result_get_field_name(result, columnIndex++)) ) {
4757
4758                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4759
4760                 fmIndex = -1; // reset the position
4761
4762                 /* determine the field type and storage attributes */
4763                 type = dbi_result_get_field_type(result, columnName);
4764                 attr = dbi_result_get_field_attribs(result, columnName);
4765
4766                 if (dbi_result_field_is_null(result, columnName)) {
4767                         jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
4768                 } else {
4769
4770                         switch( type ) {
4771
4772                                 case DBI_TYPE_INTEGER :
4773
4774                                         if( attr & DBI_INTEGER_SIZE8 )
4775                                                 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_longlong(result, columnName)) );
4776                                         else
4777                                                 jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_int(result, columnName)) );
4778                                         break;
4779
4780                                 case DBI_TYPE_DECIMAL :
4781                                         jsonObjectSetKey( object, columnName, jsonNewNumberObject(dbi_result_get_double(result, columnName)) );
4782                                         break;
4783
4784                                 case DBI_TYPE_STRING :
4785                                         jsonObjectSetKey( object, columnName, jsonNewObject(dbi_result_get_string(result, columnName)) );
4786                                         break;
4787
4788                                 case DBI_TYPE_DATETIME :
4789
4790                                         memset(dt_string, '\0', sizeof(dt_string));
4791                                         memset(&gmdt, '\0', sizeof(gmdt));
4792
4793                                         _tmp_dt = dbi_result_get_datetime(result, columnName);
4794
4795
4796                                         if (!(attr & DBI_DATETIME_DATE)) {
4797                                                 gmtime_r( &_tmp_dt, &gmdt );
4798                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4799                                         } else if (!(attr & DBI_DATETIME_TIME)) {
4800                                                 localtime_r( &_tmp_dt, &gmdt );
4801                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4802                                         } else {
4803                                                 localtime_r( &_tmp_dt, &gmdt );
4804                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4805                                         }
4806
4807                                         jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
4808                                         break;
4809
4810                                 case DBI_TYPE_BINARY :
4811                                         osrfLogError( OSRF_LOG_MARK,
4812                                                 "Can't do binary at column %s : index %d", columnName, columnIndex - 1);
4813                         }
4814                 }
4815         }
4816
4817         return object;
4818 }
4819
4820 // Interpret a string as true or false
4821 static int str_is_true( const char* str ) {
4822         if( NULL == str || strcasecmp( str, "true" ) )
4823                 return 0;
4824         else
4825                 return 1;
4826 }
4827
4828 // Interpret a jsonObject as true or false
4829 static int obj_is_true( const jsonObject* obj ) {
4830         if( !obj )
4831                 return 0;
4832         else switch( obj->type )
4833         {
4834                 case JSON_BOOL :
4835                         if( obj->value.b )
4836                                 return 1;
4837                         else
4838                                 return 0;
4839                 case JSON_STRING :
4840                         if( strcasecmp( obj->value.s, "true" ) )
4841                                 return 0;
4842                         else
4843                                 return 1;
4844                 case JSON_NUMBER :          // Support 1/0 for perl's sake
4845                         if( jsonObjectGetNumber( obj ) == 1.0 )
4846                                 return 1;
4847                         else
4848                                 return 0;
4849                 default :
4850                         return 0;
4851         }
4852 }
4853
4854 // Translate a numeric code into a text string identifying a type of
4855 // jsonObject.  To be used for building error messages.
4856 static const char* json_type( int code ) {
4857         switch ( code )
4858         {
4859                 case 0 :
4860                         return "JSON_HASH";
4861                 case 1 :
4862                         return "JSON_ARRAY";
4863                 case 2 :
4864                         return "JSON_STRING";
4865                 case 3 :
4866                         return "JSON_NUMBER";
4867                 case 4 :
4868                         return "JSON_NULL";
4869                 case 5 :
4870                         return "JSON_BOOL";
4871                 default :
4872                         return "(unrecognized)";
4873         }
4874 }
4875
4876 // Extract the "primitive" attribute from an IDL field definition.
4877 // If we haven't initialized the app, then we must be running in
4878 // some kind of testbed.  In that case, default to "string".
4879 static const char* get_primitive( osrfHash* field ) {
4880         const char* s = osrfHashGet( field, "primitive" );
4881         if( !s ) {
4882                 if( child_initialized )
4883                         osrfLogError(
4884                                 OSRF_LOG_MARK,
4885                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
4886                                 MODULENAME,
4887                                 osrfHashGet( field, "name" )
4888                         );
4889                 else
4890                         s = "string";
4891         }
4892         return s;
4893 }
4894
4895 // Extract the "datatype" attribute from an IDL field definition.
4896 // If we haven't initialized the app, then we must be running in
4897 // some kind of testbed.  In that case, default to to NUMERIC,
4898 // since we look at the datatype only for numbers.
4899 static const char* get_datatype( osrfHash* field ) {
4900         const char* s = osrfHashGet( field, "datatype" );
4901         if( !s ) {
4902                 if( child_initialized )
4903                         osrfLogError(
4904                                 OSRF_LOG_MARK,
4905                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
4906                                 MODULENAME,
4907                                 osrfHashGet( field, "name" )
4908                         );
4909                 else
4910                         s = "NUMERIC";
4911         }
4912         return s;
4913 }
4914
4915 /*
4916 If the input string is potentially a valid SQL identifier, return 1.
4917 Otherwise return 0.
4918
4919 Purpose: to prevent certain kinds of SQL injection.  To that end we
4920 don't necessarily need to follow all the rules exactly, such as requiring
4921 that the first character not be a digit.
4922
4923 We allow leading and trailing white space.  In between, we do not allow
4924 punctuation (except for underscores and dollar signs), control
4925 characters, or embedded white space.
4926
4927 More pedantically we should allow quoted identifiers containing arbitrary
4928 characters, but for the foreseeable future such quoted identifiers are not
4929 likely to be an issue.
4930 */
4931 static int is_identifier( const char* s) {
4932         if( !s )
4933                 return 0;
4934
4935         // Skip leading white space
4936         while( isspace( (unsigned char) *s ) )
4937                 ++s;
4938
4939         if( !s )
4940                 return 0;   // Nothing but white space?  Not okay.
4941
4942         // Check each character until we reach white space or
4943         // end-of-string.  Letters, digits, underscores, and
4944         // dollar signs are okay. With the exception of periods
4945         // (as in schema.identifier), control characters and other
4946         // punctuation characters are not okay.  Anything else
4947         // is okay -- it could for example be part of a multibyte
4948         // UTF8 character such as a letter with diacritical marks,
4949         // and those are allowed.
4950         do {
4951                 if( isalnum( (unsigned char) *s )
4952                         || '.' == *s
4953                         || '_' == *s
4954                         || '$' == *s )
4955                         ;  // Fine; keep going
4956                 else if(   ispunct( (unsigned char) *s )
4957                                 || iscntrl( (unsigned char) *s ) )
4958                         return 0;
4959                         ++s;
4960         } while( *s && ! isspace( (unsigned char) *s ) );
4961
4962         // If we found any white space in the above loop,
4963         // the rest had better be all white space.
4964
4965         while( isspace( (unsigned char) *s ) )
4966                 ++s;
4967
4968         if( *s )
4969                 return 0;   // White space was embedded within non-white space
4970
4971         return 1;
4972 }
4973
4974 /*
4975 Determine whether to accept a character string as a comparison operator.
4976 Return 1 if it's good, or 0 if it's bad.
4977
4978 We don't validate it for real.  We just make sure that it doesn't contain
4979 any semicolons or white space (with a special exception for the
4980 "SIMILAR TO" operator).  The idea is to block certain kinds of SQL
4981 injection.  If it has no semicolons or white space but it's still not a
4982 valid operator, then the database will complain.
4983
4984 Another approach would be to compare the string against a short list of
4985 approved operators.  We don't do that because we want to allow custom
4986 operators like ">100*", which would be difficult or impossible to
4987 express otherwise in a JSON query.
4988 */
4989 static int is_good_operator( const char* op ) {
4990         if( !op ) return 0;   // Sanity check
4991
4992         const char* s = op;
4993         while( *s ) {
4994                 if( isspace( (unsigned char) *s ) ) {
4995                         // Special exception for SIMILAR TO.  Someday we might make
4996                         // exceptions for IS DISTINCT FROM and IS NOT DISTINCT FROM.
4997                         if( !strcasecmp( op, "similar to" ) )
4998                                 return 1;
4999                         else
5000                                 return 0;
5001                 }
5002                 else if( ';' == *s )
5003                         return 0;
5004                 ++s;
5005         }
5006         return 1;
5007 }