Passed
Pull Request — develop (#43)
by inkhey
02:51
created

get_redis_connection()   A

Complexity

Conditions 1

Size

Total Lines 9
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 5
dl 0
loc 9
rs 10
c 0
b 0
f 0
cc 1
nop 1
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 preview_manager_page_format(page_number: int) -> int:
22
    """
23
    Convert page real number of page(begin at 1) to preview_manager page
24
    format(begin at 0)
25
    """
26
    return page_number-1
27
28
29
def get_root_frontend_url(config: 'CFG') -> str:
30
    """
31
    Return website base url with always '/' at the end
32
    """
33
    base_url = ''
34
    if config.WEBSITE_BASE_URL[-1] == '/':
35
        base_url = config.WEBSITE_BASE_URL
36
    else:
37
        base_url = config.WEBSITE_BASE_URL + '/'
38
    return base_url
39
40
41
def get_login_frontend_url(config: 'CFG'):
42
    """
43
    Return login page url
44
    """
45
    return get_root_frontend_url(config) + 'login'
46
47
48
def get_email_logo_frontend_url(config: 'CFG'):
49
    # TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for email_logo_frontend_url  # nopep8
50
    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'
51
52
53
def get_redis_connection(config: 'CFG') -> Redis:
54
    """
55
    :param config: current app_config
56
    :return: redis connection
57
    """
58
    return Redis(
59
        host=config.EMAIL_SENDER_REDIS_HOST,
60
        port=config.EMAIL_SENDER_REDIS_PORT,
61
        db=config.EMAIL_SENDER_REDIS_DB,
62
    )
63
64
65
def get_rq_queue(redis_connection: Redis, queue_name: str ='default') -> Queue:
66
    """
67
    :param queue_name: name of queue
68
    :return: wanted queue
69
    """
70
71
    return Queue(name=queue_name, connection=redis_connection)
72
73
74
def cmp_to_key(mycmp):
75
    """
76
    List sort related function
77
78
    Convert a cmp= function into a key= function
79
    """
80
    class K(object):
81
        def __init__(self, obj, *args):
82
            self.obj = obj
83
84
        def __lt__(self, other):
85
            return mycmp(self.obj, other.obj) < 0
86
87
        def __gt__(self, other):
88
            return mycmp(self.obj, other.obj) > 0
89
90
        def __eq__(self, other):
91
            return mycmp(self.obj, other.obj) == 0
92
93
        def __le__(self, other):
94
            return mycmp(self.obj, other.obj) <= 0
95
96
        def __ge__(self, other):
97
            return mycmp(self.obj, other.obj) >= 0
98
99
        def __ne__(self, other):
100
            return mycmp(self.obj, other.obj) != 0
101
102
    return K
103
104
105
def current_date_for_filename() -> str:
106
    """
107
    ISO8601 current date, adapted to be used in filename (for
108
    webdav feature for example), with trouble-free characters.
109
    :return: current date as string like "2018-03-19T15.49.27.246592"
110
    """
111
    # INFO - G.M - 19-03-2018 - As ':' is in transform_to_bdd method in
112
    # webdav utils, it may cause trouble. So, it should be replaced to
113
    # a character which will not change in bdd.
114
    return datetime.datetime.now().isoformat().replace(':', '.')
115
116
117
class Timezone(object):
118
    def __init__(self, name):
119
        self.name = name
120
121
122
def get_timezones_list() -> typing.List[Timezone]:
123
    tz_list = []
124
    for tz_name in pytz.common_timezones:
125
        tz_list.append(Timezone(tz_name))
126
    return tz_list
127
128
# INFO - G.M - 2018-08-02 - Simple password generator, inspired by
129
# https://gist.github.com/23maverick23/4131896
130
131
132
ALLOWED_AUTOGEN_PASSWORD_CHAR = string.ascii_letters + \
133
                                string.digits + \
134
                                string.punctuation
135
136
DEFAULT_PASSWORD_GEN_CHAR_LENGTH = 12
137
138
139
def password_generator(
140
        length: int=DEFAULT_PASSWORD_GEN_CHAR_LENGTH,
141
        chars: str=ALLOWED_AUTOGEN_PASSWORD_CHAR
142
) -> str:
143
    """
144
    :param length: length of the new password
145
    :param chars: characters allowed
146
    :return: password as string
147
    """
148
    return ''.join(random.choice(chars) for char_number in range(length))
149
150
151
def clamp(val: float, minimum: float = 0.0, maximum: float= 255.0) -> int:
152
    """ Fix value between min an max"""
153
    if val < minimum:
154
        return int(minimum)
155
    if val > maximum:
156
        return int(maximum)
157
    return int(val)
158
159
160
COLOR_DARKEN_SCALE_FACTOR = 0.85
161
COLOR_LIGHTEN_SCALE_FACTOR = 1.15
162
163
164
class Color(object):
165
    def __init__(self, base_hex_code: str):
166
        """
167
        :param base_hex_code: hex color like '#FFFFFF'
168
        """
169
170
        assert len(base_hex_code) == 7
171
        assert base_hex_code[0] == '#'
172
        self._base_hex_code = base_hex_code
173
174
    # INFO - G.M - 2018-08-10 - get_hexcolor, inspired by
175
    # https://thadeusb.com/weblog/2010/10/10/python_scale_hex_color/
176
177
    def get_hexcolor(self, scalefactor: float) -> str:
178
        """
179
180
        :param scalefactor: factor of scaling,
181
        value between 0 and 1 darken the color,
182
        value >1 lighten the color.
183
        :return: new hex_color
184
        """
185
186
        hex_color = self._base_hex_code.strip('#')
187
        assert scalefactor >= 0
188
189
        r = int(hex_color[:2], 16)
190
        g = int(hex_color[2:4], 16)
191
        b = int(hex_color[4:], 16)
192
193
        h, l, s = colorsys.rgb_to_hls(r, g, b)
194
        l = scalefactor * l
195
        r, g, b = colorsys.hls_to_rgb(h, l, s)
196
197
        return "#%02x%02x%02x" % (clamp(r), clamp(g), clamp(b))
198
199
    @property
200
    def normal(self):
201
        return self._base_hex_code
202
203
    @property
204
    def darken(self):
205
        return self.get_hexcolor(COLOR_DARKEN_SCALE_FACTOR)
206
207
    @property
208
    def lighten(self):
209
        return self.get_hexcolor(COLOR_LIGHTEN_SCALE_FACTOR)
210