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
|
/*
Copyright (c) 2007, 2009 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library 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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#include "collectionsync_p.h"
#include "collection.h"
#include "collectioncreatejob.h"
#include "collectiondeletejob.h"
#include "collectionfetchjob.h"
#include "collectionmodifyjob.h"
#include "collectionfetchscope.h"
#include "collectionmovejob.h"
#include "cachepolicy.h"
#include <kdebug.h>
#include <KLocalizedString>
#include <QtCore/QVariant>
using namespace Akonadi;
struct RemoteNode;
/**
LocalNode is used to build a tree structure of all our locally existing collections.
*/
struct LocalNode
{
LocalNode(const Collection &col)
: collection(col)
, processed(false)
{}
~LocalNode()
{
qDeleteAll(childNodes);
qDeleteAll(pendingRemoteNodes);
}
Collection collection;
QList<LocalNode *> childNodes;
QHash<QString, LocalNode *> childRidMap;
/** When using hierarchical RIDs we attach a list of not yet processable remote nodes to
the closest already existing local ancestor node. They will be re-evaluated once a new
child node is added. */
QList<RemoteNode *> pendingRemoteNodes;
bool processed;
};
Q_DECLARE_METATYPE(LocalNode *)
static const char LOCAL_NODE[] = "LocalNode";
/**
RemoteNode is used as a container for remote collections which typically don't have a UID set
and thus cannot easily be compared or put into maps etc.
*/
struct RemoteNode
{
RemoteNode(const Collection &col)
: collection(col)
{}
Collection collection;
};
Q_DECLARE_METATYPE(RemoteNode *)
static const char REMOTE_NODE[] = "RemoteNode";
static const char CONTENTMIMETYPES[] = "CONTENTMIMETYPES";
/**
* @internal
*/
class CollectionSync::Private
{
public:
Private(CollectionSync *parent)
: q(parent)
, pendingJobs(0)
, progress(0)
, localRoot(0)
, currentTransaction(0)
, knownLocalCollections(0)
, incremental(false)
, streaming(false)
, hierarchicalRIDs(false)
, localListDone(false)
, deliveryDone(false)
{
}
~Private()
{
delete localRoot;
qDeleteAll(rootRemoteNodes);
}
/** Utility method to reset the node tree. */
void resetNodeTree()
{
delete localRoot;
localRoot = new LocalNode(Collection::root());
localRoot->processed = true; // never try to delete that one
if (currentTransaction) {
// we are running the update transaction, initialize pending remote nodes
localRoot->pendingRemoteNodes.swap(rootRemoteNodes);
}
localUidMap.clear();
localRidMap.clear();
localUidMap.insert(localRoot->collection.id(), localRoot);
if (!hierarchicalRIDs) {
localRidMap.insert(QString(), localRoot);
}
}
/** Create a local node from the given local collection and integrate it into the local tree structure. */
LocalNode *createLocalNode(const Collection &col)
{
LocalNode *node = new LocalNode(col);
Q_ASSERT(!localUidMap.contains(col.id()));
localUidMap.insert(node->collection.id(), node);
if (!hierarchicalRIDs && !col.remoteId().isEmpty()) {
localRidMap.insert(node->collection.remoteId(), node);
}
// add already existing children
if (localPendingCollections.contains(col.id())) {
QVector<Collection::Id> childIds = localPendingCollections.take(col.id());
foreach (Collection::Id childId, childIds) {
Q_ASSERT(localUidMap.contains(childId));
LocalNode *childNode = localUidMap.value(childId);
node->childNodes.append(childNode);
if (!childNode->collection.remoteId().isEmpty()) {
node->childRidMap.insert(childNode->collection.remoteId(), childNode);
}
}
}
// set our parent and add ourselves as child
if (localUidMap.contains(col.parentCollection().id())) {
LocalNode *parentNode = localUidMap.value(col.parentCollection().id());
parentNode->childNodes.append(node);
if (!node->collection.remoteId().isEmpty()) {
parentNode->childRidMap.insert(node->collection.remoteId(), node);
}
} else {
localPendingCollections[col.parentCollection().id()].append(col.id());
}
return node;
}
/** Same as createLocalNode() for remote collections. */
void createRemoteNode(const Collection &col)
{
if (col.remoteId().isEmpty()) {
kWarning() << "Collection '" << col.name() << "' does not have a remote identifier - skipping";
return;
}
RemoteNode *node = new RemoteNode(col);
rootRemoteNodes.append(node);
}
/** Create local nodes as we receive the local listing from the Akonadi server. */
void localCollectionsReceived(const Akonadi::Collection::List &localCols)
{
foreach (const Collection &c, localCols) {
createLocalNode(c);
knownLocalCollections++;
}
}
/** Once the local collection listing finished we can continue with the interesting stuff. */
void localCollectionFetchResult(KJob *job)
{
if (job->error()) {
return; // handled by the base class
}
// safety check: the local tree has to be connected
if (!localPendingCollections.isEmpty()) {
q->setError(Unknown);
q->setErrorText(i18n("Inconsistent local collection tree detected."));
q->emitResult();
return;
}
localListDone = true;
execute();
}
/**
* Find a child node with matching collection name.
* @note This is used as a fallback if the resource lost the RID update somehow.
* This can be used because the Akonadi server enforces unique child collection names inside the hierarchy
*/
LocalNode *findLocalChildNodeByName(LocalNode *localParentNode, const QString &name) const
{
if (name.isEmpty()) { // shouldn't happen...
return 0;
}
if (localParentNode == localRoot) { // possibly non-unique names on top-level
return 0;
}
foreach (LocalNode *childNode, localParentNode->childNodes) {
// the restriction on empty RIDs can possibly removed, but for now I only understand the implication for this case
if (childNode->collection.name() == name && childNode->collection.remoteId().isEmpty()) {
return childNode;
}
}
return 0;
}
/**
Find the local node that matches the given remote collection, returns 0
if that doesn't exist (yet).
*/
LocalNode *findMatchingLocalNode(const Collection &collection) const
{
if (!hierarchicalRIDs) {
if (localRidMap.contains(collection.remoteId())) {
return localRidMap.value(collection.remoteId());
}
return 0;
} else {
if (collection.id() == Collection::root().id() || collection.remoteId() == Collection::root().remoteId()) {
return localRoot;
}
LocalNode *localParent = 0;
if (collection.parentCollection().id() < 0 && collection.parentCollection().remoteId().isEmpty()) {
kWarning() << "Remote collection without valid parent found: " << collection;
return 0;
}
if (collection.parentCollection().id() == Collection::root().id() || collection.parentCollection().remoteId() == Collection::root().remoteId()) {
localParent = localRoot;
} else {
localParent = findMatchingLocalNode(collection.parentCollection());
}
if (localParent) {
if (localParent->childRidMap.contains(collection.remoteId())) {
return localParent->childRidMap.value(collection.remoteId());
}
// check if we have a local folder with a matching name and no RID, if so let's use that one
// we would get an error if we don't do this anyway, as we'd try to create two sibling nodes with the same name
if (LocalNode *recoveredLocalNode = findLocalChildNodeByName(localParent, collection.name())) {
kDebug() << "Recovering collection with lost RID:" << collection << recoveredLocalNode->collection;
return recoveredLocalNode;
}
}
return 0;
}
}
/**
Find the local node that is the nearest ancestor of the given remote collection
(when using hierarchical RIDs only, otherwise it's always the local root node).
Never returns 0.
*/
LocalNode *findBestLocalAncestor(const Collection &collection, bool *exactMatch = 0)
{
if (!hierarchicalRIDs) {
return localRoot;
}
if (collection == Collection::root()) {
if (exactMatch) {
*exactMatch = true;
}
return localRoot;
}
if (collection.parentCollection().id() < 0 && collection.parentCollection().remoteId().isEmpty()) {
kWarning() << "Remote collection without valid parent found: " << collection;
return 0;
}
bool parentIsExact = false;
LocalNode *localParent = findBestLocalAncestor(collection.parentCollection(), &parentIsExact);
if (!parentIsExact) {
if (exactMatch) {
*exactMatch = false;
}
return localParent;
}
if (localParent->childRidMap.contains(collection.remoteId())) {
if (exactMatch) {
*exactMatch = true;
}
return localParent->childRidMap.value(collection.remoteId());
}
if (exactMatch) {
*exactMatch = false;
}
return localParent;
}
/**
Checks if any of the remote nodes is not equal to the current local one. If so return true.
*/
bool checkPendingRemoteNodes() const
{
if (rootRemoteNodes.size() != knownLocalCollections) {
return true;
}
foreach (RemoteNode *remoteNode, rootRemoteNodes) {
// every remote note should have a local node already
LocalNode *localNode = findMatchingLocalNode(remoteNode->collection);
if (localNode) {
if (checkLocalCollection(localNode, remoteNode)) {
return true;
}
} else {
return true;
}
}
return false;
}
/**
Checks the pending remote nodes attached to the given local root node
to see if any of them can be processed by now. If not, they are moved to
the closest ancestor available.
*/
void processPendingRemoteNodes(LocalNode *_localRoot)
{
QList<RemoteNode *> pendingRemoteNodes(_localRoot->pendingRemoteNodes);
_localRoot->pendingRemoteNodes.clear();
QHash<LocalNode *, QList<RemoteNode *> > pendingCreations;
foreach (RemoteNode *remoteNode, pendingRemoteNodes) {
// step 1: see if we have a matching local node already
LocalNode *localNode = findMatchingLocalNode(remoteNode->collection);
if (localNode) {
Q_ASSERT(!localNode->processed);
updateLocalCollection(localNode, remoteNode);
continue;
}
// step 2: check if we have the parent at least, then we can create it
localNode = findMatchingLocalNode(remoteNode->collection.parentCollection());
if (localNode) {
pendingCreations[localNode].append(remoteNode);
continue;
}
// step 3: find the best matching ancestor and enqueue it for later processing
localNode = findBestLocalAncestor(remoteNode->collection);
if (!localNode) {
q->setError(Unknown);
q->setErrorText(i18n("Remote collection without root-terminated ancestor chain provided, resource is broken."));
q->emitResult();
return;
}
localNode->pendingRemoteNodes.append(remoteNode);
}
// process the now possible collection creations
for (QHash<LocalNode *, QList<RemoteNode *> >::const_iterator it = pendingCreations.constBegin();
it != pendingCreations.constEnd(); ++it) {
createLocalCollections(it.key(), it.value());
}
}
/**
Checks if the given localNode and remoteNode are different
*/
bool checkLocalCollection(LocalNode *localNode, RemoteNode *remoteNode) const
{
const Collection &localCollection = localNode->collection;
const Collection &remoteCollection = remoteNode->collection;
if (!keepLocalChanges.contains(CONTENTMIMETYPES)) {
if (localCollection.contentMimeTypes().size() != remoteCollection.contentMimeTypes().size()) {
return true;
} else {
for (int i = 0; i < remoteCollection.contentMimeTypes().size(); i++) {
const QString &m = remoteCollection.contentMimeTypes().at(i);
if (!localCollection.contentMimeTypes().contains(m)) {
return true;
}
}
}
}
if (localCollection.parentCollection().remoteId() != remoteCollection.parentCollection().remoteId()) {
return true;
}
if (localCollection.name() != remoteCollection.name()) {
return true;
}
if (localCollection.remoteId() != remoteCollection.remoteId()) {
return true;
}
if (localCollection.remoteRevision() != remoteCollection.remoteRevision()) {
return true;
}
if (!(localCollection.cachePolicy() == remoteCollection.cachePolicy())) {
return true;
}
// CollectionModifyJob adds the remote attributes to the local collection
foreach (const Attribute *attr, remoteCollection.attributes()) {
const Attribute *localAttr = localCollection.attribute(attr->type());
if (localAttr && keepLocalChanges.contains(attr->type())) {
continue;
}
// The attribute must both exist and have equal contents
if (!localAttr || localAttr->serialized() != attr->serialized()) {
return true;
}
}
return false;
}
/**
Performs a local update for the given node pair.
*/
void updateLocalCollection(LocalNode *localNode, RemoteNode *remoteNode)
{
Collection upd(remoteNode->collection);
Q_ASSERT(!upd.remoteId().isEmpty());
Q_ASSERT(currentTransaction);
upd.setId(localNode->collection.id());
if (keepLocalChanges.contains(CONTENTMIMETYPES)) {
upd.setContentMimeTypes(localNode->collection.contentMimeTypes());
}
foreach (Attribute *remoteAttr, upd.attributes()) {
if (keepLocalChanges.contains(remoteAttr->type()) && localNode->collection.hasAttribute(remoteAttr->type())) {
//We don't want to overwrite the attribute changes with the defaults provided by the resource.
Attribute *localAttr = localNode->collection.attribute(remoteAttr->type());
upd.removeAttribute(localAttr->type());
upd.addAttribute(localAttr->clone());
}
}
{
// ### HACK to work around the implicit move attempts of CollectionModifyJob
// which we do explicitly below
Collection c(upd);
c.setParentCollection(localNode->collection.parentCollection());
++pendingJobs;
CollectionModifyJob *mod = new CollectionModifyJob(c, currentTransaction);
connect(mod, SIGNAL(result(KJob*)), q, SLOT(updateLocalCollectionResult(KJob*)));
}
// detecting moves is only possible with global RIDs
if (!hierarchicalRIDs) {
LocalNode *oldParent = localUidMap.value(localNode->collection.parentCollection().id());
LocalNode *newParent = findMatchingLocalNode(remoteNode->collection.parentCollection());
// TODO: handle the newParent == 0 case correctly, ie. defer the move until the new
// local parent has been created
if (newParent && oldParent != newParent) {
++pendingJobs;
CollectionMoveJob *move = new CollectionMoveJob(upd, newParent->collection, currentTransaction);
connect(move, SIGNAL(result(KJob*)), q, SLOT(updateLocalCollectionResult(KJob*)));
}
}
localNode->processed = true;
delete remoteNode;
}
void updateLocalCollectionResult(KJob *job)
{
--pendingJobs;
if (job->error()) {
return; // handled by the base class
}
if (qobject_cast<CollectionModifyJob *>(job)) {
++progress;
}
checkDone();
}
/**
Creates local folders for the given local parent and remote nodes.
@todo group CollectionCreateJobs into a single one once it supports that
*/
void createLocalCollections(LocalNode *localParent, QList<RemoteNode *> remoteNodes)
{
foreach (RemoteNode *remoteNode, remoteNodes) {
++pendingJobs;
Collection col(remoteNode->collection);
Q_ASSERT(!col.remoteId().isEmpty());
col.setParentCollection(localParent->collection);
CollectionCreateJob *create = new CollectionCreateJob(col, currentTransaction);
create->setProperty(LOCAL_NODE, QVariant::fromValue(localParent));
create->setProperty(REMOTE_NODE, QVariant::fromValue(remoteNode));
connect(create, SIGNAL(result(KJob*)), q, SLOT(createLocalCollectionResult(KJob*)));
}
}
void createLocalCollectionResult(KJob *job)
{
--pendingJobs;
if (job->error()) {
return; // handled by the base class
}
const Collection newLocal = static_cast<CollectionCreateJob *>(job)->collection();
LocalNode *localNode = createLocalNode(newLocal);
localNode->processed = true;
LocalNode *localParent = job->property(LOCAL_NODE).value<LocalNode *>();
Q_ASSERT(localParent->childNodes.contains(localNode));
RemoteNode *remoteNode = job->property(REMOTE_NODE).value<RemoteNode *>();
delete remoteNode;
++progress;
processPendingRemoteNodes(localParent);
if (!hierarchicalRIDs) {
processPendingRemoteNodes(localRoot);
}
checkDone();
}
/**
Checks if the given local node has processed child nodes.
*/
bool hasProcessedChildren(LocalNode *localNode) const
{
if (localNode->processed) {
return true;
}
foreach (LocalNode *child, localNode->childNodes) {
if (hasProcessedChildren(child)) {
return true;
}
}
return false;
}
/**
Find all local nodes that are not marked as processed and have no children that
are marked as processed.
*/
Collection::List findUnprocessedLocalCollections(LocalNode *localNode) const
{
Collection::List rv;
if (!localNode->processed) {
if (hasProcessedChildren(localNode)) {
kWarning() << "Found unprocessed local node with processed children, excluding from deletion";
kWarning() << localNode->collection;
return rv;
}
if (localNode->collection.remoteId().isEmpty()) {
kWarning() << "Found unprocessed local node without remoteId, excluding from deletion";
kWarning() << localNode->collection;
return rv;
}
rv.append(localNode->collection);
return rv;
}
foreach (LocalNode *child, localNode->childNodes) {
rv.append(findUnprocessedLocalCollections(child));
}
return rv;
}
/**
Deletes unprocessed local nodes, in non-incremental mode.
*/
void deleteUnprocessedLocalNodes()
{
if (incremental) {
return;
}
const Collection::List cols = findUnprocessedLocalCollections(localRoot);
deleteLocalCollections(cols);
}
/**
Deletes the given collection list.
@todo optimize delete job to support batch operations
*/
void deleteLocalCollections(const Collection::List &cols)
{
q->setTotalAmount(KJob::Bytes, q->totalAmount(KJob::Bytes) + cols.size());
foreach (const Collection &col, cols) {
Q_ASSERT(!col.remoteId().isEmpty()); // empty RID -> stuff we haven't even written to the remote side yet
++pendingJobs;
Q_ASSERT(currentTransaction);
CollectionDeleteJob *job = new CollectionDeleteJob(col, currentTransaction);
connect(job, SIGNAL(result(KJob*)), q, SLOT(deleteLocalCollectionsResult(KJob*)));
// It can happen that the groupware servers report us deleted collections
// twice, in this case this collection delete job will fail on the second try.
// To avoid a rollback of the complete transaction we gracefully allow the job
// to fail :)
currentTransaction->setIgnoreJobFailure(job);
}
}
void deleteLocalCollectionsResult(KJob *)
{
--pendingJobs;
++progress;
checkDone();
}
/**
Check update necessity.
*/
void checkUpdateNecessity()
{
bool updateNeeded = checkPendingRemoteNodes();
if (!updateNeeded) {
// We can end right now
q->emitResult();
return;
}
// Since there are differences with the remote collections we need to sync. Start a transaction here.
Q_ASSERT(!currentTransaction);
currentTransaction = new TransactionSequence(q);
currentTransaction->setAutomaticCommittingEnabled(false);
q->connect(currentTransaction, SIGNAL(result(KJob*)), SLOT(transactionSequenceResult(KJob*)));
// Now that a transaction is started we need to fetch local collections again and do the update
q->doStart();
}
/** After the transaction has finished report we're done as well. */
void transactionSequenceResult(KJob *job)
{
if (job->error()) {
return; // handled by the base class
}
q->emitResult();
}
/**
Process what's currently available.
*/
void execute()
{
kDebug() << Q_FUNC_INFO << "localListDone: " << localListDone << " deliveryDone: " << deliveryDone;
if (!localListDone || !deliveryDone) {
return;
}
// If a transaction is not started yet we are still checking if the update is
// actually needed.
if (!currentTransaction) {
checkUpdateNecessity();
return;
}
// Since the transaction is already running we need to execute the update.
processPendingRemoteNodes(localRoot);
if (!incremental && deliveryDone) {
deleteUnprocessedLocalNodes();
}
if (!hierarchicalRIDs) {
deleteLocalCollections(removedRemoteCollections);
} else {
Collection::List localCols;
foreach (const Collection &c, removedRemoteCollections) {
LocalNode *node = findMatchingLocalNode(c);
if (node) {
localCols.append(node->collection);
}
}
deleteLocalCollections(localCols);
}
removedRemoteCollections.clear();
checkDone();
}
/**
Finds pending remote nodes, which at the end of the day should be an empty set.
*/
QList<RemoteNode *> findPendingRemoteNodes(LocalNode *localNode)
{
QList<RemoteNode *> rv;
rv.append(localNode->pendingRemoteNodes);
foreach (LocalNode *child, localNode->childNodes) {
rv.append(findPendingRemoteNodes(child));
}
return rv;
}
/**
Are we there yet??
@todo progress reporting
*/
void checkDone()
{
q->setProcessedAmount(KJob::Bytes, progress);
// still running jobs or not fully delivered local/remote state
if (!deliveryDone || pendingJobs > 0 || !localListDone) {
return;
}
// safety check: there must be no pending remote nodes anymore
QList<RemoteNode *> orphans = findPendingRemoteNodes(localRoot);
if (!orphans.isEmpty()) {
q->setError(Unknown);
q->setErrorText(i18n("Found unresolved orphan collections"));
foreach (RemoteNode *orphan, orphans) {
kDebug() << "found orphan collection:" << orphan->collection;
}
q->emitResult();
return;
}
kDebug() << Q_FUNC_INFO << "q->commit()";
Q_ASSERT(currentTransaction);
currentTransaction->commit();
}
CollectionSync *q;
QString resourceId;
int pendingJobs;
int progress;
LocalNode *localRoot;
TransactionSequence *currentTransaction;
QHash<Collection::Id, LocalNode *> localUidMap;
QHash<QString, LocalNode *> localRidMap;
// temporary during build-up of the local node tree, must be empty afterwards
QHash<Collection::Id, QVector<Collection::Id> > localPendingCollections;
// removed remote collections in incremental mode
Collection::List removedRemoteCollections;
// used to store the list of remote nodes passed by the user
QList<RemoteNode *> rootRemoteNodes;
// keep track of the total number of local collections that are known
// only used during the preliminary check to see if updating is needed
int knownLocalCollections;
bool incremental;
bool streaming;
bool hierarchicalRIDs;
bool localListDone;
bool deliveryDone;
// List of parts where local changes should not be overwritten
QSet<QByteArray> keepLocalChanges;
};
CollectionSync::CollectionSync(const QString &resourceId, QObject *parent)
: Job(parent)
, d(new Private(this))
{
d->resourceId = resourceId;
setTotalAmount(KJob::Bytes, 0);
}
CollectionSync::~CollectionSync()
{
delete d;
}
void CollectionSync::setRemoteCollections(const Collection::List &remoteCollections)
{
setTotalAmount(KJob::Bytes, totalAmount(KJob::Bytes) + remoteCollections.count());
foreach (const Collection &c, remoteCollections) {
d->createRemoteNode(c);
}
if (!d->streaming) {
d->deliveryDone = true;
}
d->execute();
}
void CollectionSync::setRemoteCollections(const Collection::List &changedCollections, const Collection::List &removedCollections)
{
setTotalAmount(KJob::Bytes, totalAmount(KJob::Bytes) + changedCollections.count());
d->incremental = true;
foreach (const Collection &c, changedCollections) {
d->createRemoteNode(c);
}
d->removedRemoteCollections += removedCollections;
if (!d->streaming) {
d->deliveryDone = true;
}
d->execute();
}
void CollectionSync::doStart()
{
d->resetNodeTree();
Job *parent = (d->currentTransaction ? static_cast<Job *>(d->currentTransaction) : static_cast<Job *>(this));
CollectionFetchJob *job = new CollectionFetchJob(Collection::root(), CollectionFetchJob::Recursive, parent);
job->fetchScope().setResource(d->resourceId);
job->fetchScope().setIncludeUnsubscribed(true);
job->fetchScope().setAncestorRetrieval(CollectionFetchScope::Parent);
connect(job, SIGNAL(collectionsReceived(Akonadi::Collection::List)),
SLOT(localCollectionsReceived(Akonadi::Collection::List)));
connect(job, SIGNAL(result(KJob*)), SLOT(localCollectionFetchResult(KJob*)));
}
void CollectionSync::setStreamingEnabled(bool streaming)
{
d->streaming = streaming;
}
void CollectionSync::retrievalDone()
{
d->deliveryDone = true;
d->execute();
}
void CollectionSync::setHierarchicalRemoteIds(bool hierarchical)
{
d->hierarchicalRIDs = hierarchical;
}
void CollectionSync::rollback()
{
if (d->currentTransaction) {
d->currentTransaction->rollback();
}
}
void CollectionSync::setKeepLocalChanges(const QSet<QByteArray> &parts)
{
d->keepLocalChanges = parts;
}
#include "moc_collectionsync_p.cpp"
|