11058258525

Committed 26 Sep 2024 06:38PM UTC coverage: 62.307% (-0.01%) from 62.317%

Build # 11058258525

Build Type

push

github

Committed by

web-flow

Commit Message

add recommended content preview handling to policy prompt; fix featured preview events logic (#2854)

Run Details

0 of 1 new or added line in 1 file covered. (0.0%)

1 existing line in 1 file now uncovered.

3992 of 6407 relevant lines covered (62.31%)

1.25 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

69.78

/events/models.py

from core.models import (
    BasicPageAbstract,
    ContentPage,
    FeatureablePageAbstract,
    SearchablePageAbstract,
    ShareablePageAbstract,
    ThemeablePageAbstract
)
from django.db import models
from modelcluster.fields import ParentalKey
from wagtail.admin.panels import (
    FieldPanel,
    InlinePanel,
    MultiFieldPanel,
    PageChooserPanel,
)
from wagtail.fields import RichTextField, StreamField
from wagtail.models import Orderable, Page
from wagtail.documents.blocks import DocumentChooserBlock
from django.utils import timezone
from wagtail.search import index
import pytz
import re
import urllib.parse


class EventListPage(BasicPageAbstract, SearchablePageAbstract, Page):
    max_count = 1
    parent_page_types = ['home.HomePage']
    subpage_types = ['events.EventPage']
    templates = 'events/event_list_page.html'

    content_panels = [
        BasicPageAbstract.title_panel,
        BasicPageAbstract.hero_link_panel,
        BasicPageAbstract.body_panel,
        BasicPageAbstract.images_panel,
        MultiFieldPanel(
            [
                InlinePanel(
                    'featured_events',
                    max_num=6,
                    min_num=0,
                    label='Event',
                ),
            ],
            heading='Featured Events',
            classname='collapsible collapsed',
        ),
    ]
    settings_panels = Page.settings_panels + [
        BasicPageAbstract.submenu_panel,
    ]

    search_fields = Page.search_fields + BasicPageAbstract.search_fields + SearchablePageAbstract.search_fields

    def get_featured_events(self):
        featured_event_ids = self.featured_events.order_by('sort_order').values_list('event_page', flat=True)[:6]
        pages = Page.objects.specific().prefetch_related(
            'topics',
        ).in_bulk(featured_event_ids)
        return [pages[x] for x in featured_event_ids]

    def get_featured_events_preview(self):
        featured_events = self.featured_events.order_by('sort_order')
        featured_event_ids = [x.event_page.id for x in featured_events]
        pages = Page.objects.specific().prefetch_related(
            'topics',
        ).in_bulk(featured_event_ids)
        return [pages[x] for x in featured_event_ids]

    def get_context(self, request):
        context = super().get_context(request)
        if hasattr(context['request'], 'is_preview'):
            if context['request'].is_preview:
                context['featured_events'] = self.get_featured_events_preview()
            else:
                context['featured_events'] = self.get_featured_events()
        else:
            context['featured_events'] = self.get_featured_events()
        return context

    class Meta:
        verbose_name = 'Event List Page'


class EventListPageFeaturedEvent(Orderable):
    event_list_page = ParentalKey(
        'events.EventListPage',
        related_name='featured_events',
    )
    event_page = models.ForeignKey(
        'wagtailcore.Page',
        null=False,
        blank=False,
        on_delete=models.CASCADE,
        related_name='+',
        verbose_name='Event',
    )

    panels = [
        PageChooserPanel(
            'event_page',
            ['events.EventPage'],
        ),
    ]


class EventPage(
    BasicPageAbstract,
    ContentPage,
    FeatureablePageAbstract,
    ShareablePageAbstract,
    ThemeablePageAbstract,
):
    class EventAccessOptions(models.IntegerChoices):
        PRIVATE = (0, 'Private')
        PUBLIC = (1, 'Public')

    class EventFormats(models.TextChoices):
        HYBRID = ('hybrid', 'Hybrid')
        VIRTUAL = ('virtual', 'Virtual')
        IN_PERSON = ('in-person', 'In Person')

    class EventTypes(models.TextChoices):
        CIGI_SPONSORED = ('cigi_sponsored', 'CIGI Sponsored')
        CINEMA_SERIES = ('cinema_series', 'Cinema Series')
        COMMUNITY_EVENT = ('community_event', 'Community Event')
        CONFERENCE = ('conference', 'Conference')
        GLOBAL_POLICY_FORUM = ('global_policy_forum', 'Global Policy Forum')
        NOON_LECTURE_SERIES = ('noon_lecture_series', 'Noon Lecture Series')
        PANEL_DISCUSSION = ('panel_discussion', 'Panel Discussion')
        PUBLICATION_LAUNCH = ('publication_launch', 'Publication Launch')
        ROUNDTABLE = ('roundtable', 'Round Table')
        SEMINAR = ('seminar', 'Seminar')
        SIGNATURE_LECTURE = ('signature_lecture', 'Signature Lecture')
        VIRTUAL_EVENT = ('virtual_event', 'Virtual Event')
        WORKSHOP = ('workshop', 'Workshop')

    class InvitationTypes(models.IntegerChoices):
        RSVP_REQUIRED = (0, 'RSVP Required')
        INVITATION_ONLY = (1, 'Invitation Only')
        NO_RSVP = (2, 'No RSVP Required')

    class EventTimeZones(models.TextChoices):
        HAWAII = ('US/Hawaii', '(UTC–10:00) Hawaiian Time')
        LOS_ANGELES = ('America/Los_Angeles', '(UTC–08:00/09:00) Pacific Time')
        DENVER = ('America/Denver', '(UTC–06:00/07:00) Mountain Time')
        CHICAGO = ('America/Chicago', '(UTC–05:00/06:00) Central Time')
        TORONTO = ('America/Toronto', '(UTC–04:00/05:00) Eastern Time')
        CARACAS = ('America/Caracas', '(UTC–04:30) Venezuela Time')
        HALIFAX = ('America/Halifax', '(UTC–03:00/04:00) Atlantic Time')
        SAO_PAULO = ('America/Sao_Paulo', '(UTC–03:00) E. South America Time')
        CAPE_VERDE = ('Atlantic/Cape_Verde', '(UTC–01:00) Cape Verde Time')
        LONDON = ('Europe/London', '(UTC+00:00/01:00) GMT/BST')
        BERLIN = ('Europe/Berlin', '(UTC+01:00/02:00) Central European Time')
        BEIRUT = ('Asia/Beirut', '(UTC+02:00/03:00) Eastern European Time')
        MOSCOW = ('Europe/Moscow', '(UTC+03:00) Russian Time')
        TEHRAN = ('Asia/Tehran', '(UTC+02:30/03:30) Iran Time')
        DUBAI = ('Asia/Dubai', '(UTC+04:00) Arabian Time')
        KABUL = ('Asia/Kabul', '(UTC+04:30) Afghanistan Time')
        ASHGABAT = ('Asia/Ashgabat', '(UTC+05:00) West Asia Time')
        KOLKATA = ('Asia/Kolkata', '(UTC+05:30) India Time')
        KATHMANDU = ('Asia/Kathmandu', '(UTC+05:45) Nepal Time')
        YANGON = ('Asia/Yangon', '(UTC+06:30) Myanmar Time')
        BANGKOK = ('Asia/Bangkok', '(UTC+07:00) SE Asia Time')
        SHANGHAI = ('Asia/Shanghai', '(UTC+08:00) China Time')
        TOKYO = ('Asia/Tokyo', '(UTC+09:00) Tokyo Time')
        SYDNEY = ('Australia/Sydney', '(UTC+10:00/11:00) AUS Eastern Time')
        AUCKLAND = ('Pacific/Auckland', '(UTC+12:00/13:00) New Zealand Time')

    embed_youtube = models.URLField(blank=True)
    event_access = models.IntegerField(choices=EventAccessOptions.choices, default=EventAccessOptions.PUBLIC, null=True, blank=False)
    event_end = models.DateTimeField(blank=True, null=True)
    event_format = models.CharField(
        blank=False,
        max_length=32,
        null=True,
        choices=EventFormats.choices,
    )
    event_type = models.CharField(
        blank=False,
        max_length=32,
        null=True,
        choices=EventTypes.choices,
    )
    flickr_album_url = models.URLField(blank=True)
    invitation_type = models.IntegerField(choices=InvitationTypes.choices, default=InvitationTypes.RSVP_REQUIRED)
    location_address1 = models.CharField(blank=True, max_length=255, verbose_name='Address (Line 1)')
    location_address2 = models.CharField(blank=True, max_length=255, verbose_name='Address (Line 2)')
    location_city = models.CharField(blank=True, max_length=255, verbose_name='City')
    location_country = models.CharField(blank=True, max_length=255, verbose_name='Country')
    location_name = models.CharField(blank=True, max_length=255)
    location_postal_code = models.CharField(blank=True, max_length=32, verbose_name='Postal Code')
    location_province = models.CharField(blank=True, max_length=255, verbose_name='Province/State')
    multimedia_page = models.ForeignKey(
        'wagtailcore.Page',
        null=True,
        blank=True,
        on_delete=models.SET_NULL,
        related_name='+',
        verbose_name='Multimedia',
    )
    registration_url = models.URLField(blank=True, max_length=512)
    related_files = StreamField(
        [
            ('file', DocumentChooserBlock()),
        ],
        blank=True,
        use_json_field=True,
    )
    short_description = RichTextField(
        blank=True,
        null=False,
        features=['bold', 'italic', 'link'],
    )
    time_zone = models.CharField(
        blank=True,
        max_length=64,
        choices=EventTimeZones.choices,
        default=EventTimeZones.TORONTO,
    )
    twitter_hashtag = models.CharField(blank=True, max_length=64)
    website_button_text = models.CharField(
        blank=True,
        max_length=64,
        help_text='Override the button text for the event website. If empty, the button will read "Event Website".'
    )
    website_url = models.URLField(blank=True, max_length=512)

    # Reference field for the Drupal-Wagtail migrator. Can be removed after.
    drupal_node_id = models.IntegerField(blank=True, null=True)

    def location_string(self):
        # Show event format if it is not virtual only
        if self.event_format in [self.EventFormats.HYBRID, self.EventFormats.IN_PERSON]:
            location_strings = [
                self.location_address1,
                self.location_address2,
                self.location_city,
                self.location_province,
                self.location_postal_code,
                self.location_country
            ]
            return ', '.join([x for x in location_strings if x])
        return ''

    def location_map_url(self):
        return f'https://www.google.com/maps/search/?api=1&query={urllib.parse.quote(self.location_string())}'

    def event_format_string(self):
        return self.get_event_format_display()

    @property
    def multimedia_url(self):
        if self.multimedia_page:
            return self.multimedia_page.url
        return ''

    def is_past(self):
        now = timezone.now()
        if self.event_end:
            return self.event_end < now
        else:
            return self.publishing_date < now

    @property
    def event_start_time_utc(self):
        '''
        returns UTC datetime object
        - The datetime value entered in EventPage is currently assumed tzinfo="America/Toronto",
        regardless of the "time_zone" field specified; eg. "07:00:00AM America/Los_Angelos"
        - This is then converted to UTC and stored as "publishing_date"; eg. "11:00:00 (during daylight saving)."
        - So to allow specifying different timezones for the "time_zone" field, we need to first
        convert "publishing_date" from UTC back to "America/Toronto", then replace tzinfo with "time_zone"
        - If in the future, "publishing_date" is fixed to have user-specified timezone instead,
        this conversion and replacement would be unnecessary (and incorrect);
        can pass `return item.publishing_date` instead
        - This applies to item.event_end as well
        '''
        if self.time_zone == '' or not self.time_zone:
            return self.publishing_date
        else:
            default_tz = pytz.timezone('America/Toronto')
            correct_tz = pytz.timezone(self.time_zone)
            return pytz.utc.normalize(
                correct_tz.localize(
                    self.publishing_date.astimezone(default_tz).replace(tzinfo=None)
                )
            )

    @property
    def event_end_time_utc(self):
        if self.time_zone == '' or not self.time_zone:
            return self.event_end
        else:
            default_tz = pytz.timezone('America/Toronto')
            correct_tz = pytz.timezone(self.time_zone)
            return pytz.utc.normalize(
                correct_tz.localize(
                    self.event_end.astimezone(default_tz).replace(tzinfo=None)
                )
            )

    @property
    def time_zone_label(self):
        # timezone could have been assigned in freeform (previous version), or from a list of options (post change)
        # if it's from a list of options post change:
        if self.time_zone in self.EventTimeZones.values:
            '''
            timezone name set to short code based on self.time_zone value; in case no name is available,
            "%Z" returns offset: (eg "+0430" for Iran Time, together with offset this becomes "+0430 (UTC+0430)");
            use regex matching to remove the short code and only display offset in this case.
            '''
            tz = re.sub(r'[-+]\d{2,4} ',
                        '',
                        f'{self.event_start_time_utc.astimezone(pytz.timezone(self.time_zone)).strftime("%Z")} ')
            offset = self.event_start_time_utc.astimezone(pytz.timezone(self.time_zone)).strftime('%z')
            # return string format: "TZ (OFFSET)"" eg. "EDT (UTC-04:00)"
            label = f'{tz}(UTC{offset[:3].replace("-", "–")}:{offset[3:]})'
        # if it's not assigned: default to eastern
        elif not self.time_zone:
            tz_and_offset = self.event_start_time_utc.astimezone(pytz.timezone('America/Toronto')).strftime('%Z%z')
            label = f'{tz_and_offset[:3]} (UTC{tz_and_offset[3:6].replace("-", "–")}:{tz_and_offset[6:]})'
        # if it was assigned in freeform - preserve
        else:
            label = self.time_zone
        return label

    def get_context(self, request):
        context = super().get_context(request)
        context['location_string'] = self.location_string()
        context['event_format_string'] = self.get_event_format_display()
        context['location_map_url'] = self.location_map_url()
        return context

    def get_template(self, request, *args, **kwargs):
        standard_template = super(EventPage, self).get_template(request, *args, **kwargs)
        if self.theme:
            return f'themes/{self.get_theme_dir()}/event_page.html'
        return standard_template

    content_panels = [
        BasicPageAbstract.title_panel,
        MultiFieldPanel(
            [
                FieldPanel('short_description'),
                FieldPanel('body'),
            ],
            heading='Body',
            classname='collapsible collapsed'
        ),
        BasicPageAbstract.images_panel,
        FieldPanel('publishing_date', heading='Event start'),
        FieldPanel('event_end'),
        FieldPanel('time_zone'),
        MultiFieldPanel(
            [
                FieldPanel('event_format'),
                FieldPanel('event_type'),
                FieldPanel('event_access'),
                FieldPanel('invitation_type'),
                FieldPanel('website_url'),
                FieldPanel('website_button_text'),
                FieldPanel('registration_url'),
            ],
            heading='Event Details',
            classname='collapsible collapsed',
        ),
        MultiFieldPanel(
            [
                InlinePanel('authors'),
            ],
            heading='Speakers',
            classname='collapsible collapsed',
        ),
        MultiFieldPanel(
            [
                FieldPanel('location_name'),
                FieldPanel('location_address1'),
                FieldPanel('location_address2'),
                FieldPanel('location_city'),
                FieldPanel('location_province'),
                FieldPanel('location_postal_code'),
                FieldPanel('location_country'),
            ],
            heading='Location',
            classname='collapsible collapsed',
        ),
        MultiFieldPanel(
            [
                FieldPanel('embed_youtube'),
                FieldPanel('related_files'),
            ],
            heading='Media',
            classname='collapsible collapsed',
        ),
        MultiFieldPanel(
            [
                FieldPanel('twitter_hashtag'),
                FieldPanel('flickr_album_url'),
            ],
            heading='Event Social Media',
            classname='collapsible collapsed',
        ),
        ContentPage.recommended_panel,
        MultiFieldPanel(
            [
                FieldPanel('topics'),
                FieldPanel('projects'),
                FieldPanel('countries'),
                PageChooserPanel(
                    'multimedia_page',
                    ['multimedia.MultimediaPage'],
                ),
            ],
            heading='Related',
            classname='collapsible collapsed',
        ),
    ]
    promote_panels = Page.promote_panels + [
        FeatureablePageAbstract.feature_panel,
        ShareablePageAbstract.social_panel,
        SearchablePageAbstract.search_panel,
    ]
    settings_panels = Page.settings_panels + [
        ThemeablePageAbstract.theme_panel,
    ]

    search_fields = BasicPageAbstract.search_fields \
        + ContentPage.search_fields \
        + [
            index.FilterField('publishing_date'),
            index.FilterField('event_access'),
        ]

    parent_page_types = ['events.EventListPage']
    subpage_types = []
    templates = 'events/event_page.html'

    class Meta:
        verbose_name = 'Event'
        verbose_name_plural = 'Events'

1	from core.models import (
2	BasicPageAbstract,
3	ContentPage,
4	FeatureablePageAbstract,
5	SearchablePageAbstract,
6	ShareablePageAbstract,
7	ThemeablePageAbstract
8	)
9	from django.db import models	2✔
10	from modelcluster.fields import ParentalKey	2✔
11	from wagtail.admin.panels import (	2✔
12	FieldPanel,
13	InlinePanel,
14	MultiFieldPanel,
15	PageChooserPanel,
16	)
17	from wagtail.fields import RichTextField, StreamField	2✔
18	from wagtail.models import Orderable, Page	2✔
19	from wagtail.documents.blocks import DocumentChooserBlock	2✔
20	from django.utils import timezone	2✔
21	from wagtail.search import index	2✔
22	import pytz	2✔
23	import re	2✔
24	import urllib.parse	2✔
25
26
27	class EventListPage(BasicPageAbstract, SearchablePageAbstract, Page):	2✔
28	max_count = 1	2✔
29	parent_page_types = ['home.HomePage']	2✔
30	subpage_types = ['events.EventPage']	2✔
31	templates = 'events/event_list_page.html'	2✔
32
33	content_panels = [	2✔
34	BasicPageAbstract.title_panel,
35	BasicPageAbstract.hero_link_panel,
36	BasicPageAbstract.body_panel,
37	BasicPageAbstract.images_panel,
38	MultiFieldPanel(
39	[
40	InlinePanel(
41	'featured_events',
42	max_num=6,
43	min_num=0,
44	label='Event',
45	),
46	],
47	heading='Featured Events',
48	classname='collapsible collapsed',
49	),
50	]
51	settings_panels = Page.settings_panels + [	2✔
52	BasicPageAbstract.submenu_panel,
53	]
54
55	search_fields = Page.search_fields + BasicPageAbstract.search_fields + SearchablePageAbstract.search_fields	2✔
56
57	def get_featured_events(self):	2✔
58	featured_event_ids = self.featured_events.order_by('sort_order').values_list('event_page', flat=True)[:6]	×
59	pages = Page.objects.specific().prefetch_related(	×
60	'topics',
61	).in_bulk(featured_event_ids)
62	return [pages[x] for x in featured_event_ids]	×
63
64	def get_featured_events_preview(self):	2✔
65	featured_events = self.featured_events.order_by('sort_order')	×
66	featured_event_ids = [x.event_page.id for x in featured_events]	×
67	pages = Page.objects.specific().prefetch_related(	×
68	'topics',
69	).in_bulk(featured_event_ids)
70	return [pages[x] for x in featured_event_ids]	×
71
72	def get_context(self, request):	2✔
73	context = super().get_context(request)	×
74	if hasattr(context['request'], 'is_preview'):	×
75	if context['request'].is_preview:	×
76	context['featured_events'] = self.get_featured_events_preview()	×
77	else:
78	context['featured_events'] = self.get_featured_events()	×
79	else:
NEW 80	context['featured_events'] = self.get_featured_events()	×
UNCOV 81	return context	×
82
83	class Meta:	2✔
84	verbose_name = 'Event List Page'	2✔
85
86
87	class EventListPageFeaturedEvent(Orderable):	2✔
88	event_list_page = ParentalKey(	2✔
89	'events.EventListPage',
90	related_name='featured_events',
91	)
92	event_page = models.ForeignKey(	2✔
93	'wagtailcore.Page',
94	null=False,
95	blank=False,
96	on_delete=models.CASCADE,
97	related_name='+',
98	verbose_name='Event',
99	)
100
101	panels = [	2✔
102	PageChooserPanel(
103	'event_page',
104	['events.EventPage'],
105	),
106	]
107
108
109	class EventPage(	2✔
110	BasicPageAbstract,
111	ContentPage,
112	FeatureablePageAbstract,
113	ShareablePageAbstract,
114	ThemeablePageAbstract,
115	):
116	class EventAccessOptions(models.IntegerChoices):	2✔
117	PRIVATE = (0, 'Private')	2✔
118	PUBLIC = (1, 'Public')	2✔
119
120	class EventFormats(models.TextChoices):	2✔
121	HYBRID = ('hybrid', 'Hybrid')	2✔
122	VIRTUAL = ('virtual', 'Virtual')	2✔
123	IN_PERSON = ('in-person', 'In Person')	2✔
124
125	class EventTypes(models.TextChoices):	2✔
126	CIGI_SPONSORED = ('cigi_sponsored', 'CIGI Sponsored')	2✔
127	CINEMA_SERIES = ('cinema_series', 'Cinema Series')	2✔
128	COMMUNITY_EVENT = ('community_event', 'Community Event')	2✔
129	CONFERENCE = ('conference', 'Conference')	2✔
130	GLOBAL_POLICY_FORUM = ('global_policy_forum', 'Global Policy Forum')	2✔
131	NOON_LECTURE_SERIES = ('noon_lecture_series', 'Noon Lecture Series')	2✔
132	PANEL_DISCUSSION = ('panel_discussion', 'Panel Discussion')	2✔
133	PUBLICATION_LAUNCH = ('publication_launch', 'Publication Launch')	2✔
134	ROUNDTABLE = ('roundtable', 'Round Table')	2✔
135	SEMINAR = ('seminar', 'Seminar')	2✔
136	SIGNATURE_LECTURE = ('signature_lecture', 'Signature Lecture')	2✔
137	VIRTUAL_EVENT = ('virtual_event', 'Virtual Event')	2✔
138	WORKSHOP = ('workshop', 'Workshop')	2✔
139
140	class InvitationTypes(models.IntegerChoices):	2✔
141	RSVP_REQUIRED = (0, 'RSVP Required')	2✔
142	INVITATION_ONLY = (1, 'Invitation Only')	2✔
143	NO_RSVP = (2, 'No RSVP Required')	2✔
144
145	class EventTimeZones(models.TextChoices):	2✔
146	HAWAII = ('US/Hawaii', '(UTC–10:00) Hawaiian Time')	2✔
147	LOS_ANGELES = ('America/Los_Angeles', '(UTC–08:00/09:00) Pacific Time')	2✔
148	DENVER = ('America/Denver', '(UTC–06:00/07:00) Mountain Time')	2✔
149	CHICAGO = ('America/Chicago', '(UTC–05:00/06:00) Central Time')	2✔
150	TORONTO = ('America/Toronto', '(UTC–04:00/05:00) Eastern Time')	2✔
151	CARACAS = ('America/Caracas', '(UTC–04:30) Venezuela Time')	2✔
152	HALIFAX = ('America/Halifax', '(UTC–03:00/04:00) Atlantic Time')	2✔
153	SAO_PAULO = ('America/Sao_Paulo', '(UTC–03:00) E. South America Time')	2✔
154	CAPE_VERDE = ('Atlantic/Cape_Verde', '(UTC–01:00) Cape Verde Time')	2✔
155	LONDON = ('Europe/London', '(UTC+00:00/01:00) GMT/BST')	2✔
156	BERLIN = ('Europe/Berlin', '(UTC+01:00/02:00) Central European Time')	2✔
157	BEIRUT = ('Asia/Beirut', '(UTC+02:00/03:00) Eastern European Time')	2✔
158	MOSCOW = ('Europe/Moscow', '(UTC+03:00) Russian Time')	2✔
159	TEHRAN = ('Asia/Tehran', '(UTC+02:30/03:30) Iran Time')	2✔
160	DUBAI = ('Asia/Dubai', '(UTC+04:00) Arabian Time')	2✔
161	KABUL = ('Asia/Kabul', '(UTC+04:30) Afghanistan Time')	2✔
162	ASHGABAT = ('Asia/Ashgabat', '(UTC+05:00) West Asia Time')	2✔
163	KOLKATA = ('Asia/Kolkata', '(UTC+05:30) India Time')	2✔
164	KATHMANDU = ('Asia/Kathmandu', '(UTC+05:45) Nepal Time')	2✔
165	YANGON = ('Asia/Yangon', '(UTC+06:30) Myanmar Time')	2✔
166	BANGKOK = ('Asia/Bangkok', '(UTC+07:00) SE Asia Time')	2✔
167	SHANGHAI = ('Asia/Shanghai', '(UTC+08:00) China Time')	2✔
168	TOKYO = ('Asia/Tokyo', '(UTC+09:00) Tokyo Time')	2✔
169	SYDNEY = ('Australia/Sydney', '(UTC+10:00/11:00) AUS Eastern Time')	2✔
170	AUCKLAND = ('Pacific/Auckland', '(UTC+12:00/13:00) New Zealand Time')	2✔
171
172	embed_youtube = models.URLField(blank=True)	2✔
173	event_access = models.IntegerField(choices=EventAccessOptions.choices, default=EventAccessOptions.PUBLIC, null=True, blank=False)	2✔
174	event_end = models.DateTimeField(blank=True, null=True)	2✔
175	event_format = models.CharField(	2✔
176	blank=False,
177	max_length=32,
178	null=True,
179	choices=EventFormats.choices,
180	)
181	event_type = models.CharField(	2✔
182	blank=False,
183	max_length=32,
184	null=True,
185	choices=EventTypes.choices,
186	)
187	flickr_album_url = models.URLField(blank=True)	2✔
188	invitation_type = models.IntegerField(choices=InvitationTypes.choices, default=InvitationTypes.RSVP_REQUIRED)	2✔
189	location_address1 = models.CharField(blank=True, max_length=255, verbose_name='Address (Line 1)')	2✔
190	location_address2 = models.CharField(blank=True, max_length=255, verbose_name='Address (Line 2)')	2✔
191	location_city = models.CharField(blank=True, max_length=255, verbose_name='City')	2✔
192	location_country = models.CharField(blank=True, max_length=255, verbose_name='Country')	2✔
193	location_name = models.CharField(blank=True, max_length=255)	2✔
194	location_postal_code = models.CharField(blank=True, max_length=32, verbose_name='Postal Code')	2✔
195	location_province = models.CharField(blank=True, max_length=255, verbose_name='Province/State')	2✔
196	multimedia_page = models.ForeignKey(	2✔
197	'wagtailcore.Page',
198	null=True,
199	blank=True,
200	on_delete=models.SET_NULL,
201	related_name='+',
202	verbose_name='Multimedia',
203	)
204	registration_url = models.URLField(blank=True, max_length=512)	2✔
205	related_files = StreamField(	2✔
206	[
207	('file', DocumentChooserBlock()),
208	],
209	blank=True,
210	use_json_field=True,
211	)
212	short_description = RichTextField(	2✔
213	blank=True,
214	null=False,
215	features=['bold', 'italic', 'link'],
216	)
217	time_zone = models.CharField(	2✔
218	blank=True,
219	max_length=64,
220	choices=EventTimeZones.choices,
221	default=EventTimeZones.TORONTO,
222	)
223	twitter_hashtag = models.CharField(blank=True, max_length=64)	2✔
224	website_button_text = models.CharField(	2✔
225	blank=True,
226	max_length=64,
227	help_text='Override the button text for the event website. If empty, the button will read "Event Website".'
228	)
229	website_url = models.URLField(blank=True, max_length=512)	2✔
230
231	# Reference field for the Drupal-Wagtail migrator. Can be removed after.
232	drupal_node_id = models.IntegerField(blank=True, null=True)	2✔
233
234	def location_string(self):	2✔
235	# Show event format if it is not virtual only
236	if self.event_format in [self.EventFormats.HYBRID, self.EventFormats.IN_PERSON]:	×
237	location_strings = [	×
238	self.location_address1,
239	self.location_address2,
240	self.location_city,
241	self.location_province,
242	self.location_postal_code,
243	self.location_country
244	]
245	return ', '.join([x for x in location_strings if x])	×
246	return ''	×
247
248	def location_map_url(self):	2✔
249	return f'https://www.google.com/maps/search/?api=1&query={urllib.parse.quote(self.location_string())}'	×
250
251	def event_format_string(self):	2✔
252	return self.get_event_format_display()	×
253
254	@property	2✔
255	def multimedia_url(self):	2✔
256	if self.multimedia_page:	×
257	return self.multimedia_page.url	×
258	return ''	×
259
260	def is_past(self):	2✔
261	now = timezone.now()	×
262	if self.event_end:	×
263	return self.event_end < now	×
264	else:
265	return self.publishing_date < now	×
266
267	@property	2✔
268	def event_start_time_utc(self):	2✔
269	'''
270	returns UTC datetime object
271	- The datetime value entered in EventPage is currently assumed tzinfo="America/Toronto",
272	regardless of the "time_zone" field specified; eg. "07:00:00AM America/Los_Angelos"
273	- This is then converted to UTC and stored as "publishing_date"; eg. "11:00:00 (during daylight saving)."
274	- So to allow specifying different timezones for the "time_zone" field, we need to first
275	convert "publishing_date" from UTC back to "America/Toronto", then replace tzinfo with "time_zone"
276	- If in the future, "publishing_date" is fixed to have user-specified timezone instead,
277	this conversion and replacement would be unnecessary (and incorrect);
278	can pass `return item.publishing_date` instead
279	- This applies to item.event_end as well
280	'''
281	if self.time_zone == '' or not self.time_zone:	×
282	return self.publishing_date	×
283	else:
284	default_tz = pytz.timezone('America/Toronto')	×
285	correct_tz = pytz.timezone(self.time_zone)	×
286	return pytz.utc.normalize(	×
287	correct_tz.localize(
288	self.publishing_date.astimezone(default_tz).replace(tzinfo=None)
289	)
290	)
291
292	@property	2✔
293	def event_end_time_utc(self):	2✔
294	if self.time_zone == '' or not self.time_zone:	×
295	return self.event_end	×
296	else:
297	default_tz = pytz.timezone('America/Toronto')	×
298	correct_tz = pytz.timezone(self.time_zone)	×
299	return pytz.utc.normalize(	×
300	correct_tz.localize(
301	self.event_end.astimezone(default_tz).replace(tzinfo=None)
302	)
303	)
304
305	@property	2✔
306	def time_zone_label(self):	2✔
307	# timezone could have been assigned in freeform (previous version), or from a list of options (post change)
308	# if it's from a list of options post change:
309	if self.time_zone in self.EventTimeZones.values:	×
310	'''
311	timezone name set to short code based on self.time_zone value; in case no name is available,
312	"%Z" returns offset: (eg "+0430" for Iran Time, together with offset this becomes "+0430 (UTC+0430)");
313	use regex matching to remove the short code and only display offset in this case.
314	'''
315	tz = re.sub(r'[-+]\d{2,4} ',	×
316	'',
317	f'{self.event_start_time_utc.astimezone(pytz.timezone(self.time_zone)).strftime("%Z")} ')
318	offset = self.event_start_time_utc.astimezone(pytz.timezone(self.time_zone)).strftime('%z')	×
319	# return string format: "TZ (OFFSET)"" eg. "EDT (UTC-04:00)"
320	label = f'{tz}(UTC{offset[:3].replace("-", "–")}:{offset[3:]})'	×
321	# if it's not assigned: default to eastern
322	elif not self.time_zone:	×
323	tz_and_offset = self.event_start_time_utc.astimezone(pytz.timezone('America/Toronto')).strftime('%Z%z')	×
324	label = f'{tz_and_offset[:3]} (UTC{tz_and_offset[3:6].replace("-", "–")}:{tz_and_offset[6:]})'	×
325	# if it was assigned in freeform - preserve
326	else:
327	label = self.time_zone	×
328	return label	×
329
330	def get_context(self, request):	2✔
331	context = super().get_context(request)	×
332	context['location_string'] = self.location_string()	×
333	context['event_format_string'] = self.get_event_format_display()	×
334	context['location_map_url'] = self.location_map_url()	×
335	return context	×
336
337	def get_template(self, request, args, *kwargs):	2✔
338	standard_template = super(EventPage, self).get_template(request, args, *kwargs)	×
339	if self.theme:	×
340	return f'themes/{self.get_theme_dir()}/event_page.html'	×
341	return standard_template	×
342
343	content_panels = [	2✔
344	BasicPageAbstract.title_panel,
345	MultiFieldPanel(
346	[
347	FieldPanel('short_description'),
348	FieldPanel('body'),
349	],
350	heading='Body',
351	classname='collapsible collapsed'
352	),
353	BasicPageAbstract.images_panel,
354	FieldPanel('publishing_date', heading='Event start'),
355	FieldPanel('event_end'),
356	FieldPanel('time_zone'),
357	MultiFieldPanel(
358	[
359	FieldPanel('event_format'),
360	FieldPanel('event_type'),
361	FieldPanel('event_access'),
362	FieldPanel('invitation_type'),
363	FieldPanel('website_url'),
364	FieldPanel('website_button_text'),
365	FieldPanel('registration_url'),
366	],
367	heading='Event Details',
368	classname='collapsible collapsed',
369	),
370	MultiFieldPanel(
371	[
372	InlinePanel('authors'),
373	],
374	heading='Speakers',
375	classname='collapsible collapsed',
376	),
377	MultiFieldPanel(
378	[
379	FieldPanel('location_name'),
380	FieldPanel('location_address1'),
381	FieldPanel('location_address2'),
382	FieldPanel('location_city'),
383	FieldPanel('location_province'),
384	FieldPanel('location_postal_code'),
385	FieldPanel('location_country'),
386	],
387	heading='Location',
388	classname='collapsible collapsed',
389	),
390	MultiFieldPanel(
391	[
392	FieldPanel('embed_youtube'),
393	FieldPanel('related_files'),
394	],
395	heading='Media',
396	classname='collapsible collapsed',
397	),
398	MultiFieldPanel(
399	[
400	FieldPanel('twitter_hashtag'),
401	FieldPanel('flickr_album_url'),
402	],
403	heading='Event Social Media',
404	classname='collapsible collapsed',
405	),
406	ContentPage.recommended_panel,
407	MultiFieldPanel(
408	[
409	FieldPanel('topics'),
410	FieldPanel('projects'),
411	FieldPanel('countries'),
412	PageChooserPanel(
413	'multimedia_page',
414	['multimedia.MultimediaPage'],
415	),
416	],
417	heading='Related',
418	classname='collapsible collapsed',
419	),
420	]
421	promote_panels = Page.promote_panels + [	2✔
422	FeatureablePageAbstract.feature_panel,
423	ShareablePageAbstract.social_panel,
424	SearchablePageAbstract.search_panel,
425	]
426	settings_panels = Page.settings_panels + [	2✔
427	ThemeablePageAbstract.theme_panel,
428	]
429
430	search_fields = BasicPageAbstract.search_fields \	2✔
431	+ ContentPage.search_fields \
432	+ [
433	index.FilterField('publishing_date'),
434	index.FilterField('event_access'),
435	]
436
437	parent_page_types = ['events.EventListPage']	2✔
438	subpage_types = []	2✔
439	templates = 'events/event_page.html'	2✔
440
441	class Meta:	2✔
442	verbose_name = 'Event'	2✔
443	verbose_name_plural = 'Events'	2✔

CIGIHub / cigionline / 11058258525

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous