Class: FileHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/file_helper.rb

Defined Under Namespace

Classes: FakeIO

Class Method Summary collapse

Class Method Details

.download(url, max_file_size:, tmp_file_name:, follow_redirect: false, read_timeout: 5, skip_rate_limit: false, verbose: false, validate_uri: true, retain_on_max_file_size_exceeded: false, include_port_in_host_header: false) ⇒ Object

Raises:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/file_helper.rb', line 43

def self.download(
  url,
  max_file_size:,
  tmp_file_name:,
  follow_redirect: false,
  read_timeout: 5,
  skip_rate_limit: false,
  verbose: false,
  validate_uri: true,
  retain_on_max_file_size_exceeded: false,
  include_port_in_host_header: false
)
  url = "https:" + url if url.start_with?("//")
  raise Discourse::InvalidParameters.new(:url) unless url =~ %r{\Ahttps?://}

  tmp = nil

  fd =
    FinalDestination.new(
      url,
      max_redirects: follow_redirect ? 5 : 0,
      skip_rate_limit: skip_rate_limit,
      verbose: verbose,
      validate_uri: validate_uri,
      timeout: read_timeout,
      include_port_in_host_header: include_port_in_host_header,
    )

  fd.get do |response, chunk, uri|
    if tmp.nil?
      # error handling
      if uri.blank?
        if response.code.to_i >= 400
          # attempt error API compatibility
          io = FakeIO.new
          io.status = [response.code, ""]
          raise OpenURI::HTTPError.new("#{response.code} Error", io)
        else
          log(:error, "FinalDestination did not work for: #{url}") if verbose
          throw :done
        end
      end

      if response.content_type.present?
        ext = MiniMime.lookup_by_content_type(response.content_type)&.extension
        ext = "jpg" if ext == "jpe"
        tmp_file_ext = "." + ext if ext.present?
      end

      tmp_file_ext ||= File.extname(uri.path)
      tmp = Tempfile.new([tmp_file_name, tmp_file_ext])
      tmp.binmode
    end

    tmp.write(chunk)

    if tmp.size > max_file_size
      unless retain_on_max_file_size_exceeded
        tmp.close
        tmp = nil
      end

      throw :done
    end
  end

  tmp&.rewind
  tmp
end

.image_optim(allow_pngquant: false, strip_image_metadata: true) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/file_helper.rb', line 120

def self.image_optim(allow_pngquant: false, strip_image_metadata: true)
  # memoization is critical, initializing an ImageOptim object is very expensive
  # sometimes up to 200ms searching for binaries and looking at versions
  memoize("image_optim", allow_pngquant, strip_image_metadata) do
    pngquant_options = false
    pngquant_options = { allow_lossy: true } if allow_pngquant

    ImageOptim.new(
      # GLOBAL
      timeout: 15,
      skip_missing_workers: true,
      # PNG
      oxipng: {
        level: 3,
        strip: strip_image_metadata,
      },
      optipng: false,
      advpng: false,
      pngcrush: false,
      pngout: false,
      pngquant: pngquant_options,
      # JPG
      jpegoptim: {
        strip: strip_image_metadata ? "all" : "none",
      },
      jpegtran: false,
      jpegrecompress: false,
      # Skip looking for gifsicle, svgo binaries
      gifsicle: false,
      svgo: false,
    )
  end
end

.inline_images ⇒ Object 



166
167
168
169
 
# File 'lib/file_helper.rb', line 166

def self.inline_images
  # SVG cannot safely be shown as a document
  @@inline_images ||= supported_images - %w[svg]
end

.inline_images_regexp ⇒ Object 



191
192
193
 
# File 'lib/file_helper.rb', line 191

def self.inline_images_regexp
  @@inline_images_regexp ||= /\.(#{inline_images.to_a.join("|")})\z/i
end

.is_inline_image?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/file_helper.rb', line 27

def self.is_inline_image?(filename)
  filename.match?(inline_images_regexp)
end

.is_supported_audio?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/file_helper.rb', line 23

def self.is_supported_audio?(filename)
  filename.match?(supported_audio_regexp)
end

.is_supported_image?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/file_helper.rb', line 15

def self.is_supported_image?(filename)
  filename.match?(supported_images_regexp)
end

.is_supported_media?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/file_helper.rb', line 31

def self.is_supported_media?(filename)
  filename.match?(supported_media_regexp)
end

.is_supported_playable_media?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/file_helper.rb', line 35

def self.is_supported_playable_media?(filename)
  filename.match?(supported_playable_media_regexp)
end

.is_supported_video?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/file_helper.rb', line 19

def self.is_supported_video?(filename)
  filename.match?(supported_video_regexp)
end

.log(log_level, message) ⇒ Object 



8
9
10
11
12
13
 
# File 'lib/file_helper.rb', line 8

def self.log(log_level, message)
  Rails.logger.public_send(
    log_level,
    "#{RailsMultisite::ConnectionManagement.current_db}: #{message}",
  )
end

.memoize(*args) ⇒ Object 



154
155
156
 
# File 'lib/file_helper.rb', line 154

def self.memoize(*args)
  (@memoized ||= {})[args] ||= yield
end

.optimize_image!(filename, allow_pngquant: false) ⇒ Object 



113
114
115
116
117
118
 
# File 'lib/file_helper.rb', line 113

def self.optimize_image!(filename, allow_pngquant: false)
  image_optim(
    allow_pngquant: allow_pngquant,
    strip_image_metadata: SiteSetting.strip_image_metadata,
  ).optimize_image!(filename)
end

.supported_audio ⇒ Object 



171
172
173
 
# File 'lib/file_helper.rb', line 171

def self.supported_audio
  @@supported_audio ||= Set.new %w[mp3 ogg oga opus wav m4a m4b m4p m4r aac flac]
end

.supported_audio_regexp ⇒ Object 



183
184
185
 
# File 'lib/file_helper.rb', line 183

def self.supported_audio_regexp
  @@supported_audio_regexp ||= /\.(#{supported_audio.to_a.join("|")})\z/i
end

.supported_gravatar_extensions ⇒ Object 



158
159
160
 
# File 'lib/file_helper.rb', line 158

def self.supported_gravatar_extensions
  @@supported_gravatar_images ||= Set.new(%w[jpg jpeg png gif])
end

.supported_images ⇒ Object 



162
163
164
 
# File 'lib/file_helper.rb', line 162

def self.supported_images
  @@supported_images ||= Set.new %w[jpg jpeg png gif svg ico webp avif]
end

.supported_images_regexp ⇒ Object 



187
188
189
 
# File 'lib/file_helper.rb', line 187

def self.supported_images_regexp
  @@supported_images_regexp ||= /\.(#{supported_images.to_a.join("|")})\z/i
end

.supported_media_regexp ⇒ Object 



195
196
197
198
199
200
201
 
# File 'lib/file_helper.rb', line 195

def self.supported_media_regexp
  @@supported_media_regexp ||=
    begin
      media = supported_images | supported_audio | supported_video
      /\.(#{media.to_a.join("|")})\z/i
    end
end

.supported_playable_media_regexp ⇒ Object 



203
204
205
206
207
208
209
 
# File 'lib/file_helper.rb', line 203

def self.supported_playable_media_regexp
  @@supported_playable_media_regexp ||=
    begin
      media = supported_audio | supported_video
      /\.(#{media.to_a.join("|")})\z/i
    end
end

.supported_video ⇒ Object 



175
176
177
 
# File 'lib/file_helper.rb', line 175

def self.supported_video
  @@supported_video ||= Set.new %w[mov mp4 webm ogv m4v 3gp avi mpeg]
end

.supported_video_regexp ⇒ Object 



179
180
181
 
# File 'lib/file_helper.rb', line 179

def self.supported_video_regexp
  @@supported_video_regexp ||= /\.(#{supported_video.to_a.join("|")})\z/i
end