src/updownclient.h

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   5 // Copyright (c) 2002-2008 Merkur ( devs@emule-project.net / http://www.emule-project.net )
   6 //
   7 // Any parts of this program derived from the xMule, lMule or eMule project,
   8 // or contributed by third-party developers are copyrighted by their
   9 // respective authors.
  10 //
  11 // This program is free software; you can redistribute it and/or modify
  12 // it under the terms of the GNU General Public License as published by
  13 // the Free Software Foundation; either version 2 of the License, or
  14 // (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 // GNU General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  24 //
  25
  26 #ifndef UPDOWNCLIENT_H
  27 #define UPDOWNCLIENT_H
  28
  29 #include "GetTickCount.h"       // Needed for GetTickCount
  30 #include "MD4Hash.h"
  31 #include <common/StringFunctions.h>
  32 #include "NetworkFunctions.h"
  33 #include "OtherStructs.h"
  34
  35 #include <map>
  36
  37
  38 typedef std::vector<bool> BitVector;
  39
  40 class CPartFile;
  41 class CClientTCPSocket;
  42 class CClientCredits;
  43 class CPacket;
  44 class CFriend;
  45 class CKnownFile;
  46 class CMemFile;
  47 class CAICHHash;
  48
  49
  50 // uploadstate
  51 #define US_UPLOADING            0
  52 #define US_ONUPLOADQUEUE        1
  53 #define US_WAITCALLBACK         2
  54 #define US_CONNECTING           3
  55 #define US_PENDING              4
  56 #define US_LOWTOLOWIP           5
  57 #define US_BANNED               6
  58 #define US_ERROR                7
  59 #define US_NONE                 8
  60
  61 // downloadstate
  62 enum EDownloadState {
  63         DS_DOWNLOADING = 0,
  64         DS_ONQUEUE,
  65         DS_CONNECTED,
  66         DS_CONNECTING,
  67         DS_WAITCALLBACK,
  68         DS_WAITCALLBACKKAD,
  69         DS_REQHASHSET,
  70         DS_NONEEDEDPARTS,
  71         DS_TOOMANYCONNS,
  72         DS_TOOMANYCONNSKAD,
  73         DS_LOWTOLOWIP,
  74         DS_BANNED,
  75         DS_ERROR,
  76         DS_NONE,
  77         DS_REMOTEQUEUEFULL  // not used yet, except in statistics
  78 };
  79
  80 // m_byChatstate
  81 enum {
  82         MS_NONE = 0,
  83         MS_CHATTING,
  84         MS_CONNECTING,
  85         MS_UNABLETOCONNECT
  86 };
  87
  88 enum ESourceFrom {
  89         SF_NONE,
  90         SF_LOCAL_SERVER,
  91         SF_REMOTE_SERVER,
  92         SF_KADEMLIA,
  93         SF_SOURCE_EXCHANGE,
  94         SF_PASSIVE,
  95         SF_LINK,
  96         SF_SOURCE_SEEDS,
  97         SF_SEARCH_RESULT
  98 };
  99
 100 enum EChatCaptchaState{
 101         CA_NONE                         = 0,
 102         CA_CHALLENGESENT,
 103         CA_CAPTCHASOLVED,
 104         CA_ACCEPTING,
 105         CA_CAPTCHARECV,
 106         CA_SOLUTIONSENT
 107 };
 108
 109 enum ESecureIdentState{
 110         IS_UNAVAILABLE          = 0,
 111         IS_ALLREQUESTSSEND      = 0,
 112         IS_SIGNATURENEEDED      = 1,
 113         IS_KEYANDSIGNEEDED      = 2
 114 };
 115
 116 enum EInfoPacketState{
 117         IP_NONE                 = 0,
 118         IP_EDONKEYPROTPACK      = 1,
 119         IP_EMULEPROTPACK        = 2,
 120         IP_BOTH                 = 3
 121 };
 122
 123 enum EKadState{
 124         KS_NONE,
 125         KS_QUEUED_FWCHECK,
 126         KS_CONNECTING_FWCHECK,
 127         KS_CONNECTED_FWCHECK,
 128         KS_QUEUED_BUDDY,
 129         KS_INCOMING_BUDDY,
 130         KS_CONNECTING_BUDDY,
 131         KS_CONNECTED_BUDDY,
 132         KS_QUEUED_FWCHECK_UDP,
 133         KS_FWCHECK_UDP,
 134         KS_CONNECTING_FWCHECK_UDP
 135 };
 136
 137 //! Used to keep track of the state of the client
 138 enum ClientState
 139 {
 140         //! New is for clients that have just been created.
 141         CS_NEW = 0,
 142         //! Listed is for clients that are on the clientlist
 143         CS_LISTED,
 144         //! Dying signifies clients that have been queued for deletion
 145         CS_DYING
 146 };
 147
 148 // This is fixed on ed2k v1, but can be any number on ED2Kv2
 149 #define STANDARD_BLOCKS_REQUEST 3
 150
 151 class CUpDownClient
 152 {
 153         friend class CClientList;
 154         friend class CUpDownClientListRem;
 155 private:
 156         /**
 157          * Please note that only the ClientList is allowed to delete the clients.
 158          * To schedule a client for deletion, call the CClientList::AddToDeleteQueue
 159          * funtion, which will safely remove dead clients once every second.
 160          */
 161         ~CUpDownClient();
 162
 163 public:
 164 #ifdef CLIENT_GUI
 165         CUpDownClient(class CEC_UpDownClient_Tag *);
 166 #else
 167         //base
 168         CUpDownClient(CClientTCPSocket* sender = 0);
 169         CUpDownClient(uint16 in_port, uint32 in_userid, uint32 in_serverup, uint16 in_serverport,CPartFile* in_reqfile, bool ed2kID, bool checkfriend);
 170 #endif
 171         /**
 172          * This function should be called when the client object is to be deleted.
 173          * It'll close the socket of the client and add it to the deletion queue
 174          * owned by the CClientList class. However, if the CUpDownClient isn't on
 175          * the normal clientlist, it will be deleted immediatly.
 176          *
 177          * The purpose of this is to avoid clients suddenly being removed due to
 178          * asyncronous events, such as socket errors, which can result in the
 179          * problems, as each CUpDownClient object is often kept in multiple lists,
 180          * and instantly removing the client poses the risk of invalidating
 181          * currently used iterators and/or creating dangling pointers.
 182          *
 183          * @see CClientList::AddToDeleteQueue
 184          * @see CClientList::Process
 185          */
 186         void            Safe_Delete();
 187
 188         /**
 189          * Specifies if the client has been queued for deletion.
 190          *
 191          * @return True if Safe_Delete has been called, false otherwise.
 192          */
 193         bool            HasBeenDeleted()                { return m_clientState == CS_DYING; }
 194
 195         ClientState     GetClientState()                { return m_clientState; }
 196
 197         bool            Disconnected(const wxString& strReason, bool bFromSocket = false);
 198         bool            TryToConnect(bool bIgnoreMaxCon = false);
 199         bool            Connect();
 200         void            ConnectionEstablished();
 201         const wxString& GetUserName() const             { return m_Username; }
 202         //Only use this when you know the real IP or when your clearing it.
 203         void            SetIP( uint32 val );
 204         uint32          GetIP() const                   { return m_dwUserIP; }
 205         bool            HasLowID() const                { return IsLowID(m_nUserIDHybrid); }
 206         wxString        GetFullIP() const               { return Uint32toStringIP(m_FullUserIP); }
 207         uint32          GetConnectIP() const            { return m_nConnectIP; }
 208         uint32          GetUserIDHybrid() const         { return m_nUserIDHybrid; }
 209         void            SetUserIDHybrid(uint32 val);
 210         uint16_t        GetUserPort() const             { return m_nUserPort; }
 211         void            SetUserPort(uint16_t port)      { m_nUserPort = port; }
 212         uint32          GetTransferredDown() const      { return m_nTransferredDown; }
 213         uint32          GetServerIP() const             { return m_dwServerIP; }
 214         void            SetServerIP(uint32 nIP)         { m_dwServerIP = nIP; }
 215         uint16          GetServerPort() const           { return m_nServerPort; }
 216         void            SetServerPort(uint16 nPort)     { m_nServerPort = nPort; }
 217         const CMD4Hash& GetUserHash() const             { return m_UserHash; }
 218         void            SetUserHash(const CMD4Hash& userhash);
 219         void            ValidateHash()                  { m_HasValidHash = !m_UserHash.IsEmpty(); }
 220         bool            HasValidHash() const            { return m_HasValidHash; }
 221         uint32          GetVersion() const              { return m_nClientVersion;}
 222         uint8           GetMuleVersion() const          { return m_byEmuleVersion;}
 223         bool            ExtProtocolAvailable() const    { return m_bEmuleProtocol;}
 224         bool            IsEmuleClient() const           { return (m_byEmuleVersion > 0);}
 225         bool            IsBanned() const;
 226         const wxString& GetClientFilename() const       { return m_clientFilename; }
 227         uint16          GetUDPPort() const              { return m_nUDPPort; }
 228         void            SetUDPPort(uint16 nPort)        { m_nUDPPort = nPort; }
 229         uint8           GetUDPVersion() const           { return m_byUDPVer; }
 230         uint8           GetExtendedRequestsVersion() const { return m_byExtendedRequestsVer; }
 231         bool            IsFriend() const                { return m_Friend != NULL; }
 232         bool            IsML() const                    { return m_bIsML; }
 233         bool            IsHybrid() const                { return m_bIsHybrid; }
 234         uint32          GetCompatibleClient() const     { return m_byCompatibleClient; }
 235
 236         void            ClearDownloadBlockRequests();
 237         void            RequestSharedFileList();
 238         void            ProcessSharedFileList(const byte* pachPacket, uint32 nSize, wxString& pszDirectory);
 239
 240         wxString        GetUploadFileInfo();
 241
 242         void            SetUserName(const wxString& NewName) { m_Username = NewName; }
 243
 244         uint8           GetClientSoft() const           { return m_clientSoft; }
 245         void            ReGetClientSoft();
 246         bool            ProcessHelloAnswer(const byte* pachPacket, uint32 nSize);
 247         bool            ProcessHelloPacket(const byte* pachPacket, uint32 nSize);
 248         void            SendHelloAnswer();
 249         bool            SendHelloPacket();
 250         void            SendMuleInfoPacket(bool bAnswer, bool OSInfo = false);
 251         bool            ProcessMuleInfoPacket(const byte* pachPacket, uint32 nSize);
 252         void            ProcessMuleCommentPacket(const byte* pachPacket, uint32 nSize);
 253         bool            Compare(const CUpDownClient* tocomp, bool bIgnoreUserhash = false) const;
 254         void            SetLastSrcReqTime()             { m_dwLastSourceRequest = ::GetTickCount(); }
 255         void            SetLastSrcAnswerTime()          { m_dwLastSourceAnswer = ::GetTickCount(); }
 256         void            SetLastAskedForSources()        { m_dwLastAskedForSources = ::GetTickCount(); }
 257         uint32          GetLastSrcReqTime() const       { return m_dwLastSourceRequest; }
 258         uint32          GetLastSrcAnswerTime() const    { return m_dwLastSourceAnswer; }
 259         uint32          GetLastAskedForSources() const  { return m_dwLastAskedForSources; }
 260         bool            GetFriendSlot() const           { return m_bFriendSlot; }
 261         void            SetFriendSlot(bool bNV)         { m_bFriendSlot = bNV; }
 262         void            SetCommentDirty(bool bDirty = true)     { m_bCommentDirty = bDirty; }
 263         uint8                   GetSourceExchange1Version() const                               { return m_bySourceExchange1Ver; }
 264         bool                    SupportsSourceExchange2() const                                 { return m_fSupportsSourceEx2; }
 265
 266         bool            SafeSendPacket(CPacket* packet);
 267
 268         void            ProcessRequestPartsPacket(const byte* pachPacket, uint32 nSize, bool largeblocks);
 269         void            ProcessRequestPartsPacketv2(const CMemFile& data);
 270
 271         void            SendPublicKeyPacket();
 272         void            SendSignaturePacket();
 273         void            ProcessPublicKeyPacket(const byte* pachPacket, uint32 nSize);
 274         void            ProcessSignaturePacket(const byte* pachPacket, uint32 nSize);
 275         uint8           GetSecureIdentState();
 276
 277         void            SendSecIdentStatePacket();
 278         void            ProcessSecIdentStatePacket(const byte* pachPacket, uint32 nSize);
 279
 280         uint8           GetInfoPacketsReceived() const  { return m_byInfopacketsReceived; }
 281         void            InfoPacketsReceived();
 282
 283         //upload
 284         uint8           GetUploadState() const          { return m_nUploadState; }
 285         void            SetUploadState(uint8 news);
 286         uint32          GetTransferredUp() const        { return m_nTransferredUp; }
 287         uint32          GetSessionUp() const            { return m_nTransferredUp - m_nCurSessionUp; }
 288         void            ResetSessionUp() {
 289                                                 m_nCurSessionUp = m_nTransferredUp;
 290                                                 m_addedPayloadQueueSession = 0;
 291                                                 m_nCurQueueSessionPayloadUp = 0;
 292                                         }
 293         uint32          GetUploadDatarate() const       { return m_nUpDatarate; }
 294
 295 #ifndef CLIENT_GUI
 296         uint32          GetWaitTime() const             { return m_dwUploadTime - GetWaitStartTime(); }
 297         uint32          GetUpStartTimeDelay() const     { return ::GetTickCount() - m_dwUploadTime; }
 298         uint32          GetWaitStartTime() const;
 299 #else
 300         uint32          m_WaitTime, m_UpStartTimeDelay, m_WaitStartTime;
 301         uint32          GetWaitTime() const             { return m_WaitTime; }
 302         uint32          GetUpStartTimeDelay() const     { return m_UpStartTimeDelay; }
 303         uint32          GetWaitStartTime() const        { return m_WaitStartTime; }
 304 #endif
 305
 306         bool            IsDownloading() const           { return (m_nUploadState == US_UPLOADING); }
 307
 308 #ifndef CLIENT_GUI
 309         uint32          GetScore(
 310                                 bool sysvalue,
 311                                 bool isdownloading = false,
 312                                 bool onlybasevalue = false) const;
 313 #else
 314         uint32          m_score;
 315         uint32          GetScore(
 316                                 bool WXUNUSED(sysvalue),
 317                                 bool WXUNUSED(isdownloading) = false,
 318                                 bool WXUNUSED(onlybasevalue) = false) const
 319         {
 320                 return m_score;
 321         }
 322         uint16          m_waitingPosition;
 323         uint16          GetWaitingPosition() const { return m_waitingPosition; }
 324 #endif
 325         double          GetRating() const
 326         {
 327                 return (double)GetScore(false, IsDownloading(), true);
 328         }
 329
 330         void            AddReqBlock(Requested_Block_Struct* reqblock);
 331         void            CreateNextBlockPackage();
 332         void            SetUpStartTime()                { m_dwUploadTime = ::GetTickCount(); }
 333         void            SetWaitStartTime();
 334         void            ClearWaitStartTime();
 335         void            SendHashsetPacket(const CMD4Hash& forfileid);
 336         bool            SupportMultiPacket() const      { return m_bMultiPacket; }
 337         bool            SupportExtMultiPacket() const   { return m_fExtMultiPacket; }
 338
 339         void            SetUploadFileID(CKnownFile *newreqfile);
 340
 341         /**
 342          *Gets the file actually on upload
 343          *
 344          */
 345         const CKnownFile* GetUploadFile() const         { return m_uploadingfile; }
 346
 347         void            SendOutOfPartReqsAndAddToWaitingQueue();
 348         void            ProcessExtendedInfo(const CMemFile *data, CKnownFile *tempreqfile);
 349         void            ProcessFileInfo(const CMemFile* data, const CPartFile* file);
 350         void            ProcessFileStatus(bool bUdpPacket, const CMemFile* data, const CPartFile* file);
 351
 352         const CMD4Hash& GetUploadFileID() const         { return m_requpfileid; }
 353         void            SetUploadFileID(const CMD4Hash& new_id);
 354         void            ClearUploadFileID()             { m_requpfileid.Clear(); m_uploadingfile = NULL;};
 355         uint32          SendBlockData();
 356         void            ClearUploadBlockRequests();
 357         void            SendRankingInfo();
 358         void            SendCommentInfo(CKnownFile *file);
 359         bool            IsDifferentPartBlock() const;
 360         void            UnBan();
 361         void            Ban();
 362         bool            m_bAddNextConnect;      // VQB Fix for LowID slots only on connection
 363         uint32          GetAskedCount() const           { return m_cAsked; }
 364         void            AddAskedCount()                 { m_cAsked++; }
 365         void            ClearAskedCount()               { m_cAsked = 1; }       // 1, because it's cleared *after* the first request...
 366         void            FlushSendBlocks();      // call this when you stop upload,
 367                                                 // or the socket might be not able to send
 368         void            SetLastUpRequest()              { m_dwLastUpRequest = ::GetTickCount(); }
 369         uint32          GetLastUpRequest() const        { return m_dwLastUpRequest; }
 370         size_t          GetUpPartCount() const          { return m_upPartStatus.size(); }
 371
 372
 373         //download
 374         void            SetRequestFile(CPartFile* reqfile);
 375         CPartFile*      GetRequestFile() const          { return m_reqfile; }
 376
 377         uint8           GetDownloadState() const        { return m_nDownloadState; }
 378         void            SetDownloadState(uint8 byNewState);
 379         uint32          GetLastAskedTime() const        { return m_dwLastAskedTime; }
 380
 381         bool            IsPartAvailable(uint16 iPart) const
 382                                         { return ( iPart < m_downPartStatus.size() ) ? m_downPartStatus[iPart] : 0; }
 383         bool            IsUpPartAvailable(uint16 iPart) const
 384                                         { return ( iPart < m_upPartStatus.size() ) ? m_upPartStatus[iPart] : 0;}
 385
 386         const BitVector& GetPartStatus() const          { return m_downPartStatus; }
 387         const BitVector& GetUpPartStatus() const        { return m_upPartStatus; }
 388         float           GetKBpsDown() const                             { return kBpsDown; }
 389         float           CalculateKBpsDown();
 390         uint16          GetRemoteQueueRank() const      { return m_nRemoteQueueRank; }
 391         uint16          GetOldRemoteQueueRank() const   { return m_nOldRemoteQueueRank; }
 392         void            SetRemoteQueueFull(bool flag)   { m_bRemoteQueueFull = flag; }
 393         bool            IsRemoteQueueFull() const       { return m_bRemoteQueueFull; }
 394         void            SetRemoteQueueRank(uint16 nr);
 395         bool            AskForDownload();
 396         void            SendStartupLoadReq();
 397         void            SendFileRequest();
 398         void            ProcessHashSet(const byte* packet, uint32 size);
 399         bool            AddRequestForAnotherFile(CPartFile* file);
 400         bool            DeleteFileRequest(CPartFile* file);
 401         void            DeleteAllFileRequests();
 402         void            SendBlockRequests();
 403         void            ProcessBlockPacket(const byte* packet, uint32 size, bool packed, bool largeblocks);
 404
 405 #ifndef CLIENT_GUI
 406         uint16          GetAvailablePartCount() const;
 407 #else
 408         uint16          m_AvailPartCount;
 409         uint16          GetAvailablePartCount() const   { return m_AvailPartCount; }
 410 #endif
 411
 412         bool            SwapToAnotherFile(bool bIgnoreNoNeeded, bool ignoreSuspensions, bool bRemoveCompletely, CPartFile* toFile = NULL);
 413         void            UDPReaskACK(uint16 nNewQR);
 414         void            UDPReaskFNF();
 415         void            UDPReaskForDownload();
 416         bool            IsSourceRequestAllowed();
 417         uint16          GetUpCompleteSourcesCount() const       { return m_nUpCompleteSourcesCount; }
 418         void            SetUpCompleteSourcesCount(uint16 n)     { m_nUpCompleteSourcesCount = n; }
 419
 420         //chat
 421         uint8           GetChatState()                  { return m_byChatstate; }
 422         void            SetChatState(uint8 nNewS)       { m_byChatstate = nNewS; }
 423         EChatCaptchaState GetChatCaptchaState() const                                   { return (EChatCaptchaState)m_nChatCaptchaState; }
 424         void                    SetChatCaptchaState(EChatCaptchaState nNewS)    { m_nChatCaptchaState = nNewS; }
 425         void                    ProcessCaptchaRequest(CMemFile* data);
 426         void                    ProcessCaptchaReqRes(uint8 nStatus);
 427
 428         //File Comment
 429         const wxString& GetFileComment() const          { return m_strComment; }
 430         uint8           GetFileRating() const           { return m_iRating; }
 431
 432         const wxString& GetSoftStr() const              { return m_clientSoftString; }
 433         const wxString& GetSoftVerStr() const           { return m_clientVerString; }
 434 #ifndef CLIENT_GUI
 435         const wxString GetServerName() const;
 436 #else
 437         wxString m_ServerName;
 438         const wxString& GetServerName() const { return m_ServerName; }
 439 #endif
 440
 441         uint16          GetKadPort() const              { return m_nKadPort; }
 442         void            SetKadPort(uint16 nPort)        { m_nKadPort = nPort; }
 443
 444         // Kry - AICH import
 445         void            SetReqFileAICHHash(CAICHHash* val);
 446         CAICHHash*      GetReqFileAICHHash() const      {return m_pReqFileAICHHash;}
 447         bool            IsSupportingAICH() const        {return m_fSupportsAICH & 0x01;}
 448         void            SendAICHRequest(CPartFile* pForFile, uint16 nPart);
 449         bool            IsAICHReqPending() const        {return m_fAICHRequested; }
 450         void            ProcessAICHAnswer(const byte* packet, uint32 size);
 451         void            ProcessAICHRequest(const byte* packet, uint32 size);
 452         void            ProcessAICHFileHash(CMemFile* data, const CPartFile* file);
 453
 454         EUtf8Str        GetUnicodeSupport() const;
 455
 456         // Barry - Process zip file as it arrives, don't need to wait until end of block
 457         int             unzip(Pending_Block_Struct *block, byte *zipped, uint32 lenZipped, byte **unzipped, uint32 *lenUnzipped, int iRecursion = 0);
 458         // Barry - Sets string to show parts downloading, eg NNNYNNNNYYNYN
 459         wxString        ShowDownloadingParts() const;
 460         void            UpdateDisplayedInfo(bool force = false);
 461         int             GetFileListRequested() const    { return m_iFileListRequested; }
 462         void            SetFileListRequested(int iFileListRequested) { m_iFileListRequested = iFileListRequested; }
 463
 464         void            ResetFileStatusInfo();
 465
 466         bool            CheckHandshakeFinished(uint32 protocol, uint32 opcode) const;
 467
 468         bool            GetSentCancelTransfer() const   { return m_fSentCancelTransfer; }
 469         void            SetSentCancelTransfer(bool bVal)        { m_fSentCancelTransfer = bVal; }
 470
 471         wxString        GetClientFullInfo();
 472
 473         const wxString& GetClientOSInfo() const         { return m_sClientOSInfo; }
 474
 475         void            ProcessPublicIPAnswer(const byte* pbyData, uint32 uSize);
 476         void            SendPublicIPRequest();
 477
 478         /**
 479          * Sets the current socket of the client.
 480          *
 481          * @param socket The pointer to the new socket, can be NULL.
 482          *
 483          * Please note that this function DOES NOT delete the old socket.
 484          */
 485         void            SetSocket(CClientTCPSocket* socket);
 486
 487         /**
 488          * Function for accessing the socket owned by a client.
 489          *
 490          * @return The pointer (can be NULL) to the socket used by this client.
 491          *
 492          * Please note that the socket object is quite volatile and can be removed
 493          * from one function call to the next, therefore, you should normally use
 494          * the safer functions below, which all check if the socket is valid before
 495          * deferring it.
 496          */
 497         CClientTCPSocket* GetSocket() const             { return m_socket; }
 498
 499         /**
 500          * Safe function for checking if the socket is connected.
 501          *
 502          * @return True if the socket exists and is connected, false otherwise.
 503          */
 504 #ifndef CLIENT_GUI
 505         bool            IsConnected() const;
 506 #else
 507         bool            m_IsConnected;
 508         bool            IsConnected() const             { return m_IsConnected; }
 509 #endif
 510
 511         /**
 512          * Safe function for sending packets.
 513          *
 514          * @return True if the socket exists and the packet was sent, false otherwise.
 515          */
 516         bool            SendPacket(CPacket* packet, bool delpacket = true, bool controlpacket = true);
 517
 518         /**
 519          * Safe function for setting the download limit of the socket.
 520          *
 521          * @return Current download speed of the client.
 522          */
 523         float           SetDownloadLimit(uint32 reducedownload);
 524
 525         /**
 526          * Sends a message to a client
 527          *
 528          * @return True if sent, false if connecting
 529          */
 530         bool    SendMessage(const wxString& message);
 531
 532         uint32          GetPayloadInBuffer() const      { return m_addedPayloadQueueSession - GetQueueSessionPayloadUp(); }
 533         uint32          GetQueueSessionPayloadUp() const        { return m_nCurQueueSessionPayloadUp; }
 534         bool            HasBlocks() const               { return !m_BlockRequests_queue.empty(); }
 535
 536         /* Source comes from? */
 537         ESourceFrom             GetSourceFrom() const   { return (ESourceFrom)m_nSourceFrom; }
 538         void                    SetSourceFrom(ESourceFrom val)  { m_nSourceFrom = val; }
 539
 540         /* Kad buddy support */
 541         // ID
 542         const byte*     GetBuddyID() const              { return m_achBuddyID; }
 543         void            SetBuddyID(const byte* m_achTempBuddyID);
 544         bool            HasValidBuddyID() const         { return m_bBuddyIDValid; }
 545         /* IP */
 546         void            SetBuddyIP( uint32 val )        { m_nBuddyIP = val; }
 547         uint32          GetBuddyIP() const              { return m_nBuddyIP; }
 548         /* Port */
 549         void            SetBuddyPort( uint16 val )      { m_nBuddyPort = val; }
 550         uint16          GetBuddyPort() const            { return m_nBuddyPort; }
 551
 552         //KadIPCheck
 553         bool            SendBuddyPingPong()             { return m_dwLastBuddyPingPongTime < ::GetTickCount(); }
 554         bool            AllowIncomeingBuddyPingPong()   { return m_dwLastBuddyPingPongTime < (::GetTickCount()-(3*60*1000)); }
 555         void            SetLastBuddyPingPongTime()      { m_dwLastBuddyPingPongTime = (::GetTickCount()+(10*60*1000)); }
 556         EKadState       GetKadState() const             { return m_nKadState; }
 557         void            SetKadState(EKadState nNewS)    { m_nKadState = nNewS; }
 558         uint8           GetKadVersion()                 { return m_byKadVersion; }
 559         void            ProcessFirewallCheckUDPRequest(CMemFile *data);
 560         // Kad added by me
 561         bool                    SendBuddyPing();
 562
 563         /* Returns the client hash type (SO_EMULE, mldonkey, etc) */
 564         int             GetHashType() const;
 565
 566         /**
 567          * Checks that a client isn't aggressively re-asking for files.
 568          *
 569          * Call this when a file is requested. If the time since the last request is
 570          * less than MIN_REQUESTTIME, 3 is added to the m_Aggressiveness variable.
 571          * If the time since the last request is >= MIN_REQUESTTIME, the variable is
 572          * decremented by 1. The client is banned if the variable reaches 10 or above.
 573          *
 574          * To check if a client is aggressive use the IsClientAggressive() function.
 575          *
 576          * Currently this function is called when the following packets are received:
 577          *  - OP_STARTUPLOADREQ
 578          *  - OP_REASKFILEPING
 579          */
 580         void            CheckForAggressive();
 581
 582         const wxString& GetClientModString() const      { return m_strModVersion; }
 583
 584         const wxString& GetClientVerString() const      { return m_fullClientVerString; }
 585
 586         const wxString& GetVersionString() const        { return m_clientVersionString; }
 587
 588         void            UpdateStats();
 589
 590         /* Returns a pointer to the credits, only for hash purposes */
 591         void*           GetCreditsHash() const { return (void*)credits; }
 592
 593         uint32          GetLastBlockOffset() const { return m_nLastBlockOffset; }
 594
 595         bool            GetOSInfoSupport() const { return m_fOsInfoSupport; }
 596
 597         bool            GetVBTTags() const { return m_fValueBasedTypeTags; }
 598
 599         uint16          GetLastPartAsked() const { return m_lastPartAsked; }
 600
 601         void            SetLastPartAsked(uint16 nPart) { m_lastPartAsked = nPart; }
 602
 603         CFriend*        GetFriend() const { return m_Friend; }
 604
 605         void            SetFriend(CFriend* newfriend) { m_Friend = newfriend; }
 606
 607         bool            IsIdentified() const;
 608
 609         bool            IsBadGuy() const;
 610
 611         bool            SUIFailed() const;
 612
 613         bool            SUINeeded() const;
 614
 615         bool            SUINotSupported() const;
 616
 617         uint64          GetDownloadedTotal() const;
 618
 619         uint64          GetUploadedTotal() const;
 620
 621         double          GetScoreRatio() const;
 622
 623         uint32          GetCreationTime() const { return m_nCreationTime; }
 624
 625         bool            SupportsLargeFiles() const { return m_fSupportsLargeFiles; }
 626
 627         #ifdef __DEBUG__
 628         /* Kry - Debug. See connection_reason definition comment below */
 629         void            SetConnectionReason(const wxString& reason) { connection_reason = reason; }
 630         #endif
 631
 632         // Encryption / Obfuscation / ConnectOptions
 633         bool            SupportsCryptLayer() const                      { return m_fSupportsCryptLayer; }
 634         bool            RequestsCryptLayer() const                      { return SupportsCryptLayer() && m_fRequestsCryptLayer; }
 635         bool            RequiresCryptLayer() const                      { return RequestsCryptLayer() && m_fRequiresCryptLayer; }
 636         bool            SupportsDirectUDPCallback() const               { return m_fDirectUDPCallback != 0 && HasValidHash() && GetKadPort() != 0; }
 637         uint32_t        GetDirectCallbackTimeout() const                { return m_dwDirectCallbackTimeout; }
 638         bool            HasObfuscatedConnectionBeenEstablished() const  { return m_hasbeenobfuscatinglately; }
 639
 640         void            SetCryptLayerSupport(bool bVal)                 { m_fSupportsCryptLayer = bVal ? 1 : 0; }
 641         void            SetCryptLayerRequest(bool bVal)                 { m_fRequestsCryptLayer = bVal ? 1 : 0; }
 642         void            SetCryptLayerRequires(bool bVal)                { m_fRequiresCryptLayer = bVal ? 1 : 0; }
 643         void            SetDirectUDPCallbackSupport(bool bVal)          { m_fDirectUDPCallback = bVal ? 1 : 0; }
 644         void            SetConnectOptions(uint8_t options, bool encryption = true, bool callback = true); // shortcut, sets crypt, callback, etc from the tagvalue we receive
 645         bool            ShouldReceiveCryptUDPPackets() const;
 646
 647         bool            HasDisabledSharedFiles() const { return m_fNoViewSharedFiles; }
 648
 649 private:
 650
 651         CClientCredits  *credits;
 652         CFriend         *m_Friend;
 653
 654         uint32          m_nTransferredUp;
 655         uint32          m_nCurQueueSessionPayloadUp;
 656         uint32          m_addedPayloadQueueSession;
 657
 658         struct TransferredData {
 659                 uint32  datalen;
 660                 uint32  timestamp;
 661         };
 662
 663         //////////////////////////////////////////////////////////
 664         // Upload data rate computation
 665         //
 666         uint32          m_nUpDatarate;
 667         uint32          m_nSumForAvgUpDataRate;
 668         std::list<TransferredData> m_AvarageUDR_list;
 669
 670
 671         /**
 672          * This struct is used to keep track of CPartFiles which this source shares.
 673          */
 674         struct A4AFStamp {
 675                 //! Signifies if this sources has needed parts for this file.
 676                 bool NeededParts;
 677                 //! This is set when we wish to avoid swapping to this file for a while.
 678                 uint32 timestamp;
 679         };
 680
 681         //! I typedef in the name of readability!
 682         typedef std::map<CPartFile*, A4AFStamp> A4AFList;
 683         //! This list contains all PartFiles which this client can be used as a source for.
 684         A4AFList m_A4AF_list;
 685
 686         /**
 687          * Helper function used by SwapToAnotherFile().
 688          *
 689          * @param it The iterator of the PartFile to be examined.
 690          * @param ignorenoneeded Do not check for the status NoNeededParts when checking the file.
 691          * @param ignoresuspended Do not check the timestamp when checking the file.
 692          * @return True if the file is a viable target, false otherwise.
 693          *
 694          * This function is used to perform checks to see if we should consider
 695          * this file a viable target for A4AF swapping. Unless ignoresuspended is
 696          * true, it will examine the timestamp of the file and reset it if needed.
 697          */
 698         bool            IsValidSwapTarget( A4AFList::iterator it, bool ignorenoneeded = false, bool ignoresuspended = false );
 699
 700         CPartFile*      m_reqfile;
 701
 702         // base
 703         void            Init();
 704         bool            ProcessHelloTypePacket(const CMemFile& data);
 705         void            SendHelloTypePacket(CMemFile* data);
 706         void            SendFirewallCheckUDPRequest();
 707         void            ClearHelloProperties(); // eMule 0.42
 708         uint32          m_dwUserIP;
 709         uint32          m_nConnectIP;           // holds the supposed IP or (after we had a connection) the real IP
 710         uint32          m_dwServerIP;
 711         uint32          m_nUserIDHybrid;
 712         uint16_t        m_nUserPort;
 713         int16           m_nServerPort;
 714         uint32          m_nClientVersion;
 715         uint32          m_cSendblock;
 716         uint8           m_byEmuleVersion;
 717         uint8           m_byDataCompVer;
 718         bool            m_bEmuleProtocol;
 719         wxString        m_Username;
 720         uint32          m_FullUserIP;
 721         CMD4Hash        m_UserHash;
 722         bool            m_HasValidHash;
 723         uint16          m_nUDPPort;
 724         uint8           m_byUDPVer;
 725         uint8           m_bySourceExchange1Ver;
 726         uint8           m_byAcceptCommentVer;
 727         uint8           m_byExtendedRequestsVer;
 728         uint8           m_clientSoft;
 729         uint32          m_dwLastSourceRequest;
 730         uint32          m_dwLastSourceAnswer;
 731         uint32          m_dwLastAskedForSources;
 732         int             m_iFileListRequested;
 733         bool            m_bFriendSlot;
 734         bool            m_bCommentDirty;
 735         bool            m_bIsHybrid;
 736         bool            m_bIsML;
 737         bool            m_bSupportsPreview;
 738         bool            m_bUnicodeSupport;
 739         uint16          m_nKadPort;
 740         bool            m_bMultiPacket;
 741         ClientState     m_clientState;
 742         CClientTCPSocket*       m_socket;
 743         bool            m_fNeedOurPublicIP; // we requested our IP from this client
 744
 745         // Kry - Secure User Ident import
 746         ESecureIdentState       m_SecureIdentState;
 747         uint8           m_byInfopacketsReceived;                // have we received the edonkeyprot and emuleprot packet already (see InfoPacketsReceived() )
 748         uint32          m_dwLastSignatureIP;
 749         uint8           m_bySupportSecIdent;
 750
 751         uint32          m_byCompatibleClient;
 752         std::list<CPacket*>     m_WaitingPackets_list;
 753         uint32          m_lastRefreshedDLDisplay;
 754
 755         //upload
 756         void CreateStandartPackets(const unsigned char* data,uint32 togo, Requested_Block_Struct* currentblock);
 757         void CreatePackedPackets(const unsigned char* data,uint32 togo, Requested_Block_Struct* currentblock);
 758
 759         uint8           m_nUploadState;
 760         uint32          m_dwUploadTime;
 761         uint32          m_cAsked;
 762         uint32          m_dwLastUpRequest;
 763         uint32          m_nCurSessionUp;
 764         uint16          m_nUpPartCount;
 765         CMD4Hash        m_requpfileid;
 766         uint16          m_nUpCompleteSourcesCount;
 767
 768         //! This vector contains the avilability of parts for the file that the user
 769         //! is requesting. When changing it, be sure to call CKnownFile::UpdatePartsFrequency
 770         //! so that the files know the actual availability of parts.
 771         BitVector       m_upPartStatus;
 772         uint16          m_lastPartAsked;
 773         wxString        m_strModVersion;
 774
 775         std::list<Requested_Block_Struct*>      m_BlockRequests_queue;
 776         std::list<Requested_Block_Struct*>      m_DoneBlocks_list;
 777
 778         //download
 779         bool            m_bRemoteQueueFull;
 780         uint8           m_nDownloadState;
 781         uint16          m_nPartCount;
 782         uint32          m_dwLastAskedTime;
 783         wxString        m_clientFilename;
 784         uint32          m_nTransferredDown;
 785         uint32          m_nLastBlockOffset;   // Patch for show parts that you download [Cax2]
 786         uint16          m_cShowDR;
 787         uint32          m_dwLastBlockReceived;
 788         uint16          m_nRemoteQueueRank;
 789         uint16          m_nOldRemoteQueueRank;
 790         bool            m_bCompleteSource;
 791         bool            m_bReaskPending;
 792         bool            m_bUDPPending;
 793         bool            m_bHashsetRequested;
 794
 795         std::list<Pending_Block_Struct*>        m_PendingBlocks_list;
 796         std::list<Requested_Block_Struct*>      m_DownloadBlocks_list;
 797
 798         // download speed calculation
 799         float           kBpsDown;
 800         uint32          msReceivedPrev;
 801         uint32          bytesReceivedCycle;
 802         // chat
 803         uint8           m_byChatstate;
 804         uint8           m_nChatCaptchaState;
 805         wxString        m_strComment;
 806         int8            m_iRating;
 807
 808         unsigned int
 809                 m_fHashsetRequesting : 1, // we have sent a hashset request to this client
 810                 m_fNoViewSharedFiles : 1, // client has disabled the 'View Shared Files' feature,
 811                                           // if this flag is not set, we just know that we don't know
 812                                           // for sure if it is enabled
 813                 m_fSupportsPreview   : 1,
 814                 m_fSentCancelTransfer: 1, // we have sent an OP_CANCELTRANSFER in the current connection
 815                 m_fSharedDirectories : 1, // client supports OP_ASKSHAREDIRS opcodes
 816                 m_fSupportsAICH      : 3,
 817                 m_fAICHRequested     : 1,
 818                 m_fSupportsLargeFiles: 1,
 819                 m_fSentOutOfPartReqs : 1,
 820                 m_fExtMultiPacket    : 1,
 821                 m_fRequestsCryptLayer: 1,
 822                 m_fSupportsCryptLayer: 1,
 823                 m_fRequiresCryptLayer: 1,
 824                 m_fSupportsSourceEx2 : 1,
 825                 m_fSupportsCaptcha       : 1,
 826                 m_fDirectUDPCallback : 1;
 827
 828         unsigned int
 829                 m_fOsInfoSupport : 1,
 830                 m_fValueBasedTypeTags : 1;
 831
 832         /* Razor 1a - Modif by MikaelB */
 833
 834         bool            m_bHelloAnswerPending;
 835
 836         //! This vector contains the avilability of parts for the file we requested
 837         //! from this user. When changing it, be sure to call CPartFile::UpdatePartsFrequency
 838         //! so that the files know the actual availability of parts.
 839         BitVector       m_downPartStatus;
 840
 841         CAICHHash*      m_pReqFileAICHHash;
 842
 843         ESourceFrom     m_nSourceFrom;
 844
 845         /* Kad Stuff */
 846         byte            m_achBuddyID[16];
 847         bool            m_bBuddyIDValid;
 848         uint32          m_nBuddyIP;
 849         uint16          m_nBuddyPort;
 850
 851         EKadState       m_nKadState;
 852
 853         uint8           m_byKadVersion;
 854         uint32          m_dwLastBuddyPingPongTime;
 855         uint32_t        m_dwDirectCallbackTimeout;
 856
 857         //! This keeps track of aggressive requests for files.
 858         uint16          m_Aggressiveness;
 859         //! This tracks the time of the last time since a file was requested
 860         uint32          m_LastFileRequest;
 861
 862         bool            m_OSInfo_sent;
 863
 864         wxString        m_clientSoftString;     /* software name */
 865         wxString        m_clientVerString;      /* version + optional mod name */
 866         wxString        m_clientVersionString;  /* version string */
 867         wxString        m_fullClientVerString;  /* full info string */
 868         wxString        m_sClientOSInfo;
 869         wxString        m_pendingMessage;
 870
 871         int             SecIdentSupRec;
 872
 873         CKnownFile*     m_uploadingfile;
 874
 875         uint8           m_MaxBlockRequests;
 876
 877         // needed for stats
 878         uint32          m_lastClientSoft;
 879         uint32          m_lastClientVersion;
 880         wxString        m_lastOSInfo;
 881
 882         /* For buddies timeout */
 883         uint32 m_nCreationTime;
 884
 885         /* Calculation of last average speed */
 886         uint32 m_lastaverage;
 887         uint32 m_last_block_start;
 888
 889         /* Save the encryption status for display when disconnected */
 890         bool m_hasbeenobfuscatinglately;
 891
 892         /* Kry - Debug thing. Clients created just to check their data
 893            have this string set to the reason we want to check them.
 894            Obviously, once checked, we disconect them. Take that, sucker.
 895            This debug code is just for me I'm afraid. */
 896           #ifdef __DEBUG__
 897           wxString connection_reason;
 898           #endif
 899 };
 900
 901
 902 #define MAKE_CLIENT_VERSION(mjr, min, upd) \
 903         ((uint32)(mjr)*100U*10U*100U + (uint32)(min)*100U*10U + (uint32)(upd)*100U)
 904
 905
 906 #endif // UPDOWNCLIENT_H
 907 // File_checked_for_headers