application_controller.rb
656 lines
| 19.1 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r5296 | # Redmine - project management software | ||
|
Jean-Philippe Lang
|
r13491 | # Copyright (C) 2006-2015 Jean-Philippe Lang | ||
|
Jean-Philippe Lang
|
r330 | # | ||
| # This program is free software; you can redistribute it and/or | ||||
| # modify it under the terms of the GNU General Public License | ||||
| # as published by the Free Software Foundation; either version 2 | ||||
| # of the License, or (at your option) any later version. | ||||
Toshi MARUYAMA
|
r5629 | # | ||
|
Jean-Philippe Lang
|
r330 | # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
| # GNU General Public License for more details. | ||||
|
Toshi MARUYAMA
|
r5629 | # | ||
|
Jean-Philippe Lang
|
r330 | # You should have received a copy of the GNU General Public License | ||
| # along with this program; if not, write to the Free Software | ||||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
|
Jean-Philippe Lang
|
r1686 | require 'uri' | ||
|
Jean-Philippe Lang
|
r1891 | require 'cgi' | ||
|
Jean-Philippe Lang
|
r1686 | |||
|
Jean-Philippe Lang
|
r6043 | class Unauthorized < Exception; end | ||
|
Jean-Philippe Lang
|
r330 | class ApplicationController < ActionController::Base | ||
|
Jean-Philippe Lang
|
r2430 | include Redmine::I18n | ||
|
Jean-Philippe Lang
|
r10797 | include Redmine::Pagination | ||
|
Jean-Philippe Lang
|
r10845 | include RoutesHelper | ||
| helper :routes | ||||
|
Toshi MARUYAMA
|
r10355 | |||
|
Jean-Philippe Lang
|
r9346 | class_attribute :accept_api_auth_actions | ||
| class_attribute :accept_rss_auth_actions | ||||
| class_attribute :model_object | ||||
Eric Davis
|
r2773 | |||
|
Jean-Philippe Lang
|
r1726 | layout 'base' | ||
|
Toshi MARUYAMA
|
r6405 | |||
|
Jean-Philippe Lang
|
r6195 | protect_from_forgery | ||
|
Jean-Philippe Lang
|
r12080 | |||
| def verify_authenticity_token | ||||
| unless api_request? | ||||
| super | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r6196 | def handle_unverified_request | ||
|
Jean-Philippe Lang
|
r12080 | unless api_request? | ||
| super | ||||
| cookies.delete(autologin_cookie_name) | ||||
|
Jean-Philippe Lang
|
r12766 | self.logged_user = nil | ||
|
Jean-Philippe Lang
|
r13418 | set_localization | ||
|
Jean-Philippe Lang
|
r12080 | render_error :status => 422, :message => "Invalid form authenticity token." | ||
|
Jean-Philippe Lang
|
r12037 | end | ||
|
Jean-Philippe Lang
|
r6196 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
Jean-Baptiste Barth
|
r13049 | before_filter :session_expiration, :user_setup, :force_logout_if_password_changed, :check_if_login_required, :check_password_change, :set_localization | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r6043 | rescue_from ::Unauthorized, :with => :deny_access | ||
|
Jean-Philippe Lang
|
r10021 | rescue_from ::ActionView::MissingTemplate, :with => :missing_template | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r2829 | include Redmine::Search::Controller | ||
|
Jean-Philippe Lang
|
r1062 | include Redmine::MenuManager::MenuController | ||
| helper Redmine::MenuManager::MenuHelper | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r9614 | def session_expiration | ||
| if session[:user_id] | ||||
| if session_expired? && !try_to_autologin | ||||
|
Jean-Philippe Lang
|
r13028 | set_localization(User.active.find_by_id(session[:user_id])) | ||
|
Jean-Philippe Lang
|
r9614 | reset_session | ||
| flash[:error] = l(:error_session_expired) | ||||
| redirect_to signin_url | ||||
| else | ||||
| session[:atime] = Time.now.utc.to_i | ||||
| end | ||||
| end | ||||
| end | ||||
| def session_expired? | ||||
| if Setting.session_lifetime? | ||||
| unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60) | ||||
| return true | ||||
| end | ||||
| end | ||||
| if Setting.session_timeout? | ||||
| unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60) | ||||
| return true | ||||
| end | ||||
| end | ||||
| false | ||||
| end | ||||
| def start_user_session(user) | ||||
| session[:user_id] = user.id | ||||
| session[:ctime] = Time.now.utc.to_i | ||||
| session[:atime] = Time.now.utc.to_i | ||||
|
Jean-Philippe Lang
|
r11851 | if user.must_change_password? | ||
| session[:pwd] = '1' | ||||
| end | ||||
|
Jean-Philippe Lang
|
r9614 | end | ||
|
Jean-Philippe Lang
|
r663 | def user_setup | ||
|
Jean-Philippe Lang
|
r1016 | # Check the settings cache for each request | ||
|
Jean-Philippe Lang
|
r674 | Setting.check_cache | ||
|
Jean-Philippe Lang
|
r1016 | # Find the current user | ||
|
Jean-Philippe Lang
|
r2679 | User.current = find_current_user | ||
|
Jean-Philippe Lang
|
r10156 | logger.info(" Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger | ||
|
Jean-Philippe Lang
|
r1016 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r1016 | # Returns the current user or nil if no user is logged in | ||
|
Jean-Philippe Lang
|
r2679 | # and starts a session if needed | ||
|
Jean-Philippe Lang
|
r1016 | def find_current_user | ||
|
Jean-Philippe Lang
|
r9902 | user = nil | ||
| unless api_request? | ||||
|
Toshi MARUYAMA
|
r10355 | if session[:user_id] | ||
|
Jean-Philippe Lang
|
r9902 | # existing session | ||
| user = (User.active.find(session[:user_id]) rescue nil) | ||||
| elsif autologin_user = try_to_autologin | ||||
| user = autologin_user | ||||
| elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth? | ||||
| # RSS key authentication does not start a session | ||||
| user = User.find_by_rss_key(params[:key]) | ||||
| end | ||||
| end | ||||
| if user.nil? && Setting.rest_api_enabled? && accept_api_auth? | ||||
|
Jean-Philippe Lang
|
r6077 | if (key = api_key_from_request) | ||
|
Eric Davis
|
r3105 | # Use API key | ||
|
Jean-Philippe Lang
|
r9902 | user = User.find_by_api_key(key) | ||
|
Jean-Philippe Lang
|
r12640 | elsif request.authorization.to_s =~ /\ABasic /i | ||
|
Eric Davis
|
r3105 | # HTTP Basic, either username/password or API key/random | ||
| authenticate_with_http_basic do |username, password| | ||||
|
Jean-Philippe Lang
|
r9902 | user = User.try_to_login(username, password) || User.find_by_api_key(username) | ||
|
Eric Davis
|
r3105 | end | ||
|
Jean-Philippe Lang
|
r11851 | if user && user.must_change_password? | ||
| render_error :message => 'You must change your password', :status => 403 | ||||
| return | ||||
| end | ||||
|
Eric Davis
|
r3105 | end | ||
|
Jean-Philippe Lang
|
r10397 | # Switch user if requested by an admin user | ||
| if user && user.admin? && (username = api_switch_user_from_request) | ||||
| su = User.find_by_login(username) | ||||
| if su && su.active? | ||||
| logger.info(" User switched by: #{user.login} (id=#{user.id})") if logger | ||||
| user = su | ||||
| else | ||||
| render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412 | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r9902 | user | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Eric Davis
|
r3105 | |||
|
Jean-Baptiste Barth
|
r13049 | def force_logout_if_password_changed | ||
| passwd_changed_on = User.current.passwd_changed_on || Time.at(0) | ||||
| # Make sure we force logout only for web browser sessions, not API calls | ||||
| # if the password was changed after the session creation. | ||||
| if session[:user_id] && passwd_changed_on.utc.to_i > session[:ctime].to_i | ||||
| reset_session | ||||
| set_localization | ||||
| flash[:error] = l(:error_session_expired) | ||||
| redirect_to signin_url | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r11289 | def autologin_cookie_name | ||
| Redmine::Configuration['autologin_cookie_name'].presence || 'autologin' | ||||
| end | ||||
|
Jean-Philippe Lang
|
r9614 | def try_to_autologin | ||
|
Jean-Philippe Lang
|
r11289 | if cookies[autologin_cookie_name] && Setting.autologin? | ||
|
Jean-Philippe Lang
|
r9614 | # auto-login feature starts a new session | ||
|
Jean-Philippe Lang
|
r11289 | user = User.try_to_autologin(cookies[autologin_cookie_name]) | ||
|
Jean-Philippe Lang
|
r9614 | if user | ||
| reset_session | ||||
| start_user_session(user) | ||||
| end | ||||
| user | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2460 | # Sets the logged in user | ||
| def logged_user=(user) | ||||
|
Jean-Philippe Lang
|
r2966 | reset_session | ||
|
Jean-Philippe Lang
|
r2460 | if user && user.is_a?(User) | ||
| User.current = user | ||||
|
Jean-Philippe Lang
|
r9614 | start_user_session(user) | ||
|
Jean-Philippe Lang
|
r2460 | else | ||
| User.current = User.anonymous | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r9283 | # Logs out current user | ||
| def logout_user | ||||
| if User.current.logged? | ||||
|
Jean-Philippe Lang
|
r11290 | cookies.delete(autologin_cookie_name) | ||
|
Jean-Philippe Lang
|
r9283 | Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin']) | ||
| self.logged_user = nil | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | # check if login is globally required to access the application | ||
| def check_if_login_required | ||||
|
Jean-Philippe Lang
|
r511 | # no check needed if user is already logged in | ||
|
Jean-Philippe Lang
|
r663 | return true if User.current.logged? | ||
|
Jean-Philippe Lang
|
r330 | require_login if Setting.login_required? | ||
|
Toshi MARUYAMA
|
r5629 | end | ||
|
Jean-Philippe Lang
|
r11851 | def check_password_change | ||
| if session[:pwd] | ||||
| if User.current.must_change_password? | ||||
| redirect_to my_password_path | ||||
| else | ||||
| session.delete(:pwd) | ||||
| end | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r13028 | def set_localization(user=User.current) | ||
|
Jean-Philippe Lang
|
r2430 | lang = nil | ||
|
Jean-Philippe Lang
|
r13028 | if user && user.logged? | ||
| lang = find_language(user.language) | ||||
|
Jean-Philippe Lang
|
r2430 | end | ||
|
Jean-Philippe Lang
|
r12416 | if lang.nil? && !Setting.force_default_language_for_anonymous? && request.env['HTTP_ACCEPT_LANGUAGE'] | ||
|
Jean-Philippe Lang
|
r3588 | accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first | ||
|
Jean-Philippe Lang
|
r2430 | if !accept_lang.blank? | ||
|
Jean-Philippe Lang
|
r3588 | accept_lang = accept_lang.downcase | ||
|
Jean-Philippe Lang
|
r2430 | lang = find_language(accept_lang) || find_language(accept_lang.split('-').first) | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r2430 | end | ||
| lang ||= Setting.default_language | ||||
| set_language_if_valid(lang) | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r330 | def require_login | ||
|
Jean-Philippe Lang
|
r663 | if !User.current.logged? | ||
|
Eric Davis
|
r2936 | # Extract only the basic url parameters on non-GET requests | ||
| if request.get? | ||||
| url = url_for(params) | ||||
| else | ||||
| url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id]) | ||||
| end | ||||
|
Eric Davis
|
r3104 | respond_to do |format| | ||
|
Jean-Philippe Lang
|
r11732 | format.html { | ||
| if request.xhr? | ||||
| head :unauthorized | ||||
| else | ||||
| redirect_to :controller => "account", :action => "login", :back_url => url | ||||
| end | ||||
| } | ||||
|
Eric Davis
|
r3105 | format.atom { redirect_to :controller => "account", :action => "login", :back_url => url } | ||
|
Jean-Philippe Lang
|
r3565 | format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | ||
|
Eric Davis
|
r3713 | format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | ||
|
Jean-Philippe Lang
|
r3565 | format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | ||
|
Eric Davis
|
r3104 | end | ||
|
Jean-Philippe Lang
|
r330 | return false | ||
| end | ||||
| true | ||||
| end | ||||
| def require_admin | ||||
| return unless require_login | ||||
|
Jean-Philippe Lang
|
r663 | if !User.current.admin? | ||
|
Jean-Philippe Lang
|
r492 | render_403 | ||
|
Jean-Philippe Lang
|
r330 | return false | ||
| end | ||||
| true | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r1777 | def deny_access | ||
| User.current.logged? ? render_403 : require_login | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | |||
|
Jean-Philippe Lang
|
r663 | # Authorize the user for the requested action | ||
|
Jean-Philippe Lang
|
r2651 | def authorize(ctrl = params[:controller], action = params[:action], global = false) | ||
|
Jean-Baptiste Barth
|
r4122 | allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global) | ||
|
Jean-Philippe Lang
|
r4171 | if allowed | ||
| true | ||||
| else | ||||
| if @project && @project.archived? | ||||
| render_403 :message => :notice_not_authorized_archived_project | ||||
| else | ||||
| deny_access | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r2651 | |||
| # Authorize the user for the requested action outside a project | ||||
| def authorize_global(ctrl = params[:controller], action = params[:action], global = true) | ||||
| authorize(ctrl, action, global) | ||||
| end | ||||
|
Eric Davis
|
r3256 | |||
| # Find project of id params[:id] | ||||
| def find_project | ||||
| @project = Project.find(params[:id]) | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
|
Eric Davis
|
r3477 | |||
|
Eric Davis
|
r3961 | # Find project of id params[:project_id] | ||
| def find_project_by_project_id | ||||
| @project = Project.find(params[:project_id]) | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
|
Eric Davis
|
r3602 | # Find a project based on params[:project_id] | ||
| # TODO: some subclasses override this, see about merging their logic | ||||
| def find_optional_project | ||||
| @project = Project.find(params[:project_id]) unless params[:project_id].blank? | ||||
| allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true) | ||||
| allowed ? true : deny_access | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
|
Eric Davis
|
r3477 | # Finds and sets @project based on @object.project | ||
| def find_project_from_association | ||||
| render_404 unless @object.present? | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Eric Davis
|
r3477 | @project = @object.project | ||
| end | ||||
|
Eric Davis
|
r3483 | def find_model_object | ||
|
Jean-Philippe Lang
|
r9346 | model = self.class.model_object | ||
|
Eric Davis
|
r3483 | if model | ||
| @object = model.find(params[:id]) | ||||
| self.instance_variable_set('@' + controller_name.singularize, @object) if @object | ||||
| end | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
| def self.model_object(model) | ||||
|
Jean-Philippe Lang
|
r9346 | self.model_object = model | ||
|
Eric Davis
|
r3483 | end | ||
|
Eric Davis
|
r3824 | |||
|
Jean-Philippe Lang
|
r10677 | # Find the issue whose id is the :id parameter | ||
| # Raises a Unauthorized exception if the issue is not visible | ||||
| def find_issue | ||||
| # Issue.visible.find(...) can not be used to redirect user to the login form | ||||
| # if the issue actually exists but requires authentication | ||||
| @issue = Issue.find(params[:id]) | ||||
| raise Unauthorized unless @issue.visible? | ||||
| @project = @issue.project | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
| # Find issues with a single :id param or :ids array param | ||||
| # Raises a Unauthorized exception if one of the issues is not visible | ||||
|
Eric Davis
|
r3824 | def find_issues | ||
|
Jean-Philippe Lang
|
r11727 | @issues = Issue.where(:id => (params[:id] || params[:ids])).preload(:project, :status, :tracker, :priority, :author, :assigned_to, :relations_to).to_a | ||
|
Eric Davis
|
r3824 | raise ActiveRecord::RecordNotFound if @issues.empty? | ||
|
Jean-Philippe Lang
|
r10678 | raise Unauthorized unless @issues.all?(&:visible?) | ||
|
Jean-Baptiste Barth
|
r4114 | @projects = @issues.collect(&:project).compact.uniq | ||
| @project = @projects.first if @projects.size == 1 | ||||
| rescue ActiveRecord::RecordNotFound | ||||
| render_404 | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r10748 | def find_attachments | ||
| if (attachments = params[:attachments]).present? | ||||
| att = attachments.values.collect do |attachment| | ||||
| Attachment.find_by_token( attachment[:token] ) if attachment[:token].present? | ||||
| end | ||||
| att.compact! | ||||
| end | ||||
| @attachments = att || [] | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | # make sure that the user is a member of the project (or admin) if project is private | ||
| # used as a before_filter for actions that do not require any particular permission on the project | ||||
| def check_project_privacy | ||||
|
Jean-Philippe Lang
|
r9700 | if @project && !@project.archived? | ||
|
Jean-Philippe Lang
|
r8833 | if @project.visible? | ||
|
Jean-Philippe Lang
|
r1223 | true | ||
| else | ||||
|
Jean-Philippe Lang
|
r7859 | deny_access | ||
|
Jean-Philippe Lang
|
r1223 | end | ||
| else | ||||
|
Jean-Philippe Lang
|
r546 | @project = nil | ||
| render_404 | ||||
|
Jean-Philippe Lang
|
r1223 | false | ||
|
Jean-Philippe Lang
|
r546 | end | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Eric Davis
|
r3798 | def back_url | ||
|
Jean-Philippe Lang
|
r10056 | url = params[:back_url] | ||
| if url.nil? && referer = request.env['HTTP_REFERER'] | ||||
| url = CGI.unescape(referer.to_s) | ||||
| end | ||||
| url | ||||
|
Eric Davis
|
r3798 | end | ||
|
Jean-Philippe Lang
|
r12430 | def redirect_back_or_default(default, options={}) | ||
|
Jean-Philippe Lang
|
r10056 | back_url = params[:back_url].to_s | ||
|
Jean-Philippe Lang
|
r12938 | if back_url.present? && valid_back_url?(back_url) | ||
| redirect_to(back_url) | ||||
| return | ||||
|
Jean-Philippe Lang
|
r12430 | elsif options[:referer] | ||
| redirect_to_referer_or default | ||||
| return | ||||
|
Jean-Philippe Lang
|
r5 | end | ||
|
Jean-Philippe Lang
|
r1686 | redirect_to default | ||
|
Toshi MARUYAMA
|
r5491 | false | ||
|
Jean-Philippe Lang
|
r5 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r12938 | # Returns true if back_url is a valid url for redirection, otherwise false | ||
| def valid_back_url?(back_url) | ||||
| if CGI.unescape(back_url).include?('..') | ||||
| return false | ||||
| end | ||||
| begin | ||||
| uri = URI.parse(back_url) | ||||
| rescue URI::InvalidURIError | ||||
| return false | ||||
| end | ||||
| if uri.host.present? && uri.host != request.host | ||||
| return false | ||||
| end | ||||
| if uri.path.match(%r{/(login|account/register)}) | ||||
| return false | ||||
| end | ||||
| if relative_url_root.present? && !uri.path.starts_with?(relative_url_root) | ||||
| return false | ||||
| end | ||||
| return true | ||||
| end | ||||
| private :valid_back_url? | ||||
|
Jean-Philippe Lang
|
r9229 | # Redirects to the request referer if present, redirects to args or call block otherwise. | ||
| def redirect_to_referer_or(*args, &block) | ||||
| redirect_to :back | ||||
| rescue ::ActionController::RedirectBackError | ||||
| if args.any? | ||||
| redirect_to *args | ||||
| elsif block_given? | ||||
| block.call | ||||
| else | ||||
| raise "#redirect_to_referer_or takes arguments or a block" | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r4171 | def render_403(options={}) | ||
|
Jean-Philippe Lang
|
r492 | @project = nil | ||
|
Jean-Philippe Lang
|
r4172 | render_error({:message => :notice_not_authorized, :status => 403}.merge(options)) | ||
|
Jean-Philippe Lang
|
r492 | return false | ||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r4172 | def render_404(options={}) | ||
| render_error({:message => :notice_file_not_found, :status => 404}.merge(options)) | ||||
|
Jean-Philippe Lang
|
r330 | return false | ||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r4172 | # Renders an error response | ||
| def render_error(arg) | ||||
| arg = {:message => arg} unless arg.is_a?(Hash) | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r4172 | @message = arg[:message] | ||
| @message = l(@message) if @message.is_a?(Symbol) | ||||
| @status = arg[:status] || 500 | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r3196 | respond_to do |format| | ||
|
Jean-Philippe Lang
|
r4172 | format.html { | ||
| render :template => 'common/error', :layout => use_layout, :status => @status | ||||
|
Jean-Philippe Lang
|
r3196 | } | ||
|
Jean-Philippe Lang
|
r10021 | format.any { head @status } | ||
|
Jean-Philippe Lang
|
r3196 | end | ||
|
Jean-Philippe Lang
|
r1080 | end | ||
|
Jean-Philippe Lang
|
r10021 | |||
| # Handler for ActionView::MissingTemplate exception | ||||
| def missing_template | ||||
| logger.warn "Missing template, responding with 404" | ||||
| @project = nil | ||||
| render_404 | ||||
| end | ||||
|
Jean-Philippe Lang
|
r7757 | # Filter for actions that provide an API response | ||
| # but have no HTML representation for non admin users | ||||
| def require_admin_or_api_request | ||||
| return true if api_request? | ||||
| if User.current.admin? | ||||
| true | ||||
| elsif User.current.logged? | ||||
| render_error(:status => 406) | ||||
| else | ||||
| deny_access | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r3835 | |||
| # Picks which layout to use based on the request | ||||
| # | ||||
| # @return [boolean, string] name of the layout to use or false for no layout | ||||
| def use_layout | ||||
| request.xhr? ? false : 'base' | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
| def render_feed(items, options={}) | ||||
|
Jean-Philippe Lang
|
r675 | @items = items || [] | ||
| @items.sort! {|x,y| y.event_datetime <=> x.event_datetime } | ||||
|
Jean-Philippe Lang
|
r1295 | @items = @items.slice(0, Setting.feeds_limit.to_i) | ||
|
Jean-Philippe Lang
|
r663 | @title = options[:title] || Setting.app_title | ||
|
Jean-Philippe Lang
|
r10350 | render :template => "common/feed", :formats => [:atom], :layout => false, | ||
|
Toshi MARUYAMA
|
r7453 | :content_type => 'application/atom+xml' | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6405 | |||
|
Jean-Philippe Lang
|
r6077 | def self.accept_rss_auth(*actions) | ||
| if actions.any? | ||||
|
Jean-Philippe Lang
|
r9346 | self.accept_rss_auth_actions = actions | ||
|
Jean-Philippe Lang
|
r6077 | else | ||
|
Jean-Philippe Lang
|
r9346 | self.accept_rss_auth_actions || [] | ||
|
Jean-Philippe Lang
|
r6077 | end | ||
| end | ||||
|
Toshi MARUYAMA
|
r6405 | |||
|
Jean-Philippe Lang
|
r6077 | def accept_rss_auth?(action=action_name) | ||
| self.class.accept_rss_auth.include?(action.to_sym) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6405 | |||
|
Jean-Philippe Lang
|
r6077 | def self.accept_api_auth(*actions) | ||
| if actions.any? | ||||
|
Jean-Philippe Lang
|
r9346 | self.accept_api_auth_actions = actions | ||
|
Jean-Philippe Lang
|
r6077 | else | ||
|
Jean-Philippe Lang
|
r9346 | self.accept_api_auth_actions || [] | ||
|
Jean-Philippe Lang
|
r6077 | end | ||
| end | ||||
|
Toshi MARUYAMA
|
r6405 | |||
|
Jean-Philippe Lang
|
r6077 | def accept_api_auth?(action=action_name) | ||
| self.class.accept_api_auth.include?(action.to_sym) | ||||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r1013 | # Returns the number of objects that should be displayed | ||
| # on the paginated list | ||||
| def per_page_option | ||||
| per_page = nil | ||||
| if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i) | ||||
| per_page = params[:per_page].to_s.to_i | ||||
| session[:per_page] = per_page | ||||
| elsif session[:per_page] | ||||
| per_page = session[:per_page] | ||||
| else | ||||
| per_page = Setting.per_page_options_array.first || 25 | ||||
| end | ||||
| per_page | ||||
| end | ||||
|
Jean-Philippe Lang
|
r4457 | # Returns offset and limit used to retrieve objects | ||
| # for an API response based on offset, limit and page parameters | ||||
| def api_offset_and_limit(options=params) | ||||
| if options[:offset].present? | ||||
| offset = options[:offset].to_i | ||||
|
Jean-Philippe Lang
|
r4375 | if offset < 0 | ||
| offset = 0 | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r4457 | limit = options[:limit].to_i | ||
|
Jean-Philippe Lang
|
r4375 | if limit < 1 | ||
| limit = 25 | ||||
| elsif limit > 100 | ||||
| limit = 100 | ||||
| end | ||||
|
Jean-Philippe Lang
|
r4457 | if offset.nil? && options[:page].present? | ||
| offset = (options[:page].to_i - 1) * limit | ||||
| offset = 0 if offset < 0 | ||||
| end | ||||
| offset ||= 0 | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r4375 | [offset, limit] | ||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r330 | # qvalues http header parser | ||
| # code taken from webrick | ||||
| def parse_qvalues(value) | ||||
| tmp = [] | ||||
| if value | ||||
| parts = value.split(/,\s*/) | ||||
| parts.each {|part| | ||||
| if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part) | ||||
| val = m[1] | ||||
| q = (m[2] or 1).to_f | ||||
| tmp.push([val, q]) | ||||
| end | ||||
| } | ||||
| tmp = tmp.sort_by{|val, q| -q} | ||||
| tmp.collect!{|val, q| val} | ||||
| end | ||||
| return tmp | ||||
|
Jean-Philippe Lang
|
r2430 | rescue | ||
| nil | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r1039 | # Returns a string that can be used as filename value in Content-Disposition header | ||
| def filename_for_content_disposition(name) | ||||
|
Toshi MARUYAMA
|
r12826 | request.env['HTTP_USER_AGENT'] =~ %r{(MSIE|Trident)} ? ERB::Util.url_encode(name) : name | ||
|
Jean-Philippe Lang
|
r1039 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r3218 | def api_request? | ||
| %w(xml json).include? params[:format] | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r4459 | # Returns the API key present in the request | ||
| def api_key_from_request | ||||
| if params[:key].present? | ||||
|
Jean-Philippe Lang
|
r9615 | params[:key].to_s | ||
|
Jean-Philippe Lang
|
r4459 | elsif request.headers["X-Redmine-API-Key"].present? | ||
|
Jean-Philippe Lang
|
r9615 | request.headers["X-Redmine-API-Key"].to_s | ||
|
Jean-Philippe Lang
|
r4459 | end | ||
| end | ||||
|
Eric Davis
|
r3414 | |||
|
Jean-Philippe Lang
|
r10397 | # Returns the API 'switch user' value if present | ||
| def api_switch_user_from_request | ||||
| request.headers["X-Redmine-Switch-User"].to_s.presence | ||||
| end | ||||
|
Eric Davis
|
r3414 | # Renders a warning flash if obj has unsaved attachments | ||
| def render_attachment_warning_if_needed(obj) | ||||
| flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present? | ||||
| end | ||||
|
Eric Davis
|
r3582 | |||
| # Rescues an invalid query statement. Just in case... | ||||
| def query_statement_invalid(exception) | ||||
| logger.error "Query::StatementInvalid: #{exception.message}" if logger | ||||
| session.delete(:query) | ||||
| sort_clear if respond_to?(:sort_clear) | ||||
| render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator." | ||||
| end | ||||
|
Jean-Philippe Lang
|
r9792 | # Renders a 200 response for successfull updates or deletions via the API | ||
| def render_api_ok | ||||
|
Jean-Philippe Lang
|
r10505 | render_api_head :ok | ||
| end | ||||
| # Renders a head API response | ||||
| def render_api_head(status) | ||||
| # #head would return a response body with one space | ||||
| render :text => '', :status => status, :layout => nil | ||||
|
Jean-Philippe Lang
|
r9792 | end | ||
|
Jean-Philippe Lang
|
r4341 | # Renders API response on validation failure | ||
|
Jean-Philippe Lang
|
r13420 | # for an object or an array of objects | ||
|
Jean-Philippe Lang
|
r8975 | def render_validation_errors(objects) | ||
|
Jean-Philippe Lang
|
r13420 | messages = Array.wrap(objects).map {|object| object.errors.full_messages}.flatten | ||
| render_api_errors(messages) | ||||
| end | ||||
| def render_api_errors(*messages) | ||||
| @error_messages = messages.flatten | ||||
|
Jean-Philippe Lang
|
r9346 | render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil | ||
|
Jean-Philippe Lang
|
r4352 | end | ||
|
Toshi MARUYAMA
|
r5629 | |||
|
Jean-Philippe Lang
|
r9346 | # Overrides #_include_layout? so that #render with no arguments | ||
|
Jean-Philippe Lang
|
r4352 | # doesn't use the layout for api requests | ||
|
Jean-Philippe Lang
|
r9346 | def _include_layout?(*args) | ||
| api_request? ? false : super | ||||
|
Jean-Philippe Lang
|
r4352 | end | ||
|
Jean-Philippe Lang
|
r663 | end | ||