_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
}
return $this->bsCreateFolder($parid, $folderName);
} // fn createFolder
/**
* Store new file in the storage
*
* @param int $parid, parent id
* @param string $fileName
* The name for the new file.
* @param string $mediaFileLP
* Local path of the media file
* @param string $mdataFileLP
* Local path of the metadata file
* @param string $sessid
* Session id
* @param string $gunid
* Global unique id
* @param string $ftype
* Internal file type
* @return int
* @exception PEAR::error
*/
function putFile($parid, $fileName,
$mediaFileLP, $mdataFileLP, $sessid='',
$gunid=NULL, $ftype='audioclip')
{
if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
}
return $this->bsPutFile(
$parid, $fileName, $mediaFileLP, $mdataFileLP, $gunid, $ftype
);
} // fn putFile
/**
* Store new webstream
*
* @param int $parid
* Parent id
* @param string $fileName
* Name for new file
* @param string $mdataFileLP
* Local path of metadata file
* @param string $sessid
* Session id
* @param string $gunid
* Global unique id
* @param string $url
* Webstream url
* @return int
* @exception PEAR::error
*/
function storeWebstream($parid, $fileName, $mdataFileLP, $sessid='',
$gunid=NULL, $url)
{
if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
}
if (!file_exists($mdataFileLP)) {
$mdataFileLP = dirname(__FILE__).'/emptyWebstream.xml';
}
$oid = $this->bsPutFile(
$parid, $fileName, '', $mdataFileLP, $gunid, 'webstream'
);
if (PEAR::isError($oid)) {
return $oid;
}
$r = $this->bsSetMetadataValue(
$oid, 'ls:url', $url, NULL, NULL, 'metadata');
if (PEAR::isError($r)) {
return $r;
}
return $oid;
} // fn storeWebstream
/**
* Access stored file - increase access counter
*
* @param int $id
* virt.file's local id
* @param string $sessid
* session id
* @return string access token
*/
function accessFile($id, $sessid='')
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
$gunid = $this->_gunidFromId($id);
$r = $this->bsAccess(NULL, '', $gunid, 'access');
if (PEAR::isError($r)) {
return $r;
}
$token = $r['token'];
return $token;
} // fn accessFile
/**
* Release stored file - decrease access counter
*
* @param string $token
* access token
* @param string $sessid
* session id
* @return boolean
*/
function releaseFile($token, $sessid='')
{
$r = $this->bsRelease($token, 'access');
if (PEAR::isError($r)) {
return $r;
}
return FALSE;
} // fn releaseFile
/**
* Analyze media file for internal metadata information
*
* @param int $id
* Virtual file's local id
* @param string $sessid
* Session id
* @return array
*/
function analyzeFile($id, $sessid='')
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsAnalyzeFile($id);
} // fn analyzeFile
/**
* Rename file
*
* @param int $id
* Virtual file's local id
* @param string $newName
* @param string $sessid
* Session id
* @return boolean or PEAR::error
*/
function renameFile($id, $newName, $sessid='')
{
$parid = $this->getParent($id);
if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
}
return $this->bsRenameFile($id, $newName);
} // fn renameFile
/**
* Move file
*
* @param int $id
* virt.file's local id
* @param int $did
* destination folder local id
* @param string $sessid
* session id
* @return boolean or PEAR::error
*/
function moveFile($id, $did, $sessid='')
{
$res = $this->_authorize(array('read', 'write'), array($id, $did), $sessid);
if ($res !== TRUE) {
return $res;
}
return $this->bsMoveFile($id, $did);
} // fn moveFile
/**
* Copy file
*
* @param int $id
* virt.file's local id
* @param int $did
* destination folder local id
* @param string $sessid
* session id
* @return boolean or PEAR::error
*/
function copyFile($id, $did, $sessid='')
{
$res = $this->_authorize(array('read', 'write'), array($id, $did), $sessid);
if($res !== TRUE) {
return $res;
}
return $this->bsCopyFile($id, $did);
} // fn copyFile
/**
* Replace file. Doesn't change filetype!
*
* @param int $id
* virt.file's local id
* @param string $mediaFileLP
* local path of media file
* @param string $mdataFileLP
* local path of metadata file
* @param string $sessid
* session id
* @return true or PEAR::error
*/
function replaceFile($id, $mediaFileLP, $mdataFileLP, $sessid='')
{
if (($res = $this->_authorize('write', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsReplaceFile($id, $mediaFileLP, $mdataFileLP);
} // fn replaceFile
/**
* Delete file
*
* @param int $id
* virt.file's local id
* @param int $sessid
* @param boolean $forced
* if true don't use trash
* @return true or PEAR::error
*/
function deleteFile($id, $sessid='', $forced=FALSE)
{
$parid = $this->getParent($id);
if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
}
return $this->bsDeleteFile($id, $forced);
} // fn deleteFile
/* ------------------------------------------------------------- metadata */
/**
* Replace metadata with new XML file or string
*
* @param int $id
* virt.file's local id
* @param string $mdata
* XML string or local path of metadata XML file
* @param string $mdataLoc
* metadata location: 'file'|'string'
* @param string $sessid
* session id
* @return boolean or PEAR::error
*/
function replaceMetadata($id, $mdata, $mdataLoc='file', $sessid='')
{
if (($res = $this->_authorize('write', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsReplaceMetadata($id, $mdata, $mdataLoc);
} // fn replaceMetadata
/**
* Get metadata XML tree as string
*
* @param int $id
* virt.file's local id
* @param string $sessid
* session id
* @return string or PEAR::error
*/
function getMdata($id, $sessid='')
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsGetMetadata($id);
} // fn getMdata
/**
* Return metadata as hierarchical PHP hash-array
*
* If xml:lang attribute is specified in metadata category,
* array of metadata values indexed by xml:lang values
* is presented instead of one plain metadata value.
*
* @param int $id
* local object id
* @param string $sessid
* session ID
* @return array
*/
function getMdataArray($id, $sessid)
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
$ac = StoredFile::recall($this, $id);
if (PEAR::isError($ac)) {
return $ac;
}
$arr = $ac->md->genPhpArray();
$md = FALSE;
foreach ($arr['children'] as $i=>$a) {
if ($a['elementname'] == 'metadata'){
$md = $arr['children'][$i];
break;
}
}
if ($md === FALSE) {
return PEAR::raiseError(
"GreenBox::getMdataArray: no metadata container found"
);
}
$res = array();
foreach ($md['children'] as $el) {
$lang = isset($el['attrs']['xml:lang']) ? $el['attrs']['xml:lang'] : "";
$category = $el['elementname'];
if ($lang == "") {
$res[$category] = $el['content'];
} else {
$res[$category][$lang] = $el['content'];
}
}
return $res;
} // fn getMdataArray
/**
* Get metadata element value
*
* @param int $id
* virt.file's local id
* @param string $category
* metadata element name
* @param string $sessid
* session id
* @param string $lang
* xml:lang value for select language version
* @param string $deflang
* xml:lang for default language
* @return array of matching records as hash with fields:
*
* - mid int, local metadata record id
* - value string, element value
* - attrs hasharray of element's attributes indexed by
* qualified name (e.g. xml:lang)
*
*/
function getMdataValue($id, $category, $sessid='',
$lang=NULL, $deflang=NULL)
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsGetMetadataValue($id, $category, $lang, $deflang);
} // fn getMdataValue
/**
* Set metadata element value
*
* @param int $id
* Virtual file's local id
* @param string $category
* Metadata element identification (e.g. dc:title)
* @param string $sessid
* Session id
* @param string $value
* The value to store, if NULL then delete record
* @param string $lang
* xml:lang value for select language version
* @param int $mid
* (optional on unique elements) Metadata record id
* @return boolean
*/
function setMdataValue($id, $category, $sessid, $value, $lang=NULL, $mid=NULL)
{
if (($res = $this->_authorize('write', $id, $sessid)) !== TRUE) {
return $res;
}
return $this->bsSetMetadataValue($id, $category, $value, $lang, $mid);
} // fn setMdataValue
/**
* Search in local metadata database.
*
* @param array $criteria
* with following structure:
*
* - filetype - string, type of searched files,
* meaningful values: 'audioclip', 'webstream', 'playlist', 'all'
* - operator - string, type of conditions join
* (any condition matches / all conditions match),
* meaningful values: 'and', 'or', ''
* (may be empty or ommited only with less then 2 items in
* "conditions" field)
*
* - limit : int - limit for result arrays (0 means unlimited)
* - offset : int - starting point (0 means without offset)
* - orderby : string - metadata category for sorting (optional)
* or array of strings for multicolumn orderby
* [default: dc:creator, dc:source, dc:title]
*
* - desc : boolean - flag for descending order (optional)
* or array of boolean for multicolumn orderby
* (it corresponds to elements of orderby field)
* [default: all ascending]
*
* - conditions - array of hashes with structure:
*
* - cat - string, metadata category name
* - op - string, operator - meaningful values:
* 'full', 'partial', 'prefix', '=', '<',
* '<=', '>', '>='
* - val - string, search value
*
*
*
* @param string $sessid
* session id
* @return array of hashes, fields:
*
* - cnt : integer - number of matching gunids
* of files have been found
* - results : array of hashes:
*
* - gunid: string
* - type: string - audioclip | playlist | webstream
* - title: string - dc:title from metadata
* - creator: string - dc:creator from metadata
* - length: string - dcterms:extent in extent format
*
*
*
* @see BasicStor::bsLocalSearch
*/
function localSearch($criteria, $sessid='')
{
$limit = intval(isset($criteria['limit']) ? $criteria['limit'] : 0);
$offset = intval(isset($criteria['offset']) ? $criteria['offset'] : 0);
return $this->bsLocalSearch($criteria, $limit, $offset);
} // fn localSearch
/**
* Return values of specified metadata category
*
* @param string $category
* metadata category name
* with or without namespace prefix (dc:title, author)
* @param array $criteria
* see localSearch method
* @param string $sessid
* @return array, fields:
* results : array with found values
* cnt : integer - number of matching values
* @see BasicStor::bsBrowseCategory
*/
function browseCategory($category, $criteria, $sessid = '')
{
$limit = 0;
$offset = 0;
if (!is_null($criteria)) {
$limit = intval(isset($criteria['limit']) ? $criteria['limit'] : 0);
$offset = intval(isset($criteria['offset']) ? $criteria['offset'] : 0);
}
$res = $this->bsBrowseCategory($category, $limit, $offset, $criteria);
return $res;
} // fn browseCategory
/*====================================================== playlist methods */
/**
* Create a new empty playlist.
*
* @param int $parid
* parent id
* @param string $fname
* human readable menmonic file name
* @param string $sessid
* session ID
* @return int, local id of created playlist
*/
function createPlaylist($parid, $fname, $sessid='')
{
$gunid = StoredFile::_createGunid();
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
$gunid2 = $lc->createPlaylist($sessid, $gunid, $fname);
if (PEAR::isError($gunid2)) {
return $gunid2;
}
// get local id:
$id = $this->_idFromGunid($gunid2);
if (PEAR::isError($id)) {
return $id;
}
// get home dir id:
$hdid = $this->_getHomeDirIdFromSess($sessid);
if (PEAR::isError($hdid)) {
return $hdid;
}
// optionally move it to the destination folder:
if($parid != $hdid && !is_null($parid)){
$r = $this->bsMoveFile($id, $parid);
if (PEAR::isError($r)) {
return $r;
}
}
return $id;
} // fn createPlaylist
/**
* Return playlist as XML string
*
* @param int $id
* local object id
* @param string $sessid
* session ID
* @return string, XML
*/
function getPlaylistXml($id, $sessid)
{
return $this->getMdata($id, $sessid);
} // fn getPlaylistXml
/**
* Return playlist as hierarchical PHP hash-array
*
* @param int $id
* local object id
* @param string $sessid
* session ID
* @return array
*/
function getPlaylistArray($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
$pl = StoredFile::recall($this, $id);
if (PEAR::isError($pl)) {
return $pl;
}
$gunid = $pl->gunid;
return $pl->md->genPhpArray();
} // fn getPlaylistArray
/**
* Mark playlist as edited and return edit token
*
* @param int $id
* local object id
* @param string $sessid
* session ID
* @return string, playlist access token
*/
function lockPlaylistForEdit($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
$res = $lc->editPlaylist($sessid, $gunid);
if (PEAR::isError($res)) {
return $res;
}
return $res['token'];
} // fn lockPlaylistForEdit
/**
* Release token, regenerate XML from DB and clear edit flag.
*
* @param string $token
* playlist access token
* @param string $sessid
* session ID
* @return string gunid
*/
function releaseLockedPlaylist($token, $sessid)
{
$gunid = $this->bsCloseDownload($token, 'metadata');
if (PEAR::isError($gunid)) {
return $gunid;
}
$ac = StoredFile::recallByGunid($this, $gunid);
if (PEAR::isError($ac)) {
return $ac;
}
$r = $ac->md->regenerateXmlFile();
if (PEAR::isError($r)) {
return $r;
}
$this->_setEditFlag($gunid, FALSE, $sessid);
return $gunid;
} // fn releaseLockedPlaylist
/**
* Add audioclip specified by local id to the playlist
*
* @param string $token
* playlist access token
* @param string $acId
* local ID of added file
* @param string $sessid
* session ID
* @param string $fadeIn
* in time format hh:mm:ss.ssssss
* @param string $fadeOut
* in time format hh:mm:ss.ssssss
* @param string $length
* length in extent format -
* for webstream (or for overrule length of audioclip)
* @param string $pause
* pause between half-faded points in time format hh:mm:ss.ssssss
* @return string, generated playlistElement gunid
*/
function addAudioClipToPlaylist($token, $acId, $sessid,
$fadeIn=NULL, $fadeOut=NULL, $length=NULL, $pause=NULL)
{
require_once"Playlist.php";
$pl = Playlist::recallByToken($this, $token);
if (PEAR::isError($pl)) {
return $pl;
}
$acGunid = $this->_gunidFromId($acId);
if ($pl->_cyclicRecursion($acGunid)){
return PEAR::raiseError(
"GreenBox::addAudioClipToPlaylist: cyclic-recursion detected".
" ($type)"
);
}
// $res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL, $pause);
$res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL, $length);
if (PEAR::isError($res)) {
return $res;
}
// recalculate offsets and total length:
// $r = $pl->recalculateTimes($pause);
$r = $pl->recalculateTimes();
if (PEAR::isError($r)) {
return $r;
}
return $res;
} // fn addAudioClipToPlaylist
/**
* Remove audioclip from playlist
*
* @param string $token
* playlist access token
* @param string $plElGunid
* global id of deleted playlistElement
* @param string $sessid
* session ID
* @return boolean
*/
function delAudioClipFromPlaylist($token, $plElGunid, $sessid)
{
require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
if (PEAR::isError($pl)) {
return $pl;
}
$res = $pl->delAudioClip($plElGunid);
if (PEAR::isError($res)) {
return $res;
}
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
if (PEAR::isError($r)) {
return $r;
}
return $res;
} // fn delAudioClipFromPlaylist
/**
* Change fadeInfo values
*
* @param string $token
* playlist access token
* @param string $plElGunid
* global id of deleted playlistElement
* @param string $fadeIn
* in time format hh:mm:ss.ssssss
* @param string $fadeOut
* in time format hh:mm:ss.ssssss
* @param sessid $string
* session ID
* @return boolean
*/
function changeFadeInfo($token, $plElGunid, $fadeIn, $fadeOut, $sessid)
{
require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
if (PEAR::isError($pl)) {
return $pl;
}
$res = $pl->changeFadeInfo($plElGunid, $fadeIn, $fadeOut);
if (PEAR::isError($res)) {
return $res;
}
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
if (PEAR::isError($r)) {
return $r;
}
return TRUE;
} // fn changeFadeInfo
/**
* Move audioClip to the new position in the playlist.
*
* This method may change id attributes of playlistElements and/or
* fadeInfo.
*
* @param string $token
* playlist access token
* @param string $plElGunid
* global id of deleted playlistElement
* @param int $newPos
* new position in playlist
* @param string $sessid
* session ID
* @return boolean
*/
function moveAudioClipInPlaylist($token, $plElGunid, $newPos, $sessid)
{
require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
if (PEAR::isError($pl)) {
return $pl;
}
$res = $pl->moveAudioClip($plElGunid, $newPos);
if (PEAR::isError($res)) {
return $res;
}
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
if (PEAR::isError($r)) {
return $r;
}
return TRUE;
} // fn moveAudioClipInPlaylist
/**
* RollBack playlist changes to the locked state
*
* @param string $token
* playlist access token
* @param string $sessid
* session ID
* @return string gunid of playlist
*/
function revertEditedPlaylist($token, $sessid='')
{
require_once "LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
return $lc->revertEditedPlaylist($token, $sessid);
} // fn revertEditedPlaylist
/**
* Delete a Playlist metafile.
*
* @param int $id
* local id
* @param string $sessid
* session ID
* @return boolean
*/
function deletePlaylist($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
require_once "LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
return $lc->deletePlaylist($sessid, $gunid);
} // fn deletePlaylist
/**
* Find info about clip at specified offset in playlist.
*
* @param string $sessid
* session id
* @param string $plid
* playlist global unique id
* @param string $offset
* current playtime (hh:mm:ss.ssssss)
* @param int $distance
* 0=current clip; 1=next clip ...
* @param string $lang
* xml:lang value for select language version
* @param string $deflang
* xml:lang for default language
* @return array of matching clip info:
*
* - gunid string, global unique id of clip
* - elapsed string, already played time of clip
* - remaining string, remaining time of clip
* - duration string, total playlength of clip
*
*/
function displayPlaylistClipAtOffset($sessid, $plid, $offset, $distance=0,
$lang=NULL, $deflang=NULL)
{
require_once "Playlist.php";
$pl = Playlist::recallByGunid($this, $plid);
if (PEAR::isError($pl)) {
return $pl;
}
$res = $pl->displayPlaylistClipAtOffset($offset, $distance);
if (PEAR::isError($res)) {
return $res;
}
$res['title'] = NULL;
$id = $this->_idFromGunid($res['gunid']);
if (PEAR::isError($id)) {
return $id;
}
if (!is_null($id)) {
$md = $this->bsGetMetadataValue($id, "dc:title", $lang, $deflang);
if (PEAR::isError($md)) {
return $md;
}
if (isset($md[0]['value'])) {
$res['title'] = $md[0]['value'];
}
}
return $res;
} // fn displayPlaylistClipAtOffset
/**
* Create a tarfile with playlist export - playlist and all matching
* sub-playlists and media files (if desired)
*
* @param string $sessid
* string, session ID
* @param array $plids
* array of strings, playlist global unique IDs
* (one gunid is accepted too)
* @param string $type
* playlist format, values: lspl | smil | m3u
* @param boolean $standalone
* if only playlist should be exported or
* with all related files
* @return hasharray with fields:
* fname string: readable fname,
* token string: access token
*/
function exportPlaylistOpen($sessid, $plids, $type='lspl', $standalone=FALSE)
{
return $this->bsExportPlaylistOpen($plids, $type, $standalone);
} // fn exportPlaylistOpen
/**
* Close playlist export previously opened by the exportPlaylistOpen method
*
* @param string $token
* access token obtained from exportPlaylistOpen
* method call
* @return boolean true or error object
*/
function exportPlaylistClose($token)
{
return $this->bsExportPlaylistClose($token);
} // fn exportPlaylistClose
/**
* Open writable handle for import playlist in LS Archive format
*
* @param string $sessid
* session id
* @param string $chsum
* md5 checksum of imported file
* @return hasharray with:
* fname string: writable local filename
* token string: put token
*/
function importPlaylistOpen($sessid, $chsum='')
{
$userid = $r =$this->getSessUserId($sessid);
if ($this->dbc->isError($r)) {
return $r;
}
$r = $this->bsOpenPut($chsum, NULL, $userid);
if (PEAR::isError($r)) {
return $r;
}
return $r;
} // fn importPlaylistOpen
/**
* Close import-handle and import playlist
*
* @param string $token
* import token obtained by importPlaylistOpen method
* @return int, result file local id (or error object)
*/
function importPlaylistClose($token)
{
$arr = $r = $this->bsClosePut($token);
if (PEAR::isError($r)) {
return $r;
}
$fname = $arr['fname'];
$owner = $arr['owner'];
$parid = $r= $this->_getHomeDirId($owner);
if (PEAR::isError($r)) {
if (file_exists($fname)) {
@unlink($fname);
}
return $r;
}
$res = $r = $this->bsImportPlaylist($parid, $fname, $owner);
if (file_exists($fname)) {
@unlink($fname);
}
if (PEAR::isError($r)) {
return $r;
}
return $res;
} // fn importPlaylistClose
/**
* Check whether a Playlist metafile with the given playlist ID exists.
*
* @param int $id
* local id
* @param string $sessid
* session ID
* @return boolean
*/
function existsPlaylist($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
return $lc->existsPlaylist($sessid, $gunid);
} // fn existsPlaylist
/**
* Check whether a Playlist metafile with the given playlist ID
* is available for editing, i.e., exists and is not marked as
* beeing edited.
*
* @param int $id
* local id
* @param string $sessid
* session ID
* @return TRUE|int
* id of user editing it
*/
function playlistIsAvailable($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
return $lc->playlistIsAvailable($sessid, $gunid, TRUE);
} // fn playlistIsAvailable
/* ---------------------------------------------- time conversion methods */
/**
* Convert playlist time value to float seconds
*
* @param string $plt
* playlist time value (HH:mm:ss.dddddd)
* @return int, seconds
*/
function _plTimeToSecs($plt)
{
require_once"Playlist.php";
return Playlist::_plTimeToSecs($plt);
} // fn _plTimeToSecs
/**
* Convert float seconds value to playlist time format
*
* @param int $s0
* seconds
* @return string, time in playlist time format (HH:mm:ss.dddddd)
*/
function _secsToPlTime($s0)
{
require_once"Playlist.php";
return Playlist::_secsToPlTime($s0);
} // fn _secsToPlTime
/* ------------------------------------------------------- render methods */
/**
* Render playlist to ogg file (open handle)
*
* @param string $sessid
* session id
* @param string $plid
* playlist gunid
* @return string $token
* render token
*/
function renderPlaylistToFileOpen($sessid, $plid)
{
require_once "Renderer.php";
$r = Renderer::rnRender2FileOpen($this, $plid);
if (PEAR::isError($r)) {
return $r;
}
return $r;
} // fn renderPlaylistToFileOpen
/**
* Render playlist to ogg file (check results)
*
* @param string $token
* render token
* @return hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
*/
function renderPlaylistToFileCheck($token)
{
require_once "Renderer.php";
$r = Renderer::rnRender2FileCheck($this, $token);
if (PEAR::isError($r)) {
return $r;
}
return array('status'=>$r['status'], 'tmpfile'=>$r['tmpfile']);
} // fn renderPlaylistToFileCheck
/**
* Render playlist to ogg file (list results)
*
* @param string $status
* success | working | fault
* if this parameter is not set, then return with all unclosed
* @return array of hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
*/
function renderPlaylistToFileList($status='')
{
require_once "Renderer.php";
return Renderer::rnRender2FileList($this, $status);
} // fn renderPlaylistToFileList
/**
* Render playlist to ogg file (close handle)
*
* @param string $token
* render token
* @return boolean
* status
*/
function renderPlaylistToFileClose($token)
{
require_once "Renderer.php";
$r = Renderer::rnRender2FileClose($this, $token);
if (PEAR::isError($r)) {
return $r;
}
return array(TRUE);
} // fn renderPlaylistToFileClose
/**
* Render playlist to storage media clip (open handle)
*
* @param string $sessid
* session id
* @param string $plid
* playlist gunid
* @return string
* render token
*/
function renderPlaylistToStorageOpen($sessid, $plid)
{
require_once "Renderer.php";
$owner = $this->getSessUserId($sessid);
if ($this->dbc->isError($owner)) {
return $owner;
}
$r = Renderer::rnRender2FileOpen($this, $plid, $owner);
if (PEAR::isError($r)) {
return $r;
}
return $r;
} // fn renderPlaylistToStorageOpen
/**
* Render playlist to storage media clip (check results)
*
* @param string $token
* render token
* @return hasharray:
* status : string - susccess | working | fault
* gunid : string - gunid of result file
*/
function renderPlaylistToStorageCheck($token)
{
require_once "Renderer.php";
$r = Renderer::rnRender2StorageCheck($this, $token);
if (PEAR::isError($r)) {
return $r;
}
return $r;
} // fn renderPlaylistToStorageCheck
/**
* Render playlist to RSS file (open handle)
*
* @param string $sessid
* session id
* @param string $plid
* playlist gunid
* @return string
* render token
*/
function renderPlaylistToRSSOpen($sessid, $plid)
{
$token = '123456789abcdeff';
$fakeFile = "{$this->accessDir}/$token.rss";
file_put_contents($fakeFile, "fake rendered file");
return array('token'=>$token);
} // fn renderPlaylistToRSSOpen
/**
* Render playlist to RSS file (check results)
*
* @param string $token
* render token
* @return hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
*/
function renderPlaylistToRSSCheck($token)
{
$fakeFile = "{$this->accessDir}/$token.rss";
if ($token != '123456789abcdeff' || !file_exists($fakeFile)){
return PEAR::raiseError(
"LocStor::renderPlaylistToRSSCheck: invalid token ($token)"
);
}
return array(
'status'=> 'success',
'tmpfile' => $fakeFile,
);
} // fn renderPlaylistToRSSCheck
/**
* Render playlist to RSS file (list results)
*
* @param string $status
* success | working | fault
* @return array of hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
*/
function renderPlaylistToRSSList($status='')
{
$dummytokens = array ('123456789abcdeff');
foreach ($dummytokens as $token) {
$r[] = renderPlaylistToRSSCheck($token);
}
return $r;
} // fn renderPlaylistToRSSList
/**
* Render playlist to RSS file (close handle)
*
* @param string $token
* render token
* @return boolean
* status
*/
function renderPlaylistToRSSClose($token)
{
if ($token != '123456789abcdeff'){
return PEAR::raiseError(
"GreenBox::renderPlaylistToRSSClose: invalid token"
);
}
$fakeFile = "{$this->accessDir}/$token.rss";
unlink($fakeFile);
return TRUE;
} // fn renderPlaylistToRSSClose
/*================================================= storage admin methods */
/* ------------------------------------------------------- backup methods */
/**
* Create backup of storage (open handle)
*
* @param string $sessid
* session id
* @param struct $criteria
* see search criteria
* @return hasharray:
* token : string - backup token
*/
function createBackupOpen($sessid, $criteria='')
{
require_once "Backup.php";
$bu = $r = new Backup($this);
if (PEAR::isError($r)) {
return $r;
}
return $bu->openBackup($sessid,$criteria);
} // fn createBackupOpen
/**
* Create backup of storage (check results)
*
* @param string $token
* backup token
* @return hasharray with field:
* status : string - susccess | working | fault
* faultString: string - description of fault
* token : stirng - backup token
* url : string - access url
*/
function createBackupCheck($token)
{
require_once "Backup.php";
$bu = $r = new Backup($this);
if (PEAR::isError($r)) {
return $r;
}
return $bu->checkBackup($token);
} // fn createBackupCheck
/**
* Create backup of storage (list results)
*
* @param string $sessid
* session id
* @param string $stat
* if this parameter is not set, then return with all unclosed backups
* @return array of hasharray with field:
* status : string - susccess | working | fault
* token : stirng - backup token
* url : string - access url
*/
function createBackupList($sessid, $stat='')
{
require_once "Backup.php";
$bu = $r = new Backup($this);
if (PEAR::isError($r)) {
return $r;
}
return $bu->listBackups($stat);
} // fn createBackupList
/**
* Create backup of storage (close handle)
*
* @param string $token
* backup token
* @return boolean
* status
*/
function createBackupClose($token)
{
require_once "Backup.php";
$bu = $r = new Backup($this);
if (PEAR::isError($r)) {
return $r;
}
return $bu->closeBackup($token);
} // fn createBackupClose
/* ===================================================== restore funcitons*/
/**
* Restore a backup file
*
* @param string $sessid
* session id
* @param string $filename
* backup file path
* @return string
* restore token
*/
function backupRestoreOpen($sessid, $filename)
{
require_once 'Restore.php';
$rs = new Restore($this);
if (PEAR::isError($rs)) {
return $rs;
}
return $rs->openRestore($sessid,$filename);
} // fn backupRestoreOpen
/**
* Check status of backup restore
*
* @param string $token
* restore token
* @return hasharray
* fields:
* token: string - restore token
* status: string - working | fault | success
* faultString: string - description of fault
*/
function backupRestoreCheck($token)
{
require_once 'Restore.php';
$rs = new Restore($this);
if (PEAR::isError($rs)) {
return $rs;
}
return $rs->checkRestore($token);
} // fn backupRestoreCheck
/**
* Close a restore procedure
*
* @param string $token
* restore token
* @return boolean
* is success
*/
function backupRestoreClose($token) {
require_once 'Restore.php';
$rs = new Restore($this);
if (PEAR::isError($rs)) {
return $rs;
}
return $rs->closeRestore($token);
} // fn backupRestoreClose
/* ============================================== methods for preferences */
/**
* Read preference record by session id
*
* @param string $sessid
* session id
* @param string $key
* preference key
* @return string, preference value
*/
function loadPref($sessid, $key)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->loadPref($sessid, $key);
return $res;
} // fn loadPref
/**
* Save preference record by session id
*
* @param string $sessid
* session id
* @param string $key
* preference key
* @param string $value
* preference value
* @return boolean
*/
function savePref($sessid, $key, $value)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->savePref($sessid, $key, $value);
return $res;
} // fn savePref
/**
* Delete preference record by session id
*
* @param string $sessid
* session id
* @param string $key
* preference key
* @return boolean
*/
function delPref($sessid, $key)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->delPref($sessid, $key);
return $res;
} // fn delPref
/**
* Read group preference record
*
* @param string $sessid
* session id
* @param string $group
* group name
* @param string $key
* preference key
* @return string, preference value
*/
function loadGroupPref($sessid, $group, $key)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->loadGroupPref($sessid, $group, $key);
return $res;
} // fn loadGroupPref
/**
* Save group preference record
*
* @param string $sessid
* session id
* @param string $group
* group name
* @param string $key
* preference key
* @param string $value
* preference value
* @return boolean
*/
function saveGroupPref($sessid, $group, $key, $value)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->saveGroupPref($sessid, $group, $key, $value);
return $res;
} // fn saveGroupPref
/**
* Delete group preference record
*
* @param string $sessid
* session id
* @param string $group
* group name
* @param string $key
* preference key
* @return boolean
*/
function delGroupPref($sessid, $group, $key)
{
require_once 'Prefs.php';
$pr =& new Prefs($this);
$res = $pr->delGroupPref($sessid, $group, $key);
return $res;
} // fn delGroupPref
/* =================================================== networking methods */
/* ------------------------------------------------------- common methods */
/**
* Common "check" method for transports
*
* @param string $trtok
* transport token
* @return array with fields:
* trtype: string - audioclip | playlist | search | file
* state: string - transport state
* direction: string - up | down
* expectedsize: int - file size in bytes
* realsize: int - currently transported bytes
* expectedchsum: string - orginal file checksum
* realchsum: string - transported file checksum
* ... ?
*/
function getTransportInfo($trtok)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getTransportInfo($trtok);
} // fn getTransportInfo
/**
* Turn transports on/off, optionaly return current state.
*
* @param string $sessid
* session id
* @param boolean $onOff
* optional (if not used, current state is returned)
* @return boolean
* previous state
*/
function turnOnOffTransports($sessid, $onOff=NULL)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->turnOnOffTransports($sessid, $onOff);
} // fn turnOnOffTransports
/**
* Pause, resume or cancel transport
*
* @param string $trtok
* transport token
* @param string $action
* pause | resume | cancel
* @return string
* resulting transport state
*/
function doTransportAction($trtok, $action)
{
require_once"Transport.php";
$tr =& new Transport($this);
$res = $tr->doTransportAction($trtok, $action);
return $res;
} // fn doTransportAction
/* ------------------------ methods for ls-archive-format file transports */
/**
* Open async file transfer from local storageServer to network hub,
* file should be ls-archive-format file.
*
* @param string $filePath
* local path to uploaded file
* @return string
* transport token
*/
function uploadFile2Hub($filePath)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->uploadFile2Hub($filePath);
} // fn uploadFile2Hub
/**
* Get list of prepared transfers initiated by hub
*
* @return array of structs/hasharrays with fields:
* trtok: string transport token
* ... ?
*/
function getHubInitiatedTransfers()
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getHubInitiatedTransfers();
} // fn getHubInitiatedTransfers
/**
* Start of download initiated by hub
*
* @param string $trtok
* transport token obtained from
* the getHubInitiatedTransfers method
* @return string
* transport token
*/
function startHubInitiatedTransfer($trtok)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->startHubInitiatedTransfer($trtok);
} // fn startHubInitiatedTransfer
/* ------------- special methods for audioClip/webstream object transport */
/**
* Start upload of audioClip/webstream/playlist from local storageServer
* to hub
*
* @param string $gunid
* global unique id of object being transported
* @param boolean $withContent
* if true, transport playlist content too
* @return string
* transport token
*/
function upload2Hub($gunid, $withContent=FALSE)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->upload2Hub($gunid, $withContent);
} // fn upload2Hub
/**
* Start download of audioClip/webstream/playlist from hub to local
* storageServer
*
* @param string $sessid: session id
* @param string $gunid
* global unique id of playlist being transported
* @param boolean $withContent
* if true, transport playlist content too
* @return string
* transport token
*/
function downloadFromHub($sessid, $gunid, $withContent=TRUE){
$uid = $r = $this->getSessUserId($sessid);
if ($this->dbc->isError($r)) {
return $r;
}
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->downloadFromHub($uid, $gunid, $withContent);
} // fn downloadFromHub
/* ------------------------------------------------ global-search methods */
/**
* Start search job on network hub
*
* @param LS $criteria criteria format (see localSearch)
* @return string
* transport token
*/
function globalSearch($criteria)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->globalSearch($criteria);
} // fn globalSearch
/**
* Get results from search job on network hub
*
* @param string $trtok
* transport token
* @return LS search result format (see localSearch)
*/
function getSearchResults($trtok)
{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getSearchResults($trtok);
} // fn getSearchResults
/* ========================================================= info methods */
/**
* List files in folder
*
* @param int $id
* local id of folder
* @param string $sessid
* session id
* @return array
*/
function listFolder($id, $sessid='')
{
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
$listArr = $this->bsListFolder($id);
return $listArr;
} // fn listFolder
/**
* Get type of stored file (by local id)
*
* @param int $id
* local id
* @return string/err
*/
function getFileType($id)
{
// $id = $this->_idFromGunid($gunid);
$type = $this->getObjType($id);
return $type;
} // fn getFileType
/**
* Check if file gunid exists in the storage and
* user have permission to read it
*
* @param string $sessid
* session id
* @param string $gunid
* @param string $ftype
* internal file type
* @return string/err
*/
function existsFile($sessid, $gunid, $ftype=NULL)
{
$id = $this->_idFromGunid($gunid);
$ex = $this->bsExistsFile($id, $ftype);
if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
}
return $ex;
} // fn existsFile
/* ==================================================== redefined methods */
/**
* Get file's path in virtual filesystem
*
* @param int $id
* @return array
*/
function getPath($id)
{
$pa = parent::getPath($id, 'id, name, type');
array_shift($pa);
return $pa;
} // fn getPath
/**
* Get user id from session id
*
* This redefinition only simulate old (bad) behaviour - returns NULL
* for wrong sessid (code ALIBERR_NOTEXISTS).
* HtmlUI depends on it.
*
* @param string $sessid
* @return int/error
*/
function getSessUserId($sessid)
{
$r = parent::getSessUserId($sessid);
if (PEAR::isError($r)) {
if ($r->getCode() == ALIBERR_NOTEXISTS) {
return NULL;
} else {
return $r;
}
}
return $r;
} // fn getSessUserId
/**
* Change user password.
*
* ('superuser mode'= superuser is changing some password without
* knowledge of the old password)
*
* @param string $login
* @param string $oldpass
* old password
* (should be null or empty for 'superuser mode')
* @param string $pass
* @param string $sessid
* session id, required for 'superuser mode'
* @return boolean/err
*/
function passwd($login, $oldpass=null, $pass='', $sessid='')
{
if (is_null($oldpass) || ($oldpass == '') ) {
if (($res = $this->_authorize('subjects', $this->rootId, $sessid)) !== TRUE) {
sleep(2);
return $res;
} else {
$oldpass = null;
}
} else {
if (FALSE === $this->authenticate($login, $oldpass)) {
sleep(2);
return PEAR::raiseError(
"GreenBox::passwd: access denied (oldpass)", GBERR_DENY);
}
}
$res = parent::passwd($login, $oldpass, $pass);
if (PEAR::isError($res)) {
return $res;
}
return TRUE;
} // fn passwd
/**
* Insert permission record
*
* @param int $sid
* local user/group id
* @param string $action
* @param int $oid
* local object id
* @param char $type
* 'A'|'D' (allow/deny)
* @param string $sessid
* session id
* @return int
* local permission id
*/
function addPerm($sid, $action, $oid, $type='A', $sessid='')
{
$parid = $this->getParent($oid);
if (($res = $this->_authorize('editPerms', $parid, $sessid)) !== TRUE) {
return $res;
}
return parent::addPerm($sid, $action, $oid, $type);
} // fn addPerm
/**
* Remove permission record
*
* @param int $permid
* local permission id
* @param int $subj
* local user/group id
* @param int $obj
* local object id
* @param string $sessid
* session id
* @return boolean/error
*/
function removePerm($permid=NULL, $subj=NULL, $obj=NULL, $sessid='')
{
if (!is_null($permid)) {
$oid = $this->_getPermOid($permid);
if (PEAR::isError($oid)) {
return $oid;
}
if (!is_null($oid)) {
$parid = $this->getParent($oid);
if (($res = $this->_authorize('editPerms', $parid, $sessid)) !== TRUE) {
return $res;
}
}
}
$res = parent::removePerm($permid, $subj, $obj);
return $res;
} // fn removePerm
} // class GreenBox
?>