id = $album_id;
/* Get the information from the db */
if ($info = $this->_get_info()) {
$this->name = trim($info['prefix'] . " " . $info['album_name']);
$this->songs = $info['song_count'];
$this->artist_count = $info['artist_count'];
$this->year = $info['year'];
$this->artist = trim($info['artist_prefix'] . " " . $info['artist_name']);
$this->artist_id = $info['art_id'];
$this->album = $info['album_name'];
$this->has_art = $info['has_art'];
$this->prefix = $info['prefix'];
} // if info
return true;
} //constructor
/*!
@function get_info
@discussion get's the vars for $this out of the database
@param $this->id Taken from the object
*/
function _get_info() {
$this->id = intval($this->id);
/* Grab the basic information from the catalog and return it */
$sql = "SELECT COUNT(DISTINCT(song.artist)) as artist_count,album.prefix,album.year,album.name AS album_name,COUNT(song.id) AS song_count," .
"artist.name AS artist_name,artist.id AS art_id,artist.prefix AS artist_prefix,album.art AS has_art ".
"FROM song,artist,album WHERE album.id='$this->id' AND song.album=album.id AND song.artist=artist.id GROUP BY song.album";
$db_results = mysql_query($sql, dbh());
$results = mysql_fetch_assoc($db_results);
// If there is art then set it to 1, if not set it to 0, we don't want to cary
// around the full blob with every object because it can be pretty big
$results['has_art'] = strlen($results['has_art']) ? '1' : '0';
return $results;
} // _get_info
/*!
@function get_songs
@discussion gets the songs for this album
*/
function get_songs($limit = 0) {
$results = array();
$sql = "SELECT id FROM song WHERE album='$this->id' ORDER BY track, title";
if ($limit) { $sql .= " LIMIT $limit"; }
$db_results = mysql_query($sql, dbh());
while ($r = mysql_fetch_object($db_results)) {
$results[] = new Song($r->id);
}
return $results;
} // get_songs
/**
* get_song_ids
* This returns an array of the song id's that are on this album. This is used by the
* show_songs function and can be pased and artist if you so desire to limit it to that
*/
function get_song_ids($artist='') {
/* If they pass an artist then constrain it based on the artist as well */
if ($artist) {
$artist_sql = " AND artist='" . sql_escape($artist) . "'";
}
$sql = "SELECT id FROM song WHERE album='" . sql_escape($this->id) . "' $artist_sql ORDER BY track";
$db_results = mysql_query($sql, dbh());
$results = array();
while ($r = mysql_fetch_assoc($db_results)) {
$results[] = $r['id'];
}
return $results;
} // get_song_ids
/**
* format
* This is the format function for this object. It sets cleaned up
* album information with the base required
* f_link, f_name
*/
function format() {
$web_path = conf('web_path');
/* Truncate the string if it's to long */
$name = scrub_out(truncate_with_ellipse($this->name,conf('ellipse_threshold_album')));
$artist = scrub_out($this->artist);
$this->f_name = "id . "\" title=\"" . scrub_out($this->name) . "\">" . $name . "";
$this->f_link = "id) . "\" title=\"" . scrub_out($this->name) . "\">" . $name . "";
$this->f_songs = "" . $this->songs . "
";
$this->f_title = $name;
if ($this->artist_count == '1') {
$this->f_artist = "artist_id . "\">" . $artist . "";
}
else {
$this->f_artist = _('Various');
}
if ($this->year == '0') {
$this->year = "N/A";
}
} // format
/**
* format_album
* DEPRECIATED DO NOT USE!
*/
function format_album() {
// Call the real function
$this->format();
} // format_album
/**
* get_art
* This function only pulls art from the database, nothing else
* It should not be called when trying to find new art
*/
function get_art() {
return $this->get_db_art();
} // get_art
/**
* find_art
* This function searches for album art using all configured methods
* for the current album. There is an optional 'limit' passed that will
* gather up to the specified number of possible album covers.
* There is also an optional array of options the possible options are
* ['keyword'] = STRING
* ['artist'] = STRING
* ['album_name'] = STRING
*/
function find_art($options=array(),$limit='') {
/* Create Base Vars */
$results = array();
/* Attempt to retrive the album art order */
$config_value = conf('album_art_order');
$class_methods = get_class_methods('Album');
/* If it's not set */
if (empty($config_value)) {
// They don't want art!
return array();
}
elseif (!is_array($config_value)) {
$config_value = array($config_value);
}
foreach ($config_value AS $method) {
$data = array();
$method_name = "get_" . $method . "_art";
if (in_array($method_name,$class_methods)) {
// Some of these take options!
switch ($method_name) {
case 'get_amazon_art':
$data = $this->{$method_name}($options['keyword'],$limit);
break;
case 'get_id3_art':
if ($options['skip_id3']) { break; }
$data = $this->{$method_name}($limit);
break;
default:
$data = $this->{$method_name}();
break;
}
// Add the results we got to the current set
$total_results += count($data);
$results = array_merge($results,$data);
if ($total_results > $limit AND $limit > 0) {
return $results;
}
} // if the method exists
} // end foreach
return $results;
} // find_art
/*!
@function get_id3_art
@discussion looks for art from the id3 tags
*/
function get_id3_art($limit='') {
// grab the songs and define our results
if (!count($this->_songs)) {
$this->_songs = $this->get_songs();
}
$data = array();
// Foreach songs in this album
foreach ($this->_songs as $song) {
// If we find a good one, stop looking
$getID3 = new getID3();
$id3 = $getID3->analyze($song->file);
if ($id3['format_name'] == "WMA") {
$image = $id3['asf']['extended_content_description_object']['content_descriptors']['13'];
$data[] = array('raw'=>$image['data'],'mime'=>$image['mime']);
}
elseif (isset($id3['id3v2']['APIC'])) {
// Foreach incase they have more then one
foreach ($id3['id3v2']['APIC'] as $image) {
$data[] = array('raw'=>$image['data'],'mime'=>$image['mime']);
}
}
if (!empty($limit) && $limit < count($data)) {
return $data;
}
} // end foreach
return $data;
} // get_id3_art
/**
* get_folder_art()
* returns the album art from the folder of the audio files
* If a limit is passed or the preferred filename is found the current results set
* is returned
*/
function get_folder_art($limit='') {
if (!count($this->_songs)) {
$this->_songs = $this->get_songs();
}
$data = array();
/* See if we are looking for a specific filename */
$preferred_filename = conf('album_art_preferred_filename');
// Init a horrible hack array of lameness
$cache =array();
/* Thanks to dromio for origional code */
/* Added search for any .jpg, png or .gif - Vollmer */
foreach($this->_songs as $song) {
$dir = dirname($song->file);
debug_event('folder_art',"Opening $dir and checking for Album Art",'3');
/* Open up the directory */
$handle = @opendir($dir);
if (!is_resource($handle)) {
echo "" . _("Error: Unable to open") . " $dir
\n";
debug_event('read',"Error: Unable to open $dir for album art read",'2');
}
/* Recurse through this dir and create the files array */
while ( FALSE !== ($file = @readdir($handle)) ) {
$extension = substr($file,strlen($file)-3,4);
/* If it's an image file */
if ($extension == "jpg" || $extension == "gif" || $extension == "png" || $extension == "jp2") {
// HACK ALERT this is to prevent duplicate filenames
$full_filename = $dir . '/' . $file;
$index = md5($full_filename);
/* Make sure it's got something in it */
if (!filesize($dir . '/' . $file)) { continue; }
if ($file == $preferred_filename) {
// If we found the preferred filename we're done, wipe out previous results
$data = array(array('file' => $full_filename, 'mime' => 'image/' . $extension));
return $data;
}
elseif (!isset($cache[$index])) {
$data[] = array('file' => $full_filename, 'mime' => 'image/' . $extension);
}
$cache[$index] = '1';
} // end if it's an image
} // end while reading dir
@closedir($handle);
if (!empty($limit) && $limit < count($data)) {
return $data;
}
} // end foreach songs
return $data;
} // get_folder_art()
/**
* get_db_art()
* returns the album art from the db along with the mime type
*/
function get_db_art() {
$sql = "SELECT art,art_mime FROM album WHERE id='$this->id' AND art_mime IS NOT NULL";
$db_results = mysql_query($sql, dbh());
$results = mysql_fetch_assoc($db_results);
if (!$results['art']) { return array(); }
return $results;
} // get_db_art
/**
* get_amazon_art
* This takes keywords and performs a search of the Amazon website
* for album art. It returns an array of found objects with mime/url keys
*/
function get_amazon_art($keywords = '',$limit='') {
$images = array();
$final_results = array();
$possible_keys = array("LargeImage","MediumImage","SmallImage");
// Prevent the script from timing out
set_time_limit(0);
if (empty($keywords)) {
$keywords = $this->name;
/* If this isn't a various album combine with artist name */
if ($this->artist_count == '1') { $keywords .= ' ' . $this->artist; }
}
/* Create Base Vars */
$amazon_base_urls = array();
/* Attempt to retrive the album art order */
$config_value = conf('amazon_base_urls');
/* If it's not set */
if (empty($config_value)) {
$amazon_base_urls = array('http://webservices.amazon.com');
}
elseif (!is_array($config_value)) {
array_push($amazon_base_urls,$config_value);
}
else {
$amazon_base_urls = array_merge($amazon_base_urls, conf('amazon_base_urls'));
}
/* Foreach through the base urls that we should check */
foreach ($amazon_base_urls AS $amazon_base) {
// Create the Search Object
$amazon = new AmazonSearch(conf('amazon_developer_key'), $amazon_base);
$search_results = array();
/* Setup the needed variables */
$max_pages_to_search = max(conf('max_amazon_results_pages'),$amazon->_default_results_pages);
$pages_to_search = $max_pages_to_search; //init to max until we know better.
// while we have pages to search
do {
$raw_results = $amazon->search(array('artist'=>$artist,'album'=>$albumname,'keywords'=>$keywords));
$total = count($raw_results) + count($search_results);
// If we've gotten more then we wanted
if (!empty($limit) && $total > $limit) {
// We don't want ot re-count every loop
$i = $total;
while ($i > $limit) {
array_pop($raw_results);
$i--;
}
debug_event('amazon-xml',"Found $total, Limit $limit reducing and breaking from loop",'5');
// Merge the results and BREAK!
$search_results = array_merge($search_results,$raw_results);
break;
} // if limit defined
$search_results = array_merge($search_results,$raw_results);
$pages_to_search = min($max_pages_to_search, $amazon->_maxPage);
debug_event('amazon-xml', "Searched results page " . ($amazon->_currentPage+1) . "/" . $pages_to_search,'5');
$amazon->_currentPage++;
} while($amazon->_currentPage < $pages_to_search);
// Only do the second search if the first actually returns something
if (count($search_results)) {
$final_results = $amazon->lookup($search_results);
}
/* Log this if we're doin debug */
debug_event('amazon-xml',"Searched using $keywords with " . conf('amazon_developer_key') . " as key " . count($final_results) . " results found",'5');
// If we've hit our limit
if (!empty($limit) && count($final_results) >= $limit) {
break;
}
} // end foreach
/* Foreach through what we've found */
foreach ($final_results as $result) {
/* Recurse through the images found */
foreach ($possible_keys as $key) {
if (strlen($result[$key])) {
break;
}
} // foreach
// Rudimentary image type detection, only JPG and GIF allowed.
if (substr($result[$key], -4 == '.jpg')) {
$mime = "image/jpg";
}
elseif (substr($result[$key], -4 == '.gif')) {
$mime = "image/gif";
}
elseif (substr($result[$key], -4 == '.png')) {
$mime = "image/png";
}
else {
/* Just go to the next result */
continue;
}
$data['url'] = $result[$key];
$data['mime'] = $mime;
$images[] = $data;
if (!empty($limit)) {
if (count($images) >= $limit) {
return $images;
}
}
} // if we've got something
return $images;
} // get_amazon_art()
/*!
@function get_random_songs
@discussion gets a random number, and
a random assortment of songs from this
album
*/
function get_random_songs() {
$results = array();
$sql = "SELECT id FROM song WHERE album='$this->id' ORDER BY RAND()";
$db_results = mysql_query($sql, dbh());
while ($r = mysql_fetch_array($db_results)) {
$results[] = $r[0];
}
return $results;
} // get_random_songs
/*!
@function clear_art
@discussion clears the album art from the DB
*/
function clear_art() {
$sql = "UPDATE album SET art=NULL, art_mime=NULL WHERE id='$this->id'";
$db_results = mysql_query($sql, dbh());
} // clear_art
/*!
@function insert_art
@discussion this takes a string representation of an image
and inserts it into the database. You must pass the
mime type as well
*/
function insert_art($image, $mime) {
/* Have to disable this for Demo because people suck and try to
* insert PORN :(
*/
if (conf('demo_mode')) { return false; }
// Check for PHP:GD and if we have it make sure this image is of some size
if (function_exists('ImageCreateFromString')) {
$im = @ImageCreateFromString($image);
if (@imagesx($im) == 1 || @imagesy($im) == 1 && $im) {
return false;
}
} // if we have PHP:GD
// Push the image into the database
$sql = "UPDATE album SET art = '" . sql_escape($image) . "'," .
" art_mime = '" . sql_escape($mime) . "'" .
" WHERE id = '$this->id'";
$db_results = mysql_query($sql, dbh());
return true;
} // insert_art
} //end of album class
?>