/**
 *    Copyright (C) 2020-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.
 */


#pragma once

#include "mongo/bson/bsonobj.h"

namespace mongo {

class CurOp;
class OpDebug;
class OperationContext;

class ProfileFilter {
public:
    struct Args {
        Args(OperationContext* opCtx, const OpDebug& op, const CurOp& curop)
            : opCtx(opCtx), op(op), curop(curop) {}

        OperationContext* opCtx;
        const OpDebug& op;
        const CurOp& curop;
    };

    virtual ~ProfileFilter() = default;

    virtual bool matches(OperationContext*, const OpDebug&, const CurOp&) const = 0;
    virtual BSONObj serialize() const = 0;

    /**
     * Returns true if the profile filter depends on the given top-level field name and false
     * otherwise.
     */
    virtual bool dependsOn(StringData topLevelField) const = 0;

    /**
     * Thread-safe getter for the global 'ProfileFilter' default.
     */
    static std::shared_ptr<ProfileFilter> getDefault();

    /**
     * Thread-safe setter for the global 'ProfileFilter' default. Initially this is set from the
     * configuration file on startup.
     */
    static void setDefault(std::shared_ptr<ProfileFilter>);
};

}  // namespace mongo