path: root/lib/ui.lib.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
   as published by the Free Software Foundation; either version 2
   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 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.

 */

/**
 *	UI Function Library
 *	This contains functions that are generic, and display information
 *	things like a confirmation box, etc and so forth
 *	@package Web Interface
 * 	@catagory Library
 */

/**
 *  show_confirmation
 * shows a confirmation of an action
 * $next_url	Where to go next
 * $title	The Title of the message
 * $text	The details of the message
 * $cancel	T/F show a cancel button that uses return_referrer()
 */
function show_confirmation($title,$text,$next_url,$cancel=0) {

	if (substr_count($next_url,Config::get('web_path'))) {
		$path = $next_url;
	}
	else {
		$path = Config::get('web_path') . "/$next_url";
	}

	require Config::get('prefix') . '/templates/show_confirmation.inc.php';

} // show_confirmation

/**
 *  flip_class
 * takes an array of 2 class names
 *		and flips them back and forth and
 *		then echo's out [0]
 */
function flip_class($array=0) {

	static $classes = array();

	if ($array) {
		$classes = $array;
	}
	else {
		$classes = array_reverse($classes);
		return $classes[0];
	}

} // flip_class

/**
 *  _
 * checks to see if the alias _ is defined
 *	if it isn't it defines it as a simple return
 */
if (!function_exists('_')) {

	function _($string) {
		return $string;
	} // _

} // if _ isn't defined

/**
 *  access_denied
 * throws an error if they try to do something
 * 	that they aren't allowed to
 */
function access_denied() {

	echo "<br /><br /><br />";
	echo "<div class=\"fatalerror\">" . _("Error Access Denied") . "</div>\n";
	show_footer();
	exit();

} // access_denied

/**
 *  return_referer
 * returns the script part of the referer address passed by the web browser
 * this is not %100 accurate. Also because this is not passed by us we need
 * to clean it up, take the filename then check for a /admin/ and dump the rest
 */
function return_referer() {

	$referer = $_SERVER['HTTP_REFERER'];

	$file = basename($referer);
	
	/* Strip off the filename */
	$referer = substr($referer,0,strlen($referer)-strlen($file));
	
	if (substr($referer,strlen($referer)-6,6) == 'admin/') { 
		$file = 'admin/' . $file;
	}

	return $file;

} // return_referer

/**
 *  show_alphabet_list
 * shows the A-Z,0-9 lists for albums and artist page
 * It takes a selected and an action 
 */
function show_alphabet_list () {

	$list = array(A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,1,2,3,4,5,6,7,8,9,"0",_('All'));

	$style_name = "style_" . strtolower($selected);
	${$style_name} = "style=\"font-weight:bold;\"";
	
	echo "<div class=\"alphabet\">";
	foreach ($list as $l) {
		$style_name = "style_" . strtolower($l);
		echo "<span class=\"link\" onclick=\"ajaxPut('". Config::get('ajax_url') ."?action=browse&amp;key=alpha_match&amp;value=$l');return true;\">" . 
			$l . "</span>\n";
		$i++; 
		if ($i/5 == intval($i/5)) { echo "<br />"; } 
	}
	echo "</div>";

} // show_alphabet_list

/**
 * show_alphabet_form
 * this shows the spiffy little form that acts as a "quick search" when browsing
 * @package General
 * @catagory Display
 */
function show_alphabet_form($match, $text, $action) {

	require (conf('prefix') . '/templates/show_alphabet_form.inc.php');

} // show_alphabet_form


/**
 *  show_local_control
 * shows the controls
 *	for localplay
 */
function show_local_control () {

	require_once(conf('prefix') . "/templates/show_localplay.inc");

} // show_local_control

/**
 * truncate_with_ellipsis
 * Correct Spelling function that truncates text to a specific lenght
 * and appends three dots, or an ellipsis to the end
 * @package Web Interface
 * @catagory General
 * @author Nedko Arnaudov
 */
