Merge lp:~stolowski/unity-scopes-shell/send-user-agent into lp:unity-scopes-shell

[Paweł Stołowski]

Send build number, release name and package versions of unity8, shell plugin and scopes api with user-agent hint in SearchMetadata and PreviewMetadata.

Send build number, release name and package versions of unity8, shell plugin and scopes api with user-agent hint in SearchMetadata and PreviewMetadata.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:149
http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-ci/234/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-amd64-ci/131/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-armhf-ci/131/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-i386-ci/134/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-shell-ci/234/rebuild

review: Needs Fixing (continuous-integration)

[Pete Woods (pete-woods)]

Should we not use libdpkg-dev rather than parsing command line output?

[Pete Woods (pete-woods)]

Okay, fair enough there's a bunch of other stuff we need to find out.

[lp:~stolowski/unity-scopes-shell/send-user-agent]

150. By Paweł Stołowski on 2014-09-24

Make sure scopes are populated also if dpkg or lsb_release cannot be executed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:150
http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-ci/235/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-amd64-ci/132
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-armhf-ci/132
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-armhf-ci/132/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-utopic-i386-ci/135

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-shell-ci/235/rebuild

review: Approve (continuous-integration)

[Pete Woods (pete-woods)]

review: Approve

[lp:~stolowski/unity-scopes-shell/send-user-agent]

151. By Paweł Stołowski on 2014-10-01

Merged trunk

=== modified file 'src/Unity/previewstack.cpp'
--- src/Unity/previewstack.cpp	2014-09-11 04:55:52 +0000
+++ src/Unity/previewstack.cpp	2014-10-01 12:59:45 +0000
@@ -77,10 +77,11 @@
     return false;
 }
 
-void PreviewStack::setAssociatedScope(scopes_ng::Scope* scope, QUuid const& session_id)
+void PreviewStack::setAssociatedScope(scopes_ng::Scope* scope, QUuid const& session_id, QString const& userAgent)
 {
     m_associatedScope = scope;
     m_session_id = session_id;
+    m_userAgent = userAgent;
 }
 
 void PreviewStack::loadForResult(scopes::Result::SPtr const& result)
@@ -124,6 +125,9 @@
         if (!m_session_id.isNull()) {
             metadata["session-id"] = uuidToString(m_session_id).toStdString();
         }
+        if (!m_userAgent.isEmpty()) {
+            metadata["user-agent"] = m_userAgent.toStdString();
+        }
 
         std::shared_ptr<PreviewDataReceiver> listener(new PreviewDataReceiver(m_activePreview));
         std::weak_ptr<ScopeDataReceiverBase> wl(listener);
 
=== modified file 'src/Unity/previewstack.h'
--- src/Unity/previewstack.h	2014-09-03 09:45:15 +0000
+++ src/Unity/previewstack.h	2014-10-01 12:59:45 +0000
@@ -60,7 +60,7 @@
 
     void setWidgetColumnCount(int columnCount) override;
     int widgetColumnCount() const override;
-    void setAssociatedScope(scopes_ng::Scope*, QUuid const&);
+    void setAssociatedScope(scopes_ng::Scope*, QUuid const&, QString const&);
 
 private Q_SLOTS:
     void widgetTriggered(QString const&, QString const&, QVariantMap const&);
@@ -81,6 +81,7 @@
 
     unity::scopes::Result::SPtr m_previewedResult;
     QUuid m_session_id;
+    QString m_userAgent;
 };
 
 } // namespace scopes_ng
 
=== modified file 'src/Unity/scope.cpp'
--- src/Unity/scope.cpp	2014-09-25 05:16:02 +0000
+++ src/Unity/scope.cpp	2014-10-01 12:59:45 +0000
@@ -647,6 +647,11 @@
 
     if (m_proxy) {
         scopes::SearchMetadata meta(QLocale::system().name().toStdString(), m_formFactor.toStdString());
+        auto const userAgent = m_scopesInstance->userAgentString();
+        if (!userAgent.isEmpty()) {
+            meta["user-agent"] = userAgent.toStdString();
+        }
+
         if (!m_session_id.isNull()) {
             meta["session-id"] = uuidToString(m_session_id).toStdString();
         }
@@ -1155,7 +1160,7 @@
     }
 
     PreviewStack* stack = new PreviewStack(nullptr);
-    stack->setAssociatedScope(this, m_session_id);
+    stack->setAssociatedScope(this, m_session_id, m_scopesInstance->userAgentString());
     stack->loadForResult(result);
     return stack;
 }
 
=== modified file 'src/Unity/scopes.cpp'
--- src/Unity/scopes.cpp	2014-09-10 11:47:01 +0000
+++ src/Unity/scopes.cpp	2014-10-01 12:59:45 +0000
@@ -29,6 +29,10 @@
 #include <QDebug>
 #include <QTimer>
 #include <QDBusConnection>
+#include <QProcess>
+#include <QFile>
+#include <QUrlQuery>
+#include <QTextStream>
 
 #include <unity/scopes/Registry.h>
 #include <unity/scopes/Scope.h>
@@ -106,14 +110,6 @@
         m_noFavorites = true;
     }
 
-    // delaying spawning the worker thread, causes problems with qmlplugindump
-    // without it
-    if (LIST_DELAY < 0) {
-        QByteArray listDelay = qgetenv("UNITY_SCOPES_LIST_DELAY");
-        LIST_DELAY = listDelay.isNull() ? 100 : listDelay.toInt();
-    }
-    QTimer::singleShot(LIST_DELAY, this, SLOT(populateScopes()));
-
     connect(m_priv.get(), SIGNAL(safeInvalidateScopeResults(const QString&)), this,
             SLOT(invalidateScopeResults(const QString &)), Qt::QueuedConnection);
 
