////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 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 Max Neunhoeffer
////////////////////////////////////////////////////////////////////////////////

#include "RestAqlHandler.h"
#include "Aql/AqlItemBlock.h"
#include "Aql/ClusterBlocks.h"
#include "Aql/ExecutionBlock.h"
#include "Aql/ExecutionEngine.h"
#include "Aql/Query.h"
#include "Aql/QueryRegistry.h"
#include "Basics/Exceptions.h"
#include "Basics/StaticStrings.h"
#include "Basics/StringUtils.h"
#include "Basics/VPackStringBufferAdapter.h"
#include "Basics/VelocyPackHelper.h"
#include "Basics/tri-strings.h"
#include "Cluster/ServerState.h"
#include "Cluster/TraverserEngine.h"
#include "Cluster/TraverserEngineRegistry.h"
#include "Logger/Logger.h"
#include "Rest/HttpRequest.h"
#include "Rest/HttpResponse.h"
#include "Scheduler/JobGuard.h"
#include "Scheduler/JobQueue.h"
#include "Scheduler/SchedulerFeature.h"
#include "Transaction/Context.h"
#include "Transaction/Methods.h"
#include "VocBase/ticks.h"

#include <velocypack/Dumper.h>
#include <velocypack/Iterator.h>
#include <velocypack/velocypack-aliases.h>

using namespace arangodb;
using namespace arangodb::rest;
using namespace arangodb::aql;

using VelocyPackHelper = arangodb::basics::VelocyPackHelper;

RestAqlHandler::RestAqlHandler(GeneralRequest* request,
                               GeneralResponse* response,
                               std::pair<QueryRegistry*, traverser::TraverserEngineRegistry*>* registries)
    : RestVocbaseBaseHandler(request, response),
      _queryRegistry(registries->first),
      _traverserRegistry(registries->second),
      _qId(0) {
  TRI_ASSERT(_queryRegistry != nullptr);
  TRI_ASSERT(_traverserRegistry != nullptr);
}

// returns the queue name
size_t RestAqlHandler::queue() const { return JobQueue::AQL_QUEUE; }

bool RestAqlHandler::isDirect() const { return false; }

// POST method for /_api/aql/setup (internal)
// Only available on DBServers in the Cluster.
// This route sets-up all the query engines required
// for a complete query on this server.
// Furthermore it directly locks all shards for this query.
// So after this route the query is ready to go.
// NOTE: As this Route LOCKS the collections, the caller
// is responsible to destroy those engines in a timely
// manner, if the engines are not called for a period
// of time, they will be garbage-collected and unlocked.
// The body is a VelocyPack with the following layout:
//  {
//    lockInfo: {
//      NONE: [<collections to not-lock],
//      READ: [<collections to read-lock],
//      WRITE: [<collections to write-lock],
//      EXCLUSIVE: [<collections with exclusive-lock]
//    },
//    options: { < query options > },
//    snippets: {
//      <queryId: {nodes: [ <nodes>]}>
//    },
//    traverserEngines: [ <infos for traverser engines> ],
//    variables: [ <variables> ]
//  }

