2 // This file is part of the aMule Project.
4 // Copyright (c) 2004-2008 Angel Vidal ( kry@amule.org )
5 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
6 // Copyright (c) 2002-2008 Merkur ( devs@emule-project.net / http://www.emule-project.net )
8 // Any parts of this program derived from the xMule, lMule or eMule project,
9 // or contributed by third-party developers are copyrighted by their
10 // respective authors.
12 // This program is free software; you can redistribute it and/or modify
13 // it under the terms of the GNU General Public License as published by
14 // the Free Software Foundation; either version 2 of the License, or
15 // (at your option) any later version.
17 // This program is distributed in the hope that it will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU General Public License for more details.
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
29 #include "SHAHashSet.h"
32 #include "Preferences.h"
34 #include "updownclient.h"
35 #include "DownloadQueue.h"
38 #include <common/Format.h>
42 // for this version the limits are set very high, they might be lowered later
43 // to make a hash trustworthy, at least 10 unique Ips (255.255.128.0) must have sent it
44 // and if we have received more than one hash for the file, one hash has to be sent by more than 95% of all unique IPs
45 #define MINUNIQUEIPS_TOTRUST 10 // how many unique IPs have to send us a hash to make it trustworthy
46 #define MINPERCENTAGE_TOTRUST 92 // how many percentage of clients have to send the same hash to make it trustworthy
48 CAICHRequestedDataList
CAICHHashSet::m_liRequestedData
;
50 /////////////////////////////////////////////////////////////////////////////////////////
52 wxString
CAICHHash::GetString() const
54 return EncodeBase32(m_abyBuffer
, HASHSIZE
);
58 void CAICHHash::Read(CFileDataIO
* file
)
60 file
->Read(m_abyBuffer
,HASHSIZE
);
64 void CAICHHash::Write(CFileDataIO
* file
) const
66 file
->Write(m_abyBuffer
,HASHSIZE
);
69 unsigned int CAICHHash::DecodeBase32(const wxString
&base32
)
71 return ::DecodeBase32(base32
, HASHSIZE
, m_abyBuffer
);
75 /////////////////////////////////////////////////////////////////////////////////////////
78 CAICHHashTree::CAICHHashTree(uint64 nDataSize
, bool bLeftBranch
, uint64 nBaseSize
)
80 m_nDataSize
= nDataSize
;
81 m_nBaseSize
= nBaseSize
;
82 m_bIsLeftBranch
= bLeftBranch
;
89 CAICHHashTree::~CAICHHashTree()
97 CAICHHashTree
* CAICHHashTree::FindHash(uint64 nStartPos
, uint64 nSize
, uint8
* nLevel
)
101 wxCHECK(*nLevel
<= 22, NULL
);
102 wxCHECK(nStartPos
+ nSize
<= m_nDataSize
, NULL
);
103 wxCHECK(nSize
<= m_nDataSize
, NULL
);
105 if (nStartPos
== 0 && nSize
== m_nDataSize
) {
106 // this is the searched hash
108 } else if (m_nDataSize
<= m_nBaseSize
) { // sanity
109 // this is already the last level, cant go deeper
113 uint64 nBlocks
= m_nDataSize
/ m_nBaseSize
+ ((m_nDataSize
% m_nBaseSize
!= 0 )? 1:0);
114 uint64 nLeft
= (((m_bIsLeftBranch
) ? nBlocks
+1:nBlocks
) / 2)* m_nBaseSize
;
115 uint64 nRight
= m_nDataSize
- nLeft
;
116 if (nStartPos
< nLeft
) {
117 if (nStartPos
+ nSize
> nLeft
) { // sanity
122 if (m_pLeftTree
== NULL
) {
123 m_pLeftTree
= new CAICHHashTree(nLeft
, true, (nLeft
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
125 wxASSERT( m_pLeftTree
->m_nDataSize
== nLeft
);
128 return m_pLeftTree
->FindHash(nStartPos
, nSize
, nLevel
);
131 if (nStartPos
+ nSize
> nRight
) { // sanity
136 if (m_pRightTree
== NULL
) {
137 m_pRightTree
= new CAICHHashTree(nRight
, false, (nRight
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
139 wxASSERT( m_pRightTree
->m_nDataSize
== nRight
);
142 return m_pRightTree
->FindHash(nStartPos
, nSize
, nLevel
);
149 // calculates missing hash fromt he existing ones
150 // overwrites existing hashs
151 // fails if no hash is found for any branch
152 bool CAICHHashTree::ReCalculateHash(CAICHHashAlgo
* hashalg
, bool bDontReplace
)
154 wxASSERT ( !( (m_pLeftTree
!= NULL
) ^ (m_pRightTree
!= NULL
)) );
155 if (m_pLeftTree
&& m_pRightTree
) {
156 if ( !m_pLeftTree
->ReCalculateHash(hashalg
, bDontReplace
) || !m_pRightTree
->ReCalculateHash(hashalg
, bDontReplace
) ) {
159 if (bDontReplace
&& m_bHashValid
) {
162 if (m_pRightTree
->m_bHashValid
&& m_pLeftTree
->m_bHashValid
) {
164 hashalg
->Add(m_pLeftTree
->m_Hash
.GetRawHash(), HASHSIZE
);
165 hashalg
->Add(m_pRightTree
->m_Hash
.GetRawHash(), HASHSIZE
);
166 hashalg
->Finish(m_Hash
);
177 bool CAICHHashTree::VerifyHashTree(CAICHHashAlgo
* hashalg
, bool bDeleteBadTrees
)
181 if (bDeleteBadTrees
) {
191 AddDebugLogLineN(logSHAHashSet
, wxT("VerifyHashTree - No masterhash available"));
195 // calculated missing hashs without overwriting anything
196 if (m_pLeftTree
&& !m_pLeftTree
->m_bHashValid
) {
197 m_pLeftTree
->ReCalculateHash(hashalg
, true);
199 if (m_pRightTree
&& !m_pRightTree
->m_bHashValid
) {
200 m_pRightTree
->ReCalculateHash(hashalg
, true);
203 if ((m_pRightTree
&& m_pRightTree
->m_bHashValid
) ^ (m_pLeftTree
&& m_pLeftTree
->m_bHashValid
)) {
204 // one branch can never be verified
205 if (bDeleteBadTrees
) {
215 AddDebugLogLineN(logSHAHashSet
, wxT("VerifyHashSet failed - Hashtree incomplete"));
218 if ((m_pRightTree
&& m_pRightTree
->m_bHashValid
) && (m_pLeftTree
&& m_pLeftTree
->m_bHashValid
)) {
219 // check verify the hashs of both child nodes against my hash
223 hashalg
->Add(m_pLeftTree
->m_Hash
.GetRawHash(), HASHSIZE
);
224 hashalg
->Add(m_pRightTree
->m_Hash
.GetRawHash(), HASHSIZE
);
225 hashalg
->Finish(CmpHash
);
227 if (m_Hash
!= CmpHash
) {
228 if (bDeleteBadTrees
) {
240 return m_pLeftTree
->VerifyHashTree(hashalg
, bDeleteBadTrees
) && m_pRightTree
->VerifyHashTree(hashalg
, bDeleteBadTrees
);
242 // last hash in branch - nothing below to verify
248 void CAICHHashTree::SetBlockHash(uint64 nSize
, uint64 nStartPos
, CAICHHashAlgo
* pHashAlg
)
250 wxASSERT ( nSize
<= EMBLOCKSIZE
);
251 CAICHHashTree
* pToInsert
= FindHash(nStartPos
, nSize
);
252 if (pToInsert
== NULL
) { // sanity
254 AddDebugLogLineN(logSHAHashSet
, wxT("Critical Error: Failed to Insert SHA-HashBlock, FindHash() failed!"));
259 if (pToInsert
->m_nBaseSize
!= EMBLOCKSIZE
|| pToInsert
->m_nDataSize
!= nSize
) {
261 AddDebugLogLineN(logSHAHashSet
, wxT("Critical Error: Logical error on values in SetBlockHashFromData"));
265 pHashAlg
->Finish(pToInsert
->m_Hash
);
266 pToInsert
->m_bHashValid
= true;
270 bool CAICHHashTree::CreatePartRecoveryData(uint64 nStartPos
, uint64 nSize
, CFileDataIO
* fileDataOut
, uint32 wHashIdent
, bool b32BitIdent
)
272 wxCHECK(nStartPos
+ nSize
<= m_nDataSize
, false);
273 wxCHECK(nSize
<= m_nDataSize
, false);
275 if (nStartPos
== 0 && nSize
== m_nDataSize
) {
276 // this is the searched part, now write all blocks of this part
277 // hashident for this level will be adjsuted by WriteLowestLevelHash
278 return WriteLowestLevelHashs(fileDataOut
, wHashIdent
, false, b32BitIdent
);
279 } else if (m_nDataSize
<= m_nBaseSize
) { // sanity
280 // this is already the last level, cant go deeper
285 wHashIdent
|= (m_bIsLeftBranch
) ? 1: 0;
287 uint64 nBlocks
= m_nDataSize
/ m_nBaseSize
+ ((m_nDataSize
% m_nBaseSize
!= 0 )? 1:0);
288 uint64 nLeft
= ( ((m_bIsLeftBranch
) ? nBlocks
+1:nBlocks
) / 2)* m_nBaseSize
;
289 uint64 nRight
= m_nDataSize
- nLeft
;
290 if (m_pLeftTree
== NULL
|| m_pRightTree
== NULL
) {
294 if (nStartPos
< nLeft
) {
295 if (nStartPos
+ nSize
> nLeft
|| !m_pRightTree
->m_bHashValid
) { // sanity
299 m_pRightTree
->WriteHash(fileDataOut
, wHashIdent
, b32BitIdent
);
300 return m_pLeftTree
->CreatePartRecoveryData(nStartPos
, nSize
, fileDataOut
, wHashIdent
, b32BitIdent
);
303 if (nStartPos
+ nSize
> nRight
|| !m_pLeftTree
->m_bHashValid
) { // sanity
307 m_pLeftTree
->WriteHash(fileDataOut
, wHashIdent
, b32BitIdent
);
308 return m_pRightTree
->CreatePartRecoveryData(nStartPos
, nSize
, fileDataOut
, wHashIdent
, b32BitIdent
);
315 void CAICHHashTree::WriteHash(CFileDataIO
* fileDataOut
, uint32 wHashIdent
, bool b32BitIdent
) const
317 wxASSERT( m_bHashValid
);
319 wHashIdent
|= (m_bIsLeftBranch
) ? 1: 0;
322 wxASSERT( wHashIdent
<= 0xFFFF );
323 fileDataOut
->WriteUInt16((uint16
)wHashIdent
);
325 fileDataOut
->WriteUInt32(wHashIdent
);
328 m_Hash
.Write(fileDataOut
);
332 // write lowest level hashs into file, ordered from left to right optional without identifier
333 bool CAICHHashTree::WriteLowestLevelHashs(CFileDataIO
* fileDataOut
, uint32 wHashIdent
, bool bNoIdent
, bool b32BitIdent
) const
336 wHashIdent
|= (m_bIsLeftBranch
) ? 1: 0;
337 if (m_pLeftTree
== NULL
&& m_pRightTree
== NULL
) {
338 if (m_nDataSize
<= m_nBaseSize
&& m_bHashValid
) {
339 if (!bNoIdent
&& !b32BitIdent
) {
340 wxASSERT( wHashIdent
<= 0xFFFF );
341 fileDataOut
->WriteUInt16((uint16
)wHashIdent
);
342 } else if (!bNoIdent
&& b32BitIdent
) {
343 fileDataOut
->WriteUInt32(wHashIdent
);
346 m_Hash
.Write(fileDataOut
);
352 } else if (m_pLeftTree
== NULL
|| m_pRightTree
== NULL
) {
356 return m_pLeftTree
->WriteLowestLevelHashs(fileDataOut
, wHashIdent
, bNoIdent
, b32BitIdent
)
357 && m_pRightTree
->WriteLowestLevelHashs(fileDataOut
, wHashIdent
, bNoIdent
, b32BitIdent
);
361 // recover all low level hashs from given data. hashs are assumed to be ordered in left to right - no identifier used
362 bool CAICHHashTree::LoadLowestLevelHashs(CFileDataIO
* fileInput
)
364 if (m_nDataSize
<= m_nBaseSize
) { // sanity
365 // lowest level, read hash
366 m_Hash
.Read(fileInput
);
370 uint64 nBlocks
= m_nDataSize
/ m_nBaseSize
+ ((m_nDataSize
% m_nBaseSize
!= 0 )? 1:0);
371 uint64 nLeft
= ( ((m_bIsLeftBranch
) ? nBlocks
+1:nBlocks
) / 2)* m_nBaseSize
;
372 uint64 nRight
= m_nDataSize
- nLeft
;
373 if (m_pLeftTree
== NULL
) {
374 m_pLeftTree
= new CAICHHashTree(nLeft
, true, (nLeft
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
376 wxASSERT( m_pLeftTree
->m_nDataSize
== nLeft
);
378 if (m_pRightTree
== NULL
) {
379 m_pRightTree
= new CAICHHashTree(nRight
, false, (nRight
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
381 wxASSERT( m_pRightTree
->m_nDataSize
== nRight
);
383 return m_pLeftTree
->LoadLowestLevelHashs(fileInput
)
384 && m_pRightTree
->LoadLowestLevelHashs(fileInput
);
389 // write the hash, specified by wHashIdent, with Data from fileInput.
390 bool CAICHHashTree::SetHash(CFileDataIO
* fileInput
, uint32 wHashIdent
, sint8 nLevel
, bool bAllowOverwrite
)
392 if (nLevel
== (-1)) {
393 // first call, check how many level we need to go
395 for (; i
!= 32 && (wHashIdent
& 0x80000000) == 0; ++i
) {
399 AddDebugLogLineN(logSHAHashSet
, wxT("CAICHHashTree::SetHash - found invalid HashIdent (0)"));
406 // this is the searched hash
407 if (m_bHashValid
&& !bAllowOverwrite
) {
408 // not allowed to overwrite this hash, however move the filepointer by reading a hash
412 m_Hash
.Read(fileInput
);
415 } else if (m_nDataSize
<= m_nBaseSize
) { // sanity
416 // this is already the last level, cant go deeper
420 // adjust ident to point the path to the next node
423 uint64 nBlocks
= m_nDataSize
/ m_nBaseSize
+ ((m_nDataSize
% m_nBaseSize
!= 0 )? 1:0);
424 uint64 nLeft
= ( ((m_bIsLeftBranch
) ? nBlocks
+1:nBlocks
) / 2)* m_nBaseSize
;
425 uint64 nRight
= m_nDataSize
- nLeft
;
426 if ((wHashIdent
& 0x80000000) > 0) {
427 if (m_pLeftTree
== NULL
) {
428 m_pLeftTree
= new CAICHHashTree(nLeft
, true, (nLeft
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
430 wxASSERT( m_pLeftTree
->m_nDataSize
== nLeft
);
432 return m_pLeftTree
->SetHash(fileInput
, wHashIdent
, nLevel
);
434 if (m_pRightTree
== NULL
) {
435 m_pRightTree
= new CAICHHashTree(nRight
, false, (nRight
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
);
437 wxASSERT( m_pRightTree
->m_nDataSize
== nRight
);
439 return m_pRightTree
->SetHash(fileInput
, wHashIdent
, nLevel
);
445 /////////////////////////////////////////////////////////////////////////////////////////
446 ///CAICHUntrustedHash
447 bool CAICHUntrustedHash::AddSigningIP(uint32 dwIP
)
449 dwIP
&= 0x00F0FFFF; // we use only the 20 most significant bytes for unique IPs
450 return m_adwIpsSigning
.insert(dwIP
).second
;
455 /////////////////////////////////////////////////////////////////////////////////////////
457 CAICHHashSet::CAICHHashSet(CKnownFile
* pOwner
)
458 : m_pHashTree(0, true, PARTSIZE
)
460 m_eStatus
= AICH_EMPTY
;
464 CAICHHashSet::~CAICHHashSet(void)
469 bool CAICHHashSet::CreatePartRecoveryData(uint64 nPartStartPos
, CFileDataIO
* fileDataOut
, bool bDbgDontLoad
)
471 wxASSERT( m_pOwner
);
472 if (m_pOwner
->IsPartFile() || m_eStatus
!= AICH_HASHSETCOMPLETE
) {
476 if (m_pHashTree
.m_nDataSize
<= EMBLOCKSIZE
) {
481 if (!LoadHashSet()) {
482 AddDebugLogLineN(logSHAHashSet
,
483 CFormat(wxT("Created RecoveryData error: failed to load hashset. File: %s")) % m_pOwner
->GetFileName());
484 SetStatus(AICH_ERROR
);
490 uint32 nPartSize
= min
<uint64
>(PARTSIZE
, m_pOwner
->GetFileSize()-nPartStartPos
);
491 m_pHashTree
.FindHash(nPartStartPos
, nPartSize
,&nLevel
);
492 uint16 nHashsToWrite
= (nLevel
-1) + nPartSize
/EMBLOCKSIZE
+ ((nPartSize
% EMBLOCKSIZE
!= 0 )? 1:0);
493 const bool bUse32BitIdentifier
= m_pOwner
->IsLargeFile();
495 if (bUse32BitIdentifier
) {
496 fileDataOut
->WriteUInt16(0); // no 16bit hashs to write
499 fileDataOut
->WriteUInt16(nHashsToWrite
);
500 uint64 nCheckFilePos
= fileDataOut
->GetPosition();
501 if (m_pHashTree
.CreatePartRecoveryData(nPartStartPos
, nPartSize
, fileDataOut
, 0, bUse32BitIdentifier
)) {
502 if (nHashsToWrite
*(HASHSIZE
+(bUse32BitIdentifier
? 4u:2u)) != fileDataOut
->GetPosition() - nCheckFilePos
) {
504 AddDebugLogLineN( logSHAHashSet
,
505 CFormat(wxT("Created RecoveryData has wrong length. File: %s")) % m_pOwner
->GetFileName() );
507 SetStatus(AICH_ERROR
);
512 AddDebugLogLineN(logSHAHashSet
,
513 CFormat(wxT("Failed to create RecoveryData for '%s'")) % m_pOwner
->GetFileName());
515 SetStatus(AICH_ERROR
);
517 if (!bUse32BitIdentifier
) {
518 fileDataOut
->WriteUInt16(0); // no 32bit hashs to write
527 bool CAICHHashSet::ReadRecoveryData(uint64 nPartStartPos
, CMemFile
* fileDataIn
)
529 if (/*eMule TODO !m_pOwner->IsPartFile() ||*/ !(m_eStatus
== AICH_VERIFIED
|| m_eStatus
== AICH_TRUSTED
) ) {
534 /* V2 AICH Hash Packet:
535 <count1 uint16> 16bit-hashs-to-read
536 (<identifier uint16><hash HASHSIZE>)[count1] AICH hashs
537 <count2 uint16> 32bit-hashs-to-read
538 (<identifier uint32><hash HASHSIZE>)[count2] AICH hashs
541 // at this time we check the recoverydata for the correct ammounts of hashs only
542 // all hash are then taken into the tree, depending on there hashidentifier (except the masterhash)
545 uint32 nPartSize
= min
<uint64
>(PARTSIZE
, m_pOwner
->GetFileSize()-nPartStartPos
);
546 m_pHashTree
.FindHash(nPartStartPos
, nPartSize
,&nLevel
);
547 uint16 nHashsToRead
= (nLevel
-1) + nPartSize
/EMBLOCKSIZE
+ ((nPartSize
% EMBLOCKSIZE
!= 0 )? 1:0);
549 // read hashs with 16 bit identifier
550 uint16 nHashsAvailable
= fileDataIn
->ReadUInt16();
551 if (fileDataIn
->GetLength()-fileDataIn
->GetPosition() < nHashsToRead
*(HASHSIZE
+2u) || (nHashsToRead
!= nHashsAvailable
&& nHashsAvailable
!= 0)) {
552 // this check is redunant, CSafememfile would catch such an error too
553 AddDebugLogLineN(logSHAHashSet
,
554 CFormat(wxT("Failed to read RecoveryData for '%s' - Received datasize/amounts of hashs was invalid"))
555 % m_pOwner
->GetFileName());
558 for (uint32 i
= 0; i
!= nHashsAvailable
; i
++) {
559 uint16 wHashIdent
= fileDataIn
->ReadUInt16();
560 if (wHashIdent
== 1 /*never allow masterhash to be overwritten*/
561 || !m_pHashTree
.SetHash(fileDataIn
, wHashIdent
,(-1), false))
563 AddDebugLogLineN(logSHAHashSet
,
564 CFormat(wxT("Failed to read RecoveryData for '%s' - Error when trying to read hash into tree"))
565 % m_pOwner
->GetFileName());
566 VerifyHashTree(true); // remove invalid hashes which we have already written
572 // read hashs with 32bit identifier
573 if (nHashsAvailable
== 0 && fileDataIn
->GetLength() - fileDataIn
->GetPosition() >= 2) {
574 nHashsAvailable
= fileDataIn
->ReadUInt16();
575 if (fileDataIn
->GetLength()-fileDataIn
->GetPosition() < nHashsToRead
*(HASHSIZE
+4u) || (nHashsToRead
!= nHashsAvailable
&& nHashsAvailable
!= 0)) {
576 // this check is redunant, CSafememfile would catch such an error too
577 // TODO: theApp->QueueDebugLogLine(/*DLP_VERYHIGH,*/ false, _T("Failed to read RecoveryData for %s - Received datasize/amounts of hashs was invalid (2)"), m_pOwner->GetFileName() );
581 // TODO: DEBUG_ONLY( theApp->QueueDebugLogLine(/*DLP_VERYHIGH,*/ false, _T("read RecoveryData for %s - Received packet with %u 32bit hash identifiers)"), m_pOwner->GetFileName(), nHashsAvailable ) );
582 for (uint32 i
= 0; i
!= nHashsToRead
; i
++) {
583 uint32 wHashIdent
= fileDataIn
->ReadUInt32();
584 if (wHashIdent
== 1 /*never allow masterhash to be overwritten*/
585 || wHashIdent
> 0x400000
586 || !m_pHashTree
.SetHash(fileDataIn
, wHashIdent
,(-1), false))
588 // TODO: theApp->QueueDebugLogLine(/*DLP_VERYHIGH,*/ false, _T("Failed to read RecoveryData for %s - Error when trying to read hash into tree (2)"), m_pOwner->GetFileName() );
589 VerifyHashTree(true); // remove invalid hashes which we have already written
595 if (nHashsAvailable
== 0) {
596 // TODO: theApp->QueueDebugLogLine(/*DLP_VERYHIGH,*/ false, _T("Failed to read RecoveryData for %s - Packet didn't contained any hashs"), m_pOwner->GetFileName() );
601 if (VerifyHashTree(true)) {
602 // some final check if all hashs we wanted are there
603 for (uint32 nPartPos
= 0; nPartPos
< nPartSize
; nPartPos
+= EMBLOCKSIZE
) {
604 CAICHHashTree
* phtToCheck
= m_pHashTree
.FindHash(nPartStartPos
+nPartPos
, min
<uint64
>(EMBLOCKSIZE
, nPartSize
-nPartPos
));
605 if (phtToCheck
== NULL
|| !phtToCheck
->m_bHashValid
) {
606 AddDebugLogLineN(logSHAHashSet
,
607 CFormat(wxT("Failed to read RecoveryData for '%s' - Error while verifying presence of all lowest level hashes"))
608 % m_pOwner
->GetFileName());
615 AddDebugLogLineN(logSHAHashSet
,
616 CFormat(wxT("Failed to read RecoveryData for '%s' - Verifying received hashtree failed"))
617 % m_pOwner
->GetFileName());
622 // this function is only allowed to be called right after successfully calculating the hashset (!)
623 // will delete the hashset, after saving to free the memory
624 bool CAICHHashSet::SaveHashSet()
626 if (m_eStatus
!= AICH_HASHSETCOMPLETE
) {
630 if ( !m_pHashTree
.m_bHashValid
|| m_pHashTree
.m_nDataSize
!= m_pOwner
->GetFileSize()) {
637 const wxString fullpath
= theApp
->ConfigDir
+ KNOWN2_MET_FILENAME
;
638 const bool exists
= wxFile::Exists(fullpath
);
640 CFile
file(fullpath
, exists
? CFile::read_write
: CFile::write
);
641 if (!file
.IsOpened()) {
642 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to save HashSet: opening met file failed!"));
646 uint64 nExistingSize
= file
.GetLength();
648 uint8 header
= file
.ReadUInt8();
649 if (header
!= KNOWN2_MET_VERSION
) {
650 AddDebugLogLineC(logSHAHashSet
, wxT("Saving failed: Current file is not a met-file!"));
654 AddDebugLogLineN(logSHAHashSet
, CFormat(wxT("Met file is version 0x%2.2x.")) % header
);
656 file
.WriteUInt8(KNOWN2_MET_VERSION
);
657 // Update the recorded size, in order for the sanity check below to work.
661 // first we check if the hashset we want to write is already stored
662 CAICHHash CurrentHash
;
663 while (file
.GetPosition() < nExistingSize
) {
664 CurrentHash
.Read(&file
);
665 if (m_pHashTree
.m_Hash
== CurrentHash
) {
666 // this hashset if already available, no need to save it again
669 uint32 nHashCount
= file
.ReadUInt32();
670 if (file
.GetPosition() + nHashCount
*HASHSIZE
> nExistingSize
) {
671 AddDebugLogLineC(logSHAHashSet
, wxT("Saving failed: File contains fewer entries than specified!"));
674 // skip the rest of this hashset
675 file
.Seek(nHashCount
*HASHSIZE
, wxFromCurrent
);
679 m_pHashTree
.m_Hash
.Write(&file
);
680 uint32 nHashCount
= (PARTSIZE
/EMBLOCKSIZE
+ ((PARTSIZE
% EMBLOCKSIZE
!= 0)? 1 : 0)) * (m_pHashTree
.m_nDataSize
/PARTSIZE
);
681 if (m_pHashTree
.m_nDataSize
% PARTSIZE
!= 0) {
682 nHashCount
+= (m_pHashTree
.m_nDataSize
% PARTSIZE
)/EMBLOCKSIZE
+ (((m_pHashTree
.m_nDataSize
% PARTSIZE
) % EMBLOCKSIZE
!= 0)? 1 : 0);
684 file
.WriteUInt32(nHashCount
);
685 if (!m_pHashTree
.WriteLowestLevelHashs(&file
, 0, true, true)) {
686 // thats bad... really
687 file
.SetLength(nExistingSize
);
688 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to save HashSet: WriteLowestLevelHashs() failed!"));
691 if (file
.GetLength() != nExistingSize
+ (nHashCount
+1)*HASHSIZE
+ 4) {
693 file
.SetLength(nExistingSize
);
694 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to save HashSet: Calculated and real size of hashset differ!"));
697 AddDebugLogLineN(logSHAHashSet
, CFormat(wxT("Successfully saved eMuleAC Hashset, %u Hashs + 1 Masterhash written")) % nHashCount
);
698 } catch (const CSafeIOException
& e
) {
699 AddDebugLogLineC(logSHAHashSet
, wxT("IO error while saving AICH HashSet: ") + e
.what());
708 bool CAICHHashSet::LoadHashSet()
710 if (m_eStatus
!= AICH_HASHSETCOMPLETE
) {
714 if ( !m_pHashTree
.m_bHashValid
|| m_pHashTree
.m_nDataSize
!= m_pOwner
->GetFileSize() || m_pHashTree
.m_nDataSize
== 0) {
718 wxString fullpath
= theApp
->ConfigDir
+ KNOWN2_MET_FILENAME
;
719 CFile
file(fullpath
, CFile::read
);
720 if (!file
.IsOpened()) {
721 if (wxFileExists(fullpath
)) {
722 wxString
strError(wxT("Failed to load ") KNOWN2_MET_FILENAME
wxT(" file"));
723 AddDebugLogLineC(logSHAHashSet
, strError
);
729 uint8 header
= file
.ReadUInt8();
730 if (header
!= KNOWN2_MET_VERSION
) {
731 AddDebugLogLineC(logSHAHashSet
, wxT("Loading failed: Current file is not a met-file!"));
735 CAICHHash CurrentHash
;
736 uint64 nExistingSize
= file
.GetLength();
738 while (file
.GetPosition() < nExistingSize
) {
739 CurrentHash
.Read(&file
);
740 if (m_pHashTree
.m_Hash
== CurrentHash
) {
742 uint32 nExpectedCount
= (PARTSIZE
/EMBLOCKSIZE
+ ((PARTSIZE
% EMBLOCKSIZE
!= 0)? 1 : 0)) * (m_pHashTree
.m_nDataSize
/PARTSIZE
);
743 if (m_pHashTree
.m_nDataSize
% PARTSIZE
!= 0) {
744 nExpectedCount
+= (m_pHashTree
.m_nDataSize
% PARTSIZE
)/EMBLOCKSIZE
+ (((m_pHashTree
.m_nDataSize
% PARTSIZE
) % EMBLOCKSIZE
!= 0)? 1 : 0);
746 nHashCount
= file
.ReadUInt32();
747 if (nHashCount
!= nExpectedCount
) {
748 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to load HashSet: Available Hashs and expected hashcount differ!"));
751 if (!m_pHashTree
.LoadLowestLevelHashs(&file
)) {
752 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to load HashSet: LoadLowestLevelHashs failed!"));
755 if (!ReCalculateHash(false)) {
756 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to load HashSet: Calculating loaded hashs failed!"));
759 if (CurrentHash
!= m_pHashTree
.m_Hash
) {
760 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to load HashSet: Calculated Masterhash differs from given Masterhash - hashset corrupt!"));
765 nHashCount
= file
.ReadUInt32();
766 if (file
.GetPosition() + nHashCount
*HASHSIZE
> nExistingSize
) {
767 AddDebugLogLineC(logSHAHashSet
, wxT("Saving failed: File contains fewer entries than specified!"));
770 // skip the rest of this hashset
771 file
.Seek(nHashCount
*HASHSIZE
, wxFromCurrent
);
773 AddDebugLogLineC(logSHAHashSet
, wxT("Failed to load HashSet: HashSet not found!"));
774 } catch (const CSafeIOException
& e
) {
775 AddDebugLogLineC(logSHAHashSet
, wxT("IO error while loading AICH HashSet: ") + e
.what());
781 // delete the hashset except the masterhash (we dont keep aich hashsets in memory to save ressources)
782 void CAICHHashSet::FreeHashSet()
784 if (m_pHashTree
.m_pLeftTree
) {
785 delete m_pHashTree
.m_pLeftTree
;
786 m_pHashTree
.m_pLeftTree
= NULL
;
788 if (m_pHashTree
.m_pRightTree
) {
789 delete m_pHashTree
.m_pRightTree
;
790 m_pHashTree
.m_pRightTree
= NULL
;
794 void CAICHHashSet::SetMasterHash(const CAICHHash
& Hash
, EAICHStatus eNewStatus
)
796 m_pHashTree
.m_Hash
= Hash
;
797 m_pHashTree
.m_bHashValid
= true;
798 SetStatus(eNewStatus
);
801 CAICHHashAlgo
* CAICHHashSet::GetNewHashAlgo()
806 bool CAICHHashSet::ReCalculateHash(bool bDontReplace
)
808 CAICHHashAlgo
* hashalg
= GetNewHashAlgo();
809 bool bResult
= m_pHashTree
.ReCalculateHash(hashalg
, bDontReplace
);
814 bool CAICHHashSet::VerifyHashTree(bool bDeleteBadTrees
)
816 CAICHHashAlgo
* hashalg
= GetNewHashAlgo();
817 bool bResult
= m_pHashTree
.VerifyHashTree(hashalg
, bDeleteBadTrees
);
823 void CAICHHashSet::SetFileSize(uint64 nSize
)
825 m_pHashTree
.m_nDataSize
= nSize
;
826 m_pHashTree
.m_nBaseSize
= (nSize
<= PARTSIZE
) ? EMBLOCKSIZE
: PARTSIZE
;
830 void CAICHHashSet::UntrustedHashReceived(const CAICHHash
& Hash
, uint32 dwFromIP
)
832 switch(GetStatus()) {
842 for (uint32 i
= 0; i
< m_aUntrustedHashs
.size(); ++i
) {
843 if (m_aUntrustedHashs
[i
].m_Hash
== Hash
) {
844 bAdded
= m_aUntrustedHashs
[i
].AddSigningIP(dwFromIP
);
851 CAICHUntrustedHash uhToAdd
;
852 uhToAdd
.m_Hash
= Hash
;
853 uhToAdd
.AddSigningIP(dwFromIP
);
854 m_aUntrustedHashs
.push_back(uhToAdd
);
857 uint32 nSigningIPsTotal
= 0; // unique clients who send us a hash
858 int nMostTrustedPos
= (-1); // the hash which most clients send us
859 uint32 nMostTrustedIPs
= 0;
860 for (uint32 i
= 0; i
< (uint32
)m_aUntrustedHashs
.size(); ++i
) {
861 nSigningIPsTotal
+= m_aUntrustedHashs
[i
].m_adwIpsSigning
.size();
862 if ((uint32
)m_aUntrustedHashs
[i
].m_adwIpsSigning
.size() > nMostTrustedIPs
) {
863 nMostTrustedIPs
= m_aUntrustedHashs
[i
].m_adwIpsSigning
.size();
867 if (nMostTrustedPos
== (-1) || nSigningIPsTotal
== 0) {
871 // the check if we trust any hash
872 if ( thePrefs::IsTrustingEveryHash() ||
873 (nMostTrustedIPs
>= MINUNIQUEIPS_TOTRUST
&& (100 * nMostTrustedIPs
)/nSigningIPsTotal
>= MINPERCENTAGE_TOTRUST
)) {
875 AddDebugLogLineN(logSHAHashSet
,
876 CFormat(wxT("AICH Hash received (%sadded), We have now %u hash(es) from %u unique IP(s). ")
877 wxT("We trust the Hash %s from %u client(s) (%u%%). File: %s"))
878 % (bAdded
? wxT("") : wxT("not "))
879 % m_aUntrustedHashs
.size()
881 % m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
.GetString()
883 % ((100 * nMostTrustedIPs
) / nSigningIPsTotal
)
884 % m_pOwner
->GetFileName());
886 SetStatus(AICH_TRUSTED
);
887 if (!HasValidMasterHash() || GetMasterHash() != m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
) {
888 SetMasterHash(m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
, AICH_TRUSTED
);
893 AddDebugLogLineN(logSHAHashSet
,
894 CFormat(wxT("AICH Hash received (%sadded), We have now %u hash(es) from %u unique IP(s). ")
895 wxT("Best Hash %s from %u clients (%u%%) - but we don't trust it yet. File: %s"))
896 % (bAdded
? wxT(""): wxT("not "))
897 % m_aUntrustedHashs
.size()
899 % m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
.GetString()
901 % ((100 * nMostTrustedIPs
) / nSigningIPsTotal
)
902 % m_pOwner
->GetFileName());
904 SetStatus(AICH_UNTRUSTED
);
905 if (!HasValidMasterHash() || GetMasterHash() != m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
) {
906 SetMasterHash(m_aUntrustedHashs
[nMostTrustedPos
].m_Hash
, AICH_UNTRUSTED
);
913 void CAICHHashSet::ClientAICHRequestFailed(CUpDownClient
* pClient
)
915 pClient
->SetReqFileAICHHash(NULL
);
916 CAICHRequestedData data
= GetAICHReqDetails(pClient
);
917 RemoveClientAICHRequest(pClient
);
918 if (data
.m_pClient
.GetClient() != pClient
) {
921 if( theApp
->downloadqueue
->IsPartFile(data
.m_pPartFile
)) {
922 AddDebugLogLineN(logSHAHashSet
,
923 CFormat(wxT("AICH Request failed, Trying to ask another client (File: '%s', Part: %u, Client '%s'"))
924 % data
.m_pPartFile
->GetFileName() % data
.m_nPart
% pClient
->GetClientFullInfo());
925 data
.m_pPartFile
->RequestAICHRecovery(data
.m_nPart
);
930 void CAICHHashSet::RemoveClientAICHRequest(const CUpDownClient
* pClient
)
932 for (CAICHRequestedDataList::iterator it
= m_liRequestedData
.begin();it
!= m_liRequestedData
.end(); ++it
) {
933 if (it
->m_pClient
.GetClient() == pClient
) {
934 m_liRequestedData
.erase(it
);
941 bool CAICHHashSet::IsClientRequestPending(const CPartFile
* pForFile
, uint16 nPart
)
943 for (CAICHRequestedDataList::iterator it
= m_liRequestedData
.begin();it
!= m_liRequestedData
.end(); ++it
) {
944 if (it
->m_pPartFile
== pForFile
&& it
->m_nPart
== nPart
) {
951 CAICHRequestedData
CAICHHashSet::GetAICHReqDetails(const CUpDownClient
* pClient
)
953 for (CAICHRequestedDataList::iterator it
= m_liRequestedData
.begin();it
!= m_liRequestedData
.end(); ++it
) {
954 if (it
->m_pClient
.GetClient() == pClient
) {
959 CAICHRequestedData empty
;
963 bool CAICHHashSet::IsPartDataAvailable(uint64 nPartStartPos
)
965 if (!(m_eStatus
== AICH_VERIFIED
|| m_eStatus
== AICH_TRUSTED
|| m_eStatus
== AICH_HASHSETCOMPLETE
) ) {
969 uint64 nPartSize
= min
<uint64
>(PARTSIZE
, m_pOwner
->GetFileSize()-nPartStartPos
);
970 for (uint64 nPartPos
= 0; nPartPos
< nPartSize
; nPartPos
+= EMBLOCKSIZE
) {
971 CAICHHashTree
* phtToCheck
= m_pHashTree
.FindHash(nPartStartPos
+nPartPos
, min
<uint64
>(EMBLOCKSIZE
, nPartSize
-nPartPos
));
972 if (phtToCheck
== NULL
|| !phtToCheck
->m_bHashValid
) {
979 // VC++ defines Assert as ASSERT. VC++ also defines VERIFY MACRO, which is the equivalent of ASSERT but also works in Released builds.
981 #define VERIFY(x) wxASSERT(x)
983 void CAICHHashSet::DbgTest()
986 //define TESTSIZE 4294567295
992 /* CAICHHashTree* pTest = new CAICHHashTree(TESTSIZE, true, 9728000);
993 for (uint64 i = 0; i+9728000 < TESTSIZE; i += 9728000) {
994 CAICHHashTree* pTest2 = new CAICHHashTree(9728000, true, EMBLOCKSIZE);
995 pTest->ReplaceHashTree(i, 9728000, &pTest2);
998 CAICHHashTree* pTest2 = new CAICHHashTree(TESTSIZE-i, true, EMBLOCKSIZE);
999 pTest->ReplaceHashTree(i, (TESTSIZE-i), &pTest2);
1002 #define TESTSIZE m_pHashTree.m_nDataSize
1003 if (m_pHashTree
.m_nDataSize
<= EMBLOCKSIZE
) {
1006 CAICHHashSet
TestHashSet(m_pOwner
);
1007 TestHashSet
.SetFileSize(m_pOwner
->GetFileSize());
1008 TestHashSet
.SetMasterHash(GetMasterHash(), AICH_VERIFIED
);
1011 for (i
= 0; i
+9728000 < TESTSIZE
; i
+= 9728000) {
1012 VERIFY( CreatePartRecoveryData(i
, &file
) );
1014 /*uint32 nRandomCorruption = (rand() * rand()) % (file.GetLength()-4);
1015 file.Seek(nRandomCorruption, CFile::begin);
1016 file.Write(&nRandomCorruption, 4);*/
1018 file
.Seek(0,wxFromStart
);
1019 VERIFY( TestHashSet
.ReadRecoveryData(i
, &file
) );
1020 file
.Seek(0,wxFromStart
);
1021 TestHashSet
.FreeHashSet();
1023 for (j
= 0; j
+EMBLOCKSIZE
< 9728000; j
+= EMBLOCKSIZE
) {
1024 VERIFY( m_pHashTree
.FindHash(i
+j
, EMBLOCKSIZE
, &curLevel
) );
1025 //TRACE(wxT("%u - %s\r\n"), cHash, m_pHashTree.FindHash(i+j, EMBLOCKSIZE, &curLevel)->m_Hash.GetString());
1026 maxLevel
= max(curLevel
, maxLevel
);
1030 VERIFY( m_pHashTree
.FindHash(i
+j
, 9728000-j
, &curLevel
) );
1031 //TRACE(wxT("%u - %s\r\n"), cHash, m_pHashTree.FindHash(i+j, 9728000-j, &curLevel)->m_Hash.GetString());
1032 maxLevel
= max(curLevel
, maxLevel
);
1037 VERIFY( CreatePartRecoveryData(i
, &file
) );
1038 file
.Seek(0,wxFromStart
);
1039 VERIFY( TestHashSet
.ReadRecoveryData(i
, &file
) );
1040 file
.Seek(0,wxFromStart
);
1041 TestHashSet
.FreeHashSet();
1042 for (uint64 j
= 0; j
+EMBLOCKSIZE
< TESTSIZE
-i
; j
+= EMBLOCKSIZE
) {
1043 VERIFY( m_pHashTree
.FindHash(i
+j
, EMBLOCKSIZE
, &curLevel
) );
1044 //TRACE(wxT("%u - %s\r\n"), cHash,m_pHashTree.FindHash(i+j, EMBLOCKSIZE, &curLevel)->m_Hash.GetString());
1045 maxLevel
= max(curLevel
, maxLevel
);
1049 //VERIFY( m_pHashTree.FindHash(i+j, (TESTSIZE-i)-j, &curLevel) );
1050 //TRACE(wxT("%u - %s\r\n"), cHash,m_pHashTree.FindHash(i+j, (TESTSIZE-i)-j, &curLevel)->m_Hash.GetString());
1051 maxLevel
= max(curLevel
, maxLevel
);
1054 // File_checked_for_headers