Webdar 1.0.0
Web user interface to libdar
html_options_repair.hpp
1/*********************************************************************/
2// webdar - a web server and interface program to libdar
3// Copyright (C) 2013-2025 Denis Corbin
4//
5// This file is part of Webdar
6//
7// Webdar is free software: you can redistribute it and/or modify
8// it under the terms of the GNU General Public License as published by
9// the Free Software Foundation, either version 3 of the License, or
10// (at your option) any later version.
11//
12// Webdar is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15// GNU General Public License for more details.
16//
17// You should have received a copy of the GNU General Public License
18// along with Webdar. If not, see <http://www.gnu.org/licenses/>
19//
20//----
21// to contact the author: dar.linux@free.fr
22/*********************************************************************/
23
24#ifndef HTML_OPTIONS_REPAIR_HPP
25#define HTML_OPTIONS_REPAIR_HPP
26
27 // C system header files
28#include "my_config.h"
29extern "C"
30{
31
32}
33
34 // C++ system header files
35#include <dar/libdar.hpp>
36#include <memory>
37
38 // webdar headers
39#include "body_builder.hpp"
40#include "actor.hpp"
41#include "events.hpp"
42#include "html_form_input.hpp"
43#include "html_form_fieldset.hpp"
44#include "html_form.hpp"
45#include "html_hash_algo.hpp"
46#include "html_derouleur.hpp"
47#include "html_entrepot_landing.hpp"
48#include "html_web_user_interaction.hpp"
49#include "html_form_input_unit.hpp"
50#include "html_slicing.hpp"
51#include "html_ciphering.hpp"
52#include "guichet.hpp"
53#include "jsoner.hpp"
54#include "bibliotheque_subconfig.hpp"
55
57
59 public actor,
60 public events,
61 public jsoner,
63{
64public:
65 static const std::string landing_path_changed;
66 static const std::string entrepot_changed;
67 static const std::string changed;
68
70 html_options_repair(const html_options_repair & ref) = delete;
71 html_options_repair(html_options_repair && ref) noexcept = delete;
72 html_options_repair & operator = (const html_options_repair & ref) = delete;
73 html_options_repair & operator = (html_options_repair && ref) noexcept = delete;
74 ~html_options_repair() = default;
75
77 void set_biblio(const std::shared_ptr<bibliotheque> & ptr);
78
80 virtual void load_json(const json & source) override;
81
83 virtual json save_json() const override;
84
86 virtual void clear_json() override;
87
89 virtual bibliotheque::using_set get_using_set() const override;
90
92 virtual void on_event(const std::string & event_name) override;
93
95 libdar::archive_options_repair get_options(std::shared_ptr<html_web_user_interaction> & webui) const;
96
98 std::shared_ptr<libdar::entrepot> get_entrepot(std::shared_ptr<html_web_user_interaction> webui) const { return entrep->get_entrepot(webui); };
99
101 const std::string & get_landing_path() const { return entrep->get_landing_path(); };
102
105
106protected:
107
109 virtual std::string inherited_get_body_part(const chemin & path,
110 const request & req) override;
111
113 virtual void new_css_library_available() override;
114
115private:
116 bool ignore_events;
117
118 html_derouleur deroule;
119
120 // entrepot
121
122 guichet guichet_entrep;
123 std::shared_ptr<html_entrepot_landing> entrep;
124
125
126 // display settings
127
128 html_form_input info_details;
129 html_form_input display_treated;
130 html_form_input display_only_dir;
131 html_form_input display_skipped;
132 html_form_input display_dirstats;
133 html_form_fieldset display_fs;
134 html_form display_form;
135
136 // processing
137
138 html_form_input allow_over;
139 html_form_input warn_over;
140 html_form_input pause;
141 html_form_input execute;
142 html_form_input dry_run;
143 html_form_input multi_thread_compress;
144 html_hash_algo hash_algo;
145 html_form_fieldset processing_fs;
146 html_form processing_form;
147
148 // target
149
150 html_form_input user_comment;
151 html_form_fieldset target_fs;
152 html_form target_form;
153
154 // slicing
155
156 guichet guichet_slicing;
157 std::shared_ptr<html_slicing> slicing;
158
159 // crypto
160
161 guichet guichet_ciphering;
162 std::shared_ptr<html_ciphering> ciphering;
163
164 void init();
165 void trigger_changed();
166
167 static constexpr const unsigned int format_version = 1;
168 static constexpr const char* myclass_id = "html_options_repair";
169
170 static constexpr const char* jlabel_entrep = "entrepot";
171 static constexpr const char* jlabel_info_details = "info-details";
172 static constexpr const char* jlabel_display_treated = "display-treated";
173 static constexpr const char* jlabel_display_only_dir = "display-only-dirs";
174 static constexpr const char* jlabel_display_skipped = "display-skipped";
175 static constexpr const char* jlabel_display_dirstats = "display-dirstats";
176 static constexpr const char* jlabel_allow_over = "allow-over";
177 static constexpr const char* jlabel_warn_over = "warn-over";
178 static constexpr const char* jlabel_pause = "pause";
179 static constexpr const char* jlabel_execute = "execute";
180 static constexpr const char* jlabel_dry_run = "dry-run";
181 static constexpr const char* jlabel_multi_thread_compress = "compress-threads";
182 static constexpr const char* jlabel_hash_algo = "hash-algo";
183 static constexpr const char* jlabel_user_comment = "user-comment";
184 static constexpr const char* jlabel_slicing = "slicing";
185 static constexpr const char* jlabel_ciphering = "ciphering";
186
187};
188
189#endif
class of object that are pointed/triggered to by others
Definition: actor.hpp:55
class bibliotheque_subconfig is an interface (pure virtual class)
Definition: bibliotheque_subconfig.hpp:50
std::set< coordinates > using_set
list of configs a given config depends on
Definition: bibliotheque.hpp:117
class body_builder is the root class of object generating HTML body
Definition: body_builder.hpp:99
class chemin definition
Definition: chemin.hpp:51
class events
Definition: events.hpp:52
class guichet let one fetch config from a bibliotheque, save as or setup manually for a given compone...
Definition: guichet.hpp:92
class html_derouleur is a pure virtual class
Definition: html_derouleur.hpp:55
class html_form_fieldset implements HTML fieldset feature
Definition: html_form_fieldset.hpp:51
class html_form_input implements HTML input feature
Definition: html_form_input.hpp:57
class html_form implements HTML form feature
Definition: html_form.hpp:51
html component used for the user to define a has algorithm
Definition: html_hash_algo.hpp:43
html component used for the user to provide the parameters to repair an archive
Definition: html_options_repair.hpp:63
virtual void on_event(const std::string &event_name) override
inherited from actor
Definition: html_options_repair.cpp:360
virtual json save_json() const override
inherited from jsoner
Definition: html_options_repair.cpp:307
void set_biblio(const std::shared_ptr< bibliotheque > &ptr)
mandatory call to invoke ASAP after constructor
Definition: html_options_repair.cpp:236
void set_to_webdar_defaults()
set the object to webdar defaults
Definition: html_options_repair.cpp:440
virtual std::string inherited_get_body_part(const chemin &path, const request &req) override
inherited from body_builder
Definition: html_options_repair.cpp:457
static const std::string landing_path_changed
landing path has changed
Definition: html_options_repair.hpp:65
static const std::string entrepot_changed
event triggered for entrepot only changes except landing_path
Definition: html_options_repair.hpp:66
libdar::archive_options_repair get_options(std::shared_ptr< html_web_user_interaction > &webui) const
generate a corresponding libdar::archive_option_repair object
Definition: html_options_repair.cpp:387
static const std::string changed
event triggered for any change except landing_path
Definition: html_options_repair.hpp:67
virtual void clear_json() override
inherited from jsoner
Definition: html_options_repair.cpp:333
virtual bibliotheque::using_set get_using_set() const override
inherited from bibliotheque_subconfig
Definition: html_options_repair.cpp:349
std::shared_ptr< libdar::entrepot > get_entrepot(std::shared_ptr< html_web_user_interaction > webui) const
optain the current entrepot object where is expected to be repaired the archive
Definition: html_options_repair.hpp:98
const std::string & get_landing_path() const
obtain the entrepot landing path
Definition: html_options_repair.hpp:101
virtual void load_json(const json &source) override
inherited from jsoner
Definition: html_options_repair.cpp:254
virtual void new_css_library_available() override
inherited from body_builder
Definition: html_options_repair.cpp:464
class jsoner
Definition: jsoner.hpp:73
class holding fields of an HTTP request (method, URI, header, cookies, and so on)
Definition: request.hpp:45
defines the event class
defines jsoner class and class exception_json