http_request_router.h

Go to the documentation of this file.

/*
  Copyright (c) 2021, 2025, Oracle and/or its affiliates.
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
  as published by the Free Software Foundation.
 
  This program is designed to work with certain software (including
  but not limited to OpenSSL) that is licensed under separate terms,
  as designated in a particular file or component or in included license
  documentation.  The authors of MySQL hereby grant you an additional
  permission to link the program and your derivative works with the
  separately licensed software that they have either included with
  the program or referenced in the documentation.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#ifndef ROUTER_SRC_HTTP_SRC_HTTP_REQUEST_ROUTER_H_
#define ROUTER_SRC_HTTP_SRC_HTTP_REQUEST_ROUTER_H_
 
#include <unicode/regex.h>
 
#include <map>
#include <memory>
#include <shared_mutex>
#include <string>
#include <vector>
 
#include "http/base/request.h"
#include "http/base/request_handler.h"
#include "http/server/request_handler_interface.h"
#include "mysql/harness/stdx/expected.h"
#include "mysqlrouter/http_server_lib_export.h"
 
class HTTP_SERVER_LIB_EXPORT HttpRequestRouter
    : public http::server::RequestHandlerInterface {
 public:
  using RequestHandler = http::base::RequestHandler;
  using BaseRequestHandlerPtr = std::shared_ptr<http::base::RequestHandler>;
 
  void append(const std::string &url_host,
              const std::string &url_regex_str,
              std::unique_ptr<RequestHandler> cb);
  void remove(const void *handler_id);
  void remove(const std::string &url_host, const std::string &url_regex_str);
 
  void set_default_route(std::unique_ptr<RequestHandler> cb);
  void clear_default_route();
  void route(http::base::Request &req) override;
 
  void require_realm(const std::string &realm) { require_realm_ = realm; }
 
 private:
  class RouteMatcher {
   public:
    RouteMatcher(std::string url_pattern, BaseRequestHandlerPtr handler)
        : url_pattern_(std::move(url_pattern)), handler_(std::move(handler)) {}
 
    stdx::expected<void, UErrorCode> compile();
 
    stdx::expected<void, UErrorCode> matches(std::string_view input) const;
 
    stdx::expected<void, UErrorCode> matches(
        const icu::UnicodeString &input) const;
 
    BaseRequestHandlerPtr handler() const { return handler_; }
 
    const std::string &url_pattern() const { return url_pattern_; }
 
   private:
    std::string url_pattern_;
    BaseRequestHandlerPtr handler_;
 
    std::unique_ptr<icu::RegexPattern> regex_pattern_;
  };
 
  // if no routes are specified, return 404
  void handler_not_found(http::base::Request &req);
 
  BaseRequestHandlerPtr find_route_handler(std::string_view url_host,
                                           std::string_view path);
 
  std::map<std::string, std::vector<RouteMatcher>, std::less<>>
      request_handlers_;
 
  BaseRequestHandlerPtr default_route_;
  std::string require_realm_;
 
  std::shared_mutex route_mtx_;
};
 
#endif  // ROUTER_SRC_HTTP_SRC_HTTP_REQUEST_ROUTER_H_