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
|
# GNU Solfege - free ear training software
# Copyright (C) 2005, 2006, 2007, 2008 Tom Cato Amundsen
#
# 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/>.
r"""
linux win 3.8 win 3.9
~ C:\D&S\User
~/.solfegerc C:\D&S\User\.solfegerc %APPDATA\GNU Solfege\solfegerc
~/.solfege C:\D&S\USer\.solfege %APPDATA%\GNU Solfege
~/.solfege/trainingsets C:\D&S\User\.solfege\trainingsets My Documents\GNU Solfege\trainingsets
~/.solfege/eartr.tests C:\D&S\User\.solfege\eartr.tests My Documents\GNU Solfege\eartr.tests
~/lessonfiles C:\D&S\User\lessonfiles My Documents\GNU Solfege\lessonfiles
We need more functions that I would prefer because we still have ~/.solfegerc
and ~/lessonfiles on linux. user_lessonfiles() could have been unnecessary
if ~/lessonfiles moved to ~/.solfege/lessonfiles
MSWIN: app_data() => %APPDATA%\GNU Solfege
rcfile() => app_data()\solfegerc
user_data() => MyDocuments\GNU Solfege
user_lessonfiles() => user_data()/lessonfiles
Linux: app_data() => ~/.solfege
rcfile() => ~/.solfegerc
user_data() => app_data()
user_lessonfiles() => ~/lessonfiles
Example locations:
app_data()/learningtrees
app_data()/testresults
app_data()/statistics
user_data()/trainingsets
user_data()/eartrainingtests
"""
import os
import sys
import locale
if sys.platform == 'win32':
import winreg
# This name will be used as folder name on MS Windows, to create one
# folder in the "My Documents" folder, and one folder in "Application Data"
appname = "GNU Solfege"
def _get_home_dir():
''' Try to find user's home directory, otherwise return current directory.'''
path1 = os.path.expanduser("~")
try:
path2 = os.environ["HOME"]
except KeyError:
path2 = ""
try:
path3 = os.environ["USERPROFILE"]
except KeyError:
path3 = ""
if not os.path.exists(path1):
if not os.path.exists(path2):
if not os.path.exists(path3):
return getcwd()
else: return path3
else: return path2
else: return path1
def _win32_unicode_decode(s):
enc = sys.getfilesystemencoding()
if enc is None or enc == "":
enc = "iso-8859-1"
try:
return s.decode(enc)
except UnicodeDecodeError:
try:
return s.decode(locale.getpreferredencoding())
except UnicodeDecodeError:
return s.decode("iso-8859-1")
def get_home_dir():
if sys.platform == 'win32':
return _win32_unicode_decode(_get_home_dir())
else:
# linux user names can only be ascii chars.
return _get_home_dir().decode("iso-8859-1")
#FIXME remove??
def expanduser(s):
return s.replace("~", get_home_dir())
def user_data(dir=None):
"""
Return the full path name of a directory where solfege by default will suggest to
place the directories trainingsets/ eartrainingtests/
"""
if sys.platform == "win32":
return os.path.join(winreg._get_reg_user_value(winreg.SHELL_FOLDERS, 'Personal'), appname)
else:
return os.path.expanduser("~/.solfege")
def user_lessonfiles():
"""
Return the directory where the user should save the locally created
lesson files.
"""
if sys.platform == "win32":
return os.path.join(user_data(), "lessonfiles")
else:
return os.path.expanduser("~/lessonfiles")
def rcfile():
"""
Return the full name of the users rc file.
"""
if sys.platform == "win32":
return os.path.join(winreg.get_appdata(), appname, "solfegerc")
else:
return os.path.expanduser("~/.solfegerc")
def app_data():
"""
Return the full path name of the directory that will contain
statistics/ testresults/ and learningtress/ (and possible more).
"""
if sys.platform == "win32":
return os.path.join(winreg.get_appdata(), appname)
else:
return os.path.expanduser("~/.solfege")
|