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

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

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

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

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

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

Marcel's avatar
Marcel committed
178
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
179
180
        # resort?
        if append_hidden:
181
            files = sorted(map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
182
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
183
184
185
186
            file = files.pop(0)
            if filter and not file.startswith(filter):
                continue
            suggestion = os.path.join(source, file)
Marcel's avatar
Marcel committed
187
            if not suggestion.endswith('/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
188
189
190
                suggestion += '/'
            suggestions.append(suggestion)

191
        return suggestions if not encode_json else json.dumps(suggestions)
192

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

murban's avatar
murban committed
201
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
202
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
203
204
        name = self.expand(name)

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

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

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

227
    def rename(self, path, name, new_name, force=False):
Gero Müller's avatar
Gero Müller committed
228
229
230
231
        path = self.expand(path)
        name = self.expand(name)
        new_name = self.expand(new_name)

232
233
234
235
236
237
238
239
240
        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)
241

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

    def compress(self, path, paths, name):
Gero Müller's avatar
Gero Müller committed
254
255
256
257
258
        # 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]
        path = self.expand(path)
Martin Urban's avatar
Martin Urban committed
259

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

288
    def paste(self, path, fullsrc, cut):
Marcel's avatar
Marcel committed
289
        # TODO
290
291
292
293
        path = self.expand(path)
        if isinstance(fullsrc, (list, tuple)):
            for p in fullsrc:
                p = self.expand(p)
murban's avatar
murban committed
294
                self.paste(path, p, cut)
295
296
            return True

297
298
299
300
301
302
        # 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("")
303

304
305
        if os.path.isdir(fullsrc):
            shutil.copytree(fullsrc, fulltarget)
306
            if cut:
307
                shutil.rmtree(fullsrc)
308
        else:
309
            shutil.copy2(fullsrc, fulltarget)
310
            if cut:
311
                os.remove(fullsrc)
312

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

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

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

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

Marcel's avatar
Marcel committed
358
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
359
        path = self.expand(path)
Marcel's avatar
Marcel committed
360
361
        return os.path.getmtime(path)

murban's avatar
murban committed
362
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
363
        path = self.expand(path)
364
        extension = path.split(".")[-1]
365
        return extension.lower() in FileSystem.BROWSER_EXTENSIONS
366

murban's avatar
murban committed
367
    def handle_file_name_collision(self, name, path):
368
        # collision?
murban's avatar
murban committed
369
        files = os.listdir(path)
370
371
372
373
374
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
            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
405
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
406

Marcel's avatar
Marcel committed
407
408
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
409

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

440

Marcel's avatar
Marcel committed
441
442
443
444
445
446
447
448
449
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