Merge remote-tracking branch 'upstream/pull/2890'
[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 :blocks, :class_name => "UserBlock"
72   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
73   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
74
75   has_many :roles, :class_name => "UserRole"
76
77   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
78   has_many :issue_comments
79
80   has_many :reports
81
82   scope :visible, -> { where(:status => %w[pending active confirmed]) }
83   scope :active, -> { where(:status => %w[active confirmed]) }
84   scope :identifiable, -> { where(:data_public => true) }
85
86   has_one_attached :avatar
87
88   validates :display_name, :presence => true, :length => 3..255,
89                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
90   validates :display_name, :if => proc { |u| u.display_name_changed? },
91                            :uniqueness => { :case_sensitive => false }
92   validates :display_name, :if => proc { |u| u.display_name_changed? },
93                            :characters => { :url_safe => true },
94                            :whitespace => { :leading => false, :trailing => false }
95   validates :email, :presence => true, :confirmation => true, :characters => true
96   validates :email, :if => proc { |u| u.email_changed? },
97                     :uniqueness => { :case_sensitive => false }
98   validates :email, :if => proc { |u| u.email_changed? },
99                     :whitespace => { :leading => false, :trailing => false }
100   validates :pass_crypt, :confirmation => true, :length => 8..255
101   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
102   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
103   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
104   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
105   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
106                        :uniqueness => { :scope => :auth_provider }
107
108   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
109   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
110
111   after_initialize :set_defaults
112   before_save :encrypt_password
113   before_save :update_tile
114   after_save :spam_check
115   after_save :reset_preferred_languages
116
117   def to_param
118     display_name
119   end
120
121   def self.authenticate(options)
122     if options[:username] && options[:password]
123       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
124
125       if user.nil?
126         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])
127
128         user = users.first if users.count == 1
129       end
130
131       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
132         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
133           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
134           user.save
135         end
136       else
137         user = nil
138       end
139     elsif options[:token]
140       token = UserToken.find_by(:token => options[:token])
141       user = token.user if token
142     end
143
144     if user &&
145        (user.status == "deleted" ||
146          (user.status == "pending" && !options[:pending]) ||
147          (user.status == "suspended" && !options[:suspended]))
148       user = nil
149     end
150
151     token.update(:expiry => 1.week.from_now) if token && user
152
153     user
154   end
155
156   def to_xml
157     doc = OSM::API.new.get_xml_doc
158     doc.root << to_xml_node
159     doc
160   end
161
162   def to_xml_node
163     el1 = XML::Node.new "user"
164     el1["display_name"] = display_name.to_s
165     el1["account_created"] = creation_time.xmlschema
166     if home_lat && home_lon
167       home = XML::Node.new "home"
168       home["lat"] = home_lat.to_s
169       home["lon"] = home_lon.to_s
170       home["zoom"] = home_zoom.to_s
171       el1 << home
172     end
173     el1
174   end
175
176   def description
177     RichText.new(self[:description_format], self[:description])
178   end
179
180   def languages
181     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
182   end
183
184   def languages=(languages)
185     self[:languages] = languages.join(",")
186   end
187
188   def preferred_language
189     languages.find { |l| Language.exists?(:code => l) }
190   end
191
192   def preferred_languages
193     @preferred_languages ||= Locale.list(languages)
194   end
195
196   def reset_preferred_languages
197     @preferred_languages = nil
198   end
199
200   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
201     if home_lon && home_lat
202       gc = OSM::GreatCircle.new(home_lat, home_lon)
203       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
204       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
205       nearby = User.active.identifiable
206                    .where.not(:id => id)
207                    .where(sql_for_area)
208                    .where("#{sql_for_distance} <= ?", radius)
209                    .order(Arel.sql(sql_for_distance))
210                    .limit(num)
211     else
212       nearby = []
213     end
214     nearby
215   end
216
217   def distance(nearby_user)
218     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
219   end
220
221   def is_friends_with?(new_friend)
222     friendships.exists?(:befriendee => new_friend)
223   end
224
225   ##
226   # returns true if a user is visible
227   def visible?
228     %w[pending active confirmed].include? status
229   end
230
231   ##
232   # returns true if a user is active
233   def active?
234     %w[active confirmed].include? status
235   end
236
237   ##
238   # returns true if the user has the moderator role, false otherwise
239   def moderator?
240     has_role? "moderator"
241   end
242
243   ##
244   # returns true if the user has the administrator role, false otherwise
245   def administrator?
246     has_role? "administrator"
247   end
248
249   ##
250   # returns true if the user has the requested role
251   def has_role?(role)
252     roles.any? { |r| r.role == role }
253   end
254
255   ##
256   # returns the first active block which would require users to view
257   # a message, or nil if there are none.
258   def blocked_on_view
259     blocks.active.detect(&:needs_view?)
260   end
261
262   ##
263   # delete a user - leave the account but purge most personal data
264   def delete
265     avatar.purge_later
266
267     self.display_name = "user_#{id}"
268     self.description = ""
269     self.home_lat = nil
270     self.home_lon = nil
271     self.email_valid = false
272     self.new_email = nil
273     self.auth_provider = nil
274     self.auth_uid = nil
275     self.status = "deleted"
276
277     save
278   end
279
280   ##
281   # return a spam score for a user
282   def spam_score
283     changeset_score = changesets.size * 50
284     trace_score = traces.size * 50
285     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
286     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
287
288     score = description.spam_score / 4.0
289     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
290     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
291     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
292     score -= changeset_score
293     score -= trace_score
294
295     score.to_i
296   end
297
298   ##
299   # perform a spam check on a user
300   def spam_check
301     update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
302   end
303
304   ##
305   # return an oauth access token for a specified application
306   def access_token(application_key)
307     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
308   end
309
310   def fingerprint
311     digest = Digest::SHA256.new
312     digest.update(email)
313     digest.update(pass_crypt)
314     digest.hexdigest
315   end
316
317   private
318
319   def set_defaults
320     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
321   end
322
323   def encrypt_password
324     if pass_crypt_confirmation
325       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
326       self.pass_crypt_confirmation = nil
327     end
328   end
329
330   def update_tile
331     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
332   end
333 end