summaryrefslogtreecommitdiffstats
path: root/Classes/HJMOHandler.m
blob: fb8643e798389925ae97c938240923fca29af540 (plain)
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
//
//  HJManagedState.m
//  hjlib
//
//  Copyright Hunter and Johnson 2009, 2010, 2011
//  HJCache may be used freely in any iOS or Mac application free or commercial.
//  May be redistributed as source code only if all the original files are included.
//  See http://www.markj.net/hjcache-iphone-image-cache/

#import "HJMOHandler.h"
#import "HJMOUser.h"
#import "HJObjManager.h"
#import "HJMOFileCache.h"


@implementation HJMOHandler

@synthesize state;
@synthesize oid;
@synthesize url;
@synthesize urlConn;
@synthesize moData;
@synthesize moReadyDataFilename;
@synthesize moLoadingDataFile;
@synthesize managedObj;
@synthesize objManager;
@synthesize ownPolicy;


-(HJMOHandler*)initWithOid:(id)oid_ url:(NSURL*)url_  objManager:objManager_{
	[super init];
	state = stateNew;
	self.oid = oid_;
	self.url = url_ ;
	self.objManager = objManager_;
	if (oid==nil) { 
		self.oid = url_;
	}
	
	users = [[HJWeakMutableArray alloc] initWithCapacity:1]; //it can expand automatically.
	return self;
}

-(void)dealloc {
	//NSLog(@"dealloc %@",self);
	[urlConn cancel];
	[self clearLoadingState];
	[users release];
	[url release];
	[moReadyDataFilename release];
	//NSLog(@"managed Obj retain count before handler dealloc %i",[managedObj retainCount]);
	[managedObj release];
	[ownPolicy release];
	[oid release];
	[super dealloc];
}


-(BOOL) isEqual:(id)object {
	if (![object isKindOfClass:[HJMOHandler class]]) {
		return NO;
	}
	return [oid isEqual:[(HJMOHandler*)object oid]];
}

-(HJMOPolicy*)policy {
	if (ownPolicy) { 
		return ownPolicy;
	} else {
		return [objManager policy];
	}
}

-(void)addUser:(id<HJMOUser>)user {
	//check if already managing for this user (should not be if being used right)
	if (nil==[users findObject:user]) {
		[users addObject:user]; //did not already have user, so remember it (with a weak reference)
	} else {
		//can happen if users reused, and recycling code is lazy clearing old state, eg with UITableCellView
		//NSLog(@"HJMOHandler was already managing for user");
	}
	
	if (user.moHandler==nil) {
		//this is the normal case, so set the state
		user.moHandler=self;
	} else {
		if (user.moHandler==self) {
			//this is not what we expect, addUser has been called twice, but thats OK - do nothing
		} else {
			//user was pointing to another handler, this can happen when user is reused.
			//have to make sure that the old handler knows it should no longer manage for this user
			//otherwise it might send it callbacks, and it won't be able to become inactive (have no users)
			[user.moHandler removeUser:user];
			//now can assign the current state, which will also release the old one.
			user.moHandler=self;
		}
	}
}

-(void) deleteFileIfExistsAtPath:(NSString*)path {
	if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {
		NSError* e = nil;
		[[NSFileManager defaultManager] removeItemAtPath:path error:&e];
		if (e) {
			NSLog(@"HJMOHandler error deleting file %@",path);
		}
	}
}

-(void)clearLoadingState {
	self.urlConn=nil;
	[moLoadingDataFile closeFile];
	self.moLoadingDataFile = nil;
	self.moData = nil;
}

-(void)cancelLoading {
	if (state==stateLoading) {
		[urlConn cancel];
		[self clearLoadingState];
		state=stateNew;
	}
}

-(void)becameNotInUse {
	//TODO is there more policy decisions here?
	//[self cancelLoading]; //don't cancel loading, do that in dealloc. because object manager might be holding on to 
							//this handler in loadingHandlers to keep loading going
}

