mirror of
https://github.com/discourse/discourse.git
synced 2026-08-08 20:18:23 -05:00
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
This commit is contained in:
Martin Brennan
@@ -185,6 +185,7 @@ module Email
|
||||
correct_first_body_margin
|
||||
correct_footer_style
|
||||
correct_footer_style_highlight_first
|
||||
decorate_hashtags
|
||||
reset_tables
|
||||
|
||||
html_lang = SiteSetting.default_locale.sub("_", "-")
|
||||
@@ -323,6 +324,16 @@ module Email
|
||||
end
|
||||
end
|
||||
|
||||
def decorate_hashtags
|
||||
@fragment.search(".hashtag-cooked").each do |hashtag|
|
||||
hashtag_text = hashtag.search("span").first
|
||||
hashtag_text.add_next_sibling(<<~HTML)
|
||||
<span>##{hashtag["data-slug"]}</span>
|
||||
HTML
|
||||
hashtag_text.remove
|
||||
end
|
||||
end
|
||||
|
||||
def make_all_links_absolute
|
||||
site_uri = URI(Discourse.base_url)
|
||||
@fragment.css("a").each do |link|
|
||||
|
||||
+42
-7
@@ -1086,14 +1086,49 @@ class Plugin::Instance
|
||||
About.add_plugin_stat_group(plugin_stat_group_name, show_in_ui: show_in_ui, &block)
|
||||
end
|
||||
|
||||
# Registers a new record type to be searched via the HashtagAutocompleteService and the
|
||||
# /hashtags/search endpoint. The data returned by the block must be an array
|
||||
# with each item an instance of HashtagAutocompleteService::HashtagItem.
|
||||
##
|
||||
# Used to register data sources for HashtagAutocompleteService to look
|
||||
# up results based on a #hashtag string.
|
||||
#
|
||||
# See also registerHashtagSearchParam in the plugin JS API, otherwise the
|
||||
# clientside hashtag search code will use the new type registered here.
|
||||
def register_hashtag_data_source(type, &block)
|
||||
HashtagAutocompleteService.register_data_source(type, &block)
|
||||
# @param {String} type - Roughly corresponding to a model, this is used as a unique
|
||||
# key for the datasource and is also used when allowing different
|
||||
# contexts to search for and lookup these types. The `category`
|
||||
# and `tag` types are registered by default.
|
||||
# @param {Class} klass - Must be a class that implements methods with the following
|
||||
# signatures:
|
||||
#
|
||||
# @param {Guardian} guardian - Current user's guardian, used for permission-based filtering
|
||||
# @param {Array} slugs - An array of strings that represent slugs to search this type for,
|
||||
# e.g. category slugs.
|
||||
# @returns {Hash} A hash with the slug as the key and the URL of the record as the value.
|
||||
# def self.lookup(guardian, slugs)
|
||||
# end
|
||||
#
|
||||
# @param {Guardian} guardian - Current user's guardian, used for permission-based filtering
|
||||
# @param {String} term - The search term used to filter results
|
||||
# @param {Integer} limit - The number of search results that should be returned by the query
|
||||
# @returns {Array} An Array of HashtagAutocompleteService::HashtagItem
|
||||
# def self.search(guardian, term, limit)
|
||||
# end
|
||||
def register_hashtag_data_source(type, klass)
|
||||
HashtagAutocompleteService.register_data_source(type, klass)
|
||||
end
|
||||
|
||||
##
|
||||
# Used to set up the priority ordering of hashtag autocomplete results by
|
||||
# type using HashtagAutocompleteService.
|
||||
#
|
||||
# @param {String} type - Roughly corresponding to a model, can only be registered once
|
||||
# per context. The `category` and `tag` types are registered
|
||||
# for the `topic-composer` context by default in that priority order.
|
||||
# @param {String} context - The context in which the hashtag lookup or search is happening
|
||||
# in. For example, the Discourse composer context is `topic-composer`.
|
||||
# Different contexts may want to have different priority orderings
|
||||
# for certain types of hashtag result.
|
||||
# @param {Integer} priority - A number value for ordering type results when hashtag searches
|
||||
# or lookups occur. Priority is ordered by DESCENDING order.
|
||||
def register_hashtag_type_in_context(type, context, priority)
|
||||
HashtagAutocompleteService.register_type_in_context(type, context, priority)
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
@@ -171,6 +171,9 @@ module PrettyText
|
||||
# user_id - User id for the post being cooked.
|
||||
# force_quote_link - Always create the link to the quoted topic for [quote] bbcode. Normally this only happens
|
||||
# if the topic_id provided is different from the [quote topic:X].
|
||||
# hashtag_context - Defaults to "topic-composer" if not supplied. Controls the order of #hashtag lookup results
|
||||
# based on registered hashtag contexts from the `#register_hashtag_search_param` plugin API
|
||||
# method.
|
||||
def self.markdown(text, opts = {})
|
||||
# we use the exact same markdown converter as the client
|
||||
# TODO: use the same extensions on both client and server (in particular the template for mentions)
|
||||
@@ -201,6 +204,7 @@ module PrettyText
|
||||
__optInput.formatUsername = __formatUsername;
|
||||
__optInput.getTopicInfo = __getTopicInfo;
|
||||
__optInput.categoryHashtagLookup = __categoryLookup;
|
||||
__optInput.hashtagLookup = __hashtagLookup;
|
||||
__optInput.customEmoji = #{custom_emoji.to_json};
|
||||
__optInput.customEmojiTranslation = #{Plugin::CustomEmoji.translations.to_json};
|
||||
__optInput.emojiUnicodeReplacer = __emojiUnicodeReplacer;
|
||||
@@ -221,8 +225,17 @@ module PrettyText
|
||||
|
||||
if opts[:user_id]
|
||||
buffer << "__optInput.userId = #{opts[:user_id].to_i};\n"
|
||||
buffer << "__optInput.currentUser = #{User.find(opts[:user_id]).to_json}\n"
|
||||
end
|
||||
|
||||
opts[:hashtag_context] = opts[:hashtag_context] || "topic-composer"
|
||||
hashtag_types_as_js = HashtagAutocompleteService.ordered_types_for_context(
|
||||
opts[:hashtag_context]
|
||||
).map { |t| "'#{t}'" }.join(",")
|
||||
hashtag_icons_as_js = HashtagAutocompleteService.data_source_icons.map { |i| "'#{i}'" }.join(",")
|
||||
buffer << "__optInput.hashtagTypesInPriorityOrder = [#{hashtag_types_as_js}];\n"
|
||||
buffer << "__optInput.hashtagIcons = [#{hashtag_icons_as_js}];\n"
|
||||
|
||||
buffer << "__textOptions = __buildOptions(__optInput);\n"
|
||||
buffer << ("__pt = new __PrettyText(__textOptions);")
|
||||
|
||||
|
||||
@@ -41,14 +41,6 @@ module PrettyText
|
||||
username
|
||||
end
|
||||
|
||||
def category_hashtag_lookup(category_slug)
|
||||
if category = Category.query_from_hashtag_slug(category_slug)
|
||||
[category.url, category_slug]
|
||||
else
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
def lookup_upload_urls(urls)
|
||||
map = {}
|
||||
result = {}
|
||||
@@ -103,6 +95,8 @@ module PrettyText
|
||||
end
|
||||
end
|
||||
|
||||
# TODO (martin) Remove this when everything is using hashtag_lookup
|
||||
# after enable_experimental_hashtag_autocomplete is default.
|
||||
def category_tag_hashtag_lookup(text)
|
||||
is_tag = text =~ /#{TAG_HASHTAG_POSTFIX}$/
|
||||
|
||||
@@ -116,6 +110,29 @@ module PrettyText
|
||||
end
|
||||
end
|
||||
|
||||
def hashtag_lookup(slug, cooking_user, types_in_priority_order)
|
||||
# This is _somewhat_ expected since we need to be able to cook posts
|
||||
# etc. without a user sometimes, but it is still an edge case.
|
||||
if cooking_user.blank?
|
||||
cooking_user = Discourse.system_user
|
||||
end
|
||||
|
||||
cooking_user = User.new(cooking_user) if cooking_user.is_a?(Hash)
|
||||
|
||||
result = HashtagAutocompleteService.new(
|
||||
Guardian.new(cooking_user)
|
||||
).lookup([slug], types_in_priority_order)
|
||||
|
||||
found_hashtag = nil
|
||||
types_in_priority_order.each do |type|
|
||||
if result[type.to_sym].any?
|
||||
found_hashtag = result[type.to_sym].first.to_h
|
||||
break
|
||||
end
|
||||
end
|
||||
found_hashtag
|
||||
end
|
||||
|
||||
def get_current_user(user_id)
|
||||
return unless user_id.is_a?(Integer)
|
||||
{ staff: User.where(id: user_id).where("moderator OR admin").exists? }
|
||||
|
||||
@@ -107,10 +107,16 @@ function __getTopicInfo(i) {
|
||||
return __helpers.get_topic_info(i);
|
||||
}
|
||||
|
||||
// TODO (martin) Remove this when everything is using hashtag_lookup
|
||||
// after enable_experimental_hashtag_autocomplete is default.
|
||||
function __categoryLookup(c) {
|
||||
return __helpers.category_tag_hashtag_lookup(c);
|
||||
}
|
||||
|
||||
function __hashtagLookup(slug, cookingUser, typesInPriorityOrder) {
|
||||
return __helpers.hashtag_lookup(slug, cookingUser, typesInPriorityOrder);
|
||||
}
|
||||
|
||||
function __lookupAvatar(p) {
|
||||
return __utils.avatarImg(
|
||||
{ size: "tiny", avatarTemplate: __helpers.avatar_template(p) },
|
||||
|
||||
Reference in New Issue
Block a user