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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
|
# -*- coding: utf-8 -*-
# couch.py
# Copyright (C) 2013 LEAP
#
# 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/>.
"""A U1DB backend that uses CouchDB as its persistence layer."""
import json
import re
import uuid
import logging
import binascii
import time
import sys
from StringIO import StringIO
from urlparse import urljoin
from contextlib import contextmanager
from multiprocessing.pool import ThreadPool
from couchdb.client import Server, Database
from couchdb.http import (
ResourceConflict,
ResourceNotFound,
ServerError,
Session,
urljoin as couch_urljoin,
Resource,
)
from u1db import vectorclock
from u1db.errors import (
DatabaseDoesNotExist,
InvalidGeneration,
RevisionConflict,
InvalidDocId,
ConflictedDoc,
DocumentDoesNotExist,
DocumentAlreadyDeleted,
Unauthorized,
)
from u1db.backends import CommonBackend, CommonSyncTarget
from u1db.remote import http_app
from u1db.remote.server_state import ServerState
from leap.soledad.common import ddocs, errors
from leap.soledad.common.document import SoledadDocument
logger = logging.getLogger(__name__)
COUCH_TIMEOUT = 120 # timeout for transfers between Soledad server and Couch
class InvalidURLError(Exception):
"""
Exception raised when Soledad encounters a malformed URL.
"""
class CouchDocument(SoledadDocument):
"""
This is the document used for maintaining the Couch backend.
A CouchDocument can fetch and manipulate conflicts and also holds a
reference to the couch document revision. This data is used to ensure an
atomic and consistent update of the database.
"""
def __init__(self, doc_id=None, rev=None, json='{}', has_conflicts=False):
"""
Container for handling a document that is stored in couch backend.
:param doc_id: The unique document identifier.
:type doc_id: str
:param rev: The revision identifier of the document.
:type rev: str
:param json: The JSON string for this document.
:type json: str
:param has_conflicts: Boolean indicating if this document has conflicts
:type has_conflicts: bool
"""
SoledadDocument.__init__(self, doc_id, rev, json, has_conflicts)
self.couch_rev = None
self.transactions = None
self._conflicts = None
def get_conflicts(self):
"""
Get the conflicted versions of the document.
:return: The conflicted versions of the document.
:rtype: [CouchDocument]
"""
return self._conflicts or []
def set_conflicts(self, conflicts):
"""
Set the conflicted versions of the document.
:param conflicts: The conflicted versions of the document.
:type conflicts: list
"""
self._conflicts = conflicts
self.has_conflicts = len(self._conflicts) > 0
def add_conflict(self, doc):
"""
Add a conflict to this document.
:param doc: The conflicted version to be added.
:type doc: CouchDocument
"""
if self._conflicts is None:
raise Exception("Fetch conflicts first!")
self._conflicts.append(doc)
self.has_conflicts = len(self._conflicts) > 0
def delete_conflicts(self, conflict_revs):
"""
Delete conflicted versions of this document.
:param conflict_revs: The conflicted revisions to be deleted.
:type conflict_revs: [str]
"""
if self._conflicts is None:
raise Exception("Fetch conflicts first!")
self._conflicts = filter(
lambda doc: doc.rev not in conflict_revs,
self._conflicts)
self.has_conflicts = len(self._conflicts) > 0
def update(self, new_doc):
# update info
self.rev = new_doc.rev
if new_doc.is_tombstone():
self.is_tombstone()
else:
self.content = new_doc.content
self.has_conflicts = new_doc.has_conflicts
def prune_conflicts(self, doc_vcr, autoresolved_increment):
"""
Prune conflicts that are older then the current document's revision, or
whose content match to the current document's content.
Originally in u1db.CommonBackend
:param doc: The document to have conflicts pruned.
:type doc: CouchDocument
:param doc_vcr: A vector clock representing the current document's
revision.
:type doc_vcr: u1db.vectorclock.VectorClock
"""
if self.has_conflicts:
autoresolved = False
c_revs_to_prune = []
for c_doc in self._conflicts:
c_vcr = vectorclock.VectorClockRev(c_doc.rev)
if doc_vcr.is_newer(c_vcr):
c_revs_to_prune.append(c_doc.rev)
elif self.same_content_as(c_doc):
c_revs_to_prune.append(c_doc.rev)
doc_vcr.maximize(c_vcr)
autoresolved = True
if autoresolved:
doc_vcr.increment(autoresolved_increment)
self.rev = doc_vcr.as_str()
self.delete_conflicts(c_revs_to_prune)
# monkey-patch the u1db http app to use CouchDocument
http_app.Document = CouchDocument
def raise_missing_design_doc_error(exc, ddoc_path):
"""
Raise an appropriate exception when catching a ResourceNotFound when
accessing a design document.
:param exc: The exception cought.
:type exc: ResourceNotFound
:param ddoc_path: A list representing the requested path.
:type ddoc_path: list
:raise MissingDesignDocError: Raised when tried to access a missing design
document.
:raise MissingDesignDocListFunctionError: Raised when trying to access a
missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a design
document for an yet unknown reason.
"""
path = "".join(ddoc_path)
if exc.message[1] == 'missing':
raise errors.MissingDesignDocError(path)
elif exc.message[1] == 'missing function' or \
exc.message[1].startswith('missing lists function'):
raise errors.MissingDesignDocListFunctionError(path)
elif exc.message[1] == 'missing_named_view':
raise errors.MissingDesignDocNamedViewError(path)
elif exc.message[1] == 'deleted':
raise errors.MissingDesignDocDeletedError(path)
# other errors are unknown for now
raise errors.DesignDocUnknownError("%s: %s" % (path, str(exc.message)))
def raise_server_error(exc, ddoc_path):
"""
Raise an appropriate exception when catching a ServerError when
accessing a design document.
:param exc: The exception cought.
:type exc: ResourceNotFound
:param ddoc_path: A list representing the requested path.
:type ddoc_path: list
:raise MissingDesignDocListFunctionError: Raised when trying to access a
missing list function on a
design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a design
document for an yet unknown reason.
"""
path = "".join(ddoc_path)
msg = exc.message[1][0]
if msg == 'unnamed_error':
raise errors.MissingDesignDocListFunctionError(path)
elif msg == 'TypeError':
if 'point is undefined' in exc.message[1][1]:
raise errors.MissingDesignDocListFunctionError
# other errors are unknown for now
raise errors.DesignDocUnknownError(path)
class MultipartWriter(object):
"""
A multipart writer adapted from python-couchdb's one so we can PUT
documents using couch's multipart PUT.
This stripped down version does not allow for nested structures, and
contains only the essential things we need to PUT SoledadDocuments to the
couch backend.
"""
CRLF = '\r\n'
def __init__(self, fileobj, headers=None, boundary=None):
"""
Initialize the multipart writer.
"""
self.fileobj = fileobj
if boundary is None:
boundary = self._make_boundary()
self._boundary = boundary
self._build_headers('related', headers)
def add(self, mimetype, content, headers={}):
"""
Add a part to the multipart stream.
"""
self.fileobj.write('--')
self.fileobj.write(self._boundary)
self.fileobj.write(self.CRLF)
headers['Content-Type'] = mimetype
self._write_headers(headers)
if content:
# XXX: throw an exception if a boundary appears in the content??
self.fileobj.write(content)
self.fileobj.write(self.CRLF)
def close(self):
"""
Close the multipart stream.
"""
self.fileobj.write('--')
self.fileobj.write(self._boundary)
# be careful not to have anything after '--', otherwise old couch
# versions (including bigcouch) will fail.
self.fileobj.write('--')
def _make_boundary(self):
"""
Create a boundary to discern multi parts.
"""
try:
from uuid import uuid4
return '==' + uuid4().hex + '=='
except ImportError:
from random import randrange
token = randrange(sys.maxint)
format = '%%0%dd' % len(repr(sys.maxint - 1))
return '===============' + (format % token) + '=='
def _write_headers(self, headers):
"""
Write a part header in the buffer stream.
"""
if headers:
for name in sorted(headers.keys()):
value = headers[name]
self.fileobj.write(name)
self.fileobj.write(': ')
self.fileobj.write(value)
self.fileobj.write(self.CRLF)
self.fileobj.write(self.CRLF)
def _build_headers(self, subtype, headers):
"""
Build the main headers of the multipart stream.
This is here so we can send headers separete from content using
python-couchdb API.
"""
self.headers = {}
self.headers['Content-Type'] = 'multipart/%s; boundary="%s"' % \
(subtype, self._boundary)
if headers:
for name in sorted(headers.keys()):
value = headers[name]
self.headers[name] = value
@contextmanager
def couch_server(url):
"""
Provide a connection to a couch server and cleanup after use.
For database creation and deletion we use an ephemeral connection to the
couch server. That connection has to be properly closed, so we provide it
as a context manager.
:param url: The URL of the Couch server.
:type url: str
"""
session = Session(timeout=COUCH_TIMEOUT)
server = Server(url=url, session=session)
yield server
THREAD_POOL = ThreadPool(20)
class CouchDatabase(CommonBackend):
"""
A U1DB implementation that uses CouchDB as its persistence layer.
"""
@classmethod
def open_database(cls, url, create, replica_uid=None, ensure_ddocs=False):
"""
Open a U1DB database using CouchDB as backend.
:param url: the url of the database replica
:type url: str
:param create: should the replica be created if it does not exist?
:type create: bool
:param replica_uid: an optional unique replica identifier
:type replica_uid: str
:param ensure_ddocs: Ensure that the design docs exist on server.
:type ensure_ddocs: bool
:return: the database instance
:rtype: CouchDatabase
"""
# get database from url
m = re.match('(^https?://[^/]+)/(.+)$', url)
if not m:
raise InvalidURLError
url = m.group(1)
dbname = m.group(2)
with couch_server(url) as server:
try:
server[dbname]
except ResourceNotFound:
if not create:
raise DatabaseDoesNotExist()
server.create(dbname)
return cls(
url, dbname, replica_uid=replica_uid, ensure_ddocs=ensure_ddocs)
def __init__(self, url, dbname, replica_uid=None, ensure_ddocs=True):
"""
Create a new Couch data container.
:param url: the url of the couch database
:type url: str
:param dbname: the database name
:type dbname: str
:param replica_uid: an optional unique replica identifier
:type replica_uid: str
:param ensure_ddocs: Ensure that the design docs exist on server.
:type ensure_ddocs: bool
"""
# save params
self._url = url
self._session = Session(timeout=COUCH_TIMEOUT)
self._factory = CouchDocument
self._real_replica_uid = None
# configure couch
self._dbname = dbname
self._database = Database(
urljoin(self._url, self._dbname),
self._session)
try:
self._database.info()
except ResourceNotFound:
raise DatabaseDoesNotExist()
if replica_uid is not None:
self._set_replica_uid(replica_uid)
if ensure_ddocs:
self.ensure_ddocs_on_db()
self._cache = None
@property
def cache(self):
if self._cache is not None:
return self._cache
else:
return {}
def ensure_ddocs_on_db(self):
"""
Ensure that the design documents used by the backend exist on the
couch database.
"""
for ddoc_name in ['docs', 'syncs', 'transactions']:
try:
self._database.info(ddoc_name)
except ResourceNotFound:
ddoc = json.loads(
binascii.a2b_base64(
getattr(ddocs, ddoc_name)))
self._database.save(ddoc)
def get_sync_target(self):
"""
Return a SyncTarget object, for another u1db to synchronize with.
:return: The sync target.
:rtype: CouchSyncTarget
"""
return CouchSyncTarget(self)
def delete_database(self):
"""
Delete a U1DB CouchDB database.
"""
with couch_server(self._url) as server:
del(server[self._dbname])
def close(self):
"""
Release any resources associated with this database.
:return: True if db was succesfully closed.
:rtype: bool
"""
self._url = None
self._full_commit = None
self._session = None
self._database = None
return True
def __del__(self):
"""
Close the database upon garbage collection.
"""
self.close()
def _set_replica_uid(self, replica_uid):
"""
Force the replica uid to be set.
:param replica_uid: The new replica uid.
:type replica_uid: str
"""
try:
# set on existent config document
doc = self._database['u1db_config']
doc['replica_uid'] = replica_uid
except ResourceNotFound:
# or create the config document
doc = {
'_id': 'u1db_config',
'replica_uid': replica_uid,
}
self._database.save(doc)
self._real_replica_uid = replica_uid
def _get_replica_uid(self):
"""
Get the replica uid.
:return: The replica uid.
:rtype: str
"""
if self._real_replica_uid is not None:
self.cache[self._url] = {'replica_uid': self._real_replica_uid}
return self._real_replica_uid
if self._url in self.cache:
return self.cache[self._url]['replica_uid']
try:
# grab replica_uid from server
doc = self._database['u1db_config']
self.cache[self._url] = doc
self._real_replica_uid = doc['replica_uid']
return self._real_replica_uid
except ResourceNotFound:
# create a unique replica_uid
self._real_replica_uid = uuid.uuid4().hex
self._set_replica_uid(self._real_replica_uid)
return self._real_replica_uid
_replica_uid = property(_get_replica_uid, _set_replica_uid)
replica_uid = property(_get_replica_uid)
def _get_generation(self):
"""
Return the current generation.
:return: The current generation.
:rtype: int
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
# query a couch list function
if self.replica_uid + '_gen' in self.cache:
return self.cache[self.replica_uid + '_gen']['generation']
ddoc_path = ['_design', 'transactions', '_list', 'generation', 'log']
res = self._database.resource(*ddoc_path)
try:
response = res.get_json()
self.cache[self.replica_uid + '_gen'] = response[2]
return response[2]['generation']
except ResourceNotFound as e:
raise_missing_design_doc_error(e, ddoc_path)
except ServerError as e:
raise_server_error(e, ddoc_path)
def _get_generation_info(self):
"""
Return the current generation.
:return: A tuple containing the current generation and transaction id.
:rtype: (int, str)
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
if self.replica_uid + '_gen' in self.cache:
response = self.cache[self.replica_uid + '_gen']
return (response['generation'], response['transaction_id'])
# query a couch list function
ddoc_path = ['_design', 'transactions', '_list', 'generation', 'log']
res = self._database.resource(*ddoc_path)
try:
response = res.get_json()
self.cache[self.replica_uid + '_gen'] = response[2]
return (response[2]['generation'], response[2]['transaction_id'])
except ResourceNotFound as e:
raise_missing_design_doc_error(e, ddoc_path)
except ServerError as e:
raise_server_error(e, ddoc_path)
def _get_trans_id_for_gen(self, generation):
"""
Get the transaction id corresponding to a particular generation.
:param generation: The generation for which to get the transaction id.
:type generation: int
:return: The transaction id for C{generation}.
:rtype: str
:raise InvalidGeneration: Raised when the generation does not exist.
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
if generation == 0:
return ''
# query a couch list function
ddoc_path = [
'_design', 'transactions', '_list', 'trans_id_for_gen', 'log'
]
res = self._database.resource(*ddoc_path)
try:
response = res.get_json(gen=generation)
if response[2] == {}:
raise InvalidGeneration
return response[2]['transaction_id']
except ResourceNotFound as e:
raise_missing_design_doc_error(e, ddoc_path)
except ServerError as e:
raise_server_error(e, ddoc_path)
def _get_transaction_log(self):
"""
This is only for the test suite, it is not part of the api.
:return: The complete transaction log.
:rtype: [(str, str)]
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
# query a couch view
ddoc_path = ['_design', 'transactions', '_view', 'log']
res = self._database.resource(*ddoc_path)
try:
response = res.get_json()
return map(
lambda row: (row['id'], row['value']),
response[2]['rows'])
except ResourceNotFound as e:
raise_missing_design_doc_error(e, ddoc_path)
def _get_doc(self, doc_id, check_for_conflicts=False):
"""
Extract the document from storage.
This can return None if the document doesn't exist.
:param doc_id: The unique document identifier
:type doc_id: str
:param check_for_conflicts: If set to False, then the conflict check
will be skipped.
:type check_for_conflicts: bool
:return: The document.
:rtype: CouchDocument
"""
# get document with all attachments (u1db content and eventual
# conflicts)
try:
result = \
self._database.resource(doc_id).get_json(
attachments=True)[2]
except ResourceNotFound:
return None
return self.__parse_doc_from_couch(result, doc_id, check_for_conflicts)
def __parse_doc_from_couch(self, result, doc_id, check_for_conflicts=False):
# restrict to u1db documents
if 'u1db_rev' not in result:
return None
doc = self._factory(doc_id, result['u1db_rev'])
# set contents or make tombstone
if '_attachments' not in result \
or 'u1db_content' not in result['_attachments']:
doc.make_tombstone()
else:
doc.content = json.loads(
binascii.a2b_base64(
result['_attachments']['u1db_content']['data']))
# determine if there are conflicts
if check_for_conflicts \
and '_attachments' in result \
and 'u1db_conflicts' in result['_attachments']:
doc.set_conflicts(
self._build_conflicts(
doc.doc_id,
json.loads(binascii.a2b_base64(
result['_attachments']['u1db_conflicts']['data']))))
# store couch revision
doc.couch_rev = result['_rev']
# store transactions
doc.transactions = result['u1db_transactions']
return doc
def get_doc(self, doc_id, include_deleted=False):
"""
Get the JSON string for the given document.
:param doc_id: The unique document identifier
:type doc_id: str
:param include_deleted: If set to True, deleted documents will be
returned with empty content. Otherwise asking for a deleted
document will return None.
:type include_deleted: bool
:return: A document object.
:rtype: CouchDocument.
"""
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 get_all_docs(self, include_deleted=False):
"""
Get the JSON content for all documents in the database.
:param include_deleted: If set to True, deleted documents will be
returned with empty content. Otherwise deleted
documents will not be included in the results.
:type include_deleted: bool
:return: (generation, [CouchDocument])
The current generation of the database, followed by a list of all
the documents in the database.
:rtype: (int, [CouchDocument])
"""
generation = self._get_generation()
results = list(self.get_docs(self._database,
include_deleted=include_deleted))
return (generation, results)
def _put_doc(self, old_doc, doc):
"""
Put the document in the Couch backend database.
Note that C{old_doc} must have been fetched with the parameter
C{check_for_conflicts} equal to True, so we can properly update the
new document using the conflict information from the old one.
:param old_doc: The old document version.
:type old_doc: CouchDocument
:param doc: The document to be put.
:type doc: CouchDocument
:raise RevisionConflict: Raised when trying to update a document but
couch revisions mismatch.
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
attachments = {} # we save content and conflicts as attachments
parts = [] # and we put it using couch's multipart PUT
# save content as attachment
if doc.is_tombstone() is False:
content = doc.get_json()
attachments['u1db_content'] = {
'follows': True,
'content_type': 'application/octet-stream',
'length': len(content),
}
parts.append(content)
# save conflicts as attachment
if doc.has_conflicts is True:
conflicts = json.dumps(
map(lambda cdoc: (cdoc.rev, cdoc.content),
doc.get_conflicts()))
attachments['u1db_conflicts'] = {
'follows': True,
'content_type': 'application/octet-stream',
'length': len(conflicts),
}
parts.append(conflicts)
# store old transactions, if any
transactions = old_doc.transactions[:] if old_doc is not None else []
# create a new transaction id and timestamp it so the transaction log
# is consistent when querying the database.
transactions.append(
# here we store milliseconds to keep consistent with javascript
# Date.prototype.getTime() which was used before inside a couchdb
# update handler.
(int(time.time() * 1000),
self._allocate_transaction_id()))
# build the couch document
couch_doc = {
'_id': doc.doc_id,
'u1db_rev': doc.rev,
'u1db_transactions': transactions,
'_attachments': attachments,
}
# if we are updating a doc we have to add the couch doc revision
if old_doc is not None:
couch_doc['_rev'] = old_doc.couch_rev
# prepare the multipart PUT
buf = StringIO()
envelope = MultipartWriter(buf)
envelope.add('application/json', json.dumps(couch_doc))
for part in parts:
envelope.add('application/octet-stream', part)
envelope.close()
# try to save and fail if there's a revision conflict
try:
resource = self._new_resource()
resource.put_json(
doc.doc_id, body=buf.getvalue(), headers=envelope.headers)
except ResourceConflict:
raise RevisionConflict()
if self.replica_uid + '_gen' in self.cache:
gen_info = self.cache[self.replica_uid + '_gen']
gen_info['generation'] += 1
gen_info['transaction_id'] = transactions[-1][1]
def put_doc(self, doc):
"""
Update a document.
If the document currently has conflicts, put will fail.
If the database specifies a maximum document size and the document
exceeds it, put will fail and raise a DocumentTooBig exception.
:param doc: A Document with new content.
:return: new_doc_rev - The new revision identifier for the document.
The Document object will also be updated.
:raise InvalidDocId: Raised if the document's id is invalid.
:raise DocumentTooBig: Raised if the document size is too big.
:raise ConflictedDoc: Raised if the document has conflicts.
"""
if doc.doc_id is None:
raise InvalidDocId()
self._check_doc_id(doc.doc_id)
self._check_doc_size(doc)
old_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
if old_doc and old_doc.has_conflicts:
raise 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 RevisionConflict()
else:
if doc.rev is not None:
raise RevisionConflict()
new_rev = self._allocate_doc_rev(doc.rev)
doc.rev = new_rev
self._put_doc(old_doc, doc)
return new_rev
def whats_changed(self, old_generation=0):
"""
Return a list of documents that have changed since old_generation.
:param old_generation: The generation of the database in the old
state.
:type old_generation: int
:return: (generation, trans_id, [(doc_id, generation, trans_id),...])
The current generation of the database, its associated
transaction id, and a list of of changed documents since
old_generation, represented by tuples with for each document
its doc_id and the generation and transaction id corresponding
to the last intervening change and sorted by generation (old
changes first)
:rtype: (int, str, [(str, int, str)])
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
# query a couch list function
ddoc_path = [
'_design', 'transactions', '_list', 'whats_changed', 'log'
]
res = self._database.resource(*ddoc_path)
try:
response = res.get_json(old_gen=old_generation)
results = map(
lambda row:
(row['generation'], row['doc_id'], row['transaction_id']),
response[2]['transactions'])
results.reverse()
cur_gen = old_generation
seen = set()
changes = []
newest_trans_id = ''
for generation, doc_id, trans_id in results:
if doc_id not in seen:
changes.append((doc_id, generation, trans_id))
seen.add(doc_id)
if changes:
cur_gen = changes[0][1] # max generation
newest_trans_id = changes[0][2]
changes.reverse()
else:
cur_gen, newest_trans_id = self._get_generation_info()
return cur_gen, newest_trans_id, changes
except ResourceNotFound as e:
raise_missing_design_doc_error(e, ddoc_path)
except ServerError as e:
raise_server_error(e, ddoc_path)
def delete_doc(self, doc):
"""
Mark a document as deleted.
Will abort if the current revision doesn't match doc.rev.
This will also set doc.content to None.
:param doc: The document to mark as deleted.
:type doc: CouchDocument.
:raise DocumentDoesNotExist: Raised if the document does not
exist.
:raise RevisionConflict: Raised if the revisions do not match.
:raise DocumentAlreadyDeleted: Raised if the document is
already deleted.
:raise ConflictedDoc: Raised if the doc has conflicts.
"""
old_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
if old_doc is None:
raise DocumentDoesNotExist
if old_doc.rev != doc.rev:
raise RevisionConflict()
if old_doc.is_tombstone():
raise DocumentAlreadyDeleted
if old_doc.has_conflicts:
raise ConflictedDoc()
new_rev = self._allocate_doc_rev(doc.rev)
doc.rev = new_rev
doc.make_tombstone()
self._put_doc(old_doc, doc)
return new_rev
def _build_conflicts(self, doc_id, attached_conflicts):
"""
Build the conflicted documents list from the conflicts attachment
fetched from a couch document.
:param attached_conflicts: The document's conflicts as fetched from a
couch document attachment.
:type attached_conflicts: dict
"""
conflicts = []
for doc_rev, content in attached_conflicts:
doc = self._factory(doc_id, doc_rev)
if content is None:
doc.make_tombstone()
else:
doc.content = content
conflicts.append(doc)
return conflicts
def get_doc_conflicts(self, doc_id, couch_rev=None):
"""
Get the conflicted versions of a document.
If the C{couch_rev} parameter is not None, conflicts for a specific
document's couch revision are returned.
:param couch_rev: The couch document revision.
:type couch_rev: str
:return: A list of conflicted versions of the document.
:rtype: list
"""
# request conflicts attachment from server
params = {}
conflicts = []
if couch_rev is not None:
params['rev'] = couch_rev # restric document's couch revision
else:
# TODO: move into resource logic!
first_entry = self._get_doc(doc_id, check_for_conflicts=True)
conflicts.append(first_entry)
resource = self._database.resource(doc_id, 'u1db_conflicts')
try:
response = resource.get_json(**params)
return conflicts + self._build_conflicts(
doc_id, json.loads(response[2].read()))
except ResourceNotFound:
return []
def _get_replica_gen_and_trans_id(self, other_replica_uid):
"""
Return the last known generation and transaction id for the other db
replica.
When you do a synchronization with another replica, the Database keeps
track of what generation the other database replica was at, and what
the associated transaction id was. This is used to determine what data
needs to be sent, and if two databases are claiming to be the same
replica.
:param other_replica_uid: The identifier for the other replica.
:type other_replica_uid: str
:return: A tuple containing the generation and transaction id we
encountered during synchronization. If we've never
synchronized with the replica, this is (0, '').
:rtype: (int, str)
"""
if other_replica_uid in self.cache:
return self.cache[other_replica_uid]
doc_id = 'u1db_sync_%s' % other_replica_uid
try:
doc = self._database[doc_id]
except ResourceNotFound:
doc = {
'_id': doc_id,
'generation': 0,
'transaction_id': '',
}
self._database.save(doc)
result = doc['generation'], doc['transaction_id']
self.cache[other_replica_uid] = result
return result
def _set_replica_gen_and_trans_id(self, other_replica_uid,
other_generation, other_transaction_id,
number_of_docs=None, doc_idx=None,
sync_id=None):
"""
Set the last-known generation and transaction id for the other
database replica.
We have just performed some synchronization, and we want to track what
generation the other replica was at. See also
_get_replica_gen_and_trans_id.
:param other_replica_uid: The U1DB identifier for the other replica.
:type other_replica_uid: str
:param other_generation: The generation number for the other replica.
:type other_generation: int
:param other_transaction_id: The transaction id associated with the
generation.
:type other_transaction_id: str
:param number_of_docs: The total amount of documents sent on this sync
session.
:type number_of_docs: int
:param doc_idx: The index of the current document being sent.
:type doc_idx: int
:param sync_id: The id of the current sync session.
:type sync_id: str
"""
if other_replica_uid is not None and other_generation is not None:
self._do_set_replica_gen_and_trans_id(
other_replica_uid, other_generation, other_transaction_id,
number_of_docs=number_of_docs, doc_idx=doc_idx,
sync_id=sync_id)
def _do_set_replica_gen_and_trans_id(
self, other_replica_uid, other_generation, other_transaction_id,
number_of_docs=None, doc_idx=None, sync_id=None):
"""
Set the last-known generation and transaction id for the other
database replica.
We have just performed some synchronization, and we want to track what
generation the other replica was at. See also
_get_replica_gen_and_trans_id.
:param other_replica_uid: The U1DB identifier for the other replica.
:type other_replica_uid: str
:param other_generation: The generation number for the other replica.
:type other_generation: int
:param other_transaction_id: The transaction id associated with the
generation.
:type other_transaction_id: str
:param number_of_docs: The total amount of documents sent on this sync
session.
:type number_of_docs: int
:param doc_idx: The index of the current document being sent.
:type doc_idx: int
:param sync_id: The id of the current sync session.
:type sync_id: str
"""
self.cache[other_replica_uid] = (other_generation, other_transaction_id)
doc_id = 'u1db_sync_%s' % other_replica_uid
try:
doc = self._database[doc_id]
except ResourceNotFound:
doc = {'_id': doc_id}
doc['generation'] = other_generation
doc['transaction_id'] = other_transaction_id
self._database.save(doc)
self.cache[other_replica_uid] = (other_generation, other_transaction_id)
def _force_doc_sync_conflict(self, doc):
"""
Add a conflict and force a document put.
:param doc: The document to be put.
:type doc: CouchDocument
"""
my_doc = self._get_doc(doc.doc_id)
self._prune_conflicts(doc, vectorclock.VectorClockRev(doc.rev))
doc.add_conflict(self._factory(doc.doc_id, my_doc.rev, my_doc.get_json()))
doc.has_conflicts = True
self._put_doc(my_doc, doc)
def resolve_doc(self, doc, conflicted_doc_revs):
"""
Mark a document as no longer conflicted.
We take the list of revisions that the client knows about that it is
superseding. This may be a different list from the actual current
conflicts, in which case only those are removed as conflicted. This
may fail if the conflict list is significantly different from the
supplied information. (sync could have happened in the background from
the time you GET_DOC_CONFLICTS until the point where you RESOLVE)
:param doc: A Document with the new content to be inserted.
:type doc: CouchDocument
:param conflicted_doc_revs: A list of revisions that the new content
supersedes.
:type conflicted_doc_revs: [str]
:raise MissingDesignDocError: Raised when tried to access a missing
design document.
:raise MissingDesignDocListFunctionError: Raised when trying to access
a missing list function on a
design document.
:raise MissingDesignDocNamedViewError: Raised when trying to access a
missing named view on a design
document.
:raise MissingDesignDocDeletedError: Raised when trying to access a
deleted design document.
:raise MissingDesignDocUnknownError: Raised when failed to access a
design document for an yet
unknown reason.
"""
cur_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
new_rev = self._ensure_maximal_rev(cur_doc.rev,
conflicted_doc_revs)
superseded_revs = set(conflicted_doc_revs)
doc.rev = new_rev
# this backend stores conflicts as properties of the documents, so we
# have to copy these conflicts over to the document being updated.
if cur_doc.rev in superseded_revs:
# the newer doc version will supersede the one in the database, so
# we copy conflicts before updating the backend.
doc.set_conflicts(cur_doc.get_conflicts()) # copy conflicts over.
doc.delete_conflicts(superseded_revs)
self._put_doc(cur_doc, doc)
else:
# the newer doc version does not supersede the one in the
# database, so we will add a conflict to the database and copy
# those over to the document the user has in her hands.
cur_doc.add_conflict(doc)
cur_doc.delete_conflicts(superseded_revs)
self._put_doc(cur_doc, cur_doc) # just update conflicts
# backend has been updated with current conflicts, now copy them
# to the current document.
doc.set_conflicts(cur_doc.get_conflicts())
def _put_doc_if_newer(self, doc, save_conflict, replica_uid, replica_gen,
replica_trans_id='', number_of_docs=None,
doc_idx=None, sync_id=None):
"""
Insert/update document into the database with a given revision.
This api is used during synchronization operations.
If a document would conflict and save_conflict is set to True, the
content will be selected as the 'current' content for doc.doc_id,
even though doc.rev doesn't supersede the currently stored revision.
The currently stored document will be added to the list of conflict
alternatives for the given doc_id.
This forces the new content to be 'current' so that we get convergence
after synchronizing, even if people don't resolve conflicts. Users can
then notice that their content is out of date, update it, and
synchronize again. (The alternative is that users could synchronize and
think the data has propagated, but their local copy looks fine, and the
remote copy is never updated again.)
:param doc: A document object
:type doc: CouchDocument
:param save_conflict: If this document is a conflict, do you want to
save it as a conflict, or just ignore it.
:type save_conflict: bool
:param replica_uid: A unique replica identifier.
:type replica_uid: str
:param replica_gen: The generation of the replica corresponding to the
this document. The replica arguments are optional,
but are used during synchronization.
:type replica_gen: int
:param replica_trans_id: The transaction_id associated with the
generation.
:type replica_trans_id: str
:param number_of_docs: The total amount of documents sent on this sync
session.
:type number_of_docs: int
:param doc_idx: The index of the current document being sent.
:type doc_idx: int
:param sync_id: The id of the current sync session.
:type sync_id: str
:return: (state, at_gen) - If we don't have doc_id already, or if
doc_rev supersedes the existing document revision, then the
content will be inserted, and state is 'inserted'. If
doc_rev is less than or equal to the existing revision, then
the put is ignored and state is respecitvely 'superseded' or
'converged'. If doc_rev is not strictly superseded or
supersedes, then state is 'conflicted'. The document will not
be inserted if save_conflict is False. For 'inserted' or
'converged', at_gen is the insertion/current generation.
:rtype: (str, int)
"""
if not isinstance(doc, CouchDocument):
doc = self._factory(doc.doc_id, doc.rev, doc.get_json())
my_doc = self._get_doc(doc.doc_id, check_for_conflicts=True)
if my_doc:
doc.set_conflicts(my_doc.get_conflicts())
return CommonBackend._put_doc_if_newer(self, doc, save_conflict, replica_uid,
replica_gen, replica_trans_id)
def _put_and_update_indexes(self, cur_doc, doc):
self._put_doc(cur_doc, doc)
def get_docs(self, doc_ids, check_for_conflicts=True,
include_deleted=False):
"""
Get the JSON content for many documents.
:param doc_ids: A list of document identifiers or None for all.
:type doc_ids: list
:param check_for_conflicts: If set to False, then the conflict check
will be skipped, and 'None' will be
returned instead of True/False.
:type check_for_conflicts: bool
:param include_deleted: If set to True, deleted documents will be
returned with empty content. Otherwise deleted
documents will not be included in the results.
:return: iterable giving the Document object for each document id
in matching doc_ids order.
:rtype: iterable
"""
get_one = lambda doc_id: self._get_doc(doc_id, check_for_conflicts)
docs = [THREAD_POOL.apply_async(get_one, [doc_id])
for doc_id in doc_ids]
for doc in docs:
doc = doc.get()
if not doc or not include_deleted and doc.is_tombstone():
continue
yield doc
def _prune_conflicts(self, doc, doc_vcr):
"""
Overrides original method, but it is implemented elsewhere for
simplicity.
"""
doc.prune_conflicts(doc_vcr, self._replica_uid)
def _new_resource(self, *path):
"""
Return a new resource for accessing a couch database.
:return: A resource for accessing a couch database.
:rtype: couchdb.http.Resource
"""
# Workaround for: https://leap.se/code/issues/5448
url = couch_urljoin(self._database.resource.url, *path)
resource = Resource(url, Session(timeout=COUCH_TIMEOUT))
resource.credentials = self._database.resource.credentials
resource.headers = self._database.resource.headers.copy()
return resource
class CouchSyncTarget(CommonSyncTarget):
"""
Functionality for using a CouchDatabase as a synchronization target.
"""
def get_sync_info(self, source_replica_uid):
source_gen, source_trans_id = self._db._get_replica_gen_and_trans_id(
source_replica_uid)
my_gen, my_trans_id = self._db._get_generation_info()
return (
self._db._replica_uid, my_gen, my_trans_id, source_gen,
source_trans_id)
def record_sync_info(self, source_replica_uid, source_replica_generation,
source_replica_transaction_id):
if self._trace_hook:
self._trace_hook('record_sync_info')
self._db._set_replica_gen_and_trans_id(
source_replica_uid, source_replica_generation,
source_replica_transaction_id)
class CouchServerState(ServerState):
"""
Inteface of the WSGI server with the CouchDB backend.
"""
def __init__(self, couch_url):
"""
Initialize the couch server state.
:param couch_url: The URL for the couch database.
:type couch_url: str
"""
self.couch_url = couch_url
def open_database(self, dbname):
"""
Open a couch database.
:param dbname: The name of the database to open.
:type dbname: str
:return: The CouchDatabase object.
:rtype: CouchDatabase
"""
db = CouchDatabase(
self.couch_url,
dbname,
ensure_ddocs=False)
return db
def ensure_database(self, dbname):
"""
Ensure couch database exists.
Usually, this method is used by the server to ensure the existence of
a database. In our setup, the Soledad user that accesses the underlying
couch server should never have permission to create (or delete)
databases. But, in case it ever does, by raising an exception here we
have one more guarantee that no modified client will be able to
enforce creation of a database when syncing.
:param dbname: The name of the database to ensure.
:type dbname: str
:raise Unauthorized: Always, because Soledad server is not allowed to
create databases.
"""
raise Unauthorized()
def delete_database(self, dbname):
"""
Delete couch database.
:param dbname: The name of the database to delete.
:type dbname: str
:raise Unauthorized: Always, because Soledad server is not allowed to
delete databases.
"""
raise Unauthorized()
|