from urllib.parse import quote
from django.contrib import messages
from django.core.paginator import InvalidPage
from django.http import Http404, HttpResponsePermanentRedirect
from django.shortcuts import get_object_or_404, redirect
from django.utils.translation import gettext_lazy as _
from django.views.generic import DetailView, TemplateView
from oscar.apps.catalogue.signals import product_viewed
from oscar.core.loading import get_class, get_model
Product = get_model('catalogue', 'product')
Category = get_model('catalogue', 'category')
ProductAlert = get_model('customer', 'ProductAlert')
ProductAlertForm = get_class('customer.forms', 'ProductAlertForm')
get_product_search_handler_class = get_class(
'catalogue.search_handlers', 'get_product_search_handler_class')
[docs]class ProductDetailView(DetailView):
context_object_name = 'product'
model = Product
view_signal = product_viewed
template_folder = "catalogue"
# Whether to redirect to the URL with the right path
enforce_paths = True
# Whether to redirect child products to their parent's URL. If it's disabled,
# we display variant product details on the separate page. Otherwise, details
# displayed on parent product page.
enforce_parent = False
[docs] def get(self, request, **kwargs):
"""
Ensures that the correct URL is used before rendering a response
"""
self.object = product = self.get_object()
redirect = self.redirect_if_necessary(request.path, product)
if redirect is not None:
return redirect
# Do allow staff members so they can test layout etc.
if not self.is_viewable(product, request):
raise Http404()
response = super().get(request, **kwargs)
self.send_signal(request, response, product)
return response
def is_viewable(self, product, request):
return product.is_public or request.user.is_staff
[docs] def get_object(self, queryset=None):
# Check if self.object is already set to prevent unnecessary DB calls
if hasattr(self, 'object'):
return self.object
else:
return super().get_object(queryset)
def redirect_if_necessary(self, current_path, product):
if self.enforce_parent and product.is_child:
return HttpResponsePermanentRedirect(
product.parent.get_absolute_url())
if self.enforce_paths:
expected_path = product.get_absolute_url()
if expected_path != quote(current_path):
return HttpResponsePermanentRedirect(expected_path)
[docs] def get_context_data(self, **kwargs):
ctx = super().get_context_data(**kwargs)
ctx['alert_form'] = self.get_alert_form()
ctx['has_active_alert'] = self.get_alert_status()
return ctx
def get_alert_status(self):
# Check if this user already have an alert for this product
has_alert = False
if self.request.user.is_authenticated:
alerts = ProductAlert.objects.filter(
product=self.object, user=self.request.user,
status=ProductAlert.ACTIVE)
has_alert = alerts.exists()
return has_alert
def get_alert_form(self):
return ProductAlertForm(
user=self.request.user, product=self.object)
def send_signal(self, request, response, product):
self.view_signal.send(
sender=self, product=product, user=request.user, request=request,
response=response)
[docs] def get_template_names(self):
"""
Return a list of possible templates.
If an overriding class sets a template name, we use that. Otherwise,
we try 2 options before defaulting to :file:`catalogue/detail.html`:
1. :file:`detail-for-upc-{upc}.html`
2. :file:`detail-for-class-{classname}.html`
This allows alternative templates to be provided for a per-product
and a per-item-class basis.
"""
if self.template_name:
return [self.template_name]
return [
'oscar/%s/detail-for-upc-%s.html' % (
self.template_folder, self.object.upc),
'oscar/%s/detail-for-class-%s.html' % (
self.template_folder, self.object.get_product_class().slug),
'oscar/%s/detail.html' % self.template_folder]
[docs]class CatalogueView(TemplateView):
"""
Browse all products in the catalogue
"""
context_object_name = "products"
template_name = 'oscar/catalogue/browse.html'
def get(self, request, *args, **kwargs):
try:
self.search_handler = self.get_search_handler(
self.request.GET, request.get_full_path(), [])
except InvalidPage:
# Redirect to page one.
messages.error(request, _('The given page number was invalid.'))
return redirect('catalogue:index')
return super().get(request, *args, **kwargs)
def get_search_handler(self, *args, **kwargs):
return get_product_search_handler_class()(*args, **kwargs)
def get_context_data(self, **kwargs):
ctx = {}
ctx['summary'] = _("All products")
search_context = self.search_handler.get_search_context_data(
self.context_object_name)
ctx.update(search_context)
return ctx
[docs]class ProductCategoryView(TemplateView):
"""
Browse products in a given category
"""
context_object_name = "products"
template_name = 'oscar/catalogue/category.html'
enforce_paths = True
def get(self, request, *args, **kwargs):
# Fetch the category; return 404 or redirect as needed
self.category = self.get_category()
# Allow staff members so they can test layout etc.
if not self.is_viewable(self.category, request):
raise Http404()
potential_redirect = self.redirect_if_necessary(
request.path, self.category)
if potential_redirect is not None:
return potential_redirect
try:
self.search_handler = self.get_search_handler(
request.GET, request.get_full_path(), self.get_categories())
except InvalidPage:
messages.error(request, _('The given page number was invalid.'))
return redirect(self.category.get_absolute_url())
return super().get(request, *args, **kwargs)
def is_viewable(self, category, request):
return category.is_public or request.user.is_staff
def get_category(self):
return get_object_or_404(Category, pk=self.kwargs['pk'])
def redirect_if_necessary(self, current_path, category):
if self.enforce_paths:
# Categories are fetched by primary key to allow slug changes.
# If the slug has changed, issue a redirect.
expected_path = category.get_absolute_url()
if expected_path != quote(current_path):
return HttpResponsePermanentRedirect(expected_path)
def get_search_handler(self, *args, **kwargs):
return get_product_search_handler_class()(*args, **kwargs)
[docs] def get_categories(self):
"""
Return a list of the current category and its ancestors
"""
return self.category.get_descendants_and_self()
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['category'] = self.category
search_context = self.search_handler.get_search_context_data(
self.context_object_name)
context.update(search_context)
return context