/usr/share/php/Horde/SyncMl/Backend/Sql.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 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 | <?php
/**
* Generic SQL based Horde_SyncMl Backend.
*
* This can be used as a starting point for a custom backend implementation.
*
* Copyright 2006-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 Karsten Fourmont <karsten@horde.org>
* @package SyncMl
*/
/*
* The SQL Database must contain five tables as created by the following SQL
* script:
*
* CREATE DATABASE syncml;
*
* USE syncml;
*
* CREATE TABLE syncml_data(
* syncml_id VARCHAR(255),
* syncml_db VARCHAR(255),
* syncml_uid VARCHAR(255),
* syncml_data TEXT,
* syncml_contenttype VARCHAR(255),
* syncml_created_ts INTEGER,
* syncml_modified_ts INTEGER
* );
*
* CREATE TABLE syncml_map(
* syncml_syncpartner VARCHAR(255),
* syncml_db VARCHAR(255),
* syncml_uid VARCHAR(255),
* syncml_cuid VARCHAR(255),
* syncml_suid VARCHAR(255),
* syncml_timestamp INTEGER
* );
*
* CREATE INDEX syncml_syncpartner_idx ON syncml_map (syncml_syncpartner);
* CREATE INDEX syncml_db_idx ON syncml_map (syncml_db);
* CREATE INDEX syncml_uid_idx ON syncml_map (syncml_uid);
* CREATE INDEX syncml_cuid_idx ON syncml_map (syncml_cuid);
* CREATE INDEX syncml_suid_idx ON syncml_map (syncml_suid);
*
* CREATE TABLE syncml_anchors(
* syncml_syncpartner VARCHAR(255),
* syncml_db VARCHAR(255),
* syncml_uid VARCHAR(255),
* syncml_clientanchor VARCHAR(255),
* syncml_serveranchor VARCHAR(255)
* );
*
* CREATE TABLE syncml_suidlist(
* syncml_syncpartner VARCHAR(255),
* syncml_db VARCHAR(255),
* syncml_uid VARCHAR(255),
* syncml_suid VARCHAR(255)
* );
*
* CREATE TABLE syncml_uids(
* syncml_uid VARCHAR(255),
* syncml_password VARCHAR(255)
* );
*/
/**
*/
class Horde_SyncMl_Backend_Sql extends Horde_SyncMl_Backend
{
/**
* A PEAR MDB2 instance.
*
* @var MDB2
*/
protected $_db;
/**
* Constructor.
*
* @param array $params A hash with parameters. In addition to those
* supported by the Horde_SyncMl_Backend class one more
* parameter is required for the database connection:
* 'dsn' => connection DSN.
*/
public function __construct($params)
{
parent::__construct($params);
$this->_db = &MDB2::connect($params['dsn']);
if (is_a($this->_db, 'PEAR_Error')) {
$this->logMessage($this->_db, 'ERR');
}
}
/**
* Returns whether a database URI is valid to be synced with this backend.
*
* @param string $databaseURI URI of a database. Like calendar, tasks,
* contacts or notes. May include optional
* parameters:
* tasks?options=ignorecompleted.
*
* @return boolean True if a valid URI.
*/
public function isValidDatabaseURI($databaseURI)
{
$database = $this->normalize($databaseURI);
switch($database) {
case 'tasks':
case 'calendar':
case 'notes':
case 'contacts':
case 'events':
case 'memo':
return true;
default:
$this->logMessage('Invalid database ' . $database
. '. Try tasks, calendar, notes or contacts.', 'ERR');
return false;
}
}
/**
* Returns entries that have been modified in the server database.
*
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param integer $from_ts Start timestamp.
* @param integer $to_ts Exclusive end timestamp. Not yet
* implemented.
* @param array &$adds Output array: hash of adds suid => 0
* @param array &$mods Output array: hash of modifications
* suid => cuid
* @param array &$dels Output array: hash of deletions suid => cuid
*
* @return mixed True on success or a PEAR_Error object.
*/
public function getServerChanges($databaseURI, $from_ts, $to_ts, &$adds, &$mods,
&$dels)
{
$database = $this->normalize($databaseURI);
$adds = $mods = $dels = array();
// Handle additions:
$data = $this->_db->queryAll(
'SELECT syncml_id, syncml_created_ts from syncml_data '
. 'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_created_ts >= '
. $this->_db->quote($from_ts, 'integer')
. ' AND syncml_created_ts < '
. $this->_db->quote($to_ts, 'integer'));
if ($this->_checkForError($data)) {
return $data;
}
foreach ($data as $d) {
$suid = $d[0];
$suid_ts = $d[1];
$sync_ts = $this->_getChangeTS($databaseURI, $suid);
if ($sync_ts && $sync_ts >= $suid_ts) {
// Change was done by us upon request of client, don't mirror
// that back to the client.
$this->logMessage("Added to server from client: $suid ignored", 'DEBUG');
continue;
}
$adds[$suid] = 0;
}
// Only compile changes on delta sync:
if ($from_ts > 0) {
// Handle replaces. We might get IDs that are already in the adds
// array but that's ok: The calling code takes care to ignore
// these.
$data = $this->_db->queryAll(
'SELECT syncml_id, syncml_modified_ts from syncml_data '
.'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_modified_ts >= '
. $this->_db->quote($from_ts, 'integer')
. ' AND syncml_modified_ts < '
. $this->_db->quote($to_ts, 'integer'));
if ($this->_checkForError($data)) {
return $data;
}
foreach($data as $d) {
// Only the server needs to check the change timestamp do
// identify client-sent changes.
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$suid = $d[0];
$suid_ts = $d[1];
$sync_ts = $this->_getChangeTS($databaseURI, $suid);
if ($sync_ts && $sync_ts >= $suid_ts) {
// Change was done by us upon request of client, don't
// mirror that back to the client.
$this->logMessage(
"Changed on server after sent from client: $suid ignored", 'DEBUG');
continue;
}
$mods[$suid] = $this->_getCuid($databaseURI, $suid);
} else {
$mods[$d[0]] = $d[0];
}
}
}
// Handle deletions:
// We assume stupid a backend datastore (syncml_data) where deleted
// items are simply "gone" from the datastore. So we need to do our
// own bookkeeping to identify entries that have been deleted since
// the last sync run.
// This is done by the _trackDeless() helper function: we feed it with
// a current list of all suids and get the ones missing (and thus
// deleted) in return.
$data = $this->_db->queryCol(
'SELECT syncml_id from syncml_data WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
if ($this->_checkForError($data)) {
return $data;
}
// Get deleted items and store current items:
// Only use the deleted information on delta sync. On initial slowsync
// we just need to call _trackDeletes() once to init the list.
$data = $this->_trackDeletes($databaseURI, $data);
if ($this->_checkForError($data)) {
return $data;
}
if ($from_ts > 0) {
foreach($data as $suid) {
// Only the server needs to handle the cuid suid map:
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$dels[$suid] = $this->_getCuid($databaseURI, $suid);
} else {
$dels[$suid] = $suid;
}
}
}
}
/**
* Retrieves an entry from the backend.
*
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $suid Server unique id of the entry: for horde
* this is the guid.
* @param string $contentType Content-Type: the MIME type in which the
* public function should return the data.
* @param array $fields Hash of field names and Horde_SyncMl_Property
* properties with the requested fields.
*
* @return mixed A string with the data entry or a PEAR_Error object.
*/
public function retrieveEntry($databaseURI, $suid, $contentType, $fields)
{
$database = $this->normalize($databaseURI);
return $this->_db->queryOne(
'SELECT syncml_data from syncml_data '
. 'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_id = '
. $this->_db->quote($suid, 'text'));
}
/**
* Adds an entry into the server database.
*
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $content The actual data.
* @param string $contentType MIME type of the content.
* @param string $cuid Client ID of this entry.
*
* @return array PEAR_Error or suid (Horde guid) of new entry
*/
public function addEntry($databaseURI, $content, $contentType, $cuid = null)
{
$database = $this->normalize($databaseURI);
// Generate an id (suid). It's also possible to use a database
// generated primary key here.
$suid = strval(new Horde_Support_Uuid());
$created_ts = $this->getCurrentTimeStamp();
$r = $this->_db->exec(
'INSERT INTO syncml_data (syncml_id, syncml_db, syncml_uid, '
. 'syncml_data, syncml_contenttype, syncml_created_ts, '
. 'syncml_modified_ts) VALUES ('
. $this->_db->quote($suid, 'text') . ','
. $this->_db->quote($database, 'text') . ','
. $this->_db->quote($this->_user, 'text') . ','
. $this->_db->quote($content, 'text') . ','
. $this->_db->quote($contentType, 'text') . ','
. $this->_db->quote($created_ts, 'integer') . ','
. $this->_db->quote($created_ts, 'integer')
. ')');
if ($this->_checkForError($r)) {
return $r;
}
// Only the server needs to handle the cuid suid map:
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$this->createUidMap($databaseURI, $cuid, $suid, $created_ts);
}
}
/**
* Replaces an entry in the server database.
*
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $content The actual data.
* @param string $contentType MIME type of the content.
* @param string $cuid Client ID of this entry.
*
* @return string PEAR_Error or server ID (Horde GUID) of modified entry.
*/
public function replaceEntry($databaseURI, $content, $contentType, $cuid)
{
$database = $this->normalize($databaseURI);
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$suid = $this->_getSuid($databaseURI, $cuid);
} else {
$suid = $cuid;
}
if ($suid) {
// Entry exists: replace current one.
$modified_ts = $this->getCurrentTimeStamp();
$r = $this->_db->exec(
'UPDATE syncml_data '
. 'SET syncml_modified_ts = '
. $this->_db->quote($modified_ts, 'integer')
. ', syncml_data = '
. $this->_db->quote($content, 'text')
. ', syncml_contenttype = '
. $this->_db->quote($contentType, 'text')
. 'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_id = '
. $this->_db->quote($suid, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
// Only the server needs to keep the map:
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$this->createUidMap($databaseURI, $cuid, $suid, $modified_ts);
}
} else {
return PEAR::raiseError("No map entry found for client id $cuid replacing on server");
}
return $suid;
}
/**
* Deletes an entry from the server database.
*
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $cuid Client ID of the entry.
*
* @return boolean True on success or false on failed (item not found).
*/
public function deleteEntry($databaseURI, $cuid)
{
$database = $this->normalize($databaseURI);
// Find ID for this entry:
if ($this->_backendMode == Horde_SyncMl_Backend::MODE_SERVER) {
$suid = $this->_getSuid($databaseURI, $cuid);
} else {
$suid = $cuid;
}
if (!is_a($suid, 'PEAR_Error')) {
// A clever backend datastore would store some information about a
// deletion so this information can be extracted from the history.
// However we do a "stupid" datastore here where deleted items are
// simply gone. This allows us to illustrate the _trackDeletes()
// bookkeeping mechanism.
$r = $this->_db->queryOne(
'DELETE FROM syncml_data '
. ' WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_id = '
. $this->_db->quote($suid, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
// Deleted bookkeeping is required for server and client, but not
// for test mode:
if ($this->_backendMode != Horde_SyncMl_Backend::MODE_TEST) {
$this->_removeFromSuidList($databaseURI, $suid);
}
// @todo: delete from map!
} else {
return false;
}
if (is_a($r, 'PEAR_Error')) {
return false;
}
return true;
}
/**
* Authenticates the user at the backend.
*
* @param string $username A user name.
* @param string $password A password.
*
* @return boolean|string The user name if authentication succeeded, false
* otherwise.
*/
protected function _checkAuthentication($username, $password)
{
// Empty passwords result in errors for some authentication
// backends, don't call the backend in this case.
if ($pwd === '') {
return false;
}
$r = $this->_db->queryOne(
'SELECT syncml_uid FROM syncml_uids'
. ' WHERE syncml_uid = '
. $this->_db->quote($username, 'text')
. ' AND syncml_password = '
. $this->_db->quote($pwd, 'text'));
$this->_checkForError($r);
if ($r === $username) {
return $username;
}
return false;
}
/**
* Sets a user as being authenticated at the backend.
*
* @abstract
*
* @param string $username A user name.
* @param string $credData Authentication data provided by <Cred><Data>
* in the <SyncHdr>.
*
* @return string The user name.
*/
protected function _setAuthenticated($username, $credData)
{
return $username;
}
/**
* Stores Sync anchors after a successful synchronization to allow two-way
* synchronization next time.
*
* The backend has to store the parameters in its persistence engine
* where user, syncDeviceID and database are the keys while client and
* server anchor ar the payload. See readSyncAnchors() for retrieval.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $clientAnchorNext The client anchor as sent by the
* client.
* @param string $serverAnchorNext The anchor as used internally by the
* server.
*/
public function writeSyncAnchors($databaseURI, $clientAnchorNext,
$serverAnchorNext)
{
$database = $this->normalize($databaseURI);
// Check if entry exists. If not insert, otherwise update.
if (!$this->readSyncAnchors($databaseURI)) {
$r = $this->_db->exec(
'INSERT INTO syncml_anchors (syncml_syncpartner, '
. 'syncml_db,syncml_uid, syncml_clientanchor, '
. 'syncml_serveranchor) VALUES ('
. $this->_db->quote($this->_syncDeviceID, 'text') . ', '
. $this->_db->quote($database, 'text') . ', '
. $this->_db->quote($this->_user, 'text') . ', '
. $this->_db->quote($clientAnchorNext, 'text') . ', '
. $this->_db->quote($serverAnchorNext, 'text')
. ')');
} else {
$r = $this->_db->exec(
'UPDATE syncml_anchors '
. ' SET syncml_clientanchor = '
. $this->_db->quote($clientAnchorNext, 'text')
. ', syncml_serveranchor = '
. $this->_db->quote($serverAnchorNext, 'text')
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
}
if ($this->_checkForError($r)) {
return $r;
}
return true;
}
/**
* Reads the previously written sync anchors from the database.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
*
* @return mixed Two-element array with client anchor and server anchor as
* stored in previous writeSyncAnchor() calls. False if no
* data found.
*/
public function readSyncAnchors($databaseURI)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->queryRow(
'SELECT syncml_clientanchor, syncml_serveranchor '
. 'FROM syncml_anchors WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
$this->_checkForError($r);
if (!is_array($r)) {
return false;
}
return array($r[0], $r[1]);
}
/**
* Creates a map entry to map between server and client IDs.
*
* If an entry already exists, it is overwritten.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $cuid Client ID of the entry.
* @param string $suid Server ID of the entry.
* @param integer $timestamp Optional timestamp. This can be used to
* 'tag' changes made in the backend during the
* sync process. This allows to identify these,
* and ensure that these changes are not
* replicated back to the client (and thus
* duplicated). See key concept "Changes and
* timestamps".
*/
public function createUidMap($databaseURI, $cuid, $suid, $timestamp = 0)
{
$database = $this->normalize($databaseURI);
// Check if entry exists. If not insert, otherwise update.
if (!$this->_getSuid($databaseURI, $cuid)) {
$r = $this->_db->exec(
'INSERT INTO syncml_map (syncml_syncpartner, '
. 'syncml_db, syncml_uid, syncml_cuid, syncml_suid, '
. 'syncml_timestamp) VALUES ('
. $this->_db->quote($this->_syncDeviceID, 'text') . ', '
. $this->_db->quote($database, 'text') . ', '
. $this->_db->quote($this->_user, 'text') . ', '
. $this->_db->quote($cuid, 'text') . ', '
. $this->_db->quote($suid, 'text') . ', '
. $this->_db->quote($timestamp, 'integer')
. ')');
} else {
$r = $this->_db->exec(
'UPDATE syncml_map SET syncml_suid = '
. $this->_db->quote($suid, 'text')
. ', syncml_timestamp = '
. $this->_db->quote($timestamp, 'text')
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_cuid = '
. $this->_db->quote($cuid, 'text'));
}
if ($this->_checkForError($r)) {
return $r;
}
return true;
}
/**
* Retrieves the Server ID for a given Client ID from the map.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $cuid The client ID.
*
* @return mixed The server ID string or false if no entry is found.
*/
protected function _getSuid($databaseURI, $cuid)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->queryOne(
'SELECT syncml_suid FROM syncml_map '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_cuid = '
. $this->_db->quote($cuid, 'text'));
$this->_checkForError($r);
if (!empty($r)) {
return $r;
}
return false;
}
/**
* Retrieves the Client ID for a given Server ID from the map.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $suid The server ID.
*
* @return mixed The client ID string or false if no entry is found.
*/
protected function _getCuid($databaseURI, $suid)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->queryOne(
'SELECT syncml_cuid FROM syncml_map '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_suid = '
. $this->_db->quote($suid, 'text'));
$this->_checkForError($r);
if (!empty($r)) {
return $r;
}
return false;
}
/**
* Returns a timestamp stored in the map for a given Server ID.
*
* The timestamp is the timestamp of the last change to this server ID
* that was done inside a sync session (as a result of a change received
* by the server). It's important to distinguish changes in the backend a)
* made by the user during normal operation and b) changes made by SyncML
* to reflect client updates. When the server is sending its changes it
* is only allowed to send type a). However the history feature in the
* backend my not know if a change is of type a) or type b). So the
* timestamp is used to differentiate between the two.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $suid The server ID.
*
* @return mixed The previously stored timestamp or false if no entry is
* found.
*/
protected function _getChangeTS($databaseURI, $suid)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->queryOne(
'SELECT syncml_timestamp FROM syncml_map '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_suid = '
. $this->_db->quote($suid, 'text'));
$this->_checkForError($r);
if (!empty($r)) {
return $r;
}
return false;
}
/**
* Erases all mapping entries for one combination of user, device ID.
*
* This is used during SlowSync so that we really sync everything properly
* and no old mapping entries remain.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
*/
public function eraseMap($databaseURI)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->exec(
'DELETE FROM syncml_map '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
$r = $this->_db->exec(
'DELETE FROM syncml_suidlist '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
return true;
}
/**
* Cleanup public function called after all message processing is finished.
*
* Allows for things like closing databases or flushing logs. When
* running in test mode, tearDown() must be called rather than close.
*/
public function close()
{
parent::close();
$this->_db->disconnect();
}
/**
* Checks if the parameter is a PEAR_Error object and if so logs the
* error.
*
* @param mixed $o An object or value to check.
*
* @return mixed The error object if an error has been passed or false if
* no error has been passed.
*/
protected function _checkForError($o)
{
if (is_a($o, 'PEAR_Error')) {
$this->logMessage($o);
return $o;
}
return false;
}
/**
* Returns a list of item IDs that have been deleted since the last sync
* run and stores a complete list of IDs for next sync run.
*
* Some backend datastores don't keep information about deleted entries.
* So we have to create a workaround that finds out what entries have been
* deleted since the last sync run. This method provides this
* functionality: it is called with a list of all IDs currently in the
* database. It then compares this list with its own previously stored
* list of IDs to identify those missing (and thus deleted). The passed
* list is then stored for the next invocation.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param array $currentSuids Array of all SUIDs (primary keys) currently
* in the server datastore.
*
* @return array Array of all entries that have been deleted since the
* last call.
*/
protected function _trackDeletes($databaseURI, $currentSuids)
{
$database = $this->normalize($databaseURI);
if (!is_array($currentSuids)) {
$currentSuids = array();
}
$this->logMessage('_trackDeletes() with ' . count($currentSuids)
. ' current ids', 'DEBUG');
$r = $this->_db->queryCol(
'SELECT syncml_suid FROM syncml_suidlist '
. ' WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
$this->logMessage('_trackDeletes() found ' . count($r)
. ' items in prevlist', 'DEBUG');
// Convert to hash with suid as key.
if (is_array($r)) {
$prevSuids = array_flip($r);
} else {
$prevSuids = array();
}
foreach ($currentSuids as $suid) {
if (isset($prevSuids[$suid])) {
// Entry is there now and in $prevSuids. Unset in $prevSuids
// array so we end up with only those in $prevSuids that are
// no longer there now.
unset($prevSuids[$suid]);
} else {
// Entry is there now but not in $prevSuids. New entry, store
// in syncml_suidlist
$r = $this->_db->exec(
'INSERT INTO syncml_suidlist '
. ' (syncml_syncpartner, syncml_db, syncml_uid, '
. 'syncml_suid) VALUES ('
. $this->_db->quote($this->_syncDeviceID, 'text') . ', '
. $this->_db->quote($database, 'text') . ', '
. $this->_db->quote($this->_user, 'text') . ', '
. $this->_db->quote($suid, 'text')
. ')');
if ($this->_checkForError($r)) {
return $r;
}
}
}
// $prevSuids now contains the deleted suids. Remove those from
// syncml_suidlist so we have a current list of all existing suids.
foreach ($prevSuids as $suid => $cuid) {
$r = $this->_removeFromSuidList($databaseURI, $suid);
}
$this->logMessage('_trackDeletes() with ' . count($prevSuids)
. ' deleted items', 'DEBUG');
return array_keys($prevSuids);
}
/**
* Removes a suid from the suidlist.
*
* Called by _trackDeletes() when updating the suidlist and deleteEntry()
* when removing an entry due to a client request.
*
* @param string $databaseURI URI of database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param array $suid The suid to remove from the list.
*/
protected function _removeFromSuidList($databaseURI, $suid)
{
$database = $this->normalize($databaseURI);
$this->logMessage('_removeFromSuidList(): item ' . $suid, 'DEBUG');
$r = $this->_db->queryCol(
'DELETE FROM syncml_suidlist '
. 'WHERE syncml_syncpartner = '
. $this->_db->quote($this->_syncDeviceID, 'text')
. ' AND syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($this->_user, 'text')
. ' AND syncml_suid = '
. $this->_db->quote($suid, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
$this->logMessage('_removeFromSuidList(): result ' . implode('!', $r), 'DEBUG');
return true;
}
/**
* Creates a clean test environment in the backend.
*
* Ensures there's a user with the given credentials and an empty data
* store.
*
* @param string $user This user accout has to be created in the backend.
* @param string $pwd The password for user $user.
*/
public function testSetup($user, $pwd)
{
$this->_user = $user;
$this->_cleanUser($user);
$this->_backend->_user = $user;
$r = $this->_db->exec(
'INSERT INTO syncml_uids (syncml_uid, syncml_password)'
. ' VALUES ('
. $this->_db->quote($user, 'text') . ', '
. $this->_db->quote($pwd, 'text') . ')');
$this->_checkForError($r);
}
/**
* Prepares the test start.
*
* @param string $user This user accout has to be created in the backend.
*/
public function testStart($user)
{
$this->_user = $user;
$this->_backend->_user = $user;
}
/**
* Tears down the test environment after the test is run.
*
* Should remove the testuser created during testSetup and all its data.
*/
public function testTearDown()
{
$this->_cleanUser($this->_user);
$this->_db->disconnect();
}
/* Database access functions. The following methods are not part of the
* backend API. They are here to illustrate how a backend application
* (like a web calendar) has to modify the data with respect to the
* history. There are three functions:
* addEntry_backend(), replaceEntry_backend(), deleteEntry_backend().
* They are very similar to the API methods above, but don't use cuids or
* syncDeviceIDs as these are only relevant for syncing. */
/**
* Adds an entry into the server database.
*
* @param string $user The username to use. Not strictly necessery
* to store this, but it helps for the test
* environment to clean up all entries for a
* test user.
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $content The actual data.
* @param string $contentType MIME type of the content.
*
* @return array PEAR_Error or suid of new entry.
*/
public function addEntry_backend($user, $databaseURI, $content, $contentType)
{
$database = $this->normalize($databaseURI);
// Generate an id (suid). It's also possible to use a database
// generated primary key here. */
$suid = strval(new Horde_Support_Uuid());
$created_ts = $this->getCurrentTimeStamp();
$r = $this->_db->exec(
'INSERT INTO syncml_data (syncml_id, syncml_db, syncml_uid, '
. 'syncml_data, syncml_contenttype, syncml_created_ts, '
. 'syncml_modified_ts) VALUES ('
. $this->_db->quote($suid, 'text') . ', '
. $this->_db->quote($database, 'text') . ', '
. $this->_db->quote($user, 'text') . ', '
. $this->_db->quote($content, 'text') . ', '
. $this->_db->quote($contentType, 'text') . ', '
. $this->_db->quote($created_ts, 'integer') . ', '
. $this->_db->quote($created_ts, 'integer')
. ')');
if ($this->_checkForError($r)) {
return $r;
}
return $suid;
}
/**
* Replaces an entry in the server database.
*
* @param string $user The username to use. Not strictly necessery
* to store this but, it helps for the test
* environment to clean up all entries for a
* test user.
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $content The actual data.
* @param string $contentType MIME type of the content.
* @param string $suid Server ID of this entry.
*
* @return string PEAR_Error or suid of modified entry.
*/
public function replaceEntry_backend($user, $databaseURI, $content, $contentType,
$suid)
{
$database = $this->normalize($databaseURI);
$modified_ts = $this->getCurrentTimeStamp();
// Entry exists: replace current one.
$r = $this->_db->exec(
'UPDATE syncml_data '
. 'SET syncml_modified_ts = '
. $this->_db->quote($modified_ts, 'integer')
. ',syncml_data = '
. $this->_db->quote($content, 'text')
. ',syncml_contenttype = '
. $this->_db->quote($contentType, 'text')
. 'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($user, 'text')
. ' AND syncml_id = '
. $this->_db->quote($suid, 'text'));
if ($this->_checkForError($r)) {
return $r;
}
return $suid;
}
/**
* Deletes an entry from the server database.
*
* @param string $user The username to use. Not strictly necessery
* to store this, but it helps for the test
* environment to clean up all entries for a
* test user.
* @param string $databaseURI URI of Database to sync. Like calendar,
* tasks, contacts or notes. May include
* optional parameters:
* tasks?options=ignorecompleted.
* @param string $suid Server ID of the entry.
*
* @return boolean True on success or false on failed (item not found).
*/
public function deleteEntry_backend($user, $databaseURI, $suid)
{
$database = $this->normalize($databaseURI);
$r = $this->_db->queryOne(
'DELETE FROM syncml_data '
. 'WHERE syncml_db = '
. $this->_db->quote($database, 'text')
. ' AND syncml_uid = '
. $this->_db->quote($user, 'text')
. ' AND syncml_id = '
. $this->_db->quote($suid, 'text'));
if ($this->_checkForError($r)) {
return false;
}
return true;
}
protected function _cleanUser($user)
{
$r = $this->_db->exec('DELETE FROM syncml_data WHERE syncml_uid = '
. $this->_db->quote($user, 'text'));
$this->_checkForError($r);
$r = $this->_db->exec('DELETE FROM syncml_map WHERE syncml_uid = '
. $this->_db->quote($user, 'text'));
$this->_checkForError($r);
$r = $this->_db->exec('DELETE FROM syncml_anchors WHERE syncml_uid = '
. $this->_db->quote($user, 'text'));
$this->_checkForError($r);
$r = $this->_db->exec('DELETE FROM syncml_uids WHERE syncml_uid = '
. $this->_db->quote($user, 'text'));
$this->_checkForError($r);
$r = $this->_db->exec('DELETE FROM syncml_suidlist WHERE syncml_uid = '
. $this->_db->quote($user, 'text'));
$this->_checkForError($r);
}
}
|