LocationConf.hpp

Go to the documentation of this file.

/**
 * @file LocationConf.hpp
 * @brief Stores per-route configuration directives.
 * This class encapsulates the configuration for a specific location block
 * parsed from the webserv.conf file.
 */
 
#pragma once
 
#include <string>
#include <map>
#include "AllowedMethods.hpp"
 
class LocationConf
{
    public:
        // Canonical Form
        LocationConf();
        LocationConf(const LocationConf& other);
        LocationConf& operator=(const LocationConf& other);
        ~LocationConf();
 
        // Getters
 
        const std::string&      getPath() const;
        const std::string&      getRoot() const;
        const AllowedMethods&   getAllowedMethods() const;
        const std::string&      getReturnURL() const;
        const std::string&      getReturnCode() const;
        bool                    getAutoIndex() const;
        const std::string&      getDefaultPage() const;
        const std::string&      getStorageLocation() const;
        std::string             getCgiInterpreter(const std::string& ext) const;
 
        //  Setters
 
        void setPath(const std::string& path);
        void setRoot(const std::string& root);
        void addAllowedMethod(HTTPMethod method);
        void setReturnURL(const std::string& url);
        void setReturnCode(const std::string& code);
        void setAutoIndex(bool autoIndex);
        void setDefaultPage(const std::string& defaultPage);
        void setStorageLocation(const std::string& storageLocation);
        void addCgiInterpreter(const std::string& ext, const std::string& interpreterPath);
 
        // Utility
 
        /**
         * @brief Checks if a specific HTTP method is permitted in this location.
         * @param method The method to check (e.g., GET, POST).
         * @return true if allowed, false otherwise.
         */
        bool isMethodAllowed(HTTPMethod method) const;
 
        /**
         * @brief Checks if a given file extension should be handled by CGI.
         * @param ext The extension including the dot (e.g., ".py").
         * @return true if this extension is configured as a CGI extension.
         */
        bool isCgiExtension(const std::string& ext) const;
 
    private:
        //  Identity
        std::string _path;
        //  Data
        std::string      _root;             // Directory where the requested file should be located
        AllowedMethods  _allowedMethods;    // Bitmap wrapper of accepted HTTP methods
        std::string      _returnURL;        // Target URL for HTTP redirection
        std::string      _returnCode;       // HTTP status code for redirection (e.g., "301")
        bool            _autoIndex;         // Directory listing flag
        std::string      _defaultPage;      // Default file to serve (e.g., "index.html")
        std::string      _storageLocation;  // Directory where uploaded files are saved
        std::map<std::string, std::string>  _cgiInterpreters;   // Extension -> interpreter path (e.g., ".py" -> "/usr/bin/python3")
};