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