opf/openproject

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2024 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# 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.
#
# See COPYRIGHT and LICENSE files for more details.
#++

class TimeEntry < ApplicationRecord
  # 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 :work_package
  belongs_to :user
  belongs_to :activity, class_name: "TimeEntryActivity"
  belongs_to :rate, -> { where(type: %w[HourlyRate DefaultHourlyRate]) }, class_name: "Rate"
  belongs_to :logged_by, class_name: "User"

  acts_as_customizable

  acts_as_journalized

  validates_presence_of :user_id, :project_id, :spent_on
  validates_presence_of :hours, if: -> { !ongoing? }
  validates_numericality_of :hours, allow_nil: true, message: :invalid

  scope :on_work_packages, ->(work_packages) { where(work_package_id: work_packages) }

  extend ::TimeEntries::TimeEntryScopes
  include ::Scopes::Scoped
  include Entry::Costs
  include Entry::SplashedDates

  scopes :of_user_and_day,
         :ongoing

  # TODO: move into service
  before_save :update_costs

  register_journal_formatted_fields(:time_entry_hours, "hours")
  register_journal_formatted_fields(:time_entry_named_association, "user_id")
  register_journal_formatted_fields(:named_association, "work_package_id")
  register_journal_formatted_fields(:named_association, "activity_id")
  register_journal_formatted_fields(:plaintext, "comments")
  register_journal_formatted_fields(:plaintext, "spent_on")

  def self.update_all(updates, conditions = nil, options = {})
    # instead of a update_all, perform an individual update during work_package#move
    # to trigger the update of the costs based on new rates
    if conditions.respond_to?(:keys) && conditions.keys == [:work_package_id] && updates =~ /^project_id = (\d+)$/
      project_id = $1
      time_entries = TimeEntry.where(conditions)
      time_entries.each do |entry|
        entry.project_id = project_id
        entry.save!
      end
    else
      super
    end
  end

  def hours=(value)
    write_attribute :hours, (value.is_a?(String) ? (value.to_hours || value) : value)
  end

  # Returns true if the time entry can be edited by usr, otherwise false
  def editable_by?(usr)
    (usr == user && usr.allowed_in_work_package?(:edit_own_time_entries, work_package)) ||
      usr.allowed_in_project?(:edit_time_entries, project)
  end

  def current_rate
    user.rate_at(spent_on, project_id)
  end

  def visible_by?(usr)
    usr.allowed_in_project?(:view_time_entries, project) ||
      (user_id == usr.id && usr.allowed_in_work_package?(:view_own_time_entries, work_package))
  end

  def costs_visible_by?(usr)
    usr.allowed_in_project?(:view_hourly_rates, project) ||
      (user_id == usr.id && usr.allowed_in_project?(:view_own_hourly_rate, project))
  end

  private

  def cost_attribute
    hours
  end
end