dataobject.py 14.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# copyright 2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr -- mailto:contact@logilab.fr
#
# This program 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.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# 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 this program. If not, see <http://www.gnu.org/licenses/>.
"""cubicweb-seda views for data objects (BinaryDataObject / PhysicalDataObject)"""

18
19
import json

20
21
from logilab.mtconverter import xml_escape

22
from cubicweb import tags, view
23
24
from cubicweb.predicates import match_form_params, is_instance
from cubicweb.web.views import uicfg, tabs
25
26
27

from cubes.relationwidget import views as rwdg

28
from cubes.seda.xsd2yams import RDEF_CONSTRAINTS
29
30
from cubes.seda.views import rtags_from_xsd_element, add_subobject_link, parent_and_container
from cubes.seda.views import viewlib
31
from cubes.seda.views import uicfg as sedauicfg  # noqa - ensure those rules are defined first
32

33
34
_ = unicode

35
pvs = uicfg.primaryview_section
36
pvdc = uicfg.primaryview_display_ctrl
37
38
rec = uicfg.reledit_ctrl
afs = uicfg.autoform_section
39
40
affk = uicfg.autoform_field_kwargs

41
42

class ContainedRelationFacetWidget(rwdg.RelationFacetWidget):
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    def _render_triggers(self, w, domid, form, field, rtype):
        parent, container = parent_and_container(form.edited_entity)
        req = form._cw
        if container is None:
            w(req._('you must validate first to select a possible value'))
        else:
            try:
                constraint = RDEF_CONSTRAINTS[(form.edited_entity.cw_etype, field.name)]
            except KeyError:
                constraint = RDEF_CONSTRAINTS[field.name]
            rql = 'Any CS WHERE ' + (
                constraint.replace('O in_scheme CS, ', '').replace(', S container AT', ''))
            rql += ', AT eid %(at)s'
            if not req.execute(rql, {'at': container.eid}):
                scheme_relations = [x for x in rql.split() if x.startswith('seda_')]
                if len(scheme_relations) == 1:
                    scheme_relation = req._(scheme_relations[0])
                else:
                    scheme_relation = req.__(scheme_relations[0] + '_object')
                w(req._('you must specify a scheme for {0} to select a value').format(
                    scheme_relation))
            else:
                return super(ContainedRelationFacetWidget, self)._render_triggers(
                    w, domid, form, field, rtype)
67
68
69
70
71
72
73

    def trigger_search_url(self, entity, url_params):
        """Overriden to add information about who is the container

        This information will be used later for proper vocabulary computation.
        """
        # first retrieve the container entity
74
        _, container = parent_and_container(entity)
75
        # and put it as an extra url param
76
77
        if container is not None:
            url_params['container'] = unicode(container.eid)
78
79
80
81
82
83
        return super(ContainedRelationFacetWidget, self).trigger_search_url(entity, url_params)


class ContainedSearchForRelatedEntitiesView(rwdg.SearchForRelatedEntitiesView):
    __select__ = rwdg.SearchForRelatedEntitiesView.__select__ & match_form_params('container')

84
85
    has_creation_form = False

86
87
88
89
    def linkable_rset(self):
        """Return rset of entities to be displayed as possible values for the
        edited relation. You may want to override this.
        """
90
        container = int(self._cw.form['container'])
91
92
93
94
95
        entity = self.compute_entity()
        rtype, tetype, role = self.rdef
        rdef = entity.e_schema.rdef(rtype, role, tetype)
        assert len(rdef.constraints) == 1 and 'S container AT' in rdef.constraints[0].expression
        baserql = rdef.constraints[0].expression
96
97
98
99
100
101
102
103
104
        baserql = baserql.replace('S container AT', 'AT eid %(at)s')
        # detect language first
        languages = set(lang for lang, in self._cw.execute(
            'DISTINCT Any OLC WHERE ' + baserql + ', O preferred_label OL, '
            'OL language_code OLC', {'at': container}))
        for lang in (self._cw.lang, 'en', 'sed-2'):
            if lang in languages:
                break
        else:
