src/IPFilter.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 #include <wx/stdpaths.h>                // Needed for GetDataDir
  27
  28 #include "IPFilter.h"                   // Interface declarations.
  29 #include "Preferences.h"                // Needed for thePrefs
  30 #include "amule.h"                      // Needed for theApp
  31 #include "Statistics.h"                 // Needed for theStats
  32 #include "HTTPDownload.h"               // Needed for CHTTPDownloadThread
  33 #include "Logger.h"                     // Needed for AddDebugLogLineM
  34 #include <common/Format.h>              // Needed for CFormat
  35 #include <common/StringFunctions.h>     // Needed for CSimpleTokenizer
  36 #include <common/FileFunctions.h>       // Needed for UnpackArchive
  37 #include <common/TextFile.h>            // Needed for CTextFile
  38 #include "ThreadScheduler.h"            // Needed for CThreadScheduler and CThreadTask
  39 #include "ClientList.h"                 // Needed for CClientList
  40 #include "ServerList.h"                 // Needed for CServerList
  41
  42
  43 ////////////////////////////////////////////////////////////
  44 // CIPFilterEvent
  45
  46 BEGIN_DECLARE_EVENT_TYPES()
  47         DECLARE_EVENT_TYPE(MULE_EVT_IPFILTER_LOADED, -1)
  48 END_DECLARE_EVENT_TYPES()
  49
  50 DEFINE_EVENT_TYPE(MULE_EVT_IPFILTER_LOADED)
  51
  52
  53 class CIPFilterEvent : public wxEvent
  54 {
  55 public:
  56         CIPFilterEvent(CIPFilter::IPMap& result)
  57                 : wxEvent(-1, MULE_EVT_IPFILTER_LOADED)
  58         {
  59                 // Avoid needles copying
  60                 std::swap(result, m_result);
  61         }
  62
  63         /** @see wxEvent::Clone */
  64         virtual wxEvent* Clone() const {
  65                 return new CIPFilterEvent(*this);
  66         }
  67
  68         CIPFilter::IPMap m_result;
  69 };
  70
  71
  72 typedef void (wxEvtHandler::*MuleIPFilterEventFunction)(CIPFilterEvent&);
  73
  74 //! Event-handler for completed hashings of new shared files and partfiles.
  75 #define EVT_MULE_IPFILTER_LOADED(func) \
  76         DECLARE_EVENT_TABLE_ENTRY(MULE_EVT_IPFILTER_LOADED, -1, -1, \
  77         (wxObjectEventFunction) (wxEventFunction) \
  78         wxStaticCastEvent(MuleIPFilterEventFunction, &func), (wxObject*) NULL),
  79
  80
  81 ////////////////////////////////////////////////////////////
  82 // Thread task for loading the ipfilter.dat files.
  83
  84 /**
  85  * This task loads the two ipfilter.dat files, a task that
  86  * can take quite a while on a slow system with a large dat-
  87  * file.
  88  */
  89 class CIPFilterTask : public CThreadTask
  90 {
  91 public:
  92         CIPFilterTask(wxEvtHandler* owner)
  93                 : CThreadTask(wxT("Load IPFilter"), wxEmptyString, ETP_Critical),
  94                   m_storeDescriptions(false),
  95                   m_owner(owner)
  96         {
  97         }
  98
  99         void Entry() {
 100                 wxStandardPathsBase &spb(wxStandardPaths::Get());
 101 #ifdef __WXMSW__
 102                 wxString dataDir(spb.GetPluginsDir());
 103 #elif defined(__WXMAC__)
 104                 wxString dataDir(spb.GetDataDir());
 105 #else
 106                 wxString dataDir(spb.GetDataDir().BeforeLast(wxT('/')) + wxT("/amule"));
 107 #endif
 108                 wxString systemwideFile(JoinPaths(dataDir,wxT("ipfilter.dat")));
 109
 110                 AddLogLineM(false, _("Loading IP-filters 'ipfilter.dat' and 'ipfilter_static.dat'."));
 111                 if ( !LoadFromFile(theApp->ConfigDir + wxT("ipfilter.dat")) &&
 112                      thePrefs::UseIPFilterSystem() ) {
 113                         LoadFromFile(systemwideFile);
 114                 }
 115
 116
 117                 LoadFromFile(theApp->ConfigDir + wxT("ipfilter_static.dat"));
 118
 119                 CIPFilterEvent evt(m_result);
 120                 wxPostEvent(m_owner, evt);
 121         }
 122 private:
 123
 124         bool m_storeDescriptions;
 125
 126         /**
 127          * Helper function.
 128          *
 129          * @param IPstart The start of the IP-range.
 130          * @param IPend The end of the IP-range, must be less than or equal to IPstart.
 131          * @param AccessLevel The AccessLevel of this range.
 132          * @param Description The assosiated description of this range.
 133          * @return true if the range was added, false if it was discarded.
 134          *
 135          * This function inserts the specified range into the IPMap. Invalid
 136          * ranges where the AccessLevel is not within the range 0..255, or
 137          * where IPEnd < IPstart not inserted.
 138          */
 139         bool AddIPRange(uint32 IPStart, uint32 IPEnd, uint16 AccessLevel, const wxString& Description)
 140         {
 141                 if (AccessLevel < 256) {
 142                         if (IPStart <= IPEnd) {
 143                                 CIPFilter::rangeObject item;
 144                                 item.AccessLevel = AccessLevel;
 145 #ifdef __DEBUG__
 146                                 if (m_storeDescriptions) {
 147                                         item.Description = Description;
 148                                 }
 149 #endif
 150
 151                                 m_result.insert(IPStart, IPEnd, item);
 152
 153                                 return true;
 154                         }
 155                 }
 156
 157                 return false;
 158         }
 159
 160
 161         /**
 162          * Helper function.
 163          *
 164          * @param str A string representation of an IP-range in the format "<ip>-<ip>".
 165          * @param ipA The target of the first IP in the range.
 166          * @param ipB The target of the second IP in the range.
 167          * @return True if the parsing succeded, false otherwise (results will be invalid).
 168          *
 169          * The IPs returned by this function are in host order, not network order.
 170          */
 171         bool m_inet_atoh(const wxString &str, uint32& ipA, uint32& ipB)
 172         {
 173                 wxString first = str.BeforeFirst(wxT('-'));
 174                 wxString second = str.Mid(first.Len() + 1);
 175
 176                 bool result = StringIPtoUint32(first, ipA) && StringIPtoUint32(second, ipB);
 177
 178                 // StringIPtoUint32 saves the ip in anti-host order, but in order
 179                 // to be able to make relational comparisons, we need to convert
 180                 // it back to host-order.
 181                 ipA = wxUINT32_SWAP_ALWAYS(ipA);
 182                 ipB = wxUINT32_SWAP_ALWAYS(ipB);
 183
 184                 return result;
 185         }
 186
 187
 188         /**
 189          * Helper-function for processing the PeerGuardian format.
 190          *
 191          * @return True if the line was valid, false otherwise.
 192          *
 193          * This function will correctly parse files that follow the folllowing
 194          * format for specifying IP-ranges (whitespace is optional):
 195          *  <IPStart> - <IPEnd> , <AccessLevel> , <Description>
 196          */
 197         bool ProcessPeerGuardianLine(const wxString& sLine)
 198         {
 199                 CSimpleTokenizer tkz(sLine, wxT(','));
 200
 201                 wxString first  = tkz.next();
 202                 wxString second = tkz.next();
 203                 wxString third  = tkz.remaining().Strip(wxString::both);
 204
 205                 // If there were less than two tokens, fail
 206                 if (tkz.tokenCount() != 2) {
 207                         return false;
 208                 }
 209
 210                 // Convert string IP's to host order IP numbers
 211                 uint32 IPStart = 0;
 212                 uint32 IPEnd   = 0;
 213
 214                 // This will also fail if the line is commented out
 215                 if (!m_inet_atoh(first, IPStart, IPEnd)) {
 216                         return false;
 217                 }
 218
 219                 // Second token is Access Level, default is 0.
 220                 unsigned long AccessLevel = 0;
 221                 if (!second.Strip(wxString::both).ToULong(&AccessLevel) || AccessLevel >= 255) {
 222                         return false;
 223                 }
 224
 225                 // Add the filter
 226                 return AddIPRange(IPStart, IPEnd, AccessLevel, third);
 227         }
 228
 229
 230         /**
 231          * Helper-function for processing the AntiP2P format.
 232          *
 233          * @return True if the line was valid, false otherwise.
 234          *
 235          * This function will correctly parse files that follow the folllowing
 236          * format for specifying IP-ranges (whitespace is optional):
 237          *  <Description> : <IPStart> - <IPEnd>
 238          */
 239         bool ProcessAntiP2PLine(const wxString& sLine)
 240         {
 241                 // remove spaces from the left and right.
 242                 const wxString line = sLine.Strip(wxString::leading);
 243
 244                 // Extract description (first) and IP-range (second) form the line
 245                 int pos = line.Find(wxT(':'), true);
 246                 if (pos == -1) {
 247                         return false;
 248                 }
 249
 250                 wxString Description = line.Left(pos).Strip(wxString::trailing);
 251                 wxString IPRange     = line.Right(line.Len() - pos - 1);
 252
 253                 // Convert string IP's to host order IP numbers
 254                 uint32 IPStart = 0;
 255                 uint32 IPEnd   = 0;
 256
 257                 if (!m_inet_atoh(IPRange ,IPStart, IPEnd)) {
 258                         return false;
 259                 }
 260
 261                 // Add the filter
 262                 return AddIPRange(IPStart, IPEnd, 0, Description);
 263         }
 264
 265
 266         /**
 267          * Loads a IP-list from the specified file, can be text or zip.
 268          *
 269          * @return True if the file was loaded, false otherwise.
 270          **/
 271         int LoadFromFile(const wxString& file)
 272         {
 273                 const CPath path = CPath(file);
 274
 275                 if (!path.FileExists() /* || TestDestroy() (see CIPFilter::Reload()) */) {
 276                         return 0;
 277                 }
 278
 279 #ifdef __DEBUG__
 280                 m_storeDescriptions = theLogger.IsEnabled(logIPFilter);
 281 #endif
 282
 283                 const wxChar* ipfilter_files[] = {
 284                         wxT("ipfilter.dat"),
 285                         wxT("guardian.p2p"),
 286                         wxT("guarding.p2p"),
 287                         NULL
 288                 };
 289
 290                 // Try to unpack the file, might be an archive
 291
 292                 if (UnpackArchive(path, ipfilter_files).second != EFT_Text) {
 293                         AddLogLineM(true,
 294                                 CFormat(_("Failed to load ipfilter.dat file '%s', unknown format encountered.")) % file);
 295                         return 0;
 296                 }
 297
 298                 int filtercount = 0;
 299                 int discardedCount = 0;
 300
 301                 CTextFile readFile;
 302                 if (readFile.Open(path, CTextFile::read)) {
 303                         // Function pointer-type of the parse-functions we can use
 304                         typedef bool (CIPFilterTask::*ParseFunc)(const wxString&);
 305
 306                         ParseFunc func = NULL;
 307
 308                         while (!readFile.Eof()) {
 309                                 wxString line = readFile.GetNextLine();
 310
 311                                 /* See CIPFilter::Reload()
 312                                   if (TestDestroy()) {
 313                                         return 0;
 314                                 } else */ if (func && (*this.*func)(line)) {
 315                                         filtercount++;
 316                                 } else if (ProcessPeerGuardianLine(line)) {
 317                                         func = &CIPFilterTask::ProcessPeerGuardianLine;
 318                                         filtercount++;
 319                                 } else if (ProcessAntiP2PLine(line)) {
 320                                         func = &CIPFilterTask::ProcessAntiP2PLine;
 321                                         filtercount++;
 322                                 } else {
 323                                         // Comments and empty lines are ignored
 324                                         line = line.Strip(wxString::both);
 325
 326                                         if (!line.IsEmpty() && !line.StartsWith(wxT("#"))) {
 327                                                 discardedCount++;
 328                                                 AddDebugLogLineM(false, logIPFilter, wxT(
 329                                                         "Invalid line found while reading ipfilter file: ") + line);
 330                                         }
 331                                 }
 332                         }
 333                 } else {
 334                         AddLogLineM(true, CFormat(_(
 335                                 "Failed to load ipfilter.dat file '%s', could not open file.")) % file);
 336                         return 0;
 337                 }
 338
 339                 AddLogLineM(false,
 340                         ( CFormat(wxPLURAL("Loaded %u IP-range from '%s'.", "Loaded %u IP-ranges from '%s'.", filtercount)) % filtercount % file )
 341                         + wxT(" ") +
 342                         ( CFormat(wxPLURAL("%u malformed line was discarded.", "%u malformed lines were discarded.", discardedCount)) % discardedCount )
 343                 );
 344
 345                 return filtercount;
 346         }
 347
 348 private:
 349         wxEvtHandler*           m_owner;
 350         CIPFilter::IPMap        m_result;
 351 };
 352
 353
 354 ////////////////////////////////////////////////////////////
 355 // CIPFilter
 356
 357
 358 BEGIN_EVENT_TABLE(CIPFilter, wxEvtHandler)
 359         EVT_MULE_IPFILTER_LOADED(CIPFilter::OnIPFilterEvent)
 360 END_EVENT_TABLE()
 361
 362
 363
 364 /**
 365  * This function creates a text-file containing the specified text,
 366  * but only if the file does not already exist.
 367  */
 368 void CreateDummyFile(const wxString& filename, const wxString& text)
 369 {
 370         // Create template files
 371         if (!wxFileExists(filename)) {
 372                 CTextFile file;
 373
 374                 if (file.Open(filename, CTextFile::write)) {
 375                         file.WriteLine(text);
 376                 }
 377         }
 378 }
 379
 380
 381 CIPFilter::CIPFilter()
 382 {
 383         // Setup dummy files for the curious user.
 384         const wxString normalDat = theApp->ConfigDir + wxT("ipfilter.dat");
 385         const wxString normalMsg = wxString()
 386                 << wxT("# This file is used by aMule to store ipfilter lists downloaded\n")
 387                 << wxT("# through the auto-update functionality. Do not save ipfilter-\n")
 388                 << wxT("# ranges here that should not be overwritten by aMule.\n");
 389
 390         CreateDummyFile(normalDat, normalMsg);
 391
 392         const wxString staticDat = theApp->ConfigDir + wxT("ipfilter_static.dat");
 393         const wxString staticMsg = wxString()
 394                 << wxT("# This file is used to store ipfilter-ranges that should\n")
 395                 << wxT("# not be overwritten by aMule. If you wish to keep a custom\n")
 396                 << wxT("# set of ipfilter-ranges that take precedence over ipfilter-\n")
 397                 << wxT("# ranges aquired through the auto-update functionality, then\n")
 398                 << wxT("# place them in this file. aMule will not change this file.");
 399
 400         CreateDummyFile(staticDat, staticMsg);
 401
 402         Reload();
 403 }
 404
 405
 406 void CIPFilter::Reload()
 407 {
 408         // We keep the current filter till the new one has been loaded.
 409         //CThreadScheduler::AddTask(new CIPFilterTask(this));
 410
 411         // This procedure cannot be run as a task,
 412         // wxArchiveFSHandler::FindFirst() will eventually call wxExecute(),
 413         // and this can only be done from the main task.
 414         //
 415         // This way, We call the Entry() routine manually and comment out the
 416         // calls to TestDestroy().
 417         CIPFilterTask ipf_task(this);
 418         ipf_task.Entry();
 419 }
 420
 421
 422 uint32 CIPFilter::BanCount() const
 423 {
 424         wxMutexLocker lock(m_mutex);
 425
 426         return m_iplist.size();
 427 }
 428
 429
 430 bool CIPFilter::IsFiltered(uint32 IPTest, bool isServer)
 431 {
 432         if ((thePrefs::IsFilteringClients() && !isServer) || (thePrefs::IsFilteringServers() && isServer)) {
 433                 wxMutexLocker lock(m_mutex);
 434
 435                 // The IP needs to be in host order
 436                 IPMap::iterator it = m_iplist.find_range(wxUINT32_SWAP_ALWAYS(IPTest));
 437
 438                 if (it != m_iplist.end()) {
 439                         if (it->AccessLevel < thePrefs::GetIPFilterLevel()) {
 440 #ifdef __DEBUG__
 441                                 AddDebugLogLineM(false, logIPFilter, wxString(wxT("Filtered IP (AccLvl: ")) << (long)it->AccessLevel << wxT("): ")
 442                                                 << Uint32toStringIP(IPTest) << wxT(" (") << it->Description + wxT(")"));
 443 #endif
 444
 445                                 if (isServer) {
 446                                         theStats::AddFilteredServer();
 447                                 } else {
 448                                         theStats::AddFilteredClient();
 449                                 }
 450                                 return true;
 451                         }
 452                 }
 453         }
 454
 455         return false;
 456 }
 457
 458
 459 void CIPFilter::Update(const wxString& strURL)
 460 {
 461         if (!strURL.IsEmpty()) {
 462                 wxString filename = theApp->ConfigDir + wxT("ipfilter.download");
 463                 CHTTPDownloadThread *downloader = new CHTTPDownloadThread(strURL, filename, HTTP_IPFilter);
 464
 465                 downloader->Create();
 466                 downloader->Run();
 467         }
 468 }
 469
 470
 471 void CIPFilter::DownloadFinished(uint32 result)
 472 {
 473         if (result == 1) {
 474                 // download succeeded. proceed with ipfilter loading
 475                 wxString newDat = theApp->ConfigDir + wxT("ipfilter.download");
 476                 wxString oldDat = theApp->ConfigDir + wxT("ipfilter.dat");
 477
 478                 if (wxFileExists(oldDat)) {
 479                         if (!wxRemoveFile(oldDat)) {
 480                                 AddDebugLogLineM(true, logIPFilter,
 481                                         wxT("Failed to remove ipfilter.dat file, aborting update."));
 482                                 return;
 483                         }
 484                 }
 485
 486                 if (!wxRenameFile(newDat, oldDat)) {
 487                         AddDebugLogLineM(true, logIPFilter,
 488                                 wxT("Failed to rename new ipfilter.dat file, aborting update."));
 489                         return;
 490                 }
 491
 492                 // Reload both ipfilter files
 493                 Reload();
 494         } else {
 495                 AddDebugLogLineM(true, logIPFilter,
 496                         wxT("Failed to download the ipfilter from ") + thePrefs::IPFilterURL());
 497         }
 498 }
 499
 500
 501 void CIPFilter::OnIPFilterEvent(CIPFilterEvent& evt)
 502 {
 503         {
 504                 wxMutexLocker lock(m_mutex);
 505                 std::swap(m_iplist, evt.m_result);
 506         }
 507
 508         if (thePrefs::IsFilteringClients()) {
 509                 theApp->clientlist->FilterQueues();
 510         }
 511         if (thePrefs::IsFilteringServers()) {
 512                 theApp->serverlist->FilterServers();
 513         }
 514 }
 515
 516 // File_checked_for_headers