Class: UserAvatar
- Inherits:
-
ActiveRecord::Base
- Object
- ActiveRecord::Base
- UserAvatar
- Defined in:
- app/models/user_avatar.rb
Constant Summary collapse
- @@custom_user_gravatar_email_hash =
{ Discourse::SYSTEM_USER_ID => User.email_hash("[email protected]"), }
Class Method Summary collapse
- .ensure_consistency!(max_optimized_avatars_to_remove: 20_000) ⇒ Object
- .external_avatar_template(user_id, upload_id) ⇒ Object
- .external_avatar_url(user_id, upload_id, size) ⇒ Object
- .import_url_for_user(avatar_url, user, options = nil) ⇒ Object
- .local_avatar_template(hostname, username, upload_id) ⇒ Object
- .local_avatar_url(hostname, username, upload_id, size) ⇒ Object
- .register_custom_user_gravatar_email_hash(user_id, email) ⇒ Object
- .version(upload_id) ⇒ Object
Instance Method Summary collapse
Class Method Details
.ensure_consistency!(max_optimized_avatars_to_remove: 20_000) ⇒ Object
154 155 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 |
# File 'app/models/user_avatar.rb', line 154 def self.ensure_consistency!(max_optimized_avatars_to_remove: 20_000) DB.exec <<~SQL DELETE FROM user_avatars USING user_avatars ua LEFT JOIN users u ON ua.user_id = u.id WHERE user_avatars.id = ua.id AND u.id IS NULL SQL DB.exec <<~SQL UPDATE user_avatars SET gravatar_upload_id = NULL WHERE gravatar_upload_id IN ( SELECT u1.gravatar_upload_id FROM user_avatars u1 LEFT JOIN uploads up ON u1.gravatar_upload_id = up.id WHERE u1.gravatar_upload_id IS NOT NULL AND up.id IS NULL ) SQL DB.exec <<~SQL UPDATE user_avatars SET custom_upload_id = NULL WHERE custom_upload_id IN ( SELECT u1.custom_upload_id FROM user_avatars u1 LEFT JOIN uploads up ON u1.custom_upload_id = up.id WHERE u1.custom_upload_id IS NOT NULL AND up.id IS NULL ) SQL ids = DB.query_single(<<~SQL, sizes: Discourse.avatar_sizes, limit: max_optimized_avatars_to_remove) SELECT oi.id FROM ( SELECT custom_upload_id FROM user_avatars EXCEPT SELECT upload_id FROM upload_references WHERE target_type <> 'UserAvatar' AND upload_id IS NOT NULL ) AS a JOIN optimized_images oi ON oi.upload_id = a.custom_upload_id WHERE oi.width not in (:sizes) AND oi.height not in (:sizes) LIMIT :limit SQL warnings_reported = 0 ids.each do |id| begin OptimizedImage.find(id).destroy! rescue ActiveRecord::RecordNotFound rescue => e if warnings_reported < 10 Discourse.warn_exception(e, message: "Failed to remove optimized image") warnings_reported += 1 end end end end |
.external_avatar_template(user_id, upload_id) ⇒ Object
101 102 103 104 |
# File 'app/models/user_avatar.rb', line 101 def self.external_avatar_template(user_id, upload_id) version = self.version(upload_id) "#{Discourse.store.absolute_base_url}/avatars/#{user_id}/{size}/#{version}.png" end |
.external_avatar_url(user_id, upload_id, size) ⇒ Object
97 98 99 |
# File 'app/models/user_avatar.rb', line 97 def self.external_avatar_url(user_id, upload_id, size) self.external_avatar_template(user_id, upload_id).gsub("{size}", size.to_s) end |
.import_url_for_user(avatar_url, user, options = nil) ⇒ Object
110 111 112 113 114 115 116 117 118 119 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 'app/models/user_avatar.rb', line 110 def self.import_url_for_user(avatar_url, user, = nil) if SiteSetting.verbose_upload_logging Rails.logger.warn("Verbose Upload Logging: Downloading sso-avatar from #{avatar_url}") end tempfile = FileHelper.download( avatar_url, max_file_size: SiteSetting.max_image_size_kb.kilobytes, tmp_file_name: "sso-avatar", follow_redirect: true, skip_rate_limit: !!&.fetch(:skip_rate_limit, false), ) return unless tempfile ext = FastImage.type(tempfile).to_s tempfile.rewind upload = UploadCreator.new( tempfile, "external-avatar." + ext, origin: avatar_url, type: "avatar", ).create_for(user.id) user.create_user_avatar! unless user.user_avatar if !user.user_avatar.contains_upload?(upload.id) user.user_avatar.update!(custom_upload_id: upload.id) override_gravatar = ! || [:override_gravatar] if user.uploaded_avatar_id.nil? || !user.user_avatar.contains_upload?(user.uploaded_avatar_id) || override_gravatar user.update!(uploaded_avatar_id: upload.id) end end rescue Net::ReadTimeout, OpenURI::HTTPError, FinalDestination::SSRFError # Skip saving. We are not connected to the net, or SSRF checks failed. ensure tempfile.close! if tempfile && tempfile.respond_to?(:close!) end |
.local_avatar_template(hostname, username, upload_id) ⇒ Object
92 93 94 95 |
# File 'app/models/user_avatar.rb', line 92 def self.local_avatar_template(hostname, username, upload_id) version = self.version(upload_id) "#{Discourse.base_path}/user_avatar/#{hostname}/#{username}/{size}/#{version}.png" end |
.local_avatar_url(hostname, username, upload_id, size) ⇒ Object
88 89 90 |
# File 'app/models/user_avatar.rb', line 88 def self.local_avatar_url(hostname, username, upload_id, size) self.local_avatar_template(hostname, username, upload_id).gsub("{size}", size.to_s) end |
.register_custom_user_gravatar_email_hash(user_id, email) ⇒ Object
20 21 22 |
# File 'app/models/user_avatar.rb', line 20 def self.register_custom_user_gravatar_email_hash(user_id, email) @@custom_user_gravatar_email_hash[user_id] = User.email_hash(email) end |
.version(upload_id) ⇒ Object
106 107 108 |
# File 'app/models/user_avatar.rb', line 106 def self.version(upload_id) "#{upload_id}_#{OptimizedImage::VERSION}" end |
Instance Method Details
#contains_upload?(id) ⇒ Boolean
24 25 26 |
# File 'app/models/user_avatar.rb', line 24 def contains_upload?(id) gravatar_upload_id == id || custom_upload_id == id end |
#update_gravatar! ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 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 |
# File 'app/models/user_avatar.rb', line 28 def update_gravatar! DistributedMutex.synchronize("update_gravatar_#{user_id}") do begin self.update!(last_gravatar_download_attempt: Time.zone.now) max = Discourse.avatar_sizes.max # The user could be deleted before this executes return if user.blank? || user.primary_email.blank? email_hash = @@custom_user_gravatar_email_hash[user_id] || user.email_hash gravatar_url = "https://#{SiteSetting.gravatar_base_url}/avatar/#{email_hash}.png?s=#{max}&d=404&reset_cache=#{SecureRandom.urlsafe_base64(5)}" if SiteSetting.verbose_upload_logging Rails.logger.warn("Verbose Upload Logging: Downloading gravatar from #{gravatar_url}") end # follow redirects in case gravatar change rules on us tempfile = FileHelper.download( gravatar_url, max_file_size: SiteSetting.max_image_size_kb.kilobytes, tmp_file_name: "gravatar", skip_rate_limit: true, verbose: false, follow_redirect: true, ) if tempfile ext = File.extname(tempfile) ext = ".png" if ext.blank? upload = UploadCreator.new( tempfile, "gravatar#{ext}", origin: gravatar_url, type: "avatar", for_gravatar: true, ).create_for(user_id) if gravatar_upload_id != upload.id User.transaction do if gravatar_upload_id && user.uploaded_avatar_id == gravatar_upload_id user.update!(uploaded_avatar_id: upload.id) end self.update!(gravatar_upload: upload) end end end rescue OpenURI::HTTPError => e raise e if e.io&.status&.[](0).to_i != 404 ensure tempfile&.close! end end end |