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