Skip to content

Perform path sanitizing based on theme-settings.json config #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Perform path sanitizing based on theme-settings.json config #958

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions src/utils/data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
} from 'docc-render/utils/url-helper';
import emitWarningForSchemaVersionMismatch from 'docc-render/utils/schema-version-check';
import RedirectError from 'docc-render/errors/RedirectError';
import { fetchThemeSettings } from 'docc-render/utils/theme-settings';
import FetchError from 'docc-render/errors/FetchError';

export async function fetchData(path, params = {}, options = {}) {
Expand Down Expand Up @@ -55,8 +56,26 @@ export async function fetchData(path, params = {}, options = {}) {
return json;
}

function createDataPath(path) {
const dataPath = path.replace(/\/$/, '');
// Cache the value of the usePortablePaths setting, so we don't have to fetch it on every request.
let _cachedUsePortablePaths = null;

async function getUsePortablePaths() {
if (_cachedUsePortablePaths !== null) {
return _cachedUsePortablePaths;
}

const themeSettings = await fetchThemeSettings();
_cachedUsePortablePaths = themeSettings.portablePaths;
return _cachedUsePortablePaths;
}

async function createDataPath(path) {
const portablePaths = await getUsePortablePaths();
let dataPath = path.replace(/\/$/, '');
if (portablePaths === true) {
// Replace characters that are not allowed in file names with underscores
dataPath = dataPath.replace(/[<>:"\/\\|*]/, '_');
}
return `${normalizePath(['/data', dataPath])}.json`;
}

Expand All @@ -74,7 +93,7 @@ function transformDataPathToRoutePath(dataURL) {
}

export async function fetchDataForRouteEnter(to, from, next) {
const path = createDataPath(to.path);
const path = await createDataPath(to.path);

let data;
try {
Expand Down Expand Up @@ -113,7 +132,7 @@ export function shouldFetchDataForRouteUpdate(to, from) {
}

export async function fetchAPIChangesForRoute(route, changes) {
const path = createDataPath(`/diffs${route.path}`);
const path = await createDataPath(`/diffs${route.path}`);

let data;
try {
Expand All @@ -129,7 +148,7 @@ export async function fetchAPIChangesForRoute(route, changes) {
}

export async function fetchDataForPreview(path, options = {}) {
const dataPath = createDataPath(path);
const dataPath = await createDataPath(path);
return fetchData(dataPath, {}, options);
}

Expand Down