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 *accountsDictionary;
  48     ASIPithos *pithos;
  49
  50     NSDictionary *containersDictionary;
  51     NSUInteger containersCount;
  52     NSMutableArray *pithosContainers;
  53     NSUInteger containersIndex;
  54
  55     NSMutableArray *objects;
  56     NSMutableDictionary *remoteObjects;
  57     NSMutableDictionary *previousRemoteObjects;
  58     NSMutableDictionary *storedLocalObjectStates;
  59     NSMutableDictionary *currentLocalObjectStates;
  60
  61     NSString *pithosStateFilePath;
  62     NSString *tempDownloadsDirPath;
  63     NSString *tempTrashDirPath;
  64
  65     BOOL daemonActive;
  66
  67     NSUInteger syncOperationCount;
  68     BOOL newSyncRequested;
  69     NSDate *lastCompletedSync;
  70     BOOL syncIncomplete;
  71     BOOL syncLate;
  72
  73     ASINetworkQueue *networkQueue;
  74     NSOperationQueue *callbackQueue;
  75
  76     PithosActivityFacility *activityFacility;
  77 }
  78
  79 @property (nonatomic, retain) NSString *directoryPath;
  80 @property (nonatomic, retain) NSDictionary *accountsDictionary;
  81 @property (nonatomic, retain) ASIPithos *pithos;
  82
  83 @property (nonatomic, retain) NSDictionary *containersDictionary;
  84 @property (nonatomic, retain) NSMutableArray *pithosContainers;
  85
  86 @property (nonatomic, retain) NSMutableDictionary *remoteObjects;
  87 @property (nonatomic, retain) NSMutableDictionary *previousRemoteObjects;
  88 @property (nonatomic, retain) NSMutableDictionary *storedLocalObjectStates;
  89 @property (nonatomic, retain) NSMutableDictionary *currentLocalObjectStates;
  90
  91 @property (nonatomic, readonly) NSString *pithosStateFilePath;
  92 @property (nonatomic, readonly) NSString *tempDownloadsDirPath;
  93 @property (nonatomic, readonly) NSString *tempTrashDirPath;
  94
  95 @property (nonatomic, retain) NSDate *lastCompletedSync;
  96
  97 // accountsDictionary contains entries of the form
  98 // { <included sharing account name> : { <included container name> : [ <excluded directory names> ] } }
  99 // <included sharing account name> :
 100 //     the empty string "" denotes the user's own account
 101 // <excluded directory names> :
 102 //     the empty string "" denotes all file objects in the container root
 103 //     non-empty strings denote also container root file objects with these names
 104 // Case insensitive filesystem is assumed, so directory names should be in lowercase
 105 // and any trailing '/' should be replaced by ':'
 106 - (id)initWithDirectoryPath:(NSString *)aDirectoryPath
 107               pithosAccount:(PithosAccount *)aPithosAccount
 108          accountsDictionary:(NSDictionary *)anAccountsDictionary
 109             resetLocalState:(BOOL)resetLocalState;
 110
 111 - (void)resetDaemon;
 112 - (void)startDaemon;
 113
 114 - (void)sync;
 115 - (BOOL)isSyncing;
 116 - (void)syncLate;
 117
 118 @end