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

   1 //
   2 //  PithosSyncDaemon.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 #import <Foundation/Foundation.h>
  39 @class PithosAccount;
  40 @class ASIPithos;
  41 @class PithosActivityFacility;
  42 @class ASINetworkQueue;
  43
  44 @interface PithosSyncDaemon : NSObject {
  45     NSString *directoryPath;
  46     PithosAccount *pithosAccount;
  47     NSDictionary *containersDictionary;
  48     ASIPithos *pithos;
  49
  50     NSUInteger containersCount;
  51     NSMutableArray *pithosContainers;
  52     NSUInteger containersIndex;
  53
  54     NSMutableArray *objects;
  55     NSMutableDictionary *remoteObjects;
  56     NSMutableDictionary *previousRemoteObjects;
  57     NSMutableDictionary *storedLocalObjectStates;
  58     NSMutableDictionary *currentLocalObjectStates;
  59
  60     NSString *pithosStateFilePath;
  61     NSString *tempDownloadsDirPath;
  62     NSString *tempTrashDirPath;
  63
  64     BOOL daemonActive;
  65
  66     NSUInteger syncOperationCount;
  67     BOOL newSyncRequested;
  68     NSDate *lastCompletedSync;
  69     BOOL syncIncomplete;
  70     BOOL syncLate;
  71
  72     ASINetworkQueue *networkQueue;
  73     NSOperationQueue *callbackQueue;
  74
  75     PithosActivityFacility *activityFacility;
  76 }
  77
  78 @property (nonatomic, retain) NSString *directoryPath;
  79 @property (nonatomic, retain) NSDictionary *containersDictionary;
  80 @property (nonatomic, retain) ASIPithos *pithos;
  81
  82 @property (nonatomic, retain) NSMutableArray *pithosContainers;
  83
  84 @property (nonatomic, retain) NSMutableDictionary *remoteObjects;
  85 @property (nonatomic, retain) NSMutableDictionary *previousRemoteObjects;
  86 @property (nonatomic, retain) NSMutableDictionary *storedLocalObjectStates;
  87 @property (nonatomic, retain) NSMutableDictionary *currentLocalObjectStates;
  88
  89 @property (nonatomic, readonly) NSString *pithosStateFilePath;
  90 @property (nonatomic, readonly) NSString *tempDownloadsDirPath;
  91 @property (nonatomic, readonly) NSString *tempTrashDirPath;
  92
  93 @property (nonatomic, retain) NSDate *lastCompletedSync;
  94
  95 // containersDictionary contains entries with keys the container names that should be included
  96 // and values NSArrays that contain the directory names that should be excluded
  97 // (also container root file objects with these names)
  98 // An empty string denotes that all file objects in the container root should be excluded
  99 // Case insensitive filesystem is assumed, so directory names should be in lowercase
 100 // and any trailing '/' should be replaced by ':'
 101 - (id)initWithDirectoryPath:(NSString *)aDirectoryPath
 102               pithosAccount:(PithosAccount *)aPithosAccount
 103        containersDictionary:(NSDictionary *)aContainersDictionary
 104             resetLocalState:(BOOL)resetLocalState;
 105
 106 - (void)resetDaemon;
 107 - (void)startDaemon;
 108
 109 - (void)sync;
 110 - (BOOL)isSyncing;
 111 - (void)syncLate;
 112
 113 @end