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