1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/***************************************************************************
* Copyright (C) 2005 by Joris Guisson *
* joris.guisson@gmail.com *
* *
* 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. *
***************************************************************************/
#ifndef BTCACHE_H
#define BTCACHE_H
#include <kio/job.h>
class TQStringList;
namespace bt
{
class Torrent;
class TorrentFile;
class Chunk;
class PreallocationThread;
/**
* @author Joris Guisson
* @brief Manages the temporary data
*
* Interface for a class which manages downloaded data.
* Subclasses should implement the load and save methods.
*/
class Cache
{
protected:
Torrent & tor;
TQString tmpdir;
TQString datadir;
bool preexisting_files;
Uint32 mmap_failures;
public:
Cache(Torrent & tor,const TQString & tmpdir,const TQString & datadir);
virtual ~Cache();
/// Get the datadir
TQString getDataDir() const {return datadir;}
/**
* Get the actual output path.
* @return The output path
*/
virtual TQString getOutputPath() const = 0;
/**
* Changes the tmp dir. All data files should already been moved.
* This just modifies the tmpdir variable.
* @param ndir The new tmpdir
*/
virtual void changeTmpDir(const TQString & ndir);
/**
* Move the data files to a new directory.
* @param ndir The directory
* @return The KIO::Job doing the move
*/
virtual KIO::Job* moveDataFiles(const TQString & ndir) = 0;
/**
* The move data files job is done.
* @param job The job that did it
*/
virtual void moveDataFilesCompleted(KIO::Job* job) = 0;
/**
* Changes output path. All data files should already been moved.
* This just modifies the datadir variable.
* @param outputpath New output path
*/
virtual void changeOutputPath(const TQString & outputpath) = 0;
/**
* Load a chunk into memory. If something goes wrong,
* an Error should be thrown.
* @param c The Chunk
*/
virtual void load(Chunk* c) = 0;
/**
* Save a chunk to disk. If something goes wrong,
* an Error should be thrown.
* @param c The Chunk
*/
virtual void save(Chunk* c) = 0;
/**
* Prepare a chunk for downloading.
* @param c The Chunk
* @return true if ok, false otherwise
*/
virtual bool prep(Chunk* c) = 0;
/**
* Create all the data files to store the data.
*/
virtual void create() = 0;
/**
* Close the cache file(s).
*/
virtual void close() = 0;
/**
* Open the cache file(s)
*/
virtual void open() = 0;
/// Does nothing, can be overridden to be alerted of download status changes of a TorrentFile
virtual void downloadStatusChanged(TorrentFile*, bool) {};
/**
* Preallocate diskspace for all files
* @param prealloc The thread doing the preallocation
*/
virtual void preallocateDiskSpace(PreallocationThread* prealloc) = 0;
/// See if the download has existing files
bool hasExistingFiles() const {return preexisting_files;}
/**
* Test all files and see if they are not missing.
* If so put them in a list
*/
virtual bool hasMissingFiles(TQStringList & sl) = 0;
/**
* Delete all data files, in case of multi file torrents
* empty directories should also be deleted.
*/
virtual void deleteDataFiles() = 0;
/**
* See if we are allowed to use mmap, when loading chunks.
* This will return false if we are close to system limits.
*/
static bool mappedModeAllowed();
/**
* Get the number of bytes all the files of this torrent are currently using on disk.
* */
virtual Uint64 diskUsage() = 0;
};
}
#endif
|
