_authorize('write', $parid, $sessid)) !== TRUE) return $res; return $this->bsCreateFolder($parid, $folderName); } /** * Store new file in the storage * * @param parid int, parent id * @param fileName string, name for new file * @param mediaFileLP string, local path of media file * @param mdataFileLP string, local path of metadata file * @param sessid string, session id * @param gunid string, global unique id OPTIONAL * @param ftype string, 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 ); } /** * Store new webstream * * @param parid int, parent id * @param fileName string, name for new file * @param mdataFileLP string, local path of metadata file * @param sessid string, session id * @param gunid string, global unique id OPTIONAL * @param url string, wewbstream 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; } /** * Access stored file - increase access counter * * @param id int, virt.file's local id * @param sessid string, 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; } /** * Release stored file - decrease access counter * * @param token string, access token * @param sessid string, session id * @return boolean */ function releaseFile($token, $sessid='') { $r = $this->bsRelease($token, 'access'); if(PEAR::isError($r)){ return $r; } return FALSE; } /** * Analyze media file for internal metadata information * * @param id int, virt.file's local id * @param sessid string, session id * @return array */ function analyzeFile($id, $sessid='') { if(($res = $this->_authorize('read', $id, $sessid)) !== TRUE) return $res; return $this->bsAnalyzeFile($id); } /** * Rename file * * @param id int, virt.file's local id * @param newName string * @param sessid string, 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); } /** * Move file * * @param id int, virt.file's local id * @param did int, destination folder local id * @param sessid string, session id * @return boolean or PEAR::error */ function moveFile($id, $did, $sessid='') { if(($res = $this->_authorize( array('read', 'write'), array($id, $did), $sessid )) !== TRUE) return $res; return $this->bsMoveFile($id, $did); } /** * Copy file * * @param id int, virt.file's local id * @param did int, destination folder local id * @param sessid string, session id * @return boolean or PEAR::error */ function copyFile($id, $did, $sessid='') { if(($res = $this->_authorize( array('read', 'write'), array($id, $did), $sessid )) !== TRUE) return $res; return $this->bsCopyFile($id, $did); } /** * Delete file * * @param id int, virt.file's local id * @param sessid int * @return true or PEAR::error */ function deleteFile($id, $sessid='') { $parid = $this->getParent($id); if(($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) return $res; return $this->bsDeleteFile($id); } /* ------------------------------------------------------------- metadata */ /** * Replace metadata with new XML file or string * * @param id int, virt.file's local id * @param mdata string, XML string or local path of metadata XML file * @param mdataLoc string, metadata location: 'file'|'string' * @param sessid string, 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); } /** * Get metadata XML tree as string * * @param id int, virt.file's local id * @param sessid string, 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); } /** * 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 id int, local object id * @param sessid string, 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 $i=>$el){ $lang = $el['attrs']['xml:lang']; $category = $el['elementname']; if($lang == ""){ $res[$category] = $el['content']; }else{ $res[$category][$lang] = $el['content']; } } return $res; } /** * Get metadata element value * * @param id int, virt.file's local id * @param category string, metadata element name * @param sessid string, session id * @param lang string, optional xml:lang value for select language version * @param deflang string, optional 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); } /** * Set metadata element value * * @param id int, virt.file's local id * @param category string, metadata element identification (e.g. dc:title) * @param sessid string, session id * @param value string/NULL value to store, if NULL then delete record * @param lang string, optional xml:lang value for select language version * @param mid int, metadata record id (OPTIONAL on unique elements) * @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); } /** * Search in local metadata database. * * @param criteria hash, with following structure:
*

*
• filetype - string, type of searched files, * meaningful values: 'audioclip', 'playlist'
*
• 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)
*
• desc : boolean - flag for descending order (optional)
*
• conditions - array of hashes with structure: *
  *
  • cat - string, metadata category name
  *
  • op - string, operator - meaningful values: * 'full', 'partial', 'prefix', '=', '<', * '<=', '>', '>='
  *
  • val - string, search value
  *
  *
*

* @param sessid string, session id * @return hash, field 'results' is an array with gunid strings * of files have been found * @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); } /** * Return values of specified metadata category * * @param category string, metadata category name * with or without namespace prefix (dc:title, author) * @param criteria hash, see localSearch method * @param sessid string * @return hash, fields: * results : array with gunid strings * cnt : integer - number of matching values * @see BasicStor::bsBrowseCategory */ function browseCategory($category, $criteria, $sessid='') { $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; } /*====================================================== playlist methods */ /** * Create a new empty playlist. * * @param parid int, parent id * @param fname string, human readable menmonic file name * @param sessid string, 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->_getHomeDirId($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; } /** * Return playlist as XML string * * @param id int, local object id * @param sessid string, session ID * @return string, XML */ function getPlaylistXml($id, $sessid) { return $this->getMdata($id, $sessid); } /** * Return playlist as hierarchical PHP hash-array * * @param id int, local object id * @param sessid string, 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(); } /** * Mark playlist as edited and return edit token * * @param id int, local object id * @param sessid string, 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']; } /** * Release token, regenerate XML from DB and clear edit flag. * * @param token string, playlist access token * @param sessid string, 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; } /** * Add audioclip specified by local id to the playlist * * @param token string, playlist access token * @param acId string, local ID of added file * @param sessid string, session ID * @param fadeIn string, optional, in time format hh:mm:ss.ssssss * @param fadeOut string, dtto * @param pause string, optional - 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, $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)" ); } /* if('playlist' == ($type = $this->getFileType($acId))){ return PEAR::raiseError( "GreenBox::addAudioClipToPlaylist: object type not supported". " ($type)" ); } */ # $res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL, $pause); $res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL); 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; } /** * Remove audioclip from playlist * * @param token string, playlist access token * @param plElGunid string, global id of deleted playlistElement * @param sessid string, 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; } /** * Change fadeInfo values * * @param token string, playlist access token * @param plElGunid string, global id of deleted playlistElement * @param fadeIn string, optional, in time format hh:mm:ss.ssssss * @param fadeOut string, dtto * @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; } /** * Move audioClip to the new position in the playlist. * * This method may change id attributes of playlistElements and/or * fadeInfo. * * @param token string, playlist access token * @param plElGunid string, global id of deleted playlistElement * @param newPos int - new position in playlist * @param sessid string, 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; } /** * RollBack playlist changes to the locked state * * @param token string, playlist access token * @param sessid string, 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); } /** * Delete a Playlist metafile. * * @param id int, local id * @param sessid string, 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); } /** * Find info about clip at specified offset in playlist. * * @param sessid string, session id * @param plid string, playlist global unique id * @param offset string, current playtime (hh:mm:ss.ssssss) * @param distance int, 0=current clip; 1=next clip ... * @param lang string, optional xml:lang value for select language version * @param deflang string, optional 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; } /** * Check whether a Playlist metafile with the given playlist ID exists. * * @param id int, local id * @param sessid string, 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); } /** * 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 id int, local id * @param sessid string, 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); } /** * Convert playlist time value to float seconds * * @param plt string, playlist time value (HH:mm:ss.dddddd) * @return int, seconds */ function _plTimeToSecs($plt) { require_once"Playlist.php"; return Playlist::_plTimeToSecs($plt); } /** * Convert float seconds value to playlist time format * * @param s0 int, seconds * @return string, time in playlist time format (HH:mm:ss.dddddd) */ function _secsToPlTime($s0) { require_once"Playlist.php"; return Playlist::_secsToPlTime($s0); } /* ============================================== methods for preferences */ /** * Read preference record by session id * * @param sessid string, session id * @param key string, 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; } /** * Save preference record by session id * * @param sessid string, session id * @param key string, preference key * @param value string, 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; } /** * Delete preference record by session id * * @param sessid string, session id * @param key string, preference key * @return boolean */ function delPref($sessid, $key) { require_once 'Prefs.php'; $pr =& new Prefs($this); $res = $pr->delPref($sessid, $key); return $res; } /** * Read group preference record * * @param sessid string, session id * @param group string, group name * @param key string, 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; } /** * Save group preference record * * @param sessid string, session id * @param group string, group name * @param key string, preference key * @param value string, 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; } /** * Delete group preference record * * @param sessid string, session id * @param group string, group name * @param key string, 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; } /* --------------------------------------------------------- info methods */ /** * List files in folder * * @param id int, local id of folder * @param sessid string, session id * @return array */ function listFolder($id, $sessid='') { if(($res = $this->_authorize('read', $id, $sessid)) !== TRUE) return $res; $listArr = $this->bsListFolder($id); return $listArr; } /** * Get type of stored file (by local id) * * @param id int, local id * @return string/err */ function getFileType($id) { // $id = $this->_idFromGunid($gunid); $type = $this->getObjType($id); return $type; } /** * Check if file gunid exists in the storage and * user have permission to read it * * @param sessid string, session id * @param gunid string * @param ftype string, internal file type, optional * @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; } /* ---------------------------------------------------- redefined methods */ /** * Get file's path in virtual filesystem * * @param id int * @return array */ function getPath($id) { $pa = parent::getPath($id, 'id, name, type'); array_shift($pa); return $pa; } /** * Change user password. * * ('superuser mode'= superuser is changing some password without * knowledge of the old password) * * @param login string * @param oldpass string, old password * (should be null or empty for 'superuser mode') * @param pass string, optional * @param sessid string, 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); } } return PEAR::raiseError("GreenBox::passwd: OK"); $res = parent::passwd($login, $oldpass, $pass); if(PEAR::isError($res)) return $res; return TRUE; } /** * Insert permission record * * @param sid int - local user/group id * @param action string * @param oid int - local object id * @param type char - 'A'|'D' (allow/deny) * @param sessid string, 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); } /** * Remove permission record * * @param permid int OPT - local permission id * @param subj int OPT - local user/group id * @param obj int OPT - local object id * @param sessid string, 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; } } ?>