code.grnet.gr Git - pithos-macos/blob - pithos-macos/PithosUtilities.h

   1 //
   2 //  PithosUtilities.h
   3 //  pithos-macos
   4 //
   5 // Copyright 2011-2012 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 ASIPithos;
  40 @class ASIPithosContainerRequest;
  41 @class ASIPithosObjectRequest;
  42 @class ASIPithosObject;
  43
  44 @interface PithosUtilities : NSObject
  45
  46 + (ASIPithosObjectRequest *)objectDataRequestWithPithos:(ASIPithos *)pithos
  47                                           containerName:(NSString *)containerName
  48                                              objectName:(NSString *)objectName
  49                                             toDirectory:(NSString *)directoryPath
  50                                           checkIfExists:(BOOL)ifExists
  51                                          sharingAccount:(NSString *)sharingAccount;
  52 + (NSArray *)objectDataRequestsForSubdirWithPithos:(ASIPithos *)pithos
  53                                      containerName:(NSString *)containerName
  54                                         objectName:(NSString *)objectName
  55                                        toDirectory:(NSString *)directoryPath
  56                                      checkIfExists:(BOOL)ifExists
  57                                     sharingAccount:(NSString *)sharingAccount;
  58
  59 + (ASIPithosObjectRequest *)objectBlockDataRequestWithPithos:(ASIPithos *)pithos
  60                                                containerName:(NSString *)containerName
  61                                                       object:(ASIPithosObject *)object
  62                                                   blockIndex:(NSUInteger)blockIndex
  63                                                    blockSize:(NSUInteger)blockSize;
  64 + (NSIndexSet *)missingBlocksForFile:(NSString *)filePath
  65                            blockSize:(NSUInteger)blockSize
  66                            blockHash:(NSString *)blockHash
  67                           withHashes:(NSArray *)hashes;
  68
  69 + (ASIPithosObjectRequest *)writeObjectDataRequestWithPithos:(ASIPithos *)pithos
  70                                                containerName:(NSString *)containerName
  71                                                   objectName:(NSString *)objectName
  72                                                  contentType:(NSString *)contentType
  73                                                    blockSize:(NSUInteger)blockSize
  74                                                    blockHash:(NSString *)blockHash
  75                                                      forFile:(NSString *)filePath
  76                                                checkIfExists:(BOOL)ifExists
  77                                                       hashes:(NSArray **)hashes
  78                                               sharingAccount:(NSString *)sharingAccount;
  79 + (NSIndexSet *)missingBlocksForHashes:(NSArray *)hashes withMissingHashes:(NSArray *)missingHashes;
  80 + (ASIPithosContainerRequest *)updateContainerDataRequestWithPithos:(ASIPithos *)pithos
  81                                                       containerName:(NSString *)containerName
  82                                                           blockSize:(NSUInteger)blockSize
  83                                                             forFile:(NSString *)filePath
  84                                                              hashes:(NSArray *)hashes
  85                                                       missingHashes:(NSArray *)missingHashes
  86                                                      sharingAccount:(NSString *)sharingAccount;
  87 + (ASIPithosContainerRequest *)updateContainerDataRequestWithPithos:(ASIPithos *)pithos
  88                                                       containerName:(NSString *)containerName
  89                                                           blockSize:(NSUInteger)blockSize
  90                                                             forFile:(NSString *)filePath
  91                                                   missingBlockIndex:(NSUInteger)missingBlockIndex
  92                                                      sharingAccount:(NSString *)sharingAccount;
  93 + (NSArray *)writeObjectDataRequestsWithPithos:(ASIPithos *)pithos
  94                                  containerName:(NSString *)containerName
  95                                     objectName:(NSString *)objectName
  96                                      blockSize:(NSUInteger)blockSize
  97                                      blockHash:(NSString *)blockHash
  98                                   forDirectory:(NSString *)directoryPath
  99                                  checkIfExists:(BOOL)ifExists
 100                                    objectNames:(NSMutableArray **)objectNames
 101                                   contentTypes:(NSMutableArray **)contentTypes
 102                                      filePaths:(NSMutableArray **)filePaths
 103                                   hashesArrays:(NSMutableArray **)hashesArrays
 104                        directoryObjectRequests:(NSMutableArray **) directoryObjectRequests
 105                                 sharingAccount:(NSString *)sharingAccount;
 106
 107 + (NSArray *)deleteObjectRequestsForSubdirWithPithos:(ASIPithos *)pithos
 108                                        containerName:(NSString *)containerName
 109                                           objectName:(NSString *)objectName;
 110
 111 + (ASIPithosObjectRequest *)copyObjectRequestWithPithos:(ASIPithos *)pithos
 112                                           containerName:(NSString *)containerName
 113                                              objectName:(NSString *)objectName
 114                                destinationContainerName:(NSString *)destinationContainerName
 115                                   destinationObjectName:(NSString *)destinationObjectName
 116                                           checkIfExists:(BOOL)ifExists
 117                                          sharingAccount:(NSString *)sharingAccount;
 118 + (NSArray *)copyObjectRequestsForSubdirWithPithos:(ASIPithos *)pithos
 119                                      containerName:(NSString *)containerName
 120                                         objectName:(NSString *)objectName
 121                           destinationContainerName:(NSString *)destinationContainerName
 122                              destinationObjectName:(NSString *)destinationObjectName
 123                                      checkIfExists:(BOOL)ifExists
 124                                     sharingAccount:(NSString *)sharingAccount;
 125
 126 + (ASIPithosObjectRequest *)moveObjectRequestWithPithos:(ASIPithos *)pithos
 127                                           containerName:(NSString *)containerName
 128                                              objectName:(NSString *)objectName
 129                                destinationContainerName:(NSString *)destinationContainerName
 130                                   destinationObjectName:(NSString *)destinationObjectName
 131                                           checkIfExists:(BOOL)ifExists;
 132 + (NSArray *)moveObjectRequestsForSubdirWithPithos:(ASIPithos *)pithos
 133                                      containerName:(NSString *)containerName
 134                                         objectName:(NSString *)objectName
 135                           destinationContainerName:(NSString *)destinationContainerName
 136                              destinationObjectName:(NSString *)destinationObjectName
 137                                      checkIfExists:(BOOL)ifExists;
 138
 139 + (NSUInteger)bytesOfFile:(NSString *)filePath;
 140 + (NSString *)contentTypeOfFile:(NSString *)filePath error:(NSError **)error;
 141 + (BOOL)safeCreateDirectory:(NSString *)directoryPath error:(NSError **)error;
 142 + (BOOL)isContentTypeDirectory:(NSString *)contentType;
 143 + (BOOL)objectExistsAtPithos:(ASIPithos *)pithos containerName:(NSString *)containerName objectName:(NSString *)objectName
 144                        error:(NSError **)error isDirectory:(BOOL *)isDirectory sharingAccount:(NSString *)sharingAccount;
 145 + (BOOL)proceedIfObjectExistsAtPithos:(ASIPithos *)pithos containerName:(NSString *)containerName objectName:(NSString *)objectName
 146                        sharingAccount:(NSString *)sharingAccount;
 147 + (NSArray *)objectsWithPithos:(ASIPithos *)pithos containerName:(NSString *)containerName objectNamePrefix:(NSString *)objectNamePrefix
 148                      delimiter:(NSString *)delimiter sharingAccount:(NSString *)sharingAccount;
 149 + (NSArray *)objectsForSubdirWithPithos:(ASIPithos *)pithos containerName:(NSString *)containerName objectName:(NSString *)objectName
 150                               delimiter:(NSString *)delimiter sharingAccount:(NSString *)sharingAccount;
 151 + (NSString *)safeObjectNameForPithos:(ASIPithos *)pithos containerName:(NSString *)containerName objectName:(NSString *)objectName;
 152 + (NSString *)safeSubdirNameForPithos:(ASIPithos *)pithos containerName:(NSString *)containerName subdirName:(NSString *)subdirName;
 153
 154 + (NSInteger)httpRequestErrorAlertWithRequest:(ASIPithosRequest *)request;
 155 + (NSInteger)unexpectedResponseStatusAlertWithRequest:(ASIPithosRequest *)request;
 156 + (NSInteger)fileActionFailedAlertWithTitle:(NSString *)title message:(NSString *)message error:(NSError *)error;
 157
 158 + (ASIPithosRequest *)prepareRequest:(ASIPithosRequest *)request priority:(NSOperationQueuePriority)priority;
 159 + (ASIPithosRequest *)prepareRequest:(ASIPithosRequest *)request;
 160 + (ASIPithosRequest *)copyRequest:(ASIPithosRequest *)request;
 161
 162 @end