-
Notifications
You must be signed in to change notification settings - Fork 0
/
GTLService.m
2407 lines (2067 loc) · 91 KB
/
GTLService.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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
//
// GTLService.m
//
#import <TargetConditionals.h>
#if TARGET_OS_MAC
#include <sys/utsname.h>
#endif
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
#endif
#define GTLSERVICE_DEFINE_GLOBALS 1
#import "GTLService.h"
static NSString *const kUserDataPropertyKey = @"_userData";
static NSString* const kFetcherDelegateKey = @"_delegate";
static NSString* const kFetcherObjectClassKey = @"_objectClass";
static NSString* const kFetcherFinishedSelectorKey = @"_finishedSelector";
static NSString* const kFetcherCompletionHandlerKey = @"_completionHandler";
static NSString* const kFetcherTicketKey = @"_ticket";
static NSString* const kFetcherFetchErrorKey = @"_fetchError";
static NSString* const kFetcherParsingNotificationKey = @"_parseNotification";
static NSString* const kFetcherParsedObjectKey = @"_parsedObject";
static NSString* const kFetcherBatchClassMapKey = @"_batchClassMap";
static NSString* const kFetcherCallbackThreadKey = @"_callbackThread";
static NSString* const kFetcherCallbackRunLoopModesKey = @"_runLoopModes";
static const NSUInteger kMaxNumberOfNextPagesFetched = 25;
// we'll enforce 50K chunks minimum just to avoid the server getting hit
// with too many small upload chunks
static const NSUInteger kMinimumUploadChunkSize = 50000;
static const NSUInteger kStandardUploadChunkSize = NSUIntegerMax;
// Helper to get the ETag if it is defined on an object.
static NSString *ETagIfPresent(GTLObject *obj) {
NSString *result = [obj.JSON objectForKey:@"etag"];
return result;
}
@interface GTLServiceTicket ()
@property (retain) NSOperation *parseOperation;
@property (assign) BOOL isREST;
@end
// category to provide opaque access to tickets stored in fetcher properties
@implementation GTMHTTPFetcher (GTLServiceTicketAdditions)
- (id)ticket {
return [self propertyForKey:kFetcherTicketKey];
}
@end
// If GTMHTTPUploadFetcher is available, it can be used for chunked uploads
//
// We locally declare some methods of GTMHTTPUploadFetcher so we
// do not need to import the header, as some projects may not have it available
@interface GTMHTTPUploadFetcher : GTMHTTPFetcher
+ (GTMHTTPUploadFetcher *)uploadFetcherWithRequest:(NSURLRequest *)request
uploadData:(NSData *)data
uploadMIMEType:(NSString *)uploadMIMEType
chunkSize:(NSUInteger)chunkSize
fetcherService:(GTMHTTPFetcherService *)fetcherService;
+ (GTMHTTPUploadFetcher *)uploadFetcherWithRequest:(NSURLRequest *)request
uploadFileHandle:(NSFileHandle *)uploadFileHandle
uploadMIMEType:(NSString *)uploadMIMEType
chunkSize:(NSUInteger)chunkSize
fetcherService:(GTMHTTPFetcherService *)fetcherService;
+ (GTMHTTPUploadFetcher *)uploadFetcherWithLocation:(NSURL *)location
uploadFileHandle:(NSFileHandle *)fileHandle
uploadMIMEType:(NSString *)uploadMIMEType
chunkSize:(NSUInteger)chunkSize
fetcherService:(GTMHTTPFetcherService *)fetcherService;
- (void)pauseFetching;
- (void)resumeFetching;
- (BOOL)isPaused;
@end
@interface GTLService ()
- (void)prepareToParseObjectForFetcher:(GTMHTTPFetcher *)fetcher;
- (void)handleParsedObjectForFetcher:(GTMHTTPFetcher *)fetcher;
- (BOOL)fetchNextPageWithQuery:(GTLQuery *)query
delegate:(id)delegate
didFinishedSelector:(SEL)finishedSelector
completionHandler:(GTLServiceCompletionHandler)completionHandler
ticket:(GTLServiceTicket *)ticket;
- (id <GTLQueryProtocol>)nextPageQueryForQuery:(GTLQuery *)query
result:(GTLObject *)object
ticket:(GTLServiceTicket *)ticket;
- (GTLObject *)mergedNewResultObject:(GTLObject *)newResult
oldResultObject:(GTLObject *)oldResult
forQuery:(GTLQuery *)query;
- (GTMHTTPUploadFetcher *)uploadFetcherWithRequest:(NSURLRequest *)request
fetcherService:(GTMHTTPFetcherService *)fetcherService
params:(GTLUploadParameters *)uploadParams;
+ (void)invokeCallback:(SEL)callbackSel
target:(id)target
ticket:(id)ticket
object:(id)object
error:(id)error;
- (BOOL)invokeRetrySelector:(SEL)retrySelector
delegate:(id)delegate
ticket:(GTLServiceTicket *)ticket
willRetry:(BOOL)willRetry
error:(NSError *)error;
- (BOOL)objectFetcher:(GTMHTTPFetcher *)fetcher
willRetry:(BOOL)willRetry
forError:(NSError *)error;
- (void)objectFetcher:(GTMHTTPFetcher *)fetcher
finishedWithData:(NSData *)data
error:(NSError *)error;
- (void)parseObjectFromDataOfFetcher:(GTMHTTPFetcher *)fetcher;
@end
@interface GTLObject (StandardProperties)
@property (retain) NSString *ETag;
@property (retain) NSString *nextPageToken;
@property (retain) NSNumber *nextStartIndex;
@end
@implementation GTLService
@synthesize userAgentAddition = userAgentAddition_,
fetcherService = fetcherService_,
parseQueue = parseQueue_,
shouldFetchNextPages = shouldFetchNextPages_,
surrogates = surrogates_,
uploadProgressSelector = uploadProgressSelector_,
retryEnabled = isRetryEnabled_,
retrySelector = retrySelector_,
maxRetryInterval = maxRetryInterval_,
APIKey = apiKey_,
isRESTDataWrapperRequired = isRESTDataWrapperRequired_,
urlQueryParameters = urlQueryParameters_,
additionalHTTPHeaders = additionalHTTPHeaders_,
apiVersion = apiVersion_,
rpcURL = rpcURL_,
rpcUploadURL = rpcUploadURL_;
#if NS_BLOCKS_AVAILABLE
@synthesize retryBlock = retryBlock_,
uploadProgressBlock = uploadProgressBlock_;
#endif
+ (Class)ticketClass {
return [GTLServiceTicket class];
}
- (id)init {
self = [super init];
if (self) {
#if GTL_IPHONE || (MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_5)
// For 10.6 and up, always use an operation queue
parseQueue_ = [[NSOperationQueue alloc] init];
#elif !GTL_SKIP_PARSE_THREADING
// Avoid NSOperationQueue prior to 10.5.6, per
// http://www.mikeash.com/?page=pyblog/use-nsoperationqueue.html
SInt32 bcdSystemVersion = 0;
(void) Gestalt(gestaltSystemVersion, &bcdSystemVersion);
if (bcdSystemVersion >= 0x1057) {
parseQueue_ = [[NSOperationQueue alloc] init];
}
#else
// parseQueue_ defaults to nil, so parsing will be done immediately
// on the current thread
#endif
fetcherService_ = [[GTMHTTPFetcherService alloc] init];
NSUInteger chunkSize = [[self class] defaultServiceUploadChunkSize];
self.serviceUploadChunkSize = chunkSize;
}
return self;
}
- (void)dealloc {
[parseQueue_ release];
[userAgent_ release];
[fetcherService_ release];
[userAgentAddition_ release];
[serviceProperties_ release];
[surrogates_ release];
#if NS_BLOCKS_AVAILABLE
[uploadProgressBlock_ release];
[retryBlock_ release];
#endif
[apiKey_ release];
[apiVersion_ release];
[rpcURL_ release];
[rpcUploadURL_ release];
[urlQueryParameters_ release];
[additionalHTTPHeaders_ release];
[super dealloc];
}
- (NSString *)requestUserAgent {
NSString *userAgent = self.userAgent;
if ([userAgent length] == 0) {
// the service instance is missing an explicit user-agent; use the bundle ID
// or process name
NSBundle *owningBundle = [NSBundle bundleForClass:[self class]];
if (owningBundle == nil
|| [[owningBundle bundleIdentifier] isEqual:@"com.google.GTLFramework"]) {
owningBundle = [NSBundle mainBundle];
}
userAgent = GTMApplicationIdentifier(owningBundle);
}
NSString *requestUserAgent = userAgent;
// if the user agent already specifies the library version, we'll
// use it verbatim in the request
NSString *libraryString = @"google-api-objc-client";
NSRange libRange = [userAgent rangeOfString:libraryString
options:NSCaseInsensitiveSearch];
if (libRange.location == NSNotFound) {
// the user agent doesn't specify the client library, so append that
// information, and the system version
NSString *libVersionString = GTLFrameworkVersionString();
NSString *systemString = GTMSystemVersionString();
// We don't clean this with GTMCleanedUserAgentString so spaces are
// preserved
NSString *userAgentAddition = self.userAgentAddition;
NSString *customString = userAgentAddition ?
[@" " stringByAppendingString:userAgentAddition] : @"";
// Google servers look for gzip in the user agent before sending gzip-
// encoded responses. See Service.java
requestUserAgent = [NSString stringWithFormat:@"%@ %@/%@ %@%@ (gzip)",
userAgent, libraryString, libVersionString, systemString, customString];
}
return requestUserAgent;
}
- (NSMutableURLRequest *)requestForURL:(NSURL *)url
ETag:(NSString *)etag
httpMethod:(NSString *)httpMethod
ticket:(GTLServiceTicket *)ticket {
// subclasses may add headers to this
NSMutableURLRequest *request = [[[NSMutableURLRequest alloc] initWithURL:url
cachePolicy:NSURLRequestReloadIgnoringCacheData
timeoutInterval:60] autorelease];
NSString *requestUserAgent = self.requestUserAgent;
[request setValue:requestUserAgent forHTTPHeaderField:@"User-Agent"];
if ([httpMethod length] > 0) {
[request setHTTPMethod:httpMethod];
}
if ([etag length] > 0) {
// it's rather unexpected for an etagged object to be provided for a GET,
// but we'll check for an etag anyway, similar to HttpGDataRequest.java,
// and if present use it to request only an unchanged resource
BOOL isDoingHTTPGet = (httpMethod == nil
|| [httpMethod caseInsensitiveCompare:@"GET"] == NSOrderedSame);
if (isDoingHTTPGet) {
// set the etag header, even if weak, indicating we don't want
// another copy of the resource if it's the same as the object
[request setValue:etag forHTTPHeaderField:@"If-None-Match"];
} else {
// if we're doing PUT or DELETE, set the etag header indicating
// we only want to update the resource if our copy matches the current
// one (unless the etag is weak and so shouldn't be a constraint at all)
BOOL isWeakETag = [etag hasPrefix:@"W/"];
BOOL isModifying =
[httpMethod caseInsensitiveCompare:@"PUT"] == NSOrderedSame
|| [httpMethod caseInsensitiveCompare:@"DELETE"] == NSOrderedSame
|| [httpMethod caseInsensitiveCompare:@"PATCH"] == NSOrderedSame;
if (isModifying && !isWeakETag) {
[request setValue:etag forHTTPHeaderField:@"If-Match"];
}
}
}
return request;
}
- (NSMutableURLRequest *)requestForURL:(NSURL *)url
ETag:(NSString *)etag
httpMethod:(NSString *)httpMethod {
// this public entry point authenticates from the service object but
// not from the auth token in the ticket
return [self requestForURL:url ETag:etag httpMethod:httpMethod ticket:nil];
}
// objectRequestForURL returns an NSMutableURLRequest for a GTLObject
//
// the object is the object being sent to the server, or nil;
// the http method may be nil for get, or POST, PUT, DELETE
- (NSMutableURLRequest *)objectRequestForURL:(NSURL *)url
object:(GTLObject *)object
ETag:(NSString *)etag
httpMethod:(NSString *)httpMethod
isREST:(BOOL)isREST
additionalHeaders:(NSDictionary *)additionalHeaders
ticket:(GTLServiceTicket *)ticket {
if (object) {
// if the object being sent has an etag, add it to the request header to
// avoid retrieving a duplicate or to avoid writing over an updated
// version of the resource on the server
//
// Typically, delete requests will provide an explicit ETag parameter, and
// other requests will have the ETag carried inside the object being updated
if (etag == nil) {
SEL selEtag = @selector(ETag);
if ([object respondsToSelector:selEtag]) {
etag = [object performSelector:selEtag];
}
}
}
NSMutableURLRequest *request = [self requestForURL:url
ETag:etag
httpMethod:httpMethod
ticket:ticket];
NSString *acceptValue;
NSString *contentTypeValue;
if (isREST) {
acceptValue = @"application/json";
contentTypeValue = @"application/json; charset=utf-8";
} else {
acceptValue = @"application/json-rpc";
contentTypeValue = @"application/json-rpc; charset=utf-8";
}
[request setValue:acceptValue forHTTPHeaderField:@"Accept"];
[request setValue:contentTypeValue forHTTPHeaderField:@"Content-Type"];
[request setValue:@"no-cache" forHTTPHeaderField:@"Cache-Control"];
// Add the additional http headers from the service, and then from the query
NSDictionary *headers = self.additionalHTTPHeaders;
for (NSString *key in headers) {
NSString *value = [headers valueForKey:key];
[request setValue:value forHTTPHeaderField:key];
}
headers = additionalHeaders;
for (NSString *key in headers) {
NSString *value = [headers valueForKey:key];
[request setValue:value forHTTPHeaderField:key];
}
return request;
}
#pragma mark -
// common fetch starting method
- (GTLServiceTicket *)fetchObjectWithURL:(NSURL *)targetURL
objectClass:(Class)objectClass
bodyObject:(GTLObject *)bodyObject
dataToPost:(NSData *)dataToPost
ETag:(NSString *)etag
httpMethod:(NSString *)httpMethod
mayAuthorize:(BOOL)mayAuthorize
isREST:(BOOL)isREST
delegate:(id)delegate
didFinishSelector:(SEL)finishedSelector
completionHandler:(id)completionHandler // GTLServiceCompletionHandler
executingQuery:(id<GTLQueryProtocol>)query
ticket:(GTLServiceTicket *)ticket {
GTMAssertSelectorNilOrImplementedWithArgs(delegate, finishedSelector, @encode(GTLServiceTicket *), @encode(GTLObject *), @encode(NSError *), 0);
// The completionHandler argument is declared as an id, not as a block
// pointer, so this can be built with the 10.6 SDK and still run on 10.5.
// If the argument were declared as a block pointer, the invocation for
// fetchObjectWithURL: created in GTLService would cause an exception
// since 10.5's NSInvocation cannot deal with encoding of block pointers.
GTL_DEBUG_ASSERT(targetURL != nil, @"no url?");
if (targetURL == nil) return nil;
// we need to create a ticket unless one was created earlier (like during
// authentication)
if (!ticket) {
ticket = [[[self class] ticketClass] ticketForService:self];
}
ticket.isREST = isREST;
// Add any service specific query parameters.
NSDictionary *urlQueryParameters = self.urlQueryParameters;
if ([urlQueryParameters count] > 0) {
targetURL = [GTLUtilities URLWithString:[targetURL absoluteString]
queryParameters:urlQueryParameters];
}
// If this is REST and there is a developer key, add it onto the url. RPC
// adds the key into the payload, not on the url.
NSString *apiKey = self.APIKey;
if (isREST && [apiKey length] > 0) {
NSString *const kDeveloperAPIQueryParamKey = @"key";
NSDictionary *queryParameters;
queryParameters = [NSDictionary dictionaryWithObject:apiKey
forKey:kDeveloperAPIQueryParamKey];
targetURL = [GTLUtilities URLWithString:[targetURL absoluteString]
queryParameters:queryParameters];
}
NSDictionary *additionalHeaders = query.additionalHTTPHeaders;
NSMutableURLRequest *request = [self objectRequestForURL:targetURL
object:bodyObject
ETag:etag
httpMethod:httpMethod
isREST:isREST
additionalHeaders:additionalHeaders
ticket:ticket];
GTMAssertSelectorNilOrImplementedWithArgs(delegate, ticket.uploadProgressSelector,
@encode(GTLServiceTicket *), @encode(unsigned long long),
@encode(unsigned long long), 0);
GTMAssertSelectorNilOrImplementedWithArgs(delegate, ticket.retrySelector,
@encode(GTLServiceTicket *), @encode(BOOL), @encode(NSError *), 0);
SEL finishedSel = @selector(objectFetcher:finishedWithData:error:);
ticket.postedObject = bodyObject;
ticket.executingQuery = query;
if (ticket.originalQuery == nil) {
ticket.originalQuery = query;
}
GTMHTTPFetcherService *fetcherService = self.fetcherService;
GTMHTTPFetcher *fetcher;
GTLUploadParameters *uploadParams = query.uploadParameters;
if (uploadParams == nil) {
// Not uploading a file with this request
fetcher = [fetcherService fetcherWithRequest:request];
} else {
fetcher = [self uploadFetcherWithRequest:request
fetcherService:fetcherService
params:uploadParams];
}
if (finishedSelector) {
// if we don't have a method name, default to the finished selector as
// a useful fetcher log comment
fetcher.comment = NSStringFromSelector(finishedSelector);
}
// allow the user to specify static app-wide cookies for fetching
NSInteger cookieStorageMethod = [self cookieStorageMethod];
if (cookieStorageMethod >= 0) {
fetcher.cookieStorageMethod = cookieStorageMethod;
}
if (!mayAuthorize) {
fetcher.authorizer = nil;
}
// copy the ticket's retry settings into the fetcher
fetcher.retryEnabled = ticket.retryEnabled;
fetcher.maxRetryInterval = ticket.maxRetryInterval;
BOOL shouldExamineRetries;
#if NS_BLOCKS_AVAILABLE
shouldExamineRetries = (ticket.retrySelector != nil
|| ticket.retryBlock != nil);
#else
shouldExamineRetries = (ticket.retrySelector != nil);
#endif
if (shouldExamineRetries) {
[fetcher setRetrySelector:@selector(objectFetcher:willRetry:forError:)];
}
// remember the object fetcher in the ticket
ticket.objectFetcher = fetcher;
// add parameters used by the callbacks
[fetcher setProperty:objectClass forKey:kFetcherObjectClassKey];
[fetcher setProperty:delegate forKey:kFetcherDelegateKey];
[fetcher setProperty:NSStringFromSelector(finishedSelector)
forKey:kFetcherFinishedSelectorKey];
[fetcher setProperty:ticket
forKey:kFetcherTicketKey];
#if NS_BLOCKS_AVAILABLE
// copy the completion handler block to the heap; this does nothing if the
// block is already on the heap
completionHandler = [[completionHandler copy] autorelease];
[fetcher setProperty:completionHandler
forKey:kFetcherCompletionHandlerKey];
#endif
// set the upload data
fetcher.postData = dataToPost;
// failed fetches call the failure selector, which will delete the ticket
BOOL didFetch = [fetcher beginFetchWithDelegate:self
didFinishSelector:finishedSel];
// If something weird happens and the networking callbacks have been called
// already synchronously, we don't want to return the ticket since the caller
// will never know when to stop retaining it, so we'll make sure the
// success/failure callbacks have not yet been called by checking the
// ticket
if (!didFetch || ticket.hasCalledCallback) {
fetcher.properties = nil;
return nil;
}
return ticket;
}
- (GTMHTTPUploadFetcher *)uploadFetcherWithRequest:(NSURLRequest *)request
fetcherService:(GTMHTTPFetcherService *)fetcherService
params:(GTLUploadParameters *)uploadParams {
// Hang on to the user's requested chunk size, and ensure it's not tiny
NSUInteger uploadChunkSize = [self serviceUploadChunkSize];
if (uploadChunkSize < kMinimumUploadChunkSize) {
uploadChunkSize = kMinimumUploadChunkSize;
}
#ifdef GTL_TARGET_NAMESPACE
// Prepend the class name prefix
Class uploadClass = NSClassFromString(@GTL_TARGET_NAMESPACE_STRING
"_GTMHTTPUploadFetcher");
#else
Class uploadClass = NSClassFromString(@"GTMHTTPUploadFetcher");
#endif
GTL_ASSERT(uploadClass != nil, @"GTMHTTPUploadFetcher needed");
NSString *uploadMIMEType = uploadParams.MIMEType;
NSData *uploadData = uploadParams.data;
NSFileHandle *uploadFileHandle = uploadParams.fileHandle;
NSURL *uploadLocationURL = uploadParams.uploadLocationURL;
GTMHTTPUploadFetcher *fetcher;
if (uploadData) {
fetcher = [uploadClass uploadFetcherWithRequest:request
uploadData:uploadData
uploadMIMEType:uploadMIMEType
chunkSize:uploadChunkSize
fetcherService:fetcherService];
} else if (uploadLocationURL) {
GTL_DEBUG_ASSERT(uploadFileHandle != nil,
@"Resume requires a file handle");
fetcher = [uploadClass uploadFetcherWithLocation:uploadLocationURL
uploadFileHandle:uploadFileHandle
uploadMIMEType:uploadMIMEType
chunkSize:uploadChunkSize
fetcherService:fetcherService];
} else {
fetcher = [uploadClass uploadFetcherWithRequest:request
uploadFileHandle:uploadFileHandle
uploadMIMEType:uploadMIMEType
chunkSize:uploadChunkSize
fetcherService:fetcherService];
}
NSString *slug = [uploadParams slug];
if ([slug length] > 0) {
[[fetcher mutableRequest] setValue:slug forHTTPHeaderField:@"Slug"];
}
return fetcher;
}
#pragma mark -
// RPC fetch methods
- (NSDictionary *)rpcPayloadForMethodNamed:(NSString *)methodName
parameters:(NSDictionary *)parameters
bodyObject:(GTLObject *)bodyObject
requestID:(NSString *)requestID {
GTL_DEBUG_ASSERT([requestID length] > 0, @"Got an empty request id");
// First, merge the developer key and bodyObject into the parameters.
NSString *apiKey = self.APIKey;
NSUInteger apiKeyLen = [apiKey length];
NSString *const kDeveloperAPIParamKey = @"key";
NSString *const kBodyObjectParamKey = @"resource";
NSDictionary *finalParams;
if ((apiKeyLen == 0) && (bodyObject == nil)) {
// Nothing needs to be added, just send the dict along.
finalParams = parameters;
} else {
NSMutableDictionary *worker = [NSMutableDictionary dictionary];
if ([parameters count] > 0) {
[worker addEntriesFromDictionary:parameters];
}
if ((apiKeyLen > 0)
&& ([worker objectForKey:kDeveloperAPIParamKey] == nil)) {
[worker setObject:apiKey forKey:kDeveloperAPIParamKey];
}
if (bodyObject != nil) {
GTL_DEBUG_ASSERT([parameters objectForKey:kBodyObjectParamKey] == nil,
@"There was already something under the 'data' key?!");
NSMutableDictionary *json = [bodyObject JSON];
if (json != nil) {
[worker setObject:json forKey:kBodyObjectParamKey];
}
}
finalParams = worker;
}
// Now, build up the full dictionary for the JSON-RPC (this is the body of
// the HTTP PUT).
// Spec calls for the jsonrpc entry. Google doesn't require it, but include
// it so the code can work with other servers.
NSMutableDictionary *rpcPayload = [NSMutableDictionary dictionaryWithObjectsAndKeys:
@"2.0", @"jsonrpc",
methodName, @"method",
requestID, @"id",
nil];
// Google extension, provide the version of the api.
NSString *apiVersion = self.apiVersion;
if ([apiVersion length] > 0) {
[rpcPayload setObject:apiVersion forKey:@"apiVersion"];
}
if ([finalParams count] > 0) {
[rpcPayload setObject:finalParams forKey:@"params"];
}
return rpcPayload;
}
- (GTLServiceTicket *)fetchObjectWithMethodNamed:(NSString *)methodName
objectClass:(Class)objectClass
parameters:(NSDictionary *)parameters
bodyObject:(GTLObject *)bodyObject
requestID:(NSString *)requestID
urlQueryParameters:(NSDictionary *)urlQueryParameters
delegate:(id)delegate
didFinishSelector:(SEL)finishedSelector
completionHandler:(id)completionHandler // GTLServiceCompletionHandler
executingQuery:(id<GTLQueryProtocol>)executingQuery
ticket:(GTLServiceTicket *)ticket {
GTL_DEBUG_ASSERT([methodName length] > 0, @"Got an empty method name");
if ([methodName length] == 0) return nil;
// If we didn't get a requestID, assign one (call came from one of the public
// calls that doesn't take a GTLQuery object).
if (requestID == nil) {
requestID = [GTLQuery nextRequestID];
}
NSData *dataToPost = nil;
GTLUploadParameters *uploadParameters = executingQuery.uploadParameters;
BOOL shouldSendBody = !uploadParameters.shouldSendUploadOnly;
if (shouldSendBody) {
NSDictionary *rpcPayload = [self rpcPayloadForMethodNamed:methodName
parameters:parameters
bodyObject:bodyObject
requestID:requestID];
NSError *error = nil;
dataToPost = [GTLJSONParser dataWithObject:rpcPayload
humanReadable:NO
error:&error];
if (dataToPost == nil) {
// There is the chance something went into parameters that wasn't valid.
GTL_DEBUG_LOG(@"JSON generation error: %@", error);
return nil;
}
}
BOOL isUploading = (uploadParameters != nil);
NSURL *rpcURL = (isUploading ? self.rpcUploadURL : self.rpcURL);
if ([urlQueryParameters count] > 0) {
rpcURL = [GTLUtilities URLWithString:[rpcURL absoluteString]
queryParameters:urlQueryParameters];
}
BOOL mayAuthorize = (executingQuery ?
!executingQuery.shouldSkipAuthorization : YES);
GTLServiceTicket *resultTicket = [self fetchObjectWithURL:rpcURL
objectClass:objectClass
bodyObject:bodyObject
dataToPost:dataToPost
ETag:nil
httpMethod:@"POST"
mayAuthorize:mayAuthorize
isREST:NO
delegate:delegate
didFinishSelector:finishedSelector
completionHandler:completionHandler
executingQuery:executingQuery
ticket:ticket];
// Set the fetcher log comment to default to the method name
NSUInteger pageNumber = resultTicket.pagesFetchedCounter;
if (pageNumber == 0) {
resultTicket.objectFetcher.comment = methodName;
} else {
// Also put the page number in the log comment
[resultTicket.objectFetcher setCommentWithFormat:@"%@ (page %lu)",
methodName, (unsigned long) (pageNumber + 1)];
}
return resultTicket;
}
- (GTLServiceTicket *)executeBatchQuery:(GTLBatchQuery *)batch
delegate:(id)delegate
didFinishSelector:(SEL)finishedSelector
completionHandler:(id)completionHandler // GTLServiceCompletionHandler
ticket:(GTLServiceTicket *)ticket {
GTLBatchQuery *batchCopy = [[batch copy] autorelease];
NSArray *queries = batchCopy.queries;
NSUInteger numberOfQueries = [queries count];
if (numberOfQueries == 0) return nil;
// Build up the array of RPC calls.
NSMutableArray *rpcPayloads = [NSMutableArray arrayWithCapacity:numberOfQueries];
NSMutableArray *requestIDs = [NSMutableSet setWithCapacity:numberOfQueries];
for (GTLQuery *query in queries) {
NSString *methodName = query.methodName;
NSDictionary *parameters = query.JSON;
GTLObject *bodyObject = query.bodyObject;
NSString *requestID = query.requestID;
if ([methodName length] == 0 || [requestID length] == 0) {
GTL_DEBUG_ASSERT(0, @"Invalid query - id:%@ method:%@",
requestID, methodName);
return nil;
}
GTL_DEBUG_ASSERT(query.additionalHTTPHeaders == nil,
@"additionalHTTPHeaders disallowed on queries added to a batch - query %@ (%@)",
requestID, methodName);
GTL_DEBUG_ASSERT(query.uploadParameters == nil,
@"uploadParameters disallowed on queries added to a batch - query %@ (%@)",
requestID, methodName);
NSDictionary *rpcPayload = [self rpcPayloadForMethodNamed:methodName
parameters:parameters
bodyObject:bodyObject
requestID:requestID];
[rpcPayloads addObject:rpcPayload];
if ([requestIDs containsObject:requestID]) {
GTL_DEBUG_LOG(@"Duplicate request id in batch: %@", requestID);
return nil;
}
[requestIDs addObject:requestID];
}
NSError *error = nil;
NSData *dataToPost = nil;
dataToPost = [GTLJSONParser dataWithObject:rpcPayloads
humanReadable:NO
error:&error];
if (dataToPost == nil) {
// There is the chance something went into parameters that wasn't valid.
GTL_DEBUG_LOG(@"JSON generation error: %@", error);
return nil;
}
BOOL mayAuthorize = (batchCopy ? !batchCopy.shouldSkipAuthorization : YES);
// urlQueryParameters on the queries are currently unsupport during a batch
// as it's not clear how to map them.
NSURL *rpcURL = self.rpcURL;
GTLServiceTicket *resultTicket = [self fetchObjectWithURL:rpcURL
objectClass:[GTLBatchResult class]
bodyObject:nil
dataToPost:dataToPost
ETag:nil
httpMethod:@"POST"
mayAuthorize:mayAuthorize
isREST:NO
delegate:delegate
didFinishSelector:finishedSelector
completionHandler:completionHandler
executingQuery:batch
ticket:ticket];
#if !STRIP_GTM_FETCH_LOGGING
// Set the fetcher log comment
//
// Because this has expensive set operations, it's conditionally
// compiled in
NSArray *methodNames = [queries valueForKey:@"methodName"];
methodNames = [[NSSet setWithArray:methodNames] allObjects]; // de-dupe
NSString *methodsStr = [methodNames componentsJoinedByString:@", "];
NSUInteger pageNumber = ticket.pagesFetchedCounter;
NSString *pageStr = @"";
if (pageNumber > 0) {
pageStr = [NSString stringWithFormat:@"page %lu, ",
(unsigned long) pageNumber + 1];
}
[resultTicket.objectFetcher setCommentWithFormat:@"batch: %@ (%@%lu queries)",
methodsStr, pageStr, (unsigned long) numberOfQueries];
#endif
return resultTicket;
}
#pragma mark -
// REST fetch methods
- (GTLServiceTicket *)fetchObjectWithURL:(NSURL *)targetURL
objectClass:(Class)objectClass
bodyObject:(GTLObject *)bodyObject
ETag:(NSString *)etag
httpMethod:(NSString *)httpMethod
mayAuthorize:(BOOL)mayAuthorize
delegate:(id)delegate
didFinishSelector:(SEL)finishedSelector
completionHandler:(id)completionHandler // GTLServiceCompletionHandler
ticket:(GTLServiceTicket *)ticket {
// if no URL was supplied, treat this as if the fetch failed (below)
// and immediately return a nil ticket, skipping the callbacks
//
// this might be considered normal (say, updating a read-only entry
// that lacks an edit link) though higher-level calls may assert or
// return errors depending on the specific usage
if (targetURL == nil) return nil;
NSData *dataToPost = nil;
if (bodyObject != nil) {
NSError *error = nil;
NSDictionary *whatToSend;
NSDictionary *json = bodyObject.JSON;
if (isRESTDataWrapperRequired_) {
// create the top-level "data" object
NSDictionary *dataDict = [NSDictionary dictionaryWithObject:json
forKey:@"data"];
whatToSend = dataDict;
} else {
whatToSend = json;
}
dataToPost = [GTLJSONParser dataWithObject:whatToSend
humanReadable:NO
error:&error];
if (dataToPost == nil) {
GTL_DEBUG_LOG(@"JSON generation error: %@", error);
}
}
return [self fetchObjectWithURL:targetURL
objectClass:objectClass
bodyObject:bodyObject
dataToPost:dataToPost
ETag:etag
httpMethod:httpMethod
mayAuthorize:mayAuthorize
isREST:YES
delegate:delegate
didFinishSelector:finishedSelector
completionHandler:completionHandler
executingQuery:nil
ticket:ticket];
}
- (void)invokeProgressCallbackForTicket:(GTLServiceTicket *)ticket
deliveredBytes:(unsigned long long)numReadSoFar
totalBytes:(unsigned long long)total {
SEL progressSelector = [ticket uploadProgressSelector];
if (progressSelector) {
GTMHTTPFetcher *fetcher = ticket.objectFetcher;
id delegate = [fetcher propertyForKey:kFetcherDelegateKey];
NSMethodSignature *signature = [delegate methodSignatureForSelector:progressSelector];
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
[invocation setSelector:progressSelector];
[invocation setTarget:delegate];
[invocation setArgument:&ticket atIndex:2];
[invocation setArgument:&numReadSoFar atIndex:3];
[invocation setArgument:&total atIndex:4];
[invocation invoke];
}
#if NS_BLOCKS_AVAILABLE
GTLServiceUploadProgressBlock block = ticket.uploadProgressBlock;
if (block) {
block(ticket, numReadSoFar, total);
}
#endif
}
// sentData callback from fetcher
- (void)objectFetcher:(GTMHTTPFetcher *)fetcher
didSendBytes:(NSInteger)bytesSent
totalBytesSent:(NSInteger)totalBytesSent
totalBytesExpectedToSend:(NSInteger)totalBytesExpected {
GTLServiceTicket *ticket = [fetcher propertyForKey:kFetcherTicketKey];
[self invokeProgressCallbackForTicket:ticket
deliveredBytes:(unsigned long long)totalBytesSent
totalBytes:(unsigned long long)totalBytesExpected];
}
- (void)objectFetcher:(GTMHTTPFetcher *)fetcher finishedWithData:(NSData *)data error:(NSError *)error {
// we now have the JSON data for an object, or an error
if (error == nil) {
if ([data length] > 0) {
[self prepareToParseObjectForFetcher:fetcher];
} else {
// no data (such as when deleting)
[self handleParsedObjectForFetcher:fetcher];
}
} else {
// There was an error from the fetch
NSInteger status = [error code];
if (status >= 300) {
// Return the HTTP error status code along with a more descriptive error
// from within the HTTP response payload.
NSData *responseData = fetcher.downloadedData;
if ([responseData length] > 0) {
NSDictionary *responseHeaders = fetcher.responseHeaders;
NSString *contentType = [responseHeaders objectForKey:@"Content-Type"];
if ([data length] > 0) {
if ([contentType hasPrefix:@"application/json"]) {
NSError *parseError = nil;
NSMutableDictionary *jsonWrapper = [GTLJSONParser objectWithData:data
error:&parseError];
if (parseError) {
// We could not parse the JSON payload
error = parseError;
} else {
// Convert the JSON error payload into a structured error
NSMutableDictionary *errorJSON = [jsonWrapper valueForKey:@"error"];
GTLErrorObject *errorObject = [GTLErrorObject objectWithJSON:errorJSON];
error = [errorObject foundationError];
}
} else {
// No structured JSON error was available; make a plaintext server
// error response visible in the error object.
NSString *reasonStr = [[[NSString alloc] initWithData:data
encoding:NSUTF8StringEncoding] autorelease];
NSDictionary *userInfo = [NSDictionary dictionaryWithObject:reasonStr
forKey:NSLocalizedFailureReasonErrorKey];
error = [NSError errorWithDomain:kGTMHTTPFetcherStatusDomain
code:status
userInfo:userInfo];
}
} else {
// Response data length is zero; we'll settle for returning the
// fetcher's error.
}
}
}
// store the error, call the callbacks, and bail
[fetcher setProperty:error