609d203bc054155e69e6920f441e9a7b89fc76fe
[pithos-macos] / pithos-macos / PithosFileUtilities.h
1 //
2 //  PithosFileUtilities.h
3 //  pithos-macos
4 //
5 // Copyright 2011 GRNET S.A. All rights reserved.
6 //
7 // Redistribution and use in source and binary forms, with or
8 // without modification, are permitted provided that the following
9 // conditions are met:
10 // 
11 //   1. Redistributions of source code must retain the above
12 //      copyright notice, this list of conditions and the following
13 //      disclaimer.
14 // 
15 //   2. Redistributions in binary form must reproduce the above
16 //      copyright notice, this list of conditions and the following
17 //      disclaimer in the documentation and/or other materials
18 //      provided with the distribution.
19 // 
20 // THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
21 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
24 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
27 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 // AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 // POSSIBILITY OF SUCH DAMAGE.
32 // 
33 // The views and conclusions contained in the software and
34 // documentation are those of the authors and should not be
35 // interpreted as representing official policies, either expressed
36 // or implied, of GRNET S.A.
37
38 @class ASIPithosRequest;
39 @class ASIPithosObjectRequest;
40
41 @interface PithosFileUtilities : NSObject
42
43 + (ASIPithosObjectRequest *)objectDataRequestWithContainerName:(NSString *)containerName 
44                                                     objectName:(NSString *)objectName 
45                                                    toDirectory:(NSString *)directoryPath 
46                                                  checkIfExists:(BOOL)ifExists;
47 + (NSArray *)objectDataRequestsForSubdirWithContainerName:(NSString *)containerName 
48                                                objectName:(NSString *)objectName 
49                                               toDirectory:(NSString *)directoryPath 
50                                             checkIfExists:(BOOL)ifExists;
51
52 + (ASIPithosObjectRequest *)writeObjectDataRequestWithContainerName:(NSString *)containerName
53                                                          objectName:(NSString *)objectName
54                                                         contentType:(NSString *)contentType 
55                                                           blockSize:(NSUInteger)blockSize 
56                                                           blockHash:(NSString *)blockHash 
57                                                             forFile:(NSString *)filePath 
58                                                       checkIfExists:(BOOL)ifExists 
59                                                              hashes:(NSArray **)hashes;
60 + (NSIndexSet *)missingBlocksForHashes:(NSArray *)hashes withMissingHashesResponse:(NSString *)missingHashesResponse;
61 + (ASIPithosObjectRequest *)updateObjectDataRequestWithContainerName:(NSString *)containerName 
62                                                           objectName:(NSString *)objectName 
63                                                            blockSize:(NSUInteger)blockSize 
64                                                              forFile:(NSString *)filePath 
65                                                               hashes:(NSArray *)hashes 
66                                                missingHashesResponse:(NSString *)missingHashesResponse;
67 + (ASIPithosObjectRequest *)updateObjectDataRequestWithContainerName:(NSString *)containerName 
68                                                           objectName:(NSString *)objectName 
69                                                            blockSize:(NSUInteger)blockSize 
70                                                              forFile:(NSString *)filePath 
71                                                    missingBlockIndex:(NSUInteger)missingBlockIndex;
72 + (NSArray *)writeObjectDataRequestsWithContainerName:(NSString *)containerName
73                                            objectName:(NSString *)objectName
74                                             blockSize:(NSUInteger)blockSize 
75                                             blockHash:(NSString *)blockHash 
76                                          forDirectory:(NSString *)directoryPath 
77                                         checkIfExists:(BOOL)ifExists 
78                                           objectNames:(NSMutableArray **)objectNames
79                                          contentTypes:(NSMutableArray **)contentTypes
80                                             filePaths:(NSMutableArray **)filePaths 
81                                          hashesArrays:(NSMutableArray **)hashesArrays 
82                               directoryObjectRequests:(NSMutableArray **) directoryObjectRequests;
83
84 + (NSArray *)deleteObjectRequestsForSubdirWithContainerName:(NSString *)containerName objectName:(NSString *)objectName;
85 + (NSArray *)moveObjectRequestsForSubdirWithContainerName:(NSString *)containerName 
86                                                objectName:(NSString *)objectName 
87                                  destinationContainerName:(NSString *)destinationContainerName 
88                                     destinationObjectName:(NSString *)destinationObjectName;
89
90 + (NSUInteger)bytesOfFile:(NSString *)filePath;
91 + (NSString *)contentTypeOfFile:(NSString *)filePath error:(NSError **)error;
92 + (BOOL)objectExistsAtContainerName:(NSString *)containerName objectName:(NSString *)objectName
93                               error:(NSError **)error isDirectory:(BOOL *)isDirectory;
94 + (NSArray *)objectsWithContainerName:(NSString *)containerName objectNamePrefix:(NSString *)objectNamePrefix
95                             delimiter:(NSString *)delimiter;
96 + (NSArray *)objectsForSubdirWithContainerName:(NSString *)containerName objectName:(NSString *)objectName
97                                      delimiter:(NSString *)delimiter;
98 + (NSString *)safeObjectNameForContainerName:(NSString *)containerName objectName:(NSString *)objectName;
99 + (NSString *)safeSubdirNameForContainerName:(NSString *)containerName subdirName:(NSString *)subdirName;
100
101 + (NSInteger)httpRequestErrorAlertWithRequest:(ASIPithosRequest *)request;
102 + (NSInteger)unexpectedResponseStatusAlertWithRequest:(ASIPithosRequest *)request;
103
104 @end