?play=xspf to any post, Page, or archive URI.
Author: Sam
Version: 0.2
=== XSPF playlist ===
Tags: playlist, xspf, m3u, attachments
Requires at least: 2.5?
Tested up to: 2.7
Here is a short description of the plugin. This should be no more than 150 chars. No markup here.
== Description ==
This is the long description. No limit, and you can use Markdown…
== Installation ==
This section describes how to install the plugin and get it working.
*/
define( 'PM_CONTENT', false ); // save playlist files?
define( 'PM_CONTENT_DIRECTORY_NAME', 'play' ); // Name of directory in wp-content; stores playlists
define( 'PM_CONTENT_PATH', WP_CONTENT_DIR . DIRECTORY_SEPARATOR . PM_CONTENT_DIRECTORY_NAME );
define( 'PM_CONTENT_URL', WP_CONTENT_URL . '/' . PM_CONTENT_DIRECTORY_NAME . '/' );
define( 'PM_CONTENT_ALL_NAME', 'all' ); // Name of the playlist containing all playable attachments
define( 'PM_LOG', true );
define( 'PM_DEBUG', false );
define( 'PM_DEFAULT_PLAYLIST_FORMAT', 'xspf' ); // not used yet
define( 'PM_PLAYLIST_MAX_AGE', 600 ); // seconds for browsers/clients to keep cached copy
define( 'PM_BLOG_CHARSET', get_option('blog_charset') );
define( 'PM_REWRITE', true ); // do pretty permalinks?
define( 'PM_REWRITE_ENDPOINT_NAME', 'play' );
define( 'PM_REWRITE_ENDPOINT_PLACES'
, EP_PERMALINK // single post or page
| EP_ROOT // home or front
| EP_ALL
);
$Playlist_Maker = new Playlist_Maker;
$Playlist_Maker->plug_in();
register_activation_hook( __FILE__, array(&$Playlist_Maker, 'activate') );
register_deactivation_hook( __FILE__, array(&$Playlist_Maker, 'deactivate') );
/**
* Template tag: Get hyperlink for a playlist
*
* @param int $id
* @param string $type
* @param string $contents Contents of the hyperlink
* @return bool|string HTML hyperlink or false on failure
*/
function get_playlist_link( $id = null, $type = PM_DEFAULT_PLAYLIST_FORMAT, $contents = null ) {
return $GLOBALS['Playlist_Maker']->get_playlist_link( $id, $type, $contents );
}
/**
* Template tag: Get URL of a playlist
*
* @param int $id
* @param string $type
* @return bool|string URL or false on failure
*/
function get_playlist_url( $id = null, $type = PM_DEFAULT_PLAYLIST_FORMAT ) {
return $GLOBALS['Playlist_Maker']->get_playlist_url( $id, $type );
}
/**
* Does everything
*
*/
class Playlist_Maker
{
var $options = array(
'playable_attachment_types' => array('audio', 'video'),
'save_playlist_types' => array('m3u', 'xspf'),
'tracks_orderby' => 'ID',
'tracks_order' => 'DESC',
),
$types = array( 'audio', 'video' ), // move to 'playable types' above !
$save_types = null, // array('m3u', 'xspf'),
$log = array(),
$errors = null,
$did_notices = false,
##
$mime = array(
'm3u' => 'audio/x-mpegurl',
'xspf' => 'application/xspf+xml',
'smil' => 'application/smil'
),
## Marked to save @ shutdown
$save = array(
'attachments' => array(),
'posts' => array(),
'all' => false,
),
/*
TODO Some filters should be added conditionally!
*/
$actions = array(
'add_attachment' => 'update_attachment',
'edit_attachment' => 'update_attachment',
'delete_attachment' => 'update_attachment',
'edit_post' => 'update_post',
'init' => 'init',
'parse_query' => 'parse_query',
'shutdown' => 'shutdown',
'wp' => 'wp',
'admin_notices' => 'error_notices',
'admin_footer' => 'error_notices',
),
$query = null;
function __construct() {
$this->errors = new WP_Error;
}
function Playlist_Maker() {
$this->__construct();
}
function plug_in() {
foreach ( $this->actions as $hook => $method ) {
add_action( $hook, array( &$this, $method ) );
}
}
function init() {
if ( PM_REWRITE ) {
add_rewrite_endpoint( PM_REWRITE_ENDPOINT_NAME, PM_REWRITE_ENDPOINT_PLACES );
}
}
function activate() {
if ( PM_REWRITE ) {
$GLOBALS['wp_rewrite']->flush_rules();
$this->log('Flushing rewrite rules');
}
if ( $this->options['save_playlist_types'] ) {
if ( ! file_exists(PM_CONTENT_PATH) ) {
$created = mkdir(PM_CONTENT_PATH);
if ( ! $created ) {
$this->log("Couldn't create " . PM_CONTENT_PATH);
$this->errors->add('mkdir_failed', __('Could not create directory'), PM_CONTENT_PATH);
return;
}
$this->log('Created ' . PM_CONTENT_PATH);
}
// Content directory exists
if ( ! is_writable(PM_CONTENT_PATH) ) {
$this->errors->add('unwritable', "Can't write to this directory", PM_CONTENT_PATH);
return;
}
// Should this be done @ shutdown?
$this->save_all_playlists();
}
}
function error_notices() {
if ( $this->did_notices ) {
return;
}
$msgs = $this->errors->get_error_messages();
if ( $msgs ) {
$msgs = array_map( 'htmlspecialchars', $msgs );
echo '';
foreach ( $msgs as $code => $msg ) {
echo '- ' . $this->xmlspecialchars($msg);
// Only 1 datum per error code, ever ??
$data = $this->errors->get_error_data($code);
if ($data) {
echo '' . $this->xmlspecialchars($data) . '';
}
echo '
';
}
echo '
';
}
$this->did_notices = true;
if ( PM_LOG && $this->log ) {
echo '';
foreach ( $this->log as $i => $msg ) {
echo '- ' . Playlist_Maker::xmlspecialchars($msg) . '
';
}
echo '
';
}
}
function save_all_playlists() {
// Get all parents of playable attachments; write playlists
$attachments = $this->get_attachments( null, $this->options['playable_attachment_types'] );
$this->save_playlists_all( $this->options['save_playlist_types'], $attachments );
// arrange by parent
foreach ( $attachments as $attachment ) {
$parents[$attachment->post_parent][$attachment->ID] = $attachment;
}
// var_dump($parents);
foreach ( $parents as $parent_id => $kids ) {
$this->save_playlists_from_post( $parent_id, $this->options['save_playlist_types'], $kids );
}
}
function deactivate() {
$GLOBALS['wp_rewrite']->flush_rules();
}
function &get_attachments( $parent, $type = null, $count = -1 ) {
isset($type)
or $type = $this->options['playable_attachment_types'];
$children =& get_children(array(
'numberposts' => $count,
'post_parent' => $parent,
'post_type' => 'attachment',
'post_mime_type' => $type,
));
$this->log("Got " .count($children). " attachments for parent $parent type " . implode(',', $type));
return $children;
}
/**
* If query is for home/front page playlist, print playlist & exit
*
* Hook parse_query: Request type is known (front, single, attachment) but no posts are retrieved yet.
*
* @param object $wp_query
*/
function parse_query( &$wp_query ) {
// parse_query called for get_posts() too; DONT get in a loop
$play = get_query_var(PM_REWRITE_ENDPOINT_NAME);
$this->log("play = '$play'");
if ( 'default' == $play ) {
$play = PM_DEFAULT_PLAYLIST_FORMAT;
set_query_var(PM_REWRITE_ENDPOINT_NAME, $play);
$this->log("Setting play to default: play=" . get_query_var(PM_REWRITE_ENDPOINT_NAME));
}
if ( $play
&& empty($wp_query->query_vars['suppress_filters'])
&& $wp_query === $GLOBALS['wp_the_query'] )
{
$this->log("This is a playlist query {$wp_query->request}");
$this->query =& $wp_query; // kepp track of the query
if ( ! is_single() && ! is_page() ) {
set_query_var('post_type', 'attachment');
set_query_var('post_status', 'inherit');
set_query_var('post_mime_type', $this->options['playable_attachment_types']);
}
}
}
/**
* Send playlist for Pages and posts; exit
*
* Hook wp: Posts have been loaded
*
* @param object $wp
* @author Sam
*/
function wp( &$wp ) {
$play = get_query_var(PM_REWRITE_ENDPOINT_NAME);
if ( $play ) {
$this->log("This is a playlist request");
// $this->log( $this->query );
if ( is_404() ) {
// ??
} else {
if ( is_page() || is_single() ) {
// global $id is not set yet; get_the_ID() doesn't work
if ( empty($GLOBALS['id']) && isset($GLOBALS['wp_the_query']->post->ID) ) {
$GLOBALS['id'] = $GLOBALS['wp_the_query']->post->ID;
}
$attachments =& $this->get_attachments( get_the_ID(), $this->options['playable_attachment_types'] );
} else {
$attachments =& $GLOBALS['wp_the_query']->posts;
}
if ( $attachments ) {
$this->send_playlist( $play, $attachments );
} else {
$this->send_404("No playable tracks");
}
$this->log('Exiting at ' . __CLASS__ . '->' . __FUNCTION__);
exit;
}
}
}
function send_playlist( $type, &$attachments ) {
$this->log("Send playlist type '$type'");
switch ($type) {
case 'm3u':
header('Content-Type: application/x-mpegurl; charset='.get_bloginfo('charset'));
header('Content-Disposition: inline; filename=' . $this->get_the_playlist_filename('m3u') );
header('Cache-Control: max-age='.PM_PLAYLIST_MAX_AGE );
$this->print_playlist('m3u', $attachments);
break;
case 'xspf':
header('Content-Type: application/xspf+xml; charset='.get_bloginfo('charset'));
header('Content-Disposition: inline; filename=' . $this->get_the_playlist_filename('xspf') );
header('Cache-Control: max-age='.PM_PLAYLIST_MAX_AGE );
$this->print_playlist('xspf', $attachments);
break;
case 'smil':
header('Content-Type: application/smil');
$this->print_playlist('smil', $attachments);
break;
default:
$this->log("Can't send playlist type '$type', what is it?");
$type = wp_specialchars($type);
Playlist_Maker::send_404("I don't recognize playlist type $type");
break;
}
}
function send_404( $msg ) {
status_header(404);
// get_header();
echo 'Not found
' . "$msg
";
// get_footer();
}
function print_playlist($type, &$attachments) {
$this->log("Print playlist type '$type'");
switch ($type) {
case 'atom':
include 'templates/atom.php';
break;
case 'm3u':
foreach ( $attachments as $attachment ) {
echo wp_get_attachment_url( $attachment->ID ) . "\n";
}
break;
case 'xspf':
$display_errors = ini_set('display_errors', 0); // don't break XML
include 'templates/xspf.php';
PM_LOG && Playlist_Maker::comment($this->log);
ini_set( 'display_errors', $display_errors );
break;
case 'smil':
$display_errors = ini_set('display_errors', 0); // don't break XML
include 'templates/smil.php';
PM_LOG && Playlist_Maker::comment($this->log);
ini_set( 'display_errors', $display_errors );
break;
default:
$this->log('Nothing happened');
break;
}
}
function get_playlist( $type, &$attachments ) {
$this->log("get playlist type $type with " . count($attachments) . ' tracks');
switch ($type) {
case 'm3u':
return implode( "\n"
, array_map( 'wp_get_attachment_url', array_keys($attachments) ));
break;
case 'xspf':
ob_start();
include 'templates/xspf.php';
PM_LOG && Playlist_Maker::comment($this->log);
return ob_get_clean();
break;
case 'smil':
ob_start();
include 'templates/smil.php';
PM_LOG && Playlist_Maker::comment($this->log);
return ob_get_clean();
break;
default:
trigger_error("Unknown playlist type $type", E_USER_WARNING);
break;
}
}
/**
* Get string for XML element
*
* @param string $name Name of XML element
* @param array $attributes
* @param array|string $contents
* @return string XML chunk
* @author Sam
*/
function get_XML_element( $name, $attributes = null, $contents = null ) {
$output = "<$name";
if ( $attributes ) {
foreach ( $attributes as $attr => $value ) {
$output .= " $attr=\"" . Playlist_Maker::xmlspecialchars($value) . '"';
}
}
if ( empty($contents) ) {
$output .= '/>';
} else {
$output .= '>';
if ( is_string($contents) ) {
$output .= Playlist_Maker::xmlspecialchars($contents);
}
elseif ( is_array($contents) ) {
$output .= implode( "\n", $contents );
}
$output .= "";
}
// strip invalid chars only
$output = Playlist_Maker::xmlf($output, false);
return $output;
}
/**
* Return value for an element in XSPF , or some other playlist type
*
* @param string $name Name of XSPF playlist element ('title', 'info', 'image')
* @param bool $xml Format for XML?
* @return string
* @todo What is the best way to XML-escape these?
* @author Sam
*/
function get_playlist_value( $name, $xml = false ) {
// use add_filter( 'pm_playlist_value_pre', $callback, $priority, 2 );
// function callback( $empty, $name ) {...}
$output = apply_filters( 'pm_playlist_value_pre', '', $name );
if ( empty($output) ) {
switch ($name) {
case 'title':
return wp_title( '', false, 'right' ) . get_bloginfo('name'); // needs XML formatting
break;
case 'info':
if (is_single())
return apply_filters('the_permalink_rss', get_permalink());
elseif (is_category())
return apply_filters('the_permalink_rss', get_category_link() );
else
// for other requests, should be able to figure this out from query
return get_bloginfo_rss('url'); // lame
break;
case 'image':
if ( is_single() || is_page() ) {
// return get_post_meta 'image' first; else:
$images = get_children(array(
'numberposts' => 1,
'post_parent' => $this->query->post->ID, // too early for get_the_ID()
'post_type' => 'attachment', // required in WordPress < 2.7
'post_mime_type' => 'image',
));
if ( $images ) {
$image = current($images);
return wp_get_attachment_url($image->ID);
}
} else {
// no image
}
break;
case 'creator':
if ( is_singular() ) {
return get_the_author();
}
break;
default:
trigger_error( __FUNCTION__ . ": Can't output value $name", E_USER_NOTICE );
break;
}
}
if ($output && $xml) {
$output = Playlist_Maker::xmlf($output, true);
}
return $output;
}
/**
* Get value for element of XPSF