yattee/Model/SponsorBlock/SponsorBlockAPI.swift

128 lines
4.3 KiB
Swift
Raw Normal View History

2021-10-23 16:49:45 +00:00
import Alamofire
import Defaults
import Foundation
import Logging
import SwiftyJSON
final class SponsorBlockAPI: ObservableObject {
static let categories = ["sponsor", "selfpromo", "intro", "outro", "interaction", "music_offtopic"]
let logger = Logger(label: "stream.yattee.app.sb")
2021-10-24 09:16:04 +00:00
2021-10-23 16:49:45 +00:00
@Published var videoID: String?
@Published var segments = [Segment]()
static func categoryDescription(_ name: String) -> String? {
2022-05-20 19:53:17 +00:00
guard Self.categories.contains(name) else {
2021-10-23 16:49:45 +00:00
return nil
}
switch name {
2022-09-04 15:28:30 +00:00
case "sponsor":
return "Sponsor".localized()
2021-10-23 16:49:45 +00:00
case "selfpromo":
2022-09-04 15:28:30 +00:00
return "Self-promotion".localized()
case "intro":
return "Intro".localized()
case "outro":
return "Outro".localized()
case "interaction":
return "Interaction".localized()
2021-10-23 16:49:45 +00:00
case "music_offtopic":
2022-09-04 15:28:30 +00:00
return "Offtopic in Music Videos".localized()
2021-10-23 16:49:45 +00:00
default:
return name.capitalized
}
}
2022-01-07 18:46:47 +00:00
static func categoryDetails(_ name: String) -> String? {
2022-05-20 19:53:17 +00:00
guard Self.categories.contains(name) else {
2022-01-07 18:46:47 +00:00
return nil
}
switch name {
case "sponsor":
2022-09-04 15:28:30 +00:00
return ("Part of a video promoting a product or service not directly related to the creator. " +
"The creator will receive payment or compensation in the form of money or free products.").localized()
2022-01-07 18:46:47 +00:00
case "selfpromo":
2022-09-04 15:28:30 +00:00
return ("Promoting a product or service that is directly related to the creator themselves. " +
"This usually includes merchandise or promotion of monetized platforms.").localized()
2022-01-07 18:46:47 +00:00
case "intro":
2022-09-04 15:28:30 +00:00
return ("Segments typically found at the start of a video that include an animation, " +
"still frame or clip which are also seen in other videos by the same creator.").localized()
2022-01-07 18:46:47 +00:00
case "outro":
2022-09-04 15:28:30 +00:00
return ("Typically near or at the end of the video when the credits pop up and/or endcards are shown.").localized()
2022-01-07 18:46:47 +00:00
case "interaction":
2022-09-04 15:28:30 +00:00
return ("Explicit reminders to like, subscribe or interact with them on any paid or free platform(s) (e.g. click on a video).").localized()
2022-01-07 18:46:47 +00:00
case "music_offtopic":
2022-09-04 15:28:30 +00:00
return ("For videos which feature music as the primary content.").localized()
2022-01-07 18:46:47 +00:00
default:
return nil
}
}
func loadSegments(videoID: String, categories: Set<String>, completionHandler: @escaping () -> Void = {}) {
2021-10-23 16:49:45 +00:00
guard !skipSegmentsURL.isNil, self.videoID != videoID else {
completionHandler()
2021-10-23 16:49:45 +00:00
return
}
self.videoID = videoID
DispatchQueue.main.async { [weak self] in
self?.requestSegments(categories: categories, completionHandler: completionHandler)
}
2021-10-23 16:49:45 +00:00
}
func reset() {
videoID = nil
segments = []
}
private func requestSegments(categories: Set<String>, completionHandler: @escaping () -> Void = {}) {
guard let url = skipSegmentsURL, !categories.isEmpty else {
2021-10-23 16:49:45 +00:00
return
}
2022-01-06 23:00:55 +00:00
AF.request(url, parameters: parameters(categories: categories)).responseDecodable(of: JSON.self) { [weak self] response in
2022-09-28 14:27:01 +00:00
guard let self else {
return
}
2021-10-23 16:49:45 +00:00
switch response.result {
case let .success(value):
self.segments = JSON(value).arrayValue.map(SponsorBlockSegment.init).sorted { $0.end < $1.end }
self.logger.info("loaded \(self.segments.count) SponsorBlock segments")
self.segments.forEach {
self.logger.info("\($0.start) -> \($0.end)")
}
case let .failure(error):
self.segments = []
self.logger.error("failed to load SponsorBlock segments: \(error.localizedDescription)")
}
completionHandler()
2021-10-23 16:49:45 +00:00
}
}
private var skipSegmentsURL: String? {
let url = Defaults[.sponsorBlockInstance]
return url.isEmpty ? nil : "\(url)/api/skipSegments"
}
private func parameters(categories: Set<String>) -> [String: String] {
2021-10-23 16:49:45 +00:00
[
"videoID": videoID!,
"categories": JSON(Array(categories)).rawString(String.Encoding.utf8)!
2021-10-23 16:49:45 +00:00
]
}
}