gnufm/nixtape/data/Album.php

<?php

/* GNU FM -- a free network service for sharing your music 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($install_path . '/database.php');
require_once($install_path . '/data/Artist.php');
require_once($install_path . '/data/Track.php');
require_once($install_path . '/data/Tag.php');
require_once($install_path . '/utils/resolve-external.php');
require_once($install_path . '/utils/linkeddata.php');

/**
 * Represents album data
 *
 * General album attributes are accessible as public variables.
 * Lists of tracks are only generated when requested.
 */
class Album {

	public $name, $artist_name, $mbid, $releasedate, $image;
	public $id;

	/**
	 * Album constructor
	 *
	 * @param string name The name of the album to load
	 * @param string artist The name of the artist who recorded this album
	 */
	function __construct($name, $artist) {
		global $adodb;
		$adodb->SetFetchMode(ADODB_FETCH_ASSOC);
		$this->query = 	'SELECT name, artist_name, mbid, image, releasedate FROM Album WHERE '
			. 'lower(name) = lower(' . $adodb->qstr($name) . ') AND '
			. 'lower(artist_name) = lower(' . $adodb->qstr($artist) . ')';
		$r = $adodb->CacheGetRow(1200, $this->query);
		if (!$r) {
			throw new Exception('No such album: ' . $name);
		} else {
			$row = sanitize($r);
			$this->name = $row['name'];
			$this->mbid = $row['mbid'];
			$this->artist_name = $row['artist_name'];
			$this->releasedate = $row['releasedate'];
			$this->image = resolve_external_url($row['image']);

			$this->id = identifierAlbum(null, $this->artist_name, null, $this->name, null, null, null, $this->mbid);

			$this->track_query = 'SELECT name, artist_name FROM Track WHERE artist_name = '
				. $adodb->qstr($this->artist_name) . ' AND album_name = '
				. $adodb->qstr($this->name);

			if ($this->image == '') {
				$this->image = false;
			}
		}

	}

	/**
	 * Create a new Album
	 *
	 * @param string $name The name of the album
	 * @param string $artist_name The name of the artist who recorded this album
	 * @param string $image The URL to this album's cover image (optional)
	 * @return Album Album object corresponding to the newly created album
	 */
	public static function create($name, $artist_name, $image = '') {
		global $adodb;

		$adodb->Execute('INSERT INTO Album (name, artist_name, image) VALUES ('
			. $adodb->qstr($name) . ', '
			. $adodb->qstr($artist_name) . ', '
			. $adodb->qstr($image) . ')');

		try {
			$artist = new Artist($artist_name);
			$artist->clearAlbumCache();
		} catch (Exception $e) {
			// No such artist.
		}

		return new Album($name, $artist_name);
	}

	/**
	 * Clears the track cache
	 */
	function clearTrackCache() {
		global $adodb;
		$adodb->CacheFlush($this->track_query);
	}

	/**
	 * Clear the cache of the album information
	 */
	function clearCache() {
		global $adodb;
		$adodb->CacheFlush($this->query);
	}

	/**
	 * Retrieves total play count for all tracks on this album
	 * 
	 * @return int Number of plays
	 */
	function getPlayCount() {
		global $adodb;
		$adodb->SetFetchMode(ADODB_FETCH_ASSOC);
		try {
		$count = $adodb->CacheGetOne(600,
			'SELECT COUNT(*) AS scrobbles FROM Scrobbles JOIN Track ON Scrobbles.track = Track.name WHERE Scrobbles.artist = '
			. $adodb->qstr($this->artist_name) . ' AND Track.album_name ='
			. $adodb->qstr($this->name));
		} catch (Exception $e) {
			reportError($res->getMessage());
			$c = 0;
		}
		if (!$count) {
			$c = 0;
		} else {
			$c = $count;
		}
		return $c;
	}

	/**
	 * Retrieves all the tracks in an album
	 *
	 * @return array Track objects
	 */
	function getTracks() {
		global $adodb;
		$adodb->SetFetchMode(ADODB_FETCH_ASSOC);
		$res = $adodb->CacheGetAll(600, $this->track_query);
		foreach ($res as &$row) {
			$tracks[] = new Track($row['name'], $row['artist_name']);
		}

		return $tracks;
	}

	/**
	 * Gives the URL for this album
	 *
	 * @return string The URL of this album
	 */
	function getURL() {
		return Server::getAlbumURL($this->artist_name, $this->name);
	}

	/**
	 * Gives the URL for managers to add a new track to this album
	 *
	 * @return string The URL for adding tracks to this album
	 */
	function getAddTrackURL() {
		return Server::getAddTrackURL($this->artist_name, $this->name);
	}

	/**
	 * Get the top tags for this album, ordered by tag count
	 *
	 * @param int $limit The number of tags to return (default is 10)
	 * @param int $offset The position of the first tag to return (default is 0)
	 * @param int $cache Caching period of query in seconds (default is 600)
	 * @return array Tag details ((tag, freq) .. )
	 */
	function getTopTags($limit=10, $offset=0, $cache=600) {
		return Tag::_getTagData($cache, $limit, $offset, null, $this->artist_name, $this->name);
	}

	/**
	 * Get a specific user's tags for this album.
	 *
	 * @param int $userid Get tags for this user
	 * @param int $limit The number of tags to return (default is 10)
	 * @param int $offset The position of the first tag to return (default is 0)
	 * @param int $cache Caching period of query in seconds (default is 600)
	 * @return array Tag details ((tag, freq) .. )
	 */
	function getTags($userid, $limit=10, $offset=0, $cache=600) {
		if(isset($userid)) {
			return Tag::_getTagData($cache, $limit, $offset, $userid, $this->artist_name, $this->name);
		}
	}

