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