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