decidim-comments 0.19.1 → 0.23.0

data/app/helpers/decidim/comments/comment_cells_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # Custom helpers for comments cells.
+    #
+    module CommentCellsHelper
+      def renderable?
+        comment.present? && root_commentable.present?
+      end
+
+      def resource_link_text
+        comment.formatted_body
+      end
+
+      def resource_link_path
+        return root_commentable.polymorphic_resource_path(url_params) if root_commentable&.respond_to?(:polymorphic_resource_path)
+
+        resource_locator(root_commentable).path(url_params)
+      end
+
+      delegate :root_commentable, to: :comment
+
+      def root_commentable_title
+        decidim_html_escape(translated_attribute(root_commentable.title))
+      end
+
+      def url_params
+        { commentId: comment.id }
+      end
+    end
+  end
+end

data/app/models/decidim/comments/comment.rb

@@ -13,6 +13,9 @@ module Decidim
       include Decidim::DataPortability
       include Decidim::Traceable
       include Decidim::Loggable
+      include Decidim::Searchable
+      include Decidim::TranslatableResource
+      include Decidim::TranslatableAttributes
 
       # Limit the max depth of a comment tree. If C is a comment and R is a reply:
       # C          (depth 0)
@@ -22,22 +25,53 @@ module Decidim
       #       |--R (depth 3)
       MAX_DEPTH = 3
 
+      translatable_fields :body
+
       belongs_to :commentable, foreign_key: "decidim_commentable_id", foreign_type: "decidim_commentable_type", polymorphic: true
-      belongs_to :root_commentable, foreign_key: "decidim_root_commentable_id", foreign_type: "decidim_root_commentable_type", polymorphic: true
+      belongs_to :root_commentable, foreign_key: "decidim_root_commentable_id", foreign_type: "decidim_root_commentable_type", polymorphic: true, touch: true
       has_many :up_votes, -> { where(weight: 1) }, foreign_key: "decidim_comment_id", class_name: "CommentVote", dependent: :destroy
       has_many :down_votes, -> { where(weight: -1) }, foreign_key: "decidim_comment_id", class_name: "CommentVote", dependent: :destroy
 
+      # Updates the counter caches for the root_commentable when a comment is
+      # created or updated.
+      after_save :update_counter
+
+      # Updates the counter caches for the root_commentable when a comment is
+      # deleted.
+      after_destroy :update_counter
+
+      # Updates the counter caches for the root_commentable when a comment is
+      # touched, which happens when a comment was reported and its moderation
+      # is accepted and sets the comment as hidden.
+      after_touch :update_counter
+
+      before_validation :compute_depth
       validates :body, presence: true
-      validates :depth, numericality: { greater_than_or_equal_to: 0 }
+      validates :depth, numericality: { only_integer: true, greater_than_or_equal_to: 0, less_than_or_equal_to: MAX_DEPTH }
       validates :alignment, inclusion: { in: [0, 1, -1] }
+      validate :body_length
+      validate :commentable_can_have_comments
 
-      validates :body, length: { maximum: 1000 }
+      delegate :organization, to: :commentable
 
-      validate :commentable_can_have_comments
+      translatable_fields :body
+      searchable_fields(
+        participatory_space: :itself,
+        A: :body,
+        datetime: :created_at
+      )
 
-      before_save :compute_depth
+      def self.positive
+        where(alignment: 1)
+      end
 
-      delegate :organization, to: :commentable
+      def self.neutral
+        where(alignment: 0)
+      end
+
+      def self.negative
+        where(alignment: -1)
+      end
 
       def participatory_space
         return root_commentable if root_commentable.is_a?(Decidim::Participable)
@@ -87,12 +121,13 @@ module Decidim
 
       # Public: Overrides the `reported_content_url` Reportable concern method.
       def reported_content_url
-        ResourceLocatorPresenter.new(root_commentable).url(anchor: "comment_#{id}")
-      end
+        url_params = { anchor: "comment_#{id}" }
 
-      # Public: Returns the comment message ready to display (it is expected to include HTML)
-      def formatted_body
-        @formatted_body ||= Decidim::ContentProcessor.render(sanitized_body)
+        if root_commentable&.respond_to?(:polymorphic_resource_url)
+          root_commentable.polymorphic_resource_url(url_params)
+        else
+          ResourceLocatorPresenter.new(root_commentable).url(url_params)
+        end
       end
 
       def self.export_serializer
