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