Merge remote-tracking branch 'openstreetmap/pull/1004'
[rails.git] / app / models / user.rb
1 class User < ActiveRecord::Base
2   require "xml/libxml"
3
4   has_many :traces, -> { where(:visible => true) }
5   has_many :diary_entries, -> { order(:created_at => :desc) }
6   has_many :diary_comments, -> { order(:created_at => :desc) }
7   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
8   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
9   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
10   has_many :friends, -> { joins(:befriendee).where(:users => { :status => %w(active confirmed) }) }
11   has_many :friend_users, :through => :friends, :source => :befriendee
12   has_many :tokens, :class_name => "UserToken"
13   has_many :preferences, :class_name => "UserPreference"
14   has_many :changesets, -> { order(:created_at => :desc) }
15   has_many :changeset_comments, :foreign_key => :author_id
16   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
17   has_many :note_comments, :foreign_key => :author_id
18   has_many :notes, :through => :note_comments
19
20   has_many :client_applications
21   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
22
23   has_many :blocks, :class_name => "UserBlock"
24   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
25   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
26
27   has_many :roles, :class_name => "UserRole"
28
29   scope :visible, -> { where(:status => %w(pending active confirmed)) }
30   scope :active, -> { where(:status => %w(active confirmed)) }
31   scope :identifiable, -> { where(:data_public => true) }
32
33   has_attached_file :image,
34                     :default_url => "/assets/:class/:attachment/:style.png",
35                     :styles => { :large => "100x100>", :small => "50x50>" }
36
37   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
38                            :exclusion => %w(new terms save confirm confirm-email go_public reset-password forgot-password suspended)
39   validates :display_name, :if => proc { |u| u.display_name_changed? },
40                            :uniqueness => { :case_sensitive => false }
41   validates :display_name, :if => proc { |u| u.display_name_changed? },
42                            :format => { :with => %r{\A[^\x00-\x1f\x7f\ufffe\uffff/;.,?%#]*\z} }
43   validates :display_name, :if => proc { |u| u.display_name_changed? },
44                            :format => { :with => /\A\S/, :message => "has leading whitespace" }
45   validates :display_name, :if => proc { |u| u.display_name_changed? },
46                            :format => { :with => /\S\z/, :message => "has trailing whitespace" }
47   validates :email, :presence => true, :confirmation => true
48   validates :email, :if => proc { |u| u.email_changed? },
49                     :uniqueness => { :case_sensitive => false }
50   validates :pass_crypt, :confirmation => true, :length => 8..255
51   validates :home_lat, :home_lon, :allow_nil => true, :numericality => true
52   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
53   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
54   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
55   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
56                        :uniqueness => { :scope => :auth_provider }
57
58   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
59   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
60
61   after_initialize :set_defaults
62   before_save :encrypt_password
63   after_save :spam_check
64
65   def self.authenticate(options)
66     if options[:username] && options[:password]
67       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
68
69       if user.nil?
70         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
71
72         user = users.first if users.count == 1
73       end
74
75       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
76         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
77           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
78           user.save
79         end
80       else
81         user = nil
82       end
83     elsif options[:token]
84       token = UserToken.find_by_token(options[:token])
85       user = token.user if token
86     end
87
88     if user &&
89        (user.status == "deleted" ||
90          (user.status == "pending" && !options[:pending]) ||
91          (user.status == "suspended" && !options[:suspended]))
92       user = nil
93     end
94
95     token.update_column(:expiry, 1.week.from_now) if token && user
96
97     user
98   end
99
100   def to_xml
101     doc = OSM::API.new.get_xml_doc
102     doc.root << to_xml_node
103     doc
104   end
105
106   def to_xml_node
107     el1 = XML::Node.new "user"
108     el1["display_name"] = display_name.to_s
109     el1["account_created"] = creation_time.xmlschema
110     if home_lat && home_lon
111       home = XML::Node.new "home"
112       home["lat"] = home_lat.to_s
113       home["lon"] = home_lon.to_s
114       home["zoom"] = home_zoom.to_s
115       el1 << home
116     end
117     el1
118   end
119
120   def description
121     RichText.new(self[:description_format], self[:description])
122   end
123
124   def languages
125     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
126   end
127
128   def languages=(languages)
129     self[:languages] = languages.join(",")
130   end
131
132   def preferred_language
133     languages.find { |l| Language.exists?(:code => l) }
134   end
135
136   def preferred_languages
137     @locales ||= Locale.list(languages)
138   end
139
140   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
141     if home_lon && home_lat
142       gc = OSM::GreatCircle.new(home_lat, home_lon)
143       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
144       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)
145     else
146       nearby = []
147     end
148     nearby
149   end
150
151   def distance(nearby_user)
152     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
153   end
154
155   def is_friends_with?(new_friend)
156     friends.where(:friend_user_id => new_friend.id).exists?
157   end
158
159   ##
160   # returns true if a user is visible
161   def visible?
162     %w(pending active confirmed).include? status
163   end
164
165   ##
166   # returns true if a user is active
167   def active?
168     %w(active confirmed).include? status
169   end
170
171   ##
172   # returns true if the user has the moderator role, false otherwise
173   def moderator?
174     has_role? "moderator"
175   end
176
177   ##
178   # returns true if the user has the administrator role, false otherwise
179   def administrator?
180     has_role? "administrator"
181   end
182
183   ##
184   # returns true if the user has the requested role
185   def has_role?(role)
186     roles.any? { |r| r.role == role }
187   end
188
189   ##
190   # returns the first active block which would require users to view
191   # a message, or nil if there are none.
192   def blocked_on_view
193     blocks.active.detect(&:needs_view?)
194   end
195
196   ##
197   # delete a user - leave the account but purge most personal data
198   def delete
199     self.display_name = "user_#{id}"
200     self.description = ""
201     self.home_lat = nil
202     self.home_lon = nil
203     self.image = nil
204     self.email_valid = false
205     self.new_email = nil
206     self.auth_provider = nil
207     self.auth_uid = nil
208     self.status = "deleted"
209     save
210   end
211
212   ##
213   # return a spam score for a user
214   def spam_score
215     changeset_score = changesets.size * 50
216     trace_score = traces.size * 50
217     diary_entry_score = diary_entries.inject(0) { |a, e| a + e.body.spam_score }
218     diary_comment_score = diary_comments.inject(0) { |a, e| a + e.body.spam_score }
219
220     score = description.spam_score / 4.0
221     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
222     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
223     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
224     score -= changeset_score
225     score -= trace_score
226
227     score.to_i
228   end
229
230   ##
231   # perform a spam check on a user
232   def spam_check
233     if status == "active" && spam_score > SPAM_THRESHOLD
234       update_column(:status, "suspended")
235     end
236   end
237
238   ##
239   # return an oauth access token for a specified application
240   def access_token(application_key)
241     ClientApplication.find_by_key(application_key).access_token_for_user(self)
242   end
243
244   private
245
246   def set_defaults
247     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
248   end
249
250   def encrypt_password
251     if pass_crypt_confirmation
252       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
253       self.pass_crypt_confirmation = nil
254     end
255   end
256 end