src/IPFilter.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2003-2011 aMule Team ( admin@amule.org / http://www.amule.org )
   5 // Copyright (c) 2002-2011 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 #include <wx/stdpaths.h>                // Needed for GetDataDir
  27 #include <wx/ffile.h>
  28
  29 #include "IPFilter.h"                   // Interface declarations.
  30 #include "IPFilterScanner.h"    // Interface for flexer
  31 #include "Preferences.h"                // Needed for thePrefs
  32 #include "amule.h"                      // Needed for theApp
  33 #include "Statistics.h"                 // Needed for theStats
  34 #include "HTTPDownload.h"               // Needed for CHTTPDownloadThread
  35 #include "Logger.h"                     // Needed for AddDebugLogLine{C,N}
  36 #include <common/Format.h>              // Needed for CFormat
  37 #include <common/StringFunctions.h>     // Needed for CSimpleTokenizer
  38 #include <common/FileFunctions.h>       // Needed for UnpackArchive
  39 #include <common/TextFile.h>            // Needed for CTextFile
  40 #include "ThreadScheduler.h"            // Needed for CThreadScheduler and CThreadTask
  41 #include "ClientList.h"                 // Needed for CClientList
  42 #include "ServerList.h"                 // Needed for CServerList
  43 #include <common/Macros.h>              // Needed for DEBUG_ONLY()
  44 #include "RangeMap.h"                   // Needed for CRangeMap
  45 #include "ServerConnect.h"              // Needed for ConnectToAnyServer()
  46 #include "DownloadQueue.h"              // Needed for theApp->downloadqueue
  47
  48
  49 ////////////////////////////////////////////////////////////
  50 // CIPFilterEvent
  51
  52 BEGIN_DECLARE_EVENT_TYPES()
  53         DECLARE_EVENT_TYPE(MULE_EVT_IPFILTER_LOADED, -1)
  54 END_DECLARE_EVENT_TYPES()
  55
  56 DEFINE_EVENT_TYPE(MULE_EVT_IPFILTER_LOADED)
  57
  58
  59 class CIPFilterEvent : public wxEvent
  60 {
  61 public:
  62         CIPFilterEvent(CIPFilter::RangeIPs rangeIPs, CIPFilter::RangeLengths rangeLengths, CIPFilter::RangeNames rangeNames)
  63                 : wxEvent(-1, MULE_EVT_IPFILTER_LOADED)
  64         {
  65                 // Physically copy the vectors, this will hopefully resize them back to their needed capacity.
  66                 m_rangeIPs = rangeIPs;
  67                 m_rangeLengths = rangeLengths;
  68                 // This one is usually empty, and should always be swapped, not copied.
  69                 std::swap(m_rangeNames, rangeNames);
  70         }
  71
  72         /** @see wxEvent::Clone */
  73         virtual wxEvent* Clone() const {
  74                 return new CIPFilterEvent(*this);
  75         }
  76
  77         CIPFilter::RangeIPs m_rangeIPs;
  78         CIPFilter::RangeLengths m_rangeLengths;
  79         CIPFilter::RangeNames m_rangeNames;
  80 };
  81
  82
  83 typedef void (wxEvtHandler::*MuleIPFilterEventFunction)(CIPFilterEvent&);
  84
  85 //! Event-handler for completed hashings of new shared files and partfiles.
  86 #define EVT_MULE_IPFILTER_LOADED(func) \
  87         DECLARE_EVENT_TABLE_ENTRY(MULE_EVT_IPFILTER_LOADED, -1, -1, \
  88         (wxObjectEventFunction) (wxEventFunction) \
  89         wxStaticCastEvent(MuleIPFilterEventFunction, &func), (wxObject*) NULL),
  90
  91
  92 ////////////////////////////////////////////////////////////
  93 // Thread task for loading the ipfilter.dat files.
  94
  95 /**
  96  * This task loads the two ipfilter.dat files, a task that
  97  * can take quite a while on a slow system with a large dat-
  98  * file.
  99  */
 100 class CIPFilterTask : public CThreadTask
 101 {
 102 public:
 103         CIPFilterTask(wxEvtHandler* owner)
 104                 : CThreadTask(wxT("Load IPFilter"), wxEmptyString, ETP_Critical),
 105                   m_storeDescriptions(false),
 106                   m_owner(owner)
 107         {
 108         }
 109
 110 private:
 111         void Entry()
 112         {
 113                 AddLogLineN(_("Loading IP filters 'ipfilter.dat' and 'ipfilter_static.dat'."));
 114                 if ( !LoadFromFile(thePrefs::GetConfigDir() + wxT("ipfilter.dat")) &&
 115                      thePrefs::UseIPFilterSystem() ) {
 116                         // Load from system wide IP filter file
 117                         wxStandardPathsBase &spb(wxStandardPaths::Get());
 118 #ifdef __WINDOWS__
 119                         wxString dataDir(spb.GetPluginsDir());
 120 #elif defined(__WXMAC__)
 121                         wxString dataDir(spb.GetDataDir());
 122 #else
 123                         wxString dataDir(spb.GetDataDir().BeforeLast(wxT('/')) + wxT("/amule"));
 124 #endif
 125                         wxString systemwideFile(JoinPaths(dataDir,wxT("ipfilter.dat")));
 126                         LoadFromFile(systemwideFile);
 127                 }
 128
 129
 130                 LoadFromFile(thePrefs::GetConfigDir() + wxT("ipfilter_static.dat"));
 131
 132                 uint8 accessLevel = thePrefs::GetIPFilterLevel();
 133                 uint32 size = m_result.size();
 134                 // Reserve a little more so we don't have to resize the vector later.
 135                 // (Map ranges can exist that have to be stored in several parts.)
 136                 // Extra memory will be freed in the end.
 137                 m_rangeIPs.reserve(size + 1000);
 138                 m_rangeLengths.reserve(size + 1000);
 139                 if (m_storeDescriptions) {
 140                         m_rangeNames.reserve(size + 1000);
 141                 }
 142                 for (IPMap::iterator it = m_result.begin(); it != m_result.end(); ++it) {
 143                         if (it->AccessLevel < accessLevel) {
 144                                 // Calculate range "length"
 145                                 // (which is included-end - start and thus length - 1)
 146                                 // Encoding:
 147                                 // 0      - 0x7fff      same
 148                                 // 0x8000 - 0xffff      0xfff   - 0x07ffffff
 149                                 // that means: remove msb, shift left by 12 bit, add 0xfff
 150                                 // so it can cover 8 consecutive class A nets
 151                                 // larger ranges (or theoretical ranges with uneven ends) have to be split
 152                                 uint32 startIP = it.keyStart();
 153                                 uint32 realLength = it.keyEnd() - it.keyStart() + 1;
 154 #ifdef __DEBUG__
 155                                 std::string * descp = 0;
 156 #endif
 157                                 while (realLength) {
 158                                         m_rangeIPs.push_back(startIP);
 159                                         uint32 curLength = realLength;
 160                                         uint16 pushLength;
 161                                         if (realLength <= 0x8000) {
 162                                                 pushLength = realLength - 1;
 163                                         } else {
 164                                                 if (curLength >= 0x08000000) {
 165                                                         // range to big, limit
 166                                                         curLength = 0x08000000;
 167                                                 } else {
 168                                                         // cut off LSBs
 169                                                         curLength &= 0x07FFF000;
 170                                                 }
 171                                                 pushLength = ((curLength - 1) >> 12) | 0x8000;
 172                                         }
 173                                         m_rangeLengths.push_back(pushLength);
 174 #ifdef __DEBUG__
 175                                         if (m_storeDescriptions) {
 176                                                 // std::string has no ref counting, so swap it
 177                                                 // (it's used so we need half the space than wxString with wide chars)
 178                                                 if (descp) {
 179                                                         // we split the range so we have to duplicate it
 180                                                         m_rangeNames.push_back(*descp);
 181                                                 } else {
 182                                                         // push back empty string and swap
 183                                                         m_rangeNames.push_back(std::string());
 184                                                         descp = & * m_rangeNames.rbegin();
 185                                                         std::swap(*descp, it->Description);
 186                                                 }
 187                                         }
 188 #endif
 189                                         realLength -= curLength;
 190                                         startIP += curLength;
 191                                 }
 192                         }
 193                 }
 194                 // Numbers are probably different:
 195                 // - ranges from map that are not blocked because of their level are not added to the table
 196                 // - some ranges from the map have to be split for the table
 197                 AddDebugLogLineN(logIPFilter, CFormat(wxT("Ranges in map: %d  blocked ranges in table: %d")) % size % m_rangeIPs.size());
 198
 199                 CIPFilterEvent evt(m_rangeIPs, m_rangeLengths, m_rangeNames);
 200                 wxPostEvent(m_owner, evt);
 201         }
 202
 203         /**
 204          * This structure is used to contain the range-data in the rangemap.
 205          */
 206         struct rangeObject
 207         {
 208                 bool operator==( const rangeObject& other ) const {
 209                         return AccessLevel == other.AccessLevel;
 210                 }
 211
 212 // Since descriptions are only used for debugging messages, there
 213 // is no need to keep them in memory when running a non-debug build.
 214 #ifdef __DEBUG__
 215                 //! Contains the user-description of the range.
 216                 std::string     Description;
 217 #endif
 218
 219                 //! The AccessLevel for this filter.
 220                 uint8           AccessLevel;
 221         };
 222
 223         //! The is the type of map used to store the IPs.
 224         typedef CRangeMap<rangeObject, uint32> IPMap;
 225
 226         bool m_storeDescriptions;
 227
 228         // the generated filter
 229         CIPFilter::RangeIPs m_rangeIPs;
 230         CIPFilter::RangeLengths m_rangeLengths;
 231         CIPFilter::RangeNames m_rangeNames;
 232
 233         wxEvtHandler*           m_owner;
 234         // temporary map for filter generation
 235         IPMap                           m_result;
 236
 237         /**
 238          * Helper function.
 239          *
 240          * @param IPstart The start of the IP-range.
 241          * @param IPend The end of the IP-range, must be less than or equal to IPstart.
 242          * @param AccessLevel The AccessLevel of this range.
 243          * @param Description The assosiated description of this range.
 244          * @return true if the range was added, false if it was discarded.
 245          *
 246          * This function inserts the specified range into the IPMap. Invalid
 247          * ranges where the AccessLevel is not within the range 0..255, or
 248          * where IPEnd < IPstart not inserted.
 249          */
 250         bool AddIPRange(uint32 IPStart, uint32 IPEnd, uint16 AccessLevel, const char* DEBUG_ONLY(Description))
 251         {
 252                 if (AccessLevel < 256) {
 253                         if (IPStart <= IPEnd) {
 254                                 rangeObject item;
 255                                 item.AccessLevel = AccessLevel;
 256 #ifdef __DEBUG__
 257                                 if (m_storeDescriptions) {
 258                                         item.Description = Description;
 259                                 }
 260 #endif
 261
 262                                 m_result.insert(IPStart, IPEnd, item);
 263
 264                                 return true;
 265                         }
 266                 }
 267
 268                 return false;
 269         }
 270
 271
 272         /**
 273          * Loads a IP-list from the specified file, can be text or zip.
 274          *
 275          * @return True if the file was loaded, false otherwise.
 276          **/
 277         int LoadFromFile(const wxString& file)
 278         {
 279                 const CPath path = CPath(file);
 280
 281                 if (!path.FileExists() || TestDestroy()) {
 282                         return 0;
 283                 }
 284
 285 #ifdef __DEBUG__
 286                 m_storeDescriptions = theLogger.IsEnabled(logIPFilter);
 287 #endif
 288
 289                 const wxChar* ipfilter_files[] = {
 290                         wxT("ipfilter.dat"),
 291                         wxT("guardian.p2p"),
 292                         wxT("guarding.p2p"),
 293                         NULL
 294                 };
 295
 296                 // Try to unpack the file, might be an archive
 297
 298                 if (UnpackArchive(path, ipfilter_files).second != EFT_Text) {
 299                         AddLogLineC(CFormat(_("Failed to load ipfilter.dat file '%s', unknown format encountered.")) % file);
 300                         return 0;
 301                 }
 302
 303                 int filtercount = 0;
 304                 yyip_Bad = 0;
 305                 wxFFile readFile;
 306                 if (readFile.Open(path.GetRaw())) {
 307                         yyip_Line = 1;
 308                         yyiprestart(readFile.fp());
 309                         uint32 IPStart = 0;
 310                         uint32 IPEnd   = 0;
 311                         uint32 IPAccessLevel = 0;
 312                         char * IPDescription;
 313 #ifdef __DEBUG__
 314                         uint32 time1 = GetTickCountFullRes();
 315 #endif
 316                         while (yyiplex(IPStart, IPEnd, IPAccessLevel, IPDescription)) {
 317                                 AddIPRange(IPStart, IPEnd, IPAccessLevel, IPDescription);
 318                                 filtercount++;
 319                         }
 320 #ifdef __DEBUG__
 321                         uint32 time2 = GetTickCountFullRes();
 322                         AddDebugLogLineN(logIPFilter, CFormat(wxT("time for lexer: %.3f")) % ((time2-time1) / 1000.0));
 323 #endif
 324                 } else {
 325                         AddLogLineC(CFormat(_("Failed to load ipfilter.dat file '%s', could not open file.")) % file);
 326                         return 0;
 327                 }
 328
 329                 wxString msg = CFormat(wxPLURAL("Loaded %u IP-range from '%s'.", "Loaded %u IP-ranges from '%s'.", filtercount)) % filtercount % file;
 330                 if (yyip_Bad) {
 331                         msg << wxT(" ") << ( CFormat(wxPLURAL("%u malformed line was discarded.", "%u malformed lines were discarded.", yyip_Bad)) % yyip_Bad );
 332                 }
 333                 AddLogLineN(msg);
 334
 335                 return filtercount;
 336         }
 337 };
 338
 339
 340 ////////////////////////////////////////////////////////////
 341 // CIPFilter
 342
 343
 344 BEGIN_EVENT_TABLE(CIPFilter, wxEvtHandler)
 345         EVT_MULE_IPFILTER_LOADED(CIPFilter::OnIPFilterEvent)
 346 END_EVENT_TABLE()
 347
 348
 349
 350 /**
 351  * This function creates a text-file containing the specified text,
 352  * but only if the file does not already exist.
 353  */
 354 static bool CreateDummyFile(const wxString& filename, const wxString& text)
 355 {
 356         // Create template files
 357         if (!wxFileExists(filename)) {
 358                 CTextFile file;
 359
 360                 if (file.Open(filename, CTextFile::write)) {
 361                         file.WriteLine(text);
 362                         return true;
 363                 }
 364         }
 365         return false;
 366 }
 367
 368
 369 CIPFilter::CIPFilter() :
 370         m_ready(false),
 371         m_startKADWhenReady(false),
 372         m_connectToAnyServerWhenReady(false)
 373 {
 374         // Setup dummy files for the curious user.
 375         const wxString normalDat = thePrefs::GetConfigDir() + wxT("ipfilter.dat");
 376         const wxString normalMsg = wxString()
 377                 << wxT("# This file is used by aMule to store ipfilter lists downloaded\n")
 378                 << wxT("# through the auto-update functionality. Do not save ipfilter-\n")
 379                 << wxT("# ranges here that should not be overwritten by aMule.\n");
 380
 381         if (CreateDummyFile(normalDat, normalMsg)) {
 382                 // redownload if user deleted file
 383                 thePrefs::SetLastHTTPDownloadURL(HTTP_IPFilter, wxEmptyString);
 384         }
 385
 386         const wxString staticDat = thePrefs::GetConfigDir() + wxT("ipfilter_static.dat");
 387         const wxString staticMsg = wxString()
 388                 << wxT("# This file is used to store ipfilter-ranges that should\n")
 389                 << wxT("# not be overwritten by aMule. If you wish to keep a custom\n")
 390                 << wxT("# set of ipfilter-ranges that take precedence over ipfilter-\n")
 391                 << wxT("# ranges aquired through the auto-update functionality, then\n")
 392                 << wxT("# place them in this file. aMule will not change this file.");
 393
 394         CreateDummyFile(staticDat, staticMsg);
 395
 396         // First load currently available filter, so network connect is possible right after
 397         // (in case filter download takes some time).
 398         Reload();
 399         // Check if update should be done only after that.
 400         m_updateAfterLoading = thePrefs::IPFilterAutoLoad() && !thePrefs::IPFilterURL().IsEmpty();
 401 }
 402
 403
 404 void CIPFilter::Reload()
 405 {
 406         // We keep the current filter till the new one has been loaded.
 407         CThreadScheduler::AddTask(new CIPFilterTask(this));
 408 }
 409
 410
 411 uint32 CIPFilter::BanCount() const
 412 {
 413         wxMutexLocker lock(m_mutex);
 414
 415         return m_rangeIPs.size();
 416 }
 417
 418
 419 bool CIPFilter::IsFiltered(uint32 IPTest, bool isServer)
 420 {
 421         if ((!thePrefs::IsFilteringClients() && !isServer) || (!thePrefs::IsFilteringServers() && isServer)) {
 422                 return false;
 423         }
 424         if (!m_ready) {
 425                 // Somebody connected before we even started the networks.
 426                 // Filter is not up yet, so block him.
 427                 AddDebugLogLineN(logIPFilter, CFormat(wxT("Filtered IP %s because filter isn't ready yet.")) % Uint32toStringIP(IPTest));
 428                 if (isServer) {
 429                         theStats::AddFilteredServer();
 430                 } else {
 431                         theStats::AddFilteredClient();
 432                 }
 433                 return true;
 434         }
 435         wxMutexLocker lock(m_mutex);
 436         // The IP needs to be in host order
 437         uint32 ip = wxUINT32_SWAP_ALWAYS(IPTest);
 438         int imin = 0;
 439         int imax = m_rangeIPs.size() - 1;
 440         int i;
 441         bool found = false;
 442         while (imin <= imax) {
 443                 i = (imin + imax) / 2;
 444                 uint32 curIP = m_rangeIPs[i];
 445                 if (curIP <= ip) {
 446                         uint32 curLength = m_rangeLengths[i];
 447                         if (curLength >= 0x8000) {
 448                                 curLength = ((curLength & 0x7fff) << 12) + 0xfff;
 449                         }
 450                         if (curIP + curLength >= ip) {
 451                                 found = true;
 452                                 break;
 453                         }
 454                 }
 455                 if (curIP > ip) {
 456                         imax = i - 1;
 457                 } else {
 458                         imin = i + 1;
 459                 }
 460         }
 461         if (found) {
 462                 AddDebugLogLineN(logIPFilter, CFormat(wxT("Filtered IP %s%s")) % Uint32toStringIP(IPTest)
 463                         % (i < (int)m_rangeNames.size() ? (wxT(" (") + wxString(char2unicode(m_rangeNames[i].c_str())) + wxT(")"))
 464                                                                                         : wxString(wxEmptyString)));
 465                 if (isServer) {
 466                         theStats::AddFilteredServer();
 467                 } else {
 468                         theStats::AddFilteredClient();
 469                 }
 470                 return true;
 471         }
 472         return false;
 473 }
 474
 475
 476 void CIPFilter::Update(const wxString& strURL)
 477 {
 478         if (!strURL.IsEmpty()) {
 479                 m_URL = strURL;
 480
 481                 wxString filename = thePrefs::GetConfigDir() + wxT("ipfilter.download");
 482                 wxString oldfilename = thePrefs::GetConfigDir() + wxT("ipfilter.dat");
 483                 CHTTPDownloadThread *downloader = new CHTTPDownloadThread(m_URL, filename, oldfilename, HTTP_IPFilter, true, true);
 484
 485                 downloader->Create();
 486                 downloader->Run();
 487         }
 488 }
 489
 490
 491 void CIPFilter::DownloadFinished(uint32 result)
 492 {
 493         wxString datName = wxT("ipfilter.dat");
 494         if (result == HTTP_Success) {
 495                 // download succeeded. proceed with ipfilter loading
 496                 wxString newDat = thePrefs::GetConfigDir() + wxT("ipfilter.download");
 497                 wxString oldDat = thePrefs::GetConfigDir() + datName;
 498
 499                 if (wxFileExists(oldDat) && !wxRemoveFile(oldDat)) {
 500                         AddLogLineC(CFormat(_("Failed to remove %s file, aborting update.")) % datName);
 501                         result = HTTP_Error;
 502                 } else if (!wxRenameFile(newDat, oldDat)) {
 503                         AddLogLineC(CFormat(_("Failed to rename new %s file, aborting update.")) % datName);
 504                         result = HTTP_Error;
 505                 } else {
 506                         AddLogLineN(CFormat(_("Successfully updated %s")) % datName);
 507                 }
 508         // cppcheck-suppress duplicateBranch
 509         } else if (result == HTTP_Skipped) {
 510                 AddLogLineN(CFormat(_("Skipped download of %s, because requested file is not newer.")) % datName);
 511         } else {
 512                 AddLogLineC(CFormat(_("Failed to download %s from %s")) % datName % m_URL);
 513         }
 514
 515         if (result == HTTP_Success) {
 516                 // Reload both ipfilter files on success
 517                 Reload();
 518         }
 519 }
 520
 521
 522 void CIPFilter::OnIPFilterEvent(CIPFilterEvent& evt)
 523 {
 524         {
 525                 wxMutexLocker lock(m_mutex);
 526                 std::swap(m_rangeIPs, evt.m_rangeIPs);
 527                 std::swap(m_rangeLengths, evt.m_rangeLengths);
 528                 std::swap(m_rangeNames, evt.m_rangeNames);
 529                 m_ready = true;
 530         }
 531         if (theApp->IsOnShutDown()) {
 532                 return;
 533         }
 534         AddLogLineN(_("IP filter is ready"));
 535
 536         if (thePrefs::IsFilteringClients()) {
 537                 theApp->clientlist->FilterQueues();
 538         }
 539         if (thePrefs::IsFilteringServers()) {
 540                 theApp->serverlist->FilterServers();
 541         }
 542         // Now start networks we didn't start earlier
 543         if (m_connectToAnyServerWhenReady || m_startKADWhenReady) {
 544                 AddLogLineC(_("Connecting"));
 545         }
 546         if (m_connectToAnyServerWhenReady) {
 547                 m_connectToAnyServerWhenReady = false;
 548                 theApp->serverconnect->ConnectToAnyServer();
 549         }
 550         if (m_startKADWhenReady) {
 551                 m_startKADWhenReady = false;
 552                 theApp->StartKad();
 553         }
 554         theApp->ShowConnectionState(true);                      // update connect button
 555         if (thePrefs::GetSrcSeedsOn()) {
 556                 theApp->downloadqueue->LoadSourceSeeds();
 557         }
 558         // Trigger filter update if configured
 559         if (m_updateAfterLoading) {
 560                 m_updateAfterLoading = false;
 561                 Update(thePrefs::IPFilterURL());
 562         }
 563 }
 564
 565 // File_checked_for_headers