from Acquisition import aq_inner, aq_parent, aq_base from AccessControl import getSecurityManager from datetime import datetime from DateTime import DateTime from urllib import quote as url_quote from zope import interface, schema from zope.annotation import IAttributeAnnotatable from zope.component import createObject, getMultiAdapter, queryUtility from zope.interface import Interface, implements from zope.viewlet.interfaces import IViewlet from z3c.form import form, field, button, interfaces, widget from z3c.form.browser.textarea import TextAreaWidget from Products.Five.browser import BrowserView from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile from Products.CMFCore.utils import getToolByName from Products.CMFPlone import PloneMessageFactory as _ from Products.statusmessages.interfaces import IStatusMessage from plone.registry.interfaces import IRegistry from plone.app.layout.viewlets.common import ViewletBase from plone.app.discussion.comment import Comment, CommentFactory from plone.app.discussion.interfaces import IConversation, IComment, IReplies, IDiscussionSettings, ICaptcha from plone.app.discussion.browser.validator import CaptchaValidator from plone.z3cform import layout, z2 from plone.z3cform.fieldsets import extensible class View(BrowserView): """Comment View. Redirect from /path/to/object/++conversation++default/123456789 to /path/to/object#comment-123456789. """ def __call__(self): comment_id = aq_parent(self).id self.request.response.redirect( aq_parent(aq_parent(aq_parent(self))).absolute_url() + '#' + str(comment_id)) class AutoResizeTextArea(TextAreaWidget): """Textarea with autoresize CSS class. """ klass = u'autoresize' def AutoResizeTextAreaFieldWidget(field, request): """IFieldWidget factory for AutoResizeTextAreaWidget. """ return widget.FieldWidget(field, AutoResizeTextArea(request)) class CommentButtonAction(button.ButtonAction): """Comment button with Plone CSS style. """ def commentButtonActionFactory(request, field): """Comment button action factory. """ button = CommentButtonAction(request, field) button.klass += " context" return button class CancelButtonAction(button.ButtonAction): """Cancel button with Plone CSS style. """ def cancelButtonActionFactory(request, field): """Cancel button action factory. """ button = CancelButtonAction(request, field) button.klass += " standalone hide" return button class CommentForm(extensible.ExtensibleForm, form.Form): ignoreContext = True # don't use context to get widget data label = _(u"Add a comment") fields = field.Fields(IComment).omit('portal_type', '__parent__', '__name__', 'comment_id', 'mime_type', 'creator', 'creation_date', 'modification_date', 'author_username') fields['text'].widgetFactory = AutoResizeTextAreaFieldWidget def updateWidgets(self): super(CommentForm, self).updateWidgets() self.widgets['in_reply_to'].mode = interfaces.HIDDEN_MODE portal_membership = getToolByName(self.context, 'portal_membership') if not portal_membership.isAnonymousUser(): self.widgets['author_name'].mode = interfaces.HIDDEN_MODE self.widgets['author_email'].mode = interfaces.HIDDEN_MODE self.buttons['comment'].actionFactory = commentButtonActionFactory self.buttons['cancel'].actionFactory = cancelButtonActionFactory # XXX: Since we are not using the author_email field in the # current state, we hide it by default. But we keep the field for # integrators or later use. self.widgets['author_email'].mode = interfaces.HIDDEN_MODE @button.buttonAndHandler(_(u"Comment")) def handleComment(self, action): context = aq_inner(self.context) wf = getToolByName(context, 'portal_workflow') data, errors = self.extractData() title = u"" text = u"" author_name = u"" author_username = u"" author_email = u"" # Captcha check for anonymous users (if Captcha is enabled) registry = queryUtility(IRegistry) settings = registry.forInterface(IDiscussionSettings) portal_membership = getToolByName(self.context, 'portal_membership') if settings.captcha != 'disabled' and portal_membership.isAnonymousUser(): if 'captcha' in data: # Check Captcha only if there is a value, otherwise # the default "required" validator is sufficient. captcha = CaptchaValidator(self.context, self.request, None, ICaptcha['captcha'], None) captcha.validate(data['captcha']) else: return if 'title' in data and 'text' in data: title = data['title'] text = data['text'] if 'author_name' in data: author_name = data['author_name'] if 'author_username' in data: author_username = data['author_username'] if 'author_email' in data: author_email = data['author_email'] # The add-comment view is called on the conversation object conversation = IConversation(self.__parent__) if data['in_reply_to']: # Fetch the comment we want to reply to conversation_to_reply_to = conversation.get(data['in_reply_to']) replies = IReplies(conversation_to_reply_to) # Create the comment comment = createObject('plone.Comment') comment.title = title comment.text = text portal_membership = getToolByName(self.context, 'portal_membership') if portal_membership.isAnonymousUser(): comment.creator = author_name comment.author_name = author_name comment.author_email = author_email comment.creation_date = comment.modification_date = datetime.now() else: member = portal_membership.getAuthenticatedMember() fullname = member.getProperty('fullname') if fullname == '' or None: comment.creator = member.id else: comment.creator = fullname comment.author_username = member.getUserName() comment.author_name = member.getProperty('fullname') comment.author_email = member.getProperty('email') comment.creation_date = comment.modification_date = datetime.now() # Check if the added comment is a reply to an existing comment # or just a regular reply to the content object. if data['in_reply_to']: # Add a reply to an existing comment comment_id = replies.addComment(comment) else: # Add a comment to the conversation comment_id = conversation.addComment(comment) # If a user post a comment and moderation is enabled, a message is shown # to the user that his/her comment awaits moderation. If the user has manage # right, he/she is redirected directly to the comment. can_manage = getSecurityManager().checkPermission('Manage portal', context) if wf.getChainForPortalType('Discussion Item') == \ ('comment_review_workflow',) and not can_manage: # Show info message when comment moderation is enabled IStatusMessage(self.context.REQUEST).addStatusMessage( _("Your comment awaits moderator approval."), type="info") self.request.response.redirect(context.absolute_url()) else: # Redirect to comment (inside a content object page) self.request.response.redirect(context.absolute_url() + '#' + str(comment_id)) @button.buttonAndHandler(_(u"Cancel")) def handleCancel(self, action): # This method should never be called, it's only there to show # a cancel button that is handled by a jQuery method. pass class CommentsViewlet(ViewletBase, layout.FormWrapper): form = CommentForm index = ViewPageTemplateFile('comments.pt') def __init__(self, context, request, view, manager): super(CommentsViewlet, self).__init__(context, request, view, manager) if self.form is not None: self.form_instance = self.form(self.context.aq_inner, self.request) self.form_instance.__name__ = self.__name__ self.portal_discussion = getToolByName(self.context, 'portal_discussion', None) self.portal_membership = getToolByName(self.context, 'portal_membership', None) def render_form(self): z2.switch_on(self, request_layer=self.request_layer) self.form.update(self.form_instance) return self.form.render(self.form_instance) # view methods def can_reply(self): return getSecurityManager().checkPermission('Reply to item', aq_inner(self.context)) def can_manage(self): return getSecurityManager().checkPermission('Manage portal', aq_inner(self.context)) def is_discussion_allowed(self): context = aq_inner(self.context) conversation = IConversation(context) return conversation.enabled() def has_replies(self, workflow_actions=False): """Returns true if there are replies. """ try: if self.get_replies(workflow_actions): self.get_replies(workflow_actions).next() return True except StopIteration: return None def get_replies(self, workflow_actions=False): """Returns all replies to a content object. If workflow_actions is false, only published comments are returned. If workflow actions is true, comments are returned with workflow actions. """ context = aq_inner(self.context) conversation = IConversation(context) wf = getToolByName(context, 'portal_workflow') # workflow_actions is only true when user # has 'Manage portal' permission def replies_with_workflow_actions(): # Generator that returns replies dict with workflow actions for r in conversation.getThreads(): comment_obj = r['comment'] # list all possible workflow actions actions = [a for a in wf.listActionInfos(object=comment_obj) if a['category'] == 'workflow' and a['allowed']] r = r.copy() r['actions'] = actions yield r def published_replies(): # Generator that returns replies dict with workflow status. for r in conversation.getThreads(): comment_obj = r['comment'] workflow_status = wf.getInfoFor(comment_obj, 'review_state') if workflow_status == 'published': r = r.copy() r['workflow_status'] = workflow_status yield r # Return all direct replies if conversation.total_comments > 0: if workflow_actions: return replies_with_workflow_actions() else: return published_replies() def get_commenter_home_url(self, username): if username is None: return None else: return "%s/author/%s" % (self.context.portal_url(), username) def get_commenter_portrait(self, username): if username is None: # return the default user image if no username is given return 'defaultUser.gif' else: portal_membership = getToolByName(self.context, 'portal_membership', None) return portal_membership.getPersonalPortrait(username).absolute_url(); def anonymous_discussion_allowed(self): # Check if anonymous comments are allowed in the registry registry = queryUtility(IRegistry) settings = registry.forInterface(IDiscussionSettings) return settings.anonymous_comments def show_commenter_image(self): # Check if showing commenter image is enabled in the registry registry = queryUtility(IRegistry) settings = registry.forInterface(IDiscussionSettings) return settings.show_commenter_image def is_anonymous(self): return self.portal_state.anonymous() def login_action(self): return '%s/login_form?came_from=%s' % (self.navigation_root_url, url_quote(self.request.get('URL', '')),) def format_time(self, time): # We have to transform Python datetime into Zope DateTime # before we can call toLocalizedTime. util = getToolByName(self.context, 'translation_service') zope_time = DateTime(time.year, time.month, time.day, time.hour, time.minute, time.second) return util.toLocalizedTime(zope_time, long_format=True)