File: utils.py

package info (click to toggle)
python-infoblox-client 0.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,540 kB
  • sloc: python: 9,572; makefile: 213
file content (171 lines) | stat: -rw-r--r-- 5,064 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# Copyright 2015 OpenStack LLC.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import netaddr
import six
import re

try:
    from oslo_log import log as logging
except ImportError:  # pragma: no cover
    import logging

try:
    from oslo_serialization import jsonutils
except ImportError:  # pragma: no cover
    import json as jsonutils

LOG = logging.getLogger(__name__)


def is_valid_ip(ip):
    """Check if the given IP address is valid."""
    if not ip:
        LOG.info("IP address is not provided")
        return False
    try:
        netaddr.IPAddress(ip)
    except netaddr.core.AddrFormatError:
        LOG.info("Invalid IP address provided: %s", ip)
        return False
    return True


def generate_duid(mac):
    """DUID is consisted of 10 hex numbers.

    0x00 + mac with last 3 hex + mac with 6 hex
    """
    valid = mac and isinstance(mac, six.string_types)
    if not valid:
        raise ValueError("Invalid argument was passed")
    return "00:" + mac[9:] + ":" + mac


def determine_ip_version(ip_in):
    ip_ver = 4
    if isinstance(ip_in, (list, tuple)):
        ip_in = ip_in[0]
    if ip_in:
        if isinstance(ip_in, int):
            if ip_in == 6:
                ip_ver = 6
            else:
                ip_ver = 4
        elif hasattr(ip_in, 'ip_version'):
            return ip_in.ip_version
        else:
            if type(ip_in) is dict:
                addr = ip_in['ip_address']
            else:
                addr = ip_in
            try:
                ip = netaddr.IPAddress(addr)
            except ValueError:
                ip = netaddr.IPNetwork(addr)

            ip_ver = ip.version
    return ip_ver


def safe_json_load(data):
    try:
        return jsonutils.loads(data)
    except ValueError:
        LOG.warning("Could not decode reply into json: %s", data)


def try_value_to_bool(value, strict_mode=True):
    """Tries to convert value into boolean.

    Args:
        value       (str): Value that should be converted into boolean.

        strict_mode (bool):
            - If strict_mode is True, Only string representation of str(True)
              and str(False) are converted into booleans;
            - If strict_mode is False, anything that looks like True or False
              is converted into booleans:

              - Values accepted as True are: 'true', 'on', 'yes' (case
                independent)
              - Values accepted as False are: 'false', 'off', 'no' (case
                independent)

    Returns:
        True, False, or original value in case of failed conversion.
    """
    if strict_mode:
        true_list = ('True',)
        false_list = ('False',)
        val = value
    else:
        true_list = ('true', 'on', 'yes')
        false_list = ('false', 'off', 'no')
        val = str(value).lower()

    if val in true_list:
        return True
    elif val in false_list:
        return False
    return value


def paging(response, max_results):
    """Returns WAPI response page by page

    Args:
        response (list): WAPI response.
        max_results (int): Maximum number of objects to be returned
                           in one page.
    Returns:
        Generator object with WAPI response split page by page.
    """
    i = 0
    while i < len(response):
        yield response[i:i + max_results]
        i = i + max_results


def mask_sensitive_data(data, sensitive_keys=None):
    if sensitive_keys is None:
        sensitive_keys = ['username', 'password', 'cert', 'key']

    if isinstance(data, dict):
        # Mask sensitive data in dictionary
        return {
            k: ('****' if k in sensitive_keys else v) for k, v in data.items()
        }
    elif isinstance(data, str):
        # Mask sensitive data in string
        patterns = {key: rf'(?<={key}=)[^&]*' for key in sensitive_keys}
        for key, pattern in patterns.items():
            data = re.sub(pattern, '****', data)
        return data
    return data


def format_html(html_content):
    if not html_content:
        return ''
    # Replace HTML tags with newlines and indentation for readability
    # Decode if the content is in bytes
    if isinstance(html_content, bytes):
        html_content = html_content.decode('utf-8')
    formatted_content = html_content.replace('<', '\n<')
    formatted_content = formatted_content.replace('>', '>\n')
    formatted_content = '\n'.join(
        line.strip() for line in formatted_content.split('\n') if line.strip())
    return formatted_content