]> git.openstreetmap.org Git - rails.git/blob - app/models/user.rb
Merge remote-tracking branch 'upstream/pull/4272'
[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 #  pass_salt           :string
16 #  email_valid         :boolean          default(FALSE), not null
17 #  new_email           :string
18 #  creation_ip         :string
19 #  languages           :string
20 #  status              :enum             default("pending"), not null
21 #  terms_agreed        :datetime
22 #  consider_pd         :boolean          default(FALSE), not null
23 #  auth_uid            :string
24 #  preferred_editor    :string
25 #  terms_seen          :boolean          default(FALSE), not null
26 #  description_format  :enum             default("markdown"), not null
27 #  changesets_count    :integer          default(0), not null
28 #  traces_count        :integer          default(0), not null
29 #  diary_entries_count :integer          default(0), not null
30 #  image_use_gravatar  :boolean          default(FALSE), not null
31 #  auth_provider       :string
32 #  home_tile           :bigint(8)
33 #  tou_agreed          :datetime
34 #
35 # Indexes
36 #
37 #  users_auth_idx                    (auth_provider,auth_uid) UNIQUE
38 #  users_display_name_canonical_idx  (lower(NORMALIZE(display_name, NFKC)))
39 #  users_display_name_idx            (display_name) UNIQUE
40 #  users_email_idx                   (email) UNIQUE
41 #  users_email_lower_idx             (lower((email)::text))
42 #  users_home_idx                    (home_tile)
43 #
44
45 class User < ApplicationRecord
46   require "digest"
47   include AASM
48
49   has_many :traces, -> { where(:visible => true) }
50   has_many :diary_entries, -> { order(:created_at => :desc) }, :inverse_of => :user
51   has_many :diary_comments, -> { order(:created_at => :desc) }, :inverse_of => :user
52   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
53   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
54   has_many :messages, -> { where(:to_user_visible => true, :muted => false).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
55   has_many :new_messages, -> { where(:to_user_visible => true, :muted => false, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
56   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
57   has_many :muted_messages, -> { where(:to_user_visible => true, :muted => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :to_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) }, :inverse_of => :user
63   has_many :changeset_comments, :foreign_key => :author_id, :inverse_of => :author
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, :inverse_of => :author
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", :inverse_of => :user
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, :inverse_of => :creator
77   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id, :inverse_of => :revoker
78
79   has_many :mutes, -> { order(:created_at => :desc) }, :class_name => "UserMute", :foreign_key => :owner_id, :inverse_of => :owner
80   has_many :muted_users, :through => :mutes, :source => :subject
81
82   has_many :roles, :class_name => "UserRole"
83
84   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id, :inverse_of => :reported_user
85   has_many :issue_comments
86
87   has_many :reports
88
89   scope :visible, -> { where(:status => %w[pending active confirmed]) }
90   scope :active, -> { where(:status => %w[active confirmed]) }
91   scope :identifiable, -> { where(:data_public => true) }
92
93   has_one_attached :avatar, :service => Settings.avatar_storage
94
95   validates :display_name, :presence => true, :length => 3..255,
96                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
97   validates :display_name, :if => proc { |u| u.display_name_changed? },
98                            :normalized_uniqueness => { :case_sensitive => false }
99   validates :display_name, :if => proc { |u| u.display_name_changed? },
100                            :characters => { :url_safe => true },
101                            :whitespace => { :leading => false, :trailing => false },
102                            :width => { :minimum => 3 }
103   validate :display_name_cannot_be_user_id_with_other_id, :if => proc { |u| u.display_name_changed? }
104   validates :email, :presence => true, :confirmation => true, :characters => true
105   validates :email, :if => proc { |u| u.email_changed? },
106                     :uniqueness => { :case_sensitive => false }
107   validates :email, :if => proc { |u| u.email_changed? },
108                     :whitespace => { :leading => false, :trailing => false }
109   validates :pass_crypt, :confirmation => true, :length => 8..255
110   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
111   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
112   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
113   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
114   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
115                        :uniqueness => { :scope => :auth_provider }
116   validates :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
117                      :image => true
118
119   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
120   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
121
122   alias_attribute :created_at, :creation_time
123
124   before_save :encrypt_password
125   before_save :update_tile
126   after_save :spam_check
127
128   generates_token_for :new_user, :expires_in => 1.week do
129     fingerprint
130   end
131
132   generates_token_for :new_email, :expires_in => 1.week do
133     fingerprint
134   end
135
136   generates_token_for :password_reset, :expires_in => 1.week do
137     fingerprint
138   end
139
140   def display_name_cannot_be_user_id_with_other_id
141     display_name&.match(/^user_(\d+)$/i) do |m|
142       errors.add :display_name, I18n.t("activerecord.errors.messages.display_name_is_user_n") unless m[1].to_i == id
143     end
144   end
145
146   def to_param
147     display_name
148   end
149
150   def self.authenticate(options)
151     if options[:username] && options[:password]
152       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
153
154       if user.nil?
155         users = where("LOWER(email) = LOWER(?) OR LOWER(NORMALIZE(display_name, NFKC)) = LOWER(NORMALIZE(?, NFKC))", options[:username].strip, options[:username])
156
157         user = users.first if users.count == 1
158       end
159
160       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
161         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
162           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
163           user.save
164         end
165       else
166         user = nil
167       end
168     elsif options[:token]
169       token = UserToken.find_by(:token => options[:token])
170       user = token.user if token
171     end
172
173     if user &&
174        (user.status == "deleted" ||
175          (user.status == "pending" && !options[:pending]) ||
176          (user.status == "suspended" && !options[:suspended]))
177       user = nil
178     end
179
180     token.update(:expiry => 1.week.from_now) if token && user
181
182     user
183   end
184
185   aasm :column => :status, :no_direct_assignment => true do
186     state :pending, :initial => true
187     state :active
188     state :confirmed
189     state :suspended
190     state :deleted
191
192     # A normal account is active
193     event :activate do
194       transitions :from => :pending, :to => :active
195     end
196
197     # Used in test suite, not something that we would normally need to do.
198     if Rails.env.test?
199       event :deactivate do
200         transitions :from => :active, :to => :pending
201       end
202     end
203
204     # To confirm an account is used to override the spam scoring
205     event :confirm do
206       transitions :from => [:pending, :active, :suspended], :to => :confirmed
207     end
208
209     # To unconfirm an account is to make it subject to future spam scoring again
210     event :unconfirm do
211       transitions :from => :confirmed, :to => :active
212     end
213
214     # Accounts can be automatically suspended by spam_check
215     event :suspend do
216       transitions :from => [:pending, :active], :to => :suspended
217     end
218
219     # Unsuspending an account moves it back to active without overriding the spam scoring
220     event :unsuspend do
221       transitions :from => :suspended, :to => :active
222     end
223
224     # Mark the account as deleted but keep all data intact
225     event :hide do
226       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
227     end
228
229     event :unhide do
230       transitions :from => [:deleted], :to => :active
231     end
232
233     # Mark the account as deleted and remove personal data
234     event :soft_destroy do
235       before do
236         revoke_authentication_tokens
237         remove_personal_data
238       end
239
240       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
241     end
242   end
243
244   def description
245     RichText.new(self[:description_format], self[:description])
246   end
247
248   def languages
249     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
250   end
251
252   def languages=(languages)
253     self[:languages] = languages.join(",")
254   end
255
256   def preferred_language
257     languages.find { |l| Language.exists?(:code => l) }
258   end
259
260   def preferred_languages
261     @preferred_languages ||= Locale.list(languages)
262   end
263
264   def home_location?
265     home_lat && home_lon
266   end
267
268   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
269     if home_location?
270       gc = OSM::GreatCircle.new(home_lat, home_lon)
271       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
272       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
273       nearby = User.active.identifiable
274                    .where.not(:id => id)
275                    .where(sql_for_area)
276                    .where("#{sql_for_distance} <= ?", radius)
277                    .order(Arel.sql(sql_for_distance))
278                    .limit(num)
279     else
280       nearby = []
281     end
282     nearby
283   end
284
285   def distance(nearby_user)
286     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
287   end
288
289   def friends_with?(new_friend)
290     friendships.exists?(:befriendee => new_friend)
291   end
292
293   ##
294   # returns true if a user is visible
295   def visible?
296     %w[pending active confirmed].include? status
297   end
298
299   ##
300   # returns true if a user is active
301   def active?
302     %w[active confirmed].include? status
303   end
304
305   ##
306   # returns true if the user has the moderator role, false otherwise
307   def moderator?
308     role? "moderator"
309   end
310
311   ##
312   # returns true if the user has the administrator role, false otherwise
313   def administrator?
314     role? "administrator"
315   end
316
317   ##
318   # returns true if the user has the importer role, false otherwise
319   def importer?
320     role? "importer"
321   end
322
323   ##
324   # returns true if the user has the requested role
325   def role?(role)
326     roles.any? { |r| r.role == role }
327   end
328
329   ##
330   # returns the first active block which would require users to view
331   # a message, or nil if there are none.
332   def blocked_on_view
333     blocks.active.detect(&:needs_view?)
334   end
335
336   ##
337   # revoke any authentication tokens
338   def revoke_authentication_tokens
339     oauth_tokens.authorized.each(&:invalidate!)
340     access_tokens.not_expired.each(&:revoke)
341   end
342
343   ##
344   # remove personal data - leave the account but purge most personal data
345   def remove_personal_data
346     avatar.purge_later
347
348     self.display_name = "user_#{id}"
349     self.description = ""
350     self.home_lat = nil
351     self.home_lon = nil
352     self.email_valid = false
353     self.new_email = nil
354     self.auth_provider = nil
355     self.auth_uid = nil
356
357     save
358   end
359
360   ##
361   # return a spam score for a user
362   def spam_score
363     changeset_score = changesets.size * 50
364     trace_score = traces.size * 50
365     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
366     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
367
368     score = description.spam_score / 4.0
369     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
370     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
371     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
372     score -= changeset_score
373     score -= trace_score
374
375     score.to_i
376   end
377
378   ##
379   # perform a spam check on a user
380   def spam_check
381     suspend! if may_suspend? && spam_score > Settings.spam_threshold
382   end
383
384   ##
385   # return an oauth 1 access token for a specified application
386   def access_token(application_key)
387     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
388   end
389
390   ##
391   # return an oauth 2 access token for a specified application
392   def oauth_token(application_id)
393     application = Doorkeeper.config.application_model.find_by(:uid => application_id)
394
395     Doorkeeper.config.access_token_model.find_or_create_for(
396       :application => application,
397       :resource_owner => self,
398       :scopes => application.scopes
399     )
400   end
401
402   def fingerprint
403     digest = Digest::SHA256.new
404     digest.update(email)
405     digest.update(pass_crypt)
406     digest.hexdigest
407   end
408
409   def active_reports
410     issues
411       .with_status(:open)
412       .joins(:reports)
413       .where("reports.updated_at >= COALESCE(issues.resolved_at, '1970-01-01')")
414       .count
415   end
416
417   def max_messages_per_hour
418     account_age_in_seconds = Time.now.utc - created_at
419     account_age_in_hours = account_age_in_seconds / 3600
420     recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
421     max_messages = account_age_in_hours.ceil + recent_messages - (active_reports * 10)
422     max_messages.clamp(0, Settings.max_messages_per_hour)
423   end
424
425   def max_friends_per_hour
426     account_age_in_seconds = Time.now.utc - created_at
427     account_age_in_hours = account_age_in_seconds / 3600
428     recent_friends = Friendship.where(:befriendee => self).where("created_at >= ?", Time.now.utc - 3600).count
429     max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
430     max_friends.clamp(0, Settings.max_friends_per_hour)
431   end
432
433   def max_changeset_comments_per_hour
434     if moderator?
435       Settings.moderator_changeset_comments_per_hour
436     else
437       previous_comments = changeset_comments.limit(200).count
438       max_comments = previous_comments / 200.0 * Settings.max_changeset_comments_per_hour
439       max_comments = max_comments.floor.clamp(Settings.initial_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
440       max_comments /= 2**active_reports
441       max_comments.floor.clamp(Settings.min_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
442     end
443   end
444
445   def deletion_allowed_at
446     unless Settings.user_account_deletion_delay.nil?
447       last_changeset = changesets.reorder(:closed_at => :desc).first
448       return last_changeset.closed_at.utc + Settings.user_account_deletion_delay.hours if last_changeset
449     end
450     creation_time.utc
451   end
452
453   def deletion_allowed?
454     deletion_allowed_at <= Time.now.utc
455   end
456
457   private
458
459   def encrypt_password
460     if pass_crypt_confirmation
461       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
462       self.pass_crypt_confirmation = nil
463     end
464   end
465
466   def update_tile
467     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_location?
468   end
469 end