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