@@ -100,10 +135,10 @@ module Decidim
       end
 
       def self.newsletter_participant_ids(space)
-        Decidim::Comments::Comment.includes(:root_commentable).not_hidden
-                                  .where("decidim_comments_comments.decidim_author_id IN (?)", Decidim::User.where(organization: space.organization).pluck(:id))
-                                  .where("decidim_comments_comments.decidim_author_type IN (?)", "Decidim::UserBaseEntity")
-                                  .map(&:author).pluck(:id).flatten.compact.uniq
+        authors_sql = Decidim::Comments::Comment.select("DISTINCT decidim_comments_comments.decidim_author_id").not_hidden
+                                                .where("decidim_comments_comments.decidim_author_type" => "Decidim::UserBaseEntity").to_sql
+
+        Decidim::User.where(organization: space.organization).where("id IN (#{authors_sql})").pluck(:id)
       end
 
       def can_participate?(user)
@@ -112,8 +147,35 @@ module Decidim
         root_commentable.can_participate?(user)
       end
 
+      def formatted_body
+        Decidim::ContentProcessor.render(sanitize_content(render_markdown(translated_body)), "div")
+      end
+
+      def translated_body
+        @translated_body ||= translated_attribute(body, organization)
+      end
+
       private
 
+      def body_length
+        language = (body.keys - ["machine_translations"]).first
+        errors.add(:body, :too_long, count: comment_maximum_length) unless body[language].length <= comment_maximum_length
+      end
+
+      def comment_maximum_length
+        return unless commentable.commentable?
+        return component.settings.comments_max_length if component_settings_comments_max_length?
+        return organization.comments_max_length if organization.comments_max_length.positive?
+
+        1000
+      end
+
+      def component_settings_comments_max_length?
+        return unless component&.settings.respond_to?(:comments_max_length)
+
+        component.settings.comments_max_length.positive?
+      end
+
       # Private: Check if commentable can have comments and if not adds
       # a validation error to the model
       def commentable_can_have_comments
@@ -125,9 +187,25 @@ module Decidim
         self.depth = commentable.depth + 1 if commentable.respond_to?(:depth)
       end
 
-      # Private: Returns the comment body sanitized, stripping HTML tags
-      def sanitized_body
-        Rails::Html::Sanitizer.full_sanitizer.new.sanitize(body)
+      # Private: Returns the comment body sanitized, sanitizing HTML tags
+      def sanitize_content(content)
+        Decidim::ContentProcessor.sanitize(content)
+      end
+
+      # Private: Initializes the Markdown parser
+      def markdown
+        @markdown ||= Decidim::Comments::Markdown.new
+      end
+
+      # Private: converts the string from markdown to html
+      def render_markdown(string)
+        markdown.render(string)
+      end
+
+      def update_counter
+        return unless root_commentable
+
+        root_commentable.update_comments_count
       end
     end
   end

data/app/models/decidim/comments/seed.rb

@@ -25,7 +25,7 @@ module Decidim
           params = {
             commentable: resource,
             root_commentable: resource,
-            body: ::Faker::Lorem.sentence(50),
+            body: { en: ::Faker::Lorem.sentence(50) },
             author: author,
             user_group: user_group
           }

data/app/queries/decidim/comments/metrics/comments_metric_manage.rb

@@ -9,9 +9,6 @@ module Decidim
         end
 
         def save
-          return @registry if @registry
-
-          @registry = []
           query.each do |key, results|
             cumulative_value = results[:cumulative]
             next if cumulative_value.zero?
@@ -23,10 +20,8 @@ module Decidim
                                                            organization: @organization, decidim_category_id: category_id,
                                                            related_object_type: related_object_type, related_object_id: related_object_id)
             record.assign_attributes(cumulative: cumulative_value, quantity: quantity_value)
-            @registry << record
+            record.save!
           end
-          @registry.each(&:save!)
-          @registry
         end
 
         private

data/app/queries/decidim/comments/sorted_comments.rb

@@ -30,8 +30,7 @@ module Decidim
       # loads comments replies. It uses Comment's MAX_DEPTH to load a maximum
       # level of nested replies.
       def query
-        scope = Comment
-                .where(commentable: commentable)
+        scope = base_scope
                 .not_hidden
                 .includes(:author, :user_group, :up_votes, :down_votes)
 
@@ -53,6 +52,13 @@ module Decidim
 
       private
 
+      def base_scope
+        id = @options[:id]
+        return Comment.where(root_commentable: commentable, id: id) if id.present?
+
+        Comment.where(commentable: commentable)
+      end
+
       def order_by_older(scope)
         scope.order(created_at: :asc)
       end

