engine/schema/src/main/java/com/cloud/network/security/dao/SecurityGroupRuleDaoImpl.java

// 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 com.cloud.network.security.dao;

import java.util.List;
import java.util.Map;

import javax.inject.Inject;
import javax.naming.ConfigurationException;

import com.cloud.server.ResourceTag.ResourceObjectType;
import com.cloud.tags.dao.ResourceTagDao;
import org.springframework.stereotype.Component;

import com.cloud.network.security.SecurityGroupRuleVO;
import com.cloud.network.security.SecurityGroupVO;
import com.cloud.network.security.SecurityRule.SecurityRuleType;
import com.cloud.utils.db.GenericDaoBase;
import com.cloud.utils.db.JoinBuilder;
import com.cloud.utils.db.SearchBuilder;
import com.cloud.utils.db.SearchCriteria;
import com.cloud.utils.db.TransactionLegacy;
import com.cloud.utils.db.DB;

@Component
public class SecurityGroupRuleDaoImpl extends GenericDaoBase<SecurityGroupRuleVO, Long> implements SecurityGroupRuleDao {

    @Inject
    SecurityGroupDao _securityGroupDao;
    @Inject
    ResourceTagDao _tagsDao;

    protected SearchBuilder<SecurityGroupRuleVO> securityGroupIdSearch;
    protected SearchBuilder<SecurityGroupRuleVO> securityGroupIdAndTypeSearch;
    protected SearchBuilder<SecurityGroupRuleVO> allowedSecurityGroupIdSearch;
    protected SearchBuilder<SecurityGroupRuleVO> protoPortsAndCidrSearch;
    protected SearchBuilder<SecurityGroupRuleVO> protoPortsAndSecurityGroupNameSearch;
    protected SearchBuilder<SecurityGroupRuleVO> protoPortsAndSecurityGroupIdSearch;

