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
|
import uuid
from u1db.backends import CommonBackend
from u1db import errors, Document
from leap.soledad import util as soledadutil
class ObjectStore(CommonBackend):
"""
A backend for storing u1db data in an object store.
"""
def __init__(self, replica_uid=None):
# This initialization method should be called after the connection
# with the database is established, so it can ensure that u1db data is
# configured and up-to-date.
self.set_document_factory(Document)
self._sync_log = soledadutil.SyncLog()
self._transaction_log = soledadutil.TransactionLog()
self._replica_uid = replica_uid
self._ensure_u1db_data()
#-------------------------------------------------------------------------
# implemented methods from Database
#-------------------------------------------------------------------------
def set_document_factory(self, factory):
self._factory = factory
def set_document_size_limit(self, limit):
raise NotImplementedError(self.set_document_size_limit)
def whats_changed(self, old_generation=0):
self._get_u1db_data()
return self._transaction_log.whats_changed(old_generation)
def get_doc(self, doc_id, include_deleted=False):
doc = self._get_doc(doc_id, check_for_conflicts=True)
if doc is None:
return None
if doc.is_tombstone() and not include_deleted:
return None
return doc
def _put_doc(self, doc):
raise NotImplementedError(self._put_doc)
def put_doc(self, doc):
# consistency check
if doc.doc_id is None:
raise errors.InvalidDocId()
self._check_doc_id(doc.doc_id)
self._check_doc_size(doc)
# check if document exists
old_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
if old_doc and old_doc.has_conflicts:
raise errors.ConflictedDoc()
if old_doc and doc.rev is None and old_doc.is_tombstone():
new_rev = self._allocate_doc_rev(old_doc.rev)
else:
if old_doc is not None:
if old_doc.rev != doc.rev:
raise errors.RevisionConflict()
else:
if doc.rev is not None:
raise errors.RevisionConflict()
new_rev = self._allocate_doc_rev(doc.rev)
doc.rev = new_rev
self._put_doc(doc)
# update u1db generation and logs
new_gen = self._get_generation() + 1
trans_id = self._allocate_transaction_id()
self._transaction_log.append((new_gen, doc.doc_id, trans_id))
self._set_u1db_data()
return doc.rev
def delete_doc(self, doc):
old_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
if old_doc is None:
raise errors.DocumentDoesNotExist
if old_doc.rev != doc.rev:
raise errors.RevisionConflict()
if old_doc.is_tombstone():
raise errors.DocumentAlreadyDeleted
if old_doc.has_conflicts:
raise errors.ConflictedDoc()
new_rev = self._allocate_doc_rev(doc.rev)
doc.rev = new_rev
doc.make_tombstone()
self._put_doc(doc)
return new_rev
# start of index-related methods: these are not supported by this backend.
def create_index(self, index_name, *index_expressions):
return False
def delete_index(self, index_name):
return False
def list_indexes(self):
return []
def get_from_index(self, index_name, *key_values):
return []
def get_range_from_index(self, index_name, start_value=None,
end_value=None):
return []
def get_index_keys(self, index_name):
return []
# end of index-related methods: these are not supported by this backend.
def get_doc_conflicts(self, doc_id):
return []
def resolve_doc(self, doc, conflicted_doc_revs):
raise NotImplementedError(self.resolve_doc)
def _get_replica_gen_and_trans_id(self, other_replica_uid):
self._get_u1db_data()
return self._sync_log.get_replica_gen_and_trans_id(other_replica_uid)
def _set_replica_gen_and_trans_id(self, other_replica_uid,
other_generation, other_transaction_id):
self._get_u1db_data()
self._sync_log.set_replica_gen_and_trans_id(other_replica_uid,
other_generation,
other_transaction_id)
self._set_u1db_data()
#-------------------------------------------------------------------------
# implemented methods from CommonBackend
#-------------------------------------------------------------------------
def _get_generation(self):
self._get_u1db_data()
return self._transaction_log.get_generation()
def _get_generation_info(self):
self._get_u1db_data()
return self._transaction_log.get_generation_info()
def _has_conflicts(self, doc_id):
# Documents never have conflicts on server.
return False
def _put_and_update_indexes(self, doc_id, old_doc, new_rev, content):
raise NotImplementedError(self._put_and_update_indexes)
def _get_trans_id_for_gen(self, generation):
self._get_u1db_data()
trans_id = self._transaction_log.get_trans_id_for_gen(generation)
if trans_id is None:
raise errors.InvalidGeneration
return trans_id
#-------------------------------------------------------------------------
# methods specific for object stores
#-------------------------------------------------------------------------
def _ensure_u1db_data(self):
"""
Guarantee that u1db data (logs and replica info) exists in store.
"""
if not self._is_initialized():
self._initialize()
self._get_u1db_data()
U1DB_DATA_DOC_ID = 'u1db_data'
def _is_initialized(self):
"""
Verify if u1db data exists in store.
"""
doc = self._get_doc(self.U1DB_DATA_DOC_ID)
if not self._get_doc(self.U1DB_DATA_DOC_ID):
return False
return True
def _initialize(self):
"""
Create u1db data object in store.
"""
if self._replica_uid is None:
self._replica_uid = uuid.uuid4().hex
doc = self._factory(doc_id=self.U1DB_DATA_DOC_ID)
doc.content = { 'transaction_log' : [],
'sync_log' : [],
'replica_uid' : self._replica_uid }
self._put_doc(doc)
def _get_u1db_data(self, u1db_data_doc_id):
"""
Fetch u1db configuration data from backend storage.
"""
NotImplementedError(self._get_u1db_data)
def _set_u1db_data(self):
"""
Save u1db configuration data on backend storage.
"""
NotImplementedError(self._set_u1db_data)
def _set_replica_uid(self, replica_uid):
self._replica_uid = replica_uid
self._set_u1db_data()
def _get_replica_uid(self):
return self._replica_uid
replica_uid = property(
_get_replica_uid, _set_replica_uid, doc="Replica UID of the database")
|