function truncate_with_ellipsis($text, $max=27) {

	/* If we want it to be shorter than three, just throw it back */
	if ($max > 3) {

		/* Make sure the functions exist before doing the iconv mojo */
		if (function_exists('iconv') && function_exists('iconv_substr') && function_exists('iconv_strlen')) {
			if (iconv_strlen($text, Config::get('site_charset')) > $max) {
				$text = iconv_substr($text, 0, $max-3, Config::get('site_charset'));
				$text .= iconv("ISO-8859-1", Config::get('site_charset'), "...");
			}
		}

		/* Do normal substr if we don't have iconv */
		else {
			if (strlen($text) > $max) {
				$text = substr($text,0,$max-3)."...";
			}
		} // else no iconv
	} // else greater than 3

	return $text;

} // truncate_with_ellipsis

/**
 * show_header
 * This shows the header.inc.php, it may do something
 * more in the future
 */
function show_header() { 

	require_once Config::get('prefix') . '/templates/header.inc.php'; 

} // show_header

/**
 *  show_footer
 * shows the footer of the page
 */
function show_footer() {

	require_once Config::get('prefix') . '/templates/footer.inc.php';

} // show_footer

/**
 *  show_user_registration
 * this function is called for a new user
 * registration
 * @author Terry
 * @todo Fix so that it recieves an array of values for the user reg rather than seperate
 */
function show_user_registration ($values=array()) {

	require (conf('prefix') . "/templates/show_user_registration.inc.php");

} // show_user_registration

/**
 *  show_play_selected
 * this shows the playselected/add to playlist
 *	box, which includes a little javascript
 */
function show_play_selected() {

	require (conf('prefix') . "/templates/show_play_selected.inc.php");

} // show_play_selected

/*
 * Artist Ratings - Implemented by SoundOfEmotion
 *
 * set_artist_rating()
 *
 * check to see if the ratings exist
 * if they do: update them
 * if they don't: insert them
 *
 */
function set_artist_rating ($artist_id, $rate_user, $rating) {
	$artist_id = sql_escape($artist_id);

	$sql	     = "SELECT * FROM ratings WHERE user='$rate_user' AND object_type='artist' AND object_id='$artist_id'";
	$db_result = mysql_query( $sql, dbh() );
	$r         = mysql_fetch_row( $db_result );

	if($r[0]) {
		$sql2       = "UPDATE ratings SET user_rating='$rating' WHERE object_id='$artist_id' AND user='$rate_user' AND object_type='artist'";
		$db_result2 = mysql_query( $sql2, dbh() );
		$r          = mysql_fetch_row( $db_result2 );
		return mysql_insert_id( dbh() );
	}
	else if(!$r[0]) {
		$sql2       = "INSERT INTO ratings (id,user,object_type,object_id,user_rating) ".
			"VALUES ('','$rate_user','artist','$artist_id','$rating')";
		$db_result2 = mysql_query( $sql2, dbh() );
		return mysql_insert_id(dbh() );
	}
	else{
		return "NA";
	}
} // set_artist_rating()

/*
 * Album Ratings - Implemented by SoundOfEmotion
 *
 * set_album_rating()
 *
 * check to see if the ratings exist
 * if they do: update them
 * if they don't: insert them
 *
 */

function set_album_rating($album_id, $rate_user, $rating) {
	$album_id = sql_escape($album_id);

	$sql       = "SELECT * FROM ratings WHERE user='$rate_user' AND object_type='album' AND object_id='$album_id'";
	$db_result = mysql_query( $sql, dbh() );
	$r         = mysql_fetch_row( $db_result );

	if($r[0]) {
		$sql2       = "UPDATE ratings SET user_rating='$rating' WHERE object_id='$album_id' AND user='$rate_user' AND object_type='album'";
		$db_result2 = mysql_query( $sql2, dbh() );
		return mysql_insert_id( dbh() );
	}
	else if(!$r[0]) {
		$sql2       = "INSERT INTO ratings (id,user,object_type,object_id,user_rating) ".
			"VALUES ('','$rate_user','album','$album_id','$rating')";
		$db_result2 = mysql_query( $sql2, dbh() );
		return mysql_insert_id( dbh() );
	}
	else{
		return "NA";
	}
} // set_album_rating()

/*
 * Song Ratings - Implemented by SoundOfEmotion
 *
 * set_song_rating()
 *
 * check to see if the ratings exist
 * if they do: update them
 * if they don't: insert them
 *
 */

