From b1cfee4592df436a52103ef4b3b9a94826eeccf2 Mon Sep 17 00:00:00 2001
From: Louis Sobel <sobel@lsmbp.local>
Date: Tue, 23 Oct 2012 14:50:17 -0400
Subject: [PATCH] Add support for subtitle download link

Add a download link to the video player. The link is defined
in the content xml using the following structure:

<video youtube="youtubestring">
    <track kind="subtitle" src="subtitle_link" />
</video>
---
 common/lib/xmodule/xmodule/video_module.py | 22 ++++++++++++++++++----
 lms/templates/video.html                   |  6 ++++++
 2 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/common/lib/xmodule/xmodule/video_module.py b/common/lib/xmodule/xmodule/video_module.py
index 11c90f45ef..9a22950ca8 100644
--- a/common/lib/xmodule/xmodule/video_module.py
+++ b/common/lib/xmodule/xmodule/video_module.py
@@ -32,6 +32,7 @@ class VideoModule(XModule):
         self.position = 0
         self.show_captions = xmltree.get('show_captions', 'true')
         self.source = self._get_source(xmltree)
+        self.track = self._get_track(xmltree)
 
         if instance_state is not None:
             state = json.loads(instance_state)
@@ -40,13 +41,25 @@ class VideoModule(XModule):
 
     def _get_source(self, xmltree):
         # find the first valid source
-        source = None
-        for element in xmltree.findall('source'):
+        return self._get_first_external(xmltree, 'source')
+        
+    def _get_track(self, xmltree):
+        # find the first valid track
+        return self._get_first_external(xmltree, 'track')
+        
+    def _get_first_external(self, xmltree, tag):
+        """
+        Will return the first valid element
+        of the given tag.
+        'valid' means has a non-empty 'src' attribute
+        """
+        result = None
+        for element in xmltree.findall(tag):
             src = element.get('src')
             if src:
-                source = src
+                result = src
                 break
-        return source
+        return result
 
     def handle_ajax(self, dispatch, get):
         '''
@@ -85,6 +98,7 @@ class VideoModule(XModule):
             'id': self.location.html_id(),
             'position': self.position,
             'source': self.source,
+            'track' : self.track,
             'display_name': self.display_name,
             # TODO (cpennington): This won't work when we move to data that isn't on the filesystem
             'data_dir': self.metadata['data_dir'],
diff --git a/lms/templates/video.html b/lms/templates/video.html
index 47556095cb..5c041d5c70 100644
--- a/lms/templates/video.html
+++ b/lms/templates/video.html
@@ -18,3 +18,9 @@
   <p>Download video <a href="${source}">here</a>.</p>
 </div>
 % endif
+
+% if track:
+<div class="video-tracks">
+  <p>Download subtitles <a href="${track}">here</a>.</p>
+</div>
+% endif