def fromRequest(self, request, rest_params={}):
self.mdb_collection = request.context.db[self.collection]
self.data = RUDict({})
self.data.update(extractPostData(request))
self.data.update(rest_params)
# Since we are building from a request,
# overwrite actor with the validated one from the request in source
self.data['actor'] = request.actor
self.processFields()
#check if the object we pretend to create already exists
existing_object = self.alreadyExists()
if not existing_object:
# if we are creating a new object, set the current date and build
self['published'] = datetime.datetime.utcnow()
self._on_create_custom_validations()
self.buildObject()
else:
# if it's already on the DB, just populate with the object data
self.update(existing_object)
def fromRequest(self, request, rest_params={}):
self.mdb_collection = request.context.db[self.collection]
self.data = RUDict({})
self.data.update(extractPostData(request))
self.data.update(rest_params)
# Since we are building from a request,
# overwrite actor with the validated one from the request in source
self.data['actor'] = request.actor
self.processFields()
#check if the object we pretend to create already exists
existing_object = self.alreadyExists()
if not existing_object:
# if we are creating a new object, set the current date and build
self['published'] = datetime.datetime.utcnow()
self._on_create_custom_validations()
self.buildObject()
else:
# if it's already on the DB, just populate with the object data
self.update(existing_object)
class MADBase(MADDict):
"""
Base Class for Objects in the MongoDB, It can be instantiated with a MongoDB Object
or a request object in the source param.
If instantiated with a MongoDB Object the collection where the object must be passed
If instantiated with a request, rest_params may be passed to extend request params
Provides the methods to validate and construct an object according to activitystrea.ms
specifications by subclassing it and providing an schema with the required fields,
and a structure builder function 'buildObject'
"""
unique = ''
collection = ''
mdb_collection = None
data = {}
def fromRequest(self, request, rest_params={}):
self.mdb_collection = request.context.db[self.collection]
self.data = RUDict({})
self.data.update(extractPostData(request))
self.data.update(rest_params)
# Since we are building from a request,
# overwrite actor with the validated one from the request in source
self.data['actor'] = request.actor
self.processFields()
#check if the object we pretend to create already exists
existing_object = self.alreadyExists()
if not existing_object:
# if we are creating a new object, set the current date and build
self['published'] = datetime.datetime.utcnow()
self._on_create_custom_validations()
self.buildObject()
else:
# if it's already on the DB, just populate with the object data
self.update(existing_object)
def fromObject(self, source, collection):
self.mdb_collection = collection
self.update(source)
def getMutablePropertiesFromRequest(self, request, mutable_permission = 'operations_mutable'):
"""
"""
params = extractPostData(request)
allowed_fields = [fieldName for fieldName in self.schema if self.schema[fieldName].get(mutable_permission, 0)]
properties = {fieldName: params.get(fieldName) for fieldName in allowed_fields if params.get(fieldName, None) is not None}
return properties
def insert(self):
"""
Inserts the item into his defined collection and returns its _id
"""
oid = self.mdb_collection.insert(self)
return str(oid)
def save(self):
"""
Updates itself to the database
"""
self.mdb_collection.save(self)
def delete(self):
"""
Removes the object from the DB
"""
self.mdb_collection.remove({'_id': self._id})
def addToList(self, field, obj, allow_duplicates=False, safe=True):
"""
Updates an array field of a existing DB object appending the new object
and incrementing the totalItems counter.
if allow_duplicates = True, allows to add items even if its already on the list. If not
, looks for `safe` value to either raise an exception if safe==False or pass gracefully if its True
XXX TODO allow object to be either a single object or a list of objects
"""
obj_list = self.get(field, {'items': [], 'totalItems': 0})
items = '%s.items' % field
count = '%s.totalItems' % field
duplicated = obj in obj_list['items']
if allow_duplicates or not duplicated:
self.mdb_collection.update({'_id': self['_id']},
{'$push': {items: obj},
'$inc': {count: 1}
}
)
else:
if not safe:
raise DuplicatedItemError, 'Item already on list "%s"' % (field)
def deleteFromList(self, field, obj, safe=True):
"""
Updates an array field of a existing DB object removing the object
If safe == False, don't perform any deletion, otherwise remove the found objects.
"""
pass
def alreadyExists(self):
"""
Checks if there's an object with the value specified in the unique field.
If present, return the object, otherwise returns None
"""
unique = self.unique
query = {unique: self.data.get(unique)}
return self.mdb_collection.find_one(query)
def flatten(self):
"""
Recursively transforms non-json-serializable values and simplifies
$oid and $data BISON structures. Intended for final output
"""
dd = dict([(key, self[key]) for key in self.keys()])
flatten(dd)
return dd
def getObjectWrapper(self, objType):
"""
Get the apppopiate class to be inserted in the object field
of (mainly) an Activity
"""
module_name = objType.capitalize()
module = getattr(sys.modules['max.ASObjects'], module_name, None)
if module:
return module
else:
raise ObjectNotSupported, 'Activitystrea.ms object type %s unknown or unsupported' % objType
def updateFields(self, fields):
"""
Update fields on objects
"""
self.data = fields
self.processFields(updating=True)
self.update(fields)
class MADBase(MADDict):
"""
Base Class for Objects in the MongoDB, It can be instantiated with a MongoDB Object
or a request object in the source param.
If instantiated with a MongoDB Object the collection where the object must be passed
If instantiated with a request, rest_params may be passed to extend request params
Provides the methods to validate and construct an object according to activitystrea.ms
specifications by subclassing it and providing an schema with the required fields,
and a structure builder function 'buildObject'
"""
unique = ''
collection = ''
mdb_collection = None
data = {}
def fromRequest(self, request, rest_params={}):
self.mdb_collection = request.context.db[self.collection]
self.data = RUDict({})
self.data.update(extractPostData(request))
self.data.update(rest_params)
# Since we are building from a request,
# overwrite actor with the validated one from the request in source
self.data['actor'] = request.actor
self.processFields()
#check if the object we pretend to create already exists
existing_object = self.alreadyExists()
if not existing_object:
# if we are creating a new object, set the current date and build
self['published'] = datetime.datetime.utcnow()
self._on_create_custom_validations()
self.buildObject()
else:
# if it's already on the DB, just populate with the object data
self.update(existing_object)
def fromObject(self, source, collection):
self.mdb_collection = collection
self.update(source)
def getMutablePropertiesFromRequest(self,
request,
mutable_permission='operations_mutable'
):
"""
"""
params = extractPostData(request)
allowed_fields = [
fieldName for fieldName in self.schema
if self.schema[fieldName].get(mutable_permission, 0)
]
properties = {
fieldName: params.get(fieldName)
for fieldName in allowed_fields
if params.get(fieldName, None) is not None
}
return properties
def insert(self):
"""
Inserts the item into his defined collection and returns its _id
"""
oid = self.mdb_collection.insert(self)
return str(oid)
def save(self):
"""
Updates itself to the database
"""
self.mdb_collection.save(self)
def delete(self):
"""
Removes the object from the DB
"""
self.mdb_collection.remove({'_id': self._id})
def addToList(self, field, obj, allow_duplicates=False, safe=True):
"""
Updates an array field of a existing DB object appending the new object
and incrementing the totalItems counter.
if allow_duplicates = True, allows to add items even if its already on the list. If not
, looks for `safe` value to either raise an exception if safe==False or pass gracefully if its True
XXX TODO allow object to be either a single object or a list of objects
"""
obj_list = self.get(field, {'items': [], 'totalItems': 0})
items = '%s.items' % field
count = '%s.totalItems' % field
duplicated = obj in obj_list['items']
if allow_duplicates or not duplicated:
self.mdb_collection.update({'_id': self['_id']}, {
'$push': {
items: obj
},
'$inc': {
count: 1
}
})
else:
if not safe:
raise DuplicatedItemError, 'Item already on list "%s"' % (
field)
def deleteFromList(self, field, obj, safe=True):
"""
Updates an array field of a existing DB object removing the object
If safe == False, don't perform any deletion, otherwise remove the found objects.
"""
pass
def alreadyExists(self):
"""
Checks if there's an object with the value specified in the unique field.
If present, return the object, otherwise returns None
"""
unique = self.unique
query = {unique: self.data.get(unique)}
return self.mdb_collection.find_one(query)
def flatten(self):
"""
Recursively transforms non-json-serializable values and simplifies
$oid and $data BISON structures. Intended for final output
"""
dd = dict([(key, self[key]) for key in self.keys()])
flatten(dd)
return dd
def getObjectWrapper(self, objType):
"""
Get the apppopiate class to be inserted in the object field
of (mainly) an Activity
"""
module_name = objType.capitalize()
module = getattr(sys.modules['max.ASObjects'], module_name, None)
if module:
return module
else:
raise ObjectNotSupported, 'Activitystrea.ms object type %s unknown or unsupported' % objType
def updateFields(self, fields):
"""
Update fields on objects
"""
self.data = fields
self.processFields(updating=True)
self.update(fields)