Skip to content

Fix unprovoked symlink errors in directory_entry #353

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

Draft
stm-ableton wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Fix unprovoked symlink errors in directory_entry #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 19 additions & 9 deletions include/boost/filesystem/directory.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ class directory_entry
file_status status() const
{
if (!filesystem::status_known(m_status))
refresh_impl();
refresh_impl(refresh_mode::follow);
return m_status;
}

Expand All @@ -215,14 +215,14 @@ class directory_entry
ec.clear();

if (!filesystem::status_known(m_status))
refresh_impl(&ec);
refresh_impl(&ec, refresh_mode::follow);
return m_status;
}

file_status symlink_status() const
{
if (!filesystem::status_known(m_symlink_status))
refresh_impl();
refresh_impl(refresh_mode::no_follow);
return m_symlink_status;
}

Expand All @@ -231,14 +231,14 @@ class directory_entry
ec.clear();

if (!filesystem::status_known(m_symlink_status))
refresh_impl(&ec);
refresh_impl(&ec, refresh_mode::no_follow);
return m_symlink_status;
}

filesystem::file_type file_type() const
{
if (!filesystem::type_present(m_status))
refresh_impl();
refresh_impl(refresh_mode::follow);
return m_status.type();
}

Expand All @@ -247,14 +247,14 @@ class directory_entry
ec.clear();

if (!filesystem::type_present(m_status))
refresh_impl(&ec);
refresh_impl(&ec, refresh_mode::follow);
return m_status.type();
}

filesystem::file_type symlink_file_type() const
{
if (!filesystem::type_present(m_symlink_status))
refresh_impl();
refresh_impl(refresh_mode::no_follow);
return m_symlink_status.type();
}

Expand All @@ -263,7 +263,7 @@ class directory_entry
ec.clear();

if (!filesystem::type_present(m_symlink_status))
refresh_impl(&ec);
refresh_impl(&ec, refresh_mode::no_follow);
return m_symlink_status.type();
}

Expand Down Expand Up @@ -381,7 +381,17 @@ class directory_entry
bool operator>=(directory_entry const& rhs) const { return m_path >= rhs.m_path; }

private:
BOOST_FILESYSTEM_DECL void refresh_impl(system::error_code* ec = nullptr) const;
enum class refresh_mode
{
no_follow,
follow,
follow_lenient
};

BOOST_FILESYSTEM_DECL void refresh_impl(
system::error_code* ec = nullptr,
refresh_mode mode = refresh_mode::follow_lenient) const;
void refresh_impl(refresh_mode mode) const { refresh_impl(nullptr, mode); }

void assign_with_status(boost::filesystem::path&& p, file_status st, file_status symlink_st)
{
Expand Down
10 changes: 7 additions & 3 deletions src/directory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,9 @@ namespace filesystem {
// //
//--------------------------------------------------------------------------------------//

BOOST_FILESYSTEM_DECL void directory_entry::refresh_impl(system::error_code* ec) const
BOOST_FILESYSTEM_DECL void directory_entry::refresh_impl(
system::error_code* ec,
directory_entry::refresh_mode mode) const
{
m_status = filesystem::file_status();
m_symlink_status = filesystem::file_status();
Expand All @@ -116,9 +118,11 @@ BOOST_FILESYSTEM_DECL void directory_entry::refresh_impl(system::error_code* ec)
// Also works if symlink_status fails - set m_status to status_error as well
m_status = m_symlink_status;
}
else
else if (mode != refresh_mode::no_follow)
{
m_status = detail::status(m_path, ec);
system::error_code ec2;
// Don't clobber ec after the symlink_status call
m_status = detail::status(m_path, mode == refresh_mode::follow_lenient ? &ec2 : ec);
}
}

Expand Down
192 changes: 191 additions & 1 deletion test/operations_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,7 +934,7 @@ void create_symlink_tests()
BOOST_TEST(!fs::is_other(stat));
}

error_code ec = error_code();
error_code ec;
fs::create_symlink("doesnotexist", "", ec);
BOOST_TEST(ec);
}
Expand Down Expand Up @@ -2403,6 +2403,194 @@ void symlink_is_empty_tests()
BOOST_TEST_EQ(empty, true);
}

