Source code for linkcheck.plugins.locationinfo

# Copyright (C) 2000-2014 Bastian Kleineidam
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Store and retrieve country names for IPs.
from . import _ConnectionPlugin
import os
import sys
import socket
from ..lock import get_lock
from ..decorators import synchronized
from .. import log, LOG_PLUGIN

[docs]class LocationInfo(_ConnectionPlugin): """Adds the country and if possible city name of the URL host as info. Needs GeoIP or pygeoip and a local country or city lookup DB installed.""" def __init__(self, config): """Check for geoip module.""" if not geoip: log.warn(LOG_PLUGIN, "GeoIP or pygeoip not found for LocationInfo plugin.") super().__init__(config)
[docs] def applies_to(self, url_data): """Check for validity, host existence and geoip module.""" return url_data.valid and and geoip
[docs] def check(self, url_data): """Try to ask GeoIP database for country info.""" location = get_location( if location: url_data.add_info( _("URL is located in %(location)s.") % {"location": _(location)} )
# It is unknown if the geoip library is already thread-safe, so # no risks should be taken here by using a lock. _lock = get_lock("geoip")
[docs]def get_geoip_dat(): """Find a GeoIP database, preferring city over country lookup.""" datafiles = ("GeoIPCity.dat", "GeoIP.dat") if == 'nt': paths = (sys.exec_prefix, r"c:\geoip") else: paths = ("/usr/local/share/GeoIP", "/usr/share/GeoIP") for path in paths: for datafile in datafiles: filename = os.path.join(path, datafile) if os.path.isfile(filename): return filename
# try importing both the C-library GeoIP and the pure-python pygeoip geoip_dat = get_geoip_dat() geoip = None if geoip_dat: try: import GeoIP geoip =, GeoIP.GEOIP_STANDARD) geoip_error = GeoIP.error except ImportError: try: import pygeoip geoip = pygeoip.GeoIP(geoip_dat) geoip_error = pygeoip.GeoIPError except ImportError: pass if geoip_dat.endswith('GeoIPCity.dat'): def get_geoip_record(host): return geoip.record_by_name(host) else: def get_geoip_record(host): return { 'country_name': geoip.country_name_by_name(host), }
[docs]@synchronized(_lock) def get_location(host): """Get translated country and optional city name. @return: country with optional city or an boolean False if not found """ if geoip is None: # no geoip available return None try: record = get_geoip_record(host) except (geoip_error, socket.error): log.debug(LOG_PLUGIN, "Geoip error for %r", host, exception=True) # ignore lookup errors return None value = "" if record and record.get("city"): value += record["city"] if record and record.get("country_name"): if value: value += ", " value += record["country_name"] return value