BUG-1382: do not instantiate prefixed QNames
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / rest / impl / RestUtil.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.sal.rest.impl;
9
10 import java.util.ArrayList;
11 import java.util.List;
12 import java.util.regex.Matcher;
13 import java.util.regex.Pattern;
14 import javax.xml.stream.events.StartElement;
15 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO;
16 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue;
17 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate;
18 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
19
20 public final class RestUtil {
21
22     // FIXME: BUG-1275: this is code duplicates data.impl.codec
23
24     public static final String SQUOTE = "'";
25     public static final String DQUOTE = "\"";
26     private static final Pattern PREDICATE_PATTERN = Pattern.compile("\\[(.*?)\\]");
27
28     public final static TypeDefinition<?> resolveBaseTypeFrom(final TypeDefinition<?> type) {
29         TypeDefinition<?> superType = type;
30         while (superType.getBaseType() != null) {
31             superType = superType.getBaseType();
32         }
33         return superType;
34     }
35
36     public static IdentityValuesDTO asInstanceIdentifier(final String value, final PrefixesMaping prefixMap) {
37         final String valueTrimmed = value.trim();
38         if (!valueTrimmed.startsWith("/")) {
39             return null;
40         }
41         final String[] xPathParts = valueTrimmed.split("/");
42         if (xPathParts.length < 2) { // must be at least "/pr:node"
43             return null;
44         }
45         final IdentityValuesDTO identityValuesDTO = new IdentityValuesDTO(value);
46         for (int i = 1; i < xPathParts.length; i++) {
47             final String xPathPartTrimmed = xPathParts[i].trim();
48
49             final String xPathPartStr = getIdAndPrefixAsStr(xPathPartTrimmed);
50             final IdentityValue identityValue = toIdentity(xPathPartStr, prefixMap);
51             if (identityValue == null) {
52                 return null;
53             }
54
55             final List<Predicate> predicates = toPredicates(xPathPartTrimmed, prefixMap);
56             if (predicates == null) {
57                 return null;
58             }
59             identityValue.setPredicates(predicates);
60
61             identityValuesDTO.add(identityValue);
62         }
63         return identityValuesDTO.getValuesWithNamespaces().isEmpty() ? null : identityValuesDTO;
64     }
65
66     private static String getIdAndPrefixAsStr(final String pathPart) {
67         final int predicateStartIndex = pathPart.indexOf("[");
68         return predicateStartIndex == -1 ? pathPart : pathPart.substring(0, predicateStartIndex);
69     }
70
71     private static IdentityValue toIdentity(final String xPathPart, final PrefixesMaping prefixMap) {
72         final String xPathPartTrimmed = xPathPart.trim();
73         if (xPathPartTrimmed.isEmpty()) {
74             return null;
75         }
76         final String[] prefixAndIdentifier = xPathPartTrimmed.split(":");
77         // it is not "prefix:value"
78         if (prefixAndIdentifier.length != 2) {
79             return null;
80         }
81         final String prefix = prefixAndIdentifier[0].trim();
82         final String identifier = prefixAndIdentifier[1].trim();
83         if (prefix.isEmpty() || identifier.isEmpty()) {
84             return null;
85         }
86         final String namespace = prefixMap.getNamespace(prefix);
87         return new IdentityValue(namespace, identifier);
88     }
89
90     private static List<Predicate> toPredicates(final String predicatesStr, final PrefixesMaping prefixMap) {
91         final List<Predicate> result = new ArrayList<>();
92         final List<String> predicates = new ArrayList<>();
93         final Matcher matcher = PREDICATE_PATTERN.matcher(predicatesStr);
94         while (matcher.find()) {
95             predicates.add(matcher.group(1).trim());
96         }
97         for (final String predicate : predicates) {
98             final int indexOfEqualityMark = predicate.indexOf("=");
99             if (indexOfEqualityMark != -1) {
100                 final String predicateValue = toPredicateValue(predicate.substring(indexOfEqualityMark + 1));
101                 if (predicate.startsWith(".")) { // it is leaf-list
102                     if (predicateValue == null) {
103                         return null;
104                     }
105                     result.add(new Predicate(null, predicateValue));
106                 } else {
107                     final IdentityValue identityValue = toIdentity(predicate.substring(0, indexOfEqualityMark), prefixMap);
108                     if (identityValue == null || predicateValue == null) {
109                         return null;
110                     }
111                     result.add(new Predicate(identityValue, predicateValue));
112                 }
113             }
114         }
115         return result;
116     }
117
118     private static String toPredicateValue(final String predicatedValue) {
119         final String predicatedValueTrimmed = predicatedValue.trim();
120         if ((predicatedValueTrimmed.startsWith(DQUOTE) || predicatedValueTrimmed.startsWith(SQUOTE))
121                 && (predicatedValueTrimmed.endsWith(DQUOTE) || predicatedValueTrimmed.endsWith(SQUOTE))) {
122             return predicatedValueTrimmed.substring(1, predicatedValueTrimmed.length() - 1);
123         }
124         return null;
125     }
126
127     public interface PrefixesMaping {
128         public String getNamespace(String prefix);
129     }
130
131     public static class PrefixMapingFromXml implements PrefixesMaping {
132         StartElement startElement = null;
133
134         public PrefixMapingFromXml(final StartElement startElement) {
135             this.startElement = startElement;
136         }
137
138         @Override
139         public String getNamespace(final String prefix) {
140             return startElement.getNamespaceContext().getNamespaceURI(prefix);
141         }
142     }
143
144     public static class PrefixMapingFromJson implements PrefixesMaping {
145
146         @Override
147         public String getNamespace(final String prefix) {
148             return prefix;
149         }
150     }
151
152 }