/usr/lib/python2.7/dist-packages/txdav/base/propertystore/sql.py is in calendarserver 5.2+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- test-case-name: txdav.base.propertystore.test.test_sql -*-
##
# Copyright (c) 2010-2014 Apple Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##
"""
PostgreSQL data store.
"""
__all__ = [
"PropertyStore",
]
from twistedcaldav.memcacher import Memcacher
from twext.enterprise.dal.syntax import (
Select, Parameter, Update, Insert, TableSyntax, Delete)
from txdav.xml.parser import WebDAVDocument
from txdav.common.icommondatastore import AllRetriesFailed
from txdav.common.datastore.sql_tables import schema
from txdav.base.propertystore.base import (AbstractPropertyStore,
PropertyName, validKey)
from twisted.internet.defer import inlineCallbacks, returnValue
prop = schema.RESOURCE_PROPERTY
class PropertyStore(AbstractPropertyStore):
"""
We are going to use memcache to cache properties per-resource/per-user. However, we
need to be able to invalidate on a per-resource basis, in addition to per-resource/per-user.
So we will also track in memcache which resource/uid tokens are valid. That way we can remove
the tracking entry to completely invalidate all the per-resource/per-user pairs.
"""
_cacher = Memcacher("SQL.props", pickle=True, key_normalization=False)
def __init__(self, *a, **kw):
raise NotImplementedError(
"do not construct directly, call PropertyStore.load()"
)
_allWithID = Select(
[prop.NAME, prop.VIEWER_UID, prop.VALUE],
From=prop,
Where=prop.RESOURCE_ID == Parameter("resourceID")
)
_allWithIDViewer = Select(
[prop.NAME, prop.VALUE],
From=prop,
Where=(prop.RESOURCE_ID == Parameter("resourceID")).And
(prop.VIEWER_UID == Parameter("viewerID"))
)
def _cacheToken(self, userid):
return "{0!s}/{1}".format(self._resourceID, userid)
@inlineCallbacks
def _refresh(self, txn):
"""
Load, or re-load, this object with the given transaction; first from
memcache, then pulling from the database again.
"""
# Cache existing properties in this object
# Look for memcache entry first
@inlineCallbacks
def _cache_user_props(uid):
# First check whether uid already has a valid cached entry
rows = None
if self._cacher is not None:
valid_cached_users = yield self._cacher.get(str(self._resourceID))
if valid_cached_users is None:
valid_cached_users = set()
# Fetch cached user data if valid and present
if uid in valid_cached_users:
rows = yield self._cacher.get(self._cacheToken(uid))
# If no cached data, fetch from SQL DB and cache
if rows is None:
rows = yield self._allWithIDViewer.on(
txn,
resourceID=self._resourceID,
viewerID=uid,
)
if self._cacher is not None:
yield self._cacher.set(self._cacheToken(uid), rows if rows is not None else ())
# Mark this uid as valid
valid_cached_users.add(uid)
yield self._cacher.set(str(self._resourceID), valid_cached_users)
for name, value in rows:
self._cached[(name, uid)] = value
# Cache for the owner first, then the sharee if different
yield _cache_user_props(self._defaultUser)
if self._perUser != self._defaultUser:
yield _cache_user_props(self._perUser)
@classmethod
@inlineCallbacks
def load(cls, defaultuser, shareUser, txn, resourceID, created=False, notifyCallback=None):
"""
@param notifyCallback: a callable used to trigger notifications when the
property store changes.
"""
self = cls.__new__(cls)
super(PropertyStore, self).__init__(defaultuser, shareUser)
self._txn = txn
self._resourceID = resourceID
if not self._txn.store().queryCachingEnabled():
self._cacher = None
self._cached = {}
if not created:
yield self._refresh(txn)
self._notifyCallback = notifyCallback
returnValue(self)
@classmethod
@inlineCallbacks
def forMultipleResources(cls, defaultUser, txn,
childColumn, parentColumn, parentID):
"""
Load all property stores for all objects in a collection. This is used
to optimize Depth:1 operations on that collection, by loading all
relevant properties in a single query.
@param defaultUser: the UID of the user who owns / is requesting the
property stores; the ones whose per-user properties will be exposed.
@type defaultUser: C{str}
@param txn: the transaction within which to fetch the rows.
@type txn: L{IAsyncTransaction}
@param childColumn: The resource ID column for the child resources, i.e.
the resources of the type for which this method will loading the
property stores.
@param parentColumn: The resource ID column for the parent resources.
e.g. if childColumn is addressbook object's resource ID, then this
should be addressbook's resource ID.
@return: a L{Deferred} that fires with a C{dict} mapping resource ID (a
value taken from C{childColumn}) to a L{PropertyStore} for that ID.
"""
childTable = TableSyntax(childColumn.model.table)
query = Select([
childColumn,
# XXX is that column necessary? as per the 'on' clause it has to be
# the same as prop.RESOURCE_ID anyway.
prop.RESOURCE_ID, prop.NAME, prop.VIEWER_UID, prop.VALUE],
From=prop.join(childTable, prop.RESOURCE_ID == childColumn,
'right'),
Where=parentColumn == parentID
)
rows = yield query.on(txn)
stores = cls._createMultipleStores(defaultUser, txn, rows)
returnValue(stores)
@classmethod
@inlineCallbacks
def forMultipleResourcesWithResourceIDs(cls, defaultUser, txn, resourceIDs):
"""
Load all property stores for all specified resources. This is used
to optimize Depth:1 operations on that collection, by loading all
relevant properties in a single query. Note that the caller of this
method must make sure that the number of items being queried for is
within a reasonable batch size. If the caller is itself batching
related queries, that will take care of itself.
@param defaultUser: the UID of the user who owns / is requesting the
property stores; the ones whose per-user properties will be exposed.
@type defaultUser: C{str}
@param txn: the transaction within which to fetch the rows.
@type txn: L{IAsyncTransaction}
@param resourceIDs: The set of resource ID's to query.
@return: a L{Deferred} that fires with a C{dict} mapping resource ID (a
value taken from C{childColumn}) to a L{PropertyStore} for that ID.
"""
query = Select([
prop.RESOURCE_ID, prop.NAME, prop.VIEWER_UID, prop.VALUE],
From=prop,
Where=prop.RESOURCE_ID.In(Parameter("resourceIDs", len(resourceIDs)))
)
rows = yield query.on(txn, resourceIDs=resourceIDs)
stores = cls._createMultipleStores(defaultUser, txn, rows)
# Make sure we have a store for each resourceID even if no properties exist
for resourceID in resourceIDs:
if resourceID not in stores:
store = cls.__new__(cls)
super(PropertyStore, store).__init__(defaultUser)
store._txn = txn
store._resourceID = resourceID
store._cached = {}
stores[resourceID] = store
returnValue(stores)
@classmethod
def _createMultipleStores(cls, defaultUser, txn, rows):
"""
Create a set of stores for the set of rows passed in.
"""
createdStores = {}
for row in rows:
if len(row) == 5:
object_resource_id, resource_id, name, view_uid, value = row
else:
object_resource_id = None
resource_id, name, view_uid, value = row
if resource_id:
if resource_id not in createdStores:
store = cls.__new__(cls)
super(PropertyStore, store).__init__(defaultUser)
store._txn = txn
store._resourceID = resource_id
store._cached = {}
createdStores[resource_id] = store
createdStores[resource_id]._cached[(name, view_uid)] = value
elif object_resource_id:
store = cls.__new__(cls)
super(PropertyStore, store).__init__(defaultUser)
store._txn = txn
store._resourceID = object_resource_id
store._cached = {}
createdStores[object_resource_id] = store
return createdStores
def _getitem_uid(self, key, uid):
validKey(key)
try:
value = self._cached[(key.toString(), uid)]
except KeyError:
raise KeyError(key)
return WebDAVDocument.fromString(value).root_element
_updateQuery = Update({prop.VALUE: Parameter("value")},
Where=(
prop.RESOURCE_ID == Parameter("resourceID")).And(
prop.NAME == Parameter("name")).And(
prop.VIEWER_UID == Parameter("uid")))
_insertQuery = Insert({prop.VALUE: Parameter("value"),
prop.RESOURCE_ID: Parameter("resourceID"),
prop.NAME: Parameter("name"),
prop.VIEWER_UID: Parameter("uid")})
def _setitem_uid(self, key, value, uid):
validKey(key)
key_str = key.toString()
value_str = value.toxml()
tried = []
wasCached = [(key_str, uid) in self._cached]
self._cached[(key_str, uid)] = value_str
@inlineCallbacks
def trySetItem(txn):
if tried:
yield self._refresh(txn)
wasCached[:] = [(key_str, uid) in self._cached]
tried.append(True)
if wasCached[0]:
yield self._updateQuery.on(
txn, resourceID=self._resourceID, value=value_str,
name=key_str, uid=uid)
else:
yield self._insertQuery.on(
txn, resourceID=self._resourceID, value=value_str,
name=key_str, uid=uid)
if self._cacher is not None:
self._cacher.delete(self._cacheToken(uid))
# Call the registered notification callback - we need to do this as a preCommit since it involves
# a bunch of deferred operations, but this propstore api is not deferred. preCommit will execute
# the deferreds properly, and it is fine to wait until everything else is done before sending the
# notifications.
if hasattr(self, "_notifyCallback") and self._notifyCallback is not None:
self._txn.preCommit(self._notifyCallback)
def justLogIt(f):
f.trap(AllRetriesFailed)
self.log.error("setting a property failed; probably nothing.")
self._txn.subtransaction(trySetItem).addErrback(justLogIt)
_deleteQuery = Delete(
prop, Where=(prop.RESOURCE_ID == Parameter("resourceID")).And(
prop.NAME == Parameter("name")).And(
prop.VIEWER_UID == Parameter("uid"))
)
def _delitem_uid(self, key, uid):
validKey(key)
key_str = key.toString()
del self._cached[(key_str, uid)]
@inlineCallbacks
def doIt(txn):
yield self._deleteQuery.on(txn, lambda: KeyError(key),
resourceID=self._resourceID,
name=key_str, uid=uid
)
if self._cacher is not None:
self._cacher.delete(self._cacheToken(uid))
# Call the registered notification callback - we need to do this as a preCommit since it involves
# a bunch of deferred operations, but this propstore api is not deferred. preCommit will execute
# the deferreds properly, and it is fine to wait until everything else is done before sending the
# notifications.
if hasattr(self, "_notifyCallback") and self._notifyCallback is not None:
self._txn.preCommit(self._notifyCallback)
def justLogIt(f):
f.trap(AllRetriesFailed)
self.log.error("setting a property failed; probably nothing.")
self._txn.subtransaction(doIt).addErrback(justLogIt)
def _keys_uid(self, uid):
for cachedKey, cachedUID in self._cached.keys():
if cachedUID == uid:
yield PropertyName.fromString(cachedKey)
_deleteResourceQuery = Delete(
prop, Where=(prop.RESOURCE_ID == Parameter("resourceID"))
)
@inlineCallbacks
def _removeResource(self):
self._cached = {}
yield self._deleteResourceQuery.on(self._txn, resourceID=self._resourceID)
# Invalidate entire set of cached per-user data for this resource
if self._cacher is not None:
self._cacher.delete(str(self._resourceID))
@inlineCallbacks
def copyAllProperties(self, other):
"""
Copy all the properties from another store into this one. This needs to be done
independently of the UID.
"""
rows = yield other._allWithID.on(other._txn, resourceID=other._resourceID)
for key_str, uid, value_str in rows:
wasCached = [(key_str, uid) in self._cached]
if wasCached[0]:
yield self._updateQuery.on(
self._txn, resourceID=self._resourceID, value=value_str,
name=key_str, uid=uid)
else:
yield self._insertQuery.on(
self._txn, resourceID=self._resourceID, value=value_str,
name=key_str, uid=uid)
# Invalidate entire set of cached per-user data for this resource and reload
self._cached = {}
if self._cacher is not None:
self._cacher.delete(str(self._resourceID))
yield self._refresh(self._txn)
|