baseten / Sources / PGTSResultSet.m

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
//
// PGTSResultSet.m
// BaseTen
//
// Copyright (C) 2006 Marko Karppinen & Co. LLC.
//
// Before using this software, please review the available licensing options
// by visiting http://www.karppinen.fi/baseten/licensing/ or by contacting
// us at sales@karppinen.fi. Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
//
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//
// $Id$
//

#import <stdlib.h>
#import <limits.h>
#import <PGTS/postgresql/libpq-fe.h> 
#import <Log4Cocoa/Log4Cocoa.h>
#import "PGTSResultSet.h"
#import "PGTSResultSetPrivate.h"
#import "PGTSAdditions.h"
#import "PGTSResultRow.h"
#import "PGTSConnection.h"
#import "PGTSFunctions.h"
#import "PGTSConstants.h"
#import "PGTSDatabaseInfo.h"
#import "PGTSTableInfo.h"
#import "PGTSFieldInfo.h"
#import "PGTSTypeInfo.h"


/** 
 * Result set for a query.
 * A result set contains rows that may be iterated by the user.
 */
@implementation PGTSResultSet

#if 0
- (PGTSConnection *) connection
{
    return connection;
}
#endif

//FIXME: check that all retained objects are released
- (void) dealloc
{
	PQclear (result);
    
#if 0
    [fieldnames release];
	if (deserializedFields)
	{
		free (valueClassArray);
	}
    [rowAwakenInvocation release];
#endif
    
	[super dealloc];
}

- (ExecStatusType) status
{
	return PQresultStatus (mResult);
}

- (BOOL) querySucceeded
{
    ExecStatusType s = [self status];
    return (PGRES_FATAL_ERROR != s && PGRES_BAD_RESPONSE != s);
}

- (int) numberOfFields
{
	return mFields;
}

- (BOOL) isAtEnd
{
    return (currentRow == mTuples - 1);
}

- (BOOL) advanceRow
{
    BOOL retval = NO;
    if (NO == deserializedFields && YES == determinesFieldClassesAutomatically)
        [self beginDeserialization];
    
    //Row numbering is zero-based.
    //The number is initially -1. 
	if (currentRow < tuples - 1)
	{
        currentRow++;
		retval = YES;
	}
	return retval;
}

- (id) valueForFieldAtIndex: (int) columnIndex row: (int) rowIndex
{
    id retval = nil;
    if (! ((columnIndex < mFields) && (rowIndex < mTuples)))
    {
        @throw [NSException exceptionWithName: NSRangeException reason: nil userInfo: nil];
    }
    
    if (!PQgetisnull (result, rowIndex, columnIndex))
    {
        Class objectClass = Nil;
        if (!deserializedFields || Nil == (objectClass = valueClassArray [columnIndex]))
            objectClass = [NSData class];
        char* value = PQgetvalue (result, rowIndex, columnIndex);
        PGTSTypeInfo* type = [[connection databaseInfo] typeInfoForTypeWithOid: PQftype (result, columnIndex)];
        rval = [objectClass newForPGTSResultSet: self withCharacters: value typeInfo: type];
    }
    return retval;
}

- (id) valueForFieldNamed: (NSString *) aName row: (int) rowIndex
{
    unsigned int columnIndex = [fieldnames integerForKey: aName];
    if (NSNotFound == columnIndex)
    {
        [[NSException exceptionWithName: kPGTSFieldNotFoundException reason: nil 
                               userInfo: [NSDictionary dictionaryWithObjectsAndKeys:
                                   aName, kPGTSFieldnameKey,
                                   self,  kPGTSResultSetKey,
                                   nil]] 
            raise];
    }
    return [self valueForFieldAtIndex: columnIndex row: rowIndex];
}

- (id) valueForFieldNamed: (NSString *) aName
{
    return [self valueForFieldNamed: aName row: currentRow];
}

- (id) valueForKey: (NSString *) aKey
{
	//Unknown key raises an exception.
    return [self valueForFieldNamed: aKey];
}

- (id) valueForFieldAtIndex: (int) columnIndex
{
    return [self valueForFieldAtIndex: columnIndex row: currentRow];
}

- (unsigned int) indexOfFieldNamed: (NSString *) aName
{
    return [fieldnames integerForKey: aName];
}

- (int) currentRow
{
    return currentRow;
}