void RestAqlHandler::setupClusterQuery() {
  // We should not intentionally call this method
  // on the wrong server. So fail during maintanence.
  // On user setup reply gracefully.
  TRI_ASSERT(ServerState::instance()->isDBServer());
  if (!ServerState::instance()->isDBServer()) {
    generateError(rest::ResponseCode::METHOD_NOT_ALLOWED,
                  TRI_ERROR_CLUSTER_ONLY_ON_DBSERVER);
    return;
  }

  // ---------------------------------------------------
  // SECTION:                            body validation
  // ---------------------------------------------------
  bool success = false;
  VPackSlice querySlice = this->parseVPackBody(success);
  if (!success) {
    // if no success here, generateError will have been called already
    LOG_TOPIC(ERR, arangodb::Logger::AQL) << "Failed to setup query. Could not "
                                             "parse the transmitted plan. "
                                             "Aborting query.";
    return;
  }

  VPackSlice lockInfoSlice = querySlice.get("lockInfo");

  if (!lockInfoSlice.isObject()) {
    LOG_TOPIC(ERR, arangodb::Logger::AQL)
        << "Invalid VelocyPack: \"lockInfo\" is required but not an object.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "body must be an object with attribute \"lockInfo\"");
    return;
  }

  VPackSlice optionsSlice = querySlice.get("options");
  if (!optionsSlice.isObject()) {
    LOG_TOPIC(ERR, arangodb::Logger::AQL)
        << "Invalid VelocyPack: \"options\" attribute missing.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "body must be an object with attribute \"options\"");
    return;
  }

  VPackSlice snippetsSlice = querySlice.get("snippets");
  if (!snippetsSlice.isObject()) {
    LOG_TOPIC(ERR, arangodb::Logger::AQL)
        << "Invalid VelocyPack: \"snippets\" attribute missing.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "body must be an object with attribute \"snippets\"");
    return;
  }

  VPackSlice traverserSlice = querySlice.get("traverserEngines");
  if (!traverserSlice.isNone() && !traverserSlice.isArray()) {
    LOG_TOPIC(ERR, arangodb::Logger::AQL)
        << "Invalid VelocyPack: \"traverserEngines\" attribute is not an array.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "if \"traverserEngines\" is set in the body, it has to be an array");
    return;
  }

  VPackSlice variablesSlice = querySlice.get("variables");
  if (!variablesSlice.isArray()) {
    LOG_TOPIC(ERR, arangodb::Logger::AQL)
        << "Invalid VelocyPack: \"variables\" attribute missing.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "body must be an object with attribute \"variables\"");
    return;
  }


  // Now we need to create shared_ptr<VPackBuilder>
  // That contains the old-style cluster snippet in order
  // to prepare create a Query object.
  // This old snippet is created as follows:
  //
  // {
  //   collections: [ { name: "xyz", type: "READ" }, {name: "abc", type: "WRITE"} ],
  //   initialize: false,
  //   nodes: <one of snippets[*].value>,
  //   variables: <variables slice>
  // }


  auto options = std::make_shared<VPackBuilder>(
      VPackBuilder::clone(optionsSlice));


  // Build the collection information
  VPackBuilder collectionBuilder;
  collectionBuilder.openArray();
  for (auto const& lockInf : VPackObjectIterator(lockInfoSlice)) {
    if (!lockInf.value.isArray()) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "Invalid VelocyPack: \"lockInfo." << lockInf.key.copyString()
          << "\" is required but not an array.";
      generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
          "body must be an object with attribute: \"lockInfo." + lockInf.key.copyString() + "\" is required but not an array.");
      return;
    }
    for (auto const& col : VPackArrayIterator(lockInf.value)) {
      if (!col.isString()) {
        LOG_TOPIC(ERR, arangodb::Logger::AQL)
            << "Invalid VelocyPack: \"lockInfo." << lockInf.key.copyString()
            << "\" is required but not an array.";
        generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
            "body must be an object with attribute: \"lockInfo." + lockInf.key.copyString() + "\" is required but not an array.");
        return;
      }
      collectionBuilder.openObject();
      collectionBuilder.add("name", col);
      collectionBuilder.add("type", lockInf.key);
      collectionBuilder.close();
    }
  }
  collectionBuilder.close();

  // Now the query is ready to go, store it in the registry and return:
  double ttl = 600.0;
  bool found;
  std::string const& ttlstring = _request->header("ttl", found);

  if (found) {
    ttl = arangodb::basics::StringUtils::doubleDecimal(ttlstring);
  }

  VPackBuilder answerBuilder;
  answerBuilder.openObject();
  bool needToLock = true;
  bool res = registerSnippets(snippetsSlice, collectionBuilder.slice(), variablesSlice,
                              options, ttl, needToLock, answerBuilder);
  if (!res) {
    // TODO we need to trigger cleanup here??
    // Registering the snippets failed.
    return;
  }

  if (!traverserSlice.isNone()) {

    res = registerTraverserEngines(traverserSlice, needToLock, ttl, answerBuilder);

    if (!res) {
      // TODO we need to trigger cleanup here??
      // Registering the traverser engines failed.
      return;
    }
  }

  answerBuilder.close();

  generateOk(rest::ResponseCode::OK, answerBuilder.slice());
}

