Reject leading and trailing whitespace in display names
[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'
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'
10   has_many :friends, :include => :befriendee, :conditions => "users.status IN ('active', 'confirmed')"
11   has_many :tokens, :class_name => "UserToken"
12   has_many :preferences, :class_name => "UserPreference"
13   has_many :changesets
14
15   has_many :client_applications
16   has_many :oauth_tokens, :class_name => "OauthToken", :order => "authorized_at desc", :include => [:client_application]
17
18   has_many :active_blocks, :class_name => "UserBlock", :conditions => ['user_blocks.ends_at > \'#{Time.now.getutc.xmlschema(5)}\' or user_blocks.needs_view']
19   has_many :roles, :class_name => "UserRole"
20
21   validates_presence_of :email, :display_name
22   validates_confirmation_of :email#, :message => ' addresses must match'
23   validates_confirmation_of :pass_crypt#, :message => ' must match the confirmation password'
24   validates_uniqueness_of :display_name, :allow_nil => true
25   validates_uniqueness_of :email
26   validates_length_of :pass_crypt, :within => 8..255
27   validates_length_of :display_name, :within => 3..255, :allow_nil => true
28   validates_email_format_of :email
29   validates_email_format_of :new_email, :allow_blank => true
30   validates_format_of :display_name, :with => /^[^\/;.,?]*$/
31   validates_format_of :display_name, :with => /^\S/, :message => "has leading whitespace"
32   validates_format_of :display_name, :with => /\S$/, :message => "has trailing whitespace"
33   validates_numericality_of :home_lat, :allow_nil => true
34   validates_numericality_of :home_lon, :allow_nil => true
35   validates_numericality_of :home_zoom, :only_integer => true, :allow_nil => true
36
37   before_save :encrypt_password
38
39   file_column :image, :magick => { :geometry => "100x100>" }
40
41   def after_initialize
42     self.creation_time = Time.now.getutc unless self.attribute_present?(:creation_time)
43   end
44
45   def encrypt_password
46     if pass_crypt_confirmation
47       self.pass_salt = OSM::make_token(8)
48       self.pass_crypt = OSM::encrypt_password(pass_crypt, pass_salt)
49     end
50   end
51
52   def self.authenticate(options)
53     if options[:username] and options[:password]
54       user = find(:first, :conditions => ["email = ? OR display_name = ?", options[:username], options[:username]])
55       user = nil if user and user.pass_crypt != OSM::encrypt_password(options[:password], user.pass_salt)
56     elsif options[:token]
57       token = UserToken.find(:first, :include => :user, :conditions => ["user_tokens.token = ?", options[:token]])
58       user = token.user if token
59     end
60
61     if user and
62       ( user.status == "deleted" or
63         ( user.status == "pending" and not options[:pending] ) or
64         ( user.status == "suspended" and not options[:suspended] ) )
65       user = nil
66     end
67
68     token.update_attribute(:expiry, 1.week.from_now) if token and user
69
70     return user
71   end 
72
73   def to_xml
74     doc = OSM::API.new.get_xml_doc
75     doc.root << to_xml_node()
76     return doc
77   end
78
79   def to_xml_node
80     el1 = XML::Node.new 'user'
81     el1['display_name'] = self.display_name.to_s
82     el1['account_created'] = self.creation_time.xmlschema
83     if self.home_lat and self.home_lon
84       home = XML::Node.new 'home'
85       home['lat'] = self.home_lat.to_s
86       home['lon'] = self.home_lon.to_s
87       home['zoom'] = self.home_zoom.to_s
88       el1 << home
89     end
90     return el1
91   end
92
93   def languages
94     attribute_present?(:languages) ? read_attribute(:languages).split(/ *, */) : []
95   end
96
97   def languages=(languages)
98     write_attribute(:languages, languages.join(","))
99   end
100
101   def preferred_language
102     languages.find { |l| Language.find(:first, :conditions => { :code => l }) }
103   end
104
105   def preferred_language_from(array)
106     (languages & array.collect { |i| i.to_s }).first
107   end
108
109   def nearby(radius = 50, num = 10)
110     if self.home_lon and self.home_lat 
111       gc = OSM::GreatCircle.new(self.home_lat, self.home_lon)
112       bounds = gc.bounds(radius)
113       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
114       nearby = User.find(:all, 
115                          :conditions => ["id != ? AND status IN (\'active\', \'confirmed\') AND data_public = ? AND #{sql_for_distance} <= ?", id, true, radius],
116                          :order => sql_for_distance, :limit => num)
117     else
118       nearby = []
119     end
120     return nearby
121   end
122
123   def distance(nearby_user)
124     return OSM::GreatCircle.new(self.home_lat, self.home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
125   end
126
127   def is_friends_with?(new_friend)
128     res = false
129     @new_friend = new_friend
130     self.friends.each do |friend|
131       if friend.friend_user_id == @new_friend.id
132         return true
133       end
134     end
135     return false
136   end
137
138   ##
139   # returns true if a user is visible
140   def visible?
141     ["pending","active","confirmed"].include? self.status
142   end
143
144   ##
145   # returns true if a user is active
146   def active?
147     ["active","confirmed"].include? self.status
148   end
149
150   ##
151   # returns true if the user has the moderator role, false otherwise
152   def moderator?
153     has_role? 'moderator'
154   end
155
156   ##
157   # returns true if the user has the administrator role, false otherwise
158   def administrator?
159     has_role? 'administrator'
160   end
161
162   ##
163   # returns true if the user has the requested role
164   def has_role?(role)
165     roles.any? { |r| r.role == role }
166   end
167
168   ##
169   # returns the first active block which would require users to view 
170   # a message, or nil if there are none.
171   def blocked_on_view
172     active_blocks.detect { |b| b.needs_view? }
173   end
174
175   ##
176   # delete a user - leave the account but purge most personal data
177   def delete
178     self.display_name = "user_#{self.id}"
179     self.description = ""
180     self.home_lat = nil
181     self.home_lon = nil
182     self.image = nil
183     self.email_valid = false
184     self.new_email = nil
185     self.status = "deleted"
186     self.save
187   end
188
189   ##
190   # return a spam score for a user
191   def spam_score
192     changeset_score = self.changesets.find(:all, :limit => 10).length * 50
193     trace_score = self.traces.find(:all, :limit => 10).length * 50
194     diary_entry_score = self.diary_entries.inject(0) { |s,e| s += OSM.spam_score(e.body) }
195     diary_comment_score = self.diary_comments.inject(0) { |s,e| s += OSM.spam_score(e.body) }
196
197     score = OSM.spam_score(self.description) * 2
198     score += diary_entry_score / self.diary_entries.length if self.diary_entries.length > 0
199     score += diary_comment_score / self.diary_comments.length if self.diary_comments.length > 0
200     score -= changeset_score
201     score -= trace_score
202
203     return score.to_i
204   end
205 end