Merge lp:~boiko/telephony-service/metrics into lp:telephony-service

[Gustavo Pichorim Boiko]

Add support for user metrics.

Add support for user metrics.

[lp:~boiko/telephony-service/metrics]

751. By Gustavo Pichorim Boiko on 2013-09-25

Remove leftover return statement.

752. By Gustavo Pichorim Boiko on 2013-09-25

Add Ugo to the authors section, as he did most of the code.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:751
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/43/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-amd64-ci/43
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/43
        deb: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/43/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-i386-ci/43

Click here to trigger a rebuild:
http://s-jenkins:8080/job/telephony-service-ci/43/rebuild

review: Approve (continuous-integration)

[lp:~boiko/telephony-service/metrics]

753. By Gustavo Pichorim Boiko on 2013-09-25

Make ir float point.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:752
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/44/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-amd64-ci/44
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/44
        deb: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/44/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-i386-ci/44

Click here to trigger a rebuild:
http://s-jenkins:8080/job/telephony-service-ci/44/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:753
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/45/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-amd64-ci/45
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/45
        deb: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-armhf-ci/45/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-saucy-i386-ci/45

Click here to trigger a rebuild:
http://s-jenkins:8080/job/telephony-service-ci/45/rebuild

review: Approve (continuous-integration)

[Bill Filler (bfiller)]

approved

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-08-22 17:51:46 +0000
+++ CMakeLists.txt	2013-09-25 22:22:00 +0000
@@ -60,6 +60,7 @@
 pkg_check_modules(NOTIFY REQUIRED libnotify)
 pkg_check_modules(MESSAGING_MENU REQUIRED messaging-menu)
 pkg_check_modules(GSETTINGS REQUIRED gsettings-qt)
+pkg_check_modules(UserMetrics REQUIRED libusermetricsinput-1)
 
 # Check if the messaging menu has the message header
 set(CMAKE_REQUIRED_INCLUDES ${MESSAGING_MENU_INCLUDE_DIRS})

=== modified file 'debian/control'
--- debian/control	2013-08-29 23:14:15 +0000
+++ debian/control	2013-09-25 22:22:00 +0000
@@ -23,6 +23,7 @@
                qtdeclarative5-test-plugin (>= 5.0),
                qtmultimedia5-dev (>= 5.0),
                qtpim5-dev (>= 5),
+               libusermetricsinput1-dev,
 Standards-Version: 3.9.4
 Homepage: https://launchpad.net/telephony-service
 # If you aren't a member of ~phablet-team but need to upload packaging changes,
@@ -41,6 +42,7 @@
          telepathy-mission-control-5,
          telepathy-ofono,
          ubuntu-sounds,
+         libusermetricsinput1,
          dconf-cli,
          ${misc:Depends},
          ${shlibs:Depends},

=== modified file 'indicator/CMakeLists.txt'
--- indicator/CMakeLists.txt	2013-08-22 17:51:46 +0000
+++ indicator/CMakeLists.txt	2013-09-25 22:22:00 +0000
@@ -2,6 +2,7 @@
 set(qt_SRCS
     callchannelobserver.cpp
     messagingmenu.cpp
+    metrics.cpp
     textchannelobserver.cpp
     voicemailindicator.cpp
     )
@@ -15,6 +16,7 @@
     ${GSETTINGS_INCLUDE_DIRS}
     ${CMAKE_SOURCE_DIR}/libtelephonyservice
     ${CMAKE_CURRENT_BINARY_DIR}
+    ${UserMetrics_INCLUDE_DIRS}
     )
 
 link_directories(${MESSAGING_MENU_LIBRARY_DIRS})
@@ -27,6 +29,7 @@
     ${NOTIFY_LIBRARIES}
     ${MESSAGING_MENU_LIBRARIES}
     ${GSETTINGS_LIBRARIES}
+    ${UserMetrics_LIBRARIES}
     telephonyservice
     )
 

=== modified file 'indicator/callchannelobserver.cpp'
--- indicator/callchannelobserver.cpp	2013-08-22 17:51:46 +0000
+++ indicator/callchannelobserver.cpp	2013-09-25 22:22:00 +0000
@@ -21,6 +21,8 @@
 
 #include "callchannelobserver.h"
 #include "messagingmenu.h"
+#include "metrics.h"
+#include "telepathyhelper.h"
 #include <TelepathyQt/Contact>
 
 CallChannelObserver::CallChannelObserver(QObject *parent) :
@@ -51,6 +53,9 @@
         return;
     }
 
