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