Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/sugar_network/db/resource.py
blob: 24d4ea1778e3c9d0b2fff576bedd6d7b204e1ecf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# Copyright (C) 2011-2014 Aleksey Lim
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import time

from sugar_network.db.metadata import indexed_property, Localized
from sugar_network.db.metadata import Numeric, List, Author, Enum
from sugar_network.db.metadata import Composite, Aggregated
from sugar_network.toolkit.router import ACL
from sugar_network.toolkit import ranges


STATES = ['active', 'deleted']
STATUSES = ['featured']


class Resource(object):
    """Base class for all data classes."""

    #: `Metadata` object that describes the document
    metadata = None
    #: Whether these resources should be migrated from slave-to-master only
    one_way = False

    def __init__(self, guid, record, origs=None, posts=None):
        self.origs = origs or {}
        self.posts = posts or {}
        self.record = record
        self._post_seqno = None
        self._guid = guid

    @property
    def guid(self):
        return self._guid or self['guid']

    @property
    def post_seqno(self):
        return self._post_seqno

    @post_seqno.setter
    def post_seqno(self, value):
        if self._post_seqno is None:
            self._post_seqno = value
            self.post('seqno', value)

    @indexed_property(Numeric, slot=1000, prefix='RS', acl=0, default=0)
    def seqno(self, value):
        return value

    @indexed_property(Numeric, slot=1001, prefix='RC', default=0, acl=ACL.READ)
    def ctime(self, value):
        return value

    @indexed_property(Numeric, slot=1002, prefix='RM', default=0, acl=ACL.READ)
    def mtime(self, value):
        return value

    @indexed_property(Author, prefix='RA', default={}, full_text=True,
            acl=ACL.READ)
    def author(self, value):
        return value

    @indexed_property(Enum, STATES, prefix='RE', default=STATES[0], acl=0)
    def state(self, value):
        return value

    @indexed_property(List, prefix='RT', full_text=True, default=[])
    def tags(self, value):
        return value

    @indexed_property(List, prefix='RU', default=[], acl=ACL.READ,
            subtype=Enum(STATUSES))
    def status(self, value):
        return value

    @indexed_property(List, prefix='RP', default=[],
            acl=ACL.READ | ACL.LOCAL)
    def pins(self, value):
        return value

    @property
    def exists(self):
        return self.record is not None and self.record.consistent

    @property
    def available(self):
        return self.exists and self['state'] != 'deleted'

    def created(self):
        ts = int(time.time())
        self.posts['ctime'] = ts
        self.posts['mtime'] = ts

    def updated(self):
        self.posts['mtime'] = int(time.time())

    def get(self, prop, default=None):
        """Get document's property value.

        :param prop:
            property name to get value
        :returns:
            `prop` value

        """
        value = self.posts.get(prop)
        if value is None:
            value = self.orig(prop)
        if value is None:
            value = default
        return value

    def orig(self, prop):
        """Get document's property original value.

        :param prop:
            property name to get value
        :returns:
            `prop` value

        """
        prop = self.metadata[prop]
        value = self.origs.get(prop.name)
        if value is None and self.record is not None:
            meta = self.record.get(prop.name)
            if meta is not None:
                value = meta.get('value')
            else:
                value = prop.default
            self.origs[prop.name] = value
        return value

    def repr(self, prop):
        """Get property value with applying output typecasts.

        Such property values should be used to return property
        out from the system.

        """
        prop_ = self.metadata[prop]
        value = prop_.reprcast(self.get(prop))
        if prop_.on_get is not None:
            value = prop_.on_get(self, value)
        return value

    def properties(self, props):
        result = {}
        for i in props:
            result[i] = self.get(i)
        return result

    def meta(self, prop):
        if self.record is not None:
            return self.record.get(prop)

    def diff(self, r, out_r=None):
        patch = {}
        for name, prop in self.metadata.items():
            if name == 'seqno' or prop.acl & ACL.LOCAL:
                continue
            meta = self.meta(name)
            if meta is None:
                continue
            seqno = meta.get('seqno')
            if not ranges.contains(r, seqno):
                continue
            if out_r is not None:
                ranges.include(out_r, seqno, seqno)
            value = meta.get('value')
            if isinstance(prop, Aggregated):
                value_ = {}
                for key, agg in value.items():
                    agg_seqno = agg.pop('seqno')
                    if ranges.contains(r, agg_seqno):
                        value_[key] = agg
                        if out_r is not None:
                            ranges.include(out_r, agg_seqno, agg_seqno)
                value = value_
            patch[name] = {'mtime': meta['mtime'], 'value': value}
        return patch

    def format_patch(self, props):
        if not props:
            return {}
        patch = {}
        for prop, value in props.items():
            if self[prop] == value:
                continue
            orig_value = self[prop]
            if orig_value and isinstance(self.metadata[prop], Localized):
                for lang, subvalue in value.items():
                    if orig_value.get(lang) != subvalue:
                        break
                else:
                    continue
            patch[prop] = value
        return patch

    def post(self, prop, value=None, **meta):
        if value is None:
            if prop not in self.posts:
                return
            value = self.posts[prop]
        prop = self.metadata[prop]
        if prop.on_set is not None:
            value = prop.on_set(self, value)
        seqno = None
        if self.post_seqno and not prop.acl & ACL.LOCAL:
            seqno = meta['seqno'] = self.post_seqno
        if seqno and isinstance(prop, Aggregated):
            for agg in value.values():
                agg['seqno'] = seqno
                agg['ctime'] = int(time.time())
        if isinstance(prop, Composite):
            orig_value = self.orig(prop.name)
            if orig_value:
                orig_value.update(value)
                value = orig_value
        self.record.set(prop.name, value=value, **meta)
        self.posts[prop.name] = value

    def __contains__(self, prop):
        return prop in self.origs or prop in self.posts

    def __getitem__(self, prop):
        return self.get(prop)