storages.py 8.04 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
12
13
14
15
16
17
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
"""custom storages for the system source"""
from os import unlink, path as osp

21
22
from yams.schema import role_name

23
from cubicweb import Binary
24
from cubicweb.server import hook
25
26

def set_attribute_storage(repo, etype, attr, storage):
27
    repo.system_source.set_storage(etype, attr, storage)
28

29
def unset_attribute_storage(repo, etype, attr):
30
    repo.system_source.unset_storage(etype, attr)
31
32

class Storage(object):
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    """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
58
59
60
61
62
63
64
65
66
67
68
69
        """
        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()
70
71
72
    def migrate_entity(self, entity, attribute):
        """migrate an entity attribute to the storage"""
        raise NotImplementedError()
73
74
75
76

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

79
80
81
82
83
84
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.
    """
85
    path = osp.join(dirpath, basename.replace(osp.sep, '-'))
86
87
88
89
90
91
92
93
94
    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

Sylvain Thénault's avatar
Sylvain Thénault committed
95

96
97
class BytesFileSystemStorage(Storage):
    """store Bytes attribute value on the file system"""
98
    def __init__(self, defaultdir, fsencoding='utf-8'):
99
        self.default_directory = defaultdir
100
        self.fsencoding = fsencoding
101

102
    def callback(self, source, value):
103
104
105
        """sql generator callback when some attribute with a custom storage is
        accessed
        """
106
107
108
109
110
111
        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
112
113
114

    def entity_added(self, entity, attr):
        """an entity using this storage for attr has been added"""
115
116
117
118
119
120
121
122
        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())
123
            hook.set_operation(entity._cw, 'bfss_added', fpath, AddFileOp)
124
        return binary
125
126
127

    def entity_updated(self, entity, attr):
        """an entity using this storage for attr has been updatded"""
128
129
130
131
        if entity._cw.transaction_data.get('fs_importing'):
            oldpath = self.current_fs_path(entity, attr)
            fpath = entity[attr].getvalue()
            if oldpath != fpath:
132
133
                hook.set_operation(entity._cw, 'bfss_deleted', oldpath,
                                   DeleteFileOp)
134
135
136
137
138
            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())
139
        return binary
140
141
142

    def entity_deleted(self, entity, attr):
        """an entity using this storage for attr has been deleted"""
143
144
        fpath = self.current_fs_path(entity, attr)
        hook.set_operation(entity._cw, 'bfss_deleted', fpath, DeleteFileOp)
145
146

    def new_fs_path(self, entity, attr):
147
148
149
150
151
        # We try to get some hint about how to name the file using attribute's
        # name metadata, so we use the real file name and extension when
        # available. Keeping the extension is useful for example in the case of
        # PIL processing that use filename extension to detect content-type, as
        # well as providing more understandable file names on the fs.
152
        basename = [str(entity.eid), attr]
153
        name = entity.cw_attr_metadata(attr, 'name')
154
        if name is not None:
155
            basename.append(name.encode(self.fsencoding))
156
157
158
        fspath = uniquify_path(self.default_directory, '_'.join(basename))
        if fspath is None:
            msg = entity._cw._('failed to uniquify path (%s, %s)') % (
159
                dirpath, '_'.join(basename))
160
            raise ValidationError(entity.eid, {role_name(attr, 'subject'): msg})
161
162
163
        return fspath

    def current_fs_path(self, entity, attr):
164
165
166
        sysource = entity._cw.pool.source('system')
        cu = sysource.doexec(entity._cw,
                             'SELECT cw_%s FROM cw_%s WHERE cw_eid=%s' % (
167
                             attr, entity.__regid__, entity.eid))
168
169
170
171
        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],
172
                                       binarywrap=str)
173

174
175
176
177
178
179
180
181
182
183
    def migrate_entity(self, entity, attribute):
        """migrate an entity attribute to the storage"""
        entity.edited_attributes = set()
        self.entity_added(entity, attribute)
        session = entity._cw
        source = session.repo.system_source
        attrs = source.preprocess_entity(entity)
        sql = source.sqlgen.update('cw_' + entity.__regid__, attrs,
                                   ['cw_eid'])
        source.doexec(session, sql, attrs)
184

185
186

class AddFileOp(hook.Operation):
187
    def rollback_event(self):
188
189
190
191
192
        for filepath in self.session.transaction_data.pop('bfss_added'):
            try:
                unlink(filepath)
            except Exception, ex:
                self.error('cant remove %s: %s' % (filepath, ex))
193

194
class DeleteFileOp(hook.Operation):
195
    def commit_event(self):
196
197
198
199
200
        for filepath in self.session.transaction_data.pop('bfss_deleted'):
            try:
                unlink(filepath)
            except Exception, ex:
                self.error('cant remove %s: %s' % (filepath, ex))
201

202
class UpdateFileOp(hook.Operation):
203
204
205
    def precommit_event(self):
        try:
            file(self.filepath, 'w').write(self.filedata)
206
207
        except Exception, ex:
            self.exception(str(ex))