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