2022-11-02 21:41:30 +08:00
# frozen_string_literal: true
module Chat::ChatChannelFetcher
MAX_PUBLIC_CHANNEL_RESULTS = 50
def self . structured ( guardian )
memberships = Chat :: ChatChannelMembershipManager . all_for_user ( guardian . user )
{
public_channels :
secured_public_channels ( guardian , memberships , status : :open , following : true ) ,
direct_message_channels :
secured_direct_message_channels ( guardian . user . id , memberships , guardian ) ,
memberships : memberships ,
}
end
def self . all_secured_channel_ids ( guardian , following : true )
allowed_channel_ids_sql = generate_allowed_channel_ids_sql ( guardian )
return DB . query_single ( allowed_channel_ids_sql ) if ! following
DB . query_single ( << ~ SQL , user_id : guardian . user . id )
SELECT chat_channel_id
FROM user_chat_channel_memberships
WHERE user_chat_channel_memberships . user_id = :user_id
AND user_chat_channel_memberships . chat_channel_id IN (
#{allowed_channel_ids_sql}
)
SQL
end
2022-11-24 08:07:59 +08:00
def self . generate_allowed_channel_ids_sql ( guardian , exclude_dm_channels : false )
category_channel_sql =
2022-11-02 21:41:30 +08:00
ChatChannel
. select ( :id )
. joins (
" INNER JOIN categories ON categories.id = chat_channels.chatable_id AND chat_channels.chatable_type = 'Category' " ,
)
. where (
" categories.id IN (:allowed_category_ids) " ,
allowed_category_ids : guardian . allowed_category_ids ,
)
. to_sql
2022-11-24 08:07:59 +08:00
dm_channel_sql = " "
if ! exclude_dm_channels
dm_channel_sql = << ~ SQL
2022-11-02 21:41:30 +08:00
UNION
- - secured direct message chat channels
#{
2022-11-24 08:07:59 +08:00
ChatChannel
. select ( :id )
. joins (
" INNER JOIN direct_message_channels ON direct_message_channels.id = chat_channels.chatable_id
2022-11-02 22:53:36 +08:00
AND chat_channels . chatable_type = 'DirectMessage'
2022-11-02 21:41:30 +08:00
INNER JOIN direct_message_users ON direct_message_users . direct_message_channel_id = direct_message_channels . id " ,
2022-11-24 08:07:59 +08:00
)
. where ( " direct_message_users.user_id = :user_id " , user_id : guardian . user . id )
. to_sql
}
SQL
end
<< ~ SQL
- - secured category chat channels
#{category_channel_sql}
#{dm_channel_sql}
2022-11-02 21:41:30 +08:00
SQL
end
2022-11-24 08:07:59 +08:00
def self . secured_public_channel_slug_lookup ( guardian , slugs )
allowed_channel_ids = generate_allowed_channel_ids_sql ( guardian , exclude_dm_channels : true )
ChatChannel
. joins (
" LEFT JOIN categories ON categories.id = chat_channels.chatable_id AND chat_channels.chatable_type = 'Category' " ,
)
. where ( chatable_type : ChatChannel . public_channel_chatable_types )
. where ( " chat_channels.id IN ( #{ allowed_channel_ids } ) " )
. where ( " chat_channels.slug IN (:slugs) " , slugs : slugs )
. limit ( 1 )
end
2022-11-02 21:41:30 +08:00
def self . secured_public_channel_search ( guardian , options = { } )
2022-11-24 08:07:59 +08:00
allowed_channel_ids =
generate_allowed_channel_ids_sql ( guardian , exclude_dm_channels : options [ :exclude_dm_channels ] )
channels = ChatChannel . includes ( chatable : [ :topic_only_relative_url ] )
channels = channels . includes ( :chat_channel_archive ) if options [ :include_archives ]
2022-11-02 21:41:30 +08:00
channels =
2022-11-24 08:07:59 +08:00
channels
2022-11-02 21:41:30 +08:00
. joins (
" LEFT JOIN categories ON categories.id = chat_channels.chatable_id AND chat_channels.chatable_type = 'Category' " ,
)
. where ( chatable_type : ChatChannel . public_channel_chatable_types )
2022-11-24 08:07:59 +08:00
. where ( " chat_channels.id IN ( #{ allowed_channel_ids } ) " )
2022-11-02 21:41:30 +08:00
channels = channels . where ( status : options [ :status ] ) if options [ :status ] . present?
if options [ :filter ] . present?
2022-11-24 12:45:13 +08:00
category_filter = \
if options [ :filter_on_category_name ]
" OR categories.name ILIKE :filter "
else
" "
end
2022-11-24 08:07:59 +08:00
sql =
2022-11-24 12:45:13 +08:00
" chat_channels.name ILIKE :filter OR chat_channels.slug ILIKE :filter #{ category_filter } "
2022-11-02 21:41:30 +08:00
channels =
channels . where ( sql , filter : " % #{ options [ :filter ] . downcase } % " ) . order (
" chat_channels.name ASC, categories.name ASC " ,
)
end
FEATURE: Generic hashtag autocomplete lookup and markdown cooking (#18937)
This commit fleshes out and adds functionality for the new `#hashtag` search and
lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete`
feature flag.
**Serverside**
We have two plugin API registration methods that are used to define data sources
(`register_hashtag_data_source`) and hashtag result type priorities depending on
the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb
should make it clear what these are doing. Reading the `HashtagAutocompleteService`
in full will likely help a lot as well.
Each data source is responsible for providing its own **lookup** and **search**
method that returns hashtag results based on the arguments provided. For example,
the category hashtag data source has to take into account parent categories and
how they relate, and each data source has to define their own icon to use for the
hashtag, and so on.
The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`.
There is `hashtag_icons` that is just a simple array of all the different icons that
can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations`
that is used to store the type priority orders for each registered context.
When sending emails, we cannot render the SVG icons for hashtags, so
we need to change the HTML hashtags to the normal `#hashtag` text.
**Markdown**
The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete`
markdown rule, and like all of our rules this is used to cook the raw text on both the clientside
and on the serverside using MiniRacer. Only on the server side do we actually reach out to
the database with the `hashtagLookup` function, on the clientside we just render a plainer
version of the hashtag HTML. Only in the composer preview do we do further lookups based
on this.
This rule is the first one (that I can find) that uses the `currentUser` based on a passed
in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id`
for both the post and chat message. In some cases we need to cook without a user present,
so the `Discourse.system_user` is used in this case.
**Chat Channels**
This also contains the changes required for chat so that chat channels can be used
as a data source for hashtag searches and lookups. This data source will only be
used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have
to worry about channel results suddenly turning up.
------
**Known Rough Edges**
- Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR
- Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR
- Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future
- Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity)
- Additional refinements and review fixes wil
2022-11-21 06:37:06 +08:00
if options . key? ( :slugs )
channels = channels . where ( " chat_channels.slug IN (:slugs) " , slugs : options [ :slugs ] )
end
2022-11-02 21:41:30 +08:00
if options . key? ( :following )
if options [ :following ]
channels =
channels . joins ( :user_chat_channel_memberships ) . where (
user_chat_channel_memberships : {
user_id : guardian . user . id ,
following : true ,
} ,
)
else
channels =
channels . where (
" chat_channels.id NOT IN (SELECT chat_channel_id FROM user_chat_channel_memberships uccm WHERE uccm.chat_channel_id = chat_channels.id AND following IS TRUE AND user_id = ?) " ,
guardian . user . id ,
)
end
end
options [ :limit ] = ( options [ :limit ] || MAX_PUBLIC_CHANNEL_RESULTS ) . to_i . clamp (
1 ,
MAX_PUBLIC_CHANNEL_RESULTS ,
)
options [ :offset ] = [ options [ :offset ] . to_i , 0 ] . max
channels . limit ( options [ :limit ] ) . offset ( options [ :offset ] )
end
def self . secured_public_channels ( guardian , memberships , options = { following : true } )
2022-11-24 08:07:59 +08:00
channels =
secured_public_channel_search (
guardian ,
2022-11-24 12:45:13 +08:00
options . merge ( include_archives : true , filter_on_category_name : true ) ,
2022-11-24 08:07:59 +08:00
)
2022-11-02 21:41:30 +08:00
decorate_memberships_with_tracking_data ( guardian , channels , memberships )
channels = channels . to_a
preload_custom_fields_for ( channels )
channels
end
def self . preload_custom_fields_for ( channels )
preload_fields = Category . instance_variable_get ( :@custom_field_types ) . keys
Category . preload_custom_fields (
channels . select { | c | c . chatable_type == " Category " } . map ( & :chatable ) ,
preload_fields ,
)
end
def self . secured_direct_message_channels ( user_id , memberships , guardian )
query = ChatChannel . includes ( chatable : [ { direct_message_users : :user } , :users ] )
query = query . includes ( chatable : [ { users : :user_status } ] ) if SiteSetting . enable_user_status
channels =
query
. joins ( :user_chat_channel_memberships )
. where ( user_chat_channel_memberships : { user_id : user_id , following : true } )
2022-11-02 22:53:36 +08:00
. where ( chatable_type : " DirectMessage " )
2022-11-02 21:41:30 +08:00
. where ( " chat_channels.id IN ( #{ generate_allowed_channel_ids_sql ( guardian ) } ) " )
. order ( last_message_sent_at : :desc )
. to_a
preload_fields =
User . allowed_user_custom_fields ( guardian ) +
UserField . all . pluck ( :id ) . map { | fid | " #{ User :: USER_FIELD_PREFIX } #{ fid } " }
User . preload_custom_fields ( channels . map { | c | c . chatable . users } . flatten , preload_fields )
decorate_memberships_with_tracking_data ( guardian , channels , memberships )
end
def self . decorate_memberships_with_tracking_data ( guardian , channels , memberships )
unread_counts_per_channel = unread_counts ( channels , guardian . user . id )
mention_notifications =
Notification . unread . where (
user_id : guardian . user . id ,
notification_type : Notification . types [ :chat_mention ] ,
)
mention_notification_data = mention_notifications . map { | m | JSON . parse ( m . data ) }
channels . each do | channel |
membership = memberships . find { | m | m . chat_channel_id == channel . id }
if membership
membership . unread_mentions =
mention_notification_data . count do | data |
data [ " chat_channel_id " ] == channel . id &&
data [ " chat_message_id " ] > ( membership . last_read_message_id || 0 )
end
membership . unread_count = unread_counts_per_channel [ channel . id ] if ! membership . muted
end
end
end
def self . unread_counts ( channels , user_id )
unread_counts = DB . query_array ( << ~ SQL , channel_ids : channels . map ( & :id ) , user_id : user_id ) . to_h
SELECT cc . id , COUNT ( * ) as count
FROM chat_messages cm
JOIN chat_channels cc ON cc . id = cm . chat_channel_id
JOIN user_chat_channel_memberships uccm ON uccm . chat_channel_id = cc . id
WHERE cc . id IN ( :channel_ids )
AND cm . user_id != :user_id
AND uccm . user_id = :user_id
AND cm . id > COALESCE ( uccm . last_read_message_id , 0 )
AND cm . deleted_at IS NULL
GROUP BY cc . id
SQL
unread_counts . default = 0
unread_counts
end
def self . find_with_access_check ( channel_id_or_name , guardian )
begin
channel_id_or_name = Integer ( channel_id_or_name )
rescue ArgumentError
end
base_channel_relation =
ChatChannel . includes ( :chatable ) . joins (
" LEFT JOIN categories ON categories.id = chat_channels.chatable_id AND chat_channels.chatable_type = 'Category' " ,
)
if guardian . user . staff?
base_channel_relation = base_channel_relation . includes ( :chat_channel_archive )
end
if channel_id_or_name . is_a? Integer
chat_channel = base_channel_relation . find_by ( id : channel_id_or_name )
else
chat_channel =
base_channel_relation . find_by (
" LOWER(categories.name) = :name OR LOWER(chat_channels.name) = :name " ,
name : channel_id_or_name . downcase ,
)
end
raise Discourse :: NotFound if chat_channel . blank?
raise Discourse :: InvalidAccess if ! guardian . can_see_chat_channel? ( chat_channel )
chat_channel
end
end