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 #ifdef HAVE_CONFIG_H
  44 #       include "config.h"              // Needed for ENABLE_IP2COUNTRY
  45 #endif
  46
  47 #ifdef ENABLE_IP2COUNTRY
  48
  49 #include "Preferences.h"        // For thePrefs
  50 #include "CFile.h"                      // For CPath
  51 #include "HTTPDownload.h"
  52 #include "Logger.h"                     // For AddLogLineM()
  53 #include <common/Format.h>              // For CFormat()
  54 #include "common/FileFunctions.h"       // For UnpackArchive
  55 #include <common/StringFunctions.h>     // For unicode2char()
  56 #include "pixmaps/flags_xpm/CountryFlags.h"
  57
  58 #include <wx/intl.h>
  59 #include <wx/image.h>
  60
  61 #ifdef _MSC_VER
  62 // Block unnecessary includes from GeoIP.h
  63 #define _WINDOWS_
  64 #define _WINSOCK2API_
  65 #define _WS2TCPIP_H_
  66 #endif
  67
  68 #include <GeoIP.h>
  69 #include "IP2Country.h"
  70
  71 CIP2Country::CIP2Country(const wxString& configDir)
  72 {
  73         m_geoip = NULL;
  74         m_DataBaseName = configDir + wxT("GeoIP.dat");
  75         if (m_CountryDataMap.empty()) {
  76 // this must go to enable - when all usages of GetCountryData() (ClientListCtrl, DownloadListCtrl) are surrounded with an IsEnabled()
  77 // right now, flags are loaded even when it's disabled
  78                 LoadFlags();
  79         }
  80 }
  81
  82 void CIP2Country::Enable()
  83 {
  84         Disable();
  85         if (!CPath::FileExists(m_DataBaseName)) {
  86                 Update();
  87                 return;
  88         }
  89
  90         m_geoip = GeoIP_open(unicode2char(m_DataBaseName), GEOIP_STANDARD);
  91 }
  92
  93 void CIP2Country::Update()
  94 {
  95         AddLogLineM(false,CFormat(_("Download new GeoIP.dat from %s")) % thePrefs::GetGeoIPUpdateUrl());
  96         CHTTPDownloadThread *downloader = new CHTTPDownloadThread(thePrefs::GetGeoIPUpdateUrl(), m_DataBaseName + wxT(".download"), m_DataBaseName, HTTP_GeoIP);
  97         downloader->Create();
  98         downloader->Run();
  99 }
 100
 101 void CIP2Country::Disable()
 102 {
 103         if (m_geoip) {
 104                 GeoIP_delete(m_geoip);
 105                 m_geoip = NULL;
 106         }
 107 }
 108
 109 void CIP2Country::DownloadFinished(uint32 result)
 110 {
 111         if (result == HTTP_Success) {
 112                 Disable();
 113                 // download succeeded. Switch over to new database.
 114                 wxString newDat = m_DataBaseName + wxT(".download");
 115
 116                 // Try to unpack the file, might be an archive
 117                 const wxChar* geoip_files[] = {
 118                         wxT("GeoIP.dat"),
 119                         NULL
 120                 };
 121
 122                 if (UnpackArchive(CPath(newDat), geoip_files).second == EFT_Error) {
 123                         AddLogLineC(_("Download of GeoIP.dat file failed, aborting update."));
 124                         return;
 125                 }
 126
 127                 if (wxFileExists(m_DataBaseName)) {
 128                         if (!wxRemoveFile(m_DataBaseName)) {
 129                                 AddLogLineC(CFormat(_("Failed to remove %s file, aborting update.")) % wxT("GeoIP.dat"));
 130                                 return;
 131                         }
 132                 }
 133
 134                 if (!wxRenameFile(newDat, m_DataBaseName)) {
 135                         AddLogLineC(CFormat(_("Failed to rename %s file, aborting update.")) % wxT("GeoIP.dat"));
 136                         return;
 137                 }
 138
 139                 Enable();
 140                 if (m_geoip) {
 141                         AddLogLineN(CFormat(_("Successfully updated %s")) % wxT("GeoIP.dat"));
 142                 } else {
 143                         AddLogLineC(_("Error updating GeoIP.dat"));
 144                 }
 145         } else if (result == HTTP_Skipped) {
 146                 AddLogLineN(CFormat(_("Skipped download of %s, because requested file is not newer.")) % wxT("GeoIP.dat"));
 147         } else {
 148                 AddLogLineC(CFormat(_("Failed to download %s from %s")) % wxT("GeoIP.dat") % thePrefs::GetGeoIPUpdateUrl());
 149                 // if it failed and there is no database, turn it off
 150                 if (!wxFileExists(m_DataBaseName)) {
 151                         thePrefs::SetGeoIPEnabled(false);
 152                 }
 153         }
 154 }
 155
 156 void CIP2Country::LoadFlags()
 157 {
 158         // Load data from xpm files
 159         for (int i = 0; i < flags::FLAGS_XPM_SIZE; ++i) {
 160                 CountryData countrydata;
 161                 countrydata.Name = char2unicode(flags::flagXPMCodeVector[i].code);
 162                 countrydata.Flag = wxImage(flags::flagXPMCodeVector[i].xpm);
 163
 164                 if (countrydata.Flag.IsOk()) {
 165                         m_CountryDataMap[countrydata.Name] = countrydata;
 166                 } else {
 167                         AddLogLineM(true, CFormat(_("Failed to load country data for '%s'.")) % countrydata.Name);
 168                         continue;
 169                 }
 170         }
 171
 172         AddDebugLogLineN(logGeneral, CFormat(wxT("Loaded %d flag bitmaps.")) % m_CountryDataMap.size());  // there's never just one - no plural needed
 173 }
 174
 175
 176 CIP2Country::~CIP2Country()
 177 {
 178         Disable();
 179 }
 180
 181
 182 const CountryData& CIP2Country::GetCountryData(const wxString &ip)
 183 {
 184         // Should prevent the crash if the GeoIP database does not exists
 185         if (m_geoip == NULL) {
 186                 CountryDataMap::iterator it = m_CountryDataMap.find(wxString(wxT("unknown")));
 187                 it->second.Name = wxT("?");
 188                 return it->second;
 189         }
 190
 191         const wxString CCode = wxString(char2unicode(GeoIP_country_code_by_addr(m_geoip, unicode2char(ip)))).MakeLower();
 192
 193         CountryDataMap::iterator it = m_CountryDataMap.find(CCode);
 194         if (it == m_CountryDataMap.end()) {
 195                 // Show the code and ?? flag
 196                 it = m_CountryDataMap.find(wxString(wxT("unknown")));
 197                 wxASSERT(it != m_CountryDataMap.end());
 198                 if (CCode.IsEmpty()) {
 199                         it->second.Name = wxT("?");
 200                 } else{
 201                         it->second.Name = CCode;
 202                 }
 203         }
 204
 205         return it->second;
 206 }
 207
 208 #endif // ENABLE_IP2COUNTRY