Merge lp:~zsombi/ubuntu-ui-toolkit/statesaver-vs-urihandler into lp:ubuntu-ui-toolkit/staging

[Zsombor Egri]

StateSaver should reset its database when the application is launched by url-dispatcher using --uri=%u argument. UriHandler should cache the received URIs till StateSaver restores the application state.

[lp:~zsombi/ubuntu-ui-toolkit/statesaver-vs-urihandler]

1479. By Zsombor Egri on 2015-04-16

test added, more to come

1480. By Zsombor Egri on 2015-04-17

staging merge

Unmerged revisions

1480. By Zsombor Egri on 2015-04-17

staging merge

1479. By Zsombor Egri on 2015-04-16

test added, more to come

1478. By Zsombor Egri on 2015-04-16

StateSaver to be reset when --uri=%u Exec line is applied on application launching, UriHandler to queue URIs received until StateSaver::completed() arrives.

=== modified file 'modules/Ubuntu/Components/plugin/statesaverbackend_p.cpp'
--- modules/Ubuntu/Components/plugin/statesaverbackend_p.cpp	2015-02-26 13:35:57 +0000
+++ modules/Ubuntu/Components/plugin/statesaverbackend_p.cpp	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -34,7 +34,6 @@
 StateSaverBackend::StateSaverBackend(QObject *parent)
     : QObject(parent)
     , m_archive(0)
-    , m_globalEnabled(true)
 {
     // connect to application quit signal so when that is called, we can clean the states saved
     QObject::connect(QCoreApplication::instance(), &QCoreApplication::aboutToQuit,
@@ -54,6 +53,12 @@
     UnixSignalHandler::instance().connectSignal(UnixSignalHandler::Interrupt);
     QObject::connect(&UnixSignalHandler::instance(), SIGNAL(signalTriggered(int)),
                      this, SLOT(signalHandler(int)));
+
+    // check arguments the application is launched with
+    if (!waitForStateRestored()) {
+        // need to reset the states file
+        reset();
+    }
 }
 
 StateSaverBackend::~StateSaverBackend()
@@ -100,7 +105,11 @@
 void StateSaverBackend::cleanup()
 {
     reset();
-    m_archive.clear();
+    // remove file as well
+    if (m_archive) {
+        QFile archiveFile(m_archive.data()->fileName());
+        archiveFile.remove();
+    }
 }
 
 void StateSaverBackend::signalHandler(int type)
@@ -114,21 +123,6 @@
     QCoreApplication::quit();
 }
 
-bool StateSaverBackend::enabled() const
-{
-    return m_globalEnabled;
-}
-void StateSaverBackend::setEnabled(bool enabled)
-{
-    if (m_globalEnabled != enabled) {
-        m_globalEnabled = enabled;
-        Q_EMIT enabledChanged(m_globalEnabled);
-        if (!m_globalEnabled) {
-            reset();
-        }
-    }
-}
-
 bool StateSaverBackend::registerId(const QString &id)
 {
     if (m_register.contains(id)) {
@@ -193,6 +187,10 @@
     if (restorePreviousGroup) {
         m_archive->beginGroup(m_groupStack.pop());
     }
+    // if the archive got empty, emit completed()
+    if (m_archive->allKeys().isEmpty()) {
+        Q_EMIT completed();
+    }
     return result;
 }
 
@@ -233,14 +231,35 @@
 /*
  * The method resets the register and the state archive for the application.
  */
-bool StateSaverBackend::reset()
+void StateSaverBackend::reset()
 {
     m_register.clear();
     if (m_archive) {
+        m_archive->clear();
+        m_archive->sync();
+        // trunkate the file
         QFile archiveFile(m_archive.data()->fileName());
-        return archiveFile.remove();
+        if (archiveFile.exists() && archiveFile.open(QFile::ReadOnly | QFile::Truncate)) {
+            archiveFile.close();
+        }
+    }
+}
+
+/*
+ * The method returns the state database state.
+ */
+bool StateSaverBackend::isDatabaseEmpty()
+{
+    return !m_archive || m_archive->allKeys().isEmpty();
+}
+
+bool StateSaverBackend::waitForStateRestored()
+{
+    QStringList args = QCoreApplication::arguments();
+    Q_FOREACH(const QString &argument, args) {
+        if (argument.startsWith("--uri")) {
+            return false;
+        }
     }
     return true;
 }
-
-

=== modified file 'modules/Ubuntu/Components/plugin/statesaverbackend_p.h'
--- modules/Ubuntu/Components/plugin/statesaverbackend_p.h	2014-02-13 10:21:49 +0000
+++ modules/Ubuntu/Components/plugin/statesaverbackend_p.h	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -37,21 +37,22 @@
         return instance;
     }
 
-    bool enabled() const;
-    void setEnabled(bool enabled);
-
     bool registerId(const QString &id);
     void removeId(const QString &id);
 
     int load(const QString &id, QObject *item, const QStringList &properties);
     int save(const QString &id, QObject *item, const QStringList &properties);
 
