sopel.modules.ip.ip() - Code Metrics - sopel-irc/sopel - Measure and Improve Code Quality continuously with Scrutinizer

sopel.modules.ip.ip() F
last analyzed 2019-10-21 18:25 UTC

↳ Parent: sopel.modules.ip

Complexity

Conditions

Size

Total Lines	74
Code Lines	59

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	59
dl	0
loc	74
rs	2.4
c	0
b	0
f	0
cc	16
nop	2

How to fix Long Method Complexity

# coding=utf-8
"""
ip.py - Sopel GeoIP Lookup Module
Copyright 2011, Dimitri Molenaars, TyRope.nl,
Copyright © 2013, Elad Alfassa <[email protected]>
Licensed under the Eiffel Forum License 2.

https://sopel.chat
"""

from __future__ import unicode_literals, absolute_import, print_function, division

import logging
import os
import socket
import tarfile

import geoip2.database

from sopel.config.types import FilenameAttribute, StaticSection
from sopel.module import commands, example

urlretrieve = None
try:
    from urllib import urlretrieve
except ImportError:
    try:
        # urlretrieve has been put under urllib.request in Python 3.
        # It's also deprecated so this should probably be replaced with
        # urllib2.
        from urllib.request import urlretrieve
    except ImportError:
        pass


LOGGER = logging.getLogger(__name__)


class GeoipSection(StaticSection):
    GeoIP_db_path = FilenameAttribute('GeoIP_db_path', directory=True)
    """Path of the directory containing the GeoIP database files."""


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'
    elif urlretrieve:
        LOGGER.info('Downloading GeoIP database')
        bot.say('Downloading GeoIP database, please wait...')
        geolite_urls = [
            'https://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz',
            'https://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz'
        ]
        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 bot.config.core.homedir
    else:
        return False


@commands('iplookup', 'ip')
@example('.ip 8.8.8.8',
         r'\[IP\/Host Lookup\] Hostname: \S*dns\S*\.google\S* \| Location: United States \| ISP: AS15169 Google LLC',
         re=True,
         ignore='Downloading GeoIP database, please wait...',
         online=True)
def ip(bot, trigger):
    """IP Lookup tool"""
    # Check if there is input at all
    if not trigger.group(2):
        return bot.reply("No search term.")
    # 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()
        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:
                return bot.say("I don't know that user's host.")
        else:
            return bot.say("I\'m not aware of this user.")

    db_path = _find_geoip_db(bot)
    if db_path is False:
        LOGGER.error('Can\'t find (or download) usable GeoIP database.')
        bot.say('Sorry, I don\'t have a GeoIP database to use for this lookup.')
        return False

    if ':' in query:
        try:
            socket.inet_pton(socket.AF_INET6, query)
        except (OSError, socket.error):  # Python 2/3 compatibility
            return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")
    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:
                return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")
    else:
        return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")

    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:
        return bot.say("[IP/Host Lookup] The address is not in the database.")

    response = "[IP/Host Lookup] Hostname: %s" % host
    try:
        response += " | Location: %s" % city_response.country.name
    except AttributeError:
        response += ' | Location: Unknown'

    region = city_response.subdivisions.most_specific.name
    response += " | Region: %s" % region if region else ""
    city = city_response.city.name
    response += " | City: %s" % city if city else ""
    isp = "AS" + str(asn_response.autonomous_system_number) + \
          " " + asn_response.autonomous_system_organization
    response += " | ISP: %s" % isp if isp else ""
    bot.say(response)


if __name__ == "__main__":
    from sopel.test_tools import run_example_tests
    run_example_tests(__file__)


