{body}".format(url=url, body=self.body) - ) - return body + return self.body \ No newline at end of file diff --git a/src/cms/templatetags/site_text.py b/src/cms/templatetags/site_text.py index 11a554c..82859ca 100644 --- a/src/cms/templatetags/site_text.py +++ b/src/cms/templatetags/site_text.py @@ -7,34 +7,48 @@ @register.simple_tag(takes_context=True) -def get_site_text(context, site_text_key): +def get_site_text(context, site_text_key, cms_prefetched=None): """ Get the site text for the given key and render it with the given context. :param context: The context to render the site text with. :param site_text_key: The key of the site text to render. + :param cms_prefetched: A dictionary of prefetched site text objects. :return: The rendered site text. """ - try: - site_text = models.SiteText.objects.get( - key=site_text_key, - ) - return mark_safe(site_text.display(context)) - except models.SiteText.DoesNotExist: - return "" + if cms_prefetched: + context["request"].cms_prefetched = cms_prefetched + if site_text_key in cms_prefetched: + return mark_safe(cms_prefetched[site_text_key].display(context)) + else: + return "!!{}".format(site_text_key) + else: + if hasattr(context["request"], "cms_prefetched"): + return get_site_text( + context, + site_text_key, + cms_prefetched=context["request"].cms_prefetched, + ) -@register.simple_tag() -def get_site_text_no_edit(site_text_key): + else: + return get_site_text( + context, + site_text_key, + cms_prefetched={ + o.key: o for o in models.SiteText.objects.all() + }, + ) + + +@register.simple_tag(takes_context=True) +def get_site_text_no_edit(context, site_text_key, cms_prefetched=None): """ Get the site text for the given key and render it with the given context without the edit text. + :param context: The context to render the site text with. :param site_text_key: The key of the site text to render. + :param cms_prefetched: A dictionary of prefetched site text objects. :return: The rendered site text. """ - try: - site_text = models.SiteText.objects.get( - key=site_text_key, - ) - return mark_safe(site_text.body) - except models.SiteText.DoesNotExist: - return "" + + return get_site_text(context, site_text_key, cms_prefetched) diff --git a/src/cms/translation.py b/src/cms/translation.py new file mode 100644 index 0000000..6dd7915 --- /dev/null +++ b/src/cms/translation.py @@ -0,0 +1,47 @@ +from modeltranslation.translator import translator, TranslationOptions + +from cms import models + + +class SiteTextTranslation(TranslationOptions): + fields = ( + 'body', + ) + + +class VersionTranslation(TranslationOptions): + fields = ( + 'first_paragraph', + 'pre_break_content', + 'pull_quote', + 'body', + ) + + +class PageUpdateTranslation(TranslationOptions): + fields = ( + 'title', + 'abstract_paragraph', + ) + + +class WhoWeAreProfileItemTranslation(TranslationOptions): + fields = ( + 'bio', + ) + + +class HomePageQuoteTranslation(TranslationOptions): + fields = ( + 'pill_name', + 'quotation', + 'person_attribution', + 'organization_attribution', + ) + + +translator.register(models.SiteText, SiteTextTranslation) +translator.register(models.Version, VersionTranslation) +translator.register(models.PageUpdate, PageUpdateTranslation) +translator.register(models.WhoWeAreProfileItem, WhoWeAreProfileItemTranslation) +translator.register(models.HomePageQuote, HomePageQuoteTranslation) diff --git a/src/cms/urls.py b/src/cms/urls.py index 1c6c685..3578b50 100644 --- a/src/cms/urls.py +++ b/src/cms/urls.py @@ -113,6 +113,16 @@ views.fixed_page, name="fixed_page", ), + path( + "all_pages/", + views.all_pages, + name="all_pages", + ), + path( + "page_render/
Saved successfully at {current_time}.
'
+ )
+
+ # If GET request, render the full modal for editing
+ return render(
+ request,
+ "cms/htmx/site_text_modal.html",
+ {
+ "site_text": site_text,
+ "lang_code": lang_code,
+ },
+ )
diff --git a/src/dashboard/views.py b/src/dashboard/views.py
index b89f47e..f985843 100644
--- a/src/dashboard/views.py
+++ b/src/dashboard/views.py
@@ -34,8 +34,11 @@ def visitor_dict(stats) -> dict:
for stat in stats:
# convert from ISO 3166-1 alpha-3 to ISO 3166-1 alpha-2
- country = pycountry.countries.get(alpha_3=stat.country_code)
- ret[country.alpha_2.lower()] = stat.country_count
+ if len(stat.country_code) == 3:
+ country = pycountry.countries.get(alpha_3=stat.country_code)
+ ret[country.alpha_2.lower()] = stat.country_count
+ else:
+ ret[stat.country_code.lower()] = stat.country_count
return ret
@@ -49,13 +52,24 @@ def index(request) -> HttpResponse:
"""
template = "dashboard/dashboard_index.html"
+ try:
+ book_count = thoth_models.OverallStats.objects.first()
+ book_count = book_count.book_count
+ except AttributeError:
+ book_count = thoth_models.OverallStats()
+ count = thoth_models.Work.objects.all().count()
+ book_count.book_count = count
+ book_count.save()
+
+ book_count = book_count.book_count
+
books = thoth_models.Work.objects.all()
- book_count = books.count()
# this catches instances where a user doesn't have a profile
try:
profile = request.user.profile
- profile.save()
+ if not profile:
+ raise acc_models.Profile.DoesNotExist
except acc_models.Profile.DoesNotExist:
request.user.profile = acc_models.Profile()
@@ -198,13 +212,22 @@ def generate_graph(books):
"""
# a list of colours to loop through for the books published
colours = [
- "rgba(210, 0, 0, 1)",
+ "rgba(68, 119, 179, 1)",
+ "rgba(102, 204, 238, 1)",
+ "rgba(34, 136, 51, 1)",
+ "rgba(204, 187, 68, 1)",
+ "rgba(238, 102, 119, 1)",
+ "rgba(170, 51, 119, 1)",
+ "rgba(255, 255, 255, 1)",
"rgba(0, 0, 0, 1)",
- "rgba(210, 214, 222, 1)",
]
# see if we have any stats in the DB
- stats = thoth_models.Stats.objects.all().order_by("year")
+ stats = (
+ thoth_models.Stats.objects.all()
+ .select_related("publisher")
+ .order_by("year")
+ )
# variable initialization
publishers = {}
@@ -215,16 +238,19 @@ def generate_graph(books):
final_publishers = {}
for stat in stats:
+ if int(stat.year) < 2000:
+ continue
+
# create the years list
if stat.year not in years:
years.append(stat.year)
# add the publisher to the publishers list
if stat.publisher not in publishers:
- publishers[stat.publisher] = []
+ publishers[stat.publisher] = {}
# add the data to a list
- publishers[stat.publisher].append(stat.book_count)
+ publishers[stat.publisher][stat.year] = stat.book_count
# count publishers
publisher_count = len(publishers)
@@ -248,6 +274,7 @@ def generate_graph(books):
# return labels and values to the dashboard
labels = sorted(years)[:-1]
+
return labels, publisher_count, publisher_templates
@@ -268,6 +295,6 @@ def create_js_template(color, publisher_name, publisher_data):
"pointStrokeColor": "#c1c7d1",
"pointHighlightFill": "#fff",
"pointHighlightStroke": "rgba(220,220,220,1)",
- "data": publisher_data,
+ "data": list(publisher_data.values()),
}
return pub_template
diff --git a/src/initiatives/migrations/0021_alter_initiative_more_info.py b/src/initiatives/migrations/0021_alter_initiative_more_info.py
new file mode 100644
index 0000000..d4a0f88
--- /dev/null
+++ b/src/initiatives/migrations/0021_alter_initiative_more_info.py
@@ -0,0 +1,19 @@
+# Generated by Django 3.2.8 on 2023-10-08 16:59
+
+from django.db import migrations
+import django_bleach.models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('initiatives', '0020_alter_highlights_options'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='initiative',
+ name='more_info',
+ field=django_bleach.models.BleachField(blank=True, help_text='Appears on the Initiative/Package more info page.', null=True),
+ ),
+ ]
diff --git a/src/initiatives/migrations/0022_initiative_exclude_from_thoth_filter.py b/src/initiatives/migrations/0022_initiative_exclude_from_thoth_filter.py
new file mode 100644
index 0000000..ab6e5a2
--- /dev/null
+++ b/src/initiatives/migrations/0022_initiative_exclude_from_thoth_filter.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.8 on 2024-02-12 11:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('initiatives', '0021_alter_initiative_more_info'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='initiative',
+ name='exclude_from_thoth_filter',
+ field=models.BooleanField(default=False, help_text='Check this to exclude this initiative from the Thoth search drop down.'),
+ ),
+ ]
diff --git a/src/initiatives/models.py b/src/initiatives/models.py
index 8be2d32..124308e 100644
--- a/src/initiatives/models.py
+++ b/src/initiatives/models.py
@@ -107,6 +107,12 @@ class Initiative(models.Model):
default=0,
)
+ exclude_from_thoth_filter = models.BooleanField(
+ default=False,
+ help_text='Check this to exclude this initiative from the Thoth '
+ 'search drop down.',
+ )
+
class Meta:
ordering = ("name",)
diff --git a/src/initiatives/views.py b/src/initiatives/views.py
index 6690099..764ad4b 100644
--- a/src/initiatives/views.py
+++ b/src/initiatives/views.py
@@ -188,11 +188,11 @@ def user_initiatives(request) -> HttpResponse:
:return: an HTTP response
"""
if request.user.is_staff:
- users_initiatives = models.Initiative.objects.all()
+ users_initiatives = models.Initiative.objects.all().prefetch_related("users").prefetch_related("users__profile")
else:
users_initiatives = models.Initiative.objects.filter(
users=request.user,
- )
+ ).prefetch_related("users").prefetch_related("users__profile")
template = "initiatives/user_initiatives.html"
context = {
"users_initiatives": users_initiatives,
diff --git a/src/intrepid/forms.py b/src/intrepid/forms.py
index 39831d6..ba16b5d 100644
--- a/src/intrepid/forms.py
+++ b/src/intrepid/forms.py
@@ -26,6 +26,7 @@ class Meta:
"management_team_description",
"membership_committee_description",
"secretariat_description",
+ "finance_committee_description",
"fee_amount",
)
diff --git a/src/intrepid/middleware.py b/src/intrepid/middleware.py
index f950fd2..0eef9eb 100644
--- a/src/intrepid/middleware.py
+++ b/src/intrepid/middleware.py
@@ -5,6 +5,7 @@
from invoicing import models as invoice_models
from package import models as package_models
from thoth import models as thoth_models
+from utils import country
def debug_middleware(get_response):
@@ -41,6 +42,25 @@ def middleware(request):
return middleware
+def country_middleware(get_response):
+ """
+ Middleware that ensures that a session key is always present
+ :param get_response: a callable
+ :return: a request object
+ """
+
+ def middleware(request):
+ if not request.session.get("country"):
+ request.session["country"] = country.get_iso_country_from_request(
+ request,
+ )
+ request.session["country"] = "GB"
+
+ return get_response(request)
+
+ return middleware
+
+
def variables_middleware(get_response):
"""
Middleware that injects commonly used variables into the request
@@ -50,7 +70,7 @@ def variables_middleware(get_response):
def middleware(request):
try:
- setup = intrepid_models.SiteSetup.objects.all().order_by("pk")[0]
+ setup = intrepid_models.SiteSetup.objects.first()
except IndexError:
setup = intrepid_models.SiteSetup()
setup.save()
@@ -64,6 +84,31 @@ def middleware(request):
request.matomo_site_url = settings.MATOMO_SITE_URL
request.matomo_site_id = settings.MATOMO_SITE_ID
+ try:
+ if request.user.is_authenticated:
+ baskets = package_models.Basket.objects.filter(
+ account=request.user,
+ active=True,
+ )
+ else:
+ baskets = package_models.Basket.objects.filter(
+ session_id=request.session.session_key,
+ active=True,
+ )
+
+ request.basket = baskets.first()
+ if request.basket:
+ request.basket_count = (
+ request.basket.packages.count()
+ + request.basket.meta_packages.count()
+ )
+ else:
+ request.basket_count = 0
+ except package_models.Basket.DoesNotExist:
+ request.basket = None
+ except AttributeError:
+ request.basket_count = 0
+
if hasattr(request, "user") and request.user.is_authenticated:
# inject a document count into the request for the count on the
# library dashboard
@@ -103,7 +148,9 @@ def middleware(request):
)
# active baskets
- request.active_baskets = request.user.basket_set.filter(active=True)
+ request.active_baskets = request.user.basket_set.filter(
+ active=True
+ )
# saved searches
request.saved_searches = thoth_models.ThothSearch.objects.filter(
diff --git a/src/intrepid/migrations/0029_sitesetup_finance_committee_description.py b/src/intrepid/migrations/0029_sitesetup_finance_committee_description.py
new file mode 100644
index 0000000..2f5a8b5
--- /dev/null
+++ b/src/intrepid/migrations/0029_sitesetup_finance_committee_description.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.8 on 2024-07-06 07:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('intrepid', '0028_alter_privateimage_image'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='sitesetup',
+ name='finance_committee_description',
+ field=models.TextField(blank=True, default='', null=True, verbose_name='Description of the Finance Committee'),
+ ),
+ ]
diff --git a/src/intrepid/migrations/0030_alter_privateimage_image.py b/src/intrepid/migrations/0030_alter_privateimage_image.py
new file mode 100644
index 0000000..408ef7d
--- /dev/null
+++ b/src/intrepid/migrations/0030_alter_privateimage_image.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.8 on 2024-09-14 08:22
+
+import django.core.files.storage
+from django.db import migrations, models
+import intrepid.models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('intrepid', '0029_sitesetup_finance_committee_description'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='privateimage',
+ name='image',
+ field=models.ImageField(storage=django.core.files.storage.FileSystemStorage(location='/Users/ajrbyers/Code/copim-intrepid/src/files/private_images'), upload_to=intrepid.models.private_images_upload_path),
+ ),
+ ]
diff --git a/src/intrepid/migrations/0031_alter_privateimage_image.py b/src/intrepid/migrations/0031_alter_privateimage_image.py
new file mode 100644
index 0000000..543c2d5
--- /dev/null
+++ b/src/intrepid/migrations/0031_alter_privateimage_image.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.8 on 2024-11-12 15:18
+
+import django.core.files.storage
+from django.db import migrations, models
+import intrepid.models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('intrepid', '0030_alter_privateimage_image'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='privateimage',
+ name='image',
+ field=models.ImageField(storage=django.core.files.storage.FileSystemStorage(location='/home/martin/Documents/Programming/intrepid/src/files/private_images'), upload_to=intrepid.models.private_images_upload_path),
+ ),
+ ]
diff --git a/src/intrepid/migrations/0032_alter_privateimage_image.py b/src/intrepid/migrations/0032_alter_privateimage_image.py
new file mode 100644
index 0000000..15886ab
--- /dev/null
+++ b/src/intrepid/migrations/0032_alter_privateimage_image.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.8 on 2025-10-20 10:05
+
+import django.core.files.storage
+from django.db import migrations, models
+import intrepid.models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('intrepid', '0031_alter_privateimage_image'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='privateimage',
+ name='image',
+ field=models.ImageField(storage=django.core.files.storage.FileSystemStorage(location='/home/ajrbyers/Code/intrepid/src/files/private_images'), upload_to=intrepid.models.private_images_upload_path),
+ ),
+ ]
diff --git a/src/intrepid/models.py b/src/intrepid/models.py
index 8f0ce16..55c4274 100644
--- a/src/intrepid/models.py
+++ b/src/intrepid/models.py
@@ -81,6 +81,12 @@ class SiteSetup(models.Model):
null=True,
verbose_name="Description of the Membership Committee",
)
+ finance_committee_description = models.TextField(
+ default="",
+ blank=True,
+ null=True,
+ verbose_name="Description of the Finance Committee",
+ )
management_team_description = models.TextField(
default="",
blank=True,
diff --git a/src/intrepid/templatetags/cost_calculator.py b/src/intrepid/templatetags/cost_calculator.py
index e676209..df47f10 100644
--- a/src/intrepid/templatetags/cost_calculator.py
+++ b/src/intrepid/templatetags/cost_calculator.py
@@ -74,6 +74,38 @@ def meta_package_cost(costs, meta_package, converted_currency):
return currency_totals
+@register.simple_tag()
+def package_cost_multiplier(costs, package, order, converted_currency=None):
+ """
+ Get the cost for a package.
+ :param costs: the costs
+ :param package: the package to get the cost for
+ :param converted_currency: the currency to convert to
+ :return: the cost
+ """
+ for cost in costs:
+ if cost.get("package") == package:
+ if (
+ converted_currency
+ and converted_currency != cost.get("cost").country.currency
+ ):
+ convert_value = currency_convert.convert(
+ currency_from=cost.get("cost").country.currency,
+ currency_to=converted_currency,
+ value=cost.get("cost").value,
+ )
+
+ convert_value = convert_value * order.term
+
+ return mark_safe(
+ "{}*".format(
+ format_price(convert_value, converted_currency)
+ )
+ )
+ else:
+ return cost.get("cost") * order.term
+
+
@register.simple_tag()
def package_cost(costs, package, converted_currency=None):
"""
@@ -114,6 +146,14 @@ def format_price(cost, currency):
return utils.format_price(cost, currency)
+@register.simple_tag()
+def format_price_multiplier(cost, currency, order):
+ """
+ Format a price.
+ """
+ return utils.format_price(int(cost) * int(order.term), currency)
+
+
@register.simple_tag()
def add_total_and_site_fee(currency_total, site_percentage):
"""
diff --git a/src/intrepid/test_settings.py b/src/intrepid/test_settings.py
new file mode 100644
index 0000000..205d441
--- /dev/null
+++ b/src/intrepid/test_settings.py
@@ -0,0 +1,14 @@
+import os
+
+from intrepid.settings import * # noqa: F401, F403
+
+MIGRATION_MODULES = {
+ 'fluid_permissions': 'test_migrations.fluid_permissions',
+}
+
+FIXTURE_DIRS = [
+ os.path.join(BASE_DIR, '..', 'fixtures'),
+]
+
+# Disable HTTP Basic Auth for test client requests
+BASICAUTH_DISABLE = True
diff --git a/src/intrepid/urls.py b/src/intrepid/urls.py
index cadb0ad..83fa810 100644
--- a/src/intrepid/urls.py
+++ b/src/intrepid/urls.py
@@ -120,6 +120,8 @@
path("api/", include("api.urls")),
path("books/", include("thoth.urls")),
path("manage/vocabs/", include("vocab.urls")),
+ path("nav/Your Currency
'), + HTML('' + your_currency + '
'), HTML( - "After you enter your currency you will be asked " - "to supple information on bandings.
" + "{}
".format( + SiteText.objects.get(key="after_currency_bandings_info").body + ) ), "currency", ) @@ -105,45 +123,52 @@ def __init__(self, *args, **kwargs): else: self.helper.layout.append( Layout( - HTML("Your Institution Details
"), + HTML("{}
".format( + SiteText.objects.get(key="institution_details").body + )), "fte", ) ) if self.fields["currency"].initial: for banding_type in self.banding_types: - session_string = "banding_type_{}".format(banding_type.pk) - choices = [["", "-----"]] - for vocab in banding_type.vocabs.all(): - choices.append([vocab.pk, vocab.text]) - self.fields[session_string] = forms.ChoiceField( - choices=choices, - label=banding_type.name, - ) - if self.user: - account_banding_choice = ( - accm.AccountBandingChoices.objects.filter( - account=self.user, - banding_type=banding_type, - ).first() - ) - self.fields[session_string].initial = ( - account_banding_choice.banding_type_vocab.pk - if account_banding_choice - else None + + if banding_type.active: + + session_string = "banding_type_{}".format(banding_type.pk) + choices = [["", "-----"]] + for vocab in banding_type.vocabs.all(): + choices.append([vocab.pk, vocab.text]) + self.fields[session_string] = forms.ChoiceField( + choices=choices, + label=banding_type.name, ) - else: - self.fields[session_string].initial = self.user_session.get( - session_string, None + if self.user: + account_banding_choice = ( + accm.AccountBandingChoices.objects.filter( + account=self.user, + banding_type=banding_type, + ).first() + ) + self.fields[session_string].initial = ( + account_banding_choice.banding_type_vocab.pk + if account_banding_choice + else None + ) + else: + self.fields[session_string].initial = ( + self.user_session.get(session_string, None) + ) + + self.fields[session_string].help_text = ( + banding_type.description ) - self.fields[session_string].help_text = banding_type.description - - self.helper.layout.append( - Layout(session_string), - ) - if "currency" in self.changed_data: - self.fields[session_string].required = False + self.helper.layout.append( + Layout(session_string), + ) + if "currency" in self.changed_data: + self.fields[session_string].required = False if "currency" in self.changed_data and self.fields.get("fte"): self.fields["fte"].required = False @@ -189,6 +214,180 @@ def save(self) -> None: self.user_session[key] = value +class FastFTEForm(forms.Form): + """ + Optimized version of FTEForm. + Accepts prefetched site_texts dict and batch-fetches + AccountBandingChoices instead of per-type queries. + """ + + currency = forms.ModelChoiceField( + queryset=models.Country.objects.exclude( + name__in=["EUROZONE", "Eurozone", "eurozone"] + ), + help_text="", + label="", + ) + fte = forms.IntegerField( + help_text="", + label="", + ) + + def __init__(self, *args, **kwargs): + self.user_session = kwargs.pop("user_session") + self.user = kwargs.pop("user") + self.banding_types = kwargs.pop("banding_types") + self.site_texts = kwargs.pop("site_texts", None) + + super(FastFTEForm, self).__init__(*args, **kwargs) + + def get_site_text(key): + if self.site_texts and key in self.site_texts: + return self.site_texts[key].body + return SiteText.objects.get(key=key).body + + self.fields["currency"].help_text = get_site_text( + "select_currency_note" + ) + self.fields["fte"].help_text = get_site_text( + "fte_student_count_prompt" + ) + self.fields["fte"].label = get_site_text("institutions_fte") + + if self.user: + self.fields["fte"].initial = self.user.profile.fte + else: + self.fields["fte"].initial = self.user_session.get("fte", 0) + + self.helper = FormHelper() + + your_currency = get_site_text("your_currency") + + self.helper.layout = Layout( + HTML( + '' + your_currency + "
" + ), + HTML( + "{}
".format( + get_site_text("after_currency_bandings_info") + ) + ), + "currency", + ) + + if self.user: + self.fields["currency"].initial = ( + self.user.profile.default_currency + if self.user.profile.default_currency + else None + ) + else: + self.fields["currency"].initial = self.user_session.get( + "currency", 0 + ) + + if not self.fields["currency"].initial: + self.fields.pop("fte") + else: + self.helper.layout.append( + Layout( + HTML( + "{}
".format( + get_site_text("institution_details") + ) + ), + "fte", + ) + ) + + if self.fields["currency"].initial: + # Batch-fetch all AccountBandingChoices at once + if self.user: + account_choices = { + abc.banding_type_id: abc + for abc in accm.AccountBandingChoices.objects.filter( + account=self.user, + ).select_related("banding_type_vocab") + } + else: + account_choices = {} + + for banding_type in self.banding_types: + if banding_type.active: + session_string = "banding_type_{}".format( + banding_type.pk + ) + choices = [["", "-----"]] + for vocab in banding_type.vocabs.all(): + choices.append([vocab.pk, vocab.text]) + self.fields[session_string] = forms.ChoiceField( + choices=choices, + label=banding_type.name, + ) + if self.user: + account_banding_choice = account_choices.get( + banding_type.pk + ) + self.fields[session_string].initial = ( + account_banding_choice.banding_type_vocab.pk + if account_banding_choice + else None + ) + else: + self.fields[session_string].initial = ( + self.user_session.get(session_string, None) + ) + + self.fields[session_string].help_text = ( + banding_type.description + ) + + self.helper.layout.append( + Layout(session_string), + ) + if "currency" in self.changed_data: + self.fields[session_string].required = False + + if "currency" in self.changed_data and self.fields.get("fte"): + self.fields["fte"].required = False + + self.helper.layout.append( + Submit( + "fte_form", + "Update", + css_class="btn btn-primary btn-obc-blue", + ), + ) + + def save(self) -> None: + for key, value in self.cleaned_data.items(): + if self.user: + if key == "fte" and value: + self.user.profile.fte = value + elif key == "currency" and value: + self.user.profile.default_currency = value + elif value: + banding_type_pk = key.replace("banding_type_", "") + banding_type_vocab = vm.BandingVocab.objects.get( + pk=value, + ) + accm.AccountBandingChoices.objects.update_or_create( + account=self.user, + banding_type_id=banding_type_pk, + defaults={ + "banding_type_vocab": banding_type_vocab, + }, + ) + self.user.profile.save() + else: + if key == "fte": + self.user_session[key] = value + elif key == "currency": + self.user_session[key] = value.pk + else: + self.user_session[key] = value + + class ManagePackageForm(forms.ModelForm): """ Form for managing packages @@ -208,10 +407,10 @@ def __init__(self, *args, **kwargs): self.fields.pop("signup_contacts") self.fields.pop("access_contacts") - def save( - self, commit=True - ) -> tuple[ - models.Package, models.BandingTypeEntry, models.BandingTypeCurrencyEntry + def save(self, commit=True) -> tuple[ + models.Package, + models.BandingTypeEntry, + models.BandingTypeCurrencyEntry, ]: """ Save the form @@ -260,12 +459,13 @@ def __init__(self, *args, **kwargs): self.helper.form_method = "post" self.helper.add_input(Submit("submit", "Save")) - self.fields[ - "contact" - ].label_from_instance = lambda obj: "%s %s (%s)" % ( - obj.first_name, - obj.last_name, - obj.email, + self.fields["contact"].label_from_instance = ( + lambda obj: "%s %s (%s)" + % ( + obj.first_name, + obj.last_name, + obj.email, + ) ) def save(self, commit=True) -> models.MetaPackage: @@ -444,7 +644,9 @@ class CurrencyField(forms.Form): """ currencies = forms.ModelChoiceField( - queryset=models.Country.objects.all(), empty_label=None, label="Country" + queryset=models.Country.objects.all(), + empty_label=None, + label="Country", ) @@ -561,16 +763,54 @@ class GeneratedForm(forms.Form): """ email_address = forms.EmailField(required=True) + term_length = forms.ChoiceField(choices=[]) # Will be set in __init__ def __init__(self, *args, **kwargs): order = kwargs.pop("order", None) fields_required = kwargs.pop("fields_required", True) email = kwargs.pop("email_address", None) + term_length = kwargs.pop("term_length", 3) super(GeneratedForm, self).__init__(*args, **kwargs) + + # Load translatable strings from database + try: + months_text = SiteText.objects.get(key="months").body + except SiteText.DoesNotExist: + months_text = "months" + + # Set term length choices with translated text + TERM_CHOICES = { + "1": f"12 {months_text}", + "3": f"36 {months_text}", + } + self.fields["term_length"].choices = TERM_CHOICES.items() + + # Set labels from SiteText + try: + self.fields["email_address"].label = SiteText.objects.get( + key="email_address" + ).body + except SiteText.DoesNotExist: + self.fields["email_address"].label = "Email address*" + + try: + self.fields["term_length"].label = SiteText.objects.get( + key="term_length" + ).body + except SiteText.DoesNotExist: + self.fields["term_length"].label = "Term length*" + self.helper = FormHelper() self.helper.form_method = "post" + + # Load Save button text from SiteText + try: + save_text = SiteText.objects.get(key="save_button").body + except SiteText.DoesNotExist: + save_text = "Save" + self.helper.add_input( - Submit("submit", "Save", css_class="btn btn-primary btn-obc-blue") + Submit("save", save_text, css_class="btn btn-primary btn-obc-blue") ) elements = order.data_to_collect @@ -626,9 +866,12 @@ def __init__(self, *args, **kwargs): ) for answer in answers: if self.fields[str(answer.form_element.pk)]: - self.fields[str(answer.form_element.pk)].initial = answer.answer + self.fields[str(answer.form_element.pk)].initial = ( + answer.answer + ) self.fields["email_address"].initial = email + self.fields["term_length"].initial = term_length class CustomDocumentForm(forms.ModelForm): @@ -750,3 +993,23 @@ def save(self, commit=True) -> models.MediaFile: file.save() return file + + +class CountryForm(forms.Form): + country = forms.ModelChoiceField( + queryset=models.Country.objects.exclude( + name__in=["EUROZONE", "Eurozone", "eurozone"] + ), + help_text="Select your preferred country.", + label="Countries", + ) + + def __init__(self, *args, **kwargs): + session_country_code = kwargs.pop("session_country_code") + super(CountryForm, self).__init__(*args, **kwargs) + if session_country_code: + country = models.Country.objects.filter( + code=session_country_code, + ).first() + if country: + self.fields["country"].initial = country.pk diff --git a/src/package/management/__init__.py b/src/package/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/package/management/commands/__init__.py b/src/package/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/package/management/commands/pregenerate_prices.py b/src/package/management/commands/pregenerate_prices.py new file mode 100644 index 0000000..3a28fde --- /dev/null +++ b/src/package/management/commands/pregenerate_prices.py @@ -0,0 +1,149 @@ +import sys +from pprint import pprint + +from django.core.management.base import BaseCommand + +from package.models import Package, MetaPackage, PreCalcMinMax, Country, Price +from package.utils import get_price_for_package +from package.currency import convert + + +class Command(BaseCommand): + """ + A management command that pregenerates package prices + """ + + help = "Pre-generates package prices" + + def add_arguments(self, parser): + parser.add_argument( + "--convert-currencies", + action="store_true", + help="Enable currency conversion using default package prices when missing", + ) + + def handle(self, *args, **options): + convert_currencies = options["convert_currencies"] + + package_list = {} + meta_package_list = {} + + PreCalcMinMax.objects.all().delete() + + for package in Package.objects.all(): + package_list[package] = {} + + for key, val in package.price_bandings.items(): + for country, prices in val.items(): + found_min = sys.maxsize + found_max = 0 + + min_price = min(prices, key=lambda x: x.value) + max_price = max(prices, key=lambda x: x.value) + + found_min = ( + min_price.value + if min_price.value < found_min + else found_min + ) + found_max = ( + max_price.value + if max_price.value > found_max + else found_max + ) + + package_list[package][country] = { + "min": found_min, + "max": found_max, + } + + for mp in MetaPackage.objects.all(): + meta_package_list[mp] = {} + packages = list(mp.packages.all()) + + all_countries = set() + for package in packages: + all_countries.update(package_list.get(package, {}).keys()) + + for country in all_countries: + min_total = 0 + max_total = 0 + all_found = True + + for package in packages: + package_data = package_list.get(package, {}).get(country) + + if package_data: + min_total += package_data["min"] + max_total += package_data["max"] + elif convert_currencies: + fallback = self.get_converted_default_price(package, country.currency) + if fallback: + converted_min, converted_max = fallback + min_total += converted_min + max_total += converted_max + else: + all_found = False + break + else: + all_found = False + break + + if all_found: + meta_package_list[mp][country] = { + "min": min_total, + "max": max_total, + } + + for package, country_data in package_list.items(): + for country, values in country_data.items(): + PreCalcMinMax.objects.get_or_create( + country=country, + package=package, + min_amount=values["min"], + max_amount=values["max"], + ) + + for meta_package, country_data in meta_package_list.items(): + for country, values in country_data.items(): + PreCalcMinMax.objects.get_or_create( + meta_package=meta_package, + country=country, + min_amount=values["min"], + max_amount=values["max"], + ) + + for country in Country.objects.filter(catch_all=True): + PreCalcMinMax.objects.filter( + country__currency=country.currency, + ).exclude( + country=country, + ).delete() + + for precalc in PreCalcMinMax.objects.all().order_by("package", "meta_package", "country"): + print( + f"{precalc.get_package()} {precalc}" + ) + + def get_converted_default_price(self, package, currency_code): + default_country = package.default_country + if not default_country: + return None + + prices = Price.objects.filter( + banding__package=package, + country=default_country, + ) + + if not prices.exists(): + return None + + min_value = min(p.value for p in prices) + max_value = max(p.value for p in prices) + + try: + converted_min = round(convert(default_country.currency, currency_code, min_value)) + converted_max = round(convert(default_country.currency, currency_code, max_value)) + return converted_min, converted_max + except Exception: + return None diff --git a/src/package/migrations/0066_auto_20231008_1659.py b/src/package/migrations/0066_auto_20231008_1659.py new file mode 100644 index 0000000..976702b --- /dev/null +++ b/src/package/migrations/0066_auto_20231008_1659.py @@ -0,0 +1,25 @@ +# Generated by Django 3.2.8 on 2023-10-08 16:59 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('initiatives', '0021_alter_initiative_more_info'), + ('package', '0065_auto_20230621_1932'), + ] + + operations = [ + migrations.AlterField( + model_name='basepackage', + name='pricing_display', + field=models.CharField(help_text='Display version of pricing eg. £1000-£2000', max_length=255, null=True), + ), + migrations.AlterField( + model_name='order', + name='initiative', + field=models.ForeignKey(blank=True, help_text='If signup inserted by initiative store here.', null=True, on_delete=django.db.models.deletion.CASCADE, to='initiatives.initiative'), + ), + ] diff --git a/src/package/migrations/0067_auto_20240212_1346.py b/src/package/migrations/0067_auto_20240212_1346.py new file mode 100644 index 0000000..9b18d17 --- /dev/null +++ b/src/package/migrations/0067_auto_20240212_1346.py @@ -0,0 +1,34 @@ +# Generated by Django 3.2.8 on 2024-02-12 13:46 + +import django.core.files.storage +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0066_auto_20231008_1659'), + ] + + operations = [ + migrations.AlterField( + model_name='frozenpackagedocument', + name='final_zip', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/Users/ajrbyers/Code/copim-intrepid/src/files'), upload_to='private_documents'), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/Users/ajrbyers/Code/copim-intrepid/src/files'), upload_to='private_documents'), + ), + migrations.CreateModel( + name='PreCalcMinMax', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('min_amount', models.IntegerField()), + ('max_amount', models.IntegerField()), + ('country', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='package.country')), + ], + ), + ] diff --git a/src/package/migrations/0068_precalcminmax_package.py b/src/package/migrations/0068_precalcminmax_package.py new file mode 100644 index 0000000..c6c31d8 --- /dev/null +++ b/src/package/migrations/0068_precalcminmax_package.py @@ -0,0 +1,20 @@ +# Generated by Django 3.2.8 on 2024-02-12 13:48 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0067_auto_20240212_1346'), + ] + + operations = [ + migrations.AddField( + model_name='precalcminmax', + name='package', + field=models.ForeignKey(default=1, on_delete=django.db.models.deletion.CASCADE, to='package.package'), + preserve_default=False, + ), + ] diff --git a/src/package/migrations/0069_auto_20240212_1424.py b/src/package/migrations/0069_auto_20240212_1424.py new file mode 100644 index 0000000..f389f32 --- /dev/null +++ b/src/package/migrations/0069_auto_20240212_1424.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.8 on 2024-02-12 14:24 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0068_precalcminmax_package'), + ] + + operations = [ + migrations.AddField( + model_name='precalcminmax', + name='meta_package', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='package.metapackage'), + ), + migrations.AlterField( + model_name='precalcminmax', + name='package', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='package.package'), + ), + ] diff --git a/src/package/migrations/0070_auto_20240701_1017.py b/src/package/migrations/0070_auto_20240701_1017.py new file mode 100644 index 0000000..48b9b4a --- /dev/null +++ b/src/package/migrations/0070_auto_20240701_1017.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.8 on 2024-07-01 10:17 + +import django.core.files.storage +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0069_auto_20240212_1424'), + ] + + operations = [ + migrations.AlterField( + model_name='frozenpackagedocument', + name='final_zip', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/martin/Documents/Programming/intrepid/src/files'), upload_to='private_documents'), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/martin/Documents/Programming/intrepid/src/files'), upload_to='private_documents'), + ), + ] diff --git a/src/package/migrations/0071_auto_20240914_0822.py b/src/package/migrations/0071_auto_20240914_0822.py new file mode 100644 index 0000000..6c2686a --- /dev/null +++ b/src/package/migrations/0071_auto_20240914_0822.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.8 on 2024-09-14 08:22 + +import django.core.files.storage +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0070_auto_20240701_1017'), + ] + + operations = [ + migrations.AlterField( + model_name='frozenpackagedocument', + name='final_zip', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/Users/ajrbyers/Code/copim-intrepid/src/files'), upload_to='private_documents'), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/Users/ajrbyers/Code/copim-intrepid/src/files'), upload_to='private_documents'), + ), + ] diff --git a/src/package/migrations/0072_auto_20241112_1518.py b/src/package/migrations/0072_auto_20241112_1518.py new file mode 100644 index 0000000..62c462d --- /dev/null +++ b/src/package/migrations/0072_auto_20241112_1518.py @@ -0,0 +1,29 @@ +# Generated by Django 3.2.8 on 2024-11-12 15:18 + +import django.core.files.storage +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0071_auto_20240914_0822'), + ] + + operations = [ + migrations.AddField( + model_name='basket', + name='term', + field=models.IntegerField(default=1), + ), + migrations.AlterField( + model_name='frozenpackagedocument', + name='final_zip', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/martin/Documents/Programming/intrepid/src/files'), upload_to='private_documents'), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/martin/Documents/Programming/intrepid/src/files'), upload_to='private_documents'), + ), + ] diff --git a/src/package/migrations/0073_order_term.py b/src/package/migrations/0073_order_term.py new file mode 100644 index 0000000..31604ee --- /dev/null +++ b/src/package/migrations/0073_order_term.py @@ -0,0 +1,18 @@ +# Generated by Django 3.2.8 on 2024-11-12 15:47 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0072_auto_20241112_1518'), + ] + + operations = [ + migrations.AddField( + model_name='order', + name='term', + field=models.IntegerField(default=1), + ), + ] diff --git a/src/package/migrations/0074_auto_20251020_0946.py b/src/package/migrations/0074_auto_20251020_0946.py new file mode 100644 index 0000000..664d3a8 --- /dev/null +++ b/src/package/migrations/0074_auto_20251020_0946.py @@ -0,0 +1,25 @@ +# Generated by Django 3.2.8 on 2025-10-20 09:46 + +import django.core.files.storage +from django.db import migrations, models +import django_bleach.models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0073_order_term'), + ] + + operations = [ + migrations.AddField( + model_name='bandingtype', + name='description_de', + field=django_bleach.models.BleachField(help_text='Description that will appear on the banding selection section.', null=True), + ), + migrations.AddField( + model_name='bandingtype', + name='description_en', + field=django_bleach.models.BleachField(help_text='Description that will appear on the banding selection section.', null=True), + ), + ] diff --git a/src/package/migrations/0075_auto_20251020_0950.py b/src/package/migrations/0075_auto_20251020_0950.py new file mode 100644 index 0000000..4c71d75 --- /dev/null +++ b/src/package/migrations/0075_auto_20251020_0950.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.8 on 2025-10-20 09:50 + +import django.core.files.storage +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0074_auto_20251020_0946'), + ] + + operations = [ + migrations.AddField( + model_name='bandingtype', + name='name_de', + field=models.CharField(help_text='Public name of the Banding Type.#,', max_length=255, null=True), + ), + migrations.AddField( + model_name='bandingtype', + name='name_en', + field=models.CharField(help_text='Public name of the Banding Type.#,', max_length=255, null=True), + ), + ] diff --git a/src/package/migrations/0076_auto_20251020_1005.py b/src/package/migrations/0076_auto_20251020_1005.py new file mode 100644 index 0000000..45463a3 --- /dev/null +++ b/src/package/migrations/0076_auto_20251020_1005.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.8 on 2025-10-20 10:05 + +import django.core.files.storage +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0075_auto_20251020_0950'), + ] + + operations = [ + migrations.AlterField( + model_name='frozenpackagedocument', + name='final_zip', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/ajrbyers/Code/intrepid/src/files'), upload_to='private_documents'), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(blank=True, storage=django.core.files.storage.FileSystemStorage(base_url='/files', location='/home/ajrbyers/Code/intrepid/src/files'), upload_to='private_documents'), + ), + ] diff --git a/src/package/migrations/0077_auto_20260208_1931.py b/src/package/migrations/0077_auto_20260208_1931.py new file mode 100644 index 0000000..266feea --- /dev/null +++ b/src/package/migrations/0077_auto_20260208_1931.py @@ -0,0 +1,33 @@ +# Generated by Django 3.2.8 on 2026-02-08 19:31 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('package', '0076_auto_20251020_1005'), + ] + + operations = [ + migrations.AddIndex( + model_name='banding', + index=models.Index(fields=['package', 'banding_type'], name='banding_pkg_type_idx'), + ), + migrations.AddIndex( + model_name='bandingtypecurrencyentry', + index=models.Index(fields=['package', 'banding_type_entry'], name='btce_pkg_bte_idx'), + ), + migrations.AddIndex( + model_name='bandingtypeentry', + index=models.Index(fields=['package', 'banding_type'], name='bte_pkg_type_idx'), + ), + migrations.AddIndex( + model_name='country', + index=models.Index(fields=['currency', 'catch_all'], name='country_currency_catchall_idx'), + ), + migrations.AddIndex( + model_name='price', + index=models.Index(fields=['banding', 'country'], name='price_banding_country_idx'), + ), + ] diff --git a/src/package/models.py b/src/package/models.py index 4550962..f8a81ac 100644 --- a/src/package/models.py +++ b/src/package/models.py @@ -1,4 +1,5 @@ import datetime +import functools import os import sys import uuid @@ -19,6 +20,7 @@ from access import models as access_models from accounts import models as account_models +from cms import models as cms_models from initiatives import models as im from package import utils from vocab import models as vm @@ -68,6 +70,12 @@ class Country(models.Model): class Meta: verbose_name_plural = "Countries" ordering = ("name",) + indexes = [ + models.Index( + fields=["currency", "catch_all"], + name="country_currency_catchall_idx", + ), + ] def __str__(self): return "{} ({})".format(self.name, self.currency) @@ -135,7 +143,9 @@ def set_vocabs(self, ids, request) -> list[vm.BandingVocab]: self.vocabs.remove(vocab) if new_vocabs: - vocab_utils.notify_initiatives_new_vocabs(self, new_vocabs, request) + vocab_utils.notify_initiatives_new_vocabs( + self, new_vocabs, request + ) return new_vocabs @@ -183,6 +193,14 @@ class Banding(models.Model): ) objects = BandingManager() + class Meta: + indexes = [ + models.Index( + fields=["package", "banding_type"], + name="banding_pkg_type_idx", + ), + ] + def name(self) -> str: """ Returns the name of the banding @@ -269,6 +287,14 @@ class Price(models.Model): ) objects = PriceManager() + class Meta: + indexes = [ + models.Index( + fields=["banding", "country"], + name="price_banding_country_idx", + ), + ] + @staticmethod def collect() -> None: """ @@ -317,6 +343,14 @@ class BandingTypeCurrencyEntry(models.Model): on_delete=models.SET_NULL, ) + class Meta: + indexes = [ + models.Index( + fields=["package", "banding_type_entry"], + name="btce_pkg_bte_idx", + ), + ] + def __str__(self): return "{} ({}) in {}".format( self.country, self.banding_type_entry, self.package @@ -354,6 +388,14 @@ class BandingTypeEntry(models.Model): blank=True, null=True, default="", verbose_name="Redirect URL" ) + class Meta: + indexes = [ + models.Index( + fields=["package", "banding_type"], + name="bte_pkg_type_idx", + ), + ] + def __str__(self): return "{} in {}".format(self.banding_type, self.package) @@ -540,11 +582,17 @@ def price_bandings(self) -> dict: E.g. price_bandings[BandingTypeCurrencyEntry][Country] = [Prices] :return: a dictionary of BandingTypeCurrencyEntries that contains """ - banding_entries = self.bandingtypecurrencyentry_set.all() - price_objects = Price.objects.all() + # Fetch all related objects in one go + banding_entries = ( + self.bandingtypecurrencyentry_set.all() + .select_related("banding_type_entry__banding_type", "country") + .prefetch_related("banding_type_entry__banding_type__vocabs") + ) + price_objects = Price.objects.all().select_related("banding") prices = {} - # all available BandingTypeCurrencyEntries for this package + bandings = Banding.objects.all().select_related("banding_type") + for banding_entry in banding_entries: prices[banding_entry] = {} @@ -552,27 +600,94 @@ def price_bandings(self) -> dict: for ( v_banding ) in banding_entry.banding_type_entry.banding_type.vocabs.all(): - # get a banding object - banding = Banding.objects.get( - package=self, - vocab=v_banding, - banding_type=banding_entry.banding_type_entry.banding_type, - ) + for banding in bandings: + if ( + banding.package == self + and banding.vocab == v_banding + and banding.banding_type + == banding_entry.banding_type_entry.banding_type + ): + try: + price = None + for price_obj in price_objects: + if ( + price_obj.banding == banding + and price_obj.country + == banding_entry.country + ): + price = price_obj + + """ + # see if there are prices set + price = price_objects.get( + banding=banding, + country=banding_entry.country, + ) + """ - try: - # see if there are prices set - price = price_objects.get( - banding=banding, - country=banding_entry.country, - ) + # if so, append to the list for each country + if price.country not in prices[banding_entry]: + prices[banding_entry][price.country] = [] + + prices[banding_entry][price.country].append(price) + except Price.DoesNotExist: + pass + except AttributeError: + pass + + return prices - # if so, append to the list for each country - if price.country not in prices[banding_entry]: - prices[banding_entry][price.country] = [] + @functools.cached_property + def fast_price_bandings(self) -> dict: + """ + Optimized version of price_bandings. + Scopes queries to this package only and uses dict lookups + instead of triple-nested loops over global querysets. + """ + banding_entries = ( + self.bandingtypecurrencyentry_set.all() + .select_related("banding_type_entry__banding_type", "country") + .prefetch_related("banding_type_entry__banding_type__vocabs") + ) + + # Scope to THIS package only (not all bandings/prices globally) + package_bandings = Banding.objects.filter( + package=self + ).select_related("banding_type", "vocab") + + # Build lookup: (banding_type_id, vocab_id) -> banding + banding_lookup = {} + for b in package_bandings: + banding_lookup[(b.banding_type_id, b.vocab_id)] = b + + package_prices = Price.objects.filter( + banding__package=self + ).select_related("banding", "country") - prices[banding_entry][price.country].append(price) - except Price.DoesNotExist: - pass + # Build lookup: (banding_id, country_id) -> price + price_lookup = {} + for p in package_prices: + price_lookup[(p.banding_id, p.country_id)] = p + + prices = {} + for banding_entry in banding_entries: + prices[banding_entry] = {} + bt = banding_entry.banding_type_entry.banding_type + + for v_banding in bt.vocabs.all(): + banding = banding_lookup.get((bt.id, v_banding.id)) + if banding is None: + continue + + price = price_lookup.get( + (banding.id, banding_entry.country_id) + ) + if price is None: + continue + + if price.country not in prices[banding_entry]: + prices[banding_entry][price.country] = [] + prices[banding_entry][price.country].append(price) return prices @@ -613,17 +728,17 @@ def display_price(self) -> str: return ( "From {0} to {1} (in {2})".format( babel.numbers.format_currency( - low, self.default_country.currency + low, self.default_country.currency, locale="en_US" ), babel.numbers.format_currency( - high, self.default_country.currency + high, self.default_country.currency, locale="en_US" ), self.default_country.currency, ) if low != high else "Around {0}".format( babel.numbers.format_currency( - high, self.default_country.currency + high, self.default_country.currency, locale="en_US" ) ) ) @@ -761,17 +876,25 @@ class Basket(models.Model): help_text="If False this basket will not show in active baskets.", ) + term = models.IntegerField(default=1) + def package_set(self) -> set[Package]: """ Returns a set of packages that are in this basket :return: a set of packages """ - package_list = list() - for package in self.packages.all(): - package_list.append(package) - for meta_package in self.meta_packages.all(): - for package in meta_package.packages.all(): + # package_list = cache.get("package_list") + package_list = None + + if not package_list: + package_list = list() + for package in self.packages.all(): package_list.append(package) + for meta_package in self.meta_packages.all(): + for package in meta_package.packages.all(): + package_list.append(package) + + # cache.set("package_list", package_list, 5) # 5 seconds return set(package_list) @@ -797,21 +920,33 @@ def list_of_conflicting_packages(self) -> set[Package]: Returns a set of packages that conflict with one another :return: a set of packages """ - conflicting_packages = list() + # conflicting_packages = cache.get("conflicting_packages") + conflicting_packages = None - for package in self.packages.all(): - for meta_package in self.meta_packages.all(): - if package in meta_package.packages.all(): - conflicting_packages.append(package) + if not conflicting_packages: + conflicting_packages = list() + + for package in self.packages.all(): + for meta_package in self.meta_packages.all(): + if package in meta_package.packages.all(): + conflicting_packages.append(package) - for meta_package in self.meta_packages.all(): - other_meta_packages = self.meta_packages.exclude(pk=meta_package.pk) - for omp in other_meta_packages: - conflicts = set(meta_package.packages.all()).intersection( - set(omp.packages.all()) + for meta_package in self.meta_packages.all(): + other_meta_packages = self.meta_packages.exclude( + pk=meta_package.pk ) - for conflict in conflicts: - conflicting_packages.append(conflict) + for omp in other_meta_packages: + conflicts = set(meta_package.packages.all()).intersection( + set(omp.packages.all()) + ) + for conflict in conflicts: + conflicting_packages.append(conflict) + + """ + cache.set( + "conflicting_packages", conflicting_packages, 5 + ) # 5 seconds + """ return set(conflicting_packages) @@ -924,7 +1059,8 @@ def get_best_bandings_for_form( suitable_prices = Price.objects.filter( country__currency=catch_all_matching_currency.currency, country__catch_all=True, - ) + ).select_related("banding__banding_type") + package_bandings_return = package_bandings_return + [ price.banding for price in suitable_prices ] @@ -935,12 +1071,13 @@ def get_best_bandings_for_form( package_bandings = bandings.filter( package=package, ) + prices = Price.objects.filter( banding__in=package_bandings, - ).select_related("banding") + ).select_related("banding__banding_type") suitable_prices = prices.filter( country=currency, - ) + ).select_related("banding__banding_type") if suitable_prices: package_bandings_return = package_bandings_return + [ price.banding for price in suitable_prices @@ -948,7 +1085,8 @@ def get_best_bandings_for_form( else: suitable_prices = prices.filter( country=package.default_country, - ) + ).select_related("banding__banding_type") + if suitable_prices: package_bandings_return = package_bandings_return + [ price.banding for price in suitable_prices @@ -961,10 +1099,10 @@ def get_best_bandings_for_form( ) prices = Price.objects.filter( banding__in=package_bandings, - ) + ).select_related("banding__banding_type") suitable_prices = prices.filter( country=currency, - ) + ).select_related("banding__banding_type") if suitable_prices: package_bandings_return = package_bandings_return + [ price.banding for price in suitable_prices @@ -973,7 +1111,8 @@ def get_best_bandings_for_form( if not catch_all_matching_currency: suitable_prices = prices.filter( country=package.default_country, - ) + ).select_related("banding__banding_type") + if suitable_prices: package_bandings_return = ( package_bandings_return @@ -991,6 +1130,235 @@ def get_best_bandings_for_form( ] ) + def fast_list_of_conflicting_packages(self) -> set[Package]: + """ + Optimized version of list_of_conflicting_packages. + Uses prefetched M2M data and in-memory set operations + instead of nested DB queries. + """ + basket_packages = set(self.packages.all()) + basket_meta_packages = list(self.meta_packages.all()) + + # Build {meta_package: set(its packages)} once + mp_package_sets = { + mp: set(mp.packages.all()) for mp in basket_meta_packages + } + + conflicting_packages = [] + + # Packages that appear both individually and in a meta_package + for package in basket_packages: + for mp_pkgs in mp_package_sets.values(): + if package in mp_pkgs: + conflicting_packages.append(package) + break + + # Packages shared between different meta_packages + mp_list = list(mp_package_sets.items()) + for i, (mp, mp_pkgs) in enumerate(mp_list): + for j in range(i + 1, len(mp_list)): + omp, omp_pkgs = mp_list[j] + conflicting_packages.extend(mp_pkgs & omp_pkgs) + + return set(conflicting_packages) + + def fast_cost( + self, identifier, identifier_type="user", country=None + ) -> tuple[list, dict]: + """ + Optimized version of cost. + Accepts pre-resolved country to avoid redundant user lookups. + Uses prefetched M2M relations. + Batch-prefetches all bandings and prices in 2 queries. + """ + package_costs = [] + + if country is None: + if identifier_type == "user": + user = account_models.User.objects.get(username=identifier) + country = user.profile.default_currency + else: + country_pk = identifier.get("currency", None) + country = Country.objects.filter(pk=country_pk).first() + + # Pre-fetch all AccountBandingChoices for the user once + account_banding_choices = None + if identifier_type == "user": + account_banding_choices = { + abc.banding_type_id: abc + for abc in account_models.AccountBandingChoices.objects.filter( + account=identifier, + ).select_related("banding_type_vocab") + } + + # --- Batch-prefetch all bandings and prices for all basket packages --- + all_pkg_ids = [p.pk for p in self.packages.all()] + for mp in self.meta_packages.all(): + all_pkg_ids.extend(p.pk for p in mp.packages.all()) + + all_bandings = Banding.objects.filter( + package_id__in=all_pkg_ids + ).select_related("banding_type", "vocab") + + all_prices = Price.objects.filter( + banding__package_id__in=all_pkg_ids + ).select_related("banding", "country") + + # Build lookups: (package_id, banding_type_id) -> [bandings] + bandings_cache = {} + for b in all_bandings: + bandings_cache.setdefault( + (b.package_id, b.banding_type_id), [] + ).append(b) + + # Build lookups: (banding_id, country_id) -> price + price_cache = {} + for p in all_prices: + price_cache[(p.banding_id, p.country_id)] = p + + for package in self.packages.all(): + price, banding = utils.fast_get_price_for_package( + package=package, + identifier=identifier, + identifier_type=identifier_type, + country=country if country else None, + account_banding_choices=account_banding_choices, + bandings_cache=bandings_cache, + price_cache=price_cache, + ) + package_costs.append( + {"package": package, "cost": price, "banding": banding} + ) + + for mp in self.meta_packages.all(): + for package in mp.packages.all(): + price, banding = utils.fast_get_price_for_package( + package=package, + identifier=identifier, + identifier_type=identifier_type, + country=country if country else None, + account_banding_choices=account_banding_choices, + bandings_cache=bandings_cache, + price_cache=price_cache, + ) + package_costs.append( + {"package": package, "cost": price, "banding": banding} + ) + + currency_totals = dict() + completed_packages = [] + for pc in package_costs: + if (pc.get("cost") and pc.get("banding")) and pc.get( + "package" + ) not in completed_packages: + if pc.get("cost").country: + currency = pc.get("cost").country.currency + else: + currency = pc.get("cost").default_currency + + if currency_totals.get(currency): + currency_totals[currency] = ( + currency_totals[currency] + pc.get("cost").value + ) + else: + currency_totals[currency] = pc.get("cost").value + + completed_packages.append(pc.get("package")) + + return package_costs, currency_totals + + def fast_get_best_bandings_for_form( + self, identifier, identifier_type="user", country=None + ) -> set: + """ + Optimized version of get_best_bandings_for_form. + Accepts pre-resolved country and batch-fetches all prices + in 2 queries instead of N+1. + """ + package_bandings_return = [] + + if country is None: + if identifier_type == "user": + user = account_models.User.objects.get(username=identifier) + currency = user.profile.default_currency + else: + currency_pk = identifier.get("currency") + currency = Country.objects.filter(pk=currency_pk).first() + else: + currency = country + + if not currency: + return set() + + # Collect ALL packages from basket (direct + meta_packages) + all_packages = list(self.packages.all()) + for mp in self.meta_packages.all(): + all_packages.extend(mp.packages.all()) + all_package_ids = [p.pk for p in all_packages] + + # Find catch-all country for currency + catch_all_matching_currency = Country.objects.filter( + currency=currency.currency, catch_all=True + ).first() + + if catch_all_matching_currency: + suitable_prices = Price.objects.filter( + country__currency=catch_all_matching_currency.currency, + country__catch_all=True, + ).select_related("banding__banding_type") + package_bandings_return.extend( + price.banding for price in suitable_prices + ) + + # Batch fetch ALL bandings for all basket packages at once + bandings = Banding.objects.filter( + package_id__in=all_package_ids + ).select_related("banding_type") + + # Batch fetch ALL prices for those bandings at once + all_prices = Price.objects.filter( + banding__in=bandings + ).select_related("banding__banding_type", "country") + + # Build lookup: package_id -> list of prices + price_by_package = {} + for price in all_prices: + pkg_id = price.banding.package_id + price_by_package.setdefault(pkg_id, []).append(price) + + default_countries = { + p.pk: p.default_country_id for p in all_packages + } + + for package in all_packages: + pkg_prices = price_by_package.get(package.pk, []) + + # First try: prices matching user currency + suitable = [ + p for p in pkg_prices if p.country_id == currency.pk + ] + if suitable: + package_bandings_return.extend( + p.banding for p in suitable + ) + else: + # Fallback: default country + default_country_id = default_countries.get(package.pk) + suitable = [ + p for p in pkg_prices + if p.country_id == default_country_id + ] + if suitable: + package_bandings_return.extend( + p.banding for p in suitable + ) + + return set( + banding.banding_type + for banding in package_bandings_return + if not banding.banding_type.is_fte + ) + class AggregateForm(models.Model): """ @@ -1347,6 +1715,9 @@ class Order(models.Model): blank=True, null=True, default=datetime.date.today ) + # the term length in years + term = models.IntegerField(default=1) + # the associated basket for this order basket = models.ForeignKey( Basket, @@ -1516,8 +1887,10 @@ def save_order_form(self, form) -> None: :return: None """ self.email_address = form.cleaned_data.get("email_address") + self.term = form.cleaned_data.get("term_length") + for k, v in form.cleaned_data.items(): - if not k == "email_address": + if not k == "email_address" and not k == "term_length": form_element = AggregateFormElement.objects.get(pk=k) answer, _ = OrderFormAnswer.objects.update_or_create( order=self, @@ -1698,6 +2071,16 @@ def formatted_price(self) -> str: """ return utils.format_price(self.price, self.currency.currency) + @property + def formatted_price_multiplier(self) -> str: + """ + Returns a formatted price + :return: str + """ + return utils.format_price( + self.price * self.associated_order.term, self.currency.currency + ) + class MediaFile(models.Model): """ @@ -1750,3 +2133,45 @@ def serve_file(self) -> HttpResponse: return serve_file( path=self.file.path, filename=self.file.name, mime=self.mime ) + + +class PreCalcMinMax(models.Model): + package = models.ForeignKey( + "Package", + on_delete=models.CASCADE, + null=True, + blank=True, + ) + meta_package = models.ForeignKey( + "MetaPackage", + on_delete=models.CASCADE, + null=True, + blank=True, + ) + country = models.ForeignKey( + "Country", + on_delete=models.CASCADE, + ) + min_amount = models.IntegerField() + max_amount = models.IntegerField() + + def __str__(self): + # fetch the "to" translation field + to_translation = cms_models.SiteText.objects.get(key="to") + + return "{0} {2} {1}".format( + babel.numbers.format_currency( + self.min_amount, self.country.currency, locale="en_US" + ), + babel.numbers.format_currency( + self.max_amount, self.country.currency, locale="en_US" + ), + to_translation + ) + + def get_package(self): + if self.package: + return self.package.name + if self.meta_package: + return self.meta_package + return "No package associated with pre calc price" diff --git a/src/package/templatetags/conflicts.py b/src/package/templatetags/conflicts.py index ec06cec..2fdda04 100644 --- a/src/package/templatetags/conflicts.py +++ b/src/package/templatetags/conflicts.py @@ -1,5 +1,7 @@ from django import template +from cms import models + register = template.Library() @@ -13,12 +15,16 @@ def conflict_statement(package, basket): :return: a string describing the conflict between the package and the basket """ package_meta_packages = package.meta_packages() + text = models.SiteText.objects.get( + key='included_within_offers', + ) conflicting_metapackage_names = [] for meta_package in package_meta_packages: if meta_package in basket.meta_packages.all(): conflicting_metapackage_names.append(meta_package.name) - return "Included within these offers: {}".format( + return "{}: {}".format( + text, ", ".join(conflicting_metapackage_names) ) diff --git a/src/package/templatetags/country.py b/src/package/templatetags/country.py new file mode 100644 index 0000000..f00dec1 --- /dev/null +++ b/src/package/templatetags/country.py @@ -0,0 +1,18 @@ +from django.template.defaulttags import register + +from package import models + + +@register.simple_tag(takes_context=True) +def country_code_to_name(context): + request = context.get("request") + try: + country = models.Country.objects.filter( + code=request.session.get('country') + ).first() + if country: + return country.name + else: + return '' + except models.Country.DoesNotExist: + return request.session.get('country') diff --git a/src/package/tests.py b/src/package/tests.py new file mode 100644 index 0000000..afaaffd --- /dev/null +++ b/src/package/tests.py @@ -0,0 +1,1181 @@ +""" +Comparison tests for view_basket (original) vs fast_view_basket (optimized). + +These tests verify that for multiple package and meta-package basket +configurations, both views produce identical template context and rendered +HTML output. + +Uses fixtures/test_package.json which provides: + - 20 Initiatives (pk 1-20) + - 3 Countries (GBP pk=999, USD pk=998, EUR pk=997) + - 2 BandingTypes: FTE pk=100 (8 vocabs 100-107), + Choice pk=101 (8 vocabs 108-115) + - 50 Packages (pk 100-149) across 20 initiatives, with 10 different + banding-type / currency configurations + - 10 MetaPackages (pk 300-309) with 3-18 packages each, overlapping + membership creating 39 conflict points + - 880 prices across 520 bandings + +Additional objects (SiteSetup, SiteText, User, Profile, +AccountBandingChoices) are created programmatically in setUpTestData. +""" + +import re +import time +from decimal import Decimal +from unittest.mock import patch + +from django.contrib.auth.models import User +from django.contrib.sessions.backends.db import SessionStore +from django.core.management import call_command +from django.test import TestCase, RequestFactory + +from accounts.models import AccountBandingChoices, Profile +from cms.models import SiteText +from intrepid.models import SiteSetup +from package import forms, models, utils, views +from vocab.models import BandingVocab + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +class _AnonymousUser: + """Minimal stand-in for an anonymous user.""" + + is_authenticated = False + pk = None + + def __str__(self): + return "AnonymousUser" + + +# --------------------------------------------------------------------------- +# Shared fixture mixin +# --------------------------------------------------------------------------- + + +class BasketFixtureMixin: + """ + Loads ``fixtures/test_package.json`` (20 initiatives, 50 packages, + 10 metas, 1825 objects) and creates the supporting objects needed by + views and forms. + + Package config cycle (repeats every 10 PKs starting at 100): + 0: FTE+Choice / GBP+USD+EUR (pk 100, 110, 120, 130, 140) + 1: FTE / GBP (pk 101, 111, 121, 131, 141) + 2: FTE / GBP+USD (pk 102, 112, 122, 132, 142) + 3: Choice / GBP (pk 103, 113, 123, 133, 143) + 4: FTE+Choice / GBP+USD (pk 104, 114, 124, 134, 144) + 5: FTE / GBP+EUR (pk 105, 115, 125, 135, 145) + 6: Choice / USD (pk 106, 116, 126, 136, 146) + 7: FTE+Choice / GBP (pk 107, 117, 127, 137, 147) + 8: FTE / EUR (pk 108, 118, 128, 138, 148) + 9: Choice / GBP+USD (pk 109, 119, 129, 139, 149) + """ + + @classmethod + def setUpTestData(cls): + # ---- Load fixture (includes 20 initiatives, 50 packages, etc.) ---- + call_command("loaddata", "test_package", verbosity=0) + + # ---- Countries ---- + cls.country_gbp = models.Country.objects.get(pk=999) + cls.country_usd = models.Country.objects.get(pk=998) + cls.country_eur = models.Country.objects.get(pk=997) + + # ---- BandingTypes ---- + cls.fte_banding_type = models.BandingType.objects.get(pk=100) + cls.choice_banding_type = models.BandingType.objects.get(pk=101) + + # ---- All 50 packages (ordered by pk) ---- + cls.all_packages = list( + models.Package.objects.filter( + pk__gte=100, pk__lte=149, + ).order_by("pk") + ) + + # ---- Named references for targeted tests ---- + cls.pkg_all_combos = models.Package.objects.get(pk=100) + cls.pkg_simple_fte = models.Package.objects.get(pk=101) + cls.pkg_fte_multi_curr = models.Package.objects.get(pk=102) + cls.pkg_simple_choice = models.Package.objects.get(pk=103) + cls.pkg_dual_multi = models.Package.objects.get(pk=104) + cls.pkg_fte_gbp_eur = models.Package.objects.get(pk=105) + cls.pkg_choice_usd = models.Package.objects.get(pk=106) + cls.pkg_dual_gbp = models.Package.objects.get(pk=107) + cls.pkg_fte_eur = models.Package.objects.get(pk=108) + cls.pkg_choice_multi = models.Package.objects.get(pk=109) + + # ---- Convenience subsets ---- + # GBP-only packages (no currency conversion needed) + cls.gbp_only_packages = [ + models.Package.objects.get(pk=pk) + for pk in [101, 103, 107, 111, 113, 117, 121, 123, 127] + ] + + # ---- All 10 meta packages (ordered by pk) ---- + cls.all_metas = list( + models.MetaPackage.objects.filter( + pk__gte=300, pk__lte=309, + ).order_by("pk") + ) + cls.meta_18 = models.MetaPackage.objects.get(pk=300) + cls.meta_15 = models.MetaPackage.objects.get(pk=301) + cls.meta_3 = models.MetaPackage.objects.get(pk=309) + + # ---- SiteSetup ---- + cls.site_setup = SiteSetup.objects.create( + site_name="Test Site", + enable_signup=True, + enable_meta_package_signup=True, + enable_individual_package_signup=True, + fee_amount=5, + fallback_currency="GBP", + ) + + # ---- SiteText entries required by FTEForm / FastFTEForm ---- + for key in ( + "select_currency_note", + "fte_student_count_prompt", + "institutions_fte", + "your_currency", + "after_currency_bandings_info", + "institution_details", + "included_within_offers", + ): + SiteText.objects.get_or_create( + key=key, + defaults={ + "body": key.replace("_", " ").title(), + "help_text": "", + "rich_text": False, + "frontend": False, + }, + ) + + # ---- User + Profile ---- + cls.user = User.objects.create_user( + username="testuser", password="testpass123", + email="test@example.com", + ) + profile, _ = Profile.objects.get_or_create(account=cls.user) + profile.fte = 12000 # falls in "Large" tier (10,001-20,000) + profile.default_currency = cls.country_gbp + profile.save() + cls.profile = profile + + # ---- AccountBandingChoices (for choice-based banding type) ---- + AccountBandingChoices.objects.create( + account=cls.user, + banding_type=cls.choice_banding_type, + banding_type_vocab=BandingVocab.objects.get(pk=113), + ) + + +# --------------------------------------------------------------------------- +# Model-level: price_bandings +# --------------------------------------------------------------------------- + + +class TestFastPriceBandings(BasketFixtureMixin, TestCase): + """Verify fast_price_bandings produces identical output to price_bandings.""" + + def _compare(self, package): + original = package.price_bandings + + if "fast_price_bandings" in package.__dict__: + del package.__dict__["fast_price_bandings"] + fast = package.fast_price_bandings + + self.assertEqual( + set(original.keys()), set(fast.keys()), + "Banding entry keys differ", + ) + for entry_key in original: + orig_inner = original[entry_key] + fast_inner = fast[entry_key] + self.assertEqual( + set(orig_inner.keys()), set(fast_inner.keys()), + "Country keys differ for {}".format(entry_key), + ) + for country_key in orig_inner: + orig_pks = sorted(p.pk for p in orig_inner[country_key]) + fast_pks = sorted(p.pk for p in fast_inner[country_key]) + self.assertEqual( + orig_pks, fast_pks, + "Price PKs differ for {} / {}".format( + entry_key, country_key, + ), + ) + + def test_all_combos(self): + """FTE+Choice / GBP+USD+EUR — maximum complexity.""" + self._compare(self.pkg_all_combos) + + def test_simple_fte(self): + """FTE / GBP — simplest case.""" + self._compare(self.pkg_simple_fte) + + def test_fte_multi_currency(self): + """FTE / GBP+USD.""" + self._compare(self.pkg_fte_multi_curr) + + def test_simple_choice(self): + """Choice / GBP.""" + self._compare(self.pkg_simple_choice) + + def test_dual_multi_currency(self): + """FTE+Choice / GBP+USD.""" + self._compare(self.pkg_dual_multi) + + def test_fte_gbp_eur(self): + """FTE / GBP+EUR.""" + self._compare(self.pkg_fte_gbp_eur) + + def test_choice_usd_only(self): + """Choice / USD — foreign currency only.""" + self._compare(self.pkg_choice_usd) + + def test_dual_gbp_only(self): + """FTE+Choice / GBP.""" + self._compare(self.pkg_dual_gbp) + + def test_fte_eur_only(self): + """FTE / EUR.""" + self._compare(self.pkg_fte_eur) + + def test_choice_multi_currency(self): + """Choice / GBP+USD.""" + self._compare(self.pkg_choice_multi) + + +# --------------------------------------------------------------------------- +# Model-level: list_of_conflicting_packages +# --------------------------------------------------------------------------- + + +class TestFastListOfConflictingPackages(BasketFixtureMixin, TestCase): + """ + Verify fast_list_of_conflicting_packages matches the original for + various basket configurations. + """ + + def _compare(self, basket): + original = basket.list_of_conflicting_packages() + fast = basket.fast_list_of_conflicting_packages() + self.assertEqual(original, fast) + + def test_empty_basket(self): + basket = models.Basket.objects.create( + name="Empty", account=self.user, active=True, + ) + self._compare(basket) + + def test_packages_only_no_conflicts(self): + basket = models.Basket.objects.create( + name="Pkgs only", account=self.user, active=True, + ) + basket.packages.add(*self.gbp_only_packages[:5]) + self._compare(basket) + + def test_two_metas_with_overlap(self): + """meta_18 and meta_15 share packages -> conflicts.""" + basket = models.Basket.objects.create( + name="Meta overlap", account=self.user, active=True, + ) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._compare(basket) + + def test_direct_and_meta_overlap(self): + """pkg 100 is both direct and inside meta_18 -> conflict.""" + basket = models.Basket.objects.create( + name="Direct+meta", account=self.user, active=True, + ) + basket.packages.add(self.pkg_all_combos) + basket.meta_packages.add(self.meta_18) + self._compare(basket) + + def test_all_metas(self): + """All 10 meta packages — lots of overlaps.""" + basket = models.Basket.objects.create( + name="All metas", account=self.user, active=True, + ) + basket.meta_packages.add(*self.all_metas) + self._compare(basket) + + def test_single_meta(self): + basket = models.Basket.objects.create( + name="Single meta", account=self.user, active=True, + ) + basket.meta_packages.add(self.meta_3) + self._compare(basket) + + def test_full_basket(self): + """All 50 packages + all 10 metas.""" + basket = models.Basket.objects.create( + name="Full", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages) + basket.meta_packages.add(*self.all_metas) + self._compare(basket) + + +# --------------------------------------------------------------------------- +# Model-level: cost +# --------------------------------------------------------------------------- + + +class TestFastCost(BasketFixtureMixin, TestCase): + """ + Verify fast_cost returns the same package_costs and currency_totals + as the original cost method. + """ + + def _compare(self, basket): + identifier = self.user + identifier_type = "user" + country = self.user.profile.default_currency + + orig_costs, orig_totals = basket.cost( + identifier=identifier, identifier_type=identifier_type, + ) + fast_costs, fast_totals = basket.fast_cost( + identifier=identifier, identifier_type=identifier_type, + country=country, + ) + + self.assertEqual( + len(orig_costs), len(fast_costs), + "package_costs length differs", + ) + for i, (orig, fast) in enumerate(zip(orig_costs, fast_costs)): + self.assertEqual( + orig["package"].pk, fast["package"].pk, + "package_costs[{}].package differs".format(i), + ) + if orig["cost"] == 0: + self.assertEqual( + fast["cost"], 0, + "package_costs[{}].cost: expected 0".format(i), + ) + else: + self.assertEqual( + orig["cost"].pk, fast["cost"].pk, + "package_costs[{}].cost PK differs".format(i), + ) + self.assertEqual( + orig["cost"].value, fast["cost"].value, + "package_costs[{}].cost value differs".format(i), + ) + if orig["banding"] is None: + self.assertIsNone( + fast["banding"], + "package_costs[{}].banding: expected None".format(i), + ) + else: + self.assertEqual( + orig["banding"].pk, fast["banding"].pk, + "package_costs[{}].banding PK differs".format(i), + ) + + self.assertEqual(orig_totals, fast_totals, "currency_totals differ") + + def test_single_package(self): + basket = models.Basket.objects.create( + name="Single", account=self.user, active=True, + ) + basket.packages.add(self.pkg_all_combos) + self._compare(basket) + + def test_five_gbp_packages(self): + basket = models.Basket.objects.create( + name="5 GBP", account=self.user, active=True, + ) + basket.packages.add(*self.gbp_only_packages[:5]) + self._compare(basket) + + def test_packages_mixed_currency(self): + basket = models.Basket.objects.create( + name="Mixed curr", account=self.user, active=True, + ) + basket.packages.add( + self.pkg_all_combos, self.pkg_choice_usd, self.pkg_fte_eur, + ) + self._compare(basket) + + def test_meta_packages(self): + basket = models.Basket.objects.create( + name="Meta", account=self.user, active=True, + ) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._compare(basket) + + def test_twenty_packages(self): + basket = models.Basket.objects.create( + name="Twenty", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages[:20]) + self._compare(basket) + + def test_mixed_packages_and_meta(self): + basket = models.Basket.objects.create( + name="Mixed", account=self.user, active=True, + ) + basket.packages.add(self.pkg_simple_choice, self.pkg_fte_eur) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._compare(basket) + + def test_full_basket(self): + basket = models.Basket.objects.create( + name="Full", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages) + basket.meta_packages.add(*self.all_metas) + self._compare(basket) + + +# --------------------------------------------------------------------------- +# Model-level: get_best_bandings_for_form +# --------------------------------------------------------------------------- + + +class TestFastGetBestBandingsForForm(BasketFixtureMixin, TestCase): + """ + Verify fast_get_best_bandings_for_form returns the same set of + BandingType objects as the original. + """ + + def _compare(self, basket): + identifier = self.user + identifier_type = "user" + country = self.user.profile.default_currency + + original = basket.get_best_bandings_for_form( + identifier, identifier_type, + ) + fast = basket.fast_get_best_bandings_for_form( + identifier, identifier_type, country=country, + ) + self.assertEqual(original, fast) + + def test_single_package(self): + basket = models.Basket.objects.create( + name="Single", account=self.user, active=True, + ) + basket.packages.add(self.pkg_simple_choice) + self._compare(basket) + + def test_multiple_packages(self): + basket = models.Basket.objects.create( + name="Multi", account=self.user, active=True, + ) + basket.packages.add( + self.pkg_all_combos, self.pkg_simple_fte, self.pkg_simple_choice, + ) + self._compare(basket) + + def test_meta_packages(self): + basket = models.Basket.objects.create( + name="Meta", account=self.user, active=True, + ) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._compare(basket) + + def test_full_basket(self): + basket = models.Basket.objects.create( + name="Full", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages) + basket.meta_packages.add(*self.all_metas) + self._compare(basket) + + def test_cross_currency_package(self): + """pkg_choice_usd is USD-priced; user prefers GBP -> fallback.""" + basket = models.Basket.objects.create( + name="Cross", account=self.user, active=True, + ) + basket.packages.add(self.pkg_choice_usd) + self._compare(basket) + + def test_multi_banding_basket(self): + basket = models.Basket.objects.create( + name="Multi-band", account=self.user, active=True, + ) + basket.packages.add( + self.pkg_all_combos, self.pkg_dual_multi, self.pkg_dual_gbp, + ) + self._compare(basket) + + +# --------------------------------------------------------------------------- +# Util-level: get_price_for_package +# --------------------------------------------------------------------------- + + +class TestFastGetPriceForPackage(BasketFixtureMixin, TestCase): + """ + Verify fast_get_price_for_package returns the same price/banding + as the original for each package. + """ + + def _compare(self, package, country=None): + identifier = self.user + identifier_type = "user" + if country is None: + country = self.user.profile.default_currency + + orig_price, orig_banding = utils.get_price_for_package( + package=package, identifier=identifier, + identifier_type=identifier_type, country=country, + ) + + if "fast_price_bandings" in package.__dict__: + del package.__dict__["fast_price_bandings"] + + account_banding_choices = { + abc.banding_type_id: abc + for abc in AccountBandingChoices.objects.filter( + account=identifier, + ).select_related("banding_type_vocab") + } + + fast_price, fast_banding = utils.fast_get_price_for_package( + package=package, identifier=identifier, + identifier_type=identifier_type, country=country, + account_banding_choices=account_banding_choices, + ) + + if orig_price == 0: + self.assertEqual(fast_price, 0) + else: + self.assertEqual(orig_price.pk, fast_price.pk) + self.assertEqual(orig_price.value, fast_price.value) + + if orig_banding is None: + self.assertIsNone(fast_banding) + else: + self.assertEqual(orig_banding.pk, fast_banding.pk) + + def test_fte_matching_currency(self): + """FTE/GBP, user currency is GBP.""" + self._compare(self.pkg_simple_fte) + + def test_fte_different_currency(self): + """FTE/EUR, user currency is GBP -> fallback.""" + self._compare(self.pkg_fte_eur) + + def test_choice_package(self): + """Choice/GBP.""" + self._compare(self.pkg_simple_choice) + + def test_all_combos_package(self): + """FTE+Choice / GBP+USD+EUR — most complex.""" + self._compare(self.pkg_all_combos) + + def test_dual_multi_currency(self): + """FTE+Choice / GBP+USD.""" + self._compare(self.pkg_dual_multi) + + def test_choice_usd_with_gbp_user(self): + """Choice/USD, user is GBP -> fallback.""" + self._compare(self.pkg_choice_usd) + + def test_eur_country_override(self): + """Force EUR country for a GBP+EUR package.""" + self._compare(self.pkg_fte_gbp_eur, country=self.country_eur) + + def test_usd_country_override(self): + """Force USD country for an all-currency package.""" + self._compare(self.pkg_all_combos, country=self.country_usd) + + +# --------------------------------------------------------------------------- +# Util-level: get_user_currency +# --------------------------------------------------------------------------- + + +class TestFastGetUserCurrency(BasketFixtureMixin, TestCase): + """Verify fast_get_user_currency matches get_user_currency.""" + + def test_authenticated_user(self): + orig = utils.get_user_currency(self.user, "user") + fast = utils.fast_get_user_currency( + self.user, "user", country=self.user.profile.default_currency, + ) + self.assertEqual(orig, fast) + + def test_session_user(self): + session = {"currency": self.country_usd.pk} + orig = utils.get_user_currency(session, "session") + fast = utils.fast_get_user_currency(session, "session") + self.assertEqual(orig, fast) + + def test_pre_resolved_bypasses_lookup(self): + """When country is passed, it should be returned as-is.""" + result = utils.fast_get_user_currency( + None, "user", country=self.country_gbp, + ) + self.assertEqual(result, self.country_gbp) + + +# --------------------------------------------------------------------------- +# View-level: compare full template contexts +# --------------------------------------------------------------------------- + + +class _ViewComparisonMixin: + """ + Shared logic for comparing view_basket vs fast_view_basket contexts. + Patches ``render`` to capture the template context dict. + """ + + def _extract_context(self, view_func, request, basket_id): + captured = {} + + import package.views as pv + original_render = pv.render + + def mock_render(req, template, context): + captured.update(context) + return original_render(req, template, context) + + pv.render = mock_render + try: + view_func(request, basket_id=basket_id) + finally: + pv.render = original_render + + return captured + + def _compare_contexts(self, orig_ctx, fast_ctx): + # ---- package_costs ---- + orig_costs = orig_ctx["package_costs"] + fast_costs = fast_ctx["package_costs"] + self.assertEqual( + len(orig_costs), len(fast_costs), + "package_costs length differs", + ) + for i, (o, f) in enumerate(zip(orig_costs, fast_costs)): + self.assertEqual( + o["package"].pk, f["package"].pk, + "package_costs[{}].package differs".format(i), + ) + if o["cost"] == 0: + self.assertEqual(f["cost"], 0) + else: + self.assertEqual( + o["cost"].pk, f["cost"].pk, + "package_costs[{}].cost PK differs".format(i), + ) + if o["banding"] is None: + self.assertIsNone(f["banding"]) + else: + self.assertEqual( + o["banding"].pk, f["banding"].pk, + "package_costs[{}].banding PK differs".format(i), + ) + + # ---- currency_totals ---- + self.assertEqual( + orig_ctx["currency_totals"], fast_ctx["currency_totals"], + ) + + # ---- conflicting_packages ---- + orig_pks = {p.pk for p in orig_ctx["conflicting_packages"]} + fast_pks = {p.pk for p in fast_ctx["conflicting_packages"]} + self.assertEqual(orig_pks, fast_pks) + + # ---- scalar context values ---- + for key in ( + "has_all_prices", + "message", + "site_percentage", + "currency_converted", + "converted_total", + "converted_currency", + ): + self.assertEqual( + orig_ctx.get(key), fast_ctx.get(key), + "Context key '{}' differs".format(key), + ) + + # ---- user_currency ---- + self.assertEqual( + orig_ctx["user_currency"], fast_ctx["user_currency"], + ) + + # ---- bandings list ---- + orig_banding_pks = [b.pk for b in orig_ctx["bandings"]] + fast_banding_pks = [b.pk for b in fast_ctx["bandings"]] + self.assertEqual(orig_banding_pks, fast_banding_pks) + + +class TestViewBasketComparison( + BasketFixtureMixin, _ViewComparisonMixin, TestCase +): + """ + End-to-end comparison for an authenticated user: call both + view_basket and fast_view_basket and verify contexts match. + """ + + def setUp(self): + self.factory = RequestFactory() + + def _make_request(self): + request = self.factory.get("/fake/") + request.user = self.user + request.session = {"country": self.country_gbp.code} + request.site = self.site_setup + request.signups = [] + return request + + def _run_comparison(self, basket): + orig_ctx = self._extract_context( + views.view_basket, self._make_request(), basket.pk, + ) + fast_ctx = self._extract_context( + views.fast_view_basket, self._make_request(), basket.pk, + ) + self._compare_contexts(orig_ctx, fast_ctx) + + def test_single_package(self): + basket = models.Basket.objects.create( + name="Single", account=self.user, active=True, + ) + basket.packages.add(self.pkg_all_combos) + self._run_comparison(basket) + + def test_five_packages(self): + basket = models.Basket.objects.create( + name="Five", account=self.user, active=True, + ) + basket.packages.add(*self.gbp_only_packages[:5]) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_meta_packages(self, mock_convert): + basket = models.Basket.objects.create( + name="Meta", account=self.user, active=True, + ) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_mixed_packages_and_meta(self, mock_convert): + basket = models.Basket.objects.create( + name="Mixed", account=self.user, active=True, + ) + basket.packages.add(self.pkg_simple_choice) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_twenty_packages(self, mock_convert): + basket = models.Basket.objects.create( + name="Twenty", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages[:20]) + basket.meta_packages.add(*self.all_metas[:5]) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_full_basket(self, mock_convert): + """All 50 packages + all 10 metas.""" + basket = models.Basket.objects.create( + name="Full", account=self.user, active=True, + ) + basket.packages.add(*self.all_packages) + basket.meta_packages.add(*self.all_metas) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_cross_currency(self, mock_convert): + basket = models.Basket.objects.create( + name="Cross", account=self.user, active=True, + ) + basket.packages.add( + self.pkg_all_combos, self.pkg_choice_usd, self.pkg_fte_eur, + ) + self._run_comparison(basket) + + +# --------------------------------------------------------------------------- +# Session-based (anonymous) view comparison tests +# --------------------------------------------------------------------------- + + +class TestViewBasketSessionComparison( + BasketFixtureMixin, _ViewComparisonMixin, TestCase +): + """Same comparisons but for anonymous/session-based users.""" + + def setUp(self): + self.factory = RequestFactory() + self.session = SessionStore() + self.session["currency"] = self.country_gbp.pk + self.session["fte"] = 12000 + self.session.create() + + def _make_request(self): + request = self.factory.get("/fake/") + request.user = _AnonymousUser() + request.session = self.session + request.site = self.site_setup + request.signups = [] + return request + + def _run_comparison(self, basket): + orig_ctx = self._extract_context( + views.view_basket, self._make_request(), basket.pk, + ) + fast_ctx = self._extract_context( + views.fast_view_basket, self._make_request(), basket.pk, + ) + self._compare_contexts(orig_ctx, fast_ctx) + + def test_session_single(self): + basket = models.Basket.objects.create( + name="Sess single", session_id=self.session.session_key, + active=True, + ) + basket.packages.add(self.pkg_all_combos) + self._run_comparison(basket) + + def test_session_five(self): + basket = models.Basket.objects.create( + name="Sess five", session_id=self.session.session_key, + active=True, + ) + basket.packages.add(*self.gbp_only_packages[:5]) + self._run_comparison(basket) + + def test_session_meta(self): + basket = models.Basket.objects.create( + name="Sess meta", session_id=self.session.session_key, + active=True, + ) + basket.meta_packages.add(self.meta_18, self.meta_15) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_session_twenty(self, mock_convert): + basket = models.Basket.objects.create( + name="Sess twenty", session_id=self.session.session_key, + active=True, + ) + basket.packages.add(*self.all_packages[:20]) + basket.meta_packages.add(*self.all_metas[:5]) + self._run_comparison(basket) + + @patch("package.currency.convert", return_value=1.25) + def test_session_full(self, mock_convert): + basket = models.Basket.objects.create( + name="Sess full", session_id=self.session.session_key, + active=True, + ) + basket.packages.add(*self.all_packages) + basket.meta_packages.add(*self.all_metas) + self._run_comparison(basket) + + +# --------------------------------------------------------------------------- +# Rendered output comparison: actual HTTP responses from both views +# --------------------------------------------------------------------------- + + +class _TimingTableMixin: + """ + Collects per-test timing results and prints a summary table in + ``tearDownClass``. + """ + + _timing_results = None + _timing_title = "Timing Results" + + @classmethod + def _init_timing(cls): + cls._timing_results = [] + + @classmethod + def _print_timing_table(cls): + if not cls._timing_results: + return + + label_w = max(len(r[0]) for r in cls._timing_results) + label_w = max(label_w, len("Scenario")) + + rows = [] + for label, orig, fast in cls._timing_results: + speedup = orig / fast if fast > 0 else float("inf") + saved = orig - fast + rows.append((label, orig, fast, speedup, saved)) + + print("\n") + print(" {}".format(cls._timing_title)) + print(" {}".format("=" * (label_w + 52))) + print(" {:<{w}} {:>10} {:>10} {:>9} {:>9}".format( + "Scenario", "Original", "Fast", "Speedup", "Saved", + w=label_w, + )) + print(" {:<{w}} {:>10} {:>10} {:>9} {:>9}".format( + "-" * label_w, "-" * 10, "-" * 10, "-" * 9, "-" * 9, + w=label_w, + )) + for label, orig, fast, speedup, saved in rows: + print(" {:<{w}} {:>9.3f}s {:>9.3f}s {:>8.1f}x {:>8.3f}s".format( + label, orig, fast, speedup, saved, + w=label_w, + )) + print(" {:<{w}} {:>10} {:>10} {:>9} {:>9}".format( + "-" * label_w, "-" * 10, "-" * 10, "-" * 9, "-" * 9, + w=label_w, + )) + + total_orig = sum(r[1] for r in rows) + total_fast = sum(r[2] for r in rows) + total_speedup = total_orig / total_fast if total_fast > 0 else float("inf") + total_saved = total_orig - total_fast + print(" {:<{w}} {:>9.3f}s {:>9.3f}s {:>8.1f}x {:>8.3f}s".format( + "TOTAL", total_orig, total_fast, total_speedup, total_saved, + w=label_w, + )) + print() + + _csrf_re = re.compile( + r'(name="csrfmiddlewaretoken"\s+value=")[^"]*(")' + ) + + @classmethod + def _normalise(cls, html): + return cls._csrf_re.sub(r'\1CSRF_TOKEN\2', html) + + def _get_responses(self, basket): + orig_url = "/packages/baskets/{}/".format(basket.pk) + fast_url = "/packages/baskets/{}/fast/".format(basket.pk) + + t0 = time.perf_counter() + orig_resp = self.client.get(orig_url) + orig_time = time.perf_counter() - t0 + + t0 = time.perf_counter() + fast_resp = self.client.get(fast_url) + fast_time = time.perf_counter() - t0 + + self.assertEqual( + orig_resp.status_code, 200, + "Original view returned {}".format(orig_resp.status_code), + ) + self.assertEqual( + fast_resp.status_code, 200, + "Fast view returned {}".format(fast_resp.status_code), + ) + return orig_resp, fast_resp, orig_time, fast_time + + def _compare_html(self, basket, label=""): + orig_resp, fast_resp, orig_time, fast_time = self._get_responses( + basket, + ) + orig_html = self._normalise(orig_resp.content.decode("utf-8")) + fast_html = self._normalise(fast_resp.content.decode("utf-8")) + + display_label = label or basket.name + self.__class__._timing_results.append( + (display_label, orig_time, fast_time), + ) + + self.assertEqual( + orig_html, fast_html, + "Rendered HTML differs between view_basket and fast_view_basket", + ) + + +class TestRenderedOutputComparison( + BasketFixtureMixin, _TimingTableMixin, TestCase, +): + """ + End-to-end test that hits both /packages/baskets/
-
Permission Denied
-{{ exception }}
+{% get_site_text 'permission_denied' %}
+{{ exception }}
- 
+
@@ -33,7 +33,7 @@
-
{% block title %}{% trans "Activate a new account" %}{% endblock %}
+{% block title %}{% get_site_text 'activate_new_account' %}{% endblock %}
{% block title %}{% trans "Activate a new account" %}{% endblock %}
{% block title %}{% trans "Activate a new account" %}{% endblock %}
{% block body-mobile %}
-
+
@@ -65,19 +65,14 @@
-
{% trans "Sign into your account" %}
+{% get_site_text 'sign_in_to_account' %}
{% trans "Sign into your account" %}
{% blocktrans %}{% endblocktrans %}
{% elif wizard.steps.current == 'token' %} {% if device.method == 'call' %} -{% blocktrans trimmed %}We are calling your phone right now, please enter the - digits you hear.{% endblocktrans %}
+{% get_site_text '2fa_calling' %}
{% elif device.method == 'sms' %} -{% blocktrans trimmed %}We sent you a text message, please enter the tokens we - sent.{% endblocktrans %}
+{% get_site_text '2fa_text' %}
{% else %} -{% blocktrans trimmed %}Please enter the tokens generated by your token - generator.{% endblocktrans %}
+{% get_site_text '2fa_token' %}
{% endif %} {% elif wizard.steps.current == 'backup' %} -{% blocktrans trimmed %}Use this form for entering backup tokens for logging in. - These tokens have been generated for you to print and keep safe. Please - enter one of these backup tokens to login to your account.{% endblocktrans %}
+{% get_site_text '2fa_backup' %}
{% endif %}
-
{% endblock %}
diff --git a/src/templates/accounts/banding_setup.html b/src/templates/accounts/banding_setup.html
index e644ace..b4558c3 100644
--- a/src/templates/accounts/banding_setup.html
+++ b/src/templates/accounts/banding_setup.html
@@ -1,10 +1,10 @@
{% extends "base/admin_base.html" %}
{% load static two_factor account_tags %}
-{% block title %}{% trans "Profile" %}{% endblock title %}
+{% block title %}{% get_site_text 'profile' %}{% endblock title %}
{% block breadcrumb %}
-
-
- Not a member yet?
- -
-