standard model changes

IPython/html/notebook/handlers.py

@@ -1,97 +1,102 b''
 """Tornado handlers for the live notebook view.
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  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
 from tornado import web
 HTTPError = web.HTTPError
 
 from ..base.handlers import IPythonHandler
 from ..utils import url_path_join
 from urllib import quote
 
 #-----------------------------------------------------------------------------
 # Handlers
 #-----------------------------------------------------------------------------
 
 
 class NewPathHandler(IPythonHandler):
     
     @web.authenticated
     def get(self, notebook_path):
         notebook_name = self.notebook_manager.new_notebook(notebook_path)
         self.redirect(url_path_join(self.base_project_url,"notebooks", notebook_path, notebook_name))
         
 
 class NewHandler(IPythonHandler):
 
     @web.authenticated
     def get(self):
         notebook_name = self.notebook_manager.new_notebook()
         self.redirect(url_path_join(self.base_project_url, "notebooks", notebook_name))
 
 
 class NamedNotebookHandler(IPythonHandler):
 
     @web.authenticated
     def get(self, notebook_path):
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         if name != None:
             name = quote(name)
         if path == None:
             project = self.project + '/' + name
         else:
             project = self.project + '/' + path +'/'+ name
         if not nbm.notebook_exists(notebook_path):
             raise web.HTTPError(404, u'Notebook does not exist: %s' % name)       
         self.write(self.render_template('notebook.html',
             project=project,
             notebook_path=path,
             notebook_name=name,
             kill_kernel=False,
             mathjax_url=self.mathjax_url,
             )
         )
+    
+    @web.authenticated
+    def post(self, notebook_path):
+        nbm =self.notebook_manager
+        notebook_name = nbm.new_notebook()
 
 
 class NotebookCopyHandler(IPythonHandler):
 
     @web.authenticated
     def get(self, notebook_path=None):
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         notebook_name = self.notebook_manager.copy_notebook(name, path)
         if path==None:
             self.redirect(url_path_join(self.base_project_url, "notebooks", notebook_name))
         else:
             self.redirect(url_path_join(self.base_project_url, "notebooks", path, notebook_name))
 
 
 #-----------------------------------------------------------------------------
 # URL to handler mappings
 #-----------------------------------------------------------------------------
 
 
 _notebook_path_regex = r"(?P<notebook_path>.+)"
 
 default_handlers = [
     (r"/notebooks/%s/new" % _notebook_path_regex, NewPathHandler),
     (r"/notebooks/new", NewHandler),
     (r"/notebooks/%s/copy" % _notebook_path_regex, NotebookCopyHandler),
     (r"/notebooks/%s" % _notebook_path_regex, NamedNotebookHandler)
 ]

IPython/html/services/contents/contentmanager.py

@@ -1,102 +1,104 b''
 """A base class contents manager.
 
 Authors:
 
 * Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2011  The IPython Development Team
+#  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
 #-----------------------------------------------------------------------------
 
 import datetime
 import io
 import os
 import glob
 import shutil
 import ast
 import base64
 
 from tornado import web
 
 from IPython.config.configurable import LoggingConfigurable
 from IPython.nbformat import current
 from IPython.utils.traitlets import List, Dict, Unicode, TraitError
 from IPython.utils import tz
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class ContentManager(LoggingConfigurable):
     
     content_dir = Unicode(os.getcwdu(), config=True, help="""
             The directory to use for contents.
             """)
             
     contents = List()
     
     def get_content_names(self, content_path):
+        """List of dicts of files in content_path"""
         names = glob.glob(os.path.join(self.content_dir, content_path,'*'))
-        content_names = list()
-        dir_names = list()
+        contents = list()
+        dirs = list()
+        notebooks = list()
         for name in names:
             if os.path.isdir(name) == True:
-                dir_names.append(os.path.split(name)[1])
-            elif os.path.splitext(os.path.basename(name))[1] != '.ipynb':
-                content_names.append(os.path.split(name)[1])        
-        return dir_names, content_names
-        
+                dirs.append(os.path.split(name)[1])
+            elif os.path.splitext(name)[1] == '.ipynb':
+                notebooks.append(os.path.split(name)[1])        
+            else:
+                contents.append(os.path.split(name)[1])        
+        return dirs, notebooks, contents
+
     def list_contents(self, content_path):
         """List all contents in the named path."""
-        dir_names, content_names = self.get_content_names(content_path)
+        dir_names, notebook_names, content_names = self.get_content_names(content_path)
         content_mapping = []
         for name in dir_names:
-            model = self.directory_model(name, content_path)
+            model = self.content_model(name, content_path, type='dir')
             content_mapping.append(model)
         for name in content_names:
-            model = self.content_model(name, content_path)
+            model = self.content_model(name, content_path, type='file')
+            content_mapping.append(model)
+        for name in notebook_names:
+            model = self.content_model(name, content_path, type='notebook')
             content_mapping.append(model)
         return content_mapping
 
     def get_path_by_name(self, name, content_path):
         """Return a full path to content"""
         path = os.path.join(self.content_dir, content_path, name)
         return path
 
-    def read_content(self, name, content_path):
+    def content_info(self, name, content_path):
+        """Read the content of a named file"""
         file_type = os.path.splitext(os.path.basename(name))[1]
-        #Collect contents of file
-        with open(name, 'rb') as file_content:
-            contents = file_content.read()
         full_path = self.get_path_by_name(name, content_path)
         info = os.stat(full_path)
         size = info.st_size
         last_modified = tz.utcfromtimestamp(info.st_mtime)
-        return last_modified, file_type, contents, size
-        
-    def directory_model(self, name, content_path):
-        model = {"name": name,
-                    "path": content_path,
-                    "type": 'tree'}
-        return model
+        return last_modified, file_type, size
 
-    def content_model(self, name, content_path):
-        last_modified, file_type, contents, size = self.read_content(name, content_path)
+    def content_model(self, name, content_path, type=None):
+        """Create a dict standard model for any file (other than notebooks)"""
+        last_modified, file_type, size = self.content_info(name, content_path)
         model = {"name": name,
                     "path": content_path,
-                    "type": file_type,
+                    "type": type,
+                    "MIME-type": "",
                     "last_modified": last_modified.ctime(),
                     "size": size}
         return model
 
     def delete_content(self, content_path):
+        """Delete a file"""
         os.unlink(os.path.join(self.content_dir, content_path))
         
  No newline at end of file

IPython/html/services/contents/handlers.py

@@ -1,68 +1,68 b''
 """Tornado handlers for the contents web service.
 
 Authors:
 
 * Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2011  The IPython Development Team
+#  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, authenticate_unless_readonly
 
 #-----------------------------------------------------------------------------
 # Contents web service handlers
 #-----------------------------------------------------------------------------
 
 
 class ContentRootHandler(IPythonHandler):
 
     @authenticate_unless_readonly
     def get(self):
         cm = self.content_manager
         contents = cm.list_contents("")
         self.finish(jsonapi.dumps(contents))
         
 
 class ContentHandler(IPythonHandler):
 
     @web.authenticated
     def get(self, content_path):
         cm = self.content_manager
         contents = cm.list_contents(content_path)
         self.finish(jsonapi.dumps(contents))
 
     @web.authenticated
     def delete(self, content_path):
         cm = self.content_manager
         cm.delete_content(content_path)
         self.set_status(204)
         self.finish()
 
 
 #-----------------------------------------------------------------------------
 # URL to handler mappings
 #-----------------------------------------------------------------------------
 
 _content_path_regex = r"(?P<content_path>.+)"
 
 default_handlers = [
     (r"api/contents/%s" % _content_path_regex, ContentHandler),
     (r"api/contents",  ContentRootHandler)
 ]
 
 

IPython/html/services/notebooks/filenbmanager.py

@@ -1,345 +1,345 b''
 """A notebook manager that uses the local file system for storage.
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  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
 import ast
 
 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(os.path.join(self.notebook_dir, path,
                                        '*' + self.filename_ext))
         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)
         notebook_mapping = []
         for name in notebook_names:
