Class: TimelogController

Inherits:
ApplicationController show all
Includes:
CustomFieldsHelper, QueriesHelper, TimelogHelper
Defined in:
app/controllers/timelog_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 QueriesHelper

#available_block_columns_tags, #available_display_types_tags, #available_totalable_columns_tags, #column_content, #column_header, #column_value, #csv_content, #csv_value, #filters_options_for_select, #group_by_column_select_tag, #grouped_query_results, #link_to_clear_query, #query_as_hidden_field_tags, #query_available_inline_columns_options, #query_columns_hidden_tags, #query_filters_hidden_tags, #query_hidden_sort_tag, #query_hidden_tags, #query_links, #query_selected_inline_columns_options, #query_to_csv, #render_query_columns_selection, #render_query_totals, #render_sidebar_queries, #retrieve_query, #retrieve_query_from_session, #sidebar_queries, #total_tag

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 TimelogHelper

#activity_collection_for_select_options, #cancel_button_tag_for_time_entry, #format_criteria_value, #report_criteria_to_csv, #report_to_csv, #select_hours, #sum_hours, #user_collection_for_select_options

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_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

#bulk_editObject


181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'app/controllers/timelog_controller.rb', line 181

def bulk_edit
  @target_projects = Project.allowed_to(:log_time).to_a
  @custom_fields = TimeEntry.first.available_custom_fields.select {|field| field.format.bulk_edit_supported}
  if params[:time_entry]
    @target_project = @target_projects.detect {|p| p.id.to_s == params[:time_entry][:project_id].to_s}
  end
  if @target_project
    @available_activities = @target_project.activities
  else
    @available_activities = @projects.map(&:activities).reduce(:&)
  end
  @time_entry_params = params[:time_entry] || {}
  @time_entry_params[:custom_field_values] ||= {}
end

#bulk_updateObject


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'app/controllers/timelog_controller.rb', line 196

def bulk_update
  attributes = parse_params_for_bulk_update(params[:time_entry])

  unsaved_time_entries = []
  saved_time_entries = []

  @time_entries.each do |time_entry|
    time_entry.reload
    time_entry.safe_attributes = attributes
    call_hook(
      :controller_time_entries_bulk_edit_before_save,
      {:params => params, :time_entry => time_entry}
    )
    if time_entry.save
      saved_time_entries << time_entry
    else
      unsaved_time_entries << time_entry
    end
  end

  if unsaved_time_entries.empty?
    flash[:notice] = l(:notice_successful_update) unless saved_time_entries.empty?
    redirect_back_or_default project_time_entries_path(@projects.first)
  else
    @saved_time_entries = @time_entries
    @unsaved_time_entries = unsaved_time_entries
    @time_entries = TimeEntry.where(:id => unsaved_time_entries.map(&:id)).
      preload(:project => :time_entry_activities).
      preload(:user).to_a

    bulk_edit
    render :action => 'bulk_edit'
  end
end

#createObject


105
106
107
108
109
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
149
150
151
152
153
154
# File 'app/controllers/timelog_controller.rb', line 105

def create
  @time_entry ||=
    TimeEntry.new(:project => @project, :issue => @issue,
                  :author => User.current, :user => User.current,
                  :spent_on => User.current.today)
  @time_entry.safe_attributes = params[:time_entry]
  if @time_entry.project && !User.current.allowed_to?(:log_time, @time_entry.project)
    render_403
    return
  end

  call_hook(:controller_timelog_edit_before_save,
            {:params => params, :time_entry => @time_entry})

  if @time_entry.save
    respond_to do |format|
      format.html do
        flash[:notice] = l(:notice_successful_create)
        if params[:continue]
          options = {
            :time_entry => {
              :project_id => params[:time_entry][:project_id],
              :issue_id => @time_entry.issue_id,
              :spent_on => @time_entry.spent_on,
              :activity_id => @time_entry.activity_id
            },
            :back_url => params[:back_url]
          }
          if params[:project_id] && @time_entry.project
            redirect_to new_project_time_entry_path(@time_entry.project, options)
          elsif params[:issue_id] && @time_entry.issue
            redirect_to new_issue_time_entry_path(@time_entry.issue, options)
          else
            redirect_to new_time_entry_path(options)
          end
        else
          redirect_back_or_default project_time_entries_path(@time_entry.project)
        end
      end
      format.api do
        render :action => 'show', :status => :created, :location => time_entry_url(@time_entry)
      end
    end
  else
    respond_to do |format|
      format.html {render :action => 'new'}
      format.api  {render_validation_errors(@time_entry)}
    end
  end
