path: root/modules/localplay/shoutcast.controller.php

<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/*

 Copyright 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 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.

*/

/**
 * AmpacheShoutCast
 * This class handles the shoutcast extension this is kind of an ugly controller
 * ooh well you do what you can
 */
class AmpacheShoutCast extends localplay_controller {

	/* Variables */
	private $version 	= '000001';
	private $description	= 'Outputs to a local shoutcast server';

	private $local_path;
	private $pid;
	private $playlist;

	// Generated
	private $files = array();

	/**
	 * Constructor
	 * This returns the array map for the localplay object
	 * REQUIRED for Localplay
	 */
	public function __construct() {





	} // AmpacheShoutCast

	/**
	 * get_description
	 * Returns the description
	 */
	public function get_description() {

		return $this->description;

	} // get_description

	/**
	 * get_version
	 * This returns the version information
	 */
	public function get_version() {

		return $this->version;

	} // get_version

	/**
	 * is_installed
	 * This returns true or false if MPD controller is installed
	 */
	public function is_installed() {

                $sql = "DESCRIBE `localplay_shoutcast`";
                $db_results = Dba::read($sql);

                return Dba::num_rows($db_results);

	} // is_installed

	/**
	 * install
	 * This function installs the MPD localplay controller
	 */
	public function install() {

                /* We need to create the MPD table */
                $sql = "CREATE TABLE `localplay_shoutcast` ( `id` INT( 11 ) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY , " .
                        "`name` VARCHAR( 128 ) COLLATE utf8_unicode_ci NOT NULL , " .
                        "`owner` INT( 11 ) NOT NULL , " .
                        "`pid` VARCHAR( 255 ) COLLATE utf8_unicode_ci NOT NULL , " .
                        "`playlist` VARCHAR ( 255 ) COLLATE utf8_unicode_ci NOT NULL, " .
                        "`local_root` VARCHAR( 255 ) COLLATE utf8_unicode_ci NOT NULL , " .
                        "`access` SMALLINT( 4 ) UNSIGNED NOT NULL DEFAULT '0'" .
                        ") ENGINE = MYISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci";
                $db_results = Dba::write($sql);

		// Add an internal preference for the users current active instance
		Preference::insert('shoutcast_active','Shoutcast Active Instance','0','25','integer','internal');
		User::rebuild_all_preferences();

                return true;

	} // install

	/**
	 * uninstall
	 * This removes the localplay controller
	 */
	public function uninstall() {

                $sql = "DROP TABLE `localplay_shoutcast`";
                $db_results = Dba::write($sql);

		Preference::delete('shoutcast_active');

                return true;

	} // uninstall

	/**
	 * add_instance
	 * This takes key'd data and inserts a new MPD instance
	 */
	public function add_instance($data) {

		foreach ($data as $key=>$value) {
			switch ($key) {
				case 'name':
				case 'pid':
				case 'playlist':
				case 'local_root':
					${$key} = Dba::escape($value);
				break;
				default:

				break;
			} // end switch
		} // end foreach

		$user_id = Dba::escape($GLOBALS['user']->id);

		$sql = "INSERT INTO `localplay_shoutcast` (`name`,`pid`,`playlist`,`local_root`,`owner`) " .
			"VALUES ('$name','$pid','$playlist','$local_root','$user_id')";
		$db_results = Dba::write($sql);

		return $db_results;

	} // add_instance

	/**
 	 * delete_instance
	 * This takes a UID and deletes the instance in question
	 */
	public function delete_instance($uid) {

		$uid = Dba::escape($uid);

		// Go ahead and delete this mofo!
		$sql = "DELETE FROM `localplay_shoutcast` WHERE `id`='$uid'";
		$db_results = Dba::write($sql);

		return true;

	} // delete_instance

	/**
 	 * get_instances
	 * This returns a key'd array of the instance information with
	 * [UID]=>[NAME]
	 */
	public function get_instances() {

		$sql = "SELECT * FROM `localplay_shoutcast` ORDER BY `name`";
		$db_results = Dba::read($sql);

		$results = array();

		while ($row = Dba::fetch_assoc($db_results)) {
			$results[$row['id']] = $row['name'];
		}

		return $results;

	} // get_instances

	/**
	 * get_instance
	 * This returns the specified instance and all it's pretty variables
	 * If no instance is passed current is used
	 */
	public function get_instance($instance='') {

		$instance = $instance ? $instance : Config::get('shoutcast_active');
		$instance = Dba::escape($instance);

		$sql = "SELECT * FROM `localplay_shoutcast` WHERE `id`='$instance'";
		$db_results = Dba::read($sql);

		$row = Dba::fetch_assoc($db_results);

		return $row;

	} // get_instance

	/**
	 * update_instance
	 * This takes an ID and an array of data and updates the instance specified
	 */
	public function update_instance($uid,$data) {

		$uid 	= Dba::escape($uid);
		$pid	= Dba::escape($data['pid']);
		$playlist	= Dba::escape($data['playlist']);
		$name	= Dba::escape($data['name']);
		$local_root	= Dba::escape($data['local_root']);

		$sql = "UPDATE `localplay_shoutcast` SET `pid`='$pid', `playlist`='$playlist', `name`='$name', `local_root`='$local_root' WHERE `id`='$uid'";
		$db_results = Dba::write($sql);

		return true;

	} // update_instance

	/**
	 * instance_fields
	 * This returns a key'd array of [NAME]=>array([DESCRIPTION]=>VALUE,[TYPE]=>VALUE) for the
	 * fields so that we can on-the-fly generate a form
	 */
	public function instance_fields() {

		$fields['name'] 	= array('description'=>_('Instance Name'),'type'=>'textbox');
		$fields['pid'] 		= array('description'=>_('PID File'),'type'=>'textbox');
		$fields['playlist']	= array('description'=>_('Playlist File'),'type'=>'textbox');
		$fields['local_root']	= array('description'=>_('Local Path to Files'),'type'=>'textbox');

		return $fields;

	} // instance_fields

	/**
	 * set_active_instance
	 * This sets the specified instance as the 'active' one
	 */
	public function set_active_instance($uid,$user_id='') {

		// Not an admin? bubkiss!
		if (!$GLOBALS['user']->has_access('100')) {
			$user_id = $GLOBALS['user']->id;
		}

		$user_id = $user_id ? $user_id : $GLOBALS['user']->id;

		Preference::update('shoutcast_active',$user_id,intval($uid));
		Config::set('shoutcast_active',intval($uid),'1');

		return true;

	} // set_active_instance

	/**
	 * get_active_instance
	 * This returns the UID of the current active instance
	 * false if none are active
	 */
	public function get_active_instance() {


	} // get_active_instance

	/**
	 * add
	 * This takes a single object and adds it in, it uses the built in
	 * functions to generate the URL it needs
	 */
	public function add($object) {

		// Before we add this it must be a mp3
		$object->format_type();

		if ($object->mime != 'audio/mpeg') {
			debug_event('ShoutCast','Error: Unable to play ' . $this->mime . ' files with shoutcast, skipping','3');
			return false;
		}
		if ($object->rate != '44100') {
			debug_event('Shoutcast','Error: Unable to play ' . $this->rate . ' files with shoutcast, skipping','3');
			return false;
		}


		// Take the filename and strip off the catalog's root_path and put our
		// prefix onto it
		$filename = $object->file;
		$catalog = new Catalog($object->catalog);

		if ($this->local_path) {
			$filename = str_replace($catalog->path,$this->local_path,$filename);
		}

		$this->files[] = $filename;

		return true;

	} // add

	/**
	 * delete_track
	 * This must take a single ID (as passed by get function) from Ampache
	 * and delete it from the current playlist
	 */
	public function delete_track($object_id) {

		return true;

	} // delete_track

	/**
	 * clear_playlist
	 * This deletes the entire MPD playlist... nuff said
	 */
	function clear_playlist() {

		return true;

	} // clear_playlist

	/**
	 * play
	 * This just tells MPD to start playing, it does not
	 * take any arguments
	 */
	public function play() {

		// If we have no files[] then just Reload the server nothing else
		if (!count($this->files)) {
			$this->send_command('reload');
		}
		else {
			$this->write_playlist();
			$this->send_command('reload');
		}

		return true;

	} // play

	/**
	 * stop
	 * This just stops the shoutcast server
	 */
	public function stop() {

		$this->send_command('stop');
		return true;

	} // stop

	/**
	 * skip
	 * This tells MPD to skip to the specified song
	 */
	function skip($song) {

		return true;

	} // skip

	/**
	 * This tells MPD to increase the volume by 5
	 */
	public function volume_up() {

		return true;

	} // volume_up

	/**
	 * This tells MPD to decrese the volume by 5
	 */
	public function volume_down() {

		return true;

	} // volume_down

	/**
	 * next
	 * This just tells MPD to skip to the next song
	 */
	public function next() {

		$this->send_command('next');
		return true;

	} // next

	/**
	 * prev
	 * This just tells MPD to skip to the prev song
	 */
	public function prev() {

		return true;

	} // prev

	/**
	 * pause
	 */
	public function pause() {

		return true;

	} // pause

        /**
        * volume
        * This tells MPD to set the volume to the parameter
        */
       public function volume($volume) {

               return true;

       } // volume

       /**
        * repeat
        * This tells MPD to set the repeating the playlist (i.e. loop) to either on or off
        */
       public function repeat($state) {

       		return true;

       } // repeat


       /**
        * random
        * This tells MPD to turn on or off the playing of songs from the playlist in random order
        */
       public function random($onoff) {

		$this->send_command('shuffle');
		return true;

       } // random

       /**
        * move
        * This tells MPD to move song from SrcPos to DestPos
        */
       public function move($SrcPos, $DestPos) {

        	return true;
	} // move

	/**
	 * get_songs
	 * This functions returns an array containing information about
	 * The songs that MPD currently has in it's playlist. This must be
	 * done in a standardized fashion
	 */
	public function get() {

		$songs = $this->get_playlist();

		foreach ($songs as $key=>$file) {
			$data['id'] = $key;
			$data['raw'] = $file;
			$data['name'] = $file;
			$results[] = $data;
		}

		return $results;

	} // get

	/**
	 * get_status
	 * This returns bool/int values for features, loop, repeat and any other features
	 * That this localplay method support
	 */
	public function status() {

		return array();

	} // get_status

	/**
	 * connect
	 * This functions creates the connection to MPD and returns
	 * a boolean value for the status, to save time this handle
	 * is stored in this class
	 */
	public function connect() {

		// We should use this oppertunity to setup the current object
		$info = $this->get_instance();

		foreach ($info as $key=>$value) {
			$this->$key = $value;
		}

		if (!count($info)) { return false; }

		return true;

	} // connect

	/**
	 * get_pid
	 * This returns the pid for the current instance
	 */
	public function get_pid() {

		// Read and clean!
		$pid = intval(trim(file_get_contents($this->pid)));

		if (!$pid) {
			debug_event('Shoutcast','Unable to read PID from ' . $this->pid,'1');
		}

		return $pid;

	} // get_pid

	/**
	 * write_playlist
 	 * This takes the files that we've got in our array and writes them out
	 */
	public function write_playlist() {

		$string = implode("\n",$this->files) . "\n";

		$handle = fopen($this->playlist,'w');

		if (!is_resource($handle)) {
			debug_event('Shoutcast','Unable to open ' . $this->playlist . ' for writing playlist file','1');
			return false;
		}

		fwrite($handle,$string);
		fclose($handle);

		return true;

	} // write_playlist

	/**
	 * get_playlist
	 * This reads in the playlist and returns an array of filenames
	 */
	public function get_playlist() {

		$data = file_get_contents($this->playlist);

		if (!$data) {
			debug_event('Shoutcast','Unable to open ' . $this->playlist . ' for reading or file empty','1');
			return false;
		}

		$results = explode("\n",$data);

		return $results;

	} // get_playlist

	/**
	 * send_command
	 * This is the single funciton that's used to send commands to the
	 * shoutcast server, one function makes it easier to ensure we've escaped our input
	 */
	public function send_command($command,$options=array()) {

		// Just incase someone uses some crazy syntax
		$command = strtolower($command);
		$pid = $this->get_pid();
		if (!$pid) { return false; }

		switch ($command) {
			case 'hup':
				$command = '/bin/kill -l HUP ' . escapeshellarg($pid);
				system($command,$return);
			break;
			case 'reload':
				$command = '/bin/kill -l USR1 ' . escapeshellarg($pid);
				system($command,$return);
			break;
			case 'next':
				$commend = '/bin/kill -l WINCH ' . escapeshellarg($pid);
				system($command,$return);
			break;
			case 'shuffle':
				$command = '/bin/kill -l USR2 ' . escapeshellarg($pid);
				system($command,$return);
			break;
			case 'stop':
				$command = '/bin/kill -l TERM ' . escapeshellarg($pid);
				system($command,$return);
			break;
			case 'start':
				$command = '';
				system($command,$return);
			break;
			default:
				return false;
			break;
		} // end switch on the commands we allow

		debug_event('Shoutcat','Issued ' . $command . ' and received ' . $return,'3');

		return false;

	} // send_command

} //end of AmpacheShoutcast

?>