p4a.videoembed 1.3

Overview

A registry and adapters for converting urls for various video sharing sites into embed codes.

This package provides some functions and zope3 components for converting urls from common streaming video sites into embed codes. The purpose is to allow for content types that provide a user entered url to display embeded video based on that url. This is to avoid allowing users to enter raw html embed codes which is potentially dangerous and cumbersome. It also allows for dynamic scaling of the generated embed code to fit with your page layout.

Components

At the heart of this product is a set of named adapters. These adapters adapt a string (url) and an integer (width) and return a unicode embed code. Currently, adapters are provided for the following video sharing sites:

• YouTube http://www.youtube.com/

• Google Video http://video.google.fr

• Yahoo Video http://video.yahoo.com/

• Revver (both http://revver.com and one.revver.com)

• Vimeo http://vimeo.com

• Vmix http://vmix.com

• Blip.tv http://blip.tv

• iFilm http://ifilm.com

• MySpace http://vids.myspace.com

• MetaCafe http://metacafe.com

• College Humor http://collegehumor.com

• Veoh http://veoh.com

• flash video (.flv) using http://www.longtailvideo.com/players/jw-flv-player

• (.mov .qt .m4v) ># The original revver QT embed

• VH1 http://vh1.com

• Live Leak http://liveleak.com

• Video detective http://videodetective.com

• Dailymotion http://www.dailymotion.com

But adding more is as simple as creating a function that checks if the url is appropriate for the site you want, and another to convert it into an embed code. You register the latter function as a named adapter, like:

<adapter
    for="str int"
    name="youtube"
    provides=".interfaces.IEmbedCode"
    factory=".converters.youtube_generator"
    />

And register the url checking function as a utility with the same name:

<utility
    provides=".interfaces.IURLChecker"
    component=".converters.youtube_check"
    name="youtube" />

You may optionally provide an integer ‘index’ as an attribute of the checker to determine the relative order in which the check is made (more specific checks should go earlier).

Getting the Embed Code

There are a couple ways to generate an embed code, depending on your usecase. The easiest is single adaptation of a url:

from p4a.videoembed.interfaces import IEmbedCode embed_code = IEmbedCode(url)

This gives an embed of a preset width (425px), to get a custom width, you multiadapt:

from zope.component import getMultiAdapter embed_code = getMultiAdapter((url, width), IEmbedCode)

There is also a convenient view provided for use from restricted code, it optionally takes a url and width and returns an embed code. If the url is omitted, then it will try and get one from the context by adapting to ILinkProvider (which indicates the presence of a getLink method).

<div class="EmbedCode"
     tal:define="embed_view nocall:context/@@video-embed.htm;
                 default_embed embed_view;
                 custom_width python:embed_view(width=500);
                 custom_url python:embed_view(url='http://www.youtube.com/watch?v=1111', width=250)"
     tal:replace="structure default_embed" />

This shows how you can use the view from tal to generate a url from an object that implements or is adaptable to ILinkProvider, or using an explicit url from any object.

In all of these methods the adapter checks the global utility that the named adapters are registered with and finds the appropriate one for the given url.

I hope you find this useful.

Author: Alec Mitchell <apm13@columbia.edu> Sponsor: The Daily Reel http://www.thedailyreel.com

Changelog for videoembed

videoembed - 1.2 (2009-05-17)

• fix ComponentLookupError import from zope.component [toutpt]

• removed unused imports reported by pyflakes [tom_gross]

• add partial Dailymotion support [toutpt]

videoembed - 1.1 (2008-04-09)

• added Brightcove support [Nate Aune]

videoembed - 1.1b1 (2008-02-14)

• added partial ustream.tv support [Rocky Burt] r1672

• added code to extract URL to FLV file from Youtube and Blip.tv (Ross Patterson) r1875 and r1879

videoembed - 1.0alpha1 (2007-04-29)

• Initial public release. [Rocky Burt]

videoembed - 0.1 (unreleased)

• Initial package structure. [zopeskel]