[sociald] Use CleanUpPurge mode for cleanUp() codepath. Contributes t…

…o JB#20682

This commit ensures that the plugin is aware that it is performing a
purge for the cleanUp() account-removal case.  In that case, the sync
function will NOT have been called, and so any setup / initialization
which would normally be performed in that function, needs to be done
prior to the purge, and any state finalization needs to be committed
afterward.

In practice, this means that calendar data gets correctly purged from
the databases when the account is deleted.

Contributes to JB#20682

src/common/socialdbuteoplugin.cpp

@@ -205,10 +205,9 @@ bool SocialdButeoPlugin::cleanUp()
         m_socialNetworkSyncAdaptor = createSocialNetworkSyncAdaptor();
     }
 
-    // TODO: ensure that this is ONLY called when the account is deleted,
-    // not when the plugin is unloaded.
     if (m_socialNetworkSyncAdaptor && m_profileAccountId > 0) {
-        m_socialNetworkSyncAdaptor->purgeDataForOldAccounts(QList<int>() << m_profileAccountId);
+        m_socialNetworkSyncAdaptor->purgeDataForOldAccounts(QList<int>() << m_profileAccountId,
+                                                            SocialNetworkSyncAdaptor::CleanUpPurge);
     }
 
     return true;

src/common/socialnetworksyncadaptor.h

@@ -58,6 +58,11 @@ class SocialNetworkSyncAdaptor : public QObject
         Invalid
     };
 
+    enum PurgeMode {
+        SyncPurge = 0,
+        CleanUpPurge
+    };
+
     enum DataType {
         Contacts = 1,   // "Contacts"
         Calendars,      // "Calendars"
@@ -84,7 +89,7 @@ class SocialNetworkSyncAdaptor : public QObject
     QString serviceName() const;
     void checkAccounts(SocialNetworkSyncAdaptor::DataType dataType, QList<int> *newIds, QList<int> *purgeIds, QList<int> *updateIds);
     virtual void sync(const QString &dataType, int accountId = 0);
-    virtual void purgeDataForOldAccounts(const QList<int> &accountIds) = 0;
+    virtual void purgeDataForOldAccounts(const QList<int> &accountIds, PurgeMode mode = SyncPurge) = 0;
 
 Q_SIGNALS:
     void statusChanged();

src/facebook/facebook-calendars/facebookcalendarsyncadaptor.cpp

@@ -72,8 +72,14 @@ void FacebookCalendarSyncAdaptor::finalCleanup()
     m_storage->close();
 }
 
-void FacebookCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldIds)
+void FacebookCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode)
 {
+    if (mode == SocialNetworkSyncAdaptor::CleanUpPurge) {
+        // we need to initialise the storage
+        m_storageNeedsSave = false;
+        m_storage->open(); // we close it in finalCleanup()
+    }
+
     // We clean all the entries in the calendar
     foreach (int accountId, oldIds) {
         QList<FacebookEvent::ConstPtr> events = m_db.events(accountId);
@@ -104,6 +110,11 @@ void FacebookCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldI
         m_db.sync(accountId);
         m_db.wait();
     }
+
+    if (mode == SocialNetworkSyncAdaptor::CleanUpPurge) {
+        // and commit any changes made.
+        finalCleanup();
+    }
 }
 
 void FacebookCalendarSyncAdaptor::beginSync(int accountId, const QString &accessToken)

src/facebook/facebook-calendars/facebookcalendarsyncadaptor.h

@@ -42,7 +42,7 @@ class FacebookCalendarSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalCleanup();
 

src/facebook/facebook-contacts/facebookcontactsyncadaptor.cpp

