gnufm/gnukebox/scrobble-utils.php

<?php

/* GNUkebox -- a free software server for recording your listening habits

   Copyright (C) 2009 Free Software Foundation, Inc

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   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 Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

require_once('database.php');	// include the database connection string
require_once('temp-utils.php');

function useridFromSID($session_id) {
	//derive the username from a session ID
	global $adodb; 	   // include the Database connector

	// Delete any expired session ids
	$adodb->Execute('DELETE FROM Scrobble_Sessions WHERE expires < ' . time());

	try {
		$res = $adodb->GetOne('SELECT userid FROM Scrobble_Sessions WHERE sessionid = ' . $adodb->qstr($session_id)); // get the username from the table
	} catch (Exception $e) {
		die('FAILED ufs ' . $e->getMessage() . '\n');
		// die is there is an error, printing the error
	}

	if (!$res) {
		die("BADSESSION\n");
		// the user has no session
	}

	return $res;
	// return the first user
}

function createArtistIfNew($artist) {
	global $adodb;

	$id = $adodb->GetOne('SELECT id FROM Artist WHERE lower(name) = lower(' . $artist . ')');

	if (!$id) {
		// Artist doesn't exist, so we create them
		$res = $adodb->Execute('INSERT INTO Artist (name) VALUES (' . $artist . ')');
	}
}

function createAlbumIfNew($artist, $album) {
	global $adodb;

	$id = $adodb->GetOne('SELECT id FROM Album WHERE lower(name) = lower(' . $album . ') AND lower(artist_name) = lower(' . $artist . ')');

	if (!$id) {
		// Album doesn't exist, so create it

		// First check if artist exist, if not create it
		createArtistIfNew($artist);

		// Disable to fix scrobble breakage
		//$art = $adodb->qstr(getAlbumArt($artist, $album));
		$art = '';

		if ($art != '') {
			$license = $adodb->qstr('amazon');
			$sql = 'INSERT INTO Album (name, artist_name, image, artwork_license) VALUES (' . $album . ', ' . $artist . ', ' . $art . ', ' . $license .')';
		} else {
			$sql = 'INSERT INTO Album (name, artist_name) VALUES (' . $album . ', ' . $artist . ')';
		}
		$adodb->Execute($sql);
	}
}

function getTrackCreateIfNew($artist, $album, $track, $mbid) {
	global $adodb;

	if ($album != 'NULL') {
		$res = $adodb->GetOne('SELECT id FROM Track WHERE name = ' . $track . ' AND artist_name = ' . $artist . ' AND album_name = ' . $album);
	} else {
		$res = $adodb->GetOne('SELECT id FROM Track WHERE name = ' . $track . ' AND artist_name = ' . $artist . ' AND album_name IS NULL');
	}

	if (!$res) {
		// First check if artist and album exists, if not create them
		if ($album != 'NULL') {
			createAlbumIfNew($artist, $album);
		} else {
			createArtistIfNew($artist);
		}
		
		// Create new track
		$res = $adodb->Execute('INSERT INTO Track (name, artist_name, album_name, mbid) VALUES ('
			. $track . ', '
			. $artist . ', '
			. $album . ', '
			. $mbid . ')');
		return getTrackCreateIfNew($artist, $album, $track, $mbid);
	} else {
		return $res;
	}
}

function getScrobbleTrackCreateIfNew($artist, $album, $track, $mbid) {
	global $adodb;

	$res = $adodb->GetOne('SELECT id FROM Scrobble_Track WHERE name = lower('
		. $track . ') AND artist = lower(' . $artist . ') AND album '
		. (($album == 'NULL') ? 'IS NULL' : ('= lower(' . $album . ')')) . ' AND mbid '
		. (($mbid == 'NULL') ? 'IS NULL' : ('= lower(' . $mbid . ')')));

	if (!$res) {
		// First check if track exists, if not create it
		$tid = getTrackCreateIfNew($artist, $album, $track, $mbid);

		$sql = 'INSERT INTO Scrobble_Track (name, artist, album, mbid, track) VALUES ('
			. 'lower(' . $track . '), '
			. 'lower(' . $artist . '), '
			. (($album == 'NULL') ? 'NULL' : 'lower(' . $album . ')') . ', '
			. (($mbid == 'NULL') ? 'NULL' : 'lower(' . $mbid . ')') . ', '
			. $tid . ')';
		$res = $adodb->Execute($sql);
		return getScrobbleTrackCreateIfNew($artist, $album, $track, $mbid);
	} else {
		return $res;
	}
}

function scrobbleExists($userid, $artist, $track, $time) {
	global $adodb;

	$res = $adodb->GetOne('SELECT time FROM Scrobbles WHERE userid = ' . $userid . ' AND artist = ' . $artist . ' AND track = ' . $track . ' AND time = ' . $time);

	if (!$res) {
		return false;
	} else {
		return true;
	}
}

function noSpamTracks($track) {

	// This function exists to remove things like '(PREVIEW: buy it at www.magnatune.com)' from track names.
	$track = str_replace(' (PREVIEW: buy it at www.magnatune.com)', '', $track);
	return $track;

}

function getAlbumArt($artist, $album) {

	$Access_Key_ID = '1EST86JB355JBS3DFE82'; // this is mattl's personal key :)

	$SearchIndex = 'Music';
	$Keywords = rawurlencode($artist . ' ' . $album);
	$Operation = 'ItemSearch';
	$Version = '2007-07-16';
	$ResponseGroup = 'ItemAttributes,Images';
	$request = 'http://ecs.amazonaws.com/onca/xml'
		. '?Service=AWSECommerceService'
		. '&AssociateTag=' . $Associate_tag
		. '&AWSAccessKeyId=' . $Access_Key_ID
		. '&Operation=' . $Operation
		. '&Version=' . $Version
		. '&SearchIndex=' . $SearchIndex
		. '&Keywords=' . $Keywords
		. '&ResponseGroup=' . $ResponseGroup;

	$aws_xml = simplexml_load_file($request) or die('xml response not loading\n');

	$image = $aws_xml->Items->Item->MediumImage->URL;
	$URI = $aws_xml->Items->Item->DetailPageURL;
	return $image;
}

function validateMBID($input) {
	if (isset($input)) {
		$input = strtolower(rtrim($input));
		if (preg_match('/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/', $input)) {
			return $input;
		} else {
			return null;
		}
	} else {
		return null;
	}

}

/**
 * Sends a scrobble on to any other services the user has connected to their account
 */
