cat_directory.hpp
Go to the documentation of this file.
/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2023 Denis Corbin
//
// This program 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 2
// of the License, or (at your option) any later version.
//
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// to contact the author, see the AUTHOR file
/*********************************************************************/
#ifndef CAT_DIRECTORY_HPP
#define CAT_DIRECTORY_HPP
#include "../my_config.h"
extern "C"
{
} // end extern "C"
#include "cat_inode.hpp"
#ifdef LIBDAR_FAST_DIR
#include <map>
#endif
#include <list>
namespace libdar
{
class cat_eod;
class cat_directory : public cat_inode
{
public :
cat_directory(const infinint & xuid,
const infinint & xgid,
U_16 xperm,
const datetime & last_access,
const datetime & last_modif,
const datetime & last_change,
const std::string & xname,
const infinint & device);
cat_directory(const std::shared_ptr<user_interaction> & dialog,
const smart_pointer<pile_descriptor> & pdesc,
const archive_version & reading_ver,
saved_status saved,
entree_stats & stats,
std::map <infinint, cat_etoile *> & corres,
compression default_algo,
bool lax,
bool only_detruit, // objects of other class than detruit and cat_directory are not built in memory
bool small);
cat_directory(const cat_directory &ref); // only the inode part is build, no children is duplicated (empty dir)
cat_directory(cat_directory && ref) noexcept;
cat_directory & operator = (const cat_directory & ref); // set the inode part *only* no subdirectories/subfiles are copies or removed.
cat_directory & operator = (cat_directory && ref) noexcept;
~cat_directory() noexcept(false); // detruit aussi tous les fils et se supprime de son 'parent'
virtual bool operator == (const cat_entree & ref) const override;
void add_children(cat_nomme *r); // when r is a cat_directory, 'parent' is set to 'this'
bool has_children() const { return !ordered_fils.empty(); };
void reset_read_children() const;
void end_read() const;
bool read_children(const cat_nomme * &r) const; // read the direct children of the cat_directory, returns false if no more is available
// remove all entry not yet read by read_children
void tail_to_read_children();
void remove(const std::string & name);
cat_directory * get_parent() const { return parent; };
bool search_children(const std::string &name, const cat_nomme *&ref) const;
// using is_more_recent_than() from cat_inode class
// using method has_changed_since() from cat_inode class
virtual unsigned char signature() const override { return 'd'; };
virtual std::string get_description() const override { return "folder"; };
bool get_recursive_has_changed() const { return recursive_has_changed; };
void recursive_has_changed_update() const;
infinint get_dir_size() const { return ordered_fils.size(); };
infinint get_tree_size() const;
infinint get_tree_ea_num() const;
infinint get_tree_mirage_num() const;
// for each mirage found (hard link implementation) in the cat_directory tree, add its etiquette to the returned
// list with the number of reference that has been found in the tree. (map[etiquette] = number of occurence)
// from outside of class cat_directory, the given argument is expected to be an empty map.
void get_etiquettes_found_in_tree(std::map<infinint, infinint> & already_found) const;
bool is_empty() const { return ordered_fils.empty(); };
void remove_all_mirages_and_reduce_dirs();
void set_all_mirage_s_inode_wrote_field_to(bool val) const;
void set_all_mirage_s_inode_dumped_field_to(bool val) const;
virtual cat_entree *clone() const override { return new (std::nothrow) cat_directory(*this); };
const infinint & get_size() const { recursive_update_sizes(); return x_size; };
const infinint & get_storage_size() const { recursive_update_sizes(); return x_storage_size; };
void recursively_set_to_unsaved_data_and_FSA();
virtual void change_location(const smart_pointer<pile_descriptor> & pdesc) override;
protected:
virtual void inherited_dump(const pile_descriptor & pdesc, bool small) const override;
private:
static const cat_eod fin;
mutable infinint x_size;
mutable infinint x_storage_size;
mutable bool updated_sizes;
cat_directory *parent;
#ifdef LIBDAR_FAST_DIR
std::map<std::string, cat_nomme *> fils; // used for fast lookup
#endif
std::deque<cat_nomme *> ordered_fils;
mutable std::deque<cat_nomme *>::const_iterator it;
mutable bool recursive_has_changed;
void init() noexcept;
void clear();
void recursive_update_sizes() const;
void recursive_flag_size_to_update() const;
void erase_ordered_fils(std::deque<cat_nomme *>::const_iterator debut,
std::deque<cat_nomme *>::const_iterator fin);
};
} // end of namespace
#endif
cat_inode.hpp
base object for all inode types, managed EA and FSA, dates, permissions, ownership,...
libdar::archive_version
class archive_version manages the version of the archive format
Definition: archive_version.hpp:47
libdar::cat_directory
the cat_directory inode class
Definition: cat_directory.hpp:52
libdar::cat_directory::set_all_mirage_s_inode_wrote_field_to
void set_all_mirage_s_inode_wrote_field_to(bool val) const
recursively set all mirage inode_wrote flag
libdar::cat_directory::get_tree_ea_num
infinint get_tree_ea_num() const
get the number of entry having some EA set in the cat_directory tree (recursive call)
libdar::cat_directory::it
std::deque< cat_nomme * >::const_iterator it
next entry to be returned by read_children
Definition: cat_directory.hpp:167
libdar::cat_directory::recursive_has_changed_update
void recursive_has_changed_update() const
ask recursive update for the recursive_has_changed field
libdar::cat_directory::set_all_mirage_s_inode_dumped_field_to
void set_all_mirage_s_inode_dumped_field_to(bool val) const
set the value of inode_dumped for all mirage (recusively)
libdar::cat_directory::remove_all_mirages_and_reduce_dirs
void remove_all_mirages_and_reduce_dirs()
recursively remove all mirage entries
libdar::cat_directory::get_dir_size
infinint get_dir_size() const
get the number of "cat_nomme" entry directly containted in this cat_directory (no recursive call)
Definition: cat_directory.hpp:115
libdar::cat_directory::get_description
virtual std::string get_description() const override
inherited class designation
Definition: cat_directory.hpp:105
libdar::cat_directory::inherited_dump
virtual void inherited_dump(const pile_descriptor &pdesc, bool small) const override
true if object has been created by sequential reading of an archive
libdar::cat_directory::signature
virtual unsigned char signature() const override
inherited class signature
Definition: cat_directory.hpp:103
libdar::cat_directory::get_tree_mirage_num
infinint get_tree_mirage_num() const
get the number of entry that are hard linked inode (aka mirage in dar implementation) (recursive call...
libdar::cat_directory::clone
virtual cat_entree * clone() const override
a way to copy the exact type of an object even if pointed to by a parent class pointer
Definition: cat_directory.hpp:143
libdar::cat_directory::remove
void remove(const std::string &name)
remove the given entry from the catalogue
libdar::cat_directory::change_location
virtual void change_location(const smart_pointer< pile_descriptor > &pdesc) override
overwrite virtual method of cat_entree to propagate the action to all entries of the directory tree
libdar::cat_directory::get_recursive_has_changed
bool get_recursive_has_changed() const
detemine whether some data has changed since archive of reference in this cat_directory or subdirecto...
Definition: cat_directory.hpp:109
libdar::cat_directory::get_tree_size
infinint get_tree_size() const
get then number of "cat_nomme" entry contained in this cat_directory and subdirectories (recursive ca...
libdar::cat_directory::is_empty
bool is_empty() const
whether this cat_directory is empty or not
Definition: cat_directory.hpp:132
libdar::cat_directory::operator==
virtual bool operator==(const cat_entree &ref) const override
attention this compares only the directories themselves, not the list of their children
libdar::cat_entree
the root class from all other inherite for any entry in the catalogue
Definition: cat_entree.hpp:60
libdar::cat_eod
the End of Directory entry class
Definition: cat_eod.hpp:46
libdar::cat_inode
the root class for all cat_inode
Definition: cat_inode.hpp:53
libdar::cat_nomme
the base class for all entry that have a name
Definition: cat_nomme.hpp:45
libdar::datetime
stores time information
Definition: datetime.hpp:59
libdar::infinint
the arbitrary large positive integer class
Definition: real_infinint.hpp:62
libdar::smart_pointer< pile_descriptor >
libdar::compression
compression
the different compression algorithm available
Definition: compression.hpp:46
libdar::saved_status
saved_status
data saved status for an entry
Definition: cat_status.hpp:45
libdar::saved_status::saved
@ saved
inode is saved in the archive
libdar
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47
libdar::entree_stats
holds the statistics contents of a catalogue
Definition: entree_stats.hpp:49