function set_song_rating($song_id, $rate_user, $rating) {
	$song_id = sql_escape($song_id);

	$sql       = "SELECT * FROM ratings WHERE user='$rate_user' AND object_type='song' AND object_id='$song_id'";
	$db_result = mysql_query( $sql, dbh() );
	$r         = mysql_fetch_row( $db_result );

	if($r[0]){
		$sql2       = "UPDATE ratings SET user_rating='$rating' WHERE object_id='$song_id' AND user='$rate_user' AND object_type='song'";
		$db_result2 = mysql_query( $sql2, dbh() );
		return mysql_insert_id( dbh() );
	}
	else if(!$r[0]){
		$sql2       = "INSERT INTO ratings (id,user,object_type,object_id,user_rating) ".
			"VALUES ('','$rate_user','song','$song_id','$rating')";
		$db_result2 = mysql_query( $sql2, dbh() );
		return mysql_insert_id( dbh() );
	}
	else{
		return "NA";
	}
} // set_song_rating()

/**
 *  show_clear
 * this is a hack because of the float mojo it clears the floats
 * @package Web Interface
 * @catagory Hack-o-Rama
 * @author Karl Vollmer
 */
function show_clear() {

	echo "\n<br style=\"clear:both;\" />\n";

} // show_clear

/**
 *	show_page_footer
 *	adds page footer including html and body end tags
 *	@param $menu			menu item to highlight
 *	@param $admin_menu		admin menu item to highlight
 *	@param $display_menu		display menu or not (1 on 0 off)
 * 	@package Web Interface
 * 	@catagory Display
 */
function show_page_footer($menu="Home", $admin_menu='', $display_menu=0) {

	if ($display_menu){
		if($menu == 'Admin'){
			show_admin_menu($admin_menu);
		} // end if admin

		show_menu_items($menu);

	} // end if

	show_template('footer');

} // show_page_footer

/**
 * 	Show All Popular
 * 	This functions shows all of the possible global popular tables, this is basicly a top X where X is
 * 	set on a per user basis
 *	@package Web Interface
 *	@catagory Display
 *	@author Karl Vollmer
 */
function show_all_popular() {

	$artists 	= get_global_popular('artist');
	$albums		= get_global_popular('album');
	$songs		= get_global_popular('song');
	$genres		= get_global_popular('genre');

	require_once Config::get('prefix') . '/templates/show_all_popular.inc.php';

} // show_all_popular

/**
 * show_local_catalog_info
 * Shows the catalog stats
 * @package Web INterface
 * @catagory Display
 */
function show_local_catalog_info() {

	/* Before we display anything make sure that they have a catalog */
	$query = "SELECT * FROM catalog";
	$db_results = Dba::query($query);
	
	// Make sure we have something to display
	if (Dba::num_rows($db_results) < 1) {
		show_box_top(); 	
		echo "<span align=\"center\" class=\"error\">" . _('No Catalogs Found!') . "</span><br />";
		echo "<a href=\"" . Config::get('web_path') . "/admin/catalog.php?action=show_add_catalog\">" ._('Add a Catalog') . "</a>";
		show_box_bottom(); 
		return false;
	}

	$results = Catalog::get_stats(); 

	$hours = floor($results['time']/3600);
	$size = $results['size']/1048576;

	$days = floor($hours/24);
	$hours = $hours%24;

	$time_text = "$days ";
	$time_text .= ($days == 1) ? _("day") : _("days");
	$time_text .= ", $hours ";
	$time_text .= ($hours == 1) ? _("hour") : _("hours");

	if ( $size > 1024 ) {
		$total_size = sprintf("%.2f", ($size/1024));
		$size_unit = "GB";
	}
	else {
		$total_size = sprintf("%.2f", $size);
		$size_unit = "MB";
	}

	require Config::get('prefix') . '/templates/show_local_catalog_info.inc.php';

} // show_local_catalog_info

/**
 * img_resize
 * this automaticly resizes the image for thumbnail viewing
 * only works on gif/jpg/png this function also checks to make
 * sure php-gd is enabled
 */
