Skip to content
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.

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

3.7.x: EntryFilter#filter symlink fix #7224

Merged
merged 7 commits into from Sep 7, 2018
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/jekyll/entry_filter.rb
Expand Up @@ -31,9 +31,9 @@ def relative_to_source(entry)

def filter(entries)
entries.reject do |e|
unless included?(e)
special?(e) || backup?(e) || excluded?(e) || symlink?(e)
end
next true if symlink?(e)
next false if included?(e)
Copy link
Member

Choose a reason for hiding this comment

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

@parkr For knowledge purposes, can you pleas explain what these two lines mean..?

Thanks =)

Copy link
Member

@DirtyF DirtyF Sep 6, 2018

Choose a reason for hiding this comment

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

We first check for symlinks and directly go to next entry if true

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a comment!

special?(e) || backup?(e) || excluded?(e)
end
end

Expand Down
1 change: 1 addition & 0 deletions test/source/symlink-test/symlinked-file-outside-source
11 changes: 11 additions & 0 deletions test/test_entry_filter.rb
Expand Up @@ -105,6 +105,17 @@ class TestEntryFilter < JekyllUnitTest
refute_equal [], site.pages
refute_equal [], site.static_files
end

should "include only safe symlinks in safe mode even when included" do
# no support for symlinks on Windows
skip_if_windows "Jekyll does not currently support symlinks on Windows."

site = Site.new(site_configuration("safe" => true, "include" => ["symlinked-file-outside-source"]))
Copy link
Member

Choose a reason for hiding this comment

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

We have a helper for this.. fixture_site

site = fixture_site(
  :safe => true,
  :include => ["filename"]
)

site.reader.read_directories("symlink-test")

assert_equal %w(main.scss symlinked-file).length, site.pages.length
refute_includes site.static_files.map(&:name), "symlinked-file-outside-source"
end
end

context "#glob_include?" do
Expand Down
41 changes: 41 additions & 0 deletions test/test_layout_reader.rb
Expand Up @@ -31,5 +31,46 @@ class TestLayoutReader < JekyllUnitTest
assert_equal LayoutReader.new(@site).layout_directory, source_dir("blah/_layouts")
end
end

context "when a layout is a symlink" do
setup do
FileUtils.ln_sf("/etc/passwd", source_dir("_layouts", "symlink.html"))
@site.config = @site.config.merge({
"safe" => true,
"include" => ["symlink.html"],
})
end

teardown do
FileUtils.rm(source_dir("_layouts", "symlink.html"))
end

should "only read the layouts which are in the site" do
layouts = LayoutReader.new(@site).read

refute layouts.keys.include?("symlink"), "Should not read the symlinked layout"
Copy link
Member

Choose a reason for hiding this comment

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

Prefer using Hash#include? or Hash#key?` instead..?

end
end

context "with a theme" do
setup do
FileUtils.ln_sf("/etc/passwd", theme_dir("_layouts", "theme-symlink.html"))
@site.config = @site.config.merge({
"include" => ["theme-symlink.html"],
"theme" => "test-theme",
"safe" => true,
})
end

teardown do
FileUtils.rm(theme_dir("_layouts", "theme-symlink.html"))
end

should "not read a symlink'd theme" do
layouts = LayoutReader.new(@site).read

refute layouts.keys.include?("theme-symlink"), "Should not read symlinked layout from theme"
end
end
end
end