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 struct ClassInfoStruct;
  33 typedef struct ClassInfoStruct ClassInfo;
  34
  35 #define ALIAS_STORE_SIZE 16
  36 #define CLASS_NAME_STORE_SIZE 16
  37
  38 struct ClassInfoStruct {
  39         char* alias;
  40         char* class_name;
  41         char* source_def;
  42         osrfHash* class_def;      // Points into IDL
  43         osrfHash* fields;         // Points into IDL
  44         osrfHash* links;          // Points into IDL
  45
  46         // The remaining members are private and internal.  Client code should not
  47         // access them directly.
  48
  49         ClassInfo* next;          // Supports linked list of joined classes
  50         int in_use;               // boolean
  51
  52         // We usually store the alias and class name in the following arrays, and
  53         // point the corresponding pointers at them.  When the string is too big
  54         // for the array (which will probably never happen in practice), we strdup it.
  55
  56         char alias_store[ ALIAS_STORE_SIZE + 1 ];
  57         char class_name_store[ CLASS_NAME_STORE_SIZE + 1 ];
  58 };
  59
  60 struct QueryFrameStruct;
  61 typedef struct QueryFrameStruct QueryFrame;
  62
  63 struct QueryFrameStruct {
  64         ClassInfo core;
  65         ClassInfo* join_list;  // linked list of classes joined to the core class
  66         QueryFrame* next;      // implements stack as linked list
  67         int in_use;            // boolean
  68 };
  69
  70 int osrfAppChildInit();
  71 int osrfAppInitialize();
  72 void osrfAppChildExit();
  73
  74 static int verifyObjectClass ( osrfMethodContext*, const jsonObject* );
  75
  76 int beginTransaction ( osrfMethodContext* );
  77 int commitTransaction ( osrfMethodContext* );
  78 int rollbackTransaction ( osrfMethodContext* );
  79
  80 int setSavepoint ( osrfMethodContext* );
  81 int releaseSavepoint ( osrfMethodContext* );
  82 int rollbackSavepoint ( osrfMethodContext* );
  83
  84 int doJSONSearch ( osrfMethodContext* );
  85
  86 int dispatchCRUDMethod ( osrfMethodContext* );
  87 static jsonObject* doCreate ( osrfMethodContext*, int* );
  88 static jsonObject* doRetrieve ( osrfMethodContext*, int* );
  89 static jsonObject* doUpdate ( osrfMethodContext*, int* );
  90 static jsonObject* doDelete ( osrfMethodContext*, int* );
  91 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
  92                 jsonObject* where_hash, jsonObject* query_hash, int* err );
  93 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result, osrfHash* );
  94 static jsonObject* oilsMakeJSONFromResult( dbi_result );
  95
  96 static char* searchSimplePredicate ( const char* op, const char* class_alias,
  97                                 osrfHash* field, const jsonObject* node );
  98 static char* searchFunctionPredicate ( const char*, osrfHash*, const jsonObject*, const char* );
  99 static char* searchFieldTransform ( const char*, osrfHash*, const jsonObject*);
 100 static char* searchFieldTransformPredicate ( const ClassInfo*, osrfHash*, const jsonObject*, const char* );
 101 static char* searchBETWEENPredicate ( const char*, osrfHash*, const jsonObject* );
 102 static char* searchINPredicate ( const char*, osrfHash*,
 103                                                                  jsonObject*, const char*, osrfMethodContext* );
 104 static char* searchPredicate ( const ClassInfo*, osrfHash*, jsonObject*, osrfMethodContext* );
 105 static char* searchJOIN ( const jsonObject*, const ClassInfo* left_info );
 106 static char* searchWHERE ( const jsonObject*, const ClassInfo*, int, osrfMethodContext* );
 107 static char* buildSELECT ( jsonObject*, jsonObject*, osrfHash*, osrfMethodContext* );
 108
 109 char* SELECT ( osrfMethodContext*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, jsonObject*, int );
 110
 111 void userDataFree( void* );
 112 static void sessionDataFree( char*, void* );
 113 static char* getSourceDefinition( osrfHash* );
 114 static int str_is_true( const char* str );
 115 static int obj_is_true( const jsonObject* obj );
 116 static const char* json_type( int code );
 117 static const char* get_primitive( osrfHash* field );
 118 static const char* get_datatype( osrfHash* field );
 119 static int is_identifier( const char* s);
 120 static int is_good_operator( const char* op );
 121 static void pop_query_frame( void );
 122 static void push_query_frame( void );
 123 static int add_query_core( const char* alias, const char* class_name );
 124 static ClassInfo* search_alias( const char* target );
 125 static ClassInfo* search_all_alias( const char* target );
 126 static ClassInfo* add_joined_class( const char* alias, const char* classname );
 127 static void clear_query_stack( void );
 128
 129 #ifdef PCRUD
 130 static jsonObject* verifyUserPCRUD( osrfMethodContext* );
 131 static int verifyObjectPCRUD( osrfMethodContext*, const jsonObject* );
 132 static char* org_tree_root( osrfMethodContext* ctx );
 133 static jsonObject* single_hash( const char* key, const char* value );
 134 #endif
 135
 136 static int child_initialized = 0;   /* boolean */
 137
 138 static dbi_conn writehandle; /* our MASTER db connection */
 139 static dbi_conn dbhandle; /* our CURRENT db connection */
 140 //static osrfHash * readHandles;
 141 static jsonObject* const jsonNULL = NULL; //
 142 static int max_flesh_depth = 100;
 143
 144 // The following points the top of a stack of QueryFrames.  It's a little
 145 // confusing because the top level of the query is at the bottom of the stack.
 146 static QueryFrame* curr_query = NULL;
 147
 148 /* called when this process is about to exit */
 149 void osrfAppChildExit() {
 150     osrfLogDebug(OSRF_LOG_MARK, "Child is exiting, disconnecting from database...");
 151
 152     int same = 0;
 153     if (writehandle == dbhandle) same = 1;
 154     if (writehandle) {
 155         dbi_conn_query(writehandle, "ROLLBACK;");
 156         dbi_conn_close(writehandle);
 157         writehandle = NULL;
 158     }
 159     if (dbhandle && !same)
 160         dbi_conn_close(dbhandle);
 161
 162     // XXX add cleanup of readHandles whenever that gets used
 163
 164     return;
 165 }
 166
 167 int osrfAppInitialize() {
 168
 169     osrfLogInfo(OSRF_LOG_MARK, "Initializing the CStore Server...");
 170     osrfLogInfo(OSRF_LOG_MARK, "Finding XML file...");
 171
 172     if (!oilsIDLInit( osrf_settings_host_value("/IDL") )) return 1; /* return non-zero to indicate error */
 173
 174     growing_buffer* method_name = buffer_init(64);
 175 #ifndef PCRUD
 176     // Generic search thingy
 177     buffer_add(method_name, MODULENAME);
 178         buffer_add(method_name, ".json_query");
 179         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 180                                                    "doJSONSearch", "", 1, OSRF_METHOD_STREAMING );
 181 #endif
 182
 183     // first we register all the transaction and savepoint methods
 184     buffer_reset(method_name);
 185         OSRF_BUFFER_ADD(method_name, MODULENAME);
 186         OSRF_BUFFER_ADD(method_name, ".transaction.begin");
 187         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 188                                                    "beginTransaction", "", 0, 0 );
 189
 190     buffer_reset(method_name);
 191         OSRF_BUFFER_ADD(method_name, MODULENAME);
 192         OSRF_BUFFER_ADD(method_name, ".transaction.commit");
 193         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 194                                                    "commitTransaction", "", 0, 0 );
 195
 196     buffer_reset(method_name);
 197         OSRF_BUFFER_ADD(method_name, MODULENAME);
 198         OSRF_BUFFER_ADD(method_name, ".transaction.rollback");
 199         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 200                                                    "rollbackTransaction", "", 0, 0 );
 201
 202     buffer_reset(method_name);
 203         OSRF_BUFFER_ADD(method_name, MODULENAME);
 204         OSRF_BUFFER_ADD(method_name, ".savepoint.set");
 205         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 206                                                    "setSavepoint", "", 1, 0 );
 207
 208     buffer_reset(method_name);
 209         OSRF_BUFFER_ADD(method_name, MODULENAME);
 210         OSRF_BUFFER_ADD(method_name, ".savepoint.release");
 211         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 212                                                    "releaseSavepoint", "", 1, 0 );
 213
 214     buffer_reset(method_name);
 215         OSRF_BUFFER_ADD(method_name, MODULENAME);
 216         OSRF_BUFFER_ADD(method_name, ".savepoint.rollback");
 217         osrfAppRegisterMethod( MODULENAME, OSRF_BUFFER_C_STR(method_name),
 218                                                    "rollbackSavepoint", "", 1, 0 );
 219
 220         static const char* global_method[] = {
 221                 "create",
 222                 "retrieve",
 223                 "update",
 224                 "delete",
 225                 "search",
 226                 "id_list"
 227         };
 228         const int global_method_count
 229                 = sizeof( global_method ) / sizeof ( global_method[0] );
 230
 231         unsigned long class_count = osrfHashGetCount( oilsIDL() );
 232         osrfLogDebug(OSRF_LOG_MARK, "%lu classes loaded", class_count );
 233         osrfLogDebug(OSRF_LOG_MARK,
 234                 "At most %lu methods will be generated",
 235                 (unsigned long) (class_count * global_method_count) );
 236
 237         osrfHashIterator* class_itr = osrfNewHashIterator( oilsIDL() );
 238         osrfHash* idlClass = NULL;
 239
 240         // For each class in IDL...
 241         while( (idlClass = osrfHashIteratorNext( class_itr ) ) ) {
 242
 243                 const char* classname = osrfHashIteratorKey( class_itr );
 244         osrfLogInfo(OSRF_LOG_MARK, "Generating class methods for %s", classname);
 245
 246         if (!osrfStringArrayContains( osrfHashGet(idlClass, "controller"), MODULENAME )) {
 247             osrfLogInfo(OSRF_LOG_MARK, "%s is not listed as a controller for %s, moving on", MODULENAME, classname);
 248             continue;
 249         }
 250
 251                 if ( str_is_true( osrfHashGet(idlClass, "virtual") ) ) {
 252                         osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
 253                         continue;
 254                 }
 255
 256                 // Look up some other attributes of the current class
 257                 const char* idlClass_fieldmapper = osrfHashGet(idlClass, "fieldmapper");
 258                 if( !idlClass_fieldmapper ) {
 259                         osrfLogDebug( OSRF_LOG_MARK, "Skipping class \"%s\"; no fieldmapper in IDL", classname );
 260                         continue;
 261                 }
 262
 263 #ifdef PCRUD
 264                 osrfHash* idlClass_permacrud = osrfHashGet(idlClass, "permacrud");
 265                 if (!idlClass_permacrud) {
 266                         osrfLogDebug( OSRF_LOG_MARK, "Skipping class \"%s\"; no permacrud in IDL", classname );
 267                         continue;
 268                 }
 269 #endif
 270                 const char* readonly = osrfHashGet(idlClass, "readonly");
 271
 272         int i;
 273         for( i = 0; i < global_method_count; ++i ) {  // for each global method
 274             const char* method_type = global_method[ i ];
 275             osrfLogDebug(OSRF_LOG_MARK,
 276                 "Using files to build %s class methods for %s", method_type, classname);
 277
 278 #ifdef PCRUD
 279             const char* tmp_method = method_type;
 280             if ( *tmp_method == 'i' || *tmp_method == 's') {
 281                 tmp_method = "retrieve";
 282             }
 283             if (!osrfHashGet( idlClass_permacrud, tmp_method )) continue;
 284 #endif
 285
 286             if (    str_is_true( readonly ) &&
 287                     ( *method_type == 'c' || *method_type == 'u' || *method_type == 'd')
 288                ) continue;
 289
 290             buffer_reset( method_name );
 291 #ifdef PCRUD
 292             buffer_fadd(method_name, "%s.%s.%s", MODULENAME, method_type, classname);
 293 #else
 294             char* st_tmp = NULL;
 295             char* part = NULL;
 296             char* _fm = strdup( idlClass_fieldmapper );
 297             part = strtok_r(_fm, ":", &st_tmp);
 298
 299             buffer_fadd(method_name, "%s.direct.%s", MODULENAME, part);
 300
 301             while ((part = strtok_r(NULL, ":", &st_tmp))) {
 302                                 OSRF_BUFFER_ADD_CHAR(method_name, '.');
 303                                 OSRF_BUFFER_ADD(method_name, part);
 304             }
 305                         OSRF_BUFFER_ADD_CHAR(method_name, '.');
 306                         OSRF_BUFFER_ADD(method_name, method_type);
 307             free(_fm);
 308 #endif
 309
 310             char* method = buffer_data(method_name);
 311
 312             int flags = 0;
 313             if (*method_type == 'i' || *method_type == 's') {
 314                 flags = flags | OSRF_METHOD_STREAMING;
 315             }
 316
 317                         osrfHash* method_meta = osrfNewHash();
 318                         osrfHashSet( method_meta, idlClass, "class");
 319                         osrfHashSet( method_meta, method, "methodname" );
 320                         osrfHashSet( method_meta, strdup(method_type), "methodtype" );
 321
 322                         osrfAppRegisterExtendedMethod(
 323                     MODULENAME,
 324                     method,
 325                     "dispatchCRUDMethod",
 326                     "",
 327                     1,
 328                     flags,
 329                     (void*)method_meta
 330                     );
 331
 332             free(method);
 333         } // end for each global method
 334     } // end for each class in IDL
 335
 336         buffer_free( method_name );
 337         osrfHashIteratorFree( class_itr );
 338
 339     return 0;
 340 }
 341
 342 static char* getSourceDefinition( osrfHash* class ) {
 343
 344         char* tabledef = osrfHashGet(class, "tablename");
 345
 346         if (tabledef) {
 347                 tabledef = strdup(tabledef);
 348         } else {
 349                 tabledef = osrfHashGet(class, "source_definition");
 350                 if( tabledef ) {
 351                         growing_buffer* tablebuf = buffer_init(128);
 352                         buffer_fadd( tablebuf, "(%s)", tabledef );
 353                         tabledef = buffer_release(tablebuf);
 354                 } else {
 355                         const char* classname = osrfHashGet( class, "classname" );
 356                         if( !classname )
 357                                 classname = "???";
 358                         osrfLogError(
 359                                 OSRF_LOG_MARK,
 360                                 "%s ERROR No tablename or source_definition for class \"%s\"",
 361                                 MODULENAME,
 362                                 classname
 363                         );
 364                 }
 365         }
 366
 367         return tabledef;
 368 }
 369
 370 /**
 371  * Connects to the database
 372  */
 373 int osrfAppChildInit() {
 374
 375     osrfLogDebug(OSRF_LOG_MARK, "Attempting to initialize libdbi...");
 376     dbi_initialize(NULL);
 377     osrfLogDebug(OSRF_LOG_MARK, "... libdbi initialized.");
 378
 379     char* driver        = osrf_settings_host_value("/apps/%s/app_settings/driver", MODULENAME);
 380     char* user  = osrf_settings_host_value("/apps/%s/app_settings/database/user", MODULENAME);
 381     char* host  = osrf_settings_host_value("/apps/%s/app_settings/database/host", MODULENAME);
 382     char* port  = osrf_settings_host_value("/apps/%s/app_settings/database/port", MODULENAME);
 383     char* db    = osrf_settings_host_value("/apps/%s/app_settings/database/db", MODULENAME);
 384     char* pw    = osrf_settings_host_value("/apps/%s/app_settings/database/pw", MODULENAME);
 385     char* md    = osrf_settings_host_value("/apps/%s/app_settings/max_query_recursion", MODULENAME);
 386
 387     osrfLogDebug(OSRF_LOG_MARK, "Attempting to load the database driver [%s]...", driver);
 388     writehandle = dbi_conn_new(driver);
 389
 390     if(!writehandle) {
 391         osrfLogError(OSRF_LOG_MARK, "Error loading database driver [%s]", driver);
 392         return -1;
 393     }
 394     osrfLogDebug(OSRF_LOG_MARK, "Database driver [%s] seems OK", driver);
 395
 396     osrfLogInfo(OSRF_LOG_MARK, "%s connecting to database.  host=%s, "
 397             "port=%s, user=%s, pw=%s, db=%s", MODULENAME, host, port, user, pw, db );
 398
 399     if(host) dbi_conn_set_option(writehandle, "host", host );
 400     if(port) dbi_conn_set_option_numeric( writehandle, "port", atoi(port) );
 401     if(user) dbi_conn_set_option(writehandle, "username", user);
 402     if(pw) dbi_conn_set_option(writehandle, "password", pw );
 403     if(db) dbi_conn_set_option(writehandle, "dbname", db );
 404
 405     if(md) max_flesh_depth = atoi(md);
 406     if(max_flesh_depth < 0) max_flesh_depth = 1;
 407     if(max_flesh_depth > 1000) max_flesh_depth = 1000;
 408
 409     free(user);
 410     free(host);
 411     free(port);
 412     free(db);
 413     free(pw);
 414
 415     const char* err;
 416     if (dbi_conn_connect(writehandle) < 0) {
 417         sleep(1);
 418         if (dbi_conn_connect(writehandle) < 0) {
 419             dbi_conn_error(writehandle, &err);
 420             osrfLogError( OSRF_LOG_MARK, "Error connecting to database: %s", err);
 421             return -1;
 422         }
 423     }
 424
 425     osrfLogInfo(OSRF_LOG_MARK, "%s successfully connected to the database", MODULENAME);
 426
 427         osrfHashIterator* class_itr = osrfNewHashIterator( oilsIDL() );
 428         osrfHash* class = NULL;
 429
 430         while( (class = osrfHashIteratorNext( class_itr ) ) ) {
 431                 const char* classname = osrfHashIteratorKey( class_itr );
 432         osrfHash* fields = osrfHashGet( class, "fields" );
 433
 434                 if( str_is_true( osrfHashGet(class, "virtual") ) ) {
 435                         osrfLogDebug(OSRF_LOG_MARK, "Class %s is virtual, skipping", classname );
 436                         continue;
 437                 }
 438
 439         char* tabledef = getSourceDefinition(class);
 440                 if( !tabledef )
 441                         tabledef = strdup( "(null)" );
 442
 443         growing_buffer* sql_buf = buffer_init(32);
 444         buffer_fadd( sql_buf, "SELECT * FROM %s AS x WHERE 1=0;", tabledef );
 445
 446         free(tabledef);
 447
 448         char* sql = buffer_release(sql_buf);
 449         osrfLogDebug(OSRF_LOG_MARK, "%s Investigatory SQL = %s", MODULENAME, sql);
 450
 451         dbi_result result = dbi_conn_query(writehandle, sql);
 452         free(sql);
 453
 454         if (result) {
 455
 456             int columnIndex = 1;
 457             const char* columnName;
 458             osrfHash* _f;
 459             while( (columnName = dbi_result_get_field_name(result, columnIndex)) ) {
 460
 461                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
 462
 463                 /* fetch the fieldmapper index */
 464                 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
 465
 466                                         osrfLogDebug(OSRF_LOG_MARK, "Found [%s] in IDL hash...", (char*)columnName);
 467
 468                                         /* determine the field type and storage attributes */
 469
 470                                         switch( dbi_result_get_field_type_idx(result, columnIndex) ) {
 471
 472                                                 case DBI_TYPE_INTEGER : {
 473
 474                                                         if ( !osrfHashGet(_f, "primitive") )
 475                                                                 osrfHashSet(_f,"number", "primitive");
 476
 477                                                         int attr = dbi_result_get_field_attribs_idx(result, columnIndex);
 478                                                         if( attr & DBI_INTEGER_SIZE8 )
 479                                                                 osrfHashSet(_f,"INT8", "datatype");
 480                                                         else
 481                                                                 osrfHashSet(_f,"INT", "datatype");
 482                                                         break;
 483                                                 }
 484                         case DBI_TYPE_DECIMAL :
 485                             if ( !osrfHashGet(_f, "primitive") )
 486                                 osrfHashSet(_f,"number", "primitive");
 487
 488                             osrfHashSet(_f,"NUMERIC", "datatype");
 489                             break;
 490
 491                         case DBI_TYPE_STRING :
 492                             if ( !osrfHashGet(_f, "primitive") )
 493                                 osrfHashSet(_f,"string", "primitive");
 494                             osrfHashSet(_f,"TEXT", "datatype");
 495                             break;
 496
 497                         case DBI_TYPE_DATETIME :
 498                             if ( !osrfHashGet(_f, "primitive") )
 499                                 osrfHashSet(_f,"string", "primitive");
 500
 501                             osrfHashSet(_f,"TIMESTAMP", "datatype");
 502                             break;
 503
 504                         case DBI_TYPE_BINARY :
 505                             if ( !osrfHashGet(_f, "primitive") )
 506                                 osrfHashSet(_f,"string", "primitive");
 507
 508                             osrfHashSet(_f,"BYTEA", "datatype");
 509                     }
 510
 511                     osrfLogDebug(
 512                             OSRF_LOG_MARK,
 513                             "Setting [%s] to primitive [%s] and datatype [%s]...",
 514                             (char*)columnName,
 515                             osrfHashGet(_f, "primitive"),
 516                             osrfHashGet(_f, "datatype")
 517                             );
 518                 }
 519                                 ++columnIndex;
 520                         } // end while loop for traversing result
 521                         dbi_result_free(result);
 522                 } else {
 523                         osrfLogDebug(OSRF_LOG_MARK, "No data found for class [%s]...", (char*)classname);
 524                 }
 525         } // end for each class in IDL
 526
 527         osrfHashIteratorFree( class_itr );
 528         child_initialized = 1;
 529     return 0;
 530 }
 531
 532 /*
 533   This function is a sleazy hack intended *only* for testing and
 534   debugging.  Any real server process should initialize the
 535   database connection by calling osrfAppChildInit().
 536 */
 537 void set_cstore_dbi_conn( dbi_conn conn ) {
 538         dbhandle = writehandle = conn;
 539 }
 540
 541 void userDataFree( void* blob ) {
 542     osrfHashFree( (osrfHash*)blob );
 543     return;
 544 }
 545
 546 static void sessionDataFree( char* key, void* item ) {
 547     if (!(strcmp(key,"xact_id"))) {
 548         if (writehandle)
 549             dbi_conn_query(writehandle, "ROLLBACK;");
 550         free(item);
 551     }
 552
 553     return;
 554 }
 555
 556 int beginTransaction ( osrfMethodContext* ctx ) {
 557         if(osrfMethodVerifyContext( ctx )) {
 558                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 559                 return -1;
 560         }
 561
 562 #ifdef PCRUD
 563     jsonObject* user = verifyUserPCRUD( ctx );
 564     if (!user) return -1;
 565     jsonObjectFree(user);
 566 #endif
 567
 568     dbi_result result = dbi_conn_query(writehandle, "START TRANSACTION;");
 569     if (!result) {
 570         osrfLogError(OSRF_LOG_MARK, "%s: Error starting transaction", MODULENAME );
 571         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error starting transaction" );
 572         return -1;
 573     } else {
 574         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 575         osrfAppRespondComplete( ctx, ret );
 576         jsonObjectFree(ret);
 577
 578         if (!ctx->session->userData) {
 579             ctx->session->userData = osrfNewHash();
 580             osrfHashSetCallback((osrfHash*)ctx->session->userData, &sessionDataFree);
 581         }
 582
 583         osrfHashSet( (osrfHash*)ctx->session->userData, strdup( ctx->session->session_id ), "xact_id" );
 584         ctx->session->userDataFree = &userDataFree;
 585
 586     }
 587     return 0;
 588 }
 589
 590 int setSavepoint ( osrfMethodContext* ctx ) {
 591         if(osrfMethodVerifyContext( ctx )) {
 592                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 593                 return -1;
 594         }
 595
 596     int spNamePos = 0;
 597 #ifdef PCRUD
 598     spNamePos = 1;
 599     jsonObject* user = verifyUserPCRUD( ctx );
 600     if (!user) return -1;
 601     jsonObjectFree(user);
 602 #endif
 603
 604     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 605         osrfAppSessionStatus(
 606                 ctx->session,
 607                 OSRF_STATUS_INTERNALSERVERERROR,
 608                 "osrfMethodException",
 609                 ctx->request,
 610                 "No active transaction -- required for savepoints"
 611                 );
 612         return -1;
 613     }
 614
 615         const char* spName = jsonObjectGetString(jsonObjectGetIndex(ctx->params, spNamePos));
 616
 617         dbi_result result = dbi_conn_queryf(writehandle, "SAVEPOINT \"%s\";", spName);
 618         if (!result) {
 619                 osrfLogError(
 620                         OSRF_LOG_MARK,
 621                         "%s: Error creating savepoint %s in transaction %s",
 622                         MODULENAME,
 623                         spName,
 624                         osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 625                 );
 626                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 627                                 "osrfMethodException", ctx->request, "Error creating savepoint" );
 628                 return -1;
 629         } else {
 630                 jsonObject* ret = jsonNewObject(spName);
 631                 osrfAppRespondComplete( ctx, ret );
 632                 jsonObjectFree(ret);
 633         }
 634         return 0;
 635 }
 636
 637 int releaseSavepoint ( osrfMethodContext* ctx ) {
 638         if(osrfMethodVerifyContext( ctx )) {
 639                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 640                 return -1;
 641         }
 642
 643         int spNamePos = 0;
 644 #ifdef PCRUD
 645     spNamePos = 1;
 646     jsonObject* user = verifyUserPCRUD( ctx );
 647     if (!user) return -1;
 648     jsonObjectFree(user);
 649 #endif
 650
 651     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 652         osrfAppSessionStatus(
 653                 ctx->session,
 654                 OSRF_STATUS_INTERNALSERVERERROR,
 655                 "osrfMethodException",
 656                 ctx->request,
 657                 "No active transaction -- required for savepoints"
 658                 );
 659         return -1;
 660     }
 661
 662         const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
 663
 664     dbi_result result = dbi_conn_queryf(writehandle, "RELEASE SAVEPOINT \"%s\";", spName);
 665     if (!result) {
 666         osrfLogError(
 667                 OSRF_LOG_MARK,
 668                 "%s: Error releasing savepoint %s in transaction %s",
 669                 MODULENAME,
 670                 spName,
 671                 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 672                 );
 673                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 674                                 "osrfMethodException", ctx->request, "Error releasing savepoint" );
 675         return -1;
 676     } else {
 677         jsonObject* ret = jsonNewObject(spName);
 678         osrfAppRespondComplete( ctx, ret );
 679         jsonObjectFree(ret);
 680     }
 681     return 0;
 682 }
 683
 684 int rollbackSavepoint ( osrfMethodContext* ctx ) {
 685         if(osrfMethodVerifyContext( ctx )) {
 686                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 687                 return -1;
 688         }
 689
 690         int spNamePos = 0;
 691 #ifdef PCRUD
 692     spNamePos = 1;
 693     jsonObject* user = verifyUserPCRUD( ctx );
 694     if (!user) return -1;
 695     jsonObjectFree(user);
 696 #endif
 697
 698     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 699         osrfAppSessionStatus(
 700                 ctx->session,
 701                 OSRF_STATUS_INTERNALSERVERERROR,
 702                 "osrfMethodException",
 703                 ctx->request,
 704                 "No active transaction -- required for savepoints"
 705                 );
 706         return -1;
 707     }
 708
 709         const char* spName = jsonObjectGetString( jsonObjectGetIndex(ctx->params, spNamePos) );
 710
 711     dbi_result result = dbi_conn_queryf(writehandle, "ROLLBACK TO SAVEPOINT \"%s\";", spName);
 712     if (!result) {
 713         osrfLogError(
 714                 OSRF_LOG_MARK,
 715                 "%s: Error rolling back savepoint %s in transaction %s",
 716                 MODULENAME,
 717                 spName,
 718                 osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )
 719                 );
 720                 osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR,
 721                                 "osrfMethodException", ctx->request, "Error rolling back savepoint" );
 722         return -1;
 723     } else {
 724         jsonObject* ret = jsonNewObject(spName);
 725         osrfAppRespondComplete( ctx, ret );
 726         jsonObjectFree(ret);
 727     }
 728     return 0;
 729 }
 730
 731 int commitTransaction ( osrfMethodContext* ctx ) {
 732         if(osrfMethodVerifyContext( ctx )) {
 733                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 734                 return -1;
 735         }
 736
 737 #ifdef PCRUD
 738     jsonObject* user = verifyUserPCRUD( ctx );
 739     if (!user) return -1;
 740     jsonObjectFree(user);
 741 #endif
 742
 743     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 744         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "No active transaction to commit" );
 745         return -1;
 746     }
 747
 748     dbi_result result = dbi_conn_query(writehandle, "COMMIT;");
 749     if (!result) {
 750         osrfLogError(OSRF_LOG_MARK, "%s: Error committing transaction", MODULENAME );
 751         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error committing transaction" );
 752         return -1;
 753     } else {
 754         osrfHashRemove(ctx->session->userData, "xact_id");
 755         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 756         osrfAppRespondComplete( ctx, ret );
 757         jsonObjectFree(ret);
 758     }
 759     return 0;
 760 }
 761
 762 int rollbackTransaction ( osrfMethodContext* ctx ) {
 763         if(osrfMethodVerifyContext( ctx )) {
 764                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 765                 return -1;
 766         }
 767
 768 #ifdef PCRUD
 769     jsonObject* user = verifyUserPCRUD( ctx );
 770     if (!user) return -1;
 771     jsonObjectFree(user);
 772 #endif
 773
 774     if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
 775         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "No active transaction to roll back" );
 776         return -1;
 777     }
 778
 779     dbi_result result = dbi_conn_query(writehandle, "ROLLBACK;");
 780     if (!result) {
 781         osrfLogError(OSRF_LOG_MARK, "%s: Error rolling back transaction", MODULENAME );
 782         osrfAppSessionStatus( ctx->session, OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, "Error rolling back transaction" );
 783         return -1;
 784     } else {
 785         osrfHashRemove(ctx->session->userData, "xact_id");
 786         jsonObject* ret = jsonNewObject(ctx->session->session_id);
 787         osrfAppRespondComplete( ctx, ret );
 788         jsonObjectFree(ret);
 789     }
 790     return 0;
 791 }
 792
 793 int dispatchCRUDMethod ( osrfMethodContext* ctx ) {
 794         if(osrfMethodVerifyContext( ctx )) {
 795                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
 796                 return -1;
 797         }
 798
 799         osrfHash* meta = (osrfHash*) ctx->method->userData;
 800     osrfHash* class_obj = osrfHashGet( meta, "class" );
 801
 802     int err = 0;
 803
 804     const char* methodtype = osrfHashGet(meta, "methodtype");
 805     jsonObject * obj = NULL;
 806
 807     if (!strcmp(methodtype, "create")) {
 808         obj = doCreate(ctx, &err);
 809         osrfAppRespondComplete( ctx, obj );
 810     }
 811     else if (!strcmp(methodtype, "retrieve")) {
 812         obj = doRetrieve(ctx, &err);
 813         osrfAppRespondComplete( ctx, obj );
 814     }
 815     else if (!strcmp(methodtype, "update")) {
 816         obj = doUpdate(ctx, &err);
 817         osrfAppRespondComplete( ctx, obj );
 818     }
 819     else if (!strcmp(methodtype, "delete")) {
 820         obj = doDelete(ctx, &err);
 821         osrfAppRespondComplete( ctx, obj );
 822     }
 823     else if (!strcmp(methodtype, "search")) {
 824
 825                 jsonObject* where_clause;
 826                 jsonObject* rest_of_query;
 827
 828 #ifdef PCRUD
 829                 where_clause  = jsonObjectGetIndex( ctx->params, 1 );
 830                 rest_of_query = jsonObjectGetIndex( ctx->params, 2 );
 831 #else
 832                 where_clause  = jsonObjectGetIndex( ctx->params, 0 );
 833                 rest_of_query = jsonObjectGetIndex( ctx->params, 1 );
 834 #endif
 835
 836                 obj = doFieldmapperSearch( ctx, class_obj, where_clause, rest_of_query, &err );
 837
 838                 if(err) return err;
 839
 840                 jsonObject* cur = 0;
 841                 unsigned long res_idx = 0;
 842                 while((cur = jsonObjectGetIndex( obj, res_idx++ ) )) {
 843 #ifdef PCRUD
 844                         if(!verifyObjectPCRUD(ctx, cur)) continue;
 845 #endif
 846                         osrfAppRespond( ctx, cur );
 847                 }
 848                 osrfAppRespondComplete( ctx, NULL );
 849
 850         } else if (!strcmp(methodtype, "id_list")) {
 851
 852                 jsonObject* where_clause;
 853                 jsonObject* rest_of_query;
 854
 855                 // We use the where clause without change.  But we need
 856                 // to massage the rest of the query, so we work with a copy
 857                 // of it instead of modifying the original.
 858 #ifdef PCRUD
 859                 where_clause  = jsonObjectGetIndex( ctx->params, 1 );
 860                 rest_of_query = jsonObjectClone( jsonObjectGetIndex( ctx->params, 2 ) );
 861 #else
 862                 where_clause  = jsonObjectGetIndex( ctx->params, 0 );
 863                 rest_of_query = jsonObjectClone( jsonObjectGetIndex( ctx->params, 1 ) );
 864 #endif
 865
 866                 if ( rest_of_query ) {
 867                         jsonObjectRemoveKey( rest_of_query, "select" );
 868                         jsonObjectRemoveKey( rest_of_query, "no_i18n" );
 869                         jsonObjectRemoveKey( rest_of_query, "flesh" );
 870                         jsonObjectRemoveKey( rest_of_query, "flesh_columns" );
 871                 } else {
 872                         rest_of_query = jsonNewObjectType( JSON_HASH );
 873                 }
 874
 875                 jsonObjectSetKey( rest_of_query, "no_i18n", jsonNewBoolObject( 1 ) );
 876
 877                 // Build a SELECT list containing just the primary key,
 878                 // i.e. like { "classname":["keyname"] }
 879                 jsonObject* col_list_obj = jsonNewObjectType( JSON_ARRAY );
 880                 jsonObjectPush( col_list_obj,     // Load array with name of primary key
 881                         jsonNewObject( osrfHashGet( class_obj, "primarykey" ) ) );
 882                 jsonObject* select_clause = jsonNewObjectType( JSON_HASH );
 883                 jsonObjectSetKey( select_clause, osrfHashGet( class_obj, "classname" ), col_list_obj );
 884
 885                 jsonObjectSetKey( rest_of_query, "select", select_clause );
 886
 887                 obj = doFieldmapperSearch( ctx, class_obj, where_clause, rest_of_query, &err );
 888
 889                 jsonObjectFree( rest_of_query );
 890                 if(err) return err;
 891
 892                 jsonObject* cur;
 893                 unsigned long res_idx = 0;
 894                 while((cur = jsonObjectGetIndex( obj, res_idx++ ) )) {
 895 #ifdef PCRUD
 896                         if(!verifyObjectPCRUD(ctx, cur)) continue;
 897 #endif
 898                         osrfAppRespond(
 899                                 ctx,
 900                                 oilsFMGetObject( cur, osrfHashGet( class_obj, "primarykey" ) )
 901                                 );
 902                 }
 903                 osrfAppRespondComplete( ctx, NULL );
 904
 905     } else {
 906         osrfAppRespondComplete( ctx, obj );
 907     }
 908
 909     jsonObjectFree(obj);
 910
 911     return err;
 912 }
 913
 914 static int verifyObjectClass ( osrfMethodContext* ctx, const jsonObject* param ) {
 915
 916     int ret = 1;
 917     osrfHash* meta = (osrfHash*) ctx->method->userData;
 918     osrfHash* class = osrfHashGet( meta, "class" );
 919
 920     if (!param->classname || (strcmp( osrfHashGet(class, "classname"), param->classname ))) {
 921
 922                 const char* temp_classname = param->classname;
 923                 if( ! temp_classname )
 924                         temp_classname = "(null)";
 925
 926         growing_buffer* msg = buffer_init(128);
 927         buffer_fadd(
 928                 msg,
 929                 "%s: %s method for type %s was passed a %s",
 930                 MODULENAME,
 931                 osrfHashGet(meta, "methodtype"),
 932                 osrfHashGet(class, "classname"),
 933                 temp_classname
 934                 );
 935
 936         char* m = buffer_release(msg);
 937         osrfAppSessionStatus( ctx->session, OSRF_STATUS_BADREQUEST, "osrfMethodException", ctx->request, m );
 938
 939         free(m);
 940
 941         return 0;
 942     }
 943
 944 #ifdef PCRUD
 945     ret = verifyObjectPCRUD( ctx, param );
 946 #endif
 947
 948     return ret;
 949 }
 950
 951 #ifdef PCRUD
 952
 953 static jsonObject* verifyUserPCRUD( osrfMethodContext* ctx ) {
 954         const char* auth = jsonObjectGetString( jsonObjectGetIndex( ctx->params, 0 ) );
 955     jsonObject* auth_object = jsonNewObject(auth);
 956     jsonObject* user = oilsUtilsQuickReq("open-ils.auth","open-ils.auth.session.retrieve", auth_object);
 957     jsonObjectFree(auth_object);
 958
 959     if (!user->classname || strcmp(user->classname, "au")) {
 960
 961         growing_buffer* msg = buffer_init(128);
 962         buffer_fadd(
 963             msg,
 964             "%s: permacrud received a bad auth token: %s",
 965             MODULENAME,
 966             auth
 967         );
 968
 969         char* m = buffer_release(msg);
 970         osrfAppSessionStatus( ctx->session, OSRF_STATUS_UNAUTHORIZED, "osrfMethodException", ctx->request, m );
 971
 972         free(m);
 973         jsonObjectFree(user);
 974         user = jsonNULL;
 975     }
 976
 977     return user;
 978
 979 }
 980
 981 static int verifyObjectPCRUD (  osrfMethodContext* ctx, const jsonObject* obj ) {
 982
 983         dbhandle = writehandle;
 984
 985         osrfHash* method_metadata = (osrfHash*) ctx->method->userData;
 986         osrfHash* class = osrfHashGet( method_metadata, "class" );
 987         const char* method_type = osrfHashGet( method_metadata, "methodtype" );
 988         int fetch = 0;
 989
 990         if ( ( *method_type == 's' || *method_type == 'i' ) ) {
 991                 method_type = "retrieve"; // search and id_list are equivalant to retrieve for this
 992         } else if ( *method_type == 'u' || *method_type == 'd' ) {
 993                 fetch = 1; // MUST go to the db for the object for update and delete
 994         }
 995
 996         osrfHash* pcrud = osrfHashGet( osrfHashGet(class, "permacrud"), method_type );
 997
 998     if (!pcrud) {
 999         // No permacrud for this method type on this class
1000
1001         growing_buffer* msg = buffer_init(128);
1002         buffer_fadd(
1003             msg,
1004             "%s: %s on class %s has no permacrud IDL entry",
1005             MODULENAME,
1006             osrfHashGet(method_metadata, "methodtype"),
1007             osrfHashGet(class, "classname")
1008         );
1009
1010         char* m = buffer_release(msg);
1011         osrfAppSessionStatus( ctx->session, OSRF_STATUS_FORBIDDEN, "osrfMethodException", ctx->request, m );
1012
1013         free(m);
1014
1015         return 0;
1016     }
1017
1018     jsonObject* user = verifyUserPCRUD( ctx );
1019     if (!user) return 0;
1020
1021     int userid = atoi( oilsFMGetString( user, "id" ) );
1022     jsonObjectFree(user);
1023
1024     osrfStringArray* permission = osrfHashGet(pcrud, "permission");
1025     osrfStringArray* local_context = osrfHashGet(pcrud, "local_context");
1026     osrfHash* foreign_context = osrfHashGet(pcrud, "foreign_context");
1027
1028     osrfStringArray* context_org_array = osrfNewStringArray(1);
1029
1030     int err = 0;
1031     char* pkey_value = NULL;
1032         if ( str_is_true( osrfHashGet(pcrud, "global_required") ) ) {
1033                 osrfLogDebug( OSRF_LOG_MARK, "global-level permissions required, fetching top of the org tree" );
1034
1035                 // check for perm at top of org tree
1036                 char* org_tree_root_id = org_tree_root( ctx );
1037                 if( org_tree_root_id ) {
1038                         osrfStringArrayAdd( context_org_array, org_tree_root_id );
1039                         osrfLogDebug( OSRF_LOG_MARK, "top of the org tree is %s", org_tree_root_id );
1040                 } else  {
1041                         osrfStringArrayFree( context_org_array );
1042                         return 0;
1043                 }
1044
1045         } else {
1046             osrfLogDebug( OSRF_LOG_MARK, "global-level permissions not required, fetching context org ids" );
1047             const char* pkey = osrfHashGet(class, "primarykey");
1048         jsonObject *param = NULL;
1049
1050         if (obj->classname) {
1051             pkey_value = oilsFMGetString( obj, pkey );
1052             if (!fetch) param = jsonObjectClone(obj);
1053                 osrfLogDebug( OSRF_LOG_MARK, "Object supplied, using primary key value of %s", pkey_value );
1054         } else {
1055             pkey_value = jsonObjectToSimpleString( obj );
1056             fetch = 1;
1057                 osrfLogDebug( OSRF_LOG_MARK, "Object not supplied, using primary key value of %s and retrieving from the database", pkey_value );
1058         }
1059
1060                 if (fetch) {
1061                         jsonObject* _tmp_params = single_hash( pkey, pkey_value );
1062                         jsonObject* _list = doFieldmapperSearch( ctx, class, _tmp_params, NULL, &err );
1063                         jsonObjectFree(_tmp_params);
1064
1065                         param = jsonObjectExtractIndex(_list, 0);
1066                         jsonObjectFree(_list);
1067                 }
1068
1069         if (!param) {
1070             osrfLogDebug( OSRF_LOG_MARK, "Object not found in the database with primary key %s of %s", pkey, pkey_value );
1071
1072             growing_buffer* msg = buffer_init(128);
1073             buffer_fadd(
1074                 msg,
1075                 "%s: no object found with primary key %s of %s",
1076                 MODULENAME,
1077                 pkey,
1078                 pkey_value
1079             );
1080
1081             char* m = buffer_release(msg);
1082             osrfAppSessionStatus(
1083                 ctx->session,
1084                 OSRF_STATUS_INTERNALSERVERERROR,
1085                 "osrfMethodException",
1086                 ctx->request,
1087                 m
1088             );
1089
1090             free(m);
1091             if (pkey_value) free(pkey_value);
1092
1093             return 0;
1094         }
1095
1096         if (local_context->size > 0) {
1097                 osrfLogDebug( OSRF_LOG_MARK, "%d class-local context field(s) specified", local_context->size);
1098             int i = 0;
1099             char* lcontext = NULL;
1100             while ( (lcontext = osrfStringArrayGetString(local_context, i++)) ) {
1101                 osrfStringArrayAdd( context_org_array, oilsFMGetString( param, lcontext ) );
1102                     osrfLogDebug(
1103                     OSRF_LOG_MARK,
1104                     "adding class-local field %s (value: %s) to the context org list",
1105                     lcontext,
1106                     osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1107                 );
1108             }
1109         }
1110
1111
1112                 if (foreign_context) {
1113                         unsigned long class_count = osrfHashGetCount( foreign_context );
1114                         osrfLogDebug( OSRF_LOG_MARK, "%d foreign context classes(s) specified", class_count);
1115
1116                         if (class_count > 0) {
1117
1118                                 osrfHash* fcontext = NULL;
1119                                 osrfHashIterator* class_itr = osrfNewHashIterator( foreign_context );
1120                                 while( (fcontext = osrfHashIteratorNext( class_itr ) ) ) {
1121                                         const char* class_name = osrfHashIteratorKey( class_itr );
1122                                         osrfHash* fcontext = osrfHashGet(foreign_context, class_name);
1123
1124                         osrfLogDebug(
1125                         OSRF_LOG_MARK,
1126                         "%d foreign context fields(s) specified for class %s",
1127                         ((osrfStringArray*)osrfHashGet(fcontext,"context"))->size,
1128                         class_name
1129                     );
1130
1131                     char* foreign_pkey = osrfHashGet(fcontext, "field");
1132                     char* foreign_pkey_value = oilsFMGetString(param, osrfHashGet(fcontext, "fkey"));
1133
1134                                         jsonObject* _tmp_params = single_hash( foreign_pkey, foreign_pkey_value );
1135
1136                                         jsonObject* _list = doFieldmapperSearch(
1137                                                 ctx, osrfHashGet( oilsIDL(), class_name ), _tmp_params, NULL, &err );
1138
1139                     jsonObject* _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1140                     jsonObjectFree(_tmp_params);
1141                     jsonObjectFree(_list);
1142
1143                     osrfStringArray* jump_list = osrfHashGet(fcontext, "jump");
1144
1145                     if (_fparam && jump_list) {
1146                         char* flink = NULL;
1147                         int k = 0;
1148                         while ( (flink = osrfStringArrayGetString(jump_list, k++)) && _fparam ) {
1149                             free(foreign_pkey_value);
1150
1151                             osrfHash* foreign_link_hash = oilsIDLFindPath( "/%s/links/%s", _fparam->classname, flink );
1152
1153                                                         foreign_pkey_value = oilsFMGetString(_fparam, flink);
1154                                                         foreign_pkey = osrfHashGet( foreign_link_hash, "key" );
1155
1156                                                         _tmp_params = single_hash( foreign_pkey, foreign_pkey_value );
1157
1158                                                         _list = doFieldmapperSearch(
1159                                                                 ctx,
1160                                                                 osrfHashGet( oilsIDL(), osrfHashGet( foreign_link_hash, "class" ) ),
1161                                                                 _tmp_params,
1162                                                                 NULL,
1163                                                                 &err
1164                                                         );
1165
1166                             _fparam = jsonObjectClone(jsonObjectGetIndex(_list, 0));
1167                             jsonObjectFree(_tmp_params);
1168                             jsonObjectFree(_list);
1169                         }
1170                     }
1171
1172
1173                     if (!_fparam) {
1174
1175                         growing_buffer* msg = buffer_init(128);
1176                         buffer_fadd(
1177                             msg,
1178                             "%s: no object found with primary key %s of %s",
1179                             MODULENAME,
1180                             foreign_pkey,
1181                             foreign_pkey_value
1182                         );
1183
1184                         char* m = buffer_release(msg);
1185                         osrfAppSessionStatus(
1186                             ctx->session,
1187                             OSRF_STATUS_INTERNALSERVERERROR,
1188                             "osrfMethodException",
1189                             ctx->request,
1190                             m
1191                         );
1192
1193                         free(m);
1194                         osrfHashIteratorFree(class_itr);
1195                         free(foreign_pkey_value);
1196                         jsonObjectFree(param);
1197
1198                         return 0;
1199                     }
1200
1201                     free(foreign_pkey_value);
1202
1203                     int j = 0;
1204                     char* foreign_field = NULL;
1205                     while ( (foreign_field = osrfStringArrayGetString(osrfHashGet(fcontext,"context"), j++)) ) {
1206                         osrfStringArrayAdd( context_org_array, oilsFMGetString( _fparam, foreign_field ) );
1207                             osrfLogDebug(
1208                             OSRF_LOG_MARK,
1209                             "adding foreign class %s field %s (value: %s) to the context org list",
1210                             class_name,
1211                             foreign_field,
1212                             osrfStringArrayGetString(context_org_array, context_org_array->size - 1)
1213                         );
1214                                         }
1215
1216                                         jsonObjectFree(_fparam);
1217                                 }
1218
1219                                 osrfHashIteratorFree( class_itr );
1220                         }
1221                 }
1222
1223                 jsonObjectFree(param);
1224         }
1225
1226     char* context_org = NULL;
1227     char* perm = NULL;
1228     int OK = 0;
1229
1230     if (permission->size == 0) {
1231             osrfLogDebug( OSRF_LOG_MARK, "No permission specified for this action, passing through" );
1232         OK = 1;
1233     }
1234
1235     int i = 0;
1236     while ( (perm = osrfStringArrayGetString(permission, i++)) ) {
1237         int j = 0;
1238         while ( (context_org = osrfStringArrayGetString(context_org_array, j++)) ) {
1239             dbi_result result;
1240
1241             if (pkey_value) {
1242                     osrfLogDebug(
1243                     OSRF_LOG_MARK,
1244                     "Checking object permission [%s] for user %d on object %s (class %s) at org %d",
1245                     perm,
1246                     userid,
1247                     pkey_value,
1248                     osrfHashGet(class, "classname"),
1249                     atoi(context_org)
1250                 );
1251
1252                 result = dbi_conn_queryf(
1253                     writehandle,
1254                     "SELECT permission.usr_has_object_perm(%d, '%s', '%s', '%s', %d) AS has_perm;",
1255                     userid,
1256                     perm,
1257                     osrfHashGet(class, "classname"),
1258                     pkey_value,
1259                     atoi(context_org)
1260                 );
1261
1262                 if (result) {
1263                     osrfLogDebug(
1264                         OSRF_LOG_MARK,
1265                         "Received a result for object permission [%s] for user %d on object %s (class %s) at org %d",
1266                         perm,
1267                         userid,
1268                         pkey_value,
1269                         osrfHashGet(class, "classname"),
1270                         atoi(context_org)
1271                     );
1272
1273                     if (dbi_result_first_row(result)) {
1274                         jsonObject* return_val = oilsMakeJSONFromResult( result );
1275                                                 const char* has_perm = jsonObjectGetString( jsonObjectGetKeyConst(return_val, "has_perm") );
1276
1277                             osrfLogDebug(
1278                             OSRF_LOG_MARK,
1279                             "Status of object permission [%s] for user %d on object %s (class %s) at org %d is %s",
1280                             perm,
1281                             userid,
1282                             pkey_value,
1283                             osrfHashGet(class, "classname"),
1284                             atoi(context_org),
1285                             has_perm
1286                         );
1287
1288                         if ( *has_perm == 't' ) OK = 1;
1289                         jsonObjectFree(return_val);
1290                     }
1291
1292                     dbi_result_free(result);
1293                     if (OK) break;
1294                 }
1295             }
1296
1297                 osrfLogDebug( OSRF_LOG_MARK, "Checking non-object permission [%s] for user %d at org %d", perm, userid, atoi(context_org) );
1298             result = dbi_conn_queryf(
1299                 writehandle,
1300                 "SELECT permission.usr_has_perm(%d, '%s', %d) AS has_perm;",
1301                 userid,
1302                 perm,
1303                 atoi(context_org)
1304             );
1305
1306                         if (result) {
1307                                 osrfLogDebug( OSRF_LOG_MARK, "Received a result for permission [%s] for user %d at org %d",
1308                                                 perm, userid, atoi(context_org) );
1309                                 if ( dbi_result_first_row(result) ) {
1310                                         jsonObject* return_val = oilsMakeJSONFromResult( result );
1311                                         const char* has_perm = jsonObjectGetString( jsonObjectGetKeyConst(return_val, "has_perm") );
1312                                         osrfLogDebug( OSRF_LOG_MARK, "Status of permission [%s] for user %d at org %d is [%s]",
1313                                                         perm, userid, atoi(context_org), has_perm );
1314                                         if ( *has_perm == 't' ) OK = 1;
1315                                         jsonObjectFree(return_val);
1316                                 }
1317
1318                                 dbi_result_free(result);
1319                                 if (OK) break;
1320                         }
1321
1322         }
1323         if (OK) break;
1324     }
1325
1326     if (pkey_value) free(pkey_value);
1327     osrfStringArrayFree(context_org_array);
1328
1329     return OK;
1330 }
1331
1332 /**
1333  * Look up the root of the org_unit tree.  If you find it, return
1334  * a string containing the id, which the caller is responsible for freeing.
1335  * Otherwise return NULL.
1336  */
1337 static char* org_tree_root( osrfMethodContext* ctx ) {
1338
1339         static char cached_root_id[ 32 ] = "";  // extravagantly large buffer
1340         static time_t last_lookup_time = 0;
1341         time_t current_time = time( NULL );
1342
1343         if( cached_root_id[ 0 ] && ( current_time - last_lookup_time < 3600 ) ) {
1344                 // We successfully looked this up less than an hour ago.
1345                 // It's not likely to have changed since then.
1346                 return strdup( cached_root_id );
1347         }
1348         last_lookup_time = current_time;
1349
1350         int err = 0;
1351         jsonObject* where_clause = single_hash( "parent_ou", NULL );
1352         jsonObject* result = doFieldmapperSearch(
1353                 ctx, osrfHashGet( oilsIDL(), "aou" ), where_clause, NULL, &err );
1354         jsonObjectFree( where_clause );
1355
1356         jsonObject* tree_top = jsonObjectGetIndex( result, 0 );
1357
1358         if (! tree_top) {
1359                 jsonObjectFree( result );
1360
1361                 growing_buffer* msg = buffer_init(128);
1362                 OSRF_BUFFER_ADD( msg, MODULENAME );
1363                 OSRF_BUFFER_ADD( msg,
1364                                 ": Internal error, could not find the top of the org tree (parent_ou = NULL)" );
1365
1366                 char* m = buffer_release(msg);
1367                 osrfAppSessionStatus( ctx->session,
1368                                 OSRF_STATUS_INTERNALSERVERERROR, "osrfMethodException", ctx->request, m );
1369                 free(m);
1370
1371                 cached_root_id[ 0 ] = '\0';
1372                 return NULL;
1373         }
1374
1375         char* root_org_unit_id = oilsFMGetString( tree_top, "id" );
1376         osrfLogDebug( OSRF_LOG_MARK, "Top of the org tree is %s", root_org_unit_id );
1377
1378         jsonObjectFree( result );
1379
1380         strcpy( cached_root_id, root_org_unit_id );
1381         return root_org_unit_id;
1382 }
1383
1384 /**
1385 Utility function: create a JSON_HASH with a single key/value pair.
1386 This function is equivalent to:
1387
1388         jsonParseStringFmt( "{\"%s\":\"%s\"}", key, value )
1389
1390 or, if value is NULL:
1391
1392         jsonParseStringFmt( "{\"%s\":null}", key )
1393
1394 ...but faster because it doesn't create and parse a JSON string.
1395 */
1396 static jsonObject* single_hash( const char* key, const char* value ) {
1397         // Sanity check
1398         if( ! key ) key = "";
1399
1400         jsonObject* hash = jsonNewObjectType( JSON_HASH );
1401         jsonObjectSetKey( hash, key, jsonNewObject( value ) );
1402         return hash;
1403 }
1404 #endif
1405
1406
1407 static jsonObject* doCreate(osrfMethodContext* ctx, int* err ) {
1408
1409         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1410 #ifdef PCRUD
1411         jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
1412         jsonObject* options = jsonObjectGetIndex( ctx->params, 2 );
1413 #else
1414         jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
1415         jsonObject* options = jsonObjectGetIndex( ctx->params, 1 );
1416 #endif
1417
1418         if (!verifyObjectClass(ctx, target)) {
1419                 *err = -1;
1420                 return jsonNULL;
1421         }
1422
1423         osrfLogDebug( OSRF_LOG_MARK, "Object seems to be of the correct type" );
1424
1425         char* trans_id = NULL;
1426         if( ctx->session && ctx->session->userData )
1427                 trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
1428
1429         if ( !trans_id ) {
1430                 osrfLogError( OSRF_LOG_MARK, "No active transaction -- required for CREATE" );
1431
1432                 osrfAppSessionStatus(
1433                         ctx->session,
1434                         OSRF_STATUS_BADREQUEST,
1435                         "osrfMethodException",
1436                         ctx->request,
1437                         "No active transaction -- required for CREATE"
1438                 );
1439                 *err = -1;
1440                 return jsonNULL;
1441         }
1442
1443         // The following test is harmless but redundant.  If a class is
1444         // readonly, we don't register a create method for it.
1445         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
1446                 osrfAppSessionStatus(
1447                         ctx->session,
1448                         OSRF_STATUS_BADREQUEST,
1449                         "osrfMethodException",
1450                         ctx->request,
1451                         "Cannot INSERT readonly class"
1452                 );
1453                 *err = -1;
1454                 return jsonNULL;
1455         }
1456
1457         // Set the last_xact_id
1458         int index = oilsIDL_ntop( target->classname, "last_xact_id" );
1459         if (index > -1) {
1460                 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
1461                 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
1462         }
1463
1464         osrfLogDebug( OSRF_LOG_MARK, "There is a transaction running..." );
1465
1466         dbhandle = writehandle;
1467
1468         osrfHash* fields = osrfHashGet(meta, "fields");
1469         char* pkey = osrfHashGet(meta, "primarykey");
1470         char* seq = osrfHashGet(meta, "sequence");
1471
1472         growing_buffer* table_buf = buffer_init(128);
1473         growing_buffer* col_buf = buffer_init(128);
1474         growing_buffer* val_buf = buffer_init(128);
1475
1476         OSRF_BUFFER_ADD(table_buf, "INSERT INTO ");
1477         OSRF_BUFFER_ADD(table_buf, osrfHashGet(meta, "tablename"));
1478         OSRF_BUFFER_ADD_CHAR( col_buf, '(' );
1479         buffer_add(val_buf,"VALUES (");
1480
1481
1482         int first = 1;
1483         osrfHash* field = NULL;
1484         osrfHashIterator* field_itr = osrfNewHashIterator( fields );
1485         while( (field = osrfHashIteratorNext( field_itr ) ) ) {
1486
1487                 const char* field_name = osrfHashIteratorKey( field_itr );
1488
1489                 if( str_is_true( osrfHashGet( field, "virtual" ) ) )
1490                         continue;
1491
1492                 const jsonObject* field_object = oilsFMGetObject( target, field_name );
1493
1494                 char* value;
1495                 if (field_object && field_object->classname) {
1496                         value = oilsFMGetString(
1497                                 field_object,
1498                                 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
1499                         );
1500                 } else {
1501                         value = jsonObjectToSimpleString( field_object );
1502                 }
1503
1504
1505                 if (first) {
1506                         first = 0;
1507                 } else {
1508                         OSRF_BUFFER_ADD_CHAR( col_buf, ',' );
1509                         OSRF_BUFFER_ADD_CHAR( val_buf, ',' );
1510                 }
1511
1512                 buffer_add(col_buf, field_name);
1513
1514                 if (!field_object || field_object->type == JSON_NULL) {
1515                         buffer_add( val_buf, "DEFAULT" );
1516
1517                 } else if ( !strcmp(get_primitive( field ), "number") ) {
1518                         const char* numtype = get_datatype( field );
1519                         if ( !strcmp( numtype, "INT8") ) {
1520                                 buffer_fadd( val_buf, "%lld", atoll(value) );
1521
1522                         } else if ( !strcmp( numtype, "INT") ) {
1523                                 buffer_fadd( val_buf, "%d", atoi(value) );
1524
1525                         } else if ( !strcmp( numtype, "NUMERIC") ) {
1526                                 buffer_fadd( val_buf, "%f", atof(value) );
1527                         }
1528                 } else {
1529                         if ( dbi_conn_quote_string(writehandle, &value) ) {
1530                                 OSRF_BUFFER_ADD( val_buf, value );
1531
1532                         } else {
1533                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
1534                                 osrfAppSessionStatus(
1535                                         ctx->session,
1536                                         OSRF_STATUS_INTERNALSERVERERROR,
1537                                         "osrfMethodException",
1538                                         ctx->request,
1539                                         "Error quoting string -- please see the error log for more details"
1540                                 );
1541                                 free(value);
1542                                 buffer_free(table_buf);
1543                                 buffer_free(col_buf);
1544                                 buffer_free(val_buf);
1545                                 *err = -1;
1546                                 return jsonNULL;
1547                         }
1548                 }
1549
1550                 free(value);
1551
1552         }
1553
1554         osrfHashIteratorFree( field_itr );
1555
1556         OSRF_BUFFER_ADD_CHAR( col_buf, ')' );
1557         OSRF_BUFFER_ADD_CHAR( val_buf, ')' );
1558
1559         char* table_str = buffer_release(table_buf);
1560         char* col_str   = buffer_release(col_buf);
1561         char* val_str   = buffer_release(val_buf);
1562         growing_buffer* sql = buffer_init(128);
1563         buffer_fadd( sql, "%s %s %s;", table_str, col_str, val_str );
1564         free(table_str);
1565         free(col_str);
1566         free(val_str);
1567
1568         char* query = buffer_release(sql);
1569
1570         osrfLogDebug(OSRF_LOG_MARK, "%s: Insert SQL [%s]", MODULENAME, query);
1571
1572
1573         dbi_result result = dbi_conn_query(writehandle, query);
1574
1575         jsonObject* obj = NULL;
1576
1577         if (!result) {
1578                 obj = jsonNewObject(NULL);
1579                 osrfLogError(
1580                         OSRF_LOG_MARK,
1581                         "%s ERROR inserting %s object using query [%s]",
1582                         MODULENAME,
1583                         osrfHashGet(meta, "fieldmapper"),
1584                         query
1585                 );
1586                 osrfAppSessionStatus(
1587                         ctx->session,
1588                         OSRF_STATUS_INTERNALSERVERERROR,
1589                         "osrfMethodException",
1590                         ctx->request,
1591                         "INSERT error -- please see the error log for more details"
1592                 );
1593                 *err = -1;
1594         } else {
1595
1596                 char* id = oilsFMGetString(target, pkey);
1597                 if (!id) {
1598                         unsigned long long new_id = dbi_conn_sequence_last(writehandle, seq);
1599                         growing_buffer* _id = buffer_init(10);
1600                         buffer_fadd(_id, "%lld", new_id);
1601                         id = buffer_release(_id);
1602                 }
1603
1604                 // Find quietness specification, if present
1605                 const char* quiet_str = NULL;
1606                 if ( options ) {
1607                         const jsonObject* quiet_obj = jsonObjectGetKeyConst( options, "quiet" );
1608                         if( quiet_obj )
1609                                 quiet_str = jsonObjectGetString( quiet_obj );
1610                 }
1611
1612                 if( str_is_true( quiet_str ) ) {  // if quietness is specified
1613                         obj = jsonNewObject(id);
1614                 }
1615                 else {
1616
1617                         jsonObject* where_clause = jsonNewObjectType( JSON_HASH );
1618                         jsonObjectSetKey( where_clause, pkey, jsonNewObject(id) );
1619
1620                         jsonObject* list = doFieldmapperSearch( ctx, meta, where_clause, NULL, err );
1621
1622                         jsonObjectFree( where_clause );
1623
1624                         if(*err) {
1625                                 obj = jsonNULL;
1626                         } else {
1627                                 obj = jsonObjectClone( jsonObjectGetIndex(list, 0) );
1628                         }
1629
1630                         jsonObjectFree( list );
1631                 }
1632
1633                 free(id);
1634         }
1635
1636         free(query);
1637
1638         return obj;
1639
1640 }
1641
1642 /*
1643  * Fetch one row from a specified table, using a specified value
1644  * for the primary key
1645 */
1646 static jsonObject* doRetrieve(osrfMethodContext* ctx, int* err ) {
1647
1648     int id_pos = 0;
1649     int order_pos = 1;
1650
1651 #ifdef PCRUD
1652     id_pos = 1;
1653     order_pos = 2;
1654 #endif
1655
1656         osrfHash* class_def = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
1657
1658         const jsonObject* id_obj = jsonObjectGetIndex(ctx->params, id_pos);  // key value
1659
1660         osrfLogDebug(
1661                 OSRF_LOG_MARK,
1662                 "%s retrieving %s object with primary key value of %s",
1663                 MODULENAME,
1664                 osrfHashGet( class_def, "fieldmapper" ),
1665                 jsonObjectGetString( id_obj )
1666         );
1667
1668         // Build a WHERE clause based on the key value
1669         jsonObject* where_clause = jsonNewObjectType( JSON_HASH );
1670         jsonObjectSetKey(
1671                 where_clause,
1672                 osrfHashGet( class_def, "primarykey" ),
1673                 jsonObjectClone( id_obj )
1674         );
1675
1676         jsonObject* rest_of_query = jsonObjectGetIndex(ctx->params, order_pos);
1677
1678         jsonObject* list = doFieldmapperSearch( ctx, class_def, where_clause, rest_of_query, err );
1679
1680         jsonObjectFree( where_clause );
1681         if(*err)
1682                 return jsonNULL;
1683
1684         jsonObject* obj = jsonObjectExtractIndex( list, 0 );
1685         jsonObjectFree( list );
1686
1687 #ifdef PCRUD
1688         if(!verifyObjectPCRUD(ctx, obj)) {
1689         jsonObjectFree(obj);
1690         *err = -1;
1691
1692         growing_buffer* msg = buffer_init(128);
1693                 OSRF_BUFFER_ADD( msg, MODULENAME );
1694                 OSRF_BUFFER_ADD( msg, ": Insufficient permissions to retrieve object" );
1695
1696         char* m = buffer_release(msg);
1697         osrfAppSessionStatus( ctx->session, OSRF_STATUS_NOTALLOWED, "osrfMethodException", ctx->request, m );
1698
1699         free(m);
1700
1701                 return jsonNULL;
1702         }
1703 #endif
1704
1705         return obj;
1706 }
1707
1708 static char* jsonNumberToDBString ( osrfHash* field, const jsonObject* value ) {
1709         growing_buffer* val_buf = buffer_init(32);
1710         const char* numtype = get_datatype( field );
1711
1712         if ( !strncmp( numtype, "INT", 3 ) ) {
1713                 if (value->type == JSON_NUMBER)
1714                         //buffer_fadd( val_buf, "%ld", (long)jsonObjectGetNumber(value) );
1715                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1716                 else {
1717                         //const char* val_str = jsonObjectGetString( value );
1718                         //buffer_fadd( val_buf, "%ld", atol(val_str) );
1719                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1720                 }
1721
1722         } else if ( !strcmp( numtype, "NUMERIC" ) ) {
1723                 if (value->type == JSON_NUMBER)
1724                         //buffer_fadd( val_buf, "%f",  jsonObjectGetNumber(value) );
1725                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1726                 else {
1727                         //const char* val_str = jsonObjectGetString( value );
1728                         //buffer_fadd( val_buf, "%f", atof(val_str) );
1729                         buffer_fadd( val_buf, jsonObjectGetString( value ) );
1730                 }
1731
1732         } else {
1733                 // Presumably this was really intended ot be a string, so quote it
1734                 char* str = jsonObjectToSimpleString( value );
1735                 if ( dbi_conn_quote_string(dbhandle, &str) ) {
1736                         OSRF_BUFFER_ADD( val_buf, str );
1737                         free(str);
1738                 } else {
1739                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, str);
1740                         free(str);
1741                         buffer_free(val_buf);
1742                         return NULL;
1743                 }
1744         }
1745
1746         return buffer_release(val_buf);
1747 }
1748
1749 static char* searchINPredicate (const char* class_alias, osrfHash* field,
1750                 jsonObject* node, const char* op, osrfMethodContext* ctx ) {
1751         growing_buffer* sql_buf = buffer_init(32);
1752
1753         buffer_fadd(
1754                 sql_buf,
1755                 "\"%s\".%s ",
1756                 class_alias,
1757                 osrfHashGet(field, "name")
1758         );
1759
1760         if (!op) {
1761                 buffer_add(sql_buf, "IN (");
1762         } else if (!(strcasecmp(op,"not in"))) {
1763                 buffer_add(sql_buf, "NOT IN (");
1764         } else {
1765                 buffer_add(sql_buf, "IN (");
1766         }
1767
1768     if (node->type == JSON_HASH) {
1769         // subquery predicate
1770         char* subpred = SELECT(
1771             ctx,
1772             jsonObjectGetKey( node, "select" ),
1773             jsonObjectGetKey( node, "from" ),
1774             jsonObjectGetKey( node, "where" ),
1775             jsonObjectGetKey( node, "having" ),
1776             jsonObjectGetKey( node, "order_by" ),
1777             jsonObjectGetKey( node, "limit" ),
1778             jsonObjectGetKey( node, "offset" ),
1779             SUBSELECT
1780         );
1781                 pop_query_frame();
1782
1783                 if( subpred ) {
1784                         buffer_add(sql_buf, subpred);
1785                         free(subpred);
1786                 } else {
1787                         buffer_free( sql_buf );
1788                         return NULL;
1789                 }
1790
1791     } else if (node->type == JSON_ARRAY) {
1792         // literal value list
1793         int in_item_index = 0;
1794         int in_item_first = 1;
1795         const jsonObject* in_item;
1796         while ( (in_item = jsonObjectGetIndex(node, in_item_index++)) ) {
1797
1798                         if (in_item_first)
1799                                 in_item_first = 0;
1800                         else
1801                                 buffer_add(sql_buf, ", ");
1802
1803                         // Sanity check
1804                         if ( in_item->type != JSON_STRING && in_item->type != JSON_NUMBER ) {
1805                                 osrfLogError(OSRF_LOG_MARK, "%s: Expected string or number within IN list; found %s",
1806                                                 MODULENAME, json_type( in_item->type ) );
1807                                 buffer_free(sql_buf);
1808                                 return NULL;
1809                         }
1810
1811                         // Append the literal value -- quoted if not a number
1812                         if ( JSON_NUMBER == in_item->type ) {
1813                                 char* val = jsonNumberToDBString( field, in_item );
1814                                 OSRF_BUFFER_ADD( sql_buf, val );
1815                                 free(val);
1816
1817                         } else if ( !strcmp( get_primitive( field ), "number") ) {
1818                                 char* val = jsonNumberToDBString( field, in_item );
1819                                 OSRF_BUFFER_ADD( sql_buf, val );
1820                                 free(val);
1821
1822                         } else {
1823                                 char* key_string = jsonObjectToSimpleString(in_item);
1824                                 if ( dbi_conn_quote_string(dbhandle, &key_string) ) {
1825                                         OSRF_BUFFER_ADD( sql_buf, key_string );
1826                                         free(key_string);
1827                                 } else {
1828                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, key_string);
1829                                         free(key_string);
1830                                         buffer_free(sql_buf);
1831                                         return NULL;
1832                                 }
1833                         }
1834                 }
1835
1836                 if( in_item_first ) {
1837                         osrfLogError(OSRF_LOG_MARK, "%s: Empty IN list", MODULENAME );
1838                         buffer_free( sql_buf );
1839                         return NULL;
1840                 }
1841         } else {
1842                 osrfLogError(OSRF_LOG_MARK, "%s: Expected object or array for IN clause; found %s",
1843                         MODULENAME, json_type( node->type ) );
1844                 buffer_free(sql_buf);
1845                 return NULL;
1846         }
1847
1848         OSRF_BUFFER_ADD_CHAR( sql_buf, ')' );
1849
1850         return buffer_release(sql_buf);
1851 }
1852
1853 // Receive a JSON_ARRAY representing a function call.  The first
1854 // entry in the array is the function name.  The rest are parameters.
1855 static char* searchValueTransform( const jsonObject* array ) {
1856
1857         if( array->size < 1 ) {
1858                 osrfLogError(OSRF_LOG_MARK, "%s: Empty array for value transform", MODULENAME);
1859                 return NULL;
1860         }
1861
1862         // Get the function name
1863         jsonObject* func_item = jsonObjectGetIndex( array, 0 );
1864         if( func_item->type != JSON_STRING ) {
1865                 osrfLogError(OSRF_LOG_MARK, "%s: Error: expected function name, found %s",
1866                         MODULENAME, json_type( func_item->type ) );
1867                 return NULL;
1868         }
1869
1870         growing_buffer* sql_buf = buffer_init(32);
1871
1872         OSRF_BUFFER_ADD( sql_buf, jsonObjectGetString( func_item ) );
1873         OSRF_BUFFER_ADD( sql_buf, "( " );
1874
1875         // Get the parameters
1876         int func_item_index = 1;   // We already grabbed the zeroth entry
1877         while ( (func_item = jsonObjectGetIndex(array, func_item_index++)) ) {
1878
1879                 // Add a separator comma, if we need one
1880                 if( func_item_index > 2 )
1881                         buffer_add( sql_buf, ", " );
1882
1883                 // Add the current parameter
1884                 if (func_item->type == JSON_NULL) {
1885                         buffer_add( sql_buf, "NULL" );
1886                 } else {
1887                         char* val = jsonObjectToSimpleString(func_item);
1888                         if ( dbi_conn_quote_string(dbhandle, &val) ) {
1889                                 OSRF_BUFFER_ADD( sql_buf, val );
1890                                 free(val);
1891                         } else {
1892                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1893                                 buffer_free(sql_buf);
1894                                 free(val);
1895                                 return NULL;
1896                         }
1897                 }
1898         }
1899
1900         buffer_add( sql_buf, " )" );
1901
1902         return buffer_release(sql_buf);
1903 }
1904
1905 static char* searchFunctionPredicate (const char* class_alias, osrfHash* field,
1906                 const jsonObject* node, const char* op) {
1907
1908         if( ! is_good_operator( op ) ) {
1909                 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
1910                 return NULL;
1911         }
1912
1913         char* val = searchValueTransform(node);
1914         if( !val )
1915                 return NULL;
1916
1917         growing_buffer* sql_buf = buffer_init(32);
1918         buffer_fadd(
1919                 sql_buf,
1920                 "\"%s\".%s %s %s",
1921                 class_alias,
1922                 osrfHashGet(field, "name"),
1923                 op,
1924                 val
1925         );
1926
1927         free(val);
1928
1929         return buffer_release(sql_buf);
1930 }
1931
1932 // class_alias is a class name or other table alias
1933 // field is a field definition as stored in the IDL
1934 // node comes from the method parameter, and may represent an entry in the SELECT list
1935 static char* searchFieldTransform (const char* class_alias, osrfHash* field, const jsonObject* node) {
1936         growing_buffer* sql_buf = buffer_init(32);
1937
1938         const char* field_transform = jsonObjectGetString( jsonObjectGetKeyConst( node, "transform" ) );
1939         const char* transform_subcolumn = jsonObjectGetString( jsonObjectGetKeyConst( node, "result_field" ) );
1940
1941         if(transform_subcolumn) {
1942                 if( ! is_identifier( transform_subcolumn ) ) {
1943                         osrfLogError( OSRF_LOG_MARK, "%s: Invalid subfield name: \"%s\"\n",
1944                                         MODULENAME, transform_subcolumn );
1945                         buffer_free( sql_buf );
1946                         return NULL;
1947                 }
1948                 OSRF_BUFFER_ADD_CHAR( sql_buf, '(' );    // enclose transform in parentheses
1949         }
1950
1951         if (field_transform) {
1952
1953                 if( ! is_identifier( field_transform ) ) {
1954                         osrfLogError( OSRF_LOG_MARK, "%s: Expected function name, found \"%s\"\n",
1955                                         MODULENAME, field_transform );
1956                         buffer_free( sql_buf );
1957                         return NULL;
1958                 }
1959
1960                 buffer_fadd( sql_buf, "%s(\"%s\".%s", field_transform, class_alias, osrfHashGet(field, "name"));
1961                 const jsonObject* array = jsonObjectGetKeyConst( node, "params" );
1962
1963                 if (array) {
1964                         if( array->type != JSON_ARRAY ) {
1965                                 osrfLogError( OSRF_LOG_MARK,
1966                                         "%s: Expected JSON_ARRAY for function params; found %s",
1967                                         MODULENAME, json_type( array->type ) );
1968                                 buffer_free( sql_buf );
1969                                 return NULL;
1970                         }
1971                         int func_item_index = 0;
1972                         jsonObject* func_item;
1973                         while ( (func_item = jsonObjectGetIndex(array, func_item_index++)) ) {
1974
1975                                 char* val = jsonObjectToSimpleString(func_item);
1976
1977                                 if ( !val ) {
1978                                         buffer_add( sql_buf, ",NULL" );
1979                                 } else if ( dbi_conn_quote_string(dbhandle, &val) ) {
1980                                         OSRF_BUFFER_ADD_CHAR( sql_buf, ',' );
1981                                         OSRF_BUFFER_ADD( sql_buf, val );
1982                                 } else {
1983                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val);
1984                                         free(val);
1985                                         buffer_free(sql_buf);
1986                                         return NULL;
1987                         }
1988                                 free(val);
1989                         }
1990                 }
1991
1992                 buffer_add( sql_buf, " )" );
1993
1994         } else {
1995                 buffer_fadd( sql_buf, "\"%s\".%s", class_alias, osrfHashGet(field, "name"));
1996         }
1997
1998         if (transform_subcolumn)
1999                 buffer_fadd( sql_buf, ").\"%s\"", transform_subcolumn );
2000
2001         return buffer_release(sql_buf);
2002 }
2003
2004 static char* searchFieldTransformPredicate( const ClassInfo* class_info, osrfHash* field,
2005                 const jsonObject* node, const char* op ) {
2006
2007         if( ! is_good_operator( op ) ) {
2008                 osrfLogError(OSRF_LOG_MARK, "%s: Error: Invalid operator %s", MODULENAME, op);
2009                 return NULL;
2010         }
2011
2012         char* field_transform = searchFieldTransform( class_info->alias, field, node );
2013         if( ! field_transform )
2014                 return NULL;
2015         char* value = NULL;
2016         int extra_parens = 0;   // boolean
2017
2018         const jsonObject* value_obj = jsonObjectGetKeyConst( node, "value" );
2019         if ( ! value_obj ) {
2020                 value = searchWHERE( node, class_info, AND_OP_JOIN, NULL );
2021                 if( !value ) {
2022                         osrfLogError(OSRF_LOG_MARK, "%s: Error building condition for field transform", MODULENAME);
2023                         free(field_transform);
2024                         return NULL;
2025                 }
2026                 extra_parens = 1;
2027         } else if ( value_obj->type == JSON_ARRAY ) {
2028                 value = searchValueTransform( value_obj );
2029                 if( !value ) {
2030                         osrfLogError(OSRF_LOG_MARK, "%s: Error building value transform for field transform", MODULENAME);
2031                         free( field_transform );
2032                         return NULL;
2033                 }
2034         } else if ( value_obj->type == JSON_HASH ) {
2035                 value = searchWHERE( value_obj, class_info, AND_OP_JOIN, NULL );
2036                 if( !value ) {
2037                         osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform", MODULENAME);
2038                         free(field_transform);
2039                         return NULL;
2040                 }
2041                 extra_parens = 1;
2042         } else if ( value_obj->type == JSON_NUMBER ) {
2043                 value = jsonNumberToDBString( field, value_obj );
2044         } else if ( value_obj->type == JSON_NULL ) {
2045                 osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform: null value", MODULENAME);
2046                 free(field_transform);
2047                 return NULL;
2048         } else if ( value_obj->type == JSON_BOOL ) {
2049                 osrfLogError(OSRF_LOG_MARK, "%s: Error building predicate for field transform: boolean value", MODULENAME);
2050                 free(field_transform);
2051                 return NULL;
2052         } else {
2053                 if ( !strcmp( get_primitive( field ), "number") ) {
2054                         value = jsonNumberToDBString( field, value_obj );
2055                 } else {
2056                         value = jsonObjectToSimpleString( value_obj );
2057                         if ( !dbi_conn_quote_string(dbhandle, &value) ) {
2058                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, value);
2059                                 free(value);
2060                                 free(field_transform);
2061                                 return NULL;
2062                         }
2063                 }
2064         }
2065
2066         const char* left_parens  = "";
2067         const char* right_parens = "";
2068
2069         if( extra_parens ) {
2070                 left_parens  = "(";
2071                 right_parens = ")";
2072         }
2073
2074         growing_buffer* sql_buf = buffer_init(32);
2075
2076         buffer_fadd(
2077                 sql_buf,
2078                 "%s%s %s %s %s %s%s",
2079                 left_parens,
2080                 field_transform,
2081                 op,
2082                 left_parens,
2083                 value,
2084                 right_parens,
2085                 right_parens
2086         );
2087
2088         free(value);
2089         free(field_transform);
2090
2091         return buffer_release(sql_buf);
2092 }
2093
2094 static char* searchSimplePredicate (const char* op, const char* class_alias,
2095                 osrfHash* field, const jsonObject* node) {
2096
2097         if( ! is_good_operator( op ) ) {
2098                 osrfLogError( OSRF_LOG_MARK, "%s: Invalid operator [%s]", MODULENAME, op );
2099                 return NULL;
2100         }
2101
2102         char* val = NULL;
2103
2104         // Get the value to which we are comparing the specified column
2105         if (node->type != JSON_NULL) {
2106                 if ( node->type == JSON_NUMBER ) {
2107                         val = jsonNumberToDBString( field, node );
2108                 } else if ( !strcmp( get_primitive( field ), "number" ) ) {
2109                         val = jsonNumberToDBString( field, node );
2110                 } else {
2111                         val = jsonObjectToSimpleString(node);
2112                 }
2113         }
2114
2115         if( val ) {
2116                 if( JSON_NUMBER != node->type && strcmp( get_primitive( field ), "number") ) {
2117                         // Value is not numeric; enclose it in quotes
2118                         if ( !dbi_conn_quote_string( dbhandle, &val ) ) {
2119                                 osrfLogError( OSRF_LOG_MARK, "%s: Error quoting key string [%s]", MODULENAME, val );
2120                                 free( val );
2121                                 return NULL;
2122                         }
2123                 }
2124         } else {
2125                 // Compare to a null value
2126                 val = strdup( "NULL" );
2127                 if (strcmp( op, "=" ))
2128                         op = "IS NOT";
2129                 else
2130                         op = "IS";
2131         }
2132
2133         growing_buffer* sql_buf = buffer_init(32);
2134         buffer_fadd( sql_buf, "\"%s\".%s %s %s", class_alias, osrfHashGet(field, "name"), op, val );
2135         char* pred = buffer_release( sql_buf );
2136
2137         free(val);
2138
2139         return pred;
2140 }
2141
2142 static char* searchBETWEENPredicate (const char* class_alias,
2143                 osrfHash* field, const jsonObject* node) {
2144
2145         const jsonObject* x_node = jsonObjectGetIndex( node, 0 );
2146         const jsonObject* y_node = jsonObjectGetIndex( node, 1 );
2147
2148         if( NULL == y_node ) {
2149                 osrfLogError( OSRF_LOG_MARK, "%s: Not enough operands for BETWEEN operator", MODULENAME );
2150                 return NULL;
2151         }
2152         else if( NULL != jsonObjectGetIndex( node, 2 ) ) {
2153                 osrfLogError( OSRF_LOG_MARK, "%s: Too many operands for BETWEEN operator", MODULENAME );
2154                 return NULL;
2155         }
2156
2157         char* x_string;
2158         char* y_string;
2159
2160         if ( !strcmp( get_primitive( field ), "number") ) {
2161                 x_string = jsonNumberToDBString(field, x_node);
2162                 y_string = jsonNumberToDBString(field, y_node);
2163
2164         } else {
2165                 x_string = jsonObjectToSimpleString(x_node);
2166                 y_string = jsonObjectToSimpleString(y_node);
2167                 if ( !(dbi_conn_quote_string(dbhandle, &x_string) && dbi_conn_quote_string(dbhandle, &y_string)) ) {
2168                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting key strings [%s] and [%s]",
2169                                         MODULENAME, x_string, y_string);
2170                         free(x_string);
2171                         free(y_string);
2172                         return NULL;
2173                 }
2174         }
2175
2176         growing_buffer* sql_buf = buffer_init(32);
2177         buffer_fadd( sql_buf, "\"%s\".%s BETWEEN %s AND %s",
2178                         class_alias, osrfHashGet(field, "name"), x_string, y_string );
2179         free(x_string);
2180         free(y_string);
2181
2182         return buffer_release(sql_buf);
2183 }
2184
2185 static char* searchPredicate ( const ClassInfo* class_info, osrfHash* field,
2186                                                            jsonObject* node, osrfMethodContext* ctx ) {
2187
2188         char* pred = NULL;
2189         if (node->type == JSON_ARRAY) { // equality IN search
2190                 pred = searchINPredicate( class_info->alias, field, node, NULL, ctx );
2191         } else if (node->type == JSON_HASH) { // other search
2192                 jsonIterator* pred_itr = jsonNewIterator( node );
2193                 if( !jsonIteratorHasNext( pred_itr ) ) {
2194                         osrfLogError( OSRF_LOG_MARK, "%s: Empty predicate for field \"%s\"",
2195                                         MODULENAME, osrfHashGet(field, "name") );
2196                 } else {
2197                         jsonObject* pred_node = jsonIteratorNext( pred_itr );
2198
2199                         // Verify that there are no additional predicates
2200                         if( jsonIteratorHasNext( pred_itr ) ) {
2201                                 osrfLogError( OSRF_LOG_MARK, "%s: Multiple predicates for field \"%s\"",
2202                                                 MODULENAME, osrfHashGet(field, "name") );
2203                         } else if ( !(strcasecmp( pred_itr->key,"between" )) )
2204                                 pred = searchBETWEENPredicate( class_info->alias, field, pred_node );
2205                         else if ( !(strcasecmp( pred_itr->key,"in" )) || !(strcasecmp( pred_itr->key,"not in" )) )
2206                                 pred = searchINPredicate( class_info->alias, field, pred_node, pred_itr->key, ctx );
2207                         else if ( pred_node->type == JSON_ARRAY )
2208                                 pred = searchFunctionPredicate( class_info->alias, field, pred_node, pred_itr->key );
2209                         else if ( pred_node->type == JSON_HASH )
2210                                 pred = searchFieldTransformPredicate( class_info, field, pred_node, pred_itr->key );
2211                         else
2212                                 pred = searchSimplePredicate( pred_itr->key, class_info->alias, field, pred_node );
2213                 }
2214                 jsonIteratorFree(pred_itr);
2215
2216         } else if (node->type == JSON_NULL) { // IS NULL search
2217                 growing_buffer* _p = buffer_init(64);
2218                 buffer_fadd(
2219                         _p,
2220                         "\"%s\".%s IS NULL",
2221                         class_info->class_name,
2222                         osrfHashGet(field, "name")
2223                 );
2224                 pred = buffer_release(_p);
2225         } else { // equality search
2226                 pred = searchSimplePredicate( "=", class_info->alias, field, node );
2227         }
2228
2229         return pred;
2230
2231 }
2232
2233
2234 /*
2235
2236 join : {
2237         acn : {
2238                 field : record,
2239                 fkey : id
2240                 type : left
2241                 filter_op : or
2242                 filter : { ... },
2243                 join : {
2244                         acp : {
2245                                 field : call_number,
2246                                 fkey : id,
2247                                 filter : { ... },
2248                         },
2249                 },
2250         },
2251         mrd : {
2252                 field : record,
2253                 type : inner
2254                 fkey : id,
2255                 filter : { ... },
2256         }
2257 }
2258
2259 */
2260
2261 static char* searchJOIN ( const jsonObject* join_hash, const ClassInfo* left_info ) {
2262
2263         const jsonObject* working_hash;
2264         jsonObject* freeable_hash = NULL;
2265
2266         if (join_hash->type == JSON_HASH) {
2267                 working_hash = join_hash;
2268         } else if (join_hash->type == JSON_STRING) {
2269                 // turn it into a JSON_HASH by creating a wrapper
2270                 // around a copy of the original
2271                 const char* _tmp = jsonObjectGetString( join_hash );
2272                 freeable_hash = jsonNewObjectType(JSON_HASH);
2273                 jsonObjectSetKey(freeable_hash, _tmp, NULL);
2274                 working_hash = freeable_hash;
2275         } else {
2276                 osrfLogError(
2277                         OSRF_LOG_MARK,
2278                         "%s: JOIN failed; expected JSON object type not found",
2279                         MODULENAME
2280                 );
2281                 return NULL;
2282         }
2283
2284         growing_buffer* join_buf = buffer_init(128);
2285         const char* leftclass = left_info->class_name;
2286
2287         jsonObject* snode = NULL;
2288         jsonIterator* search_itr = jsonNewIterator( working_hash );
2289
2290         while ( (snode = jsonIteratorNext( search_itr )) ) {
2291                 const char* right_alias = search_itr->key;
2292                 const char* class =
2293                                 jsonObjectGetString( jsonObjectGetKeyConst( snode, "class" ) );
2294                 if( ! class )
2295                         class = right_alias;
2296
2297                 const ClassInfo* right_info = add_joined_class( right_alias, class );
2298                 if( !right_info ) {
2299                         osrfLogError(
2300                                 OSRF_LOG_MARK,
2301                                 "%s: JOIN failed.  Class \"%s\" not resolved in IDL",
2302                                 MODULENAME,
2303                                 search_itr->key
2304                         );
2305                         jsonIteratorFree( search_itr );
2306                         buffer_free( join_buf );
2307                         if( freeable_hash )
2308                                 jsonObjectFree( freeable_hash );
2309                         return NULL;
2310                 }
2311                 osrfHash* links    = right_info->links;
2312                 const char* table  = right_info->source_def;
2313
2314                 const char* fkey  = jsonObjectGetString( jsonObjectGetKeyConst( snode, "fkey" ) );
2315                 const char* field = jsonObjectGetString( jsonObjectGetKeyConst( snode, "field" ) );
2316
2317                 if (field && !fkey) {
2318                         // Look up the corresponding join column in the IDL.
2319                         // The link must be defined in the child table,
2320                         // and point to the right parent table.
2321                         osrfHash* idl_link = (osrfHash*) osrfHashGet( links, field );
2322                         const char* reltype = NULL;
2323                         const char* other_class = NULL;
2324                         reltype = osrfHashGet( idl_link, "reltype" );
2325                         if( reltype && strcmp( reltype, "has_many" ) )
2326                                 other_class = osrfHashGet( idl_link, "class" );
2327                         if( other_class && !strcmp( other_class, leftclass ) )
2328                                 fkey = osrfHashGet( idl_link, "key" );
2329                         if (!fkey) {
2330                                 osrfLogError(
2331                                         OSRF_LOG_MARK,
2332                                         "%s: JOIN failed.  No link defined from %s.%s to %s",
2333                                         MODULENAME,
2334                                         class,
2335                                         field,
2336                                         leftclass
2337                                 );
2338                                 buffer_free(join_buf);
2339                                 if(freeable_hash)
2340                                         jsonObjectFree(freeable_hash);
2341                                 jsonIteratorFree(search_itr);
2342                                 return NULL;
2343                         }
2344
2345                 } else if (!field && fkey) {
2346                         // Look up the corresponding join column in the IDL.
2347                         // The link must be defined in the child table,
2348                         // and point to the right parent table.
2349                         osrfHash* left_links = left_info->links;
2350                         osrfHash* idl_link = (osrfHash*) osrfHashGet( left_links, fkey );
2351                         const char* reltype = NULL;
2352                         const char* other_class = NULL;
2353                         reltype = osrfHashGet( idl_link, "reltype" );
2354                         if( reltype && strcmp( reltype, "has_many" ) )
2355                                 other_class = osrfHashGet( idl_link, "class" );
2356                         if( other_class && !strcmp( other_class, class ) )
2357                                 field = osrfHashGet( idl_link, "key" );
2358                         if (!field) {
2359                                 osrfLogError(
2360                                         OSRF_LOG_MARK,
2361                                         "%s: JOIN failed.  No link defined from %s.%s to %s",
2362                                         MODULENAME,
2363                                         leftclass,
2364                                         fkey,
2365                                         class
2366                                 );
2367                                 buffer_free(join_buf);
2368                                 if(freeable_hash)
2369                                         jsonObjectFree(freeable_hash);
2370                                 jsonIteratorFree(search_itr);
2371                                 return NULL;
2372                         }
2373
2374                 } else if (!field && !fkey) {
2375                         osrfHash* left_links = left_info->links;
2376
2377                         // For each link defined for the left class:
2378                         // see if the link references the joined class
2379                         osrfHashIterator* itr = osrfNewHashIterator( left_links );
2380                         osrfHash* curr_link = NULL;
2381                         while( (curr_link = osrfHashIteratorNext( itr ) ) ) {
2382                                 const char* other_class = osrfHashGet( curr_link, "class" );
2383                                 if( other_class && !strcmp( other_class, class ) ) {
2384
2385                                         // In the IDL, the parent class doesn't know then names of the child
2386                                         // columns that are pointing to it, so don't use that end of the link
2387                                         const char* reltype = osrfHashGet( curr_link, "reltype" );
2388                                         if( reltype && strcmp( reltype, "has_many" ) ) {
2389                                                 // Found a link between the classes
2390                                                 fkey = osrfHashIteratorKey( itr );
2391                                                 field = osrfHashGet( curr_link, "key" );
2392                                                 break;
2393                                         }
2394                                 }
2395                         }
2396                         osrfHashIteratorFree( itr );
2397
2398                         if (!field || !fkey) {
2399                                 // Do another such search, with the classes reversed
2400
2401                                 // For each link defined for the joined class:
2402                                 // see if the link references the left class
2403                                 osrfHashIterator* itr = osrfNewHashIterator( links );
2404                                 osrfHash* curr_link = NULL;
2405                                 while( (curr_link = osrfHashIteratorNext( itr ) ) ) {
2406                                         const char* other_class = osrfHashGet( curr_link, "class" );
2407                                         if( other_class && !strcmp( other_class, leftclass ) ) {
2408
2409                                                 // In the IDL, the parent class doesn't know then names of the child
2410                                                 // columns that are pointing to it, so don't use that end of the link
2411                                                 const char* reltype = osrfHashGet( curr_link, "reltype" );
2412                                                 if( reltype && strcmp( reltype, "has_many" ) ) {
2413                                                         // Found a link between the classes
2414                                                         field = osrfHashIteratorKey( itr );
2415                                                         fkey = osrfHashGet( curr_link, "key" );
2416                                                         break;
2417                                                 }
2418                                         }
2419                                 }
2420                                 osrfHashIteratorFree( itr );
2421                         }
2422
2423                         if (!field || !fkey) {
2424                                 osrfLogError(
2425                                         OSRF_LOG_MARK,
2426                                         "%s: JOIN failed.  No link defined between %s and %s",
2427                                         MODULENAME,
2428                                         leftclass,
2429                                         class
2430                                 );
2431                                 buffer_free(join_buf);
2432                                 if(freeable_hash)
2433                                         jsonObjectFree(freeable_hash);
2434                                 jsonIteratorFree(search_itr);
2435                                 return NULL;
2436                         }
2437
2438                 }
2439
2440                 const char* type = jsonObjectGetString( jsonObjectGetKeyConst( snode, "type" ) );
2441                 if (type) {
2442                         if ( !strcasecmp(type,"left") ) {
2443                                 buffer_add(join_buf, " LEFT JOIN");
2444                         } else if ( !strcasecmp(type,"right") ) {
2445                                 buffer_add(join_buf, " RIGHT JOIN");
2446                         } else if ( !strcasecmp(type,"full") ) {
2447                                 buffer_add(join_buf, " FULL JOIN");
2448                         } else {
2449                                 buffer_add(join_buf, " INNER JOIN");
2450                         }
2451                 } else {
2452                         buffer_add(join_buf, " INNER JOIN");
2453                 }
2454
2455                 buffer_fadd(join_buf, " %s AS \"%s\" ON ( \"%s\".%s = \"%s\".%s",
2456                                         table, right_alias, right_alias, field, left_info->alias, fkey);
2457
2458                 // Add any other join conditions as specified by "filter"
2459                 const jsonObject* filter = jsonObjectGetKeyConst( snode, "filter" );
2460                 if (filter) {
2461                         const char* filter_op = jsonObjectGetString( jsonObjectGetKeyConst( snode, "filter_op" ) );
2462                         if ( filter_op && !strcasecmp("or",filter_op) ) {
2463                                 buffer_add( join_buf, " OR " );
2464                         } else {
2465                                 buffer_add( join_buf, " AND " );
2466                         }
2467
2468                         char* jpred = searchWHERE( filter, right_info, AND_OP_JOIN, NULL );
2469                         if( jpred ) {
2470                                 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2471                                 OSRF_BUFFER_ADD( join_buf, jpred );
2472                                 free(jpred);
2473                         } else {
2474                                 osrfLogError(
2475                                         OSRF_LOG_MARK,
2476                                         "%s: JOIN failed.  Invalid conditional expression.",
2477                                         MODULENAME
2478                                 );
2479                                 jsonIteratorFree( search_itr );
2480                                 buffer_free( join_buf );
2481                                 if( freeable_hash )
2482                                         jsonObjectFree( freeable_hash );
2483                                 return NULL;
2484                         }
2485                 }
2486
2487                 buffer_add(join_buf, " ) ");
2488
2489                 // Recursively add a nested join, if one is present
2490                 const jsonObject* join_filter = jsonObjectGetKeyConst( snode, "join" );
2491                 if (join_filter) {
2492                         char* jpred = searchJOIN( join_filter, right_info );
2493                         if( jpred ) {
2494                                 OSRF_BUFFER_ADD_CHAR( join_buf, ' ' );
2495                                 OSRF_BUFFER_ADD( join_buf, jpred );
2496                                 free(jpred);
2497                         } else {
2498                                 osrfLogError(  OSRF_LOG_MARK, "%s: Invalid nested join.", MODULENAME );
2499                                 jsonIteratorFree( search_itr );
2500                                 buffer_free( join_buf );
2501                                 if( freeable_hash )
2502                                         jsonObjectFree( freeable_hash );
2503                                 return NULL;
2504                         }
2505                 }
2506         }
2507
2508         if(freeable_hash)
2509                 jsonObjectFree(freeable_hash);
2510         jsonIteratorFree(search_itr);
2511
2512         return buffer_release(join_buf);
2513 }
2514
2515 /*
2516
2517 { +class : { -or|-and : { field : { op : value }, ... } ... }, ... }
2518 { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }
2519 [ { +class : { -or|-and : [ { field : { op : value }, ... }, ...] ... }, ... }, ... ]
2520
2521 Generate code to express a set of conditions, as for a WHERE clause.  Parameters:
2522
2523 search_hash is the JSON expression of the conditions.
2524 meta is the class definition from the IDL, for the relevant table.
2525 opjoin_type indicates whether multiple conditions, if present, should be
2526         connected by AND or OR.
2527 osrfMethodContext is loaded with all sorts of stuff, but all we do with it here is
2528         to pass it to other functions -- and all they do with it is to use the session
2529         and request members to send error messages back to the client.
2530
2531 */
2532
2533 static char* searchWHERE ( const jsonObject* search_hash, const ClassInfo* class_info,
2534                 int opjoin_type, osrfMethodContext* ctx ) {
2535
2536         osrfLogDebug(
2537                 OSRF_LOG_MARK,
2538                 "%s: Entering searchWHERE; search_hash addr = %p, meta addr = %p, opjoin_type = %d, ctx addr = %p",
2539                 MODULENAME,
2540                 search_hash,
2541                 class_info->class_def,
2542                 opjoin_type,
2543                 ctx
2544         );
2545
2546         growing_buffer* sql_buf = buffer_init(128);
2547
2548         jsonObject* node = NULL;
2549
2550         int first = 1;
2551         if ( search_hash->type == JSON_ARRAY ) {
2552                 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_ARRAY", MODULENAME);
2553                 if( 0 == search_hash->size ) {
2554                         osrfLogError(
2555                                 OSRF_LOG_MARK,
2556                                 "%s: Invalid predicate structure: empty JSON array",
2557                                 MODULENAME
2558                         );
2559                         buffer_free( sql_buf );
2560                         return NULL;
2561                 }
2562
2563                 unsigned long i = 0;
2564                 while((node = jsonObjectGetIndex( search_hash, i++ ) )) {
2565                         if (first) {
2566                                 first = 0;
2567                         } else {
2568                                 if (opjoin_type == OR_OP_JOIN)
2569                                         buffer_add(sql_buf, " OR ");
2570                                 else
2571                                         buffer_add(sql_buf, " AND ");
2572                         }
2573
2574                         char* subpred = searchWHERE( node, class_info, opjoin_type, ctx );
2575                         if( ! subpred ) {
2576                                 buffer_free( sql_buf );
2577                                 return NULL;
2578                         }
2579
2580                         buffer_fadd(sql_buf, "( %s )", subpred);
2581                         free(subpred);
2582                 }
2583
2584         } else if ( search_hash->type == JSON_HASH ) {
2585                 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_HASH", MODULENAME);
2586                 jsonIterator* search_itr = jsonNewIterator( search_hash );
2587                 if( !jsonIteratorHasNext( search_itr ) ) {
2588                         osrfLogError(
2589                                 OSRF_LOG_MARK,
2590                                 "%s: Invalid predicate structure: empty JSON object",
2591                                 MODULENAME
2592                         );
2593                         jsonIteratorFree( search_itr );
2594                         buffer_free( sql_buf );
2595                         return NULL;
2596                 }
2597
2598                 while ( (node = jsonIteratorNext( search_itr )) ) {
2599
2600                         if (first) {
2601                                 first = 0;
2602                         } else {
2603                                 if (opjoin_type == OR_OP_JOIN)
2604                                         buffer_add(sql_buf, " OR ");
2605                                 else
2606                                         buffer_add(sql_buf, " AND ");
2607                         }
2608
2609                         if ( '+' == search_itr->key[ 0 ] ) {
2610
2611                                 // This plus sign prefixes a class name or other table alias;
2612                                 // make sure the table alias is in scope
2613                                 ClassInfo* alias_info = search_all_alias( search_itr->key + 1 );
2614                                 if( ! alias_info ) {
2615                                         osrfLogError(
2616                                                          OSRF_LOG_MARK,
2617                                                         "%s: Invalid table alias \"%s\" in WHERE clause",
2618                                                         MODULENAME,
2619                                                         search_itr->key + 1
2620                                         );
2621                                         jsonIteratorFree( search_itr );
2622                                         buffer_free( sql_buf );
2623                                         return NULL;
2624                                 }
2625
2626                                 if ( node->type == JSON_STRING ) {
2627                                         // It's the name of a column; make sure it belongs to the class
2628                                         const char* fieldname = jsonObjectGetString( node );
2629                                         if( ! osrfHashGet( alias_info->fields, fieldname ) ) {
2630                                                 osrfLogError(
2631                                                         OSRF_LOG_MARK,
2632                                                         "%s: Invalid column name \"%s\" in WHERE clause for table alias \"%s\"",
2633                                                         MODULENAME,
2634                                                         fieldname,
2635                                                         alias_info->alias
2636                                                 );
2637                                                 jsonIteratorFree( search_itr );
2638                                                 buffer_free( sql_buf );
2639                                                 return NULL;
2640                                         }
2641
2642                                         buffer_fadd(sql_buf, " \"%s\".%s ", alias_info->alias, fieldname );
2643                                 } else {
2644                                         // It's something more complicated
2645                                         char* subpred = searchWHERE( node, alias_info, AND_OP_JOIN, ctx );
2646                                         if( ! subpred ) {
2647                                                 jsonIteratorFree( search_itr );
2648                                                 buffer_free( sql_buf );
2649                                                 return NULL;
2650                                         }
2651
2652                                         buffer_fadd(sql_buf, "( %s )", subpred);
2653                                         free(subpred);
2654                                 }
2655                         } else if ( '-' == search_itr->key[ 0 ] ) {
2656                                 if ( !strcasecmp("-or",search_itr->key) ) {
2657                                         char* subpred = searchWHERE( node, class_info, OR_OP_JOIN, ctx );
2658                                         if( ! subpred ) {
2659                                                 jsonIteratorFree( search_itr );
2660                                                 buffer_free( sql_buf );
2661                                                 return NULL;
2662                                         }
2663
2664                                         buffer_fadd(sql_buf, "( %s )", subpred);
2665                                         free( subpred );
2666                                 } else if ( !strcasecmp("-and",search_itr->key) ) {
2667                                         char* subpred = searchWHERE( node, class_info, AND_OP_JOIN, ctx );
2668                                         if( ! subpred ) {
2669                                                 jsonIteratorFree( search_itr );
2670                                                 buffer_free( sql_buf );
2671                                                 return NULL;
2672                                         }
2673
2674                                         buffer_fadd(sql_buf, "( %s )", subpred);
2675                                         free( subpred );
2676                                 } else if ( !strcasecmp("-not",search_itr->key) ) {
2677                                         char* subpred = searchWHERE( node, class_info, AND_OP_JOIN, ctx );
2678                                         if( ! subpred ) {
2679                                                 jsonIteratorFree( search_itr );
2680                                                 buffer_free( sql_buf );
2681                                                 return NULL;
2682                                         }
2683
2684                                         buffer_fadd(sql_buf, " NOT ( %s )", subpred);
2685                                         free( subpred );
2686                                 } else if ( !strcasecmp("-exists",search_itr->key) ) {
2687                                         char* subpred = SELECT(
2688                                                 ctx,
2689                                                 jsonObjectGetKey( node, "select" ),
2690                                                 jsonObjectGetKey( node, "from" ),
2691                                                 jsonObjectGetKey( node, "where" ),
2692                                                 jsonObjectGetKey( node, "having" ),
2693                                                 jsonObjectGetKey( node, "order_by" ),
2694                                                 jsonObjectGetKey( node, "limit" ),
2695                                                 jsonObjectGetKey( node, "offset" ),
2696                                                 SUBSELECT
2697                                         );
2698                                         pop_query_frame();
2699
2700                                         if( ! subpred ) {
2701                                                 jsonIteratorFree( search_itr );
2702                                                 buffer_free( sql_buf );
2703                                                 return NULL;
2704                                         }
2705
2706                                         buffer_fadd(sql_buf, "EXISTS ( %s )", subpred);
2707                                         free(subpred);
2708                                 } else if ( !strcasecmp("-not-exists",search_itr->key) ) {
2709                                         char* subpred = SELECT(
2710                                                 ctx,
2711                                                 jsonObjectGetKey( node, "select" ),
2712                                                 jsonObjectGetKey( node, "from" ),
2713                                                 jsonObjectGetKey( node, "where" ),
2714                                                 jsonObjectGetKey( node, "having" ),
2715                                                 jsonObjectGetKey( node, "order_by" ),
2716                                                 jsonObjectGetKey( node, "limit" ),
2717                                                 jsonObjectGetKey( node, "offset" ),
2718                                                 SUBSELECT
2719                                         );
2720                                         pop_query_frame();
2721
2722                                         if( ! subpred ) {
2723                                                 jsonIteratorFree( search_itr );
2724                                                 buffer_free( sql_buf );
2725                                                 return NULL;
2726                                         }
2727
2728                                         buffer_fadd(sql_buf, "NOT EXISTS ( %s )", subpred);
2729                                         free(subpred);
2730                                 } else {     // Invalid "minus" operator
2731                                         osrfLogError(
2732                                                          OSRF_LOG_MARK,
2733                                                         "%s: Invalid operator \"%s\" in WHERE clause",
2734                                                         MODULENAME,
2735                                                         search_itr->key
2736                                         );
2737                                         jsonIteratorFree( search_itr );
2738                                         buffer_free( sql_buf );
2739                                         return NULL;
2740                                 }
2741
2742                         } else {
2743
2744                                 const char* class = class_info->class_name;
2745                                 osrfHash* fields = class_info->fields;
2746                                 osrfHash* field = osrfHashGet( fields, search_itr->key );
2747
2748                                 if (!field) {
2749                                         const char* table = class_info->source_def;
2750                                         osrfLogError(
2751                                                 OSRF_LOG_MARK,
2752                                                 "%s: Attempt to reference non-existent column \"%s\" on %s (%s)",
2753                                                 MODULENAME,
2754                                                 search_itr->key,
2755                                                 table ? table : "?",
2756                                                 class ? class : "?"
2757                                         );
2758                                         jsonIteratorFree(search_itr);
2759                                         buffer_free(sql_buf);
2760                                         return NULL;
2761                                 }
2762
2763                                 char* subpred = searchPredicate( class_info, field, node, ctx );
2764                                 if( ! subpred ) {
2765                                         buffer_free(sql_buf);
2766                                         jsonIteratorFree(search_itr);
2767                                         return NULL;
2768                                 }
2769
2770                                 buffer_add( sql_buf, subpred );
2771                                 free(subpred);
2772                         }
2773                 }
2774                 jsonIteratorFree(search_itr);
2775
2776     } else {
2777         // ERROR ... only hash and array allowed at this level
2778         char* predicate_string = jsonObjectToJSON( search_hash );
2779         osrfLogError(
2780             OSRF_LOG_MARK,
2781             "%s: Invalid predicate structure: %s",
2782             MODULENAME,
2783             predicate_string
2784         );
2785         buffer_free(sql_buf);
2786         free(predicate_string);
2787         return NULL;
2788     }
2789
2790         return buffer_release(sql_buf);
2791 }
2792
2793 /* Build a JSON_ARRAY of field names for a given table alias
2794  */
2795 static jsonObject* defaultSelectList( const char* table_alias ) {
2796
2797         if( ! table_alias )
2798                 table_alias = "";
2799
2800         ClassInfo* class_info = search_all_alias( table_alias );
2801         if( ! class_info ) {
2802                 osrfLogError(
2803                         OSRF_LOG_MARK,
2804                         "%s: Can't build default SELECT clause for \"%s\"; no such table alias",
2805                         MODULENAME,
2806                         table_alias
2807                 );
2808                 return NULL;
2809         }
2810
2811         jsonObject* array = jsonNewObjectType( JSON_ARRAY );
2812         osrfHash* field_def = NULL;
2813         osrfHashIterator* field_itr = osrfNewHashIterator( class_info->fields );
2814         while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
2815                 const char* field_name = osrfHashIteratorKey( field_itr );
2816                 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
2817                         jsonObjectPush( array, jsonNewObject( field_name ) );
2818                 }
2819         }
2820         osrfHashIteratorFree( field_itr );
2821
2822         return array;
2823 }
2824
2825 char* SELECT (
2826                 /* method context */ osrfMethodContext* ctx,
2827
2828                 /* SELECT   */ jsonObject* selhash,
2829                 /* FROM     */ jsonObject* join_hash,
2830                 /* WHERE    */ jsonObject* search_hash,
2831                 /* HAVING   */ jsonObject* having_hash,
2832                 /* ORDER BY */ jsonObject* order_hash,
2833                 /* LIMIT    */ jsonObject* limit,
2834                 /* OFFSET   */ jsonObject* offset,
2835                 /* flags    */ int flags
2836 ) {
2837         const char* locale = osrf_message_get_last_locale();
2838
2839         // general tmp objects
2840         const jsonObject* tmp_const;
2841         jsonObject* selclass = NULL;
2842         jsonObject* snode = NULL;
2843         jsonObject* onode = NULL;
2844
2845         char* string = NULL;
2846         int from_function = 0;
2847         int first = 1;
2848         int gfirst = 1;
2849         //int hfirst = 1;
2850
2851         osrfLogDebug(OSRF_LOG_MARK, "cstore SELECT locale: %s", locale);
2852
2853         // punt if there's no FROM clause
2854         if (!join_hash || ( join_hash->type == JSON_HASH && !join_hash->size )) {
2855                 osrfLogError(
2856                         OSRF_LOG_MARK,
2857                         "%s: FROM clause is missing or empty",
2858                         MODULENAME
2859                 );
2860                 if( ctx )
2861                         osrfAppSessionStatus(
2862                                 ctx->session,
2863                                 OSRF_STATUS_INTERNALSERVERERROR,
2864                                 "osrfMethodException",
2865                                 ctx->request,
2866                                 "FROM clause is missing or empty in JSON query"
2867                         );
2868                 return NULL;
2869         }
2870
2871         // Push a node onto the stack for the current query.  Every level of
2872         // subquery gets its own QueryFrame on the Stack.
2873         push_query_frame();
2874
2875         // the core search class
2876         const char* core_class = NULL;
2877
2878         // get the core class -- the only key of the top level FROM clause, or a string
2879         if (join_hash->type == JSON_HASH) {
2880                 jsonIterator* tmp_itr = jsonNewIterator( join_hash );
2881                 snode = jsonIteratorNext( tmp_itr );
2882
2883                 // Populate the current QueryFrame with information
2884                 // about the core class
2885                 if( add_query_core( NULL, tmp_itr->key ) ) {
2886                         if( ctx )
2887                                 osrfAppSessionStatus(
2888                                         ctx->session,
2889                                         OSRF_STATUS_INTERNALSERVERERROR,
2890                                         "osrfMethodException",
2891                                         ctx->request,
2892                                         "Unable to look up core class"
2893                                 );
2894                         return NULL;
2895                 }
2896                 core_class = curr_query->core.class_name;
2897                 join_hash = snode;
2898
2899                 jsonObject* extra = jsonIteratorNext( tmp_itr );
2900
2901                 jsonIteratorFree( tmp_itr );
2902                 snode = NULL;
2903
2904                 // There shouldn't be more than one entry in join_hash
2905                 if( extra ) {
2906                         osrfLogError(
2907                                 OSRF_LOG_MARK,
2908                                 "%s: Malformed FROM clause: extra entry in JSON_HASH",
2909                                 MODULENAME
2910                         );
2911                         if( ctx )
2912                                 osrfAppSessionStatus(
2913                                         ctx->session,
2914                                         OSRF_STATUS_INTERNALSERVERERROR,
2915                                         "osrfMethodException",
2916                                         ctx->request,
2917                                         "Malformed FROM clause in JSON query"
2918                                 );
2919                         return NULL;    // Malformed join_hash; extra entry
2920                 }
2921         } else if (join_hash->type == JSON_ARRAY) {
2922                 // We're selecting from a function, not from a table
2923                 from_function = 1;
2924                 core_class = jsonObjectGetString( jsonObjectGetIndex(join_hash, 0) );
2925                 selhash = NULL;
2926
2927         } else if (join_hash->type == JSON_STRING) {
2928                 // Populate the current QueryFrame with information
2929                 // about the core class
2930                 core_class = jsonObjectGetString( join_hash );
2931                 join_hash = NULL;
2932                 if( add_query_core( NULL, core_class ) ) {
2933                         if( ctx )
2934                                 osrfAppSessionStatus(
2935                                         ctx->session,
2936                                         OSRF_STATUS_INTERNALSERVERERROR,
2937                                         "osrfMethodException",
2938                                         ctx->request,
2939                                         "Unable to look up core class"
2940                                 );
2941                         return NULL;
2942                 }
2943         }
2944         else {
2945                 osrfLogError(
2946                         OSRF_LOG_MARK,
2947                         "%s: FROM clause is unexpected JSON type: %s",
2948                         MODULENAME,
2949                         json_type( join_hash->type )
2950                 );
2951                 if( ctx )
2952                         osrfAppSessionStatus(
2953                                 ctx->session,
2954                                 OSRF_STATUS_INTERNALSERVERERROR,
2955                                 "osrfMethodException",
2956                                 ctx->request,
2957                                 "Ill-formed FROM clause in JSON query"
2958                         );
2959                 return NULL;
2960         }
2961
2962         // Build the join clause, if any, while filling out the list
2963         // of joined classes in the current QueryFrame.
2964         char* join_clause = NULL;
2965         if( join_hash && ! from_function ) {
2966
2967                 join_clause = searchJOIN( join_hash, &curr_query->core );
2968                 if( ! join_clause ) {
2969                         if (ctx)
2970                                 osrfAppSessionStatus(
2971                                         ctx->session,
2972                                         OSRF_STATUS_INTERNALSERVERERROR,
2973                                         "osrfMethodException",
2974                                         ctx->request,
2975                                         "Unable to construct JOIN clause(s)"
2976                                 );
2977                         return NULL;
2978                 }
2979         }
2980
2981         // For in case we don't get a select list
2982         jsonObject* defaultselhash = NULL;
2983
2984         // if there is no select list, build a default select list ...
2985         if (!selhash && !from_function) {
2986                 jsonObject* default_list = defaultSelectList( core_class );
2987                 if( ! default_list ) {
2988                         if (ctx) {
2989                                 osrfAppSessionStatus(
2990                                         ctx->session,
2991                                         OSRF_STATUS_INTERNALSERVERERROR,
2992                                         "osrfMethodException",
2993                                         ctx->request,
2994                                         "Unable to build default SELECT clause in JSON query"
2995                                 );
2996                                 free( join_clause );
2997                                 return NULL;
2998                         }
2999                 }
3000
3001                 selhash = defaultselhash = jsonNewObjectType(JSON_HASH);
3002                 jsonObjectSetKey( selhash, core_class, default_list );
3003         }
3004
3005         // The SELECT clause can be encoded only by a hash
3006         if( !from_function && selhash->type != JSON_HASH ) {
3007                 osrfLogError(
3008                         OSRF_LOG_MARK,
3009                         "%s: Expected JSON_HASH for SELECT clause; found %s",
3010                         MODULENAME,
3011                         json_type( selhash->type )
3012                 );
3013
3014                 if (ctx)
3015                         osrfAppSessionStatus(
3016                                 ctx->session,
3017                                 OSRF_STATUS_INTERNALSERVERERROR,
3018                                 "osrfMethodException",
3019                                 ctx->request,
3020                                 "Malformed SELECT clause in JSON query"
3021                         );
3022                 free( join_clause );
3023                 return NULL;
3024         }
3025
3026         // If you see a null or wild card specifier for the core class, or an
3027         // empty array, replace it with a default SELECT list
3028         tmp_const = jsonObjectGetKeyConst( selhash, core_class );
3029         if ( tmp_const ) {
3030                 int default_needed = 0;   // boolean
3031                 if( JSON_STRING == tmp_const->type
3032                         && !strcmp( "*", jsonObjectGetString( tmp_const ) ))
3033                                 default_needed = 1;
3034                 else if( JSON_NULL == tmp_const->type )
3035                         default_needed = 1;
3036
3037                 if( default_needed ) {
3038                         // Build a default SELECT list
3039                         jsonObject* default_list = defaultSelectList( core_class );
3040                         if( ! default_list ) {
3041                                 if (ctx) {
3042                                         osrfAppSessionStatus(
3043                                                 ctx->session,
3044                                                 OSRF_STATUS_INTERNALSERVERERROR,
3045                                                 "osrfMethodException",
3046                                                 ctx->request,
3047                                                 "Can't build default SELECT clause in JSON query"
3048                                         );
3049                                         free( join_clause );
3050                                         return NULL;
3051                                 }
3052                         }
3053
3054                         jsonObjectSetKey( selhash, core_class, default_list );
3055                 }
3056         }
3057
3058         // temp buffers for the SELECT list and GROUP BY clause
3059         growing_buffer* select_buf = buffer_init(128);
3060         growing_buffer* group_buf = buffer_init(128);
3061
3062         int aggregate_found = 0;     // boolean
3063
3064         // Build a select list
3065         if(from_function)   // From a function we select everything
3066                 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
3067         else {
3068
3069                 // Build the SELECT list as SQL
3070             int sel_pos = 1;
3071             first = 1;
3072             gfirst = 1;
3073             jsonIterator* selclass_itr = jsonNewIterator( selhash );
3074             while ( (selclass = jsonIteratorNext( selclass_itr )) ) {    // For each class
3075
3076                         const char* cname = selclass_itr->key;
3077
3078                         // Make sure the target relation is in the FROM clause.
3079
3080                         // At this point join_hash is a step down from the join_hash we
3081                         // received as a parameter.  If the original was a JSON_STRING,
3082                         // then json_hash is now NULL.  If the original was a JSON_HASH,
3083                         // then json_hash is now the first (and only) entry in it,
3084                         // denoting the core class.  We've already excluded the
3085                         // possibility that the original was a JSON_ARRAY, because in
3086                         // that case from_function would be non-NULL, and we wouldn't
3087                         // be here.
3088
3089                         // If the current table alias isn't in scope, bail out
3090                         ClassInfo* class_info = search_alias( cname );
3091                         if( ! class_info ) {
3092                                 osrfLogError(
3093                                         OSRF_LOG_MARK,
3094                                         "%s: SELECT clause references class not in FROM clause: \"%s\"",
3095                                         MODULENAME,
3096                                         cname
3097                                 );
3098                                 if( ctx )
3099                                         osrfAppSessionStatus(
3100                                                 ctx->session,
3101                                                 OSRF_STATUS_INTERNALSERVERERROR,
3102                                                 "osrfMethodException",
3103                                                 ctx->request,
3104                                                 "Selected class not in FROM clause in JSON query"
3105                                         );
3106                                 jsonIteratorFree( selclass_itr );
3107                                 buffer_free( select_buf );
3108                                 buffer_free( group_buf );
3109                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3110                                 free( join_clause );
3111                                 return NULL;
3112                         }
3113
3114                         if( selclass->type != JSON_ARRAY ) {
3115                                 osrfLogError(
3116                                         OSRF_LOG_MARK,
3117                                         "%s: Malformed SELECT list for class \"%s\"; not an array",
3118                                         MODULENAME,
3119                                         cname
3120                                 );
3121                                 if( ctx )
3122                                         osrfAppSessionStatus(
3123                                                 ctx->session,
3124                                                 OSRF_STATUS_INTERNALSERVERERROR,
3125                                                 "osrfMethodException",
3126                                                 ctx->request,
3127                                                 "Selected class not in FROM clause in JSON query"
3128                                         );
3129
3130                                 jsonIteratorFree( selclass_itr );
3131                                 buffer_free( select_buf );
3132                                 buffer_free( group_buf );
3133                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3134                                 free( join_clause );
3135                                 return NULL;
3136                         }
3137
3138                         // Look up some attributes of the current class
3139                         osrfHash* idlClass = class_info->class_def;
3140                         osrfHash* class_field_set = class_info->fields;
3141                         const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
3142                         const char* class_tname = osrfHashGet( idlClass, "tablename" );
3143
3144                         if( 0 == selclass->size ) {
3145                                 osrfLogWarning(
3146                                         OSRF_LOG_MARK,
3147                                         "%s: No columns selected from \"%s\"",
3148                                         MODULENAME,
3149                                         cname
3150                                 );
3151                         }
3152
3153                         // stitch together the column list for the current table alias...
3154                         unsigned long field_idx = 0;
3155                         jsonObject* selfield = NULL;
3156                         while((selfield = jsonObjectGetIndex( selclass, field_idx++ ) )) {
3157
3158                                 // If we need a separator comma, add one
3159                                 if (first) {
3160                                         first = 0;
3161                                 } else {
3162                                         OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3163                                 }
3164
3165                                 // if the field specification is a string, add it to the list
3166                                 if (selfield->type == JSON_STRING) {
3167
3168                                         // Look up the field in the IDL
3169                                         const char* col_name = jsonObjectGetString( selfield );
3170                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3171                                         if ( !field_def ) {
3172                                                 // No such field in current class
3173                                                 osrfLogError(
3174                                                         OSRF_LOG_MARK,
3175                                                         "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3176                                                         MODULENAME,
3177                                                         col_name,
3178                                                         cname
3179                                                 );
3180                                                 if( ctx )
3181                                                         osrfAppSessionStatus(
3182                                                                 ctx->session,
3183                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3184                                                                 "osrfMethodException",
3185                                                                 ctx->request,
3186                                                                 "Selected column not defined in JSON query"
3187                                                         );
3188                                                 jsonIteratorFree( selclass_itr );
3189                                                 buffer_free( select_buf );
3190                                                 buffer_free( group_buf );
3191                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3192                                                 free( join_clause );
3193                                                 return NULL;
3194                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3195                                                 // Virtual field not allowed
3196                                                 osrfLogError(
3197                                                         OSRF_LOG_MARK,
3198                                                         "%s: Selected column \"%s\" for class \"%s\" is virtual",
3199                                                         MODULENAME,
3200                                                         col_name,
3201                                                         cname
3202                                                 );
3203                                                 if( ctx )
3204                                                         osrfAppSessionStatus(
3205                                                                 ctx->session,
3206                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3207                                                                 "osrfMethodException",
3208                                                                 ctx->request,
3209                                                                 "Selected column may not be virtual in JSON query"
3210                                                         );
3211                                                 jsonIteratorFree( selclass_itr );
3212                                                 buffer_free( select_buf );
3213                                                 buffer_free( group_buf );
3214                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3215                                                 free( join_clause );
3216                                                 return NULL;
3217                                         }
3218
3219                                         if (locale) {
3220                                                 const char* i18n;
3221                                                 if (flags & DISABLE_I18N)
3222                                                         i18n = NULL;
3223                                                 else
3224                                                         i18n = osrfHashGet(field_def, "i18n");
3225
3226                                                 if( str_is_true( i18n ) ) {
3227                             buffer_fadd( select_buf,
3228                                                                 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3229                                                                 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3230                         } else {
3231                                             buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3232                         }
3233                     } else {
3234                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3235                     }
3236
3237                                 // ... but it could be an object, in which case we check for a Field Transform
3238                                 } else if (selfield->type == JSON_HASH) {
3239
3240                                         const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3241
3242                                         // Get the field definition from the IDL
3243                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3244                                         if ( !field_def ) {
3245                                                 // No such field in current class
3246                                                 osrfLogError(
3247                                                         OSRF_LOG_MARK,
3248                                                         "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3249                                                         MODULENAME,
3250                                                         col_name,
3251                                                         cname
3252                                                 );
3253                                                 if( ctx )
3254                                                         osrfAppSessionStatus(
3255                                                                 ctx->session,
3256                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3257                                                                 "osrfMethodException",
3258                                                                 ctx->request,
3259                                                                 "Selected column is not defined in JSON query"
3260                                                         );
3261                                                 jsonIteratorFree( selclass_itr );
3262                                                 buffer_free( select_buf );
3263                                                 buffer_free( group_buf );
3264                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3265                                                 free( join_clause );
3266                                                 return NULL;
3267                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3268                                                 // No such field in current class
3269                                                 osrfLogError(
3270                                                         OSRF_LOG_MARK,
3271                                                         "%s: Selected column \"%s\" is virtual for class \"%s\"",
3272                                                         MODULENAME,
3273                                                         col_name,
3274                                                         cname
3275                                                 );
3276                                                 if( ctx )
3277                                                         osrfAppSessionStatus(
3278                                                                 ctx->session,
3279                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3280                                                                 "osrfMethodException",
3281                                                                 ctx->request,
3282                                                                 "Selected column is virtual in JSON query"
3283                                                         );
3284                                                 jsonIteratorFree( selclass_itr );
3285                                                 buffer_free( select_buf );
3286                                                 buffer_free( group_buf );
3287                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3288                                                 free( join_clause );
3289                                                 return NULL;
3290                                         }
3291
3292                                         // Decide what to use as a column alias
3293                                         const char* _alias;
3294                                         if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3295                                                 _alias = jsonObjectGetString( tmp_const );
3296                                         } else {         // Use field name as the alias
3297                                                 _alias = col_name;
3298                                         }
3299
3300                                         if (jsonObjectGetKeyConst( selfield, "transform" )) {
3301                                                 char* transform_str = searchFieldTransform(class_info->alias, field_def, selfield);
3302                                                 if( transform_str ) {
3303                                                         buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3304                                                         free(transform_str);
3305                                                 } else {
3306                                                         if( ctx )
3307                                                                 osrfAppSessionStatus(
3308                                                                         ctx->session,
3309                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3310                                                                         "osrfMethodException",
3311                                                                         ctx->request,
3312                                                                         "Unable to generate transform function in JSON query"
3313                                                                 );
3314                                                         jsonIteratorFree( selclass_itr );
3315                                                         buffer_free( select_buf );
3316                                                         buffer_free( group_buf );
3317                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3318                                                         free( join_clause );
3319                                                         return NULL;
3320                                                 }
3321                                         } else {
3322
3323                                                 if (locale) {
3324                                                         const char* i18n;
3325                                                         if (flags & DISABLE_I18N)
3326                                                                 i18n = NULL;
3327                                                         else
3328                                                                 i18n = osrfHashGet(field_def, "i18n");
3329
3330                                                         if( str_is_true( i18n ) ) {
3331                                                                 buffer_fadd( select_buf,
3332                                                                         " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3333                                                                         class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3334                                                         } else {
3335                                                                 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3336                                                         }
3337                                                 } else {
3338                                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3339                                                 }
3340                                         }
3341                                 }
3342                                 else {
3343                                         osrfLogError(
3344                                                 OSRF_LOG_MARK,
3345                                                 "%s: Selected item is unexpected JSON type: %s",
3346                                                 MODULENAME,
3347                                                 json_type( selfield->type )
3348                                         );
3349                                         if( ctx )
3350                                                 osrfAppSessionStatus(
3351                                                         ctx->session,
3352                                                         OSRF_STATUS_INTERNALSERVERERROR,
3353                                                         "osrfMethodException",
3354                                                         ctx->request,
3355                                                         "Ill-formed SELECT item in JSON query"
3356                                                 );
3357                                         jsonIteratorFree( selclass_itr );
3358                                         buffer_free( select_buf );
3359                                         buffer_free( group_buf );
3360                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3361                                         free( join_clause );
3362                                         return NULL;
3363                                 }
3364
3365                                 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3366                                 if( obj_is_true( agg_obj ) )
3367                                         aggregate_found = 1;
3368                                 else {
3369                                         // Append a comma (except for the first one)
3370                                         // and add the column to a GROUP BY clause
3371                                         if (gfirst)
3372                                                 gfirst = 0;
3373                                         else
3374                                                 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3375
3376                                         buffer_fadd(group_buf, " %d", sel_pos);
3377                                 }
3378
3379 #if 0
3380                             if (is_agg->size || (flags & SELECT_DISTINCT)) {
3381
3382                                         const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3383                                     if ( ! obj_is_true( aggregate_obj ) ) {
3384                                             if (gfirst) {
3385                                                     gfirst = 0;
3386                                             } else {
3387                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3388                                             }
3389
3390                                             buffer_fadd(group_buf, " %d", sel_pos);
3391
3392                                         /*
3393                                     } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3394                                             if (gfirst) {
3395                                                     gfirst = 0;
3396                                             } else {
3397                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3398                                             }
3399
3400                                             _column = searchFieldTransform(class_info->alias, field, selfield);
3401                                                 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3402                                                 OSRF_BUFFER_ADD(group_buf, _column);
3403                                             _column = searchFieldTransform(class_info->alias, field, selfield);
3404                                         */
3405                                     }
3406                             }
3407 #endif
3408
3409                                 sel_pos++;
3410                         } // end while -- iterating across SELECT columns
3411
3412                 } // end while -- iterating across classes
3413
3414                 jsonIteratorFree(selclass_itr);
3415         }
3416
3417
3418         char* col_list = buffer_release(select_buf);
3419
3420         // Make sure the SELECT list isn't empty.  This can happen, for example,
3421         // if we try to build a default SELECT clause from a non-core table.
3422
3423         if( ! *col_list ) {
3424                 osrfLogError(OSRF_LOG_MARK, "%s: SELECT clause is empty", MODULENAME );
3425                 if (ctx)
3426                         osrfAppSessionStatus(
3427                                 ctx->session,
3428                                 OSRF_STATUS_INTERNALSERVERERROR,
3429                                 "osrfMethodException",
3430                                 ctx->request,
3431                                 "SELECT list is empty"
3432                 );
3433                 free( col_list );
3434                 buffer_free( group_buf );
3435                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3436                 free( join_clause );
3437                 return NULL;
3438         }
3439
3440         char* table = NULL;
3441         if (from_function) table = searchValueTransform(join_hash);
3442         else table = strdup( curr_query->core.source_def );
3443
3444         if( !table ) {
3445                 if (ctx)
3446                         osrfAppSessionStatus(
3447                                 ctx->session,
3448                                 OSRF_STATUS_INTERNALSERVERERROR,
3449                                 "osrfMethodException",
3450                                 ctx->request,
3451                                 "Unable to identify table for core class"
3452                         );
3453                 free( col_list );
3454                 buffer_free( group_buf );
3455                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3456                 free( join_clause );
3457                 return NULL;
3458         }
3459
3460         // Put it all together
3461         growing_buffer* sql_buf = buffer_init(128);
3462         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3463         free(col_list);
3464         free(table);
3465
3466         // Append the join clause, if any
3467         if( join_clause ) {
3468                 buffer_add(sql_buf, join_clause);
3469                 free(join_clause);
3470         }
3471
3472         char* order_by_list = NULL;
3473         char* having_buf = NULL;
3474
3475         if (!from_function) {
3476
3477                 // Build a WHERE clause, if there is one
3478                 if ( search_hash ) {
3479                         buffer_add(sql_buf, " WHERE ");
3480
3481                         // and it's on the WHERE clause
3482                         char* pred = searchWHERE( search_hash, &curr_query->core, AND_OP_JOIN, ctx );
3483                         if ( ! pred ) {
3484                                 if (ctx) {
3485                                         osrfAppSessionStatus(
3486                                                 ctx->session,
3487                                                 OSRF_STATUS_INTERNALSERVERERROR,
3488                                                 "osrfMethodException",
3489                                                 ctx->request,
3490                                                 "Severe query error in WHERE predicate -- see error log for more details"
3491                                         );
3492                                 }
3493                                 buffer_free(group_buf);
3494                                 buffer_free(sql_buf);
3495                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3496                                 return NULL;
3497                         }
3498
3499                         buffer_add(sql_buf, pred);
3500                         free(pred);
3501                 }
3502
3503                 // Build a HAVING clause, if there is one
3504                 if ( having_hash ) {
3505
3506                         // and it's on the the WHERE clause
3507                         having_buf = searchWHERE( having_hash, &curr_query->core, AND_OP_JOIN, ctx );
3508
3509                         if( ! having_buf ) {
3510                                 if (ctx) {
3511                                                 osrfAppSessionStatus(
3512                                                 ctx->session,
3513                                                 OSRF_STATUS_INTERNALSERVERERROR,
3514                                                 "osrfMethodException",
3515                                                 ctx->request,
3516                                                 "Severe query error in HAVING predicate -- see error log for more details"
3517                                         );
3518                                 }
3519                                 buffer_free(group_buf);
3520                                 buffer_free(sql_buf);
3521                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3522                                 return NULL;
3523                         }
3524                 }
3525
3526                 growing_buffer* order_buf = NULL;  // to collect ORDER BY list
3527
3528                 // Build an ORDER BY clause, if there is one
3529                 if( NULL == order_hash )
3530                         ;  // No ORDER BY? do nothing
3531                 else if( JSON_ARRAY == order_hash->type ) {
3532                         // Array of field specifications, each specification being a
3533                         // hash to define the class, field, and other details
3534                         int order_idx = 0;
3535                         jsonObject* order_spec;
3536                         while( (order_spec = jsonObjectGetIndex( order_hash, order_idx++ ) ) ) {
3537
3538                                 if( JSON_HASH != order_spec->type ) {
3539                                         osrfLogError(OSRF_LOG_MARK,
3540                                                  "%s: Malformed field specification in ORDER BY clause; expected JSON_HASH, found %s",
3541                                                 MODULENAME, json_type( order_spec->type ) );
3542                                         if( ctx )
3543                                                 osrfAppSessionStatus(
3544                                                          ctx->session,
3545                                                         OSRF_STATUS_INTERNALSERVERERROR,
3546                                                         "osrfMethodException",
3547                                                         ctx->request,
3548                                                         "Malformed ORDER BY clause -- see error log for more details"
3549                                                 );
3550                                         buffer_free( order_buf );
3551                                         free(having_buf);
3552                                         buffer_free(group_buf);
3553                                         buffer_free(sql_buf);
3554                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3555                                         return NULL;
3556                                 }
3557
3558                                 const char* class_alias =
3559                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "class" ) );
3560                                 const char* field =
3561                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "field" ) );
3562
3563                                 if ( order_buf )
3564                                         OSRF_BUFFER_ADD(order_buf, ", ");
3565                                 else
3566                                         order_buf = buffer_init(128);
3567
3568                                 if( !field || !class_alias ) {
3569                                         osrfLogError(OSRF_LOG_MARK,
3570                                                 "%s: Missing class or field name in field specification of ORDER BY clause",
3571                                                  MODULENAME );
3572                                         if( ctx )
3573                                                 osrfAppSessionStatus(
3574                                                         ctx->session,
3575                                                         OSRF_STATUS_INTERNALSERVERERROR,
3576                                                         "osrfMethodException",
3577                                                         ctx->request,
3578                                                         "Malformed ORDER BY clause -- see error log for more details"
3579                                                 );
3580                                         buffer_free( order_buf );
3581                                         free(having_buf);
3582                                         buffer_free(group_buf);
3583                                         buffer_free(sql_buf);
3584                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3585                                         return NULL;
3586                                 }
3587
3588                                 ClassInfo* order_class_info = search_alias( class_alias );
3589                                 if( ! order_class_info ) {
3590                                         osrfLogError(OSRF_LOG_MARK, "%s: ORDER BY clause references class \"%s\" "
3591                                                         "not in FROM clause", MODULENAME, class_alias );
3592                                         if( ctx )
3593                                                 osrfAppSessionStatus(
3594                                                         ctx->session,
3595                                                         OSRF_STATUS_INTERNALSERVERERROR,
3596                                                         "osrfMethodException",
3597                                                         ctx->request,
3598                                                         "Invalid class referenced in ORDER BY clause -- see error log for more details"
3599                                                 );
3600                                         free(having_buf);
3601                                         buffer_free(group_buf);
3602                                         buffer_free(sql_buf);
3603                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3604                                         return NULL;
3605                                 }
3606
3607                                 osrfHash* field_def = osrfHashGet( order_class_info->fields, field );
3608                                 if( !field_def ) {
3609                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\".%s referenced in ORDER BY clause",
3610                                                  MODULENAME, class_alias, field );
3611                                         if( ctx )
3612                                                 osrfAppSessionStatus(
3613                                                         ctx->session,
3614                                                         OSRF_STATUS_INTERNALSERVERERROR,
3615                                                         "osrfMethodException",
3616                                                         ctx->request,
3617                                                         "Invalid field referenced in ORDER BY clause -- see error log for more details"
3618                                                 );
3619                                         free(having_buf);
3620                                         buffer_free(group_buf);
3621                                         buffer_free(sql_buf);
3622                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3623                                         return NULL;
3624                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3625                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3626                                                                  MODULENAME, field );
3627                                         if( ctx )
3628                                                 osrfAppSessionStatus(
3629                                                         ctx->session,
3630                                                         OSRF_STATUS_INTERNALSERVERERROR,
3631                                                         "osrfMethodException",
3632                                                         ctx->request,
3633                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3634                                                 );
3635                                         buffer_free( order_buf );
3636                                         free(having_buf);
3637                                         buffer_free(group_buf);
3638                                         buffer_free(sql_buf);
3639                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3640                                         return NULL;
3641                                 }
3642
3643                                 if( jsonObjectGetKeyConst( order_spec, "transform" ) ) {
3644                                         char* transform_str = searchFieldTransform( class_alias, field_def, order_spec );
3645                                         if( ! transform_str ) {
3646                                                 if( ctx )
3647                                                         osrfAppSessionStatus(
3648                                                                 ctx->session,
3649                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3650                                                                 "osrfMethodException",
3651                                                                 ctx->request,
3652                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3653                                                         );
3654                                                 buffer_free( order_buf );
3655                                                 free(having_buf);
3656                                                 buffer_free(group_buf);
3657                                                 buffer_free(sql_buf);
3658                                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3659                                                 return NULL;
3660                                         }
3661
3662                                         OSRF_BUFFER_ADD( order_buf, transform_str );
3663                                         free( transform_str );
3664                                 }
3665                                 else
3666                                         buffer_fadd( order_buf, "\"%s\".%s", class_alias, field );
3667
3668                                 const char* direction =
3669                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "direction" ) );
3670                                 if( direction ) {
3671                                         if( direction[ 0 ] || 'D' == direction[ 0 ] )
3672                                                 OSRF_BUFFER_ADD( order_buf, " DESC" );
3673                                         else
3674                                                 OSRF_BUFFER_ADD( order_buf, " ASC" );
3675                                 }
3676                         }
3677                 } else if( JSON_HASH == order_hash->type ) {
3678                         // This hash is keyed on class alias.  Each class has either
3679                         // an array of field names or a hash keyed on field name.
3680                         jsonIterator* class_itr = jsonNewIterator( order_hash );
3681                         while ( (snode = jsonIteratorNext( class_itr )) ) {
3682
3683                                 ClassInfo* order_class_info = search_alias( class_itr->key );
3684                                 if( ! order_class_info ) {
3685                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid class \"%s\" referenced in ORDER BY clause",
3686                                                                  MODULENAME, class_itr->key );
3687                                         if( ctx )
3688                                                 osrfAppSessionStatus(
3689                                                         ctx->session,
3690                                                         OSRF_STATUS_INTERNALSERVERERROR,
3691                                                         "osrfMethodException",
3692                                                         ctx->request,
3693                                                         "Invalid class referenced in ORDER BY clause -- see error log for more details"
3694                                                 );
3695                                         jsonIteratorFree( class_itr );
3696                                         buffer_free( order_buf );
3697                                         free(having_buf);
3698                                         buffer_free(group_buf);
3699                                         buffer_free(sql_buf);
3700                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3701                                         return NULL;
3702                                 }
3703
3704                                 osrfHash* field_list_def = order_class_info->fields;
3705
3706                                 if ( snode->type == JSON_HASH ) {
3707
3708                                         // Hash is keyed on field names from the current class.  For each field
3709                                         // there is another layer of hash to define the sorting details, if any,
3710                                         // or a string to indicate direction of sorting.
3711                                         jsonIterator* order_itr = jsonNewIterator( snode );
3712                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
3713
3714                                                 osrfHash* field_def = osrfHashGet( field_list_def, order_itr->key );
3715                                                 if( !field_def ) {
3716                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3717                                                                         MODULENAME, order_itr->key );
3718                                                         if( ctx )
3719                                                                 osrfAppSessionStatus(
3720                                                                         ctx->session,
3721                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3722                                                                         "osrfMethodException",
3723                                                                         ctx->request,
3724                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3725                                                                 );
3726                                                         jsonIteratorFree( order_itr );
3727                                                         jsonIteratorFree( class_itr );
3728                                                         buffer_free( order_buf );
3729                                                         free(having_buf);
3730                                                         buffer_free(group_buf);
3731                                                         buffer_free(sql_buf);
3732                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3733                                                         return NULL;
3734                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3735                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3736                                                                  MODULENAME, order_itr->key );
3737                                                         if( ctx )
3738                                                                 osrfAppSessionStatus(
3739                                                                         ctx->session,
3740                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3741                                                                         "osrfMethodException",
3742                                                                         ctx->request,
3743                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3744                                                         );
3745                                                         jsonIteratorFree( order_itr );
3746                                                         jsonIteratorFree( class_itr );
3747                                                         buffer_free( order_buf );
3748                                                         free(having_buf);
3749                                                         buffer_free(group_buf);
3750                                                         buffer_free(sql_buf);
3751                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3752                                                         return NULL;
3753                                                 }
3754
3755                                                 const char* direction = NULL;
3756                                                 if ( onode->type == JSON_HASH ) {
3757                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3758                                                                 string = searchFieldTransform(
3759                                                                         class_itr->key,
3760                                                                         osrfHashGet( field_list_def, order_itr->key ),
3761                                                                         onode
3762                                                                 );
3763                                                                 if( ! string ) {
3764                                                                         if( ctx ) osrfAppSessionStatus(
3765                                                                                 ctx->session,
3766                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3767                                                                                 "osrfMethodException",
3768                                                                                 ctx->request,
3769                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3770                                                                         );
3771                                                                         jsonIteratorFree( order_itr );
3772                                                                         jsonIteratorFree( class_itr );
3773                                                                         free(having_buf);
3774                                                                         buffer_free(group_buf);
3775                                                                         buffer_free(order_buf);
3776                                                                         buffer_free(sql_buf);
3777                                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3778                                                                         return NULL;
3779                                                                 }
3780                                                         } else {
3781                                                                 growing_buffer* field_buf = buffer_init(16);
3782                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3783                                                                 string = buffer_release(field_buf);
3784                                                         }
3785
3786                                                         if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3787                                                                 const char* dir = jsonObjectGetString(tmp_const);
3788                                                                 if (!strncasecmp(dir, "d", 1)) {
3789                                                                         direction = " DESC";
3790                                                                 } else {
3791                                                                         direction = " ASC";
3792                                                                 }
3793                                                         }
3794
3795                                                 } else if ( JSON_NULL == onode->type || JSON_ARRAY == onode->type ) {
3796                                                         osrfLogError( OSRF_LOG_MARK,
3797                                                                 "%s: Expected JSON_STRING in ORDER BY clause; found %s",
3798                                                                 MODULENAME, json_type( onode->type ) );
3799                                                         if( ctx )
3800                                                                 osrfAppSessionStatus(
3801                                                                         ctx->session,
3802                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3803                                                                         "osrfMethodException",
3804                                                                         ctx->request,
3805                                                                         "Malformed ORDER BY clause -- see error log for more details"
3806                                                                 );
3807                                                         jsonIteratorFree( order_itr );
3808                                                         jsonIteratorFree( class_itr );
3809                                                         free(having_buf);
3810                                                         buffer_free(group_buf);
3811                                                         buffer_free(order_buf);
3812                                                         buffer_free(sql_buf);
3813                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3814                                                         return NULL;
3815
3816                                                 } else {
3817                                                         string = strdup(order_itr->key);
3818                                                         const char* dir = jsonObjectGetString(onode);
3819                                                         if (!strncasecmp(dir, "d", 1)) {
3820                                                                 direction = " DESC";
3821                                                         } else {
3822                                                                 direction = " ASC";
3823                                                         }
3824                                                 }
3825
3826                                                 if ( order_buf )
3827                                                         OSRF_BUFFER_ADD(order_buf, ", ");
3828                                                 else
3829                                                         order_buf = buffer_init(128);
3830
3831                                                 OSRF_BUFFER_ADD(order_buf, string);
3832                                                 free(string);
3833
3834                                                 if (direction) {
3835                                                          OSRF_BUFFER_ADD(order_buf, direction);
3836                                                 }
3837
3838                                         } // end while
3839                                         jsonIteratorFree(order_itr);
3840
3841                                 } else if ( snode->type == JSON_ARRAY ) {
3842
3843                                         // Array is a list of fields from the current class
3844                                         unsigned long order_idx = 0;
3845                                         while(( onode = jsonObjectGetIndex( snode, order_idx++ ) )) {
3846
3847                                                 const char* _f = jsonObjectGetString( onode );
3848
3849                                                 osrfHash* field_def = osrfHashGet( field_list_def, _f );
3850                                                 if( !field_def ) {
3851                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3852                                                                         MODULENAME, _f );
3853                                                         if( ctx )
3854                                                                 osrfAppSessionStatus(
3855                                                                         ctx->session,
3856                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3857                                                                         "osrfMethodException",
3858                                                                         ctx->request,
3859                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3860                                                                 );
3861                                                         jsonIteratorFree( class_itr );
3862                                                         buffer_free( order_buf );
3863                                                         free(having_buf);
3864                                                         buffer_free(group_buf);
3865                                                         buffer_free(sql_buf);
3866                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3867                                                         return NULL;
3868                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3869                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3870                                                                         MODULENAME, _f );
3871                                                         if( ctx )
3872                                                                 osrfAppSessionStatus(
3873                                                                         ctx->session,
3874                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3875                                                                         "osrfMethodException",
3876                                                                         ctx->request,
3877                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3878                                                                 );
3879                                                         jsonIteratorFree( class_itr );
3880                                                         buffer_free( order_buf );
3881                                                         free(having_buf);
3882                                                         buffer_free(group_buf);
3883                                                         buffer_free(sql_buf);
3884                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3885                                                         return NULL;
3886                                                 }
3887
3888                                                 if ( order_buf )
3889                                                         OSRF_BUFFER_ADD(order_buf, ", ");
3890                                                 else
3891                                                         order_buf = buffer_init(128);
3892
3893                                                 buffer_fadd( order_buf, "\"%s\".%s", class_itr->key, _f);
3894
3895                                         } // end while
3896
3897                                 // IT'S THE OOOOOOOOOOOLD STYLE!
3898                                 } else {
3899                                         osrfLogError(OSRF_LOG_MARK,
3900                                                         "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3901                                         if (ctx) {
3902                                                 osrfAppSessionStatus(
3903                                                         ctx->session,
3904                                                         OSRF_STATUS_INTERNALSERVERERROR,
3905                                                         "osrfMethodException",
3906                                                         ctx->request,
3907                                                         "Severe query error -- see error log for more details"
3908                                                 );
3909                                         }
3910
3911                                         free(having_buf);
3912                                         buffer_free(group_buf);
3913                                         buffer_free(order_buf);
3914                                         buffer_free(sql_buf);
3915                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3916                                         jsonIteratorFree(class_itr);
3917                                         return NULL;
3918                                 }
3919                         } // end while
3920                         jsonIteratorFree( class_itr );
3921                 } else {
3922                         osrfLogError(OSRF_LOG_MARK,
3923                                 "%s: Malformed ORDER BY clause; expected JSON_HASH or JSON_ARRAY, found %s",
3924                                 MODULENAME, json_type( order_hash->type ) );
3925                         if( ctx )
3926                                 osrfAppSessionStatus(
3927                                         ctx->session,
3928                                         OSRF_STATUS_INTERNALSERVERERROR,
3929                                         "osrfMethodException",
3930                                         ctx->request,
3931                                         "Malformed ORDER BY clause -- see error log for more details"
3932                                 );
3933                         buffer_free( order_buf );
3934                         free(having_buf);
3935                         buffer_free(group_buf);
3936                         buffer_free(sql_buf);
3937                         if (defaultselhash) jsonObjectFree(defaultselhash);
3938                         return NULL;
3939                 }
3940
3941                 if( order_buf )
3942                         order_by_list = buffer_release( order_buf );
3943         }
3944
3945
3946         string = buffer_release(group_buf);
3947
3948         if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3949                 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3950                 OSRF_BUFFER_ADD( sql_buf, string );
3951         }
3952
3953         free(string);
3954
3955         if( having_buf && *having_buf ) {
3956                 OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3957                 OSRF_BUFFER_ADD( sql_buf, having_buf );
3958                 free( having_buf );
3959         }
3960
3961         if( order_by_list ) {
3962
3963                 if ( *order_by_list ) {
3964                         OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3965                         OSRF_BUFFER_ADD( sql_buf, order_by_list );
3966                 }
3967
3968                 free( order_by_list );
3969         }
3970
3971         if ( limit ){
3972                 const char* str = jsonObjectGetString(limit);
3973                 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3974         }
3975
3976         if (offset) {
3977                 const char* str = jsonObjectGetString(offset);
3978                 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3979         }
3980
3981         if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3982
3983         if (defaultselhash) jsonObjectFree(defaultselhash);
3984
3985         return buffer_release(sql_buf);
3986
3987 } // end of SELECT()
3988
3989 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3990
3991         const char* locale = osrf_message_get_last_locale();
3992
3993         osrfHash* fields = osrfHashGet(meta, "fields");
3994         char* core_class = osrfHashGet(meta, "classname");
3995
3996         const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3997
3998         jsonObject* node = NULL;
3999         jsonObject* snode = NULL;
4000         jsonObject* onode = NULL;
4001         const jsonObject* _tmp = NULL;
4002         jsonObject* selhash = NULL;
4003         jsonObject* defaultselhash = NULL;
4004
4005         growing_buffer* sql_buf = buffer_init(128);
4006         growing_buffer* select_buf = buffer_init(128);
4007
4008         if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
4009                 defaultselhash = jsonNewObjectType(JSON_HASH);
4010                 selhash = defaultselhash;
4011         }
4012
4013         // If there's no SELECT list for the core class, build one
4014         if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
4015                 jsonObject* field_list = jsonNewObjectType( JSON_ARRAY );
4016
4017                 // Add every non-virtual field to the field list
4018                 osrfHash* field_def = NULL;
4019                 osrfHashIterator* field_itr = osrfNewHashIterator( fields );
4020                 while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
4021                         if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
4022                                 const char* field = osrfHashIteratorKey( field_itr );
4023                                 jsonObjectPush( field_list, jsonNewObject( field ) );
4024                         }
4025                 }
4026                 osrfHashIteratorFree( field_itr );
4027                 jsonObjectSetKey( selhash, core_class, field_list );
4028         }
4029
4030         int first = 1;
4031         jsonIterator* class_itr = jsonNewIterator( selhash );
4032         while ( (snode = jsonIteratorNext( class_itr )) ) {
4033
4034                 const char* cname = class_itr->key;
4035                 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
4036                 if (!idlClass) continue;
4037
4038                 if (strcmp(core_class,class_itr->key)) {
4039                         if (!join_hash) continue;
4040
4041                         jsonObject* found =  jsonObjectFindPath(join_hash, "//%s", class_itr->key);
4042                         if (!found->size) {
4043                                 jsonObjectFree(found);
4044                                 continue;
4045                         }
4046
4047                         jsonObjectFree(found);
4048                 }
4049
4050                 jsonIterator* select_itr = jsonNewIterator( snode );
4051                 while ( (node = jsonIteratorNext( select_itr )) ) {
4052                         const char* item_str = jsonObjectGetString( node );
4053                         osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
4054                         char* fname = osrfHashGet(field, "name");
4055
4056                         if (!field) continue;
4057
4058                         if (first) {
4059                                 first = 0;
4060                         } else {
4061                                 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
4062                         }
4063
4064             if (locale) {
4065                         const char* i18n;
4066                                 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
4067                                 if ( obj_is_true( no_i18n_obj ) )    // Suppress internationalization?
4068                                         i18n = NULL;
4069                                 else
4070                                         i18n = osrfHashGet(field, "i18n");
4071
4072                                 if( str_is_true( i18n ) ) {
4073                         char* pkey = osrfHashGet(idlClass, "primarykey");
4074                         char* tname = osrfHashGet(idlClass, "tablename");
4075
4076                     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);
4077                 } else {
4078                                 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
4079                 }
4080             } else {
4081                             buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
4082             }
4083                 }
4084
4085         jsonIteratorFree(select_itr);
4086         }
4087
4088     jsonIteratorFree(class_itr);
4089
4090         char* col_list = buffer_release(select_buf);
4091         char* table = getSourceDefinition(meta);
4092         if( !table )
4093                 table = strdup( "(null)" );
4094
4095         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
4096         free(col_list);
4097         free(table);
4098
4099         // Clear the query stack (as a fail-safe precaution against possible
4100         // leftover garbage); then push the first query frame onto the stack.
4101         clear_query_stack();
4102         push_query_frame();
4103         if( add_query_core( NULL, core_class ) ) {
4104                 if( ctx )
4105                         osrfAppSessionStatus(
4106                                 ctx->session,
4107                                 OSRF_STATUS_INTERNALSERVERERROR,
4108                                 "osrfMethodException",
4109                                 ctx->request,
4110                                 "Unable to build query frame for core class"
4111                         );
4112                 return NULL;
4113         }
4114
4115         if ( join_hash ) {
4116                 char* join_clause = searchJOIN( join_hash, &curr_query->core );
4117                 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
4118                 OSRF_BUFFER_ADD(sql_buf, join_clause);
4119                 free(join_clause);
4120         }
4121
4122         osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL =  %s",
4123                                  MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
4124
4125         OSRF_BUFFER_ADD(sql_buf, " WHERE ");
4126
4127         char* pred = searchWHERE( search_hash, &curr_query->core, AND_OP_JOIN, ctx );
4128         if (!pred) {
4129                 osrfAppSessionStatus(
4130                         ctx->session,
4131                         OSRF_STATUS_INTERNALSERVERERROR,
4132                                 "osrfMethodException",
4133                                 ctx->request,
4134                                 "Severe query error -- see error log for more details"
4135                         );
4136                 buffer_free(sql_buf);
4137                 if(defaultselhash) jsonObjectFree(defaultselhash);
4138                 clear_query_stack();
4139                 return NULL;
4140         } else {
4141                 buffer_add(sql_buf, pred);
4142                 free(pred);
4143         }
4144
4145         if (order_hash) {
4146                 char* string = NULL;
4147                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
4148
4149                         growing_buffer* order_buf = buffer_init(128);
4150
4151                         first = 1;
4152                         jsonIterator* class_itr = jsonNewIterator( _tmp );
4153                         while ( (snode = jsonIteratorNext( class_itr )) ) {
4154
4155                                 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
4156                                         continue;
4157
4158                                 if ( snode->type == JSON_HASH ) {
4159
4160                                         jsonIterator* order_itr = jsonNewIterator( snode );
4161                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
4162
4163                                                 osrfHash* field_def = oilsIDLFindPath( "/%s/fields/%s",
4164                                                                 class_itr->key, order_itr->key );
4165                                                 if ( !field_def )
4166                                                         continue;
4167
4168                                                 char* direction = NULL;
4169                                                 if ( onode->type == JSON_HASH ) {
4170                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
4171                                                                 string = searchFieldTransform( class_itr->key, field_def, onode );
4172                                                                 if( ! string ) {
4173                                                                         osrfAppSessionStatus(
4174                                                                                 ctx->session,
4175                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
4176                                                                                 "osrfMethodException",
4177                                                                                 ctx->request,
4178                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
4179                                                                         );
4180                                                                         jsonIteratorFree( order_itr );
4181                                                                         jsonIteratorFree( class_itr );
4182                                                                         buffer_free( order_buf );
4183                                                                         buffer_free( sql_buf );
4184                                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
4185                                                                         clear_query_stack();
4186                                                                         return NULL;
4187                                                                 }
4188                                                         } else {
4189                                                                 growing_buffer* field_buf = buffer_init(16);
4190                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
4191                                                                 string = buffer_release(field_buf);
4192                                                         }
4193
4194                                                         if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
4195                                                                 const char* dir = jsonObjectGetString(_tmp);
4196                                                                 if (!strncasecmp(dir, "d", 1)) {
4197                                                                         direction = " DESC";
4198                                                                 } else {
4199                                                                         free(direction);
4200                                                                 }
4201                                                         }
4202
4203                                                 } else {
4204                                                         string = strdup(order_itr->key);
4205                                                         const char* dir = jsonObjectGetString(onode);
4206                                                         if (!strncasecmp(dir, "d", 1)) {
4207                                                                 direction = " DESC";
4208                                                         } else {
4209                                                                 direction = " ASC";
4210                                                         }
4211                                                 }
4212
4213                                                 if (first) {
4214                                                         first = 0;
4215                                                 } else {
4216                                                         buffer_add(order_buf, ", ");
4217                                                 }
4218
4219                                                 buffer_add(order_buf, string);
4220                                                 free(string);
4221
4222                                                 if (direction) {
4223                                                         buffer_add(order_buf, direction);
4224                                                 }
4225
4226                                         }
4227
4228                     jsonIteratorFree(order_itr);
4229
4230                                 } else {
4231                                         const char* str = jsonObjectGetString(snode);
4232                                         buffer_add(order_buf, str);
4233                                         break;
4234                                 }
4235
4236                         }
4237
4238                         jsonIteratorFree(class_itr);
4239
4240                         string = buffer_release(order_buf);
4241
4242                         if ( *string ) {
4243                                 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
4244                                 OSRF_BUFFER_ADD( sql_buf, string );
4245                         }
4246
4247                         free(string);
4248                 }
4249
4250                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
4251                         const char* str = jsonObjectGetString(_tmp);
4252                         buffer_fadd(
4253                                 sql_buf,
4254                                 " LIMIT %d",
4255                                 atoi(str)
4256                         );
4257                 }
4258
4259                 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
4260                 if (_tmp) {
4261                         const char* str = jsonObjectGetString(_tmp);
4262                         buffer_fadd(
4263                                 sql_buf,
4264                                 " OFFSET %d",
4265                                 atoi(str)
4266                         );
4267                 }
4268         }
4269
4270         if (defaultselhash) jsonObjectFree(defaultselhash);
4271         clear_query_stack();
4272
4273         OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
4274         return buffer_release(sql_buf);
4275 }
4276
4277 int doJSONSearch ( osrfMethodContext* ctx ) {
4278         if(osrfMethodVerifyContext( ctx )) {
4279                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
4280                 return -1;
4281         }
4282
4283         osrfLogDebug(OSRF_LOG_MARK, "Received query request");
4284
4285         int err = 0;
4286
4287         // XXX for now...
4288         dbhandle = writehandle;
4289
4290         jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
4291
4292         int flags = 0;
4293
4294         if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
4295                 flags |= SELECT_DISTINCT;
4296
4297         if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
4298                 flags |= DISABLE_I18N;
4299
4300         osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
4301         char* sql = SELECT(
4302                         ctx,
4303                         jsonObjectGetKey( hash, "select" ),
4304                         jsonObjectGetKey( hash, "from" ),
4305                         jsonObjectGetKey( hash, "where" ),
4306                         jsonObjectGetKey( hash, "having" ),
4307                         jsonObjectGetKey( hash, "order_by" ),
4308                         jsonObjectGetKey( hash, "limit" ),
4309                         jsonObjectGetKey( hash, "offset" ),
4310                         flags
4311         );
4312         clear_query_stack();
4313
4314         if (!sql) {
4315                 err = -1;
4316                 return err;
4317         }
4318
4319         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4320         dbi_result result = dbi_conn_query(dbhandle, sql);
4321
4322         if(result) {
4323                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4324
4325                 if (dbi_result_first_row(result)) {
4326                         /* JSONify the result */
4327                         osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4328
4329                         do {
4330                                 jsonObject* return_val = oilsMakeJSONFromResult( result );
4331                                 osrfAppRespond( ctx, return_val );
4332                 jsonObjectFree( return_val );
4333                         } while (dbi_result_next_row(result));
4334
4335                 } else {
4336                         osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
4337                 }
4338
4339                 osrfAppRespondComplete( ctx, NULL );
4340
4341                 /* clean up the query */
4342                 dbi_result_free(result);
4343
4344         } else {
4345                 err = -1;
4346                 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
4347                 osrfAppSessionStatus(
4348                         ctx->session,
4349                         OSRF_STATUS_INTERNALSERVERERROR,
4350                         "osrfMethodException",
4351                         ctx->request,
4352                         "Severe query error -- see error log for more details"
4353                 );
4354         }
4355
4356         free(sql);
4357         return err;
4358 }
4359
4360 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
4361                 jsonObject* where_hash, jsonObject* query_hash, int* err ) {
4362
4363         // XXX for now...
4364         dbhandle = writehandle;
4365
4366         osrfHash* links = osrfHashGet(meta, "links");
4367         osrfHash* fields = osrfHashGet(meta, "fields");
4368         char* core_class = osrfHashGet(meta, "classname");
4369         char* pkey = osrfHashGet(meta, "primarykey");
4370
4371         const jsonObject* _tmp;
4372         jsonObject* obj;
4373
4374         char* sql = buildSELECT( where_hash, query_hash, meta, ctx );
4375         if (!sql) {
4376                 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
4377                 *err = -1;
4378                 return NULL;
4379         }
4380
4381         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4382
4383         dbi_result result = dbi_conn_query(dbhandle, sql);
4384         if( NULL == result ) {
4385                 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
4386                         MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
4387                 osrfAppSessionStatus(
4388                         ctx->session,
4389                         OSRF_STATUS_INTERNALSERVERERROR,
4390                         "osrfMethodException",
4391                         ctx->request,
4392                         "Severe query error -- see error log for more details"
4393                 );
4394                 *err = -1;
4395                 free(sql);
4396                 return jsonNULL;
4397
4398         } else {
4399                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4400         }
4401
4402         jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
4403         osrfHash* dedup = osrfNewHash();
4404
4405         if (dbi_result_first_row(result)) {
4406                 /* JSONify the result */
4407                 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4408                 do {
4409                         obj = oilsMakeFieldmapperFromResult( result, meta );
4410                         char* pkey_val = oilsFMGetString( obj, pkey );
4411                         if ( osrfHashGet( dedup, pkey_val ) ) {
4412                                 jsonObjectFree(obj);
4413                                 free(pkey_val);
4414                         } else {
4415                                 osrfHashSet( dedup, pkey_val, pkey_val );
4416                                 jsonObjectPush(res_list, obj);
4417                         }
4418                 } while (dbi_result_next_row(result));
4419         } else {
4420                 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
4421                         MODULENAME, sql );
4422         }
4423
4424         osrfHashFree(dedup);
4425         /* clean up the query */
4426         dbi_result_free(result);
4427         free(sql);
4428
4429         if (res_list->size && query_hash) {
4430                 _tmp = jsonObjectGetKeyConst( query_hash, "flesh" );
4431                 if (_tmp) {
4432                         int x = (int)jsonObjectGetNumber(_tmp);
4433                         if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4434
4435                         const jsonObject* temp_blob;
4436                         if ((temp_blob = jsonObjectGetKeyConst( query_hash, "flesh_fields" )) && x > 0) {
4437
4438                                 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4439                                 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4440
4441                                 osrfStringArray* link_fields = NULL;
4442
4443                                 if (flesh_fields) {
4444                                         if (flesh_fields->size == 1) {
4445                                                 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4446                                                 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4447                                         }
4448
4449                                         if (!link_fields) {
4450                                                 jsonObject* _f;
4451                                                 link_fields = osrfNewStringArray(1);
4452                                                 jsonIterator* _i = jsonNewIterator( flesh_fields );
4453                                                 while ((_f = jsonIteratorNext( _i ))) {
4454                                                         osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4455                                                 }
4456                         jsonIteratorFree(_i);
4457                                         }
4458                                 }
4459
4460                                 jsonObject* cur;
4461                                 unsigned long res_idx = 0;
4462                                 while ((cur = jsonObjectGetIndex( res_list, res_idx++ ) )) {
4463
4464                                         int i = 0;
4465                                         char* link_field;
4466
4467                                         while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4468
4469                                                 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4470
4471                                                 osrfHash* kid_link = osrfHashGet(links, link_field);
4472                                                 if (!kid_link) continue;
4473
4474                                                 osrfHash* field = osrfHashGet(fields, link_field);
4475                                                 if (!field) continue;
4476
4477                                                 osrfHash* value_field = field;
4478
4479                                                 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4480                                                 if (!kid_idl) continue;
4481
4482                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4483                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4484                                                 }
4485
4486                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4487                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4488                                                 }
4489
4490                                                 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4491
4492                                                 if (link_map->size > 0) {
4493                                                         jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4494                                                         jsonObjectPush(
4495                                                                 _kid_key,
4496                                                                 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4497                                                         );
4498
4499                                                         jsonObjectSetKey(
4500                                                                 flesh_blob,
4501                                                                 osrfHashGet(kid_link, "class"),
4502                                                                 _kid_key
4503                                                         );
4504                                                 };
4505
4506                                                 osrfLogDebug(
4507                                                         OSRF_LOG_MARK,
4508                                                         "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4509                                                         osrfHashGet(kid_link, "field"),
4510                                                         osrfHashGet(kid_link, "class"),
4511                                                         osrfHashGet(kid_link, "key"),
4512                                                         osrfHashGet(kid_link, "reltype")
4513                                                 );
4514
4515                                                 const char* search_key = jsonObjectGetString(
4516                                                         jsonObjectGetIndex(
4517                                                                 cur,
4518                                                                 atoi( osrfHashGet(value_field, "array_position") )
4519                                                         )
4520                                                 );
4521
4522                                                 if (!search_key) {
4523                                                         osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4524                                                         continue;
4525                                                 }
4526
4527                                                 osrfLogDebug(OSRF_LOG_MARK, "Creating param objects...");
4528
4529                                                 // construct WHERE clause
4530                                                 jsonObject* where_clause  = jsonNewObjectType(JSON_HASH);
4531                                                 jsonObjectSetKey(
4532                                                         where_clause,
4533                                                         osrfHashGet(kid_link, "key"),
4534                                                         jsonNewObject( search_key )
4535                                                 );
4536
4537                                                 // construct the rest of the query
4538                                                 jsonObject* rest_of_query = jsonNewObjectType(JSON_HASH);
4539                                                 jsonObjectSetKey( rest_of_query, "flesh",
4540                                                         jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4541                                                 );
4542
4543                                                 if (flesh_blob)
4544                                                         jsonObjectSetKey( rest_of_query, "flesh_fields", jsonObjectClone(flesh_blob) );
4545
4546                                                 if (jsonObjectGetKeyConst(query_hash, "order_by")) {
4547                                                         jsonObjectSetKey( rest_of_query, "order_by",
4548                                                                 jsonObjectClone(jsonObjectGetKeyConst(query_hash, "order_by"))
4549                                                         );
4550                                                 }
4551
4552                                                 if (jsonObjectGetKeyConst(query_hash, "select")) {
4553                                                         jsonObjectSetKey( rest_of_query, "select",
4554                                                                 jsonObjectClone(jsonObjectGetKeyConst(query_hash, "select"))
4555                                                         );
4556                                                 }
4557
4558                                                 jsonObject* kids = doFieldmapperSearch( ctx, kid_idl,
4559                                                         where_clause, rest_of_query, err);
4560
4561                                                 jsonObjectFree( where_clause );
4562                                                 jsonObjectFree( rest_of_query );
4563
4564                                                 if(*err) {
4565                                                         osrfStringArrayFree(link_fields);
4566                                                         jsonObjectFree(res_list);
4567                                                         jsonObjectFree(flesh_blob);
4568                                                         return jsonNULL;
4569                                                 }
4570
4571                                                 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4572
4573                                                 jsonObject* X = NULL;
4574                                                 if ( link_map->size > 0 && kids->size > 0 ) {
4575                                                         X = kids;
4576                                                         kids = jsonNewObjectType(JSON_ARRAY);
4577
4578                                                         jsonObject* _k_node;
4579                                                         unsigned long res_idx = 0;
4580                                                         while ((_k_node = jsonObjectGetIndex( X, res_idx++ ) )) {
4581                                                                 jsonObjectPush(
4582                                                                         kids,
4583                                                                         jsonObjectClone(
4584                                                                                 jsonObjectGetIndex(
4585                                                                                         _k_node,
4586                                                                                         (unsigned long)atoi(
4587                                                                                                 osrfHashGet(
4588                                                                                                         osrfHashGet(
4589                                                                                                                 osrfHashGet(
4590                                                                                                                         osrfHashGet(
4591                                                                                                                                 oilsIDL(),
4592                                                                                                                                 osrfHashGet(kid_link, "class")
4593                                                                                                                         ),
4594                                                                                                                         "fields"
4595                                                                                                                 ),
4596                                                                                                                 osrfStringArrayGetString( link_map, 0 )
4597                                                                                                         ),
4598                                                                                                         "array_position"
4599                                                                                                 )
4600                                                                                         )
4601                                                                                 )
4602                                                                         )
4603                                                                 );
4604                                                         } // end while loop traversing X
4605                                                 }
4606
4607                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4608                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4609                                                         jsonObjectSetIndex(
4610                                                                 cur,
4611                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4612                                                                 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4613                                                         );
4614                                                 }
4615
4616                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4617                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4618                                                         jsonObjectSetIndex(
4619                                                                 cur,
4620                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4621                                                                 jsonObjectClone( kids )
4622                                                         );
4623                                                 }
4624
4625                                                 if (X) {
4626                                                         jsonObjectFree(kids);
4627                                                         kids = X;
4628                                                 }
4629
4630                                                 jsonObjectFree( kids );
4631
4632                                                 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4633                                                 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4634
4635                                         }
4636                                 } // end while loop traversing res_list
4637                                 jsonObjectFree( flesh_blob );
4638                                 osrfStringArrayFree(link_fields);
4639                         }
4640                 }
4641         }
4642
4643         return res_list;
4644 }
4645
4646
4647 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4648
4649         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4650 #ifdef PCRUD
4651         jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4652 #else
4653         jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4654 #endif
4655
4656         if (!verifyObjectClass(ctx, target)) {
4657                 *err = -1;
4658                 return jsonNULL;
4659         }
4660
4661         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4662                 osrfAppSessionStatus(
4663                         ctx->session,
4664                         OSRF_STATUS_BADREQUEST,
4665                         "osrfMethodException",
4666                         ctx->request,
4667                         "No active transaction -- required for UPDATE"
4668                 );
4669                 *err = -1;
4670                 return jsonNULL;
4671         }
4672
4673         // The following test is harmless but redundant.  If a class is
4674         // readonly, we don't register an update method for it.
4675         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4676                 osrfAppSessionStatus(
4677                         ctx->session,
4678                         OSRF_STATUS_BADREQUEST,
4679                         "osrfMethodException",
4680                         ctx->request,
4681                         "Cannot UPDATE readonly class"
4682                 );
4683                 *err = -1;
4684                 return jsonNULL;
4685         }
4686
4687         dbhandle = writehandle;
4688
4689         char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4690
4691         // Set the last_xact_id
4692         int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4693         if (index > -1) {
4694                 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d",
4695                                 trans_id, target->classname, index);
4696                 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4697         }
4698
4699         char* pkey = osrfHashGet(meta, "primarykey");
4700         osrfHash* fields = osrfHashGet(meta, "fields");
4701
4702         char* id = oilsFMGetString( target, pkey );
4703
4704         osrfLogDebug(
4705                 OSRF_LOG_MARK,
4706                 "%s updating %s object with %s = %s",
4707                 MODULENAME,
4708                 osrfHashGet(meta, "fieldmapper"),
4709                 pkey,
4710                 id
4711         );
4712
4713         growing_buffer* sql = buffer_init(128);
4714         buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4715
4716         int first = 1;
4717         osrfHash* field_def = NULL;
4718         osrfHashIterator* field_itr = osrfNewHashIterator( fields );
4719         while( (field_def = osrfHashIteratorNext( field_itr ) ) ) {
4720
4721                 // Skip virtual fields, and the primary key
4722                 if( str_is_true( osrfHashGet( field_def, "virtual") ) )
4723                         continue;
4724
4725                 const char* field_name = osrfHashIteratorKey( field_itr );
4726                 if( ! strcmp( field_name, pkey ) )
4727                         continue;
4728
4729                 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4730
4731                 int value_is_numeric = 0;    // boolean
4732                 char* value;
4733                 if (field_object && field_object->classname) {
4734                         value = oilsFMGetString(
4735                                 field_object,
4736                                 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4737             );
4738                 } else {
4739                         value = jsonObjectToSimpleString( field_object );
4740                         if( field_object && JSON_NUMBER == field_object->type )
4741                                 value_is_numeric = 1;
4742                 }
4743
4744                 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s",
4745                                 osrfHashGet(meta, "fieldmapper"), field_name, value);
4746
4747                 if (!field_object || field_object->type == JSON_NULL) {
4748                         if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) )
4749                                         && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4750                                 if (first) first = 0;
4751                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4752                                 buffer_fadd( sql, " %s = NULL", field_name );
4753                         }
4754
4755                 } else if ( value_is_numeric || !strcmp( get_primitive( field_def ), "number") ) {
4756                         if (first) first = 0;
4757                         else OSRF_BUFFER_ADD_CHAR(sql, ',');
4758
4759                         const char* numtype = get_datatype( field_def );
4760                         if ( !strncmp( numtype, "INT", 3 ) ) {
4761                                 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4762                         } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4763                                 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4764                         } else {
4765                                 // Must really be intended as a string, so quote it
4766                                 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4767                                         buffer_fadd( sql, " %s = %s", field_name, value );
4768                                 } else {
4769                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4770                                         osrfAppSessionStatus(
4771                                                 ctx->session,
4772                                                 OSRF_STATUS_INTERNALSERVERERROR,
4773                                                 "osrfMethodException",
4774                                                 ctx->request,
4775                                                 "Error quoting string -- please see the error log for more details"
4776                                         );
4777                                         free(value);
4778                                         free(id);
4779                                         osrfHashIteratorFree( field_itr );
4780                                         buffer_free(sql);
4781                                         *err = -1;
4782                                         return jsonNULL;
4783                                 }
4784                         }
4785
4786                         osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4787
4788                 } else {
4789                         if ( dbi_conn_quote_string(dbhandle, &value) ) {
4790                                 if (first) first = 0;
4791                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4792                                 buffer_fadd( sql, " %s = %s", field_name, value );
4793
4794                         } else {
4795                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4796                                 osrfAppSessionStatus(
4797                                         ctx->session,
4798                                         OSRF_STATUS_INTERNALSERVERERROR,
4799                                         "osrfMethodException",
4800                                         ctx->request,
4801                                         "Error quoting string -- please see the error log for more details"
4802                                 );
4803                                 free(value);
4804                                 free(id);
4805                                 osrfHashIteratorFree( field_itr );
4806                                 buffer_free(sql);
4807                                 *err = -1;
4808                                 return jsonNULL;
4809                         }
4810                 }
4811
4812                 free(value);
4813
4814         } // end while
4815
4816         osrfHashIteratorFree( field_itr );
4817
4818         jsonObject* obj = jsonNewObject(id);
4819
4820         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4821                 dbi_conn_quote_string(dbhandle, &id);
4822
4823         buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4824
4825         char* query = buffer_release(sql);
4826         osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4827
4828         dbi_result result = dbi_conn_query(dbhandle, query);
4829         free(query);
4830
4831         if (!result) {
4832                 jsonObjectFree(obj);
4833                 obj = jsonNewObject(NULL);
4834                 osrfLogError(
4835                         OSRF_LOG_MARK,
4836                         "%s ERROR updating %s object with %s = %s",
4837                         MODULENAME,
4838                         osrfHashGet(meta, "fieldmapper"),
4839                         pkey,
4840                         id
4841                 );
4842         }
4843
4844         free(id);
4845
4846         return obj;
4847 }
4848
4849 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4850
4851         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4852
4853         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4854                 osrfAppSessionStatus(
4855                         ctx->session,
4856                         OSRF_STATUS_BADREQUEST,
4857                         "osrfMethodException",
4858                         ctx->request,
4859                         "No active transaction -- required for DELETE"
4860                 );
4861                 *err = -1;
4862                 return jsonNULL;
4863         }
4864
4865         // The following test is harmless but redundant.  If a class is
4866         // readonly, we don't register a delete method for it.
4867         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4868                 osrfAppSessionStatus(
4869                         ctx->session,
4870                         OSRF_STATUS_BADREQUEST,
4871                         "osrfMethodException",
4872                         ctx->request,
4873                         "Cannot DELETE readonly class"
4874                 );
4875                 *err = -1;
4876                 return jsonNULL;
4877         }
4878
4879         dbhandle = writehandle;
4880
4881         jsonObject* obj;
4882
4883         char* pkey = osrfHashGet(meta, "primarykey");
4884
4885         int _obj_pos = 0;
4886 #ifdef PCRUD
4887                 _obj_pos = 1;
4888 #endif
4889
4890         char* id;
4891         if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4892                 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4893                         *err = -1;
4894                         return jsonNULL;
4895                 }
4896
4897                 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4898         } else {
4899 #ifdef PCRUD
4900         if (!verifyObjectPCRUD( ctx, NULL )) {
4901                         *err = -1;
4902                         return jsonNULL;
4903         }
4904 #endif
4905                 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4906         }
4907
4908         osrfLogDebug(
4909                 OSRF_LOG_MARK,
4910                 "%s deleting %s object with %s = %s",
4911                 MODULENAME,
4912                 osrfHashGet(meta, "fieldmapper"),
4913                 pkey,
4914                 id
4915         );
4916
4917         obj = jsonNewObject(id);
4918
4919         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4920                 dbi_conn_quote_string(writehandle, &id);
4921
4922         dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4923
4924         if (!result) {
4925                 jsonObjectFree(obj);
4926                 obj = jsonNewObject(NULL);
4927                 osrfLogError(
4928                         OSRF_LOG_MARK,
4929                         "%s ERROR deleting %s object with %s = %s",
4930                         MODULENAME,
4931                         osrfHashGet(meta, "fieldmapper"),
4932                         pkey,
4933                         id
4934                 );
4935         }
4936
4937         free(id);
4938
4939         return obj;
4940
4941 }
4942
4943
4944 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4945         if(!(result && meta)) return jsonNULL;
4946
4947         jsonObject* object = jsonNewObject(NULL);
4948         jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4949
4950         osrfHash* fields = osrfHashGet(meta, "fields");
4951
4952         osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4953
4954         osrfHash* _f;
4955         time_t _tmp_dt;
4956         char dt_string[256];
4957         struct tm gmdt;
4958
4959         int fmIndex;
4960         int columnIndex = 1;
4961         int attr;
4962         unsigned short type;
4963         const char* columnName;
4964
4965         /* cycle through the column list */
4966         while( (columnName = dbi_result_get_field_name(result, columnIndex)) ) {
4967
4968                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4969
4970                 fmIndex = -1; // reset the position
4971
4972                 /* determine the field type and storage attributes */
4973                 type = dbi_result_get_field_type_idx(result, columnIndex);
4974                 attr = dbi_result_get_field_attribs_idx(result, columnIndex);
4975
4976                 /* fetch the fieldmapper index */
4977                 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4978
4979                         if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4980                                 continue;
4981
4982                         const char* pos = (char*)osrfHashGet(_f, "array_position");
4983                         if ( !pos ) continue;
4984
4985                         fmIndex = atoi( pos );
4986                         osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4987                 } else {
4988                         continue;
4989                 }
4990
4991                 if (dbi_result_field_is_null_idx(result, columnIndex)) {
4992                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4993                 } else {
4994
4995                         switch( type ) {
4996
4997                                 case DBI_TYPE_INTEGER :
4998
4999                                         if( attr & DBI_INTEGER_SIZE8 )
5000                                                 jsonObjectSetIndex( object, fmIndex,
5001                                                         jsonNewNumberObject(dbi_result_get_longlong_idx(result, columnIndex)));
5002                                         else
5003                                                 jsonObjectSetIndex( object, fmIndex,
5004                                                         jsonNewNumberObject(dbi_result_get_int_idx(result, columnIndex)));
5005
5006                                         break;
5007
5008                                 case DBI_TYPE_DECIMAL :
5009                                         jsonObjectSetIndex( object, fmIndex,
5010                                                         jsonNewNumberObject(dbi_result_get_double_idx(result, columnIndex)));
5011                                         break;
5012
5013                                 case DBI_TYPE_STRING :
5014
5015
5016                                         jsonObjectSetIndex(
5017                                                 object,
5018                                                 fmIndex,
5019                                                 jsonNewObject( dbi_result_get_string_idx(result, columnIndex) )
5020                                         );
5021
5022                                         break;
5023
5024                                 case DBI_TYPE_DATETIME :
5025
5026                                         memset(dt_string, '\0', sizeof(dt_string));
5027                                         memset(&gmdt, '\0', sizeof(gmdt));
5028
5029                                         _tmp_dt = dbi_result_get_datetime_idx(result, columnIndex);
5030
5031
5032                                         if (!(attr & DBI_DATETIME_DATE)) {
5033                                                 gmtime_r( &_tmp_dt, &gmdt );
5034                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
5035                                         } else if (!(attr & DBI_DATETIME_TIME)) {
5036                                                 localtime_r( &_tmp_dt, &gmdt );
5037                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
5038                                         } else {
5039                                                 localtime_r( &_tmp_dt, &gmdt );
5040                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
5041                                         }
5042
5043                                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
5044
5045                                         break;
5046
5047                                 case DBI_TYPE_BINARY :
5048                                         osrfLogError( OSRF_LOG_MARK,
5049                                                 "Can't do binary at column %s : index %d", columnName, columnIndex);
5050                         }
5051                 }
5052                 ++columnIndex;
5053         }
5054
5055         return object;
5056 }
5057
5058 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
5059         if(!result) return jsonNULL;
5060
5061         jsonObject* object = jsonNewObject(NULL);
5062
5063         time_t _tmp_dt;
5064         char dt_string[256];
5065         struct tm gmdt;
5066
5067         int fmIndex;
5068         int columnIndex = 1;
5069         int attr;
5070         unsigned short type;
5071         const char* columnName;
5072
5073         /* cycle through the column list */
5074         while( (columnName = dbi_result_get_field_name(result, columnIndex)) ) {
5075
5076                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
5077
5078                 fmIndex = -1; // reset the position
5079
5080                 /* determine the field type and storage attributes */
5081                 type = dbi_result_get_field_type_idx(result, columnIndex);
5082                 attr = dbi_result_get_field_attribs_idx(result, columnIndex);
5083
5084                 if (dbi_result_field_is_null_idx(result, columnIndex)) {
5085                         jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
5086                 } else {
5087
5088                         switch( type ) {
5089
5090                                 case DBI_TYPE_INTEGER :
5091
5092                                         if( attr & DBI_INTEGER_SIZE8 )
5093                                                 jsonObjectSetKey( object, columnName,
5094                                                                 jsonNewNumberObject(dbi_result_get_longlong_idx(result, columnIndex)) );
5095                                         else
5096                                                 jsonObjectSetKey( object, columnName,
5097                                                                 jsonNewNumberObject(dbi_result_get_int_idx(result, columnIndex)) );
5098                                         break;
5099
5100                                 case DBI_TYPE_DECIMAL :
5101                                         jsonObjectSetKey( object, columnName,
5102                                                         jsonNewNumberObject(dbi_result_get_double_idx(result, columnIndex)) );
5103                                         break;
5104
5105                                 case DBI_TYPE_STRING :
5106                                         jsonObjectSetKey( object, columnName,
5107                                                         jsonNewObject(dbi_result_get_string_idx(result, columnIndex)) );
5108                                         break;
5109
5110                                 case DBI_TYPE_DATETIME :
5111
5112                                         memset(dt_string, '\0', sizeof(dt_string));
5113                                         memset(&gmdt, '\0', sizeof(gmdt));
5114
5115                                         _tmp_dt = dbi_result_get_datetime_idx(result, columnIndex);
5116
5117
5118                                         if (!(attr & DBI_DATETIME_DATE)) {
5119                                                 gmtime_r( &_tmp_dt, &gmdt );
5120                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
5121                                         } else if (!(attr & DBI_DATETIME_TIME)) {
5122                                                 localtime_r( &_tmp_dt, &gmdt );
5123                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
5124                                         } else {
5125                                                 localtime_r( &_tmp_dt, &gmdt );
5126                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
5127                                         }
5128
5129                                         jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
5130                                         break;
5131
5132                                 case DBI_TYPE_BINARY :
5133                                         osrfLogError( OSRF_LOG_MARK,
5134                                                 "Can't do binary at column %s : index %d", columnName, columnIndex );
5135                         }
5136                 }
5137                 ++columnIndex;
5138         } // end while loop traversing result
5139
5140         return object;
5141 }
5142
5143 // Interpret a string as true or false
5144 static int str_is_true( const char* str ) {
5145         if( NULL == str || strcasecmp( str, "true" ) )
5146                 return 0;
5147         else
5148                 return 1;
5149 }
5150
5151 // Interpret a jsonObject as true or false
5152 static int obj_is_true( const jsonObject* obj ) {
5153         if( !obj )
5154                 return 0;
5155         else switch( obj->type )
5156         {
5157                 case JSON_BOOL :
5158                         if( obj->value.b )
5159                                 return 1;
5160                         else
5161                                 return 0;
5162                 case JSON_STRING :
5163                         if( strcasecmp( obj->value.s, "true" ) )
5164                                 return 0;
5165                         else
5166                                 return 1;
5167                 case JSON_NUMBER :          // Support 1/0 for perl's sake
5168                         if( jsonObjectGetNumber( obj ) == 1.0 )
5169                                 return 1;
5170                         else
5171                                 return 0;
5172                 default :
5173                         return 0;
5174         }
5175 }
5176
5177 // Translate a numeric code into a text string identifying a type of
5178 // jsonObject.  To be used for building error messages.
5179 static const char* json_type( int code ) {
5180         switch ( code )
5181         {
5182                 case 0 :
5183                         return "JSON_HASH";
5184                 case 1 :
5185                         return "JSON_ARRAY";
5186                 case 2 :
5187                         return "JSON_STRING";
5188                 case 3 :
5189                         return "JSON_NUMBER";
5190                 case 4 :
5191                         return "JSON_NULL";
5192                 case 5 :
5193                         return "JSON_BOOL";
5194                 default :
5195                         return "(unrecognized)";
5196         }
5197 }
5198
5199 // Extract the "primitive" attribute from an IDL field definition.
5200 // If we haven't initialized the app, then we must be running in
5201 // some kind of testbed.  In that case, default to "string".
5202 static const char* get_primitive( osrfHash* field ) {
5203         const char* s = osrfHashGet( field, "primitive" );
5204         if( !s ) {
5205                 if( child_initialized )
5206                         osrfLogError(
5207                                 OSRF_LOG_MARK,
5208                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5209                                 MODULENAME,
5210                                 osrfHashGet( field, "name" )
5211                         );
5212                 else
5213                         s = "string";
5214         }
5215         return s;
5216 }
5217
5218 // Extract the "datatype" attribute from an IDL field definition.
5219 // If we haven't initialized the app, then we must be running in
5220 // some kind of testbed.  In that case, default to to NUMERIC,
5221 // since we look at the datatype only for numbers.
5222 static const char* get_datatype( osrfHash* field ) {
5223         const char* s = osrfHashGet( field, "datatype" );
5224         if( !s ) {
5225                 if( child_initialized )
5226                         osrfLogError(
5227                                 OSRF_LOG_MARK,
5228                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5229                                 MODULENAME,
5230                                 osrfHashGet( field, "name" )
5231                         );
5232                 else
5233                         s = "NUMERIC";
5234         }
5235         return s;
5236 }
5237
5238 /*
5239 If the input string is potentially a valid SQL identifier, return 1.
5240 Otherwise return 0.
5241
5242 Purpose: to prevent certain kinds of SQL injection.  To that end we
5243 don't necessarily need to follow all the rules exactly, such as requiring
5244 that the first character not be a digit.
5245
5246 We allow leading and trailing white space.  In between, we do not allow
5247 punctuation (except for underscores and dollar signs), control
5248 characters, or embedded white space.
5249
5250 More pedantically we should allow quoted identifiers containing arbitrary
5251 characters, but for the foreseeable future such quoted identifiers are not
5252 likely to be an issue.
5253 */
5254 static int is_identifier( const char* s) {
5255         if( !s )
5256                 return 0;
5257
5258         // Skip leading white space
5259         while( isspace( (unsigned char) *s ) )
5260                 ++s;
5261
5262         if( !s )
5263                 return 0;   // Nothing but white space?  Not okay.
5264
5265         // Check each character until we reach white space or
5266         // end-of-string.  Letters, digits, underscores, and
5267         // dollar signs are okay. With the exception of periods
5268         // (as in schema.identifier), control characters and other
5269         // punctuation characters are not okay.  Anything else
5270         // is okay -- it could for example be part of a multibyte
5271         // UTF8 character such as a letter with diacritical marks,
5272         // and those are allowed.
5273         do {
5274                 if( isalnum( (unsigned char) *s )
5275                         || '.' == *s
5276                         || '_' == *s
5277                         || '$' == *s )
5278                         ;  // Fine; keep going
5279                 else if(   ispunct( (unsigned char) *s )
5280                                 || iscntrl( (unsigned char) *s ) )
5281                         return 0;
5282                         ++s;
5283         } while( *s && ! isspace( (unsigned char) *s ) );
5284
5285         // If we found any white space in the above loop,
5286         // the rest had better be all white space.
5287
5288         while( isspace( (unsigned char) *s ) )
5289                 ++s;
5290
5291         if( *s )
5292                 return 0;   // White space was embedded within non-white space
5293
5294         return 1;
5295 }
5296
5297 /*
5298 Determine whether to accept a character string as a comparison operator.
5299 Return 1 if it's good, or 0 if it's bad.
5300
5301 We don't validate it for real.  We just make sure that it doesn't contain
5302 any semicolons or white space (with special exceptions for a few specific
5303 operators).   The idea is to block certain kinds of SQL injection.  If it
5304 has no semicolons or white space but it's still not a valid operator, then
5305 the database will complain.
5306
5307 Another approach would be to compare the string against a short list of
5308 approved operators.  We don't do that because we want to allow custom
5309 operators like ">100*", which would be difficult or impossible to
5310 express otherwise in a JSON query.
5311 */
5312 static int is_good_operator( const char* op ) {
5313         if( !op ) return 0;   // Sanity check
5314
5315         const char* s = op;
5316         while( *s ) {
5317                 if( isspace( (unsigned char) *s ) ) {
5318                         // Special exceptions for SIMILAR TO, IS DISTINCT FROM,
5319                         // and IS NOT DISTINCT FROM.
5320                         if( !strcasecmp( op, "similar to" ) )
5321                                 return 1;
5322                         else if( !strcasecmp( op, "is distinct from" ) )
5323                                 return 1;
5324                         else if( !strcasecmp( op, "is not distinct from" ) )
5325                                 return 1;
5326                         else
5327                                 return 0;
5328                 }
5329                 else if( ';' == *s )
5330                         return 0;
5331                 ++s;
5332         }
5333         return 1;
5334 }
5335
5336 /* ----------------------------------------------------------------------------------
5337 The following machinery supports a stack of query frames for use by SELECT().
5338
5339 A query frame caches information about one level of a SELECT query.  When we enter
5340 a subquery, we push another query frame onto the stack, and pop it off when we leave.
5341
5342 The query frame stores information about the core class, and about any joined classes
5343 in the FROM clause.
5344
5345 The main purpose is to map table aliases to classes and tables, so that a query can
5346 join to the same table more than once.  A secondary goal is to reduce the number of
5347 lookups in the IDL by caching the results.
5348  ----------------------------------------------------------------------------------*/
5349
5350 #define STATIC_CLASS_INFO_COUNT 3
5351
5352 static ClassInfo static_class_info[ STATIC_CLASS_INFO_COUNT ];
5353
5354 /* ---------------------------------------------------------------------------
5355  Allocate a ClassInfo as raw memory.  Except for the in_use flag, we don't
5356  initialize it here.
5357  ---------------------------------------------------------------------------*/
5358 static ClassInfo* allocate_class_info( void ) {
5359         // In order to reduce the number of mallocs and frees, we return a static
5360         // instance of ClassInfo, if we can find one that we're not already using.
5361         // We rely on the fact that the compiler will implicitly initialize the
5362         // static instances so that in_use == 0.
5363
5364         int i;
5365         for( i = 0; i < STATIC_CLASS_INFO_COUNT; ++i ) {
5366                 if( ! static_class_info[ i ].in_use ) {
5367                         static_class_info[ i ].in_use = 1;
5368                         return static_class_info + i;
5369                 }
5370         }
5371
5372         // The static ones are all in use.  Malloc one.
5373
5374         return safe_malloc( sizeof( ClassInfo ) );
5375 }
5376
5377 /* --------------------------------------------------------------------------
5378  Free any malloc'd memory owned by a ClassInfo; return it to a pristine state
5379 ---------------------------------------------------------------------------*/
5380 static void clear_class_info( ClassInfo* info ) {
5381         // Sanity check
5382         if( ! info )
5383                 return;
5384
5385         // Free any malloc'd strings
5386
5387         if( info->alias != info->alias_store )
5388                 free( info->alias );
5389
5390         if( info->class_name != info->class_name_store )
5391                 free( info->class_name );
5392
5393         free( info->source_def );
5394
5395         info->alias = info->class_name = info->source_def = NULL;
5396         info->next = NULL;
5397 }
5398
5399 /* --------------------------------------------------------------------------
5400  Deallocate a ClassInfo and everything it owns
5401 ---------------------------------------------------------------------------*/
5402 static void free_class_info( ClassInfo* info ) {
5403         // Sanity check
5404         if( ! info )
5405                 return;
5406
5407         clear_class_info( info );
5408
5409         // If it's one of the static instances, just mark it as not in use
5410
5411         int i;
5412         for( i = 0; i < STATIC_CLASS_INFO_COUNT; ++i ) {
5413                 if( info == static_class_info + i ) {
5414                         static_class_info[ i ].in_use = 0;
5415                         return;
5416                 }
5417         }
5418
5419         // Otherwise it must have been malloc'd, so free it
5420
5421         free( info );
5422 }
5423
5424 /* --------------------------------------------------------------------------
5425  Populate an already-allocated ClassInfo.  Return 0 if successful, 1 if not.
5426 ---------------------------------------------------------------------------*/
5427 static int build_class_info( ClassInfo* info, const char* alias, const char* class ) {
5428         // Sanity checks
5429         if( ! info ){
5430                 osrfLogError( OSRF_LOG_MARK,
5431                                           "%s ERROR: No ClassInfo available to populate", MODULENAME );
5432                 info->alias = info->class_name = info->source_def = NULL;
5433                 info->class_def = info->fields = info->links = NULL;
5434                 return 1;
5435         }
5436
5437         if( ! class ) {
5438                 osrfLogError( OSRF_LOG_MARK,
5439                                           "%s ERROR: No class name provided for lookup", MODULENAME );
5440                 info->alias = info->class_name = info->source_def = NULL;
5441                 info->class_def = info->fields = info->links = NULL;
5442                 return 1;
5443         }
5444
5445         // Alias defaults to class name if not supplied
5446         if( ! alias || ! alias[ 0 ] )
5447                 alias = class;
5448
5449         // Look up class info in the IDL
5450         osrfHash* class_def = osrfHashGet( oilsIDL(), class );
5451         if( ! class_def ) {
5452                 osrfLogError( OSRF_LOG_MARK,
5453                                           "%s ERROR: Class %s not defined in IDL", MODULENAME, class );
5454                 info->alias = info->class_name = info->source_def = NULL;
5455                 info->class_def = info->fields = info->links = NULL;
5456                 return 1;
5457         } else if( str_is_true( osrfHashGet( class_def, "virtual" ) ) ) {
5458                 osrfLogError( OSRF_LOG_MARK,
5459                                           "%s ERROR: Class %s is defined as virtual", MODULENAME, class );
5460                 info->alias = info->class_name = info->source_def = NULL;
5461                 info->class_def = info->fields = info->links = NULL;
5462                 return 1;
5463         }
5464
5465         osrfHash* links = osrfHashGet( class_def, "links" );
5466         if( ! links ) {
5467                 osrfLogError( OSRF_LOG_MARK,
5468                                           "%s ERROR: No links defined in IDL for class %s", MODULENAME, class );
5469                 info->alias = info->class_name = info->source_def = NULL;
5470                 info->class_def = info->fields = info->links = NULL;
5471                 return 1;
5472         }
5473
5474         osrfHash* fields = osrfHashGet( class_def, "fields" );
5475         if( ! fields ) {
5476                 osrfLogError( OSRF_LOG_MARK,
5477                                           "%s ERROR: No fields defined in IDL for class %s", MODULENAME, class );
5478                 info->alias = info->class_name = info->source_def = NULL;
5479                 info->class_def = info->fields = info->links = NULL;
5480                 return 1;
5481         }
5482
5483         char* source_def = getSourceDefinition( class_def );
5484         if( ! source_def )
5485                 return 1;
5486
5487         // We got everything we need, so populate the ClassInfo
5488         if( strlen( alias ) > ALIAS_STORE_SIZE )
5489                 info->alias = strdup( alias );
5490         else {
5491                 strcpy( info->alias_store, alias );
5492                 info->alias = info->alias_store;
5493         }
5494
5495         if( strlen( class ) > CLASS_NAME_STORE_SIZE )
5496                 info->class_name = strdup( class );
5497         else {
5498                 strcpy( info->class_name_store, class );
5499                 info->class_name = info->class_name_store;
5500         }
5501
5502         info->source_def = source_def;
5503
5504         info->class_def = class_def;
5505         info->links     = links;
5506         info->fields    = fields;
5507
5508         return 0;
5509 }
5510
5511 #define STATIC_FRAME_COUNT 3
5512
5513 static QueryFrame static_frame[ STATIC_FRAME_COUNT ];
5514
5515 /* ---------------------------------------------------------------------------
5516  Allocate a ClassInfo as raw memory.  Except for the in_use flag, we don't
5517  initialize it here.
5518  ---------------------------------------------------------------------------*/
5519 static QueryFrame* allocate_frame( void ) {
5520         // In order to reduce the number of mallocs and frees, we return a static
5521         // instance of QueryFrame, if we can find one that we're not already using.
5522         // We rely on the fact that the compiler will implicitly initialize the
5523         // static instances so that in_use == 0.
5524
5525         int i;
5526         for( i = 0; i < STATIC_FRAME_COUNT; ++i ) {
5527                 if( ! static_frame[ i ].in_use ) {
5528                         static_frame[ i ].in_use = 1;
5529                         return static_frame + i;
5530                 }
5531         }
5532
5533         // The static ones are all in use.  Malloc one.
5534
5535         return safe_malloc( sizeof( QueryFrame ) );
5536 }
5537
5538 /* --------------------------------------------------------------------------
5539  Free a QueryFrame, and all the memory it owns.
5540 ---------------------------------------------------------------------------*/
5541 static void free_query_frame( QueryFrame* frame ) {
5542         // Sanity check
5543         if( ! frame )
5544                 return;
5545
5546         clear_class_info( &frame->core );
5547
5548         // Free the join list
5549         ClassInfo* temp;
5550         ClassInfo* info = frame->join_list;
5551         while( info ) {
5552                 temp = info->next;
5553                 free_class_info( info );
5554                 info = temp;
5555         }
5556
5557         frame->join_list = NULL;
5558         frame->next = NULL;
5559
5560         // If the frame is a static instance, just mark it as unused
5561         int i;
5562         for( i = 0; i < STATIC_FRAME_COUNT; ++i ) {
5563                 if( frame == static_frame + i ) {
5564                         static_frame[ i ].in_use = 0;
5565                         return;
5566                 }
5567         }
5568
5569         // Otherwise it must have been malloc'd, so free it
5570
5571         free( frame );
5572 }
5573
5574 /* --------------------------------------------------------------------------
5575  Search a given QueryFrame for a specified alias.  If you find it, return
5576  a pointer to the corresponding ClassInfo.  Otherwise return NULL.
5577 ---------------------------------------------------------------------------*/
5578 static ClassInfo* search_alias_in_frame( QueryFrame* frame, const char* target ) {
5579         if( ! frame || ! target ) {
5580                 return NULL;
5581         }
5582
5583         ClassInfo* found_class = NULL;
5584
5585         if( !strcmp( target, frame->core.alias ) )
5586                 return &(frame->core);
5587         else {
5588                 ClassInfo* curr_class = frame->join_list;
5589                 while( curr_class ) {
5590                         if( strcmp( target, curr_class->alias ) )
5591                                 curr_class = curr_class->next;
5592                         else {
5593                                 found_class = curr_class;
5594                                 break;
5595                         }
5596                 }
5597         }
5598
5599         return found_class;
5600 }
5601
5602 /* --------------------------------------------------------------------------
5603  Push a new (blank) QueryFrame onto the stack.
5604 ---------------------------------------------------------------------------*/
5605 static void push_query_frame( void ) {
5606         QueryFrame* frame = allocate_frame();
5607         frame->join_list = NULL;
5608         frame->next = curr_query;
5609
5610         // Initialize the ClassInfo for the core class
5611         ClassInfo* core = &frame->core;
5612         core->alias = core->class_name = core->source_def = NULL;
5613         core->class_def = core->fields = core->links = NULL;
5614
5615         curr_query = frame;
5616 }
5617
5618 /* --------------------------------------------------------------------------
5619  Pop a QueryFrame off the stack and destroy it
5620 ---------------------------------------------------------------------------*/
5621 static void pop_query_frame( void ) {
5622         // Sanity check
5623         if( ! curr_query )
5624                 return;
5625
5626         QueryFrame* popped = curr_query;
5627         curr_query = popped->next;
5628
5629         free_query_frame( popped );
5630 }
5631
5632 /* --------------------------------------------------------------------------
5633  Populate the ClassInfo for the core class.  Return 0 if successful, 1 if not.
5634 ---------------------------------------------------------------------------*/
5635 static int add_query_core( const char* alias, const char* class_name ) {
5636
5637         // Sanity checks
5638         if( ! curr_query ) {
5639                 osrfLogError( OSRF_LOG_MARK,
5640                                           "%s ERROR: No QueryFrame available for class %s", MODULENAME, class_name );
5641                 return 1;
5642         } else if( curr_query->core.alias ) {
5643                 osrfLogError( OSRF_LOG_MARK,
5644                                           "%s ERROR: Core class %s already populated as %s",
5645                                           MODULENAME, curr_query->core.class_name, curr_query->core.alias );
5646                 return 1;
5647         }
5648
5649         build_class_info( &curr_query->core, alias, class_name );
5650         if( curr_query->core.alias )
5651                 return 0;
5652         else {
5653                 osrfLogError( OSRF_LOG_MARK,
5654                                           "%s ERROR: Unable to look up core class %s", MODULENAME, class_name );
5655                 return 1;
5656         }
5657 }
5658
5659 /* --------------------------------------------------------------------------
5660  Search the current QueryFrame for a specified alias.  If you find it,
5661  return a pointer to the corresponding ClassInfo.  Otherwise return NULL.
5662 ---------------------------------------------------------------------------*/
5663 static ClassInfo* search_alias( const char* target ) {
5664         return search_alias_in_frame( curr_query, target );
5665 }
5666
5667 /* --------------------------------------------------------------------------
5668  Search all levels of query for a specified alias, starting with the
5669  current query.  If you find it, return a pointer to the corresponding
5670  ClassInfo.  Otherwise return NULL.
5671 ---------------------------------------------------------------------------*/
5672 static ClassInfo* search_all_alias( const char* target ) {
5673         ClassInfo* found_class = NULL;
5674         QueryFrame* curr_frame = curr_query;
5675
5676         while( curr_frame ) {
5677                 if(( found_class = search_alias_in_frame( curr_frame, target ) ))
5678                         break;
5679                 else
5680                         curr_frame = curr_frame->next;
5681         }
5682
5683         return found_class;
5684 }
5685
5686 /* --------------------------------------------------------------------------
5687  Add a class to the list of classes joined to the current query.
5688 ---------------------------------------------------------------------------*/
5689 static ClassInfo* add_joined_class( const char* alias, const char* classname ) {
5690
5691         if( ! classname || ! *classname ) {    // sanity check
5692                 osrfLogError( OSRF_LOG_MARK, "Can't join a class with no class name" );
5693                 return NULL;
5694         }
5695
5696         if( ! alias )
5697                 alias = classname;
5698
5699         const ClassInfo* conflict = search_alias( alias );
5700         if( conflict ) {
5701                 osrfLogError( OSRF_LOG_MARK,
5702                                           "%s ERROR: Table alias \"%s\" conflicts with class \"%s\"",
5703                                           MODULENAME, alias, conflict->class_name );
5704                 return NULL;
5705         }
5706
5707         ClassInfo* info = allocate_class_info();
5708
5709         if( build_class_info( info, alias, classname ) ) {
5710                 free_class_info( info );
5711                 return NULL;
5712         }
5713
5714         // Add the new ClassInfo to the join list of the current QueryFrame
5715         info->next = curr_query->join_list;
5716         curr_query->join_list = info;
5717
5718         return info;
5719 }
5720
5721 /* --------------------------------------------------------------------------
5722  Destroy all nodes on the query stack.
5723 ---------------------------------------------------------------------------*/
5724 static void clear_query_stack( void ) {
5725         while( curr_query )
5726                 pop_query_frame();
5727 }