-(void)removeUser:(id<HJMOUser>)user {
	[users removeObject:user];
	[self retain]; //because the next line could dealloc self.
	user.moHandler = nil;
	if (![self isInUse]) {
		[self becameNotInUse];
	}
	[self autorelease];
}



-(BOOL)isInUse {
	return [users count]>0;
}

-(BOOL)isLoading {
	return urlConn!=nil;
}

-(BOOL)isReady {
	return managedObj!=nil;
}

-(void)touchFile:(NSString*)path {
	HJMOFileCache* fileCache = objManager.fileCache;
	if (fileCache==nil) { return; }
	NSTimeInterval ageLimit = fileCache.fileAgeLimit;
	if (ageLimit<=0) { return; }
	
	NSFileManager* fileMan = [NSFileManager defaultManager];

	NSError* e;
	NSDictionary* fsAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:path error:&e];		
	double ageSeconds = -1* [[fsAttributes fileModificationDate] timeIntervalSinceNow];

	if (ageSeconds>(ageLimit/4)) {
		//to save writes, file age modification date isn't changed on every access, only if 1/4 of age limit old.
		NSString *keyArray[1] = {NSFileModificationDate}; 
		id objectArray[1] = {[NSDate dateWithTimeIntervalSinceNow:0]};
		NSDictionary* attributes = [NSDictionary dictionaryWithObjects:objectArray forKeys:keyArray count:1];
		NSError* err;
		[fileMan setAttributes:attributes ofItemAtPath:path error:&err];
	}
}

-(void)activateNewHandlerForUser:(id<HJMOUser>)user {
	HJMOFileCache* fileCache = objManager.fileCache;
	if (fileCache) {
		//File caching is in use
		
		NSString* readyFile = [fileCache readyFilePathForOid:oid];
		
		if ([[NSFileManager defaultManager] fileExistsAtPath:readyFile]) {
			//NSLog(@"HJCache loading from fileCache");
			//mo is loaded as a file in file cache
			self.moReadyDataFilename = readyFile;
			if (self.policy.readsUpdateFileDate) {
				[self touchFile:readyFile];
			}
			state = stateLoaded;
			[self goFromLoadedToReady];
			if (state == stateReady || state==stateLoaded) {
				[objManager addHandlerToMemCache:self];
			}
			return;
			
		} else {
			//not loaded yet, so load to file because file cache in use
			//NSLog(@"HJCache loading from url");
			NSString* loadingFile = [fileCache loadingFilePathForOid:oid];
		
			BOOL ok = [[NSFileManager defaultManager] createFileAtPath:loadingFile contents:nil attributes:nil];
			if (!ok) {
				state = stateFailed;
				NSLog(@"HJMOHandler error creating loading file %@",loadingFile);
				loadingFile = nil;
				[self clearLoadingState]; 
				[self callbackFailedToUsers];
				return;
			} else {
				self.moLoadingDataFile = [NSFileHandle fileHandleForWritingAtPath:loadingFile];
			}
		}
	}
		
	//if file cache is in use temporary file name is prepared, either way now load from url
	[self startDownloadingFromURL];
}



-(void)activateHandlerForUser:(id<HJMOUser>)user {
	//stateNew, stateLoading, stateLoaded, stateReady, stateFailed 
	
	switch (state) {
			
		case stateNew:
			[self activateNewHandlerForUser:user];
			return;
			
		case stateLoading:
			//handler is still loading, have to wait for it to load, so nop.
			return;
			
		case stateLoaded:
			//for some reason it didn't go to ready when it was loaded, so try again now.
			[self goFromLoadedToReady];
			return;
			
		case stateReady:
			[user managedObjReady];
			return;
			
		case stateFailed:
			[user managedObjFailed];
			return;
			
		default:
			//not supposed to get here
			NSLog(@"HJMOHandler activateHandlerForUser error, no recognized state");
			break;
	}
}


