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