filesystem.py 11.5 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
import logging
logger = logging.getLogger(__name__)

18
19
20
class FileSystem(object):

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

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

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

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

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

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

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

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

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

161
        return suggestions if not encode_json else json.dumps(suggestions)
162

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

murban's avatar
murban committed
171
    def create_folder(self, path, name):
Marcel's avatar
Marcel committed
172
        path = self.expand(path)
173
        # folder with the same name existent?
Marcel's avatar
Marcel committed
174
        fullpath = os.path.join(path, name)
175
176
177
178
179
180
181
182
        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
183
    def create_file(self, path, name):
Marcel's avatar
Marcel committed
184
        path = self.expand(path)
185
        # file with the same name existent?
Marcel's avatar
Marcel committed
186
        fullpath = os.path.join(path, name)
187
188
189
190
191
192
193
194
        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))

195
196
197
198
199
200
201
202
203
204
    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)
205

murban's avatar
murban committed
206
207
    def remove(self, path):
        if isinstance(path, list):
208
209
210
            for p in path:
                self.remove(p)
        else:
Marcel's avatar
Marcel committed
211
212
213
214
215
            path = self.expand(path)
            if os.path.isdir(path):
                shutil.rmtree(path)
            else:
                os.remove(path)
216
217

    def compress(self, path, paths, name):
Marcel's avatar
Marcel committed
218
        # TODO
219
        # paths has to be a list of strings
Marcel's avatar
Marcel committed
220
        paths = paths if isinstance(paths, (list, tuple)) else [paths]
221

murban's avatar
murban committed
222
        path = path if not path.endswith(os.sep) else path[:-1]
223
224
225
226
227
228
229
230

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

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

        archive.close()

murban's avatar
murban committed
250
    def paste(self, path, target, cut):
Marcel's avatar
Marcel committed
251
252
        # TODO
        if isinstance(target, (list, tuple)):
murban's avatar
murban committed
253
254
            for p in target:
                self.paste(path, p, cut)
255
256
            return True

murban's avatar
murban committed
257
        fulltarget = os.path.join(path, target.split(os.sep)[-1])
258
259
260
261

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

murban's avatar
murban committed
262
263
        if os.path.isdir(target):
            shutil.copytree(target, fulltarget)
264
            if cut:
murban's avatar
murban committed
265
                shutil.rmtree(target)
266
        else:
murban's avatar
murban committed
267
            shutil.copy2(target, path)
268
            if cut:
murban's avatar
murban committed
269
                os.remove(target)
270

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

murban's avatar
murban committed
283
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
284
        path = self.expand(path)
murban's avatar
murban committed
285
        f = open(path, "r")
286
287
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
288
        return content
289

Marcel's avatar
Marcel committed
290
    def get_mtime(self, path):
Marcel's avatar
Marcel committed
291
        path = self.expand(path)
Marcel's avatar
Marcel committed
292
293
        return os.path.getmtime(path)

murban's avatar
murban committed
294
    def is_browser_file(self, path):
Marcel's avatar
Marcel committed
295
        path = self.expand(path)
296
        extension = path.split(".")[-1]
murban's avatar
murban committed
297
        return extension in FileSystem.BROWSER_EXTENSIONS
298

murban's avatar
murban committed
299
    def handle_file_name_collision(self, name, path):
300
        # collision?
murban's avatar
murban committed
301
        files = os.listdir(path)
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
333
334
335
336
        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
337
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
338

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

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