end

#destroyObject


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'app/controllers/timelog_controller.rb', line 231

def destroy
  destroyed = TimeEntry.transaction do
    @time_entries.each do |t|
      unless t.destroy && t.destroyed?
        raise ActiveRecord::Rollback
      end
    end
  end

  respond_to do |format|
    format.html do
      if destroyed
        flash[:notice] = l(:notice_successful_delete)
      else
        flash[:error] = l(:notice_unable_delete_time_entry)
      end
      redirect_back_or_default project_time_entries_path(@projects.first), :referer => true
    end
    format.api do
      if destroyed
        render_api_ok
      else
        render_validation_errors(@time_entries)
      end
    end
  end
end

#editObject


156
157
158
# File 'app/controllers/timelog_controller.rb', line 156

def edit
  @time_entry.safe_attributes = params[:time_entry]
end

#indexObject


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
73
# File 'app/controllers/timelog_controller.rb', line 44

def index
  retrieve_time_entry_query
  scope = time_entry_scope.
    preload(:issue => [:project, :tracker, :status, :assigned_to, :priority]).
    preload(:project, :user)

  respond_to do |format|
    format.html do
      @entry_count = scope.count
      @entry_pages = Paginator.new @entry_count, per_page_option, params['page']
      @entries = scope.offset(@entry_pages.offset).limit(@entry_pages.per_page).to_a

      render :layout => !request.xhr?
    end
    format.api do
      @entry_count = scope.count
      @offset, @limit = api_offset_and_limit
      @entries = scope.offset(@offset).limit(@limit).preload(:custom_values => :custom_field).to_a
    end
    format.atom do
      entries = scope.limit(Setting.feeds_limit.to_i).reorder("#{TimeEntry.table_name}.created_on DESC").to_a
      render_feed(entries, :title => l(:label_spent_time))
    end
    format.csv do
      # Export all entries
      @entries = scope.to_a
      send_data(query_to_csv(@entries, @query, params), :type => 'text/csv; header=present', :filename => 'timelog.csv')
    end
  end
end

#newObject


98
99
100
101
102
103
# File 'app/controllers/timelog_controller.rb', line 98

def new
  @time_entry ||=
    TimeEntry.new(:project => @project, :issue => @issue,
                  :author => User.current, :spent_on => User.current.today)
  @time_entry.safe_attributes = params[:time_entry]
end

#reportObject


75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'app/controllers/timelog_controller.rb', line 75

def report
  retrieve_time_entry_query
  scope = time_entry_scope

  @report = Redmine::Helpers::TimeReport.new(@project, @issue, params[:criteria], params[:columns], scope)

  respond_to do |format|
    format.html {render :layout => !request.xhr?}
    format.csv do
      send_data(report_to_csv(@report), :type => 'text/csv; header=present',
                :filename => 'timelog.csv')
    end
  end
end

#showObject


90
91
92
93
94
95
96
# File 'app/controllers/timelog_controller.rb', line 90

def show
  respond_to do |format|
    # TODO: Implement html response
    format.html {head 406}
    format.api
  end
end

#updateObject


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'app/controllers/timelog_controller.rb', line 160

def update
  @time_entry.safe_attributes = params[:time_entry]
  call_hook(:controller_timelog_edit_before_save,
            {:params => params, :time_entry => @time_entry})

  if @time_entry.save
    respond_to do |format|
      format.html do
        flash[:notice] = l(:notice_successful_update)
        redirect_back_or_default project_time_entries_path(@time_entry.project)
      end
      format.api  {render_api_ok}
    end
  else
    respond_to do |format|
      format.html {render :action => 'edit'}
      format.api  {render_validation_errors(@time_entry)}
    end
  end
end