Merged in [19917] and [19930] from jennifer@painless-security.com:

    Create/delete Meetecho conferences when requesting/canceling interim sessions. Fixes ietf-tools#3507. Fixes ietf-tools#3508.
 - Legacy-Id: 19934
Note: SVN reference [19917] has been migrated to Git commit 81cd64d

Note: SVN reference [19930] has been migrated to Git commit c64297e

Author: rjsparks

ietf/meeting/forms.py

@@ -16,6 +16,7 @@
 from django.core.exceptions import ValidationError
 from django.db.models import Q
 from django.forms import BaseInlineFormSet
+from django.utils.functional import cached_property
 
 import debug                            # pyflakes:ignore
 
@@ -207,7 +208,8 @@ class InterimSessionModelForm(forms.ModelForm):
     time = forms.TimeField(widget=forms.TimeInput(format='%H:%M'), required=True)
     requested_duration = CustomDurationField(required=True)
     end_time = forms.TimeField(required=False)
-    remote_instructions = forms.CharField(max_length=1024, required=True)
+    remote_participation = forms.ChoiceField(choices=(), required=False)
+    remote_instructions = forms.CharField(max_length=1024, required=False)
     agenda = forms.CharField(required=False, widget=forms.Textarea, strip=False)
     agenda_note = forms.CharField(max_length=255, required=False)
 
@@ -233,7 +235,13 @@ def __init__(self, *args, **kwargs):
                 doc = self.instance.agenda()
                 content = doc.text_or_error()
                 self.initial['agenda'] = content