data/app/scrubbers/decidim/comments/user_input_scrubber.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Comments
+    # Use this class as a scrubber to sanitize user input.
+    # https://stackoverflow.com/a/35073814/2110884.
+    class UserInputScrubber < Rails::Html::PermitScrubber
+      def initialize
+        super
+        self.tags = custom_allowed_tags
+      end
+
+      private
+
+      def custom_allowed_tags
+        %w(p blockquote)
+      end
+    end
+  end
+end

data/app/services/decidim/comments/new_comment_notification_creator.rb

@@ -17,9 +17,12 @@ module Decidim
       # comment - the Comment from which to generate notifications.
       # mentioned_users - An ActiveRecord::Relation of the users that have been
       #   mentioned
-      def initialize(comment, mentioned_users)
+      # mentioned_groups - And ActiveRecord::Relation of the user_groups that have
+      #   been mentioned
+      def initialize(comment, mentioned_users, mentioned_groups = nil)
         @comment = comment
         @mentioned_users = mentioned_users
+        @mentioned_groups = mentioned_groups
         @already_notified_users = [comment.author]
       end
 
@@ -28,14 +31,16 @@ module Decidim
       # Returns nothing.
       def create
         notify_mentioned_users
+        notify_mentioned_groups
         notify_parent_comment_author
         notify_author_followers
+        notify_user_group_followers
         notify_commentable_recipients
       end
 
       private
 
-      attr_reader :comment, :mentioned_users, :already_notified_users
+      attr_reader :comment, :mentioned_users, :mentioned_groups, :already_notified_users
 
       def notify_mentioned_users
         affected_users = mentioned_users - already_notified_users
@@ -44,6 +49,17 @@ module Decidim
         notify(:user_mentioned, affected_users: affected_users)
       end
 
+      def notify_mentioned_groups
+        return unless mentioned_groups
+
+        mentioned_groups.each do |group|
+          affected_users = group.accepted_users - already_notified_users
+          @already_notified_users += affected_users
+
+          notify(:user_group_mentioned, affected_users: affected_users, extra: { group: group })
+        end
+      end
+
       # Notifies the author of a comment that their comment has been replied.
       # Only applies if the comment is a reply.
       def notify_parent_comment_author
@@ -62,6 +78,15 @@ module Decidim
         notify(:comment_by_followed_user, followers: followers)
       end
 
+      def notify_user_group_followers
+        return if comment.user_group.blank?
+
+        followers = comment.user_group.followers - already_notified_users
+        @already_notified_users += followers
+
+        notify(:comment_by_followed_user_group, followers: followers)
+      end
+
       # Notifies the users the `comment.commentable` resource implements as necessary.
       def notify_commentable_recipients
         followers = comment.commentable.users_to_notify_on_comment_created - already_notified_users
@@ -90,7 +115,7 @@ module Decidim
           extra: {
             comment_id: comment.id
           }
-        }.merge(users)
+        }.deep_merge(users)
 
         Decidim::EventsManager.publish(data)
       end

data/app/types/decidim/comments/commentable_interface.rb

@@ -29,9 +29,10 @@ module Decidim
         type !types[!CommentType]
 
         argument :orderBy, types.String, "Order the comments"
+        argument :singleCommentId, types.String, "ID of the single comment to look at"
 
         resolve lambda { |obj, args, _ctx|
-          SortedComments.for(obj, order_by: args[:orderBy])
+          SortedComments.for(obj, order_by: args[:orderBy], id: args[:singleCommentId])
         }
       end
 
@@ -40,7 +41,7 @@ module Decidim
         description "The number of comments in all levels this resource holds"
 
         resolve lambda { |obj, _args, _ctx|
-          obj.comments.count
+          obj.comments_count
         }
       end
 

data/app/types/decidim/comments/commentable_mutation_type.rb

