]> git.openstreetmap.org Git - rails.git/blob - app/models/user.rb
Merge remote-tracking branch 'upstream/pull/4472'
[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_idx        (display_name) UNIQUE
39 #  users_display_name_lower_idx  (lower((display_name)::text))
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                            :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   validates :email, :presence => true, :confirmation => true, :characters => true
103   validates :email, :if => proc { |u| u.email_changed? },
104                     :uniqueness => { :case_sensitive => false }
105   validates :email, :if => proc { |u| u.email_changed? },
106                     :whitespace => { :leading => false, :trailing => false }
107   validates :pass_crypt, :confirmation => true, :length => 8..255
108   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
109   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
110   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
111   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
112   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
113                        :uniqueness => { :scope => :auth_provider }
114   validates :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
115                      :image => true
116
117   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
118   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
119
120   alias_attribute :created_at, :creation_time
121
122   before_save :encrypt_password
123   before_save :update_tile
124   after_save :spam_check
125
126   def to_param
127     display_name
128   end
129
130   def self.authenticate(options)
131     if options[:username] && options[:password]
132       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
133
134       if user.nil?
135         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])
136
137         user = users.first if users.count == 1
138       end
139
140       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
141         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
142           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
143           user.save
144         end
145       else
146         user = nil
147       end
148     elsif options[:token]
149       token = UserToken.find_by(:token => options[:token])
150       user = token.user if token
151     end
152
153     if user &&
154        (user.status == "deleted" ||
155          (user.status == "pending" && !options[:pending]) ||
156          (user.status == "suspended" && !options[:suspended]))
157       user = nil
158     end
159
160     token.update(:expiry => 1.week.from_now) if token && user
161
162     user
163   end
164
165   aasm :column => :status, :no_direct_assignment => true do
166     state :pending, :initial => true
167     state :active
168     state :confirmed
169     state :suspended
170     state :deleted
171
172     # A normal account is active
173     event :activate do
174       transitions :from => :pending, :to => :active
175     end
176
177     # Used in test suite, not something that we would normally need to do.
178     if Rails.env.test?
179       event :deactivate do
180         transitions :from => :active, :to => :pending
181       end
182     end
183
184     # To confirm an account is used to override the spam scoring
185     event :confirm do
186       transitions :from => [:pending, :active, :suspended], :to => :confirmed
187     end
188
189     # To unconfirm an account is to make it subject to future spam scoring again
190     event :unconfirm do
191       transitions :from => :confirmed, :to => :active
192     end
193
194     # Accounts can be automatically suspended by spam_check
195     event :suspend do
196       transitions :from => [:pending, :active], :to => :suspended
197     end
198
199     # Unsuspending an account moves it back to active without overriding the spam scoring
200     event :unsuspend do
201       transitions :from => :suspended, :to => :active
202     end
203
204     # Mark the account as deleted but keep all data intact
205     event :hide do
206       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
207     end
208
209     event :unhide do
210       transitions :from => [:deleted], :to => :active
211     end
212
213     # Mark the account as deleted and remove personal data
214     event :soft_destroy do
215       before do
216         revoke_authentication_tokens
217         remove_personal_data
218       end
219
220       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
221     end
222   end
223
224   def description
225     RichText.new(self[:description_format], self[:description])
226   end
227
228   def languages
229     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
230   end
231
232   def languages=(languages)
233     self[:languages] = languages.join(",")
234   end
235
236   def preferred_language
237     languages.find { |l| Language.exists?(:code => l) }
238   end
239
240   def preferred_languages
241     @preferred_languages ||= Locale.list(languages)
242   end
243
244   def home_location?
245     home_lat && home_lon
246   end
247
248   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
249     if home_location?
250       gc = OSM::GreatCircle.new(home_lat, home_lon)
251       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
252       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
253       nearby = User.active.identifiable
254                    .where.not(:id => id)
255                    .where(sql_for_area)
256                    .where("#{sql_for_distance} <= ?", radius)
257                    .order(Arel.sql(sql_for_distance))
258                    .limit(num)
259     else
260       nearby = []
261     end
262     nearby
263   end
264
265   def distance(nearby_user)
266     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
267   end
268
269   def friends_with?(new_friend)
270     friendships.exists?(:befriendee => new_friend)
271   end
272
273   ##
274   # returns true if a user is visible
275   def visible?
276     %w[pending active confirmed].include? status
277   end
278
279   ##
280   # returns true if a user is active
281   def active?
282     %w[active confirmed].include? status
283   end
284
285   ##
286   # returns true if the user has the moderator role, false otherwise
287   def moderator?
288     role? "moderator"
289   end
290
291   ##
292   # returns true if the user has the administrator role, false otherwise
293   def administrator?
294     role? "administrator"
295   end
296
297   ##
298   # returns true if the user has the importer role, false otherwise
299   def importer?
300     role? "importer"
301   end
302
303   ##
304   # returns true if the user has the requested role
305   def role?(role)
306     roles.any? { |r| r.role == role }
307   end
308
309   ##
310   # returns the first active block which would require users to view
311   # a message, or nil if there are none.
312   def blocked_on_view
313     blocks.active.detect(&:needs_view?)
314   end
315
316   ##
317   # revoke any authentication tokens
318   def revoke_authentication_tokens
319     oauth_tokens.authorized.each(&:invalidate!)
320     access_tokens.not_expired.each(&:revoke)
321   end
322
323   ##
324   # remove personal data - leave the account but purge most personal data
325   def remove_personal_data
326     avatar.purge_later
327
328     self.display_name = "user_#{id}"
329     self.description = ""
330     self.home_lat = nil
331     self.home_lon = nil
332     self.email_valid = false
333     self.new_email = nil
334     self.auth_provider = nil
335     self.auth_uid = nil
336
337     save
338   end
339
340   ##
341   # return a spam score for a user
342   def spam_score
343     changeset_score = changesets.size * 50
344     trace_score = traces.size * 50
345     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
346     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
347
348     score = description.spam_score / 4.0
349     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
350     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
351     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
352     score -= changeset_score
353     score -= trace_score
354
355     score.to_i
356   end
357
358   ##
359   # perform a spam check on a user
360   def spam_check
361     suspend! if may_suspend? && spam_score > Settings.spam_threshold
362   end
363
364   ##
365   # return an oauth 1 access token for a specified application
366   def access_token(application_key)
367     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
368   end
369
370   ##
371   # return an oauth 2 access token for a specified application
372   def oauth_token(application_id)
373     application = Doorkeeper.config.application_model.find_by(:uid => application_id)
374
375     Doorkeeper.config.access_token_model.find_or_create_for(
376       :application => application,
377       :resource_owner => self,
378       :scopes => application.scopes
379     )
380   end
381
382   def fingerprint
383     digest = Digest::SHA256.new
384     digest.update(email)
385     digest.update(pass_crypt)
386     digest.hexdigest
387   end
388
389   def active_reports
390     issues
391       .with_status(:open)
392       .joins(:reports)
393       .where("reports.updated_at >= COALESCE(issues.resolved_at, '1970-01-01')")
394       .count
395   end
396
397   def max_messages_per_hour
398     account_age_in_seconds = Time.now.utc - created_at
399     account_age_in_hours = account_age_in_seconds / 3600
400     recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
401     max_messages = account_age_in_hours.ceil + recent_messages - (active_reports * 10)
402     max_messages.clamp(0, Settings.max_messages_per_hour)
403   end
404
405   def max_friends_per_hour
406     account_age_in_seconds = Time.now.utc - created_at
407     account_age_in_hours = account_age_in_seconds / 3600
408     recent_friends = Friendship.where(:befriendee => self).where("created_at >= ?", Time.now.utc - 3600).count
409     max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
410     max_friends.clamp(0, Settings.max_friends_per_hour)
411   end
412
413   def max_changeset_comments_per_hour
414     if moderator?
415       Settings.moderator_changeset_comments_per_hour
416     else
417       previous_comments = changeset_comments.limit(200).count
418       max_comments = previous_comments / 200.0 * Settings.max_changeset_comments_per_hour
419       max_comments = max_comments.floor.clamp(Settings.initial_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
420       max_comments /= 2**active_reports
421       max_comments.floor.clamp(Settings.min_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
422     end
423   end
424
425   def deletion_allowed_at
426     unless Settings.user_account_deletion_delay.nil?
427       last_changeset = changesets.reorder(:closed_at => :desc).first
428       return last_changeset.closed_at.utc + Settings.user_account_deletion_delay.hours if last_changeset
429     end
430     creation_time.utc
431   end
432
433   def deletion_allowed?
434     deletion_allowed_at <= Time.now.utc
435   end
436
437   private
438
439   def encrypt_password
440     if pass_crypt_confirmation
441       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
442       self.pass_crypt_confirmation = nil
443     end
444   end
445
446   def update_tile
447     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_location?
448   end
449 end