aboutsummaryrefslogtreecommitdiffstats
path: root/BSF/include/ws_protocols/rest_encoder.php
diff options
context:
space:
mode:
authorvdigital <vdigital@piwigo.org>2008-05-23 21:05:41 +0000
committervdigital <vdigital@piwigo.org>2008-05-23 21:05:41 +0000
commit77fd1f51a3c5f5a52f72ef8a299fe368228e2285 (patch)
treea67ede42904657ccf3349ecdaef1cec8b8e36ff8 /BSF/include/ws_protocols/rest_encoder.php
parent553727dffacc48e8337c1d141f2a25af359e74b1 (diff)
git-svn-id: http://piwigo.org/svn/trunk@2357 68402e56-0260-453c-a942-63ccdbb3a9ee
Diffstat (limited to 'BSF/include/ws_protocols/rest_encoder.php')
-rw-r--r--BSF/include/ws_protocols/rest_encoder.php281
1 files changed, 281 insertions, 0 deletions
diff --git a/BSF/include/ws_protocols/rest_encoder.php b/BSF/include/ws_protocols/rest_encoder.php
new file mode 100644
index 000000000..e057c6427
--- /dev/null
+++ b/BSF/include/ws_protocols/rest_encoder.php
@@ -0,0 +1,281 @@
+<?php
+// +-----------------------------------------------------------------------+
+// | Piwigo - a PHP based picture gallery |
+// +-----------------------------------------------------------------------+
+// | Copyright(C) 2008 Piwigo Team http://piwigo.org |
+// | Copyright(C) 2003-2008 PhpWebGallery Team http://phpwebgallery.net |
+// | Copyright(C) 2002-2003 Pierrick LE GALL http://le-gall.net/pierrick |
+// +-----------------------------------------------------------------------+
+// | This program is free software; you can redistribute it and/or modify |
+// | it under the terms of the GNU General Public License as published by |
+// | the Free Software Foundation |
+// | |
+// | This program is distributed in the hope that it will be useful, but |
+// | WITHOUT ANY WARRANTY; without even the implied warranty of |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
+// | General Public License for more details. |
+// | |
+// | You should have received a copy of the GNU General Public License |
+// | along with this program; if not, write to the Free Software |
+// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
+// | USA. |
+// +-----------------------------------------------------------------------+
+
+
+class PwgXmlWriter
+{
+ var $_indent;
+ var $_indentStr;
+
+ var $_elementStack;
+ var $_lastTagOpen;
+ var $_indentLevel;
+
+ var $_encodedXml;
+
+ function PwgXmlWriter()
+ {
+ $this->_elementStack = array();
+ $this->_lastTagOpen = false;
+ $this->_indentLevel = 0;
+
+ $this->_encodedXml = '';
+ $this->_indent = true;
+ $this->_indentStr = "\t";
+ }
+
+ function &getOutput()
+ {
+ return $this->_encodedXml;
+ }
+
+
+ function start_element($name)
+ {
+ $this->_end_prev(false);
+ if (!empty($this->_elementStack))
+ {
+ $this->_eol_indent();
+ }
+ $this->_indentLevel++;
+ $this->_indent();
+ $this->_output( '<'.$name );
+ $this->_lastTagOpen = true;
+ array_push( $this->_elementStack, $name);
+ }
+
+ function end_element($x)
+ {
+ $close_tag = $this->_end_prev(true);
+ $name = array_pop( $this->_elementStack );
+ if ($close_tag)
+ {
+ $this->_indentLevel--;
+ $this->_indent();
+// $this->_eol_indent();
+ $this->_output('</'.$name.">");
+ }
+ }
+
+ function write_content($value)
+ {
+ $this->_end_prev(false);
+ $value = (string)$value;
+ $this->_output( htmlspecialchars( $value ) );
+ }
+
+ function write_cdata($value)
+ {
+ $this->_end_prev(false);
+ $value = (string)$value;
+ $this->_output(
+ '<![CDATA['
+ . str_replace(']]>', ']]&gt;', $value)
+ . ']]>' );
+ }
+
+ function write_attribute($name, $value)
+ {
+ $this->_output(' '.$name.'="'.$this->encode_attribute($value).'"');
+ }
+
+ function encode_attribute($value)
+ {
+ return htmlspecialchars( (string)$value);
+ }
+
+ function _end_prev($done)
+ {
+ $ret = true;
+ if ($this->_lastTagOpen)
+ {
+ if ($done)
+ {
+ $this->_indentLevel--;
+ $this->_output( ' />' );
+ //$this->_eol_indent();
+ $ret = false;
+ }
+ else
+ {
+ $this->_output( '>' );
+ }
+ $this->_lastTagOpen = false;
+ }
+ return $ret;
+ }
+
+ function _eol_indent()
+ {
+ if ($this->_indent)
+ $this->_output("\n");
+ }
+
+ function _indent()
+ {
+ if ($this->_indent and
+ $this->_indentLevel > count($this->_elementStack) )
+ {
+ $this->_output(
+ str_repeat( $this->_indentStr, count($this->_elementStack) )
+ );
+ }
+ }
+
+ function _output($raw_content)
+ {
+ $this->_encodedXml .= $raw_content;
+ }
+}
+
+class PwgRestEncoder extends PwgResponseEncoder
+{
+ function encodeResponse($response)
+ {
+ $respClass = strtolower( get_class($response) );
+ if ($respClass=='pwgerror')
+ {
+ $ret = '<?xml version="1.0"?>
+<rsp stat="fail">
+ <err code="'.$response->code().'" msg="'.htmlspecialchars($response->message()).'" />
+</rsp>';
+ return $ret;
+ }
+
+ $this->_writer = new PwgXmlWriter();
+ $this->encode($response);
+ $ret = $this->_writer->getOutput();
+ $ret = '<?xml version="1.0" encoding="'.get_pwg_charset().'" ?>
+<rsp stat="ok">
+'.$ret.'
+</rsp>';
+
+ return $ret;
+ }
+
+ function getContentType()
+ {
+ return 'text/xml';
+ }
+
+ function encode_array($data, $itemName, $xml_attributes=array())
+ {
+ foreach ($data as $item)
+ {
+ $this->_writer->start_element( $itemName );
+ $this->encode($item, $xml_attributes);
+ $this->_writer->end_element( $itemName );
+ }
+ }
+
+ function encode_struct($data, $skip_underscore, $xml_attributes=array())
+ {
+ foreach ($data as $name => $value)
+ {
+ if (is_numeric($name))
+ continue;
+ if ($skip_underscore and $name[0]=='_')
+ continue;
+ if ( is_null($value) )
+ continue; // null means we dont put it
+ if ( $name==WS_XML_ATTRIBUTES)
+ {
+ foreach ($value as $attr_name => $attr_value)
+ {
+ $this->_writer->write_attribute($attr_name, $attr_value);
+ }
+ unset($data[$name]);
+ }
+ else if ( isset($xml_attributes[$name]) )
+ {
+ $this->_writer->write_attribute($name, $value);
+ unset($data[$name]);
+ }
+ }
+
+ foreach ($data as $name => $value)
+ {
+ if (is_numeric($name))
+ continue;
+ if ($skip_underscore and $name[0]=='_')
+ continue;
+ if ( is_null($value) )
+ continue; // null means we dont put it
+ if ($name!=WS_XML_CONTENT)
+ $this->_writer->start_element($name);
+ $this->encode($value);
+ if ($name!=WS_XML_CONTENT)
+ $this->_writer->end_element($name);
+ }
+ }
+
+ function encode($data, $xml_attributes=array() )
+ {
+ switch (gettype($data))
+ {
+ case 'null':
+ case 'NULL':
+ $this->_writer->write_content('');
+ break;
+ case 'boolean':
+ $this->_writer->write_content($data ? '1' : '0');
+ break;
+ case 'integer':
+ case 'double':
+ $this->_writer->write_content($data);
+ break;
+ case 'string':
+ $this->_writer->write_content($data);
+ break;
+ case 'array':
+ $is_array = range(0, count($data) - 1) === array_keys($data);
+ if ($is_array)
+ {
+ $this->encode_array($data, 'item' );
+ }
+ else
+ {
+ $this->encode_struct($data, false, $xml_attributes);
+ }
+ break;
+ case 'object':
+ switch ( strtolower(get_class($data)) )
+ {
+ case 'pwgnamedarray':
+ $this->encode_array($data->_content, $data->_itemName, $data->_xmlAttributes);
+ break;
+ case 'pwgnamedstruct':
+ $this->encode_array( array($data->_content), $data->_name, $data->_xmlAttributes);
+ break;
+ default:
+ $this->encode_struct(get_object_vars($data), true);
+ break;
+ }
+ break;
+ default:
+ trigger_error("Invalid type ". gettype($data)." ".get_class($data), E_USER_WARNING );
+ }
+ }
+}
+
+?>