105
106
            if not languages:
                return self._cw.empty_rset()
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
            lang = languages.pop()
        # now build the query to prefetch/sort on the preferred label in the proper language
        return self._cw.execute(
            'DISTINCT Any O,OL,OLL ORDERBY OLL WHERE ' + baserql + ', O preferred_label OL, '
            'OL label OLL, OL language_code %(lang)s',
            {'at': container, 'lang': lang})

    @staticmethod
    def pref_label_label(concept):
        return concept.cw_rset[concept.cw_row][2]

    @staticmethod
    def pref_label_column(w, concept):
        w(tags.a(ContainedSearchForRelatedEntitiesView.pref_label_label(concept),
                 href=concept.absolute_url()))


class SelectConceptEntitiesTableView(rwdg.SelectEntitiesTableView):
    """Table view of the selectable entities in the relation widget

    Selection of columns (and respective renderer) can be overridden by
    updating `columns` and `column_renderers` class attributes.
    """
    __select__ = rwdg.SelectEntitiesTableView.__select__ & is_instance('Concept')

    column_renderers = rwdg.SelectEntitiesTableView.column_renderers.copy()
    # speed-up things by considering rset shape from ContainedSearchForRelatedEntitiesView
    column_renderers['entity'] = rwdg.SelectMainEntityColRenderer(
        sortfunc=ContainedSearchForRelatedEntitiesView.pref_label_label,
        renderfunc=ContainedSearchForRelatedEntitiesView.pref_label_column)
137
138


139
140
# hide some relation from autoform because of limitation of _container_eid
afs.tag_object_of(('*', 'seda_compressed', 'SEDABinaryDataObject'), 'main', 'hidden')
141
pvs.tag_object_of(('*', 'seda_compressed', 'SEDABinaryDataObject'), 'attributes')
142
143
pvs.tag_object_of(('*', 'seda_data_object_reference_id', 'SEDABinaryDataObject'),
                  'relations')
144
145
146
147
pvdc.tag_object_of(('*', 'seda_data_object_reference_id', 'SEDABinaryDataObject'),
                   {'vid': 'autolimited',
                    'subvid': 'seda.object-ref.archive-unit',
                    'label': _('referenced by:')})
148
149
150
151
152
153
154
155
156
rec.tag_object_of(('*', 'seda_compressed', 'SEDABinaryDataObject'),
                  {'rvid': 'seda.reledit.complexlink',
                   'novalue_label': _('<unauthorized>')})

rec.tag_subject_of(('SEDABinaryDataObject', 'seda_alt_binary_data_object_attachment', '*'),
                   {'rvid': 'seda.reledit.alternative',
                    'novalue_label': _('<unauthorized>')})

for etype in ('SEDABinaryDataObject', 'SEDAPhysicalDataObject'):
157
158
    afs.tag_object_of(('*', 'seda_data_object_version_from', etype), 'main', 'hidden')
    pvs.tag_object_of(('*', 'seda_data_object_version_from', etype), 'attributes')
159
160
161
162
    rec.tag_object_of(('*', 'seda_data_object_version_from', etype),
                      {'rvid': 'seda.reledit.complexlink',
                       'novalue_label': _('<unauthorized>')})

163
164
    pvs.tag_object_of(('*', 'seda_target', etype), 'hidden')  # in the relationship tab

165

166
167
def uri_cardinality_vocabulary(form, field):
    req = form._cw
168
169
170
171
172
173
174
175
176
177
    if form.edited_entity.has_eid():
        parent_type = form.edited_entity.cw_adapt_to('IContained').parent.cw_etype
    else:
        try:
            # inlined creation form
            parent_type = json.loads(req.form['arg'][1])
        except KeyError:
            # edition through reledit
            parent_eid = req.form['eid']
            parent_type = req.describe(int(parent_eid))[0]