+    bool incoming = channel->initiatorContact() != TelepathyHelper::instance()->account()->connection()->selfContact();
+    QDateTime activeTimestamp = channel->property("activeTimestamp").toDateTime();
+
     switch (state) {
     case Tp::CallStateEnded:
         Q_EMIT callEnded(channel);
@@ -58,6 +63,13 @@
         // FIXME: handle conf call
         MessagingMenu::instance()->addCall(channel->targetContact()->id(), QDateTime::currentDateTime());
         mChannels.removeOne(channel);
+
+        // update the metrics
+        Metrics::instance()->increment(incoming ? Metrics::IncomingCalls : Metrics::OutgoingCalls);
+        if (activeTimestamp.isValid()) {
+            double minutes = activeTimestamp.secsTo(QDateTime::currentDateTime()) / 60.;
+            Metrics::instance()->increment(Metrics::CallDurations, qRound(minutes * 100) / 100);
+        }
         break;
     case Tp::CallStateActive:
         channel->setProperty("activeTimestamp", QDateTime::currentDateTime());

=== modified file 'indicator/main.cpp'
--- indicator/main.cpp	2013-08-22 21:51:42 +0000
+++ indicator/main.cpp	2013-09-25 22:22:00 +0000
@@ -24,6 +24,7 @@
 
 #include "applicationutils.h"
 #include "callchannelobserver.h"
+#include "metrics.h"
 #include "telepathyhelper.h"
 #include "textchannelobserver.h"
 #include "voicemailindicator.h"
@@ -69,5 +70,8 @@
     VoiceMailIndicator voiceMailIndicator;
     Q_UNUSED(voiceMailIndicator);
 
+    // instanciate the metrics helper
+    Metrics::instance();
+
     return app.exec();
 }

=== added file 'indicator/metrics.cpp'
--- indicator/metrics.cpp	1970-01-01 00:00:00 +0000
+++ indicator/metrics.cpp	2013-09-25 22:22:00 +0000
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Gustavo Pichorim Boiko <[e-mail]>
+ *  Ugo Riboni <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * telephony-service 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "metrics.h"
+#include <QDebug>
+
+const QString APP_ID = QString("telephony-service");
+const QString MESSAGES_RECEIVED_STATISTICS_ID = QString("text-messages-received");
+const QString MESSAGES_SENT_STATISTICS_ID = QString("text-messages-sent");
+const QString DIALER_INCOMING_STATISTICS_ID = QString("dialer-calls-incoming");
+const QString DIALER_OUTGOING_STATISTICS_ID = QString("dialer-calls-outgoing");
+const QString DIALER_CALL_DURATION_STATISTICS_ID = QString("dialer-calls-duration");
+
+using namespace UserMetricsInput;
+
+Metrics::Metrics(QObject *parent) :
+    QObject(parent),
+    mMetricManager(MetricManager::getInstance())
+{
+    mMetrics[SentMessages] = mMetricManager->add(MetricParameters(MESSAGES_SENT_STATISTICS_ID).formatString("<b>%1</b> text messages sent today")
+                                              .emptyDataString("No text messages sent today").textDomain(APP_ID).minimum(0.0));
+    mMetrics[ReceivedMessages] = mMetricManager->add(MetricParameters(MESSAGES_RECEIVED_STATISTICS_ID).formatString("<b>%1</b> text messages received today")
+                                              .emptyDataString("No text messages received today").textDomain(APP_ID).minimum(0.0));
+    mMetrics[IncomingCalls] = mMetricManager->add(MetricParameters(DIALER_INCOMING_STATISTICS_ID).formatString("<b>%1</b> calls received today")
+                                                  .emptyDataString("No calls received today").textDomain(APP_ID).minimum(0.0));
+    mMetrics[OutgoingCalls] = mMetricManager->add(MetricParameters(DIALER_OUTGOING_STATISTICS_ID).formatString("<b>%1</b> calls made today")
+                                                  .emptyDataString("No calls made today").textDomain(APP_ID).minimum(0.0));
+    mMetrics[CallDurations] = mMetricManager->add(MetricParameters(DIALER_CALL_DURATION_STATISTICS_ID).formatString("Spent <b>%1</b> minutes in calls today")
+                                                  .emptyDataString("No calls made today").textDomain(APP_ID).minimum(0.0));
+}
+
+Metrics *Metrics::instance()
+{
+    static Metrics *self = new Metrics();
+    return self;
+}
+
+void Metrics::increment(Metrics::MetricType metric, double amount)
+{
+    mMetrics[metric]->increment(amount);
+}