bool RestAqlHandler::registerSnippets(
    VPackSlice const snippetsSlice,
    VPackSlice const collectionSlice,
    VPackSlice const variablesSlice,
    std::shared_ptr<VPackBuilder> options,
    double const ttl,
    bool& needToLock,
    VPackBuilder& answerBuilder
    ) {
  TRI_ASSERT(answerBuilder.isOpenObject());
  answerBuilder.add(VPackValue("snippets"));
  answerBuilder.openObject();
  // NOTE: We need to clean up all engines if we bail out during the following
  // loop
  for (auto const& it : VPackObjectIterator(snippetsSlice)) {
    auto planBuilder = std::make_shared<VPackBuilder>();
    planBuilder->openObject();
    planBuilder->add(VPackValue("collections"));
    planBuilder->add(collectionSlice);

      // hard-code initialize: false
    planBuilder->add("initialize", VPackValue(false));

    planBuilder->add(VPackValue("nodes"));
    planBuilder->add(it.value.get("nodes"));

    planBuilder->add(VPackValue("variables"));
    planBuilder->add(variablesSlice);
    planBuilder->close(); // base-object

    // All snippets know all collections.
    // The first snippet will provide proper locking
    auto query = std::make_unique<Query>(
      false,
      _vocbase,
      planBuilder,
      options,
      (needToLock ? PART_MAIN : PART_DEPENDENT)
    );

    bool prepared = false;
    try {
      query->prepare(_queryRegistry, 0);
      prepared = true;
    } catch (std::exception const& ex) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "failed to instantiate the query: " << ex.what();
      generateError(rest::ResponseCode::BAD, TRI_ERROR_QUERY_BAD_JSON_PLAN,
                    ex.what());
      return false;
    } catch (...) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "failed to instantiate the query";
      generateError(rest::ResponseCode::BAD, TRI_ERROR_QUERY_BAD_JSON_PLAN);
      return false;
    }

    try {
      QueryId qId = TRI_NewTickServer();

      if (needToLock) {
        // Directly try to lock only the first snippet is required to be locked.
        // For all others locking is pointless
        needToLock = false;

        {
          JobGuard guard(SchedulerFeature::SCHEDULER);
          guard.block();

          try {
            int res = query->trx()->lockCollections();
            if (res != TRI_ERROR_NO_ERROR) {
              generateError(rest::ResponseCode::SERVER_ERROR,
                  res, TRI_errno_string(res));
              return false;
            }
          } catch (basics::Exception  const& e) {
            generateError(rest::ResponseCode::SERVER_ERROR,
                e.code(), e.message());
            return false;
          } catch (...) {
            generateError(rest::ResponseCode::SERVER_ERROR,
                          TRI_ERROR_HTTP_SERVER_ERROR,
                          "Unable to lock all collections.");
            return false;
          }
          // If we get here we successfully locked the collections.
          // If we bail out up to this point nothing is kept alive.
          // No need to cleanup...
        }

      }

      _queryRegistry->insert(qId, query.get(), ttl, prepared);
      query.release();
      answerBuilder.add(it.key);
      answerBuilder.add(VPackValue(arangodb::basics::StringUtils::itoa(qId)));
    } catch (...) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "could not keep query in registry";
      generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                    "could not keep query in registry");
      return false;
    }
  }
  answerBuilder.close(); // Snippets

  return true;
}

