filesystem.py 11.9 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
Marcel's avatar
Marcel committed
12

13
14
15
16
17
18
19
20
21
22
23
24

class FileSystem(object):

    FILE_EXTENSIONS = ["png", "jpg", "jpeg", "bmp", "ps", "eps", "pdf", "txt", "xml", "py", "c", "cpp", "root", "pxlio"]
    BROWSER_EXTENSIONS = ["png", "jpg", "jpeg", "bmp", "pdf"]
    ADDITIONAL_MIMES = {"pxlio": "text/plain",
                        "root" : "text/plain"}

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

25
26
27
    def setup(self, basedir=None):
        if basedir==None:
            basedir = os.path.expanduser("~")
murban's avatar
murban committed
28
29
30
31
        if not os.path.isdir(basedir):
            raise Exception("Basedir ("+str(basedir)+") does not exist!")
        # the basedir
        self.basedir = os.path.join(basedir, ".vispa")
32
33
34
35
36
        if os.path.isdir(self.basedir):
            return "Basedir already exists"
        else: 
            os.makedirs(self.basedir, 0700)
            return "Basedir now exists"
37

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

72
    def get_file_list(self, path, deep=False, filter=[], reverse=False, hide_hidden=True, encode_json=False):
73
        filelist = []
74
        path_expand = os.path.expanduser(os.path.expandvars(path))
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        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)

                # get locales, mtime, etc
                locale.setlocale(locale.LC_ALL, '')
                stats = os.stat(path_expand)
                size = locale.format('%d', stats.st_size, grouping=True)
                mtime = datetime.fromtimestamp(stats.st_mtime).strftime('%Y-%m-%d %H:%M:%S')

                if os.path.isdir(fullpath):
                    filelist.append({'name': elem, 'type': 'd', 'parent': path, 'extension': '', 'mtime': mtime, 'size': size, 'path': fullpath})
                    if deep:
                        filelist.extend(self.get_file_list(fullpath, deep, filter, reverse))
                else:
                    extension = elem.split('.')[-1]
                    filelist.append({'name': elem, 'type': 'f', 'parent': path, 'extension': extension, 'mtime': mtime, 'size': size, 'path': fullpath})
        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)
110
111
112
113
114
        data = {'filelist': filelist, 'parentpath': parentpath}
        if encode_json:
            return json.dumps(data)
        return data

115

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

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

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

        return suggestions
156

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

murban's avatar
murban committed
164
    def create_folder(self, path, name):
165
166
167
168
169
170
171
172
173
174
        # folder with the same name existent?
        fullpath = os.path.join(path, name)
        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
175
    def create_file(self, path, name):
176
177
178
179
180
181
182
183
184
185
186
        # file with the same name existent?
        fullpath = os.path.join(path, name)
        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))
        

murban's avatar
murban committed
187
    def rename_folder(self, path, name):
188
189
190
191
192
        # file or folder
        if not os.path.isdir(path):
            raise Exception("Renaming file with folder function!")

        # folder with the same name existent?
murban's avatar
murban committed
193
194
        path = path if not path.endswith(os.sep) else path[:-1]
        fullpath = os.path.join(os.sep.join(path.split(os.sep)[:-1]), name)
195
196
197
198
199
        if os.path.exists(fullpath):
            raise Exception("Name already in use!")

        os.renames(path, fullpath)

murban's avatar
murban committed
200
    def rename_file(self, path, name):
201
202
203
204
205
        # file or folder
        if os.path.isdir(path):
            raise Exception("Renaming folder with file function!")

        # file with the same name existent?
murban's avatar
murban committed
206
        fullpath = os.path.join(os.sep.join(path.split(os.sep)[:-1]), name)
207
208
209
210
211
        if os.path.exists(fullpath):
            raise Exception("Name already in use!")

        os.renames(path, fullpath)

murban's avatar
murban committed
212
213
    def remove(self, path):
        if isinstance(path, list):
214
215
216
217
218
219
220
221
222
223
224
225
226
            for p in path:
                self.remove(p)
            return True

        if os.path.isdir(path):
            shutil.rmtree(path)
        else:
            os.remove(path)

    def compress(self, path, paths, name):
        # paths has to be a list of strings
        paths = paths if isinstance(paths, list) else [paths]

murban's avatar
murban committed
227
        path = path if not path.endswith(os.sep) else path[:-1]
228
229
230
231
232
233
234
235

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

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

        archive.close()

murban's avatar
murban committed
255
256
257
258
    def paste(self, path, target, cut):
        if isinstance(target, list):
            for p in target:
                self.paste(path, p, cut)
259
260
            return True

murban's avatar
murban committed
261
        fulltarget = os.path.join(path, target.split(os.sep)[-1])
262
263
264
265

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

murban's avatar
murban committed
266
267
        if os.path.isdir(target):
            shutil.copytree(target, fulltarget)
268
            if cut:
murban's avatar
murban committed
269
                shutil.rmtree(target)
270
        else:
murban's avatar
murban committed
271
            shutil.copy2(target, path)
272
            if cut:
murban's avatar
murban committed
273
                os.remove(target)
274

murban's avatar
murban committed
275
    def save_file_content(self, path, content, force=True):
Marcel's avatar
Marcel committed
276
277
        path = os.path.expandvars(os.path.expanduser(path))
        # check if file already exists
murban's avatar
murban committed
278
        if os.path.exists(path) and not force:
Marcel's avatar
Marcel committed
279
280
281
            return False
        out = open(path, "wb")
        out.write(content)
282
        out.close()
Marcel's avatar
Marcel committed
283
        return True
284

murban's avatar
murban committed
285
    def get_file_content(self, path):
Marcel's avatar
Marcel committed
286
        path = os.path.expandvars(os.path.expanduser(path))
murban's avatar
murban committed
287
        f = open(path, "r")
288
289
        content = f.read()
        f.close()
Marcel's avatar
Marcel committed
290
        return content
291

Marcel's avatar
Marcel committed
292
293
294
295
    def get_mtime(self, path):
        path = os.path.expandvars(os.path.expanduser(path))
        return os.path.getmtime(path)

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

murban's avatar
murban committed
300
    def handle_file_name_collision(self, name, path):
301
        # collision?
murban's avatar
murban committed
302
        files = os.listdir(path)
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
337
        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
338
        return self.handle_file_name_collision(newname, path)
Marcel's avatar
Marcel committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357


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