trivial_sar.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 TRIVIAL_SAR_HPP
#define TRIVIAL_SAR_HPP
 
#include "../my_config.h"
 
#include <string>
#include "infinint.hpp"
#include "generic_file.hpp"
#include "integers.hpp"
#include "entrepot.hpp"
#include "contextual.hpp"
#include "mem_ui.hpp"
 
namespace libdar
{
    // contextual is defined in generic_file module
 
 
 
    class trivial_sar : public generic_file, public contextual, protected mem_ui
    {
    public:
    trivial_sar(const std::shared_ptr<user_interaction> & dialog,   
            gf_mode open_mode,                 
            const std::string & base_name,     
            const std::string & extension,     
            const entrepot & where,            
            const label & internal_nale,       
            const label & data_name,           
            const std::string & execute,       
            bool allow_over,                   
            bool warn_over,                    
            bool force_permission,             
            U_I permission,                    
            hash_algo x_hash,                  
                const infinint & min_digits,       
            bool format_07_compatible          
        );
 
 
    trivial_sar(const std::shared_ptr<user_interaction> & dialog,   
            const std::string & pipename,      
            bool lax                           
        );
 
    trivial_sar(const std::shared_ptr<user_interaction> & dialog,  
            int filedescriptor,                
            bool lax                           
        );
 
    trivial_sar(const std::shared_ptr<user_interaction> & dialog, 
            generic_file * f, 
            const label & internal_name, 
            const label & data_name,     
            bool format_07_compatible,   
            const std::string & execute  
        );
 
    trivial_sar(const trivial_sar & ref) = delete;
 
    trivial_sar(trivial_sar && ref) noexcept = delete;
 
    trivial_sar & operator = (const trivial_sar & ref) = delete;
 
    trivial_sar & operator = (trivial_sar && ref) noexcept = delete;
 
    ~trivial_sar();
 
    virtual bool skippable(skippability direction, const infinint & amount) override { return reference->skippable(direction, amount); };
        virtual bool skip(const infinint & pos) override;
        virtual bool skip_to_eof() override { if(is_terminated()) throw SRC_BUG; return reference->skip_to_eof(); };
        virtual bool skip_relative(S_I x) override;
    virtual bool truncatable(const infinint & pos) const override { return reference->truncatable(offset + pos); };
        virtual infinint get_position() const override { return cur_pos; };
 
        // contextual inherited method
    virtual bool is_an_old_start_end_archive() const override { return old_sar; };
    virtual const label & get_data_name() const override { return of_data_name; };
 
    const infinint & get_slice_header_size() const { return offset; };
 
    void disable_natural_destruction() { natural_destruction = false; };
 
    void enable_natural_destruction() { natural_destruction = true; };
 
    protected:
    virtual void inherited_read_ahead(const infinint & amount) override { reference->read_ahead(amount); };
        virtual U_I inherited_read(char *a, U_I size) override;
        virtual void inherited_write(const char *a, U_I size) override;
    virtual void inherited_truncate(const infinint & pos) override { reference->truncate(pos + offset); cur_pos = pos; };
    virtual void inherited_sync_write() override { if(reference != nullptr) reference->sync_write(); };
    virtual void inherited_flush_read() override { if(reference != nullptr) reference->flush_read(); };
    virtual void inherited_terminate() override;
 
    private:
        generic_file *reference;  
        infinint offset;          
    infinint cur_pos;         
    infinint end_of_slice;    
    std::string hook;         
    std::string base;         
    std::string ext;          
    label of_data_name;       
    bool old_sar;             
    infinint min_digits;      
    std::string hook_where;   
    std::string base_url;     
    bool natural_destruction; 
 
    void init(const label & internal_name); 
 
    void where_am_i();
    };
 
 
    extern std::string sar_make_filename(const std::string & base_name, const infinint & num, const infinint & min_digits, const std::string & ext);
 
 
} // end of namespace
 
#endif