А static element can't be saved

[sergant210]

Bug report

Summary

А static element can't be saved.

Step to reproduce

Create a snippet, check the "Is static" checkbox and try to save it.

Observed behavior

And I got an error message in the log

[2021-12-04 07:50:33] (ERROR @ C:\Projects\modx3.local\core\src\Revolution\Sources\modMediaSource.php : 562) Unable to retrieve the last_modified for file at location: C:/Projects/modx3.local/core/components/pdotools/elements/snippets/snippet.pdoresources.php. filemtime(): stat failed for C:\Projects\modx3.local\C:/Projects/modx3.local/core/components/pdotools/elements/snippets/snippet.pdoresources.php

There is invalid file path - C:\Projects\modx3.local\C:/Projects/modx3.local/core/components/pdotools/elements/snippets/snippet.pdoresources.php.

Environment

MODX3 Beta 2.
Windows 10.

[Ibochkarev]

1) If the media source is not selected and you are trying to save, then we get an error

I also get an error when trying to save a text snippet

2) If you tried to save and you don't have the source selected, and then you select it, we get this error

[2021-12-05 10:55:45] (ERROR @ /home/s28269/www/core/src/Revolution/Sources/modMediaSource.php : 585) Unable to read file from location: home/s28269/www/assets/static/snippets/test.snippet.php. file_get_contents(/home/s28269/www/home/s28269/www/assets/static/snippets/test.snippet.php): failed to open stream: No such file or directory
[2021-12-05 10:55:45] (ERROR @ /home/s28269/www/core/src/Revolution/Sources/modMediaSource.php : 562) Unable to retrieve the last_modified for file at location: home/s28269/www/assets/static/snippets/test.snippet.php. filemtime(): stat failed for /home/s28269/www/home/s28269/www/assets/static/snippets/test.snippet.php
[2021-12-05 10:55:45] (ERROR @ /home/s28269/www/core/src/Revolution/Sources/modMediaSource.php : 585) Unable to read file from location: home/s28269/www/assets/static/snippets/test.snippet.php. file_get_contents(/home/s28269/www/home/s28269/www/assets/static/snippets/test.snippet.php): failed to open stream: No such file or directory
[2021-12-05 10:55:45] (ERROR @ /home/s28269/www/core/src/Revolution/Sources/modMediaSource.php : 562) Unable to retrieve the last_modified for file at location: assets/static/snippets/test.snippet.php. filemtime(): stat failed for /home/s28269/www/assets/static/snippets/test.snippet.php
[2021-12-05 10:55:45] (ERROR @ /home/s28269/www/core/src/Revolution/modSnippet.php : 52) An error occurred while creating the snippet.Array
(
    [id] => 1
    [source] => 1
    [property_preprocess] => 
    [name] => test
    [description] => 
    [editor_type] => 0
    [category] => 0
    [cache_type] => 0
    [snippet] => 
    [locked] => 
    [properties] => Array
        (
        )

    [moduleguid] => 
    [static] => 1
    [static_file] => assets/static/snippets/test.snippet.php
    [content] => 
    [action] => Element/Snippet/Create
    [propdata] => []
    [props] => 
    [clearCache] => 1
)

3) If you select the source before trying to save, everything is OK

[JoshuaLuckers]

@Mark-H could it be related to the changes in PR #15843?

[Mark-H]

Maybe, if 3.x changed the way static elements are handled. I don't think the file type (extension) restriction affected static elements in 2.x.

[JoshuaLuckers]

There are two issues here:

Issue 1

Unable to retrieve the last_modified for file at location because getMetaData logs an error because the directory/file doesn't exist:

revolution/core/src/Revolution/Sources/modMediaSource.php

Line 552 in 38ab332

public function getMetaData($path)

We call this method in isStaticSourceMutable:

revolution/core/src/Revolution/modElement.php

Line 1148 in 565537a

if (!$isMutable = (bool)$source->getMetaData($sourceFile)) {

Issue 2

Static files can't be saved because .php and .tpl etc are now allowed:

revolution/core/src/Revolution/Sources/modMediaSource.php

Line 698 in 38ab332

if (!$this->checkFileType($path)) {

[sergant210]

Issue 2 is solved by adding the appropriate extensions to the "upload_files" system setting. This should be written in the documentation.

Issue 1 workflow is as follows:

1. You specify a relative path to a static file - "core/elements/snippets/snippet.php".
2. modMediaSource gets the full path - "/home/user/www/core/elements/snippets/snippet.php".
   

   revolution/core/src/Revolution/modElement.php

   Line 593 in 8f9c31b

   $result = $source->getBasePath() . $filename;

3. Then the getMetaData method is called, in which we can see the following line

$data['timestamp'] = $this->filesystem->lastModified($path);

4. League\Flysystem\Local\LocalFilesystemAdapter::lastModified()
   
   And the file path now is "/home/user/www/home/user/www/core/elements/snippets/snippet.php".

[JoshuaLuckers]

Issue 2 is solved by adding the appropriate extensions to the "upload_files" system setting. This should be written in the documentation.

Yes, but I believe it's not in there by default for security purposes. The same applies for .html and .tpl (used for templates and chunks).

[smg6511]

Guys, re Issue 2, even if 2.x behaved differently I think how it works now is the way it should. After all, if you're going to allow the saving of or duplicating of a file type that's not in the upload_files list, you might as well be allowing it for uploads. One can always lock down that list by overriding the setting on the user/user group level.

For Issue 1, would it make sense to check for the prefix in the getMetaData method and strip it out if present when setting $data['timestamp'] = $this->filesystem->lastModified($path)?

I happen to be working on this issue in a different area (the duplication of static elements via the context menu) where Issue 2 occurs when trying to duplicate a static element with a file type not in upload_files. What happens there is the element gets duplicated but the file does not get written and you're left with the duplicate window still open and no indication of what happened.