premiere-libtorrent/include/libtorrent/storage.hpp

191 lines
5.5 KiB
C++
Raw Normal View History

/*
Copyright (c) 2003, 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_STORAGE_HPP_INCLUDE
#define TORRENT_STORAGE_HPP_INCLUDE
2003-12-10 01:39:47 +01:00
#include <vector>
2004-01-24 18:14:03 +01:00
#include <bitset>
#ifdef _MSC_VER
#pragma warning(push, 1)
#endif
#include <boost/limits.hpp>
#include <boost/filesystem/path.hpp>
2003-10-31 05:02:51 +01:00
#include <boost/thread.hpp>
2004-04-14 14:14:28 +02:00
#include <boost/shared_ptr.hpp>
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#include "libtorrent/torrent_info.hpp"
#include "libtorrent/config.hpp"
namespace libtorrent
{
namespace aux
2003-10-30 00:28:09 +01:00
{
2004-01-05 00:51:54 +01:00
struct piece_checker_data;
2003-10-30 00:28:09 +01:00
}
2004-01-17 21:04:19 +01:00
class session;
struct file_pool;
2006-02-18 01:21:13 +01:00
#if defined(_WIN32) && defined(UNICODE)
TORRENT_EXPORT std::wstring safe_convert(std::string const& s);
2006-02-18 01:21:13 +01:00
#endif
TORRENT_EXPORT std::vector<std::pair<size_type, std::time_t> > get_filesizes(
2004-10-10 02:42:48 +02:00
torrent_info const& t
, boost::filesystem::path p);
2004-01-17 21:04:19 +01:00
TORRENT_EXPORT bool match_filesizes(
2004-10-10 02:42:48 +02:00
torrent_info const& t
, boost::filesystem::path p
2005-06-16 17:41:04 +02:00
, std::vector<std::pair<size_type, std::time_t> > const& sizes
, std::string* error = 0);
2004-01-17 21:04:19 +01:00
struct TORRENT_EXPORT file_allocation_failed: std::exception
{
file_allocation_failed(const char* error_msg): m_msg(error_msg) {}
virtual const char* what() const throw() { return m_msg.c_str(); }
2004-01-13 04:08:59 +01:00
virtual ~file_allocation_failed() throw() {}
std::string m_msg;
};
struct TORRENT_EXPORT storage_interface
2003-12-07 02:26:57 +01:00
{
// create directories and set file sizes
// if allocate_files is true.
// allocate_files is true if allocation mode
// is set to full and sparse files are supported
virtual void initialize(bool allocate_files) = 0;
// may throw file_error if storage for slot does not exist
virtual size_type read(char* buf, int slot, int offset, int size) = 0;
// may throw file_error if storage for slot hasn't been allocated
virtual void write(const char* buf, int slot, int offset, int size) = 0;
2003-12-07 02:26:57 +01:00
virtual bool move_storage(boost::filesystem::path save_path) = 0;
2004-07-18 02:39:58 +02:00
virtual bool verify_resume_data(entry& rd, std::string& error) = 0;
virtual void move_slot(int src_slot, int dst_slot) = 0;
2004-12-21 13:30:09 +01:00
// this will close all open files that are opened for
// writing. This is called when a torrent has finished
// downloading.
virtual void release_files() = 0;
virtual ~storage_interface() {}
};
2004-12-21 13:30:09 +01:00
typedef storage_interface* (&storage_constructor_type)(
torrent_info const&, boost::filesystem::path const&
, file_pool&);
2004-01-27 00:38:08 +01:00
TORRENT_EXPORT storage_interface* default_storage_constructor(torrent_info const& ti
, boost::filesystem::path const& path, file_pool& fp);
2003-12-07 02:26:57 +01:00
// returns true if the filesystem the path relies on supports
// sparse files or automatic zero filling of files.
TORRENT_EXPORT bool supports_sparse_files(boost::filesystem::path const& p);
class TORRENT_EXPORT piece_manager : boost::noncopyable
2003-11-26 15:11:25 +01:00
{
public:
2003-12-07 02:26:57 +01:00
piece_manager(
const torrent_info& info
, const boost::filesystem::path& path
, file_pool& fp
, storage_constructor_type sc);
2003-12-07 02:26:57 +01:00
2004-01-04 13:54:38 +01:00
~piece_manager();
bool check_fastresume(aux::piece_checker_data& d
, std::vector<bool>& pieces, int& num_pieces, bool compact_mode);
std::pair<bool, float> check_files(std::vector<bool>& pieces
, int& num_pieces, boost::recursive_mutex& mutex);
2003-12-07 02:26:57 +01:00
2005-03-10 12:26:55 +01:00
void release_files();
2004-12-21 13:30:09 +01:00
bool verify_resume_data(entry& rd, std::string& error);
bool is_allocating() const;
bool allocate_slots(int num_slots, bool abort_on_disk = false);
2004-01-12 04:05:10 +01:00
void mark_failed(int index);
2003-12-07 02:26:57 +01:00
2004-01-24 18:14:03 +01:00
unsigned long piece_crc(
int slot_index
, int block_size
, const std::bitset<256>& bitmask);
int slot_for_piece(int piece_index) const;
size_type read(
char* buf
, int piece_index
, int offset
, int size);
void write(
const char* buf
, int piece_index
, int offset
, int size);
2003-12-07 06:53:04 +01:00
2004-07-18 02:39:58 +02:00
boost::filesystem::path const& save_path() const;
bool move_storage(boost::filesystem::path const&);
2003-11-26 15:11:25 +01:00
2003-12-27 02:34:50 +01:00
// fills the vector that maps all allocated
// slots to the piece that is stored (or
2004-01-02 21:46:24 +01:00
// partially stored) there. -2 is the index
// of unassigned pieces and -1 is unallocated
2003-12-27 02:34:50 +01:00
void export_piece_map(std::vector<int>& pieces) const;
2003-12-25 13:11:31 +01:00
2007-04-17 23:54:40 +02:00
bool compact_allocation() const;
2003-11-26 15:11:25 +01:00
private:
class impl;
2004-01-04 13:54:38 +01:00
std::auto_ptr<impl> m_pimpl;
};
}
#endif // TORRENT_STORAGE_HPP_INCLUDED
2003-11-26 15:11:25 +01:00