Bucket.h

/*
 Copyright (c) 2009-2017, Haystack Software LLC https://www.arqbackup.com
 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 
 * Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 
 * Neither the names of PhotoMinds LLC or Haystack Software, nor the names of
 their contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */




#import "StorageType.h"
@class AWSRegion;
@class DictNode;
@class BucketExcludeSet;
@class BackupParamSet;
@class Target;
@class BufferedInputStream;
@class BufferedOutputStream;
@protocol TargetConnectionDelegate;
@class TargetConnection;


@protocol BucketActivityListener <NSObject>
- (void)bucketActivity:(NSString *)theActivity;
@end

enum {
    BucketPathMixedState = -1,
    BucketPathOffState   =  0,
    BucketPathOnState    =  1
};
typedef NSInteger BucketPathState;

@interface Bucket : NSObject <NSCopying> {
    Target *target;
    NSString *bucketUUID;
    NSString *bucketName;
    NSString *computerUUID;
    NSString *localPath;
    NSString *localMountPoint;
    StorageType storageType;
    NSMutableArray *ignoredRelativePaths;
    BucketExcludeSet *excludeSet;
    NSString *vaultName;
    NSDate *vaultCreatedDate;
    NSDate *plistDeletedDate;
    BOOL skipDuringBackup;
    BOOL excludeItemsWithTimeMachineExcludeMetadataFlag;
    BOOL skipIfNotMounted;
}

+ (NSArray *)bucketsWithTarget:(Target *)theTarget
                  computerUUID:(NSString *)theComputerUUID
            encryptionPassword:(NSString *)theEncryptionPassword
      targetConnectionDelegate:(id <TargetConnectionDelegate>)theTCD
                         error:(NSError **)error;

+ (NSArray *)bucketsWithTarget:(Target *)theTarget
                  computerUUID:(NSString *)theComputerUUID
            encryptionPassword:(NSString *)theEncryptionPassword
      targetConnectionDelegate:(id <TargetConnectionDelegate>)theTCD
              activityListener:(id <BucketActivityListener>)theActivityListener
                         error:(NSError **)error;

+ (NSArray *)bucketUUIDsWithTarget:(Target *)theTarget
                      computerUUID:(NSString *)theComputerUUID
          targetConnectionDelegate:(id <TargetConnectionDelegate>)theTCD
                             error:(NSError **)error;

+ (NSString *)errorDomain;

- (id)initWithTarget:(Target *)theTarget
          bucketUUID:(NSString *)theBucketUUID
          bucketName:(NSString *)theBucketName
        computerUUID:(NSString *)theComputerUUID
           localPath:(NSString *)theLocalPath
     localMountPoint:(NSString *)theLocalMountPoint
         storageType:(int)theStorageType;
- (id)initWithBufferedInputStream:(BufferedInputStream *)theBIS error:(NSError **)error;


- (Target *)target;
- (NSString *)computerUUID;
- (NSString *)bucketUUID;
- (NSString *)bucketName;
- (NSString *)localPath;
- (StorageType)storageType;
- (NSString *)localMountPoint;
- (BucketExcludeSet *)bucketExcludeSet;
- (NSString *)vaultName;
- (NSDate *)vaultCreatedDate;
- (NSDate *)plistDeletedDate;
- (BOOL)skipDuringBackup;
- (BOOL)excludeItemsWithTimeMachineExcludeMetadataFlag;
- (BucketPathState)stateForPath:(NSString *)thePath ignoreExcludes:(BOOL)ignoreExcludes;
- (NSSet *)ignoredRelativePaths;
- (BOOL)skipIfNotMounted;
- (NSData *)toXMLData;
- (BOOL)writeTo:(BufferedOutputStream *)theBOS error:(NSError **)error;
- (void)writeTo:(NSMutableData *)data;
@end