Problem with invalid escaping in Clockwork FileStorage when using fputcsv

[SheylaSilvana]

Problem with invalid escaping in Clockwork FileStorage when using fputcsv

When configuring Clockwork to use FileStorage, an error occurs when writing to the index file using the fputcsv function. The error occurs because the escape character provided for the function is not valid. The problem appears with the following error message:

ErrorException: fputcsv(): escape must be a character

This problem occurs because the fourth parameter of fputcsv (escape) is not a valid character. By default, FileStorage escapes an empty value (''), which causes the error.

To reproduce the issue, configure Clockwork to use FileStorage in the configuration file as follows:

'storage' => env('CLOCKWORK_STORAGE', 'files'),
'storage_files_path' => env('CLOCKWORK_STORAGE_FILES_PATH', storage_path('clockwork')),

Then, make a request to the application and observe the error generated in the log. This issue has been identified in the following environment:

• Operating System: Windows/Linux
• PHP version: 7.3
• Clockwork version: 5.3.3
• Framework: Laravel Lumen 8.3

Related Code:

In the file Clockwork\Storage\FileStorage, the updateIndex method uses:

fputcsv($handle, [...], ',', '"', '');

Possible Solution:

Change the updateIndex method in the FileStorage file to use a valid escape character (for example, ):

fputcsv($handle, [...], ',', '"', '\\');