Merge branch 'master' into moderation
[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   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
92                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
93   validates :display_name, :if => proc { |u| u.display_name_changed? },
94                            :uniqueness => { :case_sensitive => false }
95   validates :display_name, :if => proc { |u| u.display_name_changed? },
96                            :format => { :with => %r{\A[^\x00-\x1f\x7f\ufffe\uffff/;.,?%#]*\z} }
97   validates :display_name, :if => proc { |u| u.display_name_changed? },
98                            :format => { :with => /\A\S/, :message => "has leading whitespace" }
99   validates :display_name, :if => proc { |u| u.display_name_changed? },
100                            :format => { :with => /\S\z/, :message => "has trailing whitespace" }
101   validates :email, :presence => true, :confirmation => true
102   validates :email, :if => proc { |u| u.email_changed? },
103                     :uniqueness => { :case_sensitive => false }
104   validates :pass_crypt, :confirmation => true, :length => 8..255
105   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
106   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
107   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
108   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
109   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
110   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
111                        :uniqueness => { :scope => :auth_provider }
112
113   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
114   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
115
116   after_initialize :set_defaults
117   before_save :encrypt_password
118   before_save :update_tile
119   after_save :spam_check
120
121   def to_param
122     display_name
123   end
124
125   def self.authenticate(options)
126     if options[:username] && options[:password]
127       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
128
129       if user.nil?
130         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
131
132         user = users.first if users.count == 1
133       end
134
135       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
136         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
137           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
138           user.save
139         end
140       else
141         user = nil
142       end
143     elsif options[:token]
144       token = UserToken.find_by(:token => options[:token])
145       user = token.user if token
146     end
147
148     if user &&
149        (user.status == "deleted" ||
150          (user.status == "pending" && !options[:pending]) ||
151          (user.status == "suspended" && !options[:suspended]))
152       user = nil
153     end
154
155     token.update(:expiry => 1.week.from_now) if token && user
156
157     user
158   end
159
160   def to_xml
161     doc = OSM::API.new.get_xml_doc
162     doc.root << to_xml_node
163     doc
164   end
165
166   def to_xml_node
167     el1 = XML::Node.new "user"
168     el1["display_name"] = display_name.to_s
169     el1["account_created"] = creation_time.xmlschema
170     if home_lat && home_lon
171       home = XML::Node.new "home"
172       home["lat"] = home_lat.to_s
173       home["lon"] = home_lon.to_s
174       home["zoom"] = home_zoom.to_s
175       el1 << home
176     end
177     el1
178   end
179
180   def description
181     RichText.new(self[:description_format], self[:description])
182   end
183
184   def languages
185     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
186   end
187
188   def languages=(languages)
189     self[:languages] = languages.join(",")
190   end
191
192   def preferred_language
193     languages.find { |l| Language.exists?(:code => l) }
194   end
195
196   def preferred_languages
197     @preferred_languages ||= Locale.list(languages)
198   end
199
200   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
201     if home_lon && home_lat
202       gc = OSM::GreatCircle.new(home_lat, home_lon)
203       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
204       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
205       nearby = User.active.identifiable
206                    .where("id != ?", id)
207                    .where(sql_for_area)
208                    .where("#{sql_for_distance} <= ?", radius)
209                    .order(sql_for_distance)
210                    .limit(num)
211     else
212       nearby = []
213     end
214     nearby
215   end
216
217   def distance(nearby_user)
218     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
219   end
220
221   def is_friends_with?(new_friend)
222     friends.where(:friend_user_id => new_friend.id).exists?
223   end
224
225   ##
226   # returns true if a user is visible
227   def visible?
228     %w[pending active confirmed].include? status
229   end
230
231   ##
232   # returns true if a user is active
233   def active?
234     %w[active confirmed].include? status
235   end
236
237   ##
238   # returns true if the user has the moderator role, false otherwise
239   def moderator?
240     has_role? "moderator"
241   end
242
243   ##
244   # returns true if the user has the administrator role, false otherwise
245   def administrator?
246     has_role? "administrator"
247   end
248
249   ##
250   # returns true if the user has the requested role
251   def has_role?(role)
252     roles.any? { |r| r.role == role }
253   end
254
255   ##
256   # returns the first active block which would require users to view
257   # a message, or nil if there are none.
258   def blocked_on_view
259     blocks.active.detect(&:needs_view?)
260   end
261
262   ##
263   # delete a user - leave the account but purge most personal data
264   def delete
265     self.display_name = "user_#{id}"
266     self.description = ""
267     self.home_lat = nil
268     self.home_lon = nil
269     self.image = nil
270     self.email_valid = false
271     self.new_email = nil
272     self.auth_provider = nil
273     self.auth_uid = nil
274     self.status = "deleted"
275     save
276   end
277
278   ##
279   # return a spam score for a user
280   def spam_score
281     changeset_score = changesets.size * 50
282     trace_score = traces.size * 50
283     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
284     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
285
286     score = description.spam_score / 4.0
287     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
288     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
289     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
290     score -= changeset_score
291     score -= trace_score
292
293     score.to_i
294   end
295
296   ##
297   # perform a spam check on a user
298   def spam_check
299     update(:status => "suspended") if status == "active" && spam_score > SPAM_THRESHOLD
300   end
301
302   ##
303   # return an oauth access token for a specified application
304   def access_token(application_key)
305     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
306   end
307
308   private
309
310   def set_defaults
311     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
312   end
313
314   def encrypt_password
315     if pass_crypt_confirmation
316       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
317       self.pass_crypt_confirmation = nil
318     end
319   end
320
321   def update_tile
322     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
323   end
324 end