index.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. 'use strict'
  2. const { normalizeIPv6, removeDotSegments, recomposeAuthority, normalizeComponentEncoding, isIPv4, nonSimpleDomain } = require('./lib/utils')
  3. const { SCHEMES, getSchemeHandler } = require('./lib/schemes')
  4. /**
  5. * @template {import('./types/index').URIComponent|string} T
  6. * @param {T} uri
  7. * @param {import('./types/index').Options} [options]
  8. * @returns {T}
  9. */
  10. function normalize (uri, options) {
  11. if (typeof uri === 'string') {
  12. uri = /** @type {T} */ (serialize(parse(uri, options), options))
  13. } else if (typeof uri === 'object') {
  14. uri = /** @type {T} */ (parse(serialize(uri, options), options))
  15. }
  16. return uri
  17. }
  18. /**
  19. * @param {string} baseURI
  20. * @param {string} relativeURI
  21. * @param {import('./types/index').Options} [options]
  22. * @returns {string}
  23. */
  24. function resolve (baseURI, relativeURI, options) {
  25. const schemelessOptions = options ? Object.assign({ scheme: 'null' }, options) : { scheme: 'null' }
  26. const resolved = resolveComponent(parse(baseURI, schemelessOptions), parse(relativeURI, schemelessOptions), schemelessOptions, true)
  27. schemelessOptions.skipEscape = true
  28. return serialize(resolved, schemelessOptions)
  29. }
  30. /**
  31. * @param {import ('./types/index').URIComponent} base
  32. * @param {import ('./types/index').URIComponent} relative
  33. * @param {import('./types/index').Options} [options]
  34. * @param {boolean} [skipNormalization=false]
  35. * @returns {import ('./types/index').URIComponent}
  36. */
  37. function resolveComponent (base, relative, options, skipNormalization) {
  38. /** @type {import('./types/index').URIComponent} */
  39. const target = {}
  40. if (!skipNormalization) {
  41. base = parse(serialize(base, options), options) // normalize base component
  42. relative = parse(serialize(relative, options), options) // normalize relative component
  43. }
  44. options = options || {}
  45. if (!options.tolerant && relative.scheme) {
  46. target.scheme = relative.scheme
  47. // target.authority = relative.authority;
  48. target.userinfo = relative.userinfo
  49. target.host = relative.host
  50. target.port = relative.port
  51. target.path = removeDotSegments(relative.path || '')
  52. target.query = relative.query
  53. } else {
  54. if (relative.userinfo !== undefined || relative.host !== undefined || relative.port !== undefined) {
  55. // target.authority = relative.authority;
  56. target.userinfo = relative.userinfo
  57. target.host = relative.host
  58. target.port = relative.port
  59. target.path = removeDotSegments(relative.path || '')
  60. target.query = relative.query
  61. } else {
  62. if (!relative.path) {
  63. target.path = base.path
  64. if (relative.query !== undefined) {
  65. target.query = relative.query
  66. } else {
  67. target.query = base.query
  68. }
  69. } else {
  70. if (relative.path[0] === '/') {
  71. target.path = removeDotSegments(relative.path)
  72. } else {
  73. if ((base.userinfo !== undefined || base.host !== undefined || base.port !== undefined) && !base.path) {
  74. target.path = '/' + relative.path
  75. } else if (!base.path) {
  76. target.path = relative.path
  77. } else {
  78. target.path = base.path.slice(0, base.path.lastIndexOf('/') + 1) + relative.path
  79. }
  80. target.path = removeDotSegments(target.path)
  81. }
  82. target.query = relative.query
  83. }
  84. // target.authority = base.authority;
  85. target.userinfo = base.userinfo
  86. target.host = base.host
  87. target.port = base.port
  88. }
  89. target.scheme = base.scheme
  90. }
  91. target.fragment = relative.fragment
  92. return target
  93. }
  94. /**
  95. * @param {import ('./types/index').URIComponent|string} uriA
  96. * @param {import ('./types/index').URIComponent|string} uriB
  97. * @param {import ('./types/index').Options} options
  98. * @returns {boolean}
  99. */
  100. function equal (uriA, uriB, options) {
  101. if (typeof uriA === 'string') {
  102. uriA = unescape(uriA)
  103. uriA = serialize(normalizeComponentEncoding(parse(uriA, options), true), { ...options, skipEscape: true })
  104. } else if (typeof uriA === 'object') {
  105. uriA = serialize(normalizeComponentEncoding(uriA, true), { ...options, skipEscape: true })
  106. }
  107. if (typeof uriB === 'string') {
  108. uriB = unescape(uriB)
  109. uriB = serialize(normalizeComponentEncoding(parse(uriB, options), true), { ...options, skipEscape: true })
  110. } else if (typeof uriB === 'object') {
  111. uriB = serialize(normalizeComponentEncoding(uriB, true), { ...options, skipEscape: true })
  112. }
  113. return uriA.toLowerCase() === uriB.toLowerCase()
  114. }
  115. /**
  116. * @param {Readonly<import('./types/index').URIComponent>} cmpts
  117. * @param {import('./types/index').Options} [opts]
  118. * @returns {string}
  119. */
  120. function serialize (cmpts, opts) {
  121. const component = {
  122. host: cmpts.host,
  123. scheme: cmpts.scheme,
  124. userinfo: cmpts.userinfo,
  125. port: cmpts.port,
  126. path: cmpts.path,
  127. query: cmpts.query,
  128. nid: cmpts.nid,
  129. nss: cmpts.nss,
  130. uuid: cmpts.uuid,
  131. fragment: cmpts.fragment,
  132. reference: cmpts.reference,
  133. resourceName: cmpts.resourceName,
  134. secure: cmpts.secure,
  135. error: ''
  136. }
  137. const options = Object.assign({}, opts)
  138. const uriTokens = []
  139. // find scheme handler
  140. const schemeHandler = getSchemeHandler(options.scheme || component.scheme)
  141. // perform scheme specific serialization
  142. if (schemeHandler && schemeHandler.serialize) schemeHandler.serialize(component, options)
  143. if (component.path !== undefined) {
  144. if (!options.skipEscape) {
  145. component.path = escape(component.path)
  146. if (component.scheme !== undefined) {
  147. component.path = component.path.split('%3A').join(':')
  148. }
  149. } else {
  150. component.path = unescape(component.path)
  151. }
  152. }
  153. if (options.reference !== 'suffix' && component.scheme) {
  154. uriTokens.push(component.scheme, ':')
  155. }
  156. const authority = recomposeAuthority(component)
  157. if (authority !== undefined) {
  158. if (options.reference !== 'suffix') {
  159. uriTokens.push('//')
  160. }
  161. uriTokens.push(authority)
  162. if (component.path && component.path[0] !== '/') {
  163. uriTokens.push('/')
  164. }
  165. }
  166. if (component.path !== undefined) {
  167. let s = component.path
  168. if (!options.absolutePath && (!schemeHandler || !schemeHandler.absolutePath)) {
  169. s = removeDotSegments(s)
  170. }
  171. if (
  172. authority === undefined &&
  173. s[0] === '/' &&
  174. s[1] === '/'
  175. ) {
  176. // don't allow the path to start with "//"
  177. s = '/%2F' + s.slice(2)
  178. }
  179. uriTokens.push(s)
  180. }
  181. if (component.query !== undefined) {
  182. uriTokens.push('?', component.query)
  183. }
  184. if (component.fragment !== undefined) {
  185. uriTokens.push('#', component.fragment)
  186. }
  187. return uriTokens.join('')
  188. }
  189. const URI_PARSE = /^(?:([^#/:?]+):)?(?:\/\/((?:([^#/?@]*)@)?(\[[^#/?\]]+\]|[^#/:?]*)(?::(\d*))?))?([^#?]*)(?:\?([^#]*))?(?:#((?:.|[\n\r])*))?/u
  190. /**
  191. * @param {string} uri
  192. * @param {import('./types/index').Options} [opts]
  193. * @returns
  194. */
  195. function parse (uri, opts) {
  196. const options = Object.assign({}, opts)
  197. /** @type {import('./types/index').URIComponent} */
  198. const parsed = {
  199. scheme: undefined,
  200. userinfo: undefined,
  201. host: '',
  202. port: undefined,
  203. path: '',
  204. query: undefined,
  205. fragment: undefined
  206. }
  207. let isIP = false
  208. if (options.reference === 'suffix') {
  209. if (options.scheme) {
  210. uri = options.scheme + ':' + uri
  211. } else {
  212. uri = '//' + uri
  213. }
  214. }
  215. const matches = uri.match(URI_PARSE)
  216. if (matches) {
  217. // store each component
  218. parsed.scheme = matches[1]
  219. parsed.userinfo = matches[3]
  220. parsed.host = matches[4]
  221. parsed.port = parseInt(matches[5], 10)
  222. parsed.path = matches[6] || ''
  223. parsed.query = matches[7]
  224. parsed.fragment = matches[8]
  225. // fix port number
  226. if (isNaN(parsed.port)) {
  227. parsed.port = matches[5]
  228. }
  229. if (parsed.host) {
  230. const ipv4result = isIPv4(parsed.host)
  231. if (ipv4result === false) {
  232. const ipv6result = normalizeIPv6(parsed.host)
  233. parsed.host = ipv6result.host.toLowerCase()
  234. isIP = ipv6result.isIPV6
  235. } else {
  236. isIP = true
  237. }
  238. }
  239. if (parsed.scheme === undefined && parsed.userinfo === undefined && parsed.host === undefined && parsed.port === undefined && parsed.query === undefined && !parsed.path) {
  240. parsed.reference = 'same-document'
  241. } else if (parsed.scheme === undefined) {
  242. parsed.reference = 'relative'
  243. } else if (parsed.fragment === undefined) {
  244. parsed.reference = 'absolute'
  245. } else {
  246. parsed.reference = 'uri'
  247. }
  248. // check for reference errors
  249. if (options.reference && options.reference !== 'suffix' && options.reference !== parsed.reference) {
  250. parsed.error = parsed.error || 'URI is not a ' + options.reference + ' reference.'
  251. }
  252. // find scheme handler
  253. const schemeHandler = getSchemeHandler(options.scheme || parsed.scheme)
  254. // check if scheme can't handle IRIs
  255. if (!options.unicodeSupport && (!schemeHandler || !schemeHandler.unicodeSupport)) {
  256. // if host component is a domain name
  257. if (parsed.host && (options.domainHost || (schemeHandler && schemeHandler.domainHost)) && isIP === false && nonSimpleDomain(parsed.host)) {
  258. // convert Unicode IDN -> ASCII IDN
  259. try {
  260. parsed.host = URL.domainToASCII(parsed.host.toLowerCase())
  261. } catch (e) {
  262. parsed.error = parsed.error || "Host's domain name can not be converted to ASCII: " + e
  263. }
  264. }
  265. // convert IRI -> URI
  266. }
  267. if (!schemeHandler || (schemeHandler && !schemeHandler.skipNormalize)) {
  268. if (uri.indexOf('%') !== -1) {
  269. if (parsed.scheme !== undefined) {
  270. parsed.scheme = unescape(parsed.scheme)
  271. }
  272. if (parsed.host !== undefined) {
  273. parsed.host = unescape(parsed.host)
  274. }
  275. }
  276. if (parsed.path) {
  277. parsed.path = escape(unescape(parsed.path))
  278. }
  279. if (parsed.fragment) {
  280. parsed.fragment = encodeURI(decodeURIComponent(parsed.fragment))
  281. }
  282. }
  283. // perform scheme specific parsing
  284. if (schemeHandler && schemeHandler.parse) {
  285. schemeHandler.parse(parsed, options)
  286. }
  287. } else {
  288. parsed.error = parsed.error || 'URI can not be parsed.'
  289. }
  290. return parsed
  291. }
  292. const fastUri = {
  293. SCHEMES,
  294. normalize,
  295. resolve,
  296. resolveComponent,
  297. equal,
  298. serialize,
  299. parse
  300. }
  301. module.exports = fastUri
  302. module.exports.default = fastUri
  303. module.exports.fastUri = fastUri