mirror of https://gitee.com/bigwinds/arangodb
198 lines
7.5 KiB
JavaScript
198 lines
7.5 KiB
JavaScript
/*jslint indent: 2, nomen: true, maxlen: 100, white: true, plusplus: true, unparam: true */
|
|
/*global require, applicationContext*/
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief A Foxx.Controller to show all Foxx Applications
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2010-2013 triagens GmbH, Cologne, Germany
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
///
|
|
/// Copyright holder is triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Michael Hackstein
|
|
/// @author Copyright 2011-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
"use strict";
|
|
|
|
// Initialise a new FoxxController called controller under the urlPrefix: "foxxes".
|
|
var FoxxController = require("org/arangodb/foxx").Controller,
|
|
controller = new FoxxController(applicationContext),
|
|
underscore = require("underscore");
|
|
|
|
var foxxes = new (require("lib/foxxes").Foxxes)();
|
|
var docus = new (require("lib/swagger").Swagger)();
|
|
|
|
|
|
/** Fetch a foxx from temp folder
|
|
*
|
|
* Makes a foxx uploaded to the temp folder
|
|
* available for mounting.
|
|
*/
|
|
|
|
controller.post("/foxxes/fetch", function (req, res) {
|
|
var content = JSON.parse(req.requestBody),
|
|
path = content.filename;
|
|
res.json(foxxes.fetch(path));
|
|
});
|
|
|
|
// .............................................................................
|
|
// install
|
|
// .............................................................................
|
|
|
|
controller.put("/foxxes/install", function (req, res) {
|
|
var content = JSON.parse(req.requestBody),
|
|
name = content.name,
|
|
mount = content.mount,
|
|
version = content.version;
|
|
res.json(foxxes.install(name, mount, version));
|
|
}).summary("Installs a new foxx")
|
|
.notes("This function is used to install a new foxx.");
|
|
|
|
// .............................................................................
|
|
// uninstall
|
|
// .............................................................................
|
|
|
|
controller.del("/foxxes/:key", function (req, res) {
|
|
res.json(foxxes.uninstall(req.params("key")));
|
|
}).pathParam("key", {
|
|
description: "The _key attribute, where the information of this Foxx-Install is stored.",
|
|
type: "string",
|
|
required: true,
|
|
allowMultiple: false
|
|
}).summary("Uninstall a Foxx.")
|
|
.notes("This function is used to uninstall a foxx.");
|
|
|
|
// .............................................................................
|
|
// update
|
|
// .............................................................................
|
|
|
|
controller.put("/foxxes/:key", function (req, res) {
|
|
var content = JSON.parse(req.requestBody),
|
|
active = content.active;
|
|
// TODO: Other changes applied to foxx! e.g. Mount
|
|
if (active) {
|
|
res.json(foxxes.activate());
|
|
} else {
|
|
res.json(foxxes.deactivate());
|
|
}
|
|
}).pathParam("key", {
|
|
description: "The _key attribute, where the information of this Foxx-Install is stored.",
|
|
type: "string",
|
|
required: true,
|
|
allowMultiple: false
|
|
}).summary("Update a foxx.")
|
|
.notes("Used to either activate/deactivate a foxx, or change the mount point.");
|
|
|
|
// .............................................................................
|
|
// read thumbnail
|
|
// .............................................................................
|
|
|
|
controller.get("/foxxes/thumbnail/:app", function (req, res) {
|
|
res.transformations = [ "base64decode" ];
|
|
res.body = foxxes.thumbnail(req.params("app"));
|
|
}).pathParam("app", {
|
|
description: "The appname which is used to identify the foxx in the list of available foxxes.",
|
|
type: "string",
|
|
required: true,
|
|
allowMultiple: false
|
|
}).summary("Get the thumbnail of a foxx.")
|
|
.notes("Used to request the thumbnail of the given Foxx in order to display it on the screen.");
|
|
|
|
// .............................................................................
|
|
// all foxxes
|
|
// .............................................................................
|
|
|
|
controller.get('/foxxes', function (req, res) {
|
|
res.json(foxxes.viewAll());
|
|
}).summary("List of all foxxes.")
|
|
.notes("This function simply returns the list of all running foxxes");
|
|
|
|
// .............................................................................
|
|
// documentation for all foxxes
|
|
// .............................................................................
|
|
|
|
controller.get('/docus', function (req, res) {
|
|
res.json(docus.list(req.protocol + "://" + req.headers.host + "/_db/" + req.database + req.path + "/"));
|
|
}).summary("List documentation of all foxxes.")
|
|
.notes("This function simply returns the list of all running"
|
|
+ " foxxes and supplies the paths for the swagger documentation");
|
|
|
|
// .............................................................................
|
|
// documentation for one foxx
|
|
// .............................................................................
|
|
|
|
controller.get("/docu/:key",function (req, res) {
|
|
var subPath = req.path.substr(0, req.path.lastIndexOf("[") - 1),
|
|
key = req.params("key"),
|
|
path = req.protocol + "://" + req.headers.host + "/_db/" + req.database + subPath + "/" + key + "/";
|
|
res.json(docus.listOne(path, key));
|
|
}).summary("List documentation of all foxxes.")
|
|
.notes("This function simply returns one specific"
|
|
+ " foxx and supplies the paths for the swagger documentation");
|
|
|
|
// .............................................................................
|
|
// API for one foxx
|
|
// .............................................................................
|
|
|
|
controller.get('/docu/:key/*', function(req, res) {
|
|
var mountPoint = "";
|
|
underscore.each(req.suffix, function(part) {
|
|
mountPoint += "/" + part;
|
|
});
|
|
res.json(docus.show(mountPoint))
|
|
}).pathParam("appname", {
|
|
description: "The mount point of the App the documentation should be requested for",
|
|
type: "string",
|
|
required: true,
|
|
allowMultiple: false
|
|
}).summary("List the API for one foxx")
|
|
.notes("This function lists the API of the foxx"
|
|
+ " running under the given mount point");
|
|
|
|
// .............................................................................
|
|
// Move one foxx from mount-point to another
|
|
// .............................................................................
|
|
|
|
controller.put('/foxx/move/:key', function(req, res) {
|
|
var body = req.body();
|
|
var mountPoint = body.mount;
|
|
var app = body.app;
|
|
var key = req.params("key");
|
|
var prefix = body.prefix;
|
|
var result = foxxes.move(key, app, mountPoint, prefix);
|
|
if (result.error) {
|
|
res.status(result.status);
|
|
res.body = result.message;
|
|
return;
|
|
}
|
|
res.json(result);
|
|
})
|
|
.summary("Move one foxx to another moint point")
|
|
.notes ("This function moves one installed foxx"
|
|
+ " to a given mount point.");
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
/// Local Variables:
|
|
/// mode: outline-minor
|
|
/// outline-regexp: "/// @brief\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}\\|/\\*jslint"
|
|
/// End:
|