178
179
180
181
182
183
184
185
    if parent_type in ('SEDABinaryDataObject', 'SEDAAltBinaryDataObjectAttachment'):
        return [u'1']
    return [u'0..1', u'1']

affk.tag_attribute(('SEDAUri', 'user_cardinality'),
                   {'choices': uri_cardinality_vocabulary})


186
187
188
189
190
191
192
for key, rql_expr in RDEF_CONSTRAINTS.items():
    if 'S container AT' in rql_expr:
        try:
            etype, rtype = key
        except ValueError:
            etype = '*'
            rtype = key
193
194
        if rtype == 'seda_rule':
            continue  # managed in mgmt_rules module
195
196
        affk.tag_subject_of((etype, rtype, '*'),
                            {'widget': ContainedRelationFacetWidget(dialog_options={'width': 800})})
197
198


199
200
201
202
203
204
205
206
207
208
209
210
211
bdo_ordered_fields = [
    ('id', 'subject'),
    ('user_cardinality', 'subject'),
    ('user_annotation', 'subject'),
    ('filename', 'subject'),
    ('seda_compressed', 'object'),
    ('seda_data_object_version_from', 'object'),
    ('seda_algorithm', 'object'),
]
affk.set_fields_order('SEDABinaryDataObject', bdo_ordered_fields)
pvdc.set_fields_order('SEDABinaryDataObject', bdo_ordered_fields)


212
213
214
215
class BinaryDataObjectTabbedPrimaryView(tabs.TabbedPrimaryView):
    __select__ = tabs.TabbedPrimaryView.__select__ & is_instance('SEDABinaryDataObject')
    tabs = [
        'main_tab',
216
        _('seda_bdo_format_identification'),
217
        _('seda_bdo_file_information'),
218
        _('seda_do_relations'),
219
220
221
    ]


222
223
224
225
226
227
228
229
class BinaryDataObjectFormatIdentificationTab(tabs.PrimaryTab):
    """Display format identification information of a binary data object"""
    __regid__ = 'seda_bdo_format_identification'
    __select__ = tabs.PrimaryTab.__select__ & is_instance('SEDABinaryDataObject')

    rsection, display_ctrl = rtags_from_xsd_element('SEDABinaryDataObject', 'FormatIdentification')


230
231
232
233
234
235
236
237
class BinaryDataObjectFileInfoTab(tabs.PrimaryTab):
    """Display file information of a binary data object"""
    __regid__ = 'seda_bdo_file_information'
    __select__ = tabs.PrimaryTab.__select__ & is_instance('SEDABinaryDataObject')

    rsection, display_ctrl = rtags_from_xsd_element('SEDABinaryDataObject', 'FileInfo')


238
239
240
241
class PhysicalDataObjectTabbedPrimaryView(tabs.TabbedPrimaryView):
    __select__ = tabs.TabbedPrimaryView.__select__ & is_instance('SEDAPhysicalDataObject')
    tabs = [
        'main_tab',
242
        _('seda_pdo_dimensions'),
243
        _('seda_do_relations'),
244
    ]
245
246


247
248
249
250
251
252
253
254
class PhysicalDataObjectDimensionsTab(tabs.PrimaryTab):
    """Display physical dimensions of a physical data object"""
    __regid__ = 'seda_pdo_dimensions'
    __select__ = tabs.PrimaryTab.__select__ & is_instance('SEDAPhysicalDataObject')

    rsection, display_ctrl = rtags_from_xsd_element('SEDAPhysicalDataObject', 'PhysicalDimensions')


