##// END OF EJS Templates
Merge pull request #5396 from ivanov/fix-5363...
Min RK -
r15995:41452895 merge
parent child Browse files
Show More
@@ -1,2407 +1,2413 b''
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2011 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // Notebook
10 10 //============================================================================
11 11
12 12 var IPython = (function (IPython) {
13 13 "use strict";
14 14
15 15 var utils = IPython.utils;
16 16
17 17 /**
18 18 * A notebook contains and manages cells.
19 19 *
20 20 * @class Notebook
21 21 * @constructor
22 22 * @param {String} selector A jQuery selector for the notebook's DOM element
23 23 * @param {Object} [options] A config object
24 24 */
25 25 var Notebook = function (selector, options) {
26 26 this.options = options = options || {};
27 27 this.base_url = options.base_url;
28 28 this.notebook_path = options.notebook_path;
29 29 this.notebook_name = options.notebook_name;
30 30 this.element = $(selector);
31 31 this.element.scroll();
32 32 this.element.data("notebook", this);
33 33 this.next_prompt_number = 1;
34 34 this.session = null;
35 35 this.kernel = null;
36 36 this.clipboard = null;
37 37 this.undelete_backup = null;
38 38 this.undelete_index = null;
39 39 this.undelete_below = false;
40 40 this.paste_enabled = false;
41 41 // It is important to start out in command mode to match the intial mode
42 42 // of the KeyboardManager.
43 43 this.mode = 'command';
44 44 this.set_dirty(false);
45 45 this.metadata = {};
46 46 this._checkpoint_after_save = false;
47 47 this.last_checkpoint = null;
48 48 this.checkpoints = [];
49 49 this.autosave_interval = 0;
50 50 this.autosave_timer = null;
51 51 // autosave *at most* every two minutes
52 52 this.minimum_autosave_interval = 120000;
53 53 // single worksheet for now
54 54 this.worksheet_metadata = {};
55 55 this.notebook_name_blacklist_re = /[\/\\:]/;
56 56 this.nbformat = 3; // Increment this when changing the nbformat
57 57 this.nbformat_minor = 0; // Increment this when changing the nbformat
58 58 this.style();
59 59 this.create_elements();
60 60 this.bind_events();
61 this.save_notebook = function() { // don't allow save until notebook_loaded
62 this.save_notebook_error(null, null, "Load failed, save is disabled");
63 };
61 64 };
62 65
63 66 /**
64 67 * Tweak the notebook's CSS style.
65 68 *
66 69 * @method style
67 70 */
68 71 Notebook.prototype.style = function () {
69 72 $('div#notebook').addClass('border-box-sizing');
70 73 };
71 74
72 75 /**
73 76 * Create an HTML and CSS representation of the notebook.
74 77 *
75 78 * @method create_elements
76 79 */
77 80 Notebook.prototype.create_elements = function () {
78 81 var that = this;
79 82 this.element.attr('tabindex','-1');
80 83 this.container = $("<div/>").addClass("container").attr("id", "notebook-container");
81 84 // We add this end_space div to the end of the notebook div to:
82 85 // i) provide a margin between the last cell and the end of the notebook
83 86 // ii) to prevent the div from scrolling up when the last cell is being
84 87 // edited, but is too low on the page, which browsers will do automatically.
85 88 var end_space = $('<div/>').addClass('end_space');
86 89 end_space.dblclick(function (e) {
87 90 var ncells = that.ncells();
88 91 that.insert_cell_below('code',ncells-1);
89 92 });
90 93 this.element.append(this.container);
91 94 this.container.append(end_space);
92 95 };
93 96
94 97 /**
95 98 * Bind JavaScript events: key presses and custom IPython events.
96 99 *
97 100 * @method bind_events
98 101 */
99 102 Notebook.prototype.bind_events = function () {
100 103 var that = this;
101 104
102 105 $([IPython.events]).on('set_next_input.Notebook', function (event, data) {
103 106 var index = that.find_cell_index(data.cell);
104 107 var new_cell = that.insert_cell_below('code',index);
105 108 new_cell.set_text(data.text);
106 109 that.dirty = true;
107 110 });
108 111
109 112 $([IPython.events]).on('set_dirty.Notebook', function (event, data) {
110 113 that.dirty = data.value;
111 114 });
112 115
113 116 $([IPython.events]).on('trust_changed.Notebook', function (event, data) {
114 117 that.trusted = data.value;
115 118 });
116 119
117 120 $([IPython.events]).on('select.Cell', function (event, data) {
118 121 var index = that.find_cell_index(data.cell);
119 122 that.select(index);
120 123 });
121 124
122 125 $([IPython.events]).on('edit_mode.Cell', function (event, data) {
123 126 that.handle_edit_mode(data.cell);
124 127 });
125 128
126 129 $([IPython.events]).on('command_mode.Cell', function (event, data) {
127 130 that.handle_command_mode(data.cell);
128 131 });
129 132
130 133 $([IPython.events]).on('status_autorestarting.Kernel', function () {
131 134 IPython.dialog.modal({
132 135 title: "Kernel Restarting",
133 136 body: "The kernel appears to have died. It will restart automatically.",
134 137 buttons: {
135 138 OK : {
136 139 class : "btn-primary"
137 140 }
138 141 }
139 142 });
140 143 });
141 144
142 145 var collapse_time = function (time) {
143 146 var app_height = $('#ipython-main-app').height(); // content height
144 147 var splitter_height = $('div#pager_splitter').outerHeight(true);
145 148 var new_height = app_height - splitter_height;
146 149 that.element.animate({height : new_height + 'px'}, time);
147 150 };
148 151
149 152 this.element.bind('collapse_pager', function (event, extrap) {
150 153 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
151 154 collapse_time(time);
152 155 });
153 156
154 157 var expand_time = function (time) {
155 158 var app_height = $('#ipython-main-app').height(); // content height
156 159 var splitter_height = $('div#pager_splitter').outerHeight(true);
157 160 var pager_height = $('div#pager').outerHeight(true);
158 161 var new_height = app_height - pager_height - splitter_height;
159 162 that.element.animate({height : new_height + 'px'}, time);
160 163 };
161 164
162 165 this.element.bind('expand_pager', function (event, extrap) {
163 166 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
164 167 expand_time(time);
165 168 });
166 169
167 170 // Firefox 22 broke $(window).on("beforeunload")
168 171 // I'm not sure why or how.
169 172 window.onbeforeunload = function (e) {
170 173 // TODO: Make killing the kernel configurable.
171 174 var kill_kernel = false;
172 175 if (kill_kernel) {
173 176 that.session.kill_kernel();
174 177 }
175 178 // if we are autosaving, trigger an autosave on nav-away.
176 179 // still warn, because if we don't the autosave may fail.
177 180 if (that.dirty) {
178 181 if ( that.autosave_interval ) {
179 182 // schedule autosave in a timeout
180 183 // this gives you a chance to forcefully discard changes
181 184 // by reloading the page if you *really* want to.
182 185 // the timer doesn't start until you *dismiss* the dialog.
183 186 setTimeout(function () {
184 187 if (that.dirty) {
185 188 that.save_notebook();
186 189 }
187 190 }, 1000);
188 191 return "Autosave in progress, latest changes may be lost.";
189 192 } else {
190 193 return "Unsaved changes will be lost.";
191 194 }
192 195 }
193 196 // Null is the *only* return value that will make the browser not
194 197 // pop up the "don't leave" dialog.
195 198 return null;
196 199 };
197 200 };
198 201
199 202 /**
200 203 * Set the dirty flag, and trigger the set_dirty.Notebook event
201 204 *
202 205 * @method set_dirty
203 206 */
204 207 Notebook.prototype.set_dirty = function (value) {
205 208 if (value === undefined) {
206 209 value = true;
207 210 }
208 211 if (this.dirty == value) {
209 212 return;
210 213 }
211 214 $([IPython.events]).trigger('set_dirty.Notebook', {value: value});
212 215 };
213 216
214 217 /**
215 218 * Scroll the top of the page to a given cell.
216 219 *
217 220 * @method scroll_to_cell
218 221 * @param {Number} cell_number An index of the cell to view
219 222 * @param {Number} time Animation time in milliseconds
220 223 * @return {Number} Pixel offset from the top of the container
221 224 */
222 225 Notebook.prototype.scroll_to_cell = function (cell_number, time) {
223 226 var cells = this.get_cells();
224 227 time = time || 0;
225 228 cell_number = Math.min(cells.length-1,cell_number);
226 229 cell_number = Math.max(0 ,cell_number);
227 230 var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ;
228 231 this.element.animate({scrollTop:scroll_value}, time);
229 232 return scroll_value;
230 233 };
231 234
232 235 /**
233 236 * Scroll to the bottom of the page.
234 237 *
235 238 * @method scroll_to_bottom
236 239 */
237 240 Notebook.prototype.scroll_to_bottom = function () {
238 241 this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0);
239 242 };
240 243
241 244 /**
242 245 * Scroll to the top of the page.
243 246 *
244 247 * @method scroll_to_top
245 248 */
246 249 Notebook.prototype.scroll_to_top = function () {
247 250 this.element.animate({scrollTop:0}, 0);
248 251 };
249 252
250 253 // Edit Notebook metadata
251 254
252 255 Notebook.prototype.edit_metadata = function () {
253 256 var that = this;
254 257 IPython.dialog.edit_metadata(this.metadata, function (md) {
255 258 that.metadata = md;
256 259 }, 'Notebook');
257 260 };
258 261
259 262 // Cell indexing, retrieval, etc.
260 263
261 264 /**
262 265 * Get all cell elements in the notebook.
263 266 *
264 267 * @method get_cell_elements
265 268 * @return {jQuery} A selector of all cell elements
266 269 */
267 270 Notebook.prototype.get_cell_elements = function () {
268 271 return this.container.children("div.cell");
269 272 };
270 273
271 274 /**
272 275 * Get a particular cell element.
273 276 *
274 277 * @method get_cell_element
275 278 * @param {Number} index An index of a cell to select
276 279 * @return {jQuery} A selector of the given cell.
277 280 */
278 281 Notebook.prototype.get_cell_element = function (index) {
279 282 var result = null;
280 283 var e = this.get_cell_elements().eq(index);
281 284 if (e.length !== 0) {
282 285 result = e;
283 286 }
284 287 return result;
285 288 };
286 289
287 290 /**
288 291 * Try to get a particular cell by msg_id.
289 292 *
290 293 * @method get_msg_cell
291 294 * @param {String} msg_id A message UUID
292 295 * @return {Cell} Cell or null if no cell was found.
293 296 */
294 297 Notebook.prototype.get_msg_cell = function (msg_id) {
295 298 return IPython.CodeCell.msg_cells[msg_id] || null;
296 299 };
297 300
298 301 /**
299 302 * Count the cells in this notebook.
300 303 *
301 304 * @method ncells
302 305 * @return {Number} The number of cells in this notebook
303 306 */
304 307 Notebook.prototype.ncells = function () {
305 308 return this.get_cell_elements().length;
306 309 };
307 310
308 311 /**
309 312 * Get all Cell objects in this notebook.
310 313 *
311 314 * @method get_cells
312 315 * @return {Array} This notebook's Cell objects
313 316 */
314 317 // TODO: we are often calling cells as cells()[i], which we should optimize
315 318 // to cells(i) or a new method.
316 319 Notebook.prototype.get_cells = function () {
317 320 return this.get_cell_elements().toArray().map(function (e) {
318 321 return $(e).data("cell");
319 322 });
320 323 };
321 324
322 325 /**
323 326 * Get a Cell object from this notebook.
324 327 *
325 328 * @method get_cell
326 329 * @param {Number} index An index of a cell to retrieve
327 330 * @return {Cell} A particular cell
328 331 */
329 332 Notebook.prototype.get_cell = function (index) {
330 333 var result = null;
331 334 var ce = this.get_cell_element(index);
332 335 if (ce !== null) {
333 336 result = ce.data('cell');
334 337 }
335 338 return result;
336 339 };
337 340
338 341 /**
339 342 * Get the cell below a given cell.
340 343 *
341 344 * @method get_next_cell
342 345 * @param {Cell} cell The provided cell
343 346 * @return {Cell} The next cell
344 347 */
345 348 Notebook.prototype.get_next_cell = function (cell) {
346 349 var result = null;
347 350 var index = this.find_cell_index(cell);
348 351 if (this.is_valid_cell_index(index+1)) {
349 352 result = this.get_cell(index+1);
350 353 }
351 354 return result;
352 355 };
353 356
354 357 /**
355 358 * Get the cell above a given cell.
356 359 *
357 360 * @method get_prev_cell
358 361 * @param {Cell} cell The provided cell
359 362 * @return {Cell} The previous cell
360 363 */
361 364 Notebook.prototype.get_prev_cell = function (cell) {
362 365 // TODO: off-by-one
363 366 // nb.get_prev_cell(nb.get_cell(1)) is null
364 367 var result = null;
365 368 var index = this.find_cell_index(cell);
366 369 if (index !== null && index > 1) {
367 370 result = this.get_cell(index-1);
368 371 }
369 372 return result;
370 373 };
371 374
372 375 /**
373 376 * Get the numeric index of a given cell.
374 377 *
375 378 * @method find_cell_index
376 379 * @param {Cell} cell The provided cell
377 380 * @return {Number} The cell's numeric index
378 381 */
379 382 Notebook.prototype.find_cell_index = function (cell) {
380 383 var result = null;
381 384 this.get_cell_elements().filter(function (index) {
382 385 if ($(this).data("cell") === cell) {
383 386 result = index;
384 387 }
385 388 });
386 389 return result;
387 390 };
388 391
389 392 /**
390 393 * Get a given index , or the selected index if none is provided.
391 394 *
392 395 * @method index_or_selected
393 396 * @param {Number} index A cell's index
394 397 * @return {Number} The given index, or selected index if none is provided.
395 398 */
396 399 Notebook.prototype.index_or_selected = function (index) {
397 400 var i;
398 401 if (index === undefined || index === null) {
399 402 i = this.get_selected_index();
400 403 if (i === null) {
401 404 i = 0;
402 405 }
403 406 } else {
404 407 i = index;
405 408 }
406 409 return i;
407 410 };
408 411
409 412 /**
410 413 * Get the currently selected cell.
411 414 * @method get_selected_cell
412 415 * @return {Cell} The selected cell
413 416 */
414 417 Notebook.prototype.get_selected_cell = function () {
415 418 var index = this.get_selected_index();
416 419 return this.get_cell(index);
417 420 };
418 421
419 422 /**
420 423 * Check whether a cell index is valid.
421 424 *
422 425 * @method is_valid_cell_index
423 426 * @param {Number} index A cell index
424 427 * @return True if the index is valid, false otherwise
425 428 */
426 429 Notebook.prototype.is_valid_cell_index = function (index) {
427 430 if (index !== null && index >= 0 && index < this.ncells()) {
428 431 return true;
429 432 } else {
430 433 return false;
431 434 }
432 435 };
433 436
434 437 /**
435 438 * Get the index of the currently selected cell.
436 439
437 440 * @method get_selected_index
438 441 * @return {Number} The selected cell's numeric index
439 442 */
440 443 Notebook.prototype.get_selected_index = function () {
441 444 var result = null;
442 445 this.get_cell_elements().filter(function (index) {
443 446 if ($(this).data("cell").selected === true) {
444 447 result = index;
445 448 }
446 449 });
447 450 return result;
448 451 };
449 452
450 453
451 454 // Cell selection.
452 455
453 456 /**
454 457 * Programmatically select a cell.
455 458 *
456 459 * @method select
457 460 * @param {Number} index A cell's index
458 461 * @return {Notebook} This notebook
459 462 */
460 463 Notebook.prototype.select = function (index) {
461 464 if (this.is_valid_cell_index(index)) {
462 465 var sindex = this.get_selected_index();
463 466 if (sindex !== null && index !== sindex) {
464 467 // If we are about to select a different cell, make sure we are
465 468 // first in command mode.
466 469 if (this.mode !== 'command') {
467 470 this.command_mode();
468 471 }
469 472 this.get_cell(sindex).unselect();
470 473 }
471 474 var cell = this.get_cell(index);
472 475 cell.select();
473 476 if (cell.cell_type === 'heading') {
474 477 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
475 478 {'cell_type':cell.cell_type,level:cell.level}
476 479 );
477 480 } else {
478 481 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
479 482 {'cell_type':cell.cell_type}
480 483 );
481 484 }
482 485 }
483 486 return this;
484 487 };
485 488
486 489 /**
487 490 * Programmatically select the next cell.
488 491 *
489 492 * @method select_next
490 493 * @return {Notebook} This notebook
491 494 */
492 495 Notebook.prototype.select_next = function () {
493 496 var index = this.get_selected_index();
494 497 this.select(index+1);
495 498 return this;
496 499 };
497 500
498 501 /**
499 502 * Programmatically select the previous cell.
500 503 *
501 504 * @method select_prev
502 505 * @return {Notebook} This notebook
503 506 */
504 507 Notebook.prototype.select_prev = function () {
505 508 var index = this.get_selected_index();
506 509 this.select(index-1);
507 510 return this;
508 511 };
509 512
510 513
511 514 // Edit/Command mode
512 515
513 516 /**
514 517 * Gets the index of the cell that is in edit mode.
515 518 *
516 519 * @method get_edit_index
517 520 *
518 521 * @return index {int}
519 522 **/
520 523 Notebook.prototype.get_edit_index = function () {
521 524 var result = null;
522 525 this.get_cell_elements().filter(function (index) {
523 526 if ($(this).data("cell").mode === 'edit') {
524 527 result = index;
525 528 }
526 529 });
527 530 return result;
528 531 };
529 532
530 533 /**
531 534 * Handle when a a cell blurs and the notebook should enter command mode.
532 535 *
533 536 * @method handle_command_mode
534 537 * @param [cell] {Cell} Cell to enter command mode on.
535 538 **/
536 539 Notebook.prototype.handle_command_mode = function (cell) {
537 540 if (this.mode !== 'command') {
538 541 cell.command_mode();
539 542 this.mode = 'command';
540 543 $([IPython.events]).trigger('command_mode.Notebook');
541 544 IPython.keyboard_manager.command_mode();
542 545 }
543 546 };
544 547
545 548 /**
546 549 * Make the notebook enter command mode.
547 550 *
548 551 * @method command_mode
549 552 **/
550 553 Notebook.prototype.command_mode = function () {
551 554 var cell = this.get_cell(this.get_edit_index());
552 555 if (cell && this.mode !== 'command') {
553 556 // We don't call cell.command_mode, but rather call cell.focus_cell()
554 557 // which will blur and CM editor and trigger the call to
555 558 // handle_command_mode.
556 559 cell.focus_cell();
557 560 }
558 561 };
559 562
560 563 /**
561 564 * Handle when a cell fires it's edit_mode event.
562 565 *
563 566 * @method handle_edit_mode
564 567 * @param [cell] {Cell} Cell to enter edit mode on.
565 568 **/
566 569 Notebook.prototype.handle_edit_mode = function (cell) {
567 570 if (cell && this.mode !== 'edit') {
568 571 cell.edit_mode();
569 572 this.mode = 'edit';
570 573 $([IPython.events]).trigger('edit_mode.Notebook');
571 574 IPython.keyboard_manager.edit_mode();
572 575 }
573 576 };
574 577
575 578 /**
576 579 * Make a cell enter edit mode.
577 580 *
578 581 * @method edit_mode
579 582 **/
580 583 Notebook.prototype.edit_mode = function () {
581 584 var cell = this.get_selected_cell();
582 585 if (cell && this.mode !== 'edit') {
583 586 cell.unrender();
584 587 cell.focus_editor();
585 588 }
586 589 };
587 590
588 591 /**
589 592 * Focus the currently selected cell.
590 593 *
591 594 * @method focus_cell
592 595 **/
593 596 Notebook.prototype.focus_cell = function () {
594 597 var cell = this.get_selected_cell();
595 598 if (cell === null) {return;} // No cell is selected
596 599 cell.focus_cell();
597 600 };
598 601
599 602 // Cell movement
600 603
601 604 /**
602 605 * Move given (or selected) cell up and select it.
603 606 *
604 607 * @method move_cell_up
605 608 * @param [index] {integer} cell index
606 609 * @return {Notebook} This notebook
607 610 **/
608 611 Notebook.prototype.move_cell_up = function (index) {
609 612 var i = this.index_or_selected(index);
610 613 if (this.is_valid_cell_index(i) && i > 0) {
611 614 var pivot = this.get_cell_element(i-1);
612 615 var tomove = this.get_cell_element(i);
613 616 if (pivot !== null && tomove !== null) {
614 617 tomove.detach();
615 618 pivot.before(tomove);
616 619 this.select(i-1);
617 620 var cell = this.get_selected_cell();
618 621 cell.focus_cell();
619 622 }
620 623 this.set_dirty(true);
621 624 }
622 625 return this;
623 626 };
624 627
625 628
626 629 /**
627 630 * Move given (or selected) cell down and select it
628 631 *
629 632 * @method move_cell_down
630 633 * @param [index] {integer} cell index
631 634 * @return {Notebook} This notebook
632 635 **/
633 636 Notebook.prototype.move_cell_down = function (index) {
634 637 var i = this.index_or_selected(index);
635 638 if (this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) {
636 639 var pivot = this.get_cell_element(i+1);
637 640 var tomove = this.get_cell_element(i);
638 641 if (pivot !== null && tomove !== null) {
639 642 tomove.detach();
640 643 pivot.after(tomove);
641 644 this.select(i+1);
642 645 var cell = this.get_selected_cell();
643 646 cell.focus_cell();
644 647 }
645 648 }
646 649 this.set_dirty();
647 650 return this;
648 651 };
649 652
650 653
651 654 // Insertion, deletion.
652 655
653 656 /**
654 657 * Delete a cell from the notebook.
655 658 *
656 659 * @method delete_cell
657 660 * @param [index] A cell's numeric index
658 661 * @return {Notebook} This notebook
659 662 */
660 663 Notebook.prototype.delete_cell = function (index) {
661 664 var i = this.index_or_selected(index);
662 665 var cell = this.get_selected_cell();
663 666 this.undelete_backup = cell.toJSON();
664 667 $('#undelete_cell').removeClass('disabled');
665 668 if (this.is_valid_cell_index(i)) {
666 669 var old_ncells = this.ncells();
667 670 var ce = this.get_cell_element(i);
668 671 ce.remove();
669 672 if (i === 0) {
670 673 // Always make sure we have at least one cell.
671 674 if (old_ncells === 1) {
672 675 this.insert_cell_below('code');
673 676 }
674 677 this.select(0);
675 678 this.undelete_index = 0;
676 679 this.undelete_below = false;
677 680 } else if (i === old_ncells-1 && i !== 0) {
678 681 this.select(i-1);
679 682 this.undelete_index = i - 1;
680 683 this.undelete_below = true;
681 684 } else {
682 685 this.select(i);
683 686 this.undelete_index = i;
684 687 this.undelete_below = false;
685 688 }
686 689 $([IPython.events]).trigger('delete.Cell', {'cell': cell, 'index': i});
687 690 this.set_dirty(true);
688 691 }
689 692 return this;
690 693 };
691 694
692 695 /**
693 696 * Restore the most recently deleted cell.
694 697 *
695 698 * @method undelete
696 699 */
697 700 Notebook.prototype.undelete_cell = function() {
698 701 if (this.undelete_backup !== null && this.undelete_index !== null) {
699 702 var current_index = this.get_selected_index();
700 703 if (this.undelete_index < current_index) {
701 704 current_index = current_index + 1;
702 705 }
703 706 if (this.undelete_index >= this.ncells()) {
704 707 this.select(this.ncells() - 1);
705 708 }
706 709 else {
707 710 this.select(this.undelete_index);
708 711 }
709 712 var cell_data = this.undelete_backup;
710 713 var new_cell = null;
711 714 if (this.undelete_below) {
712 715 new_cell = this.insert_cell_below(cell_data.cell_type);
713 716 } else {
714 717 new_cell = this.insert_cell_above(cell_data.cell_type);
715 718 }
716 719 new_cell.fromJSON(cell_data);
717 720 if (this.undelete_below) {
718 721 this.select(current_index+1);
719 722 } else {
720 723 this.select(current_index);
721 724 }
722 725 this.undelete_backup = null;
723 726 this.undelete_index = null;
724 727 }
725 728 $('#undelete_cell').addClass('disabled');
726 729 };
727 730
728 731 /**
729 732 * Insert a cell so that after insertion the cell is at given index.
730 733 *
731 734 * Similar to insert_above, but index parameter is mandatory
732 735 *
733 736 * Index will be brought back into the accissible range [0,n]
734 737 *
735 738 * @method insert_cell_at_index
736 739 * @param type {string} in ['code','markdown','heading']
737 740 * @param [index] {int} a valid index where to inser cell
738 741 *
739 742 * @return cell {cell|null} created cell or null
740 743 **/
741 744 Notebook.prototype.insert_cell_at_index = function(type, index){
742 745
743 746 var ncells = this.ncells();
744 747 index = Math.min(index,ncells);
745 748 index = Math.max(index,0);
746 749 var cell = null;
747 750
748 751 if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) {
749 752 if (type === 'code') {
750 753 cell = new IPython.CodeCell(this.kernel);
751 754 cell.set_input_prompt();
752 755 } else if (type === 'markdown') {
753 756 cell = new IPython.MarkdownCell();
754 757 } else if (type === 'raw') {
755 758 cell = new IPython.RawCell();
756 759 } else if (type === 'heading') {
757 760 cell = new IPython.HeadingCell();
758 761 }
759 762
760 763 if(this._insert_element_at_index(cell.element,index)) {
761 764 cell.render();
762 765 $([IPython.events]).trigger('create.Cell', {'cell': cell, 'index': index});
763 766 cell.refresh();
764 767 // We used to select the cell after we refresh it, but there
765 768 // are now cases were this method is called where select is
766 769 // not appropriate. The selection logic should be handled by the
767 770 // caller of the the top level insert_cell methods.
768 771 this.set_dirty(true);
769 772 }
770 773 }
771 774 return cell;
772 775
773 776 };
774 777
775 778 /**
776 779 * Insert an element at given cell index.
777 780 *
778 781 * @method _insert_element_at_index
779 782 * @param element {dom element} a cell element
780 783 * @param [index] {int} a valid index where to inser cell
781 784 * @private
782 785 *
783 786 * return true if everything whent fine.
784 787 **/
785 788 Notebook.prototype._insert_element_at_index = function(element, index){
786 789 if (element === undefined){
787 790 return false;
788 791 }
789 792
790 793 var ncells = this.ncells();
791 794
792 795 if (ncells === 0) {
793 796 // special case append if empty
794 797 this.element.find('div.end_space').before(element);
795 798 } else if ( ncells === index ) {
796 799 // special case append it the end, but not empty
797 800 this.get_cell_element(index-1).after(element);
798 801 } else if (this.is_valid_cell_index(index)) {
799 802 // otherwise always somewhere to append to
800 803 this.get_cell_element(index).before(element);
801 804 } else {
802 805 return false;
803 806 }
804 807
805 808 if (this.undelete_index !== null && index <= this.undelete_index) {
806 809 this.undelete_index = this.undelete_index + 1;
807 810 this.set_dirty(true);
808 811 }
809 812 return true;
810 813 };
811 814
812 815 /**
813 816 * Insert a cell of given type above given index, or at top
814 817 * of notebook if index smaller than 0.
815 818 *
816 819 * default index value is the one of currently selected cell
817 820 *
818 821 * @method insert_cell_above
819 822 * @param type {string} cell type
820 823 * @param [index] {integer}
821 824 *
822 825 * @return handle to created cell or null
823 826 **/
824 827 Notebook.prototype.insert_cell_above = function (type, index) {
825 828 index = this.index_or_selected(index);
826 829 return this.insert_cell_at_index(type, index);
827 830 };
828 831
829 832 /**
830 833 * Insert a cell of given type below given index, or at bottom
831 834 * of notebook if index greater thatn number of cell
832 835 *
833 836 * default index value is the one of currently selected cell
834 837 *
835 838 * @method insert_cell_below
836 839 * @param type {string} cell type
837 840 * @param [index] {integer}
838 841 *
839 842 * @return handle to created cell or null
840 843 *
841 844 **/
842 845 Notebook.prototype.insert_cell_below = function (type, index) {
843 846 index = this.index_or_selected(index);
844 847 return this.insert_cell_at_index(type, index+1);
845 848 };
846 849
847 850
848 851 /**
849 852 * Insert cell at end of notebook
850 853 *
851 854 * @method insert_cell_at_bottom
852 855 * @param {String} type cell type
853 856 *
854 857 * @return the added cell; or null
855 858 **/
856 859 Notebook.prototype.insert_cell_at_bottom = function (type){
857 860 var len = this.ncells();
858 861 return this.insert_cell_below(type,len-1);
859 862 };
860 863
861 864 /**
862 865 * Turn a cell into a code cell.
863 866 *
864 867 * @method to_code
865 868 * @param {Number} [index] A cell's index
866 869 */
867 870 Notebook.prototype.to_code = function (index) {
868 871 var i = this.index_or_selected(index);
869 872 if (this.is_valid_cell_index(i)) {
870 873 var source_element = this.get_cell_element(i);
871 874 var source_cell = source_element.data("cell");
872 875 if (!(source_cell instanceof IPython.CodeCell)) {
873 876 var target_cell = this.insert_cell_below('code',i);
874 877 var text = source_cell.get_text();
875 878 if (text === source_cell.placeholder) {
876 879 text = '';
877 880 }
878 881 target_cell.set_text(text);
879 882 // make this value the starting point, so that we can only undo
880 883 // to this state, instead of a blank cell
881 884 target_cell.code_mirror.clearHistory();
882 885 source_element.remove();
883 886 this.select(i);
884 887 this.set_dirty(true);
885 888 }
886 889 }
887 890 };
888 891
889 892 /**
890 893 * Turn a cell into a Markdown cell.
891 894 *
892 895 * @method to_markdown
893 896 * @param {Number} [index] A cell's index
894 897 */
895 898 Notebook.prototype.to_markdown = function (index) {
896 899 var i = this.index_or_selected(index);
897 900 if (this.is_valid_cell_index(i)) {
898 901 var source_element = this.get_cell_element(i);
899 902 var source_cell = source_element.data("cell");
900 903 if (!(source_cell instanceof IPython.MarkdownCell)) {
901 904 var target_cell = this.insert_cell_below('markdown',i);
902 905 var text = source_cell.get_text();
903 906 if (text === source_cell.placeholder) {
904 907 text = '';
905 908 }
906 909 // We must show the editor before setting its contents
907 910 target_cell.unrender();
908 911 target_cell.set_text(text);
909 912 // make this value the starting point, so that we can only undo
910 913 // to this state, instead of a blank cell
911 914 target_cell.code_mirror.clearHistory();
912 915 source_element.remove();
913 916 this.select(i);
914 917 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
915 918 target_cell.render();
916 919 }
917 920 this.set_dirty(true);
918 921 }
919 922 }
920 923 };
921 924
922 925 /**
923 926 * Turn a cell into a raw text cell.
924 927 *
925 928 * @method to_raw
926 929 * @param {Number} [index] A cell's index
927 930 */
928 931 Notebook.prototype.to_raw = function (index) {
929 932 var i = this.index_or_selected(index);
930 933 if (this.is_valid_cell_index(i)) {
931 934 var source_element = this.get_cell_element(i);
932 935 var source_cell = source_element.data("cell");
933 936 var target_cell = null;
934 937 if (!(source_cell instanceof IPython.RawCell)) {
935 938 target_cell = this.insert_cell_below('raw',i);
936 939 var text = source_cell.get_text();
937 940 if (text === source_cell.placeholder) {
938 941 text = '';
939 942 }
940 943 // We must show the editor before setting its contents
941 944 target_cell.unrender();
942 945 target_cell.set_text(text);
943 946 // make this value the starting point, so that we can only undo
944 947 // to this state, instead of a blank cell
945 948 target_cell.code_mirror.clearHistory();
946 949 source_element.remove();
947 950 this.select(i);
948 951 this.set_dirty(true);
949 952 }
950 953 }
951 954 };
952 955
953 956 /**
954 957 * Turn a cell into a heading cell.
955 958 *
956 959 * @method to_heading
957 960 * @param {Number} [index] A cell's index
958 961 * @param {Number} [level] A heading level (e.g., 1 becomes &lt;h1&gt;)
959 962 */
960 963 Notebook.prototype.to_heading = function (index, level) {
961 964 level = level || 1;
962 965 var i = this.index_or_selected(index);
963 966 if (this.is_valid_cell_index(i)) {
964 967 var source_element = this.get_cell_element(i);
965 968 var source_cell = source_element.data("cell");
966 969 var target_cell = null;
967 970 if (source_cell instanceof IPython.HeadingCell) {
968 971 source_cell.set_level(level);
969 972 } else {
970 973 target_cell = this.insert_cell_below('heading',i);
971 974 var text = source_cell.get_text();
972 975 if (text === source_cell.placeholder) {
973 976 text = '';
974 977 }
975 978 // We must show the editor before setting its contents
976 979 target_cell.set_level(level);
977 980 target_cell.unrender();
978 981 target_cell.set_text(text);
979 982 // make this value the starting point, so that we can only undo
980 983 // to this state, instead of a blank cell
981 984 target_cell.code_mirror.clearHistory();
982 985 source_element.remove();
983 986 this.select(i);
984 987 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
985 988 target_cell.render();
986 989 }
987 990 }
988 991 this.set_dirty(true);
989 992 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
990 993 {'cell_type':'heading',level:level}
991 994 );
992 995 }
993 996 };
994 997
995 998
996 999 // Cut/Copy/Paste
997 1000
998 1001 /**
999 1002 * Enable UI elements for pasting cells.
1000 1003 *
1001 1004 * @method enable_paste
1002 1005 */
1003 1006 Notebook.prototype.enable_paste = function () {
1004 1007 var that = this;
1005 1008 if (!this.paste_enabled) {
1006 1009 $('#paste_cell_replace').removeClass('disabled')
1007 1010 .on('click', function () {that.paste_cell_replace();});
1008 1011 $('#paste_cell_above').removeClass('disabled')
1009 1012 .on('click', function () {that.paste_cell_above();});
1010 1013 $('#paste_cell_below').removeClass('disabled')
1011 1014 .on('click', function () {that.paste_cell_below();});
1012 1015 this.paste_enabled = true;
1013 1016 }
1014 1017 };
1015 1018
1016 1019 /**
1017 1020 * Disable UI elements for pasting cells.
1018 1021 *
1019 1022 * @method disable_paste
1020 1023 */
1021 1024 Notebook.prototype.disable_paste = function () {
1022 1025 if (this.paste_enabled) {
1023 1026 $('#paste_cell_replace').addClass('disabled').off('click');
1024 1027 $('#paste_cell_above').addClass('disabled').off('click');
1025 1028 $('#paste_cell_below').addClass('disabled').off('click');
1026 1029 this.paste_enabled = false;
1027 1030 }
1028 1031 };
1029 1032
1030 1033 /**
1031 1034 * Cut a cell.
1032 1035 *
1033 1036 * @method cut_cell
1034 1037 */
1035 1038 Notebook.prototype.cut_cell = function () {
1036 1039 this.copy_cell();
1037 1040 this.delete_cell();
1038 1041 };
1039 1042
1040 1043 /**
1041 1044 * Copy a cell.
1042 1045 *
1043 1046 * @method copy_cell
1044 1047 */
1045 1048 Notebook.prototype.copy_cell = function () {
1046 1049 var cell = this.get_selected_cell();
1047 1050 this.clipboard = cell.toJSON();
1048 1051 this.enable_paste();
1049 1052 };
1050 1053
1051 1054 /**
1052 1055 * Replace the selected cell with a cell in the clipboard.
1053 1056 *
1054 1057 * @method paste_cell_replace
1055 1058 */
1056 1059 Notebook.prototype.paste_cell_replace = function () {
1057 1060 if (this.clipboard !== null && this.paste_enabled) {
1058 1061 var cell_data = this.clipboard;
1059 1062 var new_cell = this.insert_cell_above(cell_data.cell_type);
1060 1063 new_cell.fromJSON(cell_data);
1061 1064 var old_cell = this.get_next_cell(new_cell);
1062 1065 this.delete_cell(this.find_cell_index(old_cell));
1063 1066 this.select(this.find_cell_index(new_cell));
1064 1067 }
1065 1068 };
1066 1069
1067 1070 /**
1068 1071 * Paste a cell from the clipboard above the selected cell.
1069 1072 *
1070 1073 * @method paste_cell_above
1071 1074 */
1072 1075 Notebook.prototype.paste_cell_above = function () {
1073 1076 if (this.clipboard !== null && this.paste_enabled) {
1074 1077 var cell_data = this.clipboard;
1075 1078 var new_cell = this.insert_cell_above(cell_data.cell_type);
1076 1079 new_cell.fromJSON(cell_data);
1077 1080 new_cell.focus_cell();
1078 1081 }
1079 1082 };
1080 1083
1081 1084 /**
1082 1085 * Paste a cell from the clipboard below the selected cell.
1083 1086 *
1084 1087 * @method paste_cell_below
1085 1088 */
1086 1089 Notebook.prototype.paste_cell_below = function () {
1087 1090 if (this.clipboard !== null && this.paste_enabled) {
1088 1091 var cell_data = this.clipboard;
1089 1092 var new_cell = this.insert_cell_below(cell_data.cell_type);
1090 1093 new_cell.fromJSON(cell_data);
1091 1094 new_cell.focus_cell();
1092 1095 }
1093 1096 };
1094 1097
1095 1098 // Split/merge
1096 1099
1097 1100 /**
1098 1101 * Split the selected cell into two, at the cursor.
1099 1102 *
1100 1103 * @method split_cell
1101 1104 */
1102 1105 Notebook.prototype.split_cell = function () {
1103 1106 var mdc = IPython.MarkdownCell;
1104 1107 var rc = IPython.RawCell;
1105 1108 var cell = this.get_selected_cell();
1106 1109 if (cell.is_splittable()) {
1107 1110 var texta = cell.get_pre_cursor();
1108 1111 var textb = cell.get_post_cursor();
1109 1112 if (cell instanceof IPython.CodeCell) {
1110 1113 // In this case the operations keep the notebook in its existing mode
1111 1114 // so we don't need to do any post-op mode changes.
1112 1115 cell.set_text(textb);
1113 1116 var new_cell = this.insert_cell_above('code');
1114 1117 new_cell.set_text(texta);
1115 1118 } else if ((cell instanceof mdc && !cell.rendered) || (cell instanceof rc)) {
1116 1119 // We know cell is !rendered so we can use set_text.
1117 1120 cell.set_text(textb);
1118 1121 var new_cell = this.insert_cell_above(cell.cell_type);
1119 1122 // Unrender the new cell so we can call set_text.
1120 1123 new_cell.unrender();
1121 1124 new_cell.set_text(texta);
1122 1125 }
1123 1126 }
1124 1127 };
1125 1128
1126 1129 /**
1127 1130 * Combine the selected cell into the cell above it.
1128 1131 *
1129 1132 * @method merge_cell_above
1130 1133 */
1131 1134 Notebook.prototype.merge_cell_above = function () {
1132 1135 var mdc = IPython.MarkdownCell;
1133 1136 var rc = IPython.RawCell;
1134 1137 var index = this.get_selected_index();
1135 1138 var cell = this.get_cell(index);
1136 1139 var render = cell.rendered;
1137 1140 if (!cell.is_mergeable()) {
1138 1141 return;
1139 1142 }
1140 1143 if (index > 0) {
1141 1144 var upper_cell = this.get_cell(index-1);
1142 1145 if (!upper_cell.is_mergeable()) {
1143 1146 return;
1144 1147 }
1145 1148 var upper_text = upper_cell.get_text();
1146 1149 var text = cell.get_text();
1147 1150 if (cell instanceof IPython.CodeCell) {
1148 1151 cell.set_text(upper_text+'\n'+text);
1149 1152 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1150 1153 cell.unrender(); // Must unrender before we set_text.
1151 1154 cell.set_text(upper_text+'\n\n'+text);
1152 1155 if (render) {
1153 1156 // The rendered state of the final cell should match
1154 1157 // that of the original selected cell;
1155 1158 cell.render();
1156 1159 }
1157 1160 }
1158 1161 this.delete_cell(index-1);
1159 1162 this.select(this.find_cell_index(cell));
1160 1163 }
1161 1164 };
1162 1165
1163 1166 /**
1164 1167 * Combine the selected cell into the cell below it.
1165 1168 *
1166 1169 * @method merge_cell_below
1167 1170 */
1168 1171 Notebook.prototype.merge_cell_below = function () {
1169 1172 var mdc = IPython.MarkdownCell;
1170 1173 var rc = IPython.RawCell;
1171 1174 var index = this.get_selected_index();
1172 1175 var cell = this.get_cell(index);
1173 1176 var render = cell.rendered;
1174 1177 if (!cell.is_mergeable()) {
1175 1178 return;
1176 1179 }
1177 1180 if (index < this.ncells()-1) {
1178 1181 var lower_cell = this.get_cell(index+1);
1179 1182 if (!lower_cell.is_mergeable()) {
1180 1183 return;
1181 1184 }
1182 1185 var lower_text = lower_cell.get_text();
1183 1186 var text = cell.get_text();
1184 1187 if (cell instanceof IPython.CodeCell) {
1185 1188 cell.set_text(text+'\n'+lower_text);
1186 1189 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1187 1190 cell.unrender(); // Must unrender before we set_text.
1188 1191 cell.set_text(text+'\n\n'+lower_text);
1189 1192 if (render) {
1190 1193 // The rendered state of the final cell should match
1191 1194 // that of the original selected cell;
1192 1195 cell.render();
1193 1196 }
1194 1197 }
1195 1198 this.delete_cell(index+1);
1196 1199 this.select(this.find_cell_index(cell));
1197 1200 }
1198 1201 };
1199 1202
1200 1203
1201 1204 // Cell collapsing and output clearing
1202 1205
1203 1206 /**
1204 1207 * Hide a cell's output.
1205 1208 *
1206 1209 * @method collapse_output
1207 1210 * @param {Number} index A cell's numeric index
1208 1211 */
1209 1212 Notebook.prototype.collapse_output = function (index) {
1210 1213 var i = this.index_or_selected(index);
1211 1214 var cell = this.get_cell(i);
1212 1215 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1213 1216 cell.collapse_output();
1214 1217 this.set_dirty(true);
1215 1218 }
1216 1219 };
1217 1220
1218 1221 /**
1219 1222 * Hide each code cell's output area.
1220 1223 *
1221 1224 * @method collapse_all_output
1222 1225 */
1223 1226 Notebook.prototype.collapse_all_output = function () {
1224 1227 $.map(this.get_cells(), function (cell, i) {
1225 1228 if (cell instanceof IPython.CodeCell) {
1226 1229 cell.collapse_output();
1227 1230 }
1228 1231 });
1229 1232 // this should not be set if the `collapse` key is removed from nbformat
1230 1233 this.set_dirty(true);
1231 1234 };
1232 1235
1233 1236 /**
1234 1237 * Show a cell's output.
1235 1238 *
1236 1239 * @method expand_output
1237 1240 * @param {Number} index A cell's numeric index
1238 1241 */
1239 1242 Notebook.prototype.expand_output = function (index) {
1240 1243 var i = this.index_or_selected(index);
1241 1244 var cell = this.get_cell(i);
1242 1245 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1243 1246 cell.expand_output();
1244 1247 this.set_dirty(true);
1245 1248 }
1246 1249 };
1247 1250
1248 1251 /**
1249 1252 * Expand each code cell's output area, and remove scrollbars.
1250 1253 *
1251 1254 * @method expand_all_output
1252 1255 */
1253 1256 Notebook.prototype.expand_all_output = function () {
1254 1257 $.map(this.get_cells(), function (cell, i) {
1255 1258 if (cell instanceof IPython.CodeCell) {
1256 1259 cell.expand_output();
1257 1260 }
1258 1261 });
1259 1262 // this should not be set if the `collapse` key is removed from nbformat
1260 1263 this.set_dirty(true);
1261 1264 };
1262 1265
1263 1266 /**
1264 1267 * Clear the selected CodeCell's output area.
1265 1268 *
1266 1269 * @method clear_output
1267 1270 * @param {Number} index A cell's numeric index
1268 1271 */
1269 1272 Notebook.prototype.clear_output = function (index) {
1270 1273 var i = this.index_or_selected(index);
1271 1274 var cell = this.get_cell(i);
1272 1275 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1273 1276 cell.clear_output();
1274 1277 this.set_dirty(true);
1275 1278 }
1276 1279 };
1277 1280
1278 1281 /**
1279 1282 * Clear each code cell's output area.
1280 1283 *
1281 1284 * @method clear_all_output
1282 1285 */
1283 1286 Notebook.prototype.clear_all_output = function () {
1284 1287 $.map(this.get_cells(), function (cell, i) {
1285 1288 if (cell instanceof IPython.CodeCell) {
1286 1289 cell.clear_output();
1287 1290 }
1288 1291 });
1289 1292 this.set_dirty(true);
1290 1293 };
1291 1294
1292 1295 /**
1293 1296 * Scroll the selected CodeCell's output area.
1294 1297 *
1295 1298 * @method scroll_output
1296 1299 * @param {Number} index A cell's numeric index
1297 1300 */
1298 1301 Notebook.prototype.scroll_output = function (index) {
1299 1302 var i = this.index_or_selected(index);
1300 1303 var cell = this.get_cell(i);
1301 1304 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1302 1305 cell.scroll_output();
1303 1306 this.set_dirty(true);
1304 1307 }
1305 1308 };
1306 1309
1307 1310 /**
1308 1311 * Expand each code cell's output area, and add a scrollbar for long output.
1309 1312 *
1310 1313 * @method scroll_all_output
1311 1314 */
1312 1315 Notebook.prototype.scroll_all_output = function () {
1313 1316 $.map(this.get_cells(), function (cell, i) {
1314 1317 if (cell instanceof IPython.CodeCell) {
1315 1318 cell.scroll_output();
1316 1319 }
1317 1320 });
1318 1321 // this should not be set if the `collapse` key is removed from nbformat
1319 1322 this.set_dirty(true);
1320 1323 };
1321 1324
1322 1325 /** Toggle whether a cell's output is collapsed or expanded.
1323 1326 *
1324 1327 * @method toggle_output
1325 1328 * @param {Number} index A cell's numeric index
1326 1329 */
1327 1330 Notebook.prototype.toggle_output = function (index) {
1328 1331 var i = this.index_or_selected(index);
1329 1332 var cell = this.get_cell(i);
1330 1333 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1331 1334 cell.toggle_output();
1332 1335 this.set_dirty(true);
1333 1336 }
1334 1337 };
1335 1338
1336 1339 /**
1337 1340 * Hide/show the output of all cells.
1338 1341 *
1339 1342 * @method toggle_all_output
1340 1343 */
1341 1344 Notebook.prototype.toggle_all_output = function () {
1342 1345 $.map(this.get_cells(), function (cell, i) {
1343 1346 if (cell instanceof IPython.CodeCell) {
1344 1347 cell.toggle_output();
1345 1348 }
1346 1349 });
1347 1350 // this should not be set if the `collapse` key is removed from nbformat
1348 1351 this.set_dirty(true);
1349 1352 };
1350 1353
1351 1354 /**
1352 1355 * Toggle a scrollbar for long cell outputs.
1353 1356 *
1354 1357 * @method toggle_output_scroll
1355 1358 * @param {Number} index A cell's numeric index
1356 1359 */
1357 1360 Notebook.prototype.toggle_output_scroll = function (index) {
1358 1361 var i = this.index_or_selected(index);
1359 1362 var cell = this.get_cell(i);
1360 1363 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1361 1364 cell.toggle_output_scroll();
1362 1365 this.set_dirty(true);
1363 1366 }
1364 1367 };
1365 1368
1366 1369 /**
1367 1370 * Toggle the scrolling of long output on all cells.
1368 1371 *
1369 1372 * @method toggle_all_output_scrolling
1370 1373 */
1371 1374 Notebook.prototype.toggle_all_output_scroll = function () {
1372 1375 $.map(this.get_cells(), function (cell, i) {
1373 1376 if (cell instanceof IPython.CodeCell) {
1374 1377 cell.toggle_output_scroll();
1375 1378 }
1376 1379 });
1377 1380 // this should not be set if the `collapse` key is removed from nbformat
1378 1381 this.set_dirty(true);
1379 1382 };
1380 1383
1381 1384 // Other cell functions: line numbers, ...
1382 1385
1383 1386 /**
1384 1387 * Toggle line numbers in the selected cell's input area.
1385 1388 *
1386 1389 * @method cell_toggle_line_numbers
1387 1390 */
1388 1391 Notebook.prototype.cell_toggle_line_numbers = function() {
1389 1392 this.get_selected_cell().toggle_line_numbers();
1390 1393 };
1391 1394
1392 1395 // Session related things
1393 1396
1394 1397 /**
1395 1398 * Start a new session and set it on each code cell.
1396 1399 *
1397 1400 * @method start_session
1398 1401 */
1399 1402 Notebook.prototype.start_session = function () {
1400 1403 this.session = new IPython.Session(this, this.options);
1401 1404 this.session.start($.proxy(this._session_started, this));
1402 1405 };
1403 1406
1404 1407
1405 1408 /**
1406 1409 * Once a session is started, link the code cells to the kernel and pass the
1407 1410 * comm manager to the widget manager
1408 1411 *
1409 1412 */
1410 1413 Notebook.prototype._session_started = function(){
1411 1414 this.kernel = this.session.kernel;
1412 1415 var ncells = this.ncells();
1413 1416 for (var i=0; i<ncells; i++) {
1414 1417 var cell = this.get_cell(i);
1415 1418 if (cell instanceof IPython.CodeCell) {
1416 1419 cell.set_kernel(this.session.kernel);
1417 1420 }
1418 1421 }
1419 1422 };
1420 1423
1421 1424 /**
1422 1425 * Prompt the user to restart the IPython kernel.
1423 1426 *
1424 1427 * @method restart_kernel
1425 1428 */
1426 1429 Notebook.prototype.restart_kernel = function () {
1427 1430 var that = this;
1428 1431 IPython.dialog.modal({
1429 1432 title : "Restart kernel or continue running?",
1430 1433 body : $("<p/>").text(
1431 1434 'Do you want to restart the current kernel? You will lose all variables defined in it.'
1432 1435 ),
1433 1436 buttons : {
1434 1437 "Continue running" : {},
1435 1438 "Restart" : {
1436 1439 "class" : "btn-danger",
1437 1440 "click" : function() {
1438 1441 that.session.restart_kernel();
1439 1442 }
1440 1443 }
1441 1444 }
1442 1445 });
1443 1446 };
1444 1447
1445 1448 /**
1446 1449 * Execute or render cell outputs and go into command mode.
1447 1450 *
1448 1451 * @method execute_cell
1449 1452 */
1450 1453 Notebook.prototype.execute_cell = function () {
1451 1454 // mode = shift, ctrl, alt
1452 1455 var cell = this.get_selected_cell();
1453 1456 var cell_index = this.find_cell_index(cell);
1454 1457
1455 1458 cell.execute();
1456 1459 this.command_mode();
1457 1460 this.set_dirty(true);
1458 1461 };
1459 1462
1460 1463 /**
1461 1464 * Execute or render cell outputs and insert a new cell below.
1462 1465 *
1463 1466 * @method execute_cell_and_insert_below
1464 1467 */
1465 1468 Notebook.prototype.execute_cell_and_insert_below = function () {
1466 1469 var cell = this.get_selected_cell();
1467 1470 var cell_index = this.find_cell_index(cell);
1468 1471
1469 1472 cell.execute();
1470 1473
1471 1474 // If we are at the end always insert a new cell and return
1472 1475 if (cell_index === (this.ncells()-1)) {
1473 1476 this.command_mode();
1474 1477 this.insert_cell_below('code');
1475 1478 this.select(cell_index+1);
1476 1479 this.edit_mode();
1477 1480 this.scroll_to_bottom();
1478 1481 this.set_dirty(true);
1479 1482 return;
1480 1483 }
1481 1484
1482 1485 this.command_mode();
1483 1486 this.insert_cell_below('code');
1484 1487 this.select(cell_index+1);
1485 1488 this.edit_mode();
1486 1489 this.set_dirty(true);
1487 1490 };
1488 1491
1489 1492 /**
1490 1493 * Execute or render cell outputs and select the next cell.
1491 1494 *
1492 1495 * @method execute_cell_and_select_below
1493 1496 */
1494 1497 Notebook.prototype.execute_cell_and_select_below = function () {
1495 1498
1496 1499 var cell = this.get_selected_cell();
1497 1500 var cell_index = this.find_cell_index(cell);
1498 1501
1499 1502 cell.execute();
1500 1503
1501 1504 // If we are at the end always insert a new cell and return
1502 1505 if (cell_index === (this.ncells()-1)) {
1503 1506 this.command_mode();
1504 1507 this.insert_cell_below('code');
1505 1508 this.select(cell_index+1);
1506 1509 this.edit_mode();
1507 1510 this.scroll_to_bottom();
1508 1511 this.set_dirty(true);
1509 1512 return;
1510 1513 }
1511 1514
1512 1515 this.command_mode();
1513 1516 this.select(cell_index+1);
1514 1517 this.focus_cell();
1515 1518 this.set_dirty(true);
1516 1519 };
1517 1520
1518 1521 /**
1519 1522 * Execute all cells below the selected cell.
1520 1523 *
1521 1524 * @method execute_cells_below
1522 1525 */
1523 1526 Notebook.prototype.execute_cells_below = function () {
1524 1527 this.execute_cell_range(this.get_selected_index(), this.ncells());
1525 1528 this.scroll_to_bottom();
1526 1529 };
1527 1530
1528 1531 /**
1529 1532 * Execute all cells above the selected cell.
1530 1533 *
1531 1534 * @method execute_cells_above
1532 1535 */
1533 1536 Notebook.prototype.execute_cells_above = function () {
1534 1537 this.execute_cell_range(0, this.get_selected_index());
1535 1538 };
1536 1539
1537 1540 /**
1538 1541 * Execute all cells.
1539 1542 *
1540 1543 * @method execute_all_cells
1541 1544 */
1542 1545 Notebook.prototype.execute_all_cells = function () {
1543 1546 this.execute_cell_range(0, this.ncells());
1544 1547 this.scroll_to_bottom();
1545 1548 };
1546 1549
1547 1550 /**
1548 1551 * Execute a contiguous range of cells.
1549 1552 *
1550 1553 * @method execute_cell_range
1551 1554 * @param {Number} start Index of the first cell to execute (inclusive)
1552 1555 * @param {Number} end Index of the last cell to execute (exclusive)
1553 1556 */
1554 1557 Notebook.prototype.execute_cell_range = function (start, end) {
1555 1558 this.command_mode();
1556 1559 for (var i=start; i<end; i++) {
1557 1560 this.select(i);
1558 1561 this.execute_cell();
1559 1562 }
1560 1563 };
1561 1564
1562 1565 // Persistance and loading
1563 1566
1564 1567 /**
1565 1568 * Getter method for this notebook's name.
1566 1569 *
1567 1570 * @method get_notebook_name
1568 1571 * @return {String} This notebook's name (excluding file extension)
1569 1572 */
1570 1573 Notebook.prototype.get_notebook_name = function () {
1571 1574 var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
1572 1575 return nbname;
1573 1576 };
1574 1577
1575 1578 /**
1576 1579 * Setter method for this notebook's name.
1577 1580 *
1578 1581 * @method set_notebook_name
1579 1582 * @param {String} name A new name for this notebook
1580 1583 */
1581 1584 Notebook.prototype.set_notebook_name = function (name) {
1582 1585 this.notebook_name = name;
1583 1586 };
1584 1587
1585 1588 /**
1586 1589 * Check that a notebook's name is valid.
1587 1590 *
1588 1591 * @method test_notebook_name
1589 1592 * @param {String} nbname A name for this notebook
1590 1593 * @return {Boolean} True if the name is valid, false if invalid
1591 1594 */
1592 1595 Notebook.prototype.test_notebook_name = function (nbname) {
1593 1596 nbname = nbname || '';
1594 1597 if (nbname.length>0 && !this.notebook_name_blacklist_re.test(nbname)) {
1595 1598 return true;
1596 1599 } else {
1597 1600 return false;
1598 1601 }
1599 1602 };
1600 1603
1601 1604 /**
1602 1605 * Load a notebook from JSON (.ipynb).
1603 1606 *
1604 1607 * This currently handles one worksheet: others are deleted.
1605 1608 *
1606 1609 * @method fromJSON
1607 1610 * @param {Object} data JSON representation of a notebook
1608 1611 */
1609 1612 Notebook.prototype.fromJSON = function (data) {
1610 1613 var content = data.content;
1611 1614 var ncells = this.ncells();
1612 1615 var i;
1613 1616 for (i=0; i<ncells; i++) {
1614 1617 // Always delete cell 0 as they get renumbered as they are deleted.
1615 1618 this.delete_cell(0);
1616 1619 }
1617 1620 // Save the metadata and name.
1618 1621 this.metadata = content.metadata;
1619 1622 this.notebook_name = data.name;
1620 1623 var trusted = true;
1621 1624 // Only handle 1 worksheet for now.
1622 1625 var worksheet = content.worksheets[0];
1623 1626 if (worksheet !== undefined) {
1624 1627 if (worksheet.metadata) {
1625 1628 this.worksheet_metadata = worksheet.metadata;
1626 1629 }
1627 1630 var new_cells = worksheet.cells;
1628 1631 ncells = new_cells.length;
1629 1632 var cell_data = null;
1630 1633 var new_cell = null;
1631 1634 for (i=0; i<ncells; i++) {
1632 1635 cell_data = new_cells[i];
1633 1636 // VERSIONHACK: plaintext -> raw
1634 1637 // handle never-released plaintext name for raw cells
1635 1638 if (cell_data.cell_type === 'plaintext'){
1636 1639 cell_data.cell_type = 'raw';
1637 1640 }
1638 1641
1639 1642 new_cell = this.insert_cell_at_index(cell_data.cell_type, i);
1640 1643 new_cell.fromJSON(cell_data);
1641 1644 if (new_cell.cell_type == 'code' && !new_cell.output_area.trusted) {
1642 1645 trusted = false;
1643 1646 }
1644 1647 }
1645 1648 }
1646 1649 if (trusted != this.trusted) {
1647 1650 this.trusted = trusted;
1648 1651 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1649 1652 }
1650 1653 if (content.worksheets.length > 1) {
1651 1654 IPython.dialog.modal({
1652 1655 title : "Multiple worksheets",
1653 1656 body : "This notebook has " + data.worksheets.length + " worksheets, " +
1654 1657 "but this version of IPython can only handle the first. " +
1655 1658 "If you save this notebook, worksheets after the first will be lost.",
1656 1659 buttons : {
1657 1660 OK : {
1658 1661 class : "btn-danger"
1659 1662 }
1660 1663 }
1661 1664 });
1662 1665 }
1663 1666 };
1664 1667
1665 1668 /**
1666 1669 * Dump this notebook into a JSON-friendly object.
1667 1670 *
1668 1671 * @method toJSON
1669 1672 * @return {Object} A JSON-friendly representation of this notebook.
1670 1673 */
1671 1674 Notebook.prototype.toJSON = function () {
1672 1675 var cells = this.get_cells();
1673 1676 var ncells = cells.length;
1674 1677 var cell_array = new Array(ncells);
1675 1678 var trusted = true;
1676 1679 for (var i=0; i<ncells; i++) {
1677 1680 var cell = cells[i];
1678 1681 if (cell.cell_type == 'code' && !cell.output_area.trusted) {
1679 1682 trusted = false;
1680 1683 }
1681 1684 cell_array[i] = cell.toJSON();
1682 1685 }
1683 1686 var data = {
1684 1687 // Only handle 1 worksheet for now.
1685 1688 worksheets : [{
1686 1689 cells: cell_array,
1687 1690 metadata: this.worksheet_metadata
1688 1691 }],
1689 1692 metadata : this.metadata
1690 1693 };
1691 1694 if (trusted != this.trusted) {
1692 1695 this.trusted = trusted;
1693 1696 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1694 1697 }
1695 1698 return data;
1696 1699 };
1697 1700
1698 1701 /**
1699 1702 * Start an autosave timer, for periodically saving the notebook.
1700 1703 *
1701 1704 * @method set_autosave_interval
1702 1705 * @param {Integer} interval the autosave interval in milliseconds
1703 1706 */
1704 1707 Notebook.prototype.set_autosave_interval = function (interval) {
1705 1708 var that = this;
1706 1709 // clear previous interval, so we don't get simultaneous timers
1707 1710 if (this.autosave_timer) {
1708 1711 clearInterval(this.autosave_timer);
1709 1712 }
1710 1713
1711 1714 this.autosave_interval = this.minimum_autosave_interval = interval;
1712 1715 if (interval) {
1713 1716 this.autosave_timer = setInterval(function() {
1714 1717 if (that.dirty) {
1715 1718 that.save_notebook();
1716 1719 }
1717 1720 }, interval);
1718 1721 $([IPython.events]).trigger("autosave_enabled.Notebook", interval);
1719 1722 } else {
1720 1723 this.autosave_timer = null;
1721 1724 $([IPython.events]).trigger("autosave_disabled.Notebook");
1722 1725 }
1723 1726 };
1724 1727
1725 1728 /**
1726 * Save this notebook on the server.
1729 * Save this notebook on the server. This becomes a notebook instance's
1730 * .save_notebook method *after* the entire notebook has been loaded.
1727 1731 *
1728 1732 * @method save_notebook
1729 1733 */
1730 1734 Notebook.prototype.save_notebook = function (extra_settings) {
1731 1735 // Create a JSON model to be sent to the server.
1732 1736 var model = {};
1733 1737 model.name = this.notebook_name;
1734 1738 model.path = this.notebook_path;
1735 1739 model.content = this.toJSON();
1736 1740 model.content.nbformat = this.nbformat;
1737 1741 model.content.nbformat_minor = this.nbformat_minor;
1738 1742 // time the ajax call for autosave tuning purposes.
1739 1743 var start = new Date().getTime();
1740 1744 // We do the call with settings so we can set cache to false.
1741 1745 var settings = {
1742 1746 processData : false,
1743 1747 cache : false,
1744 1748 type : "PUT",
1745 1749 data : JSON.stringify(model),
1746 1750 headers : {'Content-Type': 'application/json'},
1747 1751 success : $.proxy(this.save_notebook_success, this, start),
1748 1752 error : $.proxy(this.save_notebook_error, this)
1749 1753 };
1750 1754 if (extra_settings) {
1751 1755 for (var key in extra_settings) {
1752 1756 settings[key] = extra_settings[key];
1753 1757 }
1754 1758 }
1755 1759 $([IPython.events]).trigger('notebook_saving.Notebook');
1756 1760 var url = utils.url_join_encode(
1757 1761 this.base_url,
1758 1762 'api/notebooks',
1759 1763 this.notebook_path,
1760 1764 this.notebook_name
1761 1765 );
1762 1766 $.ajax(url, settings);
1763 1767 };
1764 1768
1765 1769 /**
1766 1770 * Success callback for saving a notebook.
1767 1771 *
1768 1772 * @method save_notebook_success
1769 1773 * @param {Integer} start the time when the save request started
1770 1774 * @param {Object} data JSON representation of a notebook
1771 1775 * @param {String} status Description of response status
1772 1776 * @param {jqXHR} xhr jQuery Ajax object
1773 1777 */
1774 1778 Notebook.prototype.save_notebook_success = function (start, data, status, xhr) {
1775 1779 this.set_dirty(false);
1776 1780 $([IPython.events]).trigger('notebook_saved.Notebook');
1777 1781 this._update_autosave_interval(start);
1778 1782 if (this._checkpoint_after_save) {
1779 1783 this.create_checkpoint();
1780 1784 this._checkpoint_after_save = false;
1781 1785 }
1782 1786 };
1783 1787
1784 1788 /**
1785 1789 * update the autosave interval based on how long the last save took
1786 1790 *
1787 1791 * @method _update_autosave_interval
1788 1792 * @param {Integer} timestamp when the save request started
1789 1793 */
1790 1794 Notebook.prototype._update_autosave_interval = function (start) {
1791 1795 var duration = (new Date().getTime() - start);
1792 1796 if (this.autosave_interval) {
1793 1797 // new save interval: higher of 10x save duration or parameter (default 30 seconds)
1794 1798 var interval = Math.max(10 * duration, this.minimum_autosave_interval);
1795 1799 // round to 10 seconds, otherwise we will be setting a new interval too often
1796 1800 interval = 10000 * Math.round(interval / 10000);
1797 1801 // set new interval, if it's changed
1798 1802 if (interval != this.autosave_interval) {
1799 1803 this.set_autosave_interval(interval);
1800 1804 }
1801 1805 }
1802 1806 };
1803 1807
1804 1808 /**
1805 1809 * Failure callback for saving a notebook.
1806 1810 *
1807 1811 * @method save_notebook_error
1808 1812 * @param {jqXHR} xhr jQuery Ajax object
1809 1813 * @param {String} status Description of response status
1810 1814 * @param {String} error HTTP error message
1811 1815 */
1812 1816 Notebook.prototype.save_notebook_error = function (xhr, status, error) {
1813 1817 $([IPython.events]).trigger('notebook_save_failed.Notebook', [xhr, status, error]);
1814 1818 };
1815 1819
1816 1820 /**
1817 1821 * Explicitly trust the output of this notebook.
1818 1822 *
1819 1823 * @method trust_notebook
1820 1824 */
1821 1825 Notebook.prototype.trust_notebook = function (extra_settings) {
1822 1826 var body = $("<div>").append($("<p>")
1823 1827 .text("A trusted IPython notebook may execute hidden malicious code ")
1824 1828 .append($("<strong>")
1825 1829 .append(
1826 1830 $("<em>").text("when you open it")
1827 1831 )
1828 1832 ).append(".").append(
1829 1833 " Selecting trust will immediately reload this notebook in a trusted state."
1830 1834 ).append(
1831 1835 " For more information, see the "
1832 1836 ).append($("<a>").attr("href", "http://ipython.org/security.html")
1833 1837 .text("IPython security documentation")
1834 1838 ).append(".")
1835 1839 );
1836 1840
1837 1841 var nb = this;
1838 1842 IPython.dialog.modal({
1839 1843 title: "Trust this notebook?",
1840 1844 body: body,
1841 1845
1842 1846 buttons: {
1843 1847 Cancel : {},
1844 1848 Trust : {
1845 1849 class : "btn-danger",
1846 1850 click : function () {
1847 1851 var cells = nb.get_cells();
1848 1852 for (var i = 0; i < cells.length; i++) {
1849 1853 var cell = cells[i];
1850 1854 if (cell.cell_type == 'code') {
1851 1855 cell.output_area.trusted = true;
1852 1856 }
1853 1857 }
1854 1858 $([IPython.events]).on('notebook_saved.Notebook', function () {
1855 1859 window.location.reload();
1856 1860 });
1857 1861 nb.save_notebook();
1858 1862 }
1859 1863 }
1860 1864 }
1861 1865 });
1862 1866 };
1863 1867
1864 1868 Notebook.prototype.new_notebook = function(){
1865 1869 var path = this.notebook_path;
1866 1870 var base_url = this.base_url;
1867 1871 var settings = {
1868 1872 processData : false,
1869 1873 cache : false,
1870 1874 type : "POST",
1871 1875 dataType : "json",
1872 1876 async : false,
1873 1877 success : function (data, status, xhr){
1874 1878 var notebook_name = data.name;
1875 1879 window.open(
1876 1880 utils.url_join_encode(
1877 1881 base_url,
1878 1882 'notebooks',
1879 1883 path,
1880 1884 notebook_name
1881 1885 ),
1882 1886 '_blank'
1883 1887 );
1884 1888 }
1885 1889 };
1886 1890 var url = utils.url_join_encode(
1887 1891 base_url,
1888 1892 'api/notebooks',
1889 1893 path
1890 1894 );
1891 1895 $.ajax(url,settings);
1892 1896 };
1893 1897
1894 1898
1895 1899 Notebook.prototype.copy_notebook = function(){
1896 1900 var path = this.notebook_path;
1897 1901 var base_url = this.base_url;
1898 1902 var settings = {
1899 1903 processData : false,
1900 1904 cache : false,
1901 1905 type : "POST",
1902 1906 dataType : "json",
1903 1907 data : JSON.stringify({copy_from : this.notebook_name}),
1904 1908 async : false,
1905 1909 success : function (data, status, xhr) {
1906 1910 window.open(utils.url_join_encode(
1907 1911 base_url,
1908 1912 'notebooks',
1909 1913 data.path,
1910 1914 data.name
1911 1915 ), '_blank');
1912 1916 }
1913 1917 };
1914 1918 var url = utils.url_join_encode(
1915 1919 base_url,
1916 1920 'api/notebooks',
1917 1921 path
1918 1922 );
1919 1923 $.ajax(url,settings);
1920 1924 };
1921 1925
1922 1926 Notebook.prototype.rename = function (nbname) {
1923 1927 var that = this;
1924 1928 if (!nbname.match(/\.ipynb$/)) {
1925 1929 nbname = nbname + ".ipynb";
1926 1930 }
1927 1931 var data = {name: nbname};
1928 1932 var settings = {
1929 1933 processData : false,
1930 1934 cache : false,
1931 1935 type : "PATCH",
1932 1936 data : JSON.stringify(data),
1933 1937 dataType: "json",
1934 1938 headers : {'Content-Type': 'application/json'},
1935 1939 success : $.proxy(that.rename_success, this),
1936 1940 error : $.proxy(that.rename_error, this)
1937 1941 };
1938 1942 $([IPython.events]).trigger('rename_notebook.Notebook', data);
1939 1943 var url = utils.url_join_encode(
1940 1944 this.base_url,
1941 1945 'api/notebooks',
1942 1946 this.notebook_path,
1943 1947 this.notebook_name
1944 1948 );
1945 1949 $.ajax(url, settings);
1946 1950 };
1947 1951
1948 1952 Notebook.prototype.delete = function () {
1949 1953 var that = this;
1950 1954 var settings = {
1951 1955 processData : false,
1952 1956 cache : false,
1953 1957 type : "DELETE",
1954 1958 dataType: "json",
1955 1959 };
1956 1960 var url = utils.url_join_encode(
1957 1961 this.base_url,
1958 1962 'api/notebooks',
1959 1963 this.notebook_path,
1960 1964 this.notebook_name
1961 1965 );
1962 1966 $.ajax(url, settings);
1963 1967 };
1964 1968
1965 1969
1966 1970 Notebook.prototype.rename_success = function (json, status, xhr) {
1967 1971 var name = this.notebook_name = json.name;
1968 1972 var path = json.path;
1969 1973 this.session.rename_notebook(name, path);
1970 1974 $([IPython.events]).trigger('notebook_renamed.Notebook', json);
1971 1975 };
1972 1976
1973 1977 Notebook.prototype.rename_error = function (xhr, status, error) {
1974 1978 var that = this;
1975 1979 var dialog = $('<div/>').append(
1976 1980 $("<p/>").addClass("rename-message")
1977 1981 .text('This notebook name already exists.')
1978 1982 );
1979 1983 $([IPython.events]).trigger('notebook_rename_failed.Notebook', [xhr, status, error]);
1980 1984 IPython.dialog.modal({
1981 1985 title: "Notebook Rename Error!",
1982 1986 body: dialog,
1983 1987 buttons : {
1984 1988 "Cancel": {},
1985 1989 "OK": {
1986 1990 class: "btn-primary",
1987 1991 click: function () {
1988 1992 IPython.save_widget.rename_notebook();
1989 1993 }}
1990 1994 },
1991 1995 open : function (event, ui) {
1992 1996 var that = $(this);
1993 1997 // Upon ENTER, click the OK button.
1994 1998 that.find('input[type="text"]').keydown(function (event, ui) {
1995 1999 if (event.which === IPython.keyboard.keycodes.enter) {
1996 2000 that.find('.btn-primary').first().click();
1997 2001 }
1998 2002 });
1999 2003 that.find('input[type="text"]').focus();
2000 2004 }
2001 2005 });
2002 2006 };
2003 2007
2004 2008 /**
2005 2009 * Request a notebook's data from the server.
2006 2010 *
2007 2011 * @method load_notebook
2008 2012 * @param {String} notebook_name and path A notebook to load
2009 2013 */
2010 2014 Notebook.prototype.load_notebook = function (notebook_name, notebook_path) {
2011 2015 var that = this;
2012 2016 this.notebook_name = notebook_name;
2013 2017 this.notebook_path = notebook_path;
2014 2018 // We do the call with settings so we can set cache to false.
2015 2019 var settings = {
2016 2020 processData : false,
2017 2021 cache : false,
2018 2022 type : "GET",
2019 2023 dataType : "json",
2020 2024 success : $.proxy(this.load_notebook_success,this),
2021 2025 error : $.proxy(this.load_notebook_error,this),
2022 2026 };
2023 2027 $([IPython.events]).trigger('notebook_loading.Notebook');
2024 2028 var url = utils.url_join_encode(
2025 2029 this.base_url,
2026 2030 'api/notebooks',
2027 2031 this.notebook_path,
2028 2032 this.notebook_name
2029 2033 );
2030 2034 $.ajax(url, settings);
2031 2035 };
2032 2036
2033 2037 /**
2034 2038 * Success callback for loading a notebook from the server.
2035 2039 *
2036 2040 * Load notebook data from the JSON response.
2037 2041 *
2038 2042 * @method load_notebook_success
2039 2043 * @param {Object} data JSON representation of a notebook
2040 2044 * @param {String} status Description of response status
2041 2045 * @param {jqXHR} xhr jQuery Ajax object
2042 2046 */
2043 2047 Notebook.prototype.load_notebook_success = function (data, status, xhr) {
2044 2048 this.fromJSON(data);
2045 2049 if (this.ncells() === 0) {
2046 2050 this.insert_cell_below('code');
2047 2051 this.edit_mode(0);
2048 2052 } else {
2049 2053 this.select(0);
2050 2054 this.handle_command_mode(this.get_cell(0));
2051 2055 }
2052 2056 this.set_dirty(false);
2053 2057 this.scroll_to_top();
2054 2058 if (data.orig_nbformat !== undefined && data.nbformat !== data.orig_nbformat) {
2055 2059 var msg = "This notebook has been converted from an older " +
2056 2060 "notebook format (v"+data.orig_nbformat+") to the current notebook " +
2057 2061 "format (v"+data.nbformat+"). The next time you save this notebook, the " +
2058 2062 "newer notebook format will be used and older versions of IPython " +
2059 2063 "may not be able to read it. To keep the older version, close the " +
2060 2064 "notebook without saving it.";
2061 2065 IPython.dialog.modal({
2062 2066 title : "Notebook converted",
2063 2067 body : msg,
2064 2068 buttons : {
2065 2069 OK : {
2066 2070 class : "btn-primary"
2067 2071 }
2068 2072 }
2069 2073 });
2070 2074 } else if (data.orig_nbformat_minor !== undefined && data.nbformat_minor !== data.orig_nbformat_minor) {
2071 2075 var that = this;
2072 2076 var orig_vs = 'v' + data.nbformat + '.' + data.orig_nbformat_minor;
2073 2077 var this_vs = 'v' + data.nbformat + '.' + this.nbformat_minor;
2074 2078 var msg = "This notebook is version " + orig_vs + ", but we only fully support up to " +
2075 2079 this_vs + ". You can still work with this notebook, but some features " +
2076 2080 "introduced in later notebook versions may not be available.";
2077 2081
2078 2082 IPython.dialog.modal({
2079 2083 title : "Newer Notebook",
2080 2084 body : msg,
2081 2085 buttons : {
2082 2086 OK : {
2083 2087 class : "btn-danger"
2084 2088 }
2085 2089 }
2086 2090 });
2087 2091
2088 2092 }
2089 2093
2090 2094 // Create the session after the notebook is completely loaded to prevent
2091 2095 // code execution upon loading, which is a security risk.
2092 2096 if (this.session === null) {
2093 2097 this.start_session();
2094 2098 }
2095 2099 // load our checkpoint list
2096 2100 this.list_checkpoints();
2097 2101
2098 2102 // load toolbar state
2099 2103 if (this.metadata.celltoolbar) {
2100 2104 IPython.CellToolbar.global_show();
2101 2105 IPython.CellToolbar.activate_preset(this.metadata.celltoolbar);
2102 2106 }
2103
2107
2108 // now that we're fully loaded, it is safe to restore save functionality
2109 delete(this.save_notebook);
2104 2110 $([IPython.events]).trigger('notebook_loaded.Notebook');
2105 2111 };
2106 2112
2107 2113 /**
2108 2114 * Failure callback for loading a notebook from the server.
2109 2115 *
2110 2116 * @method load_notebook_error
2111 2117 * @param {jqXHR} xhr jQuery Ajax object
2112 2118 * @param {String} status Description of response status
2113 2119 * @param {String} error HTTP error message
2114 2120 */
2115 2121 Notebook.prototype.load_notebook_error = function (xhr, status, error) {
2116 2122 $([IPython.events]).trigger('notebook_load_failed.Notebook', [xhr, status, error]);
2117 2123 var msg;
2118 2124 if (xhr.status === 400) {
2119 2125 msg = error;
2120 2126 } else if (xhr.status === 500) {
2121 2127 msg = "An unknown error occurred while loading this notebook. " +
2122 2128 "This version can load notebook formats " +
2123 2129 "v" + this.nbformat + " or earlier.";
2124 2130 }
2125 2131 IPython.dialog.modal({
2126 2132 title: "Error loading notebook",
2127 2133 body : msg,
2128 2134 buttons : {
2129 2135 "OK": {}
2130 2136 }
2131 2137 });
2132 2138 };
2133 2139
2134 2140 /********************* checkpoint-related *********************/
2135 2141
2136 2142 /**
2137 2143 * Save the notebook then immediately create a checkpoint.
2138 2144 *
2139 2145 * @method save_checkpoint
2140 2146 */
2141 2147 Notebook.prototype.save_checkpoint = function () {
2142 2148 this._checkpoint_after_save = true;
2143 2149 this.save_notebook();
2144 2150 };
2145 2151
2146 2152 /**
2147 2153 * Add a checkpoint for this notebook.
2148 2154 * for use as a callback from checkpoint creation.
2149 2155 *
2150 2156 * @method add_checkpoint
2151 2157 */
2152 2158 Notebook.prototype.add_checkpoint = function (checkpoint) {
2153 2159 var found = false;
2154 2160 for (var i = 0; i < this.checkpoints.length; i++) {
2155 2161 var existing = this.checkpoints[i];
2156 2162 if (existing.id == checkpoint.id) {
2157 2163 found = true;
2158 2164 this.checkpoints[i] = checkpoint;
2159 2165 break;
2160 2166 }
2161 2167 }
2162 2168 if (!found) {
2163 2169 this.checkpoints.push(checkpoint);
2164 2170 }
2165 2171 this.last_checkpoint = this.checkpoints[this.checkpoints.length - 1];
2166 2172 };
2167 2173
2168 2174 /**
2169 2175 * List checkpoints for this notebook.
2170 2176 *
2171 2177 * @method list_checkpoints
2172 2178 */
2173 2179 Notebook.prototype.list_checkpoints = function () {
2174 2180 var url = utils.url_join_encode(
2175 2181 this.base_url,
2176 2182 'api/notebooks',
2177 2183 this.notebook_path,
2178 2184 this.notebook_name,
2179 2185 'checkpoints'
2180 2186 );
2181 2187 $.get(url).done(
2182 2188 $.proxy(this.list_checkpoints_success, this)
2183 2189 ).fail(
2184 2190 $.proxy(this.list_checkpoints_error, this)
2185 2191 );
2186 2192 };
2187 2193
2188 2194 /**
2189 2195 * Success callback for listing checkpoints.
2190 2196 *
2191 2197 * @method list_checkpoint_success
2192 2198 * @param {Object} data JSON representation of a checkpoint
2193 2199 * @param {String} status Description of response status
2194 2200 * @param {jqXHR} xhr jQuery Ajax object
2195 2201 */
2196 2202 Notebook.prototype.list_checkpoints_success = function (data, status, xhr) {
2197 2203 data = $.parseJSON(data);
2198 2204 this.checkpoints = data;
2199 2205 if (data.length) {
2200 2206 this.last_checkpoint = data[data.length - 1];
2201 2207 } else {
2202 2208 this.last_checkpoint = null;
2203 2209 }
2204 2210 $([IPython.events]).trigger('checkpoints_listed.Notebook', [data]);
2205 2211 };
2206 2212
2207 2213 /**
2208 2214 * Failure callback for listing a checkpoint.
2209 2215 *
2210 2216 * @method list_checkpoint_error
2211 2217 * @param {jqXHR} xhr jQuery Ajax object
2212 2218 * @param {String} status Description of response status
2213 2219 * @param {String} error_msg HTTP error message
2214 2220 */
2215 2221 Notebook.prototype.list_checkpoints_error = function (xhr, status, error_msg) {
2216 2222 $([IPython.events]).trigger('list_checkpoints_failed.Notebook');
2217 2223 };
2218 2224
2219 2225 /**
2220 2226 * Create a checkpoint of this notebook on the server from the most recent save.
2221 2227 *
2222 2228 * @method create_checkpoint
2223 2229 */
2224 2230 Notebook.prototype.create_checkpoint = function () {
2225 2231 var url = utils.url_join_encode(
2226 2232 this.base_url,
2227 2233 'api/notebooks',
2228 2234 this.notebook_path,
2229 2235 this.notebook_name,
2230 2236 'checkpoints'
2231 2237 );
2232 2238 $.post(url).done(
2233 2239 $.proxy(this.create_checkpoint_success, this)
2234 2240 ).fail(
2235 2241 $.proxy(this.create_checkpoint_error, this)
2236 2242 );
2237 2243 };
2238 2244
2239 2245 /**
2240 2246 * Success callback for creating a checkpoint.
2241 2247 *
2242 2248 * @method create_checkpoint_success
2243 2249 * @param {Object} data JSON representation of a checkpoint
2244 2250 * @param {String} status Description of response status
2245 2251 * @param {jqXHR} xhr jQuery Ajax object
2246 2252 */
2247 2253 Notebook.prototype.create_checkpoint_success = function (data, status, xhr) {
2248 2254 data = $.parseJSON(data);
2249 2255 this.add_checkpoint(data);
2250 2256 $([IPython.events]).trigger('checkpoint_created.Notebook', data);
2251 2257 };
2252 2258
2253 2259 /**
2254 2260 * Failure callback for creating a checkpoint.
2255 2261 *
2256 2262 * @method create_checkpoint_error
2257 2263 * @param {jqXHR} xhr jQuery Ajax object
2258 2264 * @param {String} status Description of response status
2259 2265 * @param {String} error_msg HTTP error message
2260 2266 */
2261 2267 Notebook.prototype.create_checkpoint_error = function (xhr, status, error_msg) {
2262 2268 $([IPython.events]).trigger('checkpoint_failed.Notebook');
2263 2269 };
2264 2270
2265 2271 Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
2266 2272 var that = this;
2267 2273 checkpoint = checkpoint || this.last_checkpoint;
2268 2274 if ( ! checkpoint ) {
2269 2275 console.log("restore dialog, but no checkpoint to restore to!");
2270 2276 return;
2271 2277 }
2272 2278 var body = $('<div/>').append(
2273 2279 $('<p/>').addClass("p-space").text(
2274 2280 "Are you sure you want to revert the notebook to " +
2275 2281 "the latest checkpoint?"
2276 2282 ).append(
2277 2283 $("<strong/>").text(
2278 2284 " This cannot be undone."
2279 2285 )
2280 2286 )
2281 2287 ).append(
2282 2288 $('<p/>').addClass("p-space").text("The checkpoint was last updated at:")
2283 2289 ).append(
2284 2290 $('<p/>').addClass("p-space").text(
2285 2291 Date(checkpoint.last_modified)
2286 2292 ).css("text-align", "center")
2287 2293 );
2288 2294
2289 2295 IPython.dialog.modal({
2290 2296 title : "Revert notebook to checkpoint",
2291 2297 body : body,
2292 2298 buttons : {
2293 2299 Revert : {
2294 2300 class : "btn-danger",
2295 2301 click : function () {
2296 2302 that.restore_checkpoint(checkpoint.id);
2297 2303 }
2298 2304 },
2299 2305 Cancel : {}
2300 2306 }
2301 2307 });
2302 2308 };
2303 2309
2304 2310 /**
2305 2311 * Restore the notebook to a checkpoint state.
2306 2312 *
2307 2313 * @method restore_checkpoint
2308 2314 * @param {String} checkpoint ID
2309 2315 */
2310 2316 Notebook.prototype.restore_checkpoint = function (checkpoint) {
2311 2317 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2312 2318 var url = utils.url_join_encode(
2313 2319 this.base_url,
2314 2320 'api/notebooks',
2315 2321 this.notebook_path,
2316 2322 this.notebook_name,
2317 2323 'checkpoints',
2318 2324 checkpoint
2319 2325 );
2320 2326 $.post(url).done(
2321 2327 $.proxy(this.restore_checkpoint_success, this)
2322 2328 ).fail(
2323 2329 $.proxy(this.restore_checkpoint_error, this)
2324 2330 );
2325 2331 };
2326 2332
2327 2333 /**
2328 2334 * Success callback for restoring a notebook to a checkpoint.
2329 2335 *
2330 2336 * @method restore_checkpoint_success
2331 2337 * @param {Object} data (ignored, should be empty)
2332 2338 * @param {String} status Description of response status
2333 2339 * @param {jqXHR} xhr jQuery Ajax object
2334 2340 */
2335 2341 Notebook.prototype.restore_checkpoint_success = function (data, status, xhr) {
2336 2342 $([IPython.events]).trigger('checkpoint_restored.Notebook');
2337 2343 this.load_notebook(this.notebook_name, this.notebook_path);
2338 2344 };
2339 2345
2340 2346 /**
2341 2347 * Failure callback for restoring a notebook to a checkpoint.
2342 2348 *
2343 2349 * @method restore_checkpoint_error
2344 2350 * @param {jqXHR} xhr jQuery Ajax object
2345 2351 * @param {String} status Description of response status
2346 2352 * @param {String} error_msg HTTP error message
2347 2353 */
2348 2354 Notebook.prototype.restore_checkpoint_error = function (xhr, status, error_msg) {
2349 2355 $([IPython.events]).trigger('checkpoint_restore_failed.Notebook');
2350 2356 };
2351 2357
2352 2358 /**
2353 2359 * Delete a notebook checkpoint.
2354 2360 *
2355 2361 * @method delete_checkpoint
2356 2362 * @param {String} checkpoint ID
2357 2363 */
2358 2364 Notebook.prototype.delete_checkpoint = function (checkpoint) {
2359 2365 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2360 2366 var url = utils.url_join_encode(
2361 2367 this.base_url,
2362 2368 'api/notebooks',
2363 2369 this.notebook_path,
2364 2370 this.notebook_name,
2365 2371 'checkpoints',
2366 2372 checkpoint
2367 2373 );
2368 2374 $.ajax(url, {
2369 2375 type: 'DELETE',
2370 2376 success: $.proxy(this.delete_checkpoint_success, this),
2371 2377 error: $.proxy(this.delete_notebook_error,this)
2372 2378 });
2373 2379 };
2374 2380
2375 2381 /**
2376 2382 * Success callback for deleting a notebook checkpoint
2377 2383 *
2378 2384 * @method delete_checkpoint_success
2379 2385 * @param {Object} data (ignored, should be empty)
2380 2386 * @param {String} status Description of response status
2381 2387 * @param {jqXHR} xhr jQuery Ajax object
2382 2388 */
2383 2389 Notebook.prototype.delete_checkpoint_success = function (data, status, xhr) {
2384 2390 $([IPython.events]).trigger('checkpoint_deleted.Notebook', data);
2385 2391 this.load_notebook(this.notebook_name, this.notebook_path);
2386 2392 };
2387 2393
2388 2394 /**
2389 2395 * Failure callback for deleting a notebook checkpoint.
2390 2396 *
2391 2397 * @method delete_checkpoint_error
2392 2398 * @param {jqXHR} xhr jQuery Ajax object
2393 2399 * @param {String} status Description of response status
2394 2400 * @param {String} error_msg HTTP error message
2395 2401 */
2396 2402 Notebook.prototype.delete_checkpoint_error = function (xhr, status, error_msg) {
2397 2403 $([IPython.events]).trigger('checkpoint_delete_failed.Notebook');
2398 2404 };
2399 2405
2400 2406
2401 2407 IPython.Notebook = Notebook;
2402 2408
2403 2409
2404 2410 return IPython;
2405 2411
2406 2412 }(IPython));
2407 2413
@@ -1,235 +1,235 b''
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2012 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // Notification widget
10 10 //============================================================================
11 11
12 12 var IPython = (function (IPython) {
13 13 "use strict";
14 14 var utils = IPython.utils;
15 15
16 16
17 17 var NotificationArea = function (selector) {
18 18 this.selector = selector;
19 19 if (this.selector !== undefined) {
20 20 this.element = $(selector);
21 21 }
22 22 this.widget_dict = {};
23 23 };
24 24
25 25 NotificationArea.prototype.temp_message = function (msg, timeout, css_class) {
26 26 var uuid = utils.uuid();
27 27 if( css_class == 'danger') {css_class = 'ui-state-error';}
28 28 if( css_class == 'warning') {css_class = 'ui-state-highlight';}
29 29 var tdiv = $('<div>')
30 30 .attr('id',uuid)
31 31 .addClass('notification_widget ui-widget ui-widget-content ui-corner-all')
32 32 .addClass('border-box-sizing')
33 33 .addClass(css_class)
34 34 .hide()
35 35 .text(msg);
36 36
37 37 $(this.selector).append(tdiv);
38 38 var tmout = Math.max(1500,(timeout||1500));
39 39 tdiv.fadeIn(100);
40 40
41 41 setTimeout(function () {
42 42 tdiv.fadeOut(100, function () {tdiv.remove();});
43 43 }, tmout);
44 44 };
45 45
46 46 NotificationArea.prototype.widget = function(name) {
47 47 if(this.widget_dict[name] === undefined) {
48 48 return this.new_notification_widget(name);
49 49 }
50 50 return this.get_widget(name);
51 51 };
52 52
53 53 NotificationArea.prototype.get_widget = function(name) {
54 54 if(this.widget_dict[name] === undefined) {
55 55 throw('no widgets with this name');
56 56 }
57 57 return this.widget_dict[name];
58 58 };
59 59
60 60 NotificationArea.prototype.new_notification_widget = function(name) {
61 61 if(this.widget_dict[name] !== undefined) {
62 62 throw('widget with that name already exists ! ');
63 63 }
64 64 var div = $('<div/>').attr('id','notification_'+name);
65 65 $(this.selector).append(div);
66 66 this.widget_dict[name] = new IPython.NotificationWidget('#notification_'+name);
67 67 return this.widget_dict[name];
68 68 };
69 69
70 70 NotificationArea.prototype.init_notification_widgets = function() {
71 71 var knw = this.new_notification_widget('kernel');
72 72 var $kernel_ind_icon = $("#kernel_indicator_icon");
73 73 var $modal_ind_icon = $("#modal_indicator_icon");
74 74
75 75 // Command/Edit mode
76 76 $([IPython.events]).on('edit_mode.Notebook',function () {
77 77 IPython.save_widget.update_document_title();
78 78 $modal_ind_icon.attr('class','edit_mode_icon').attr('title','Edit Mode');
79 79 });
80 80
81 81 $([IPython.events]).on('command_mode.Notebook',function () {
82 82 IPython.save_widget.update_document_title();
83 83 $modal_ind_icon.attr('class','command_mode_icon').attr('title','Command Mode');
84 84 });
85 85
86 86 // Implicitly start off in Command mode, switching to Edit mode will trigger event
87 87 $modal_ind_icon.attr('class','command-mode_icon').attr('title','Command Mode');
88 88
89 89 // Kernel events
90 90 $([IPython.events]).on('status_idle.Kernel',function () {
91 91 IPython.save_widget.update_document_title();
92 92 $kernel_ind_icon.attr('class','kernel_idle_icon').attr('title','Kernel Idle');
93 93 });
94 94
95 95 $([IPython.events]).on('status_busy.Kernel',function () {
96 96 window.document.title='(Busy) '+window.document.title;
97 97 $kernel_ind_icon.attr('class','kernel_busy_icon').attr('title','Kernel Busy');
98 98 });
99 99
100 100 $([IPython.events]).on('status_restarting.Kernel',function () {
101 101 IPython.save_widget.update_document_title();
102 102 knw.set_message("Restarting kernel", 2000);
103 103 });
104 104
105 105 $([IPython.events]).on('status_interrupting.Kernel',function () {
106 106 knw.set_message("Interrupting kernel", 2000);
107 107 });
108 108
109 109 // Start the kernel indicator in the busy state, and send a kernel_info request.
110 110 // When the kernel_info reply arrives, the kernel is idle.
111 111 $kernel_ind_icon.attr('class','kernel_busy_icon').attr('title','Kernel Busy');
112 112
113 113 $([IPython.events]).on('status_started.Kernel', function (evt, data) {
114 114 data.kernel.kernel_info(function () {
115 115 $([IPython.events]).trigger('status_idle.Kernel');
116 116 });
117 117 });
118 118
119 119 $([IPython.events]).on('status_dead.Kernel',function () {
120 120 var msg = 'The kernel has died, and the automatic restart has failed.' +
121 121 ' It is possible the kernel cannot be restarted.' +
122 122 ' If you are not able to restart the kernel, you will still be able to save' +
123 123 ' the notebook, but running code will no longer work until the notebook' +
124 124 ' is reopened.';
125 125
126 126 IPython.dialog.modal({
127 127 title: "Dead kernel",
128 128 body : msg,
129 129 buttons : {
130 130 "Manual Restart": {
131 131 class: "btn-danger",
132 132 click: function () {
133 133 $([IPython.events]).trigger('status_restarting.Kernel');
134 134 IPython.notebook.start_kernel();
135 135 }
136 136 },
137 137 "Don't restart": {}
138 138 }
139 139 });
140 140 });
141 141
142 142 $([IPython.events]).on('websocket_closed.Kernel', function (event, data) {
143 143 var kernel = data.kernel;
144 144 var ws_url = data.ws_url;
145 145 var early = data.early;
146 146 var msg;
147 147 if (!early) {
148 148 knw.set_message('Reconnecting WebSockets', 1000);
149 149 setTimeout(function () {
150 150 kernel.start_channels();
151 151 }, 5000);
152 152 return;
153 153 }
154 154 console.log('WebSocket connection failed: ', ws_url);
155 155 msg = "A WebSocket connection could not be established." +
156 156 " You will NOT be able to run code. Check your" +
157 157 " network connection or notebook server configuration.";
158 158 IPython.dialog.modal({
159 159 title: "WebSocket connection failed",
160 160 body: msg,
161 161 buttons : {
162 162 "OK": {},
163 163 "Reconnect": {
164 164 click: function () {
165 165 knw.set_message('Reconnecting WebSockets', 1000);
166 166 setTimeout(function () {
167 167 kernel.start_channels();
168 168 }, 5000);
169 169 }
170 170 }
171 171 }
172 172 });
173 173 });
174 174
175 175
176 176 var nnw = this.new_notification_widget('notebook');
177 177
178 178 // Notebook events
179 179 $([IPython.events]).on('notebook_loading.Notebook', function () {
180 180 nnw.set_message("Loading notebook",500);
181 181 });
182 182 $([IPython.events]).on('notebook_loaded.Notebook', function () {
183 183 nnw.set_message("Notebook loaded",500);
184 184 });
185 185 $([IPython.events]).on('notebook_saving.Notebook', function () {
186 186 nnw.set_message("Saving notebook",500);
187 187 });
188 188 $([IPython.events]).on('notebook_saved.Notebook', function () {
189 189 nnw.set_message("Notebook saved",2000);
190 190 });
191 $([IPython.events]).on('notebook_save_failed.Notebook', function () {
192 nnw.set_message("Notebook save failed");
191 $([IPython.events]).on('notebook_save_failed.Notebook', function (evt, xhr, status, data) {
192 nnw.set_message(data || "Notebook save failed");
193 193 });
194 194
195 195 // Checkpoint events
196 196 $([IPython.events]).on('checkpoint_created.Notebook', function (evt, data) {
197 197 var msg = "Checkpoint created";
198 198 if (data.last_modified) {
199 199 var d = new Date(data.last_modified);
200 200 msg = msg + ": " + d.format("HH:MM:ss");
201 201 }
202 202 nnw.set_message(msg, 2000);
203 203 });
204 204 $([IPython.events]).on('checkpoint_failed.Notebook', function () {
205 205 nnw.set_message("Checkpoint failed");
206 206 });
207 207 $([IPython.events]).on('checkpoint_deleted.Notebook', function () {
208 208 nnw.set_message("Checkpoint deleted", 500);
209 209 });
210 210 $([IPython.events]).on('checkpoint_delete_failed.Notebook', function () {
211 211 nnw.set_message("Checkpoint delete failed");
212 212 });
213 213 $([IPython.events]).on('checkpoint_restoring.Notebook', function () {
214 214 nnw.set_message("Restoring to checkpoint...", 500);
215 215 });
216 216 $([IPython.events]).on('checkpoint_restore_failed.Notebook', function () {
217 217 nnw.set_message("Checkpoint restore failed");
218 218 });
219 219
220 220 // Autosave events
221 221 $([IPython.events]).on('autosave_disabled.Notebook', function () {
222 222 nnw.set_message("Autosave disabled", 2000);
223 223 });
224 224 $([IPython.events]).on('autosave_enabled.Notebook', function (evt, interval) {
225 225 nnw.set_message("Saving every " + interval / 1000 + "s", 1000);
226 226 });
227 227
228 228 };
229 229
230 230 IPython.NotificationArea = NotificationArea;
231 231
232 232 return IPython;
233 233
234 234 }(IPython));
235 235
General Comments 0
You need to be logged in to leave comments. Login now