org.apache.sshd.sftp.common.extensions.VersionsParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-sftp Show documentation
There is a newer version: 2.14.0
/*
 * 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.sshd.sftp.common.extensions;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import org.apache.sshd.common.util.GenericUtils;
import org.apache.sshd.common.util.NumberUtils;
import org.apache.sshd.sftp.common.SftpConstants;
import org.apache.sshd.sftp.common.extensions.VersionsParser.Versions;

/**
 * @author Apache MINA SSHD Project
 */
public class VersionsParser extends AbstractParser {
    /**
     * The "versions" extension data as per
     * DRAFT 09
     * Section 4.6
     *
     * @author Apache MINA SSHD Project
     */
    public static class Versions {
        public static final char SEP = ',';

        private List versions;

        public Versions() {
            this(null);
        }

        public Versions(List versions) {
            this.versions = versions;
        }

        public List getVersions() {
            return versions;
        }

        public void setVersions(List versions) {
            this.versions = versions;
        }

        public List resolveAvailableVersions(int current) {
            List currentlyAvailable = Collections.singletonList(current);
            Collection reported = getVersions();
            if (GenericUtils.isEmpty(reported)) {
                return currentlyAvailable;
            }

            Set available = GenericUtils.asSortedSet(currentlyAvailable);
            for (String v : reported) {
                /*
                 * According to https://tools.ietf.org/html/draft-ietf-secsh-filexfer-11#section-5.5 versions may
                 * contain not only numbers
                 */
                if (!NumberUtils.isIntegerNumber(v)) {
                    continue;
                }

                if (!available.add(Integer.valueOf(v))) {
                    continue; // debug breakpoint
                }
            }

            return (available.size() == 1)
                    ? currentlyAvailable
                    : new ArrayList<>(available);
        }

        @Override
        public String toString() {
            return GenericUtils.join(getVersions(), ',');
        }
    }

    public static final VersionsParser INSTANCE = new VersionsParser();

    public VersionsParser() {
        super(SftpConstants.EXT_VERSIONS);
    }

    @Override
    public Versions parse(byte[] input, int offset, int len) {
        return parse(new String(input, offset, len, StandardCharsets.UTF_8));
    }

    public Versions parse(String value) {
        String[] comps = GenericUtils.split(value, Versions.SEP);
        return new Versions(GenericUtils.isEmpty(comps) ? Collections.emptyList() : Arrays.asList(comps));
    }
}