refactoring of nbmanager and filenbmanager

major clean up of the two managers. We make sure to follow
the standard models described in IPEP 16

IPython/html/notebookapp.py

@@ -1,759 +1,758 b''
 # coding: utf-8
 """A tornado based IPython notebook server.
 
 Authors:
 
 * Brian Granger
 """
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2013  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 # stdlib
 import errno
 import logging
 import os
 import random
 import select
 import signal
 import socket
 import sys
 import threading
 import time
 import webbrowser
 
 
 # Third party
 # check for pyzmq 2.1.11
 from IPython.utils.zmqrelated import check_for_zmq
 check_for_zmq('2.1.11', 'IPython.html')
 
 from jinja2 import Environment, FileSystemLoader
 
 # Install the pyzmq ioloop. This has to be done before anything else from
 # tornado is imported.
 from zmq.eventloop import ioloop
 ioloop.install()
 
 # check for tornado 2.1.0
 msg = "The IPython Notebook requires tornado >= 2.1.0"
 try:
     import tornado
 except ImportError:
     raise ImportError(msg)
 try:
     version_info = tornado.version_info
 except AttributeError:
     raise ImportError(msg + ", but you have < 1.1.0")
 if version_info < (2,1,0):
     raise ImportError(msg + ", but you have %s" % tornado.version)
 
 from tornado import httpserver
 from tornado import web
 
 # Our own libraries
 from IPython.html import DEFAULT_STATIC_FILES_PATH
 
 from .services.kernels.kernelmanager import MappingKernelManager
 from .services.notebooks.nbmanager import NotebookManager
 from .services.notebooks.filenbmanager import FileNotebookManager
 from .services.clusters.clustermanager import ClusterManager
 from .services.sessions.sessionmanager import SessionManager
 
 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
 
 from IPython.config.application import catch_config_error, boolean_flag
 from IPython.core.application import BaseIPythonApplication
 from IPython.consoleapp import IPythonConsoleApp
 from IPython.kernel import swallow_argv
 from IPython.kernel.zmq.session import default_secure
 from IPython.kernel.zmq.kernelapp import (
     kernel_flags,
     kernel_aliases,
 )
 from IPython.utils.importstring import import_item
 from IPython.utils.localinterfaces import localhost
 from IPython.utils import submodule
 from IPython.utils.traitlets import (
     Dict, Unicode, Integer, List, Bool, Bytes,
     DottedObjectName
 )
 from IPython.utils import py3compat
 from IPython.utils.path import filefind, get_ipython_dir
 
 from .utils import url_path_join
 
 #-----------------------------------------------------------------------------
 # Module globals
 #-----------------------------------------------------------------------------
 
 _examples = """
 ipython notebook                       # start the notebook
 ipython notebook --profile=sympy       # use the sympy profile
 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
 """
 
 #-----------------------------------------------------------------------------
 # Helper functions
 #-----------------------------------------------------------------------------
 
 def random_ports(port, n):
     """Generate a list of n random ports near the given port.
 
     The first 5 ports will be sequential, and the remaining n-5 will be
     randomly selected in the range [port-2*n, port+2*n].
     """
     for i in range(min(5, n)):
         yield port + i
     for i in range(n-5):
         yield max(1, port + random.randint(-2*n, 2*n))
 
 def load_handlers(name):
     """Load the (URL pattern, handler) tuples for each component."""
     name = 'IPython.html.' + name
     mod = __import__(name, fromlist=['default_handlers'])
     return mod.default_handlers
 
 #-----------------------------------------------------------------------------
 # The Tornado web application
 #-----------------------------------------------------------------------------
 
 class NotebookWebApplication(web.Application):
 
     def __init__(self, ipython_app, kernel_manager, notebook_manager,
                  cluster_manager, session_manager, log, base_project_url,
                  settings_overrides):
 
         settings = self.init_settings(
             ipython_app, kernel_manager, notebook_manager, cluster_manager,
             session_manager, log, base_project_url, settings_overrides)
         handlers = self.init_handlers(settings)
 
         super(NotebookWebApplication, self).__init__(handlers, **settings)
 
     def init_settings(self, ipython_app, kernel_manager, notebook_manager,
                       cluster_manager, session_manager, log, base_project_url,
                       settings_overrides):
         # Python < 2.6.5 doesn't accept unicode keys in f(**kwargs), and
         # base_project_url will always be unicode, which will in turn
         # make the patterns unicode, and ultimately result in unicode
         # keys in kwargs to handler._execute(**kwargs) in tornado.
         # This enforces that base_project_url be ascii in that situation.
         # 
         # Note that the URLs these patterns check against are escaped,
         # and thus guaranteed to be ASCII: 'héllo' is really 'h%C3%A9llo'.
         base_project_url = py3compat.unicode_to_str(base_project_url, 'ascii')
         template_path = settings_overrides.get("template_path", os.path.join(os.path.dirname(__file__), "templates"))
         settings = dict(
             # basics
             base_project_url=base_project_url,
             base_kernel_url=ipython_app.base_kernel_url,
             template_path=template_path,
             static_path=ipython_app.static_file_path,
             static_handler_class = FileFindHandler,
             static_url_prefix = url_path_join(base_project_url,'/static/'),
             
             # authentication
             cookie_secret=ipython_app.cookie_secret,
             login_url=url_path_join(base_project_url,'/login'),
             password=ipython_app.password,
             
             # managers
             kernel_manager=kernel_manager,
             notebook_manager=notebook_manager,
             cluster_manager=cluster_manager,
             session_manager=session_manager,
 
             # IPython stuff
             nbextensions_path = ipython_app.nbextensions_path,
             mathjax_url=ipython_app.mathjax_url,
             config=ipython_app.config,
             use_less=ipython_app.use_less,
             jinja2_env=Environment(loader=FileSystemLoader(template_path)),
         )
 
         # allow custom overrides for the tornado web app.
         settings.update(settings_overrides)
         return settings
 
     def init_handlers(self, settings):
         # Load the (URL pattern, handler) tuples for each component.
         handlers = []
         handlers.extend(load_handlers('base.handlers'))
         handlers.extend(load_handlers('tree.handlers'))
         handlers.extend(load_handlers('auth.login'))
         handlers.extend(load_handlers('auth.logout'))
         handlers.extend(load_handlers('notebook.handlers'))
         handlers.extend(load_handlers('services.kernels.handlers'))
         handlers.extend(load_handlers('services.notebooks.handlers'))
         handlers.extend(load_handlers('services.clusters.handlers'))
         handlers.extend(load_handlers('services.sessions.handlers'))
         handlers.extend([
             (r"/files/(.*)", AuthenticatedFileHandler, {'path' : settings['notebook_manager'].notebook_dir}),
             (r"/nbextensions/(.*)", FileFindHandler, {'path' : settings['nbextensions_path']}),
         ])
         # prepend base_project_url onto the patterns that we match
         new_handlers = []
         for handler in handlers:
             pattern = url_path_join(settings['base_project_url'], handler[0])
             new_handler = tuple([pattern] + list(handler[1:]))
             new_handlers.append(new_handler)
         return new_handlers
 
 
 
 #-----------------------------------------------------------------------------
 # Aliases and Flags
 #-----------------------------------------------------------------------------
 
 flags = dict(kernel_flags)
 flags['no-browser']=(
     {'NotebookApp' : {'open_browser' : False}},
     "Don't open the notebook in a browser after startup."
 )
 flags['no-mathjax']=(
     {'NotebookApp' : {'enable_mathjax' : False}},
     """Disable MathJax
     
     MathJax is the javascript library IPython uses to render math/LaTeX. It is
     very large, so you may want to disable it if you have a slow internet
     connection, or for offline use of the notebook.
     
     When disabled, equations etc. will appear as their untransformed TeX source.
     """
 )
 
 # Add notebook manager flags
 flags.update(boolean_flag('script', 'FileNotebookManager.save_script',
                'Auto-save a .py script everytime the .ipynb notebook is saved',
                'Do not auto-save .py scripts for every notebook'))
 
 # the flags that are specific to the frontend
 # these must be scrubbed before being passed to the kernel,
 # or it will raise an error on unrecognized flags
 notebook_flags = ['no-browser', 'no-mathjax', 'script', 'no-script']
 
 aliases = dict(kernel_aliases)
 
 aliases.update({
     'ip': 'NotebookApp.ip',
     'port': 'NotebookApp.port',
     'port-retries': 'NotebookApp.port_retries',
     'transport': 'KernelManager.transport',
     'keyfile': 'NotebookApp.keyfile',
     'certfile': 'NotebookApp.certfile',
     'notebook-dir': 'NotebookManager.notebook_dir',
     'browser': 'NotebookApp.browser',
 })
 
 # remove ipkernel flags that are singletons, and don't make sense in
 # multi-kernel evironment:
 aliases.pop('f', None)
 
 notebook_aliases = [u'port', u'port-retries', u'ip', u'keyfile', u'certfile',
                     u'notebook-dir', u'profile', u'profile-dir']
 
 #-----------------------------------------------------------------------------
 # NotebookApp
 #-----------------------------------------------------------------------------
 
 class NotebookApp(BaseIPythonApplication):
 
     name = 'ipython-notebook'
     
     description = """
         The IPython HTML Notebook.
         
         This launches a Tornado based HTML Notebook Server that serves up an
         HTML5/Javascript Notebook client.
     """
     examples = _examples
     
     classes = IPythonConsoleApp.classes + [MappingKernelManager, NotebookManager,
         FileNotebookManager]
     flags = Dict(flags)
     aliases = Dict(aliases)
 
     kernel_argv = List(Unicode)
 
     def _log_level_default(self):
         return logging.INFO
 
     def _log_format_default(self):
         """override default log format to include time"""
         return u"%(asctime)s.%(msecs).03d [%(name)s]%(highlevel)s %(message)s"
 
     # create requested profiles by default, if they don't exist:
     auto_create = Bool(True)
 
     # file to be opened in the notebook server
     file_to_run = Unicode('')
     entry_path = Unicode('')
 
     # Network related information.
 
     ip = Unicode(config=True,
         help="The IP address the notebook server will listen on."
     )
     def _ip_default(self):
         return localhost()
 
     def _ip_changed(self, name, old, new):
         if new == u'*': self.ip = u''
 
     port = Integer(8888, config=True,
         help="The port the notebook server will listen on."
     )
     port_retries = Integer(50, config=True,
         help="The number of additional ports to try if the specified port is not available."
     )
 
     certfile = Unicode(u'', config=True, 
         help="""The full path to an SSL/TLS certificate file."""
     )
     
     keyfile = Unicode(u'', config=True, 
         help="""The full path to a private key file for usage with SSL/TLS."""
     )
     
     cookie_secret = Bytes(b'', config=True,
         help="""The random bytes used to secure cookies.
         By default this is a new random number every time you start the Notebook.
         Set it to a value in a config file to enable logins to persist across server sessions.
         
         Note: Cookie secrets should be kept private, do not share config files with
         cookie_secret stored in plaintext (you can read the value from a file).
         """
     )
     def _cookie_secret_default(self):
         return os.urandom(1024)
 
     password = Unicode(u'', config=True,
                       help="""Hashed password to use for web authentication.
 
                       To generate, type in a python/IPython shell:
 
                         from IPython.lib import passwd; passwd()
 
                       The string should be of the form type:salt:hashed-password.
                       """
     )
 
     open_browser = Bool(True, config=True,
                         help="""Whether to open in a browser after starting.
                         The specific browser used is platform dependent and
                         determined by the python standard library `webbrowser`
                         module, unless it is overridden using the --browser
                         (NotebookApp.browser) configuration option.
                         """)
 
     browser = Unicode(u'', config=True,
                       help="""Specify what command to use to invoke a web
                       browser when opening the notebook. If not specified, the
                       default browser will be determined by the `webbrowser`
                       standard library module, which allows setting of the
                       BROWSER environment variable to override it.
                       """)
     
     use_less = Bool(False, config=True,
                        help="""Wether to use Browser Side less-css parsing
                        instead of compiled css version in templates that allows
                        it. This is mainly convenient when working on the less
                        file to avoid a build step, or if user want to overwrite
                        some of the less variables without having to recompile
                        everything.
                        
                        You will need to install the less.js component in the static directory
                        either in the source tree or in your profile folder.
                        """)
 
     webapp_settings = Dict(config=True,
             help="Supply overrides for the tornado.web.Application that the "
                  "IPython notebook uses.")
     
     enable_mathjax = Bool(True, config=True,
         help="""Whether to enable MathJax for typesetting math/TeX
 
         MathJax is the javascript library IPython uses to render math/LaTeX. It is
         very large, so you may want to disable it if you have a slow internet
         connection, or for offline use of the notebook.
 
         When disabled, equations etc. will appear as their untransformed TeX source.
         """
     )
     def _enable_mathjax_changed(self, name, old, new):
         """set mathjax url to empty if mathjax is disabled"""
         if not new:
             self.mathjax_url = u''
 
     base_project_url = Unicode('/', config=True,
                                help='''The base URL for the notebook server.
 
                                Leading and trailing slashes can be omitted,
                                and will automatically be added.
                                ''')
     def _base_project_url_changed(self, name, old, new):
         if not new.startswith('/'):
             self.base_project_url = '/'+new
         elif not new.endswith('/'):
             self.base_project_url = new+'/'
 
     base_kernel_url = Unicode('/', config=True,
                                help='''The base URL for the kernel server
 
                                Leading and trailing slashes can be omitted,
                                and will automatically be added.
                                ''')
     def _base_kernel_url_changed(self, name, old, new):
         if not new.startswith('/'):
             self.base_kernel_url = '/'+new
         elif not new.endswith('/'):
             self.base_kernel_url = new+'/'
 
     websocket_url = Unicode("", config=True,
         help="""The base URL for the websocket server,
         if it differs from the HTTP server (hint: it almost certainly doesn't).
         
         Should be in the form of an HTTP origin: ws[s]://hostname[:port]
         """
     )
 
     extra_static_paths = List(Unicode, config=True,
         help="""Extra paths to search for serving static files.
         
         This allows adding javascript/css to be available from the notebook server machine,
         or overriding individual files in the IPython"""
     )
     def _extra_static_paths_default(self):
         return [os.path.join(self.profile_dir.location, 'static')]
     
     @property
     def static_file_path(self):
         """return extra paths + the default location"""
         return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
     
     nbextensions_path = List(Unicode, config=True,
         help="""paths for Javascript extensions. By default, this is just IPYTHONDIR/nbextensions"""
     )
     def _nbextensions_path_default(self):
         return [os.path.join(get_ipython_dir(), 'nbextensions')]
 
     mathjax_url = Unicode("", config=True,
         help="""The url for MathJax.js."""
     )
     def _mathjax_url_default(self):
         if not self.enable_mathjax:
             return u''
         static_url_prefix = self.webapp_settings.get("static_url_prefix",
                          url_path_join(self.base_project_url, "static")
         )
         
         # try local mathjax, either in nbextensions/mathjax or static/mathjax
         for (url_prefix, search_path) in [
             (url_path_join(self.base_project_url, "nbextensions"), self.nbextensions_path),
             (static_url_prefix, self.static_file_path),
         ]:
             self.log.debug("searching for local mathjax in %s", search_path)
             try:
                 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), search_path)
             except IOError:
                 continue
             else:
                 url = url_path_join(url_prefix, u"mathjax/MathJax.js")
                 self.log.info("Serving local MathJax from %s at %s", mathjax, url)
                 return url
         
         # no local mathjax, serve from CDN
         if self.certfile:
             # HTTPS: load from Rackspace CDN, because SSL certificate requires it
             host = u"https://c328740.ssl.cf1.rackcdn.com"
         else:
             host = u"http://cdn.mathjax.org"
         
         url = host + u"/mathjax/latest/MathJax.js"
         self.log.info("Using MathJax from CDN: %s", url)
         return url
     
     def _mathjax_url_changed(self, name, old, new):
         if new and not self.enable_mathjax:
             # enable_mathjax=False overrides mathjax_url
             self.mathjax_url = u''
         else:
             self.log.info("Using MathJax: %s", new)
 
     notebook_manager_class = DottedObjectName('IPython.html.services.notebooks.filenbmanager.FileNotebookManager',
         config=True,
         help='The notebook manager class to use.')
 
     trust_xheaders = Bool(False, config=True,
         help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
               "sent by the upstream reverse proxy. Neccesary if the proxy handles SSL")
     )
     
     def parse_command_line(self, argv=None):
         super(NotebookApp, self).parse_command_line(argv)
         
         if self.extra_args:
             f = os.path.abspath(self.extra_args[0])
             if os.path.isdir(f):
                 self.entry_path = self.extra_args[0]
             elif os.path.isfile(f):
                 self.file_to_run = f
                 path = os.path.split(self.extra_args[0])
                 if path[0] != '':
                     self.entry_path = path[0]+'/'
                 
 
     def init_kernel_argv(self):
         """construct the kernel arguments"""
         # Scrub frontend-specific flags
         self.kernel_argv = swallow_argv(self.argv, notebook_aliases, notebook_flags)
         # Kernel should inherit default config file from frontend
         self.kernel_argv.append("--IPKernelApp.parent_appname='%s'" % self.name)
         # Kernel should get *absolute* path to profile directory
         self.kernel_argv.extend(["--profile-dir", self.profile_dir.location])
 
     def init_configurables(self):
         # force Session default to be secure
         default_secure(self.config)
         self.kernel_manager = MappingKernelManager(
             parent=self, log=self.log, kernel_argv=self.kernel_argv,
             connection_dir = self.profile_dir.security_dir,
         )
         kls = import_item(self.notebook_manager_class)
         self.notebook_manager = kls(parent=self, log=self.log)
