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

Fix Staticfiles 404.html in HTML mode #1314

Merged
merged 15 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
31 changes: 16 additions & 15 deletions starlette/staticfiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,6 @@ async def get_response(self, path: str, scope: Scope) -> Response:
full_path, stat_result = await anyio.to_thread.run_sync(
self.lookup_path, path
)
except (FileNotFoundError, NotADirectoryError):
if self.html:
# Check for '404.html' if we're in HTML mode.
full_path, stat_result = await anyio.to_thread.run_sync(
self.lookup_path, "404.html"
)
if stat_result and stat.S_ISREG(stat_result.st_mode):
return FileResponse(
full_path,
stat_result=stat_result,
method=scope["method"],
status_code=404,
)
raise HTTPException(status_code=404)
aminalaee marked this conversation as resolved.
Show resolved Hide resolved
except PermissionError:
raise HTTPException(status_code=401)
except OSError:
Expand All @@ -149,6 +135,18 @@ async def get_response(self, path: str, scope: Scope) -> Response:
return RedirectResponse(url=url)
return self.file_response(full_path, stat_result, scope)

if self.html:
# Check for '404.html' if we're in HTML mode.
full_path, stat_result = await anyio.to_thread.run_sync(
self.lookup_path, "404.html"
)
if stat_result and stat.S_ISREG(stat_result.st_mode):
return FileResponse(
full_path,
stat_result=stat_result,
method=scope["method"],
status_code=404,
)
raise HTTPException(status_code=404)

def lookup_path(
Expand All @@ -161,7 +159,10 @@ def lookup_path(
# Don't allow misbehaving clients to break out of the static files
# directory.
continue
return full_path, os.stat(full_path)
try:
return full_path, os.stat(full_path)
except (FileNotFoundError, NotADirectoryError):
continue
aminalaee marked this conversation as resolved.
Show resolved Hide resolved
return "", None

def file_response(
Expand Down
69 changes: 68 additions & 1 deletion tests/test_staticfiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ def test_staticfiles_304_with_last_modified_compare_last_req(
assert response.content == b"<file content>"


def test_staticfiles_html(tmpdir, test_client_factory):
def test_staticfiles_html_normal(tmpdir, test_client_factory):
path = os.path.join(tmpdir, "404.html")
with open(path, "w") as file:
file.write("<h1>Custom not found page</h1>")
Expand Down Expand Up @@ -262,6 +262,73 @@ def test_staticfiles_html(tmpdir, test_client_factory):
assert response.text == "<h1>Custom not found page</h1>"


def test_staticfiles_html_without_index(tmpdir, test_client_factory):
path = os.path.join(tmpdir, "404.html")
with open(path, "w") as file:
file.write("<h1>Custom not found page</h1>")
path = os.path.join(tmpdir, "dir")
os.mkdir(path)

app = StaticFiles(directory=tmpdir, html=True)
client = test_client_factory(app)

response = client.get("/dir/")
assert response.status_code == 404
assert response.text == "<h1>Custom not found page</h1>"

response = client.get("/dir")
assert response.status_code == 404
assert response.text == "<h1>Custom not found page</h1>"

response = client.get("/missing")
assert response.status_code == 404
assert response.text == "<h1>Custom not found page</h1>"


def test_staticfiles_html_without_404(tmpdir, test_client_factory):
path = os.path.join(tmpdir, "dir")
os.mkdir(path)
path = os.path.join(path, "index.html")
with open(path, "w") as file:
file.write("<h1>Hello</h1>")

app = StaticFiles(directory=tmpdir, html=True)
client = test_client_factory(app)

response = client.get("/dir/")
assert response.status_code == 200
assert response.text == "<h1>Hello</h1>"

response = client.get("/dir")
aminalaee marked this conversation as resolved.
Show resolved Hide resolved
assert response.status_code == 200
assert response.text == "<h1>Hello</h1>"

response = client.get("/missing")
assert response.status_code == 404
assert response.text == "Not Found"


def test_staticfiles_html_only_files(tmpdir, test_client_factory):
path = os.path.join(tmpdir, "hello.html")
with open(path, "w") as file:
file.write("<h1>Hello</h1>")

app = StaticFiles(directory=tmpdir, html=True)
client = test_client_factory(app)

response = client.get("/dir")
assert response.status_code == 404
assert response.text == "Not Found"

response = client.get("/hello.html")
assert response.status_code == 200
assert response.text == "<h1>Hello</h1>"

response = client.get("/missing")
assert response.status_code == 404
assert response.text == "Not Found"


def test_staticfiles_cache_invalidation_for_deleted_file_html_mode(
tmpdir, test_client_factory
):
Expand Down