Skip to content

Use singular transcript util to retrieve transcripts from contentstore #17851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Qubad786 wants to merge 4 commits into from
Closed

Use singular transcript util to retrieve transcripts from contentstore #17851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80b1484
Use singular transcript util to retrieve transcripts from contentstore
Qubad786 Apr 2, 2018
d2b65b8
fix download output format
Qubad786 Apr 3, 2018
6bbfd97
refactor tests
Qubad786 Apr 3, 2018
a887cd5
allow transcript download in txt format
Qubad786 Apr 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions common/lib/xmodule/xmodule/video_module/transcripts_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ def convert(content, input_format, output_format):
# With error handling (set to 'ERROR_RAISE'), we will be getting
# the exception if something went wrong in parsing the transcript.
srt_subs = SubRipFile.from_string(
content.decode('utf8'),
content.decode('utf-8-sig'),
error_handling=SubRipFile.ERROR_RAISE
)
except Error as ex: # Base exception from pysrt
Expand Down Expand Up @@ -944,7 +944,7 @@ def get_transcript_from_contentstore(video, language, output_format, transcripts
transcripts['en'] = sub
elif video.youtube_id_1_0:
transcripts['en'] = video.youtube_id_1_0
elif language == u'en':
elif language == u'en' and not transcripts.get(language, False):
raise NotFoundError('No transcript for `en` language')

try:
Expand Down
45 changes: 26 additions & 19 deletions common/lib/xmodule/xmodule/video_module/video_handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
get_or_create_sjson,
generate_sjson_for_all_speeds,
get_video_transcript_content,
get_transcript_from_contentstore,
Copy link
Contributor

@muhammad-ammar muhammad-ammar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we need to use get_transcript instead of get_transcript_from_contentstore?

Copy link
Contributor Author

@Qubad786 Qubad786 Apr 4, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, I am only aiming for contentstore part of the interface. So that we may find some further unseen scenario(i.e. not covered by our util).

save_to_store,
subs_filename,
Transcript,
Expand Down Expand Up @@ -288,11 +289,14 @@ def transcript(self, request, dispatch):
self.transcript_language = language

try:
transcript = self.translation(request.GET.get('videoId', None), transcripts)
except (TypeError, TranscriptException, NotFoundError) as ex:
# Catching `TranscriptException` because its also getting raised at places
# when transcript is not found in contentstore.
log.debug(six.text_type(ex))
transcript_content, __, mime_type = get_transcript_from_contentstore(
video=self,
language=language,
output_format=Transcript.SJSON,
transcripts_info=transcripts,
youtube_id=request.GET.get('videoId', None)
)
except (TranscriptsGenerationException, UnicodeDecodeError, NotFoundError):
# Try to return static URL redirection as last resort
# if no translation is required
response = self.get_static_transcript(request, transcripts)
Expand All @@ -314,25 +318,28 @@ def transcript(self, request, dispatch):
log.info(six.text_type(ex))
response = Response(status=404)
else:
response = Response(transcript, headerlist=[('Content-Language', language)])
response.content_type = Transcript.mime_types['sjson']
response = Response(transcript_content, headerlist=[('Content-Language', language)])
response.content_type = mime_type

elif dispatch == 'download':

lang = request.GET.get('lang', None)
# Make sure the language is set.
if not lang:
lang = self.get_default_transcript_language(transcripts)

try:
transcript_content, transcript_filename, transcript_mime_type = self.get_transcript(
transcripts, transcript_format=self.transcript_download_format, lang=lang
output_format = self.transcript_download_format if self.transcript_download_format else Transcript.SRT
transcript_content, filename, mime_type = get_transcript_from_contentstore(
video=self,
language=lang,
output_format=output_format,
transcripts_info=transcripts
)
except (KeyError, UnicodeDecodeError):
return Response(status=404)
except (ValueError, NotFoundError):
except (TranscriptsGenerationException, UnicodeDecodeError, NotFoundError):
response = Response(status=404)
# Check for transcripts in edx-val as a last resort if corresponding feature is enabled.
if feature_enabled:
# Make sure the language is set.
if not lang:
lang = self.get_default_transcript_language(transcripts)

transcript = get_video_transcript_content(edx_video_id=self.edx_video_id, language_code=lang)
if transcript:
transcript_conversion_props = dict(transcript, output_format=self.transcript_download_format)
Expand All @@ -354,12 +361,12 @@ def transcript(self, request, dispatch):
response = Response(
transcript_content,
headerlist=[
('Content-Disposition', 'attachment; filename="{}"'.format(transcript_filename.encode('utf8'))),
('Content-Language', self.transcript_language),
('Content-Disposition', 'attachment; filename="{}"'.format(filename.encode('utf8'))),
('Content-Language', lang),
],
charset='utf8'
)
response.content_type = transcript_mime_type
response.content_type = mime_type

elif dispatch.startswith('available_translations'):
Copy link
Contributor

@muhammad-ammar muhammad-ammar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this file are different from what we did in https://github.com/edx/edx-platform/pull/17718. Is this intentionally? Changes in the https://github.com/edx/edx-platform/pull/17718 are final and should be used.

Copy link
Contributor Author

@Qubad786 Qubad786 Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@muhammad-ammar this is temporary just to make sure that our contentstore part of the interface works as smooth as it should be! :)


Expand Down
15 changes: 12 additions & 3 deletions lms/djangoapps/courseware/tests/test_video_handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,15 +435,21 @@ def test_download_transcript_not_exist(self):
response = self.item.transcript(request=request, dispatch='download')
self.assertEqual(response.status, '404 Not Found')

@patch('xmodule.video_module.VideoModule.get_transcript', return_value=('Subs!', 'test_filename.srt', 'application/x-subrip; charset=utf-8'))
@patch(
'xmodule.video_module.video_handlers.get_transcript_from_contentstore',
return_value=('Subs!', 'test_filename.srt', 'application/x-subrip; charset=utf-8')
)
def test_download_srt_exist(self, __):
request = Request.blank('/download')
response = self.item.transcript(request=request, dispatch='download')
self.assertEqual(response.body, 'Subs!')
self.assertEqual(response.headers['Content-Type'], 'application/x-subrip; charset=utf-8')
self.assertEqual(response.headers['Content-Language'], 'en')

@patch('xmodule.video_module.VideoModule.get_transcript', return_value=('Subs!', 'txt', 'text/plain; charset=utf-8'))
@patch(
'xmodule.video_module.video_handlers.get_transcript_from_contentstore',
return_value=('Subs!', 'txt', 'text/plain; charset=utf-8')
)
def test_download_txt_exist(self, __):
self.item.transcript_format = 'txt'
request = Request.blank('/download')
Expand All @@ -460,7 +466,10 @@ def test_download_en_no_sub(self):
with self.assertRaises(NotFoundError):
self.item.get_transcript(transcripts)

@patch('xmodule.video_module.VideoModule.get_transcript', return_value=('Subs!', u"塞.srt", 'application/x-subrip; charset=utf-8'))
@patch(
'xmodule.video_module.video_handlers.get_transcript_from_contentstore',
return_value=('Subs!', u"塞.srt", 'application/x-subrip; charset=utf-8')
)
def test_download_non_en_non_ascii_filename(self, __):
request = Request.blank('/download')
response = self.item.transcript(request=request, dispatch='download')
Expand Down