function forwardScrobble($userid, $artist, $album, $track, $time, $mbid, $source, $rating, $length) {
	global $adodb, $lastfm_key, $lastfm_secret;

	$artist = rawurlencode($artist);
	$track = rawurlencode($track);
	$album = rawurlencode($album);
	$mbid = rawurlencode($mbid);
	$source = rawurlencode($source);
	$rating = rawurlencode($rating);
	$length = rawurlencode($length);

	$res = $adodb->CacheGetAll(600, 'SELECT * FROM Service_Connections WHERE userid = ' . $userid . ' AND forward = 1');
	foreach ($res as &$row) {
		$remote_key = $row['remote_key'];
		$ws_url = $row['webservice_url'];
		$curl_session = curl_init($ws_url);

		$post_vars = '';
		if ($album) {
			$post_vars .= 'album[0]=' . $album . '&';
		}
		$post_vars .= 'api_key=' . $lastfm_key . '&artist[0]=' . $artist;
		if ($length) {
			$post_vars .= '&length[0]=' . $length;
		}
		if ($mbid) {
			$post_vars .= '&mbid[0]=' . $mbid;
		}
		$post_vars .= '&method=track.scrobble';
		if ($rating) {
			$post_vars .= '&rating[0]=' . $rating;
		}
		$post_vars .= '&sk=' . $remote_key;
		if ($source) {
			$post_vars .= '&source[0]='. $source;
		}
		$post_vars .= '&timestamp[0]=' . $time . '&track[0]=' . $track;

		$sig = urldecode(str_replace('&', '', $post_vars));
		$sig = str_replace('=', '', $sig);
		$sig = md5($sig . $lastfm_secret);

		$post_vars .= '&api_sig=' . $sig;
		curl_setopt($curl_session, CURLOPT_POST, true);
		curl_setopt($curl_session, CURLOPT_POSTFIELDS, $post_vars);
		curl_setopt($curl_session, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($curl_session, CURLOPT_CONNECTTIMEOUT, 1);
		curl_setopt($curl_session, CURLOPT_TIMEOUT, 1);
		$response = curl_exec($curl_session);

		curl_close($curl_session);
	}
}