src/vs/base/node/unc.ts
102 LOC · 48 covered · 54 uncovered · 6 ranges · 1 concepts · 1 introducers · 1 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
unc.ts ×6
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
export function getUNCHostAllowlist(): string[] {
const allowlist = processUNCHostAllowlist();
if (allowlist) {
return Array.from(allowlist);
}
return [];
}
function processUNCHostAllowlist(): Set<string> | undefined {
// The property `process.uncHostAllowlist` is not available in official node.js
// releases, only in our own builds, so we have to probe for availability
return (process as unknown as { uncHostAllowlist?: Set<string> }).uncHostAllowlist;
}
export function addUNCHostToAllowlist(allowedHost: string | string[]): void {
if (process.platform !== 'win32') {
return;
}
const allowlist = processUNCHostAllowlist();
if (allowlist) {
if (typeof allowedHost === 'string') {
allowlist.add(allowedHost.toLowerCase()); // UNC hosts are case-insensitive
} else {
for (const host of toSafeStringArray(allowedHost)) {
addUNCHostToAllowlist(host);
}
}
}
}
function toSafeStringArray(arg0: unknown): string[] {
const allowedUNCHosts = new Set<string>();
if (Array.isArray(arg0)) {
for (const host of arg0) {
if (typeof host === 'string') {
allowedUNCHosts.add(host);
}
}
}
return Array.from(allowedUNCHosts);
}
export function getUNCHost(maybeUNCPath: string | undefined | null): string | undefined {
if (typeof maybeUNCPath !== 'string') {
return undefined; // require a valid string
}
const uncRoots = [
'\\\\.\\UNC\\', // DOS Device paths (https://learn.microsoft.com/en-us/dotnet/standard/io/file-path-formats)
'\\\\?\\UNC\\',
'\\\\' // standard UNC path
];
let host = undefined;
for (const uncRoot of uncRoots) {
const indexOfUNCRoot = maybeUNCPath.indexOf(uncRoot);
if (indexOfUNCRoot !== 0) {
continue; // not matching any of our expected UNC roots
}
const indexOfUNCPath = maybeUNCPath.indexOf('\\', uncRoot.length);
if (indexOfUNCPath === -1) {
continue; // no path component found
}
const hostCandidate = maybeUNCPath.substring(uncRoot.length, indexOfUNCPath);
if (hostCandidate) {
host = hostCandidate;
break;
}
}
return host;
}
export function disableUNCAccessRestrictions(): void {
if (process.platform !== 'win32') {
return;
}
(process as unknown as { restrictUNCAccess?: boolean }).restrictUNCAccess = false;
}
export function isUNCAccessRestrictionsDisabled(): boolean {
if (process.platform !== 'win32') {
return true;
}
return (process as unknown as { restrictUNCAccess?: boolean }).restrictUNCAccess === false;
}