//  Copyright (c) 2008 Andre Merzky <andre@merzky.net>
// 
//  Distributed under the Boost Software License, 
//  Version 1.0. (See accompanying LICENSE file 
//  or copy at http://www.boost.org/LICENSE_1_0.txt)

#ifndef ADAPTORS_SSH_FILE_ADAPTOR_FILE_HPP
#define ADAPTORS_SSH_FILE_ADAPTOR_FILE_HPP

#include <saga/saga/adaptors/adaptor.hpp>
#include <saga/saga/adaptors/adaptor_data.hpp>
// #include <saga/saga/adaptors/adaptor_suite_data.hpp>

#include <saga/impl/packages/filesystem/file_cpi.hpp>

#include "ssh_file_adaptor.hpp"
#include "ssh_file_adaptor_sshfs.hpp"

// #include "ssh_suite.hpp"

////////////////////////////////////////////////////////////////////////////////
//
namespace ssh_filesystem_adaptor 
{
  class filesystem_adaptor;

  /**
   * This adaptor class implements the functionality of the Saga API "directory".
   * It defines the functions declared in its base class, directory_cpi.
   *
   * @note some notes
   *
   * @see The documentation of the Saga API 
   */  
  class file_cpi_impl : public saga::adaptors::v1_0::file_cpi<file_cpi_impl>
  {
    private:
      typedef saga::adaptors::v1_0::file_cpi<file_cpi_impl> file_cpi;


      /* instance data */
      typedef saga::adaptors::v1_0::file_cpi_instance_data 
                                                  instance_data_type;
      friend class saga::adaptors::instance_data <instance_data_type>;
      typedef      saga::adaptors::instance_data <instance_data_type> 
                                                  file_instance_data_t;

      /* adaptor data */
      typedef saga::adaptors::adaptor_data       <filesystem_adaptor> 
                                                  adaptor_instance_data_t;

      /* adaptor suite data */
      /// typedef saga::adaptors::adaptor_suite_data <filesystem_adaptor, ssh::suite> 
      ///                                             suite_instance_data_t;


      boost::shared_ptr <file_cpi_impl> shared_from_this (void)
      {
        return boost::shared_ptr <file_cpi_impl> (this->base_type::shared_from_this (),
                                                  boost::detail::static_cast_tag ());
      }


      // state
      saga::session          s_;         // session
      saga::filesystem::file f_;         // proxy entry


    public:
      file_cpi_impl (proxy                * p, 
                     cpi_info       const & info,
                     saga::ini::ini const & glob_ini,
                     saga::ini::ini const & adap_ini,
                     boost::shared_ptr <saga::adaptor> adaptor);

      ~file_cpi_impl (void);

      // initialize cpi state, from instance data
      void init (void);


      ///////////////////////////////////////////////////////////////////////////
      ///////////////////////// NAMESPACE::ENTRY METHODS ////////////////////////
      ///////////////////////////////////////////////////////////////////////////

      void sync_get_url   (saga::url                   & url); 
      void sync_get_cwd   (saga::url                   & cwd); 
      void sync_get_name  (saga::url                   & name); 

      void sync_is_dir    (bool                        & is_dir);      
      void sync_is_entry  (bool                        & is_file);   
      void sync_is_link   (bool                        & is_link);      
      void sync_read_link (saga::url                   & target); 

      void sync_copy      (saga::impl::void_t          & ret,   
                           saga::url                     target, 
                           int                           flags = saga::filesystem::None);
      void sync_link      (saga::impl::void_t          & ret,    
                           saga::url                     dest, 
                           int                           flags = saga::filesystem::None);
      void sync_move      (saga::impl::void_t          & ret,   
                           saga::url                     dest, 
                           int                           flags = saga::filesystem::None);
      void sync_remove    (saga::impl::void_t          & ret,
                           int                           flags = saga::filesystem::None);  

      void sync_close     (saga::impl::void_t          & ret, 
                           double                        timeout = 0.0); 

      ///////////////////////////////////////////////////////////////////////////
      ////////////////////////// FILESYSTEM::FILE METHODS ///////////////////////
      ///////////////////////////////////////////////////////////////////////////

      void sync_get_size  (saga::off_t                 & size_out);
      void sync_read      (saga::ssize_t               & len_out,
                           saga::mutable_buffer          data, 
                           saga::ssize_t                 len_in);
      void sync_write     (saga::ssize_t               & len_out,
                           saga::const_buffer            data,
                           saga::ssize_t                 len_in);
      void sync_seek      (saga::off_t                 & out,
                           saga::off_t                   offset,
                           saga::filesystem::seek_mode   whence);


      ///////////////////////////////////////////////////////////////////////////
      /////////////////////// PERMISSION INTERFACE METHODS //////////////////////
      ///////////////////////////////////////////////////////////////////////////

      void sync_permissions_allow (saga::impl::void_t  & ret,
                                   std::string           id,
                                   int                   perm, 
                                   int                   flags);
      void sync_permissions_deny  (saga::impl::void_t & ret,
                                   std::string          id,
                                   int                  perm, 
                                   int                  flags);
      void sync_permissions_check (bool               & ret,
                                   std::string          id,
                                   int                  perm);
      void sync_get_owner         (std::string        & out);
      void sync_get_group         (std::string        & out);    

  }; // class file_cpi_impl

} // namespace ssh_filesystem_adaptor

#endif // ADAPTORS_SSH_FILE_ADAPTOR_FILE_HPP