@azure/storage-file-datalake
Version:
Microsoft Azure Storage SDK for JavaScript - DataLake
344 lines • 12.1 kB
JavaScript
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import { ToBlobEndpointHostMappings, ToDfsEndpointHostMappings } from "./utils/constants.js";
import { base64encode } from "./utils/utils.common.js";
/**
* Get a blob endpoint URL from incoming blob or dfs endpoint URLs.
* Only handle known host name pair patterns, add more patterns into ToBlobEndpointHostMappings in constants.ts.
*
* Expected input and outputs:
* http://account.blob.core.windows.net - http://account.blob.core.windows.net
* http://account.dfs.core.windows.net - http://account.blob.core.windows.net
* http://127.0.0.1:10000 - http://127.0.0.1:10000
* http://account.blob.core.windows.net/abc - http://account.blob.core.windows.net/abc
* http://account.dfs.core.windows.net/abc - http://account.blob.core.windows.net/abc
* http://127.0.0.1:10000/abc - http://127.0.0.1:10000/abc
*
* @param url -
*/
export function toBlobEndpointUrl(url) {
return mapHostUrl(url, ToBlobEndpointHostMappings, "toBlobEndpointUrl");
}
/**
* Get a dfs endpoint URL from incoming blob or dfs endpoint URLs.
* Only handle known host name pair patterns, add more patterns into ToDfsEndpointHostMappings in constants.ts.
*
* Expected input and outputs:
* http://account.blob.core.windows.net - http://account.dfs.core.windows.net
* http://account.dfs.core.windows.net - http://account.dfs.core.windows.net
* http://127.0.0.1:10000 - http://127.0.0.1:10000
* http://account.blob.core.windows.net/abc - http://account.dfs.core.windows.net/abc
* http://account.dfs.core.windows.net/abc - http://account.dfs.core.windows.net/abc
* http://127.0.0.1:10000/abc - http://127.0.0.1:10000/abc
*
* @param url -
*/
export function toDfsEndpointUrl(url) {
return mapHostUrl(url, ToDfsEndpointHostMappings, "toDfsEndpointUrl");
}
function mapHostUrl(url, hostMappings, callerMethodName) {
let urlParsed;
try {
urlParsed = new URL(url);
}
catch (e) {
// invalid urls are returned unmodified
return url;
}
let host = urlParsed.hostname;
if (host === undefined) {
throw RangeError(`${callerMethodName}() parameter url ${url} doesn't include valid host.`);
}
for (const mapping of hostMappings) {
if (host.includes(mapping[0])) {
host = host.replace(mapping[0], mapping[1]);
break;
}
}
urlParsed.hostname = host;
const result = urlParsed.toString();
// don't add a trailing slash if one wasn't already present
if (!url.endsWith("/") && result.endsWith("/")) {
return result.slice(0, -1);
}
else {
return result;
}
}
function toFileSystemAsyncIterableIterator(iter) {
return {
async next() {
const rawResult = await iter.next();
if (rawResult.value) {
rawResult.value.fileSystemItems = rawResult.value.containerItems.map((val) => {
return {
...val,
versionId: val.version,
properties: {
...val.properties,
publicAccess: toPublicAccessType(val.properties.publicAccess),
},
};
});
}
return rawResult;
},
[Symbol.asyncIterator]() {
return this;
},
};
}
export function toFileSystemPagedAsyncIterableIterator(iter) {
return {
async next() {
const rawResult = await iter.next();
const result = rawResult;
if (!result.done && !rawResult.done) {
result.value.properties.publicAccess = toPublicAccessType(rawResult.value.properties.publicAccess);
result.value.versionId = rawResult.value.version;
}
return result;
},
[Symbol.asyncIterator]() {
return this;
},
byPage(settings = {}) {
return toFileSystemAsyncIterableIterator(iter.byPage(settings));
},
};
}
export function toContainerPublicAccessType(publicAccessType) {
if (!publicAccessType) {
return undefined;
}
switch (publicAccessType) {
case "filesystem":
return "container";
case "file":
return "blob";
default:
throw TypeError(`toContainerPublicAccessType() parameter ${publicAccessType} is not recognized.`);
}
}
export function toPublicAccessType(containerPublicAccessType) {
if (!containerPublicAccessType) {
return undefined;
}
switch (containerPublicAccessType) {
case "container":
return "filesystem";
case "blob":
return "file";
default:
throw TypeError(`toPublicAccessType() parameter ${containerPublicAccessType} is not recognized.`);
}
}
export function toProperties(metadata) {
if (metadata === undefined) {
return undefined;
}
const properties = [];
for (const key in metadata) {
if (Object.prototype.hasOwnProperty.call(metadata, key)) {
const value = metadata[key];
properties.push(`${key}=${base64encode(value)}`);
}
}
return properties.join(",");
}
export function toRolePermissions(permissionsString) {
const error = new RangeError(`toRolePermissions() Invalid role permissions string ${permissionsString}`);
if (permissionsString.length !== 3) {
throw error;
}
permissionsString = permissionsString.toLowerCase();
let read = false;
if (permissionsString[0] === "r") {
read = true;
}
else if (permissionsString[0] !== "-") {
throw error;
}
let write = false;
if (permissionsString[1] === "w") {
write = true;
}
else if (permissionsString[1] !== "-") {
throw error;
}
let execute = false;
if (permissionsString[2] === "x") {
execute = true;
}
else if (permissionsString[2] !== "-") {
throw error;
}
return { read, write, execute };
}
export function toPermissions(permissionsString) {
if (permissionsString === undefined || permissionsString === "" || permissionsString === null) {
return undefined;
}
if (permissionsString.length !== 9 && permissionsString.length !== 10) {
throw RangeError(`toPermissions() Invalid permissions string ${permissionsString}`);
}
let stickyBit = false;
if (permissionsString[8] === "t") {
stickyBit = true;
const firstPart = permissionsString.substr(0, 8);
const lastPart = permissionsString.substr(9);
permissionsString = firstPart + "x" + lastPart;
}
else if (permissionsString[8] === "T") {
stickyBit = true;
const firstPart = permissionsString.substr(0, 8);
const lastPart = permissionsString.substr(9);
permissionsString = firstPart + "-" + lastPart;
}
// Case insensitive
permissionsString = permissionsString.toLowerCase();
let extendedAcls = false;
if (permissionsString.length === 10) {
if (permissionsString[9] === "+") {
extendedAcls = true;
}
else {
throw RangeError(`toPermissions() Invalid extendedAcls bit ${permissionsString[9]} in permissions string ${permissionsString}`);
}
}
const owner = toRolePermissions(permissionsString.substr(0, 3));
const group = toRolePermissions(permissionsString.substr(3, 3));
const other = toRolePermissions(permissionsString.substr(6, 3));
return {
owner,
group,
other,
stickyBit,
extendedAcls,
};
}
export function toAccessControlItem(aclItemString) {
const error = new RangeError(`toAccessControlItem() Parameter access control item string ${aclItemString} is not valid.`);
if (aclItemString === "") {
throw error;
}
aclItemString = aclItemString.toLowerCase();
const parts = aclItemString.split(":");
if (parts.length < 3 || parts.length > 4) {
throw error;
}
let defaultScope = false;
let index = 0;
if (parts.length === 4) {
if (parts[index] !== "default") {
throw error;
}
defaultScope = true;
index++;
}
const accessControlType = parts[index++];
if (accessControlType !== "user" &&
accessControlType !== "group" &&
accessControlType !== "mask" &&
accessControlType !== "other") {
throw error;
}
const entityId = parts[index++];
const permissions = toRolePermissions(parts[index++]);
return {
defaultScope,
accessControlType,
entityId,
permissions,
};
}
export function toRemoveAccessControlItem(aclItemString) {
const error = new RangeError(`toAccessControlItem() Parameter access control item string "${aclItemString}" is not valid.`);
if (aclItemString === "") {
throw error;
}
aclItemString = aclItemString.toLowerCase();
const parts = aclItemString.split(":");
if (parts.length < 1 || parts.length > 3) {
throw error;
}
if (parts.length === 3) {
if (parts[0] !== "default") {
throw error;
}
}
let defaultScope = false;
let index = 0;
if (parts[index] === "default") {
defaultScope = true;
index++;
}
const accessControlType = parts[index++];
if (accessControlType !== "user" &&
accessControlType !== "group" &&
accessControlType !== "mask" &&
accessControlType !== "other") {
throw error;
}
const entityId = parts[index++];
return {
defaultScope,
accessControlType,
entityId,
};
}
export function toAcl(aclString) {
if (aclString === undefined || aclString === "" || aclString === null) {
return [];
}
const acls = [];
const aclParts = aclString.split(",");
for (const aclPart of aclParts) {
acls.push(toAccessControlItem(aclPart));
}
return acls;
}
export function toRemoveAcl(aclString) {
if (aclString === undefined || aclString === "" || aclString === null) {
return [];
}
const acls = [];
const aclParts = aclString.split(",");
for (const aclPart of aclParts) {
acls.push(toRemoveAccessControlItem(aclPart));
}
return acls;
}
export function toAccessControlItemString(item) {
const entityIdString = item.entityId !== undefined ? `:${item.entityId}` : "";
const permissionsString = item.permissions !== undefined ? `:${toRolePermissionsString(item.permissions)}` : "";
return `${item.defaultScope ? "default:" : ""}${item.accessControlType}${entityIdString}${permissionsString}`;
}
export function toAclString(acl) {
return acl.map(toAccessControlItemString).join(",");
}
export function toRolePermissionsString(p, stickyBit = false) {
return `${p.read ? "r" : "-"}${p.write ? "w" : "-"}${stickyBit ? (p.execute ? "t" : "T") : p.execute ? "x" : "-"}`;
}
export function toPermissionsString(permissions) {
return `${toRolePermissionsString(permissions.owner)}${toRolePermissionsString(permissions.group)}${toRolePermissionsString(permissions.other, permissions.stickyBit)}${permissions.extendedAcls ? "+" : ""}`;
}
export function toAccessControlChangeFailureArray(aclFailedEntries = []) {
return aclFailedEntries.map((aclFailedEntry) => {
return {
name: aclFailedEntry.name || "",
isDirectory: (aclFailedEntry.type || "").toLowerCase() === "directory",
message: aclFailedEntry.errorMessage || "",
};
});
}
export function toBlobCpkInfo(input) {
return input
? {
encryptionKey: input.encryptionKey,
encryptionKeySha256: input.encryptionKeySha256,
encryptionAlgorithm: "AES256",
}
: undefined;
}
//# sourceMappingURL=transforms.js.map