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