Merge pull request #23 from spiiroin/jb56945_imei_numbers

[deviceinfo] Add imeiNumbers property. JB#56945

Author: spiiroin

rpm/nemo-qml-plugin-systemsettings.spec

@@ -37,6 +37,7 @@ BuildRequires:  pkgconfig(libsystemd)
 BuildRequires:  pkgconfig(sailfishusermanager)
 BuildRequires:  qt5-qttools-linguist
 BuildRequires:  pkgconfig(openssl)
+BuildRequires:  pkgconfig(qofono-qt5) >= 0.105
 
 %description
 %{summary}.

src/deviceinfo.cpp

@@ -34,12 +34,16 @@
 #include <QSet>
 
 #include <ssusysinfo.h>
+#include <qofonomanager.h>
+#include <qofonomodem.h>
 
-class DeviceInfoPrivate
+class DeviceInfoPrivate: public QObject
 {
+    Q_OBJECT
 public:
-    DeviceInfoPrivate();
+    DeviceInfoPrivate(DeviceInfo *deviceInfo, bool synchronousInit);
     ~DeviceInfoPrivate();
+    QStringList imeiNumbers();
 
     QSet<DeviceInfo::Feature> m_features;
     QSet<Qt::Key> m_keys;
@@ -51,9 +55,31 @@ class DeviceInfoPrivate
     QString m_osName;
     QString m_osVersion;
     QString m_adaptationVersion;
+private slots:
+    void modemsChanged(const QStringList &modems);
+    void modemSerialChanged(const QString &serial);
+    void updateModemProperties();
+private:
+    void modemAdded(const QString &modem);
+    void modemRemoved(const QString &modem);
+    QSharedPointer<QOfonoManager> ofonoManager();
+    void updateModemPropertiesLater();
+
+    DeviceInfo *q_ptr;
+    bool m_synchronousInit;
+    QSharedPointer<QOfonoManager> m_ofonoManager;
+    QHash<QString, QSharedPointer<QOfonoModem> > m_modemHash;
+    QStringList m_modemList;
+    QStringList m_imeiNumbers;
+    QTimer *m_updateModemPropertiesTimer;
+    Q_DISABLE_COPY(DeviceInfoPrivate);
+    Q_DECLARE_PUBLIC(DeviceInfo);
 };
 
-DeviceInfoPrivate::DeviceInfoPrivate()
+DeviceInfoPrivate::DeviceInfoPrivate(DeviceInfo *deviceInfo, bool synchronousInit)
+    : q_ptr(deviceInfo)
+    , m_synchronousInit(synchronousInit)
+    , m_updateModemPropertiesTimer(nullptr)
 {
     ssusysinfo_t *si = ssusysinfo_create();
 
@@ -90,10 +116,107 @@ DeviceInfoPrivate::~DeviceInfoPrivate()
 {
 }
 
+QStringList DeviceInfoPrivate::imeiNumbers()
+{
+    /* Trigger on-demand ofono tracking and
+     * evaluate initial property values. */
+    ofonoManager();
+
+    return m_imeiNumbers;
+}
+
+QSharedPointer<QOfonoManager> DeviceInfoPrivate::ofonoManager()
+{
+    if (m_ofonoManager.isNull()) {
+        m_ofonoManager = QOfonoManager::instance(m_synchronousInit);
+        connect(&*m_ofonoManager, &QOfonoManager::modemsChanged, this, &DeviceInfoPrivate::modemsChanged);
+
+        m_updateModemPropertiesTimer = new QTimer(this);
+        m_updateModemPropertiesTimer->setInterval(50);
+        m_updateModemPropertiesTimer->setSingleShot(true);
+        connect(m_updateModemPropertiesTimer, &QTimer::timeout, this, &DeviceInfoPrivate::updateModemProperties);
+
+        QStringList modems(m_ofonoManager->modems());
+        for (auto iter = modems.cbegin(); iter != modems.cend(); ++iter)
+            modemAdded(*iter);
+        updateModemProperties();
+    }
+    return m_ofonoManager;
+}
+
+void DeviceInfoPrivate::updateModemPropertiesLater()
+{
+    if (!m_updateModemPropertiesTimer->isActive())
+        m_updateModemPropertiesTimer->start();
+}
+
+void DeviceInfoPrivate::updateModemProperties()
+{
+    QStringList imeiNumbers;
+    for (auto iter = m_modemList.cbegin(); iter != m_modemList.cend(); ++iter) {
+        QString imei(m_modemHash[*iter]->serial());
+        if (!imei.isEmpty())
+            imeiNumbers.append(imei);
+    }
+    if (m_imeiNumbers != imeiNumbers) {
+        m_imeiNumbers = imeiNumbers;
+        Q_Q(DeviceInfo);
+        emit q->imeiNumbersChanged();
+    }
+    m_updateModemPropertiesTimer->stop();
+}
+
+void DeviceInfoPrivate::modemRemoved(const QString &modemName)
+{
+    QSharedPointer<QOfonoModem> modem(m_modemHash.take(modemName));
+    if (!modem.isNull()) {
+        disconnect(&*modem, &QOfonoModem::serialChanged, this, &DeviceInfoPrivate::modemSerialChanged);
+        m_modemList.removeOne(modemName);
+        updateModemPropertiesLater();
+    }
+}
+
+void DeviceInfoPrivate::modemAdded(const QString &modemName)
+{
+    if (!m_modemHash.contains(modemName)) {
+        QSharedPointer<QOfonoModem> modem(QOfonoModem::instance(modemName, m_synchronousInit));
+        connect(&*modem, &QOfonoModem::serialChanged, this, &DeviceInfoPrivate::modemSerialChanged);
+        m_modemHash[modemName] = modem;
+        m_modemList.append(modemName);
+        updateModemPropertiesLater();
+    }
+}
+
+void DeviceInfoPrivate::modemsChanged(const QStringList &modems)
+{
+    QSet<QString> previous(m_modemList.toSet());
+    QSet<QString> current(modems.toSet());
+    QSet<QString> added(current - previous);
+    QSet<QString> removed(previous - current);
+    for (auto iter = removed.cbegin(); iter != removed.cend(); ++iter)
+        modemRemoved(*iter);
+    for (auto iter = added.cbegin(); iter != added.cend(); ++iter)
+        modemAdded(*iter);
+}
+
+void DeviceInfoPrivate::modemSerialChanged(const QString &serial)
+{
+    Q_UNUSED(serial);
+    updateModemPropertiesLater();
+}
+
+DeviceInfo::DeviceInfo(bool synchronousInit, QObject *parent)
+    : QObject(parent)
+    , d_ptr(new DeviceInfoPrivate(this, synchronousInit))
+{
+    Q_D(const DeviceInfo);
+}
+
 DeviceInfo::DeviceInfo(QObject *parent)
     : QObject(parent)
-    , d_ptr(new DeviceInfoPrivate())
+    , d_ptr(new DeviceInfoPrivate(this, false))
 {
+    Q_D(const DeviceInfo);
 }
 
 DeviceInfo::~DeviceInfo()
@@ -161,3 +284,11 @@ QString DeviceInfo::adaptationVersion() const
     Q_D(const DeviceInfo);
     return d->m_adaptationVersion;
 }
