Issue 194

AUTHORS

@@ -27,6 +27,7 @@ Yngve Høiseth, @yhoiseth
 Ashwani Gupta, @ashwani99
 Jean-Paul Ladage, @jladage
 Михаил Рыбкин, @MikerStudio
+McKinly Springer, @mckinly
 
 Main developer
 Daniel Rus Morales, @danirus

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [3.0.0] -
+
+    * Fixes issue #194. Take into account setting COMMENTS_HIDE_REMOVED from
+      parent's app django-comments. This is a backwards incompatible change.
+      When COMMENTS_HIDE_REMOVED is not defined or is defined as True, removed
+      comments should not be retrieved nor counted. <document this>
+
+## [2.8.1] -
+
+    * Fixes issue #221, about the get_version function. Now it returns the full
+      version number <major>.<minor>.<patch>. Thanks to @mckinly.
+
 ## [2.8.0] - 2020-09-26
 
     * Fixes issue #106, which is about computing the number of nested comments

django_comments_xtd/__init__.py

@@ -22,9 +22,7 @@ def get_form():
 
 
 def get_version():
-    version = '%s.%s' % (VERSION[0], VERSION[1])
-    if VERSION[2]:
-        version = '%s.%s' % (version, VERSION[2])
+    version = '%s.%s.%s' % (VERSION[0], VERSION[1], VERSION[2])
     if VERSION[3] != 'f':
         version = '%s%s%s' % (version, VERSION[3], VERSION[4])
     return version

django_comments_xtd/api/views.py

@@ -5,6 +5,7 @@
 from django.utils.module_loading import import_string
 
 from django_comments.models import CommentFlag
+from django_comments_xtd import get_model as get_comment_model
 from django_comments.views.moderation import perform_flag
 from rest_framework import generics, mixins, permissions, status
 from rest_framework.decorators import api_view
@@ -60,15 +61,21 @@ def get_queryset(self, **kwargs):
                 CommentFlag.SUGGEST_REMOVAL, LIKEDIT_FLAG, DISLIKEDIT_FLAG
             ]).prefetch_related('user')
             prefetch = Prefetch('flags', queryset=flags_qs)
-            qs = XtdComment\
+            site_id = getattr(settings, "SITE_ID", None)
+            if not site_id:
+                site_id = get_current_site_id(self.request)
+            fkwds = {
+                "content_type": content_type,
+                "object_pk": object_pk_arg,
+                "site__pk": site_id,
+                "is_public": True
+            }
+            if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+                fkwds['is_removed'] = False
+            qs = get_comment_model()\
                 .objects\
                 .prefetch_related(prefetch)\
-                .filter(
-                    content_type=content_type,
-                    object_pk=object_pk_arg,
-                    site__pk=get_current_site_id(self.request),
-                    is_public=True
-                )
+                .filter(**fkwds)
         return qs
 
 
@@ -81,10 +88,18 @@ def get_queryset(self):
         object_pk_arg = self.kwargs.get('object_pk', None)
         app_label, model = content_type_arg.split("-")
         content_type = ContentType.objects.get_by_natural_key(app_label, model)
-        qs = XtdComment.objects.filter(content_type=content_type,
-                                       object_pk=object_pk_arg,
-                                       is_public=True)
-        return qs
+        site_id = getattr(settings, "SITE_ID", None)
+        if not site_id:
+            site_id = get_current_site_id(self.request)
+        fkwds = {
+            "content_type": content_type,
+            "object_pk": object_pk_arg,
+            "site__pk": site_id,
+            "is_public": True
+        }
+        if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+            fkwds["is_removed"] = False
+        return get_comment_model().objects.filter(**fkwds)
 
     def get(self, request, *args, **kwargs):
         return Response({'count': self.get_queryset().count()})

django_comments_xtd/apps.py

@@ -8,8 +8,13 @@ class CommentsXtdConfig(AppConfig):
 
     def ready(self):
         from django_comments_xtd import get_model
-        from django_comments_xtd.models import publish_or_unpublish_on_pre_save
+        from django_comments_xtd.conf import settings
+        from django_comments_xtd.models import publish_or_withhold_on_pre_save
 
-        model_app_label = get_model()._meta.label
-        pre_save.connect(publish_or_unpublish_on_pre_save,
-                         sender=model_app_label)
+        if (
+            getattr(settings, 'COMMENTS_HIDE_REMOVED', True) or
+            getattr(settings, 'COMMENTS_XTD_PUBLISH_OR_WITHHOLD_NESTED', True)
+        ):
+            model_app_label = get_model()._meta.label
+            pre_save.connect(publish_or_withhold_on_pre_save,
+                             sender=model_app_label)

django_comments_xtd/conf/defaults.py

@@ -49,6 +49,10 @@
     }
 }
 
+# When True, an approval or removal operation on a comment will
+# trigger a publishing or withholding operation on its nested comments.
+COMMENTS_XTD_PUBLISH_OR_WITHHOLD_NESTED = True
+
 
 # Define a function to return the user representation. Used by
 # the web API to represent user strings in response objects.

django_comments_xtd/models.py

@@ -209,20 +209,20 @@ def get_comment_dict(obj):
         return dic_list
 
 
-def publish_or_unpublish_nested_comments(comment, are_public=False):
+def publish_or_withhold_nested_comments(comment, shall_be_public=False):
     qs = get_model().objects.filter(~Q(pk=comment.id), parent_id=comment.id)
     nested = [cm.id for cm in qs]
-    qs.update(is_public=are_public)
+    qs.update(is_public=shall_be_public)
     while len(nested):
         cm_id = nested.pop()
         qs = XtdComment.objects.filter(~Q(pk=cm_id), parent_id=cm_id)
         nested.extend([cm.id for cm in qs])
-        qs.update(is_public=are_public)
+        qs.update(is_public=shall_be_public)
     # Update nested_count in parents comments in the same thread.
     # The comment.nested_count doesn't change because the comment's is_public
     # attribute is not changing, only its nested comments change, and it will
     # help to re-populate nested_count should it be published again.
-    if are_public:
+    if shall_be_public:
         op = F('nested_count') + comment.nested_count
     else:
         op = F('nested_count') - comment.nested_count
@@ -232,10 +232,10 @@ def publish_or_unpublish_nested_comments(comment, are_public=False):
                       .update(nested_count=op)
 
 
-def publish_or_unpublish_on_pre_save(sender, instance, raw, using, **kwargs):
+def publish_or_withhold_on_pre_save(sender, instance, raw, using, **kwargs):
     if not raw and instance and instance.id:
-        are_public = (not instance.is_removed) and instance.is_public
-        publish_or_unpublish_nested_comments(instance, are_public=are_public)
+        shall_be_public = (not instance.is_removed) and instance.is_public
+        publish_or_withhold_nested_comments(instance, shall_be_public)
 
 
 # ----------------------------------------------------------------------

django_comments_xtd/static/django_comments_xtd/js/src/commentbox.jsx

@@ -26,7 +26,7 @@ export class CommentBox extends React.Component {
   handle_comment_created() {
     this.load_comments();
   }
-  
+
   handle_preview(name, email, url, comment) {
     this.setState({
       preview: {name: name, email: email, url: url, comment: comment},
@@ -122,7 +122,7 @@ export class CommentBox extends React.Component {
         return comments[index];
       });
     };
-    
+
     for (let item of data) {
       incids.push(item.id);
       comments[item.id] = item;
@@ -189,13 +189,13 @@ export class CommentBox extends React.Component {
       }.bind(this)
     });
   }
-  
+
   componentDidMount() {
     this.load_comments();
     if(this.props.polling_interval)
       setInterval(this.load_count.bind(this), this.props.polling_interval);
   }
-  
+
   render() {
     var settings = this.props;
     var comment_counter = this.render_comment_counter();
@@ -211,7 +211,7 @@ export class CommentBox extends React.Component {
                  on_comment_created={this.handle_comment_created} />
       );
     }.bind(this));
-    
+
     return (
       <div>
         {comment_counter}

django_comments_xtd/templates/django_comments_xtd/comment_tree.html

@@ -47,7 +47,7 @@ <h6 class="mb-1 small d-flex">
         {% endif %}
       {% endif %}
     </div>
-    {% if not item.comment.is_removed and item.children %}
+    {% if item.children and not hide_removed or item.children and hide_removed and not item.is_removed %}
       {% render_xtdcomment_tree with comments=item.children %}
     {% endif %}
   </div>

django_comments_xtd/templatetags/comments_xtd.py

@@ -14,6 +14,7 @@
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 
+from django_comments_xtd.conf import settings
 from django_comments.models import CommentFlag
 from django_comments_xtd import get_model as get_comment_model
 from django_comments_xtd.api import frontend
@@ -36,12 +37,16 @@ class XtdCommentCountNode(Node):
     def __init__(self, as_varname, content_types):
         """Class method to parse get_xtdcomment_list and return a Node."""
         self.as_varname = as_varname
-        self.qs = XtdComment.objects.for_content_types(content_types)
+        self.qs = get_comment_model().objects.for_content_types(content_types)
+        self.qs = self.qs.filter(is_public=True)
+        if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+            self.qs = self.qs.filter(is_removed=False)
 
     def render(self, context):
-        context[self.as_varname] = self.qs.filter(
-                site=get_current_site_id(context.get('request'))
-            ).count()
+        site_id = getattr(settings, "SITE_ID", None)
+        if not site_id and ('request' in context):
+            site_id = get_current_site_id(context['request'])
+        context[self.as_varname] = self.qs.filter(site=site_id).count()
         return ''
 
 
@@ -138,19 +143,26 @@ def __init__(self, count, content_types, template_path=None):
 
 
 class RenderLastXtdCommentsNode(BaseLastXtdCommentsNode):
-
     def render(self, context):
         if not isinstance(self.count, int):
             self.count = int(self.count.resolve(context))
 
-        self.qs = XtdComment.objects.for_content_types(
-                self.content_types,
-                site=get_current_site_id(context.get('request'))
-            ).order_by('submit_date')[:self.count]
+        site_id = getattr(settings, "SITE_ID", None)
+        if not site_id and ('request' in context):
+            site_id = get_current_site_id(context['request'])
+
+        qs = get_comment_model().objects.for_content_types(
+            self.content_types, site=site_id)
+
+        qs = qs.filter(is_public=True)
+        if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+            qs = qs.filter(is_removed=False)
+
+        qs = qs.order_by('submit_date')[:self.count]
 
         strlist = []
         context_dict = context.flatten()
-        for xtd_comment in self.qs:
+        for xtd_comment in qs:
             if self.template_path:
                 template_arg = self.template_path
             else:
@@ -168,20 +180,28 @@ def render(self, context):
 
 
 class GetLastXtdCommentsNode(BaseLastXtdCommentsNode):
-
     def __init__(self, count, as_varname, content_types):
         super(GetLastXtdCommentsNode, self).__init__(count, content_types)
         self.as_varname = as_varname
 
     def render(self, context):
         if not isinstance(self.count, int):
             self.count = int(self.count.resolve(context))
-        self.qs = XtdComment.objects.for_content_types(
-                self.content_types,
-                site=get_current_site_id(context.get('request'))
-            )\
-            .order_by('submit_date')[:self.count]
-        context[self.as_varname] = self.qs
+
+        site_id = getattr(settings, "SITE_ID", None)
+        if not site_id and ('request' in context):
+            site_id = get_current_site_id(context['request'])
+
+        qs = get_comment_model().objects.for_content_types(
+                self.content_types, site=site_id)
+
+        qs = qs.filter(is_public=True)
+        if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+            qs = qs.filter(is_removed=False)
+
+        qs = qs.order_by('submit_date')[:self.count]
+
+        context[self.as_varname] = qs
         return ''
 
 
@@ -301,29 +321,40 @@ def render(self, context):
         for attr in ['allow_flagging', 'allow_feedback', 'show_feedback']:
             context_dict[attr] = (getattr(self, attr, False) or
                                   context.get(attr, False))
+
+        hide_removed = getattr(settings, 'COMMENTS_HIDE_REMOVED', True)
+        context_dict['hide_removed'] = hide_removed
+
         if self.obj:
             obj = self.obj.resolve(context)
             ctype = ContentType.objects.get_for_model(obj)
             flags_qs = CommentFlag.objects.filter(flag__in=[
                 CommentFlag.SUGGEST_REMOVAL, LIKEDIT_FLAG, DISLIKEDIT_FLAG
             ]).prefetch_related('user')
             prefetch = Prefetch('flags', queryset=flags_qs)
-            queryset = XtdComment\
+            site_id = getattr(settings, "SITE_ID", None)
+            if not site_id and ('request' in context):
+                site_id = get_current_site_id(context['request'])
+            fkwds = {
+                "content_type": ctype,
+                "object_pk": obj.pk,
+                "site__pk": site_id,
+                "is_public": True
+            }
+            if getattr(settings, 'COMMENTS_HIDE_REMOVED', True):
+                fkwds['is_removed'] = False
+            qs = get_comment_model()\
                 .objects\
                 .prefetch_related(prefetch)\
-                .filter(
-                    content_type=ctype,
-                    object_pk=obj.pk,
-                    site__pk=get_current_site_id(context.get('request')),
-                    is_public=True
-                )
+                .filter(**fkwds)
             comments = XtdComment.tree_from_queryset(
-                queryset,
+                qs,
                 with_flagging=self.allow_flagging,
                 with_feedback=self.allow_feedback,
                 user=context['user']
             )
             context_dict['comments'] = comments
+
         if self.cvars:
             for vname, vobj in self.cvars:
                 context_dict[vname] = vobj.resolve(context)
@@ -363,7 +394,7 @@ def render(self, context):
             CommentFlag.SUGGEST_REMOVAL, LIKEDIT_FLAG, DISLIKEDIT_FLAG
         ]).prefetch_related('user')
         prefetch = Prefetch('flags', queryset=flags_qs)
-        queryset = XtdComment\
+        queryset = get_comment_model()\
             .objects\
             .prefetch_related(prefetch)\
             .filter(

django_comments_xtd/tests/settings.py

@@ -113,6 +113,10 @@
 
 DEFAULT_FROM_EMAIL = "Alice Bloggs <[email protected]>"
 
+COMMENTS_HIDE_REMOVED = True
+
+COMMENTS_XTD_PUBLISH_OR_WITHHOLD_NESTED = True
+
 COMMENTS_XTD_CONFIRM_EMAIL = True
 COMMENTS_XTD_SALT = b"es-war-einmal-una-bella-princesa-in-a-beautiful-castle"
 COMMENTS_XTD_MAX_THREAD_LEVEL = 2