-        self.notebook_manager.load_notebook_names('')
         self.session_manager = SessionManager(parent=self, log=self.log)
         self.cluster_manager = ClusterManager(parent=self, log=self.log)
         self.cluster_manager.update_profiles()
 
     def init_logging(self):
         # This prevents double log messages because tornado use a root logger that
         # self.log is a child of. The logging module dipatches log messages to a log
         # and all of its ancenstors until propagate is set to False.
         self.log.propagate = False
         
         # hook up tornado 3's loggers to our app handlers
         for name in ('access', 'application', 'general'):
             logging.getLogger('tornado.%s' % name).handlers = self.log.handlers
     
     def init_webapp(self):
         """initialize tornado webapp and httpserver"""
         self.web_app = NotebookWebApplication(
             self, self.kernel_manager, self.notebook_manager, 
             self.cluster_manager, self.session_manager,
             self.log, self.base_project_url, self.webapp_settings
         )
         if self.certfile:
             ssl_options = dict(certfile=self.certfile)
             if self.keyfile:
                 ssl_options['keyfile'] = self.keyfile
         else:
             ssl_options = None
         self.web_app.password = self.password
         self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
                                                  xheaders=self.trust_xheaders)
         if not self.ip:
             warning = "WARNING: The notebook server is listening on all IP addresses"
             if ssl_options is None:
                 self.log.critical(warning + " and not using encryption. This "
                     "is not recommended.")
             if not self.password:
                 self.log.critical(warning + " and not using authentication. "
                     "This is highly insecure and not recommended.")
         success = None
         for port in random_ports(self.port, self.port_retries+1):
             try:
                 self.http_server.listen(port, self.ip)
             except socket.error as e:
                 # XXX: remove the e.errno == -9 block when we require
                 # tornado >= 3.0
                 if e.errno == -9 and tornado.version_info[0] < 3:
                     # The flags passed to socket.getaddrinfo from
                     # tornado.netutils.bind_sockets can cause "gaierror:
                     # [Errno -9] Address family for hostname not supported"
                     # when the interface is not associated, for example.
                     # Changing the flags to exclude socket.AI_ADDRCONFIG does
                     # not cause this error, but the only way to do this is to
                     # monkeypatch socket to remove the AI_ADDRCONFIG attribute
                     saved_AI_ADDRCONFIG = socket.AI_ADDRCONFIG
                     self.log.warn('Monkeypatching socket to fix tornado bug')
                     del(socket.AI_ADDRCONFIG)
                     try:
                         # retry the tornado call without AI_ADDRCONFIG flags
                         self.http_server.listen(port, self.ip)
                     except socket.error as e2:
                         e = e2
                     else:
                         self.port = port
                         success = True
                         break
                     # restore the monekypatch
                     socket.AI_ADDRCONFIG = saved_AI_ADDRCONFIG
                 if e.errno == errno.EADDRINUSE:
                     self.log.info('The port %i is already in use, trying another random port.' % port)
                     continue
                 elif e.errno in (errno.EACCES, getattr(errno, 'WSAEACCES', errno.EACCES)):
                     self.log.warn("Permission to listen on port %i denied" % port)
                     continue
                 else:
                     raise
             else:
                 self.port = port
                 success = True
                 break
         if not success:
             self.log.critical('ERROR: the notebook server could not be started because '
                               'no available port could be found.')
             self.exit(1)
     
     def init_signal(self):
         if not sys.platform.startswith('win'):
             signal.signal(signal.SIGINT, self._handle_sigint)
         signal.signal(signal.SIGTERM, self._signal_stop)
         if hasattr(signal, 'SIGUSR1'):
             # Windows doesn't support SIGUSR1
             signal.signal(signal.SIGUSR1, self._signal_info)
         if hasattr(signal, 'SIGINFO'):
             # only on BSD-based systems
             signal.signal(signal.SIGINFO, self._signal_info)
     
     def _handle_sigint(self, sig, frame):
         """SIGINT handler spawns confirmation dialog"""
         # register more forceful signal handler for ^C^C case
         signal.signal(signal.SIGINT, self._signal_stop)
         # request confirmation dialog in bg thread, to avoid
         # blocking the App
         thread = threading.Thread(target=self._confirm_exit)
         thread.daemon = True
         thread.start()
     
     def _restore_sigint_handler(self):
         """callback for restoring original SIGINT handler"""
         signal.signal(signal.SIGINT, self._handle_sigint)
     
     def _confirm_exit(self):
         """confirm shutdown on ^C
         
         A second ^C, or answering 'y' within 5s will cause shutdown,
         otherwise original SIGINT handler will be restored.
         
         This doesn't work on Windows.
         """
         # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
         time.sleep(0.1)
         info = self.log.info
         info('interrupted')
         print self.notebook_info()
         sys.stdout.write("Shutdown this notebook server (y/[n])? ")
         sys.stdout.flush()
         r,w,x = select.select([sys.stdin], [], [], 5)
         if r:
             line = sys.stdin.readline()
             if line.lower().startswith('y'):
                 self.log.critical("Shutdown confirmed")
                 ioloop.IOLoop.instance().stop()
                 return
         else:
             print "No answer for 5s:",
         print "resuming operation..."
         # no answer, or answer is no:
         # set it back to original SIGINT handler
         # use IOLoop.add_callback because signal.signal must be called
         # from main thread
         ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
     
     def _signal_stop(self, sig, frame):
         self.log.critical("received signal %s, stopping", sig)
         ioloop.IOLoop.instance().stop()
 
     def _signal_info(self, sig, frame):
         print self.notebook_info()
     
     def init_components(self):
         """Check the components submodule, and warn if it's unclean"""
         status = submodule.check_submodule_status()
         if status == 'missing':
             self.log.warn("components submodule missing, running `git submodule update`")
             submodule.update_submodules(submodule.ipython_parent())
         elif status == 'unclean':
             self.log.warn("components submodule unclean, you may see 404s on static/components")
             self.log.warn("run `setup.py submodule` or `git submodule update` to update")
             
     
     @catch_config_error
     def initialize(self, argv=None):
         self.init_logging()
         super(NotebookApp, self).initialize(argv)
         self.init_kernel_argv()
         self.init_configurables()
         self.init_components()
         self.init_webapp()
         self.init_signal()
 
     def cleanup_kernels(self):
         """Shutdown all kernels.
         
         The kernels will shutdown themselves when this process no longer exists,
         but explicit shutdown allows the KernelManagers to cleanup the connection files.
         """
         self.log.info('Shutting down kernels')
         self.kernel_manager.shutdown_all()
 
     def notebook_info(self):
         "Return the current working directory and the server url information"
         mgr_info = self.notebook_manager.info_string() + "\n"
         return mgr_info +"The IPython Notebook is running at: %s" % self._url
 
     def start(self):
         """ Start the IPython Notebook server app, after initialization
         
         This method takes no arguments so all configuration and initialization
         must be done prior to calling this method."""
         ip = self.ip if self.ip else '[all ip addresses on your system]'
         proto = 'https' if self.certfile else 'http'
         info = self.log.info
         self._url = "%s://%s:%i%s" % (proto, ip, self.port,
                                       self.base_project_url)
         for line in self.notebook_info().split("\n"):
             info(line)
         info("Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).")
 
         if self.open_browser or self.file_to_run:
             ip = self.ip or localhost()
             try:
                 browser = webbrowser.get(self.browser or None)
             except webbrowser.Error as e:
                 self.log.warn('No web browser found: %s.' % e)
                 browser = None
 
             if self.file_to_run:
                 name, _ = os.path.splitext(os.path.basename(self.file_to_run))
                 url = 'notebooks/' + self.entry_path + name + _
             else:
                 url = 'tree/' + self.entry_path
             if browser:
                 b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
                     self.port, self.base_project_url, url), new=2)
                 threading.Thread(target=b).start()
         try:
             ioloop.IOLoop.instance().start()
         except KeyboardInterrupt:
             info("Interrupted...")
         finally:
             self.cleanup_kernels()
     
 
 #-----------------------------------------------------------------------------
 # Main entry point
 #-----------------------------------------------------------------------------
 
 launch_new_instance = NotebookApp.launch_instance
 

