Current File : //data/www_bck/varak.net_bck/ampache.varak.net/lib/class/artist.class.php
<?php
/* vim:set softtabstop=4 shiftwidth=4 expandtab: */
/**
*
* LICENSE: GNU General Public License, version 2 (GPLv2)
* Copyright 2001 - 2014 Ampache.org
*
* 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 Artist extends database_object
{
/* Variables from DB */
public $id;
public $name;
public $summary;
public $placeformed;
public $yearformed;
public $last_update;
public $songs;
public $albums;
public $prefix;
public $mbid; // MusicBrainz ID
public $catalog_id;
public $time;
public $tags;
public $f_tags;
public $object_cnt;
public $f_name;
public $f_full_name;
public $f_link;
public $f_name_link;
public $f_time;
// Constructed vars
public $_fake = false; // Set if construct_from_array() used
private static $_mapcache = array();
/**
* Artist
* Artist class, for modifing a artist
* Takes the ID of the artist and pulls the info from the db
*/
public function __construct($id='',$catalog_init=0)
{
/* If they failed to pass in an id, just run for it */
if (!$id) { return false; }
$this->catalog_id = $catalog_init;
/* Get the information from the db */
$info = $this->get_info($id);
foreach ($info as $key=>$value) {
$this->$key = $value;
} // foreach info
return true;
} //constructor
/**
* construct_from_array
* This is used by the metadata class specifically but fills out a Artist object
* based on a key'd array, it sets $_fake to true
*/
public static function construct_from_array($data)
{
$artist = new Artist(0);
foreach ($data as $key=>$value) {
$artist->$key = $value;
}
//Ack that this is not a real object from the DB
$artist->_fake = true;
return $artist;
} // construct_from_array
/**
* gc
*
* This cleans out unused artists
*/
public static function gc()
{
Dba::write('DELETE FROM `artist` USING `artist` LEFT JOIN `song` ON `song`.`artist` = `artist`.`id` LEFT JOIN `wanted` ON `wanted`.`artist` = `artist`.`id` WHERE `song`.`id` IS NULL AND `wanted`.`id` IS NULL');
}
/**
* this attempts to build a cache of the data from the passed albums all in one query
*/
public static function build_cache($ids,$extra=false)
{
if (!is_array($ids) OR !count($ids)) { return false; }
$idlist = '(' . implode(',', $ids) . ')';
$sql = "SELECT * FROM `artist` WHERE `id` IN $idlist";
$db_results = Dba::read($sql);
while ($row = Dba::fetch_assoc($db_results)) {
parent::add_to_cache('artist',$row['id'],$row);
}
// If we need to also pull the extra information, this is normally only used when we are doing the human display
if ($extra) {
$sql = "SELECT `song`.`artist`, COUNT(`song`.`id`) AS `song_count`, COUNT(DISTINCT `song`.`album`) AS `album_count`, SUM(`song`.`time`) AS `time` FROM `song` WHERE `song`.`artist` IN $idlist GROUP BY `song`.`artist`";
debug_event("Artist", "build_cache sql: " . $sql, "6");
$db_results = Dba::read($sql);
while ($row = Dba::fetch_assoc($db_results)) {
if (AmpConfig::get('show_played_times')) {
$row['object_cnt'] = Stats::get_object_count('artist', $row['artist']);
}
parent::add_to_cache('artist_extra',$row['artist'],$row);
}
} // end if extra
return true;
} // build_cache
/**
* get_from_name
* This gets an artist object based on the artist name
*/
public static function get_from_name($name)
{
$sql = "SELECT `id` FROM `artist` WHERE `name` = ?'";
$db_results = Dba::read($sql, array($name));
$row = Dba::fetch_assoc($db_results);
$object = new Artist($row['id']);
return $object;
} // get_from_name
/**
* get_albums
* gets the album ids that this artist is a part
* of
*/
public function get_albums($catalog = null, $ignoreAlbumGroups = false)
{
$catalog_where = "";
$catalog_join = "LEFT JOIN `catalog` ON `catalog`.`id` = `song`.`catalog`";
if ($catalog) {
$catalog_where .= " AND `catalog`.`id` = '$catalog'";
}
if (AmpConfig::get('catalog_disable')) {
$catalog_where .= " AND `catalog`.`enabled` = '1'";
}
$results = array();
$sort_type = AmpConfig::get('album_sort');
$sql_sort = '`album`.`name`,`album`.`disk`,`album`.`year`';
if ($sort_type == 'year_asc') {
$sql_sort = '`album`.`year` ASC';
} elseif ($sort_type == 'year_desc') {
$sql_sort = '`album`.`year` DESC';
} elseif ($sort_type == 'name_asc') {
$sql_sort = '`album`.`name` ASC';
} elseif ($sort_type == 'name_desc') {
$sql_sort = '`album`.`name` DESC';
}
$sql_group_type = '`album`.`id`';
if (!$ignoreAlbumGroups && AmpConfig::get('album_group')) {
$sql_group_type = '`album`.`mbid`';
}
$sql_group = "COALESCE($sql_group_type, `album`.`id`)";
$sql = "SELECT `album`.`id` FROM album LEFT JOIN `song` ON `song`.`album`=`album`.`id` $catalog_join " .
"WHERE `song`.`artist`='$this->id' $catalog_where GROUP BY $sql_group ORDER BY $sql_sort";
debug_event("Artist", "$sql", "6");
$db_results = Dba::read($sql);
while ($r = Dba::fetch_assoc($db_results)) {
$results[] = $r['id'];
}
return $results;
} // get_albums
/**
* get_songs
* gets the songs for this artist
*/
public function get_songs()
{
$sql = "SELECT `song`.`id` FROM `song` ";
if (AmpConfig::get('catalog_disable')) {
$sql .= "LEFT JOIN `catalog` ON `catalog`.`id` = `song`.`catalog` ";
}
$sql .= "WHERE `song`.`artist`='" . Dba::escape($this->id) . "' ";
if (AmpConfig::get('catalog_disable')) {
$sql .= "AND `catalog`.`enabled` = '1' ";
}
$sql .= "ORDER BY album, track";
$db_results = Dba::read($sql);
$results = array();
while ($r = Dba::fetch_assoc($db_results)) {
$results[] = $r['id'];
}
return $results;
} // get_songs
/**
* get_random_songs
* Gets the songs from this artist in a random order
*/
public function get_random_songs()
{
$results = array();
$sql = "SELECT `song`.`id` FROM `song` ";
if (AmpConfig::get('catalog_disable')) {
$sql .= "LEFT JOIN `catalog` ON `catalog`.`id` = `song`.`catalog` ";
}
$sql .= "WHERE `song`.`artist`='$this->id' ";
if (AmpConfig::get('catalog_disable')) {
$sql .= "AND `catalog`.`enabled` = '1' ";
}
$sql .= "ORDER BY RAND()";
$db_results = Dba::read($sql);
while ($r = Dba::fetch_assoc($db_results)) {
$results[] = $r['id'];
}
return $results;
} // get_random_songs
/**
* _get_extra info
* This returns the extra information for the artist, this means totals etc
*/
private function _get_extra_info($catalog=FALSE)
{
// Try to find it in the cache and save ourselves the trouble
if (parent::is_cached('artist_extra',$this->id) ) {
$row = parent::get_from_cache('artist_extra',$this->id);
} else {
$uid = Dba::escape($this->id);
$sql = "SELECT `song`.`artist`,COUNT(`song`.`id`) AS `song_count`, COUNT(DISTINCT `song`.`album`) AS `album_count`, SUM(`song`.`time`) AS `time` FROM `song` LEFT JOIN `catalog` ON `catalog`.`id` = `song`.`catalog` " .
"WHERE `song`.`artist`='$uid' ";
if ($catalog) {
$sql .= "AND (`song`.`catalog` = '$catalog') ";
}
if (AmpConfig::get('catalog_disable')) {
$sql .= " AND `catalog`.`enabled` = '1'";
}
$sql .= "GROUP BY `song`.`artist`";
$db_results = Dba::read($sql);
$row = Dba::fetch_assoc($db_results);
if (AmpConfig::get('show_played_times')) {
$row['object_cnt'] = Stats::get_object_count('artist', $row['artist']);
}
parent::add_to_cache('artist_extra',$row['artist'],$row);
}
/* Set Object Vars */
$this->songs = $row['song_count'];
$this->albums = $row['album_count'];
$this->time = $row['time'];
return $row;
} // _get_extra_info
/**
* format
* this function takes an array of artist
* information and reformats the relevent values
* so they can be displayed in a table for example
* it changes the title into a full link.
*/
public function format()
{
/* Combine prefix and name, trim then add ... if needed */
$name = trim($this->prefix . " " . $this->name);
$this->f_name = $name;
$this->f_full_name = trim(trim($this->prefix) . ' ' . trim($this->name));
// If this is a fake object, we're done here
if ($this->_fake) { return true; }
if ($this->catalog_id) {
$this->f_link = AmpConfig::get('web_path') . '/artists.php?action=show&catalog=' . $this->catalog_id . '&artist=' . $this->id;
$this->f_name_link = "<a href=\"" . $this->f_link . "\" title=\"" . $this->f_full_name . "\">" . $name . "</a>";
} else {
$this->f_link = AmpConfig::get('web_path') . '/artists.php?action=show&artist=' . $this->id;
$this->f_name_link = "<a href=\"" . $this->f_link . "\" title=\"" . $this->f_full_name . "\">" . $name . "</a>";
}
// Get the counts
$extra_info = $this->_get_extra_info($this->catalog_id);
//Format the new time thingy that we just got
$min = sprintf("%02d",(floor($extra_info['time']/60)%60));
$sec = sprintf("%02d",($extra_info['time']%60));
$hours = floor($extra_info['time']/3600);
$this->f_time = ltrim($hours . ':' . $min . ':' . $sec,'0:');
$this->tags = Tag::get_top_tags('artist', $this->id);
$this->f_tags = Tag::get_display($this->tags);
$this->object_cnt = $extra_info['object_cnt'];
return true;
} // format
/**
* check
*
* Checks for an existing artist; if none exists, insert one.
*/
public static function check($name, $mbid = null, $readonly = false)
{
$trimmed = Catalog::trim_prefix(trim($name));
$name = $trimmed['string'];
$prefix = $trimmed['prefix'];
if ($mbid == '') $mbid = null;
if (!$name) {
$name = T_('Unknown (Orphaned)');
$prefix = null;
}
if (isset(self::$_mapcache[$name][$mbid])) {
return self::$_mapcache[$name][$mbid];
}
$id = 0;
$exists = false;
if ($mbid) {
$sql = 'SELECT `id` FROM `artist` WHERE `mbid` = ?';
$db_results = Dba::read($sql, array($mbid));
if ($row = Dba::fetch_assoc($db_results)) {
$id = $row['id'];
$exists = true;
}
}
if (!$exists) {
$sql = 'SELECT `id`, `mbid` FROM `artist` WHERE `name` LIKE ?';
$db_results = Dba::read($sql, array($name));
$id_array = array();
while ($row = Dba::fetch_assoc($db_results)) {
$key = $row['mbid'] ?: 'null';
$id_array[$key] = $row['id'];
}
if (count($id_array)) {
if ($mbid) {
if (isset($id_array['null']) && !$readonly) {
$sql = 'UPDATE `artist` SET `mbid` = ? WHERE `id` = ?';
Dba::write($sql, array($mbid, $id_array['null']));
}
if (isset($id_array['null'])) {
$id = $id_array['null'];
$exists = true;
}
} else {
// Pick one at random
$id = array_shift($id_array);
$exists = true;
}
}
}
if ($exists) {
self::$_mapcache[$name][$mbid] = $id;
return $id;
}
if ($readonly) {
return null;
}
$sql = 'INSERT INTO `artist` (`name`, `prefix`, `mbid`) ' .
'VALUES(?, ?, ?)';
$db_results = Dba::write($sql, array($name, $prefix, $mbid));
if (!$db_results) {
return null;
}
$id = Dba::insert_id();
self::$_mapcache[$name][$mbid] = $id;
return $id;
}
/**
* update
* This takes a key'd array of data and updates the current artist
*/
public function update($data)
{
// Save our current ID
$current_id = $this->id;
// Check if name is different than current name
if ($this->name != $data['name']) {
$artist_id = self::check($data['name'], $this->mbid);
$updated = false;
$songs = array();
// If it's changed we need to update
if ($artist_id != $this->id) {
$songs = $this->get_songs();
foreach ($songs as $song_id) {
Song::update_artist($artist_id,$song_id);
}
$updated = true;
$current_id = $artist_id;
self::gc();
} // end if it changed
if ($updated) {
foreach ($songs as $song_id) {
Song::update_utime($song_id);
}
Stats::gc();
Rating::gc();
Userflag::gc();
} // if updated
} else if ($this->mbid != $data['mbid']) {
$sql = 'UPDATE `artist` SET `mbid` = ? WHERE `id` = ?';
Dba::write($sql, array($data['mbid'], $current_id));
}
// Update artist name (if we don't want to use the MusicBrainz name)
$trimmed = Catalog::trim_prefix(trim($data['name']));
$name = $trimmed['string'];
if ($name != '' && $name != $this->name) {
$sql = 'UPDATE `artist` SET `name` = ? WHERE `id` = ?';
Dba::write($sql, array($name, $current_id));
}
$override_childs = false;
if ($data['apply_childs'] == 'checked') {
$override_childs = true;
}
$this->update_tags($data['edit_tags'], $override_childs, $current_id);
return $current_id;
} // update
/**
* update_tags
*
* Update tags of artists and/or albums
*/
public function update_tags($tags_comma, $override_childs, $current_id = null)
{
if ($current_id == null) {
$current_id = $this->id;
}
Tag::update_tag_list($tags_comma, 'artist', $current_id);
if ($override_childs) {
$albums = $this->get_albums(null, true);
foreach ($albums as $album_id) {
$album = new Album($album_id);
$album->update_tags($tags_comma, $override_childs);
}
}
}
public function update_artist_info($summary, $placeformed, $yearformed)
{
$sql = "UPDATE `artist` SET `summary` = ?, `placeformed` = ?, `yearformed` = ?, `last_update` = ? WHERE `id` = ?";
return Dba::write($sql, array($summary, $placeformed, $yearformed, time(), $this->id));
}
} // end of artist class
Mini Shell