diff --git a/livesupport/modules/storageServer/var/GreenBox.php b/livesupport/modules/storageServer/var/GreenBox.php index 7b8f18d73..ebc3da60b 100644 --- a/livesupport/modules/storageServer/var/GreenBox.php +++ b/livesupport/modules/storageServer/var/GreenBox.php @@ -23,7 +23,7 @@ Author : $Author: tomas $ - Version : $Revision: 1.5 $ + Version : $Revision: 1.6 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storageServer/var/GreenBox.php,v $ ------------------------------------------------------------------------------*/ @@ -48,7 +48,7 @@ require_once "Transport.php"; * LiveSupport file storage module * * @author $Author: tomas $ - * @version $Revision: 1.5 $ + * @version $Revision: 1.6 $ * @see Alib */ class GreenBox extends Alib{ @@ -113,6 +113,7 @@ class GreenBox extends Alib{ * @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 * @return int * @exception PEAR::error */ diff --git a/livesupport/modules/storageServer/var/LocStor.php b/livesupport/modules/storageServer/var/LocStor.php index f8ecc0347..9dce52160 100644 --- a/livesupport/modules/storageServer/var/LocStor.php +++ b/livesupport/modules/storageServer/var/LocStor.php @@ -23,7 +23,7 @@ Author : $Author: tomas $ - Version : $Revision: 1.4 $ + Version : $Revision: 1.5 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storageServer/var/LocStor.php,v $ ------------------------------------------------------------------------------*/ @@ -177,6 +177,7 @@ class LocStor extends GreenBox{ * @param sessid string * @param criteria string * @return array or PEAR::error + * @see GreenBox::localSearch */ function searchMetadata($sessid, $criteria) { diff --git a/livesupport/modules/storageServer/var/xmlrpc/testRunner.sh b/livesupport/modules/storageServer/var/xmlrpc/testRunner.sh index 6f72749e0..2b4cc1262 100755 --- a/livesupport/modules/storageServer/var/xmlrpc/testRunner.sh +++ b/livesupport/modules/storageServer/var/xmlrpc/testRunner.sh @@ -23,7 +23,7 @@ # # # Author : $Author: tomas $ -# Version : $Revision: 1.3 $ +# Version : $Revision: 1.4 $ # Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storageServer/var/xmlrpc/testRunner.sh,v $ #------------------------------------------------------------------------------- @@ -87,7 +87,7 @@ updateAudioClipMetadata() { getAudioClip() { echo "getAudioClip:" - $XR_CLI getAudioClip $SESSID $GUNID | ./urldecode + $XR_CLI getAudioClip $SESSID $GUNID | $TESTDIR/urldecode } searchMetadata() { diff --git a/livesupport/modules/storageServer/var/xmlrpc/xrLocStor.php b/livesupport/modules/storageServer/var/xmlrpc/xrLocStor.php index 2228b53bf..0f4d2bbfe 100644 --- a/livesupport/modules/storageServer/var/xmlrpc/xrLocStor.php +++ b/livesupport/modules/storageServer/var/xmlrpc/xrLocStor.php @@ -23,7 +23,7 @@ Author : $Author: tomas $ - Version : $Revision: 1.2 $ + Version : $Revision: 1.3 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storageServer/var/xmlrpc/xrLocStor.php,v $ ------------------------------------------------------------------------------*/ @@ -67,6 +67,7 @@ class XR_LocStor extends LocStor{ * Convert XMLRPC struct to PHP array * * @param input XMLRPC struct + * @return array */ function _xr_getPars($input) { @@ -77,7 +78,7 @@ class XR_LocStor extends LocStor{ return array(TRUE, $r); } else return array(FALSE, new xmlrpcresp(0, 801, - "xr_login: wrong 1st parameter, struct expected." + "wrong 1st parameter, struct expected." )); } @@ -86,6 +87,7 @@ class XR_LocStor extends LocStor{ * also return loginname of logged user * * @param input XMLRPC struct + * @return XMLRPC struct */ function xr_test($input) { @@ -98,29 +100,92 @@ class XR_LocStor extends LocStor{ ), true)); } + /** - * Call LocStor::authenticate + * Checks the login name and password of the user and return + * true if login data are correct, othervise return false. + * + * The XML-RPC name of this method is "locstor.authenticate". + * + * Input parameters: XML-RPC struct with the following fields: + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see Subjects::authenticate */ function xr_authenticate($input) { list($ok, $r) = $this->_xr_getPars($input); if(!$ok) return $r; $res = $this->authenticate($r['login'], $r['pass']); - return new xmlrpcresp(new xmlrpcval($res, "boolean")); + if(PEAR::isError($res)){ + return new xmlrpcresp(0, 804,"xr_authenticate: database error"); + } + $retval = ($res !== FALSE); + return new xmlrpcresp(new xmlrpcval($retval, "boolean")); } /** - * Call LocStor::login + * Checks the login name and password of the user. If the login is + * correct, a new session ID string is generated, to be used in all + * subsequent XML-RPC calls as the "sessid" field of the + * parameters. + * + * The XML-RPC name of this method is "locstor.login". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return string + * @see Alib::login */ function xr_login($input) { list($ok, $r) = $this->_xr_getPars($input); if(!$ok) return $r; - if(!($res = $this->login($r['login'], $r['pass']))) + $res = $this->login($r['login'], $r['pass']); + if(PEAR::isError($res)){ + return new xmlrpcresp(0, 804,"xr_login: database error"); + } + if($res === FALSE) return new xmlrpcresp(0, 802, "xr_login: login failed - incorrect username or password." ); @@ -129,9 +194,34 @@ class XR_LocStor extends LocStor{ } /** - * Call LocStor::logout + * Logout, destroy session and return 'Bye'. + * If session is not valid error message is returned. + * + * The XML-RPC name of this method is "locstor.logout". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return string + * @see GreenBox::logout */ function xr_logout($input) { @@ -147,9 +237,35 @@ class XR_LocStor extends LocStor{ } /** - * Call LocStor::existsAudioClip + * Check if audio clip exists and return TRUE/FALSE + * + * The XML-RPC name of this method is "locstor.existsAudioClip". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see LocStor::existsAudioClip */ function xr_existsAudioClip($input) { @@ -159,7 +275,7 @@ class XR_LocStor extends LocStor{ $res = $this->existsAudioClip($r['sessid'], $r['gunid']); #$this->debugLog($res); if(PEAR::isError($res)) - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_existsAudioClip: ".$res->getMessage(). " ".$res->getUserInfo() ); @@ -167,9 +283,37 @@ class XR_LocStor extends LocStor{ } /** - * Call LocStor::storeAudioClip + * Store new AudioClip or replace existing one. + * + * The XML-RPC name of this method is "locstor.storeAudioClip". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return string + * @see LocStor::storeAudioClip */ function xr_storeAudioClip($input) { @@ -181,16 +325,42 @@ class XR_LocStor extends LocStor{ if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "string")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_storeAudioClip: ".$res->getMessage(). " ".$res->getUserInfo() ); } /** - * Call LocStor::deleteAudioClip + * Delete existing audio clip + * + * The XML-RPC name of this method is "locstor.deleteAudioClip". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see LocStor::deleteAudioClip */ function xr_deleteAudioClip($input) { @@ -200,16 +370,43 @@ class XR_LocStor extends LocStor{ if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "boolean")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_deleteAudioClip: ".$res->getMessage(). " ".$res->getUserInfo() ); } /** - * Call LocStor::updateAudioClipMetadata + * Update existing audio clip metadata + * + * The XML-RPC name of this method is "locstor.updateAudioClipMetadata". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see LocStor::updateAudioClipMetadata */ function xr_updateAudioClipMetadata($input) { @@ -221,16 +418,46 @@ class XR_LocStor extends LocStor{ if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "boolean")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_updateAudioClip: ".$res->getMessage(). " ".$res->getUserInfo() ); } /** - * Call LocStor::searchMetadata + * Search in local metadata database + * + * The XML-RPC name of this method is "locstor.searchMetadata". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see LocStor::searchMetadata + * @see GreenBox::localSearch */ function xr_searchMetadata($input) { @@ -247,9 +474,35 @@ class XR_LocStor extends LocStor{ } /** - * Call LocStor::accessRawAudioData + * Make access to audio clip. + * + * The XML-RPC name of this method is "locstor.accessRawAudioData". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return string + * @see LocStor::accessRawAudioData */ function xr_accessRawAudioData($input) { @@ -259,16 +512,43 @@ class XR_LocStor extends LocStor{ if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "string")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_accessRawAudioData: ".$res->getMessage(). " ".$res->getUserInfo() ); } /** - * Call LocStor::releaseRawAudioData + * Release access to audio clip + * + * The XML-RPC name of this method is "locstor.releaseRawAudioData". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return boolean + * @see LocStor::releaseRawAudioData */ function xr_releaseRawAudioData($input) { @@ -278,26 +558,52 @@ class XR_LocStor extends LocStor{ if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "boolean")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_releaseRawAudioData: ".$res->getMessage(). " ".$res->getUserInfo() ); } /** - * Call LocStor::getAudioClip + * Return all file's metadata as XML string + * + * The XML-RPC name of this method is "locstor.getAudioClip". + * + * The input parameters are an XML-RPC struct with the following + * fields: + * + * + * On success, returns a single XML-RPC value: + * + * + * On errors, returns an XML-RPC error response. + * The possible error codes and error message are: + * * * @param input XMLRPC struct + * @return string + * @see LocStor::getAudioClip */ function xr_getAudioClip($input) { list($ok, $r) = $this->_xr_getPars($input); if(!$ok) return $r; - $res = $this->getAudioClip($r['sessid'], $r['gunid'], $r['metaData']); + $res = $this->getAudioClip($r['sessid'], $r['gunid']); if(!PEAR::isError($res)) return new xmlrpcresp(new xmlrpcval($res, "string")); else - return new xmlrpcresp(0, 803, + return new xmlrpcresp(0, 805, "xr_getAudioClip: ".$res->getMessage()." ".$res->getUserInfo() ); }