| Disk ARchive 2.6.12 Full featured and portable backup and archiving tool

macro_tools.hpp
Go to the documentation of this file.
1 /*********************************************************************/
2 // dar - disk archive - a backup/restoration program
3 // Copyright (C) 2002-2020 Denis Corbin
4 //
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License
7 // as published by the Free Software Foundation; either version 2
8 // of the License, or (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 //
19 // to contact the author : http://dar.linux.free.fr/email.html
20 /*********************************************************************/
21
25
26 #ifndef MACRO_TOOLS_HPP
27 #define MACRO_TOOLS_HPP
28
29 #include "../my_config.h"
30
31 extern "C"
32 {
33 #if HAVE_LIMITS_H
34 #include <limits.h>
35 #endif
36 }
37 #include <string>
38 #include <vector>
39
40 #include "catalogue.hpp"
41 #include "compression.hpp"
42 #include "infinint.hpp"
43 #include "header_version.hpp"
44 #include "generic_file.hpp"
45 #include "crypto.hpp"
46 #include "pile.hpp"
47 #include "entrepot.hpp"
48 #include "range.hpp"
49 #include "slice_layout.hpp"
50 #include "tuyau.hpp"
51 #include "trivial_sar.hpp"
52
53
54
55 #define BUFFER_SIZE 102400
56 #ifdef SSIZE_MAX
57 #if SSIZE_MAX < BUFFER_SIZE
58 #undef BUFFER_SIZE
59 #define BUFFER_SIZE SSIZE_MAX
60 #endif
61 #endif
62
63 namespace libdar
64 {
65
68
69 constexpr U_I GLOBAL_ELASTIC_BUFFER_SIZE = 51200;
70
71 extern const archive_version macro_tools_supported_version;
72 extern const std::string LIBDAR_STACK_LABEL_UNCOMPRESSED;
73 extern const std::string LIBDAR_STACK_LABEL_CLEAR;
74 extern const std::string LIBDAR_STACK_LABEL_UNCYPHERED;
75 extern const std::string LIBDAR_STACK_LABEL_LEVEL1;
76
78 extern trivial_sar *macro_tools_open_archive_tuyau(const std::shared_ptr<user_interaction> & dialog,
79 S_I fd,
80 gf_mode mode,
81 const label & internal_name,
82 const label & data_name,
83 bool slice_header_format_07,
84 const std::string & execute);
85
86
88
113
114 extern void macro_tools_open_archive(const std::shared_ptr<user_interaction> & dialog,
115 const std::shared_ptr<entrepot> & where,
116 const std::string &basename,
117 const infinint & min_digits,
118 const std::string &extension,
119 crypto_algo crypto,
120 const secu_string &pass,
121 U_32 crypto_size,
122 pile & stack,
123 header_version &ver,
124 const std::string &input_pipe,
125 const std::string &output_pipe,
126 const std::string & execute,
127 infinint & second_terminateur_offset,
128 bool lax,
129 bool has_external_cat,
130 bool sequential_read,
131 bool info_details,
132 std::list<signator> & gnupg_signed,
133 slice_layout & sl,
134 bool multi_threaded,
135 bool header_only
136 );
137 // all allocated objects (ret1, ret2, scram), must be deleted when no more needed by the caller of this routine
138
140 extern catalogue *macro_tools_get_derivated_catalogue_from(const std::shared_ptr<user_interaction> & dialog,
141 pile & data_stack, // where to get the files and EA from
142 pile & cata_stack, // where to get the catalogue from
143 const header_version & ver, // version format as defined in the header of the archive to read
144 bool info_details, // verbose display (throught user_interaction)
145 infinint &cat_size, // return size of archive in file (not in memory !)
146 const infinint & second_terminateur_offset, // location of the second terminateur (zero if none exist)
147 std::list<signator> & signatories, // returns the list of signatories (empty if archive is was not signed)
148 bool lax_mode); // whether to do relaxed checkings
149
151 extern catalogue *macro_tools_get_catalogue_from(const std::shared_ptr<user_interaction> & dialog,
152 pile & stack, // raw data access object
153 const header_version & ver, // version format as defined in the header of the archive to read
154 bool info_details, // verbose display (throught user_interaction)
155 infinint &cat_size, // return size of archive in file (not in memory !)
156 const infinint & second_terminateur_offset,
157 std::list<signator> & signatories, // returns the list of signatories (empty if archive is was not signed)
158 bool lax_mode);
159
161 extern catalogue *macro_tools_read_catalogue(const std::shared_ptr<user_interaction> & dialog,
162 const header_version & ver,
163 const pile_descriptor & cata_pdesc,
164 const infinint & cat_size,
165 std::list<signator> & signatories,
166 bool lax_mode,
167 const label & lax_layer1_data_name,
168 bool only_detruits);
169
170 extern catalogue *macro_tools_lax_search_catalogue(const std::shared_ptr<user_interaction> & dialog,
171 pile & stack,
172 const archive_version & edition,
173 compression compr_algo,
174 bool info_details,
175 bool even_partial_catalogues,
176 const label & layer1_data_name);
177
178 // return the offset of the beginning of the catalogue.
179 extern infinint macro_tools_get_terminator_start(generic_file & f, const archive_version & reading_ver);
180
182
241
242 extern void macro_tools_create_layers(const std::shared_ptr<user_interaction> & dialog,
243 pile & layers,
244 header_version & ver,
245 slice_layout & slicing,
246 const slice_layout *ref_slicing,
247 const std::shared_ptr<entrepot> & sauv_path_t,
248 const std::string & filename,
249 const std::string & extension,
250 bool allow_over,
251 bool warn_over,
252 bool info_details,
253 const infinint & pause,
254 compression algo,
255 U_I compression_level,
256 const infinint & file_size,
257 const infinint & first_file_size,
258 const std::string & execute,
259 crypto_algo crypto,
260 const secu_string & pass,
261 U_32 crypto_size,
262 const std::vector<std::string> & gnupg_recipients,
263 const std::vector<std::string> & gnupg_signatories,
264 bool empty,
265 const std::string & slice_permission,
266 bool add_marks_for_sequential_reading,
267 const std::string & user_comment,
268 hash_algo hash,
269 const infinint & slice_min_digits,
270 const label & internal_name,
271 const label & data_name,
272 const infinint & iteration_count,
273 hash_algo kdf_hash,
274 bool multi_threaded);
275
277
288 extern void macro_tools_close_layers(const std::shared_ptr<user_interaction> & dialog,
289 pile & layers,
290 const header_version & ver,
291 const catalogue & cat,
292 bool info_details,
293 crypto_algo crypto,
294 compression algo,
295 const std::vector<std::string> & gnupg_recipients,
296 const std::vector<std::string> & gnupg_signatories,
297 bool empty);
298
299
301
306 extern range macro_tools_get_slices(const cat_nomme *obj, slice_layout sl);
307
309
316 extern void macro_tools_open_pipes(const std::shared_ptr<user_interaction> & dialog,
317 const std::string &input,
318 const std::string & output,
319 tuyau *&in,
320 tuyau *&out);
321
323
324 } // end of namespace
325
326
327 #endif
libdar::hash_algo
hash_algo
hashing algorithm available
Definition: archive_aux.hpp:63
libdar::range
stores a range of integers or a set of ranges
Definition: range.hpp:44
libdar::macro_tools_create_layers
void macro_tools_create_layers(const std::shared_ptr< user_interaction > &dialog, pile &layers, header_version &ver, slice_layout &slicing, const slice_layout *ref_slicing, const std::shared_ptr< entrepot > &sauv_path_t, const std::string &filename, const std::string &extension, bool allow_over, bool warn_over, bool info_details, const infinint &pause, compression algo, U_I compression_level, const infinint &file_size, const infinint &first_file_size, const std::string &execute, crypto_algo crypto, const secu_string &pass, U_32 crypto_size, const std::vector< std::string > &gnupg_recipients, const std::vector< std::string > &gnupg_signatories, bool empty, const std::string &slice_permission, bool add_marks_for_sequential_reading, const std::string &user_comment, hash_algo hash, const infinint &slice_min_digits, const label &internal_name, const label &data_name, const infinint &iteration_count, hash_algo kdf_hash, bool multi_threaded)
build layers for a new archive
libdar::compression
compression
the different compression algorithm available
Definition: compression.hpp:46
libdar::label
manage label data structure used in archive slice headers
Definition: label.hpp:43
libdar::macro_tools_open_archive
void macro_tools_open_archive(const std::shared_ptr< user_interaction > &dialog, const std::shared_ptr< entrepot > &where, const std::string &basename, const infinint &min_digits, const std::string &extension, crypto_algo crypto, const secu_string &pass, U_32 crypto_size, pile &stack, header_version &ver, const std::string &input_pipe, const std::string &output_pipe, const std::string &execute, infinint &second_terminateur_offset, bool lax, bool has_external_cat, bool sequential_read, bool info_details, std::list< signator > &gnupg_signed, slice_layout &sl, bool multi_threaded, bool header_only)
setup the given pile object to contain a stack of generic_files suitable to read an archive
libdar::pile
stores a stack of generic_files writing/reading on each others
Definition: pile.hpp:44
compression.hpp
compression parameters for API
libdar::gf_mode
gf_mode
generic_file openning modes
Definition: gf_mode.hpp:44
infinint.hpp
switch module to limitint (32 ou 64 bits integers) or infinint
libdar::infinint
the arbitrary large positive integer class
Definition: real_infinint.hpp:62
tuyau.hpp
defines the implementation of pipe under the generic_file interface.
libdar::cat_nomme
the base class for all entry that have a name
Definition: cat_nomme.hpp:45
trivial_sar.hpp
the trivial_sar classes manages the slicing layer when single slice is used
libdar::trivial_sar
Definition: trivial_sar.hpp:54
libdar::macro_tools_get_catalogue_from
catalogue * macro_tools_get_catalogue_from(const std::shared_ptr< user_interaction > &dialog, pile &stack, const header_version &ver, bool info_details, infinint &cat_size, const infinint &second_terminateur_offset, std::list< signator > &signatories, bool lax_mode)
uses terminator to skip to the position where to find the catalogue and read it
libdar::archive_version
class archive_version manages the version of the archive format
Definition: archive_version.hpp:47
libdar::macro_tools_open_pipes
void macro_tools_open_pipes(const std::shared_ptr< user_interaction > &dialog, const std::string &input, const std::string &output, tuyau *&in, tuyau *&out)
open a pair of tuyau objects encapsulating two named pipes.
libdar::tuyau
pipe implementation under the generic_file interface.
Definition: tuyau.hpp:49
entrepot.hpp
defines the entrepot interface. Entrepot interface defines a generic way to interact with files (slic...
range.hpp
class than provide a way to manipulate and represent range of integer numbers (infinint)
generic_file.hpp
class generic_file is defined here as well as class fichier
slice_layout.hpp
object describing the slicing of an archive
libdar::macro_tools_get_derivated_catalogue_from
catalogue * macro_tools_get_derivated_catalogue_from(const std::shared_ptr< user_interaction > &dialog, pile &data_stack, pile &cata_stack, const header_version &ver, bool info_details, infinint &cat_size, const infinint &second_terminateur_offset, std::list< signator > &signatories, bool lax_mode)
uses terminator to skip to the position where to find the catalogue and read it, taking care of havin...
header_version.hpp
archive global header/trailer structure is defined here
libdar::macro_tools_read_catalogue
catalogue * macro_tools_read_catalogue(const std::shared_ptr< user_interaction > &dialog, const header_version &ver, const pile_descriptor &cata_pdesc, const infinint &cat_size, std::list< signator > &signatories, bool lax_mode, const label &lax_layer1_data_name, bool only_detruits)
read the catalogue from cata_stack assuming the cata_stack is positionned at the beginning of the are...
libdar::macro_tools_open_archive_tuyau
trivial_sar * macro_tools_open_archive_tuyau(const std::shared_ptr< user_interaction > &dialog, S_I fd, gf_mode mode, const label &internal_name, const label &data_name, bool slice_header_format_07, const std::string &execute)
create an container to write an archive to a pipe
libdar::macro_tools_get_slices
range macro_tools_get_slices(const cat_nomme *obj, slice_layout sl)
gives the location of data EA and FSA (when they are saved) of the object given in argument
pile.hpp
class pile definition. Used to manage a stack of generic_file objects
libdar::generic_file
this is the interface class from which all other data transfer classes inherit
Definition: generic_file.hpp:77
libdar::secu_string
class secu_string
Definition: secu_string.hpp:58
libdar::crypto_algo
crypto_algo
the different cypher available for encryption (strong or weak)
Definition: crypto.hpp:50
libdar::catalogue
the catalogue class which gather all objects contained in a give archive
Definition: catalogue.hpp:61
libdar::header_version
manages the archive header and trailer
Definition: header_version.hpp:48
catalogue.hpp
here is defined the classe used to manage catalogue of archives
crypto.hpp
the crypto algoritm definition
libdar::macro_tools_close_layers
void macro_tools_close_layers(const std::shared_ptr< user_interaction > &dialog, pile &layers, const header_version &ver, const catalogue &cat, bool info_details, crypto_algo crypto, compression algo, const std::vector< std::string > &gnupg_recipients, const std::vector< std::string > &gnupg_signatories, bool empty)
dumps the catalogue and close all the archive layers to terminate the archive
libdar
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47