-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
pageconfig.ts
336 lines (306 loc) · 9.62 KB
/
pageconfig.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { JSONExt } from '@lumino/coreutils';
import minimist from 'minimist';
import { URLExt } from './url';
/**
* Declare stubs for the node variables.
*/
declare let process: any;
declare let require: any;
/**
* The namespace for `PageConfig` functions.
*/
export namespace PageConfig {
/**
* Get global configuration data for the Jupyter application.
*
* @param name - The name of the configuration option.
*
* @returns The config value or an empty string if not found.
*
* #### Notes
* All values are treated as strings.
* For browser based applications, it is assumed that the page HTML
* includes a script tag with the id `jupyter-config-data` containing the
* configuration as valid JSON. In order to support the classic Notebook,
* we fall back on checking for `body` data of the given `name`.
*
* For node applications, it is assumed that the process was launched
* with a `--jupyter-config-data` option pointing to a JSON settings
* file.
*/
export function getOption(name: string): string {
if (configData) {
return configData[name] || getBodyData(name);
}
configData = Object.create(null);
let found = false;
// Use script tag if available.
if (typeof document !== 'undefined' && document) {
const el = document.getElementById('jupyter-config-data');
if (el) {
configData = JSON.parse(el.textContent || '') as {
[key: string]: string;
};
found = true;
}
}
// Otherwise use CLI if given.
if (!found && typeof process !== 'undefined' && process.argv) {
try {
const cli = minimist(process.argv.slice(2));
const path: any = require('path');
let fullPath = '';
if ('jupyter-config-data' in cli) {
fullPath = path.resolve(cli['jupyter-config-data']);
} else if ('JUPYTER_CONFIG_DATA' in process.env) {
fullPath = path.resolve(process.env['JUPYTER_CONFIG_DATA']);
}
if (fullPath) {
// Force Webpack to ignore this require.
// eslint-disable-next-line
configData = eval('require')(fullPath) as { [key: string]: string };
}
} catch (e) {
console.error(e);
}
}
if (!JSONExt.isObject(configData)) {
configData = Object.create(null);
} else {
for (const key in configData) {
// PageConfig expects strings
if (typeof configData[key] !== 'string') {
configData[key] = JSON.stringify(configData[key]);
}
}
}
return configData![name] || getBodyData(name);
}
/**
* Set global configuration data for the Jupyter application.
*
* @param name - The name of the configuration option.
* @param value - The value to set the option to.
*
* @returns The last config value or an empty string if it doesn't exist.
*/
export function setOption(name: string, value: string): string {
const last = getOption(name);
configData![name] = value;
return last;
}
/**
* Get the base url for a Jupyter application, or the base url of the page.
*/
export function getBaseUrl(): string {
return URLExt.normalize(getOption('baseUrl') || '/');
}
/**
* Get the tree url for a JupyterLab application.
*/
export function getTreeUrl(): string {
return URLExt.join(getBaseUrl(), getOption('treeUrl'));
}
/**
* Get the base url for sharing links (usually baseUrl)
*/
export function getShareUrl(): string {
return URLExt.normalize(getOption('shareUrl') || getBaseUrl());
}
/**
* Get the tree url for shareable links.
* Usually the same as treeUrl,
* but overrideable e.g. when sharing with JupyterHub.
*/
export function getTreeShareUrl(): string {
return URLExt.normalize(URLExt.join(getShareUrl(), getOption('treeUrl')));
}
/**
* Create a new URL given an optional mode and tree path.
*
* This is used to create URLS when the mode or tree path change as the user
* changes mode or the current document in the main area. If fields in
* options are omitted, the value in PageConfig will be used.
*
* @param options - IGetUrlOptions for the new path.
*/
export function getUrl(options: IGetUrlOptions): string {
let path = options.toShare ? getShareUrl() : getBaseUrl();
const mode = options.mode ?? getOption('mode');
const workspace = options.workspace ?? getOption('workspace');
const labOrDoc = mode === 'single-document' ? 'doc' : 'lab';
path = URLExt.join(path, labOrDoc);
if (workspace !== defaultWorkspace) {
path = URLExt.join(
path,
'workspaces',
encodeURIComponent(getOption('workspace') ?? defaultWorkspace)
);
}
const treePath = options.treePath ?? getOption('treePath');
if (treePath) {
path = URLExt.join(path, 'tree', URLExt.encodeParts(treePath));
}
return path;
}
export const defaultWorkspace: string = 'default';
/**
* Options for getUrl
*/
export interface IGetUrlOptions {
/**
* The optional mode as a string 'single-document' or 'multiple-document'. If
* the mode argument is missing, it will be provided from the PageConfig.
*/
mode?: string;
/**
* The optional workspace as a string. If this argument is missing, the value will
* be pulled from PageConfig. To use the default workspace (no /workspaces/<name>
* URL segment will be included) pass the string PageConfig.defaultWorkspace.
*/
workspace?: string;
/**
* Whether the url is meant to be shared or not; default false.
*/
toShare?: boolean;
/**
* The optional tree path as as string. If treePath is not provided it will be
* provided from the PageConfig. If an empty string, the resulting path will not
* contain a tree portion.
*/
treePath?: string;
}
/**
* Get the base websocket url for a Jupyter application, or an empty string.
*/
export function getWsUrl(baseUrl?: string): string {
let wsUrl = getOption('wsUrl');
if (!wsUrl) {
baseUrl = baseUrl ? URLExt.normalize(baseUrl) : getBaseUrl();
if (baseUrl.indexOf('http') !== 0) {
return '';
}
wsUrl = 'ws' + baseUrl.slice(4);
}
return URLExt.normalize(wsUrl);
}
/**
* Returns the URL converting this notebook to a certain
* format with nbconvert.
*/
export function getNBConvertURL({
path,
format,
download
}: {
path: string;
format: string;
download: boolean;
}): string {
const notebookPath = URLExt.encodeParts(path);
const url = URLExt.join(getBaseUrl(), 'nbconvert', format, notebookPath);
if (download) {
return url + '?download=true';
}
return url;
}
/**
* Get the authorization token for a Jupyter application.
*/
export function getToken(): string {
return getOption('token') || getBodyData('jupyterApiToken');
}
/**
* Get the Notebook version info [major, minor, patch].
*/
export function getNotebookVersion(): [number, number, number] {
const notebookVersion = getOption('notebookVersion');
if (notebookVersion === '') {
return [0, 0, 0];
}
return JSON.parse(notebookVersion);
}
/**
* Private page config data for the Jupyter application.
*/
let configData: { [key: string]: string } | null = null;
/**
* Get a url-encoded item from `body.data` and decode it
* We should never have any encoded URLs anywhere else in code
* until we are building an actual request.
*/
function getBodyData(key: string): string {
if (typeof document === 'undefined' || !document.body) {
return '';
}
const val = document.body.dataset[key];
if (typeof val === 'undefined') {
return '';
}
return decodeURIComponent(val);
}
/**
* The namespace for page config `Extension` functions.
*/
export namespace Extension {
/**
* Populate an array from page config.
*
* @param key - The page config key (e.g., `deferredExtensions`).
*
* #### Notes
* This is intended for `deferredExtensions` and `disabledExtensions`.
*/
function populate(key: string): string[] {
try {
const raw = getOption(key);
if (raw) {
return JSON.parse(raw);
}
} catch (error) {
console.warn(`Unable to parse ${key}.`, error);
}
return [];
}
/**
* The collection of deferred extensions in page config.
*/
export const deferred = populate('deferredExtensions');
/**
* The collection of disabled extensions in page config.
*/
export const disabled = populate('disabledExtensions');
/**
* Returns whether a plugin is deferred.
*
* @param id - The plugin ID.
*/
export function isDeferred(id: string): boolean {
// Check for either a full plugin id match or an extension
// name match.
const separatorIndex = id.indexOf(':');
let extName = '';
if (separatorIndex !== -1) {
extName = id.slice(0, separatorIndex);
}
return deferred.some(val => val === id || (extName && val === extName));
}
/**
* Returns whether a plugin is disabled.
*
* @param id - The plugin ID.
*/
export function isDisabled(id: string): boolean {
// Check for either a full plugin id match or an extension
// name match.
const separatorIndex = id.indexOf(':');
let extName = '';
if (separatorIndex !== -1) {
extName = id.slice(0, separatorIndex);
}
return disabled.some(val => val === id || (extName && val === extName));
}
}
}