src/IP2Country.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2008 Marcelo Roberto Jimenez ( phoenix@amule.org )
   5 // Copyright (c) 2006-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   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 //
  28 // Country flags are from FAMFAMFAM (http://www.famfamfam.com)
  29 //
  30 // Flag icons - http://www.famfamfam.com
  31 //
  32 // These icons are public domain, and as such are free for any use (attribution appreciated but not required).
  33 //
  34 // Note that these flags are named using the ISO3166-1 alpha-2 country codes where appropriate.
  35 // A list of codes can be found at http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
  36 //
  37 // If you find these icons useful, please donate via paypal to mjames@gmail.com
  38 // (or click the donate button available at http://www.famfamfam.com/lab/icons/silk)
  39 //
  40 // Contact: mjames@gmail.com
  41 //
  42
  43 #include "IP2Country.h"
  44
  45 #include <GeoIP.h>
  46
  47 // MSVC projects can't include files configuration dependent, so just double-check the #define
  48 #ifdef ENABLE_IP2COUNTRY
  49
  50 #include "amule.h"                      // For theApp
  51 #include "Preferences.h"        // For thePrefs
  52 #include "CFile.h"                      // For CPath
  53 #include "HTTPDownload.h"
  54 #include "Logger.h"                     // For AddLogLineM()
  55 #include <common/Format.h>              // For CFormat()
  56 #include "common/FileFunctions.h"       // For UnpackArchive
  57 #include <common/StringFunctions.h>     // For unicode2char()
  58 #include "pixmaps/flags_xpm/CountryFlags.h"
  59
  60 #include <wx/intl.h>
  61 #include <wx/image.h>
  62
  63 CIP2Country::CIP2Country()
  64 {
  65         m_geoip = NULL;
  66         m_DataBaseName = theApp->ConfigDir + wxT("GeoIP.dat");
  67         if (m_CountryDataMap.empty()) {
  68 // this must go to enable - when all usages of GetCountryData() (ClientListCtrl, DownloadListCtrl) are surrounded with an IsEnabled()
  69 // right now, flags are loaded even when it's disabled
  70                 LoadFlags();
  71         }
  72 }
  73
  74 void CIP2Country::Enable()
  75 {
  76         Disable();
  77         if (!CPath::FileExists(m_DataBaseName)) {
  78                 Update();
  79                 return;
  80         }
  81
  82         m_geoip = GeoIP_open(unicode2char(m_DataBaseName), GEOIP_STANDARD);
  83 }
  84
  85 void CIP2Country::Update()
  86 {
  87         AddLogLineM(false,CFormat(_("Download new GeoIP.dat from %s")) % thePrefs::GetGeoIPUpdateUrl());
  88         CHTTPDownloadThread *downloader = new CHTTPDownloadThread(thePrefs::GetGeoIPUpdateUrl(), m_DataBaseName + wxT(".download"), HTTP_GeoIP);
  89         downloader->Create();
  90         downloader->Run();
  91 }
  92
  93 void CIP2Country::Disable()
  94 {
  95         if (m_geoip) {
  96                 GeoIP_delete(m_geoip);
  97                 m_geoip = NULL;
  98         }
  99 }
 100
 101 void CIP2Country::DownloadFinished(uint32 result)
 102 {
 103         if (result == 1) {
 104                 Disable();
 105                 // download succeeded. Switch over to new database.
 106                 wxString newDat = m_DataBaseName + wxT(".download");
 107
 108                 // Try to unpack the file, might be an archive
 109                 const wxChar* geoip_files[] = {
 110                         wxT("GeoIP.dat"),
 111                         NULL
 112                 };
 113
 114                 if (UnpackArchive(CPath(newDat), geoip_files).second == EFT_Error) {
 115                         AddLogLineM(false, _("Download of GeoIP.dat file failed, aborting update."));
 116                         return;
 117                 }
 118
 119                 if (wxFileExists(m_DataBaseName)) {
 120                         if (!wxRemoveFile(m_DataBaseName)) {
 121                                 AddLogLineM(false, _("Failed to remove GeoIP.dat file, aborting update."));
 122                                 return;
 123                         }
 124                 }
 125
 126                 if (!wxRenameFile(newDat, m_DataBaseName)) {
 127                         AddLogLineM(false,      _("Failed to rename new GeoIP.dat file, aborting update."));
 128                         return;
 129                 }
 130
 131                 Enable();
 132                 if (m_geoip) {
 133                   AddLogLineM(false, _("Successfully updated GeoIP.dat"));
 134                 } else {
 135                   AddLogLineM(false, _("Error updating GeoIP.dat"));
 136                 }
 137         } else {
 138                 AddLogLineM(false, CFormat(_("Failed to download GeoIP.dat from %s")) % thePrefs::GetGeoIPUpdateUrl());
 139                 // if it failed and there is no database, turn it off
 140                 if (!wxFileExists(m_DataBaseName)) {
 141                         thePrefs::SetGeoIPEnabled(false);
 142                 }
 143         }
 144 }
 145
 146 void CIP2Country::LoadFlags()
 147 {
 148         // Load data from xpm files
 149         for (int i = 0; i < flags::FLAGS_XPM_SIZE; ++i) {
 150                 CountryData countrydata;
 151                 countrydata.Name = char2unicode(flags::flagXPMCodeVector[i].code);
 152                 countrydata.Flag = wxImage(flags::flagXPMCodeVector[i].xpm);
 153
 154                 if (countrydata.Flag.IsOk()) {
 155                         m_CountryDataMap[countrydata.Name] = countrydata;
 156                 } else {
 157                         AddLogLineM(true, _("CIP2Country::CIP2Country(): Failed to load country data from ") + countrydata.Name);
 158                         continue;
 159                 }
 160         }
 161
 162         AddLogLineM(false, CFormat(_("Loaded %d flag bitmaps.")) % m_CountryDataMap.size());  // there's never just one - no plural needed
 163 }
 164
 165
 166 CIP2Country::~CIP2Country()
 167 {
 168         Disable();
 169 }
 170
 171
 172 const CountryData& CIP2Country::GetCountryData(const wxString &ip)
 173 {
 174         // Should prevent the crash if the GeoIP database does not exists
 175         if (m_geoip == NULL) {
 176                 CountryDataMap::iterator it = m_CountryDataMap.find(wxString(wxT("unknown")));
 177                 it->second.Name = wxT("?");
 178                 return it->second;
 179         }
 180
 181         const wxString CCode = wxString(char2unicode(GeoIP_country_code_by_addr(m_geoip, unicode2char(ip)))).MakeLower();
 182
 183         CountryDataMap::iterator it = m_CountryDataMap.find(CCode);
 184         if (it == m_CountryDataMap.end()) {
 185                 // Show the code and ?? flag
 186                 it = m_CountryDataMap.find(wxString(wxT("unknown")));
 187                 wxASSERT(it != m_CountryDataMap.end());
 188                 if (CCode.IsEmpty()) {
 189                         it->second.Name = wxT("?");
 190                 } else{
 191                         it->second.Name = CCode;
 192                 }
 193         }
 194
 195         return it->second;
 196 }
 197
 198 #endif // ENABLE_IP2COUNTRY