Skip to content

[5.x] Prevent some folders from listing in template fieldtype#10031

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

Merged
jasonvarga merged 9 commits into from
May 27, 2024
Merged

[5.x] Prevent some folders from listing in template fieldtype #10031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dc340ae
prevent some folders from listing in template FT
peimn May 9, 2024
ecbc53e
Merge branch '5.x' into fix/template-list
jasonvarga May 24, 2024
6e33375
not everyone stores their views like this.
jasonvarga May 24, 2024
463ed9b
better tests, fix issues, and clean up.
jasonvarga May 24, 2024
53dda2c
handle symlinks
jasonvarga May 24, 2024
fd379a2
hush
jasonvarga May 24, 2024
582d482
tostring so the failure is readable
jasonvarga May 24, 2024
896367c
replace slashes for windows
jasonvarga May 24, 2024
f41cde8
fix test on windows
jasonvarga May 27, 2024
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
30 changes: 15 additions & 15 deletions src/Fieldtypes/TemplateFolder.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

public function getIndexItems($request)
{
return collect(config('view.paths'))
->flatMap(function ($path) {
$directories = collect();
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

foreach ($iterator as $file) {
if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
$directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
}
}

return $directories->filter()->values();
})
->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
->values();
return collect(config('view.paths'))->flatMap(function ($path) {
return collect(new RecursiveIteratorIterator(
new RecursiveCallbackFilterIterator(
new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
),
RecursiveIteratorIterator::SELF_FIRST
))->map(fn ($file) => Str::of($file->getPathname())
->after($path.DIRECTORY_SEPARATOR)
->replace('\\', '/')
->toString()
);
})->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
}
}
33 changes: 13 additions & 20 deletions src/Http/Controllers/CP/API/TemplatesController.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
public function index()
{
return collect(config('view.paths'))
->flatMap(function ($path) {
$views = collect();
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

foreach ($iterator as $file) {
if ($file->isFile()) {
$viewPath = Str::of($file->getPathname())
->after($path.DIRECTORY_SEPARATOR)
->before('.')
->replace('\\', '/')
->toString();

$views->push($viewPath);
}
}

return $views->filter()->sort()->values();
})
->values();
return collect(config('view.paths'))->flatMap(function ($path) {
return collect(new RecursiveIteratorIterator(
new RecursiveCallbackFilterIterator(
new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
)
))->map(fn ($file) => Str::of($file->getPathname())
->after($path.DIRECTORY_SEPARATOR)
->before('.')
->replace('\\', '/')
)->sort()->values();
});
}
}
108 changes: 108 additions & 0 deletions tests/Fieldtypes/TemplateFolderTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
private string $dir;

public function setUp(): void
{
parent::setUp();

app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

$this->app['config']->set('view.paths', [$this->dir.'/views']);
}

public function tearDown(): void
{
app('files')->deleteDirectory($this->dir);

parent::tearDown();
}

/** @test */
public function it_returns_a_list_of_directories()
{
$this->createFiles();

$fieldtype = $this->fieldtype();

$items = $fieldtype->getIndexItems(request());

// A collection with identical id/title keys are returned but we're only really concerned about the content.
$actual = $items->map->id->all();

$this->assertEquals([
'empty',
'empty-symlink',
'empty-symlink/three',
'one',
'one/two',
'symlink-dir',
'symlink-dir/five',
'symlink-dir/four',
], $actual);
}

private function createFiles()
{
$files = [
// Regular files, these should all be shown.
'alfa.html',
'one/bravo.html',
'one/two/charlie.html',
'one/two/delta.html',

// .git directories at any level should get filtered out
'.git/echo.html',
'one/.git/foxtrot.html',
'one/two/.git/golf.html',

// node_modules at any level should get filtered out
'node_modules/hotel.html',
'one/node_modules/india.html',
'one/two/node_modules/juliett.html',

// dotfiles at any level should get filtered out
'.kilo.html',
'one/.lima.html',
'one/two/.mike.html',
];

foreach ($files as $path) {
File::put($this->dir.'/views/'.$path, '');
}

// Empty directories should also be shown.
File::makeDirectory($this->dir.'/views/empty');

// Symlinked directories (even empties) should be shown.
File::makeDirectory($this->dir.'/empty-symlink-target');
File::makeDirectory($this->dir.'/empty-symlink-target/three');
File::put($this->dir.'/symlink-target-dir/tango.html', '');
File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
File::makeDirectory($this->dir.'/symlink-target-dir/five');
symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

// Symlinked files should not.
File::put($this->dir.'/foo.html', '');
symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
}

private function fieldtype()
{
$field = new Field('test', array_merge([
'type' => 'template_folder',
]));

return (new TemplateFolder)->setField($field);
}
}
75 changes: 68 additions & 7 deletions tests/Fieldtypes/TemplatesTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
use PreventSavingStacheItemsToDisk;

