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
|
# -*- coding: utf-8 -*-
# adbapi.py
# Copyright (C) 2013, 2014 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/>.
"""
An asyncrhonous interface to soledad using sqlcipher backend.
It uses twisted.enterprise.adbapi.
"""
import re
import os
import sys
from functools import partial
from twisted.enterprise import adbapi
from twisted.python import log
from zope.proxy import ProxyBase, setProxiedObject
from leap.soledad.client import sqlcipher as soledad_sqlcipher
DEBUG_SQL = os.environ.get("LEAP_DEBUG_SQL")
if DEBUG_SQL:
log.startLogging(sys.stdout)
def getConnectionPool(opts, openfun=None, driver="pysqlcipher"):
"""
Return a connection pool.
:param opts:
Options for the SQLCipher connection.
:type opts: SQLCipherOptions
:param openfun:
Callback invoked after every connect() on the underlying DB-API
object.
:type openfun: callable
:param driver:
The connection driver.
:type driver: str
:return: A U1DB connection pool.
:rtype: U1DBConnectionPool
"""
if openfun is None and driver == "pysqlcipher":
openfun = partial(soledad_sqlcipher.set_init_pragmas, opts=opts)
return U1DBConnectionPool(
"%s.dbapi2" % driver, database=opts.path,
check_same_thread=False, cp_openfun=openfun)
class U1DBConnection(adbapi.Connection):
"""
A wrapper for a U1DB connection instance.
"""
u1db_wrapper = soledad_sqlcipher.SoledadSQLCipherWrapper
"""
The U1DB wrapper to use.
"""
def __init__(self, pool, init_u1db=False):
"""
:param pool: The pool of connections to that owns this connection.
:type pool: adbapi.ConnectionPool
:param init_u1db: Wether the u1db database should be initialized.
:type init_u1db: bool
"""
self.init_u1db = init_u1db
adbapi.Connection.__init__(self, pool)
def reconnect(self):
"""
Reconnect to the U1DB database.
"""
if self._connection is not None:
self._pool.disconnect(self._connection)
self._connection = self._pool.connect()
if self.init_u1db:
self._u1db = self.u1db_wrapper(self._connection)
def __getattr__(self, name):
"""
Route the requested attribute either to the U1DB wrapper or to the
connection.
:param name: The name of the attribute.
:type name: str
"""
if name.startswith('u1db_'):
attr = re.sub('^u1db_', '', name)
return getattr(self._u1db, attr)
else:
return getattr(self._connection, name)
class U1DBTransaction(adbapi.Transaction):
"""
A wrapper for a U1DB 'cursor' object.
"""
def __getattr__(self, name):
"""
Route the requested attribute either to the U1DB wrapper of the
connection or to the actual connection cursor.
:param name: The name of the attribute.
:type name: str
"""
if name.startswith('u1db_'):
attr = re.sub('^u1db_', '', name)
return getattr(self._connection._u1db, attr)
else:
return getattr(self._cursor, name)
class U1DBConnectionPool(adbapi.ConnectionPool):
"""
Represent a pool of connections to an U1DB database.
"""
connectionFactory = U1DBConnection
transactionFactory = U1DBTransaction
def __init__(self, *args, **kwargs):
"""
Initialize the connection pool.
"""
adbapi.ConnectionPool.__init__(self, *args, **kwargs)
# all u1db connections, hashed by thread-id
self._u1dbconnections = {}
# The replica uid, primed by the connections on init.
self.replica_uid = ProxyBase(None)
conn = self.connectionFactory(self, init_u1db=True)
replica_uid = conn._u1db._real_replica_uid
setProxiedObject(self.replica_uid, replica_uid)
def runU1DBQuery(self, meth, *args, **kw):
"""
Execute a U1DB query in a thread, using a pooled connection.
:param meth: The U1DB wrapper method name.
:type meth: str
:return: a Deferred which will fire the return value of
'self._runU1DBQuery(Transaction(...), *args, **kw)', or a Failure.
:rtype: twisted.internet.defer.Deferred
"""
meth = "u1db_%s" % meth
return self.runInteraction(self._runU1DBQuery, meth, *args, **kw)
def _runU1DBQuery(self, trans, meth, *args, **kw):
"""
Execute a U1DB query.
:param trans: An U1DB transaction.
:type trans: adbapi.Transaction
:param meth: the U1DB wrapper method name.
:type meth: str
"""
meth = getattr(trans, meth)
return meth(*args, **kw)
def _runInteraction(self, interaction, *args, **kw):
"""
Interact with the database and return the result.
:param interaction:
A callable object whose first argument is an
L{adbapi.Transaction}.
:type interaction: callable
:return: a Deferred which will fire the return value of
'interaction(Transaction(...), *args, **kw)', or a Failure.
:rtype: twisted.internet.defer.Deferred
"""
tid = self.threadID()
u1db = self._u1dbconnections.get(tid)
conn = self.connectionFactory(self, init_u1db=not bool(u1db))
if self.replica_uid is None:
replica_uid = conn._u1db._real_replica_uid
setProxiedObject(self.replica_uid, replica_uid)
if u1db is None:
self._u1dbconnections[tid] = conn._u1db
else:
conn._u1db = u1db
trans = self.transactionFactory(self, conn)
try:
result = interaction(trans, *args, **kw)
trans.close()
conn.commit()
return result
except:
excType, excValue, excTraceback = sys.exc_info()
try:
conn.rollback()
except:
log.err(None, "Rollback failed")
raise excType, excValue, excTraceback
def finalClose(self):
"""
A final close, only called by the shutdown trigger.
"""
self.shutdownID = None
self.threadpool.stop()
self.running = False
for conn in self.connections.values():
self._close(conn)
for u1db in self._u1dbconnections.values():
self._close(u1db)
self.connections.clear()
|