summaryrefslogtreecommitdiff
path: root/docs/XMLRPC/xmlrpc.php
blob: 90e7a09c3760113744c506e1642dbd86a0660451 (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
<?php
/* XMLRPC Functions
 *
 * (C) 2003-2014 Anope Team
 * Contact us at team@anope.org
 *
 */

class AnopeXMLRPC
{
    private $Host;

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

    /** 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.
     */
    public function RunXMLRPC($name, $params)
    {
        $xmlquery = xmlrpc_encode_request($name, $params);
        $context = stream_context_create(array("http" => array(
            "method" => "POST",
            "header" => "Content-Type: text/xml",
            "content" => $xmlquery)));

        $inbuf = file_get_contents($this->Host, false, $context);
        $response = xmlrpc_decode($inbuf);

        if (isset($response)) {
            return $response;
        }

        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'
     */
    public 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
     */
    public 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
     */
    public 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
     */
    public function DoChannel($Channel)
    {
        return $this->RunXMLRPC("channel", array($Channel));
    }

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

$anopexmlrpc = new AnopeXMLRPC("http://127.0.0.1:8080/xmlrpc");