<?php
/***********************************************
* File : exportchangesdiff.php
* Project : Z-Push
* Descr : IExportChanges implementation using
* the differential engine
*
* Created : 02.01.2012
*
* Copyright 2007 - 2013 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 ExportChangesDiff extends DiffState implements IExportChanges{
private $importer;
private $folderid;
private $changes;
private $step;
/**
* Constructor
*
* @param object $backend
* @param string $folderid
*
* @access public
* @throws StatusException
*/
public function ExportChangesDiff($backend, $folderid) {
$this->backend = $backend;
$this->folderid = $folderid;
}
/**
* Sets the importer the exporter will sent it's changes to
* and initializes the Exporter
*
* @param object &$importer Implementation of IImportChanges
*
* @access public
* @return boolean
* @throws StatusException
*/
public function InitializeExporter(&$importer) {
$this->changes = array();
$this->step = 0;
$this->importer = $importer;
if($this->folderid) {
// Get the changes since the last sync
if(!isset($this->syncstate) || !$this->syncstate)
$this->syncstate = array();
ZLog::Write(LOGLEVEL_DEBUG,sprintf("ExportChangesDiff->InitializeExporter(): Initializing message diff engine. '%d' messages in state", count($this->syncstate)));
//do nothing if it is a dummy folder
if ($this->folderid != SYNC_FOLDER_TYPE_DUMMY) {
// Get our lists - syncstate (old) and msglist (new)
$msglist = $this->backend->GetMessageList($this->folderid, $this->cutoffdate);
// if the folder was deleted, no information is available anymore. A hierarchysync should be executed
if($msglist === false)
throw new StatusException("ExportChangesDiff->InitializeExporter(): Error, no message list available from the backend", SYNC_STATUS_FOLDERHIERARCHYCHANGED, null, LOGLEVEL_INFO);
$this->changes = $this->getDiffTo($msglist);
}
}
else {
ZLog::Write(LOGLEVEL_DEBUG, "Initializing folder diff engine");
ZLog::Write(LOGLEVEL_DEBUG, "ExportChangesDiff->InitializeExporter(): Initializing folder diff engine");
$folderlist = $this->backend->GetFolderList();
if($folderlist === false)
throw new StatusException("ExportChangesDiff->InitializeExporter(): error, no folders available from the backend", SYNC_FSSTATUS_CODEUNKNOWN, null, LOGLEVEL_WARN);
if(!isset($this->syncstate) || !$this->syncstate)
$this->syncstate = array();
$this->changes = $this->getDiffTo($folderlist);
}
ZLog::Write(LOGLEVEL_INFO, sprintf("ExportChangesDiff->InitializeExporter(): Found %d changes", count($this->changes)));
}
/**
* Returns the amount of changes to be exported
*
* @access public
* @return int
*/
public function GetChangeCount() {
return count($this->changes);
}
/**
* Synchronizes a change
*
* @access public
* @return array
*/
public function Synchronize() {
$progress = array();
// Get one of our stored changes and send it to the importer, store the new state if
// it succeeds
if($this->folderid == false) {
if($this->step < count($this->changes)) {
$change = $this->changes[$this->step];
switch($change["type"]) {
case "change":
$folder = $this->backend->GetFolder($change["id"]);
$stat = $this->backend->StatFolder($change["id"]);
if(!$folder)
return;
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportFolderChange($folder))
$this->updateState("change", $stat);
break;
case "delete":
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportFolderDeletion($change["id"]))
$this->updateState("delete", $change);
break;
}
$this->step++;
$progress = array();
$progress["steps"] = count($this->changes);
$progress["progress"] = $this->step;
return $progress;
} else {
return false;
}
}
else {
if($this->step < count($this->changes)) {
$change = $this->changes[$this->step];
switch($change["type"]) {
case "change":
// Note: because 'parseMessage' and 'statMessage' are two seperate
// calls, we have a chance that the message has changed between both
// calls. This may cause our algorithm to 'double see' changes.
$stat = $this->backend->StatMessage($this->folderid, $change["id"]);
$message = $this->backend->GetMessage($this->folderid, $change["id"], $this->contentparameters);
// copy the flag to the message
$message->flags = (isset($change["flags"])) ? $change["flags"] : 0;
if($stat && $message) {
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportMessageChange($change["id"], $message) == true)
$this->updateState("change", $stat);
}
break;
case "delete":
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportMessageDeletion($change["id"]) == true)
$this->updateState("delete", $change);
break;
case "flags":
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportMessageReadFlag($change["id"], $change["flags"]) == true)
$this->updateState("flags", $change);
break;
case "move":
if($this->flags & BACKEND_DISCARD_DATA || $this->importer->ImportMessageMove($change["id"], $change["parent"]) == true)
$this->updateState("move", $change);
break;
}
$this->step++;
$progress = array();
$progress["steps"] = count($this->changes);
$progress["progress"] = $this->step;
return $progress;
} else {
return false;
}
}
}
}