-(void)startDownloadingFromURL {
	//NSLog(@"HJMOHandler starting download for %@",self);
	HJMOPolicy* policy = [self policy];
	NSURLRequest* request = [NSURLRequest requestWithURL:url 
										  cachePolicy:NSURLRequestReloadIgnoringLocalCacheData 
								          timeoutInterval:policy.urlTimeoutTime];
	self.urlConn = [[NSURLConnection alloc] initWithRequest:request delegate:self];
	[urlConn release];
	if (urlConn==nil) {
		NSLog(@"HJMOHandler nil URLConnection for %@",url);
		state=stateFailed;
	} else {
		state=stateLoading;
		//TODO if app is showing a network activity monitor in the status bar, here is where a call needs to be 
		// made to increment the number of active URLs
	}
}

-(void) goFromLoadedToReady {
	if ([users count]==0) {
		//can't go to stateReady because there's no user to do it. stay in stateLoaded.
		//this is not a bug, it can happen if the object has already been deleted before its content was
		//loaded over the net, eg because scrolled off the top of a table.
		//NSLog(@"HJMOHandler no user object to make it ready"); 
		return; 
	}
		
	self.managedObj=nil; //just to be sure there's not some old one around
	//pick _one_ and only one user to take mo from loaded to ready	
	id<HJMOUser> user = [users objectAtIndex:0];
	@try {
		[user changeManagedObjStateFromLoadedToReady];
		if (managedObj!=nil) {
			state = stateReady;  //because it worked
			[self callbackReadyToUsers];
		}
	} 
	@catch (id exception) {
		NSLog(@"%@",exception);
		self.managedObj=nil;
	}
	@finally {
		if (managedObj==nil) {
			//managedObj was still nil, ie going from loaded to ready failed. go to stateFailed and clean up from caches
			state = stateFailed; 
			self.moReadyDataFilename = nil;
			self.moData=nil;
			[objManager removeFromHandlerFromCaches:self];
			[self callbackFailedToUsers];
		}
	}
}

-(void) callbackReadyToUsers {
	for (id<HJMOUser> user in [users objectEnumerator]) {
		[user managedObjReady];
	}
}

-(void) callbackFailedToUsers {
	for (id<HJMOUser> user in [users objectEnumerator]) {
		[user managedObjFailed];
	}
}

- (void)connection:(NSURLConnection *)connection didReceiveData:(NSData *)data {
	if (state!=stateLoading) { return; }
	if (!moLoadingDataFile) {
		//loading direct to memory
		if (moData==nil) {
			self.moData = [NSMutableData dataWithCapacity:1024*10];
		}
		[moData appendData:data];
	} else {
		[moLoadingDataFile writeData:data];
	}
}

- (void)connectionDidFinishLoading:(NSURLConnection *)connection {
    [self retain]; //ensure that self isn't released in this method when the connection is finished with it.
	//NSLog(@"finishedLoading %@",self);
	state = stateLoaded;
	if (moLoadingDataFile) {
		//was downloading to file
		[moLoadingDataFile closeFile];
		self.moLoadingDataFile = nil;
		self.urlConn = nil;
		NSString* readyFilename = [self.objManager.fileCache loadingFinishedForOid:oid];
		if (readyFilename==nil) {
			state = stateFailed;
			[self callbackFailedToUsers]; 
			return;
		} else {
			self.moReadyDataFilename = readyFilename;
		}
	}
	//TODO if app is showing a network activity monitor in the status bar, here is where a call needs to be 
	// made to decrement the count of active URLs
	[objManager handlerFinishedDownloading:self];
	[self goFromLoadedToReady];
	if (state==stateReady || state==stateLoaded) {
		[objManager addHandlerToMemCache:self];
	}
    [self release];
}

- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error {
	state = stateFailed;
	NSLog(@"HJMOHandler URLConnection failed %@",error);
	//TODO if app is showing a network activity monitor in the status bar, here is where a call needs to be 
	// made to decrement the count of active URLs
	[self clearLoadingState]; 
	self.moReadyDataFilename = nil;
	self.moData=nil;
	[objManager removeFromHandlerFromCaches:self];
	[self callbackFailedToUsers];
}


-(NSString*)description {
	return [NSString stringWithFormat:@"HJMOHandler %@ users:%i retains:%i",oid,[users count],[self retainCount]];
}


@end