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

Marcel's avatar
Marcel committed
3
# imports
4
5
from StringIO import StringIO
from distutils.spawn import find_executable
6
7
from mimetypes import guess_type
from zipfile import ZipFile
8
import json
9
10
11
12
import logging
import os
import re
import shutil
Gero Müller's avatar
Gero Müller committed
13
import stat
14
15
16
17
import subprocess

try:
    import Image
Gero Müller's avatar
Gero Müller committed
18
    import ImageFilter
19
20
21
22
23
24
25
26
27
28
    HAVE_PIL = True
except:
    HAVE_PIL = False

if not HAVE_PIL:
    convert_executable = find_executable('convert')
    if convert_executable and os.path.isfile(convert_executable):
        HAVE_CONVERT = True
    else:
        HAVE_CONVERT = False
29

30
31
logger = logging.getLogger(__name__)

32

33
34
class FileSystem(object):

35
36
    FILE_EXTENSIONS = ["png", "jpg", "jpeg", "bmp", "ps", "eps", "pdf",
                       "txt", "xml", "py", "c", "cpp", "root", "pxlio"]
Marcel's avatar
Marcel committed
37
38
39
    BROWSER_EXTENSIONS = ["png", "jpg", "jpeg", "bmp"]
    ADDITIONAL_MIMES = {
        "pxlio": "text/plain",
40
        "root": "text/plain"
Marcel's avatar
Marcel committed
41
    }
42
43
44
45

    def __init__(self):
        # allowed extensions
        self.allowed_extensions = FileSystem.FILE_EXTENSIONS
46
        self.browser_extensions = FileSystem.BROWSER_EXTENSIONS
47

48
    def setup(self, basedir=None):
Marcel's avatar
Marcel committed
49
50
        if basedir is None:
            basedir = self.expand('~/')
murban's avatar
murban committed
51
        if not os.path.isdir(basedir):
Marcel's avatar
Marcel committed
52
            raise Exception("Basedir '%s' does not exist!" % basedir)
murban's avatar
murban committed
53
54
        # the basedir
        self.basedir = os.path.join(basedir, ".vispa")
55
56
        if os.path.isdir(self.basedir):
            return "Basedir already exists"
57
        else:
Gero Müller's avatar
Gero Müller committed
58
            os.makedirs(self.basedir, 0o700)
59
            return "Basedir now exists"
60

murban's avatar
murban committed
61
    def get_mime_type(self, filepath):
Marcel's avatar
Marcel committed
62
        filepath = self.expand(filepath)
63
64
65
66
        mime, encoding = guess_type(filepath)
        if mime is not None:
            return mime
        ext = filepath.split(".")[-1]
Gero Müller's avatar
Gero Müller committed
67
68
        if ext is not None and ext != "" and ext.lower(
        ) in FileSystem.ADDITIONAL_MIMES.keys():
69
70
71
            return FileSystem.ADDITIONAL_MIMES[ext]
        return None

murban's avatar
murban committed
72
    def check_file_extension(self, path, extensions=[]):
Marcel's avatar
Marcel committed
73
        path = self.expand(path)
74
75
76
77
78
79
80
81
        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
82
83
    def exists(self, path, type=None):
        # type may be 'f' or 'd'
Marcel's avatar
Marcel committed
84
        path = self.expand(path)
85
86
        # path exists physically?
        if not os.path.exists(path):
Marcel's avatar
Marcel committed
87
88
            return None
        # type correct?
89
90
91
92
93
94
95
        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
96

97
98
99
100
101
102
103
    def get_file_count(self, path):
        path = self.expand(path)
        if os.path.exists(path):
            return len(os.listdir(path))
        else:
            return -1

Gero Müller's avatar
Gero Müller committed
104
105
106
    def get_file_list(self, path, deep=False,
                      filter=None, reverse=False,
                      hide_hidden=True, encode_json=True):
107
        filter = filter or []
108
        filelist = []
Marcel's avatar
Marcel committed
109
        path_expand = self.expand(path)
110
111
112
113
114
115
116
117
118
119
120
121
122
123
        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

Gero Müller's avatar
Gero Müller committed
124
125
126
                info = {
                    'name': elem
                }
127

Gero Müller's avatar
Gero Müller committed
128
                fullpath = os.path.join(path_expand, elem)
Gero Müller's avatar
Gero Müller committed
129
                stats = os.lstat(fullpath)
Gero Müller's avatar
Gero Müller committed
130
                is_symlink = stat.S_ISLNK(stats.st_mode)
Gero Müller's avatar
Gero Müller committed
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
                if is_symlink:
                    realfullpath = os.path.realpath(fullpath)
                    info.update({'symlink': True, 'realpath': realfullpath})
                    if os.path.exists(realfullpath):
                        stats = os.stat(realfullpath)

                info.update({
                    'size': stats.st_size,
                    'mtime': stats.st_mtime,
                    'type': 'd' if stat.S_ISDIR(stats.st_mode) else 'f'
                })

                filelist.append(info)
                if deep:
                    filelist.extend(self.get_file_list(fullpath, deep,
                                                       filter, reverse))
        except:
            pass
