Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add twitter share button to public access video

Browse Source
This commit is contained in:
Leangseu Kim
2023-03-08 20:58:02 -05:00
committed by leangseu-edx
parent d7ca7c14cd
commit e3e83c74dc
4 changed files with 94 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
lms/djangoapps/courseware/tests/test_video_mongo.py
View File

@@ -53,7 +53,7 @@ from openedx.core.djangoapps.waffle_utils.models import WaffleFlagCourseOverride
from openedx.core.djangolib.testing.utils import CacheIsolationTestCase
from .test_video_handlers import BaseTestVideoXBlock, TestVideo
from .test_video_xml import SOURCE_XML
from .test_video_xml import SOURCE_XML, PUBLIC_SOURCE_XML
MODULESTORES = {
ModuleStoreEnum.Type.mongo: TEST_DATA_MONGO_MODULESTORE,
@@ -132,6 +132,7 @@ class TestVideoYouTube(TestVideo): # lint-amnesty, pylint: disable=missing-clas
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
}
mako_service = self.item_descriptor.xmodule_runtime.service(self.item_descriptor, 'mako')
@@ -215,6 +216,7 @@ class TestVideoNonYouTube(TestVideo): # pylint: disable=test-inherits-tests
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
}
mako_service = self.item_descriptor.xmodule_runtime.service(self.item_descriptor, 'mako')
@@ -226,6 +228,25 @@ class TestVideoNonYouTube(TestVideo): # pylint: disable=test-inherits-tests
assert expected_result['display_name'] == 'A Name'
@ddt.ddt
class TestVideoPublicAccess(BaseTestVideoXBlock):
"""Test video public access."""
DATA = PUBLIC_SOURCE_XML
MODEL_DATA = {
'data': DATA,
}
METADATA = {}
@ddt.data(True, False)
def test_public_video_url(self, is_lms_platform):
"""Test public video url."""
assert self.item_descriptor.public_access is True
with patch.object(self.item_descriptor, '_is_lms_platform', return_value=is_lms_platform):
context = self.item_descriptor.render(STUDENT_VIEW).content
# public video url iif is_lms_platform and public_access are true
assert bool(get_context_dict_from_string(context)['public_video_url']) is is_lms_platform
@ddt.ddt
class TestGetHtmlMethod(BaseTestVideoXBlock):
'''
@@ -356,6 +377,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
}
for data in cases:
@@ -476,6 +498,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
}
initial_context['metadata']['duration'] = None
@@ -602,6 +625,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
'metadata': metadata
}
@@ -775,6 +799,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'poster': 'null',
'public_video_url': None,
'metadata': metadata,
}
@@ -888,6 +913,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'SubRip (.srt) file', 'value': 'srt'},
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'public_video_url': None,
'poster': 'null',
}
initial_context['metadata']['duration'] = None
@@ -984,6 +1010,7 @@ class TestGetHtmlMethod(BaseTestVideoXBlock):
{'display_name': 'SubRip (.srt) file', 'value': 'srt'},
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'public_video_url': None,
'poster': 'null',
}
initial_context['metadata']['duration'] = None
@@ -2254,6 +2281,7 @@ class TestVideoWithBumper(TestVideo): # pylint: disable=test-inherits-tests
{'display_name': 'SubRip (.srt) file', 'value': 'srt'},
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'public_video_url': None,
'poster': json.dumps(OrderedDict({
'url': 'http://img.youtube.com/vi/ZwkTiUPN0mg/0.jpg',
'type': 'youtube'
@@ -2335,6 +2363,7 @@ class TestAutoAdvanceVideo(TestVideo): # lint-amnesty, pylint: disable=test-inh
{'display_name': 'SubRip (.srt) file', 'value': 'srt'},
{'display_name': 'Text (.txt) file', 'value': 'txt'}
],
'public_video_url': None,
'poster': 'null'
}
return context

15
lms/djangoapps/courseware/tests/test_video_xml.py
View File

@@ -32,6 +32,21 @@ SOURCE_XML = """
</video>
"""
PUBLIC_SOURCE_XML = """
<video show_captions="true"
display_name="A Name"
youtube="0.75:jNCf2gIqpeE,1.0:ZwkTiUPN0mg,1.25:rsq9auxASqI,1.50:kMyNdzVHHgg"
sub="a_sub_file.srt.sjson"
download_video="true"
public_access="true"
start_time="3603.0" end_time="3610.0"
>
<source src="example.mp4"/>
<source src="example.webm"/>
<transcript language="uk" src="ukrainian_translation.srt" />
</video>
"""
class VideoBlockLogicTest(TestCase):
"""Tests for logic of VideoBlock."""

27
lms/templates/video.html
View File

@@ -55,6 +55,17 @@ from openedx.core.djangolib.js_utils import (
<a class="btn-link video-sources video-download-button" href="${download_video_link}">
${_('Download video file')}
</a>
% if public_video_url:
<br/>
<a
class="btn-link"
id="twitter-share-button"
href="${public_video_url}"
target="_blank"
>
${_('Share on Twitter')}
</a>
% endif
</div>
% endif
% if track:
@@ -117,3 +128,19 @@ from openedx.core.djangolib.js_utils import (
}
</script>
% endif;
% if public_video_url:
<script>
$("#twitter-share-button").click(function() {
var tweetText = encodeURIComponent("Here\'s a fun clip from a class I\'m taking on @edXonline.\n\n");
var utmQuery = $.param({
utm_source: 'twitter',
utm_medium: 'social',
utm_campaign: 'social-share-exp',
});
var url = encodeURIComponent(this.href + "?" + utmQuery);
var tweetUrl = "https://twitter.com/intent/tweet?text=" + tweetText + "&url=" + url;
window.open(tweetUrl,'targetWindow','toolbar=no,location=0,status=no,menubar=no,scrollbars=yes,resizable=yes,width=600,height=400');
return false;
});
</script>
% endif

22
xmodule/video_block/video_block.py
View File

@@ -18,8 +18,10 @@ import json
import logging
from collections import OrderedDict, defaultdict
from operator import itemgetter
from urllib.parse import urljoin
from django.conf import settings
from django.urls import reverse
from edx_django_utils.cache import RequestCache
from lxml import etree
from opaque_keys.edx.locator import AssetLocator
@@ -28,6 +30,7 @@ from xblock.completable import XBlockCompletionMode
from xblock.core import XBlock
from xblock.fields import ScopeIds
from xblock.runtime import KvsFieldData
from lms.djangoapps.lms_xblock.runtime import LmsModuleSystem
from common.djangoapps.xblock_django.constants import ATTR_KEY_REQUEST_COUNTRY_CODE
from openedx.core.djangoapps.video_config.models import HLSPlaybackEnabledFlag, CourseYoutubeBlockedFlag
@@ -474,9 +477,28 @@ class VideoBlock(
'track': track_url,
'transcript_download_format': transcript_download_format,
'transcript_download_formats_list': self.fields['transcript_download_format'].values, # lint-amnesty, pylint: disable=unsubscriptable-object
# provide the video url iif the video is public and we are in LMS.
# Reverse render_public_video_xblock is not available in studio.
'public_video_url': self._get_public_video_url(),
}
return self.runtime.service(self, 'mako').render_template('video.html', template_context)
def _is_lms_platform(self):
"""
Returns True if the platform is LMS.
"""
return isinstance(self.xmodule_runtime, LmsModuleSystem)
def _get_public_video_url(self):
"""
Returns the public video url
"""
return urljoin(
settings.LMS_ROOT_URL,
reverse('render_public_video_xblock', kwargs={'usage_key_string': str(self.location)})
) if self.public_access and self._is_lms_platform() else None
def validate(self):
"""
Validates the state of this Video XBlock instance. This