2008-07-02 09:19:59 -04:00
|
|
|
/*
|
|
|
|
* libretroshare/src/ft: ftcontroller.h
|
|
|
|
*
|
|
|
|
* File Transfer for RetroShare.
|
|
|
|
*
|
|
|
|
* Copyright 2008 by Robert Fernie.
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Library General Public
|
|
|
|
* License Version 2 as published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* This library 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
|
|
|
|
* Library General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Library General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
|
|
* USA.
|
|
|
|
*
|
|
|
|
* Please report all bugs and problems to "retroshare@lunamutt.com".
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef FT_CONTROLLER_HEADER
|
|
|
|
#define FT_CONTROLLER_HEADER
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ftController
|
|
|
|
*
|
|
|
|
* Top level download controller.
|
|
|
|
*
|
|
|
|
* inherits configuration (save downloading files)
|
|
|
|
* inherits pqiMonitor (knows which peers are online).
|
|
|
|
* inherits CacheTransfer (transfers cache files too)
|
|
|
|
* inherits RsThread (to control transfers)
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2008-08-03 08:45:53 -04:00
|
|
|
class ftFileCreator;
|
|
|
|
class ftTransferModule;
|
|
|
|
class ftFileProvider;
|
2008-08-09 13:03:24 -04:00
|
|
|
class ftSearch;
|
|
|
|
class ftDataMultiplex;
|
|
|
|
|
|
|
|
#include "dbase/cachestrapper.h"
|
|
|
|
#include "util/rsthreads.h"
|
|
|
|
#include "pqi/pqimonitor.h"
|
|
|
|
#include "pqi/p3cfgmgr.h"
|
|
|
|
|
|
|
|
#include "rsiface/rsfiles.h"
|
|
|
|
|
|
|
|
#include <map>
|
|
|
|
|
|
|
|
class ftFileControl
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
2008-09-11 06:33:43 -04:00
|
|
|
enum {DOWNLOADING,COMPLETED};
|
|
|
|
|
2008-08-09 13:03:24 -04:00
|
|
|
ftFileControl();
|
|
|
|
ftFileControl(std::string fname, uint64_t size, std::string hash,
|
|
|
|
uint32_t flags, ftFileCreator *fc, ftTransferModule *tm);
|
|
|
|
|
|
|
|
ftTransferModule * mTransfer;
|
|
|
|
ftFileCreator * mCreator;
|
|
|
|
uint32_t mState;
|
|
|
|
std::string mHash;
|
|
|
|
std::string mName;
|
|
|
|
uint64_t mSize;
|
2008-08-17 11:23:11 -04:00
|
|
|
uint32_t mFlags;
|
2008-08-09 13:03:24 -04:00
|
|
|
};
|
|
|
|
|
2008-08-03 08:45:53 -04:00
|
|
|
|
2008-07-02 09:19:59 -04:00
|
|
|
class ftController: public CacheTransfer, public RsThread, public pqiMonitor, public p3Config
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
/* Setup */
|
2008-08-09 13:03:24 -04:00
|
|
|
ftController(CacheStrapper *cs, ftDataMultiplex *dm, std::string configDir);
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
void setFtSearch(ftSearch *);
|
|
|
|
|
|
|
|
virtual void run();
|
|
|
|
|
|
|
|
/***************************************************************/
|
|
|
|
/********************** Controller Access **********************/
|
|
|
|
/***************************************************************/
|
|
|
|
|
|
|
|
bool FileRequest(std::string fname, std::string hash,
|
2008-07-23 18:01:59 -04:00
|
|
|
uint64_t size, std::string dest, uint32_t flags,
|
2008-08-09 13:03:24 -04:00
|
|
|
std::list<std::string> &sourceIds);
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
bool FileCancel(std::string hash);
|
|
|
|
bool FileControl(std::string hash, uint32_t flags);
|
|
|
|
bool FileClearCompleted();
|
2008-09-11 06:33:43 -04:00
|
|
|
bool completeFile(std::string hash);
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
/* get Details of File Transfers */
|
|
|
|
bool FileDownloads(std::list<std::string> &hashs);
|
|
|
|
|
|
|
|
/* Directory Handling */
|
2008-07-23 18:01:59 -04:00
|
|
|
bool setDownloadDirectory(std::string path);
|
|
|
|
bool setPartialsDirectory(std::string path);
|
2008-07-02 09:19:59 -04:00
|
|
|
std::string getDownloadDirectory();
|
|
|
|
std::string getPartialsDirectory();
|
|
|
|
bool FileDetails(std::string hash, FileInfo &info);
|
|
|
|
|
2008-08-17 11:23:11 -04:00
|
|
|
/***************************************************************/
|
|
|
|
/********************** Cache Transfer *************************/
|
|
|
|
/***************************************************************/
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual bool RequestCacheFile(RsPeerId id, std::string path, std::string hash, uint64_t size);
|
|
|
|
virtual bool CancelCacheFile(RsPeerId id, std::string path, std::string hash, uint64_t size);
|
|
|
|
|
2008-07-02 09:19:59 -04:00
|
|
|
/***************************************************************/
|
|
|
|
/********************** Controller Access **********************/
|
|
|
|
/***************************************************************/
|
|
|
|
|
|
|
|
/* pqiMonitor callback (also provided mConnMgr pointer!) */
|
|
|
|
public:
|
|
|
|
virtual void statusChange(const std::list<pqipeer> &plist);
|
|
|
|
|
|
|
|
|
|
|
|
/* p3Config Interface */
|
|
|
|
protected:
|
|
|
|
virtual RsSerialiser *setupSerialiser();
|
|
|
|
virtual std::list<RsItem *> saveList(bool &cleanup);
|
|
|
|
virtual bool loadList(std::list<RsItem *> load);
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
/* RunTime Functions */
|
2008-08-09 13:03:24 -04:00
|
|
|
void checkDownloadQueue();
|
2008-09-11 06:33:43 -04:00
|
|
|
//bool completeFile(std::string hash);
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
/* pointers to other components */
|
|
|
|
|
|
|
|
ftSearch *mSearch;
|
2008-08-09 13:03:24 -04:00
|
|
|
ftDataMultiplex *mDataplex;
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
RsMutex ctrlMutex;
|
|
|
|
|
2008-08-03 08:45:53 -04:00
|
|
|
std::list<FileInfo> incomingQueue;
|
2008-09-11 06:33:43 -04:00
|
|
|
std::map<std::string, ftFileControl> mCompleted;
|
2008-07-02 09:19:59 -04:00
|
|
|
|
2008-08-09 13:03:24 -04:00
|
|
|
|
|
|
|
std::map<std::string, ftFileControl> mDownloads;
|
|
|
|
|
|
|
|
//std::map<std::string, ftTransferModule *> mTransfers;
|
|
|
|
//std::map<std::string, ftFileCreator *> mFileCreators;
|
2008-07-02 09:19:59 -04:00
|
|
|
|
|
|
|
std::string mConfigPath;
|
|
|
|
std::string mDownloadPath;
|
|
|
|
std::string mPartialPath;
|
2008-08-17 11:23:11 -04:00
|
|
|
|
|
|
|
/**** SPEED QUEUES ****/
|
|
|
|
std::list<std::string> mSlowQueue;
|
|
|
|
std::list<std::string> mStreamQueue;
|
|
|
|
std::list<std::string> mFastQueue;
|
2008-07-02 09:19:59 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
2008-08-17 11:23:11 -04:00
|
|
|
|
|
|
|
#if 0
|
|
|
|
class CacheTransfer
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
CacheTransfer(CacheStrapper *cs) :strapper(cs) { return; }
|
|
|
|
virtual ~CacheTransfer() {}
|
|
|
|
|
|
|
|
/* upload side of things .... searches through CacheStrapper. */
|
|
|
|
bool FindCacheFile(std::string hash, std::string &path, uint64_t &size);
|
|
|
|
|
|
|
|
|
|
|
|
/* At the download side RequestCache() => overloaded RequestCacheFile()
|
|
|
|
* the class should then call CompletedCache() or FailedCache()
|
|
|
|
*/
|
|
|
|
|
|
|
|
bool RequestCache(CacheData &data, CacheStore *cbStore); /* request from CacheStore */
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/* to be overloaded */
|
|
|
|
virtual bool RequestCacheFile(RsPeerId id, std::string path, std::string hash, uint64_t size);
|
|
|
|
virtual bool CancelCacheFile(RsPeerId id, std::string path, std::string hash, uint64_t size);
|
|
|
|
|
|
|
|
bool CompletedCache(std::string hash); /* internal completion -> does cb */
|
|
|
|
bool FailedCache(std::string hash); /* internal completion -> does cb */
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
CacheStrapper *strapper;
|
|
|
|
|
|
|
|
std::map<std::string, CacheData> cbData;
|
|
|
|
std::map<std::string, CacheStore *> cbStores;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|