Merge pull request #6783 from takluyver/contentsmanager-js
contents.js wrapper for contents servicepull/37/head
Min RK
11 years ago
commit
ef49e32ef0
@ -0,0 +1,285 @@
|
||||
// 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.
|
||||
// base_url: string
|
||||
this.base_url = options.base_url;
|
||||
};
|
||||
|
||||
/** Error type */
|
||||
Contents.DIRECTORY_NOT_EMPTY_ERROR = 'DirectoryNotEmptyError';
|
||||
|
||||
Contents.DirectoryNotEmptyError = function() {
|
||||
// Constructor
|
||||
//
|
||||
// An error representing the result of attempting to delete a non-empty
|
||||
// directory.
|
||||
this.message = 'A directory must be empty before being deleted.';
|
||||
}
|
||||
Contents.DirectoryNotEmptyError.prototype = new Error;
|
||||
Contents.DirectoryNotEmptyError.prototype.name =
|
||||
Contents.DIRECTORY_NOT_EMPTY_ERROR;
|
||||
|
||||
|
||||
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);
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a basic error handler that wraps a jqXHR error as an Error.
|
||||
*
|
||||
* Takes a callback that accepts an Error, and returns a callback that can
|
||||
* be passed directly to $.ajax, which will wrap the error from jQuery
|
||||
* as an Error, and pass that to the original callback.
|
||||
*
|
||||
* @method create_basic_error_handler
|
||||
* @param{Function} callback
|
||||
* @return{Function}
|
||||
*/
|
||||
Contents.prototype.create_basic_error_handler = function(callback) {
|
||||
if (!callback) {
|
||||
return function(xhr, status, error) { };
|
||||
}
|
||||
return function(xhr, status, error) {
|
||||
callback(utils.wrap_ajax_error(xhr, status, error));
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* File Functions (including notebook operations)
|
||||
*/
|
||||
|
||||
/**
|
||||
* Load a file.
|
||||
*
|
||||
* Calls success with file JSON model, or error with error.
|
||||
*
|
||||
* @method load_notebook
|
||||
* @param {String} path
|
||||
* @param {String} name
|
||||
* @param {Function} success
|
||||
* @param {Function} error
|
||||
*/
|
||||
Contents.prototype.load = function (path, name, options) {
|
||||
// We do the call with settings so we can set cache to false.
|
||||
var settings = {
|
||||
processData : false,
|
||||
cache : false,
|
||||
type : "GET",
|
||||
dataType : "json",
|
||||
success : options.success,
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
var url = this.api_url(path, name);
|
||||
$.ajax(url, settings);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new notebook file at the specified directory path.
|
||||
*
|
||||
* @method scroll_to_cell
|
||||
* @param {String} path The path to create the new notebook at
|
||||
* @param {String} name Name for new file. Chosen by server if unspecified.
|
||||
* @param {Object} options:
|
||||
* ext: file extension to use if name unspecified
|
||||
*/
|
||||
Contents.prototype.new = function(path, name, options) {
|
||||
var method, data;
|
||||
if (name) {
|
||||
method = "PUT";
|
||||
} else {
|
||||
method = "POST";
|
||||
data = JSON.stringify({ext: options.ext || ".ipynb"});
|
||||
}
|
||||
|
||||
var settings = {
|
||||
processData : false,
|
||||
type : method,
|
||||
data: data,
|
||||
dataType : "json",
|
||||
success : options.success || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
if (options.extra_settings) {
|
||||
$.extend(settings, options.extra_settings);
|
||||
}
|
||||
$.ajax(this.api_url(path), settings);
|
||||
};
|
||||
|
||||
Contents.prototype.delete = function(name, path, options) {
|
||||
var error_callback = options.error || function() {};
|
||||
var that = this;
|
||||
var settings = {
|
||||
processData : false,
|
||||
type : "DELETE",
|
||||
dataType : "json",
|
||||
success : options.success || function() {},
|
||||
error : function(xhr, status, error) {
|
||||
// TODO: update IPEP27 to specify errors more precisely, so
|
||||
// that error types can be detected here with certainty.
|
||||
if (xhr.status === 400) {
|
||||
error_callback(new Contents.DirectoryNotEmptyError());
|
||||
}
|
||||
error_callback(utils.wrap_ajax_error(xhr, status, error));
|
||||
}
|
||||
};
|
||||
var url = this.api_url(path, name);
|
||||
$.ajax(url, settings);
|
||||
};
|
||||
|
||||
Contents.prototype.rename = function(path, name, new_path, new_name, options) {
|
||||
var data = {name: new_name, path: new_path};
|
||||
var settings = {
|
||||
processData : false,
|
||||
type : "PATCH",
|
||||
data : JSON.stringify(data),
|
||||
dataType: "json",
|
||||
contentType: 'application/json',
|
||||
success : options.success || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
var url = this.api_url(path, name);
|
||||
$.ajax(url, settings);
|
||||
};
|
||||
|
||||
Contents.prototype.save = function(path, name, model, options) {
|
||||
// We do the call with settings so we can set cache to false.
|
||||
var settings = {
|
||||
processData : false,
|
||||
type : "PUT",
|
||||
data : JSON.stringify(model),
|
||||
contentType: 'application/json',
|
||||
success : options.success || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
if (options.extra_settings) {
|
||||
$.extend(settings, options.extra_settings);
|
||||
}
|
||||
var url = this.api_url(path, name);
|
||||
$.ajax(url, settings);
|
||||
};
|
||||
|
||||
Contents.prototype.copy = function(to_path, to_name, from, options) {
|
||||
var url, method;
|
||||
if (to_name) {
|
||||
url = this.api_url(to_path, to_name);
|
||||
method = "PUT";
|
||||
} else {
|
||||
url = this.api_url(to_path);
|
||||
method = "POST";
|
||||
}
|
||||
|
||||
var settings = {
|
||||
processData : false,
|
||||
type: method,
|
||||
data: JSON.stringify({copy_from: from}),
|
||||
dataType : "json",
|
||||
success: options.success || function() {},
|
||||
error: this.create_basic_error_handler(options.error)
|
||||
};
|
||||
if (options.extra_settings) {
|
||||
$.extend(settings, options.extra_settings);
|
||||
}
|
||||
$.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 || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
$.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,
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
$.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 || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
$.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 || function() {},
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
$.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 called with ajax results on error
|
||||
*/
|
||||
Contents.prototype.list_contents = function(path, options) {
|
||||
var settings = {
|
||||
processData : false,
|
||||
cache : false,
|
||||
type : "GET",
|
||||
dataType : "json",
|
||||
success : options.success,
|
||||
error : this.create_basic_error_handler(options.error)
|
||||
};
|
||||
|
||||
$.ajax(this.api_url(path), settings);
|
||||
};
|
||||
|
||||
|
||||
IPython.Contents = Contents;
|
||||
|
||||
return {'Contents': Contents};
|
||||
});
|
||||
Loading…
Reference in new issue