filesystem.py 12.9 KB
Newer Older
Marcel's avatar
Marcel committed
1
# -*- coding: utf-8 -*-
2

Marcel's avatar
Marcel committed
3
# imports
4
import os
5
import re
6
7
8
9
10
from datetime import datetime
import locale
import shutil
from mimetypes import guess_type
from zipfile import ZipFile
11
import json
Gero Müller's avatar
Gero Müller committed
12
import stat
13
import base64
14

15
16
17
import logging
logger = logging.getLogger(__name__)

18
19
20
class FileSystem(object):

    FILE_EXTENSIONS = ["png", "jpg", "jpeg", "bmp", "ps", "eps", "pdf", "txt", "xml", "py", "c", "cpp", "root", "pxlio"]
Marcel's avatar
Marcel committed
21
22
23
24
25
    BROWSER_EXTENSIONS = ["png", "jpg", "jpeg", "bmp"]
    ADDITIONAL_MIMES = {
        "pxlio": "text/plain",
        "root" : "text/plain"
    }
26
27
28
29
30

    def __init__(self):
        # allowed extensions
        self.allowed_extensions = FileSystem.FILE_EXTENSIONS

31
    def setup(self, basedir=None):
Marcel's avatar
Marcel committed
32
33
        if basedir is None:
            basedir = self.expand('~/')
murban's avatar
murban committed
34
        if not os.path.isdir(basedir):
Marcel's avatar
Marcel committed
35
            raise Exception("Basedir '%s' does not exist!" % basedir)
murban's avatar
murban committed
36
37
        # the basedir
        self.basedir = os.path.join(basedir, ".vispa")
38
39
40
41
42
        if os.path.isdir(self.basedir):
            return "Basedir already exists"
        else: 
            os.makedirs(self.basedir, 0700)
            return "Basedir now exists"
43

murban's avatar
murban committed
44
    def get_mime_type(self, filepath):
Marcel's avatar
Marcel committed
45
        filepath = self.expand(filepath)
46
47
48
49
50
51
52
53
        mime, encoding = guess_type(filepath)
        if mime is not None:
            return mime
        ext = filepath.split(".")[-1]
        if ext is not None and ext != "" and ext.lower() in FileSystem.ADDITIONAL_MIMES.keys():
            return FileSystem.ADDITIONAL_MIMES[ext]
        return None

murban's avatar
murban committed
54
    def check_file_extension(self, path, extensions=[]):
Marcel's avatar
Marcel committed
55
        path = self.expand(path)
56
57
58
59
60
61
62
63
        if (len(extensions) == 0):
            return True
        for elem in extensions:
            elem = elem if elem.startswith(".") else "." + elem
            if path.lower().endswith(elem.lower()):
                return True
        return False

Marcel's avatar
Marcel committed
64
65
    def exists(self, path, type=None):
        # type may be 'f' or 'd'
Marcel's avatar
Marcel committed
66
        path = self.expand(path)
67
68
        # path exists physically?
        if not os.path.exists(path):
Marcel's avatar
Marcel committed
69
70
            return None
        # type correct?
71
72
73
74
75
76
77
        target_type = 'd' if os.path.isdir(path) else 'f'
        if not type:
            return target_type
        type = type.lower()
        if type not in ['f', 'd']:
            return None
        return target_type if target_type == type else None
78

Gero Müller's avatar
Gero Müller committed
79
80
81
    def get_file_list(self, path, deep=False,
                      filter=None, reverse=False,
                      hide_hidden=True, encode_json=True):
82
        filter = filter or []
83
        filelist = []
Marcel's avatar
Marcel committed
84
        path_expand = self.expand(path)
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
        try:
            for elem in os.listdir(path_expand):
                # hide hidden files?
                if elem.startswith('.') and hide_hidden:
                    continue

                # excluded by filters?
                match = False
                for filter_elem in filter:
                    if re.search(filter_elem, elem):
                        match = True
                if match != reverse:
                    continue

                fullpath = os.path.join(path_expand, elem)

Gero Müller's avatar
Gero Müller committed
101
                stats = os.lstat(fullpath)
Gero Müller's avatar
Gero Müller committed
102
103
104
                is_symlink = stat.S_ISLNK(stats.st_mode)
                if is_symlink:
                    stats = os.stat(fullpath)
105
106
                size = stats.st_size
                mtime = stats.st_mtime
107

Gero Müller's avatar
Gero Müller committed
108
                if stat.S_ISDIR(stats.st_mode):
Gero Müller's avatar
Gero Müller committed
109
                    filelist.append({'name': elem, 'symlink': is_symlink, 'type': 'd', 'mtime': mtime, 'size': size})