    protected SecurityGroupRuleDaoImpl() {
        securityGroupIdSearch = createSearchBuilder();
        securityGroupIdSearch.and("securityGroupId", securityGroupIdSearch.entity().getSecurityGroupId(), SearchCriteria.Op.EQ);
        securityGroupIdSearch.done();

        securityGroupIdAndTypeSearch = createSearchBuilder();
        securityGroupIdAndTypeSearch.and("securityGroupId", securityGroupIdAndTypeSearch.entity().getSecurityGroupId(), SearchCriteria.Op.EQ);
        securityGroupIdAndTypeSearch.and("type", securityGroupIdAndTypeSearch.entity().getType(), SearchCriteria.Op.EQ);
        securityGroupIdAndTypeSearch.done();

        allowedSecurityGroupIdSearch = createSearchBuilder();
        allowedSecurityGroupIdSearch.and("allowedNetworkId", allowedSecurityGroupIdSearch.entity().getAllowedNetworkId(), SearchCriteria.Op.EQ);
        allowedSecurityGroupIdSearch.done();

        protoPortsAndCidrSearch = createSearchBuilder();
        protoPortsAndCidrSearch.and("securityGroupId", protoPortsAndCidrSearch.entity().getSecurityGroupId(), SearchCriteria.Op.EQ);
        protoPortsAndCidrSearch.and("proto", protoPortsAndCidrSearch.entity().getProtocol(), SearchCriteria.Op.EQ);
        protoPortsAndCidrSearch.and("startPort", protoPortsAndCidrSearch.entity().getStartPort(), SearchCriteria.Op.EQ);
        protoPortsAndCidrSearch.and("endPort", protoPortsAndCidrSearch.entity().getEndPort(), SearchCriteria.Op.EQ);
        protoPortsAndCidrSearch.and("cidr", protoPortsAndCidrSearch.entity().getAllowedSourceIpCidr(), SearchCriteria.Op.EQ);
        protoPortsAndCidrSearch.done();

        protoPortsAndSecurityGroupIdSearch = createSearchBuilder();
        protoPortsAndSecurityGroupIdSearch.and("securityGroupId", protoPortsAndSecurityGroupIdSearch.entity().getSecurityGroupId(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupIdSearch.and("proto", protoPortsAndSecurityGroupIdSearch.entity().getProtocol(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupIdSearch.and("startPort", protoPortsAndSecurityGroupIdSearch.entity().getStartPort(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupIdSearch.and("endPort", protoPortsAndSecurityGroupIdSearch.entity().getEndPort(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupIdSearch.and("allowedNetworkId", protoPortsAndSecurityGroupIdSearch.entity().getAllowedNetworkId(), SearchCriteria.Op.EQ);

    }

    @Override
    public List<SecurityGroupRuleVO> listBySecurityGroupId(long securityGroupId, SecurityRuleType type) {
        SearchCriteria<SecurityGroupRuleVO> sc = securityGroupIdAndTypeSearch.create();
        sc.setParameters("securityGroupId", securityGroupId);
        String dbType;
        if (type == SecurityRuleType.EgressRule) {
            dbType = SecurityRuleType.EgressRule.getType();
        } else {
            dbType = SecurityRuleType.IngressRule.getType();
        }

        sc.setParameters("type", dbType);
        return listBy(sc);
    }

    @Override
    public int deleteBySecurityGroup(long securityGroupId) {
        SearchCriteria<SecurityGroupRuleVO> sc = securityGroupIdSearch.create();
        sc.setParameters("securityGroupId", securityGroupId);
        return expunge(sc);
    }

    @Override
    public List<SecurityGroupRuleVO> listByAllowedSecurityGroupId(long securityGroupId) {
        SearchCriteria<SecurityGroupRuleVO> sc = allowedSecurityGroupIdSearch.create();
        sc.setParameters("allowedNetworkId", securityGroupId);
        return listBy(sc);
    }

    @Override
    public SecurityGroupRuleVO findByProtoPortsAndCidr(long securityGroupId, String proto, int startPort, int endPort, String cidr) {
        SearchCriteria<SecurityGroupRuleVO> sc = protoPortsAndCidrSearch.create();
        sc.setParameters("securityGroupId", securityGroupId);
        sc.setParameters("proto", proto);
        sc.setParameters("startPort", startPort);
        sc.setParameters("endPort", endPort);
        sc.setParameters("cidr", cidr);
        return findOneIncludingRemovedBy(sc);
    }

    @Override
    public SecurityGroupRuleVO findByProtoPortsAndGroup(String proto, int startPort, int endPort, String securityGroup) {
        SearchCriteria<SecurityGroupRuleVO> sc = protoPortsAndSecurityGroupNameSearch.create();
        sc.setParameters("proto", proto);
        sc.setParameters("startPort", startPort);
        sc.setParameters("endPort", endPort);
        sc.setJoinParameters("groupName", "groupName", securityGroup);
        return findOneIncludingRemovedBy(sc);
    }

    @Override
    public boolean configure(String name, Map<String, Object> params) throws ConfigurationException {
        protoPortsAndSecurityGroupNameSearch = createSearchBuilder();
        protoPortsAndSecurityGroupNameSearch.and("proto", protoPortsAndSecurityGroupNameSearch.entity().getProtocol(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupNameSearch.and("startPort", protoPortsAndSecurityGroupNameSearch.entity().getStartPort(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupNameSearch.and("endPort", protoPortsAndSecurityGroupNameSearch.entity().getEndPort(), SearchCriteria.Op.EQ);
        SearchBuilder<SecurityGroupVO> ngSb = _securityGroupDao.createSearchBuilder();
        ngSb.and("groupName", ngSb.entity().getName(), SearchCriteria.Op.EQ);
        protoPortsAndSecurityGroupNameSearch.join("groupName", ngSb, protoPortsAndSecurityGroupNameSearch.entity().getAllowedNetworkId(), ngSb.entity().getId(),
            JoinBuilder.JoinType.INNER);
        protoPortsAndSecurityGroupNameSearch.done();
        return super.configure(name, params);
    }

    @Override
    public int deleteByPortProtoAndGroup(long securityGroupId, String protocol, int startPort, int endPort, Long allowedGroupId) {
        SearchCriteria<SecurityGroupRuleVO> sc = protoPortsAndSecurityGroupIdSearch.create();
        sc.setParameters("securityGroupId", securityGroupId);
        sc.setParameters("proto", protocol);
        sc.setParameters("startPort", startPort);
        sc.setParameters("endPort", endPort);
        sc.setParameters("allowedNetworkId", allowedGroupId);
        return expunge(sc);
    }

    @Override
    public int deleteByPortProtoAndCidr(long securityGroupId, String protocol, int startPort, int endPort, String cidr) {
        SearchCriteria<SecurityGroupRuleVO> sc = protoPortsAndCidrSearch.create();
        sc.setParameters("securityGroupId", securityGroupId);
        sc.setParameters("proto", protocol);
        sc.setParameters("startPort", startPort);
        sc.setParameters("endPort", endPort);
        sc.setParameters("cidr", cidr);
        return expunge(sc);
    }

    @Override
    public SecurityGroupRuleVO findByProtoPortsAndAllowedGroupId(long securityGroupId, String proto, int startPort, int endPort, Long allowedGroupId) {
        SearchCriteria<SecurityGroupRuleVO> sc = protoPortsAndSecurityGroupIdSearch.create();
        sc.addAnd("securityGroupId", SearchCriteria.Op.EQ, securityGroupId);
        sc.setParameters("proto", proto);
        sc.setParameters("startPort", startPort);
        sc.setParameters("endPort", endPort);
        sc.setParameters("allowedNetworkId", allowedGroupId);
        return findOneIncludingRemovedBy(sc);
    }

    @Override
    @DB
    public boolean remove(Long id) {
        TransactionLegacy txn = TransactionLegacy.currentTxn();
        txn.start();
        SecurityGroupRuleVO entry = findById(id);
        if (entry != null) {
            _tagsDao.removeByIdAndType(id, ResourceObjectType.SecurityGroupRule);
        }
        boolean result = super.remove(id);
        txn.commit();
        return result;
    }
}