Import export settings

2025-08-09 20:24:06 +00:00 · 2024-02-01 23:54:16 +01:00
parent 9826ee4d36
commit 2be6f04e37
46 changed files with 2801 additions and 169 deletions
--- a/Settings/Exporters/AdvancedSettingsGroupExporter.swift
+++ b/Settings/Exporters/AdvancedSettingsGroupExporter.swift
@@ -0,0 +1,16 @@
+import Defaults
+import SwiftyJSON
+
+final class AdvancedSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "showPlayNowInBackendContextMenu": Defaults[.showPlayNowInBackendContextMenu],
+            "showMPVPlaybackStats": Defaults[.showMPVPlaybackStats],
+            "mpvEnableLogging": Defaults[.mpvEnableLogging],
+            "mpvCacheSecs": Defaults[.mpvCacheSecs],
+            "mpvCachePauseWait": Defaults[.mpvCachePauseWait],
+            "showCacheStatus": Defaults[.showCacheStatus],
+            "feedCacheSize": Defaults[.feedCacheSize]
+        ]
+    }
+}
--- a/Settings/Exporters/BrowsingSettingsGroupExporter.swift
+++ b/Settings/Exporters/BrowsingSettingsGroupExporter.swift
@@ -0,0 +1,54 @@
+import Defaults
+import SwiftyJSON
+
+final class BrowsingSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "showHome": Defaults[.showHome],
+            "showOpenActionsInHome": Defaults[.showOpenActionsInHome],
+            "showQueueInHome": Defaults[.showQueueInHome],
+            "showFavoritesInHome": Defaults[.showFavoritesInHome],
+            "favorites": Defaults[.favorites].compactMap { jsonFromString(FavoriteItem.bridge.serialize($0)) },
+            "widgetsSettings": Defaults[.widgetsSettings].compactMap { widgetSettingsJSON($0) },
+            "startupSection": Defaults[.startupSection].rawValue,
+            "visibleSections": Defaults[.visibleSections].compactMap { $0.rawValue },
+            "showOpenActionsToolbarItem": Defaults[.showOpenActionsToolbarItem],
+            "accountPickerDisplaysAnonymousAccounts": Defaults[.accountPickerDisplaysAnonymousAccounts],
+            "showUnwatchedFeedBadges": Defaults[.showUnwatchedFeedBadges],
+            "expandChannelDescription": Defaults[.expandChannelDescription],
+            "keepChannelsWithUnwatchedFeedOnTop": Defaults[.keepChannelsWithUnwatchedFeedOnTop],
+            "showChannelAvatarInChannelsLists": Defaults[.showChannelAvatarInChannelsLists],
+            "showChannelAvatarInVideosListing": Defaults[.showChannelAvatarInVideosListing],
+            "playerButtonSingleTapGesture": Defaults[.playerButtonSingleTapGesture].rawValue,
+            "playerButtonDoubleTapGesture": Defaults[.playerButtonDoubleTapGesture].rawValue,
+            "playerButtonShowsControlButtonsWhenMinimized": Defaults[.playerButtonShowsControlButtonsWhenMinimized],
+            "playerButtonIsExpanded": Defaults[.playerButtonIsExpanded],
+            "playerBarMaxWidth": Defaults[.playerBarMaxWidth],
+            "channelOnThumbnail": Defaults[.channelOnThumbnail],
+            "timeOnThumbnail": Defaults[.timeOnThumbnail],
+            "roundedThumbnails": Defaults[.roundedThumbnails],
+            "thumbnailsQuality": Defaults[.thumbnailsQuality].rawValue
+        ]
+    }
+
+    override var platformJSON: JSON {
+        var export = JSON()
+
+        #if os(iOS)
+            export["showDocuments"].bool = Defaults[.showDocuments]
+            export["lockPortraitWhenBrowsing"].bool = Defaults[.lockPortraitWhenBrowsing]
+        #endif
+
+        #if !os(tvOS)
+            export["accountPickerDisplaysUsername"].bool = Defaults[.accountPickerDisplaysUsername]
+        #endif
+
+        return export
+    }
+
+    private func widgetSettingsJSON(_ settings: WidgetSettings) -> JSON {
+        var json = JSON()
+        json.dictionaryObject = WidgetSettingsBridge().serialize(settings)
+        return json
+    }
+}
--- a/Settings/Exporters/ControlsSettingsGroupExporter.swift
+++ b/Settings/Exporters/ControlsSettingsGroupExporter.swift
@@ -0,0 +1,40 @@
+import Defaults
+import SwiftyJSON
+
+final class ConstrolsSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "avPlayerUsesSystemControls": Defaults[.avPlayerUsesSystemControls],
+            "horizontalPlayerGestureEnabled": Defaults[.horizontalPlayerGestureEnabled],
+            "seekGestureSensitivity": Defaults[.seekGestureSensitivity],
+            "seekGestureSpeed": Defaults[.seekGestureSpeed],
+            "playerControlsLayout": Defaults[.playerControlsLayout].rawValue,
+            "fullScreenPlayerControlsLayout": Defaults[.fullScreenPlayerControlsLayout].rawValue,
+            "systemControlsCommands": Defaults[.systemControlsCommands].rawValue,
+            "buttonBackwardSeekDuration": Defaults[.buttonBackwardSeekDuration],
+            "buttonForwardSeekDuration": Defaults[.buttonForwardSeekDuration],
+            "gestureBackwardSeekDuration": Defaults[.gestureBackwardSeekDuration],
+            "gestureForwardSeekDuration": Defaults[.gestureForwardSeekDuration],
+            "systemControlsSeekDuration": Defaults[.systemControlsSeekDuration],
+            "playerControlsSettingsEnabled": Defaults[.playerControlsSettingsEnabled],
+            "playerControlsCloseEnabled": Defaults[.playerControlsCloseEnabled],
+            "playerControlsRestartEnabled": Defaults[.playerControlsRestartEnabled],
+            "playerControlsAdvanceToNextEnabled": Defaults[.playerControlsAdvanceToNextEnabled],
+            "playerControlsPlaybackModeEnabled": Defaults[.playerControlsPlaybackModeEnabled],
+            "playerControlsMusicModeEnabled": Defaults[.playerControlsMusicModeEnabled],
+            "playerActionsButtonLabelStyle": Defaults[.playerActionsButtonLabelStyle].rawValue,
+            "actionButtonShareEnabled": Defaults[.actionButtonShareEnabled],
+            "actionButtonAddToPlaylistEnabled": Defaults[.actionButtonAddToPlaylistEnabled],
+            "actionButtonSubscribeEnabled": Defaults[.actionButtonSubscribeEnabled],
+            "actionButtonSettingsEnabled": Defaults[.actionButtonSettingsEnabled],
+            "actionButtonHideEnabled": Defaults[.actionButtonHideEnabled],
+            "actionButtonCloseEnabled": Defaults[.actionButtonCloseEnabled],
+            "actionButtonFullScreenEnabled": Defaults[.actionButtonFullScreenEnabled],
+            "actionButtonPipEnabled": Defaults[.actionButtonPipEnabled],
+            "actionButtonLockOrientationEnabled": Defaults[.actionButtonLockOrientationEnabled],
+            "actionButtonRestartEnabled": Defaults[.actionButtonRestartEnabled],
+            "actionButtonAdvanceToNextItemEnabled": Defaults[.actionButtonAdvanceToNextItemEnabled],
+            "actionButtonMusicModeEnabled": Defaults[.actionButtonMusicModeEnabled]
+        ]
+    }
+}
--- a/Settings/Exporters/HistorySettingsGroupExporter.swift
+++ b/Settings/Exporters/HistorySettingsGroupExporter.swift
@@ -0,0 +1,21 @@
+import Defaults
+import SwiftyJSON
+
+final class HistorySettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "saveRecents": Defaults[.saveRecents],
+            "saveHistory": Defaults[.saveHistory],
+            "showWatchingProgress": Defaults[.showWatchingProgress],
+            "saveLastPlayed": Defaults[.saveLastPlayed],
+
+            "watchedVideoPlayNowBehavior": Defaults[.watchedVideoPlayNowBehavior].rawValue,
+            "watchedThreshold": Defaults[.watchedThreshold],
+            "resetWatchedStatusOnPlaying": Defaults[.resetWatchedStatusOnPlaying],
+
+            "watchedVideoStyle": Defaults[.watchedVideoStyle].rawValue,
+            "watchedVideoBadgeColor": Defaults[.watchedVideoBadgeColor].rawValue,
+            "showToggleWatchedStatusButton": Defaults[.showToggleWatchedStatusButton]
+        ]
+    }
+}
--- a/Settings/Exporters/LocationsSettingsGroupExporter.swift
+++ b/Settings/Exporters/LocationsSettingsGroupExporter.swift
@@ -0,0 +1,56 @@
+import Defaults
+import SwiftyJSON
+
+final class LocationsSettingsGroupExporter: SettingsGroupExporter {
+    var includePublicInstances = true
+    var includeInstances = true
+    var includeAccounts = true
+    var includeAccountsUnencryptedPasswords = false
+
+    init(includePublicInstances: Bool = true, includeInstances: Bool = true, includeAccounts: Bool = true, includeAccountsUnencryptedPasswords: Bool = false) {
+        self.includePublicInstances = includePublicInstances
+        self.includeInstances = includeInstances
+        self.includeAccounts = includeAccounts
+        self.includeAccountsUnencryptedPasswords = includeAccountsUnencryptedPasswords
+    }
+
+    override var globalJSON: JSON {
+        var json = JSON()
+
+        if includePublicInstances {
+            json["instancesManifest"].string = Defaults[.instancesManifest]
+            json["countryOfPublicInstances"].string = Defaults[.countryOfPublicInstances] ?? ""
+        }
+
+        if includeInstances {
+            json["instances"].arrayObject = Defaults[.instances].compactMap { instanceJSON($0) }
+        }
+
+        if includeAccounts {
+            json["accounts"].arrayObject = Defaults[.accounts].compactMap { account in
+                var account = account
+                let (username, password) = AccountsModel.getCredentials(account)
+                account.username = username ?? ""
+                if includeAccountsUnencryptedPasswords {
+                    account.password = password ?? ""
+                }
+
+                return accountJSON(account).dictionaryObject
+            }
+        }
+
+        return json
+    }
+
+    private func instanceJSON(_ instance: Instance) -> JSON {
+        var json = JSON()
+        json.dictionaryObject = InstancesBridge().serialize(instance)
+        return json
+    }
+
+    private func accountJSON(_ account: Account) -> JSON {
+        var json = JSON()
+        json.dictionaryObject = AccountsBridge().serialize(account)
+        return json
+    }
+}
--- a/Settings/Exporters/OtherDataSettingsGroupExporter.swift
+++ b/Settings/Exporters/OtherDataSettingsGroupExporter.swift
@@ -0,0 +1,27 @@
+import Defaults
+import SwiftyJSON
+
+final class OtherDataSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "lastAccountID": Defaults[.lastAccountID] ?? "",
+            "lastInstanceID": Defaults[.lastInstanceID] ?? "",
+
+            "playerRate": Defaults[.playerRate],
+
+            "trendingCategory": Defaults[.trendingCategory].rawValue,
+            "trendingCountry": Defaults[.trendingCountry].rawValue,
+
+            "subscriptionsViewPage": Defaults[.subscriptionsViewPage].rawValue,
+            "subscriptionsListingStyle": Defaults[.subscriptionsListingStyle].rawValue,
+            "popularListingStyle": Defaults[.popularListingStyle].rawValue,
+            "trendingListingStyle": Defaults[.trendingListingStyle].rawValue,
+            "playlistListingStyle": Defaults[.playlistListingStyle].rawValue,
+            "channelPlaylistListingStyle": Defaults[.channelPlaylistListingStyle].rawValue,
+            "searchListingStyle": Defaults[.searchListingStyle].rawValue,
+
+            "hideShorts": Defaults[.hideShorts],
+            "hideWatched": Defaults[.hideWatched]
+        ]
+    }
+}
--- a/Settings/Exporters/PlayerSettingsGroupExporter.swift
+++ b/Settings/Exporters/PlayerSettingsGroupExporter.swift
@@ -0,0 +1,44 @@
+import Defaults
+import SwiftyJSON
+
+final class PlayerSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "playerInstanceID": Defaults[.playerInstanceID] ?? "",
+            "pauseOnHidingPlayer": Defaults[.pauseOnHidingPlayer],
+            "closeVideoOnEOF": Defaults[.closeVideoOnEOF],
+            "expandVideoDescription": Defaults[.expandVideoDescription],
+            "collapsedLinesDescription": Defaults[.collapsedLinesDescription],
+            "showChapters": Defaults[.showChapters],
+            "expandChapters": Defaults[.expandChapters],
+            "showRelated": Defaults[.showRelated],
+            "showInspector": Defaults[.showInspector].rawValue,
+            "playerSidebar": Defaults[.playerSidebar].rawValue,
+            "showKeywords": Defaults[.showKeywords],
+            "enableReturnYouTubeDislike": Defaults[.enableReturnYouTubeDislike],
+            "closePiPOnNavigation": Defaults[.closePiPOnNavigation],
+            "closePiPOnOpeningPlayer": Defaults[.closePiPOnOpeningPlayer],
+            "closePlayerOnOpeningPiP": Defaults[.closePlayerOnOpeningPiP]
+        ]
+    }
+
+    override var platformJSON: JSON {
+        var export = JSON()
+
+        #if !os(macOS)
+            export["pauseOnEnteringBackground"].bool = Defaults[.pauseOnEnteringBackground]
+        #endif
+
+        #if !os(tvOS)
+            export["showScrollToTopInComments"].bool = Defaults[.showScrollToTopInComments]
+        #endif
+
+        #if os(iOS)
+            export["honorSystemOrientationLock"].bool = Defaults[.honorSystemOrientationLock]
+            export["enterFullscreenInLandscape"].bool = Defaults[.enterFullscreenInLandscape]
+            export["rotateToLandscapeOnEnterFullScreen"].string = Defaults[.rotateToLandscapeOnEnterFullScreen].rawValue
+        #endif
+
+        return export
+    }
+}
--- a/Settings/Exporters/QualitySettingsGroupExporter.swift
+++ b/Settings/Exporters/QualitySettingsGroupExporter.swift
@@ -0,0 +1,21 @@
+import Defaults
+import SwiftyJSON
+
+final class QualitySettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "batteryCellularProfile": Defaults[.batteryCellularProfile],
+            "batteryNonCellularProfile": Defaults[.batteryNonCellularProfile],
+            "chargingCellularProfile": Defaults[.chargingCellularProfile],
+            "chargingNonCellularProfile": Defaults[.chargingNonCellularProfile],
+            "forceAVPlayerForLiveStreams": Defaults[.forceAVPlayerForLiveStreams],
+            "qualityProfiles": Defaults[.qualityProfiles].compactMap { qualityProfileJSON($0) }
+        ]
+    }
+
+    func qualityProfileJSON(_ profile: QualityProfile) -> JSON {
+        var json = JSON()
+        json.dictionaryObject = QualityProfileBridge().serialize(profile)
+        return json
+    }
+}
--- a/Settings/Exporters/RecentlyOpenedExporter.swift
+++ b/Settings/Exporters/RecentlyOpenedExporter.swift
@@ -0,0 +1,16 @@
+import Defaults
+import SwiftyJSON
+
+final class RecentlyOpenedExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "recentlyOpened": Defaults[.recentlyOpened].compactMap { recentItemJSON($0) }
+        ]
+    }
+
+    private func recentItemJSON(_ recentItem: RecentItem) -> JSON {
+        var json = JSON()
+        json.dictionaryObject = RecentItemBridge().serialize(recentItem)
+        return json
+    }
+}
--- a/Settings/Exporters/SettingsGroupExporter.swift
+++ b/Settings/Exporters/SettingsGroupExporter.swift
@@ -0,0 +1,32 @@
+import Foundation
+import SwiftyJSON
+
+class SettingsGroupExporter { // swiftlint:disable:this final_class
+    var globalJSON: JSON {
+        []
+    }
+
+    var platformJSON: JSON {
+        []
+    }
+
+    var exportJSON: JSON {
+        var json = globalJSON
+
+        if !platformJSON.isEmpty {
+            try? json.merge(with: platformJSON)
+        }
+
+        return json
+    }
+
+    func jsonFromString(_ string: String?) -> JSON? {
+        if let data = string?.data(using: .utf8, allowLossyConversion: false),
+           let json = try? JSON(data: data)
+        {
+            return json
+        }
+
+        return nil
+    }
+}
--- a/Settings/Exporters/SponsorBlockSettingsGroupExporter.swift
+++ b/Settings/Exporters/SponsorBlockSettingsGroupExporter.swift
@@ -0,0 +1,11 @@
+import Defaults
+import SwiftyJSON
+
+final class SponsorBlockSettingsGroupExporter: SettingsGroupExporter {
+    override var globalJSON: JSON {
+        [
+            "sponsorBlockInstance": Defaults[.sponsorBlockInstance],
+            "sponsorBlockCategories": Array(Defaults[.sponsorBlockCategories])
+        ]
+    }
+}