Skip to content

Commit

Permalink
Merge pull request #4 from OtterJS/feat/content-header-improvements
Browse files Browse the repository at this point in the history 
Feat/content header improvements
  • Loading branch information
@Lordfirespeed
Lordfirespeed authored Aug 16, 2024
2 parents 86e2b76 + 109be5f commit 27b679e
Show file tree
Hide file tree
Showing 19 changed files with 726 additions and 387 deletions.
9 changes: 9 additions & 0 deletions .changeset/nice-taxis-hear.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"@otterhttp/content-disposition": minor
"@otterhttp/content-type": minor
"@otterhttp/parameters": minor
"@otterhttp/type-is": major
---

Rely on `@otterhttp/parameters` for parsing HTTP header parameters
Refactor type-is to allow `@otterhttp/content-type` to do more heavy lifting; prefer returning `ContentType`s to strings
4 changes: 3 additions & 1 deletion packages/content-disposition/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,7 @@
"build": "tsup",
"prepack": "pnpm build"
},
"dependencies": {}
"dependencies": {
"@otterhttp/parameters": "workspace:*"
}
}
182 changes: 42 additions & 140 deletions packages/content-disposition/src/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,51 +1,26 @@
const ENCODE_URL_ATTR_CHAR_REGEXP = /[\x00-\x20"'()*,/:;<=>?@[\\\]{}\x7f]/g

const HEX_ESCAPE_REGEXP = /%[0-9A-Fa-f]{2}/
const HEX_ESCAPE_REPLACE_REGEXP = /%([0-9A-Fa-f]{2})/g
import {
decodeExtendedFieldValue,
formatParameters,
parseParameters,
validateParameterNames
} from '@otterhttp/parameters'

const NON_LATIN1_REGEXP = /[^\x20-\x7e\xa0-\xff]/g

const QESC_REGEXP = /\\([\u0000-\u007f])/g

const QUOTE_REGEXP = /([\\"])/g

const PARAM_REGEXP =
/;[\x09\x20]*([!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*=[\x09\x20]*("(?:[\x20!\x23-\x5b\x5d-\x7e\x80-\xff]|\\[\x20-\x7e])*"|[!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*/g
const TEXT_REGEXP = /^[\x20-\x7e\x80-\xff]+$/
const TOKEN_REGEXP = /^[!#$%&'*+.0-9A-Z^_`a-z|~-]+$/

const EXT_VALUE_REGEXP =
/^([A-Za-z0-9!#$%&+\-^_`{}~]+)'(?:[A-Za-z]{2,3}(?:-[A-Za-z]{3}){0,3}|[A-Za-z]{4,8}|)'((?:%[0-9A-Fa-f]{2}|[A-Za-z0-9!#$&+.^_`|~-])+)$/

const DISPOSITION_TYPE_REGEXP = /^([!#$%&'*+.0-9A-Z^_`a-z|~-]+)[\x09\x20]*(?:$|;)/

const getlatin1 = (val: unknown) => {
// simple Unicode -> ISO-8859-1 transformation
return String(val).replace(NON_LATIN1_REGEXP, '?')
}
const DISPOSITION_TYPE_REGEXP = /^([!#$%&'*+.0-9A-Z^_`a-z|~-]+)(?:$|[\x09\x20]*;)/

export class ContentDisposition {
type: string
parameters: Record<string, unknown>
constructor(type: string, parameters: Record<string, unknown>) {
parameters: Record<string, string>
constructor(type: string, parameters: Record<string, string>) {
this.type = type
this.parameters = parameters
}
}

const qstring = (val: unknown) => `"${String(val).replace(QUOTE_REGEXP, '\\$1')}"`

const pencode = (char: string) => `%${String(char).charCodeAt(0).toString(16).toUpperCase()}`

function ustring(val: unknown): string {
const str = String(val)

// percent encode as UTF-8
const encoded = encodeURIComponent(str).replace(ENCODE_URL_ATTR_CHAR_REGEXP, pencode)

return `UTF-8''${encoded}`
}

const basename = (str: string) => str.slice(str.lastIndexOf('/') + 1)

/**
Expand All @@ -54,66 +29,54 @@ const basename = (str: string) => str.slice(str.lastIndexOf('/') + 1)
export function format({
parameters,
type
}: Partial<{
parameters: Record<string, unknown>
}: {
parameters?: Record<string, string>
type: string | boolean | undefined
}>) {
}) {
if (type == null || typeof type !== 'string' || !TOKEN_REGEXP.test(type)) {
throw new TypeError('invalid type')
}

// start with normalized type
let string = String(type).toLowerCase()
// append parameters
if (parameters && typeof parameters === 'object') {
const params = Object.keys(parameters).sort()

for (const param of params) {
const val = param.slice(-1) === '*' ? ustring(parameters[param]) : qstring(parameters[param])

string += `; ${param}=${val}`
}
validateParameterNames(Object.keys(parameters))
string += formatParameters(parameters)
}

return string
}

function createParams(filename?: string, fallback?: string | boolean): Record<string, string> {
function createParams(filename?: string, fallback?: string): Record<string, string> {
if (filename == null) return {}

const params: Record<string, string> = {}

// fallback defaults to true
if (fallback == null) fallback = true
if (typeof fallback === 'string' && NON_LATIN1_REGEXP.test(fallback)) {
throw new TypeError('fallback must be ISO-8859-1 string')
}

// restrict to file base name
const name = basename(filename)

// determine if name is suitable for quoted string
const isQuotedString = TEXT_REGEXP.test(name)

// generate fallback name
const fallbackName = typeof fallback !== 'string' ? fallback && getlatin1(name) : basename(fallback)
const hasFallback = typeof fallbackName === 'string' && fallbackName !== name

// set extended filename parameter
if (hasFallback || !isQuotedString || HEX_ESCAPE_REGEXP.test(name)) {
params['filename*'] = name
// determine if name is suitable for quoted string / token
const canUseAsciiEncoding = TEXT_REGEXP.test(name)
if (canUseAsciiEncoding && fallback == null) {
return {
filename: name
}
}

// set filename parameter
if (isQuotedString || hasFallback) {
params.filename = hasFallback ? fallbackName : name
if (fallback == null) {
return {
'filename*': name
}
}

return params
return {
'filename*': name,
filename: basename(fallback)
}
}

const pdecode = (_str: string, hex: string) => String.fromCharCode(Number.parseInt(hex, 16))

/**
* Create an attachment Content-Disposition header.
*
Expand All @@ -123,97 +86,36 @@ const pdecode = (_str: string, hex: string) => String.fromCharCode(Number.parseI

export function contentDisposition(
filename?: string,
options: Partial<{
type: string
fallback: string | boolean
}> = {}
options?: {
type?: string
fallback?: string
}
): string {
// format into string
return format(new ContentDisposition(options.type || 'attachment', createParams(filename, options.fallback)))
}

function decodefield(str: string) {
const match = EXT_VALUE_REGEXP.exec(str)
if (!match) throw new TypeError('invalid extended field value')

const charset = match[1].toLowerCase()
const encoded = match[2]
let value: string
switch (charset) {
case 'iso-8859-1':
value = getlatin1(encoded.replace(HEX_ESCAPE_REPLACE_REGEXP, pdecode))
break
case 'utf-8':
try {
value = decodeURIComponent(encoded)
} catch {
throw new TypeError('invalid encoded utf-8')
}
break
default:
throw new TypeError('unsupported charset in extended field')
}

return value
return format(new ContentDisposition(options?.type ?? 'attachment', createParams(filename, options?.fallback)))
}

/**
* Parse Content-Disposition header string.
* @param header string
*/
export function parse(header: string): ContentDisposition {
let match = DISPOSITION_TYPE_REGEXP.exec(header)
const match = DISPOSITION_TYPE_REGEXP.exec(header)

if (!match) throw new TypeError('invalid type format')

// normalize type
let index = match[0].length
const index = match[0].length
const type = match[1].toLowerCase()

let key: string
const names: string[] = []
const params: Record<string, string> = {}
let value: string | string[]

// calculate index to start at
index = PARAM_REGEXP.lastIndex = match[0].slice(-1) === ';' ? index - 1 : index

// match parameters
while ((match = PARAM_REGEXP.exec(header))) {
if (match.index !== index) throw new TypeError('invalid parameter format')

index += match[0].length
key = match[1].toLowerCase()
value = match[2]

if (names.indexOf(key) !== -1) {
throw new TypeError('invalid duplicate parameter')
}

names.push(key)

if (key.indexOf('*') + 1 === key.length) {
// decode extended value
key = key.slice(0, -1)
value = decodefield(value)

// overwrite existing value
params[key] = value
continue
}

if (typeof params[key] === 'string') continue

if (value[0] === '"') {
value = value.slice(1, value.length - 1).replace(QESC_REGEXP, '$1')
}

params[key] = value
}
if (!match[0].endsWith(';')) return new ContentDisposition(type, {})

if (index !== -1 && index !== header.length) {
throw new TypeError('invalid parameter format')
const parameters = parseParameters(header.slice(index - 1))
for (const [parameterName, parameterValue] of Object.entries(parameters)) {
if (!parameterName.endsWith('*')) continue
parameters[parameterName] = decodeExtendedFieldValue(parameterValue)
}

return new ContentDisposition(type, params)
return new ContentDisposition(type, parameters)
}
4 changes: 3 additions & 1 deletion packages/content-type/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,7 @@
"build": "tsup",
"prepack": "pnpm build"
},
"dependencies": {}
"dependencies": {
"@otterhttp/parameters": "workspace:*"
}
}
Loading

0 comments on commit 27b679e

Please sign in to comment.