feature-9029: Chat rooms: Add info to form and chat options to virtua… (#9048)

Hieu Lam - TMA · web-flow · commit ebc0d5ddf1e4 · 2023-08-11T05:56:57.000+02:00
* feature-9029: Chat rooms: Add info to form and chat options to virtual event room

* feature-9029: Chat rooms: Add info to form and chat options to virtual event room

* feature-9029: Chat rooms: Add info to form and chat options to virtual event room

* feature-9029: Fix bug create room for virtual room

* feature-9029: Fix bug create room for virtual room

* feature-9029: Chat rooms: Add info to form and chat options to virtual event room

* feature-9029: Merge code development
diff --git a/app/api/chat/rocket_chat.py b/app/api/chat/rocket_chat.py
@@ -11,6 +11,7 @@
 from app.models.event import Event
 from app.models.microlocation import Microlocation
 from app.models.user import User
+from app.models.video_stream import VideoStream
 from app.settings import get_settings
 
 logger = logging.getLogger(__name__)
@@ -142,6 +143,53 @@ def get_token(
 
             return self.register(user, event)
 
+    def get_token_virtual_room(
+        self,
+        user: User,
+        event: Optional[Event] = None,
+        retried=False,
+        videoStream: Optional[VideoStream] = None,
+    ):
+        if user.rocket_chat_token:
+            res = requests.post(self.login_url, json=dict(resume=user.rocket_chat_token))
+
+            data = res.json()
+            if res.status_code == 200:
+                if event:
+                    self.add_in_room_virtual_room(
+                        event, data['data']['userId'], videoStream
+                    )
+                return dict(method='resumed', token=user.rocket_chat_token, res=data)
+            elif res.status_code == 401:
+                # Token Expired. Login again
+
+                try:
+                    return self.login(user, event, 'login')
+                except RocketChatException as rce:
+                    if (
+                        not retried
+                        and rce.response is not None
+                        and rce.response.status_code == 401
+                    ):
+                        # Invalid credentials stored. Reset credentials and retry
+                        # If we have already retried, give up
+                        user.rocket_chat_token = None
+                        db.session.add(user)
+                        db.session.commit()
+                        return self.get_token_virtual_room(user, event, retried=True)
+                    else:
+                        raise rce
+            else:
+                # Unhandled Case
+                logger.error('Error while rocket chat resume or login: %s', data)
+                raise RocketChatException(
+                    'Error while resume or logging in', response=res
+                )
+        else:
+            # No token. Try creating profile, else login
+
+            return self.register(user, event)
+
     def check_or_create_bot(self):
         bot_email = 'open-event-bot@open-event.invalid'
         bot_user, _ = get_or_create(
@@ -184,6 +232,40 @@ def create_room(self, event: Event, microlocation: Optional[Microlocation], data
                 db.session.add(event)
             db.session.commit()
 
+    def create_room_virtual_room(
+        self, event: Event, videoStream: Optional[VideoStream], data
+    ):
+        bot_token = data['token']
+        bot_id = data['res']['data']['userId']
+        if videoStream:
+            chat_room_name = videoStream.chat_room_name
+        else:
+            chat_room_name = event.chat_room_name
+
+        res = requests.post(
+            self.api_url + '/api/v1/groups.create',
+            json=dict(
+                name=chat_room_name,
+                members=[bot_id],
+            ),
+            headers={
+                'X-Auth-Token': bot_token,
+                'X-User-Id': bot_id,
+            },
+        )
+        if not res.status_code == 200:
+            logger.error('Error while creating room : %s', res.json())
+            raise RocketChatException('Error while creating room', response=res)
+        else:
+            group_data = res.json()
+            if videoStream:
+                videoStream.chat_room_id = group_data['group']['_id']
+                db.session.add(videoStream)
+            else:
+                event.chat_room_id = group_data['group']['_id']
+                db.session.add(event)
+            db.session.commit()
+
     def add_in_room(
         self, event: Event, rocket_user_id, microlocation: Optional[Microlocation] = None
     ):
@@ -215,6 +297,36 @@ def add_in_room(
             logger.error('Error while adding user : %s', res.json())
             raise RocketChatException('Error while adding user', response=res)
 
+    def add_in_room_virtual_room(
+        self, event: Event, rocket_user_id, videoStream: Optional[VideoStream] = None
+    ):
+        bot = self.check_or_create_bot()
+        data = self.get_token_virtual_room(bot, videoStream=videoStream)
+        if (not event.chat_room_id) or (videoStream and not videoStream.chat_room_id):
+            self.create_room_virtual_room(event=event, videoStream=videoStream, data=data)
+
+        if videoStream is not None:
+            chat_room_id = videoStream.chat_room_id
+        else:
+            chat_room_id = event.chat_room_id
+
+        bot_token = data['token']
+        bot_id = data['res']['data']['userId']
+        room_info = {'roomId': chat_room_id, 'userId': rocket_user_id}
+
+        res = requests.post(
+            self.api_url + '/api/v1/groups.invite',
+            json=room_info,
+            headers={
+                'X-Auth-Token': bot_token,
+                'X-User-Id': bot_id,
+            },
+        )
+
+        if res.status_code != 200:
+            logger.error('Error while adding user : %s', res.json())
+            raise RocketChatException('Error while adding user', response=res)
+
 
 def generate_pass(size=10, chars=string.ascii_lowercase + string.digits):
     return ''.join(random.choice(chars) for _ in range(size))
@@ -235,6 +347,21 @@ def get_rocket_chat_token(
     return rocket_chat.get_token(user, event, microlocation=microlocation)
 
 
+def get_rocket_chat_token_virtual_room(
+    user: User,
+    event: Optional[Event] = None,
+    videoStream: Optional[VideoStream] = None,
+):
+    settings = get_settings()
+    if not (api_url := settings['rocket_chat_url']):
+        raise RocketChatException(
+            'Rocket Chat Integration is not enabled', RocketChatException.CODES.DISABLED
+        )
+
+    rocket_chat = RocketChat(api_url)
+    return rocket_chat.get_token_virtual_room(user, event, videoStream=videoStream)
+
+
 def rename_rocketchat_room(event: Event):
     settings = get_settings()
     if not event.chat_room_id or not (api_url := settings['rocket_chat_url']):
diff --git a/app/api/events.py b/app/api/events.py
@@ -13,7 +13,11 @@
 from sqlalchemy import and_, or_
 
 from app.api.bootstrap import api
-from app.api.chat.rocket_chat import RocketChatException, get_rocket_chat_token
+from app.api.chat.rocket_chat import (
+    RocketChatException,
+    get_rocket_chat_token,
+    get_rocket_chat_token_virtual_room,
+)
 from app.api.data_layers.EventCopyLayer import EventCopyLayer
 from app.api.helpers.db import safe_query, safe_query_kwargs, save_to_db
 from app.api.helpers.errors import (
@@ -162,6 +166,45 @@ def get_room_chat_token(event_id: int, microlocation_id: int):
         )
 
 
+@events_blueprint.route(
+    '/<string:event_identifier>/virtual-room/<int:video_stream_id>/chat-token',
+)
+@jwt_required
+@to_event_id
+def get_virtual_room_chat_token(event_id: int, video_stream_id: int):
+    """
+    Get room chat token for specific room
+    @param event_id: event identifier
+    @param video_stream_id: microlocation id
+    @return: room chat token
+    """
+    event = Event.query.get_or_404(event_id)
+    videoStream = VideoStream.query.get_or_404(video_stream_id)
+
+    if not VideoStream(event_id=event.id).user_can_access:
+        raise NotFoundError({'source': ''}, 'Video Stream Not Found')
+
+    if not event.is_chat_enabled:
+        raise NotFoundError({'source': ''}, 'Chat Not Enabled')
+
+    if not videoStream.is_chat_enabled and not videoStream.is_global_event_room:
+        raise NotFoundError({'source': ''}, 'Chat Not Enabled For This Room')
+
+    try:
+        data = get_rocket_chat_token_virtual_room(current_user, event, videoStream)
+        return jsonify({'success': True, 'token': data['token']})
+    except RocketChatException as rce:
+        if rce.code == RocketChatException.CODES.DISABLED:
+            return jsonify({'success': False, 'code': rce.code})
+        return jsonify(
+            {
+                'success': False,
+                'code': rce.code,
+                'response': rce.response is not None and rce.response.json(),
+            }
+        )
+
+
 def validate_event(user, data):
     if not user.can_create_event():
         raise ForbiddenError({'source': ''}, "Please verify your Email")
diff --git a/app/api/schema/video_stream.py b/app/api/schema/video_stream.py
@@ -47,6 +47,9 @@ class Meta:
     bg_img_url = fields.Str(required=False, allow_none=True)
     additional_information = fields.Str(required=False, allow_none=True)
     extra = fields.Nested(VideoStreamExtraSchema, allow_none=True)
+    is_chat_enabled = fields.Boolean(default=False, allow_none=True)
+    is_global_event_room = fields.Boolean(default=False, allow_none=True)
+    chat_room_name = fields.Str(dump_only=True)
     rooms = Relationship(
         many=True,
         self_view='v1.video_stream_rooms',
diff --git a/app/models/video_stream.py b/app/models/video_stream.py
@@ -1,3 +1,5 @@
+import re
+
 from flask_jwt_extended import current_user
 from sqlalchemy import or_
 from sqlalchemy.orm import backref
@@ -41,6 +43,9 @@ class VideoStream(db.Model):
         db.Integer, db.ForeignKey('video_channels.id', ondelete='CASCADE')
     )
     channel = db.relationship(VideoChannel, backref='streams')
+    is_chat_enabled = db.Column(db.Boolean, default=False, nullable=True)
+    is_global_event_room = db.Column(db.Boolean, default=False, nullable=True)
+    chat_room_id = db.Column(db.String, nullable=True)
 
     def __repr__(self):
         return f'<VideoStream {self.name!r} {self.url!r}>'
@@ -99,3 +104,7 @@ def user_can_access(self):
                 .exists()
             ).scalar()
         )
+
+    @property
+    def chat_room_name(self):
+        return re.sub('[^0-9a-zA-Z!]', '-', self.name) + '-' + str(self.id)
diff --git a/migrations/versions/rev-2023-08-08-16:37:30-c27a61850a11_.py b/migrations/versions/rev-2023-08-08-16:37:30-c27a61850a11_.py
@@ -0,0 +1,31 @@
+"""empty message
+
+Revision ID: c27a61850a11
+Revises: 7e91153d66b0
+Create Date: 2023-08-07 11:37:30.000148
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'c27a61850a11'
+down_revision = '7e91153d66b0'
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('video_streams', sa.Column('is_chat_enabled', sa.Boolean(), nullable=True))
+    op.add_column('video_streams', sa.Column('is_global_event_room', sa.Boolean(), nullable=True))
+    op.add_column('video_streams', sa.Column('chat_room_id', sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('video_streams', 'chat_room_id')
+    op.drop_column('video_streams', 'is_global_event_room')
+    op.drop_column('video_streams', 'is_chat_enabled')
+    # ### end Alembic commands ###
