forked from jupyterlab/jupyterlab
/
dialogs.ts
173 lines (154 loc) · 4.44 KB
/
dialogs.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
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { Dialog, showDialog, showErrorMessage } from '@jupyterlab/apputils';
import { PathExt } from '@jupyterlab/coreutils';
import { Contents } from '@jupyterlab/services';
import { JSONObject } from '@phosphor/coreutils';
import { Widget } from '@phosphor/widgets';
import { IDocumentManager } from './';
/**
* The class name added to file dialogs.
*/
const FILE_DIALOG_CLASS = 'jp-FileDialog';
/**
* The class name added for the new name label in the rename dialog
*/
const RENAME_NEWNAME_TITLE_CLASS = 'jp-new-name-title';
/**
* A stripped-down interface for a file container.
*/
export interface IFileContainer extends JSONObject {
/**
* The list of item names in the current working directory.
*/
items: string[];
/**
* The current working directory of the file container.
*/
path: string;
}
/**
* Rename a file with a dialog.
*/
export function renameDialog(
manager: IDocumentManager,
oldPath: string
): Promise<Contents.IModel | null> {
return showDialog({
title: 'Rename File',
body: new RenameHandler(oldPath),
focusNodeSelector: 'input',
buttons: [Dialog.cancelButton(), Dialog.okButton({ label: 'Rename' })]
}).then(result => {
if (!result.value) {
return;
}
if (!isValidFileName(result.value)) {
void showErrorMessage(
'Rename Error',
Error(
`"${result.value}" is not a valid name for a file. ` +
`Names must have nonzero length, ` +
`and cannot include "/", "\\", or ":"`
)
);
return null;
}
let basePath = PathExt.dirname(oldPath);
let newPath = PathExt.join(basePath, result.value);
return renameFile(manager, oldPath, newPath);
});
}
/**
* Rename a file, asking for confirmation if it is overwriting another.
*/
export function renameFile(
manager: IDocumentManager,
oldPath: string,
newPath: string
): Promise<Contents.IModel | null> {
return manager.rename(oldPath, newPath).catch(error => {
if (error.message.indexOf('409') === -1) {
throw error;
}
return shouldOverwrite(newPath).then(value => {
if (value) {
return manager.overwrite(oldPath, newPath);
}
return Promise.reject('File not renamed');
});
});
}
/**
* Ask the user whether to overwrite a file.
*/
export function shouldOverwrite(path: string): Promise<boolean> {
let options = {
title: 'Overwrite file?',
body: `"${path}" already exists, overwrite?`,
buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'Overwrite' })]
};
return showDialog(options).then(result => {
return Promise.resolve(result.button.accept);
});
}
/**
* Test whether a name is a valid file name
*
* Disallows "/", "\", and ":" in file names, as well as names with zero length.
*/
export function isValidFileName(name: string): boolean {
const validNameExp = /[\/\\:]/;
return name.length > 0 && !validNameExp.test(name);
}
/**
* A widget used to rename a file.
*/
class RenameHandler extends Widget {
/**
* Construct a new "rename" dialog.
*/
constructor(oldPath: string) {
super({ node: Private.createRenameNode(oldPath) });
this.addClass(FILE_DIALOG_CLASS);
let ext = PathExt.extname(oldPath);
let value = (this.inputNode.value = PathExt.basename(oldPath));
this.inputNode.setSelectionRange(0, value.length - ext.length);
}
/**
* Get the input text node.
*/
get inputNode(): HTMLInputElement {
return this.node.getElementsByTagName('input')[0] as HTMLInputElement;
}
/**
* Get the value of the widget.
*/
getValue(): string {
return this.inputNode.value;
}
}
/**
* A namespace for private data.
*/
namespace Private {
/**
* Create the node for a rename handler.
*/
export function createRenameNode(oldPath: string): HTMLElement {
let body = document.createElement('div');
let existingLabel = document.createElement('label');
existingLabel.textContent = 'File Path';
let existingPath = document.createElement('span');
existingPath.textContent = oldPath;
let nameTitle = document.createElement('label');
nameTitle.textContent = 'New Name';
nameTitle.className = RENAME_NEWNAME_TITLE_CLASS;
let name = document.createElement('input');
body.appendChild(existingLabel);
body.appendChild(existingPath);
body.appendChild(nameTitle);
body.appendChild(name);
return body;
}
}