Merge lp:~mardy/signon-ui/persistent-cookies into lp:signon-ui

[Alberto Mardegan]

Implement persistent cookie storage

Cookies are saved into ~/.cache/signon-ui/cookies/<id>.jar

[jenkins (martin-mrazik+qa)]

FAILED: Continuous integration, rev:49
http://s-jenkins:8080/job/online-accounts-signon-ui-ci/2/
Executed test runs:
    FAILURE: http://s-jenkins:8080/job/online-accounts-signon-ui-ci/./label=precise-clean-i386/2/console

review: Needs Fixing (continuous-integration)

[lp:~mardy/signon-ui/persistent-cookies]

50. By Alberto Mardegan on 2012-07-26

Revert changes to DBus XML file

Latest Qt not yet available on Precise.

[jenkins (martin-mrazik+qa)]

PASSED: Continuous integration, rev:50
http://s-jenkins:8080/job/online-accounts-signon-ui-ci/3/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/online-accounts-signon-ui-ci/./label=precise-clean-i386/3/console

review: Approve (continuous-integration)

[David King (amigadave)]

Tested and seems fine.

review: Approve

=== modified file 'src/cookie-jar-manager.cpp'
--- src/cookie-jar-manager.cpp	2012-05-31 08:21:16 +0000
+++ src/cookie-jar-manager.cpp	2012-07-26 11:32:19 +0000
@@ -22,12 +22,18 @@
 
 #include "debug.h"
 
+#include <QCoreApplication>
 #include <QDBusMetaType>
+#include <QDataStream>
+#include <QDesktopServices>
+#include <QDir>
+#include <QFile>
 #include <QHash>
 
 using namespace SignOnUi;
 
 static CookieJarManager *m_instance = 0;
+static const unsigned int JAR_VERSION = 1;
 
 namespace SignOnUi {
 
@@ -41,6 +47,7 @@
 {
     TRACE() << "Setting cookies for url:" << url;
     TRACE() << cookieList;
+    queueSave();
     return QNetworkCookieJar::setCookiesFromUrl(cookieList, url);
 }
 
@@ -51,15 +58,108 @@
 private:
     mutable CookieJarManager *q_ptr;
     QHash<quint32, CookieJar*> cookieJars;
+    QDir cookieDir;
 };
 
 } // namespace
 
+QDataStream &operator<<(QDataStream &stream,
+                        const QList<QNetworkCookie> &list)
+{
+    stream << JAR_VERSION;
+    stream << quint32(list.size());
+    foreach (const QNetworkCookie &cookie, list) {
+        stream << cookie.toRawForm();
+    }
+    return stream;
+}
+
+QDataStream &operator>>(QDataStream &stream,
+                        QList<QNetworkCookie> &list)
+{
+    list.clear();
+
+    quint32 version;
+    stream >> version;
+
+    if (version != JAR_VERSION)
+        return stream;
+
+    quint32 count;
+    stream >> count;
+    for (quint32 i = 0; i < count; i++)
+    {
+        QByteArray value;
+        stream >> value;
+        QList<QNetworkCookie> newCookies = QNetworkCookie::parseCookies(value);
+        if (newCookies.count() == 0 && value.length() != 0) {
+            qWarning() << "CookieJar: Unable to parse saved cookie:" << value;
+        }
+        foreach (const QNetworkCookie &cookie, newCookies) {
+            list.append(cookie);
+        }
+        if (stream.atEnd())
+            break;
+    }
+    return stream;
+}
+
+CookieJar::CookieJar(QString cookiePath, QObject *parent):
+    QNetworkCookieJar(parent),
+    m_cookiePath(cookiePath)
+{
+    // Prepare the auto-save timer
+    m_saveTimer.setInterval(10 * 1000);
+    m_saveTimer.setSingleShot(true);
+    QObject::connect(&m_saveTimer, SIGNAL(timeout()),
+                     this, SLOT(save()));
+
+    // Load any saved cookies
+    QFile file(m_cookiePath);
+    file.open(QIODevice::ReadOnly);
+    QDataStream in(&file);
+
+    QList<QNetworkCookie> cookies;
+    in >> cookies;
+    setAllCookies(cookies);
+}
+
+void CookieJar::save()
+{
+    TRACE() << "saving to" << m_cookiePath;
+    QFile file(m_cookiePath);
+    file.open(QIODevice::WriteOnly);
+    QDataStream out(&file);
+
+    out << allCookies();
+
+    /* clear any running timer */
+    m_saveTimer.stop();
+}
+
+void CookieJar::queueSave()
+{
+    m_saveTimer.start();
+}
+
 CookieJarManager::CookieJarManager(QObject *parent):
     QObject(parent),
     d_ptr(new CookieJarManagerPrivate)
 {
+    Q_D(CookieJarManager);
+
     qDBusRegisterMetaType<RawCookies>();
+    qRegisterMetaTypeStreamOperators<QList<QNetworkCookie> >("QList<QNetworkCookie>");
+
+    d->cookieDir =
+        QDesktopServices::storageLocation(QDesktopServices::CacheLocation) +
+        QDir::separator() + "cookies";
+    if (!d->cookieDir.exists()) {
+        d->cookieDir.mkpath(".");
+    }
+
+    QObject::connect(QCoreApplication::instance(), SIGNAL(aboutToQuit()),
+                     this, SLOT(saveAll()));
 }
 
 CookieJarManager::~CookieJarManager()
