Skip to content

Update SafeRedirectMixin #440

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
mortenlyn merged 1 commit into from
Jul 28, 2025
Merged

Update SafeRedirectMixin #440

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
44 changes: 30 additions & 14 deletions src/staff/mixins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,23 +168,39 @@ def get_fallback_url(self) -> str:
raise NotImplementedError(msg)

def get_next_url_from_request(self) -> str | None:
return self.request.POST.get(self.next_param) or self.request.GET.get(
self.next_param
)

def has_next_url(self) -> bool:
next_url = self.get_next_url_from_request()
return bool(
next_url
and url_has_allowed_host_and_scheme(
next_url,
allowed_hosts={self.request.get_host()},
require_https=self.request.is_secure(),
)
"""
Safely extract the next URL from POST and GET data.
Returns a stripped string if present and non-empty, else None.
"""
next_url = self.request.POST.get(self.next_param)
if not next_url:
next_url = self.request.GET.get(self.next_param)
if isinstance(next_url, str):
Copy link

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

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

The isinstance check is redundant since request.POST.get() and request.GET.get() always return strings or None. Consider removing this check or handle the case where next_url could be a list (if multiple values are provided for the same parameter).

Suggested change
if isinstance(next_url, str):
if isinstance(next_url, list):
next_url = next_url[0] # Extract the first value if multiple are provided
if next_url:

Copilot uses AI. Check for mistakes.
next_url = next_url.strip()
if next_url:
return next_url
return None

def has_next_url(self, next_url: str | None = None) -> bool:
"""
Check if a valid and safe next URL is present in the request.
Optionally accepts a next_url to avoid duplicate extraction.
"""
if next_url is None:
next_url = self.get_next_url_from_request()
if not next_url:
return False
return url_has_allowed_host_and_scheme(
url=next_url,
Copy link

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

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

[nitpick] The explicit 'url=' parameter name is unnecessary here since it's the first positional parameter of url_has_allowed_host_and_scheme. This change makes the code less consistent with the original implementation.

Suggested change
url=next_url,
next_url,

Copilot uses AI. Check for mistakes.
allowed_hosts={self.request.get_host()},
require_https=self.request.is_secure(),
)

def get_next_url(self) -> str:
"""
Return a safe next URL if available, otherwise fallback URL.
"""
next_url = self.get_next_url_from_request()
if next_url and self.has_next_url():
if next_url and self.has_next_url(next_url):
return next_url
return self.get_fallback_url()