/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.jackrabbit.oak.security.authorization.evaluation;

import java.security.Principal;
import javax.jcr.security.AccessControlManager;
import javax.jcr.security.AccessControlPolicy;

import org.apache.jackrabbit.api.security.JackrabbitAccessControlList;
import org.apache.jackrabbit.commons.jackrabbit.authorization.AccessControlUtils;
import org.apache.jackrabbit.oak.AbstractSecurityTest;
import org.apache.jackrabbit.oak.api.ContentSession;
import org.apache.jackrabbit.oak.api.Root;
import org.apache.jackrabbit.oak.api.Tree;
import org.apache.jackrabbit.oak.plugins.tree.TreeUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.junit.After;
import org.junit.Before;

import static java.util.Objects.requireNonNull;
import static org.apache.jackrabbit.JcrConstants.NT_UNSTRUCTURED;

/**
 * Base class for all classes that attempt to test OAK API and OAK core functionality
 * in combination with permission evaluation
 */
public abstract class AbstractOakCoreTest extends AbstractSecurityTest {

    protected Principal testPrincipal;
    private ContentSession testSession;

    @Before
    @Override
    public void before() throws Exception {
        super.before();

        testPrincipal = getTestUser().getPrincipal();

        Tree a = TreeUtil.addChild(root.getTree("/"), "a", NT_UNSTRUCTURED);
        a.setProperty("aProp", "aValue");

        Tree b = TreeUtil.addChild(a, "b", NT_UNSTRUCTURED);
        b.setProperty("bProp", "bValue");
        // sibling
        Tree bb = TreeUtil.addChild(a, "bb", NT_UNSTRUCTURED);
        bb.setProperty("bbProp", "bbValue");

        Tree c = TreeUtil.addChild(b, "c", NT_UNSTRUCTURED);
        c.setProperty("cProp", "cValue");
        root.commit();
    }

    @After
    @Override
    public void after() throws Exception {
        try {
            // revert uncommited changes
            root.refresh();

            // clean up policies at the root node
            AccessControlManager acMgr = getAccessControlManager(root);
            AccessControlPolicy[] policies = acMgr.getPolicies("/");
            for (AccessControlPolicy policy : policies) {
                acMgr.removePolicy("/", policy);
            }

            // remove all test content
            root.getTree("/a").remove();
            root.commit();

            // release test session
            if (testSession != null) {
                testSession.close();
            }
        } finally {
            super.after();
        }
    }

    @NotNull
    protected ContentSession getTestSession() throws Exception {
        if (testSession == null) {
            testSession = createTestSession();
        }
        return testSession;
    }

    @NotNull
    protected Root getTestRoot() throws Exception {
        return getTestSession().getLatestRoot();
    }

    /**
     * Same as {@link #setupPermission(org.apache.jackrabbit.oak.api.Root, String, java.security.Principal, boolean, String...)}
     * where the specified root is the current root associated with the admin
     * session created in the test setup.
     *
     * @param path The path of the access controlled tree.
     * @param principal The principal for which new ACE is being created.
     * @param isAllow {@code true} if privileges are granted; {@code false} otherwise.
     * @param privilegeNames The privilege names.
     * @throws Exception If an error occurs.
     */
    protected void setupPermission(@Nullable String path,
                                   @NotNull Principal principal,
                                   boolean isAllow,
                                   @NotNull String... privilegeNames) throws Exception {
        setupPermission(root, path, principal, isAllow, privilegeNames);
    }

    /**
     * Setup simple allow/deny permissions (without restrictions).
     *
     * @param root The editing root.
     * @param path The path of the access controlled tree.
     * @param principal The principal for which new ACE is being created.
     * @param isAllow {@code true} if privileges are granted; {@code false} otherwise.
     * @param privilegeNames The privilege names.
     * @throws Exception If an error occurs.
     */
    protected void setupPermission(@NotNull Root root,
                                   @Nullable String path,
                                   @NotNull Principal principal,
                                   boolean isAllow,
                                   @NotNull String... privilegeNames) throws Exception {
        AccessControlManager acMgr = getAccessControlManager(root);
        JackrabbitAccessControlList acl = requireNonNull(AccessControlUtils.getAccessControlList(acMgr, path));
        acl.addEntry(principal, AccessControlUtils.privilegesFromNames(acMgr, privilegeNames), isAllow);
        acMgr.setPolicy(path, acl);
        root.commit();
    }
}
