/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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. */ #import "CMISBrowserVersioningService.h" #import "CMISRequest.h" #import "CMISBrowserConstants.h" #import "CMISHttpResponse.h" #import "CMISBrowserUtil.h" #import "CMISURLUtil.h" #import "CMISConstants.h" #import "CMISErrors.h" #import "CMISBroswerFormDataWriter.h" #import "CMISFileUtil.h" #import "CMISLog.h" #import "CMISBrowserTypeCache.h" #import "CMISObjectList.h" @implementation CMISBrowserVersioningService - (CMISRequest*)retrieveObjectOfLatestVersion:(NSString *)objectId major:(BOOL)major filter:(NSString *)filter relationships:(CMISIncludeRelationship)relationships includePolicyIds:(BOOL)includePolicyIds renditionFilter:(NSString *)renditionFilter includeACL:(BOOL)includeACL includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void (^)(CMISObjectData *objectData, NSError *error))completionBlock { NSString *objectUrl = [self retrieveObjectUrlForObjectWithId:objectId selector:kCMISBrowserJSONSelectorObject]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterFilter value:filter urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterIncludeAllowableActions boolValue:includeAllowableActions urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterIncludeRelationships value:[CMISEnums stringForIncludeRelationShip:relationships] urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterRenditionFilter value:renditionFilter urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterIncludePolicyIds boolValue:includePolicyIds urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterIncludeAcl boolValue:includeACL urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterReturnVersion value:[CMISEnums stringForReturnVersion:major] urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISBrowserJSONParameterSuccinct value:kCMISParameterValueTrue urlString:objectUrl]; CMISRequest *cmisRequest = [[CMISRequest alloc] init]; [self.bindingSession.networkProvider invokeGET:[NSURL URLWithString:objectUrl] session:self.bindingSession cmisRequest:cmisRequest completionBlock:^(CMISHttpResponse *httpResponse, NSError *error) { if (httpResponse.statusCode == 200 && httpResponse.data) { CMISBrowserTypeCache *typeCache = [[CMISBrowserTypeCache alloc] initWithRepositoryId:self.bindingSession.repositoryId bindingService:self]; NSError *parsingError = nil; [CMISBrowserUtil objectDataFromJSONData:httpResponse.data typeCache:typeCache completionBlock:^(CMISObjectData *objectData, NSError *error) { if (error) { completionBlock(nil, parsingError); } else { completionBlock(objectData, nil); } }]; } else { completionBlock(nil, error); } }]; return cmisRequest; } - (CMISRequest*)retrieveAllVersions:(NSString *)objectId filter:(NSString *)filter includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void (^)(NSArray *objects, NSError *error))completionBlock { NSString *objectUrl = [self retrieveObjectUrlForObjectWithId:objectId selector:kCMISBrowserJSONSelectorVersions]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterFilter value:filter urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISParameterIncludeAllowableActions value:(includeAllowableActions ? @"true" : @"false") urlString:objectUrl]; objectUrl = [CMISURLUtil urlStringByAppendingParameter:kCMISBrowserJSONParameterSuccinct value:@"true" urlString:objectUrl]; CMISRequest *cmisRequest = [[CMISRequest alloc] init]; [self.bindingSession.networkProvider invokeGET:[NSURL URLWithString:objectUrl] session:self.bindingSession cmisRequest:cmisRequest completionBlock:^(CMISHttpResponse *httpResponse, NSError *error) { if (httpResponse.statusCode == 200 && httpResponse.data) { CMISBrowserTypeCache *typeCache = [[CMISBrowserTypeCache alloc] initWithRepositoryId:self.bindingSession.repositoryId bindingService:self]; [CMISBrowserUtil objectListFromJSONData:httpResponse.data typeCache:typeCache isQueryResult:NO completionBlock:^(CMISObjectList *objectList, NSError *error) { if (error) { completionBlock(nil, error); } else { completionBlock(objectList.objects, nil); } }]; } else { completionBlock(nil, error); } }]; return cmisRequest; } /** * Create a private working copy of a document given an object identifier. * * @param objectId * @param completionBlock returns PWC object data or nil */ - (CMISRequest*)checkOut:(NSString *)objectId completionBlock:(void (^)(CMISObjectData *objectData, NSError *error))completionBlock { // we need an object id if ((objectId == nil) || (objectId.length == 0)) { completionBlock(nil, [CMISErrors createCMISErrorWithCode:kCMISErrorCodeInvalidArgument detailedDescription:@"Object id must be set!"]); } // build URL NSString *objectUrl = [self retrieveObjectUrlForObjectWithId:objectId]; // prepare form data CMISBroswerFormDataWriter *formData = [[CMISBroswerFormDataWriter alloc] initWithAction:kCMISBrowserJSONActionCheckOut]; [formData addSuccinctFlag:true]; CMISRequest *cmisRequest = [[CMISRequest alloc] init]; // send [self.bindingSession.networkProvider invokePOST:[NSURL URLWithString:objectUrl] session:self.bindingSession body:formData.body headers:formData.headers cmisRequest:cmisRequest completionBlock:^(CMISHttpResponse *httpResponse, NSError *error) { if ((httpResponse.statusCode == 200 || httpResponse.statusCode == 201) && httpResponse.data) { CMISBrowserTypeCache *typeCache = [[CMISBrowserTypeCache alloc] initWithRepositoryId:self.bindingSession.repositoryId bindingService:self]; [CMISBrowserUtil objectDataFromJSONData:httpResponse.data typeCache:typeCache completionBlock:^(CMISObjectData *objectData, NSError *error) { if (error) { completionBlock(nil, error); } else { completionBlock(objectData, nil); } }]; } else { completionBlock(nil, error); } }]; return cmisRequest; } /** * Reverses the effect of a check-out. * * @param objectId * @param completionBlock returns object data or nil */ - (CMISRequest*)cancelCheckOut:(NSString *)objectId completionBlock:(void (^)(BOOL checkOutCancelled, NSError *error))completionBlock { // we need an object id if ((objectId == nil) || (objectId.length == 0)) { completionBlock(NO, [CMISErrors createCMISErrorWithCode:kCMISErrorCodeInvalidArgument detailedDescription:@"Object id must be set!"]); } // build URL NSString *objectUrl = [self retrieveObjectUrlForObjectWithId:objectId]; // prepare form data CMISBroswerFormDataWriter *formData = [[CMISBroswerFormDataWriter alloc] initWithAction:kCMISBrowserJSONActionCancelCheckOut]; CMISRequest *cmisRequest = [[CMISRequest alloc] init]; // send [self.bindingSession.networkProvider invokePOST:[NSURL URLWithString:objectUrl] session:self.bindingSession body:formData.body headers:formData.headers cmisRequest:cmisRequest completionBlock:^(CMISHttpResponse *httpResponse, NSError *error) { if ((httpResponse.statusCode == 200 || httpResponse.statusCode == 201) && httpResponse.data) { completionBlock(YES, nil); } else { completionBlock(NO, error); } }]; return cmisRequest; } /** * Checks-in the private working copy (PWC) document from the given path. * * @param objectId the identifier for the PWC * @param asMajorVersion indicator if the new version should become a major (YES) or minor (NO) version * @param filePath (optional) Path to the file containing the content to be uploaded * @param mimeType (optional) Mime type of the content to be uploaded * @param properties (optional) the property values that must be applied to the checked-in document object * @param checkinComment (optional) a version comment * @param completionBlock returns object data or nil * @param progressBlock periodic file upload status */ - (CMISRequest*)checkIn:(NSString *)objectId asMajorVersion:(BOOL)asMajorVersion filePath:(NSString *)filePath mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void (^)(CMISObjectData *objectData, NSError *error))completionBlock progressBlock:(void (^)(unsigned long long bytesUploaded, unsigned long long bytesTotal))progressBlock { NSInputStream *inputStream = [NSInputStream inputStreamWithFileAtPath:filePath]; if (inputStream == nil) { CMISLogError(@"Could not find file %@", filePath); if (completionBlock) { completionBlock(nil, [CMISErrors createCMISErrorWithCode:kCMISErrorCodeInvalidArgument detailedDescription:nil]); } return nil; } NSError *fileError = nil; unsigned long long fileSize = [CMISFileUtil fileSizeForFileAtPath:filePath error:&fileError]; if (fileError) { CMISLogError(@"Could not determine size of file %@: %@", filePath, [fileError description]); } return [self checkIn:objectId asMajorVersion:asMajorVersion inputStream:inputStream bytesExpected:fileSize mimeType:mimeType properties:properties checkinComment:checkinComment completionBlock:completionBlock progressBlock:progressBlock]; } /** * Checks-in the private working copy (PWC) document from the given an input stream. * * @param objectId the identifier for the PWC * @param asMajorVersion indicator if the new version should become a major (YES) or minor (NO) version * @param inputStream (optional) Input stream containing the content to be uploaded * @param bytesExpected The size of content to be uploaded (must be provided if an inputStream is given) * @param mimeType (optional) Mime type of the content to be uploaded * @param properties (optional) the property values that must be applied to the checked-in document object * @param checkinComment (optional) a version comment * @param completionBlock returns object data or nil * @param progressBlock periodic file upload status */ - (CMISRequest*)checkIn:(NSString *)objectId asMajorVersion:(BOOL)asMajorVersion inputStream:(NSInputStream *)inputStream bytesExpected:(unsigned long long)bytesExpected mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void (^)(CMISObjectData *objectData, NSError *error))completionBlock progressBlock:(void (^)(unsigned long long bytesUploaded, unsigned long long bytesTotal))progressBlock { // we need an object id if ((objectId == nil) || (objectId.length == 0)) { completionBlock(nil, [CMISErrors createCMISErrorWithCode:kCMISErrorCodeInvalidArgument detailedDescription:@"Object id must be set!"]); } // Validate mimetype if (inputStream && !mimeType) { CMISLogError(@"Must provide a mimetype when creating a cmis document"); if (completionBlock) { completionBlock(nil, [CMISErrors createCMISErrorWithCode:kCMISErrorCodeInvalidArgument detailedDescription:nil]); } return nil; } // build URL NSString *objectUrl = [self retrieveObjectUrlForObjectWithId:objectId]; // prepare form data CMISBroswerFormDataWriter *formData = [[CMISBroswerFormDataWriter alloc] initWithAction:kCMISBrowserJSONActionCheckIn contentStream:inputStream mediaType:mimeType]; [formData addParameter:kCMISParameterMajor boolValue:asMajorVersion]; [formData addPropertiesParameters:properties]; [formData addParameter:kCMISParameterCheckinComment value:checkinComment]; // TODO [formData addParameter:kCMISParameterVersioningState value:versioningState]; // TODO [formData addPoliciesParameters:policies]; // TODO [formData addAddAcesParameters:addAces]; // TODO [formData addRemoveAcesParameters:removeAces]; [formData addSuccinctFlag:true]; CMISRequest *cmisRequest = [[CMISRequest alloc] init]; // send [self.bindingSession.networkProvider invoke:[NSURL URLWithString:objectUrl] httpMethod:HTTP_POST session:self.bindingSession inputStream:inputStream headers:formData.headers bytesExpected:bytesExpected cmisRequest:cmisRequest startData:formData.startData endData:formData.endData useBase64Encoding:NO completionBlock:^(CMISHttpResponse *httpResponse, NSError *error) { if ((httpResponse.statusCode == 200 || httpResponse.statusCode == 201) && httpResponse.data) { CMISBrowserTypeCache *typeCache = [[CMISBrowserTypeCache alloc] initWithRepositoryId:self.bindingSession.repositoryId bindingService:self]; [CMISBrowserUtil objectDataFromJSONData:httpResponse.data typeCache:typeCache completionBlock:^(CMISObjectData *objectData, NSError *error) { if (error) { completionBlock(nil, error); } else { completionBlock(objectData, nil); } }]; } else { completionBlock(nil, error); } } progressBlock:progressBlock]; return cmisRequest; } @end