baseten / Sources / BXDatabaseAdditions.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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
//
// BXDatabaseAdditions.m
// BaseTen
//
// Copyright (C) 2006-2008 Marko Karppinen & Co. LLC.
//
// Before using this software, please review the available licensing options
// by visiting http://basetenframework.org/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 "BXConstants.h"
#import "BXDatabaseAdditions.h"
#import "BXDatabaseObjectPrivate.h"
#import "BXDatabaseObjectID.h"
#import "BXDatabaseObjectIDPrivate.h"
#import "BXDatabaseContext.h"
#import "BXException.h"
#import "BXDatabaseObject.h"
#import "BXAttributeDescription.h"
#import "BXLogger.h"


@implementation NSURL (BXDatabaseAdditions)

- (unsigned int) BXHash
{
    unsigned int u = 0;
	u = [[self scheme] hash];
	u ^= [[self host] hash];
	u ^= [[self port] hash];
	u ^= [[self path] hash];
	u ^= [[self query] hash];
    return u;
}

- (NSURL *) BXURIForHost: (NSString *) host database: (NSString *) dbName username: (NSString *) username password: (id) password
{
	NSString* scheme = [self scheme];
	NSURL* retval = nil;
	
	if (nil != scheme)
	{
		NSMutableString* URLString = [NSMutableString string];
		[URLString appendFormat: @"%@://", scheme];

		if (nil == username) username = [self user];
		
		if (nil == password) password = [self password];
		else if ([NSNull null] == password) password = nil;
		
		if (nil != password && 0 < [password length])
			[URLString appendFormat: @"%@:%@@", [username BXURLEncodedString] ?: @"", [password BXURLEncodedString]];
		else if (nil != username && 0 < [username length])
			[URLString appendFormat: @"%@@", [username BXURLEncodedString]];
	
		if (nil == host) host = [self host];
		if (nil == host) host = @"";
		[URLString appendString: host];
		
		NSNumber* port = [self port];
		if (port) [URLString appendFormat: @":%@", port];
	
		if (nil != dbName)
            dbName = [dbName BXURLEncodedString];
        else
            dbName = [[self path] substringFromIndex: 1];
        
        if (nil != dbName) [URLString appendFormat: @"/%@", dbName];
		retval = [NSURL URLWithString: URLString];
	}
	return retval;
}

@end


static NSData*
URLEncode (const char* bytes, size_t length)
{
    NSMutableData* retval = [NSMutableData data];
    char hex [4] = "\0\0\0\0";
    for (unsigned int i = 0; i < length; i++)
    {
        char c = bytes [i];
        if (('0' <= c && c <= '9') || ('A' <= c && c <= 'Z') || ('a' <= c && c <= 'z') || 
            '-' == c || '_' == c || '.' == c || '~' == c)
            [retval appendBytes: &c length: sizeof (char)];
        else
        {
            snprintf (hex, 4, "%%%02hhx", c);
            [retval appendBytes: hex length: 3 * sizeof (char)];
        }
    }
    return retval;
}

static NSData* 
URLDecode (const char* bytes, size_t length, id sender)
{
    NSMutableData* retval = [NSMutableData data];
    char hex [3] = "\0\0\0";
    for (unsigned int i = 0; i < length; i++)
    {
        char c = bytes [i];
        if ('%' != c)
            [retval appendBytes: &c length: sizeof (char)];
        else
        {
            if (length < i + 3)
            {
                @throw [NSException exceptionWithName: NSRangeException reason: nil 
                                             userInfo: [NSDictionary dictionaryWithObject: sender forKey: kBXObjectKey]];
            }
            i++;
            strlcpy ((char *) &hex, &bytes [i], 3);
            char c = (char) strtol ((char *) &hex, NULL, 16);
            [retval appendBytes: &c length: sizeof (char)];
            i++;
        }
    }
    return retval;
}


@implementation NSData (BXDatabaseAdditions)
- (NSData *) BXURLDecodedData;
{
    return URLDecode ((char *) [self bytes], [self length], self);
}

- (NSData *) BXURLEncodedData
{
    return URLEncode ((char *) [self bytes], [self length]);
}
@end


@implementation NSString (BXDatabaseAdditions)