Sylvain Thénault's avatar
Sylvain Thénault committed
255
class DataObjectRelationsTab(tabs.PrimaryTab):
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
    """Display relations of a binary or physical data object"""
    __regid__ = 'seda_do_relations'
    __select__ = tabs.PrimaryTab.__select__ & is_instance('SEDABinaryDataObject',
                                                          'SEDAPhysicalDataObject')

    def entity_call(self, entity):
        rschema = self._cw.vreg.schema.rschema('seda_relationship')
        if rschema.has_perm(self._cw, 'add', toeid=entity.eid):
            urlparams = {'__redirectparams': 'tab=' + self.__regid__}
            self.w(add_subobject_link(entity, 'seda_relationship', 'object', urlparams,
                                      msg=self._cw._('add a SEDARelationship'),
                                      klass='btn btn-success pull-right'))
            self.w(tags.div(klass='clearfix'))
        rset = entity.related('seda_relationship', 'object')
        if rset:
            self._cw.view('list', rset=rset, parent=entity, w=self.w, tabid=self.__regid__,
                          subvid='seda.listitem')
273
274
275
276
277
278
279
        rset = entity.related('seda_target', 'object')
        if rset:
            self.w(u'<h2>{0}</h2>'.format(self._cw._('Relationship target of')))
            self.w(u'<div>{0}</div>'.format(
                self._cw._('This object is used as a relationship target of the following '
                           'entities')))
            self._cw.view('list', rset=rset, subvid='seda.relationship.reverse', w=self.w)
280
281
282
283
284


class RelationshipBusinessValueLinkEntityView(viewlib.BusinessValueLinkEntityView):
    __select__ = viewlib.BusinessValueLinkEntityView.__select__ & is_instance('SEDARelationship')

285
286
287
288
289
290
    def entity_value(self, entity):
        target = entity.seda_target[0] if entity.seda_target else None
        if target:
            value = tags.a(target.dc_title(), href=target.absolute_url())
        else:
            value = xml_escape(self._cw._('<no data-object specified>'))
291
292
        if entity.seda_type_relationship:
            concept = entity.seda_type_relationship[0]
293
            msg = self._cw._(', of relationship type %s') % concept.label()
294
        else:
295
296
297
            msg = self._cw._(', no relationship type specified')
        value += xml_escape(msg)
        return value
298
299


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
class RelationshipReverseEntityView(view.EntityView):
    __regid__ = 'seda.relationship.reverse'
    __select__ = is_instance('SEDARelationship')

    def entity_call(self, entity):
        target = entity.seda_relationship[0]
        self.w(tags.a(target.dc_title(), href=target.absolute_url()))
        if entity.seda_type_relationship:
            concept = entity.seda_type_relationship[0]
            msg = self._cw._(', of relationship type %s') % concept.label()
        else:
            msg = self._cw._(', no relationship type specified')
        self.w(xml_escape(msg))


315
316
317
318
319
320
321
322
323
324
325
class ObjectReferencepArchiveUnitEntityView(view.EntityView):
    __regid__ = 'seda.object-ref.archive-unit'
    __select__ = is_instance('SEDADataObjectReference')

    def entity_call(self, entity):
        au_seq = entity.seda_data_object_reference[0]
        au_choice = au_seq.reverse_seda_seq_alt_archive_unit_archive_unit_ref_id_management[0]
        archive_unit = au_choice.reverse_seda_alt_archive_unit_archive_unit_ref_id[0]
        self._cw.view('listitem', rset=archive_unit.as_rset(), w=self.w)


326
327
328
329
330
331
332
333
334
335
336
class UnitBusinessValueEntityView(viewlib.BusinessValueEntityView):
    __select__ = is_instance('SEDAWidth', 'SEDAHeight', 'SEDADepth', 'SEDAShape',
                             'SEDADiameter', 'SEDALength', 'SEDAThickness', 'SEDAWeight')

    def entity_call(self, entity):
        super(UnitBusinessValueEntityView, self).entity_call(entity)
        if entity.seda_unit:
            unit = self._cw._('unit: {0}').format(entity.seda_unit[0].label())
        else:
            unit = self._cw._('<no unit specified>')
        self.w(u' (%s)' % xml_escape(unit))