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