Chris@0: # redMine - project management software
Chris@0: # Copyright (C) 2006-2007  Jean-Philippe Lang
Chris@0: #
Chris@0: # This program is free software; you can redistribute it and/or
Chris@0: # modify it under the terms of the GNU General Public License
Chris@0: # as published by the Free Software Foundation; either version 2
Chris@0: # of the License, or (at your option) any later version.
Chris@0: # 
Chris@0: # This program is distributed in the hope that it will be useful,
Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@0: # GNU General Public License for more details.
Chris@0: # 
Chris@0: # You should have received a copy of the GNU General Public License
Chris@0: # along with this program; if not, write to the Free Software
Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@0: 
Chris@0: class TimelogController < ApplicationController
Chris@0:   menu_item :issues
Chris@0:   before_filter :find_project, :authorize, :only => [:edit, :destroy]
Chris@0:   before_filter :find_optional_project, :only => [:report, :details]
Chris@0:   before_filter :load_available_criterias, :only => [:report]
Chris@0: 
Chris@0:   verify :method => :post, :only => :destroy, :redirect_to => { :action => :details }
Chris@0:   
Chris@0:   helper :sort
Chris@0:   include SortHelper
Chris@0:   helper :issues
Chris@0:   include TimelogHelper
Chris@0:   helper :custom_fields
Chris@0:   include CustomFieldsHelper
Chris@0:   
Chris@0:   def report
Chris@0:     @criterias = params[:criterias] || []
Chris@0:     @criterias = @criterias.select{|criteria| @available_criterias.has_key? criteria}
Chris@0:     @criterias.uniq!
Chris@0:     @criterias = @criterias[0,3]
Chris@0:     
Chris@0:     @columns = (params[:columns] && %w(year month week day).include?(params[:columns])) ? params[:columns] : 'month'
Chris@0:     
Chris@0:     retrieve_date_range
Chris@0:     
Chris@0:     unless @criterias.empty?
Chris@0:       sql_select = @criterias.collect{|criteria| @available_criterias[criteria][:sql] + " AS " + criteria}.join(', ')
Chris@0:       sql_group_by = @criterias.collect{|criteria| @available_criterias[criteria][:sql]}.join(', ')
Chris@0:       sql_condition = ''
Chris@0:       
Chris@0:       if @project.nil?
Chris@0:         sql_condition = Project.allowed_to_condition(User.current, :view_time_entries)
Chris@0:       elsif @issue.nil?
Chris@0:         sql_condition = @project.project_condition(Setting.display_subprojects_issues?)
Chris@0:       else
Chris@0:         sql_condition = "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
Chris@0:       end
Chris@0: 
Chris@0:       sql = "SELECT #{sql_select}, tyear, tmonth, tweek, spent_on, SUM(hours) AS hours"
Chris@0:       sql << " FROM #{TimeEntry.table_name}"
Chris@14:       sql << time_report_joins
Chris@0:       sql << " WHERE"
Chris@0:       sql << " (%s) AND" % sql_condition
Chris@0:       sql << " (spent_on BETWEEN '%s' AND '%s')" % [ActiveRecord::Base.connection.quoted_date(@from), ActiveRecord::Base.connection.quoted_date(@to)]
Chris@0:       sql << " GROUP BY #{sql_group_by}, tyear, tmonth, tweek, spent_on"
Chris@0:       
Chris@0:       @hours = ActiveRecord::Base.connection.select_all(sql)
Chris@0:       
Chris@0:       @hours.each do |row|
Chris@0:         case @columns
Chris@0:         when 'year'
Chris@0:           row['year'] = row['tyear']
Chris@0:         when 'month'
Chris@0:           row['month'] = "#{row['tyear']}-#{row['tmonth']}"
Chris@0:         when 'week'
Chris@0:           row['week'] = "#{row['tyear']}-#{row['tweek']}"
Chris@0:         when 'day'
Chris@0:           row['day'] = "#{row['spent_on']}"
Chris@0:         end
Chris@0:       end
Chris@0:       
Chris@0:       @total_hours = @hours.inject(0) {|s,k| s = s + k['hours'].to_f}
Chris@0:       
Chris@0:       @periods = []
Chris@0:       # Date#at_beginning_of_ not supported in Rails 1.2.x
Chris@0:       date_from = @from.to_time
Chris@0:       # 100 columns max
Chris@0:       while date_from <= @to.to_time && @periods.length < 100
Chris@0:         case @columns
Chris@0:         when 'year'
Chris@0:           @periods << "#{date_from.year}"
Chris@0:           date_from = (date_from + 1.year).at_beginning_of_year
Chris@0:         when 'month'
Chris@0:           @periods << "#{date_from.year}-#{date_from.month}"
Chris@0:           date_from = (date_from + 1.month).at_beginning_of_month
Chris@0:         when 'week'
Chris@0:           @periods << "#{date_from.year}-#{date_from.to_date.cweek}"
Chris@0:           date_from = (date_from + 7.day).at_beginning_of_week
Chris@0:         when 'day'
Chris@0:           @periods << "#{date_from.to_date}"
Chris@0:           date_from = date_from + 1.day
Chris@0:         end
Chris@0:       end
Chris@0:     end
Chris@0:     
Chris@0:     respond_to do |format|
Chris@0:       format.html { render :layout => !request.xhr? }
Chris@0:       format.csv  { send_data(report_to_csv(@criterias, @periods, @hours), :type => 'text/csv; header=present', :filename => 'timelog.csv') }
Chris@0:     end
Chris@0:   end
Chris@0:   
Chris@0:   def details
Chris@0:     sort_init 'spent_on', 'desc'
Chris@0:     sort_update 'spent_on' => 'spent_on',
Chris@0:                 'user' => 'user_id',
Chris@0:                 'activity' => 'activity_id',
Chris@0:                 'project' => "#{Project.table_name}.name",
Chris@0:                 'issue' => 'issue_id',
Chris@0:                 'hours' => 'hours'
Chris@0:     
Chris@0:     cond = ARCondition.new
Chris@0:     if @project.nil?
Chris@0:       cond << Project.allowed_to_condition(User.current, :view_time_entries)
Chris@0:     elsif @issue.nil?
Chris@0:       cond << @project.project_condition(Setting.display_subprojects_issues?)
Chris@0:     else
Chris@0:       cond << "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
Chris@0:     end
Chris@0:     
Chris@0:     retrieve_date_range
Chris@0:     cond << ['spent_on BETWEEN ? AND ?', @from, @to]
Chris@0: 
Chris@0:     TimeEntry.visible_by(User.current) do
Chris@0:       respond_to do |format|
Chris@0:         format.html {
Chris@0:           # Paginate results
Chris@0:           @entry_count = TimeEntry.count(:include => [:project, :issue], :conditions => cond.conditions)
Chris@0:           @entry_pages = Paginator.new self, @entry_count, per_page_option, params['page']
Chris@0:           @entries = TimeEntry.find(:all, 
Chris@0:                                     :include => [:project, :activity, :user, {:issue => :tracker}],
Chris@0:                                     :conditions => cond.conditions,
Chris@0:                                     :order => sort_clause,
Chris@0:                                     :limit  =>  @entry_pages.items_per_page,
Chris@0:                                     :offset =>  @entry_pages.current.offset)
Chris@0:           @total_hours = TimeEntry.sum(:hours, :include => [:project, :issue], :conditions => cond.conditions).to_f
Chris@0: 
Chris@0:           render :layout => !request.xhr?
Chris@0:         }
Chris@0:         format.atom {
Chris@0:           entries = TimeEntry.find(:all,
Chris@0:                                    :include => [:project, :activity, :user, {:issue => :tracker}],
Chris@0:                                    :conditions => cond.conditions,
Chris@0:                                    :order => "#{TimeEntry.table_name}.created_on DESC",
Chris@0:                                    :limit => Setting.feeds_limit.to_i)
Chris@0:           render_feed(entries, :title => l(:label_spent_time))
Chris@0:         }
Chris@0:         format.csv {
Chris@0:           # Export all entries
Chris@0:           @entries = TimeEntry.find(:all, 
Chris@0:                                     :include => [:project, :activity, :user, {:issue => [:tracker, :assigned_to, :priority]}],
Chris@0:                                     :conditions => cond.conditions,
Chris@0:                                     :order => sort_clause)
Chris@0:           send_data(entries_to_csv(@entries), :type => 'text/csv; header=present', :filename => 'timelog.csv')
Chris@0:         }
Chris@0:       end
Chris@0:     end
Chris@0:   end
Chris@0:   
Chris@0:   def edit
Chris@0:     (render_403; return) if @time_entry && !@time_entry.editable_by?(User.current)
Chris@0:     @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => User.current.today)
Chris@0:     @time_entry.attributes = params[:time_entry]
Chris@0:     
Chris@0:     call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
Chris@0:     
Chris@0:     if request.post? and @time_entry.save
Chris@0:       flash[:notice] = l(:notice_successful_update)
Chris@0:       redirect_back_or_default :action => 'details', :project_id => @time_entry.project
Chris@0:       return
Chris@0:     end    
Chris@0:   end
Chris@0:   
Chris@0:   def destroy
Chris@0:     (render_404; return) unless @time_entry
Chris@0:     (render_403; return) unless @time_entry.editable_by?(User.current)
Chris@0:     if @time_entry.destroy && @time_entry.destroyed?
Chris@0:       flash[:notice] = l(:notice_successful_delete)
Chris@0:     else
Chris@0:       flash[:error] = l(:notice_unable_delete_time_entry)
Chris@0:     end
Chris@0:     redirect_to :back
Chris@0:   rescue ::ActionController::RedirectBackError
Chris@0:     redirect_to :action => 'details', :project_id => @time_entry.project
Chris@0:   end
Chris@0: 
Chris@0: private
Chris@0:   def find_project
Chris@0:     if params[:id]
Chris@0:       @time_entry = TimeEntry.find(params[:id])
Chris@0:       @project = @time_entry.project
Chris@0:     elsif params[:issue_id]
Chris@0:       @issue = Issue.find(params[:issue_id])
Chris@0:       @project = @issue.project
Chris@0:     elsif params[:project_id]
Chris@0:       @project = Project.find(params[:project_id])
Chris@0:     else
Chris@0:       render_404
Chris@0:       return false
Chris@0:     end
Chris@0:   rescue ActiveRecord::RecordNotFound
Chris@0:     render_404
Chris@0:   end
Chris@0:   
Chris@0:   def find_optional_project
Chris@0:     if !params[:issue_id].blank?
Chris@0:       @issue = Issue.find(params[:issue_id])
Chris@0:       @project = @issue.project
Chris@0:     elsif !params[:project_id].blank?
Chris@0:       @project = Project.find(params[:project_id])
Chris@0:     end
Chris@0:     deny_access unless User.current.allowed_to?(:view_time_entries, @project, :global => true)
Chris@0:   end
Chris@0:   
Chris@0:   # Retrieves the date range based on predefined ranges or specific from/to param dates
Chris@0:   def retrieve_date_range
Chris@0:     @free_period = false
Chris@0:     @from, @to = nil, nil
Chris@0: 
Chris@0:     if params[:period_type] == '1' || (params[:period_type].nil? && !params[:period].nil?)
Chris@0:       case params[:period].to_s
Chris@0:       when 'today'
Chris@0:         @from = @to = Date.today
Chris@0:       when 'yesterday'
Chris@0:         @from = @to = Date.today - 1
Chris@0:       when 'current_week'
Chris@0:         @from = Date.today - (Date.today.cwday - 1)%7
Chris@0:         @to = @from + 6
Chris@0:       when 'last_week'
Chris@0:         @from = Date.today - 7 - (Date.today.cwday - 1)%7
Chris@0:         @to = @from + 6
Chris@0:       when '7_days'
Chris@0:         @from = Date.today - 7
Chris@0:         @to = Date.today
Chris@0:       when 'current_month'
Chris@0:         @from = Date.civil(Date.today.year, Date.today.month, 1)
Chris@0:         @to = (@from >> 1) - 1
Chris@0:       when 'last_month'
Chris@0:         @from = Date.civil(Date.today.year, Date.today.month, 1) << 1
Chris@0:         @to = (@from >> 1) - 1
Chris@0:       when '30_days'
Chris@0:         @from = Date.today - 30
Chris@0:         @to = Date.today
Chris@0:       when 'current_year'
Chris@0:         @from = Date.civil(Date.today.year, 1, 1)
Chris@0:         @to = Date.civil(Date.today.year, 12, 31)
Chris@0:       end
Chris@0:     elsif params[:period_type] == '2' || (params[:period_type].nil? && (!params[:from].nil? || !params[:to].nil?))
Chris@0:       begin; @from = params[:from].to_s.to_date unless params[:from].blank?; rescue; end
Chris@0:       begin; @to = params[:to].to_s.to_date unless params[:to].blank?; rescue; end
Chris@0:       @free_period = true
Chris@0:     else
Chris@0:       # default
Chris@0:     end
Chris@0:     
Chris@0:     @from, @to = @to, @from if @from && @to && @from > @to
chris@22:     @from ||= (TimeEntry.earilest_date_for_project(@project) || Date.today)
chris@22:     @to   ||= (TimeEntry.latest_date_for_project(@project) || Date.today)
Chris@0:   end
Chris@0: 
Chris@0:   def load_available_criterias
Chris@0:     @available_criterias = { 'project' => {:sql => "#{TimeEntry.table_name}.project_id",
Chris@0:                                           :klass => Project,
Chris@0:                                           :label => :label_project},
Chris@0:                              'version' => {:sql => "#{Issue.table_name}.fixed_version_id",
Chris@0:                                           :klass => Version,
Chris@0:                                           :label => :label_version},
Chris@0:                              'category' => {:sql => "#{Issue.table_name}.category_id",
Chris@0:                                             :klass => IssueCategory,
Chris@0:                                             :label => :field_category},
Chris@0:                              'member' => {:sql => "#{TimeEntry.table_name}.user_id",
Chris@0:                                          :klass => User,
Chris@0:                                          :label => :label_member},
Chris@0:                              'tracker' => {:sql => "#{Issue.table_name}.tracker_id",
Chris@0:                                           :klass => Tracker,
Chris@0:                                           :label => :label_tracker},
Chris@0:                              'activity' => {:sql => "#{TimeEntry.table_name}.activity_id",
Chris@0:                                            :klass => TimeEntryActivity,
Chris@0:                                            :label => :label_activity},
Chris@0:                              'issue' => {:sql => "#{TimeEntry.table_name}.issue_id",
Chris@0:                                          :klass => Issue,
Chris@0:                                          :label => :label_issue}
Chris@0:                            }
Chris@0:     
Chris@0:     # Add list and boolean custom fields as available criterias
Chris@0:     custom_fields = (@project.nil? ? IssueCustomField.for_all : @project.all_issue_custom_fields)
Chris@0:     custom_fields.select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
Chris@0:       @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)",
Chris@0:                                              :format => cf.field_format,
Chris@0:                                              :label => cf.name}
Chris@0:     end if @project
Chris@0:     
Chris@0:     # Add list and boolean time entry custom fields
Chris@0:     TimeEntryCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
Chris@0:       @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)",
Chris@0:                                              :format => cf.field_format,
Chris@0:                                              :label => cf.name}
Chris@0:     end
Chris@0: 
Chris@0:     # Add list and boolean time entry activity custom fields
Chris@0:     TimeEntryActivityCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
Chris@0:       @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 = 'Enumeration' AND c.customized_id = #{TimeEntry.table_name}.activity_id)",
Chris@0:                                              :format => cf.field_format,
Chris@0:                                              :label => cf.name}
Chris@0:     end
Chris@0: 
Chris@0:     call_hook(:controller_timelog_available_criterias, { :available_criterias => @available_criterias, :project => @project })
Chris@0:     @available_criterias
Chris@0:   end
Chris@14: 
Chris@14:   def time_report_joins
Chris@14:     sql = ''
Chris@14:     sql << " LEFT JOIN #{Issue.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id"
Chris@14:     sql << " LEFT JOIN #{Project.table_name} ON #{TimeEntry.table_name}.project_id = #{Project.table_name}.id"
Chris@14:     call_hook(:controller_timelog_time_report_joins, {:sql => sql} )
Chris@14:     sql
Chris@14:   end
Chris@0: end