ExtensionBasedMapper | Community Solid Server

Supports the behaviour described in https://www.w3.org/DesignIssues/HTTPFilenameMapping.html Determines content-type based on the file extension. In case an identifier does not end on an extension matching its content-type, the corresponding file will be appended with the correct extension, preceded by $.

Hierarchy

BaseFileIdentifierMapper
- ExtensionBasedMapper
  - SubdomainExtensionBasedMapper

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExtensionBasedMapper(base: string, rootFilepath: string, customTypes?: Record<string, string>): ExtensionBasedMapper

Overrides BaseFileIdentifierMapper.constructor
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:18
Parameters
- base: string
- rootFilepath: string
- Optional customTypes: Record<string, string>
Returns ExtensionBasedMapper

Properties

Protected Readonly baseRequestURI

baseRequestURI: string

Private Readonly customExtensions

customExtensions: Record<string, string>

Private Readonly customTypes

customTypes: Record<string, string>

Protected Readonly logger

logger: Logger = ...

Protected Readonly rootFilepath

rootFilepath: string

Methods

Protected getAbsolutePath

getAbsolutePath(path: string): string

Inherited from BaseFileIdentifierMapper.getAbsolutePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:172
Get the absolute file path based on the rootFilepath.

Parameters
- path: string
  
  The relative file path.
Returns string

Absolute path of the file.

Protected getContainerUrl

getContainerUrl(relative: string): Promise<string>

Inherited from BaseFileIdentifierMapper.getContainerUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:141
Maps the given container path to a URL and determines its content type.

Parameters
- relative: string
  
  The relative container path.
Returns Promise<string>

A ResourceLink with all the necessary metadata.

Protected getContentTypeFromPath

getContentTypeFromPath(filePath: string): Promise<string>

Overrides BaseFileIdentifierMapper.getContentTypeFromPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:81
Determines the content type from the relative path.

Parameters
- filePath: string
Returns Promise<string>

The content type of the document.

Protected getContentTypeFromUrl

getContentTypeFromUrl(identifier: ResourceIdentifier, contentType?: string): Promise<string>

Inherited from BaseFileIdentifierMapper.getContentTypeFromUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:100
Determines the content type from the document identifier.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<string>

The content type of the document.

Protected getDocumentUrl

getDocumentUrl(relative: string): Promise<string>

Overrides BaseFileIdentifierMapper.getDocumentUrl
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:77
Maps the given document path to a URL and determines its content type.

Parameters
- relative: string
Returns Promise<string>

A ResourceLink with all the necessary metadata.

Protected getRelativePath

getRelativePath(identifier: ResourceIdentifier): string

Inherited from BaseFileIdentifierMapper.getRelativePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:185
Strips the baseRequestURI from the identifier.

throws

NotFoundHttpError If the identifier does not match the baseRequestURI.

Parameters
- identifier: ResourceIdentifier
  
  Incoming identifier.
Returns string

A string representing the relative path.

Protected isMetadataPath

isMetadataPath(path: string): boolean

Inherited from BaseFileIdentifierMapper.isMetadataPath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:217
Checks if the given path is a metadata path.

Parameters
- path: string
Returns boolean

mapFilePathToUrl

mapFilePathToUrl(filePath: string, isContainer: boolean): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapFilePathToUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:111
Maps the given file path to a URL and determines its content type.

Parameters
- filePath: string
  
  The input file path.
- isContainer: boolean
  
  If the path corresponds to a file.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Protected mapUrlToContainerPath

mapUrlToContainerPath(identifier: ResourceIdentifier, filePath: string): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapUrlToContainerPath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:70
Maps the given container identifier to a file path, possibly making alterations to the direct translation.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- filePath: string
  
  The direct translation of the identifier onto the file path.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Protected mapUrlToDocumentPath

mapUrlToDocumentPath(identifier: ResourceIdentifier, filePath: string, contentType?: string): Promise<ResourceLink>

Overrides BaseFileIdentifierMapper.mapUrlToDocumentPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:40
Maps the given document identifier to a file path, possibly making alterations to the direct translation (for instance, based on its content type)). Determines the content type if none was provided.

Parameters
- identifier: ResourceIdentifier
- filePath: string
- Optional contentType: string
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

mapUrlToFilePath

mapUrlToFilePath(identifier: ResourceIdentifier, isMetadata: boolean, contentType?: string): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapUrlToFilePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:42
Maps the given resource identifier / URL to a file path. Determines the content type if none was provided. For containers the content-type input is ignored.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- isMetadata: boolean
  
  If we need the data or metadata file path.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Protected stripExtension

stripExtension(path: string): string

- Defined in src/storage/mapping/ExtensionBasedMapper.ts:92
Helper function that removes the internal extension, one starting with $., from the given path. Nothing happens if no such extension is present.

Parameters
- path: string
Returns string

Protected validateRelativePath

validateRelativePath(path: string, identifier: ResourceIdentifier): void

Inherited from BaseFileIdentifierMapper.validateRelativePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:202
Check if the given relative path is valid.

throws

BadRequestHttpError If the relative path is invalid.

Parameters
- path: string
  
  A relative path, as generated by getRelativePath.
- identifier: ResourceIdentifier
  
  A resource identifier.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

base: string

rootFilepath: string

Optional customTypes: Record<string, string>

Returns ExtensionBasedMapper

Properties

Protected Readonly baseRequestURI

Private Readonly customExtensions

Private Readonly customTypes

Protected Readonly logger

Protected Readonly rootFilepath

Methods

Protected getAbsolutePath

Parameters

path: string

Returns string

Protected getContainerUrl

Parameters

relative: string

Returns Promise<string>

Protected getContentTypeFromPath

Parameters

filePath: string

Returns Promise<string>

Protected getContentTypeFromUrl

Parameters

identifier: ResourceIdentifier

Optional contentType: string

Returns Promise<string>

Protected getDocumentUrl

Parameters

relative: string

Returns Promise<string>

Protected getRelativePath

Parameters

identifier: ResourceIdentifier

Returns string

Protected isMetadataPath

Parameters

path: string

Returns boolean

mapFilePathToUrl

Parameters

filePath: string

isContainer: boolean

Returns Promise<ResourceLink>

Protected mapUrlToContainerPath

Parameters

identifier: ResourceIdentifier

filePath: string

Returns Promise<ResourceLink>

Protected mapUrlToDocumentPath

Parameters

identifier: ResourceIdentifier

filePath: string

Optional contentType: string

Returns Promise<ResourceLink>

mapUrlToFilePath

Parameters

identifier: ResourceIdentifier

isMetadata: boolean

Optional contentType: string

Returns Promise<ResourceLink>

Protected stripExtension

Parameters

path: string

Returns string

Protected validateRelativePath

Parameters

path: string

identifier: ResourceIdentifier

Returns void