private string $dir;

public function setUp(): void
{
parent::setUp();

$this->app['config']->set('view.paths', [
__DIR__.'/../__fixtures__/templates',
]);
app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

$this->app['config']->set('view.paths', [$this->dir.'/views']);
}

public function tearDown(): void
{
app('files')->deleteDirectory($this->dir);

parent::tearDown();
}

/** @test */
public function it_returns_a_list_of_templates()
{
$files = [
// Regular files, these should all be shown.
'alfa.html',
'one/bravo.html',
'one/two/charlie.html',
'one/two/delta.html',

// .git directories at any level should get filtered out
'.git/echo.html',
'one/.git/foxtrot.html',
'one/two/.git/golf.html',

// node_modules at any level should get filtered out
'node_modules/hotel.html',
'one/node_modules/india.html',
'one/two/node_modules/juliett.html',

// dot directories at any level should get filtered out
'.kilo/lima.html',
'one/.mike/november.html',
'one/two/.oscar/papa.html',

// dotfiles at any level should get filtered out
'.quebec.html',
'one/.rome.html',
'one/two/.sierra.html',
];

foreach ($files as $path) {
File::put($this->dir.'/views/'.$path, '');
}

// Empty directories should be ignored.
File::makeDirectory($this->dir.'/views/empty');

// Empty symlinked directories should be ignored.
File::makeDirectory($this->dir.'/empty-symlink-target');
app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

// Files in symlinked directories should be shown.
File::put($this->dir.'/symlink-target-dir/tango.html', '');
File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

// Symlinked files should be shown.
File::put($this->dir.'/foo.html', '');
app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

$this
->actingAs(User::make()->makeSuper()->save())
->get(cp_route('api.templates.index'))
->assertJson([
'blog/index',
'conditions-literals',
'five_hundred_nested_ifs',
'nested-conditionals',
'alfa',
'one/bravo',
'one/two/charlie',
'one/two/delta',
'symlink-dir/tango',
'symlink-dir/three/uniform',
'victor',
]);
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[5.x] Prevent some folders from listing in template fieldtype by peimn · Pull Request #10031 · statamic/cms · GitHub
Skip to content
[5.x] Prevent some folders from listing in template fieldtype#10031

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

 Merged

jasonvarga
merged 9 commits into

from

May 27, 2024
 Merged


[5.x] Prevent some folders from listing in template fieldtype
#10031
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
dc340ae

prevent some folders from listing in template FT


peimn May 9, 2024
ecbc53e

Merge branch '5.x' into fix/template-list


jasonvarga May 24, 2024
6e33375

not everyone stores their views like this.


jasonvarga May 24, 2024
463ed9b

better tests, fix issues, and clean up.


jasonvarga May 24, 2024
53dda2c

handle symlinks


jasonvarga May 24, 2024
fd379a2

hush


jasonvarga May 24, 2024
582d482

tostring so the failure is readable


jasonvarga May 24, 2024
896367c

replace slashes for windows


jasonvarga May 24, 2024
f41cde8

fix test on windows


jasonvarga May 27, 2024

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


30 changes: 15 additions & 15 deletions
src/Fieldtypes/TemplateFolder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

namespace Statamic\Fieldtypes;

use FilesystemIterator;
use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Support\Str;
Expand All@@ -18,20 +20,18 @@ protected function toItemArray($id, $site = null)

 public function getIndexItems($request)
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $directories = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

 foreach ($iterator as $file) {
 if ($file->isDir() && ! $iterator->isDot() && ! $iterator->isLink()) {
 $directories->push(Str::replaceFirst($path.DIRECTORY_SEPARATOR, '', $file->getPathname()));
 }
 }

 return $directories->filter()->values();
 })
 ->map(fn ($folder) => ['id' => $folder, 'title' => $folder])
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS),
 fn ($file) => $file->isDir() && ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 ),
 RecursiveIteratorIterator::SELF_FIRST
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->replace('\\', '/')
 ->toString()
 );
 })->map(fn ($folder) => ['id' => $folder, 'title' => $folder])->sort()->values();
 }
}

33 changes: 13 additions & 20 deletions
src/Http/Controllers/CP/API/TemplatesController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Statamic\Http\Controllers\CP\API;

use RecursiveCallbackFilterIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use Statamic\Http\Controllers\CP\CpController;
Expand All@@ -11,25 +12,17 @@ class TemplatesController extends CpController
{
 public function index()
 {
 return collect(config('view.paths'))
 ->flatMap(function ($path) {
 $views = collect();
 $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));

 foreach ($iterator as $file) {
 if ($file->isFile()) {
 $viewPath = Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 ->toString();

 $views->push($viewPath);
 }
 }

 return $views->filter()->sort()->values();
 })
 ->values();
 return collect(config('view.paths'))->flatMap(function ($path) {
 return collect(new RecursiveIteratorIterator(
 new RecursiveCallbackFilterIterator(
 new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS),
 fn ($file) => ! str_starts_with($file->getFilename(), '.') && ! in_array($file->getBaseName(), ['node_modules'])
 )
 ))->map(fn ($file) => Str::of($file->getPathname())
 ->after($path.DIRECTORY_SEPARATOR)
 ->before('.')
 ->replace('\\', '/')
 )->sort()->values();
 });
 }
}