@@ -83,9 +183,18 @@
     if (d->cookieJars.contains(id)) {
         return d->cookieJars[id];
     } else {
-        CookieJar *cookieJar = new CookieJar(this);
+        QString fileName = QString::fromLatin1("%1.jar").arg(id);
+        CookieJar *cookieJar =
+            new CookieJar(d->cookieDir.absoluteFilePath(fileName), this);
         d->cookieJars.insert(id, cookieJar);
         return cookieJar;
     }
 }
 
+void CookieJarManager::saveAll()
+{
+    Q_D(CookieJarManager);
+    foreach (CookieJar *jar, d->cookieJars) {
+        jar->save();
+    }
+}

=== modified file 'src/cookie-jar-manager.h'
--- src/cookie-jar-manager.h	2012-05-31 08:21:16 +0000
+++ src/cookie-jar-manager.h	2012-07-26 11:32:19 +0000
@@ -25,6 +25,7 @@
 #include <QNetworkCookieJar>
 #include <QObject>
 #include <QString>
+#include <QTimer>
 
 namespace SignOnUi {
 
@@ -35,17 +36,26 @@
     Q_OBJECT
 
 public:
-    CookieJar(QObject *parent = 0):
-        QNetworkCookieJar(parent) {
-    }
+    CookieJar(QString cookiePath, QObject *parent = 0);
     ~CookieJar() {}
 
     QList<QNetworkCookie> cookiesForUrl(const QUrl &url) const;
     bool setCookiesFromUrl(const QList<QNetworkCookie> &cookieList,
                            const QUrl &url);
     void setCookies(const QList<QNetworkCookie> &cookieList) {
+        queueSave();
         setAllCookies(cookieList);
     }
+
+public Q_SLOTS:
+    void save();
+
+private:
+    void queueSave();
+
+private:
+    QString m_cookiePath;
+    QTimer m_saveTimer;
 };
 
 class CookieJarManagerPrivate;
@@ -61,6 +71,9 @@
 
     CookieJar *cookieJarForIdentity(uint id);
 
+public Q_SLOTS:
+    void saveAll();
+
 protected:
     explicit CookieJarManager(QObject *parent = 0);
 

=== modified file 'src/main.cpp'
--- src/main.cpp	2012-04-03 11:46:12 +0000
+++ src/main.cpp	2012-07-26 11:32:19 +0000
@@ -37,6 +37,7 @@
 int main(int argc, char **argv)
 {
     QApplication app(argc, argv);
+    app.setApplicationName("signon-ui");
     app.setQuitOnLastWindowClosed(false);
 
     /* read environment variables */