ZP-770 Expose additional user folder API to ZPushAdmin class. Implement

API in device webservice. Fixed typos.

Released under the Affero GNU General Public License (AGPL) version 3.

src/lib/webservice/webservicedevice.php

@@ -8,7 +8,7 @@
 *
 * Created   :   23.12.2011
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2015 Zarafa Deutschland GmbH
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
@@ -146,13 +146,111 @@ class WebserviceDevice {
         $deviceId = preg_replace("/[^A-Za-z0-9]/", "", $deviceId);
         $folderId = preg_replace("/[^A-Za-z0-9]/", "", $folderId);
         ZLog::Write(LOGLEVEL_INFO, sprintf("WebserviceDevice::ResyncFolder('%s','%s'): mark folder of a device of user '%s' for resynchronization", $deviceId, $folderId, Request::GetGETUser()));
-    
+
         if (! ZPushAdmin::ResyncFolder(Request::GetGETUser(), $deviceId, $folderId)) {
             ZPush::GetTopCollector()->AnnounceInformation(ZLog::GetLastMessage(LOGLEVEL_ERROR), true);
             throw new SoapFault("ERROR", ZLog::GetLastMessage(LOGLEVEL_ERROR));
         }
-    
+
         ZPush::GetTopCollector()->AnnounceInformation(sprintf("Folder resync requested - device id '%s', folder id '%s", $deviceId, $folderId), true);
         return true;
     }
+
+    /**
+     * Returns a list of all additional folders of the given device and the Request::GetGETUser().
+     *
+     * @param string    $devid          device id that should be listed.
+     *
+     * @access public
+     * @return array
+     */
+    public function AdditionalFolderList($deviceId) {
+        $user = Request::GetGETUser();
+        $deviceId = preg_replace("/[^A-Za-z0-9]/", "", $deviceId);
+        $folders = ZPushAdmin::AdditionalFolderList($user, $deviceId);
+        ZLog::Write(LOGLEVEL_INFO, sprintf("WebserviceDevice::AdditionalFolderList(): found %d folders for device '%s' of user '%s'", count($folders), $deviceId, $user));
+        ZPush::GetTopCollector()->AnnounceInformation(sprintf("Retrieved details of %d folders", count($folders)), true);
+
+        return $folders;
+    }
+
+    /**
+     * Adds an additional folder to the given device and the Request::GetGETUser().
+     *
+     * @param string    $devid          device id the folder should be added to.
+     * @param string    $add_store      the store where this folder is located, e.g. "SYSTEM" (for public folder) or an username/email address.
+     * @param string    $add_folderid   the folder id of the additional folder.
+     * @param string    $add_name       the name of the addtional folder (has to be unique for all folders on the device).
+     * @param string    $add_type       AS foldertype of SYNC_FOLDER_TYPE_USER_*
+     *
+     * @access public
+     * @return boolean
+     */
+    public function AdditionalFolderAdd($deviceId, $add_store, $add_folderid, $add_name, $add_type) {
+        $user = Request::GetGETUser();
+        $deviceId = preg_replace("/[^A-Za-z0-9]/", "", $deviceId);
+        $add_folderid = preg_replace("/[^A-Za-z0-9]/", "", $add_folderid);
+        $add_type = preg_replace("/[^0-9]/", "", $add_type);
+
+        $status = ZPushAdmin::AdditionalFolderAdd($user, $deviceId, $add_store, $add_folderid, $add_name, $add_type);
+        if (!$status) {
+            ZPush::GetTopCollector()->AnnounceInformation(ZLog::GetLastMessage(LOGLEVEL_ERROR), true);
+            throw new SoapFault("ERROR", ZLog::GetLastMessage(LOGLEVEL_ERROR));
+        }
+        ZLog::Write(LOGLEVEL_INFO, sprintf("WebserviceDevice::AdditionalFolderAdd(): added folder for device '%s' of user '%s': %s", $deviceId, $user, Utils::PrintAsString($status)));
+        ZPush::GetTopCollector()->AnnounceInformation("Added additional folder", true);
+
+        return $status;
+    }
+
+    /**
+     * Updates the name of an additional folder to the given device and the Request::GetGETUser().
+     *
+     * @param string    $devid          device id of where the folder should be updated.
+     * @param string    $add_folderid   the folder id of the additional folder.
+     * @param string    $add_name       the name of the addtional folder (has to be unique for all folders on the device).
+     *
+     * @access public
+     * @return boolean
+     */
+    public function AdditionalFolderEdit($deviceId, $add_folderid, $add_name) {
+        $user = Request::GetGETUser();
+        $deviceId = preg_replace("/[^A-Za-z0-9]/", "", $deviceId);
+        $add_folderid = preg_replace("/[^A-Za-z0-9]/", "", $add_folderid);
+
+        $status = ZPushAdmin::AdditionalFolderEdit($user, $deviceId, $add_folderid, $add_name);
+        if (!$status) {
+            ZPush::GetTopCollector()->AnnounceInformation(ZLog::GetLastMessage(LOGLEVEL_ERROR), true);
+            throw new SoapFault("ERROR", ZLog::GetLastMessage(LOGLEVEL_ERROR));
+        }
+        ZLog::Write(LOGLEVEL_INFO, sprintf("WebserviceDevice::AdditionalFolderEdit(): added folder for device '%s' of user '%s': %s", $deviceId, $user, Utils::PrintAsString($status)));
+        ZPush::GetTopCollector()->AnnounceInformation("Edited additional folder", true);
+
+        return $status;
+    }
+
+    /**
+     * Removes an additional folder from the given device and the Request::GetGETUser().
+     *
+     * @param string    $devid          device id of where the folder should be removed.
+     * @param string    $add_folderid   the folder id of the additional folder.
+     *
+     * @access public
+     * @return boolean
+     */
+    public function AdditionalFolderRemove($deviceId, $add_folderid) {
+        $user = Request::GetGETUser();
+        $deviceId = preg_replace("/[^A-Za-z0-9]/", "", $deviceId);
+        $add_folderid = preg_replace("/[^A-Za-z0-9]/", "", $add_folderid);
+
+        $status = ZPushAdmin::AdditionalFolderRemove($user, $deviceId, $add_folderid);
+        if (!$status) {
+            ZPush::GetTopCollector()->AnnounceInformation(ZLog::GetLastMessage(LOGLEVEL_ERROR), true);
+            throw new SoapFault("ERROR", ZLog::GetLastMessage(LOGLEVEL_ERROR));
+        }
+        ZLog::Write(LOGLEVEL_INFO, sprintf("WebserviceDevice::AdditionalFolderRemove(): removed folder for device '%s' of user '%s': %s", $deviceId, $user, Utils::PrintAsString($status)));
+        ZPush::GetTopCollector()->AnnounceInformation("Removed additional folder", true);
+
+        return $status;
+    }
 }