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