proper '.py' and '.ipynb' download files

IPython/html/services/notebooks/handlers.py

@@ -1,199 +1,204 b''
 """Tornado handlers for the notebooks web service.
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  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
 import ast
 
 from zmq.utils import jsonapi
 
 from IPython.utils.jsonutil import date_default
 
 from ...base.handlers import IPythonHandler
 
 #-----------------------------------------------------------------------------
 # Notebook web service handlers
 #-----------------------------------------------------------------------------
 
 
 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))
 
     @web.authenticated
     def post(self):
         nbm = self.notebook_manager
         notebook_name = nbm.new_notebook()
         model = nbm.notebook_model(notebook_name)
         self.set_header('Location', '{0}api/notebooks/{1}'.format(self.base_project_url, notebook_name))
         self.finish(jsonapi.dumps(model))
         
         
 class NotebookRootRedirect(IPythonHandler):
 
     @authenticate_unless_readonly
     def get(self):
         self.redirect("/api/notebooks")
 
 
 class NotebookHandler(IPythonHandler):
 
     SUPPORTED_METHODS = ('GET', 'PUT', 'PATCH', 'DELETE')
 
     @web.authenticated
     def get(self, notebook_path):
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         
         if name == None:
             notebooks = nbm.list_notebooks(path)
             self.finish(jsonapi.dumps(notebooks))
         else:
             format = self.get_argument('format', default='json')
+            download = self.get_argument('download', default='False')
             model = nbm.notebook_model(name,path)
             last_mod, representation, name = nbm.get_notebook(name, path, format)
-
-            if format == u'json':
-                self.set_header('Content-Type', 'application/json')
-                self.set_header('Content-Disposition','attachment; filename="%s.ipynb"' % name)
-            elif format == u'py':
-                self.set_header('Content-Type', 'application/x-python')
-                self.set_header('Content-Disposition','attachment; filename="%s.py"' % name)
-            #self.set_header('Last-Modified', last_mod)
-            self.finish(jsonapi.dumps(model))
+            self.set_header('Last-Modified', last_mod)
+            
+            if download == 'True':
+                if format == u'json':
+                    self.set_header('Content-Type', 'application/json')
+                    self.set_header('Content-Disposition','attachment; filename="%s.ipynb"' % name)
+                    self.finish(representation)
+                elif format == u'py':
+                    self.set_header('Content-Type', 'application/x-python')
+                    self.set_header('Content-Disposition','attachment; filename="%s.py"' % name)
+                    self.finish(representation)
+            else:
+                self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def patch(self, notebook_path):
         nbm = self.notebook_manager
         notebook_name, notebook_path = nbm.named_notebook_path(notebook_path)
         data = jsonapi.loads(self.request.body)
         model = nbm.change_notebook(data, notebook_name, notebook_path)
         self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def put(self, notebook_path):
         nbm = self.notebook_manager
         notebook_name, notebook_path = nbm.named_notebook_path(notebook_path)        
         if notebook_name == None:
             body = self.request.body.strip()
             format = self.get_argument('format', default='json')
             name = self.get_argument('name', default=None)
             if body:
                 notebook_name = nbm.save_new_notebook(body, notebook_path=notebook_path, name=name, format=format)
             else:
                 notebook_name = nbm.new_notebook(notebook_path=notebook_path)
             if notebook_path==None:
                 self.set_header('Location', nbm.notebook_dir + '/'+ notebook_name)
             else:
                 self.set_header('Location', nbm.notebook_dir + '/'+ notebook_path + '/' + notebook_name)
             model = nbm.notebook_model(notebook_name, notebook_path)
             self.finish(jsonapi.dumps(model))
         else:            
             format = self.get_argument('format', default='json')
             name = self.get_argument('name', default=None)
             nbm.save_notebook(self.request.body, notebook_path=notebook_path, name=name, format=format)
             model = nbm.notebook_model(notebook_name, notebook_path)
             self.set_status(204)
             self.finish(jsonapi.dumps(model))
 
     @web.authenticated
     def delete(self, notebook_path):
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         nbm.delete_notebook(name, path)
         self.set_status(204)
         self.finish()
 
 
 class NotebookCheckpointsHandler(IPythonHandler):
     
     SUPPORTED_METHODS = ('GET', 'POST')
     
     @web.authenticated
     def get(self, notebook_path):
         """get lists checkpoints for a notebook"""
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         checkpoints = nbm.list_checkpoints(name, path)
         data = jsonapi.dumps(checkpoints, default=date_default)
         self.finish(data)
     
     @web.authenticated
     def post(self, notebook_path):
         """post creates a new checkpoint"""
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         checkpoint = nbm.create_checkpoint(name, path)
         data = jsonapi.dumps(checkpoint, default=date_default)
         if path == None:
             self.set_header('Location', '{0}notebooks/{1}/checkpoints/{2}'.format(
                 self.base_project_url, name, checkpoint['checkpoint_id']
                 ))
         else:
             self.set_header('Location', '{0}notebooks/{1}/{2}/checkpoints/{3}'.format(
                 self.base_project_url, path, name, checkpoint['checkpoint_id']
                 ))
         self.finish(data)
 
 
 class ModifyNotebookCheckpointsHandler(IPythonHandler):
     
     SUPPORTED_METHODS = ('POST', 'DELETE')
     
     @web.authenticated
     def post(self, notebook_path, checkpoint_id):
         """post restores a notebook from a checkpoint"""
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         nbm.restore_checkpoint(name, checkpoint_id, path)
         self.set_status(204)
         self.finish()
     
     @web.authenticated
     def delete(self, notebook_path, checkpoint_id):
         """delete clears a checkpoint for a given notebook"""
         nbm = self.notebook_manager
         name, path = nbm.named_notebook_path(notebook_path)
         nbm.delete_checkpoint(name, checkpoint_id, path)
         self.set_status(204)
         self.finish()
         
 #-----------------------------------------------------------------------------
 # URL to handler mappings
 #-----------------------------------------------------------------------------
 
 
 _notebook_path_regex = r"(?P<notebook_path>.+)"
 _checkpoint_id_regex = r"(?P<checkpoint_id>[\w-]+)"
 
 default_handlers = [
     (r"api/notebooks/%s/checkpoints" % _notebook_path_regex, NotebookCheckpointsHandler),
     (r"api/notebooks/%s/checkpoints/%s" % (_notebook_path_regex, _checkpoint_id_regex),
         ModifyNotebookCheckpointsHandler),
     (r"api/notebooks/%s" % _notebook_path_regex, NotebookHandler),
     (r"api/notebooks/", NotebookRootRedirect),
     (r"api/notebooks", NotebookRootHandler),
 ]
 
 
 
 

IPython/html/static/notebook/js/menubar.js

@@ -1,285 +1,285 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.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // MenuBar
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  * @submodule MenuBar
  */
 
 
 var IPython = (function (IPython) {
     "use strict";
 
     /**
      * A MenuBar Class to generate the menubar of IPython notebook
      * @Class MenuBar
      *
      * @constructor
      *
      *
      * @param selector {string} selector for the menubar element in DOM
      * @param {object} [options]
      *      @param [options.baseProjectUrl] {String} String to use for the
      *      Base Project url, default would be to inspect
      *      $('body').data('baseProjectUrl');
      *      does not support change for now is set through this option
      */
     var MenuBar = function (selector, options) {
         var options = options || {};
         if(options.baseProjectUrl!= undefined){
             this._baseProjectUrl = options.baseProjectUrl;
         }
         this.selector = selector;
         if (this.selector !== undefined) {
             this.element = $(selector);
             this.style();
             this.bind_events();
         }
     };
 
     MenuBar.prototype.baseProjectUrl = function(){
         return this._baseProjectUrl || $('body').data('baseProjectUrl');
     };
 
     MenuBar.prototype.notebookPath = function() {
         var path = $('body').data('notebookPath');
         if (path != 'None') {
             if (path[path.length-1] != '/') {
                 path = path.substring(0,path.length);
             };
             return path;
         } else {
             return '';
         }
     };
     
     MenuBar.prototype.style = function () {
         this.element.addClass('border-box-sizing');
         this.element.find("li").click(function (event, ui) {
                 // The selected cell loses focus when the menu is entered, so we
                 // re-select it upon selection.
                 var i = IPython.notebook.get_selected_index();
                 IPython.notebook.select(i);
             }
         );
     };
 
 
     MenuBar.prototype.bind_events = function () {
         //  File
         var that = this;
         this.element.find('#new_notebook').click(function () {
             window.open(that.baseProjectUrl() + 'notebooks/' + that.notebookPath() +'new');
         });
         this.element.find('#open_notebook').click(function () {
             window.open(that.baseProjectUrl() + 'tree/' + that.notebookPath());
         });
         this.element.find('#copy_notebook').click(function () {
             var notebook_name = IPython.notebook.get_notebook_name();
             var url = that.baseProjectUrl() + 'notebooks/' + that.notebookPath() + notebook_name + '/copy';
             window.open(url,'_blank');
             return false;
         });
         this.element.find('#download_ipynb').click(function () {
             var notebook_name = IPython.notebook.get_notebook_name();
-            var url = that.baseProjectUrl() + 'api/notebooks/' +
-                      notebook_name + '?format=json';
+            var url = that.baseProjectUrl() + 'api/notebooks/' + that.notebookPath() +
+                      notebook_name + '?format=json'+ '&download=True';
             window.location.assign(url);
         });
         this.element.find('#download_py').click(function () {
             var notebook_name = IPython.notebook.get_notebook_name();
-            var url = that.baseProjectUrl() + 'api/notebooks/' +
-                      notebook_name + '?format=py';
+            var url = that.baseProjectUrl() + 'api/notebooks/' + that.notebookPath() +
+                      notebook_name + '?format=py' + '&download=True';
             window.location.assign(url);
         });
         this.element.find('#rename_notebook').click(function () {
             IPython.save_widget.rename_notebook();
         });
         this.element.find('#save_checkpoint').click(function () {
             IPython.notebook.save_checkpoint();
         });
         this.element.find('#restore_checkpoint').click(function () {
         });
         this.element.find('#kill_and_exit').click(function () {
             IPython.notebook.session.delete_session();
             setTimeout(function(){window.close();}, 500);
         });
         // Edit
         this.element.find('#cut_cell').click(function () {
             IPython.notebook.cut_cell();
         });
         this.element.find('#copy_cell').click(function () {
             IPython.notebook.copy_cell();
         });
         this.element.find('#delete_cell').click(function () {
             IPython.notebook.delete_cell();
         });
         this.element.find('#undelete_cell').click(function () {
             IPython.notebook.undelete();
         });
         this.element.find('#split_cell').click(function () {
             IPython.notebook.split_cell();
         });
         this.element.find('#merge_cell_above').click(function () {
             IPython.notebook.merge_cell_above();
         });
         this.element.find('#merge_cell_below').click(function () {
             IPython.notebook.merge_cell_below();
         });
         this.element.find('#move_cell_up').click(function () {
             IPython.notebook.move_cell_up();
         });
         this.element.find('#move_cell_down').click(function () {
             IPython.notebook.move_cell_down();
         });
         this.element.find('#select_previous').click(function () {
             IPython.notebook.select_prev();
         });
         this.element.find('#select_next').click(function () {
             IPython.notebook.select_next();
         });
         this.element.find('#edit_nb_metadata').click(function () {
             IPython.notebook.edit_metadata();
         });
         
         // View
         this.element.find('#toggle_header').click(function () {
             $('div#header').toggle();
             IPython.layout_manager.do_resize();
         });
         this.element.find('#toggle_toolbar').click(function () {
             $('div#maintoolbar').toggle();
             IPython.layout_manager.do_resize();
         });
         // Insert
         this.element.find('#insert_cell_above').click(function () {
             IPython.notebook.insert_cell_above('code');
         });
         this.element.find('#insert_cell_below').click(function () {
             IPython.notebook.insert_cell_below('code');
         });
         // Cell
         this.element.find('#run_cell').click(function () {
             IPython.notebook.execute_selected_cell();
         });
         this.element.find('#run_cell_in_place').click(function () {
             IPython.notebook.execute_selected_cell({terminal:true});
         });
         this.element.find('#run_all_cells').click(function () {
             IPython.notebook.execute_all_cells();
         }).attr('title', 'Run all cells in the notebook');
         this.element.find('#run_all_cells_above').click(function () {
             IPython.notebook.execute_cells_above();
         }).attr('title', 'Run all cells above (but not including) this cell');
         this.element.find('#run_all_cells_below').click(function () {
             IPython.notebook.execute_cells_below();
         }).attr('title', 'Run this cell and all cells below it');
         this.element.find('#to_code').click(function () {
             IPython.notebook.to_code();
         });
         this.element.find('#to_markdown').click(function () {
             IPython.notebook.to_markdown();
         });
         this.element.find('#to_raw').click(function () {
             IPython.notebook.to_raw();
         });
         this.element.find('#to_heading1').click(function () {
             IPython.notebook.to_heading(undefined, 1);
         });
         this.element.find('#to_heading2').click(function () {
             IPython.notebook.to_heading(undefined, 2);
         });
         this.element.find('#to_heading3').click(function () {
             IPython.notebook.to_heading(undefined, 3);
         });
         this.element.find('#to_heading4').click(function () {
             IPython.notebook.to_heading(undefined, 4);
         });
         this.element.find('#to_heading5').click(function () {
             IPython.notebook.to_heading(undefined, 5);
         });
         this.element.find('#to_heading6').click(function () {
             IPython.notebook.to_heading(undefined, 6);
         });
         this.element.find('#toggle_output').click(function () {
             IPython.notebook.toggle_output();
         });
         this.element.find('#collapse_all_output').click(function () {
             IPython.notebook.collapse_all_output();
         });
         this.element.find('#scroll_all_output').click(function () {
             IPython.notebook.scroll_all_output();
         });
         this.element.find('#expand_all_output').click(function () {
             IPython.notebook.expand_all_output();
         });
         this.element.find('#clear_all_output').click(function () {
             IPython.notebook.clear_all_output();
         });
         // Kernel
         this.element.find('#int_kernel').click(function () {
             IPython.notebook.session.interrupt_kernel();
         });
         this.element.find('#restart_kernel').click(function () {
             IPython.notebook.restart_kernel();
         });
         // Help
         this.element.find('#keyboard_shortcuts').click(function () {
             IPython.quick_help.show_keyboard_shortcuts();
         });
         
         this.update_restore_checkpoint(null);
         
         $([IPython.events]).on('checkpoints_listed.Notebook', function (event, data) {
             that.update_restore_checkpoint(IPython.notebook.checkpoints);
         });
         
         $([IPython.events]).on('checkpoint_created.Notebook', function (event, data) {
             that.update_restore_checkpoint(IPython.notebook.checkpoints);
         });
     };
 
     MenuBar.prototype.update_restore_checkpoint = function(checkpoints) {
         var ul = this.element.find("#restore_checkpoint").find("ul");
         ul.empty();
         if (! checkpoints || checkpoints.length == 0) {
             ul.append(
                 $("<li/>")
                 .addClass("disabled")
                 .append(
                     $("<a/>")
                     .text("No checkpoints")
                 )
             );
             return;
         };
         
         checkpoints.map(function (checkpoint) {
             var d = new Date(checkpoint.last_modified);
             ul.append(
                 $("<li/>").append(
                     $("<a/>")
                     .attr("href", "#")
                     .text(d.format("mmm dd HH:MM:ss"))
                     .click(function () {
                         IPython.notebook.restore_checkpoint_dialog(checkpoint);
                     })
                 )
             );
         });
     };
 
     IPython.MenuBar = MenuBar;
 
     return IPython;
 
 }(IPython));