110
111
112
                    if deep:
                        filelist.extend(self.get_file_list(fullpath, deep, filter, reverse))
                else:
Gero Müller's avatar
Gero Müller committed
113
                    filelist.append({'name': elem, 'symlink': is_symlink, 'type': 'f', 'mtime': mtime, 'size': size})
114
115
116
117
118
119
        except Exception, e:
            filelist.append({'warning': str(e)})

        # Determine the parent
        parentpath = path_expand[:-1] if path_expand.endswith(os.sep) and path_expand!=os.sep else path_expand
        parentpath = os.path.dirname(path_expand)
120
121
122
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
123
124
        else:
            return data
125

126
    def get_suggestions(self, path, length=1, append_hidden=True, encode_json=True):
Marcel's avatar
Marcel committed
127
128
129
        suggestions = []
        source, filter = None, None
        # does the path exist?
Marcel's avatar
Marcel committed
130
131
        path_expanded = self.expand(path)
        if os.path.exists(path_expanded):
Marcel's avatar
Marcel committed
132
            # dir case
Marcel's avatar
Marcel committed
133
            if os.path.isdir(path_expanded):
Marcel's avatar
Marcel committed
134
135
136
137
138
139
140
141
142
143
144
                if path.endswith('/'):
                    source = path
                else:
                    suggestions.append(path + os.sep)
                    return suggestions
            # file case
            else:
                return suggestions
        else:
            # try to estimate source and filter
            head, tail = os.path.split(path)
Marcel's avatar
Marcel committed
145
            if os.path.isdir(os.path.expanduser(os.path.expandvars(head))):
Marcel's avatar
Marcel committed
146
147
148
149
150
151
152
                source = head
                filter = tail

        # return empty suggestions when source is not set
        if not source:
            return suggestions

Marcel's avatar
Marcel committed
153
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
154
155
        # resort?
        if append_hidden:
