Improve SyncML session handling; code cleunups

This commit is contained in:
Jörg Lehrke 2010-01-13 08:47:00 +00:00
parent 3ce3cde916
commit 59affe07ce
2 changed files with 46 additions and 51 deletions

View File

@ -146,7 +146,7 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
var $_maxMsgSize; var $_maxMsgSize;
function getStateFromSession($sourceURI, $locName, $sessionID) function &getStateFromSession($sourceURI, $locName, $sessionID)
{ {
// Remove any existing session since we'll be contructing a // Remove any existing session since we'll be contructing a
// custom session id. // custom session id.
@ -185,7 +185,7 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
} }
if($_SESSION['SyncML.state']->isAuthorized()) { if ($_SESSION['SyncML.state']->isAuthorized()) {
Horde::logMessage('SyncML['. session_id() .']: session is authorized', Horde::logMessage('SyncML['. session_id() .']: session is authorized',
__FILE__, __LINE__, PEAR_LOG_DEBUG); __FILE__, __LINE__, PEAR_LOG_DEBUG);
} }
@ -214,29 +214,22 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
{ {
switch ($this->_xmlStack) { switch ($this->_xmlStack) {
case 2: case 2:
/*
$str = 'localname=' . $this->_locName;
$str .= ' version=' . $this->_version;
$str .= ' msgid=' . $this->_msgID;
$str .= ' source=' . $this->_sourceURI;
$str .= ' target=' . $this->_targetURI;
$str .= ' sessionID=' . $this->_sessionID;
*/
// </SyncHdr></SyncML> // </SyncHdr></SyncML>
// Find the state. Horde::logMessage('SyncML['. session_id() .']: package '
#Horde::logMessage('SymcML: SyncHdr done. Try to load state from session.', __FILE__, __LINE__, PEAR_LOG_DEBUG);
$state = $this->getStateFromSession($this->_sourceURI, $this->_locName, $this->_sessionID);
Horde::logMessage('SyncML['. session_id() .']: package '
. $this->_msgID.' +++++++++++++++++++++ started', . $this->_msgID.' +++++++++++++++++++++ started',
__FILE__, __LINE__, PEAR_LOG_DEBUG); __FILE__, __LINE__, PEAR_LOG_DEBUG);
// Find the state.
//Horde::logMessage('SymcML: SyncHdr done. Try to load state from session.',
// __FILE__, __LINE__, PEAR_LOG_DEBUG);
$state =& $this->getStateFromSession($this->_sourceURI, $this->_locName, $this->_sessionID);
$state->setVersion($this->_version); $state->setVersion($this->_version);
$state->setMsgID($this->_msgID); $state->setMsgID($this->_msgID);
$state->setTargetURI($this->_targetURI); $state->setTargetURI($this->_targetURI);
$state->setWBXML(is_a($this->_output, 'XML_WBXML_Encoder')); $state->setWBXML(is_a($this->_output, 'XML_WBXML_Encoder'));
if(isset($this->_credData) if (isset($this->_credData)
&& isset($this->_locName) && isset($this->_locName)
&& !$state->isAuthorized()) { && !$state->isAuthorized()) {
$state->setPassword($this->_credData); $state->setPassword($this->_credData);
@ -247,14 +240,7 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
$state->setMaxMsgSize($this->_maxMsgSize); $state->setMaxMsgSize($this->_maxMsgSize);
} }
#$str = 'authorized=' . $state->isAuthorized(); // $_SESSION['SyncML.state'] = $state;
#$str .= ' version=' . $state->getVersion();
#$str .= ' msgid=' . $state->getMsgID();
#$str .= ' source=' . $state->getSourceURI();
#$str .= ' target=' . $state->getTargetURI();
#$str .= ' locName=' . $state->getLocName();
$_SESSION['SyncML.state'] = $state;
#Horde::logMessage('SymcML: session id 2 =' . session_id(), __FILE__, __LINE__, PEAR_LOG_DEBUG); #Horde::logMessage('SymcML: session id 2 =' . session_id(), __FILE__, __LINE__, PEAR_LOG_DEBUG);
@ -289,14 +275,14 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
// </Cred></SyncHdr></SyncML> // </Cred></SyncHdr></SyncML>
$this->_isCred = false; $this->_isCred = false;
//multisync does not specify the cred format // We only support b64 for now
//if ($this->_credFormat == 'b64') { //if ($this->_credFormat == 'b64') {
$this->_credData = base64_decode($this->_credData); $this->_credData = base64_decode($this->_credData);
//} //}
$tmp = explode(':', $this->_credData, 2); $tmp = explode(':', $this->_credData, 2);
// set only if not set by LocName already // set only if not set by LocName already
if(!isset($this->_locName)) { if (!isset($this->_locName)) {
$this->_locName = $tmp[0]; $this->_locName = $tmp[0];
} }
$this->_credData = $tmp[1]; $this->_credData = $tmp[1];
@ -355,7 +341,7 @@ class Horde_SyncML_SyncMLHdr extends Horde_SyncML_ContentHandler {
{ {
$attrs = array(); $attrs = array();
$state = &$_SESSION['SyncML.state']; $state =& $_SESSION['SyncML.state'];
$uri = $state->getURI(); $uri = $state->getURI();
$uriMeta = $state->getURIMeta(); $uriMeta = $state->getURIMeta();
@ -495,7 +481,7 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
function startElement($uri, $element, $attrs) function startElement($uri, $element, $attrs)
{ {
parent::startElement($uri, $element, $attrs); parent::startElement($uri, $element, $attrs);
$state = &$_SESSION['SyncML.state']; $state =& $_SESSION['SyncML.state'];
switch ($this->_xmlStack) { switch ($this->_xmlStack) {
case 2: case 2:
@ -505,8 +491,8 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
// <SyncML><SyncBody> // <SyncML><SyncBody>
$this->_output->startElement($uri, $element, $attrs); $this->_output->startElement($uri, $element, $attrs);
if($state->getLocName()) { if ($state->getLocName()) {
if($state->isAuthConfirmed()) { if ($state->isAuthConfirmed()) {
// Right our status about the header // Right our status about the header
$status = new Horde_SyncML_Command_Status(($state->isAuthorized()) ? $status = new Horde_SyncML_Command_Status(($state->isAuthorized()) ?
RESPONSE_OK : RESPONSE_INVALID_CREDENTIALS, 'SyncHdr'); RESPONSE_OK : RESPONSE_INVALID_CREDENTIALS, 'SyncHdr');
@ -550,7 +536,7 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
Horde::logMessage('SyncML['. session_id() ."]: found action commands <$element> ", __FILE__, __LINE__, PEAR_LOG_DEBUG); Horde::logMessage('SyncML['. session_id() ."]: found action commands <$element> ", __FILE__, __LINE__, PEAR_LOG_DEBUG);
} }
switch($element) switch ($element)
{ {
case 'Sync': case 'Sync':
$state->setSyncStatus(CLIENT_SYNC_STARTED); $state->setSyncStatus(CLIENT_SYNC_STARTED);
@ -568,7 +554,7 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
function endElement($uri, $element) function endElement($uri, $element)
{ {
$state = &$_SESSION['SyncML.state']; $state =& $_SESSION['SyncML.state'];
switch ($this->_xmlStack) { switch ($this->_xmlStack) {
case 2: case 2:
@ -588,14 +574,14 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
// send the sync reply // send the sync reply
// we do still have some data to send OR // we do still have some data to send OR
// we should reply to the Sync command // we should reply to the Sync command
if($state->getSyncStatus() > CLIENT_SYNC_FINNISHED && $state->getSyncStatus() < SERVER_SYNC_FINNISHED) { if ($state->getSyncStatus() > CLIENT_SYNC_FINNISHED && $state->getSyncStatus() < SERVER_SYNC_FINNISHED) {
$sync = new Horde_SyncML_Command_Sync(); $sync = new Horde_SyncML_Command_Sync();
$this->_currentCmdID = $sync->syncToClient($this->_currentCmdID, $this->_output); $this->_currentCmdID = $sync->syncToClient($this->_currentCmdID, $this->_output);
} }
// send the Final tag if possible // send the Final tag if possible
#if($state->getSyncStatus() != SERVER_SYNC_DATA_PENDING && $state->getSyncStatus() != CLIENT_SYNC_STARTED) { #if ($state->getSyncStatus() != SERVER_SYNC_DATA_PENDING && $state->getSyncStatus() != CLIENT_SYNC_STARTED) {
if($state->getSyncStatus() >= SERVER_SYNC_FINNISHED || $state->_sendFinal) { if ($state->getSyncStatus() >= SERVER_SYNC_FINNISHED || $state->_sendFinal) {
$final = new Horde_SyncML_Command_Final(); $final = new Horde_SyncML_Command_Final();
$this->_currentCmdID = $final->output($this->_currentCmdID, $this->_output); $this->_currentCmdID = $final->output($this->_currentCmdID, $this->_output);
} }
@ -609,11 +595,12 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
// this packet did not contain any real actions, just status and map. // this packet did not contain any real actions, just status and map.
// This means, we're through! The session can be closed and // This means, we're through! The session can be closed and
// the Anchors saved for the next Sync // the Anchors saved for the next Sync
Horde::logMessage('SyncML['. session_id() .']: sync' . session_id() . ' completed successfully!', __FILE__, __LINE__, PEAR_LOG_INFO); Horde::logMessage('SyncML['. session_id() .']: sync' . session_id() . ' completed successfully!',
__FILE__, __LINE__, PEAR_LOG_INFO);
$state->writeSyncSummary(); $state->writeSyncSummary();
$log = $state->getLog(); $log = $state->getLog();
$s=""; $s="";
foreach($log as $k => $v) { foreach ($log as $k => $v) {
$s .= " $k=$v"; $s .= " $k=$v";
} }
if (strlen(trim($s)) == 0) { if (strlen(trim($s)) == 0) {
@ -630,11 +617,12 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
// this packet did not contain any real actions, just status and map. // this packet did not contain any real actions, just status and map.
// This means, we're through! The session can be closed and // This means, we're through! The session can be closed and
// the Anchors saved for the next Sync // the Anchors saved for the next Sync
Horde::logMessage('SyncML['. session_id() .']: sync' . session_id() . ' completed successfully!', __FILE__, __LINE__, PEAR_LOG_INFO); Horde::logMessage('SyncML['. session_id() .']: sync' . session_id() . ' completed successfully!',
__FILE__, __LINE__, PEAR_LOG_INFO);
$state->writeSyncSummary(); $state->writeSyncSummary();
$log = $state->getLog(); $log = $state->getLog();
$s=""; $s="";
foreach($log as $k => $v) { foreach ($log as $k => $v) {
$s .= " $k=$v"; $s .= " $k=$v";
} }
if (strlen(trim($s)) == 0) { if (strlen(trim($s)) == 0) {
@ -654,7 +642,7 @@ class Horde_SyncML_SyncMLBody extends Horde_SyncML_ContentHandler {
$this->_currentCommand->endElement($uri, $element); $this->_currentCommand->endElement($uri, $element);
switch($element) { switch ($element) {
case 'Final': case 'Final':
$this->_actionCommands = false; $this->_actionCommands = false;
$deviceInfo = $state->getClientDeviceInfo(); $deviceInfo = $state->getClientDeviceInfo();

View File

@ -13,6 +13,7 @@
* @author Joerg Lehrke <jlehrke@noc.de> * @author Joerg Lehrke <jlehrke@noc.de>
* @version $Id$ * @version $Id$
*/ */
require_once(EGW_API_INC.'/common_functions.inc.php');
include_once dirname(__FILE__).'/State.php'; include_once dirname(__FILE__).'/State.php';
/** /**
@ -297,12 +298,12 @@ class EGW_SyncML_State extends Horde_SyncML_State
if (!$this->_isAuthorized) { if (!$this->_isAuthorized) {
if(!isset($this->_locName) && !isset($this->_password)) { if(!isset($this->_locName) && !isset($this->_password)) {
Horde::logMessage('SyncML: Authentication not yet possible currently. Username and password not available' , __FILE__, __LINE__, PEAR_LOG_DEBUG); Horde::logMessage('SyncML: Authentication not yet possible currently. Username and password not available' , __FILE__, __LINE__, PEAR_LOG_DEBUG);
return FALSE; return false;
} }
if (!isset($this->_password)) { if (!isset($this->_password)) {
Horde::logMessage('SyncML: Authentication not yet possible currently. Password not available' , __FILE__, __LINE__, PEAR_LOG_DEBUG); Horde::logMessage('SyncML: Authentication not yet possible currently. Password not available' , __FILE__, __LINE__, PEAR_LOG_DEBUG);
return FALSE; return false;
} }
if (strpos($this->_locName,'@') === False) { if (strpos($this->_locName,'@') === False) {
@ -325,31 +326,37 @@ class EGW_SyncML_State extends Horde_SyncML_State
$GLOBALS['egw_info']['server']['db_type'] = $GLOBALS['egw_domain'][$this->_account_domain]['db_type']; $GLOBALS['egw_info']['server']['db_type'] = $GLOBALS['egw_domain'][$this->_account_domain]['db_type'];
// It works -- don't ask me why. // It works -- don't ask me why.
$this->db = new egw_db($GLOBALS['egw_info']['server']); $this->db = new egw_db($GLOBALS['egw_info']['server']);
$this->db->connect(); if (!$this->db->connect()) {
Horde::logMessage('SyncML_EGW: Can not connect to database for user ' . $this->_locName,
__FILE__, __LINE__, PEAR_LOG_ERROR);
return false;
}
#Horde::logMessage('SyncML: authenticate with username: ' . $this->_locName . ' and password: ' . $this->_password, __FILE__, __LINE__, PEAR_LOG_DEBUG); #Horde::logMessage('SyncML: authenticate with username: ' . $this->_locName . ' and password: ' . $this->_password, __FILE__, __LINE__, PEAR_LOG_DEBUG);
if (($GLOBALS['sessionid'] = $GLOBALS['egw']->session->create($this->_locName,$this->_password,'text'))) if (($GLOBALS['sessionid'] = $GLOBALS['egw']->session->create($this->_locName,$this->_password,'text'))) {
{
if ($GLOBALS['egw_info']['user']['apps']['syncml']) { if ($GLOBALS['egw_info']['user']['apps']['syncml']) {
$this->_isAuthorized = true; $this->_isAuthorized = true;
Horde::logMessage('SyncML_EGW: Authentication of ' . $this->_locName . '/' . $GLOBALS['sessionid'] . ' succeded' , __FILE__, __LINE__, PEAR_LOG_DEBUG); Horde::logMessage('SyncML_EGW: Authentication of ' . $this->_locName . '/' . $GLOBALS['sessionid'] . ' succeded',
__FILE__, __LINE__, PEAR_LOG_DEBUG);
} else { } else {
$this->_isAuthorized = false; $this->_isAuthorized = false;
Horde::logMessage('SyncML is not enabled for user ' . $this->_locName , __FILE__, __LINE__, PEAR_LOG_ERROR); Horde::logMessage('SyncML is not enabled for user ' . $this->_locName,
__FILE__, __LINE__, PEAR_LOG_ERROR);
} }
return $this->_isAuthorized; return $this->_isAuthorized;
} }
} }
$this->_isAuthorized = false; $this->_isAuthorized = false;
Horde::logMessage('SyncML: Authentication of ' . $this->_locName . ' failed' , __FILE__, __LINE__, PEAR_LOG_INFO); Horde::logMessage('SyncML: Authentication of ' . $this->_locName . ' failed' ,
__FILE__, __LINE__, PEAR_LOG_INFO);
} else { } else {
if ($this->log) error_log(__FILE__.'['.__LINE__.'] '.__METHOD__."()\n".var_export($GLOBALS['egw_info'], true)."\n",3,$this->logfile); // store sessionID in a variable, because verify() may reset this value
// store sessionID in a variable, because ->verify maybe resets that value
$sessionID = session_id(); $sessionID = session_id();
$GLOBALS['egw_info']['user']['domain'] = $this->_account_domain; $GLOBALS['egw_info']['user']['domain'] = $this->_account_domain;
if (!$GLOBALS['egw']->session->verify($sessionID, 'staticsyncmlkp3')) { if (!$GLOBALS['egw']->session->verify($sessionID, 'staticsyncmlkp3')) {
Horde::logMessage('SyncML_EGW: egw session(' .$sessionID. ') not verified ' , __FILE__, __LINE__, PEAR_LOG_DEBUG); Horde::logMessage('SyncML_EGW: egw session(' .$sessionID. ') not verified' ,
__FILE__, __LINE__, PEAR_LOG_WARNING);
} }
} }
return $this->_isAuthorized; return $this->_isAuthorized;