Bug 5410 - XSD regular expressions are interpreted as Java regexes (1/2)

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / PatternStatementImpl.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/PatternStatementImpl.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/PatternStatementImpl.java
index 2a4ab6c9c4402caebc1f85540afad1b630935dfb..d899ed879fbc1d8044f239e9ca45663f92f9443a 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/PatternStatementImpl.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/PatternStatementImpl.java
@@ -10,11 +10,13 @@ package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
 import com.google.common.base.Optional;
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
-import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ModifierStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.PatternStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
@@ -28,12 +30,12 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class PatternStatementImpl extends AbstractDeclaredStatement<PatternConstraint> implements PatternStatement {
-    private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
+    private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
             .PATTERN)
-            .add(Rfc6020Mapping.DESCRIPTION, 0, 1)
-            .add(Rfc6020Mapping.ERROR_APP_TAG, 0, 1)
-            .add(Rfc6020Mapping.ERROR_MESSAGE, 0, 1)
-            .add(Rfc6020Mapping.REFERENCE, 0, 1)
+            .addOptional(YangStmtMapping.DESCRIPTION)
+            .addOptional(YangStmtMapping.ERROR_APP_TAG)
+            .addOptional(YangStmtMapping.ERROR_MESSAGE)
+            .addOptional(YangStmtMapping.REFERENCE)
             .build();
     private static final Logger LOG = LoggerFactory.getLogger(PatternStatementImpl.class);
 
@@ -46,21 +48,72 @@ public class PatternStatementImpl extends AbstractDeclaredStatement<PatternConst
             AbstractStatementSupport<PatternConstraint, PatternStatement, EffectiveStatement<PatternConstraint, PatternStatement>> {
 
         public Definition() {
-            super(Rfc6020Mapping.PATTERN);
+            super(YangStmtMapping.PATTERN);
         }
 
         @Override
         public PatternConstraint parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
-            final String pattern = "^" + Utils.fixUnicodeScriptPattern(value) + '$';
+            final String pattern = getJavaRegexFromXSD(value);
 
             try {
                 Pattern.compile(pattern);
-            } catch (PatternSyntaxException e) {
+            } catch (final PatternSyntaxException e) {
                 LOG.debug("Pattern \"{}\" failed to compile at {}", pattern, ctx.getStatementSourceReference(), e);
                 return null;
             }
 
-            return new PatternConstraintEffectiveImpl(pattern, Optional.<String>absent(), Optional.<String>absent());
+            return new PatternConstraintEffectiveImpl(pattern, value, Optional.absent(), Optional.absent());
+        }
+
+        static String getJavaRegexFromXSD(final String xsdRegex) {
+            return "^" + Utils.fixUnicodeScriptPattern(escapeChars(xsdRegex)) + '$';
+        }
+
+        /*
+         * As both '^' and '$' are special anchor characters in java regular
+         * expressions which are implicitly present in XSD regular expressions,
+         * we need to escape them in case they are not defined as part of
+         * character ranges i.e. inside regular square brackets.
+         */
+        private static String escapeChars(final String regex) {
+            final StringBuilder result = new StringBuilder(regex.length());
+            int bracket = 0;
+            boolean escape = false;
+            for (int i = 0; i < regex.length(); i++) {
+                final char ch = regex.charAt(i);
+                switch (ch) {
+                case '[':
+                    if (!escape) {
+                        bracket++;
+                    }
+                    escape = false;
+                    result.append(ch);
+                    break;
+                case ']':
+                    if (!escape) {
+                        bracket--;
+                    }
+                    escape = false;
+                    result.append(ch);
+                    break;
+                case '\\':
+                    escape = !escape;
+                    result.append(ch);
+                    break;
+                case '^':
+                case '$':
+                    if (bracket == 0) {
+                        result.append('\\');
+                    }
+                    escape = false;
+                    result.append(ch);
+                    break;
+                default:
+                    escape = false;
+                    result.append(ch);
+                }
+            }
+            return result.toString();
         }
 
         @Override
@@ -75,10 +128,8 @@ public class PatternStatementImpl extends AbstractDeclaredStatement<PatternConst
         }
 
         @Override
-        public void onFullDefinitionDeclared(StmtContext.Mutable<PatternConstraint, PatternStatement,
-                EffectiveStatement<PatternConstraint, PatternStatement>> stmt) {
-            super.onFullDefinitionDeclared(stmt);
-            SUBSTATEMENT_VALIDATOR.validate(stmt);
+        protected SubstatementValidator getSubstatementValidator() {
+            return SUBSTATEMENT_VALIDATOR;
         }
     }
 
@@ -97,14 +148,19 @@ public class PatternStatementImpl extends AbstractDeclaredStatement<PatternConst
         return firstDeclared(DescriptionStatement.class);
     }
 
+    @Override
+    public ModifierStatement getModifierStatement() {
+        return firstDeclared(ModifierStatement.class);
+    }
+
     @Override
     public ReferenceStatement getReference() {
         return firstDeclared(ReferenceStatement.class);
     }
 
+    @Nonnull
     @Override
     public PatternConstraint getValue() {
         return argument();
     }
-
 }