+    bool isDatabaseEmpty();
+    static bool waitForStateRestored();
+
 public Q_SLOTS:
-    bool reset();
+    void reset();
 
 Q_SIGNALS:
     void enabledChanged(bool enabled);
     void initiateStateSaving();
+    void completed();
 
 protected:
     explicit StateSaverBackend(QObject *parent = 0);
@@ -65,7 +66,6 @@
     QPointer<QSettings> m_archive;
     QSet<QString> m_register;
     QStack<QString> m_groupStack;
-    bool m_globalEnabled;
 };
 
 #endif // STATESAVERBACKEND_P_H

=== modified file 'modules/Ubuntu/Components/plugin/ucstatesaver.cpp'
--- modules/Ubuntu/Components/plugin/ucstatesaver.cpp	2015-03-03 13:47:48 +0000
+++ modules/Ubuntu/Components/plugin/ucstatesaver.cpp	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -66,7 +66,7 @@
  */
 void UCStateSaverAttachedPrivate::_q_save()
 {
-    if (m_enabled && StateSaverBackend::instance().enabled() && !m_properties.isEmpty() && !m_absoluteId.isEmpty()) {
+    if (m_enabled && !m_properties.isEmpty() && !m_absoluteId.isEmpty()) {
         StateSaverBackend::instance().save(m_absoluteId, m_attachee, m_properties);
     }
 }
@@ -154,9 +154,10 @@
  * \note The application name must be set correctly to the package name so that
  * state saving can work (e.g. com.ubuntu.calendar) through \l MainView::applicationName.
  *
- * States saved are discarded when the application is closed properly. The state
- * loading is ignored (but not discarded) when the application is launched through
- * UriHandler.
+ * States saved are discarded when the application is closed properly, as well as
+ * when the application is launched by the url-dispatcher and the application's
+ * desktop Exec line contains \c {--uri=%u} argument passing.
+ * \sa UriHandler
  *
  * Example:
  * \qml
@@ -280,9 +281,7 @@
     if (d->m_enabled != v) {
         d->m_enabled = v;
         // make sure next time we sync properties
-        if (StateSaverBackend::instance().enabled()) {
-            d->watchComponent(d->m_enabled);
-        }
+        d->watchComponent(d->m_enabled);
         Q_EMIT enabledChanged();
     }
 }
@@ -292,7 +291,7 @@
  * List of properties to be serialized, separated with commas. Properties must be
  * writable and can only be \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-typesystem-basictypes.html}{QML base types}.
  *
- * A custom singl eline input which saves the text, polaceholderText, font and color would look as follows:
+ * A custom single line input which saves the text, paceholderText, font and color would look as follows:
  * \qml
  * TextField {
  *     id: input

=== modified file 'modules/Ubuntu/Components/plugin/ucurihandler.cpp'
--- modules/Ubuntu/Components/plugin/ucurihandler.cpp	2014-10-08 20:16:03 +0000
+++ modules/Ubuntu/Components/plugin/ucurihandler.cpp	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -24,13 +24,27 @@
 
 UriHandlerObject::UriHandlerObject(UCUriHandler* uriHandler)
     : m_uriHandler(uriHandler)
+    , m_cacheUris(false)
 {
 }
 
 void UriHandlerObject::Open(const QStringList& uris, const QHash<QString, QVariant>& platformData)
 {
     Q_UNUSED(platformData);
-    Q_EMIT m_uriHandler->opened(uris);
+    m_uris << uris;
+    if (!m_cacheUris) {
+        Q_EMIT m_uriHandler->opened(uris);
+    }
+}
+
+// slot called when statesaver ends its work
+void UriHandlerObject::handOverCachedUris()
+{
+    m_cacheUris = false;
+    disconnect(&StateSaverBackend::instance(), &StateSaverBackend::completed,
+                this, &UriHandlerObject::handOverCachedUris);
+    // emit all cached URIs
+    Q_EMIT m_uriHandler->opened(m_uris);
 }
 
 /*!
@@ -53,6 +67,13 @@
  *     onOpened: print(uris)
  * }
  * \endqml
+ *
+ * \section2 Interaction with StateSaver
+ * When application uses StateSaver to save property states, UriHandler will deliver
+ * the URIs only after StateSaver restores the last state of the application. This
+ * can be overruled by specifying the \c {--uri=%u} argument in Exec line of the
+ * application's desktop file. If that is specified, states will not be loaded
+ * at all, and will be lost, URIs will be delivered as they come.
  */
 UCUriHandler::UCUriHandler()
     : m_uriHandlerObject(this)
@@ -84,6 +105,21 @@
 
     QDBusConnection::sessionBus().registerObject(
         objectPath, &m_uriHandlerObject, QDBusConnection::ExportAllSlots);
+
+    // if the app was launched with --uri= argument, we do not have to queue
+    // URLs, otherwise yes
+    if (StateSaverBackend::waitForStateRestored()) {
+        // connect to completed signal
+        m_uriHandlerObject.m_cacheUris = true;
+        connect(&StateSaverBackend::instance(), &StateSaverBackend::completed,
+                &m_uriHandlerObject, &UriHandlerObject::handOverCachedUris);
+        // feed URIs
+        Q_FOREACH(QString arg, QCoreApplication::arguments()) {
+            if (arg.startsWith(QStringLiteral("--uri="))) {
+                m_uriHandlerObject.m_uris << arg.remove(QStringLiteral("--uri="));
+            }
+        }
+    }
 }
 
 /*!

=== modified file 'modules/Ubuntu/Components/plugin/ucurihandler.h'
--- modules/Ubuntu/Components/plugin/ucurihandler.h	2013-09-27 20:21:01 +0000
+++ modules/Ubuntu/Components/plugin/ucurihandler.h	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -17,6 +17,7 @@
  */
 
 #include <QtCore/QObject>
