Last.fm tracks in a customizable format. Author: Collin Allen Author URI: http://www.command-tab.com */ /* Copyright (c) 2010 Collin Allen, http://www.command-tab.com/ 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. */ // Display last.fm tracks, no duplicates, none without "large" artwork function fmtuner() { if (function_exists('simplexml_load_string') && function_exists('file_put_contents')) { // Fetch options from WordPress DB and set up variables $iCacheTime = get_option('fmtuner_update_frequency'); $sCachePath = get_option('fmtuner_cachepath'); $iTrackLimit = get_option('fmtuner_track_limit'); $iTrackLimitWithBuffer = $iTrackLimit + 15; // Grab extra in case some albums don't have artwork $sBaseUrl = 'http://ws.audioscrobbler.com/2.0/?method='; $sMethod = get_option('fmtuner_track_type'); $sUsername = get_option('fmtuner_username'); $sApiKey = 'ff0eaca3b7e2660755d6c652af7b0489'; $sDisplayFormat = get_option('fmtuner_display_format'); $sApiUrl = "{$sBaseUrl}{$sMethod}&user={$sUsername}&api_key={$sApiKey}&limit={$iTrackLimitWithBuffer}"; // Check if we're using images or not $bUsingImages = false; if (strpos($sDisplayFormat, '[::image::]') === false) $bUsingImages = false; else $bUsingImages = true; // Run only if a username is set if ($sUsername) { // If the cached XML exists on disk if (file_exists($sCachePath)) { // Compare file modification time against update frequency if (time() - filemtime($sCachePath) > $iCacheTime) { // Cache miss $sTracksXml = fmtuner_fetch($sApiUrl); file_put_contents($sCachePath, $sTracksXml); } else { // Cache hit $sTracksXml = file_get_contents($sCachePath); } } else { // Fetch the XML for the first time $sTracksXml = fmtuner_fetch($sApiUrl); file_put_contents($sCachePath, $sTracksXml); } // Parse the XML $xTracksXml = simplexml_load_string($sTracksXml); $aTracks = array(); $iTotal = 1; // If we have any parsed tracks if ($xTracksXml) { // Switch based on selected track type switch($sMethod) { case 'user.getlovedtracks': $xTracks = $xTracksXml->lovedtracks->track; break; case 'user.getrecenttracks': $xTracks = $xTracksXml->recenttracks->track; break; case 'user.gettoptracks': $xTracks = $xTracksXml->toptracks->track; break; default: $xTracks = $xTracksXml->lovedtracks->track; break; } // Loop over each track, outputting it in the desired format foreach($xTracks as $oTrack) { // If we want to use images, but the current $oTrack has no big image, skip it if ($bUsingImages && $oTrack->image[2] == '') continue; // 'Recent tracks' node has no child node, while other methods do. // Sort it out and get the artist name into $sArtist if ($sMethod == 'user.getrecenttracks') $sArtist = $oTrack->artist; else $sArtist = $oTrack->artist->name; // Store each track in $aTracks, and check it every iteration so as not to output duplicates $sKey = $sArtist . ' - ' . $oTrack->name; // If the current track is not in $aTracks and we haven't hit the track limit if (!in_array($sKey, $aTracks) != "" && $iTotal <= $iTrackLimit) { // Shove the current track into $aTracks to be checked for next time around $aTracks[] = $sKey; // Dump out the blob of HTML with data embedded $aTags = array( '/\[::album::\]/', '/\[::artist::\]/', '/\[::image::\]/', '/\[::number::\]/', '/\[::title::\]/', '/\[::url::\]/' ); $aData = array( $oTrack->album, $sArtist, $oTrack->image[2], $iTotal, $oTrack->name, (strpos($oTrack->url, 'http') === 0) ? $oTrack->url : 'http://' . $oTrack->url ); // Clean up data, prevent XSS, etc. foreach ($aData as $iKey => $sValue) $aData[$iKey] = trim(strip_tags(htmlspecialchars($sValue))); // Merge $aTags and $aData echo preg_replace($aTags, $aData, $sDisplayFormat); // Increment the counter so we can check the track limit next time around $iTotal++; } } // end foreach loop } // end if (any parsed tracks) } else { echo 'Please set fmTuner options in your WordPress administration panel.'; } // end if (username) } else { echo 'fmTuner requires PHP version 5 or greater. Please contact your web host for more information.'; } // end PHP5 check } // end fmtuner() // Fetch a given URL using file_get_contents or cURL function fmtuner_fetch($sUrl) { // Check if file_get_contents will work if ( ini_get('allow_url_fopen') && function_exists('file_get_contents') && $sUrl ) { // Use file_get_contents return file_get_contents($sUrl); } elseif ( function_exists('curl_init') && $sUrl ) { // Fall back to cURL $hCurl = curl_init(); $iTimeout = 5; curl_setopt($hCurl, CURLOPT_URL, $sUrl); curl_setopt($hCurl, CURLOPT_RETURNTRANSFER, 1); curl_setopt($hCurl, CURLOPT_CONNECTTIMEOUT, $iTimeout); $sFileContents = curl_exec($hCurl); curl_close($hCurl); return $sFileContents; } else { return false; } } // Add default options to the DB function add_fmtuner_options() { add_option('fmtuner_cachepath', dirname(__FILE__).'/fmtuner_cache.xml'); // Default cache location add_option('fmtuner_username', ''); // Default to '' add_option('fmtuner_track_type', 'user.getrecenttracks'); // Default to 'Recent Tracks' add_option('fmtuner_update_frequency', 3600); // Default to 'Every hour' add_option('fmtuner_track_limit', 2); // Default to max of 2 tracks add_option('fmtuner_display_format', '

