Class: UsersController

Inherits:
ApplicationController show all
Includes:
ActivitiesHelper, CustomFieldsHelper, SortHelper, UsersHelper
Defined in:
app/controllers/users_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2021 Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::ATTACHMENT_CONTAINER_LINK, ApplicationHelper::HEADING_RE, ApplicationHelper::LINKS_RE, ApplicationHelper::MACROS_RE, ApplicationHelper::MACRO_SUB_RE, ApplicationHelper::RECORD_LINK, ApplicationHelper::TOC_RE

Constants included from CustomFieldsHelper

CustomFieldsHelper::CUSTOM_FIELDS_TABS

Instance Method Summary collapse

Methods included from ActivitiesHelper

#activity_authors_options_for_select, #sort_activity_events

Methods included from UsersHelper

#additional_emails_link, #change_status_link, #csv_content, #history_default_tab_options, #textarea_font_options, #user_emails, #user_mail_notification_options, #user_settings_tabs, #users_status_options_for_select, #users_to_csv

Methods included from ApplicationHelper

#accesskey, #actions_dropdown, #anchor, #api_meta, #authoring, #authorize_for, #autocomplete_data_sources, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #bulk_edit_error_messages, #calendar_for, #cancel_button_tag, #catch_macros, #check_all_links, #checked_image, #context_menu, #copy_object_url_link, #default_search_project_scope, #delete_link, #due_date_distance_in_words, #email_delivery_enabled?, #error_messages_for, #export_csv_encoding_select_tag, #favicon, #favicon_path, #favicon_url, #form_tag_html, #format_activity_day, #format_activity_description, #format_activity_title, #format_changeset_comments, #format_object, #format_version_name, #get_tab_action, #heads_for_auto_complete, #html_hours, #html_title, #image_tag, #include_calendar_headers_tags, #include_in_api_response?, #inject_macros, #javascript_heads, #javascript_include_tag, #labelled_fields_for, #labelled_form_for, #lang_options_for_select, #link_to_attachment, #link_to_attachment_container, #link_to_context_menu, #link_to_function, #link_to_group, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_month, #link_to_next_month, #link_to_previous_month, #link_to_project, #link_to_project_settings, #link_to_record, #link_to_revision, #link_to_user, #link_to_version, #option_tag, #other_formats_links, #page_header_title, #parse_headings, #parse_hires_images, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_sections, #parse_wiki_links, #principals_check_box_tags, #principals_options_for_select, #progress_bar, #project_tree, #project_tree_options_for_select, #projects_for_jump_box, #raw_json, #render_error_messages, #render_flash_messages, #render_if_exist, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_projects_for_jump_box, #render_tabs, #reorder_handle, #replace_toc, #robot_exclusion_tag, #sanitize_anchor_name, #sidebar_content?, #simple_format_without_paragraph, #stylesheet_link_tag, #syntax_highlight, #syntax_highlight_lines, #textilizable, #thumbnail_tag, #time_tag, #title, #to_path_param, #toggle_checkboxes_link, #toggle_link, #truncate_lines, #truncate_single_line_raw, #view_layouts_base_sidebar_hook_response, #wiki_page_path

Methods included from Redmine::Helpers::URL

#uri_with_safe_scheme?

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Themes::Helper

#current_theme, #heads_for_theme

Methods included from Redmine::SudoMode::Helper

#hash_to_hidden_fields

Methods included from Redmine::Pagination::Helper

#pagination_links_each, #pagination_links_full, #per_page_links, #per_page_options

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options, #macro_exists?

Methods included from CustomFieldsHelper

#custom_field_formats_for_select, #custom_field_label_tag, #custom_field_name_tag, #custom_field_tag, #custom_field_tag_for_bulk_edit, #custom_field_tag_id, #custom_field_tag_name, #custom_field_tag_with_label, #custom_field_title, #custom_field_type_options, #custom_field_value_tag, #edit_tag_style_tag, #format_value, #render_api_custom_values, #render_custom_field_format_partial, #render_custom_field_values, #render_custom_fields_tabs, #select_type_radio_buttons, #show_value