	/**
	 * Set the cover art for this artist.
	 *
	 * @param string $image The URL of the image to use.
	 */
	function setImage($image) {
		global $adodb;
		$adodb->Execute('UPDATE Album SET image=' . $adodb->qstr($image) 
			. ' WHERE artist_name = ' . $adodb->qstr($this->artist_name)
			. ' AND name = ' . $adodb->qstr($this->name));
		$this->clearCache();
	}

	function getEditURL() {
		return Server::getAlbumEditURL($this->artist_name, $this->name);
	}

	/**
	 * Return Album Art URL from Wikipedia
	 *
	 * @deprecated mb_convert_case fails and wikipedia returns 403. 20120307 kabniel
	 *
	 * @param string $album_name Album name
	 * @param string $artist_name Artist name
	 * @param bool $save Save info to Album table.
	 * @param string $api_url Wikipedia API URL
	 * @return array An object with the url and usage_url properties
	 */
	function WikipediaAlbumArt ($album_name, $artist_name, $save = false, $api_url = 'http://en.wikipedia.org/w/api.php') {
		global $adodb;
		/*
		 * Search query string
		 */
		$album_name  = mb_convert_case($album_name, 'UTF-8');
		$artist_name = mb_convert_case($artist_name, 'UTF-8');
		$get_params  = array(
			'action'    => 'query',
			'format'    => 'php',
			'redirects' => true,
			'list'      => 'search',
			'srsearch'  => "$album_name $artist_name album",
			'srlimit'   => 10
		);

		try {
			if (is_null($album_name)) {
				throw new Exception('No album name provided.');
			}

			$search_url = $api_url . '?' . http_build_query($get_params);

			$open = fopen($search_url, 'r');

			if ($open == false) {
				throw new Exception('Can\'t open Search URL');
			}

			$search_results = unserialize(stream_get_contents($open));
			fclose($open);

			if (!isset($search_results['query']['search']) || count($search_results['query']['search']) == 0) {
				return false;
			}

			$results = array();

			foreach ($search_results['query']['search'] as $id => $page) {
				switch ($page['title']) {
				case $album_name:
					$weight = 0.5;
					break;
				case "$album_name (album)":
					$weight = 0.75;
					break;
				case "$album_name ($artist_name album)":
					$weight = 1;
					break;
				default:
					$weight = 0;
				}

				if ($weight > 0) {
					$results[$page['title']] = $weight;
				}
			}

			if (count($results) > 0) {
				# order by weight
				# highest gets on bottom
				asort($results);
				end($results);
				$possible_cover = key($results);

				# Cover search query string
				$cover_params = array(
					'action'    => 'query',
					'format'    => 'php',
					'redirects' => true,
					'generator' => 'images',
					'titles'    => $possible_cover,
					'prop'      => 'imageinfo',
					'iiprop'    => 'url'
				);

				$cover_search_url = $api_url . '?' . http_build_query($cover_params);
				$open_cover_url   = fopen($cover_search_url, 'r');

				if ($open_cover_url == false) {
					throw new Exception ('Can\'t open Cover Search URL');
				}
				$cover_search_results = unserialize(stream_get_contents($open_cover_url));
				fclose($open_cover_url);

				if (!isset($cover_search_results['query']['pages']) || count($cover_search_results['query']['pages']) == 0) {
					return false;
				}

				foreach ($cover_search_results['query']['pages'] as $image_id => $image) {
					# Wikipedia covers are mostly JPEG images.
					# Gets the first image (hard guess!)
					if (preg_match('/\.jpg$/i', $image['title']) == 1) {
						$cover = $image['imageinfo'][0];
						break;
					}
				}

				/*
				 * Save the info if $save = true
				 */
				if ($save) {
					$adodb->SetFetchMode(ADODB_FETCH_ASSOC);
					$album   = $adodb->qstr($album_name);
					$artist  = $adodb->qstr($artist_name);
					$license = $adodb->qstr($cover['descriptionurl']);
					$image   = $adodb->qstr($cover['url']);

					$sql = ('UPDATE Album SET image = '
						. ($image) . ', '
						. ' artwork_license = '
						. ($license) . ' WHERE artist_name = '. ($artist)
						. ' AND name = '	. ($album));

					$res = $adodb->Execute($sql);
				}

				return $cover['url'];
			} else {
				return false;
			}


		} catch (Exception $e) {
			reportError($e->getMessage());
		}

		return $album_art_url;
	}

}

/**
 * Retrieves and saves the URL to cover art for an album
 *
 * @deprecated amazonaws.com returns error 400. 20120307 kabniel
 *
 * @param string $artist Artist name
 * @param string $album Album name
 */
function go_get_album_art($artist, $album){
	global $adodb;
	$adodb->SetFetchMode(ADODB_FETCH_ASSOC);

	$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');

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

	if ($image) {

		if ($license == '') {
			$license = 'amazon';
		}

		$license = $adodb->qstr($license);
		$image = $adodb->qstr($image);
		$album = $adodb->qstr($album);
		$artist = $adodb->qstr($artist);

		$sql = ('UPDATE Album SET image = '
			. ($image) . ', '
			. ' artwork_license = '
			. ($license) . ' WHERE artist_name = '. ($artist)
			. ' AND name = '	. ($album));

		try {
			$res = $adodb->Execute($sql);
		} catch (Exception $e) {
			die('FAILED ' . $e->getMessage() . ' query was :' . $sql);
		}
	}
}