@@ -197,7 +197,7 @@ void FacebookContactSyncAdaptor::sync(const QString &dataTypeString, int account
     FacebookDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void FacebookContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void FacebookContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     foreach (int pid, purgeIds) {
         // first, purge all data from QtContacts and also our cache db.

src/facebook/facebook-contacts/facebookcontactsyncadaptor.h

@@ -54,7 +54,7 @@ class FacebookContactSyncAdaptor : public FacebookDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
     void finalCleanup();

src/facebook/facebook-images/facebookimagesyncadaptor.cpp

@@ -70,7 +70,7 @@ void FacebookImageSyncAdaptor::sync(const QString &dataTypeString, int accountId
     FacebookDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void FacebookImageSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void FacebookImageSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     foreach (int pid, purgeIds) {
         // first, purge the data from our database + our cache directory

src/facebook/facebook-images/facebookimagesyncadaptor.h

@@ -49,7 +49,7 @@ class FacebookImageSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
 

src/facebook/facebook-notifications/facebooknotificationsyncadaptor.cpp

@@ -43,7 +43,7 @@ QString FacebookNotificationSyncAdaptor::syncServiceName() const
     return QStringLiteral("facebook-microblog");
 }
 
-void FacebookNotificationSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void FacebookNotificationSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     if (purgeIds.size()) {
         foreach (int accountIdentifier, purgeIds) {

src/facebook/facebook-notifications/facebooknotificationsyncadaptor.h

@@ -38,7 +38,7 @@ class FacebookNotificationSyncAdaptor : public FacebookDataTypeSyncAdaptor
     QString syncServiceName() const;
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
 

src/facebook/facebook-posts/facebookpostsyncadaptor.cpp

@@ -113,7 +113,7 @@ void FacebookPostSyncAdaptor::sync(const QString &dataTypeString, int accountId)
     FacebookDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void FacebookPostSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void FacebookPostSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     if (purgeIds.size()) {
         foreach (int accountIdentifier, purgeIds) {

src/facebook/facebook-posts/facebookpostsyncadaptor.h

@@ -52,7 +52,7 @@ class FacebookPostSyncAdaptor : public FacebookDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
 

src/facebook/facebook-signon/facebooksignonsyncadaptor.cpp

@@ -50,7 +50,7 @@ void FacebookSignonSyncAdaptor::sync(const QString &dataTypeString, int accountI
     FacebookDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void FacebookSignonSyncAdaptor::purgeDataForOldAccounts(const QList<int> &)
+void FacebookSignonSyncAdaptor::purgeDataForOldAccounts(const QList<int> &, SocialNetworkSyncAdaptor::PurgeMode)
 {
     // Nothing to do.
 }

src/facebook/facebook-signon/facebooksignonsyncadaptor.h

@@ -52,7 +52,7 @@ class FacebookSignonSyncAdaptor : public FacebookDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing FacebookDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
 

src/google/google-calendars/googlecalendarsyncadaptor.cpp

@@ -365,11 +365,19 @@ void GoogleCalendarSyncAdaptor::finalCleanup()
             succeededAccounts.append(accountId);
         }
     }
-    setLastSyncSuccessful(succeededAccounts);
+    if (succeededAccounts.size()) {
+        setLastSyncSuccessful(succeededAccounts);
+    }
 }
 
-void GoogleCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldIds)
+void GoogleCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode)
 {
+    if (mode == SocialNetworkSyncAdaptor::CleanUpPurge) {
+        // need to initialise the database
+        m_storageNeedsSave = false;
+        m_storage->open(); // we close it in finalCleanup()
+    }
+
     // We clean all the entries in the calendar
     foreach (int accountId, oldIds) {
         // Delete the notebooks from the storage
@@ -392,6 +400,11 @@ void GoogleCalendarSyncAdaptor::purgeDataForOldAccounts(const QList<int> &oldIds
         // Delete ids from our local->remote id mapping
         m_idDb.removeEvents(accountId);
     }
+
+    if (mode == SocialNetworkSyncAdaptor::CleanUpPurge) {
+        // and commit any changes made.
+        finalCleanup();
+    }
 }
 
 void GoogleCalendarSyncAdaptor::beginSync(int accountId, const QString &accessToken)

src/google/google-calendars/googlecalendarsyncadaptor.h

@@ -47,7 +47,7 @@ class GoogleCalendarSyncAdaptor : public GoogleDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId);
 
 protected: // implementing GoogleDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalCleanup();
 

src/google/google-contacts/googlecontactsyncadaptor.cpp

@@ -111,10 +111,9 @@ void GoogleContactSyncAdaptor::sync(const QString &dataTypeString, int accountId
     GoogleDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void GoogleContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void GoogleContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     foreach (int pid, purgeIds) {
-        // first, purge all data from QtContacts
         purgeAccount(pid);
     }
 }

src/google/google-contacts/googlecontactsyncadaptor.h

@@ -52,7 +52,7 @@ class GoogleContactSyncAdaptor : public GoogleDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing GoogleDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalCleanup();
 

src/google/google-contacts/googletwowaycontactsyncadaptor.cpp

@@ -94,7 +94,7 @@ void GoogleTwoWayContactSyncAdaptor::sync(const QString &dataTypeString, int acc
     GoogleDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void GoogleTwoWayContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void GoogleTwoWayContactSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode )
 {
     foreach (int pid, purgeIds) {
         purgeAccount(pid);

src/google/google-contacts/googletwowaycontactsyncadaptor.h

@@ -59,7 +59,7 @@ class GoogleTwoWayContactSyncAdaptor : public GoogleDataTypeSyncAdaptor, public
 
 protected:
     // implementing GoogleDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
     void finalCleanup();

src/google/google-signon/googlesignonsyncadaptor.cpp

@@ -51,7 +51,7 @@ void GoogleSignonSyncAdaptor::sync(const QString &dataTypeString, int accountId)
     GoogleDataTypeSyncAdaptor::sync(dataTypeString, accountId);
 }
 
-void GoogleSignonSyncAdaptor::purgeDataForOldAccounts(const QList<int> &)
+void GoogleSignonSyncAdaptor::purgeDataForOldAccounts(const QList<int> &, SocialNetworkSyncAdaptor::PurgeMode)
 {
     // Nothing to do.
 }

src/google/google-signon/googlesignonsyncadaptor.h

@@ -52,7 +52,7 @@ class GoogleSignonSyncAdaptor : public GoogleDataTypeSyncAdaptor
     void sync(const QString &dataTypeString, int accountId = 0);
 
 protected: // implementing GoogleDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &accessToken);
     void finalize(int accountId);
 

src/twitter/twitter-notifications/twittermentiontimelinesyncadaptor.cpp

@@ -50,7 +50,7 @@ QString TwitterMentionTimelineSyncAdaptor::syncServiceName() const
     return QStringLiteral("twitter-microblog");
 }
 
-void TwitterMentionTimelineSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void TwitterMentionTimelineSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     foreach (int accountIdentifier, purgeIds) {
         Notification *notification = findNotification(accountIdentifier);

src/twitter/twitter-notifications/twittermentiontimelinesyncadaptor.h

@@ -44,7 +44,7 @@ class TwitterMentionTimelineSyncAdaptor : public TwitterDataTypeSyncAdaptor
     QString syncServiceName() const;
 
 protected: // implementing TwitterDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &oauthToken, const QString &oauthTokenSecret);
 
 private:

src/twitter/twitter-posts/twitterhometimelinesyncadaptor.cpp

@@ -36,7 +36,7 @@ TwitterHomeTimelineSyncAdaptor::~TwitterHomeTimelineSyncAdaptor()
 {
 }
 
-void TwitterHomeTimelineSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds)
+void TwitterHomeTimelineSyncAdaptor::purgeDataForOldAccounts(const QList<int> &purgeIds, SocialNetworkSyncAdaptor::PurgeMode)
 {
     if (purgeIds.size()) {
         foreach (int accountIdentifier, purgeIds) {

src/twitter/twitter-posts/twitterhometimelinesyncadaptor.h

@@ -47,7 +47,7 @@ class TwitterHomeTimelineSyncAdaptor : public TwitterDataTypeSyncAdaptor
     QString syncServiceName() const;
 
 protected: // implementing TwitterDataTypeSyncAdaptor interface
-    void purgeDataForOldAccounts(const QList<int> &oldIds);
+    void purgeDataForOldAccounts(const QList<int> &oldIds, SocialNetworkSyncAdaptor::PurgeMode mode);
     void beginSync(int accountId, const QString &oauthToken, const QString &oauthTokenSecret);
     void finalize(int accountId);
 

tests/tst_facebook/tst_facebook.cpp

@@ -81,7 +81,7 @@ class TestFacebookContactSyncAdaptor : public FacebookContactSyncAdaptor
     TestFacebookContactSyncAdaptor(QObject *parent)
         : FacebookContactSyncAdaptor(parent), m_doFinalCleanup(false) {}
     void doBeginSync(int accountId, const QString &accessToken) { beginSync(accountId, accessToken); }
-    void doPurge(int accountId) { purgeDataForOldAccounts(QList<int>() << accountId); }
+    void doPurge(int accountId) { purgeDataForOldAccounts(QList<int>() << accountId, SocialNetworkSyncAdaptor::SyncPurge); }
 protected:
     // override this to avoid auto purging the fake account contacts when sync finishes.
     void finalCleanup() { if (m_doFinalCleanup) FacebookContactSyncAdaptor::finalCleanup(); }