Place sponsors logos via templatetag (#1822)

* New manager method to filter by enabled sponsorships

* New manager method to filter by sponsorships with logo placement benefits

* New template tag to list sponsors accordingly with logo placement rules

* Replace box for download sponsors by new template tag

* Change sponsors URL to be a TemplateView instead of SiteTree

* Display sponsors logos

* Replace references from master branch to new main one

* Enable search by sponsor name

* Make sure title is still the same

* Move tests for admin views to a specific test file

* Create form to list related sponsorships from a specific benefit

* Implement admin view to update related sponsor benefit from a sponsorships benefit

* Add select/clear all sponsorships helper

* Disable new sponsor logo placement by default

* Fix CSS class name

* Refactor to group sponsorships by package in the backend

* Template tag have to know how to control logos dimension

* Display logos as thumbnail instead of using the uploaded logo

* Display logos at sponsorship detail page as thumbnails as well

Author: berinhard

README.md

@@ -1,6 +1,6 @@
 # python.org
 
-[![Build Status](https://travis-ci.org/python/pythondotorg.svg?branch=master)](https://travis-ci.org/python/pythondotorg)
+[![Build Status](https://travis-ci.org/python/pythondotorg.svg?branch=main)](https://travis-ci.org/python/pythondotorg)
 [![Documentation Status](https://readthedocs.org/projects/pythondotorg/badge/?version=latest)](https://pythondotorg.readthedocs.io/?badge=latest)
 
 ### General information
@@ -19,5 +19,5 @@ https://bugs.python.org.
 * Documentation: https://pythondotorg.readthedocs.org/
 * Mailing list: [pydotorg-www](https://mail.python.org/mailman/listinfo/pydotorg-www)
 * IRC: `#pydotorg` on Freenode
-* Staging site: https://staging.python.org/ (`master` branch)
+* Staging site: https://staging.python.org/ (`main` branch)
 * License: Apache License

base-requirements.txt

@@ -44,3 +44,4 @@ xhtml2pdf==0.2.5
 django-easy-pdf==0.1.1
 num2words==0.5.10
 django-polymorphic==2.1.2
+sorl-thumbnail==12.7.0

docs/source/contributing.rst

@@ -28,5 +28,5 @@ maintainers if you follow good coding practices such as:
   methods behind your change
 
 .. _GitHub: https://github.com/python/pythondotorg/issues
-.. _license: https://github.com/python/pythondotorg/blob/master/LICENSE
+.. _license: https://github.com/python/pythondotorg/blob/main/LICENSE
 .. _pythondotorg: https://github.com/python/pythondotorg

docs/source/index.rst

@@ -10,10 +10,10 @@ General information
 :Issue tracker: https://github.com/python/pythondotorg/issues
 :Mailing list: pydotorg-www_
 :IRC: ``#pydotorg`` on Freenode
-:Staging site: https://staging.python.org/ (``master`` branch)
+:Staging site: https://staging.python.org/ (``main`` branch)
 :Production configuration: https://github.com/python/psf-salt
 :Travis:
-  .. image:: https://travis-ci.org/python/pythondotorg.svg?branch=master
+  .. image:: https://travis-ci.org/python/pythondotorg.svg?branch=main
        :target: https://travis-ci.org/python/pythondotorg
 :License: Apache License
 

pydotorg/settings/base.py

@@ -157,6 +157,7 @@
     'widget_tweaks',
     'django_countries',
     'easy_pdf',
+    'sorl.thumbnail',
 
     'users',
     'boxes',

pydotorg/urls.py

@@ -41,6 +41,7 @@
 
     # other section landing pages
     url(r'^psf-landing/$', TemplateView.as_view(template_name="psf/index.html"), name='psf-landing'),
+    url(r'^psf/sponsors/$', TemplateView.as_view(template_name="psf/sponsors-list.html"), name='psf-sponsors'),
     url(r'^docs-landing/$', TemplateView.as_view(template_name="docs/index.html"), name='docs-landing'),
     url(r'^pypl-landing/$', TemplateView.as_view(template_name="pypl/index.html"), name='pypl-landing'),
     url(r'^shop-landing/$', TemplateView.as_view(template_name="shop/index.html"), name='shop-landing'),

sponsors/admin.py

@@ -1,6 +1,7 @@
 from ordered_model.admin import OrderedModelAdmin
 from polymorphic.admin import PolymorphicInlineSupportMixin, StackedPolymorphicInline
 
+from django.template import Context, Template
 from django.contrib import admin
 from django.contrib.humanize.templatetags.humanize import intcomma
 from django.urls import path
@@ -45,6 +46,7 @@ class LogoPlacementConfigurationInline(StackedPolymorphicInline.Child):
 
 @admin.register(SponsorshipBenefit)
 class SponsorshipBenefitAdmin(PolymorphicInlineSupportMixin, OrderedModelAdmin):
+    change_form_template = "sponsors/admin/sponsorshipbenefit_change_form.html"
     inlines = [BenefitFeatureConfigurationInline]
     ordering = ("program", "order")
     list_display = [
@@ -87,6 +89,20 @@ class SponsorshipBenefitAdmin(PolymorphicInlineSupportMixin, OrderedModelAdmin):
         ),
     ]
 
+    def get_urls(self):
+        urls = super().get_urls()
+        my_urls = [
+            path(
+                "<int:pk>/update-related-sponsorships",
+                self.admin_site.admin_view(self.update_related_sponsorships),
+                name="sponsors_sponsorshipbenefit_update_related",
+            ),
+        ]
+        return my_urls + urls
+
+    def update_related_sponsorships(self, *args, **kwargs):
+        return views_admin.update_related_sponsorships(self, *args, **kwargs)
+
 
 @admin.register(SponsorshipPackage)
 class SponsorshipPackageAdmin(OrderedModelAdmin):
@@ -103,6 +119,7 @@ class SponsorContactInline(admin.TabularInline):
 @admin.register(Sponsor)
 class SponsorAdmin(ContentManageableModelAdmin):
     inlines = [SponsorContactInline]
+    search_fields = ["name"]
 
 
 class SponsorBenefitInline(admin.TabularInline):
@@ -152,6 +169,7 @@ class SponsorshipAdmin(admin.ModelAdmin):
     change_form_template = "sponsors/admin/sponsorship_change_form.html"
     form = SponsorshipReviewAdminForm
     inlines = [SponsorBenefitInline]
+    search_fields = ["sponsor__name"]
     list_display = [
         "sponsor",
         "status",
@@ -306,7 +324,10 @@ def get_sponsor_landing_page_url(self, obj):
     get_sponsor_landing_page_url.short_description = "Landing Page URL"
 
     def get_sponsor_web_logo(self, obj):
-        html = f"<img src='{obj.sponsor.web_logo.url}'/>"
+        html = "{% load thumbnail %}{% thumbnail sponsor.web_logo '150x150' format='PNG' quality=100 as im %}<img src='{{ im.url}}'/>{% endthumbnail %}"
+        template = Template(html)
+        context = Context({'sponsor': obj.sponsor})
+        html = template.render(context)
         return mark_safe(html)
 
     get_sponsor_web_logo.short_description = "Web Logo"
@@ -315,7 +336,10 @@ def get_sponsor_print_logo(self, obj):
         img = obj.sponsor.print_logo
         html = ""
         if img:
-            html = f"<img src='{img.url}'/>"
+            html = "{% load thumbnail %}{% thumbnail img '150x150' format='PNG' quality=100 as im %}<img src='{{ im.url}}'/>{% endthumbnail %}"
+            template = Template(html)
+            context = Context({'img': img})
+            html = template.render(context)
         return mark_safe(html) if html else "---"
 
     get_sponsor_print_logo.short_description = "Print Logo"

sponsors/forms.py

@@ -2,6 +2,8 @@
 from django import forms
 from django.conf import settings
 from django.contrib.admin.widgets import AdminDateWidget
+from django.db.models import Q
+from django.utils import timezone
 from django.utils.functional import cached_property
 from django.utils.text import slugify
 from django.utils.translation import ugettext_lazy as _
@@ -394,3 +396,27 @@ def save(self, commit=True):
             self.instance.save()
 
         return self.instance
+
+
+class SponsorshipsListForm(forms.Form):
+    sponsorships = forms.ModelMultipleChoiceField(
+        required=True,
+        queryset=Sponsorship.objects.select_related("sponsor"),
+        widget=forms.CheckboxSelectMultiple,
+    )
+
+    @classmethod
+    def with_benefit(cls, sponsorship_benefit, *args, **kwargs):
+        """
+        Queryset considering only valid sponsorships which have the benefit
+        """
+        today = timezone.now().date()
+        queryset = sponsorship_benefit.related_sponsorships.exclude(
+            Q(end_date__lt=today) | Q(status=Sponsorship.REJECTED)
+        ).select_related("sponsor")
+
+        form = cls(*args, **kwargs)
+        form.fields["sponsorships"].queryset = queryset
+        form.sponsorship_benefit = sponsorship_benefit
+
+        return form

sponsors/managers.py

@@ -2,6 +2,9 @@
 from ordered_model.models import OrderedModelManager
 from django.db.models import Q, Subquery
 from django.db.models.query import QuerySet
+from django.utils import timezone
+
+from .enums import PublisherChoices
 
 
 class SponsorshipQuerySet(QuerySet):
@@ -23,6 +26,22 @@ def visible_to(self, user):
     def finalized(self):
         return self.filter(status=self.model.FINALIZED)
 
+    def enabled(self):
+        """Sponsorship which are finalized and enabled"""
+        today = timezone.now().date()
+        qs = self.finalized()
+        return qs.filter(start_date__lte=today, end_date__gte=today)
+
+    def with_logo_placement(self, logo_place=None, publisher=None):
+        from sponsors.models import LogoPlacement, SponsorBenefit
+        feature_qs = LogoPlacement.objects.all()
+        if logo_place:
+            feature_qs = feature_qs.filter(logo_place=logo_place)
+        if publisher:
+            feature_qs = feature_qs.filter(publisher=publisher)
+        benefit_qs = SponsorBenefit.objects.filter(id__in=Subquery(feature_qs.values_list('sponsor_benefit_id', flat=True)))
+        return self.filter(id__in=Subquery(benefit_qs.values_list('sponsorship_id', flat=True)))
+
 
 class SponsorContactQuerySet(QuerySet):
     def get_primary_contact(self, sponsor):

sponsors/models.py

@@ -6,7 +6,7 @@
 from django.core.files.storage import default_storage
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models, transaction
-from django.db.models import Sum
+from django.db.models import Sum, Subquery
 from django.template.defaultfilters import truncatechars
 from django.utils import timezone
 from django.utils.functional import cached_property
@@ -211,6 +211,11 @@ def remaining_capacity(self):
     def features_config(self):
         return self.benefitfeatureconfiguration_set
 
+    @property
+    def related_sponsorships(self):
+        ids_qs = self.sponsorbenefit_set.values_list("sponsorship__pk", flat=True)
+        return Sponsorship.objects.filter(id__in=Subquery(ids_qs))
+
     def __str__(self):
         return f"{self.program} > {self.name}"