RMTileCache.m
12.6 KB
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
//
// RMTileCache.m
//
// Copyright (c) 2008-2009, Route-Me Contributors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#import <sys/utsname.h>
#import "RMTileCache.h"
#import "RMMemoryCache.h"
#import "RMDatabaseCache.h"
#import "RMConfiguration.h"
#import "RMTileSource.h"
@interface RMTileCache (Configuration)
- (id <RMTileCache>)memoryCacheWithConfig:(NSDictionary *)cfg;
- (id <RMTileCache>)databaseCacheWithConfig:(NSDictionary *)cfg;
@end
@implementation RMTileCache
{
NSMutableArray *_tileCaches;
// The memory cache, if we have one
// This one has its own variable because we want to propagate cache hits down in
// the cache hierarchy up to the memory cache
RMMemoryCache *_memoryCache;
NSTimeInterval _expiryPeriod;
dispatch_queue_t _tileCacheQueue;
}
- (id)initWithExpiryPeriod:(NSTimeInterval)period
{
if (!(self = [super init]))
return nil;
_tileCaches = [[NSMutableArray alloc] init];
_tileCacheQueue = dispatch_queue_create("routeme.tileCacheQueue", DISPATCH_QUEUE_CONCURRENT);
_memoryCache = nil;
_expiryPeriod = period;
id cacheCfg = [[RMConfiguration configuration] cacheConfiguration];
if (!cacheCfg)
cacheCfg = [NSArray arrayWithObjects:
[NSDictionary dictionaryWithObject: @"memory-cache" forKey: @"type"],
[NSDictionary dictionaryWithObject: @"db-cache" forKey: @"type"],
nil];
for (id cfg in cacheCfg)
{
id <RMTileCache> newCache = nil;
@try {
NSString *type = [cfg valueForKey:@"type"];
if ([@"memory-cache" isEqualToString:type])
{
_memoryCache = [[self memoryCacheWithConfig:cfg] retain];
continue;
}
if ([@"db-cache" isEqualToString:type])
newCache = [self databaseCacheWithConfig:cfg];
if (newCache)
[_tileCaches addObject:newCache];
else
RMLog(@"failed to create cache of type %@", type);
}
@catch (NSException * e) {
RMLog(@"*** configuration error: %@", [e reason]);
}
}
return self;
}
- (id)init
{
if (!(self = [self initWithExpiryPeriod:0]))
return nil;
return self;
}
- (void)dealloc
{
dispatch_barrier_sync(_tileCacheQueue, ^{
[_memoryCache release]; _memoryCache = nil;
[_tileCaches release]; _tileCaches = nil;
});
[super dealloc];
}
- (void)addCache:(id <RMTileCache>)cache
{
dispatch_barrier_async(_tileCacheQueue, ^{
[_tileCaches addObject:cache];
});
}
- (void)insertCache:(id <RMTileCache>)cache atIndex:(NSUInteger)index
{
dispatch_barrier_async(_tileCacheQueue, ^{
if (index >= [_tileCaches count])
[_tileCaches addObject:cache];
else
[_tileCaches insertObject:cache atIndex:index];
});
}
+ (NSNumber *)tileHash:(RMTile)tile
{
return [NSNumber numberWithUnsignedLongLong:RMTileKey(tile)];
}
// Returns the cached image if it exists. nil otherwise.
- (UIImage *)cachedImage:(RMTile)tile withCacheKey:(NSString *)aCacheKey
{
__block UIImage *image = [_memoryCache cachedImage:tile withCacheKey:aCacheKey];
if (image)
return image;
dispatch_sync(_tileCacheQueue, ^{
for (id <RMTileCache> cache in _tileCaches)
{
image = [[cache cachedImage:tile withCacheKey:aCacheKey] retain];
if (image != nil)
{
[_memoryCache addImage:image forTile:tile withCacheKey:aCacheKey];
break;
}
}
});
return [image autorelease];
}
- (void)addImage:(UIImage *)image forTile:(RMTile)tile withCacheKey:(NSString *)aCacheKey
{
if (!image || !aCacheKey)
return;
[_memoryCache addImage:image forTile:tile withCacheKey:aCacheKey];
dispatch_sync(_tileCacheQueue, ^{
for (id <RMTileCache> cache in _tileCaches)
{
if ([cache respondsToSelector:@selector(addImage:forTile:withCacheKey:)])
[cache addImage:image forTile:tile withCacheKey:aCacheKey];
}
});
}
- (void)didReceiveMemoryWarning
{
LogMethod();
[_memoryCache didReceiveMemoryWarning];
dispatch_sync(_tileCacheQueue, ^{
for (id<RMTileCache> cache in _tileCaches)
{
[cache didReceiveMemoryWarning];
}
});
}
- (void)removeAllCachedImages
{
[_memoryCache removeAllCachedImages];
dispatch_sync(_tileCacheQueue, ^{
for (id<RMTileCache> cache in _tileCaches)
{
[cache removeAllCachedImages];
}
});
}
@end
#pragma mark -
@implementation RMTileCache (Configuration)
static NSMutableDictionary *predicateValues = nil;
- (NSDictionary *)predicateValues
{
static dispatch_once_t predicateValuesOnceToken;
dispatch_once(&predicateValuesOnceToken, ^{
struct utsname systemInfo;
uname(&systemInfo);
NSString *machine = [NSString stringWithCString:systemInfo.machine encoding:NSASCIIStringEncoding];
predicateValues = [[NSMutableDictionary alloc] initWithObjectsAndKeys:
[[UIDevice currentDevice] model], @"model",
machine, @"machine",
[[UIDevice currentDevice] systemName], @"systemName",
[NSNumber numberWithFloat:[[[UIDevice currentDevice] systemVersion] floatValue]], @"systemVersion",
[NSNumber numberWithInt:[[UIDevice currentDevice] userInterfaceIdiom]], @"userInterfaceIdiom",
nil];
if ( ! ([machine isEqualToString:@"i386"] || [machine isEqualToString:@"x86_64"]))
{
NSNumber *machineNumber = [NSNumber numberWithFloat:[[[machine stringByTrimmingCharactersInSet:[NSCharacterSet letterCharacterSet]] stringByReplacingOccurrencesOfString:@"," withString:@"."] floatValue]];
if ( ! machineNumber)
machineNumber = [NSNumber numberWithFloat:0.0];
[predicateValues setObject:machineNumber forKey:@"machineNumber"];
}
else
{
[predicateValues setObject:[NSNumber numberWithFloat:0.0] forKey:@"machineNumber"];
}
// A predicate might be:
// (self.model = 'iPad' and self.machineNumber >= 3) or (self.machine = 'x86_64')
// See NSPredicate
// NSLog(@"Predicate values:\n%@", [predicateValues description]);
});
return predicateValues;
}
- (id <RMTileCache>)memoryCacheWithConfig:(NSDictionary *)cfg
{
NSUInteger capacity = 32;
NSNumber *capacityNumber = [cfg objectForKey:@"capacity"];
if (capacityNumber != nil)
capacity = [capacityNumber unsignedIntegerValue];
NSArray *predicates = [cfg objectForKey:@"predicates"];
if (predicates)
{
NSDictionary *predicateValues = [self predicateValues];
for (NSDictionary *predicateDescription in predicates)
{
NSString *predicate = [predicateDescription objectForKey:@"predicate"];
if ( ! predicate)
continue;
if ( ! [[NSPredicate predicateWithFormat:predicate] evaluateWithObject:predicateValues])
continue;
capacityNumber = [predicateDescription objectForKey:@"capacity"];
if (capacityNumber != nil)
capacity = [capacityNumber unsignedIntegerValue];
}
}
RMLog(@"Memory cache configuration: {capacity : %d}", capacity);
return [[[RMMemoryCache alloc] initWithCapacity:capacity] autorelease];
}
- (id <RMTileCache>)databaseCacheWithConfig:(NSDictionary *)cfg
{
BOOL useCacheDir = NO;
RMCachePurgeStrategy strategy = RMCachePurgeStrategyFIFO;
NSUInteger capacity = 1000;
NSUInteger minimalPurge = capacity / 10;
// Defaults
NSNumber *capacityNumber = [cfg objectForKey:@"capacity"];
if ([UIDevice currentDevice].userInterfaceIdiom == UIUserInterfaceIdiomPad && [cfg objectForKey:@"capacity-ipad"])
{
NSLog(@"***** WARNING: deprecated config option capacity-ipad, use a predicate instead: -[%@ %@] (line %d)", self, NSStringFromSelector(_cmd), __LINE__);
capacityNumber = [cfg objectForKey:@"capacity-ipad"];
}
NSString *strategyStr = [cfg objectForKey:@"strategy"];
NSNumber *useCacheDirNumber = [cfg objectForKey:@"useCachesDirectory"];
NSNumber *minimalPurgeNumber = [cfg objectForKey:@"minimalPurge"];
NSNumber *expiryPeriodNumber = [cfg objectForKey:@"expiryPeriod"];
NSArray *predicates = [cfg objectForKey:@"predicates"];
if (predicates)
{
NSDictionary *predicateValues = [self predicateValues];
for (NSDictionary *predicateDescription in predicates)
{
NSString *predicate = [predicateDescription objectForKey:@"predicate"];
if ( ! predicate)
continue;
if ( ! [[NSPredicate predicateWithFormat:predicate] evaluateWithObject:predicateValues])
continue;
if ([predicateDescription objectForKey:@"capacity"])
capacityNumber = [predicateDescription objectForKey:@"capacity"];
if ([predicateDescription objectForKey:@"strategy"])
strategyStr = [predicateDescription objectForKey:@"strategy"];
if ([predicateDescription objectForKey:@"useCachesDirectory"])
useCacheDirNumber = [predicateDescription objectForKey:@"useCachesDirectory"];
if ([predicateDescription objectForKey:@"minimalPurge"])
minimalPurgeNumber = [predicateDescription objectForKey:@"minimalPurge"];
if ([predicateDescription objectForKey:@"expiryPeriod"])
expiryPeriodNumber = [predicateDescription objectForKey:@"expiryPeriod"];
}
}
// Check the values
if (capacityNumber != nil)
{
NSInteger value = [capacityNumber intValue];
// 0 is valid: it means no capacity limit
if (value >= 0)
{
capacity = value;
minimalPurge = MAX(1,capacity / 10);
}
else
{
RMLog(@"illegal value for capacity: %d", value);
}
}
if (strategyStr != nil)
{
if ([strategyStr caseInsensitiveCompare:@"FIFO"] == NSOrderedSame) strategy = RMCachePurgeStrategyFIFO;
if ([strategyStr caseInsensitiveCompare:@"LRU"] == NSOrderedSame) strategy = RMCachePurgeStrategyLRU;
}
else
{
strategyStr = @"FIFO";
}
if (useCacheDirNumber != nil)
useCacheDir = [useCacheDirNumber boolValue];
if (minimalPurgeNumber != nil && capacity != 0)
{
NSUInteger value = [minimalPurgeNumber unsignedIntValue];
if (value > 0 && value<=capacity)
minimalPurge = value;
else
RMLog(@"minimalPurge must be at least one and at most the cache capacity");
}
if (expiryPeriodNumber != nil)
_expiryPeriod = [expiryPeriodNumber doubleValue];
RMLog(@"Database cache configuration: {capacity : %d, strategy : %@, minimalPurge : %d, expiryPeriod: %.0f, useCacheDir : %@}", capacity, strategyStr, minimalPurge, _expiryPeriod, useCacheDir ? @"YES" : @"NO");
RMDatabaseCache *dbCache = [[[RMDatabaseCache alloc] initUsingCacheDir:useCacheDir] autorelease];
[dbCache setCapacity:capacity];
[dbCache setPurgeStrategy:strategy];
[dbCache setMinimalPurge:minimalPurge];
[dbCache setExpiryPeriod:_expiryPeriod];
return dbCache;
}
@end