1			# coding=utf-8
2			"""
3			ip.py - Sopel GeoIP Lookup Module
4			Copyright 2011, Dimitri Molenaars, TyRope.nl,
5			Copyright © 2013, Elad Alfassa <[email protected]>
6			Licensed under the Eiffel Forum License 2.
7
8			https://sopel.chat
9			"""
10
11			from __future__ import unicode_literals, absolute_import, print_function, division
12
13			import logging
14			import os
15			import socket
16			import tarfile
17
18			import geoip2.database
19
20			from sopel.config.types import FilenameAttribute, StaticSection
21			from sopel.module import commands, example
22
23			urlretrieve = None
24			try:
25			from urllib import urlretrieve
26			except ImportError:
27			try:
28			# urlretrieve has been put under urllib.request in Python 3.
29			# It's also deprecated so this should probably be replaced with
30			# urllib2.
31			from urllib.request import urlretrieve
32			except ImportError:
33			pass
34
35
36			LOGGER = logging.getLogger(__name__)
37
38
39			class GeoipSection(StaticSection):
40			GeoIP_db_path = FilenameAttribute('GeoIP_db_path', directory=True)
41			"""Path of the directory containing the GeoIP database files."""
42
43
44			def configure(config):
45			"""
46			\| name \| example \| purpose \|
47			\| ---- \| ------- \| ------- \|
48			\| GeoIP\\_db\\_path \| /home/sopel/GeoIP/ \| Path to the GeoIP database files \|
49			"""
50			config.define_section('ip', GeoipSection)
51			config.ip.configure_setting('GeoIP_db_path',
52			'Path of the GeoIP db files')
53
54
55			def setup(bot):
56			bot.config.define_section('ip', GeoipSection)
57
58
59			def _decompress(source, target, delete_after_decompression=True):
60			"""Decompress just the database from the archive"""
61			# https://stackoverflow.com/a/16452962
62			tar = tarfile.open(source)
63			for member in tar.getmembers():
64			if ".mmdb" in member.name:
65			member.name = os.path.basename(member.name)
66			tar.extract(member, target)
67			if delete_after_decompression:
68			os.remove(source)
69
70
71			def _find_geoip_db(bot):
72			"""Find the GeoIP database"""
73			config = bot.config
74			if config.ip.GeoIP_db_path:
75			cities_db = os.path.join(config.ip.GeoIP_db_path, 'GeoLite2-City.mmdb')
76			ipasnum_db = os.path.join(config.ip.GeoIP_db_path, 'GeoLite2-ASN.mmdb')
77			if (os.path.isfile(cities_db) and os.path.isfile(ipasnum_db)):
78			return config.ip.GeoIP_db_path
79			else:
80			LOGGER.warning(
81			'GeoIP path configured but DB not found in configured path')
82
83			if (os.path.isfile(os.path.join(config.core.homedir, 'GeoLite2-City.mmdb')) and
84			os.path.isfile(os.path.join(config.core.homedir, 'GeoLite2-ASN.mmdb'))):
85			return config.core.homedir
86			elif (os.path.isfile(os.path.join('/usr/share/GeoIP', 'GeoLite2-City.mmdb')) and
87			os.path.isfile(os.path.join('/usr/share/GeoIP', 'GeoLite2-ASN.mmdb'))):
88			return '/usr/share/GeoIP'
89			elif urlretrieve:
90			LOGGER.info('Downloading GeoIP database')
91			bot.say('Downloading GeoIP database, please wait...')
92			geolite_urls = [
93			'https://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz',
94			'https://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz'
95			]
96			for url in geolite_urls:
97			LOGGER.debug('GeoIP Source URL: %s', url)
98			full_path = os.path.join(config.core.homedir, url.split("/")[-1])
99			urlretrieve(url, full_path)
100			_decompress(full_path, config.core.homedir)
101			return bot.config.core.homedir
102			else:
103			return False
104
105
106			@commands('iplookup', 'ip')
107			@example('.ip 8.8.8.8',
108			r'\[IP\/Host Lookup\] Hostname: \Sdns\S\.google\S* \\| Location: United States \\| ISP: AS15169 Google LLC',
109			re=True,
110			ignore='Downloading GeoIP database, please wait...',
111			online=True)
112			def ip(bot, trigger):
113			"""IP Lookup tool"""
114			# Check if there is input at all
115			if not trigger.group(2):
116			return bot.reply("No search term.")
117			# Check whether the input is an IP or hostmask or a nickname
118			decide = ['.', ':']
119			if any(x in trigger.group(2) for x in decide):
120			# It's an IP/hostname!
121			query = trigger.group(2).strip()
122			else:
123			# Need to get the host for the username
124			username = trigger.group(2).strip()
125			user_in_botdb = bot.users.get(username)
126			if user_in_botdb is not None:
127			query = user_in_botdb.host
128
129			# Sanity check - sometimes user information isn't populated yet
130			if query is None:
131			return bot.say("I don't know that user's host.")
132			else:
133			return bot.say("I\'m not aware of this user.")
134
135			db_path = _find_geoip_db(bot)
136			if db_path is False:
137			LOGGER.error('Can\'t find (or download) usable GeoIP database.')
138			bot.say('Sorry, I don\'t have a GeoIP database to use for this lookup.')
139			return False
140
141			if ':' in query:
142			try:
143			socket.inet_pton(socket.AF_INET6, query)
144			except (OSError, socket.error): # Python 2/3 compatibility
145			return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")
146			elif '.' in query:
147			try:
148			socket.inet_pton(socket.AF_INET, query)
149			except (socket.error, socket.herror):
150			try:
151			query = socket.getaddrinfo(query, None)[0][4][0]
152			except socket.gaierror:
153			return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")
154			else:
155			return bot.say("[IP/Host Lookup] Unable to resolve IP/Hostname")
156
157			city = geoip2.database.Reader(os.path.join(db_path, 'GeoLite2-City.mmdb'))
158			asn = geoip2.database.Reader(os.path.join(db_path, 'GeoLite2-ASN.mmdb'))
159			host = socket.getfqdn(query)
160			try:
161			city_response = city.city(query)
162			asn_response = asn.asn(query)
163			except geoip2.errors.AddressNotFoundError:
164			return bot.say("[IP/Host Lookup] The address is not in the database.")
165
166			response = "[IP/Host Lookup] Hostname: %s" % host
167			try:
168			response += " \| Location: %s" % city_response.country.name
169			except AttributeError:
170			response += ' \| Location: Unknown'
171
172			region = city_response.subdivisions.most_specific.name
173			response += " \| Region: %s" % region if region else ""
174			city = city_response.city.name
175			response += " \| City: %s" % city if city else ""
176			isp = "AS" + str(asn_response.autonomous_system_number) + \
177			" " + asn_response.autonomous_system_organization
178			response += " \| ISP: %s" % isp if isp else ""
179			bot.say(response)
180
181
182			if __name__ == "__main__":
183			from sopel.test_tools import run_example_tests
184			run_example_tests(__file__)
185

sopel-irc / sopel

sopel.modules.ip.ip() F last analyzed 2019-10-21 18:25 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like

sopel.modules.ip.ip() F
last analyzed 2019-10-21 18:25 UTC