/*    Copyright 2012 10gen Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include <vector>

#include "mongo/db/auth/action_set.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/privilege_parser.h"
#include "mongo/db/auth/resource_pattern.h"

namespace mongo {

    class Privilege;
    typedef std::vector<Privilege> PrivilegeVector;

    /**
     * A representation of the permission to perform a set of actions on a resource.
     */
    class Privilege {
    public:
        /**
         * Adds "privilegeToAdd" to "privileges", de-duping "privilegeToAdd" if the vector already
         * contains a privilege on the same resource.
         *
         * This method is the preferred way to add privileges to  privilege vectors.
         */
        static void addPrivilegeToPrivilegeVector(PrivilegeVector* privileges,
                                                  const Privilege& privilegeToAdd);


        Privilege() {};
        Privilege(const ResourcePattern& resource, const ActionType& action);
        Privilege(const ResourcePattern& resource, const ActionSet& actions);
        ~Privilege() {}

        const ResourcePattern& getResourcePattern() const { return _resource; }

        const ActionSet& getActions() const { return _actions; }

        void addActions(const ActionSet& actionsToAdd);
        void removeActions(const ActionSet& actionsToRemove);

        // Checks if the given action is present in the Privilege.
        bool includesAction(const ActionType& action) const;
        // Checks if the given actions are present in the Privilege.
        bool includesActions(const ActionSet& actions) const;

    private:

        ResourcePattern _resource;
        ActionSet _actions; // bitmask of actions this privilege grants
    };

} // namespace mongo
