##// END OF EJS Templates
Merge pull request #3373 from minrk/cookiesecret...
Matthias Bussonnier -
r10864:f57d5c77 merge
parent child Browse files
Show More
@@ -1,741 +1,753
1 1 # coding: utf-8
2 2 """A tornado based IPython notebook server.
3 3
4 4 Authors:
5 5
6 6 * Brian Granger
7 7 """
8 8 #-----------------------------------------------------------------------------
9 9 # Copyright (C) 2013 The IPython Development Team
10 10 #
11 11 # Distributed under the terms of the BSD License. The full license is in
12 12 # the file COPYING, distributed as part of this software.
13 13 #-----------------------------------------------------------------------------
14 14
15 15 #-----------------------------------------------------------------------------
16 16 # Imports
17 17 #-----------------------------------------------------------------------------
18 18
19 19 # stdlib
20 20 import errno
21 21 import logging
22 22 import os
23 23 import random
24 24 import select
25 25 import signal
26 26 import socket
27 27 import sys
28 28 import threading
29 29 import time
30 30 import uuid
31 31 import webbrowser
32 32
33 33
34 34 # Third party
35 35 # check for pyzmq 2.1.11
36 36 from IPython.utils.zmqrelated import check_for_zmq
37 37 check_for_zmq('2.1.11', 'IPython.frontend.html.notebook')
38 38
39 39 import zmq
40 40 from jinja2 import Environment, FileSystemLoader
41 41
42 42 # Install the pyzmq ioloop. This has to be done before anything else from
43 43 # tornado is imported.
44 44 from zmq.eventloop import ioloop
45 45 ioloop.install()
46 46
47 47 # check for tornado 2.1.0
48 48 msg = "The IPython Notebook requires tornado >= 2.1.0"
49 49 try:
50 50 import tornado
51 51 except ImportError:
52 52 raise ImportError(msg)
53 53 try:
54 54 version_info = tornado.version_info
55 55 except AttributeError:
56 56 raise ImportError(msg + ", but you have < 1.1.0")
57 57 if version_info < (2,1,0):
58 58 raise ImportError(msg + ", but you have %s" % tornado.version)
59 59
60 60 from tornado import httpserver
61 61 from tornado import web
62 62
63 63 # Our own libraries
64 64 from IPython.frontend.html.notebook import DEFAULT_STATIC_FILES_PATH
65 65
66 66 from .services.kernels.kernelmanager import MappingKernelManager
67 67 from .services.notebooks.nbmanager import NotebookManager
68 68 from .services.notebooks.filenbmanager import FileNotebookManager
69 69 from .services.clusters.clustermanager import ClusterManager
70 70
71 71 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
72 72
73 73 from IPython.config.application import catch_config_error, boolean_flag
74 74 from IPython.core.application import BaseIPythonApplication
75 75 from IPython.frontend.consoleapp import IPythonConsoleApp
76 76 from IPython.kernel import swallow_argv
77 77 from IPython.kernel.zmq.session import default_secure
78 78 from IPython.kernel.zmq.kernelapp import (
79 79 kernel_flags,
80 80 kernel_aliases,
81 81 )
82 82 from IPython.utils.importstring import import_item
83 83 from IPython.utils.localinterfaces import LOCALHOST
84 84 from IPython.utils import submodule
85 85 from IPython.utils.traitlets import (
86 Dict, Unicode, Integer, List, Bool,
86 Dict, Unicode, Integer, List, Bool, Bytes,
87 87 DottedObjectName
88 88 )
89 89 from IPython.utils import py3compat
90 90 from IPython.utils.path import filefind
91 91
92 92 from .utils import url_path_join
93 93
94 94 #-----------------------------------------------------------------------------
95 95 # Module globals
96 96 #-----------------------------------------------------------------------------
97 97
98 98 _examples = """
99 99 ipython notebook # start the notebook
100 100 ipython notebook --profile=sympy # use the sympy profile
101 101 ipython notebook --pylab=inline # pylab in inline plotting mode
102 102 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
103 103 ipython notebook --port=5555 --ip=* # Listen on port 5555, all interfaces
104 104 """
105 105
106 106 #-----------------------------------------------------------------------------
107 107 # Helper functions
108 108 #-----------------------------------------------------------------------------
109 109
110 110 def random_ports(port, n):
111 111 """Generate a list of n random ports near the given port.
112 112
113 113 The first 5 ports will be sequential, and the remaining n-5 will be
114 114 randomly selected in the range [port-2*n, port+2*n].
115 115 """
116 116 for i in range(min(5, n)):
117 117 yield port + i
118 118 for i in range(n-5):
119 119 yield port + random.randint(-2*n, 2*n)
120 120
121 121 def load_handlers(name):
122 122 """Load the (URL pattern, handler) tuples for each component."""
123 123 name = 'IPython.frontend.html.notebook.' + name
124 124 mod = __import__(name, fromlist=['default_handlers'])
125 125 return mod.default_handlers
126 126
127 127 #-----------------------------------------------------------------------------
128 128 # The Tornado web application
129 129 #-----------------------------------------------------------------------------
130 130
131 131 class NotebookWebApplication(web.Application):
132 132
133 133 def __init__(self, ipython_app, kernel_manager, notebook_manager,
134 134 cluster_manager, log,
135 135 base_project_url, settings_overrides):
136 136
137 137 settings = self.init_settings(
138 138 ipython_app, kernel_manager, notebook_manager, cluster_manager,
139 139 log, base_project_url, settings_overrides)
140 140 handlers = self.init_handlers(settings)
141 141
142 142 super(NotebookWebApplication, self).__init__(handlers, **settings)
143 143
144 144 def init_settings(self, ipython_app, kernel_manager, notebook_manager,
145 145 cluster_manager, log,
146 146 base_project_url, settings_overrides):
147 147 # Python < 2.6.5 doesn't accept unicode keys in f(**kwargs), and
148 148 # base_project_url will always be unicode, which will in turn
149 149 # make the patterns unicode, and ultimately result in unicode
150 150 # keys in kwargs to handler._execute(**kwargs) in tornado.
151 151 # This enforces that base_project_url be ascii in that situation.
152 152 #
153 153 # Note that the URLs these patterns check against are escaped,
154 154 # and thus guaranteed to be ASCII: 'héllo' is really 'h%C3%A9llo'.
155 155 base_project_url = py3compat.unicode_to_str(base_project_url, 'ascii')
156 156 template_path = os.path.join(os.path.dirname(__file__), "templates")
157 157 settings = dict(
158 158 # basics
159 159 base_project_url=base_project_url,
160 160 base_kernel_url=ipython_app.base_kernel_url,
161 161 template_path=template_path,
162 162 static_path=ipython_app.static_file_path,
163 163 static_handler_class = FileFindHandler,
164 164 static_url_prefix = url_path_join(base_project_url,'/static/'),
165 165
166 166 # authentication
167 cookie_secret=os.urandom(1024),
167 cookie_secret=ipython_app.cookie_secret,
168 168 login_url=url_path_join(base_project_url,'/login'),
169 169 read_only=ipython_app.read_only,
170 170 password=ipython_app.password,
171 171
172 172 # managers
173 173 kernel_manager=kernel_manager,
174 174 notebook_manager=notebook_manager,
175 175 cluster_manager=cluster_manager,
176 176
177 177 # IPython stuff
178 178 mathjax_url=ipython_app.mathjax_url,
179 179 max_msg_size=ipython_app.max_msg_size,
180 180 config=ipython_app.config,
181 181 use_less=ipython_app.use_less,
182 182 jinja2_env=Environment(loader=FileSystemLoader(template_path)),
183 183 )
184 184
185 185 # allow custom overrides for the tornado web app.
186 186 settings.update(settings_overrides)
187 187 return settings
188 188
189 189 def init_handlers(self, settings):
190 190 # Load the (URL pattern, handler) tuples for each component.
191 191 handlers = []
192 192 handlers.extend(load_handlers('base.handlers'))
193 193 handlers.extend(load_handlers('tree.handlers'))
194 194 handlers.extend(load_handlers('auth.login'))
195 195 handlers.extend(load_handlers('auth.logout'))
196 196 handlers.extend(load_handlers('notebook.handlers'))
197 197 handlers.extend(load_handlers('services.kernels.handlers'))
198 198 handlers.extend(load_handlers('services.notebooks.handlers'))
199 199 handlers.extend(load_handlers('services.clusters.handlers'))
200 200 handlers.extend([
201 201 (r"/files/(.*)", AuthenticatedFileHandler, {'path' : settings['notebook_manager'].notebook_dir}),
202 202 ])
203 203 # prepend base_project_url onto the patterns that we match
204 204 new_handlers = []
205 205 for handler in handlers:
206 206 pattern = url_path_join(settings['base_project_url'], handler[0])
207 207 new_handler = tuple([pattern] + list(handler[1:]))
208 208 new_handlers.append(new_handler)
209 209 return new_handlers
210 210
211 211
212 212
213 213 #-----------------------------------------------------------------------------
214 214 # Aliases and Flags
215 215 #-----------------------------------------------------------------------------
216 216
217 217 flags = dict(kernel_flags)
218 218 flags['no-browser']=(
219 219 {'NotebookApp' : {'open_browser' : False}},
220 220 "Don't open the notebook in a browser after startup."
221 221 )
222 222 flags['no-mathjax']=(
223 223 {'NotebookApp' : {'enable_mathjax' : False}},
224 224 """Disable MathJax
225 225
226 226 MathJax is the javascript library IPython uses to render math/LaTeX. It is
227 227 very large, so you may want to disable it if you have a slow internet
228 228 connection, or for offline use of the notebook.
229 229
230 230 When disabled, equations etc. will appear as their untransformed TeX source.
231 231 """
232 232 )
233 233 flags['read-only'] = (
234 234 {'NotebookApp' : {'read_only' : True}},
235 235 """Allow read-only access to notebooks.
236 236
237 237 When using a password to protect the notebook server, this flag
238 238 allows unauthenticated clients to view the notebook list, and
239 239 individual notebooks, but not edit them, start kernels, or run
240 240 code.
241 241
242 242 If no password is set, the server will be entirely read-only.
243 243 """
244 244 )
245 245
246 246 # Add notebook manager flags
247 247 flags.update(boolean_flag('script', 'FileNotebookManager.save_script',
248 248 'Auto-save a .py script everytime the .ipynb notebook is saved',
249 249 'Do not auto-save .py scripts for every notebook'))
250 250
251 251 # the flags that are specific to the frontend
252 252 # these must be scrubbed before being passed to the kernel,
253 253 # or it will raise an error on unrecognized flags
254 254 notebook_flags = ['no-browser', 'no-mathjax', 'read-only', 'script', 'no-script']
255 255
256 256 aliases = dict(kernel_aliases)
257 257
258 258 aliases.update({
259 259 'ip': 'NotebookApp.ip',
260 260 'port': 'NotebookApp.port',
261 261 'port-retries': 'NotebookApp.port_retries',
262 262 'transport': 'KernelManager.transport',
263 263 'keyfile': 'NotebookApp.keyfile',
264 264 'certfile': 'NotebookApp.certfile',
265 265 'notebook-dir': 'NotebookManager.notebook_dir',
266 266 'browser': 'NotebookApp.browser',
267 267 })
268 268
269 269 # remove ipkernel flags that are singletons, and don't make sense in
270 270 # multi-kernel evironment:
271 271 aliases.pop('f', None)
272 272
273 273 notebook_aliases = [u'port', u'port-retries', u'ip', u'keyfile', u'certfile',
274 274 u'notebook-dir']
275 275
276 276 #-----------------------------------------------------------------------------
277 277 # NotebookApp
278 278 #-----------------------------------------------------------------------------
279 279
280 280 class NotebookApp(BaseIPythonApplication):
281 281
282 282 name = 'ipython-notebook'
283 283 default_config_file_name='ipython_notebook_config.py'
284 284
285 285 description = """
286 286 The IPython HTML Notebook.
287 287
288 288 This launches a Tornado based HTML Notebook Server that serves up an
289 289 HTML5/Javascript Notebook client.
290 290 """
291 291 examples = _examples
292 292
293 293 classes = IPythonConsoleApp.classes + [MappingKernelManager, NotebookManager,
294 294 FileNotebookManager]
295 295 flags = Dict(flags)
296 296 aliases = Dict(aliases)
297 297
298 298 kernel_argv = List(Unicode)
299 299
300 300 max_msg_size = Integer(65536, config=True, help="""
301 301 The max raw message size accepted from the browser
302 302 over a WebSocket connection.
303 303 """)
304 304
305 305 def _log_level_default(self):
306 306 return logging.INFO
307 307
308 308 def _log_format_default(self):
309 309 """override default log format to include time"""
310 310 return u"%(asctime)s.%(msecs).03d [%(name)s]%(highlevel)s %(message)s"
311 311
312 312 # create requested profiles by default, if they don't exist:
313 313 auto_create = Bool(True)
314 314
315 315 # file to be opened in the notebook server
316 316 file_to_run = Unicode('')
317 317
318 318 # Network related information.
319 319
320 320 ip = Unicode(LOCALHOST, config=True,
321 321 help="The IP address the notebook server will listen on."
322 322 )
323 323
324 324 def _ip_changed(self, name, old, new):
325 325 if new == u'*': self.ip = u''
326 326
327 327 port = Integer(8888, config=True,
328 328 help="The port the notebook server will listen on."
329 329 )
330 330 port_retries = Integer(50, config=True,
331 331 help="The number of additional ports to try if the specified port is not available."
332 332 )
333 333
334 334 certfile = Unicode(u'', config=True,
335 335 help="""The full path to an SSL/TLS certificate file."""
336 336 )
337 337
338 338 keyfile = Unicode(u'', config=True,
339 339 help="""The full path to a private key file for usage with SSL/TLS."""
340 340 )
341
342 cookie_secret = Bytes(b'', config=True,
343 help="""The random bytes used to secure cookies.
344 By default this is a new random number every time you start the Notebook.
345 Set it to a value in a config file to enable logins to persist across server sessions.
346
347 Note: Cookie secrets should be kept private, do not share config files with
348 cookie_secret stored in plaintext (you can read the value from a file).
349 """
350 )
351 def _cookie_secret_default(self):
352 return os.urandom(1024)
341 353
342 354 password = Unicode(u'', config=True,
343 355 help="""Hashed password to use for web authentication.
344 356
345 357 To generate, type in a python/IPython shell:
346 358
347 359 from IPython.lib import passwd; passwd()
348 360
349 361 The string should be of the form type:salt:hashed-password.
350 362 """
351 363 )
352 364
353 365 open_browser = Bool(True, config=True,
354 366 help="""Whether to open in a browser after starting.
355 367 The specific browser used is platform dependent and
356 368 determined by the python standard library `webbrowser`
357 369 module, unless it is overridden using the --browser
358 370 (NotebookApp.browser) configuration option.
359 371 """)
360 372
361 373 browser = Unicode(u'', config=True,
362 374 help="""Specify what command to use to invoke a web
363 375 browser when opening the notebook. If not specified, the
364 376 default browser will be determined by the `webbrowser`
365 377 standard library module, which allows setting of the
366 378 BROWSER environment variable to override it.
367 379 """)
368 380
369 381 read_only = Bool(False, config=True,
370 382 help="Whether to prevent editing/execution of notebooks."
371 383 )
372 384
373 385 use_less = Bool(False, config=True,
374 386 help="""Wether to use Browser Side less-css parsing
375 387 instead of compiled css version in templates that allows
376 388 it. This is mainly convenient when working on the less
377 389 file to avoid a build step, or if user want to overwrite
378 390 some of the less variables without having to recompile
379 391 everything.
380 392
381 393 You will need to install the less.js component in the static directory
382 394 either in the source tree or in your profile folder.
383 395 """)
384 396
385 397 webapp_settings = Dict(config=True,
386 398 help="Supply overrides for the tornado.web.Application that the "
387 399 "IPython notebook uses.")
388 400
389 401 enable_mathjax = Bool(True, config=True,
390 402 help="""Whether to enable MathJax for typesetting math/TeX
391 403
392 404 MathJax is the javascript library IPython uses to render math/LaTeX. It is
393 405 very large, so you may want to disable it if you have a slow internet
394 406 connection, or for offline use of the notebook.
395 407
396 408 When disabled, equations etc. will appear as their untransformed TeX source.
397 409 """
398 410 )
399 411 def _enable_mathjax_changed(self, name, old, new):
400 412 """set mathjax url to empty if mathjax is disabled"""
401 413 if not new:
402 414 self.mathjax_url = u''
403 415
404 416 base_project_url = Unicode('/', config=True,
405 417 help='''The base URL for the notebook server.
406 418
407 419 Leading and trailing slashes can be omitted,
408 420 and will automatically be added.
409 421 ''')
410 422 def _base_project_url_changed(self, name, old, new):
411 423 if not new.startswith('/'):
412 424 self.base_project_url = '/'+new
413 425 elif not new.endswith('/'):
414 426 self.base_project_url = new+'/'
415 427
416 428 base_kernel_url = Unicode('/', config=True,
417 429 help='''The base URL for the kernel server
418 430
419 431 Leading and trailing slashes can be omitted,
420 432 and will automatically be added.
421 433 ''')
422 434 def _base_kernel_url_changed(self, name, old, new):
423 435 if not new.startswith('/'):
424 436 self.base_kernel_url = '/'+new
425 437 elif not new.endswith('/'):
426 438 self.base_kernel_url = new+'/'
427 439
428 440 websocket_url = Unicode("", config=True,
429 441 help="""The base URL for the websocket server,
430 442 if it differs from the HTTP server (hint: it almost certainly doesn't).
431 443
432 444 Should be in the form of an HTTP origin: ws[s]://hostname[:port]
433 445 """
434 446 )
435 447
436 448 extra_static_paths = List(Unicode, config=True,
437 449 help="""Extra paths to search for serving static files.
438 450
439 451 This allows adding javascript/css to be available from the notebook server machine,
440 452 or overriding individual files in the IPython"""
441 453 )
442 454 def _extra_static_paths_default(self):
443 455 return [os.path.join(self.profile_dir.location, 'static')]
444 456
445 457 @property
446 458 def static_file_path(self):
447 459 """return extra paths + the default location"""
448 460 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
449 461
450 462 mathjax_url = Unicode("", config=True,
451 463 help="""The url for MathJax.js."""
452 464 )
453 465 def _mathjax_url_default(self):
454 466 if not self.enable_mathjax:
455 467 return u''
456 468 static_url_prefix = self.webapp_settings.get("static_url_prefix",
457 469 "/static/")
458 470 try:
459 471 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), self.static_file_path)
460 472 except IOError:
461 473 if self.certfile:
462 474 # HTTPS: load from Rackspace CDN, because SSL certificate requires it
463 475 base = u"https://c328740.ssl.cf1.rackcdn.com"
464 476 else:
465 477 base = u"http://cdn.mathjax.org"
466 478
467 479 url = base + u"/mathjax/latest/MathJax.js"
468 480 self.log.info("Using MathJax from CDN: %s", url)
469 481 return url
470 482 else:
471 483 self.log.info("Using local MathJax from %s" % mathjax)
472 484 return static_url_prefix+u"mathjax/MathJax.js"
473 485
474 486 def _mathjax_url_changed(self, name, old, new):
475 487 if new and not self.enable_mathjax:
476 488 # enable_mathjax=False overrides mathjax_url
477 489 self.mathjax_url = u''
478 490 else:
479 491 self.log.info("Using MathJax: %s", new)
480 492
481 493 notebook_manager_class = DottedObjectName('IPython.frontend.html.notebook.services.notebooks.filenbmanager.FileNotebookManager',
482 494 config=True,
483 495 help='The notebook manager class to use.')
484 496
485 497 trust_xheaders = Bool(False, config=True,
486 498 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
487 499 "sent by the upstream reverse proxy. Neccesary if the proxy handles SSL")
488 500 )
489 501
490 502 def parse_command_line(self, argv=None):
491 503 super(NotebookApp, self).parse_command_line(argv)
492 504 if argv is None:
493 505 argv = sys.argv[1:]
494 506
495 507 # Scrub frontend-specific flags
496 508 self.kernel_argv = swallow_argv(argv, notebook_aliases, notebook_flags)
497 509 # Kernel should inherit default config file from frontend
498 510 self.kernel_argv.append("--IPKernelApp.parent_appname='%s'" % self.name)
499 511
500 512 if self.extra_args:
501 513 f = os.path.abspath(self.extra_args[0])
502 514 if os.path.isdir(f):
503 515 nbdir = f
504 516 else:
505 517 self.file_to_run = f
506 518 nbdir = os.path.dirname(f)
507 519 self.config.NotebookManager.notebook_dir = nbdir
508 520
509 521 def init_configurables(self):
510 522 # force Session default to be secure
511 523 default_secure(self.config)
512 524 self.kernel_manager = MappingKernelManager(
513 525 config=self.config, log=self.log, kernel_argv=self.kernel_argv,
514 526 connection_dir = self.profile_dir.security_dir,
515 527 )
516 528 kls = import_item(self.notebook_manager_class)
517 529 self.notebook_manager = kls(config=self.config, log=self.log)
518 530 self.notebook_manager.load_notebook_names()
519 531 self.cluster_manager = ClusterManager(config=self.config, log=self.log)
520 532 self.cluster_manager.update_profiles()
521 533
522 534 def init_logging(self):
523 535 # This prevents double log messages because tornado use a root logger that
524 536 # self.log is a child of. The logging module dipatches log messages to a log
525 537 # and all of its ancenstors until propagate is set to False.
526 538 self.log.propagate = False
527 539
528 540 # hook up tornado 3's loggers to our app handlers
529 541 for name in ('access', 'application', 'general'):
530 542 logging.getLogger('tornado.%s' % name).handlers = self.log.handlers
531 543
532 544 def init_webapp(self):
533 545 """initialize tornado webapp and httpserver"""
534 546 self.web_app = NotebookWebApplication(
535 547 self, self.kernel_manager, self.notebook_manager,
536 548 self.cluster_manager, self.log,
537 549 self.base_project_url, self.webapp_settings
538 550 )
539 551 if self.certfile:
540 552 ssl_options = dict(certfile=self.certfile)
541 553 if self.keyfile:
542 554 ssl_options['keyfile'] = self.keyfile
543 555 else:
544 556 ssl_options = None
545 557 self.web_app.password = self.password
546 558 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
547 559 xheaders=self.trust_xheaders)
548 560 if not self.ip:
549 561 warning = "WARNING: The notebook server is listening on all IP addresses"
550 562 if ssl_options is None:
551 563 self.log.critical(warning + " and not using encryption. This "
552 564 "is not recommended.")
553 565 if not self.password and not self.read_only:
554 566 self.log.critical(warning + " and not using authentication. "
555 567 "This is highly insecure and not recommended.")
556 568 success = None
557 569 for port in random_ports(self.port, self.port_retries+1):
558 570 try:
559 571 self.http_server.listen(port, self.ip)
560 572 except socket.error as e:
561 573 # XXX: remove the e.errno == -9 block when we require
562 574 # tornado >= 3.0
563 575 if e.errno == -9 and tornado.version_info[0] < 3:
564 576 # The flags passed to socket.getaddrinfo from
565 577 # tornado.netutils.bind_sockets can cause "gaierror:
566 578 # [Errno -9] Address family for hostname not supported"
567 579 # when the interface is not associated, for example.
568 580 # Changing the flags to exclude socket.AI_ADDRCONFIG does
569 581 # not cause this error, but the only way to do this is to
570 582 # monkeypatch socket to remove the AI_ADDRCONFIG attribute
571 583 saved_AI_ADDRCONFIG = socket.AI_ADDRCONFIG
572 584 self.log.warn('Monkeypatching socket to fix tornado bug')
573 585 del(socket.AI_ADDRCONFIG)
574 586 try:
575 587 # retry the tornado call without AI_ADDRCONFIG flags
576 588 self.http_server.listen(port, self.ip)
577 589 except socket.error as e2:
578 590 e = e2
579 591 else:
580 592 self.port = port
581 593 success = True
582 594 break
583 595 # restore the monekypatch
584 596 socket.AI_ADDRCONFIG = saved_AI_ADDRCONFIG
585 597 if e.errno != errno.EADDRINUSE:
586 598 raise
587 599 self.log.info('The port %i is already in use, trying another random port.' % port)
588 600 else:
589 601 self.port = port
590 602 success = True
591 603 break
592 604 if not success:
593 605 self.log.critical('ERROR: the notebook server could not be started because '
594 606 'no available port could be found.')
595 607 self.exit(1)
596 608
597 609 def init_signal(self):
598 610 if not sys.platform.startswith('win'):
599 611 signal.signal(signal.SIGINT, self._handle_sigint)
600 612 signal.signal(signal.SIGTERM, self._signal_stop)
601 613 if hasattr(signal, 'SIGUSR1'):
602 614 # Windows doesn't support SIGUSR1
603 615 signal.signal(signal.SIGUSR1, self._signal_info)
604 616 if hasattr(signal, 'SIGINFO'):
605 617 # only on BSD-based systems
606 618 signal.signal(signal.SIGINFO, self._signal_info)
607 619
608 620 def _handle_sigint(self, sig, frame):
609 621 """SIGINT handler spawns confirmation dialog"""
610 622 # register more forceful signal handler for ^C^C case
611 623 signal.signal(signal.SIGINT, self._signal_stop)
612 624 # request confirmation dialog in bg thread, to avoid
613 625 # blocking the App
614 626 thread = threading.Thread(target=self._confirm_exit)
615 627 thread.daemon = True
616 628 thread.start()
617 629
618 630 def _restore_sigint_handler(self):
619 631 """callback for restoring original SIGINT handler"""
620 632 signal.signal(signal.SIGINT, self._handle_sigint)
621 633
622 634 def _confirm_exit(self):
623 635 """confirm shutdown on ^C
624 636
625 637 A second ^C, or answering 'y' within 5s will cause shutdown,
626 638 otherwise original SIGINT handler will be restored.
627 639
628 640 This doesn't work on Windows.
629 641 """
630 642 # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
631 643 time.sleep(0.1)
632 644 info = self.log.info
633 645 info('interrupted')
634 646 print self.notebook_info()
635 647 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
636 648 sys.stdout.flush()
637 649 r,w,x = select.select([sys.stdin], [], [], 5)
638 650 if r:
639 651 line = sys.stdin.readline()
640 652 if line.lower().startswith('y'):
641 653 self.log.critical("Shutdown confirmed")
642 654 ioloop.IOLoop.instance().stop()
643 655 return
644 656 else:
645 657 print "No answer for 5s:",
646 658 print "resuming operation..."
647 659 # no answer, or answer is no:
648 660 # set it back to original SIGINT handler
649 661 # use IOLoop.add_callback because signal.signal must be called
650 662 # from main thread
651 663 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
652 664
653 665 def _signal_stop(self, sig, frame):
654 666 self.log.critical("received signal %s, stopping", sig)
655 667 ioloop.IOLoop.instance().stop()
656 668
657 669 def _signal_info(self, sig, frame):
658 670 print self.notebook_info()
659 671
660 672 def init_components(self):
661 673 """Check the components submodule, and warn if it's unclean"""
662 674 status = submodule.check_submodule_status()
663 675 if status == 'missing':
664 676 self.log.warn("components submodule missing, running `git submodule update`")
665 677 submodule.update_submodules(submodule.ipython_parent())
666 678 elif status == 'unclean':
667 679 self.log.warn("components submodule unclean, you may see 404s on static/components")
668 680 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
669 681
670 682
671 683 @catch_config_error
672 684 def initialize(self, argv=None):
673 685 self.init_logging()
674 686 super(NotebookApp, self).initialize(argv)
675 687 self.init_configurables()
676 688 self.init_components()
677 689 self.init_webapp()
678 690 self.init_signal()
679 691
680 692 def cleanup_kernels(self):
681 693 """Shutdown all kernels.
682 694
683 695 The kernels will shutdown themselves when this process no longer exists,
684 696 but explicit shutdown allows the KernelManagers to cleanup the connection files.
685 697 """
686 698 self.log.info('Shutting down kernels')
687 699 self.kernel_manager.shutdown_all()
688 700
689 701 def notebook_info(self):
690 702 "Return the current working directory and the server url information"
691 703 mgr_info = self.notebook_manager.info_string() + "\n"
692 704 return mgr_info +"The IPython Notebook is running at: %s" % self._url
693 705
694 706 def start(self):
695 707 """ Start the IPython Notebook server app, after initialization
696 708
697 709 This method takes no arguments so all configuration and initialization
698 710 must be done prior to calling this method."""
699 711 ip = self.ip if self.ip else '[all ip addresses on your system]'
700 712 proto = 'https' if self.certfile else 'http'
701 713 info = self.log.info
702 714 self._url = "%s://%s:%i%s" % (proto, ip, self.port,
703 715 self.base_project_url)
704 716 for line in self.notebook_info().split("\n"):
705 717 info(line)
706 718 info("Use Control-C to stop this server and shut down all kernels.")
707 719
708 720 if self.open_browser or self.file_to_run:
709 721 ip = self.ip or LOCALHOST
710 722 try:
711 723 browser = webbrowser.get(self.browser or None)
712 724 except webbrowser.Error as e:
713 725 self.log.warn('No web browser found: %s.' % e)
714 726 browser = None
715 727
716 728 if self.file_to_run:
717 729 name, _ = os.path.splitext(os.path.basename(self.file_to_run))
718 730 url = self.notebook_manager.rev_mapping.get(name, '')
719 731 else:
720 732 url = ''
721 733 if browser:
722 734 b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
723 735 self.port, self.base_project_url, url), new=2)
724 736 threading.Thread(target=b).start()
725 737 try:
726 738 ioloop.IOLoop.instance().start()
727 739 except KeyboardInterrupt:
728 740 info("Interrupted...")
729 741 finally:
730 742 self.cleanup_kernels()
731 743
732 744
733 745 #-----------------------------------------------------------------------------
734 746 # Main entry point
735 747 #-----------------------------------------------------------------------------
736 748
737 749 def launch_new_instance():
738 750 app = NotebookApp.instance()
739 751 app.initialize()
740 752 app.start()
741 753
General Comments 0
You need to be logged in to leave comments. Login now