File: SyncMLServer.cpp

package info (click to toggle)
buteo-sync-plugins 0.8.36-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,076 kB
  • sloc: cpp: 8,130; xml: 755; sh: 207; perl: 82; makefile: 11
file content (628 lines) | stat: -rw-r--r-- 17,678 bytes parent folder | download
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
/*
* This file is part of buteo-sync-plugins package
*
* Copyright (C) 2013 Jolla Ltd. and/or its subsidiary(-ies).
*
* Author: Sateesh Kavuri <sateesh.kavuri@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#include "SyncMLServer.h"
#include "SyncMLPluginLogging.h"

#include <buteosyncfw5/SyncProfile.h>
#include <buteosyncml5/OBEXTransport.h>
#include <buteosyncml5/SyncAgentConfig.h>
#include <buteosyncfw5/PluginCbInterface.h>

#include "SyncMLConfig.h"
#include "DeviceInfo.h"

Buteo::ServerPlugin* SyncMLServerLoader::createServerPlugin(
        const QString& pluginName,
        const Buteo::Profile& profile,
        Buteo::PluginCbInterface* cbInterface)
{
    return new SyncMLServer(pluginName, profile, cbInterface);
}


SyncMLServer::SyncMLServer (const QString& pluginName,
                            const Buteo::Profile profile,
                            Buteo::PluginCbInterface *cbInterface) :
    ServerPlugin (pluginName, profile, cbInterface), mAgent (0), mConfig (0),
    mTransport (0), mCommittedItems (0), mConnectionType (Sync::CONNECTIVITY_USB),
    mIsSessionInProgress (false), mBTActive (false), mUSBActive (false)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
}

SyncMLServer::~SyncMLServer ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    closeSyncAgentConfig ();
    closeSyncAgent ();
    if (mUSBActive)
        closeUSBTransport ();
    if (mBTActive)
        closeBTTransport ();
    delete mTransport;
}

bool
SyncMLServer::init ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    return true;
}

bool
SyncMLServer::uninit ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    closeSyncAgentConfig ();
    closeSyncAgent ();

    // uninit() is called after completion of every sync session
    // Do not invoke close of transports, since in server mode
    // sync would be initiated from external entities and so
    // transport has to be open

    return true;
}

void
SyncMLServer::abortSync (Sync::SyncStatus status)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    DataSync::SyncState state = DataSync::ABORTED;

    if (status == Sync::SYNC_ERROR)
        state = DataSync::CONNECTION_ERROR;

    if (mAgent && mAgent->abort (state))
    {
        qCDebug(lcSyncMLPlugin) << "Signaling SyncML agent abort";
    } else
    {
        handleSyncFinished (DataSync::ABORTED);
    }
}

bool
SyncMLServer::cleanUp ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    // FIXME: Perform necessary cleanup
    return true;
}

Buteo::SyncResults
SyncMLServer::getSyncResults () const
{
    return mResults;
}

bool
SyncMLServer::startListen ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Starting listener";

    bool listening = false;
    if (iCbInterface->isConnectivityAvailable (Sync::CONNECTIVITY_USB))
    {
        mUSBActive = listening = createUSBTransport ();
    }
    
    if (iCbInterface->isConnectivityAvailable (Sync::CONNECTIVITY_BT))
    {
        mBTActive = listening |= createBTTransport ();
    }
    
    if (iCbInterface->isConnectivityAvailable (Sync::CONNECTIVITY_INTERNET))
    {
        // No sync over IP as of now
    }

    return listening;
}

void
SyncMLServer::stopListen ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    // Stop all connections
    if (mUSBActive)
        closeUSBTransport ();
    if (mBTActive)
        closeBTTransport ();
}

void
SyncMLServer::suspend ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    // Not implementing suspend
}

void
SyncMLServer::resume ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    // Not implementing suspend
}

void
SyncMLServer::connectivityStateChanged (Sync::ConnectivityType type, bool state)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Connectivity state changed event " << type << ". Connectivity changed to " << state;

    if (type == Sync::CONNECTIVITY_USB)
    {
        // Only connectivity changes would be USB enabled/disabled
        if (state)
        {
            qCDebug(lcSyncMLPlugin) << "USB available. Starting sync...";
            mUSBActive = createUSBTransport ();
        } else {
            qCDebug(lcSyncMLPlugin) << "USB connection not available. Stopping sync...";
            closeUSBTransport ();
            mUSBActive = false;

            // FIXME: Should we also abort any ongoing sync session?
        }
    } else if (type == Sync::CONNECTIVITY_BT)
    {
        if (state)
        {
            qCDebug(lcSyncMLPlugin) << "BT connection is available. Creating BT connection...";
            mBTActive = createBTTransport ();
        } else
        {
            qCDebug(lcSyncMLPlugin) << "BT connection unavailable. Closing BT connection...";
            closeBTTransport ();
            mBTActive = false;
        }
    }
}

bool
SyncMLServer::initSyncAgent ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Creating SyncML agent...";

    mAgent = new DataSync::SyncAgent ();
    return true;
}

void
SyncMLServer::closeSyncAgent ()
{
    delete mAgent;
    mAgent = 0;
}

DataSync::SyncAgentConfig*
SyncMLServer::initSyncAgentConfig ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    if (!mTransport || !mStorageProvider.init (&iProfile, this, iCbInterface, true))
        return 0;

    mConfig = new DataSync::SyncAgentConfig ();

    QString defaultSyncMLConfigFile, extSyncMLConfigFile;
    SyncMLConfig::syncmlConfigFilePaths (defaultSyncMLConfigFile, extSyncMLConfigFile);
    if (!mConfig->fromFile (defaultSyncMLConfigFile))
    {
        qCCritical(lcSyncMLPlugin) << "Unable to read default SyncML config";
        delete mConfig;
        mConfig = 0;
        return mConfig;
    }

    if (!mConfig->fromFile (extSyncMLConfigFile))
    {
        qCDebug(lcSyncMLPlugin) << "Could not find external configuration file";
    }

    mConfig->setStorageProvider (&mStorageProvider);
    mConfig->setTransport (mTransport);

    // Do we need to read the device info from file?
    QString DEV_INFO_FILE = SyncMLConfig::getDevInfoFile ();
    QFile devInfoFile (DEV_INFO_FILE);

    if (!devInfoFile.exists ())
    {
        Buteo::DeviceInfo devInfo;
        QMap<QString,QString> deviceInfoMap = devInfo.getDeviceInformation ();
        devInfo.saveDevInfoToFile (deviceInfoMap, DEV_INFO_FILE);
    }

    DataSync::DeviceInfo syncDeviceInfo;
    syncDeviceInfo.readFromFile (DEV_INFO_FILE);
    mConfig->setDeviceInfo (syncDeviceInfo);

    return mConfig;
}

void
SyncMLServer::closeSyncAgentConfig ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Closing config...";

    delete mConfig;
    mConfig = 0;

    if (!mStorageProvider.uninit ())
        qCCritical(lcSyncMLPlugin) << "Unable to close storage provider";
}

bool
SyncMLServer::createUSBTransport ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Opening new USB connection";

    mUSBConnection.connect ();

    QObject::connect (&mUSBConnection, SIGNAL (usbConnected (int)),
                      this, SLOT (handleUSBConnected (int)));

    return mUSBConnection.isConnected ();
}

bool
SyncMLServer::createBTTransport ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    
    qCDebug(lcSyncMLPlugin) << "Creating new BT connection";
    bool btInitRes = mBTConnection.init ();
    
    QObject::connect (&mBTConnection, SIGNAL (btConnected (int, QString)),
                      this, SLOT (handleBTConnected (int, QString)));
    
    return btInitRes;
}

void
SyncMLServer::closeUSBTransport ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    QObject::disconnect (&mUSBConnection, SIGNAL (usbConnected (int)),
                this, SLOT (handleUSBConnected (int)));
    mUSBConnection.disconnect ();
}

void
SyncMLServer::closeBTTransport ()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    
    QObject::disconnect (&mBTConnection, SIGNAL (btConnected (int, QString)),
                         this, SLOT (handleBTConnected (int, QString)));
    mBTConnection.uninit ();
}

void
SyncMLServer::handleUSBConnected (int fd)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    Q_UNUSED (fd);

    if (mIsSessionInProgress)
    {
        qCDebug(lcSyncMLPlugin) << "Sync session is in progress over transport " << mConnectionType;
        emit sessionInProgress (mConnectionType);
        return;
    }

    qCDebug(lcSyncMLPlugin) << "New incoming data over USB";

    if (mTransport == NULL)
    {
        mTransport = new DataSync::OBEXTransport (mUSBConnection,
                                              DataSync::OBEXTransport::MODE_OBEX_SERVER,
                                              DataSync::OBEXTransport::TYPEHINT_USB);
    }
    
    if (!mTransport)
    {
        qCDebug(lcSyncMLPlugin) << "Creation of USB transport failed";
        return;
    }

    if (!mAgent)
    {
        mConnectionType = Sync::CONNECTIVITY_USB;
        startNewSession ("USB");
    }
}

void
SyncMLServer::handleBTConnected (int fd, QString btAddr)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    Q_UNUSED (fd);

    if (mIsSessionInProgress)
    {
        qCDebug(lcSyncMLPlugin) << "Sync session is in progress over transport " << mConnectionType;
        emit sessionInProgress (mConnectionType);
        return;
    }

    qCDebug(lcSyncMLPlugin) << "New incoming connection over BT";
    
    if (mTransport == NULL)
    {
        mTransport = new DataSync::OBEXTransport (mBTConnection,
                                              DataSync::OBEXTransport::MODE_OBEX_SERVER,
                                              DataSync::OBEXTransport::TYPEHINT_BT);
    }
    
    if (!mTransport)
    {
        qCDebug(lcSyncMLPlugin) << "Creation of BT transport failed";
        return;
    }
    
    if (!mAgent)
    {
        mConnectionType = Sync::CONNECTIVITY_BT;
        startNewSession (btAddr);
    }
}

bool
SyncMLServer::startNewSession (QString address)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    if (!initSyncAgent () || !initSyncAgentConfig ())
        return false;

    QObject::connect (mAgent, SIGNAL (stateChanged (DataSync::SyncState)),
             this, SLOT (handleStateChanged (DataSync::SyncState)));
    QObject::connect (mAgent, SIGNAL (syncFinished (DataSync::SyncState)),
             this, SLOT (handleSyncFinished (DataSync::SyncState)));
    QObject::connect (mAgent, SIGNAL (storageAccquired (QString)),
             this, SLOT (handleStorageAccquired (QString)));
    QObject::connect (mAgent, SIGNAL (itemProcessed (DataSync::ModificationType, DataSync::ModifiedDatabase, QString, QString, int)),
             this, SLOT (handleItemProcessed (DataSync::ModificationType, DataSync::ModifiedDatabase, QString, QString, int)));

    mIsSessionInProgress = true;

    if (mAgent->listen (*mConfig))
    {
        emit newSession (address);
        return true;
    } else
    {
        return false;
    }
}

void
SyncMLServer::handleStateChanged (DataSync::SyncState state)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "SyncML new state " << state;
}

void
SyncMLServer::handleSyncFinished (DataSync::SyncState state)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Sync finished with state " << state;
    bool errorStatus = true;

    switch (state)
    {
    case DataSync::SUSPENDED:
    case DataSync::ABORTED:
    case DataSync::SYNC_FINISHED:
    {
        generateResults (true);
        errorStatus = false;
        emit success(getProfileName(), QString::number(state));
        break;
    }

    case DataSync::INTERNAL_ERROR:
    case DataSync::DATABASE_FAILURE:
    case DataSync::CONNECTION_ERROR:
    case DataSync::INVALID_SYNCML_MESSAGE:
    {
        generateResults (false);
        emit error(getProfileName(), QString::number(state), Buteo::SyncResults::INTERNAL_ERROR);
        break;
    }

    default:
    {
        qCCritical(lcSyncMLPlugin) << "Unexpected state change";
        generateResults (false);

        emit error(getProfileName(), QString::number(state), Buteo::SyncResults::INTERNAL_ERROR);
        break;
    }
    }

    uninit ();

    // Signal the USBConnection that sync has finished
    if (mConnectionType == Sync::CONNECTIVITY_USB)
        mUSBConnection.handleSyncFinished (errorStatus);
    else if (mConnectionType == Sync::CONNECTIVITY_BT)
        mBTConnection.handleSyncFinished (errorStatus);

    mIsSessionInProgress = false;
}

void
SyncMLServer::handleStorageAccquired (QString type)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    // emit signal that storage has been acquired
    emit accquiredStorage (type);
}

void
SyncMLServer::handleItemProcessed (DataSync::ModificationType modificationType,
                                   DataSync::ModifiedDatabase modifiedDb,
                                   QString localDb,
                                   QString dbType,
                                   int committedItems)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    qCDebug(lcSyncMLPlugin) << "Modification type:" << modificationType;
    qCDebug(lcSyncMLPlugin) << "ModificationType database:" << modifiedDb;
    qCDebug(lcSyncMLPlugin) << "Local database:" << localDb;
    qCDebug(lcSyncMLPlugin) << "Database type:" << dbType;
    qCDebug(lcSyncMLPlugin) << "Committed items:" << committedItems;

    mCommittedItems++;

    if (!receivedItems.contains (localDb))
    {
        ReceivedItemDetails details;
        details.added = details.modified = details.deleted = details.error = 0;
        details.mime = dbType;
        receivedItems[localDb] = details;
    }

    switch (modificationType)
    {
    case DataSync::MOD_ITEM_ADDED:
    {
        ++receivedItems[localDb].added;
        break;
    }
    case DataSync::MOD_ITEM_MODIFIED:
    {
        ++receivedItems[localDb].modified;
        break;
    }
    case DataSync::MOD_ITEM_DELETED:
    {
        ++receivedItems[localDb].deleted;
        break;
    }
    case DataSync::MOD_ITEM_ERROR:
    {
        ++receivedItems[localDb].error;
        break;
    }
    default:
    {
        Q_ASSERT (0);
        break;
    }
    }

    Sync::TransferDatabase db = Sync::LOCAL_DATABASE;
    if (modifiedDb == DataSync::MOD_LOCAL_DATABASE)
        db = Sync::LOCAL_DATABASE;
    else
        db = Sync::REMOTE_DATABASE;

    if (mCommittedItems == committedItems)
    {
        QMapIterator<QString, ReceivedItemDetails> itr (receivedItems);
        while (itr.hasNext ())
        {
            itr.next ();
            if (itr.value ().added)
                emit transferProgress (getProfileName (), db, Sync::ITEM_ADDED, itr.value ().mime, itr.value ().added);
            if (itr.value ().modified)
                emit transferProgress (getProfileName (), db, Sync::ITEM_MODIFIED, itr.value ().mime, itr.value ().modified);
            if (itr.value ().deleted)
                emit transferProgress (getProfileName (), db, Sync::ITEM_DELETED, itr.value ().mime, itr.value ().deleted);
            if (itr.value ().error)
                emit transferProgress (getProfileName (), db, Sync::ITEM_ERROR, itr.value ().mime, itr.value ().error);
        }

        mCommittedItems = 0;
        receivedItems.clear ();
    }
}

void
SyncMLServer::generateResults (bool success)
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    mResults.setMajorCode (success ? Buteo::SyncResults::SYNC_RESULT_SUCCESS : Buteo::SyncResults::SYNC_RESULT_FAILED);

    mResults.setTargetId (mAgent->getResults().getRemoteDeviceId ());
    const QMap<QString, DataSync::DatabaseResults>* dbResults = mAgent->getResults ().getDatabaseResults ();

    if (dbResults->isEmpty ())
    {
        qCDebug(lcSyncMLPlugin) << "No items transferred";
    }
    else
    {
        QMapIterator<QString, DataSync::DatabaseResults> itr (*dbResults);
        while (itr.hasNext ())
        {
            itr.next ();
            const DataSync::DatabaseResults& r = itr.value ();
            Buteo::TargetResults targetResults(
                    itr.key(), // Target name
                    Buteo::ItemCounts (r.iLocalItemsAdded,
                                       r.iLocalItemsDeleted,
                                       r.iLocalItemsModified),
                    Buteo::ItemCounts (r.iRemoteItemsAdded,
                                       r.iRemoteItemsDeleted,
                                       r.iRemoteItemsModified));
            mResults.addTargetResults (targetResults);

            qCDebug(lcSyncMLPlugin) << "Items for" << targetResults.targetName () << ":";
            qCDebug(lcSyncMLPlugin) << "LA:" << targetResults.localItems ().added <<
                      "LD:" << targetResults.localItems ().deleted <<
                      "LM:" << targetResults.localItems ().modified <<
                      "RA:" << targetResults.remoteItems ().added <<
                      "RD:" << targetResults.remoteItems ().deleted <<
                      "RM:" << targetResults.remoteItems ().modified;
        }
    }
}