156
            files = sorted(map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
157
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
158
159
160
161
            file = files.pop(0)
            if filter and not file.startswith(filter):
                continue
            suggestion = os.path.join(source, file)
Marcel's avatar
Marcel committed
162
            if not suggestion.endswith('/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
163
164
165
                suggestion += '/'
            suggestions.append(suggestion)

166
        return suggestions if not encode_json else json.dumps(suggestions)
167

murban's avatar
murban committed
168
    def cut_slashs(self, path):
Marcel's avatar
Marcel committed
169
        path = self.expand(path)
murban's avatar
murban committed
170
        path = path[1:] if path.startswith(os.sep) else path
171
172
        if path == "":
            return path
murban's avatar
murban committed
173
        path = path[:-1] if path.endswith(os.sep) else path
174
175
        return path

murban's avatar
murban committed
176
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
177
        path = self.expand(path)
178
        # folder with the same name existent?
179
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
180
        fullpath = os.path.join(path, name)
181
182
183
184
185
186
        try:
            os.mkdir(fullpath)
        except Exception as e:
            #raise Exception("You don't have the permission to create this folder!")
            raise Exception(str(e))

murban's avatar
murban committed
187
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
188
        path = self.expand(path)
189
        # file with the same name existent?
190
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
191
        fullpath = os.path.join(path, name)
192
193
194
195
196
197
        try:
            f = file(fullpath, "w")
            f.close()
        except Exception as e:
            raise Exception(str(e))

198
199
200
201
202
203
204
205
206
207
    def rename(self, path, name, new_name, force=False):
        try:
            if force == False:
                new_name = self.handle_file_name_collision(new_name, path)
            name = os.path.join(path, name)
            new_name = os.path.join(path, new_name)
            os.renames(name, new_name)
            return
        except Exception, e:
            return str(e)
208

murban's avatar
murban committed
209
210
    def remove(self, path):
        if isinstance(path, list):
211
212
213
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
214
215
216
217
218
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
219
220

    def compress(self, path, paths, name):
Martin Urban's avatar
Martin Urban committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        try:
            # paths has to be a list of strings
            paths = paths if isinstance(paths, (list, tuple)) else [paths]

            path = path if not path.endswith(os.sep) else path[:-1]

            name = name if name.endswith(".zip") else name + ".zip"
            name = self.handle_file_name_collision(name, path)

            fullpath = os.path.join(path, name)

            with ZipFile(fullpath, "w") as archive:
            # archive =  ZipFile(fullpath, "w")
                path = path if path.startswith(os.sep) else path
                for p in paths:
                    if p is None or p == "":
                        continue
                    p = p if p.startswith(os.sep) else os.sep + path
                    if os.path.isdir(p):
                        for elem in os.listdir(p):
                            fullp = os.path.join(p, elem)
                            if os.path.isdir(fullp):
                                paths.append(fullp)
                            else:
                                ap = fullp[len(path):] if fullp.startswith(path) else fullp
                                archive.write(fullp, ap)

                    ap = p[len(path):] if p.startswith(path) else p
                    archive.write(p, ap)
        # archive.close()
        except Exception, e:
            return str(e)
253

254
    def paste(self, path, fullsrc, cut):
Marcel's avatar
Marcel committed
255
        # TODO
256
257
258
259
        path = self.expand(path)
        if isinstance(fullsrc, (list, tuple)):
            for p in fullsrc:
                p = self.expand(p)
murban's avatar
murban committed
260
                self.paste(path, p, cut)
261
262
            return True

263
264
265
266
267
268
        # fulltarget = os.path.join(path, fullsrc.split(os.sep)[-1])
        logger.error("")
        target = self.handle_file_name_collision(fullsrc.split(os.sep)[-1], path)
        fulltarget = os.path.join(path, target)
        logger.error(cut)
        logger.error("")
269

270
271
        if os.path.isdir(fullsrc):
            shutil.copytree(fullsrc, fulltarget)
272
            if cut:
273
                shutil.rmtree(fullsrc)
274
        else:
275
            shutil.copy2(fullsrc, fulltarget)
276
            if cut:
277
                os.remove(fullsrc)
278

Marcel's avatar
Marcel committed
279
    def save_file(self, path, content, binary=False, force=True):
280
281
282
        logger.info(path)
        logger.info("\n\n")
        return
Marcel's avatar
Marcel committed
283
        path = self.expand(path)
Marcel's avatar
Marcel committed
284
        # check if file already exists
murban's avatar
murban committed
285
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
286
            return False
Marcel's avatar
Marcel committed
287
        if binary:
288
289
290
291
292
            out = file(path, "wb")
        else:
            out = file(path, "w")
        logger.info("saved")
        logger.info("\n\n")
Marcel's avatar
Marcel committed
293
        out.write(content)
294
        out.close()
Marcel's avatar
Marcel committed
295
        return True
296

Gero Müller's avatar
Gero Müller committed
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
    def save_file_content(self, filename, content,
                        path=None, force=True, append=False):
        #check write permissions
        #if not self.checkPermission(username, vPath, 'w'):
        #    return False, "Permission denied!"

        if path:
            filename = os.path.join(path, filename)
        filename = self.expand(filename)

        #check if file already exists
        if os.path.exists(filename) and not force:
            return False, "The file '%s' already exists!" % filename

        out = open(filename, "ab+" if append else "wb")
        out.write(content)
        out.close()

        return True, "File saved!"

murban's avatar
murban committed
317
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
318
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
319
        f = open(path, "rb")
320
321
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
322
        return content
323

Marcel's avatar
Marcel committed
324
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
325
        path = self.expand(path)
Marcel's avatar
Marcel committed
326
327
        return os.path.getmtime(path)

murban's avatar
murban committed
328
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
329
        path = self.expand(path)
330
        extension = path.split(".")[-1]
331
        return extension.lower() in FileSystem.BROWSER_EXTENSIONS
332

murban's avatar
murban committed
333
    def handle_file_name_collision(self, name, path):
334
        # collision?
murban's avatar
murban committed
335
        files = os.listdir(path)
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
        if name not in files:
            return name

        # when this line is reached, there is a collision!

        # cut the file extension
        extension = name.split(".")[-1]
        prename = None
        if name == extension:
            extension = ""
            prename = name
        else:
            prename = name.split("." + extension)[0]

        # has the name already a counter at its end?
        hasCounter = False
        preprename = None
        counter = prename.split("_")[-1]

        if counter != prename:
            try:
                counter = int(counter)
                hasCounter = True
                preprename = "_".join(prename.split("_")[:-1])
            except:
                pass

        if hasCounter:
            # increment and try again
            counter += 1
            newname = "%s_%d%s" % (preprename, counter, "" if extension == "" else "." + extension)
        else:
            newname = "%s_1%s" % (prename, "" if extension == "" else "." + extension)

        # return
murban's avatar
murban committed
371
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
372

Marcel's avatar
Marcel committed
373
374
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392

def string_compare(a, b):
    if a == b:
        return 0
    elif a > b:
        return 1
    else:
        return -1

def file_compare(a, b):
    if not a.startswith('.') and not b.startswith('.'):
        return string_compare(a, b)
    elif a.startswith('.') and b.startswith('.'):
        return string_compare(a, b)
    elif a.startswith('.') and not b.startswith('.'):
        return 1
    elif not a.startswith('.') and b.startswith('.'):
        return -1