Specifiy invalid chars in username error message
[rails.git] / app / models / user.rb
1 # == Schema Information
2 #
3 # Table name: users
4 #
5 #  email               :string           not null
6 #  id                  :integer          not null, primary key
7 #  pass_crypt          :string           not null
8 #  creation_time       :datetime         not null
9 #  display_name        :string           default(""), not null
10 #  data_public         :boolean          default(FALSE), not null
11 #  description         :text             default(""), not null
12 #  home_lat            :float
13 #  home_lon            :float
14 #  home_zoom           :integer          default(3)
15 #  nearby              :integer          default(50)
16 #  pass_salt           :string
17 #  image_file_name     :text
18 #  email_valid         :boolean          default(FALSE), not null
19 #  new_email           :string
20 #  creation_ip         :string
21 #  languages           :string
22 #  status              :enum             default("pending"), not null
23 #  terms_agreed        :datetime
24 #  consider_pd         :boolean          default(FALSE), not null
25 #  auth_uid            :string
26 #  preferred_editor    :string
27 #  terms_seen          :boolean          default(FALSE), not null
28 #  description_format  :enum             default("markdown"), not null
29 #  image_fingerprint   :string
30 #  changesets_count    :integer          default(0), not null
31 #  traces_count        :integer          default(0), not null
32 #  diary_entries_count :integer          default(0), not null
33 #  image_use_gravatar  :boolean          default(FALSE), not null
34 #  image_content_type  :string
35 #  auth_provider       :string
36 #  home_tile           :integer
37 #
38 # Indexes
39 #
40 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
41 #  users_display_name_idx        (display_name) UNIQUE
42 #  users_display_name_lower_idx  (lower((display_name)::text))
43 #  users_email_idx               (email) UNIQUE
44 #  users_email_lower_idx         (lower((email)::text))
45 #  users_home_idx                (home_tile)
46 #
47
48 class User < ActiveRecord::Base
49   require "xml/libxml"
50
51   has_many :traces, -> { where(:visible => true) }
52   has_many :diary_entries, -> { order(:created_at => :desc) }
53   has_many :diary_comments, -> { order(:created_at => :desc) }
54   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
55   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
56   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
57   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
58   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
59   has_many :friends, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
60   has_many :friend_users, :through => :friends, :source => :befriendee
61   has_many :tokens, :class_name => "UserToken"
62   has_many :preferences, :class_name => "UserPreference"
63   has_many :changesets, -> { order(:created_at => :desc) }
64   has_many :changeset_comments, :foreign_key => :author_id
65   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
66   has_many :note_comments, :foreign_key => :author_id
67   has_many :notes, :through => :note_comments
68
69   has_many :client_applications
70   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
71
72   has_many :blocks, :class_name => "UserBlock"
73   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
74   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
75
76   has_many :roles, :class_name => "UserRole"
77
78   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
79   has_many :issue_comments
80
81   has_many :reports
82
83   scope :visible, -> { where(:status => %w[pending active confirmed]) }
84   scope :active, -> { where(:status => %w[active confirmed]) }
85   scope :identifiable, -> { where(:data_public => true) }
86
87   has_attached_file :image,
88                     :default_url => "/assets/:class/:attachment/:style.png",
89                     :styles => { :large => "100x100>", :small => "50x50>" }
90
91   INVALID_CHARS = "/;.,?%#"
92
93   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
94                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
95   validates :display_name, :if => proc { |u| u.display_name_changed? },
96                            :uniqueness => { :case_sensitive => false }
97   validates :display_name, :if => proc { |u| u.display_name_changed? },
98                            :format => { :with => %r{\A[^\x00-\x1f\x7f\ufffe\uffff]*\z} }
99   validates :display_name, :if => proc { |u| u.display_name_changed? },
100                            :format => { :with => %r{\A[^#{INVALID_CHARS}]*\z},
101                                         :message => "cannot contain invalid chars: #{INVALID_CHARS}", invalid_chars: INVALID_CHARS }
102   validates :display_name, :if => proc { |u| u.display_name_changed? },
103                            :format => { :with => /\A\S/, :message => "has leading whitespace" }
104   validates :display_name, :if => proc { |u| u.display_name_changed? },
105                            :format => { :with => /\S\z/, :message => "has trailing whitespace" }
106   validates :email, :presence => true, :confirmation => true
107   validates :email, :if => proc { |u| u.email_changed? },
108                     :uniqueness => { :case_sensitive => false }
109   validates :pass_crypt, :confirmation => true, :length => 8..255
110   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
111   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
112   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
113   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
114   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
115   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
116                        :uniqueness => { :scope => :auth_provider }
117
118   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
119   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
120
121   after_initialize :set_defaults
122   before_save :encrypt_password
123   before_save :update_tile
124   after_save :spam_check
125   after_save :reset_preferred_languages
126
127   def to_param
128     display_name
129   end
130
131   def self.authenticate(options)
132     if options[:username] && options[:password]
133       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
134
135       if user.nil?
136         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
137
138         user = users.first if users.count == 1
139       end
140
141       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
142         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
143           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
144           user.save
145         end
146       else
147         user = nil
148       end
149     elsif options[:token]
150       token = UserToken.find_by(:token => options[:token])
151       user = token.user if token
152     end
153
154     if user &&
155        (user.status == "deleted" ||
156          (user.status == "pending" && !options[:pending]) ||
157          (user.status == "suspended" && !options[:suspended]))
158       user = nil
159     end
160
161     token.update(:expiry => 1.week.from_now) if token && user
162
163     user
164   end
165
166   def to_xml
167     doc = OSM::API.new.get_xml_doc
168     doc.root << to_xml_node
169     doc
170   end
171
172   def to_xml_node
173     el1 = XML::Node.new "user"
174     el1["display_name"] = display_name.to_s
175     el1["account_created"] = creation_time.xmlschema
176     if home_lat && home_lon
177       home = XML::Node.new "home"
178       home["lat"] = home_lat.to_s
179       home["lon"] = home_lon.to_s
180       home["zoom"] = home_zoom.to_s
181       el1 << home
182     end
183     el1
184   end
185
186   def description
187     RichText.new(self[:description_format], self[:description])
188   end
189
190   def languages
191     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
192   end
193
194   def languages=(languages)
195     self[:languages] = languages.join(",")
196   end
197
198   def preferred_language
199     languages.find { |l| Language.exists?(:code => l) }
200   end
201
202   def preferred_languages
203     @preferred_languages ||= Locale.list(languages)
204   end
205
206   def reset_preferred_languages
207     @preferred_languages = nil
208   end
209
210   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
211     if home_lon && home_lat
212       gc = OSM::GreatCircle.new(home_lat, home_lon)
213       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
214       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
215       nearby = User.active.identifiable
216                    .where("id != ?", id)
217                    .where(sql_for_area)
218                    .where("#{sql_for_distance} <= ?", radius)
219                    .order(Arel.sql(sql_for_distance))
220                    .limit(num)
221     else
222       nearby = []
223     end
224     nearby
225   end
226
227   def distance(nearby_user)
228     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
229   end
230
231   def is_friends_with?(new_friend)
232     friends.where(:friend_user_id => new_friend.id).exists?
233   end
234
235   ##
236   # returns true if a user is visible
237   def visible?
238     %w[pending active confirmed].include? status
239   end
240
241   ##
242   # returns true if a user is active
243   def active?
244     %w[active confirmed].include? status
245   end
246
247   ##
248   # returns true if the user has the moderator role, false otherwise
249   def moderator?
250     has_role? "moderator"
251   end
252
253   ##
254   # returns true if the user has the administrator role, false otherwise
255   def administrator?
256     has_role? "administrator"
257   end
258
259   ##
260   # returns true if the user has the requested role
261   def has_role?(role)
262     roles.any? { |r| r.role == role }
263   end
264
265   ##
266   # returns the first active block which would require users to view
267   # a message, or nil if there are none.
268   def blocked_on_view
269     blocks.active.detect(&:needs_view?)
270   end
271
272   ##
273   # delete a user - leave the account but purge most personal data
274   def delete
275     self.display_name = "user_#{id}"
276     self.description = ""
277     self.home_lat = nil
278     self.home_lon = nil
279     self.image = nil
280     self.email_valid = false
281     self.new_email = nil
282     self.auth_provider = nil
283     self.auth_uid = nil
284     self.status = "deleted"
285     save
286   end
287
288   ##
289   # return a spam score for a user
290   def spam_score
291     changeset_score = changesets.size * 50
292     trace_score = traces.size * 50
293     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
294     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
295
296     score = description.spam_score / 4.0
297     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
298     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
299     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
300     score -= changeset_score
301     score -= trace_score
302
303     score.to_i
304   end
305
306   ##
307   # perform a spam check on a user
308   def spam_check
309     update(:status => "suspended") if status == "active" && spam_score > SPAM_THRESHOLD
310   end
311
312   ##
313   # return an oauth access token for a specified application
314   def access_token(application_key)
315     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
316   end
317
318   private
319
320   def set_defaults
321     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
322   end
323
324   def encrypt_password
325     if pass_crypt_confirmation
326       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
327       self.pass_crypt_confirmation = nil
328     end
329   end
330
331   def update_tile
332     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
333   end
334 end