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