// directory_entry_tests ----------------------------------------------------//

void directory_entry_tests()
{
cout << "directory_entry_tests..." << endl;

fs::path reg_file(dir / "reg-file");
fs::path nonexistent_file(dir / "nonexistent-file");
fs::remove(reg_file);
fs::remove(nonexistent_file);
create_file(reg_file);
error_code ec;

fs::directory_entry reg_entry(reg_file);
fs::directory_entry nonexistent_entry(nonexistent_file);

BOOST_TEST(reg_entry.exists());
BOOST_TEST(reg_entry.exists(ec));
BOOST_TEST(!ec);
BOOST_TEST_EQ(reg_entry.status().type(), fs::regular_file);
BOOST_TEST_EQ(reg_entry.status(ec).type(), fs::regular_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(reg_entry.symlink_status().type(), fs::regular_file);
BOOST_TEST_EQ(reg_entry.symlink_status(ec).type(), fs::regular_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(reg_entry.file_type(), fs::regular_file);
BOOST_TEST_EQ(reg_entry.file_type(ec), fs::regular_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(reg_entry.symlink_file_type(), fs::regular_file);
BOOST_TEST_EQ(reg_entry.symlink_file_type(ec), fs::regular_file);
BOOST_TEST(!ec);

reg_entry.refresh(ec);
BOOST_TEST(!ec);

// Make sure status() and symlink_status() hold the expected types
// after a call to refresh, too
BOOST_TEST_EQ(reg_entry.symlink_status().type(), fs::regular_file);
BOOST_TEST_EQ(reg_entry.status().type(), fs::regular_file);

#if BOOST_FILESYSTEM_VERSION >= 4
// ctor overload with error_code
{
ec.clear();
fs::directory_entry reg_entry2(reg_file, ec);
BOOST_TEST(!ec);
BOOST_TEST(reg_entry2.path() == reg_file);
}

// assign overload with error_code
ec.clear();
reg_entry.assign(reg_file, ec);
BOOST_TEST(!ec);
BOOST_TEST(reg_entry.path() == reg_file);
#endif

// Missing file
BOOST_TEST_EQ(nonexistent_entry.status().type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.status(ec).type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.symlink_status().type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.symlink_status(ec).type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.file_type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.file_type(ec), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.symlink_file_type(), fs::file_not_found);
BOOST_TEST_EQ(nonexistent_entry.symlink_file_type(ec), fs::file_not_found);
BOOST_TEST(!nonexistent_entry.exists(ec));
BOOST_TEST(!nonexistent_entry.exists());

#if BOOST_FILESYSTEM_VERSION >= 4
// ctor overload with error_code
{
ec.clear();
fs::directory_entry nonexistent_entry2(nonexistent_file, ec);
BOOST_TEST(ec);
BOOST_TEST(nonexistent_entry2.path().empty());
}

// assign overload with error_code
ec.clear();
nonexistent_entry.assign(nonexistent_file, ec);
BOOST_TEST(ec);
BOOST_TEST_EQ(nonexistent_entry.path(), nonexistent_file);
#endif

fs::remove(reg_file);
}

// directory_entry_symlink_tests --------------------------------------------//

void directory_entry_symlink_tests()
{
cout << "directory_entry_symlink_tests..." << endl;

fs::path reg_file(dir / "reg-file");
fs::path valid_sym(dir / "valid-sym");
fs::path dangling_sym(dir / "dangling-sym");
fs::remove(reg_file);
fs::remove(valid_sym);
fs::remove(dangling_sym);
create_file(reg_file);
fs::create_symlink(reg_file, valid_sym);
fs::create_symlink("does not exist", dangling_sym);
error_code ec;

fs::directory_entry sym_entry(valid_sym);
fs::directory_entry dsym_entry(dangling_sym);

// Valid symlink
BOOST_TEST(sym_entry.exists());
BOOST_TEST(sym_entry.exists(ec));
BOOST_TEST(!ec);
BOOST_TEST(sym_entry.is_symlink());
BOOST_TEST(sym_entry.is_symlink(ec));
BOOST_TEST(!ec);
BOOST_TEST_EQ(sym_entry.status().type(), fs::regular_file);
BOOST_TEST_EQ(sym_entry.status(ec).type(), fs::regular_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(sym_entry.symlink_status().type(), fs::symlink_file);
BOOST_TEST_EQ(sym_entry.symlink_status(ec).type(), fs::symlink_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(sym_entry.file_type(), fs::regular_file);
BOOST_TEST_EQ(sym_entry.file_type(ec), fs::regular_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(sym_entry.symlink_file_type(), fs::symlink_file);
BOOST_TEST_EQ(sym_entry.symlink_file_type(ec), fs::symlink_file);
BOOST_TEST(!ec);

BOOST_TEST(!dsym_entry.exists());
BOOST_TEST(!dsym_entry.exists(ec));
ec.clear();
BOOST_TEST(dsym_entry.is_symlink());
BOOST_TEST(dsym_entry.is_symlink(ec));
BOOST_TEST(!ec);
BOOST_TEST_EQ(dsym_entry.status().type(), fs::file_not_found);
BOOST_TEST_EQ(dsym_entry.status(ec).type(), fs::file_not_found);
ec.clear();
BOOST_TEST_EQ(dsym_entry.symlink_status().type(), fs::symlink_file);
BOOST_TEST_EQ(dsym_entry.symlink_status(ec).type(), fs::symlink_file);
BOOST_TEST(!ec);
BOOST_TEST_EQ(dsym_entry.file_type(), fs::file_not_found);
BOOST_TEST_EQ(dsym_entry.file_type(ec), fs::file_not_found);
ec.clear();
BOOST_TEST_EQ(dsym_entry.symlink_file_type(), fs::symlink_file);
BOOST_TEST_EQ(dsym_entry.symlink_file_type(ec), fs::symlink_file);
BOOST_TEST(!ec);

sym_entry.refresh(ec);
BOOST_TEST(!ec);
dsym_entry.refresh(ec);
BOOST_TEST(!ec);

// Make sure status() and symlink_status() hold the expected types
// after a call to refresh, too
BOOST_TEST_EQ(sym_entry.symlink_status().type(), fs::symlink_file);
BOOST_TEST_EQ(sym_entry.status().type(), fs::regular_file);
BOOST_TEST_EQ(dsym_entry.symlink_status().type(), fs::symlink_file);
BOOST_TEST_EQ(dsym_entry.status().type(), fs::file_not_found);

#if BOOST_FILESYSTEM_VERSION >= 4
// ctor overload with error_code
{
ec.clear();
fs::directory_entry sym_entry2(valid_sym, ec);
BOOST_TEST(!ec);
BOOST_TEST(sym_entry2.path() == valid_sym);

// In particular, shouldn't report an error with broken symlinks
fs::directory_entry dsym_entry2(dangling_sym, ec);
BOOST_TEST(!ec);
BOOST_TEST(dsym_entry2.path() == dangling_sym);
}

ec.clear();
sym_entry.assign(valid_sym, ec);
BOOST_TEST(!ec);
BOOST_TEST(sym_entry.path() == valid_sym);

// In particular, shouldn't report an error with broken symlinks
dsym_entry.assign(dangling_sym, ec);
BOOST_TEST(!ec);
BOOST_TEST(dsym_entry.path() == dangling_sym);
#endif

fs::remove(reg_file);
fs::remove(valid_sym);
fs::remove(dangling_sym);
}

// write_time_tests ----------------------------------------------------------------//

void write_time_tests(const fs::path& dirx)
Expand Down Expand Up @@ -3025,6 +3213,7 @@ int cpp_main(int argc, char* argv[])
weakly_canonical_basic_tests();
permissions_tests();
copy_file_tests(f1, d1);
directory_entry_tests();
if (create_symlink_ok) // only if symlinks supported
{
symlink_status_tests();
Expand All @@ -3033,6 +3222,7 @@ int cpp_main(int argc, char* argv[])
weakly_canonical_symlink_tests();
symlink_file_size_tests();
symlink_is_empty_tests();
directory_entry_symlink_tests();
}
iterator_status_tests(); // lots of cases by now, so a good time to test
// dump_tree(dir);
Expand Down