@@ -127,6 +123,8 @@
 
     m_overviewScope = new OverviewScope(this);
     m_locationService.reset(new UbuntuLocationService());
+
+    createUserAgentString();
 }
 
 Scopes::~Scopes()
@@ -137,6 +135,11 @@
     }
 }
 
+QString Scopes::userAgentString() const
+{
+    return m_userAgent;
+}
+
 int Scopes::rowCount(const QModelIndex& parent) const
 {
     Q_UNUSED(parent)
@@ -149,6 +152,89 @@
     return m_scopes.count();
 }
 
+void Scopes::createUserAgentString()
+{
+    QProcess *dpkg = new QProcess(this);
+    connect(dpkg, SIGNAL(finished(int, QProcess::ExitStatus)), this, SLOT(dpkgFinished()));
+    connect(dpkg, SIGNAL(error(QProcess::ProcessError)), this, SLOT(initPopulateScopes()));
+    dpkg->start("dpkg-query -W libunity-scopes3 unity-plugin-scopes unity8", QIODevice::ReadOnly);
+}
+
+void Scopes::dpkgFinished()
+{
+    QProcess *dpkg = qobject_cast<QProcess *>(sender());
+    if (dpkg) {
+        while (dpkg->canReadLine()) {
+            const QString line = dpkg->readLine();
+            const QStringList lineParts = line.split(QRegExp("\\s+"), QString::SkipEmptyParts);
+            QString key;
+            if (lineParts.size() == 2) {
+                if (lineParts.at(0).startsWith("libunity-scopes")) {
+                    key = "scopes-api";
+                }
+                else if (lineParts.at(0).startsWith("unity-plugin-scopes")) {
+                    key = "plugin";
+                }
+                else if (lineParts.at(0).startsWith("unity8")) {
+                    key = "unity8";
+                }
+                if (!key.isEmpty()) {
+                    m_versions.push_back(qMakePair(key, lineParts.at(1)));
+                } else {
+                    qWarning() << "Unexpected dpkg-query output:" << line;
+                }
+            }
+        }
+        dpkg->deleteLater();
+
+        QProcess *lsb_release = new QProcess(this);
+        connect(lsb_release, SIGNAL(finished(int, QProcess::ExitStatus)), this, SLOT(lsbReleaseFinished()));
+        connect(lsb_release, SIGNAL(error(QProcess::ProcessError)), this, SLOT(initPopulateScopes()));
+        lsb_release->start("lsb_release -r", QIODevice::ReadOnly);
+    }
+}
+
+void Scopes::lsbReleaseFinished()
+{
+    QProcess *lsb_release = qobject_cast<QProcess *>(sender());
+    if (lsb_release) {
+        const QString out = lsb_release->readAllStandardOutput();
+        const QStringList parts = out.split(QRegExp("\\s+"), QString::SkipEmptyParts);
+        if (parts.size() == 2) {
+            m_versions.push_back(qMakePair(QString("release"), parts.at(1)));
+        }
+        lsb_release->deleteLater();
+
+        QFile buildFile("/etc/ubuntu-build");
+        if (buildFile.open(QIODevice::ReadOnly)) {
+            QTextStream str(&buildFile);
+            QString bld;
+            str >> bld;
+            m_versions.push_back(qMakePair(QString("build"), bld));
+        }
+
+        QUrlQuery q;
+        q.setQueryItems(m_versions);
+        m_versions.clear();
+        m_userAgent = q.toString();
+    }
+
+    qDebug() << "User agent string:" << m_userAgent;
+    initPopulateScopes();
+}
+
+void Scopes::initPopulateScopes()
+{
+    // initiate scopes
+    // delaying spawning the worker thread, causes problems with qmlplugindump
+    // without it
+    if (LIST_DELAY < 0) {
+        QByteArray listDelay = qgetenv("UNITY_SCOPES_LIST_DELAY");
+        LIST_DELAY = listDelay.isNull() ? 100 : listDelay.toInt();
+    }
+    QTimer::singleShot(LIST_DELAY, this, SLOT(populateScopes()));
+}
+
 void Scopes::populateScopes()
 {
     auto thread = new ScopeListWorker;
 
=== modified file 'src/Unity/scopes.h'
--- src/Unity/scopes.h	2014-09-10 11:47:01 +0000
+++ src/Unity/scopes.h	2014-10-01 12:59:45 +0000
@@ -69,6 +69,7 @@
     unity::shell::scopes::ScopeInterface* overviewScope() const override;
 
     LocationService::Ptr locationService() const;
+    QString userAgentString() const;
 
 Q_SIGNALS:
     void metadataRefreshed();
@@ -81,8 +82,13 @@
     void refreshFinished();
     void invalidateScopeResults(QString const&);
 
+    void initPopulateScopes();
+    void dpkgFinished();
+    void lsbReleaseFinished();
+
 private:
     void queryScopesOnStartup();
+    void createUserAgentString();
 
     static int LIST_DELAY;
     static const int SCOPE_DELETE_DELAY;
@@ -95,6 +101,8 @@
     QMap<QString, unity::scopes::ScopeMetadata::SPtr> m_cachedMetadata;
     OverviewScope* m_overviewScope;
     QThread* m_listThread;
+    QList<QPair<QString, QString>> m_versions;
+    QString m_userAgent;
     bool m_loaded;
     bool m_queryOnStartup;