//////////////////////////////////////////////////////////////////////////////// /// @brief abstract base request handler /// /// @file /// /// DISCLAIMER /// /// Copyright 2014 ArangoDB GmbH, Cologne, Germany /// Copyright 2004-2014 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 ArangoDB GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany /// @author Copyright 2010-2013, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #include "RestVocbaseBaseHandler.h" #include "Basics/JsonHelper.h" #include "Basics/StringUtils.h" #include "Basics/conversions.h" #include "Basics/string-buffer.h" #include "Basics/tri-strings.h" #include "Rest/HttpRequest.h" #include "ShapedJson/shaped-json.h" #include "Utils/DocumentHelper.h" #include "VocBase/document-collection.h" using namespace std; using namespace triagens::basics; using namespace triagens::rest; using namespace triagens::arango; // ----------------------------------------------------------------------------- // --SECTION-- REST_VOCBASE_BASE_HANDLER // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public constants // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief batch path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::BATCH_PATH = "/_api/batch"; //////////////////////////////////////////////////////////////////////////////// /// @brief document path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::DOCUMENT_PATH = "/_api/document"; //////////////////////////////////////////////////////////////////////////////// /// @brief documents import path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::DOCUMENT_IMPORT_PATH = "/_api/import"; //////////////////////////////////////////////////////////////////////////////// /// @brief document path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::EDGE_PATH = "/_api/edge"; //////////////////////////////////////////////////////////////////////////////// /// @brief replication path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::REPLICATION_PATH = "/_api/replication"; //////////////////////////////////////////////////////////////////////////////// /// @brief upload path //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::UPLOAD_PATH = "/_api/upload"; //////////////////////////////////////////////////////////////////////////////// /// @brief name of the queue //////////////////////////////////////////////////////////////////////////////// const string RestVocbaseBaseHandler::QUEUE_NAME = "STANDARD"; // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief constructor //////////////////////////////////////////////////////////////////////////////// RestVocbaseBaseHandler::RestVocbaseBaseHandler (HttpRequest* request) : RestBaseHandler(request), _context(static_cast(request->getRequestContext())), _vocbase(_context->getVocbase()) { } //////////////////////////////////////////////////////////////////////////////// /// @brief destructor //////////////////////////////////////////////////////////////////////////////// RestVocbaseBaseHandler::~RestVocbaseBaseHandler () { } // ----------------------------------------------------------------------------- // --SECTION-- protected methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief check if a collection needs to be created on the fly /// /// this method will check the "createCollection" attribute of the request. if /// it is set to true, it will verify that the named collection actually exists. /// if the collection does not yet exist, it will create it on the fly. /// if the "createCollection" attribute is not set or set to false, nothing will /// happen, and the collection name will not be checked //////////////////////////////////////////////////////////////////////////////// bool RestVocbaseBaseHandler::checkCreateCollection (string const& name, TRI_col_type_e type) { bool found; char const* valueStr = _request->value("createCollection", found); if (! found) { // "createCollection" parameter not specified return true; } if (! StringUtils::boolean(valueStr)) { // "createCollection" parameter specified, but with non-true value return true; } if (ServerState::instance()->isCoordinator() || ServerState::instance()->isDBserver()) { // create-collection is not supported in a cluster generateTransactionError(name, TRI_ERROR_CLUSTER_UNSUPPORTED); return false; } TRI_vocbase_col_t* collection = TRI_FindCollectionByNameOrCreateVocBase(_vocbase, name.c_str(), type); if (collection == nullptr) { generateTransactionError(name, TRI_errno()); return false; } return true; } //////////////////////////////////////////////////////////////////////////////// /// @brief generates a HTTP 201 or 202 response //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generate20x (HttpResponse::HttpResponseCode responseCode, string const& collectionName, TRI_voc_key_t key, TRI_voc_rid_t rid) { string const&& handle = DocumentHelper::assembleDocumentId(collectionName, key); string const&& rev = StringUtils::itoa(rid); _response = createResponse(responseCode); _response->setContentType("application/json; charset=utf-8"); if (responseCode != HttpResponse::OK) { // 200 OK is sent is case of delete or update. // in these cases we do not return etag nor location _response->setHeader("etag", 4, "\"" + rev + "\""); // handle does not need to be RFC 2047-encoded if (_request->compatibility() < 10400L) { // pre-1.4 location header (e.g. /_api/document/xyz) _response->setHeader("location", 8, string(DOCUMENT_PATH + "/" + handle)); } else { // 1.4+ location header (e.g. /_db/_system/_api/document/xyz) _response->setHeader("location", 8, string("/_db/" + _request->databaseName() + DOCUMENT_PATH + "/" + handle)); } } // _id and _key are safe and do not need to be JSON-encoded _response->body() .appendText("{\"error\":false,\"" TRI_VOC_ATTRIBUTE_ID "\":\"") .appendText(handle) .appendText("\",\"" TRI_VOC_ATTRIBUTE_REV "\":\"") .appendText(rev) .appendText("\",\"" TRI_VOC_ATTRIBUTE_KEY "\":\"") .appendText(key) .appendText("\"}"); } //////////////////////////////////////////////////////////////////////////////// /// @brief generates not implemented //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generateNotImplemented (string const& path) { generateError(HttpResponse::NOT_IMPLEMENTED, TRI_ERROR_NOT_IMPLEMENTED, "'" + path + "' not implemented"); } //////////////////////////////////////////////////////////////////////////////// /// @brief generates forbidden //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generateForbidden () { generateError(HttpResponse::FORBIDDEN, TRI_ERROR_FORBIDDEN, "operation forbidden"); } //////////////////////////////////////////////////////////////////////////////// /// @brief generates precondition failed //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generatePreconditionFailed (string const& collectionName, TRI_voc_key_t key, TRI_voc_rid_t rid) { string const&& rev = StringUtils::itoa(rid); _response = createResponse(HttpResponse::PRECONDITION_FAILED); _response->setContentType("application/json; charset=utf-8"); _response->setHeader("etag", 4, "\"" + rev + "\""); // _id and _key are safe and do not need to be JSON-encoded _response->body() .appendText("{\"error\":true,\"code\":") .appendInteger((int32_t) HttpResponse::PRECONDITION_FAILED) .appendText(",\"errorNum\":") .appendInteger((int32_t) TRI_ERROR_ARANGO_CONFLICT) .appendText(",\"errorMessage\":\"precondition failed\"") .appendText(",\"" TRI_VOC_ATTRIBUTE_ID "\":\"") .appendText(DocumentHelper::assembleDocumentId(collectionName, key)) .appendText("\",\"" TRI_VOC_ATTRIBUTE_REV "\":\"") .appendText(StringUtils::itoa(rid)) .appendText("\",\"" TRI_VOC_ATTRIBUTE_KEY "\":\"") .appendText(key) .appendText("\"}"); } //////////////////////////////////////////////////////////////////////////////// /// @brief generates not modified //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generateNotModified (TRI_voc_rid_t rid) { string const&& rev = StringUtils::itoa(rid); _response = createResponse(HttpResponse::NOT_MODIFIED); _response->setHeader("etag", 4, "\"" + rev + "\""); } //////////////////////////////////////////////////////////////////////////////// /// @brief generates next entry from a result set //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generateDocument (SingleCollectionReadOnlyTransaction& trx, TRI_voc_cid_t cid, TRI_doc_mptr_copy_t const& mptr, TRI_shaper_t* shaper, bool generateBody) { CollectionNameResolver const* resolver = trx.resolver(); char const* key = TRI_EXTRACT_MARKER_KEY(&mptr); // PROTECTED by trx from above string const&& id = DocumentHelper::assembleDocumentId(resolver->getCollectionName(cid), key); TRI_json_t augmented; TRI_InitArray2Json(TRI_UNKNOWN_MEM_ZONE, &augmented, 5); TRI_json_t* idJson = TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, id.c_str(), id.size()); if (idJson != nullptr) { TRI_Insert2ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_ID, idJson); } // convert rid from uint64_t to string string const&& rid = StringUtils::itoa(mptr._rid); TRI_json_t* rev = TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, rid.c_str(), rid.size()); if (rev != nullptr) { TRI_Insert2ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_REV, rev); } TRI_json_t* keyJson = TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, key, strlen(key)); if (keyJson) { TRI_Insert2ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_KEY, keyJson); } TRI_df_marker_type_t type = static_cast(mptr.getDataPtr())->_type; // PROTECTED by trx passed from above if (type == TRI_DOC_MARKER_KEY_EDGE) { TRI_doc_edge_key_marker_t const* marker = static_cast(mptr.getDataPtr()); // PROTECTED by trx passed from above string const&& from = DocumentHelper::assembleDocumentId(resolver->getCollectionNameCluster(marker->_fromCid), string((char*) marker + marker->_offsetFromKey)); string const&& to = DocumentHelper::assembleDocumentId(resolver->getCollectionNameCluster(marker->_toCid), string((char*) marker + marker->_offsetToKey)); TRI_Insert3ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_FROM, TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, from.c_str(), from.size())); TRI_Insert3ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_TO, TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, to.c_str(), to.size())); } else if (type == TRI_WAL_MARKER_EDGE) { triagens::wal::edge_marker_t const* marker = static_cast(mptr.getDataPtr()); // PROTECTED by trx passed from above string const&& from = DocumentHelper::assembleDocumentId(resolver->getCollectionNameCluster(marker->_fromCid), string((char*) marker + marker->_offsetFromKey)); string const&& to = DocumentHelper::assembleDocumentId(resolver->getCollectionNameCluster(marker->_toCid), string((char*) marker + marker->_offsetToKey)); TRI_Insert3ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_FROM, TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, from.c_str(), from.size())); TRI_Insert3ArrayJson(TRI_UNKNOWN_MEM_ZONE, &augmented, TRI_VOC_ATTRIBUTE_TO, TRI_CreateString2CopyJson(TRI_UNKNOWN_MEM_ZONE, to.c_str(), to.size())); } // add document identifier to buffer TRI_string_buffer_t buffer; // convert object to string TRI_InitStringBuffer(&buffer, TRI_UNKNOWN_MEM_ZONE); TRI_shaped_json_t shapedJson; TRI_EXTRACT_SHAPED_JSON_MARKER(shapedJson, mptr.getDataPtr()); // PROTECTED by trx passed from above TRI_StringifyAugmentedShapedJson(shaper, &buffer, &shapedJson, &augmented); TRI_DestroyJson(TRI_UNKNOWN_MEM_ZONE, &augmented); if (idJson) { TRI_Free(TRI_UNKNOWN_MEM_ZONE, idJson); } if (rev) { TRI_Free(TRI_UNKNOWN_MEM_ZONE, rev); } if (keyJson) { TRI_Free(TRI_UNKNOWN_MEM_ZONE, keyJson); } // and generate a response _response = createResponse(HttpResponse::OK); _response->setContentType("application/json; charset=utf-8"); _response->setHeader("etag", 4, "\"" + rid + "\""); if (generateBody) { _response->body().appendText(TRI_BeginStringBuffer(&buffer), TRI_LengthStringBuffer(&buffer)); } else { _response->headResponse(TRI_LengthStringBuffer(&buffer)); } TRI_DestroyStringBuffer(&buffer); } //////////////////////////////////////////////////////////////////////////////// /// @brief generate an error message for a transaction error //////////////////////////////////////////////////////////////////////////////// void RestVocbaseBaseHandler::generateTransactionError (string const& collectionName, int res, TRI_voc_key_t key, TRI_voc_rid_t rid) { switch (res) { case TRI_ERROR_ARANGO_COLLECTION_NOT_FOUND: if (collectionName.empty()) { // no collection name specified generateError(HttpResponse::BAD, res, "no collection name specified"); } else { // collection name specified but collection not found generateError(HttpResponse::NOT_FOUND, res, "collection '" + collectionName + "' not found"); } return; case TRI_ERROR_ARANGO_READ_ONLY: generateError(HttpResponse::FORBIDDEN, res, "collection is read-only"); return; case TRI_ERROR_ARANGO_UNIQUE_CONSTRAINT_VIOLATED: generateError(HttpResponse::CONFLICT, res, "cannot create document, unique constraint violated"); return; case TRI_ERROR_ARANGO_GEO_INDEX_VIOLATED: generateError(HttpResponse::CONFLICT, res, "geo constraint violated"); return; case TRI_ERROR_ARANGO_DOCUMENT_KEY_BAD: generateError(HttpResponse::BAD, res, "invalid document key"); return; case TRI_ERROR_ARANGO_OUT_OF_KEYS: generateError(HttpResponse::SERVER_ERROR, res, "out of keys"); return; case TRI_ERROR_ARANGO_DOCUMENT_KEY_UNEXPECTED: generateError(HttpResponse::BAD, res, "collection does not allow using user-defined keys"); return; case TRI_ERROR_ARANGO_DOCUMENT_NOT_FOUND: generateDocumentNotFound(collectionName, key); return; case TRI_ERROR_ARANGO_DOCUMENT_TYPE_INVALID: generateError(HttpResponse::BAD, res); return; case TRI_ERROR_ARANGO_CONFLICT: generatePreconditionFailed(collectionName, key ? key : (TRI_voc_key_t) "unknown", rid); return; case TRI_ERROR_CLUSTER_SHARD_GONE: generateError(HttpResponse::SERVER_ERROR, res, "coordinator: no responsible shard found"); return; case TRI_ERROR_CLUSTER_TIMEOUT: generateError(HttpResponse::SERVER_ERROR, res); return; case TRI_ERROR_CLUSTER_MUST_NOT_CHANGE_SHARDING_ATTRIBUTES: case TRI_ERROR_CLUSTER_MUST_NOT_SPECIFY_KEY: { generateError(HttpResponse::BAD, res); return; } case TRI_ERROR_CLUSTER_UNSUPPORTED: { generateError(HttpResponse::NOT_IMPLEMENTED, res); return; } default: generateError(HttpResponse::SERVER_ERROR, TRI_ERROR_INTERNAL, "failed with error: " + string(TRI_errno_string(res))); } } //////////////////////////////////////////////////////////////////////////////// /// @brief extracts the revision //////////////////////////////////////////////////////////////////////////////// TRI_voc_rid_t RestVocbaseBaseHandler::extractRevision (char const* header, char const* parameter, bool& isValid) { isValid = true; bool found; char const* etag = _request->header(header, found); if (found) { char const* s = etag; char const* e = etag + strlen(etag); while (s < e && (s[0] == ' ' || s[0] == '\t')) { ++s; } if (s < e && (s[0] == '"' || s[0] == '\'')) { ++s; } while (s < e && (e[-1] == ' ' || e[-1] == '\t')) { --e; } if (s < e && (e[-1] == '"' || e[-1] == '\'')) { --e; } TRI_voc_rid_t rid = TRI_UInt64String2(s, e - s); isValid = (TRI_errno() != TRI_ERROR_ILLEGAL_NUMBER); return rid; } if (parameter != nullptr) { etag = _request->value(parameter, found); if (found) { TRI_voc_rid_t rid = TRI_UInt64String(etag); isValid = (TRI_errno() != TRI_ERROR_ILLEGAL_NUMBER); return rid; } } return 0; } //////////////////////////////////////////////////////////////////////////////// /// @brief extracts the update policy //////////////////////////////////////////////////////////////////////////////// TRI_doc_update_policy_e RestVocbaseBaseHandler::extractUpdatePolicy () const { bool found; char const* policy = _request->value("policy", found); if (found) { if (TRI_CaseEqualString(policy, "error")) { return TRI_DOC_UPDATE_ERROR; } else if (TRI_CaseEqualString(policy, "last")) { return TRI_DOC_UPDATE_LAST_WRITE; } else { return TRI_DOC_UPDATE_ILLEGAL; } } else { return TRI_DOC_UPDATE_ERROR; } } //////////////////////////////////////////////////////////////////////////////// /// @brief extracts the waitForSync value //////////////////////////////////////////////////////////////////////////////// bool RestVocbaseBaseHandler::extractWaitForSync () const { bool found; char const* forceStr = _request->value("waitForSync", found); if (found) { return StringUtils::boolean(forceStr); } return false; } //////////////////////////////////////////////////////////////////////////////// /// @brief parses the body //////////////////////////////////////////////////////////////////////////////// TRI_json_t* RestVocbaseBaseHandler::parseJsonBody () { char* errmsg = nullptr; TRI_json_t* json = _request->toJson(&errmsg); if (json == nullptr) { if (errmsg == nullptr) { generateError(HttpResponse::BAD, TRI_ERROR_HTTP_CORRUPTED_JSON, "cannot parse json object"); } else { generateError(HttpResponse::BAD, TRI_ERROR_HTTP_CORRUPTED_JSON, errmsg); TRI_FreeString(TRI_CORE_MEM_ZONE, errmsg); } return nullptr; } TRI_ASSERT(errmsg == nullptr); if (TRI_HasDuplicateKeyJson(json)) { generateError(HttpResponse::BAD, TRI_ERROR_HTTP_CORRUPTED_JSON, "cannot parse json object"); TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json); return nullptr; } return json; } // ----------------------------------------------------------------------------- // --SECTION-- HANDLER // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// string const& RestVocbaseBaseHandler::queue () const { return QUEUE_NAME; } //////////////////////////////////////////////////////////////////////////////// /// @brief extract a string attribute from a JSON array /// /// if the attribute is not there or not a string, this returns 0 //////////////////////////////////////////////////////////////////////////////// char const* RestVocbaseBaseHandler::extractJsonStringValue (TRI_json_t const* json, char const* name) { if (! TRI_IsArrayJson(json)) { return nullptr; } TRI_json_t const* value = TRI_LookupArrayJson(json, name); if (! TRI_IsStringJson(value)) { return nullptr; } return value->_value._string.data; } //////////////////////////////////////////////////////////////////////////////// /// @brief parses a document handle /// TODO: merge with DocumentHelper::parseDocumentId //////////////////////////////////////////////////////////////////////////////// int RestVocbaseBaseHandler::parseDocumentId (CollectionNameResolver const* resolver, string const& handle, TRI_voc_cid_t& cid, TRI_voc_key_t& key) { char const* ptr = handle.c_str(); char const* end = ptr + handle.size(); if (end - ptr < 3) { // minimum length of document id is 3: // at least 1 byte for collection name, '/' + at least 1 byte for key return TRI_set_errno(TRI_ERROR_ARANGO_DOCUMENT_HANDLE_BAD); } char const* pos = static_cast(memchr(static_cast(ptr), TRI_DOCUMENT_HANDLE_SEPARATOR_CHR, handle.size())); if (pos == nullptr || pos >= end - 1) { // if no '/' is found, the id is invalid // if '/' is at the very end, the id is invalid too return TRI_set_errno(TRI_ERROR_ARANGO_DOCUMENT_HANDLE_BAD); } // check if the id contains a second '/' if (memchr(static_cast(pos + 1), TRI_DOCUMENT_HANDLE_SEPARATOR_CHR, end - pos - 1) != nullptr) { return TRI_set_errno(TRI_ERROR_ARANGO_DOCUMENT_HANDLE_BAD); } char const first = *ptr; if (first >= '0' && first <= '9') { cid = TRI_UInt64String2(ptr, ptr - pos); } else { cid = resolver->getCollectionIdCluster(std::string(ptr, pos - ptr)); } if (cid == 0) { return TRI_ERROR_ARANGO_COLLECTION_NOT_FOUND; } key = TRI_DuplicateString2Z(TRI_CORE_MEM_ZONE, pos + 1, end - pos - 1); return TRI_ERROR_NO_ERROR; } // ----------------------------------------------------------------------------- // --SECTION-- END-OF-FILE // ----------------------------------------------------------------------------- // Local Variables: // mode: outline-minor // outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}" // End: