org.apache.jackrabbit.oak.plugins.index.property.ValuePatternUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * 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.jackrabbit.oak.plugins.index.property;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.apache.jackrabbit.oak.api.PropertyValue;
import org.apache.jackrabbit.oak.api.Type;
import org.apache.jackrabbit.oak.spi.query.Filter;
import org.apache.jackrabbit.oak.spi.query.Filter.PropertyRestriction;
import org.jetbrains.annotations.Nullable;

import static org.apache.jackrabbit.guava.common.collect.Sets.newLinkedHashSet;

public final class ValuePatternUtil {
    /**
     * Get the longest prefix of restrictions on a property.
     *
     * @param filter the filter with all restrictions
     * @param property the property
     * @return the longest prefix, or null if none
     */
    @Nullable
    public static String getLongestPrefix(Filter filter, String property) {
        boolean first = false, last = false;
        List list = new ArrayList<>();
        for(PropertyRestriction p : filter.getPropertyRestrictions(property)) {
            if (p.isLike) {
                String prefixForLike = getPrefixForLikeRestriction(p.first.getValue(Type.STRING));
                if (prefixForLike != null) {
                    list.add(prefixForLike);
                    // Set first and last to true to make sure if there is only 1 property restriction, which is like -
                    // the value for same gets evaluated for calculating the longest prefix.
                    first = true;
                    last = true;
                }
                continue;
            }
            if (p.first != null) {
                if (p.first.isArray()) {
                    return null;
                }
                list.add(p.first.getValue(Type.STRING));
                first = true;
            }
            if (p.last != null) {
                if (p.last.isArray()) {
                    return null;
                }
                list.add(p.last.getValue(Type.STRING));
                last = true;
            }
        }
        if (!first || !last) {
            return null;
        }
        String prefix = list.get(0);
        for (String s : list) {
            while (!s.startsWith(prefix)) {
                prefix = prefix.substring(0, prefix.length() - 1);
                if (prefix.isEmpty()) {
                    return null;
                }
            }
        }
        return prefix;
    }

    private static String getPrefixForLikeRestriction(String likeRestrictionValue) {
        //"like 'abc%'"  => prefix 'abc'
        //"like 'abcdef' => prefix 'abcdef'
        //"like 'abc_def' => prefix 'abc'
        //"like '%abc' => no prefix
        //"like 'abc\%'"  => prefix 'abc%'  (because \ is the escape char to search for the character % explicitly)
        //"like 'abc\_def%' => prefix 'abc_def'
        // the wildcards characters for like values are _ (any one character) and % (any characters).
        // An index is used, except if the operand starts with a wildcard. To search for the characters % and _,
        // the characters need to be escaped using \ (backslash).

        // if the value starts with a wildcard, then there is no prefix
        if (likeRestrictionValue.startsWith("%") || likeRestrictionValue.startsWith("_")) {
            return null;
        } else {
            // if the value contains a wildcard, then the prefix is the value up to the first of the 2 wildcards % or _
            // Logic also handles escape using \ (backslash).
            StringBuilder prefix = new StringBuilder();
            boolean escape = false;
            for (int i = 0; i < likeRestrictionValue.length(); i++) {
                char c = likeRestrictionValue.charAt(i);
                if (c == '\\' && !escape) {
                    escape = true;
                } else {
                    if (!escape && (c == '%' || c == '_')) {
                        break;
                    }
                    prefix.append(c);
                    escape = false;
                }
            }
            return prefix.toString();
        }
    }

    @Nullable
    public static Set getAllValues(PropertyRestriction restriction){
        return getValues(restriction, ValuePattern.MATCH_ALL);
    }

    @Nullable
    public static Set getValues(PropertyRestriction restriction, ValuePattern pattern) {
        if (restriction.firstIncluding
                && restriction.lastIncluding
                && restriction.first != null
                && restriction.first.equals(restriction.last)) {
            // "[property] = $value"
            return read(restriction.first, pattern);
        } else if (restriction.list != null) {
            // "[property] IN (...)
            Set values = newLinkedHashSet(); // keep order for testing
            for (PropertyValue value : restriction.list) {
                values.addAll(read(value, pattern));
            }
            return values;
        } else {
            // "[property] is not null" or "[property] is null"
            return null;
        }
    }

    @Nullable
    public static Set read(PropertyValue value, ValuePattern pattern) {
        if (value == null) {
            return null;
        }
        Set values = new HashSet();
        for (String v : value.getValue(Type.STRINGS)) {
            if (!pattern.matches(v)) {
                continue;
            }
            values.add(v);
        }
        return values;
    }
}