glances.plugins.ip.PluginModel.public_info_for_human() - Code Metrics - Inspection of "Refactored `glances.plugins.ip.PluginModel.update`" - nicolargo/glances - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — develop (#2998)

unknown

created 2024-11-01 16:17 UTC

PluginModel.public_info_for_human() A

↳ Parent: glances.plugins.ip

Complexity

Conditions

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nop	2
dl	0
loc	6
rs	10
c	0
b	0
f	0

#
# This file is part of Glances.
#
# SPDX-FileCopyrightText: 2024 Nicolas Hennion <[email protected]>
#
# SPDX-License-Identifier: LGPL-3.0-only
#

"""IP plugin."""

import threading

from glances.globals import json_loads, queue, urlopen_auth
from glances.logger import logger
from glances.plugins.plugin.model import GlancesPluginModel
from glances.timer import Timer, getTimeSinceLastUpdate

# Import plugin specific dependency
try:
    import netifaces
except ImportError as e:
    import_error_tag = True
    logger.warning(f"Missing Python Lib ({e}), IP plugin is disabled")
else:
    import_error_tag = False

# Fields description
# description: human readable description
# short_name: shortname to use un UI
# unit: unit type
# rate: is it a rate ? If yes, // by time_since_update when displayed,
# min_symbol: Auto unit should be used if value > than 1 'X' (K, M, G)...
fields_description = {
    'address': {
        'description': 'Private IP address',
    },
    'mask': {
        'description': 'Private IP mask',
    },
    'mask_cidr': {
        'description': 'Private IP mask in CIDR format',
        'unit': 'number',
    },
    'gateway': {
        'description': 'Private IP gateway',
    },
    'public_address': {
        'description': 'Public IP address',
    },
    'public_info_human': {
        'description': 'Public IP information',
    },
}


class PluginModel(GlancesPluginModel):
    """Glances IP Plugin.

    stats is a dict
    """

    _default_public_refresh_interval = 300

    def __init__(self, args=None, config=None):
        """Init the plugin."""
        super().__init__(args=args, config=config, fields_description=fields_description)

        # We want to display the stat in the curse interface
        self.display_curse = True

        # Public information (see issue #2732)
        self.public_address = ""
        self.public_info = ""
        self.public_api = self.get_conf_value("public_api", default=[None])[0]
        self.public_username = self.get_conf_value("public_username", default=[None])[0]
        self.public_password = self.get_conf_value("public_password", default=[None])[0]
        self.public_field = self.get_conf_value("public_field", default=[None])
        self.public_template = self.get_conf_value("public_template", default=[None])[0]
        self.public_disabled = (
            self.get_conf_value('public_disabled', default='False')[0].lower() != 'false'
            or self.public_api is None
            or self.public_field is None
        )
        self.public_address_refresh_interval = self.get_conf_value(
            "public_refresh_interval", default=self._default_public_refresh_interval
        )

    def get_private_ipv4(self, stats, stop=False):
        # Get the default gateway thanks to the netifaces lib
        try:
            default_gw = netifaces.gateways()['default'][netifaces.AF_INET]
        except (KeyError, AttributeError) as e:
            logger.debug(f"Cannot grab default gateway IP address ({e})")
            stop = True
        else:
            stats['gateway'] = default_gw[0]

        return (stop, stats)

    def get_first_ipv4(self, stats, stop=False):
        try:
            default_gw = netifaces.gateways()['default'][netifaces.AF_INET]
            address = netifaces.ifaddresses(default_gw[1])[netifaces.AF_INET][0]['addr']
            mask = netifaces.ifaddresses(default_gw[1])[netifaces.AF_INET][0]['netmask']
        except (KeyError, AttributeError) as e:
            logger.debug(f"Cannot grab private IP address ({e})")
            stop = True
        else:
            stats['address'] = address
            stats['mask'] = mask
            stats['mask_cidr'] = self.ip_to_cidr(stats['mask'])

        return (stop, stats)

    def get_public_ipv4(self, stats, stop=True):
        time_since_update = getTimeSinceLastUpdate('public-ip')
        try:
            if not self.public_disabled and (
                self.public_address == "" or time_since_update > self.public_address_refresh_interval
            ):
                self.public_info = PublicIpInfo(self.public_api, self.public_username, self.public_password).get()
                self.public_address = self.public_info['ip']
        except (KeyError, AttributeError, TypeError) as e:
            logger.debug(f"Cannot grab public IP information ({e})")
        else:
            stats['public_address'] = (
                self.public_address if not self.args.hide_public_info else self.__hide_ip(self.public_address)
            )
            stats['public_info_human'] = self.public_info_for_human(self.public_info)

        return (stop, stats)

    @GlancesPluginModel._check_decorator
    @GlancesPluginModel._log_result_decorator
    def update(self):
        """Update IP stats using the input method.

        :return: the stats dict
        """
        # Init new stats
        stats = self.get_init_value()

        # Revert

        if self.input_method == 'local' and not import_error_tag:
            # Private IP address
            stop, stats = self.get_private_ipv4(stats)

            if not stop:
                stop, stats = self.get_first_ipv4(stats)

            # Public IP address
            if not stop:
                stop, stats = self.get_public_ipv4(stats)

        elif self.input_method == 'snmp':
            # Not implemented yet
            pass

        # Update the stats
        self.stats = stats

        return self.stats

    def __hide_ip(self, ip):
        """Hide last to digit of the given IP address"""
        return '.'.join(ip.split('.')[0:2]) + '.*.*'

    def msg_curse(self, args=None, max_width=None):
        """Return the dict to display in the curse interface."""
        # Init the return message
        ret = []

        # Only process if stats exist and display plugin enable...
        if not self.stats or self.is_disabled() or import_error_tag:
            return ret

        # Build the string message
        msg = ' - '
        ret.append(self.curse_add_line(msg, optional=True))

        # Start with the private IP information
        msg = 'IP '
        ret.append(self.curse_add_line(msg, 'TITLE', optional=True))
        if 'address' in self.stats:
            msg = '{}'.format(self.stats['address'])
            ret.append(self.curse_add_line(msg, optional=True))
        if 'mask_cidr' in self.stats:
            # VPN with no internet access (issue #842)
            msg = '/{}'.format(self.stats['mask_cidr'])
            ret.append(self.curse_add_line(msg, optional=True))

        # Then with the public IP information
        try:
            msg_pub = '{}'.format(self.stats['public_address'])
        except (UnicodeEncodeError, KeyError):
            # Add KeyError exception (see https://github.com/nicolargo/glances/issues/1469)
            pass
        else:
            if self.stats['public_address']:
                msg = ' Pub '
                ret.append(self.curse_add_line(msg, 'TITLE', optional=True))
                ret.append(self.curse_add_line(msg_pub, optional=True))

            if self.stats['public_info_human']:
                ret.append(self.curse_add_line(' {}'.format(self.stats['public_info_human']), optional=True))

        return ret

    def public_info_for_human(self, public_info):
        """Return the data to pack to the client."""
        if not public_info:
            return ''

        return self.public_template.format(**public_info)

    @staticmethod
    def ip_to_cidr(ip):
        """Convert IP address to CIDR.

        Example: '255.255.255.0' will return 24
        """
        # Thanks to @Atticfire
        # See https://github.com/nicolargo/glances/issues/1417#issuecomment-469894399
        if ip is None:
            # Correct issue #1528
            return 0
        return sum(bin(int(x)).count('1') for x in ip.split('.'))


class PublicIpInfo:
    """Get public IP information from online service."""

    def __init__(self, url, username, password, timeout=2):
        """Init the class."""
        self.url = url
        self.username = username
        self.password = password
        self.timeout = timeout

    def get(self):
        """Return the public IP information returned by one of the online service."""
        q = queue.Queue()

        t = threading.Thread(target=self._get_ip_public_info, args=(q, self.url, self.username, self.password))
        t.daemon = True
        t.start()

        timer = Timer(self.timeout)
        info = None
        while not timer.finished() and info is None:
            if q.qsize() > 0:
                info = q.get()

        return info

    def _get_ip_public_info(self, queue_target, url, username, password):
        """Request the url service and put the result in the queue_target."""
        try:
            response = urlopen_auth(url, username, password).read()
        except Exception as e:
            logger.debug(f"IP plugin - Cannot get public IP information from {url} ({e})")
            queue_target.put(None)
        else:
            try:
                queue_target.put(json_loads(response))
            except (ValueError, KeyError) as e:
                logger.debug(f"IP plugin - Cannot load public IP information from {url} ({e})")
                queue_target.put(None)


1			#
2			# This file is part of Glances.
3			#
4			# SPDX-FileCopyrightText: 2024 Nicolas Hennion <[email protected]>
5			#
6			# SPDX-License-Identifier: LGPL-3.0-only
7			#
8
9			"""IP plugin."""
10
11			import threading
12
13			from glances.globals import json_loads, queue, urlopen_auth
14			from glances.logger import logger
15			from glances.plugins.plugin.model import GlancesPluginModel
16			from glances.timer import Timer, getTimeSinceLastUpdate
17
18			# Import plugin specific dependency
19			try:
20			import netifaces
21			except ImportError as e:
22			import_error_tag = True
23			logger.warning(f"Missing Python Lib ({e}), IP plugin is disabled")
24			else:
25			import_error_tag = False
26
27			# Fields description
28			# description: human readable description
29			# short_name: shortname to use un UI
30			# unit: unit type
31			# rate: is it a rate ? If yes, // by time_since_update when displayed,
32			# min_symbol: Auto unit should be used if value > than 1 'X' (K, M, G)...
33			fields_description = {
34			'address': {
35			'description': 'Private IP address',
36			},
37			'mask': {
38			'description': 'Private IP mask',
39			},
40			'mask_cidr': {
41			'description': 'Private IP mask in CIDR format',
42			'unit': 'number',
43			},
44			'gateway': {
45			'description': 'Private IP gateway',
46			},
47			'public_address': {
48			'description': 'Public IP address',
49			},
50			'public_info_human': {
51			'description': 'Public IP information',
52			},
53			}
54
55
56			class PluginModel(GlancesPluginModel):
57			"""Glances IP Plugin.
58
59			stats is a dict
60			"""
61
62			_default_public_refresh_interval = 300
63
64			def __init__(self, args=None, config=None):
65			"""Init the plugin."""
66			super().__init__(args=args, config=config, fields_description=fields_description)
67
68			# We want to display the stat in the curse interface
69			self.display_curse = True
70
71			# Public information (see issue #2732)
72			self.public_address = ""
73			self.public_info = ""
74			self.public_api = self.get_conf_value("public_api", default=[None])[0]
75			self.public_username = self.get_conf_value("public_username", default=[None])[0]
76			self.public_password = self.get_conf_value("public_password", default=[None])[0]
77			self.public_field = self.get_conf_value("public_field", default=[None])
78			self.public_template = self.get_conf_value("public_template", default=[None])[0]
79			self.public_disabled = (
80			self.get_conf_value('public_disabled', default='False')[0].lower() != 'false'
81			or self.public_api is None
82			or self.public_field is None
83			)
84			self.public_address_refresh_interval = self.get_conf_value(
85			"public_refresh_interval", default=self._default_public_refresh_interval
86			)
87
88			def get_private_ipv4(self, stats, stop=False):
89			# Get the default gateway thanks to the netifaces lib
90			try:
91			default_gw = netifaces.gateways()['default'][netifaces.AF_INET]
92			except (KeyError, AttributeError) as e:
93			logger.debug(f"Cannot grab default gateway IP address ({e})")
94			stop = True
95			else:
96			stats['gateway'] = default_gw[0]
97
98			return (stop, stats)
99
100			def get_first_ipv4(self, stats, stop=False):
101			try:
102			default_gw = netifaces.gateways()['default'][netifaces.AF_INET]
103			address = netifaces.ifaddresses(default_gw[1])[netifaces.AF_INET][0]['addr']
104			mask = netifaces.ifaddresses(default_gw[1])[netifaces.AF_INET][0]['netmask']
105			except (KeyError, AttributeError) as e:
106			logger.debug(f"Cannot grab private IP address ({e})")
107			stop = True
108			else:
109			stats['address'] = address
110			stats['mask'] = mask
111			stats['mask_cidr'] = self.ip_to_cidr(stats['mask'])
112
113			return (stop, stats)
114
115			def get_public_ipv4(self, stats, stop=True):
116			time_since_update = getTimeSinceLastUpdate('public-ip')
117			try:
118			if not self.public_disabled and (
119			self.public_address == "" or time_since_update > self.public_address_refresh_interval
120			):
121			self.public_info = PublicIpInfo(self.public_api, self.public_username, self.public_password).get()
122			self.public_address = self.public_info['ip']
123			except (KeyError, AttributeError, TypeError) as e:
124			logger.debug(f"Cannot grab public IP information ({e})")
125			else:
126			stats['public_address'] = (
127			self.public_address if not self.args.hide_public_info else self.__hide_ip(self.public_address)
128			)
129			stats['public_info_human'] = self.public_info_for_human(self.public_info)
130
131			return (stop, stats)
132
133			@GlancesPluginModel._check_decorator
134			@GlancesPluginModel._log_result_decorator
135			def update(self):
136			"""Update IP stats using the input method.
137
138			:return: the stats dict
139			"""
140			# Init new stats
141			stats = self.get_init_value()
142
143			# Revert
144
145			if self.input_method == 'local' and not import_error_tag:
146			# Private IP address
147			stop, stats = self.get_private_ipv4(stats)
148
149			if not stop:
150			stop, stats = self.get_first_ipv4(stats)
151
152			# Public IP address
153			if not stop:
154			stop, stats = self.get_public_ipv4(stats)
155
156			elif self.input_method == 'snmp':
157			# Not implemented yet
158			pass
159
160			# Update the stats
161			self.stats = stats
162
163			return self.stats
164
165			def __hide_ip(self, ip):
166			"""Hide last to digit of the given IP address"""
167			return '.'.join(ip.split('.')[0:2]) + '..'
168
169			def msg_curse(self, args=None, max_width=None):
170			"""Return the dict to display in the curse interface."""
171			# Init the return message
172			ret = []
173
174			# Only process if stats exist and display plugin enable...
175			if not self.stats or self.is_disabled() or import_error_tag:
176			return ret
177
178			# Build the string message
179			msg = ' - '
180			ret.append(self.curse_add_line(msg, optional=True))
181
182			# Start with the private IP information
183			msg = 'IP '
184			ret.append(self.curse_add_line(msg, 'TITLE', optional=True))
185			if 'address' in self.stats:
186			msg = '{}'.format(self.stats['address'])
187			ret.append(self.curse_add_line(msg, optional=True))
188			if 'mask_cidr' in self.stats:
189			# VPN with no internet access (issue #842)
190			msg = '/{}'.format(self.stats['mask_cidr'])
191			ret.append(self.curse_add_line(msg, optional=True))
192
193			# Then with the public IP information
194			try:
195			msg_pub = '{}'.format(self.stats['public_address'])
196			except (UnicodeEncodeError, KeyError):
197			# Add KeyError exception (see https://github.com/nicolargo/glances/issues/1469)
198			pass
199			else:
200			if self.stats['public_address']:
201			msg = ' Pub '
202			ret.append(self.curse_add_line(msg, 'TITLE', optional=True))
203			ret.append(self.curse_add_line(msg_pub, optional=True))
204
205			if self.stats['public_info_human']:
206			ret.append(self.curse_add_line(' {}'.format(self.stats['public_info_human']), optional=True))
207
208			return ret
209
210			def public_info_for_human(self, public_info):
211			"""Return the data to pack to the client."""
212			if not public_info:
213			return ''
214
215			return self.public_template.format(**public_info)
216
217			@staticmethod
218			def ip_to_cidr(ip):
219			"""Convert IP address to CIDR.
220
221			Example: '255.255.255.0' will return 24
222			"""
223			# Thanks to @Atticfire
224			# See https://github.com/nicolargo/glances/issues/1417#issuecomment-469894399
225			if ip is None:
226			# Correct issue #1528
227			return 0
228			return sum(bin(int(x)).count('1') for x in ip.split('.'))
229
230
231			class PublicIpInfo:
232			"""Get public IP information from online service."""
233
234			def __init__(self, url, username, password, timeout=2):
235			"""Init the class."""
236			self.url = url
237			self.username = username
238			self.password = password
239			self.timeout = timeout
240
241			def get(self):
242			"""Return the public IP information returned by one of the online service."""
243			q = queue.Queue()
244
245			t = threading.Thread(target=self._get_ip_public_info, args=(q, self.url, self.username, self.password))
246			t.daemon = True
247			t.start()
248
249			timer = Timer(self.timeout)
250			info = None
251			while not timer.finished() and info is None:
252			if q.qsize() > 0:
253			info = q.get()
254
255			return info
256
257			def _get_ip_public_info(self, queue_target, url, username, password):
258			"""Request the url service and put the result in the queue_target."""
259			try:
260			response = urlopen_auth(url, username, password).read()
261			except Exception as e:
262			logger.debug(f"IP plugin - Cannot get public IP information from {url} ({e})")
263			queue_target.put(None)
264			else:
265			try:
266			queue_target.put(json_loads(response))
267			except (ValueError, KeyError) as e:
268			logger.debug(f"IP plugin - Cannot load public IP information from {url} ({e})")
269			queue_target.put(None)
270

nicolargo / glances

Pull Request — develop (#2998)

PluginModel.public_info_for_human() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like