summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/vpn/utils.py
blob: 51f24d9bb9a067e739bfb47c2cfe449052e25b56 (plain)
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
# -*- coding: utf-8 -*-
# util.py
# Copyright (C) 2013-2017 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
Common utils
"""

import os


def get_path_prefix(standalone=False):
    """
    Returns the platform dependent path prefix.

    :param standalone: if True it will return the prefix for a standalone
                       application.
                       Otherwise, it will return the system default for
                       configuration storage.
    :type standalone: bool
    """
    return os.path.expanduser("~/.config")  # hardcoded Linux XDG config path

    # TODO: this is to use XDG specifications
    # commented temporarily to avoid that extra dependency

    # config_home = get_xdg_config_home()
    # if standalone:
    #     config_home = os.path.join(os.getcwd(), "config")
    #
    # return config_home


def force_eval(items):
    """
    Return a sequence that evaluates any callable in the sequence,
    instantiating it beforehand if the item is a class, and
    leaves the non-callable items without change.
    """
    def do_eval(thing):
        if isinstance(thing, type):
            return thing()()
        if callable(thing):
            return thing()
        return thing

    if isinstance(items, (list, tuple)):
        return map(do_eval, items)
    else:
        return do_eval(items)


def first(things):
    """
    Return the head of a collection.

    :param things: a sequence to extract the head from.
    :type things: sequence
    :return: object, or None
    """
    try:
        return things[0]
    except (IndexError, TypeError):
        return None


def get_vpn_launcher():
    """
    Return the VPN launcher for the current platform.
    """
    from leap.bitmask.vpn.constants import IS_LINUX, IS_MAC, IS_WIN

    if not (IS_LINUX or IS_MAC or IS_WIN):
        error_msg = "VPN Launcher not implemented for this platform."
        raise NotImplementedError(error_msg)

    launcher = None
    if IS_LINUX:
        from leap.bitmask.vpn.launchers.linux import LinuxVPNLauncher
        launcher = LinuxVPNLauncher
    elif IS_MAC:
        from leap.bitmask.vpn.launchers.darwin import DarwinVPNLauncher
        launcher = DarwinVPNLauncher
    elif IS_WIN:
        from leap.bitmask.vpn.launchers.windows import WindowsVPNLauncher
        launcher = WindowsVPNLauncher

    if launcher is None:
        raise Exception("Launcher is None")

    return launcher()