IPython/html/services/notebooks/filenbmanager.py

@@ -1,347 +1,333 b''
 """A notebook manager that uses the local file system for storage.
 
 Authors:
 
 * Brian Granger
+* Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import datetime
 import io
 import os
 import glob
 import shutil
 
 from unicodedata import normalize
 
 from tornado import web
 
 from .nbmanager import NotebookManager
 from IPython.nbformat import current
 from IPython.utils.traitlets import Unicode, Dict, Bool, TraitError
 from IPython.utils import tz
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class FileNotebookManager(NotebookManager):
     
     save_script = Bool(False, config=True,
         help="""Automatically create a Python script when saving the notebook.
         
         For easier use of import, %run and %load across notebooks, a
         <notebook-name>.py script will be created next to any
         <notebook-name>.ipynb on each save.  This can also be set with the
         short `--script` flag.
         """
     )
     
     checkpoint_dir = Unicode(config=True,
         help="""The location in which to keep notebook checkpoints
         
         By default, it is notebook-dir/.ipynb_checkpoints
         """
     )
     def _checkpoint_dir_default(self):
         return os.path.join(self.notebook_dir, '.ipynb_checkpoints')
     
     def _checkpoint_dir_changed(self, name, old, new):
         """do a bit of validation of the checkpoint dir"""
         if not os.path.isabs(new):
             # If we receive a non-absolute path, make it absolute.
             abs_new = os.path.abspath(new)
             self.checkpoint_dir = abs_new
             return
         if os.path.exists(new) and not os.path.isdir(new):
             raise TraitError("checkpoint dir %r is not a directory" % new)
         if not os.path.exists(new):
             self.log.info("Creating checkpoint dir %s", new)
             try:
                 os.mkdir(new)
             except:
                 raise TraitError("Couldn't create checkpoint dir %r" % new)
     
     filename_ext = Unicode(u'.ipynb')
 
-    
     def get_notebook_names(self, path):
         """List all notebook names in the notebook dir."""
         names = glob.glob(self.get_os_path('*'+self.filename_ext, path))
         names = [os.path.basename(name)
                  for name in names]
         return names
-        
-    def list_notebooks(self, path):
-        """List all notebooks in the notebook dir."""
-        notebook_names = self.get_notebook_names(path)
-        notebooks = []
-        for name in notebook_names:
-            model = self.notebook_model(name, path, content=False)
-            notebooks.append(model)
-        return notebooks
 
-    def update_notebook(self, data, notebook_name, notebook_path='/'):
-        """Changes notebook"""
-        changes = data.keys()
-        for change in changes:
-            full_path = self.get_os_path(notebook_name, notebook_path)
-            if change == "name":
-                new_path = self.get_os_path(data['name'], notebook_path)
-                if not os.path.isfile(new_path):
-                    os.rename(full_path,
-                        self.get_os_path(data['name'], notebook_path))
-                    notebook_name = data['name']
-                else:
-                    raise web.HTTPError(409, u'Notebook name already exists.')
-            if change == "path":
-                new_path = self.get_os_path(data['name'], data['path'])
-                stutil.move(full_path, new_path)
-                notebook_path = data['path']
-            if change == "content":
-                self.save_notebook(data, notebook_name, notebook_path)
-        model = self.notebook_model(notebook_name, notebook_path)
-        return model
+    def increment_filename(self, basename, path='/'):
+        """Return a non-used filename of the form basename<int>.
+        
+        This searches through the filenames (basename0, basename1, ...)
+        until is find one that is not already being used. It is used to
+        create Untitled and Copy names that are unique.
+        """
+        i = 0
+        while True:
+            name = u'%s%i.ipynb' % (basename,i)
+            os_path = self.get_os_path(name, path)
+            if not os.path.isfile(os_path):
+                break
+            else:
+                i = i+1
+        return name
 
     def notebook_exists(self, name, path):
         """Returns a True if the notebook exists. Else, returns False.
-        
+
         Parameters
         ----------
         name : string
             The name of the notebook you are checking.
         path : string
             The relative path to the notebook (with '/' as separator)
-        
+
         Returns
         -------
         bool
         """
         path = self.get_os_path(name, path)
         return os.path.isfile(path)
 
-    def read_notebook_object_from_path(self, path):
+    def list_notebooks(self, path):
+        """List all notebooks in the notebook dir."""
+        notebook_names = self.get_notebook_names(path)
+        notebooks = []
+        for name in notebook_names:
+            model = self.get_notebook_model(name, path, content=False)
+            notebooks.append(model)
+        notebooks = sorted(notebooks, key=lambda item: item['name'])
+        return notebooks
+
+    def get_notebook_model(self, name, path='/', content=True):
         """read a notebook object from a path"""
-        info = os.stat(path)
+        os_path = self.get_os_path(name, path)
+        if not os.path.isfile(os_path):
+            raise web.HTTPError(404, u'Notebook does not exist: %s' % name)
+        info = os.stat(os_path)
         last_modified = tz.utcfromtimestamp(info.st_mtime)
-        with open(path,'r') as f:
-            s = f.read()
-            try:
-                # v1 and v2 and json in the .ipynb files.
-                nb = current.reads(s, u'json')
-            except ValueError as e:
-                msg = u"Unreadable Notebook: %s" % e
-                raise web.HTTPError(400, msg, reason=msg)
-        return last_modified, nb
-    
-    def read_notebook_object(self, notebook_name, notebook_path='/'):
-        """Get the Notebook representation of a notebook by notebook_name."""
-        path = self.get_os_path(notebook_name, notebook_path)
-        if not os.path.isfile(path):
-            raise web.HTTPError(404, u'Notebook does not exist: %s' % notebook_name)
-        last_modified, nb = self.read_notebook_object_from_path(path)
-        # Always use the filename as the notebook name.
-        # Eventually we will get rid of the notebook name in the metadata
-        # but for now, that name is just an empty string. Until the notebooks
-        # web service knows about names in URLs we still pass the name
-        # back to the web app using the metadata though.
-        nb.metadata.name = os.path.splitext(os.path.basename(path))[0]
-        return last_modified, nb
-    
-    def write_notebook_object(self, nb, notebook_name=None, notebook_path='/', new_name= None):
-        """Save an existing notebook object by notebook_name."""
-        if new_name == None:
-            try:
-                new_name = normalize('NFC', nb.metadata.name)
-            except AttributeError:
-                raise web.HTTPError(400, u'Missing notebook name')
+        # Create the notebook model.
+        model ={}
+        model['name'] = name
+        model['path'] = path
+        model['last_modified'] = last_modified.ctime()
+        if content is True:
+            with open(os_path,'r') as f:
+                s = f.read()
+                try:
+                    # v1 and v2 and json in the .ipynb files.
+                    nb = current.reads(s, u'json')
+                except ValueError as e:
+                    raise web.HTTPError(400, u"Unreadable Notebook: %s" % e)
+            model['content'] = nb
+        return model
 
-        new_path = notebook_path
-        old_name = notebook_name
-        old_checkpoints = self.list_checkpoints(old_name)
-        
-        path = self.get_os_path(new_name, new_path)
-        
-        # Right before we save the notebook, we write an empty string as the
-        # notebook name in the metadata. This is to prepare for removing
-        # this attribute entirely post 1.0. The web app still uses the metadata
-        # name for now.
-        nb.metadata.name = u''
+    def save_notebook_model(self, model, name, path='/'):
+        """Save the notebook model and return the model with no content."""
+
+        if 'content' not in model:
+            raise web.HTTPError(400, u'No notebook JSON data provided')
+
+        new_path = model.get('path', path)
+        new_name = model.get('name', name)
+
+        if path != new_path or name != new_name:
+            self.rename_notebook(name, path, new_name, new_path)
 
+        # Save the notebook file
+        ospath = self.get_os_path(new_name, new_path)
+        nb = model['content']
+        if 'name' in nb['metadata']:
+            nb['metadata']['name'] = u''
         try:
-            self.log.debug("Autosaving notebook %s", path)
-            with open(path,'w') as f:
+            self.log.debug("Autosaving notebook %s", ospath)
+            with open(ospath,'w') as f:
                 current.write(nb, f, u'json')
         except Exception as e:
-            raise web.HTTPError(400, u'Unexpected error while autosaving notebook: %s' % e)
+            #raise web.HTTPError(400, u'Unexpected error while autosaving notebook: %s' % ospath)
+            raise e
 
-        # save .py script as well
+        # Save .py script as well
         if self.save_script:
             pypath = os.path.splitext(path)[0] + '.py'
             self.log.debug("Writing script %s", pypath)
             try:
-                with io.open(pypath,'w', encoding='utf-8') as f:
-                    current.write(nb, f, u'py')
+                with io.open(pypath, 'w', encoding='utf-8') as f:
+                    current.write(model, f, u'py')
             except Exception as e:
-                raise web.HTTPError(400, u'Unexpected error while saving notebook as script: %s' % e)
-        
-        if old_name != None:
-            # remove old files if the name changed
-            if old_name != new_name:            
-                # remove renamed original, if it exists
-                old_path = self.get_os_path(old_name, notebook_path)
-                if os.path.isfile(old_path):
-                    self.log.debug("unlinking notebook %s", old_path)
-                    os.unlink(old_path)
-            
-                # cleanup old script, if it exists
-                if self.save_script:
-                    old_pypath = os.path.splitext(old_path)[0] + '.py'
-                    if os.path.isfile(old_pypath):
-                        self.log.debug("unlinking script %s", old_pypath)
-                        os.unlink(old_pypath)
-                
-                # rename checkpoints to follow file
-                for cp in old_checkpoints:
-                    checkpoint_id = cp['checkpoint_id']
-                    old_cp_path = self.get_checkpoint_path_by_name(old_name, checkpoint_id)
-                    new_cp_path = self.get_checkpoint_path_by_name(new_name, checkpoint_id)
-                    if os.path.isfile(old_cp_path):
-                        self.log.debug("renaming checkpoint %s -> %s", old_cp_path, new_cp_path)
-                        os.rename(old_cp_path, new_cp_path)
-            
-        return new_name
-            
-    def delete_notebook(self, notebook_name, notebook_path):
-        """Delete notebook by notebook_name."""
-        nb_path = self.get_os_path(notebook_name, notebook_path)
+                raise web.HTTPError(400, u'Unexpected error while saving notebook as script: %s' % pypath)
+
+        model = self.get_notebook_model(name, path, content=False)
+        return model
+
+    def update_notebook_model(self, model, name, path='/'):
+        """Update the notebook's path and/or name"""
+        new_name = model.get('name', name)
+        new_path = model.get('path', path)
+        if path != new_path or name != new_name:
+            self.rename_notebook(name, path, new_name, new_path)
+        model = self.get_notebook_model(new_name, new_path, content=False)
+        return model
+
+    def delete_notebook_model(self, name, path='/'):
+        """Delete notebook by name and path."""
+        nb_path = self.get_os_path(name, path)
         if not os.path.isfile(nb_path):
