snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)

client/src/helpers/file-upload.js

@@ -0,0 +1,197 @@
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2026 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+/** @module helpers/file-upload */
+
+import {inject} from 'di';
+import Settings from 'models/settings';
+
+/**
+ * A file-upload helper.
+ */
+class FileUploadExport {
+
+    /**
+     * @private
+     * @type {Settings}
+     */
+    @inject(Settings)
+    config
+
+    /**
+     * @typedef {Object} module:helpers/file-upload~Options
+     *
+     * @property {function(number):void} [afterChunkUpload] After every chunk is uploaded.
+     * @property {function(module:model):void} [afterAttachmentSave] After an attachment is saved.
+     * @property {{isCanceled?: boolean}} [mediator] A mediator.
+     */
+
+    /**
+     * Upload.
+     *
+     * @param {File} file A file.
+     * @param {module:model} attachment An attachment model.
+     * @param {module:helpers/file-upload~Options} [options] Options.
+     * @returns {Promise}
+     */
+    upload(file, attachment, options) {
+        options = options || {};
+
+        options.afterChunkUpload = options.afterChunkUpload || (() => {});
+        options.afterAttachmentSave = options.afterAttachmentSave || (() => {});
+        options.mediator = options.mediator || {};
+
+        attachment.set('name', file.name);
+        attachment.set('type', file.type || 'text/plain');
+        attachment.set('size', file.size);
+
+        if (this._useChunks(file)) {
+            return this._uploadByChunks(file, attachment, options);
+        }
+
+        return new Promise((resolve, reject) => {
+            const fileReader = new FileReader();
+
+            fileReader.onload = (e) => {
+                attachment.set('file', e.target.result);
+
+                attachment.save({}, {timeout: 0})
+                    .then(() => resolve())
+                    .catch(() => reject());
+            };
+
+            fileReader.readAsDataURL(file);
+        });
+    }
+
+    /**
+     * @private
+     */
+    _uploadByChunks(file, attachment, options) {
+        return new Promise((resolve, reject) => {
+            attachment.set('isBeingUploaded', true);
+
+            attachment
+                .save()
+                .then(() => {
+                    options.afterAttachmentSave(attachment);
+
+                    return this._uploadChunks(
+                        file,
+                        attachment,
+                        resolve,
+                        reject,
+                        options
+                    );
+                })
+                .catch(() => reject());
+        });
+    }
+
+    /**
+     * @private
+     */
+    _uploadChunks(file, attachment, resolve, reject, options, start) {
+        start = start || 0;
+        let end = start + this._getChunkSize() + 1;
+
+        if (end > file.size) {
+            end = file.size;
+        }
+
+        if (options.mediator.isCanceled) {
+            reject();
+
+            return;
+        }
+
+        const blob = file.slice(start, end);
+
+        const fileReader = new FileReader();
+
+        fileReader.onloadend = (e) => {
+            if (e.target.readyState !== FileReader.DONE) {
+                return;
+            }
+
+            Espo.Ajax
+                .postRequest('Attachment/chunk/' + attachment.id, e.target.result, {
+                    headers: {
+                        'Content-Type': 'multipart/form-data',
+                    },
+                })
+                .then(() => {
+                    options.afterChunkUpload(end);
+
+                    if (end === file.size) {
+                        resolve();
+
+                        return;
+                    }
+
+                    this._uploadChunks(
+                        file,
+                        attachment,
+                        resolve,
+                        reject,
+                        options,
+                        end
+                    );
+                })
+                .catch(() => reject());
+        };
+
+        fileReader.readAsDataURL(blob);
+    }
+
+    /**
+     * @private
+     */
+    _useChunks(file) {
+        const chunkSize = this._getChunkSize();
+
+        if (!chunkSize) {
+            return false;
+        }
+
+        if (file.size > chunkSize) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @private
+     */
+    _getChunkSize() {
+        return (this.config.get('attachmentUploadChunkSize') || 0) * 1024 * 1024;
+    }
+}
+
+export default FileUploadExport;