function img_resize($image,$size,$type,$album_id) {

	/* Make sure they even want us to resize it */
	if (!Config::get('resize_images')) {
		return $image['raw'];
	}
	// Already resized
	if ($image['db_resized']) { 
		debug_event('using_resized','using resized image for Album:' . $album_id,'2'); 
		return $image['raw']; 
	}

	$image = $image['raw'];

	if (!function_exists('gd_info')) { return false; }

	/* First check for php-gd */
	$info = gd_info();

	if ( ($type == 'jpg' OR $type == 'jpeg') AND !$info['JPG Support']) {
		return false;
	}
	elseif ($type == 'png' AND !$info['PNG Support']) {
		return false;
	}
	elseif ($type == 'gif' AND !$info['GIF Create Support']) {
		return false;
	}

	$src = imagecreatefromstring($image);
	
	if (!$src) { 
		debug_event('IMG_RESIZE','Failed to create from string','3');
		return false; 
	} 

	$width = imagesx($src);
	$height = imagesy($src);

	$new_w = $size['width'];
	$new_h = $size['height'];

	$img = imagecreatetruecolor($new_w,$new_h);
	
	if (!imagecopyresampled($img,$src,0,0,0,0,$new_w,$new_h,$width,$height)) { 
		debug_event('IMG_RESIZE','Failed to copy resample image','3');
		return false;
	}

	ob_start(); 

	// determine image type and send it to the client
	switch ($type) {
		case 'jpg':
		case 'jpeg':
			imagejpeg($img,null,100);
			break;
		case 'gif':
			imagegif($img,null,100);
			break;
		case 'png':
			imagepng($img,null,100);
			break;
	}

	// Grab this image data and save it into the thumbnail
	$data = ob_get_contents(); 
	ob_end_clean();

	// If our image create failed don't save it, just return
	if (!$data) { 
		debug_event('IMG_RESIZE','Failed to resize Art from Album:' . $album_id,'3'); 
		return $image;
	}

	// Save what we've got
	Album::save_resized_art($data,'image/' . $type,$album_id); 

	return $data; 

} // img_resize

/**
 * show_genres
 * this shows the 'many' genre form, it takes an array of genre objects and the view object
 */
function show_genres($genres,$view) {

	require Config::get('prefix') . '/templates/show_genres.inc.php';

} // show_genres

/**
 * show_genre
 * this shows a single genre item which is basicly just a link to the albums/artists/songs of said genre
 */
function show_genre($genre_id) {

	$genre = new Genre($genre_id);

	require Config::get('prefix') . '/templates/show_genre.inc.php';

} // show_genre

/**
 * get_location
 * This function gets the information about said persons currently location
 * this is used for A) Sidebar highlighting & submenu showing and B) Titlebar information
 * it returns an array of information about what they are currently doing
 * Possible array elements
 * ['title']	Text name for the page
 * ['page']	actual page name
 * ['section']	name of the section we are in, admin, browse etc (submenu control)
 * @package General
 */
function get_location() {

	$location = array();

	if (strlen($_SERVER['PHP_SELF'])) { 
		$source = $_SERVER['PHP_SELF'];
	}
	else { 
		$source = $_SERVER['REQUEST_URI'];
	}

	/* Sanatize the $_SERVER['PHP_SELF'] variable */
	$source			= ltrim($source, Config::get('raw_web_path')); 
	$location['page'] 	= preg_replace("/^\/(.+\.php)\/?.*/","$1",$source);

	switch ($location['page']) {
		case 'index.php':
			$location['title'] 	= _('Home');
			break;
		case 'upload.php':
			$location['title'] 	= _('Upload');
			break;
		case 'localplay.php':
			$location['title'] 	= _('Local Play');
			break;
		case 'randomplay.php':
			$location['title'] 	= _('Random Play');
			break;
		case 'playlist.php':
			$location['title'] 	= _('Playlist');
			break;
		case 'search.php':
			$location['title'] 	= _('Search');
			break;
		case 'preferences.php':
			$location['title'] 	= _('Preferences');
			break;
		case 'admin/index.php':
			$location['title'] 	= _('Admin-Catalog');
			$location['section']	= 'admin';
			break;
		case 'admin/catalog.php':
			$location['title'] 	= _('Admin-Catalog');
			$location['section']	= 'admin';
			break;
		case 'admin/users.php':
			$location['title']	= _('Admin-User Management');
			$location['section']	= 'admin';
			break;
		case 'admin/mail.php':
			$location['title']	= _('Admin-Mail Users');
			$location['section']	= 'admin';
			break;
		case 'admin/access.php':
			$location['title']	= _('Admin-Manage Access Lists');
			$location['section']	= 'admin';
			break;
		case 'admin/preferences.php':
			$location['title']	= _('Admin-Site Preferences');
			$location['section']	= 'admin';
			break;
		case 'admin/modules.php':
			$location['title']	= _('Admin-Manage Modules');
			$location['section']	= 'admin';
			break;
		case 'browse.php':
			$location['title']	= _('Browse Music');
			$location['section']	= 'browse';
			break;
		case 'albums.php':
			$location['title']	= _('Albums');
			$location['section']	= 'browse';
			break;
		case 'artists.php':
			$location['title']	= _('Artists');
			$location['section']	= 'browse';
			break;
		case 'genre.php':
			$location['title']	= _('Genre');
			$location['section']	= 'browse';
			break;
		case 'stats.php':
			$location['title']	= _('Statistics');
			break;
		default:
			$location['title'] = '';
			break;
	} // switch on raw page location

	return $location;

} // get_location