bool RestAqlHandler::registerTraverserEngines(VPackSlice const traverserEngines, bool& needToLock, double ttl, VPackBuilder& answerBuilder) {
  TRI_ASSERT(traverserEngines.isArray());

  TRI_ASSERT(answerBuilder.isOpenObject());
  answerBuilder.add(VPackValue("traverserEngines"));
  answerBuilder.openArray();

  for (auto const& te : VPackArrayIterator(traverserEngines)) {
    try {
      auto id = _traverserRegistry->createNew(_vocbase, te, needToLock, ttl);

      needToLock = false;
      TRI_ASSERT(id != 0);
      answerBuilder.add(VPackValue(id));
    } catch (basics::Exception const& e) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "Failed to instanciate traverser engines. Reason: " << e.message();
      generateError(rest::ResponseCode::SERVER_ERROR, e.code(), e.message());
      return false;
    } catch (...) {
      LOG_TOPIC(ERR, arangodb::Logger::AQL)
          << "Failed to instanciate traverser engines.";
      generateError(rest::ResponseCode::SERVER_ERROR,
                    TRI_ERROR_HTTP_SERVER_ERROR,
                    "Unable to instanciate traverser engines");
      return false;
    }
  }
  answerBuilder.close(); // traverserEngines
  // Everything went well
  return true;
}

// POST method for /_api/aql/instantiate (internal)
// The body is a VelocyPack with attributes "plan" for the execution plan and
// "options" for the options, all exactly as in AQL_EXECUTEJSON.
void RestAqlHandler::createQueryFromVelocyPack() {
  bool success = false;
  VPackSlice querySlice = this->parseVPackBody(success);
  if (!success) {
    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "invalid VelocyPack plan in query";
    return;
  }

  TRI_ASSERT(querySlice.isObject());

  VPackSlice plan = querySlice.get("plan");
  if (plan.isNone()) {
    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "Invalid VelocyPack: \"plan\" attribute missing.";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL,
                  "body must be an object with attribute \"plan\"");
    return;
  }

  auto options = std::make_shared<VPackBuilder>(
      VPackBuilder::clone(querySlice.get("options")));

  std::string const part =
      VelocyPackHelper::getStringValue(querySlice, "part", "");

  auto planBuilder = std::make_shared<VPackBuilder>(VPackBuilder::clone(plan));
  auto query = std::make_unique<Query>(
    false,
    _vocbase,
    planBuilder,
    options,
    (part == "main" ? PART_MAIN : PART_DEPENDENT)
  );

  try {
    query->prepare(_queryRegistry, 0);
  } catch (std::exception const& ex) {
    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "failed to instantiate the query: " << ex.what();
    generateError(rest::ResponseCode::BAD, TRI_ERROR_QUERY_BAD_JSON_PLAN,
                  ex.what());
    return;
  } catch (...) {
    LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "failed to instantiate the query";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_QUERY_BAD_JSON_PLAN, "failed to instantiate the query");
    return;
  }

  // Now the query is ready to go, store it in the registry and return:
  double ttl = QueryInsertTTL;
  bool found;
  std::string const& ttlstring = _request->header("ttl", found);

  if (found) {
    ttl = arangodb::basics::StringUtils::doubleDecimal(ttlstring);
  }

  _qId = TRI_NewTickServer();
  try {
    _queryRegistry->insert(_qId, query.get(), ttl, false);
    query.release();
  } catch (...) {
    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "could not keep query in registry";
    generateError(rest::ResponseCode::BAD, TRI_ERROR_INTERNAL, "could not insert query into registry");
    return;
  }

  VPackBuilder answerBody;
  try {
    VPackObjectBuilder guard(&answerBody);
    answerBody.add("queryId",
                   VPackValue(arangodb::basics::StringUtils::itoa(_qId)));
    answerBody.add("ttl", VPackValue(ttl));
  } catch (arangodb::basics::Exception const& ex) {
    generateError(rest::ResponseCode::BAD, ex.code(), ex.what());
    return;
  } catch (std::exception const& ex) {
    generateError(rest::ResponseCode::BAD, TRI_ERROR_FAILED, ex.what());
    return;
  } catch (...) {
    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_OUT_OF_MEMORY);
    return;
  }

  sendResponse(rest::ResponseCode::ACCEPTED, answerBody.slice());
}

