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