Methods included from SortHelper

#sort_clause, #sort_clear, #sort_criteria, #sort_css_classes, #sort_header_tag, #sort_init, #sort_link, #sort_name, #sort_update

Methods inherited from ApplicationController

#_include_layout?, accept_api_auth, #accept_api_auth?, accept_rss_auth, #accept_rss_auth?, #api_key_from_request, #api_offset_and_limit, #api_request?, #api_switch_user_from_request, #authorize, #authorize_global, #autologin_cookie_name, #back_url, #check_if_login_required, #check_password_change, #check_project_privacy, #check_twofa_activation, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_optional_project, #find_optional_project_by_id, #find_project, #find_project_by_project_id, #find_project_from_association, #handle_unverified_request, #init_twofa_pairing_and_send_code_for, #logged_user=, #logout_user, #missing_template, model_object, #parse_params_for_bulk_update, #parse_qvalues, #per_page_option, #query_error, #query_statement_invalid, #record_project_usage, #redirect_back_or_default, #redirect_to_referer_or, #render_403, #render_404, #render_api_errors, #render_api_head, #render_api_ok, #render_attachment_warning_if_needed, #render_error, #render_feed, #render_validation_errors, #require_admin, #require_admin_or_api_request, #require_login, #session_expiration, #session_expired?, #set_localization, #start_user_session, #try_to_autologin, #use_layout, #user_setup, #verify_authenticity_token

Methods included from Redmine::SudoMode::Controller

#process_sudo_form, #render_sudo_form, #require_sudo_mode, #sudo_mode, #sudo_timestamp_valid?, #update_sudo_timestamp!

Methods included from Redmine::MenuManager::MenuController

#current_menu, #current_menu_item, included, #menu_items, #redirect_to_menu_item, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes, included

Methods included from AvatarsHelper

#assignee_avatar, #author_avatar, #avatar, #avatar_edit_link

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

Methods included from RoutesHelper

#_new_project_issue_path, #_new_time_entry_path, #_project_calendar_path, #_project_gantt_path, #_project_issues_path, #_project_issues_url, #_project_news_path, #_report_time_entries_path, #_time_entries_path, #board_path

Methods included from Redmine::Pagination

#paginate, #paginator

Instance Method Details

#createObject


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'app/controllers/users_controller.rb', line 110

def create
  @user = User.new(:language => Setting.default_language,
                   :mail_notification => Setting.default_notification_option,
                   :admin => false)
  @user.safe_attributes = params[:user]
  unless @user.auth_source_id
    @user.password              = params[:user][:password]
    @user.password_confirmation = params[:user][:password_confirmation]
  end
  @user.pref.safe_attributes = params[:pref]

  if @user.save
    Mailer.(@user, @user.password) if params[:send_information]

    respond_to do |format|
      format.html do
        flash[:notice] =
          l(:notice_user_successful_create,
            :id => view_context.link_to(@user., user_path(@user)))
        if params[:continue]
          attrs = {:generate_password => @user.generate_password}
          redirect_to new_user_path(:user => attrs)
        else
          redirect_to edit_user_path(@user)
        end
      end
      format.api {render :action => 'show', :status => :created, :location => user_url(@user)}
    end
  else
    @auth_sources = AuthSource.all
    # Clear password input
    @user.password = @user.password_confirmation = nil

    respond_to do |format|
      format.html {render :action => 'new'}
      format.api  {render_validation_errors(@user)}
    end
  end
end

#destroyObject


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'app/controllers/users_controller.rb', line 196

def destroy
  return render_error status: 422 if @user == User.current && !@user.

  if api_request? || params[:lock] || params[:confirm] == @user.
    if params[:lock]
      @user.update_attribute :status, User::STATUS_LOCKED
    else
      @user.destroy
    end
    respond_to do |format|
      format.html {redirect_back_or_default(users_path)}
      format.api  {render_api_ok}
    end
  end