-            raise web.HTTPError(404, u'Notebook does not exist: %s' % notebook_name)
+            raise web.HTTPError(404, u'Notebook does not exist: %s' % nb_path)
         
         # clear checkpoints
-        for checkpoint in self.list_checkpoints(notebook_name):
+        for checkpoint in self.list_checkpoints(name):
             checkpoint_id = checkpoint['checkpoint_id']
-            path = self.get_checkpoint_path(notebook_name, checkpoint_id)
-            self.log.debug(path)
-            if os.path.isfile(path):
-                self.log.debug("unlinking checkpoint %s", path)
-                os.unlink(path)
+            cp_path = self.get_checkpoint_path(checkpoint_id, name, path)
+            self.log.debug(cp_path)
+            if os.path.isfile(cp_path):
+                self.log.debug("Unlinking checkpoint %s", cp_path)
+                os.unlink(cp_path)
         
-        self.log.debug("unlinking notebook %s", nb_path)
+        self.log.debug("Unlinking notebook %s", nb_path)
         os.unlink(nb_path)
 
-    def increment_filename(self, basename, notebook_path='/'):
-        """Return a non-used filename of the form basename<int>.
+    def rename_notebook(self, old_name, old_path, new_name, new_path):
+        """Rename a notebook."""
+        if new_name == old_name and new_path == old_path:
+            return
         
-        This searches through the filenames (basename0, basename1, ...)
-        until is find one that is not already being used. It is used to
-        create Untitled and Copy names that are unique.
-        """
-        i = 0
-        while True:
-            name = u'%s%i.ipynb' % (basename,i)
-            path = self.get_os_path(name, notebook_path)
-            if not os.path.isfile(path):
-                break
-            else:
-                i = i+1
-        return name
-    
+        new_full_path = self.get_os_path(new_name, new_path)
+        old_full_path = self.get_os_path(old_name, old_path)
+
+        # Should we proceed with the move?
+        if os.path.isfile(new_full_path):
+            raise web.HTTPError(409, u'Notebook with name already exists: ' % new_full_path)
+        if self.save_script:
+            old_pypath = os.path.splitext(old_full_path)[0] + '.py'
+            new_pypath = os.path.splitext(new_full_path)[0] + '.py'
+            if os.path.isfile(new_pypath):
+                raise web.HTTPError(409, u'Python script with name already exists: %s' % new_pypath)
+
+        # Move the notebook file
+        try:
+            os.rename(old_full_path, new_full_path)
+        except:
+            raise web.HTTPError(400, u'Unknown error renaming notebook: %s' % old_full_path)
+
+        # Move the checkpoints
+        old_checkpoints = self.list_checkpoints(old_name, old_path)
+        for cp in old_checkpoints:
+            checkpoint_id = cp['checkpoint_id']
+            old_cp_path = self.get_checkpoint_path(checkpoint_id, old_name, path)
+            new_cp_path = self.get_checkpoint_path(checkpoint_id, new_name, path)
+            if os.path.isfile(old_cp_path):
+                self.log.debug("Renaming checkpoint %s -> %s", old_cp_path, new_cp_path)
+                os.rename(old_cp_path, new_cp_path)
+
+        # Move the .py script
+        if self.save_script:
+            os.rename(old_pypath, new_pypath)
+  
     # Checkpoint-related utilities
     
-    def get_checkpoint_path_by_name(self, name, checkpoint_id, notebook_path='/'):
-        """Return a full path to a notebook checkpoint, given its name and checkpoint id."""
+    def get_checkpoint_path(self, checkpoint_id, name, path='/'):
+        """find the path to a checkpoint"""
         filename = u"{name}-{checkpoint_id}{ext}".format(
             name=name,
             checkpoint_id=checkpoint_id,
             ext=self.filename_ext,
         )
-        if notebook_path ==None:
-            path = os.path.join(self.checkpoint_dir, filename)
-        else:
-            path = os.path.join(notebook_path, self.checkpoint_dir, filename)
-        return path
-    
-    def get_checkpoint_path(self, notebook_name, checkpoint_id, notebook_path='/'):
-        """find the path to a checkpoint"""
-        name = notebook_name
-        return self.get_checkpoint_path_by_name(name, checkpoint_id, notebook_path)
-    
-    def get_checkpoint_info(self, notebook_name, checkpoint_id, notebook_path='/'):
+        cp_path = os.path.join(path, self.checkpoint_dir, filename)
+        return cp_path
+
+    def get_checkpoint_model(self, checkpoint_id, name, path='/'):
         """construct the info dict for a given checkpoint"""
-        path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
-        stats = os.stat(path)
+        cp_path = self.get_checkpoint_path(checkpoint_id, name, path)
+        stats = os.stat(cp_path)
         last_modified = tz.utcfromtimestamp(stats.st_mtime)
         info = dict(
             checkpoint_id = checkpoint_id,
             last_modified = last_modified,
         )
-        
         return info
         
     # public checkpoint API
     
-    def create_checkpoint(self, notebook_name, notebook_path='/'):
+    def create_checkpoint(self, name, path='/'):
         """Create a checkpoint from the current state of a notebook"""
-        nb_path = self.get_os_path(notebook_name, notebook_path)
+        nb_path = self.get_os_path(name, path)
         # only the one checkpoint ID:
         checkpoint_id = u"checkpoint"
-        cp_path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
-        self.log.debug("creating checkpoint for notebook %s", notebook_name)
+        cp_path = self.get_checkpoint_path(checkpoint_id, name, path)
+        self.log.debug("creating checkpoint for notebook %s", name)
         if not os.path.exists(self.checkpoint_dir):
             os.mkdir(self.checkpoint_dir)
         shutil.copy2(nb_path, cp_path)
         
         # return the checkpoint info
-        return self.get_checkpoint_info(notebook_name, checkpoint_id, notebook_path)
+        return self.get_checkpoint_model(checkpoint_id, name, path)
     
-    def list_checkpoints(self, notebook_name, notebook_path='/'):
+    def list_checkpoints(self, name, path='/'):
         """list the checkpoints for a given notebook
         
         This notebook manager currently only supports one checkpoint per notebook.
         """
         checkpoint_id = "checkpoint"
-        path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
+        path = self.get_checkpoint_path(checkpoint_id, name, path)
         if not os.path.exists(path):
             return []
         else:
-            return [self.get_checkpoint_info(notebook_name, checkpoint_id, notebook_path)]
+            return [self.get_checkpoint_model(checkpoint_id, name, path)]
         
     
-    def restore_checkpoint(self, notebook_name, checkpoint_id, notebook_path='/'):
+    def restore_checkpoint(self, checkpoint_id, name, path='/'):
         """restore a notebook to a checkpointed state"""
-        self.log.info("restoring Notebook %s from checkpoint %s", notebook_name, checkpoint_id)
-        nb_path = self.get_os_path(notebook_name, notebook_path)
-        cp_path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
+        self.log.info("restoring Notebook %s from checkpoint %s", name, checkpoint_id)
+        nb_path = self.get_os_path(name, path)
+        cp_path = self.get_checkpoint_path(checkpoint_id, name, path)
         if not os.path.isfile(cp_path):
             self.log.debug("checkpoint file does not exist: %s", cp_path)
             raise web.HTTPError(404,
-                u'Notebook checkpoint does not exist: %s-%s' % (notebook_name, checkpoint_id)
+                u'Notebook checkpoint does not exist: %s-%s' % (name, checkpoint_id)
             )
         # ensure notebook is readable (never restore from an unreadable notebook)
-        last_modified, nb = self.read_notebook_object_from_path(cp_path)
+        with file(cp_path, 'r') as f:
+            nb = current.read(f, u'json')
         shutil.copy2(cp_path, nb_path)
         self.log.debug("copying %s -> %s", cp_path, nb_path)
     
-    def delete_checkpoint(self, notebook_name, checkpoint_id, notebook_path='/'):
+    def delete_checkpoint(self, checkpoint_id, name, path='/'):
         """delete a notebook's checkpoint"""
