##// END OF EJS Templates
add note about sharing config files with cookie_secret
MinRK -
Show More
@@ -1,746 +1,749 b''
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 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 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 341
342 342 cookie_secret = Bytes(b'', config=True,
343 343 help="""The random bytes used to secure cookies.
344 344 By default this is a new random number every time you start the Notebook.
345 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).
346 349 """
347 350 )
348 351 def _cookie_secret_default(self):
349 352 return os.urandom(1024)
350 353
351 354 password = Unicode(u'', config=True,
352 355 help="""Hashed password to use for web authentication.
353 356
354 357 To generate, type in a python/IPython shell:
355 358
356 359 from IPython.lib import passwd; passwd()
357 360
358 361 The string should be of the form type:salt:hashed-password.
359 362 """
360 363 )
361 364
362 365 open_browser = Bool(True, config=True,
363 366 help="""Whether to open in a browser after starting.
364 367 The specific browser used is platform dependent and
365 368 determined by the python standard library `webbrowser`
366 369 module, unless it is overridden using the --browser
367 370 (NotebookApp.browser) configuration option.
368 371 """)
369 372
370 373 browser = Unicode(u'', config=True,
371 374 help="""Specify what command to use to invoke a web
372 375 browser when opening the notebook. If not specified, the
373 376 default browser will be determined by the `webbrowser`
374 377 standard library module, which allows setting of the
375 378 BROWSER environment variable to override it.
376 379 """)
377 380
378 381 read_only = Bool(False, config=True,
379 382 help="Whether to prevent editing/execution of notebooks."
380 383 )
381 384
382 385 use_less = Bool(False, config=True,
383 386 help="""Wether to use Browser Side less-css parsing
384 387 instead of compiled css version in templates that allows
385 388 it. This is mainly convenient when working on the less
386 389 file to avoid a build step, or if user want to overwrite
387 390 some of the less variables without having to recompile
388 391 everything.
389 392
390 393 You will need to install the less.js component in the static directory
391 394 either in the source tree or in your profile folder.
392 395 """)
393 396
394 397 webapp_settings = Dict(config=True,
395 398 help="Supply overrides for the tornado.web.Application that the "
396 399 "IPython notebook uses.")
397 400
398 401 enable_mathjax = Bool(True, config=True,
399 402 help="""Whether to enable MathJax for typesetting math/TeX
400 403
401 404 MathJax is the javascript library IPython uses to render math/LaTeX. It is
402 405 very large, so you may want to disable it if you have a slow internet
403 406 connection, or for offline use of the notebook.
404 407
405 408 When disabled, equations etc. will appear as their untransformed TeX source.
406 409 """
407 410 )
408 411 def _enable_mathjax_changed(self, name, old, new):
409 412 """set mathjax url to empty if mathjax is disabled"""
410 413 if not new:
411 414 self.mathjax_url = u''
412 415
413 416 base_project_url = Unicode('/', config=True,
414 417 help='''The base URL for the notebook server.
415 418
416 419 Leading and trailing slashes can be omitted,
417 420 and will automatically be added.
418 421 ''')
419 422 def _base_project_url_changed(self, name, old, new):
420 423 if not new.startswith('/'):
421 424 self.base_project_url = '/'+new
422 425 elif not new.endswith('/'):
423 426 self.base_project_url = new+'/'
424 427
425 428 base_kernel_url = Unicode('/', config=True,
426 429 help='''The base URL for the kernel server
427 430
428 431 Leading and trailing slashes can be omitted,
429 432 and will automatically be added.
430 433 ''')
431 434 def _base_kernel_url_changed(self, name, old, new):
432 435 if not new.startswith('/'):
433 436 self.base_kernel_url = '/'+new
434 437 elif not new.endswith('/'):
435 438 self.base_kernel_url = new+'/'
436 439
437 440 websocket_host = Unicode("", config=True,
438 441 help="""The hostname for the websocket server."""
439 442 )
440 443
441 444 extra_static_paths = List(Unicode, config=True,
442 445 help="""Extra paths to search for serving static files.
443 446
444 447 This allows adding javascript/css to be available from the notebook server machine,
445 448 or overriding individual files in the IPython"""
446 449 )
447 450 def _extra_static_paths_default(self):
448 451 return [os.path.join(self.profile_dir.location, 'static')]
449 452
450 453 @property
451 454 def static_file_path(self):
452 455 """return extra paths + the default location"""
453 456 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
454 457
455 458 mathjax_url = Unicode("", config=True,
456 459 help="""The url for MathJax.js."""
457 460 )
458 461 def _mathjax_url_default(self):
459 462 if not self.enable_mathjax:
460 463 return u''
461 464 static_url_prefix = self.webapp_settings.get("static_url_prefix",
462 465 "/static/")
463 466 try:
464 467 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), self.static_file_path)
465 468 except IOError:
466 469 if self.certfile:
467 470 # HTTPS: load from Rackspace CDN, because SSL certificate requires it
468 471 base = u"https://c328740.ssl.cf1.rackcdn.com"
469 472 else:
470 473 base = u"http://cdn.mathjax.org"
471 474
472 475 url = base + u"/mathjax/latest/MathJax.js"
473 476 self.log.info("Using MathJax from CDN: %s", url)
474 477 return url
475 478 else:
476 479 self.log.info("Using local MathJax from %s" % mathjax)
477 480 return static_url_prefix+u"mathjax/MathJax.js"
478 481
479 482 def _mathjax_url_changed(self, name, old, new):
480 483 if new and not self.enable_mathjax:
481 484 # enable_mathjax=False overrides mathjax_url
482 485 self.mathjax_url = u''
483 486 else:
484 487 self.log.info("Using MathJax: %s", new)
485 488
486 489 notebook_manager_class = DottedObjectName('IPython.frontend.html.notebook.services.notebooks.filenbmanager.FileNotebookManager',
487 490 config=True,
488 491 help='The notebook manager class to use.')
489 492
490 493 trust_xheaders = Bool(False, config=True,
491 494 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
492 495 "sent by the upstream reverse proxy. Neccesary if the proxy handles SSL")
493 496 )
494 497
495 498 def parse_command_line(self, argv=None):
496 499 super(NotebookApp, self).parse_command_line(argv)
497 500 if argv is None:
498 501 argv = sys.argv[1:]
499 502
500 503 # Scrub frontend-specific flags
501 504 self.kernel_argv = swallow_argv(argv, notebook_aliases, notebook_flags)
502 505 # Kernel should inherit default config file from frontend
503 506 self.kernel_argv.append("--IPKernelApp.parent_appname='%s'" % self.name)
504 507
505 508 if self.extra_args:
506 509 f = os.path.abspath(self.extra_args[0])
507 510 if os.path.isdir(f):
508 511 nbdir = f
509 512 else:
510 513 self.file_to_run = f
511 514 nbdir = os.path.dirname(f)
512 515 self.config.NotebookManager.notebook_dir = nbdir
513 516
514 517 def init_configurables(self):
515 518 # force Session default to be secure
516 519 default_secure(self.config)
517 520 self.kernel_manager = MappingKernelManager(
518 521 config=self.config, log=self.log, kernel_argv=self.kernel_argv,
519 522 connection_dir = self.profile_dir.security_dir,
520 523 )
521 524 kls = import_item(self.notebook_manager_class)
522 525 self.notebook_manager = kls(config=self.config, log=self.log)
523 526 self.notebook_manager.load_notebook_names()
524 527 self.cluster_manager = ClusterManager(config=self.config, log=self.log)
525 528 self.cluster_manager.update_profiles()
526 529
527 530 def init_logging(self):
528 531 # This prevents double log messages because tornado use a root logger that
529 532 # self.log is a child of. The logging module dipatches log messages to a log
530 533 # and all of its ancenstors until propagate is set to False.
531 534 self.log.propagate = False
532 535
533 536 # hook up tornado 3's loggers to our app handlers
534 537 for name in ('access', 'application', 'general'):
535 538 logging.getLogger('tornado.%s' % name).handlers = self.log.handlers
536 539
537 540 def init_webapp(self):
538 541 """initialize tornado webapp and httpserver"""
539 542 self.web_app = NotebookWebApplication(
540 543 self, self.kernel_manager, self.notebook_manager,
541 544 self.cluster_manager, self.log,
542 545 self.base_project_url, self.webapp_settings
543 546 )
544 547 if self.certfile:
545 548 ssl_options = dict(certfile=self.certfile)
546 549 if self.keyfile:
547 550 ssl_options['keyfile'] = self.keyfile
548 551 else:
549 552 ssl_options = None
550 553 self.web_app.password = self.password
551 554 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
552 555 xheaders=self.trust_xheaders)
553 556 if not self.ip:
554 557 warning = "WARNING: The notebook server is listening on all IP addresses"
555 558 if ssl_options is None:
556 559 self.log.critical(warning + " and not using encryption. This "
557 560 "is not recommended.")
558 561 if not self.password and not self.read_only:
559 562 self.log.critical(warning + " and not using authentication. "
560 563 "This is highly insecure and not recommended.")
561 564 success = None
562 565 for port in random_ports(self.port, self.port_retries+1):
563 566 try:
564 567 self.http_server.listen(port, self.ip)
565 568 except socket.error as e:
566 569 # XXX: remove the e.errno == -9 block when we require
567 570 # tornado >= 3.0
568 571 if e.errno == -9 and tornado.version_info[0] < 3:
569 572 # The flags passed to socket.getaddrinfo from
570 573 # tornado.netutils.bind_sockets can cause "gaierror:
571 574 # [Errno -9] Address family for hostname not supported"
572 575 # when the interface is not associated, for example.
573 576 # Changing the flags to exclude socket.AI_ADDRCONFIG does
574 577 # not cause this error, but the only way to do this is to
575 578 # monkeypatch socket to remove the AI_ADDRCONFIG attribute
576 579 saved_AI_ADDRCONFIG = socket.AI_ADDRCONFIG
577 580 self.log.warn('Monkeypatching socket to fix tornado bug')
578 581 del(socket.AI_ADDRCONFIG)
579 582 try:
580 583 # retry the tornado call without AI_ADDRCONFIG flags
581 584 self.http_server.listen(port, self.ip)
582 585 except socket.error as e2:
583 586 e = e2
584 587 else:
585 588 self.port = port
586 589 success = True
587 590 break
588 591 # restore the monekypatch
589 592 socket.AI_ADDRCONFIG = saved_AI_ADDRCONFIG
590 593 if e.errno != errno.EADDRINUSE:
591 594 raise
592 595 self.log.info('The port %i is already in use, trying another random port.' % port)
593 596 else:
594 597 self.port = port
595 598 success = True
596 599 break
597 600 if not success:
598 601 self.log.critical('ERROR: the notebook server could not be started because '
599 602 'no available port could be found.')
600 603 self.exit(1)
601 604
602 605 def init_signal(self):
603 606 if not sys.platform.startswith('win'):
604 607 signal.signal(signal.SIGINT, self._handle_sigint)
605 608 signal.signal(signal.SIGTERM, self._signal_stop)
606 609 if hasattr(signal, 'SIGUSR1'):
607 610 # Windows doesn't support SIGUSR1
608 611 signal.signal(signal.SIGUSR1, self._signal_info)
609 612 if hasattr(signal, 'SIGINFO'):
610 613 # only on BSD-based systems
611 614 signal.signal(signal.SIGINFO, self._signal_info)
612 615
613 616 def _handle_sigint(self, sig, frame):
614 617 """SIGINT handler spawns confirmation dialog"""
615 618 # register more forceful signal handler for ^C^C case
616 619 signal.signal(signal.SIGINT, self._signal_stop)
617 620 # request confirmation dialog in bg thread, to avoid
618 621 # blocking the App
619 622 thread = threading.Thread(target=self._confirm_exit)
620 623 thread.daemon = True
621 624 thread.start()
622 625
623 626 def _restore_sigint_handler(self):
624 627 """callback for restoring original SIGINT handler"""
625 628 signal.signal(signal.SIGINT, self._handle_sigint)
626 629
627 630 def _confirm_exit(self):
628 631 """confirm shutdown on ^C
629 632
630 633 A second ^C, or answering 'y' within 5s will cause shutdown,
631 634 otherwise original SIGINT handler will be restored.
632 635
633 636 This doesn't work on Windows.
634 637 """
635 638 # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
636 639 time.sleep(0.1)
637 640 info = self.log.info
638 641 info('interrupted')
639 642 print self.notebook_info()
640 643 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
641 644 sys.stdout.flush()
642 645 r,w,x = select.select([sys.stdin], [], [], 5)
643 646 if r:
644 647 line = sys.stdin.readline()
645 648 if line.lower().startswith('y'):
646 649 self.log.critical("Shutdown confirmed")
647 650 ioloop.IOLoop.instance().stop()
648 651 return
649 652 else:
650 653 print "No answer for 5s:",
651 654 print "resuming operation..."
652 655 # no answer, or answer is no:
653 656 # set it back to original SIGINT handler
654 657 # use IOLoop.add_callback because signal.signal must be called
655 658 # from main thread
656 659 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
657 660
658 661 def _signal_stop(self, sig, frame):
659 662 self.log.critical("received signal %s, stopping", sig)
660 663 ioloop.IOLoop.instance().stop()
661 664
662 665 def _signal_info(self, sig, frame):
663 666 print self.notebook_info()
664 667
665 668 def init_components(self):
666 669 """Check the components submodule, and warn if it's unclean"""
667 670 status = submodule.check_submodule_status()
668 671 if status == 'missing':
669 672 self.log.warn("components submodule missing, running `git submodule update`")
670 673 submodule.update_submodules(submodule.ipython_parent())
671 674 elif status == 'unclean':
672 675 self.log.warn("components submodule unclean, you may see 404s on static/components")
673 676 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
674 677
675 678
676 679 @catch_config_error
677 680 def initialize(self, argv=None):
678 681 self.init_logging()
679 682 super(NotebookApp, self).initialize(argv)
680 683 self.init_configurables()
681 684 self.init_components()
682 685 self.init_webapp()
683 686 self.init_signal()
684 687
685 688 def cleanup_kernels(self):
686 689 """Shutdown all kernels.
687 690
688 691 The kernels will shutdown themselves when this process no longer exists,
689 692 but explicit shutdown allows the KernelManagers to cleanup the connection files.
690 693 """
691 694 self.log.info('Shutting down kernels')
692 695 self.kernel_manager.shutdown_all()
693 696
694 697 def notebook_info(self):
695 698 "Return the current working directory and the server url information"
696 699 mgr_info = self.notebook_manager.info_string() + "\n"
697 700 return mgr_info +"The IPython Notebook is running at: %s" % self._url
698 701
699 702 def start(self):
700 703 """ Start the IPython Notebook server app, after initialization
701 704
702 705 This method takes no arguments so all configuration and initialization
703 706 must be done prior to calling this method."""
704 707 ip = self.ip if self.ip else '[all ip addresses on your system]'
705 708 proto = 'https' if self.certfile else 'http'
706 709 info = self.log.info
707 710 self._url = "%s://%s:%i%s" % (proto, ip, self.port,
708 711 self.base_project_url)
709 712 for line in self.notebook_info().split("\n"):
710 713 info(line)
711 714 info("Use Control-C to stop this server and shut down all kernels.")
712 715
713 716 if self.open_browser or self.file_to_run:
714 717 ip = self.ip or LOCALHOST
715 718 try:
716 719 browser = webbrowser.get(self.browser or None)
717 720 except webbrowser.Error as e:
718 721 self.log.warn('No web browser found: %s.' % e)
719 722 browser = None
720 723
721 724 if self.file_to_run:
722 725 name, _ = os.path.splitext(os.path.basename(self.file_to_run))
723 726 url = self.notebook_manager.rev_mapping.get(name, '')
724 727 else:
725 728 url = ''
726 729 if browser:
727 730 b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
728 731 self.port, self.base_project_url, url), new=2)
729 732 threading.Thread(target=b).start()
730 733 try:
731 734 ioloop.IOLoop.instance().start()
732 735 except KeyboardInterrupt:
733 736 info("Interrupted...")
734 737 finally:
735 738 self.cleanup_kernels()
736 739
737 740
738 741 #-----------------------------------------------------------------------------
739 742 # Main entry point
740 743 #-----------------------------------------------------------------------------
741 744
742 745 def launch_new_instance():
743 746 app = NotebookApp.instance()
744 747 app.initialize()
745 748 app.start()
746 749
General Comments 0
You need to be logged in to leave comments. Login now