Extracted time report logic from the controller.

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@8026 e93f8b46-1217-0410-a6f0-8f06a7374b81

1 files changed, 164 insertions, 0 deletions

diff --git a/lib/redmine/helpers/time_report.rb b/lib/redmine/helpers/time_report.rb
new file mode 100644
index 000000000..528ef02fe
--- /dev/null
+++ b/lib/redmine/helpers/time_report.rb
@@ -0,0 +1,164 @@
+# Redmine - project management software
+# Copyright (C) 2006-2011  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.
+
+module Redmine
+  module Helpers
+    class TimeReport
+      attr_reader :criteria, :columns, :from, :to, :hours, :total_hours, :periods
+
+      def initialize(project, issue, criteria, columns, from, to)
+        @project = project
+        @issue = issue
+
+        @criteria = criteria || []
+        @criteria = @criteria.select{|criteria| available_criteria.has_key? criteria}
+        @criteria.uniq!
+        @criteria = @criteria[0,3]
+
+        @columns = (columns && %w(year month week day).include?(columns)) ? columns : 'month'
+        @from = from
+        @to = to
+
+        run
+      end
+
+      def available_criteria
+        @available_criteria || load_available_criteria
+      end
+
+      private
+
+      def run
+        unless @criteria.empty?
+          sql_select = @criteria.collect{|criteria| @available_criteria[criteria][:sql] + " AS " + criteria}.join(', ')
+          sql_group_by = @criteria.collect{|criteria| @available_criteria[criteria][:sql]}.join(', ')
+          sql_condition = ''
+
+          if @project.nil?
+            sql_condition = Project.allowed_to_condition(User.current, :view_time_entries)
+          elsif @issue.nil?
+            sql_condition = @project.project_condition(Setting.display_subprojects_issues?)
+          else
+            sql_condition = "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
+          end
+
+          sql = "SELECT #{sql_select}, tyear, tmonth, tweek, spent_on, SUM(hours) AS hours"
+          sql << " FROM #{TimeEntry.table_name}"
+          sql << time_report_joins
+          sql << " WHERE"
+          sql << " (%s) AND" % sql_condition
+          sql << " (spent_on BETWEEN '%s' AND '%s')" % [ActiveRecord::Base.connection.quoted_date(@from), ActiveRecord::Base.connection.quoted_date(@to)]
+          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
+      end
+
+      def load_available_criteria
+        @available_criteria = { '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 => TimeEntryActivity,
+                                               :label => :label_activity},
+                                 'issue' => {:sql => "#{TimeEntry.table_name}.issue_id",
+                                             :klass => Issue,
+                                             :label => :label_issue}
+                               }
+
+        # Add list and boolean custom fields as available criteria
+        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_criteria["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_criteria["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
+
+        # Add list and boolean time entry activity custom fields
+        TimeEntryActivityCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
+          @available_criteria["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)",
+                                                 :format => cf.field_format,
+                                                 :label => cf.name}
+        end
+
+        @available_criteria
+      end
+
+      def time_report_joins
+        sql = ''
+        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
+      end
+    end
+  end
+end