-        path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
-        if not os.path.isfile(path):
+        cp_path = self.get_checkpoint_path(checkpoint_id, name, path)
+        if not os.path.isfile(cp_path):
             raise web.HTTPError(404,
-                u'Notebook checkpoint does not exist: %s-%s' % (notebook_name, checkpoint_id)
+                u'Notebook checkpoint does not exist: %s-%s' % (name, checkpoint_id)
             )
-        self.log.debug("unlinking %s", path)
-        os.unlink(path)
+        self.log.debug("unlinking %s", cp_path)
+        os.unlink(cp_path)
     
     def info_string(self):
         return "Serving notebooks from local directory: %s" % self.notebook_dir

IPython/html/services/notebooks/nbmanager.py

@@ -1,301 +1,224 b''
 """A base class notebook manager.
 
 Authors:
 
 * Brian Granger
+* Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 import uuid
+from urllib import quote, unquote
 
 from tornado import web
-from urllib import quote, unquote
 
+from IPython.html.utils import url_path_join
 from IPython.config.configurable import LoggingConfigurable
 from IPython.nbformat import current
 from IPython.utils.traitlets import List, Dict, Unicode, TraitError
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class NotebookManager(LoggingConfigurable):
 
     # Todo:
     # The notebook_dir attribute is used to mean a couple of different things:
     # 1. Where the notebooks are stored if FileNotebookManager is used.
     # 2. The cwd of the kernel for a project.
     # Right now we use this attribute in a number of different places and
     # we are going to have to disentangle all of this.
     notebook_dir = Unicode(os.getcwdu(), config=True, help="""
             The directory to use for notebooks.
             """)
 
+    filename_ext = Unicode(u'.ipynb')
+
     def named_notebook_path(self, notebook_path):
-        """Given a notebook_path name, returns a (name, path) tuple, where
-        name is a .ipynb file, and path is the directory for the file, which
-        *always* starts *and* ends with a '/' character.
+        """Given notebook_path (*always* a URL path to notebook), returns a 
+        (name, path) tuple, where name is a .ipynb file, and path is the 
+        URL path that describes the file system path for the file. 
+        It *always* starts *and* ends with a '/' character.
 
         Parameters
         ----------
         notebook_path : string
             A path that may be a .ipynb name or a directory
 
         Returns
         -------
         name : string or None
             the filename of the notebook, or None if not a .ipynb extension
         path : string
             the path to the directory which contains the notebook
         """
         names = notebook_path.split('/')
         names = [n for n in names if n != ''] # remove duplicate splits
 
         names = [''] + names
 
         if names and names[-1].endswith(".ipynb"):
             name = names[-1]
             path = "/".join(names[:-1]) + '/'
         else:
             name = None
             path = "/".join(names) + '/'
         return name, path
         
     def get_os_path(self, fname=None, path='/'):
-        """Given a notebook name and a server URL path, return its file system
+        """Given a notebook name and a URL path, return its file system
         path.
 
         Parameters
         ----------
         fname : string
             The name of a notebook file with the .ipynb extension
         path : string
             The relative URL path (with '/' as separator) to the named
             notebook.
 
         Returns
         -------
         path : string
             A file system path that combines notebook_dir (location where
             server started), the relative path, and the filename with the
             current operating system's url.
         """
         parts = path.split('/')
         parts = [p for p in parts if p != ''] # remove duplicate splits
         if fname is not None:
             parts += [fname]
         path = os.path.join(self.notebook_dir, *parts)
         return path
 
     def url_encode(self, path):
-        """Returns the path with all special characters URL encoded"""
-        parts = os.path.split(path)
-        return os.path.join(*[quote(p) for p in parts])
+        """Takes a URL path with special characters and returns 
+        the path with all these characters URL encoded"""
+        parts = path.split('/')
+        return '/'.join([quote(p) for p in parts])
 
     def url_decode(self, path):
-        """Returns the URL with special characters decoded"""
-        parts = os.path.split(path)
-        return os.path.join(*[unquote(p) for p in parts])
+        """Takes a URL path with encoded special characters and 
+        returns the URL with special characters decoded"""
+        parts = path.split('/')
+        return '/'.join([unquote(p) for p in parts])
 
-    def _notebook_dir_changed(self, new):
-        """do a bit of validation of the notebook dir"""
+    def _notebook_dir_changed(self, name, old, new):
+        """Do a bit of validation of the notebook dir."""
         if not os.path.isabs(new):
             # If we receive a non-absolute path, make it absolute.
             abs_new = os.path.abspath(new)
-            #self.notebook_dir = os.path.dirname(abs_new)
+            self.notebook_dir = os.path.dirname(abs_new)
             return
         if os.path.exists(new) and not os.path.isdir(new):
             raise TraitError("notebook dir %r is not a directory" % new)
         if not os.path.exists(new):
             self.log.info("Creating notebook dir %s", new)
             try:
                 os.mkdir(new)
             except:
                 raise TraitError("Couldn't create notebook dir %r" % new)
-                
-    allowed_formats = List([u'json',u'py'])
 
-    def add_new_folder(self, path=None):
-        new_path = os.path.join(self.notebook_dir, path)
-        if not os.path.exists(new_path):
-            os.makedirs(new_path) 
-        else:
-            raise web.HTTPError(409, u'Directory already exists or creation permission not allowed.')
+    # Main notebook API
 
-    def load_notebook_names(self, path):
-        """Load the notebook names into memory.
-
-        This should be called once immediately after the notebook manager
-        is created to load the existing notebooks into the mapping in
-        memory.
+    def increment_filename(self, basename, path='/'):
+        """Increment a notebook filename without the .ipynb to make it unique.
+        
+        Parameters
+        ----------
+        basename : unicode
+            The name of a notebook without the ``.ipynb`` file extension.
+        path : unicode
+            The URL path of the notebooks directory
         """
-        self.list_notebooks(path)
+        return basename
 
     def list_notebooks(self):
-        """List all notebooks.
+        """Return a list of notebook dicts without content.
 
         This returns a list of dicts, each of the form::
 
             dict(notebook_id=notebook,name=name)
 
         This list of dicts should be sorted by name::
 
             data = sorted(data, key=lambda item: item['name'])
         """
         raise NotImplementedError('must be implemented in a subclass')
 
-    def notebook_model(self, name, path='/', content=True):
-        """ Creates the standard notebook model """
-        last_modified, contents = self.read_notebook_model(name, path)
-        model = {"name": name, 
-                    "path": path,
-                    "last_modified": last_modified.ctime()}
-        if content is True:
-            model['content'] = contents
-        return model
-
-    def get_notebook(self, notebook_name, notebook_path='/', format=u'json'):
-        """Get the representation of a notebook in format by notebook_name."""
-        format = unicode(format)
-        if format not in self.allowed_formats:
-            raise web.HTTPError(415, u'Invalid notebook format: %s' % format)
-        kwargs = {}
-        last_mod, nb = self.read_notebook_object(notebook_name, notebook_path)
-        if format == 'json':
-            # don't split lines for sending over the wire, because it
-            # should match the Python in-memory format.
-            kwargs['split_lines'] = False
-        representation = current.writes(nb, format, **kwargs)
-        name = nb.metadata.get('name', 'notebook')
-        return last_mod, representation, name
-
-    def read_notebook_model(self, notebook_name, notebook_path='/'):
-        """Get the object representation of a notebook by notebook_id."""
+    def get_notebook_model(self, name, path='/', content=True):
+        """Get the notebook model with or without content."""
         raise NotImplementedError('must be implemented in a subclass')
 
-    def save_notebook(self, model, name=None, path='/'):
-        """Save the Notebook"""
-        if name is None:
-            name = self.increment_filename('Untitled', path)
-        if 'content' not in model:
-            metadata = current.new_metadata(name=name)
-            nb = current.new_notebook(metadata=metadata)
-        else:
-            nb = model['content']
-        self.write_notebook_object()
-            
-
-    def save_new_notebook(self, data, notebook_path='/', name=None, format=u'json'):
-        """Save a new notebook and return its name.
+    def save_notebook_model(self, model, name, path='/'):
+        """Save the notebook model and return the model with no content."""
+        raise NotImplementedError('must be implemented in a subclass')
 
-        If a name is passed in, it overrides any values in the notebook data
-        and the value in the data is updated to use that value.
-        """
-        if format not in self.allowed_formats:
-            raise web.HTTPError(415, u'Invalid notebook format: %s' % format)
-
-        try:
-            nb = current.reads(data.decode('utf-8'), format)
-        except:
-            raise web.HTTPError(400, u'Invalid JSON data')
-
-        if name is None:
-           try:
-               name = nb.metadata.name
-           except AttributeError:
-               raise web.HTTPError(400, u'Missing notebook name')
-        nb.metadata.name = name
-
-        notebook_name = self.write_notebook_object(nb, notebook_path=notebook_path)
-        return notebook_name
-
-    def save_notebook(self, data, notebook_path='/', name=None, format=u'json'):
-        """Save an existing notebook by notebook_name."""
-        if format not in self.allowed_formats:
-            raise web.HTTPError(415, u'Invalid notebook format: %s' % format)
-
-        try:
-            nb = current.reads(data.decode('utf-8'), format)
-        except:
-            raise web.HTTPError(400, u'Invalid JSON data')
-
-        if name is not None:
-            nb.metadata.name = name
-        self.write_notebook_object(nb, name, notebook_path, new_name)
-
-    def write_notebook_model(self, model):
-        """Write a notebook object and return its notebook_name.
-
-        If notebook_name is None, this method should create a new notebook_name.
-        If notebook_name is not None, this method should check to make sure it
-        exists and is valid.
-        """
+    def update_notebook_model(self, model, name, path='/'):
+        """Update the notebook model and return the model with no content."""
         raise NotImplementedError('must be implemented in a subclass')
 
-    def delete_notebook(self, notebook_name, notebook_path):
-        """Delete notebook by notebook_id."""
+    def delete_notebook_model(self, name, path):
+        """Delete notebook by name and path."""
         raise NotImplementedError('must be implemented in a subclass')
 
-    def increment_filename(self, name):
-        """Increment a filename to make it unique.
+    def create_notebook_model(self, model=None, path='/'):
+        """Create a new untitled notebook and return its model with no content."""
+        name = self.increment_filename('Untitled', path)
+        if model is None:
+            model = {}
+            metadata = current.new_metadata(name=u'')
+            nb = current.new_notebook(metadata=metadata)
+            model['content'] = nb
+            model['name'] = name
+            model['path'] = path
+        model = self.save_notebook_model(model, name, path)
+        return model
 
