##// END OF EJS Templates
Shutdown the selected notebooks before deleting them
Jonathan Frederic -
Show More
@@ -1,705 +1,710
1 1 // Copyright (c) IPython Development Team.
2 2 // Distributed under the terms of the Modified BSD License.
3 3
4 4 define([
5 5 'base/js/namespace',
6 6 'jquery',
7 7 'base/js/utils',
8 8 'base/js/dialog',
9 9 'base/js/events',
10 10 'base/js/keyboard',
11 11 ], function(IPython, $, utils, dialog, events, keyboard) {
12 12 "use strict";
13 13
14 14 var NotebookList = function (selector, options) {
15 15 /**
16 16 * Constructor
17 17 *
18 18 * Parameters:
19 19 * selector: string
20 20 * options: dictionary
21 21 * Dictionary of keyword arguments.
22 22 * session_list: SessionList instance
23 23 * element_name: string
24 24 * base_url: string
25 25 * notebook_path: string
26 26 * contents: Contents instance
27 27 */
28 28 var that = this;
29 29 this.session_list = options.session_list;
30 30 // allow code re-use by just changing element_name in kernellist.js
31 31 this.element_name = options.element_name || 'notebook';
32 32 this.selector = selector;
33 33 if (this.selector !== undefined) {
34 34 this.element = $(selector);
35 35 this.style();
36 36 this.bind_events();
37 37 }
38 38 this.notebooks_list = [];
39 39 this.sessions = {};
40 40 this.base_url = options.base_url || utils.get_body_data("baseUrl");
41 41 this.notebook_path = options.notebook_path || utils.get_body_data("notebookPath");
42 42 this.contents = options.contents;
43 43 if (this.session_list && this.session_list.events) {
44 44 this.session_list.events.on('sessions_loaded.Dashboard',
45 45 function(e, d) { that.sessions_loaded(d); });
46 46 }
47 47 };
48 48
49 49 NotebookList.prototype.style = function () {
50 50 var prefix = '#' + this.element_name;
51 51 $(prefix + '_toolbar').addClass('list_toolbar');
52 52 $(prefix + '_list_info').addClass('toolbar_info');
53 53 $(prefix + '_buttons').addClass('toolbar_buttons');
54 54 $(prefix + '_list_header').addClass('list_header');
55 55 this.element.addClass("list_container");
56 56 };
57 57
58 58 NotebookList.prototype.bind_events = function () {
59 59 var that = this;
60 60 $('#refresh_' + this.element_name + '_list').click(function () {
61 61 that.load_sessions();
62 62 });
63 63 this.element.bind('dragover', function () {
64 64 return false;
65 65 });
66 66 this.element.bind('drop', function(event){
67 67 that.handleFilesUpload(event,'drop');
68 68 return false;
69 69 });
70 70
71 71 // Bind events for singleton controls.
72 72 if (!NotebookList._bound_singletons) {
73 73 NotebookList._bound_singletons = true;
74 74 $('#new-file').click(function(e) {
75 75 var w = window.open();
76 76 that.contents.new_untitled(that.notebook_path || '', {type: 'file', ext: '.txt'}).then(function(data) {
77 77 var url = utils.url_join_encode(
78 78 that.base_url, 'edit', data.path
79 79 );
80 80 w.location = url;
81 81 });
82 82 that.load_sessions();
83 83 });
84 84 $('#new-folder').click(function(e) {
85 85 that.contents.new_untitled(that.notebook_path || '', {type: 'directory'})
86 86 .then(function(){
87 87 that.load_list();
88 88 });
89 89 });
90 90
91 91 $('.rename-button').click($.proxy(this.rename_selected, this));
92 92 $('.shutdown-button').click($.proxy(this.shutdown_selected, this));
93 93 $('.duplicate-button').click($.proxy(this.duplicate_selected, this));
94 94 $('.delete-button').click($.proxy(this.delete_selected, this));
95 95 }
96 96 };
97 97
98 98 NotebookList.prototype.handleFilesUpload = function(event, dropOrForm) {
99 99 var that = this;
100 100 var files;
101 101 if(dropOrForm =='drop'){
102 102 files = event.originalEvent.dataTransfer.files;
103 103 } else
104 104 {
105 105 files = event.originalEvent.target.files;
106 106 }
107 107 for (var i = 0; i < files.length; i++) {
108 108 var f = files[i];
109 109 var name_and_ext = utils.splitext(f.name);
110 110 var file_ext = name_and_ext[1];
111 111
112 112 var reader = new FileReader();
113 113 if (file_ext === '.ipynb') {
114 114 reader.readAsText(f);
115 115 } else {
116 116 // read non-notebook files as binary
117 117 reader.readAsArrayBuffer(f);
118 118 }
119 119 var item = that.new_item(0, true);
120 120 item.addClass('new-file');
121 121 that.add_name_input(f.name, item, file_ext == '.ipynb' ? 'notebook' : 'file');
122 122 // Store the list item in the reader so we can use it later
123 123 // to know which item it belongs to.
124 124 $(reader).data('item', item);
125 125 reader.onload = function (event) {
126 126 var item = $(event.target).data('item');
127 127 that.add_file_data(event.target.result, item);
128 128 that.add_upload_button(item);
129 129 };
130 130 reader.onerror = function (event) {
131 131 var item = $(event.target).data('item');
132 132 var name = item.data('name');
133 133 item.remove();
134 134 dialog.modal({
135 135 title : 'Failed to read file',
136 136 body : "Failed to read file '" + name + "'",
137 137 buttons : {'OK' : { 'class' : 'btn-primary' }}
138 138 });
139 139 };
140 140 }
141 141 // Replace the file input form wth a clone of itself. This is required to
142 142 // reset the form. Otherwise, if you upload a file, delete it and try to
143 143 // upload it again, the changed event won't fire.
144 144 var form = $('input.fileinput');
145 145 form.replaceWith(form.clone(true));
146 146 return false;
147 147 };
148 148
149 149 NotebookList.prototype.clear_list = function (remove_uploads) {
150 150 /**
151 151 * Clears the navigation tree.
152 152 *
153 153 * Parameters
154 154 * remove_uploads: bool=False
155 155 * Should upload prompts also be removed from the tree.
156 156 */
157 157 if (remove_uploads) {
158 158 this.element.children('.list_item').remove();
159 159 } else {
160 160 this.element.children('.list_item:not(.new-file)').remove();
161 161 }
162 162 };
163 163
164 164 NotebookList.prototype.load_sessions = function(){
165 165 this.session_list.load_sessions();
166 166 };
167 167
168 168
169 169 NotebookList.prototype.sessions_loaded = function(data){
170 170 this.sessions = data;
171 171 this.load_list();
172 172 };
173 173
174 174 NotebookList.prototype.load_list = function () {
175 175 var that = this;
176 176 this.contents.list_contents(that.notebook_path).then(
177 177 $.proxy(this.draw_notebook_list, this),
178 178 function(error) {
179 179 that.draw_notebook_list({content: []}, "Server error: " + error.message);
180 180 }
181 181 );
182 182 };
183 183
184 184 /**
185 185 * Draw the list of notebooks
186 186 * @method draw_notebook_list
187 187 * @param {Array} list An array of dictionaries representing files or
188 188 * directories.
189 189 * @param {String} error_msg An error message
190 190 */
191 191
192 192
193 193 var type_order = {'directory':0,'notebook':1,'file':2};
194 194
195 195 NotebookList.prototype.draw_notebook_list = function (list, error_msg) {
196 196 list.content.sort(function(a, b) {
197 197 if (type_order[a['type']] < type_order[b['type']]) {
198 198 return -1;
199 199 }
200 200 if (type_order[a['type']] > type_order[b['type']]) {
201 201 return 1;
202 202 }
203 203 if (a['name'] < b['name']) {
204 204 return -1;
205 205 }
206 206 if (a['name'] > b['name']) {
207 207 return 1;
208 208 }
209 209 return 0;
210 210 });
211 211 var message = error_msg || 'Notebook list empty.';
212 212 var item = null;
213 213 var model = null;
214 214 var len = list.content.length;
215 215 this.clear_list();
216 216 var n_uploads = this.element.children('.list_item').length;
217 217 if (len === 0) {
218 218 item = this.new_item(0);
219 219 var span12 = item.children().first();
220 220 span12.empty();
221 221 span12.append($('<div style="margin:auto;text-align:center;color:grey"/>').text(message));
222 222 }
223 223 var path = this.notebook_path;
224 224 var offset = n_uploads;
225 225 if (path !== '') {
226 226 item = this.new_item(offset, false);
227 227 model = {
228 228 type: 'directory',
229 229 name: '..',
230 230 path: utils.url_path_split(path)[0],
231 231 };
232 232 this.add_link(model, item);
233 233 offset += 1;
234 234 }
235 235 for (var i=0; i<len; i++) {
236 236 model = list.content[i];
237 237 item = this.new_item(i+offset, true);
238 238 this.add_link(model, item);
239 239 }
240 240 // Trigger an event when we've finished drawing the notebook list.
241 241 events.trigger('draw_notebook_list.NotebookList');
242 242 this._selection_changed();
243 243 };
244 244
245 245
246 246 /**
247 247 * Creates a new item.
248 248 * @param {integer} index
249 249 * @param {boolean} [selectable] - tristate, undefined: don't draw checkbox,
250 250 * false: don't draw checkbox but pad
251 251 * where it should be, true: draw checkbox.
252 252 * @return {JQuery} row
253 253 */
254 254 NotebookList.prototype.new_item = function (index, selectable) {
255 255 var row = $('<div/>')
256 256 .addClass("list_item")
257 257 .addClass("row");
258 258
259 259 var item = $("<div/>")
260 260 .addClass("col-md-12")
261 261 .appendTo(row);
262 262
263 263 var checkbox;
264 264 if (selectable !== undefined) {
265 265 checkbox = $('<input/>')
266 266 .attr('type', 'checkbox')
267 267 .appendTo(item);
268 268 }
269 269
270 270 $('<i/>')
271 271 .addClass('item_icon')
272 272 .appendTo(item);
273 273
274 274 var link = $("<a/>")
275 275 .addClass("item_link")
276 276 .appendTo(item);
277 277
278 278 $("<span/>")
279 279 .addClass("item_name")
280 280 .appendTo(link);
281 281
282 282 if (selectable === false) {
283 283 checkbox.css('visibility', 'hidden');
284 284 } else if (selectable === true) {
285 285 var that = this;
286 286 link.click(function(e) {
287 287 e.stopPropagation();
288 288 });
289 289 checkbox.click(function(e) {
290 290 e.stopPropagation();
291 291 that._selection_changed();
292 292 });
293 293 row.click(function(e) {
294 294 e.stopPropagation();
295 295 checkbox.prop('checked', !checkbox.prop('checked'));
296 296 that._selection_changed();
297 297 });
298 298 }
299 299
300 300 var buttons = $('<div/>')
301 301 .addClass("item_buttons pull-right")
302 302 .appendTo(item);
303 303
304 304 $('<i/>')
305 305 .addClass('fa fa-power-off running-indicator')
306 306 .css('visible', 'hidden')
307 307 .appendTo(buttons);
308 308
309 309 if (index === -1) {
310 310 this.element.append(row);
311 311 } else {
312 312 this.element.children().eq(index).after(row);
313 313 }
314 314 return row;
315 315 };
316 316
317 317
318 318 NotebookList.icons = {
319 319 directory: 'folder_icon',
320 320 notebook: 'notebook_icon',
321 321 file: 'file_icon',
322 322 };
323 323
324 324 NotebookList.uri_prefixes = {
325 325 directory: 'tree',
326 326 notebook: 'notebooks',
327 327 file: 'edit',
328 328 };
329 329
330 330 NotebookList.prototype._selection_changed = function() {
331 331 var selected = [];
332 332 var has_notebook = false;
333 333 var has_directory = false;
334 334 $('.list_item :checked').each(function(index, item) {
335 335 var parent = $(item).parent().parent();
336 336 selected.push({
337 337 name: parent.data('name'),
338 338 path: parent.data('path'),
339 339 type: parent.data('type')
340 340 });
341 341
342 342 has_notebook = has_notebook || parent.data('type') == 'notebook';
343 343 has_directory = has_directory || parent.data('type') == 'directory';
344 344 });
345 345 this.selected = selected;
346 346
347 347 // Rename is only visible when one item is selected.
348 348 if (selected.length==1) {
349 349 $('.rename-button').css('display', 'inline-block');
350 350 } else {
351 351 $('.rename-button').css('display', 'none');
352 352 }
353 353
354 354 // Shutdown is only visible when one or more notebooks are visible.
355 355 if (has_notebook) {
356 356 $('.shutdown-button').css('display', 'inline-block');
357 357 } else {
358 358 $('.shutdown-button').css('display', 'none');
359 359 }
360 360
361 361 // Duplicate isn't visible if a directory is selected.
362 362 if (selected.length > 0 && !has_directory) {
363 363 $('.duplicate-button').css('display', 'inline-block');
364 364 } else {
365 365 $('.duplicate-button').css('display', 'none');
366 366 }
367 367
368 368 // Delete is visible if one or more items are selected.
369 369 if (selected.length > 0) {
370 370 $('.delete-button').css('display', 'inline-block');
371 371 } else {
372 372 $('.delete-button').css('display', 'none');
373 373 }
374 374 };
375 375
376 376 NotebookList.prototype.add_link = function (model, item) {
377 377 var path = model.path,
378 378 name = model.name;
379 379 item.data('name', name);
380 380 item.data('path', path);
381 381 item.data('type', model.type);
382 382 item.find(".item_name").text(name);
383 383 var icon = NotebookList.icons[model.type];
384 384 var uri_prefix = NotebookList.uri_prefixes[model.type];
385 385 item.find(".item_icon").addClass(icon).addClass('icon-fixed-width');
386 386 var link = item.find("a.item_link")
387 387 .attr('href',
388 388 utils.url_join_encode(
389 389 this.base_url,
390 390 uri_prefix,
391 391 path
392 392 )
393 393 );
394 394
395 395 var running = (model.type == 'notebook' && this.sessions[path] !== undefined);
396 396 item.find(".item_buttons i.running-indicator").css('visibility', running ? '' : 'hidden');
397 397
398 398 // directory nav doesn't open new tabs
399 399 // files, notebooks do
400 400 if (model.type !== "directory") {
401 401 link.attr('target','_blank');
402 402 }
403 403 };
404 404
405 405
406 406 NotebookList.prototype.add_name_input = function (name, item, icon_type) {
407 407 item.data('name', name);
408 408 item.find(".item_icon").addClass(NotebookList.icons[icon_type]).addClass('icon-fixed-width');
409 409 item.find(".item_name").empty().append(
410 410 $('<input/>')
411 411 .addClass("filename_input")
412 412 .attr('value', name)
413 413 .attr('size', '30')
414 414 .attr('type', 'text')
415 415 .keyup(function(event){
416 416 if(event.keyCode == 13){item.find('.upload_button').click();}
417 417 else if(event.keyCode == 27){item.remove();}
418 418 })
419 419 );
420 420 };
421 421
422 422
423 423 NotebookList.prototype.add_file_data = function (data, item) {
424 424 item.data('filedata', data);
425 425 };
426 426
427 427
428 428 NotebookList.prototype.shutdown_selected = function() {
429 429 var that = this;
430 430 var settings = {
431 431 processData : false,
432 432 cache : false,
433 433 type : "DELETE",
434 434 dataType : "json",
435 435 success : function () {
436 436 that.load_sessions();
437 437 },
438 438 error : utils.log_ajax_error,
439 439 };
440 440
441 441 this.selected.forEach(function(item) {
442 442 if (item.type == 'notebook') {
443 443 var session = that.sessions[item.path];
444 444 if (session) {
445 445 var url = utils.url_join_encode(
446 446 that.base_url,
447 447 'api/sessions',
448 448 session
449 449 );
450 450 $.ajax(url, settings);
451 451 }
452 452 }
453 453 });
454 454 };
455 455
456 456 NotebookList.prototype.rename_selected = function() {
457 457 if (this.selected.length != 1) return;
458 458
459 459 var that = this;
460 460 var path = this.selected[0].path;
461 461 var input = $('<input/>').attr('type','text').attr('size','25').addClass('form-control')
462 462 .val(path);
463 463 var dialog_body = $('<div/>').append(
464 464 $("<p/>").addClass("rename-message")
465 465 .text('Enter a new directory name:')
466 466 ).append(
467 467 $("<br/>")
468 468 ).append(input);
469 469 var d = dialog.modal({
470 470 title : "Rename directory",
471 471 body : dialog_body,
472 472 buttons : {
473 473 OK : {
474 474 class: "btn-primary",
475 475 click: function() {
476 476 that.contents.rename(path, input.val()).then(function() {
477 477 that.load_list();
478 478 }).catch(function(e) {
479 479 dialog.modal({
480 480 title : "Error",
481 481 body : $('<div/>')
482 482 .text("An error occurred while renaming \"" + path + "\" to \"" + input.val() + "\".")
483 483 .append($('<div/>').addClass('alert alert-danger').text(String(e))),
484 484 buttons : {
485 485 OK : {}
486 486 }
487 487 });
488 488 });
489 489 }
490 490 },
491 491 Cancel : {}
492 492 },
493 493 open : function () {
494 494 // Upon ENTER, click the OK button.
495 495 input.keydown(function (event) {
496 496 if (event.which === keyboard.keycodes.enter) {
497 497 d.find('.btn-primary').first().click();
498 498 return false;
499 499 }
500 500 });
501 501 input.focus().select();
502 502 }
503 503 });
504 504 };
505 505
506 506 NotebookList.prototype.delete_selected = function() {
507 507 var message;
508 508 if (this.selected.length == 1) {
509 509 message = 'Are you sure you want to permanently delete: ' + this.selected[0].name + '?';
510 510 } else {
511 511 message = 'Are you sure you want to permanently delete the ' + this.selected.length + ' files selected?';
512 512 }
513 513 var that = this;
514 514 dialog.modal({
515 515 title : "Delete",
516 516 body : message,
517 517 buttons : {
518 518 Delete : {
519 519 class: "btn-danger",
520 520 click: function() {
521 // Shutdown any/all selected notebooks before deleting
522 // the files.
523 that.shutdown_selected();
524
525 // Delete selected.
521 526 that.selected.forEach(function(item) {
522 527 that.contents.delete(item.path).then(function() {
523 528 that.notebook_deleted(item.path);
524 529 }).catch(function(e) {
525 530 dialog.modal({
526 531 title : "Error",
527 532 body : $('<div/>')
528 533 .text("An error occurred while deleting \"" + item.path + "\".")
529 534 .append($('<div/>').addClass('alert alert-danger').text(String(e))),
530 535 buttons : {
531 536 OK : {}
532 537 }
533 538 });
534 539 });
535 540 });
536 541 }
537 542 },
538 543 Cancel : {}
539 544 }
540 545 });
541 546 };
542 547
543 548 NotebookList.prototype.duplicate_selected = function() {
544 549 var message;
545 550 if (this.selected.length == 1) {
546 551 message = 'Are you sure you want to duplicate: ' + this.selected[0].name + '?';
547 552 } else {
548 553 message = 'Are you sure you want to duplicate the ' + this.selected.length + ' files selected?';
549 554 }
550 555 var that = this;
551 556 dialog.modal({
552 557 title : "Delete",
553 558 body : message,
554 559 buttons : {
555 560 Duplicate : {
556 561 class: "btn-primary",
557 562 click: function() {
558 563 that.selected.forEach(function(item) {
559 564 that.contents.copy(item.path, that.notebook_path).then(function () {
560 565 that.load_list();
561 566 }).catch(function(e) {
562 567 dialog.modal({
563 568 title : "Error",
564 569 body : $('<div/>')
565 570 .text("An error occurred while copying \"" + item.path + "\".")
566 571 .append($('<div/>').addClass('alert alert-danger').text(String(e))),
567 572 buttons : {
568 573 OK : {}
569 574 }
570 575 });
571 576 });
572 577 });
573 578 }
574 579 },
575 580 Cancel : {}
576 581 }
577 582 });
578 583 };
579 584
580 585 NotebookList.prototype.notebook_deleted = function(path) {
581 586 /**
582 587 * Remove the deleted notebook.
583 588 */
584 589 $( ":data(path)" ).each(function() {
585 590 var element = $(this);
586 591 if (element.data("path") == path) {
587 592 element.remove();
588 593 events.trigger('notebook_deleted.NotebookList');
589 594 this._selection_changed();
590 595 }
591 596 });
592 597 };
593 598
594 599
595 600 NotebookList.prototype.add_upload_button = function (item) {
596 601 var that = this;
597 602 var upload_button = $('<button/>').text("Upload")
598 603 .addClass('btn btn-primary btn-xs upload_button')
599 604 .click(function (e) {
600 605 var filename = item.find('.item_name > input').val();
601 606 var path = utils.url_path_join(that.notebook_path, filename);
602 607 var filedata = item.data('filedata');
603 608 var format = 'text';
604 609 if (filename.length === 0 || filename[0] === '.') {
605 610 dialog.modal({
606 611 title : 'Invalid file name',
607 612 body : "File names must be at least one character and not start with a dot",
608 613 buttons : {'OK' : { 'class' : 'btn-primary' }}
609 614 });
610 615 return false;
611 616 }
612 617 if (filedata instanceof ArrayBuffer) {
613 618 // base64-encode binary file data
614 619 var bytes = '';
615 620 var buf = new Uint8Array(filedata);
616 621 var nbytes = buf.byteLength;
617 622 for (var i=0; i<nbytes; i++) {
618 623 bytes += String.fromCharCode(buf[i]);
619 624 }
620 625 filedata = btoa(bytes);
621 626 format = 'base64';
622 627 }
623 628 var model = {};
624 629
625 630 var name_and_ext = utils.splitext(filename);
626 631 var file_ext = name_and_ext[1];
627 632 var content_type;
628 633 if (file_ext === '.ipynb') {
629 634 model.type = 'notebook';
630 635 model.format = 'json';
631 636 try {
632 637 model.content = JSON.parse(filedata);
633 638 } catch (e) {
634 639 dialog.modal({
635 640 title : 'Cannot upload invalid Notebook',
636 641 body : "The error was: " + e,
637 642 buttons : {'OK' : {
638 643 'class' : 'btn-primary',
639 644 click: function () {
640 645 item.remove();
641 646 }
642 647 }}
643 648 });
644 649 return false;
645 650 }
646 651 content_type = 'application/json';
647 652 } else {
648 653 model.type = 'file';
649 654 model.format = format;
650 655 model.content = filedata;
651 656 content_type = 'application/octet-stream';
652 657 }
653 658 filedata = item.data('filedata');
654 659
655 660 var on_success = function () {
656 661 item.removeClass('new-file');
657 662 that.add_link(model, item);
658 663 that.add_delete_button(item);
659 664 that.session_list.load_sessions();
660 665 };
661 666
662 667 var exists = false;
663 668 $.each(that.element.find('.list_item:not(.new-file)'), function(k,v){
664 669 if ($(v).data('name') === filename) { exists = true; return false; }
665 670 });
666 671
667 672 if (exists) {
668 673 dialog.modal({
669 674 title : "Replace file",
670 675 body : 'There is already a file named ' + filename + ', do you want to replace it?',
671 676 buttons : {
672 677 Overwrite : {
673 678 class: "btn-danger",
674 679 click: function () {
675 680 that.contents.save(path, model).then(on_success);
676 681 }
677 682 },
678 683 Cancel : {
679 684 click: function() { item.remove(); }
680 685 }
681 686 }
682 687 });
683 688 } else {
684 689 that.contents.save(path, model).then(on_success);
685 690 }
686 691
687 692 return false;
688 693 });
689 694 var cancel_button = $('<button/>').text("Cancel")
690 695 .addClass("btn btn-default btn-xs")
691 696 .click(function (e) {
692 697 item.remove();
693 698 return false;
694 699 });
695 700 item.find(".item_buttons").empty()
696 701 .append(upload_button)
697 702 .append(cancel_button);
698 703 };
699 704
700 705
701 706 // Backwards compatability.
702 707 IPython.NotebookList = NotebookList;
703 708
704 709 return {'NotebookList': NotebookList};
705 710 });
General Comments 0
You need to be logged in to leave comments. Login now