From 0752ff8f834597cbec891bbb9e91882581fa4530 Mon Sep 17 00:00:00 2001 From: James Gerity Date: Sat, 14 Oct 2023 17:42:24 -0400 Subject: [PATCH] ip: remove ip plugin in favor of external package --- sopel/modules/ip.py | 196 -------------------------------------------- 1 file changed, 196 deletions(-) delete mode 100644 sopel/modules/ip.py diff --git a/sopel/modules/ip.py b/sopel/modules/ip.py deleted file mode 100644 index 4512dcd5e..000000000 --- a/sopel/modules/ip.py +++ /dev/null @@ -1,196 +0,0 @@ -""" -ip.py - Sopel GeoIP Lookup Plugin -Copyright 2011, Dimitri Molenaars, TyRope.nl, -Copyright © 2013, Elad Alfassa -Licensed under the Eiffel Forum License 2. - -https://sopel.chat -""" - -from __future__ import annotations - -import logging -import os -import socket -import tarfile -from urllib.request import urlretrieve - -import geoip2.database - -from sopel import plugin -from sopel.config import types -from sopel.tools import web - - -LOGGER = logging.getLogger(__name__) - - -class GeoipSection(types.StaticSection): - GeoIP_db_path = types.FilenameAttribute('GeoIP_db_path', directory=True) - """Path of the directory containing the GeoIP database files. - - If the given value is not an absolute path, it will be interpreted relative - to the directory containing the config file with which Sopel was started. - """ - - -def configure(config): - """ - | name | example | purpose | - | ---- | ------- | ------- | - | GeoIP\\_db\\_path | /home/sopel/GeoIP/ | Path to the GeoIP database files | - """ - config.define_section('ip', GeoipSection) - config.ip.configure_setting('GeoIP_db_path', - 'Path of the GeoIP db files') - - -def setup(bot): - bot.config.define_section('ip', GeoipSection) - - -def _decompress(source, target, delete_after_decompression=True): - """Decompress just the database from the archive""" - # https://stackoverflow.com/a/16452962 - tar = tarfile.open(source) - for member in tar.getmembers(): - if ".mmdb" in member.name: - member.name = os.path.basename(member.name) - tar.extract(member, target) - if delete_after_decompression: - os.remove(source) - - -def _find_geoip_db(bot): - """Find the GeoIP database""" - config = bot.config - if config.ip.GeoIP_db_path: - cities_db = os.path.join(config.ip.GeoIP_db_path, 'GeoLite2-City.mmdb') - ipasnum_db = os.path.join(config.ip.GeoIP_db_path, 'GeoLite2-ASN.mmdb') - if (os.path.isfile(cities_db) and os.path.isfile(ipasnum_db)): - return config.ip.GeoIP_db_path - else: - LOGGER.warning( - 'GeoIP path configured but DB not found in configured path') - - if (os.path.isfile(os.path.join(config.core.homedir, 'GeoLite2-City.mmdb')) and - os.path.isfile(os.path.join(config.core.homedir, 'GeoLite2-ASN.mmdb'))): - return config.core.homedir - elif (os.path.isfile(os.path.join('/usr/share/GeoIP', 'GeoLite2-City.mmdb')) and - os.path.isfile(os.path.join('/usr/share/GeoIP', 'GeoLite2-ASN.mmdb'))): - return '/usr/share/GeoIP' - - LOGGER.info('Downloading GeoIP database') - bot.say('Downloading GeoIP database, please wait...') - - common_params = {'license_key': 'JXBEmLjOzislFnh4', 'suffix': 'tar.gz'} - base_url = 'https://download.maxmind.com/app/geoip_download' - geolite_urls = [] - - for edition in ['ASN', 'City']: - geolite_urls.append( - '{base}?{params}'.format( - base=base_url, - params=web.urlencode(dict(common_params, **{'edition_id': 'GeoLite2-%s' % edition})), - ) - ) - - for url in geolite_urls: - LOGGER.debug('GeoIP Source URL: %s', url) - full_path = os.path.join(config.core.homedir, url.split("/")[-1]) - urlretrieve(url, full_path) - _decompress(full_path, config.core.homedir) - - return config.core.homedir - - -@plugin.command('iplookup', 'ip') -@plugin.example( - '.ip 8.8.8.8', - r'Hostname: \S*dns\S*\.google\S*( \| .+?: .+?)+ \| ISP: AS15169 \S+', - re=True, - ignore='Downloading GeoIP database, please wait...', - online=True) -@plugin.output_prefix('[IP/Host Lookup] ') -def ip(bot, trigger): - """IP Lookup tool""" - # Check if there is input at all - if not trigger.group(2): - bot.reply("No search term.") - return - - parts = [] - # Check whether the input is an IP or hostmask or a nickname - decide = ['.', ':'] - if any(x in trigger.group(2) for x in decide): - # It's an IP/hostname! - query = trigger.group(2).strip() - else: - # Need to get the host for the username - username = trigger.group(2).strip().lower() - user_in_botdb = bot.users.get(username) - if user_in_botdb is not None: - query = user_in_botdb.host - - # Sanity check - sometimes user information isn't populated yet - if query is None: - bot.reply("I don't know that user's host.") - return - else: - bot.reply("I\'m not aware of this user.") - return - - db_path = _find_geoip_db(bot) - if db_path is False: - LOGGER.error('Can\'t find (or download) usable GeoIP database.') - bot.reply('Sorry, I don\'t have a GeoIP database to use for this lookup.') - return - - if ':' in query: - try: - socket.inet_pton(socket.AF_INET6, query) - except (OSError, socket.error): # Python 2/3 compatibility - bot.reply("Unable to resolve IP/Hostname") - return - elif '.' in query: - try: - socket.inet_pton(socket.AF_INET, query) - except (socket.error, socket.herror): - try: - query = socket.getaddrinfo(query, None)[0][4][0] - except socket.gaierror: - bot.reply("Unable to resolve IP/Hostname") - return - else: - bot.reply("Unable to resolve IP/Hostname") - return - - city = geoip2.database.Reader(os.path.join(db_path, 'GeoLite2-City.mmdb')) - asn = geoip2.database.Reader(os.path.join(db_path, 'GeoLite2-ASN.mmdb')) - host = socket.getfqdn(query) - try: - city_response = city.city(query) - asn_response = asn.asn(query) - except geoip2.errors.AddressNotFoundError: - bot.reply("The address is not in the database.") - return - - parts.append("Hostname: %s" % host) - try: - parts.append("Location: %s" % city_response.country.name) - except AttributeError: - parts.append('Location: Unknown') - - region = city_response.subdivisions.most_specific.name - if region: - parts.append("Region: %s" % region) - - city_name = city_response.city.name - if city_name: - parts.append("City: %s" % city_name) - - isp = "ISP: AS" + str(asn_response.autonomous_system_number) + \ - " " + str(asn_response.autonomous_system_organization) - parts.append(isp) - - bot.say(' | '.join(parts))