Skip to content

Filenames with slashes in volume filtering #1466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yannik131 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Filenames with slashes in volume filtering #1466

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ddb38e
Added additional escaping for filename controller
yannik131 May 20, 2026
9448a41
Removed trailing whitespace, formatting
yannik131 May 21, 2026
ed957be
Apply suggestions from code review
yannik131 May 21, 2026
fe6f98a
Remove manual encoding/decoding, unravel test loop
yannik131 May 22, 2026
5c3d72e
Removed unused code
yannik131 May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/Http/Controllers/Api/Volumes/Filters/FilenameController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ public function index($id, $pattern)
$volume = Volume::findOrFail($id);
$this->authorize('access', $volume);

// Decode percent-encoded characters, example:
// Frontend turns / into %2F, we turn it back to /
$pattern = rawurldecode($pattern);

// Escape trailing backslashes, else there would be an error with ilike.
$pattern = preg_replace('/\\\\$/', '\\\\\\\\', $pattern);

Expand Down
2 changes: 1 addition & 1 deletion resources/assets/js/volumes/cloneForm.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export default {
let promise1 = VolumeApi.queryFilenames({id: this.id});
let promise2 = VolumeApi.queryFilesWithFilename({
id: this.id,
pattern: this.filePattern
pattern: encodeURIComponent(this.filePattern)
Comment thread
yannik131 marked this conversation as resolved.
Outdated
});

Promise.all([promise1, promise2])
Expand Down
2 changes: 1 addition & 1 deletion resources/assets/js/volumes/stores/filters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ let filenameFilter = {
getSequence(volumeId, pattern) {
return VolumesApi.queryFilesWithFilename({
id: volumeId,
pattern: pattern,
pattern: encodeURIComponent(pattern),
});
},
Comment thread
yannik131 marked this conversation as resolved.
};
Expand Down
2 changes: 1 addition & 1 deletion routes/api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@

$router->get('{id}/files/filter/filename/{pattern}', [
'uses' => 'Filters\FilenameController@index',
]);
])->where('pattern', '.*');
Copy link
Copy Markdown
Member

@mzur mzur May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this if it matches anything?

Copy link
Copy Markdown
Contributor Author

@yannik131 yannik131 May 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After additional investigation:

  • Laravel already encodes/decodes URI components
  • However, laravel decodes the route parameters and throws an exception if the decoded pattern contains invalid characters such as slashes
  • 2 possible fixes:
    • encode/decode manually on top of vue/laravel encoding/decoding, then laravel can't "see" the invalid characters after decoding the pattern just once
    • add the ->where('pattern', '.*'); to explicitly allow any characters, including slashes

The second approach is actually cleaner so I'll remove the manual encoding/decoding

Copy link
Copy Markdown
Member

@mzur mzur May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a comment here why this is used, then. And you think we shouldn't use encodeURIComponent in JS as well? Is seems a safer bet.


$router->get('{id}/file-labels', [
'uses' => 'UsedFileLabelsController@index',
Expand Down
26 changes: 22 additions & 4 deletions tests/php/Http/Controllers/Api/Volumes/Filters/FilenameControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,32 @@ public function testIndexEscape()
{
$vid = $this->volume()->id;

$image = ImageTest::create([
$image1 = ImageTest::create([
'volume_id' => $vid,
'filename' => 'abcde.jpg',
]);
$image2 = ImageTest::create([
'volume_id' => $vid,
'filename' => '/.jpg',
]);
$image3 = ImageTest::create([
'volume_id' => $vid,
'filename' => '%2F.jpg', // encodeURIComponent("/") yields "%2F"
]);

$expectedResults = [
'*cde*%5C' => [],
'%2F.jpg' => [$image2->id], // "/.jpg"
'%2F*' => [$image2->id], // "/*"
'%25252F.jpg' => [$image3->id], // "%2F.jpg"
];

$this->beGuest();
$response = $this->json('GET', "/api/v1/volumes/{$vid}/files/filter/filename/*cde*%5C")
->assertExactJson([]);
$response->assertStatus(200);
foreach ($expectedResults as $pattern => $expectedIds) {
$response = $this->json('GET', "/api/v1/volumes/{$vid}/files/filter/filename/{$pattern}")
->assertExactJson($expectedIds);
$response->assertStatus(200);
}
}

public function testIndexVideo()
Expand Down