/**
 * show_preference_box
 * This shows the preference box for the preferences pages
 * it takes a chunck of the crazy preference array and then displays it out
 * it does not contain the <form> </form> tags
 */
function show_preference_box($preferences) { 
	
	require Config::get('prefix') . '/templates/show_preference_box.inc.php';

} // show_preference_box

/**
 * good_email
 * Don't get me started... I'm sure the indenting is still wrong on this
 * it shouldn't be named this, it should be documented, yea this needs
 * some serious MOJO work
 */
function good_email($email) {
	// First check that there's one @ symbol, and that the lengths are good
	if (!ereg("^[^@]{1,64}@[^@]{1,255}$", $email)) {
		// Email invalid because wrong number of characters in one section, or wrong number of @ symbols.
		return false;
	}

	// Split it into sections
	$email_array = explode("@", $email);
	$local_array = explode(".", $email_array[0]);
	for ($i = 0; $i < sizeof($local_array); $i++) {
		if (!ereg("^(([A-Za-z0-9!#$%&'*+/=?^_`{|}~-][A-Za-z0-9!#$%&'*+/=?^_`{|}~\.-]{0,63})|(\"[^(\\|\")]{0,62}\"))$", $local_array[$i])) {
				return false;
			}
		}
	if (!ereg("^\[?[0-9\.]+\]?$", $email_array[1])) { // Check if domain is IP. If not, it should be valid domain name
		$domain_array = explode(".", $email_array[1]);
		if (sizeof($domain_array) < 2) {
			return false; // Not enough parts to domain
		}
		for ($i = 0; $i < sizeof($domain_array); $i++) {
			if (!ereg("^(([A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9])|([A-Za-z0-9]+))$", $domain_array[$i])) {
				return false;
			}
		}
	}
	return true;
} //good_email

/**
 * str_rand
 *
 *
 */
function str_rand($length = 8, $seeds = 'abcdefghijklmnopqrstuvwxyz0123456789'){
    $str = '';
    $seeds_count = strlen($seeds);

    // Seed
    list($usec, $sec) = explode(' ', microtime());
    $seed = (float) $sec + ((float) $usec * 100000);
    mt_srand($seed);

    // Generate
    for ($i = 0; $length > $i; $i++) {
        $str .= $seeds{mt_rand(0, $seeds_count - 1)};
    }

    return $str;
} //str_rand

/**
 * send_confirmation
 *
 *
 */
