app/controllers/user_controller.rb

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