epg-grabber 0.27.2 → 0.28.0

package/src/utils.js

@@ -1,127 +1,34 @@
-const fs = require('fs')
-const { padStart } = require('lodash')
-const path = require('path')
-const axios = require('axios').default
-const axiosCookieJarSupport = require('axios-cookiejar-support').default
-const { setupCache } = require('axios-cache-interceptor')
-const tough = require('tough-cookie')
-const convert = require('xml-js')
-const { merge } = require('lodash')
 const dayjs = require('dayjs')
 const utc = require('dayjs/plugin/utc')
-const { CurlGenerator } = require('curl-generator')
-dayjs.extend(utc)
-axiosCookieJarSupport(axios)
-
-let timeout
-const utils = {}
-const defaultUserAgent =
-  'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36 Edg/79.0.309.71'
 
-utils.loadConfig = function (config) {
-  if (!config.site) throw new Error("The required 'site' property is missing")
-  if (!config.url) throw new Error("The required 'url' property is missing")
-  if (typeof config.url !== 'function' && typeof config.url !== 'string')
-    throw new Error("The 'url' property should return the function or string")
-  if (!config.parser) throw new Error("The required 'parser' function is missing")
-  if (typeof config.parser !== 'function')
-    throw new Error("The 'parser' property should return the function")
-  if (config.logo && typeof config.logo !== 'function')
-    throw new Error("The 'logo' property should return the function")
+dayjs.extend(utc)
 
-  const defaultConfig = {
-    days: 1,
-    lang: 'en',
-    delay: 3000,
-    output: 'guide.xml',
-    request: {
-      method: 'GET',
-      maxContentLength: 5 * 1024 * 1024,
-      timeout: 5000,
-      withCredentials: true,
-      jar: new tough.CookieJar(),
-      responseType: 'arraybuffer',
-      cache: false
-    }
-  }
+module.exports.sleep = sleep
+module.exports.getUTCDate = getUTCDate
+module.exports.isPromise = isPromise
+module.exports.isObject = isObject
+module.exports.escapeString = escapeString
+module.exports.parseInteger = parseInteger
 
-  return merge(defaultConfig, config)
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
 }
 
