txp_plugins/bts_podcast/bts_podcast.php

<?php

$plugin['version'] = '0.1';
$plugin['author'] = 'brent saner';
$plugin['author_uri'] = 'http://square-r00t.net/';
$plugin['description'] = 'A plugin to generate a tech-centric podcast feed.';

$plugin['order'] = 5;
//$plugin['type'] = 1;
$plugin['type'] = 0;

//if (!defined('PLUGIN_HAS_PREFS')) define('PLUGIN_HAS_PREFS', 0x0001); // This plugin wants to receive "plugin_prefs.{$plugin['name']}" events
//if (!defined('PLUGIN_LIFECYCLE_NOTIFY')) define('PLUGIN_LIFECYCLE_NOTIFY', 0x0002); // This plugin wants to receive "plugin_lifecycle.{$plugin['name']}" events

//$plugin['flags'] = PLUGIN_HAS_PREFS | PLUGIN_LIFECYCLE_NOTIFY;

//if (!defined('txpinterface'))
//	@include_once('zem_tpl.php');

if (0) {
?>
# --- BEGIN PLUGIN HELP --- 

h1. Podcast generation... *for nerds*.
h4. For an exmaple of this in action, check out the various feeds for "Sysadministrivia":http://sysadministrivia.com.

This plugin performs multiple functions to aid in creating a podcast. It requires "getID3":http://www.getid3.org to be available in your PHP's path.

h5. bts_podcast_path
The path to the media file.

Attributes:
	*type=*
	Useful for mp3/oggcasts. Default is _mp3_.

	*base=*
	Path to the media file (excluding the filename itself). Default is _media/*$type*/_.


h5. bts_podcast_filename
The filename of the media file. Automatically generated from the title by default.

Attributes:
	*type=*
	File extension. Recommended is either _mp3_ or _ogg_. Default is _mp3_.

	*name=*
	The string to use as the filename. Default is to use *@<txp:title />@* (in a stripped manner- all symbols etc. replaced with . and -).


h5. bts_podcast_guid
The GUID for the podcast. See the *Storing Checksums* section.

Attributes:
	*string=*
	The string to use as a GUID. Default is to use a SHA256 of the file (byte-wise) found at _*@<txp:bts_podcast_path />@*/*@<txp:bts_podcast_filename />@*_.

	*byte=*
	Boolean. Use byte checksumming instead of string checksumming. This requires a valid path for the *string=* attribute. Default is _1_ (use byte checksumming).

	*db=*
	Boolean. Use the SHA256 table to look up the GUID (see the *Storing Checksums* section below). Default is _1_ (use the sha256 table).


h5. bts_podcast_media_uri
The web path to fetch the file.

Attributes:
	*uri=*
	The path to use. Default is to use _*@<txp:site_url />@@<txp:bts_podcast_path />@*/*@<txp:bts_podcast_filename />@*_.
	

h3. Storing Checksums
Using SHA256 sums as your GUID is a very handy thing- it not only gaurantees unique GUIDs (which is the entire point of GUIDs), but also gaurantees file integrity in transit.
However, it can take a while to generate SHA256 sums dynamically every time the feed is fetched. So how do we get around this?

Simple; we use a database!

This plugin creates a *sha256* table in your Textpattern DB. There, it stores the checksums of MP3 and OGG files when an article in the "episodes" section is created. When the feed is pulled, they are fetched from the DB automatically (assuming you're using *bts_podcast_guid* with _db="1"_).

# --- END PLUGIN HELP ---
<?php
}

# --- BEGIN PLUGIN CODE ---

// Plugin code goes here.  No need to escape quotes.

if(class_exists('\Textpattern\Tag\Registry')) {
	Txp::get('\Textpattern\Tag\Registry')
		->register('bts_podcast_path')
		->register('bts_podcast_filename')
		->register('bts_podcast_guid')
		->register('bts_podcast_media_uri');
}

function bts_podcast_path($atts) {
 $default_vals = array('type' => 'mp3');
 $default_vals['base'] = 'media/' . $default_vals['type'] . '/';
 extract(lAtts(($default_vals), $atts));
 if ($base == 'media/mp3/') {
 	$base = 'media/' . $type . '/';
 }
  return $base;
}


function bts_podcast_filename($atts) {
 extract(lAtts(array(
  'type' => 'mp3',
  'name' => NULL,
 ), $atts));
 if (! $name) {
   $raw_name = strtolower(title($atts));
   $stripped = trim($raw_name);
   $replaced = preg_replace('(\s+|[^A-Za-z0-9\.\-]+)','.',$stripped);
   $name = preg_replace('(\.+)','.',$replaced);
 }
 return $name . '.' . $type;
}


function bts_podcast_guid ($atts) {
 extract(lAtts(array(
  'string' => '',
  'byte' => '1',
  'db' => '1',
 ), $atts));

 if (($byte == '1' && $db == '1') || ($string == '')) {
  //$checksum = safe_query('select checksum from sha256 where url_title = \'' . article_url_title() . '\' and filename = \'' . bts_podcast_filename() . '\'');
  $checksum = fetch('checksum','sha256','filename',bts_podcast_filename($atts));
 } elseif ($byte == '1') {
  $checksum = hash_file('sha256',$string);
 } else {
  $checksum = hash('sha256',$string);
 }
return $checksum;
}


function bts_podcast_media_uri ($atts) {
 $default_vals = array('type' => 'mp3');
 //$default_vals['uri'] = site_url($atts) . bts_podcast_path($type=$default_vals['type']) . bts_podcast_filename($type=$default_vals['type']);
 $default_vals['uri'] = site_url($atts) . bts_podcast_path($atts) . bts_podcast_filename($atts);
 extract(lAtts(array($default_vals), $atts));
 //if ($uri == site_url() . 
return $uri; 
}


# --- END PLUGIN CODE ---

?>