Source code for abilian.services.activity.models

"""
Activity Service.

See: http://activitystrea.ms/specs/json/1.0/
See: http://activitystrea.ms/specs/atom/1.0/#activity
See: http://stackoverflow.com/questions/1443960/how-to-implement-the-activity-stream-in-a-social-network

TODO: Look wether other attributes from the spec need to be implemented.
"""
from __future__ import print_function
from __future__ import division
from __future__ import absolute_import

from datetime import datetime
from flask import logging

from sqlalchemy.orm import relationship
from sqlalchemy.schema import Column, ForeignKey
from sqlalchemy.types import Integer, DateTime, Text, String

from abilian.core.entities import db, Entity
from abilian.core.models.subjects import User

__all__ = ['ActivityEntry']

logger = logging.getLogger(__name__)


def _default_from(column):
  """
  Helper for default and onupdates parameters in a Column definitions.

  Returns a `context-sensitive default function <http://docs.sqlalchemy.org/en/rel_0_8/core/defaults.html#context-sensitive-default-functions>`_
  to set value from another column.
  """
  def _default_value(context):
    return context.current_parameters[column]
  return _default_value


[docs]class ActivityEntry(db.Model): """ Main table for all activities. """ id = Column(Integer, primary_key=True) happened_at = Column(DateTime, default=datetime.utcnow) verb = Column(Text) actor_id = Column(Integer, ForeignKey(User.id)) actor = relationship(User, foreign_keys=actor_id) object_type = Column(String(1000)) object_id = Column(Integer, default=_default_from('_fk_object_id')) _fk_object_id = Column(Integer, ForeignKey(Entity.id, ondelete="SET NULL")) object = relationship(Entity, foreign_keys=_fk_object_id) target_type = Column(String(1000)) target_id = Column(Integer, default=_default_from('_fk_target_id')) _fk_target_id = Column(Integer, ForeignKey(Entity.id, ondelete="SET NULL")) target = relationship(Entity, foreign_keys=_fk_target_id) def __repr__(self): return ('<{}.ActivityEntry id={} actor={} verb={} object={} ' 'target={}>'.format( self.__class__.__module__, self.id, repr(unicode(self.actor)), repr(self.verb), repr(unicode(self.object)), repr(unicode(self.target))) )