-        This exists for notebook stores that must have unique names. When a notebook
-        is created or copied this method constructs a unique filename, typically
-        by appending an integer to the name.
-        """
-        return name
-
-    def new_notebook(self, notebook_path='/'):
-        """Create a new notebook and return its notebook_name."""
-        name = self.increment_filename('Untitled', notebook_path)
-        metadata = current.new_metadata(name=name)
-        nb = current.new_notebook(metadata=metadata)
-        notebook_name = self.write_notebook_object(nb, notebook_path=notebook_path)
-        return notebook_name
-
-    def copy_notebook(self, name, path='/'):
-        """Copy an existing notebook and return its new notebook_name."""
-        last_mod, nb = self.read_notebook_object(name, path)
-        name = nb.metadata.name + '-Copy'
-        name = self.increment_filename(name, path)
-        nb.metadata.name = name
-        notebook_name = self.write_notebook_object(nb, notebook_path = path)
-        return notebook_name  
+    def copy_notebook(self, name, path='/', content=False):
+        """Copy an existing notebook and return its new model."""
+        model = self.get_notebook_model(name, path)
+        name = os.path.splitext(name)[0] + '-Copy'
+        name = self.increment_filename(name, path) + self.filename_ext
+        model['name'] = name
+        model = self.save_notebook_model(model, name, path, content=content)
+        return model
     
     # Checkpoint-related
     
-    def create_checkpoint(self, notebook_name, notebook_path='/'):
+    def create_checkpoint(self, name, path='/'):
         """Create a checkpoint of the current state of a notebook
         
         Returns a checkpoint_id for the new checkpoint.
         """
         raise NotImplementedError("must be implemented in a subclass")
     
-    def list_checkpoints(self, notebook_name, notebook_path='/'):
+    def list_checkpoints(self, name, path='/'):
         """Return a list of checkpoints for a given notebook"""
         return []
     
-    def restore_checkpoint(self, notebook_name, checkpoint_id, notebook_path='/'):
+    def restore_checkpoint(self, checkpoint_id, name, path='/'):
         """Restore a notebook from one of its checkpoints"""
         raise NotImplementedError("must be implemented in a subclass")
 
-    def delete_checkpoint(self, notebook_name, checkpoint_id, notebook_path='/'):
+    def delete_checkpoint(self, checkpoint_id, name, path='/'):
         """delete a checkpoint for a notebook"""
         raise NotImplementedError("must be implemented in a subclass")
     
     def log_info(self):
         self.log.info(self.info_string())
     
     def info_string(self):
-        return "Serving notebooks"
+        return "Serving notebooks"
  No newline at end of file

IPython/html/services/notebooks/tests/test_nbmanager.py

@@ -1,111 +1,266 b''
 """Tests for the notebook manager."""
 
 import os
+
+from tornado.web import HTTPError
 from unittest import TestCase
 from tempfile import NamedTemporaryFile
 
 from IPython.utils.tempdir import TemporaryDirectory
 from IPython.utils.traitlets import TraitError
+from IPython.html.utils import url_path_join
 
 from ..filenbmanager import FileNotebookManager
 from ..nbmanager import NotebookManager
 
 class TestFileNotebookManager(TestCase):
 
     def test_nb_dir(self):
         with TemporaryDirectory() as td:
             fm = FileNotebookManager(notebook_dir=td)
             self.assertEqual(fm.notebook_dir, td)
 
     def test_create_nb_dir(self):
         with TemporaryDirectory() as td:
             nbdir = os.path.join(td, 'notebooks')
             fm = FileNotebookManager(notebook_dir=nbdir)
             self.assertEqual(fm.notebook_dir, nbdir)
 
     def test_missing_nb_dir(self):
         with TemporaryDirectory() as td:
             nbdir = os.path.join(td, 'notebook', 'dir', 'is', 'missing')
             self.assertRaises(TraitError, FileNotebookManager, notebook_dir=nbdir)
 
     def test_invalid_nb_dir(self):
         with NamedTemporaryFile() as tf:
             self.assertRaises(TraitError, FileNotebookManager, notebook_dir=tf.name)
 
     def test_get_os_path(self):
         # full filesystem path should be returned with correct operating system
         # separators.
         with TemporaryDirectory() as td:
             nbdir = os.path.join(td, 'notebooks')
             fm = FileNotebookManager(notebook_dir=nbdir)
             path = fm.get_os_path('test.ipynb', '/path/to/notebook/')
             rel_path_list =  '/path/to/notebook/test.ipynb'.split('/')
             fs_path = os.path.join(fm.notebook_dir, *rel_path_list)
             self.assertEqual(path, fs_path)
 
             fm = FileNotebookManager(notebook_dir=nbdir)
             path = fm.get_os_path('test.ipynb')
             fs_path = os.path.join(fm.notebook_dir, 'test.ipynb')
             self.assertEqual(path, fs_path)
 
             fm = FileNotebookManager(notebook_dir=nbdir)
             path = fm.get_os_path('test.ipynb', '////')
             fs_path = os.path.join(fm.notebook_dir, 'test.ipynb')
             self.assertEqual(path, fs_path)
 
 class TestNotebookManager(TestCase):
+    
+    def make_dir(self, abs_path, rel_path):
+        """make subdirectory, rel_path is the relative path
+        to that directory from the location where the server started"""
+        os_path = os.path.join(abs_path, rel_path)
+        try:
+            os.makedirs(os_path)
+        except OSError:
+            print "Directory already exists."
+
     def test_named_notebook_path(self):
         nm = NotebookManager()
 
         # doesn't end with ipynb, should just be path
         name, path = nm.named_notebook_path('hello')
         self.assertEqual(name, None)
         self.assertEqual(path, '/hello/')
 
         name, path = nm.named_notebook_path('/')
         self.assertEqual(name, None)
         self.assertEqual(path, '/')
 
         name, path = nm.named_notebook_path('hello.ipynb')
         self.assertEqual(name, 'hello.ipynb')
         self.assertEqual(path, '/')
 
         name, path = nm.named_notebook_path('/hello.ipynb')
         self.assertEqual(name, 'hello.ipynb')
         self.assertEqual(path, '/')
 
         name, path = nm.named_notebook_path('/this/is/a/path/hello.ipynb')
         self.assertEqual(name, 'hello.ipynb')
         self.assertEqual(path, '/this/is/a/path/')
 
         name, path = nm.named_notebook_path('path/without/leading/slash/hello.ipynb')
         self.assertEqual(name, 'hello.ipynb')
         self.assertEqual(path, '/path/without/leading/slash/')
 
     def test_url_encode(self):
         nm = NotebookManager()
 
         # changes path or notebook name with special characters to url encoding
         # these tests specifically encode paths with spaces
         path = nm.url_encode('/this is a test/for spaces/')
         self.assertEqual(path, '/this%20is%20a%20test/for%20spaces/')
 
         path = nm.url_encode('notebook with space.ipynb')
         self.assertEqual(path, 'notebook%20with%20space.ipynb')
 
         path = nm.url_encode('/path with a/notebook and space.ipynb')
         self.assertEqual(path, '/path%20with%20a/notebook%20and%20space.ipynb')
 
     def test_url_decode(self):
         nm = NotebookManager()
-        
+
         # decodes a url string to a plain string
         # these tests decode paths with spaces
         path = nm.url_decode('/this%20is%20a%20test/for%20spaces/')
         self.assertEqual(path, '/this is a test/for spaces/')
-        
+
         path = nm.url_decode('notebook%20with%20space.ipynb')
         self.assertEqual(path, 'notebook with space.ipynb')
-        
+
         path = nm.url_decode('/path%20with%20a/notebook%20and%20space.ipynb')
         self.assertEqual(path, '/path with a/notebook and space.ipynb')
+
+    def test_create_notebook_model(self):
+        with TemporaryDirectory() as td:
+            # Test in root directory
+            nm = FileNotebookManager(notebook_dir=td)
+            model = nm.create_notebook_model()
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], 'Untitled0.ipynb')
+            self.assertEqual(model['path'], '/')
+
+            # Test in sub-directory
+            sub_dir = '/foo/'
+            self.make_dir(nm.notebook_dir, 'foo')
+            model = nm.create_notebook_model(None, sub_dir)
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], 'Untitled0.ipynb')
+            self.assertEqual(model['path'], sub_dir)
+
+    def test_get_notebook_model(self):
+        with TemporaryDirectory() as td:
+            # Test in root directory
+            # Create a notebook
+            nm = FileNotebookManager(notebook_dir=td)
+            model = nm.create_notebook_model()
+            name = model['name']
+            path = model['path']
+
+            # Check that we 'get' on the notebook we just created
+            model2 = nm.get_notebook_model(name, path)
+            assert isinstance(model2, dict)
+            self.assertIn('name', model2)
+            self.assertIn('path', model2)
+            self.assertEqual(model['name'], name)
+            self.assertEqual(model['path'], path)
+
+            # Test in sub-directory
+            sub_dir = '/foo/'
+            self.make_dir(nm.notebook_dir, 'foo')
+            model = nm.create_notebook_model(None, sub_dir)
+            model2 = nm.get_notebook_model(name, sub_dir)
+            assert isinstance(model2, dict)
+            self.assertIn('name', model2)
+            self.assertIn('path', model2)
+            self.assertIn('content', model2)
+            self.assertEqual(model2['name'], 'Untitled0.ipynb')
+            self.assertEqual(model2['path'], sub_dir)
+            
+    def test_update_notebook_model(self):
+        with TemporaryDirectory() as td:
+            # Test in root directory
+            # Create a notebook
+            nm = FileNotebookManager(notebook_dir=td)
+            model = nm.create_notebook_model()
+            name = model['name']
+            path = model['path']
+
+            # Change the name in the model for rename
+            model['name'] = 'test.ipynb'
+            model = nm.update_notebook_model(model, name, path)
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], 'test.ipynb')
+
+            # Make sure the old name is gone
+            self.assertRaises(HTTPError, nm.get_notebook_model, name, path)
+
+            # Test in sub-directory
+            # Create a directory and notebook in that directory
+            sub_dir = '/foo/'
+            self.make_dir(nm.notebook_dir, 'foo')
+            model = nm.create_notebook_model(None, sub_dir)
+            name = model['name']
+            path = model['path']
+            
+            # Change the name in the model for rename
+            model['name'] = 'test_in_sub.ipynb'
+            model = nm.update_notebook_model(model, name, path)
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], 'test_in_sub.ipynb')
+            self.assertEqual(model['path'], sub_dir)
+            
+            # Make sure the old name is gone
+            self.assertRaises(HTTPError, nm.get_notebook_model, name, path)
+
+    def test_save_notebook_model(self):
+        with TemporaryDirectory() as td:
+            # Test in the root directory
+            # Create a notebook
+            nm = FileNotebookManager(notebook_dir=td)
+            model = nm.create_notebook_model()
+            name = model['name']
+            path = model['path']
+
+            # Get the model with 'content'
+            full_model = nm.get_notebook_model(name, path)
+
+            # Save the notebook
+            model = nm.save_notebook_model(full_model, name, path)
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], name)
+            self.assertEqual(model['path'], path)
+
+            # Test in sub-directory
+            # Create a directory and notebook in that directory
+            sub_dir = '/foo/'
+            self.make_dir(nm.notebook_dir, 'foo')
+            model = nm.create_notebook_model(None, sub_dir)
+            name = model['name']
+            path = model['path']
+            model = nm.get_notebook_model(name, path)
+
+            # Change the name in the model for rename
+            model = nm.save_notebook_model(model, name, path)
+            assert isinstance(model, dict)
+            self.assertIn('name', model)
+            self.assertIn('path', model)
+            self.assertEqual(model['name'], 'Untitled0.ipynb')
+            self.assertEqual(model['path'], sub_dir)          
+
+    def test_delete_notebook_model(self):
+        with TemporaryDirectory() as td:
+            # Test in the root directory
+            # Create a notebook
+            nm = FileNotebookManager(notebook_dir=td)
+            model = nm.create_notebook_model()
+            name = model['name']
+            path = model['path']
+            
+            # Delete the notebook
+            nm.delete_notebook_model(name, path)
+            
+            # Check that a 'get' on the deleted notebook raises and error
+            self.assertRaises(HTTPError, nm.get_notebook_model, name, path)

IPython/html/services/notebooks/tests/test_notebooks_api.py

@@ -1,115 +1,112 b''
 """Test the notebooks webservice API."""
 
 
 import os
 import sys
 import json
 from zmq.utils import jsonapi
 
 import requests
 
 from IPython.html.tests.launchnotebook import NotebookTestBase
 
 class APITest(NotebookTestBase):
     """Test the kernels web service API"""
 
     def notebook_url(self):
         return super(APITest,self).base_url() + 'api/notebooks'
 
     def mknb(self, name='', path='/'):
         url = self.notebook_url() + path
         return url, requests.post(url)
 
     def delnb(self, name, path='/'):
         url = self.notebook_url() + path + name
         r = requests.delete(url)
         return r.status_code
 
     def test_notebook_handler(self):
         # POST a notebook and test the dict thats returned.
         #url, nb = self.mknb()
         url = self.notebook_url()
-        nb = requests.post(url)
+        nb = requests.post(url+'/')
+        print nb.text
         data = nb.json()
         assert isinstance(data, dict)
         self.assertIn('name', data)
         self.assertIn('path', data)
         self.assertEqual(data['name'], u'Untitled0.ipynb')
         self.assertEqual(data['path'], u'/')
 
         # GET list of notebooks in directory.
         r = requests.get(url)
         assert isinstance(r.json(), list)
         assert isinstance(r.json()[0], dict)
         
         self.delnb('Untitled0.ipynb')
         
         # GET with a notebook name.
         url, nb = self.mknb()
         data = nb.json()
         url = self.notebook_url() + '/Untitled0.ipynb'
         r = requests.get(url)
         assert isinstance(data, dict)
-        self.assertEqual(r.json(), data)
 
         # PATCH (rename) request.
         new_name = {'name':'test.ipynb'}
         r = requests.patch(url, data=jsonapi.dumps(new_name))
         data = r.json()
         assert isinstance(data, dict)
 
         # make sure the patch worked.
         new_url = self.notebook_url() + '/test.ipynb'
         r = requests.get(new_url)
         assert isinstance(r.json(), dict)
-        self.assertEqual(r.json(), data)
 
         # GET bad (old) notebook name.
         r = requests.get(url)
         self.assertEqual(r.status_code, 404)
 
         # POST notebooks to folders one and two levels down.
         os.makedirs(os.path.join(self.notebook_dir.name, 'foo'))
         os.makedirs(os.path.join(self.notebook_dir.name, 'foo','bar'))
         assert os.path.isdir(os.path.join(self.notebook_dir.name, 'foo'))
         url, nb = self.mknb(path='/foo/')
         url2, nb2 = self.mknb(path='/foo/bar/')
         data = nb.json()
         data2 = nb2.json()
         assert isinstance(data, dict)
         assert isinstance(data2, dict)
         self.assertIn('name', data)
         self.assertIn('path', data)
         self.assertEqual(data['name'], u'Untitled0.ipynb')
         self.assertEqual(data['path'], u'/foo/')
         self.assertIn('name', data2)
         self.assertIn('path', data2)
         self.assertEqual(data2['name'], u'Untitled0.ipynb')
         self.assertEqual(data2['path'], u'/foo/bar/')
 
         # GET request on notebooks one and two levels down.
         r = requests.get(url+'/Untitled0.ipynb')
         r2 = requests.get(url2+'/Untitled0.ipynb')
         assert isinstance(r.json(), dict)
-        self.assertEqual(r.json(), data)
         assert isinstance(r2.json(), dict)
-        self.assertEqual(r2.json(), data2)
 
         # PATCH notebooks that are one and two levels down.
         new_name = {'name': 'testfoo.ipynb'}
         r = requests.patch(url+'/Untitled0.ipynb', data=jsonapi.dumps(new_name))
         r = requests.get(url+'/testfoo.ipynb')
         data = r.json()
         assert isinstance(data, dict)
         self.assertIn('name', data)
         self.assertEqual(data['name'], 'testfoo.ipynb')
         r = requests.get(url+'/Untitled0.ipynb')
         self.assertEqual(r.status_code, 404)
         
         # DELETE notebooks
         r0 = self.delnb('test.ipynb')
         r1 = self.delnb('testfoo.ipynb', '/foo/')
         r2 = self.delnb('Untitled0.ipynb', '/foo/bar/')
         self.assertEqual(r0, 204)
         self.assertEqual(r1, 204)
         self.assertEqual(r2, 204)

IPython/html/services/sessions/handlers.py

@@ -1,114 +1,115 b''
 """Tornado handlers for the sessions web service.
 
 Authors:
 
 * Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2013  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from tornado import web
 
 from zmq.utils import jsonapi
 
 from IPython.utils.jsonutil import date_default
 from ...base.handlers import IPythonHandler
 
 #-----------------------------------------------------------------------------
 # Session web service handlers
 #-----------------------------------------------------------------------------
 
 
 class SessionRootHandler(IPythonHandler):
 
     @web.authenticated
     def get(self):
         # Return a list of running sessions
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         sessions = sm.list_sessions()
         self.finish(jsonapi.dumps(sessions))
 
     @web.authenticated
     def post(self):
         # Creates a new session 
         #(unless a session already exists for the named nb)
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         notebook_path = self.get_argument('notebook_path', default=None)
         name, path = nbm.named_notebook_path(notebook_path)
         # Check to see if session exists
         if sm.session_exists(name=name, path=path):
             model = sm.get_session(name=name, path=path)
             kernel_id = model['kernel']['id']
             km.start_kernel(kernel_id, cwd=nbm.notebook_dir)
         else:
             session_id = sm.get_session_id()
             sm.save_session(session_id=session_id, name=name, path=path)
             kernel_id = km.start_kernel(cwd=nbm.notebook_dir)
             kernel = km.kernel_model(kernel_id, self.ws_url)
             sm.update_session(session_id, kernel=kernel_id)
             model = sm.get_session(id=session_id)
         self.set_header('Location', '{0}kernels/{1}'.format(self.base_kernel_url, kernel_id))
         self.finish(jsonapi.dumps(model))
 
 class SessionHandler(IPythonHandler):
 
     SUPPORTED_METHODS = ('GET', 'PATCH', 'DELETE')
 
     @web.authenticated
     def get(self, session_id):
         # Returns the JSON model for a single session
         sm = self.session_manager
         model = sm.get_session(id=session_id)
         self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def patch(self, session_id):
         # Currently, this handler is strictly for renaming notebooks
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
+        data = self.request.body
         data = jsonapi.loads(self.request.body)
         name, path = nbm.named_notebook_path(data['notebook_path'])
         sm.update_session(session_id, name=name)
         model = sm.get_session(id=session_id)
         self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def delete(self, session_id):
         # Deletes the session with given session_id
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         session = sm.get_session(id=session_id)
         sm.delete_session(session_id)        
         km.shutdown_kernel(session['kernel']['id'])
         self.set_status(204)
         self.finish()
 
 
 #-----------------------------------------------------------------------------
 # URL to handler mappings
 #-----------------------------------------------------------------------------
 
 _session_id_regex = r"(?P<session_id>\w+-\w+-\w+-\w+-\w+)"
 
 default_handlers = [
     (r"api/sessions/%s/" % _session_id_regex, SessionHandler),
     (r"api/sessions/%s" % _session_id_regex, SessionHandler),
     (r"api/sessions/",  SessionRootHandler),
     (r"api/sessions",  SessionRootHandler)
 ]
 

