StaticMiddleware.h

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#ifndef EXPRESS_MIDDLEWARE_STATICMIDDLEWARE_H
#define EXPRESS_MIDDLEWARE_STATICMIDDLEWARE_H
 
#include "express/Router.h"           // IWYU pragma: export
#include "web/http/ConnectionState.h" // IWYU pragma: export
#include "web/http/CookieOptions.h"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include <map>
#include <string>
#include <utility>
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
namespace express::middleware {
 
    class StaticMiddleware : public Router {
    public:
        StaticMiddleware(const StaticMiddleware&) = delete;
 
        StaticMiddleware& operator=(const StaticMiddleware&) = delete;
 
    protected:
        explicit StaticMiddleware(const std::string& root);
        static class StaticMiddleware& instance(const std::string& root);
 
    public:
        StaticMiddleware& setIndex(const std::string& index);
        StaticMiddleware& clearStdHeaders();
        StaticMiddleware& setStdHeaders(const std::map<std::string, std::string>& stdHeaders);
        StaticMiddleware& appendStdHeaders(const std::map<std::string, std::string>& stdHeaders);
        StaticMiddleware& appendStdHeaders(const std::string& field, const std::string& value);
        StaticMiddleware&
        appendStdCookie(const std::string& name, const std::string& value, const std::map<std::string, std::string>& options = {});
        StaticMiddleware& afterResponse(web::http::ConnectionState connectionState);
 
    private:
        std::string root;
        std::string index;
        std::map<std::string, std::string> stdHeaders = {{"Cache-Control", "public, max-age=0"}, {"Accept-Ranges", "bytes"}};
        std::map<std::string, web::http::CookieOptions> stdCookies;
        web::http::ConnectionState defaultConnectionState = web::http::ConnectionState::Default;
 
        friend class StaticMiddleware& StaticMiddleware(const std::string& root);
    };
 
    class StaticMiddleware& StaticMiddleware(const std::string& root);
 
} // namespace express::middleware
 
#endif // EXPRESS_MIDDLEWARE_STATICMIDDLEWARE_H