Class: MyController

Inherits:
ApplicationController show all
Defined in:
app/controllers/my_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2016 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.

Since:

  • 0.4.0

Constant Summary collapse

BLOCKS =
{ 'issuesassignedtome' => :label_assigned_to_me_issues,
  'issuesreportedbyme' => :label_reported_issues,
  'issueswatched' => :label_watched_issues,
  'news' => :label_news_latest,
  'calendar' => :label_calendar,
  'documents' => :label_document_plural,
  'timelog' => :label_spent_time
}.merge(Redmine::Views::MyPage::Block.additional_blocks).freeze
DEFAULT_LAYOUT =
{  'left' => ['issuesassignedtome'],
   'right' => ['issuesreportedbyme']
}.freeze

Instance Method Summary collapse

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, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_optional_project, #find_project, #find_project_by_project_id, #find_project_from_association, #handle_unverified_request, #logged_user=, #logout_user, #missing_template, model_object, #parse_params_for_bulk_update, #parse_qvalues, #per_page_option, #query_statement_invalid, #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_item, #menu_items, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes

Methods included from RoutesHelper

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

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Pagination

#deprecated_paginate, #paginate, #paginator

Methods included from Redmine::I18n

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

Instance Method Details

#accountObject

Edit user's account



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'app/controllers/my_controller.rb', line 55

def 
  @user = User.current
  @pref = @user.pref
  if request.post?
    @user.safe_attributes = params[:user] if params[:user]
    @user.pref.attributes = params[:pref] if params[:pref]
    if @user.save
      @user.pref.save
      set_language_if_valid @user.language
      flash[:notice] = l(:notice_account_updated)
      redirect_to 
      return
    end
  end
end

#add_blockObject

Add a block to user's page The block is added on top of the page params : id of the block to add



161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'app/controllers/my_controller.rb', line 161

def add_block
  block = params[:block].to_s.underscore
  if block.present? && BLOCKS.key?(block)
    @user = User.current
    layout = @user.pref[:my_page_layout] || {}
    # remove if already present in a group
    %w(top left right).each {|f| (layout[f] ||= []).delete block }
    # add it on top
    layout['top'].unshift block
    @user.pref[:my_page_layout] = layout
    @user.pref.save
  end
  redirect_to my_page_layout_path
end

#destroyObject

Destroys user's account

Since:

  • 1.4.1



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'app/controllers/my_controller.rb', line 72

def destroy
  @user = User.current
  unless @user.
    redirect_to 
    return
  end

  if request.post? && params[:confirm]
    @user.destroy
    if @user.destroyed?
      logout_user
      flash[:notice] = l(:notice_account_deleted)
    end
    redirect_to home_path
  end
end

#indexObject



43
44
45
46
# File 'app/controllers/my_controller.rb', line 43

def index
  page
  render :action => 'page'
end

#order_blocksObject

Change blocks order on user's page params : group to order (top, left or right) params : array of block ids of the group



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

def order_blocks
  group = params[:group]
  @user = User.current
  if group.is_a?(String)
    group_items = (params["blocks"] || []).collect(&:underscore)
    group_items.each {|s| s.sub!(/^block_/, '')}
    if group_items and group_items.is_a? Array
      layout = @user.pref[:my_page_layout] || {}
      # remove group blocks if they are presents in other groups
      %w(top left right).each {|f|
        layout[f] = (layout[f] || []) - group_items
      }
      layout[group] = group_items
      @user.pref[:my_page_layout] = layout
      @user.pref.save
    end
  end
  render :nothing => true
end

#pageObject

Show user's page



49
50
51
52
# File 'app/controllers/my_controller.rb', line 49

def page
  @user = User.current
  @blocks = @user.pref[:my_page_layout] || DEFAULT_LAYOUT
end

#page_layoutObject

Deprecated.

Removed at 3.4.0

User's page layout configuration



147
148
149
150
151
152
153
154
155
156
# File 'app/controllers/my_controller.rb', line 147

def page_layout
  @user = User.current
  @blocks = @user.pref[:my_page_layout] || DEFAULT_LAYOUT.dup
  @block_options = []
  BLOCKS.each do |k, v|
    unless @blocks.values.flatten.include?(k)
      @block_options << [l("my.blocks.#{v}", :default => [v, v.to_s.humanize]), k.dasherize]
    end
  end
end

#passwordObject

Manage user's password

Since:

  • 0.6.0



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'app/controllers/my_controller.rb', line 90

def password
  @user = User.current
  unless @user.change_password_allowed?
    flash[:error] = l(:notice_can_t_change_password)
    redirect_to 
    return
  end
  if request.post?
    if !@user.check_password?(params[:password])
      flash.now[:error] = l(:notice_account_wrong_password)
    elsif params[:password] == params[:new_password]
      flash.now[:error] = l(:notice_new_password_must_be_different)
    else
      @user.password, @user.password_confirmation = params[:new_password], params[:new_password_confirmation]
      @user.must_change_passwd = false
      if @user.save
        # The session token was destroyed by the password change, generate a new one
        session[:tk] = @user.generate_session_token
        Mailer.password_updated(@user)
        flash[:notice] = l(:notice_account_password_updated)
        redirect_to 
      end
    end
  end
end

#remove_blockObject

Remove a block to user's page params : id of the block to remove



178
179
180
181
182
183
184
185
186
187
# File 'app/controllers/my_controller.rb', line 178

def remove_block
  block = params[:block].to_s.underscore
  @user = User.current
  # remove block in all groups
  layout = @user.pref[:my_page_layout] || {}
  %w(top left right).each {|f| (layout[f] ||= []).delete block }
  @user.pref[:my_page_layout] = layout
  @user.pref.save
  redirect_to my_page_layout_path
end

#reset_api_keyObject

Create a new API key

Since:

  • 0.9.0



134
135
136
137
138
139
140
141
142
143
144
# File 'app/controllers/my_controller.rb', line 134

def reset_api_key
  if request.post?
    if User.current.api_token
      User.current.api_token.destroy
      User.current.reload
    end
    User.current.api_key
    flash[:notice] = l(:notice_api_access_key_reseted)
  end
  redirect_to 
end

#reset_rss_keyObject

Create a new feeds key

Since:

  • 0.6.0



117
118
119
120
121
122
123
124
125
126
127
# File 'app/controllers/my_controller.rb', line 117

def reset_rss_key
  if request.post?
    if User.current.rss_token
      User.current.rss_token.destroy
      User.current.reload
    end
    User.current.rss_key
    flash[:notice] = l(:notice_feeds_access_key_reseted)
  end
  redirect_to 
end

#show_api_keyObject

Since:

  • 3.1.0



129
130
131
# File 'app/controllers/my_controller.rb', line 129

def show_api_key
  @user = User.current
end