function send_confirmation($username, $fullname, $email, $password, $validation) {

$title = conf('site_title');
$from = "From: Ampache <".conf('mail_from').">";
$body = "Welcome to $title

Please keep this email for your records. Your account information is as follows: 

----------------------------
Username: $username
Password: $password
----------------------------

Your account is currently inactive. You cannot use it until you visit the following link:
"
. conf('web_path'). "/activate.php?mode=activate&u=$username&act_key=$validation

Please do not forget your password as it has been encrypted in our database and we cannot retrieve it for you. However, should you forget your password you can request a new one which will be activated in the same way as this account.

Thank you for registering.";


mail($email, "Welcome to $title" , $body, $from);

if (conf('admin_notify_reg')){

$admin_body = "A new user has registered at $title

The following values where entered;

Username: $username
Fullname: $fullname
E-Mail: $email

Click here to view user:
"
 . conf('web_path') . "/admin/users.php?action=edit&user=$username";



mail (conf('mail_from'), "New user registration at $title", $admin_body, $from);
}


} //send_confirmation

/**
 * show_registration_agreement
 * This function reads in /config/registration_agreement.php
 * Plaintext Only
 */
function show_registration_agreement() { 

	$filename = conf('prefix') . '/config/registration_agreement.php';

	/* Check for existance */
	$fp = fopen($filename,'r');

	if (!$fp) { return false; }

	$data = fread($fp,filesize($filename));

	/* Scrub and show */
	echo $data;
		
} // show_registration_agreement


/**
 * show_playlist_import
 * This shows the playlist import templates
 */
function show_playlist_import() { 

	require (conf('prefix') . '/templates/show_import_playlist.inc.php');

} // show_playlist_import

/**
 * show_album_select
 * This displays a select of every album that we've got in Ampache, (it can be hella long) it's used
 * by the Edit page, it takes a $name and a $album_id 
 */
function show_album_select($name='album',$album_id=0) { 

	echo "<select name=\"$name\">\n";

	$sql = "SELECT `id`, `name`, `prefix` FROM `album` ORDER BY `name`";
	$db_results = Dba::query($sql);

	while ($r = Dba::fetch_assoc($db_results)) { 
		$selected = '';
		$album_name = trim($r['prefix'] . " " . $r['name']);
		if ($r['id'] == $album_id) { 
			$selected = "selected=\"selected\"";
		}

		echo "\t<option value=\"" . $r['id'] . "\" $selected>" . scrub_out($album_name) . "</option>\n";
		
	} // end while

	echo "</select>\n";

} // show_album_select

/**
 * show_artist_select
 * This is the same as the album select except it's *gasp* for artists how inventive!
 */
function show_artist_select($name='artist', $artist_id=0) { 

	echo "<select name=\"$name\">\n";
	
	$sql = "SELECT `id`, `name`, `prefix` FROM `artist` ORDER BY `name`";
	$db_results = Dba::query($sql);
	
	while ($r = Dba::fetch_assoc($db_results)) { 
		$selected = '';
		$artist_name = trim($r['prefix'] . " " . $r['name']);
		if ($r['id'] == $artist_id) { 
			$selected = "selected=\"selected\"";
		}

		echo "\t<option value=\"" . $r['id'] . "\" $selected>" . scrub_out($artist_name) . "</option>\n";

	} // end while

	echo "</select>\n";

} // show_artist_select

/**
 * show_genre_select
 * It's amazing we have three of these funtions now, this one shows a select of genres and take s name
 * and a selected genre... Woot!
 */
function show_genre_select($name='genre',$genre_id=0) { 

	echo "<select name=\"$name\">\n";

	$sql = "SELECT `id`, `name` FROM `genre` ORDER BY `name`";
	$db_results = Dba::query($sql);

	while ($r = Dba::fetch_assoc($db_results)) { 
		$selected = '';
		$genre_name = $r['name'];
		if ($r['id'] == $genre_id) { 
			$selected = "selected=\"selected\"";
		}
	
		echo "\t<option value=\"" . $r['id'] . "\" $selected>" . scrub_out($genre_name) . "</option>\n";
	
	} // end while

	echo "</select>\n";

} // show_genre_select

/**
 * show_catalog_select
 * Yet another one of these buggers. this shows a drop down of all of your catalogs 
 */
function show_catalog_select($name='catalog',$catalog_id=0,$style='') { 

	echo "<select name=\"$name\" style=\"$style\">\n";

	$sql = "SELECT `id`, `name` FROM `catalog` ORDER BY `name`";
	$db_results = Dba::query($sql);

	while ($r = Dba::fetch_assoc($db_results)) { 
		$selected = '';
		if ($r['id'] == $catalog_id) { 
			$selected = "selected=\"selected\"";
		}

		echo "\t<option value=\"" . $r['id'] . "\" $selected>" . scrub_out($r['name']) . "</option>\n";

	} // end while

	echo "</select>\n";

} // show_catalog_select

