/usr/share/php/Horde/SyncMl/Command/Alert.php is in php-horde-syncml 2.0.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | <?php
/**
* The Horde_SyncMl_Command_Alert class provides a SyncML implementation of the
* Alert command as defined in SyncML Representation Protocol, version 1.1,
* section 5.5.2.
*
* The Alert command is used for sending custom content information to the
* recipient. The command provides a mechanism for communicating content
* information, such as state information or notifications to an application on
* the recipient device.
*
* Copyright 2003-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Anthony Mills <amills@pyramid6.com>
* @author Karsten Fourmont <karsten@horde.org>
* @author Jan Schneider <jan@horde.org>
* @package SyncMl
*/
class Horde_SyncMl_Command_Alert extends Horde_SyncMl_Command
{
/**
* Name of the command.
*
* @var string
*/
protected $_cmdName = 'Alert';
/**
* The alert type. Should be one of the Horde_SyncMl::ALERT_* constants.
*
* @var integer
*/
protected $_alert;
/**
* Source database of the Alert command.
*
* @var string
*/
protected $_sourceLocURI;
/**
* Target database of the Alert command.
*
* @var string
*/
protected $_targetLocURI;
/**
* The current time this synchronization happens, from the <Meta><Next>
* element.
*
* @var string
*/
protected $_metaAnchorNext;
/**
* The last time when synchronization happened, from the <Meta><Last>
* element.
*
* @var integer
*/
protected $_metaAnchorLast;
/**
* End element handler for the XML parser, delegated from
* Horde_SyncMl_ContentHandler::endElement().
*
* @param string $uri The namespace URI of the element.
* @param string $element The element tag name.
*/
public function endElement($uri, $element)
{
switch (count($this->_stack)) {
case 2:
if ($element == 'Data') {
$this->_alert = intval(trim($this->_chars));
}
break;
case 4:
if ($element == 'LocURI') {
switch ($this->_stack[2]) {
case 'Source':
$this->_sourceLocURI = trim($this->_chars);
break;
case 'Target':
$this->_targetLocURI = trim($this->_chars);
break;
}
}
break;
case 5:
switch ($element) {
case 'Next':
$this->_metaAnchorNext = trim($this->_chars);
break;
case 'Last':
$this->_metaAnchorLast = trim($this->_chars);
break;
}
break;
}
parent::endElement($uri, $element);
}
/**
* Implements the actual business logic of the Alert command.
*/
public function handleCommand($debug = false)
{
$state = $GLOBALS['backend']->state;
// Handle unauthenticated first.
if (!$state->authenticated) {
$this->_outputHandler->outputStatus($this->_cmdID, $this->_cmdName,
Horde_SyncMl::RESPONSE_INVALID_CREDENTIALS);
return;
}
// Handle NEXT_MESSAGE Alert by sending either pending elements or
// OK status response.
if ($this->_alert == Horde_SyncMl::ALERT_NEXT_MESSAGE) {
if ($sync = &$state->getSync($this->_targetLocURI)) {
if ($sync->hasPendingElements()) {
$sync->createSyncOutput($this->_outputHandler);
return;
}
}
$this->_outputHandler->outputStatus($this->_cmdID, $this->_cmdName,
Horde_SyncMl::RESPONSE_OK);
return;
}
$database = $this->_targetLocURI;
if (!$GLOBALS['backend']->isValidDatabaseURI($database)) {
$this->_outputHandler->outputStatus($this->_cmdID, $this->_cmdName,
Horde_SyncMl::RESPONSE_NOT_FOUND);
return;
}
if ($database == 'configuration') {
$this->_outputHandler->outputStatus($this->_cmdID, $this->_cmdName,
Horde_SyncMl::RESPONSE_OK);
}
$clientAnchorNext = $this->_metaAnchorNext;
if (!$debug &&
($this->_alert == Horde_SyncMl::ALERT_TWO_WAY ||
$this->_alert == Horde_SyncMl::ALERT_ONE_WAY_FROM_CLIENT ||
$this->_alert == Horde_SyncMl::ALERT_ONE_WAY_FROM_SERVER)) {
// Check if we have information about previous sync.
$r = $GLOBALS['backend']->readSyncAnchors($this->_targetLocURI);
if (is_array($r)) {
// Info about previous successful sync sessions found.
list($clientlast, $serverAnchorLast) = $r;
$GLOBALS['backend']->logMessage(
'Previous sync found for database ' . $database
. '; client timestamp: ' . $clientlast, 'DEBUG');
// Check if anchor sent from client matches our own stored
// data.
if ($clientlast == $this->_metaAnchorLast) {
// Last sync anchors matche, TwoWaySync will do.
$anchormatch = true;
$GLOBALS['backend']->logMessage(
'Anchor timestamps match, TwoWaySync possible. Syncing data since '
. date('Y-m-d H:i:s', $serverAnchorLast), 'DEBUG');
} else {
// Server and client have different anchors, enforce
// SlowSync/RefreshSync
$GLOBALS['backend']->logMessage(
'Client requested sync with anchor timestamp '
. $this->_metaAnchorLast
. ' but server has recorded timestamp '
. $clientlast . '. Enforcing SlowSync', 'INFO');
$anchormatch = false;
$clientlast = 0;
}
} else {
// No info about previous sync, use SlowSync or RefreshSync.
$GLOBALS['backend']->logMessage(
'No info about previous syncs found for device ' .
$state->sourceURI . ' and database ' . $database, 'DEBUG');
$clientlast = 0;
$serverAnchorLast = 0;
$anchormatch = false;
}
} else {
// SlowSync requested, no anchor check required.
$anchormatch = true;
}
// Determine sync type and status response code.
switch ($this->_alert) {
case Horde_SyncMl::ALERT_TWO_WAY:
if ($anchormatch) {
$synctype = Horde_SyncMl::ALERT_TWO_WAY;
$response = Horde_SyncMl::RESPONSE_OK;
} else {
$synctype = Horde_SyncMl::ALERT_SLOW_SYNC;
$response = Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
}
break;
case Horde_SyncMl::ALERT_SLOW_SYNC:
$synctype = Horde_SyncMl::ALERT_SLOW_SYNC;
$response = $anchormatch ? Horde_SyncMl::RESPONSE_OK : Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
break;
case Horde_SyncMl::ALERT_ONE_WAY_FROM_CLIENT:
if ($anchormatch) {
$synctype = Horde_SyncMl::ALERT_ONE_WAY_FROM_CLIENT;
$response = Horde_SyncMl::RESPONSE_OK;
} else {
$synctype = Horde_SyncMl::ALERT_REFRESH_FROM_CLIENT;
$response = Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
}
break;
case Horde_SyncMl::ALERT_REFRESH_FROM_CLIENT:
$synctype = Horde_SyncMl::ALERT_REFRESH_FROM_CLIENT;
$response = $anchormatch ? Horde_SyncMl::RESPONSE_OK : Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
break;
case Horde_SyncMl::ALERT_ONE_WAY_FROM_SERVER:
if ($anchormatch) {
$synctype = Horde_SyncMl::ALERT_ONE_WAY_FROM_SERVER;
$response = Horde_SyncMl::RESPONSE_OK;
} else {
$synctype = Horde_SyncMl::ALERT_REFRESH_FROM_SERVER;
$response = Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
}
break;
case Horde_SyncMl::ALERT_REFRESH_FROM_SERVER:
$synctype = Horde_SyncMl::ALERT_REFRESH_FROM_SERVER;
$response = $anchormatch ? Horde_SyncMl::RESPONSE_OK : Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
break;
case Horde_SyncMl::ALERT_RESUME:
// @TODO: Suspend and Resume is not supported yet
$synctype = Horde_SyncMl::ALERT_SLOW_SYNC;
$response = Horde_SyncMl::RESPONSE_REFRESH_REQUIRED;
break;
default:
$GLOBALS['backend']->logMessage(
'Unknown sync type ' . $this->_alert, 'ERR');
break;
}
// Now set interval to retrieve server changes from, defined by
// ServerAnchor [Last,Next]
if ($synctype != Horde_SyncMl::ALERT_TWO_WAY &&
$synctype != Horde_SyncMl::ALERT_ONE_WAY_FROM_CLIENT &&
$synctype != Horde_SyncMl::ALERT_ONE_WAY_FROM_SERVER) {
$serverAnchorLast = 0;
// Erase existing map:
if (!$debug &&
(($anchormatch &&
Horde_SyncMl::CONFIG_DELETE_MAP_ON_REQUESTED_SLOWSYNC) ||
(!$anchormatch &&
Horde_SyncMl::CONFIG_DELETE_MAP_ON_ANCHOR_MISMATCH_SLOWSYNC))) {
$GLOBALS['backend']->eraseMap($this->_targetLocURI);
}
}
$serverAnchorNext = $debug ? time() : $GLOBALS['backend']->getCurrentTimeStamp();
// Now create the actual Horde_SyncMl_Sync object, if it doesn't exist yet.
$sync = &$state->getSync($this->_targetLocURI);
if (!$sync) {
$GLOBALS['backend']->logMessage(
'Creating Horde_SyncMl_Sync object for database '
. $this->_targetLocURI . '; sync type ' . $synctype, 'DEBUG');
$sync = new Horde_SyncMl_Sync($synctype,
$this->_targetLocURI,
$this->_sourceLocURI,
(int)$serverAnchorLast, (int)$serverAnchorNext,
$clientAnchorNext);
$state->setSync($this->_targetLocURI, $sync);
}
$this->_outputHandler->outputStatus($this->_cmdID, $this->_cmdName,
$response,
$this->_targetLocURI,
$this->_sourceLocURI,
$this->_metaAnchorNext,
$this->_metaAnchorLast);
$this->_outputHandler->outputAlert($synctype,
$sync->getClientLocURI(),
$sync->getServerLocURI(),
$sync->getServerAnchorLast(),
$sync->getServerAnchorNext());
}
}
|