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 "SearchList.h"         // Needed for UpdateSearchFileByHash
  37 #include <common/Format.h>
  38
  39
  40 // This function is inlined for performance
  41 inline bool CKnownFileList::KnownFileMatches(
  42         CKnownFile *knownFile,
  43         const CPath& filename,
  44         uint32 in_date,
  45         uint64 in_size) const
  46 {
  47         return
  48                 (knownFile->GetLastChangeDatetime() == (time_t)in_date) &&
  49                 (knownFile->GetFileSize() == in_size) &&
  50                 (knownFile->GetFileName() == filename);
  51 }
  52
  53
  54 CKnownFileList::CKnownFileList()
  55 {
  56         accepted = 0;
  57         requested = 0;
  58         transferred = 0;
  59         m_filename = wxT("known.met");
  60         Init();
  61 }
  62
  63
  64 CKnownFileList::~CKnownFileList()
  65 {
  66         Clear();
  67 }
  68
  69
  70 bool CKnownFileList::Init()
  71 {
  72         CFile file;
  73
  74         CPath fullpath = CPath(theApp->ConfigDir + m_filename);
  75         if (!fullpath.FileExists()) {
  76                 // This is perfectly normal. The file was probably either
  77                 // deleted, or this is the first time running aMule.
  78                 return false;
  79         }
  80
  81         if (!file.Open(fullpath)) {
  82                 AddLogLineM(true, CFormat(_("WARNING: %s cannot be opened.")) % m_filename);
  83                 return false;
  84         }
  85
  86         try {
  87                 uint8 version = file.ReadUInt8();
  88                 if ((version != MET_HEADER) && (version != MET_HEADER_WITH_LARGEFILES)) {
  89                         AddLogLineM(true, _("WARNING: Known file list corrupted, contains invalid header."));
  90                         return false;
  91                 }
  92
  93                 wxMutexLocker sLock(list_mut);
  94                 uint32 RecordsNumber = file.ReadUInt32();
  95                 AddDebugLogLineM(false, logKnownFiles,
  96                         wxString::Format(wxT("Reading %i known files from file format 0x%2.2x."),
  97                         RecordsNumber, version));
  98                 for (uint32 i = 0; i < RecordsNumber; i++) {
  99                         CScopedPtr<CKnownFile> record(new CKnownFile());
 100                         if (record->LoadFromFile(&file)) {
 101                                 AddDebugLogLineM(false, logKnownFiles,
 102                                         CFormat(wxT("Known file read: %s")) % record->GetFileName());
 103                                 Append(record.release());
 104                         } else {
 105                                 AddLogLineM(true,
 106                                         wxT("Failed to load entry in knownfilelist, file may be corrupt"));
 107                         }
 108                 }
 109                 AddDebugLogLineM(false, logKnownFiles, wxT("Finished reading known files"));
 110
 111                 return true;
 112         } catch (const CInvalidPacket& e) {
 113                 AddLogLineM(true, wxT("Invalid entry in knownfilelist, file may be corrupt: ") + e.what());
 114         } catch (const CSafeIOException& e) {
 115                 AddLogLineM(true, CFormat(_("IO error while reading %s file: %s")) % m_filename % e.what());
 116         }
 117
 118         return false;
 119 }
 120
 121
 122 void CKnownFileList::Save()
 123 {
 124         CFile file(theApp->ConfigDir + m_filename, CFile::write);
 125         if (!file.IsOpened()) {
 126                 return;
 127         }
 128
 129         wxMutexLocker sLock(list_mut);
 130
 131         try {
 132                 // Kry - This is the version, but we don't know it till
 133                 // we know if any largefile is saved. This allows the list
 134                 // to be compatible with previous versions.
 135                 bool bContainsAnyLargeFiles = false;
 136                 file.WriteUInt8(0);
 137
 138                 file.WriteUInt32(m_knownFileMap.size() + m_duplicateFileList.size());
 139
 140                 // Duplicates handling. Duplicates needs to be saved first,
 141                 // since it is the last entry that gets used.
 142                 KnownFileList::iterator itDup = m_duplicateFileList.begin();
 143                 for ( ; itDup != m_duplicateFileList.end(); ++itDup ) {
 144                         (*itDup)->WriteToFile(&file);
 145                         if ((*itDup)->IsLargeFile()) {
 146                                 bContainsAnyLargeFiles = true;
 147                         }
 148                 }
 149
 150                 CKnownFileMap::iterator it = m_knownFileMap.begin();
 151                 for (; it != m_knownFileMap.end(); ++it) {
 152                         it->second->WriteToFile(&file);
 153                         if (it->second->IsLargeFile()) {
 154                                 bContainsAnyLargeFiles = true;
 155                         }
 156                 }
 157
 158                 file.Seek(0);
 159                 file.WriteUInt8(bContainsAnyLargeFiles ? MET_HEADER_WITH_LARGEFILES : MET_HEADER);
 160         } catch (const CIOFailureException& e) {
 161                 AddLogLineM(true, CFormat(_("Error while saving %s file: %s")) % m_filename % e.what());
 162         }
 163 }
 164
 165
 166 void CKnownFileList::Clear()
 167 {
 168         wxMutexLocker sLock(list_mut);
 169
 170         DeleteContents(m_knownFileMap);
 171         DeleteContents(m_duplicateFileList);
 172 }
 173
 174
 175 CKnownFile* CKnownFileList::FindKnownFile(
 176         const CPath& filename,
 177         time_t in_date,
 178         uint64 in_size)
 179 {
 180         wxMutexLocker sLock(list_mut);
 181
 182         for (CKnownFileMap::const_iterator it = m_knownFileMap.begin();
 183              it != m_knownFileMap.end(); ++it) {
 184                 CKnownFile *cur_file = it->second;
 185                 if (KnownFileMatches(cur_file, filename, in_date, in_size)) {
 186                         return cur_file;
 187                 }
 188         }
 189
 190         return IsOnDuplicates(filename, in_date, in_size);
 191 }
 192
 193
 194 CKnownFile *CKnownFileList::IsOnDuplicates(
 195         const CPath& filename,
 196         uint32 in_date,
 197         uint64 in_size) const
 198 {
 199         for (KnownFileList::const_iterator it = m_duplicateFileList.begin();
 200              it != m_duplicateFileList.end(); ++it) {
 201                 CKnownFile *cur_file = *it;
 202                 if (KnownFileMatches(cur_file, filename, in_date, in_size)) {
 203                         return cur_file;
 204                 }
 205         }
 206         return NULL;
 207 }
 208
 209
 210 bool CKnownFileList::IsKnownFile(const CKnownFile *file)
 211 {
 212         wxCHECK(file, false);
 213
 214         wxMutexLocker sLock(list_mut);
 215
 216         // For the map, search with the key
 217         const CMD4Hash &key = file->GetFileHash();
 218         CKnownFileMap::const_iterator itMap = m_knownFileMap.find(key);
 219         if (itMap != m_knownFileMap.end()) {
 220                 return true;
 221         }
 222         // For the list, we have to iterate to search
 223         for (KnownFileList::iterator it = m_duplicateFileList.begin();
 224              it != m_duplicateFileList.end(); ++it) {
 225                 if (*it == file) {
 226                         return true;
 227                 }
 228         }
 229         return false;
 230 }
 231
 232
 233 CKnownFile* CKnownFileList::FindKnownFileByID(const CMD4Hash& hash)
 234 {
 235         wxMutexLocker sLock(list_mut);
 236
 237         if (!hash.IsEmpty()) {
 238                 if (m_knownFileMap.find(hash) != m_knownFileMap.end()) {
 239                         return m_knownFileMap[hash];
 240                 } else {
 241                         return NULL;
 242                 }
 243         }
 244         return NULL;
 245
 246 }
 247
 248
 249 bool CKnownFileList::SafeAddKFile(CKnownFile* toadd)
 250 {
 251         bool ret;
 252         {
 253                 wxMutexLocker sLock(list_mut);
 254                 ret = Append(toadd);
 255         }
 256         if (ret) {
 257                 theApp->searchlist->UpdateSearchFileByHash(toadd->GetFileHash());
 258         }
 259         return ret;
 260 }
 261
 262
 263 bool CKnownFileList::Append(CKnownFile *Record)
 264 {
 265         if (Record->GetFileSize() > 0) {
 266                 const CMD4Hash& tkey = Record->GetFileHash();
 267                 CKnownFileMap::iterator it = m_knownFileMap.find(tkey);
 268                 if (it == m_knownFileMap.end()) {
 269                         m_knownFileMap[tkey] = Record;
 270                         return true;
 271                 } else {
 272                         it->second;
 273                         time_t in_date =  it->second->GetLastChangeDatetime();
 274                         uint64 in_size =  it->second->GetFileSize();
 275                         CPath filename = it->second->GetFileName();
 276                         if (KnownFileMatches(Record, filename, in_date, in_size) ||
 277                             IsOnDuplicates(filename, in_date, in_size)) {
 278                                 // The file is already on the list, ignore it.
 279                                 return false;
 280                         } else {
 281                                 // The file is a duplicated hash. Add THE OLD ONE to the duplicates list.
 282                                 m_duplicateFileList.push_back(m_knownFileMap[tkey]);
 283                                 // Is this thread-safe? If John is not sure and I'm not sure either...
 284                                 if (theApp->sharedfiles) {
 285                                         // Removing the old kad keywords created with the old filename
 286                                         theApp->sharedfiles->RemoveKeywords(it->second);
 287                                 }
 288                                 m_knownFileMap[tkey] = Record;
 289                                 return true;
 290                         }
 291                 }
 292         } else {
 293                 AddDebugLogLineM(false, logGeneral,
 294                         CFormat(wxT("%s is 0-size, not added")) %
 295                         Record->GetFileName());
 296
 297                 return false;
 298         }
 299 }
 300
 301 // File_checked_for_headers