Disk ARchive  2.7.8
Full featured and portable backup and archiving tool
catalogue.hpp
Go to the documentation of this file.
1 /*********************************************************************/
2 // dar - disk archive - a backup/restoration program
3 // Copyright (C) 2002-2022 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, see the AUTHOR file
20 /*********************************************************************/
21 
25 
26 #ifndef CATALOGUE_HPP
27 #define CATALOGUE_HPP
28 
29 #include "../my_config.h"
30 
31 extern "C"
32 {
33 #if HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36 } // end extern "C"
37 
38 #include "infinint.hpp"
39 #include "path.hpp"
40 #include "integers.hpp"
41 #include "mask.hpp"
42 #include "user_interaction.hpp"
43 #include "label.hpp"
44 #include "escape.hpp"
45 #include "datetime.hpp"
46 #include "slice_layout.hpp"
47 #include "cat_entree.hpp"
48 #include "cat_nomme.hpp"
49 #include "cat_directory.hpp"
50 #include "mem_ui.hpp"
51 #include "delta_sig_block_size.hpp"
52 
53 namespace libdar
54 {
55 
58 
60  class catalogue: public mem_ui
61  {
62  public :
63  catalogue(const std::shared_ptr<user_interaction> & ui,
64  const datetime & root_last_modif,
65  const label & data_name);
66  catalogue(const std::shared_ptr<user_interaction> & ui,
67  const pile_descriptor & pdesc,
68  const archive_version & reading_ver,
69  compression default_algo,
70  bool lax,
71  const label & lax_layer1_data_name, // ignored unless in lax mode, in lax mode unless it is a cleared label, forces the catalogue label to be equal to the lax_layer1_data_name for it be considered a plain internal catalogue, even in case of corruption
72  bool only_detruit = false); // if set to true, only directories and detruit objects are read from the archive
73  catalogue(const catalogue & ref) : mem_ui(ref), out_compare(ref.out_compare), in_place(ref.in_place) { partial_copy_from(ref); };
74  catalogue(catalogue && ref) = delete;
75  catalogue & operator = (const catalogue &ref);
76  catalogue & operator = (catalogue && ref) = delete;
77  virtual ~catalogue() { detruire(); };
78 
79 
80  // reading methods. The reading is iterative and uses the current_read cat_directory pointer
81 
82  virtual void reset_read() const; // set the reading cursor to the beginning of the catalogue
83  virtual void end_read() const; // set the reading cursor to the end of the catalogue
84  virtual void skip_read_to_parent_dir() const;
85  // skip all items of the current dir and of any subdir, the next call will return
86  // next item of the parent dir (no cat_eod to exit from the current dir !)
87  virtual bool read(const cat_entree * & ref) const;
88  // sequential read (generates cat_eod) and return false when all files have been read
89  virtual bool read_if_present(std::string *name, const cat_nomme * & ref) const;
90  // pseudo-sequential read (reading a directory still
91  // implies that following read are located in this subdirectory up to the next EOD) but
92  // it returns false if no entry of this name are present in the current directory
93  // a call with nullptr as first argument means to set the current dir the parent directory
94  void remove_read_entry(std::string & name);
95  // in the currently read directory, removes the entry which name is given in argument
96  const cat_directory & get_current_reading_dir() const { if(current_read == nullptr) throw SRC_BUG; return *current_read; };
97  // remove from the catalogue all the entries that have not yet been read
98  // by read().
99  virtual void tail_catalogue_to_current_read();
100 
101 
102  void reset_sub_read(const path &sub); // initialise sub_read to the given directory
103  bool sub_read(user_interaction & ui, const cat_entree * &ref); // sequential read of the catalogue, ignoring all that
104  // is not part of the subdirectory specified with reset_sub_read
105  // the read include the inode leading to the sub_tree as well as the pending cat_eod
106 
107  // return true if the last read entry has already been read
108  // and has not to be counted again. This is never the case for catalogue but may occur
109  // with escape_catalogue (where from the 'virtual').
110  // last this method gives a valid result only if the last read() entry is a directory as
111  // only directory may be read() twice.
112  virtual bool read_second_time_dir() const { return false; };
113 
114 
115  // Additions methods. The addition is also iterative but uses its specific current_add directory pointer
116 
117  void reset_add();
118 
120  // real implementation is only needed in escape_catalogue class, here there nothing to be done
121  virtual void pre_add(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
122  virtual void pre_add_ea(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
123  virtual void pre_add_crc(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
124  virtual void pre_add_dirty( const pile_descriptor* dest = nullptr) const {};
125  virtual void pre_add_ea_crc(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
126  virtual void pre_add_waste_mark(const pile_descriptor* dest = nullptr) const {};
127  virtual void pre_add_failed_mark(const pile_descriptor* dest = nullptr) const {};
128  virtual void pre_add_fsa(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
129  virtual void pre_add_fsa_crc(const cat_entree *ref, const pile_descriptor* dest = nullptr) const {};
130  virtual void pre_add_delta_sig(const pile_descriptor* dest = nullptr) const {};
131  virtual escape *get_escape_layer() const { return nullptr; };
132  virtual void drop_escape_layer() {};
133 
134  void add(cat_entree *ref); // add at end of catalogue (sequential point of view)
135  void re_add_in(const std::string &subdirname); // return into an already existing subdirectory for further addition
136  void re_add_in_replace(const cat_directory &dir); // same as re_add_in but also set the properties of the existing directory to those of the given argument
137  void add_in_current_read(cat_nomme *ref); // add in currently read directory
138  const cat_directory & get_current_add_dir() const { if(current_add == nullptr) throw SRC_BUG; return *current_add; };
139 
140 
141 
142  // Comparison methods. The comparision is here also iterative and uses its specific current_compare directory pointer
143 
144  void reset_compare() const;
145  bool compare(const cat_entree * name, const cat_entree * & extracted) const;
146  // returns true if the ref exists, and gives it back in second argument as it is in the current catalogue.
147  // returns false is no entry of that nature exists in the catalogue (in the current directory)
148  // if ref is a directory, the operation is normaly relative to the directory itself, but
149  // such a call implies a chdir to that directory. thus, a call with an EOD is necessary to
150  // change to the parent directory.
151  // note :
152  // if a directory is not present, returns false, but records the inexistant subdirectory
153  // structure defined by the following calls to this routine, this to be able to know when
154  // the last available directory is back the current one when changing to parent directory,
155  // and then proceed with normal comparison of inode. In this laps of time, the call will
156  // always return false, while it temporary stores the missing directory structure
157 
158 
159 
160  // non interative methods
161 
162 
164 
167 
168 
170 
174  void update_absent_with(const catalogue & ref, infinint aborting_next_etoile);
175 
176 
179 
181 
184  bool is_subset_of(const catalogue & ref) const;
185 
187  void reset_dump() const;
188 
190  void dump(const pile_descriptor & pdesc) const;
191 
192  entree_stats get_stats() const { return stats; };
193 
195  bool is_empty() const { if(contenu == nullptr) throw SRC_BUG; return contenu->is_empty(); };
196 
197  const cat_directory *get_contenu() const { return contenu; }; // used by data_tree
198 
199  const label & get_data_name() const { return ref_data_name; };
200  void set_data_name(const label & val) { ref_data_name = val; };
201 
202  datetime get_root_dir_last_modif() const { return contenu->get_last_modif(); };
203 
206 
209 
210  datetime get_root_mtime() const { return contenu->get_last_modif(); };
211 
213  void reset_all();
214 
215  void set_to_unsaved_data_and_FSA() { if(contenu == nullptr) throw SRC_BUG; contenu->recursively_set_to_unsaved_data_and_FSA(); };
216 
218  void change_location(const pile_descriptor & pdesc);
219 
221 
229  void transfer_delta_signatures(const pile_descriptor & destination,
230  bool sequential_read,
231  bool build,
232  const mask & delta_mask,
233  const infinint & delta_sig_min_size,
234  const delta_sig_block_size & signature_block_size);
235 
238 
239 
241  bool has_in_place() const { return in_place.is_absolute(); };
242 
244 
248  bool get_in_place(path & arg) const;
249 
251  virtual void set_in_place(const path & arg);
252 
254  virtual void clear_in_place();
255 
256 
257  protected:
258  entree_stats & access_stats() { return stats; };
259  void copy_detruits_from(const catalogue & ref); // needed for escape_catalogue implementation only.
260 
261  const cat_eod * get_r_eod_address() const { return & r_eod; }; // cat_eod are never stored in the catalogue
262  // however it is sometimes required to return such a reference to a valid object
263  // owned by the catalogue.
264 
265 
268  void swap_stuff(catalogue & ref);
269 
270  private :
272  mutable path out_compare;
277  mutable signed int sub_count;
281 
282  void partial_copy_from(const catalogue &ref);
283  void detruire();
284 
285  static const cat_eod r_eod;
286  static const U_I CAT_CRC_SIZE;
287  };
288 
289 
290 
292 
293 } // end of namespace
294 
295 #endif
class used to organize objects in tree in catalogue as like directories in a filesystem
base class for all object contained in a catalogue
base class of all objects contained in a catalogue and that can be named
class archive_version manages the version of the archive format
the cat_directory inode class
void recursive_has_changed_update() const
ask recursive update for the recursive_has_changed field
bool is_empty() const
whether this cat_directory is empty or not
the root class from all other inherite for any entry in the catalogue
Definition: cat_entree.hpp:60
the End of Directory entry class
Definition: cat_eod.hpp:46
the base class for all entry that have a name
Definition: cat_nomme.hpp:45
the catalogue class which gather all objects contained in a give archive
Definition: catalogue.hpp:61
void change_location(const pile_descriptor &pdesc)
change location where to find EA, FSA and DATA for all the objects of the catalogue
void set_all_mirage_s_inode_wrote_field_to(bool val) const
recursive setting of mirage inode_wrote flag
Definition: catalogue.hpp:208
path in_place
path of the directory used for root of the backup (at the time of the backup)
Definition: catalogue.hpp:280
cat_directory * current_read
points to the directory where the next item will be read
Definition: catalogue.hpp:275
void reset_all()
reset all pointers to the root (a bit better than reset_add() + reset_read() + reset_compare() + rese...
infinint update_destroyed_with(const catalogue &ref)
add into "this" detruit object corresponding to object of ref absent in "this"
bool is_subset_of(const catalogue &ref) const
check whether all inode existing in the "this" and ref have the same attributes
entree_stats stats
statistics catalogue contents
Definition: catalogue.hpp:278
void swap_stuff(catalogue &ref)
path * sub_tree
path to sub_tree
Definition: catalogue.hpp:276
virtual void pre_add(const cat_entree *ref, const pile_descriptor *dest=nullptr) const
catalogue extension routines for escape sequence
Definition: catalogue.hpp:121
void transfer_delta_signatures(const pile_descriptor &destination, bool sequential_read, bool build, const mask &delta_mask, const infinint &delta_sig_min_size, const delta_sig_block_size &signature_block_size)
copy delta signatures to the given stack and update the cat_file objects accordingly
path out_compare
stores the missing directory structure, when extracting
Definition: catalogue.hpp:272
bool is_empty() const
whether the catalogue is empty or not
Definition: catalogue.hpp:195
cat_directory * current_add
points to the directory where to add the next file with add_file;
Definition: catalogue.hpp:274
void drop_delta_signatures()
remove delta signature from the catalogue object as if they had never been calculated
void drop_all_non_detruits()
remove/destroy from "this" all objects that are neither directory nor detruit objects
label ref_data_name
name of the archive where is located the data
Definition: catalogue.hpp:279
bool has_in_place() const
returns whether an in-place path is stored in the catalogue
Definition: catalogue.hpp:241
void update_absent_with(const catalogue &ref, infinint aborting_next_etoile)
copy from ref missing files in "this" and mark then as "not_saved" (no change since reference)
cat_directory * contenu
catalogue contents
Definition: catalogue.hpp:271
virtual void clear_in_place()
clear the in_place path
bool get_in_place(path &arg) const
get the in_place path when available
virtual void set_in_place(const path &arg)
set the in_place path for recording in the archive
void launch_recursive_has_changed_update() const
recursive evaluation of directories that have changed (make the cat_directory::get_recurisve_has_chan...
Definition: catalogue.hpp:205
static const cat_eod r_eod
needed to return eod reference, without taking risk of saturating memory
Definition: catalogue.hpp:285
signed int sub_count
count the depth in of read routine in the sub_tree
Definition: catalogue.hpp:277
cat_directory * current_compare
points to the current directory when extracting
Definition: catalogue.hpp:273
void dump(const pile_descriptor &pdesc) const
write down the whole catalogue to file
void reset_dump() const
before dumping the catalogue, need to set all hardlinked inode they have not been saved once
stores time information
Definition: datetime.hpp:59
the arbitrary large positive integer class
manage label data structure used in archive slice headers
Definition: label.hpp:43
the generic class, parent of all masks
Definition: mask.hpp:62
class mem_ui to keep a copy of a user_interaction object
Definition: mem_ui.hpp:55
mem_ui(const std::shared_ptr< user_interaction > &dialog)
constructor
the class path is here to manipulate paths in the Unix notation: using'/'
Definition: path.hpp:51
bool is_absolute() const
whether the path is absolute or relative
Definition: path.hpp:104
This is a pure virtual class that is used by libdar when interaction with the user is required.
this file contains the definition of class datetime that stores unix times in a portable way
structure used to define how to select block size for delta signature
class escape definition, used for sequential reading of archives
compression
the different compression algorithm available
Definition: compression.hpp:46
switch module to limitint (32 ou 64 bits integers) or infinint
are defined here basic integer types that tend to be portable
define the datastructure "label" used to identify slice membership to an archive
here lies a collection of mask classes
class mem_ui definition. This class is to be used as parent class to handle user_interaction object m...
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47
here is the definition of the path class
object describing the slicing of an archive
defines how to calculate delta signature block size based of file size to delta sign
holds the statistics contents of a catalogue
defines the interaction interface between libdar and users.