108 changes: 108 additions & 0 deletions
tests/Fieldtypes/TemplateFolderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
<?php

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\TemplateFolder;
use Tests\TestCase;

class TemplateFolderTest extends TestCase
{
 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_directories()
 {
 $this->createFiles();

 $fieldtype = $this->fieldtype();

 $items = $fieldtype->getIndexItems(request());

 // A collection with identical id/title keys are returned but we're only really concerned about the content.
 $actual = $items->map->id->all();

 $this->assertEquals([
 'empty',
 'empty-symlink',
 'empty-symlink/three',
 'one',
 'one/two',
 'symlink-dir',
 'symlink-dir/five',
 'symlink-dir/four',
 ], $actual);
 }

 private function createFiles()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dotfiles at any level should get filtered out
 '.kilo.html',
 'one/.lima.html',
 'one/two/.mike.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should also be shown.
 File::makeDirectory($this->dir.'/views/empty');

 // Symlinked directories (even empties) should be shown.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 File::makeDirectory($this->dir.'/empty-symlink-target/three');
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/four/uniform.html', '');
 File::makeDirectory($this->dir.'/symlink-target-dir/five');
 symlink($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');
 symlink($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should not.
 File::put($this->dir.'/foo.html', '');
 symlink($this->dir.'/foo.html', $this->dir.'/views/victor.html');
 }

 private function fieldtype()
 {
 $field = new Field('test', array_merge([
 'type' => 'template_folder',
 ]));

 return (new TemplateFolder)->setField($field);
 }
}

75 changes: 68 additions & 7 deletions
tests/Fieldtypes/TemplatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\Fieldtypes;

use Statamic\Facades\File;
use Statamic\Facades\User;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand All@@ -10,26 +11,86 @@ class TemplatesTest extends TestCase
{
 use PreventSavingStacheItemsToDisk;

 private string $dir;

 public function setUp(): void
 {
 parent::setUp();

 $this->app['config']->set('view.paths', [
 __DIR__.'/../__fixtures__/templates',
 ]);
 app('files')->makeDirectory($this->dir = __DIR__.'/templates-test-tmp', force: true);

 $this->app['config']->set('view.paths', [$this->dir.'/views']);
 }

 public function tearDown(): void
 {
 app('files')->deleteDirectory($this->dir);

 parent::tearDown();
 }

 /** @test */
 public function it_returns_a_list_of_templates()
 {
 $files = [
 // Regular files, these should all be shown.
 'alfa.html',
 'one/bravo.html',
 'one/two/charlie.html',
 'one/two/delta.html',

 // .git directories at any level should get filtered out
 '.git/echo.html',
 'one/.git/foxtrot.html',
 'one/two/.git/golf.html',

 // node_modules at any level should get filtered out
 'node_modules/hotel.html',
 'one/node_modules/india.html',
 'one/two/node_modules/juliett.html',

 // dot directories at any level should get filtered out
 '.kilo/lima.html',
 'one/.mike/november.html',
 'one/two/.oscar/papa.html',

 // dotfiles at any level should get filtered out
 '.quebec.html',
 'one/.rome.html',
 'one/two/.sierra.html',
 ];

 foreach ($files as $path) {
 File::put($this->dir.'/views/'.$path, '');
 }

 // Empty directories should be ignored.
 File::makeDirectory($this->dir.'/views/empty');

 // Empty symlinked directories should be ignored.
 File::makeDirectory($this->dir.'/empty-symlink-target');
 app('files')->link($this->dir.'/empty-symlink-target', $this->dir.'/views/empty-symlink');

 // Files in symlinked directories should be shown.
 File::put($this->dir.'/symlink-target-dir/tango.html', '');
 File::put($this->dir.'/symlink-target-dir/three/uniform.html', '');
 app('files')->link($this->dir.'/symlink-target-dir', $this->dir.'/views/symlink-dir');

 // Symlinked files should be shown.
 File::put($this->dir.'/foo.html', '');
 app('files')->link($this->dir.'/foo.html', $this->dir.'/views/victor.html');

 $this
 ->actingAs(User::make()->makeSuper()->save())
 ->get(cp_route('api.templates.index'))
 ->assertJson([
 'blog/index',
 'conditions-literals',
 'five_hundred_nested_ifs',
 'nested-conditionals',
 'alfa',
 'one/bravo',
 'one/two/charlie',
 'one/two/delta',
 'symlink-dir/tango',
 'symlink-dir/three/uniform',
 'victor',
 ]);
 }
}