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