Skip to content

Commit bb6c00d

Browse files
RangerMauveRangerMauve
authored
Merge pull request #21 from akhileshthite/decode-url
fix: handle URL-encoded filenames in protocol resolver
2 parents 610df38 + 2011f95 commit bb6c00d

File tree

1 file changed

+95
-40
lines changed

1 file changed

+95
-40
lines changed

‎index.js

+95-40
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { CID } from 'multiformats/cid'
1010
import { base32 } from 'multiformats/bases/base32'
1111
import { base36 } from 'multiformats/bases/base36'
1212

13-
// Different from raw JSON. Determenistic
13+
// Different from raw JSON. Deterministic
1414
import * as dagJSON from '@ipld/dag-json'
1515
import * as cbor from '@ipld/dag-cbor'
1616

@@ -147,7 +147,8 @@ export default function makeIPFSFetch ({
147147
// TODO: better status?
148148
status: 400,
149149
headers: defaultHeaders,
150-
body: 'Unsupproted content-type, must be dag-cbor, application/json, or dag-json'
150+
body:
151+
'Unsupported content-type, must be dag-cbor, application/json, or dag-json'
151152
}
152153
}
153154

@@ -199,7 +200,8 @@ export default function makeIPFSFetch ({
199200
// TODO: better status?
200201
status: 400,
201202
headers: defaultHeaders,
202-
body: 'Unsupproted content-type, must be dag-cbor, application/json, or dag-json'
203+
body:
204+
'Unsupported content-type, must be dag-cbor, application/json, or dag-json'
203205
}
204206
}
205207

