function FileSystem::createFilename

File

core/lib/Drupal/Core/File/FileSystem.php, line 563

Class

FileSystem

Provides helpers to operate on files and stream wrappers.

Namespace

Code

public function createFilename($basename, $directory) {
    $original = $basename;
    // Strip control characters (ASCII value < 32). Though these are allowed in
    // some filesystems, not many applications handle them well.
    $basename = preg_replace('/[\\x00-\\x1F]/u', '_', $basename);
    if (preg_last_error() !== PREG_NO_ERROR) {
        throw new FileException(sprintf("Invalid filename '%s'", $original));
    }
    if (str_starts_with(PHP_OS, 'WIN')) {
        // These characters are not allowed in Windows filenames.
        $basename = str_replace([
            ':',
            '*',
            '?',
            '"',
            '<',
            '>',
            '|',
        ], '_', $basename);
    }
    // A URI or path may already have a trailing slash or look like "public://".
    if (str_ends_with($directory, '/')) {
        $separator = '';
    }
    else {
        $separator = '/';
    }
    $destination = $directory . $separator . $basename;
    if (file_exists($destination)) {
        // Destination file already exists, generate an alternative.
        $pos = strrpos($basename, '.');
        if ($pos !== FALSE) {
            $name = substr($basename, 0, $pos);
            $ext = substr($basename, $pos);
        }
        else {
            $name = $basename;
            $ext = '';
        }
        $counter = 0;
        do {
            $destination = $directory . $separator . $name . '_' . $counter++ . $ext;
        } while (file_exists($destination));
    }
    return $destination;
}