Support Spotify Provider

Mx-Iris · Mx-Iris · commit 3b977a48be08 · 2025-03-04T21:22:25.000+08:00
diff --git a/Package.swift b/Package.swift
@@ -19,7 +19,7 @@ let package = Package(
         .package(url: "https://github.com/MxIris-LyricsX-Project/CXShim", .branchItem("master")),
         .package(url: "https://github.com/MxIris-LyricsX-Project/CXExtensions", .branchItem("master")),
         .package(url: "https://github.com/ddddxxx/Regex", from: "1.0.1"),
-        .package(url: "https://github.com/Mx-Iris/SwiftCF", .branchItem("master")),
+        .package(url: "https://github.com/MxIris-Library-Forks/SwiftCF", .branchItem("master")),
         .package(name: "Gzip", url: "https://github.com/1024jp/GzipSwift", from: "5.0.0"),
     ],
     targets: [
@@ -30,7 +30,6 @@ let package = Package(
             name: "LyricsService",
             dependencies: [
                 "LyricsCore", "CXShim", "CXExtensions", "Regex", "Gzip",
-//                .product(name: "SWXMLHash", package: "SWXMLHash")
             ]
         ),
         .testTarget(
diff --git a/Sources/LyricsService/LyricsMetadata+Extension.swift b/Sources/LyricsService/LyricsMetadata+Extension.swift
@@ -38,8 +38,8 @@ extension Lyrics.Metadata {
         set { data[.artworkURL] = newValue }
     }
     
-    public var service: LyricsProviders.Service? {
-        get { return data[.service] as? LyricsProviders.Service }
+    public var service: String? {
+        get { return data[.service] as? String }
         set { data[.service] = newValue }
     }
     
diff --git a/Sources/LyricsService/Provider/Discontinued/ViewLyrics.swift b/Sources/LyricsService/Provider/Discontinued/ViewLyrics.swift
@@ -35,7 +35,7 @@ extension LyricsProviders.ViewLyrics: _LyricsProvider {
         var value: ViewLyricsResponseSearchResult
     }
     
-    public static let service: LyricsProviders.Service? = nil
+    public static let service: String? = nil
     
     func assembleQuery(artist: String, title: String, page: Int = 0) -> Data {
         let watermark = "Mlv1clt4.0"
diff --git a/Sources/LyricsService/Provider/Discontinued/Xiami.swift b/Sources/LyricsService/Provider/Discontinued/Xiami.swift
@@ -30,7 +30,7 @@ extension LyricsProviders.Xiami: _LyricsProvider {
         let value: XiamiResponseSearchResult.Data.Song
     }
     
-    public static let service: LyricsProviders.Service? = nil
+    public static let service: String? = nil
     
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         let parameter: [String : Any] = [
diff --git a/Sources/LyricsService/Provider/Gecimi.swift b/Sources/LyricsService/Provider/Gecimi.swift
@@ -31,7 +31,7 @@ extension LyricsProviders.Gecimi: _LyricsProvider {
         let value: GecimiResponseSearchResult.Result
     }
     
-    public static let service: LyricsProviders.Service? = .gecimi
+    public static let service: String? = "Gecimi"
     
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         guard case let .info(title, artist) = request.searchTerm else {
diff --git a/Sources/LyricsService/Provider/Group.swift b/Sources/LyricsService/Provider/Group.swift
@@ -17,7 +17,7 @@ extension LyricsProviders {
         
         var providers: [LyricsProvider]
         
-        public init(service: [LyricsProviders.Service] = LyricsProviders.Service.allCases) {
+        public init(service: [LyricsProviders.Service] = LyricsProviders.Service.noAuthenticationRequiredServices) {
             providers = service.map { $0.create() }
         }
         
diff --git a/Sources/LyricsService/Provider/Kugou.swift b/Sources/LyricsService/Provider/Kugou.swift
@@ -31,7 +31,7 @@ extension LyricsProviders.Kugou: _LyricsProvider {
         let value: KugouResponseSearchResult.Item
     }
     
-    public static let service: LyricsProviders.Service? = .kugou
+    public static let service: String? = "Kugou"
     
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         let parameter: [String: Any] = [
diff --git a/Sources/LyricsService/Provider/LyricsProvider.swift b/Sources/LyricsService/Provider/LyricsProvider.swift
@@ -22,7 +22,7 @@ public protocol _LyricsProvider: LyricsProvider {
     
     associatedtype LyricsToken
     
-    static var service: LyricsProviders.Service? { get }
+    static var service: String? { get }
     
     func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never>
     
diff --git a/Sources/LyricsService/Provider/NetEase.swift b/Sources/LyricsService/Provider/NetEase.swift
@@ -32,7 +32,7 @@ extension LyricsProviders.NetEase: _LyricsProvider {
         let value: NetEaseResponseSearchResult.Result.Song
     }
     
-    public static let service: LyricsProviders.Service? = .netease
+    public static let service: String? = "NetEase"
     
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         let parameter: [String: Any] = [
diff --git a/Sources/LyricsService/Provider/QQMusic.swift b/Sources/LyricsService/Provider/QQMusic.swift
@@ -31,7 +31,7 @@ extension LyricsProviders {
 extension LyricsProviders.QQMusic: _LyricsProvider {
     public typealias LyricsToken = QQMusicSongSearchResult
 
-    public static let service: LyricsProviders.Service? = .qq
+    public static let service: String? = "QQMusic"
 
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         let parameter = ["key": request.searchTerm.description]
diff --git a/Sources/LyricsService/Provider/Service.swift b/Sources/LyricsService/Provider/Service.swift
@@ -11,14 +11,37 @@ import Foundation
 
 extension LyricsProviders {
     
-    public enum Service: String, CaseIterable {
-        case netease = "163"
-        case qq = "QQMusic"
-        case kugou = "Kugou"
-        case gecimi = "Gecimi"
-        case syair = "Syair"
-        case lrclib = "LRCLIB"
-        case spotify = "Spotify"
+    public enum Service {
+        case netease
+        case qq
+        case kugou
+        case gecimi
+        case syair
+        case lrclib
+        case spotify(accessToken: String)
+
+        public var displayName: String {
+            switch self {
+            case .netease: return "Netease"
+            case .qq: return "QQMusic"
+            case .kugou: return "Kugou"
+            case .gecimi: return "Gecimi"
+            case .syair: return "Syair"
+            case .lrclib: return "LRCLIB"
+            case .spotify: return "Spotify"
+            }
+        }
+        
+        public static var noAuthenticationRequiredServices: [Service] {
+            [
+                .netease,
+                .qq,
+                .kugou,
+                .gecimi,
+                .syair,
+                .lrclib,
+            ]
+        }
     }
 }
 
@@ -30,6 +53,7 @@ extension LyricsProviders.Service {
         case .qq:       return LyricsProviders.QQMusic()
         case .kugou:    return LyricsProviders.Kugou()
         case .gecimi:   return LyricsProviders.Gecimi()
+        case .spotify(let accessToken): return LyricsProviders.Spotify(accessToken: accessToken)
         #if canImport(Darwin)
         case .syair:    return LyricsProviders.Syair()
         #endif
diff --git a/Sources/LyricsService/Provider/Spotify.swift b/Sources/LyricsService/Provider/Spotify.swift
@@ -10,7 +10,7 @@ struct SpotifyAccessToken: Codable {
     let isAnonymous: Bool
 }
 
-struct SpotifyResponse: Codable {
+struct SpotifySearchResponse: Codable {
     struct Tracks: Codable {
         struct Item: Codable {
             let type: String
@@ -23,23 +23,74 @@ struct SpotifyResponse: Codable {
     let tracks: Tracks
 }
 
+struct SpotifyLyricsResponse: Codable {
+    struct Lyric: Codable {
+        struct Line: Codable {
+            let startTimeMs: TimeInterval
+            let words: String
+            let endTimeMs: String
+        }
+
+        let syncType: String
+        let lines: [Line]
+        let provider: String
+        let providerLyricsID: String
+        let providerDisplayName: String
+        let syncLyricsUri: String
+        let isDenseTypeface: Bool
+        let language: String
+        let isRtlLanguage: Bool
+        let capStatus: String
+        let isSnippet: Bool
+
+        private enum CodingKeys: String, CodingKey {
+            case syncType
+            case lines
+            case provider
+            case providerLyricsID = "providerLyricsId"
+            case providerDisplayName
+            case syncLyricsUri
+            case isDenseTypeface
+            case language
+            case isRtlLanguage
+            case capStatus
+            case isSnippet
+        }
+    }
+
+    struct Color: Codable {
+        let background: Int
+        let text: Int
+        let highlightText: Int
+    }
+
+    let lyrics: Lyric
+    let colors: Color
+    let hasVocalRemoval: Bool
+}
+
 extension LyricsProviders {
     final class Spotify: _LyricsProvider {
-        typealias LyricsToken = SpotifyResponse.Tracks.Item
+        typealias LyricsToken = SpotifySearchResponse.Tracks.Item
 
         let accessToken: String
-        let fakeSpotifyUserAgentconfig = URLSessionConfiguration.default
-        let fakeSpotifyUserAgentSession: URLSession
+        
         init(accessToken: String) {
             self.accessToken = accessToken
-            fakeSpotifyUserAgentconfig.httpAdditionalHeaders = ["User-Agent": "Spotify/121000760 Win32/0 (PC laptop)"]
-            fakeSpotifyUserAgentSession = URLSession(configuration: fakeSpotifyUserAgentconfig)
         }
+
+        static let fakeSpotifyUserAgentconfig: URLSessionConfiguration = {
+            let fakeSpotifyUserAgentconfig = URLSessionConfiguration.default
+            fakeSpotifyUserAgentconfig.httpAdditionalHeaders = ["User-Agent": "Spotify/121000760 Win32/0 (PC laptop)"]
+            return fakeSpotifyUserAgentconfig
+        }()
+
+        static let fakeSpotifyUserAgentSession: URLSession = .init(configuration: fakeSpotifyUserAgentconfig)
     }
 }
 
 extension LyricsProviders.Spotify {
-    static var service: LyricsProviders.Service? = .spotify
+    static let service: String? = "Spotify"
 
     func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {
         let url: URL
@@ -55,7 +106,7 @@ extension LyricsProviders.Spotify {
         req.addValue("Bearer \(accessToken)", forHTTPHeaderField: "authorization")
         return sharedURLSession.cx.dataTaskPublisher(for: req)
             .map(\.data)
-            .decode(type: SpotifyResponse.self, decoder: JSONDecoder().cx)
+            .decode(type: SpotifySearchResponse.self, decoder: JSONDecoder().cx)
             .map(\.tracks.items)
             .replaceError(with: [])
             .flatMap(Publishers.Sequence.init)
@@ -64,22 +115,16 @@ extension LyricsProviders.Spotify {
     }
 
     func lyricsFetchPublisher(token: LyricsToken) -> AnyPublisher<Lyrics, Never> {
-//        let url = URL(string: "https://spclient.wg.spotify.com/color-lyrics/v2/track/\(token.id)?format=json&vocalRemoval=false")!
-//        var request = URLRequest(url: url)
-//        request.addValue("WebPlayer", forHTTPHeaderField: "app-platform")
-//        request.addValue("Bearer \(accessToken)", forHTTPHeaderField: "authorization")
-//
-//        return fakeSpotifyUserAgentSession.dataTaskPublisher(for: request)
-//            .map {
-//                
-//            }
-//            .ignoreOutput()
-//            .eraseToAnyPublisher()
-//
-//        let songObject = try decoder.decode(SongObjectParent.self, from: urlResponseAndData.0)
-//        print("downloaded from internet successfully \(trackID) \(trackName)")
-//        saveCoreData()
-//        let lyricsArray = zip(songObject.lyrics.lyricsTimestamps, songObject.lyrics.lyricsWords).map { LyricLine(startTime: $0, words: $1) }
-        fatalError()
+        let url = URL(string: "https://spclient.wg.spotify.com/color-lyrics/v2/track/\(token.id)?format=json&vocalRemoval=false")!
+        var request = URLRequest(url: url)
+        request.addValue("WebPlayer", forHTTPHeaderField: "app-platform")
+        request.addValue("Bearer \(accessToken)", forHTTPHeaderField: "authorization")
+
+        return Self.fakeSpotifyUserAgentSession.cx.dataTaskPublisher(for: request)
+            .map(\.data)
+            .decode(type: SpotifyLyricsResponse.self, decoder: JSONDecoder().cx)
+            .map { Lyrics(lines: $0.lyrics.lines.map { LyricsLine(content: $0.words, position: $0.startTimeMs / 1000) }, idTags: [:]) }
+            .ignoreError()
+            .eraseToAnyPublisher()
     }
 }
diff --git a/Sources/LyricsService/Provider/Syair.swift b/Sources/LyricsService/Provider/Syair.swift
@@ -25,7 +25,7 @@ extension LyricsProviders {
 
 extension LyricsProviders.Syair: _LyricsProvider {
     
-    public static let service: LyricsProviders.Service? = .syair
+    public static let service: String? = "Syair"
     
     public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<String, Never> {
         var parameter: [String: Any] = ["page": 1]

Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,8 @@ extension Lyrics.Metadata {`
`38`	`38`	`set { data[.artworkURL] = newValue }`
`39`	`39`	`}`
`40`	`40`
`41`		`- public var service: LyricsProviders.Service? {`
`42`		`- get { return data[.service] as? LyricsProviders.Service }`
	`41`	`+ public var service: String? {`
	`42`	`+ get { return data[.service] as? String }`
`43`	`43`	`set { data[.service] = newValue }`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ extension LyricsProviders.ViewLyrics: _LyricsProvider {`
`35`	`35`	`var value: ViewLyricsResponseSearchResult`
`36`	`36`	`}`
`37`	`37`
`38`		`- public static let service: LyricsProviders.Service? = nil`
	`38`	`+ public static let service: String? = nil`
`39`	`39`
`40`	`40`	`func assembleQuery(artist: String, title: String, page: Int = 0) -> Data {`
`41`	`41`	`let watermark = "Mlv1clt4.0"`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ extension LyricsProviders.Xiami: _LyricsProvider {`
`30`	`30`	`let value: XiamiResponseSearchResult.Data.Song`
`31`	`31`	`}`
`32`	`32`
`33`		`- public static let service: LyricsProviders.Service? = nil`
	`33`	`+ public static let service: String? = nil`
`34`	`34`
`35`	`35`	`public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {`
`36`	`36`	`let parameter: [String : Any] = [`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ extension LyricsProviders.Gecimi: _LyricsProvider {`
`31`	`31`	`let value: GecimiResponseSearchResult.Result`
`32`	`32`	`}`
`33`	`33`
`34`		`- public static let service: LyricsProviders.Service? = .gecimi`
	`34`	`+ public static let service: String? = "Gecimi"`
`35`	`35`
`36`	`36`	`public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {`
`37`	`37`	`guard case let .info(title, artist) = request.searchTerm else {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ extension LyricsProviders {`
`17`	`17`
`18`	`18`	`var providers: [LyricsProvider]`
`19`	`19`
`20`		`- public init(service: [LyricsProviders.Service] = LyricsProviders.Service.allCases) {`
	`20`	`+ public init(service: [LyricsProviders.Service] = LyricsProviders.Service.noAuthenticationRequiredServices) {`
`21`	`21`	`providers = service.map { $0.create() }`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ extension LyricsProviders.NetEase: _LyricsProvider {`
`32`	`32`	`let value: NetEaseResponseSearchResult.Result.Song`
`33`	`33`	`}`
`34`	`34`
`35`		`- public static let service: LyricsProviders.Service? = .netease`
	`35`	`+ public static let service: String? = "NetEase"`
`36`	`36`
`37`	`37`	`public func lyricsSearchPublisher(request: LyricsSearchRequest) -> AnyPublisher<LyricsToken, Never> {`
`38`	`38`	`let parameter: [String: Any] = [`