+
+QStringList DeviceInfo::imeiNumbers()
+{
+    Q_D(DeviceInfo);
+    return d->imeiNumbers();
+}
+
+#include "deviceinfo.moc"

src/deviceinfo.h

@@ -29,8 +29,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  */
 
-#ifndef DEVICEINFO_H
-#define DEVICEINFO_H
+#ifndef NEMO_SYSTEMSETTINGS_DEVICEINFO_H_
+#define NEMO_SYSTEMSETTINGS_DEVICEINFO_H_
 
 #include <QObject>
 
@@ -51,6 +51,7 @@ class SYSTEMSETTINGS_EXPORT DeviceInfo: public QObject
     Q_PROPERTY(QString osName READ osName CONSTANT)
     Q_PROPERTY(QString osVersion READ osVersion CONSTANT)
     Q_PROPERTY(QString adaptationVersion READ adaptationVersion CONSTANT)
+    Q_PROPERTY(QStringList imeiNumbers READ imeiNumbers NOTIFY imeiNumbersChanged)
 
 public:
     enum Feature {
@@ -103,7 +104,8 @@ class SYSTEMSETTINGS_EXPORT DeviceInfo: public QObject
     };
     Q_ENUM(Feature)
 
-    DeviceInfo(QObject *parent = 0);
+    DeviceInfo(bool synchronousInit, QObject *parent = nullptr);
+    DeviceInfo(QObject *parent = nullptr);
     ~DeviceInfo();
     Q_INVOKABLE bool hasFeature(DeviceInfo::Feature feature) const;
     Q_INVOKABLE bool hasHardwareKey(Qt::Key key) const;
@@ -220,11 +222,42 @@ class SYSTEMSETTINGS_EXPORT DeviceInfo: public QObject
      */
     QString adaptationVersion() const;
 
+    /*!
+     * List of IMEI number strings
+     *
+     * Note: Access is limited to users in
+     * \l {https://github.com/sailfishos/sailfish-setup} {sailfish-phone}
+     * group. Additionally sandboxed applications need
+     * \l {https://github.com/sailfishos/sailjail-permissions} {Phone}
+     * permission. If these requirements are not met, an empty list
+     * is returned.
+     *
+     * Obtained by enumerating modems exposed on D-Bus by OFono service.
+     *
+     * Normally enumeration is done asynchronously in background and
+     * empty list is returned until enumeration is finished.
+     *
+     * If DeviceInfo object is created using synchronousInit=true,
+     * constructor blocks while getting the initial values - which may
+     * be useful when dealing with procedural logic.
+     *
+     * If/when OFono is not running, an empty list is returned regardless
+     * of whether asynchronous or synchronous init is used.
+     *
+     * Should be functionally equivalent with obtaining data via:
+     *   QDeviceInfo::imei()
+     *   QDeviceInfo::imeiCount()
+     */
+    QStringList imeiNumbers();
+
+Q_SIGNALS:
+    void imeiNumbersChanged();
+
 private:
 
     DeviceInfoPrivate *d_ptr;
     Q_DISABLE_COPY(DeviceInfo)
     Q_DECLARE_PRIVATE(DeviceInfo)
 };
 
-#endif /* DEVICEINFO_H */
+#endif /* NEMO_SYSTEMSETTINGS_DEVICEINFO_H_ */

src/src.pro

@@ -8,6 +8,7 @@ QT -= gui
 CONFIG += c++11 hide_symbols link_pkgconfig
 PKGCONFIG += profile mlite5 mce timed-qt5 blkid libcrypto libsailfishkeyprovider connman-qt5 glib-2.0
 PKGCONFIG += ssu-sysinfo nemodbus packagekitqt5 libsystemd sailfishusermanager sailfishaccesscontrol
+PKGCONFIG += qofono-qt5
 
 system($$[QT_INSTALL_BINS]/qdbusxml2cpp -p mceiface.h:mceiface.cpp mce.xml)