Skip to content

Fix rename_file and delete_file to handle hidden files properly #1073

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
merged 2 commits into from
Nov 18, 2022
Merged

Fix rename_file and delete_file to handle hidden files properly #1073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5d7db4
Fix for determining if a file is hidden and tests for rename_file and…
yacchin1205 Nov 18, 2022
6958baa
Merge branch 'main' into fix/rename-delete-hidden-file
yacchin1205 Nov 18, 2022
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
17 changes: 13 additions & 4 deletions jupyter_server/services/contents/filemanager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,14 +468,14 @@ def delete_file(self, path):
path = path.strip("/")
os_path = self._get_os_path(path)
rm = os.unlink
four_o_four = "file or directory does not exist: %r" % path

if not self.exists(path):
raise web.HTTPError(404, four_o_four)

if is_hidden(os_path, self.root_dir) and not self.allow_hidden:
raise web.HTTPError(400, f"Cannot delete file or directory {os_path!r}")

four_o_four = "file or directory does not exist: %r" % path
if not self.exists(path):
raise web.HTTPError(404, four_o_four)

def _check_trash(os_path):
if sys.platform in {"win32", "darwin"}:
return True
Expand Down Expand Up @@ -805,6 +805,10 @@ async def delete_file(self, path):
path = path.strip("/")
os_path = self._get_os_path(path)
rm = os.unlink

if is_hidden(os_path, self.root_dir) and not self.allow_hidden:
raise web.HTTPError(400, f"Cannot delete file or directory {os_path!r}")

if not os.path.exists(os_path):
raise web.HTTPError(404, "File or directory does not exist: %s" % os_path)

Expand Down Expand Up @@ -876,6 +880,11 @@ async def rename_file(self, old_path, new_path):
new_os_path = self._get_os_path(new_path)
old_os_path = self._get_os_path(old_path)

if (
is_hidden(old_os_path, self.root_dir) or is_hidden(new_os_path, self.root_dir)
) and not self.allow_hidden:
raise web.HTTPError(400, f"Cannot rename file or directory {old_os_path!r}")

# Should we proceed with the move?
if os.path.exists(new_os_path) and not samefile(old_os_path, new_os_path):
raise web.HTTPError(409, "File already exists: %s" % new_path)
Expand Down
132 changes: 56 additions & 76 deletions tests/services/contents/test_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,34 +264,26 @@ async def test_403(jp_file_contents_manager_class, tmp_path):
async def test_400(jp_file_contents_manager_class, tmp_path):
# Test Delete behavior
# Test delete of file in hidden directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
os_path = cm._get_os_path(model["path"])
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)

try:
result = await ensure_async(cm.delete_file(os_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.delete_file(file_in_hidden_path))
assert excinfo.value.status_code == 400

# Test delete hidden file in visible directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
os_path = cm._get_os_path(model["path"])
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)

try:
result = await ensure_async(cm.delete_file(os_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.delete_file(file_in_hidden_path))
assert excinfo.value.status_code == 400

# Test Save behavior
# Test save of file in hidden directory
Expand Down Expand Up @@ -326,68 +318,56 @@ async def test_400(jp_file_contents_manager_class, tmp_path):

# Test rename behavior
# Test rename with source file in hidden directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
old_path = cm._get_os_path(model["path"])
new_path = "new.txt"
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)
old_path = file_in_hidden_path
new_path = "new.txt"

try:
result = await ensure_async(cm.rename_file(old_path, new_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.rename_file(old_path, new_path))
assert excinfo.value.status_code == 400

# Test rename of dest file in hidden directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
new_path = cm._get_os_path(model["path"])
old_path = "old.txt"
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = ".hidden"
file_in_hidden_path = os.path.join(hidden_dir, "visible.txt")
_make_dir(cm, hidden_dir)
new_path = file_in_hidden_path
old_path = "old.txt"

try:
result = await ensure_async(cm.rename_file(old_path, new_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.rename_file(old_path, new_path))
assert excinfo.value.status_code == 400

# Test rename with hidden source file in visible directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
old_path = cm._get_os_path(model["path"])
new_path = "new.txt"
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)
old_path = file_in_hidden_path
new_path = "new.txt"

try:
result = await ensure_async(cm.rename_file(old_path, new_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.rename_file(old_path, new_path))
assert excinfo.value.status_code == 400

# Test rename with hidden dest file in visible directory
with pytest.raises(HTTPError) as excinfo:
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)
model = await ensure_async(cm.new(path=file_in_hidden_path))
new_path = cm._get_os_path(model["path"])
old_path = "old.txt"
td = str(tmp_path)
cm = jp_file_contents_manager_class(root_dir=td)
hidden_dir = "visible"
file_in_hidden_path = os.path.join(hidden_dir, ".hidden.txt")
_make_dir(cm, hidden_dir)
new_path = file_in_hidden_path
old_path = "old.txt"

try:
result = await ensure_async(cm.rename_file(old_path, new_path))
except HTTPError as e:
assert e.status_code == 400
with pytest.raises(HTTPError) as excinfo:
await ensure_async(cm.rename_file(old_path, new_path))
assert excinfo.value.status_code == 400


@pytest.mark.skipif(sys.platform.startswith("win"), reason="Can't test hidden files on Windows")
Expand Down