Cached formatted Images not deleted when image file renamed

[sheadawson]

A bit of an edge case, but there is an issue where, for example - If I upload 2 images, image-1.jpg and image-2.jpg... and then renamed image-1.jpg to image-1a.jpg, and renamed image-2.jpg to "image-1.jpg", any resampled image-1.jpg images with the same resampling method and sizes will refer to a cached version of the original image-1.jpg, which is actually a different image.

A possible solution for this would be to deleteFormattedImages when an image file is renamed. Here's an extension I wrote to get around it

class CustomImage extends DataExtension{

    public function onBeforeWrite(){
        // Delete formatted images if the filename has changed
        $changed = $this->owner->getChangedFields();
        if(isset($changed['Name'])){
            $this->owner->Name = $changed['Name']['before'];
            $this->owner->Filename = $changed['Filename']['before'];
            $this->owner->deleteFormattedImages();
            $this->owner->Name = $changed['Name']['after'];
            $this->owner->Filename = $changed['Filename']['after'];
        }
    }
}  

[micmania1]

@sheadawson This would probably solve silverstripe/silverstripe-cms#997 too. Sounds like the same issue.

[tractorcow]

I would be careful of changing the data fields during an onbeforewrite, but the methodology seems ok. Maybe clone the object just to be safe.

You should also take into consideration that the file may be moved to another parent directory.

[sheadawson]

Both excellent points @tractorcow

[tractorcow]

This is taken care of in 4.x. On move / rename, all variants are also moved.

[dhensby]

@tractorcow did your recent patch cause any regressions in this regard?

[dhensby]

silverstripe/silverstripe-assets#56

[tractorcow]

In 4.x if you rename a file, all variants are renamed at the same time.