filesystem_hard_link_read.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 FILESYSTEM_HARD_LINK_READ_HPP
#define FILESYSTEM_HARD_LINK_READ_HPP
#include "../my_config.h"
extern "C"
{
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
#if HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif
} // end extern "C"
#include <map>
#include "infinint.hpp"
#include "fsa_family.hpp"
#include "cat_all_entrees.hpp"
#include "mem_ui.hpp"
#include <set>
namespace libdar
{
class filesystem_hard_link_read : protected mem_ui
{
// this class is not to be used directly
// it only provides some routine for the inherited classes
public:
filesystem_hard_link_read(const std::shared_ptr<user_interaction> & dialog,
bool x_furtive_read_mode,
const fsa_scope & scope) : mem_ui(dialog)
{ furtive_read_mode = x_furtive_read_mode; sc = scope; ask_before_zeroing_neg_dates = true; };
// the copy of the current object would make copy of addresses in
// corres_read that could be released twice ... thus, copy constructor and
// assignement are forbidden for this class:
filesystem_hard_link_read(const filesystem_hard_link_read & ref) = delete;
filesystem_hard_link_read(filesystem_hard_link_read && ref) = delete;
filesystem_hard_link_read & operator = (const filesystem_hard_link_read & ref) = delete;
filesystem_hard_link_read & operator = (filesystem_hard_link_read && ref) = delete;
virtual ~filesystem_hard_link_read() = default;
const infinint & get_last_etoile_ref() const { return etiquette_counter; };
const fsa_scope get_fsa_scope() const { return sc; };
void zeroing_negative_dates_without_asking() { ask_before_zeroing_neg_dates = false; };
void set_ignored_symlinks_list(const std::set<std::string> & x_ignored_symlinks)
{ ignored_symlinks = x_ignored_symlinks; };
protected:
void corres_reset() { corres_read.clear(); etiquette_counter = 0; };
cat_nomme *make_read_entree(const path & lieu,
const std::string & name,
bool see_hard_link,
const mask & ea_mask
);
bool get_ask_before_zeroing_neg_dates() const { return ask_before_zeroing_neg_dates; };
private:
// private datastructure
struct couple
{
nlink_t count;
cat_etoile *obj;
cat_mirage holder;
couple(cat_etoile *ptr, nlink_t ino_count) : holder("FAKE", ptr) { count = ino_count; obj = ptr; };
};
struct node
{
node(ino_t num, dev_t dev) { numnode = num; device = dev; };
// this operator is required to use the type node in a std::map
bool operator < (const node & ref) const { return numnode < ref.numnode || (numnode == ref.numnode && device < ref.device); };
ino_t numnode;
dev_t device;
};
// private variable
std::map <node, couple> corres_read;
infinint etiquette_counter;
bool furtive_read_mode;
fsa_scope sc;
bool ask_before_zeroing_neg_dates;
std::set<std::string> ignored_symlinks;
// private methods
bool ignore_if_symlink(const std::string & full_path)
{ return ignored_symlinks.find(full_path) != ignored_symlinks.end(); };
};
} // end of namespace
#endif
cat_all_entrees.hpp
include file gathering all entree found in a catalogue
libdar::cat_etoile
the hard link implementation
Definition: cat_etoile.hpp:48
libdar::cat_mirage
the hard link implementation, cat_mirage is the named entry owned by a directory it points to a commo...
Definition: cat_mirage.hpp:48
libdar::cat_nomme
the base class for all entry that have a name
Definition: cat_nomme.hpp:45
libdar::filesystem_hard_link_read
keep trace of hard links when reading the filesystem
Definition: filesystem_hard_link_read.hpp:58
libdar::filesystem_hard_link_read::corres_reset
void corres_reset()
reset the whole list of hard linked inodes (hard linked inode stay alive but are no more referenced b...
Definition: filesystem_hard_link_read.hpp:97
libdar::filesystem_hard_link_read::set_ignored_symlinks_list
void set_ignored_symlinks_list(const std::set< std::string > &x_ignored_symlinks)
Definition: filesystem_hard_link_read.hpp:91
libdar::filesystem_hard_link_read::zeroing_negative_dates_without_asking
void zeroing_negative_dates_without_asking()
don't ask before zeroing negative date just warn user
Definition: filesystem_hard_link_read.hpp:86
libdar::filesystem_hard_link_read::make_read_entree
cat_nomme * make_read_entree(const path &lieu, const std::string &name, bool see_hard_link, const mask &ea_mask)
libdar::filesystem_hard_link_read::get_fsa_scope
const fsa_scope get_fsa_scope() const
provide the FSA scope used by the object
Definition: filesystem_hard_link_read.hpp:83
libdar::filesystem_hard_link_read::get_last_etoile_ref
const infinint & get_last_etoile_ref() const
get the last assigned number for a hard linked inode
Definition: filesystem_hard_link_read.hpp:80
libdar::infinint
the arbitrary large positive integer class
Definition: real_infinint.hpp:62
libdar::mask
the generic class, parent of all masks
Definition: mask.hpp:62
libdar::mem_ui
class mem_ui to keep a copy of a user_interaction object
Definition: mem_ui.hpp:55
libdar::mem_ui::mem_ui
mem_ui(const std::shared_ptr< user_interaction > &dialog)
constructor
libdar::path
the class path is here to manipulate paths in the Unix notation: using'/'
Definition: path.hpp:51
fsa_family.hpp
filesystem specific attributes available families and fsa_scope definition
libdar::fsa_scope
std::set< fsa_family > fsa_scope
set of fsa families
Definition: fsa_family.hpp:70
infinint.hpp
switch module to limitint (32 ou 64 bits integers) or infinint
mem_ui.hpp
class mem_ui definition. This class is to be used as parent class to handle user_interaction object m...
libdar
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47