Version 3.0.5
This commit is contained in:
Neo committed
1 parent
19b38c7c74
commit
1d4720f3e2
3755 files changed
+508378
-664541
No files matched your search
@@ -0,0 +1,613 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Invision Power Services
|
||||
* IP.Board v3.0.5
|
||||
* This class can act as an API server, handling API requests
|
||||
* Last Updated: $Date: 2009-10-01 10:02:41 -0400 (Thu, 01 Oct 2009) $
|
||||
*
|
||||
* @author $Author: bfarber $
|
||||
* @copyright (c) 2001 - 2009 Invision Power Services, Inc.
|
||||
* @license http://www.iinvisionpower.com/community/board/license.html
|
||||
* @package Invision Power Services Kernel
|
||||
* @link http://www.iinvisionpower.com
|
||||
* @since Friday 6th January 2006 (12:24)
|
||||
* @version $Revision: 334 $
|
||||
*
|
||||
* Examples of sending and receiving API data
|
||||
* <code>
|
||||
* # APPLICATION: SEND AN API REQUEST AND PARSE DATA
|
||||
* $api_server->apiSendRequest( 'http://www.domain.com/xmlrpc.php', 'get_members', array( 'name' => 'matt', 'email' => 'matt@email.com' ) );
|
||||
* # APPLICATION: PICK UP REPLY AND PARSE
|
||||
* print_r( $api_server->params );
|
||||
*
|
||||
* # SERVER: PARSE DATA, MAKE DATA AND RETURN
|
||||
* $api_server->apiDecodeRequest( $_SERVER['RAW_HTTP_POST_DATA'] );
|
||||
* print $api_server->method_name;
|
||||
* print_r( $api_server->params );
|
||||
* # SERVER: SEND DATA BACK
|
||||
* # Is complex array, so we choose to encode and send with the , 1 flag
|
||||
* $api_server->apiSendReply( array( 'matt' => array( 'email' => 'matt@email.com', 'joined' => '01-01-2005' ) ), 1 );
|
||||
* </code>
|
||||
*
|
||||
*/
|
||||
|
||||
if ( ! defined( 'IPS_CLASSES_PATH' ) )
|
||||
{
|
||||
/**
|
||||
* Define classes path
|
||||
*/
|
||||
define( 'IPS_CLASSES_PATH', dirname(__FILE__) );
|
||||
}
|
||||
|
||||
class classApiServer
|
||||
{
|
||||
/**
|
||||
* XML-RPC class
|
||||
*
|
||||
* @access public
|
||||
* @var object
|
||||
*/
|
||||
public $xmlrpc;
|
||||
|
||||
/**
|
||||
* Raw incoming data
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
public $raw_request;
|
||||
|
||||
/**
|
||||
* Requested method name
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
private $method_name;
|
||||
|
||||
/**
|
||||
* Raw data incoming
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
private $_raw_in_data;
|
||||
|
||||
/**
|
||||
* Raw data output
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
private $_raw_out_data;
|
||||
|
||||
/**
|
||||
* Method params
|
||||
*
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $params = array();
|
||||
|
||||
/**
|
||||
* XML-RPC serialized 64 key
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
private $serialized_key = '__serialized64__';
|
||||
|
||||
/**
|
||||
* Server function object
|
||||
*
|
||||
* @access private
|
||||
* @var object
|
||||
*/
|
||||
private $xml_server;
|
||||
|
||||
/**
|
||||
* Return cookie information
|
||||
*
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $cookies = array();
|
||||
|
||||
/**
|
||||
* XML-RPC cookie serialized 64 key
|
||||
*
|
||||
* @access private
|
||||
* @var string
|
||||
*/
|
||||
private $cookie_serialized_key = '__cookie__serialized64__';
|
||||
|
||||
/**
|
||||
* HTTP Auth required
|
||||
*
|
||||
* @access public
|
||||
* @var string
|
||||
* @var string
|
||||
*/
|
||||
public $auth_user = '';
|
||||
public $auth_pass = '';
|
||||
|
||||
/**
|
||||
* Errors array
|
||||
*
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $errors = array();
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
if ( ! is_object( $this->xmlrpc ) )
|
||||
{
|
||||
require_once( IPS_KERNEL_PATH . '/classXmlRpc.php' );
|
||||
$this->xmlrpc = new classXmlRpc();
|
||||
}
|
||||
|
||||
$this->cookies = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Add object map to this class
|
||||
*
|
||||
* @access public
|
||||
* @param string Incoming data
|
||||
* @return string api
|
||||
*/
|
||||
public function decodeRequest( $incoming='' )
|
||||
{
|
||||
if ( ! $incoming )
|
||||
{
|
||||
# PHP Bug: http://bugs.php.net/bug.php?id=41293
|
||||
|
||||
if( phpversion() == "5.2.2" )
|
||||
{
|
||||
$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( "php://input" );
|
||||
}
|
||||
|
||||
$incoming = isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ? $GLOBALS['HTTP_RAW_POST_DATA'] : '';
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Get data and dispatch
|
||||
//-----------------------------------------
|
||||
|
||||
$this->apiDecodeRequest( $incoming );
|
||||
|
||||
$this->raw_request = $incoming;
|
||||
|
||||
$api_call = explode( ".", $this->method_name );
|
||||
|
||||
if ( count($api_call) > 1 )
|
||||
{
|
||||
$this->method_name = $api_call[1];
|
||||
|
||||
return $api_call[0];
|
||||
}
|
||||
else
|
||||
{
|
||||
return 'default';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add object map to this class
|
||||
*
|
||||
* @access public
|
||||
* @param object Server class object
|
||||
* @param string Document type
|
||||
* @return boolean
|
||||
*/
|
||||
public function addObjectMap( $server_class, $doc_type='UTF-8' )
|
||||
{
|
||||
$this->xmlrpc->doc_type = $doc_type;
|
||||
|
||||
if ( is_object( $server_class ) )
|
||||
{
|
||||
$this->xml_server =& $server_class;
|
||||
|
||||
return true;
|
||||
}
|
||||
else
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the XML-RPC data
|
||||
*
|
||||
* @access public
|
||||
* @param string Incoming data
|
||||
* @return mixed Boolean, Output error
|
||||
*/
|
||||
public function getXmlRpc( $incoming='' )
|
||||
{
|
||||
if ( ! $this->xml_server )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Got function?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( $this->method_name AND is_array( $this->xml_server->__dispatch_map[ $this->method_name ] ) )
|
||||
{
|
||||
$func = $this->method_name;
|
||||
$_params = array();
|
||||
|
||||
//-----------------------------------------
|
||||
// Figure out params to use...
|
||||
//-----------------------------------------
|
||||
|
||||
if ( is_array( $this->params ) and is_array( $this->xml_server->__dispatch_map[ $func ]['in'] ) )
|
||||
{
|
||||
foreach( $this->xml_server->__dispatch_map[ $func ]['in'] as $field => $type )
|
||||
{
|
||||
$_var = $this->params[ $field ];
|
||||
|
||||
switch ($type)
|
||||
{
|
||||
default:
|
||||
case 'string':
|
||||
$_var = (string) $_var;
|
||||
break;
|
||||
case 'int':
|
||||
case 'i4':
|
||||
$_var = (int) $_var;
|
||||
break;
|
||||
case 'double':
|
||||
$_var = (double) $_var;
|
||||
break;
|
||||
case 'boolean':
|
||||
$_var = (bool) $_var;
|
||||
break;
|
||||
case 'base64':
|
||||
$_var = trim($_var);
|
||||
break;
|
||||
case 'struct':
|
||||
$_var = is_array($_var) ? $_var : (string) $_var;
|
||||
break;
|
||||
}
|
||||
|
||||
$_params[ $field ] = $_var;
|
||||
}
|
||||
}
|
||||
|
||||
if ( is_array( $_params ) )
|
||||
{
|
||||
@call_user_func_array( array( &$this->xml_server, $func), $_params );
|
||||
}
|
||||
else
|
||||
{
|
||||
@call_user_func( array( &$this->xml_server, $func), $_params );
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
//-----------------------------------------
|
||||
// Return false
|
||||
//-----------------------------------------
|
||||
|
||||
$this->apiSendError( 100, 'No methodRequest function -' . htmlspecialchars( $this->method_name ) . ' defined / found' );
|
||||
exit();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a cookie for the API request
|
||||
*
|
||||
* @access public
|
||||
* @param array Array of params to send
|
||||
* @return void
|
||||
*/
|
||||
public function apiAddCookieData( $data )
|
||||
{
|
||||
if ( $data['name'] )
|
||||
{
|
||||
$this->cookies[ $data['name'] ] = $data;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return API Request
|
||||
*
|
||||
* @access public
|
||||
* @param array Array of params to send
|
||||
* @param int Complex data: Encode before sending
|
||||
* @param array Forced data type mapping
|
||||
* @return void
|
||||
*/
|
||||
public function apiSendReply( $data=array(), $complex_data=0, $force=array() )
|
||||
{
|
||||
//-----------------------------------------
|
||||
// Cookies?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( is_array( $this->cookies ) AND count( $this->cookies ) )
|
||||
{
|
||||
$data[ $this->cookie_serialized_key ] = $this->_encodeBase64Array( $this->cookies );
|
||||
$this->xmlrpc->map_type_to_key[ $this->cookie_serialized_key ] = 'base64';
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Check
|
||||
//-----------------------------------------
|
||||
|
||||
if ( ! is_array( $data ) )
|
||||
{
|
||||
$this->xmlrpc->returnValue( $data );
|
||||
}
|
||||
elseif ( ! count( $data ) )
|
||||
{
|
||||
# No data? Just return true
|
||||
$this->xmlrpc->returnTrue();
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Complex data?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( $complex_data )
|
||||
{
|
||||
$_tmp = $data;
|
||||
$data = array();
|
||||
$data[ $this->serialized_key ] = $this->_encodeBase64Array( $_tmp );
|
||||
$this->xmlrpc->map_type_to_key[ $this->serialized_key ] = 'base64';
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Force type?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( is_array($force) AND count($force) > 0 )
|
||||
{
|
||||
foreach ( $force as $key => $type )
|
||||
{
|
||||
$this->xmlrpc->map_type_to_key[ $key ] = $type;
|
||||
}
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Send...
|
||||
//-----------------------------------------
|
||||
|
||||
$this->xmlrpc->returnParams( $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return API Request (ERROR)
|
||||
*
|
||||
* @access public
|
||||
* @param int Error Code
|
||||
* @param string Error message
|
||||
* @return void
|
||||
*/
|
||||
public function apiSendError( $error_code, $error_msg )
|
||||
{
|
||||
$this->xmlrpc->returnError( $error_code, $error_msg );
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode API Request
|
||||
*
|
||||
* @access public
|
||||
* @param string Raw data picked up
|
||||
* @return void
|
||||
*/
|
||||
public function apiDecodeRequest( $raw_data )
|
||||
{
|
||||
//-----------------------------------------
|
||||
// Get data...
|
||||
//-----------------------------------------
|
||||
|
||||
$raw = $this->xmlrpc->decodeXmlRpc( $raw_data );
|
||||
|
||||
//-----------------------------------------
|
||||
// Process return data
|
||||
//-----------------------------------------
|
||||
|
||||
$this->apiProcessData( $raw );
|
||||
}
|
||||
|
||||
/**
|
||||
* Send API Request
|
||||
*
|
||||
* @access public
|
||||
* @param string URL to send request to
|
||||
* @param string Method name for API to pick up
|
||||
* @param array Data to send
|
||||
* @param int Complex data: Encode before sending
|
||||
* @return boolean Data sent successfully
|
||||
*/
|
||||
public function apiSendRequest( $url, $method_name, $data=array(), $complex_data=0 )
|
||||
{
|
||||
//-----------------------------------------
|
||||
// INIT
|
||||
//-----------------------------------------
|
||||
|
||||
$return_data = array();
|
||||
$raw = array();
|
||||
$this->xmlrpc->errors = array();
|
||||
$this->xmlrpc->auth_user = $this->auth_user;
|
||||
$this->xmlrpc->auth_pass = $this->auth_pass;
|
||||
|
||||
//-----------------------------------------
|
||||
// Cookies?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( is_array( $this->cookies ) AND count( $this->cookies ) )
|
||||
{
|
||||
$data[ $this->cookie_serialized_key ] = $this->_encodeBase64Array( $this->cookies );
|
||||
$this->xmlrpc->map_type_to_key[ $this->cookie_serialized_key ] = 'base64';
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Complex data?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( $complex_data )
|
||||
{
|
||||
$_tmp = $data;
|
||||
$data = array();
|
||||
$data[ $this->serialized_key ] = $this->_encodeBase64Array( $_tmp );
|
||||
$this->xmlrpc->map_type_to_key[ $this->serialized_key ] = 'base64';
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Get data...
|
||||
//-----------------------------------------
|
||||
|
||||
$return_data = $this->xmlrpc->sendXmlRpc( $url, $method_name, $data );
|
||||
|
||||
if ( count( $this->xmlrpc->errors ) )
|
||||
{
|
||||
$this->errors = $this->xmlrpc->errors;
|
||||
return false;
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Process return data
|
||||
//-----------------------------------------
|
||||
|
||||
$this->apiProcessData( $return_data );
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process returned data
|
||||
*
|
||||
* @access public
|
||||
* @param array Raw array
|
||||
* @return array Cleaned array
|
||||
*/
|
||||
public function apiProcessData( $raw=array() )
|
||||
{
|
||||
//-----------------------------------------
|
||||
// INIT
|
||||
//-----------------------------------------
|
||||
|
||||
$_params = $this->xmlrpc->getParams( $raw );
|
||||
$this->method_name = $this->xmlrpc->getMethodName( $raw );
|
||||
$this->params = array();
|
||||
$this->_raw_in_data = var_export( $raw, TRUE );
|
||||
$this->_raw_out_data = var_export( $_params, TRUE );
|
||||
|
||||
//-----------------------------------------
|
||||
// Debug?
|
||||
//-----------------------------------------
|
||||
|
||||
if ( IPS_XML_RPC_DEBUG_ON )
|
||||
{
|
||||
$this->xmlrpc->addDebug( "API_PROCESS_DECODE: IN PARAMS: " . var_export( $raw, TRUE ) );
|
||||
$this->xmlrpc->addDebug( "API_PROCESS_DECODE: OUT PARAMS: " . var_export( $_params, TRUE ) );
|
||||
}
|
||||
|
||||
//-----------------------------------------
|
||||
// Fix up params
|
||||
//-----------------------------------------
|
||||
|
||||
if ( isset($_params[0]) AND is_array( $_params[0] ) )
|
||||
{
|
||||
foreach( $_params[0] as $k => $v )
|
||||
{
|
||||
if ( $k != '' && $k == $this->serialized_key )
|
||||
{
|
||||
$_tmp = $this->_decodeBase64Array( $v );
|
||||
|
||||
if ( is_array( $_tmp ) and count( $_tmp ) )
|
||||
{
|
||||
$this->params = array_merge( $this->params, $_tmp );
|
||||
}
|
||||
}
|
||||
else if ( $k != '' && $k == $this->cookie_serialized_key )
|
||||
{
|
||||
$_cookies = $this->_decodeBase64Array( $v );
|
||||
|
||||
if ( is_array( $_cookies ) and count( $_cookies ) )
|
||||
{
|
||||
foreach( $_cookies as $cookie_data )
|
||||
{
|
||||
if ( $cookie_data['sticky'] == 1 )
|
||||
{
|
||||
$cookie_data['expires'] = time() + 60*60*24*365;
|
||||
}
|
||||
|
||||
$cookie_data['path'] = $cookie_data['path'] ? $cookie_data['path'] : '/';
|
||||
|
||||
@setcookie( $cookie_data['name'], $cookie_data['value'], $cookie_data['expires'], $cookie_data['path'], $cookie_data['domain'] );
|
||||
|
||||
if ( IPS_XML_RPC_DEBUG_ON )
|
||||
{
|
||||
$this->xmlrpc->addDebug( "API_PROCESS_DECODE: SETTING COOKIE: " . var_export( $cookie_data, TRUE ) );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->params[ $k ] = $v;
|
||||
}
|
||||
}
|
||||
}
|
||||
else if ( is_array( $_params ) )
|
||||
{
|
||||
$i = 0;
|
||||
foreach( $_params as $v )
|
||||
{
|
||||
$this->params['param'.$i] = $v;
|
||||
$i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode array
|
||||
*
|
||||
* @access private
|
||||
* @param array Raw array
|
||||
* @return string Encoded string
|
||||
*/
|
||||
private function _encodeBase64Array( $array )
|
||||
{
|
||||
return base64_encode( serialize( $array ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode array
|
||||
*
|
||||
* @access private
|
||||
* @param string Encoded string
|
||||
* @return array Raw array
|
||||
*/
|
||||
private function _decodeBase64Array( $data )
|
||||
{
|
||||
if ( ! is_array( $data ) )
|
||||
{
|
||||
//return unserialize( base64_decode( $data ) );
|
||||
/**
|
||||
* @see http://community.invisionpower.com/tracker/issue-18676-xml-rpcapiserver-params-not-unserialized/
|
||||
* base64 data types are properly base-64 decoded in the XML-RPC library now, so it is redundant to do so here now
|
||||
*/
|
||||
return unserialize( $data );
|
||||
}
|
||||
else
|
||||
{
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
Reference in new issue
Block a user