arangodb/arangod/GeneralServer/RestHandlerFactory.cpp

////////////////////////////////////////////////////////////////////////////////
/// 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 Dr. Frank Celler
////////////////////////////////////////////////////////////////////////////////

#include "RestHandlerFactory.h"
#include "Cluster/ServerState.h"
#include "Logger/Logger.h"
#include "Replication/GlobalReplicationApplier.h"
#include "Replication/ReplicationFeature.h"
#include "Rest/GeneralRequest.h"
#include "RestHandler/RestBaseHandler.h"
#include "RestHandler/RestDocumentHandler.h"

using namespace arangodb;
using namespace arangodb::basics;
using namespace arangodb::rest;

static std::string const ROOT_PATH = "/";

namespace {
class MaintenanceHandler : public RestBaseHandler {
  ServerState::Mode _mode;

 public:
  MaintenanceHandler(GeneralRequest* request, GeneralResponse* response, ServerState::Mode mode)
      : RestBaseHandler(request, response), _mode(mode) {}

  char const* name() const override final { return "MaintenanceHandler"; }

  bool isDirect() const override { return true; };

  // returns the queue name, should trigger processing without job
  size_t queue() const override { return JobQueue::AQL_QUEUE; }

  RestStatus execute() override {
    ReplicationFeature::prepareFollowerResponse(_response.get(), _mode);
    return RestStatus::DONE;
  }

  void handleError(const Exception& error) override {
    resetResponse(rest::ResponseCode::SERVICE_UNAVAILABLE);
  }
};
}  // namespace

////////////////////////////////////////////////////////////////////////////////
/// @brief creates a new handler
////////////////////////////////////////////////////////////////////////////////

RestHandler* RestHandlerFactory::createHandler(std::unique_ptr<GeneralRequest> req,
                                               std::unique_ptr<GeneralResponse> res) const {
  std::string const& path = req->requestPath();

  // In the shutdown phase we simply return 503:
  if (application_features::ApplicationServer::isStopping()) {
    return new MaintenanceHandler(req.release(), res.release(), ServerState::Mode::INVALID);
  }

  // In the bootstrap phase, we would like that coordinators answer the
  // following endpoints, but not yet others:
  ServerState::Mode mode = ServerState::serverMode();
  switch (mode) {
    case ServerState::Mode::MAINTENANCE: {
      if ((!ServerState::instance()->isCoordinator() &&
           path.find("/_api/agency/agency-callbacks") == std::string::npos) ||
          (path.find("/_api/agency/agency-callbacks") == std::string::npos &&
           path.find("/_api/aql") == std::string::npos)) {
        LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
            << "Maintenance mode: refused path: " << path;
        return new MaintenanceHandler(req.release(), res.release(), mode);
      }
      break;
    }
    case ServerState::Mode::REDIRECT:
    case ServerState::Mode::TRYAGAIN: {
      if (path.find("/_admin/shutdown") == std::string::npos &&
          path.find("/_admin/cluster/health") == std::string::npos &&
          path.find("/_admin/server/role") == std::string::npos &&
          path.find("/_admin/status") == std::string::npos &&
          path.find("/_admin/statistics") == std::string::npos &&
          path.find("/_admin/log") == std::string::npos &&
          path.find("/_admin/server/availability") == std::string::npos &&
          path.find("/_api/agency/agency-callbacks") == std::string::npos &&
          path.find("/_api/cluster/") == std::string::npos &&
          path.find("/_api/replication") == std::string::npos &&
          path.find("/_api/version") == std::string::npos &&
          path.find("/_api/wal") == std::string::npos) {
        LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
            << "Maintenance mode: refused path: " << path;
        return new MaintenanceHandler(req.release(), res.release(), mode);
      }
      break;
    }
    case ServerState::Mode::DEFAULT:
    case ServerState::Mode::READ_ONLY:
    case ServerState::Mode::INVALID:
      // no special handling required
      break;
  }

  auto const& ii = _constructors;
  std::string const* modifiedPath = &path;
  std::string prefix;

  auto i = ii.find(path);

  // no direct match, check prefix matches
  if (i == ii.end()) {
    LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
        << "no direct handler found, trying prefixes";

    // find longest match
    size_t const pathLength = path.size();
    // prefixes are sorted by length descending,
    for (auto const& p : _prefixes) {
      size_t const pSize = p.size();
      if (path.compare(0, pSize, p) == 0) {
        if (pSize < pathLength && path[pSize] == '/') {
          prefix = p;
          break;  // first match is longest match
        }
      }
    }

    if (prefix.empty()) {
      LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
          << "no prefix handler found, trying catch all";

      i = ii.find(ROOT_PATH);
      if (i != ii.end()) {
        LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
            << "found catch all handler '/'";

        size_t l = 1;
        size_t n = path.find_first_of('/', l);

        while (n != std::string::npos) {
          req->addSuffix(path.substr(l, n - l));
          l = n + 1;
          n = path.find_first_of('/', l);
        }

        if (l < path.size()) {
          req->addSuffix(path.substr(l));
        }

        modifiedPath = &ROOT_PATH;
        req->setPrefix(ROOT_PATH);
      }
    }

    else {
      LOG_TOPIC(TRACE, arangodb::Logger::FIXME) << "found prefix match '" << prefix << "'";

      size_t l = prefix.size() + 1;
      size_t n = path.find_first_of('/', l);

      while (n != std::string::npos) {
        req->addSuffix(path.substr(l, n - l));
        l = n + 1;
        n = path.find_first_of('/', l);
      }

      if (l < path.size()) {
        req->addSuffix(path.substr(l));
      }

      modifiedPath = &prefix;

      i = ii.find(prefix);
      req->setPrefix(prefix);
    }
  }

  // no match
  if (i == ii.end()) {
    if (_notFound != nullptr) {
      return _notFound(req.release(), res.release(), nullptr);
    }

    LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
        << "no not-found handler, giving up";
    return nullptr;
  }

  LOG_TOPIC(TRACE, arangodb::Logger::FIXME)
      << "found handler for path '" << *modifiedPath << "'";
  return i->second.first(req.release(), res.release(), i->second.second);
}

////////////////////////////////////////////////////////////////////////////////
/// @brief adds a path and constructor to the factory
////////////////////////////////////////////////////////////////////////////////

void RestHandlerFactory::addHandler(std::string const& path, create_fptr func, void* data) {
  _constructors[path] = std::make_pair(func, data);
}

////////////////////////////////////////////////////////////////////////////////
/// @brief adds a prefix path and constructor to the factory
////////////////////////////////////////////////////////////////////////////////

void RestHandlerFactory::addPrefixHandler(std::string const& path,
                                          create_fptr func, void* data) {
  _constructors[path] = std::make_pair(func, data);
  _prefixes.emplace_back(path);
  std::sort(_prefixes.begin(), _prefixes.end(),
            [](std::string const& a, std::string const& b) {
              return a.size() > b.size();
            });
}

////////////////////////////////////////////////////////////////////////////////
/// @brief adds a path and constructor to the factory
////////////////////////////////////////////////////////////////////////////////

void RestHandlerFactory::addNotFoundHandler(create_fptr func) {
  _notFound = func;
}