Class: TopicQuery

Inherits:
Object
  • Object
show all
Includes:
PrivateMessageLists
Defined in:
lib/topic_query.rb,
lib/topic_query/private_message_lists.rb

Overview

Helps us find topics. Returns a TopicList object containing the topics found.

Defined Under Namespace

Modules: PrivateMessageLists

Constant Summary collapse

SORTABLE_MAPPING =

Maps ‘order` to a columns in `topics`

{
  "likes" => "like_count",
  "op_likes" => "op_likes",
  "views" => "views",
  "posts" => "posts_count",
  "activity" => "bumped_at",
  "posters" => "participant_count",
  "category" => "category_id",
  "created" => "created_at",
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PrivateMessageLists

#filter_private_message_new, #filter_private_messages_unread, #list_private_messages, #list_private_messages_archive, #list_private_messages_direct_and_groups, #list_private_messages_group, #list_private_messages_group_archive, #list_private_messages_group_new, #list_private_messages_group_unread, #list_private_messages_new, #list_private_messages_sent, #list_private_messages_tag, #list_private_messages_unread, #list_private_messages_warnings, #private_messages_for

Constructor Details

#initialize(user = nil, options = {}) ⇒ TopicQuery

Returns a new instance of TopicQuery.



123
124
125
126
127
128
 
# File 'lib/topic_query.rb', line 123

def initialize(user = nil, options = {})
  options.assert_valid_keys(TopicQuery.valid_options)
  @options = options.dup
  @user = user
  @guardian = options[:guardian] || Guardian.new(@user)
end

Instance Attribute Details

#guardian ⇒ Object

Returns the value of attribute guardian.



100
101
102
 
# File 'lib/topic_query.rb', line 100

def guardian
  @guardian
end

#options ⇒ Object

Returns the value of attribute options.



100
101
102
 
# File 'lib/topic_query.rb', line 100

def options
  @options
end

#user ⇒ Object

Returns the value of attribute user.



100
101
102
 
# File 'lib/topic_query.rb', line 100

def user
  @user
end

Class Method Details

.add_custom_filter(key, &blk) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/topic_query.rb', line 102

def self.add_custom_filter(key, &blk)
  @custom_filters ||= {}
  valid_options << key
  public_valid_options << key
  @custom_filters[key] = blk
end

.apply_custom_filters(results, topic_query) ⇒ Object 



116
117
118
119
120
121
 
# File 'lib/topic_query.rb', line 116

def self.apply_custom_filters(results, topic_query)
  if @custom_filters
    @custom_filters.each { |key, filter| results = filter.call(results, topic_query) }
  end
  results
end

.new_filter(list, treat_as_new_topic_start_date: nil, treat_as_new_topic_clause_sql: nil) ⇒ Object 



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/topic_query.rb', line 400

def self.new_filter(list, treat_as_new_topic_start_date: nil, treat_as_new_topic_clause_sql: nil)
  if treat_as_new_topic_start_date
    list =
      list.where("topics.created_at >= :created_at", created_at: treat_as_new_topic_start_date)
  else
    list = list.where("topics.created_at >= #{treat_as_new_topic_clause_sql}")
  end

  list.where("tu.last_read_post_number IS NULL").where(
    "COALESCE(tu.notification_level, :tracking) >= :tracking",
    tracking: TopicUser.notification_levels[:tracking],
  )
end

.public_valid_options ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/topic_query.rb', line 40

def self.public_valid_options
  # For these to work in Ember, add them to `controllers/discovery-sortable.js`
  @public_valid_options ||= %i[
    page
    before
    bumped_before
    topic_ids
    category
    order
    ascending
    min_posts
    max_posts
    status
    filter
    state
    search
    q
    f
    subset
    group_name
    tags
    match_all_tags
    no_subcategories
    no_tags
    exclude_tag
  ]
end

.remove_custom_filter(key) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/topic_query.rb', line 109

def self.remove_custom_filter(key)
  @custom_filters.delete(key)
  public_valid_options.delete(key)
  valid_options.delete(key)
  @custom_filters = nil if @custom_filters.length == 0
end

.tracked_filter(list, user_id) ⇒ Object

Any changes here will need to be reflected in ‘lib/topic-list-tracked-filter.js` for the `isTrackedTopic` function on the client side. The `f=tracked` query param is not heavily used so we do not want to be querying for a topic’s tracked status by default. Instead, the client will handle the filtering when the ‘f=tracked` query params is present.



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/topic_query.rb', line 427

def self.tracked_filter(list, user_id)
  tracked_category_ids_sql = <<~SQL
  SELECT cd.category_id FROM category_users cd
  WHERE cd.user_id = :user_id AND cd.notification_level >= :tracking
  SQL

  has_sub_sub_categories = SiteSetting.max_category_nesting == 3

  sql = +<<~SQL
    topics.category_id IN (
      SELECT
        c.id
      FROM categories c
      #{has_sub_sub_categories ? "LEFT JOIN categories parent_categories ON parent_categories.id = c.parent_category_id" : ""}
      WHERE (c.id IN (#{tracked_category_ids_sql}))
      OR c.parent_category_id IN (#{tracked_category_ids_sql})
      #{has_sub_sub_categories ? "OR (parent_categories.id IS NOT NULL AND parent_categories.parent_category_id IN (#{tracked_category_ids_sql}))" : ""}
    )
  SQL

  sql << <<~SQL if SiteSetting.tagging_enabled
      OR topics.id IN (
        SELECT tt.topic_id FROM topic_tags tt WHERE tt.tag_id IN (
          SELECT tu.tag_id
          FROM tag_users tu
          WHERE tu.user_id = :user_id AND tu.notification_level >= :tracking
        )
      )
    SQL

  list.where(sql, user_id: user_id, tracking: NotificationLevels.all[:tracking])
end

.unread_filter(list, whisperer: false) ⇒ Object 



414
415
416
417
418
419
420
421
422
 
# File 'lib/topic_query.rb', line 414

def self.unread_filter(list, whisperer: false)
  col_name = whisperer ? "highest_staff_post_number" : "highest_post_number"

  list.where("tu.last_read_post_number < topics.#{col_name}").where(
    "COALESCE(tu.notification_level, :regular) >= :tracking",
    regular: TopicUser.notification_levels[:regular],
    tracking: TopicUser.notification_levels[:tracking],
  )
end

.valid_options ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/topic_query.rb', line 68

def self.valid_options
  @valid_options ||=
    public_valid_options +
      %i[
        except_topic_ids
        limit
        page
        per_page
        visible
        guardian
        no_definitions
        destination_category_id
        include_all_pms
        include_pms
      ]
end

.validate?(option, value) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
36
37
38
 
# File 'lib/topic_query.rb', line 32

def self.validate?(option, value)
  if fn = validators[option.to_sym]
    fn.call(value)
  else
    true
  end
end

.validators ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/topic_query.rb', line 14

def self.validators
  @validators ||=
    begin
      int = lambda { |x| Integer === x || (String === x && x.match?(/\A-?[0-9]+\z/)) }
      zero_up_to_max_int = lambda { |x| int.call(x) && x.to_i.between?(0, PG_MAX_INT) }
      array_or_string = lambda { |x| Array === x || String === x }

      {
        before: zero_up_to_max_int,
        bumped_before: zero_up_to_max_int,
        max_posts: zero_up_to_max_int,
        min_posts: zero_up_to_max_int,
        page: zero_up_to_max_int,
        tags: array_or_string,
      }
    end
end

Instance Method Details

#create_list(filter, options = {}, topics = nil) ⇒ Object 



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/topic_query.rb', line 490

def create_list(filter, options = {}, topics = nil)
  options[:filter] ||= filter
  topics ||= default_results(options)
  topics = yield(topics) if block_given?
  topics =
    DiscoursePluginRegistry.apply_modifier(:topic_query_create_list_topics, topics, options, self)

  options = options.merge(@options)
  if %w[activity default].include?(options[:order] || "activity") && !options[:unordered] &&
       filter != :private_messages
    topics = prioritize_pinned_topics(topics, options)
  end

  topics = topics.to_a

  if options[:preload_posters]
    user_ids = []
    topics.each do |ft|
      user_ids << ft.user_id << ft.last_post_user_id << ft.featured_user_ids <<
        ft.allowed_user_ids
    end

    user_lookup = UserLookup.new(user_ids)

    # memoize for loop so we don't keep looking these up
    translations = TopicPostersSummary.translations

    topics.each do |t|
      t.posters = t.posters_summary(user_lookup: user_lookup, translations: translations)
    end
  end

  topics.each do |t|
    if filter == :private_messages
      t.allowed_user_ids = t.allowed_users.map { |u| u.id }
      t.allowed_group_ids = t.allowed_groups.map { |g| g.id }
    else
      t.allowed_user_ids = []
      t.allowed_group_ids = []
    end
  end

  list = TopicList.new(filter, @user, topics, options.merge(@options))
  list.per_page = options[:per_page] || per_page_setting
  list
end

#get_pm_params(topic) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/topic_query.rb', line 136

def get_pm_params(topic)
  if topic.private_message?
    my_group_ids =
      topic
        .topic_allowed_groups
        .joins(
          "
        LEFT JOIN group_users gu
        ON topic_allowed_groups.group_id = gu.group_id
        AND gu.user_id = #{@user.id.to_i}
      ",
        )
        .where("gu.group_id IS NOT NULL")
        .pluck(:group_id)

    target_group_ids = topic.topic_allowed_groups.pluck(:group_id)

    target_users = topic.topic_allowed_users

    if my_group_ids.present?
      # strip out users in groups you already belong to
      target_users =
        target_users.joins(
          "LEFT JOIN group_users gu ON gu.user_id = topic_allowed_users.user_id AND #{DB.sql_fragment("gu.group_id IN (?)", my_group_ids)}",
        ).where("gu.group_id IS NULL")
    end

    target_user_ids =
      target_users.where("NOT topic_allowed_users.user_id = ?", @user.id).pluck(:user_id)

    {
      topic: topic,
      my_group_ids: my_group_ids,
      target_group_ids: target_group_ids,
      target_user_ids: target_user_ids,
    }
  end
end

#joined_topic_user(list = nil) ⇒ Object 



130
131
132
133
134
 
# File 'lib/topic_query.rb', line 130

def joined_topic_user(list = nil)
  (list || Topic).joins(
    "LEFT OUTER JOIN topic_users AS tu ON (topics.id = tu.topic_id AND tu.user_id = #{@user.id.to_i})",
  )
end

#latest_results(options = {}) ⇒ Object 



537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/topic_query.rb', line 537

def latest_results(options = {})
  result = default_results(options)
  result = remove_muted(result, @user, options)
  result = apply_shared_drafts(result, get_category_id(options[:category]), options)

  # plugins can remove topics here:
  self.class.results_filter_callbacks.each do |filter_callback|
    result = filter_callback.call(:latest, result, @user, options)
  end

  result
end

#list_bookmarks ⇒ Object 



337
338
339
 
# File 'lib/topic_query.rb', line 337

def list_bookmarks
  create_list(:bookmarks) { |l| l.where("tu.bookmarked") }
end

#list_category_topic_ids(category) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/topic_query.rb', line 381

def list_category_topic_ids(category)
  query = default_results(category: category.id)
  pinned_ids =
    query
      .where("topics.pinned_at IS NOT NULL AND topics.category_id = ?", category.id)
      .limit(nil)
      .order("pinned_at DESC")
      .pluck(:id)
  non_pinned_ids =
    query.where("topics.pinned_at IS NULL OR topics.category_id <> ?", category.id).pluck(:id)
  (pinned_ids + non_pinned_ids)
end

#list_filter ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/topic_query.rb', line 284

def list_filter
  topics_filter =
    TopicsFilter.new(
      guardian: @guardian,
      scope: latest_results(include_muted: false, skip_ordering: true),
    )

  results = topics_filter.filter_from_query_string(@options[:q])

  if !topics_filter.topic_notification_levels.include?(NotificationLevels.all[:muted])
    results = remove_muted_topics(results, @user)
  end

  results = apply_ordering(results) if results.order_values.empty?

  create_list(:filter, {}, results)
end

#list_group_topics(group) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/topic_query.rb', line 367

def list_group_topics(group)
  list =
    default_results.where(
      "
    topics.user_id IN (
      SELECT user_id FROM group_users gu WHERE gu.group_id = ?
    )
  ",
      group.id.to_i,
    )

  create_list(:group_topics, {}, list)
end

#list_latest ⇒ Object

The latest view of topics



280
281
282
 
# File 'lib/topic_query.rb', line 280

def list_latest
  create_list(:latest, {}, latest_results)
end

#list_new ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/topic_query.rb', line 308

def list_new
  if @user&.new_new_view_enabled?
    list =
      case @options[:subset]
      when "topics"
        new_results
      when "replies"
        unread_results
      else
        new_and_unread_results
      end
    create_list(:new, { unordered: true }, list)
  else
    create_list(:new, { unordered: true }, new_results)
  end
end

#list_new_in_category(category) ⇒ Object 



394
395
396
397
398
 
# File 'lib/topic_query.rb', line 394

def list_new_in_category(category)
  create_list(:new_in_category, unordered: true, category: category.id) do |list|
    list.by_newest.first(25)
  end
end

#list_posted ⇒ Object 



333
334
335
 
# File 'lib/topic_query.rb', line 333

def list_posted
  create_list(:posted) { |l| l.where("tu.posted") }
end

#list_read ⇒ Object 



302
303
304
305
306
 
# File 'lib/topic_query.rb', line 302

def list_read
  create_list(:read, unordered: true) do |topics|
    topics.where("tu.last_visited_at IS NOT NULL").order("tu.last_visited_at DESC")
  end
end

#list_related_for(topic, pm_params: nil) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/topic_query.rb', line 175

def list_related_for(topic, pm_params: nil)
  return if !topic.private_message?
  return if @user.blank?

  return if !@user.in_any_groups?(SiteSetting.personal_message_enabled_groups_map)

  builder = SuggestedTopicsBuilder.new(topic)
  pm_params = pm_params || get_pm_params(topic)

  if pm_params[:my_group_ids].present?
    builder.add_results(
      related_messages_group(
        pm_params.merge(
          count: [6, builder.results_left].max,
          exclude: builder.excluded_topic_ids,
        ),
      ),
    )
  else
    builder.add_results(
      related_messages_user(
        pm_params.merge(
          count: [6, builder.results_left].max,
          exclude: builder.excluded_topic_ids,
        ),
      ),
    )
  end

  params = { unordered: true }
  params[:preload_posters] = true
  create_list(:suggested, params, builder.results)
end

#list_suggested_for(topic, pm_params: nil, include_random: true) ⇒ Object

Return a list of suggested topics for a topic The include_random param was added so plugins can generate a suggested topics list without the random topics



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/topic_query.rb', line 211

def list_suggested_for(topic, pm_params: nil, include_random: true)
  # Don't suggest messages unless we have a user, and private messages are
  # enabled.
  if topic.private_message? &&
       (@user.blank? || !@user.in_any_groups?(SiteSetting.personal_message_enabled_groups_map))
    return
  end

  builder = SuggestedTopicsBuilder.new(topic)

  pm_params = pm_params || get_pm_params(topic)

  if DiscoursePluginRegistry.list_suggested_for_providers.any?
    DiscoursePluginRegistry.list_suggested_for_providers.each do |provider|
      suggested = provider.call(topic, pm_params, self)
      builder.add_results(suggested[:result]) if suggested && !suggested[:result].blank?
    end
  end

  # When logged in we start with different results
  if @user
    if topic.private_message?
      unless builder.full?
        builder.add_results(new_messages(pm_params.merge(count: builder.results_left)))
      end

      unless builder.full?
        builder.add_results(unread_messages(pm_params.merge(count: builder.results_left)))
      end
    else
      if @user.new_new_view_enabled?
        builder.add_results(
          new_and_unread_results(
            topic:,
            per_page: builder.results_left,
            max_age: SiteSetting.suggested_topics_unread_max_days_old,
          ),
        )
      else
        builder.add_results(
          unread_results(
            topic: topic,
            per_page: builder.results_left,
            max_age: SiteSetting.suggested_topics_unread_max_days_old,
          ),
          :high,
        )

        unless builder.full?
          builder.add_results(new_results(topic: topic, per_page: builder.category_results_left))
        end
      end
    end
  end

  if !topic.private_message?
    if include_random && !builder.full?
      builder.add_results(
        random_suggested(topic, builder.results_left, builder.excluded_topic_ids),
      )
    end
  end

  params = { unordered: true }
  params[:preload_posters] = true if topic.private_message?
  create_list(:suggested, params, builder.results)
end

#list_top_for(period) ⇒ Object 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/topic_query.rb', line 341

def list_top_for(period)
  score_column = TopTopic.score_column_for_period(period)
  create_list(:top, unordered: true) do |topics|
    topics = remove_muted_categories(topics, @user)
    topics = topics.joins(:top_topic).where("top_topics.#{score_column} > 0")
    if period == :yearly && @user.try(:trust_level) == TrustLevel[0]
      topics.order(<<~SQL)
        CASE WHEN (
           COALESCE(topics.pinned_at, '1900-01-01') > COALESCE(tu.cleared_pinned_at, '1900-01-01')
        ) THEN 0 ELSE 1 END,
        top_topics.#{score_column} DESC,
        topics.bumped_at DESC
      SQL
    else
      topics.order(<<~SQL)
        COALESCE(top_topics.#{score_column}, 0) DESC, topics.bumped_at DESC
      SQL
    end
  end
end

#list_topics_by(user) ⇒ Object 



362
363
364
365
 
# File 'lib/topic_query.rb', line 362

def list_topics_by(user)
  @options[:filtered_to_user] = user.id
  create_list(:user_topics) { |topics| topics.where(user_id: user.id) }
end

#list_unread ⇒ Object 



325
326
327
 
# File 'lib/topic_query.rb', line 325

def list_unread
  create_list(:unread, { unordered: true }, unread_results)
end

#list_unseen ⇒ Object 



329
330
331
 
# File 'lib/topic_query.rb', line 329

def list_unseen
  create_list(:unseen, { unordered: true }, unseen_results)
end

#new_and_unread_results(options = {}) ⇒ Object 



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/topic_query.rb', line 598

def new_and_unread_results(options = {})
  base = default_results(options.reverse_merge(unordered: true))

  new_results =
    TopicQuery.new_filter(
      base,
      treat_as_new_topic_start_date: @user.user_option.treat_as_new_topic_start_date,
    )

  new_results = remove_muted(new_results, @user, options)
  new_results = remove_dismissed(new_results, @user)

  unread_results =
    apply_max_age_limit(TopicQuery.unread_filter(base, whisperer: @user&.whisperer?), options)

  base.joins_values.concat(new_results.joins_values, unread_results.joins_values)
  base.joins_values.uniq!
  results = base.merge(new_results.or(unread_results))

  results = results.order("CASE WHEN topics.user_id = tu.user_id THEN 1 ELSE 2 END")
  suggested_ordering(results, options)
end

#new_results(options = {}) ⇒ Object 



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/topic_query.rb', line 580

def new_results(options = {})
  # TODO does this make sense or should it be ordered on created_at
  #  it is ordering on bumped_at now
  result =
    TopicQuery.new_filter(
      default_results(options.reverse_merge(unordered: true)),
      treat_as_new_topic_start_date: @user.user_option.treat_as_new_topic_start_date,
    )
  result = remove_muted(result, @user, options)
  result = remove_dismissed(result, @user)

  self.class.results_filter_callbacks.each do |filter_callback|
    result = filter_callback.call(:new, result, @user, options)
  end

  suggested_ordering(result, options)
end

#prioritize_pinned_topics(topics, options) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/topic_query.rb', line 460

def prioritize_pinned_topics(topics, options)
  pinned_clause =
    if options[:category_id]
      +"topics.category_id = #{options[:category_id].to_i} AND"
    else
      +"pinned_globally AND "
    end

  pinned_clause << " pinned_at IS NOT NULL "

  if @user
    pinned_clause << " AND (topics.pinned_at > tu.cleared_pinned_at OR tu.cleared_pinned_at IS NULL)"
  end

  unpinned_topics = topics.where("NOT ( #{pinned_clause} )")
  pinned_topics = topics.dup.offset(nil).where(pinned_clause).reorder(pinned_at: :desc)

  per_page = options[:per_page] || per_page_setting
  limit = per_page unless options[:limit] == false
  page = options[:page].to_i

  if page == 0
    (pinned_topics + unpinned_topics)[0...limit] if limit
  else
    offset = (page * per_page) - pinned_topics.length
    offset = 0 if offset <= 0
    unpinned_topics.offset(offset).to_a
  end
end

#unread_results(options = {}) ⇒ Object 



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/topic_query.rb', line 564

def unread_results(options = {})
  result =
    TopicQuery.unread_filter(
      default_results(options.reverse_merge(unordered: true)),
      whisperer: @user&.whisperer?,
    ).order("CASE WHEN topics.user_id = tu.user_id THEN 1 ELSE 2 END")

  result = apply_max_age_limit(result, options)

  self.class.results_filter_callbacks.each do |filter_callback|
    result = filter_callback.call(:unread, result, @user, options)
  end

  suggested_ordering(result, options)
end

#unseen_results(options = {}) ⇒ Object 



550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/topic_query.rb', line 550

def unseen_results(options = {})
  result = default_results(options)
  result = unseen_filter(result, @user.first_seen_at, @user.whisperer?) if @user
  result = remove_muted(result, @user, options)
  result = apply_shared_drafts(result, get_category_id(options[:category]), options)

  # plugins can remove topics here:
  self.class.results_filter_callbacks.each do |filter_callback|
    result = filter_callback.call(:latest, result, @user, options)
  end

  result
end