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