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                 jsonIterator* search_itr = jsonNewIterator( search_hash );
2554                 if( !jsonIteratorHasNext( search_itr ) ) {
2555                         osrfLogError(
2556                                 OSRF_LOG_MARK,
2557                                 "%s: Invalid predicate structure: empty JSON array",
2558                                 MODULENAME
2559                         );
2560                         jsonIteratorFree( search_itr );
2561                         buffer_free( sql_buf );
2562                         return NULL;
2563                 }
2564
2565                 while ( (node = jsonIteratorNext( search_itr )) ) {
2566                         if (first) {
2567                                 first = 0;
2568                         } else {
2569                                 if (opjoin_type == OR_OP_JOIN)
2570                                         buffer_add(sql_buf, " OR ");
2571                                 else
2572                                         buffer_add(sql_buf, " AND ");
2573                         }
2574
2575                         char* subpred = searchWHERE( node, class_info, opjoin_type, ctx );
2576                         if( ! subpred ) {
2577                                 jsonIteratorFree( search_itr );
2578                                 buffer_free( sql_buf );
2579                                 return NULL;
2580                         }
2581
2582                         buffer_fadd(sql_buf, "( %s )", subpred);
2583                         free(subpred);
2584                 }
2585                 jsonIteratorFree(search_itr);
2586
2587         } else if ( search_hash->type == JSON_HASH ) {
2588                 osrfLogDebug(OSRF_LOG_MARK, "%s: In WHERE clause, condition type is JSON_HASH", MODULENAME);
2589                 jsonIterator* search_itr = jsonNewIterator( search_hash );
2590                 if( !jsonIteratorHasNext( search_itr ) ) {
2591                         osrfLogError(
2592                                 OSRF_LOG_MARK,
2593                                 "%s: Invalid predicate structure: empty JSON object",
2594                                 MODULENAME
2595                         );
2596                         jsonIteratorFree( search_itr );
2597                         buffer_free( sql_buf );
2598                         return NULL;
2599                 }
2600
2601                 while ( (node = jsonIteratorNext( search_itr )) ) {
2602
2603                         if (first) {
2604                                 first = 0;
2605                         } else {
2606                                 if (opjoin_type == OR_OP_JOIN)
2607                                         buffer_add(sql_buf, " OR ");
2608                                 else
2609                                         buffer_add(sql_buf, " AND ");
2610                         }
2611
2612                         if ( '+' == search_itr->key[ 0 ] ) {
2613
2614                                 // This plus sign prefixes a class name or other table alias;
2615                                 // make sure the table alias is in scope
2616                                 ClassInfo* alias_info = search_all_alias( search_itr->key + 1 );
2617                                 if( ! alias_info ) {
2618                                         osrfLogError(
2619                                                          OSRF_LOG_MARK,
2620                                                         "%s: Invalid table alias \"%s\" in WHERE clause",
2621                                                         MODULENAME,
2622                                                         search_itr->key + 1
2623                                         );
2624                                         jsonIteratorFree( search_itr );
2625                                         buffer_free( sql_buf );
2626                                         return NULL;
2627                                 }
2628
2629                                 if ( node->type == JSON_STRING ) {
2630                                         // It's the name of a column; make sure it belongs to the class
2631                                         const char* fieldname = jsonObjectGetString( node );
2632                                         if( ! osrfHashGet( alias_info->fields, fieldname ) ) {
2633                                                 osrfLogError(
2634                                                         OSRF_LOG_MARK,
2635                                                         "%s: Invalid column name \"%s\" in WHERE clause for table alias \"%s\"",
2636                                                         MODULENAME,
2637                                                         fieldname,
2638                                                         alias_info->alias
2639                                                 );
2640                                                 jsonIteratorFree( search_itr );
2641                                                 buffer_free( sql_buf );
2642                                                 return NULL;
2643                                         }
2644
2645                                         buffer_fadd(sql_buf, " \"%s\".%s ", alias_info->alias, fieldname );
2646                                 } else {
2647                                         // It's something more complicated
2648                                         char* subpred = searchWHERE( node, alias_info, AND_OP_JOIN, ctx );
2649                                         if( ! subpred ) {
2650                                                 jsonIteratorFree( search_itr );
2651                                                 buffer_free( sql_buf );
2652                                                 return NULL;
2653                                         }
2654
2655                                         buffer_fadd(sql_buf, "( %s )", subpred);
2656                                         free(subpred);
2657                                 }
2658                         } else if ( '-' == search_itr->key[ 0 ] ) {
2659                                 if ( !strcasecmp("-or",search_itr->key) ) {
2660                                         char* subpred = searchWHERE( node, class_info, OR_OP_JOIN, ctx );
2661                                         if( ! subpred ) {
2662                                                 jsonIteratorFree( search_itr );
2663                                                 buffer_free( sql_buf );
2664                                                 return NULL;
2665                                         }
2666
2667                                         buffer_fadd(sql_buf, "( %s )", subpred);
2668                                         free( subpred );
2669                                 } else if ( !strcasecmp("-and",search_itr->key) ) {
2670                                         char* subpred = searchWHERE( node, class_info, AND_OP_JOIN, ctx );
2671                                         if( ! subpred ) {
2672                                                 jsonIteratorFree( search_itr );
2673                                                 buffer_free( sql_buf );
2674                                                 return NULL;
2675                                         }
2676
2677                                         buffer_fadd(sql_buf, "( %s )", subpred);
2678                                         free( subpred );
2679                                 } else if ( !strcasecmp("-not",search_itr->key) ) {
2680                                         char* subpred = searchWHERE( node, class_info, AND_OP_JOIN, ctx );
2681                                         if( ! subpred ) {
2682                                                 jsonIteratorFree( search_itr );
2683                                                 buffer_free( sql_buf );
2684                                                 return NULL;
2685                                         }
2686
2687                                         buffer_fadd(sql_buf, " NOT ( %s )", subpred);
2688                                         free( subpred );
2689                                 } else if ( !strcasecmp("-exists",search_itr->key) ) {
2690                                         char* subpred = SELECT(
2691                                                 ctx,
2692                                                 jsonObjectGetKey( node, "select" ),
2693                                                 jsonObjectGetKey( node, "from" ),
2694                                                 jsonObjectGetKey( node, "where" ),
2695                                                 jsonObjectGetKey( node, "having" ),
2696                                                 jsonObjectGetKey( node, "order_by" ),
2697                                                 jsonObjectGetKey( node, "limit" ),
2698                                                 jsonObjectGetKey( node, "offset" ),
2699                                                 SUBSELECT
2700                                         );
2701                                         pop_query_frame();
2702
2703                                         if( ! subpred ) {
2704                                                 jsonIteratorFree( search_itr );
2705                                                 buffer_free( sql_buf );
2706                                                 return NULL;
2707                                         }
2708
2709                                         buffer_fadd(sql_buf, "EXISTS ( %s )", subpred);
2710                                         free(subpred);
2711                                 } else if ( !strcasecmp("-not-exists",search_itr->key) ) {
2712                                         char* subpred = SELECT(
2713                                                 ctx,
2714                                                 jsonObjectGetKey( node, "select" ),
2715                                                 jsonObjectGetKey( node, "from" ),
2716                                                 jsonObjectGetKey( node, "where" ),
2717                                                 jsonObjectGetKey( node, "having" ),
2718                                                 jsonObjectGetKey( node, "order_by" ),
2719                                                 jsonObjectGetKey( node, "limit" ),
2720                                                 jsonObjectGetKey( node, "offset" ),
2721                                                 SUBSELECT
2722                                         );
2723                                         pop_query_frame();
2724
2725                                         if( ! subpred ) {
2726                                                 jsonIteratorFree( search_itr );
2727                                                 buffer_free( sql_buf );
2728                                                 return NULL;
2729                                         }
2730
2731                                         buffer_fadd(sql_buf, "NOT EXISTS ( %s )", subpred);
2732                                         free(subpred);
2733                                 } else {     // Invalid "minus" operator
2734                                         osrfLogError(
2735                                                          OSRF_LOG_MARK,
2736                                                         "%s: Invalid operator \"%s\" in WHERE clause",
2737                                                         MODULENAME,
2738                                                         search_itr->key
2739                                         );
2740                                         jsonIteratorFree( search_itr );
2741                                         buffer_free( sql_buf );
2742                                         return NULL;
2743                                 }
2744
2745                         } else {
2746
2747                                 const char* class = class_info->class_name;
2748                                 osrfHash* fields = class_info->fields;
2749                                 osrfHash* field = osrfHashGet( fields, search_itr->key );
2750
2751                                 if (!field) {
2752                                         const char* table = class_info->source_def;
2753                                         osrfLogError(
2754                                                 OSRF_LOG_MARK,
2755                                                 "%s: Attempt to reference non-existent column \"%s\" on %s (%s)",
2756                                                 MODULENAME,
2757                                                 search_itr->key,
2758                                                 table ? table : "?",
2759                                                 class ? class : "?"
2760                                         );
2761                                         jsonIteratorFree(search_itr);
2762                                         buffer_free(sql_buf);
2763                                         return NULL;
2764                                 }
2765
2766                                 char* subpred = searchPredicate( class_info, field, node, ctx );
2767                                 if( ! subpred ) {
2768                                         buffer_free(sql_buf);
2769                                         jsonIteratorFree(search_itr);
2770                                         return NULL;
2771                                 }
2772
2773                                 buffer_add( sql_buf, subpred );
2774                                 free(subpred);
2775                         }
2776                 }
2777                 jsonIteratorFree(search_itr);
2778
2779     } else {
2780         // ERROR ... only hash and array allowed at this level
2781         char* predicate_string = jsonObjectToJSON( search_hash );
2782         osrfLogError(
2783             OSRF_LOG_MARK,
2784             "%s: Invalid predicate structure: %s",
2785             MODULENAME,
2786             predicate_string
2787         );
2788         buffer_free(sql_buf);
2789         free(predicate_string);
2790         return NULL;
2791     }
2792
2793         return buffer_release(sql_buf);
2794 }
2795
2796 char* SELECT (
2797                 /* method context */ osrfMethodContext* ctx,
2798
2799                 /* SELECT   */ jsonObject* selhash,
2800                 /* FROM     */ jsonObject* join_hash,
2801                 /* WHERE    */ jsonObject* search_hash,
2802                 /* HAVING   */ jsonObject* having_hash,
2803                 /* ORDER BY */ jsonObject* order_hash,
2804                 /* LIMIT    */ jsonObject* limit,
2805                 /* OFFSET   */ jsonObject* offset,
2806                 /* flags    */ int flags
2807 ) {
2808         const char* locale = osrf_message_get_last_locale();
2809
2810         // general tmp objects
2811         const jsonObject* tmp_const;
2812         jsonObject* selclass = NULL;
2813         jsonObject* selfield = NULL;
2814         jsonObject* snode = NULL;
2815         jsonObject* onode = NULL;
2816
2817         char* string = NULL;
2818         int from_function = 0;
2819         int first = 1;
2820         int gfirst = 1;
2821         //int hfirst = 1;
2822
2823         osrfLogDebug(OSRF_LOG_MARK, "cstore SELECT locale: %s", locale);
2824
2825         // punt if there's no FROM clause
2826         if (!join_hash || ( join_hash->type == JSON_HASH && !join_hash->size )) {
2827                 osrfLogError(
2828                         OSRF_LOG_MARK,
2829                         "%s: FROM clause is missing or empty",
2830                         MODULENAME
2831                 );
2832                 if( ctx )
2833                         osrfAppSessionStatus(
2834                                 ctx->session,
2835                                 OSRF_STATUS_INTERNALSERVERERROR,
2836                                 "osrfMethodException",
2837                                 ctx->request,
2838                                 "FROM clause is missing or empty in JSON query"
2839                         );
2840                 return NULL;
2841         }
2842
2843         // Push a node onto the stack for the current query.  Every level of
2844         // subquery gets its own QueryFrame on the Stack.
2845         push_query_frame();
2846
2847         // the core search class
2848         const char* core_class = NULL;
2849
2850         // get the core class -- the only key of the top level FROM clause, or a string
2851         if (join_hash->type == JSON_HASH) {
2852                 jsonIterator* tmp_itr = jsonNewIterator( join_hash );
2853                 snode = jsonIteratorNext( tmp_itr );
2854
2855                 // Populate the current QueryFrame with information
2856                 // about the core class
2857                 if( add_query_core( NULL, tmp_itr->key ) ) {
2858                         if( ctx )
2859                                 osrfAppSessionStatus(
2860                                         ctx->session,
2861                                         OSRF_STATUS_INTERNALSERVERERROR,
2862                                         "osrfMethodException",
2863                                         ctx->request,
2864                                         "Unable to look up core class"
2865                                 );
2866                         return NULL;
2867                 }
2868                 core_class = curr_query->core.class_name;
2869                 join_hash = snode;
2870
2871                 jsonObject* extra = jsonIteratorNext( tmp_itr );
2872
2873                 jsonIteratorFree( tmp_itr );
2874                 snode = NULL;
2875
2876                 // There shouldn't be more than one entry in join_hash
2877                 if( extra ) {
2878                         osrfLogError(
2879                                 OSRF_LOG_MARK,
2880                                 "%s: Malformed FROM clause: extra entry in JSON_HASH",
2881                                 MODULENAME
2882                         );
2883                         if( ctx )
2884                                 osrfAppSessionStatus(
2885                                         ctx->session,
2886                                         OSRF_STATUS_INTERNALSERVERERROR,
2887                                         "osrfMethodException",
2888                                         ctx->request,
2889                                         "Malformed FROM clause in JSON query"
2890                                 );
2891                         return NULL;    // Malformed join_hash; extra entry
2892                 }
2893         } else if (join_hash->type == JSON_ARRAY) {
2894                 // We're selecting from a function, not from a table
2895                 from_function = 1;
2896                 core_class = jsonObjectGetString( jsonObjectGetIndex(join_hash, 0) );
2897                 selhash = NULL;
2898
2899         } else if (join_hash->type == JSON_STRING) {
2900                 // Populate the current QueryFrame with information
2901                 // about the core class
2902                 core_class = jsonObjectGetString( join_hash );
2903                 join_hash = NULL;
2904                 if( add_query_core( NULL, core_class ) ) {
2905                         if( ctx )
2906                                 osrfAppSessionStatus(
2907                                         ctx->session,
2908                                         OSRF_STATUS_INTERNALSERVERERROR,
2909                                         "osrfMethodException",
2910                                         ctx->request,
2911                                         "Unable to look up core class"
2912                                 );
2913                         return NULL;
2914                 }
2915         }
2916         else {
2917                 osrfLogError(
2918                         OSRF_LOG_MARK,
2919                         "%s: FROM clause is unexpected JSON type: %s",
2920                         MODULENAME,
2921                         json_type( join_hash->type )
2922                 );
2923                 if( ctx )
2924                         osrfAppSessionStatus(
2925                                 ctx->session,
2926                                 OSRF_STATUS_INTERNALSERVERERROR,
2927                                 "osrfMethodException",
2928                                 ctx->request,
2929                                 "Ill-formed FROM clause in JSON query"
2930                         );
2931                 return NULL;
2932         }
2933
2934         // Build the join clause, if any, while filling out the list
2935         // of joined classes in the current QueryFrame.
2936         char* join_clause = NULL;
2937         if( join_hash && ! from_function ) {
2938
2939                 join_clause = searchJOIN( join_hash, &curr_query->core );
2940                 if( ! join_clause ) {
2941                         if (ctx)
2942                                 osrfAppSessionStatus(
2943                                         ctx->session,
2944                                         OSRF_STATUS_INTERNALSERVERERROR,
2945                                         "osrfMethodException",
2946                                         ctx->request,
2947                                         "Unable to construct JOIN clause(s)"
2948                                 );
2949                         return NULL;
2950                 }
2951         }
2952
2953         // For in case we don't get a select list
2954         jsonObject* defaultselhash = NULL;
2955
2956         // if the select list is empty, or the core class field list is '*',
2957         // build the default select list ...
2958         if (!selhash) {
2959                 selhash = defaultselhash = jsonNewObjectType(JSON_HASH);
2960                 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2961         } else if( selhash->type != JSON_HASH ) {
2962                 osrfLogError(
2963                         OSRF_LOG_MARK,
2964                         "%s: Expected JSON_HASH for SELECT clause; found %s",
2965                         MODULENAME,
2966                         json_type( selhash->type )
2967                 );
2968
2969                 if (ctx)
2970                         osrfAppSessionStatus(
2971                                 ctx->session,
2972                                 OSRF_STATUS_INTERNALSERVERERROR,
2973                                 "osrfMethodException",
2974                                 ctx->request,
2975                                 "Malformed SELECT clause in JSON query"
2976                         );
2977                 free( join_clause );
2978                 return NULL;
2979         } else if ( (tmp_const = jsonObjectGetKeyConst( selhash, core_class )) && tmp_const->type == JSON_STRING ) {
2980                 const char* _x = jsonObjectGetString( tmp_const );
2981                 if (!strncmp( "*", _x, 1 )) {
2982                         jsonObjectRemoveKey( selhash, core_class );
2983                         jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
2984                 }
2985         }
2986
2987         // temp buffers for the SELECT list and GROUP BY clause
2988         growing_buffer* select_buf = buffer_init(128);
2989         growing_buffer* group_buf = buffer_init(128);
2990
2991         int aggregate_found = 0;     // boolean
2992
2993         // Build a select list
2994         if(from_function)   // From a function we select everything
2995                 OSRF_BUFFER_ADD_CHAR( select_buf, '*' );
2996         else {
2997
2998                 // If we need to build a default list, prepare to do so
2999                 jsonObject* _tmp = jsonObjectGetKey( selhash, core_class );
3000                 if ( _tmp && !_tmp->size ) {
3001
3002                         osrfHash* core_fields = curr_query->core.fields;
3003
3004                         osrfHashIterator* field_itr = osrfNewHashIterator( core_fields );
3005                         osrfHash* field_def;
3006                         while( ( field_def = osrfHashIteratorNext( field_itr ) ) ) {
3007                                 if( ! str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3008                                         // This field is not virtual, so add it to the list
3009                                         jsonObjectPush( _tmp, jsonNewObject( osrfHashIteratorKey( field_itr ) ) );
3010                                 }
3011                         }
3012                         osrfHashIteratorFree( field_itr );
3013                 }
3014
3015                 // Now build the actual select list
3016             int sel_pos = 1;
3017             first = 1;
3018             gfirst = 1;
3019             jsonIterator* selclass_itr = jsonNewIterator( selhash );
3020             while ( (selclass = jsonIteratorNext( selclass_itr )) ) {    // For each class
3021
3022                         const char* cname = selclass_itr->key;
3023
3024                         // Make sure the target relation is in the FROM clause.
3025
3026                         // At this point join_hash is a step down from the join_hash we
3027                         // received as a parameter.  If the original was a JSON_STRING,
3028                         // then json_hash is now NULL.  If the original was a JSON_HASH,
3029                         // then json_hash is now the first (and only) entry in it,
3030                         // denoting the core class.  We've already excluded the
3031                         // possibility that the original was a JSON_ARRAY, because in
3032                         // that case from_function would be non-NULL, and we wouldn't
3033                         // be here.
3034
3035                         // If the current class isn't the core class
3036                         // and it isn't in the join tree, bail out
3037                         ClassInfo* class_info = search_alias( cname );
3038                         if( ! class_info ) {
3039                                 osrfLogError(
3040                                         OSRF_LOG_MARK,
3041                                         "%s: SELECT clause references class not in FROM clause: \"%s\"",
3042                                         MODULENAME,
3043                                         cname
3044                                 );
3045                                 if( ctx )
3046                                         osrfAppSessionStatus(
3047                                                 ctx->session,
3048                                                 OSRF_STATUS_INTERNALSERVERERROR,
3049                                                 "osrfMethodException",
3050                                                 ctx->request,
3051                                                 "Selected class not in FROM clause in JSON query"
3052                                         );
3053                                 jsonIteratorFree( selclass_itr );
3054                                 buffer_free( select_buf );
3055                                 buffer_free( group_buf );
3056                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3057                                 free( join_clause );
3058                                 return NULL;
3059                         }
3060
3061                         // Look up some attributes of the current class
3062                         osrfHash* idlClass = class_info->class_def;
3063                         osrfHash* class_field_set = class_info->fields;
3064                         const char* class_pkey = osrfHashGet( idlClass, "primarykey" );
3065                         const char* class_tname = osrfHashGet( idlClass, "tablename" );
3066
3067                         if( 0 == selclass->size ) {
3068                                 osrfLogWarning(
3069                                         OSRF_LOG_MARK,
3070                                         "%s: No columns selected from \"%s\"",
3071                                         MODULENAME,
3072                                         cname
3073                                 );
3074                         }
3075
3076                         // stitch together the column list for the current table alias...
3077                         jsonIterator* select_itr = jsonNewIterator( selclass );
3078                         while ( (selfield = jsonIteratorNext( select_itr )) ) {   // for each SELECT column
3079
3080                                 // If we need a separator comma, add one
3081                                 if (first) {
3082                                         first = 0;
3083                                 } else {
3084                                         OSRF_BUFFER_ADD_CHAR( select_buf, ',' );
3085                                 }
3086
3087                                 // ... if it's a string, just toss it on the pile
3088                                 if (selfield->type == JSON_STRING) {
3089
3090                                         // Look up the field in the IDL
3091                                         const char* col_name = jsonObjectGetString( selfield );
3092                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3093                                         if ( !field_def ) {
3094                                                 // No such field in current class
3095                                                 osrfLogError(
3096                                                         OSRF_LOG_MARK,
3097                                                         "%s: Selected column \"%s\" not defined in IDL for class \"%s\"",
3098                                                         MODULENAME,
3099                                                         col_name,
3100                                                         cname
3101                                                 );
3102                                                 if( ctx )
3103                                                         osrfAppSessionStatus(
3104                                                                 ctx->session,
3105                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3106                                                                 "osrfMethodException",
3107                                                                 ctx->request,
3108                                                                 "Selected column not defined in JSON query"
3109                                                         );
3110                                                 jsonIteratorFree( select_itr );
3111                                                 jsonIteratorFree( selclass_itr );
3112                                                 buffer_free( select_buf );
3113                                                 buffer_free( group_buf );
3114                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3115                                                 free( join_clause );
3116                                                 return NULL;
3117                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3118                                                 // Virtual field not allowed
3119                                                 osrfLogError(
3120                                                         OSRF_LOG_MARK,
3121                                                         "%s: Selected column \"%s\" for class \"%s\" is virtual",
3122                                                         MODULENAME,
3123                                                         col_name,
3124                                                         cname
3125                                                 );
3126                                                 if( ctx )
3127                                                         osrfAppSessionStatus(
3128                                                                 ctx->session,
3129                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3130                                                                 "osrfMethodException",
3131                                                                 ctx->request,
3132                                                                 "Selected column may not be virtual in JSON query"
3133                                                         );
3134                                                 jsonIteratorFree( select_itr );
3135                                                 jsonIteratorFree( selclass_itr );
3136                                                 buffer_free( select_buf );
3137                                                 buffer_free( group_buf );
3138                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3139                                                 free( join_clause );
3140                                                 return NULL;
3141                                         }
3142
3143                                         if (locale) {
3144                                                 const char* i18n;
3145                                                 if (flags & DISABLE_I18N)
3146                                                         i18n = NULL;
3147                                                 else
3148                                                         i18n = osrfHashGet(field_def, "i18n");
3149
3150                                                 if( str_is_true( i18n ) ) {
3151                             buffer_fadd( select_buf,
3152                                                                 " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3153                                                                 class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, col_name );
3154                         } else {
3155                                             buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3156                         }
3157                     } else {
3158                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, col_name );
3159                     }
3160
3161                                 // ... but it could be an object, in which case we check for a Field Transform
3162                                 } else if (selfield->type == JSON_HASH) {
3163
3164                                         const char* col_name = jsonObjectGetString( jsonObjectGetKeyConst( selfield, "column" ) );
3165
3166                                         // Get the field definition from the IDL
3167                                         osrfHash* field_def = osrfHashGet( class_field_set, col_name );
3168                                         if ( !field_def ) {
3169                                                 // No such field in current class
3170                                                 osrfLogError(
3171                                                         OSRF_LOG_MARK,
3172                                                         "%s: Selected column \"%s\" is not defined in IDL for class \"%s\"",
3173                                                         MODULENAME,
3174                                                         col_name,
3175                                                         cname
3176                                                 );
3177                                                 if( ctx )
3178                                                         osrfAppSessionStatus(
3179                                                                 ctx->session,
3180                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3181                                                                 "osrfMethodException",
3182                                                                 ctx->request,
3183                                                                 "Selected column is not defined in JSON query"
3184                                                         );
3185                                                 jsonIteratorFree( select_itr );
3186                                                 jsonIteratorFree( selclass_itr );
3187                                                 buffer_free( select_buf );
3188                                                 buffer_free( group_buf );
3189                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3190                                                 free( join_clause );
3191                                                 return NULL;
3192                                         } else if ( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3193                                                 // No such field in current class
3194                                                 osrfLogError(
3195                                                         OSRF_LOG_MARK,
3196                                                         "%s: Selected column \"%s\" is virtual for class \"%s\"",
3197                                                         MODULENAME,
3198                                                         col_name,
3199                                                         cname
3200                                                 );
3201                                                 if( ctx )
3202                                                         osrfAppSessionStatus(
3203                                                                 ctx->session,
3204                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3205                                                                 "osrfMethodException",
3206                                                                 ctx->request,
3207                                                                 "Selected column is virtual in JSON query"
3208                                                         );
3209                                                 jsonIteratorFree( select_itr );
3210                                                 jsonIteratorFree( selclass_itr );
3211                                                 buffer_free( select_buf );
3212                                                 buffer_free( group_buf );
3213                                                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3214                                                 free( join_clause );
3215                                                 return NULL;
3216                                         }
3217
3218                                         // Decide what to use as a column alias
3219                                         const char* _alias;
3220                                         if ((tmp_const = jsonObjectGetKeyConst( selfield, "alias" ))) {
3221                                                 _alias = jsonObjectGetString( tmp_const );
3222                                         } else {         // Use field name as the alias
3223                                                 _alias = col_name;
3224                                         }
3225
3226                                         if (jsonObjectGetKeyConst( selfield, "transform" )) {
3227                                                 char* transform_str = searchFieldTransform(class_info->alias, field_def, selfield);
3228                                                 if( transform_str ) {
3229                                                         buffer_fadd(select_buf, " %s AS \"%s\"", transform_str, _alias);
3230                                                         free(transform_str);
3231                                                 } else {
3232                                                         if( ctx )
3233                                                                 osrfAppSessionStatus(
3234                                                                         ctx->session,
3235                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3236                                                                         "osrfMethodException",
3237                                                                         ctx->request,
3238                                                                         "Unable to generate transform function in JSON query"
3239                                                                 );
3240                                                         jsonIteratorFree( select_itr );
3241                                                         jsonIteratorFree( selclass_itr );
3242                                                         buffer_free( select_buf );
3243                                                         buffer_free( group_buf );
3244                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3245                                                         free( join_clause );
3246                                                         return NULL;
3247                                                 }
3248                                         } else {
3249
3250                                                 if (locale) {
3251                                                         const char* i18n;
3252                                                         if (flags & DISABLE_I18N)
3253                                                                 i18n = NULL;
3254                                                         else
3255                                                                 i18n = osrfHashGet(field_def, "i18n");
3256
3257                                                         if( str_is_true( i18n ) ) {
3258                                                                 buffer_fadd( select_buf,
3259                                                                         " oils_i18n_xlate('%s', '%s', '%s', '%s', \"%s\".%s::TEXT, '%s') AS \"%s\"",
3260                                                                         class_tname, cname, col_name, class_pkey, cname, class_pkey, locale, _alias);
3261                                                         } else {
3262                                                                 buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3263                                                         }
3264                                                 } else {
3265                                                         buffer_fadd(select_buf, " \"%s\".%s AS \"%s\"", cname, col_name, _alias);
3266                                                 }
3267                                         }
3268                                 }
3269                                 else {
3270                                         osrfLogError(
3271                                                 OSRF_LOG_MARK,
3272                                                 "%s: Selected item is unexpected JSON type: %s",
3273                                                 MODULENAME,
3274                                                 json_type( selfield->type )
3275                                         );
3276                                         if( ctx )
3277                                                 osrfAppSessionStatus(
3278                                                         ctx->session,
3279                                                         OSRF_STATUS_INTERNALSERVERERROR,
3280                                                         "osrfMethodException",
3281                                                         ctx->request,
3282                                                         "Ill-formed SELECT item in JSON query"
3283                                                 );
3284                                         jsonIteratorFree( select_itr );
3285                                         jsonIteratorFree( selclass_itr );
3286                                         buffer_free( select_buf );
3287                                         buffer_free( group_buf );
3288                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
3289                                         free( join_clause );
3290                                         return NULL;
3291                                 }
3292
3293                                 const jsonObject* agg_obj = jsonObjectGetKey( selfield, "aggregate" );
3294                                 if( obj_is_true( agg_obj ) )
3295                                         aggregate_found = 1;
3296                                 else {
3297                                         // Append a comma (except for the first one)
3298                                         // and add the column to a GROUP BY clause
3299                                         if (gfirst)
3300                                                 gfirst = 0;
3301                                         else
3302                                                 OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3303
3304                                         buffer_fadd(group_buf, " %d", sel_pos);
3305                                 }
3306
3307 #if 0
3308                             if (is_agg->size || (flags & SELECT_DISTINCT)) {
3309
3310                                         const jsonObject* aggregate_obj = jsonObjectGetKey( selfield, "aggregate" );
3311                                     if ( ! obj_is_true( aggregate_obj ) ) {
3312                                             if (gfirst) {
3313                                                     gfirst = 0;
3314                                             } else {
3315                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3316                                             }
3317
3318                                             buffer_fadd(group_buf, " %d", sel_pos);
3319
3320                                         /*
3321                                     } else if (is_agg = jsonObjectGetKey( selfield, "having" )) {
3322                                             if (gfirst) {
3323                                                     gfirst = 0;
3324                                             } else {
3325                                                         OSRF_BUFFER_ADD_CHAR( group_buf, ',' );
3326                                             }
3327
3328                                             _column = searchFieldTransform(class_info->alias, field, selfield);
3329                                                 OSRF_BUFFER_ADD_CHAR(group_buf, ' ');
3330                                                 OSRF_BUFFER_ADD(group_buf, _column);
3331                                             _column = searchFieldTransform(class_info->alias, field, selfield);
3332                                         */
3333                                     }
3334                             }
3335 #endif
3336
3337                                 sel_pos++;
3338                         } // end while -- iterating across SELECT columns
3339
3340                         jsonIteratorFree(select_itr);
3341                 } // end while -- iterating across classes
3342
3343                 jsonIteratorFree(selclass_itr);
3344         }
3345
3346
3347         char* col_list = buffer_release(select_buf);
3348
3349         // Make sure the SELECT list isn't empty.  This can happen if we try to
3350         // build a default SELECT clause from a non-core table.
3351
3352         if( ! *col_list ) {
3353                 if (ctx)
3354                         osrfAppSessionStatus(
3355                                 ctx->session,
3356                                 OSRF_STATUS_INTERNALSERVERERROR,
3357                                 "osrfMethodException",
3358                                 ctx->request,
3359                                 "SELECT list is empty"
3360                 );
3361                 free( col_list );
3362                 buffer_free( group_buf );
3363                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3364                 free( join_clause );
3365                 return NULL;
3366         }
3367
3368         char* table = NULL;
3369         if (from_function) table = searchValueTransform(join_hash);
3370         else table = strdup( curr_query->core.source_def );
3371
3372         if( !table ) {
3373                 if (ctx)
3374                         osrfAppSessionStatus(
3375                                 ctx->session,
3376                                 OSRF_STATUS_INTERNALSERVERERROR,
3377                                 "osrfMethodException",
3378                                 ctx->request,
3379                                 "Unable to identify table for core class"
3380                         );
3381                 free( col_list );
3382                 buffer_free( group_buf );
3383                 if( defaultselhash ) jsonObjectFree( defaultselhash );
3384                 free( join_clause );
3385                 return NULL;
3386         }
3387
3388         // Put it all together
3389         growing_buffer* sql_buf = buffer_init(128);
3390         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\" ", col_list, table, core_class );
3391         free(col_list);
3392         free(table);
3393
3394         // Append the join clause, if any
3395         if( join_clause ) {
3396                 buffer_add(sql_buf, join_clause);
3397                 free(join_clause);
3398         }
3399
3400         char* order_by_list = NULL;
3401         char* having_buf = NULL;
3402
3403         if (!from_function) {
3404
3405                 // Build a WHERE clause, if there is one
3406                 if ( search_hash ) {
3407                         buffer_add(sql_buf, " WHERE ");
3408
3409                         // and it's on the WHERE clause
3410                         char* pred = searchWHERE( search_hash, &curr_query->core, AND_OP_JOIN, ctx );
3411                         if ( ! pred ) {
3412                                 if (ctx) {
3413                                         osrfAppSessionStatus(
3414                                                 ctx->session,
3415                                                 OSRF_STATUS_INTERNALSERVERERROR,
3416                                                 "osrfMethodException",
3417                                                 ctx->request,
3418                                                 "Severe query error in WHERE predicate -- see error log for more details"
3419                                         );
3420                                 }
3421                                 buffer_free(group_buf);
3422                                 buffer_free(sql_buf);
3423                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3424                                 return NULL;
3425                         }
3426
3427                         buffer_add(sql_buf, pred);
3428                         free(pred);
3429                 }
3430
3431                 // Build a HAVING clause, if there is one
3432                 if ( having_hash ) {
3433
3434                         // and it's on the the WHERE clause
3435                         having_buf = searchWHERE( having_hash, &curr_query->core, AND_OP_JOIN, ctx );
3436
3437                         if( ! having_buf ) {
3438                                 if (ctx) {
3439                                                 osrfAppSessionStatus(
3440                                                 ctx->session,
3441                                                 OSRF_STATUS_INTERNALSERVERERROR,
3442                                                 "osrfMethodException",
3443                                                 ctx->request,
3444                                                 "Severe query error in HAVING predicate -- see error log for more details"
3445                                         );
3446                                 }
3447                                 buffer_free(group_buf);
3448                                 buffer_free(sql_buf);
3449                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3450                                 return NULL;
3451                         }
3452                 }
3453
3454                 growing_buffer* order_buf = NULL;  // to collect ORDER BY list
3455
3456                 // Build an ORDER BY clause, if there is one
3457                 if( NULL == order_hash )
3458                         ;  // No ORDER BY? do nothing
3459                 else if( JSON_ARRAY == order_hash->type ) {
3460                         // Array of field specifications, each specification being a
3461                         // hash to define the class, field, and other details
3462                         int order_idx = 0;
3463                         jsonObject* order_spec;
3464                         while( (order_spec = jsonObjectGetIndex( order_hash, order_idx++ ) ) ) {
3465
3466                                 if( JSON_HASH != order_spec->type ) {
3467                                         osrfLogError(OSRF_LOG_MARK,
3468                                                  "%s: Malformed field specification in ORDER BY clause; expected JSON_HASH, found %s",
3469                                                 MODULENAME, json_type( order_spec->type ) );
3470                                         if( ctx )
3471                                                 osrfAppSessionStatus(
3472                                                          ctx->session,
3473                                                         OSRF_STATUS_INTERNALSERVERERROR,
3474                                                         "osrfMethodException",
3475                                                         ctx->request,
3476                                                         "Malformed ORDER BY clause -- see error log for more details"
3477                                                 );
3478                                         buffer_free( order_buf );
3479                                         free(having_buf);
3480                                         buffer_free(group_buf);
3481                                         buffer_free(sql_buf);
3482                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3483                                         return NULL;
3484                                 }
3485
3486                                 const char* class_alias =
3487                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "class" ) );
3488                                 const char* field =
3489                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "field" ) );
3490
3491                                 if ( order_buf )
3492                                         OSRF_BUFFER_ADD(order_buf, ", ");
3493                                 else
3494                                         order_buf = buffer_init(128);
3495
3496                                 if( !field || !class_alias ) {
3497                                         osrfLogError(OSRF_LOG_MARK,
3498                                                 "%s: Missing class or field name in field specification of ORDER BY clause",
3499                                                  MODULENAME );
3500                                         if( ctx )
3501                                                 osrfAppSessionStatus(
3502                                                         ctx->session,
3503                                                         OSRF_STATUS_INTERNALSERVERERROR,
3504                                                         "osrfMethodException",
3505                                                         ctx->request,
3506                                                         "Malformed ORDER BY clause -- see error log for more details"
3507                                                 );
3508                                         buffer_free( order_buf );
3509                                         free(having_buf);
3510                                         buffer_free(group_buf);
3511                                         buffer_free(sql_buf);
3512                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3513                                         return NULL;
3514                                 }
3515
3516                                 ClassInfo* order_class_info = search_alias( class_alias );
3517                                 if( ! order_class_info ) {
3518                                         osrfLogError(OSRF_LOG_MARK, "%s: ORDER BY clause references class \"%s\" "
3519                                                         "not in FROM clause", MODULENAME, class_alias );
3520                                         if( ctx )
3521                                                 osrfAppSessionStatus(
3522                                                         ctx->session,
3523                                                         OSRF_STATUS_INTERNALSERVERERROR,
3524                                                         "osrfMethodException",
3525                                                         ctx->request,
3526                                                         "Invalid class referenced in ORDER BY clause -- see error log for more details"
3527                                                 );
3528                                         free(having_buf);
3529                                         buffer_free(group_buf);
3530                                         buffer_free(sql_buf);
3531                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3532                                         return NULL;
3533                                 }
3534
3535                                 osrfHash* field_def = osrfHashGet( order_class_info->fields, field );
3536                                 if( !field_def ) {
3537                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\".%s referenced in ORDER BY clause",
3538                                                  MODULENAME, class_alias, field );
3539                                         if( ctx )
3540                                                 osrfAppSessionStatus(
3541                                                         ctx->session,
3542                                                         OSRF_STATUS_INTERNALSERVERERROR,
3543                                                         "osrfMethodException",
3544                                                         ctx->request,
3545                                                         "Invalid field referenced in ORDER BY clause -- see error log for more details"
3546                                                 );
3547                                         free(having_buf);
3548                                         buffer_free(group_buf);
3549                                         buffer_free(sql_buf);
3550                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3551                                         return NULL;
3552                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3553                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3554                                                                  MODULENAME, field );
3555                                         if( ctx )
3556                                                 osrfAppSessionStatus(
3557                                                         ctx->session,
3558                                                         OSRF_STATUS_INTERNALSERVERERROR,
3559                                                         "osrfMethodException",
3560                                                         ctx->request,
3561                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3562                                                 );
3563                                         buffer_free( order_buf );
3564                                         free(having_buf);
3565                                         buffer_free(group_buf);
3566                                         buffer_free(sql_buf);
3567                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3568                                         return NULL;
3569                                 }
3570
3571                                 if( jsonObjectGetKeyConst( order_spec, "transform" ) ) {
3572                                         char* transform_str = searchFieldTransform( class_alias, field_def, order_spec );
3573                                         if( ! transform_str ) {
3574                                                 if( ctx )
3575                                                         osrfAppSessionStatus(
3576                                                                 ctx->session,
3577                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3578                                                                 "osrfMethodException",
3579                                                                 ctx->request,
3580                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3581                                                         );
3582                                                 buffer_free( order_buf );
3583                                                 free(having_buf);
3584                                                 buffer_free(group_buf);
3585                                                 buffer_free(sql_buf);
3586                                                 if (defaultselhash) jsonObjectFree(defaultselhash);
3587                                                 return NULL;
3588                                         }
3589
3590                                         OSRF_BUFFER_ADD( order_buf, transform_str );
3591                                         free( transform_str );
3592                                 }
3593                                 else
3594                                         buffer_fadd( order_buf, "\"%s\".%s", class_alias, field );
3595
3596                                 const char* direction =
3597                                                 jsonObjectGetString( jsonObjectGetKeyConst( order_spec, "direction" ) );
3598                                 if( direction ) {
3599                                         if( direction[ 0 ] || 'D' == direction[ 0 ] )
3600                                                 OSRF_BUFFER_ADD( order_buf, " DESC" );
3601                                         else
3602                                                 OSRF_BUFFER_ADD( order_buf, " ASC" );
3603                                 }
3604                         }
3605                 } else if( JSON_HASH == order_hash->type ) {
3606                         // This hash is keyed on class alias.  Each class has either
3607                         // an array of field names or a hash keyed on field name.
3608                         jsonIterator* class_itr = jsonNewIterator( order_hash );
3609                         while ( (snode = jsonIteratorNext( class_itr )) ) {
3610
3611                                 ClassInfo* order_class_info = search_alias( class_itr->key );
3612                                 if( ! order_class_info ) {
3613                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid class \"%s\" referenced in ORDER BY clause",
3614                                                                  MODULENAME, class_itr->key );
3615                                         if( ctx )
3616                                                 osrfAppSessionStatus(
3617                                                         ctx->session,
3618                                                         OSRF_STATUS_INTERNALSERVERERROR,
3619                                                         "osrfMethodException",
3620                                                         ctx->request,
3621                                                         "Invalid class referenced in ORDER BY clause -- see error log for more details"
3622                                                 );
3623                                         jsonIteratorFree( class_itr );
3624                                         buffer_free( order_buf );
3625                                         free(having_buf);
3626                                         buffer_free(group_buf);
3627                                         buffer_free(sql_buf);
3628                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3629                                         return NULL;
3630                                 }
3631
3632                                 osrfHash* field_list_def = order_class_info->fields;
3633
3634                                 if ( snode->type == JSON_HASH ) {
3635
3636                                         // Hash is keyed on field names from the current class.  For each field
3637                                         // there is another layer of hash to define the sorting details, if any,
3638                                         // or a string to indicate direction of sorting.
3639                                         jsonIterator* order_itr = jsonNewIterator( snode );
3640                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
3641
3642                                                 osrfHash* field_def = osrfHashGet( field_list_def, order_itr->key );
3643                                                 if( !field_def ) {
3644                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3645                                                                         MODULENAME, order_itr->key );
3646                                                         if( ctx )
3647                                                                 osrfAppSessionStatus(
3648                                                                         ctx->session,
3649                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3650                                                                         "osrfMethodException",
3651                                                                         ctx->request,
3652                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3653                                                                 );
3654                                                         jsonIteratorFree( order_itr );
3655                                                         jsonIteratorFree( class_itr );
3656                                                         buffer_free( order_buf );
3657                                                         free(having_buf);
3658                                                         buffer_free(group_buf);
3659                                                         buffer_free(sql_buf);
3660                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3661                                                         return NULL;
3662                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3663                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3664                                                                  MODULENAME, order_itr->key );
3665                                                         if( ctx )
3666                                                                 osrfAppSessionStatus(
3667                                                                         ctx->session,
3668                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3669                                                                         "osrfMethodException",
3670                                                                         ctx->request,
3671                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3672                                                         );
3673                                                         jsonIteratorFree( order_itr );
3674                                                         jsonIteratorFree( class_itr );
3675                                                         buffer_free( order_buf );
3676                                                         free(having_buf);
3677                                                         buffer_free(group_buf);
3678                                                         buffer_free(sql_buf);
3679                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3680                                                         return NULL;
3681                                                 }
3682
3683                                                 const char* direction = NULL;
3684                                                 if ( onode->type == JSON_HASH ) {
3685                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
3686                                                                 string = searchFieldTransform(
3687                                                                         class_itr->key,
3688                                                                         osrfHashGet( field_list_def, order_itr->key ),
3689                                                                         onode
3690                                                                 );
3691                                                                 if( ! string ) {
3692                                                                         if( ctx ) osrfAppSessionStatus(
3693                                                                                 ctx->session,
3694                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
3695                                                                                 "osrfMethodException",
3696                                                                                 ctx->request,
3697                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
3698                                                                         );
3699                                                                         jsonIteratorFree( order_itr );
3700                                                                         jsonIteratorFree( class_itr );
3701                                                                         free(having_buf);
3702                                                                         buffer_free(group_buf);
3703                                                                         buffer_free(order_buf);
3704                                                                         buffer_free(sql_buf);
3705                                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3706                                                                         return NULL;
3707                                                                 }
3708                                                         } else {
3709                                                                 growing_buffer* field_buf = buffer_init(16);
3710                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
3711                                                                 string = buffer_release(field_buf);
3712                                                         }
3713
3714                                                         if ( (tmp_const = jsonObjectGetKeyConst( onode, "direction" )) ) {
3715                                                                 const char* dir = jsonObjectGetString(tmp_const);
3716                                                                 if (!strncasecmp(dir, "d", 1)) {
3717                                                                         direction = " DESC";
3718                                                                 } else {
3719                                                                         direction = " ASC";
3720                                                                 }
3721                                                         }
3722
3723                                                 } else if ( JSON_NULL == onode->type || JSON_ARRAY == onode->type ) {
3724                                                         osrfLogError( OSRF_LOG_MARK,
3725                                                                 "%s: Expected JSON_STRING in ORDER BY clause; found %s",
3726                                                                 MODULENAME, json_type( onode->type ) );
3727                                                         if( ctx )
3728                                                                 osrfAppSessionStatus(
3729                                                                         ctx->session,
3730                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3731                                                                         "osrfMethodException",
3732                                                                         ctx->request,
3733                                                                         "Malformed ORDER BY clause -- see error log for more details"
3734                                                                 );
3735                                                         jsonIteratorFree( order_itr );
3736                                                         jsonIteratorFree( class_itr );
3737                                                         free(having_buf);
3738                                                         buffer_free(group_buf);
3739                                                         buffer_free(order_buf);
3740                                                         buffer_free(sql_buf);
3741                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3742                                                         return NULL;
3743
3744                                                 } else {
3745                                                         string = strdup(order_itr->key);
3746                                                         const char* dir = jsonObjectGetString(onode);
3747                                                         if (!strncasecmp(dir, "d", 1)) {
3748                                                                 direction = " DESC";
3749                                                         } else {
3750                                                                 direction = " ASC";
3751                                                         }
3752                                                 }
3753
3754                                                 if ( order_buf )
3755                                                         OSRF_BUFFER_ADD(order_buf, ", ");
3756                                                 else
3757                                                         order_buf = buffer_init(128);
3758
3759                                                 OSRF_BUFFER_ADD(order_buf, string);
3760                                                 free(string);
3761
3762                                                 if (direction) {
3763                                                          OSRF_BUFFER_ADD(order_buf, direction);
3764                                                 }
3765
3766                                         } // end while
3767                                         jsonIteratorFree(order_itr);
3768
3769                                 } else if ( snode->type == JSON_ARRAY ) {
3770
3771                                         // Array is a list of fields from the current class
3772                                         unsigned long order_idx = 0;
3773                                         while(( onode = jsonObjectGetIndex( snode, order_idx++ ) )) {
3774
3775                                                 const char* _f = jsonObjectGetString( onode );
3776
3777                                                 osrfHash* field_def = osrfHashGet( field_list_def, _f );
3778                                                 if( !field_def ) {
3779                                                         osrfLogError(OSRF_LOG_MARK, "%s: Invalid field \"%s\" in ORDER BY clause",
3780                                                                         MODULENAME, _f );
3781                                                         if( ctx )
3782                                                                 osrfAppSessionStatus(
3783                                                                         ctx->session,
3784                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3785                                                                         "osrfMethodException",
3786                                                                         ctx->request,
3787                                                                         "Invalid field in ORDER BY clause -- see error log for more details"
3788                                                                 );
3789                                                         jsonIteratorFree( class_itr );
3790                                                         buffer_free( order_buf );
3791                                                         free(having_buf);
3792                                                         buffer_free(group_buf);
3793                                                         buffer_free(sql_buf);
3794                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3795                                                         return NULL;
3796                                                 } else if( str_is_true( osrfHashGet( field_def, "virtual" ) ) ) {
3797                                                         osrfLogError(OSRF_LOG_MARK, "%s: Virtual field \"%s\" in ORDER BY clause",
3798                                                                         MODULENAME, _f );
3799                                                         if( ctx )
3800                                                                 osrfAppSessionStatus(
3801                                                                         ctx->session,
3802                                                                         OSRF_STATUS_INTERNALSERVERERROR,
3803                                                                         "osrfMethodException",
3804                                                                         ctx->request,
3805                                                                         "Virtual field in ORDER BY clause -- see error log for more details"
3806                                                                 );
3807                                                         jsonIteratorFree( class_itr );
3808                                                         buffer_free( order_buf );
3809                                                         free(having_buf);
3810                                                         buffer_free(group_buf);
3811                                                         buffer_free(sql_buf);
3812                                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3813                                                         return NULL;
3814                                                 }
3815
3816                                                 if ( order_buf )
3817                                                         OSRF_BUFFER_ADD(order_buf, ", ");
3818                                                 else
3819                                                         order_buf = buffer_init(128);
3820
3821                                                 buffer_fadd( order_buf, "\"%s\".%s", class_itr->key, _f);
3822
3823                                         } // end while
3824
3825                                 // IT'S THE OOOOOOOOOOOLD STYLE!
3826                                 } else {
3827                                         osrfLogError(OSRF_LOG_MARK,
3828                                                         "%s: Possible SQL injection attempt; direct order by is not allowed", MODULENAME);
3829                                         if (ctx) {
3830                                                 osrfAppSessionStatus(
3831                                                         ctx->session,
3832                                                         OSRF_STATUS_INTERNALSERVERERROR,
3833                                                         "osrfMethodException",
3834                                                         ctx->request,
3835                                                         "Severe query error -- see error log for more details"
3836                                                 );
3837                                         }
3838
3839                                         free(having_buf);
3840                                         buffer_free(group_buf);
3841                                         buffer_free(order_buf);
3842                                         buffer_free(sql_buf);
3843                                         if (defaultselhash) jsonObjectFree(defaultselhash);
3844                                         jsonIteratorFree(class_itr);
3845                                         return NULL;
3846                                 }
3847                         } // end while
3848                         jsonIteratorFree( class_itr );
3849                 } else {
3850                         osrfLogError(OSRF_LOG_MARK,
3851                                 "%s: Malformed ORDER BY clause; expected JSON_HASH or JSON_ARRAY, found %s",
3852                                 MODULENAME, json_type( order_hash->type ) );
3853                         if( ctx )
3854                                 osrfAppSessionStatus(
3855                                         ctx->session,
3856                                         OSRF_STATUS_INTERNALSERVERERROR,
3857                                         "osrfMethodException",
3858                                         ctx->request,
3859                                         "Malformed ORDER BY clause -- see error log for more details"
3860                                 );
3861                         buffer_free( order_buf );
3862                         free(having_buf);
3863                         buffer_free(group_buf);
3864                         buffer_free(sql_buf);
3865                         if (defaultselhash) jsonObjectFree(defaultselhash);
3866                         return NULL;
3867                 }
3868
3869                 if( order_buf )
3870                         order_by_list = buffer_release( order_buf );
3871         }
3872
3873
3874         string = buffer_release(group_buf);
3875
3876         if ( *string && ( aggregate_found || (flags & SELECT_DISTINCT) ) ) {
3877                 OSRF_BUFFER_ADD( sql_buf, " GROUP BY " );
3878                 OSRF_BUFFER_ADD( sql_buf, string );
3879         }
3880
3881         free(string);
3882
3883         if( having_buf && *having_buf ) {
3884                 OSRF_BUFFER_ADD( sql_buf, " HAVING " );
3885                 OSRF_BUFFER_ADD( sql_buf, having_buf );
3886                 free( having_buf );
3887         }
3888
3889         if( order_by_list ) {
3890
3891                 if ( *order_by_list ) {
3892                         OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
3893                         OSRF_BUFFER_ADD( sql_buf, order_by_list );
3894                 }
3895
3896                 free( order_by_list );
3897         }
3898
3899         if ( limit ){
3900                 const char* str = jsonObjectGetString(limit);
3901                 buffer_fadd( sql_buf, " LIMIT %d", atoi(str) );
3902         }
3903
3904         if (offset) {
3905                 const char* str = jsonObjectGetString(offset);
3906                 buffer_fadd( sql_buf, " OFFSET %d", atoi(str) );
3907         }
3908
3909         if (!(flags & SUBSELECT)) OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
3910
3911         if (defaultselhash) jsonObjectFree(defaultselhash);
3912
3913         return buffer_release(sql_buf);
3914
3915 } // end of SELECT()
3916
3917 static char* buildSELECT ( jsonObject* search_hash, jsonObject* order_hash, osrfHash* meta, osrfMethodContext* ctx ) {
3918
3919         const char* locale = osrf_message_get_last_locale();
3920
3921         osrfHash* fields = osrfHashGet(meta, "fields");
3922         char* core_class = osrfHashGet(meta, "classname");
3923
3924         const jsonObject* join_hash = jsonObjectGetKeyConst( order_hash, "join" );
3925
3926         jsonObject* node = NULL;
3927         jsonObject* snode = NULL;
3928         jsonObject* onode = NULL;
3929         const jsonObject* _tmp = NULL;
3930         jsonObject* selhash = NULL;
3931         jsonObject* defaultselhash = NULL;
3932
3933         growing_buffer* sql_buf = buffer_init(128);
3934         growing_buffer* select_buf = buffer_init(128);
3935
3936         if ( !(selhash = jsonObjectGetKey( order_hash, "select" )) ) {
3937                 defaultselhash = jsonNewObjectType(JSON_HASH);
3938                 selhash = defaultselhash;
3939         }
3940
3941         if ( !jsonObjectGetKeyConst(selhash,core_class) ) {
3942                 jsonObjectSetKey( selhash, core_class, jsonNewObjectType(JSON_ARRAY) );
3943                 jsonObject* flist = jsonObjectGetKey( selhash, core_class );
3944
3945                 int i = 0;
3946                 char* field;
3947
3948                 osrfStringArray* keys = osrfHashKeys( fields );
3949                 while ( (field = osrfStringArrayGetString(keys, i++)) ) {
3950                         if( ! str_is_true( osrfHashGet( osrfHashGet( fields, field ), "virtual" ) ) )
3951                                 jsonObjectPush( flist, jsonNewObject( field ) );
3952                 }
3953                 osrfStringArrayFree(keys);
3954         }
3955
3956         int first = 1;
3957         jsonIterator* class_itr = jsonNewIterator( selhash );
3958         while ( (snode = jsonIteratorNext( class_itr )) ) {
3959
3960                 char* cname = class_itr->key;
3961                 osrfHash* idlClass = osrfHashGet( oilsIDL(), cname );
3962                 if (!idlClass) continue;
3963
3964                 if (strcmp(core_class,class_itr->key)) {
3965                         if (!join_hash) continue;
3966
3967                         jsonObject* found =  jsonObjectFindPath(join_hash, "//%s", class_itr->key);
3968                         if (!found->size) {
3969                                 jsonObjectFree(found);
3970                                 continue;
3971                         }
3972
3973                         jsonObjectFree(found);
3974                 }
3975
3976                 jsonIterator* select_itr = jsonNewIterator( snode );
3977                 while ( (node = jsonIteratorNext( select_itr )) ) {
3978                         const char* item_str = jsonObjectGetString( node );
3979                         osrfHash* field = osrfHashGet( osrfHashGet( idlClass, "fields" ), item_str );
3980                         char* fname = osrfHashGet(field, "name");
3981
3982                         if (!field) continue;
3983
3984                         if (first) {
3985                                 first = 0;
3986                         } else {
3987                                 OSRF_BUFFER_ADD_CHAR(select_buf, ',');
3988                         }
3989
3990             if (locale) {
3991                         const char* i18n;
3992                                 const jsonObject* no_i18n_obj = jsonObjectGetKey( order_hash, "no_i18n" );
3993                                 if ( obj_is_true( no_i18n_obj ) )    // Suppress internationalization?
3994                                         i18n = NULL;
3995                                 else
3996                                         i18n = osrfHashGet(field, "i18n");
3997
3998                                 if( str_is_true( i18n ) ) {
3999                         char* pkey = osrfHashGet(idlClass, "primarykey");
4000                         char* tname = osrfHashGet(idlClass, "tablename");
4001
4002                     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);
4003                 } else {
4004                                 buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
4005                 }
4006             } else {
4007                             buffer_fadd(select_buf, " \"%s\".%s", cname, fname);
4008             }
4009                 }
4010
4011         jsonIteratorFree(select_itr);
4012         }
4013
4014     jsonIteratorFree(class_itr);
4015
4016         char* col_list = buffer_release(select_buf);
4017         char* table = getSourceDefinition(meta);
4018         if( !table )
4019                 table = strdup( "(null)" );
4020
4021         buffer_fadd(sql_buf, "SELECT %s FROM %s AS \"%s\"", col_list, table, core_class );
4022         free(col_list);
4023         free(table);
4024
4025         // Clear the query stack (as a fail-safe precaution against possible
4026         // leftover garbage); then push the first query frame onto the stack.
4027         clear_query_stack();
4028         push_query_frame();
4029         if( add_query_core( NULL, core_class ) ) {
4030                 if( ctx )
4031                         osrfAppSessionStatus(
4032                                 ctx->session,
4033                                 OSRF_STATUS_INTERNALSERVERERROR,
4034                                 "osrfMethodException",
4035                                 ctx->request,
4036                                 "Unable to build query frame for core class"
4037                         );
4038                 return NULL;
4039         }
4040
4041         if ( join_hash ) {
4042                 char* join_clause = searchJOIN( join_hash, &curr_query->core );
4043                 OSRF_BUFFER_ADD_CHAR(sql_buf, ' ');
4044                 OSRF_BUFFER_ADD(sql_buf, join_clause);
4045                 free(join_clause);
4046         }
4047
4048         osrfLogDebug(OSRF_LOG_MARK, "%s pre-predicate SQL =  %s",
4049                                  MODULENAME, OSRF_BUFFER_C_STR(sql_buf));
4050
4051         OSRF_BUFFER_ADD(sql_buf, " WHERE ");
4052
4053         char* pred = searchWHERE( search_hash, &curr_query->core, AND_OP_JOIN, ctx );
4054         if (!pred) {
4055                 osrfAppSessionStatus(
4056                         ctx->session,
4057                         OSRF_STATUS_INTERNALSERVERERROR,
4058                                 "osrfMethodException",
4059                                 ctx->request,
4060                                 "Severe query error -- see error log for more details"
4061                         );
4062                 buffer_free(sql_buf);
4063                 if(defaultselhash) jsonObjectFree(defaultselhash);
4064                 clear_query_stack();
4065                 return NULL;
4066         } else {
4067                 buffer_add(sql_buf, pred);
4068                 free(pred);
4069         }
4070
4071         if (order_hash) {
4072                 char* string = NULL;
4073                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "order_by" )) ){
4074
4075                         growing_buffer* order_buf = buffer_init(128);
4076
4077                         first = 1;
4078                         jsonIterator* class_itr = jsonNewIterator( _tmp );
4079                         while ( (snode = jsonIteratorNext( class_itr )) ) {
4080
4081                                 if (!jsonObjectGetKeyConst(selhash,class_itr->key))
4082                                         continue;
4083
4084                                 if ( snode->type == JSON_HASH ) {
4085
4086                                         jsonIterator* order_itr = jsonNewIterator( snode );
4087                                         while ( (onode = jsonIteratorNext( order_itr )) ) {
4088
4089                                                 osrfHash* field_def = oilsIDLFindPath( "/%s/fields/%s",
4090                                                                 class_itr->key, order_itr->key );
4091                                                 if ( !field_def )
4092                                                         continue;
4093
4094                                                 char* direction = NULL;
4095                                                 if ( onode->type == JSON_HASH ) {
4096                                                         if ( jsonObjectGetKeyConst( onode, "transform" ) ) {
4097                                                                 string = searchFieldTransform( class_itr->key, field_def, onode );
4098                                                                 if( ! string ) {
4099                                                                         osrfAppSessionStatus(
4100                                                                                 ctx->session,
4101                                                                                 OSRF_STATUS_INTERNALSERVERERROR,
4102                                                                                 "osrfMethodException",
4103                                                                                 ctx->request,
4104                                                                                 "Severe query error in ORDER BY clause -- see error log for more details"
4105                                                                         );
4106                                                                         jsonIteratorFree( order_itr );
4107                                                                         jsonIteratorFree( class_itr );
4108                                                                         buffer_free( order_buf );
4109                                                                         buffer_free( sql_buf );
4110                                                                         if( defaultselhash ) jsonObjectFree( defaultselhash );
4111                                                                         clear_query_stack();
4112                                                                         return NULL;
4113                                                                 }
4114                                                         } else {
4115                                                                 growing_buffer* field_buf = buffer_init(16);
4116                                                                 buffer_fadd(field_buf, "\"%s\".%s", class_itr->key, order_itr->key);
4117                                                                 string = buffer_release(field_buf);
4118                                                         }
4119
4120                                                         if ( (_tmp = jsonObjectGetKeyConst( onode, "direction" )) ) {
4121                                                                 const char* dir = jsonObjectGetString(_tmp);
4122                                                                 if (!strncasecmp(dir, "d", 1)) {
4123                                                                         direction = " DESC";
4124                                                                 } else {
4125                                                                         free(direction);
4126                                                                 }
4127                                                         }
4128
4129                                                 } else {
4130                                                         string = strdup(order_itr->key);
4131                                                         const char* dir = jsonObjectGetString(onode);
4132                                                         if (!strncasecmp(dir, "d", 1)) {
4133                                                                 direction = " DESC";
4134                                                         } else {
4135                                                                 direction = " ASC";
4136                                                         }
4137                                                 }
4138
4139                                                 if (first) {
4140                                                         first = 0;
4141                                                 } else {
4142                                                         buffer_add(order_buf, ", ");
4143                                                 }
4144
4145                                                 buffer_add(order_buf, string);
4146                                                 free(string);
4147
4148                                                 if (direction) {
4149                                                         buffer_add(order_buf, direction);
4150                                                 }
4151
4152                                         }
4153
4154                     jsonIteratorFree(order_itr);
4155
4156                                 } else {
4157                                         const char* str = jsonObjectGetString(snode);
4158                                         buffer_add(order_buf, str);
4159                                         break;
4160                                 }
4161
4162                         }
4163
4164                         jsonIteratorFree(class_itr);
4165
4166                         string = buffer_release(order_buf);
4167
4168                         if ( *string ) {
4169                                 OSRF_BUFFER_ADD( sql_buf, " ORDER BY " );
4170                                 OSRF_BUFFER_ADD( sql_buf, string );
4171                         }
4172
4173                         free(string);
4174                 }
4175
4176                 if ( (_tmp = jsonObjectGetKeyConst( order_hash, "limit" )) ){
4177                         const char* str = jsonObjectGetString(_tmp);
4178                         buffer_fadd(
4179                                 sql_buf,
4180                                 " LIMIT %d",
4181                                 atoi(str)
4182                         );
4183                 }
4184
4185                 _tmp = jsonObjectGetKeyConst( order_hash, "offset" );
4186                 if (_tmp) {
4187                         const char* str = jsonObjectGetString(_tmp);
4188                         buffer_fadd(
4189                                 sql_buf,
4190                                 " OFFSET %d",
4191                                 atoi(str)
4192                         );
4193                 }
4194         }
4195
4196         if (defaultselhash) jsonObjectFree(defaultselhash);
4197         clear_query_stack();
4198
4199         OSRF_BUFFER_ADD_CHAR(sql_buf, ';');
4200         return buffer_release(sql_buf);
4201 }
4202
4203 int doJSONSearch ( osrfMethodContext* ctx ) {
4204         if(osrfMethodVerifyContext( ctx )) {
4205                 osrfLogError( OSRF_LOG_MARK,  "Invalid method context" );
4206                 return -1;
4207         }
4208
4209         osrfLogDebug(OSRF_LOG_MARK, "Received query request");
4210
4211         int err = 0;
4212
4213         // XXX for now...
4214         dbhandle = writehandle;
4215
4216         jsonObject* hash = jsonObjectGetIndex(ctx->params, 0);
4217
4218         int flags = 0;
4219
4220         if ( obj_is_true( jsonObjectGetKey( hash, "distinct" ) ) )
4221                 flags |= SELECT_DISTINCT;
4222
4223         if ( obj_is_true( jsonObjectGetKey( hash, "no_i18n" ) ) )
4224                 flags |= DISABLE_I18N;
4225
4226         osrfLogDebug(OSRF_LOG_MARK, "Building SQL ...");
4227         char* sql = SELECT(
4228                         ctx,
4229                         jsonObjectGetKey( hash, "select" ),
4230                         jsonObjectGetKey( hash, "from" ),
4231                         jsonObjectGetKey( hash, "where" ),
4232                         jsonObjectGetKey( hash, "having" ),
4233                         jsonObjectGetKey( hash, "order_by" ),
4234                         jsonObjectGetKey( hash, "limit" ),
4235                         jsonObjectGetKey( hash, "offset" ),
4236                         flags
4237         );
4238         clear_query_stack();
4239
4240         if (!sql) {
4241                 err = -1;
4242                 return err;
4243         }
4244
4245         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4246         dbi_result result = dbi_conn_query(dbhandle, sql);
4247
4248         if(result) {
4249                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4250
4251                 if (dbi_result_first_row(result)) {
4252                         /* JSONify the result */
4253                         osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4254
4255                         do {
4256                                 jsonObject* return_val = oilsMakeJSONFromResult( result );
4257                                 osrfAppRespond( ctx, return_val );
4258                 jsonObjectFree( return_val );
4259                         } while (dbi_result_next_row(result));
4260
4261                 } else {
4262                         osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s", MODULENAME, sql);
4263                 }
4264
4265                 osrfAppRespondComplete( ctx, NULL );
4266
4267                 /* clean up the query */
4268                 dbi_result_free(result);
4269
4270         } else {
4271                 err = -1;
4272                 osrfLogError(OSRF_LOG_MARK, "%s: Error with query [%s]", MODULENAME, sql);
4273                 osrfAppSessionStatus(
4274                         ctx->session,
4275                         OSRF_STATUS_INTERNALSERVERERROR,
4276                         "osrfMethodException",
4277                         ctx->request,
4278                         "Severe query error -- see error log for more details"
4279                 );
4280         }
4281
4282         free(sql);
4283         return err;
4284 }
4285
4286 static jsonObject* doFieldmapperSearch ( osrfMethodContext* ctx, osrfHash* meta,
4287                 jsonObject* where_hash, jsonObject* query_hash, int* err ) {
4288
4289         // XXX for now...
4290         dbhandle = writehandle;
4291
4292         osrfHash* links = osrfHashGet(meta, "links");
4293         osrfHash* fields = osrfHashGet(meta, "fields");
4294         char* core_class = osrfHashGet(meta, "classname");
4295         char* pkey = osrfHashGet(meta, "primarykey");
4296
4297         const jsonObject* _tmp;
4298         jsonObject* obj;
4299
4300         char* sql = buildSELECT( where_hash, query_hash, meta, ctx );
4301         if (!sql) {
4302                 osrfLogDebug(OSRF_LOG_MARK, "Problem building query, returning NULL");
4303                 *err = -1;
4304                 return NULL;
4305         }
4306
4307         osrfLogDebug(OSRF_LOG_MARK, "%s SQL =  %s", MODULENAME, sql);
4308
4309         dbi_result result = dbi_conn_query(dbhandle, sql);
4310         if( NULL == result ) {
4311                 osrfLogError(OSRF_LOG_MARK, "%s: Error retrieving %s with query [%s]",
4312                         MODULENAME, osrfHashGet(meta, "fieldmapper"), sql);
4313                 osrfAppSessionStatus(
4314                         ctx->session,
4315                         OSRF_STATUS_INTERNALSERVERERROR,
4316                         "osrfMethodException",
4317                         ctx->request,
4318                         "Severe query error -- see error log for more details"
4319                 );
4320                 *err = -1;
4321                 free(sql);
4322                 return jsonNULL;
4323
4324         } else {
4325                 osrfLogDebug(OSRF_LOG_MARK, "Query returned with no errors");
4326         }
4327
4328         jsonObject* res_list = jsonNewObjectType(JSON_ARRAY);
4329         osrfHash* dedup = osrfNewHash();
4330
4331         if (dbi_result_first_row(result)) {
4332                 /* JSONify the result */
4333                 osrfLogDebug(OSRF_LOG_MARK, "Query returned at least one row");
4334                 do {
4335                         obj = oilsMakeFieldmapperFromResult( result, meta );
4336                         char* pkey_val = oilsFMGetString( obj, pkey );
4337                         if ( osrfHashGet( dedup, pkey_val ) ) {
4338                                 jsonObjectFree(obj);
4339                                 free(pkey_val);
4340                         } else {
4341                                 osrfHashSet( dedup, pkey_val, pkey_val );
4342                                 jsonObjectPush(res_list, obj);
4343                         }
4344                 } while (dbi_result_next_row(result));
4345         } else {
4346                 osrfLogDebug(OSRF_LOG_MARK, "%s returned no results for query %s",
4347                         MODULENAME, sql );
4348         }
4349
4350         osrfHashFree(dedup);
4351         /* clean up the query */
4352         dbi_result_free(result);
4353         free(sql);
4354
4355         if (res_list->size && query_hash) {
4356                 _tmp = jsonObjectGetKeyConst( query_hash, "flesh" );
4357                 if (_tmp) {
4358                         int x = (int)jsonObjectGetNumber(_tmp);
4359                         if (x == -1 || x > max_flesh_depth) x = max_flesh_depth;
4360
4361                         const jsonObject* temp_blob;
4362                         if ((temp_blob = jsonObjectGetKeyConst( query_hash, "flesh_fields" )) && x > 0) {
4363
4364                                 jsonObject* flesh_blob = jsonObjectClone( temp_blob );
4365                                 const jsonObject* flesh_fields = jsonObjectGetKeyConst( flesh_blob, core_class );
4366
4367                                 osrfStringArray* link_fields = NULL;
4368
4369                                 if (flesh_fields) {
4370                                         if (flesh_fields->size == 1) {
4371                                                 const char* _t = jsonObjectGetString( jsonObjectGetIndex( flesh_fields, 0 ) );
4372                                                 if (!strcmp(_t,"*")) link_fields = osrfHashKeys( links );
4373                                         }
4374
4375                                         if (!link_fields) {
4376                                                 jsonObject* _f;
4377                                                 link_fields = osrfNewStringArray(1);
4378                                                 jsonIterator* _i = jsonNewIterator( flesh_fields );
4379                                                 while ((_f = jsonIteratorNext( _i ))) {
4380                                                         osrfStringArrayAdd( link_fields, jsonObjectGetString( _f ) );
4381                                                 }
4382                         jsonIteratorFree(_i);
4383                                         }
4384                                 }
4385
4386                                 jsonObject* cur;
4387                                 unsigned long res_idx = 0;
4388                                 while ((cur = jsonObjectGetIndex( res_list, res_idx++ ) )) {
4389
4390                                         int i = 0;
4391                                         char* link_field;
4392
4393                                         while ( (link_field = osrfStringArrayGetString(link_fields, i++)) ) {
4394
4395                                                 osrfLogDebug(OSRF_LOG_MARK, "Starting to flesh %s", link_field);
4396
4397                                                 osrfHash* kid_link = osrfHashGet(links, link_field);
4398                                                 if (!kid_link) continue;
4399
4400                                                 osrfHash* field = osrfHashGet(fields, link_field);
4401                                                 if (!field) continue;
4402
4403                                                 osrfHash* value_field = field;
4404
4405                                                 osrfHash* kid_idl = osrfHashGet(oilsIDL(), osrfHashGet(kid_link, "class"));
4406                                                 if (!kid_idl) continue;
4407
4408                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4409                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4410                                                 }
4411
4412                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) { // might_have
4413                                                         value_field = osrfHashGet( fields, osrfHashGet(meta, "primarykey") );
4414                                                 }
4415
4416                                                 osrfStringArray* link_map = osrfHashGet( kid_link, "map" );
4417
4418                                                 if (link_map->size > 0) {
4419                                                         jsonObject* _kid_key = jsonNewObjectType(JSON_ARRAY);
4420                                                         jsonObjectPush(
4421                                                                 _kid_key,
4422                                                                 jsonNewObject( osrfStringArrayGetString( link_map, 0 ) )
4423                                                         );
4424
4425                                                         jsonObjectSetKey(
4426                                                                 flesh_blob,
4427                                                                 osrfHashGet(kid_link, "class"),
4428                                                                 _kid_key
4429                                                         );
4430                                                 };
4431
4432                                                 osrfLogDebug(
4433                                                         OSRF_LOG_MARK,
4434                                                         "Link field: %s, remote class: %s, fkey: %s, reltype: %s",
4435                                                         osrfHashGet(kid_link, "field"),
4436                                                         osrfHashGet(kid_link, "class"),
4437                                                         osrfHashGet(kid_link, "key"),
4438                                                         osrfHashGet(kid_link, "reltype")
4439                                                 );
4440
4441                                                 const char* search_key = jsonObjectGetString(
4442                                                         jsonObjectGetIndex(
4443                                                                 cur,
4444                                                                 atoi( osrfHashGet(value_field, "array_position") )
4445                                                         )
4446                                                 );
4447
4448                                                 if (!search_key) {
4449                                                         osrfLogDebug(OSRF_LOG_MARK, "Nothing to search for!");
4450                                                         continue;
4451                                                 }
4452
4453                                                 osrfLogDebug(OSRF_LOG_MARK, "Creating param objects...");
4454
4455                                                 // construct WHERE clause
4456                                                 jsonObject* where_clause  = jsonNewObjectType(JSON_HASH);
4457                                                 jsonObjectSetKey(
4458                                                         where_clause,
4459                                                         osrfHashGet(kid_link, "key"),
4460                                                         jsonNewObject( search_key )
4461                                                 );
4462
4463                                                 // construct the rest of the query
4464                                                 jsonObject* rest_of_query = jsonNewObjectType(JSON_HASH);
4465                                                 jsonObjectSetKey( rest_of_query, "flesh",
4466                                                         jsonNewNumberObject( (double)(x - 1 + link_map->size) )
4467                                                 );
4468
4469                                                 if (flesh_blob)
4470                                                         jsonObjectSetKey( rest_of_query, "flesh_fields", jsonObjectClone(flesh_blob) );
4471
4472                                                 if (jsonObjectGetKeyConst(query_hash, "order_by")) {
4473                                                         jsonObjectSetKey( rest_of_query, "order_by",
4474                                                                 jsonObjectClone(jsonObjectGetKeyConst(query_hash, "order_by"))
4475                                                         );
4476                                                 }
4477
4478                                                 if (jsonObjectGetKeyConst(query_hash, "select")) {
4479                                                         jsonObjectSetKey( rest_of_query, "select",
4480                                                                 jsonObjectClone(jsonObjectGetKeyConst(query_hash, "select"))
4481                                                         );
4482                                                 }
4483
4484                                                 jsonObject* kids = doFieldmapperSearch( ctx, kid_idl,
4485                                                         where_clause, rest_of_query, err);
4486
4487                                                 jsonObjectFree( where_clause );
4488                                                 jsonObjectFree( rest_of_query );
4489
4490                                                 if(*err) {
4491                                                         osrfStringArrayFree(link_fields);
4492                                                         jsonObjectFree(res_list);
4493                                                         jsonObjectFree(flesh_blob);
4494                                                         return jsonNULL;
4495                                                 }
4496
4497                                                 osrfLogDebug(OSRF_LOG_MARK, "Search for %s return %d linked objects", osrfHashGet(kid_link, "class"), kids->size);
4498
4499                                                 jsonObject* X = NULL;
4500                                                 if ( link_map->size > 0 && kids->size > 0 ) {
4501                                                         X = kids;
4502                                                         kids = jsonNewObjectType(JSON_ARRAY);
4503
4504                                                         jsonObject* _k_node;
4505                                                         unsigned long res_idx = 0;
4506                                                         while ((_k_node = jsonObjectGetIndex( X, res_idx++ ) )) {
4507                                                                 jsonObjectPush(
4508                                                                         kids,
4509                                                                         jsonObjectClone(
4510                                                                                 jsonObjectGetIndex(
4511                                                                                         _k_node,
4512                                                                                         (unsigned long)atoi(
4513                                                                                                 osrfHashGet(
4514                                                                                                         osrfHashGet(
4515                                                                                                                 osrfHashGet(
4516                                                                                                                         osrfHashGet(
4517                                                                                                                                 oilsIDL(),
4518                                                                                                                                 osrfHashGet(kid_link, "class")
4519                                                                                                                         ),
4520                                                                                                                         "fields"
4521                                                                                                                 ),
4522                                                                                                                 osrfStringArrayGetString( link_map, 0 )
4523                                                                                                         ),
4524                                                                                                         "array_position"
4525                                                                                                 )
4526                                                                                         )
4527                                                                                 )
4528                                                                         )
4529                                                                 );
4530                                                         } // end while loop traversing X
4531                                                 }
4532
4533                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_a" )) || !(strcmp( osrfHashGet(kid_link, "reltype"), "might_have" ))) {
4534                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4535                                                         jsonObjectSetIndex(
4536                                                                 cur,
4537                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4538                                                                 jsonObjectClone( jsonObjectGetIndex(kids, 0) )
4539                                                         );
4540                                                 }
4541
4542                                                 if (!(strcmp( osrfHashGet(kid_link, "reltype"), "has_many" ))) { // has_many
4543                                                         osrfLogDebug(OSRF_LOG_MARK, "Storing fleshed objects in %s", osrfHashGet(kid_link, "field"));
4544                                                         jsonObjectSetIndex(
4545                                                                 cur,
4546                                                                 (unsigned long)atoi( osrfHashGet( field, "array_position" ) ),
4547                                                                 jsonObjectClone( kids )
4548                                                         );
4549                                                 }
4550
4551                                                 if (X) {
4552                                                         jsonObjectFree(kids);
4553                                                         kids = X;
4554                                                 }
4555
4556                                                 jsonObjectFree( kids );
4557
4558                                                 osrfLogDebug(OSRF_LOG_MARK, "Fleshing of %s complete", osrfHashGet(kid_link, "field"));
4559                                                 osrfLogDebug(OSRF_LOG_MARK, "%s", jsonObjectToJSON(cur));
4560
4561                                         }
4562                                 } // end while loop traversing res_list
4563                                 jsonObjectFree( flesh_blob );
4564                                 osrfStringArrayFree(link_fields);
4565                         }
4566                 }
4567         }
4568
4569         return res_list;
4570 }
4571
4572
4573 static jsonObject* doUpdate(osrfMethodContext* ctx, int* err ) {
4574
4575         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4576 #ifdef PCRUD
4577         jsonObject* target = jsonObjectGetIndex( ctx->params, 1 );
4578 #else
4579         jsonObject* target = jsonObjectGetIndex( ctx->params, 0 );
4580 #endif
4581
4582         if (!verifyObjectClass(ctx, target)) {
4583                 *err = -1;
4584                 return jsonNULL;
4585         }
4586
4587         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4588                 osrfAppSessionStatus(
4589                         ctx->session,
4590                         OSRF_STATUS_BADREQUEST,
4591                         "osrfMethodException",
4592                         ctx->request,
4593                         "No active transaction -- required for UPDATE"
4594                 );
4595                 *err = -1;
4596                 return jsonNULL;
4597         }
4598
4599         // The following test is harmless but redundant.  If a class is
4600         // readonly, we don't register an update method for it.
4601         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4602                 osrfAppSessionStatus(
4603                         ctx->session,
4604                         OSRF_STATUS_BADREQUEST,
4605                         "osrfMethodException",
4606                         ctx->request,
4607                         "Cannot UPDATE readonly class"
4608                 );
4609                 *err = -1;
4610                 return jsonNULL;
4611         }
4612
4613         dbhandle = writehandle;
4614
4615         char* trans_id = osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" );
4616
4617         // Set the last_xact_id
4618         int index = oilsIDL_ntop( target->classname, "last_xact_id" );
4619         if (index > -1) {
4620                 osrfLogDebug(OSRF_LOG_MARK, "Setting last_xact_id to %s on %s at position %d", trans_id, target->classname, index);
4621                 jsonObjectSetIndex(target, index, jsonNewObject(trans_id));
4622         }
4623
4624         char* pkey = osrfHashGet(meta, "primarykey");
4625         osrfHash* fields = osrfHashGet(meta, "fields");
4626
4627         char* id = oilsFMGetString( target, pkey );
4628
4629         osrfLogDebug(
4630                 OSRF_LOG_MARK,
4631                 "%s updating %s object with %s = %s",
4632                 MODULENAME,
4633                 osrfHashGet(meta, "fieldmapper"),
4634                 pkey,
4635                 id
4636         );
4637
4638         growing_buffer* sql = buffer_init(128);
4639         buffer_fadd(sql,"UPDATE %s SET", osrfHashGet(meta, "tablename"));
4640
4641         int i = 0;
4642         int first = 1;
4643         char* field_name;
4644         osrfStringArray* field_list = osrfHashKeys( fields );
4645         while ( (field_name = osrfStringArrayGetString(field_list, i++)) ) {
4646
4647                 osrfHash* field = osrfHashGet( fields, field_name );
4648
4649                 if(!( strcmp( field_name, pkey ) )) continue;
4650                 if( str_is_true( osrfHashGet(osrfHashGet(fields,field_name), "virtual") ) )
4651                         continue;
4652
4653                 const jsonObject* field_object = oilsFMGetObject( target, field_name );
4654
4655                 int value_is_numeric = 0;    // boolean
4656                 char* value;
4657                 if (field_object && field_object->classname) {
4658                         value = oilsFMGetString(
4659                                 field_object,
4660                                 (char*)oilsIDLFindPath("/%s/primarykey", field_object->classname)
4661             );
4662                 } else {
4663                         value = jsonObjectToSimpleString( field_object );
4664                         if( field_object && JSON_NUMBER == field_object->type )
4665                                 value_is_numeric = 1;
4666                 }
4667
4668                 osrfLogDebug( OSRF_LOG_MARK, "Updating %s object with %s = %s", osrfHashGet(meta, "fieldmapper"), field_name, value);
4669
4670                 if (!field_object || field_object->type == JSON_NULL) {
4671                         if ( !(!( strcmp( osrfHashGet(meta, "classname"), "au" ) ) && !( strcmp( field_name, "passwd" ) )) ) { // arg at the special case!
4672                                 if (first) first = 0;
4673                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4674                                 buffer_fadd( sql, " %s = NULL", field_name );
4675                         }
4676
4677                 } else if ( value_is_numeric || !strcmp( get_primitive( field ), "number") ) {
4678                         if (first) first = 0;
4679                         else OSRF_BUFFER_ADD_CHAR(sql, ',');
4680
4681                         const char* numtype = get_datatype( field );
4682                         if ( !strncmp( numtype, "INT", 3 ) ) {
4683                                 buffer_fadd( sql, " %s = %ld", field_name, atol(value) );
4684                         } else if ( !strcmp( numtype, "NUMERIC" ) ) {
4685                                 buffer_fadd( sql, " %s = %f", field_name, atof(value) );
4686                         } else {
4687                                 // Must really be intended as a string, so quote it
4688                                 if ( dbi_conn_quote_string(dbhandle, &value) ) {
4689                                         buffer_fadd( sql, " %s = %s", field_name, value );
4690                                 } else {
4691                                         osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4692                                         osrfAppSessionStatus(
4693                                                 ctx->session,
4694                                                 OSRF_STATUS_INTERNALSERVERERROR,
4695                                                 "osrfMethodException",
4696                                                 ctx->request,
4697                                                 "Error quoting string -- please see the error log for more details"
4698                                         );
4699                                         free(value);
4700                                         free(id);
4701                                         buffer_free(sql);
4702                                         *err = -1;
4703                                         return jsonNULL;
4704                                 }
4705                         }
4706
4707                         osrfLogDebug( OSRF_LOG_MARK, "%s is of type %s", field_name, numtype );
4708
4709                 } else {
4710                         if ( dbi_conn_quote_string(dbhandle, &value) ) {
4711                                 if (first) first = 0;
4712                                 else OSRF_BUFFER_ADD_CHAR(sql, ',');
4713                                 buffer_fadd( sql, " %s = %s", field_name, value );
4714
4715                         } else {
4716                                 osrfLogError(OSRF_LOG_MARK, "%s: Error quoting string [%s]", MODULENAME, value);
4717                                 osrfAppSessionStatus(
4718                                         ctx->session,
4719                                         OSRF_STATUS_INTERNALSERVERERROR,
4720                                         "osrfMethodException",
4721                                         ctx->request,
4722                                         "Error quoting string -- please see the error log for more details"
4723                                 );
4724                                 free(value);
4725                                 free(id);
4726                                 buffer_free(sql);
4727                                 *err = -1;
4728                                 return jsonNULL;
4729                         }
4730                 }
4731
4732                 free(value);
4733
4734         }
4735
4736         jsonObject* obj = jsonNewObject(id);
4737
4738         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4739                 dbi_conn_quote_string(dbhandle, &id);
4740
4741         buffer_fadd( sql, " WHERE %s = %s;", pkey, id );
4742
4743         char* query = buffer_release(sql);
4744         osrfLogDebug(OSRF_LOG_MARK, "%s: Update SQL [%s]", MODULENAME, query);
4745
4746         dbi_result result = dbi_conn_query(dbhandle, query);
4747         free(query);
4748
4749         if (!result) {
4750                 jsonObjectFree(obj);
4751                 obj = jsonNewObject(NULL);
4752                 osrfLogError(
4753                         OSRF_LOG_MARK,
4754                         "%s ERROR updating %s object with %s = %s",
4755                         MODULENAME,
4756                         osrfHashGet(meta, "fieldmapper"),
4757                         pkey,
4758                         id
4759                 );
4760         }
4761
4762         free(id);
4763
4764         return obj;
4765 }
4766
4767 static jsonObject* doDelete(osrfMethodContext* ctx, int* err ) {
4768
4769         osrfHash* meta = osrfHashGet( (osrfHash*) ctx->method->userData, "class" );
4770
4771         if (!osrfHashGet( (osrfHash*)ctx->session->userData, "xact_id" )) {
4772                 osrfAppSessionStatus(
4773                         ctx->session,
4774                         OSRF_STATUS_BADREQUEST,
4775                         "osrfMethodException",
4776                         ctx->request,
4777                         "No active transaction -- required for DELETE"
4778                 );
4779                 *err = -1;
4780                 return jsonNULL;
4781         }
4782
4783         // The following test is harmless but redundant.  If a class is
4784         // readonly, we don't register a delete method for it.
4785         if( str_is_true( osrfHashGet( meta, "readonly" ) ) ) {
4786                 osrfAppSessionStatus(
4787                         ctx->session,
4788                         OSRF_STATUS_BADREQUEST,
4789                         "osrfMethodException",
4790                         ctx->request,
4791                         "Cannot DELETE readonly class"
4792                 );
4793                 *err = -1;
4794                 return jsonNULL;
4795         }
4796
4797         dbhandle = writehandle;
4798
4799         jsonObject* obj;
4800
4801         char* pkey = osrfHashGet(meta, "primarykey");
4802
4803         int _obj_pos = 0;
4804 #ifdef PCRUD
4805                 _obj_pos = 1;
4806 #endif
4807
4808         char* id;
4809         if (jsonObjectGetIndex(ctx->params, _obj_pos)->classname) {
4810                 if (!verifyObjectClass(ctx, jsonObjectGetIndex( ctx->params, _obj_pos ))) {
4811                         *err = -1;
4812                         return jsonNULL;
4813                 }
4814
4815                 id = oilsFMGetString( jsonObjectGetIndex(ctx->params, _obj_pos), pkey );
4816         } else {
4817 #ifdef PCRUD
4818         if (!verifyObjectPCRUD( ctx, NULL )) {
4819                         *err = -1;
4820                         return jsonNULL;
4821         }
4822 #endif
4823                 id = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, _obj_pos));
4824         }
4825
4826         osrfLogDebug(
4827                 OSRF_LOG_MARK,
4828                 "%s deleting %s object with %s = %s",
4829                 MODULENAME,
4830                 osrfHashGet(meta, "fieldmapper"),
4831                 pkey,
4832                 id
4833         );
4834
4835         obj = jsonNewObject(id);
4836
4837         if ( strcmp( get_primitive( osrfHashGet( osrfHashGet(meta, "fields"), pkey ) ), "number" ) )
4838                 dbi_conn_quote_string(writehandle, &id);
4839
4840         dbi_result result = dbi_conn_queryf(writehandle, "DELETE FROM %s WHERE %s = %s;", osrfHashGet(meta, "tablename"), pkey, id);
4841
4842         if (!result) {
4843                 jsonObjectFree(obj);
4844                 obj = jsonNewObject(NULL);
4845                 osrfLogError(
4846                         OSRF_LOG_MARK,
4847                         "%s ERROR deleting %s object with %s = %s",
4848                         MODULENAME,
4849                         osrfHashGet(meta, "fieldmapper"),
4850                         pkey,
4851                         id
4852                 );
4853         }
4854
4855         free(id);
4856
4857         return obj;
4858
4859 }
4860
4861
4862 static jsonObject* oilsMakeFieldmapperFromResult( dbi_result result, osrfHash* meta) {
4863         if(!(result && meta)) return jsonNULL;
4864
4865         jsonObject* object = jsonNewObject(NULL);
4866         jsonObjectSetClass(object, osrfHashGet(meta, "classname"));
4867
4868         osrfHash* fields = osrfHashGet(meta, "fields");
4869
4870         osrfLogInternal(OSRF_LOG_MARK, "Setting object class to %s ", object->classname);
4871
4872         osrfHash* _f;
4873         time_t _tmp_dt;
4874         char dt_string[256];
4875         struct tm gmdt;
4876
4877         int fmIndex;
4878         int columnIndex = 1;
4879         int attr;
4880         unsigned short type;
4881         const char* columnName;
4882
4883         /* cycle through the column list */
4884         while( (columnName = dbi_result_get_field_name(result, columnIndex)) ) {
4885
4886                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4887
4888                 fmIndex = -1; // reset the position
4889
4890                 /* determine the field type and storage attributes */
4891                 type = dbi_result_get_field_type_idx(result, columnIndex);
4892                 attr = dbi_result_get_field_attribs_idx(result, columnIndex);
4893
4894                 /* fetch the fieldmapper index */
4895                 if( (_f = osrfHashGet(fields, (char*)columnName)) ) {
4896
4897                         if ( str_is_true( osrfHashGet(_f, "virtual") ) )
4898                                 continue;
4899
4900                         const char* pos = (char*)osrfHashGet(_f, "array_position");
4901                         if ( !pos ) continue;
4902
4903                         fmIndex = atoi( pos );
4904                         osrfLogInternal(OSRF_LOG_MARK, "... Found column at position [%s]...", pos);
4905                 } else {
4906                         continue;
4907                 }
4908
4909                 if (dbi_result_field_is_null_idx(result, columnIndex)) {
4910                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(NULL) );
4911                 } else {
4912
4913                         switch( type ) {
4914
4915                                 case DBI_TYPE_INTEGER :
4916
4917                                         if( attr & DBI_INTEGER_SIZE8 )
4918                                                 jsonObjectSetIndex( object, fmIndex,
4919                                                         jsonNewNumberObject(dbi_result_get_longlong_idx(result, columnIndex)));
4920                                         else
4921                                                 jsonObjectSetIndex( object, fmIndex,
4922                                                         jsonNewNumberObject(dbi_result_get_int_idx(result, columnIndex)));
4923
4924                                         break;
4925
4926                                 case DBI_TYPE_DECIMAL :
4927                                         jsonObjectSetIndex( object, fmIndex,
4928                                                         jsonNewNumberObject(dbi_result_get_double_idx(result, columnIndex)));
4929                                         break;
4930
4931                                 case DBI_TYPE_STRING :
4932
4933
4934                                         jsonObjectSetIndex(
4935                                                 object,
4936                                                 fmIndex,
4937                                                 jsonNewObject( dbi_result_get_string_idx(result, columnIndex) )
4938                                         );
4939
4940                                         break;
4941
4942                                 case DBI_TYPE_DATETIME :
4943
4944                                         memset(dt_string, '\0', sizeof(dt_string));
4945                                         memset(&gmdt, '\0', sizeof(gmdt));
4946
4947                                         _tmp_dt = dbi_result_get_datetime_idx(result, columnIndex);
4948
4949
4950                                         if (!(attr & DBI_DATETIME_DATE)) {
4951                                                 gmtime_r( &_tmp_dt, &gmdt );
4952                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
4953                                         } else if (!(attr & DBI_DATETIME_TIME)) {
4954                                                 localtime_r( &_tmp_dt, &gmdt );
4955                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
4956                                         } else {
4957                                                 localtime_r( &_tmp_dt, &gmdt );
4958                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
4959                                         }
4960
4961                                         jsonObjectSetIndex( object, fmIndex, jsonNewObject(dt_string) );
4962
4963                                         break;
4964
4965                                 case DBI_TYPE_BINARY :
4966                                         osrfLogError( OSRF_LOG_MARK,
4967                                                 "Can't do binary at column %s : index %d", columnName, columnIndex);
4968                         }
4969                 }
4970                 ++columnIndex;
4971         }
4972
4973         return object;
4974 }
4975
4976 static jsonObject* oilsMakeJSONFromResult( dbi_result result ) {
4977         if(!result) return jsonNULL;
4978
4979         jsonObject* object = jsonNewObject(NULL);
4980
4981         time_t _tmp_dt;
4982         char dt_string[256];
4983         struct tm gmdt;
4984
4985         int fmIndex;
4986         int columnIndex = 1;
4987         int attr;
4988         unsigned short type;
4989         const char* columnName;
4990
4991         /* cycle through the column list */
4992         while( (columnName = dbi_result_get_field_name(result, columnIndex)) ) {
4993
4994                 osrfLogInternal(OSRF_LOG_MARK, "Looking for column named [%s]...", (char*)columnName);
4995
4996                 fmIndex = -1; // reset the position
4997
4998                 /* determine the field type and storage attributes */
4999                 type = dbi_result_get_field_type_idx(result, columnIndex);
5000                 attr = dbi_result_get_field_attribs_idx(result, columnIndex);
5001
5002                 if (dbi_result_field_is_null_idx(result, columnIndex)) {
5003                         jsonObjectSetKey( object, columnName, jsonNewObject(NULL) );
5004                 } else {
5005
5006                         switch( type ) {
5007
5008                                 case DBI_TYPE_INTEGER :
5009
5010                                         if( attr & DBI_INTEGER_SIZE8 )
5011                                                 jsonObjectSetKey( object, columnName,
5012                                                                 jsonNewNumberObject(dbi_result_get_longlong_idx(result, columnIndex)) );
5013                                         else
5014                                                 jsonObjectSetKey( object, columnName,
5015                                                                 jsonNewNumberObject(dbi_result_get_int_idx(result, columnIndex)) );
5016                                         break;
5017
5018                                 case DBI_TYPE_DECIMAL :
5019                                         jsonObjectSetKey( object, columnName,
5020                                                         jsonNewNumberObject(dbi_result_get_double_idx(result, columnIndex)) );
5021                                         break;
5022
5023                                 case DBI_TYPE_STRING :
5024                                         jsonObjectSetKey( object, columnName,
5025                                                         jsonNewObject(dbi_result_get_string_idx(result, columnIndex)) );
5026                                         break;
5027
5028                                 case DBI_TYPE_DATETIME :
5029
5030                                         memset(dt_string, '\0', sizeof(dt_string));
5031                                         memset(&gmdt, '\0', sizeof(gmdt));
5032
5033                                         _tmp_dt = dbi_result_get_datetime_idx(result, columnIndex);
5034
5035
5036                                         if (!(attr & DBI_DATETIME_DATE)) {
5037                                                 gmtime_r( &_tmp_dt, &gmdt );
5038                                                 strftime(dt_string, sizeof(dt_string), "%T", &gmdt);
5039                                         } else if (!(attr & DBI_DATETIME_TIME)) {
5040                                                 localtime_r( &_tmp_dt, &gmdt );
5041                                                 strftime(dt_string, sizeof(dt_string), "%F", &gmdt);
5042                                         } else {
5043                                                 localtime_r( &_tmp_dt, &gmdt );
5044                                                 strftime(dt_string, sizeof(dt_string), "%FT%T%z", &gmdt);
5045                                         }
5046
5047                                         jsonObjectSetKey( object, columnName, jsonNewObject(dt_string) );
5048                                         break;
5049
5050                                 case DBI_TYPE_BINARY :
5051                                         osrfLogError( OSRF_LOG_MARK,
5052                                                 "Can't do binary at column %s : index %d", columnName, columnIndex );
5053                         }
5054                 }
5055                 ++columnIndex;
5056         } // end while loop traversing result
5057
5058         return object;
5059 }
5060
5061 // Interpret a string as true or false
5062 static int str_is_true( const char* str ) {
5063         if( NULL == str || strcasecmp( str, "true" ) )
5064                 return 0;
5065         else
5066                 return 1;
5067 }
5068
5069 // Interpret a jsonObject as true or false
5070 static int obj_is_true( const jsonObject* obj ) {
5071         if( !obj )
5072                 return 0;
5073         else switch( obj->type )
5074         {
5075                 case JSON_BOOL :
5076                         if( obj->value.b )
5077                                 return 1;
5078                         else
5079                                 return 0;
5080                 case JSON_STRING :
5081                         if( strcasecmp( obj->value.s, "true" ) )
5082                                 return 0;
5083                         else
5084                                 return 1;
5085                 case JSON_NUMBER :          // Support 1/0 for perl's sake
5086                         if( jsonObjectGetNumber( obj ) == 1.0 )
5087                                 return 1;
5088                         else
5089                                 return 0;
5090                 default :
5091                         return 0;
5092         }
5093 }
5094
5095 // Translate a numeric code into a text string identifying a type of
5096 // jsonObject.  To be used for building error messages.
5097 static const char* json_type( int code ) {
5098         switch ( code )
5099         {
5100                 case 0 :
5101                         return "JSON_HASH";
5102                 case 1 :
5103                         return "JSON_ARRAY";
5104                 case 2 :
5105                         return "JSON_STRING";
5106                 case 3 :
5107                         return "JSON_NUMBER";
5108                 case 4 :
5109                         return "JSON_NULL";
5110                 case 5 :
5111                         return "JSON_BOOL";
5112                 default :
5113                         return "(unrecognized)";
5114         }
5115 }
5116
5117 // Extract the "primitive" attribute from an IDL field definition.
5118 // If we haven't initialized the app, then we must be running in
5119 // some kind of testbed.  In that case, default to "string".
5120 static const char* get_primitive( osrfHash* field ) {
5121         const char* s = osrfHashGet( field, "primitive" );
5122         if( !s ) {
5123                 if( child_initialized )
5124                         osrfLogError(
5125                                 OSRF_LOG_MARK,
5126                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5127                                 MODULENAME,
5128                                 osrfHashGet( field, "name" )
5129                         );
5130                 else
5131                         s = "string";
5132         }
5133         return s;
5134 }
5135
5136 // Extract the "datatype" attribute from an IDL field definition.
5137 // If we haven't initialized the app, then we must be running in
5138 // some kind of testbed.  In that case, default to to NUMERIC,
5139 // since we look at the datatype only for numbers.
5140 static const char* get_datatype( osrfHash* field ) {
5141         const char* s = osrfHashGet( field, "datatype" );
5142         if( !s ) {
5143                 if( child_initialized )
5144                         osrfLogError(
5145                                 OSRF_LOG_MARK,
5146                                 "%s ERROR No \"datatype\" attribute for field \"%s\"",
5147                                 MODULENAME,
5148                                 osrfHashGet( field, "name" )
5149                         );
5150                 else
5151                         s = "NUMERIC";
5152         }
5153         return s;
5154 }
5155
5156 /*
5157 If the input string is potentially a valid SQL identifier, return 1.
5158 Otherwise return 0.
5159
5160 Purpose: to prevent certain kinds of SQL injection.  To that end we
5161 don't necessarily need to follow all the rules exactly, such as requiring
5162 that the first character not be a digit.
5163
5164 We allow leading and trailing white space.  In between, we do not allow
5165 punctuation (except for underscores and dollar signs), control
5166 characters, or embedded white space.
5167
5168 More pedantically we should allow quoted identifiers containing arbitrary
5169 characters, but for the foreseeable future such quoted identifiers are not
5170 likely to be an issue.
5171 */
5172 static int is_identifier( const char* s) {
5173         if( !s )
5174                 return 0;
5175
5176         // Skip leading white space
5177         while( isspace( (unsigned char) *s ) )
5178                 ++s;
5179
5180         if( !s )
5181                 return 0;   // Nothing but white space?  Not okay.
5182
5183         // Check each character until we reach white space or
5184         // end-of-string.  Letters, digits, underscores, and
5185         // dollar signs are okay. With the exception of periods
5186         // (as in schema.identifier), control characters and other
5187         // punctuation characters are not okay.  Anything else
5188         // is okay -- it could for example be part of a multibyte
5189         // UTF8 character such as a letter with diacritical marks,
5190         // and those are allowed.
5191         do {
5192                 if( isalnum( (unsigned char) *s )
5193                         || '.' == *s
5194                         || '_' == *s
5195                         || '$' == *s )
5196                         ;  // Fine; keep going
5197                 else if(   ispunct( (unsigned char) *s )
5198                                 || iscntrl( (unsigned char) *s ) )
5199                         return 0;
5200                         ++s;
5201         } while( *s && ! isspace( (unsigned char) *s ) );
5202
5203         // If we found any white space in the above loop,
5204         // the rest had better be all white space.
5205
5206         while( isspace( (unsigned char) *s ) )
5207                 ++s;
5208
5209         if( *s )
5210                 return 0;   // White space was embedded within non-white space
5211
5212         return 1;
5213 }
5214
5215 /*
5216 Determine whether to accept a character string as a comparison operator.
5217 Return 1 if it's good, or 0 if it's bad.
5218
5219 We don't validate it for real.  We just make sure that it doesn't contain
5220 any semicolons or white space (with special exceptions for a few specific
5221 operators).   The idea is to block certain kinds of SQL injection.  If it
5222 has no semicolons or white space but it's still not a valid operator, then
5223 the database will complain.
5224
5225 Another approach would be to compare the string against a short list of
5226 approved operators.  We don't do that because we want to allow custom
5227 operators like ">100*", which would be difficult or impossible to
5228 express otherwise in a JSON query.
5229 */
5230 static int is_good_operator( const char* op ) {
5231         if( !op ) return 0;   // Sanity check
5232
5233         const char* s = op;
5234         while( *s ) {
5235                 if( isspace( (unsigned char) *s ) ) {
5236                         // Special exceptions for SIMILAR TO, IS DISTINCT FROM,
5237                         // and IS NOT DISTINCT FROM.
5238                         if( !strcasecmp( op, "similar to" ) )
5239                                 return 1;
5240                         else if( !strcasecmp( op, "is distinct from" ) )
5241                                 return 1;
5242                         else if( !strcasecmp( op, "is not distinct from" ) )
5243                                 return 1;
5244                         else
5245                                 return 0;
5246                 }
5247                 else if( ';' == *s )
5248                         return 0;
5249                 ++s;
5250         }
5251         return 1;
5252 }
5253
5254 /* ----------------------------------------------------------------------------------
5255 The following machinery supports a stack of query frames for use by SELECT().
5256
5257 A query frame caches information about one level of a SELECT query.  When we enter
5258 a subquery, we push another query frame onto the stack, and pop it off when we leave.
5259
5260 The query frame stores information about the core class, and about any joined classes
5261 in the FROM clause.
5262
5263 The main purpose is to map table aliases to classes and tables, so that a query can
5264 join to the same table more than once.  A secondary goal is to reduce the number of
5265 lookups in the IDL by caching the results.
5266  ----------------------------------------------------------------------------------*/
5267
5268 #define STATIC_CLASS_INFO_COUNT 3
5269
5270 static ClassInfo static_class_info[ STATIC_CLASS_INFO_COUNT ];
5271
5272 /* ---------------------------------------------------------------------------
5273  Allocate a ClassInfo as raw memory.  Except for the in_use flag, we don't
5274  initialize it here.
5275  ---------------------------------------------------------------------------*/
5276 static ClassInfo* allocate_class_info( void ) {
5277         // In order to reduce the number of mallocs and frees, we return a static
5278         // instance of ClassInfo, if we can find one that we're not already using.
5279         // We rely on the fact that the compiler will implicitly initialize the
5280         // static instances so that in_use == 0.
5281
5282         int i;
5283         for( i = 0; i < STATIC_CLASS_INFO_COUNT; ++i ) {
5284                 if( ! static_class_info[ i ].in_use ) {
5285                         static_class_info[ i ].in_use = 1;
5286                         return static_class_info + i;
5287                 }
5288         }
5289
5290         // The static ones are all in use.  Malloc one.
5291
5292         return safe_malloc( sizeof( ClassInfo ) );
5293 }
5294
5295 /* --------------------------------------------------------------------------
5296  Free any malloc'd memory owned by a ClassInfo; return it to a pristine state
5297 ---------------------------------------------------------------------------*/
5298 static void clear_class_info( ClassInfo* info ) {
5299         // Sanity check
5300         if( ! info )
5301                 return;
5302
5303         // Free any malloc'd strings
5304
5305         if( info->alias != info->alias_store )
5306                 free( info->alias );
5307
5308         if( info->class_name != info->class_name_store )
5309                 free( info->class_name );
5310
5311         free( info->source_def );
5312
5313         info->alias = info->class_name = info->source_def = NULL;
5314         info->next = NULL;
5315 }
5316
5317 /* --------------------------------------------------------------------------
5318  Deallocate a ClassInfo and everything it owns
5319 ---------------------------------------------------------------------------*/
5320 static void free_class_info( ClassInfo* info ) {
5321         // Sanity check
5322         if( ! info )
5323                 return;
5324
5325         clear_class_info( info );
5326
5327         // If it's one of the static instances, just mark it as not in use
5328
5329         int i;
5330         for( i = 0; i < STATIC_CLASS_INFO_COUNT; ++i ) {
5331                 if( info == static_class_info + i ) {
5332                         static_class_info[ i ].in_use = 0;
5333                         return;
5334                 }
5335         }
5336
5337         // Otherwise it must have been malloc'd, so free it
5338
5339         free( info );
5340 }
5341
5342 /* --------------------------------------------------------------------------
5343  Populate an already-allocated ClassInfo.  Return 0 if successful, 1 if not.
5344 ---------------------------------------------------------------------------*/
5345 static int build_class_info( ClassInfo* info, const char* alias, const char* class ) {
5346         // Sanity checks
5347         if( ! info ){
5348                 osrfLogError( OSRF_LOG_MARK,
5349                                           "%s ERROR: No ClassInfo available to populate", MODULENAME );
5350                 info->alias = info->class_name = info->source_def = NULL;
5351                 info->class_def = info->fields = info->links = NULL;
5352                 return 1;
5353         }
5354
5355         if( ! class ) {
5356                 osrfLogError( OSRF_LOG_MARK,
5357                                           "%s ERROR: No class name provided for lookup", MODULENAME );
5358                 info->alias = info->class_name = info->source_def = NULL;
5359                 info->class_def = info->fields = info->links = NULL;
5360                 return 1;
5361         }
5362
5363         // Alias defaults to class name if not supplied
5364         if( ! alias || ! alias[ 0 ] )
5365                 alias = class;
5366
5367         // Look up class info in the IDL
5368         osrfHash* class_def = osrfHashGet( oilsIDL(), class );
5369         if( ! class_def ) {
5370                 osrfLogError( OSRF_LOG_MARK,
5371                                           "%s ERROR: Class %s not defined in IDL", MODULENAME, class );
5372                 info->alias = info->class_name = info->source_def = NULL;
5373                 info->class_def = info->fields = info->links = NULL;
5374                 return 1;
5375         } else if( str_is_true( osrfHashGet( class_def, "virtual" ) ) ) {
5376                 osrfLogError( OSRF_LOG_MARK,
5377                                           "%s ERROR: Class %s is defined as virtual", MODULENAME, class );
5378                 info->alias = info->class_name = info->source_def = NULL;
5379                 info->class_def = info->fields = info->links = NULL;
5380                 return 1;
5381         }
5382
5383         osrfHash* links = osrfHashGet( class_def, "links" );
5384         if( ! links ) {
5385                 osrfLogError( OSRF_LOG_MARK,
5386                                           "%s ERROR: No links defined in IDL for class %s", MODULENAME, class );
5387                 info->alias = info->class_name = info->source_def = NULL;
5388                 info->class_def = info->fields = info->links = NULL;
5389                 return 1;
5390         }
5391
5392         osrfHash* fields = osrfHashGet( class_def, "fields" );
5393         if( ! fields ) {
5394                 osrfLogError( OSRF_LOG_MARK,
5395                                           "%s ERROR: No fields defined in IDL for class %s", MODULENAME, class );
5396                 info->alias = info->class_name = info->source_def = NULL;
5397                 info->class_def = info->fields = info->links = NULL;
5398                 return 1;
5399         }
5400
5401         char* source_def = getSourceDefinition( class_def );
5402         if( ! source_def )
5403                 return 1;
5404
5405         // We got everything we need, so populate the ClassInfo
5406         if( strlen( alias ) > ALIAS_STORE_SIZE )
5407                 info->alias = strdup( alias );
5408         else {
5409                 strcpy( info->alias_store, alias );
5410                 info->alias = info->alias_store;
5411         }
5412
5413         if( strlen( class ) > CLASS_NAME_STORE_SIZE )
5414                 info->class_name = strdup( class );
5415         else {
5416                 strcpy( info->class_name_store, class );
5417                 info->class_name = info->class_name_store;
5418         }
5419
5420         info->source_def = source_def;
5421
5422         info->class_def = class_def;
5423         info->links     = links;
5424         info->fields    = fields;
5425
5426         return 0;
5427 }
5428
5429 #define STATIC_FRAME_COUNT 3
5430
5431 static QueryFrame static_frame[ STATIC_FRAME_COUNT ];
5432
5433 /* ---------------------------------------------------------------------------
5434  Allocate a ClassInfo as raw memory.  Except for the in_use flag, we don't
5435  initialize it here.
5436  ---------------------------------------------------------------------------*/
5437 static QueryFrame* allocate_frame( void ) {
5438         // In order to reduce the number of mallocs and frees, we return a static
5439         // instance of QueryFrame, if we can find one that we're not already using.
5440         // We rely on the fact that the compiler will implicitly initialize the
5441         // static instances so that in_use == 0.
5442
5443         int i;
5444         for( i = 0; i < STATIC_FRAME_COUNT; ++i ) {
5445                 if( ! static_frame[ i ].in_use ) {
5446                         static_frame[ i ].in_use = 1;
5447                         return static_frame + i;
5448                 }
5449         }
5450
5451         // The static ones are all in use.  Malloc one.
5452
5453         return safe_malloc( sizeof( QueryFrame ) );
5454 }
5455
5456 /* --------------------------------------------------------------------------
5457  Free a QueryFrame, and all the memory it owns.
5458 ---------------------------------------------------------------------------*/
5459 static void free_query_frame( QueryFrame* frame ) {
5460         // Sanity check
5461         if( ! frame )
5462                 return;
5463
5464         clear_class_info( &frame->core );
5465
5466         // Free the join list
5467         ClassInfo* temp;
5468         ClassInfo* info = frame->join_list;
5469         while( info ) {
5470                 temp = info->next;
5471                 free_class_info( info );
5472                 info = temp;
5473         }
5474
5475         frame->join_list = NULL;
5476         frame->next = NULL;
5477
5478         // If the frame is a static instance, just mark it as unused
5479         int i;
5480         for( i = 0; i < STATIC_FRAME_COUNT; ++i ) {
5481                 if( frame == static_frame + i ) {
5482                         static_frame[ i ].in_use = 0;
5483                         return;
5484                 }
5485         }
5486
5487         // Otherwise it must have been malloc'd, so free it
5488
5489         free( frame );
5490 }
5491
5492 /* --------------------------------------------------------------------------
5493  Search a given QueryFrame for a specified alias.  If you find it, return
5494  a pointer to the corresponding ClassInfo.  Otherwise return NULL.
5495 ---------------------------------------------------------------------------*/
5496 static ClassInfo* search_alias_in_frame( QueryFrame* frame, const char* target ) {
5497         if( ! frame || ! target ) {
5498                 return NULL;
5499         }
5500
5501         ClassInfo* found_class = NULL;
5502
5503         if( !strcmp( target, frame->core.alias ) )
5504                 return &(frame->core);
5505         else {
5506                 ClassInfo* curr_class = frame->join_list;
5507                 while( curr_class ) {
5508                         if( strcmp( target, curr_class->alias ) )
5509                                 curr_class = curr_class->next;
5510                         else {
5511                                 found_class = curr_class;
5512                                 break;
5513                         }
5514                 }
5515         }
5516
5517         return found_class;
5518 }
5519
5520 /* --------------------------------------------------------------------------
5521  Push a new (blank) QueryFrame onto the stack.
5522 ---------------------------------------------------------------------------*/
5523 static void push_query_frame( void ) {
5524         QueryFrame* frame = allocate_frame();
5525         frame->join_list = NULL;
5526         frame->next = curr_query;
5527
5528         // Initialize the ClassInfo for the core class
5529         ClassInfo* core = &frame->core;
5530         core->alias = core->class_name = core->source_def = NULL;
5531         core->class_def = core->fields = core->links = NULL;
5532
5533         curr_query = frame;
5534 }
5535
5536 /* --------------------------------------------------------------------------
5537  Pop a QueryFrame off the stack and destroy it
5538 ---------------------------------------------------------------------------*/
5539 static void pop_query_frame( void ) {
5540         // Sanity check
5541         if( ! curr_query )
5542                 return;
5543
5544         QueryFrame* popped = curr_query;
5545         curr_query = popped->next;
5546
5547         free_query_frame( popped );
5548 }
5549
5550 /* --------------------------------------------------------------------------
5551  Populate the ClassInfo for the core class.  Return 0 if successful, 1 if not.
5552 ---------------------------------------------------------------------------*/
5553 static int add_query_core( const char* alias, const char* class_name ) {
5554
5555         // Sanity checks
5556         if( ! curr_query ) {
5557                 osrfLogError( OSRF_LOG_MARK,
5558                                           "%s ERROR: No QueryFrame available for class %s", MODULENAME, class_name );
5559                 return 1;
5560         } else if( curr_query->core.alias ) {
5561                 osrfLogError( OSRF_LOG_MARK,
5562                                           "%s ERROR: Core class %s already populated as %s",
5563                                           MODULENAME, curr_query->core.class_name, curr_query->core.alias );
5564                 return 1;
5565         }
5566
5567         build_class_info( &curr_query->core, alias, class_name );
5568         if( curr_query->core.alias )
5569                 return 0;
5570         else {
5571                 osrfLogError( OSRF_LOG_MARK,
5572                                           "%s ERROR: Unable to look up core class %s", MODULENAME, class_name );
5573                 return 1;
5574         }
5575 }
5576
5577 /* --------------------------------------------------------------------------
5578  Search the current QueryFrame for a specified alias.  If you find it,
5579  return a pointer to the corresponding ClassInfo.  Otherwise return NULL.
5580 ---------------------------------------------------------------------------*/
5581 static ClassInfo* search_alias( const char* target ) {
5582         return search_alias_in_frame( curr_query, target );
5583 }
5584
5585 /* --------------------------------------------------------------------------
5586  Search all levels of query for a specified alias, starting with the
5587  current query.  If you find it, return a pointer to the corresponding
5588  ClassInfo.  Otherwise return NULL.
5589 ---------------------------------------------------------------------------*/
5590 static ClassInfo* search_all_alias( const char* target ) {
5591         ClassInfo* found_class = NULL;
5592         QueryFrame* curr_frame = curr_query;
5593
5594         while( curr_frame ) {
5595                 if(( found_class = search_alias_in_frame( curr_frame, target ) ))
5596                         break;
5597                 else
5598                         curr_frame = curr_frame->next;
5599         }
5600
5601         return found_class;
5602 }
5603
5604 /* --------------------------------------------------------------------------
5605  Add a class to the list of classes joined to the current query.
5606 ---------------------------------------------------------------------------*/
5607 static ClassInfo* add_joined_class( const char* alias, const char* classname ) {
5608
5609         if( ! classname || ! *classname ) {    // sanity check
5610                 osrfLogError( OSRF_LOG_MARK, "Can't join a class with no class name" );
5611                 return NULL;
5612         }
5613
5614         if( ! alias )
5615                 alias = classname;
5616
5617         const ClassInfo* conflict = search_alias( alias );
5618         if( conflict ) {
5619                 osrfLogError( OSRF_LOG_MARK,
5620                                           "%s ERROR: Table alias \"%s\" conflicts with class \"%s\"",
5621                                           MODULENAME, alias, conflict->class_name );
5622                 return NULL;
5623         }
5624
5625         ClassInfo* info = allocate_class_info();
5626
5627         if( build_class_info( info, alias, classname ) ) {
5628                 free_class_info( info );
5629                 return NULL;
5630         }
5631
5632         // Add the new ClassInfo to the join list of the current QueryFrame
5633         info->next = curr_query->join_list;
5634         curr_query->join_list = info;
5635
5636         return info;
5637 }
5638
5639 /* --------------------------------------------------------------------------
5640  Destroy all nodes on the query stack.
5641 ---------------------------------------------------------------------------*/
5642 static void clear_query_stack( void ) {
5643         while( curr_query )
5644                 pop_query_frame();
5645 }