xmlrpctag.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
*/

abstract class XoopsXmlRpcDocument
{
    protected $_tags = array();

    public function add(XoopsXmlRpcTag &$tagobj)
    {
        $this->_tags[] = $tagobj;
    }

    abstract function render();

}

class XoopsXmlRpcResponse extends XoopsXmlRpcDocument
{
    public function render()
    {
        $payload = '';
        foreach ($this->_tags as $tag) {
            /* @var $tag XoopsXmlRpcTag */
            if (!$tag->isFault()) {
                $payload .= $tag->render();
            } else {
                return '<?xml version="1.0"?><methodResponse>' . $tag->render() . '</methodResponse>';
            }
        }
        return '<?xml version="1.0"?><methodResponse><params><param>' . $payload . '</param></params></methodResponse>';
    }
}

class XoopsXmlRpcRequest extends XoopsXmlRpcDocument
{

    public $methodName;

    public function __construct($methodName)
    {
        $this->methodName = trim($methodName);
    }

    public function render()
    {
        $payload = '';
        foreach ($this->_tags as $tag) {
            /* @var $tag XoopsXmlRpcTag */
            $payload .= '<param>' . $tag->render() . '</param>';
        }
        return '<?xml version="1.0"?><methodCall><methodName>' . $this->methodName . '</methodName><params>' . $payload . '</params></methodCall>';
    }
}

abstract class XoopsXmlRpcTag
{
    protected $_fault = false;

    public function encode(&$text)
    {
        $text = preg_replace(array("/\&([a-z\d\#]+)\;/i", "/\&/", "/\#\|\|([a-z\d\#]+)\|\|\#/i"),
            array("#||\\1||#", "&amp;", "&\\1;"), str_replace(array("<", ">"), array("&lt;", "&gt;"), $text));
        return $text;
    }

    public function setFault($fault = true)
    {
        $this->_fault = (bool)$fault;
    }

    public function isFault()
    {
        return $this->_fault;
    }

    abstract function render();
}

class XoopsXmlRpcFault extends XoopsXmlRpcTag
{
    protected $_code;

    protected $_extra;

    public function __construct($code, $extra = null)
    {
        $this->setFault(true);
        $this->_code = intval($code);
        $this->_extra = isset($extra) ? trim($extra) : '';
    }

    public function render()
    {
        switch ($this->_code) {
            case 101:
                $string = 'Invalid server URI';
                break;
            case 102:
                $string = 'Parser parse error';
                break;
            case 103:
                $string = 'Module not found';
                break;
            case 104:
                $string = 'User authentication failed';
                break;
            case 105:
                $string = 'Module API not found';
                break;
            case 106:
                $string = 'Method response error';
                break;
            case 107:
                $string = 'Method not supported';
                break;
            case 108:
                $string = 'Invalid parameter';
                break;
            case 109:
                $string = 'Missing parameters';
                break;
            case 110:
                $string = 'Selected blog application does not exist';
                break;
            case 111:
                $string = 'Method permission denied';
                break;
            default:
                $string = 'Method response error';
                break;
        }
        $string .= "\n" . $this->_extra;
        return '<fault><value><struct><member><name>faultCode</name><value>' . $this->_code . '</value></member><member><name>faultString</name><value>' . $this->encode($string) . '</value></member></struct></value></fault>';
    }
}

class XoopsXmlRpcInt extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        $this->_value = intval($value);
    }

    public function render()
    {
        return '<value><int>' . $this->_value . '</int></value>';
    }
}

class XoopsXmlRpcDouble extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        $this->_value = (float)$value;
    }

    public function render()
    {
        return '<value><double>' . $this->_value . '</double></value>';
    }
}

class XoopsXmlRpcBoolean extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        $this->_value = (!empty($value) && $value != false) ? 1 : 0;
    }

    public function render()
    {
        return '<value><boolean>' . $this->_value . '</boolean></value>';
    }
}

class XoopsXmlRpcString extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        $this->_value = strval($value);
    }

    public function render()
    {
        return '<value><string>' . $this->encode($this->_value) . '</string></value>';
    }
}

class XoopsXmlRpcDatetime extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        if (!is_numeric($value)) {
            $this->_value = strtotime($value);
        } else {
            $this->_value = intval($value);
        }
    }

    public function render()
    {
        return '<value><dateTime.iso8601>' . gmstrftime("%Y%m%dT%H:%M:%S", $this->_value) . '</dateTime.iso8601></value>';
    }
}

class XoopsXmlRpcBase64 extends XoopsXmlRpcTag
{
    protected $_value;

    public function __construct($value)
    {
        $this->_value = base64_encode($value);
    }

    public function render()
    {
        return '<value><base64>' . $this->_value . '</base64></value>';
    }
}

class XoopsXmlRpcArray extends XoopsXmlRpcTag
{
    protected $_tags = array();

    public function add(XoopsXmlRpcTag &$tagobj)
    {
        $this->_tags[] = $tagobj;
    }

    public function render()
    {
        $ret = '<value><array><data>';
        foreach ($this->_tags as $tag) {
            /* @var $tag XoopsXmlRpcTag */
            $ret .= $tag->render();
        }
        $ret .= '</data></array></value>';
        return $ret;
    }
}

class XoopsXmlRpcStruct extends XoopsXmlRpcTag
{
    protected $_tags = array();

    public function add($name, XoopsXmlRpcTag &$tagobj)
    {
        $this->_tags[] = array('name' => $name, 'value' => $tagobj);
    }

    public function render()
    {
        $ret = '<value><struct>';
        foreach ($this->_tags as $tag) {
            /* @var $tag['value'] XoopsXmlRplTag */
            $ret .= '<member><name>' . $this->encode($tag['name']) . '</name>' . $tag['value']->render() . '</member>';
        }
        $ret .= '</struct></value>';
        return $ret;
    }
}

?>