threema-ios/Threema/DatabaseManager.h

//  _____ _
// |_   _| |_  _ _ ___ ___ _ __  __ _
//   | | | ' \| '_/ -_) -_) '  \/ _` |_
//   |_| |_||_|_| \___\___|_|_|_\__,_(_)
//
// Threema iOS Client
// Copyright (c) 2015-2020 Threema GmbH
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License, version 3,
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

#import <Foundation/Foundation.h>
#import <CoreData/CoreData.h>
#import "DatabaseContext.h"

@interface DatabaseManager : NSObject

@property (strong, nonatomic) NSManagedObjectModel *managedObjectModel;
@property (strong, nonatomic) NSPersistentStoreCoordinator *persistentStoreCoordinator;

@property (readonly) NSError *storeError;

+ (instancetype)dbManager;

/**
 Get database context for the application.
 
 @param forBackgroundProcess    YES means it will be create a private context
*/
- (DatabaseContext *)getDatabaseContext:(BOOL)forBackgroundProcess;

+ (NSURL *)storeUrl;

+ (BOOL)storeExists;

- (BOOL)storeRequiresMigration;

- (BOOL)storeRequiresImport;

- (NSError *)storeError;

- (BOOL)canMigrateDB;

- (void)doMigrateDB;

- (void)copyImportedDatabase;

- (void)eraseDB;

- (BOOL)shouldUpdateProtection;

- (void)updateProtection;

- (void)disableBackupForDatabaseDirectory:(BOOL)disable;

- (void)refreshDirtyObjectIDs:(NSDictionary *)changes intoContext:(NSManagedObjectContext *)context;

- (void)refreshDirtyObjects;

- (void)addDirtyObject:(NSManagedObject *)object;

/**
 Replace database and external data with version in applicationDocuments/ThreemaDataOldVersion, for testing database migration.
*/
- (BOOL)copyOldVersionOfDatabase;

@end