IPython/html/static/services/contents.js

// Copyright (c) IPython Development Team.
// Distributed under the terms of the Modified BSD License.

define([
    'base/js/namespace',
    'jquery',
    'base/js/utils',
    'base/js/dialog',
], function(IPython, $, utils, dialog) {
    var Contents = function(options) {
        // Constructor
        //
        // A contents handles passing file operations
        // to the back-end.  This includes checkpointing
        // with the normal file operations.
        //
        // Parameters:
        //  options: dictionary
        //      Dictionary of keyword arguments.
        //          events: $(Events) instance
        //          base_url: string
        this.events = options.events;
        this.base_url = options.base_url;
    };

    Contents.prototype.api_url = function() {
        var url_parts = [this.base_url, 'api/contents'].concat(
                                Array.prototype.slice.apply(arguments));
        return utils.url_join_encode.apply(null, url_parts);
    };

    /**
     * Notebook Functions
     */

    /**
     * Load a notebook.
     *
     * Calls success_callback with notebook JSON object (as string), or
     * error_callback with error.
     *
     * @method load_notebook
     * @param {String} path
     * @param {String} name
     * @param {Function} success_callback
     * @param {Function} error_callback
     */
    Contents.prototype.load_notebook = function (path, name, success_callback, 
        error_callback) {
        // We do the call with settings so we can set cache to false.
        var settings = {
            processData : false,
            cache : false,
            type : "GET",
            dataType : "json",
            success : success_callback,
            error : error_callback,
        };
        this.events.trigger('notebook_loading.Notebook');
        var url = this.api_url(path, name);
        $.ajax(url, settings);
    };


    /**
     * Creates a new notebook file at the specified path, and
     * opens that notebook in a new window.
     *
     * @method scroll_to_cell
     * @param {String} path The path to create the new notebook at
     */
    Contents.prototype.new_notebook = function(path, options) {
        var base_url = this.base_url;
        var success_callback = options.success_callback || function(data, status, xhr) {};
        var error_callback = options.error_callback || function(xhr, status, error) {};
        var settings = {
            processData : false,
            cache : false,
            type : "POST",
            dataType : "json",
            async : false,
            success : success_callback,
            error : function(xhr, status, error) {
                utils.log_ajax_error(xhr, status, error);
                error_callback(xhr, status, error);
            }
        };
        $.ajax(this.api_url(path), settings);
    };

    Contents.prototype.delete_notebook = function(name, path) {
        var settings = {
            processData : false,
            cache : false,
            type : "DELETE",
            dataType : "json",
            success : $.proxy(this.events.trigger, this.events,
                'notebook_deleted.Contents',
                {
                    name: name,
                    path: path
                }),
            error : utils.log_ajax_error
        };
        var url = this.api_url(path, name);
        $.ajax(url, settings);
    };

    Contents.prototype.rename_notebook = function(path, name, new_name) {
        var that = this;
        var data = {name: new_name};
        var settings = {
            processData : false,
            cache : false,
            type : "PATCH",
            data : JSON.stringify(data),
            dataType: "json",
            contentType: 'application/json',
            success :  function (json, status, xhr) {
                that.events.trigger('notebook_rename_success.Contents',
                    json);
            },
            error : function (xhr, status, error) {
                that.events.trigger('notebook_rename_error.Contents',
                    [xhr, status, error]);
            }
        };
        var url = this.api_url(path, name);
        $.ajax(url, settings);
    };

    Contents.prototype.save_notebook = function(path, name, content,
        extra_settings) {
        var that = content;
        // Create a JSON model to be sent to the server.
        var model = {
            name : name,
            path : path,
            type : "notebook",
            content : content
        };
        // time the ajax call for autosave tuning purposes.
        var start =  new Date().getTime();
        // We do the call with settings so we can set cache to false.
        var settings = {
            processData : false,
            cache : false,
            type : "PUT",
            data : JSON.stringify(model),
            contentType: 'application/json',
            success : $.proxy(this.events.trigger, this.events,
                'notebook_save_success.Contents',
                $.extend(model, { start : start })),
            error : function (xhr, status, error) {
                that.events.trigger('notebook_save_error.Contents',
                    [xhr, status, error, model]);
            }
        };
        if (extra_settings) {
            for (var key in extra_settings) {
                settings[key] = extra_settings[key];
            }
        }
        var url = this.api_url(path, name);
        $.ajax(url, settings);
    };

    /**
     * Checkpointing Functions
     */

    Contents.prototype.create_checkpoint = function(path, name, options) {
        var url = this.api_url(path, name, 'checkpoints');
        var settings = {
            type : "POST",
            success: options.success_callback || function(data, status, xhr) {},
            error: options.error_callback || function(xhr, status, error_msg) {}
        };
        $.ajax(url, settings);
    };

    Contents.prototype.list_checkpoints = function(path, name, options) {
        var url = this.api_url(path, name, 'checkpoints');
        var settings = {
            type : "GET",
            success: options.success_callback || function(data, status, xhr) {},
            error: options.error_callback || function(xhr, status, error_msg) {}
        };
        $.ajax(url, settings);
    };

    Contents.prototype.restore_checkpoint = function(path, name, checkpoint_id, options) {
        var url = this.api_url(path, name, 'checkpoints', checkpoint_id);
        var settings = {
            type : "POST",
            success: options.success_callback || function(data, status, xhr) {},
            error: options.error_callback || function(xhr, status, error_msg) {}
        };
        $.ajax(url, settings);
    };

    Contents.prototype.delete_checkpoint = function(path, name, checkpoint_id, options) {        
        var url = this.api_url(path, name, 'checkpoints', checkpoint_id);
        var settings = {
            type : "DELETE",
            success: options.success_callback || function(data, status, xhr) {},
            error: options.error_callback || function(xhr, status, error_msg) {}
        };
        $.ajax(url, settings);
    };

    /**
     * File management functions
     */

    /**
     * List notebooks and directories at a given path
     *
     * On success, load_callback is called with an array of dictionaries
     * representing individual files or directories.  Each dictionary has
     * the keys:
     *     type: "notebook" or "directory"
     *     name: the name of the file or directory
     *     created: created date
     *     last_modified: last modified dat
     *     path: the path
     * @method list_notebooks
     * @param {String} path The path to list notebooks in
     * @param {Function} load_callback called with list of notebooks on success
     * @param {Function} error_callback called with ajax results on error
     */
    Contents.prototype.list_contents = function(path, load_callback,
        error_callback) {
        var settings = {
            processData : false,
            cache : false,
            type : "GET",
            dataType : "json",
            success : load_callback,
            error : error_callback
        };

        $.ajax(this.api_url(path), settings);
    };


    IPython.Contents = Contents;

    return {'Contents': Contents};
});