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