@ -11,6 +11,7 @@ public enum GarbageCollectionJob: JobExecutor {
public static var maxFailureCount : Int = - 1
public static var requiresThreadId : Bool = false
public static let requiresInteractionId : Bool = false
private static let approxSixMonthsInSeconds : TimeInterval = ( 6 * 30 * 24 * 60 * 60 )
public static func run (
_ job : Job ,
@ -26,7 +27,216 @@ public enum GarbageCollectionJob: JobExecutor {
return
}
failure ( job , JobRunnerError . missingRequiredDetails , true )
// I f t h e r e a r e n o t y p e s t o c o l l e c t t h e n c o m p l e t e t h e j o b ( a n d n e v e r r u n a g a i n - i t d o e s n ' t d o a n y t h i n g )
guard ! details . typesToCollect . isEmpty else {
success ( job , true )
return
}
let timestampNow : TimeInterval = Date ( ) . timeIntervalSince1970
var attachmentLocalRelativePaths : Set < String > = [ ]
var profileAvatarFilenames : Set < String > = [ ]
GRDBStorage . shared . writeAsync (
updates : { db in
// R e m o v e a n y e x p i r e d c o n t r o l M e s s a g e P r o c e s s R e c o r d s
if details . typesToCollect . contains ( . expiredControlMessageProcessRecords ) {
_ = try ControlMessageProcessRecord
. filter ( ControlMessageProcessRecord . Columns . serverExpirationTimestamp <= timestampNow )
. deleteAll ( db )
}
// R e m o v e a n y t y p i n g i n d i c a t o r s
if details . typesToCollect . contains ( . threadTypingIndicators ) {
_ = try ThreadTypingIndicator
. deleteAll ( db )
}
// R e m o v e a n y t y p i n g i n d i c a t o r s
if details . typesToCollect . contains ( . oldOpenGroupMessages ) {
let interaction : TypedTableAlias < Interaction > = TypedTableAlias ( )
let thread : TypedTableAlias < SessionThread > = TypedTableAlias ( )
try db . execute ( literal : " " "
DELETE FROM \ ( Interaction . self )
WHERE \ ( Column . rowID ) IN (
SELECT \ ( interaction . alias [ Column . rowID ] )
FROM \ ( Interaction . self )
JOIN \ ( SessionThread . self ) ON (
\ ( SQL ( " \( thread [ . variant ] ) = \( SessionThread . Variant . openGroup ) " ) ) AND
\ ( thread [ . id ] ) = \ ( interaction [ . threadId ] )
)
WHERE \ ( interaction [ . timestampMs ] ) < \ ( timestampNow - approxSixMonthsInSeconds )
)
" " " )
}
// O r p h a n e d j o b s
if details . typesToCollect . contains ( . orphanedJobs ) {
let job : TypedTableAlias < Job > = TypedTableAlias ( )
let thread : TypedTableAlias < SessionThread > = TypedTableAlias ( )
let interaction : TypedTableAlias < Interaction > = TypedTableAlias ( )
try db . execute ( literal : " " "
DELETE FROM \ ( Job . self )
WHERE \ ( Column . rowID ) IN (
SELECT \ ( job . alias [ Column . rowID ] )
FROM \ ( Job . self )
LEFT JOIN \ ( SessionThread . self ) ON \ ( thread [ . id ] ) = \ ( job [ . threadId ] )
LEFT JOIN \ ( Interaction . self ) ON \ ( interaction [ . id ] ) = \ ( job [ . interactionId ] )
WHERE (
(
\ ( job [ . threadId ] ) IS NOT NULL AND
\ ( thread [ . id ] ) IS NULL
) OR (
\ ( job [ . interactionId ] ) IS NOT NULL AND
\ ( interaction [ . id ] ) IS NULL
)
)
)
" " " )
}
// O r p h a n e d l i n k p r e v i e w s
if details . typesToCollect . contains ( . orphanedLinkPreviews ) {
let linkPreview : TypedTableAlias < LinkPreview > = TypedTableAlias ( )
let interaction : TypedTableAlias < Interaction > = TypedTableAlias ( )
try db . execute ( literal : " " "
DELETE FROM \ ( LinkPreview . self )
WHERE \ ( Column . rowID ) IN (
SELECT \ ( linkPreview . alias [ Column . rowID ] )
FROM \ ( LinkPreview . self )
LEFT JOIN \ ( Interaction . self ) ON (
\ ( interaction [ . linkPreviewUrl ] ) = \ ( linkPreview [ . url ] ) AND
\ ( Interaction . linkPreviewFilterLiteral ( ) )
)
WHERE \ ( interaction [ . id ] ) IS NULL
)
" " " )
}
// O r p h a n e d a t t a c h m e n t s
if details . typesToCollect . contains ( . orphanedAttachments ) {
let attachment : TypedTableAlias < Attachment > = TypedTableAlias ( )
let quote : TypedTableAlias < Quote > = TypedTableAlias ( )
let linkPreview : TypedTableAlias < LinkPreview > = TypedTableAlias ( )
let interactionAttachment : TypedTableAlias < InteractionAttachment > = TypedTableAlias ( )
try db . execute ( literal : " " "
DELETE FROM \ ( Attachment . self )
WHERE \ ( Column . rowID ) IN (
SELECT \ ( attachment . alias [ Column . rowID ] )
FROM \ ( Attachment . self )
LEFT JOIN \ ( Quote . self ) ON \ ( quote [ . attachmentId ] ) = \ ( attachment [ . id ] )
LEFT JOIN \ ( LinkPreview . self ) ON \ ( linkPreview [ . attachmentId ] ) = \ ( attachment [ . id ] )
LEFT JOIN \ ( InteractionAttachment . self ) ON \ ( interactionAttachment [ . attachmentId ] ) = \ ( attachment [ . id ] )
WHERE (
\ ( quote [ . attachmentId ] ) IS NULL AND
\ ( linkPreview [ . url ] ) IS NULL AND
\ ( interactionAttachment [ . attachmentId ] ) IS NULL
)
)
" " " )
}
// O r p h a n e d a t t a c h m e n t f i l e s
if details . typesToCollect . contains ( . orphanedAttachmentFiles ) {
// / * * N o t e : * * T h u m b n a i l s a r e s t o r e d i n t h e ` N S C a c h e s D i r e c t o r y ` d i r e c t o r y w h i c h s h o u l d b e a u t o m a t i c a l l y m a n a g e
// / i t ' s o w n g a r b a g e c o l l e c t i o n s o w e c a n j u s t i g n o r e i t a c c o r d i n g t o t h e v a r i o u s c o m m e n t s i n t h e f o l l o w i n g s t a c k o v e r f l o w
// / p o s t , t h e d i r e c t o r y w i l l b e c l e a r e d d u r i n g a p p u p d a t e s a s w e l l a s i f t h e s y s t e m i s r u n n i n g l o w o n m e m o r y ( i f t h e a p p i s n ' t r u n n i n g )
// / h t t p s : / / s t a c k o v e r f l o w . c o m / q u e s t i o n s / 6 8 7 9 8 6 0 / w h e n - a r e - f i l e s - f r o m - n s c a c h e s d i r e c t o r y - r e m o v e d
attachmentLocalRelativePaths = try Attachment
. select ( . localRelativeFilePath )
. filter ( Attachment . Columns . localRelativeFilePath != nil )
. asRequest ( of : String . self )
. fetchSet ( db )
}
// O r p h a n e d p r o f i l e a v a t a r f i l e s
if details . typesToCollect . contains ( . orphanedProfileAvatars ) {
profileAvatarFilenames = try Profile
. select ( . profilePictureFileName )
. filter ( Profile . Columns . profilePictureFileName != nil )
. asRequest ( of : String . self )
. fetchSet ( db )
}
} ,
completion : { _ , _ in
var deletionErrors : [ Error ] = [ ]
// O r p h a n e d a t t a c h m e n t f i l e s ( a c t u a l d e l e t i o n )
if details . typesToCollect . contains ( . orphanedAttachmentFiles ) {
// N o t e : L o o k s l i k e i n o r d e r t o r e c u r s i v e l y l o o k t h r o u g h f i l e s w e n e e d t o u s e t h e
// e n u m e r a t o r m e t h o d
let fileEnumerator = FileManager . default . enumerator (
at : URL ( fileURLWithPath : Attachment . attachmentsFolder ) ,
includingPropertiesForKeys : nil ,
options : . skipsHiddenFiles // I g n o r e t h e ` . D S _ S t o r e ` f o r t h e s i m u l a t o r
)
let allAttachmentFilePaths : Set < String > = ( fileEnumerator ?
. allObjects
. compactMap { Attachment . localRelativeFilePath ( from : ( $0 as ? URL ) ? . path ) } )
. defaulting ( to : [ ] )
. asSet ( )
// N o t e : D i r e c t o r i e s w i l l h a v e t h e i r o w n e n t r i e s i n t h e l i s t , i f t h e r e i s a f o l d e r w i t h c o n t e n t
// t h e f i l e w i l l i n c l u d e t h e d i r e c t o r y i n i t ' s p a t h w i t h a f o r w a r d s l a s h s o w e c a n u s e t h i s t o
// d i s t i n g u i s h e m p t y d i r e c t o r i e s f r o m o n e s w i t h c o n t e n t s o w e d o n ' t u n i n t e n t i o n a l l y d e l e t e a
// d i r e c t o r y w h i c h c o n t a i n s c o n t e n t t o k e e p a s w e l l a s d e l e t e ( d i r e c t o r i e s w h i c h e n d u p e m p t y a f t e r
// t h i s c l e a n u p w i l l b e r e m o v e d d u r i n g t h e n e x t r u n )
let directoryNamesContainingContent : [ String ] = allAttachmentFilePaths
. filter { path -> Bool in path . contains ( " / " ) }
. compactMap { path -> String ? in path . components ( separatedBy : " / " ) . first }
let orphanedAttachmentFiles : Set < String > = allAttachmentFilePaths
. subtracting ( attachmentLocalRelativePaths )
. subtracting ( directoryNamesContainingContent )
orphanedAttachmentFiles . forEach { filepath in
// W e d o n ' t w a n t a s i n g l e d e l e t i o n f a i l u r e t o b l o c k d e l e t i o n o f t h e o t h e r f i l e s s o t r y
// e a c h o n e a n d s t o r e t h e e r r o r t o b e u s e d t o d e t e r m i n e s u c c e s s / f a i l u r e o f t h e j o b
do {
try FileManager . default . removeItem (
atPath : URL ( fileURLWithPath : Attachment . attachmentsFolder )
. appendingPathComponent ( filepath )
. path
)
}
catch { deletionErrors . append ( error ) }
}
}
// O r p h a n e d p r o f i l e a v a t a r f i l e s ( a c t u a l d e l e t i o n )
if details . typesToCollect . contains ( . orphanedProfileAvatars ) {
let allAvatarProfileFilenames : Set < String > = ( try ? FileManager . default
. contentsOfDirectory ( atPath : ProfileManager . sharedDataProfileAvatarsDirPath ) )
. defaulting ( to : [ ] )
. asSet ( )
let orphanedAvatarFiles : Set < String > = allAvatarProfileFilenames
. subtracting ( profileAvatarFilenames )
orphanedAvatarFiles . forEach { filename in
// W e d o n ' t w a n t a s i n g l e d e l e t i o n f a i l u r e t o b l o c k d e l e t i o n o f t h e o t h e r f i l e s s o t r y
// e a c h o n e a n d s t o r e t h e e r r o r t o b e u s e d t o d e t e r m i n e s u c c e s s / f a i l u r e o f t h e j o b
do {
try FileManager . default . removeItem (
atPath : ProfileManager . profileAvatarFilepath ( filename : filename )
)
}
catch { deletionErrors . append ( error ) }
}
}
// R e p o r t a s i n g l e f i l e d e l e t i o n a s a j o b f a i l u r e ( e v e n i f o t h e r c o n t e n t w a s s u c c e s s f u l l y r e m o v e d )
guard deletionErrors . isEmpty else {
failure ( job , ( deletionErrors . first ? ? StorageError . generic ) , false )
return
}
success ( job , false )
}
)
}
}
@ -34,12 +244,14 @@ public enum GarbageCollectionJob: JobExecutor {
extension GarbageCollectionJob {
public enum Types : Codable , CaseIterable {
case oldOpenGroupMessages
case expiredControlMessageProcessRecords
case threadTypingIndicators
case oldOpenGroupMessages
case orphanedJobs
case orphanedLinkPreviews
case orphanedAttachments
case orphanedAttachmentFiles
case orphanedProfileAvatars
case orphanedLinkPreviews
}
public struct Details : Codable {
Morgan Pretty
3 years ago