+ (NSString *) BXURLEncodedData: (id) data
{
    return [[[self alloc] initWithData: [data BXURLEncodedData] 
                              encoding: NSASCIIStringEncoding] autorelease];
}

+ (NSString *) BXURLDecodedData: (id) data
{
    return [[[self alloc] initWithData: [data BXURLDecodedData]
                              encoding: NSUTF8StringEncoding] autorelease];
}

- (NSData *) BXURLDecodedData
{
    return [[self dataUsingEncoding: NSASCIIStringEncoding] BXURLDecodedData];
}

- (NSData *) BXURLEncodedData
{
    const char* UTF8String = [self UTF8String];
    size_t length = strlen (UTF8String);
    return URLEncode (UTF8String, length);
}

- (NSString *) BXURLEncodedString
{
    return [NSString BXURLEncodedData: self];
}

- (NSString *) BXURLDecodedString
{
    return [NSString BXURLDecodedData: self];
}

- (NSArray *) BXKeyPathComponentsWithQuote: (NSString *) quoteString
{
    NSMutableArray* rval = [NSMutableArray array];
    NSString* part = nil;
    NSScanner* scanner = [NSScanner scannerWithString: self];
    for (;;)
    {
        if ('"' == [self characterAtIndex: [scanner scanLocation]])
        {
            NSMutableString* subpart = [NSMutableString string];
            [scanner scanString: quoteString intoString: NULL];
            for (;;) 
            {
                if ([scanner scanUpToString: quoteString intoString: &part])
                    [subpart appendString: part];
                else
                {
                    unichar c = [self characterAtIndex: [scanner scanLocation] - 1];
                    [scanner scanString: quoteString intoString: NULL];
                    if ('\\' != c)
                        break;
                }
            }
            [rval addObject: subpart];            
        }
        else if ([scanner scanUpToString: @"." intoString: &part])
        {
            [rval addObject: part];
        }
        
        if ([scanner isAtEnd])
            break;
        else
        {
            BOOL period = [scanner scanString: @"." intoString: NULL];
            assert (period);
        }
    }
    return rval;
}

- (NSString *) BXAttributeName
{
	return self;
}
@end


@implementation NSPredicate (BXDatabaseAdditions)
+ (NSPredicate *) BXAndPredicateWithProperties: (NSArray *) properties
                             matchingProperties: (NSArray *) otherProperties
                                           type: (NSPredicateOperatorType) type
{
    NSArray* parts = [self BXSubpredicatesForProperties: properties
                                      matchingProperties: otherProperties
                                                    type: type];
    id rval = nil;
    if (nil != parts)
        rval = [NSCompoundPredicate andPredicateWithSubpredicates: parts];
    return rval;
}

+ (NSPredicate *) BXOrPredicateWithProperties: (NSArray *) properties
                            matchingProperties: (NSArray *) otherProperites
                                          type: (NSPredicateOperatorType) type
{
    NSArray* parts = [self BXSubpredicatesForProperties: properties
                                      matchingProperties: otherProperites
                                                    type: type];
    id rval = nil;
    if (nil != parts)
        rval = [NSCompoundPredicate orPredicateWithSubpredicates: parts];
    return rval;    
}

+ (NSArray *) BXSubpredicatesForProperties: (NSArray *) properties
                         matchingProperties: (NSArray *) otherProperties
                                       type: (NSPredicateOperatorType) type
{
    unsigned int count = [properties count];
	BXAssertValueReturn (count == [otherProperties count], nil, @"Expected given arrays' counts to match.");
    NSMutableArray* parts = [NSMutableArray arrayWithCapacity: count];
    for (unsigned int i = 0; i < count; i++)
    {
        //The expression type should not be changed since it affects expression handling in NSExpression+PGTSAdditions.
        NSExpression* lhs = [NSExpression expressionForConstantValue: [properties objectAtIndex: i]];
        NSExpression* rhs = [NSExpression expressionForConstantValue: [otherProperties objectAtIndex: i]];
        [parts addObject: [NSComparisonPredicate predicateWithLeftExpression: lhs
                                                             rightExpression: rhs
                                                                    modifier: NSDirectPredicateModifier
                                                                        type: type
                                                                     options: 0]];
    }
    if (0 == [parts count])
        parts = nil;
    return parts;
}

- (NSArray *) BXEntities
{
    return nil;
}

