org.neo4j.configuration.helpers.DatabaseNameValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-configuration Show documentation
Code responsible for parsing the Neo4j configuration.
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.configuration.helpers;

import static org.apache.commons.lang3.CharUtils.isAsciiAlphaLower;

import java.util.Objects;
import java.util.regex.Pattern;
import org.neo4j.kernel.database.NormalizedDatabaseName;

public class DatabaseNameValidator {
    public static final int MINIMUM_DATABASE_NAME_LENGTH = 3;
    public static final int MAXIMUM_DATABASE_NAME_LENGTH = 63;
    private static final Pattern DATABASE_NAME_PATTERN = Pattern.compile("^[a-z0-9-.]+$");

    public static void validateExternalDatabaseName(NormalizedDatabaseName normalizedName) {
        validateInternalDatabaseName(normalizedName);

        var name = normalizedName.name();
        if (name.startsWith("system")) {
            throw new IllegalArgumentException("Database name '" + name + "' is invalid, due to the prefix 'system'.");
        }
    }

    public static void validateInternalDatabaseName(NormalizedDatabaseName normalizedName) {
        Objects.requireNonNull(normalizedName, "The provided database name is empty.");

        String name = normalizedName.name();

        if (name.isEmpty()) {
            throw new IllegalArgumentException("The provided database name is empty.");
        }

        if (name.length() < MINIMUM_DATABASE_NAME_LENGTH || name.length() > MAXIMUM_DATABASE_NAME_LENGTH) {
            throw new IllegalArgumentException("The provided database name must have a length between "
                    + MINIMUM_DATABASE_NAME_LENGTH + " and " + MAXIMUM_DATABASE_NAME_LENGTH + " characters.");
        }

        if (!isAsciiAlphaLower(name.charAt(0))) {
            throw new IllegalArgumentException(
                    "Database name '" + name + "' is not starting with an ASCII alphabetic character.");
        }

        if (!DATABASE_NAME_PATTERN.matcher(name).matches()) {
            throw new IllegalArgumentException("Database name '" + name
                    + "' contains illegal characters. Use simple ascii characters, numbers, dots and dashes.");
        }
    }

    private static final Pattern DATABASE_NAME_GLOBBING_PATTERN = Pattern.compile("^[a-z0-9-.*?]+$");

    public static String validateDatabaseNamePattern(String name) {
        Objects.requireNonNull(name, "The provided database name is empty.");

        if (name.trim().isEmpty()) {
            throw new IllegalArgumentException("The provided database name is empty.");
        }
        name = name.toLowerCase();
        if (name.length() > MAXIMUM_DATABASE_NAME_LENGTH) {
            throw new IllegalArgumentException("The provided database name must have a length between " + 1 + " and "
                    + MAXIMUM_DATABASE_NAME_LENGTH + " characters.");
        }

        validateDatabaseNameCharacters(name);
        return name;
    }

    public static String validateDatabaseNameCharacters(String name) {
        if (!DATABASE_NAME_GLOBBING_PATTERN.matcher(name).matches()) {
            throw new IllegalArgumentException("Database name '" + name
                    + "' contains illegal characters. Use simple ascii characters, numbers, dots,"
                    + " question marks, asterisk and dashes.");
        }

        return name;
    }
}