app/controllers/user_controller.rb

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