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