- (NSSet *) BXEntitySet
{
    NSMutableSet* rval = [NSMutableSet setWithArray: [self BXEntities]];
    return rval;
}

- (BOOL) BXEvaluateWithObject: (id) anObject
{
    //True / false predicate
    return [self evaluateWithObject: anObject];
}

@end


@implementation NSCompoundPredicate (BXDatabaseAdditions)
- (NSSet *) BXEntitySet
{
    NSMutableSet* set = [NSMutableSet set];
    TSEnumerate (currentPredicate, e, [[self subpredicates] objectEnumerator])
        [set unionSet: [currentPredicate BXEntitySet]];
    return set;
}

- (BOOL) BXEvaluateWithObject: (id) anObject
{
    NSCompoundPredicateType type = [self compoundPredicateType];
    BOOL rval = NO;
    switch (type)
    {
        case NSNotPredicateType:
        {
            rval = ! ([[[self subpredicates] objectAtIndex: 0] BXEvaluateWithObject: anObject]);
            break;
        }
        case NSAndPredicateType:
        case NSOrPredicateType:
        {
            TSEnumerate (currentPredicate, e, [[self subpredicates] objectEnumerator])
            {
                rval = [currentPredicate BXEvaluateWithObject: anObject];
                if ((!rval && NSAndPredicateType == type) || (rval && NSOrPredicateType == type))
                    break;
            }
            break;
        }
        default:
            break;
    }
    return rval;
}
@end


@implementation NSMutableSet (BXDatabaseAdditions)
- (id) BXConditionalAdd: (id) anObject
{
    id rval = [self member: anObject];
    if (nil == rval)
    {
        [self addObject: anObject];
        rval = anObject;
    }
    return rval;
}
@end


@implementation NSError (BXDatabaseAdditions)
- (NSException *) BXExceptionWithName: (NSString *) aName
{
    NSMutableDictionary* userInfo = [NSMutableDictionary dictionaryWithDictionary: [self userInfo]];
    [userInfo setObject: self forKey: kBXErrorKey];
    return [BXException exceptionWithName: kBXExceptionUnhandledError 
								   reason: [self localizedFailureReason]
								 userInfo: userInfo];
}
@end


@implementation NSDictionary (BXDatabaseAdditions)
- (NSDictionary *) BXSubDictionaryExcludingKeys: (NSArray *) keys
{
    NSMutableDictionary* rval = [NSMutableDictionary dictionaryWithCapacity: [self count] - [keys count]];
    TSEnumerate (currentKey, e, [self keyEnumerator])
    {
        if (NO == [keys containsObject: currentKey])
            [rval setObject: [self objectForKey: currentKey] forKey: currentKey];
    }
    return rval;
}

- (NSDictionary *) BXTranslateUsingKeys: (NSDictionary *) translationDict
{
    NSMutableDictionary* rval = [NSMutableDictionary dictionaryWithCapacity: 
        MIN ([self count], [translationDict count])];
    TSEnumerate (currentKey, e, [translationDict keyEnumerator])
    {
        id currentObject = [self objectForKey: currentKey];
        if (nil != currentObject)
            [rval setObject: currentObject forKey: [translationDict objectForKey: currentKey]];
    }
    return rval;
}
@end


@implementation NSExpression (BXDatabaseAdditions)
- (BXEntityDescription *) BXEntity
{
    return [[self BXAttribute] entity];
}

- (BXAttributeDescription *) BXAttribute
{
    BXAttributeDescription* rval = nil;
    if ([self expressionType] == NSConstantValueExpressionType)
    {
        id constantValue = [self constantValue];
        if ([constantValue isKindOfClass: [BXAttributeDescription class]])
            rval = constantValue;
    }
    return rval;
}
@end


@implementation NSComparisonPredicate (BXDatabaseAdditions)
- (NSMutableSet *) BXEntitySet
{
	return [NSMutableSet setWithArray: [self BXEntities]];
}

- (NSArray *) BXEntities
{
    id lEnt = [[self  leftExpression] BXEntity];
    id rEnt = [[self rightExpression] BXEntity];
	id rval = nil;
	if (nil == lEnt && nil == rEnt)
		rval = nil;
	else if (nil == lEnt)
		rval = [NSArray arrayWithObject: rEnt];
	else if (nil == rEnt)
		rval = [NSArray arrayWithObject: lEnt];
	else
		rval = [NSArray arrayWithObjects: lEnt, rEnt, nil];
	
	return rval;
}

