devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
305 lines (303 loc) • 11.7 kB
JavaScript
/**
* DevExtreme (cjs/file_management/remote_provider.js)
* Version: 24.2.6
* Build date: Mon Mar 17 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
"use strict";
exports.default = void 0;
var _renderer = _interopRequireDefault(require("../core/renderer"));
var _ajax = _interopRequireDefault(require("../core/utils/ajax"));
var _common = require("../core/utils/common");
var _common2 = require("../common");
var _window = require("../core/utils/window");
var _iterator = require("../core/utils/iterator");
var _deferred = require("../core/utils/deferred");
var _events_engine = _interopRequireDefault(require("../common/core/events/core/events_engine"));
var _provider_base = _interopRequireDefault(require("./provider_base"));
var _data = require("../core/utils/data");
var _type = require("../core/utils/type");
function _interopRequireDefault(e) {
return e && e.__esModule ? e : {
default: e
}
}
const window = (0, _window.getWindow)();
const FILE_CHUNK_BLOB_NAME = "chunk";
const FILE_SYSTEM_COMMNAD = {
GET_DIR_CONTENTS: "GetDirContents",
CREATE_DIR: "CreateDir",
RENAME: "Rename",
MOVE: "Move",
COPY: "Copy",
REMOVE: "Remove",
UPLOAD_CHUNK: "UploadChunk",
ABORT_UPLOAD: "AbortUpload",
DOWLOAD: "Download"
};
const REQUEST_METHOD = {
GET: "GET",
POST: "POST"
};
class RemoteFileSystemProvider extends _provider_base.default {
constructor(options) {
options = (0, _common.ensureDefined)(options, {});
super(options);
this._endpointUrl = options.endpointUrl;
this._beforeAjaxSend = options.beforeAjaxSend;
this._beforeSubmit = options.beforeSubmit;
this._requestHeaders = options.requestHeaders;
this._hasSubDirsGetter = (0, _data.compileGetter)(options.hasSubDirectoriesExpr || "hasSubDirectories")
}
getItems(parentDir) {
const pathInfo = parentDir.getFullPathInfo();
return this._executeRequest(FILE_SYSTEM_COMMNAD.GET_DIR_CONTENTS, {
pathInfo: pathInfo
}).then((result => this._convertDataObjectsToFileItems(result.result, pathInfo)))
}
renameItem(item, name) {
return this._executeRequest(FILE_SYSTEM_COMMNAD.RENAME, {
pathInfo: item.getFullPathInfo(),
isDirectory: item.isDirectory,
name: name
})
}
createDirectory(parentDir, name) {
return this._executeRequest(FILE_SYSTEM_COMMNAD.CREATE_DIR, {
pathInfo: parentDir.getFullPathInfo(),
name: name
})
}
deleteItems(items) {
return items.map((item => this._executeRequest(FILE_SYSTEM_COMMNAD.REMOVE, {
pathInfo: item.getFullPathInfo(),
isDirectory: item.isDirectory
})))
}
moveItems(items, destinationDirectory) {
return items.map((item => this._executeRequest(FILE_SYSTEM_COMMNAD.MOVE, {
sourcePathInfo: item.getFullPathInfo(),
sourceIsDirectory: item.isDirectory,
destinationPathInfo: destinationDirectory.getFullPathInfo()
})))
}
copyItems(items, destinationFolder) {
return items.map((item => this._executeRequest(FILE_SYSTEM_COMMNAD.COPY, {
sourcePathInfo: item.getFullPathInfo(),
sourceIsDirectory: item.isDirectory,
destinationPathInfo: destinationFolder.getFullPathInfo()
})))
}
uploadFileChunk(fileData, chunksInfo, destinationDirectory) {
if (0 === chunksInfo.chunkIndex) {
chunksInfo.customData.uploadId = new _common2.Guid
}
const args = {
destinationPathInfo: destinationDirectory.getFullPathInfo(),
chunkMetadata: JSON.stringify({
UploadId: chunksInfo.customData.uploadId,
FileName: fileData.name,
Index: chunksInfo.chunkIndex,
TotalCount: chunksInfo.chunkCount,
FileSize: fileData.size
})
};
const ajaxSettings = {
url: this._endpointUrl,
headers: this._requestHeaders || {},
method: REQUEST_METHOD.POST,
dataType: "json",
data: {
[FILE_CHUNK_BLOB_NAME]: chunksInfo.chunkBlob,
arguments: JSON.stringify(args),
command: FILE_SYSTEM_COMMNAD.UPLOAD_CHUNK
},
upload: {
onprogress: _common.noop,
onloadstart: _common.noop,
onabort: _common.noop
},
xhrFields: {},
cache: false
};
const deferred = new _deferred.Deferred;
this._beforeSendInternal(ajaxSettings);
_ajax.default.sendRequest(ajaxSettings).done((result => {
!result.success && deferred.reject(result) || deferred.resolve()
})).fail(deferred.reject);
return deferred.promise()
}
abortFileUpload(fileData, chunksInfo, destinationDirectory) {
return this._executeRequest(FILE_SYSTEM_COMMNAD.ABORT_UPLOAD, {
uploadId: chunksInfo.customData.uploadId
})
}
downloadItems(items) {
const args = this._getDownloadArgs(items);
const $form = (0, _renderer.default)("<form>").css({
display: "none"
}).attr({
method: REQUEST_METHOD.POST,
action: args.url
});
const formDataEntries = {
command: args.command,
arguments: args.arguments
};
this._beforeSubmitInternal(formDataEntries);
this._appendFormDataInputsToForm(formDataEntries, $form);
$form.appendTo("body");
_events_engine.default.trigger($form, "submit");
setTimeout((() => $form.remove()))
}
getItemsContent(items) {
const args = this._getDownloadArgs(items);
const ajaxSettings = {
url: args.url,
headers: this._requestHeaders || {},
method: REQUEST_METHOD.POST,
responseType: "arraybuffer",
data: {
command: args.command,
arguments: args.arguments
},
upload: {
onprogress: _common.noop,
onloadstart: _common.noop,
onabort: _common.noop
},
xhrFields: {},
cache: false
};
this._beforeSendInternal(ajaxSettings);
return _ajax.default.sendRequest(ajaxSettings)
}
_getDownloadArgs(items) {
const pathInfoList = items.map((item => item.getFullPathInfo()));
const args = {
pathInfoList: pathInfoList
};
const argsStr = JSON.stringify(args);
return {
url: this._endpointUrl,
arguments: argsStr,
command: FILE_SYSTEM_COMMNAD.DOWLOAD
}
}
_getItemsIds(items) {
return items.map((it => it.relativeName))
}
_executeRequest(command, args) {
const method = command === FILE_SYSTEM_COMMNAD.GET_DIR_CONTENTS ? REQUEST_METHOD.GET : REQUEST_METHOD.POST;
const deferred = new _deferred.Deferred;
const ajaxSettings = {
url: this._getEndpointUrl(command, args),
headers: this._requestHeaders || {},
method: method,
dataType: "json",
data: {},
xhrFields: {},
cache: false
};
this._beforeSendInternal(ajaxSettings);
_ajax.default.sendRequest(ajaxSettings).then((result => {
!result.success && deferred.reject(result) || deferred.resolve(result)
}), (e => deferred.reject(e)));
return deferred.promise()
}
_beforeSubmitInternal(formDataEntries) {
if ((0, _type.isFunction)(this._beforeSubmit)) {
this._beforeSubmit({
formData: formDataEntries
})
}
}
_beforeSendInternal(ajaxSettings) {
if ((0, _type.isFunction)(this._beforeAjaxSend)) {
const ajaxArguments = {
headers: ajaxSettings.headers,
formData: ajaxSettings.data,
xhrFields: ajaxSettings.xhrFields
};
this._beforeAjaxSend(ajaxArguments);
ajaxSettings.headers = ajaxArguments.headers;
ajaxSettings.data = ajaxArguments.formData;
ajaxSettings.xhrFields = ajaxArguments.xhrFields
}
if ((0, _type.isEmptyObject)(ajaxSettings.data)) {
delete ajaxSettings.data
} else if (ajaxSettings.responseType || ajaxSettings.upload) {
ajaxSettings.data = this._createFormData(ajaxSettings.data)
}
}
_createFormData(formDataEntries) {
const formData = new window.FormData;
for (const entryName in formDataEntries) {
if (Object.prototype.hasOwnProperty.call(formDataEntries, entryName) && (0, _type.isDefined)(formDataEntries[entryName])) {
formData.append(entryName, formDataEntries[entryName])
}
}
return formData
}
_appendFormDataInputsToForm(formDataEntries, formElement) {
for (const entryName in formDataEntries) {
if (Object.prototype.hasOwnProperty.call(formDataEntries, entryName) && (0, _type.isDefined)(formDataEntries[entryName])) {
(0, _renderer.default)("<input>").attr({
type: "hidden",
name: entryName,
value: formDataEntries[entryName]
}).appendTo(formElement)
}
}
}
_getEndpointUrl(command, args) {
const queryString = this._getQueryString({
command: command,
arguments: JSON.stringify(args)
});
const separator = this._endpointUrl && this._endpointUrl.indexOf("?") > 0 ? "&" : "?";
return this._endpointUrl + separator + queryString
}
_getQueryString(params) {
const pairs = [];
const keys = Object.keys(params);
for (let i = 0; i < keys.length; i++) {
const key = keys[i];
let value = params[key];
if (void 0 === value) {
continue
}
if (null === value) {
value = ""
}
if (Array.isArray(value)) {
this._processQueryStringArrayParam(key, value, pairs)
} else {
const pair = this._getQueryStringPair(key, value);
pairs.push(pair)
}
}
return pairs.join("&")
}
_processQueryStringArrayParam(key, array, pairs) {
(0, _iterator.each)(array, ((_, item) => {
const pair = this._getQueryStringPair(key, item);
pairs.push(pair)
}))
}
_getQueryStringPair(key, value) {
return encodeURIComponent(key) + "=" + encodeURIComponent(value)
}
_hasSubDirs(dataObj) {
const hasSubDirs = this._hasSubDirsGetter(dataObj);
return "boolean" === typeof hasSubDirs ? hasSubDirs : true
}
_getKeyExpr(options) {
return options.keyExpr || "key"
}
}
var _default = exports.default = RemoteFileSystemProvider;
module.exports = exports.default;
module.exports.default = exports.default;