Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added public/private/static modifiers to functions. Added function getAllMetadata(). Commented out function updateRecord() which doesnt seem to be used.

This commit is contained in:
paul 2006-11-23 07:05:15 +00:00
parent ec562b0165
commit b4cecf725d
1 changed files with 97 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

213
campcaster/src/modules/storageServer/var/MetaData.php
View File

@ -52,19 +52,19 @@ class MetaData {
/** /**
* Parse and store metadata from XML file or XML string * Parse and store metadata from XML file or XML string
* *
* @param string $mdata * @param string $mdata
* Local path to metadata XML file or XML string * Local path to metadata XML file or XML string
* @param string $loc * @param string $loc
* location: 'file'|'string' * location: 'file'|'string'
* @param string $format * @param string $format
* Metadata format for validation * Metadata format for validation
* ('audioclip' | 'playlist' | 'webstream' | NULL) * ('audioclip' | 'playlist' | 'webstream' | NULL)
* (NULL = no validation) * (NULL = no validation)
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function insert($mdata, $loc='file', $format=NULL) public function insert($mdata, $loc='file', $format=NULL)
{ {
if ($this->exists()) { if ($this->exists()) {
return FALSE; return FALSE;
@ -82,34 +82,6 @@ class MetaData {
if (PEAR::isError($res)) { if (PEAR::isError($res)) {
return $res; return $res;
} }
/* obsolete by regenerateXmlFile()
switch($loc){
case"file":
if(! @copy($mdata, $this->fname)){
return PEAR::raiseError(
"MetaData::insert: file save failed".
" ($mdata, {$this->fname})",GBERR_FILEIO
);
}
break;
case"string":
$fname = $this->fname;
$e = FALSE;
if(!$fh = fopen($fname, "w")){ $e = TRUE; }
elseif(fwrite($fh, $mdata) === FALSE){ $e = TRUE; }
if($e){
return PEAR::raiseError(
"BasicStor::bsOpenDownload: can't write ($fname)",
GBERR_FILEIO);
}
fclose($fh);
break;
default:
return PEAR::raiseError(
"MetaData::insert: unsupported metadata location ($loc)"
);
}
*/
$this->exists = TRUE; $this->exists = TRUE;
$r = $this->regenerateXmlFile(); $r = $this->regenerateXmlFile();
if (PEAR::isError($r)) { if (PEAR::isError($r)) {
@ -120,19 +92,19 @@ class MetaData {
/** /**
* Call delete and insert * Call delete and insert
* *
* @param string $mdata * @param string $mdata
* local path to metadata XML file or XML string * local path to metadata XML file or XML string
* @param string $loc * @param string $loc
* 'file'|'string' * 'file'|'string'
* @param string $format * @param string $format
* metadata format for validation * metadata format for validation
* ('audioclip' | 'playlist' | 'webstream' | NULL) * ('audioclip' | 'playlist' | 'webstream' | NULL)
* (NULL = no validation) * (NULL = no validation)
* @return true or PEAR::error * @return true or PEAR::error
*/ */
function replace($mdata, $loc='file', $format=NULL) public function replace($mdata, $loc='file', $format=NULL)
{ {
if ($this->exists()) { if ($this->exists()) {
$res = $this->delete(); $res = $this->delete();
@ -149,12 +121,12 @@ class MetaData {
* *
* @return boolean * @return boolean
*/ */
function exists() public function exists()
{ {
if (is_null($this->exists)) { if (is_null($this->exists)) {
$this->exists = $this->dbCheck($this->gunid) && $this->exists = $this->dbCheck($this->gunid)
is_file($this->fname) && && is_file($this->fname)
is_readable($this->fname); && is_readable($this->fname);
} }
return $this->exists; return $this->exists;
} }
@ -165,7 +137,7 @@ class MetaData {
* *
* @return TRUE|PEAR_Error * @return TRUE|PEAR_Error
*/ */
function delete() public function delete()
{ {
if (file_exists($this->fname)) { if (file_exists($this->fname)) {
@unlink($this->fname); @unlink($this->fname);
@ -187,14 +159,10 @@ class MetaData {
* *
* @return string * @return string
*/ */
function getMetaData() public function getMetadata()
{ {
// return $this->genXMLDoc(); // obsolete
if (file_exists($this->fname)) { if (file_exists($this->fname)) {
$res = file_get_contents($this->fname); $res = file_get_contents($this->fname);
//require_once "XML/Beautifier.php";
//$fmt = new XML_Beautifier();
//$res = $fmt->formatString($res);
return $res; return $res;
} else { } else {
return file_get_contents(dirname(__FILE__).'/emptyMdata.xml'); return file_get_contents(dirname(__FILE__).'/emptyMdata.xml');
@ -202,6 +170,25 @@ class MetaData {
} }
/**
* Return all metadata for this GUNID.
*
* @return array
*/
public function getAllMetadata()
{
$sql = "SELECT predns, predicate, object
FROM {$this->mdataTable}
WHERE gunid=x'{$this->gunid}'::bigint";
$rows = $this->dbc->getAll($sql);
$values = array();
foreach ($rows as $row) {
$values[$row["predns"].":".$row["predicate"]] = $row["object"];
}
return $values;
}
/** /**
* Get metadata element value and record id * Get metadata element value and record id
* *
@ -213,7 +200,7 @@ class MetaData {
* int 'mid': record id * int 'mid': record id
* string 'value': metadata value} * string 'value': metadata value}
*/ */
function getMetadataEl($category, $parid=NULL) public function getMetadataEl($category, $parid=NULL)
{ {
// handle predicate namespace shortcut // handle predicate namespace shortcut
$a = XML_Util::splitQualifiedName($category); $a = XML_Util::splitQualifiedName($category);
@ -247,15 +234,15 @@ class MetaData {
/** /**
* Set metadata value / delete metadata record * Set metadata value / delete metadata record
* *
* @param int $mid * @param int $mid
* metadata record id * metadata record id
* @param string $value * @param string $value
* new metadata value (NULL for delete) * new metadata value (NULL for delete)
* @return boolean * @return boolean
*/ */
function setMetadataEl($mid, $value=NULL) public function setMetadataEl($mid, $value=NULL)
{ {
$info = $this->dbc->getRow(" $info = $this->dbc->getRow("
SELECT parmd.predns as parns, parmd.predicate as parname, SELECT parmd.predns as parns, parmd.predicate as parname,
@ -309,10 +296,10 @@ class MetaData {
* new metadata value (NULL for delete) * new metadata value (NULL for delete)
* @param string $predxml * @param string $predxml
* 'T' | 'A' | 'N' (tag, attr., namespace) * 'T' | 'A' | 'N' (tag, attr., namespace)
* @return int, * @return int
* new metadata record id * new metadata record id
*/ */
function insertMetadataEl($parid, $category, $value=NULL, $predxml='T') public function insertMetadataEl($parid, $category, $value=NULL, $predxml='T')
{ {
//$category = strtolower($category); //$category = strtolower($category);
$parent = $this->dbc->getRow(" $parent = $this->dbc->getRow("
@ -370,7 +357,7 @@ class MetaData {
* </ul> * </ul>
* @see BasicStor::bsGetMetadataValue * @see BasicStor::bsGetMetadataValue
*/ */
function getMetadataValueWithAttrs($category, $lang=NULL, $deflang=NULL, $objns='_L') private function getMetadataValueWithAttrs($category, $lang=NULL, $deflang=NULL, $objns='_L')
{ {
$all = $this->getMetadataEl($category); $all = $this->getMetadataEl($category);
$res = array(); $res = array();
@ -424,7 +411,7 @@ class MetaData {
* @return string * @return string
* If the value doesnt exist, return the empty string. * If the value doesnt exist, return the empty string.
*/ */
function getMetadataValue($category) public function getMetadataValue($category)
{ {
$element = $this->getMetadataEl($category); $element = $this->getMetadataEl($category);
$value = (isset($element[0]['value']) ? $element[0]['value'] : ''); $value = (isset($element[0]['value']) ? $element[0]['value'] : '');
@ -447,7 +434,7 @@ class MetaData {
* container element name for insert * container element name for insert
* @return boolean * @return boolean
*/ */
function setMetadataValue($category, $value, $lang=NULL, $mid=NULL, public function setMetadataValue($category, $value, $lang=NULL, $mid=NULL,
$container='metadata') $container='metadata')
{ {
// resolve actual element: // resolve actual element:
@ -530,7 +517,7 @@ class MetaData {
* *
* @return boolean * @return boolean
*/ */
function regenerateXmlFile() public function regenerateXmlFile()
{ {
$atime = date('c'); $atime = date('c');
// php4 fix: // php4 fix:
@ -566,7 +553,7 @@ class MetaData {
* *
* @return string * @return string
*/ */
function makeFname() private function makeFname()
{ {
return "{$this->resDir}/{$this->gunid}.xml"; return "{$this->resDir}/{$this->gunid}.xml";
} }
@ -577,7 +564,7 @@ class MetaData {
* *
* @return string * @return string
*/ */
function getFname() public function getFname()
{ {
return $this->fname; return $this->fname;
} }
@ -585,8 +572,9 @@ class MetaData {
/** /**
* Set the metadata format to the object instance * Set the metadata format to the object instance
* @return void
*/ */
function setFormat($format=NULL) public function setFormat($format=NULL)
{ {
$this->format = $format; $this->format = $format;
} }
@ -599,7 +587,7 @@ class MetaData {
* global unique id * global unique id
* @return boolean * @return boolean
*/ */
function dbCheck($gunid) private function dbCheck($gunid)
{ {
$cnt = $this->dbc->getOne(" $cnt = $this->dbc->getOne("
SELECT count(*)as cnt SELECT count(*)as cnt
@ -615,16 +603,16 @@ class MetaData {
/* ============================================= parse and store metadata */ /* ============================================= parse and store metadata */
/** /**
* Parse XML metadata * Parse XML metadata
* *
* @param string $mdata * @param string $mdata
* local path to metadata XML file or XML string * local path to metadata XML file or XML string
* @param string $loc * @param string $loc
* location: 'file'|'string' * location: 'file'|'string'
* @return array * @return array|PEAR_Error
* reference, parse result tree (or PEAR::error) * reference, parse result tree
*/ */
function &parse($mdata='', $loc='file') public function &parse($mdata='', $loc='file')
{ {
require_once("XmlParser.php"); require_once("XmlParser.php");
return XmlParser::parse($mdata, $loc); return XmlParser::parse($mdata, $loc);
@ -636,9 +624,9 @@ class MetaData {
* *
* @param array $tree * @param array $tree
* parsed tree * parsed tree
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function validate(&$tree) private function validate(&$tree)
{ {
if ($this->config['validate'] && !is_null($this->format)) { if ($this->config['validate'] && !is_null($this->format)) {
require_once("Validator.php"); require_once("Validator.php");
@ -666,9 +654,9 @@ class MetaData {
* 'A' | 'T' (attr or tag) * 'A' | 'T' (attr or tag)
* @param string $value * @param string $value
* validated element value * validated element value
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function validateOneValue($parName, $category, $predxml, $value) private function validateOneValue($parName, $category, $predxml, $value)
{ {
if ($this->config['validate'] && !is_null($this->format)) { if ($this->config['validate'] && !is_null($this->format)) {
require_once("Validator.php"); require_once("Validator.php");
@ -688,12 +676,11 @@ class MetaData {
/** /**
* Insert parsed metadata into database * Insert parsed metadata into database
* *
* @todo Check the return value for this function...
* @param array $tree * @param array $tree
* parsed tree * parsed tree
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function storeDoc(&$tree) private function storeDoc(&$tree)
{ {
$this->dbc->query("BEGIN"); $this->dbc->query("BEGIN");
$res = $this->storeNode($tree); $res = $this->storeNode($tree);
@ -707,7 +694,6 @@ class MetaData {
return $res; return $res;
} }
return TRUE; return TRUE;
return $root;
} }
@ -723,7 +709,7 @@ class MetaData {
* @return int * @return int
* local metadata record id * local metadata record id
*/ */
function storeNode(&$node, $parid=NULL, $nSpaces=array()) private function storeNode(&$node, $parid=NULL, $nSpaces=array())
{ {
//echo $node->node_name().", ".$node->node_type().", ".$node->prefix().", $parid.\n"; //echo $node->node_name().", ".$node->node_type().", ".$node->prefix().", $parid.\n";
$nSpaces = array_merge($nSpaces, $node->nSpaces); $nSpaces = array_merge($nSpaces, $node->nSpaces);
@ -767,21 +753,21 @@ class MetaData {
* object value, e.g. title string * object value, e.g. title string
* @param string $objns * @param string $objns
* object namespace prefix, have to be defined in file's metadata * object namespace prefix, have to be defined in file's metadata
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function updateRecord($mdid, $object, $objns='_L') // function updateRecord($mdid, $object, $objns='_L')
{ // {
$object_sql = is_null($object) ? "NULL" : "'".pg_escape_string($object)."'"; // $object_sql = is_null($object) ? "NULL" : "'".pg_escape_string($object)."'";
$objns_sql = is_null($objns) ? "NULL" : "'".pg_escape_string($objns)."'"; // $objns_sql = is_null($objns) ? "NULL" : "'".pg_escape_string($objns)."'";
$res = $this->dbc->query("UPDATE {$this->mdataTable} // $res = $this->dbc->query("UPDATE {$this->mdataTable}
SET objns = $objns_sql, object = $object_sql // SET objns = $objns_sql, object = $object_sql
WHERE gunid = x'{$this->gunid}'::bigint AND id='$mdid' // WHERE gunid = x'{$this->gunid}'::bigint AND id='$mdid'
"); // ");
if (PEAR::isError($res)) { // if (PEAR::isError($res)) {
return $res; // return $res;
} // }
return TRUE; // return TRUE;
} // }
/** /**
@ -807,7 +793,7 @@ class MetaData {
* @return int * @return int
* new metadata record id * new metadata record id
*/ */
function storeRecord($subjns, $subject, $predns, $predicate, $predxml='T', private function storeRecord($subjns, $subject, $predns, $predicate, $predxml='T',
$objns=NULL, $object=NULL) $objns=NULL, $object=NULL)
{ {
//echo "$subjns, $subject, $predns, $predicate, $predxml, $objns, $object\n"; //echo "$subjns, $subject, $predns, $predicate, $predxml, $objns, $object\n";
@ -849,13 +835,11 @@ class MetaData {
* local metadata record id * local metadata record id
* @return boolean * @return boolean
*/ */
function deleteRecord($mid) private function deleteRecord($mid)
{ {
$sql = " $sql = "SELECT id FROM {$this->mdataTable}
SELECT id FROM {$this->mdataTable} WHERE subjns='_I' AND subject='{$mid}' AND
WHERE subjns='_I' AND subject='{$mid}' AND gunid=x'{$this->gunid}'::bigint";
gunid=x'{$this->gunid}'::bigint
";
$rh = $this->dbc->query($sql); $rh = $this->dbc->query($sql);
if (PEAR::isError($rh)) { if (PEAR::isError($rh)) {
return $rh; return $rh;
@ -867,11 +851,9 @@ class MetaData {
} }
} }
$rh->free(); $rh->free();
$sql = " $sql = "DELETE FROM {$this->mdataTable}
DELETE FROM {$this->mdataTable} WHERE id={$mid} AND
WHERE id={$mid} AND gunid=x'{$this->gunid}'::bigint";
gunid=x'{$this->gunid}'::bigint
";
$res = $this->dbc->query($sql); $res = $this->dbc->query($sql);
if (PEAR::isError($res)) { if (PEAR::isError($res)) {
return $res; return $res;
@ -887,7 +869,7 @@ class MetaData {
* @return array * @return array
* array with metadata tree * array with metadata tree
*/ */
function genPhpArray() public function genPhpArray()
{ {
$res = array(); $res = array();
$row = $this->dbc->getRow(" $row = $this->dbc->getRow("
@ -915,7 +897,7 @@ class MetaData {
* @return string * @return string
* string with XML document * string with XML document
*/ */
function genXMLDoc() public function genXMLDoc()
{ {
require_once("XML/Util.php"); require_once("XML/Util.php");
$res = XML_Util::getXMLDeclaration("1.0", "UTF-8")."\n"; $res = XML_Util::getXMLDeclaration("1.0", "UTF-8")."\n";
@ -940,7 +922,6 @@ class MetaData {
$res .= $node; $res .= $node;
require_once("XML/Beautifier.php"); require_once("XML/Beautifier.php");
$fmt = new XML_Beautifier(); $fmt = new XML_Beautifier();
# $res = $fmt->formatString($res);
return $res; return $res;
} }
@ -955,7 +936,7 @@ class MetaData {
* @return string * @return string
* XML serialization of node * XML serialization of node
*/ */
function genXMLNode($row, $genXML=TRUE) private function genXMLNode($row, $genXML=TRUE)
{ {
if (DEBUG) { if (DEBUG) {
echo"genXMLNode:\n"; echo"genXMLNode:\n";
@ -1007,7 +988,7 @@ class MetaData {
* - children array, child nodes * - children array, child nodes
* - nSpaces hash, namespace definitions * - nSpaces hash, namespace definitions
*/ */
function getSubrows($parid, $genXML=TRUE) private function getSubrows($parid, $genXML=TRUE)
{ {
if (DEBUG) { if (DEBUG) {
echo" getSubrows:\n"; echo" getSubrows:\n";
@ -1063,17 +1044,17 @@ class MetaData {
/* ========================================================= test methods */ /* ========================================================= test methods */
/** /**
* Test method * Test method
* *
* @return true or PEAR::error * @return true|PEAR_Error
*/ */
function test() public function test()
{ {
$res = $this->replace(getcwd().'/mdata2.xml'); $res = $this->replace(getcwd().'/mdata2.xml');
if (PEAR::isError($res)) { if (PEAR::isError($res)) {
return $res; return $res;
} }
$res = $this->getMetaData(); $res = $this->getMetadata();
if (PEAR::isError($res)) { if (PEAR::isError($res)) {
return $res; return $res;
} }