-                
+
+        # set up remote participation choices
+        choices = []
+        if hasattr(settings, 'MEETECHO_API_CONFIG'):
+            choices.append(('meetecho', 'Automatically create Meetecho conference'))
+        choices.append(('manual', 'Manually specify remote instructions...'))
+        self.fields['remote_participation'].choices = choices
 
     def clean_date(self):
         '''Date field validator.  We can't use required on the input because
@@ -251,6 +259,21 @@ def clean_requested_duration(self):
             raise forms.ValidationError('Provide a duration, %s-%smin.' % (min_minutes, max_minutes))
         return duration
 
+    def clean(self):
+        if self.cleaned_data.get('remote_participation', None) == 'meetecho':
+            self.cleaned_data['remote_instructions'] = ''  # blank this out if we're creating a Meetecho conference
+        elif not self.cleaned_data['remote_instructions']:
+            self.add_error('remote_instructions', 'This field is required')
+        return self.cleaned_data
+
+    # Override to ignore the non-model 'remote_participation' field when computing has_changed()
+    @cached_property
+    def changed_data(self):
+        data = super().changed_data
+        if 'remote_participation' in data:
+            data.remove('remote_participation')
+        return data
+
     def save(self, *args, **kwargs):
         """NOTE: as the baseform of an inlineformset self.save(commit=True)
         never gets called"""

ietf/meeting/helpers.py

@@ -12,6 +12,7 @@
 from django.http import Http404
 from django.db.models import F, Prefetch
 from django.conf import settings
+from django.contrib import messages
 from django.contrib.auth.models import AnonymousUser
 from django.urls import reverse
 from django.shortcuts import get_object_or_404
@@ -29,7 +30,7 @@
 from ietf.meeting.models import Meeting, Schedule, TimeSlot, SchedTimeSessAssignment, ImportantDate, SchedulingEvent, Session
 from ietf.meeting.utils import session_requested_by, add_event_info_to_session_qs
 from ietf.name.models import ImportantDateName, SessionPurposeName
-from ietf.utils import log
+from ietf.utils import log, meetecho
 from ietf.utils.history import find_history_replacements_active_at
 from ietf.utils.mail import send_mail
 from ietf.utils.pipe import pipe
@@ -1074,6 +1075,76 @@ def sessions_post_save(request, forms):
         if 'agenda' in form.changed_data:
             form.save_agenda()
 
+        try:
+            create_interim_session_conferences(
+                form.instance for form in forms
+                if form.cleaned_data.get('remote_participation', None) == 'meetecho'
+            )
+        except RuntimeError:
+            messages.warning(
+                request,
+                'An error occurred while creating a Meetecho conference. The interim meeting request '
+                'has been created without complete remote participation information. '
+                'Please edit the request to add this or contact the secretariat if you require assistance.',
+            )
+
+
+def create_interim_session_conferences(sessions):
+    error_occurred = False
+    if hasattr(settings, 'MEETECHO_API_CONFIG'):  # do nothing if not configured
+        meetecho_manager = meetecho.ConferenceManager(settings.MEETECHO_API_CONFIG)
+        for session in sessions:
+            ts = session.official_timeslotassignment().timeslot
+            try:
+                confs = meetecho_manager.create(
+                    group=session.group,
+                    description=str(session),
+                    start_time=ts.time,
+                    duration=ts.duration,
+                )
+            except Exception as err:
+                log.log(f'Exception creating Meetecho conference for {session}: {err}')
+                confs = []
+
+            if len(confs) == 1:
+                session.remote_instructions = confs[0].url
+                session.save()
+            else:
+                error_occurred = True
+    if error_occurred:
+        raise RuntimeError('error creating meetecho conferences')
+
+
+def delete_interim_session_conferences(sessions):
+    """Delete Meetecho conference for the session, if any"""
+    if hasattr(settings, 'MEETECHO_API_CONFIG'):  # do nothing if Meetecho API not configured
+        meetecho_manager = meetecho.ConferenceManager(settings.MEETECHO_API_CONFIG)
+        for session in sessions:
+            if session.remote_instructions:
+                for conference in meetecho_manager.fetch(session.group):
+                    if conference.url == session.remote_instructions:
+                        conference.delete()
+                        break
+
+
+def sessions_post_cancel(request, sessions):
+    """Clean up after session cancellation
+
+    When this is called, the session has already been canceled, so exceptions should
+    not be raised.
+    """
+    try:
+        delete_interim_session_conferences(sessions)
+    except Exception as err:
+        sess_pks = ', '.join(str(s.pk) for s in sessions)
+        log.log(f'Exception deleting Meetecho conferences for sessions [{sess_pks}]: {err}')
+        messages.warning(
+            request,
+            'An error occurred while cleaning up Meetecho conferences for the canceled sessions. '
+            'The session or sessions have been canceled, but Meetecho conferences may not have been cleaned '
+            'up properly.',
+        )
+
 
 def update_interim_session_assignment(form):
     """Helper function to create / update timeslot assigned to interim session"""

ietf/meeting/management/commands/meetecho_conferences.py

@@ -0,0 +1,91 @@
+# Copyright The IETF Trust 2022, All Rights Reserved
+# -*- coding: utf-8 -*-
+import datetime
+
+from textwrap import dedent
+
+from django.conf import settings
+from django.core.management.base import BaseCommand, CommandError
+
+from ietf.meeting.models import Session
+from ietf.utils.meetecho import ConferenceManager, MeetechoAPIError
+
+
+class Command(BaseCommand):
+    help = 'Manage Meetecho conferences'
+    
+    def add_arguments(self, parser) -> None:
+        parser.add_argument('group', type=str)
+        parser.add_argument('-d', '--delete', type=int, action='append',
+                            metavar='SESSION_PK',
+                            help='Delete the conference associated with the specified Session')
+    
+    def handle(self, group, delete, *args, **options):
+        conf_mgr = ConferenceManager(settings.MEETECHO_API_CONFIG)
+        if delete:
+            self.handle_delete_conferences(conf_mgr, group, delete)
+        else:
+            self.handle_list_conferences(conf_mgr, group)
+
+    def handle_list_conferences(self, conf_mgr, group):
+        confs, conf_sessions = self.fetch_conferences(conf_mgr, group)
+        self.stdout.write(f'Meetecho conferences for {group}:\n\n')
+        for conf in confs:
+            sessions_desc = ', '.join(str(s.pk) for s in conf_sessions[conf.id]) or None
+            self.stdout.write(
+                dedent(f'''\
+                * {conf.description}
+                    Start time: {conf.start_time} 
+                    Duration: {int(conf.duration.total_seconds() // 60)} minutes
+                    URL: {conf.url}
+                    Associated session PKs: {sessions_desc}
+                
+                ''')
+            )
+
+    def handle_delete_conferences(self, conf_mgr, group, session_pks_to_delete):
+        sessions_to_delete = Session.objects.filter(pk__in=session_pks_to_delete)
+        confs, conf_sessions = self.fetch_conferences(conf_mgr, group)
+        confs_to_delete = []
+        descriptions = []
+        for session in sessions_to_delete:
+            for conf in confs:
+                associated = conf_sessions[conf.id]
+                if session in associated:
+                    confs_to_delete.append(conf)
+                    sessions_desc = ', '.join(str(s.pk) for s in associated) or None
+                    descriptions.append(
+                        f'{conf.description} ({conf.start_time}, {int(conf.duration.total_seconds() // 60)} mins) - used by {sessions_desc}'
+                    )
+        if len(confs_to_delete) > 0:
+            self.stdout.write('Will delete:')
+            for desc in descriptions:
+                self.stdout.write(f'* {desc}')
+
+            try:
+                proceed = input('Proceed [y/N]? ').lower()
+            except EOFError:
+                proceed = 'n'
+            if proceed in ['y', 'yes']:
+                for conf, desc in zip(confs_to_delete, descriptions):
+                    conf.delete()
+                    self.stdout.write(f'Deleted {desc}')
+            else:
+                self.stdout.write('Nothing deleted.')
+        else:
+            self.stdout.write('No associated Meetecho conferences found')
+
+    def fetch_conferences(self, conf_mgr, group):
+        try:
+            confs = conf_mgr.fetch(group)
+        except MeetechoAPIError as err:
+            raise CommandError('API error fetching Meetecho conference data') from err
+
+        conf_sessions = {}
+        for conf in confs:
+            conf_sessions[conf.id] = Session.objects.filter(
+                group__acronym=group,
+                meeting__date__gte=datetime.date.today(),
+                remote_instructions__contains=conf.url,
+            )
+        return confs, conf_sessions

ietf/meeting/tests_forms.py

@@ -1,10 +1,11 @@
 # Copyright The IETF Trust 2021, All Rights Reserved
 # -*- coding: utf-8 -*-
 """Tests of forms in the Meeting application"""
+from django.conf import settings
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import override_settings
 
-from ietf.meeting.forms import FileUploadForm, ApplyToAllFileUploadForm
+from ietf.meeting.forms import FileUploadForm, ApplyToAllFileUploadForm, InterimSessionModelForm
 from ietf.utils.test_utils import TestCase
 
 
@@ -102,3 +103,19 @@ def test_has_apply_to_all_field_by_default(self):
     def test_no_show_apply_to_all_field(self):
         form = ApplyToAllFileUploadFormTests.TestClass(show_apply_to_all_checkbox=False)
         self.assertNotIn('apply_to_all', form.fields)
+
+
+class InterimSessionModelFormTests(TestCase):
+    @override_settings(MEETECHO_API_CONFIG={})  # setting needs to exist, don't care about its value in this test
+    def test_remote_participation_options(self):
+        """Only offer Meetecho conference creation when configured"""
+        form = InterimSessionModelForm()
+        choice_vals = [choice[0] for choice in form.fields['remote_participation'].choices]
+        self.assertIn('meetecho', choice_vals)
+        self.assertIn('manual', choice_vals)
+
+        del settings.MEETECHO_API_CONFIG
+        form = InterimSessionModelForm()
+        choice_vals = [choice[0] for choice in form.fields['remote_participation'].choices]
+        self.assertNotIn('meetecho', choice_vals)
+        self.assertIn('manual', choice_vals)