// PUT method for /_api/aql/<operation>/<queryId>, (internal)
// this is using the part of the cursor API with side effects.
// <operation>: can be "lock" or "getSome" or "skip" or "initializeCursor" or
// "shutdown".
// The body must be a Json with the following attributes:
// For the "getSome" operation one has to give:
//   "atMost": must be a positive integer, the cursor returns never
//             more than "atMost" items. The result is the JSON representation
//             of an AqlItemBlock.
//             If "atMost" is not given it defaults to ExecutionBlock::DefaultBatchSize.
// For the "skipSome" operation one has to give:
//   "atMost": must be a positive integer, the cursor skips never
//             more than "atMost" items. The result is a JSON object with a
//             single attribute "skipped" containing the number of
//             skipped items.
//             If "atMost" is not given it defaults to ExecutionBlock::DefaultBatchSize.
// For the "skip" operation one should give:
//   "number": must be a positive integer, the cursor skips as many items,
//             possibly exhausting the cursor.
//             The result is a JSON with the attributes "error" (boolean),
//             "errorMessage" (if applicable) and "exhausted" (boolean)
//             to indicate whether or not the cursor is exhausted.
//             If "number" is not given it defaults to 1.
// For the "initializeCursor" operation, one has to bind the following
// attributes:
//   "items": This is a serialized AqlItemBlock with usually only one row
//            and the correct number of columns.
//   "pos":   The number of the row in "items" to take, usually 0.
// For the "shutdown" and "lock" operations no additional arguments are
// required and an empty JSON object in the body is OK.
// All operations allow to set the HTTP header "Shard-ID:". If this is
// set, then the root block of the stored query must be a ScatterBlock
// and the shard ID is given as an additional argument to the ScatterBlock's
// special API.
void RestAqlHandler::useQuery(std::string const& operation,
                              std::string const& idString) {
  // the PUT verb
  Query* query = nullptr;
  if (findQuery(idString, query)) {
    return;
  }

  TRI_ASSERT(_qId > 0);
  TRI_ASSERT(query->engine() != nullptr);

  bool success = false;
  VPackSlice querySlice = this->parseVPackBody(success);
  if (!success) {
    _queryRegistry->close(&_vocbase, _qId);

    return;
  }

  try {
    handleUseQuery(operation, query, querySlice);

    if (_qId != 0) {
      try {
        _queryRegistry->close(&_vocbase, _qId);
      } catch (...) {
        // ignore errors on unregistering
        // an error might occur if "shutdown" is called
      }
    }
  } catch (arangodb::basics::Exception const& ex) {
    _queryRegistry->close(&_vocbase, _qId);
    generateError(rest::ResponseCode::SERVER_ERROR, ex.code(), ex.what());
  } catch (std::exception const& ex) {
    _queryRegistry->close(&_vocbase, _qId);

    LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "failed during use of Query: "
                                            << ex.what();

    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_HTTP_SERVER_ERROR,
                  ex.what());
  } catch (...) {
    _queryRegistry->close(&_vocbase, _qId);
    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "failed during use of Query: Unknown exception occurred";

    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_HTTP_SERVER_ERROR,
                  "an unknown exception occurred");
  }
}

// GET method for /_api/aql/<operation>/<queryId>, (internal)
// this is using
// the part of the cursor API without side effects. The operation must
// be "hasMore". The result is a Json
// with, depending on the operation, the following attributes:
//   for "hasMore": the result has the attributes "error" (set to false)
//                  and "hasMore" set to a boolean value.
void RestAqlHandler::getInfoQuery(std::string const& operation,
                                  std::string const& idString) {
  bool found;
  std::string const& shardId = _request->header("shard-id", found);

  Query* query = nullptr;
  if (findQuery(idString, query)) {
    return;
  }

  TRI_ASSERT(_qId > 0);

  VPackBuilder answerBody;
  try {
    VPackObjectBuilder guard(&answerBody);

    if (operation == "hasMore") {
      bool hasMore;
      if (shardId.empty()) {
        hasMore = query->engine()->hasMore();
      } else {
        auto block = static_cast<BlockWithClients*>(query->engine()->root());
        if (block->getPlanNode()->getType() != ExecutionNode::SCATTER &&
            block->getPlanNode()->getType() != ExecutionNode::DISTRIBUTE) {
          THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL,
                                         "unexpected node type");
        }
        hasMore = block->hasMoreForShard(shardId);
      }

      answerBody.add("hasMore", VPackValue(hasMore));
    } else {
      _queryRegistry->close(&_vocbase, _qId);
      LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "referenced query not found";
      generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND);
      return;
    }

    answerBody.add("error", VPackValue(false));
  } catch (arangodb::basics::Exception const& ex) {
    _queryRegistry->close(&_vocbase, _qId);
    LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "failed during use of query: " << ex.message();
    generateError(rest::ResponseCode::SERVER_ERROR, ex.code(), ex.what());
  } catch (std::exception const& ex) {
    _queryRegistry->close(&_vocbase, _qId);

    LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "failed during use of query: "
                                            << ex.what();

    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_HTTP_SERVER_ERROR,
                  ex.what());
  } catch (...) {
    _queryRegistry->close(&_vocbase, _qId);

    LOG_TOPIC(ERR, arangodb::Logger::FIXME)
        << "failed during use of query: Unknown exception occurred";

    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_HTTP_SERVER_ERROR,
                  "an unknown exception occurred");
  }

  _queryRegistry->close(&_vocbase, _qId);

  sendResponse(rest::ResponseCode::OK, answerBody.slice(),
               query->trx()->transactionContext().get());
}

// executes the handler
RestStatus RestAqlHandler::execute() {
  // std::cout << "GOT INCOMING REQUEST: " <<
  // GeneralRequest::translateMethod(_request->requestType()) << ",
  // " << arangodb::ServerState::instance()->getId() << ": " <<
  // _request->fullUrl() << ": " << _request->body() << "\n\n";
  std::vector<std::string> const& suffixes = _request->suffixes();

  // extract the sub-request type
  rest::RequestType type = _request->requestType();

  // execute one of the CRUD methods
  switch (type) {
    case rest::RequestType::POST: {
      if (suffixes.size() != 1) {
        generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND);
      } else if (suffixes[0] == "instantiate") {
        createQueryFromVelocyPack();
      } else if (suffixes[0] == "setup") {
        setupClusterQuery();
      } else {
        LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "Unknown API";
        generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND, "Unknown API");
      }
      break;
    }
    case rest::RequestType::PUT: {
      if (suffixes.size() != 2) {
        LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "unknown PUT API";
        generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND, "unknown PUT API");
      } else {
        useQuery(suffixes[0], suffixes[1]);
      }
      break;
    }
    case rest::RequestType::GET: {
      if (suffixes.size() != 2) {
        LOG_TOPIC(ERR, arangodb::Logger::FIXME) << "Unknown GET API";
        generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND, "Unknown GET API");
      } else {
        getInfoQuery(suffixes[0], suffixes[1]);
      }
      break;
    }
    case rest::RequestType::DELETE_REQ:
    case rest::RequestType::HEAD:
    case rest::RequestType::PATCH:
    case rest::RequestType::OPTIONS:
    case rest::RequestType::VSTREAM_CRED:
    case rest::RequestType::VSTREAM_REGISTER:
    case rest::RequestType::VSTREAM_STATUS:
    case rest::RequestType::ILLEGAL: {
      generateError(rest::ResponseCode::METHOD_NOT_ALLOWED,
                    TRI_ERROR_NOT_IMPLEMENTED, "illegal method for /_api/aql");
      break;
    }
  }

  // std::cout << "REQUEST HANDLING DONE: " <<
  // arangodb::ServerState::instance()->getId() << ": " <<
  // _request->fullUrl() << ": " << _response->responseCode() << ",
  // CONTENT-LENGTH: " << _response->contentLength() << "\n";

  return RestStatus::DONE;
}

