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