-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Dominik Schmidt <[email protected]>
- Loading branch information
Showing
19 changed files
with
681 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
182 changes: 182 additions & 0 deletions
182
packages/@uppy/companion/src/server/provider/webdav/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
|
|
||
| const Provider = require('../Provider') | ||
| const { getProtectedHttpAgent, validateURL } = require('../../helpers/request') | ||
| const { ProviderApiError, ProviderAuthError } = require('../error') | ||
| const { ProviderUserError } = require('../error') | ||
| const logger = require('../../logger') | ||
|
|
||
| const defaultDirectory = '/' | ||
|
|
||
| /** | ||
| * Adapter for WebDAV servers that support simple auth (non-OAuth). | ||
| */ | ||
| class WebdavProvider extends Provider { | ||
| static get hasSimpleAuth () { | ||
| return true | ||
| } | ||
|
|
||
| // eslint-disable-next-line class-methods-use-this | ||
| isAuthenticated ({ providerUserSession }) { | ||
| return providerUserSession.webdavUrl != null | ||
| } | ||
|
|
||
| async getClient ({ providerUserSession }) { | ||
| const webdavUrl = providerUserSession?.webdavUrl | ||
| const { allowLocalUrls } = this | ||
| if (!validateURL(webdavUrl, allowLocalUrls)) { | ||
| throw new Error('invalid public link url') | ||
| } | ||
|
|
||
| // dynamic import because Companion currently uses CommonJS and webdav is shipped as ESM | ||
| // todo implement as regular require as soon as Node 20.17 or 22 is required | ||
| // or as regular import when Companion is ported to ESM | ||
| const { AuthType } = await import('webdav') // eslint-disable-line import/no-unresolved | ||
|
|
||
| // Is this an ownCloud or Nextcloud public link URL? e.g. https://example.com/s/kFy9Lek5sm928xP | ||
| // they have specific urls that we can identify | ||
| // todo not sure if this is the right way to support nextcloud and other webdavs | ||
| if (/\/s\/([^/]+)/.test(webdavUrl)) { | ||
| const [baseURL, publicLinkToken] = webdavUrl.split('/s/') | ||
|
|
||
| return this.getClientHelper({ | ||
| url: `${baseURL.replace('/index.php', '')}/public.php/webdav/`, | ||
| authType: AuthType.Password, | ||
| username: publicLinkToken, | ||
| password: 'null', | ||
| }) | ||
| } | ||
|
|
||
| // normal public WebDAV urls | ||
| return this.getClientHelper({ | ||
| url: webdavUrl, | ||
| authType: AuthType.None, | ||
| }) | ||
| } | ||
|
|
||
| async logout () { // eslint-disable-line class-methods-use-this | ||
| return { revoked: true } | ||
| } | ||
|
|
||
| async simpleAuth ({ requestBody }) { | ||
| try { | ||
| const providerUserSession = { webdavUrl: requestBody.form.webdavUrl } | ||
|
|
||
| const client = await this.getClient({ providerUserSession }) | ||
| // call the list operation as a way to validate the url | ||
| await client.getDirectoryContents(defaultDirectory) | ||
|
|
||
| return providerUserSession | ||
| } catch (err) { | ||
| logger.error(err, 'provider.webdav.error') | ||
| if (['ECONNREFUSED', 'ENOTFOUND'].includes(err.code)) { | ||
| throw new ProviderUserError({ message: 'Cannot connect to server' }) | ||
| } | ||
| // todo report back to the user what actually went wrong | ||
| throw err | ||
| } | ||
| } | ||
|
|
||
| async getClientHelper ({ url, ...options }) { | ||
| const { allowLocalUrls } = this | ||
| if (!validateURL(url, allowLocalUrls)) { | ||
| throw new Error('invalid webdav url') | ||
| } | ||
| const { protocol } = new URL(url) | ||
| const HttpAgentClass = getProtectedHttpAgent({ protocol, allowLocalIPs: !allowLocalUrls }) | ||
|
|
||
| // dynamic import because Companion currently uses CommonJS and webdav is shipped as ESM | ||
| // todo implement as regular require as soon as Node 20.17 or 22 is required | ||
| // or as regular import when Companion is ported to ESM | ||
| const { createClient } = await import('webdav') | ||
| return createClient(url, { | ||
| ...options, | ||
| [`${protocol}Agent`] : new HttpAgentClass(), | ||
| }) | ||
| } | ||
|
|
||
| async list ({ directory, providerUserSession }) { | ||
| return this.withErrorHandling('provider.webdav.list.error', async () => { | ||
| // @ts-ignore | ||
| if (!this.isAuthenticated({ providerUserSession })) { | ||
| throw new ProviderAuthError() | ||
| } | ||
|
|
||
| const data = { items: [] } | ||
| const client = await this.getClient({ providerUserSession }) | ||
|
|
||
| /** @type {any} */ | ||
| const dir = await client.getDirectoryContents(directory || '/') | ||
|
|
||
| dir.forEach(item => { | ||
| const isFolder = item.type === 'directory' | ||
| const requestPath = encodeURIComponent(`${directory || ''}/${item.basename}`) | ||
|
|
||
| let modifiedDate | ||
| try { | ||
| modifiedDate = new Date(item.lastmod).toISOString() | ||
| } catch (e) { | ||
| // ignore invalid date from server | ||
| } | ||
|
|
||
| data.items.push({ | ||
| isFolder, | ||
| id: requestPath, | ||
| name: item.basename, | ||
| modifiedDate, | ||
| requestPath, | ||
| ...(!isFolder && { | ||
| mimeType: item.mime, | ||
| size: item.size, | ||
| thumbnail: null, | ||
|
|
||
| }), | ||
| }) | ||
| }) | ||
|
|
||
| return data | ||
| }) | ||
| } | ||
|
|
||
| async download ({ id, providerUserSession }) { | ||
| return this.withErrorHandling('provider.webdav.download.error', async () => { | ||
| const client = await this.getClient({ providerUserSession }) | ||
| const stream = client.createReadStream(`/${id}`) | ||
| return { stream } | ||
| }) | ||
| } | ||
|
|
||
| // eslint-disable-next-line | ||
| async thumbnail ({ id, providerUserSession }) { | ||
| // not implementing this because a public thumbnail from webdav will be used instead | ||
| logger.error('call to thumbnail is not implemented', 'provider.webdav.thumbnail.error') | ||
| throw new Error('call to thumbnail is not implemented') | ||
| } | ||
|
|
||
| // eslint-disable-next-line | ||
| async size ({ id, token, providerUserSession }) { | ||
| return this.withErrorHandling('provider.webdav.size.error', async () => { | ||
| const client = await this.getClient({ providerUserSession }) | ||
|
|
||
| /** @type {any} */ | ||
| const stat = await client.stat(id) | ||
| return stat.size | ||
| }) | ||
| } | ||
|
|
||
| // eslint-disable-next-line class-methods-use-this | ||
| async withErrorHandling (tag, fn) { | ||
| try { | ||
| return await fn() | ||
| } catch (err) { | ||
| let err2 = err | ||
| if (err.status === 401) err2 = new ProviderAuthError() | ||
| if (err.response) { | ||
| err2 = new ProviderApiError('WebDAV API error', err.status) // todo improve (read err?.response?.body readable stream and parse response) | ||
| } | ||
| logger.error(err2, tag) | ||
| throw err2 | ||
| } | ||
| } | ||
| } | ||
|
|
||
| module.exports = WebdavProvider |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "name": "@uppy/webdav", | ||
| "description": "Import files from WebDAV into Uppy.", | ||
| "version": "0.1.0", | ||
| "license": "MIT", | ||
| "main": "lib/index.js", | ||
| "types": "types/index.d.ts", | ||
| "type": "module", | ||
| "keywords": [ | ||
| "file uploader", | ||
| "uppy", | ||
| "uppy-plugin", | ||
| "webdav", | ||
| "provider", | ||
| "photos", | ||
| "videos" | ||
| ], | ||
| "homepage": "https://uppy.io", | ||
| "bugs": { | ||
| "url": "https://github.com/transloadit/uppy/issues" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/transloadit/uppy.git" | ||
| }, | ||
| "dependencies": { | ||
| "@uppy/companion-client": "workspace:^", | ||
| "@uppy/provider-views": "workspace:^", | ||
| "@uppy/utils": "workspace:^", | ||
| "preact": "^10.5.13" | ||
| }, | ||
| "peerDependencies": { | ||
| "@uppy/core": "workspace:^" | ||
| } | ||
| } |
Oops, something went wrong.