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