mirror of https://gitee.com/bigwinds/arangodb
487 lines
17 KiB
JavaScript
487 lines
17 KiB
JavaScript
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief JavaScript actions modules
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2012 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 Dr. Frank Celler
|
|
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
var internal = require("internal");
|
|
var console = require("console");
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoActions
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns a result of a query as documents
|
|
///
|
|
/// @FUN{actions.defineHttp(@FA{options})}
|
|
///
|
|
/// Defines a new action. The @FA{options} are as follows:
|
|
///
|
|
/// @FA{options.url}
|
|
///
|
|
/// The URL, which can be used to access the action. This path might contain
|
|
/// slashes. Note that this action will also be called, if a url is given such that
|
|
/// @FA{options.url} is a prefix of the given url and no longer definition
|
|
/// matches.
|
|
///
|
|
/// @FA{options.context}
|
|
///
|
|
/// The context to which this actions belongs. Possible values are "admin",
|
|
/// "monitoring", "api", and "user". All contexts apart from "user" are reserved
|
|
/// for system actions and are database independent. All actions except "user"
|
|
/// and "api" are executed in a different worker queue than the normal queue for
|
|
/// clients. The "api" actions are used by the client api to communicate with
|
|
/// the AvocadoDB server. Both the "api" and "user" actions are using the same
|
|
/// worker queue.
|
|
///
|
|
/// It is possible to specify a list of contexts, in case an actions belongs to
|
|
/// more than one context.
|
|
///
|
|
/// Note that the url for "user" actions is automatically prefixed
|
|
/// with @LIT{_action}. This applies to all specified contexts. For example, if
|
|
/// the context contains "admin" and "user" and the url is @LIT{hallo}, then the
|
|
/// action is accessible under @LIT{/_action/hallo} - even for the admin context.
|
|
///
|
|
/// @FA{options.callback}(@FA{request}, @FA{response})
|
|
///
|
|
/// The request argument contains a description of the request. A request
|
|
/// parameter @LIT{foo} is accessible as @LIT{request.parametrs.foo}. A request
|
|
/// header @LIT{bar} is accessible as @LIT{request.headers.bar}. Assume that
|
|
/// the action is defined for the url @LIT{/foo/bar} and the request url is
|
|
/// @LIT{/foo/bar/hugo/egon}. Then the suffix parts @LIT{[ "hugon"\, "egon" ]}
|
|
/// are availible in @LIT{request.suffix}.
|
|
///
|
|
/// The callback must define fill the @FA{response}.
|
|
///
|
|
/// - @LIT{@FA{response}.responseCode}: the response code
|
|
/// - @LIT{@FA{response}.contentType}: the content type of the response
|
|
/// - @LIT{@FA{response}.body}: the body of the response
|
|
///
|
|
/// You can use the functions @FN{ResultOk} and @FN{ResultError} to easily
|
|
/// generate a response.
|
|
///
|
|
/// @FA{options.parameters}
|
|
///
|
|
/// Normally the paramaters are passed to the callback as strings. You can
|
|
/// use the @FA{options}, to force a converstion of the parameter to
|
|
///
|
|
/// - @c "collection"
|
|
/// - @c "collection-identifier"
|
|
/// - @c "collection-name"
|
|
/// - @c "number"
|
|
/// - @c "string"
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function DefineHttp (options) {
|
|
var url = options.url;
|
|
var contexts = options.context;
|
|
var callback = options.callback;
|
|
var parameter = options.parameter;
|
|
var userContext = false;
|
|
|
|
if (! contexts) {
|
|
contexts = "user";
|
|
}
|
|
|
|
if (typeof contexts == "string") {
|
|
if (contexts == "user") {
|
|
userContext = true;
|
|
}
|
|
|
|
contexts = [ contexts ];
|
|
}
|
|
else {
|
|
for (var i = 0; i < contexts.length && ! userContext; ++i) {
|
|
if (context == "user") {
|
|
userContext = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (userContext) {
|
|
url = "_action/" + url;
|
|
}
|
|
|
|
if (typeof callback !== "function") {
|
|
console.error("callback for '%s' must be a function, got '%s'", url + (typeof callback));
|
|
return;
|
|
}
|
|
|
|
// console.debug("callback: %s", callback);
|
|
|
|
for (var i = 0; i < contexts.length; ++i) {
|
|
var context = contexts[i];
|
|
var use = false;
|
|
|
|
if (context == "admin") {
|
|
if (SYS_ACTION_QUEUE == "SYSTEM") {
|
|
use = true;
|
|
}
|
|
}
|
|
else if (context == "api") {
|
|
if (SYS_ACTION_QUEUE == "SYSTEM" || SYS_ACTION_QUEUE == "CLIENT") {
|
|
use = true;
|
|
}
|
|
}
|
|
else if (context == "user") {
|
|
if (SYS_ACTION_QUEUE == "SYSTEM" || SYS_ACTION_QUEUE == "CLIENT") {
|
|
use = true;
|
|
}
|
|
}
|
|
else if (context == "monitoring") {
|
|
if (SYS_ACTION_QUEUE == "MONITORING") {
|
|
use = true;
|
|
}
|
|
}
|
|
|
|
if (use) {
|
|
try {
|
|
internal.defineAction(url, SYS_ACTION_QUEUE, callback, parameter);
|
|
console.debug("defining action '%s' in context '%s' using queue '%s'", url, context, SYS_ACTION_QUEUE);
|
|
}
|
|
catch (err) {
|
|
console.error("action '%s' encountered error: %s", url, err);
|
|
}
|
|
}
|
|
else {
|
|
console.debug("ignoring '%s' for context '%s' in queue '%s'", url, context, SYS_ACTION_QUEUE);
|
|
}
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get an error message string for an error code
|
|
///
|
|
/// @FUN{actions.getErrorMessage(@FA{code})}
|
|
///
|
|
/// Returns the error message for an error code.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function GetErrorMessage (code) {
|
|
var error = internal.errors[code];
|
|
|
|
if (!error) {
|
|
return "";
|
|
}
|
|
|
|
return error.message;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error
|
|
///
|
|
/// @FUN{actions.resultError(@FA{req}, @FA{res}, @FA{code}, @FA{errorNum}, @FA{errorMessage}, @FA{headers}, @FA{keyvals})}
|
|
///
|
|
/// The functions generates an error response. The response body is an array
|
|
/// with an attribute @LIT{errorMessage} containing the error message
|
|
/// @FA{errorMessage}, @LIT{error} containing @LIT{true}, @LIT{code} containing
|
|
/// @FA{code}, @LIT{errorNum} containing @FA{errorNum}, and @LIT{errorMessage}
|
|
/// containing the error message @FA{errorMessage}. @FA{keyvals} are mixed
|
|
/// into the result.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultError (req, res, httpReturnCode, errorNum, errorMessage, headers, keyvals) {
|
|
res.responseCode = httpReturnCode;
|
|
res.contentType = "application/json";
|
|
|
|
if (typeof errorNum === "string") {
|
|
keyvals = headers;
|
|
headers = errorMessage;
|
|
errorMessage = errorNum;
|
|
errorNum = httpReturnCode;
|
|
}
|
|
|
|
var result = {};
|
|
|
|
if (keyvals !== undefined) {
|
|
for (var i in keyvals) {
|
|
if (keyvals.hasOwnProperty(i)) {
|
|
result[i] = keyvals[i];
|
|
}
|
|
}
|
|
}
|
|
|
|
result["error"] = true;
|
|
result["code"] = httpReturnCode;
|
|
result["errorNum"] = errorNum;
|
|
result["errorMessage"] = errorMessage;
|
|
|
|
res.body = JSON.stringify(result);
|
|
|
|
if (headers != undefined) {
|
|
res.headers = headers;
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- standard HTTP responses
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoActions
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns a result
|
|
///
|
|
/// @FUN{actions.resultOk(@FA{req}, @FA{res}, @FA{code}, @FA{result}, @FA{headers}})}
|
|
///
|
|
/// The functions defines a response. @FA{code} is the status code to
|
|
/// return. @FA{result} is the result object, which will be returned as JSON
|
|
/// object in the body. @LIT{headers} is an array of headers to returned.
|
|
/// The function adds the attribute @LIT{error} with value @LIT{false}
|
|
/// and @LIT{code} with value @FA{code} to the @FA{result}.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultOk (req, res, httpReturnCode, result, headers) {
|
|
res.responseCode = httpReturnCode;
|
|
res.contentType = "application/json";
|
|
|
|
// add some default attributes to result
|
|
if (result == undefined) {
|
|
result = {};
|
|
}
|
|
|
|
result.error = false;
|
|
result.code = httpReturnCode;
|
|
|
|
res.body = JSON.stringify(result);
|
|
|
|
if (headers != undefined) {
|
|
res.headers = headers;
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for a bad request
|
|
///
|
|
/// @FUN{actions.resultBad(@FA{req}, @FA{res}, @FA{error-code}, @FA{msg}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultBad (req, res, code, msg, headers) {
|
|
ResultError(req, res, exports.HTTP_BAD, code, "" + msg, headers);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for not found
|
|
///
|
|
/// @FUN{actions.resultNotFound(@FA{req}, @FA{res}, @FA{msg}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultNotFound (req, res, msg, headers) {
|
|
ResultError(req, res, exports.HTTP_NOT_FOUND, exports.ERROR_HTTP_NOT_FOUND, "" + msg, headers);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for unsupported methods
|
|
///
|
|
/// @FUN{actions.resultUnsupported(@FA{req}, @FA{res}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultUnsupported (req, res, headers) {
|
|
ResultError(req, res,
|
|
exports.HTTP_METHOD_NOT_ALLOWED, exports.ERROR_HTTP_METHOD_NOT_ALLOWED,
|
|
"Unsupported method",
|
|
headers);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- AvocadoDB specific responses
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoActions
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for unknown collection
|
|
///
|
|
/// @FUN{actions.collectionNotFound(@FA{req}, @FA{res}, @FA{collection}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function CollectionNotFound (req, res, collection, headers) {
|
|
if (collection == null) {
|
|
ResultError(req, res,
|
|
exports.HTTP_BAD, exports.ERROR_HTTP_BAD_PARAMETER,
|
|
"expecting a collection name or identifier",
|
|
headers);
|
|
}
|
|
else {
|
|
ResultError(req, res,
|
|
exports.HTTP_NOT_FOUND, exports.ERROR_AVOCADO_COLLECTION_NOT_FOUND,
|
|
"unknown collection '" + collection + "'", headers);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for unknown index
|
|
///
|
|
/// @FUN{actions.collectionNotFound(@FA{req}, @FA{res}, @FA{collection}, @FA{index}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function IndexNotFound (req, res, collection, index, headers) {
|
|
if (collection == null) {
|
|
ResultError(req, res,
|
|
exports.HTTP_BAD, exports.ERROR_HTTP_BAD_PARAMETER,
|
|
"expecting a collection name or identifier",
|
|
headers);
|
|
}
|
|
else if (index == null) {
|
|
ResultError(req, res,
|
|
exports.HTTP_BAD, exports.ERROR_HTTP_BAD_PARAMETER,
|
|
"expecting an index identifier",
|
|
headers);
|
|
}
|
|
else {
|
|
ResultError(req, res,
|
|
exports.HTTP_NOT_FOUND, exports.ERROR_AVOCADO_INDEX_NOT_FOUND,
|
|
"unknown index '" + index + "'", headers);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief generates an error for an exception
|
|
///
|
|
/// @FUN{actions.resultException(@FA{req}, @FA{res}, @FA{err}, @FA{headers})}
|
|
///
|
|
/// The functions generates an error response.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function ResultException (req, res, err, headers) {
|
|
if (err instanceof AvocadoError) {
|
|
var num = err.errorNum;
|
|
var msg = err.errorMessage;
|
|
var code = exports.HTTP_BAD;
|
|
|
|
switch (num) {
|
|
case exports.ERROR_INTERNAL: code = exports.HTTP_SERVER_ERROR; break;
|
|
}
|
|
|
|
ResultError(req, res, code, num, msg, headers);
|
|
}
|
|
else {
|
|
ResultError(req, res,
|
|
exports.HTTP_SERVER_ERROR, exports.ERROR_HTTP_SERVER_ERROR,
|
|
"" + err,
|
|
headers);
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- MODULE EXPORTS
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup AvocadoActions
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// public functions
|
|
exports.defineHttp = DefineHttp;
|
|
exports.getErrorMessage = GetErrorMessage;
|
|
|
|
// standard HTTP responses
|
|
exports.resultBad = ResultBad;
|
|
exports.resultNotFound = ResultNotFound;
|
|
exports.resultOk = ResultOk;
|
|
exports.resultUnsupported = ResultUnsupported;
|
|
exports.resultError = ResultError;
|
|
|
|
// AvocadoDB specific responses
|
|
exports.collectionNotFound = CollectionNotFound;
|
|
exports.indexNotFound = IndexNotFound;
|
|
exports.resultException = ResultException;
|
|
|
|
// some useful constants
|
|
exports.COLLECTION = "collection";
|
|
exports.COLLECTION_IDENTIFIER = "collection-identifier";
|
|
exports.COLLECTION_NAME = "collection-name";
|
|
exports.NUMBER = "number";
|
|
|
|
exports.DELETE = "DELETE";
|
|
exports.GET = "GET";
|
|
exports.HEAD = "HEAD";
|
|
exports.POST = "POST";
|
|
exports.PUT = "PUT";
|
|
|
|
// HTTP 2xx
|
|
exports.HTTP_OK = 200;
|
|
exports.HTTP_CREATED = 201;
|
|
exports.HTTP_ACCEPTED = 202;
|
|
|
|
// HTTP 4xx
|
|
exports.HTTP_BAD = 400;
|
|
exports.HTTP_NOT_FOUND = 404;
|
|
exports.HTTP_METHOD_NOT_ALLOWED = 405;
|
|
exports.HTTP_CONFLICT = 409;
|
|
|
|
// HTTP 5xx
|
|
exports.HTTP_SERVER_ERROR = 500;
|
|
|
|
// copy error codes
|
|
for (var name in internal.errors) {
|
|
if (internal.errors.hasOwnProperty(name)) {
|
|
exports[name] = internal.errors[name].code;
|
|
}
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @}\\)"
|
|
// End:
|