Chris@441: # Redmine - project management software Chris@1115: # Copyright (C) 2006-2012 Jean-Philippe Lang Chris@0: # Chris@0: # This program is free software; you can redistribute it and/or Chris@0: # modify it under the terms of the GNU General Public License Chris@0: # as published by the Free Software Foundation; either version 2 Chris@0: # of the License, or (at your option) any later version. Chris@441: # Chris@0: # This program is distributed in the hope that it will be useful, Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@0: # GNU General Public License for more details. Chris@441: # Chris@0: # You should have received a copy of the GNU General Public License Chris@0: # along with this program; if not, write to the Free Software Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@0: Chris@0: require 'uri' Chris@0: require 'cgi' Chris@0: Chris@507: class Unauthorized < Exception; end Chris@507: Chris@0: class ApplicationController < ActionController::Base Chris@0: include Redmine::I18n Chris@0: Chris@1115: class_attribute :accept_api_auth_actions Chris@1115: class_attribute :accept_rss_auth_actions Chris@1115: class_attribute :model_object Chris@1115: Chris@0: layout 'base' Chris@441: Chris@909: protect_from_forgery Chris@909: def handle_unverified_request Chris@909: super Chris@909: cookies.delete(:autologin) Chris@909: end Chris@441: Chris@1115: before_filter :session_expiration, :user_setup, :check_if_login_required, :set_localization Chris@441: Chris@0: rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token Chris@507: rescue_from ::Unauthorized, :with => :deny_access Chris@1115: rescue_from ::ActionView::MissingTemplate, :with => :missing_template Chris@441: Chris@0: include Redmine::Search::Controller Chris@0: include Redmine::MenuManager::MenuController Chris@0: helper Redmine::MenuManager::MenuHelper Chris@441: Chris@1115: def session_expiration Chris@1115: if session[:user_id] Chris@1115: if session_expired? && !try_to_autologin Chris@1115: reset_session Chris@1115: flash[:error] = l(:error_session_expired) Chris@1115: redirect_to signin_url Chris@1115: else Chris@1115: session[:atime] = Time.now.utc.to_i Chris@1115: end Chris@1115: end Chris@1115: end Chris@1115: Chris@1115: def session_expired? Chris@1115: if Setting.session_lifetime? Chris@1115: unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60) Chris@1115: return true Chris@1115: end Chris@1115: end Chris@1115: if Setting.session_timeout? Chris@1115: unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60) Chris@1115: return true Chris@1115: end Chris@1115: end Chris@1115: false Chris@1115: end Chris@1115: Chris@1115: def start_user_session(user) Chris@1115: session[:user_id] = user.id Chris@1115: session[:ctime] = Time.now.utc.to_i Chris@1115: session[:atime] = Time.now.utc.to_i Chris@0: end Chris@0: Chris@0: def user_setup Chris@0: # Check the settings cache for each request Chris@0: Setting.check_cache Chris@0: # Find the current user Chris@0: User.current = find_current_user Chris@1115: logger.info(" Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger Chris@0: end Chris@441: Chris@0: # Returns the current user or nil if no user is logged in Chris@0: # and starts a session if needed Chris@0: def find_current_user Chris@1115: user = nil Chris@1115: unless api_request? Chris@1115: if session[:user_id] Chris@1115: # existing session Chris@1115: user = (User.active.find(session[:user_id]) rescue nil) Chris@1115: elsif autologin_user = try_to_autologin Chris@1115: user = autologin_user Chris@1115: elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth? Chris@1115: # RSS key authentication does not start a session Chris@1115: user = User.find_by_rss_key(params[:key]) Chris@1115: end Chris@1115: end Chris@1115: if user.nil? && Setting.rest_api_enabled? && accept_api_auth? Chris@507: if (key = api_key_from_request) Chris@0: # Use API key Chris@1115: user = User.find_by_api_key(key) Chris@0: else Chris@0: # HTTP Basic, either username/password or API key/random Chris@0: authenticate_with_http_basic do |username, password| Chris@1115: user = User.try_to_login(username, password) || User.find_by_api_key(username) Chris@0: end Chris@0: end Chris@1115: # Switch user if requested by an admin user Chris@1115: if user && user.admin? && (username = api_switch_user_from_request) Chris@1115: su = User.find_by_login(username) Chris@1115: if su && su.active? Chris@1115: logger.info(" User switched by: #{user.login} (id=#{user.id})") if logger Chris@1115: user = su Chris@1115: else Chris@1115: render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412 Chris@1115: end Chris@1115: end Chris@1115: end Chris@1115: user Chris@1115: end Chris@1115: Chris@1115: def try_to_autologin Chris@1115: if cookies[:autologin] && Setting.autologin? Chris@1115: # auto-login feature starts a new session Chris@1115: user = User.try_to_autologin(cookies[:autologin]) Chris@1115: if user Chris@1115: reset_session Chris@1115: start_user_session(user) Chris@1115: end Chris@1115: user Chris@0: end Chris@0: end Chris@0: Chris@0: # Sets the logged in user Chris@0: def logged_user=(user) Chris@0: reset_session Chris@0: if user && user.is_a?(User) Chris@0: User.current = user Chris@1115: start_user_session(user) Chris@0: else Chris@0: User.current = User.anonymous Chris@0: end Chris@0: end Chris@441: Chris@1115: # Logs out current user Chris@1115: def logout_user Chris@1115: if User.current.logged? Chris@1115: cookies.delete :autologin Chris@1115: Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin']) Chris@1115: self.logged_user = nil Chris@1115: end Chris@1115: end Chris@1115: Chris@0: # check if login is globally required to access the application Chris@0: def check_if_login_required Chris@0: # no check needed if user is already logged in Chris@0: return true if User.current.logged? Chris@0: require_login if Setting.login_required? Chris@441: end Chris@441: Chris@0: def set_localization Chris@0: lang = nil Chris@0: if User.current.logged? Chris@0: lang = find_language(User.current.language) Chris@0: end Chris@0: if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE'] Chris@0: accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first Chris@0: if !accept_lang.blank? Chris@0: accept_lang = accept_lang.downcase Chris@0: lang = find_language(accept_lang) || find_language(accept_lang.split('-').first) Chris@0: end Chris@0: end Chris@0: lang ||= Setting.default_language Chris@0: set_language_if_valid(lang) Chris@0: end Chris@441: Chris@0: def require_login Chris@0: if !User.current.logged? Chris@0: # Extract only the basic url parameters on non-GET requests Chris@0: if request.get? Chris@0: url = url_for(params) Chris@0: else Chris@0: url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id]) Chris@0: end Chris@0: respond_to do |format| Chris@0: format.html { redirect_to :controller => "account", :action => "login", :back_url => url } Chris@0: format.atom { redirect_to :controller => "account", :action => "login", :back_url => url } Chris@0: format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } Chris@0: format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } Chris@0: format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } Chris@0: end Chris@0: return false Chris@0: end Chris@0: true Chris@0: end Chris@0: Chris@0: def require_admin Chris@0: return unless require_login Chris@0: if !User.current.admin? Chris@0: render_403 Chris@0: return false Chris@0: end Chris@0: true Chris@0: end Chris@441: Chris@0: def deny_access Chris@0: User.current.logged? ? render_403 : require_login Chris@0: end Chris@0: Chris@0: # Authorize the user for the requested action Chris@0: def authorize(ctrl = params[:controller], action = params[:action], global = false) chris@37: allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global) chris@37: if allowed chris@37: true chris@37: else chris@37: if @project && @project.archived? chris@37: render_403 :message => :notice_not_authorized_archived_project chris@37: else chris@37: deny_access chris@37: end chris@37: end Chris@0: end Chris@0: Chris@0: # Authorize the user for the requested action outside a project Chris@0: def authorize_global(ctrl = params[:controller], action = params[:action], global = true) Chris@0: authorize(ctrl, action, global) Chris@0: end Chris@0: Chris@0: # Find project of id params[:id] Chris@0: def find_project Chris@0: @project = Project.find(params[:id]) Chris@0: rescue ActiveRecord::RecordNotFound Chris@0: render_404 Chris@0: end Chris@0: chris@22: # Find project of id params[:project_id] chris@22: def find_project_by_project_id chris@22: @project = Project.find(params[:project_id]) chris@22: rescue ActiveRecord::RecordNotFound chris@22: render_404 chris@22: end chris@22: Chris@0: # Find a project based on params[:project_id] Chris@0: # TODO: some subclasses override this, see about merging their logic Chris@0: def find_optional_project Chris@0: @project = Project.find(params[:project_id]) unless params[:project_id].blank? Chris@0: allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true) Chris@0: allowed ? true : deny_access Chris@0: rescue ActiveRecord::RecordNotFound Chris@0: render_404 Chris@0: end Chris@0: Chris@0: # Finds and sets @project based on @object.project Chris@0: def find_project_from_association Chris@0: render_404 unless @object.present? Chris@441: Chris@0: @project = @object.project Chris@0: end Chris@0: Chris@0: def find_model_object Chris@1115: model = self.class.model_object Chris@0: if model Chris@0: @object = model.find(params[:id]) Chris@0: self.instance_variable_set('@' + controller_name.singularize, @object) if @object Chris@0: end Chris@0: rescue ActiveRecord::RecordNotFound Chris@0: render_404 Chris@0: end Chris@0: Chris@0: def self.model_object(model) Chris@1115: self.model_object = model Chris@0: end Chris@14: Chris@1115: # Find the issue whose id is the :id parameter Chris@1115: # Raises a Unauthorized exception if the issue is not visible Chris@1115: def find_issue Chris@1115: # Issue.visible.find(...) can not be used to redirect user to the login form Chris@1115: # if the issue actually exists but requires authentication Chris@1115: @issue = Issue.find(params[:id]) Chris@1115: raise Unauthorized unless @issue.visible? Chris@1115: @project = @issue.project Chris@1115: rescue ActiveRecord::RecordNotFound Chris@1115: render_404 Chris@1115: end Chris@1115: Chris@1115: # Find issues with a single :id param or :ids array param Chris@1115: # Raises a Unauthorized exception if one of the issues is not visible Chris@14: def find_issues Chris@14: @issues = Issue.find_all_by_id(params[:id] || params[:ids]) Chris@14: raise ActiveRecord::RecordNotFound if @issues.empty? Chris@1115: raise Unauthorized unless @issues.all?(&:visible?) chris@37: @projects = @issues.collect(&:project).compact.uniq chris@37: @project = @projects.first if @projects.size == 1 chris@37: rescue ActiveRecord::RecordNotFound chris@37: render_404 chris@37: end Chris@441: Chris@0: # make sure that the user is a member of the project (or admin) if project is private Chris@0: # used as a before_filter for actions that do not require any particular permission on the project Chris@0: def check_project_privacy Chris@1115: if @project && !@project.archived? Chris@1115: if @project.visible? Chris@0: true Chris@0: else Chris@909: deny_access Chris@0: end Chris@0: else Chris@0: @project = nil Chris@0: render_404 Chris@0: false Chris@0: end Chris@0: end Chris@0: Chris@14: def back_url Chris@1115: url = params[:back_url] Chris@1115: if url.nil? && referer = request.env['HTTP_REFERER'] Chris@1115: url = CGI.unescape(referer.to_s) Chris@1115: end Chris@1115: url Chris@14: end Chris@14: Chris@0: def redirect_back_or_default(default) Chris@1115: back_url = params[:back_url].to_s Chris@1115: if back_url.present? Chris@0: begin Chris@0: uri = URI.parse(back_url) Chris@0: # do not redirect user to another host or to the login or register page Chris@0: if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)}) Chris@0: redirect_to(back_url) Chris@0: return Chris@0: end Chris@0: rescue URI::InvalidURIError Chris@1115: logger.warn("Could not redirect to invalid URL #{back_url}") Chris@0: # redirect to default Chris@0: end Chris@0: end Chris@0: redirect_to default Chris@441: false Chris@0: end Chris@441: Chris@1115: # Redirects to the request referer if present, redirects to args or call block otherwise. Chris@1115: def redirect_to_referer_or(*args, &block) Chris@1115: redirect_to :back Chris@1115: rescue ::ActionController::RedirectBackError Chris@1115: if args.any? Chris@1115: redirect_to *args Chris@1115: elsif block_given? Chris@1115: block.call Chris@1115: else Chris@1115: raise "#redirect_to_referer_or takes arguments or a block" Chris@1115: end Chris@1115: end Chris@1115: chris@37: def render_403(options={}) Chris@0: @project = nil chris@37: render_error({:message => :notice_not_authorized, :status => 403}.merge(options)) Chris@0: return false Chris@0: end Chris@441: chris@37: def render_404(options={}) chris@37: render_error({:message => :notice_file_not_found, :status => 404}.merge(options)) Chris@0: return false Chris@0: end Chris@441: chris@37: # Renders an error response chris@37: def render_error(arg) chris@37: arg = {:message => arg} unless arg.is_a?(Hash) Chris@441: chris@37: @message = arg[:message] chris@37: @message = l(@message) if @message.is_a?(Symbol) chris@37: @status = arg[:status] || 500 Chris@441: Chris@0: respond_to do |format| chris@37: format.html { chris@37: render :template => 'common/error', :layout => use_layout, :status => @status Chris@0: } Chris@1115: format.any { head @status } Chris@0: end Chris@0: end Chris@1115: Chris@1115: # Handler for ActionView::MissingTemplate exception Chris@1115: def missing_template Chris@1115: logger.warn "Missing template, responding with 404" Chris@1115: @project = nil Chris@1115: render_404 Chris@1115: end Chris@1115: Chris@909: # Filter for actions that provide an API response Chris@909: # but have no HTML representation for non admin users Chris@909: def require_admin_or_api_request Chris@909: return true if api_request? Chris@909: if User.current.admin? Chris@909: true Chris@909: elsif User.current.logged? Chris@909: render_error(:status => 406) Chris@909: else Chris@909: deny_access Chris@909: end Chris@909: end Chris@14: Chris@14: # Picks which layout to use based on the request Chris@14: # Chris@14: # @return [boolean, string] name of the layout to use or false for no layout Chris@14: def use_layout Chris@14: request.xhr? ? false : 'base' Chris@14: end Chris@441: Chris@0: def invalid_authenticity_token Chris@0: if api_request? Chris@0: logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)." Chris@0: end Chris@0: render_error "Invalid form authenticity token." Chris@0: end Chris@441: Chris@441: def render_feed(items, options={}) Chris@0: @items = items || [] Chris@0: @items.sort! {|x,y| y.event_datetime <=> x.event_datetime } Chris@0: @items = @items.slice(0, Setting.feeds_limit.to_i) Chris@0: @title = options[:title] || Setting.app_title Chris@1115: render :template => "common/feed", :formats => [:atom], :layout => false, Chris@909: :content_type => 'application/atom+xml' Chris@0: end Chris@909: Chris@507: def self.accept_rss_auth(*actions) Chris@507: if actions.any? Chris@1115: self.accept_rss_auth_actions = actions Chris@507: else Chris@1115: self.accept_rss_auth_actions || [] Chris@507: end Chris@507: end Chris@909: Chris@507: def accept_rss_auth?(action=action_name) Chris@507: self.class.accept_rss_auth.include?(action.to_sym) Chris@507: end Chris@909: Chris@507: def self.accept_api_auth(*actions) Chris@507: if actions.any? Chris@1115: self.accept_api_auth_actions = actions Chris@507: else Chris@1115: self.accept_api_auth_actions || [] Chris@507: end Chris@507: end Chris@909: Chris@507: def accept_api_auth?(action=action_name) Chris@507: self.class.accept_api_auth.include?(action.to_sym) Chris@0: end Chris@441: Chris@0: # Returns the number of objects that should be displayed Chris@0: # on the paginated list Chris@0: def per_page_option Chris@0: per_page = nil Chris@0: if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i) Chris@0: per_page = params[:per_page].to_s.to_i Chris@0: session[:per_page] = per_page Chris@0: elsif session[:per_page] Chris@0: per_page = session[:per_page] Chris@0: else Chris@0: per_page = Setting.per_page_options_array.first || 25 Chris@0: end Chris@0: per_page Chris@0: end Chris@0: Chris@119: # Returns offset and limit used to retrieve objects Chris@119: # for an API response based on offset, limit and page parameters Chris@119: def api_offset_and_limit(options=params) Chris@119: if options[:offset].present? Chris@119: offset = options[:offset].to_i Chris@119: if offset < 0 Chris@119: offset = 0 Chris@119: end Chris@119: end Chris@119: limit = options[:limit].to_i Chris@119: if limit < 1 Chris@119: limit = 25 Chris@119: elsif limit > 100 Chris@119: limit = 100 Chris@119: end Chris@119: if offset.nil? && options[:page].present? Chris@119: offset = (options[:page].to_i - 1) * limit Chris@119: offset = 0 if offset < 0 Chris@119: end Chris@119: offset ||= 0 Chris@441: Chris@119: [offset, limit] Chris@119: end Chris@441: Chris@0: # qvalues http header parser Chris@0: # code taken from webrick Chris@0: def parse_qvalues(value) Chris@0: tmp = [] Chris@0: if value Chris@0: parts = value.split(/,\s*/) Chris@0: parts.each {|part| Chris@0: if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part) Chris@0: val = m[1] Chris@0: q = (m[2] or 1).to_f Chris@0: tmp.push([val, q]) Chris@0: end Chris@0: } Chris@0: tmp = tmp.sort_by{|val, q| -q} Chris@0: tmp.collect!{|val, q| val} Chris@0: end Chris@0: return tmp Chris@0: rescue Chris@0: nil Chris@0: end Chris@441: Chris@0: # Returns a string that can be used as filename value in Content-Disposition header Chris@0: def filename_for_content_disposition(name) Chris@0: request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name Chris@0: end Chris@441: Chris@0: def api_request? Chris@0: %w(xml json).include? params[:format] Chris@0: end Chris@441: Chris@119: # Returns the API key present in the request Chris@119: def api_key_from_request Chris@119: if params[:key].present? Chris@1115: params[:key].to_s Chris@119: elsif request.headers["X-Redmine-API-Key"].present? Chris@1115: request.headers["X-Redmine-API-Key"].to_s Chris@119: end Chris@119: end Chris@0: Chris@1115: # Returns the API 'switch user' value if present Chris@1115: def api_switch_user_from_request Chris@1115: request.headers["X-Redmine-Switch-User"].to_s.presence Chris@1115: end Chris@1115: Chris@0: # Renders a warning flash if obj has unsaved attachments Chris@0: def render_attachment_warning_if_needed(obj) Chris@0: flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present? Chris@0: end Chris@0: Chris@14: # Sets the `flash` notice or error based the number of issues that did not save Chris@14: # Chris@14: # @param [Array, Issue] issues all of the saved and unsaved Issues Chris@14: # @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved Chris@14: def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids) Chris@14: if unsaved_issue_ids.empty? Chris@14: flash[:notice] = l(:notice_successful_update) unless issues.empty? Chris@14: else Chris@14: flash[:error] = l(:notice_failed_to_save_issues, Chris@14: :count => unsaved_issue_ids.size, Chris@14: :total => issues.size, Chris@14: :ids => '#' + unsaved_issue_ids.join(', #')) Chris@14: end Chris@14: end Chris@14: Chris@0: # Rescues an invalid query statement. Just in case... Chris@0: def query_statement_invalid(exception) Chris@0: logger.error "Query::StatementInvalid: #{exception.message}" if logger Chris@0: session.delete(:query) Chris@0: sort_clear if respond_to?(:sort_clear) Chris@0: render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator." Chris@0: end Chris@0: Chris@1115: # Renders a 200 response for successfull updates or deletions via the API Chris@1115: def render_api_ok Chris@1115: render_api_head :ok Chris@119: end Chris@441: Chris@1115: # Renders a head API response Chris@1115: def render_api_head(status) Chris@1115: # #head would return a response body with one space Chris@1115: render :text => '', :status => status, :layout => nil Chris@119: end Chris@441: Chris@1115: # Renders API response on validation failure Chris@1115: def render_validation_errors(objects) Chris@1115: if objects.is_a?(Array) Chris@1115: @error_messages = objects.map {|object| object.errors.full_messages}.flatten Chris@1115: else Chris@1115: @error_messages = objects.errors.full_messages Chris@1115: end Chris@1115: render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil Chris@1115: end Chris@1115: Chris@1115: # Overrides #_include_layout? so that #render with no arguments Chris@119: # doesn't use the layout for api requests Chris@1115: def _include_layout?(*args) Chris@1115: api_request? ? false : super Chris@119: end Chris@0: end