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 => [:activate, :deactivate, :hide, :unhide, :delete]
  15   before_filter :lookup_this_user, :only => [:activate, :deactivate, :hide, :unhide, :delete]
  16
  17   filter_parameter_logging :password, :pass_crypt, :pass_crypt_confirmation
  18
  19   cache_sweeper :user_sweeper, :only => [:account, :hide, :unhide, :delete]
  20
  21   def save
  22     @title = t 'user.new.title'
  23
  24     if Acl.find_by_address(request.remote_ip, :conditions => {:k => "no_account_creation"})
  25       render :action => 'new'
  26     else
  27       #The redirect from the OpenID provider reenters here again
  28       #and we need to pass the parameters through to the
  29       #open_id_authentication function a second time
  30       if params[:open_id_complete]
  31         openid_verify('', true)
  32         #We have set the user.openid_url to nil beforehand. If it hasn't
  33         #been set to a new valid openid_url, it means the openid couldn't be validated
  34         if @user.nil? or @user.openid_url.nil?
  35           render :action => 'new'
  36           return
  37         end
  38       else
  39       @user = User.new(params[:user])
  40
  41       @user.visible = true
  42       @user.data_public = true
  43       @user.description = "" if @user.description.nil?
  44       @user.creation_ip = request.remote_ip
  45       @user.languages = request.user_preferred_languages
  46         #Set the openid_url to nil as for one it is used
  47         #to check if the openid could be validated and secondly
  48         #to not get dupplicate conflicts for an empty openid
  49         @user.openid_url = nil
  50
  51         if (!params[:user][:openid_url].nil? and params[:user][:openid_url].length > 0)
  52           if @user.pass_crypt.length == 0
  53             #if the password is empty, but we have a openid
  54             #then generate a random passowrd to disable
  55             #loging in via password
  56             @user.pass_crypt = ActiveSupport::SecureRandom.base64(16)
  57             @user.pass_crypt_confirmation = @user.pass_crypt
  58           end
  59           #Validate all of the other fields before
  60           #redirecting to the openid provider
  61           if !@user.valid?
  62             render :action => 'new'
  63           else
  64             #TODO: Is it a problem to store the user variable with respect to password safty in the session variables?
  65             #Store the user variable in the session for it to be accessible when redirecting back from the openid provider
  66             session[:new_usr] = @user
  67             begin
  68               @norm_openid_url = OpenIdAuthentication.normalize_identifier(params[:user][:openid_url])
  69             rescue
  70               flash.now[:error] = t 'user.login.openid invalid'
  71               render :action => 'new'
  72               return
  73             end
  74             #Verify that the openid provided is valid and that the user is the owner of the id
  75             openid_verify(@norm_openid_url, true)
  76             #openid_verify can return in two ways:
  77             #Either it returns with a redirect to the openid provider who then freshly
  78             #redirects back to this url if the openid is valid, or if the openid is not plausible
  79             #and no provider for it could be found it just returns
  80             #we want to just let the redirect through
  81             if response.headers["Location"].nil?
  82               render :action => 'new'
  83             end
  84           end
  85           #At this point there was either an error and the page has been rendered,
  86           #or there is a redirect to the openid provider and the rest of the method
  87           #gets executed whenn this method gets reentered after redirecting back
  88           #from the openid provider
  89           return
  90         end
  91       end
  92
  93       if @user.save
  94         flash[:notice] = t 'user.new.flash create success message'
  95         Notifier.deliver_signup_confirm(@user, @user.tokens.create(:referer => params[:referer]))
  96         redirect_to :action => 'login'
  97       else
  98         render :action => 'new'
  99       end
 100     end
 101   end
 102
 103   def account
 104     @title = t 'user.account.title'
 105     @tokens = @user.oauth_tokens.find :all, :conditions => 'oauth_tokens.invalidated_at is null and oauth_tokens.authorized_at is not null'
 106
 107     #The redirect from the OpenID provider reenters here again
 108     #and we need to pass the parameters through to the
 109     #open_id_authentication function
 110     if params[:open_id_complete]
 111       openid_verify('', false)
 112       @user.save
 113       return
 114     end
 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       if @user.save
 137         set_locale
 138
 139         if @user.new_email.nil? or @user.new_email.empty?
 140           flash.now[:notice] = t 'user.account.flash update success'
 141         else
 142           flash.now[:notice] = t 'user.account.flash update success confirm needed'
 143
 144           begin
 145             Notifier.deliver_email_confirm(@user, @user.tokens.create)
 146           rescue
 147             # Ignore errors sending email
 148           end
 149         end
 150       end
 151
 152       if (params[:user][:openid_url].length > 0)
 153         begin
 154           @norm_openid_url = OpenIdAuthentication.normalize_identifier(params[:user][:openid_url])
 155           if (@norm_openid_url != @user.openid_url)
 156             #If the OpenID has changed, we want to check that it is a valid OpenID and one
 157             #the user has control over before saving the openID as a password equivalent for
 158             #the user.
 159             openid_verify(@norm_openid_url, false)
 160           end
 161         rescue
 162           flash.now[:error] = t 'user.login.openid invalid'
 163         end
 164       end
 165
 166     else
 167       if flash[:errors]
 168         flash[:errors].each do |attr,msg|
 169           attr = "new_email" if attr == "email"
 170           @user.errors.add(attr,msg)
 171         end
 172       end
 173     end
 174   end
 175
 176   def openid_specialcase_mapping(openid_url)
 177     #Special case gmail.com, as it is pontentially a popular OpenID provider and unlike
 178     #yahoo.com, where it works automatically, Google have hidden their OpenID endpoint
 179     #somewhere obscure making it less userfriendly.
 180     if (openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/) )
 181       return 'https://www.google.com/accounts/o8/id'
 182     end
 183
 184     return nil
 185   end
 186
 187   def openid_verify(openid_url,account_create)
 188     authenticate_with_open_id(openid_url) do |result, identity_url|
 189       if result.successful?
 190         #We need to use the openid url passed back from the OpenID provider
 191         #rather than the one supplied by the user, as these can be different.
 192         #e.g. one can simply enter yahoo.com in the login box, i.e. no user specific url
 193         #only once it comes back from the OpenID provider do we know the unique address for
 194         #the user.
 195         @user = session[:new_usr] unless @user #this is used for account creation when the user is not yet in the database
 196         @user.openid_url = identity_url
 197       elsif result.missing?
 198         mapped_id = openid_specialcase_mapping(openid_url)
 199         if mapped_id
 200           openid_verify(mapped_id, account_create)
 201         else
 202           flash.now[:error] = t 'user.login.openid missing provider'
 203         end
 204       elsif result.invalid?
 205         flash.now[:error] = t 'user.login.openid invalid'
 206       else
 207         flash.now[:error] = t 'user.login.auth failure'
 208       end
 209     end
 210   end
 211
 212   def open_id_authentication(openid_url)
 213     #TODO: only ask for nickname and email, if we don't already have a user for that openID, in which case
 214     #email and nickname are already filled out. I don't know how to do that with ruby syntax though, as we
 215     #don't want to duplicate the do block
 216     #On the other hand it also doesn't matter too much if we ask every time, as the OpenID provider should
 217     #remember these results, and shouldn't repromt the user for these data each time.
 218     user = nil
 219     authenticate_with_open_id(openid_url, :return_to => request.protocol + request.host_with_port + '/login?referer=' + params[:referer], :optional => [:nickname, :email]) do |result, identity_url, registration|
 220       if result.successful?
 221         #We need to use the openid url passed back from the OpenID provider
 222         #rather than the one supplied by the user, as these can be different.
 223         #e.g. one can simply enter yahoo.com in the login box, i.e. no user specific url
 224         #only once it comes back from the OpenID provider do we know the unique address for
 225         #the user.
 226         user = User.find_by_openid_url(identity_url)
 227         if user
 228           if user.visible? and user.active?
 229             session[:user] = user.id
 230             session_expires_after 1.month if session[:remember]
 231             return user
 232           else
 233             user = nil
 234             flash.now[:error] = t 'user.login.account not active'
 235           end
 236         else
 237           #We don't have a user registered to this OpenID. Redirect to the create account page
 238           #with username and email filled in if they have been given by the OpenID provider through
 239           #the simple registration protocol
 240           redirect_to :controller => 'user', :action => 'new', :nickname => registration['nickname'], :email => registration['email'], :openid => identity_url
 241         end
 242       else if result.missing?
 243              #Try and apply some heuristics to make common cases more userfriendly
 244              mapped_id = openid_specialcase_mapping(openid_url)
 245              if mapped_id
 246                open_id_authentication(mapped_id)
 247              else
 248                flash.now[:error] = t 'user.login.openid missing provider'
 249              end
 250            else if result.invalid?
 251                   flash.now[:error] = t 'user.login.openid invalid'
 252                 else
 253                   flash.now[:error] = t 'user.login.auth failure'
 254                 end
 255            end
 256       end
 257     end
 258     return user
 259   end
 260
 261   def go_public
 262     @user.data_public = true
 263     @user.save
 264     flash[:notice] = t 'user.go_public.flash success'
 265     redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
 266   end
 267
 268   def lost_password
 269     @title = t 'user.lost_password.title'
 270
 271     if params[:user] and params[:user][:email]
 272       user = User.find_by_email(params[:user][:email], :conditions => {:visible => true})
 273
 274       if user
 275         token = user.tokens.create
 276         Notifier.deliver_lost_password(user, token)
 277         flash[:notice] = t 'user.lost_password.notice email on way'
 278         redirect_to :action => 'login'
 279       else
 280         flash.now[:error] = t 'user.lost_password.notice email cannot find'
 281       end
 282     end
 283   end
 284
 285   def reset_password
 286     @title = t 'user.reset_password.title'
 287
 288     if params[:token]
 289       token = UserToken.find_by_token(params[:token])
 290
 291       if token
 292         @user = token.user
 293
 294         if params[:user]
 295           @user.pass_crypt = params[:user][:pass_crypt]
 296           @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
 297           @user.active = true
 298           @user.email_valid = true
 299
 300           if @user.save
 301             token.destroy
 302             flash[:notice] = t 'user.reset_password.flash changed'
 303             redirect_to :action => 'login'
 304           end
 305         end
 306       else
 307         flash[:error] = t 'user.reset_password.flash token bad'
 308         redirect_to :action => 'lost_password'
 309       end
 310     end
 311   end
 312
 313   def new
 314     @title = t 'user.new.title'
 315
 316     # The user is logged in already, so don't show them the signup
 317     # page, instead send them to the home page
 318     redirect_to :controller => 'site', :action => 'index' if session[:user]
 319
 320     @nickname = params['nickname']
 321     @email = params['email']
 322     @openID = params['openid']
 323   end
 324
 325   def login
 326     @title = t 'user.login.title'
 327
 328     #The redirect from the OpenID provider reenters here again
 329     #and we need to pass the parameters through to the
 330     # open_id_authentication function
 331     if params[:open_id_complete]
 332       user = open_id_authentication('')
 333     elsif params[:user]
 334       if !params[:user][:openid_url].nil? and !params[:user][:openid_url].empty?
 335         session[:remember] = params[:remember_me]
 336         #construct the openid request. This will redirect to the OpenID server to ask for validation
 337         #The external OpenID server will then redirect back to the login method and reenters at the top
 338         open_id_authentication(params[:user][:openid_url])
 339         return
 340       else
 341         email_or_display_name = params[:user][:email]
 342         pass = params[:user][:password]
 343
 344         if user = User.authenticate(:username => email_or_display_name, :password => pass)
 345           session[:user] = user.id
 346           session_expires_after 1.month if params[:remember_me]
 347         elsif User.authenticate(:username => email_or_display_name, :password => pass, :inactive => true)
 348           flash.now[:error] = t 'user.login.account not active'
 349         else
 350           flash.now[:error] = t 'user.login.auth failure'
 351         end
 352       end
 353     end
 354
 355     if user
 356       # The user is logged in, if the referer param exists, redirect
 357       # them to that unless they've also got a block on them, in
 358       # which case redirect them to the block so they can clear it.
 359       if user.blocked_on_view
 360         redirect_to user.blocked_on_view, :referrer => params[:referrer]
 361       elsif params[:referer]
 362         redirect_to params[:referer]
 363       else
 364         redirect_to :controller => 'site', :action => 'index'
 365       end
 366     end
 367   end
 368
 369   def logout
 370     @title = t 'user.logout.title'
 371
 372     if params[:session] == request.session_options[:id]
 373       if session[:token]
 374         token = UserToken.find_by_token(session[:token])
 375         if token
 376           token.destroy
 377         end
 378         session[:token] = nil
 379       end
 380       session[:user] = nil
 381       session_expires_automatically
 382       if params[:referer]
 383         redirect_to params[:referer]
 384       else
 385         redirect_to :controller => 'site', :action => 'index'
 386       end
 387     end
 388   end
 389
 390   def confirm
 391     if params[:confirm_action]
 392       token = UserToken.find_by_token(params[:confirm_string])
 393       if token and !token.user.active?
 394         @user = token.user
 395         @user.active = true
 396         @user.email_valid = true
 397         @user.save!
 398         referer = token.referer
 399         token.destroy
 400         flash[:notice] = t 'user.confirm.success'
 401         session[:user] = @user.id
 402         unless referer.nil?
 403           redirect_to referer
 404         else
 405           redirect_to :action => 'account', :display_name => @user.display_name
 406         end
 407       else
 408         flash.now[:error] = t 'user.confirm.failure'
 409       end
 410     end
 411   end
 412
 413   def confirm_email
 414     if params[:confirm_action]
 415       token = UserToken.find_by_token(params[:confirm_string])
 416       if token and token.user.new_email?
 417         @user = token.user
 418         @user.email = @user.new_email
 419         @user.new_email = nil
 420         @user.active = true
 421         @user.email_valid = true
 422         if @user.save
 423           flash[:notice] = t 'user.confirm_email.success'
 424         else
 425           flash[:errors] = @user.errors
 426         end
 427         token.destroy
 428         session[:user] = @user.id
 429         redirect_to :action => 'account', :display_name => @user.display_name
 430       else
 431         flash.now[:error] = t 'user.confirm_email.failure'
 432       end
 433     end
 434   end
 435
 436   def api_gpx_files
 437     doc = OSM::API.new.get_xml_doc
 438     @user.traces.each do |trace|
 439       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
 440     end
 441     render :text => doc.to_s, :content_type => "text/xml"
 442   end
 443
 444   def view
 445     @this_user = User.find_by_display_name(params[:display_name])
 446
 447     if @this_user and
 448        (@this_user.visible? or (@user and @user.administrator?))
 449       @title = @this_user.display_name
 450     else
 451       @title = t 'user.no_such_user.title'
 452       @not_found_user = params[:display_name]
 453       render :action => 'no_such_user', :status => :not_found
 454     end
 455   end
 456
 457   def make_friend
 458     if params[:display_name]
 459       name = params[:display_name]
 460       new_friend = User.find_by_display_name(name, :conditions => {:visible => true})
 461       friend = Friend.new
 462       friend.user_id = @user.id
 463       friend.friend_user_id = new_friend.id
 464       unless @user.is_friends_with?(new_friend)
 465         if friend.save
 466           flash[:notice] = t 'user.make_friend.success', :name => name
 467           Notifier.deliver_friend_notification(friend)
 468         else
 469           friend.add_error(t('user.make_friend.failed', :name => name))
 470         end
 471       else
 472         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
 473       end
 474
 475       if params[:referer]
 476         redirect_to params[:referer]
 477       else
 478         redirect_to :controller => 'user', :action => 'view'
 479       end
 480     end
 481   end
 482
 483   def remove_friend
 484     if params[:display_name]
 485       name = params[:display_name]
 486       friend = User.find_by_display_name(name, :conditions => {:visible => true})
 487       if @user.is_friends_with?(friend)
 488         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
 489         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
 490       else
 491         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
 492       end
 493
 494       if params[:referer]
 495         redirect_to params[:referer]
 496       else
 497         redirect_to :controller => 'user', :action => 'view'
 498       end
 499     end
 500   end
 501
 502   ##
 503   # activate a user, allowing them to log in
 504   def activate
 505     @this_user.update_attributes(:active => true)
 506     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 507   end
 508
 509   ##
 510   # deactivate a user, preventing them from logging in
 511   def deactivate
 512     @this_user.update_attributes(:active => false)
 513     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 514   end
 515
 516   ##
 517   # hide a user, marking them as logically deleted
 518   def hide
 519     @this_user.update_attributes(:visible => false)
 520     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 521   end
 522
 523   ##
 524   # unhide a user, clearing the logically deleted flag
 525   def unhide
 526     @this_user.update_attributes(:visible => true)
 527     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 528   end
 529
 530   ##
 531   # delete a user, marking them as deleted and removing personal data
 532   def delete
 533     @this_user.delete
 534     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 535   end
 536 private
 537   ##
 538   # require that the user is a administrator, or fill out a helpful error message
 539   # and return them to the user page.
 540   def require_administrator
 541     unless @user.administrator?
 542       flash[:error] = t('user.filter.not_an_administrator')
 543       redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
 544     end
 545   end
 546
 547   ##
 548   # ensure that there is a "this_user" instance variable
 549   def lookup_this_user
 550     @this_user = User.find_by_display_name(params[:display_name])
 551   rescue ActiveRecord::RecordNotFound
 552     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
 553   end
 554 end