Add option to extract id from URL (#13)

Author: omaralbeik

Sources/M3UKit/PlaylistParser.swift

@@ -37,8 +37,14 @@ public final class PlaylistParser {
     /// Remove season number and episode number "S--E--" from the name of media.
     public static let removeSeriesInfoFromText = Options(rawValue: 1 << 0)
 
+    /// Extract id from the URL (usually last path component removing the extension)
+    public static let extractIdFromURL = Options(rawValue: 1 << 1)
+
     /// All available options.
-    public static let all: Options = [.removeSeriesInfoFromText]
+    public static let all: Options = [
+      .removeSeriesInfoFromText,
+      .extractIdFromURL,
+    ]
   }
 
   /// Parser options.
@@ -77,7 +83,7 @@ public final class PlaylistParser {
 
       if let metadataLine = lastMetadataLine, let url = lastURL {
         do {
-          let metadata = try self.parseMetadata((lineNumber, metadataLine))
+          let metadata = try self.parseMetadata(line: lineNumber, rawString: metadataLine, url: url)
           let kind = self.parseMediaKind(url)
           medias.append(.init(metadata: metadata, kind: kind, url: url))
           lastMetadataLine = nil
@@ -127,7 +133,7 @@ public final class PlaylistParser {
 
       if let metadataLine = lastMetadataLine, let url = lastURL {
         do {
-          let metadata = try self.parseMetadata((lineNumber, metadataLine))
+          let metadata = try self.parseMetadata(line: lineNumber, rawString: metadataLine, url: url)
           let kind = self.parseMediaKind(url)
           handler(.init(metadata: metadata, kind: kind, url: url))
           lastMetadataLine = nil
@@ -216,23 +222,23 @@ public final class PlaylistParser {
 
   internal typealias Show = (name: String, se: (s: Int, e: Int)?)
 
-  internal func parseMetadata(_ input: (line: Int, rawString: String)) throws -> Playlist.Media.Metadata {
-    let duration = try extractDuration(input)
-    let attributes = parseAttributes(input.rawString)
-    let name = parseSeasonEpisode(extractName(input.rawString)).name
+  internal func parseMetadata(line: Int, rawString: String, url: URL) throws -> Playlist.Media.Metadata {
+    let duration = try extractDuration(line: line, rawString: rawString)
+    let attributes = parseAttributes(rawString: rawString, url: url)
+    let name = parseSeasonEpisode(extractName(rawString)).name
     return (duration, attributes, name)
   }
 
   internal func isInfoLine(_ input: String) -> Bool {
     return input.starts(with: "#EXTINF:")
   }
 
-  internal func extractDuration(_ input: (line: Int, rawString: String)) throws -> Int {
+  internal func extractDuration(line: Int, rawString: String) throws -> Int {
     guard
-      let match = durationRegex.firstMatch(in: input.rawString),
+      let match = durationRegex.firstMatch(in: rawString),
       let duration = Int(match)
     else {
-      throw ParsingError.missingDuration(input.line, input.rawString)
+      throw ParsingError.missingDuration(line, rawString)
     }
     return duration
   }
@@ -241,6 +247,10 @@ public final class PlaylistParser {
     return nameRegex.firstMatch(in: input) ?? ""
   }
 
+  internal func extractId(_ input: URL) -> String {
+    String(input.lastPathComponent.split(separator: ".").first ?? "")
+  }
+
   internal func parseMediaKind(_ input: URL) -> Playlist.Media.Kind {
     let string = input.absoluteString
     if mediaKindMSeriesRegex.numberOfMatches(source: string) == 1 {
@@ -255,33 +265,35 @@ public final class PlaylistParser {
     return .unknown
   }
 
-  internal func parseAttributes(_ input: String) -> Playlist.Media.Attributes {
+  internal func parseAttributes(rawString: String, url: URL) -> Playlist.Media.Attributes {
     var attributes = Playlist.Media.Attributes()
-    if let id = attributesIdRegex.firstMatch(in: input) {
-      attributes.id = id
+    let id = attributesIdRegex.firstMatch(in: rawString) ?? ""
+    attributes.id = id
+    if id.isEmpty && options.contains(.extractIdFromURL) {
+      attributes.id = extractId(url)
     }
-    if let name = attributesNameRegex.firstMatch(in: input) {
+    if let name = attributesNameRegex.firstMatch(in: rawString) {
       let show = parseSeasonEpisode(name)
       attributes.name = show.name
       attributes.seasonNumber = show.se?.s
       attributes.episodeNumber = show.se?.e
     }
-    if let country = attributesCountryRegex.firstMatch(in: input) {
+    if let country = attributesCountryRegex.firstMatch(in: rawString) {
       attributes.country = country
     }
-    if let language = attributesLanguageRegex.firstMatch(in: input) {
+    if let language = attributesLanguageRegex.firstMatch(in: rawString) {
       attributes.language = language
     }
-    if let logo = attributesLogoRegex.firstMatch(in: input) {
+    if let logo = attributesLogoRegex.firstMatch(in: rawString) {
       attributes.logo = logo
     }
-    if let channelNumber = attributesChannelNumberRegex.firstMatch(in: input) {
+    if let channelNumber = attributesChannelNumberRegex.firstMatch(in: rawString) {
       attributes.channelNumber = channelNumber
     }
-    if let shift = attributesShiftRegex.firstMatch(in: input) {
+    if let shift = attributesShiftRegex.firstMatch(in: rawString) {
       attributes.shift = shift
     }
-    if let groupTitle = attributesGroupTitleRegex.firstMatch(in: input) {
+    if let groupTitle = attributesGroupTitleRegex.firstMatch(in: rawString) {
       attributes.groupTitle = groupTitle
     }
     return attributes

Tests/M3UKitTests/PlaylistParserTests.swift

@@ -128,7 +128,7 @@ final class PlaylistParserTests: XCTestCase {
   func testExtractingDuration() throws {
     let parser = PlaylistParser()
 
-    XCTAssertThrowsError(try parser.extractDuration((1, "invalid")))
+    XCTAssertThrowsError(try parser.extractDuration(line: 1, rawString: "invalid"))
   }
 
   func testExtractingName() throws {
@@ -138,6 +138,13 @@ final class PlaylistParserTests: XCTestCase {
     XCTAssertEqual(parser.extractName(",valid"), "valid")
   }
 
+  func testExtractingIdFromURL() {
+    let parser = PlaylistParser()
+
+    let url = URL(string: "https://domain.com/live/username/password/123456.mp4")!
+    XCTAssertEqual(parser.extractId(url), "123456")
+  }
+
   func testIsInfoLine() {
     let parser = PlaylistParser()
 
@@ -148,10 +155,10 @@ final class PlaylistParserTests: XCTestCase {
   func testParsingAttributes() {
     let rawMedia = """
 #EXTINF:-1 tvg-name="DWEnglish.de" tvg-id="DWEnglish.de" tvg-country="INT" tvg-language="English" tvg-logo="https://i.imgur.com/A1xzjOI.png" tvg-chno="1" tvg-shift="0" group-title="News",DW English (1080p)
-https://dwamdstream102.akamaized.net/hls/live/2015525/dwstream102/index.m3u8
 """
-    let parser = PlaylistParser()
-    let attributes = parser.parseAttributes(rawMedia)
+    let url = URL(string: "https://dwamdstream102.akamaized.net/hls/live/2015525/dwstream102/index.m3u8")!
+    let parser = PlaylistParser(options: .extractIdFromURL)
+    let attributes = parser.parseAttributes(rawString: rawMedia, url: url)
     XCTAssertEqual(attributes.name, "DWEnglish.de")
     XCTAssertEqual(attributes.id, "DWEnglish.de")
     XCTAssertEqual(attributes.country, "INT")
@@ -162,6 +169,24 @@ https://dwamdstream102.akamaized.net/hls/live/2015525/dwstream102/index.m3u8
     XCTAssertEqual(attributes.groupTitle, "News")
   }
 
+  func testParsingAttributesWithOverridingId() {
+    let rawMedia = """
+#EXTINF:-1 tvg-name="DWEnglish.de" tvg-id="" tvg-country="INT" tvg-language="English" tvg-logo="https://i.imgur.com/A1xzjOI.png" tvg-chno="1" tvg-shift="0" group-title="News",DW English (1080p)
+"""
+    let url = URL(string: "https://domain.com/live/username/password/123456.mp4")!
+    let parser = PlaylistParser(options: .extractIdFromURL)
+    let attributes = parser.parseAttributes(rawString: rawMedia, url: url)
+    XCTAssertEqual(attributes.name, "DWEnglish.de")
+    XCTAssertEqual(attributes.id, "123456")
+    XCTAssertEqual(attributes.country, "INT")
+    XCTAssertEqual(attributes.language, "English")
+    XCTAssertEqual(attributes.logo, "https://i.imgur.com/A1xzjOI.png")
+    XCTAssertEqual(attributes.channelNumber, "1")
+    XCTAssertEqual(attributes.shift, "0")
+    XCTAssertEqual(attributes.groupTitle, "News")
+  }
+
+
   func testSeasonEpisodeParsing() {
     let parser = PlaylistParser()
     let input = "Kyou Kara Ore Wa!! LIVE ACTION S01 E09"