src/KnownFileList.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   5 // Copyright (c) 2002-2008 Merkur ( devs@emule-project.net / http://www.emule-project.net )
   6 //
   7 // Any parts of this program derived from the xMule, lMule or eMule project,
   8 // or contributed by third-party developers are copyrighted by their
   9 // respective authors.
  10 //
  11 // This program is free software; you can redistribute it and/or modify
  12 // it under the terms of the GNU General Public License as published by
  13 // the Free Software Foundation; either version 2 of the License, or
  14 // (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 // GNU General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  24 //
  25
  26
  27 #include "KnownFileList.h"      // Interface declarations
  28
  29 #include <common/DataFileVersion.h>
  30
  31 #include <memory>               // Do_not_auto_remove (lionel's Mac, 10.3)
  32 #include "PartFile.h"           // Needed for CPartFile
  33 #include "amule.h"
  34 #include "Logger.h"
  35 #include "ScopedPtr.h"
  36 #include <common/Format.h>
  37
  38
  39 // This function is inlined for performance
  40 inline bool CKnownFileList::KnownFileMatches(
  41         CKnownFile *knownFile,
  42         const CPath& filename,
  43         uint32 in_date,
  44         uint64 in_size) const
  45 {
  46         return
  47                 (knownFile->GetLastChangeDatetime() == (time_t)in_date) &&
  48                 (knownFile->GetFileSize() == in_size) &&
  49                 (knownFile->GetFileName() == filename);
  50 }
  51
  52
  53 CKnownFileList::CKnownFileList()
  54 {
  55         accepted = 0;
  56         requested = 0;
  57         transferred = 0;
  58         Init();
  59 }
  60
  61
  62 CKnownFileList::~CKnownFileList()
  63 {
  64         Clear();
  65 }
  66
  67
  68 bool CKnownFileList::Init()
  69 {
  70         CFile file;
  71
  72         CPath fullpath = CPath(theApp->ConfigDir + wxT("known.met"));
  73         if (!fullpath.FileExists()) {
  74                 // This is perfectly normal. The file was probably either
  75                 // deleted, or this is the first time running aMule.
  76                 return false;
  77         }
  78
  79         if (!file.Open(fullpath)) {
  80                 AddLogLineM(true, _("WARNING: known.met cannot be opened."));
  81                 return false;
  82         }
  83
  84         try {
  85                 uint8 version = file.ReadUInt8();
  86                 if ((version != MET_HEADER) && (version != MET_HEADER_WITH_LARGEFILES)) {
  87                         AddLogLineM(true, _("WARNING: Known file list corrupted, contains invalid header."));
  88                         return false;
  89                 }
  90
  91                 wxMutexLocker sLock(list_mut);
  92                 uint32 RecordsNumber = file.ReadUInt32();
  93                 AddDebugLogLineM(false, logKnownFiles,
  94                         wxString::Format(wxT("Reading %i known files from file format 0x%2.2x."),
  95                         RecordsNumber, version));
  96                 for (uint32 i = 0; i < RecordsNumber; i++) {
  97                         CScopedPtr<CKnownFile> record(new CKnownFile());
  98                         if (record->LoadFromFile(&file)) {
  99                                 AddDebugLogLineM(false, logKnownFiles,
 100                                         CFormat(wxT("Known file read: %s")) % record->GetFileName());
 101                                 Append(record.release());
 102                         } else {
 103                                 AddLogLineM(true,
 104                                         wxT("Failed to load entry in knownfilelist, file may be corrupt"));
 105                         }
 106                 }
 107                 AddDebugLogLineM(false, logKnownFiles, wxT("Finished reading known files"));
 108
 109                 return true;
 110         } catch (const CInvalidPacket& e) {
 111                 AddLogLineM(true, wxT("Invalid entry in knownfilelist, file may be corrupt: ") + e.what());
 112         } catch (const CSafeIOException& e) {
 113                 AddLogLineM(true, CFormat(_("IO error while reading known.met file: %s")) % e.what());
 114         }
 115
 116         return false;
 117 }
 118
 119
 120 void CKnownFileList::Save()
 121 {
 122         CFile file(theApp->ConfigDir + wxT("known.met"), CFile::write);
 123         if (!file.IsOpened()) {
 124                 return;
 125         }
 126
 127         wxMutexLocker sLock(list_mut);
 128
 129         try {
 130                 // Kry - This is the version, but we don't know it till
 131                 // we know if any largefile is saved. This allows the list
 132                 // to be compatible with previous versions.
 133                 bool bContainsAnyLargeFiles = false;
 134                 file.WriteUInt8(0);
 135
 136                 file.WriteUInt32(m_knownFileMap.size() + m_duplicateFileList.size());
 137
 138                 // Duplicates handling. Duplicates needs to be saved first,
 139                 // since it is the last entry that gets used.
 140                 KnownFileList::iterator itDup = m_duplicateFileList.begin();
 141                 for ( ; itDup != m_duplicateFileList.end(); ++itDup ) {
 142                         (*itDup)->WriteToFile(&file);
 143                         if ((*itDup)->IsLargeFile()) {
 144                                 bContainsAnyLargeFiles = true;
 145                         }
 146                 }
 147
 148                 CKnownFileMap::iterator it = m_knownFileMap.begin();
 149                 for (; it != m_knownFileMap.end(); ++it) {
 150                         it->second->WriteToFile(&file);
 151                         if (it->second->IsLargeFile()) {
 152                                 bContainsAnyLargeFiles = true;
 153                         }
 154                 }
 155
 156                 file.Seek(0);
 157                 file.WriteUInt8(bContainsAnyLargeFiles ? MET_HEADER_WITH_LARGEFILES : MET_HEADER);
 158         } catch (const CIOFailureException& e) {
 159                 AddLogLineM(true, CFormat(_("Error while saving known.met file: %s")) % e.what());
 160         }
 161 }
 162
 163
 164 void CKnownFileList::Clear()
 165 {
 166         wxMutexLocker sLock(list_mut);
 167
 168         DeleteContents(m_knownFileMap);
 169         DeleteContents(m_duplicateFileList);
 170 }
 171
 172
 173 CKnownFile* CKnownFileList::FindKnownFile(
 174         const CPath& filename,
 175         time_t in_date,
 176         uint64 in_size)
 177 {
 178         wxMutexLocker sLock(list_mut);
 179
 180         for (CKnownFileMap::const_iterator it = m_knownFileMap.begin();
 181              it != m_knownFileMap.end(); ++it) {
 182                 CKnownFile *cur_file = it->second;
 183                 if (KnownFileMatches(cur_file, filename, in_date, in_size)) {
 184                         return cur_file;
 185                 }
 186         }
 187
 188         return IsOnDuplicates(filename, in_date, in_size);
 189 }
 190
 191
 192 CKnownFile *CKnownFileList::IsOnDuplicates(
 193         const CPath& filename,
 194         uint32 in_date,
 195         uint64 in_size) const
 196 {
 197         for (KnownFileList::const_iterator it = m_duplicateFileList.begin();
 198              it != m_duplicateFileList.end(); ++it) {
 199                 CKnownFile *cur_file = *it;
 200                 if (KnownFileMatches(cur_file, filename, in_date, in_size)) {
 201                         return cur_file;
 202                 }
 203         }
 204         return NULL;
 205 }
 206
 207
 208 bool CKnownFileList::IsKnownFile(const CKnownFile *file)
 209 {
 210         wxCHECK(file, false);
 211
 212         wxMutexLocker sLock(list_mut);
 213
 214         // For the map, search with the key
 215         const CMD4Hash &key = file->GetFileHash();
 216         CKnownFileMap::const_iterator itMap = m_knownFileMap.find(key);
 217         if (itMap != m_knownFileMap.end()) {
 218                 return true;
 219         }
 220         // For the list, we have to iterate to search
 221         for (KnownFileList::iterator it = m_duplicateFileList.begin();
 222              it != m_duplicateFileList.end(); ++it) {
 223                 if (*it == file) {
 224                         return true;
 225                 }
 226         }
 227         return false;
 228 }
 229
 230
 231 CKnownFile* CKnownFileList::FindKnownFileByID(const CMD4Hash& hash)
 232 {
 233         wxMutexLocker sLock(list_mut);
 234
 235         if (!hash.IsEmpty()) {
 236                 if (m_knownFileMap.find(hash) != m_knownFileMap.end()) {
 237                         return m_knownFileMap[hash];
 238                 } else {
 239                         return NULL;
 240                 }
 241         }
 242         return NULL;
 243
 244 }
 245
 246
 247 bool CKnownFileList::SafeAddKFile(CKnownFile* toadd)
 248 {
 249         wxMutexLocker sLock(list_mut);
 250         return Append(toadd);
 251 }
 252
 253
 254 bool CKnownFileList::Append(CKnownFile *Record)
 255 {
 256         if (Record->GetFileSize() > 0) {
 257                 const CMD4Hash& tkey = Record->GetFileHash();
 258                 CKnownFileMap::iterator it = m_knownFileMap.find(tkey);
 259                 if (it == m_knownFileMap.end()) {
 260                         m_knownFileMap[tkey] = Record;
 261                         return true;
 262                 } else {
 263                         it->second;
 264                         time_t in_date =  it->second->GetLastChangeDatetime();
 265                         uint64 in_size =  it->second->GetFileSize();
 266                         CPath filename = it->second->GetFileName();
 267                         if (KnownFileMatches(Record, filename, in_date, in_size) ||
 268                             IsOnDuplicates(filename, in_date, in_size)) {
 269                                 // The file is already on the list, ignore it.
 270                                 return false;
 271                         } else {
 272                                 // The file is a duplicated hash. Add THE OLD ONE to the duplicates list.
 273                                 m_duplicateFileList.push_back(m_knownFileMap[tkey]);
 274                                 // Is this thread-safe? If John is not sure and I'm not sure either...
 275                                 if (theApp->sharedfiles) {
 276                                         // Removing the old kad keywords created with the old filename
 277                                         theApp->sharedfiles->RemoveKeywords(it->second);
 278                                 }
 279                                 m_knownFileMap[tkey] = Record;
 280                                 return true;
 281                         }
 282                 }
 283         } else {
 284                 AddDebugLogLineM(false, logGeneral,
 285                         CFormat(wxT("%s is 0-size, not added")) %
 286                         Record->GetFileName());
 287
 288                 return false;
 289         }
 290 }
 291
 292 // File_checked_for_headers