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