i_entrepot_libcurl.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2025 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 I_ENTREPOT_LIBCURL_HPP
#define I_ENTREPOT_LIBCURL_HPP
 
#include "../my_config.h"
 
extern "C"
{
#if LIBCURL_AVAILABLE
#if HAVE_CURL_CURL_H
#include <curl/curl.h>
#endif
#endif
}
 
#include <string>
#include <deque>
#include <map>
#include "entrepot_libcurl.hpp"
#include "secu_string.hpp"
#include "mem_ui.hpp"
#include "mycurl_easyhandle_sharing.hpp"
 
namespace libdar
{
 
 
 
#if defined ( LIBCURL_AVAILABLE ) && defined ( LIBTHREADAR_AVAILABLE )
 
    class entrepot_libcurl::i_entrepot_libcurl : public entrepot, public mem_ui
    {
    public:
    i_entrepot_libcurl(const std::shared_ptr<user_interaction> & dialog,         
               remote_entrepot_type proto,             
               const std::string & login,              
               const secu_string & password,      
               const std::string & host,               
               const std::string & port,               
               bool auth_from_file,               
               const std::string & sftp_pub_keyfile,   
               const std::string & sftp_prv_keyfile,   
               const std::string & sftp_known_hosts,   
               U_I waiting_time,                       
               bool verbose                           
        );
    i_entrepot_libcurl(const i_entrepot_libcurl & ref) = default;
    i_entrepot_libcurl(i_entrepot_libcurl && ref) = default;
    i_entrepot_libcurl & operator = (const i_entrepot_libcurl & ref) = delete;
    i_entrepot_libcurl & operator = (i_entrepot_libcurl && ref) noexcept = delete;
    ~i_entrepot_libcurl() throw () {};
 
 
        // inherited from class entrepot
 
    virtual std::string get_url() const override { return base_URL + get_full_path().display_without_root(); };
    virtual void change_user_interaction(const std::shared_ptr<user_interaction> & new_dialog) override { change_ui(new_dialog); };
    virtual std::shared_ptr<user_interaction> get_current_user_interaction() const override { return get_pointer(); };
    virtual void read_dir_reset() const override { set_current_dir(false); };
    virtual bool read_dir_next(std::string & filename) const override;
    virtual void read_dir_reset_dirinfo() const override { set_current_dir(true); };
    virtual bool read_dir_next_dirinfo(std::string & filename, inode_type &tp) const override;
 
    virtual void create_dir(const std::string & dirname, U_I permission) override;
 
    virtual entrepot *clone() const override { return new (std::nothrow) i_entrepot_libcurl(*this); };
 
    protected:
 
        // inherited from class entrepot
 
    virtual fichier_global *inherited_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) const override;
 
    virtual void inherited_unlink(const std::string & filename) const override;
    virtual void read_dir_flush() const override;
 
    private:
    remote_entrepot_type x_proto;
    std::string base_URL; 
    mutable mycurl_easyhandle_sharing easyh;
    mutable std::map<std::string, inode_type> current_dir; 
    mutable std::string reading_dir_tmp;                   
    mutable std::deque<std::string> temporary_list;        
    mutable std::map<std::string, inode_type>::const_iterator cur_dir_cursor; 
    U_I wait_delay;
    bool verbosity;
    mutable bool withdirinfo; 
 
    std::string get_libcurl_URL() const;
    void set_libcurl_authentication(user_interaction & dialog,         
                    const std::string & location,      
                    const std::string & login,         
                    const secu_string & password,      
                    bool auth_from_file,               
                    const std::string & sftp_pub_keyfile,  
                    const std::string & sftp_prv_keyfile,  
                    const std::string & sftp_known_hosts   
        );
 
    void fill_temporary_list() const;   
    void update_current_dir_with_line(const std::string & line) const; 
    void set_current_dir(bool details) const;  
 
 
    static std::string mycurl_protocol2string(remote_entrepot_type proto);
    static std::string build_url_from(remote_entrepot_type proto, const std::string & host, const std::string & port);
    static size_t get_ftp_listing_callback(void *buffer, size_t size, size_t nmemb, void *userp);
    static size_t null_callback(void *buffer, size_t size, size_t nmemb, void *userp) { return size*nmemb; };
    static bool mycurl_is_protocol_available(remote_entrepot_type proto);
 
        // needed to access the entrepot inherited protected methods
    friend class entrepot_libcurl;
    };
 
#endif
 
} // end of namespace
 
#endif