solid-server 5.8.6 → 5.8.8-8d509db1

package/lib/handlers/{get.js → get.mjs}

@@ -1,252 +1,254 @@
-/* eslint-disable no-mixed-operators, no-async-promise-executor */
-
-module.exports = handler
-
-const fs = require('fs')
-const glob = require('glob')
-const _path = require('path')
-const $rdf = require('rdflib')
-const Negotiator = require('negotiator')
-const mime = require('mime-types')
-
-const debug = require('debug')('solid:get')
-const debugGlob = require('debug')('solid:glob')
-const allow = require('./allow')
-
-const translate = require('../utils.js').translate
-const error = require('../http-error')
-
-const RDFs = require('../ldp').mimeTypesAsArray()
-const isRdf = require('../ldp').mimeTypeIsRdf
-
-const prepConfig = 'accept=("message/rfc822" "application/ld+json" "text/turtle")'
-
-async function handler (req, res, next) {
-  const ldp = req.app.locals.ldp
-  const prep = req.app.locals.prep
-  const includeBody = req.method === 'GET'
-  const negotiator = new Negotiator(req)
-  const baseUri = ldp.resourceMapper.resolveUrl(req.hostname, req.path)
-  const path = res.locals.path || req.path
-  const requestedType = negotiator.mediaType()
-  const possibleRDFType = negotiator.mediaType(RDFs)
-
-  // deprecated kept for compatibility
-  res.header('MS-Author-Via', 'SPARQL')
-
-  res.header('Accept-Patch', 'text/n3, application/sparql-update, application/sparql-update-single-match')
-  res.header('Accept-Post', '*/*')
-  if (!path.endsWith('/') && !glob.hasMagic(path)) res.header('Accept-Put', '*/*')
-
-  // Set live updates
-  if (ldp.live) {
-    res.header('Updates-Via', ldp.resourceMapper.resolveUrl(req.hostname).replace(/^http/, 'ws'))
-  }
-
-  debug(req.originalUrl + ' on ' + req.hostname)
-
-  const options = {
-    hostname: req.hostname,
-    path: path,
-    includeBody: includeBody,
-    possibleRDFType: possibleRDFType,
-    range: req.headers.range,
-    contentType: req.headers.accept
-  }
-
-  let ret
-  try {
-    ret = await ldp.get(options, req.accepts(['html', 'turtle', 'rdf+xml', 'n3', 'ld+json']) === 'html')
-  } catch (err) {
-    // set Accept-Put if container do not exist
-    if (err.status === 404 && path.endsWith('/')) res.header('Accept-Put', 'text/turtle')
-    // use globHandler if magic is detected
-    if (err.status === 404 && glob.hasMagic(path)) {
-      debug('forwarding to glob request')
-      return globHandler(req, res, next)
-    } else {
-      debug(req.method + ' -- Error: ' + err.status + ' ' + err.message)
-      return next(err)
-    }
-  }
-
-  let stream
-  let contentType
-  let container
-  let contentRange
-  let chunksize
-
-  if (ret) {
-    stream = ret.stream
-    contentType = ret.contentType
-    container = ret.container
-    contentRange = ret.contentRange
-    chunksize = ret.chunksize
-  }
-
-  // Till here it must exist
-  if (!includeBody) {
-    debug('HEAD only')
-    res.setHeader('Content-Type', ret.contentType)
-    return res.status(200).send('OK')
-  }
-
-  // Handle dataBrowser
-  if (requestedType && requestedType.includes('text/html')) {
-    const { path: filename } = await ldp.resourceMapper.mapUrlToFile({ url: options })
-    const mimeTypeByExt = mime.lookup(_path.basename(filename))
-    const isHtmlResource = mimeTypeByExt && mimeTypeByExt.includes('html')
-    const useDataBrowser = ldp.dataBrowserPath && (
-      container ||
-      [...RDFs, 'text/markdown'].includes(contentType) && !isHtmlResource && !ldp.suppressDataBrowser)
-
-    if (useDataBrowser) {
-      res.setHeader('Content-Type', 'text/html')
-      const defaultDataBrowser = require.resolve('mashlib/dist/databrowser.html')
-      const dataBrowserPath = ldp.dataBrowserPath === 'default' ? defaultDataBrowser : ldp.dataBrowserPath
-      debug('   sending data browser file: ' + dataBrowserPath)
-      res.sendFile(dataBrowserPath)
-      return
-    } else if (stream) { // EXIT text/html
-      res.setHeader('Content-Type', contentType)
-      return stream.pipe(res)
-    }
-  }
-
-  // If request accepts the content-type we found
-  if (stream && negotiator.mediaType([contentType])) {
-    let headers = {
-      'Content-Type': contentType
-    }
-
-    if (contentRange) {
-      headers = {
-        ...headers,
-        'Content-Range': contentRange,
-        'Accept-Ranges': 'bytes',
-        'Content-Length': chunksize
-      }
-      res.status(206)
-    }
-
-    if (prep && isRdf(contentType) && !res.sendEvents({
-      config: { prep: prepConfig },
-      body: stream,
-      isBodyStream: true,
-      headers
-    })) return
-
-    res.set(headers)
-    return stream.pipe(res)
-  }
-
-  // If it is not in our RDFs we can't even translate,
-  // Sorry, we can't help
-  if (!possibleRDFType || !RDFs.includes(contentType)) { // possibleRDFType defaults to text/turtle
-    return next(error(406, 'Cannot serve requested type: ' + contentType))
-  }
-  try {
-    // Translate from the contentType found to the possibleRDFType desired
-    const data = await translate(stream, baseUri, contentType, possibleRDFType)
-    debug(req.originalUrl + ' translating ' + contentType + ' -> ' + possibleRDFType)
-    const headers = {
-      'Content-Type': possibleRDFType
-    }
-    if (prep && isRdf(contentType) && !res.sendEvents({
-      config: { prep: prepConfig },
-      body: data,
-      headers
-    })) return
-    res.setHeader('Content-Type', possibleRDFType)
-    res.send(data)
-    return next()
-  } catch (err) {
-    debug('error translating: ' + req.originalUrl + ' ' + contentType + ' -> ' + possibleRDFType + ' -- ' + 406 + ' ' + err.message)
-    return next(error(500, 'Cannot serve requested type: ' + requestedType))
-  }
-}
-
-async function globHandler (req, res, next) {
-  const { ldp } = req.app.locals
-
-  // Ensure this is a glob for all files in a single folder
-  // https://github.com/solid/solid-spec/pull/148
-  const requestUrl = await ldp.resourceMapper.getRequestUrl(req)
-  if (!/^[^*]+\/\*$/.test(requestUrl)) {
-    return next(error(404, 'Unsupported glob pattern'))
-  }
-
-  // Extract the folder on the file system from the URL glob
-  const folderUrl = requestUrl.substr(0, requestUrl.length - 1)
-  const folderPath = (await ldp.resourceMapper.mapUrlToFile({ url: folderUrl, searchIndex: false })).path
-
-  const globOptions = {
-    noext: true,
-    nobrace: true,
-    nodir: true
-  }
-
-  glob(`${folderPath}*`, globOptions, async (err, matches) => {
-    if (err || matches.length === 0) {
-      debugGlob('No files matching the pattern')
-      return next(error(404, 'No files matching glob pattern'))
-    }
-
-    // Matches found
-    const globGraph = $rdf.graph()
-
-    debugGlob('found matches ' + matches)
-    await Promise.all(matches.map(match => new Promise(async (resolve, reject) => {
-      const urlData = await ldp.resourceMapper.mapFileToUrl({ path: match, hostname: req.hostname })
-      fs.readFile(match, { encoding: 'utf8' }, function (err, fileData) {
-        if (err) {
-          debugGlob('error ' + err)
-          return resolve()
-        }
-        // Files should be Turtle
-        if (urlData.contentType !== 'text/turtle') {
-          return resolve()
-        }
-        // The agent should have Read access to the file
-        hasReadPermissions(match, req, res, function (allowed) {
-          if (allowed) {
-            try {
-              $rdf.parse(fileData, globGraph, urlData.url, 'text/turtle')
-            } catch (parseErr) {
-              debugGlob(`error parsing ${match}: ${parseErr}`)
-            }
-          }
-          return resolve()
-        })
-      })
-    })))
-
-    const data = $rdf.serialize(undefined, globGraph, requestUrl, 'text/turtle')
-    // TODO this should be added as a middleware in the routes
-    res.setHeader('Content-Type', 'text/turtle')
-    debugGlob('returning turtle')
-
-    res.send(data)
-    next()
-  })
-}
-
-// TODO: get rid of this ugly hack that uses the Allow handler to check read permissions
-function hasReadPermissions (file, req, res, callback) {
-  const ldp = req.app.locals.ldp
-
-  if (!ldp.webid) {
-    // FIXME: what is the rule that causes
-    // "Unexpected literal in error position of callback" in `npm run standard`?
-    // eslint-disable-next-line
-    return callback(true)
-  }
-
-  const root = ldp.resourceMapper.resolveFilePath(req.hostname)
-  const relativePath = '/' + _path.relative(root, file)
-  res.locals.path = relativePath
-  // FIXME: what is the rule that causes
-  // "Unexpected literal in error position of callback" in `npm run standard`?
-  // eslint-disable-next-line
-  allow('Read')(req, res, err => callback(!err))
-}
+/* eslint-disable no-mixed-operators, no-async-promise-executor */
+
+import { createRequire } from 'module'
+import fs from 'fs'
+import glob from 'glob'
+import _path from 'path'
+import $rdf from 'rdflib'
+import Negotiator from 'negotiator'
+import mime from 'mime-types'
+import debugModule from 'debug'
+import allow from './allow.mjs'
+
+import { translate } from '../utils.mjs'
+import HTTPError from '../http-error.mjs'
+
+import ldpModule from '../ldp.mjs'
+const require = createRequire(import.meta.url)
+const debug = debugModule('solid:get')
+const debugGlob = debugModule('solid:glob')
+const RDFs = ldpModule.mimeTypesAsArray()
+const isRdf = ldpModule.mimeTypeIsRdf
+
+const prepConfig = 'accept=("message/rfc822" "application/ld+json" "text/turtle")'
+
+export default async function handler (req, res, next) {
+  const ldp = req.app.locals.ldp
+  const prep = req.app.locals.prep
+  const includeBody = req.method === 'GET'
+  const negotiator = new Negotiator(req)
+  const baseUri = ldp.resourceMapper.resolveUrl(req.hostname, req.path)
+  const path = res.locals.path || req.path
+  const requestedType = negotiator.mediaType()
+  const possibleRDFType = negotiator.mediaType(RDFs)
+
+  // deprecated kept for compatibility
+  res.header('MS-Author-Via', 'SPARQL')
+
+  res.header('Accept-Patch', 'text/n3, application/sparql-update, application/sparql-update-single-match')
+  res.header('Accept-Post', '*/*')
+  if (!path.endsWith('/') && !glob.hasMagic(path)) res.header('Accept-Put', '*/*')
+
+  // Set live updates
+  if (ldp.live) {
+    res.header('Updates-Via', ldp.resourceMapper.resolveUrl(req.hostname).replace(/^http/, 'ws'))
+  }
+
+  debug(req.originalUrl + ' on ' + req.hostname)
+
+  const options = {
+    hostname: req.hostname,
+    path: path,
+    includeBody: includeBody,
+    possibleRDFType: possibleRDFType,
+    range: req.headers.range,
+    contentType: req.headers.accept
+  }
+
+  let ret
+  try {
+    ret = await ldp.get(options, req.accepts(['html', 'turtle', 'rdf+xml', 'n3', 'ld+json']) === 'html')
+  } catch (err) {
+    // set Accept-Put if container do not exist
+    if (err.status === 404 && path.endsWith('/')) res.header('Accept-Put', 'text/turtle')
+    // use globHandler if magic is detected
+    if (err.status === 404 && glob.hasMagic(path)) {
+      debug('forwarding to glob request')
+      return globHandler(req, res, next)
+    } else {
+      debug(req.method + ' -- Error: ' + err.status + ' ' + err.message)
+      return next(err)
+    }
+  }
+
+  let stream
+  let contentType
+  let container
+  let contentRange
+  let chunksize
+
+  if (ret) {
+    stream = ret.stream
+    contentType = ret.contentType
+    container = ret.container
+    contentRange = ret.contentRange
+    chunksize = ret.chunksize
+  }
+
+  // Till here it must exist
+  if (!includeBody) {
+    debug('HEAD only')
+    res.setHeader('Content-Type', ret.contentType)
+    return res.status(200).send('OK')
+  }
+
+  // Handle dataBrowser
+  if (requestedType && requestedType.includes('text/html')) {
+    const { path: filename } = await ldp.resourceMapper.mapUrlToFile({ url: options })
+    const mimeTypeByExt = mime.lookup(_path.basename(filename))
+    const isHtmlResource = mimeTypeByExt && mimeTypeByExt.includes('html')
+    const useDataBrowser = ldp.dataBrowserPath && (
+      container ||
+      [...RDFs, 'text/markdown'].includes(contentType) && !isHtmlResource && !ldp.suppressDataBrowser)
+
+    if (useDataBrowser) {
+      res.setHeader('Content-Type', 'text/html')
+
+      const defaultDataBrowser = require.resolve('mashlib/dist/databrowser.html')
+      const dataBrowserPath = ldp.dataBrowserPath === 'default' ? defaultDataBrowser : ldp.dataBrowserPath
+      debug('   sending data browser file: ' + dataBrowserPath)
+      res.sendFile(dataBrowserPath)
+      return
+    } else if (stream) { // EXIT text/html
+      res.setHeader('Content-Type', contentType)
+      return stream.pipe(res)
+    }
+  }
+
+  // If request accepts the content-type we found
+  if (stream && negotiator.mediaType([contentType])) {
+    let headers = {
+      'Content-Type': contentType
+    }
+
+    if (contentRange) {
+      headers = {
+        ...headers,
+        'Content-Range': contentRange,
+        'Accept-Ranges': 'bytes',
+        'Content-Length': chunksize
+      }
+      res.status(206)
+    }
+
+    if (prep && isRdf(contentType) && !res.sendEvents({
+      config: { prep: prepConfig },
+      body: stream,
+      isBodyStream: true,
+      headers
+    })) return
+
+    res.set(headers)
+    return stream.pipe(res)
+  }
+
+  // If it is not in our RDFs we can't even translate,
+  // Sorry, we can't help
+  if (!possibleRDFType || !RDFs.includes(contentType)) { // possibleRDFType defaults to text/turtle
+    return next(HTTPError(406, 'Cannot serve requested type: ' + contentType))
+  }
+  try {
+    // Translate from the contentType found to the possibleRDFType desired
+    const data = await translate(stream, baseUri, contentType, possibleRDFType)
+    debug(req.originalUrl + ' translating ' + contentType + ' -> ' + possibleRDFType)
+    const headers = {
+      'Content-Type': possibleRDFType
+    }
+    if (prep && isRdf(contentType) && !res.sendEvents({
+      config: { prep: prepConfig },
+      body: data,
+      headers
+    })) return
+    res.setHeader('Content-Type', possibleRDFType)
+    res.send(data)
+    return next()
+  } catch (err) {
+    debug('error translating: ' + req.originalUrl + ' ' + contentType + ' -> ' + possibleRDFType + ' -- ' + 406 + ' ' + err.message)
+    return next(HTTPError(500, 'Cannot serve requested type: ' + requestedType))
+  }
+}
+
+async function globHandler (req, res, next) {
+  const { ldp } = req.app.locals
+
+  // Ensure this is a glob for all files in a single folder
+  // https://github.com/solid/solid-spec/pull/148
+  const requestUrl = await ldp.resourceMapper.getRequestUrl(req)
+  if (!/^[^*]+\/\*$/.test(requestUrl)) {
+    return next(HTTPError(404, 'Unsupported glob pattern'))
+  }
+
+  // Extract the folder on the file system from the URL glob
+  const folderUrl = requestUrl.substr(0, requestUrl.length - 1)
+  const folderPath = (await ldp.resourceMapper.mapUrlToFile({ url: folderUrl, searchIndex: false })).path
+
+  const globOptions = {
+    noext: true,
+    nobrace: true,
+    nodir: true
+  }
+
+  glob(`${folderPath}*`, globOptions, async (err, matches) => {
+    if (err || matches.length === 0) {
+      debugGlob('No files matching the pattern')
+      return next(HTTPError(404, 'No files matching glob pattern'))
+    }
+
+    // Matches found
+    const globGraph = $rdf.graph()
+
+    debugGlob('found matches ' + matches)
+    await Promise.all(matches.map(match => new Promise(async (resolve, reject) => {
+      const urlData = await ldp.resourceMapper.mapFileToUrl({ path: match, hostname: req.hostname })
+      fs.readFile(match, { encoding: 'utf8' }, function (err, fileData) {
+        if (err) {
+          debugGlob('error ' + err)
+          return resolve()
+        }
+        // Files should be Turtle
+        if (urlData.contentType !== 'text/turtle') {
+          return resolve()
+        }
+        // The agent should have Read access to the file
+        hasReadPermissions(match, req, res, function (allowed) {
+          if (allowed) {
+            try {
+              $rdf.parse(fileData, globGraph, urlData.url, 'text/turtle')
+            } catch (parseErr) {
+              debugGlob(`error parsing ${match}: ${parseErr}`)
+            }
+          }
+          return resolve()
+        })
+      })
+    })))
+
+    const data = $rdf.serialize(undefined, globGraph, requestUrl, 'text/turtle')
+    // TODO this should be added as a middleware in the routes
+    res.setHeader('Content-Type', 'text/turtle')
+    debugGlob('returning turtle')
+
+    res.send(data)
+    next()
+  })
+}
+
+// TODO: get rid of this ugly hack that uses the Allow handler to check read permissions
+function hasReadPermissions (file, req, res, callback) {
+  const ldp = req.app.locals.ldp
+
+  if (!ldp.webid) {
+    // FIXME: what is the rule that causes
+    // "Unexpected literal in error position of callback" in `npm run standard`?
+    // eslint-disable-next-line
+    return callback(true)
+  }
+
+  const root = ldp.resourceMapper.resolveFilePath(req.hostname)
+  const relativePath = '/' + _path.relative(root, file)
+  res.locals.path = relativePath
+  // FIXME: what is the rule that causes
+  // "Unexpected literal in error position of callback" in `npm run standard`?
+  // eslint-disable-next-line
+  allow('Read')(req, res, err => callback(!err))
+}

