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