discourse/lib/topics_filter.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

525 lines
15 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
class TopicsFilter
attr_reader :topic_notification_levels
def initialize(guardian:, scope: Topic.all)
@guardian = guardian
@scope = scope
@topic_notification_levels = Set.new
end
FILTER_ALIASES = { "categories" => "category", "tags" => "tag" }
private_constant :FILTER_ALIASES
def filter_from_query_string(query_string)
return @scope if query_string.blank?
filters = {}
query_string.scan(
/(?<key_prefix>(?:-|=|-=|=-))?(?<key>[\w-]+):(?<value>[^\s]+)/,
) do |key_prefix, key, value|
key = FILTER_ALIASES[key] || key
filters[key] ||= {}
filters[key]["key_prefixes"] ||= []
filters[key]["key_prefixes"] << key_prefix
filters[key]["values"] ||= []
filters[key]["values"] << value
end
filters.each do |filter, hash|
key_prefixes = hash["key_prefixes"]
values = hash["values"]
filter_values = extract_and_validate_value_for(filter, values)
case filter
when "activity-before"
filter_by_activity(before: filter_values)
when "activity-after"
filter_by_activity(after: filter_values)
when "category"
filter_categories(values: key_prefixes.zip(filter_values))
when "created-after"
filter_by_created(after: filter_values)
when "created-before"
filter_by_created(before: filter_values)
when "created-by"
filter_created_by_user(usernames: filter_values.flat_map { |value| value.split(",") })
when "in"
filter_in(values: filter_values)
when "latest-post-after"
filter_by_latest_post(after: filter_values)
when "latest-post-before"
filter_by_latest_post(before: filter_values)
when "likes-min"
filter_by_number_of_likes(min: filter_values)
when "likes-max"
filter_by_number_of_likes(max: filter_values)
when "likes-op-min"
filter_by_number_of_likes_in_first_post(min: filter_values)
when "likes-op-max"
filter_by_number_of_likes_in_first_post(max: filter_values)
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
when "order"
order_by(values: filter_values)
when "posts-min"
filter_by_number_of_posts(min: filter_values)
when "posts-max"
filter_by_number_of_posts(max: filter_values)
when "posters-min"
filter_by_number_of_posters(min: filter_values)
when "posters-max"
filter_by_number_of_posters(max: filter_values)
when "status"
filter_values.each { |status| @scope = filter_status(status: status) }
when "tag"
filter_tags(values: key_prefixes.zip(filter_values))
when "views-min"
filter_by_number_of_views(min: filter_values)
when "views-max"
filter_by_number_of_views(max: filter_values)
end
end
@scope
end
def filter_status(status:, category_id: nil)
case status
when "open"
@scope = @scope.where("NOT topics.closed AND NOT topics.archived")
when "closed"
@scope = @scope.where("topics.closed")
when "archived"
@scope = @scope.where("topics.archived")
when "listed"
@scope = @scope.where("topics.visible")
when "unlisted"
@scope = @scope.where("NOT topics.visible")
when "deleted"
category = category_id.present? ? Category.find_by(id: category_id) : nil
if @guardian.can_see_deleted_topics?(category)
@scope = @scope.unscope(where: :deleted_at).where("topics.deleted_at IS NOT NULL")
end
when "public"
@scope = @scope.joins(:category).where("NOT categories.read_restricted")
end
@scope
end
private
YYYY_MM_DD_REGEXP =
/\A(?<year>[12][0-9]{3})-(?<month>0?[1-9]|1[0-2])-(?<day>0?[1-9]|[12]\d|3[01])\z/
private_constant :YYYY_MM_DD_REGEXP
def extract_and_validate_value_for(filter, values)
case filter
when "activity-before", "activity-after", "created-before", "created-after",
"latest-post-before", "latest-post-after"
value = values.last
if match_data = value.match(YYYY_MM_DD_REGEXP)
Time.zone.parse(
"#{match_data[:year].to_i}-#{match_data[:month].to_i}-#{match_data[:day].to_i}",
)
end
when "likes-min", "likes-max", "likes-op-min", "likes-op-max", "posts-min", "posts-max",
"posters-min", "posters-max", "views-min", "views-max"
value = values.last
value if value =~ /\A\d+\z/
when "order"
values.flat_map { |value| value.split(",") }
when "created-by"
values.flat_map { |value| value.split(",").map { |username| username.delete_prefix("@") } }
else
values
end
end
def filter_by_topic_range(column_name:, min: nil, max: nil, scope: nil)
{ min => ">=", max => "<=" }.each do |value, operator|
next if !value
@scope = (scope || @scope).where("#{column_name} #{operator} ?", value)
end
end
def filter_by_activity(before: nil, after: nil)
filter_by_topic_range(column_name: "topics.bumped_at", min: after, max: before)
end
def filter_by_created(before: nil, after: nil)
filter_by_topic_range(column_name: "topics.created_at", min: after, max: before)
end
def filter_by_latest_post(before: nil, after: nil)
filter_by_topic_range(column_name: "topics.last_posted_at", min: after, max: before)
end
def filter_by_number_of_posts(min: nil, max: nil)
filter_by_topic_range(column_name: "topics.posts_count", min:, max:)
end
def filter_by_number_of_posters(min: nil, max: nil)
filter_by_topic_range(column_name: "topics.participant_count", min:, max:)
end
def filter_by_number_of_likes(min: nil, max: nil)
filter_by_topic_range(column_name: "topics.like_count", min:, max:)
end
def filter_by_number_of_likes_in_first_post(min: nil, max: nil)
filter_by_topic_range(
column_name: "first_posts.like_count",
min:,
max:,
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
scope: self.joins_first_posts(@scope),
)
end
def filter_by_number_of_views(min: nil, max: nil)
filter_by_topic_range(column_name: "views", min:, max:)
end
def filter_categories(values:)
category_slugs = {
include: {
with_subcategories: [],
without_subcategories: [],
},
exclude: {
with_subcategories: [],
without_subcategories: [],
},
}
values.each do |key_prefix, value|
exclude_categories = key_prefix&.include?("-")
exclude_subcategories = key_prefix&.include?("=")
value
.scan(
/\A(?<category_slugs>([\p{L}\p{N}\-:]+)(?<delimiter>[,])?([\p{L}\p{N}\-:]+)?(\k<delimiter>[\p{L}\p{N}\-:]+)*)\z/,
)
.each do |category_slugs_match, delimiter|
slugs = category_slugs_match.split(delimiter)
type = exclude_categories ? :exclude : :include
subcategory_type = exclude_subcategories ? :without_subcategories : :with_subcategories
category_slugs[type][subcategory_type].concat(slugs)
end
end
include_category_ids = []
if category_slugs[:include][:without_subcategories].present?
include_category_ids =
get_category_ids_from_slugs(
category_slugs[:include][:without_subcategories],
exclude_subcategories: true,
)
end
if category_slugs[:include][:with_subcategories].present?
include_category_ids.concat(
get_category_ids_from_slugs(
category_slugs[:include][:with_subcategories],
exclude_subcategories: false,
),
)
end
if include_category_ids.present?
@scope = @scope.where("topics.category_id IN (?)", include_category_ids)
elsif category_slugs[:include].values.flatten.present?
@scope = @scope.none
return
end
exclude_category_ids = []
if category_slugs[:exclude][:without_subcategories].present?
exclude_category_ids =
get_category_ids_from_slugs(
category_slugs[:exclude][:without_subcategories],
exclude_subcategories: true,
)
end
if category_slugs[:exclude][:with_subcategories].present?
exclude_category_ids.concat(
get_category_ids_from_slugs(
category_slugs[:exclude][:with_subcategories],
exclude_subcategories: false,
),
)
end
if exclude_category_ids.present?
@scope = @scope.where("topics.category_id NOT IN (?)", exclude_category_ids)
end
end
def filter_created_by_user(usernames:)
@scope =
@scope.joins(:user).where(
"users.username_lower IN (:usernames)",
usernames: usernames.map(&:downcase),
)
end
def filter_in(values:)
values.uniq!
if values.delete("pinned")
@scope =
@scope.where(
"topics.pinned_at IS NOT NULL AND topics.pinned_until > topics.pinned_at AND ? < topics.pinned_until",
Time.zone.now,
)
end
if @guardian.user
if values.delete("bookmarked")
@scope =
@scope.joins(:topic_users).where(
"topic_users.bookmarked AND topic_users.user_id = ?",
@guardian.user.id,
)
end
if values.present?
values.each do |value|
value
.split(",")
.each do |topic_notification_level|
if level = TopicUser.notification_levels[topic_notification_level.to_sym]
@topic_notification_levels << level
end
end
end
@scope =
@scope.joins(:topic_users).where(
"topic_users.notification_level IN (:topic_notification_levels) AND topic_users.user_id = :user_id",
topic_notification_levels: @topic_notification_levels.to_a,
user_id: @guardian.user.id,
)
end
elsif values.present?
@scope = @scope.none
end
end
def get_category_ids_from_slugs(slugs, exclude_subcategories: false)
category_ids = Category.ids_from_slugs(slugs)
category_ids =
Category
.where(id: category_ids)
.filter { |category| @guardian.can_see_category?(category) }
.map(&:id)
if !exclude_subcategories
category_ids = category_ids.flat_map { |category_id| Category.subcategory_ids(category_id) }
end
category_ids
end
# Accepts an array of tag names and returns an array of tag ids and the tag ids of aliases for the tag names which the user can see.
# If a block is given, it will be called with the tag ids and alias tag ids as arguments.
def tag_ids_from_tag_names(tag_names)
tag_ids, alias_tag_ids =
DiscourseTagging
.filter_visible(Tag, @guardian)
.where_name(tag_names)
.pluck(:id, :target_tag_id)
.transpose
tag_ids ||= []
alias_tag_ids ||= []
yield(tag_ids, alias_tag_ids) if block_given?
all_tag_ids = tag_ids.concat(alias_tag_ids)
all_tag_ids.compact!
all_tag_ids.uniq!
all_tag_ids
end
def filter_tags(values:)
return if !SiteSetting.tagging_enabled?
exclude_all_tags = []
exclude_any_tags = []
include_any_tags = []
include_all_tags = []
values.each do |key_prefix, value|
break if key_prefix && key_prefix != "-"
value.scan(
/\A(?<tag_names>([\p{N}\p{L}\-]+)(?<delimiter>[,+])?([\p{N}\p{L}\-]+)?(\k<delimiter>[\p{N}\p{L}\-]+)*)\z/,
) do |tag_names, delimiter|
match_all =
if delimiter == ","
false
else
true
end
(
case [key_prefix, match_all]
in ["-", true]
exclude_all_tags
in ["-", false]
exclude_any_tags
in [nil, true]
include_all_tags
in [nil, false]
include_any_tags
end
).concat(tag_names.split(delimiter))
end
end
if exclude_all_tags.present?
exclude_topics_with_all_tags(tag_ids_from_tag_names(exclude_all_tags))
end
if exclude_any_tags.present?
exclude_topics_with_any_tags(tag_ids_from_tag_names(exclude_any_tags))
end
if include_any_tags.present?
include_topics_with_any_tags(tag_ids_from_tag_names(include_any_tags))
end
if include_all_tags.present?
has_invalid_tags = false
all_tag_ids =
tag_ids_from_tag_names(include_all_tags) do |tag_ids, _|
has_invalid_tags = tag_ids.length < include_all_tags.length
end
if has_invalid_tags
@scope = @scope.none
else
include_topics_with_all_tags(all_tag_ids)
end
end
end
def topic_tags_alias
@topic_tags_alias ||= 0
"tt#{@topic_tags_alias += 1}"
end
def exclude_topics_with_all_tags(tag_ids)
where_clause = []
tag_ids.each do |tag_id|
sql_alias = "tt#{topic_tags_alias}"
@scope =
@scope.joins(
"LEFT JOIN topic_tags #{sql_alias} ON #{sql_alias}.topic_id = topics.id AND #{sql_alias}.tag_id = #{tag_id}",
)
where_clause << "#{sql_alias}.topic_id IS NULL"
end
@scope = @scope.where(where_clause.join(" OR "))
end
def exclude_topics_with_any_tags(tag_ids)
@scope =
@scope.where(
"topics.id NOT IN (SELECT DISTINCT topic_id FROM topic_tags WHERE topic_tags.tag_id IN (?))",
tag_ids,
)
end
def include_topics_with_all_tags(tag_ids)
tag_ids.each do |tag_id|
sql_alias = topic_tags_alias
@scope =
@scope.joins(
"INNER JOIN topic_tags #{sql_alias} ON #{sql_alias}.topic_id = topics.id AND #{sql_alias}.tag_id = #{tag_id}",
)
end
end
def include_topics_with_any_tags(tag_ids)
sql_alias = topic_tags_alias
@scope =
@scope
.joins("INNER JOIN topic_tags #{sql_alias} ON #{sql_alias}.topic_id = topics.id")
.where("#{sql_alias}.tag_id IN (?)", tag_ids)
.distinct(:id)
end
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
ORDER_BY_MAPPINGS = {
"activity" => {
column: "topics.bumped_at",
},
"category" => {
column: "categories.name",
scope: -> { @scope.joins(:category) },
},
"created" => {
column: "topics.created_at",
},
"latest-post" => {
column: "topics.last_posted_at",
},
"likes" => {
column: "topics.like_count",
},
"likes-op" => {
column: "first_posts.like_count",
scope: -> { joins_first_posts(@scope) },
},
"posters" => {
column: "topics.participant_count",
},
"title" => {
column: "LOWER(topics.title)",
},
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
"views" => {
column: "topics.views",
},
}
private_constant :ORDER_BY_MAPPINGS
ORDER_BY_REGEXP = /\A(?<order_by>#{ORDER_BY_MAPPINGS.keys.join("|")})(?<asc>-asc)?\z/
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
private_constant :ORDER_BY_REGEXP
def order_by(values:)
values.each do |value|
match_data = value.match(ORDER_BY_REGEXP)
if match_data && column_name = ORDER_BY_MAPPINGS.dig(match_data[:order_by], :column)
if scope = ORDER_BY_MAPPINGS.dig(match_data[:order_by], :scope)
@scope = instance_exec(&scope)
end
@scope = @scope.order("#{column_name} #{match_data[:asc] ? "ASC" : "DESC"}")
DEV: Support ordering filters on `/filter` route (#21275) This commit adds support for the following ordering filters: 1. `order:activity` which orders the topics by `Topic#bumped_at` in descending order 2. `order:activity-asc` which orders the topics by `Topic#bumped_at` in ascending order 3. `order:latest-post` which orders the topics by `Topic#last_posted_at` in descending order 4. `order:latest-post-asc` which orders the topics by `Topic#last_posted_at` in ascending order 5. `order:created` which orders the topics by `Topic#created_at` in descending order 6. `order:created-asc` which orders the topics by `Topic#created_at` in ascending order 7. `order:views` which orders the topics by `Topic#views` in descending order 8. `order:views-asc` which orders the topics by `Topic#views` in ascending order 9. `order:likes` which orders the topics by `Topic#likes` in descending order 10. `order:likes-asc` which orders the topics by `Topic#likes` in ascending order 11. `order:likes-op` which orders the topics by `Post#like_count` of the first post in the topic in descending order 12. `order:likes-op-asc` which orders the topics by `Post#like_count` of the first post in the topic in ascending order 13. `order:posters` which orders the topics by `Topic#participant_count` in descending order 14. `order:posters-asc` which orders the topics by `Topic#participant_count` in ascending order 15. `order:category` which orders the topics by `Category#name` of the topic's category in descending order 16. `order:category-asc` which orders the topics by `Category#name` of the topic's category in ascending order Multiple order filters can be composed together and the order of ordering is applied based on the position of the filter in the query string. For example, `order:views order:created` will order the topics by `Topic#views` in descending order and then order the topics by `Topics#created_at` in descending order.
2023-04-27 03:44:58 -04:00
end
end
end
def joins_first_posts(scope)
scope.joins(
"INNER JOIN posts AS first_posts ON first_posts.topic_id = topics.id AND first_posts.post_number = 1",
)
end
end