time_entry.rb
160 lines
| 5.6 KiB
| text/x-ruby
|
RubyLexer
|
r5029 | # Redmine - project management software | ||
|
r14856 | # Copyright (C) 2006-2016 Jean-Philippe Lang | ||
|
r569 | # | ||
# 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. | ||||
|
r5700 | # | ||
|
r569 | # 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. | ||||
|
r5700 | # | ||
|
r569 | # 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. | ||||
|
r365 | class TimeEntry < ActiveRecord::Base | ||
|
r9016 | include Redmine::SafeAttributes | ||
|
r365 | # could have used polymorphic association | ||
# project association here allows easy loading of time entries at project level with one database trip | ||||
belongs_to :project | ||||
belongs_to :issue | ||||
belongs_to :user | ||||
|
r13102 | belongs_to :activity, :class_name => 'TimeEntryActivity' | ||
|
r5700 | |||
|
r13058 | attr_protected :user_id, :tyear, :tmonth, :tweek | ||
|
r1546 | |||
|
r1672 | acts_as_customizable | ||
|
r2763 | acts_as_event :title => Proc.new {|o| "#{l_hours(o.hours)} (#{(o.issue || o.project).event_title})"}, | ||
|
r4163 | :url => Proc.new {|o| {:controller => 'timelog', :action => 'index', :project_id => o.project, :issue_id => o.issue}}, | ||
|
r1546 | :author => :user, | ||
|
r10724 | :group => :issue, | ||
|
r1546 | :description => :comments | ||
|
r2763 | |||
acts_as_activity_provider :timestamp => "#{table_name}.created_on", | ||||
:author_key => :user_id, | ||||
|
r13589 | :scope => joins(:project).preload(:project) | ||
|
r2763 | |||
|
r365 | validates_presence_of :user_id, :activity_id, :project_id, :hours, :spent_on | ||
|
r2430 | validates_numericality_of :hours, :allow_nil => true, :message => :invalid | ||
|
r14239 | validates_length_of :comments, :maximum => 1024, :allow_nil => true | ||
|
r11242 | validates :spent_on, :date => true | ||
|
r7333 | before_validation :set_project_if_nil | ||
|
r7328 | validate :validate_time_entry | ||
|
r5700 | |||
|
r10723 | scope :visible, lambda {|*args| | ||
|
r13100 | joins(:project). | ||
|
r13893 | where(TimeEntry.visible_condition(args.shift || User.current, *args)) | ||
|
r10723 | } | ||
scope :on_issue, lambda {|issue| | ||||
|
r13100 | joins(:issue). | ||
where("#{Issue.table_name}.root_id = #{issue.root_id} AND #{Issue.table_name}.lft >= #{issue.lft} AND #{Issue.table_name}.rgt <= #{issue.rgt}") | ||||
|
r10723 | } | ||
|
r7965 | |||
|
r13058 | safe_attributes 'hours', 'comments', 'project_id', 'issue_id', 'activity_id', 'spent_on', 'custom_field_values', 'custom_fields' | ||
|
r9016 | |||
|
r13893 | # Returns a SQL conditions string used to find all time entries visible by the specified user | ||
def self.visible_condition(user, options={}) | ||||
Project.allowed_to_condition(user, :view_time_entries, options) do |role, user| | ||||
if role.time_entries_visibility == 'all' | ||||
nil | ||||
elsif role.time_entries_visibility == 'own' && user.id && user.logged? | ||||
"#{table_name}.user_id = #{user.id}" | ||||
else | ||||
'1=0' | ||||
end | ||||
end | ||||
end | ||||
# Returns true if user or current user is allowed to view the time entry | ||||
def visible?(user=nil) | ||||
(user || User.current).allowed_to?(:view_time_entries, self.project) do |role, user| | ||||
if role.time_entries_visibility == 'all' | ||||
true | ||||
elsif role.time_entries_visibility == 'own' | ||||
self.user == user | ||||
else | ||||
false | ||||
end | ||||
end | ||||
end | ||||
|
r8168 | def initialize(attributes=nil, *args) | ||
super | ||||
|
r1519 | if new_record? && self.activity.nil? | ||
|
r2677 | if default_activity = TimeEntryActivity.default | ||
|
r1519 | self.activity_id = default_activity.id | ||
end | ||||
|
r3118 | self.hours = nil if hours == 0 | ||
|
r1447 | end | ||
end | ||||
|
r5700 | |||
|
r12715 | def safe_attributes=(attrs, user=User.current) | ||
|
r13058 | if attrs | ||
attrs = super(attrs) | ||||
|
r13780 | if issue_id_changed? && issue | ||
|
r14414 | if issue.visible?(user) && user.allowed_to?(:log_time, issue.project) | ||
|
r13780 | if attrs[:project_id].blank? && issue.project_id != project_id | ||
self.project_id = issue.project_id | ||||
end | ||||
@invalid_issue_id = nil | ||||
else | ||||
@invalid_issue_id = issue_id | ||||
|
r13058 | end | ||
|
r12715 | end | ||
end | ||||
attrs | ||||
end | ||||
|
r7333 | def set_project_if_nil | ||
|
r365 | self.project = issue.project if issue && project.nil? | ||
end | ||||
|
r5700 | |||
|
r7328 | def validate_time_entry | ||
|
r2430 | errors.add :hours, :invalid if hours && (hours < 0 || hours >= 1000) | ||
errors.add :project_id, :invalid if project.nil? | ||||
|
r13780 | errors.add :issue_id, :invalid if (issue_id && !issue) || (issue && project!=issue.project) || @invalid_issue_id | ||
|
r13906 | errors.add :activity_id, :inclusion if activity_id_changed? && project && !project.activities.include?(activity) | ||
|
r365 | end | ||
|
r5700 | |||
|
r1305 | def hours=(h) | ||
|
r2249 | write_attribute :hours, (h.is_a?(String) ? (h.to_hours || h) : h) | ||
|
r1305 | end | ||
|
r5700 | |||
|
r8860 | def hours | ||
h = read_attribute(:hours) | ||||
if h.is_a?(Float) | ||||
h.round(2) | ||||
else | ||||
h | ||||
end | ||||
end | ||||
|
r365 | # tyear, tmonth, tweek assigned where setting spent_on attributes | ||
# these attributes make time aggregations easier | ||||
def spent_on=(date) | ||||
super | ||||
self.tyear = spent_on ? spent_on.year : nil | ||||
self.tmonth = spent_on ? spent_on.month : nil | ||||
|
r476 | self.tweek = spent_on ? Date.civil(spent_on.year, spent_on.month, spent_on.day).cweek : nil | ||
|
r1159 | end | ||
|
r5700 | |||
|
r1159 | # Returns true if the time entry can be edited by usr, otherwise false | ||
def editable_by?(usr) | ||||
|
r13893 | visible?(usr) && ( | ||
(usr == user && usr.allowed_to?(:edit_own_time_entries, project)) || usr.allowed_to?(:edit_time_entries, project) | ||||
) | ||||
|
r1159 | end | ||
|
r12981 | |||
# Returns the custom_field_values that can be edited by the given user | ||||
def editable_custom_field_values(user=nil) | ||||
visible_custom_field_values | ||||
end | ||||
# Returns the custom fields that can be edited by the given user | ||||
def editable_custom_fields(user=nil) | ||||
editable_custom_field_values(user).map(&:custom_field).uniq | ||||
end | ||||
|
r365 | end | ||