src/IP2Country.cpp

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