-            model = self.notebook_model(name, path)
+            model = self.notebook_model(name, path, content=False)
             notebook_mapping.append(model)
         return notebook_mapping
 
     def change_notebook(self, data, notebook_name, notebook_path=None):
         """Changes notebook"""
         changes = data.keys()
         for change in changes:
             full_path = self.get_path(notebook_name, notebook_path)
             if change == "notebook_name":
                 os.rename(full_path,
                     self.get_path(data['notebook_name'], notebook_path))
                 notebook_name = data['notebook_name']
             if change == "notebook_path":
                 new_path = self.get_path(data['notebook_name'], data['notebook_path'])
                 stutil.move(full_path, new_path)
                 notebook_path = data['notebook_path']
             if change == "content":
                 self.save_notebook(data, notebook_name, notebook_path)
         model = self.notebook_model(notebook_name, notebook_path)
         return model
 
     def notebook_exists(self, notebook_path):
         """Does a notebook exist?"""
         return os.path.isfile(notebook_path)
 
     def get_path(self, notebook_name, notebook_path=None):
         """Return a full path to a notebook given its notebook_name."""
         return self.get_path_by_name(notebook_name, notebook_path)
 
     def get_path_by_name(self, name, notebook_path=None):
         """Return a full path to a notebook given its name."""
         filename = name #+ self.filename_ext
         if notebook_path == None:
             path = os.path.join(self.notebook_dir, filename)
         else:    
             path = os.path.join(self.notebook_dir, notebook_path, filename)
         return path
 
     def read_notebook_object_from_path(self, path):
         """read a notebook object from a path"""
         info = os.stat(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_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=None, 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')
 
         new_path = notebook_path
         old_name = notebook_name
         old_checkpoints = self.list_checkpoints(old_name)
         
         path = self.get_path_by_name(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''
 
         try:
             self.log.debug("Autosaving notebook %s", path)
             with open(path,'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)
 
         # 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')
             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_path_by_name(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_path(notebook_name, notebook_path)
         if not os.path.isfile(nb_path):
             raise web.HTTPError(404, u'Notebook does not exist: %s' % notebook_name)
         
         # clear checkpoints
         for checkpoint in self.list_checkpoints(notebook_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)
         
         self.log.debug("unlinking notebook %s", nb_path)
         os.unlink(nb_path)
 
     def increment_filename(self, basename, notebook_path=None):
         """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)
             path = self.get_path_by_name(name, notebook_path)
             if not os.path.isfile(path):
                 break
             else:
                 i = i+1
         return name
     
     # Checkpoint-related utilities
     
     def get_checkpoint_path_by_name(self, name, checkpoint_id, notebook_path=None):
         """Return a full path to a notebook checkpoint, given its name and checkpoint id."""
         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=None):
         """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=None):
         """construct the info dict for a given checkpoint"""
         path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
         stats = os.stat(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=None):
         """Create a checkpoint from the current state of a notebook"""
         nb_path = self.get_path(notebook_name, notebook_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)
         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)
     
     def list_checkpoints(self, notebook_name, notebook_path=None):
         """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)
         if not os.path.exists(path):
             return []
         else:
             return [self.get_checkpoint_info(notebook_name, checkpoint_id, notebook_path)]
         
     
     def restore_checkpoint(self, notebook_name, checkpoint_id, notebook_path=None):
         """restore a notebook to a checkpointed state"""
         self.log.info("restoring Notebook %s from checkpoint %s", notebook_name, checkpoint_id)
         nb_path = self.get_path(notebook_name, notebook_path)
         cp_path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_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)
             )
         # ensure notebook is readable (never restore from an unreadable notebook)
         last_modified, nb = self.read_notebook_object_from_path(cp_path)
         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=None):
         """delete a notebook's checkpoint"""
         path = self.get_checkpoint_path(notebook_name, checkpoint_id, notebook_path)
         if not os.path.isfile(path):
             raise web.HTTPError(404,
                 u'Notebook checkpoint does not exist: %s-%s' % (notebook_name, checkpoint_id)
             )
         self.log.debug("unlinking %s", path)
         os.unlink(path)
     
     def info_string(self):
         return "Serving notebooks from local directory: %s" % self.notebook_dir

IPython/html/services/notebooks/nbmanager.py

@@ -1,247 +1,249 b''
 """A base class notebook manager.
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  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 tornado import web
 
 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.
             """)
             
     def named_notebook_path(self, notebook_path):
         
         l = len(notebook_path)
         names = notebook_path.split('/')
         if len(names) > 1:     
             name = names[len(names)-1]
             if name[(len(name)-6):(len(name))] == ".ipynb":
                 name = name
                 path = notebook_path[0:l-len(name)-1]+'/'
             else:
                 name = None
                 path = notebook_path+'/'
         else:
             name = names[0]
             if name[(len(name)-6):(len(name))] == ".ipynb":
                 name = name
                 path = None
             else:
                 name = None
                 path = notebook_path+'/'
         return name, path
              
     def _notebook_dir_changed(self, 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)
             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.')
 
     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.
         """
         self.list_notebooks(path)
 
     def list_notebooks(self):
         """List all notebooks.
 
         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_exists(self, notebook_path):
         """Does a notebook exist?"""
 
-    def notebook_model(self, notebook_name, notebook_path=None):
+        
+    def notebook_model(self, notebook_name, notebook_path=None, content=True):
         """ Creates the standard notebook model """
-        last_modified, content = self.read_notebook_object(notebook_name, notebook_path)
+        last_modified, contents = self.read_notebook_object(notebook_name, notebook_path)
         model = {"notebook_name": notebook_name, 
                     "notebook_path": notebook_path,
-                    "content": content,
                     "last_modified": last_modified.ctime()}
+        if content == True:
+            model['content'] = contents
         return model
 
     def get_notebook(self, notebook_name, notebook_path=None, 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_object(self, notebook_name, notebook_path):
         """Get the object representation of a notebook by notebook_id."""
         raise NotImplementedError('must be implemented in a subclass')
 
     def save_new_notebook(self, data, notebook_path = None, name=None, format=u'json'):
-        """Save a new notebook and return its notebook_id.
+        """Save a new notebook and return its name.
 
         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=None, name=None, new_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_object(self, nb, notebook_name=None, notebook_path=None, new_name=None):
         """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.
         """
         raise NotImplementedError('must be implemented in a subclass')
 
     def delete_notebook(self, notebook_name, notebook_path):
         """Delete notebook by notebook_id."""
         raise NotImplementedError('must be implemented in a subclass')
 
     def increment_filename(self, name):
         """Increment a filename to make it unique.
 
         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=None):
         """Create a new notebook and return its notebook_id."""
         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 notebook_id."""
         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  
     
     # Checkpoint-related
     
     def create_checkpoint(self, notebook_name, notebook_path=None):
         """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=None):
         """Return a list of checkpoints for a given notebook"""
         return []
     
     def restore_checkpoint(self, notebook_name, checkpoint_id, notebook_path=None):
         """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=None):
         """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"

IPython/html/services/sessions/handlers.py

@@ -1,104 +1,104 b''
-"""Tornado handlers for the notebooks web service.
+"""Tornado handlers for the sessions web service.
 
 Authors:
 
 * Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2011  The IPython Development Team
+#  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, authenticate_unless_readonly
 
 #-----------------------------------------------------------------------------
 # Session web service handlers
 #-----------------------------------------------------------------------------
 
 
 
 class SessionRootHandler(IPythonHandler):
 
     @authenticate_unless_readonly
     def get(self):
         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):
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         notebook_path = self.get_argument('notebook_path', default=None)
         notebook_name, path = nbm.named_notebook_path(notebook_path)
         session_id, model = sm.get_session(notebook_name, path)
         if model == None:
             kernel_id = km.start_kernel()
             kernel = km.kernel_model(kernel_id, self.ws_url)
             model = sm.session_model(session_id, notebook_name, path, kernel)
         self.finish(jsonapi.dumps(model))
 
 class SessionHandler(IPythonHandler):
 
     SUPPORTED_METHODS = ('GET', 'PATCH', 'DELETE')
 
     @authenticate_unless_readonly
     def get(self, session_id):
         sm = self.session_manager
         model = sm.get_session_from_id(session_id)
         self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def patch(self, session_id):
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         notebook_path = self.request.body
         notebook_name, path = nbm.named_notebook_path(notebook_path)
         kernel_id = sm.get_kernel_from_session(session_id)
         kernel = km.kernel_model(kernel_id, self.ws_url)
         sm.delete_mapping_for_session(session_id)
         model = sm.session_model(session_id, notebook_name, path, kernel)
         self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def delete(self, session_id):
         sm = self.session_manager
         nbm = self.notebook_manager
         km = self.kernel_manager
         kernel_id = sm.get_kernel_from_session(session_id)
         km.shutdown_kernel(kernel_id)
         sm.delete_mapping_for_session(session_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",  SessionRootHandler)
 ]
 
 
 
 

IPython/html/services/sessions/sessionmanager.py

@@ -1,95 +1,97 b''
 """A base class session manager.
 
 Authors:
 
 * Zach Sailer
 """
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2011  The IPython Development Team
+#  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
 #-----------------------------------------------------------------------------
 
 import os
 import uuid
 
 from tornado import web
 
 from IPython.config.configurable import LoggingConfigurable
 from IPython.nbformat import current
 from IPython.utils.traitlets import List, Dict, Unicode, TraitError
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class SessionManager(LoggingConfigurable):
     
     # Use session_ids to map notebook names to kernel_ids
     sessions = List()
     
     def get_session(self, nb_name, nb_path=None):
         """Get an existing session or create a new one"""
         model = None
         for session in self.sessions:
             if session['notebook_name'] == nb_name and session['notebook_path'] == nb_path:
                 session_id = session['session_id']
                 model = session
         if model != None:
             return session_id, model
         else:
             session_id = unicode(uuid.uuid4())
             return session_id, model
     
     def session_model(self, session_id, notebook_name=None, notebook_path=None, kernel=None):
         """ Create a session that links notebooks with kernels """
         model = dict(session_id=session_id,
                 notebook_name=notebook_name, 
                 notebook_path=notebook_path, 
                 kernel=kernel)
+        if notebook_path == None:
+            model['notebook_path']=""
         self.sessions.append(model)
         return model
     
     def list_sessions(self):
         """List all sessions and their information"""
         return self.sessions
     
     def set_kernel_for_sessions(self, session_id, kernel_id):
         """Maps the kernel_ids to the session_id in session_mapping"""
         for session in self.sessions:
             if session['session_id'] == session_id:
                 session['kernel_id'] = kernel_id
         return self.sessions
         
     def delete_mapping_for_session(self, session_id):
         """Delete the session from session_mapping with the given session_id"""
         i = 0
         for session in self.sessions:
             if session['session_id'] == session_id:
                 del self.sessions[i]
             i = i + 1
         return self.sessions
         
     def get_session_from_id(self, session_id):
         for session in self.sessions:
             if session['session_id'] == session_id:
                 return session
 
     def get_notebook_from_session(self, session_id):
         """Returns the notebook_path for the given session_id"""
         for session in self.sessions:
             if session['session_id'] == session_id:
                 return session['notebook_name']
     
     def get_kernel_from_session(self, session_id):
         """Returns the kernel_id for the given session_id"""
         for session in self.sessions:
             if session['session_id'] == session_id:
                 return session['kernel']['kernel_id']