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 Queries::WorkPackages
  module Common
    module ManualSorting
      ##
      # We depend on ordered_work_packages association
      # for determining sort and filter for manual sorting.
      #
      # We could restrict the join result with where(query_id: context.id) later
      # but that prevents the execution planner from optimizing on the explicit join clause.
      def ordered_work_packages_join(query)
        join_sql = <<-SQL
          LEFT OUTER JOIN
            ordered_work_packages
          ON
            ordered_work_packages.work_package_id = work_packages.id
            AND ordered_work_packages.query_id = :query_id
        SQL

        ::OpenProject::SqlSanitization
          .sanitize join_sql, query_id: query.id
      end
    end
  end
end