129 lines
3.3 KiB
Python
129 lines
3.3 KiB
Python
"""The default comment class and factory.
|
|
"""
|
|
from datetime import datetime
|
|
from zope.interface import implements
|
|
from zope.component.factory import Factory
|
|
|
|
from Acquisition import aq_parent, Implicit
|
|
from AccessControl.Role import RoleManager
|
|
from AccessControl.Owned import Owned
|
|
|
|
from Globals import Persistent
|
|
|
|
from Products.CMFCore.DynamicType import DynamicType
|
|
from Products.CMFCore.utils import getToolByName
|
|
|
|
from OFS.Traversable import Traversable
|
|
|
|
from plone.app.discussion.interfaces import IComment
|
|
|
|
try:
|
|
# Plone 4:
|
|
# Mixin CatalogAware and WorkflowAware into the Comment class
|
|
# is necessary for comments to be indexed in Plone4.
|
|
from Products.CMFCore.CMFCatalogAware import CatalogAware
|
|
from Products.CMFCore.CMFCatalogAware import WorkflowAware
|
|
except:
|
|
# Plone 3:
|
|
# Dummy imports to make Comment class happy
|
|
from OFS.Traversable import Traversable as CatalogAware
|
|
from OFS.Traversable import Traversable as WorkflowAware
|
|
|
|
|
|
class Comment(CatalogAware, WorkflowAware, DynamicType, Traversable,
|
|
RoleManager, Owned, Implicit, Persistent):
|
|
"""A comment.
|
|
|
|
This object attempts to be as lightweight as possible. We implement a
|
|
number of standard methods instead of subclassing, to have total control
|
|
over what goes into the object.
|
|
"""
|
|
|
|
implements(IComment)
|
|
|
|
meta_type = portal_type = 'Discussion Item'
|
|
|
|
__parent__ = None
|
|
|
|
comment_id = None # long
|
|
in_reply_to = None # long
|
|
|
|
title = u""
|
|
|
|
mime_type = "text/plain"
|
|
text = u""
|
|
|
|
creator = None
|
|
creation_date = None
|
|
modification_date = None
|
|
|
|
author_username = None
|
|
|
|
author_name = None
|
|
author_email = None
|
|
|
|
# Note: we want to use zope.component.createObject() to instantiate
|
|
# comments as far as possible. comment_id and __parent__ are set via
|
|
# IConversation.addComment().
|
|
|
|
def __init__(self):
|
|
self.creation_date = self.modification_date = datetime.now()
|
|
|
|
@property
|
|
def __name__(self):
|
|
return self.comment_id and unicode(self.comment_id) or None
|
|
|
|
@property
|
|
def id(self):
|
|
return self.comment_id and str(self.comment_id) or None
|
|
|
|
def getId(self):
|
|
"""The id of the comment, as a string
|
|
"""
|
|
return self.id
|
|
|
|
def getText(self):
|
|
'''the text'''
|
|
return self.text
|
|
|
|
def Title(self):
|
|
"""The title of the comment
|
|
"""
|
|
return self.title
|
|
|
|
def Creator(self):
|
|
"""The name of the person who wrote the comment
|
|
"""
|
|
return self.creator
|
|
|
|
def Type(self):
|
|
"""The Discussion Item content type
|
|
"""
|
|
return self.portal_type
|
|
|
|
# CMF's event handlers assume any IDynamicType has these :(
|
|
|
|
def opaqueItems(self):
|
|
return []
|
|
|
|
def opaqueIds(self):
|
|
return []
|
|
|
|
def opaqueValues(self):
|
|
return []
|
|
|
|
CommentFactory = Factory(Comment)
|
|
|
|
def notify_workflow(obj, event):
|
|
"""Tell the workflow tool when a comment is added
|
|
"""
|
|
tool = getToolByName(obj, 'portal_workflow', None)
|
|
if tool is not None:
|
|
tool.notifyCreated(obj)
|
|
|
|
def notify_content_object(obj, event):
|
|
"""Tell the content object when a comment is added
|
|
"""
|
|
content_obj = aq_parent(aq_parent(obj))
|
|
content_obj.reindexObject(idxs=('total_comments', 'last_comment_date', 'commentators',))
|