filesystem.py 11.3 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

class FileSystem(object):

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

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

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

murban's avatar
murban committed
41
    def get_mime_type(self, filepath):
Marcel's avatar
Marcel committed
42
        filepath = self.expand(filepath)
43
44
45
46
47
48
49
50
        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
51
    def check_file_extension(self, path, extensions=[]):
Marcel's avatar
Marcel committed
52
        path = self.expand(path)
53
54
55
56
57
58
59
60
        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
61
62
    def exists(self, path, type=None):
        # type may be 'f' or 'd'
Marcel's avatar
Marcel committed
63
        path = self.expand(path)
64
65
        # path exists physically?
        if not os.path.exists(path):
Marcel's avatar
Marcel committed
66
67
            return None
        # type correct?
68
69
70
71
72
73
74
        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
75

76
    def get_file_list(self, path, deep=False, filter=[], reverse=False, hide_hidden=True, encode_json=True):
77
        filelist = []
Marcel's avatar
Marcel committed
78
        path_expand = self.expand(path)
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
        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
95
                stats = os.lstat(fullpath)
96
97
                size = stats.st_size
                mtime = stats.st_mtime
98

Gero Müller's avatar
Gero Müller committed
99
                if stat.S_ISDIR(stats.st_mode):
100
                    filelist.append({'name': elem, 'type': 'd', 'mtime': mtime, 'size': size})
101
102
103
                    if deep:
                        filelist.extend(self.get_file_list(fullpath, deep, filter, reverse))
                else:
104
                    filelist.append({'name': elem, 'type': 'f', 'mtime': mtime, 'size': size})
105
106
107
108
109
110
        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)
111
112
113
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
114
115
        else:
            return data
116

117
    def get_suggestions(self, path, length=1, append_hidden=True, encode_json=True):
Marcel's avatar
Marcel committed
118
119
120
        suggestions = []
        source, filter = None, None
        # does the path exist?
Marcel's avatar
Marcel committed
121
122
        path_expanded = self.expand(path)
        if os.path.exists(path_expanded):
Marcel's avatar
Marcel committed
123
            # dir case
Marcel's avatar
Marcel committed
124
            if os.path.isdir(path_expanded):
Marcel's avatar
Marcel committed
125
126
127
128
129
130
131
132
133
134
135
                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
136
            if os.path.isdir(os.path.expanduser(os.path.expandvars(head))):
Marcel's avatar
Marcel committed
137
138
139
140
141
142
143
                source = head
                filter = tail

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

Marcel's avatar
Marcel committed
144
        files = os.listdir(os.path.expanduser(os.path.expandvars(source)))
Marcel's avatar
Marcel committed
145
146
        # resort?
        if append_hidden:
147
            files = sorted(map(lambda f: str(f), files), cmp=file_compare, key=str.lower)
148
        while (len(suggestions) < length or length == 0) and len(files):
Marcel's avatar
Marcel committed
149
150
151
152
            file = files.pop(0)
            if filter and not file.startswith(filter):
                continue
            suggestion = os.path.join(source, file)
Marcel's avatar
Marcel committed
153
            if not suggestion.endswith('/') and os.path.isdir(os.path.expanduser(os.path.expandvars(suggestion))):
Marcel's avatar
Marcel committed
154
155
156
                suggestion += '/'
            suggestions.append(suggestion)

157
        return suggestions if not encode_json else json.dumps(suggestions)
158

murban's avatar
murban committed
159
    def cut_slashs(self, path):
Marcel's avatar
Marcel committed
160
        path = self.expand(path)
murban's avatar
murban committed
161
        path = path[1:] if path.startswith(os.sep) else path
162
163
        if path == "":
            return path
murban's avatar
murban committed
164
        path = path[:-1] if path.endswith(os.sep) else path
165
166
        return path

murban's avatar
murban committed
167
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
168
        path = self.expand(path)
169
        # folder with the same name existent?
Marcel's avatar
Marcel committed
170
        fullpath = os.path.join(path, name)
171
172
173
174
175
176
177
178
        if os.path.isdir(fullpath):
            raise Exception("Name already in use!")
        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
179
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
180
        path = self.expand(path)
181
        # file with the same name existent?
