jro_apps/redmine Commit - r2675:211b13c9ec4d

Added plugin hook, :controller_timelog_edit_before_save. (#3341)...

Eric Davis -

r2675:211b13c9ec4d

parent child

Context file:

r2675:211b13c9ec4d

Collapse all files

app/controllers/timelog_controller.rb +3 0

              # redMine - project management software
              # Copyright (C) 2006-2007  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.
              class TimelogController < ApplicationController
                menu_item :issues
                before_filter :find_project, :authorize, :only => [:edit, :destroy]
                before_filter :find_optional_project, :only => [:report, :details]
                verify :method => :post, :only => :destroy, :redirect_to => { :action => :details }
                helper :sort
                include SortHelper
                helper :issues
                include TimelogHelper
                helper :custom_fields
                include CustomFieldsHelper
                def report
                  @available_criterias = { 'project' => {:sql => "#{TimeEntry.table_name}.project_id",
                                                        :klass => Project,
                                                        :label => :label_project},
                                           'version' => {:sql => "#{Issue.table_name}.fixed_version_id",
                                                        :klass => Version,
                                                        :label => :label_version},
                                           'category' => {:sql => "#{Issue.table_name}.category_id",
                                                          :klass => IssueCategory,
                                                          :label => :field_category},
                                           'member' => {:sql => "#{TimeEntry.table_name}.user_id",
                                                       :klass => User,
                                                       :label => :label_member},
                                           'tracker' => {:sql => "#{Issue.table_name}.tracker_id",
                                                        :klass => Tracker,
                                                        :label => :label_tracker},
                                           'activity' => {:sql => "#{TimeEntry.table_name}.activity_id",
                                                         :klass => Enumeration,
                                                         :label => :label_activity},
                                           'issue' => {:sql => "#{TimeEntry.table_name}.issue_id",
                                                       :klass => Issue,
                                                       :label => :label_issue}
                                         }
                  # Add list and boolean custom fields as available criterias
                  custom_fields = (@project.nil? ? IssueCustomField.for_all : @project.all_issue_custom_fields)
                  custom_fields.select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
                    @available_criterias["cf_#{cf.id}"] = {:sql => "(SELECT c.value FROM #{CustomValue.table_name} c WHERE c.custom_field_id = #{cf.id} AND c.customized_type = 'Issue' AND c.customized_id = #{Issue.table_name}.id)",
                                                           :format => cf.field_format,
                                                           :label => cf.name}
                  end if @project
                  # Add list and boolean time entry custom fields
                  TimeEntryCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
                    @available_criterias["cf_#{cf.id}"] = {:sql => "(SELECT c.value FROM #{CustomValue.table_name} c WHERE c.custom_field_id = #{cf.id} AND c.customized_type = 'TimeEntry' AND c.customized_id = #{TimeEntry.table_name}.id)",
                                                           :format => cf.field_format,
                                                           :label => cf.name}
                  end
                  @criterias = params[:criterias] || []
                  @criterias = @criterias.select{|criteria| @available_criterias.has_key? criteria}
                  @criterias.uniq!
                  @criterias = @criterias[0,3]
                  @columns = (params[:columns] && %w(year month week day).include?(params[:columns])) ? params[:columns] : 'month'
                  retrieve_date_range
                  unless @criterias.empty?
                    sql_select = @criterias.collect{|criteria| @available_criterias[criteria][:sql] + " AS " + criteria}.join(', ')
                    sql_group_by = @criterias.collect{|criteria| @available_criterias[criteria][:sql]}.join(', ')
                    sql = "SELECT #{sql_select}, tyear, tmonth, tweek, spent_on, SUM(hours) AS hours"
                    sql << " FROM #{TimeEntry.table_name}"
                    sql << " LEFT JOIN #{Issue.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id"
                    sql << " LEFT JOIN #{Project.table_name} ON #{TimeEntry.table_name}.project_id = #{Project.table_name}.id"
                    sql << " WHERE"
                    sql << " (%s) AND" % @project.project_condition(Setting.display_subprojects_issues?) if @project
                    sql << " (%s) AND" % Project.allowed_to_condition(User.current, :view_time_entries)
                    sql << " (spent_on BETWEEN '%s' AND '%s')" % [ActiveRecord::Base.connection.quoted_date(@from.to_time), ActiveRecord::Base.connection.quoted_date(@to.to_time)]
                    sql << " GROUP BY #{sql_group_by}, tyear, tmonth, tweek, spent_on"
                    @hours = ActiveRecord::Base.connection.select_all(sql)
                    @hours.each do |row|
                      case @columns
                      when 'year'
                        row['year'] = row['tyear']
                      when 'month'
                        row['month'] = "#{row['tyear']}-#{row['tmonth']}"
                      when 'week'
                        row['week'] = "#{row['tyear']}-#{row['tweek']}"
                      when 'day'
                        row['day'] = "#{row['spent_on']}"
                      end
                    end
                    @total_hours = @hours.inject(0) {|s,k| s = s + k['hours'].to_f}
                    @periods = []
                    # Date#at_beginning_of_ not supported in Rails 1.2.x
                    date_from = @from.to_time
                    # 100 columns max
                    while date_from <= @to.to_time && @periods.length < 100
                      case @columns
                      when 'year'
                        @periods << "#{date_from.year}"
                        date_from = (date_from + 1.year).at_beginning_of_year
                      when 'month'
                        @periods << "#{date_from.year}-#{date_from.month}"
                        date_from = (date_from + 1.month).at_beginning_of_month
                      when 'week'
                        @periods << "#{date_from.year}-#{date_from.to_date.cweek}"
                        date_from = (date_from + 7.day).at_beginning_of_week
                      when 'day'
                        @periods << "#{date_from.to_date}"
                        date_from = date_from + 1.day
                      end
                    end
                  end
                  respond_to do |format|
                    format.html { render :layout => !request.xhr? }
                    format.csv  { send_data(report_to_csv(@criterias, @periods, @hours).read, :type => 'text/csv; header=present', :filename => 'timelog.csv') }
                  end
                end
                def details
                  sort_init 'spent_on', 'desc'
                  sort_update 'spent_on' => 'spent_on',
                              'user' => 'user_id',
                              'activity' => 'activity_id',
                              'project' => "#{Project.table_name}.name",
                              'issue' => 'issue_id',
                              'hours' => 'hours'
                  cond = ARCondition.new
                  if @project.nil?
                    cond << Project.allowed_to_condition(User.current, :view_time_entries)
                  elsif @issue.nil?
                    cond << @project.project_condition(Setting.display_subprojects_issues?)
                  else
                    cond << ["#{TimeEntry.table_name}.issue_id = ?", @issue.id]
                  end
                  retrieve_date_range
                  cond << ['spent_on BETWEEN ? AND ?', @from, @to]
                  TimeEntry.visible_by(User.current) do
                    respond_to do |format|
                      format.html {
                        # Paginate results
                        @entry_count = TimeEntry.count(:include => :project, :conditions => cond.conditions)
                        @entry_pages = Paginator.new self, @entry_count, per_page_option, params['page']
                        @entries = TimeEntry.find(:all,
                                                  :include => [:project, :activity, :user, {:issue => :tracker}],
                                                  :conditions => cond.conditions,
                                                  :order => sort_clause,
                                                  :limit  =>  @entry_pages.items_per_page,
                                                  :offset =>  @entry_pages.current.offset)
                        @total_hours = TimeEntry.sum(:hours, :include => :project, :conditions => cond.conditions).to_f
                        render :layout => !request.xhr?
                      }
                      format.atom {
                        entries = TimeEntry.find(:all,
                                                 :include => [:project, :activity, :user, {:issue => :tracker}],
                                                 :conditions => cond.conditions,
                                                 :order => "#{TimeEntry.table_name}.created_on DESC",
                                                 :limit => Setting.feeds_limit.to_i)
                        render_feed(entries, :title => l(:label_spent_time))
                      }
                      format.csv {
                        # Export all entries
                        @entries = TimeEntry.find(:all,
                                                  :include => [:project, :activity, :user, {:issue => [:tracker, :assigned_to, :priority]}],
                                                  :conditions => cond.conditions,
                                                  :order => sort_clause)
                        send_data(entries_to_csv(@entries).read, :type => 'text/csv; header=present', :filename => 'timelog.csv')
                      }
                    end
                  end
                end
                def edit
                  render_403 and return if @time_entry && !@time_entry.editable_by?(User.current)
                  @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => Date.today)
                  @time_entry.attributes = params[:time_entry]
