App.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2021 Anselm Schmidt (ans[ät]ohai.su)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version in addition to the terms of any
 *  licences already herein identified.
 *
 *  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, see <https://www.gnu.org/licenses/>.
 *
 * ---
 *
 * App.hpp
 *
 * The main application class that processes command line arguments, shows the initial header, loads the
 *  configuration from the argument-specified configuration file and creates as well as starts the server.
 *
 *  Created on: Oct 26, 2018
 *      Author: ans
 */

#ifndef MAIN_APP_HPP_
#define MAIN_APP_HPP_

#include "ConfigFile.hpp"
#include "Exception.hpp"
#include "Server.hpp"
#include "SignalHandler.hpp"
#include "Version.hpp"

#include "../Helper/DateTime.hpp"
#include "../Helper/Portability/compiler.h"
#include "../Helper/Portability/getch.h"
#include "../Helper/Versions.hpp"
#include "../Struct/DatabaseSettings.hpp"
#include "../Struct/NetworkSettings.hpp"
#include "../Struct/ServerSettings.hpp"

#include <atomic>       // std::atomic
#include <csignal>      // SIGINT, SIGTERM, std::sig_atomic_t
#include <exception>    // std::exception
#include <iostream>     // std::cout, std::endl, std::flush
#include <memory>       // std::make_unique, std::unique_ptr
#include <string>       // std::string
#include <string_view>  // std::string_view_literals
#include <vector>       // std::vector

namespace crawlservpp::Main {

    using std::string_view_literals::operator""sv;

    /*
     * CONSTANTS
     */


    inline constexpr auto argsRequired{2};

    inline constexpr auto pwPrompt1{"Enter password for "sv};

    inline constexpr auto pwPrompt2{"@"sv};

    inline constexpr auto pwPrompt3{":"sv};

    inline constexpr auto pwPrompt4{": "sv};

    inline constexpr auto doneMsg{"[DONE]"sv};

    inline constexpr auto inputBackspace{127};

    inline constexpr auto inputEof{-1};

    inline constexpr auto inputEtx{3};

    inline constexpr auto inputEsc{27};

    //NOLINTNEXTLINE(clang-diagnostic-string-plus-int, cppcoreguidelines-pro-bounds-pointer-arithmetic)
    inline constexpr auto year{__DATE__ + 7};

    inline constexpr auto descName{"crawlserv++ Command-and-Control Server"sv};

    inline constexpr auto descVer{"Version "sv};

    inline constexpr auto descCopyrightHead{"Copyright (C) "sv};

    inline constexpr auto descCopyrightTail{" Anselm Schmidt (ans[ät]ohai.su)"sv};

    inline constexpr auto descLicense{
        "This program is free software: you can redistribute it and/or modify\n"
        "it under the terms of the GNU General Public License as published by\n"
        "the Free Software Foundation, either version 3 of the License, or\n"
        "(at your option) any later version.\n\n"
        "This program is distributed in the hope that it will be useful,\n"
        "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
        "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
        "GNU General Public License for more details.\n\n"
        "You should have received a copy of the GNU General Public License\n"
        "along with this program. If not, see <https://www.gnu.org/licenses/>."sv
    };

    inline constexpr auto descUsing{"using"sv};

    inline constexpr auto descUsage{"USAGE: crawlserv <config_file> or crawlserv -v"};


    /*
     * DECLARATION
     */


    class App final : SignalHandler {
        // for convenience
        using DatabaseSettings = Struct::DatabaseSettings;
        using NetworkSettings = Struct::NetworkSettings;
        using ServerSettings = Struct::ServerSettings;

    public:

        explicit App(const std::vector<std::string>& args) noexcept;
        virtual ~App();


        int run() noexcept;



        App(App&) = delete;

        App& operator=(App&) = delete;

        App(App&&) = delete;

        App& operator=(App&&) = delete;


    private:
        std::atomic<bool> running{true};
        std::unique_ptr<Server> server;
        bool showVersionsOnly{false};

        // signal handling
        void shutdown(std::sig_atomic_t signal);

        // helper functions
        bool getPassword(DatabaseSettings& dbSettings);
        bool inputLoop(DatabaseSettings& dbSettings, bool& isCancelTo);

        // static helper functions
        static void outputHeader(bool showLibraryVersions);
        static void checkArgumentNumber(int args);
        static void loadConfig(
                const std::string& fileName,
                ServerSettings& serverSettings,
                DatabaseSettings& dbSettings,
                NetworkSettings& networkSettings
        );
    };

} /* namespace crawlservpp::Main */

#endif /* MAIN_APP_HPP_ */