/**
 * Current row with values in the same order as given in the query
 */
- (NSArray *) currentRowAsArray
{
    NSMutableArray* row = [NSMutableArray arrayWithCapacity: fields];
    for (int i = 0; i < fields; i++)
    {
        id value = [self valueForFieldAtIndex: i];
        [row addObject: (value == nil ? [NSNull null] : value)];
    }
    return row;
}

/**
 * Current row with field names as keys
 * NSNull is used in place of nil
 */
- (NSDictionary *) currentRowAsDictionary
{
    NSMutableDictionary* rowDict = [NSMutableDictionary dictionaryWithCapacity: fields];
    [self setValuesFromRow: currentRow target: rowDict nullPlaceholder: [NSNull null]];
    return [[rowDict copy] autorelease];
}

/** Move to the beginning of the result set */
- (void) goBeforeFirstRow
{
    [self goToRow: -1];
}

- (BOOL) goToRow: (int) aRow
{
	if (-1 <= aRow && aRow < tuples)
	{
		currentRow = aRow;
		return YES;
	}
	return NO;
}

- (int) numberOfRowsAffected;
{
	return tuples;
}

- (NSString *) description
{
    return [NSString stringWithFormat: @"<%@ %u (%p) PGres: %p cr: %d t: %d f: %d hbv: %d ok: %d>",
        [self class], serial, self, result, currentRow, tuples, fields, deserializedFields, [self querySucceeded]];
}

- (unsigned long long) numberOfRowsAffectedByCommand;
{
	return strtoull (PQcmdTuples (result), NULL, 10);
}

@end


/** Automatic construction of objects */
@implementation PGTSResultSet (Serialization)

- (void) setDeterminesFieldClassesAutomatically: (BOOL) aBool
{
    determinesFieldClassesAutomatically = aBool;
}

- (BOOL) determinesFieldClassesAutomatically
{
    return determinesFieldClassesAutomatically;
}

/**
 * Set the class that should be used with a specific field
 * @{
 */
- (BOOL) setClass: (Class) aClass forFieldNamed: (NSString *) aName
{
    return [self setClass: aClass forFieldAtIndex: [fieldnames integerForKey: aName]];
}

- (BOOL) setClass: (Class) aClass forFieldAtIndex: (int) fieldIndex
{
    BOOL rval = NO;
    if (!deserializedFields)
        [self beginDeserialization];
    if (fieldIndex < fields)
    {
        valueClassArray [fieldIndex] = aClass;
        rval = YES;
    }
    return rval;
}

- (Class) classForFieldNamed: (NSString *) aName
{
	return [self classForFieldAtIndex: [fieldnames integerForKey: aName]];
}

- (Class) classForFieldAtIndex: (int) fieldIndex
{
	Class retval = Nil;
	if (!deserializedFields)
		[self beginDeserialization];
	if (fieldIndex < fields)
        retval = valueClassArray [fieldIndex];
	return retval;
}

- (BOOL) setFieldClassesFromArray: (NSArray *) classes
{
    int count = [classes count];
    for (int i = 0; i < count; i++)
    {
        Class currentClass = [classes objectAtIndex: i];
        log4AssertValueReturn ([currentClass class] == currentClass, NO, 
							   @"Class array may contain only classes (was %@).", classes);

        if ([NSNull null] != (void *) currentClass)
            if (NO == [self setClass: currentClass forFieldAtIndex: i])
                return NO;
    }
    return YES;
}
//@}

- (void) setRowClass: (Class) aClass
{
    if ([aClass conformsToProtocol: @protocol (PGTSResultRowProtocol)])
        rowClass = aClass;
    else
    {
        //FIXME: localize me
        NSString* reason = @"Class %@ does not conform to protocol PGTSResultRowProtocol";
        [NSException raise: NSInvalidArgumentException 
                    format: reason, aClass];
    }
}

- (Class) rowClass
{
    return rowClass;
}

- (NSInvocation *) rowAwakenInvocation
{
    return rowAwakenInvocation;
}

- (void) setRowAwakenInvocation: (NSInvocation *) invocation
{
    if (invocation != rowAwakenInvocation)
    {
        [rowAwakenInvocation release];
        rowAwakenInvocation = [invocation retain];
    }
}

- (void) setValuesToTarget: (id) targetObject
{
    [self setValuesFromRow: currentRow target: targetObject nullPlaceholder: nil];
}

