Added video translation backend (#9018)

* added files for video translation backend

* resolving python errors

* adding docstrings and re-formatting

* marking unused function parameters

* add static method decorators

* modifying static methods

---------

Co-authored-by: Mao Nguyen Minh Tam <[email protected]>
Co-authored-by: Mario Behling <[email protected]>
Co-authored-by: Norbert Preining <[email protected]>

Author: 4 people

app/api/routes.py

@@ -265,6 +265,12 @@
     TrackRelationshipOptional,
     TrackRelationshipRequired,
 )
+from app.api.translation_channels import (
+    TranslationChannelsDetail,
+    TranslationChannelsList,
+    TranslationChannelsListPost,
+    TranslationChannelsRelationship,
+)
 from app.api.user_check_in import (
     UserCheckInDetail,
     UserCheckInList,
@@ -1907,6 +1913,35 @@
 api.route(ImportJobDetail, 'import_job_detail', '/import-jobs/<int:id>')
 
 # Video Streams
+api.route(
+    TranslationChannelsList,
+    'translation_channels_list',
+    "/translation_channels",
+    '/video-streams/<int:video_stream_id>/translation_channels',
+)
+
+api.route(
+    TranslationChannelsListPost, 'translation_channels_list_post', '/translation_channels'
+)
+
+api.route(
+    TranslationChannelsDetail,
+    'translation_channels_detail',
+    '/translation_channels/<int:id>',
+)
+
+api.route(
+    TranslationChannelsRelationship,
+    'translation_channels_video_stream',
+    '/translation_channel/<int:id>/relationships/video-stream',
+)
+
+api.route(
+    TranslationChannelsRelationship,
+    'translation_channels_channel',
+    '/translation_channel/<int:id>/relationships/channels',
+)
+
 api.route(VideoStreamList, 'video_stream_list', '/video-streams')
 api.route(
     VideoStreamDetail,
@@ -1943,6 +1978,8 @@
     'video_stream_moderators',
     '/video-streams/<int:id>/relationships/video-stream-moderators',
 )
+
+
 api.route(
     VideoStreamRelationship,
     'video_stream_recordings',

app/api/schema/translation_channels.py

@@ -0,0 +1,38 @@
+from marshmallow_jsonapi import fields
+from marshmallow_jsonapi.flask import Relationship, Schema
+
+from app.api.helpers.utilities import dasherize
+
+
+class TranslationChannelSchema(Schema):
+    """Schema of Translation Channel objects"""
+
+    id = fields.Integer(dump_only=True)
+    name = fields.String(required=True)
+    url = fields.String(required=True)
+
+    video_stream = Relationship(
+        self_view="v1.translation_channels_video_stream",
+        self_view_kwargs={"id": "<id>"},
+        related_view="v1.video_stream_detail",
+        related_view_kwargs={"id": "<video_stream_id>"},
+        schema="VideoStreamSchema",
+        type_="video_stream",
+    )
+
+    channel = Relationship(
+        self_view="v1.translation_channels_channel",
+        self_view_kwargs={"id": "<id>"},
+        related_view="v1.video_channel_detail",
+        related_view_kwargs={"id": "<channel_id>"},
+        schema="VideoChannelSchema",
+        type_="video_channel",
+    )
+
+    class Meta:
+        type_ = "translation_channel"
+        self_view = 'v1.translation_channels_detail'
+        self_view_kwargs = {'id': '<id>'}
+        self_view_many = 'v1.translation_channels_list'
+        inflect = dasherize
+        strict = True

app/api/schema/video_stream.py

@@ -56,6 +56,7 @@ class Meta:
         schema='MicrolocationSchema',
         type_='microlocation',
     )
+
     event = Relationship(
         self_view='v1.video_stream_event',
         self_view_kwargs={'id': '<id>'},

app/api/translation_channels.py

@@ -0,0 +1,108 @@
+from flask_rest_jsonapi import ResourceDetail, ResourceList, ResourceRelationship
+from flask_rest_jsonapi.exceptions import ObjectNotFound
+
+from app.api.bootstrap import api
+from app.api.helpers.db import safe_query_by_id
+from app.api.helpers.permissions import jwt_required
+from app.api.helpers.utilities import require_relationship
+from app.api.schema.translation_channels import TranslationChannelSchema
+from app.models import db
+from app.models.translation_channels import TranslationChannel
+from app.models.video_channel import VideoChannel
+from app.models.video_stream import VideoStream
+
+
+class TranslationChannelsList(ResourceList):
+    """Get list of Translation Channels"""
+
+    @staticmethod
+    def before_get(kwargs):
+        """Function called when requesting Translation Channels List"""
+        stream_id = kwargs.get("video_stream_id")
+        if stream_id:
+            vid_stream = safe_query_by_id(VideoStream, stream_id)
+            if not vid_stream:
+
+                raise ObjectNotFound(
+                    {'parameter': f'{stream_id}'},
+                    f"video stream not found for id {stream_id}",
+                )
+
+    def query(self, view_kwargs):
+        """Query related channels (translations) for specific video stream"""
+        if view_kwargs.get("video_stream_id"):
+            stream_id = view_kwargs.get("video_stream_id")
+
+            # Do not use all() as it returns a list of object, needs BaseQuery object
+            records = self.session.query(TranslationChannel).filter_by(
+                video_stream_id=stream_id
+            )
+            return records
+        else:
+            return None
+
+    methods = ["GET"]
+    schema = TranslationChannelSchema
+    decorators = (jwt_required,)
+    data_layer = {
+        'session': db.session,
+        'model': TranslationChannel,
+        'methods': {"query": query, "before_get": before_get},
+    }
+
+
+class TranslationChannelsListPost(ResourceList):
+    """Post a list of Translation Channels"""
+
+    @staticmethod
+    def before_post(data):
+        """Function called when posting to the Translation Channel List"""
+        require_relationship(['video_stream', 'channel'], data)
+        video_stream = db.session.query(
+            VideoStream.query.filter_by(id=data['video_stream']).exists()
+        ).scalar()
+
+        channel = db.session.query(
+            VideoChannel.query.filter_by(id=data['channel']).exists()
+        ).scalar()
+        if not video_stream and not channel:
+            raise ObjectNotFound(
+                {'parameter': 'id'},
+                "Incorrect video_stream and channel data in request body",
+            )
+
+    schema = TranslationChannelSchema
+    decorators = (
+        jwt_required,
+        api.has_permission('auth_required', methods="POST", model=TranslationChannel),
+    )
+    methods = ['POST']
+    data_layer = {
+        'session': db.session,
+        'model': TranslationChannel,
+        'methods': {"before_post": before_post},
+    }
+
+
+class TranslationChannelsDetail(ResourceDetail):
+    """Plain Pattern for the Translation Channel Detail class"""
+
+    schema = TranslationChannelSchema
+    decorators = (jwt_required,)
+    methods = ['GET', 'PATCH', 'DELETE']
+    data_layer = {
+        'session': db.session,
+        'model': TranslationChannel,
+        'methods': {},
+    }
+
+
+class TranslationChannelsRelationship(ResourceRelationship):
+    """Plain pattern for the Translation Channel Relationship class"""
+
+    schema = TranslationChannelSchema
+    data_layer = {
+        'session': db.session,
+        'model': TranslationChannel,
+        'methods': {},
+    }

app/api/video_channel_stream.py

@@ -0,0 +1,69 @@
+from flask_rest_jsonapi import ResourceDetail, ResourceList
+
+from app.api.bootstrap import api
+from app.api.helpers.db import safe_query_kwargs
+from app.api.helpers.permission_manager import has_access, is_logged_in
+from app.api.schema.video_channel import VideoChannelSchema, VideoChannelSchemaPublic
+from app.models import db
+from app.models.video_channel import VideoChannel
+from app.models.video_stream import VideoStream
+
+
+class VideoChannelListPost(ResourceList):
+    """Post to Video Channel List"""
+
+    methods = ['POST']
+    decorators = (api.has_permission('is_admin', methods="POST"),)
+    schema = VideoChannelSchema
+    data_layer = {
+        'session': db.session,
+        'model': VideoChannel,
+    }
+
+
+class VideoChannelList(ResourceList):
+    """List of Video Channels"""
+
+    def before_get(self, unused_args, unused_kwargs):
+        """Providing the requester with the (public) video channel schema"""
+        if is_logged_in() and has_access('is_admin'):
+            self.schema = VideoChannelSchema
+        else:
+            self.schema = VideoChannelSchemaPublic
+
+    methods = ['GET']
+    schema = VideoChannelSchemaPublic
+    data_layer = {
+        'session': db.session,
+        'model': VideoChannel,
+    }
+
+
+class VideoChannelDetail(ResourceDetail):
+    """Details of Video Channel"""
+
+    def before_get(self, unused_args, kwargs):
+        """
+        Providing the requester with the (public) video channel schema,
+        as well as further details.
+        """
+        if is_logged_in() and has_access('is_admin'):
+            self.schema = VideoChannelSchema
+        else:
+            self.schema = VideoChannelSchemaPublic
+
+        if kwargs.get('video_stream_id'):
+            stream = safe_query_kwargs(VideoStream, kwargs, 'video_stream_id')
+            kwargs['id'] = stream.channel_id
+
+    schema = VideoChannelSchema
+    decorators = (
+        api.has_permission(
+            'is_admin',
+            methods="PATCH,DELETE",
+        ),
+    )
+    data_layer = {
+        'session': db.session,
+        'model': VideoChannel,
+    }

app/models/translation_channels.py

@@ -0,0 +1,22 @@
+from sqlalchemy.orm import backref
+
+from app.models import db
+from app.models.video_channel import VideoChannel
+
+
+class TranslationChannel(db.Model):
+    """Translation Channel"""
+
+    __tablename__ = "translation_channels"
+    id = db.Column(db.Integer, primary_key=True)
+    video_stream_id = db.Column(
+        db.Integer, db.ForeignKey('video_streams.id', ondelete='CASCADE')
+    )
+    video_stream = db.relationship('VideoStream', backref=backref('video_stream'))
+
+    channel_id = db.Column(
+        db.Integer, db.ForeignKey('video_channels.id', ondelete='CASCADE')
+    )
+    channel = db.relationship(VideoChannel, backref='stream_channels')
+    name = db.Column(db.String)
+    url = db.Column(db.String)