Merge branch 'master' into moderation
[rails.git] / app / models / user.rb
1 # == Schema Information
2 #
3 # Table name: users
4 #
5 #  email               :string           not null
6 #  id                  :integer          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 #
37 # Indexes
38 #
39 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
40 #  users_display_name_idx        (display_name) UNIQUE
41 #  users_display_name_lower_idx  (lower((display_name)::text))
42 #  users_email_idx               (email) UNIQUE
43 #  users_email_lower_idx         (lower((email)::text))
44 #
45
46 class User < ActiveRecord::Base
47   require "xml/libxml"
48
49   has_many :traces, -> { where(:visible => true) }
50   has_many :diary_entries, -> { order(:created_at => :desc) }
51   has_many :diary_comments, -> { order(:created_at => :desc) }
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 :friends, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
58   has_many :friend_users, :through => :friends, :source => :befriendee
59   has_many :tokens, :class_name => "UserToken"
60   has_many :preferences, :class_name => "UserPreference"
61   has_many :changesets, -> { order(:created_at => :desc) }
62   has_many :changeset_comments, :foreign_key => :author_id
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
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"
69
70   has_many :blocks, :class_name => "UserBlock"
71   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
72   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
73
74   has_many :roles, :class_name => "UserRole"
75
76   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
77   has_one :issue, :class_name => "Issue", :foreign_key => :updated_by
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_attached_file :image,
87                     :default_url => "/assets/:class/:attachment/:style.png",
88                     :styles => { :large => "100x100>", :small => "50x50>" }
89
90   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
91                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
92   validates :display_name, :if => proc { |u| u.display_name_changed? },
93                            :uniqueness => { :case_sensitive => false }
94   validates :display_name, :if => proc { |u| u.display_name_changed? },
95                            :format => { :with => %r{\A[^\x00-\x1f\x7f\ufffe\uffff/;.,?%#]*\z} }
96   validates :display_name, :if => proc { |u| u.display_name_changed? },
97                            :format => { :with => /\A\S/, :message => "has leading whitespace" }
98   validates :display_name, :if => proc { |u| u.display_name_changed? },
99                            :format => { :with => /\S\z/, :message => "has trailing whitespace" }
100   validates :email, :presence => true, :confirmation => true
101   validates :email, :if => proc { |u| u.email_changed? },
102                     :uniqueness => { :case_sensitive => false }
103   validates :pass_crypt, :confirmation => true, :length => 8..255
104   validates :home_lat, :home_lon, :allow_nil => true, :numericality => true
105   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
106   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
107   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
108   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
109                        :uniqueness => { :scope => :auth_provider }
110
111   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
112   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
113
114   after_initialize :set_defaults
115   before_save :encrypt_password
116   after_save :spam_check
117
118   def self.authenticate(options)
119     if options[:username] && options[:password]
120       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
121
122       if user.nil?
123         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
124
125         user = users.first if users.count == 1
126       end
127
128       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
129         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
130           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
131           user.save
132         end
133       else
134         user = nil
135       end
136     elsif options[:token]
137       token = UserToken.find_by(:token => options[:token])
138       user = token.user if token
139     end
140
141     if user &&
142        (user.status == "deleted" ||
143          (user.status == "pending" && !options[:pending]) ||
144          (user.status == "suspended" && !options[:suspended]))
145       user = nil
146     end
147
148     token.update(:expiry => 1.week.from_now) if token && user
149
150     user
151   end
152
153   def to_xml
154     doc = OSM::API.new.get_xml_doc
155     doc.root << to_xml_node
156     doc
157   end
158
159   def to_xml_node
160     el1 = XML::Node.new "user"
161     el1["display_name"] = display_name.to_s
162     el1["account_created"] = creation_time.xmlschema
163     if home_lat && home_lon
164       home = XML::Node.new "home"
165       home["lat"] = home_lat.to_s
166       home["lon"] = home_lon.to_s
167       home["zoom"] = home_zoom.to_s
168       el1 << home
169     end
170     el1
171   end
172
173   def description
174     RichText.new(self[:description_format], self[:description])
175   end
176
177   def languages
178     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
179   end
180
181   def languages=(languages)
182     self[:languages] = languages.join(",")
183   end
184
185   def preferred_language
186     languages.find { |l| Language.exists?(:code => l) }
187   end
188
189   def preferred_languages
190     @locales ||= Locale.list(languages)
191   end
192
193   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
194     if home_lon && home_lat
195       gc = OSM::GreatCircle.new(home_lat, home_lon)
196       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
197       nearby = User.where("id != ? AND status IN (\'active\', \'confirmed\') AND data_public = ? AND #{sql_for_distance} <= ?", id, true, radius).order(sql_for_distance).limit(num)
198     else
199       nearby = []
200     end
201     nearby
202   end
203
204   def distance(nearby_user)
205     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
206   end
207
208   def is_friends_with?(new_friend)
209     friends.where(:friend_user_id => new_friend.id).exists?
210   end
211
212   ##
213   # returns true if a user is visible
214   def visible?
215     %w[pending active confirmed].include? status
216   end
217
218   ##
219   # returns true if a user is active
220   def active?
221     %w[active confirmed].include? status
222   end
223
224   ##
225   # returns true if the user has the moderator role, false otherwise
226   def moderator?
227     has_role? "moderator"
228   end
229
230   ##
231   # returns true if the user has the administrator role, false otherwise
232   def administrator?
233     has_role? "administrator"
234   end
235
236   ##
237   # returns true if the user has the requested role
238   def has_role?(role)
239     roles.any? { |r| r.role == role }
240   end
241
242   ##
243   # returns the first active block which would require users to view
244   # a message, or nil if there are none.
245   def blocked_on_view
246     blocks.active.detect(&:needs_view?)
247   end
248
249   ##
250   # delete a user - leave the account but purge most personal data
251   def delete
252     self.display_name = "user_#{id}"
253     self.description = ""
254     self.home_lat = nil
255     self.home_lon = nil
256     self.image = nil
257     self.email_valid = false
258     self.new_email = nil
259     self.auth_provider = nil
260     self.auth_uid = nil
261     self.status = "deleted"
262     save
263   end
264
265   ##
266   # return a spam score for a user
267   def spam_score
268     changeset_score = changesets.size * 50
269     trace_score = traces.size * 50
270     diary_entry_score = diary_entries.inject(0) { |acc, elem| acc + elem.body.spam_score }
271     diary_comment_score = diary_comments.inject(0) { |acc, elem| acc + elem.body.spam_score }
272
273     score = description.spam_score / 4.0
274     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
275     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
276     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
277     score -= changeset_score
278     score -= trace_score
279
280     score.to_i
281   end
282
283   ##
284   # perform a spam check on a user
285   def spam_check
286     if status == "active" && spam_score > SPAM_THRESHOLD
287       update(:status => "suspended")
288     end
289   end
290
291   ##
292   # return an oauth access token for a specified application
293   def access_token(application_key)
294     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
295   end
296
297   private
298
299   def set_defaults
300     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
301   end
302
303   def encrypt_password
304     if pass_crypt_confirmation
305       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
306       self.pass_crypt_confirmation = nil
307     end
308   end
309 end