entrepot.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2024 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 ENTREPOT_HPP
#define ENTREPOT_HPP
 
#include "../my_config.h"
 
#include <string>
#include <memory>
#include "user_interaction.hpp"
#include "path.hpp"
#include "archive_aux.hpp"
#include "gf_mode.hpp"
 
namespace libdar
{
 
    // no need to dig into this from API header
    class fichier_global;
 
 
    class entrepot
    {
    public:
 
    entrepot();
 
    entrepot(const entrepot & ref) = default;
 
    entrepot(entrepot && ref) noexcept = default;
 
    entrepot & operator = (const entrepot & ref) = default;
 
    entrepot & operator = (entrepot && ref) noexcept = default;
 
    virtual ~entrepot() = default;
 
    bool operator == (const entrepot & ref) const { return get_url() == ref.get_url(); };
 
 
    virtual void set_location(const path & chemin);
 
    virtual void set_root(const path & p_root);
 
 
    virtual path get_full_path() const;
 
    virtual std::string get_url() const = 0;
 
    void set_user_ownership(const std::string & x_user) { user = x_user; };
    void set_group_ownership(const std::string & x_group) { group = x_group; };
 
    virtual const path & get_location() const { return where; }; //< retreives relative to root path the current location points to
    virtual const path & get_root() const { return root; };      //< retrieves the given root location
 
    const std::string & get_user_ownership() const { return user; };
    const std::string & get_group_ownership() const { return group; };
 
 
    fichier_global *open(const std::shared_ptr<user_interaction> & dialog,
                 const std::string & filename,
                 gf_mode mode,
                 bool force_permission,
                 U_I permission,
                 bool fail_if_exists,
                 bool erase,
                 hash_algo algo,
                 bool provide_a_plain_file = true) const;
 
    virtual void read_dir_reset() const = 0;
    virtual bool read_dir_next(std::string & filename) const = 0;
 
    void unlink(const std::string & filename) const { inherited_unlink(filename); }; //< done this way for homogeneity with open/inherited_open
 
 
    virtual entrepot *clone() const = 0;
 
    protected:
    virtual fichier_global *inherited_open(const std::shared_ptr<user_interaction> & dialog,     //< for user interaction
                           const std::string & filename,  //< filename to open
                           gf_mode mode,                  //< mode to use
                           bool force_permission,         //< set the permission of the file to open
                           U_I permission,                //< value of the permission to assign when force_permission is true
                           bool fail_if_exists,           //< whether to fail if file exists (write mode)
                           bool erase) const = 0;         //< whether to erase file if file already exists (write mode)
 
    virtual void inherited_unlink(const std::string & filename) const = 0;
 
    virtual void read_dir_flush() = 0; //< ends the read_dir_next, (no more entry available)
 
    private:
    path where;
        path root;
    std::string user;
    std::string group;
    };
 
 
} // end of namespace
 
#endif