IPython/html/static/services/sessions/js/session.js

@@ -1,96 +1,95 b''
 //----------------------------------------------------------------------------
 //  Copyright (C) 2008-2011  The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // Notebook
 //============================================================================
 
 var IPython = (function (IPython) {
     
     var Session = function(notebook_path, Notebook){
         this.kernel = null;
         this.kernel_id = null;
         this.session_id = null;
         this.notebook_path = notebook_path;
         this.notebook = Notebook;
         this._baseProjectUrl = Notebook.baseProjectUrl() 
     };
     
     Session.prototype.start = function(){
         var that = this
         var qs = $.param({notebook_path:this.notebook_path});
         var url = '/api/sessions' + '?' + qs;
         $.post(url, 
             $.proxy(this.start_kernel, that),
             'json'
         );
     };
     
     Session.prototype.notebook_rename = function (notebook_path) {
         this.notebook_path = notebook_path;
-        name = {'notebook_path': notebook_path}
+        var name = {'notebook_path': notebook_path}
         var settings = {
             processData : false,
             cache : false,
             type : "PATCH",
             data: JSON.stringify(name),
             dataType : "json",
         };
         var url = this._baseProjectUrl + 'api/sessions/' + this.session_id;
         $.ajax(url, settings);
     }
     
-    
     Session.prototype.delete_session = function() {
         var settings = {
             processData : false,
             cache : false,
             type : "DELETE",
             dataType : "json",
         };
         var url = this._baseProjectUrl + 'api/sessions/' + this.session_id;
         $.ajax(url, settings);
     };
     
     // Kernel related things
     /**
      * Start a new kernel and set it on each code cell.
      * 
      * @method start_kernel
      */
     Session.prototype.start_kernel = function (json) {
         this.session_id = json.id;
         this.kernel_content = json.kernel;
         var base_url = $('body').data('baseKernelUrl') + "api/kernels";
         this.kernel = new IPython.Kernel(base_url, this.session_id);
         this.kernel._kernel_started(this.kernel_content);
     };
     
     /**
      * Prompt the user to restart the IPython kernel.
      * 
      * @method restart_kernel
      */
     Session.prototype.restart_kernel = function () {
         this.kernel.restart();
     };
     
     Session.prototype.interrupt_kernel = function() {
         this.kernel.interrupt();
     };
     
 
     Session.prototype.kill_kernel = function() {
         this.kernel.kill();        
     };
     
     IPython.Session = Session;
 
 
     return IPython;
 
 }(IPython));

IPython/html/static/tree/js/notebooklist.js

