src/KnownFile.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Parts of this file are based on work from pan One (http://home-3.tiscali.nl/~meost/pms/)
   5 //
   6 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   7 // Copyright (c) 2002-2008 Merkur ( devs@emule-project.net / http://www.emule-project.net )
   8 //
   9 // Any parts of this program derived from the xMule, lMule or eMule project,
  10 // or contributed by third-party developers are copyrighted by their
  11 // respective authors.
  12 //
  13 // This program is free software; you can redistribute it and/or modify
  14 // it under the terms of the GNU General Public License as published by
  15 // the Free Software Foundation; either version 2 of the License, or
  16 // (at your option) any later version.
  17 //
  18 // This program is distributed in the hope that it will be useful,
  19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 // GNU General Public License for more details.
  22 //
  23 // You should have received a copy of the GNU General Public License
  24 // along with this program; if not, write to the Free Software
  25 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  26 //
  27
  28
  29 #include "KnownFile.h"          // Do_not_auto_remove
  30
  31 #include <protocol/kad/Constants.h>
  32 #include <protocol/ed2k/Client2Client/TCP.h>
  33 #include <protocol/ed2k/ClientSoftware.h>
  34 #include <protocol/Protocols.h>
  35 #include <tags/FileTags.h>
  36
  37 #include <wx/config.h>
  38
  39 #ifdef CLIENT_GUI
  40 #include "UpDownClientEC.h"     // Needed for CUpDownClient
  41 #else
  42 #include "updownclient.h"       // Needed for CUpDownClient
  43 #endif
  44
  45 #include "MemFile.h"            // Needed for CMemFile
  46 #include "Packet.h"             // Needed for CPacket
  47 #include "Preferences.h"        // Needed for CPreferences
  48 #include "KnownFileList.h"      // Needed for CKnownFileList
  49 #include "amule.h"              // Needed for theApp
  50 #include "PartFile.h"           // Needed for SavePartFile
  51 #include "ClientList.h"         // Needed for clientlist (buddy support)
  52 #include "Logger.h"
  53 #include "ScopedPtr.h"          // Needed for CScopedArray and CScopedPtr
  54 #include "GuiEvents.h"          // Needed for Notify_*
  55 #include "SearchFile.h"         // Needed for CSearchFile
  56 #include "FileArea.h"           // Needed for CFileArea
  57 #include "FileAutoClose.h"      // Needed for CFileAutoClose
  58 #include "Server.h"                     // Needed for CServer
  59
  60 #include "CryptoPP_Inc.h"       // Needed for MD4
  61
  62 #include <common/Format.h>
  63
  64 CFileStatistic::CFileStatistic() :
  65         requested(0),
  66         transferred(0),
  67         accepted(0),
  68         alltimerequested(0),
  69         alltimetransferred(0),
  70         alltimeaccepted(0)
  71 {
  72 }
  73
  74 #ifndef CLIENT_GUI
  75
  76 void CFileStatistic::AddRequest(){
  77         requested++;
  78         alltimerequested++;
  79         theApp->knownfiles->requested++;
  80         theApp->sharedfiles->UpdateItem(fileParent);
  81 }
  82
  83 void CFileStatistic::AddAccepted(){
  84         accepted++;
  85         alltimeaccepted++;
  86         theApp->knownfiles->accepted++;
  87         theApp->sharedfiles->UpdateItem(fileParent);
  88 }
  89
  90 void CFileStatistic::AddTransferred(uint64 bytes){
  91         transferred += bytes;
  92         alltimetransferred += bytes;
  93         theApp->knownfiles->transferred += bytes;
  94         theApp->sharedfiles->UpdateItem(fileParent);
  95 }
  96
  97 #endif // CLIENT_GUI
  98
  99
 100 /* Abstract File (base class)*/
 101
 102 CAbstractFile::CAbstractFile()
 103 :
 104 m_iRating(0),
 105 m_hasComment(false),
 106 m_iUserRating(0),
 107 m_nFileSize(0)
 108 {
 109 }
 110
 111
 112 CAbstractFile::CAbstractFile(const CAbstractFile& other)
 113 :
 114 m_abyFileHash(other.m_abyFileHash),
 115 m_strComment(other.m_strComment),
 116 m_iRating(other.m_iRating),
 117 m_hasComment(other.m_hasComment),
 118 m_iUserRating(other.m_iUserRating),
 119 m_taglist(other.m_taglist),
 120 m_nFileSize(other.m_nFileSize),
 121 m_fileName(other.m_fileName)
 122 {
 123 /* // TODO: Currently it's not safe to duplicate the entries, but isn't needed either.
 124         CKadEntryPtrList::const_iterator it = other.m_kadNotes.begin();
 125         for (; it != other.m_kadNotes.end(); ++it) {
 126                 m_kadNotes.push_back(new Kademlia::CEntry(**it));
 127         }
 128 */
 129 }
 130
 131
 132 void CAbstractFile::SetFileName(const CPath& fileName)
 133 {
 134         m_fileName = fileName;
 135 }
 136
 137 uint32 CAbstractFile::GetIntTagValue(uint8 tagname) const
 138 {
 139         ArrayOfCTag::const_iterator it = m_taglist.begin();
 140         for (; it != m_taglist.end(); ++it){
 141                 if (((*it).GetNameID() == tagname) && (*it).IsInt()) {
 142                         return (*it).GetInt();
 143                 }
 144         }
 145         return 0;
 146 }
 147
 148 bool CAbstractFile::GetIntTagValue(uint8 tagname, uint32& ruValue) const
 149 {
 150         ArrayOfCTag::const_iterator it = m_taglist.begin();
 151         for (; it != m_taglist.end(); ++it){
 152                 if (((*it).GetNameID() == tagname) && (*it).IsInt()){
 153                         ruValue = (*it).GetInt();
 154                         return true;
 155                 }
 156         }
 157         return false;
 158 }
 159
 160 uint32 CAbstractFile::GetIntTagValue(const wxString& tagname) const
 161 {
 162         ArrayOfCTag::const_iterator it = m_taglist.begin();
 163         for (; it != m_taglist.end(); ++it){
 164                 if ((*it).IsInt() && ((*it).GetName() == tagname)) {
 165                         return (*it).GetInt();
 166                 }
 167         }
 168         return 0;
 169 }
 170
 171 const wxString& CAbstractFile::GetStrTagValue(uint8 tagname) const
 172 {
 173         ArrayOfCTag::const_iterator it = m_taglist.begin();
 174         for (; it != m_taglist.end(); ++it){
 175                 if ((*it).GetNameID() == tagname && (*it).IsStr()) {
 176                         return (*it).GetStr();
 177                 }
 178         }
 179         return EmptyString;
 180 }
 181
 182 const wxString& CAbstractFile::GetStrTagValue(const wxString& tagname) const
 183 {
 184         ArrayOfCTag::const_iterator it = m_taglist.begin();
 185         for (; it != m_taglist.end(); ++it){
 186                 if ((*it).IsStr() && ((*it).GetName() == tagname)) {
 187                         return (*it).GetStr();
 188                 }
 189         }
 190         return EmptyString;
 191 }
 192
 193 const CTag *CAbstractFile::GetTag(uint8 tagname, uint8 tagtype) const
 194 {
 195         ArrayOfCTag::const_iterator it = m_taglist.begin();
 196         for (; it != m_taglist.end(); ++it){
 197                 if ((*it).GetNameID() == tagname && (*it).GetType() == tagtype) {
 198                         return &(*it);
 199                 }
 200         }
 201         return NULL;
 202 }
 203
 204 const CTag *CAbstractFile::GetTag(const wxString& tagname, uint8 tagtype) const
 205 {
 206         ArrayOfCTag::const_iterator it = m_taglist.begin();
 207         for (; it != m_taglist.end(); ++it){
 208                 if ((*it).GetType() == tagtype && (*it).GetName() == tagname) {
 209                         return &(*it);
 210                 }
 211         }
 212         return NULL;
 213 }
 214
 215 const CTag *CAbstractFile::GetTag(uint8 tagname) const
 216 {
 217         ArrayOfCTag::const_iterator it = m_taglist.begin();
 218         for (; it != m_taglist.end(); ++it){
 219                 if ((*it).GetNameID() == tagname) {
 220                         return &(*it);
 221                 }
 222         }
 223         return NULL;
 224 }
 225
 226 const CTag *CAbstractFile::GetTag(const wxString& tagname) const
 227 {
 228         ArrayOfCTag::const_iterator it = m_taglist.begin();
 229         for (; it != m_taglist.end(); ++it){
 230                 if ((*it).GetName() == tagname) {
 231                         return &(*it);
 232                 }
 233         }
 234         return NULL;
 235 }
 236
 237 void CAbstractFile::AddTagUnique(const CTag &rTag)
 238 {
 239         ArrayOfCTag::iterator it = m_taglist.begin();
 240         for (; it != m_taglist.end(); ++it) {
 241                 if ( ( ((*it).GetNameID() != 0 &&
 242                         (*it).GetNameID() == rTag.GetNameID()) ||
 243                        (!(*it).GetName().IsEmpty() &&
 244                         !rTag.GetName().IsEmpty() &&
 245                         (*it).GetName() == rTag.GetName()) ) &&
 246                      (*it).GetType() == rTag.GetType()){
 247                         m_taglist.erase(it);
 248                         m_taglist.insert(it, rTag);
 249                         return;
 250                 }
 251         }
 252         m_taglist.push_back(rTag);
 253 }
 254
 255 #ifndef CLIENT_GUI
 256 void CAbstractFile::AddNote(Kademlia::CEntry *pEntry)
 257 {
 258         CKadEntryPtrList::iterator it = m_kadNotes.begin();
 259         for (; it != m_kadNotes.end(); ++it) {
 260                 Kademlia::CEntry* entry = *it;
 261                 if(entry->m_uIP == pEntry->m_uIP || entry->m_uSourceID == pEntry->m_uSourceID) {
 262                         delete pEntry;
 263                         return;
 264                 }
 265         }
 266         m_kadNotes.push_front(pEntry);
 267 }
 268 #else
 269 void CAbstractFile::AddNote(Kademlia::CEntry *)
 270 {
 271 }
 272 #endif
 273
 274
 275 /* Known File */
 276
 277 CKnownFile::CKnownFile()
 278 {
 279         Init();
 280 }
 281
 282 CKnownFile::CKnownFile(uint32 ecid) : CECID(ecid)
 283 {
 284         Init();
 285 }
 286
 287
 288 //#warning Experimental: Construct a CKnownFile from a CSearchFile
 289 CKnownFile::CKnownFile(const CSearchFile &searchFile)
 290 :
 291 // This will copy the file hash
 292 CAbstractFile(static_cast<const CAbstractFile &>(searchFile))
 293 {
 294         Init();
 295
 296         // Use CKnownFile::SetFileName()
 297         SetFileName(searchFile.GetFileName());
 298
 299         // Use CKnownFile::SetFileSize()
 300         SetFileSize(searchFile.GetFileSize());
 301 }
 302
 303
 304 void CKnownFile::Init()
 305 {
 306         m_showSources = false;
 307         m_showPeers = false;
 308         m_nCompleteSourcesTime = time(NULL);
 309         m_nCompleteSourcesCount = 0;
 310         m_nCompleteSourcesCountLo = 0;
 311         m_nCompleteSourcesCountHi = 0;
 312         m_bCommentLoaded = false;
 313         m_iPartCount = 0;
 314         m_iED2KPartCount = 0;
 315         m_iED2KPartHashCount = 0;
 316         m_PublishedED2K = false;
 317         kadFileSearchID = 0;
 318         m_lastPublishTimeKadSrc = 0;
 319         m_lastPublishTimeKadNotes = 0;
 320         m_lastBuddyIP = 0;
 321         m_lastDateChanged = 0;
 322         m_bAutoUpPriority = thePrefs::GetNewAutoUp();
 323         m_iUpPriority = ( m_bAutoUpPriority ) ? PR_HIGH : PR_NORMAL;
 324
 325         statistic.fileParent = this;
 326
 327 #ifndef CLIENT_GUI
 328         m_pAICHHashSet = new CAICHHashSet(this);
 329 #endif
 330 }
 331
 332
 333 void CKnownFile::SetFileSize(uint64 nFileSize)
 334 {
 335         CAbstractFile::SetFileSize(nFileSize);
 336 #ifndef CLIENT_GUI
 337         m_pAICHHashSet->SetFileSize(nFileSize);
 338 #endif
 339
 340         // Examples of parthashs, hashsets and filehashs for different filesizes
 341         // according the ed2k protocol
 342         //----------------------------------------------------------------------
 343         //
 344         //File size: 3 bytes
 345         //File hash: 2D55E87D0E21F49B9AD25F98531F3724
 346         //Nr. hashs: 0
 347         //
 348         //
 349         //File size: 1*PARTSIZE
 350         //File hash: A72CA8DF7F07154E217C236C89C17619
 351         //Nr. hashs: 2
 352         //Hash[  0]: 4891ED2E5C9C49F442145A3A5F608299
 353         //Hash[  1]: 31D6CFE0D16AE931B73C59D7E0C089C0   *special part hash*
 354         //
 355         //
 356         //File size: 1*PARTSIZE + 1 byte
 357         //File hash: 2F620AE9D462CBB6A59FE8401D2B3D23
 358         //Nr. hashs: 2
 359         //Hash[  0]: 121795F0BEDE02DDC7C5426D0995F53F
 360         //Hash[  1]: C329E527945B8FE75B3C5E8826755747
 361         //
 362         //
 363         //File size: 2*PARTSIZE
 364         //File hash: A54C5E562D5E03CA7D77961EB9A745A4
 365         //Nr. hashs: 3
 366         //Hash[  0]: B3F5CE2A06BF403BFB9BFFF68BDDC4D9
 367         //Hash[  1]: 509AA30C9EA8FC136B1159DF2F35B8A9
 368         //Hash[  2]: 31D6CFE0D16AE931B73C59D7E0C089C0   *special part hash*
 369         //
 370         //
 371         //File size: 3*PARTSIZE
 372         //File hash: 5E249B96F9A46A18FC2489B005BF2667
 373         //Nr. hashs: 4
 374         //Hash[  0]: 5319896A2ECAD43BF17E2E3575278E72
 375         //Hash[  1]: D86EF157D5E49C5ED502EDC15BB5F82B
 376         //Hash[  2]: 10F2D5B1FCB95C0840519C58D708480F
 377         //Hash[  3]: 31D6CFE0D16AE931B73C59D7E0C089C0   *special part hash*
 378         //
 379         //
 380         //File size: 3*PARTSIZE + 1 byte
 381         //File hash: 797ED552F34380CAFF8C958207E40355
 382         //Nr. hashs: 4
 383         //Hash[  0]: FC7FD02CCD6987DCF1421F4C0AF94FB8
 384         //Hash[  1]: 2FE466AF8A7C06DA3365317B75A5ACFE
 385         //Hash[  2]: 873D3BF52629F7C1527C6E8E473C1C30
 386         //Hash[  3]: BCE50BEE7877BB07BB6FDA56BFE142FB
 387         //
 388
 389         // File size       Data parts      ED2K parts      ED2K part hashs
 390         // ---------------------------------------------------------------
 391         // 1..PARTSIZE-1   1               1               0(!)
 392         // PARTSIZE        1               2(!)            2(!)
 393         // PARTSIZE+1      2               2               2
 394         // PARTSIZE*2      2               3(!)            3(!)
 395         // PARTSIZE*2+1    3               3               3
 396
 397         if (nFileSize == 0){
 398                 //wxFAIL; // Kry - Why commented out by lemonfan? it can never be 0
 399                 m_iPartCount = 0;
 400                 m_iED2KPartCount = 0;
 401                 m_iED2KPartHashCount = 0;
 402                 m_sizeLastPart = 0;
 403                 return;
 404         }
 405
 406         // nr. of data parts
 407         m_iPartCount = nFileSize / PARTSIZE + 1;
 408         // size of last part
 409         m_sizeLastPart = nFileSize % PARTSIZE;
 410         // file with size of n * PARTSIZE
 411         if (m_sizeLastPart == 0) {
 412                 m_sizeLastPart = PARTSIZE;
 413                 m_iPartCount--;
 414         }
 415
 416         // nr. of parts to be used with OP_FILESTATUS
 417         m_iED2KPartCount = nFileSize / PARTSIZE + 1;
 418
 419         // nr. of parts to be used with OP_HASHSETANSWER
 420         m_iED2KPartHashCount = nFileSize / PARTSIZE;
 421         if (m_iED2KPartHashCount != 0) {
 422                 m_iED2KPartHashCount += 1;
 423         }
 424 }
 425
 426
 427 void CKnownFile::AddUploadingClient(CUpDownClient* client)
 428 {
 429         m_ClientUploadList.insert(CCLIENTREF(client, wxT("CKnownFile::AddUploadingClient m_ClientUploadList")));
 430
 431         SourceItemType type = UNAVAILABLE_SOURCE;
 432         switch (client->GetUploadState()) {
 433                 case US_UPLOADING:
 434                 case US_ONUPLOADQUEUE:
 435                         type = AVAILABLE_SOURCE;
 436                         break;
 437                 default: {
 438                         // Any other state is UNAVAILABLE_SOURCE by default.
 439                 }
 440         }
 441
 442         Notify_SharedCtrlAddClient(this, CCLIENTREF(client, wxT("CKnownFile::AddUploadingClient Notify_SharedCtrlAddClient")), type);
 443
 444         UpdateAutoUpPriority();
 445 }
 446
 447
 448 void CKnownFile::RemoveUploadingClient(CUpDownClient* client)
 449 {
 450         if (m_ClientUploadList.erase(CCLIENTREF(client, wxEmptyString))) {
 451                 Notify_SharedCtrlRemoveClient(client->ECID(), this);
 452                 UpdateAutoUpPriority();
 453         }
 454 }
 455
 456
 457 #ifdef CLIENT_GUI
 458
 459 CKnownFile::CKnownFile(CEC_SharedFile_Tag *tag) : CECID(tag->ID())
 460 {
 461         Init();
 462
 463         m_abyFileHash = tag->FileHash();
 464         SetFileSize(tag->SizeFull());
 465         m_AvailPartFrequency.insert(m_AvailPartFrequency.end(), m_iPartCount, 0);
 466         m_queuedCount = 0;
 467 }
 468
 469 CKnownFile::~CKnownFile()
 470 {
 471 }
 472
 473 void CKnownFile::UpdateAutoUpPriority()
 474 {
 475 }
 476
 477
 478 #else // ! CLIENT_GUI
 479
 480 CKnownFile::~CKnownFile()
 481 {
 482         SourceSet::iterator it = m_ClientUploadList.begin();
 483         for ( ; it != m_ClientUploadList.end(); ++it ) {
 484                 it->ClearUploadFileID();
 485         }
 486
 487         delete m_pAICHHashSet;
 488 }
 489
 490
 491 void CKnownFile::SetFilePath(const CPath& filePath)
 492 {
 493         m_filePath = filePath;
 494 }
 495
 496
 497 // needed for memfiles. its probably better to switch everything to CFile...
 498 bool CKnownFile::LoadHashsetFromFile(const CFileDataIO* file, bool checkhash)
 499 {
 500         CMD4Hash checkid = file->ReadHash();
 501
 502         uint16 parts = file->ReadUInt16();
 503         for (uint16 i = 0; i < parts; ++i){
 504                 CMD4Hash cur_hash = file->ReadHash();
 505                 m_hashlist.push_back(cur_hash);
 506         }
 507
 508         // SLUGFILLER: SafeHash - always check for valid m_hashlist
 509         if (!checkhash){
 510                 m_abyFileHash = checkid;
 511                 if (parts <= 1) {       // nothing to check
 512                         return true;
 513                 }
 514         } else {
 515                 if ( m_abyFileHash != checkid ) {
 516                         return false;   // wrong file?
 517                 } else {
 518                         if (parts != GetED2KPartHashCount()) {
 519                                 return false;
 520                         }
 521                 }
 522         }
 523         // SLUGFILLER: SafeHash
 524
 525         // trust noone ;-)
 526         // lol, useless comment but made me lmao
 527         // wtf you guys are weird.
 528
 529         if (!m_hashlist.empty()) {
 530                 CreateHashFromHashlist(m_hashlist, &checkid);
 531         }
 532
 533         if ( m_abyFileHash == checkid ) {
 534                 return true;
 535         } else {
 536                 m_hashlist.clear();
 537                 return false;
 538         }
 539 }
 540
 541
 542 bool CKnownFile::LoadTagsFromFile(const CFileDataIO* file)
 543 {
 544         uint32 tagcount = file->ReadUInt32();
 545         for (uint32 j = 0; j != tagcount; ++j) {
 546                 CTag newtag(*file, true);
 547                 switch(newtag.GetNameID()){
 548                         case FT_FILENAME:
 549                                 if (GetFileName().IsOk()) {
 550                                         // Unlike eMule, we actually prefer the second
 551                                         // filename tag, since we use it to specify the
 552                                         // 'universial' filename (see CPath::ToUniv).
 553                                         CPath path = CPath::FromUniv(newtag.GetStr());
 554
 555                                         // May be invalid, if from older versions where
 556                                         // unicoded filenames be saved as empty-strings.
 557                                         if (path.IsOk()) {
 558                                                 SetFileName(path);
 559                                         }
 560                                 } else {
 561                                         SetFileName(CPath(newtag.GetStr()));
 562                                 }
 563                                 break;
 564
 565                         case FT_FILESIZE:
 566                                 SetFileSize(newtag.GetInt());
 567                                 m_AvailPartFrequency.clear();
 568                                 m_AvailPartFrequency.insert(
 569                                         m_AvailPartFrequency.begin(),
 570                                         GetPartCount(), 0);
 571                                 break;
 572
 573                         case FT_ATTRANSFERRED:
 574                                 statistic.alltimetransferred += newtag.GetInt();
 575                                 break;
 576
 577                         case FT_ATTRANSFERREDHI:
 578                                 statistic.alltimetransferred =
 579                                         (((uint64)newtag.GetInt()) << 32) +
 580                                         ((uint64)statistic.alltimetransferred);
 581                                 break;
 582
 583                         case FT_ATREQUESTED:
 584                                 statistic.alltimerequested = newtag.GetInt();
 585                                 break;
 586
 587                         case FT_ATACCEPTED:
 588                                 statistic.alltimeaccepted = newtag.GetInt();
 589                                 break;
 590
 591                         case FT_ULPRIORITY:
 592                                 m_iUpPriority = newtag.GetInt();
 593                                 if( m_iUpPriority == PR_AUTO ){
 594                                         m_iUpPriority = PR_HIGH;
 595                                         m_bAutoUpPriority = true;
 596                                 } else {
 597                                         if (    m_iUpPriority != PR_VERYLOW &&
 598                                                 m_iUpPriority != PR_LOW &&
 599                                                 m_iUpPriority != PR_NORMAL &&
 600                                                 m_iUpPriority != PR_HIGH &&
 601                                                 m_iUpPriority != PR_VERYHIGH &&
 602                                                 m_iUpPriority != PR_POWERSHARE) {
 603                                                 m_iUpPriority = PR_NORMAL;
 604                                         }
 605
 606                                         m_bAutoUpPriority = false;
 607                                 }
 608                                 break;
 609
 610                         case FT_PERMISSIONS:
 611                                 // Ignore it, it's not used anymore.
 612                                 break;
 613
 614                         case FT_AICH_HASH: {
 615                                 CAICHHash hash;
 616                                 bool hashSizeOk =
 617                                         hash.DecodeBase32(newtag.GetStr()) == CAICHHash::GetHashSize();
 618                                 wxASSERT(hashSizeOk);
 619                                 if (hashSizeOk) {
 620                                         m_pAICHHashSet->SetMasterHash(hash, AICH_HASHSETCOMPLETE);
 621                                 }
 622                                 break;
 623                         }
 624
 625                         case FT_KADLASTPUBLISHSRC:
 626                                 SetLastPublishTimeKadSrc( newtag.GetInt(), 0 );
 627
 628                                 if(GetLastPublishTimeKadSrc() > (uint32)time(NULL)+KADEMLIAREPUBLISHTIMES) {
 629                                         //There may be a posibility of an older client that saved a random number here.. This will check for that..
 630                                         SetLastPublishTimeKadSrc(0, 0);
 631                                 }
 632                                 break;
 633
 634                         case FT_KADLASTPUBLISHNOTES:
 635                                 SetLastPublishTimeKadNotes( newtag.GetInt() );
 636                                 break;
 637
 638                         case FT_KADLASTPUBLISHKEY:
 639                                 // Just purge it
 640                                 wxASSERT( newtag.IsInt() );
 641                                 break;
 642
 643                         default:
 644                                 // Store them here and write them back on saving.
 645                                 m_taglist.push_back(newtag);
 646                 }
 647         }
 648
 649         return true;
 650 }
 651
 652
 653 bool CKnownFile::LoadDateFromFile(const CFileDataIO* file)
 654 {
 655         m_lastDateChanged = file->ReadUInt32();
 656
 657         return true;
 658 }
 659
 660
 661 bool CKnownFile::LoadFromFile(const CFileDataIO* file)
 662 {
 663         // SLUGFILLER: SafeHash - load first, verify later
 664         bool ret1 = LoadDateFromFile(file);
 665         bool ret2 = LoadHashsetFromFile(file,false);
 666         bool ret3 = LoadTagsFromFile(file);
 667         UpdatePartsInfo();
 668         // Final hash-count verification, needs to be done after the tags are loaded.
 669         return ret1 && ret2 && ret3 && GetED2KPartHashCount()==GetHashCount();
 670         // SLUGFILLER: SafeHash
 671 }
 672
 673
 674 bool CKnownFile::WriteToFile(CFileDataIO* file)
 675 {
 676         wxCHECK(!IsPartFile(), false);
 677
 678         // date
 679         file->WriteUInt32(m_lastDateChanged);
 680         // hashset
 681         file->WriteHash(m_abyFileHash);
 682
 683         uint16 parts = m_hashlist.size();
 684         file->WriteUInt16(parts);
 685
 686         for (int i = 0; i < parts; ++i)
 687                 file->WriteHash(m_hashlist[i]);
 688
 689         //tags
 690         const int iFixedTags = 8;
 691         uint32 tagcount = iFixedTags;
 692         if (HasProperAICHHashSet()) {
 693                 tagcount++;
 694         }
 695         // Float meta tags are currently not written. All older eMule versions < 0.28a have
 696         // a bug in the meta tag reading+writing code. To achive maximum backward
 697         // compatibility for met files with older eMule versions we just don't write float
 698         // tags. This is OK, because we (eMule) do not use float tags. The only float tags
 699         // we may have to handle is the '# Sent' tag from the Hybrid, which is pretty
 700         // useless but may be received from us via the servers.
 701         //
 702         // The code for writing the float tags SHOULD BE ENABLED in SOME MONTHS (after most
 703         // people are using the newer eMule versions which do not write broken float tags).
 704         for (size_t j = 0; j < m_taglist.size(); ++j){
 705                 if (m_taglist[j].IsInt() || m_taglist[j].IsStr()) {
 706                         ++tagcount;
 707                 }
 708         }
 709
 710         if (m_lastPublishTimeKadSrc) {
 711                 ++tagcount;
 712         }
 713
 714         if (m_lastPublishTimeKadNotes){
 715                 ++tagcount;
 716         }
 717
 718         // standard tags
 719
 720         file->WriteUInt32(tagcount);
 721
 722         // We still save the unicoded filename, for backwards
 723         // compatibility with pre-2.2 and other clients.
 724         CTagString nametag_unicode(FT_FILENAME, GetFileName().GetRaw());
 725         // We write it with BOM to kep eMule compatibility
 726         nametag_unicode.WriteTagToFile(file,utf8strOptBOM);
 727
 728         // The non-unicoded filename is written in an 'universial'
 729         // format, which allows us to identify files, even if the
 730         // system locale changes.
 731         CTagString nametag(FT_FILENAME, CPath::ToUniv(GetFileName()));
 732         nametag.WriteTagToFile(file);
 733
 734         CTagIntSized sizetag(FT_FILESIZE, GetFileSize(), IsLargeFile() ? 64 : 32);
 735         sizetag.WriteTagToFile(file);
 736
 737         // statistic
 738         uint32 tran;
 739         tran=statistic.alltimetransferred & 0xFFFFFFFF;
 740         CTagInt32 attag1(FT_ATTRANSFERRED, tran);
 741         attag1.WriteTagToFile(file);
 742
 743         tran=statistic.alltimetransferred>>32;
 744         CTagInt32 attag4(FT_ATTRANSFERREDHI, tran);
 745         attag4.WriteTagToFile(file);
 746
 747         CTagInt32 attag2(FT_ATREQUESTED, statistic.GetAllTimeRequests());
 748         attag2.WriteTagToFile(file);
 749
 750         CTagInt32 attag3(FT_ATACCEPTED, statistic.GetAllTimeAccepts());
 751         attag3.WriteTagToFile(file);
 752
 753         // priority N permission
 754         CTagInt32 priotag(FT_ULPRIORITY, IsAutoUpPriority() ? PR_AUTO : m_iUpPriority);
 755         priotag.WriteTagToFile(file);
 756
 757         //AICH Filehash
 758         if (HasProperAICHHashSet()) {
 759                 CTagString aichtag(FT_AICH_HASH, m_pAICHHashSet->GetMasterHash().GetString());
 760                 aichtag.WriteTagToFile(file);
 761         }
 762
 763         // Kad sources
 764         if (m_lastPublishTimeKadSrc){
 765                 CTagInt32 kadLastPubSrc(FT_KADLASTPUBLISHSRC, m_lastPublishTimeKadSrc);
 766                 kadLastPubSrc.WriteTagToFile(file);
 767         }
 768
 769         // Kad notes
 770         if (m_lastPublishTimeKadNotes){
 771                 CTagInt32 kadLastPubNotes(FT_KADLASTPUBLISHNOTES, m_lastPublishTimeKadNotes);
 772                 kadLastPubNotes.WriteTagToFile(file);
 773         }
 774
 775         //other tags
 776         for (size_t j = 0; j < m_taglist.size(); ++j){
 777                 if (m_taglist[j].IsInt() || m_taglist[j].IsStr()) {
 778                         m_taglist[j].WriteTagToFile(file);
 779                 }
 780         }
 781         return true;
 782 }
 783
 784
 785 void CKnownFile::CreateHashFromHashlist(const ArrayOfCMD4Hash& hashes, CMD4Hash* Output)
 786 {
 787         wxCHECK_RET(hashes.size(), wxT("No input to hash from in CreateHashFromHashlist"));
 788
 789         std::vector<byte> buffer(hashes.size() * MD4HASH_LENGTH);
 790         std::vector<byte>::iterator it = buffer.begin();
 791
 792         for (size_t i = 0; i < hashes.size(); ++i) {
 793                 it = STLCopy_n(hashes[i].GetHash(), MD4HASH_LENGTH, it);
 794         }
 795
 796         CreateHashFromInput(&buffer[0], buffer.size(), Output, NULL);
 797 }
 798
 799
 800 void CKnownFile::CreateHashFromFile(CFileAutoClose& file, uint64 offset, uint32 Length, CMD4Hash* Output, CAICHHashTree* pShaHashOut)
 801 {
 802         wxCHECK_RET(Length, wxT("No input to hash from in CreateHashFromFile"));
 803
 804         CFileArea area;
 805         area.ReadAt(file, offset, Length);
 806
 807         CreateHashFromInput(area.GetBuffer(), Length, Output, pShaHashOut);
 808         area.CheckError();
 809 }
 810
 811
 812 void CKnownFile::CreateHashFromInput(const byte* input, uint32 Length, CMD4Hash* Output, CAICHHashTree* pShaHashOut )
 813 {
 814         wxASSERT_MSG(Output || pShaHashOut, wxT("Nothing to do in CreateHashFromInput"));
 815         wxCHECK_RET(input, wxT("No input to hash from in CreateHashFromInput"));
 816         wxASSERT(Length <= PARTSIZE); // We never hash more than one PARTSIZE
 817
 818         CMemFile data(input, Length);
 819
 820         uint32 Required = Length;
 821         byte   X[64*128];
 822
 823         uint32  posCurrentEMBlock = 0;
 824         uint32  nIACHPos = 0;
 825         CScopedPtr<CAICHHashAlgo> pHashAlg(CAICHHashSet::GetNewHashAlgo());
 826
 827         // This is all AICH.
 828         while (Required >= 64) {
 829                 uint32 len = Required / 64;
 830                 if (len > sizeof(X)/(64 * sizeof(X[0]))) {
 831                         len = sizeof(X)/(64 * sizeof(X[0]));
 832                 }
 833
 834                 data.Read(&X, len * 64);
 835
 836                 // SHA hash needs 180KB blocks
 837                 if (pShaHashOut) {
 838                         if (nIACHPos + len*64 >= EMBLOCKSIZE) {
 839                                 uint32 nToComplete = EMBLOCKSIZE - nIACHPos;
 840                                 pHashAlg->Add(X, nToComplete);
 841                                 wxASSERT( nIACHPos + nToComplete == EMBLOCKSIZE );
 842                                 pShaHashOut->SetBlockHash(EMBLOCKSIZE, posCurrentEMBlock, pHashAlg.get());
 843                                 posCurrentEMBlock += EMBLOCKSIZE;
 844                                 pHashAlg->Reset();
 845                                 pHashAlg->Add(X+nToComplete,(len*64) - nToComplete);
 846                                 nIACHPos = (len*64) - nToComplete;
 847                         }
 848                         else{
 849                                 pHashAlg->Add(X, len*64);
 850                                 nIACHPos += len*64;
 851                         }
 852                 }
 853
 854                 Required -= len*64;
 855         }
 856         // bytes to read
 857         Required = Length % 64;
 858         if (Required != 0){
 859                 data.Read(&X,Required);
 860
 861                 if (pShaHashOut != NULL){
 862                         if (nIACHPos + Required >= EMBLOCKSIZE){
 863                                 uint32 nToComplete = EMBLOCKSIZE - nIACHPos;
 864                                 pHashAlg->Add(X, nToComplete);
 865                                 wxASSERT( nIACHPos + nToComplete == EMBLOCKSIZE );
 866                                 pShaHashOut->SetBlockHash(EMBLOCKSIZE, posCurrentEMBlock, pHashAlg.get());
 867                                 posCurrentEMBlock += EMBLOCKSIZE;
 868                                 pHashAlg->Reset();
 869                                 pHashAlg->Add(X+nToComplete, Required - nToComplete);
 870                                 nIACHPos = Required - nToComplete;
 871                         }
 872                         else{
 873                                 pHashAlg->Add(X, Required);
 874                                 nIACHPos += Required;
 875                         }
 876                 }
 877         }
 878         if (pShaHashOut != NULL){
 879                 if(nIACHPos > 0){
 880                         pShaHashOut->SetBlockHash(nIACHPos, posCurrentEMBlock, pHashAlg.get());
 881                         posCurrentEMBlock += nIACHPos;
 882                 }
 883                 wxASSERT( posCurrentEMBlock == Length );
 884                 wxCHECK2( pShaHashOut->ReCalculateHash(pHashAlg.get(), false), );
 885         }
 886
 887         if (Output != NULL){
 888                 #ifdef __WEAK_CRYPTO__
 889                         CryptoPP::Weak::MD4 md4_hasher;
 890                 #else
 891                         CryptoPP::MD4 md4_hasher;
 892                 #endif
 893                  md4_hasher.CalculateDigest(Output->GetHash(), input, Length);
 894         }
 895 }
 896
 897
 898 const CMD4Hash& CKnownFile::GetPartHash(uint16 part) const {
 899         wxASSERT( part < m_hashlist.size() );
 900
 901         return m_hashlist[part];
 902 }
 903
 904 CPacket* CKnownFile::CreateSrcInfoPacket(const CUpDownClient* forClient, uint8 byRequestedVersion, uint16 nRequestedOptions)
 905 {
 906         // Kad reviewed
 907
 908         if (m_ClientUploadList.empty()) {
 909                 return NULL;
 910         }
 911
 912         if ((((CKnownFile*)forClient->GetRequestFile() != this)
 913                 && ((CKnownFile*)forClient->GetUploadFile() != this)) || forClient->GetUploadFileID() != GetFileHash()) {
 914                 wxString file1 = _("Unknown");
 915                 if (forClient->GetRequestFile() && forClient->GetRequestFile()->GetFileName().IsOk()) {
 916                         file1 = forClient->GetRequestFile()->GetFileName().GetPrintable();
 917                 } else if (forClient->GetUploadFile() && forClient->GetUploadFile()->GetFileName().IsOk()) {
 918                         file1 = forClient->GetUploadFile()->GetFileName().GetPrintable();
 919                 }
 920                 wxString file2 = _("Unknown");
 921                 if (GetFileName().IsOk()) {
 922                         file2 = GetFileName().GetPrintable();
 923                 }
 924                 AddDebugLogLineN(logKnownFiles, wxT("File mismatch on source packet (K) Sending: ") + file1 + wxT("  From: ") + file2);
 925                 return NULL;
 926         }
 927
 928         const BitVector& rcvstatus = forClient->GetUpPartStatus();
 929         bool SupportsUploadChunksState = !rcvstatus.empty();
 930         //wxASSERT(rcvstatus.size() == GetPartCount()); // Obviously!
 931         if (rcvstatus.size() != GetPartCount()) {
 932                 // Yuck. Same file but different part count? Seriously fucked up.
 933                 AddDebugLogLineN(logKnownFiles, CFormat(wxT("Impossible situation: different partcounts for the same known file: %i (client) and %i (file)")) % rcvstatus.size() % GetPartCount());
 934                 return NULL;
 935         }
 936
 937         CMemFile data(1024);
 938
 939         uint8 byUsedVersion;
 940         bool bIsSX2Packet;
 941         if (forClient->SupportsSourceExchange2() && byRequestedVersion > 0){
 942                 // the client uses SourceExchange2 and requested the highest version he knows
 943                 // and we send the highest version we know, but of course not higher than his request
 944                 byUsedVersion = std::min(byRequestedVersion, (uint8)SOURCEEXCHANGE2_VERSION);
 945                 bIsSX2Packet = true;
 946                 data.WriteUInt8(byUsedVersion);
 947
 948                 // we don't support any special SX2 options yet, reserved for later use
 949                 if (nRequestedOptions != 0) {
 950                         AddDebugLogLineN(logKnownFiles, CFormat(wxT("Client requested unknown options for SourceExchange2: %u")) % nRequestedOptions);
 951                 }
 952         } else {
 953                 byUsedVersion = forClient->GetSourceExchange1Version();
 954                 bIsSX2Packet = false;
 955                 if (forClient->SupportsSourceExchange2()) {
 956                         AddDebugLogLineN(logKnownFiles, wxT("Client which announced to support SX2 sent SX1 packet instead"));
 957                 }
 958         }
 959
 960         uint16 nCount = 0;
 961
 962         data.WriteHash(forClient->GetUploadFileID());
 963         data.WriteUInt16(nCount);
 964         uint32 cDbgNoSrc = 0;
 965
 966         SourceSet::iterator it = m_ClientUploadList.begin();
 967         for ( ; it != m_ClientUploadList.end(); it++ ) {
 968                 const CUpDownClient *cur_src = it->GetClient();
 969
 970                 if (    cur_src->HasLowID() ||
 971                         cur_src == forClient ||
 972                         !(      cur_src->GetUploadState() == US_UPLOADING ||
 973                                 cur_src->GetUploadState() == US_ONUPLOADQUEUE)) {
 974                         continue;
 975                 }
 976
 977                 bool bNeeded = false;
 978
 979                 if ( SupportsUploadChunksState ) {
 980                         const BitVector& srcstatus = cur_src->GetUpPartStatus();
 981                         if ( !srcstatus.empty() ) {
 982                                 //wxASSERT(srcstatus.size() == GetPartCount()); // Obviously!
 983                                 if (srcstatus.size() != GetPartCount()) {
 984                                         continue;
 985                                 }
 986                                 if ( cur_src->GetUpPartCount() == forClient->GetUpPartCount() ) {
 987                                         for (int x = 0; x < GetPartCount(); x++ ) {
 988                                                 if ( srcstatus.get(x) && !rcvstatus.get(x) ) {
 989                                                         // We know the receiving client needs
 990                                                         // a chunk from this client.
 991                                                         bNeeded = true;
 992                                                         break;
 993                                                 }
 994                                         }
 995                                 }
 996                         } else {
 997                                 cDbgNoSrc++;
 998                                 // This client doesn't support upload chunk status.
 999                                 // So just send it and hope for the best.
1000                                 bNeeded = true;
1001                         }
1002                 } else {
1003                         // remote client does not support upload chunk status,
1004                         // search sources which have at least one complete part
1005                         // we could even sort the list of sources by available
1006                         // chunks to return as much sources as possible which
1007                         // have the most available chunks. but this could be
1008                         // a noticeable performance problem.
1009                         const BitVector& srcstatus = cur_src->GetUpPartStatus();
1010                         if ( !srcstatus.empty() ) {
1011                                 //wxASSERT(srcstatus.size() == GetPartCount());
1012                                 if (srcstatus.size() != GetPartCount()) {
1013                                         continue;
1014                                 }
1015                                 for (int x = 0; x < GetPartCount(); x++ ) {
1016                                         if ( srcstatus.get(x) ) {
1017                                                 // this client has at least one chunk
1018                                                 bNeeded = true;
1019                                                 break;
1020                                         }
1021                                 }
1022                         } else {
1023                                 // This client doesn't support upload chunk status.
1024                                 // So just send it and hope for the best.
1025                                 bNeeded = true;
1026                         }
1027                 }
1028
1029                 if ( bNeeded ) {
1030                         nCount++;
1031                         uint32 dwID;
1032                         if(byUsedVersion >= 3) {
1033                                 dwID = cur_src->GetUserIDHybrid();
1034                         } else {
1035                                 dwID = cur_src->GetIP();
1036                         }
1037                         data.WriteUInt32(dwID);
1038                         data.WriteUInt16(cur_src->GetUserPort());
1039                         data.WriteUInt32(cur_src->GetServerIP());
1040                         data.WriteUInt16(cur_src->GetServerPort());
1041
1042                         if (byUsedVersion >= 2) {
1043                             data.WriteHash(cur_src->GetUserHash());
1044                         }
1045
1046                         if (byUsedVersion >= 4){
1047                                 // CryptSettings - SourceExchange V4
1048                                 // 5 Reserved (!)
1049                                 // 1 CryptLayer Required
1050                                 // 1 CryptLayer Requested
1051                                 // 1 CryptLayer Supported
1052                                 const uint8 uSupportsCryptLayer = cur_src->SupportsCryptLayer() ? 1 : 0;
1053                                 const uint8 uRequestsCryptLayer = cur_src->RequestsCryptLayer() ? 1 : 0;
1054                                 const uint8 uRequiresCryptLayer = cur_src->RequiresCryptLayer() ? 1 : 0;
1055                                 const uint8 byCryptOptions = (uRequiresCryptLayer << 2) | (uRequestsCryptLayer << 1) | (uSupportsCryptLayer << 0);
1056                                 data.WriteUInt8(byCryptOptions);
1057                         }
1058
1059                         if (nCount > 500) {
1060                                 break;
1061                         }
1062                 }
1063         }
1064
1065         if (!nCount) {
1066                 return 0;
1067         }
1068
1069         data.Seek(bIsSX2Packet ? 17 : 16, wxFromStart);
1070         data.WriteUInt16(nCount);
1071
1072         CPacket* result = new CPacket(data, OP_EMULEPROT, bIsSX2Packet ? OP_ANSWERSOURCES2 : OP_ANSWERSOURCES);
1073
1074         if ( result->GetPacketSize() > 354 ) {
1075                 result->PackPacket();
1076         }
1077
1078         return result;
1079 }
1080
1081
1082 void CKnownFile::CreateOfferedFilePacket(
1083         CMemFile *files,
1084         CServer *pServer,
1085         CUpDownClient *pClient) {
1086
1087         // This function is used for offering files to the local server and for sending
1088         // shared files to some other client. In each case we send our IP+Port only, if
1089         // we have a HighID.
1090
1091         wxASSERT(!(pClient && pServer));
1092
1093         SetPublishedED2K(true);
1094         files->WriteHash(GetFileHash());
1095
1096         uint32 nClientID = 0;
1097         uint16 nClientPort = 0;
1098
1099         if (pServer) {
1100                 if (pServer->GetTCPFlags() & SRV_TCPFLG_COMPRESSION) {
1101                         #define FILE_COMPLETE_ID                0xfbfbfbfb
1102                         #define FILE_COMPLETE_PORT      0xfbfb
1103                         #define FILE_INCOMPLETE_ID      0xfcfcfcfc
1104                         #define FILE_INCOMPLETE_PORT    0xfcfc
1105                         // complete   file: ip 251.251.251 (0xfbfbfbfb) port 0xfbfb
1106                         // incomplete file: op 252.252.252 (0xfcfcfcfc) port 0xfcfc
1107                         if (GetStatus() == PS_COMPLETE) {
1108                                 nClientID = FILE_COMPLETE_ID;
1109                                 nClientPort = FILE_COMPLETE_PORT;
1110                         } else {
1111                                 nClientID = FILE_INCOMPLETE_ID;
1112                                 nClientPort = FILE_INCOMPLETE_PORT;
1113                         }
1114                 } else {
1115                         if (theApp->IsConnectedED2K() && !::IsLowID(theApp->GetED2KID())){
1116                                 nClientID = theApp->GetID();
1117                                 nClientPort = thePrefs::GetPort();
1118                         }
1119                 }
1120         } else {
1121                 // Do not merge this with the above case - this one
1122                 // also checks Kad status.
1123                 if (theApp->IsConnected() && !theApp->IsFirewalled()) {
1124                         nClientID = theApp->GetID();
1125                         nClientPort = thePrefs::GetPort();
1126                 }
1127         }
1128
1129         files->WriteUInt32(nClientID);
1130         files->WriteUInt16(nClientPort);
1131
1132         TagPtrList tags;
1133
1134         // The printable filename is used because it's destined for another user.
1135         tags.push_back(new CTagString(FT_FILENAME, GetFileName().GetPrintable()));
1136
1137         if (pClient && pClient->GetVBTTags()) {
1138                 tags.push_back(new CTagVarInt(FT_FILESIZE, GetFileSize()));
1139         } else {
1140                 if (!IsLargeFile()){
1141                         tags.push_back(new CTagInt32(FT_FILESIZE, GetFileSize()));
1142                 } else {
1143                         // Large file
1144                         // we send 2*32 bit tags to servers, but a real 64 bit tag to other clients.
1145                         if (pServer) {
1146                                 if (!pServer->SupportsLargeFilesTCP()){
1147                                         wxFAIL;
1148                                         tags.push_back(new CTagInt32(FT_FILESIZE, 0));
1149                                 } else {
1150                                         tags.push_back(new CTagInt32(FT_FILESIZE, (uint32)GetFileSize()));
1151                                         tags.push_back(new CTagInt32(FT_FILESIZE_HI, (uint32)(GetFileSize() >> 32)));
1152                                 }
1153                         } else {
1154                                 if (!pClient->SupportsLargeFiles()) {
1155                                         wxFAIL;
1156                                         tags.push_back(new CTagInt32(FT_FILESIZE, 0));
1157                                 } else {
1158                                         tags.push_back(new CTagInt64(FT_FILESIZE, GetFileSize()));
1159                                 }
1160                         }
1161                 }
1162         }
1163
1164         if (GetFileRating()) {
1165                 tags.push_back(new CTagVarInt(FT_FILERATING, GetFileRating(), (pClient && pClient->GetVBTTags()) ? 0 : 32));
1166         }
1167
1168         // NOTE: Archives and CD-Images are published+searched with file type "Pro"
1169         bool bAddedFileType = false;
1170         if (pServer && (pServer->GetTCPFlags() & SRV_TCPFLG_TYPETAGINTEGER)) {
1171                 // Send integer file type tags to newer servers
1172                 EED2KFileType eFileType = GetED2KFileTypeSearchID(GetED2KFileTypeID(GetFileName()));
1173                 if (eFileType >= ED2KFT_AUDIO && eFileType <= ED2KFT_CDIMAGE) {
1174                         tags.push_back(new CTagInt32(FT_FILETYPE, eFileType));
1175                         bAddedFileType = true;
1176                 }
1177         }
1178         if (!bAddedFileType) {
1179                 // Send string file type tags to:
1180                 //      - newer servers, in case there is no integer type available for the file type (e.g. emulecollection)
1181                 //      - older servers
1182                 //      - all clients
1183                 wxString strED2KFileType(GetED2KFileTypeSearchTerm(GetED2KFileTypeID(GetFileName())));
1184                 if (!strED2KFileType.IsEmpty()) {
1185                         tags.push_back(new CTagString(FT_FILETYPE, strED2KFileType));
1186                 }
1187         }
1188
1189         // There, we could add MetaData info, if we ever get to have that.
1190
1191         EUtf8Str eStrEncode;
1192
1193         bool unicode_support =
1194                 // eservers that support UNICODE.
1195                 (pServer && (pServer->GetUnicodeSupport()))
1196                 ||
1197                 // clients that support unicode
1198                 (pClient && pClient->GetUnicodeSupport());
1199         eStrEncode = unicode_support ? utf8strRaw : utf8strNone;
1200
1201         files->WriteUInt32(tags.size());
1202
1203         // Sadly, eMule doesn't use a MISCOPTIONS flag on hello packet for this, so we
1204         // have to identify the support for new tags by version.
1205         bool new_ed2k =
1206                 // eMule client > 0.42f
1207                 (pClient && pClient->IsEmuleClient() && pClient->GetVersion()  >= MAKE_CLIENT_VERSION(0,42,7))
1208                 ||
1209                 // aMule >= 2.0.0rc8. Sadly, there's no way to check the rcN number, so I checked
1210                 // the rc8 changelog. On rc8 OSInfo was introduced, so...
1211                 (pClient && pClient->GetClientSoft() == SO_AMULE && !pClient->GetClientOSInfo().IsEmpty())
1212                 ||
1213                 // eservers use a flag for this, at least.
1214                 (pServer && (pServer->GetTCPFlags() & SRV_TCPFLG_NEWTAGS));
1215
1216         for (TagPtrList::iterator it = tags.begin(); it != tags.end(); ++it ) {
1217                 CTag* pTag = *it;
1218                 if (new_ed2k) {
1219                         pTag->WriteNewEd2kTag(files, eStrEncode);
1220                 } else {
1221                         pTag->WriteTagToFile(files, eStrEncode);
1222                 }
1223                 delete pTag;
1224         }
1225 }
1226
1227
1228 // Updates priority of file if autopriority is activated
1229 void CKnownFile::UpdateAutoUpPriority()
1230 {
1231         if (IsAutoUpPriority()) {
1232                 uint32 queued = GetQueuedCount();
1233                 uint8 priority = PR_NORMAL;
1234
1235                 if (queued > 20) {
1236                         priority = PR_LOW;
1237                 } else if (queued > 1) {
1238                         priority = PR_NORMAL;
1239                 } else {
1240                         priority = PR_HIGH;
1241                 }
1242
1243                 if (GetUpPriority() != priority) {
1244                         SetUpPriority(priority, false);
1245                         Notify_SharedFilesUpdateItem(this);
1246                 }
1247         }
1248 }
1249
1250 void CKnownFile::SetFileCommentRating(const wxString& strNewComment, int8 iNewRating)
1251 {
1252         if (m_strComment != strNewComment || m_iRating != iNewRating) {
1253                 SetLastPublishTimeKadNotes(0);
1254                 wxString strCfgPath = wxT("/") + m_abyFileHash.Encode() + wxT("/");
1255
1256                 wxConfigBase* cfg = wxConfigBase::Get();
1257                 if (strNewComment.IsEmpty() && iNewRating == 0) {
1258                         cfg->DeleteGroup(strCfgPath);
1259                 } else {
1260                         cfg->Write( strCfgPath + wxT("Comment"), strNewComment);
1261                         cfg->Write( strCfgPath + wxT("Rate"), (int)iNewRating);
1262                 }
1263
1264                 m_strComment = strNewComment;
1265                 m_iRating = iNewRating;
1266
1267                 SourceSet::iterator it = m_ClientUploadList.begin();
1268                 for ( ; it != m_ClientUploadList.end(); it++ ) {
1269                         it->SetCommentDirty();
1270                 }
1271         }
1272 }
1273
1274
1275 void CKnownFile::SetUpPriority(uint8 iNewUpPriority, bool m_bsave){
1276         m_iUpPriority = iNewUpPriority;
1277         if( IsPartFile() && m_bsave ) {
1278                 ((CPartFile*)this)->SavePartFile();
1279         }
1280 }
1281
1282 void CKnownFile::SetPublishedED2K(bool val){
1283         m_PublishedED2K = val;
1284         Notify_SharedFilesUpdateItem(this);
1285 }
1286
1287 bool CKnownFile::PublishNotes()
1288 {
1289         if(m_lastPublishTimeKadNotes > (uint32)time(NULL)) {
1290                 return false;
1291         }
1292
1293         if(!GetFileComment().IsEmpty()) {
1294                 m_lastPublishTimeKadNotes = (uint32)time(NULL)+KADEMLIAREPUBLISHTIMEN;
1295                 return true;
1296         }
1297
1298         if(GetFileRating() != 0) {
1299                 m_lastPublishTimeKadNotes = (uint32)time(NULL)+KADEMLIAREPUBLISHTIMEN;
1300                 return true;
1301         }
1302
1303         return false;
1304 }
1305
1306 bool CKnownFile::PublishSrc()
1307 {
1308         uint32 lastBuddyIP = 0;
1309
1310         if( theApp->IsFirewalled() ) {
1311                 CUpDownClient* buddy = theApp->clientlist->GetBuddy();
1312                 if( buddy ) {
1313                         lastBuddyIP = theApp->clientlist->GetBuddy()->GetIP();
1314                         if( lastBuddyIP != m_lastBuddyIP ) {
1315                                 SetLastPublishTimeKadSrc( (uint32)time(NULL)+KADEMLIAREPUBLISHTIMES, lastBuddyIP );
1316                                 return true;
1317                         }
1318                 } else {
1319                         return false;
1320                 }
1321         }
1322
1323         if(m_lastPublishTimeKadSrc > (uint32)time(NULL)) {
1324                 return false;
1325         }
1326
1327         SetLastPublishTimeKadSrc((uint32)time(NULL)+KADEMLIAREPUBLISHTIMES,lastBuddyIP);
1328         return true;
1329
1330 }
1331
1332 void CKnownFile::UpdatePartsInfo()
1333 {
1334         // Cache part count
1335         uint16 partcount = GetPartCount();
1336         bool flag = (time(NULL) - m_nCompleteSourcesTime > 0);
1337
1338         // Ensure the frequency-list is ready
1339         if ( m_AvailPartFrequency.size() != GetPartCount() ) {
1340                 m_AvailPartFrequency.clear();
1341                 m_AvailPartFrequency.insert(m_AvailPartFrequency.begin(), GetPartCount(), 0);
1342         }
1343
1344         if (flag) {
1345                 ArrayOfUInts16 count;
1346                 count.reserve(m_ClientUploadList.size());
1347
1348                 SourceSet::iterator it = m_ClientUploadList.begin();
1349                 for ( ; it != m_ClientUploadList.end(); it++ ) {
1350                         CUpDownClient* client = it->GetClient();
1351                         if ( !client->GetUpPartStatus().empty() && client->GetUpPartCount() == partcount ) {
1352                                 count.push_back(client->GetUpCompleteSourcesCount());
1353                         }
1354                 }
1355
1356                 m_nCompleteSourcesCount = m_nCompleteSourcesCountLo = m_nCompleteSourcesCountHi = 0;
1357
1358                 if( partcount > 0) {
1359                         m_nCompleteSourcesCount = m_AvailPartFrequency[0];
1360                 }
1361                 for (uint16 i = 1; i < partcount; ++i) {
1362                         if( m_nCompleteSourcesCount > m_AvailPartFrequency[i]) {
1363                                 m_nCompleteSourcesCount = m_AvailPartFrequency[i];
1364                         }
1365                 }
1366                 count.push_back(m_nCompleteSourcesCount);
1367
1368                 int32 n = count.size();
1369                 if (n > 0) {
1370                         std::sort(count.begin(), count.end(), std::less<uint16>());
1371
1372                         // calculate range
1373                         int i = n >> 1;                 // (n / 2)
1374                         int j = (n * 3) >> 2;   // (n * 3) / 4
1375                         int k = (n * 7) >> 3;   // (n * 7) / 8
1376
1377                         // For complete files, trust the people your uploading to more...
1378
1379                         // For low guess and normal guess count
1380                         //      - If we see more sources then the guessed low and
1381                         //      normal, use what we see.
1382                         //      - If we see less sources then the guessed low,
1383                         //      adjust network accounts for 100%, we account for
1384                         //      0% with what we see and make sure we are still
1385                         //      above the normal.
1386                         // For high guess
1387                         //      Adjust 100% network and 0% what we see.
1388                         if (n < 20) {
1389                                 if ( count[i] < m_nCompleteSourcesCount ) {
1390                                         m_nCompleteSourcesCountLo = m_nCompleteSourcesCount;
1391                                 } else {
1392                                         m_nCompleteSourcesCountLo = count[i];
1393                                 }
1394                                 m_nCompleteSourcesCount= m_nCompleteSourcesCountLo;
1395                                 m_nCompleteSourcesCountHi = count[j];
1396                                 if( m_nCompleteSourcesCountHi < m_nCompleteSourcesCount ) {
1397                                         m_nCompleteSourcesCountHi = m_nCompleteSourcesCount;
1398                                 }
1399                         } else {
1400                         // Many sources..
1401                         // For low guess
1402                         //      Use what we see.
1403                         // For normal guess
1404                         //      Adjust network accounts for 100%, we account for
1405                         //      0% with what we see and make sure we are still above the low.
1406                         // For high guess
1407                         //      Adjust network accounts for 100%, we account for 0%
1408                         //      with what we see and make sure we are still above the normal.
1409
1410                                 m_nCompleteSourcesCountLo = m_nCompleteSourcesCount;
1411                                 m_nCompleteSourcesCount = count[j];
1412                                 if( m_nCompleteSourcesCount < m_nCompleteSourcesCountLo ) {
1413                                         m_nCompleteSourcesCount = m_nCompleteSourcesCountLo;
1414                                 }
1415                                 m_nCompleteSourcesCountHi= count[k];
1416                                 if( m_nCompleteSourcesCountHi < m_nCompleteSourcesCount ) {
1417                                         m_nCompleteSourcesCountHi = m_nCompleteSourcesCount;
1418                                 }
1419                         }
1420                 }
1421                 m_nCompleteSourcesTime = time(NULL) + (60);
1422         }
1423
1424         Notify_SharedFilesUpdateItem(this);
1425 }
1426
1427
1428 void CKnownFile::UpdateUpPartsFrequency( CUpDownClient* client, bool increment )
1429 {
1430         if ( m_AvailPartFrequency.size() != GetPartCount() ) {
1431                 m_AvailPartFrequency.clear();
1432                 m_AvailPartFrequency.insert(m_AvailPartFrequency.begin(), GetPartCount(), 0);
1433                 if ( !increment ) {
1434                         return;
1435                 }
1436         }
1437
1438         const BitVector& freq = client->GetUpPartStatus();
1439         unsigned int size = freq.size();
1440         if ( size != m_AvailPartFrequency.size() ) {
1441                 return;
1442         }
1443
1444         if ( increment ) {
1445                 for ( unsigned int i = 0; i < size; ++i ) {
1446                         if ( freq.get(i) ) {
1447                                 m_AvailPartFrequency[i]++;
1448                         }
1449                 }
1450         } else {
1451                 for ( unsigned int i = 0; i < size; ++i ) {
1452                         if ( freq.get(i) ) {
1453                                 m_AvailPartFrequency[i]--;
1454                         }
1455                 }
1456         }
1457 }
1458
1459 void CKnownFile::ClearPriority() {
1460         if ( !m_bAutoUpPriority ) return;
1461         m_iUpPriority = ( m_bAutoUpPriority ) ? PR_HIGH : PR_NORMAL;
1462         UpdateAutoUpPriority();
1463 }
1464
1465 void GuessAndRemoveExt(CPath& name)
1466 {
1467         wxString ext = name.GetExt();
1468
1469         // Remove common two-part extensions, such as "tar.gz"
1470         if (ext == wxT("gz") || ext == wxT("bz2")) {
1471                 name = name.RemoveExt();
1472                 if (name.GetExt() == wxT("tar")) {
1473                         name = name.RemoveExt();
1474                 }
1475         // might be an extension if length == 3
1476         // and also remove some common non-three-character extensions
1477         } else if (ext.Length() == 3  ||
1478                    ext == wxT("7z")   ||
1479                    ext == wxT("rm")   ||
1480                    ext == wxT("jpeg") ||
1481                    ext == wxT("mpeg")
1482                    ) {
1483                 name = name.RemoveExt();
1484         }
1485 }
1486
1487 void CKnownFile::SetFileName(const CPath& filename)
1488 {
1489         CAbstractFile::SetFileName(filename);
1490         wordlist.clear();
1491         // Don't publish extension. That'd kill the node indexing e.g. "avi".
1492         CPath tmpName = GetFileName();
1493         GuessAndRemoveExt(tmpName);
1494         Kademlia::CSearchManager::GetWords(tmpName.GetPrintable(), &wordlist);
1495 }
1496
1497 #endif // CLIENT_GUI
1498
1499 //For File Comment //
1500 void CKnownFile::LoadComment() const
1501 {
1502         #ifndef CLIENT_GUI
1503         wxString strCfgPath = wxT("/") + m_abyFileHash.Encode() + wxT("/");
1504
1505         wxConfigBase* cfg = wxConfigBase::Get();
1506
1507         m_strComment = cfg->Read( strCfgPath + wxT("Comment"), wxEmptyString);
1508         m_iRating = cfg->Read( strCfgPath + wxT("Rate"), 0l);
1509         #endif
1510
1511         m_bCommentLoaded = true;
1512 }
1513
1514
1515 wxString CKnownFile::GetAICHMasterHash() const
1516 {
1517 #ifdef CLIENT_GUI
1518         return m_AICHMasterHash;
1519 #else
1520         if (HasProperAICHHashSet()) {
1521                 return m_pAICHHashSet->GetMasterHash().GetString();
1522         }
1523
1524         return wxEmptyString;
1525 #endif
1526 }
1527
1528
1529 bool CKnownFile::HasProperAICHHashSet() const
1530 {
1531 #ifdef CLIENT_GUI
1532         return m_AICHMasterHash.Length() != 0;
1533 #else
1534         return m_pAICHHashSet->HasValidMasterHash() &&
1535                 (m_pAICHHashSet->GetStatus() == AICH_HASHSETCOMPLETE ||
1536                  m_pAICHHashSet->GetStatus() == AICH_VERIFIED);
1537 #endif
1538 }
1539
1540 wxString CKnownFile::GetFeedback() const
1541 {
1542         return    wxString(_("File name")) + wxT(": ") + GetFileName().GetPrintable() + wxT("\n")
1543                 + _("File size") + wxT(": ") + CastItoXBytes(GetFileSize()) + wxT("\n")
1544                 + _("Share ratio") + CFormat(wxT(": %.2f%%\n")) % (((double)statistic.GetAllTimeTransferred() / (double)GetFileSize()) * 100.0)
1545                 + _("Uploaded") + wxT(": ") + CastItoXBytes(statistic.GetTransferred()) + wxT(" (") + CastItoXBytes(statistic.GetAllTimeTransferred()) + wxT(")\n")
1546                 + _("Requested") + CFormat(wxT(": %u (%u)\n")) % statistic.GetRequests() % statistic.GetAllTimeRequests()
1547                 + _("Accepted") + CFormat(wxT(": %u (%u)\n")) % statistic.GetAccepts() % statistic.GetAllTimeAccepts()
1548                 + _("On Queue") + CFormat(wxT(": %u\n")) % GetQueuedCount()
1549                 + _("Complete sources") + CFormat(wxT(": %u\n")) % m_nCompleteSourcesCount;
1550 }
1551
1552 // File_checked_for_headers