org.eclipse.jetty.http.QuotedQualityCSV 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
// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.http;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.function.ToIntFunction;
import java.util.stream.Collectors;
import org.eclipse.jetty.util.log.Log;

/**
 *  Implements a quoted comma separated list of quality values
 *  in accordance with RFC7230 and RFC7231.
 *  Values are returned sorted in quality order, with OWS and the
 *  quality parameters removed.
 *
 *  @see "https://tools.ietf.org/html/rfc7230#section-3.2.6"
 *  @see "https://tools.ietf.org/html/rfc7230#section-7"
 *  @see "https://tools.ietf.org/html/rfc7231#section-5.3.1"
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
public class QuotedQualityCSV extends QuotedCSV implements Iterable {

    /**
     * Lambda to apply a most specific MIME encoding secondary ordering.
     *
     * @see "https://tools.ietf.org/html/rfc7231#section-5.3.2"
     */
    public static ToIntFunction MOST_SPECIFIC_MIME_ORDERING = s -> {
        if ("*/*".equals(s))
            return 0;
        if (s.endsWith("/*"))
            return 1;
        if (s.indexOf(';') < 0)
            return 2;
        return 3;
    };

    private final List _qualities = new ArrayList<>();

    private QualityValue _lastQuality;

    private boolean _sorted = false;

    private final ToIntFunction _secondaryOrdering;

    /**
     * Sorts values with equal quality according to the length of the value String.
     */
    public QuotedQualityCSV() {
        this((ToIntFunction) null);
    }

    /**
     * Sorts values with equal quality according to given order.
     *
     * @param preferredOrder Array indicating the preferred order of known values
     */
    public QuotedQualityCSV(String[] preferredOrder) {
        this((s) -> {
            for (int i = 0; i < preferredOrder.length; ++i) {
                if (preferredOrder[i].equals(s))
                    return preferredOrder.length - i;
            }
            if ("*".equals(s))
                return preferredOrder.length;
            return 0;
        });
    }

    /**
     * Orders values with equal quality with the given function.
     *
     * @param secondaryOrdering Function to apply an ordering other than specified by quality, highest values are sorted first.
     */
    public QuotedQualityCSV(ToIntFunction secondaryOrdering) {
        this._secondaryOrdering = secondaryOrdering == null ? s -> 0 : secondaryOrdering;
    }

    @Override
    protected void parsedValueAndParams(StringBuffer buffer) {
        super.parsedValueAndParams(buffer);
        // Collect full value with parameters
        _lastQuality = new QualityValue(_lastQuality._quality, buffer.toString(), _lastQuality._index);
        _qualities.set(_lastQuality._index, _lastQuality);
    }

    @Override
    protected void parsedValue(StringBuffer buffer) {
        super.parsedValue(buffer);
        _sorted = false;
        // This is the just the value, without parameters.
        // Assume a quality of ONE
        _lastQuality = new QualityValue(1.0D, buffer.toString(), _qualities.size());
        _qualities.add(_lastQuality);
    }

    @Override
    protected void parsedParam(StringBuffer buffer, int valueLength, int paramName, int paramValue) {
        _sorted = false;
        if (paramName < 0) {
            if (buffer.charAt(buffer.length() - 1) == ';')
                buffer.setLength(buffer.length() - 1);
        } else if (paramValue >= 0 && buffer.charAt(paramName) == 'q' && paramValue > paramName && buffer.length() >= paramName && buffer.charAt(paramName + 1) == '=') {
            double q;
            try {
                q = (_keepQuotes && buffer.charAt(paramValue) == '"') ? Double.valueOf(buffer.substring(paramValue + 1, buffer.length() - 1)) : Double.valueOf(buffer.substring(paramValue));
            } catch (Exception e) {
                Log.getLogger(QuotedQualityCSV.class).ignore(e);
                q = 0.0D;
            }
            buffer.setLength(Math.max(0, paramName - 1));
            if (q != 1.0D) {
                _lastQuality = new QualityValue(q, buffer.toString(), _lastQuality._index);
                _qualities.set(_lastQuality._index, _lastQuality);
            }
        }
    }

    @Override
    public List getValues() {
        if (!_sorted)
            sort();
        return _values;
    }

    @Override
    public Iterator iterator() {
        if (!_sorted)
            sort();
        return _values.iterator();
    }

    protected void sort() {
        _values.clear();
        _qualities.stream().filter((qv) -> qv._quality != 0.0D).sorted().map(QualityValue::getValue).collect(Collectors.toCollection(() -> _values));
        _sorted = true;
    }

    // @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    @Deprecated(since = "2021-05-27")
    private class QualityValue implements Comparable {

        private final double _quality;

        private final String _value;

        private final int _index;

        private QualityValue(double quality, String value, int index) {
            _quality = quality;
            _value = value;
            _index = index;
        }

        @Override
        public int hashCode() {
            return Double.hashCode(_quality) ^ Objects.hash(_value, _index);
        }

        @Override
        public boolean equals(Object obj) {
            if (!(obj instanceof QualityValue))
                return false;
            QualityValue qv = (QualityValue) obj;
            return _quality == qv._quality && Objects.equals(_value, qv._value) && Objects.equals(_index, qv._index);
        }

        private String getValue() {
            return _value;
        }

        @Override
        public int compareTo(QualityValue o) {
            // sort highest quality first
            int compare = Double.compare(o._quality, _quality);
            if (compare == 0) {
                // then sort secondary order highest first
                compare = Integer.compare(_secondaryOrdering.applyAsInt(o._value), _secondaryOrdering.applyAsInt(_value));
                if (compare == 0)
                    // then sort index lowest first
                    compare = -Integer.compare(o._index, _index);
            }
            return compare;
        }

        @Override
        public String toString() {
            return String.format("%s@%x[%s,q=%f,i=%d]", getClass().getSimpleName(), hashCode(), _value, _quality, _index);
        }
    }
}