Alejandro Avilés 71462cf69b Fix __repr__
2014-11-04 17:42:36 +01:00

142 lines
4.3 KiB
Python

# This file is part of Indico.
# Copyright (C) 2002 - 2014 European Organization for Nuclear Research (CERN).
#
# Indico 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.
#
# Indico 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 Indico; if not, see <http://www.gnu.org/licenses/>.
from __future__ import unicode_literals
from werkzeug.datastructures import ImmutableDict
from indico.core.db.sqlalchemy import db, UTCDateTime
from indico.util.date_time import now_utc
from indico.util.string import return_ascii
from indico.util.struct.enum import IndicoEnum
from indico_livesync.models.agents import LiveSyncAgent
from indico_livesync.util import obj_deref
class ChangeType(int, IndicoEnum):
created = 1
deleted = 2
moved = 3
data_changed = 4
title_changed = 5
protection_changed = 6
class LiveSyncQueueEntry(db.Model):
__tablename__ = 'queues'
__table_args__ = (db.CheckConstraint('change IN ({})'.format(', '.join(map(str, ChangeType)))),
{'schema': 'plugin_livesync'})
#: Entry ID
id = db.Column(
db.Integer,
primary_key=True
)
#: ID of the agent this entry belongs to
agent_id = db.Column(
db.Integer,
db.ForeignKey('plugin_livesync.agents.id'),
nullable=False,
index=True
)
#: Timestamp of the change
timestamp = db.Column(
UTCDateTime,
nullable=False,
default=now_utc
)
#: the change type, a :class:`ChangeType`
change = db.Column(
db.SmallInteger,
nullable=False
)
#: The type of the changed object
type = db.Column(
db.String,
nullable=False
)
#: The ID of the changed category
category_id = db.Column(
db.String,
nullable=True
)
#: The event ID of the changed event/contribution/subcontribution
event_id = db.Column(
db.String,
nullable=True
)
#: The contribution ID of the changed contribution/subcontribution
contrib_id = db.Column(
db.String,
nullable=True
)
#: The subcontribution ID of the changed subcontribution
subcontrib_id = db.Column(
db.String,
nullable=True
)
#: The associated :class:LiveSyncAgent
agent = db.relationship(
'LiveSyncAgent',
backref=db.backref('queue', cascade='all, delete-orphan', lazy='dynamic')
)
@property
def object(self):
"""Returns the changed object"""
return obj_deref(self.object_ref)
@property
def object_ref(self):
"""Returns the reference of the changed object"""
return ImmutableDict(type=self.type, category_id=self.category_id, event_id=self.event_id,
contrib_id=self.contrib_id, subcontrib_id=self.subcontrib_id)
@return_ascii
def __repr__(self):
ref_repr = '{}.{}.{}.{}'.format(self.category_id if self.category_id else 'x',
self.event_id if self.event_id else 'x',
self.contrib_id if self.contrib_id else 'x',
self.subcontrib_id if self.subcontrib_id else 'x')
return '<LiveSyncQueueEntry({}, {}, {}, {}, {})>'.format(self.agent, self.id, self.type,
ChangeType(self.change).name, ref_repr)
@classmethod
def create(cls, changes, obj_ref):
"""Creates a new change in all queues
:param changes: the change types, an iterable containing
:class:`ChangeType`
:param obj_ref: the object reference (returned by `obj_ref`)
of the changed object
"""
obj_ref = dict(obj_ref)
for agent in LiveSyncAgent.find():
for change in changes:
entry = cls(agent=agent, change=change, **obj_ref)
db.session.add(entry)
db.session.flush()