- (BOOL) BXEvaluateWithObject: (id) anObject
{
    BOOL retval = NO;
    id expressions [2] = {[self leftExpression], [self rightExpression]};
    BOOL createNew = NO;
    NSDictionary* values = nil;
	
	//FIXME: reconsider this in the future.
    for (int i = 0; i < 2; i++)
    {
        if (NSConstantValueExpressionType == [expressions [i] expressionType])
        {
            id attribute = [expressions [i] constantValue];
            if ([attribute isKindOfClass: [BXAttributeDescription class]])
            {
                createNew = YES;
				
				//Stupid optimizations for objectIDs and database objects.
				//In case we have an object id or only need a fault, get the value dict.
				if (nil == values)
					values = [(BXDatabaseObject *) anObject allValues];
				NSString* name = [attribute name];
				id value = [values objectForKey: name];
				if (nil == value)
					value = [anObject primitiveValueForKey: name];
					
                expressions [i] = [NSExpression expressionForConstantValue: value];
            }
        }
    }
    
    if (NO == createNew)
        retval = [self evaluateWithObject: anObject];
    else
    {
        //Custom selectors needn't be supported, since Postgres interface won't handle them anyway.
        NSPredicate* predicate = [NSComparisonPredicate predicateWithLeftExpression: expressions [0]
                                                                    rightExpression: expressions [1]
                                                                           modifier: [self comparisonPredicateModifier]
                                                                               type: [self predicateOperatorType]
                                                                            options: [self options]];
        retval = [predicate evaluateWithObject: anObject];
    }
    return retval;
}
@end


@implementation NSArray (BXDatabaseAdditions)
- (BOOL) BXContainsObjectsInArray: (NSArray *) anArray
{
    BOOL rval = YES;
    TSEnumerate (currentObject, e, [anArray objectEnumerator])
    {
        if (NO == [self containsObject: currentObject])
        {
            rval = NO;
            break;
        }
    }
    return rval;
}

- (NSMutableArray *) BXFilteredArrayUsingPredicate: (NSPredicate *) predicate others: (NSMutableArray *) otherArray
{
    NSMutableArray* retval = [NSMutableArray arrayWithCapacity: [self count]];
    TSEnumerate (currentObject, e, [self objectEnumerator])
    {
        if ([predicate BXEvaluateWithObject: currentObject])
            [retval addObject: currentObject];
        else
            [otherArray addObject: currentObject];
    }
    return retval;
}

+ (NSArray *) BXNullArray: (unsigned int) count
{
	id* buffer = (id *) alloca (count * sizeof (id));
	for (unsigned int i = 0; i < count; i++)
		buffer [i] = [NSNull null];
	
	NSArray* rval = [NSArray arrayWithObjects: buffer count: count];
	return rval;
}

@end


@implementation NSSet (BXDatabaseAdditions)
- (NSPredicate *) BXOrPredicateForObjects
{
    NSPredicate* rval = nil;
    if (0 < [self count])
    {
        NSMutableArray* parts = [NSMutableArray arrayWithCapacity: [self count]];
        TSEnumerate (currentObject, e, [self objectEnumerator])
            [parts addObject: [[currentObject objectID] predicate]];
        rval = [NSCompoundPredicate orPredicateWithSubpredicates: parts];
    }
    return rval;
}
@end


@implementation NSMutableDictionary (BXDatabaseAdditions)
- (void) BXSetModificationType: (enum BXModificationType) aType forKey: (BXDatabaseObjectID *) aKey
{
    [self setObject: [NSValue valueWithBytes: &aType objCType: @encode (enum BXModificationType)] forKey: aKey];
}

- (enum BXModificationType) BXModificationTypeForKey: (BXDatabaseObjectID *) aKey
{
    enum BXModificationType retval = kBXNoModification;
    [[self objectForKey: aKey] getValue: &retval];
    return retval;
}
@end


@implementation NSObject (BXDatabaseAdditions)
- (BOOL) BXIsRelationshipProxy
{
	return NO;
}
@end


@implementation NSProxy (BXDatabaeAdditions)
- (BOOL) BXIsRelationshipProxy
{
	return NO;
}
@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.