add contents web service api

IPython/html/services/contents/__init__.py

@@ -0,0 +1,2 b''
+
+

IPython/html/services/contents/contentmanager.py

@@ -0,0 +1,103 b''
+"""A base class contents manager.
+
+Authors:
+
+* 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
+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):
+        names = glob.glob(os.path.join(self.content_dir, content_path,'*'))
+        content_names = list()
+        dir_names = 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
+        
+    def list_contents(self, content_path):
+        """List all contents in the named path."""
+        dir_names, content_names = self.get_content_names(content_path)
+        content_mapping = []
+        for name in dir_names:
+            model = self.directory_model(name, content_path)
+            content_mapping.append(model)
+        for name in content_names:
+            model = self.content_model(name, content_path)
+            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):
+        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
+
+    def content_model(self, name, content_path):
+        last_modified, file_type, contents, size = self.read_content(name, content_path)
+        model = {"name": name,
+                    "path": content_path,
+                    "type": file_type,
+                    "last_modified": last_modified.ctime(),
+                    "size": size}
+        return model
+
+    def delete_content(self, name, content_path):
+        full_path = self.get_path_by_name(name, content_path)
+        os.unlink(full_path)
+        
  No newline at end of file

IPython/html/services/contents/handlers.py

@@ -0,0 +1,69 b''
+"""Tornado handlers for the contents web service.
+
+Authors:
+
+* Zach Sailer
+"""
+
+#-----------------------------------------------------------------------------
+#  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.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# 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):
+        nbm = self.notebook_manager
+        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
+        nbm = self.notebook_manager
+        contents = cm.list_contents(content_path)
+        self.finish(jsonapi.dumps(contents))
+
+    @web.authenticated
+    def delete(self, 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/base/handlers.py

@@ -218,6 +218,10 b' class IPythonHandler(AuthenticatedHandler):'
         return self.settings['session_manager']
     
     @property
+    def content_manager(self):
+        return self.settings['content_manager']
+    
+    @property
     def project(self):
         return self.notebook_manager.notebook_dir
     

IPython/html/notebook/handlers.py

@@ -54,8 +54,8 b' class NamedNotebookHandler(IPythonHandler):'
             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' % notebook_path)       
+        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,

IPython/html/notebookapp.py

@@ -66,6 +66,7 b' 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 .services.contents.contentmanager import ContentManager
 
 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
 
@@ -128,18 +129,18 b' def load_handlers(name):'
 class NotebookWebApplication(web.Application):
 
     def __init__(self, ipython_app, kernel_manager, notebook_manager,
-                 cluster_manager, session_manager, log,
+                 cluster_manager, session_manager, content_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)
+            session_manager, content_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,
+                      cluster_manager, session_manager, content_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
@@ -170,6 +171,7 b' class NotebookWebApplication(web.Application):'
             notebook_manager=notebook_manager,
             cluster_manager=cluster_manager,
             session_manager=session_manager,
+            content_manager=content_manager,
 
             # IPython stuff
             nbextensions_path = ipython_app.nbextensions_path,
@@ -195,6 +197,7 b' class NotebookWebApplication(web.Application):'
         handlers.extend(load_handlers('services.notebooks.handlers'))
         handlers.extend(load_handlers('services.clusters.handlers'))
         handlers.extend(load_handlers('services.sessions.handlers'))
+        handlers.extend(load_handlers('services.contents.handlers'))
         handlers.extend([
             (r"/files/(.*)", AuthenticatedFileHandler, {'path' : settings['notebook_manager'].notebook_dir}),
             (r"/nbextensions/(.*)", FileFindHandler, {'path' : settings['nbextensions_path']}),
@@ -528,6 +531,7 b' class NotebookApp(BaseIPythonApplication):'
         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.content_manager = ContentManager(parent=self, log=self.log)
         self.cluster_manager = ClusterManager(parent=self, log=self.log)
         self.cluster_manager.update_profiles()
 
@@ -545,8 +549,8 b' class NotebookApp(BaseIPythonApplication):'
         """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
+            self.cluster_manager, self.session_manager, self.content_manager, 
+            self.log, self.base_project_url, self.webapp_settings
         )
         if self.certfile:
             ssl_options = dict(certfile=self.certfile)

IPython/html/services/notebooks/filenbmanager.py

@@ -80,7 +80,6 b' class FileNotebookManager(NotebookManager):'
         """List all notebook names in the notebook dir."""
         names = glob.glob(os.path.join(self.notebook_dir, path,
                                        '*' + self.filename_ext))
-        #names = [os.path.splitext(os.path.basename(name))[0]
         names = [os.path.basename(name)
                  for name in names]
         return names
@@ -112,13 +111,9 b' class FileNotebookManager(NotebookManager):'
         model = self.notebook_model(notebook_name, notebook_path)
         return model
 
-    def notebook_exists(self, notebook_name):
+    def notebook_exists(self, notebook_path):
         """Does a notebook exist?"""
-        exists = super(FileNotebookManager, self).notebook_exists(notebook_name)
-        if not exists:
-            return False
-        path = self.get_path_by_name(self.mapping[notebook_name])
-        return os.path.isfile(path)
+        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."""

IPython/html/services/notebooks/handlers.py

@@ -35,7 +35,6 b' class NotebookRootHandler(IPythonHandler):'
     @web.authenticated
     def get(self):
         nbm = self.notebook_manager
-        km = self.kernel_manager
         notebooks = nbm.list_notebooks("")
         self.finish(jsonapi.dumps(notebooks))
 

IPython/html/services/notebooks/nbmanager.py

@@ -111,9 +111,8 b' class NotebookManager(LoggingConfigurable):'
         raise NotImplementedError('must be implemented in a subclass')
 
 
-    def notebook_exists(self, notebook_name):
+    def notebook_exists(self, notebook_path):
         """Does a notebook exist?"""
-        return notebook_name in self.mapping
 
     def notebook_model(self, notebook_name, notebook_path=None):
         """ Creates the standard notebook model """