filesystem.py 14.1 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
115
116
        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
117
                stats = os.lstat(fullpath)
Gero Müller's avatar
Gero Müller committed
118
                is_symlink = stat.S_ISLNK(stats.st_mode)
Gero Müller's avatar
Gero Müller committed
119
                if is_symlink and os.path.exists(fullpath):
Gero Müller's avatar
Gero Müller committed
120
                    stats = os.stat(fullpath)
121
122
                size = stats.st_size
                mtime = stats.st_mtime
123

Gero Müller's avatar
Gero Müller committed
124
                #TODO: send realpath and/or broken link
Gero Müller's avatar
Gero Müller committed
125
                if stat.S_ISDIR(stats.st_mode):
Gero Müller's avatar
Gero Müller committed
126
                    filelist.append({'name': elem, 'symlink': is_symlink, 'type': 'd', 'mtime': mtime, 'size': size})
127
128
129
                    if deep:
                        filelist.extend(self.get_file_list(fullpath, deep, filter, reverse))
                else:
Gero Müller's avatar
Gero Müller committed
130
                    filelist.append({'name': elem, 'symlink': is_symlink, 'type': 'f', 'mtime': mtime, 'size': size})
131
132
133
134
        except Exception, e:
            filelist.append({'warning': str(e)})

        # Determine the parent
135
        parentpath = path_expand[:-1] if path_expand.endswith(os.sep) and path_expand != os.sep else path_expand
136
        parentpath = os.path.dirname(path_expand)
137
138
139
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
140
141
        else:
            return data
142

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

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

Marcel's avatar
Marcel committed
170
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
171
172
        # resort?
        if append_hidden:
173
            files = sorted(map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
174
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
175
176
177
178
            file = files.pop(0)
            if filter and not file.startswith(filter):
                continue
            suggestion = os.path.join(source, file)
Marcel's avatar
Marcel committed
179
            if not suggestion.endswith('/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
180
181
182
                suggestion += '/'
            suggestions.append(suggestion)

183
        return suggestions if not encode_json else json.dumps(suggestions)
184

murban's avatar
murban committed
185
    def cut_slashs(self, path):
Marcel's avatar
Marcel committed
186
        path = self.expand(path)
murban's avatar
murban committed
187
        path = path[1:] if path.startswith(os.sep) else path
188
189
        if path == "":
            return path
murban's avatar
murban committed
190
        path = path[:-1] if path.endswith(os.sep) else path
191
192
        return path

murban's avatar
murban committed
193
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
194
        path = self.expand(path)
195
        # folder with the same name existent?
196
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
197
        fullpath = os.path.join(path, name)
198
199
200
        try:
            os.mkdir(fullpath)
        except Exception as e:
201
            # raise Exception("You don't have the permission to create this folder!")
202
203
            raise Exception(str(e))

murban's avatar
murban committed
204
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
205
        path = self.expand(path)
206
        # file with the same name existent?
207
        name = self.handle_file_name_collision(name, path)
Marcel's avatar
Marcel committed
208
        fullpath = os.path.join(path, name)
209
210
211
212
213
214
        try:
            f = file(fullpath, "w")
            f.close()
        except Exception as e:
            raise Exception(str(e))

215
216
217
218
219
220
221
222
223
224
    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)
225

murban's avatar
murban committed
226
227
    def remove(self, path):
        if isinstance(path, list):
228
229
230
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
231
232
233
234
235
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
236
237

    def compress(self, path, paths, name):
Martin Urban's avatar
Martin Urban committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
        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)
270

271
    def paste(self, path, fullsrc, cut):
Marcel's avatar
Marcel committed
272
        # TODO
273
274
275
276
        path = self.expand(path)
        if isinstance(fullsrc, (list, tuple)):
            for p in fullsrc:
                p = self.expand(p)
murban's avatar
murban committed
277
                self.paste(path, p, cut)
278
279
            return True

280
281
282
283
284
285
        # 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("")
286

287
288
        if os.path.isdir(fullsrc):
            shutil.copytree(fullsrc, fulltarget)
289
            if cut:
290
                shutil.rmtree(fullsrc)
291
        else:
292
            shutil.copy2(fullsrc, fulltarget)
293
            if cut:
294
                os.remove(fullsrc)
295

Marcel's avatar
Marcel committed
296
    def save_file(self, path, content, binary=False, force=True):
297
298
299
        logger.info(path)
        logger.info("\n\n")
        return
Marcel's avatar
Marcel committed
300
        path = self.expand(path)
Marcel's avatar
Marcel committed
301
        # check if file already exists
murban's avatar
murban committed
302
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
303
            return False
Marcel's avatar
Marcel committed
304
        if binary:
305
306
307
308
309
            out = file(path, "wb")
        else:
            out = file(path, "w")
        logger.info("saved")
        logger.info("\n\n")
Marcel's avatar
Marcel committed
310
        out.write(content)
311
        out.close()
Marcel's avatar
Marcel committed
312
        return True
313

Gero Müller's avatar
Gero Müller committed
314
315
    def save_file_content(self, filename, content,
                        path=None, force=True, append=False):
316
317
        # check write permissions
        # if not self.checkPermission(username, vPath, 'w'):
Gero Müller's avatar
Gero Müller committed
318
319
320
321
322
323
        #    return False, "Permission denied!"

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

324
        # check if file already exists
Gero Müller's avatar
Gero Müller committed
325
326
327
328
329
330
331
332
333
        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
334
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
335
        path = self.expand(path)
Gero Müller's avatar
Gero Müller committed
336
        f = open(path, "rb")
337
338
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
339
        return content
340

Marcel's avatar
Marcel committed
341
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
342
        path = self.expand(path)
Marcel's avatar
Marcel committed
343
344
        return os.path.getmtime(path)

murban's avatar
murban committed
345
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
346
        path = self.expand(path)
347
        extension = path.split(".")[-1]
348
        return extension.lower() in FileSystem.BROWSER_EXTENSIONS
349

murban's avatar
murban committed
350
    def handle_file_name_collision(self, name, path):
351
        # collision?
murban's avatar
murban committed
352
        files = os.listdir(path)
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
        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
388
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
389

Marcel's avatar
Marcel committed
390
391
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
392

Gero Müller's avatar
Gero Müller committed
393
    def thumbnail(self, path, width=100, height=100, sharpen=True):
394
395
396
        path = self.expand(path)
        if HAVE_PIL:
            output = StringIO()
Gero Müller's avatar
Gero Müller committed
397
            img = Image.open(path)
Gero Müller's avatar
Gero Müller committed
398
            img.thumbnail((width, height), Image.ANTIALIAS)
Gero Müller's avatar
Gero Müller committed
399
            if sharpen:
400
                img.filter(ImageFilter.SHARPEN)
Gero Müller's avatar
Gero Müller committed
401
            img.save(output, "JPEG")
402
403
404
405
406
407
408
409
410
411
412
413
414
            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
415
416
417
418
419
420
421
422
def string_compare(a, b):
    if a == b:
        return 0
    elif a > b:
        return 1
    else:
        return -1

423

Marcel's avatar
Marcel committed
424
425
426
427
428
429
430
431
432
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