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