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