@@ -16,9 +16,12 @@ module Decidim
         argument :userGroupId, types.ID, "The comment's user group id. Replaces the author."
 
         resolve lambda { |obj, args, ctx|
-          params = { "comment" => { "body" => args[:body], "alignment" => args[:alignment], "user_group_id" => args[:userGroupId] } }
-          form = Decidim::Comments::CommentForm.from_params(params).with_context(current_organization: ctx[:current_organization])
-          Decidim::Comments::CreateComment.call(form, ctx[:current_user], obj) do
+          params = { "comment" => { "body" => args[:body], "alignment" => args[:alignment], "user_group_id" => args[:userGroupId], "commentable" => obj } }
+          form = Decidim::Comments::CommentForm.from_params(params).with_context(
+            current_organization: ctx[:current_organization],
+            current_component: obj.component
+          )
+          Decidim::Comments::CreateComment.call(form, ctx[:current_user]) do
             on(:ok) do |comment|
               return comment
             end

data/config/locales/am-ET.yml

@@ -0,0 +1 @@
+am:

data/config/locales/ar.yml

@@ -4,6 +4,7 @@ ar:
       decidim/comments/comment_by_followed_user_event: تعليق
       decidim/comments/comment_created_event: تعليق
       decidim/comments/reply_created_event: تعليق الرد
+      decidim/comments/user_group_mentioned_event: أشير
       decidim/comments/user_mentioned_event: أشير
   activerecord:
     models:
@@ -50,6 +51,7 @@ ar:
           against: ضد
           in_favor: لصالح
         deleted_user: مشارك محذوف
+        hide_replies: إخفاء الردود
         reply: الرد
         report:
           action: أبلغ عن
@@ -61,7 +63,8 @@ ar:
             does_not_belong: يحتوي على نشاط غير قانوني أو تهديدات انتحارية أو معلومات شخصية أو أي شيء آخر تعتقد أنه لا ينتمي إلى %{organization_name}.
             offensive: يحتوي على العنصرية والتمييز الجنسي والتشهير والهجمات الشخصية والتهديدات بالقتل أو طلبات الانتحار أو أي شكل من أشكال خطاب الكراهية.
             spam: يحتوي على clickbait أو الإعلان أو الخدع أو روبوت البرامج النصية.
-          title: الإبلاغ عن مشكلة
+        show_replies: اظهر الردود الـ %{replies_count}
+        single_comment_link_title: الحصول على رابط نحو تعليق واحد
       comment_order_selector:
         order:
           best_rated: أفضل تصنيف
@@ -74,7 +77,10 @@ ar:
       comments:
         blocked_comments_for_user_warning: لا يمكنك التعليق في هذه اللحظة ، ولكن يمكنك قراءة التعليقات السابقة.
         blocked_comments_warning: التعليقات معطلة في هذا الوقت ، لكن يمكنك قراءة التعليقات السابقة.
+        comment_details_title: تفاصيل التعليق
         loading: جارٍ تحميل التعليقات ...
+        single_comment_warning: يمكنك الإطلاع على التعليقات المتبقية الأخرى <a href="%{url}">هنا</a>.
+        single_comment_warning_title: إنك ترى تعليقا واحدا
         title: "%{count} تعليقات"
     events:
       comments:
@@ -83,6 +89,9 @@ ar:
           email_outro: لقد تلقيت هذا الإشعار لأنك تتابع %{author_name}. يمكنك إلغاء تتبع هذا المستخدم من صفحة ملفه الشخصي.
           email_subject: هناك تعليق جديد مِن %{author_name} على %{resource_title}
           notification_title: هناك تعليق جديد مِن <a href="%{author_path}">%{author_name} %{author_nickname}</a> على <a href="%{resource_path}">%{resource_title}</a>.
+        comment_by_followed_user_group:
+          email_subject: هناك تعليق جديد مِن %{author_name} على %{resource_title}
+          notification_title: هناك تعليق جديد مِن <a href="%{author_path}">%{author_name} %{author_nickname}</a> على <a href="%{resource_path}">%{resource_title}</a>.
         comment_created:
           email_intro: "%{resource_title} تم التعليق. يمكنك قراءة التعليق في هذه الصفحة:"
           email_outro: لقد تلقيت هذا الإشعار لأنك تتابع "%{resource_title}" أو مؤلفه. يمكنك إلغاء تتبعه من الرابط السابق.

data/config/locales/bg-BG.yml

@@ -0,0 +1,6 @@
+bg:
+  activemodel:
+    models:
+      decidim/comments/comment_by_followed_user_event: Коментар
+      decidim/comments/comment_created_event: Коментар
+      decidim/comments/reply_created_event: Отговор на коментар

data/config/locales/bg.yml

@@ -0,0 +1,6 @@
+bg:
+  activemodel:
+    models:
+      decidim/comments/comment_by_followed_user_event: Коментар
+      decidim/comments/comment_created_event: Коментар
+      decidim/comments/reply_created_event: Отговор на коментар