lucaspalomodevelop/indico-plugins
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/indico-plugins.git synced 2026-03-13 07:29:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

VC/Zoom: Support getting users via authenticators

Browse Source
This commit is contained in:
Adrian Moennich 2020-12-01 18:18:11 +01:00
parent a0bca2e207
commit e2bfceb99a
4 changed files with 107 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
vc_zoom/indico_vc_zoom/forms.py
View File

@ -113,8 +113,7 @@ class VCRoomForm(VCRoomFormBase):
self._check_zoom_user(field.data)
def _check_zoom_user(self, user):
email = find_enterprise_email(user)
if email is None or ZoomIndicoClient().get_user(email, silent=True) is None:
if find_enterprise_email(user) is None:
raise ValidationError(_('This user has no Zoom account'))
def validate_name(self, field):

63
vc_zoom/indico_vc_zoom/plugin.py
View File

@ -8,15 +8,17 @@
from __future__ import unicode_literals
from flask import flash, session
from markupsafe import escape
from requests.exceptions import HTTPError
from sqlalchemy.orm.attributes import flag_modified
from werkzeug.exceptions import Forbidden, NotFound
from wtforms.fields.core import BooleanField
from wtforms.fields import TextAreaField
from wtforms.fields.simple import StringField
from wtforms.validators import DataRequired
from wtforms.validators import DataRequired, ValidationError
from indico.core import signals
from indico.core.auth import multipass
from indico.core.plugins import IndicoPlugin, render_plugin_template, url_for_plugin
from indico.modules.events.views import WPSimpleEventDisplay
from indico.modules.vc import VCPluginMixin, VCPluginSettingsFormBase
@ -24,7 +26,8 @@ from indico.modules.vc.exceptions import VCRoomError
from indico.modules.vc.models.vc_rooms import VCRoom
from indico.modules.vc.views import WPVCEventPage, WPVCManageEvent
from indico.util.user import principal_from_identifier
from indico.web.forms.fields.simple import IndicoPasswordField
from indico.web.forms.fields import IndicoEnumSelectField, IndicoPasswordField, TextListField
from indico.web.forms.validators import HiddenUnless
from indico.web.forms.widgets import CKEditorWidget, SwitchWidget
from indico_vc_zoom import _
@ -33,14 +36,15 @@ from indico_vc_zoom.blueprint import blueprint
from indico_vc_zoom.cli import cli
from indico_vc_zoom.forms import VCRoomAttachForm, VCRoomForm
from indico_vc_zoom.notifications import notify_new_host, notify_host_start_url
from indico_vc_zoom.util import (fetch_zoom_meeting, find_enterprise_email, gen_random_password, get_schedule_args,
get_url_data_args, update_zoom_meeting, ZoomMeetingType)
from indico_vc_zoom.util import (UserLookupMode, fetch_zoom_meeting, find_enterprise_email, gen_random_password,
get_schedule_args, get_url_data_args, update_zoom_meeting, ZoomMeetingType)
class PluginSettingsForm(VCPluginSettingsFormBase):
_fieldsets = [
('API Credentials', ['api_key', 'api_secret', 'webhook_token']),
('Zoom Account', ['email_domains', 'assistant_id', 'allow_webinars']),
('Zoom Account', ['user_lookup_mode', 'email_domains', 'authenticators', 'enterprise_domain', 'assistant_id',
'allow_webinars']),
('Room Settings', ['mute_audio', 'mute_host_video', 'mute_participant_video', 'join_before_host',
'waiting_room']),
('Notifications', ['creation_email_footer', 'send_host_url'])
@ -53,8 +57,27 @@ class PluginSettingsForm(VCPluginSettingsFormBase):
webhook_token = IndicoPasswordField(_('Webhook Token'), toggle=True,
description=_("Specify Zoom's webhook token if you want live updates"))
email_domains = StringField(_('E-mail domains'), [DataRequired()],
description=_('Comma-separated list of e-mail domains which can use the Zoom API.'))
user_lookup_mode = IndicoEnumSelectField(_('User lookup mode'), [DataRequired()], enum=UserLookupMode,
description=_('Specify how Indico should look up the zoom user that '
'corresponds to an Indico user.'))
email_domains = TextListField(_('E-mail domains'),
[HiddenUnless('user_lookup_mode', UserLookupMode.email_domains), DataRequired()],
description=_('List of e-mail domains which can use the Zoom API. Indico attempts '
'to find Zoom accounts using all email addresses of a user which use '
'those domains.'))
authenticators = TextListField(_('Indico identity providers'),
[HiddenUnless('user_lookup_mode', UserLookupMode.authenticators), DataRequired()],
description=_('Identity providers from which to get usernames. '
'Indico queries those providers using the email addresses of the user '
'and attempts to find Zoom accounts having an email address looking '
'like <username>@<enterprise-domain>.'))
enterprise_domain = StringField(_('Enterprise domain'),
[HiddenUnless('user_lookup_mode', UserLookupMode.authenticators), DataRequired()],
description=_('The domain name used together with the usernames from the Indico '
'identity provider'))
assistant_id = StringField(_('Assistant Zoom ID'), [DataRequired()],
description=_('Account to be used as owner of all rooms. It will get "assistant" '
@ -93,6 +116,11 @@ class PluginSettingsForm(VCPluginSettingsFormBase):
description=_('Whether to send an e-mail with the Host URL to the meeting host upon '
'creation of a meeting'))
def validate_authenticators(self, field):
invalid = set(field.data) - set(multipass.identity_providers)
if invalid:
raise ValidationError(_('Invalid identity providers: {}').format(escape(', '.join(invalid))))
class ZoomPlugin(VCPluginMixin, IndicoPlugin):
"""Zoom
@ -109,7 +137,10 @@ class ZoomPlugin(VCPluginMixin, IndicoPlugin):
'api_key': '',
'api_secret': '',
'webhook_token': '',
'email_domains': '',
'user_lookup_mode': UserLookupMode.email_domains,
'email_domains': [],
'authenticators': [],
'enterprise_domain': '',
'allow_webinars': False,
'mute_host_video': True,
'mute_audio': True,
@ -334,12 +365,16 @@ class ZoomPlugin(VCPluginMixin, IndicoPlugin):
if not email:
raise Forbidden(_("This user doesn't seem to have an associated Zoom account"))
if is_webinar:
changes.setdefault('settings', {})['alternative_hosts'] = email
else:
changes['schedule_for'] = email
self._check_indico_is_assistant(email)
notify_new_host(session.user, vc_room)
# When using authenticator mode for user lookups, the email address used on zoom
# may not be an email address the Indico user has, so we can only check if the host
# really changed after checking for the zoom account.
if host_data['email'] != email:
if is_webinar:
changes.setdefault('settings', {})['alternative_hosts'] = email
else:
changes['schedule_for'] = email
self._check_indico_is_assistant(email)
notify_new_host(session.user, vc_room)
if vc_room.name != zoom_meeting['topic']:
changes['topic'] = vc_room.name

70
vc_zoom/indico_vc_zoom/util.py
View File

@ -16,14 +16,15 @@ from indico.core.db import db
from indico.modules.users.models.emails import UserEmail
from indico.modules.users.models.users import User
from indico.modules.vc.exceptions import VCRoomError, VCRoomNotFoundError
from indico.util.caching import memoize_request
from indico.util.date_time import now_utc
from indico.util.struct.enum import RichIntEnum
from indico.util.struct.enum import IndicoEnum, RichEnum
from indico_vc_zoom import _
from indico_vc_zoom.api import ZoomIndicoClient
class ZoomMeetingType(RichIntEnum):
class ZoomMeetingType(int, IndicoEnum):
instant_meeting = 1
scheduled_meeting = 2
recurring_meeting_no_time = 3
@ -33,22 +34,63 @@ class ZoomMeetingType(RichIntEnum):
recurring_meeting_fixed_time = 9
def find_enterprise_email(user):
"""Find a user's first e-mail address which can be used by the Zoom API.
class UserLookupMode(unicode, RichEnum):
__titles__ = {
'email_domains': _('Email domains'),
'authenticators': _('Authenticators'),
}
@property
def title(self):
return RichEnum.title.__get__(self, type(self))
email_domains = 'email_domains'
authenticators = 'authenticators'
def _iter_user_identifiers(user):
"""Iterates over all existing user identifiers that can be used with Zoom"""
from indico_vc_zoom.plugin import ZoomPlugin
done = set()
for provider in ZoomPlugin.settings.get('authenticators'):
for __, identifier in user.iter_identifiers(check_providers=True, providers={provider}):
if identifier in done:
continue
done.add(identifier)
yield identifier
def _iter_user_emails(user):
"""Yield all emails of a user that may work with zoom.
:param user: the `User` in question
:return: the e-mail address if it exists, otherwise `None`
"""
from indico_vc_zoom.plugin import ZoomPlugin
domains = [domain.strip() for domain in ZoomPlugin.settings.get('email_domains').split(',')]
# get all matching e-mails, primary first
result = UserEmail.query.filter(
UserEmail.user == user,
~User.is_blocked,
~User.is_deleted,
db.or_(UserEmail.email.endswith(domain) for domain in domains)
).join(User).order_by(UserEmail.is_primary.desc()).first()
return result.email if result else None
mode = ZoomPlugin.settings.get('user_lookup_mode')
if mode == UserLookupMode.email_domains:
domains = ZoomPlugin.settings.get('email_domains')
if not domains:
return
# get all matching e-mails, primary first
query = UserEmail.query.filter(
UserEmail.user == user,
~User.is_blocked,
~User.is_deleted,
db.or_(UserEmail.email.endswith('@{}'.format(domain)) for domain in domains)
).join(User).order_by(UserEmail.is_primary.desc())
for entry in query:
yield entry.email
elif mode == UserLookupMode.authenticators:
domain = ZoomPlugin.settings.get('enterprise_domain')
for username in _iter_user_identifiers(user):
yield '{}@{}'.format(username, domain)
@memoize_request
def find_enterprise_email(user):
"""Get the email address of a user that has a zoom account."""
client = ZoomIndicoClient()
return next((email for email in _iter_user_emails(user) if client.get_user(email, silent=True)), None)
def gen_random_password():

1
vc_zoom/tests/operation_test.py
View File

@ -107,6 +107,7 @@ def test_room_creation(create_meeting, zoom_api):
def test_host_change(create_user, mocker, create_meeting, zoom_plugin, zoom_api, request_context):
mocker.patch('indico_vc_zoom.plugin.find_enterprise_email', return_value='joe.bidon@megacorp.xyz')
notify_new_host = mocker.patch('indico_vc_zoom.plugin.notify_new_host')
create_user(2, email='joe.bidon@megacorp.xyz')