actual fix for #437 and Do Not Replace Lyrics option

whoeevee · Oct 10, 2024 · e0fe39d · e0fe39d
1 parent a579a07
commit e0fe39d
Show file tree

Hide file tree

Showing 20 changed files with 248 additions and 188 deletions.
diff --git a/Sources/EeveeSpotify/DataLoaderServiceHooks.x.swift b/Sources/EeveeSpotify/DataLoaderServiceHooks.x.swift
@@ -6,8 +6,11 @@ class SPTDataLoaderServiceHook: ClassHook<NSObject>, SpotifySessionDelegate {
 
     // orion:new
     func shouldModify(_ url: URL) -> Bool {
-        let isModifyingCustomizeResponse = UserDefaults.patchType == .requests
-        return url.isLyrics || (url.isCustomize && isModifyingCustomizeResponse)
+        let isModifyingCustomizeResponse = PremiumPatchingGroup.isActive
+        let isModifyingLyrics = LyricsGroup.isActive
+
+        return (url.isLyrics && isModifyingLyrics)
+            || (url.isCustomize && isModifyingCustomizeResponse)
     }
 
     func URLSession(
@@ -82,7 +85,7 @@ class SPTDataLoaderServiceHook: ClassHook<NSObject>, SpotifySessionDelegate {
             return
         }
 
-        if url.isLyrics, response.statusCode != 200 {
+        if shouldModify(url), url.isLyrics, response.statusCode != 200 {
             let okResponse = HTTPURLResponse(
                 url: url,
                 statusCode: 200,

diff --git a/Sources/EeveeSpotify/Helpers/PopUpHelper.swift b/Sources/EeveeSpotify/Helpers/PopUpHelper.swift
@@ -39,7 +39,6 @@ struct PopUpHelper {
 
             dialog.update(model)
             dialog.setEventHandler({ state in
-
                 switch (state) {
 
                 case .primary: onPrimaryClick?()

diff --git a/Sources/EeveeSpotify/Lyrics/CustomLyrics+AllTracksLyrics.x.swift b/Sources/EeveeSpotify/Lyrics/CustomLyrics+AllTracksLyrics.x.swift
@@ -0,0 +1,27 @@
+import Orion
+
+class SPTPlayerTrackHook: ClassHook<NSObject> {
+    typealias Group = LyricsGroup
+    static let targetName = "SPTPlayerTrack"
+
+    func metadata() -> [String:String] {
+        var meta = orig.metadata()
+
+        meta["has_lyrics"] = "true"
+        return meta
+    }
+}
+
+class LyricsScrollProviderHook: ClassHook<NSObject> {
+    typealias Group = LyricsGroup
+
+    static var targetName: String {
+        return EeveeSpotify.isOldSpotifyVersion
+            ? "Lyrics_CoreImpl.ScrollProvider"
+            : "Lyrics_NPVCommunicatorImpl.ScrollProvider"
+    }
+
+    func isEnabledForTrack(_ track: SPTPlayerTrack) -> Bool {
+        return true
+    }
+}
diff --git a/Sources/EeveeSpotify/Lyrics/CustomLyrics.x.swift b/Sources/EeveeSpotify/Lyrics/CustomLyrics.x.swift
@@ -1,32 +1,15 @@
 import Orion
 import SwiftUI
 
-class SPTPlayerTrackHook: ClassHook<NSObject> {
-    static let targetName = "SPTPlayerTrack"
+//
 
-    func metadata() -> [String:String] {
-        var meta = orig.metadata()
+struct LyricsGroup: HookGroup { }
 
-        meta["has_lyrics"] = "true"
-        return meta
-    }
-}
-
-class LyricsScrollProviderHook: ClassHook<NSObject> {
-
-    static var targetName: String {
-        return EeveeSpotify.isOldSpotifyVersion
-            ? "Lyrics_CoreImpl.ScrollProvider"
-            : "Lyrics_NPVCommunicatorImpl.ScrollProvider"
-    }
-
-    func isEnabledForTrack(_ track: SPTPlayerTrack) -> Bool {
-        return true
-    }
-}
+//
 
 class LyricsFullscreenViewControllerHook: ClassHook<UIViewController> {
-
+    typealias Group = LyricsGroup
+
     static var targetName: String {
         return EeveeSpotify.isOldSpotifyVersion
             ? "Lyrics_CoreImpl.FullscreenViewController"
@@ -62,6 +45,7 @@ private var hasShownUnauthorizedPopUp = false
 //
 
 class LyricsOnlyViewControllerHook: ClassHook<UIViewController> {
+    typealias Group = LyricsGroup
 
     static var targetName: String {
         return EeveeSpotify.isOldSpotifyVersion
@@ -70,7 +54,6 @@ class LyricsOnlyViewControllerHook: ClassHook<UIViewController> {
     }
 
     func viewDidLoad() {
-
         orig.viewDidLoad()
 
         guard
@@ -162,6 +145,7 @@ private func loadLyricsForCurrentTrack() throws {
         case .lrclib: LrcLibLyricsRepository()
         case .musixmatch: MusixmatchLyricsRepository.shared
         case .petit: PetitLyricsRepository()
+        case .notReplaced: throw LyricsError.InvalidSource
     }
 
     let lyricsDto: LyricsDto
@@ -180,7 +164,6 @@ private func loadLyricsForCurrentTrack() throws {
             switch error {
 
             case .InvalidMusixmatchToken:
-
                 if !hasShownUnauthorizedPopUp {
                     PopUpHelper.showPopUp(
                         delayed: false,
@@ -192,7 +175,6 @@ private func loadLyricsForCurrentTrack() throws {
                 }
 
             case .MusixmatchRestricted:
-
                 if !hasShownRestrictedPopUp {
                     PopUpHelper.showPopUp(
                         delayed: false,
@@ -226,7 +208,7 @@ private func loadLyricsForCurrentTrack() throws {
     lastLyricsState.areEmpty = lyricsDto.lines.isEmpty
 
     lastLyricsState.wasRomanized = lyricsDto.romanization == .romanized
-    || (lyricsDto.romanization == .canBeRomanized && UserDefaults.lyricsOptions.romanization)
+        || (lyricsDto.romanization == .canBeRomanized && UserDefaults.lyricsOptions.romanization)
 
     lastLyricsState.loadedSuccessfully = true
 

diff --git a/Sources/EeveeSpotify/Lyrics/Models/LyricsError.swift b/Sources/EeveeSpotify/Lyrics/Models/LyricsError.swift
@@ -7,6 +7,7 @@ enum LyricsError: Error, CustomStringConvertible {
     case DecodingError
     case NoSuchSong
     case UnknownError
+    case InvalidSource
 
     var description: String {
         switch self {
@@ -16,6 +17,7 @@ enum LyricsError: Error, CustomStringConvertible {
         case .DecodingError: "decoding_error".localized
         case .NoCurrentTrack: "no_current_track".localized
         case .UnknownError: "unknown_error".localized
+        case .InvalidSource: ""
         }
     }
 }
diff --git a/Sources/EeveeSpotify/Lyrics/Models/Settings/LyricsSource.swift b/Sources/EeveeSpotify/Lyrics/Models/Settings/LyricsSource.swift
@@ -5,13 +5,27 @@ enum LyricsSource: Int, CaseIterable, CustomStringConvertible {
     case lrclib
     case musixmatch
     case petit
+    case notReplaced
+
+    static var allCases: [LyricsSource] {
+        return [.genius, .lrclib, .musixmatch, .petit]
+    }
 
     var description: String {
         switch self {
         case .genius: "Genius"
         case .lrclib: "LRCLIB"
         case .musixmatch: "Musixmatch"
         case .petit: "PetitLyrics"
+        case .notReplaced: "Spotify"
         }
     }
+
+    var isReplacing: Bool { self != .notReplaced }
+
+    static var defaultSource: LyricsSource {
+        Locale.isInRegion("JP", orHasLanguage: "ja")
+            ? .petit
+            : .lrclib
+    }
 }
diff --git a/Sources/EeveeSpotify/Models/Extensions/UserDefaults+Extension.swift b/Sources/EeveeSpotify/Models/Extensions/UserDefaults+Extension.swift
@@ -1,7 +1,6 @@
 import Foundation
 
 extension UserDefaults {
-
     private static let defaults = UserDefaults.standard
 
     private static let lyricsSourceKey = "lyricsSource"
@@ -21,11 +20,7 @@ extension UserDefaults {
                 return LyricsSource(rawValue: rawValue)!
             }
 
-            if Locale.isInRegion("JP", orHasLanguage: "ja") {
-                return .petit
-            }
-
-            return .lrclib
+            return LyricsSource.defaultSource
         }
         set (newSource) {
             defaults.set(newSource.rawValue, forKey: lyricsSourceKey)

diff --git a/Sources/EeveeSpotify/Premium/DynamicPremium+ModifyBootstrap.x.swift b/Sources/EeveeSpotify/Premium/DynamicPremium+ModifyBootstrap.x.swift
@@ -69,7 +69,7 @@ class SpotifySessionDelegateBootstrapHook: ClassHook<NSObject>, SpotifySessionDe
                     }
                     else {
                         UserDefaults.patchType = .requests
-                        PremiumPatching().activate()
+                        PremiumPatchingGroup().activate()
                     }
 
                     NSLog("[EeveeSpotify] Fetched bootstrap, \(UserDefaults.patchType) was set")

diff --git a/Sources/EeveeSpotify/Premium/LikedSongsEnabler.x.swift b/Sources/EeveeSpotify/Premium/LikedSongsEnabler.x.swift
@@ -6,7 +6,7 @@ private let likedTracksRow: [String: Any] = [
 ]
 
 class HUBViewModelBuilderImplementationHook: ClassHook<NSObject> {
-    typealias Group = PremiumPatching
+    typealias Group = PremiumPatchingGroup
     static let targetName: String = "HUBViewModelBuilderImplementation"
 
     func addJSONDictionary(_ dictionary: NSDictionary?) {

diff --git a/Sources/EeveeSpotify/Premium/ServerSidedReminder.x.swift b/Sources/EeveeSpotify/Premium/ServerSidedReminder.x.swift
@@ -2,7 +2,7 @@ import Orion
 import UIKit
 
 class StreamQualitySettingsSectionHook: ClassHook<NSObject> {
-    typealias Group = PremiumPatching
+    typealias Group = PremiumPatchingGroup
     static let targetName = "StreamQualitySettingsSection"
 
     func shouldResetSelection() -> Bool {
@@ -15,17 +15,8 @@ class StreamQualitySettingsSectionHook: ClassHook<NSObject> {
     }
 }
 
-//
-
-private func showOfflineModePopUp() {
-    PopUpHelper.showPopUp(
-        message: "playlist_downloading_popup".localized,
-        buttonText: "OK".uiKitLocalized
-    )
-}
-
 class ContentOffliningUIHelperImplementationHook: ClassHook<NSObject> {
-    typealias Group = PremiumPatching
+    typealias Group = PremiumPatchingGroup
     static let targetName = "Offline_ContentOffliningUIImpl.ContentOffliningUIHelperImplementation"
 
     func downloadToggledWithCurrentAvailability(
@@ -34,18 +25,31 @@ class ContentOffliningUIHelperImplementationHook: ClassHook<NSObject> {
         removeAction: NSObject,
         pageIdentifier: String,
         pageURI: URL
-    ) -> String {
-        if pageIdentifier == "spotify:local-files" {
-            return orig.downloadToggledWithCurrentAvailability(
-                availability,
-                addAction: addAction,
-                removeAction: removeAction,
-                pageIdentifier: pageIdentifier,
-                pageURI: pageURI
-            )
-        }
+    ) -> String? {
+        let isPlaylist = [
+            "free-tier-playlist",
+            "playlist/ondemand"
+        ].contains(pageIdentifier)
+
+        PopUpHelper.showPopUp(
+            message: "playlist_downloading_popup".localized,
+            buttonText: "OK".uiKitLocalized,
+            secondButtonText: isPlaylist
+                ? "download_local_playlist".localized
+                : nil,
+            onSecondaryClick: isPlaylist
+                ? {
+                    _ = self.orig.downloadToggledWithCurrentAvailability(
+                        availability,
+                        addAction: addAction,
+                        removeAction: removeAction,
+                        pageIdentifier: pageIdentifier,
+                        pageURI: pageURI
+                    )
+                }
+                : nil
+        )
 
-        showOfflineModePopUp()
-        return pageIdentifier
+        return nil
     }
 }
diff --git a/Sources/EeveeSpotify/Premium/TrackRowsEnabler.x.swift b/Sources/EeveeSpotify/Premium/TrackRowsEnabler.x.swift
@@ -1,7 +1,7 @@
 import Orion
 
 class SPTFreeTierArtistHubRemoteURLResolverHook: ClassHook<NSObject> {
-    typealias Group = PremiumPatching
+    typealias Group = PremiumPatchingGroup
     static let targetName = "SPTFreeTierArtistHubRemoteURLResolver"
 
     func initWithViewURI(

diff --git a/Sources/EeveeSpotify/Settings/Views/EeveeSettingsView.swift b/Sources/EeveeSpotify/Settings/Views/EeveeSettingsView.swift
@@ -3,6 +3,7 @@ import UIKit
 
 struct EeveeSettingsView: View {
     let navigationController: UINavigationController
+    static let spotifyAccentColor = Color(hex: "#1ed760")
 
     @State private var hasShownCommonIssuesTip = UserDefaults.hasShownCommonIssuesTip
     @State private var isClearingData = false
@@ -18,9 +19,7 @@ struct EeveeSettingsView: View {
 
     init(navigationController: UINavigationController) {
         self.navigationController = navigationController
-
-        let spotifyAccentColor = UIColor(Color(hex: "#1ed760"))
-        UIView.appearance().tintColor = spotifyAccentColor
+        UIView.appearance().tintColor = UIColor(EeveeSettingsView.spotifyAccentColor)
     }
 
     var body: some View {