plone.app.discussion/plone/app/discussion/conversation.py

124 lines
3.2 KiB
Python
Raw Normal View History

"""The conversation and replies adapters
The conversation is responsible for storing all comments. It provides a
dict-like API for accessing comments, where keys are integers and values
are IComment objects. It also provides features for finding comments quickly.
The two IReplies adapters - one for the IConversation and one for IComment -
manipulate the same data structures, but provide an API for finding and
manipulating the comments directly in reply to a particular comment or at the
top level of the conversation.
"""
from persistence import Persistent
from zope.interface import implements, implementer
from zope.component import adapts, adapter
from zope.annotation.interfaces import IAnnotatable
from BTrees.OIBTree import OIBTree
from BTrees.IOBTree import IOBTree
from BTrees.IIBTree import IIBTree, IISet
from Acquisition import Explicit
from plone.app.discussion.interfaces import IConversation, IComment, IReplies
class Conversation(Persistent, Explicit):
"""A conversation is a container for all comments on a content object.
It manages internal data structures for comment threading and efficient
comment lookup.
"""
implements(IConversation)
def __init__(self, id="++comments++"):
self.id = id
# username -> count of comments; key is removed when count reaches 0
self._commentators = OIBTree()
self._last_comment_date = None
# id -> comment - find comment by id
self._comments = IOBTree()
# id -> IISet (children) - find all children for a given comment. 0 signifies root.
self._children = IOBTree()
def getId(self):
"""
"""
return self.id
@property
def enabled(self):
# TODO
return True
@property
def total_comments(self):
# TODO
return 0
@property
def last_comment_date(self):
# TODO
return None
@property
def commentators(self):
# TODO:
return set()
def getComments(start=0, size=None):
# TODO
pass
def getThreads(start=0, size=None, root=None, depth=None):
# TODO
pass
# Dict API
# TODO: Update internal data structures when items added or removed
@implementer(IConversation)
@adapter(IAnnotatable)
def conversationAdapterFactory(content):
"""Adapter factory to fetch a conversation from annotations
"""
# TODO
return None
class ConversationReplies(object):
"""An IReplies adapter for conversations.
This makes it easy to work with top-level comments.
"""
implements(IReplies)
adapts(Conversation)
def __init__(self, context):
self.conversation = context
self.root = 0
# TODO: dict interface - generalise to work with any starting point, so
# that the subclassing below works
class CommentReplies(ConversationReplies):
"""An IReplies adapter for comments.
This makes it easy to work with replies to specific comments.
"""
implements(IReplies)
adapts(IComment)
def __init__(self, context):
self.conversation = context.__parent__
self.root = context.comment_id