Merge commit 'origin/translations' into experimental
[vuplus_dvbapp] / lib / python / Tools / Directories.py
1 # -*- coding: utf-8 -*-
2
3 from os import path as os_path, mkdir, rmdir, system, walk, stat as os_stat, listdir, readlink, makedirs, error as os_error, symlink, access, F_OK, R_OK, W_OK
4 from stat import S_IMODE
5 from re import compile
6
7 try:
8         from os import chmod
9         have_chmod = True
10 except:
11         have_chmod = False
12
13 try:
14         from os import utime
15         have_utime = True
16 except:
17         have_utime = False
18
19 SCOPE_TRANSPONDERDATA = 0
20 SCOPE_SYSETC = 1
21 SCOPE_FONTS = 2
22 SCOPE_SKIN = 3
23 SCOPE_SKIN_IMAGE = 4
24 SCOPE_USERETC = 5
25 SCOPE_CONFIG = 6
26 SCOPE_LANGUAGE = 7
27 SCOPE_HDD = 8
28 SCOPE_PLUGINS = 9
29 SCOPE_MEDIA = 10
30 SCOPE_PLAYLIST = 11
31 SCOPE_CURRENT_SKIN = 12
32 SCOPE_DEFAULTDIR = 13
33 SCOPE_DEFAULTPARTITION = 14
34 SCOPE_DEFAULTPARTITIONMOUNTDIR = 15
35 SCOPE_METADIR = 16
36 SCOPE_CURRENT_PLUGIN = 17
37
38 PATH_CREATE = 0
39 PATH_DONTCREATE = 1
40 PATH_FALLBACK = 2
41 defaultPaths = {
42                 SCOPE_TRANSPONDERDATA: ("/etc/", PATH_DONTCREATE),
43                 SCOPE_SYSETC: ("/etc/", PATH_DONTCREATE),
44                 SCOPE_FONTS: ("/usr/share/fonts/", PATH_DONTCREATE),
45                 SCOPE_CONFIG: ("/etc/enigma2/", PATH_CREATE),
46                 SCOPE_PLUGINS: ("/usr/lib/enigma2/python/Plugins/", PATH_CREATE),
47
48                 SCOPE_LANGUAGE: ("/usr/share/enigma2/po/", PATH_DONTCREATE),
49
50                 SCOPE_SKIN: ("/usr/share/enigma2/", PATH_DONTCREATE),
51                 SCOPE_SKIN_IMAGE: ("/usr/share/enigma2/", PATH_DONTCREATE),
52                 SCOPE_HDD: ("/hdd/movie/", PATH_DONTCREATE),
53                 SCOPE_MEDIA: ("/media/", PATH_DONTCREATE),
54                 SCOPE_PLAYLIST: ("/etc/enigma2/playlist/", PATH_CREATE),
55                 
56                 SCOPE_USERETC: ("", PATH_DONTCREATE), # user home directory
57                 
58                 SCOPE_DEFAULTDIR: ("/usr/share/enigma2/defaults/", PATH_CREATE),
59                 SCOPE_DEFAULTPARTITION: ("/dev/mtdblock/6", PATH_DONTCREATE),
60                 SCOPE_DEFAULTPARTITIONMOUNTDIR: ("/usr/share/enigma2/dealer", PATH_CREATE),
61                 SCOPE_METADIR: ("/usr/share/meta", PATH_CREATE),
62         }
63
64 FILE_COPY = 0 # copy files from fallback dir to the basedir
65 FILE_MOVE = 1 # move files
66 PATH_COPY = 2 # copy the complete fallback dir to the basedir
67 PATH_MOVE = 3 # move the fallback dir to the basedir (can be used for changes in paths)
68 fallbackPaths = {
69                 SCOPE_CONFIG: [("/home/root/", FILE_MOVE),
70                                            ("/usr/share/enigma2/defaults/", FILE_COPY)],
71                 SCOPE_HDD: [("/hdd/movies", PATH_MOVE)]
72         }
73
74 def resolveFilename(scope, base = "", path_prefix = None):
75         if base[0:2] == "~/":
76                 # you can only use the ~/ if we have a prefix directory
77                 assert path_prefix is not None
78                 base = os_path.join(path_prefix, base[2:])
79
80         # don't resolve absolute paths
81         if base[0:1] == '/':
82                 return base
83
84         if scope == SCOPE_CURRENT_SKIN:
85                 from Components.config import config
86                 tmp = defaultPaths[SCOPE_SKIN]
87                 pos = config.skin.primary_skin.value.rfind('/')
88                 if pos != -1:
89                         #if basefile is not available use default skin path as fallback
90                         tmpfile = tmp[0]+config.skin.primary_skin.value[:pos+1] + base
91                         if fileExists(tmpfile):
92                                 path = tmp[0]+config.skin.primary_skin.value[:pos+1]
93                         else:
94                                 path = tmp[0]
95                 else:
96                         path = tmp[0]
97
98         elif scope == SCOPE_CURRENT_PLUGIN:
99                 tmp = defaultPaths[SCOPE_PLUGINS]
100                 from Components.config import config
101                 skintmp = defaultPaths[SCOPE_SKIN]
102                 pos = config.skin.primary_skin.value.rfind('/')
103                 if pos != -1:
104                         #if basefile is not available inside current skin path, use the original provided file as fallback
105                         skintmpfile = skintmp[0]+config.skin.primary_skin.value[:pos+1] + base
106                         if fileExists(skintmpfile):
107                                 path = skintmp[0]+config.skin.primary_skin.value[:pos+1]
108                         else:
109                                 path = tmp[0]
110                 else:
111                         path = tmp[0]
112         else:
113                 tmp = defaultPaths[scope]
114                 path = tmp[0]
115
116         flags = tmp[1]
117
118         if flags == PATH_CREATE:
119                 if not pathExists(path):
120                         mkdir(path)
121
122         fallbackPath = fallbackPaths.get(scope)
123
124         if fallbackPath and not fileExists(path + base):
125                 for x in fallbackPath:
126                         if x[1] == FILE_COPY:
127                                 if fileExists(x[0] + base):
128                                         system("cp " + x[0] + base + " " + path + base)
129                                         break
130                         elif x[1] == FILE_MOVE:
131                                 if fileExists(x[0] + base):
132                                         system("mv " + x[0] + base + " " + path + base)
133                                         break
134                         elif x[1] == PATH_COPY:
135                                 if pathExists(x[0]):
136                                         if not pathExists(defaultPaths[scope][0]):
137                                                 mkdir(path)
138                                         system("cp -a " + x[0] + "* " + path)
139                                         break
140                         elif x[1] == PATH_MOVE:
141                                 if pathExists(x[0]):
142                                         system("mv " + x[0] + " " + path)
143                                         break
144
145         # FIXME: we also have to handle DATADIR etc. here.
146         return path + base
147         # this is only the BASE - an extension must be added later.
148
149 def pathExists(path):
150         return os_path.exists(path)
151
152 def isMount(path):
153         return os_path.ismount(path)
154
155 def createDir(path, makeParents = False):
156         try:
157                 if makeParents:
158                         makedirs(path)
159                 else:
160                         mkdir(path)
161         except:
162                 ret = 0
163         else:
164                 ret = 1
165         return ret
166
167 def removeDir(path):
168         try:
169                 rmdir(path)
170         except:
171                 ret = 0
172         else:
173                 ret = 1
174         return ret
175
176 def fileExists(f, mode='r'):
177         if mode == 'r':
178                 acc_mode = R_OK
179         elif mode == 'w':
180                 acc_mode = W_OK
181         else:
182                 acc_mode = F_OK
183         return access(f, acc_mode)
184
185 def getRecordingFilename(basename, dirname = None):
186         # filter out non-allowed characters
187         non_allowed_characters = "/.\\:*?<>|\""
188         filename = ""
189         
190         basename = basename.replace('\xc2\x86', '').replace('\xc2\x87', '')
191         
192         for c in basename:
193                 if c in non_allowed_characters or ord(c) < 32:
194                         c = "_"
195                 filename += c
196
197         if dirname is not None:
198                 filename = ''.join((dirname, filename))
199
200         while len(filename) > 240:
201                 filename = filename.decode('UTF-8')
202                 filename = filename[:-1]
203                 filename = filename.encode('UTF-8')
204
205         i = 0
206         while True:
207                 path = resolveFilename(SCOPE_HDD, filename)
208                 if i > 0:
209                         path += "_%03d" % i
210                 try:
211                         open(path + ".ts")
212                         i += 1
213                 except IOError:
214                         return path
215
216 # this is clearly a hack:
217 def InitFallbackFiles():
218         resolveFilename(SCOPE_CONFIG, "userbouquet.favourites.tv")
219         resolveFilename(SCOPE_CONFIG, "bouquets.tv")
220         resolveFilename(SCOPE_CONFIG, "userbouquet.favourites.radio")
221         resolveFilename(SCOPE_CONFIG, "bouquets.radio")
222
223 # returns a list of tuples containing pathname and filename matching the given pattern
224 # example-pattern: match all txt-files: ".*\.txt$"
225 def crawlDirectory(directory, pattern):
226         expression = compile(pattern)
227         list = []
228         for root, dirs, files in walk(directory):
229                 for file in files:
230                         if expression.match(file) is not None:
231                                 list.append((root, file))
232         return list
233
234 def copyfile(src, dst):
235         try:
236                 f1 = open(src, "rb")
237                 if os_path.isdir(dst):
238                         dst = os_path.join(dst, os_path.basename(src))
239                 f2 = open(dst, "w+b")
240                 while True:
241                         buf = f1.read(16*1024)
242                         if not buf:
243                                 break
244                         f2.write(buf)
245                 st = os_stat(src)
246                 mode = S_IMODE(st.st_mode)
247                 if have_chmod:
248                         chmod(dst, mode)
249                 if have_utime:
250                         utime(dst, (st.st_atime, st.st_mtime))
251         except:
252                 print "copy", src, "to", dst, "failed!"
253                 return -1
254         return 0
255
256 def copytree(src, dst, symlinks=False):
257         names = listdir(src)
258         if os_path.isdir(dst):
259                 dst = os_path.join(dst, os_path.basename(src))
260                 if not os_path.isdir(dst):
261                         mkdir(dst)
262         else:
263                 makedirs(dst)
264         for name in names:
265                 srcname = os_path.join(src, name)
266                 dstname = os_path.join(dst, name)
267                 try:
268                         if symlinks and os_path.islink(srcname):
269                                 linkto = readlink(srcname)
270                                 symlink(linkto, dstname)
271                         elif os_path.isdir(srcname):
272                                 copytree(srcname, dstname, symlinks)
273                         else:
274                                 copyfile(srcname, dstname)
275                 except:
276                         print "dont copy srcname (no file or link or folder)"
277         try:
278                 st = os_stat(src)
279                 mode = S_IMODE(st.st_mode)
280                 if have_chmod:
281                         chmod(dst, mode)
282                 if have_utime:
283                         utime(dst, (st.st_atime, st.st_mtime))
284         except:
285                 print "copy stats for", src, "failed!"
286
287 def getSize(path, pattern=".*"):
288         path_size = 0
289         if os_path.isdir(path):
290                 files = crawlDirectory(path, pattern)
291                 for file in files:
292                         filepath = os_path.join(file[0], file[1])
293                         path_size += os_path.getsize(filepath)
294         elif os_path.isfile(path):
295                 path_size = os_path.getsize(path)
296         return path_size