/**
 * show_user_select
 * This one is for users! shows a select/option statement so you can pick a user
 * to blame
 */
function show_user_select($name,$selected='',$style='') { 

	echo "<select name=\"$name\" style=\"$style\">\n";
	echo "\t<option value=\"\">" . _('None') . "</option>\n";

	$sql = "SELECT username as id,fullname FROM user ORDER BY fullname";
	$db_results = mysql_query($sql, dbh());

	while ($r = mysql_fetch_assoc($db_results)) { 
		$select_txt = '';
		if ($r['id'] == $selected) { 
			$select_txt = 'selected="selected"';
		}

		echo "\t<option value=\"" . $r['id'] . "\" $select_txt>" . scrub_out($r['fullname']) . "</option>\n";
		
	} // end while users

} // show_user_select

/**
 * show_box_top
 * This function requires the top part of the box
 * it takes title as an optional argument
 */
function show_box_top($title='',$class='') { 

	require Config::get('prefix') . '/templates/show_box_top.inc.php';	

} // show_box_top

/**
 * show_box_bottom
 * This function requires the bottom part of the box
 * it does not take any arguments
 */
function show_box_bottom() { 

	require Config::get('prefix') . '/templates/show_box_bottom.inc.php';

} // show_box_bottom

/**
 * get_user_icon
 * this function takes a name and a returns either a text representation
 * or an <img /> tag 
 */
function get_user_icon($name,$title='',$id='') { 
	
	/* Because we do a lot of calls cache the URLs */
	static $url_cache = array(); 

	// If our name is an array
	if (is_array($name)) { 
		$hover_name = $name['1']; 
		$name = $name['0']; 
	} 

	if (!$title) { $title = $name; } 

	if ($id) { 
		$id_element = 'id="' . $id . '"'; 
	} 

	if (isset($url_cache[$name])) { 
		$img_url = $url_cache[$name]; 
		$cache_url = true; 
	}
	if (isset($url_cache[$hover_name])) { 
		$hover_url = $url_cache[$hover_name];
		$cache_hover = true; 
	}
	
	if (empty($hover_name)) { $cache_hover = true; } 

	if (!isset($cache_url) OR !isset($cache_hover)) { 

		$icon_name = 'icon_' . $name . '.png';

		/* Build the image url */
		if (file_exists(Config::get('prefix') . '/themes/' . Config::get('theme_path') . '/images/' . $icon_name)) { 
			$img_url = Config::get('web_path') . Config::get('theme_path') . '/images/' . $icon_name;
		}
		else { 
			$img_url = Config::get('web_path') . '/images/' . $icon_name; 
		}

		/* If Hover, then build its url */
		if (!empty($hover_name)) { 
			$hover_icon = 'icon_' . $hover_name . '.png';
			if (file_exists(Config::get('prefix') . '/themes/' . Config::get('theme_path') . '/images/' . $icon_name)) { 
				$hov_url = Config::get('web_path') . Config::get('theme_path') . '/images/' . $hover_icon;
			}
			else { 
				$hov_url = Config::get('web_path') . '/images/' . $hover_icon;
			}
			
			$hov_txt = "onmouseover=\"this.src='$hov_url'; return true;\" onmouseout=\"this.src='$img_url'; return true;\"";
		} // end hover

	} // end if not cached

	$string = "<img style=\"cursor: pointer;\" src=\"$img_url\" $id_element border=\"0\" alt=\"" . ucfirst($title) . "\" title=\"" . ucfirst($title) . "\" $hov_txt/>";

	return $string;

} // get_user_icon

/**
 * xml_from_array
 * This takes a one dimensional array and 
 * creates a XML document form it for use 
 * primarly by the ajax mojo
 */
