/* Copyright (c) 2003-2014, Arvid Norberg All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef TORRENT_FILE_HPP_INCLUDED #define TORRENT_FILE_HPP_INCLUDED #include #include #ifdef _MSC_VER #pragma warning(push, 1) #endif #include #ifdef _MSC_VER #pragma warning(pop) #endif #include "libtorrent/error_code.hpp" #include "libtorrent/size_type.hpp" #include "libtorrent/config.hpp" #include "libtorrent/intrusive_ptr_base.hpp" #ifdef TORRENT_WINDOWS // windows part #ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN #endif #include #include #include #else // posix part #define _FILE_OFFSET_BITS 64 #ifndef _GNU_SOURCE #define _GNU_SOURCE #endif #ifndef _XOPEN_SOURCE #define _XOPEN_SOURCE 600 #endif #include #include #include #include #include // for DIR #undef _FILE_OFFSET_BITS #endif namespace libtorrent { struct file_status { size_type file_size; boost::uint64_t atime; boost::uint64_t mtime; boost::uint64_t ctime; enum { #if defined TORRENT_WINDOWS fifo = 0x1000, // named pipe (fifo) character_special = 0x2000, // character special directory = 0x4000, // directory regular_file = 0x8000 // regular #else fifo = 0010000, // named pipe (fifo) character_special = 0020000, // character special directory = 0040000, // directory block_special = 0060000, // block special regular_file = 0100000, // regular link = 0120000, // symbolic link socket = 0140000 // socket #endif } modes_t; int mode; }; // internal flags for stat_file enum { dont_follow_links = 1 }; TORRENT_EXTRA_EXPORT void stat_file(std::string f, file_status* s , error_code& ec, int flags = 0); TORRENT_EXTRA_EXPORT void rename(std::string const& f , std::string const& newf, error_code& ec); TORRENT_EXTRA_EXPORT void create_directories(std::string const& f , error_code& ec); TORRENT_EXTRA_EXPORT void create_directory(std::string const& f , error_code& ec); TORRENT_EXTRA_EXPORT void remove_all(std::string const& f , error_code& ec); TORRENT_EXTRA_EXPORT void remove(std::string const& f, error_code& ec); TORRENT_EXTRA_EXPORT bool exists(std::string const& f); TORRENT_EXTRA_EXPORT size_type file_size(std::string const& f); TORRENT_EXTRA_EXPORT bool is_directory(std::string const& f , error_code& ec); TORRENT_EXTRA_EXPORT void recursive_copy(std::string const& old_path , std::string const& new_path, error_code& ec); TORRENT_EXTRA_EXPORT void copy_file(std::string const& f , std::string const& newf, error_code& ec); TORRENT_EXTRA_EXPORT std::string split_path(std::string const& f); TORRENT_EXTRA_EXPORT char const* next_path_element(char const* p); TORRENT_EXTRA_EXPORT std::string extension(std::string const& f); TORRENT_EXTRA_EXPORT std::string remove_extension(std::string const& f); TORRENT_EXTRA_EXPORT void replace_extension(std::string& f, std::string const& ext); TORRENT_EXTRA_EXPORT bool is_root_path(std::string const& f); // internal used by create_torrent.hpp TORRENT_EXPORT std::string parent_path(std::string const& f); TORRENT_EXTRA_EXPORT bool has_parent_path(std::string const& f); // internal used by create_torrent.hpp TORRENT_EXPORT std::string filename(std::string const& f); TORRENT_EXTRA_EXPORT std::string combine_path(std::string const& lhs , std::string const& rhs); // internal used by create_torrent.hpp TORRENT_EXPORT std::string complete(std::string const& f); TORRENT_EXTRA_EXPORT bool is_complete(std::string const& f); TORRENT_EXTRA_EXPORT std::string current_working_directory(); #if TORRENT_USE_UNC_PATHS TORRENT_EXTRA_EXPORT std::string canonicalize_path(std::string const& f); #endif class TORRENT_EXTRA_EXPORT directory : public boost::noncopyable { public: directory(std::string const& path, error_code& ec); ~directory(); void next(error_code& ec); std::string file() const; boost::uint64_t inode() const; bool done() const { return m_done; } private: #ifdef TORRENT_WINDOWS HANDLE m_handle; int m_inode; #if TORRENT_USE_WSTRING WIN32_FIND_DATAW m_fd; #else WIN32_FIND_DATAA m_fd; #endif #else DIR* m_handle; // the dirent struct contains a zero-sized // array at the end, it will end up referring // to the m_name field struct dirent m_dirent; char m_name[TORRENT_MAX_PATH + 1]; // +1 to make room for null #endif bool m_done; }; struct TORRENT_EXTRA_EXPORT file: boost::noncopyable, intrusive_ptr_base { // the open mode for files. Used for the file constructor or // file::open(). enum open_mode_t { // open the file for reading only read_only = 0, // open the file for writing only write_only = 1, // open the file for reading and writing read_write = 2, // the mask for the bits determining read or write mode rw_mask = read_only | write_only | read_write, // indicate that the file should be opened in // *direct io* mode, i.e. bypassing the operating // system's disk cache, or as much as possible of it // depending on the system. // when a file is opened with no_buffer, // file offsets have to be aligned to // pos_alignment() and buffer addresses // to buf_alignment() and read/write sizes // to size_alignment() no_buffer = 4, // open the file in sparse mode (if supported by the // filesystem). sparse = 8, // don't update the access timestamps on the file (if // supported by the operating system and filesystem). // this generally improves disk performance. no_atime = 16, // open the file for random acces. This disables read-ahead // logic random_access = 32, // prevent the file from being opened by another process // while it's still being held open by this handle lock_file = 64, // when creating a file, set the hidden attribute (windows only) attribute_hidden = 0x1000, // when creating a file, set the executable attribute attribute_executable = 0x2000, // the mask of all attribute bits attribute_mask = attribute_hidden | attribute_executable }; #ifdef TORRENT_WINDOWS struct iovec_t { void* iov_base; size_t iov_len; }; #else typedef iovec iovec_t; #endif // use a typedef for the type of iovec_t::iov_base // since it may differ #ifdef TORRENT_SOLARIS typedef char* iovec_base_t; #else typedef void* iovec_base_t; #endif file(); file(std::string const& p, int m, error_code& ec); ~file(); bool open(std::string const& p, int m, error_code& ec); bool is_open() const; void close(); bool set_size(size_type size, error_code& ec); int open_mode() const { return m_open_mode; } // when opened in unbuffered mode, this is the // required alignment of file_offsets. i.e. // any (file_offset & (pos_alignment()-1)) == 0 // is a precondition to read and write operations int pos_alignment() const; // when opened in unbuffered mode, this is the // required alignment of buffer addresses int buf_alignment() const; // read/write buffer sizes needs to be aligned to // this when in unbuffered mode int size_alignment() const; size_type writev(size_type file_offset, iovec_t const* bufs, int num_bufs, error_code& ec); size_type readv(size_type file_offset, iovec_t const* bufs, int num_bufs, error_code& ec); void hint_read(size_type file_offset, int len); size_type get_size(error_code& ec) const; // return the offset of the first byte that // belongs to a data-region size_type sparse_end(size_type start) const; size_type phys_offset(size_type offset); #ifdef TORRENT_WINDOWS HANDLE native_handle() const { return m_file_handle; } #else int native_handle() const { return m_fd; } #endif private: #ifdef TORRENT_WINDOWS HANDLE m_file_handle; #if TORRENT_USE_WSTRING std::wstring m_path; #else std::string m_path; #endif // TORRENT_USE_WSTRING #else // TORRENT_WINDOWS int m_fd; #endif // TORRENT_WINDOWS #if defined TORRENT_WINDOWS || defined TORRENT_LINUX || defined TORRENT_DEBUG static void init_file(); static int m_page_size; #endif int m_open_mode; #if defined TORRENT_WINDOWS || defined TORRENT_LINUX mutable int m_sector_size; #endif #if defined TORRENT_WINDOWS mutable int m_cluster_size; static bool has_manage_volume_privs; #endif }; } #endif // TORRENT_FILE_HPP_INCLUDED