// dig out the query from ID, handle errors
bool RestAqlHandler::findQuery(std::string const& idString, Query*& query) {
  _qId = arangodb::basics::StringUtils::uint64(idString);
  query = nullptr;

  // sleep for 10ms each time, wait for at most 30 seconds...
  static int64_t const SingleWaitPeriod = 10 * 1000;
  static int64_t const MaxIterations =
      static_cast<int64_t>(30.0 * 1000000.0 / (double)SingleWaitPeriod);

  int64_t iterations = 0;

  // probably need to cycle here until we can get hold of the query
  while (++iterations < MaxIterations) {
    try {
      query = _queryRegistry->open(&_vocbase, _qId);
      // we got the query (or it was not found - at least no one else
      // can now have access to the same query)
      break;
    } catch (...) {
      // we can only get here if the query is currently used by someone
      // else. in this case we sleep for a while and re-try
      std::this_thread::sleep_for(std::chrono::microseconds(SingleWaitPeriod));
    }
  }

  if (query == nullptr) {
    LOG_TOPIC_IF(ERR, Logger::AQL, iterations == MaxIterations) << "Timeout waiting for query " << _qId;
    _qId = 0;
    generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_QUERY_NOT_FOUND);
    return true;
  }

  TRI_ASSERT(_qId > 0);

  return false;
}

// handle for useQuery
void RestAqlHandler::handleUseQuery(std::string const& operation, Query* query,
                                    VPackSlice const querySlice) {
  bool found;
  std::string const& shardId = _request->header("shard-id", found);

  // upon first usage, the "initializeCursor" method must be called
  // note: if the operation is "initializeCursor" itself, we do not initialize
  // the cursor here but let the case for "initializeCursor" process it.
  // this is because the request may contain additional data
  if ((operation == "getSome" || operation == "skipSome") &&
      !query->engine()->initializeCursorCalled()) {
    int res = query->engine()->initializeCursor(nullptr, 0);
    if (res != TRI_ERROR_NO_ERROR) {
      generateError(GeneralResponse::responseCode(res),
                    res, "cannot initialize cursor for AQL query");
      return;
    }
  }

  VPackBuilder answerBuilder;
  auto transactionContext = query->trx()->transactionContext();
  try {
    {
      VPackObjectBuilder guard(&answerBuilder);
      if (operation == "lock") {
        // Mark current thread as potentially blocking:
        int res = TRI_ERROR_INTERNAL;

        {
          JobGuard guard(SchedulerFeature::SCHEDULER);
          guard.block();

          // let exceptions propagate from here
          res = query->trx()->lockCollections();
        }

        answerBuilder.add(StaticStrings::Error, VPackValue(res != TRI_ERROR_NO_ERROR));
        answerBuilder.add(StaticStrings::Code, VPackValue(res));
      } else if (operation == "getSome") {
        auto atMost = VelocyPackHelper::getNumericValue<size_t>(
            querySlice, "atMost", ExecutionBlock::DefaultBatchSize());
        std::unique_ptr<AqlItemBlock> items;
        if (shardId.empty()) {
          items.reset(query->engine()->getSome(atMost));
        } else {
          auto block = static_cast<BlockWithClients*>(query->engine()->root());
          if (block->getPlanNode()->getType() != ExecutionNode::SCATTER &&
              block->getPlanNode()->getType() != ExecutionNode::DISTRIBUTE) {
            THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL,
                                           "unexpected node type");
          }
          items.reset(block->getSomeForShard(atMost, shardId));
        }
        if (items.get() == nullptr) {
          answerBuilder.add("exhausted", VPackValue(true));
          answerBuilder.add("error", VPackValue(false));
        } else {
          items->toVelocyPack(query->trx(), answerBuilder);
        }
      } else if (operation == "skipSome") {
        auto atMost = VelocyPackHelper::getNumericValue<size_t>(
            querySlice, "atMost", ExecutionBlock::DefaultBatchSize());
        size_t skipped;
        if (shardId.empty()) {
          skipped = query->engine()->skipSome(atMost);
        } else {
          auto block =
              static_cast<BlockWithClients*>(query->engine()->root());
          if (block->getPlanNode()->getType() != ExecutionNode::SCATTER &&
              block->getPlanNode()->getType() != ExecutionNode::DISTRIBUTE) {
            THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL,
                                            "unexpected node type");
          }
          skipped = block->skipSomeForShard(atMost, shardId);
        }
        answerBuilder.add("skipped", VPackValue(skipped));
        answerBuilder.add("error", VPackValue(false));
      } else if (operation == "initialize") {
        // this is a no-op now
        answerBuilder.add(StaticStrings::Error, VPackValue(false));
        answerBuilder.add(StaticStrings::Code, VPackValue(TRI_ERROR_NO_ERROR));
      } else if (operation == "initializeCursor") {
        auto pos =
            VelocyPackHelper::getNumericValue<size_t>(querySlice, "pos", 0);
        std::unique_ptr<AqlItemBlock> items;
        int res;
        if (VelocyPackHelper::getBooleanValue(querySlice, "exhausted", true)) {
          res = query->engine()->initializeCursor(nullptr, 0);
        } else {
          items.reset(new AqlItemBlock(query->resourceMonitor(),
                                       querySlice.get("items")));
          res = query->engine()->initializeCursor(items.get(), pos);
        }
        answerBuilder.add(StaticStrings::Error, VPackValue(res != TRI_ERROR_NO_ERROR));
        answerBuilder.add(StaticStrings::Code, VPackValue(res));
      } else if (operation == "shutdown") {
        int errorCode = VelocyPackHelper::getNumericValue<int>(
            querySlice, "code", TRI_ERROR_INTERNAL);
        int res = query->engine()->shutdown(errorCode);  // pass errorCode to shutdown

        // return statistics
        answerBuilder.add(VPackValue("stats"));
        query->getStats(answerBuilder);

        // return warnings if present
        query->addWarningsToVelocyPack(answerBuilder);

        // return the query to the registry
        _queryRegistry->close(&_vocbase, _qId);

        // delete the query from the registry
        _queryRegistry->destroy(&_vocbase, _qId, errorCode);
        _qId = 0;
        answerBuilder.add(StaticStrings::Error, VPackValue(res != TRI_ERROR_NO_ERROR));
        answerBuilder.add(StaticStrings::Code, VPackValue(res));
      } else {
        generateError(rest::ResponseCode::NOT_FOUND, TRI_ERROR_HTTP_NOT_FOUND);
        return;
      }
    }

    sendResponse(rest::ResponseCode::OK, answerBuilder.slice(), transactionContext.get());
  } catch (arangodb::basics::Exception const& ex) {
    generateError(GeneralResponse::responseCode(ex.code()), ex.code(), ex.message());
  } catch (std::exception const& ex) {
    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_INTERNAL, ex.what());
  } catch (...) {
    generateError(rest::ResponseCode::SERVER_ERROR, TRI_ERROR_INTERNAL, "unknown exception caught in handleUsequery");
  }
}