Marcel's avatar
Marcel committed
182
        fullpath = os.path.join(path, name)
183
184
185
186
187
188
189
190
        if os.path.exists(fullpath):
            raise Exception("Name already in use!")
        try:
            f = file(fullpath, "w")
            f.close()
        except Exception as e:
            raise Exception(str(e))

Marcel's avatar
Marcel committed
191
192
193
194
    def rename_folder(self, path, name, force=False):
        # TODO
        pass
        # os.renames(path, fullpath)
195

Marcel's avatar
Marcel committed
196
197
198
199
    def rename_file(self, path, name, force=False):
        # TODO
        pass
        # os.renames(path, fullpath)
200

murban's avatar
murban committed
201
202
    def remove(self, path):
        if isinstance(path, list):
203
204
205
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
206
207
208
209
210
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
211
212

    def compress(self, path, paths, name):
Marcel's avatar
Marcel committed
213
        # TODO
214
        # paths has to be a list of strings
Marcel's avatar
Marcel committed
215
        paths = paths if isinstance(paths, (list, tuple)) else [paths]
216

murban's avatar
murban committed
217
        path = path if not path.endswith(os.sep) else path[:-1]
218
219
220
221
222
223
224
225

        fullpath = os.path.join(path, "%s.zip" % name)

        if os.path.exists(fullpath):
            raise Exception("Name already in use!")

        archive = ZipFile(fullpath, "w")

murban's avatar
murban committed
226
        path = path if path.startswith(os.sep) else path
227
228
229
        for p in paths:
            if p is None or p == "":
                continue
murban's avatar
murban committed
230
            p = p if p.startswith(os.sep) else os.sep + path
231
232
233
234
235
236
237
            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
238
                        archive.write(fullp, ap)
239
240
241
242
243
244

            ap = p[len(path):] if p.startswith(path) else p
            archive.write(p, ap)

        archive.close()

murban's avatar
murban committed
245
    def paste(self, path, target, cut):
Marcel's avatar
Marcel committed
246
247
        # TODO
        if isinstance(target, (list, tuple)):
murban's avatar
murban committed
248
249
            for p in target:
                self.paste(path, p, cut)
250
251
            return True

murban's avatar
murban committed
252
        fulltarget = os.path.join(path, target.split(os.sep)[-1])
253
254
255
256

        if os.path.exists(fulltarget):
            raise Exception("Name already in use!")

murban's avatar
murban committed
257
258
        if os.path.isdir(target):
            shutil.copytree(target, fulltarget)
259
            if cut:
murban's avatar
murban committed
260
                shutil.rmtree(target)
261
        else:
murban's avatar
murban committed
262
            shutil.copy2(target, path)
263
            if cut:
murban's avatar
murban committed
264
                os.remove(target)
265

Marcel's avatar
Marcel committed
266
267
    def save_file(self, path, content, binary=False, force=True):
        path = self.expand(path)
Marcel's avatar
Marcel committed
268
        # check if file already exists
murban's avatar
murban committed
269
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
270
271
            return False
        out = open(path, "wb")
Marcel's avatar
Marcel committed
272
273
274
        if binary:
            content = base64.b64decode(content)
        out.write(content)
275
        out.close()
Marcel's avatar
Marcel committed
276
        return True
277

murban's avatar
murban committed
278
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
279
        path = self.expand(path)
murban's avatar
murban committed
280
        f = open(path, "r")
281
282
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
283
        return content
284

Marcel's avatar
Marcel committed
285
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
286
        path = self.expand(path)
Marcel's avatar
Marcel committed
287
288
        return os.path.getmtime(path)

murban's avatar
murban committed
289
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
290
        path = self.expand(path)
291
        extension = path.split(".")[-1]
murban's avatar
murban committed
292
        return extension in FileSystem.BROWSER_EXTENSIONS
293

murban's avatar
murban committed
294
    def handle_file_name_collision(self, name, path):
Marcel's avatar
Marcel committed
295
        # TODO
296
        # collision?
murban's avatar
murban committed
297
        files = os.listdir(path)
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        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
333
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
334

Marcel's avatar
Marcel committed
335
336
    def expand(self, path):
        return os.path.expanduser(os.path.expandvars(path))
Marcel's avatar
Marcel committed
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354

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