storages.py 6.07 KB
Newer Older
1
2
3
"""custom storages for the system source"""
from os import unlink, path as osp

4
5
from yams.schema import role_name

6
from cubicweb import Binary
7
8
9
from cubicweb.server.hook import Operation

def set_attribute_storage(repo, etype, attr, storage):
10
    repo.system_source.set_storage(etype, attr, storage)
11

12
def unset_attribute_storage(repo, etype, attr):
13
    repo.system_source.unset_storage(etype, attr)
14
15

class Storage(object):
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
    """abstract storage

    * If `source_callback` is true (by default), the callback will be run during
      query result process of fetched attribute's valu and should have the
      following prototype::

        callback(self, source, value)

      where `value` is the value actually stored in the backend. None values
      will be skipped (eg callback won't be called).

    * if `source_callback` is false, the callback will be run during sql
      generation when some attribute with a custom storage is accessed and
      should have the following prototype::

        callback(self, generator, relation, linkedvar)

      where `generator` is the sql generator, `relation` the current rql syntax
      tree relation and linkedvar the principal syntax tree variable holding the
      attribute.
    """
    is_source_callback = True

    def callback(self, *args):
        """see docstring for prototype, which vary according to is_source_callback
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
        """
        raise NotImplementedError()

    def entity_added(self, entity, attr):
        """an entity using this storage for attr has been added"""
        raise NotImplementedError()
    def entity_updated(self, entity, attr):
        """an entity using this storage for attr has been updatded"""
        raise NotImplementedError()
    def entity_deleted(self, entity, attr):
        """an entity using this storage for attr has been deleted"""
        raise NotImplementedError()

# TODO
# * make it configurable without code
# * better file path attribution
Sylvain Thénault's avatar
Sylvain Thénault committed
57
# * handle backup/restore
58

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def uniquify_path(dirpath, basename):
    """return a unique file name for `basename` in `dirpath`, or None
    if all attemps failed.

    XXX subject to race condition.
    """
    path = osp.join(dirpath, basename)
    if not osp.isfile(path):
        return path
    base, ext = osp.splitext(path)
    for i in xrange(1, 256):
        path = '%s%s%s' % (base, i, ext)
        if not osp.isfile(path):
            return path
    return None

75
76
77
78
79
class BytesFileSystemStorage(Storage):
    """store Bytes attribute value on the file system"""
    def __init__(self, defaultdir):
        self.default_directory = defaultdir

80
    def callback(self, source, value):
81
82
83
        """sql generator callback when some attribute with a custom storage is
        accessed
        """
84
85
86
87
88
89
        fpath = source.binary_to_str(value)
        try:
            return Binary(file(fpath).read())
        except OSError, ex:
            source.critical("can't open %s: %s", value, ex)
            return None
90
91
92

    def entity_added(self, entity, attr):
        """an entity using this storage for attr has been added"""
93
94
95
96
97
98
99
100
101
102
        if entity._cw.transaction_data.get('fs_importing'):
            binary = Binary(file(entity[attr].getvalue()).read())
        else:
            binary = entity.pop(attr)
            fpath = self.new_fs_path(entity, attr)
            # bytes storage used to store file's path
            entity[attr] = Binary(fpath)
            file(fpath, 'w').write(binary.getvalue())
            AddFileOp(entity._cw, filepath=fpath)
        return binary
103
104
105

    def entity_updated(self, entity, attr):
        """an entity using this storage for attr has been updatded"""
106
107
108
109
110
111
112
113
114
115
        if entity._cw.transaction_data.get('fs_importing'):
            oldpath = self.current_fs_path(entity, attr)
            fpath = entity[attr].getvalue()
            if oldpath != fpath:
                DeleteFileOp(entity._cw, filepath=oldpath)
            binary = Binary(file(fpath).read())
        else:
            binary = entity.pop(attr)
            fpath = self.current_fs_path(entity, attr)
            UpdateFileOp(entity._cw, filepath=fpath, filedata=binary.getvalue())
116
        return binary
117
118
119
120
121
122

    def entity_deleted(self, entity, attr):
        """an entity using this storage for attr has been deleted"""
        DeleteFileOp(entity._cw, filepath=self.current_fs_path(entity, attr))

    def new_fs_path(self, entity, attr):
123
124
125
126
127
128
129
130
131
132
133
134
135
136
        basename = [str(entity.eid), attr]
        # We try to get some hint about how to name the file using attributes
        # metadata. Using the real file name and extension when available.
        #
        # Keeping the extension might be usefull for exemple in the case of PIL
        # processing that use filename extension to detect content-type.
        name = entity.attr_metadata(attr, 'name')
        if name is not None:
            basename.append(name.encode(entity._cw.encoding))
        fspath = uniquify_path(self.default_directory, '_'.join(basename))
        if fspath is None:
            msg = entity._cw._('failed to uniquify path (%s, %s)') % (
                dirpath, basename)
            raise ValidationError(entity.eid, {role_name(attr, 'subject'): msg})
137
138
139
        return fspath

    def current_fs_path(self, entity, attr):
140
141
142
        sysource = entity._cw.pool.source('system')
        cu = sysource.doexec(entity._cw,
                             'SELECT cw_%s FROM cw_%s WHERE cw_eid=%s' % (
143
                             attr, entity.__regid__, entity.eid))
144
145
146
147
        rawvalue = cu.fetchone()[0]
        if rawvalue is None: # no previous value
            return self.new_fs_path(entity, attr)
        return sysource._process_value(rawvalue, cu.description[0],
148
                                       binarywrap=str)
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168


class AddFileOp(Operation):
    def rollback_event(self):
        try:
            unlink(self.filepath)
        except:
            pass

class DeleteFileOp(Operation):
    def commit_event(self):
        try:
            unlink(self.filepath)
        except:
            pass

class UpdateFileOp(Operation):
    def precommit_event(self):
        try:
            file(self.filepath, 'w').write(self.filedata)
169
170
        except Exception, ex:
            self.exception(str(ex))