session-ios/SignalServiceKit/src/Storage/OWSOrphanedDataCleaner.h

//
//  Copyright (c) 2017 Open Whisper Systems. All rights reserved.
//

NS_ASSUME_NONNULL_BEGIN

// Notes:
//
// * On disk, we only bother cleaning up files, not directories.
// * For code simplicity, we don't guarantee that everything is
//   cleaned up in a single pass. If an interaction is cleaned up,
//   it's attachments might not be cleaned up until the next pass.
//   If an attachment is cleaned up, it's file on disk might not
//   be cleaned up until the next pass.
@interface OWSOrphanedDataCleaner : NSObject

- (instancetype)init NS_UNAVAILABLE;

+ (void)auditAsync;

// completion, if present, will be invoked on the main thread.
+ (void)auditAndCleanupAsync:(void (^_Nullable)(void))completion;

+ (NSSet<NSString *> *)filePathsInAttachmentsFolder;

+ (long long)fileSizeOfFilePaths:(NSArray<NSString *> *)filePaths;

@end

NS_ASSUME_NONNULL_END
Run orphan cleanup on startup. // FREEBIE 2017-07-04 18:42:33 +02:00			`//`
			`// Copyright (c) 2017 Open Whisper Systems. All rights reserved.`
			`//`
Ensure interactions removed when thread is deleted In theory, this should have already been handled by the YapDatabaseRelationship extension via edges. However, in practice, there were situations (cause unknown) where interactions would exist without an edge to their corresponding thread. Rather than being clever with the edge/callback machinery, now threads explicitly delete all their interactions, and interactions delete all their attachments (when applicable). Also, a class to clean up spurious interactions / attachments In the process: - refactored TSYapDatabaseObject init to specify designated initializer - added some testing niceties to TSYapDatabaseObject // FREEBIE 2016-07-28 04:29:27 +02:00
Fix broken tests. // FREEBIE 2017-07-07 16:26:09 +02:00			`NS_ASSUME_NONNULL_BEGIN`

			`// Notes:`
			`//`
			`// * On disk, we only bother cleaning up files, not directories.`
			`// * For code simplicity, we don't guarantee that everything is`
			`// cleaned up in a single pass. If an interaction is cleaned up,`
			`// it's attachments might not be cleaned up until the next pass.`
			`// If an attachment is cleaned up, it's file on disk might not`
			`// be cleaned up until the next pass.`
Ensure interactions removed when thread is deleted In theory, this should have already been handled by the YapDatabaseRelationship extension via edges. However, in practice, there were situations (cause unknown) where interactions would exist without an edge to their corresponding thread. Rather than being clever with the edge/callback machinery, now threads explicitly delete all their interactions, and interactions delete all their attachments (when applicable). Also, a class to clean up spurious interactions / attachments In the process: - refactored TSYapDatabaseObject init to specify designated initializer - added some testing niceties to TSYapDatabaseObject // FREEBIE 2016-07-28 04:29:27 +02:00			`@interface OWSOrphanedDataCleaner : NSObject`

Run orphan cleanup on startup. // FREEBIE 2017-07-04 18:42:33 +02:00			`- (instancetype)init NS_UNAVAILABLE;`

			`+ (void)auditAsync;`

Fix broken tests. // FREEBIE 2017-07-07 16:26:09 +02:00			`// completion, if present, will be invoked on the main thread.`
Proper function prototypes // FREEBIE 2017-12-01 01:57:56 +01:00			`+ (void)auditAndCleanupAsync:(void (^_Nullable)(void))completion;`
Fix broken tests. // FREEBIE 2017-07-07 16:26:09 +02:00
			`+ (NSSet<NSString > )filePathsInAttachmentsFolder;`

			`+ (long long)fileSizeOfFilePaths:(NSArray<NSString > )filePaths;`
Ensure interactions removed when thread is deleted In theory, this should have already been handled by the YapDatabaseRelationship extension via edges. However, in practice, there were situations (cause unknown) where interactions would exist without an edge to their corresponding thread. Rather than being clever with the edge/callback machinery, now threads explicitly delete all their interactions, and interactions delete all their attachments (when applicable). Also, a class to clean up spurious interactions / attachments In the process: - refactored TSYapDatabaseObject init to specify designated initializer - added some testing niceties to TSYapDatabaseObject // FREEBIE 2016-07-28 04:29:27 +02:00
			`@end`
Fix broken tests. // FREEBIE 2017-07-07 16:26:09 +02:00
			`NS_ASSUME_NONNULL_END`