@@ -284,7 +286,7 @@ export default function makeIPFSFetch ({
284286
const { url, signal } = request
285287
const topic = new URL(url).hostname
286288
const payload = await request.arrayBuffer()
287-
// TODO: Handle oversized messages wihth 413
289+
// TODO: Handle oversized messages with 413
288290
await ipfs.pubsub.publish(topic, payload, {
289291
signal,
290292
timeout
@@ -318,6 +320,7 @@ export default function makeIPFSFetch ({
318320
}
319321
}
320322
})
323+
321324
// TODO: Generate from headers somehow
322325
router.post(`ipns://${SPECIAL_HOSTNAME}/`, async ({ url, signal }) => {
323326
const key = new URL(url).searchParams.get('key')
@@ -333,9 +336,11 @@ export default function makeIPFSFetch ({
333336
status: 201,
334337
headers: {
335338
Location: keyURL
336-
}
339+
},
340+
body: keyURL
337341
}
338342
})
343+
339344
router.delete(`ipns://${SPECIAL_HOSTNAME}/`, async ({ url, signal }) => {
340345
const key = new URL(url).searchParams.get('key')
341346
await ipfs.key.rm(key, {
@@ -417,7 +422,7 @@ export default function makeIPFSFetch ({
417422
const contentType = headers.get('Content-Type') || ''
418423
const isFormData = contentType.includes('multipart/form-data')
419424

420-
const ipnsPath = urlToIPFSPath(url)
425+
const ipnsPath = urlToIPNSPath(url)
421426
const split = ipnsPath.split('/')
422427
const keyName = split[2]
423428
const subpath = split.slice(3).join('/')
@@ -445,7 +450,9 @@ export default function makeIPFSFetch ({
445450
const { hostname: keyName } = new URL(url)
446451

447452
const rawValue = await request.text()
448-
const value = rawValue.replace(/^ipfs:\/\//, '/ipfs/').replace(/^ipns:\/\//, '/ipns/')
453+
const value = rawValue
454+
.replace(/^ipfs:\/\//, '/ipfs/')
455+
.replace(/^ipns:\/\//, '/ipns/')
449456

450457
return updateIPNS(keyName, value, signal)
451458
})
@@ -462,7 +469,9 @@ export default function makeIPFSFetch ({
462469
const ipfsPath = await resolveIPNS(ipnsPath, signal)
463470
const { body: updatedURL } = await deleteData(ipfsPath, signal)
464471

465-
const value = updatedURL.replace(/^ipfs:\/\//, '/ipfs/').replace(/^ipns:\/\//, '/ipns/')
472+
const value = updatedURL
473+
.replace(/^ipfs:\/\//, '/ipfs/')
474+
.replace(/^ipns:\/\//, '/ipns/')
466475

467476
return updateIPNS(keyName, value, signal)
468477
})
@@ -505,24 +514,30 @@ export default function makeIPFSFetch ({
505514
const accept = reqHeaders.get('Accept') || ''
506515
const expectedType = format || accept
507516

508-
const headers = { ...defaultHeaders }
517+
const headersResponse = { ...defaultHeaders }
509518

510-
if (expectedType === 'raw' || expectedType === 'application/vnd.ipld.raw') {
519+
if (
520+
expectedType === 'raw' ||
521+
expectedType === 'application/vnd.ipld.raw'
522+
) {
511523
const body = await ipfs.block.get(ipfsPath, {
512524
timeout,
513525
signal
514526
})
515527

516-
headers['Content-Type'] = 'application/vnd.ipld.raw'
528+
headersResponse['Content-Type'] = 'application/vnd.ipld.raw'
517529

518530
return {
519531
status: 200,
520-
headers,
532+
headers: headersResponse,
521533
body
522534
}
523535
}
524536

525-
if (expectedType === 'car' || expectedType === 'application/vnd.ipld.car') {
537+
if (
538+
expectedType === 'car' ||
539+
expectedType === 'application/vnd.ipld.car'
540+
) {
526541
const { cid } = await ipfs.dag.resolve(ipfsPath, {
527542
timeout,
528543
signal
@@ -533,11 +548,11 @@ export default function makeIPFSFetch ({
533548
signal
534549
})
535550

536-
headers['Content-Type'] = 'application/vnd.ipld.car'
551+
headersResponse['Content-Type'] = 'application/vnd.ipld.car'
537552

538553
return {
539554
status: 200,
540-
headers,
555+
headers: headersResponse,
541556
body
542557
}
543558
}
@@ -551,34 +566,49 @@ export default function makeIPFSFetch ({
551566

552567
try {
553568
const stats = await collect(ipfs.ls(ipfsPath, { signal, timeout }))
554-
const files = stats.map(({ name, type }) => (type === 'dir') ? `${name}/` : name)
569+
// Decode path segments for accurate file names
570+
const files = stats.map(({ name, type }) =>
571+
type === 'dir' ? `${decodeURIComponent(name)}/` : decodeURIComponent(name)
572+
)
555573

556574
if (files.includes('index.html')) {
557575
if (!searchParams.has('noResolve')) {
558-
return serveFile(posixPath.join(ipfsPath, 'index.html'), searchParams, reqHeaders, headers, signal)
576+
return serveFile(
577+
posixPath.join(ipfsPath, 'index.html'),
578+
searchParams,
579+
reqHeaders,
580+
headersResponse,
581+
signal
582+
)
559583
}
560584
}
561585

562586
if (accept.includes('text/html')) {
563-
const page = await renderIndex(url, files, fetch)
564-
headers['Content-Type'] = 'text/html; charset=utf-8'
587+
// Encode file names to handle spaces and special characters
588+
const encodedFiles = files.map((file) =>
589+
file.endsWith('/')
590+
? `${encodeURIComponent(file.slice(0, -1))}/`
591+
: encodeURIComponent(file)
592+
)
593+
const page = await renderIndex(url, encodedFiles, fetch)
594+
headersResponse['Content-Type'] = 'text/html; charset=utf-8'
565595
body = page
566596
} else {
567597
const json = JSON.stringify(files, null, '\t')
568-
headers['Content-Type'] = `${MIME_JSON}; charset=utf-8`
598+
headersResponse['Content-Type'] = `${MIME_JSON}; charset=utf-8`
569599
body = json
570600
}
571601

572602
return {
573603
status: 200,
574-
headers,
604+
headers: headersResponse,
575605
body
576606
}
577607
} catch {
578-
return serveFile(ipfsPath, searchParams, reqHeaders, headers, signal)
608+
return serveFile(ipfsPath, searchParams, reqHeaders, headersResponse, signal)
579609
}
580610
} else {
581-
return serveFile(ipfsPath, searchParams, reqHeaders, headers, signal)
611+
return serveFile(ipfsPath, searchParams, reqHeaders, headersResponse, signal)
582612
}
583613
}
584614

@@ -590,11 +620,10 @@ export default function makeIPFSFetch ({
590620
if (stat.type === 'directory') {
591621
// TODO: Something for directories?
592622
if (!noResolve) {
593-
const stats = await collect(ipfs.ls(ipfsPath, {
594-
signal,
595-
timeout
596-
}))
597-
const files = stats.map(({ name, type }) => (type === 'dir') ? `${name}/` : name)
623+
const stats = await collect(ipfs.ls(ipfsPath, { signal, timeout }))
624+
const files = stats.map(({ name, type }) =>
625+
type === 'dir' ? `${decodeURIComponent(name)}/` : decodeURIComponent(name)
626+
)
598627
if (files.includes('index.html')) {
599628
ipfsPath = posixPath.join(ipfsPath, 'index.html')
600629
} else {
@@ -636,7 +665,7 @@ export default function makeIPFSFetch ({
636665
const ranges = parseRange(size, isRanged)
637666
if (ranges && ranges.length && ranges.type === 'bytes') {
638667
const [{ start, end }] = ranges
639-
const length = (end - start + 1)
668+
const length = end - start + 1
640669
headers['Content-Length'] = `${length}`
641670
headers['Content-Range'] = `bytes ${start}-${end}/${size}`
642671
return {
@@ -731,7 +760,9 @@ export default function makeIPFSFetch ({
731760
return keys.find(({ name, id }) => {
732761
if (name === keyName) return true
733762
try {
734-
return (CID.parse(id, bases).toV1().toString(base36) === keyName)
763+
return (
764+
CID.parse(id, bases).toV1().toString(base36) === keyName
765+
)
735766
} catch {
736767
return false
737768
}
@@ -777,7 +808,7 @@ export default function makeIPFSFetch ({
777808
}
778809
}
779810

780-
async function uploadData (ipfsPath, response, isFormData, signal) {
811+
async function uploadData (ipfsPath, request, isFormData, signal) {
781812
const tmpDir = makeTmpDir()
782813
const { rootCID, relativePath } = cidFromPath(ipfsPath)
783814

@@ -791,16 +822,16 @@ export default function makeIPFSFetch ({
791822
}
792823

793824
if (isFormData) {
794-
const formData = await response.formData()
825+
const formData = await request.formData()
795826
const toWait = []
796827

797828
for (const [fieldName, fileData] of formData) {
798-
// TODO: Should we filter by field name?
829+
// Filter by field name if necessary
799830
if (fieldName !== 'file') continue
800-
// Must not be a file
831+
// Must have a filename
801832
if (!fileData.name) continue
802833
const fileName = fileData.name
803-
const finalPath = posixPath.join(tmpDir, relativePath, fileName)
834+
const finalPath = posixPath.join(tmpDir, relativePath, encodeURIComponent(fileName))
804835
const result = ipfs.files.write(finalPath, fileData, {
805836
cidVersion: 1,
806837
parents: true,
@@ -815,9 +846,12 @@ export default function makeIPFSFetch ({
815846

816847
await Promise.all(toWait)
817848
} else {
818-
const path = posixPath.join(tmpDir, ensureStartingSlash(stripEndingSlash(relativePath)))
849+
const path = posixPath.join(
850+
tmpDir,
851+
ensureStartingSlash(stripEndingSlash(relativePath))
852+
)
819853

820-
await ipfs.files.write(path, await response.blob(), {
854+
await ipfs.files.write(path, await request.blob(), {
821855
signal,
822856
parents: true,
823857
truncate: true,
@@ -832,7 +866,13 @@ export default function makeIPFSFetch ({
832866

833867
const cidHash = cid.toString()
834868
const endPath = isFormData ? relativePath : stripEndingSlash(relativePath)
835-
const addedURL = `ipfs://${cidHash}${ensureStartingSlash(endPath)}`
869+
const encodedEndPath = isFormData
870+
? relativePath
871+
.split('/')
872+
.map((segment) => encodeURIComponent(segment))
873+
.join('/')
874+
: encodeURIComponent(endPath)
875+
const addedURL = `ipfs://${cidHash}${ensureStartingSlash(encodedEndPath)}`
836876

837877
return addedURL
838878
}
@@ -909,9 +949,24 @@ function keyToURL ({ id }) {
909949

910950
function urlToIPFSPath (url) {
911951
const { pathname, hostname } = new URL(url)
912-
return `/ipfs/${hostname}${pathname}`
952+
const decodedPathSegments = pathname
953+
.split('/')
954+
.filter(Boolean)
955+
.map((part) => decodeURIComponent(part))
956+
const encodedPathSegments = decodedPathSegments.map((part) =>
957+
encodeURIComponent(part)
958+
)
959+
return `/ipfs/${hostname}/${encodedPathSegments.join('/')}`
913960
}
961+
914962
function urlToIPNSPath (url) {
915963
const { pathname, hostname } = new URL(url)
916-
return `/ipns/${hostname}${pathname}`
964+
const decodedPathSegments = pathname
965+
.split('/')
966+
.filter(Boolean)
967+
.map((part) => decodeURIComponent(part))
968+
const encodedPathSegments = decodedPathSegments.map((part) =>
969+
encodeURIComponent(part)
970+
)
971+
return `/ipns/${hostname}/${encodedPathSegments.join('/')}`
917972
}

0 commit comments

Comments
 (0)