/**
 *    Copyright (C) 2024-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include "mongo/db/query/classic_runtime_planner_for_sbe/planner_interface.h"

#include "mongo/db/query/plan_executor_factory.h"
#include "mongo/db/query/stage_builder/sbe/builder.h"

namespace mongo::classic_runtime_planner_for_sbe {

PlannerBase::PlannerBase(PlannerDataForSBE plannerData) : _plannerData(std::move(plannerData)) {}

std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> PlannerBase::prepareSbePlanExecutor(
    std::unique_ptr<CanonicalQuery> canonicalQuery,
    std::unique_ptr<QuerySolution> solution,
    std::pair<std::unique_ptr<sbe::PlanStage>, stage_builder::PlanStageData> sbePlanAndData,
    bool isFromPlanCache,
    boost::optional<size_t> cachedPlanHash,
    std::unique_ptr<MultiPlanStage> classicRuntimePlannerStage) {
    const auto* expCtx = cq()->getExpCtxRaw();
    auto remoteCursors =
        expCtx->explain ? nullptr : search_helpers::getSearchRemoteCursors(cq()->cqPipeline());
    auto remoteExplains = expCtx->explain
        ? search_helpers::getSearchRemoteExplains(expCtx, cq()->cqPipeline())
        : nullptr;

    stage_builder::prepareSlotBasedExecutableTree(opCtx(),
                                                  sbePlanAndData.first.get(),
                                                  &sbePlanAndData.second,
                                                  *cq(),
                                                  collections(),
                                                  sbeYieldPolicy(),
                                                  isFromPlanCache,
                                                  remoteCursors.get());

    auto nss = cq()->nss();
    tassert(8551900,
            "Solution must be present if cachedPlanHash is present",
            solution != nullptr || !cachedPlanHash.has_value());
    return uassertStatusOK(plan_executor_factory::make(opCtx(),
                                                       std::move(canonicalQuery),
                                                       std::move(solution),
                                                       std::move(sbePlanAndData),
                                                       plannerOptions(),
                                                       std::move(nss),
                                                       extractSbeYieldPolicy(),
                                                       isFromPlanCache,
                                                       cachedPlanHash,
                                                       std::move(remoteCursors),
                                                       std::move(remoteExplains),
                                                       std::move(classicRuntimePlannerStage)));
}

std::unique_ptr<QuerySolution> PlannerBase::extendSolutionWithPipeline(
    std::unique_ptr<QuerySolution> solution) {
    if (cq()->cqPipeline().empty()) {
        return solution;
    }
    return QueryPlanner::extendWithAggPipeline(
        *cq(), std::move(solution), plannerParams().secondaryCollectionsInfo);
}

std::pair<std::unique_ptr<sbe::PlanStage>, stage_builder::PlanStageData>
PlannerBase::prepareSbePlanAndData(const QuerySolution& solution,
                                   boost::optional<std::string> replanReason) {
    auto sbePlanAndData = stage_builder::buildSlotBasedExecutableTree(
        opCtx(), collections(), *cq(), solution, sbeYieldPolicy());
    sbePlanAndData.second.replanReason = std::move(replanReason);
    return sbePlanAndData;
}
}  // namespace mongo::classic_runtime_planner_for_sbe
