filesystem.py 14.4 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
46

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

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

murban's avatar
murban committed
60
    def get_mime_type(self, filepath):
Marcel's avatar
Marcel committed
61
        filepath = self.expand(filepath)
62
63
64
65
        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
66
67
        if ext is not None and ext != "" and ext.lower(
        ) in FileSystem.ADDITIONAL_MIMES.keys():
68
69
70
            return FileSystem.ADDITIONAL_MIMES[ext]
        return None

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

Gero Müller's avatar
Gero Müller committed
96
97
98
    def get_file_list(self, path, deep=False,
                      filter=None, reverse=False,
                      hide_hidden=True, encode_json=True):
99
        filter = filter or []
100
        filelist = []
Marcel's avatar
Marcel committed
101
        path_expand = self.expand(path)
102
103
104
105
106
107
108
109
110
111
112
113
114
115
        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
116
117
118
                info = {
                    'name': elem
                }
119

Gero Müller's avatar
Gero Müller committed
120
                fullpath = os.path.join(path_expand, elem)
Gero Müller's avatar
Gero Müller committed
121
                stats = os.lstat(fullpath)
Gero Müller's avatar
Gero Müller committed
122
                is_symlink = stat.S_ISLNK(stats.st_mode)
Gero Müller's avatar
Gero Müller committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
                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
141
142

        # Determine the parent
Gero Müller's avatar
Gero Müller committed
143
        # parentpath = path_expand[:-1] if path_expand.endswith(os.sep) and
Gero Müller's avatar
Gero Müller committed
144
        #    path_expand != os.sep else path_expand
145
        parentpath = os.path.dirname(path_expand)
146
147
148
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
149
150
        else:
            return data
151

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

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

Marcel's avatar
Marcel committed
180
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
181
182
        # resort?
        if append_hidden:
Gero Müller's avatar
Gero Müller committed
183
184
            files = sorted(
                map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
185
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
186
187
188
189
            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
190
191
            if not suggestion.endswith(
                    '/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
192
193
194
                suggestion += '/'
            suggestions.append(suggestion)

195
        return suggestions if not encode_json else json.dumps(suggestions)
196

murban's avatar
murban committed
197
    def cut_slashs(self, path):
Marcel's avatar
Marcel committed
198
        path = self.expand(path)
murban's avatar
murban committed
199
        path = path[1:] if path.startswith(os.sep) else path
200
201
        if path == "":
            return path
murban's avatar
murban committed
202
        path = path[:-1] if path.endswith(os.sep) else path
203
204
        return path

murban's avatar
murban committed
205
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
206
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
207
208
        name = self.expand(name)

209
        # folder with the same name existent?
210
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
211
        fullpath = os.path.join(path, name)
212
213
214
        try:
            os.mkdir(fullpath)
        except Exception as e:
215
            # raise Exception("You don't have the permission to create this folder!")
216
217
            raise Exception(str(e))

murban's avatar
murban committed
218
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
219
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
220
221
        name = self.expand(name)

222
        # file with the same name existent?
223
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
224
        fullpath = os.path.join(path, name)
225
226
227
228
229
230
        try:
            f = file(fullpath, "w")
            f.close()
        except Exception as e:
            raise Exception(str(e))

231
    def rename(self, path, name, new_name, force=False):
Gero Müller's avatar
Gero Müller committed
232
233
234
235
        path = self.expand(path)
        name = self.expand(name)
        new_name = self.expand(new_name)

236
237
238
239
240
241
242
        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
243
        except Exception as e:
244
            return str(e)
245

murban's avatar
murban committed
246
247
    def remove(self, path):
        if isinstance(path, list):
248
249
250
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
251
252
253
254
255
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
256
257

    def compress(self, path, paths, name):
Gero Müller's avatar
Gero Müller committed
258
259
        # 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
260
        paths = [self.expand(p) for p in paths]
Gero Müller's avatar
Gero Müller committed
261
262
263

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

Gero Müller's avatar
Gero Müller committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
        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
285
286
                            ap = fullp[
                                len(path):] if fullp.startswith(path) else fullp
Gero Müller's avatar
Gero Müller committed
287
288
289
                            logger.debug(fullp)
                            archive.write(fullp, ap)
                else:
Martin Urban's avatar
Martin Urban committed
290
                    ap = p[len(path):] if p.startswith(path) else p
Gero Müller's avatar
Gero Müller committed
291
                    logger.debug(p)
Martin Urban's avatar
Martin Urban committed
292
                    archive.write(p, ap)
293

294
    def paste(self, path, fullsrc, cut):
Marcel's avatar
Marcel committed
295
        # TODO
296
297
298
299
        path = self.expand(path)
        if isinstance(fullsrc, (list, tuple)):
            for p in fullsrc:
                p = self.expand(p)
murban's avatar
murban committed
300
                self.paste(path, p, cut)
301
302
            return True

303
304
        # fulltarget = os.path.join(path, fullsrc.split(os.sep)[-1])
        logger.error("")
Gero Müller's avatar
Gero Müller committed
305
306
        target = self.handle_file_name_collision(
            fullsrc.split(os.sep)[-1], path)
307
        fulltarget = os.path.join(path, target)
308

309
310
        if os.path.isdir(fullsrc):
            shutil.copytree(fullsrc, fulltarget)
311
            if cut:
312
                shutil.rmtree(fullsrc)
313
        else:
314
            shutil.copy2(fullsrc, fulltarget)
315
            if cut:
316
                os.remove(fullsrc)
317

Marcel's avatar
Marcel committed
318
    def save_file(self, path, content, binary=False, force=True):
319
320
321
        logger.info(path)
        logger.info("\n\n")
        return
Marcel's avatar
Marcel committed
322
        path = self.expand(path)
Marcel's avatar
Marcel committed
323
        # check if file already exists
murban's avatar
murban committed
324
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
325
            return False
Marcel's avatar
Marcel committed
326
        if binary:
327
328
329
330
331
            out = file(path, "wb")
        else:
            out = file(path, "w")
        logger.info("saved")
        logger.info("\n\n")
Marcel's avatar
Marcel committed
332
        out.write(content)
333
        out.close()
Marcel's avatar
Marcel committed
334
        return True
335

Gero Müller's avatar
Gero Müller committed
336
    def save_file_content(self, filename, content,
Gero Müller's avatar
Gero Müller committed
337
                          path=None, force=True, append=False):
338
339
        # check write permissions
        # if not self.checkPermission(username, vPath, 'w'):
Gero Müller's avatar
Gero Müller committed
340
341
342
343
344
345
        #    return False, "Permission denied!"

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

346
        # check if file already exists
Gero Müller's avatar
Gero Müller committed
347
348
349
350
351
352
353
354
355
        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
356
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
357
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
358
        f = open(path, "rb")
359
360
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
361
        return content
362

Marcel's avatar
Marcel committed
363
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
364
        path = self.expand(path)
Marcel's avatar
Marcel committed
365
366
        return os.path.getmtime(path)

murban's avatar
murban committed
367
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
368
        path = self.expand(path)
369
        extension = path.split(".")[-1]
370
        return extension.lower() in FileSystem.BROWSER_EXTENSIONS
371

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

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

Marcel's avatar
Marcel committed
415
416
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
417

Gero Müller's avatar
Gero Müller committed
418
    def thumbnail(self, path, width=100, height=100, sharpen=True):
419
420
421
        path = self.expand(path)
        if HAVE_PIL:
            output = StringIO()
Gero Müller's avatar
Gero Müller committed
422
            img = Image.open(path)
Gero Müller's avatar
Gero Müller committed
423
            img.thumbnail((width, height), Image.ANTIALIAS)
Gero Müller's avatar
Gero Müller committed
424
            if sharpen:
425
                img.filter(ImageFilter.SHARPEN)
Gero Müller's avatar
Gero Müller committed
426
            img.save(output, "JPEG")
427
428
429
430
431
432
433
434
435
436
437
438
439
            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
440
441
442
443
444
445
446
447
def string_compare(a, b):
    if a == b:
        return 0
    elif a > b:
        return 1
    else:
        return -1

448

Marcel's avatar
Marcel committed
449
450
451
452
453
454
455
456
457
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