function xml_from_array($array,$callback=0,$type='') { 
	switch ($type) {
	
	case 'itunes':
	        foreach ($array as $key=>$value) {
	                if (is_array($value)) {
        	                $value = xml_from_array($value,1,$type);
                	        $string .= "\t\t<$key>\n$value\t\t</$key>\n";
	                }
        	        else {
                	        if ($key == "key"){
                        	$string .= "\t\t<$key>$value</$key>\n";
	                        } elseif (is_numeric($value)) {
        	                $string .= "\t\t\t<key>$key</key><integer>$value</integer>\n";
                	        } elseif ($key == "Date Added") {
                        	$string .= "\t\t\t<key>$key</key><date>$value</date>\n";
	                        } elseif (is_string($value)) {
        	                /* We need to escape the value */
                	        $string .= "\t\t\t<key>$key</key><string><![CDATA[$value]]></string>\n";
	                        }
        	        }

	        }

		return $string;
	break;
	case 'xspf':
	        foreach ($array as $key=>$value) {
	                if (is_array($value)) {
        	                $value = xml_from_array($value,1,$type);
                	        $string .= "\t\t<$key>\n$value\t\t</$key>\n";
	                }
        	        else {
                	        if ($key == "key"){
                        	$string .= "\t\t<$key>$value</$key>\n";
	                        } elseif (is_numeric($value)) {
        	                $string .= "\t\t\t<$key>$value</$key>\n";
	                        } elseif (is_string($value)) {
        	                /* We need to escape the value */
                	        $string .= "\t\t\t<$key><![CDATA[$value]]></$key>\n";
	                        }
        	        }

	        }

		return $string;
	break;
	default:
		foreach ($array as $key=>$value) { 
			if (is_numeric($key)) { $key = 'item'; } 
			if (is_array($value)) { 
				$value = xml_from_array($value,1);
				$string .= "\t<content div=\"$key\">$value</content>\n";
			}
			else { 
				/* We need to escape the value */
				$string .= "\t<content div=\"$key\"><![CDATA[$value]]></content>\n";
			}
		// end foreach elements
	        } 
		if (!$callback) { 
			$string = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<root>\n" . $string . "</root>\n";
		}

		return $string;
	break;
	}
} // xml_from_array

/**
 * xml_get_header
 * This takes the type and returns the correct xml header 
 */
function xml_get_header($type){
	switch ($type){
	case 'itunes':
		$header = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" .
                "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\"\n" .
                "\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n" .
                "<plist version=\"1.0\">\n" .
                "<dict>\n" .
                "       <key>Major Version</key><integer>1</integer>\n" .
                "       <key>Minor Version</key><integer>1</integer>\n" .
                "       <key>Application Version</key><string>7.0.2</string>\n" .
                "       <key>Features</key><integer>1</integer>\n" .
                "       <key>Show Content Ratings</key><true/>\n" .
                "       <key>Tracks</key>\n" .
                "       <dict>\n";
		return $header;
	break;
	case 'xspf':
                $header = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n" .
                	  "<playlist version = \"1\" xmlns=\"http://xspf.org/ns/0/\">\n ".
                	  "<title>Ampache XSPF Playlist</title>\n" .
                	  "<creator>" . Config::get('site_title') . "</creator>\n" .
                	  "<annotation>" . Config::get('site_title') . "</annotation>\n" .
                	  "<info>". Config::get('web_path') ."</info>\n" .
                	  "<trackList>\n\n\n\n";
		return $header;	
	break;
	default:
		$header = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; 
		return $header;	
	break;
	}
} //xml_get_header

/**
 * xml_get_footer
 * This takes the type and returns the correct xml footer
 */
function xml_get_footer($type){
	switch ($type){
	case 'itunes':
        	$footer = "      </dict>\n" .
                "</dict>\n" .
                "</plist>\n";
		return $footer;
	break;
	case 'xspf':
                $footer = "          </trackList>\n" .
                	  "</playlist>\n";
		return $footer;
	break;
	default:

	break;
	}
} //xml_get_footer

/**
 * ajax_include
 * This does an ob_start, getcontents, clean
 * on the specified require, only works if you
 * don't need to pass data in
 */
function ajax_include($include) { 

	ob_start(); 
	require_once Config::get('prefix') . '/templates/' . $include; 
	$results = ob_get_contents(); 
	ob_end_clean(); 

	return $results; 

} // ajax_include

?>