summaryrefslogtreecommitdiff
path: root/docs/XMLRPC/xmlrpc.php
blob: cffc23a0cd3c6ba61bcdb1a3f34cd43d56725d57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?php
/* XMLRPC Functions
 *
 * (C) 2003-2011 Anope Team
 * Contact us at team@anope.org
 *
 */

class AnopeXMLRPC
{
	private $Host, $Bind, $Port;

	private $Socket;

	function __construct($Host, $Port, $Bind = NULL)
	{
		$this->Host = $Host;
		$this->Port = $Port;
		$this->Bind = $Bind;

		$this->Socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
		if ($Bind && socket_bind($this->Socket, $this->Bind) == false)
			$his->Socket = false;
		if (socket_connect($this->Socket, $this->Host, $this->Port) == false)
			$this->Socket = false;
	}

	function __destruct()
	{
		@socket_close($this->Socket);
	}

	/** Run an XMLRPC command. Name should be a query name and params an array of parameters, eg:
	 * $this->RunXMLRPC("checkAuthentication", array("adam", "qwerty"));
	 * If successful returns back an array of useful information.
	 *
	 * Note that $params["id"] is reserved for query ID, you may set it to something if you wish.
	 * If you do, the same ID will be passed back with the reply from Anope.
	 */
	function RunXMLRPC($name, $params)
	{
		$xmlquery = xmlrpc_encode_request($name, $params);
		socket_write($this->Socket, $xmlquery);

		$inbuf = socket_read($this->Socket, 4096);
		$inbuf = substr($inbuf, strpos($inbuf, "\r\n\r\n") + 4);
		$response = xmlrpc_decode($inbuf);

		if (isset($response[0]))
			return $response[0];
		return NULL;
	}

	/** Do Command on Service as User, eg:
	 * $anope->DoCommand("ChanServ", "Adam", "REGISTER #adam");
	 * Returns an array of information regarding the command execution, if
	 * If 'online' is set to yes, then the reply to the command was sent to the user on IRC.
	 * If 'online' is set to no, then the reply to the command is in the array member 'return'
	 */
	function DoCommand($Service, $User, $Command)
	{
		return $this->RunXMLRPC("command", array($Service, $User, $Command));
	}

	/** Check an account/nick name and password to see if they are valid
	 * Returns the account display name if valid
	 */
	function CheckAuthentication($Account, $Pass)
	{
		$ret = $this->RunXMLRPC("checkAuthentication", array($Account, $Pass));

		if ($ret && $ret["result"] == "Success")
			return $ret["account"];
		return NULL;
	}

	/* Returns an array of misc stats regarding Anope
	 */
	function DoStats()
	{
		return $this->RunXMLRPC("stats", NULL);
	}

	/* Look up data for a channel
	 * Returns an array containing channel information, or an array of size one
	 * (just containing the name) if the channel does not exist
	 */
	function DoChannel($Channel)
	{
		return $this->RunXMLRPC("channel", NULL);
	}

	/* Like DoChannel(), but different.
	 */
	function DoUser($User)
	{
		return $this->RunXMLRPC("user", array($User));
	}
}

?>