discourse/lib/oneboxer.rb

321 lines
9.2 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
require 'uri'
Dir["#{Rails.root}/lib/onebox/engine/*_onebox.rb"].sort.each { |f| require f }
2013-02-05 14:16:51 -05:00
module Oneboxer
ONEBOX_CSS_CLASS = "onebox"
AUDIO_REGEX = /^\.(mp3|og[ga]|opus|wav|m4[abpr]|aac|flac)$/i
VIDEO_REGEX = /^\.(mov|mp4|m4v|webm|ogv|3gp)$/i
# keep reloaders happy
unless defined? Oneboxer::Result
Result = Struct.new(:doc, :changed) do
def to_html
doc.to_html
end
def changed?
changed
end
end
end
def self.ignore_redirects
2019-11-27 04:22:28 -05:00
@ignore_redirects ||= ['http://www.dropbox.com', 'http://store.steampowered.com', 'http://vimeo.com', Discourse.base_url]
end
def self.force_get_hosts
@force_get_hosts ||= ['http://us.battle.net']
end
def self.force_custom_user_agent_hosts
@force_custom_user_agent_hosts ||= ['http://codepen.io']
end
def self.allowed_post_types
@allowed_post_types ||= [Post.types[:regular], Post.types[:moderator_action]]
end
2017-07-27 21:20:09 -04:00
def self.preview(url, options = nil)
options ||= {}
invalidate(url) if options[:invalidate_oneboxes]
onebox_raw(url, options)[:preview]
2013-02-05 14:16:51 -05:00
end
2017-07-27 21:20:09 -04:00
def self.onebox(url, options = nil)
options ||= {}
invalidate(url) if options[:invalidate_oneboxes]
onebox_raw(url, options)[:onebox]
end
def self.cached_onebox(url)
if c = Discourse.cache.read(onebox_cache_key(url))
c[:onebox]
end
rescue => e
invalidate(url)
Rails.logger.warn("invalid cached onebox for #{url} #{e}")
""
end
def self.cached_preview(url)
if c = Discourse.cache.read(onebox_cache_key(url))
c[:preview]
end
rescue => e
invalidate(url)
Rails.logger.warn("invalid cached preview for #{url} #{e}")
""
end
2014-01-28 13:18:19 -05:00
def self.invalidate(url)
Discourse.cache.delete(onebox_cache_key(url))
Discourse.cache.delete(onebox_failed_cache_key(url))
2013-02-05 14:16:51 -05:00
end
2014-01-28 13:18:19 -05:00
2013-02-05 14:16:51 -05:00
# Parse URLs out of HTML, returning the document when finished.
def self.each_onebox_link(string_or_doc, extra_paths: [])
2013-02-05 14:16:51 -05:00
doc = string_or_doc
doc = Nokogiri::HTML::fragment(doc) if doc.is_a?(String)
2013-02-05 14:16:51 -05:00
onebox_links = doc.css("a.#{ONEBOX_CSS_CLASS}", *extra_paths)
2013-02-05 14:16:51 -05:00
if onebox_links.present?
onebox_links.each do |link|
yield(link['href'], link) if link['href'].present?
2013-02-05 14:16:51 -05:00
end
end
doc
end
HTML5_BLOCK_ELEMENTS ||= %w{address article aside blockquote canvas center dd div dl dt fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 header hgroup hr li main nav noscript ol output p pre section table tfoot ul video}
def self.apply(string_or_doc, extra_paths: nil)
doc = string_or_doc
doc = Nokogiri::HTML::fragment(doc) if doc.is_a?(String)
changed = false
each_onebox_link(doc, extra_paths: extra_paths) do |url, element|
onebox, _ = yield(url, element)
if onebox
parsed_onebox = Nokogiri::HTML::fragment(onebox)
next unless parsed_onebox.children.count > 0
if element&.parent&.node_name&.downcase == "p" &&
element.parent.children.count == 1 &&
HTML5_BLOCK_ELEMENTS.include?(parsed_onebox.children[0].node_name.downcase)
element = element.parent
end
changed = true
element.swap parsed_onebox.to_html
end
end
# strip empty <p> elements
doc.css("p").each { |p| p.remove if p.children.empty? }
Result.new(doc, changed)
end
def self.is_previewing?(user_id)
Discourse.redis.get(preview_key(user_id)) == "1"
end
def self.preview_onebox!(user_id)
Discourse.redis.setex(preview_key(user_id), 1.minute, "1")
end
def self.onebox_previewed!(user_id)
Discourse.redis.del(preview_key(user_id))
end
def self.engine(url)
Onebox::Matcher.new(url).oneboxed
end
def self.recently_failed?(url)
Discourse.cache.read(onebox_failed_cache_key(url)).present?
end
def self.cache_failed!(url)
Discourse.cache.write(onebox_failed_cache_key(url), true, expires_in: 1.hour)
end
private
2018-06-07 01:28:18 -04:00
def self.preview_key(user_id)
"onebox:preview:#{user_id}"
end
2018-06-07 01:28:18 -04:00
def self.blank_onebox
{ preview: "", onebox: "" }
end
2018-06-07 01:28:18 -04:00
def self.onebox_cache_key(url)
"onebox__#{url}"
end
2015-08-23 20:43:07 -04:00
def self.onebox_failed_cache_key(url)
"onebox_failed__#{url}"
end
2018-06-07 01:28:18 -04:00
def self.onebox_raw(url, opts = {})
url = URI(url).to_s
local_onebox(url, opts) || external_onebox(url)
rescue => e
# no point warning here, just cause we have an issue oneboxing a url
# we can later hunt for failed oneboxes by searching logs if needed
Rails.logger.info("Failed to onebox #{url} #{e} #{e.backtrace}")
# return a blank hash, so rest of the code works
blank_onebox
end
2018-06-07 01:28:18 -04:00
def self.local_onebox(url, opts = {})
return unless route = Discourse.route_for(url)
2018-06-07 01:28:18 -04:00
html =
case route[:controller]
when "uploads" then local_upload_html(url)
when "topics" then local_topic_html(url, route, opts)
when "users" then local_user_html(url, route)
end
2018-06-07 01:28:18 -04:00
html = html.presence || "<a href='#{url}'>#{url}</a>"
{ onebox: html, preview: html }
end
2018-06-07 01:28:18 -04:00
def self.local_upload_html(url)
case File.extname(URI(url).path || "")
when VIDEO_REGEX
<<~HTML
<div class="onebox video-onebox">
<video width="100%" height="100%" controls="">
<source src='#{url}'>
<a href='#{url}'>#{url}</a>
</source>
</video>
</div>
HTML
when AUDIO_REGEX
2018-06-07 01:28:18 -04:00
"<audio controls><source src='#{url}'><a href='#{url}'>#{url}</a></audio>"
end
2018-06-07 01:28:18 -04:00
end
2018-06-07 01:28:18 -04:00
def self.local_topic_html(url, route, opts)
return unless current_user = User.find_by(id: opts[:user_id])
2018-06-07 01:28:18 -04:00
if current_category = Category.find_by(id: opts[:category_id])
return unless Guardian.new(current_user).can_see_category?(current_category)
end
2018-06-07 01:28:18 -04:00
if current_topic = Topic.find_by(id: opts[:topic_id])
return unless Guardian.new(current_user).can_see_topic?(current_topic)
end
2018-06-07 01:28:18 -04:00
topic = Topic.find_by(id: route[:topic_id])
2018-06-07 01:28:18 -04:00
return unless topic
return if topic.private_message?
2018-02-15 16:00:06 -05:00
2018-06-07 01:28:18 -04:00
if current_category&.id != topic.category_id
return unless Guardian.new.can_see_topic?(topic)
end
2018-02-15 16:56:13 -05:00
2018-06-07 01:28:18 -04:00
post_number = route[:post_number].to_i
2018-02-16 05:21:11 -05:00
2018-06-07 01:28:18 -04:00
post = post_number > 1 ?
topic.posts.where(post_number: post_number).first :
topic.ordered_posts.first
2018-02-15 16:56:13 -05:00
return if !post || post.hidden || !allowed_post_types.include?(post.post_type)
2018-06-07 01:28:18 -04:00
if post_number > 1 && current_topic&.id == topic.id
excerpt = post.excerpt(SiteSetting.post_onebox_maxlength)
excerpt.gsub!(/[\r\n]+/, " ")
excerpt.gsub!("[/quote]", "[quote]") # don't break my quote
2018-06-07 01:28:18 -04:00
quote = "[quote=\"#{post.user.username}, topic:#{topic.id}, post:#{post.post_number}\"]\n#{excerpt}\n[/quote]"
2018-06-07 01:28:18 -04:00
PrettyText.cook(quote)
else
args = {
topic_id: topic.id,
post_number: post.post_number,
avatar: PrettyText.avatar_img(post.user.avatar_template, "tiny"),
original_url: url,
title: PrettyText.unescape_emoji(CGI::escapeHTML(topic.title)),
category_html: CategoryBadge.html_for(topic.category),
quote: PrettyText.unescape_emoji(post.excerpt(SiteSetting.post_onebox_maxlength)),
}
2018-06-07 01:28:18 -04:00
template = File.read("#{Rails.root}/lib/onebox/templates/discourse_topic_onebox.hbs")
Mustache.render(template, args)
end
2018-06-07 01:28:18 -04:00
end
2018-06-07 01:28:18 -04:00
def self.local_user_html(url, route)
username = route[:username] || ""
if user = User.find_by(username_lower: username.downcase)
name = user.name if SiteSetting.enable_names
2018-06-07 01:28:18 -04:00
args = {
user_id: user.id,
username: user.username,
avatar: PrettyText.avatar_img(user.avatar_template, "extra_large"),
name: name,
2018-06-07 01:28:18 -04:00
bio: user.user_profile.bio_excerpt(230),
location: Onebox::Helpers.sanitize(user.user_profile.location),
2018-06-07 01:28:18 -04:00
joined: I18n.t('joined'),
created_at: user.created_at.strftime(I18n.t('datetime_formats.formats.date_only')),
website: user.user_profile.website,
website_name: UserSerializer.new(user).website_name,
original_url: url
}
template = File.read("#{Rails.root}/lib/onebox/templates/discourse_user_onebox.hbs")
Mustache.render(template, args)
else
nil
end
2018-06-07 01:28:18 -04:00
end
def self.blacklisted_domains
SiteSetting.onebox_domains_blacklist.split("|")
end
2018-12-19 01:27:07 -05:00
def self.preserve_fragment_url_hosts
@preserve_fragment_url_hosts ||= ['http://github.com']
2018-12-19 01:27:07 -05:00
end
2018-06-07 01:28:18 -04:00
def self.external_onebox(url)
Discourse.cache.fetch(onebox_cache_key(url), expires_in: 1.day) do
fd = FinalDestination.new(url,
ignore_redirects: ignore_redirects,
ignore_hostnames: blacklisted_domains,
force_get_hosts: force_get_hosts,
force_custom_user_agent_hosts: force_custom_user_agent_hosts,
preserve_fragment_url_hosts: preserve_fragment_url_hosts)
2018-06-07 01:28:18 -04:00
uri = fd.resolve
return blank_onebox if uri.blank? || blacklisted_domains.map { |hostname| uri.hostname.match?(hostname) }.any?
2018-06-07 01:28:18 -04:00
options = {
max_width: 695,
sanitize_config: Onebox::DiscourseOneboxSanitizeConfig::Config::DISCOURSE_ONEBOX
2018-06-07 01:28:18 -04:00
}
2018-06-07 01:28:18 -04:00
options[:cookie] = fd.cookie if fd.cookie
2018-06-07 01:28:18 -04:00
r = Onebox.preview(uri.to_s, options)
2018-06-07 01:28:18 -04:00
{ onebox: r.to_s, preview: r&.placeholder_html.to_s }
end
2018-06-07 01:28:18 -04:00
end
2013-02-05 14:16:51 -05:00
end