##// END OF EJS Templates
Added authentication configuration for the notebook app.
Phil Elson -
Show More
@@ -1,62 +1,86 b''
1 """Tornado handlers logging into the notebook.
1 """Tornado handlers logging into the notebook.
2
2
3 Authors:
3 Authors:
4
4
5 * Brian Granger
5 * Brian Granger
6 * Phil Elson
6 """
7 """
7
8
8 #-----------------------------------------------------------------------------
9 #-----------------------------------------------------------------------------
9 # Copyright (C) 2011 The IPython Development Team
10 # Copyright (C) 2014 The IPython Development Team
10 #
11 #
11 # Distributed under the terms of the BSD License. The full license is in
12 # Distributed under the terms of the BSD License. The full license is in
12 # the file COPYING, distributed as part of this software.
13 # the file COPYING, distributed as part of this software.
13 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
14
15
15 #-----------------------------------------------------------------------------
16 #-----------------------------------------------------------------------------
16 # Imports
17 # Imports
17 #-----------------------------------------------------------------------------
18 #-----------------------------------------------------------------------------
18
19
19 import uuid
20 import uuid
20
21
21 from tornado.escape import url_escape
22 from tornado.escape import url_escape
23 from tornado import web
22
24
25 from IPython.config.configurable import Configurable
23 from IPython.lib.security import passwd_check
26 from IPython.lib.security import passwd_check
24
27
25 from ..base.handlers import IPythonHandler
28 from ..base.handlers import IPythonHandler
26
29
27 #-----------------------------------------------------------------------------
30 #-----------------------------------------------------------------------------
28 # Handler
31 # Handler
29 #-----------------------------------------------------------------------------
32 #-----------------------------------------------------------------------------
30
33
31 class LoginHandler(IPythonHandler):
34 class LoginHandler(IPythonHandler):
32
35 """ The basic IPythonWebApplication login handler which authenticates with a
36 hashed password from the configuration.
37
38 """
33 def _render(self, message=None):
39 def _render(self, message=None):
34 self.write(self.render_template('login.html',
40 self.write(self.render_template('login.html',
35 next=url_escape(self.get_argument('next', default=self.base_url)),
41 next=url_escape(self.get_argument('next', default=self.base_url)),
36 message=message,
42 message=message,
37 ))
43 ))
38
44
39 def get(self):
45 def get(self):
40 if self.current_user:
46 if self.current_user:
41 self.redirect(self.get_argument('next', default=self.base_url))
47 self.redirect(self.get_argument('next', default=self.base_url))
42 else:
48 else:
43 self._render()
49 self._render()
44
50
45 def post(self):
51 def post(self):
46 pwd = self.get_argument('password', default=u'')
52 hashed_password = self.password_from_configuration(self.application)
47 if self.login_available:
53 typed_password = self.get_argument('password', default=u'')
48 if passwd_check(self.password, pwd):
54 if self.login_available(self.application):
55 if passwd_check(hashed_password, typed_password):
49 self.set_secure_cookie(self.cookie_name, str(uuid.uuid4()))
56 self.set_secure_cookie(self.cookie_name, str(uuid.uuid4()))
50 else:
57 else:
51 self._render(message={'error': 'Invalid password'})
58 self._render(message={'error': 'Invalid password'})
52 return
59 return
53
60
54 self.redirect(self.get_argument('next', default=self.base_url))
61 self.redirect(self.get_argument('next', default=self.base_url))
55
62
56
63 @classmethod
57 #-----------------------------------------------------------------------------
64 def validate_notebook_app_security(cls, notebook_app, ssl_options=None):
58 # URL to handler mappings
65 if not notebook_app.ip:
59 #-----------------------------------------------------------------------------
66 warning = "WARNING: The notebook server is listening on all IP addresses"
60
67 if ssl_options is None:
61
68 notebook_app.log.critical(warning + " and not using encryption. This "
62 default_handlers = [(r"/login", LoginHandler)]
69 "is not recommended.")
70 if not self.password_from_configuration(notebook_app):
71 notebook_app.log.critical(warning + " and not using authentication. "
72 "This is highly insecure and not recommended.")
73
74 @staticmethod
75 def password_from_configuration(webapp):
76 """ Return the hashed password from the given NotebookWebApplication's configuration.
77
78 If there is no configured password, None will be returned.
79
80 """
81 return webapp.settings['config']['NotebookApp'].get('password', None)
82
83 @classmethod
84 def login_available(cls, webapp):
85 """Whether this LoginHandler is needed - and therefore whether the login page should be displayed."""
86 return bool(cls.password_from_configuration(webapp))
@@ -1,514 +1,514 b''
1 """Base Tornado handlers for the notebook server."""
1 """Base Tornado handlers for the notebook server."""
2
2
3 # Copyright (c) IPython Development Team.
3 # Copyright (c) IPython Development Team.
4 # Distributed under the terms of the Modified BSD License.
4 # Distributed under the terms of the Modified BSD License.
5
5
6 import functools
6 import functools
7 import json
7 import json
8 import logging
8 import logging
9 import os
9 import os
10 import re
10 import re
11 import sys
11 import sys
12 import traceback
12 import traceback
13 try:
13 try:
14 # py3
14 # py3
15 from http.client import responses
15 from http.client import responses
16 except ImportError:
16 except ImportError:
17 from httplib import responses
17 from httplib import responses
18
18
19 from jinja2 import TemplateNotFound
19 from jinja2 import TemplateNotFound
20 from tornado import web
20 from tornado import web
21
21
22 try:
22 try:
23 from tornado.log import app_log
23 from tornado.log import app_log
24 except ImportError:
24 except ImportError:
25 app_log = logging.getLogger()
25 app_log = logging.getLogger()
26
26
27 import IPython
27 import IPython
28 from IPython.utils.sysinfo import get_sys_info
28 from IPython.utils.sysinfo import get_sys_info
29
29
30 from IPython.config import Application
30 from IPython.config import Application
31 from IPython.utils.path import filefind
31 from IPython.utils.path import filefind
32 from IPython.utils.py3compat import string_types
32 from IPython.utils.py3compat import string_types
33 from IPython.html.utils import is_hidden, url_path_join, url_escape
33 from IPython.html.utils import is_hidden, url_path_join, url_escape
34
34
35 from IPython.html.services.security import csp_report_uri
35 from IPython.html.services.security import csp_report_uri
36
36
37 #-----------------------------------------------------------------------------
37 #-----------------------------------------------------------------------------
38 # Top-level handlers
38 # Top-level handlers
39 #-----------------------------------------------------------------------------
39 #-----------------------------------------------------------------------------
40 non_alphanum = re.compile(r'[^A-Za-z0-9]')
40 non_alphanum = re.compile(r'[^A-Za-z0-9]')
41
41
42 sys_info = json.dumps(get_sys_info())
42 sys_info = json.dumps(get_sys_info())
43
43
44 class AuthenticatedHandler(web.RequestHandler):
44 class AuthenticatedHandler(web.RequestHandler):
45 """A RequestHandler with an authenticated user."""
45 """A RequestHandler with an authenticated user."""
46
46
47 def set_default_headers(self):
47 def set_default_headers(self):
48 headers = self.settings.get('headers', {})
48 headers = self.settings.get('headers', {})
49
49
50 if "Content-Security-Policy" not in headers:
50 if "Content-Security-Policy" not in headers:
51 headers["Content-Security-Policy"] = (
51 headers["Content-Security-Policy"] = (
52 "frame-ancestors 'self'; "
52 "frame-ancestors 'self'; "
53 # Make sure the report-uri is relative to the base_url
53 # Make sure the report-uri is relative to the base_url
54 "report-uri " + url_path_join(self.base_url, csp_report_uri) + ";"
54 "report-uri " + url_path_join(self.base_url, csp_report_uri) + ";"
55 )
55 )
56
56
57 # Allow for overriding headers
57 # Allow for overriding headers
58 for header_name,value in headers.items() :
58 for header_name,value in headers.items() :
59 try:
59 try:
60 self.set_header(header_name, value)
60 self.set_header(header_name, value)
61 except Exception as e:
61 except Exception as e:
62 # tornado raise Exception (not a subclass)
62 # tornado raise Exception (not a subclass)
63 # if method is unsupported (websocket and Access-Control-Allow-Origin
63 # if method is unsupported (websocket and Access-Control-Allow-Origin
64 # for example, so just ignore)
64 # for example, so just ignore)
65 self.log.debug(e)
65 self.log.debug(e)
66
66
67 def clear_login_cookie(self):
67 def clear_login_cookie(self):
68 self.clear_cookie(self.cookie_name)
68 self.clear_cookie(self.cookie_name)
69
69
70 def get_current_user(self):
70 def get_current_user(self):
71 user_id = self.get_secure_cookie(self.cookie_name)
71 user_id = self.get_secure_cookie(self.cookie_name)
72 # For now the user_id should not return empty, but it could eventually
72 # For now the user_id should not return empty, but it could eventually
73 if user_id == '':
73 if user_id == '':
74 user_id = 'anonymous'
74 user_id = 'anonymous'
75 if user_id is None:
75 if user_id is None:
76 # prevent extra Invalid cookie sig warnings:
76 # prevent extra Invalid cookie sig warnings:
77 self.clear_login_cookie()
77 self.clear_login_cookie()
78 if not self.login_available:
78 if not self.login_available:
79 user_id = 'anonymous'
79 user_id = 'anonymous'
80 return user_id
80 return user_id
81
81
82 @property
82 @property
83 def cookie_name(self):
83 def cookie_name(self):
84 default_cookie_name = non_alphanum.sub('-', 'username-{}'.format(
84 default_cookie_name = non_alphanum.sub('-', 'username-{}'.format(
85 self.request.host
85 self.request.host
86 ))
86 ))
87 return self.settings.get('cookie_name', default_cookie_name)
87 return self.settings.get('cookie_name', default_cookie_name)
88
88
89 @property
89 @property
90 def password(self):
91 """our password"""
92 return self.settings.get('password', '')
93
94 @property
95 def logged_in(self):
90 def logged_in(self):
96 """Is a user currently logged in?
91 """Is a user currently logged in?
97
92
98 """
93 """
99 user = self.get_current_user()
94 user = self.get_current_user()
100 return (user and not user == 'anonymous')
95 return (user and not user == 'anonymous')
101
96
102 @property
97 @property
98 def _login_handler(self):
99 """Return the login handler for this application."""
100 return self.settings['login_handler_class']
101
102 @property
103 def login_available(self):
103 def login_available(self):
104 """May a user proceed to log in?
104 """May a user proceed to log in?
105
105
106 This returns True if login capability is available, irrespective of
106 This returns True if login capability is available, irrespective of
107 whether the user is already logged in or not.
107 whether the user is already logged in or not.
108
108
109 """
109 """
110 return bool(self.settings.get('password', ''))
110 return bool(self._login_handler.login_available(self.application))
111
111
112
112
113 class IPythonHandler(AuthenticatedHandler):
113 class IPythonHandler(AuthenticatedHandler):
114 """IPython-specific extensions to authenticated handling
114 """IPython-specific extensions to authenticated handling
115
115
116 Mostly property shortcuts to IPython-specific settings.
116 Mostly property shortcuts to IPython-specific settings.
117 """
117 """
118
118
119 @property
119 @property
120 def config(self):
120 def config(self):
121 return self.settings.get('config', None)
121 return self.settings.get('config', None)
122
122
123 @property
123 @property
124 def log(self):
124 def log(self):
125 """use the IPython log by default, falling back on tornado's logger"""
125 """use the IPython log by default, falling back on tornado's logger"""
126 if Application.initialized():
126 if Application.initialized():
127 return Application.instance().log
127 return Application.instance().log
128 else:
128 else:
129 return app_log
129 return app_log
130
130
131 #---------------------------------------------------------------
131 #---------------------------------------------------------------
132 # URLs
132 # URLs
133 #---------------------------------------------------------------
133 #---------------------------------------------------------------
134
134
135 @property
135 @property
136 def version_hash(self):
136 def version_hash(self):
137 """The version hash to use for cache hints for static files"""
137 """The version hash to use for cache hints for static files"""
138 return self.settings.get('version_hash', '')
138 return self.settings.get('version_hash', '')
139
139
140 @property
140 @property
141 def mathjax_url(self):
141 def mathjax_url(self):
142 return self.settings.get('mathjax_url', '')
142 return self.settings.get('mathjax_url', '')
143
143
144 @property
144 @property
145 def base_url(self):
145 def base_url(self):
146 return self.settings.get('base_url', '/')
146 return self.settings.get('base_url', '/')
147
147
148 @property
148 @property
149 def ws_url(self):
149 def ws_url(self):
150 return self.settings.get('websocket_url', '')
150 return self.settings.get('websocket_url', '')
151
151
152 @property
152 @property
153 def contents_js_source(self):
153 def contents_js_source(self):
154 self.log.debug("Using contents: %s", self.settings.get('contents_js_source',
154 self.log.debug("Using contents: %s", self.settings.get('contents_js_source',
155 'services/contents'))
155 'services/contents'))
156 return self.settings.get('contents_js_source', 'services/contents')
156 return self.settings.get('contents_js_source', 'services/contents')
157
157
158 #---------------------------------------------------------------
158 #---------------------------------------------------------------
159 # Manager objects
159 # Manager objects
160 #---------------------------------------------------------------
160 #---------------------------------------------------------------
161
161
162 @property
162 @property
163 def kernel_manager(self):
163 def kernel_manager(self):
164 return self.settings['kernel_manager']
164 return self.settings['kernel_manager']
165
165
166 @property
166 @property
167 def contents_manager(self):
167 def contents_manager(self):
168 return self.settings['contents_manager']
168 return self.settings['contents_manager']
169
169
170 @property
170 @property
171 def cluster_manager(self):
171 def cluster_manager(self):
172 return self.settings['cluster_manager']
172 return self.settings['cluster_manager']
173
173
174 @property
174 @property
175 def session_manager(self):
175 def session_manager(self):
176 return self.settings['session_manager']
176 return self.settings['session_manager']
177
177
178 @property
178 @property
179 def terminal_manager(self):
179 def terminal_manager(self):
180 return self.settings['terminal_manager']
180 return self.settings['terminal_manager']
181
181
182 @property
182 @property
183 def kernel_spec_manager(self):
183 def kernel_spec_manager(self):
184 return self.settings['kernel_spec_manager']
184 return self.settings['kernel_spec_manager']
185
185
186 @property
186 @property
187 def config_manager(self):
187 def config_manager(self):
188 return self.settings['config_manager']
188 return self.settings['config_manager']
189
189
190 #---------------------------------------------------------------
190 #---------------------------------------------------------------
191 # CORS
191 # CORS
192 #---------------------------------------------------------------
192 #---------------------------------------------------------------
193
193
194 @property
194 @property
195 def allow_origin(self):
195 def allow_origin(self):
196 """Normal Access-Control-Allow-Origin"""
196 """Normal Access-Control-Allow-Origin"""
197 return self.settings.get('allow_origin', '')
197 return self.settings.get('allow_origin', '')
198
198
199 @property
199 @property
200 def allow_origin_pat(self):
200 def allow_origin_pat(self):
201 """Regular expression version of allow_origin"""
201 """Regular expression version of allow_origin"""
202 return self.settings.get('allow_origin_pat', None)
202 return self.settings.get('allow_origin_pat', None)
203
203
204 @property
204 @property
205 def allow_credentials(self):
205 def allow_credentials(self):
206 """Whether to set Access-Control-Allow-Credentials"""
206 """Whether to set Access-Control-Allow-Credentials"""
207 return self.settings.get('allow_credentials', False)
207 return self.settings.get('allow_credentials', False)
208
208
209 def set_default_headers(self):
209 def set_default_headers(self):
210 """Add CORS headers, if defined"""
210 """Add CORS headers, if defined"""
211 super(IPythonHandler, self).set_default_headers()
211 super(IPythonHandler, self).set_default_headers()
212 if self.allow_origin:
212 if self.allow_origin:
213 self.set_header("Access-Control-Allow-Origin", self.allow_origin)
213 self.set_header("Access-Control-Allow-Origin", self.allow_origin)
214 elif self.allow_origin_pat:
214 elif self.allow_origin_pat:
215 origin = self.get_origin()
215 origin = self.get_origin()
216 if origin and self.allow_origin_pat.match(origin):
216 if origin and self.allow_origin_pat.match(origin):
217 self.set_header("Access-Control-Allow-Origin", origin)
217 self.set_header("Access-Control-Allow-Origin", origin)
218 if self.allow_credentials:
218 if self.allow_credentials:
219 self.set_header("Access-Control-Allow-Credentials", 'true')
219 self.set_header("Access-Control-Allow-Credentials", 'true')
220
220
221 def get_origin(self):
221 def get_origin(self):
222 # Handle WebSocket Origin naming convention differences
222 # Handle WebSocket Origin naming convention differences
223 # The difference between version 8 and 13 is that in 8 the
223 # The difference between version 8 and 13 is that in 8 the
224 # client sends a "Sec-Websocket-Origin" header and in 13 it's
224 # client sends a "Sec-Websocket-Origin" header and in 13 it's
225 # simply "Origin".
225 # simply "Origin".
226 if "Origin" in self.request.headers:
226 if "Origin" in self.request.headers:
227 origin = self.request.headers.get("Origin")
227 origin = self.request.headers.get("Origin")
228 else:
228 else:
229 origin = self.request.headers.get("Sec-Websocket-Origin", None)
229 origin = self.request.headers.get("Sec-Websocket-Origin", None)
230 return origin
230 return origin
231
231
232 #---------------------------------------------------------------
232 #---------------------------------------------------------------
233 # template rendering
233 # template rendering
234 #---------------------------------------------------------------
234 #---------------------------------------------------------------
235
235
236 def get_template(self, name):
236 def get_template(self, name):
237 """Return the jinja template object for a given name"""
237 """Return the jinja template object for a given name"""
238 return self.settings['jinja2_env'].get_template(name)
238 return self.settings['jinja2_env'].get_template(name)
239
239
240 def render_template(self, name, **ns):
240 def render_template(self, name, **ns):
241 ns.update(self.template_namespace)
241 ns.update(self.template_namespace)
242 template = self.get_template(name)
242 template = self.get_template(name)
243 return template.render(**ns)
243 return template.render(**ns)
244
244
245 @property
245 @property
246 def template_namespace(self):
246 def template_namespace(self):
247 return dict(
247 return dict(
248 base_url=self.base_url,
248 base_url=self.base_url,
249 ws_url=self.ws_url,
249 ws_url=self.ws_url,
250 logged_in=self.logged_in,
250 logged_in=self.logged_in,
251 login_available=self.login_available,
251 login_available=self.login_available,
252 static_url=self.static_url,
252 static_url=self.static_url,
253 sys_info=sys_info,
253 sys_info=sys_info,
254 contents_js_source=self.contents_js_source,
254 contents_js_source=self.contents_js_source,
255 version_hash=self.version_hash,
255 version_hash=self.version_hash,
256 )
256 )
257
257
258 def get_json_body(self):
258 def get_json_body(self):
259 """Return the body of the request as JSON data."""
259 """Return the body of the request as JSON data."""
260 if not self.request.body:
260 if not self.request.body:
261 return None
261 return None
262 # Do we need to call body.decode('utf-8') here?
262 # Do we need to call body.decode('utf-8') here?
263 body = self.request.body.strip().decode(u'utf-8')
263 body = self.request.body.strip().decode(u'utf-8')
264 try:
264 try:
265 model = json.loads(body)
265 model = json.loads(body)
266 except Exception:
266 except Exception:
267 self.log.debug("Bad JSON: %r", body)
267 self.log.debug("Bad JSON: %r", body)
268 self.log.error("Couldn't parse JSON", exc_info=True)
268 self.log.error("Couldn't parse JSON", exc_info=True)
269 raise web.HTTPError(400, u'Invalid JSON in body of request')
269 raise web.HTTPError(400, u'Invalid JSON in body of request')
270 return model
270 return model
271
271
272 def write_error(self, status_code, **kwargs):
272 def write_error(self, status_code, **kwargs):
273 """render custom error pages"""
273 """render custom error pages"""
274 exc_info = kwargs.get('exc_info')
274 exc_info = kwargs.get('exc_info')
275 message = ''
275 message = ''
276 status_message = responses.get(status_code, 'Unknown HTTP Error')
276 status_message = responses.get(status_code, 'Unknown HTTP Error')
277 if exc_info:
277 if exc_info:
278 exception = exc_info[1]
278 exception = exc_info[1]
279 # get the custom message, if defined
279 # get the custom message, if defined
280 try:
280 try:
281 message = exception.log_message % exception.args
281 message = exception.log_message % exception.args
282 except Exception:
282 except Exception:
283 pass
283 pass
284
284
285 # construct the custom reason, if defined
285 # construct the custom reason, if defined
286 reason = getattr(exception, 'reason', '')
286 reason = getattr(exception, 'reason', '')
287 if reason:
287 if reason:
288 status_message = reason
288 status_message = reason
289
289
290 # build template namespace
290 # build template namespace
291 ns = dict(
291 ns = dict(
292 status_code=status_code,
292 status_code=status_code,
293 status_message=status_message,
293 status_message=status_message,
294 message=message,
294 message=message,
295 exception=exception,
295 exception=exception,
296 )
296 )
297
297
298 self.set_header('Content-Type', 'text/html')
298 self.set_header('Content-Type', 'text/html')
299 # render the template
299 # render the template
300 try:
300 try:
301 html = self.render_template('%s.html' % status_code, **ns)
301 html = self.render_template('%s.html' % status_code, **ns)
302 except TemplateNotFound:
302 except TemplateNotFound:
303 self.log.debug("No template for %d", status_code)
303 self.log.debug("No template for %d", status_code)
304 html = self.render_template('error.html', **ns)
304 html = self.render_template('error.html', **ns)
305
305
306 self.write(html)
306 self.write(html)
307
307
308
308
309
309
310 class Template404(IPythonHandler):
310 class Template404(IPythonHandler):
311 """Render our 404 template"""
311 """Render our 404 template"""
312 def prepare(self):
312 def prepare(self):
313 raise web.HTTPError(404)
313 raise web.HTTPError(404)
314
314
315
315
316 class AuthenticatedFileHandler(IPythonHandler, web.StaticFileHandler):
316 class AuthenticatedFileHandler(IPythonHandler, web.StaticFileHandler):
317 """static files should only be accessible when logged in"""
317 """static files should only be accessible when logged in"""
318
318
319 @web.authenticated
319 @web.authenticated
320 def get(self, path):
320 def get(self, path):
321 if os.path.splitext(path)[1] == '.ipynb':
321 if os.path.splitext(path)[1] == '.ipynb':
322 name = path.rsplit('/', 1)[-1]
322 name = path.rsplit('/', 1)[-1]
323 self.set_header('Content-Type', 'application/json')
323 self.set_header('Content-Type', 'application/json')
324 self.set_header('Content-Disposition','attachment; filename="%s"' % name)
324 self.set_header('Content-Disposition','attachment; filename="%s"' % name)
325
325
326 return web.StaticFileHandler.get(self, path)
326 return web.StaticFileHandler.get(self, path)
327
327
328 def set_headers(self):
328 def set_headers(self):
329 super(AuthenticatedFileHandler, self).set_headers()
329 super(AuthenticatedFileHandler, self).set_headers()
330 # disable browser caching, rely on 304 replies for savings
330 # disable browser caching, rely on 304 replies for savings
331 if "v" not in self.request.arguments:
331 if "v" not in self.request.arguments:
332 self.add_header("Cache-Control", "no-cache")
332 self.add_header("Cache-Control", "no-cache")
333
333
334 def compute_etag(self):
334 def compute_etag(self):
335 return None
335 return None
336
336
337 def validate_absolute_path(self, root, absolute_path):
337 def validate_absolute_path(self, root, absolute_path):
338 """Validate and return the absolute path.
338 """Validate and return the absolute path.
339
339
340 Requires tornado 3.1
340 Requires tornado 3.1
341
341
342 Adding to tornado's own handling, forbids the serving of hidden files.
342 Adding to tornado's own handling, forbids the serving of hidden files.
343 """
343 """
344 abs_path = super(AuthenticatedFileHandler, self).validate_absolute_path(root, absolute_path)
344 abs_path = super(AuthenticatedFileHandler, self).validate_absolute_path(root, absolute_path)
345 abs_root = os.path.abspath(root)
345 abs_root = os.path.abspath(root)
346 if is_hidden(abs_path, abs_root):
346 if is_hidden(abs_path, abs_root):
347 self.log.info("Refusing to serve hidden file, via 404 Error")
347 self.log.info("Refusing to serve hidden file, via 404 Error")
348 raise web.HTTPError(404)
348 raise web.HTTPError(404)
349 return abs_path
349 return abs_path
350
350
351
351
352 def json_errors(method):
352 def json_errors(method):
353 """Decorate methods with this to return GitHub style JSON errors.
353 """Decorate methods with this to return GitHub style JSON errors.
354
354
355 This should be used on any JSON API on any handler method that can raise HTTPErrors.
355 This should be used on any JSON API on any handler method that can raise HTTPErrors.
356
356
357 This will grab the latest HTTPError exception using sys.exc_info
357 This will grab the latest HTTPError exception using sys.exc_info
358 and then:
358 and then:
359
359
360 1. Set the HTTP status code based on the HTTPError
360 1. Set the HTTP status code based on the HTTPError
361 2. Create and return a JSON body with a message field describing
361 2. Create and return a JSON body with a message field describing
362 the error in a human readable form.
362 the error in a human readable form.
363 """
363 """
364 @functools.wraps(method)
364 @functools.wraps(method)
365 def wrapper(self, *args, **kwargs):
365 def wrapper(self, *args, **kwargs):
366 try:
366 try:
367 result = method(self, *args, **kwargs)
367 result = method(self, *args, **kwargs)
368 except web.HTTPError as e:
368 except web.HTTPError as e:
369 status = e.status_code
369 status = e.status_code
370 message = e.log_message
370 message = e.log_message
371 self.log.warn(message)
371 self.log.warn(message)
372 self.set_status(e.status_code)
372 self.set_status(e.status_code)
373 self.finish(json.dumps(dict(message=message)))
373 self.finish(json.dumps(dict(message=message)))
374 except Exception:
374 except Exception:
375 self.log.error("Unhandled error in API request", exc_info=True)
375 self.log.error("Unhandled error in API request", exc_info=True)
376 status = 500
376 status = 500
377 message = "Unknown server error"
377 message = "Unknown server error"
378 t, value, tb = sys.exc_info()
378 t, value, tb = sys.exc_info()
379 self.set_status(status)
379 self.set_status(status)
380 tb_text = ''.join(traceback.format_exception(t, value, tb))
380 tb_text = ''.join(traceback.format_exception(t, value, tb))
381 reply = dict(message=message, traceback=tb_text)
381 reply = dict(message=message, traceback=tb_text)
382 self.finish(json.dumps(reply))
382 self.finish(json.dumps(reply))
383 else:
383 else:
384 return result
384 return result
385 return wrapper
385 return wrapper
386
386
387
387
388
388
389 #-----------------------------------------------------------------------------
389 #-----------------------------------------------------------------------------
390 # File handler
390 # File handler
391 #-----------------------------------------------------------------------------
391 #-----------------------------------------------------------------------------
392
392
393 # to minimize subclass changes:
393 # to minimize subclass changes:
394 HTTPError = web.HTTPError
394 HTTPError = web.HTTPError
395
395
396 class FileFindHandler(web.StaticFileHandler):
396 class FileFindHandler(web.StaticFileHandler):
397 """subclass of StaticFileHandler for serving files from a search path"""
397 """subclass of StaticFileHandler for serving files from a search path"""
398
398
399 # cache search results, don't search for files more than once
399 # cache search results, don't search for files more than once
400 _static_paths = {}
400 _static_paths = {}
401
401
402 def set_headers(self):
402 def set_headers(self):
403 super(FileFindHandler, self).set_headers()
403 super(FileFindHandler, self).set_headers()
404 # disable browser caching, rely on 304 replies for savings
404 # disable browser caching, rely on 304 replies for savings
405 if "v" not in self.request.arguments or \
405 if "v" not in self.request.arguments or \
406 any(self.request.path.startswith(path) for path in self.no_cache_paths):
406 any(self.request.path.startswith(path) for path in self.no_cache_paths):
407 self.add_header("Cache-Control", "no-cache")
407 self.add_header("Cache-Control", "no-cache")
408
408
409 def initialize(self, path, default_filename=None, no_cache_paths=None):
409 def initialize(self, path, default_filename=None, no_cache_paths=None):
410 self.no_cache_paths = no_cache_paths or []
410 self.no_cache_paths = no_cache_paths or []
411
411
412 if isinstance(path, string_types):
412 if isinstance(path, string_types):
413 path = [path]
413 path = [path]
414
414
415 self.root = tuple(
415 self.root = tuple(
416 os.path.abspath(os.path.expanduser(p)) + os.sep for p in path
416 os.path.abspath(os.path.expanduser(p)) + os.sep for p in path
417 )
417 )
418 self.default_filename = default_filename
418 self.default_filename = default_filename
419
419
420 def compute_etag(self):
420 def compute_etag(self):
421 return None
421 return None
422
422
423 @classmethod
423 @classmethod
424 def get_absolute_path(cls, roots, path):
424 def get_absolute_path(cls, roots, path):
425 """locate a file to serve on our static file search path"""
425 """locate a file to serve on our static file search path"""
426 with cls._lock:
426 with cls._lock:
427 if path in cls._static_paths:
427 if path in cls._static_paths:
428 return cls._static_paths[path]
428 return cls._static_paths[path]
429 try:
429 try:
430 abspath = os.path.abspath(filefind(path, roots))
430 abspath = os.path.abspath(filefind(path, roots))
431 except IOError:
431 except IOError:
432 # IOError means not found
432 # IOError means not found
433 return ''
433 return ''
434
434
435 cls._static_paths[path] = abspath
435 cls._static_paths[path] = abspath
436 return abspath
436 return abspath
437
437
438 def validate_absolute_path(self, root, absolute_path):
438 def validate_absolute_path(self, root, absolute_path):
439 """check if the file should be served (raises 404, 403, etc.)"""
439 """check if the file should be served (raises 404, 403, etc.)"""
440 if absolute_path == '':
440 if absolute_path == '':
441 raise web.HTTPError(404)
441 raise web.HTTPError(404)
442
442
443 for root in self.root:
443 for root in self.root:
444 if (absolute_path + os.sep).startswith(root):
444 if (absolute_path + os.sep).startswith(root):
445 break
445 break
446
446
447 return super(FileFindHandler, self).validate_absolute_path(root, absolute_path)
447 return super(FileFindHandler, self).validate_absolute_path(root, absolute_path)
448
448
449
449
450 class ApiVersionHandler(IPythonHandler):
450 class ApiVersionHandler(IPythonHandler):
451
451
452 @json_errors
452 @json_errors
453 def get(self):
453 def get(self):
454 # not authenticated, so give as few info as possible
454 # not authenticated, so give as few info as possible
455 self.finish(json.dumps({"version":IPython.__version__}))
455 self.finish(json.dumps({"version":IPython.__version__}))
456
456
457
457
458 class TrailingSlashHandler(web.RequestHandler):
458 class TrailingSlashHandler(web.RequestHandler):
459 """Simple redirect handler that strips trailing slashes
459 """Simple redirect handler that strips trailing slashes
460
460
461 This should be the first, highest priority handler.
461 This should be the first, highest priority handler.
462 """
462 """
463
463
464 def get(self):
464 def get(self):
465 self.redirect(self.request.uri.rstrip('/'))
465 self.redirect(self.request.uri.rstrip('/'))
466
466
467 post = put = get
467 post = put = get
468
468
469
469
470 class FilesRedirectHandler(IPythonHandler):
470 class FilesRedirectHandler(IPythonHandler):
471 """Handler for redirecting relative URLs to the /files/ handler"""
471 """Handler for redirecting relative URLs to the /files/ handler"""
472 def get(self, path=''):
472 def get(self, path=''):
473 cm = self.contents_manager
473 cm = self.contents_manager
474 if cm.dir_exists(path):
474 if cm.dir_exists(path):
475 # it's a *directory*, redirect to /tree
475 # it's a *directory*, redirect to /tree
476 url = url_path_join(self.base_url, 'tree', path)
476 url = url_path_join(self.base_url, 'tree', path)
477 else:
477 else:
478 orig_path = path
478 orig_path = path
479 # otherwise, redirect to /files
479 # otherwise, redirect to /files
480 parts = path.split('/')
480 parts = path.split('/')
481
481
482 if not cm.file_exists(path=path) and 'files' in parts:
482 if not cm.file_exists(path=path) and 'files' in parts:
483 # redirect without files/ iff it would 404
483 # redirect without files/ iff it would 404
484 # this preserves pre-2.0-style 'files/' links
484 # this preserves pre-2.0-style 'files/' links
485 self.log.warn("Deprecated files/ URL: %s", orig_path)
485 self.log.warn("Deprecated files/ URL: %s", orig_path)
486 parts.remove('files')
486 parts.remove('files')
487 path = '/'.join(parts)
487 path = '/'.join(parts)
488
488
489 if not cm.file_exists(path=path):
489 if not cm.file_exists(path=path):
490 raise web.HTTPError(404)
490 raise web.HTTPError(404)
491
491
492 url = url_path_join(self.base_url, 'files', path)
492 url = url_path_join(self.base_url, 'files', path)
493 url = url_escape(url)
493 url = url_escape(url)
494 self.log.debug("Redirecting %s to %s", self.request.path, url)
494 self.log.debug("Redirecting %s to %s", self.request.path, url)
495 self.redirect(url)
495 self.redirect(url)
496
496
497
497
498 #-----------------------------------------------------------------------------
498 #-----------------------------------------------------------------------------
499 # URL pattern fragments for re-use
499 # URL pattern fragments for re-use
500 #-----------------------------------------------------------------------------
500 #-----------------------------------------------------------------------------
501
501
502 # path matches any number of `/foo[/bar...]` or just `/` or ''
502 # path matches any number of `/foo[/bar...]` or just `/` or ''
503 path_regex = r"(?P<path>(?:(?:/[^/]+)+|/?))"
503 path_regex = r"(?P<path>(?:(?:/[^/]+)+|/?))"
504 notebook_path_regex = r"(?P<path>(?:/[^/]+)+\.ipynb)"
504 notebook_path_regex = r"(?P<path>(?:/[^/]+)+\.ipynb)"
505
505
506 #-----------------------------------------------------------------------------
506 #-----------------------------------------------------------------------------
507 # URL to handler mappings
507 # URL to handler mappings
508 #-----------------------------------------------------------------------------
508 #-----------------------------------------------------------------------------
509
509
510
510
511 default_handlers = [
511 default_handlers = [
512 (r".*/", TrailingSlashHandler),
512 (r".*/", TrailingSlashHandler),
513 (r"api", ApiVersionHandler)
513 (r"api", ApiVersionHandler)
514 ]
514 ]
@@ -1,1042 +1,1038 b''
1 # coding: utf-8
1 # coding: utf-8
2 """A tornado based IPython notebook server."""
2 """A tornado based IPython notebook server."""
3
3
4 # Copyright (c) IPython Development Team.
4 # Copyright (c) IPython Development Team.
5 # Distributed under the terms of the Modified BSD License.
5 # Distributed under the terms of the Modified BSD License.
6
6
7 from __future__ import print_function
7 from __future__ import print_function
8
8
9 import base64
9 import base64
10 import datetime
10 import datetime
11 import errno
11 import errno
12 import io
12 import io
13 import json
13 import json
14 import logging
14 import logging
15 import os
15 import os
16 import random
16 import random
17 import re
17 import re
18 import select
18 import select
19 import signal
19 import signal
20 import socket
20 import socket
21 import sys
21 import sys
22 import threading
22 import threading
23 import time
23 import time
24 import webbrowser
24 import webbrowser
25
25
26
26
27 # check for pyzmq 2.1.11
27 # check for pyzmq 2.1.11
28 from IPython.utils.zmqrelated import check_for_zmq
28 from IPython.utils.zmqrelated import check_for_zmq
29 check_for_zmq('2.1.11', 'IPython.html')
29 check_for_zmq('2.1.11', 'IPython.html')
30
30
31 from jinja2 import Environment, FileSystemLoader
31 from jinja2 import Environment, FileSystemLoader
32
32
33 # Install the pyzmq ioloop. This has to be done before anything else from
33 # Install the pyzmq ioloop. This has to be done before anything else from
34 # tornado is imported.
34 # tornado is imported.
35 from zmq.eventloop import ioloop
35 from zmq.eventloop import ioloop
36 ioloop.install()
36 ioloop.install()
37
37
38 # check for tornado 3.1.0
38 # check for tornado 3.1.0
39 msg = "The IPython Notebook requires tornado >= 4.0"
39 msg = "The IPython Notebook requires tornado >= 4.0"
40 try:
40 try:
41 import tornado
41 import tornado
42 except ImportError:
42 except ImportError:
43 raise ImportError(msg)
43 raise ImportError(msg)
44 try:
44 try:
45 version_info = tornado.version_info
45 version_info = tornado.version_info
46 except AttributeError:
46 except AttributeError:
47 raise ImportError(msg + ", but you have < 1.1.0")
47 raise ImportError(msg + ", but you have < 1.1.0")
48 if version_info < (4,0):
48 if version_info < (4,0):
49 raise ImportError(msg + ", but you have %s" % tornado.version)
49 raise ImportError(msg + ", but you have %s" % tornado.version)
50
50
51 from tornado import httpserver
51 from tornado import httpserver
52 from tornado import web
52 from tornado import web
53 from tornado.log import LogFormatter, app_log, access_log, gen_log
53 from tornado.log import LogFormatter, app_log, access_log, gen_log
54
54
55 from IPython.html import (
55 from IPython.html import (
56 DEFAULT_STATIC_FILES_PATH,
56 DEFAULT_STATIC_FILES_PATH,
57 DEFAULT_TEMPLATE_PATH_LIST,
57 DEFAULT_TEMPLATE_PATH_LIST,
58 )
58 )
59 from .base.handlers import Template404
59 from .base.handlers import Template404
60 from .log import log_request
60 from .log import log_request
61 from .services.kernels.kernelmanager import MappingKernelManager
61 from .services.kernels.kernelmanager import MappingKernelManager
62 from .services.contents.manager import ContentsManager
62 from .services.contents.manager import ContentsManager
63 from .services.contents.filemanager import FileContentsManager
63 from .services.contents.filemanager import FileContentsManager
64 from .services.clusters.clustermanager import ClusterManager
64 from .services.clusters.clustermanager import ClusterManager
65 from .services.sessions.sessionmanager import SessionManager
65 from .services.sessions.sessionmanager import SessionManager
66
66
67 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
67 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
68
68
69 from IPython.config import Config
69 from IPython.config import Config
70 from IPython.config.application import catch_config_error, boolean_flag
70 from IPython.config.application import catch_config_error, boolean_flag
71 from IPython.core.application import (
71 from IPython.core.application import (
72 BaseIPythonApplication, base_flags, base_aliases,
72 BaseIPythonApplication, base_flags, base_aliases,
73 )
73 )
74 from IPython.core.profiledir import ProfileDir
74 from IPython.core.profiledir import ProfileDir
75 from IPython.kernel import KernelManager
75 from IPython.kernel import KernelManager
76 from IPython.kernel.kernelspec import KernelSpecManager
76 from IPython.kernel.kernelspec import KernelSpecManager
77 from IPython.kernel.zmq.session import default_secure, Session
77 from IPython.kernel.zmq.session import default_secure, Session
78 from IPython.nbformat.sign import NotebookNotary
78 from IPython.nbformat.sign import NotebookNotary
79 from IPython.utils.importstring import import_item
79 from IPython.utils.importstring import import_item
80 from IPython.utils import submodule
80 from IPython.utils import submodule
81 from IPython.utils.process import check_pid
81 from IPython.utils.process import check_pid
82 from IPython.utils.traitlets import (
82 from IPython.utils.traitlets import (
83 Dict, Unicode, Integer, List, Bool, Bytes, Instance,
83 Dict, Unicode, Integer, List, Bool, Bytes, Instance,
84 DottedObjectName, TraitError,
84 DottedObjectName, TraitError,
85 )
85 )
86 from IPython.utils import py3compat
86 from IPython.utils import py3compat
87 from IPython.utils.path import filefind, get_ipython_dir
87 from IPython.utils.path import filefind, get_ipython_dir
88 from IPython.utils.sysinfo import get_sys_info
88 from IPython.utils.sysinfo import get_sys_info
89
89
90 from .utils import url_path_join
90 from .utils import url_path_join
91
91
92 #-----------------------------------------------------------------------------
92 #-----------------------------------------------------------------------------
93 # Module globals
93 # Module globals
94 #-----------------------------------------------------------------------------
94 #-----------------------------------------------------------------------------
95
95
96 _examples = """
96 _examples = """
97 ipython notebook # start the notebook
97 ipython notebook # start the notebook
98 ipython notebook --profile=sympy # use the sympy profile
98 ipython notebook --profile=sympy # use the sympy profile
99 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
99 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
100 """
100 """
101
101
102 #-----------------------------------------------------------------------------
102 #-----------------------------------------------------------------------------
103 # Helper functions
103 # Helper functions
104 #-----------------------------------------------------------------------------
104 #-----------------------------------------------------------------------------
105
105
106 def random_ports(port, n):
106 def random_ports(port, n):
107 """Generate a list of n random ports near the given port.
107 """Generate a list of n random ports near the given port.
108
108
109 The first 5 ports will be sequential, and the remaining n-5 will be
109 The first 5 ports will be sequential, and the remaining n-5 will be
110 randomly selected in the range [port-2*n, port+2*n].
110 randomly selected in the range [port-2*n, port+2*n].
111 """
111 """
112 for i in range(min(5, n)):
112 for i in range(min(5, n)):
113 yield port + i
113 yield port + i
114 for i in range(n-5):
114 for i in range(n-5):
115 yield max(1, port + random.randint(-2*n, 2*n))
115 yield max(1, port + random.randint(-2*n, 2*n))
116
116
117 def load_handlers(name):
117 def load_handlers(name):
118 """Load the (URL pattern, handler) tuples for each component."""
118 """Load the (URL pattern, handler) tuples for each component."""
119 name = 'IPython.html.' + name
119 name = 'IPython.html.' + name
120 mod = __import__(name, fromlist=['default_handlers'])
120 mod = __import__(name, fromlist=['default_handlers'])
121 return mod.default_handlers
121 return mod.default_handlers
122
122
123 #-----------------------------------------------------------------------------
123 #-----------------------------------------------------------------------------
124 # The Tornado web application
124 # The Tornado web application
125 #-----------------------------------------------------------------------------
125 #-----------------------------------------------------------------------------
126
126
127 class NotebookWebApplication(web.Application):
127 class NotebookWebApplication(web.Application):
128
128
129 def __init__(self, ipython_app, kernel_manager, contents_manager,
129 def __init__(self, ipython_app, kernel_manager, contents_manager,
130 cluster_manager, session_manager, kernel_spec_manager,
130 cluster_manager, session_manager, kernel_spec_manager,
131 config_manager, log,
131 config_manager, log,
132 base_url, default_url, settings_overrides, jinja_env_options):
132 base_url, default_url, settings_overrides, jinja_env_options):
133
133
134 settings = self.init_settings(
134 settings = self.init_settings(
135 ipython_app, kernel_manager, contents_manager, cluster_manager,
135 ipython_app, kernel_manager, contents_manager, cluster_manager,
136 session_manager, kernel_spec_manager, config_manager, log, base_url,
136 session_manager, kernel_spec_manager, config_manager, log, base_url,
137 default_url, settings_overrides, jinja_env_options)
137 default_url, settings_overrides, jinja_env_options)
138 handlers = self.init_handlers(settings)
138 handlers = self.init_handlers(settings)
139
139
140 super(NotebookWebApplication, self).__init__(handlers, **settings)
140 super(NotebookWebApplication, self).__init__(handlers, **settings)
141
141
142 def init_settings(self, ipython_app, kernel_manager, contents_manager,
142 def init_settings(self, ipython_app, kernel_manager, contents_manager,
143 cluster_manager, session_manager, kernel_spec_manager,
143 cluster_manager, session_manager, kernel_spec_manager,
144 config_manager,
144 config_manager,
145 log, base_url, default_url, settings_overrides,
145 log, base_url, default_url, settings_overrides,
146 jinja_env_options=None):
146 jinja_env_options=None):
147
147
148 _template_path = settings_overrides.get(
148 _template_path = settings_overrides.get(
149 "template_path",
149 "template_path",
150 ipython_app.template_file_path,
150 ipython_app.template_file_path,
151 )
151 )
152 if isinstance(_template_path, str):
152 if isinstance(_template_path, str):
153 _template_path = (_template_path,)
153 _template_path = (_template_path,)
154 template_path = [os.path.expanduser(path) for path in _template_path]
154 template_path = [os.path.expanduser(path) for path in _template_path]
155
155
156 jenv_opt = jinja_env_options if jinja_env_options else {}
156 jenv_opt = jinja_env_options if jinja_env_options else {}
157 env = Environment(loader=FileSystemLoader(template_path), **jenv_opt)
157 env = Environment(loader=FileSystemLoader(template_path), **jenv_opt)
158
158
159 sys_info = get_sys_info()
159 sys_info = get_sys_info()
160 if sys_info['commit_source'] == 'repository':
160 if sys_info['commit_source'] == 'repository':
161 # don't cache (rely on 304) when working from master
161 # don't cache (rely on 304) when working from master
162 version_hash = ''
162 version_hash = ''
163 else:
163 else:
164 # reset the cache on server restart
164 # reset the cache on server restart
165 version_hash = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
165 version_hash = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
166
166
167 settings = dict(
167 settings = dict(
168 # basics
168 # basics
169 log_function=log_request,
169 log_function=log_request,
170 base_url=base_url,
170 base_url=base_url,
171 default_url=default_url,
171 default_url=default_url,
172 template_path=template_path,
172 template_path=template_path,
173 static_path=ipython_app.static_file_path,
173 static_path=ipython_app.static_file_path,
174 static_handler_class = FileFindHandler,
174 static_handler_class = FileFindHandler,
175 static_url_prefix = url_path_join(base_url,'/static/'),
175 static_url_prefix = url_path_join(base_url,'/static/'),
176 static_handler_args = {
176 static_handler_args = {
177 # don't cache custom.js
177 # don't cache custom.js
178 'no_cache_paths': [url_path_join(base_url, 'static', 'custom')],
178 'no_cache_paths': [url_path_join(base_url, 'static', 'custom')],
179 },
179 },
180 version_hash=version_hash,
180 version_hash=version_hash,
181
181
182 # authentication
182 # authentication
183 cookie_secret=ipython_app.cookie_secret,
183 cookie_secret=ipython_app.cookie_secret,
184 login_url=url_path_join(base_url,'/login'),
184 login_url=url_path_join(base_url,'/login'),
185 login_handler_class=ipython_app.login_handler_class,
185 password=ipython_app.password,
186 password=ipython_app.password,
186
187
187 # managers
188 # managers
188 kernel_manager=kernel_manager,
189 kernel_manager=kernel_manager,
189 contents_manager=contents_manager,
190 contents_manager=contents_manager,
190 cluster_manager=cluster_manager,
191 cluster_manager=cluster_manager,
191 session_manager=session_manager,
192 session_manager=session_manager,
192 kernel_spec_manager=kernel_spec_manager,
193 kernel_spec_manager=kernel_spec_manager,
193 config_manager=config_manager,
194 config_manager=config_manager,
194
195
195 # IPython stuff
196 # IPython stuff
196 nbextensions_path = ipython_app.nbextensions_path,
197 nbextensions_path=ipython_app.nbextensions_path,
197 websocket_url=ipython_app.websocket_url,
198 websocket_url=ipython_app.websocket_url,
198 mathjax_url=ipython_app.mathjax_url,
199 mathjax_url=ipython_app.mathjax_url,
199 config=ipython_app.config,
200 config=ipython_app.config,
200 jinja2_env=env,
201 jinja2_env=env,
201 terminals_available=False, # Set later if terminals are available
202 terminals_available=False, # Set later if terminals are available
202 )
203 )
203
204
204 # allow custom overrides for the tornado web app.
205 # allow custom overrides for the tornado web app.
205 settings.update(settings_overrides)
206 settings.update(settings_overrides)
206 return settings
207 return settings
207
208
208 def init_handlers(self, settings):
209 def init_handlers(self, settings):
209 """Load the (URL pattern, handler) tuples for each component."""
210 """Load the (URL pattern, handler) tuples for each component."""
210
211
211 # Order matters. The first handler to match the URL will handle the request.
212 # Order matters. The first handler to match the URL will handle the request.
212 handlers = []
213 handlers = []
213 handlers.extend(load_handlers('tree.handlers'))
214 handlers.extend(load_handlers('tree.handlers'))
214 handlers.extend(load_handlers('auth.login'))
215 handlers.extend([(r"/login", settings['login_handler_class'])])
215 handlers.extend(load_handlers('auth.logout'))
216 handlers.extend(load_handlers('auth.logout'))
216 handlers.extend(load_handlers('files.handlers'))
217 handlers.extend(load_handlers('files.handlers'))
217 handlers.extend(load_handlers('notebook.handlers'))
218 handlers.extend(load_handlers('notebook.handlers'))
218 handlers.extend(load_handlers('nbconvert.handlers'))
219 handlers.extend(load_handlers('nbconvert.handlers'))
219 handlers.extend(load_handlers('kernelspecs.handlers'))
220 handlers.extend(load_handlers('kernelspecs.handlers'))
220 handlers.extend(load_handlers('edit.handlers'))
221 handlers.extend(load_handlers('edit.handlers'))
221 handlers.extend(load_handlers('services.config.handlers'))
222 handlers.extend(load_handlers('services.config.handlers'))
222 handlers.extend(load_handlers('services.kernels.handlers'))
223 handlers.extend(load_handlers('services.kernels.handlers'))
223 handlers.extend(load_handlers('services.contents.handlers'))
224 handlers.extend(load_handlers('services.contents.handlers'))
224 handlers.extend(load_handlers('services.clusters.handlers'))
225 handlers.extend(load_handlers('services.clusters.handlers'))
225 handlers.extend(load_handlers('services.sessions.handlers'))
226 handlers.extend(load_handlers('services.sessions.handlers'))
226 handlers.extend(load_handlers('services.nbconvert.handlers'))
227 handlers.extend(load_handlers('services.nbconvert.handlers'))
227 handlers.extend(load_handlers('services.kernelspecs.handlers'))
228 handlers.extend(load_handlers('services.kernelspecs.handlers'))
228 handlers.extend(load_handlers('services.security.handlers'))
229 handlers.extend(load_handlers('services.security.handlers'))
229 handlers.append(
230 handlers.append(
230 (r"/nbextensions/(.*)", FileFindHandler, {
231 (r"/nbextensions/(.*)", FileFindHandler, {
231 'path': settings['nbextensions_path'],
232 'path': settings['nbextensions_path'],
232 'no_cache_paths': ['/'], # don't cache anything in nbextensions
233 'no_cache_paths': ['/'], # don't cache anything in nbextensions
233 }),
234 }),
234 )
235 )
235 # register base handlers last
236 # register base handlers last
236 handlers.extend(load_handlers('base.handlers'))
237 handlers.extend(load_handlers('base.handlers'))
237 # set the URL that will be redirected from `/`
238 # set the URL that will be redirected from `/`
238 handlers.append(
239 handlers.append(
239 (r'/?', web.RedirectHandler, {
240 (r'/?', web.RedirectHandler, {
240 'url' : url_path_join(settings['base_url'], settings['default_url']),
241 'url' : url_path_join(settings['base_url'], settings['default_url']),
241 'permanent': False, # want 302, not 301
242 'permanent': False, # want 302, not 301
242 })
243 })
243 )
244 )
244 # prepend base_url onto the patterns that we match
245 # prepend base_url onto the patterns that we match
245 new_handlers = []
246 new_handlers = []
246 for handler in handlers:
247 for handler in handlers:
247 pattern = url_path_join(settings['base_url'], handler[0])
248 pattern = url_path_join(settings['base_url'], handler[0])
248 new_handler = tuple([pattern] + list(handler[1:]))
249 new_handler = tuple([pattern] + list(handler[1:]))
249 new_handlers.append(new_handler)
250 new_handlers.append(new_handler)
250 # add 404 on the end, which will catch everything that falls through
251 # add 404 on the end, which will catch everything that falls through
251 new_handlers.append((r'(.*)', Template404))
252 new_handlers.append((r'(.*)', Template404))
252 return new_handlers
253 return new_handlers
253
254
254
255
255 class NbserverListApp(BaseIPythonApplication):
256 class NbserverListApp(BaseIPythonApplication):
256
257
257 description="List currently running notebook servers in this profile."
258 description="List currently running notebook servers in this profile."
258
259
259 flags = dict(
260 flags = dict(
260 json=({'NbserverListApp': {'json': True}},
261 json=({'NbserverListApp': {'json': True}},
261 "Produce machine-readable JSON output."),
262 "Produce machine-readable JSON output."),
262 )
263 )
263
264
264 json = Bool(False, config=True,
265 json = Bool(False, config=True,
265 help="If True, each line of output will be a JSON object with the "
266 help="If True, each line of output will be a JSON object with the "
266 "details from the server info file.")
267 "details from the server info file.")
267
268
268 def start(self):
269 def start(self):
269 if not self.json:
270 if not self.json:
270 print("Currently running servers:")
271 print("Currently running servers:")
271 for serverinfo in list_running_servers(self.profile):
272 for serverinfo in list_running_servers(self.profile):
272 if self.json:
273 if self.json:
273 print(json.dumps(serverinfo))
274 print(json.dumps(serverinfo))
274 else:
275 else:
275 print(serverinfo['url'], "::", serverinfo['notebook_dir'])
276 print(serverinfo['url'], "::", serverinfo['notebook_dir'])
276
277
277 #-----------------------------------------------------------------------------
278 #-----------------------------------------------------------------------------
278 # Aliases and Flags
279 # Aliases and Flags
279 #-----------------------------------------------------------------------------
280 #-----------------------------------------------------------------------------
280
281
281 flags = dict(base_flags)
282 flags = dict(base_flags)
282 flags['no-browser']=(
283 flags['no-browser']=(
283 {'NotebookApp' : {'open_browser' : False}},
284 {'NotebookApp' : {'open_browser' : False}},
284 "Don't open the notebook in a browser after startup."
285 "Don't open the notebook in a browser after startup."
285 )
286 )
286 flags['pylab']=(
287 flags['pylab']=(
287 {'NotebookApp' : {'pylab' : 'warn'}},
288 {'NotebookApp' : {'pylab' : 'warn'}},
288 "DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib."
289 "DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib."
289 )
290 )
290 flags['no-mathjax']=(
291 flags['no-mathjax']=(
291 {'NotebookApp' : {'enable_mathjax' : False}},
292 {'NotebookApp' : {'enable_mathjax' : False}},
292 """Disable MathJax
293 """Disable MathJax
293
294
294 MathJax is the javascript library IPython uses to render math/LaTeX. It is
295 MathJax is the javascript library IPython uses to render math/LaTeX. It is
295 very large, so you may want to disable it if you have a slow internet
296 very large, so you may want to disable it if you have a slow internet
296 connection, or for offline use of the notebook.
297 connection, or for offline use of the notebook.
297
298
298 When disabled, equations etc. will appear as their untransformed TeX source.
299 When disabled, equations etc. will appear as their untransformed TeX source.
299 """
300 """
300 )
301 )
301
302
302 # Add notebook manager flags
303 # Add notebook manager flags
303 flags.update(boolean_flag('script', 'FileContentsManager.save_script',
304 flags.update(boolean_flag('script', 'FileContentsManager.save_script',
304 'DEPRECATED, IGNORED',
305 'DEPRECATED, IGNORED',
305 'DEPRECATED, IGNORED'))
306 'DEPRECATED, IGNORED'))
306
307
307 aliases = dict(base_aliases)
308 aliases = dict(base_aliases)
308
309
309 aliases.update({
310 aliases.update({
310 'ip': 'NotebookApp.ip',
311 'ip': 'NotebookApp.ip',
311 'port': 'NotebookApp.port',
312 'port': 'NotebookApp.port',
312 'port-retries': 'NotebookApp.port_retries',
313 'port-retries': 'NotebookApp.port_retries',
313 'transport': 'KernelManager.transport',
314 'transport': 'KernelManager.transport',
314 'keyfile': 'NotebookApp.keyfile',
315 'keyfile': 'NotebookApp.keyfile',
315 'certfile': 'NotebookApp.certfile',
316 'certfile': 'NotebookApp.certfile',
316 'notebook-dir': 'NotebookApp.notebook_dir',
317 'notebook-dir': 'NotebookApp.notebook_dir',
317 'browser': 'NotebookApp.browser',
318 'browser': 'NotebookApp.browser',
318 'pylab': 'NotebookApp.pylab',
319 'pylab': 'NotebookApp.pylab',
319 })
320 })
320
321
321 #-----------------------------------------------------------------------------
322 #-----------------------------------------------------------------------------
322 # NotebookApp
323 # NotebookApp
323 #-----------------------------------------------------------------------------
324 #-----------------------------------------------------------------------------
324
325
325 class NotebookApp(BaseIPythonApplication):
326 class NotebookApp(BaseIPythonApplication):
326
327
327 name = 'ipython-notebook'
328 name = 'ipython-notebook'
328
329
329 description = """
330 description = """
330 The IPython HTML Notebook.
331 The IPython HTML Notebook.
331
332
332 This launches a Tornado based HTML Notebook Server that serves up an
333 This launches a Tornado based HTML Notebook Server that serves up an
333 HTML5/Javascript Notebook client.
334 HTML5/Javascript Notebook client.
334 """
335 """
335 examples = _examples
336 examples = _examples
336 aliases = aliases
337 aliases = aliases
337 flags = flags
338 flags = flags
338
339
339 classes = [
340 classes = [
340 KernelManager, ProfileDir, Session, MappingKernelManager,
341 KernelManager, ProfileDir, Session, MappingKernelManager,
341 ContentsManager, FileContentsManager, NotebookNotary,
342 ContentsManager, FileContentsManager, NotebookNotary,
342 ]
343 ]
343 flags = Dict(flags)
344 flags = Dict(flags)
344 aliases = Dict(aliases)
345 aliases = Dict(aliases)
345
346
346 subcommands = dict(
347 subcommands = dict(
347 list=(NbserverListApp, NbserverListApp.description.splitlines()[0]),
348 list=(NbserverListApp, NbserverListApp.description.splitlines()[0]),
348 )
349 )
349
350
350 ipython_kernel_argv = List(Unicode)
351 ipython_kernel_argv = List(Unicode)
351
352
352 _log_formatter_cls = LogFormatter
353 _log_formatter_cls = LogFormatter
353
354
354 def _log_level_default(self):
355 def _log_level_default(self):
355 return logging.INFO
356 return logging.INFO
356
357
357 def _log_datefmt_default(self):
358 def _log_datefmt_default(self):
358 """Exclude date from default date format"""
359 """Exclude date from default date format"""
359 return "%H:%M:%S"
360 return "%H:%M:%S"
360
361
361 def _log_format_default(self):
362 def _log_format_default(self):
362 """override default log format to include time"""
363 """override default log format to include time"""
363 return u"%(color)s[%(levelname)1.1s %(asctime)s.%(msecs).03d %(name)s]%(end_color)s %(message)s"
364 return u"%(color)s[%(levelname)1.1s %(asctime)s.%(msecs).03d %(name)s]%(end_color)s %(message)s"
364
365
365 # create requested profiles by default, if they don't exist:
366 # create requested profiles by default, if they don't exist:
366 auto_create = Bool(True)
367 auto_create = Bool(True)
367
368
368 # file to be opened in the notebook server
369 # file to be opened in the notebook server
369 file_to_run = Unicode('', config=True)
370 file_to_run = Unicode('', config=True)
370
371
371 # Network related information
372 # Network related information
372
373
373 allow_origin = Unicode('', config=True,
374 allow_origin = Unicode('', config=True,
374 help="""Set the Access-Control-Allow-Origin header
375 help="""Set the Access-Control-Allow-Origin header
375
376
376 Use '*' to allow any origin to access your server.
377 Use '*' to allow any origin to access your server.
377
378
378 Takes precedence over allow_origin_pat.
379 Takes precedence over allow_origin_pat.
379 """
380 """
380 )
381 )
381
382
382 allow_origin_pat = Unicode('', config=True,
383 allow_origin_pat = Unicode('', config=True,
383 help="""Use a regular expression for the Access-Control-Allow-Origin header
384 help="""Use a regular expression for the Access-Control-Allow-Origin header
384
385
385 Requests from an origin matching the expression will get replies with:
386 Requests from an origin matching the expression will get replies with:
386
387
387 Access-Control-Allow-Origin: origin
388 Access-Control-Allow-Origin: origin
388
389
389 where `origin` is the origin of the request.
390 where `origin` is the origin of the request.
390
391
391 Ignored if allow_origin is set.
392 Ignored if allow_origin is set.
392 """
393 """
393 )
394 )
394
395
395 allow_credentials = Bool(False, config=True,
396 allow_credentials = Bool(False, config=True,
396 help="Set the Access-Control-Allow-Credentials: true header"
397 help="Set the Access-Control-Allow-Credentials: true header"
397 )
398 )
398
399
399 default_url = Unicode('/tree', config=True,
400 default_url = Unicode('/tree', config=True,
400 help="The default URL to redirect to from `/`"
401 help="The default URL to redirect to from `/`"
401 )
402 )
402
403
403 ip = Unicode('localhost', config=True,
404 ip = Unicode('localhost', config=True,
404 help="The IP address the notebook server will listen on."
405 help="The IP address the notebook server will listen on."
405 )
406 )
406
407
407 def _ip_changed(self, name, old, new):
408 def _ip_changed(self, name, old, new):
408 if new == u'*': self.ip = u''
409 if new == u'*': self.ip = u''
409
410
410 port = Integer(8888, config=True,
411 port = Integer(8888, config=True,
411 help="The port the notebook server will listen on."
412 help="The port the notebook server will listen on."
412 )
413 )
413 port_retries = Integer(50, config=True,
414 port_retries = Integer(50, config=True,
414 help="The number of additional ports to try if the specified port is not available."
415 help="The number of additional ports to try if the specified port is not available."
415 )
416 )
416
417
417 certfile = Unicode(u'', config=True,
418 certfile = Unicode(u'', config=True,
418 help="""The full path to an SSL/TLS certificate file."""
419 help="""The full path to an SSL/TLS certificate file."""
419 )
420 )
420
421
421 keyfile = Unicode(u'', config=True,
422 keyfile = Unicode(u'', config=True,
422 help="""The full path to a private key file for usage with SSL/TLS."""
423 help="""The full path to a private key file for usage with SSL/TLS."""
423 )
424 )
424
425
425 cookie_secret_file = Unicode(config=True,
426 cookie_secret_file = Unicode(config=True,
426 help="""The file where the cookie secret is stored."""
427 help="""The file where the cookie secret is stored."""
427 )
428 )
428 def _cookie_secret_file_default(self):
429 def _cookie_secret_file_default(self):
429 if self.profile_dir is None:
430 if self.profile_dir is None:
430 return ''
431 return ''
431 return os.path.join(self.profile_dir.security_dir, 'notebook_cookie_secret')
432 return os.path.join(self.profile_dir.security_dir, 'notebook_cookie_secret')
432
433
433 cookie_secret = Bytes(b'', config=True,
434 cookie_secret = Bytes(b'', config=True,
434 help="""The random bytes used to secure cookies.
435 help="""The random bytes used to secure cookies.
435 By default this is a new random number every time you start the Notebook.
436 By default this is a new random number every time you start the Notebook.
436 Set it to a value in a config file to enable logins to persist across server sessions.
437 Set it to a value in a config file to enable logins to persist across server sessions.
437
438
438 Note: Cookie secrets should be kept private, do not share config files with
439 Note: Cookie secrets should be kept private, do not share config files with
439 cookie_secret stored in plaintext (you can read the value from a file).
440 cookie_secret stored in plaintext (you can read the value from a file).
440 """
441 """
441 )
442 )
442 def _cookie_secret_default(self):
443 def _cookie_secret_default(self):
443 if os.path.exists(self.cookie_secret_file):
444 if os.path.exists(self.cookie_secret_file):
444 with io.open(self.cookie_secret_file, 'rb') as f:
445 with io.open(self.cookie_secret_file, 'rb') as f:
445 return f.read()
446 return f.read()
446 else:
447 else:
447 secret = base64.encodestring(os.urandom(1024))
448 secret = base64.encodestring(os.urandom(1024))
448 self._write_cookie_secret_file(secret)
449 self._write_cookie_secret_file(secret)
449 return secret
450 return secret
450
451
451 def _write_cookie_secret_file(self, secret):
452 def _write_cookie_secret_file(self, secret):
452 """write my secret to my secret_file"""
453 """write my secret to my secret_file"""
453 self.log.info("Writing notebook server cookie secret to %s", self.cookie_secret_file)
454 self.log.info("Writing notebook server cookie secret to %s", self.cookie_secret_file)
454 with io.open(self.cookie_secret_file, 'wb') as f:
455 with io.open(self.cookie_secret_file, 'wb') as f:
455 f.write(secret)
456 f.write(secret)
456 try:
457 try:
457 os.chmod(self.cookie_secret_file, 0o600)
458 os.chmod(self.cookie_secret_file, 0o600)
458 except OSError:
459 except OSError:
459 self.log.warn(
460 self.log.warn(
460 "Could not set permissions on %s",
461 "Could not set permissions on %s",
461 self.cookie_secret_file
462 self.cookie_secret_file
462 )
463 )
463
464
464 password = Unicode(u'', config=True,
465 password = Unicode(u'', config=True,
465 help="""Hashed password to use for web authentication.
466 help="""Hashed password to use for web authentication.
466
467
467 To generate, type in a python/IPython shell:
468 To generate, type in a python/IPython shell:
468
469
469 from IPython.lib import passwd; passwd()
470 from IPython.lib import passwd; passwd()
470
471
471 The string should be of the form type:salt:hashed-password.
472 The string should be of the form type:salt:hashed-password.
472 """
473 """
473 )
474 )
474
475
475 open_browser = Bool(True, config=True,
476 open_browser = Bool(True, config=True,
476 help="""Whether to open in a browser after starting.
477 help="""Whether to open in a browser after starting.
477 The specific browser used is platform dependent and
478 The specific browser used is platform dependent and
478 determined by the python standard library `webbrowser`
479 determined by the python standard library `webbrowser`
479 module, unless it is overridden using the --browser
480 module, unless it is overridden using the --browser
480 (NotebookApp.browser) configuration option.
481 (NotebookApp.browser) configuration option.
481 """)
482 """)
482
483
483 browser = Unicode(u'', config=True,
484 browser = Unicode(u'', config=True,
484 help="""Specify what command to use to invoke a web
485 help="""Specify what command to use to invoke a web
485 browser when opening the notebook. If not specified, the
486 browser when opening the notebook. If not specified, the
486 default browser will be determined by the `webbrowser`
487 default browser will be determined by the `webbrowser`
487 standard library module, which allows setting of the
488 standard library module, which allows setting of the
488 BROWSER environment variable to override it.
489 BROWSER environment variable to override it.
489 """)
490 """)
490
491
491 webapp_settings = Dict(config=True,
492 webapp_settings = Dict(config=True,
492 help="DEPRECATED, use tornado_settings"
493 help="DEPRECATED, use tornado_settings"
493 )
494 )
494 def _webapp_settings_changed(self, name, old, new):
495 def _webapp_settings_changed(self, name, old, new):
495 self.log.warn("\n webapp_settings is deprecated, use tornado_settings.\n")
496 self.log.warn("\n webapp_settings is deprecated, use tornado_settings.\n")
496 self.tornado_settings = new
497 self.tornado_settings = new
497
498
498 tornado_settings = Dict(config=True,
499 tornado_settings = Dict(config=True,
499 help="Supply overrides for the tornado.web.Application that the "
500 help="Supply overrides for the tornado.web.Application that the "
500 "IPython notebook uses.")
501 "IPython notebook uses.")
501
502
502 jinja_environment_options = Dict(config=True,
503 jinja_environment_options = Dict(config=True,
503 help="Supply extra arguments that will be passed to Jinja environment.")
504 help="Supply extra arguments that will be passed to Jinja environment.")
504
505
505
506 enable_mathjax = Bool(True, config=True,
506 enable_mathjax = Bool(True, config=True,
507 help="""Whether to enable MathJax for typesetting math/TeX
507 help="""Whether to enable MathJax for typesetting math/TeX
508
508
509 MathJax is the javascript library IPython uses to render math/LaTeX. It is
509 MathJax is the javascript library IPython uses to render math/LaTeX. It is
510 very large, so you may want to disable it if you have a slow internet
510 very large, so you may want to disable it if you have a slow internet
511 connection, or for offline use of the notebook.
511 connection, or for offline use of the notebook.
512
512
513 When disabled, equations etc. will appear as their untransformed TeX source.
513 When disabled, equations etc. will appear as their untransformed TeX source.
514 """
514 """
515 )
515 )
516 def _enable_mathjax_changed(self, name, old, new):
516 def _enable_mathjax_changed(self, name, old, new):
517 """set mathjax url to empty if mathjax is disabled"""
517 """set mathjax url to empty if mathjax is disabled"""
518 if not new:
518 if not new:
519 self.mathjax_url = u''
519 self.mathjax_url = u''
520
520
521 base_url = Unicode('/', config=True,
521 base_url = Unicode('/', config=True,
522 help='''The base URL for the notebook server.
522 help='''The base URL for the notebook server.
523
523
524 Leading and trailing slashes can be omitted,
524 Leading and trailing slashes can be omitted,
525 and will automatically be added.
525 and will automatically be added.
526 ''')
526 ''')
527 def _base_url_changed(self, name, old, new):
527 def _base_url_changed(self, name, old, new):
528 if not new.startswith('/'):
528 if not new.startswith('/'):
529 self.base_url = '/'+new
529 self.base_url = '/'+new
530 elif not new.endswith('/'):
530 elif not new.endswith('/'):
531 self.base_url = new+'/'
531 self.base_url = new+'/'
532
532
533 base_project_url = Unicode('/', config=True, help="""DEPRECATED use base_url""")
533 base_project_url = Unicode('/', config=True, help="""DEPRECATED use base_url""")
534 def _base_project_url_changed(self, name, old, new):
534 def _base_project_url_changed(self, name, old, new):
535 self.log.warn("base_project_url is deprecated, use base_url")
535 self.log.warn("base_project_url is deprecated, use base_url")
536 self.base_url = new
536 self.base_url = new
537
537
538 extra_static_paths = List(Unicode, config=True,
538 extra_static_paths = List(Unicode, config=True,
539 help="""Extra paths to search for serving static files.
539 help="""Extra paths to search for serving static files.
540
540
541 This allows adding javascript/css to be available from the notebook server machine,
541 This allows adding javascript/css to be available from the notebook server machine,
542 or overriding individual files in the IPython"""
542 or overriding individual files in the IPython"""
543 )
543 )
544 def _extra_static_paths_default(self):
544 def _extra_static_paths_default(self):
545 return [os.path.join(self.profile_dir.location, 'static')]
545 return [os.path.join(self.profile_dir.location, 'static')]
546
546
547 @property
547 @property
548 def static_file_path(self):
548 def static_file_path(self):
549 """return extra paths + the default location"""
549 """return extra paths + the default location"""
550 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
550 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
551
551
552 extra_template_paths = List(Unicode, config=True,
552 extra_template_paths = List(Unicode, config=True,
553 help="""Extra paths to search for serving jinja templates.
553 help="""Extra paths to search for serving jinja templates.
554
554
555 Can be used to override templates from IPython.html.templates."""
555 Can be used to override templates from IPython.html.templates."""
556 )
556 )
557 def _extra_template_paths_default(self):
557 def _extra_template_paths_default(self):
558 return []
558 return []
559
559
560 @property
560 @property
561 def template_file_path(self):
561 def template_file_path(self):
562 """return extra paths + the default locations"""
562 """return extra paths + the default locations"""
563 return self.extra_template_paths + DEFAULT_TEMPLATE_PATH_LIST
563 return self.extra_template_paths + DEFAULT_TEMPLATE_PATH_LIST
564
564
565 nbextensions_path = List(Unicode, config=True,
565 nbextensions_path = List(Unicode, config=True,
566 help="""paths for Javascript extensions. By default, this is just IPYTHONDIR/nbextensions"""
566 help="""paths for Javascript extensions. By default, this is just IPYTHONDIR/nbextensions"""
567 )
567 )
568 def _nbextensions_path_default(self):
568 def _nbextensions_path_default(self):
569 return [os.path.join(get_ipython_dir(), 'nbextensions')]
569 return [os.path.join(get_ipython_dir(), 'nbextensions')]
570
570
571 websocket_url = Unicode("", config=True,
571 websocket_url = Unicode("", config=True,
572 help="""The base URL for websockets,
572 help="""The base URL for websockets,
573 if it differs from the HTTP server (hint: it almost certainly doesn't).
573 if it differs from the HTTP server (hint: it almost certainly doesn't).
574
574
575 Should be in the form of an HTTP origin: ws[s]://hostname[:port]
575 Should be in the form of an HTTP origin: ws[s]://hostname[:port]
576 """
576 """
577 )
577 )
578 mathjax_url = Unicode("", config=True,
578 mathjax_url = Unicode("", config=True,
579 help="""The url for MathJax.js."""
579 help="""The url for MathJax.js."""
580 )
580 )
581 def _mathjax_url_default(self):
581 def _mathjax_url_default(self):
582 if not self.enable_mathjax:
582 if not self.enable_mathjax:
583 return u''
583 return u''
584 static_url_prefix = self.tornado_settings.get("static_url_prefix",
584 static_url_prefix = self.tornado_settings.get("static_url_prefix",
585 url_path_join(self.base_url, "static")
585 url_path_join(self.base_url, "static")
586 )
586 )
587
587
588 # try local mathjax, either in nbextensions/mathjax or static/mathjax
588 # try local mathjax, either in nbextensions/mathjax or static/mathjax
589 for (url_prefix, search_path) in [
589 for (url_prefix, search_path) in [
590 (url_path_join(self.base_url, "nbextensions"), self.nbextensions_path),
590 (url_path_join(self.base_url, "nbextensions"), self.nbextensions_path),
591 (static_url_prefix, self.static_file_path),
591 (static_url_prefix, self.static_file_path),
592 ]:
592 ]:
593 self.log.debug("searching for local mathjax in %s", search_path)
593 self.log.debug("searching for local mathjax in %s", search_path)
594 try:
594 try:
595 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), search_path)
595 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), search_path)
596 except IOError:
596 except IOError:
597 continue
597 continue
598 else:
598 else:
599 url = url_path_join(url_prefix, u"mathjax/MathJax.js")
599 url = url_path_join(url_prefix, u"mathjax/MathJax.js")
600 self.log.info("Serving local MathJax from %s at %s", mathjax, url)
600 self.log.info("Serving local MathJax from %s at %s", mathjax, url)
601 return url
601 return url
602
602
603 # no local mathjax, serve from CDN
603 # no local mathjax, serve from CDN
604 url = u"https://cdn.mathjax.org/mathjax/latest/MathJax.js"
604 url = u"https://cdn.mathjax.org/mathjax/latest/MathJax.js"
605 self.log.info("Using MathJax from CDN: %s", url)
605 self.log.info("Using MathJax from CDN: %s", url)
606 return url
606 return url
607
607
608 def _mathjax_url_changed(self, name, old, new):
608 def _mathjax_url_changed(self, name, old, new):
609 if new and not self.enable_mathjax:
609 if new and not self.enable_mathjax:
610 # enable_mathjax=False overrides mathjax_url
610 # enable_mathjax=False overrides mathjax_url
611 self.mathjax_url = u''
611 self.mathjax_url = u''
612 else:
612 else:
613 self.log.info("Using MathJax: %s", new)
613 self.log.info("Using MathJax: %s", new)
614
614
615 contents_manager_class = DottedObjectName('IPython.html.services.contents.filemanager.FileContentsManager',
615 contents_manager_class = DottedObjectName('IPython.html.services.contents.filemanager.FileContentsManager',
616 config=True,
616 config=True,
617 help='The notebook manager class to use.'
617 help='The notebook manager class to use.'
618 )
618 )
619 kernel_manager_class = DottedObjectName('IPython.html.services.kernels.kernelmanager.MappingKernelManager',
619 kernel_manager_class = DottedObjectName('IPython.html.services.kernels.kernelmanager.MappingKernelManager',
620 config=True,
620 config=True,
621 help='The kernel manager class to use.'
621 help='The kernel manager class to use.'
622 )
622 )
623 session_manager_class = DottedObjectName('IPython.html.services.sessions.sessionmanager.SessionManager',
623 session_manager_class = DottedObjectName('IPython.html.services.sessions.sessionmanager.SessionManager',
624 config=True,
624 config=True,
625 help='The session manager class to use.'
625 help='The session manager class to use.'
626 )
626 )
627 cluster_manager_class = DottedObjectName('IPython.html.services.clusters.clustermanager.ClusterManager',
627 cluster_manager_class = DottedObjectName('IPython.html.services.clusters.clustermanager.ClusterManager',
628 config=True,
628 config=True,
629 help='The cluster manager class to use.'
629 help='The cluster manager class to use.'
630 )
630 )
631
631
632 config_manager_class = DottedObjectName('IPython.html.services.config.manager.ConfigManager',
632 config_manager_class = DottedObjectName('IPython.html.services.config.manager.ConfigManager',
633 config = True,
633 config = True,
634 help='The config manager class to use'
634 help='The config manager class to use'
635 )
635 )
636
636
637 kernel_spec_manager = Instance(KernelSpecManager)
637 kernel_spec_manager = Instance(KernelSpecManager)
638
638
639 def _kernel_spec_manager_default(self):
639 def _kernel_spec_manager_default(self):
640 return KernelSpecManager(ipython_dir=self.ipython_dir)
640 return KernelSpecManager(ipython_dir=self.ipython_dir)
641
641
642
643 kernel_spec_manager_class = DottedObjectName('IPython.kernel.kernelspec.KernelSpecManager',
642 kernel_spec_manager_class = DottedObjectName('IPython.kernel.kernelspec.KernelSpecManager',
644 config=True,
643 config=True,
645 help="""
644 help="""
646 The kernel spec manager class to use. Should be a subclass
645 The kernel spec manager class to use. Should be a subclass
647 of `IPython.kernel.kernelspec.KernelSpecManager`.
646 of `IPython.kernel.kernelspec.KernelSpecManager`.
648
647
649 The Api of KernelSpecManager is provisional and might change
648 The Api of KernelSpecManager is provisional and might change
650 without warning between this version of IPython and the next stable one.
649 without warning between this version of IPython and the next stable one.
651 """)
650 """)
652
651
652 login_handler = DottedObjectName('IPython.html.auth.login.LoginHandler',
653 config=True,
654 help='The login handler class to use.')
655
653 trust_xheaders = Bool(False, config=True,
656 trust_xheaders = Bool(False, config=True,
654 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
657 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
655 "sent by the upstream reverse proxy. Necessary if the proxy handles SSL")
658 "sent by the upstream reverse proxy. Necessary if the proxy handles SSL")
656 )
659 )
657
660
658 info_file = Unicode()
661 info_file = Unicode()
659
662
660 def _info_file_default(self):
663 def _info_file_default(self):
661 info_file = "nbserver-%s.json"%os.getpid()
664 info_file = "nbserver-%s.json"%os.getpid()
662 return os.path.join(self.profile_dir.security_dir, info_file)
665 return os.path.join(self.profile_dir.security_dir, info_file)
663
666
664 pylab = Unicode('disabled', config=True,
667 pylab = Unicode('disabled', config=True,
665 help="""
668 help="""
666 DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
669 DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
667 """
670 """
668 )
671 )
669 def _pylab_changed(self, name, old, new):
672 def _pylab_changed(self, name, old, new):
670 """when --pylab is specified, display a warning and exit"""
673 """when --pylab is specified, display a warning and exit"""
671 if new != 'warn':
674 if new != 'warn':
672 backend = ' %s' % new
675 backend = ' %s' % new
673 else:
676 else:
674 backend = ''
677 backend = ''
675 self.log.error("Support for specifying --pylab on the command line has been removed.")
678 self.log.error("Support for specifying --pylab on the command line has been removed.")
676 self.log.error(
679 self.log.error(
677 "Please use `%pylab{0}` or `%matplotlib{0}` in the notebook itself.".format(backend)
680 "Please use `%pylab{0}` or `%matplotlib{0}` in the notebook itself.".format(backend)
678 )
681 )
679 self.exit(1)
682 self.exit(1)
680
683
681 notebook_dir = Unicode(config=True,
684 notebook_dir = Unicode(config=True,
682 help="The directory to use for notebooks and kernels."
685 help="The directory to use for notebooks and kernels."
683 )
686 )
684
687
685 def _notebook_dir_default(self):
688 def _notebook_dir_default(self):
686 if self.file_to_run:
689 if self.file_to_run:
687 return os.path.dirname(os.path.abspath(self.file_to_run))
690 return os.path.dirname(os.path.abspath(self.file_to_run))
688 else:
691 else:
689 return py3compat.getcwd()
692 return py3compat.getcwd()
690
693
691 def _notebook_dir_changed(self, name, old, new):
694 def _notebook_dir_changed(self, name, old, new):
692 """Do a bit of validation of the notebook dir."""
695 """Do a bit of validation of the notebook dir."""
693 if not os.path.isabs(new):
696 if not os.path.isabs(new):
694 # If we receive a non-absolute path, make it absolute.
697 # If we receive a non-absolute path, make it absolute.
695 self.notebook_dir = os.path.abspath(new)
698 self.notebook_dir = os.path.abspath(new)
696 return
699 return
697 if not os.path.isdir(new):
700 if not os.path.isdir(new):
698 raise TraitError("No such notebook dir: %r" % new)
701 raise TraitError("No such notebook dir: %r" % new)
699
702
700 # setting App.notebook_dir implies setting notebook and kernel dirs as well
703 # setting App.notebook_dir implies setting notebook and kernel dirs as well
701 self.config.FileContentsManager.root_dir = new
704 self.config.FileContentsManager.root_dir = new
702 self.config.MappingKernelManager.root_dir = new
705 self.config.MappingKernelManager.root_dir = new
703
704
706
705 def parse_command_line(self, argv=None):
707 def parse_command_line(self, argv=None):
706 super(NotebookApp, self).parse_command_line(argv)
708 super(NotebookApp, self).parse_command_line(argv)
707
709
708 if self.extra_args:
710 if self.extra_args:
709 arg0 = self.extra_args[0]
711 arg0 = self.extra_args[0]
710 f = os.path.abspath(arg0)
712 f = os.path.abspath(arg0)
711 self.argv.remove(arg0)
713 self.argv.remove(arg0)
712 if not os.path.exists(f):
714 if not os.path.exists(f):
713 self.log.critical("No such file or directory: %s", f)
715 self.log.critical("No such file or directory: %s", f)
714 self.exit(1)
716 self.exit(1)
715
717
716 # Use config here, to ensure that it takes higher priority than
718 # Use config here, to ensure that it takes higher priority than
717 # anything that comes from the profile.
719 # anything that comes from the profile.
718 c = Config()
720 c = Config()
719 if os.path.isdir(f):
721 if os.path.isdir(f):
720 c.NotebookApp.notebook_dir = f
722 c.NotebookApp.notebook_dir = f
721 elif os.path.isfile(f):
723 elif os.path.isfile(f):
722 c.NotebookApp.file_to_run = f
724 c.NotebookApp.file_to_run = f
723 self.update_config(c)
725 self.update_config(c)
724
726
725 def init_kernel_argv(self):
727 def init_kernel_argv(self):
726 """add the profile-dir to arguments to be passed to IPython kernels"""
728 """add the profile-dir to arguments to be passed to IPython kernels"""
727 # FIXME: remove special treatment of IPython kernels
729 # FIXME: remove special treatment of IPython kernels
728 # Kernel should get *absolute* path to profile directory
730 # Kernel should get *absolute* path to profile directory
729 self.ipython_kernel_argv = ["--profile-dir", self.profile_dir.location]
731 self.ipython_kernel_argv = ["--profile-dir", self.profile_dir.location]
730
732
731 def init_configurables(self):
733 def init_configurables(self):
732 # force Session default to be secure
734 # force Session default to be secure
733 default_secure(self.config)
735 default_secure(self.config)
734 kls = import_item(self.kernel_spec_manager_class)
736 kls = import_item(self.kernel_spec_manager_class)
735 self.kernel_spec_manager = kls(ipython_dir=self.ipython_dir)
737 self.kernel_spec_manager = kls(ipython_dir=self.ipython_dir)
736
738
737 kls = import_item(self.kernel_manager_class)
739 kls = import_item(self.kernel_manager_class)
738 self.kernel_manager = kls(
740 self.kernel_manager = kls(
739 parent=self, log=self.log, ipython_kernel_argv=self.ipython_kernel_argv,
741 parent=self, log=self.log, ipython_kernel_argv=self.ipython_kernel_argv,
740 connection_dir = self.profile_dir.security_dir,
742 connection_dir = self.profile_dir.security_dir,
741 )
743 )
742 kls = import_item(self.contents_manager_class)
744 kls = import_item(self.contents_manager_class)
743 self.contents_manager = kls(parent=self, log=self.log)
745 self.contents_manager = kls(parent=self, log=self.log)
744 kls = import_item(self.session_manager_class)
746 kls = import_item(self.session_manager_class)
745 self.session_manager = kls(parent=self, log=self.log,
747 self.session_manager = kls(parent=self, log=self.log,
746 kernel_manager=self.kernel_manager,
748 kernel_manager=self.kernel_manager,
747 contents_manager=self.contents_manager)
749 contents_manager=self.contents_manager)
748 kls = import_item(self.cluster_manager_class)
750 kls = import_item(self.cluster_manager_class)
749 self.cluster_manager = kls(parent=self, log=self.log)
751 self.cluster_manager = kls(parent=self, log=self.log)
750 self.cluster_manager.update_profiles()
752 self.cluster_manager.update_profiles()
753 self.login_handler_class = import_item(self.login_handler)
751
754
752 kls = import_item(self.config_manager_class)
755 kls = import_item(self.config_manager_class)
753 self.config_manager = kls(parent=self, log=self.log,
756 self.config_manager = kls(parent=self, log=self.log,
754 profile_dir=self.profile_dir.location)
757 profile_dir=self.profile_dir.location)
755
758
756 def init_logging(self):
759 def init_logging(self):
757 # This prevents double log messages because tornado use a root logger that
760 # This prevents double log messages because tornado use a root logger that
758 # self.log is a child of. The logging module dipatches log messages to a log
761 # self.log is a child of. The logging module dipatches log messages to a log
759 # and all of its ancenstors until propagate is set to False.
762 # and all of its ancenstors until propagate is set to False.
760 self.log.propagate = False
763 self.log.propagate = False
761
764
762 for log in app_log, access_log, gen_log:
765 for log in app_log, access_log, gen_log:
763 # consistent log output name (NotebookApp instead of tornado.access, etc.)
766 # consistent log output name (NotebookApp instead of tornado.access, etc.)
764 log.name = self.log.name
767 log.name = self.log.name
765 # hook up tornado 3's loggers to our app handlers
768 # hook up tornado 3's loggers to our app handlers
766 logger = logging.getLogger('tornado')
769 logger = logging.getLogger('tornado')
767 logger.propagate = True
770 logger.propagate = True
768 logger.parent = self.log
771 logger.parent = self.log
769 logger.setLevel(self.log.level)
772 logger.setLevel(self.log.level)
770
773
771 def init_webapp(self):
774 def init_webapp(self):
772 """initialize tornado webapp and httpserver"""
775 """initialize tornado webapp and httpserver"""
773 self.tornado_settings['allow_origin'] = self.allow_origin
776 self.tornado_settings['allow_origin'] = self.allow_origin
774 if self.allow_origin_pat:
777 if self.allow_origin_pat:
775 self.tornado_settings['allow_origin_pat'] = re.compile(self.allow_origin_pat)
778 self.tornado_settings['allow_origin_pat'] = re.compile(self.allow_origin_pat)
776 self.tornado_settings['allow_credentials'] = self.allow_credentials
779 self.tornado_settings['allow_credentials'] = self.allow_credentials
777
780
778 self.web_app = NotebookWebApplication(
781 self.web_app = NotebookWebApplication(
779 self, self.kernel_manager, self.contents_manager,
782 self, self.kernel_manager, self.contents_manager,
780 self.cluster_manager, self.session_manager, self.kernel_spec_manager,
783 self.cluster_manager, self.session_manager, self.kernel_spec_manager,
781 self.config_manager,
784 self.config_manager,
782 self.log, self.base_url, self.default_url, self.tornado_settings,
785 self.log, self.base_url, self.default_url, self.tornado_settings,
783 self.jinja_environment_options
786 self.jinja_environment_options
784 )
787 )
785 if self.certfile:
788 if self.certfile:
786 ssl_options = dict(certfile=self.certfile)
789 ssl_options = dict(certfile=self.certfile)
787 if self.keyfile:
790 if self.keyfile:
788 ssl_options['keyfile'] = self.keyfile
791 ssl_options['keyfile'] = self.keyfile
789 else:
792 else:
790 ssl_options = None
793 ssl_options = None
791 self.web_app.password = self.password
794 self.login_handler_class.validate_notebook_app_security(self, ssl_options=ssl_options)
792 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
795 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
793 xheaders=self.trust_xheaders)
796 xheaders=self.trust_xheaders)
794 if not self.ip:
797
795 warning = "WARNING: The notebook server is listening on all IP addresses"
796 if ssl_options is None:
797 self.log.critical(warning + " and not using encryption. This "
798 "is not recommended.")
799 if not self.password:
800 self.log.critical(warning + " and not using authentication. "
801 "This is highly insecure and not recommended.")
802 success = None
798 success = None
803 for port in random_ports(self.port, self.port_retries+1):
799 for port in random_ports(self.port, self.port_retries+1):
804 try:
800 try:
805 self.http_server.listen(port, self.ip)
801 self.http_server.listen(port, self.ip)
806 except socket.error as e:
802 except socket.error as e:
807 if e.errno == errno.EADDRINUSE:
803 if e.errno == errno.EADDRINUSE:
808 self.log.info('The port %i is already in use, trying another random port.' % port)
804 self.log.info('The port %i is already in use, trying another random port.' % port)
809 continue
805 continue
810 elif e.errno in (errno.EACCES, getattr(errno, 'WSAEACCES', errno.EACCES)):
806 elif e.errno in (errno.EACCES, getattr(errno, 'WSAEACCES', errno.EACCES)):
811 self.log.warn("Permission to listen on port %i denied" % port)
807 self.log.warn("Permission to listen on port %i denied" % port)
812 continue
808 continue
813 else:
809 else:
814 raise
810 raise
815 else:
811 else:
816 self.port = port
812 self.port = port
817 success = True
813 success = True
818 break
814 break
819 if not success:
815 if not success:
820 self.log.critical('ERROR: the notebook server could not be started because '
816 self.log.critical('ERROR: the notebook server could not be started because '
821 'no available port could be found.')
817 'no available port could be found.')
822 self.exit(1)
818 self.exit(1)
823
819
824 @property
820 @property
825 def display_url(self):
821 def display_url(self):
826 ip = self.ip if self.ip else '[all ip addresses on your system]'
822 ip = self.ip if self.ip else '[all ip addresses on your system]'
827 return self._url(ip)
823 return self._url(ip)
828
824
829 @property
825 @property
830 def connection_url(self):
826 def connection_url(self):
831 ip = self.ip if self.ip else 'localhost'
827 ip = self.ip if self.ip else 'localhost'
832 return self._url(ip)
828 return self._url(ip)
833
829
834 def _url(self, ip):
830 def _url(self, ip):
835 proto = 'https' if self.certfile else 'http'
831 proto = 'https' if self.certfile else 'http'
836 return "%s://%s:%i%s" % (proto, ip, self.port, self.base_url)
832 return "%s://%s:%i%s" % (proto, ip, self.port, self.base_url)
837
833
838 def init_terminals(self):
834 def init_terminals(self):
839 try:
835 try:
840 from .terminal import initialize
836 from .terminal import initialize
841 initialize(self.web_app)
837 initialize(self.web_app)
842 self.web_app.settings['terminals_available'] = True
838 self.web_app.settings['terminals_available'] = True
843 except ImportError as e:
839 except ImportError as e:
844 self.log.info("Terminals not available (error was %s)", e)
840 self.log.info("Terminals not available (error was %s)", e)
845
841
846 def init_signal(self):
842 def init_signal(self):
847 if not sys.platform.startswith('win'):
843 if not sys.platform.startswith('win'):
848 signal.signal(signal.SIGINT, self._handle_sigint)
844 signal.signal(signal.SIGINT, self._handle_sigint)
849 signal.signal(signal.SIGTERM, self._signal_stop)
845 signal.signal(signal.SIGTERM, self._signal_stop)
850 if hasattr(signal, 'SIGUSR1'):
846 if hasattr(signal, 'SIGUSR1'):
851 # Windows doesn't support SIGUSR1
847 # Windows doesn't support SIGUSR1
852 signal.signal(signal.SIGUSR1, self._signal_info)
848 signal.signal(signal.SIGUSR1, self._signal_info)
853 if hasattr(signal, 'SIGINFO'):
849 if hasattr(signal, 'SIGINFO'):
854 # only on BSD-based systems
850 # only on BSD-based systems
855 signal.signal(signal.SIGINFO, self._signal_info)
851 signal.signal(signal.SIGINFO, self._signal_info)
856
852
857 def _handle_sigint(self, sig, frame):
853 def _handle_sigint(self, sig, frame):
858 """SIGINT handler spawns confirmation dialog"""
854 """SIGINT handler spawns confirmation dialog"""
859 # register more forceful signal handler for ^C^C case
855 # register more forceful signal handler for ^C^C case
860 signal.signal(signal.SIGINT, self._signal_stop)
856 signal.signal(signal.SIGINT, self._signal_stop)
861 # request confirmation dialog in bg thread, to avoid
857 # request confirmation dialog in bg thread, to avoid
862 # blocking the App
858 # blocking the App
863 thread = threading.Thread(target=self._confirm_exit)
859 thread = threading.Thread(target=self._confirm_exit)
864 thread.daemon = True
860 thread.daemon = True
865 thread.start()
861 thread.start()
866
862
867 def _restore_sigint_handler(self):
863 def _restore_sigint_handler(self):
868 """callback for restoring original SIGINT handler"""
864 """callback for restoring original SIGINT handler"""
869 signal.signal(signal.SIGINT, self._handle_sigint)
865 signal.signal(signal.SIGINT, self._handle_sigint)
870
866
871 def _confirm_exit(self):
867 def _confirm_exit(self):
872 """confirm shutdown on ^C
868 """confirm shutdown on ^C
873
869
874 A second ^C, or answering 'y' within 5s will cause shutdown,
870 A second ^C, or answering 'y' within 5s will cause shutdown,
875 otherwise original SIGINT handler will be restored.
871 otherwise original SIGINT handler will be restored.
876
872
877 This doesn't work on Windows.
873 This doesn't work on Windows.
878 """
874 """
879 info = self.log.info
875 info = self.log.info
880 info('interrupted')
876 info('interrupted')
881 print(self.notebook_info())
877 print(self.notebook_info())
882 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
878 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
883 sys.stdout.flush()
879 sys.stdout.flush()
884 r,w,x = select.select([sys.stdin], [], [], 5)
880 r,w,x = select.select([sys.stdin], [], [], 5)
885 if r:
881 if r:
886 line = sys.stdin.readline()
882 line = sys.stdin.readline()
887 if line.lower().startswith('y') and 'n' not in line.lower():
883 if line.lower().startswith('y') and 'n' not in line.lower():
888 self.log.critical("Shutdown confirmed")
884 self.log.critical("Shutdown confirmed")
889 ioloop.IOLoop.instance().stop()
885 ioloop.IOLoop.instance().stop()
890 return
886 return
891 else:
887 else:
892 print("No answer for 5s:", end=' ')
888 print("No answer for 5s:", end=' ')
893 print("resuming operation...")
889 print("resuming operation...")
894 # no answer, or answer is no:
890 # no answer, or answer is no:
895 # set it back to original SIGINT handler
891 # set it back to original SIGINT handler
896 # use IOLoop.add_callback because signal.signal must be called
892 # use IOLoop.add_callback because signal.signal must be called
897 # from main thread
893 # from main thread
898 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
894 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
899
895
900 def _signal_stop(self, sig, frame):
896 def _signal_stop(self, sig, frame):
901 self.log.critical("received signal %s, stopping", sig)
897 self.log.critical("received signal %s, stopping", sig)
902 ioloop.IOLoop.instance().stop()
898 ioloop.IOLoop.instance().stop()
903
899
904 def _signal_info(self, sig, frame):
900 def _signal_info(self, sig, frame):
905 print(self.notebook_info())
901 print(self.notebook_info())
906
902
907 def init_components(self):
903 def init_components(self):
908 """Check the components submodule, and warn if it's unclean"""
904 """Check the components submodule, and warn if it's unclean"""
909 status = submodule.check_submodule_status()
905 status = submodule.check_submodule_status()
910 if status == 'missing':
906 if status == 'missing':
911 self.log.warn("components submodule missing, running `git submodule update`")
907 self.log.warn("components submodule missing, running `git submodule update`")
912 submodule.update_submodules(submodule.ipython_parent())
908 submodule.update_submodules(submodule.ipython_parent())
913 elif status == 'unclean':
909 elif status == 'unclean':
914 self.log.warn("components submodule unclean, you may see 404s on static/components")
910 self.log.warn("components submodule unclean, you may see 404s on static/components")
915 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
911 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
916
912
917 @catch_config_error
913 @catch_config_error
918 def initialize(self, argv=None):
914 def initialize(self, argv=None):
919 super(NotebookApp, self).initialize(argv)
915 super(NotebookApp, self).initialize(argv)
920 self.init_logging()
916 self.init_logging()
921 self.init_kernel_argv()
917 self.init_kernel_argv()
922 self.init_configurables()
918 self.init_configurables()
923 self.init_components()
919 self.init_components()
924 self.init_webapp()
920 self.init_webapp()
925 self.init_terminals()
921 self.init_terminals()
926 self.init_signal()
922 self.init_signal()
927
923
928 def cleanup_kernels(self):
924 def cleanup_kernels(self):
929 """Shutdown all kernels.
925 """Shutdown all kernels.
930
926
931 The kernels will shutdown themselves when this process no longer exists,
927 The kernels will shutdown themselves when this process no longer exists,
932 but explicit shutdown allows the KernelManagers to cleanup the connection files.
928 but explicit shutdown allows the KernelManagers to cleanup the connection files.
933 """
929 """
934 self.log.info('Shutting down kernels')
930 self.log.info('Shutting down kernels')
935 self.kernel_manager.shutdown_all()
931 self.kernel_manager.shutdown_all()
936
932
937 def notebook_info(self):
933 def notebook_info(self):
938 "Return the current working directory and the server url information"
934 "Return the current working directory and the server url information"
939 info = self.contents_manager.info_string() + "\n"
935 info = self.contents_manager.info_string() + "\n"
940 info += "%d active kernels \n" % len(self.kernel_manager._kernels)
936 info += "%d active kernels \n" % len(self.kernel_manager._kernels)
941 return info + "The IPython Notebook is running at: %s" % self.display_url
937 return info + "The IPython Notebook is running at: %s" % self.display_url
942
938
943 def server_info(self):
939 def server_info(self):
944 """Return a JSONable dict of information about this server."""
940 """Return a JSONable dict of information about this server."""
945 return {'url': self.connection_url,
941 return {'url': self.connection_url,
946 'hostname': self.ip if self.ip else 'localhost',
942 'hostname': self.ip if self.ip else 'localhost',
947 'port': self.port,
943 'port': self.port,
948 'secure': bool(self.certfile),
944 'secure': bool(self.certfile),
949 'base_url': self.base_url,
945 'base_url': self.base_url,
950 'notebook_dir': os.path.abspath(self.notebook_dir),
946 'notebook_dir': os.path.abspath(self.notebook_dir),
951 'pid': os.getpid()
947 'pid': os.getpid()
952 }
948 }
953
949
954 def write_server_info_file(self):
950 def write_server_info_file(self):
955 """Write the result of server_info() to the JSON file info_file."""
951 """Write the result of server_info() to the JSON file info_file."""
956 with open(self.info_file, 'w') as f:
952 with open(self.info_file, 'w') as f:
957 json.dump(self.server_info(), f, indent=2)
953 json.dump(self.server_info(), f, indent=2)
958
954
959 def remove_server_info_file(self):
955 def remove_server_info_file(self):
960 """Remove the nbserver-<pid>.json file created for this server.
956 """Remove the nbserver-<pid>.json file created for this server.
961
957
962 Ignores the error raised when the file has already been removed.
958 Ignores the error raised when the file has already been removed.
963 """
959 """
964 try:
960 try:
965 os.unlink(self.info_file)
961 os.unlink(self.info_file)
966 except OSError as e:
962 except OSError as e:
967 if e.errno != errno.ENOENT:
963 if e.errno != errno.ENOENT:
968 raise
964 raise
969
965
970 def start(self):
966 def start(self):
971 """ Start the IPython Notebook server app, after initialization
967 """ Start the IPython Notebook server app, after initialization
972
968
973 This method takes no arguments so all configuration and initialization
969 This method takes no arguments so all configuration and initialization
974 must be done prior to calling this method."""
970 must be done prior to calling this method."""
975 if self.subapp is not None:
971 if self.subapp is not None:
976 return self.subapp.start()
972 return self.subapp.start()
977
973
978 info = self.log.info
974 info = self.log.info
979 for line in self.notebook_info().split("\n"):
975 for line in self.notebook_info().split("\n"):
980 info(line)
976 info(line)
981 info("Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).")
977 info("Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).")
982
978
983 self.write_server_info_file()
979 self.write_server_info_file()
984
980
985 if self.open_browser or self.file_to_run:
981 if self.open_browser or self.file_to_run:
986 try:
982 try:
987 browser = webbrowser.get(self.browser or None)
983 browser = webbrowser.get(self.browser or None)
988 except webbrowser.Error as e:
984 except webbrowser.Error as e:
989 self.log.warn('No web browser found: %s.' % e)
985 self.log.warn('No web browser found: %s.' % e)
990 browser = None
986 browser = None
991
987
992 if self.file_to_run:
988 if self.file_to_run:
993 if not os.path.exists(self.file_to_run):
989 if not os.path.exists(self.file_to_run):
994 self.log.critical("%s does not exist" % self.file_to_run)
990 self.log.critical("%s does not exist" % self.file_to_run)
995 self.exit(1)
991 self.exit(1)
996
992
997 relpath = os.path.relpath(self.file_to_run, self.notebook_dir)
993 relpath = os.path.relpath(self.file_to_run, self.notebook_dir)
998 uri = url_path_join('notebooks', *relpath.split(os.sep))
994 uri = url_path_join('notebooks', *relpath.split(os.sep))
999 else:
995 else:
1000 uri = 'tree'
996 uri = 'tree'
1001 if browser:
997 if browser:
1002 b = lambda : browser.open(url_path_join(self.connection_url, uri),
998 b = lambda : browser.open(url_path_join(self.connection_url, uri),
1003 new=2)
999 new=2)
1004 threading.Thread(target=b).start()
1000 threading.Thread(target=b).start()
1005 try:
1001 try:
1006 ioloop.IOLoop.instance().start()
1002 ioloop.IOLoop.instance().start()
1007 except KeyboardInterrupt:
1003 except KeyboardInterrupt:
1008 info("Interrupted...")
1004 info("Interrupted...")
1009 finally:
1005 finally:
1010 self.cleanup_kernels()
1006 self.cleanup_kernels()
1011 self.remove_server_info_file()
1007 self.remove_server_info_file()
1012
1008
1013
1009
1014 def list_running_servers(profile='default'):
1010 def list_running_servers(profile='default'):
1015 """Iterate over the server info files of running notebook servers.
1011 """Iterate over the server info files of running notebook servers.
1016
1012
1017 Given a profile name, find nbserver-* files in the security directory of
1013 Given a profile name, find nbserver-* files in the security directory of
1018 that profile, and yield dicts of their information, each one pertaining to
1014 that profile, and yield dicts of their information, each one pertaining to
1019 a currently running notebook server instance.
1015 a currently running notebook server instance.
1020 """
1016 """
1021 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), name=profile)
1017 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), name=profile)
1022 for file in os.listdir(pd.security_dir):
1018 for file in os.listdir(pd.security_dir):
1023 if file.startswith('nbserver-'):
1019 if file.startswith('nbserver-'):
1024 with io.open(os.path.join(pd.security_dir, file), encoding='utf-8') as f:
1020 with io.open(os.path.join(pd.security_dir, file), encoding='utf-8') as f:
1025 info = json.load(f)
1021 info = json.load(f)
1026
1022
1027 # Simple check whether that process is really still running
1023 # Simple check whether that process is really still running
1028 # Also remove leftover files from IPython 2.x without a pid field
1024 # Also remove leftover files from IPython 2.x without a pid field
1029 if ('pid' in info) and check_pid(info['pid']):
1025 if ('pid' in info) and check_pid(info['pid']):
1030 yield info
1026 yield info
1031 else:
1027 else:
1032 # If the process has died, try to delete its info file
1028 # If the process has died, try to delete its info file
1033 try:
1029 try:
1034 os.unlink(file)
1030 os.unlink(file)
1035 except OSError:
1031 except OSError:
1036 pass # TODO: This should warn or log or something
1032 pass # TODO: This should warn or log or something
1037 #-----------------------------------------------------------------------------
1033 #-----------------------------------------------------------------------------
1038 # Main entry point
1034 # Main entry point
1039 #-----------------------------------------------------------------------------
1035 #-----------------------------------------------------------------------------
1040
1036
1041 launch_new_instance = NotebookApp.launch_instance
1037 launch_new_instance = NotebookApp.launch_instance
1042
1038
General Comments 0
You need to be logged in to leave comments. Login now