Passed
Push — develop ( 1a738b...dc1907 )
by Bastien
02:16
created

password_generator()   A

Complexity

Conditions 1

Size

Total Lines 10
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 4
dl 0
loc 10
rs 10
c 0
b 0
f 0
cc 1
nop 2
1
# -*- coding: utf-8 -*-
2
import datetime
3
import random
4
import string
5
from enum import Enum
6
import colorsys
7
import pytz
8
from redis import Redis
9
from rq import Queue
10
import typing
11
if typing.TYPE_CHECKING:
12
    from tracim_backend.config import CFG
13
14
DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
15
DEFAULT_WEBDAV_CONFIG_FILE = "wsgidav.conf"
16
DEFAULT_TRACIM_CONFIG_FILE = "development.ini"
17
CONTENT_FRONTEND_URL_SCHEMA = 'workspaces/{workspace_id}/contents/{content_type}/{content_id}'  # nopep8
18
WORKSPACE_FRONTEND_URL_SCHEMA = 'workspaces/{workspace_id}'  # nopep8
19
20
21
def get_root_frontend_url(config: 'CFG') -> str:
22
    """
23
    Return website base url with always '/' at the end
24
    """
25
    base_url = ''
26
    if config.WEBSITE_BASE_URL[-1] == '/':
27
        base_url = config.WEBSITE_BASE_URL
28
    else:
29
        base_url = config.WEBSITE_BASE_URL + '/'
30
    return base_url
31
32
33
def get_login_frontend_url(config: 'CFG'):
34
    """
35
    Return login page url
36
    """
37
    return get_root_frontend_url(config) + 'login'
38
39
40
def get_email_logo_frontend_url(config: 'CFG'):
41
    # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for email_logo_frontend_url  # nopep8
