Combine the address and netmask for an ACL in one column
[rails.git] / app / controllers / user_controller.rb
1 class UserController < ApplicationController
2   layout :choose_layout
3
4   skip_before_filter :verify_authenticity_token, :only => [:api_details, :api_gpx_files]
5   before_filter :disable_terms_redirect, :only => [:terms, :save, :logout, :api_details]
6   before_filter :authorize, :only => [:api_details, :api_gpx_files]
7   before_filter :authorize_web, :except => [:api_details, :api_gpx_files]
8   before_filter :set_locale, :except => [:api_details, :api_gpx_files]
9   before_filter :require_user, :only => [:account, :go_public, :make_friend, :remove_friend]
10   before_filter :check_database_readable, :except => [:api_details, :api_gpx_files]
11   before_filter :check_database_writable, :only => [:login, :new, :account, :go_public, :make_friend, :remove_friend]
12   before_filter :check_api_readable, :only => [:api_details, :api_gpx_files]
13   before_filter :require_allow_read_prefs, :only => [:api_details]
14   before_filter :require_allow_read_gpx, :only => [:api_gpx_files]
15   before_filter :require_cookies, :only => [:login, :confirm]
16   before_filter :require_administrator, :only => [:set_status, :delete, :list]
17   before_filter :lookup_this_user, :only => [:set_status, :delete]
18
19   cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete]
20
21   def terms
22     @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || DEFAULT_LEGALE
23     @text = OSM.legal_text_for_country(@legale)
24
25     if request.xhr?
26       render :partial => "terms"
27     elsif using_open_id?
28       # The redirect from the OpenID provider reenters here
29       # again and we need to pass the parameters through to
30       # the open_id_authentication function
31       @user = session.delete(:new_user)
32
33       openid_verify(nil, @user) do |user|
34       end
35
36       if @user.openid_url.nil? or @user.invalid?
37         render :action => 'new'
38       else
39         render :action => 'terms'
40       end
41     else
42       session[:referer] = params[:referer]
43
44       @title = t 'user.terms.title'
45       @user = User.new(params[:user]) if params[:user]
46
47       if params[:user] and params[:user][:openid_url] and @user.pass_crypt.empty?
48         # We are creating an account with OpenID and no password
49         # was specified so create a random one
50         @user.pass_crypt = SecureRandom.base64(16) 
51         @user.pass_crypt_confirmation = @user.pass_crypt 
52       end
53
54       if @user
55         if @user.invalid?
56           if @user.new_record?
57             # Something is wrong with a new user, so rerender the form
58             render :action => :new
59           else
60             # Error in existing user, so go to account settings
61             flash[:errors] = @user.errors
62             redirect_to :action => :account, :display_name => @user.display_name
63           end
64         elsif @user.terms_agreed?
65           # Already agreed to terms, so just show settings
66           redirect_to :action => :account, :display_name => @user.display_name
67         elsif params[:user] and params[:user][:openid_url] and not params[:user][:openid_url].empty?
68           # Verify OpenID before moving on
69           session[:new_user] = @user
70           openid_verify(params[:user][:openid_url], @user)
71         end
72       else
73         # Not logged in, so redirect to the login page
74         redirect_to :action => :login, :referer => request.fullpath
75       end
76     end
77   end
78
79   def save
80     @title = t 'user.new.title'
81
82     if Acl.address(request.remote_ip).where(:k => "no_account_creation").exists?
83       render :action => 'new'
84     elsif params[:decline]
85       if @user
86         @user.terms_seen = true
87
88         if @user.save
89           flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
90         end
91
92         if params[:referer]
93           redirect_to params[:referer]
94         else
95           redirect_to :action => :account, :display_name => @user.display_name
96         end
97       else
98         redirect_to t('user.terms.declined')
99       end
100     elsif @user
101       if !@user.terms_agreed?
102         @user.consider_pd = params[:user][:consider_pd]
103         @user.terms_agreed = Time.now.getutc
104         @user.terms_seen = true
105         if @user.save
106           flash[:notice] = t 'user.new.terms accepted'
107         end
108       end
109
110       if params[:referer]
111         redirect_to params[:referer]
112       else
113         redirect_to :action => :account, :display_name => @user.display_name
114       end
115     else
116       @user = User.new(params[:user])
117
118       @user.status = "pending"
119       @user.data_public = true
120       @user.description = "" if @user.description.nil?
121       @user.creation_ip = request.remote_ip
122       @user.languages = request.user_preferred_languages
123       @user.terms_agreed = Time.now.getutc
124       @user.terms_seen = true
125       @user.openid_url = nil if @user.openid_url and @user.openid_url.empty?
126       
127       if @user.save
128         flash[:piwik_goal] = PIWIK_SIGNUP_GOAL if defined?(PIWIK_SIGNUP_GOAL)
129         flash[:notice] = t 'user.new.flash create success message', :email => @user.email
130         Notifier.signup_confirm(@user, @user.tokens.create(:referer => session.delete(:referer))).deliver
131         session[:token] = @user.tokens.create.token
132         redirect_to :action => 'login', :referer => params[:referer]
133       else
134         render :action => 'new', :referer => params[:referer]
135       end
136     end
137   end
138
139   def account
140     @title = t 'user.account.title'
141     @tokens = @user.oauth_tokens.authorized
142
143     if params[:user] and params[:user][:display_name] and params[:user][:description]
144       @user.display_name = params[:user][:display_name]
145       @user.new_email = params[:user][:new_email]
146
147       if params[:user][:pass_crypt].length > 0 or params[:user][:pass_crypt_confirmation].length > 0
148         @user.pass_crypt = params[:user][:pass_crypt]
149         @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
150       end
151
152       @user.description = params[:user][:description]
153       @user.languages = params[:user][:languages].split(",")
154
155       case params[:image_action]
156         when "new" then @user.image = params[:user][:image]
157         when "delete" then @user.image = nil
158       end
159
160       @user.home_lat = params[:user][:home_lat]
161       @user.home_lon = params[:user][:home_lon]
162
163       if params[:user][:preferred_editor] == "default"
164         @user.preferred_editor = nil
165       else
166         @user.preferred_editor = params[:user][:preferred_editor]
167       end
168
169       @user.openid_url = nil if params[:user][:openid_url].blank?
170
171       if params[:user][:openid_url] and
172          params[:user][:openid_url].length > 0 and
173          params[:user][:openid_url] != @user.openid_url
174         # If the OpenID has changed, we want to check that it is a
175         # valid OpenID and one the user has control over before saving
176         # it as a password equivalent for the user.
177         session[:new_user] = @user
178         openid_verify(params[:user][:openid_url], @user)
179       else
180         update_user(@user)
181       end
182     elsif using_open_id?
183       # The redirect from the OpenID provider reenters here
184       # again and we need to pass the parameters through to
185       # the open_id_authentication function
186       @user = session.delete(:new_user)
187       openid_verify(nil, @user) do |user|
188         update_user(user)
189       end
190     end
191   end
192
193   def go_public
194     @user.data_public = true
195     @user.save
196     flash[:notice] = t 'user.go_public.flash success'
197     redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
198   end
199
200   def lost_password
201     @title = t 'user.lost_password.title'
202
203     if params[:user] and params[:user][:email]
204       user = User.visible.find_by_email(params[:user][:email])
205
206       if user.nil?
207         users = User.visible.where("LOWER(email) = LOWER(?)", params[:user][:email])
208
209         if users.count == 1
210           user = users.first
211         end
212       end
213
214       if user
215         token = user.tokens.create
216         Notifier.lost_password(user, token).deliver
217         flash[:notice] = t 'user.lost_password.notice email on way'
218         redirect_to :action => 'login'
219       else
220         flash.now[:error] = t 'user.lost_password.notice email cannot find'
221       end
222     end
223   end
224
225   def reset_password
226     @title = t 'user.reset_password.title'
227
228     if params[:token]
229       token = UserToken.find_by_token(params[:token])
230
231       if token
232         @user = token.user
233
234         if params[:user]
235           @user.pass_crypt = params[:user][:pass_crypt]
236           @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
237           @user.status = "active" if @user.status == "pending"
238           @user.email_valid = true
239
240           if @user.save
241             token.destroy
242             flash[:notice] = t 'user.reset_password.flash changed'
243             redirect_to :action => 'login'
244           end
245         end
246       else
247         flash[:error] = t 'user.reset_password.flash token bad'
248         redirect_to :action => 'lost_password'
249       end
250     end
251   end
252
253   def new
254     @title = t 'user.new.title'
255     @referer = params[:referer] || session[:referer]
256
257     if @user
258       # The user is logged in already, so don't show them the signup
259       # page, instead send them to the home page
260       if @referer
261         redirect_to @referer
262       else
263         redirect_to :controller => 'site', :action => 'index'
264       end
265     elsif params.key?(:openid)
266       @user = User.new(:email => params[:email],
267                        :email_confirmation => params[:email],
268                        :display_name => params[:nickname],
269                        :openid_url => params[:openid])
270
271       flash.now[:notice] = t 'user.new.openid association'
272     end
273   end
274
275   def login
276     if params[:username] or using_open_id?
277       session[:remember_me] ||= params[:remember_me]
278       session[:referer] ||= params[:referer]
279
280       if using_open_id?
281         openid_authentication(params[:openid_url])
282       else
283         password_authentication(params[:username], params[:password])
284       end
285     elsif params[:notice]
286       flash.now[:notice] = t "user.login.notice_#{params[:notice]}"
287     elsif flash[:notice].nil?
288       flash.now[:notice] =  t 'user.login.notice'
289     end
290   end
291
292   def logout
293     @title = t 'user.logout.title'
294
295     if params[:session] == request.session_options[:id]
296       if session[:token]
297         token = UserToken.find_by_token(session[:token])
298         if token
299           token.destroy
300         end
301         session.delete(:token)
302       end
303       session.delete(:user)
304       session_expires_automatically
305       if params[:referer]
306         redirect_to params[:referer]
307       else
308         redirect_to :controller => 'site', :action => 'index'
309       end
310     end
311   end
312
313   def confirm
314     if request.post?
315       if token = UserToken.find_by_token(params[:confirm_string])
316         if token.user.active?
317           flash[:error] = t('user.confirm.already active')
318           redirect_to :action => 'login'
319         else
320           user = token.user
321           user.status = "active"
322           user.email_valid = true
323           user.save!
324           referer = token.referer
325           token.destroy
326
327           if session[:token] 
328             token = UserToken.find_by_token(session[:token])
329             session.delete(:token)
330           else
331             token = nil
332           end
333
334           if token.nil? or token.user != user
335             flash[:notice] = t('user.confirm.success')
336             redirect_to :action => :login, :referer => referer
337           else
338             token.destroy
339
340             session[:user] = user.id
341             cookies.permanent["_osm_username"] = user.display_name
342
343             if referer.nil?
344               flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
345               redirect_to :action => :account, :display_name => user.display_name
346             else
347               flash[:notice] = t('user.confirm.success')
348               redirect_to referer
349             end
350           end
351         end
352       else
353         user = User.find_by_display_name(params[:display_name])
354
355         if user and user.active?
356           flash[:error] = t('user.confirm.already active')
357         elsif user
358           flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
359         else
360           flash[:error] = t('user.confirm.unknown token')
361         end
362
363         redirect_to :action => 'login'
364       end
365     end
366   end
367
368   def confirm_resend
369     if user = User.find_by_display_name(params[:display_name])
370       Notifier.signup_confirm(user, user.tokens.create).deliver
371       flash[:notice] = t 'user.confirm_resend.success', :email => user.email
372     else
373       flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
374     end
375
376     redirect_to :action => 'login'
377   end
378
379   def confirm_email
380     if request.post?
381       token = UserToken.find_by_token(params[:confirm_string])
382       if token and token.user.new_email?
383         @user = token.user
384         @user.email = @user.new_email
385         @user.new_email = nil
386         @user.email_valid = true
387         if @user.save
388           flash[:notice] = t 'user.confirm_email.success'
389         else
390           flash[:errors] = @user.errors
391         end
392         token.destroy
393         session[:user] = @user.id
394         cookies.permanent["_osm_username"] = @user.display_name
395         redirect_to :action => 'account', :display_name => @user.display_name
396       else
397         flash[:error] = t 'user.confirm_email.failure'
398         redirect_to :action => 'account', :display_name => @user.display_name
399       end
400     end
401   end
402
403   def api_gpx_files
404     doc = OSM::API.new.get_xml_doc
405     @user.traces.each do |trace|
406       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
407     end
408     render :text => doc.to_s, :content_type => "text/xml"
409   end
410
411   def view
412     @this_user = User.find_by_display_name(params[:display_name])
413
414     if @this_user and
415        (@this_user.visible? or (@user and @user.administrator?))
416       @title = @this_user.display_name
417     else
418       @title = t 'user.no_such_user.title'
419       @not_found_user = params[:display_name]
420       render :action => 'no_such_user', :status => :not_found
421     end
422   end
423
424   def make_friend
425     if params[:display_name]
426       name = params[:display_name]
427       new_friend = User.active.where(:display_name => name).first
428       friend = Friend.new
429       friend.user_id = @user.id
430       friend.friend_user_id = new_friend.id
431       unless @user.is_friends_with?(new_friend)
432         if friend.save
433           flash[:notice] = t 'user.make_friend.success', :name => name
434           Notifier.friend_notification(friend).deliver
435         else
436           friend.add_error(t('user.make_friend.failed', :name => name))
437         end
438       else
439         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
440       end
441
442       if params[:referer]
443         redirect_to params[:referer]
444       else
445         redirect_to :controller => 'user', :action => 'view'
446       end
447     end
448   end
449
450   def remove_friend
451     if params[:display_name]
452       name = params[:display_name]
453       friend = User.active.where(:display_name => name).first
454       if @user.is_friends_with?(friend)
455         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
456         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
457       else
458         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
459       end
460
461       if params[:referer]
462         redirect_to params[:referer]
463       else
464         redirect_to :controller => 'user', :action => 'view'
465       end
466     end
467   end
468
469   ##
470   # sets a user's status
471   def set_status
472     @this_user.update_attributes(:status => params[:status])
473     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
474   end
475
476   ##
477   # delete a user, marking them as deleted and removing personal data
478   def delete
479     @this_user.delete
480     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
481   end
482
483   ##
484   # display a list of users matching specified criteria
485   def list
486     if request.post?
487       ids = params[:user].keys.collect { |id| id.to_i }
488
489       User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
490       User.update_all("status = 'deleted'", :id => ids) if params[:hide]
491
492       redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
493     else
494       conditions = Hash.new
495       conditions[:status] = params[:status] if params[:status]
496       conditions[:creation_ip] = params[:ip] if params[:ip]
497
498       @user_pages, @users = paginate(:users,
499                                      :conditions => conditions,
500                                      :order => :id,
501                                      :per_page => 50)
502     end
503   end
504
505 private
506
507   ##
508   # handle password authentication
509   def password_authentication(username, password)
510     if user = User.authenticate(:username => username, :password => password)
511       successful_login(user)
512     elsif user = User.authenticate(:username => username, :password => password, :pending => true)
513       failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
514     elsif User.authenticate(:username => username, :password => password, :suspended => true)
515       failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
516     else
517       failed_login t('user.login.auth failure')
518     end
519   end
520
521   ##
522   # handle OpenID authentication
523   def openid_authentication(openid_url)
524     # If we don't appear to have a user for this URL then ask the
525     # provider for some extra information to help with signup
526     if openid_url and User.find_by_openid_url(openid_url)
527       required = nil
528     else
529       required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
530     end
531
532     # Start the authentication
533     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => required) do |result, identity_url, sreg, ax|
534       if result.successful?
535         # We need to use the openid url passed back from the OpenID provider
536         # rather than the one supplied by the user, as these can be different.
537         #
538         # For example, you can simply enter yahoo.com in the login box rather
539         # than a user specific url. Only once it comes back from the provider
540         # provider do we know the unique address for the user.
541         if user = User.find_by_openid_url(identity_url)
542           case user.status
543             when "pending" then
544               failed_login t('user.login.account not active')
545             when "active", "confirmed" then
546               successful_login(user)
547             when "suspended" then
548               failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
549             else
550               failed_login t('user.login.auth failure')
551           end
552         else
553           # Guard against not getting any extension data
554           sreg = Hash.new if sreg.nil?
555           ax = Hash.new if ax.nil?
556
557           # We don't have a user registered to this OpenID, so redirect
558           # to the create account page with username and email filled
559           # in if they have been given by the OpenID provider through
560           # the simple registration protocol.
561           nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"]
562           email = sreg["email"] || ax["http://axschema.org/contact/email"]
563           redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
564         end
565       elsif result.missing?
566         failed_login t('user.login.openid missing provider')
567       elsif result.invalid?
568         failed_login t('user.login.openid invalid')
569       else
570         failed_login t('user.login.auth failure')
571       end
572     end
573   end
574
575   ##
576   # verify an OpenID URL
577   def openid_verify(openid_url, user)
578     user.openid_url = openid_url
579
580     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get) do |result, identity_url|
581       if result.successful?
582         # We need to use the openid url passed back from the OpenID provider
583         # rather than the one supplied by the user, as these can be different.
584         #
585         # For example, you can simply enter yahoo.com in the login box rather
586         # than a user specific url. Only once it comes back from the provider
587         # provider do we know the unique address for the user.
588         user.openid_url = identity_url
589         yield user
590       elsif result.missing?
591         flash.now[:error] = t 'user.login.openid missing provider'
592       elsif result.invalid?
593         flash.now[:error] = t 'user.login.openid invalid'
594       else
595         flash.now[:error] = t 'user.login.auth failure'
596       end
597     end
598   end
599
600   ##
601   # special case some common OpenID providers by applying heuristics to
602   # try and come up with the correct URL based on what the user entered
603   def openid_expand_url(openid_url)
604     if openid_url.nil?
605       return nil
606     elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
607       # Special case gmail.com as it is potentially a popular OpenID
608       # provider and, unlike yahoo.com, where it works automatically, Google
609       # have hidden their OpenID endpoint somewhere obscure this making it
610       # somewhat less user friendly.
611       return 'https://www.google.com/accounts/o8/id'
612     else
613       return openid_url
614     end
615   end  
616
617   ##
618   # process a successful login
619   def successful_login(user)
620     cookies.permanent["_osm_username"] = user.display_name
621
622     session[:user] = user.id
623     session_expires_after 1.month if session[:remember_me]
624
625     target = session[:referer] || url_for(:controller => :site, :action => :index)
626
627     # The user is logged in, so decide where to send them:
628     #
629     # - If they haven't seen the contributor terms, send them there.
630     # - If they have a block on them, show them that.
631     # - If they were referred to the login, send them back there.
632     # - Otherwise, send them to the home page.
633     if REQUIRE_TERMS_SEEN and not user.terms_seen
634       redirect_to :controller => :user, :action => :terms, :referer => target
635     elsif user.blocked_on_view
636       redirect_to user.blocked_on_view, :referer => target
637     else
638       redirect_to target
639     end
640
641     session.delete(:remember_me)
642     session.delete(:referer)
643   end
644
645   ##
646   # process a failed login
647   def failed_login(message)
648     flash[:error] = message
649
650     redirect_to :action => 'login', :referer =>  session[:referer]
651
652     session.delete(:remember_me)
653     session.delete(:referer)
654   end
655
656   ##
657   # update a user's details
658   def update_user(user)
659     if user.save
660       set_locale
661
662       if user.new_email.blank?
663         flash.now[:notice] = t 'user.account.flash update success'
664       else
665         user.email = user.new_email
666
667         if user.valid?
668           flash.now[:notice] = t 'user.account.flash update success confirm needed'
669
670           begin
671             Notifier.email_confirm(user, user.tokens.create).deliver
672           rescue
673             # Ignore errors sending email
674           end
675         else
676           @user.errors.set(:new_email, @user.errors.get(:email))
677           @user.errors.set(:email, [])
678         end
679
680         user.reset_email!
681       end
682     end
683   end
684
685   ##
686   # require that the user is a administrator, or fill out a helpful error message
687   # and return them to the user page.
688   def require_administrator
689     if @user and not @user.administrator?
690       flash[:error] = t('user.filter.not_an_administrator')
691
692       if params[:display_name]
693         redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
694       else
695         redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
696       end
697     elsif not @user
698       redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
699     end
700   end
701
702   ##
703   # ensure that there is a "this_user" instance variable
704   def lookup_this_user
705     @this_user = User.find_by_display_name(params[:display_name])
706   rescue ActiveRecord::RecordNotFound
707     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
708   end
709
710   ##
711   # Choose the layout to use. See
712   # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
713   def choose_layout
714     oauth_url = url_for(:controller => :oauth, :action => :oauthorize, :only_path => true)
715
716     if [ 'api_details' ].include? action_name
717       nil
718     elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
719       'slim'
720     else
721       'site'
722     end
723   end
724
725   ##
726   #
727   def disable_terms_redirect
728     # this is necessary otherwise going to the user terms page, when 
729     # having not agreed already would cause an infinite redirect loop.
730     # it's .now so that this doesn't propagate to other pages.
731     flash.now[:skip_terms] = true
732   end
733 end