ampache/modules/plugins/Lastfm.plugin.php

<?php
/*

 Copyright (c) 2001 - 2007 Ampache.org
 All rights reserved.

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License v2
 as published by the Free Software Foundation.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

class AmpacheLastfm { 

	public $name		='Last.FM'; 
	public $description	='Records your played songs to your Last.FM Account'; 
	public $url		='';
	public $version		='000003';
	public $min_ampache	='340007';
	public $max_ampache	='340008';

	// These are internal settings used by this class, run this->load to 
	// fill em out
	private $username; 
	private $password; 
	private $hostname;
	private $port; 
	private $path; 
	private $challenge;

	/**
	 * Constructor
	 * This function does nothing...
	 */
	public function __construct() { 

		return true; 

	} // PluginLastfm

	/**
	 * install
	 * This is a required plugin function it inserts the required preferences
	 * into Ampache
	 */
	public function install() { 

		Preference::insert('lastfm_user','Last.FM Username',' ','25','string','options'); 
		Preference::insert('lastfm_pass','Last.FM Password',' ','25','string','options'); 
		Preference::insert('lastfm_port','Last.FM Submit Port',' ','25','string','internal'); 
		Preference::insert('lastfm_host','Last.FM Submit Host',' ','25','string','internal'); 
		Preference::insert('lastfm_url','Last.FM Submit URL',' ','25','string','internal'); 
		Preference::insert('lastfm_challenge','Last.FM Submit Challenge',' ','25','string','internal'); 

	} // install

	/**
	 * uninstall
	 * This is a required plugin function it removes the required preferences from
	 * the database returning it to its origional form
	 */
	public function uninstall() { 

		/* We need to remove the preivously added preferences */
		$sql = "DELETE FROM `preference` WHERE `name`='lastfm_pass' OR `name`='lastfm_user' " . 
			"OR `name`='lastfm_url' OR `name`='lastfm_host' OR `name`='lastfm_port' OR `name`='lastfm_challenge'"; 
		$db_results = Dba::query($sql);

	} // uninstall

	/**
	 * submit
	 * This takes care of queueing and then submiting the tracks eventually this will make sure
	 * that you've haven't
	 */
	public function submit($song,$user_id) { 

		// Before we start let's pull the last song submited by this user
		$previous = Stats::get_last_song($user_id); 

		$diff = time() - $previous['date']; 
		
		// Make sure it wasn't within the last min
		if ($diff < 60) { 
			debug_event('LastFM','Last song played within ' . $diff . ' seconds, not recording stats','3'); 
			return false; 
		} 

		if ($song->time < 30) { 
			debug_event('LastFM','Song less then 30 seconds not queueing','3'); 
			return false; 
		} 
		
		// Create our scrobbler with everything this time and then queue it
		$scrobbler = new scrobbler($this->username,$this->password,$this->hostname,$this->port,$this->path,$this->challenge); 
		if (!$scrobbler->queue_track($song->f_artist_full,$song->f_album_full,$song->title,time(),$song->time,$song->track)) { 
			return false; 
		} 
		
		// Go ahead and submit it now	
		if (!$scrobbler->submit_tracks()) { 
			debug_event('LastFM','Error Submit Failed: ' . $scrobbler->error_msg,'3'); 
			return false; 
		}
		
		return true; 

	} // submit

	/** 
	 * set_handshake
	 * This runs a handshake and properly updates the preferences as needed, it returns the data
	 * as an array so we don't have to requery the db. This requires a userid so it knows who's 
	 * crap to update
	 */
	public function set_handshake($user_id) { 
	
		$scrobbler = new scrobbler($this->username,$this->password); 
		$data = $scrobbler->handshake(); 

		if (!$data) { 
			debug_event('LastFM','Handshake Failed: ' . $scrobbler->error_msg,'3'); 
			return false; 
		} 

		$this->hostname = $data['submit_host']; 
		$this->port = $data['submit_port']; 
		$this->path = $data['submit_url']; 
		$this->challenge = $data['challenge']; 

                // Update the preferences
                Preference::update('lastfm_port',$user_id,$data['submit_port']);
                Preference::update('lastfm_host',$user_id,$data['submit_host']);
                Preference::update('lastfm_url',$user_id,$data['submit_url']);
                Preference::update('lastfm_challenge',$user_id,$data['challenge']);

		return true; 

	} // set_handshake

	/**
	 * load
	 * This loads up the data we need into this object, this stuff comes from the preferences
	 * it's passed as a key'd array
	 */
	public function load($data,$user_id) { 

		if (isset($data['lastfm_user'])) { 
			$this->username = $data['lastfm_user']; 
		} 
		else { 
			return false; 
		} 
		if (isset($data['lastfm_pass'])) { 
			$this->password = $data['lastfm_pass']; 
		} 
		else { 
			return false; 
		} 

		// If we don't have the other stuff try to get it before giving up
		if (!$data['lastfm_host'] || !$data['lastfm_port'] || !$data['lastfm_url'] || !$data['lastfm_challenge']) { 
			debug_event('LastFM','Running Handshake, missing information','3'); 
			if (!$this->set_handshake($user_id)) { 
				debug_event('LastFM','Handshake failed, you lose','3');
				return false; 
			} 
		}  
		else { 
	                $this->hostname = $data['lastfm_host'];
	                $this->port = $data['lastfm_port'];
	                $this->path = $data['lastfm_url'];
	                $this->challenge = $data['lastfm_challenge'];
		} 
		

		return true; 	

	} // load


} // end AmpacheLastfm
?>