-utils.createClient = function (config) {
-  const client = setupCache(axios.create())
-  client.interceptors.request.use(
-    function (request) {
-      if (config.debug) {
-        console.log('Request:', JSON.stringify(request, null, 2))
-      }
-      return request
-    },
-    function (error) {
-      return Promise.reject(error)
-    }
-  )
-  client.interceptors.response.use(
-    function (response) {
-      if (config.debug) {
-        const data =
-          utils.isObject(response.data) || Array.isArray(response.data)
-            ? JSON.stringify(response.data)
-            : response.data.toString()
-        console.log(
-          'Response:',
-          JSON.stringify(
-            {
-              headers: response.headers,
-              data,
-              cached: response.cached
-            },
-            null,
-            2
-          )
-        )
-      }
-
-      clearTimeout(timeout)
-      return response
-    },
-    function (error) {
-      clearTimeout(timeout)
-      return Promise.reject(error)
-    }
-  )
-
-  return client
+function isObject(a) {
+  return !!a && a.constructor === Object
 }
 
-utils.parseChannels = function (xml) {
-  const result = convert.xml2js(xml)
-  const siteTag = result.elements.find(el => el.name === 'site') || {}
-  if (!siteTag.elements) return []
-  const site = siteTag.attributes.site
-
-  const channelsTag = siteTag.elements.find(el => el.name === 'channels')
-  if (!channelsTag.elements) return []
-
-  const channels = channelsTag.elements
-    .filter(el => el.name === 'channel')
-    .map(el => {
-      const channel = el.attributes
-      if (!el.elements) throw new Error(`Channel '${channel.xmltv_id}' has no valid name`)
-      channel.name = el.elements.find(el => el.type === 'text').text
-      channel.site = channel.site || site
-
-      return channel
-    })
-
-  return { site, channels }
+function isPromise(promise) {
+  return !!promise && typeof promise.then === 'function'
 }
 
-utils.sleep = function (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
+function getUTCDate(d = null) {
+  if (typeof d === 'string') return dayjs.utc(d).startOf('d')
+
+  return dayjs.utc().startOf('d')
 }
 
-utils.escapeString = function (string, defaultValue = '') {
+function escapeString(string, defaultValue = '') {
   if (!string) return defaultValue
 
   const regex = new RegExp(
@@ -149,372 +56,6 @@ utils.escapeString = function (string, defaultValue = '') {
     .trim()
 }
 
-utils.convertToXMLTV = function ({ channels, programs, date = dayjs.utc() }) {
-  let output = `<?xml version="1.0" encoding="UTF-8" ?><tv date="${dayjs(date).format(
-    'YYYYMMDD'
-  )}">\r\n`
-  for (let channel of channels) {
-    const id = utils.escapeString(channel['xmltv_id'])
-    const displayName = utils.escapeString(channel.name)
-    output += `<channel id="${id}"><display-name>${displayName}</display-name>`
-    if (channel.logo) {
-      const logo = utils.escapeString(channel.logo)
-      output += `<icon src="${logo}"/>`
-    }
-    if (channel.site) {
-      const url = channel.site ? 'https://' + channel.site : null
-      output += `<url>${url}</url>`
-    }
-    output += `</channel>\r\n`
-  }
-
-  for (let program of programs) {
-    if (!program) continue
-
-    const channel = utils.escapeString(program.channel)
-    const title = utils.escapeString(program.title)
-    const description = utils.escapeString(program.description)
-    const categories = Array.isArray(program.category) ? program.category : [program.category]
-    const start = program.start ? dayjs.unix(program.start).utc().format('YYYYMMDDHHmmss ZZ') : ''
-    const stop = program.stop ? dayjs.unix(program.stop).utc().format('YYYYMMDDHHmmss ZZ') : ''
-    const lang = program.lang || 'en'
-    const xmltv_ns = createXMLTVNS(program.season, program.episode)
-    const onscreen = createOnScreen(program.season, program.episode)
-    const date = program.date || ''
-    const credits = createCredits({
-      director: program.director,
-      actor: program.actor,
-      writer: program.writer,
-      adapter: program.adapter,
-      producer: program.producer,
-      composer: program.composer,
-      editor: program.editor,
-      presenter: program.presenter,
-      commentator: program.commentator,
-      guest: program.guest
-    })
-    const icon = utils.escapeString(program.icon)
-    const sub_title = utils.escapeString(program.sub_title)
-    const url = program.url ? createURL(program.url, channel) : ''
-
-    if (start && stop && title) {
-      output += `<programme start="${start}" stop="${stop}" channel="${channel}"><title lang="${lang}">${title}</title>`
-
-      if (sub_title) {
-        output += `<sub-title>${sub_title}</sub-title>`
-      }
-
-      if (description) {
-        output += `<desc lang="${lang}">${description}</desc>`
-      }
-
-      if (categories.length) {
-        categories.forEach(category => {
-          if (category) {
-            output += `<category lang="${lang}">${utils.escapeString(category)}</category>`
-          }
-        })
-      }
-
-      if (url) {
-        output += url
-      }
-
-      if (xmltv_ns) {
-        output += `<episode-num system="xmltv_ns">${xmltv_ns}</episode-num>`
-      }
-
-      if (onscreen) {
-        output += `<episode-num system="onscreen">${onscreen}</episode-num>`
-      }
-      if (date) {
-        output += `<date>${date}</date>`
-      }
-
-      if (icon) {
-        output += `<icon src="${icon}"/>`
-      }
-
-      if (credits) {
-        output += `<credits>${credits}</credits>`
-      }
-
-      output += '</programme>\r\n'
-    }
-  }
-
-  output += '</tv>'
-
-  function createXMLTVNS(s, e) {
-    if (!e) return null
-    s = s || 1
-
-    return `${s - 1}.${e - 1}.0/1`
-  }
-
-  function createOnScreen(s, e) {
-    if (!e) return null
-    s = s || 1
-
-    s = padStart(s, 2, '0')
-    e = padStart(e, 2, '0')
-
-    return `S${s}E${e}`
-  }
-
-  function createURL(urlObj, channel = '') {
-    const urls = Array.isArray(urlObj) ? urlObj : [urlObj]
-    let output = ''
-    for (let url of urls) {
-      if (typeof url === 'string' || url instanceof String) {
-        url = { value: url }
-      }
-
-      let attr = url.system ? ` system="${url.system}"` : ''
-      if (url.value.includes('http')) {
-        output += `<url${attr}>${url.value}</url>`
-      } else if (channel) {
-        let chan = channels.find(c => c.xmltv_id.localeCompare(channel) === 0)
-        if (chan && chan.site) {
-          output += `<url${attr}>https://${chan.site}${url.value}</url>`
-        }
-      }
-    }
-
-    return output
-  }
-
-  function createImage(imgObj, channel = '') {
-    const imgs = Array.isArray(imgObj) ? imgObj : [imgObj]
-    let output = ''
-    for (let img of imgs) {
-      if (typeof img === 'string' || img instanceof String) {
-        img = { value: img }
-      }
-
-      const imageTypes = ['poster', 'backdrop', 'still', 'person', 'character']
-      const imageSizes = ['1', '2', '3']
-      const imageOrients = ['P', 'L']
-
-      let attr = ''
-
-      if (img.type && imageTypes.some(el => img.type.includes(el))) {
-        attr += ` type="${img.type}"`
-      }
-
-      if (img.size && imageSizes.some(el => img.size.includes(el))) {
-        attr += ` size="${img.size}"`
-      }
-
-      if (img.orient && imageOrients.some(el => img.orient.includes(el))) {
-        attr += ` orient="${img.orient}"`
-      }
-
-      if (img.system) {
-        attr += ` system="${img.system}"`
-      }
-
-      if (img.value.includes('http')) {
-        output += `<image${attr}>${img.value}</image>`
-      } else if (channel) {
-        let chan = channels.find(c => c.xmltv_id.localeCompare(channel) === 0)
-        if (chan && chan.site) {
-          output += `<image${attr}>https://${chan.site}${img.value}</image>`
-        }
-      }
-    }
-
-    return output
-  }
-
-  function createCredits(obj) {
-    let cast = Object.entries(obj)
-      .filter(x => x[1])
-      .map(([name, value]) => ({ name, value }))
-
-    let output = ''
-    for (let type of cast) {
-      const r = Array.isArray(type.value) ? type.value : [type.value]
-      for (let person of r) {
-        if (typeof person === 'string' || person instanceof String) {
-          person = { value: person }
-        }
-
-        let attr = ''
-        if (type.name.localeCompare('actor') === 0 && type.value.role) {
-          attr += ` role="${type.value.role}"`
-        }
-        if (type.name.localeCompare('actor') === 0 && type.value.guest) {
-          attr += ` guest="${type.value.guest}"`
-        }
-        output += `<${type.name}${attr}>${person.value}`
-
-        if (person.url) {
-          output += createURL(person.url)
-        }
-        if (person.image) {
-          output += createImage(person.image)
-        }
-
-        output += `</${type.name}>`
-      }
-    }
-    return output
-  }
-  return output
-}
-
-utils.writeToFile = function (filename, data) {
-  const dir = path.resolve(path.dirname(filename))
-  if (!fs.existsSync(dir)) {
-    fs.mkdirSync(dir, { recursive: true })
-  }
-
-  fs.writeFileSync(path.resolve(filename), data)
+function parseInteger(val) {
+  return val ? parseInt(val) : null
 }
-
-utils.buildRequest = async function (item, config) {
-  const CancelToken = axios.CancelToken
-  const source = CancelToken.source()
-  const request = { ...config.request }
-  timeout = setTimeout(() => {
-    source.cancel('Connection timeout')
-  }, request.timeout)
-  const headers = await utils.getRequestHeaders(item, config)
-  request.headers = { 'User-Agent': defaultUserAgent, ...headers }
-  request.url = await utils.getRequestUrl(item, config)
-  request.data = await utils.getRequestData(item, config)
-  request.cancelToken = source.token
-
-  if (config.curl) {
-    const curl = CurlGenerator({
-      url: request.url,
-      method: request.method,
-      headers: request.headers,
-      body: request.data
-    })
-    console.log(curl)
-  }
-
-  return request
-}
-
-utils.fetchData = function (client, request) {
-  return client(request)
-}
-
-utils.getRequestHeaders = async function (item, config) {
-  if (typeof config.request.headers === 'function') {
-    const headers = config.request.headers(item)
-    if (this.isPromise(headers)) {
-      return await headers
-    }
-    return headers
-  }
-  return config.request.headers || null
-}
-
-utils.getRequestData = async function (item, config) {
-  if (typeof config.request.data === 'function') {
-    const data = config.request.data(item)
-    if (this.isPromise(data)) {
-      return await data
-    }
-    return data
-  }
-  return config.request.data || null
-}
-
-utils.getRequestUrl = async function (item, config) {
-  if (typeof config.url === 'function') {
-    const url = config.url(item)
-    if (this.isPromise(url)) {
-      return await url
-    }
-    return url
-  }
-  return config.url
-}
-
-utils.getUTCDate = function (d = null) {
-  if (typeof d === 'string') return dayjs.utc(d).startOf('d')
-
-  return dayjs.utc().startOf('d')
-}
-
-utils.parseResponse = async (item, response, config) => {
-  const data = merge(item, config, {
-    content: response.data.toString(),
-    buffer: response.data,
-    headers: response.headers,
-    request: response.request,
-    cached: response.cached
-  })
-
-  if (!item.channel.logo && config.logo) {
-    data.channel.logo = await utils.loadLogo(data, config)
-  }
-
-  return await utils.parsePrograms(data, config)
-}
-
-utils.parsePrograms = async function (data, config) {
-  let programs = config.parser(data)
-
-  if (this.isPromise(programs)) {
-    programs = await programs
-  }
-
-  if (!Array.isArray(programs)) {
-    throw new Error('Parser should return an array')
-  }
-
-  const channel = data.channel
-  return programs
-    .filter(i => i)
-    .map(program => {
-      return {
-        title: program.title,
-        description: program.description || null,
-        category: program.category || null,
-        season: program.season || null,
-        episode: program.episode || null,
-        sub_title: program.sub_title || null,
-        url: program.url || null,
-        icon: program.icon || null,
-        channel: channel.xmltv_id,
-        lang: program.lang || channel.lang || config.lang || 'en',
-        start: program.start ? dayjs(program.start).unix() : null,
-        stop: program.stop ? dayjs(program.stop).unix() : null,
-        date: program.date || null,
-        director: program.director || null,
-        actor: program.actor || null,
-        writer: program.writer || null,
-        adapter: program.adapter || null,
-        producer: program.producer || null,
-        composer: program.composer || null,
-        editor: program.editor || null,
-        presenter: program.presenter || null,
-        commentator: program.commentator || null,
-        guest: program.guest || null
-      }
-    })
-}
-
-utils.loadLogo = async function (options, config) {
-  const logo = config.logo(options)
-  if (this.isPromise(logo)) {
-    return await logo
-  }
-  return logo
-}
-
-utils.isPromise = function (promise) {
-  return !!promise && typeof promise.then === 'function'
-}
-
-utils.isObject = function (a) {
-  return !!a && a.constructor === Object
-}
-
-module.exports = utils

package/src/xmltv.js

@@ -0,0 +1,187 @@
+const { padStart } = require('lodash')
+const { escapeString, getUTCDate } = require('./utils')
+const dayjs = require('dayjs')
+const utc = require('dayjs/plugin/utc')
+
+dayjs.extend(utc)
+
+module.exports.generate = generate
+
+function generate({ channels, programs, date = getUTCDate() }) {
+	let output = `<?xml version="1.0" encoding="UTF-8" ?>`
+	output += createElements(channels, programs, date)
+
+	return output
+}
+
+const el = createElement
+
+function createElements(channels, programs, date) {
+	date = formatDate(date, 'YYYYMMDD')
+	return el('tv', { date }, [
+		...channels.map(channel => {
+			const url = channel.site ? `https://${channel.site}` : ''
+
+			return (
+				'\r\n' +
+				el('channel', { id: channel.xmltv_id }, [
+					el('display-name', {}, [escapeString(channel.name)]),
+					el('icon', { src: channel.logo }),
+					el('url', {}, [url])
+				])
+			)
+		}),
+		...programs.map(program => {
+			const programDate = program.date ? formatDate(program.date, 'YYYYMMDD') : ''
+
+			return (
+				'\r\n' +
+				el(
+					'programme',
+					{
+						start: formatDate(program.start, 'YYYYMMDDHHmmss ZZ'),
+						stop: formatDate(program.stop, 'YYYYMMDDHHmmss ZZ'),
+						channel: program.channel
+					},
+					[
+						el('title', {}, [escapeString(program.title)]),
+						el('sub-title', {}, [escapeString(program.sub_title)]),
+						el('desc', {}, [escapeString(program.description)]),
+						el('credits', {}, [
+							...toArray(program.director).map(data => createCastMember('director', data)),
+							...toArray(program.actor).map(data => createCastMember('actor', data)),
+							...toArray(program.writer).map(data => createCastMember('writer', data)),
+							...toArray(program.adapter).map(data => createCastMember('adapter', data)),
+							...toArray(program.producer).map(data => createCastMember('producer', data)),
+							...toArray(program.composer).map(data => createCastMember('composer', data)),
+							...toArray(program.editor).map(data => createCastMember('editor', data)),
+							...toArray(program.presenter).map(data => createCastMember('presenter', data)),
+							...toArray(program.commentator).map(data => createCastMember('commentator', data)),
+							...toArray(program.guest).map(data => createCastMember('guest', data))
+						]),
+						el('date', {}, [programDate]),
+						...toArray(program.category).map(category =>
+							el('category', {}, [escapeString(category)])
+						),
+						el('icon', { src: program.icon }),
+						...toArray(program.url).map(createURL),
+						el('episode-num', { system: 'xmltv_ns' }, [
+							formatEpisodeNum(program.season, program.episode, 'xmltv_ns')
+						]),
+						el('episode-num', { system: 'onscreen' }, [
+							formatEpisodeNum(program.season, program.episode, 'onscreen')
+						]),
+						...toArray(program.rating).map(rating =>
+							el('rating', { system: rating.system }, [
+								el('value', {}, [rating.value]),
+								el('icon', { src: rating.icon })
+							])
+						)
+					]
+				)
+			)
+		})
+	])
+}
+
+function formatEpisodeNum(s, e, system) {
+	switch (system) {
+		case 'xmltv_ns':
+			return createXMLTVNS(s, e)
+		case 'onscreen':
+			return createOnScreen(s, e)
+	}
+
+	return ''
+}
+
+function createXMLTVNS(s, e) {
+	if (!e) return ''
+	s = s || 1
+
+	return `${s - 1}.${e - 1}.0/1`
+}
+
+function createOnScreen(s, e) {
+	if (!e) return ''
+	s = s || 1
+
+	s = padStart(s, 2, '0')
+	e = padStart(e, 2, '0')
+
+	return `S${s}E${e}`
+}
+
+function createCastMember(position, data) {
+	data = toObject(data)
+	return el(position, {}, [
+		escapeString(data.value),
+		...toArray(data.url).map(createURL),
+		...toArray(data.image).map(createImage)
+	])
+}
+
+function createImage(image) {
+	image = toObject(image)
+	return el(
+		'image',
+		{
+			type: image.type,
+			size: image.size,
+			orient: image.orient,
+			system: image.system
+		},
+		[image.value]
+	)
+}
+
+function createURL(url) {
+	url = toObject(url)
+	return el('url', { system: url.system }, [url.value])
+}
+
+function toObject(value) {
+	if (typeof value === 'string') return { value }
+
+	return value
+}
+
+function toArray(value) {
+	if (Array.isArray(value)) return value.filter(Boolean)
+
+	return [value].filter(Boolean)
+}
+
+function formatDate(date, format) {
+	return date ? dayjs.utc(date).format(format) : null
+}
+
+function createElement(name, attrs = {}, children = []) {
+	return toString({ name, attrs, children })
+}
+
+function toString(elem) {
+	if (typeof elem === 'string') return elem
+
+	let attrs = ''
+	for (let key in elem.attrs) {
+		let value = elem.attrs[key]
+		if (value) {
+			attrs += ` ${key}="${escapeString(value)}"`
+		}
+	}
+
+	if (elem.children.filter(Boolean).length) {
+		let children = ''
+		elem.children.forEach(childElem => {
+			children += toString(childElem)
+		})
+
+		return `<${elem.name}${attrs}>${children}</${elem.name}>`
+	}
+
+	if (!attrs) return ''
+	if (!['icon'].includes(elem.name)) return ''
+
+	return `<${elem.name}${attrs}/>`
+}