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