| @@ -1,490 +1,490 | |||||
| 1 | # Redmine - project management software |
|
1 | # Redmine - project management software | |
| 2 | # Copyright (C) 2006-2011 Jean-Philippe Lang |
|
2 | # Copyright (C) 2006-2011 Jean-Philippe Lang | |
| 3 | # |
|
3 | # | |
| 4 | # This program is free software; you can redistribute it and/or |
|
4 | # This program is free software; you can redistribute it and/or | |
| 5 | # modify it under the terms of the GNU General Public License |
|
5 | # modify it under the terms of the GNU General Public License | |
| 6 | # as published by the Free Software Foundation; either version 2 |
|
6 | # as published by the Free Software Foundation; either version 2 | |
| 7 | # of the License, or (at your option) any later version. |
|
7 | # of the License, or (at your option) any later version. | |
| 8 | # |
|
8 | # | |
| 9 | # This program is distributed in the hope that it will be useful, |
|
9 | # This program is distributed in the hope that it will be useful, | |
| 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 12 | # GNU General Public License for more details. |
|
12 | # GNU General Public License for more details. | |
| 13 | # |
|
13 | # | |
| 14 | # You should have received a copy of the GNU General Public License |
|
14 | # You should have received a copy of the GNU General Public License | |
| 15 | # along with this program; if not, write to the Free Software |
|
15 | # along with this program; if not, write to the Free Software | |
| 16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|
16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | |
| 17 |
|
17 | |||
| 18 | require 'uri' |
|
18 | require 'uri' | |
| 19 | require 'cgi' |
|
19 | require 'cgi' | |
| 20 |
|
20 | |||
| 21 | class Unauthorized < Exception; end |
|
21 | class Unauthorized < Exception; end | |
| 22 |
|
22 | |||
| 23 | class ApplicationController < ActionController::Base |
|
23 | class ApplicationController < ActionController::Base | |
| 24 | include Redmine::I18n |
|
24 | include Redmine::I18n | |
| 25 |
|
25 | |||
| 26 | layout 'base' |
|
26 | layout 'base' | |
| 27 | exempt_from_layout 'builder', 'rsb' |
|
27 | exempt_from_layout 'builder', 'rsb' | |
| 28 |
|
28 | |||
| 29 | # Remove broken cookie after upgrade from 0.8.x (#4292) |
|
29 | # Remove broken cookie after upgrade from 0.8.x (#4292) | |
| 30 | # See https://rails.lighthouseapp.com/projects/8994/tickets/3360 |
|
30 | # See https://rails.lighthouseapp.com/projects/8994/tickets/3360 | |
| 31 | # TODO: remove it when Rails is fixed |
|
31 | # TODO: remove it when Rails is fixed | |
| 32 | before_filter :delete_broken_cookies |
|
32 | before_filter :delete_broken_cookies | |
| 33 | def delete_broken_cookies |
|
33 | def delete_broken_cookies | |
| 34 | if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/ |
|
34 | if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/ | |
| 35 | cookies.delete '_redmine_session' |
|
35 | cookies.delete '_redmine_session' | |
| 36 | redirect_to home_path |
|
36 | redirect_to home_path | |
| 37 | return false |
|
37 | return false | |
| 38 | end |
|
38 | end | |
| 39 | end |
|
39 | end | |
| 40 |
|
40 | |||
| 41 | before_filter :user_setup, :check_if_login_required, :set_localization |
|
41 | before_filter :user_setup, :check_if_login_required, :set_localization | |
| 42 | filter_parameter_logging :password |
|
42 | filter_parameter_logging :password | |
| 43 | protect_from_forgery |
|
43 | protect_from_forgery | |
| 44 |
|
44 | |||
| 45 | rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token |
|
45 | rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token | |
| 46 | rescue_from ::Unauthorized, :with => :deny_access |
|
46 | rescue_from ::Unauthorized, :with => :deny_access | |
| 47 |
|
47 | |||
| 48 | include Redmine::Search::Controller |
|
48 | include Redmine::Search::Controller | |
| 49 | include Redmine::MenuManager::MenuController |
|
49 | include Redmine::MenuManager::MenuController | |
| 50 | helper Redmine::MenuManager::MenuHelper |
|
50 | helper Redmine::MenuManager::MenuHelper | |
| 51 |
|
51 | |||
| 52 | Redmine::Scm::Base.all.each do |scm| |
|
52 | Redmine::Scm::Base.all.each do |scm| | |
| 53 | require_dependency "repository/#{scm.underscore}" |
|
53 | require_dependency "repository/#{scm.underscore}" | |
| 54 | end |
|
54 | end | |
| 55 |
|
55 | |||
| 56 | def user_setup |
|
56 | def user_setup | |
| 57 | # Check the settings cache for each request |
|
57 | # Check the settings cache for each request | |
| 58 | Setting.check_cache |
|
58 | Setting.check_cache | |
| 59 | # Find the current user |
|
59 | # Find the current user | |
| 60 | User.current = find_current_user |
|
60 | User.current = find_current_user | |
| 61 | end |
|
61 | end | |
| 62 |
|
62 | |||
| 63 | # Returns the current user or nil if no user is logged in |
|
63 | # Returns the current user or nil if no user is logged in | |
| 64 | # and starts a session if needed |
|
64 | # and starts a session if needed | |
| 65 | def find_current_user |
|
65 | def find_current_user | |
| 66 | if session[:user_id] |
|
66 | if session[:user_id] | |
| 67 | # existing session |
|
67 | # existing session | |
| 68 | (User.active.find(session[:user_id]) rescue nil) |
|
68 | (User.active.find(session[:user_id]) rescue nil) | |
| 69 | elsif cookies[:autologin] && Setting.autologin? |
|
69 | elsif cookies[:autologin] && Setting.autologin? | |
| 70 | # auto-login feature starts a new session |
|
70 | # auto-login feature starts a new session | |
| 71 | user = User.try_to_autologin(cookies[:autologin]) |
|
71 | user = User.try_to_autologin(cookies[:autologin]) | |
| 72 | session[:user_id] = user.id if user |
|
72 | session[:user_id] = user.id if user | |
| 73 | user |
|
73 | user | |
| 74 | elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action]) |
|
74 | elsif params[:format] == 'atom' && request.get? && params[:key] && accept_key_auth_actions.include?(params[:action]) | |
| 75 | # RSS key authentication does not start a session |
|
75 | # RSS key authentication does not start a session | |
| 76 | User.find_by_rss_key(params[:key]) |
|
76 | User.find_by_rss_key(params[:key]) | |
| 77 | elsif Setting.rest_api_enabled? && api_request? |
|
77 | elsif Setting.rest_api_enabled? && api_request? | |
| 78 | if (key = api_key_from_request) && accept_key_auth_actions.include?(params[:action]) |
|
78 | if (key = api_key_from_request) && accept_key_auth_actions.include?(params[:action]) | |
| 79 | # Use API key |
|
79 | # Use API key | |
| 80 | User.find_by_api_key(key) |
|
80 | User.find_by_api_key(key) | |
| 81 | else |
|
81 | else | |
| 82 | # HTTP Basic, either username/password or API key/random |
|
82 | # HTTP Basic, either username/password or API key/random | |
| 83 | authenticate_with_http_basic do |username, password| |
|
83 | authenticate_with_http_basic do |username, password| | |
| 84 | User.try_to_login(username, password) || User.find_by_api_key(username) |
|
84 | User.try_to_login(username, password) || User.find_by_api_key(username) | |
| 85 | end |
|
85 | end | |
| 86 | end |
|
86 | end | |
| 87 | end |
|
87 | end | |
| 88 | end |
|
88 | end | |
| 89 |
|
89 | |||
| 90 | # Sets the logged in user |
|
90 | # Sets the logged in user | |
| 91 | def logged_user=(user) |
|
91 | def logged_user=(user) | |
| 92 | reset_session |
|
92 | reset_session | |
| 93 | if user && user.is_a?(User) |
|
93 | if user && user.is_a?(User) | |
| 94 | User.current = user |
|
94 | User.current = user | |
| 95 | session[:user_id] = user.id |
|
95 | session[:user_id] = user.id | |
| 96 | else |
|
96 | else | |
| 97 | User.current = User.anonymous |
|
97 | User.current = User.anonymous | |
| 98 | end |
|
98 | end | |
| 99 | end |
|
99 | end | |
| 100 |
|
100 | |||
| 101 | # check if login is globally required to access the application |
|
101 | # check if login is globally required to access the application | |
| 102 | def check_if_login_required |
|
102 | def check_if_login_required | |
| 103 | # no check needed if user is already logged in |
|
103 | # no check needed if user is already logged in | |
| 104 | return true if User.current.logged? |
|
104 | return true if User.current.logged? | |
| 105 | require_login if Setting.login_required? |
|
105 | require_login if Setting.login_required? | |
| 106 | end |
|
106 | end | |
| 107 |
|
107 | |||
| 108 | def set_localization |
|
108 | def set_localization | |
| 109 | lang = nil |
|
109 | lang = nil | |
| 110 | if User.current.logged? |
|
110 | if User.current.logged? | |
| 111 | lang = find_language(User.current.language) |
|
111 | lang = find_language(User.current.language) | |
| 112 | end |
|
112 | end | |
| 113 | if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE'] |
|
113 | if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE'] | |
| 114 | accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first |
|
114 | accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first | |
| 115 | if !accept_lang.blank? |
|
115 | if !accept_lang.blank? | |
| 116 | accept_lang = accept_lang.downcase |
|
116 | accept_lang = accept_lang.downcase | |
| 117 | lang = find_language(accept_lang) || find_language(accept_lang.split('-').first) |
|
117 | lang = find_language(accept_lang) || find_language(accept_lang.split('-').first) | |
| 118 | end |
|
118 | end | |
| 119 | end |
|
119 | end | |
| 120 | lang ||= Setting.default_language |
|
120 | lang ||= Setting.default_language | |
| 121 | set_language_if_valid(lang) |
|
121 | set_language_if_valid(lang) | |
| 122 | end |
|
122 | end | |
| 123 |
|
123 | |||
| 124 | def require_login |
|
124 | def require_login | |
| 125 | if !User.current.logged? |
|
125 | if !User.current.logged? | |
| 126 | # Extract only the basic url parameters on non-GET requests |
|
126 | # Extract only the basic url parameters on non-GET requests | |
| 127 | if request.get? |
|
127 | if request.get? | |
| 128 | url = url_for(params) |
|
128 | url = url_for(params) | |
| 129 | else |
|
129 | else | |
| 130 | url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id]) |
|
130 | url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id]) | |
| 131 | end |
|
131 | end | |
| 132 | respond_to do |format| |
|
132 | respond_to do |format| | |
| 133 | format.html { redirect_to :controller => "account", :action => "login", :back_url => url } |
|
133 | format.html { redirect_to :controller => "account", :action => "login", :back_url => url } | |
| 134 | format.atom { redirect_to :controller => "account", :action => "login", :back_url => url } |
|
134 | format.atom { redirect_to :controller => "account", :action => "login", :back_url => url } | |
| 135 | format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } |
|
135 | format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | |
| 136 | format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } |
|
136 | format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | |
| 137 | format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } |
|
137 | format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' } | |
| 138 | end |
|
138 | end | |
| 139 | return false |
|
139 | return false | |
| 140 | end |
|
140 | end | |
| 141 | true |
|
141 | true | |
| 142 | end |
|
142 | end | |
| 143 |
|
143 | |||
| 144 | def require_admin |
|
144 | def require_admin | |
| 145 | return unless require_login |
|
145 | return unless require_login | |
| 146 | if !User.current.admin? |
|
146 | if !User.current.admin? | |
| 147 | render_403 |
|
147 | render_403 | |
| 148 | return false |
|
148 | return false | |
| 149 | end |
|
149 | end | |
| 150 | true |
|
150 | true | |
| 151 | end |
|
151 | end | |
| 152 |
|
152 | |||
| 153 | def deny_access |
|
153 | def deny_access | |
| 154 | User.current.logged? ? render_403 : require_login |
|
154 | User.current.logged? ? render_403 : require_login | |
| 155 | end |
|
155 | end | |
| 156 |
|
156 | |||
| 157 | # Authorize the user for the requested action |
|
157 | # Authorize the user for the requested action | |
| 158 | def authorize(ctrl = params[:controller], action = params[:action], global = false) |
|
158 | def authorize(ctrl = params[:controller], action = params[:action], global = false) | |
| 159 | allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global) |
|
159 | allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global) | |
| 160 | if allowed |
|
160 | if allowed | |
| 161 | true |
|
161 | true | |
| 162 | else |
|
162 | else | |
| 163 | if @project && @project.archived? |
|
163 | if @project && @project.archived? | |
| 164 | render_403 :message => :notice_not_authorized_archived_project |
|
164 | render_403 :message => :notice_not_authorized_archived_project | |
| 165 | else |
|
165 | else | |
| 166 | deny_access |
|
166 | deny_access | |
| 167 | end |
|
167 | end | |
| 168 | end |
|
168 | end | |
| 169 | end |
|
169 | end | |
| 170 |
|
170 | |||
| 171 | # Authorize the user for the requested action outside a project |
|
171 | # Authorize the user for the requested action outside a project | |
| 172 | def authorize_global(ctrl = params[:controller], action = params[:action], global = true) |
|
172 | def authorize_global(ctrl = params[:controller], action = params[:action], global = true) | |
| 173 | authorize(ctrl, action, global) |
|
173 | authorize(ctrl, action, global) | |
| 174 | end |
|
174 | end | |
| 175 |
|
175 | |||
| 176 | # Find project of id params[:id] |
|
176 | # Find project of id params[:id] | |
| 177 | def find_project |
|
177 | def find_project | |
| 178 | @project = Project.find(params[:id]) |
|
178 | @project = Project.find(params[:id]) | |
| 179 | rescue ActiveRecord::RecordNotFound |
|
179 | rescue ActiveRecord::RecordNotFound | |
| 180 | render_404 |
|
180 | render_404 | |
| 181 | end |
|
181 | end | |
| 182 |
|
182 | |||
| 183 | # Find project of id params[:project_id] |
|
183 | # Find project of id params[:project_id] | |
| 184 | def find_project_by_project_id |
|
184 | def find_project_by_project_id | |
| 185 | @project = Project.find(params[:project_id]) |
|
185 | @project = Project.find(params[:project_id]) | |
| 186 | rescue ActiveRecord::RecordNotFound |
|
186 | rescue ActiveRecord::RecordNotFound | |
| 187 | render_404 |
|
187 | render_404 | |
| 188 | end |
|
188 | end | |
| 189 |
|
189 | |||
| 190 | # Find a project based on params[:project_id] |
|
190 | # Find a project based on params[:project_id] | |
| 191 | # TODO: some subclasses override this, see about merging their logic |
|
191 | # TODO: some subclasses override this, see about merging their logic | |
| 192 | def find_optional_project |
|
192 | def find_optional_project | |
| 193 | @project = Project.find(params[:project_id]) unless params[:project_id].blank? |
|
193 | @project = Project.find(params[:project_id]) unless params[:project_id].blank? | |
| 194 | allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true) |
|
194 | allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true) | |
| 195 | allowed ? true : deny_access |
|
195 | allowed ? true : deny_access | |
| 196 | rescue ActiveRecord::RecordNotFound |
|
196 | rescue ActiveRecord::RecordNotFound | |
| 197 | render_404 |
|
197 | render_404 | |
| 198 | end |
|
198 | end | |
| 199 |
|
199 | |||
| 200 | # Finds and sets @project based on @object.project |
|
200 | # Finds and sets @project based on @object.project | |
| 201 | def find_project_from_association |
|
201 | def find_project_from_association | |
| 202 | render_404 unless @object.present? |
|
202 | render_404 unless @object.present? | |
| 203 |
|
203 | |||
| 204 | @project = @object.project |
|
204 | @project = @object.project | |
| 205 | rescue ActiveRecord::RecordNotFound |
|
205 | rescue ActiveRecord::RecordNotFound | |
| 206 | render_404 |
|
206 | render_404 | |
| 207 | end |
|
207 | end | |
| 208 |
|
208 | |||
| 209 | def find_model_object |
|
209 | def find_model_object | |
| 210 | model = self.class.read_inheritable_attribute('model_object') |
|
210 | model = self.class.read_inheritable_attribute('model_object') | |
| 211 | if model |
|
211 | if model | |
| 212 | @object = model.find(params[:id]) |
|
212 | @object = model.find(params[:id]) | |
| 213 | self.instance_variable_set('@' + controller_name.singularize, @object) if @object |
|
213 | self.instance_variable_set('@' + controller_name.singularize, @object) if @object | |
| 214 | end |
|
214 | end | |
| 215 | rescue ActiveRecord::RecordNotFound |
|
215 | rescue ActiveRecord::RecordNotFound | |
| 216 | render_404 |
|
216 | render_404 | |
| 217 | end |
|
217 | end | |
| 218 |
|
218 | |||
| 219 | def self.model_object(model) |
|
219 | def self.model_object(model) | |
| 220 | write_inheritable_attribute('model_object', model) |
|
220 | write_inheritable_attribute('model_object', model) | |
| 221 | end |
|
221 | end | |
| 222 |
|
222 | |||
| 223 | # Filter for bulk issue operations |
|
223 | # Filter for bulk issue operations | |
| 224 | def find_issues |
|
224 | def find_issues | |
| 225 | @issues = Issue.find_all_by_id(params[:id] || params[:ids]) |
|
225 | @issues = Issue.find_all_by_id(params[:id] || params[:ids]) | |
| 226 | raise ActiveRecord::RecordNotFound if @issues.empty? |
|
226 | raise ActiveRecord::RecordNotFound if @issues.empty? | |
| 227 | if @issues.detect {|issue| !issue.visible?} |
|
227 | if @issues.detect {|issue| !issue.visible?} | |
| 228 | deny_access |
|
228 | deny_access | |
| 229 | return |
|
229 | return | |
| 230 | end |
|
230 | end | |
| 231 | @projects = @issues.collect(&:project).compact.uniq |
|
231 | @projects = @issues.collect(&:project).compact.uniq | |
| 232 | @project = @projects.first if @projects.size == 1 |
|
232 | @project = @projects.first if @projects.size == 1 | |
| 233 | rescue ActiveRecord::RecordNotFound |
|
233 | rescue ActiveRecord::RecordNotFound | |
| 234 | render_404 |
|
234 | render_404 | |
| 235 | end |
|
235 | end | |
| 236 |
|
236 | |||
| 237 | # Check if project is unique before bulk operations |
|
237 | # Check if project is unique before bulk operations | |
| 238 | def check_project_uniqueness |
|
238 | def check_project_uniqueness | |
| 239 | unless @project |
|
239 | unless @project | |
| 240 | # TODO: let users bulk edit/move/destroy issues from different projects |
|
240 | # TODO: let users bulk edit/move/destroy issues from different projects | |
| 241 | render_error 'Can not bulk edit/move/destroy issues from different projects' |
|
241 | render_error 'Can not bulk edit/move/destroy issues from different projects' | |
| 242 | return false |
|
242 | return false | |
| 243 | end |
|
243 | end | |
| 244 | end |
|
244 | end | |
| 245 |
|
245 | |||
| 246 | # make sure that the user is a member of the project (or admin) if project is private |
|
246 | # make sure that the user is a member of the project (or admin) if project is private | |
| 247 | # used as a before_filter for actions that do not require any particular permission on the project |
|
247 | # used as a before_filter for actions that do not require any particular permission on the project | |
| 248 | def check_project_privacy |
|
248 | def check_project_privacy | |
| 249 | if @project && @project.active? |
|
249 | if @project && @project.active? | |
| 250 | if @project.is_public? || User.current.member_of?(@project) || User.current.admin? |
|
250 | if @project.is_public? || User.current.member_of?(@project) || User.current.admin? | |
| 251 | true |
|
251 | true | |
| 252 | else |
|
252 | else | |
| 253 | User.current.logged? ? render_403 : require_login |
|
253 | User.current.logged? ? render_403 : require_login | |
| 254 | end |
|
254 | end | |
| 255 | else |
|
255 | else | |
| 256 | @project = nil |
|
256 | @project = nil | |
| 257 | render_404 |
|
257 | render_404 | |
| 258 | false |
|
258 | false | |
| 259 | end |
|
259 | end | |
| 260 | end |
|
260 | end | |
| 261 |
|
261 | |||
| 262 | def back_url |
|
262 | def back_url | |
| 263 | params[:back_url] || request.env['HTTP_REFERER'] |
|
263 | params[:back_url] || request.env['HTTP_REFERER'] | |
| 264 | end |
|
264 | end | |
| 265 |
|
265 | |||
| 266 | def redirect_back_or_default(default) |
|
266 | def redirect_back_or_default(default) | |
| 267 | back_url = CGI.unescape(params[:back_url].to_s) |
|
267 | back_url = CGI.unescape(params[:back_url].to_s) | |
| 268 | if !back_url.blank? |
|
268 | if !back_url.blank? | |
| 269 | begin |
|
269 | begin | |
| 270 | uri = URI.parse(back_url) |
|
270 | uri = URI.parse(back_url) | |
| 271 | # do not redirect user to another host or to the login or register page |
|
271 | # do not redirect user to another host or to the login or register page | |
| 272 | if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)}) |
|
272 | if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)}) | |
| 273 | redirect_to(back_url) |
|
273 | redirect_to(back_url) | |
| 274 | return |
|
274 | return | |
| 275 | end |
|
275 | end | |
| 276 | rescue URI::InvalidURIError |
|
276 | rescue URI::InvalidURIError | |
| 277 | # redirect to default |
|
277 | # redirect to default | |
| 278 | end |
|
278 | end | |
| 279 | end |
|
279 | end | |
| 280 | redirect_to default |
|
280 | redirect_to default | |
| 281 | false |
|
281 | false | |
| 282 | end |
|
282 | end | |
| 283 |
|
283 | |||
| 284 | def render_403(options={}) |
|
284 | def render_403(options={}) | |
| 285 | @project = nil |
|
285 | @project = nil | |
| 286 | render_error({:message => :notice_not_authorized, :status => 403}.merge(options)) |
|
286 | render_error({:message => :notice_not_authorized, :status => 403}.merge(options)) | |
| 287 | return false |
|
287 | return false | |
| 288 | end |
|
288 | end | |
| 289 |
|
289 | |||
| 290 | def render_404(options={}) |
|
290 | def render_404(options={}) | |
| 291 | render_error({:message => :notice_file_not_found, :status => 404}.merge(options)) |
|
291 | render_error({:message => :notice_file_not_found, :status => 404}.merge(options)) | |
| 292 | return false |
|
292 | return false | |
| 293 | end |
|
293 | end | |
| 294 |
|
294 | |||
| 295 | # Renders an error response |
|
295 | # Renders an error response | |
| 296 | def render_error(arg) |
|
296 | def render_error(arg) | |
| 297 | arg = {:message => arg} unless arg.is_a?(Hash) |
|
297 | arg = {:message => arg} unless arg.is_a?(Hash) | |
| 298 |
|
298 | |||
| 299 | @message = arg[:message] |
|
299 | @message = arg[:message] | |
| 300 | @message = l(@message) if @message.is_a?(Symbol) |
|
300 | @message = l(@message) if @message.is_a?(Symbol) | |
| 301 | @status = arg[:status] || 500 |
|
301 | @status = arg[:status] || 500 | |
| 302 |
|
302 | |||
| 303 | respond_to do |format| |
|
303 | respond_to do |format| | |
| 304 | format.html { |
|
304 | format.html { | |
| 305 | render :template => 'common/error', :layout => use_layout, :status => @status |
|
305 | render :template => 'common/error', :layout => use_layout, :status => @status | |
| 306 | } |
|
306 | } | |
| 307 | format.atom { head @status } |
|
307 | format.atom { head @status } | |
| 308 | format.xml { head @status } |
|
308 | format.xml { head @status } | |
| 309 | format.js { head @status } |
|
309 | format.js { head @status } | |
| 310 | format.json { head @status } |
|
310 | format.json { head @status } | |
| 311 | end |
|
311 | end | |
| 312 | end |
|
312 | end | |
| 313 |
|
313 | |||
| 314 | # Picks which layout to use based on the request |
|
314 | # Picks which layout to use based on the request | |
| 315 | # |
|
315 | # | |
| 316 | # @return [boolean, string] name of the layout to use or false for no layout |
|
316 | # @return [boolean, string] name of the layout to use or false for no layout | |
| 317 | def use_layout |
|
317 | def use_layout | |
| 318 | request.xhr? ? false : 'base' |
|
318 | request.xhr? ? false : 'base' | |
| 319 | end |
|
319 | end | |
| 320 |
|
320 | |||
| 321 | def invalid_authenticity_token |
|
321 | def invalid_authenticity_token | |
| 322 | if api_request? |
|
322 | if api_request? | |
| 323 | logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)." |
|
323 | logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)." | |
| 324 | end |
|
324 | end | |
| 325 | render_error "Invalid form authenticity token." |
|
325 | render_error "Invalid form authenticity token." | |
| 326 | end |
|
326 | end | |
| 327 |
|
327 | |||
| 328 | def render_feed(items, options={}) |
|
328 | def render_feed(items, options={}) | |
| 329 | @items = items || [] |
|
329 | @items = items || [] | |
| 330 | @items.sort! {|x,y| y.event_datetime <=> x.event_datetime } |
|
330 | @items.sort! {|x,y| y.event_datetime <=> x.event_datetime } | |
| 331 | @items = @items.slice(0, Setting.feeds_limit.to_i) |
|
331 | @items = @items.slice(0, Setting.feeds_limit.to_i) | |
| 332 | @title = options[:title] || Setting.app_title |
|
332 | @title = options[:title] || Setting.app_title | |
| 333 | render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml' |
|
333 | render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml' | |
| 334 | end |
|
334 | end | |
| 335 |
|
335 | |||
| 336 | def self.accept_key_auth(*actions) |
|
336 | def self.accept_key_auth(*actions) | |
| 337 | actions = actions.flatten.map(&:to_s) |
|
337 | actions = actions.flatten.map(&:to_s) | |
| 338 | write_inheritable_attribute('accept_key_auth_actions', actions) |
|
338 | write_inheritable_attribute('accept_key_auth_actions', actions) | |
| 339 | end |
|
339 | end | |
| 340 |
|
340 | |||
| 341 | def accept_key_auth_actions |
|
341 | def accept_key_auth_actions | |
| 342 | self.class.read_inheritable_attribute('accept_key_auth_actions') || [] |
|
342 | self.class.read_inheritable_attribute('accept_key_auth_actions') || [] | |
| 343 | end |
|
343 | end | |
| 344 |
|
344 | |||
| 345 | # Returns the number of objects that should be displayed |
|
345 | # Returns the number of objects that should be displayed | |
| 346 | # on the paginated list |
|
346 | # on the paginated list | |
| 347 | def per_page_option |
|
347 | def per_page_option | |
| 348 | per_page = nil |
|
348 | per_page = nil | |
| 349 | if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i) |
|
349 | if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i) | |
| 350 | per_page = params[:per_page].to_s.to_i |
|
350 | per_page = params[:per_page].to_s.to_i | |
| 351 | session[:per_page] = per_page |
|
351 | session[:per_page] = per_page | |
| 352 | elsif session[:per_page] |
|
352 | elsif session[:per_page] | |
| 353 | per_page = session[:per_page] |
|
353 | per_page = session[:per_page] | |
| 354 | else |
|
354 | else | |
| 355 | per_page = Setting.per_page_options_array.first || 25 |
|
355 | per_page = Setting.per_page_options_array.first || 25 | |
| 356 | end |
|
356 | end | |
| 357 | per_page |
|
357 | per_page | |
| 358 | end |
|
358 | end | |
| 359 |
|
359 | |||
| 360 | # Returns offset and limit used to retrieve objects |
|
360 | # Returns offset and limit used to retrieve objects | |
| 361 | # for an API response based on offset, limit and page parameters |
|
361 | # for an API response based on offset, limit and page parameters | |
| 362 | def api_offset_and_limit(options=params) |
|
362 | def api_offset_and_limit(options=params) | |
| 363 | if options[:offset].present? |
|
363 | if options[:offset].present? | |
| 364 | offset = options[:offset].to_i |
|
364 | offset = options[:offset].to_i | |
| 365 | if offset < 0 |
|
365 | if offset < 0 | |
| 366 | offset = 0 |
|
366 | offset = 0 | |
| 367 | end |
|
367 | end | |
| 368 | end |
|
368 | end | |
| 369 | limit = options[:limit].to_i |
|
369 | limit = options[:limit].to_i | |
| 370 | if limit < 1 |
|
370 | if limit < 1 | |
| 371 | limit = 25 |
|
371 | limit = 25 | |
| 372 | elsif limit > 100 |
|
372 | elsif limit > 100 | |
| 373 | limit = 100 |
|
373 | limit = 100 | |
| 374 | end |
|
374 | end | |
| 375 | if offset.nil? && options[:page].present? |
|
375 | if offset.nil? && options[:page].present? | |
| 376 | offset = (options[:page].to_i - 1) * limit |
|
376 | offset = (options[:page].to_i - 1) * limit | |
| 377 | offset = 0 if offset < 0 |
|
377 | offset = 0 if offset < 0 | |
| 378 | end |
|
378 | end | |
| 379 | offset ||= 0 |
|
379 | offset ||= 0 | |
| 380 |
|
380 | |||
| 381 | [offset, limit] |
|
381 | [offset, limit] | |
| 382 | end |
|
382 | end | |
| 383 |
|
383 | |||
| 384 | # qvalues http header parser |
|
384 | # qvalues http header parser | |
| 385 | # code taken from webrick |
|
385 | # code taken from webrick | |
| 386 | def parse_qvalues(value) |
|
386 | def parse_qvalues(value) | |
| 387 | tmp = [] |
|
387 | tmp = [] | |
| 388 | if value |
|
388 | if value | |
| 389 | parts = value.split(/,\s*/) |
|
389 | parts = value.split(/,\s*/) | |
| 390 | parts.each {|part| |
|
390 | parts.each {|part| | |
| 391 | if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part) |
|
391 | if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part) | |
| 392 | val = m[1] |
|
392 | val = m[1] | |
| 393 | q = (m[2] or 1).to_f |
|
393 | q = (m[2] or 1).to_f | |
| 394 | tmp.push([val, q]) |
|
394 | tmp.push([val, q]) | |
| 395 | end |
|
395 | end | |
| 396 | } |
|
396 | } | |
| 397 | tmp = tmp.sort_by{|val, q| -q} |
|
397 | tmp = tmp.sort_by{|val, q| -q} | |
| 398 | tmp.collect!{|val, q| val} |
|
398 | tmp.collect!{|val, q| val} | |
| 399 | end |
|
399 | end | |
| 400 | return tmp |
|
400 | return tmp | |
| 401 | rescue |
|
401 | rescue | |
| 402 | nil |
|
402 | nil | |
| 403 | end |
|
403 | end | |
| 404 |
|
404 | |||
| 405 | # Returns a string that can be used as filename value in Content-Disposition header |
|
405 | # Returns a string that can be used as filename value in Content-Disposition header | |
| 406 | def filename_for_content_disposition(name) |
|
406 | def filename_for_content_disposition(name) | |
| 407 | request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name |
|
407 | request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name | |
| 408 | end |
|
408 | end | |
| 409 |
|
409 | |||
| 410 | def api_request? |
|
410 | def api_request? | |
| 411 | %w(xml json).include? params[:format] |
|
411 | %w(xml json).include? params[:format] | |
| 412 | end |
|
412 | end | |
| 413 |
|
413 | |||
| 414 | # Returns the API key present in the request |
|
414 | # Returns the API key present in the request | |
| 415 | def api_key_from_request |
|
415 | def api_key_from_request | |
| 416 | if params[:key].present? |
|
416 | if params[:key].present? | |
| 417 | params[:key] |
|
417 | params[:key] | |
| 418 | elsif request.headers["X-Redmine-API-Key"].present? |
|
418 | elsif request.headers["X-Redmine-API-Key"].present? | |
| 419 | request.headers["X-Redmine-API-Key"] |
|
419 | request.headers["X-Redmine-API-Key"] | |
| 420 | end |
|
420 | end | |
| 421 | end |
|
421 | end | |
| 422 |
|
422 | |||
| 423 | # Renders a warning flash if obj has unsaved attachments |
|
423 | # Renders a warning flash if obj has unsaved attachments | |
| 424 | def render_attachment_warning_if_needed(obj) |
|
424 | def render_attachment_warning_if_needed(obj) | |
| 425 | flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present? |
|
425 | flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present? | |
| 426 | end |
|
426 | end | |
| 427 |
|
427 | |||
| 428 | # Sets the `flash` notice or error based the number of issues that did not save |
|
428 | # Sets the `flash` notice or error based the number of issues that did not save | |
| 429 | # |
|
429 | # | |
| 430 | # @param [Array, Issue] issues all of the saved and unsaved Issues |
|
430 | # @param [Array, Issue] issues all of the saved and unsaved Issues | |
| 431 | # @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved |
|
431 | # @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved | |
| 432 | def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids) |
|
432 | def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids) | |
| 433 | if unsaved_issue_ids.empty? |
|
433 | if unsaved_issue_ids.empty? | |
| 434 | flash[:notice] = l(:notice_successful_update) unless issues.empty? |
|
434 | flash[:notice] = l(:notice_successful_update) unless issues.empty? | |
| 435 | else |
|
435 | else | |
| 436 | flash[:error] = l(:notice_failed_to_save_issues, |
|
436 | flash[:error] = l(:notice_failed_to_save_issues, | |
| 437 | :count => unsaved_issue_ids.size, |
|
437 | :count => unsaved_issue_ids.size, | |
| 438 | :total => issues.size, |
|
438 | :total => issues.size, | |
| 439 | :ids => '#' + unsaved_issue_ids.join(', #')) |
|
439 | :ids => '#' + unsaved_issue_ids.join(', #')) | |
| 440 | end |
|
440 | end | |
| 441 | end |
|
441 | end | |
| 442 |
|
442 | |||
| 443 | # Rescues an invalid query statement. Just in case... |
|
443 | # Rescues an invalid query statement. Just in case... | |
| 444 | def query_statement_invalid(exception) |
|
444 | def query_statement_invalid(exception) | |
| 445 | logger.error "Query::StatementInvalid: #{exception.message}" if logger |
|
445 | logger.error "Query::StatementInvalid: #{exception.message}" if logger | |
| 446 | session.delete(:query) |
|
446 | session.delete(:query) | |
| 447 | sort_clear if respond_to?(:sort_clear) |
|
447 | sort_clear if respond_to?(:sort_clear) | |
| 448 | render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator." |
|
448 | render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator." | |
| 449 | end |
|
449 | end | |
| 450 |
|
450 | |||
| 451 | # Converts the errors on an ActiveRecord object into a common JSON format |
|
451 | # Converts the errors on an ActiveRecord object into a common JSON format | |
| 452 | def object_errors_to_json(object) |
|
452 | def object_errors_to_json(object) | |
| 453 | object.errors.collect do |attribute, error| |
|
453 | object.errors.collect do |attribute, error| | |
| 454 | { attribute => error } |
|
454 | { attribute => error } | |
| 455 | end.to_json |
|
455 | end.to_json | |
| 456 | end |
|
456 | end | |
| 457 |
|
457 | |||
| 458 | # Renders API response on validation failure |
|
458 | # Renders API response on validation failure | |
| 459 | def render_validation_errors(object) |
|
459 | def render_validation_errors(object) | |
| 460 | options = { :status => :unprocessable_entity, :layout => false } |
|
460 | options = { :status => :unprocessable_entity, :layout => false } | |
| 461 | options.merge!(case params[:format] |
|
461 | options.merge!(case params[:format] | |
| 462 | when 'xml'; { :xml => object.errors } |
|
462 | when 'xml'; { :xml => object.errors } | |
| 463 | when 'json'; { :json => {'errors' => object.errors} } # ActiveResource client compliance |
|
463 | when 'json'; { :json => {'errors' => object.errors} } # ActiveResource client compliance | |
| 464 | else |
|
464 | else | |
| 465 | raise "Unknown format #{params[:format]} in #render_validation_errors" |
|
465 | raise "Unknown format #{params[:format]} in #render_validation_errors" | |
| 466 | end |
|
466 | end | |
| 467 | ) |
|
467 | ) | |
| 468 | render options |
|
468 | render options | |
| 469 | end |
|
469 | end | |
| 470 |
|
470 | |||
| 471 | # Overrides #default_template so that the api template |
|
471 | # Overrides #default_template so that the api template | |
| 472 | # is used automatically if it exists |
|
472 | # is used automatically if it exists | |
| 473 | def default_template(action_name = self.action_name) |
|
473 | def default_template(action_name = self.action_name) | |
| 474 | if api_request? |
|
474 | if api_request? | |
| 475 | begin |
|
475 | begin | |
| 476 | return self.view_paths.find_template(default_template_name(action_name), 'api') |
|
476 | return self.view_paths.find_template(default_template_name(action_name), 'api') | |
| 477 | rescue ::ActionView::MissingTemplate |
|
477 | rescue ::ActionView::MissingTemplate | |
| 478 | # the api template was not found |
|
478 | # the api template was not found | |
| 479 | # fallback to the default behaviour |
|
479 | # fallback to the default behaviour | |
| 480 | end |
|
480 | end | |
| 481 | end |
|
481 | end | |
| 482 | super |
|
482 | super | |
| 483 | end |
|
483 | end | |
| 484 |
|
484 | |||
| 485 | # Overrides #pick_layout so that #render with no arguments |
|
485 | # Overrides #pick_layout so that #render with no arguments | |
| 486 | # doesn't use the layout for api requests |
|
486 | # doesn't use the layout for api requests | |
| 487 | def pick_layout(*args) |
|
487 | def pick_layout(*args) | |
| 488 | api_request? ? nil : super |
|
488 | api_request? ? nil : super | |
| 489 | end |
|
489 | end | |
| 490 | end |
|
490 | end | |
General Comments 0
You need to be logged in to leave comments.
Login now