/usr/share/pyshared/desktopcouch/records/__init__.py is in python-desktopcouch-records 1.0.8-0ubuntu3.
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 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 | # Copyright 2009-2010 Canonical Ltd.
#
# This file is part of desktopcouch.
#
# desktopcouch is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License version 3
# as published by the Free Software Foundation.
#
# desktopcouch 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with desktopcouch. If not, see <http://www.gnu.org/licenses/>.
#
# Authors: Eric Casteleijn <eric.casteleijn@canonical.com>
# Nicola Larosa <nicola.larosa@canonical.com>
# Mark G. Saye <mark.saye@canonical.com>
# Vincenzo Di Somma <vincenzo.di.somma@canonical.com>
"""A dictionary based record representation."""
import re
import uuid
import warnings
from time import strptime
from collections import MutableSequence, MutableMapping
RX = re.compile('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
def is_internal(key):
"""Test whether this is an internal key."""
return (
key == 'record_type' or
key.startswith(('_', 'application_annotations')))
def is_mergeable_list(dictionary):
"""Tests wether the dictionary represents a mergeable list."""
if not dictionary:
return False
if not isinstance(dictionary, MutableMapping):
return False
if not '_order' in dictionary:
for key in dictionary:
if not RX.match(key):
return False
for key in dictionary:
if not key == '_order' and not RX.match(key):
return False
return True
def is_uuid_dict(dictionary):
"""Deprecated."""
warnings.warn(
".is_uuid_dict is deprecated, use .is_mergeable_list instead",
DeprecationWarning, stacklevel=2)
return dictionary and not [
key for key in dictionary if (not RX.match(key) and key != '_order')]
def record_factory(data):
"""Create a RecordDict or RecordList from passed data."""
if isinstance(data, MutableMapping):
return _build_from_dict(data)
return data
def _build_from_dict(data):
"""Create a RecordDict from passed data."""
result = RecordDict({})
for key, value in data.items():
if RX.match(key):
raise IllegalKeyException(
"Can't set '%s'. uuid-like keys are not allowed." % key)
result[key] = record_factory(value)
return result
def validate(data):
"""Validate underlying data for Record objects."""
if isinstance(data, MutableMapping):
if is_mergeable_list(data):
return
if any(RX.match(key) for key in data):
raise IllegalKeyException(
'Mixing uuid-like keys and regular keys in a '
'single dictionary is not allowed.')
for value in data.values():
validate(value)
class RecordField(object):
"""Descriptor to manage record fields."""
def __init__(self, field_name):
self.field_name = field_name
def __get__(self, obj, owner=None):
return obj.get(self.field_name)
def __set__(self, obj, value):
obj[self.field_name] = value
class StringRecordField(RecordField):
"""Descriptor to manage string record fields."""
def __set__(self, obj, value):
if not type(value) is str:
raise TypeError("Expected string value, got %s." % repr(value))
obj[self.field_name] = value
class ListRecordField(RecordField):
"""Descriptor to manage string record fields."""
def __set__(self, obj, value):
if not type(value) is list:
raise TypeError("Expected list value, got %s." % repr(value))
obj[self.field_name] = value
class DateRecordField(RecordField):
"""Descriptor to manage data record fields."""
def __set__(self, obj, value):
obj[self.field_name] = strptime(value, "%Y-%m-%dT%H:%M:%S")
class IllegalKeyException(Exception):
"""Exception when attempting to set a key we don't allow."""
pass
class NoRecordTypeSpecified(Exception):
"""Exception when creating a record without specifying record type"""
def __str__(self):
return "Record type must be specified and should be a URL"
class Attachment(object):
"""This represents the value of the attachment. The name is
stored as the key that points to this name."""
def __init__(self, content=None, content_type=None):
super(Attachment, self).__init__()
if content is not None:
if hasattr(content, "read") and hasattr(content, "seek"):
pass # is a file-like object.
elif isinstance(content, basestring):
pass # is a string-like object.
else:
raise TypeError(
"Expected string or file (or None) as content.")
self.content = content
self.content_type = content_type
self.needs_synch = content is not None
def get_content_and_type(self): # WTF? pylint: disable=E0202
"""Get content and type of the attachment."""
assert self.content is not None
if hasattr(self.content, "read"):
if hasattr(self.content, "seek"):
self.content.seek(0, 0)
return self.content.read(), self.content_type
else:
return self.content, self.content_type
class RecordData(object):
"""Base class for all the Record data objects."""
def __init__(self, data):
validate(data)
self._data = data
self._attachments = dict()
self._detached = set()
def __getitem__(self, key):
value = self._data[key]
if isinstance(value, MutableMapping):
if is_mergeable_list(value):
result = MergeableList(value)
else:
result = RecordDict(value)
return result
return value
def __setitem__(self, key, item):
if isinstance(item, MutableMapping):
item = record_factory(item)
if hasattr(item, '_data'):
item = item._data # pylint: disable=W0212
self._data[key] = item
def __delitem__(self, key):
del self._data[key]
class RecordDict(RecordData, MutableMapping):
"""An object that represents an desktop CouchDB record fragment,
but behaves like a dictionary.
"""
def __setitem__(self, key, item):
if RX.match(key):
raise IllegalKeyException(
"Can't set '%s'. uuid-like keys are not allowed." % key)
super(RecordDict, self).__setitem__(key, item)
def __iter__(self):
for key in self._data:
yield key
def __len__(self):
return len(self._data)
def setdefault(self, key, default=None):
"""D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D."""
try:
return self[key]
except KeyError:
self[key] = default
# NOTE: since we (possibly) mangle the default value in
# __setitem__, we can't just 'return default' here, as
# MutableMapping does.
return self[key]
class MergeableList(RecordData, MutableSequence):
"""An object that represents a list of complex values."""
def __init__(self, data):
if isinstance(data, MutableMapping):
super(MergeableList, self).__init__(data)
else:
self._data = {}
for value in data:
self.append(record_factory(value))
self._attachments = dict()
self._detached = set()
def __getitem__(self, index):
if not isinstance(index, int):
raise TypeError(
"list indices must be integers, not %s" % type(index))
key = self.get_uuid_for_index(index)
return super(MergeableList, self).__getitem__(key)
def __setitem__(self, index, value):
if not isinstance(index, int):
raise TypeError(
"list indices must be integers, not %s" % type(index))
key = self.get_uuid_for_index(index)
super(MergeableList, self).__setitem__(key, value)
def __delitem__(self, index):
if not isinstance(index, int):
raise TypeError(
"list indices must be integers, not %s" % type(index))
key = self.get_uuid_for_index(index)
if key in self._data.get('_order', []):
self._data['_order'].remove(key)
super(MergeableList, self).__delitem__(key)
def __len__(self):
if '_order' in self._data:
return len(self._data) - 1
return len(self._data)
def __eq__(self, other):
if not isinstance(other, MutableSequence):
return False
if len(self) != len(other):
return False
for i in range(len(self)):
if self[i] != other[i]:
return False
return True
def __ne__(self, other):
return not self.__eq__(other)
def insert(self, index, value):
"""Insert value at index."""
new_uuid = str(uuid.uuid4())
if not '_order' in self._data:
self._data['_order'] = sorted(
[key for key in self._data.keys() if RX.match(key)])
self._data['_order'].insert(index, new_uuid)
super(MergeableList, self).__setitem__(new_uuid, value)
def _get_ordered_keys(self):
"""Get list of uuid keys ordered by 'order' property or uuid key."""
result = []
order = self._data.get('_order', [])
keys = sorted([key for key in self._data if key != '_order'])
for key in order:
keys.remove(key)
result.append(key)
result.extend(keys)
return result
def get_uuid_for_index(self, index):
"""Return uuid key for index."""
return self._get_ordered_keys()[index]
def get_value_for_uuid(self, lookup_uuid):
"""Allow API consumers that do know about the UUIDs to get
values directly.
"""
return super(MergeableList, self).__getitem__(lookup_uuid)
class Record(RecordDict):
"""An object that represents a Desktop CouchDB record."""
def __init__(self, data=None, record_type=None,
record_id=None, record_type_version=None):
if data is None:
data = {}
if record_type is None:
if 'record_type' in data:
record_type = data['record_type']
else:
raise NoRecordTypeSpecified
super(Record, self).__init__(data)
self._data['record_type'] = record_type
if record_type_version is not None:
self._data['_record_type_version'] = record_type_version
if record_id is not None:
# Explicit setting, so try to use it.
if data.get('_id', None) is None:
# Overwrite _id if it is None.
self._data['_id'] = record_id
else:
# _id already set. Verify that the explicit value agrees.
if self._data['_id'] != record_id:
raise ValueError("record_id doesn't match value in data.")
def __getitem__(self, key):
if is_internal(key):
raise KeyError(key)
return super(Record, self).__getitem__(key)
def __setitem__(self, key, item):
if is_internal(key):
raise IllegalKeyException(
"Can't set '%s'. This is an internal key." % key)
super(Record, self).__setitem__(key, item)
def __iter__(self):
return (
key for key in super(Record, self).__iter__() if not is_internal(
key))
def __contains__(self, key):
if is_internal(key):
return False
return super(Record, self).__contains__(key)
def __delitem__(self, key):
if is_internal(key):
raise KeyError(key)
super(Record, self).__delitem__(key)
def get(self, key, default=None):
"""Get a value from the record by key."""
if is_internal(key):
return default
return super(Record, self).get(key, default)
def keys(self):
"""Return all keys"""
return [
key for key in super(Record, self).keys() if not is_internal(key)]
def _get_record_id(self):
"""Gets the record id."""
if '_id' in self._data:
return self._data['_id']
return None
def _set_record_id(self, value):
"""Sets the record id."""
self._data['_id'] = value
def _set_record_revision(self, value):
"""Sets the record revision."""
self._data['_rev'] = value
record_id = property(_get_record_id, _set_record_id)
@property
def application_annotations(self):
"""Get the section with application specific data."""
return RecordDict(self._data.setdefault('application_annotations', {}))
@property
def record_type(self):
"""Get the record type."""
return self._data.setdefault('record_type', None) # Set if unset.
@property
def record_revision(self):
"""Get the record revision."""
return self._data.get('_rev', None) # Retreive only; comes from DB.
@property
def record_type_version(self):
"""Get the record type version if it's there."""
return self._data.get('_record_type_version', None)
def attach_by_reference(self, filename, getter_function):
"""This should only be called by the server code to refer to a BLOB
that is in the database, so that we do not have to download it until
the user wants it."""
attachment = Attachment(None, None)
attachment.get_content_and_type = getter_function
self._attachments[filename] = attachment
def attach(self, content, filename, content_type):
"""Attach a file-like or string-like object, with a particular name and
content type, to a document to be stored in the database. One can not
clobber names that already exist."""
if filename in self._attachments:
raise KeyError("%r already exists" % (filename,))
self._attachments[filename] = Attachment(content, content_type)
def detach(self, filename):
"""Remove a BLOB attached to a document."""
try:
self._attachments.pop(filename)
self._detached.add(filename)
except KeyError:
raise KeyError("%r is not attached to this document" % (filename,))
def list_attachments(self):
"""List the record's attachments."""
return self._attachments.keys()
def attachment_data(self, filename):
"""Retreive the attached data, the BLOB and content_type."""
try:
attachment = self._attachments[filename]
except KeyError:
raise KeyError("%r is not attached to this document" % (filename,))
return attachment.get_content_and_type()
|