=== added file 'indicator/metrics.h'
--- indicator/metrics.h	1970-01-01 00:00:00 +0000
+++ indicator/metrics.h	2013-09-25 22:22:00 +0000
@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Gustavo Pichorim Boiko <[e-mail]>
+ *  Ugo Riboni <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * telephony-service 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef METRICS_H
+#define METRICS_H
+
+#include <QObject>
+#include <QMap>
+#include <libusermetricsinput/MetricManager.h>
+
+using namespace UserMetricsInput;
+
+class Metrics : public QObject
+{
+    Q_OBJECT
+public:
+    enum MetricType {
+        SentMessages,
+        ReceivedMessages,
+        IncomingCalls,
+        OutgoingCalls,
+        CallDurations
+    };
+
+    static Metrics *instance();
+    void increment(MetricType metric, double amount = 1.0f);
+    
+private:
+    explicit Metrics(QObject *parent = 0);
+    QMap<MetricType, UserMetricsInput::MetricPtr> mMetrics;
+    UserMetricsInput::MetricManagerPtr mMetricManager;
+};
+
+#endif // METRICS_H

=== modified file 'indicator/textchannelobserver.cpp'
--- indicator/textchannelobserver.cpp	2013-08-22 17:51:46 +0000
+++ indicator/textchannelobserver.cpp	2013-09-25 22:22:00 +0000
@@ -22,6 +22,7 @@
 #include <libnotify/notify.h>
 #include "textchannelobserver.h"
 #include "messagingmenu.h"
+#include "metrics.h"
 #include "chatmanager.h"
 #include "config.h"
 #include "contactutils.h"
@@ -53,11 +54,6 @@
 
 void TextChannelObserver::showNotificationForMessage(const Tp::ReceivedMessage &message)
 {
-    // do not place notification items for scrollback messages
-    if (message.isScrollback() || message.isDeliveryReport() || message.isRescued()) {
-        return;
-    }
-
     Tp::ContactPtr contact = message.sender();
 
     // try to match the contact info
@@ -131,12 +127,15 @@
     connect(textChannel.data(),
             SIGNAL(pendingMessageRemoved(const Tp::ReceivedMessage&)),
             SLOT(onPendingMessageRemoved(const Tp::ReceivedMessage&)));
+    connect(textChannel.data(),
+            SIGNAL(messageSent(Tp::Message,Tp::MessageSendingFlags,QString)),
+            SLOT(onMessageSent(Tp::Message,Tp::MessageSendingFlags,QString)));
 
     mChannels.append(textChannel);
 
     // notify all the messages from the channel
     Q_FOREACH(Tp::ReceivedMessage message, textChannel->messageQueue()) {
-        showNotificationForMessage(message);
+        onMessageReceived(message);
     }
 }
 
@@ -148,7 +147,11 @@
 
 void TextChannelObserver::onMessageReceived(const Tp::ReceivedMessage &message)
 {
-    showNotificationForMessage(message);
+    // do not place notification items for scrollback messages
+    if (!message.isScrollback() && !message.isDeliveryReport() && !message.isRescued()) {
+        showNotificationForMessage(message);
+        Metrics::instance()->increment(Metrics::ReceivedMessages);
+    }
 }
 
 void TextChannelObserver::onPendingMessageRemoved(const Tp::ReceivedMessage &message)
@@ -166,3 +169,8 @@
     QString messageId(QByteArray::fromHex(encodedMessageId.toUtf8()));
     ChatManager::instance()->acknowledgeMessage(phoneNumber, messageId);
 }
+
+void TextChannelObserver::onMessageSent(Tp::Message, Tp::MessageSendingFlags, QString)
+{
+    Metrics::instance()->increment(Metrics::SentMessages);
+}

=== modified file 'indicator/textchannelobserver.h'
--- indicator/textchannelobserver.h	2013-08-22 17:51:46 +0000
+++ indicator/textchannelobserver.h	2013-09-25 22:22:00 +0000
@@ -45,6 +45,7 @@
     void onPendingMessageRemoved(const Tp::ReceivedMessage &message);
     void onReplyReceived(const QString &phoneNumber, const QString &reply);
     void onMessageRead(const QString &phoneNumber, const QString &encodedMessageId);
+    void onMessageSent(Tp::Message, Tp::MessageSendingFlags, QString);
 
 private:
     QList<Tp::TextChannelPtr> mChannels;