From d522ccead79191dda8c1ea8c42b09c53fa6193b9 Mon Sep 17 00:00:00 2001
From: paul <paul@cfc7b370-4200-0410-a6e3-cb6bdb053afe>
Date: Fri, 1 Sep 2006 09:21:34 +0000
Subject: [PATCH] Fixed warnings about undefined values, prettied up the code
to Campware coding conventions.
---
.../modules/storageServer/var/GreenBox.php | 1058 ++++++++++-------
1 file changed, 632 insertions(+), 426 deletions(-)
diff --git a/livesupport/src/modules/storageServer/var/GreenBox.php b/livesupport/src/modules/storageServer/var/GreenBox.php
index 8bb3323bf..6e248c4b2 100644
--- a/livesupport/src/modules/storageServer/var/GreenBox.php
+++ b/livesupport/src/modules/storageServer/var/GreenBox.php
@@ -38,36 +38,38 @@ require_once "BasicStor.php";
* @version $Revision$
* @see BasicStor
*/
-class GreenBox extends BasicStor{
+class GreenBox extends BasicStor {
/* ====================================================== storage methods */
/**
* Create new folder
*
- * @param parid int, parent id
- * @param folderName string, name for new folder
- * @param sessid string, session id
+ * @param int $parid, parent id
+ * @param string $folderName, name for new folder
+ * @param string $sessid, session id
* @return id of new folder
* @exception PEAR::error
*/
function createFolder($parid, $folderName, $sessid='')
{
- if(($res = $this->_authorize('write', $parid, $sessid)) !== TRUE)
+ if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsCreateFolder($parid, $folderName);
- }
+ } // fn createFolder
+
/**
* 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
+ * @param int $parid, parent id
+ * @param string $fileName, name for new file
+ * @param string $mediaFileLP, local path of media file
+ * @param string $mdataFileLP, local path of metadata file
+ * @param string $sessid, session id
+ * @param string $gunid, global unique id OPTIONAL
+ * @param string $ftype, internal file type
* @return int
* @exception PEAR::error
*/
@@ -75,201 +77,231 @@ class GreenBox extends BasicStor{
$mediaFileLP, $mdataFileLP, $sessid='',
$gunid=NULL, $ftype='audioclip')
{
- if(($res = $this->_authorize('write', $parid, $sessid)) !== TRUE)
+ 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 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
+ * @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 OPTIONAL
+ * @param string $url, wewbstream url
* @return int
* @exception PEAR::error
*/
function storeWebstream($parid, $fileName, $mdataFileLP, $sessid='',
$gunid=NULL, $url)
{
- if(($res = $this->_authorize('write', $parid, $sessid)) !== TRUE)
+ if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
- if(!file_exists($mdataFileLP)){
+ }
+ if (!file_exists($mdataFileLP)) {
$mdataFileLP = dirname(__FILE__).'/emptyWebstream.xml';
}
$oid = $this->bsPutFile(
$parid, $fileName, '', $mdataFileLP, $gunid, 'webstream'
);
- if(PEAR::isError($oid)) return $oid;
+ if (PEAR::isError($oid)) {
+ return $oid;
+ }
$r = $this-> bsSetMetadataValue(
$oid, 'ls:url', $url, NULL, NULL, 'metadata');
- if(PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $oid;
- }
+ } // fn storeWebstream
/**
* Access stored file - increase access counter
*
- * @param id int, virt.file's local id
- * @param sessid string, session id
+ * @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)
+ 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; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
$token = $r['token'];
return $token;
- }
+ } // fn accessFile
+
/**
* Release stored file - decrease access counter
*
- * @param token string, access token
- * @param sessid string, session id
+ * @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; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return FALSE;
- }
+ } // fn releaseFile
+
/**
* Analyze media file for internal metadata information
*
- * @param id int, virt.file's local id
- * @param sessid string, session id
+ * @param int $id, virt.file's local id
+ * @param string $sessid, session id
* @return array
*/
function analyzeFile($id, $sessid='')
{
- if(($res = $this->_authorize('read', $id, $sessid)) !== TRUE)
+ if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsAnalyzeFile($id);
- }
+ } // fn analyzeFile
+
/**
* Rename file
*
- * @param id int, virt.file's local id
- * @param newName string
- * @param sessid string, session id
+ * @param int $id, virt.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)
+ if (($res = $this->_authorize('write', $parid, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsRenameFile($id, $newName);
- }
+ } // fn renameFile
+
/**
* Move file
*
- * @param id int, virt.file's local id
- * @param did int, destination folder local id
- * @param sessid string, session id
+ * @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='')
{
- if(($res = $this->_authorize(
- array('read', 'write'), array($id, $did), $sessid
- )) !== TRUE) return $res;
+ $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 id int, virt.file's local id
- * @param did int, destination folder local id
- * @param sessid string, session id
+ * @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='')
{
- if(($res = $this->_authorize(
- array('read', 'write'), array($id, $did), $sessid
- )) !== TRUE) return $res;
+ $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 id int, virt.file's local id
- * @param mediaFileLP string, local path of media file
- * @param mdataFileLP string, local path of metadata file
- * @param sessid string, session id
+ * @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)
+ if (($res = $this->_authorize('write', $id, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsReplaceFile($id, $mediaFileLP, $mdataFileLP);
- }
+ } // fn replaceFile
+
/**
* Delete file
*
- * @param id int, virt.file's local id
- * @param sessid int
- * @param forced boolean, if true don't use trash
+ * @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)
+ 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 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
+ * @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)
+ 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 id int, virt.file's local id
- * @param sessid string, session id
+ * @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)
+ if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsGetMetadata($id);
- }
+ } // fn getMdata
+
/**
* Return metadata as hierarchical PHP hash-array
@@ -278,50 +310,54 @@ class GreenBox extends BasicStor{
* 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
+ * @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)
+ if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
+ }
$ac = StoredFile::recall($this, $id);
- if(PEAR::isError($ac)){ return $ac; }
+ if (PEAR::isError($ac)) {
+ return $ac;
+ }
$arr = $ac->md->genPhpArray();
$md = FALSE;
- foreach($arr['children'] as $i=>$a){
- if($a['elementname'] == 'metadata'){
+ foreach ($arr['children'] as $i=>$a) {
+ if ($a['elementname'] == 'metadata'){
$md = $arr['children'][$i];
break;
}
}
- if($md === FALSE){
+ 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'];
+ foreach ($md['children'] as $el) {
+ $lang = isset($el['attrs']['xml:lang']) ? $el['attrs']['xml:lang'] : "";
$category = $el['elementname'];
- if($lang == ""){
+ if ($lang == "") {
$res[$category] = $el['content'];
- }else{
+ } else {
$res[$category][$lang] = $el['content'];
}
}
return $res;
- }
+ } // fn getMdataArray
+
/**
* 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
+ * @param int $id, virt.file's local id
+ * @param string $category, metadata element name
+ * @param string $sessid, session id
+ * @param string $lang, optional xml:lang value for select language version
+ * @param string $deflang, optional xml:lang for default language
* @return array of matching records as hash with fields:
* <ul>
* <li>mid int, local metadata record id</li>
@@ -333,33 +369,37 @@ class GreenBox extends BasicStor{
function getMdataValue($id, $category, $sessid='',
$lang=NULL, $deflang=NULL)
{
- if(($res = $this->_authorize('read', $id, $sessid)) !== TRUE)
+ if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
+ }
return $this->bsGetMetadataValue($id, $category, $lang, $deflang);
- }
+ } // fn getMdataValue
+
/**
* 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)
+ * @param int $id, virt.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, optional xml:lang value for select language version
+ * @param int $mid, 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)
+ 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 criteria hash, with following structure:<br>
+ * @param array $criteria, with following structure:<br>
* <ul>
* <li>filetype - string, type of searched files,
* meaningful values: 'audioclip', 'webstream', 'playlist', 'all'</li>
@@ -386,10 +426,10 @@ class GreenBox extends BasicStor{
* </ul>
* </li>
* </ul>
- * @param sessid string, session id
+ * @param string $sessid, session id
* @return array of hashes, fields:
* <ul>
- * <li>cnt : integer - number of matching gunids
+ * <li>cnt : integer - number of matching gunids
* of files have been found</li>
* <li>results : array of hashes:
* <ul>
@@ -408,35 +448,41 @@ class GreenBox extends BasicStor{
$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 category string, metadata category name
+ * @param string $category, metadata category name
* with or without namespace prefix (dc:title, author)
- * @param criteria hash, see localSearch method
- * @param sessid string
- * @return hash, fields:
+ * @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='')
+ function browseCategory($category, $criteria, $sessid = '')
{
- $limit = intval(isset($criteria['limit']) ? $criteria['limit'] : 0);
- $offset = intval(isset($criteria['offset']) ? $criteria['offset'] : 0);
+ $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 parid int, parent id
- * @param fname string, human readable menmonic file name
- * @param sessid string, session ID
+ * @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='')
@@ -445,54 +491,67 @@ class GreenBox extends BasicStor{
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
$gunid2 = $lc->createPlaylist($sessid, $gunid, $fname);
- if(PEAR::isError($gunid2)) return $gunid2;
+ if (PEAR::isError($gunid2)) {
+ return $gunid2;
+ }
// get local id:
$id = $this->_idFromGunid($gunid2);
- if(PEAR::isError($id)) return $id;
+ if (PEAR::isError($id)) {
+ return $id;
+ }
// get home dir id:
$hdid = $this->_getHomeDirIdFromSess($sessid);
- if(PEAR::isError($hdid)) return $hdid;
+ 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; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
}
return $id;
- }
+ } // fn createPlaylist
+
/**
* Return playlist as XML string
*
- * @param id int, local object id
- * @param sessid string, session ID
+ * @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 id int, local object id
- * @param sessid string, session ID
+ * @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; }
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$gunid = $pl->gunid;
return $pl->md->genPhpArray();
- }
+ } // fn getPlaylistArray
+
/**
* Mark playlist as edited and return edit token
*
- * @param id int, local object id
- * @param sessid string, session ID
+ * @param int $id, local object id
+ * @param string $sessid, session ID
* @return string, playlist access token
*/
function lockPlaylistForEdit($id, $sessid)
@@ -501,40 +560,50 @@ class GreenBox extends BasicStor{
require_once"LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
$res = $lc->editPlaylist($sessid, $gunid);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
return $res['token'];
- }
+ } // fn lockPlaylistForEdit
+
/**
* Release token, regenerate XML from DB and clear edit flag.
*
- * @param token string, playlist access token
- * @param sessid string, session ID
+ * @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;
+ if (PEAR::isError($gunid)) {
+ return $gunid;
+ }
$ac = StoredFile::recallByGunid($this, $gunid);
- if(PEAR::isError($ac)){ return $ac; }
+ if (PEAR::isError($ac)) {
+ return $ac;
+ }
$r = $ac->md->regenerateXmlFile();
- if(PEAR::isError($r)) return $r;
+ 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 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 length string - optional length in extent format -
+ * @param string $token, playlist access token
+ * @param string $acId, local ID of added file
+ * @param string $sessid, session ID
+ * @param string $fadeIn, optional, in time format hh:mm:ss.ssssss
+ * @param string $fadeOut, optional, in time format hh:mm:ss.ssssss
+ * @param string $length - optional length in extent format -
* for webstream (or for overrule length of audioclip)
- * @param pause string, optional - pause between half-faded points
+ * @param string $pause, optional - pause between half-faded points
* in time format hh:mm:ss.ssssss
* @return string, generated playlistElement gunid
*/
@@ -543,9 +612,11 @@ class GreenBox extends BasicStor{
{
require_once"Playlist.php";
$pl = Playlist::recallByToken($this, $token);
- if(PEAR::isError($pl)) return $pl;
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$acGunid = $this->_gunidFromId($acId);
- if($pl->_cyclicRecursion($acGunid)){
+ if ($pl->_cyclicRecursion($acGunid)){
return PEAR::raiseError(
"GreenBox::addAudioClipToPlaylist: cyclic-recursion detected".
" ($type)"
@@ -553,57 +624,76 @@ class GreenBox extends BasicStor{
}
// $res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL, $pause);
$res = $pl->addAudioClip($acId, $fadeIn, $fadeOut, NULL, $length);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
// recalculate offsets and total length:
// $r = $pl->recalculateTimes($pause);
$r = $pl->recalculateTimes();
- if(PEAR::isError($r)){ return $r; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $res;
- }
+ } // fn addAudioClipToPlaylist
+
/**
* Remove audioclip from playlist
*
- * @param token string, playlist access token
- * @param plElGunid string, global id of deleted playlistElement
- * @param sessid string, session ID
+ * @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";
+ require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
- if(PEAR::isError($pl)) return $pl;
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$res = $pl->delAudioClip($plElGunid);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
- if(PEAR::isError($r)){ return $r; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $res;
- }
+ } // fn delAudioClipFromPlaylist
+
/**
* 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
+ * @param string $token, playlist access token
+ * @param string $plElGunid, global id of deleted playlistElement
+ * @param string $fadeIn, optional, in time format hh:mm:ss.ssssss
+ * @param string $fadeOut, optional, 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";
+ require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
- if(PEAR::isError($pl)) return $pl;
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$res = $pl->changeFadeInfo($plElGunid, $fadeIn, $fadeOut);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
- if(PEAR::isError($r)){ return $r; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return TRUE;
- }
+ } // fn changeFadeInfo
+
/**
* Move audioClip to the new position in the playlist.
@@ -611,63 +701,72 @@ class GreenBox extends BasicStor{
* 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
+ * @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";
+ require_once "Playlist.php";
$pl = Playlist::recallByToken($this, $token);
- if(PEAR::isError($pl)) return $pl;
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$res = $pl->moveAudioClip($plElGunid, $newPos);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
// recalculate offsets and total length:
$r = $pl->recalculateTimes();
- if(PEAR::isError($r)){ return $r; }
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return TRUE;
- }
+ } // fn moveAudioClipInPlaylist
+
/**
* RollBack playlist changes to the locked state
*
- * @param token string, playlist access token
- * @param sessid string, session ID
+ * @param string $token, playlist access token
+ * @param string $sessid, session ID
* @return string gunid of playlist
*/
function revertEditedPlaylist($token, $sessid='')
{
- require_once"LocStor.php";
+ require_once "LocStor.php";
$lc =& new LocStor($this->dbc, $this->config);
return $lc->revertEditedPlaylist($token, $sessid);
- }
+ } // fn revertEditedPlaylist
+
/**
* Delete a Playlist metafile.
*
- * @param id int, local id
- * @param sessid string, session ID
+ * @param int $id, local id
+ * @param string $sessid, session ID
* @return boolean
*/
function deletePlaylist($id, $sessid)
{
$gunid = $this->_gunidFromId($id);
- require_once"LocStor.php";
+ 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 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
+ * @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, optional xml:lang value for select language version
+ * @param string $deflang, optional xml:lang for default language
* @return array of matching clip info:
* <ul>
* <li>gunid string, global unique id of clip</li>
@@ -679,31 +778,42 @@ class GreenBox extends BasicStor{
function displayPlaylistClipAtOffset($sessid, $plid, $offset, $distance=0,
$lang=NULL, $deflang=NULL)
{
- require_once"Playlist.php";
+ require_once "Playlist.php";
$pl = Playlist::recallByGunid($this, $plid);
- if(PEAR::isError($pl)) return $pl;
+ if (PEAR::isError($pl)) {
+ return $pl;
+ }
$res = $pl->displayPlaylistClipAtOffset($offset, $distance);
- if(PEAR::isError($res)) return $res;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
$res['title'] = NULL;
$id = $this->_idFromGunid($res['gunid']);
- if(PEAR::isError($id)) return $id;
- if(!is_null($id)){
+ 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']; }
+ 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 sessid - string, session ID
- * @param plids - array of strings, playlist global unique IDs
+ * @param string $sessid - string, session ID
+ * @param array $plids - array of strings, playlist global unique IDs
* (one gunid is accepted too)
- * @param type - string, playlist format, values: lspl | smil | m3u
- * @param standalone - boolean, if only playlist should be exported or
+ * @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,
@@ -712,25 +822,27 @@ class GreenBox extends BasicStor{
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 token - string, access token obtained from exportPlaylistOpen
+ * @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 sessid string, session id
- * @param chsum string, md5 checksum of imported file (optional)
+ * @param string $sessid, session id
+ * @param string $chsum, md5 checksum of imported file (optional)
* @return hasharray with:
* fname string: writable local filename
* token string: put token
@@ -738,40 +850,54 @@ class GreenBox extends BasicStor{
function importPlaylistOpen($sessid, $chsum='')
{
$userid = $r =$this->getSessUserId($sessid);
- if($this->dbc->isError($r)) return $r;
+ if ($this->dbc->isError($r)) {
+ return $r;
+ }
$r = $this->bsOpenPut($chsum, NULL, $userid);
- if(PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $r;
- }
-
+ } // fn importPlaylistOpen
+
+
/**
* Close import-handle and import playlist
*
- * @param token string, import token obtained by importPlaylistOpen method
+ * @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;
+ 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);
+ 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;
+ 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 id int, local id
- * @param sessid string, session ID
+ * @param int $id, local id
+ * @param string $sessid, session ID
* @return boolean
*/
function existsPlaylist($id, $sessid)
@@ -780,16 +906,17 @@ class GreenBox extends BasicStor{
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 id int, local id
- * @param sessid string, session ID
- * @return TRUE | int - id of user editing it
+ * @param int $id, local id
+ * @param string $sessid, session ID
+ * @return TRUE|int - id of user editing it
*/
function playlistIsAvailable($id, $sessid)
{
@@ -797,53 +924,59 @@ class GreenBox extends BasicStor{
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 plt string, playlist time value (HH:mm:ss.dddddd)
+ * @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 s0 int, seconds
+ * @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 sessid : string - session id
- * @param plid : string - playlist gunid
- * @return token : string - render token
+ * @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;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $r;
- }
+ } // fn renderPlaylistToFileOpen
+
/**
* Render playlist to ogg file (check results)
*
- * @param token : string - render token
+ * @param string $token - render token
* @return hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
@@ -852,14 +985,17 @@ class GreenBox extends BasicStor{
{
require_once "Renderer.php";
$r = Renderer::rnRender2FileCheck($this, $token);
- if(PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return array('status'=>$r['status'], 'tmpfile'=>$r['tmpfile']);
- }
+ } // fn renderPlaylistToFileCheck
+
/**
* Render playlist to ogg file (list results)
*
- * @param status : string - success | working | fault
+ * @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
@@ -869,44 +1005,52 @@ class GreenBox extends BasicStor{
{
require_once "Renderer.php";
return Renderer::rnRender2FileList($this, $status);
- }
+ } // fn renderPlaylistToFileList
+
/**
* Render playlist to ogg file (close handle)
*
- * @param token : string - render token
- * @return status : boolean
+ * @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;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return array(TRUE);
- }
+ } // fn renderPlaylistToFileClose
/**
* Render playlist to storage media clip (open handle)
*
- * @param sessid : string - session id
- * @param plid : string - playlist gunid
- * @return token : string - render token
+ * @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;
+ if ($this->dbc->isError($owner)) {
+ return $owner;
+ }
$r = Renderer::rnRender2FileOpen($this, $plid, $owner);
- if(PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $r;
- }
+ } // fn renderPlaylistToStorageOpen
+
/**
* Render playlist to storage media clip (check results)
*
- * @param token : string - render token
+ * @param string $token - render token
* @return hasharray:
* status : string - susccess | working | fault
* gunid : string - gunid of result file
@@ -915,17 +1059,19 @@ class GreenBox extends BasicStor{
{
require_once "Renderer.php";
$r = Renderer::rnRender2StorageCheck($this, $token);
- if(PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $r;
- }
+ } // fn renderPlaylistToStorageCheck
/**
* Render playlist to RSS file (open handle)
*
- * @param sessid : string - session id
- * @param plid : string - playlist gunid
- * @return token : string - render token
+ * @param string $sessid - session id
+ * @param string $plid - playlist gunid
+ * @return string - render token
*/
function renderPlaylistToRSSOpen($sessid, $plid)
{
@@ -933,12 +1079,13 @@ class GreenBox extends BasicStor{
$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 token : string - render token
+ * @param string $token - render token
* @return hasharray:
* status : string - susccess | working | fault
* tmpfile : string - filepath to result temporary file
@@ -946,7 +1093,7 @@ class GreenBox extends BasicStor{
function renderPlaylistToRSSCheck($token)
{
$fakeFile = "{$this->accessDir}/$token.rss";
- if($token != '123456789abcdeff' || !file_exists($fakeFile)){
+ if ($token != '123456789abcdeff' || !file_exists($fakeFile)){
return PEAR::raiseError(
"LocStor::renderPlaylistToRSSCheck: invalid token ($token)"
);
@@ -955,34 +1102,36 @@ class GreenBox extends BasicStor{
'status'=> 'success',
'tmpfile' => $fakeFile,
);
- }
+ } // fn renderPlaylistToRSSCheck
+
/**
* Render playlist to RSS file (list results)
*
- * @param status : string - success | working | fault
+ * @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;
- }
+ $dummytokens = array ('123456789abcdeff');
+ foreach ($dummytokens as $token) {
+ $r[] = renderPlaylistToRSSCheck($token);
+ }
+ return $r;
+ } // fn renderPlaylistToRSSList
+
/**
* Render playlist to RSS file (close handle)
*
- * @param token : string - render token
- * @return status : boolean
+ * @param string $token - render token
+ * @return boolean - status
*/
function renderPlaylistToRSSClose($token)
{
- if($token != '123456789abcdeff'){
+ if ($token != '123456789abcdeff'){
return PEAR::raiseError(
"GreenBox::renderPlaylistToRSSClose: invalid token"
);
@@ -990,7 +1139,7 @@ class GreenBox extends BasicStor{
$fakeFile = "{$this->accessDir}/$token.rss";
unlink($fakeFile);
return TRUE;
- }
+ } // fn renderPlaylistToRSSClose
/*================================================= storage admin methods */
@@ -998,8 +1147,8 @@ class GreenBox extends BasicStor{
/**
* Create backup of storage (open handle)
*
- * @param sessid : string - session id
- * @param criteria : struct - see search criteria
+ * @param string $sessid - session id
+ * @param struct $criteria - see search criteria
* @return hasharray:
* token : string - backup token
*/
@@ -1007,15 +1156,18 @@ class GreenBox extends BasicStor{
{
require_once "Backup.php";
$bu = $r = new Backup($this);
- if (PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $bu->openBackup($sessid,$criteria);
- }
+ } // fn createBackupOpen
+
/**
* Create backup of storage (check results)
*
- * @param token : string - backup token
- * @return hasharray with field:
+ * @param string $token - backup token
+ * @return hasharray with field:
* status : string - susccess | working | fault
* faultString: string - description of fault
* token : stirng - backup token
@@ -1025,17 +1177,20 @@ class GreenBox extends BasicStor{
{
require_once "Backup.php";
$bu = $r = new Backup($this);
- if (PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $bu->checkBackup($token);
- }
+ } // fn createBackupCheck
+
/**
* Create backup of storage (list results)
*
- * @param sessid : string - session id
- * @param stat : status (optional)
+ * @param string $sessid - session id
+ * @param string $stat (optional)
* if this parameter is not set, then return with all unclosed backups
- * @return array of hasharray with field:
+ * @return array of hasharray with field:
* status : string - susccess | working | fault
* token : stirng - backup token
* url : string - access url
@@ -1044,76 +1199,91 @@ class GreenBox extends BasicStor{
{
require_once "Backup.php";
$bu = $r = new Backup($this);
- if (PEAR::isError($r)) return $r;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $bu->listBackups($stat);
- }
+ } // fn createBackupList
+
/**
* Create backup of storage (close handle)
*
- * @param token : string - backup token
- * @return status : boolean
+ * @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;
+ if (PEAR::isError($r)) {
+ return $r;
+ }
return $bu->closeBackup($token);
- }
-
+ } // fn createBackupClose
+
+
/* ===================================================== restore funcitons*/
/**
* Restore a backup file
*
- * @param sessid : string - session id
- * @param filename : string - backup file path
- * @return token : string - restore token
+ * @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;
+ if (PEAR::isError($rs)) {
+ return $rs;
+ }
return $rs->openRestore($sessid,$filename);
- }
+ } // fn backupRestoreOpen
+
/**
* Check status of backup restore
*
- * @param token : string - restore token
- * @return status : hasharray - fields:
- * token: string - restore token
- * status: string - working | fault | success
- * faultString: string - description of fault
+ * @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;
+ if (PEAR::isError($rs)) {
+ return $rs;
+ }
return $rs->checkRestore($token);
- }
-
+ } // fn backupRestoreCheck
+
+
/**
* Close a restore procedure
*
- * @param token : string - restore token
- * @return status : bool - is success
+ * @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;
+ if (PEAR::isError($rs)) {
+ return $rs;
+ }
return $rs->closeRestore($token);
- }
+ } // fn backupRestoreClose
+
/* ============================================== methods for preferences */
/**
* Read preference record by session id
*
- * @param sessid string, session id
- * @param key string, preference key
+ * @param string $sessid, session id
+ * @param string $key, preference key
* @return string, preference value
*/
function loadPref($sessid, $key)
@@ -1122,14 +1292,15 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->loadPref($sessid, $key);
return $res;
- }
+ } // fn loadPref
+
/**
* Save preference record by session id
*
- * @param sessid string, session id
- * @param key string, preference key
- * @param value string, preference value
+ * @param string $sessid, session id
+ * @param string $key, preference key
+ * @param string $value, preference value
* @return boolean
*/
function savePref($sessid, $key, $value)
@@ -1138,13 +1309,14 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->savePref($sessid, $key, $value);
return $res;
- }
+ } // fn savePref
+
/**
* Delete preference record by session id
*
- * @param sessid string, session id
- * @param key string, preference key
+ * @param string $sessid, session id
+ * @param string $key, preference key
* @return boolean
*/
function delPref($sessid, $key)
@@ -1153,14 +1325,15 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->delPref($sessid, $key);
return $res;
- }
+ } // fn delPref
+
/**
* Read group preference record
*
- * @param sessid string, session id
- * @param group string, group name
- * @param key string, preference key
+ * @param string $sessid, session id
+ * @param string $group, group name
+ * @param string $key, preference key
* @return string, preference value
*/
function loadGroupPref($sessid, $group, $key)
@@ -1169,15 +1342,16 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->loadGroupPref($sessid, $group, $key);
return $res;
- }
+ } // fn loadGroupPref
+
/**
* Save group preference record
*
- * @param sessid string, session id
- * @param group string, group name
- * @param key string, preference key
- * @param value string, preference value
+ * @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)
@@ -1186,14 +1360,15 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->saveGroupPref($sessid, $group, $key, $value);
return $res;
- }
+ } // fn saveGroupPref
+
/**
* Delete group preference record
*
- * @param sessid string, session id
- * @param group string, group name
- * @param key string, preference key
+ * @param string $sessid, session id
+ * @param string $group, group name
+ * @param string $key, preference key
* @return boolean
*/
function delGroupPref($sessid, $group, $key)
@@ -1202,15 +1377,16 @@ class GreenBox extends BasicStor{
$pr =& new Prefs($this);
$res = $pr->delGroupPref($sessid, $group, $key);
return $res;
- }
+ } // fn delGroupPref
+
/* =================================================== networking methods */
/* ------------------------------------------------------- common methods */
/**
* Common "check" method for transports
*
- * @param trtok: string - transport token
- * @return struct/hasharray with fields:
+ * @param string $trtok - transport token
+ * @return array with fields:
* trtype: string - audioclip | playlist | search | file
* state: string - transport state
* direction: string - up | down
@@ -1225,13 +1401,14 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getTransportInfo($trtok);
- }
-
+ } // fn getTransportInfo
+
+
/**
* Turn transports on/off, optionaly return current state.
*
- * @param sessid string: session id
- * @param onOff: boolean optional (if not used, current state is returned)
+ * @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)
@@ -1239,13 +1416,14 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->turnOnOffTransports($sessid, $onOff);
- }
-
+ } // fn turnOnOffTransports
+
+
/**
* Pause, resume or cancel transport
*
- * @param trtok: string - transport token
- * @param action: string - pause | resume | cancel
+ * @param string $trtok - transport token
+ * @param string $action - pause | resume | cancel
* @return string - resulting transport state
*/
function doTransportAction($trtok, $action)
@@ -1254,14 +1432,15 @@ class GreenBox extends BasicStor{
$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 filePath string - local path to uploaded file
+ * @param string $filePath - local path to uploaded file
* @return string - transport token
*/
function uploadFile2Hub($filePath)
@@ -1269,8 +1448,9 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->uploadFile2Hub($filePath);
- }
-
+ } // fn uploadFile2Hub
+
+
/**
* Get list of prepared transfers initiated by hub
*
@@ -1283,12 +1463,13 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getHubInitiatedTransfers();
- }
-
+ } // fn getHubInitiatedTransfers
+
+
/**
* Start of download initiated by hub
*
- * @param trtok: string - transport token obtained from
+ * @param string $trtok - transport token obtained from
* the getHubInitiatedTransfers method
* @return string - transport token
*/
@@ -1297,16 +1478,17 @@ class GreenBox extends BasicStor{
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 gunid: string - global unique id of object being transported
- * @param withContent: boolean - if true, transport playlist content too
+ * @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)
@@ -1314,31 +1496,34 @@ class GreenBox extends BasicStor{
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 sessid string: session id
- * @param gunid: string - global unique id of playlist being transported
- * @param withContent: boolean - if true, transport playlist content too
+ * @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;
+ 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 criteria: LS criteria format (see localSearch)
+ * @param LS $criteria criteria format (see localSearch)
* @return string - transport token
*/
function globalSearch($criteria)
@@ -1346,12 +1531,13 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->globalSearch($criteria);
- }
-
+ } // fn globalSearch
+
+
/**
* Get results from search job on network hub
*
- * @param trtok: string - transport token
+ * @param string $trtok - transport token
* @return : LS search result format (see localSearch)
*/
function getSearchResults($trtok)
@@ -1359,28 +1545,31 @@ class GreenBox extends BasicStor{
require_once"Transport.php";
$tr =& new Transport($this);
return $tr->getSearchResults($trtok);
- }
-
+ } // fn getSearchResults
+
+
/* ========================================================= info methods */
/**
* List files in folder
*
- * @param id int, local id of folder
- * @param sessid string, session id
+ * @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)
+ 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 id int, local id
+ * @param int $id, local id
* @return string/err
*/
function getFileType($id)
@@ -1388,39 +1577,43 @@ class GreenBox extends BasicStor{
// $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 sessid string, session id
- * @param gunid string
- * @param ftype string, internal file type, optional
+ * @param string $sessid, session id
+ * @param string $gunid
+ * @param string $ftype, 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)
+ if (($res = $this->_authorize('read', $id, $sessid)) !== TRUE) {
return $res;
+ }
return $ex;
- }
+ } // fn existsFile
+
/* ==================================================== redefined methods */
/**
* Get file's path in virtual filesystem
*
- * @param id int
+ * @param int $id
* @return array
*/
function getPath($id)
{
- $pa = parent::getPath($id, 'id, name, type');
+ $pa = parent::getPath($id, 'id, name, type');
array_shift($pa);
return $pa;
- }
+ } // fn getPath
+
/**
* Get user id from session id
@@ -1429,18 +1622,22 @@ class GreenBox extends BasicStor{
* for wrong sessid (code ALIBERR_NOTEXISTS).
* HtmlUI depends on it.
*
- * @param sessid string
+ * @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;
+ if (PEAR::isError($r)) {
+ if ($r->getCode() == ALIBERR_NOTEXISTS) {
+ return NULL;
+ } else {
+ return $r;
+ }
}
return $r;
- }
+ } // fn getSessUserId
+
/**
* Change user password.
@@ -1448,74 +1645,83 @@ class GreenBox extends BasicStor{
* ('superuser mode'= superuser is changing some password without
* knowledge of the old password)
*
- * @param login string
- * @param oldpass string, old password
+ * @param string $login
+ * @param string $oldpass, old password
* (should be null or empty for 'superuser mode')
- * @param pass string, optional
- * @param sessid string, session id, required for 'superuser mode'
+ * @param string $pass, optional
+ * @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)){
+ 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;
+ if (PEAR::isError($res)) {
+ return $res;
+ }
return TRUE;
- }
+ } // fn passwd
+
/**
* 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
+ * @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){
+ if (($res = $this->_authorize('editPerms', $parid, $sessid)) !== TRUE) {
return $res;
}
return parent::addPerm($sid, $action, $oid, $type);
- }
-
+ } // fn addPerm
+
+
/**
* 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
+ * @param int $permid OPT - local permission id
+ * @param int $subj OPT - local user/group id
+ * @param int $obj OPT - local object id
+ * @param string $sessid, session id
* @return boolean/error
*/
function removePerm($permid=NULL, $subj=NULL, $obj=NULL, $sessid='')
{
- if(!is_null($permid)){
+ if (!is_null($permid)) {
$oid = $this->_getPermOid($permid);
- if(PEAR::isError($oid)) return $oid;
- if(!is_null($oid)){
+ if (PEAR::isError($oid)) {
+ return $oid;
+ }
+ if (!is_null($oid)) {
$parid = $this->getParent($oid);
- if(($res = $this->_authorize('editPerms', $parid, $sessid)) !== TRUE)
+ if (($res = $this->_authorize('editPerms', $parid, $sessid)) !== TRUE) {
return $res;
+ }
}
}
$res = parent::removePerm($permid, $subj, $obj);
return $res;
- }
-
-}
-?>
+ } // fn removePerm
+
+} // class GreenBox
+?>
\ No newline at end of file