Improve Error Message "Invalid file name" in setValueAfterValidation() Method

[obsergiu]

Currently, the setValueAfterValidation method in Magento\Config\Model\Config\Backend\File.php throws a generic error message, Invalid file name, when a file name doesn't pass validation(like: default/logo.png). I think it would be better for improving this by including the actual invalid file name in the message to make it more informative.

This validation and function were introduced in Magento 2.4.6-p5, but I don't see it in the current beta version. As such it should be treated more like a reference for others who might encounter similar issues.

The code is located at:

magento2/app/code/Magento/Config/Model/Config/Backend/File.php

Line 283 in 1819fe7

throw new LocalizedException(__('Invalid file name'));

The existing code:

private function setValueAfterValidation(string $value): void
{
    if (preg_match('/[^a-z0-9_\/\\-\\.]+/i', $value)
        // phpcs:ignore Magento2.Functions.DiscouragedFunction
        || !$this->_mediaDirectory->isFile($this->_getUploadDir() . DIRECTORY_SEPARATOR . basename($value))
    ) {
        throw new LocalizedException(__('Invalid file name'));
    }

    $this->setValue($value);
}

Suggested change:

private function setValueAfterValidation(string $value): void
{
    if (preg_match('/[^a-z0-9_\/\\-\\.]+/i', $value)
        // phpcs:ignore Magento2.Functions.DiscouragedFunction
        || !$this->_mediaDirectory->isFile($this->_getUploadDir() . DIRECTORY_SEPARATOR . basename($value))
    ) {
        throw new LocalizedException(__('Invalid file name: "%1".', $value));
    }

    $this->setValue($value);
}

Including the actual file name in the error message will make it easier to understand what went wrong and help debug the issue faster.

Steps to Reproduce:

1. Try to save a configuration with an invalid file name.
2. You’ll see a generic error message: Invalid file name.

Expected Result:
The error message should show the exact file name, like: Invalid file name: "default/logo.png".

Actual Result:
Currently, it just says: Invalid file name.

[m2-assistant]

Hi @obsergiu. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Bravo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Bravo]

Hi @obsergiu,

Thanks for your reporting and collaboration.

We are Considering this as a improvement to proceed further marking this as a feature request.

Thanks.

[jumaanji231]

I am using Magento 2.4.7p3 On a Nginx webserver + Varnish + Redis and elasticsearch 7 enabled. I am getting an error "Invalid File Name" whenever, i try to update a custom module configuration via Magento admin under general settings. I am also using a custom theme. There was no error log other then "Invalid File Name" error displayed on magneto admin end.

The above solution does work and displayed a file name without the direcoty name, so i further reasearch and added following code. It display an absolute directory path due to which i able to resolve the issue.

/vendor/magento/module-config/Model/Config/Backend

Updated function

private function setValueAfterValidation(string $value): void
{
if (preg_match('/[^a-z0-9_\/\\-\\.]+/i', $value)
// phpcs:ignore Magento2.Functions.DiscouragedFunction
|| !$this->_mediaDirectory->isFile($this->_getUploadDir() . DIRECTORY_SEPARATOR . basename($value))
) {
/* throw new LocalizedException(('Invalid file name')); /
/ throw new LocalizedException(('Invalid file name: "%1".', $value)); */
$filePath = $this->_mediaDirectory->getAbsolutePath($this->_getUploadDir() . DIRECTORY_SEPARATOR . basename($value));
if (!$this->_mediaDirectory->isFile($filePath)) {
throw new \Magento\Framework\Exception\LocalizedException(
__('Invalid file name: "%1". File does not exist at path: "%2".', $value, $filePath)
);
}

    }

In my case custom module directory path was misconfigured, i created the folder and related files - error resolved.

[gzldx]

protected function _getUploadDir()
    {
        $fieldConfig = $this->getFieldConfig();

        if (!array_key_exists('upload_dir', $fieldConfig)) {
            throw new LocalizedException(
                __('The base directory to upload file is not specified.')
            );
        }

        if (is_array($fieldConfig['upload_dir'])) {
            $uploadDir = $fieldConfig['upload_dir']['value'];
            if (array_key_exists('scope_info', $fieldConfig['upload_dir'])
                && $fieldConfig['upload_dir']['scope_info']
            ) {
                $uploadDir = $this->_appendScopeInfo($uploadDir);
            }

            if (array_key_exists('config', $fieldConfig['upload_dir'])) {
                $uploadDir = $this->getUploadDirPath($uploadDir);
            }
        } else {
            $uploadDir = (string)$fieldConfig['upload_dir'];
        }

        return $uploadDir;
    }

if has the scope_info attribute in upload_dir, the upload dir will append a default path.