package/lib/handlers/{index.js → index.mjs}

@@ -1,14 +1,13 @@
 /* eslint-disable node/no-deprecated-api */
 
-module.exports = handler
+import path from 'path'
+import debugModule from 'debug'
+import Negotiator from 'negotiator'
+import url from 'url'
+import URI from 'urijs'
+const debug = debugModule('solid:index')
 
-const path = require('path')
-const debug = require('debug')('solid:index')
-const Negotiator = require('negotiator')
-const url = require('url')
-const URI = require('urijs')
-
-async function handler (req, res, next) {
+export default async function handler (req, res, next) {
   const indexFile = 'index.html'
   const ldp = req.app.locals.ldp
   const negotiator = new Negotiator(req)

package/lib/handlers/{notify.js → notify.mjs}

@@ -1,10 +1,8 @@
-module.exports = handler
-
-const libPath = require('path/posix')
-
-const headerTemplate = require('express-prep/templates').header
-const solidRDFTemplate = require('../rdf-notification-template')
-const debug = require('../debug').prep
+import { posix as libPath } from 'path'
+import { header as headerTemplate } from 'express-prep/templates'
+import solidRDFTemplate from '../rdf-notification-template.mjs'
+import debug from '../debug.mjs'
+const debugPrep = debug.prep
 
 const ALLOWED_RDF_MIME_TYPES = [
   'application/ld+json',
@@ -53,7 +51,7 @@ function getDate (date) {
   return filterMillseconds(now.toISOString())
 }
 
-function handler (req, res, next) {
+export default function handler (req, res, next) {
   const { trigger, defaultNotification } = res.events.prep
 
   const { method, path } = req
@@ -96,7 +94,7 @@ function handler (req, res, next) {
         }
       })
     } catch (error) {
-      debug(`Failed to trigger notification on route ${fullUrl}`)
+      debugPrep(`Failed to trigger notification on route ${fullUrl}`)
       // No special handling is necessary since the resource mutation was
       // already successful. The purpose of this block is to prevent Express
       // from triggering error handling middleware when notifications fail.
@@ -136,7 +134,7 @@ function handler (req, res, next) {
         }
       })
     } catch (error) {
-      debug(`Failed to trigger notification on parent route ${parentUrl}`)
+      debugPrep(`Failed to trigger notification on parent route ${parentUrl}`)
       // No special handling is necessary since the resource mutation was
       // already successful. The purpose of this block is to prevent Express
       // from triggering error handling middleware when notifications fail.

package/lib/handlers/{options.js → options.mjs}

@@ -1,11 +1,9 @@
 /* eslint-disable node/no-deprecated-api */
 
-const addLink = require('../header').addLink
-const url = require('url')
+import { addLink } from '../header.mjs'
+import url from 'url'
 
-module.exports = handler
-
-function handler (req, res, next) {
+export default function handler (req, res, next) {
   linkServiceEndpoint(req, res)
   linkAuthProvider(req, res)
   linkAcceptEndpoint(res)