- (void) setValuesFromRow: (int) rowIndex target: (id) targetObject
{
    [self setValuesFromRow: rowIndex target: targetObject nullPlaceholder: nil];
}

- (void) setValuesFromRow: (int) rowIndex target: (id) targetObject nullPlaceholder: (id) anObject
{
    TSEnumerate (fieldname, e, [fieldnames keyEnumerator])
    {
        id value = [self valueForFieldAtIndex: [fieldnames integerForKey: fieldname] row: rowIndex];
        if (nil == value)
        {
            value = anObject;
        }
        
        //setValue throws an exception if a suitable method or an ivar cannot be found
        NS_DURING
            [targetObject setValue: value forKey: fieldname];
        NS_HANDLER
        NS_ENDHANDLER
    }    
}

- (id) currentRowAsObject
{
    return [self objectInRowsAtIndex: currentRow];
}

- (NSArray *) resultAsArray
{
    if (NO == deserializedFields && YES == determinesFieldClassesAutomatically)
        [self beginDeserialization];

    NSMutableArray* rval = [NSMutableArray arrayWithCapacity: tuples];
    for (int i = 0; i < tuples; i++)
        [rval addObject: [self objectInRowsAtIndex: i]];
    return rval;
}

//FIXME: reconsider this
#if 0
//FIXME: Add some comments to this method
- (NSArray *) allObjects
{
    unsigned int* indexes = [fieldnames tagVectorSortedByValue];
    if ([objectCache count] < [self numberOfRowsAffected])
    {
        int expectedIndex = 0;
        TSEnumerate (currentKey, e, [keys objectEnumerator])
        {
            expectedIndex++;
            while ([currentKey intValue] > expectedIndex)
            {
                [self rowAsObject: expectedIndex];
                expectedIndex++;
            }
        }
    }
    return [objectCache objectsForKeys: keys notFoundMarker: [NSNull null]];
}
#endif

@end


@implementation PGTSResultSet (PrivateMethods)

- (PGresult *) pgresult
{
    return result;
}

+ (id) resultWithPGresult: (PGresult *) aResult connection: (PGTSConnection *) aConnection
{
	return [[[self alloc] initWithResult: aResult connection: aConnection] autorelease];
}

- (id) initWithResult: (PGresult *) aResult connection: (PGTSConnection *) aConnection;
{
	if (! (self = [super init])) return nil;
	mResult = aResult;
	mCurrentRow = -1;
	mTuples = PQntuples (result);
	mFields = PQnfields (result);
    
    fieldnames = [MKCDictionary copyDictionaryWithCapacity: fields 
                                                   keyType: kMKCCollectionTypeObject 
                                                 valueType: kMKCCollectionTypeInteger];
    for (int i = 0; i < fields; i++)
    {
        //FIXME: workaround for what seems to be a bug in libpq
        //This should be isolated and reported
        //Occures at least with the COPY command
        char* fname = PQfname (result, i);
        if (NULL == fname)
        {
            fields = i;
            break;
        }
        [fieldnames setInteger: i forKey: [NSString stringWithUTF8String: fname]];
    }
    
    determinesFieldClassesAutomatically = YES;
    rowClass = [NSMutableDictionary class];
    rowAwakenInvocation = nil;
	deserializedFields = NO;
	valueClassArray = NULL;
    
    if (YES == [connection logsQueries] && NO == [self querySucceeded])
        [self logError];
	    
	return self;
}

- (void) beginDeserialization
{
	deserializedFields = YES;
	valueClassArray = calloc (fields, sizeof (Class));
    
    if (determinesFieldClassesAutomatically)
    {
        PGTSDatabaseInfo* dbInfo = [connection databaseInfo];
        NSDictionary* deserializationDictionary = [connection deserializationDictionary];
        if (nil == deserializationDictionary)
            deserializationDictionary = [NSDictionary PGTSDeserializationDictionary];
        for (int i = 0; i < fields; i++)
        {
            PGTSTypeInfo* typeInfo = [dbInfo typeInfoForTypeWithOid: [self typeOidForFieldAtIndex: i]];
            NSString* name = [typeInfo name];
            [self setClass: [deserializationDictionary objectForKey: name] forFieldAtIndex: i];
        }
    }
}

@end
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.