Update bundle
[rails.git] / app / models / user.rb
1 # == Schema Information
2 #
3 # Table name: users
4 #
5 #  email               :string           not null
6 #  id                  :bigint(8)        not null, primary key
7 #  pass_crypt          :string           not null
8 #  creation_time       :datetime         not null
9 #  display_name        :string           default(""), not null
10 #  data_public         :boolean          default(FALSE), not null
11 #  description         :text             default(""), not null
12 #  home_lat            :float
13 #  home_lon            :float
14 #  home_zoom           :integer          default(3)
15 #  nearby              :integer          default(50)
16 #  pass_salt           :string
17 #  email_valid         :boolean          default(FALSE), not null
18 #  new_email           :string
19 #  creation_ip         :string
20 #  languages           :string
21 #  status              :enum             default("pending"), not null
22 #  terms_agreed        :datetime
23 #  consider_pd         :boolean          default(FALSE), not null
24 #  auth_uid            :string
25 #  preferred_editor    :string
26 #  terms_seen          :boolean          default(FALSE), not null
27 #  description_format  :enum             default("markdown"), not null
28 #  changesets_count    :integer          default(0), not null
29 #  traces_count        :integer          default(0), not null
30 #  diary_entries_count :integer          default(0), not null
31 #  image_use_gravatar  :boolean          default(FALSE), not null
32 #  auth_provider       :string
33 #  home_tile           :bigint(8)
34 #  tou_agreed          :datetime
35 #
36 # Indexes
37 #
38 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
39 #  users_display_name_idx        (display_name) UNIQUE
40 #  users_display_name_lower_idx  (lower((display_name)::text))
41 #  users_email_idx               (email) UNIQUE
42 #  users_email_lower_idx         (lower((email)::text))
43 #  users_home_idx                (home_tile)
44 #
45
46 class User < ApplicationRecord
47   require "digest"
48   require "xml/libxml"
49
50   has_many :traces, -> { where(:visible => true) }
51   has_many :diary_entries, -> { order(:created_at => :desc) }
52   has_many :diary_comments, -> { order(:created_at => :desc) }
53   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
54   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
55   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
56   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
57   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
58   has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
59   has_many :friends, :through => :friendships, :source => :befriendee
60   has_many :tokens, :class_name => "UserToken", :dependent => :destroy
61   has_many :preferences, :class_name => "UserPreference"
62   has_many :changesets, -> { order(:created_at => :desc) }
63   has_many :changeset_comments, :foreign_key => :author_id
64   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
65   has_many :note_comments, :foreign_key => :author_id
66   has_many :notes, :through => :note_comments
67
68   has_many :client_applications
69   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
70
71   has_many :oauth2_applications, :class_name => Doorkeeper.config.application_model.name, :as => :owner
72   has_many :access_grants, :class_name => Doorkeeper.config.access_grant_model.name, :foreign_key => :resource_owner_id
73   has_many :access_tokens, :class_name => Doorkeeper.config.access_token_model.name, :foreign_key => :resource_owner_id
74
75   has_many :blocks, :class_name => "UserBlock"
76   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
77   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
78
79   has_many :roles, :class_name => "UserRole"
80
81   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
82   has_many :issue_comments
83
84   has_many :reports
85
86   scope :visible, -> { where(:status => %w[pending active confirmed]) }
87   scope :active, -> { where(:status => %w[active confirmed]) }
88   scope :identifiable, -> { where(:data_public => true) }
89
90   has_one_attached :avatar
91
92   validates :display_name, :presence => true, :length => 3..255,
93                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
94   validates :display_name, :if => proc { |u| u.display_name_changed? },
95                            :uniqueness => { :case_sensitive => false }
96   validates :display_name, :if => proc { |u| u.display_name_changed? },
97                            :characters => { :url_safe => true },
98                            :whitespace => { :leading => false, :trailing => false }
99   validates :email, :presence => true, :confirmation => true, :characters => true
100   validates :email, :if => proc { |u| u.email_changed? },
101                     :uniqueness => { :case_sensitive => false }
102   validates :email, :if => proc { |u| u.email_changed? },
103                     :whitespace => { :leading => false, :trailing => false }
104   validates :pass_crypt, :confirmation => true, :length => 8..255
105   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
106   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
107   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
108   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
109   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
110                        :uniqueness => { :scope => :auth_provider }
111   validates :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
112                      :image => true
113
114   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
115   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
116
117   after_initialize :set_defaults
118   before_save :encrypt_password
119   before_save :update_tile
120   after_save :spam_check
121
122   def to_param
123     display_name
124   end
125
126   def self.authenticate(options)
127     if options[:username] && options[:password]
128       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
129
130       if user.nil?
131         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])
132
133         user = users.first if users.count == 1
134       end
135
136       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
137         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
138           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
139           user.save
140         end
141       else
142         user = nil
143       end
144     elsif options[:token]
145       token = UserToken.find_by(:token => options[:token])
146       user = token.user if token
147     end
148
149     if user &&
150        (user.status == "deleted" ||
151          (user.status == "pending" && !options[:pending]) ||
152          (user.status == "suspended" && !options[:suspended]))
153       user = nil
154     end
155
156     token.update(:expiry => 1.week.from_now) if token && user
157
158     user
159   end
160
161   def description
162     RichText.new(self[:description_format], self[:description])
163   end
164
165   def languages
166     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
167   end
168
169   def languages=(languages)
170     self[:languages] = languages.join(",")
171   end
172
173   def preferred_language
174     languages.find { |l| Language.exists?(:code => l) }
175   end
176
177   def preferred_languages
178     @preferred_languages ||= Locale.list(languages)
179   end
180
181   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
182     if home_lon && home_lat
183       gc = OSM::GreatCircle.new(home_lat, home_lon)
184       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
185       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
186       nearby = User.active.identifiable
187                    .where.not(:id => id)
188                    .where(sql_for_area)
189                    .where("#{sql_for_distance} <= ?", radius)
190                    .order(Arel.sql(sql_for_distance))
191                    .limit(num)
192     else
193       nearby = []
194     end
195     nearby
196   end
197
198   def distance(nearby_user)
199     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
200   end
201
202   def is_friends_with?(new_friend)
203     friendships.exists?(:befriendee => new_friend)
204   end
205
206   ##
207   # returns true if a user is visible
208   def visible?
209     %w[pending active confirmed].include? status
210   end
211
212   ##
213   # returns true if a user is active
214   def active?
215     %w[active confirmed].include? status
216   end
217
218   ##
219   # returns true if the user has the moderator role, false otherwise
220   def moderator?
221     has_role? "moderator"
222   end
223
224   ##
225   # returns true if the user has the administrator role, false otherwise
226   def administrator?
227     has_role? "administrator"
228   end
229
230   ##
231   # returns true if the user has the requested role
232   def has_role?(role)
233     roles.any? { |r| r.role == role }
234   end
235
236   ##
237   # returns the first active block which would require users to view
238   # a message, or nil if there are none.
239   def blocked_on_view
240     blocks.active.detect(&:needs_view?)
241   end
242
243   ##
244   # delete a user - leave the account but purge most personal data
245   def delete
246     avatar.purge_later
247
248     self.display_name = "user_#{id}"
249     self.description = ""
250     self.home_lat = nil
251     self.home_lon = nil
252     self.email_valid = false
253     self.new_email = nil
254     self.auth_provider = nil
255     self.auth_uid = nil
256     self.status = "deleted"
257
258     save
259   end
260
261   ##
262   # return a spam score for a user
263   def spam_score
264     changeset_score = changesets.size * 50
265     trace_score = traces.size * 50
266     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
267     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
268
269     score = description.spam_score / 4.0
270     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
271     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
272     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
273     score -= changeset_score
274     score -= trace_score
275
276     score.to_i
277   end
278
279   ##
280   # perform a spam check on a user
281   def spam_check
282     update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
283   end
284
285   ##
286   # return an oauth 1 access token for a specified application
287   def access_token(application_key)
288     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
289   end
290
291   ##
292   # return an oauth 2 access token for a specified application
293   def oauth_token(application_id)
294     application = Doorkeeper.config.application_model.find_by(:uid => application_id)
295
296     Doorkeeper.config.access_token_model.find_or_create_for(
297       :application => application,
298       :resource_owner => self,
299       :scopes => application.scopes
300     )
301   end
302
303   def fingerprint
304     digest = Digest::SHA256.new
305     digest.update(email)
306     digest.update(pass_crypt)
307     digest.hexdigest
308   end
309
310   def max_messages_per_hour
311     account_age_in_seconds = Time.now.utc - creation_time
312     account_age_in_hours = account_age_in_seconds / 3600
313     recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
314     active_reports = issues.with_status(:open).sum(:reports_count)
315     max_messages = account_age_in_hours.ceil + recent_messages - active_reports * 10
316     max_messages.clamp(0, Settings.max_messages_per_hour)
317   end
318
319   def max_friends_per_hour
320     account_age_in_seconds = Time.now.utc - creation_time
321     account_age_in_hours = account_age_in_seconds / 3600
322     recent_friends = Friendship.where(:befriendee => self).where("created_at >= ?", Time.now.utc - 3600).count
323     active_reports = issues.with_status(:open).sum(:reports_count)
324     max_friends = account_age_in_hours.ceil + recent_friends - active_reports * 10
325     max_friends.clamp(0, Settings.max_friends_per_hour)
326   end
327
328   private
329
330   def set_defaults
331     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
332   end
333
334   def encrypt_password
335     if pass_crypt_confirmation
336       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
337       self.pass_crypt_confirmation = nil
338     end
339   end
340
341   def update_tile
342     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
343   end
344 end