html_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 HTML_WEB_USER_INTERACTION_HPP
#define HTML_WEB_USER_INTERACTION_HPP
 
    // C system header files
#include "my_config.h"
extern "C"
{
 
}
 
    // C++ system header files
#include <libthreadar/libthreadar.hpp>
#include <memory>
#include <list>
 
    // webdar headers
#include "body_builder.hpp"
#include "events.hpp"
#include "actor.hpp"
#include "html_form_input.hpp"
#include "html_form.hpp"
#include "html_form_radio.hpp"
#include "html_form_fieldset.hpp"
#include "html_text.hpp"
#include "html_button.hpp"
#include "html_statistics.hpp"
#include "web_user_interaction.hpp"
 
 
 
 
 
class html_web_user_interaction: public body_builder, public actor, public events
{
public:
        // this class generates the following events:
    static const std::string display_started;     
    static const std::string can_refresh;         
    static const std::string dont_refresh;        
    static const std::string libdar_has_finished; 
 
    // class constructor assignment ops and destructors
    html_web_user_interaction(unsigned int x_warn_size = 25);
    html_web_user_interaction(const html_web_user_interaction & ref) = delete;
    html_web_user_interaction(html_web_user_interaction && ref) noexcept = delete;
    html_web_user_interaction & operator = (const html_web_user_interaction & ref) = delete;
    html_web_user_interaction & operator = (html_web_user_interaction && ref) noexcept = delete;
    ~html_web_user_interaction();
 
    void set_warning_list_size(unsigned int size) { check_libdata(); lib_data->set_warning_list_size(size); };
 
    virtual void on_event(const std::string & event_name) override;
 
 
    void auto_hide(bool mode, bool unless_interrupted) { autohide = mode; hide_unless_interrupted = unless_interrupted; };
 
 
    void clear();
 
    std::shared_ptr<web_user_interaction> get_user_interaction() { check_libdata(); return lib_data; };
 
    html_statistics & get_statistics() { stats.set_visible(true); return stats; };
 
 
    void hide_statistics() { stats.set_visible(false); };
 
 
    void run_and_control_thread(libthreadar::thread* arg);
 
 
    void join_controlled_thread();
 
    bool is_libdar_running() const;
 
    bool has_libdar_been_aborted() const { return was_interrupted; };
 
 
protected:
    virtual std::string inherited_get_body_part(const chemin & path,
                        const request & req) override;
    // inherited from body_builder
    virtual void new_css_library_available() override;
 
    // inherited from body_builder
    virtual void my_visibility_has_changed() override;
 
 
private:
    static const std::string class_button;
    static const std::string class_web;
    static const std::string class_inter;
 
    // internal event names (assigned to control buttons and on which we registered)
    static const std::string ask_end_libdar;      
    static const std::string force_end_libdar;    
    static const std::string close_libdar_screen; 
 
    enum mode_type
    {
    normal,        
    end_asked,     
    end_forced,    
    finished,      
    closed         
    };
 
 
    // fields for exchange with libdar thread
    std::shared_ptr<web_user_interaction> lib_data;
 
    // current display mode
    mode_type mode;               
    bool autohide;                
    bool hide_unless_interrupted; 
    bool was_interrupted;         
 
    bool ignore_event;      
 
    libthreadar::thread* managed_thread; // the thread object we manage (or nullptr if none is managed)
    mutable libthreadar::condition all_threads_pending;
 
    // body_builder fields
    html_form_radio h_pause;      
    html_form_fieldset h_inter;   
    html_text h_inter_text;       
    html_form_fieldset h_gtstr_fs;
    html_form_input h_get_string; 
    html_form h_form;             
    html_text h_warnings;         
    html_form_fieldset h_logs;    
    html_form_fieldset h_global;  
 
    html_statistics stats;        
    html_button ask_close;        
    html_button force_close;      
    html_text helper_text;        
    html_button finish;           
 
    void adjust_visibility();
    void check_libdata() { if(!lib_data) throw WEBDAR_BUG; };
    void set_mode(mode_type m);
    void update_html_from_libdar_status();
    void update_controlled_thread_status(); 
    void clean_threads_termination(bool force); 
    void trigger_refresh();                 
    void check_clean_status();              
};
 
 
#endif