egroupware/addressbook/inc/class.addressbook_sif.inc.php
Ralf Becker 1baa158195 Big SyncML patch from Philip Herbert <pherbert(at)knauber.de>:
- change the processing of slowsync, to use the content_map instead of
  trying to build a new one. This caused duplication issues on the
  client if multiple similar records where stored, because only the first
  one found in the server-db was matched, These duplicate entries at client
  side had no entry at serverside, so deleting the wrong one
  on the client (the content with a valid map entry) could cause
  unwanted data loss at server side, because it is impossible for the
  user to see what is a duplicate, and what is not.

see also: 
http://www.nabble.com/again---syncml-duplication-issue-to20333619s3741.html

- reenabled UID from syncml clients, because it was partly used this caused
  issues during SlowSync if the content was changed. 

- infolog, calendar if a uid is found in the provided data, allway try to
  find the corresponding content first   using only the UID, instead of
  using the content-id taken from content_map.

also fixed:

- a few fixes in ./notes
- creating an entry on the client that can not be imported,
  (Example, Nokia E Series Appointment without a Title)
  will no longer create an invalid content-map entry
  However, at client side this is still counted in the Protocol as
  Server-Add
2008-11-16 10:42:29 +00:00

274 lines
7.5 KiB
PHP

<?php
/**
* Addressbook - SIF parser
*
* @link http://www.egroupware.org
* @author Lars Kneschke <lkneschke@egroupware.org>
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @package addressbook
* @subpackage export
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
class addressbook_sif extends addressbook_bo
{
var $sifMapping = array(
'Anniversary' => '',
'AssistantName' => 'assistent',
'AssistantTelephoneNumber' => 'tel_assistent',
'BillingInformation' => '',
'Birthday' => 'bday',
'Body' => 'note',
'Business2TelephoneNumber' => '',
'BusinessAddressCity' => 'adr_one_locality',
'BusinessAddressCountry' => 'adr_one_countryname',
'BusinessAddressPostalCode' => 'adr_one_postalcode',
'BusinessAddressPostOfficeBox' => 'adr_one_street2',
'BusinessAddressState' => 'adr_one_region',
'BusinessAddressStreet' => 'adr_one_street',
'BusinessFaxNumber' => 'tel_fax',
'BusinessTelephoneNumber' => 'tel_work',
'CallbackTelephoneNumber' => '',
'CarTelephoneNumber' => 'tel_car',
'Categories' => 'cat_id',
'Children' => '',
'Companies' => '',
'CompanyMainTelephoneNumber' => '',
'CompanyName' => 'org_name',
'ComputerNetworkName' => '',
'Department' => 'org_unit',
'Email1Address' => 'email',
'Email1AddressType' => '',
'Email2Address' => 'email_home',
'Email2AddressType' => '',
'Email3Address' => '',
'Email3AddressType' => '',
'FileAs' => 'n_fileas',
'FirstName' => 'n_given',
'Hobby' => '',
'Home2TelephoneNumber' => '',
'HomeAddressCity' => 'adr_two_locality',
'HomeAddressCountry' => 'adr_two_countryname',
'HomeAddressPostalCode' => 'adr_two_postalcode',
'HomeAddressPostOfficeBox' => 'adr_two_street2',
'HomeAddressState' => 'adr_two_region',
'HomeAddressStreet' => 'adr_two_street',
'HomeFaxNumber' => 'tel_fax_home',
'HomeTelephoneNumber' => 'tel_home',
'Importance' => '',
'Initials' => '',
'JobTitle' => 'title',
'Language' => '',
'LastName' => 'n_family',
'ManagerName' => '',
'MiddleName' => 'n_middle',
'Mileage' => '',
'MobileTelephoneNumber' => 'tel_cell',
'NickName' => '',
'OfficeLocation' => 'room',
'OrganizationalIDNumber' => '',
'OtherAddressCity' => '',
'OtherAddressCountry' => '',
'OtherAddressPostalCode' => '',
'OtherAddressPostOfficeBox' => '',
'OtherAddressState' => '',
'OtherAddressStreet' => '',
'OtherFaxNumber' => '',
'OtherTelephoneNumber' => 'tel_other',
'PagerNumber' => 'tel_pager',
'PrimaryTelephoneNumber' => 'tel_prefer',
'Profession' => 'role',
'RadioTelephoneNumber' => '',
'Sensitivity' => 'private',
'Spouse' => '',
'Subject' => '',
'Suffix' => 'n_suffix',
'TelexNumber' => '',
'Title' => 'n_prefix',
'WebPage' => 'url',
'YomiCompanyName' => '',
'YomiFirstName' => '',
'YomiLastName' => '',
'HomeWebPage' => 'url_home',
'Folder' => '',
);
function startElement($_parser, $_tag, $_attributes) {
}
function endElement($_parser, $_tag) {
if(!empty($this->sifMapping[$_tag])) {
$this->contact[$this->sifMapping[$_tag]] = trim($this->sifData);
}
unset($this->sifData);
}
function characterData($_parser, $_data) {
$this->sifData .= $_data;
}
function siftoegw($_sifdata) {
$sifData = base64_decode($_sifdata);
#$tmpfname = tempnam('/tmp/sync/contents','sifc_');
#$handle = fopen($tmpfname, "w");
#fwrite($handle, $sifdata);
#fclose($handle);
$this->xml_parser = xml_parser_create('UTF-8');
xml_set_object($this->xml_parser, $this);
xml_parser_set_option($this->xml_parser, XML_OPTION_CASE_FOLDING, false);
xml_set_element_handler($this->xml_parser, "startElement", "endElement");
xml_set_character_data_handler($this->xml_parser, "characterData");
$this->strXmlData = xml_parse($this->xml_parser, $sifData);
if(!$this->strXmlData) {
error_log(sprintf("XML error: %s at line %d",
xml_error_string(xml_get_error_code($this->xml_parser)),
xml_get_current_line_number($this->xml_parser)));
return false;
}
foreach($this->contact as $key => $value) {
$value = $GLOBALS['egw']->translation->convert($value, 'utf-8');
switch($key) {
case 'cat_id':
if(!empty($value))
{
$finalContact[$key] = implode(",", $this->find_or_add_categories(explode(';', $value)));
}
else
{
$finalContact[$key] = '';
}
break;
case 'private':
$finalContact[$key] = (int) ($value > 0); // eGW private is 0 (public) or 1 (private), SIF seems to use 0 and 2
break;
default:
$finalContact[$key] = $value;
break;
}
}
$this->fixup_contact($finalContact);
return $finalContact;
}
/**
* Search an exactly matching entry (used for slow sync)
*
* @param string $_sifdata
* @return boolean/int/string contact-id or false, if not found
*/
function search($_sifdata,$contentID=null)
{
if(!$contact = $this->siftoegw($_sifdata))
{
return false;
}
if ($contentID) {
$contact['contact_id'] = $contentID;
}
// patch from Di Guest says: we need to ignore the n_fileas
unset($contact['n_fileas']);
// we probably need to ignore even more as we do in vcaladdressbook
if(($foundContacts = addressbook_bo::search($contact)))
{
error_log(print_r($foundContacts,true));
return $foundContacts[0]['id'];
}
return false;
}
/**
* import a vard into addressbook
*
* @return int contact id
* @param string $_vcard the vcard
* @param int/string $_abID=null the internal addressbook id or !$_abID for a new enty
*/
function addSIF($_sifdata, $_abID=null)
{
#error_log('ABID: '.$_abID);
#error_log(base64_decode($_sifdata));
if(!$contact = $this->siftoegw($_sifdata)) {
return false;
}
if($_abID) {
// update entry
$contact['id'] = $_abID;
}
return $this->save($contact);
}
/**
* return a vcard
*
* @param int $_id the id of the contact
* @param int $_vcardProfile profile id for mapping from vcard values to egw addressbook
* @return string containing the vcard
*/
function getSIF($_id)
{
$fields = array_unique(array_values($this->sifMapping));
sort($fields);
if(!($entry = $this->read($_id)))
{
return false;
}
$sifContact = '<contact>';
#error_log(print_r($entry,true));
$sysCharSet = $GLOBALS['egw']->translation->charset();
// fillup some defaults such as n_fn and n_fileas is needed
$this->fixup_contact($entry);
foreach($this->sifMapping as $sifField => $egwField)
{
if(empty($egwField)) continue;
#error_log("$sifField => $egwField");
#error_log('VALUE1: '.$entry[0][$egwField]);
$value = $GLOBALS['egw']->translation->convert($entry[$egwField], $sysCharSet, 'utf-8');
#error_log('VALUE2: '.$value);
switch($sifField)
{
// TODO handle multiple categories
case 'Categories':
if(!empty($value)) {
$value = implode("; ", $this->get_categories($value));
$value = $GLOBALS['egw']->translation->convert($value, $sysCharSet, 'utf-8');
}
$sifContact .= "<$sifField>$value</$sifField>";
break;
case 'Sensitivity':
$value = 2 * $value; // eGW private is 0 (public) or 1 (private)
$sifContact .= "<$sifField>$value</$sifField>";
break;
case 'Folder':
# skip currently. This is the folder where Outlook stores the contact.
#$sifContact .= "<$sifField>/</$sifField>";
break;
default:
$sifContact .= "<$sifField>".trim($value)."</$sifField>";
break;
}
}
$sifContact .= "</contact>";
return base64_encode($sifContact);
}
}