[::artist::] - [::title::] [::title::] by [::artist::]

[::title::] by [::artist::]

'); // Default format } // Delete the cache file and options stored in the DB function delete_fmtuner_options() { $sCachePath = get_option('fmtuner_cachepath'); if (file_exists($sCachePath)) unlink($sCachePath); delete_option('fmtuner_cachepath'); delete_option('fmtuner_username'); delete_option('fmtuner_track_type'); delete_option('fmtuner_update_frequency'); delete_option('fmtuner_track_limit'); delete_option('fmtuner_display_format'); } // Add the options page to the admin area under Settings when called function setup_fmtuner_options() { add_options_page('fmTuner Settings', 'fmTuner', 1, __FILE__, 'fmtuner_options'); } // Add a Settings link to the plugin actions list function setup_fmtuner_settings_link($aActionLinks) { $sSettingsLink = 'Settings'; array_unshift($aActionLinks, $sSettingsLink); return $aActionLinks; } // Hook into WordPress to add a Settings link add_filter('plugin_action_links_' . plugin_basename(__FILE__), 'setup_fmtuner_settings_link'); // Register fmTuner plugin activation/deactivation hooks register_activation_hook(__FILE__, 'add_fmtuner_options'); register_deactivation_hook(__FILE__, 'delete_fmtuner_options'); // Hook into WordPress to call setup_fmtuner_options() when the admin menu is loaded add_action('admin_menu', 'setup_fmtuner_options'); // Display the options page in wp-admin function fmtuner_options() { ?>

fmTuner requires PHP version 5 or greater. Please contact your web host for more information.

fmTuner Settings

Last.fm Username	Enter your Last.fm username
Track Type	class="tog" value="user.getrecenttracks" name="fmtuner_track_type" /> Recent tracks class="tog" value="user.getlovedtracks" name="fmtuner_track_type" /> Loved tracks class="tog" value="user.gettoptracks" name="fmtuner_track_type" /> Top tracks
Track Limit	Show tracks at most.
Update Frequency
Display Format	The fmTuner tags below can be used among standard HTML to customize the album display format. Tags can be used more than once, or completely left out, depending on your preferences. The block of code you design below will be used for each track, so put other non-track-related code around your fmTuner call: <?php if(function_exists('fmtuner')) { fmtuner(); } ?> `[::album::]` Album name (Only available for Recent tracks.) `[::artist::]` Artist name `[::image::]` Album artwork address (Usually ~120 pixels in size — may not be square. If used, only tracks with artwork will be shown.) `[::number::]` Track number within the fmTuner set (e.g. for a numbered list) `[::title::]` Track title `[::url::]` Last.fm track address <?php echo get_option('fmtuner_display_format'); ?>