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
|
# -*- coding: utf-8 -*-
# prefixers.py
# Copyright (C) 2013 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/>.
"""
Platform dependant configuration path prefixers
"""
import os
import platform
from abc import ABCMeta, abstractmethod
from xdg import BaseDirectory
from leap.common.check import leap_assert
class Prefixer:
"""
Abstract prefixer class
"""
__metaclass__ = ABCMeta
@abstractmethod
def get_path_prefix(self, standalone=False):
"""
Returns the platform dependant path prefixer
@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 ""
def get_platform_prefixer():
prefixer = globals()[platform.system() + "Prefixer"]
leap_assert(prefixer, "Unimplemented platform prefixer: %s" %
(platform.system(),))
return prefixer()
class LinuxPrefixer(Prefixer):
"""
Config prefixer for the Linux platform
"""
def get_path_prefix(self, standalone=False):
"""
Returns the platform dependant path prefixer.
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
@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
"""
config_dir = BaseDirectory.xdg_config_home
if not standalone:
return config_dir
return os.path.join(os.getcwd(), "config")
class DarwinPrefixer(Prefixer):
"""
Config prefixer for the Darwin platform
"""
def get_path_prefix(self, standalone=False):
"""
Returns the platform dependant path prefixer.
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
@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
"""
config_dir = BaseDirectory.xdg_config_home
if not standalone:
return config_dir
return os.getenv("LEAP_CLIENT_PATH", config_dir)
class WindowsPrefixer(Prefixer):
"""
Config prefixer for the Windows platform
"""
def get_path_prefix(self, standalone=False):
"""
Returns the platform dependant path prefixer.
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
@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
"""
config_dir = BaseDirectory.xdg_config_home
if not standalone:
return config_dir
return os.path.join(os.getcwd(), "config")
if __name__ == "__main__":
try:
abs_prefixer = Prefixer()
except Exception as e:
assert isinstance(e, TypeError), "Something went wrong"
print "Abstract Prefixer class is working as expected"
linux_prefixer = LinuxPrefixer()
print linux_prefixer.get_path_prefix(standalone=True)
print linux_prefixer.get_path_prefix()
|