+                 call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
                  if request.post? and @time_entry.save
                    flash[:notice] = l(:notice_successful_update)
                    redirect_back_or_default :action => 'details', :project_id => @time_entry.project
                    return
                  end
                end
                def destroy
                  render_404 and return unless @time_entry
                  render_403 and return unless @time_entry.editable_by?(User.current)
                  @time_entry.destroy
                  flash[:notice] = l(:notice_successful_delete)
                  redirect_to :back
                rescue ::ActionController::RedirectBackError
                  redirect_to :action => 'details', :project_id => @time_entry.project
                end
              private
                def find_project
                  if params[:id]
                    @time_entry = TimeEntry.find(params[:id])
                    @project = @time_entry.project
                  elsif params[:issue_id]
                    @issue = Issue.find(params[:issue_id])
                    @project = @issue.project
                  elsif params[:project_id]
                    @project = Project.find(params[:project_id])
                  else
                    render_404
                    return false
                  end
                rescue ActiveRecord::RecordNotFound
                  render_404
                end
                def find_optional_project
                  if !params[:issue_id].blank?
                    @issue = Issue.find(params[:issue_id])
                    @project = @issue.project
                  elsif !params[:project_id].blank?
                    @project = Project.find(params[:project_id])
                  end
                  deny_access unless User.current.allowed_to?(:view_time_entries, @project, :global => true)
                end
                # Retrieves the date range based on predefined ranges or specific from/to param dates
                def retrieve_date_range
                  @free_period = false
                  @from, @to = nil, nil
                  if params[:period_type] == '1' || (params[:period_type].nil? && !params[:period].nil?)
                    case params[:period].to_s
                    when 'today'
                      @from = @to = Date.today
                    when 'yesterday'
                      @from = @to = Date.today - 1
                    when 'current_week'
                      @from = Date.today - (Date.today.cwday - 1)%7
                      @to = @from + 6
                    when 'last_week'
                      @from = Date.today - 7 - (Date.today.cwday - 1)%7
                      @to = @from + 6
                    when '7_days'
                      @from = Date.today - 7
                      @to = Date.today
                    when 'current_month'
                      @from = Date.civil(Date.today.year, Date.today.month, 1)
                      @to = (@from >> 1) - 1
                    when 'last_month'
                      @from = Date.civil(Date.today.year, Date.today.month, 1) << 1
                      @to = (@from >> 1) - 1
                    when '30_days'
                      @from = Date.today - 30
                      @to = Date.today
                    when 'current_year'
                      @from = Date.civil(Date.today.year, 1, 1)
                      @to = Date.civil(Date.today.year, 12, 31)
                    end
                  elsif params[:period_type] == '2' || (params[:period_type].nil? && (!params[:from].nil? || !params[:to].nil?))
                    begin; @from = params[:from].to_s.to_date unless params[:from].blank?; rescue; end
                    begin; @to = params[:to].to_s.to_date unless params[:to].blank?; rescue; end
                    @free_period = true
                  else
                    # default
                  end
                  @from, @to = @to, @from if @from && @to && @from > @to
                  @from ||= (TimeEntry.minimum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries)) || Date.today) - 1
                  @to   ||= (TimeEntry.maximum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries)) || Date.today)
                end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages