"name", "dc:creator" => "creator", "dc:description" => "description", "dcterms:extent" => "length");
public function __construct($p_gunid=NULL)
{
}
public static function Insert($p_values)
{
global $CC_CONFIG, $CC_DBC;
// Create the StoredPlaylist object
$storedPlaylist = new Playlist();
$storedPlaylist->name = isset($p_values['filename']) ? $p_values['filename'] : date("H:i:s");
// NOTE: POSTGRES-SPECIFIC KEYWORD "DEFAULT" BEING USED, WOULD BE "NULL" IN MYSQL
$storedPlaylist->id = isset($p_values['id']) && is_integer($p_values['id'])?"'".$p_values['id']."'":'DEFAULT';
// Insert record into the database
$escapedName = pg_escape_string($storedPlaylist->name);
$CC_DBC->query("BEGIN");
$sql = "INSERT INTO ".$CC_CONFIG['playListTable']
."(id, name, state, mtime)"
." VALUES ({$storedPlaylist->id}, '{$escapedName}', "
." 'incomplete', now())";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
if (!is_integer($storedPlaylist->id)) {
// NOTE: POSTGRES-SPECIFIC
$sql = "SELECT currval('".$CC_CONFIG["playListSequence"]."_seq')";
$storedPlaylist->id = $CC_DBC->getOne($sql);
}
// Save state
$res = $storedPlaylist->setState('ready');
// Commit changes
$res = $CC_DBC->query("COMMIT");
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
return $storedPlaylist->id;
}
public static function Delete($id) {
global $CC_CONFIG, $CC_DBC;
$CC_DBC->query("BEGIN");
$sql = "DELETE FROM ".$CC_CONFIG['playListTable']. " WHERE id='{$id}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
// Commit changes
$res = $CC_DBC->query("COMMIT");
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
return TRUE;
}
/**
* Fetch instance of Playlist object.
*
* @param string $id
* DB id of file
* @return Playlist|NULL
* Return NULL if the object doesnt exist in the DB.
*/
public static function Recall($id) {
global $CC_DBC, $CC_CONFIG;
$escapedID = pg_escape_string($id);
$sql = "SELECT id,"
." name, state, currentlyaccessing, editedby, "
." mtime"
." FROM ".$CC_CONFIG['playListTable']
." WHERE id ='{$escapedID}'";
$row = $CC_DBC->getRow($sql);
if (PEAR::isError($row)) {
return FALSE;
}
if (is_null($row)) {
return FALSE;
}
$storedPlaylist = new Playlist($id);
$storedPlaylist->id = $row['id'];
$storedPlaylist->name = $row['name'];
$storedPlaylist->state = $row['state'];
$storedPlaylist->currentlyaccessing = $row['currentlyaccessing'];
$storedPlaylist->editedby = $row['editedby'];
$storedPlaylist->mtime = $row['mtime'];
return $storedPlaylist;
}
/**
* Rename stored virtual playlist
*
* @param string $p_newname
* @return TRUE|PEAR_Error
*/
public function setName($p_newname)
{
global $CC_CONFIG, $CC_DBC;
$escapedName = pg_escape_string($p_newname);
$sql = "UPDATE ".$CC_CONFIG['playListTable']
." SET name='$escapedName', mtime=now()"
." WHERE id='{$this->id}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
return $res;
}
$this->name = $p_newname;
return TRUE;
}
/**
* Get mnemonic playlist name
*
* @param string $p_gunid
* global unique id of playlist
* @return string
*/
public function getName($id=NULL)
{
global $CC_CONFIG, $CC_DBC;
if (is_null($id)) {
return $this->name;
}
$sql = "SELECT name FROM ".$CC_CONFIG['playListTable']
." WHERE id='$id'";
return $CC_DBC->getOne($sql);
}
/**
* Set state of virtual playlist
*
* @param string $p_state
* 'empty'|'incomplete'|'ready'|'edited'
* @param int $p_editedby
* user id | 'NULL' for clear editedBy field
* @return TRUE|PEAR_Error
*/
public function setState($p_state, $p_editedby=NULL)
{
global $CC_CONFIG, $CC_DBC;
$escapedState = pg_escape_string($p_state);
$eb = (!is_null($p_editedby) ? ", editedBy=$p_editedby" : '');
$sql = "UPDATE ".$CC_CONFIG['playListTable']
." SET state='$escapedState'$eb, mtime=now()"
." WHERE id='{$this->id}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
return $res;
}
$this->state = $p_state;
$this->editedby = $p_editedby;
return TRUE;
}
/**
* Get storage-internal file state
*
* @param string $p_gunid
* global unique id of file
* @return string
* see install()
*/
public function getState($id=NULL)
{
global $CC_CONFIG, $CC_DBC;
if (is_null($id)) {
return $this->state;
}
$sql = "SELECT state FROM ".$CC_CONFIG['playListTable']
." WHERE id='$id'";
return $CC_DBC->getOne($sql);
}
/**
* TODO have to change this.
* */
/*
public function isScheduled() {
global $CC_CONFIG, $CC_DBC;
$sql = "SELECT * "
." FROM ".$CC_CONFIG['scheduleTable']
." WHERE ends > now() and playlist=x'{$this->gunid}'::bigint";
$scheduled = $CC_DBC->getAll($sql);
return $scheduled;
}
*/
/**
* Returns true if virtual file is currently in use.
* Static or dynamic call is possible.
*
* @param string $p_gunid
* optional (for static call), global unique id
* @return boolean|PEAR_Error
*/
public function isAccessed($id=NULL)
{
global $CC_CONFIG, $CC_DBC;
if (is_null($id)) {
return ($this->currentlyaccessing > 0);
}
$sql = "SELECT currentlyAccessing FROM ".$CC_CONFIG['playListTable']
." WHERE id='$id'";
$ca = $CC_DBC->getOne($sql);
if (is_null($ca)) {
return PEAR::raiseError(
"StoredPlaylist::isAccessed: invalid id ($id)",
GBERR_FOBJNEX
);
}
return ($ca > 0);
}
/**
* Returns id of user editing playlist
*
* @param string $p_playlistId
* playlist global unique ID
* @return int id of user editing playlist
*/
public function isEdited() {
if($this->state === 'edited') {
return $this->editedby;
}
return FALSE;
}
/**
* Set playlist edit flag
*
* @param string $p_playlistId
* Playlist unique ID
* @param boolean $p_val
* Set/clear of edit flag
* @param string $p_sessid
* Session id
* @param int $p_subjid
* Subject id (if sessid is not specified)
* @return boolean
* TRUE on success.
*/
public function setEditFlag($p_val=TRUE, $p_sessid=NULL, $p_subjid=NULL) {
if (!is_null($p_sessid)) {
$p_subjid = Alib::GetSessUserId($p_sessid);
if (PEAR::isError($p_subjid)) {
return $p_subjid;
}
}
$state = $this->state;
if ($p_val) {
$r = $this->setState('edited', $p_subjid);
} else {
$r = $this->setState('ready', 'NULL');
}
if (PEAR::isError($r)) {
return $r;
}
return TRUE;
}
/**
* Return local ID of virtual file.
*
* @return int
*/
public function getId() {
return $this->id;
}
private function getNextPos() {
global $CC_CONFIG, $CC_DBC;
$sql = "SELECT MAX(position) AS nextPos
FROM cc_playlistcontents
WHERE playlist_id='{$this->getId()}'";
$res = $CC_DBC->getOne($sql);
if(is_null($res))
return 0;
if(PEAR::isError($res)){
return $res;
}
return $res + 1;
}
/**
* Get the entire playlist as a two dimentional array, sorted in order of play.
* @return array
*/
public function getContents() {
global $CC_CONFIG, $CC_DBC;
$sql = "SELECT *
FROM cc_playlistcontents C JOIN cc_files F ON C.file_id = F.id
WHERE C.playlist_id='{$this->getId()}' ORDER BY C.position";
return $CC_DBC->getAll($sql);
}
public function getLength() {
global $CC_CONFIG, $CC_DBC;
$sql = "SELECT SUM(cliplength) AS length FROM ".$CC_CONFIG['playListContentsTable']
." WHERE playlist_id='{$this->getId()}' group by playlist_id";
$res = $CC_DBC->getRow($sql);
if (PEAR::isError($res)) {
return $res;
}
if(is_null($res))
return '00:00:00.000000';
return $res['length'];
}
/**
* Create instance of Playlist object and insert empty file
*
* @param string $fname
* name of new file
* @return instance of Playlist object
*/
public function create($fname=NULL)
{
$values = array("filename" => $fname);
$pl_id = Playlist::Insert($values);
if (PEAR::isError($pl_id)) {
return $pl_id;
}
$this->id = $pl_id;
return $this->id;
}
/**
* Lock playlist for edit
*
* @param string $sessid
* session id
* @param int $subjid
* local subject (user) id
* @param boolean $val
* if false do unlock
* @return boolean
* previous state or error object
*/
public function lock($sessid, $subjid=NULL, $val=TRUE)
{
if ($val && $this->isEdited() !== FALSE) {
return PEAR::raiseError(
'Playlist::lock: playlist already locked'
);
}
$r = $this->setEditFlag($val, $sessid, $subjid);
return $r;
}
/**
* Unlock playlist
*
* @param sessId
* reference to GreenBox object
* @return boolean
* previous state or error object
*/
public function unlock($sessid)
{
$r = $this->lock($sessid, NULL, FALSE);
return $r;
}
/**
* Add audio clip to the playlist
*
* @param string $p_id
* local ID of added file
* @param string $p_position
* optional, Which position in the playlist to insert the audio clip
* @param string $p_fadeIn
* optional, in time format hh:mm:ss.ssssss - total duration
* @param string $p_fadeOut
* optional, in time format hh:mm:ss.ssssss - total duration
* @param string $p_clipLength
* optional length in in time format hh:mm:ss.ssssss -
* for webstream (or for overrule length of audioclip)
* @return true|PEAR_Error
* TRUE on success
*/
public function addAudioClip($p_id, $p_position=NULL, $p_fadeIn=NULL, $p_fadeOut=NULL, $p_clipLength=NULL, $p_cuein=NULL, $p_cueout=NULL)
{
//get audio clip.
$ac = StoredFile::Recall($p_id);
if (is_null($ac) || PEAR::isError($ac)) {
return $ac;
}
// get information about audioClip
$acInfo = $this->getAudioClipInfo($ac);
if (PEAR::isError($acInfo)) {
return $acInfo;
}
extract($acInfo); // 'acGunid', 'acLen', 'acTit', 'elType'
if (!is_null($p_clipLength)) {
$acLen = $p_clipLength;
}
// insert at end of playlist.
if (is_null($p_position))
$p_position = $this->getNextPos();
if (PEAR::isError($p_position)) {
return $p_position;
}
// insert default values if parameter was empty
$p_cuein = !is_null($p_cuein) ? $p_cuein : '00:00:00.000000';
$p_cueout = !is_null($p_cueout) ? $p_cueout : $acLen;
$acLengthS = $clipLengthS = self::playlistTimeToSeconds($acLen);
if (!is_null($p_cuein)) {
$clipLengthS = $acLengthS - self::playlistTimeToSeconds($p_cuein);
}
if (!is_null($p_cueout)) {
$clipLengthS = $clipLengthS - ($acLengthS - self::playlistTimeToSeconds($p_cueout));
}
$p_clipLength = self::secondsToPlaylistTime($clipLengthS);
$res = $this->insertPlaylistElement($this->getId(), $p_id, $p_position, $p_clipLength, $p_cuein, $p_cueout, $p_fadeIn, $p_fadeOut);
if (PEAR::isError($res)) {
return $res;
}
return TRUE;
}
/**
* Remove audioClip from playlist
*
* @param int $position
* position of audioclip in the playlist.
* @return boolean
*/
public function delAudioClip($pos)
{
global $CC_CONFIG, $CC_DBC;
if($pos < 0 || $pos >= $this->getNextPos())
return FALSE;
$pos = pg_escape_string($pos);
$CC_DBC->query("BEGIN");
$sql = "DELETE FROM ".$CC_CONFIG['playListContentsTable']." WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
// Commit changes
$res = $CC_DBC->query("COMMIT");
if (PEAR::isError($res)) {
$CC_DBC->query("ROLLBACK");
return $res;
}
return TRUE;
}
/**
* Move audioClip to the new position in the playlist
*
* @param int $oldPos
* old positioin in playlist
* @param int $newPos
* new position in playlist
* @return mixed
*/
public function moveAudioClip($oldPos, $newPos)
{
global $CC_CONFIG, $CC_DBC;
if($newPos < 0 || $newPos >= $this->getNextPos() || $oldPos < 0 || $oldPos >= $this->getNextPos())
return FALSE;
$oldPos = pg_escape_string($oldPos);
$newPos = pg_escape_string($newPos);
$sql = "SELECT * FROM ".$CC_CONFIG['playListContentsTable']. " WHERE playlist_id='{$this->getId()}' AND position='{$oldPos}'";
$ac = $CC_DBC->getRow($sql);
if (PEAR::isError($ac)) {
return $ac;
}
$res = $this->delAudioClip($oldPos);
if($res !== TRUE)
return FALSE;
$res = $this->addAudioClip($ac['file_id'], $newPos, $ac['fadein'], $ac['fadeOut'], $ac['cliplength'], $ac['cuein'], $ac['cueout']);
if($res !== TRUE)
return FALSE;
return TRUE;
}
/**
* Change fadeIn and fadeOut values for playlist Element
*
* @param int $pos
* position of audioclip in playlist
* @param string $fadeIn
* new value in ss.ssssss or extent format
* @param string $fadeOut
* new value in ss.ssssss or extent format
* @return boolean
*/
public function changeFadeInfo($pos, $fadeIn, $fadeOut)
{
global $CC_CONFIG, $CC_DBC;
$errArray= array();
if(is_null($pos) || $pos < 0 || $pos >= $this->getNextPos()) {
$errArray["error"]="Invalid position.";
return $errArray;
}
$sql = $sql = "SELECT cliplength
FROM cc_playlistcontents WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
$clipLength = $CC_DBC->getOne($sql);
if(!is_null($fadeIn) && !is_null($fadeOut)) {
if(Playlist::playlistTimeToSeconds($fadeIn) > Playlist::playlistTimeToSeconds($clipLength)) {
$errArray["error"]="Fade In can't be larger than overall playlength.";
return $errArray;
}
if(Playlist::playlistTimeToSeconds($fadeOut) > Playlist::playlistTimeToSeconds($clipLength)) {
$errArray["error"]="Fade Out can't be larger than overall playlength.";
return $errArray;
}
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable']. " SET fadein='{$fadeIn}', fadeout='{$fadeOut}' " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
else if(!is_null($fadeIn)) {
if(Playlist::playlistTimeToSeconds($fadeIn) > Playlist::playlistTimeToSeconds($clipLength)) {
$errArray["error"]="Fade In can't be larger than overall playlength.";
return $errArray;
}
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable']. " SET fadein='{$fadeIn}' " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
else if(!is_null($fadeOut)){
if(Playlist::playlistTimeToSeconds($fadeOut) > Playlist::playlistTimeToSeconds($clipLength)) {
$errArray["error"]="Fade Out can't be larger than overall playlength.";
return $errArray;
}
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable']. " SET fadeout='{$fadeOut}' " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$errArray["error"] =$res->getMessage();
return $errArray;
}
return array("fadeIn"=>$fadeIn, "fadeOut"=>$fadeOut);
}
/**
* Change cueIn/cueOut values for playlist element
*
* @param int $pos
* position of audioclip in playlist
* @param string $cueIn
* new value in ss.ssssss or extent format
* @param string $cueOut
* new value in ss.ssssss or extent format
* @return boolean or pear error object
*/
public function changeClipLength($pos, $cueIn, $cueOut)
{
global $CC_CONFIG, $CC_DBC;
$errArray= array();
if(is_null($cueIn) && is_null($cueOut)) {
$errArray["error"]="Cue in and cue out are null.";
return $errArray;
}
if(is_null($pos) || $pos < 0 || $pos >= $this->getNextPos()) {
$errArray["error"]="Invalid position.";
return $errArray;
}
$sql = $sql = "SELECT length AS original_length, cuein, cueout, fadein, fadeout
FROM cc_playlistcontents C JOIN cc_files F ON C.file_id = F.id
WHERE C.playlist_id='{$this->getId()}' AND position='{$pos}'";
$res = $CC_DBC->getRow($sql);
$origLength = $res['original_length'];
$oldCueIn = $res['cuein'];
$oldCueOut = $res['cueout'];
$fadeIn = $res['fadein'];
$fadeOut = $res['fadeout'];
if(!is_null($cueIn) && !is_null($cueOut)){
if($cueOut === ""){
$cueOut = $origLength;
}
if(Playlist::playlistTimeToSeconds($cueIn) > Playlist::playlistTimeToSeconds($cueOut)) {
$errArray["error"]= "Can't set cue in to be larger than cue out.";
return $errArray;
}
if(Playlist::playlistTimeToSeconds($cueOut) > Playlist::playlistTimeToSeconds($origLength)){
$errArray["error"] = "Can't set cue out to be greater than file length.";
return $errArray;
}
$cueIn = pg_escape_string($cueIn);
$cueOut = pg_escape_string($cueOut);
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable'].
" SET cuein='{$cueIn}', cueout='{$cueOut}', ".
"cliplength=(interval '{$cueOut}' - interval '{$cueIn}') " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
else if(!is_null($cueIn)) {
if(Playlist::playlistTimeToSeconds($cueIn) > Playlist::playlistTimeToSeconds($oldCueOut)) {
$errArray["error"] = "Can't set cue in to be larger than cue out.";
return $errArray;
}
$cueIn = pg_escape_string($cueIn);
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable'].
" SET cuein='{$cueIn}', cliplength=(interval '{$oldCueOut}' - interval '{$cueIn}') " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
else if(!is_null($cueOut)) {
if($cueOut === ""){
$cueOut = $origLength;
}
if(Playlist::playlistTimeToSeconds($cueOut) < Playlist::playlistTimeToSeconds($oldCueIn)) {
$errArray["error"] ="Can't set cue out to be smaller than cue in.";
return $errArray;
}
if(Playlist::playlistTimeToSeconds($cueOut) > Playlist::playlistTimeToSeconds($origLength)){
$errArray["error"] ="Can't set cue out to be greater than file length.";
return $errArray;
}
$cueOut = pg_escape_string($cueOut);
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable'].
" SET cueout='{$cueOut}', cliplength=(interval '{$cueOut}' - interval '{$oldCueIn}') " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
}
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$errArray["error"] =$res->getMessage();
return $errArray;
}
$sql = "SELECT cliplength FROM ".$CC_CONFIG['playListContentsTable']."
WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
$cliplength = $CC_DBC->getOne($sql);
if(Playlist::playlistTimeToSeconds($fadeIn) > Playlist::playlistTimeToSeconds($cliplength)){
$fadeIn = $cliplength;
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable'].
" SET fadein='{$fadeIn}' " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$errArray["error"] =$res->getMessage();
return $errArray;
}
}
if(Playlist::playlistTimeToSeconds($fadeOut) > Playlist::playlistTimeToSeconds($cliplength)){
$fadeOut = $cliplength;
$sql = "UPDATE ".$CC_CONFIG['playListContentsTable'].
" SET fadeout='{$fadeOut}' " .
"WHERE playlist_id='{$this->getId()}' AND position='{$pos}'";
$res = $CC_DBC->query($sql);
if (PEAR::isError($res)) {
$errArray["error"] =$res->getMessage();
return $errArray;
}
}
return array("cliplength"=>$cliplength, "cueIn"=>$cueIn, "cueOut"=>$cueOut, "length"=>$this->getLength(),
"fadeIn"=>$fadeIn, "fadeOut"=>$fadeOut);
}
/**
* Find info about clip at specified offset in playlist.
*
* @param string $offset
* current playtime (hh:mm:ss.ssssss)
* @param int $distance
* 0=current clip; 1=next clip ...
* @return array of matching clip info:
*