42
    return 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAC4jAAAuIwF4pT92AAAAB3RJTUUH4QUTDjMSlsws9AAAB89JREFUaN7tmWtwlFcZx3/PeXeXXLmKQJEGsFZApIUBnaqjUm4VgdYyCUib0cJoKLmHW5EWmlGoQkMICURgEPuhtiYDU7XcyVgKVugULZVCQAwUYyENYAmEXHb3PH7IFjYQNgnZHfnA+bKz+7573v//PPf/C/fWvdWhJWHfMbO4P479OpCAigeowWglPq3ARWfU9AJ7Cb/3MAXZn95dBLKKHsfIQmAUIq7rv6t6gU+BKCAGaEBkN9h88tLe7sgjTdjAJ5Y4OGYMIo80Aw8g4kakJyLxiDiIxABPoMwj5+XP3R0ESpP8WC1H1YuqBj4bUWwIB5gA0d/6/xFQFUpKHBJLHADyU9chTEc1BdEZqJ0O+ofb4xcPyuBIxoBQuHc4ov3w2zrwH0Nd0aBDccwgVPsjEg/4Uc4jegKfvkfMmQ9JSfECkFP0HGJeuu0TrJZhSacg9Xh4Caze2wsXC1B9GugO+BAqUIkC/QIinhYsYoEqYDt+fY2s8WXkFE5CnBIg+vaWtJuQukzy5te2l4Bz2ysTkxchshCRWERMU2BKT4RuiLT0vwagHsENPIyR7zAx2eGybws09AUZEQLHcNS5wMEdB8NjgaKyBNTuQuTLoWOAs6AHUd5DpRzxX0KMBe0M+gA4D4Hdw5mT72LJQORxkM6IfgxSC3wjyHpHEN8M8jKPtYeAq2VgvhHg9A4RvPUIKzCyBVe346SM9LZw1y5KShzOxfUhL60SmMfcNUXgisXYS/iNA/IzhNmBgH4I3E8Cxzpmgby9ffFoMSKTQxA4jZjRpI35qENZbF5Rb1SWgcwM7HsQr28KhZnVd55GPfqTkOCbaB+i2lR1uHa8nHYeda0EygJWGILHGXzndaBgz3CQ5Fb8/hSqr5E7uj4sBXBVSjlqN6FaixKHlS8BxCYtHhs/bUly9JT597U9C30/eRYiU4Nc5Q1gH+AG/gvsxJBH2vg3w9pDPTjqFDGxX0FkKOih2PtHOcbIBiPMMi5XT9eDo9/xlu+rDW2BpX+MAQnOCudRWcWFA3OwncYhrke5VpuK1SrW7+sTVgKv5NYjsr2p6TMY1QEGvhi4mmw89unWXaiX6QQEN1YHuHjpELm5lsxvV2MbhxAdWwCSiNfnCXsb7mc/Ih8hXED8J1T1k6awEAG+R+LCLqEJOL2vInwQOP46VHaSm9QYiI1nMU4xwv2oa3OHs0+LiaHuHKr/wOo/r1yuOQwcDEqVw2KdqITQBFJGelFWojITPz8kY+wmAAp3pWLkJVT7oGwkY3R5REar/Ln1qO7AyIfsLGxQ1eB60E3UDmi9kKWPOwmcvP69cM8kROYCXVB5FW18I4LToeLSbTGnKh2T9MIChLHBOI2lT9srMUDB9s7AM8CApj7H/yaZExsiOd9GnbngcjzOciPyVPOuW0RFB7ZvHnDck4FJgbOpwPoPRHpAdxs782bwQSwei3ty0aC2EVh61ANMutEy63Gi/l0VUfSJC7sIjAnhYYON4x7eNgI9KgeifDPIOyuuDygRWnGuKDcQF6roWrGxbSNgzDAgqBuV6ki7z9WT5y4DR0LdoqoVbSOgZhAi7hv4bXzEFarDG7yqbPmsgN2aovhdLdf+2jqBorIE4JGbIugZCvcsijQHr5ojN1tbVaustUWNNP6S0vy60AR+ut4Ndj7CYzdlgL7AixTtmRnRLOToVNAhQeDfR+yPr+iJrIbf/+pM62l0WP8RKNNCSCCTySuJjgT42MTnv4rqjEDvg6J+VH5T8/qynZSW+ts40EgCQtcQDcsDEN2d9IKe4U2hiR5jmG1ERt4QKrS4pkqK2zmRSQMaUsj6D5cuu3C5ppCY6IQLf2dn8CIjZk4Q+N961VnJvlxf+4Z6v/cojvsDYEQL4BXRHVTXfkysjqPfd3tA6YqOnXx293gnLgvV5xFBVa2iv/b6dEX91p+fbf9ImTnxX6gWAadbILARX+0rbEjxohwCFpBVlH1nyJea2KTFY+OduHUGeaFJoNN3gcwr1smu37qsze16y7pQ4a7pYFYj0iuAvho0jbTxJQBkrB6Ky70VGIDqamA9+WmnWtwrZ20/fN4uQA1rss52Slw8wIOZKg4/QIlTKBfY32DttobSZafDJS0Ka3YXYEx6UCXZid8/n6wJRwHIXrsEI7kB6+xHtQTDn8hLPQuipBb2oJOkgSQBPREuAlupq98cfa6mXsXnOFpfV5uQMBRxlMpP/kJpbmP4tNHC3SNBNiLycJAbleLlOXLGVTB33edRLUBkepAuegyRd1D7Pphh10Wr5mJuMT5fNo67L45NQSUlIBqsYlXqkqaiGy51es3eWQh5CDfmUeufTcaE9QBkFY7AyIuImXxT3bfI7doUvQayFbUDMSZYRHiLq64n2JByOXzvBzLGbkJ1GarnP4OPmBt60Or0v+E381Fdj+ILOhYT4p1ADOhTzcA3EdjeXvCtEwDIGNc0J6vNB/0FDXXbmk9uc05wMSYLq+nAgYArtWJ3keYW0eVUVheE9/3ArbYXkND+mbO2H8gk0AnAlGZAb3WlWpQ/I/o6q9JevWMxIyJdWWZ+V4xnOUaebQH4MVS2I/59eO3bFGbWdEiNiVhrmVncH+NfhMg0IA4RH1bfQnQlq9LKwiYnRbTB/9HmKLrWfg2j94HUoI1/Z3XOOe6te+vuWf8DkM0cb7DOQZgAAAAASUVORK5CYII='  # nopep8'
43
44
45
def get_redis_connection(config: 'CFG') -> Redis:
46
    """
47
    :param config: current app_config
48
    :return: redis connection
49
    """
50
    return Redis(
51
        host=config.EMAIL_SENDER_REDIS_HOST,
52
        port=config.EMAIL_SENDER_REDIS_PORT,
53
        db=config.EMAIL_SENDER_REDIS_DB,
54
    )
55
56
57
def get_rq_queue(redis_connection: Redis, queue_name: str ='default') -> Queue:
58
    """
59
    :param queue_name: name of queue
60
    :return: wanted queue
61
    """
62
63
    return Queue(name=queue_name, connection=redis_connection)
