Merge pull request #58 in ZP/z-push from bugfix/ZP-649-fix-resolverecipients-for-zarafa to develop

* commit '2f63beb7':
  ZP-718 Re-factor resolving recipients in gal and contacts.
  ZP-716 implement ResolveRecipients options processing.
  ZP-649 Fix ResolveRecipients for Zarafa to work with FreeBusy.

src/index.php

@@ -117,6 +117,7 @@ include_once('lib/syncobjects/syncsendmailsource.php');
 include_once('lib/syncobjects/syncvalidatecert.php');
 include_once('lib/syncobjects/syncresolverecipients.php');
 include_once('lib/syncobjects/syncresolverecipient.php');
+include_once('lib/syncobjects/syncresolverecipientsresponse.php');
 include_once('lib/syncobjects/syncresolverecipientsoptions.php');
 include_once('lib/syncobjects/syncresolverecipientsavailability.php');
 include_once('lib/syncobjects/syncresolverecipientscertificates.php');

src/lib/default/backend.php

@@ -20,7 +20,7 @@
 *
 * Created   :   01.10.2007
 *
-* 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,
@@ -199,7 +199,6 @@ abstract class Backend implements IBackend {
     public function ResolveRecipients($resolveRecipients) {
         $r = new SyncResolveRecipients();
         $r->status = SYNC_RESOLVERECIPSSTATUS_PROTOCOLERROR;
-        $r->recipient = array();
         return $r;
     }
 

src/lib/request/resolverecipients.php

@@ -6,7 +6,7 @@
 *
 * Created   :   15.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -64,7 +64,6 @@ class ResolveRecipients extends RequestProcessor {
 
         $resolveRecipients = self::$backend->ResolveRecipients($resolveRecipients);
 
-
         self::$encoder->startWBXML();
         self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RESOLVERECIPIENTS);
 
@@ -72,32 +71,34 @@ class ResolveRecipients extends RequestProcessor {
             self::$encoder->content($resolveRecipients->status);
             self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_STATUS
 
+            if ($resolveRecipients->status == SYNC_COMMONSTATUS_SUCCESS && !empty($resolveRecipients->response)) {
+                foreach ($resolveRecipients->response as $i => $response) {
+                    self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RESPONSE);
+                        self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_TO);
+                        self::$encoder->content($response->to);
+                        self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_TO
 
-            foreach ($resolveRecipients->to as $i => $to) {
-                self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RESPONSE);
-                    self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_TO);
-                    self::$encoder->content($to);
-                    self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_TO
-
-                    self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_STATUS);
-                    self::$encoder->content($resolveRecipients->status);
-                    self::$encoder->endTag();
-
-                    // do only if recipient is resolved
-                    if ($resolveRecipients->status != SYNC_RESOLVERECIPSSTATUS_RESPONSE_UNRESOLVEDRECIP) {
-                        self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT);
-                        self::$encoder->content(count($resolveRecipients->recipient));
-                        self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT
+                        self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_STATUS);
+                        self::$encoder->content($response->status);
+                        self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_STATUS
 
-                        self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RECIPIENT);
-                        $resolveRecipients->recipient[$i]->Encode(self::$encoder);
-                        self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RECIPIENT
-                    }
+                        // do only if recipient is resolved
+                        if ($response->status != SYNC_RESOLVERECIPSSTATUS_RESPONSE_UNRESOLVEDRECIP && !empty($response->recipient)) {
+                            self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT);
+                            self::$encoder->content(count($response->recipient));
+                            self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT
 
-                self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RESPONSE
+                            foreach ($response->recipient as $recipient) {
+                                self::$encoder->startTag(SYNC_RESOLVERECIPIENTS_RECIPIENT);
+                                $recipient->Encode(self::$encoder);
+                                self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RECIPIENT
+                            }
+                        }
+                    self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RESPONSE
+                }
             }
 
         self::$encoder->endTag(); // SYNC_RESOLVERECIPIENTS_RESOLVERECIPIENTS
         return true;
     }
-}
+}
\ No newline at end of file

