first version of the new website

[markerbeacon.git] / plugins / pelican_youtube / youtube.py

diff --git a/plugins/pelican_youtube/youtube.py b/plugins/pelican_youtube/youtube.py
new file mode 100644 (file)
index 0000000..a79f55a
--- /dev/null
+++ b/plugins/pelican_youtube/youtube.py
@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2013 Kura
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from __future__ import unicode_literals
+
+from docutils import nodes
+from docutils.parsers.rst import directives, Directive
+
+
+class YouTube(Directive):
+    """ Embed YouTube video in posts.
+
+    Based on the YouTube directive by Brian Hsu:
+    https://gist.github.com/1422773
+
+    VIDEO_ID is required, other arguments are optional
+
+    Usage:
+    .. youtube:: VIDEO_ID
+    """
+
+    def boolean(argument):
+        """Conversion function for yes/no True/False."""
+        value = directives.choice(argument, ('yes', 'True', 'no', 'False'))
+        return value in ('yes', 'True')
+
+    required_arguments = 1
+    optional_arguments = 5
+    option_spec = {
+        'class': directives.unchanged,
+        'width': directives.positive_int,
+        'height': directives.positive_int,
+        'allowfullscreen': boolean,
+        'seamless': boolean,
+    }
+
+    final_argument_whitespace = False
+    has_content = False
+
+    def run(self):
+        videoID = self.arguments[0].strip()
+        url = 'https://www.youtube.com/embed/{}'.format(videoID)
+
+        width = self.options['width'] if 'width' in self.options else None
+        height = self.options['height'] if 'height' in self.options else None
+        fullscreen = self.options['allowfullscreen'] \
+            if 'allowfullscreen' in self.options else True
+        seamless = self.options['seamless'] \
+            if 'seamless' in self.options else True
+
+        css_classes = 'youtube'
+        if 'class' in self.options:
+            css_classes += ' {}'.format(self.options['class'])
+        elif height is None:
+            # use responsive design with 16:9 aspect ratio by default
+            css_classes += ' {}'.format('youtube-16x9')
+        # no additional classes if dimensions (height/width) are specified
+
+        iframe_arguments = [
+            (width, 'width="{}"'),
+            (height, 'height="{}"'),
+            (fullscreen, 'allowfullscreen'),
+            (seamless, 'seamless frameBorder="0"'),
+        ]
+
+        div_block = '<div class="{}">'.format(css_classes)
+        embed_block = '<iframe src="{}" '.format(url)
+
+        for value, format in iframe_arguments:
+            embed_block += (format + ' ').format(value) if value else ''
+
+        embed_block = embed_block[:-1] + '></iframe>'
+
+        return [
+            nodes.raw('', div_block, format='html'),
+            nodes.raw('', embed_block, format='html'),
+            nodes.raw('', '</div>', format='html'),
+        ]
+
+
+def register():
+    directives.register_directive('youtube', YouTube)