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 #include "BitVector.h"          // Needed for BitVector
  37
  38 #include <map>
  39
  40
  41 class CPartFile;
  42 class CClientTCPSocket;
  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 // Obfuscation status
 149 enum EObfuscationState {
 150         OBST_UNDEFINED = 0,
 151         OBST_ENABLED,
 152         OBST_SUPPORTED,
 153         OBST_NOT_SUPPORTED,
 154         OBST_DISABLED
 155 };
 156
 157 // This is fixed on ed2k v1, but can be any number on ED2Kv2
 158 #define STANDARD_BLOCKS_REQUEST 3
 159
 160 class CUpDownClient : public CECID
 161 {
 162         friend class CClientList;
 163         friend class CUpDownClientListRem;
 164 private:
 165         /**
 166          * Please note that only the ClientList is allowed to delete the clients.
 167          * To schedule a client for deletion, call the CClientList::AddToDeleteQueue
 168          * funtion, which will safely remove dead clients once every second.
 169          */
 170         ~CUpDownClient();
 171
 172 public:
 173 #ifdef CLIENT_GUI
 174         CUpDownClient(class CEC_UpDownClient_Tag *);
 175 #else
 176         //base
 177         CUpDownClient(CClientTCPSocket* sender = 0);
 178         CUpDownClient(uint16 in_port, uint32 in_userid, uint32 in_serverup, uint16 in_serverport,CPartFile* in_reqfile, bool ed2kID, bool checkfriend);
 179 #endif
 180         /**
 181          * This function should be called when the client object is to be deleted.
 182          * It'll close the socket of the client and add it to the deletion queue
 183          * owned by the CClientList class. However, if the CUpDownClient isn't on
 184          * the normal clientlist, it will be deleted immediatly.
 185          *
 186          * The purpose of this is to avoid clients suddenly being removed due to
 187          * asyncronous events, such as socket errors, which can result in the
 188          * problems, as each CUpDownClient object is often kept in multiple lists,
 189          * and instantly removing the client poses the risk of invalidating
 190          * currently used iterators and/or creating dangling pointers.
 191          *
 192          * @see CClientList::AddToDeleteQueue
 193          * @see CClientList::Process
 194          */
 195         void            Safe_Delete();
 196
 197         /**
 198          * Specifies if the client has been queued for deletion.
 199          *
 200          * @return True if Safe_Delete has been called, false otherwise.
 201          */
 202         bool            HasBeenDeleted()                { return m_clientState == CS_DYING; }
 203
 204         ClientState     GetClientState()                { return m_clientState; }
 205
 206         bool            Disconnected(const wxString& strReason, bool bFromSocket = false);
 207         bool            TryToConnect(bool bIgnoreMaxCon = false);
 208         bool            Connect();
 209         void            ConnectionEstablished();
 210         const wxString& GetUserName() const             { return m_Username; }
 211         //Only use this when you know the real IP or when your clearing it.
 212         void            SetIP( uint32 val );
 213         uint32          GetIP() const                   { return m_dwUserIP; }
 214         bool            HasLowID() const                { return IsLowID(m_nUserIDHybrid); }
 215         wxString        GetFullIP() const               { return Uint32toStringIP(m_FullUserIP); }
 216         uint32          GetConnectIP() const            { return m_nConnectIP; }
 217         uint32          GetUserIDHybrid() const         { return m_nUserIDHybrid; }
 218         void            SetUserIDHybrid(uint32 val);
 219         uint16_t        GetUserPort() const             { return m_nUserPort; }
 220         void            SetUserPort(uint16_t port)      { m_nUserPort = port; }
 221         uint64          GetTransferredDown() const      { return m_nTransferredDown; }
 222         uint32          GetServerIP() const             { return m_dwServerIP; }
 223         void            SetServerIP(uint32 nIP)         { m_dwServerIP = nIP; }
 224         uint16          GetServerPort() const           { return m_nServerPort; }
 225         void            SetServerPort(uint16 nPort)     { m_nServerPort = nPort; }
 226         const CMD4Hash& GetUserHash() const             { return m_UserHash; }
 227         void            SetUserHash(const CMD4Hash& userhash);
 228         void            ValidateHash()                  { m_HasValidHash = !m_UserHash.IsEmpty(); }
 229         bool            HasValidHash() const            { return m_HasValidHash; }
 230         uint32          GetVersion() const              { return m_nClientVersion;}
 231         uint8           GetMuleVersion() const          { return m_byEmuleVersion;}
 232         bool            ExtProtocolAvailable() const    { return m_bEmuleProtocol;}
 233         bool            IsEmuleClient() const           { return (m_byEmuleVersion > 0);}
 234         bool            IsBanned() const;
 235         const wxString& GetClientFilename() const       { return m_clientFilename; }
 236         uint16          GetUDPPort() const              { return m_nUDPPort; }
 237         void            SetUDPPort(uint16 nPort)        { m_nUDPPort = nPort; }
 238         uint8           GetUDPVersion() const           { return m_byUDPVer; }
 239         uint8           GetExtendedRequestsVersion() const { return m_byExtendedRequestsVer; }
 240         bool            IsFriend() const                { return m_Friend != NULL; }
 241         bool            IsML() const                    { return m_bIsML; }
 242         bool            IsHybrid() const                { return m_bIsHybrid; }
 243         uint32          GetCompatibleClient() const     { return m_byCompatibleClient; }
 244
 245         void            ClearDownloadBlockRequests();
 246         void            RequestSharedFileList();
 247         void            ProcessSharedFileList(const byte* pachPacket, uint32 nSize, wxString& pszDirectory);
 248
 249         wxString        GetUploadFileInfo();
 250
 251         void            SetUserName(const wxString& NewName) { m_Username = NewName; }
 252
 253         uint8           GetClientSoft() const           { return m_clientSoft; }
 254         void            ReGetClientSoft();
 255         bool            ProcessHelloAnswer(const byte* pachPacket, uint32 nSize);
 256         bool            ProcessHelloPacket(const byte* pachPacket, uint32 nSize);
 257         void            SendHelloAnswer();
 258         bool            SendHelloPacket();
 259         void            SendMuleInfoPacket(bool bAnswer, bool OSInfo = false);
 260         bool            ProcessMuleInfoPacket(const byte* pachPacket, uint32 nSize);
 261         void            ProcessMuleCommentPacket(const byte* pachPacket, uint32 nSize);
 262         bool            Compare(const CUpDownClient* tocomp, bool bIgnoreUserhash = false) const;
 263         void            SetLastSrcReqTime()             { m_dwLastSourceRequest = ::GetTickCount(); }
 264         void            SetLastSrcAnswerTime()          { m_dwLastSourceAnswer = ::GetTickCount(); }
 265         void            SetLastAskedForSources()        { m_dwLastAskedForSources = ::GetTickCount(); }
 266         uint32          GetLastSrcReqTime() const       { return m_dwLastSourceRequest; }
 267         uint32          GetLastSrcAnswerTime() const    { return m_dwLastSourceAnswer; }
 268         uint32          GetLastAskedForSources() const  { return m_dwLastAskedForSources; }
 269         bool            GetFriendSlot() const           { return m_bFriendSlot; }
 270         void            SetFriendSlot(bool bNV)         { m_bFriendSlot = bNV; }
 271         void            SetCommentDirty(bool bDirty = true)     { m_bCommentDirty = bDirty; }
 272         uint8           GetSourceExchange1Version() const       { return m_bySourceExchange1Ver; }
 273         bool            SupportsSourceExchange2() const         { return m_fSupportsSourceEx2; }
 274
 275         bool            SafeSendPacket(CPacket* packet);
 276
 277         void            ProcessRequestPartsPacket(const byte* pachPacket, uint32 nSize, bool largeblocks);
 278         void            ProcessRequestPartsPacketv2(const CMemFile& data);
 279
 280         void            SendPublicKeyPacket();
 281         void            SendSignaturePacket();
 282         void            ProcessPublicKeyPacket(const byte* pachPacket, uint32 nSize);
 283         void            ProcessSignaturePacket(const byte* pachPacket, uint32 nSize);
 284         uint8           GetSecureIdentState();
 285
 286         void            SendSecIdentStatePacket();
 287         void            ProcessSecIdentStatePacket(const byte* pachPacket, uint32 nSize);
 288
 289         uint8           GetInfoPacketsReceived() const  { return m_byInfopacketsReceived; }
 290         void            InfoPacketsReceived();
 291
 292         //upload
 293         uint8           GetUploadState() const          { return m_nUploadState; }
 294         void            SetUploadState(uint8 news);
 295         uint32          GetTransferredUp() const        { return m_nTransferredUp; }
 296         uint32          GetSessionUp() const            { return m_nTransferredUp - m_nCurSessionUp; }
 297         void            ResetSessionUp();
 298         uint32          GetUploadDatarate() const       { return m_nUpDatarate; }
 299
 300 #ifndef CLIENT_GUI
 301         //uint32                GetWaitTime() const             { return m_dwUploadTime - GetWaitStartTime(); }
 302         uint32          GetUpStartTimeDelay() const     { return ::GetTickCount() - m_dwUploadTime; }
 303         uint32          GetWaitStartTime() const;
 304 #else
 305         //uint32                m_WaitTime, m_UpStartTimeDelay, m_WaitStartTime;
 306         //uint32                GetWaitTime() const             { return m_WaitTime; }
 307         //uint32                GetUpStartTimeDelay() const     { return m_UpStartTimeDelay; }
 308         //uint32                GetWaitStartTime() const        { return m_WaitStartTime; }
 309 #endif
 310
 311         bool            IsDownloading() const           { return (m_nUploadState == US_UPLOADING); }
 312
 313         uint32          GetScore() const        { return m_score; }
 314         uint32          CalculateScore()        { m_score = CalculateScoreInternal(); return m_score; }
 315         void            ClearScore()            { m_score = 0; }
 316         uint16          GetUploadQueueWaitingPosition() const   { return m_waitingPosition; }
 317         void            SetUploadQueueWaitingPosition(uint16 pos)       { m_waitingPosition = pos; }
 318 #ifndef CLIENT_GUI
 319         uint8           GetObfuscationStatus() const;
 320         uint16          GetNextRequestedPart() const;
 321 #else
 322         EIdentState     m_identState;
 323         uint8           GetObfuscationStatus() const { return m_obfuscationStatus; }
 324         uint8           m_obfuscationStatus;
 325         uint16          m_nextRequestedPart;
 326         uint16          GetNextRequestedPart() const { return m_nextRequestedPart; }
 327 #endif
 328
 329         void            AddReqBlock(Requested_Block_Struct* reqblock);
 330         void            CreateNextBlockPackage();
 331         void            SetUpStartTime()                { m_dwUploadTime = ::GetTickCount(); }
 332         void            SetWaitStartTime();
 333         void            ClearWaitStartTime();
 334         void            SendHashsetPacket(const CMD4Hash& forfileid);
 335         bool            SupportMultiPacket() const      { return m_bMultiPacket; }
 336         bool            SupportExtMultiPacket() const   { return m_fExtMultiPacket; }
 337
 338         void            SetUploadFileID(CKnownFile *newreqfile);
 339
 340         /**
 341          *Gets the file actually on upload
 342          *
 343          */
 344         const CKnownFile* GetUploadFile() const         { return m_uploadingfile; }
 345
 346         void            SendOutOfPartReqsAndAddToWaitingQueue();
 347         void            ProcessExtendedInfo(const CMemFile *data, CKnownFile *tempreqfile);
 348         void            ProcessFileInfo(const CMemFile* data, const CPartFile* file);
 349         void            ProcessFileStatus(bool bUdpPacket, const CMemFile* data, const CPartFile* file);
 350
 351         const CMD4Hash& GetUploadFileID() const         { return m_requpfileid; }
 352         void            SetUploadFileID(const CMD4Hash& new_id);
 353         void            ClearUploadFileID()             { m_requpfileid.Clear(); m_uploadingfile = NULL;};
 354         uint32          SendBlockData();
 355         void            ClearUploadBlockRequests();
 356         void            SendRankingInfo();
 357         void            SendCommentInfo(CKnownFile *file);
 358         bool            IsDifferentPartBlock() const;
 359         void            UnBan();
 360         void            Ban();
 361         bool            m_bAddNextConnect;      // VQB Fix for LowID slots only on connection
 362         uint32          GetAskedCount() const           { return m_cAsked; }
 363         void            AddAskedCount()                 { m_cAsked++; }
 364         void            ClearAskedCount()               { m_cAsked = 1; }       // 1, because it's cleared *after* the first request...
 365         void            FlushSendBlocks();      // call this when you stop upload,
 366                                                 // or the socket might be not able to send
 367         void            SetLastUpRequest()              { m_dwLastUpRequest = ::GetTickCount(); }
 368         uint32          GetLastUpRequest() const        { return m_dwLastUpRequest; }
 369         size_t          GetUpPartCount() const          { return m_upPartStatus.size(); }
 370
 371
 372         //download
 373         void            SetRequestFile(CPartFile* reqfile);
 374         CPartFile*      GetRequestFile() const          { return m_reqfile; }
 375
 376         uint8           GetDownloadState() const        { return m_nDownloadState; }
 377         void            SetDownloadState(uint8 byNewState);
 378         uint32          GetLastAskedTime() const        { return m_dwLastAskedTime; }
 379         void            ResetLastAskedTime()            { m_dwLastAskedTime = 0; }
 380
 381         bool            IsPartAvailable(uint16 iPart) const
 382                                         { return ( iPart < m_downPartStatus.size() ) ? m_downPartStatus.get(iPart) : 0; }
 383         bool            IsUpPartAvailable(uint16 iPart) const
 384                                         { return ( iPart < m_upPartStatus.size() ) ? m_upPartStatus.get(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            ProcessCaptchaRequest(CMemFile* data);
 425         void            ProcessCaptchaReqRes(uint8 nStatus);
 426         void            ProcessChatMessage(wxString message);
 427         // message filtering
 428         uint8           GetMessagesReceived() const     { return m_cMessagesReceived; }
 429         void            IncMessagesReceived()           { m_cMessagesReceived < 255 ? ++m_cMessagesReceived : 255; }
 430         uint8           GetMessagesSent() const         { return m_cMessagesSent; }
 431         void            IncMessagesSent()               { m_cMessagesSent < 255 ? ++m_cMessagesSent : 255; }
 432         bool            IsSpammer() const               { return m_fIsSpammer; }
 433         void            SetSpammer(bool bVal);
 434         bool            IsMessageFiltered(const wxString& message);
 435
 436         //File Comment
 437         const wxString& GetFileComment() const          { return m_strComment; }
 438         uint8           GetFileRating() const           { return m_iRating; }
 439
 440         const wxString& GetSoftStr() const              { return m_clientSoftString; }
 441         const wxString& GetSoftVerStr() const           { return m_clientVerString; }
 442 #ifndef CLIENT_GUI
 443         const wxString GetServerName() const;
 444 #else
 445         wxString m_ServerName;
 446         const wxString& GetServerName() const { return m_ServerName; }
 447 #endif
 448
 449         uint16          GetKadPort() const              { return m_nKadPort; }
 450         void            SetKadPort(uint16 nPort)        { m_nKadPort = nPort; }
 451
 452         // Kry - AICH import
 453         void            SetReqFileAICHHash(CAICHHash* val);
 454         CAICHHash*      GetReqFileAICHHash() const      {return m_pReqFileAICHHash;}
 455         bool            IsSupportingAICH() const        {return m_fSupportsAICH & 0x01;}
 456         void            SendAICHRequest(CPartFile* pForFile, uint16 nPart);
 457         bool            IsAICHReqPending() const        {return m_fAICHRequested; }
 458         void            ProcessAICHAnswer(const byte* packet, uint32 size);
 459         void            ProcessAICHRequest(const byte* packet, uint32 size);
 460         void            ProcessAICHFileHash(CMemFile* data, const CPartFile* file);
 461
 462         EUtf8Str        GetUnicodeSupport() const;
 463
 464         // Barry - Process zip file as it arrives, don't need to wait until end of block
 465         int             unzip(Pending_Block_Struct *block, byte *zipped, uint32 lenZipped, byte **unzipped, uint32 *lenUnzipped, int iRecursion = 0);
 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         uint16          GetLastDownloadingPart() const { return m_lastDownloadingPart; }
 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 CreateStandardPackets(const unsigned char* data,uint32 togo, Requested_Block_Struct* currentblock);
 765         void CreatePackedPackets(const unsigned char* data,uint32 togo, Requested_Block_Struct* currentblock);
 766         uint32 CalculateScoreInternal();
 767
 768         uint8           m_nUploadState;
 769         uint32          m_dwUploadTime;
 770         uint32          m_cAsked;
 771         uint32          m_dwLastUpRequest;
 772         uint32          m_nCurSessionUp;
 773         uint16          m_nUpPartCount;
 774         CMD4Hash        m_requpfileid;
 775         uint16          m_nUpCompleteSourcesCount;
 776         uint32          m_score;
 777         uint16          m_waitingPosition;
 778
 779         //! This vector contains the avilability of parts for the file that the user
 780         //! is requesting. When changing it, be sure to call CKnownFile::UpdatePartsFrequency
 781         //! so that the files know the actual availability of parts.
 782         BitVector       m_upPartStatus;
 783         uint16          m_lastPartAsked;
 784         wxString        m_strModVersion;
 785
 786         std::list<Requested_Block_Struct*>      m_BlockRequests_queue;
 787         std::list<Requested_Block_Struct*>      m_DoneBlocks_list;
 788
 789         //download
 790         bool            m_bRemoteQueueFull;
 791         uint8           m_nDownloadState;
 792         uint16          m_nPartCount;
 793         uint32          m_dwLastAskedTime;
 794         wxString        m_clientFilename;
 795         uint64          m_nTransferredDown;
 796         uint16          m_lastDownloadingPart;   // last Part that was downloading
 797         uint16          m_cShowDR;
 798         uint32          m_dwLastBlockReceived;
 799         uint16          m_nRemoteQueueRank;
 800         uint16          m_nOldRemoteQueueRank;
 801         bool            m_bCompleteSource;
 802         bool            m_bReaskPending;
 803         bool            m_bUDPPending;
 804         bool            m_bHashsetRequested;
 805
 806         std::list<Pending_Block_Struct*>        m_PendingBlocks_list;
 807         std::list<Requested_Block_Struct*>      m_DownloadBlocks_list;
 808
 809         // download speed calculation
 810         float           kBpsDown;
 811         uint32          msReceivedPrev;
 812         uint32          bytesReceivedCycle;
 813         // chat
 814         wxString        m_strComment;
 815         uint8           m_byChatstate;
 816         uint8           m_nChatCaptchaState;
 817         uint8           m_cCaptchasSent;
 818         int8            m_iRating;
 819         uint8           m_cMessagesReceived;            // count of chatmessages he sent to me
 820         uint8           m_cMessagesSent;                        // count of chatmessages I sent to him
 821         wxString        m_strCaptchaChallenge;
 822         wxString        m_strCaptchaPendingMsg;
 823
 824         unsigned int
 825                 m_fHashsetRequesting : 1, // we have sent a hashset request to this client
 826                 m_fNoViewSharedFiles : 1, // client has disabled the 'View Shared Files' feature,
 827                                           // if this flag is not set, we just know that we don't know
 828                                           // for sure if it is enabled
 829                 m_fSupportsPreview   : 1,
 830                 m_fIsSpammer         : 1,
 831                 m_fSentCancelTransfer: 1, // we have sent an OP_CANCELTRANSFER in the current connection
 832                 m_fSharedDirectories : 1, // client supports OP_ASKSHAREDIRS opcodes
 833                 m_fSupportsAICH      : 3,
 834                 m_fAICHRequested     : 1,
 835                 m_fSupportsLargeFiles: 1,
 836                 m_fSentOutOfPartReqs : 1,
 837                 m_fExtMultiPacket    : 1,
 838                 m_fRequestsCryptLayer: 1,
 839                 m_fSupportsCryptLayer: 1,
 840                 m_fRequiresCryptLayer: 1,
 841                 m_fSupportsSourceEx2 : 1,
 842                 m_fSupportsCaptcha   : 1,
 843                 m_fDirectUDPCallback : 1;
 844
 845         unsigned int
 846                 m_fOsInfoSupport : 1,
 847                 m_fValueBasedTypeTags : 1;
 848
 849         /* Razor 1a - Modif by MikaelB */
 850
 851         bool            m_bHelloAnswerPending;
 852
 853         //! This vector contains the avilability of parts for the file we requested
 854         //! from this user. When changing it, be sure to call CPartFile::UpdatePartsFrequency
 855         //! so that the files know the actual availability of parts.
 856         BitVector       m_downPartStatus;
 857
 858         CAICHHash*      m_pReqFileAICHHash;
 859
 860         ESourceFrom     m_nSourceFrom;
 861
 862         /* Kad Stuff */
 863         byte            m_achBuddyID[16];
 864         bool            m_bBuddyIDValid;
 865         uint32          m_nBuddyIP;
 866         uint16          m_nBuddyPort;
 867
 868         EKadState       m_nKadState;
 869
 870         uint8           m_byKadVersion;
 871         uint32          m_dwLastBuddyPingPongTime;
 872         uint32_t        m_dwDirectCallbackTimeout;
 873
 874         //! This keeps track of aggressive requests for files.
 875         uint16          m_Aggressiveness;
 876         //! This tracks the time of the last time since a file was requested
 877         uint32          m_LastFileRequest;
 878
 879         bool            m_OSInfo_sent;
 880
 881         wxString        m_clientSoftString;     /* software name */
 882         wxString        m_clientVerString;      /* version + optional mod name */
 883         wxString        m_clientVersionString;  /* version string */
 884         wxString        m_fullClientVerString;  /* full info string */
 885         wxString        m_sClientOSInfo;
 886         wxString        m_pendingMessage;
 887
 888         int             SecIdentSupRec;
 889
 890         CKnownFile*     m_uploadingfile;
 891
 892         uint8           m_MaxBlockRequests;
 893
 894         // needed for stats
 895         uint32          m_lastClientSoft;
 896         uint32          m_lastClientVersion;
 897         wxString        m_lastOSInfo;
 898
 899         /* For buddies timeout */
 900         uint32          m_nCreationTime;
 901
 902         /* Calculation of last average speed */
 903         uint32          m_lastaverage;
 904         uint32          m_last_block_start;
 905
 906         /* Save the encryption status for display when disconnected */
 907         bool            m_hasbeenobfuscatinglately;
 908
 909         /* Kry - Debug thing. Clients created just to check their data
 910            have this string set to the reason we want to check them.
 911            Obviously, once checked, we disconnect them. Take that, sucker.
 912            This debug code is just for me I'm afraid. */
 913 #ifdef __DEBUG__
 914         wxString        connection_reason;
 915 #endif
 916 };
 917
 918
 919 #define MAKE_CLIENT_VERSION(mjr, min, upd) \
 920         ((uint32)(mjr)*100U*10U*100U + (uint32)(min)*100U*10U + (uint32)(upd)*100U)
 921
 922
 923 #endif // UPDOWNCLIENT_H
 924 // File_checked_for_headers