Improve blocks on/by links on user pages
[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
16   has_many :client_applications
17   has_many :oauth_tokens, :class_name => "OauthToken", :order => "authorized_at desc", :include => [:client_application]
18
19   has_many :blocks, :class_name => "UserBlock"
20   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
21   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
22
23   has_many :roles, :class_name => "UserRole"
24
25   scope :visible, where(:status => ["pending", "active", "confirmed"])
26   scope :active, where(:status => ["active", "confirmed"])
27   scope :public, where(:data_public => true)
28
29   validates_presence_of :email, :display_name
30   validates_confirmation_of :email#, :message => ' addresses must match'
31   validates_confirmation_of :pass_crypt#, :message => ' must match the confirmation password'
32   validates_uniqueness_of :display_name, :allow_nil => true, :case_sensitive => false, :if => Proc.new { |u| u.display_name_changed? }
33   validates_uniqueness_of :email, :case_sensitive => false, :if => Proc.new { |u| u.email_changed? }
34   validates_uniqueness_of :openid_url, :allow_nil => true
35   validates_length_of :pass_crypt, :within => 8..255
36   validates_length_of :display_name, :within => 3..255, :allow_nil => true
37   validates_email_format_of :email, :if => Proc.new { |u| u.email_changed? }
38   validates_email_format_of :new_email, :allow_blank => true, :if => Proc.new { |u| u.new_email_changed? }
39   validates_format_of :display_name, :with => /^[^\/;.,?%#]*$/, :if => Proc.new { |u| u.display_name_changed? }
40   validates_format_of :display_name, :with => /^\S/, :message => "has leading whitespace", :if => Proc.new { |u| u.display_name_changed? }
41   validates_format_of :display_name, :with => /\S$/, :message => "has trailing whitespace", :if => Proc.new { |u| u.display_name_changed? }
42   validates_numericality_of :home_lat, :allow_nil => true
43   validates_numericality_of :home_lon, :allow_nil => true
44   validates_numericality_of :home_zoom, :only_integer => true, :allow_nil => true
45   validates_inclusion_of :preferred_editor, :in => Editors::ALL_EDITORS, :allow_nil => true
46
47   attr_accessible :display_name, :email, :email_confirmation, :openid_url,
48                   :pass_crypt, :pass_crypt_confirmation, :consider_pd
49
50   after_initialize :set_defaults
51   before_save :encrypt_password
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       user = nil if user and user.pass_crypt != OSM::encrypt_password(options[:password], user.pass_salt)
70     elsif options[:token]
71       token = UserToken.find_by_token(options[:token])
72       user = token.user if token
73     end
74
75     if user and
76       ( user.status == "deleted" or
77         ( user.status == "pending" and not options[:pending] ) or
78         ( user.status == "suspended" and not options[:suspended] ) )
79       user = nil
80     end
81
82     token.update_column(:expiry, 1.week.from_now) if token and user
83
84     return user
85   end 
86
87   def to_xml
88     doc = OSM::API.new.get_xml_doc
89     doc.root << to_xml_node()
90     return doc
91   end
92
93   def to_xml_node
94     el1 = XML::Node.new 'user'
95     el1['display_name'] = self.display_name.to_s
96     el1['account_created'] = self.creation_time.xmlschema
97     if self.home_lat and self.home_lon
98       home = XML::Node.new 'home'
99       home['lat'] = self.home_lat.to_s
100       home['lon'] = self.home_lon.to_s
101       home['zoom'] = self.home_zoom.to_s
102       el1 << home
103     end
104     return el1
105   end
106
107   def description
108     RichText.new(read_attribute(:description_format), read_attribute(:description))
109   end
110
111   def languages
112     attribute_present?(:languages) ? read_attribute(:languages).split(/ *, */) : []
113   end
114
115   def languages=(languages)
116     write_attribute(:languages, languages.join(","))
117   end
118
119   def preferred_language
120     languages.find { |l| Language.exists?(:code => l) }
121   end
122
123   def preferred_language_from(array)
124     (languages & array.collect { |i| i.to_s }).first
125   end
126
127   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
128     if self.home_lon and self.home_lat 
129       gc = OSM::GreatCircle.new(self.home_lat, self.home_lon)
130       bounds = gc.bounds(radius)
131       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
132       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)
133     else
134       nearby = []
135     end
136     return nearby
137   end
138
139   def distance(nearby_user)
140     return OSM::GreatCircle.new(self.home_lat, self.home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
141   end
142
143   def is_friends_with?(new_friend)
144     res = false
145     @new_friend = new_friend
146     self.friends.each do |friend|
147       if friend.friend_user_id == @new_friend.id
148         return true
149       end
150     end
151     return false
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.status = "deleted"
202     self.save
203   end
204
205   ##
206   # return a spam score for a user
207   def spam_score
208     changeset_score = self.changesets.limit(10).length * 50
209     trace_score = self.traces.limit(10).length * 50
210     diary_entry_score = self.diary_entries.inject(0) { |s,e| s += e.body.spam_score }
211     diary_comment_score = self.diary_comments.inject(0) { |s,c| s += c.body.spam_score }
212
213     score = self.description.spam_score / 4.0
214     score += diary_entry_score / self.diary_entries.length if self.diary_entries.length > 0
215     score += diary_comment_score / self.diary_comments.length if self.diary_comments.length > 0
216     score -= changeset_score
217     score -= trace_score
218
219     return score.to_i
220   end
221
222   ##
223   # return an oauth access token for a specified application
224   def access_token(application_key)
225     return ClientApplication.find_by_key(application_key).access_token_for_user(self)
226   end
227
228 private
229
230   def set_defaults
231     self.creation_time = Time.now.getutc unless self.attribute_present?(:creation_time)
232     self.description_format = "markdown" unless self.attribute_present?(:description_format)
233   end
234
235   def encrypt_password
236     if pass_crypt_confirmation
237       self.pass_salt = OSM::make_token(8)
238       self.pass_crypt = OSM::encrypt_password(pass_crypt, pass_salt)
239       self.pass_crypt_confirmation = nil
240     end
241   end
242 end