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.
#++

module OpenProject::Backlogs::List
  extend ActiveSupport::Concern

  included do
    acts_as_list touch_on_update: false
    # acts as list adds a before destroy hook which messes
    # with the parent_id_was value
    skip_callback(:destroy, :before, :reload)

    # Reorder list, if work_package is removed from sprint
    before_update :fix_other_work_package_positions
    before_update :fix_own_work_package_position

    # Used by acts_list to limit the list to a certain subset within
    # the table.
    #
    # Also sanitize_sql seems to be unavailable in a sensible way. Therefore
    # we're using send to circumvent visibility work_packages.
    def scope_condition
      self.class.send(:sanitize_sql, ["project_id = ? AND version_id = ? AND type_id IN (?)",
                                      project_id, version_id, types])
    end

    include InstanceMethods
  end

  module InstanceMethods
    def move_after(prev_id)
      # Remove so the potential 'prev' has a correct position
      remove_from_list
      reload

      prev = self.class.find_by(id: prev_id.to_i)

      # If it should be the first story, move it to the 1st position
      if prev.blank?
        insert_at
        move_to_top

      # If its predecessor has no position, create an order on position
      # silently. This can happen when sorting inside a version for the first
      # time after backlogs was activated and there have already been items
      # inside the version at the time of backlogs activation
      elsif !prev.in_list?
        prev_pos = set_default_prev_positions_silently(prev)
        insert_at(prev_pos += 1)

      # There's a valid predecessor
      else
        insert_at(prev.position + 1)
      end
    end

    protected

    # Override acts_as_list implementation to avoid it calling save.
    # Calling save would remove the changes/saved_changes information.
    def set_list_position(new_position, _raise_exception_if_save_fails = false)
      update_columns(position: new_position)
    end

    def fix_other_work_package_positions
      if changes.slice("project_id", "type_id", "version_id").present?
        if changes.slice("project_id", "version_id").blank? and
           Story.types.include?(type_id.to_i) and
           Story.types.include?(type_id_was.to_i)
          return
        end

        if version_id_changed?
          restore_version_id = true
          new_version_id = version_id
          self.version_id = version_id_was
        end

        if type_id_changed?
          restore_type_id = true
          new_type_id = type_id
          self.type_id = type_id_was
        end

        if project_id_changed?
          restore_project_id = true
          # I've got no idea, why there's a difference between setting the
          # project via project= or via project_id=, but there is.
          new_project = project
          self.project = Project.find(project_id_was)
        end

        remove_from_list if is_story?

        if restore_project_id
          self.project = new_project
        end

        if restore_type_id
          self.type_id = new_type_id
        end

        if restore_version_id
          self.version_id = new_version_id
        end
      end
    end

    def fix_own_work_package_position
      if changes.slice("project_id", "type_id", "version_id").present?
        if changes.slice("project_id", "version_id").blank? and
           Story.types.include?(type_id.to_i) and
           Story.types.include?(type_id_was.to_i)
          return
        end

        if is_story? and version.present?
          assume_bottom_position
        else
          remove_from_list
        end
      end
    end

    def set_default_prev_positions_silently(prev)
      if prev.is_task?
        prev.version.rebuild_task_positions(prev)
      else
        prev.version.rebuild_story_positions(prev.project)
      end

      prev.reload.position
    end
  end
end