add xmlrpc server support - TOTALLY NOT TESTED YET!!!

git-svn-id: https://svn.code.sf.net/p/postfixadmin/code/trunk@579 a1433add-5e2c-0410-b055-b7f2511e0802

model/AliasHandler.php

@@ -7,12 +7,15 @@ class AliasHandler {
 
     private $username = null;
 
+    /**
+     * @param string $username
+     */
     public function __construct($username) {
         $this->username = $username;
-
     }
+
     /**
-     * @return list of email addresses the user's mail is forwarded to.
+     * @return array - list of email addresses the user's mail is forwarded to.
      * (may be an empty list, especially if $CONF['alias_control'] is turned off...
      * @param boolean - by default we don't return special addresses (e.g. vacation and mailbox alias); pass in true here if you wish to.
      */

model/VacationHandler.php

@@ -79,7 +79,6 @@ class VacationHandler {
         return false;
     }
     /**
-     * @param string $username
      * @param string $subject
      * @param string $body
      */

xmlrpc.php

@@ -0,0 +1,146 @@
+<?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('http://server/xmlrpc.php');
+ *
+ * $http_client = $xmlrpc->getHttpClient();
+ * $http_client->setCookieJar();
+ *
+ * $login_object = $xmlrpc->getProxy('login');
+ * $success = $login_object->login($username, $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->isEnabled()) {
+ *     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.
+ */
+
+require_once('Zend/XmlRpc/Server.php');
+$server = new Zend_XmlRpc_Server();
+session_start();
+
+function login($username, $password) {
+    if(UserHandler::login($username, $password)) {
+        session_regenerate_id();
+        $_SESSION['authenticated'] = true;
+        $_SESSION['username'] = $username;
+    }
+}
+
+if(!isset($_SESSION['authenticated'])) {
+    $server->addFunction('login', 'login');
+}
+else {
+    $server->addClass('user', 'UserProxy');
+    $server->addClass('vacation', 'VacationProxy');
+    $server->addClass('alias', 'AliasProxy');
+}
+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($username, $old_password, $new_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();
+    }
+}