content: /*
   * 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.ambari.server.orm.dao;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.List;
  
  import javax.annotation.Nullable;
  
  import jakarta.persistence.EntityManager;
  import jakarta.persistence.TypedQuery;
  import jakarta.persistence.criteria.CriteriaBuilder;
  import jakarta.persistence.criteria.CriteriaQuery;
  import jakarta.persistence.criteria.Join;
  import jakarta.persistence.criteria.Predicate;
  import jakarta.persistence.criteria.Root;
  
  import org.apache.ambari.server.orm.RequiresSession;
  import org.apache.ambari.server.orm.entities.HostEntity;
  import org.apache.ambari.server.orm.entities.KerberosKeytabEntity;
  import org.apache.ambari.server.orm.entities.KerberosKeytabPrincipalEntity;
  import org.apache.ambari.server.orm.entities.KerberosKeytabServiceMappingEntity;
  import org.apache.ambari.server.orm.entities.KerberosPrincipalEntity;
  import org.apache.ambari.server.orm.helpers.SQLConstants;
  import org.apache.ambari.server.orm.helpers.SQLOperations;
  import org.apache.commons.collections4.CollectionUtils;
  
  import com.google.inject.Inject;
  import com.google.inject.Provider;
  import com.google.inject.Singleton;
  import com.google.inject.persist.Transactional;
  
  @Singleton
  public class KerberosKeytabPrincipalDAO {
    @Inject
    Provider<EntityManager> entityManagerProvider;
  
    @Inject
    HostDAO hostDAO;
  
    @Inject
    DaoUtils daoUtils;
  
    @Transactional
    public void create(KerberosKeytabPrincipalEntity kerberosKeytabPrincipalEntity) {
      entityManagerProvider.get().persist(kerberosKeytabPrincipalEntity);
    }
  
    @Transactional
    public void create(
      KerberosKeytabEntity kerberosKeytabEntity,
      HostEntity hostEntity,
      KerberosPrincipalEntity principalEntity) {
      entityManagerProvider.get().persist(
        new KerberosKeytabPrincipalEntity(kerberosKeytabEntity, hostEntity, principalEntity)
      );
    }
  
    /**
     * Find or create {@link KerberosKeytabPrincipalEntity} with specified dependencies.
     *
     * @param kerberosKeytabEntity {@link KerberosKeytabEntity} which owns this principal
     * @param hostEntity           {@link HostEntity} which owns this principal
     * @param kerberosPrincipalEntity      {@link KerberosPrincipalEntity} which related to this principal
     * @return evaluated entity
     */
    public KeytabPrincipalFindOrCreateResult findOrCreate(KerberosKeytabEntity kerberosKeytabEntity,
                                                          HostEntity hostEntity, KerberosPrincipalEntity kerberosPrincipalEntity,
                                                          @Nullable List<KerberosKeytabPrincipalEntity> keytabList) {
      KeytabPrincipalFindOrCreateResult result = new KeytabPrincipalFindOrCreateResult();
      result.created = false;
  
      Long hostId = hostEntity == null ? null : hostEntity.getHostId();
      // The DB requests should be avoided due to heavy impact on the performance
      KerberosKeytabPrincipalEntity kkp = (keytabList == null || keytabList.isEmpty())
        ? findByNaturalKey(hostId, kerberosKeytabEntity.getKeytabPath(), kerberosPrincipalEntity.getPrincipalName())
        : keytabList.stream()
        .filter(keytab ->
          keytab != null
            && keytab.getHostId() != null
            && keytab.getKeytabPath() != null
            && keytab.getPrincipalName() != null
            && keytab.getHostId().equals(hostId)
            && keytab.getKeytabPath().equals(kerberosKeytabEntity.getKeytabPath())
            && keytab.getPrincipalName().equals(kerberosPrincipalEntity.getPrincipalName())
        )
        .findFirst()
        .orElse(null);
  
      if (kkp != null) {
        result.kkp = kkp;
        return result;
      }
  
      kkp = new KerberosKeytabPrincipalEntity(
          kerberosKeytabEntity,
          hostEntity,
          kerberosPrincipalEntity
      );
      create(kkp);
  
      kerberosKeytabEntity.addKerberosKeytabPrincipal(kkp);
      kerberosPrincipalEntity.addKerberosKeytabPrincipal(kkp);
  
      result.kkp = kkp;
      result.created = true;
      return result;
    }
  
    @Transactional
    public KerberosKeytabPrincipalEntity merge(KerberosKeytabPrincipalEntity kerberosKeytabPrincipalEntity) {
      return entityManagerProvider.get().merge(kerberosKeytabPrincipalEntity);
    }
  
    @Transactional
    public void remove(KerberosKeytabPrincipalEntity kerberosKeytabPrincipalEntity) {
      entityManagerProvider.get().remove(merge(kerberosKeytabPrincipalEntity));
    }
  
    public void remove(Collection<KerberosKeytabPrincipalEntity> kerberosKeytabPrincipalEntities) {
      for (KerberosKeytabPrincipalEntity entity : kerberosKeytabPrincipalEntities) {
        remove(entity);
      }
    }
  
    @RequiresSession
    public List<KerberosKeytabPrincipalEntity> findByPrincipal(String principal) {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findByPrincipal", KerberosKeytabPrincipalEntity.class);
      query.setParameter("principalName", principal);
      return daoUtils.selectList(query);
    }
  
    @RequiresSession
    public List<KerberosKeytabPrincipalEntity> findByHost(Long hostId) {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findByHost", KerberosKeytabPrincipalEntity.class);
      query.setParameter("hostId", hostId);
      return daoUtils.selectList(query);
    }
  
    @RequiresSession
    public List<KerberosKeytabPrincipalEntity> findByHostAndKeytab(Long hostId, String keytabPath) {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findByHostAndKeytab", KerberosKeytabPrincipalEntity.class);
      query.setParameter("hostId", hostId);
      query.setParameter("keytabPath", keytabPath);
      return daoUtils.selectList(query);
    }
  
    @RequiresSession
    public KerberosKeytabPrincipalEntity findByHostKeytabAndPrincipal(Long hostId, String keytabPath, String principalName) {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findByHostKeytabAndPrincipal", KerberosKeytabPrincipalEntity.class);
      query.setParameter("hostId", hostId);
      query.setParameter("keytabPath", keytabPath);
      query.setParameter("principalName", principalName);
      return daoUtils.selectOne(query);
    }
  
    @RequiresSession
    public KerberosKeytabPrincipalEntity findByKeytabAndPrincipalNullHost(String keytabPath, String principal) {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findByKeytabAndPrincipalNullHost", KerberosKeytabPrincipalEntity.class);
      query.setParameter("keytabPath", keytabPath);
      query.setParameter("principalName", principal);
      return daoUtils.selectOne(query);
    }
  
    /**
     * Ideally for this record PK must be (hostId, keytabPath, principalName), but in some cases hostId can be null.
     * So surrogate auto-generated PK used, and unique constraint for (hostId, keytabPath, principalName) applied.
     * This method checks if hostId is null and calls specific method.
     *
     * @param hostId host id
     * @param keytabPath keytab path
     * @param principalName principal name
     * @return keytab found
     */
    public KerberosKeytabPrincipalEntity findByNaturalKey(Long hostId, String keytabPath, String principalName) {
      if (hostId == null) {
        return findByKeytabAndPrincipalNullHost(keytabPath, principalName);
      } else {
        return findByHostKeytabAndPrincipal(hostId, keytabPath, principalName);
      }
    }
  
    @RequiresSession
    public List<KerberosKeytabPrincipalEntity> findByFilter(KerberosKeytabPrincipalFilter filter) {
      CriteriaBuilder cb = entityManagerProvider.get().getCriteriaBuilder();
      CriteriaQuery<KerberosKeytabPrincipalEntity> cq = cb.createQuery(KerberosKeytabPrincipalEntity.class);
      Root<KerberosKeytabPrincipalEntity> root = cq.from(KerberosKeytabPrincipalEntity.class);
      ArrayList<Predicate> predicates = new ArrayList<>();
  
      if (CollectionUtils.isNotEmpty(filter.getServiceNames())) {
        Join<KerberosKeytabPrincipalEntity, KerberosKeytabServiceMappingEntity> mappingJoin = root.join("serviceMapping");
        predicates.add(mappingJoin.get("serviceName").in(filter.getServiceNames()));
        if (CollectionUtils.isNotEmpty(filter.getComponentNames())) {
          predicates.add(mappingJoin.get("componentName").in(filter.getComponentNames()));
        }
      }
  
      if (CollectionUtils.isNotEmpty(filter.getHostNames())) {
        List<Long> hostIds = new ArrayList<>();
        boolean hasNull = false;
  
        for (String hostname : filter.getHostNames()) {
          HostEntity host = hostDAO.findByName(hostname);
  
          if (host == null) {
            // host may be null after a delete host operation, if so, add an OR NULL clause
            hasNull = true;
          } else {
            hostIds.add(host.getHostId());
          }
        }
  
        //split hostIDs into batches and combine them using OR
        if (CollectionUtils.isNotEmpty(hostIds)) {
          List<Predicate> hostPredicates = new ArrayList<>();
          SQLOperations.batch(hostIds, SQLConstants.IN_ARGUMENT_MAX_SIZE, (chunk, currentBatch, totalBatches, totalSize) -> {
            hostPredicates.add(root.get("hostId").in(chunk));
            return 0;
          });
  
          Predicate hostCombinedPredicate = cb.or(hostPredicates.toArray(new Predicate[hostPredicates.size()]));
          predicates.add(hostCombinedPredicate);
        }
  
        if (hasNull) {
          predicates.add(root.get("hostId").isNull());
        }
      }
  
      //Split principals into batches and combine them using OR
      if (CollectionUtils.isNotEmpty(filter.getPrincipals())) {
        ArrayList<Predicate> principalPredicates = new ArrayList<>();
        SQLOperations.batch(filter.getPrincipals(), SQLConstants.IN_ARGUMENT_MAX_SIZE,
          (chunk, currentBatch, totalBatches, totalSize) -> {
            principalPredicates.add(root.get("principalName").in(chunk));
            return 0;
          });
  
        Predicate principalCombinedPredicate = cb.or(principalPredicates.toArray(new Predicate[0]));
        predicates.add(principalCombinedPredicate);
      }
      cq.where(cb.and(predicates.toArray(new Predicate[0])));
  
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().createQuery(cq);
      List<KerberosKeytabPrincipalEntity> result = query.getResultList();
      if (result == null) {
        return Collections.emptyList();
      }
      return result;
    }
  
  
    public List<KerberosKeytabPrincipalEntity> findByFilters(Collection<KerberosKeytabPrincipalFilter> filters) {
      ArrayList<KerberosKeytabPrincipalEntity> result = new ArrayList<>();
      for (KerberosKeytabPrincipalFilter filter : filters) {
        result.addAll(findByFilter(filter));
      }
      return result;
    }
  
    @RequiresSession
    public boolean exists(Long hostId, String keytabPath, String principalName) {
      return findByNaturalKey(hostId, keytabPath, principalName) != null;
    }
  
    @RequiresSession
    public List<KerberosKeytabPrincipalEntity> findAll() {
      TypedQuery<KerberosKeytabPrincipalEntity> query = entityManagerProvider.get().
        createNamedQuery("KerberosKeytabPrincipalEntity.findAll", KerberosKeytabPrincipalEntity.class);
      List<KerberosKeytabPrincipalEntity> result = query.getResultList();
      if (result == null) {
        return Collections.emptyList();
      }
      return result;
    }
  
    @Transactional
    public void remove(List<KerberosKeytabPrincipalEntity> entities) {
      if (entities != null) {
        for (KerberosKeytabPrincipalEntity entity : entities) {
          entityManagerProvider.get().remove(merge(entity));
        }
      }
    }
  
    public void removeByHost(Long hostId) {
      remove(findByHost(hostId));
    }
  
    public static class KerberosKeytabPrincipalFilter {
      private Collection<String> hostNames;
      private Collection<String> serviceNames;
      private Collection<String> componentNames;
      private Collection<String> principals;
  
      private KerberosKeytabPrincipalFilter() {
        this(null, null, null, null);
      }
  
      private KerberosKeytabPrincipalFilter(Collection<String> hostNames, Collection<String> serviceNames, Collection<String> componentNames, Collection<String> principals) {
        this.hostNames = hostNames;
        this.serviceNames = serviceNames;
        this.componentNames = componentNames;
        this.principals = principals;
      }
  
      public Collection<String> getHostNames() {
        return hostNames;
      }
  
      public void setHostNames(Collection<String> hostNames) {
        this.hostNames = hostNames;
      }
  
      public Collection<String> getServiceNames() {
        return serviceNames;
      }
  
      public void setServiceNames(Collection<String> serviceNames) {
        this.serviceNames = serviceNames;
      }
  
      public Collection<String> getComponentNames() {
        return componentNames;
      }
  
      public void setComponentNames(Collection<String> componentNames) {
        this.componentNames = componentNames;
      }
  
      public Collection<String> getPrincipals() {
        return principals;
      }
  
      public void setPrincipals(Collection<String> principals) {
        this.principals = principals;
      }
  
      public static KerberosKeytabPrincipalFilter createEmptyFilter() {
        return new KerberosKeytabPrincipalFilter();
      }
  
      public static KerberosKeytabPrincipalFilter createFilter(String serviceName, Collection<String> componentNames, Collection<String> hostNames, Collection<String> principalNames) {
        return new KerberosKeytabPrincipalFilter(hostNames,
            (serviceName == null) ? null : Collections.singleton(serviceName),
            componentNames,
            principalNames);
      }
    }
  
    /**
     * Used to return a keytab principal and whether or not it was created. This
     * is required so that callers know whether associated keytabs and principals
     * need bi-direcitonal merges.
     */
    public static class KeytabPrincipalFindOrCreateResult {
      public KerberosKeytabPrincipalEntity kkp;
      public boolean created;
    }
  }
  