end

#editObject


150
151
152
153
# File 'app/controllers/users_controller.rb', line 150

def edit
  @auth_sources = AuthSource.all
  @membership ||= Member.new
end

#indexObject


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'app/controllers/users_controller.rb', line 40

def index
  sort_init 'login', 'asc'
  sort_update %w(login firstname lastname admin created_on last_login_on)

  case params[:format]
  when 'xml', 'json'
    @offset, @limit = api_offset_and_limit
  else
    @limit = per_page_option
  end

  @status = params[:status] || 1

  scope = User.logged.status(@status).preload(:email_address)
  scope = scope.like(params[:name]) if params[:name].present?
  scope = scope.in_group(params[:group_id]) if params[:group_id].present?

  @user_count = scope.count
  @user_pages = Paginator.new @user_count, @limit, params['page']
  @offset ||= @user_pages.offset
  @users =  scope.order(sort_clause).limit(@limit).offset(@offset).to_a

  respond_to do |format|
    format.html do
      @groups = Group.givable.sort
      render :layout => !request.xhr?
    end
    format.csv do
      send_data(users_to_csv(scope.order(sort_clause)), :type => 'text/csv; header=present', :filename => 'users.csv')
    end
    format.api
  end
end

#newObject


103
104
105
106
107
108
# File 'app/controllers/users_controller.rb', line 103

def new
  @user = User.new(:language => Setting.default_language,
                   :mail_notification => Setting.default_notification_option)
  @user.safe_attributes = params[:user]
  @auth_sources = AuthSource.all
end

#showObject


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'app/controllers/users_controller.rb', line 74

def show
  unless @user.visible?
    render_404
    return
  end

  # show projects based on current user visibility
  @memberships = @user.memberships.preload(:roles, :project).where(Project.visible_condition(User.current)).to_a

  @issue_counts = {}
  @issue_counts[:assigned] = {
    :total  => Issue.visible.assigned_to(@user).count,
    :open   => Issue.visible.open.assigned_to(@user).count
  }
  @issue_counts[:reported] = {
    :total  => Issue.visible.where(:author_id => @user.id).count,
    :open   => Issue.visible.open.where(:author_id => @user.id).count
  }

  respond_to do |format|
    format.html do
      events = Redmine::Activity::Fetcher.new(User.current, :author => @user).events(nil, nil, :limit => 10)
      @events_by_day = events.group_by {|event| User.current.time_to_date(event.event_datetime)}
      render :layout => 'base'
    end
    format.api
  end
end

#updateObject


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'app/controllers/users_controller.rb', line 155

def update
  is_updating_password = params[:user][:password].present? && (@user.auth_source_id.nil? || params[:user][:auth_source_id].blank?)
  if is_updating_password
    @user.password, @user.password_confirmation = params[:user][:password], params[:user][:password_confirmation]
  end
  @user.safe_attributes = params[:user]
  # Was the account actived ? (do it before User#save clears the change)
  was_activated = (@user.status_change == [User::STATUS_REGISTERED, User::STATUS_ACTIVE])
  # TODO: Similar to My#account
  @user.pref.safe_attributes = params[:pref]

  if @user.save
    @user.pref.save

    Mailer.deliver_password_updated(@user, User.current) if is_updating_password
    if was_activated
      Mailer.(@user)
    elsif @user.active? && params[:send_information] && @user != User.current
      Mailer.(@user, @user.password)
    end

    respond_to do |format|
      format.html do
        flash[:notice] = l(:notice_successful_update)
        redirect_to_referer_or edit_user_path(@user)
      end
      format.api  {render_api_ok}
    end
  else
    @auth_sources = AuthSource.all
    @membership ||= Member.new
    # Clear password input
    @user.password = @user.password_confirmation = nil

    respond_to do |format|
      format.html {render :action => :edit}
      format.api  {render_validation_errors(@user)}
    end
  end
end