149
150

        # Determine the parent
Gero Müller's avatar
Gero Müller committed
151
        # parentpath = path_expand[:-1] if path_expand.endswith(os.sep) and
Gero Müller's avatar
Gero Müller committed
152
        #    path_expand != os.sep else path_expand
153
        parentpath = os.path.dirname(path_expand)
154
155
156
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
157
158
        else:
            return data
159

Gero Müller's avatar
Gero Müller committed
160
161
    def get_suggestions(
            self, path, length=1, append_hidden=True, encode_json=True):
Marcel's avatar
Marcel committed
162
163
164
        suggestions = []
        source, filter = None, None
        # does the path exist?
Marcel's avatar
Marcel committed
165
166
        path_expanded = self.expand(path)
        if os.path.exists(path_expanded):
Marcel's avatar
Marcel committed
167
            # dir case
Marcel's avatar
Marcel committed
168
            if os.path.isdir(path_expanded):
Marcel's avatar
Marcel committed
169
170
171
172
173
174
175
176
177
178
179
                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
180
            if os.path.isdir(os.path.expanduser(os.path.expandvars(head))):
Marcel's avatar
Marcel committed
181
182
183
184
185
186
187
                source = head
                filter = tail

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

Marcel's avatar
Marcel committed
188
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
189
190
        # resort?
        if append_hidden:
Gero Müller's avatar
Gero Müller committed
191
192
            files = sorted(
                map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
193
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
194
195
196
197
            file = files.pop(0)
            if filter and not file.startswith(filter):
                continue
            suggestion = os.path.join(source, file)
Gero Müller's avatar
Gero Müller committed
198
199
            if not suggestion.endswith(
                    '/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
200
201
202
                suggestion += '/'
            suggestions.append(suggestion)

203
        return suggestions if not encode_json else json.dumps(suggestions)
204

murban's avatar
murban committed
205
    def cut_slashs(self, path):
Marcel's avatar
Marcel committed
206
        path = self.expand(path)
murban's avatar
murban committed
207
        path = path[1:] if path.startswith(os.sep) else path
208
209
        if path == "":
            return path
murban's avatar
murban committed
210
        path = path[:-1] if path.endswith(os.sep) else path
211
212
        return path

murban's avatar
murban committed
213
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
214
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
215
216
        name = self.expand(name)

217
        # folder with the same name existent?
218
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
219
        fullpath = os.path.join(path, name)
220
221
222
        try:
            os.mkdir(fullpath)
        except Exception as e:
223
            # raise Exception("You don't have the permission to create this folder!")
224
225
            raise Exception(str(e))

murban's avatar
murban committed
226
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
227
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
228
229
        name = self.expand(name)

230
        # file with the same name existent?
231
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
232
        fullpath = os.path.join(path, name)
233
234
235
236
237
238
        try:
            f = file(fullpath, "w")
            f.close()
        except Exception as e:
            raise Exception(str(e))

239
    def rename(self, path, name, new_name, force=False):
Gero Müller's avatar
Gero Müller committed
240
241
242
243
        path = self.expand(path)
        name = self.expand(name)
        new_name = self.expand(new_name)

244
245
246
247
248
249
250
        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
Gero Müller's avatar
Gero Müller committed
251
        except Exception as e:
252
            return str(e)
253

murban's avatar
murban committed
254
255
    def remove(self, path):
        if isinstance(path, list):
256
257
258
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
259
260
261
262
263
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
264
265

    def compress(self, path, paths, name):
Gero Müller's avatar
Gero Müller committed
266
267
        # paths has to be a list of strings
        paths = paths if isinstance(paths, (list, tuple)) else [paths]
Gero Müller's avatar
Gero Müller committed
268
        paths = [self.expand(p) for p in paths]
Gero Müller's avatar
Gero Müller committed
269
270
271

        path = path if not path.endswith(os.sep) else path[:-1]
        path = self.expand(path)
Martin Urban's avatar
Martin Urban committed
272

Gero Müller's avatar
Gero Müller committed
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
        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:
            i = 0
            while i < len(paths):
                if not paths[i]:
                    i += 1
                    continue
                p = self.expand(paths[i])
                i += 1

                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:
Gero Müller's avatar
Gero Müller committed
293
294
                            ap = fullp[
                                len(path):] if fullp.startswith(path) else fullp
Gero Müller's avatar
Gero Müller committed
295
296
297
                            logger.debug(fullp)
                            archive.write(fullp, ap)
                else:
Martin Urban's avatar
Martin Urban committed
298
                    ap = p[len(path):] if p.startswith(path) else p
Gero Müller's avatar
Gero Müller committed
299
                    logger.debug(p)
Martin Urban's avatar
Martin Urban committed
300
                    archive.write(p, ap)
301

302
    def paste(self, path, fullsrc, cut):
Marcel's avatar
Marcel committed
303
        # TODO
304
305
306
307
        path = self.expand(path)
        if isinstance(fullsrc, (list, tuple)):
            for p in fullsrc:
                p = self.expand(p)
murban's avatar
murban committed
308
                self.paste(path, p, cut)
309
310
            return True

311
312
        # fulltarget = os.path.join(path, fullsrc.split(os.sep)[-1])
        logger.error("")
Gero Müller's avatar
Gero Müller committed
313
314
        target = self.handle_file_name_collision(
            fullsrc.split(os.sep)[-1], path)
315
        fulltarget = os.path.join(path, target)
316

317
318
        if os.path.isdir(fullsrc):
            shutil.copytree(fullsrc, fulltarget)
319
            if cut:
320
                shutil.rmtree(fullsrc)
321
        else:
322
            shutil.copy2(fullsrc, fulltarget)
323
            if cut:
324
                os.remove(fullsrc)
325

Marcel's avatar
Marcel committed
326
    def save_file(self, path, content, binary=False, force=True):
327
328
329
        logger.info(path)
        logger.info("\n\n")
        return
Marcel's avatar
Marcel committed
330
        path = self.expand(path)
Marcel's avatar
Marcel committed
331
        # check if file already exists
murban's avatar
murban committed
332
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
333
            return False
Marcel's avatar
Marcel committed
334
        if binary:
335
336
337
338
339
            out = file(path, "wb")
        else:
            out = file(path, "w")
        logger.info("saved")
        logger.info("\n\n")
Marcel's avatar
Marcel committed
340
        out.write(content)
341
        out.close()
Marcel's avatar
Marcel committed
342
        return True
343

Gero Müller's avatar
Gero Müller committed
344
    def save_file_content(self, filename, content,
Gero Müller's avatar
Gero Müller committed
345
                          path=None, force=True, append=False):
346
347
        # check write permissions
        # if not self.checkPermission(username, vPath, 'w'):
Gero Müller's avatar
Gero Müller committed
348
349
350
351
352
353
        #    return False, "Permission denied!"

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

354
        # check if file already exists
Gero Müller's avatar
Gero Müller committed
355
356
357
358
359
360
361
362
363
        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
364
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
365
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
366
        f = open(path, "rb")
367
368
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
369
        return content
370

Marcel's avatar
Marcel committed
371
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
372
        path = self.expand(path)
Marcel's avatar
Marcel committed
373
374
        return os.path.getmtime(path)

murban's avatar
murban committed
375
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
376
        path = self.expand(path)
377
        extension = path.split(".")[-1]
378
        return extension.lower() in FileSystem.BROWSER_EXTENSIONS
379

murban's avatar
murban committed
380
    def handle_file_name_collision(self, name, path):
381
        # collision?
murban's avatar
murban committed
382
        files = os.listdir(path)
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
        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
Gero Müller's avatar
Gero Müller committed
413
414
415
            newname = "%s_%d%s" % (preprename,
                                   counter,
                                   "" if extension == "" else "." + extension)
416
        else:
Gero Müller's avatar
Gero Müller committed
417
418
            newname = "%s_1%s" % (
                prename, "" if extension == "" else "." + extension)
419
420

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

Marcel's avatar
Marcel committed
423
424
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
425

Gero Müller's avatar
Gero Müller committed
426
    def thumbnail(self, path, width=100, height=100, sharpen=True):
427
428
429
        path = self.expand(path)
        if HAVE_PIL:
            output = StringIO()
Gero Müller's avatar
Gero Müller committed
430
            img = Image.open(path)
Gero Müller's avatar
Gero Müller committed
431
            img.thumbnail((width, height), Image.ANTIALIAS)
Gero Müller's avatar
Gero Müller committed
432
            if sharpen:
433
                img.filter(ImageFilter.SHARPEN)
Gero Müller's avatar
Gero Müller committed
434
            img.save(output, "JPEG")
435
436
437
438
439
440
441
442
443
444
445
446
447
            contents = output.getvalue()
            output.close()
            return contents
        elif HAVE_CONVERT:
            cmd = ['convert', path,
                   '-thumbnail', '%dx%d' % (width, height),
                   'jpeg:-']
            p = subprocess.Popen(cmd, stdin=None, stdout=subprocess.PIPE)
            return p.communicate()[0]
        else:
            return self.get_file_content(path)


Marcel's avatar
Marcel committed
448
449
450
451
452
453
454
455
def string_compare(a, b):
    if a == b:
        return 0
    elif a > b:
        return 1
    else:
        return -1

456

Marcel's avatar
Marcel committed
457
458
459
460
461
462
463
464
465
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