Class: TimelogController

Inherits:
ApplicationController show all
Includes:
CustomFieldsHelper, QueriesHelper, SortHelper, TimelogHelper
Defined in:
app/controllers/timelog_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2014 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::HEADING_RE, ApplicationHelper::MACROS_RE, ApplicationHelper::MACRO_SUB_RE, ApplicationHelper::TOC_RE

Constants included from CustomFieldsHelper

CustomFieldsHelper::CUSTOM_FIELDS_TABS

Instance Method Summary collapse

Methods included from QueriesHelper

#available_block_columns_tags, #column_content, #column_header, #column_value, #csv_content, #csv_value, #filters_options_for_select, #query_available_inline_columns_options, #query_columns_hidden_tags, #query_filters_hidden_tags, #query_hidden_tags, #query_selected_inline_columns_options, #query_to_csv, #render_query_columns_selection, #retrieve_query, #retrieve_query_from_session

Methods included from ApplicationHelper

#accesskey, #anchor, #api_meta, #authoring, #authorize_for, #avatar, #back_url, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #calendar_for, #catch_macros, #check_all_links, #checked_image, #context_menu, #current_theme, #delete_link, #due_date_distance_in_words, #email_delivery_enabled?, #error_messages_for, #favicon, #favicon_path, #favicon_url, #format_activity_day, #format_activity_description, #format_activity_title, #format_object, #format_version_name, #heads_for_theme, #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_function, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_project, #link_to_project_settings, #link_to_revision, #link_to_user, #link_to_version, #option_tag, #other_formats_links, #page_header_title, #parse_headings, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_sections, #parse_wiki_links, #preview_link, #principals_check_box_tags, #principals_options_for_select, #progress_bar, #project_tree, #project_tree_options_for_select, #raw_json, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_tabs, #reorder_links, #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::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_time, included, #l, #l_hours, #l_or_humanize, #languages_options, #ll, #month_name, #set_language_if_valid, #valid_languages

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

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_tag, #custom_field_tag_for_bulk_edit, #custom_field_tag_id, #custom_field_tag_name, #custom_field_tag_with_label, #custom_field_type_options, #edit_tag_style_tag, #format_value, #render_api_custom_values, #render_custom_field_format_partial, #render_custom_fields_tabs, #show_value

Methods included from TimelogHelper

#activity_collection_for_select_options, #format_criteria_value, #render_timelog_breadcrumb, #report_criteria_to_csv, #report_to_csv, #select_hours, #sum_hours

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, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_project, #find_project_by_project_id, #find_project_from_association, #force_logout_if_password_changed, #handle_unverified_request, #logged_user=, #logout_user, #missing_template, model_object, #parse_qvalues, #per_page_option, #query_statement_invalid, #redirect_back_or_default, #redirect_to_referer_or, #render_403, #render_404, #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::MenuManager::MenuController

#current_menu_item, included, #menu_items, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes, included

Methods included from RoutesHelper

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

Methods included from Redmine::Pagination

#deprecated_paginate, #paginate, #paginator

Instance Method Details

#bulk_editObject


171
172
173
174
# File 'app/controllers/timelog_controller.rb', line 171

def bulk_edit
  @available_activities = TimeEntryActivity.shared.active
  @custom_fields = TimeEntry.first.available_custom_fields
end

#bulk_updateObject


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'app/controllers/timelog_controller.rb', line 176

def bulk_update
  attributes = parse_params_for_bulk_time_entry_attributes(params)

  unsaved_time_entry_ids = []
  @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 })
    unless time_entry.save
      logger.info "time entry could not be updated: #{time_entry.errors.full_messages}" if logger && logger.info?
      # Keep unsaved time_entry ids to display them in flash error
      unsaved_time_entry_ids << time_entry.id
    end
  end
  set_flash_from_bulk_time_entry_save(@time_entries, unsaved_time_entry_ids)
  redirect_back_or_default project_time_entries_path(@projects.first)
end

#createObject


102
103
104
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
# File 'app/controllers/timelog_controller.rb', line 102

def create
  @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :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 {
        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,
              :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
      }
      format.api  { render :action => 'show', :status => :created, :location => time_entry_url(@time_entry) }
    end
  else
    respond_to do |format|
      format.html { render :action => 'new' }
      format.api  { render_validation_errors(@time_entry) }
    end
  end
end

#destroyObject


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

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 {
      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)
    }
    format.api  {
      if destroyed
        render_api_ok
      else
        render_validation_errors(@time_entries)
      end
    }
  end
end

#editObject


146
147
148
# File 'app/controllers/timelog_controller.rb', line 146

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

#indexObject


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

def index
  @query = TimeEntryQuery.build_from_params(params, :project => @project, :name => '_')

  sort_init(@query.sort_criteria.empty? ? [['spent_on', 'desc']] : @query.sort_criteria)
  sort_update(@query.sortable_columns)
  scope = time_entry_scope(:order => sort_clause).
    includes(:project, :user, :issue).
    preload(:issue => [:project, :tracker, :status, :assigned_to, :priority])

  respond_to do |format|
    format.html {
      @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
      @total_hours = scope.sum(:hours).to_f

      render :layout => !request.xhr?
    }
    format.api  {
      @entry_count = scope.count
      @offset, @limit = api_offset_and_limit
      @entries = scope.offset(@offset).limit(@limit).preload(:custom_values => :custom_field).to_a
    }
    format.atom {
      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))
    }
    format.csv {
      # 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

#newObject


97
98
99
100
# File 'app/controllers/timelog_controller.rb', line 97

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

#reportObject


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

def report
  @query = TimeEntryQuery.build_from_params(params, :project => @project, :name => '_')
  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  { send_data(report_to_csv(@report), :type => 'text/csv; header=present', :filename => 'timelog.csv') }
  end
end

#showObject


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

def show
  respond_to do |format|
    # TODO: Implement html response
    format.html { render :nothing => true, :status => 406 }
    format.api
  end
end

#updateObject


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'app/controllers/timelog_controller.rb', line 150

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 {
        flash[:notice] = l(:notice_successful_update)
        redirect_back_or_default project_time_entries_path(@time_entry.project)
      }
      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