File: xmlrpc.php

package info (click to toggle)
postfixadmin 2.3.5-2+deb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,200 kB
  • sloc: php: 25,767; xml: 14,485; perl: 964; sh: 664; python: 169; makefile: 84
file content (168 lines) | stat: -rw-r--r-- 4,878 bytes parent folder | download | duplicates (2)
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?php
/**
 * Requires the Zend framework is installed and in the include path.
 *
 * Usage example:
 * require_once('Zend/XmlRpc/Client.php');
 * $xmlrpc = new Zend_XmlRpc_Client('https://server/xmlrpc.php');
 *
 * $http_client = $xmlrpc->getHttpClient();
 * $http_client->setCookieJar();
 *
 * $login_object = $xmlrpc->getProxy('login');
 * $success = $login_object->login($email_address, $password);
 *
 * if($success) {
 *     echo "We're logged in";
 * }
 * else {
 *     die("Auth failed");
 * }
 * $user = $xmlrpc->getProxy('user');
 * $alias = $xmlrpc->getProxy('alias');
 * $vacation = $xmlrpc->getProxy('vacation');
 *
 * if($vacation->checkVacation()) {
 *     echo "Vacation turned on for user";
 * }
 *
 * Note, the requirement that your XmlRpc client provides cookies with each request.
 * If it does not do this, then your authentication details will not persist across requests, and 
 * this XMLRPC interface will not work.
 */
require_once(dirname(__FILE__) . '/common.php');

if($CONF['xmlrpc_enabled'] == false) {
    die("xmlrpc support disabled");
}
require_once('Zend/XmlRpc/Server.php');
$server = new Zend_XmlRpc_Server();

/**
 * @param string $username
 * @param string $password
 * @return boolean true on success, else false.
 */
function login($username, $password) {
    if(UserHandler::login($username, $password)) {
        session_regenerate_id();
        $_SESSION['authenticated'] = true;
        $_SESSION['username'] = $username;
        return true;
    }
    return false;
}

if(!isset($_SESSION['authenticated'])) {
    $server->addFunction('login', 'login');
}
else {
    $server->setClass('UserProxy', 'user');
    $server->setClass('VacationProxy', 'vacation');
    $server->setClass('AliasProxy', 'alias');
}
echo $server->handle();


class UserProxy {

    /**
     * @param string $old_password
     * @param string $new_password
     * @return boolean true on success
     */
    public function changePassword($old_password, $new_password) {
        $uh = new UserHandler($_SESSION['username']);
        return $uh->change_pass($old_password, $new_password);
    }

   /**
     * @param string $username
     * @param string $password
     * @return boolean true if successful.
     */
    public function login($username, $password) {
        $uh = new UserHandler($_SESSION['username']);
        return $uh->login($username, $password);
    }
}

class VacationProxy {
    /**
     * @return boolean true if the vacation is removed successfully. Else false.
     */
    public function remove() {
        $vh = new VacationHandler($_SESSION['username']);
        return $vh->remove();
    }

    /**
     * @return boolean true if vacation stuff is enabled in this instance of postfixadmin
     * and the user has the ability to make changes to it.
     */
    public function isVacationSupported() {
        $vh = new VacationHandler($_SESSION['username']);
        return $vh->vacation_supported();
    }

    /**
     * @return boolean true if the user has an active vacation record etc.
     */
    public function checkVacation() {
        $vh = new VacationHandler($_SESSION['username']);
        return $vh->check_vacation();
    }

    /**
     * @return struct|boolean - either array of vacation details or boolean false if the user has none.
     */
    public function getDetails() {
        $vh = new VacationHandler($_SESSION['username']);
        return $vh->get_details();
    }

    /**
     * @param string $subject
     * @param string $body
     * @return boolean true on success.
     */
    public function setAway($subject, $body) {
        $vh = new VacationHandler($_SESSION['username']);
        return $vh->set_away($subject, $body);
    }


}
class AliasProxy {
    /**
     * @return array - array of aliases this user has. Array may be empty.
     */
    public function get() {
        $ah = new AliasHandler($_SESSION['username']);
        /* I see no point in returning special addresses to the user. */
        return $ah->get(false);
    }

    /**
     * @param array of email addresses (Strings)
     * @param string flag to set ('forward_and_store' or 'remote_only')
     * @return boolean true
     */
    public function update($addresses, $flags) {
        $ah = new AliasHandler($_SESSION['username']);
        /**
         * if the user is on vacation, they should use VacationProxy stuff to remove it 
         * and we'll never return the vacation address from here anyway
         */
        return $ah->update($addresses, $flags, true);
    }

    /**
     * @return boolean true if the user has 'store_and_forward' set.
     * (i.e. their email address is also in the alias table). IF it returns false, then it's 'remote_only'
     */
    public function hasStoreAndForward() {
        $ah = new AliasHandler($_SESSION['username']);
        return $ah->hasStoreAndForward();
    }
}