// extract the VelocyPack from the request
std::shared_ptr<VPackBuilder> RestAqlHandler::parseVelocyPackBody() {
  try {
    std::shared_ptr<VPackBuilder> body = _request->toVelocyPackBuilderPtr();
    if (body == nullptr) {
      generateError(rest::ResponseCode::BAD,
                    TRI_ERROR_HTTP_CORRUPTED_JSON, "cannot parse json object");
      return nullptr;
    }
    VPackSlice tmp = body->slice();
    if (!tmp.isObject()) {
      // Validate the input has correct format.
      LOG_TOPIC(ERR, arangodb::Logger::FIXME)
          << "body of request must be a VelocyPack object";
      generateError(rest::ResponseCode::BAD, TRI_ERROR_HTTP_BAD_PARAMETER,
                    "body of request must be a VelcoyPack object");
      return nullptr;
    }
    return body;
  } catch (...) {
    generateError(rest::ResponseCode::BAD, TRI_ERROR_HTTP_CORRUPTED_JSON,
                  "cannot parse json object");
  }
  return nullptr;
}

// Send slice as result with the given response type.
void RestAqlHandler::sendResponse(rest::ResponseCode code,
                                  VPackSlice const slice,
                                  transaction::Context* transactionContext) {
  resetResponse(code);
  writeResult(slice, *(transactionContext->getVPackOptionsForDump()));
}
// Send slice as result with the given response type.
void RestAqlHandler::sendResponse(
    rest::ResponseCode code, VPackSlice const slice) {
  resetResponse(code);
  VPackOptions options = VPackOptions::Defaults;
  options.escapeUnicode = true;
  writeResult(slice, options);
}