##// END OF EJS Templates
fix non-ascii attachment file name get corrupted in IE11 (#16711)...
Toshi MARUYAMA -
r12826:709211cb9cc1
parent child
Show More
@@ -1,621 +1,621
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2014 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require 'uri'
19 19 require 'cgi'
20 20
21 21 class Unauthorized < Exception; end
22 22
23 23 class ApplicationController < ActionController::Base
24 24 include Redmine::I18n
25 25 include Redmine::Pagination
26 26 include RoutesHelper
27 27 helper :routes
28 28
29 29 class_attribute :accept_api_auth_actions
30 30 class_attribute :accept_rss_auth_actions
31 31 class_attribute :model_object
32 32
33 33 layout 'base'
34 34
35 35 protect_from_forgery
36 36
37 37 def verify_authenticity_token
38 38 unless api_request?
39 39 super
40 40 end
41 41 end
42 42
43 43 def handle_unverified_request
44 44 unless api_request?
45 45 super
46 46 cookies.delete(autologin_cookie_name)
47 47 self.logged_user = nil
48 48 render_error :status => 422, :message => "Invalid form authenticity token."
49 49 end
50 50 end
51 51
52 52 before_filter :session_expiration, :user_setup, :check_if_login_required, :check_password_change, :set_localization
53 53
54 54 rescue_from ::Unauthorized, :with => :deny_access
55 55 rescue_from ::ActionView::MissingTemplate, :with => :missing_template
56 56
57 57 include Redmine::Search::Controller
58 58 include Redmine::MenuManager::MenuController
59 59 helper Redmine::MenuManager::MenuHelper
60 60
61 61 def session_expiration
62 62 if session[:user_id]
63 63 if session_expired? && !try_to_autologin
64 64 reset_session
65 65 flash[:error] = l(:error_session_expired)
66 66 redirect_to signin_url
67 67 else
68 68 session[:atime] = Time.now.utc.to_i
69 69 end
70 70 end
71 71 end
72 72
73 73 def session_expired?
74 74 if Setting.session_lifetime?
75 75 unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60)
76 76 return true
77 77 end
78 78 end
79 79 if Setting.session_timeout?
80 80 unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60)
81 81 return true
82 82 end
83 83 end
84 84 false
85 85 end
86 86
87 87 def start_user_session(user)
88 88 session[:user_id] = user.id
89 89 session[:ctime] = Time.now.utc.to_i
90 90 session[:atime] = Time.now.utc.to_i
91 91 if user.must_change_password?
92 92 session[:pwd] = '1'
93 93 end
94 94 end
95 95
96 96 def user_setup
97 97 # Check the settings cache for each request
98 98 Setting.check_cache
99 99 # Find the current user
100 100 User.current = find_current_user
101 101 logger.info(" Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger
102 102 end
103 103
104 104 # Returns the current user or nil if no user is logged in
105 105 # and starts a session if needed
106 106 def find_current_user
107 107 user = nil
108 108 unless api_request?
109 109 if session[:user_id]
110 110 # existing session
111 111 user = (User.active.find(session[:user_id]) rescue nil)
112 112 elsif autologin_user = try_to_autologin
113 113 user = autologin_user
114 114 elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth?
115 115 # RSS key authentication does not start a session
116 116 user = User.find_by_rss_key(params[:key])
117 117 end
118 118 end
119 119 if user.nil? && Setting.rest_api_enabled? && accept_api_auth?
120 120 if (key = api_key_from_request)
121 121 # Use API key
122 122 user = User.find_by_api_key(key)
123 123 elsif request.authorization.to_s =~ /\ABasic /i
124 124 # HTTP Basic, either username/password or API key/random
125 125 authenticate_with_http_basic do |username, password|
126 126 user = User.try_to_login(username, password) || User.find_by_api_key(username)
127 127 end
128 128 if user && user.must_change_password?
129 129 render_error :message => 'You must change your password', :status => 403
130 130 return
131 131 end
132 132 end
133 133 # Switch user if requested by an admin user
134 134 if user && user.admin? && (username = api_switch_user_from_request)
135 135 su = User.find_by_login(username)
136 136 if su && su.active?
137 137 logger.info(" User switched by: #{user.login} (id=#{user.id})") if logger
138 138 user = su
139 139 else
140 140 render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412
141 141 end
142 142 end
143 143 end
144 144 user
145 145 end
146 146
147 147 def autologin_cookie_name
148 148 Redmine::Configuration['autologin_cookie_name'].presence || 'autologin'
149 149 end
150 150
151 151 def try_to_autologin
152 152 if cookies[autologin_cookie_name] && Setting.autologin?
153 153 # auto-login feature starts a new session
154 154 user = User.try_to_autologin(cookies[autologin_cookie_name])
155 155 if user
156 156 reset_session
157 157 start_user_session(user)
158 158 end
159 159 user
160 160 end
161 161 end
162 162
163 163 # Sets the logged in user
164 164 def logged_user=(user)
165 165 reset_session
166 166 if user && user.is_a?(User)
167 167 User.current = user
168 168 start_user_session(user)
169 169 else
170 170 User.current = User.anonymous
171 171 end
172 172 end
173 173
174 174 # Logs out current user
175 175 def logout_user
176 176 if User.current.logged?
177 177 cookies.delete(autologin_cookie_name)
178 178 Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin'])
179 179 self.logged_user = nil
180 180 end
181 181 end
182 182
183 183 # check if login is globally required to access the application
184 184 def check_if_login_required
185 185 # no check needed if user is already logged in
186 186 return true if User.current.logged?
187 187 require_login if Setting.login_required?
188 188 end
189 189
190 190 def check_password_change
191 191 if session[:pwd]
192 192 if User.current.must_change_password?
193 193 redirect_to my_password_path
194 194 else
195 195 session.delete(:pwd)
196 196 end
197 197 end
198 198 end
199 199
200 200 def set_localization
201 201 lang = nil
202 202 if User.current.logged?
203 203 lang = find_language(User.current.language)
204 204 end
205 205 if lang.nil? && !Setting.force_default_language_for_anonymous? && request.env['HTTP_ACCEPT_LANGUAGE']
206 206 accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first
207 207 if !accept_lang.blank?
208 208 accept_lang = accept_lang.downcase
209 209 lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)
210 210 end
211 211 end
212 212 lang ||= Setting.default_language
213 213 set_language_if_valid(lang)
214 214 end
215 215
216 216 def require_login
217 217 if !User.current.logged?
218 218 # Extract only the basic url parameters on non-GET requests
219 219 if request.get?
220 220 url = url_for(params)
221 221 else
222 222 url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])
223 223 end
224 224 respond_to do |format|
225 225 format.html {
226 226 if request.xhr?
227 227 head :unauthorized
228 228 else
229 229 redirect_to :controller => "account", :action => "login", :back_url => url
230 230 end
231 231 }
232 232 format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }
233 233 format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
234 234 format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
235 235 format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
236 236 end
237 237 return false
238 238 end
239 239 true
240 240 end
241 241
242 242 def require_admin
243 243 return unless require_login
244 244 if !User.current.admin?
245 245 render_403
246 246 return false
247 247 end
248 248 true
249 249 end
250 250
251 251 def deny_access
252 252 User.current.logged? ? render_403 : require_login
253 253 end
254 254
255 255 # Authorize the user for the requested action
256 256 def authorize(ctrl = params[:controller], action = params[:action], global = false)
257 257 allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global)
258 258 if allowed
259 259 true
260 260 else
261 261 if @project && @project.archived?
262 262 render_403 :message => :notice_not_authorized_archived_project
263 263 else
264 264 deny_access
265 265 end
266 266 end
267 267 end
268 268
269 269 # Authorize the user for the requested action outside a project
270 270 def authorize_global(ctrl = params[:controller], action = params[:action], global = true)
271 271 authorize(ctrl, action, global)
272 272 end
273 273
274 274 # Find project of id params[:id]
275 275 def find_project
276 276 @project = Project.find(params[:id])
277 277 rescue ActiveRecord::RecordNotFound
278 278 render_404
279 279 end
280 280
281 281 # Find project of id params[:project_id]
282 282 def find_project_by_project_id
283 283 @project = Project.find(params[:project_id])
284 284 rescue ActiveRecord::RecordNotFound
285 285 render_404
286 286 end
287 287
288 288 # Find a project based on params[:project_id]
289 289 # TODO: some subclasses override this, see about merging their logic
290 290 def find_optional_project
291 291 @project = Project.find(params[:project_id]) unless params[:project_id].blank?
292 292 allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true)
293 293 allowed ? true : deny_access
294 294 rescue ActiveRecord::RecordNotFound
295 295 render_404
296 296 end
297 297
298 298 # Finds and sets @project based on @object.project
299 299 def find_project_from_association
300 300 render_404 unless @object.present?
301 301
302 302 @project = @object.project
303 303 end
304 304
305 305 def find_model_object
306 306 model = self.class.model_object
307 307 if model
308 308 @object = model.find(params[:id])
309 309 self.instance_variable_set('@' + controller_name.singularize, @object) if @object
310 310 end
311 311 rescue ActiveRecord::RecordNotFound
312 312 render_404
313 313 end
314 314
315 315 def self.model_object(model)
316 316 self.model_object = model
317 317 end
318 318
319 319 # Find the issue whose id is the :id parameter
320 320 # Raises a Unauthorized exception if the issue is not visible
321 321 def find_issue
322 322 # Issue.visible.find(...) can not be used to redirect user to the login form
323 323 # if the issue actually exists but requires authentication
324 324 @issue = Issue.find(params[:id])
325 325 raise Unauthorized unless @issue.visible?
326 326 @project = @issue.project
327 327 rescue ActiveRecord::RecordNotFound
328 328 render_404
329 329 end
330 330
331 331 # Find issues with a single :id param or :ids array param
332 332 # Raises a Unauthorized exception if one of the issues is not visible
333 333 def find_issues
334 334 @issues = Issue.where(:id => (params[:id] || params[:ids])).preload(:project, :status, :tracker, :priority, :author, :assigned_to, :relations_to).to_a
335 335 raise ActiveRecord::RecordNotFound if @issues.empty?
336 336 raise Unauthorized unless @issues.all?(&:visible?)
337 337 @projects = @issues.collect(&:project).compact.uniq
338 338 @project = @projects.first if @projects.size == 1
339 339 rescue ActiveRecord::RecordNotFound
340 340 render_404
341 341 end
342 342
343 343 def find_attachments
344 344 if (attachments = params[:attachments]).present?
345 345 att = attachments.values.collect do |attachment|
346 346 Attachment.find_by_token( attachment[:token] ) if attachment[:token].present?
347 347 end
348 348 att.compact!
349 349 end
350 350 @attachments = att || []
351 351 end
352 352
353 353 # make sure that the user is a member of the project (or admin) if project is private
354 354 # used as a before_filter for actions that do not require any particular permission on the project
355 355 def check_project_privacy
356 356 if @project && !@project.archived?
357 357 if @project.visible?
358 358 true
359 359 else
360 360 deny_access
361 361 end
362 362 else
363 363 @project = nil
364 364 render_404
365 365 false
366 366 end
367 367 end
368 368
369 369 def back_url
370 370 url = params[:back_url]
371 371 if url.nil? && referer = request.env['HTTP_REFERER']
372 372 url = CGI.unescape(referer.to_s)
373 373 end
374 374 url
375 375 end
376 376
377 377 def redirect_back_or_default(default, options={})
378 378 back_url = params[:back_url].to_s
379 379 if back_url.present?
380 380 begin
381 381 uri = URI.parse(back_url)
382 382 # do not redirect user to another host or to the login or register page
383 383 if ((uri.relative? && back_url.match(%r{\A/(\w.*)?\z})) || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})
384 384 redirect_to(back_url)
385 385 return
386 386 end
387 387 rescue URI::InvalidURIError
388 388 logger.warn("Could not redirect to invalid URL #{back_url}")
389 389 # redirect to default
390 390 end
391 391 elsif options[:referer]
392 392 redirect_to_referer_or default
393 393 return
394 394 end
395 395 redirect_to default
396 396 false
397 397 end
398 398
399 399 # Redirects to the request referer if present, redirects to args or call block otherwise.
400 400 def redirect_to_referer_or(*args, &block)
401 401 redirect_to :back
402 402 rescue ::ActionController::RedirectBackError
403 403 if args.any?
404 404 redirect_to *args
405 405 elsif block_given?
406 406 block.call
407 407 else
408 408 raise "#redirect_to_referer_or takes arguments or a block"
409 409 end
410 410 end
411 411
412 412 def render_403(options={})
413 413 @project = nil
414 414 render_error({:message => :notice_not_authorized, :status => 403}.merge(options))
415 415 return false
416 416 end
417 417
418 418 def render_404(options={})
419 419 render_error({:message => :notice_file_not_found, :status => 404}.merge(options))
420 420 return false
421 421 end
422 422
423 423 # Renders an error response
424 424 def render_error(arg)
425 425 arg = {:message => arg} unless arg.is_a?(Hash)
426 426
427 427 @message = arg[:message]
428 428 @message = l(@message) if @message.is_a?(Symbol)
429 429 @status = arg[:status] || 500
430 430
431 431 respond_to do |format|
432 432 format.html {
433 433 render :template => 'common/error', :layout => use_layout, :status => @status
434 434 }
435 435 format.any { head @status }
436 436 end
437 437 end
438 438
439 439 # Handler for ActionView::MissingTemplate exception
440 440 def missing_template
441 441 logger.warn "Missing template, responding with 404"
442 442 @project = nil
443 443 render_404
444 444 end
445 445
446 446 # Filter for actions that provide an API response
447 447 # but have no HTML representation for non admin users
448 448 def require_admin_or_api_request
449 449 return true if api_request?
450 450 if User.current.admin?
451 451 true
452 452 elsif User.current.logged?
453 453 render_error(:status => 406)
454 454 else
455 455 deny_access
456 456 end
457 457 end
458 458
459 459 # Picks which layout to use based on the request
460 460 #
461 461 # @return [boolean, string] name of the layout to use or false for no layout
462 462 def use_layout
463 463 request.xhr? ? false : 'base'
464 464 end
465 465
466 466 def render_feed(items, options={})
467 467 @items = items || []
468 468 @items.sort! {|x,y| y.event_datetime <=> x.event_datetime }
469 469 @items = @items.slice(0, Setting.feeds_limit.to_i)
470 470 @title = options[:title] || Setting.app_title
471 471 render :template => "common/feed", :formats => [:atom], :layout => false,
472 472 :content_type => 'application/atom+xml'
473 473 end
474 474
475 475 def self.accept_rss_auth(*actions)
476 476 if actions.any?
477 477 self.accept_rss_auth_actions = actions
478 478 else
479 479 self.accept_rss_auth_actions || []
480 480 end
481 481 end
482 482
483 483 def accept_rss_auth?(action=action_name)
484 484 self.class.accept_rss_auth.include?(action.to_sym)
485 485 end
486 486
487 487 def self.accept_api_auth(*actions)
488 488 if actions.any?
489 489 self.accept_api_auth_actions = actions
490 490 else
491 491 self.accept_api_auth_actions || []
492 492 end
493 493 end
494 494
495 495 def accept_api_auth?(action=action_name)
496 496 self.class.accept_api_auth.include?(action.to_sym)
497 497 end
498 498
499 499 # Returns the number of objects that should be displayed
500 500 # on the paginated list
501 501 def per_page_option
502 502 per_page = nil
503 503 if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)
504 504 per_page = params[:per_page].to_s.to_i
505 505 session[:per_page] = per_page
506 506 elsif session[:per_page]
507 507 per_page = session[:per_page]
508 508 else
509 509 per_page = Setting.per_page_options_array.first || 25
510 510 end
511 511 per_page
512 512 end
513 513
514 514 # Returns offset and limit used to retrieve objects
515 515 # for an API response based on offset, limit and page parameters
516 516 def api_offset_and_limit(options=params)
517 517 if options[:offset].present?
518 518 offset = options[:offset].to_i
519 519 if offset < 0
520 520 offset = 0
521 521 end
522 522 end
523 523 limit = options[:limit].to_i
524 524 if limit < 1
525 525 limit = 25
526 526 elsif limit > 100
527 527 limit = 100
528 528 end
529 529 if offset.nil? && options[:page].present?
530 530 offset = (options[:page].to_i - 1) * limit
531 531 offset = 0 if offset < 0
532 532 end
533 533 offset ||= 0
534 534
535 535 [offset, limit]
536 536 end
537 537
538 538 # qvalues http header parser
539 539 # code taken from webrick
540 540 def parse_qvalues(value)
541 541 tmp = []
542 542 if value
543 543 parts = value.split(/,\s*/)
544 544 parts.each {|part|
545 545 if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)
546 546 val = m[1]
547 547 q = (m[2] or 1).to_f
548 548 tmp.push([val, q])
549 549 end
550 550 }
551 551 tmp = tmp.sort_by{|val, q| -q}
552 552 tmp.collect!{|val, q| val}
553 553 end
554 554 return tmp
555 555 rescue
556 556 nil
557 557 end
558 558
559 559 # Returns a string that can be used as filename value in Content-Disposition header
560 560 def filename_for_content_disposition(name)
561 request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name
561 request.env['HTTP_USER_AGENT'] =~ %r{(MSIE|Trident)} ? ERB::Util.url_encode(name) : name
562 562 end
563 563
564 564 def api_request?
565 565 %w(xml json).include? params[:format]
566 566 end
567 567
568 568 # Returns the API key present in the request
569 569 def api_key_from_request
570 570 if params[:key].present?
571 571 params[:key].to_s
572 572 elsif request.headers["X-Redmine-API-Key"].present?
573 573 request.headers["X-Redmine-API-Key"].to_s
574 574 end
575 575 end
576 576
577 577 # Returns the API 'switch user' value if present
578 578 def api_switch_user_from_request
579 579 request.headers["X-Redmine-Switch-User"].to_s.presence
580 580 end
581 581
582 582 # Renders a warning flash if obj has unsaved attachments
583 583 def render_attachment_warning_if_needed(obj)
584 584 flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present?
585 585 end
586 586
587 587 # Rescues an invalid query statement. Just in case...
588 588 def query_statement_invalid(exception)
589 589 logger.error "Query::StatementInvalid: #{exception.message}" if logger
590 590 session.delete(:query)
591 591 sort_clear if respond_to?(:sort_clear)
592 592 render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."
593 593 end
594 594
595 595 # Renders a 200 response for successfull updates or deletions via the API
596 596 def render_api_ok
597 597 render_api_head :ok
598 598 end
599 599
600 600 # Renders a head API response
601 601 def render_api_head(status)
602 602 # #head would return a response body with one space
603 603 render :text => '', :status => status, :layout => nil
604 604 end
605 605
606 606 # Renders API response on validation failure
607 607 def render_validation_errors(objects)
608 608 if objects.is_a?(Array)
609 609 @error_messages = objects.map {|object| object.errors.full_messages}.flatten
610 610 else
611 611 @error_messages = objects.errors.full_messages
612 612 end
613 613 render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil
614 614 end
615 615
616 616 # Overrides #_include_layout? so that #render with no arguments
617 617 # doesn't use the layout for api requests
618 618 def _include_layout?(*args)
619 619 api_request? ? false : super
620 620 end
621 621 end
General Comments 0
You need to be logged in to leave comments. Login now