web_user_interaction.hpp

/*********************************************************************/
// webdar - a web server and interface program to libdar
// Copyright (C) 2013-2025 Denis Corbin
//
// This file is part of Webdar
//
//  Webdar 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.
//
//  Webdar 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 Webdar.  If not, see <http://www.gnu.org/licenses/>
//
//----
//  to contact the author: dar.linux@free.fr
/*********************************************************************/
 
#ifndef WEB_USER_INTERACTION_HPP
#define WEB_USER_INTERACTION_HPP
 
    // C system header files
#include "my_config.h"
extern "C"
{
 
}
 
    // C++ system header files
#include <string>
#include <list>
#include <dar/libdar.hpp>
#include <libthreadar/libthreadar.hpp>
 
    // webdar headers
 
 
 
 
 
class web_user_interaction : public libdar::user_interaction
{
public:
    web_user_interaction(unsigned int x_warn_size = 10); 
    web_user_interaction(const web_user_interaction & ref) = delete;
    web_user_interaction(web_user_interaction && ref) noexcept = delete;
    web_user_interaction & operator = (const web_user_interaction & ref) = delete;
    web_user_interaction & operator = (web_user_interaction && ref) noexcept = delete;
    ~web_user_interaction();
 
    void set_warning_list_size(unsigned int size);
 
    void clear();
 
    std::list<std::string> get_warnings();
 
    bool pending_pause(std::string & msg) const;
 
    bool pending_get_string(std::string & msg, bool & echo) const;
 
    bool pending_get_secu_string(std::string & msg, bool & echo) const;
 
    void set_pause_answer(bool val);
 
    void set_get_string_answer(const std::string & val);
 
    void set_get_secu_string_answer(const libdar::secu_string & val);
 
    bool has_libdar_pending() const;
 
protected:
 
    // inherited from libdar::user_interaction
 
    virtual void inherited_message(const std::string & message) override;
    virtual bool inherited_pause(const std::string & message) override;
    virtual std::string inherited_get_string(const std::string & message, bool echo) override;
    virtual libdar::secu_string inherited_get_secu_string(const std::string & message, bool echo) override;
 
private:
    mutable libthreadar::condition control; 
 
    // pause() fields
    bool pause_pending;    
    bool pause_answered;   
    std::string pause_msg; 
    bool pause_ans;        
 
 
    // get_string() fields
    bool get_string_pending;    
    bool get_string_answered;   
    std::string get_string_msg; 
    bool get_string_echo;       
    std::string get_string_ans; 
 
    // get_secu_string() fields
    bool get_secu_string_pending;    
    bool get_secu_string_answered;   
    std::string get_secu_string_msg; 
    bool get_secu_string_echo;       
    libdar::secu_string get_secu_string_ans; 
 
    // libdar warnings (= logs)
    std::list<std::string> warnings;  
    unsigned warn_size;               
};
 
#endif