+#include <QtCore/QStringList>
 
 class UCUriHandler;
 
@@ -30,9 +31,13 @@
 
  public Q_SLOTS:
     void Open(const QStringList& uris, const QHash<QString, QVariant>& platformData);
+    void handOverCachedUris();
 
  private:
     UCUriHandler* m_uriHandler;
+    QStringList m_uris;
+    bool m_cacheUris:1;
+    friend class UCUriHandler;
 };
 
 class UCUriHandler : public QObject

=== added file 'tests/unit_x11/tst_statesaver/UriHandlerApp.qml'
--- tests/unit_x11/tst_statesaver/UriHandlerApp.qml	1970-01-01 00:00:00 +0000
+++ tests/unit_x11/tst_statesaver/UriHandlerApp.qml	2015-04-17 07:52:46 +0000
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2015 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.4
+import Ubuntu.Components 1.2
+
+Item {
+    id: testItem
+    width: units.gu(40)
+    height: units.gu(40)
+
+    property string testProperty: "yoho"
+    property bool completed: false
+
+    Component.onCompleted: {
+        completed = true;
+        testProperty = "me hardies!";
+    }
+
+    Connections {
+        target: UriHandler
+        onOpened: {
+            console.error("URI=", uris);
+            console.error("completed=", testItem.completed);
+            console.error("testProperty=", testProperty);
+        }
+    }
+}

=== modified file 'tests/unit_x11/tst_statesaver/tst_statesaver.cpp'
--- tests/unit_x11/tst_statesaver/tst_statesaver.cpp	2015-01-29 14:15:41 +0000
+++ tests/unit_x11/tst_statesaver/tst_statesaver.cpp	2015-04-17 07:52:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2015 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -604,6 +604,38 @@
         // clean the file
         QFile::remove(fileName);
     }
+
+    void test_uri_handler()
+    {
+        qputenv("APP_ID", "UriHandlerApp");
+        QProcess testApp;
+        testApp.start("qmlscene",QStringList() << "-I" << UBUNTU_QML_IMPORT_PATH << "UriHandlerApp.qml");
+        testApp.waitForStarted();
+        QTest::qWait(1000);
+
+        // make sure we are not killing the parent
+        QVERIFY(testApp.pid() != QCoreApplication::applicationPid());
+        // skip tests if the application PID is zero => the child app PID seems to be zero as well
+        if (!testApp.pid()) {
+            // kill child process
+            testApp.close();
+            QSKIP("This test requires valid PID");
+        }
+        // send SIGINT
+        ::kill(testApp.pid(), SIGINT);
+        testApp.waitForFinished();
+
+        // launch the app with --uri argument
+        testApp.start("qmlscene",QStringList() << "-I" << UBUNTU_QML_IMPORT_PATH << "--uri=whatever.org" << "UriHandlerApp.qml");
+        testApp.waitForStarted();
+        QTest::qWait(2000);
+
+        QString result = testApp.readAllStandardError();
+        // terminate the app
+        testApp.terminate();
+        testApp.waitForFinished();
+        QCOMPARE(result, QString("qml: URI= whatever.org\nqml: completed= false\nqml: testProperty= me hardies!\n"));
+    }
 };
 
 QTEST_MAIN(tst_StateSaverTest)

=== modified file 'tests/unit_x11/tst_statesaver/tst_statesaver.pro'
--- tests/unit_x11/tst_statesaver/tst_statesaver.pro	2014-07-28 14:46:19 +0000
+++ tests/unit_x11/tst_statesaver/tst_statesaver.pro	2015-04-17 07:52:46 +0000
@@ -27,4 +27,5 @@
     ListViewItems.qml \
     GridViewItems.qml \
     NormalAppClose.qml \
-    SaveEnum.qml
+    SaveEnum.qml \
+    UriHandlerApp.qml