snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/server/lib/media/file-upload/ufs/Webdav/server.ts

@@ -0,0 +1,154 @@
+import stream from 'node:stream';
+
+import type { IUpload } from '@rocket.chat/core-typings';
+import { Random } from '@rocket.chat/random';
+import { check } from 'meteor/check';
+
+import { WebdavClientAdapter } from '../../../../../bridges/webdav/lib/webdavClientAdapter';
+import { UploadFS } from '../../../../../ufs';
+import type { StoreOptions } from '../../../../../ufs/ufs-store';
+import { SystemLogger } from '../../../../logger/system';
+
+type WebdavOptions = StoreOptions & {
+	connection: {
+		credentials: {
+			server: string;
+			username: string;
+			password: string;
+		};
+	};
+	uploadFolderPath: string;
+	getPath: (file: Omit<IUpload, '_updatedAt'>) => string;
+};
+
+class WebdavStore extends UploadFS.Store {
+	protected getPath: (file: Omit<IUpload, '_updatedAt'>) => string;
+
+	constructor(options: WebdavOptions) {
+		super(options);
+		const { server, username, password } = options.connection.credentials;
+		const client = new WebdavClientAdapter(server, { username, password });
+
+		options.getPath = function (file) {
+			if (options.uploadFolderPath[options.uploadFolderPath.length - 1] !== '/') {
+				options.uploadFolderPath += '/';
+			}
+			return options.uploadFolderPath + file._id;
+		};
+
+		client.stat(options.uploadFolderPath).catch((err) => {
+			if (err.message.toLowerCase() === 'not found') {
+				void client.createDirectory(options.uploadFolderPath);
+			} else if (err.message.toLowerCase() === 'unauthorized') {
+				console.warn('File upload is unauthorized to connect on Webdav, please verify your credentials');
+			}
+		});
+
+		/**
+		 * Returns the file path
+		 * @param file
+		 * @return {string}
+		 */
+		this.getPath = function (file) {
+			if (file.Webdav) {
+				return file.Webdav.path;
+			}
+
+			return file._id;
+		};
+
+		/**
+		 * Creates the file in the col lection
+		 * @param file
+		 * @param callback
+		 * @return {string}
+		 */
+		this.create = async function (file) {
+			check(file, Object);
+
+			if (file._id == null) {
+				file._id = Random.id();
+			}
+
+			file.Webdav = {
+				path: options.getPath(file as Omit<IUpload, '_updatedAt'>),
+			};
+
+			file.store = this.options.name;
+
+			return (await this.getCollection().insertOne(file)).insertedId;
+		};
+
+		/**
+		 * Removes the file
+		 * @param fileId
+		 * @param callback
+		 */
+		this.delete = async function (fileId) {
+			const file = await this.getCollection().findOne({ _id: fileId });
+			if (!file) {
+				throw new Error('File no found');
+			}
+
+			try {
+				return client.deleteFile(this.getPath(file));
+			} catch (err: any) {
+				SystemLogger.error({ err });
+			}
+		};
+
+		/**
+		 * Returns the file read stream
+		 * @param fileId
+		 * @param file
+		 * @param options
+		 * @return {*}
+		 */
+		this.getReadStream = async function (_fileId, file, options = {}) {
+			const range: {
+				start?: number;
+				end?: number;
+			} = {};
+
+			if (options.start != null) {
+				range.start = options.start;
+			}
+
+			if (options.end != null) {
+				range.end = options.end;
+			}
+			return client.createReadStream(this.getPath(file), options);
+		};
+
+		/**
+		 * Returns the file write stream
+		 * @param fileId
+		 * @param file
+		 * @return {*}
+		 */
+		this.getWriteStream = async function (_fileId, file) {
+			const writeStream = new stream.PassThrough();
+			const webdavStream = client.createWriteStream(this.getPath(file), file.size || 0);
+
+			// TODO remove timeout when UploadFS bug resolved
+			const newListenerCallback = (event: string, listener: () => any) => {
+				if (event === 'finish') {
+					process.nextTick(() => {
+						writeStream.removeListener(event, listener);
+						writeStream.removeListener('newListener', newListenerCallback);
+						writeStream.on(event, () => {
+							setTimeout(listener, 500);
+						});
+					});
+				}
+			};
+			writeStream.on('newListener', newListenerCallback);
+
+			writeStream.pipe(webdavStream);
+			return writeStream;
+		};
+	}
+}
+
+// Add store to UFS namespace
+UploadFS.store.Webdav = WebdavStore;