FileManager.h

Go to the documentation of this file.

//
//  FileManager.h
//  MicroStrategyMobile
//
//  Created by Amirali Charania on 10/31/11.
//  Copyright 2011 MicroStrategy Inc. All rights reserved.
//

#import <UIKit/UIKit.h>

@protocol FileManager

+(id<FileManager>)fileManager;

-(BOOL)createDirectoryAtPath:(NSString*)path withIntermediateDirectories:(BOOL)createIntermediates
                  attributes:(NSDictionary*)attributes error:(NSError**)error;

-(NSArray*)contentsOfDirectoryAtPath:(NSString*)path error:(NSError**)error;

-(NSArray*)subpathsAtPath:(NSString *)path;

-(BOOL)fileExistsAtPath:(NSString*)path;
-(BOOL)fileExistsAtPath:(NSString*)path isDirectory:(BOOL*)isDirectory;

-(BOOL)setAttributes:(NSDictionary *)attributes ofItemAtPath:(NSString*)path error:(NSError **)error;

-(NSDictionary *)attributesOfItemAtPath:(NSString *)path error:(NSError **)error;

-(NSData*)readDataAtPath:(NSString*)path error:(NSError**)error;
-(NSData*)readDataWithoutEncryptionAtPath:(NSString*)path error:(NSError**)error;

-(size_t)readData:(void*)dataBuf atPath:(NSString*)path offset:(long)offset
           length:(size_t)length error:(NSError**)error;
-(size_t)readDataInBuffer:(void**)dataBuf atPath:(NSString*)path offset:(long)offset
                   length:(size_t)length error:(NSError**)error;

-(NSInteger)writeData:(NSData*)data atPath:(NSString*)path error:(NSError**)error;
-(NSInteger)appendData:(NSData*)data atPath:(NSString*)path error:(NSError**)error;
-(NSInteger)writeDataWithoutEncryption:(NSData*)data atPath:(NSString*)path error:(NSError**)error; // DE96741, custom widget files ignore file encryption for both write/read

-(BOOL)createFileAtPath:(NSString*)path contents:(NSData*)contents attributes:(NSDictionary*)attributes;

-(void)writeDictionary:(NSDictionary*)dictionary toFileAtPath:(NSString*)filePath;

-(NSDictionary*)dictionaryAtFilePath:(NSString*)filePath;


//APIs to read/write/append data from a specific file without protection. These APIs are used to read/write/append data when device is locked. At this point, the data is not encrypted, data encryption could be done in these method if necessary.
-(NSData*)readDataWithNoProtectionAtPath:(NSString*)path error:(NSError**)error encrypt:(bool)encrypt;

-(NSInteger)writeDataWithNoProtection:(NSData*)data atPath:(NSString*)path error:(NSError**)error encrypt:(bool)encrypt;
-(NSInteger)appendDataWithNoProtection:(NSData*)data atPath:(NSString*)path error:(NSError**)error encrypt:(bool)encrypt;

-(NSOutputStream*)newOutputStreamToFileAtPath:(NSString*)filePath append:(BOOL)append;

-(NSInputStream*)newInputStreamWithFileAtPath:(NSString*)filePath;

-(NSInteger)moveItemAtPath:(NSString*)path toPath:(NSString*)toPath error:(NSError**)error;
-(NSInteger)copyItemAtPath:(NSString*)path toPath:(NSString*)toPath error:(NSError**)error;

-(NSInteger)deleteDataAtPath:(NSString*)path error:(NSError**)error;
-(BOOL)removeItemAtPath:(NSString*)path error:(NSError**)error;

-(void)clearTmpDirectory;

-(NSString*)documentDirectory;
-(NSString*)cachesDirectory;
-(NSString*)libraryDirectory;
-(NSString*)tempDirectory;

-(void)waitUntilUnlockOperationIsFinished;

-(BOOL)isMappedFileSupported;

-(long long)decryptDataAtPath:(NSString*)path;

-(size_t)incrementalDecryptSoftwareEncryptedDataAtPath:(NSString *)path error:(NSError **)error;

- (NSString *) decryptedExternalFileForFileAtPath:(NSString *)encryptedFilePath;

- (void) removeDecryptedFileForFile:(NSString *)file;
@end