@@ -1,355 +1,355 b''
 //----------------------------------------------------------------------------
 //  Copyright (C) 2008-2011  The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // NotebookList
 //============================================================================
 
 var IPython = (function (IPython) {
 
     var NotebookList = function (selector) {
         this.selector = selector;
         if (this.selector !== undefined) {
             this.element = $(selector);
             this.style();
             this.bind_events();
         }
         this.notebooks_list = new Array();
         this.sessions = new Object();
     };
 
     NotebookList.prototype.baseProjectUrl = function () {
         return $('body').data('baseProjectUrl');
     };
 
     NotebookList.prototype.notebookPath = function() {
         var path = $('body').data('notebookPath');
         path = decodeURIComponent(path);
         return path;
     };
     
     NotebookList.prototype.url_name = function(name){
         return encodeURIComponent(name);
     };
 
     NotebookList.prototype.style = function () {
         $('#notebook_toolbar').addClass('list_toolbar');
         $('#drag_info').addClass('toolbar_info');
         $('#notebook_buttons').addClass('toolbar_buttons');
         $('#notebook_list_header').addClass('list_header');
         this.element.addClass("list_container");
     };
 
 
     NotebookList.prototype.bind_events = function () {
         var that = this;
         $('#refresh_notebook_list').click(function () {
             that.load_list();
         });
         this.element.bind('dragover', function () {
             return false;
         });
         this.element.bind('drop', function(event){
             that.handelFilesUpload(event,'drop');
             return false;
         });
     };
 
     NotebookList.prototype.handelFilesUpload =  function(event, dropOrForm) {
         var that = this;
         var files;
         if(dropOrForm =='drop'){
             files = event.originalEvent.dataTransfer.files;
         } else 
         {
             files = event.originalEvent.target.files
         }
         for (var i = 0, f; f = files[i]; i++) {
             var reader = new FileReader();
             reader.readAsText(f);
             var fname = f.name.split('.'); 
             var nbname = fname.slice(0,-1).join('.');
             var nbformat = fname.slice(-1)[0];
             if (nbformat === 'ipynb') {nbformat = 'json';};
             if (nbformat === 'py' || nbformat === 'json') {
                 var item = that.new_notebook_item(0);
                 that.add_name_input(nbname, item);
                 item.data('nbformat', nbformat);
                 // Store the notebook item in the reader so we can use it later
                 // to know which item it belongs to.
                 $(reader).data('item', item);
                 reader.onload = function (event) {
                     var nbitem = $(event.target).data('item');
                     that.add_notebook_data(event.target.result, nbitem);
                     that.add_upload_button(nbitem);
                 };
             };
         }
         return false;
         };
 
     NotebookList.prototype.clear_list = function () {
         this.element.children('.list_item').remove();
     };
 
     NotebookList.prototype.load_sessions = function(){
         var that = this;
         var settings = {
             processData : false,
             cache : false,
             type : "GET",
             dataType : "json",
             success : $.proxy(that.sessions_loaded, this)
         };
         var url = this.baseProjectUrl() + 'api/sessions';
         $.ajax(url,settings);
     };
 
 
     NotebookList.prototype.sessions_loaded = function(data){
         this.sessions = new Object();
         var len = data.length;
         if (len != 0) {
             for (var i=0; i<len; i++) {
                 if (data[i]['path']==null) {
                     nb_path = data[i]['name'];
                 }
                 else {
                     nb_path = data[i]['path'] + data[i]['name'];
                 }
                 this.sessions[nb_path]= data[i]['id'];
             }
         };
         this.load_list();
     };
 
     NotebookList.prototype.load_list = function () {
         var that = this;
         var settings = {
             processData : false,
             cache : false,
             type : "GET",
             dataType : "json",
             success : $.proxy(this.list_loaded, this),
             error : $.proxy( function(){
                 that.list_loaded([], null, null, {msg:"Error connecting to server."});
                              },this)
         };
 
         var url = this.baseProjectUrl() + 'api/notebooks' + this.notebookPath();
         $.ajax(url, settings);
     };
 
 
     NotebookList.prototype.list_loaded = function (data, status, xhr, param) {
         var message = 'Notebook list empty.';
         if (param !== undefined && param.msg) {
             var message = param.msg;
         }
         var len = data.length;
         this.clear_list();
         if(len == 0)
         {
             $(this.new_notebook_item(0))
                 .append(
                     $('<div style="margin:auto;text-align:center;color:grey"/>')
                     .text(message)
                     )
         }
         for (var i=0; i<len; i++) {
             var name = data[i].name;
             var path = this.notebookPath();
             var nbname = name.split(".")[0];
             var item = this.new_notebook_item(i);
             this.add_link(path, nbname, item);
             name = this.notebookPath() + name;
             if(this.sessions[name] == undefined){
                 this.add_delete_button(item);
             } else {
                 this.add_shutdown_button(item,this.sessions[name]);
             }
         };
     };
 
 
     NotebookList.prototype.new_notebook_item = function (index) {
         var item = $('<div/>').addClass("list_item").addClass("row-fluid");
         // item.addClass('list_item ui-widget ui-widget-content ui-helper-clearfix');
         // item.css('border-top-style','none');
         item.append($("<div/>").addClass("span12").append(
             $("<a/>").addClass("item_link").append(
                 $("<span/>").addClass("item_name")
             )
         ).append(
             $('<div/>').addClass("item_buttons btn-group pull-right")
         ));
         
         if (index === -1) {
             this.element.append(item);
         } else {
             this.element.children().eq(index).after(item);
         }
         return item;
     };
 
 
     NotebookList.prototype.add_link = function (path, nbname, item) {
         item.data('nbname', nbname);
         item.data('path', path);
         item.find(".item_name").text(nbname);
         item.find("a.item_link")
             .attr('href', this.baseProjectUrl() + "notebooks" + this.notebookPath() + nbname + ".ipynb")
             .attr('target','_blank');
     };
 
 
     NotebookList.prototype.add_name_input = function (nbname, item) {
         item.data('nbname', nbname);
         item.find(".item_name").empty().append(
             $('<input/>')
             .addClass("nbname_input")
             .attr('value', nbname)
             .attr('size', '30')
             .attr('type', 'text')
         );
     };
 
 
     NotebookList.prototype.add_notebook_data = function (data, item) {
         item.data('nbdata',data);
     };
 
 
     NotebookList.prototype.add_shutdown_button = function (item, session) {
         var that = this;
         var shutdown_button = $("<button/>").text("Shutdown").addClass("btn btn-mini").
             click(function (e) {
                 var settings = {
                     processData : false,
                     cache : false,
                     type : "DELETE",
                     dataType : "json",
                     success : function () {
                         that.load_sessions();
                     }
                 };
                 var url = that.baseProjectUrl() + 'api/sessions/' + session;
                 $.ajax(url, settings);
                 return false;
             });
         // var new_buttons = item.find('a'); // shutdown_button;
         item.find(".item_buttons").html("").append(shutdown_button);
     };
 
     NotebookList.prototype.add_delete_button = function (item) {
         var new_buttons = $('<span/>').addClass("btn-group pull-right");
         var notebooklist = this;
         var delete_button = $("<button/>").text("Delete").addClass("btn btn-mini").
             click(function (e) {
                 // $(this) is the button that was clicked.
                 var that = $(this);
                 // We use the nbname and notebook_id from the parent notebook_item element's
                 // data because the outer scopes values change as we iterate through the loop.
                 var parent_item = that.parents('div.list_item');
                 var nbname = parent_item.data('nbname');
                 var message = 'Are you sure you want to permanently delete the notebook: ' + nbname + '?';
                 IPython.dialog.modal({
                     title : "Delete notebook",
                     body : message,
                     buttons : {
                         Delete : {
                             class: "btn-danger",
                             click: function() {
                                 var settings = {
                                     processData : false,
                                     cache : false,
                                     type : "DELETE",
                                     dataType : "json",
                                     success : function (data, status, xhr) {
                                         parent_item.remove();
                                     }
                                 };
                                 var url = notebooklist.baseProjectUrl() + 'api/notebooks' + notebooklist.notebookPath() + nbname + '.ipynb';
                                 $.ajax(url, settings);
                             }
                         },
                         Cancel : {}
                     }
                 });
                 return false;
             });
         item.find(".item_buttons").html("").append(delete_button);
     };
 
 
     NotebookList.prototype.add_upload_button = function (item) {
         var that = this;
         var upload_button = $('<button/>').text("Upload")
             .addClass('btn btn-primary btn-mini upload_button')
             .click(function (e) {
                 var nbname = item.find('.item_name > input').attr('value');
                 var nbformat = item.data('nbformat');
                 var nbdata = item.data('nbdata');
                 var content_type = 'text/plain';
                 if (nbformat === 'json') {
                     content_type = 'application/json';
                 } else if (nbformat === 'py') {
                     content_type = 'application/x-python';
                 };
                 var settings = {
                     processData : false,
                     cache : false,
                     type : 'POST',
                     dataType : 'json',
                     data : nbdata,
                     headers : {'Content-Type': content_type},
                     success : function (data, status, xhr) {
                         that.add_link(data, nbname, item);
                         that.add_delete_button(item);
                     }
                 };
 
                 var qs = $.param({name:nbname, format:nbformat});
                 var url = that.baseProjectUrl() + 'notebooks?' + qs;
                 $.ajax(url, settings);
                 return false;
             });
         var cancel_button = $('<button/>').text("Cancel")
             .addClass("btn btn-mini")
             .click(function (e) {
                 console.log('cancel click');
                 item.remove();
                 return false;
             });
         item.find(".item_buttons").empty()
             .append(upload_button)
             .append(cancel_button);
     };
 
 
     NotebookList.prototype.new_notebook = function(){
         var path = this.notebookPath();
         var settings = {
             processData : false,
             cache : false,
             type : "POST",
             dataType : "json",
             success:$.proxy(function (data, status, xhr){
                 notebook_name = data.name;
                 window.open(this.baseProjectUrl() +'notebooks' + this.notebookPath()+ notebook_name, '_blank');
             }, this)
         };
-        var url = this.baseProjectUrl() + 'notebooks' + path;
+        var url = this.baseProjectUrl() + 'api/notebooks' + path;
         $.ajax(url,settings);
     };
 
     IPython.NotebookList = NotebookList;
 
     return IPython;
 
 }(IPython));
 

IPython/html/tests/launchnotebook.py

@@ -1,63 +1,62 b''
 """Base class for notebook tests."""
 
 import sys
 import time
 import requests
 from subprocess import Popen, PIPE
 from unittest import TestCase
 
 from IPython.utils.tempdir import TemporaryDirectory
 
 
 class NotebookTestBase(TestCase):
     """A base class for tests that need a running notebook.
     
     This creates an empty profile in a temp ipython_dir
     and then starts the notebook server with a separate temp notebook_dir.
     """
 
-    port = 1234
+    port = 12341
 
     def wait_till_alive(self):
         url = 'http://localhost:%i/' % self.port
         while True:
             time.sleep(.1)
             try:
                 r = requests.get(url + 'api/notebooks')
                 break
             except requests.exceptions.ConnectionError:
                 pass
         
     def wait_till_dead(self):
         url = 'http://localhost:%i/' % self.port
         while True:
             time.sleep(.1)
             try:
                 r = requests.get(url + 'api/notebooks')
                 continue
             except requests.exceptions.ConnectionError:
                 break
 
     def setUp(self):
         self.ipython_dir = TemporaryDirectory()
         self.notebook_dir = TemporaryDirectory()
         notebook_args = [
             sys.executable, '-c',
             'from IPython.html.notebookapp import launch_new_instance; launch_new_instance()',
             '--port=%d' % self.port,
             '--no-browser',
             '--ipython-dir=%s' % self.ipython_dir.name,
             '--notebook-dir=%s' % self.notebook_dir.name
-        ]  
+        ]
         self.notebook = Popen(notebook_args, stdout=PIPE, stderr=PIPE)
         self.wait_till_alive()
-        #time.sleep(3.0)
 
     def tearDown(self):
         self.notebook.terminate()
         self.ipython_dir.cleanup()
         self.notebook_dir.cleanup()
         self.wait_till_dead()
         
     def base_url(self):
         return 'http://localhost:%i/' % self.port