Class: CookedPostProcessor
- Inherits:
-
Object
- Object
- CookedPostProcessor
- Includes:
- CookedProcessorMixin
- Defined in:
- lib/cooked_post_processor.rb
Overview
Post processing that we can do after a post has already been cooked. For example, inserting the onebox content, or image sizes/thumbnails.
Constant Summary collapse
- LIGHTBOX_WRAPPER_CSS_CLASS =
"lightbox-wrapper"
- GIF_SOURCES_REGEXP =
%r{(giphy|tenor)\.com/}
- MIN_LIGHTBOX_WIDTH =
100
- MIN_LIGHTBOX_HEIGHT =
100
Instance Attribute Summary collapse
-
#cooking_options ⇒ Object
readonly
Returns the value of attribute cooking_options.
-
#doc ⇒ Object
readonly
Returns the value of attribute doc.
Instance Method Summary collapse
- #add_lightbox!(img, original_width, original_height, upload) ⇒ Object
- #convert_to_link!(img) ⇒ Object
- #enforce_nofollow ⇒ Object
- #extract_images ⇒ Object
- #extract_images_for_post ⇒ Object
- #get_filename(upload, src) ⇒ Object
- #grant_badges ⇒ Object
- #has_emoji? ⇒ Boolean
-
#initialize(post, opts = {}) ⇒ CookedPostProcessor
constructor
A new instance of CookedPostProcessor.
- #optimize_image!(img, upload, cropped: false) ⇒ Object
- #optimize_urls ⇒ Object
- #post_process(new_post: false) ⇒ Object
- #post_process_quotes ⇒ Object
- #remove_full_quote_on_direct_reply ⇒ Object
- #remove_user_ids ⇒ Object
- #update_post_image ⇒ Object
- #update_uploads_secure_status ⇒ Object
Methods included from CookedProcessorMixin
#add_blocked_hotlinked_image_placeholder!, #add_blocked_hotlinked_media_placeholder!, #add_broken_image_placeholder!, #add_large_image_placeholder!, #add_to_size_cache, #create_icon_node, #create_link_node, #create_node, #create_span_node, #dirty?, #each_responsive_ratio, #get_size, #get_size_from_attributes, #get_size_from_image_sizes, #html, #is_a_hyperlink?, #is_valid_image_url?, #limit_size!, #oneboxed_images, #post_process_oneboxes, #process_inline_onebox, #remove_inline_onebox_loading_class
Constructor Details
#initialize(post, opts = {}) ⇒ CookedPostProcessor
Returns a new instance of CookedPostProcessor.
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/cooked_post_processor.rb', line 16 def initialize(post, opts = {}) @dirty = false @opts = opts @post = post @model = post @previous_cooked = (@post.cooked || "").dup # NOTE: we re-cook the post here in order to prevent timing issues with edits # cf. https://meta.discourse.org/t/edit-of-rebaked-post-doesnt-show-in-html-only-in-raw/33815/6 @cooking_options = post. || opts[:cooking_options] || {} @cooking_options[:topic_id] = post.topic_id @cooking_options = @cooking_options.symbolize_keys @should_secure_uploads = @post.should_secure_uploads? @category_id = @post&.topic&.category_id cooked = post.cook(post.raw, @cooking_options) @doc = Loofah.html5_fragment(cooked) @has_oneboxes = post.post_analyzer.found_oneboxes? @size_cache = {} @disable_dominant_color = !!opts[:disable_dominant_color] @omit_nofollow = post.omit_nofollow? end |
Instance Attribute Details
#cooking_options ⇒ Object (readonly)
Returns the value of attribute cooking_options.
14 15 16 |
# File 'lib/cooked_post_processor.rb', line 14 def @cooking_options end |
#doc ⇒ Object (readonly)
Returns the value of attribute doc.
14 15 16 |
# File 'lib/cooked_post_processor.rb', line 14 def doc @doc end |
Instance Method Details
#add_lightbox!(img, original_width, original_height, upload) ⇒ Object
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/cooked_post_processor.rb', line 270 def add_lightbox!(img, original_width, original_height, upload) return if original_width < MIN_LIGHTBOX_WIDTH || original_height < MIN_LIGHTBOX_HEIGHT # first, create a div to hold our lightbox lightbox = create_node("div", LIGHTBOX_WRAPPER_CSS_CLASS) img.add_next_sibling(lightbox) lightbox.add_child(img) # then, the link to our larger image src_url = Upload.secure_uploads_url?(img["src"]) ? upload&.url || img["src"] : img["src"] src = UrlHelper.cook_url(src_url, secure: @should_secure_uploads) a = create_link_node("lightbox", src) img.add_next_sibling(a) a["data-download-href"] = Discourse.store.download_url(upload) if upload a.add_child(img) # then, some overlay informations = create_node("div", "meta") img.add_next_sibling() filename = get_filename(upload, img["src"]) informations = +"#{original_width}×#{original_height}" informations << " #{upload.human_filesize}" if upload a["title"] = img["title"] || img["alt"] || filename .add_child create_icon_node("far-image") .add_child create_span_node("filename", a["title"]) .add_child create_span_node("informations", informations) .add_child create_icon_node("discourse-expand") end |
#convert_to_link!(img) ⇒ Object
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/cooked_post_processor.rb', line 156 def convert_to_link!(img) w, h = img["width"].to_i, img["height"].to_i user_width, user_height = (w > 0 && h > 0 && [w, h]) || get_size_from_attributes(img) || get_size_from_image_sizes(img["src"], @opts[:image_sizes]) limit_size!(img) src = img["src"] return if src.blank? || is_a_hyperlink?(img) || is_svg?(img) upload = Upload.get_from_url(src) original_width, original_height = nil if (upload.present?) original_width = upload.width || 0 original_height = upload.height || 0 else original_width, original_height = (get_size(src) || [0, 0]).map(&:to_i) if original_width == 0 || original_height == 0 Rails.logger.info "Can't reach '#{src}' to get its dimension." return end end if (upload.present? && upload.animated?) || src.match?(GIF_SOURCES_REGEXP) img.add_class("animated") end generate_thumbnail = original_width > SiteSetting.max_image_width || original_height > SiteSetting.max_image_height user_width, user_height = [original_width, original_height] if user_width.to_i <= 0 && user_height.to_i <= 0 width, height = user_width, user_height crop = SiteSetting.min_ratio_to_crop > 0 && width.to_f / height.to_f < SiteSetting.min_ratio_to_crop if crop width, height = ImageSizer.crop(width, height) img["width"], img["height"] = width, height else width, height = ImageSizer.resize(width, height) end if upload.present? if generate_thumbnail upload.create_thumbnail!(width, height, crop: crop) each_responsive_ratio do |ratio| resized_w = (width * ratio).to_i resized_h = (height * ratio).to_i if upload.width && resized_w <= upload.width upload.create_thumbnail!(resized_w, resized_h, crop: crop) end end end return if upload.animated? if img.ancestors(".onebox, .onebox-body").blank? && !img.classes.include?("onebox") add_lightbox!(img, original_width, original_height, upload) end optimize_image!(img, upload, cropped: crop) if generate_thumbnail end end |
#enforce_nofollow ⇒ Object
382 383 384 385 |
# File 'lib/cooked_post_processor.rb', line 382 def enforce_nofollow add_nofollow = !@omit_nofollow && SiteSetting.add_rel_nofollow_to_user_content PrettyText.add_rel_attributes_to_user_content(@doc, add_nofollow) end |
#extract_images ⇒ Object
132 133 134 135 136 137 138 139 |
# File 'lib/cooked_post_processor.rb', line 132 def extract_images # all images with a src attribute @doc.css("img[src], img[#{PrettyText::BLOCKED_HOTLINKED_SRC_ATTR}]") - # minus data images @doc.css("img[src^='data']") - # minus emojis @doc.css("img.emoji") end |
#extract_images_for_post ⇒ Object
141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/cooked_post_processor.rb', line 141 def extract_images_for_post # all images with a src attribute @doc.css("img[src]") - # minus emojis @doc.css("img.emoji") - # minus images inside quotes @doc.css(".quote img") - # minus onebox site icons @doc.css("img.site-icon") - # minus onebox avatars @doc.css("img.onebox-avatar") - @doc.css("img.onebox-avatar-inline") - # minus github onebox profile images @doc.css(".onebox.githubfolder img") end |
#get_filename(upload, src) ⇒ Object
305 306 307 308 309 |
# File 'lib/cooked_post_processor.rb', line 305 def get_filename(upload, src) return File.basename(src) unless upload return upload.original_filename unless upload.original_filename =~ /\Ablob(\.png)?\z/i I18n.t("upload.pasted_image_filename") end |
#grant_badges ⇒ Object
63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/cooked_post_processor.rb', line 63 def grant_badges return if @post.user.blank? || !Guardian.new.can_see?(@post) BadgeGranter.grant(Badge.find(Badge::FirstEmoji), @post.user, post_id: @post.id) if has_emoji? if @has_oneboxes BadgeGranter.grant(Badge.find(Badge::FirstOnebox), @post.user, post_id: @post.id) end if @post.is_reply_by_email? BadgeGranter.grant(Badge.find(Badge::FirstReplyByEmail), @post.user, post_id: @post.id) end end |
#has_emoji? ⇒ Boolean
59 60 61 |
# File 'lib/cooked_post_processor.rb', line 59 def has_emoji? (@doc.css("img.emoji") - @doc.css(".quote img")).size > 0 end |
#optimize_image!(img, upload, cropped: false) ⇒ Object
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 |
# File 'lib/cooked_post_processor.rb', line 227 def optimize_image!(img, upload, cropped: false) w, h = img["width"].to_i, img["height"].to_i onebox = img.ancestors(".onebox, .onebox-body").first # note: optimize_urls cooks the src further after this thumbnail = upload.thumbnail(w, h) if thumbnail && thumbnail.filesize.to_i < upload.filesize img["src"] = thumbnail.url srcset = +"" # Skip srcset for onebox images. Because onebox thumbnails by default # are fairly small the width/height of the smallest thumbnail is likely larger # than what the onebox thumbnail size will be displayed at, so we shouldn't # need to upscale for retina devices if !onebox each_responsive_ratio do |ratio| resized_w = (w * ratio).to_i resized_h = (h * ratio).to_i if !cropped && upload.width && resized_w > upload.width cooked_url = UrlHelper.cook_url(upload.url, secure: @should_secure_uploads) srcset << ", #{cooked_url} #{ratio.to_s.sub(/\.0\z/, "")}x" elsif t = upload.thumbnail(resized_w, resized_h) cooked_url = UrlHelper.cook_url(t.url, secure: @should_secure_uploads) srcset << ", #{cooked_url} #{ratio.to_s.sub(/\.0\z/, "")}x" end img[ "srcset" ] = "#{UrlHelper.cook_url(img["src"], secure: @should_secure_uploads)}#{srcset}" if srcset.present? end end else img["src"] = upload.url end if !@disable_dominant_color && (color = upload.dominant_color(calculate_if_missing: true).presence) img["data-dominant-color"] = color end end |
#optimize_urls ⇒ Object
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/cooked_post_processor.rb', line 344 def optimize_urls %w[href data-download-href].each do |selector| @doc.css("a[#{selector}]").each { |a| a[selector] = UrlHelper.cook_url(a[selector].to_s) } end %w[src].each do |selector| @doc .css("img[#{selector}]") .each do |img| custom_emoji = img["class"]&.include?("emoji-custom") && Emoji.custom?(img["title"]) img[selector] = UrlHelper.cook_url( img[selector].to_s, secure: @should_secure_uploads && !custom_emoji, ) end end end |
#post_process(new_post: false) ⇒ Object
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/cooked_post_processor.rb', line 39 def post_process(new_post: false) DistributedMutex.synchronize("post_process_#{@post.id}", validity: 10.minutes) do DiscourseEvent.trigger(:before_post_process_cooked, @doc, @post) update_uploads_secure_status remove_full_quote_on_direct_reply if new_post post_process_oneboxes post_process_images add_blocked_hotlinked_media_placeholders post_process_quotes optimize_urls remove_user_ids update_post_image enforce_nofollow grant_badges @post.link_post_uploads(fragments: @doc) DiscourseEvent.trigger(:post_process_cooked, @doc, @post) nil end end |
#post_process_quotes ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/cooked_post_processor.rb', line 75 def post_process_quotes @doc .css("aside.quote") .each do |q| post_number = q["data-post"] topic_id = q["data-topic"] if topic_id && post_number comparer = QuoteComparer.new(topic_id.to_i, post_number.to_i, q.css("blockquote").text) q["class"] = ((q["class"] || "") + " quote-post-not-found").strip if comparer.missing? q["class"] = ((q["class"] || "") + " quote-modified").strip if comparer.modified? end end end |
#remove_full_quote_on_direct_reply ⇒ Object
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/cooked_post_processor.rb', line 94 def remove_full_quote_on_direct_reply return if !SiteSetting.remove_full_quote return if @post.post_number == 1 return if @doc.xpath("aside[contains(@class, 'quote')]").size != 1 previous = Post .where( "post_number < ? AND topic_id = ? AND post_type = ? AND NOT hidden", @post.post_number, @post.topic_id, Post.types[:regular], ) .order("post_number DESC") .limit(1) .pluck(:cooked) .first return if previous.blank? previous_text = Nokogiri::HTML5.fragment(previous).text.strip quoted_text = @doc.css("aside.quote:first-child blockquote").first&.text&.strip || "" return if previous_text.gsub(/(\s){2,}/, '\1') != quoted_text.gsub(/(\s){2,}/, '\1') quote_regexp = %r{\A\s*\[quote.+\[/quote\]}im quoteless_raw = @post.raw.sub(quote_regexp, "").strip return if @post.raw.strip == quoteless_raw PostRevisor.new(@post).revise!( Discourse.system_user, { raw: quoteless_raw, edit_reason: I18n.t(:removed_direct_reply_full_quotes) }, skip_validations: true, bypass_bump: true, ) end |
#remove_user_ids ⇒ Object
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/cooked_post_processor.rb', line 362 def remove_user_ids @doc .css("a[href]") .each do |a| uri = begin URI(a["href"]) rescue URI::Error next end next if uri.hostname != Discourse.current_hostname query = Rack::Utils.parse_nested_query(uri.query) next if !query.delete("u") uri.query = query.map { |k, v| "#{k}=#{v}" }.join("&").presence a["href"] = uri.to_s end end |
#update_post_image ⇒ Object
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/cooked_post_processor.rb', line 311 def update_post_image upload = nil images = extract_images_for_post @post.each_upload_url(fragments: images.css("[data-thumbnail]")) do |src, path, sha1| upload = Upload.find_by(sha1: sha1) break if upload end if upload.nil? # No specified thumbnail. Use any image: @post.each_upload_url(fragments: images.css(":not([data-thumbnail])")) do |src, path, sha1| upload = Upload.find_by(sha1: sha1) break if upload end end if upload.present? @post.update_column(:image_upload_id, upload.id) # post if @post.is_first_post? # topic @post.topic.update_column(:image_upload_id, upload.id) extra_sizes = ThemeModifierHelper.new(theme_ids: Theme.user_selectable.pluck(:id)).topic_thumbnail_sizes @post.topic.generate_thumbnails!(extra_sizes: extra_sizes) end else @post.update_column(:image_upload_id, nil) if @post.image_upload_id if @post.topic.image_upload_id && @post.is_first_post? @post.topic.update_column(:image_upload_id, nil) end nil end end |
#update_uploads_secure_status ⇒ Object
90 91 92 |
# File 'lib/cooked_post_processor.rb', line 90 def update_uploads_secure_status @post.update_uploads_secure_status(source: "post processor") end |