2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2023 Nordix Foundation
4 * Modifications Copyright (C) 2023 TechMahindra Ltd.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.spi.repository;
24 import java.util.Collections;
25 import java.util.HashMap;
26 import java.util.LinkedList;
27 import java.util.List;
29 import java.util.Queue;
30 import javax.persistence.EntityManager;
31 import javax.persistence.PersistenceContext;
32 import javax.persistence.Query;
33 import lombok.RequiredArgsConstructor;
34 import lombok.extern.slf4j.Slf4j;
35 import org.onap.cps.cpspath.parser.CpsPathPrefixType;
36 import org.onap.cps.cpspath.parser.CpsPathQuery;
37 import org.onap.cps.spi.PaginationOption;
38 import org.onap.cps.spi.entities.AnchorEntity;
39 import org.onap.cps.spi.entities.DataspaceEntity;
40 import org.onap.cps.spi.entities.FragmentEntity;
41 import org.onap.cps.spi.exceptions.CpsPathException;
42 import org.onap.cps.spi.utils.EscapeUtils;
43 import org.springframework.stereotype.Component;
45 @RequiredArgsConstructor
48 public class FragmentQueryBuilder {
49 private static final AnchorEntity ACROSS_ALL_ANCHORS = null;
52 private EntityManager entityManager;
55 * Create a sql query to retrieve by anchor(id) and cps path.
57 * @param anchorEntity the anchor
58 * @param cpsPathQuery the cps path query to be transformed into a sql query
59 * @return a executable query object
61 public Query getQueryForAnchorAndCpsPath(final AnchorEntity anchorEntity, final CpsPathQuery cpsPathQuery) {
62 return getQueryForDataspaceOrAnchorAndCpsPath(anchorEntity.getDataspace(),
63 anchorEntity, cpsPathQuery, Collections.emptyList());
67 * Create a sql query to retrieve by cps path.
69 * @param dataspaceEntity the dataspace
70 * @param cpsPathQuery the cps path query to be transformed into a sql query
71 * @return a executable query object
73 public Query getQueryForDataspaceAndCpsPath(final DataspaceEntity dataspaceEntity,
74 final CpsPathQuery cpsPathQuery,
75 final List<Long> anchorIdsForPagination) {
76 return getQueryForDataspaceOrAnchorAndCpsPath(dataspaceEntity, ACROSS_ALL_ANCHORS,
77 cpsPathQuery, anchorIdsForPagination);
81 * Get query for dataspace, cps path, page index and page size.
82 * @param dataspaceEntity data space entity
83 * @param cpsPathQuery cps path query
84 * @param paginationOption pagination option
85 * @return query for given dataspace, cps path and pagination parameters
87 public Query getQueryForAnchorIdsForPagination(final DataspaceEntity dataspaceEntity,
88 final CpsPathQuery cpsPathQuery,
89 final PaginationOption paginationOption) {
90 final StringBuilder sqlStringBuilder = new StringBuilder();
91 final Map<String, Object> queryParameters = new HashMap<>();
92 sqlStringBuilder.append("SELECT distinct(fragment.anchor_id) FROM fragment "
93 + "JOIN anchor ON anchor.id = fragment.anchor_id WHERE dataspace_id = :dataspaceId");
94 queryParameters.put("dataspaceId", dataspaceEntity.getId());
95 addXpathSearch(cpsPathQuery, sqlStringBuilder, queryParameters);
96 addLeafConditions(cpsPathQuery, sqlStringBuilder);
97 addTextFunctionCondition(cpsPathQuery, sqlStringBuilder, queryParameters);
98 addContainsFunctionCondition(cpsPathQuery, sqlStringBuilder, queryParameters);
99 if (PaginationOption.NO_PAGINATION != paginationOption) {
100 sqlStringBuilder.append(" ORDER BY fragment.anchor_id");
101 addPaginationCondition(sqlStringBuilder, queryParameters, paginationOption);
104 final Query query = entityManager.createNativeQuery(sqlStringBuilder.toString());
105 setQueryParameters(query, queryParameters);
109 private Query getQueryForDataspaceOrAnchorAndCpsPath(final DataspaceEntity dataspaceEntity,
110 final AnchorEntity anchorEntity,
111 final CpsPathQuery cpsPathQuery,
112 final List<Long> anchorIdsForPagination) {
113 final StringBuilder sqlStringBuilder = new StringBuilder();
114 final Map<String, Object> queryParameters = new HashMap<>();
116 if (anchorEntity == ACROSS_ALL_ANCHORS) {
117 sqlStringBuilder.append("SELECT fragment.* FROM fragment JOIN anchor ON anchor.id = fragment.anchor_id"
118 + " WHERE dataspace_id = :dataspaceId");
119 queryParameters.put("dataspaceId", dataspaceEntity.getId());
120 if (!anchorIdsForPagination.isEmpty()) {
121 sqlStringBuilder.append(" AND anchor_id IN (:anchorIdsForPagination)");
122 queryParameters.put("anchorIdsForPagination", anchorIdsForPagination);
125 sqlStringBuilder.append("SELECT * FROM fragment WHERE anchor_id = :anchorId");
126 queryParameters.put("anchorId", anchorEntity.getId());
128 addXpathSearch(cpsPathQuery, sqlStringBuilder, queryParameters);
129 addLeafConditions(cpsPathQuery, sqlStringBuilder);
130 addTextFunctionCondition(cpsPathQuery, sqlStringBuilder, queryParameters);
131 addContainsFunctionCondition(cpsPathQuery, sqlStringBuilder, queryParameters);
133 final Query query = entityManager.createNativeQuery(sqlStringBuilder.toString(), FragmentEntity.class);
134 setQueryParameters(query, queryParameters);
138 private static void addXpathSearch(final CpsPathQuery cpsPathQuery,
139 final StringBuilder sqlStringBuilder,
140 final Map<String, Object> queryParameters) {
141 sqlStringBuilder.append(" AND (xpath LIKE :escapedXpath OR "
142 + "(xpath LIKE :escapedXpath||'[@%]' AND xpath NOT LIKE :escapedXpath||'[@%]/%[@%]'))");
143 if (CpsPathPrefixType.ABSOLUTE.equals(cpsPathQuery.getCpsPathPrefixType())) {
144 queryParameters.put("escapedXpath", EscapeUtils.escapeForSqlLike(cpsPathQuery.getXpathPrefix()));
146 queryParameters.put("escapedXpath", "%/" + EscapeUtils.escapeForSqlLike(cpsPathQuery.getDescendantName()));
150 private static void addPaginationCondition(final StringBuilder sqlStringBuilder,
151 final Map<String, Object> queryParameters,
152 final PaginationOption paginationOption) {
153 final Integer offset = (paginationOption.getPageIndex() - 1) * paginationOption.getPageSize();
154 sqlStringBuilder.append(" LIMIT :pageSize OFFSET :offset");
155 queryParameters.put("pageSize", paginationOption.getPageSize());
156 queryParameters.put("offset", offset);
159 private static Integer getTextValueAsInt(final CpsPathQuery cpsPathQuery) {
161 return Integer.parseInt(cpsPathQuery.getTextFunctionConditionValue());
162 } catch (final NumberFormatException e) {
167 private void addLeafConditions(final CpsPathQuery cpsPathQuery, final StringBuilder sqlStringBuilder) {
168 if (cpsPathQuery.hasLeafConditions()) {
169 queryLeafConditions(cpsPathQuery, sqlStringBuilder);
173 private void queryLeafConditions(final CpsPathQuery cpsPathQuery, final StringBuilder sqlStringBuilder) {
174 sqlStringBuilder.append(" AND (");
175 final Queue<String> booleanOperatorsQueue = new LinkedList<>(cpsPathQuery.getBooleanOperators());
176 final Queue<String> comparativeOperatorQueue = new LinkedList<>(cpsPathQuery.getComparativeOperators());
177 cpsPathQuery.getLeavesData().forEach(leaf -> {
178 final String nextComparativeOperator = comparativeOperatorQueue.poll();
179 if (leaf.getValue() instanceof Integer) {
180 sqlStringBuilder.append("(attributes ->> '").append(leaf.getName()).append("')\\:\\:int");
181 sqlStringBuilder.append(nextComparativeOperator);
182 sqlStringBuilder.append(leaf.getValue());
184 if ("=".equals(nextComparativeOperator)) {
185 final String leafValueAsText = leaf.getValue().toString();
186 sqlStringBuilder.append("attributes ->> '").append(leaf.getName()).append("'");
187 sqlStringBuilder.append(" = '");
188 sqlStringBuilder.append(EscapeUtils.escapeForSqlStringLiteral(leafValueAsText));
189 sqlStringBuilder.append("'");
191 throw new CpsPathException(" can use only " + nextComparativeOperator + " with integer ");
194 if (!booleanOperatorsQueue.isEmpty()) {
195 sqlStringBuilder.append(" ");
196 sqlStringBuilder.append(booleanOperatorsQueue.poll());
197 sqlStringBuilder.append(" ");
200 sqlStringBuilder.append(")");
203 private static void addTextFunctionCondition(final CpsPathQuery cpsPathQuery,
204 final StringBuilder sqlStringBuilder,
205 final Map<String, Object> queryParameters) {
206 if (cpsPathQuery.hasTextFunctionCondition()) {
207 sqlStringBuilder.append(" AND (");
208 sqlStringBuilder.append("attributes @> jsonb_build_object(:textLeafName, :textValue)");
210 .append(" OR attributes @> jsonb_build_object(:textLeafName, json_build_array(:textValue))");
211 queryParameters.put("textLeafName", cpsPathQuery.getTextFunctionConditionLeafName());
212 queryParameters.put("textValue", cpsPathQuery.getTextFunctionConditionValue());
213 final Integer textValueAsInt = getTextValueAsInt(cpsPathQuery);
214 if (textValueAsInt != null) {
215 sqlStringBuilder.append(" OR attributes @> jsonb_build_object(:textLeafName, :textValueAsInt)");
217 .append(" OR attributes @> jsonb_build_object(:textLeafName, json_build_array(:textValueAsInt))");
218 queryParameters.put("textValueAsInt", textValueAsInt);
220 sqlStringBuilder.append(")");
224 private static void addContainsFunctionCondition(final CpsPathQuery cpsPathQuery,
225 final StringBuilder sqlStringBuilder,
226 final Map<String, Object> queryParameters) {
227 if (cpsPathQuery.hasContainsFunctionCondition()) {
228 sqlStringBuilder.append(" AND attributes ->> :containsLeafName LIKE CONCAT('%',:containsValue,'%') ");
229 queryParameters.put("containsLeafName", cpsPathQuery.getContainsFunctionConditionLeafName());
230 queryParameters.put("containsValue",
231 EscapeUtils.escapeForSqlLike(cpsPathQuery.getContainsFunctionConditionValue()));
235 private static void setQueryParameters(final Query query, final Map<String, Object> queryParameters) {
236 for (final Map.Entry<String, Object> queryParameter : queryParameters.entrySet()) {
237 query.setParameter(queryParameter.getKey(), queryParameter.getValue());