\d+))?/?$%i',
'build_str' => '{$slug}/atom/comments(/page/{$page})',
'handler' => 'AtomHandler',
'action' => 'entry_comments',
'priority' => 8,
'description' => 'Podcast comments',
));
return $rules;
}
/**
* Filter the parameters being passed to Posts::get()
*
* @param array $filters The parameters to be passed to Posts::get()
*
* @return array The updated parameters
*/
public function filter_template_where_filters( $filters )
{
$vars = Controller::get_handler_vars();
if( strlen( $vars['entire_match'] ) && strpos( $vars['entire_match'], 'podcast/' ) !== FALSE && isset( $vars['podcast_name'] ) ) {
$filters['where'] = "{posts}.id in ( select post_id from {postinfo} where name = '{$vars['podcast_name']}' )";
}
if( isset( $filters['content_type'] ) ) {
$types = Utils::single_array( $filters->offsetGet( 'content_type' ) );
$types[] = Post::type( 'podcast' );
$filters->offsetSet( 'content_type', $types );
}
return $filters;
}
/**
* Filter the parameters passed to Posts::get() in the Atomhandler.
* @param $content_type. mixed. content types being passed.
* @return array. content types with Podcast type added.
*/
public function filter_atom_get_collection_content_type( $content_type )
{
$content_type = Utils::single_array( $content_type );
$content_type[] = Post::type( 'podcast' );
return $content_type;
}
/**
* If their is an enclosure on the post, add it to the feed
* @param $feed_entry. String. The entry as it will appear in the feed.
* @param $post. Post. The post that is providing the content for the feed entry.
*/
public function action_atom_add_post( $feed_entry, $post )
{
$info = $post->info->get_url_args();
foreach( $info as $key => $value ) {
if( is_array( $value ) && isset( $value['enclosure'] ) ) {
// create a url
$episode = URL::get( 'podcast_media', array( 'podcast_name' => $key, 'post_name' => $post->slug, 'method' => 'feed', 'filename' => rawurlencode( basename( $value['enclosure'] ) ) ) );
$enclosure = $feed_entry->addChild( 'link' );
$enclosure->addAttribute( 'rel', 'enclosure' );
$enclosure->addAttribute( 'href', $episode );
$enclosure->addAttribute( 'length', $value['size'] );
$enclosure->addAttribute( 'type', 'audio/mpeg' );
}
}
}
/**
* If their is an enclosure on the post, add it to the feed
* @param $feed_entry. String. The entry as it will appear in the feed.
* @param $post. Post. The post that is providing the content for the feed entry.
*/
public function action_rss_add_post( $feed_entry, $post )
{
$info = $post->info->get_url_args();
foreach( $info as $key => $value ) {
if( is_array( $value ) && isset( $value['enclosure'] ) ) {
// create a url
$episode = URL::get( 'podcast_media', array( 'podcast_name' => $key, 'post_name' => $post->slug, 'method' => 'feed', 'filename' => rawurlencode( basename( $value['enclosure'] ) ) ) );
$enclosure = $feed_entry->addChild( 'enclosure' );
$enclosure->addAttribute( 'url', $episode );
$enclosure->addAttribute( 'length', $value['size'] );
$enclosure->addAttribute( 'type', 'audio/mpeg' );
}
}
}
/**
* Respond to requests for posts for a specific podcast on the site
*
* @param array $handled. Boolean whether or not the request was handled
* @param $theme. Theme. the current theme in use
* @return boolean. Whether or not the request was handled
*/
public function filter_theme_act_display_podcasts( $handled, $theme )
{
$paramarray['fallback'] = array(
'podcast.multiple',
'entries.multiple',
'multiple',
'home',
);
$default_filters = array(
'content_type' => Post::type( 'podcast' ),
);
$paramarray['user_filters'] = $default_filters;
return $theme->act_display( $paramarray );
}
/**
* Generates the settings form for an iTunes feed
*
* @param ArrayIterator $it The current feed
*
*/
protected function itunes_options( $it )
{
$feed = $it->key();
$user = User::identify();
$options = Options::get( self::OPTIONS_PREFIX . "{$feed}_itunes" );
$ui = new FormUI( 'feed' );
$label = sprintf( _t( 'Edit %s iTunes Channel Settings', 'podcast' ), $feed );
$itunes = $ui->append( 'fieldset', 'itunes', $label );
$author = $itunes->append( 'text', 'author', 'null:null', _t( 'Podcast Author * : ', 'podcast' ) );
$author->value = $options['author'] ? $options['author'] : $user->displayname;
$author->add_validator( 'validate_required' );
$subtitle = $itunes->append( 'text', 'title', 'null:null', _t( 'Podcast Title: ', 'podcast' ) );
$subtitle->value = isset($options['title']) ? $options['title'] : Options::get( 'title' );
$subtitle = $itunes->append( 'text', 'subtitle', 'null:null', _t( 'Podcast Subtitle: ', 'podcast' ) );
$subtitle->value = $options['subtitle'] ? $options['subtitle'] : Options::get( 'tagline' );
$summary = $itunes->append( 'textarea', 'summary', 'null:null', _t( 'Podcast Summary * : ', 'podcast' ) );
$summary->value = $options['summary'] ? $options['summary'] : Options::get( 'tagline' );
$summary->add_validator( 'validate_required' );
$owner_name = $itunes->append( 'text', 'owner_name', 'null:null', _t( 'Podcast Owner Name * : ', 'podcast' ) );
$owner_name->value = $options['owner_name'] ? $options['owner_name'] : $user->displayname;
$owner_name->add_validator( 'validate_required' );
$owner_email = $itunes->append( 'text', 'owner_email', 'null:null', _t( 'Podcast Owner EMail: ', 'podcast' ) );
$owner_email->value = $options['owner_email'] ? $options['owner_email'] : $user->email;
$owner_email->add_validator( 'validate_email' );
$explicit = $itunes->append( 'select', 'explicit', 'null:null', _t( 'Content Rating: ', 'podcast' ) );
$explicit->options = $this->itunes_rating;
$explicit->value = isset( $options['explicit'] ) ? $this->itunes_rating[$options['explicit']] : $this->itunes_rating['No'];
$image = $itunes->append( 'text', 'image', 'null:null', _t( 'Podcast Artwork URL: ', 'podcast' ) );
$image->value = $options['image'] ? $options['image'] : '';
// $image->add_validator( 'validate_required' );
$main_category = $itunes->append( 'select', 'main_category', 'null:null', _t( 'Podcast Category * : ', 'podcast' ) );
$main_category->options = $this->itunes_categories;
$main_category->value = isset( $options['main_category'] ) ? array_search( $options['main_category'], $this->itunes_categories ) : 0;
$main_category->add_validator( 'validate_required' );
$category_2 = $itunes->append( 'select', 'category_2', 'null:null', _t( 'Podcast Category: ', 'podcast' ) );
$category_2->options = $this->itunes_categories;
$category_2->value = isset( $options['category_2'] ) ? array_search( $options['category_2'], $this->itunes_categories ) : 0;
$category_3 = $itunes->append( 'select', 'category_3', 'null:null', _t( 'Podcast Category: ', 'podcast' ) );
$category_3->options = $this->itunes_categories;
$category_3->value = isset( $options['category_3'] ) ? array_search( $options['category_3'], $this->itunes_categories ) : 0;
$block = $itunes->append( 'checkbox', 'block', 'null:null', _t( 'Block Podcast: ', 'podcast' ) );
$block->value = $options['block'] ? $options['block'] : 0;
$redirect = $itunes->append( 'text', 'redirect', 'null:null', _t( 'New podcast url: ' ) );
$ui->append( 'submit', 'submit', _t( 'Submit' ) );
$ui->on_success( array( $this, 'itunes_updated' ), $it );
$ui->out();
}
/**
* A callback function used by itunes_options
* to save the settings.
*
* @param FormUI $ui The form that is being saved
* @param ArrayIterator $it The feed for which the form was completed
*/
public function itunes_updated( $ui, $it )
{
$options = array(
'author' => $ui->author->value,
'title' => $ui->title->value,
'subtitle' => $ui->subtitle->value,
'summary' => $ui->summary->value,
'owner_name' => $ui->owner_name->value,
'owner_email' => $ui->owner_email->value,
'explicit' => $ui->explicit->value,
'image' => $ui->image->value,
'block' => $ui->block->value,
'main_category' => $this->itunes_categories[$ui->main_category->value],
'category_2' => $this->itunes_categories[$ui->category_2->value],
'category_3' => $this->itunes_categories[$ui->category_3->value],
'redirect' => $ui->redirect->value,
);
Options::set( self::OPTIONS_PREFIX . "{$it->key()}_itunes", $options );
Session::notice( "{$it->key()} iTunes options updated." );
}
/**
* Modify the publish form to include the iTunes settings for
* a specific post
*
* @param FormUI $form The form being modified
* @param Post $post The post being edited
* @param string $feed The name of the feed for which the form is being modified
*
*/
protected function post_itunes_form( $form, $post, $feed )
{
$postfields = $form->publish_controls->enclosures;
if( isset( $post->info->$feed ) ) {
$options = $post->info->$feed;
}
$control_id = md5( $feed );
$fieldname = "{$control_id}_player_settings";
$player = $postfields->append( 'fieldset', $fieldname, _t( 'Display Settings' ) );
$player->class = 'podcast-settings';
$fieldname = "show_player_{$control_id}";
$field = $player->append( 'checkbox', $fieldname, 'null:null', _t( 'Show player instead of link', 'podcast' ), 'tabcontrol_checkbox' );
$field->value = isset( $options['show_player'] ) ? $options['show_player'] : TRUE;
$fieldname = "show_download_{$control_id}";
$field = $player->append( 'checkbox', $fieldname, 'null:null', _t( 'Show download link under player', 'podcast' ), 'tabcontrol_checkbox' );
$field->value = isset( $options['show_download'] ) ? $options['show_download'] : TRUE;
$fieldname = "{$control_id}_settings";
$feed_fields = $postfields->append( 'fieldset', $fieldname, _t( 'Settings for ', 'podcast' ) . $feed );
$feed_fields->class = 'podcast-settings';
$fieldname = "enclosure_{$control_id}";
$customfield = $feed_fields->append( 'text', $fieldname, 'null:null', _t( 'Podcast Enclosure * :', 'podcast' ), 'tabcontrol_text' );
$customfield->value = isset( $options['enclosure'] ) ? $options['enclosure'] : '';
$customfield->add_validator( 'validate_required' );
$fieldname = "subtitle_{$control_id}";
$customfield = $feed_fields->append( 'text', $fieldname, 'null:null', _t( 'Subtitle:', 'podcast' ), 'tabcontrol_text' );
$customfield->value = isset( $options['subtitle'] ) ? $options['subtitle'] : '';
$fieldname = "explicit_{$control_id}";
$customfield = $feed_fields->append( 'select', $fieldname, 'null:null', _t( 'Content Rating:', 'podcast' ) );
$customfield->template = 'tabcontrol_select';
$customfield->options = $this->itunes_rating;
$customfield->value = isset( $options['rating'] ) ? $this->itunes_rating[array_search( $options['rating'], $this->itunes_rating )] : $this->itunes_rating['No'];
$fieldname = "summary_{$control_id}";
$customfield = $feed_fields->append( 'textarea', $fieldname, 'null:null', _t( 'Summary:', 'podcast' ), 'tabcontrol_textarea' );
$customfield->value = isset( $options['summary'] ) ? $options['summary'] : strip_tags(Format::summarize( Format::autop( $post->content ) ) );
$fieldname = "block_{$control_id}";
$customfield = $feed_fields->append( 'checkbox', $fieldname, 'null:null', _t( 'Block:', 'podcast' ), 'tabcontrol_checkbox' );
$customfield->value = isset( $options['block'] ) ? $options['block'] : 0;
}
/**
* Save the settings made in post_itunes_form
*
* @param Form $form The form to get the values from
* @param Post $post The post for which the values are being saved
* @param string $feed The name of the feed the values will be used in
*
*/
protected function get_post_itunes_settings( $form, $post, $feed )
{
$control_id = md5( $feed );
if( !strlen( $form->{"enclosure_{$control_id}"}->value ) ) {
return;
}
$options = array(
'enclosure' => $form->{"enclosure_{$control_id}"}->value,
'rating' => $form->{"explicit_{$control_id}"}->value,
'subtitle' => $form->{"subtitle_{$control_id}"}->value,
'summary' => $form->{"summary_{$control_id}"}->value,
'block' => $form->{"block_{$control_id}"}->value,
'show_player' => $form->{"show_player_{$control_id}"}->value,
'show_download' => $form->{"show_download_{$control_id}"}->value,
);
$mp3 = new MP3Info( $options['enclosure'] );
$result = $mp3->open();
if( $result ) {
$options['size'] = $mp3->get_size();
$options['duration'] = $mp3->format_minutes_seconds( $mp3->get_duration() );
}
else {
$options['size'] = 0;
$options['duration'] = 0;
}
$post->info->$feed = $options;
}
public function help()
{
return _t( "
If you are upgrading your Podcast plugin, it is recommended that you deactivate, then reactivate the plugin to set new default values. All your current feed settings will be preserved.
Usage
General
When Podcast is activated, it creates a new content type called, naturally enough, podcast. You will see a new menu item under the admin menu's 'New' submenu to create podcast posts, and a new menu item under the 'Manage' submenu to manage podcast posts.
Podcast has three main screens for configuration. Two of these, 'Manage Feeds' and 'Edit feed' are located on the plugins page of the admin area and are used to manage and edit your podcast feeds. The third is located on the post publish page and is reached by clicking the 'Enclosures' tab under the tags area when you are creating or editing a podcast post.
Manage Feeds
Podcast is able to create and maintain as many feeds as you wish, a capability you may know as category casting. To create or delete a podcast feed use this configuration form.
- Navigate to the Plugins page of the admin area.
- Select 'Manage Feeds' from the Podcast dropdown menu. The feed management form will open up. To create a new feed
- type in the feed's name in the top edit box
- select the feed type from the next select box
- click the 'Save' button. Currently iTunes is the only feed type available.
To delete a feed you no longer want
- uncheck the feed you want to delete at the bottom of the form.
click the 'Save' button.
Edit feed
Once you have created a feed, a new option will be added to the Podcast plugin's dropdown menu, 'Edit name_of_feed feed'. There will be a menu item added for each feed you create. Several items are required. Their labels have an asterisk ( * ) at the end. Without filling in these items, your changes will not be saved. To edit a feed's options
- Navigate to the Plugins page of the admin area.
- Select 'Edit name_of_feed feed' from the Podcast dropdown menu. A configuration form for the selected feed will open up. The options in the form will relate to the type of feed you are creating. For now, this means iTunes feed options. For iTunes the following options are available:
- Podcast Author - defaults to the current user's display name
- Podcast Subtitle - defaults to the blog's tagline
- Podcast Summary = defaults to the blog's tagline
- Podcast Owner Name - defaults to the current user's display name
- Podcast Owner Email = defaults to the current user's email
- Content Rating - defaults to 'No Rating'.
- Podcast Artwork URL - enter the url for the artwork to supply to iTunes. These needs to be an image no larger than 300 x 300 pixels
- Podcast Category - Choose the appropriate categories from the select boxes. You need to select at least one, and can have up to three
- Block Podcast - defaults to unchecked. Do not check this unless you want to block your podcast from iTunes
- New podcast url - if you move your feed to a new url, you need to notify iTunes. do so by entering the new url in this field
When you are done making the changes you desire, click the \'Save\' button. A message will pop up in the messages area of the admin to notify you when you have successfully edited the feed options.
Creating and Editing a Podcast Post
After you have the feed set up, you are ready to begin creating posts for your podcast. To do so select New->Podcast from the admin's main menu. You will be taken to a publish page that, for the most part, is like a normal entry's publish page. Write a post as you normally would, complete with title, content, and tags, then you'll be ready to add the podcast specific items. If you have uploaded you audio files to a directory accessible to the Habari media silo, you'll find your work is much easier.
1. Click on the location in your post where you want the podcast player to appear, then open the Habari silo and navigate to the directory containing your audio file. While audio files currently don't have an associated icon, you'll see their title's listed, and will note that underneath each a menu item has been added that says 'add to name_of_feed'. Click the 'add to ..' item to insert a link to the file in your post where you last had the cursor. The link added will have the format
<a href=\"http://url/path/to/file/filename.mp3\" rel=\"enclosure\"<filename.mp3</a>>
Note: There are two important points here. First, the link must have the rel=\"enclosure\" attribute. The Podcast plugin relies on this when determining what links to replace with a player. Second, if your audio files are hosted externally, you won't be able to use the silo and will have to enter this link by hand.
If you have more than one feed, you can use a post in as many of them as you like. You can either add the same audio file for each feed, or add more than one audio file to the post in the position you desire, with whichever feeds you want. Having more than one audio file in a post won't interfere with the individual feeds. Each will contain only the appropriate audio file. However, in the post as viewed on your blog, a player will appear for each feed and each file. Please note that the last link entered for each feed from the Habari silo in this manner will be the only one to be added to the actual podcast feed.
2. Click the 'Enclosures' tab underneath the tags area. A form will open containing the options for the player display settings and for each indivdual feed that you have created for your site, one set of feed options after the other. For the display settings the options include
- Show player instead of link - Checked by default. Uncheck to not show a player for the podcast in your post. Instead, a link to download the podcast will be shown.
- Show download link under player - Uncheck to not show a download link for the podcast if a player is shown for it.
For iTunes feeds the settings include
- Podcast Enclosure - this is the name of the audio file you are using for the feed. If you placed the file in the post with the Habari silo, this will have been automatically filled in for you. If not, enter it manually, being sure to enter a fully qualified url. This is the only required item.
- Subtitle - if you want the post to have a subtitle, enter it here
- Content Rating - this defaults to 'No Rating'. use this setting to override the feed rating for that particular post
- Summary - if you wish to have a summary for the post, enter it here
- Block - if you wish to block a particular post from iTunes, check this item
If the post is being added to more than one feed, continue on to make desired changes for each feed. After you are completely done, click the 'Save' button to save the post as a draft or to save any changes to an already published post, or click the 'Publish' button to publish the post. When you do so, the Podcast plugin will add any tags for the post to its iTunes keywords, calculate the length of the audio file for each feed, and calculate the running time for each audio file. These calculations can cause Podcast posts to take a little longer to save than regular entries, especially if the audio files are hosted on an external server.
Note: If you haven't set up a feed, there will be no links in the Habari media silo to insert a podcast into a post. Nor will there be any controls under the Enclosures tab to set information regarding the podcast's enclosures. There will only appear text directing you to create a feed.
Accessing Podcasts From Your Site
The Podcast plugin makes several changes to your blog
- Home page - Podcast posts show up on your home page intermixed with regular entries.
- Multiple post archives - Podcast posts show up in your tag urls intermixed with regular entries.
- Podcast urls - Podcasts are accessible by using an archive url of the form http://yoursite.com/podcast/name_of_podcast. This will contain only posts that have been assigned to the named podcast.
- Feed urls - Podcast feeds are accessible by using a url of the form http://yoursite.com/podcast/name_of_podcast/rss for an RSS-2 feed. The feed will contain only feed item versions of posts that have been assigned to the named podcast.
Podcast Templates
Podcast comes with four templates one each for an individual podcast post and for multiple podcast post pages, for both the rawphpengine and the hiengine. These will probably not fit with the theme of your blog, so it is recommended that you copy them to your theme directory and modify them as needed.
The Players
Podcast provides two flash players, the nifty player and the slim version of the xspf player. It uses the chosen player to enable playing podcast audio files on your site. When a podcast post is viewed, the plugin searches it's content and replaces all links with the rel=\"enclosure\" attribute with a player and a link to download the file. Thus, if you have multiple audio file links in the post, a separate player will be embedded for each of them.
To configure the players
- Select 'Configure Players' from Podcast's droplist on the plugin page of the admin area.
- Choose which player you wish to use. The default is the niftyplayer.
- Set the options for the selected player. For both players you can set the height and width. The default values are reasonable for most sites. For the niftyplayer you can set the background color to more closely match your site using hex RGB colors. A hex RGB color consists of 6 digits. The left two denote the degree of red, the middle two the degree of green, and the right two the degree of blue. Each digit is a hexadecimal numeral from 0 - F. The default results in a white background.
Uninstallation
- Got to the plugins page of your Habari admin panel.
- Click on the Deactivate button.
- Delete the Podcast directory from your user/plugins directory.
", 'podcast' );
}
}
?>