src/lib/syncobjects/syncresolverecipient.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -51,7 +51,7 @@ class SyncResolveRecipient extends SyncObject {
     public $emailaddress;
     public $availability;
     public $certificates;
-    public $pictures;
+    public $picture;
 
     public function SyncResolveRecipient() {
         $mapping = array (
@@ -60,14 +60,13 @@ class SyncResolveRecipient extends SyncObject {
             SYNC_RESOLVERECIPIENTS_EMAILADDRESS             => array (  self::STREAMER_VAR      => "emailaddress"),
 
             SYNC_RESOLVERECIPIENTS_AVAILABILITY             => array (  self::STREAMER_VAR      => "availability",
-                                                                        self::STREAMER_TYPE     => "SyncRRAvailability"),
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsAvailability"),
 
             SYNC_RESOLVERECIPIENTS_CERTIFICATES             => array (  self::STREAMER_VAR      => "certificates",
-                                                                        self::STREAMER_TYPE     => "SyncRRCertificates"),
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsCertificates"),
 
-            SYNC_RESOLVERECIPIENTS_PICTURE                  => array (  self::STREAMER_VAR      => "pictures",
-                                                                        self::STREAMER_TYPE     => "SyncRRPicture",
-                                                                        self::STREAMER_ARRAY    => SYNC_RESOLVERECIPIENTS_PICTURE),
+            SYNC_RESOLVERECIPIENTS_PICTURE                  => array (  self::STREAMER_VAR      => "picture",
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsPicture"),
         );
 
         parent::SyncObject($mapping);

src/lib/syncobjects/syncresolverecipients.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -49,8 +49,7 @@ class SyncResolveRecipients extends SyncObject {
     public $to = array();
     public $options;
     public $status;
-    public $recipientCount;
-    public $recipient;
+    public $response;
 
     public function SyncResolveRecipients() {
         $mapping = array (
@@ -59,13 +58,13 @@ class SyncResolveRecipients extends SyncObject {
                                                                         self::STREAMER_PROP     => self::STREAMER_TYPE_NO_CONTAINER),
 
             SYNC_RESOLVERECIPIENTS_OPTIONS                  => array (  self::STREAMER_VAR      => "options",
-                                                                        self::STREAMER_TYPE     => "SyncRROptions"),
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsOptions"),
 
             SYNC_RESOLVERECIPIENTS_STATUS                   => array (  self::STREAMER_VAR      => "status"),
-            SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT           => array (  self::STREAMER_VAR      => "recipientcount"),
 
-            SYNC_RESOLVERECIPIENTS_RECIPIENT                => array (  self::STREAMER_VAR      => "recipient",
-                                                                        self::STREAMER_TYPE     => "SyncResolveRecipient"),
+            SYNC_RESOLVERECIPIENTS_RESPONSE                 => array (  self::STREAMER_VAR      => "response",
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsResponse",
+                                                                        self::STREAMER_ARRAY    => SYNC_RESOLVERECIPIENTS_RESPONSE),
         );
 
         parent::SyncObject($mapping);

src/lib/syncobjects/syncresolverecipientsavailability.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.12.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -45,13 +45,13 @@
 * Consult LICENSE file for details
 ************************************************/
 
-class SyncRRAvailability extends SyncObject {
+class SyncResolveRecipientsAvailability extends SyncObject {
     public $starttime;
     public $endtime;
     public $status;
     public $mergedfreebusy;
 
-    public function SyncRRAvailability() {
+    public function SyncResolveRecipientsAvailability() {
         $mapping = array (
             SYNC_RESOLVERECIPIENTS_STARTTIME                => array (  self::STREAMER_VAR      => "starttime"),
             SYNC_RESOLVERECIPIENTS_ENDTIME                  => array (  self::STREAMER_VAR      => "endtime"),

src/lib/syncobjects/syncresolverecipientscertificates.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -45,14 +45,14 @@
 * Consult LICENSE file for details
 ************************************************/
 
-class SyncRRCertificates extends SyncObject {
+class SyncResolveRecipientsCertificates extends SyncObject {
     public $status;
     public $certificatecount;
     public $recipientcount;
     public $certificate;
     public $minicertificate;
 
-    public function SyncRRCertificates() {
+    public function SyncResolveRecipientsCertificates() {
         $mapping = array (
             SYNC_RESOLVERECIPIENTS_STATUS                   => array (  self::STREAMER_VAR      => "status"),
             SYNC_RESOLVERECIPIENTS_CERTIFICATECOUNT         => array (  self::STREAMER_VAR      => "certificatecount"),

src/lib/syncobjects/syncresolverecipientsoptions.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -45,24 +45,24 @@
 * Consult LICENSE file for details
 ************************************************/
 
-class SyncRROptions extends SyncObject {
+class SyncResolveRecipientsOptions extends SyncObject {
     public $certificateretrieval;
     public $maxcertificates;
     public $maxambiguousrecipients;
     public $availability;
     public $picture;
 
-    public function SyncRROptions() {
+    public function SyncResolveRecipientsOptions() {
         $mapping = array (
             SYNC_RESOLVERECIPIENTS_CERTIFICATERETRIEVAL     => array (  self::STREAMER_VAR      => "certificateretrieval"),
             SYNC_RESOLVERECIPIENTS_MAXCERTIFICATES          => array (  self::STREAMER_VAR      => "maxcertificates"),
             SYNC_RESOLVERECIPIENTS_MAXAMBIGUOUSRECIPIENTS   => array (  self::STREAMER_VAR      => "maxambiguousrecipients"),
 
             SYNC_RESOLVERECIPIENTS_AVAILABILITY             => array (  self::STREAMER_VAR      => "availability",
-                                                                        self::STREAMER_TYPE     => "SyncRRAvailability"),
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsAvailability"),
 
             SYNC_RESOLVERECIPIENTS_PICTURE                  => array (  self::STREAMER_VAR      => "picture",
-                                                                        self::STREAMER_TYPE     => "SyncRRPicture"),
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipientsPicture"),
         );
 
         parent::SyncObject($mapping);

src/lib/syncobjects/syncresolverecipientspicture.php

@@ -10,7 +10,7 @@
 *
 * Created   :   28.10.2012
 *
-* Copyright 2007 - 2013 Zarafa Deutschland GmbH
+* Copyright 2007 - 2013, 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,
@@ -45,13 +45,13 @@
 * Consult LICENSE file for details
 ************************************************/
 
-class SyncRRPicture extends SyncObject {
+class SyncResolveRecipientsPicture extends SyncObject {
     public $maxsize;
     public $maxpictures;
     public $status;
     public $data;
 
-    public function SyncRRPicture() {
+    public function SyncResolveRecipientsPicture() {
         $mapping = array (
             SYNC_RESOLVERECIPIENTS_MAXSIZE                  => array (  self::STREAMER_VAR      => "maxsize"),
             SYNC_RESOLVERECIPIENTS_MAXPICTURES              => array (  self::STREAMER_VAR      => "maxpictures"),

src/lib/syncobjects/syncresolverecipientsresponse.php

+<?php
+/**********************************************************
+* File      :   syncresolverecipientsresponse.php
+* Project   :   Z-Push
+* Descr     :   WBXML appointment entities that can be
+*               parsed directly (as a stream) from WBXML.
+*               It is automatically decoded
+*               according to $mapping,
+*               and the Sync WBXML mappings
+*
+* Created   :   07.09.2015
+*
+* Copyright 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,
+* as published by the Free Software Foundation with the following additional
+* term according to sec. 7:
+*
+* According to sec. 7 of the GNU Affero General Public License, version 3,
+* the terms of the AGPL are supplemented with the following terms:
+*
+* "Zarafa" is a registered trademark of Zarafa B.V.
+* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
+* The licensing of the Program under the AGPL does not imply a trademark license.
+* Therefore any rights, title and interest in our trademarks remain entirely with us.
+*
+* However, if you propagate an unmodified version of the Program you are
+* allowed to use the term "Z-Push" to indicate that you distribute the Program.
+* Furthermore you may use our trademarks where it is necessary to indicate
+* the intended purpose of a product or service provided you use it in accordance
+* with honest practices in industrial or commercial matters.
+* If you want to propagate modified versions of the Program under the name "Z-Push",
+* you may only do so if you have a written permission by Zarafa Deutschland GmbH
+* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* Consult LICENSE file for details
+************************************************/
+
+class SyncResolveRecipientsResponse extends SyncObject {
+    public $to;
+    public $status;
+    public $recipientcount;
+    public $recipient;
+
+    public function SyncResolveRecipientsResponse() {
+        $mapping = array (
+            SYNC_RESOLVERECIPIENTS_TO                       => array (  self::STREAMER_VAR      => "to"),
+
+            SYNC_RESOLVERECIPIENTS_STATUS                   => array (  self::STREAMER_VAR      => "status"),
+
+            SYNC_RESOLVERECIPIENTS_RECIPIENTCOUNT           => array (  self::STREAMER_VAR      => "recipientcount"),
+
+            SYNC_RESOLVERECIPIENTS_RECIPIENT                => array (  self::STREAMER_VAR      => "recipient",
+                                                                        self::STREAMER_TYPE     => "SyncResolveRecipient",
+                                                                        self::STREAMER_ARRAY    => SYNC_RESOLVERECIPIENTS_RECIPIENT),
+        );
+
+        parent::SyncObject($mapping);
+    }
+}
\ No newline at end of file