Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1295: #
Chris@1295: # This program is free software; you can redistribute it and/or
Chris@1295: # modify it under the terms of the GNU General Public License
Chris@1295: # as published by the Free Software Foundation; either version 2
Chris@1295: # of the License, or (at your option) any later version.
Chris@1295: #
Chris@1295: # This program is distributed in the hope that it will be useful,
Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1295: # GNU General Public License for more details.
Chris@1295: #
Chris@1295: # You should have received a copy of the GNU General Public License
Chris@1295: # along with this program; if not, write to the Free Software
Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1295: 
Chris@1295: class TimeEntry < ActiveRecord::Base
Chris@1295:   include Redmine::SafeAttributes
Chris@1295:   # could have used polymorphic association
Chris@1295:   # project association here allows easy loading of time entries at project level with one database trip
Chris@1295:   belongs_to :project
Chris@1295:   belongs_to :issue
Chris@1295:   belongs_to :user
Chris@1295:   belongs_to :activity, :class_name => 'TimeEntryActivity', :foreign_key => 'activity_id'
Chris@1295: 
Chris@1295:   attr_protected :project_id, :user_id, :tyear, :tmonth, :tweek
Chris@1295: 
Chris@1295:   acts_as_customizable
Chris@1295:   acts_as_event :title => Proc.new {|o| "#{l_hours(o.hours)} (#{(o.issue || o.project).event_title})"},
Chris@1295:                 :url => Proc.new {|o| {:controller => 'timelog', :action => 'index', :project_id => o.project, :issue_id => o.issue}},
Chris@1295:                 :author => :user,
Chris@1295:                 :description => :comments
Chris@1295: 
Chris@1295:   acts_as_activity_provider :timestamp => "#{table_name}.created_on",
Chris@1295:                             :author_key => :user_id,
Chris@1295:                             :find_options => {:include => :project}
Chris@1295: 
Chris@1295:   validates_presence_of :user_id, :activity_id, :project_id, :hours, :spent_on
Chris@1295:   validates_numericality_of :hours, :allow_nil => true, :message => :invalid
Chris@1295:   validates_length_of :comments, :maximum => 255, :allow_nil => true
Chris@1295:   before_validation :set_project_if_nil
Chris@1295:   validate :validate_time_entry
Chris@1295: 
Chris@1295:   scope :visible, lambda {|*args| {
Chris@1295:     :include => :project,
Chris@1295:     :conditions => Project.allowed_to_condition(args.shift || User.current, :view_time_entries, *args)
Chris@1295:   }}
Chris@1295:   scope :on_issue, lambda {|issue| {
Chris@1295:     :include => :issue,
Chris@1295:     :conditions => "#{Issue.table_name}.root_id = #{issue.root_id} AND #{Issue.table_name}.lft >= #{issue.lft} AND #{Issue.table_name}.rgt <= #{issue.rgt}"
Chris@1295:   }}
Chris@1295:   scope :on_project, lambda {|project, include_subprojects| {
Chris@1295:     :include => :project,
Chris@1295:     :conditions => project.project_condition(include_subprojects)
Chris@1295:   }}
Chris@1295:   scope :spent_between, lambda {|from, to|
Chris@1295:     if from && to
Chris@1295:      {:conditions => ["#{TimeEntry.table_name}.spent_on BETWEEN ? AND ?", from, to]}
Chris@1295:     elsif from
Chris@1295:      {:conditions => ["#{TimeEntry.table_name}.spent_on >= ?", from]}
Chris@1295:     elsif to
Chris@1295:      {:conditions => ["#{TimeEntry.table_name}.spent_on <= ?", to]}
Chris@1295:     else
Chris@1295:      {}
Chris@1295:     end
Chris@1295:   }
Chris@1295: 
Chris@1295:   safe_attributes 'hours', 'comments', 'issue_id', 'activity_id', 'spent_on', 'custom_field_values', 'custom_fields'
Chris@1295: 
Chris@1295:   def initialize(attributes=nil, *args)
Chris@1295:     super
Chris@1295:     if new_record? && self.activity.nil?
Chris@1295:       if default_activity = TimeEntryActivity.default
Chris@1295:         self.activity_id = default_activity.id
Chris@1295:       end
Chris@1295:       self.hours = nil if hours == 0
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def set_project_if_nil
Chris@1295:     self.project = issue.project if issue && project.nil?
Chris@1295:   end
Chris@1295: 
Chris@1295:   def validate_time_entry
Chris@1295:     errors.add :hours, :invalid if hours && (hours < 0 || hours >= 1000)
Chris@1295:     errors.add :project_id, :invalid if project.nil?
Chris@1295:     errors.add :issue_id, :invalid if (issue_id && !issue) || (issue && project!=issue.project)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def hours=(h)
Chris@1295:     write_attribute :hours, (h.is_a?(String) ? (h.to_hours || h) : h)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def hours
Chris@1295:     h = read_attribute(:hours)
Chris@1295:     if h.is_a?(Float)
Chris@1295:       h.round(2)
Chris@1295:     else
Chris@1295:       h
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   # tyear, tmonth, tweek assigned where setting spent_on attributes
Chris@1295:   # these attributes make time aggregations easier
Chris@1295:   def spent_on=(date)
Chris@1295:     super
Chris@1295:     if spent_on.is_a?(Time)
Chris@1295:       self.spent_on = spent_on.to_date
Chris@1295:     end
Chris@1295:     self.tyear = spent_on ? spent_on.year : nil
Chris@1295:     self.tmonth = spent_on ? spent_on.month : nil
Chris@1295:     self.tweek = spent_on ? Date.civil(spent_on.year, spent_on.month, spent_on.day).cweek : nil
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns true if the time entry can be edited by usr, otherwise false
Chris@1295:   def editable_by?(usr)
Chris@1295:     (usr == user && usr.allowed_to?(:edit_own_time_entries, project)) || usr.allowed_to?(:edit_time_entries, project)
Chris@1295:   end
Chris@1295: end