64
65
66
def cmp_to_key(mycmp):
67
    """
68
    List sort related function
69
70
    Convert a cmp= function into a key= function
71
    """
72
    class K(object):
73
        def __init__(self, obj, *args):
74
            self.obj = obj
75
76
        def __lt__(self, other):
77
            return mycmp(self.obj, other.obj) < 0
78
79
        def __gt__(self, other):
80
            return mycmp(self.obj, other.obj) > 0
81
82
        def __eq__(self, other):
83
            return mycmp(self.obj, other.obj) == 0
84
85
        def __le__(self, other):
86
            return mycmp(self.obj, other.obj) <= 0
87
88
        def __ge__(self, other):
89
            return mycmp(self.obj, other.obj) >= 0
90
91
        def __ne__(self, other):
92
            return mycmp(self.obj, other.obj) != 0
93
94
    return K
95
96
97
def current_date_for_filename() -> str:
98
    """
99
    ISO8601 current date, adapted to be used in filename (for
100
    webdav feature for example), with trouble-free characters.
101
    :return: current date as string like "2018-03-19T15.49.27.246592"
102
    """
103
    # INFO - G.M - 19-03-2018 - As ':' is in transform_to_bdd method in
104
    # webdav utils, it may cause trouble. So, it should be replaced to
105
    # a character which will not change in bdd.
106
    return datetime.datetime.now().isoformat().replace(':', '.')
107
108
109
class Timezone(object):
110
    def __init__(self, name):
111
        self.name = name
112
113
114
def get_timezones_list() -> typing.List[Timezone]:
115
    tz_list = []
116
    for tz_name in pytz.common_timezones:
117
        tz_list.append(Timezone(tz_name))
118
    return tz_list
119
120
# INFO - G.M - 2018-08-02 - Simple password generator, inspired by
121
# https://gist.github.com/23maverick23/4131896
122
123
124
ALLOWED_AUTOGEN_PASSWORD_CHAR = string.ascii_letters + \
125
                                string.digits + \
126
                                string.punctuation
127
128
DEFAULT_PASSWORD_GEN_CHAR_LENGTH = 12
129
130
131
def password_generator(
132
        length: int=DEFAULT_PASSWORD_GEN_CHAR_LENGTH,
133
        chars: str=ALLOWED_AUTOGEN_PASSWORD_CHAR
134
) -> str:
135
    """
136
    :param length: length of the new password
137
    :param chars: characters allowed
138
    :return: password as string
139
    """
140
    return ''.join(random.choice(chars) for char_number in range(length))
141
142
143
def clamp(val: float, minimum: float = 0.0, maximum: float= 255.0) -> int:
144
    """ Fix value between min an max"""
145
    if val < minimum:
146
        return minimum
147
    if val > maximum:
148
        return maximum
149
    return int(val)
150
151
152
COLOR_DARKEN_SCALE_FACTOR = 0.85
153
COLOR_LIGHTEN_SCALE_FACTOR = 1.15
154
155
156
class Color(object):
157
    def __init__(self, base_hex_code: str):
158
        """
159
        :param base_hex_code: hex color like '#FFFFFF'
160
        """
161
162
        assert len(base_hex_code) == 7
163
        self._base_hex_code = base_hex_code
164
165
    # INFO - G.M - 2018-08-10 - get_hexcolor, inspired by
166
    # https://thadeusb.com/weblog/2010/10/10/python_scale_hex_color/
167
168
    def get_hexcolor(self, scalefactor: float) -> str:
169
        """
170
171
        :param scalefactor: factor of scaling,
172
        value between 0 and 1 darken the color,
173
        value >1 lighten the color.
174
        :return: new hex_color
175
        """
176
177
        hex_color = self._base_hex_code.strip('#')
178
        assert scalefactor > 0
179
180
        r = int(hex_color[:2], 16)
181
        g = int(hex_color[2:4], 16)
182
        b = int(hex_color[4:], 16)
183
184
        h, l, s = colorsys.rgb_to_hls(r, g, b)
185
        l = scalefactor * l
186
        r, g, b = colorsys.hls_to_rgb(h, l, s)
187
188
        return "#%02x%02x%02x" % (clamp(r), clamp(g), clamp(b))
189
190
    @property
191
    def normal(self):
192
        return self._base_hex_code
193
194
    @property
195
    def darken(self):
196
        return self.get_hexcolor(COLOR_DARKEN_SCALE_FACTOR)
197
198
    @property
199
    def lighten(self):
200
        return self.get_hexcolor(COLOR_LIGHTEN_SCALE_FACTOR)
201